QUERY OTMADESC command
Use the QUERY OTMADESC command to query information about an existing IMS Open Transaction Manager Access (OTMA) destination descriptor.
Subsections:
Environment
The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the commands and its keywords.
| Command / Keywords | DB/DC | DBCTL | DCCTL |
|---|---|---|---|
| QUERY OTMADESC | X | X |
Syntax
Keywords
The following keywords are valid for the QUERY OTMADESC command:
- ADAPTER(adaptername)
- A 1- to 8-character name that identifies the IMS Connect adapter. This keyword is an optional parameter for TYPE(IMSCON). When an adapter name is specified, information is displayed from only the descriptors that specify that adapter name. This keyword is ignored if TYPE(NONOTMA) is specified.
- CONVRTR(convertrname)
- A 1- to 8-character converter name associated with the adapter specified on the ADAPTER keyword. When a converter name is specified, information is displayed from only the descriptors that specify that converter name.
- EXIT(Y | N)
- An optional parameter that filters descriptors based on whether they allow the appropriate exit routine to override the descriptor routing information.
- LTERMOVR(ltermname)
- An optional parameter that filters descriptors based on the logical terminal override name.
- MQAPPLID(mqmdapplidentitydata)
- Filters for descriptors with the specified value or values for the MQAPPLID parameter. MQAPPLID specifies the content of the MQMD_APPLIDENTITYDATA field, a 1- to 32-character user data field in the MQMD data structure for IBM® MQ messages.
- MQCOPYMD(Y | N)
- Filters for descriptors based on whether they specify to copy the MQMD data from the input message to the output message.
- MQCORREL(mqmdcorrel)
- Filters for descriptors with the specified value or values for the MQCORREL parameter. MQCORREL specifies the content of the MQMD_CORRELID field of the MQMD data structure for IBM MQ messages.
- MQFORMAT(mqmdformatname)
- Filters for descriptors with the specified value or values for
the MQFORMAT parameter. MQFORMAT specifies the content of the MQMD_FORMAT
field of the MQMD data structure for IBM MQ messages.
The following values are supported by IMS:
- MQIMSVS
- MQIMS
- NONE
- MQMSGID(mqmdmsgid)
- Filters for descriptors with the specified value or values for the MQMSGID parameter. MQMSGID specifies the content of the MQMD_MSGID field of the MQMD data structure for IBM MQ messages.
- MQPERST(N | Y )
- Filters TYPE=MQSERIES descriptors based on whether they use message persistence.
- MQREPORT(mqmdreportname)
- Filters for descriptors with the specified value or values for
the MQREPORT parameter. MQREPORT specifies the content of the MQMD_REPORT
field of the MQMD data structure for IBM MQ messages.
The following values are supported:
- Parameter value
- Equivalent MQMD structure value
- NEWMSGID
- MQRO_NEW_MSG_ID
- PASSMSGI
- MQRO_PASS_MSG_ID
- COPYMTOC
- MQRO_COPY_MSG_ID_TO_CORREL_ID
- PASSCORR
- MQRO_PASS_CORREL_ID
- PASSMSCO
- MQRO_PASS_MSG_ID and MQRO_PASS_CORREL_ID
- NONE
- MQRO_NONE
- MQRTF(mqmdreplytoformatname)
- Filters for descriptors with the specified value or values for the MQRTF parameter. MQRTF specifies the content of the MQMD_REPLYTOFORMAT field of the MQMD data structure for IBM MQ messages.
- MQRTQ(mqmdreplytoqname)
- Filters for descriptors with the specified value or values for the MQRTQ parameter. MQRTQ specifies the content of the MQMD_REPLYTOQ field of the MQMD data structure for IBM MQ messages.
- MQRTQ(mqmdreplytoqmgrname)
- Filters for descriptors with the specified value or values for the MQRTQMGR parameter. MQRTQMGR specifies the content of the MQMD_REPLYTOQMGR field of the MQMD data structure for IBM MQ messages.
- NAME(destname*)
- A 1- to 8-character destination name that identifies the OTMA destination descriptors to display. This keyword is required. If OPTION(WILDCARD) is also specified, an asterisk can be used as a wildcard character.
- OPTION(NOWILDCARD | WILDCARD)
- Determines whether an asterisk in the NAME keyword is treated as a wildcard character. When NOWILDCARD is specified, an asterisk is processed as a normal character and a descriptor is displayed only if the destination name coded in the descriptor in the DFSYDTx PROCLIB member includes a matching asterisk character. When WILDCARD is specified, an asterisk in the NAME keyword is treated as wildcard character and any descriptors that have a destination name that matches the characters not masked by the asterisk are displayed.
- REPLYCHK(Y | N)
- An optional parameter that filters descriptors based on whether they have OTMA DFS2082 message support enabled.
- RMTIMS(imsname)
- The name of a remote IMS system that is the destination for OTMA ALTPCB output. When a remote IMS name is specified, information is displayed from only the descriptors that specify that remote IMS name. The RMTIMS parameter is optional and accepts a 1- to 8-character name.
- RMTIMSCON(imsconnectname)
- The name of a connection to a remote IMS Connect instance that manages the TCP/IP communications for a remote IMS system that is the destination for OTMA ALTPCB output. When a remote IMS Connect connection name is specified, information is displayed from only the descriptors that specify that remote IMS Connect connection name. The RMTIMSCON parameter is optional and accepts a 1- to 8-character name of the connection.
- RMTSEC(F | C | N)
- Filters for descriptors based on the security flag settings for OTMA ALTPCB output message.
- F
- OTMA RACF® security is set to FULL.
- C
- OTMA RACF security is set to CHECK.
- N
- OTMA RACF security is set to NONE.
- RMTTRAN(trancode)
- An optional parameter that displays the transaction code that is scheduled to process OTMA messages in a destination remote IMS system. When a remote transaction code is specified, information is displayed from only the descriptors that specify that remote transaction code. The RMTTRAN value is a 1- to 8-character name of a transaction.
- SENDALTP(Y | N)
- An optional parameter that filters descriptors based on the setting of this parameter.You can specify the following values on the SENDALTP parameter:
- Y
- IMS sends any ALTPCB output that is initiated by an IMS Connect commit-then-send send-receive call back to the originating IMS Connect client.
- N
- IMS keeps any ALTPCB output for IMS Connect in a tpipe hold queue. The output message can be retrieved by a RESUME TPIPE request.
- SHOW()
- Specifies which information to display in the output fields.
- ADAPTER
- Displays the name that identifies the IMS Connect adapter.
- ALL
- Displays all available information.
- CONVRTR
- Displays the converter name used by the adapter.
- EXIT
- For descriptors with TYPE=IMSTRAN, this field displays whether the DFSCMUX0 exit routine can override the descriptor routing information for late response messages.
- LTERMOVR
- Displays the lterm name specified in the destination descriptor.
- MQAPPLID
- Displays the IBM MQ user application data that is inserted into the MQMD_APPLIDENTITYDATA field for messages that are routed with this descriptor.
- MQCOPYMD
- Displays whether the original input values for the IBM MQ data structure (MQMD) are copied to the output message.
- MQFORMAT
- Displays the value of the MQMD_FORMAT field for messages that are routed to IBM MQ with this descriptor.
- MQPERST
- Displays whether messages that are routed to IBM MQ with this descriptor are persistent on a synchronous tpipe.
- MQREPORT
- Displays the value of the MQMD_REPORT field for messages that are routed to IBM MQ with this descriptor.
- MQRTF
- Displays the value of the MQMD_REPLYTOFORMAT field for messages that are routed to IBM MQ with this descriptor.
- MQRTQ
- Displays the value of the MQMD_REPLYTOQ field for messages that are routed to IBM MQ with this descriptor.
- MQRTQMGR
- Displays the value of the MQMD_REPLYTOQMGR field for messages that are routed to IBM MQ with this descriptor.
- REPLYCHK
- Displays whether DFS2082 message support is enabled for the descriptor.
- RMTIMS
- Displays the name of the destination remote IMS systems.
- RMTIMSCON
- Displays the name of remote IMS Connect systems that are managing TCP/IP connections for a destination remote IMS system.
- RMTSEC
- Displays the security flag of the message prefix for an OTMA ALTPCB output message that is sent to a remote IMS system through IMS-to-IMS TCP/IP communications.
- RMTTRAN
- The transaction code to be scheduled in the destination remote IMS system.
- SENDALTP
- Displays the setting of the SENDALTP parameter for IMS ALTPCB output messages for IMS Connect clients.
- SMEM
- Displays the super member indicator.
- SYNCTP
- Displays whether messages that are routed to IBM MQ with this descriptor require a synchronous tpipe.
- SYNTIMER
- Displays the timeout value for synchronous callout processing.
- TMEMBER
- Displays the name of TMEMBER or the Super Member if SMEM indicates as such.
- TPIPE
- Displays the TPIPE name under a TMEMBER.
- TYPE
- Displays the type of descriptor.
- NONOTMA
- Only displays fields relevant for NONOTMA descriptors.
- IMSCON
- Only displays fields relevant for IMSCON descriptors.
- IMSTRAN
- Only displays fields relevant for IMSTRAN descriptors.
- MQSERIES
- Only displays fields relevant for MQSERIES descriptors.
- USERID
- Displays the user ID used for transaction authorization in a destination remote IMS system.
- SMEM(Y | N)
- An optional parameter that specifies whether the TMEMBER name is a super member. When SMEM is specified, information is displayed from only the descriptors that specify the matching Y or N value for SMEM. SMEM and TYPE(NONOTMA) are mutually exclusive.
- SYNCTP(N | Y)
- Filters TYPE=MQSERIES descriptors based on whether they require a synchronous tpipe.
- TMEMBER(tmem)
- An optional parameter that is used to filter by a 1- to 16-character TMEMBER name. When a tmember name is specified, information is displayed from only the descriptors that specify that tmember name. TMEMBER and TYPE(NONOTMA) are mutually exclusive.
- TPIPE(tpipename)
- An optional parameter that is used to filter by a 1- to 8-character TPIPE name. When a tpipe name is specified, information is displayed from only the descriptors that specify that tpipe name. TPIPE and TYPE(NONOTMA) are mutually exclusive.
- TYPE(IMSCON | IMSTRAN | MQSERIES | NONOTMA)
- An optional keyword that can be IMSCON, IMSTRAN, MQSERIES, or NONOTMA. All output types are displayed if the keyword is not specified. To filter the display, specify IMSCON, IMSTRAN, MQSERIES, or NONOTMA. To include the other keywords, such as TMEMBER, TPIPE, SMEM, ADAPTER, or CONVRTR, use the SHOW keyword. If TYPE(NONOTMA) is specified, the rest of the display parameters will show blanks even if the SHOW keyword is specified.
- USERID(userid)
- An optional parameter that displays the user ID used for transaction authorization in a destination remote IMS system. When a user ID is specified, information is displayed from only the descriptors that specify that user ID. The USERID value is a 1- to 8-character RACF user ID.
Usage notes
The QUERY OTMADESC command is used to display the values specified in the destination routing descriptors that are identified in the NAME() keyword. The results returned by the QUERY OTMADESC command can be filtered by secondary keywords, such as TPIPE(). For example, when QUERY OTMADESC NAME(abc*) TPIPE(xyz) OPTION(WILDCARD) is specified, information is returned for only descriptors that have a destination name that starts with abc and a tpipe name of xyz.
Use the SHOW() keyword to control what information is displayed from the OTMA destination descriptors found by the command. For example, if you include SHOW(TMEMBER) in the command, the TMEMBER values are returned.
The QUERY OTMADESC command does not process asterisks as wildcard characters. However, you can use an asterisk as a wildcard character in the NAME() keyword if you specify OPTION(WILDCARD) when you issue the command.
No log records are written when the command is issued.
The QUERY OTMADESC command can be issued on an Extended Recovery Facility (XRF) alternate environment. The information retrieved might differ from the active system because of timing issues. For example, take the scenario where the UPDATE OTMADESC command is issued on the active system, the log record is written, and the QUERY OTMADESC command is issued on both the active and alternate system. The information about the active system reflects the current information whereas the alternate system reflects the old information. This is caused by the log record being read and updated in the alternate system.
You can issue a valid QUERY OTMADESC command that does not return any results because one of the filter keywords excluded the entire result set. For example, querying descriptors with both the ADAPTER keyword and the MQFORMAT keyword will never return any results because those keywords are never used together in a valid descriptor. If your query does not return any results, ensure that no mutually exclusive filtering keywords were specified.
Output fields
- Short label
- Contains the short label generated in the XML output.
- Long label
- Contains the column heading for the output field in the formatted output.
- Keyword
- Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error.
- Meaning
- Provides a brief description of the output field.
| Short label | Long label | Keyword | Meaning |
|---|---|---|---|
| ADAP | Adapter | ADAPTER | Adapter name. |
| CC | CC | N/A | Completion code for the line of output. The completion code indicates whether IMS was able to process the command for the specified resource. The completion code is always returned. |
| CCTXT | CCText | N/A | Completion code text that briefly explains the meaning of the nonzero completion code. This field is returned only for an error completion code. |
| CVRTR | Converter | CONVRTR | Converter name. |
| DEST | DestName | NAME | Destination name. |
| IMSRPY | IMSReply | IMSREPLY | Indicator that shows whether a DFS2082 message can be received as a response for a synchronous program switch request. |
| MBR | MbrName | N/A | Member name. |
| RMTIMS | RmtIMS | RMTIMS | Name of a remote IMS system. |
| RMTIMSCON | RmtIMSCon | RMTIMSCON | Connection to a remote IMS Connect instance. |
| RMTSEC | RmtSec | RMTSEC | Security flag of the message prefix for an OTMA ALTPCB output message that is sent to a remote IMS system. |
| RMTTRAN | RmtTran | RMTTRAN | Transaction sent to the remote IMS system. |
| SALTP | SendALTP | SENDALTP | The current specification of SENDALTP for this descriptor entry. |
| SMEM | SMem | SMEM | Indicator that shows whether the destination is a super member. |
| SYNTO | Syntimer | SYNTIMER | Timeout value for synchronous callout processing. |
| TMEM | TMember | TMEMBER | OTMA TMEMBER name. |
| TPIPE | TPipe | TPIPE | TPIPE name. |
| TYPE | Type | TYPE | Output type. |
| UID | Userid | USERID | User ID. |
Return, reason, and completion codes
An IMS return and reason code is returned to OM by the QUERY OTMADESC command. The OM return and reason codes that might be returned as a result of the QUERY OTMADESC command are standard for all commands entered through the OM API.
The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request; see CSLOMCMD return and reason codes for details.
| Return code | Reason code | Meaning |
|---|---|---|
| X'00000000' | X'00000000' | Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See Table 4 for details. |
| X'02000008' | X'00002000' | The command contains an invalid verb or no client is registered for the verb. |
| X'02000008' | X'00002004' | The command contains an invalid primary keyword or no client is registered for the keyword. |
| X'02000008' | X'00002028' | The command contains an invalid keyword. |
| X'02000008' | X'0000202C' | The command contains an unknown positional parameter. |
| X'02000008' | X'00002034' | The command contains an incomplete keyword parameter. |
| X'02000008' | X'00002038' | The command is missing a required parameter. |
| X'02000008' | X'0000203C' | The command contains an invalid keyword parameter value. |
The following table includes an explanation of the completion codes. Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource.
| Completion code | Completion code text | Meaning |
|---|---|---|
| 0 | Command completed successfully | The QUERY OTMADESC command completed successfully for the resource. |
| 165 | No Desc found meet any criteria | No descriptors were found based on the filters specified. |
| 166 | No entries found | Command failed for QUERY OTMADESC because no entries were found in the table of destination routing descriptors. |
Example 1 for QUERY OTMADESC command
The following are examples of the QUERY OTMADESC command:
Example 1 for QUERY OTMADESC command
QUERY OTMADESC NAME(OTMACL*) SHOW(TYPE,TMEMBER,SMEM)DestName MbrName CC Type TMember SMem
OTMACL* IMSA 0 IMSCON HWS2 N
Example 2 for QUERY OTMADESC command
QUERY OTMADESC NAME(OTMACL*) SHOW(ALL) OPTION(WILDCARD)DestName MbrName CC Type TMember TPipe SMem
OTMACL99 IMSA 0 IMSCON HWS1 HWS1TP01 N
OTMACL* IMSA 0 IMSCON HWS2 N
Example 3 for QUERY OTMADESC command
QUERY OTMADESC NAME(OTMD*) TYPE(IMSCON) SHOW(TMEMBER,SMEM,SYNTIMER) OPTION(WILDCARD)DestName MbrName CC Type TMember SMem Syntimer
OTMD* IMS1 0 IMSCON HWS1 N 1000
OTMDSC01 IMS1 0 IMSCON HWS1 N 3500
OTMDSC02 IMS1 0 IMSCON HWS1 N 999999
OTMDSC03 IMS1 0 IMSCON HWS1 N 1000
OTMDSC04 IMS1 0 IMSCON SM01 Y 4000
OTMDSC08 IMS1 0 IMSCON HWS1 N Example 4 for QUERY OTMADESC command: RMTIMSCON
The following example shows all OTMA destination descriptors that are used to route ALTPCB output to the remote IMS Connect connection ICON2B.
QRY OTMADESC NAME(*) RMTIMSCON(ICON2B) SHOW(ALL) OPTION(WILDCARD) PLEX1 IMS Single Point of Control
Command ===>
----------------------- Plex . . PLEX1 Route . . IMS1 Wait . . 5:00
Response for: QRY OTMADESC NAME(*) RMTIMSCON(ICON2B) SHOW(ALL)... More: >
DestName MbrName CC Type TMember TPipe SMem Adapter Converte
DESC0001 IMS1 0 IMSCON HWS1 TPIPE01 N
DESC0002 IMS1 0 IMSCON HWS1 TPIPE02 Y
DESC0003 IMS1 0 IMSCON HWS1 TPIPE03 N
DESC0004 IMS1 0 IMSCON HWS1 TPIPE03 N
SM01000B IMS1 0 IMSCON SM01 TPSM01 Y
T01R2BI2 IMS1 0 IMSCON HWS1 TPIPE01 N
T02R2BI2 IMS1 0 IMSCON HWS1 TPIPE02 N PLEX1 IMS Single Point of Control
Command ===>
----------------------- Plex . . PLEX1 Route . . IMS1 Wait . . 5:00
Response for: QRY OTMADESC NAME(*) RMTIMSCON(ICON2B) SHOW(ALL)... More: <
DestName MbrName Converter Syntimer RmtIMSCon RmtIMS RmtTran Userid
DESC0001 IMS1 ICON2B IMS2
DESC0002 IMS1 ICON2B IMS2
DESC0003 IMS1 ICON2B IMS2 APOL12
DESC0004 IMS1 ICON2B IMS2 APOL12 BILL
SM01000B IMS1 ICON2B IMS2
T01R2BI2 IMS1 ICON2B IMS2
T02R2BI2 IMS1 ICON2B IMS2 Example 5 for QUERY OTMADESC command: RMTTRAN
The following example shows all OTMA destination descriptors that set a transaction code, APOL12, in ALTPCB messages that are routed to a remote IMS system for processing.
QRY OTMADESC NAME(*) RMTTRAN(APOL12) SHOW(ALL) OPTION(WILDCARD) PLEX1 IMS Single Point of Control
Command ===>
----------------------- Plex . . PLEX1 Route . . IMS1 Wait . . 5:00
Response for: QRY OTMADESC NAME(*) RMTTRAN(APOL12) SHOW(ALL) O... More: >
DestName MbrName CC Type TMember TPipe SMem Adapter Converte
DESC0003 IMS1 0 IMSCON HWS1 TPIPE03 N
DESC0004 IMS1 0 IMSCON HWS1 TPIPE03 N
PLEX1 IMS Single Point of Control
Command ===>
----------------------- Plex . . PLEX1 Route . . IMS1 Wait . . 5:00
Response for: QRY OTMADESC NAME(*) RMTTRAN(APOL12) SHOW(ALL) O... More: <
DestName MbrName Converter Syntimer RmtIMSCon RmtIMS RmtTran Userid
DESC0003 IMS1 ICON2B IMS2 APOL12
DESC0004 IMS1 ICON2B IMS2 APOL12 BILL RmtIMSCon, RmtIMS,
and Userid output fields are also related to the
processing of ALTPCB messages on remote IMS systems.Example 6 for QUERY OTMADESC command: TPIPE for connections to a remote IMS system
The following example shows all OTMA destination descriptors that specify the same tpipe, TPSM01, which is used to route ALTPCB messages to a remote IMS system for processing.
QRY OTMADESC NAME(*) TPIPE(TPSM01) SHOW(ALL) OPTION(WILDCARD) PLEX1 IMS Single Point of Control
Command ===>
----------------------- Plex . . PLEX1 Route . . IMS1 Wait . . 5:00
Response for: QRY OTMADESC NAME(*) TPIPE(TPSM01) SHOW(ALL) OPT... More: >
DestName MbrName CC Type TMember TPipe SMem Adapter Converte
SM01000A IMS1 0 IMSCON SM01 TPSM01 Y
SM01000B IMS1 0 IMSCON SM01 TPSM01 Y
SM01000C IMS1 0 IMSCON SM01 TPSM01 Y
SM01000D IMS1 0 IMSCON SM01 TPSM01 Y
SM01000E IMS1 0 IMSCON SM01 TPSM01 Y
SM01000F IMS1 0 IMSCON SM01 TPSM01 Y
SM01000G IMS1 0 IMSCON SM01 TPSM01 Y
SM01000H IMS1 0 IMSCON SM01 TPSM01 Y PLEX1 IMS Single Point of Control
Command ===>
----------------------- Plex . . PLEX1 Route . . IMS1 Wait . . 5:00
Response for: QRY OTMADESC NAME(*) TPIPE(TPSM01) SHOW(ALL) OPT... More: <
DestName MbrName Converter Syntimer RmtIMSCon RmtIMS RmtTran Userid
SM01000A IMS1 ICON2A IMS2
SM01000B IMS1 ICON2B IMS2
SM01000C IMS1 ICON2C IMS2
SM01000D IMS1 ICON2D IMS2
SM01000E IMS1 ICON2E IMS2
SM01000F IMS1 ICON2F IMS2
SM01000G IMS1 ICON2G IMS2
SM01000H IMS1 ICON2H IMS2 RmtIMSCon to the remote IMS system identified under RmtIMS for
processing.