Coding Each AOF Rule Type › OMEGAMON Rules › AOF Variables Available in an OMG Rule

AOF Variables Available in an OMG Rule

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

OMG.COLOR

The color a message line is used in OPSLOG Browse

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

Sample Value: '00'X

Notes:

• Use the OPSCOLOR function of OPS/REXX to set the OMG.COLOR variable.
• To change the default display colors for OMEGAMON messages, reset the CA OPS/MVS parameters whose names begin with OMG. For descriptions of these parameters, see the Parameter Reference.
• If multiple rules set OMG.COLOR for a single OMEGAMON message, CA OPS/MVS uses only the last value. To trace the color set by each rule, set the CA OPS/MVS RULETRACE parameter to ON. For a description of the RULETRACE parameter, see the Parameter Reference.

OPSLOG Browse Column: COLOR

OMG.DDNAME

The 8-character ddname associated with the OMEGAMON report file

Data Type: Character, read-only

Sample Value: OMREPORT

Note: Use this variable to identify the source of an OMEGAMON exception event.

OPSLOG Browse Column: TERMNAME

OMG.JOBNAME

The name of the OMEGAMON address space that caused the rule to execute

Data Type: Character, read-only

Sample Value: OMEGTASK

OPSLOG Browse Column: JOBNAME

OMG.NAME

The name of the OMEGAMON exception (for instance, DNSR for DASD Not Responding). Usually, this is a 4-character code.

Data Type: Character, read-only

Sample Value: XREP

Note: The OMG.NAME variable value determines which OMEGAMON rules execute for the current OMEGAMON event. For descriptions of the OMEGAMON exception codes, see your OMEGAMON manuals. For information on setting up the CA OPS/MVS interface to OMEGAMON, see the Administration Guide.

OPSLOG Browse Column: MSGID

OMG.REPORTID

A unique report ID you can use to identify the source of an OMEGAMON message. This is taken from the SUBSYS parameter (if specified).

Data Type: Character, read-only

Sample Value: CICSA

Note: Knowing where OMEGAMON events are coming from can be useful when you monitor multiple CICS systems from a single address space. The OMG.REPORTID variable enables you to tell to which CICS system the event refers.

OPSLOG Browse Column: DSPNAME

OMG.SYSID

The ID of the system where OMEGAMON is running. For JES3 messages, the SYSID value derives from the MPNAME field of the Active Main Processor Control Table. For JES2 messages, the SYSID value derives from the SMF ID string.

Data Type: Character, read-only

Sample Value: S000

OPSLOG Browse Column: SYSID

Note: The OPSLOG Browse column displays two characters of this variable, not the complete field. The CA OPS/MVS BROWSEIDFORMAT parameter determines which characters are displayed. For a description of the BROWSEIDFORMAT parameter, see the Parameter Reference.

OMG.TEXT

The text of the exception message

Data Type: Character, read-only

Sample Value: 'XREP Number of Outstanding Replies = 4'

Notes:

• Some OMEGAMON exceptions generate several lines of output; when this occurs, the OMG.TEXT variable contains all of these lines concatenated together.
• All sequences of multiple blanks are compressed to a single blank.
• If the exception produces more output lines than the OMG.TEXT variable can hold, CA OPS/MVS truncates the lines that do not fit.

OPSLOG Browse Column: Text is always displayed.

OMG.USER

An 8-byte variable providing communication between rules that execute for the same OMEGAMON 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 OMEGAMON event; each rule can look at or change the variable contents before passing the variable to the next rule for the OMEGAMON 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 binary or mixed case. The USER field may also be used for filtering in the OPSLOG. However, USER data used for OPSLOG filtering must be uppercase and displayable.

OPSLOG Browse Column: USER