Previous Topic: OPS/REXX Host Environments in the )PROC Section of an MSG RuleNext Topic: Debug an MSG Rule


AOF Variables Available in MSG Rules

The following unique AOF event variables appear in the )PROC section of an MSG rule. Use all variables as an aid in debugging or implementing rule logic. The corresponding OPSLOG display fields are listed. For more information, see AOF Rule Tools.

MSG.AMRF

Displays a value indicating whether the message is retained in the Action Message Retention Facility (AMRF).

Data Type

Integer, read/write

Values
0

Do not retain this message.

1

Retain this message.

Example

1

Notes:

Example

The following two lines of code in an MSG rule results in the AMRF retaining the message:

MSG.DESC = OPSBITS("IMEDACTN")
MSG.AMRF=1

OPSLOG Browse Column: Fourth bit of AFLAGS

MSG.AUTOFLAG

The NetView automation flag, which is taken from the WQESAUT bit flag. In addition, the WQEAUTO bit flag is also used.

Data Type

Integer, read/write

Example

1, if automation is specified.

Notes:

OPSLOG Browse Column: The high-order bit in the AFLAGS (AF) column

MSG.AUTOTOKN

The NetView automation token, which is taken from the WQEAUTOT flag in the WQE.

Data Type

8-byte character, read/write

Example

Parm1

Notes:

OPSLOG Browse Column: AUTOTOKN

MSG.BEWTO

A value indicating whether the current message was issued as a branch entry WTO.

Data Type

Integer, read-only

Values
0

Message is not a branch entry WTO.

1

Message is a branch entry WTO.

Usage Notes:

This variable can be used to determine whether MSG.JOBNAME or MSG.OJOBNAME should be used in your automation procedure.

Example

The following code can be used to determine which variable contains the appropriate JOBNAME:

IF MSG.BEWTO = 1 THEN
  jobname = MSG.OJOBNAME
ELSE
  jobname = MSG.JOBNAME
MSG.CMDRESPONSE

A value indicating whether the current message is a command response.

Data Type

Integer, read-only

Values
0

Message is not a command response.

1

Message is a command response

Example

0

OPSLOG Browse Column: Third bit of AFLAGS

MSG.COLOR

The color that the message has in OPSLOG Browse and, optionally, on the console.

Data Type

1-byte binary (unprintable), read/write

Note: Write takes effect only if the value of the PROPAGATEATTR parameter is YES.

Example

'00'X

Notes:

OPSLOG Browse Column: COLOR

MSG.CONSNAME

The console name that is used to get messages from the subsystem interface:

Data Type

Character, read/write

Example

MSTCONS

OPSLOG Browse Column: CONSNAME

MSG.CONTROLLN

A value indicating whether the current message is a control line in a multiline message (MLWTO).

Data Type

Character, read-only

Values
0

Not a control line.

1

A control line.

Example

1

OPSLOG Browse Column: Fourth bit of OPSFLAGS

MSG.DATALN

A value indicating whether the current message is a data line in a multiline message (MLWTO).

Data Type

Character, read-only

Values
0

Not a data line.

1

A data line.

Example

1

OPSLOG Browse Column: Sixth bit of OPSFLAGS

MSG.DATESTMP

The date when the message was issued.

Data Type

Character, read-only

Example

20050908

Notes:

Recommended

Use the REXX DATE("S") function because that date always matches the date for the message in OPSLOG Browse. MSG.DATESTMP is provided for completeness.

MSG.DESC

The descriptor codes of the message, which are taken from the WQEDESCD field of the WQE control block.

Data Type

2-byte binary (unprintable), read/write

Example

'0400'X

Note: Use the OPSBITS function of OPS/REXX to set the MSG.DESC variable. For a description of message descriptor codes, see the IBM documentation.

OPSLOG Browse Column: ROUTE or ROUTEX

MSG.DISP

The current disposition of the message that is set previously in executed rules. For example, SUPPRESS.

Data Type

Integer, read-only

Example

4

Note: CA OPS/MVS sets this variable automatically after each rule processes a message; this variable cannot be set manually. The next rule always gets the highest return code that is set in all of the previous rules. The following list shows the correspondence between the MSG.DISP value and the AOF RETURN values:

