HWSSMPL0 and HWSSMPL1 return and reason codes

HWSSMPL0 and HWSSMPL1 return and reason codes are sent to the client in the RSM fields RSM_RETCOD/RSM_RSM_RSNCOD.

Return codes

Table 1. Return codes for HWSSMPL0 and HWSSMPL1

Hex value	Description
04	Exit request error message sent to client before socket termination. The socket is disconnected.
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	Error returned by IMS OTMA when an OTMA sense code is returned in the "Reason Code" field of the RSM. See the OTMA codes for your installation's version of IMS for sense code descriptions. The socket is disconnected for IMS.
14	Currently reserved.
18	SCI error detected. See CSL codes for REASON codes. The socket is disconnected for IMS.
1C	OM error detected. See CSL codes for REASON codes. The socket is disconnected for IMS.
20	The IRM_TIMER value 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 value 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.

Reason codes

Table 2. Reason codes for HWSSMPL0 and HWSSMPL1

OMUSR reason code passed to Exit	Decimal value in RSM	Description
N/A	4	Input data exceeds buffer size.
N/A	5	Negative length value.
N/A	6	IMS request message (IRM) length invalid.
N/A	7	Total message length invalid.
N/A	8	OTMA NAK with no sense code or RC.
N/A	9	Contents of buffer invalid.
N/A	10	Output data exceeds buffer size.
N/A	11	Invalid Unicode definition.
N/A	12	Invalid message, no data.
N/A	16	Do not know who client is.
N/A	20	OTMA segment length error.
N/A	24	FIC missing.
N/A	28	LIC missing.
N/A	32	Sequence number error.
N/A	34	Unable to locate context token.
N/A	36	Protocol error.
N/A	40	Security violation.
N/A	44	Message incomplete.
N/A	48	Incorrect message length.
NOSECHDR	51	Security failure — no OTMA security header.
INVESECHL	52	Security failure — no security data in OTMA security header.
SECFNOPW	53	Security failure — no password in OTMA user data header.
SECFNUID	54	Security failure — no user ID in OTMA security header.
SECFNPUI	55	Security failure — no password in OTMA user data and no user ID in OTMA security header.
DUPECLNT	56	Duplicate Client ID used; the client ID is currently in use.
INVLDTOK	57	Invalid token is being used — internal error.
INVLDSTA	58	Invalid client status — internal error.
CANTIMER	59	Cancel Timer completed successfully.
NFNDCOMP	70	IMS Connect component was not found.
NFNDFUNC	71	IMS Connect function was not found.
NFNDDST	72	The data store was not found.
DSCLOSE	73	The data store was closed.
STP/CLSE	74	The data store or IMSplex was in a stop or close process.
DSCERR	75	Data store communication error.
STOPCMD	76	The data store or IMSplex was stopped by command.
COMMERR	77	A data store or IMSplex communication error was sent to the pending client.
SECFAIL	78	Security failure. RACF® call failed, IMS Connect call failed. See IMS Connect error message on system console.
PROTOERR	79	IMS Connect protocol error. See IMS Connect error message on system console.
CANCRTP	81	OTMA canceled the RESUME TPIPE request.
SUSPTPIP	82	OTMA suspended the tpipe.
INVLDCM1	93	Invalid commit mode of 1 specified on the RESUME TPIPE request.
REQUEST	94	Request
CONVER	95	Conversation
REQ_CON	96	Request and conversation
DEAL_CTD	97	Deallocate confirmed
DEAL_ABT	98	Deallocate abnormal termination
	99	Default reason code