-tracking: Configure SOAP Gateway-to-IMS transaction tracking IDs

Use the -tracking command to enable, disable, and configure the horizontal tracking IDs for inbound SOAP messages (the provider scenario).

Syntax

Read syntax diagramSkip visual syntax diagramiogmgmt -tracking  -off -on  -idmessageID -idgenerated -idcustom -elementelementname -nameSpacenamespace

Parameters

-tracking
Change the SOAP Gateway horizontal tracking ID configuration for the provider scenario. The shortcut for this keyword is -tr.

Setting with this parameter does not affect callout transaction logging because callout transaction logging uses vertical tracking IDs only.

-on
Enables SOAP Gateway horizontal tracking IDs. When IDs are enabled, SOAP Gateway adds a tracking ID to every inbound request message (the provider scenario). This tracking ID is used by the SOAP Gateway transaction logger to correlate messages at multiple stages of request and response message processing. The ID is also associated with processing activity for the message in IMS Connect and IMS.
-off
Disables tracking IDs. By default, SOAP Gateway does not add an ID to messages.
-id
Sets the type of identifier that SOAP Gateway adds to incoming messages. This parameter applies to inbound message tracking for the provider scenario only. For callout messages, the tracking ID is always generated.
The valid values are:
messageID
SOAP Gateway uses the value from the WS-addressing messageID element of the inbound SOAP request message header as the tracking ID. This value is generated by the client application. If the messageID element does not exist, is empty, or is longer than 40 bytes, SOAP Gateway generates an ID for the message instead. When message IDs are activated, messageID is the default tracking ID type.
generated
SOAP Gateway generates a unique tracking ID for every inbound SOAP request message.
custom
SOAP Gateway retrieves the value of a user-specified SOAP element to use as the tracking ID. If the value of the user-specified element does not exist, is empty, or is longer than 40 bytes, SOAP Gateway generates a tracking ID for the message. This tracking ID type has one required parameter and one optional parameter:
-element
Specifies the name of the target SOAP message element. Only the value of the element is used for the tracking ID. If any attributes are set for the target element in the message, they are ignored. When the tracking ID type is set to custom, -element is a required parameter. It is not valid with any other tracking ID type. The shortcut for this keyword is -e.
-nameSpace
Specifies a namespace for the target element. SOAP Gateway attempts to find an exact match for the namespace of the target element (specified with the -element parameter) in the SOAP message. If an exact match is not found, SOAP Gateway generates an ID instead. When the tracking ID type is set to custom, -nameSpace is an optional parameter. It is not valid with any other tracking ID type. The shortcut for this keyword is -ns.

Example

The following example enables uniquely generated tracking IDs for incoming request messages:
iogmgmt -tracking -on -id generated