Table 24. Elements of IAA-XML Message
|
|
|
Message element structure in top level A container for Commands that can also contain elements such as Defaults, and CrfActionGroup. Valid elements are described below. |
id |
Unique Id of the message. Every instance of every message has a unique Id. |
System generated |
SessionId |
Multiple Messages may be sent on the same topic OR a one message may start chain of messages. In both case, the sessionId associates these messages together. Associated messages have the same sessionId value. For example, the sessionId for the messages containing a Command and the one containing its Response are the same. |
System generated |
version |
Version of IAA-XML architecture or message structure. This attribute applies only to IAA-XML if bodyType='IAA-XML'. |
IAA Envelope Integration Object->Message Integration Component->Message_version Integration Component Field, XML Literal Value. The default is 1.4. |
bodyType |
Describes the architecture of the message content. Defined values: IAA-XML, EID. |
IAA Envelope Integration Object->Message Integration Component->Message_version Integration Component Field, XML Literal Value. The default is IAA-XML. |
timeStampCreated |
The time the message was created in the source system. Format: yyyy-mm- ddThh: mm:ss.ffffff timestamp. |
System generated |
timeStampExpired |
The time when the message expires. |
IAA Envelope Integration Object->Message Integration Component->Message_timeStampExpired Integration Component Field, XML Literal Value. |
sourceLogicalId |
Logical Id of the system that issued the message. |
IAA Envelope Integration Object->Message Integration Component->Message_sourceLogicalId Integration Component Field, XML Literal Value. The default is Siebel. |
destinationLogicalId |
Logical Id of the system that should receive the message. Typically this attribute is used for notification when the publish-subscribe mechanism is not used. |
IAA Envelope Integration Object->Message Integration Component->Message_destinationLogicalId Integration Component Field, XML Literal Value. The default is BackEnd. |
authenticationId |
Id of the user that issued the message. |
IAA Envelope Integration Object -> Message Integration Component -> Message_authenticationId Integration Component Field, XML Literal Value. |
crfPublish |
Indicates whether to publish the hub activity to subscribers and defines the default value for the crfPublish attribute within CrfActionGroup. Valid values are true or false. |
IAA Envelope Integration Object->Message Integration Component->Message_crfPublish Integration Component Field, XML Literal Value. The default is false. |
crfCmdMode |
Defines response type that will be generated by the hub and defines the default value for the crfCmdMode attribute within CrfActionGroup. Valid values are alwaysRespond, neverRespond, onlyRespondInError. |
IAA Envelope Integration Object->Message Integration Component->Message_crfCmdMode Integration Component Field, XML Literal Value The default is alwaysRespond. |
txnScope |
Valid values are all or any. 'All' means all commands in the Message are part of a transaction. 'Any' means that Commands are transaction independent. |
IAA Envelope Integration Object->Message Integration Component->Message_txnScope Integration Component Field, XML Literal Value. |
Default element structure in Message XML attributes listed below can appear many times in a message with the same value. Using the Defaults section allows these attributes to be predefined which reduces message size. |
DefaultTime element structure in Default Applies to type Timestamp. |
zoneOffset |
Default time zone offset from UTC. Values must be between -720 and +720. Value is typically an exact number of hours (a multiple of 60) but the offset may also include half and quarter hours. |
IAA Envelope Integration Object->DefaultTime Integration Component-> DefaultTime_zoneOffset Integration Component Field, XML Literal Value |
DefaultCurrency element structure in Default Applies to type CurrencyAmount. |
currencyCode |
Default currency code (for currency amounts not specifying a currency code) using the ISO-4217 values. |
IAA Envelope Integration Object->DefaultCurrency Integration Component-> DefaultCurrency_currencyCode Integration Component Field, XML Literal Value |
DefaultUnit element structure in Default Define default unit of measure. For example, kg for weight. |
measuredConcept |
Measured concepts includes weight, distance, temperature, and so on. |
IAA Envelope Integration Object->DefaultUnit Integration Component-> DefaultUnit_measuredConcept Integration Component Field, XML Literal Value |
CrfActionGroup element structure in Message Grouping of hub activity related to a command section. This must be defined for each command contained in the message and is required if the hub processing the message. |
bodyCategory |
Name of Workflow script that the adapter wants used to process a message. |
any external integration object->Integration Object User Property-> Name:CrfActionGroup_bodyCategory, Value:<specify the values here>. |
crfPublish |
Determines whether or not the messages need to be published specific to this action. Valid values are true or false. |
IAA Envelope Integration Object->CrfActionGroup Integration Component-> CrfActionGroup _crfPublish Integration Component Field, XML Literal Value. The default is false. |
crfCmdMode |
Type of required response for action group. Valid values are alwaysRespond, neverRespond, or onlyRespondInError. This attribute is a specialized version of cmdType attribute defined for IAA-XML commands. |
IAA Envelope Integration Object->CrfActionGroup Integration Component-> CrfActionGroup _crfCmdMode Integration Component Field, XML Literal Value The default is alwaysRespond. |
destinationLogicalId |
Logical Id of destination system receiving the message specific to this action group. |
any external integration object->Integration Object User Property-> Name:CrfActionGroup_destinationLogicalId, Value:<specify the values here>. |
CommandReference element structure in CrfActionGroup Refers to a (command) in the core (business content) section of the message. |
refid |
Reference to a COMMAND element corresponding to this action group. |
System generated |
KeyGroup element structure in CrfAction CrfActionGroup Defined for each aggregate contained in a particular command. For the MQSFSE hub, the message header contains the KeyGroup information instead of the aggregate. The aggregate refers to its KeyGroup using refid. When there are multiple keys, multiple alternate ids will show within KeyGroup. It assumes all keys are related by UUID. |
id |
Identifier for referencing key blocks within a message. |
System generated |
refid |
Reference to key block (used at aggregate level to reference their keys in the header). |
System generated |
keyGroupType |
Type of key. Corresponds to aggregate type. |
System generated |
UUID element structure in KeyGroup |
|
Universal unique identifier for accessing all keys for all systems corresponding to this entry. |
System generated |
AlternateID element structure in KeyGroup Alternative or system specific key used by a system to identify an aggregate. |
value |
Key value stored in a particular system (if different from UUID). |
System generated |
sourceLogicalId |
Id of the system owning this key. |
IAA Envelope Integration Object->AlternateId Integration Component-> AlternateId_sourceLogicalId Integration Component Field, XML Literal Value. The default is Siebel. |
attributeString |
Set of strings that some systems may require to be held in the hub cross reference file (CRF). Valid separator is comma. |
IAA Envelope Integration Object->AlternateId Integration Component-> AlternateId_attributeString Integration Component Field, XML Literal Value. |
state |
Action on the key. referenced. Key is information sent from one system to another and that CRF should not have an entry for it. add. Key was created in a system and needs to be added to CRF, only for message into hub. added. Key was created in the originating system and in the CRF, only for message coming from hub. exists. Key is in the CRF & should be translated for another system. modify. Key was modified in the originating system and needs to be modified in the CRF, only for message into hub. modified. Key was modified in the originating system and in the CRF, only for message coming from hub. delete. The key needs to be removed from the CRF, only for message into hub |
any external integration object->Integration Object User Property-> Name:AlternatedId_state, Value:<specify the values here>. |
newValue |
Value to which the key should be modified. If a newValue is present, then the atttributeString attribute (if present) contains the new attributeString. |
Not Supported |