Format of the callout control data in the message

The format of the callout control data in the output message that is sent to the client application depends on the type of client application that issues the resume tpipe request.

For non-IMS TM resource adapter clients

The output message that is sent by IMS Connect to the client application includes a structure that contains control data. This structure can be mapped by using the CTLDATA and CTLDATASEG DSECTs, which are included in the macro HWSIMSCB. The control data structure is placed before the callout request data.

The format of the control data structure is as follows:

Table 1. Callout control data message format for non-IMS TM resource adapter clients
Field Length Meaning
CTL_LLLL 4 bytes Length of control data structure
CTL_ID 8 bytes Control data structure ID, which is a character value of *CTLDAT*
zzzz 4 bytes Reserved for IMS Connect
CTL_HDRLEN1 4 bytes Length of the header (tag) of the first control data section. This field is followed by the first pair of open and close tags.
CTL_DATA1 d1 The first control data section, which is in the following format:<tag1>data1</tag1>
CTL_HDRLEN2 4 bytes Length of the header (tag) of the second control data section. This field is followed by the second pair of open and close tags.
CTL_DATA2 d2 The second control data section, which is in the following format:<tag2>data2</tag2>
: : :
CTL_HDRLENn 4 bytes Length of the header (tag) of the last control data section. This field is followed by the last pair of open and close tags.
CTL_DATAn dn The last control data section, which is in the following format:<tagn>datan</tagn>

For IMS TM resource adapter clients

The format of the control data structure is as follows:

Table 2. Callout control data message format for IMS TM resource adapter clients
Field Length Meaning
LLLL 4 bytes Length of control data structure
LLLL 4 bytes Length of the header (tag) of the first control data section. This field is followed by the first pair of open and close tags.
DATA d1 The first control data section, which is in the following format: <tag1>data1</tag1>
LLLL 4 bytes Length of the header (tag) of the second control data section. This field is followed by the second pair of open and close tags.
DATA d2 The second control data section, which is in the following format: <tag2>data2</tag2>
: : :
LLLL 4 bytes Length of the header (tag) of the last control data section. This field is followed by the last pair of open and close tags.
DATA dn The last control data section, which is in the following format: <tagn>datan</tagn>