RAMDB Variables › Variable Types › Message Variables

Message Variables

Use these variables to retrieve information about a message. Some of the variables have equivalent AOM NCL system variables that are described in more detail in the Network Control Language Reference Guide.

You can use the variables to pass values to a message rule, to the parameters of macros used in the rule, and to NCL procedures invoked from the rule.

Note: The special messages prefixes ($AA-, $DN-, or $MN-) may be used in ResourceView to enhance functionality. A message captured by using such a prefix has the prefix included in the message variables.

&ZMSGATEXT (&AOMATEXT)

Contains the text of the current line of a message.

&ZMSGAWORDn

Contains a word in the current line of a message. n is a number indicating the position of the word in the message and is in the range 1 through 32. Words are delimited by a blank or a comma.

&ZMSGJOBID (&AOMJOBID)

Contains the identification number of the job that sends the message.

&ZMSGJOBNM (&AOMJOBNM)

Contains the name of the job that issued the message. The value may be overridden by a job name supplied by JES. Thus, messages originating from JES can have the name of the target job, rather than the JES job name.

&ZMSGMSGID (&AOMMSGID)

Contains the first word of the message text and is equivalent to &ZMSGWORD1. If the message is a multiline WTO or WTOR message, &ZMSGMSGID contains the first word of the major line text.

&ZMSGTEXT (&AOMTEXT)

Contains the text of the message. If the message is a multiline WTO or WTOR message, &ZMSGTEXT contains the first (major) line of the message. Use the &ZMSGATEXT variable to retrieve the current line (which can be a minor line) of a message.

&ZMSGTIME

Contains the time of message arrival, in the form hh.mm.ss. The value can be in the range 00.00.00 through 23.59.59.

&ZMSGWORDn

Contains a word in the message text. If the message is a multi-line WTO or WTOR message, it is treated as one long string and ZMSGWORDn variables are assigned accordingly. Words are delimited by a blank or a comma. Use the &ZMSGAWORDn variable to retrieve a word in the current line (which can be a minor line) of a message.

&ZMSGWRID (&AOMWRID)

Contains the WTOR reply number. The value is blank if the message is not of the WTOR type.

Variables Available to EventView Message Group Rules

The following variables are available to EventView message rules only:

&ZMSGIJOBN (&AOMIJOBN)

Contains the name of the job that issued the WTO or WTOR message.

&ZMSGSYSNM

Contains the name of the system from which the message originates.

Variables Available to Completed EventView Message Group Rules

The following variables are available to completed (or triggered) EventView message group rules:

&ZMSGCORR

Contains the correlation key used for the triggered message group rule.

&ZMSGGRP

Contains the name of the triggered message group rule.

&ZMSGTXTN

Contains the number of messages that triggered the message group rule.

&ZMSGTXTn

Contains the text of one of the messages that triggered the message group rule. n is a message arrival sequence number and is in the range 1 to &ZMSGTXTN.

Variables Not Available to EventView Correlation keys, Replacement Text, and ZREV Variables

The following variables are not available to EventView correlation keys, replacement text, and ZREV variables:

&ZMSGDATE

Contains the date of message arrival, in the form dd-mmm-yyyy (for example, 14-JUN-2000).

&ZMSGDAY

Contains the day of message arrival, in the form ddd (for example, WED).

Variables Not Available to EventView

The following variables are not available to EventView:

&ZMSGLINEn

Contains each line of a multi-line WTO or WTOR, where &ZMSGLINE1 is the major line.

&ZMSGLINES

Contains the number of lines in a multi-line WTO or WTOR.

&ZMSGLnWn

Contains a word from a line in a multi-line WTO or WTOR, for example, &ZMSGL24w16 is the 16th word in line 24.