Using System State Manager › How to Specify and Store Actions › Built-in Variables

Built-in Variables

Built-in variables that begin with the prefix SSM! are designed to provide global and process exits with certain data that is not found in RDF columns or global variables.

The following list describes the built-in variables:

SSM!XRESNAME

A short form of the concatenation of the variables &SSM!PRISYS..&SSM!TABLE..&SSM!NAME which is usually passed as an action parameter for the XPREREQ and XSUBREQ process events.

SSM!USERDATA

Contains the job name and program name of the SQL statement issuer that caused the global event.

SSM!TABLE

Contains the name of the resource table or SSM directory table for a global event or process event or the current resource table being processed by SSM for process events and normal resource actions.

SSM!RESNAME

A short form of the concatenation of the variables &SSM!TABLE..&SSM!NAME which is often passed as an action parameter.

SSM!PROCESS

Contains the name of the global or process event or ACTION for normal resource action processing.

SSM!PRISYS

Contains the primary or local system name of the resource in the format system.subsys. If a column called PRIMARY_SYSTEM does not exist in the resource table, then the local system name is always returned.

SSM!PREREQ

Contains the text of the prerequisite that the XPREREQ process event evaluates.

SSM!NAME

Contains the name of the resource or managed table name for a global event, process event, or the current resource name that SSM processes for process events and normal resource actions.

SSM!MAXRC

Contains the maximum return code that has occurred for any global event or resource action table processing when multiple actions are defined in the text column of the action table.

SSM!LASTRC

Contains the return code from the last completed action.

SSM!IPL

Contains YES or NO. YES implies the first call to SSMBEGIN and the BEGIN global event since IPL. The value is NO at all other times.

SSM!COLUMN

Contains the name of the first monitored column that the SQL statement updated that triggered an UPDATE global event.

Notes:

• The only valid variables for the BEGIN global event are SSM!IPL, SSM!MAXRC, and SSM!LASTRC.
• Resource and directory table column variables and SSM!PRISYS are not available for action text substitution in global event actions. The REXX program that is invoked for a global event action must read the resource or directory table to obtain any column data.
• The SSM!COLUMN variable is only valid for the UPDATE global event.
• The SSM!PREREQ variable is only valid for the XPREREQ process event.
• The SSM!USERDATA variable is only valid for all global events except BEGIN.
• The SSM!MAXRC and SSM!LASTRC values are always valid and initialized to zero before any action processing begins.