CSLOMBLD: command registration build

With the CSLOMBLD request, you can build the command registration list that is passed to OM on the CSLOMREG request.

This list identifies the commands for which the IMS system can be called. The list contains a set of statements starting with a CSLOMBLD FUNC=BEGIN statement and ending with a CSLOMBLD FUNC=END statement.

Any number of CSLOMBLD FUNC=DEFVRB statements can be provided, each one defining the command verb. Following each DEFVRB statement are CSLOMBLD FUNC=DEFKEY statements, which identify keywords valid for the previously defined command verb.

The set of CSLOMBLD statements can be defined either in a separate data-only assembler module, or in a static data section of an executable assembler module. Refer to the documentation in the CSLOMBLD macro.

CSLOMBLD is used to build the command registration list; it does not have an input parameter list.

CSLOMBLD syntax

CSLOMBLD BEGIN

Use the BEGIN function statement to identify the beginning of the set of command statements.

Read syntax diagramSkip visual syntax diagramCSLOMBLDFUNC=BEGIN

CSLOMBLD DEFVRB

Use the DEFVRB function statement to identify a command that the OM client or IMS system will support. You can specify a short form of the command verb.

Read syntax diagramSkip visual syntax diagramCSLOMBLDFUNC=DEFVRBVERB=verbnameNORM=shortverbname

CSLOMBLD DEFKEY

Use the DEFKEY function statement to identify a keyword that is valid for the previously defined command. You can also specify command routing and required RACF® authorization with this statement.

Read syntax diagramSkip visual syntax diagramCSLOMBLDFUNC=DEFKEYKEYW=keywordROUTE=ANY|ALLSEC=READ|UPDATE

CSLOMBLD DEFGMR

Use the DEFGMR function statement to identify the beginning of the statements that describe the output parsing grammar.

Note: This function is for internal IBM® use only.
Read syntax diagramSkip visual syntax diagramCSLOMBLDFUNC=DEFGMR

CSLOMBLD ENDGMR

Use the ENDGMR function statement to designate the end of the statements that describe the output parsing grammar.

Note: This function is for internal IBM use only.
Read syntax diagramSkip visual syntax diagramCSLOMBLDFUNC=ENDGMR

CSLOMBLD END

Use the END function statement to designate the end of the list of command statements.

Read syntax diagramSkip visual syntax diagramCSLOMBLDFUNC=END

CSLOMBLD parameters

KEYW=keyword
Specifies a valid keyword for the command verb that immediately precedes this parameter. For a null keyword, use blanks; for example, 'KEYW= '. This parameter is required for FUNC=DEFKEY.
NORM=shortverbname
Specifies the short form of the command being defined. This parameter is required for FUNC=DEFVRB.
ROUTE=ANY | ALL
Specifies the override routing for the command being defined. This parameter is required for FUNC=DEFKEY.
SEC=READ | UPDATE
Specifies the required RACF authorization for KEYW. This parameter is required for FUNC=DEFKEY.
VERB=verbname
Specifies the long form of the command being defined. This parameter is required for FUNC=DEFVRB.

CSLOMBLD example

The following shows an example of a set of CSLOMBLD statements.

Figure 1. CSLOMBLD example statements
  CSLOMBLD FUNC=BEGIN
  CSLOMBLD FUNC=DEFVRB,VERB=ACTIVATE,NORM=ACT
  CSLOMBLD FUNC=DEFKEY,KEYW=LINK,SEC=UPDATE
  CSLOMBLD FUNC=DEFKEY,KEYW=NODE,SEC=UPDATE
  CSLOMBLD FUNC=END

Overriding CSL OM command routing with the ROUTE parameter

CSLOMBLD allows the command processing client to override the routing that you specify when you enter a command. There are a few commands that specify command routing overrides. OM overrides command routing when two command processing clients specify different routing overrides for the same command if:

  • At least one command processing client specifies an override of ROUTE=ALL, then OM routes the command to all registered command processing clients.
  • At least one command processing client specifies an override of ROUTE=ANY, and no command processing client has specified ROUTE=ALL, then OM routes the command to one of the registered command processing clients.
  • No command processing clients have specified an override of ROUTE=ALL or ROUTE=ANY, then OM routes the command as specified by the user that entered the command.

When an OM command has a ROUTE parameter, IMS chooses the highest level IMS in the route list as the command master. For example, in an IMSplex configuration that includes an IMS 15 system with an IMS 15 CQS, and another IMS system with a previous version SCI, if an INIT OLC command (which is a ROUTE=ANY command) is issued, the IMS 15 system is selected as the command master.

For a list of the commands that can be issued with the ROUTE parameter, see Commands and keywords supported by the OM API.