0

NORMAL

4

SUPPRESS

8

DISPLAY

12

DELETE

OPSLOG Browse Column: DISP

Note: This column uses descriptive character strings to display the final, highest return code.

MSG.ENDLN

A value indicating whether the current message is the end line in a multiline message (MLWTO).

Data Type

Character, read-only

Values
0

Not an end line.

1

An end line.

Example

1

OPSLOG Browse Column: Seventh bit of OPSFLAGS

MSG.FLAGS

The message type is taken from CA OPS/MVS message flags. For example, MLWTO.

Data Type

2-byte binary (unprintable), read-only

Example

'0010'X

Message Flags

Many of the bits represented in MSG.FLAGS are also represented by bit-specific MSG variables. We recommend using the bit-specific variables wherever possible. In all cases, the bit-specific variable takes on a value of 1 or 0 to show whether the corresponding bit is set.

'8000'X

Single-line message flag.

Single-bit equivalent: MSG.SINGLELN

'4000'X

WTOR message flag.

Single-bit equivalent: MSG.WTOR

'2000'X

Multiline message (MLWTO) flag.

Single-bit equivalent: MSG.MULTILN

'1000'X

Control line of an MLWTO flag.

Single-bit equivalent: MSG.CONTROLLN

'0800'X

Label line of an MLWTO flag.

Single-bit equivalent: MSG.LABELLN

'0400'X

Data line of an MLWTO flag.

Single-bit equivalent: MSG.DATALN

'0200'X

End line of an MLWTO flag. See note.

Single-bit equivalent: MSG.ENDLN

'0100'X

Last command output message flag. CA OPS/MVS sets this variable to mark the last output line.

'0080'X

Urgent attention message flag. Set when the message has descriptor code 1 or 11 set.

Single-bit equivalent: MSG.URGENT

'0040'X

Immediate action message flag, Set when the message has descriptor code 2 is set or is a WTOR.

Single-bit equivalent: MSG.IMMEDACT

'0020'X

Message is from a local JES3.

'0010'X

Current message is a z/OS (WTO/SVC 35) message from a global JES3.

'0002'X

Current message is a WTL (SVC 36) rather than a WTO. CA OPS/MVS intercepts WTL messages only if its SSIWTL parameter is set to YES.

'0008'X

Current message is from an authorized task.

'0004'X

Current message was originally issued on a different system and is now being reissued on the current system.

Single-bit equivalent: MSG.REISSUE

'0001'X

MPF has suppressed the current message.

Single-bit equivalent: MSG.MPFSUPP

Note: The '0200'X bit is set for the last line of an MLWTO, and usually marks the end of output from a single command. However, HSM, JES2, and other products can issue multiple MLWTOs in response to a single command, so this bit is not a reliable indication that output has been completed.

OPSLOG Browse Column: OPSFLAGS

MSG.FULLTEXT

The COF feature of the product generates message rule events from the CICS Transient Data Queue. This variable contains up to 256 characters of the TD queue message text. When the MSG.TEXT variable is reworded, it replaces the MSG.FULLTEXT value once the message event is fully processed by the message rules. Because the maximum length of MSG.TEXT is shorter than MSG.FULLTEXT, truncation of the original message text value can occur. For all other message rule event types, this variable is the same as MSG.TEXT.

Data Type

256-byte character, read-only

Example
DFHTD0101I applid Transient Data initialization has ended.
MSG.ID

The message identifier, usually the first token, or the first blank delimited word of the message text. This variable has a maximum length of ten characters. If this token exceeds ten characters in length, this variable contains the leftmost ten characters of the token.

Data Type

Character, read-only

Example

IEF125I

Note: The MSG.ID variable value determines which message rules execute for the current message event. This variable never contains any special screen characters or leading or trailing blanks.

OPSLOG Browse Column: MSGID

MSG.IMMEDACT

A value indicating whether the current message is an immediate action message. An immediate action message is one that has descriptor code 2 set.

Data Type

Character, read-only

Values

0

Not an urgent attention message.

1

An urgent attention message.

Example

1

OPSLOG Browse Column: Tenth bit of OPSFLAGS

MSG.IMSID

