Common Attributes

extkey (boolean)

extkey (boolean)
Syntax	[extkey = Boolean : false]
May occur in	<field> < fields > <cond> <getcat> any Import field
Description	An indicator of whether the referenced (field-) value specifies an external key.
Remarks	Currently, this attribute is also used to specify an external key in other places. This is fixed in an upcoming version.

extkey (value)

extkey (value
Syntax	[extkey = string]
May occur in	<link> destination_record source_record
Description	The value of an external key.
Remarks	Currently, this attribute is also used to specify whether an external key is referenced in other places. This is fixed in an upcoming version.

extkey_as_attr

extkey_as_attr (boolean)
Syntax	[extkey_as_attr = Boolean : false]
May occur in	<field> < fields > <cond>
Description	An indicator of whether the external key of a catalog value is returned as its own attribute extkey on field level. If true, the external key is returned (as value of attribute extkey) as well as the catalog text in the response.
Remarks	This attribute is only valid in conjunction with the attribute extkey.

The following examples of request and response with extkey_as_attr on field level.

      <request>
        <query>
          <tables>
            <table tablename="Company"/>
          </tables>
          <fields>
            <field tablename="Company" fieldname="Company"/>
            <field tablename="Company" extkey="true" extkey_as_attr="true" fieldname="Country"/>
          </fields>
        </query>
      </request>

      <response>
        <query>
          <Company tableshort="FI" id="73014444233">
            <Company>Austrian Company</Company>
            <Country extkey="AUT">Österreich</Country>
          </Company>
        </query>
      </response>

extsystem

extsystem
Syntax	[extsystem = string]
May occur in	< cond > < link > < merge > any valid Command element any valid Table or field element
Description	The value of an external system.
Remarks	Used in conjunction with an external key.

fid

fid
Syntax	[fid = int]
May occur in	< field > (or any other field reference)
Description	The field id or the core field id (see cid attribute in <metainfo/>), unique within its table.
Remarks	The field index is usually specified in the fnr attribute.

fieldname

fieldname
Syntax	[fieldname = string]
May occur in	< field > (or any other field reference)
Description	The XML name of a field, unique within its table.
Remarks	The language-dependent name is usually specified in the name attribute.

fields

fields
Syntax	[fields = string]
May occur in	< field > (or any other field reference)
Description	A comma-separated list of fields.
Remarks	Wildcards and regular expressions can be used.

fnr

fnr
Syntax	[field = int]
May occur in	< field > (or any other field reference)
Description	The field index, unique within its table.
Remarks	The field id is usually specified in the fid attribute.

if

if
Syntax	[if = string]
May occur in	any Command element
Description	An XPath specifying a condition that is evaluated against the current MP-document. If successful, the element is processed, otherwise it is ignored.
Remarks	See Message Processing.

mnr

mnr
Syntax	[mnr = unsignedShort]
May occur in	(any field)
Description	The tenant number.

name

name
Syntax	[name = string]
May occur in	<cond> (used in various places in the response document)
Description	The name of a table, field, catalog, or other entity.
Remarks	Commonly used to reference a language-dependent entity in the data model.

optional

optional
Syntax	[optional = Boolean : false]
May occur in	<link> (any import field)
Description	An indicator of whether a processing error of this element causes an error. If true, an error is ignored and the respective element is treated as if it is absent.
Remarks	Commonly used for optional links.

recId

recId
Syntax	[recId = unsignedLongHex]
May occur in	<table> (any record)
Description	A 64-bit record id specified in hexadecimal notation and prefixed with an 'x' character.
Remarks	Usually represented in full length with left zero padding.

table

table
Syntax	[table = string]
May occur in	< table > or any other table reference
Description	The table id. When used in an XML request, interface also tries to look up the table by its name when it is not found via its id.
Remarks	See also the tablename attribute.

tablename

tablename
Syntax	[tablename = string]
May occur in	< table > or any other table reference
Description	The XML name of a table. When used in an XML request, interface also tries to look up the table by its id when it is not found via its name.
Remarks	See also the table attribute.

value

value
Syntax	[value = string]
May occur in	<cond> (used in various places in the response document)
Description	The value of a condition or field.
Remarks	none