OTMA message-control fields used by IMS Connect
The table in this topic defines the fields of the OTMA message control header and the order of those fields.
The numbered notes in the table are explained in Notes to OTMA header tables.
| Field | Length | Hexadecimal offset | Field value | Description and settings | Note |
|---|---|---|---|---|---|
| OMCTLALV | 1 | 0 | ARCHITECTURE LEVEL Set to X'01' architecture level 1. Set for all messages. |
1 | |
| OMCTLMGT | 1 | 1 | MESSAGE TYPE | ||
| OMCTLDTA X'80' | MESSAGE TYPE=Data Set for conversational transactions but not on first input. If EXPREA FLAG1 is set to EXPREA_ CONVERS then set OMCTLMGT to OMCTLDTA. EXPREA FLAG1 is not set to EXPREA_ CONVERS on the first input for conversation. |
1 | |||
| OMCTLTXN X'40' | MESSAGE TYPE=Transaction Set for first transaction input. That is, first input for conversation or nonconversation, EXPREA_FLAG1 is not set to EXPREA_CONVERS. |
1 | |||
| OMCTLRSP X'20' | MESSAGE TYPE=Response Set for ACK or NAK response to message sent to client. Required for:
|
1 | |||
| OMCTLCMD X'10' | MESSAGE TYPE-Command Set for - RESUME TPIPE calls |
1 | |||
| OMCTLCMT X'08' | MESSAGE TYPE = Commit Confirmation
Set for SEND ONLY or DEALLOCATE. SEND ONLY or DEALLOCATE is indicated in IRM from client. |
1 | |||
| OMCTLRSI | 1 | 2 | RESPONSE INDICATOR | ||
| OMCTLACK X'80' | RESPONSE = ACK Set for ACK. ACK is indicated in IRM. |
||||
| OMCTLNAK X'40' | RESPONSE = NAK Set for NAK. NAK is indicated in IRM. |
1 | |||
| OMCTLRRQ X'20' | RESPONSE = Response requested If set, then conversational transaction and the IMSEA_RSNCODE must be set to 96 (X'60') to signal client application that conversation continues. |
1 | |||
| OMCTLERQ X'10' | RESPONSE=Extended response requested. Neither tested nor set by exit. | 4 | |||
| OMCTLSYR X'08' | Response to a synchronous callout message | ||||
| OMCTLDAN X'02' | Support for delayed ACK or NAK response | ||||
| OMCTLCCI | 1 | 3 | COMMIT CONFIRMATION INDICATOR AND OTHER FLAGS | ||
| OMCTLCTD X'80' | Confirm=Committed If set, then the IMS application has terminated the conversation, and the IMSEA_RSNCODE must be set to 97 (X'61') to signal client application that the IMS application terminated successfully. |
||||
| OMCTLABT X'40' | Confirm=Aborted. Neither tested nor set by exit. | 4 | |||
| OMCTSATP EQU'04' | The SENDALTP message level activation set whether the IRM requests the SENDALTP support, and whether field IRM_F2 is set to "IRM_F2_SNDALTP". This is only valid for a commit-then-send send-receive transaction. | ||||
| OMCTLTYP | 1 | 4 | COMMAND TYPE | ||
| OMCTLBID X'04' | COMMAND=Client Bid. Neither tested nor set by exit. | 4 | |||
| OMCTLAVL X'08' | COMMAND=Server Available. Neither tested nor set by exit. | 4 | |||
| OMCLTRSN X'0C' | Command=Resynch. Neither tested nor set by exit. | 4 | |||
| OMCTLSPA X'14' | Command=Suspend I/P for all tpipes. Neither tested nor set by exit. | 4 | |||
| OMCTLRSA X'18' | Command=Resume I/P for all tpipes. Neither tested nor set by exit. | 4 | |||
| OMCTLSPN X'1C' | Command=Suspend I/P for named tpipe. Neither tested nor set by exit. | 4 | |||
| OMCTLRSM X'20' | Command=Resume I/P for named tpipe. Neither tested nor set by exit. | 4 | |||
| OMCTLRTP X'24' | Command=Resume O/P for named tpipe without options. Set for RESUME TPIPE call without options. | 1 | |||
| OMCTLRID X'28' | Command=Resume single tpipe with options. Set for RESUME TPIPE call with options. | 1 | |||
| OMCTLMTR X'3C' | Command=Resource state protocol command. OTMA sends this command to notify IMS Connect and other OTMA clients about how well the IMS system is processing the input received from OTMA clients. IMS Connect updates the exit interface block data store entry (HWSXIBDS) with the information sent in this command. |
||||
| OMCTLPFG | 1 | 5 | PROCESSING FLAG | ||
| OMCTLLPG X'80' | Load Program. Neither tested nor set by exit. | 4 | |||
| OMCTSHDN X'80' | The suspended processing for all tpipes (OMCTLSPA) is due to IMS shutdown. | 7 | |||
| OMCTLSYP X'40' | Synchronized tpipe. Neither tested nor set by exit. | 4 | |||
| OMCTLASY X'20' | Asynchronous/ unsolicited queued messages. Neither tested nor set by exit. | 4 | |||
| OMCTLERR X'10' | There is an error message with the NAK. Neither tested nor set by exit. | 4 | |||
| OMCTLQUE X'08' | Asynchronous message is in IMS
Hold Queue. If set, set CSM_FLG1 to CSM_AMSG if sending CSM, or set RSMFLG1 to RSM_AMSG if sending RSM. |
4 | |||
| OMCTLOME X'01' | SCI not present error message. | ||||
| OMCTLTNM | 8 | 6 | Tpipe name. Neither tested nor set by exit. | 4 | |
| OMCTLCHN | 1 | E | CHAIN STATE FLAG | ||
| OMCTLFIC X'80' | First in chain. Set for first message segment in chain. | 1 | |||
| OMCTLMIC X'40' | Middle in chain. Set for not first and, or, not last message segment in chain. | 1 | |||
| OMCTLLIC X'20' | Last in chain. Set for last message segment in chain. | 1 | |||
| OMCTLCAN X'10' | Cancel this message. Neither tested nor set by exit. | 4 | |||
| OMCTLPFL | 1 | F | PREFIX FLAG | ||
| OMCTLSTD X'80' | State Data is present. Set if State Data Header present in OTMA Headers being built. | 1 | |||
| OMCTLSEC X'40' | Security data is present. Set if Security Data Header present in OTMA Headers being built. | 1 | |||
| OMCTLUSR X'20' | User data is present. Set if User Data Header present in OTMA Headers being built. | 1 | |||
| OMCTLAPP X'10' | Application data is present. Set if Application Data Header present in OTMA Headers being built. | 1 | |||
| OMCTLSSN | 4 | 10 | SEND SEQUENCE NUMBER. NEITHER TESTED NOR SET BY EXIT. | 4 | |
| OMCTLSNS | 4 | 14 | SENSE CODE. See OMCTLSNC and OMCTLRSC, which follow. | ||
| ORG OMCTLSNS | |||||
| OMCTLSNC | 2 | 14 | SENSE CODE If nonzero value, then build a NAK RSM to send to the client application, pass the sense code in the RSM as the reason code, and set the return code to X'0C'. |
1 | |
| OMCTLRSC | 2 | 16 | REASON CODE NEITHER TESTED NOR SET BY EXIT. |
4 | |
| OMCTLRSQ | 4 | 18 | RECOVERABLE MESSAGE SEQUENCE NUMBER
NEITHER TESTED NOR SET BY EXIT. |
4 | |
| OMCTLSEQ | 2 | 1C | SEGMENT SEQUENCE NUMBER Set to 1 in first OTMA Control Header and count maintained in user work area. Increment by 1 for each subsequent OTMA Control Header within a single message being sent to IMS. |
1 | |
| 1 | 1E | RESERVED. | 3 | ||
| OMCTLCDN | 1 | 1F | Specifies the number of control data segments (1 to 255) when OMHDRCTD is set in the state data. This field is used only when IMS sends an ICAL callout message with control data in the application data section of the message. | ||
| ORG OMCTLRSQ | |||||
| OMCTLUID | 8 | 18 | The user ID of the client that is submitting a RESUME TPIPE call | ||