You can use all AOF variable types in MSG rules, as described in the chapter “AOF Rule Tools.” You can use the following unique AOF event variables in the )PROC section of a MSG rule, and you can manually interrogate the corresponding OPSLOG display field as an aid in debugging or implementing rule logic.
Displays a value indicating whether the message should be retained in the Action Message Retention Facility (AMRF).
Data Type: Integer, read/write
Possible Values: 0 (do not retain this message) or 1 (retain this message)
Sample Value: 1
Usage Notes:
Example: The following two lines of code in a MSG rule will result in the message being retained by AMRF:
MSG.DESC = OPSBITS("IMEDACTN")
MSG.AMRF=1
OPSLOG Browse Column: Fourth bit of AFLAGS
The NetView automation flag, taken from the WQESAUT bit flag. In addition, the WQEAUTO bit flag is also used.
Data Type: Integer, read/write
Sample Value: 1, if automation is specified
Notes:
OPSLOG Browse Column: The high order bit in the AFLAGS (AF) column
The NetView automation token, taken from the WQEAUTOT flag in the WQE
Data Type: 8-byte character, read/write
Sample Value: Parm1
Notes:
OPSLOG Browse Column: AUTOTOKN
A value indicating whether the current message is a command response
Data Type: Integer, read-only
Possible Values: 0 (message is not a command response) and 1 (message is a command response)
Sample Value: 0
OPSLOG Browse Column: Third bit of AFLAGS
The color that the message will have in OPSLOG Browse and, optionally, on the console
Data Type: 1-byte binary (unprintable), read/write (write takes effect only if the value of the PROPAGATEATTR parameter is YES)
Sample Value: '00'X
Notes:
OPSLOG Browse Column: COLOR
The name of the console used to get messages from the subsystem interface
Data Type: Character, read/write
Sample Value: MSTCONS
OPSLOG Browse Column: CONSNAME
A value indicating whether the current message is a control line a multi-line message (MLWTO)
Data Type: Character, read-only
Possible Values: 0 (this is not a control line) and 1 (this is a control line)
Sample Value: 1
OPSLOG Browse Column: Fourth bit of OPSFLAGS
A value indicating whether the current message is a data line in a multi-line message (MLWTO)
Data Type: Character, read-only
Possible Values: 0 (this is not a data line) and 1 (this is a data line)
Sample Value: 1
OPSLOG Browse Column: Sixth bit of OPSFLAGS
The date when the message was issued
Data Type: Character, read-only
Sample Value: 20050908
Notes:
It is recommended that you use the REXX DATE("S") function since that date will always match the date for the message in OPSLOG Browse. MSG.DATESTMP is provided for completeness.
The descriptor codes of the message, taken from the WQEDESCD field of the WQE control block
Data Type: 2-byte binary (unprintable), read/write
Sample Value: '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
The current disposition of the message (such as SUPPRESS) as set by previously executed rules
Data Type: Integer, read-only
Sample Value: 4
Note: CA OPS/MVS sets this variable automatically after each rule processes a message; you cannot set the variable manually. The next rule always gets the highest return code set by all of the previous rules. The following list shows the correspondence between the MSG.DISP value and the AOF RETURN values:
OPSLOG Browse Column: DISP (This column uses descriptive character strings to display the final, highest return code.)
A value indicating whether the current message is the end line in a multi-line message (MLWTO)
Data Type: Character, read-only
Possible Values: 0 (this is not an end line) and 1 (this is an end line)
Sample Value: 1
OPSLOG Browse Column: Seventh bit of OPSFLAGS
The message type (for example, MLWTO), taken from CA OPS/MVS message flags described below
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.
Single line message flag.
Single-bit equivalent: MSG.SINGLELN
WTOR message flag.
Single-bit equivalent: MSG.WTOR
Multi-line message (MLWTO) flag.
Single-bit equivalent: MSG.MULTILN
Control line of a MLWTO flag.
Single-bit equivalent: MSG.CONTROLLN
Label line of a MLWTO flag.
Single-bit equivalent: MSG.LABELLN
Data line of a MLWTO flag.
Single-bit equivalent: MSG.DATALN
End line of a MLWTO flag. See note.
Single-bit equivalent: MSG.ENDLN
Last command output message flag (set by CA OPS/MVS to mark the last output line).
Urgent attention message flag; set if message has descriptor code 1 or 11 set.
Single-bit equivalent: MSG.URGENT
Immediate action message flag; set if message has descriptor code 2 set, or is a WTOR.
Single-bit equivalent: MSG.IMMEDACT
Message is from a local JES3.
Current message is a z/OS (WTO/SVC 35) message from a global JES3.
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.
Current message is from an authorized task.
Current message was originally issued on a different system and is now being reissued on the current system.
Single-bit equivalent: MSG.REISSUE
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 may 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
For message rule events from the CICS Transient Data Queue that are generated by the COF feature of the product, this variable contains up to 256 characters of the TD queue message text. If the MSG.TEXT variable is reworded, it will replace the MSG.FULLTEXT value once the message event has been fully processed by message rules. Since the maximum length of MSG.TEXT is shorter than MSG.FULLTEXT, truncation of the original message text value may occur. For all other message rule event types, this variable is the same as MSG.TEXT.
Data Type: 256 byte character, read-only
Sample Value: DFHTD0101I applid Transient Data initialization has ended.
The message identifier, usually the first token or the first blank delimited word of the message text. This variable has a maximum length of 10 characters. If this token exceeds 10 characters in length, this variable contains the leftmost 10 characters of the token.
Data Type: Character, read-only
Sample Value: IEF125I
Note: The MSG.ID variable value determines which message rules execute for the current message event. This variable will never contain any special screen characters or leading or trailing blanks.
OPSLOG Browse Column: MSGID
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
Possible Values: 0 (this is not an urgent attention message) and 1 (this is an urgent attention message)
Sample Value: 1
OPSLOG Browse Column: Tenth bit of OPSFLAGS
The IMS ID of the associated IMS control region; or, for non-IMS messages, the value of the IMSNONE parameter (the default of the IMSNONE parameter is NONE)
Data Type: Character, read-only
Sample Value: IMSA
Notes:
OPSLOG Browse Column: IMSID
The identifier that JES2 or JES3 assigned to the message issuer
Data Type: Character, read-only
Sample Values: T12345 for a TSO user; J12345 for a job; S12345 for a started task; ACF2 for a started task started with SUB=MSTR. When JOBIDs greater than 100,000 are supported and activated in z/OS 1.2 and above, the above sample values will be in the format T0012345, J0012345, and S0012345.
Note: The contents of this variable depend on where the current address space was created:
This value may be different than the value returned by OPSINFO('JOBID') when used in a message rule. MSG.JOBID contains the job ID explicitly specified by the message issuer or determined by z/OS. Messages 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. If 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
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
Possible Values: 0 (display the message in the JES job log) or 1 (suppress the message from the JES job log)
Sample Value: 1
Notes:
OPSLOG Browse Column: Sixth bit of AFLAGS
The job name of the message issuer, taken from:
Note: The MSG.JOBNAME value is blank for some JES3 messages.
Data Type: Character, read-only
Sample Value: VTAM
OPSLOG Browse Column: JOBNAME
The name of the job associated with this line of output, taken from the WQEJOBNM field of the WQE
Data Type: Character, read-only
Sample Value: VTAM
Notes:
OPSLOG Browse Column: JOBNM
A value indicating whether the current message is a label line in a multi-line message (MLWTO).
Data Type: Character, read-only
Possible Values: 0 (this is not a label line) and 1 (this is a label line)
Sample Value: 1
OPSLOG Browse Column: Fifth bit of OPSFLAGS
Internal z/OS, IMS, or MCS message flags, taken from:
Data Type: 3-byte binary (unprintable), read-only
Sample Value: '0E0000'X
Note: For information about WQE flags, see the IBM documentation.
OPSLOG Browse Column: FLAGS
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
Possible Values: 0 (message not reissued by CA MIC) and 1 (message reissued by CA MIC)
Sample Value: 1
Note: CA MIC reissued messages (even messages that are the responses that are returned to this system as a result of a cross-system command issued on this system through CA MIC), are only eligible to be processed by the AOF when the AOFMESSAGES parameter is set to MVSGLOBAL.
If the message is a minor line of a MLWTO message, the value is 1; if the message is the major line of a MLWTO message, or the only line of a WTO message, the value of the variable is 0.
Data Type: Character, read-only
OPSLOG Browse Column: Second bit of AFLAGS
A value indicating whether the z/OS Message Processing Facility (MPF) has suppressed the current message.
Data Type: Character, read-only
Possible Values: 0 (message not suppressed by MPF) and 1 (message suppressed by MPF)
Sample Value: 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
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
Sample Value: SYSA
Note: The MSF ID of a message is the local SYSID, for a message created on the current system. For a remote system, the MSFID is the SYSID of that system.
OPSLOG Browse Column: MSFID
A value indicating whether the current message is a part of a multi-line message (MLWTO).
Data Type: Character, read-only
Possible Values: 0 (this is not part of a multi-line message) and 1 (this is part of a multi-line message)
Sample Value: 1
Third bit of OPSFLAGS
The original ASID associated with the message.
When the message is issued asynchronously from the CONSOLE address space or is reissued for some reason, this value differs from OPSINFO("ASID") which 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
Sample Value: '003E'X
Notes:
The original descriptor codes assigned to a message
Data Type: 2-byte binary (unprintable), read-only
Sample Value: '0400'X
Note: The MSG.ODESC variable is equivalent to the Automate &DESC environmental variable.
The original job name associated with the message.
When the message is issued asynchronously from the CONSOLE address space or is reissued for some reason, 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
Sample Value: VTAM
The original message text. The value of MSG.OMAJORTEXT does not change from rule to rule, even if a rule rewords the message text.
Possible Values: For a WTO message, the value is the original message text; for an MLWTO message, the value is the possibly updated text from first line of the message
Data Type: Character, read-only
Notes:
The original routing codes assigned to a message
Data Type: 16-byte binary (unprintable), read-only
Sample Value: '100000000000000000000000000000'X
Note: The MSG.OROUTE variable is equivalent to the Automate &ROUTCDE environmental variable.
The complete text of a secondary line (a line other than the first or primary line) of a multi-line WTO message; this value is null for a message that is not a multi-line WTO
Data Type: Character, read-only
Note: The MSG.OTEXT variable is equivalent to the Automate &MLMSG environmental variable.
A value indicating whether the current message is a message that was originally issued on another system and has been transported and subsequently reissued on this system
Data Type: Character, read-only
Possible Values: 0 (this is not a reissued message) and 1 (this is a reissued message)
Sample Value: 1
Note: Messages may 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
The reply number associated with a WTOR message, taken from the OREID field of the ORE
Data Type: Character, read-only
Sample Values: 01
Notes:
OPSLOG Browse Column: First part of the text field when the message is a WTOR
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
Sample Value: PAYLOG1
OPSLOG Browse Column: DSPNAME
The routing codes of the message, taken from the WQE control block
Data Type: 16-byte binary (unprintable), read/write
Sample Value: '100000000000000000000000000000'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
A value indicating whether the current message is a single line message
Data Type: Character, read-only
Possible Values: 0 (this is not a single line message) and 1 (this is a single line message)
Sample Value: 1
OPSLOG Browse Column: First bit of OPSFLAGS
The message special screen character. For example, the + preceding problem CA OPS/MVS messages.
Data Type: Character, read-only
Sample Value: +
Note: This variable often is blank. For more information about special screen characters, see the IBM documentation.
OPSLOG Browse Column: SPECIAL
A value indicating whether the current message is eligible for subsystem modification. It is determined by the value of the SUBSMOD parameter specified for the WTO message.
Possible Values: 0 (message is not eligible for subsystem modification) and 1 (message is eligible for subsystem modification)
Data Type: Integer, read-only
Sample Value: 1
OPSLOG Browse Column: Fifth bit of AFLAGS
The system name of the system issuing the message
Data Type: Character, read-only
Sample Value: 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
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
Sample Value: 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 Parameter Reference.
OPSLOG Browse Column: SYSID
The name of the terminal associated with the message:
Data Type: Character, read-only
Sample Value: OPSS1
OPSLOG Browse Column: TERMNAME
The message text: for z/OS messages, taken from the WQE text field (excluding special characters and blanks); for JES3 messages, taken from a parameter list passed to the IATUX31 exit; for IMS messages, taken from the AOI exit parameter list.
Data Type: Character, read/write
Sample Value: IEF125I USERA - LOGGED ON - TIME=06.49.05
OPSLOG Browse Column: Text is always displayed.
The time when the message was issued, as it would appear on an MCS console through MFORM=T
Data Type: Character, read-only
Sample Value: 12.43.14
Notes:
OPSLOG Browse Column: TIMESTMP
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
Sample Value: '00004C94'
Notes:
OPSLOG Browse Column: TOKEN
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
Possible Values: 0 (this is not an urgent attention message) and 1 (this is an urgent attention message)
Sample Value: 1
OPSLOG Browse Column: Ninth bit of OPSFLAGS
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
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
Sample Value: TSOID01
Note: The MSG.USERID value may 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 may be different.
OPSLOG Browse Column: USERID
The internal WTO sequence number, taken from the WQERTCT field of the WQE delimited word of the message text
Data Type: 4-byte binary (unprintable), read-only
Sample Value: '00004C94'X
Notes:
OPSLOG Browse Column: WTOID
A value indicating whether the current message is a WTOR.
Data Type: Character, read-only
Possible Values: 0 (this message is not a WTOR) and 1 (this message is a WTOR)
Sample Value: 1
OPSLOG Browse Column: Second bit of OPSFLAGS
A value indicating whether the message should be WTPed. WTP stands for Write to Programmer. WTPed messages appear in the JESYSMSG data set (this is the same place that allocation messages appear and is different than 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
Possible Values: 1 (issue the WTP) or 0 (do not issue the WTP)
Sample Value: 1
For example, if you use the OPSPRM function to change the severity of message OPS1000 to J, you can 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 issued with a ROUTE code of 11 will have MSG.WTP set to 1.
OPSLOG Browse Column: Seventh bit of AFLAGS
|
Copyright © 2011 CA.
All rights reserved.
|
|