AOF Rule Tools › AOF Variables › Environmental (Event-related) Variables

Environmental (Event-related) Variables

AOF environmental (event-related) variables provide detailed information about the system event that AOF is evaluating. Each AOF event rule type (MSG, CMD, EOM, and so on) provides a set of unique environmental variables. For example, in a MSG rule type, you have access to various MSG.xxxx variables such as the following:

MSG.TEXT

Contains the complete text of the current message.

MSG.JOBNAME

Contains the name of the job or address space that issued the message.

MSG.REPLYID

Contains the reply for WTOR messages.

In a CMD rule type, you have access to various CMD.xxxx variables such as the following:

CMD.TEXT

Contains the complete text of the current command.

CMD.JOBNAME

Contains the name of the job or address space that issued the command.

CMD.CONSNAME

Contains the name of the console from which the command was issued.

Review the following additional facts about environmental (event-related) variables:

• Environmental variables are automatically provided by the AOF engine and are available only in the )PROC (processing) section of a rule.
• Some environmental variables are modifiable and can affect original event attributes.

  For example, changing the contents of the MSG.TEXT variable in a )MSG rule changes the text of the WTO message, or modifying the CMD.TEXT variable in a )CMD rule changes the original command that was entered.

  Note: Some environmental variables are designated as read-only; changing the value of a read-only variable is not allowed and results in an error condition. Because the values of read-only environmental variables do not change, all rules that execute for a single event get the same environmental data.

• Changes to an environmental variable by multiple rules are cumulative. The first rule to execute receives original event information. Subsequent rules (executing in response to the same event) receive event information modified by each preceding rule.

  Note: Because rules cannot change the values of read-only variables, these variables always contain original information.

• All rules that usually execute in response to an event do so regardless of how each rule changes an environmental variable.

  For example, if a message rule changes the message ID contained in the MSG.ID variable, then all rules matching the original message ID still execute (and no rules matching the new message ID execute).

• You can view most environmental variables using the DISPLAY primary command in the OPSLOG Browse facility.

  Note: For more information about the OPSLOG Browse facility, see the OPSVIEW User Guide.

More information:

Coding Each AOF Rule Type