The IMS ID of the associated IMS control region; or, for non-IMS messages, the value of the IMSNONE parameter. The default for the IMSNONE parameter is NONE.

Data Type

Character, read-only

Example

IMSA

Notes:

OPSLOG Browse Column: IMSID

MSG.JOBID

The identifier that JES2 or JES3 assigned to the message issuer.

Data Type

Character, read-only

Examples
  • T12345 for a TSO user
  • J12345 for a job
  • S12345 for a started task
  • ACF2 for a started task that is started with SUB=MSTR.

When JOBIDs greater than 100,000 are supported and activated in z/OS, the examples are in the format T0012345, J0012345, and S0012345.

Note: The contents of this variable depend on where the current address space was created:

This value can be different than the value OPSINFO('JOBID') returns when used in a message rule. MSG.JOBID contains the job ID explicitly specified by the message issuer or determined by z/OS. Messages that are issued by JES2 in response to JES2 commands specify the job ID of the address space to which the message relates rather than the job ID of JES2. When the WQE does not contain an explicit job ID. CA OPS/MVS uses the job ID of the address space that issued the message.

OPSLOG Browse Column: JOBID

MSG.JOBLOGSUP

A value indicating whether the message should appear in the JES job log of the job that issued the message or on whose behalf the message was issued.

Data Type

Integer, read/write

Values
0

Display the message in the JES job log.

1

Suppress the message from the JES job log.

Example

1

Notes:

OPSLOG Browse Column: Sixth bit of AFLAGS

MSG.JOBNAME

The job name of the message issuer, which is taken from:

Note: The MSG.JOBNAME value is blank for some JES3 messages.

Data Type

Character, read-only

Example

VTAM

OPSLOG Browse Column: JOBNAME

MSG.JOBNM

The name of the job that is associated with this line of output, which is taken from the WQEJOBNM field of the WQE.

Data Type

Character, read-only

Example

VTAM

Notes:

OPSLOG Browse Column: JOBNM

MSG.LABELLN

A value indicating whether the current message is a label line in a multiline message (MLWTO).

Data Type

Character, read-only

Values

0

Not a label line.

1

A label line.

Example

1

OPSLOG Browse Column: Fifth bit of OPSFLAGS

MSG.LINETYPE.0

Shows number of lines available in the MLWTO. Only valid if the MLWTO option is specified on the message specifier.

Data Type

Character, read-only

MSG.LINETYPE. n

The line type of each line in the MLWTO ( msg.linetype.1 is the line type of the first line, msg.linetype.2 is the line type of the second line,etc). Only valid if the MLWTO option is specified on the message specifier.

Data Type

Character, read-only

Values
C

Control line

L

Label line

D

Data line

E

End line

DE

Data and end line

MSG.MCSFG

Internal z/OS, IMS, or MCS message flags, which are taken from:

Data Type

3-byte binary (unprintable), read-only

Example

'0E0000'X

Note: For information about WQE flags, see the IBM documentation.

OPSLOG Browse Column: FLAGS

MSG.MIC

A value indicating whether the current message is a message that was imported and reissued on this system by CA MIC.

Data Type

Character, read-only

Values

0

CA MIC did not reissue this message.

1

CA MIC reissued this message.

Example

1

Note: When the AOFMESSAGES parameter is set to MVSGLOBAL, CA MIC reissued messages are eligible for processing by the AOF. Even response messages which are returned to this system as a result of a cross-system command that is issued on this system through CA MIC.

MSG.MLWTOMIN

When the message is a minor line of an MLWTO message, the value is 1. When the message is the major line of an MLWTO message, or the only line of a WTO message, the variable 0.

Data Type

Character, read-only

OPSLOG Browse Column: Second bit of AFLAGS

MSG.MPFSUPP

A value indicating whether the z/OS Message Processing Facility (MPF) has suppressed the current message.

Data Type

Character, read-only

Values
0

MRF did not suppress this message.

1

MPF suppressed this message.

Example

1

Note: MPF processes messages before they are passed to the subsystem interface where CA OPS/MVS processes them.

OPSLOG Browse Column: 16th bit of OPSFLAGS

MSG.MSFID

The system ID of the system where the message originated, supplied by the CA OPS/MVS Multi-System Facility (MSF).

Data Type

Character, read-only

Example

