CSLOMREG: command registration request

With the CSLOMREG request, a command processing client like the IMS control region can register commands with an OM. The registration tells OM which commands that a client can process.

CSLOMREG must be the first request that a command processing client issues to OM. A command processing client must register with all OM address spaces in the IMSplex. If a client is registered with only one OM in an IMSplex, and that OM goes down, the client's commands are not routed to another OM in the IMSplex. Use the CSLSCQRY request to obtain the names of all OMs in the IMSplex. The client must be authorized to issue a CSLOMREG request. This authorization is from SCI, which notifies OM that the client can issue requests.

CSLOMREG syntax

CSLOMREG DSECT syntax

Use the DSECT function of a CSLOMREG request to include equate (EQU) statements in your program for the CSLOMREG parameter list length and return and reason codes.

Read syntax diagramSkip visual syntax diagramCSLOMREGFUNC=DSECT

CSLOMREG request protocol syntax

The syntax for the CSLOMREG request follows.

Read syntax diagramSkip visual syntax diagramCSLOMREGFUNC=REGISTERCMDLIST= cmdlistaddrCMDLISTLEN= cmdlistlenECB= ecbaddressOMNAME= omnameaddr OUTPUT= outputaddr OUTLEN= outputlen PARM= parmaddrRETCODE= returncodeaddrRSNCODE= reasoncodeaddrSCITOKEN= scitokenaddr

CSLOMREG parameters

CMDLIST=symbol
CMDLIST=(r2-r12)
(Required) - Specifies the command definition list.

The command list is built using the CSLOMBLD macro.

CMDLISTLEN=symbol
CMDLISTLEN=(r2-r12)
(Required) - Specifies the length of the command definition list buffer.
ECB=symbol
ECB=(r2-r12)
(Optional) - Specifies the address of a z/OS® event control block (ECB) used for asynchronous requests. When the request is complete, the ECB specified is posted. If an ECB is not specified, the task is suspended until the request is complete. If an ECB is specified, the invoker of the macro must issue a WAIT (or equivalent) after receiving control from CSLOMREG before using or examining any data returned by this macro (including the RETCODE and RSNCODE fields).
OMNAME=symbol
OMNAME=(r2-r12)
(Required) - Specifies the 8-byte OM name to which to send the command registration request.
OUTLEN=symbol
OUTLEN=(r2-r12)
(Optional) - Specifies a 4-byte field to receive the length of the output returned by the CSLOMREG request. OUTLEN contains the length of the output pointed to by the OUTPUT= parameter.

The output length is zero if no output is built, for example, if an error is detected before any output can be built.

OUTPUT=outputaddr
OUTPUT=(r2-r12)
(Required) - Specifies a field to receive the variable length output returned by the CSLOMREG request. The output length is returned in the OUTLEN= field.

The output is mapped by the CSLOREGO macro and is built only if there was an error registering one or more commands. The output contains a header and one or more list entries. Refer to the CSLOREGO macro for the output fields.

The output address is zero if no output was built, for example, if an error was detected before any output could be built.

The output buffer is not preallocated by the caller. After the request returns it, this word contains the address of a buffer containing the update output. It is the caller's responsibility to release this storage by issuing the CSLSCBFR FUNC=RELEASE request when it is finished with the storage. The length of the output is returned in the OUTLEN=field.

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 OREG_PARMLN.
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 (CSLOMREG) 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.

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.
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.

You can find the return and reason codes for the CSLOMREG command request in CSLOMREG return and reason codes.