REXX SPOC API environment with the CSL OM

The REXX SPOC API allows REXX programs to set up the IMSplex environment, submit commands to OM, and to retrieve the command responses.

There are three phases related to using the REXX SPOC API with the CSL OM:

Set up the REXX environment
Set up the IMSplex environment and issue commands
Retrieve the command responses

Setting up the REXX environment in a CSL
By issuing the ADDRESS command, you can call the program CSLULXSB to set up the REXX environment. This program establishes the REXX subcommand environment for the REXX SPOC API.
Setting up the IMSplex environment
By switching the default host command to IMSSPOC and issuing the ADDRESS command, you can set up the IMSplex environment. After you set the default host command to IMSSPOC, IMSSPOC executes subsequent host commands issued by the REXX program that is running.
Issuing type-2 IMS commands
You issue IMS™ commands, including type-2 commands, by including them in the REXX program stream as quoted strings or as REXX variables that resolve to quoted strings.
CSLULGTS: retrieving command responses in XML
By issuing the CSLULGTS request, you can retrieve command responses. The CSLULGTS command puts the command responses to a stem variable so that REXX can access them.
CSLULOPT: including format identifiers in command responses
By issuing the CSLULOPT request, you can specify whether a command response should contain format IDs. Automated operator programs (AOPs) use format identifiers (FID) to identify the record format of specific lines of a command response.
CSLULGTP: retrieving command responses directly to a REXX stem variable
By issuing the CSLULGTP request, you can retrieve command responses from OM and put the command response into a REXX stem variable. The REXX program then refers to the information in the stem variable directly, rather than parsing XML statements, as it does with the CSLULGTS request.
REXX SPOC API within a transaction
Transactions can be written in the REXX language. A REXX EXEC runs as an IMS application and has characteristics similar to other IMS-supported programming languages. The REXX SPOC API can be used to issue commands from a transaction and to examine the command responses.
Ending the IMS SPOC environment
By issuing the END subcommand, you can end the IMS SPOC environment when you no longer want to execute IMS commands and signify that the SPOC environment is no longer needed.

Parent topic: REXX SPOC API and the CSL