SYSA

Note: The MSF ID of a message is the local SYSID, for a message that is created on the current system. For a remote system, the MSFID is the SYSID of that system.

OPSLOG Browse Column: MSFID

MSG.MULTILN

A value indicating whether the current message is a part of a multiline message (MLWTO).

Data Type

Character, read-only

Values

0

Not part of a multiline message.

1

Part of a multiline message.

Example

1

Third bit of OPSFLAGS

MSG.OASID

The original ASID associated with the message.

When the message is:

The value differs from OPSINFO("ASID") and represents the ASID in which the message was intercepted.

In the following cases, the value of MSG.OASID is always the same as OPSINFO("ASID"):

Data Type

2-byte binary (unprintable), read-only

Example

'003E'X

Notes:

MSG.ODESC

The original descriptor codes that are assigned to a message.

Data Type

2-byte binary (unprintable), read-only

Example

'0400'X

Note: The MSG.ODESC variable is equivalent to the Automate &DESC environmental variable.

MSG.OJOBNAME

The original job name that is associated with the message.

When the message is:

This value differs from MSG.JOBNAME.

In the following cases, the value of MSG.OJOBNAME is always the same as MSG.JOBNAME:

Data Type

Character, read-only

Example

VTAM

MSG.OMAJORTEXT

The original message text. The value of MSG.OMAJORTEXT does not change from a rule to a rule, even if a rule rewords the message text.

Data Type

Character, read-only

Values

For a WTO message, the value is the original message text; for an MLWTO message, the value is the possibly updated text from the first line of the message.

Notes:

MSG.OROUTE

The original routing codes that are assigned to a message.

Data Type

16-byte binary (unprintable), read-only

Example

'100000000000000000000000000000'X

Note: The MSG.OROUTE variable is equivalent to the Automate &ROUTCDE environmental variable.

MSG.OTEXT

The complete text of a secondary line of a multiline WTO message; this value is null for a message that is not a multiline WTO. The secondary line is a line other than the first or primary line.

Data Type

Character, read-only

Note: The MSG.OTEXT variable is equivalent to the Automate &MLMSG environmental variable.

MSG.REISSUE

A value indicating whether the current message is a message that was originally issued on another system and has been transported and then reissued on this system.

Data Type

Character, read-only

Values
0

Not a reissued message.

1

A reissued message.

Example

1

Note: Messages can be reissued as a result of sysplex console processing, MSF, CA MIC, and possibly other software products. Reissued messages are only eligible to be processed by the AOF when the AOFMESSAGES parameter is set to MVSGLOBAL.

14th bit of OPSFLAGS

MSG.REPLYID

The reply number that is associated with a WTOR message, which is taken from the OREID field of the ORE.

Data Type

Character, read-only

Example

01

Notes:

OPSLOG Browse Column: First part of the text field when the message is a WTOR.

MSG.REPORTID

The report ID associated with the message. If the message comes from the generic data set interface, MSG.REPORTID contains the subsystem report ID parameter.

Data Type

Character, read-only

Example

PAYLOG1

OPSLOG Browse Column: DSPNAME

MSG.ROUTE

The routing codes of the message, that is taken from the WQE control block.

Data Type

16-byte binary (unprintable), read/write

Example

'10000000000000000000000000000000'X

Notes:

Use the OPSBITS function of OPS/REXX to set this variable.

For a description of routing codes, see the IBM documentation.

OPSLOG Browse Column: ROUTE or ROUTEX

MSG.SINGLELN

A value indicating whether the current message is a single-line message.

Data Type

Character, read-only

Values

0

Not a single-line message.

1

A single-line message.

Example

1

OPSLOG Browse Column: First bit of OPSFLAGS

MSG.SPCHR

The message special screen character. For example, the + preceding problem CA OPS/MVS messages.

Data Type

Character, read-only

Example

+

Note: This variable often is blank. For more information about special screen characters, see the IBM documentation.

OPSLOG Browse Column: SPECIAL

MSG.SUBSMOD

A value indicating whether the current message is eligible for subsystem modification. The value of the SUBSMOD parameter that is specified for the WTO message determines message eligibility.

Data Type

Integer, read-only

Values

0

Message is not eligible for subsystem modification.

