Coding Each AOF Rule Type › Generic Event Application Program Interface › Common API Event Variables

Common API Event Variables

The following common API event variables are supplied to every API rule:

API.APPLICATION

The application identifier string as defined by the application and registered with CA OPS/MVS development to ensure uniqueness

Data Type: Character, read-only

Sample Value: PDSMAN

API.COLOR

The color that certain messages will display in OPSLOG Browse

Data Type: 1-byte binary (unprintable), read/write

Sample Value: '00'X

Note: For additional information on setting this environmental variable, see the chapter “OPS/REXX Built-In Functions” in the Command and Function Reference.

API.ID

When a rule executes due to a wildcard match, API.ID can be used to determine which event caused the rule to execute.

The complete event name that the rule is processing

Data Type: Character, read-only

Sample Value: XXXXCLOSE

API.LEVEL

A 1- to 8-character string provided by the application. One intended purpose of this variable is to allow the application to differentiate between multiple copies of the application executing on the same system, if it is possible to do so. Otherwise, the application may or may not provide information in this variable.

Data Type: Character, read-only

Sample Value: 1

API.USER

Before AOF processing, this variable is initialized to binary zeros. It is then passed to each rule that executes for the same API event; each rule can look at or change the variable contents before passing the variable to the next rule for the API event.

The primary purpose of the USER variable is to provide a method to pass a small amount of data between the rules. This data may be in any format. The USER field may also be used for filtering in the OPSLOG; however, USER data used for OPSLOG filtering must be uppercase and displayable.

An 8-byte variable providing communication between rules that execute for the same API 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

API.VERSION

A 1- to 8-character string provided by the application to identify the version of the application that generated the API event. Note that different versions of the application may provide different environmental variables. In such cases, the rule writer can use this variable to determine which application version-specific environmental variables to use.

Data Type: Character, read-only

Sample Value: 05.01

API.TEXT

This variable is not usually used by the API rules. Its primary purpose is to provide a readable explanation of the event in the OPSLOG.

The first 128 characters of data of this variable are displayed in OPSLOG.

Determined by the application

Data Type: Character, read-only

Sample Value: XXXX EVENT RECORDED 10MAY2011