IMS TM Resource Adapter return and reason codes

OTMA return codes and IMS TM Resource Adapter return and reason codes are sent to the OTMA User fields OMUSR_RETCODE and OMUSR_RESCODE.

Return codes

Table 1. Return codes for OTMA
OMUSR_RETCODE received by IMS TM Resource Adapter (hex value) Description
04 Exit request error message sent to client before socket termination. The socket is disconnected for IMS.
08 Error detected by IMS Connect; the socket is disconnected for IMS.
0C Error returned by IMS/OTMA; the socket is disconnected for IMS.
10 Not valid for HWSJAVA0 (OTMA RETURN code); the socket is disconnected for IMS.
14 Reserved
18 Not valid for HWSJAVA0 (SCI RETURN code); the socket is disconnected for IMS.
1C Not valid for HWSJAVA0 (OM RETURN code); the socket is disconnected for IMS.
20 The IRM_TIMER has expired. The reason code value is the value of the IRM_TIMER and the socket is disconnected by IMS Connect.
24 A default IRM_TIMER value has expired. Either the IRM_TIMER value specified was X'00' or an invalid value. The reason code is the value of the IRM_TIMER and the socket is disconnected by IMS Connect.
28 IRM_TIMER value has expired. The reason code value is the value of the IRM_TIMER. The connection is not disconnected. The socket remains connected.
2C Cancel Timer has completed successfully.
30 Exit requests response message to the HWSPWCH/PING request to be sent back to client. IMS Connect keeps the socket connection because the PWCH/PING came in on a new socket connection or an existing persistent socket connection which is not in conversational mode or waiting for an ACK/NAK from the client application.

IMS might also determine whether to keep the connection depending upon the socket status after sending a user-defined message back to the client application.

Exit requests a message to be sent to the client and requests IMS Connect to determine whether to keep the persistent connection open.

34 Exit requests response message to the HWSPWCH/PING request to be sent back to client. IMS connect will terminate the socket connection after sending the message back to the client application because IMS Connect was waiting for an ACK/NAK from the client application on that socket connection.
38 Exit requests response message to the HWSPWCH/PING request to be sent back to client. IMS connect will terminate the socket connection after sending the message back to the client application because that socket connection was being used in IMS conversational mode.

Reason codes

Table 2. Reason codes for OTMA
OMUSR_RESCODE received by IMS TM Resource Adapter Description
  Default reason code.
APPLREQD The RACF® application name is required when you attempt to change a password phrase by using a RACF PassTicket.
BADEXTNL Incorrect length value in an IRM extension or incorrect offset to the first IRM extension.
Start of changeCANCRTPEnd of change Start of changeIMS cancelled the Resume Tpipe request as a result of an ACKTO timeout, or a /STO TMEMBER TPIPE command.End of change
CANTIMER Cancel Timer completed successfully.
COMMERR A data store or IMSplex communication error was sent to the pending client.
CONVER Conversation.
DEAL_ABT Deallocate abnormal termination.
DEAL_CTD Deallocate confirmed.
DSCERR Data store communication error.
DSCLOSE IMS Connect in shutdown.
DUPECLNT Duplicate client ID was used; the client ID is currently in use.
ICONSUCC PING or PWCH request was successful.

ICONSUCC can also indicate that a user-defined message was sent back to the client application.

INVCHAR Security failure; invalid character detected in user ID, groupname, or password field.
INVLDCM1 An invalid mode of 1 was specified on the RESUME TPIPE request.
INVLDSTA Invalid client status; internal error.
INVLDTOK Invalid token is being used; internal error.
INVLERCD Invalid error code was returned for PWCH request.
INVPHRSL The length of the RACF password phrase provided is invalid.
INVRQSNT The PWCH request has invalid syntax.
INVSECHL Security failure; no security data in the OTMA security header.
NFNDCOMP Component not found.
NFNDDST The data store was not found.
NFNDFUNC Function not found.
NFNDUOR Unit of recovery not found.
NOSECHDR Security failure; no OTMA security header.
NPW1INVL The new password 1 contained non-alphanumeric character.
NPW2INVL The new password 2 contained non-alphanumeric character.
NPW1LINV The new password 1 has invalid length.
NPW2LINV The new password 2 has invalid length.
NPWINVAL The new password is invalid.
NPWNOMCH New passwords do not match.
OPWINVAL The old password contained non-alphanumeric character.
OPWLINVL The old password has invalid length.
PROTOERR An IMS Connect protocol error occurred. See the IMS Connect error message on the system console.
PWCHGERR The password change request was in error.
PWCHNSUP Password change function is not supported.
PWEXPIRD The password has expired.
PWNOAUTH The old password is not authorized.
RACFNACT RACF is not active.
REQUEST Request.
REQ_CON Request and conversation.
SECFAIL Security failure; a RACF call failed; an IMS Connect call failed. See the IMS Connect error message on the system console.
SECFNOPW Security failure; no password in the OTMA user data header.
SECFNPUI Security failure; no password in the OTMA user data header, and no user ID in the OTMA user security header.
SECFNUID Security failure; no user ID in the OTMA user security header.
STOPCMD The data store or IMSplex was stopped by a command.
STP/CLSE The data store or IMSplex was in a stop or close process.
Start of changeSUSPTPIPEnd of change Start of changeIMS suspended the tpipe as a result of a /STO TMEMBER TPIPE command.End of change
XTNOFFZR Offset value to the first IRM extension is zero.