CSLOMRSP: command response request

A command processing client issues the CSLOMRSP request in response to a command. All command response information from an individual command processing client is consolidated by the client and sent to OM in one request. OM consolidates the responses from multiple clients into one response for the automated operator program client.

CSLOMRSP parameters

CMD=symbol

CMD=(r2-r12)

(Optional) - Specifies the command input buffer. This can be any IMS command that can be specified through the OM API.

This parameter is optional; what you provide here will be included in the input tags that are returned as XML output.

CMDDATA=symbol

CMDDATA=(r2-r12)

(Optional) - Specifies the command response data buffer.

CMDDATALEN=symbol

CMDDATALEN=(r2-r12)

(Optional) - Specifies the length of the command response data buffer.

CMDHDR=symbol

CMDHDR=(r2-r12)

(Optional) - Specifies the command response header buffer.

CMDHDRLEN=symbol

CMDHDRLEN=(r2-r12)

(Optional) - Specifies the length of the command response header buffer.

CMDLEN=symbol

CMDLEN=(r2-r12)

(Optional) - Specifies the length of the command input buffer.

CMDTOKEN=symbol

CMDTOKEN=(r2-r12)

(Required) - Specifies a 32-byte field to contain the command token. This token uniquely identifies the command instance that the client has processed. The command token is passed to the client on an OM command directive. The address of the token is passed to the client in the ODIR_CMDTKPTR field in the OM command directive parameter list.

MSGDATA=symbol

MSGDATA=(r2-r12)

(Optional) - Specifies the command response message buffer.

MSGDATALEN=symbol

MSGDATALEN=(r2-r12)

(Optional) - Specifies the length of the command response message buffer.

PARM=symbol

PARM=(r2-r12)

(Required) - Four-byte input parameter that specifies the address of the storage used by the request to pass the parameters to SCI. The length of the parameter list must be equal to the parameter list length EQU value defined by ORSP_PARMLN.

OMNAME=symbol

OMNAME=(r2-r12)

(Required) - Specifies the 8-byte OM name to which to send the command registration request.

RETCODE=symbol

RETCODE=(r2-r12)

(Required) - Specifies a 4-byte field to receive the return code on output. Possible return codes are described in the following table.

The return code can be from OM (CSLOMRSP) or SCI (CSLSCMSG or CSLSCRQS). If ECB is specified, the RETCODE is not valid until the ECB is posted. The value of the high-order byte in the return code identifies whether SCI (X'01') or OM (X'02') provided the return code. OM return codes are defined in the CSLORR. SCI return codes are defined in CSLSRR.

RQSTRC=symbol

RQSTRC=(r2-r12)

(Required) - Specifies a 4-byte field to contain the reason code to be passed to the originator of the command. This reason code is defined by the command processing client and indicates the result of the command. Non-zero reason codes are passed back to the client in the <cmderr> section of the command response.

RQSTRSN=symbol

RQSTRSN=(r2-r12)

(Required) - Specifies a 4-byte field to contain the reason code to be passed to the originator of the command. This reason code is defined by the command processor client and indicates the result of the command. Non-zero reason codes are passed back to the client in the <cmderr> section of the command response.

RQSTTKN=symbol

RQSTTNK=(r2-r12)

(Optional) - Specifies the 32-byte request token that was passed to the command processing client on an OM command directive. This parameter represents the RQSTTKN1 and RQSTTKN2 fields that are entered on either or both the CSLOMI and CSLOMCMD requests.

RSNCODE=symbol

RSNCODE=(r2-r12)

(Required) - Specifies a 4-byte field to receive the reason code on output. OM reason codes are defined in the CSLORR. SCI reason codes are defined in CSLSRR. Possible reason codes are described in the following table.

RSNTEXT=symbol

RSNTEXT=(r2-r12)

(Optional) - Specifies a register that must contain the address of the reason text buffer; if specified as a symbol it must be the label of the reason text buffer. The buffer consists of a two-byte length field followed by the reason text. This token allows an OM client to pass a text description of the reason code in a command response.

RSNTEXTLEN=symbol

RSNTEXTLEN=(r2-r12)

(Optional) - Specifies a register that must contain the address of the reason text buffer; if specified as a symbol it must be the label of the reason text buffer. The buffer consists of a two-byte length field followed by the reason text. This token allows an OM client to pass a text description of the reason code in a command response.

SCITOKEN=symbol

SCITOKEN=(r2-r12)

(Required) - Specifies a 16-byte field containing the SCI token. This token uniquely identifies this connection to SCI. The SCI token is returned by a successful CSLSCREG FUNC=REGISTER request.

CSLOMRSP return and reason codes

The following table lists the return and reason codes that can be returned on a CSLOMRSP macro request. Also included is the meaning of the reason code (that is, what possibly caused it).