OTMA user data fields used by IMS Connect
The format of the user data fields in the OTMA header is defined by the HWSOMUSR DSECT in the HWSOMPFX macro and is common to all IMS Connect messages.
The numbered notes in the table are explained in Notes to OTMA header tables.
| Field | Length | Hexadecimal offset | Field value | Description and settings | Note |
|---|---|---|---|---|---|
| OMUSRLEN | 2 | 0 | USER DATA LENGTH. Set to length of User Data Header. |
1 | |
| 2 | 2 | ALIGN FULLWORD. | |||
| OMUSR_DESTID | 8 | 4 | DESTINATION ID. Set to destination ID (data store) from IRM field IRM_IMSDESTID. |
1 | |
| OMUSR_ORIGID | 8 | C | ORIGIN ID. Neither tested nor set by exit. | 4 | |
| OMUSR_PORTID | 8 | 14 | PORTID. Neither tested nor set by exit. | 4 | |
| OMUSR_LTOKEN | 8 | 1C | LOGON TOKEN. Neither tested nor set by exit. |
4 | |
| OMUSR_RETCODE | 4 | 24 | Communication return code. Neither tested nor set by exit. |
4 | |
| OMUSR_RESCODE | 8 | 28 | Communication reason code. Neither tested nor set by exit. |
4 | |
| OMUSR_RTOKEN | 4 | 30 | RESPONSE TOKEN - A(SVT) COMMUNICATION RETURN CODE. Neither tested nor set by exit. |
4 | |
| OMUSR_PASSTICK | 8 | 34 | RACF® PASSWORD/ PASSTICKET. Set to password from IRM field IRM_RACF_PW. This field must be cleared before passing message back to IMS Connect. |
1 | |
| OMUSR_FLAG1 | 1 | 3C | OMUSR_CONV_OPT EQU X'80' | For IMS TM Resource Adapter, specifies IMS conversational transaction support for service oriented architecture composite business applications (process choreography). | 4 |
| OMUSR_NPSOCKET X'40' | Non-persistent Socket. Neither tested nor set by exit. |
4 | |||
| OMUSR_CANCID X'20' | Cancel client ID When establishing a new session, cancel client ID requests that if an existing session on the same port is using the same client ID as the new session, the existing session be terminated to allow the new session to connect. |
||||
| OMUSR_PSOCKET X'10' | Persistent Socket. Set if persistent socket specified in IRM field IRM_SOCT has been set to IRM_SOCT_PER. |
4 | |||
| OMUSR_RTALTCID X'08' | RESUME TPIPE call with an alternate client ID. | 1 | |||
| OMUSR_RRDFLT X'04' | Default reroute name used. | 4 | |||
| OMUSR_CANTMR X'02' | Cancel timer request. This allows you to cancel the timer (from IRM_TIMER or default configuration timer value) wait when waiting on data from the data store. |
1 | |||
| OMUSR_REROUT X'01' | Reroute undeliverable output. When Commit Mode 0 (CM0) output cannot be delivered, this option causes the output to be rerouted to an alternate IMS Connect destination. |
1 | |||
| OMUSR_TRAN X'00' |
Transaction Socket. Set if transaction socket specified in IRM field IRM_SOCT has been set to IRM_SOCT_TRAN. |
||||
| OMUSR_FLAG2 | 1 | 3D | OMUSR_PWDTEXT X'01' | PASSTCKT field is text password. Neither tested nor set by exit. |
4 |
| OMUSR_PWDBIN X'02' | PASSTCKT field is binary password. Neither tested nor set by exit. |
4 | |||
| OMUSR_HWSPLSET X'10' | For IMS TM Resource Adapter, set if the IMS Connect protocol level is specified in the OMUSR_PROLEV field. | ||||
| OMUSR_TRSTUSR X'80' | Trusted user can be set by exit. | ||||
| OMUSR_F2_CIDREQ X'40' | For IMS TM Resource Adapter clients, specifies that if the ID of the current connection is a duplicate of an ID of an existing connection, IMS Connect generate a unique client ID for this connection. | ||||
| OMUSR_F2_CIDGEN X'20' | Set when a reply message sent to IMS TM Resource Adapter by IMS Connect contains a generated client ID. | ||||
| OMUSR_FLAG3 | 1 | 3E | OMUSR_HDRCM0 X'40' |
ORIGINAL SYNCHRONIZATION. Commit Mode 0. Neither tested nor set by exit. |
4 |
| OMUSR_HDRCM1 X'20' |
Commit Mode 1 (Send Commit). Neither tested nor set by exit. |
4 | |||
| OMUSR_SOA X'08' | Send-only protocol with the acknowledgment option. | ||||
| OMUSR_SOE X’80’ | Send-only protocol with error option. This option can be used with OMUSR_SOO X’04’. | ||||
| OMUSR_SOO X'04' | Send-only protocol with the serial (ordered) delivery option. This option can be used with OMUSR_SOE X’80’. | ||||
| OMUSR_ALT_ANAK X'02' | ACK or NAK requests output to be rerouted to an alternate client ID | ||||
| OMUSR_OM_MSG X'01' | OM message present | ||||
| OMUSR_TIMER | 1 | 3F | OMUSR_ZERO X'E9' - X'nn' specifies no wait. OMUSR_FF specifies wait forever. See Timeout specifications on input messages for a range of timer values. |
OMUSR_TIMER specifies the amount of time that IMS Connect will wait for a reply from OTMA. Value is supplied by the IRM_TIMER byte, the TIMEOUT= keyword of the IMS Connect TCPIP configuration statement, or the internal IMS Connect logic. |
1 |
| OMUSR_USTAT | 4 | 40 | USTAT ADDRESS. Neither tested nor set by exit. |
4 | |
| OMUSR_APPL_NM | 8 | 44 | PassTicket APPLname set to blanks or IRM value. |
1 | |
| OMUSR_RRS_RCD | 4 | 4C | z/OS® Resource Recovery Services return code | ||
| OMUSR_ARCLEV | 1 | 50 | Architectural level of the message structure of IMS TM Resource Adapter messages. | ||
| OMUSR_AL00 - X'00': Indicates the base architecture level IMS TM Resource Adapter | |||||
OMUSR_AL02 - X'02': Indicates architecture
level 2, which is required to support:
|
|||||
| OMUSR_AL03 - X'03': Indicates architecture level 3, which is required to support IMS-to-IMS TCP/IP communications for MSC and OTMA | |||||
| OMUSR_PROLEV | 1 | 51 | When OMUSR_HWSPLSET is set, this byte specifies the protocol level of this IMS Connect instance. | ||
| OMUSR_PR00 - X'00' | Base protocol level | ||||
| OMUSR_PR01 - X'01' | Currently not used | ||||
| OMUSR_PR02 - X'02' | CM0 NOWAIT ACK support | ||||
| OMUSR_PR03 - X'03' | Support for return codes in the request status message (RSM) from the RACROUTE user verification call. | ||||
| OMUSR_RES4 | 1 | 52 | Reserved for IMS Connect usage. Neither tested nor set by exit. |
3 | |
| OMUSR_RES5 | 4 | 54 | Reserved for IMS Connect usage. Neither tested nor set by exit. |
3 | |
| OMUSR_FLAG5 | 1 | 53 | OMUSR_SOCORTIM X'80' |
The message correlator value in OMHDRTIM is valid for the SendOnly transaction. |
|
| OMUSR_RES6 | 4 | 58 | Reserved for IMS Connect usage. Neither tested nor set by exit. |
3 | |
| OMUSR_REROUT_NM | 8 | 5C | Client Reroute name. Set to reroute name specified in IRM_REROUT_NM. This field occupies the same offset as the OMUSR_RT_ALTCID field. | 1 | |
| ORG OMUSR_REROUT_NM | |||||
| OMUSR_RT_ALTCID | 8 | 5C | Alternate client ID. Tested by exit. Also requires OMUSR_ARCLEV to be set to OMUSR_AL02. This field occupies the same offset as the OMUSR_REROUT_NM field. | 6 | |
| OMUSR_ADPTNM | 8 | 64 | Adapter name. | ||
| OMUSR_DRVNM | 8 | 6C | Input driver name. | ||
| OMUSR_LCLIMSID | 8 | 74 | IMS ID of the IMS system sending the message. | ||
| OMUSR_RMTICON | 8 | 7C | The name of the remote IMS Connect connection (RMTIMSCON) as defined in the local IMS Connect. | ||
| OMUSR_RMTIMSID | 8 | 84 | IMS ID of the IMS system receiving the message. | ||
| OMUSR_RMTTRAN | 8 | 8C | Transaction code that the receiving IMS system schedules to process the message. | ||
| OMUSR_RMTUID | 8 | 94 | User ID that the receiving IMS system uses to authorize the message for transaction processing. | ||
| OMUSR_SESTKN | 8 | 9C | The session token used to track events during IMS Connect processing of IMS-to-IMS messages. | ||
| 2 | A4 | Reserved. Align to fullword. | |||
| OMUSR_UTC_TO | 16 | A6 | Transaction expiration time in UTC format | ||
| OMUSR_CORTKN | 0XL40 | Correlation token for synchronous callout messages | |||
| OMUSR_CT_LEN | 2 | B6 | Length of the correlation token | ||
| OMUSR_CT_PSTNR | 2 | B8 | Region ID for the synchronous callout message | ||
| OMUSR_CT_IMSID | 4 | BA | IMS identifier | ||
| OMUSR_CT_MEMTK | 8 | BE | OTMA TMEMBER token | ||
| OMUSR_CT_AWETK | 8 | C6 | OTMA message token | ||
| OMUSR_CT_TPIPE | 8 | CE | OTMA TPIPE name | ||
| OMUSR_CT_USERID | 8 | D6 | User ID from ICAL call | ||
| OMUSR_TRCKID_OFF | 2 | DE | Offset to tracking ID. Set by user message exit to point to the tracking ID copied to the user data section from one of the IRM extensions. | ||
| OMUSR_CONTXT_OFF | 2 | E0 | Offset to context information. This field is set by the user message exit to point to the context information copied to the user data section from one of the IRM extensions. | ||
| 2 | E2 | Reserved for IMS Connect usage. | |||
| 2 | E4 | Reserved for IMS Connect usage. | |||
| OMUSR_RES6 | 24 | E6 | Reserved for IMS Connect usage. | ||
| Reserved | 2 | FE | Align to fullword. | ||