Coding Each AOF Rule Type › Screen Rules › AOF Variables Available in an SCR Rule

AOF Variables Available in an SCR Rule

You can use all AOF variable types in SCR rules, as described in the chapter “AOF Rule Tools.” You can use the following unique AOF event variables in the )PROC section of a SCR rule, and you can manually interrogate the corresponding OPSLOG display field as an aid in debugging or implementing rule logic.

SCR.ASID

The ASID of the address space that caused this screen event taken from either the address space of the issuer of an EPI command or, in all other cases, from the CA OPS/MVS main address space

Data Type: 2-byte binary (unprintable), read-only

Sample Value: '003E'X

Notes:

• Use the C2X function of OPS/REXX to convert the value of this variable to hexadecimal characters.
• You can use SCR.ASID to check whether a specific address space is issuing an EPI command.

OPSLOG Browse Column: ASID

SCR.JOBNAME

The job name of the address space that caused the current screen event. This name can be one of the following:

• The name of the job which issued an EPI command
• The name of the address space of the CA OPS/MVS product

Data Type: Character, read-only

Sample Value: OPSMAIN

OPSLOG Browse Column: JOBNAME

SCR.TERMNAME

The name of the virtual terminal associated with this screen event; taken from the DEFINE command used to define the terminal to EPI

Data Type: Character, read-only

Sample Value: IMSTERM

Note: The SCR.TERMNAME variable determines which screen rules execute for the current screen event.

OPSLOG Browse Column: TERMNAME

SCR.TEXT

A description of the screen event.

Possible Values:

• ENABLE-The virtual terminal has been enabled.
• DISABLE-The virtual terminal has been disabled.
• LOGON-The virtual terminal has logged on to an application.
• LOGOFF-The virtual terminal has logged off from an application.
• CHANGE-The virtual terminal characteristics have been changed (the EPI CHANGE, SETMODEL, and SETUNAME commands only).
• SCRUPDATE row col string-The virtual terminal screen has been updated at the named row and column. The string reflects the new text on the screen.
• MVCURSOR row col-The virtual terminal cursor has been moved to the specified row and column.
• KBUNLOCK-The virtual terminal keyboard has been unlocked.

Data Type: Character, read-only

Sample Value: SCRUPDATE 3 2 READY

Note: The first word of the SCR.TEXT variable always matches the value of the SCR.TYPE variable.

OPSLOG Browse Column: Text is always displayed.

SCR.TYPE

A description of the screen event.

Possible Values:

• ENABLE-The virtual terminal has been enabled
• DISABLE-The virtual terminal has been disabled
• LOGON-The virtual terminal has logged on to an application
• LOGOFF-The virtual terminal has logged off of an application
• CHANGE-The virtual terminal characteristics have been changed (the EPI CHANGE, SETMODEL, and SETUNAME commands only)
• SCRUPDATE-The virtual terminal screen has been updated
• MVCURSOR-The virtual terminal cursor has been moved
• KBUNLOCK-The virtual terminal keyboard has been unlocked

Data Type: Character, read-only

Sample Value: SCRUPDATE

Note: The value of SCR.TYPE always matches the first word of the SCR.TEXT variable.

OPSLOG Browse Column: MSGID

SCR.USER

An 8-byte variable providing communication between rules that execute for the same screen event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Data Type: User-defined, read/write

Notes:

• Before AOF processing, this variable is initialized to binary zeros. It is then passed to each rule that executes for the same screen event; each rule can look at or change the variable contents before passing the variable to the next rule for the screen event.
• You can store Dialog Manager attribute characters in this variable to control the color of the OPSLOG Browse column.

OPSLOG Browse Column: USER