IBM Tivoli NetView for z/OS Programming: Pipes - IBM notice

PIPE HELDMSG
PIPE HELDMSG
Syntax
Synonyms
HELDMSG:
HELDMSG
Stage Name Synonym
HELDMSG HELD
Command Description
The HELDMSG stage reads a copy of the held message queue of the task running
the PIPE command into the pipeline. HELDMSG creates a snapshot of all the held
messages at the instant this stage runs. The messages remain in the held message
queue for normal NetView processing. The held messages that are read into the
pipeline are exact copies of the originals, including all time stamps and attributes.
Streams
Stream Type Number Supported
Input 0
Output 1
Termination Conditions
HELDMSG terminates when it finishes processing its output or when the output
stream disconnects.
Usage Notes
Examples
136 Programming: Pipes
v HELDMSG must be the first stage.
v When you pull messages into the pipe with HELDMSG, those messages can
potentially be logged a second time and held a second time. To redisplay
messages without logging a second time, follow the HELDMSG stage with a
CONSOLE ONLY stage.
v Held Message has a slightly different meaning at an autotask from that familiar
for an attended operator. The purpose of holding a message at an autotask is to
ensure proper routing of matching DOMs when they appear. Therefore a
message is held at an autotask if and only if a DOM is expected for it. The
message automation action HOLD(Y) is not meaningful at an autotask.
Example: Deleting Held Messages
To delete all the IEE123 messages on an operator's screen, enter:
PIPE HELDMSG
| LOCATE 1.6 /IEE123/
| CONSOLE DELETE