Request information on unanswered messages
Component: | BS2000 |
Functional area: | Operator terminal control |
Domain: | CONSOLE-MANAGEMENT |
Privileges: | OPERATING |
Routing code: | @ |
Function
The SHOW-PENDING-MSG command allows operators to list unanswered console messages (response messages). The command can be issued both at consoles and at terminals on which a user task with the OPERATING privilege is active.
The command lets messages be selected on the basis of the following criteria:
Criterion | Meaning |
|---|---|
Destination | Only display messages addressed to specific consoles or applications or with a specific routing code |
Sender | Only display messages sent for specific consoles, applications or tasks |
Message reference name | Only display messages assigned a specific message reference name by the sender |
Message type | Only display messages of a specific type (ordinary question, command-related questions, etc.) |
Message identifier | Only display messages containing a specific 7-character message ID; only applies to messages created with the MSG7 / MSG7X macro |
Time | Only display messages created within a specific period |
Emergency response messages are always displayed, regardless of the message selection operand used.
The command supports structured output in S variables (see "Output in S variables").
Format
SHOW-PENDING-MSG | Alias: SHMSG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
DESTINATION = *STD / *OWN / *ANY / *ROUTING-CODE(...) / *CONSOLE(...) / *TSN(...)
Selects unanswered response messages by destination.
DESTINATION = *STD
If the command is entered at a physical or logical operator console, *STD has the same effect as DESTINATION=*OWN.
If it is entered at a data display terminal, *STD has the same effect as DESTINATION=*ANY (*OWN would display an empty set; see "Notes").
DESTINATION = *OWN
Displays unanswered messages directly addressed to the command caller or directed to the command caller by means of a routing code or the standby console mechanism (i.e., questions that the command caller is authorized to answer).
If this operand is used when the command is entered at an ordinary terminal, open response messages are not displayed (see Notes).
DESTINATION = *ANY
Displays all unanswered response messages; the message destination is irrelevant.
DESTINATION = *ROUTING-CODE(...)
Displays all unanswered response messages which are allocated to a specific routing code.
ROUTING-CODE = list-poss(40): <alphanum-name 1..1> / *
Up to 40 routing codes can be specified.
Operand values: *, A..Z, 0..9, $, #, @
The functions of the various routing codes are described in the “Introduction to System Administration” [14].
DESTINATION = *CONSOLE(...)
Displays all response messages sent to a specific console (physical or logical).
CONSOLE = list-poss(10): <alphanum-name 2..2> / <name 4..4>
Up to 10 console mnemonics (2-character) or names of authorized applications (4-character) can be specified.
DESTINATION = *TSN
Displays all response messages sent to a user task. The user task is identified by its TSN (task sequence number).
TSN = list-poss(10): <alphanum-name 1..4>
Up to 10 user tasks can be identified by their TSNs.
TSN can be between 1 and 4 characters long (leading zeros can be omitted).
SENDER = *ANY / *CONSOLE(...) / *TSN(...)
Selects unanswered response messages by sender.
SENDER = *ANY
Displays all unanswered response messages; the identity of the message sender is irrelevant.
SENDER = *CONSOLE(...)
Displays all response messages sent from a specific console (physical or logical).
CONSOLE = list-poss(10): <alphanum-name 2..2> / <name 4..4>
Up to 10 console mnemonics (2-character) or names of authorized applications (4-character) can be specified.
SENDER = *TSN(...)
Displays all response messages sent by a specific user or system task. The task is identified by its TSN (task sequence number).
TSN = list-poss(10): <alphanum-name 1..4>
Up to 10 user tasks can be identified by their TSNs.
TSN can be between 1 and 4 characters long (leading zeros can be omitted).
MSG-REFERENCE-NAME = *ANY / list-poss(10): <alphanum-name 3..3>
Selects unanswered response messages by message reference name.
MSG-REFERENCE-NAME = *ANY
Displays all unanswered response messages; the message reference name assigned by the sender is irrelevant.
MSG-REFERENCE-NAME = list-poss(10): <alphanum-name 3..3>
Displays all unanswered response messages to which the sender has assigned one of the specified message reference names.
Up to 10 names can be specified.
Note
The message reference name uniquely identifies messages with the same sender or recipient. In the case of command-related messages, it is formed from the job name prefixed to the command (default: '000').
MSG-TYPE = *ANY / *QUESTION / *ADDITIONAL-INFORMATION-REQUEST / *ACTION-MSG
Selects unanswered response messages by message type.
MSG-TYPE = *ANY
Displays all unanswered response messages; the message type is irrelevant.
MSG-TYPE = *QUESTION
Displays all unanswered response messages which are assigned a message type of 'Question'. Messages of this type have '?' as their message flag.
MSG-TYPE = *ADDITIONAL-INFORMATION-REQUEST
Displays all unanswered response messages which are assigned a message type of 'Additional information request'. Messages of this type have '&' as their message flag.
MSG-TYPE = *ACTION-MSG
Displays all unanswered response messages which can only be answered by a task, not by an operator. However, the response is usually initiated indirectly by an operator action. Messages of this type have ';' as their message flag.
MSG-IDENTIFICATION = *ANY / list-poss(10): <name 7..7>
Selects unanswered response messages by message identifier.
MSG-IDENTIFICATION = *ANY
Displays all unanswered response messages, regardless of message type or of whether or not they were created with an MSG7/MSG7X macro.
MSG-IDENTIFICATION = list-poss(10): <name 7..7>
Displays all unanswered response messages which are assigned one of the specified message identifiers and were created with an MSG7 / MSG7X macro.
Up to 10 message identifiers can be specified.
Note
Messages created using TYPIO / $TYPIO are disregarded, even if their output format matches that of the MSG7 / $MSG7X macro.
TIME = *ANY / *INTERVAL(...)
Selects unanswered response messages by time of creation.
TIME = *ANY
Displays all unanswered response messages; the time when they were created is irrelevant.
TIME = *INTERVAL(...)
Displays all unanswered response messages created within the specified period.
Note
A period specification only makes sense if the FROM value is earlier than the TO value. If the system session extends over a number of days, a period specification may result in messages being displayed which were created within the specified period but on different days. The messages contain no information as to the date when they were created.
Messages are displayed in reverse order of creation (most recent message first).
FROM = *EARLIEST / <time>
Time of creation of the earliest response messages to display.
FROM = *EARLIEST
Earliest specifiable time (00:00:00).
FROM = <time>
The creation time of the earliest unanswered response messages to display must be specified in hh:mm:ss form (hour:minute:second).
TO = *LATEST / <time>
Time of creation of the most recent response messages to display.
TO = *LATEST
Latest specifiable time (23:59:59).
TO = <time>
The creation time of the most recent unanswered response messages to display must be specified in hh:mm:ss form (hour:minute:second).
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command successfully executed | |
1 | 0 | CMD0001 | There were no unanswered response messages to display |
1 | CMD0202 | Syntax error in command | |
32 | NBR0034 | Error executing command (&00); | |
32 | CMD2009 | Error during generation of presentation variables | |
64 | CMD0216 | User does not have required privilege |
The “internal error” return code NBR0034 is supplied in the event of bourse, DMS, memory or other system problems.
Notes
Messages are displayed in reverse order of appearance (most recent message first).
If the command is issued at a console before SYSTEM READY or during SHUTDOWN processing, unanswered messages for all consoles are listed.
If the operand DESTINATION=*OWN is used when the command is issued from an ordinary terminal, open response messages cannot be displayed. The reason for this is that terminals will not accept command input while there are response messages outstanding.
The main console is authorized to answer all response messages.
The SHOW-PENDING-MSG is one of the INSTANT commands and as such cannot be used in RUN files, or can only be used subject to certain restrictions, because it may be processed ahead of other commands which precede it in the file.
Results
A vertical bar separates the message header from the message text proper. The bar is followed by the message destination (4 characters, see the DESTINATION operand) and then the original response message.
The command is issued at a terminal. Result:
% |(K3) &XAAA-000.130820 % EXC0432 PROCESSING...
The command is issued at a console. Result:
+XAAB |(K3) &XAAA-000.130820 % EXC0432 PROCESSING...
The command is issued by an authorized application. Result:
+XAAB-000.131350 |(K3) &XAAA-000.130820 % EXC0432 PROCESSING...
Output in S variables
Output information | Name of the S variable | T | Contents | Condition |
|---|---|---|---|---|
Response message destination; <destination> always consists of 4 characters and may take the following forms: | var(*LIST).DEST | S | <destination> | |
Destination type | var(*LIST).DEST-TYPE | S | *APP | |
Number of inserts | var(*LIST).HIGH-INS-NUM | I | <integer 0..15> | |
Insert | var(*LIST).INS(*LIST) | S | <insert-name> | HIGH-INS-NUM > 0 |
Message identifier | var(*LIST).MSG-ID | S | '' | |
Message reference name | var(*LIST).MSG-REF-NAME | S | <alphan.-name 3..3> | |
Text of the response message | var(*LIST).MSG-TEXT | S | <c-string 1..255> | |
Message type | var(*LIST).MSG-TYPE | S | *ACTION-MSG | |
Sender of the response message; <sender-name> always consists of 4 characters and may take the following forms: | var(*LIST).SENDER | S | <sender-name> | |
Type of sender | var(*LIST).SENDER-TYPE | S | *APPL | |
Time of message generation | var(*LIST).TIME | S | <hh:mm:ss> |