|
|
|
Following execution of any of the &INTREAD, &LOGREAD, &PPOREAD, or &MSGREAD verbs, message profile variables are set to reflect the message profile of the message read by the verb statement. The particular variables that are set depend on the verb executed and on the class of message received.
This section describes the different values that can be set in the variables that apply to the &INTREAD, &LOGREAD, and &MSGREAD verbs, and the conditions under which each of the variables can be set. The individual variables that form the message profiles of the message flows handled by the different verbs are then cross-referenced against the individual verbs in the remaining sections.
Note: System profile variables are available immediately after the &xxxREAD statement is executed and are generally available until another NCL statement is executed that alters the profile. System variables are valid only within the scope of the procedure and their values are unpredictable when control is passed to another procedure level. MDOs can be shared between called procedures using SHRVARS and explicitly on the &return statement.
Following is a list of the complete set of message profile variables that apply to these three verbs. Their MDO equivalents are included in brackets, where relevant.
Note: stem can be $MSG, $INT or $LOG depending on which verb caused the variable to be set.
Specifies whether an &INTREAD operation has been satisfied by a request message or a response message. Values are REQ (request message) or RESP (response message) or NONE (no message).
Indicates whether the message will cause the terminal alarm to sound. Value is YES or NO.
Indicates whether the message was generated by a MSG ALL command. Value is YES or NO.
Indicates the color attribute of the message. Value can be any one of NONE, RED, BLUE, GREEN, YELLOW, TURQUOISE, PINK, or WHITE.
Indicates whether the message is a delete operator message instruction. Value is YES or NO. This value is dependent also on the setting of the &ZMTYPE variable.
Contains the delete operator message identifier (domid) of the message read, if the message has the non-roll delete message attribute, as determined by the setting of the &ZMNRD variable. If &ZMNRD=NO, this variable is set to null.
Is set when the incoming message was generated by an &EVENT verb and contains the nclid of the procedure which issued the &EVENT.
Is set for incoming event messages (N00102) and represents the EDS profile name which resulted in delivery of the event notification.
Contains the routecde of the incoming event message (N00102) if the ROUTECDE operand was specified on the originating &EVENT verb.
Is set for incoming event messages (N00102) to the time the event originated. Time is in the format HH.MM.SS.TTT.
Is set when the incoming message was generated by an &EVENT verb and contains the user ID of the user who issued the &EVENT verb. This variable is also set for some system events and represents the user who was responsible for the event generation.
Indicates whether the message originated from File Transmission Services (FTS). Value is YES or NO.
Indicates the display highlighting attributes of the message. Values are NONE, USCORE, REVERSE, or BLINK.
Indicates the display intensity attribute of the message. Values are HIGH or LOW or null if no message is being processed.
Indicates the terminal name of the user to whom a log message is to be attributed. Value is the name of a terminal. (This is available to &LOGREAD only.)
Indicates whether a log message is an echo to the log of a command. Value is YES or NO. (This is available to &LOGREAD only.)
Contains the message prefix of the last handler of the message just received.
Indicates the type of the last handler of the message just received. Values can be:
If the message was generated within this system.
If the message was delivered across a ROF session.
If the message was delivered across an MAI OC session.
Contains the timestamp of a log message. (This is available to &LOGREAD only.) Time is in the format HH.MM.SS.TTT.
Contains the user ID to whom generation of the log message is to be attributed. (This is available to &LOGREAD only.)
Contains the mapname of the object in $MSG.USERMDO for the current message (if present).
Indicates whether the message received is a monitor class message. Values are YES or NO.
Indicates whether the message received is a standard message or not. The setting of this variable is always opposite to the setting of the &ZMDOM variable and is dependent on the setting of the &ZMTYPE variable.
Indicates the (hexadecimal) message code attribute of this message. Value can be 00-FF. The message code dictates which user IDs are eligible to receive the message.
The domain ID of the last region to handle this message. This can be the same as the originating system, or different if the message was originated by a remote system and then routed onwards by an intermediate system.
The domain ID of the region from which this message originated. If sourced from the local system it will contain the local system's domain ID. If sourced from a remote system this variable carries the domain ID of the originating system even though the message might have been routed onwards by intermediate systems.
Indicates whether the message carries the non-roll delete attribute. Values can be:
Not a non-roll delete message.
Message is non-roll delete and can be deleted only by a delete operator message (DOM) instruction.
If the message is non-roll delete but is deleted only by the cursor delete function from an OCS window.
Indicates whether the message has been received as a result of a NRDRET command being issued by the user. This allows an NCL procedure to detect redisplayed messages and ignore them for event analysis purposes. Value is YES or NO.
Contains the message prefix of the originator of the message just received.
Indicates the type of the originator of the message just received. Values can be:
If the message was generated within this system.
If the message was delivered across a ROF session.
If the message was delivered across an MAI OC session.
Indicates whether any PPO message profile information is available concerning this message. Value is YES or NO. If YES, then other message profile variables are available containing information relating to certain PPO attributes of the message.
Indicates whether the message originated from PPO. Value is YES or NO.
If &ZMPPODTA = YES, then the severity level of the PPO message is available in this variable. Value can be U (undeliverable), I (information), W (Important!), N (normal), or S (severe).
If &ZMPPODTA = YES, this variable contains the time that the message originated. Time is in the format HH.MM.SS.TTT.
If &ZMPPODTA = YES, this variable contains the VTAM message number of the PPO message.
Indicates whether the message text has been prefixed with identifier values, for example MAI OC session identifier or ROF message prefix. Values are YES or NO.
Is set to the entire message text, prefixed with any ROF or MAI OC session identifiers according to the current profile settings, as it will appear on the OCS window if the message is allowed to flow to the window unchanged.
If &ZINTYPE=REQ (&INTREAD satisfied by a request message), this variable is set to the user ID of the user that issued the INTQUE command that generated the message, or to the NCL ID of the NCL process that issued the INTQUE command or the &WRITE statement. This variable is dependent on &ZINTYPE for relevance, and its setting is categorized by the &ZMREQSRC variable which will also be set. (This is available to &INTREAD only.)
If &ZINTYPE=REQ (&INTREAD satisfied by a request message), this variable indicates whether the process that generated the message was a user, another NCL process or a system notification. Values are USER, NCL or SYSTEM respectively. (This is available to &INTREAD only.)
Indicates whether the message was solicited or unsolicited. A solicited message is usually a command response. Values are YES (solicited) or NO.
Indicates the verb that last set the values of the message profile variables. The suite of message profile variables remain set until changed by the execution of another verb that modifies the suite. Values are:
After &LOGREAD, this variable does not include the standard log message heading information of user ID, time, and terminal name. These values are available from other message profile variables that are set after &LOGREAD.
Specifies the type of message received after execution of the read verb. Values are:
The message is a standard text message.
The message is a delete operator message instruction.
The message is a request message that has satisfied &INTREAD TYPE=ANY or TYPE=REQ.
| Copyright © 2011 CA. All rights reserved. | Tell Technical Publications how we can improve this information |