Writing a Script

Scripts are written in REXX language and must adhere to REXX syntax rules. Use a text editor to write the scripts and store them in the following library:

<prefix>.<version>.USER.CLIST

where:

  • <prefix> – Value set in parameter OLPREFS in member LOADCTS in the Connector INSTALL library.

  • <version> – Value set in parameter OLVERS in member LOADCTS in the Connector INSTALL library.

Note
This library name is defined in parameter SCRIPT_DIR in member RSSPARM stored in the Connector PARM library.

Scripts may be executed before and/or after a Connector for Top Secret function is executed (see Executing a Script for details). All scripts are activated under the Connector for Top Secret address space.

A script should consist of the following sequence of actions:

  1. Read the current Connector for Top Secret variables into REXX variables.

  2. Examine the REXX variables, modify them (if required) and execute additional actions as required.

  3. Update the Connector for Top Secret variables with the resultant REXX variable values.

To enable the script to manipulate Connector for Top Secret variables, Connector for Top Secret provides the script command CTSAVAR which reads the current Connector for Top Secret variables into REXX variables. After the REXX variables have been examined and modified, the script command CTSAVAR is used to update the Connector for Top Secret variables with the resultant REXX variable values. Script commands are described later in this chapter.

Since the script is executed in the TSO-REXX environment, Connector for Top Secret scripts can also issue TSO and REXX commands.

When writing a script, the following must be taken into account:

  • Certain variables are unmodifiable (see Script Variables).

  • The return code of a script must be set by the script before it terminates (see Setting the Return Code).

  • Several TSO commands can only be issued indirectly from within a Connector for Top Secret script (see TSO Considerations).

  • Due to REXX limitations, field names for keywords must be all uppercase. This applies both when defining keywords in SailPoint and when specifying the field name of the keyword in a script.