Command attributes
List of attributes that are parsed on every command element, although most of them affect the processing of only a subset of commands.
Below is the list of attributes:
__iflags
__iflags |
|
---|---|
Syntax |
[__iflags = mmFlags] |
May occur in |
(any Command element) |
Description |
Internal flags that control processing. |
Remarks |
Do not use (internal use only). |
catbynum
catbynum |
|
---|---|
Syntax |
[catbynum = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether catalog values are specified by a numeric index (as opposed to its textual value). This affects both request (records specified in <import> commands for example) and response (records returned from <query> commands for example). |
Remarks |
The catbynum and catexkeys indicators cannot both be set |
catexkeys
catexkeys |
|
---|---|
Syntax |
[catexkeys = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether catalog values are specified by external key (as opposed to its textual value). This affects both request (records specified in <import> commands for example) and response (records returned from <query> commands for example). |
Remarks |
The catbynum and catexkeys indicators cannot both be set |
catformat
catformat |
|
---|---|
Syntax |
[catformat = string] |
May occur in |
(any valid Command element) |
Description |
Indicates a format how catalog values are specified in requests, if the values are a combination of external key and text. Values: 1 = [EXTKEY] Text 2 = Text [EXTKEY] 3 = (EXTKEY) Text 4 = Text (EXTKEY) 5 = EXTKEY-Text 6 = EXTKEY|Text 7 = EXTKEY - Text 8 = EXTKEY | Text 9 = EXTKEY Text |
Remarks |
This indicator takes precedence over the catbynum and catexkeys attributes. |
dateformatin
dateformatin |
|
---|---|
Syntax |
[dateformatin = string] |
May occur in |
(any valid Command element) |
Description |
The order of the date components if not unique. Possible values are "dmy", "mdy", "ymd", "ydm". |
Remarks |
none |
dateformatout
dateformatout |
|
---|---|
Syntax |
[dateformatout = string] |
May occur in |
(any valid Command element) |
Description |
The formatting for date values in the response. |
Remarks |
See Formatting Date and Time Values. |
fixcatint
fixcatint |
|
---|---|
Syntax |
[fixcatint = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether values of static catalogs are specified as numeric index (as opposed to textual value). |
Remarks |
none |
flags
flags |
|
---|---|
Syntax |
[flags = mmFlags] |
May occur in |
(any valid Command element) |
Description |
Flags that control processing. |
Remarks |
flags2
flags2 |
|
---|---|
Syntax |
[flags2 = mmFlags] |
May occur in |
(any valid Command element) |
Description |
Flags that control processing. |
Remarks |
force_internal_matchup
force_internal_matchup |
|
---|---|
Syntax |
[force_internal_matchup = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether the Aurea CRM internal logic is to be used for a matchup (as opposed to the external matchup configured in the configuration table). |
Remarks |
See Matchup. |
internalfields
internalfields |
|
---|---|
Syntax |
[internalfields = string] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether certain fields should be generated in the response. These include the primary key and last modified timestamp for records, and the update timestamps for fields. |
Remarks |
none |
lazy_catfilter
lazy_catfilter |
|
---|---|
Syntax |
[lazy_catfilter = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether non-existing catalog values used in a query do not result in an error. If true, a condition that always evaluates to false is generated instead of the failing comparison. |
Remarks |
none |
lazy_filter
lazy_filter |
|
---|---|
Syntax |
[lazy_filter = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
Combines the lazy_catfiler and lazy_repfilter attributes. |
Remarks |
none |
lazy_repfilter
lazy_repfilter |
|
---|---|
Syntax |
[lazy_repfilter = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether non-existing rep values used in a query do not result in an error. If true, a condition that always evaluates to false is generated instead of the failing comparison. |
Remarks |
none |
matchup
matchup |
|
---|---|
Syntax |
[matchup = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether the matchup is to be done for records in <import> commands. |
Remarks |
The force_internal_matchup and use_configured_matchup attributes are only considered when matchup is true. See Matchup. |
nodefaults
nodefaults |
|
---|---|
Syntax |
[nodefaults = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether default values should be set when creating new records. |
Remarks |
This flag is primarily for testing purposes – the setting "nodefaults" can cause the record not to be created due to missing default values or violate your business rules. |
noerror
noerror |
|
---|---|
Syntax |
[noerror = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether field-check errors during the processing of < import > commands are to be ignored (and processing continues). |
Remarks |
For example, if you have no permission to update a field, this field is left unchanged (and the record is updated with all fields you have permission for) instead of an error generated and no update taking place. |
nomustcheck
nomustcheck |
|
---|---|
Syntax |
[nomustcheck = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether must-fields are to be checked. |
Remarks |
This flag is primarily for testing purposes – setting "nomustcheck" can violate your business rules due to missing mandatory fields. |
notrigger
notrigger |
|
---|---|
Syntax |
[notrigger = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether triggers are run when processing write operations on records. |
Remarks |
This flag is primarily for testing purposes – setting "notrigger" can violate your business rules. |
readback
readback |
|
---|---|
Syntax |
[readback = string] |
May occur in |
(any valid Command element) |
Description |
Return record data instead of success/failure information for write operations on records. |
Remarks |
See Returning record data. |
return
return |
|
---|---|
Syntax |
[return = string] |
May occur in |
(any valid Command element) |
Description |
Deprecated, only retained for backwards compatibility. |
Remarks |
Use readback='true' instead of return='2', and readback='false' instead of return='0'. |
timeformatout
timeformatout |
|
---|---|
Syntax |
[timeformatout = string] |
May occur in |
(any valid Command element) |
Description |
The formatting for time values in the response. |
Remarks |
See Formatting Date and Time Values. |
threads
type |
|
---|---|
Syntax |
[threads = unsignedByte] |
May occur in |
(any valid Command element) |
Description |
The number of concurrent threads to be used when importing records. |
Remarks |
transaction
transaction |
|
---|---|
Syntax |
[transaction = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether a transaction context is established or not. Requests within transactions are rolled back if one of the requests fails. |
Remarks |
Although it is possible to set the transaction on every command element it doesn’t affect the behavior in all cases since this attribute is ignored by the data base layer. E.g. during pure read only operations there is no transaction context established at all. Note: if catnew = true, catalog values are generated anyway no matter if
the requests of the transaction are executed successfully or rolled
back.
For further details and examples see Working with transactions below. |
truncate
truncate |
|
---|---|
Syntax |
[truncate = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether field values for text fields in < import > commands should be truncated if they are too long. |
Remarks |
none |
updtimestamps
updtimestamps |
|
---|---|
Syntax |
[updtimestamps = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether the update timestamps for fields should be generated in <query> results. |
Remarks |
These timestamps (and more) are also generated when setting the internalfields attribute. |
use_configured_matchup
use_configured_matchup |
|
---|---|
Syntax |
[use_configured_matchup = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether the matchup configured in the configuration table is to used. |
Remarks |
See Matchup. |
xsdt
xsdt |
|
---|---|
Syntax |
[xsdt = Boolean : false] |
May occur in |
(any valid Command element) |
Description |
An indicator of whether XML Schema data types are to be used in the response. Affects the following field types: numbers, dates and times. |
Remarks |
The use of XML Schema data types is highly recommended for data exchange. |