1

Message is eligible for subsystem modification.

Example

1

OPSLOG Browse Column: Fifth bit of AFLAGS

MSG.SYNA

The system name of the system issuing the message.

Data Type

Character, read-only

Example

MVS34

Notes:

The system name is derived from the SYSNAME parameter specified in the appropriate IEASYSxx member of the Logical Parmlib Concatenation.

For messages imported through the CA MIC product, this variable contains the name of the system from which the message originated.

OPSLOG Browse Column: SYSNAME or SYNA

MSG.SYSID

The system ID of the system where the message was issued, usually the SMF ID. 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

Example

S000

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 CA OPS/MVS Parameter Reference.

OPSLOG Browse Column: SYSID

MSG.TERMNAME

The name of the terminal that is associated with the message:

Data Type

Character, read-only

Example

OPSS1

OPSLOG Browse Column: TERMNAME

MSG.TEXT

The message text:

Data Type

Character, read/write

Example

IEF125I USERA - LOGGED ON - TIME=06.49.05

OPSLOG Browse Column: Text is always displayed.

MSG.TEXT.0

Shows the number of lines available in a multiline message. Only valid if the MLWTO option is specified on the message specifier.

Data Type

Character, read only

MSG.TEXT.n

Text of each data line of a multiline message. Only valid if the MLWTO option is specified on the message specifier.

Data Type

Character, read only

MSG.TIMESTMP

The time when the message was issued, as it would appear on an MCS console through MFORM=T.

Data Type

Character, read-only

Example

12.43.14

Notes:

Recommended

Use the REXX TIME("N") function because that time always matches the time for the message in OPSLOG Browse. MSG.TIMESTMP is provided for completeness.

OPSLOG Browse Column: TIMESTMP

MSG.TOKEN

The variable token set when the MSF receives the message and the originating system specified OPSSEND('W' ,...).

Data Type

4-byte binary (unprintable), read-only

Example

'00004C94'

Notes:

OPSLOG Browse Column: TOKEN

MSG.URGENT

A value indicating whether the current message is an urgent attention message. An urgent attention message is one that has descriptor codes 1 or 11 set.

Data Type

Character, read-only

Values
0

Not an urgent attention message.

1

An urgent attention message.

Example

1

OPSLOG Browse Column: Ninth bit of OPSFLAGS

MSG.USER

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

OPSLOG Browse Column: USER

MSG.USERID

The user ID for the security product on your system. This value is usually the CA ACF2 user ID from the ACFASVT or the RACF user ID from the current ACEE. For IMS, the user ID from the CTB is valid only if IMS is generated with enhanced security.

Data Type

Character, read-only

Example

TSOID01

Note: The MSG.USERID value can have the same value as the JOBNAME which is typical for a TSO address space. These values need not match; for instance, the user IDs and the job names for batch jobs or started tasks can be different.

OPSLOG Browse Column: USERID

MSG.WTOID

The internal WTO sequence number, which is taken from the WQERTCT field of the WQE delimited word of the message text.

Data Type

4-byte binary (unprintable), read-only

Example

'00004C94'X

Notes:

OPSLOG Browse Column: WTOID

MSG.WTOR

A value indicating whether the current message is a WTOR.

Data Type

Character, read-only

Values
0

This message is not a WTOR.

1

This message is a WTOR.

Example

1

OPSLOG Browse Column: Second bit of OPSFLAGS

MSG.WTP

A value indicating whether the message is set to Write to Programmer (WTP). WTP messages appear in the JESYSMSG data set. The JESYSMSG data that is set. These data set allocated data set messages appear and are different from the job log of the job that issued the message or on whose behalf the message was issued. If the issuing address space is a TSO address space, a WTP message is written (TPUT) to the TSO screen.

Data Type

Integer, read/write

Values
1

Issue the WTP

0

Do not issue the WTP

Example

1

For example, Use the OPSPRM function to change the severity of message OPS1000 to J. Keep the results of SAY statements from rules out of the JESYSMSG data set by setting the MSG.WTP variable to 0 in a message rule for OPS1000J.

By default, messages that are issued with a ROUTE code of 11 have MSG.WTP set to 1.

OPSLOG Browse Column: Seventh bit of AFLAGS