Previous Topic: Update Mirrored Vartables

Next Topic: Arithmetic in NCL

AOM Attributes of Mirrored Vartables

Mirrored vartables support several extra data fields in a table entry.

.AOMID

This attribute allows a 1- to 12-character AOM identifier to be stored or retrieved. When a LOOKUP statement assigns the ID attribute on a successful lookup, this value is assigned as the ID of the current message and is available to AOMPROC in the &AOMID system variable. If the supplied value is blank, the AOMID in the table entry is regarded as not specified, and a LOOKUP ASSIGN statement of ID will not override the current ID value for the message.

.AOMATTR

This attribute lets you set a list of AOM message attributes. Each allowable attribute is encoded into a 1- or 2-character value and placed into a particular position in a character string. The blank and dash (-) have special meaning. A blank in any position means that the associated attribute is to be regarded as not specified. This means that when a LOOKUP statement assigns an attribute from a table entry that is not specified, the current attribute value is not changed. A dash (-) means that the current value of the associated attribute is not to be changed and acts as a place holder when updating attributes that are further down in the attribute string.

The following message attributes can be encoded in a .AOMATTR string:

Position 1

z/OS delete option. Y-YES, N-NO, F-FORCE.

Position 2

ALARM option. Y-YES, N-NO.

Position 3

MONITOR option. Y-YES, N-NO.

Position 4

INTENSITY option

H-HIGH, N-NORMAL, L-LOW.

Position 5

NRD option. Y-YES, N-NO, O-OPER.

Position 6

TRACE option. S-START, F-FINISH, *-This one.

Position 7

ROUTE option. P-PROC, O-PROCONLY, M-MSG, B-BOTH, L-LOG, N-NO.

Refer to local/remote route options. If LCLROUTE and/or RMTROUTE are also specified, they override any value set here. If both positions are set and are different, this position is returned as not specified (-).

Position 8

HLITE option. N-NO, R-REVERSE, B-BLINK, U-UNDERSCORE,

Position 9

COLOR option. N-NO, B-BLUE, R-RED, P-PINK, G-GREEN, Y-YELLOW, T-TURQUOISE, W-WHITE.

Positions 10-11

MSGCODE value. 2 hexadecimal digits.

Positions 12-19

8 user flags. Each can be Y-YES, N-NO.

Position 20

LCLROUTE option. P-PROC, O-PROCONLY, M-MSG, B-BOTH, L-LOG, N-NO

Position 21

RMTROUTE option. P-PROC, O-PROCONLY, M-MSG, B-BOTH, L-LOG, N-NO

Position 22

DOM-TRACK option. Y-YES, N-NO.

Positions 23-30

8 RMTCLASS values. Each can be Y-YES, N-NO.

If a string shorter than 30 characters is specified it is padded to 30 characters with dashes. A new entry is regarded as having all attributes as not specified prior to processing any supplied .AOMID or .AOMATTR values.

When retrieving a table entry, if the .AOMATTR values are retrieved, a 30-character string is always returned, however some positions can be blank.

.AOMCOUNT

This attribute cannot be set or updated but can be retrieved by using the &VARTABLE GET statement. This is a counter that is incremented if the COUNT option is specified in the LOOKUP statement. It can be used as a hit counter. A new table entry has this field initialized to zero before the implied count if it is added by a LOOKUP statement with both ADD and COUNT specified.

.AOMTHIT, .AOMTMISS, .AOMTADD

These attributes are counters. The counters can be accessed using these field names in the &VARTABLE QUERY statement.

.AOMTHIT

Counts the total number of LOOKUP statements, with TOTAL specified, that found a matching table entry.

.AOMTMISS

Counts the total number of LOOKUP statements, with TOTAL specified, that did not find a matching table entry (including those that later added a new entry).

.AOMTADD

Counts the total number of LOOKUP statements, with TOTAL specified, that added a new entry. These are also counted in the .AOMTMIS, since no match is found.

These counters are initialized to zero when a table is allocated or reset.