/BROADCAST command
The /BROADCAST command is a multisegment command used to send a message to terminals in one or more IMS systems.
Subsections:
Environment
The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords.
Command / Keywords | DB/DC | DBCTL | DCCTL |
---|---|---|---|
/BROADCAST | X | X | |
ACT | X | X | |
LINE | X | X | |
LTERM | X | X | |
MASTER | X | X | |
MSNAME | X | X | |
NODE | X | X | |
PTERM | X | X | |
SYSID | X | X | |
USER | X | X |
Syntax
Keywords
The following keywords can be specified for the /BROADCAST command:
- ACT
- Specifies
that the supplied message is queued to the first LTERM allocated to
each active node.
When operating on a dynamic terminal, the /BROADCAST ACT command only succeeds if a signed on user exists. A signed on user must exist, otherwise there is no destination to which to send the message.
- LINE
- Specifies that a message is to be sent to all terminals associated with the specified line. PTERM specifies that the message is to be sent to specific terminals on the associated line.
- LTERM
- Specifies
that a message is queued to each named LTERM in the local system or
any remote system. The remote logical terminal must be defined in
the input system.
Where a LTERM does not exist, IMS attempts to create the LTERM and associated user structure if ETO is active. LTERM parameters can be generic, where the generic parameter specifies logical terminals that already exist.
When /BROADCAST LTERM ALL is specified, one copy of the message is queued for each logical terminal in the local system. In a multiple systems configuration, the message is not sent to remote systems when the ALL parameter is used. When more than one logical terminal is assigned to a physical terminal for output purposes, multiple copies of the message will result.
When the LTERM keyword specifies a logical terminal assigned to the VTAM® pool, broadcast messages are queued for the first logical terminal in a subpool.
- MASTER
- Specifies that a message is to be sent to the IMS master terminal and to any specified secondary master terminal. Keywords SYSID and MSNAME can be used to further qualify the reserved parameter MASTER.
- MSNAME
- Specifies the logical link path in a multiple systems configuration.
- NODE
- Specifies that
the supplied message is queued to the first output LTERM allocated
to a terminal. If a terminal has no signed on user, no message can
be queued. NODE parameters can be generic, where the generic parameter
specifies nodes that already exist.
When operating on a dynamic terminal, the /BROADCAST NODE command only succeeds if a signed on user exists. A signed on user must exist, otherwise there is no destination to which to send the message.
- PTERM
- Specifies the physical terminal to which a message is to be sent.
- SYSID
- Specifies the system identification of a system in a multiple system configuration.
- USER
- Specifies that
the supplied message is queued to the first LTERM associated with
the dynamic user. The USER parameter can be generic. The /BROADCAST
USER command applies only to existing dynamic users.
In an IMSplex, /BROADCAST USER queues the supplied message to the first LTERM associated with a dynamic user, if the user is signed on locally. /BROADCAST USER cannot be used to queue a message to an LTERM associated with a user signed on to another IMS in the IMSplex, or not signed on at all.
Usage notes
For /BROADCAST commands entered by the master terminal operator, the multisegment input from this command is combined into 79-character segments for output transmission. The first input segment contains only the broadcast destination. The second and subsequent input segments must contain the data to be broadcast. Messages that are broadcast are sent even if the line, terminal, or both, are stopped at the time the broadcast is issued.
This command can be issued to an IMSplex using the Batch SPOC utility.
All /BROADCAST formats require an EOM indication to denote end-of-message; an EOS indication must be included for all segments that precede the last segment.
Requirement: When the /BROADCAST command is issued from an MCS/E-MCS console, OM API, or an AOI application, a period must appear as a delimiter between the command and the message text.
Unlike message switches, broadcast messages are sent to a terminal even when the terminal, associated line, or both, are not available (stopped, process stopped, or locked). However, broadcast messages are never sent to terminals if the MSGDEL parameter of the TERMINAL macro is specified MSGDEL=NONIOPCB.
Broadcast messages are always queued for logical terminals. When the ACTIVE, LINE, NODE, PTERM, or USER keywords are used, IMS queues the message for the first logical terminal found that is associated for output purposes with the specified line or physical terminal.
Examples
The following are examples of the /BROADCAST command:
Example 1 for /BROADCAST command
/BROADCAST ACTIVE (EOS)
SYSTEM WILL BE SHUTDOWN FOR PM (EOS)
IN 5 MINUTES (EOM)
DFS058I BROADCAST COMMAND COMPLETED
SYSTEM WILL BE SHUTDOWN FOR PM IN 5 MINUTES
Explanation: The entered message is transmitted to all active terminals.
Example 2 for /BROADCAST command
/BROADCAST TO LTERM APPLE, TREE (EOS)
DON'T USE TRANSACTION GREENTRE UNTIL FURTHER (EOS)
NOTICE. (EOM)
DFS058I BROADCAST COMMAND COMPLETED
DON'T USE TRANSACTION GREENTRE UNTIL FURTHER
NOTICE.
Explanation: The entered message is transmitted to the logical terminals named APPLE and TREE.
Example 3 for /BROADCAST command
/BROADCAST TO LINE ALL (EOS)
SYSTEM WILL SHUTDOWN AT 5PM (EOM)
DFS058I BROADCAST COMMAND COMPLETED
SYSTEM WILL SHUTDOWN AT 5PM
Explanation: The entered message is transmitted to all physical terminals.
Example 4 for /BROADCAST command
/BROADCAST TO LINE 13 PTERM ALL (EOS)
EXPECT DEMO YOUR LINE AT 9PM (EOM)
DFS058I BROADCAST COMMAND COMPLETED
EXPECT DEMO YOUR LINE AT 9PM
Explanation: The entered message is transmitted to all physical terminals on line 13.
Example 5 for /BROADCAST command
/BROADCAST MASTER SYSID 2 (EOS)
SYSTEM WILL SHUTDOWN AT 5:00 PM (EOM)
DFS058I BROADCAST COMMAND COMPLETED
SYSTEM WILL SHUTDOWN AT 5:00 PM
Explanation: The message is transmitted to the master terminal of the system specified by the SYSID 2.
Example 6 for /BROADCAST command
/BROADCAST MASTER MSNAME BOSTON, CHICAGO (EOS)
SYSTEM WILL SHUTDOWN AT 5:00 PM (EOM)
DFS058I BROADCAST COMMAND COMPLETED
SYSTEM WILL SHUTDOWN AT 5:00 PM
Explanation: The message is transmitted to the master terminals. of the remote systems specified by the MSNAMEs BOSTON and CHICAGO.
Example 7 for /BROADCAST command
/FORMAT DFSMO4
/BRO LTERM WTOR (eos)
this is segment 1 (eos)
this is segment 2 (eos)
this is segment 3 (eom)
DFS058I BROADCAST COMMAND COMPLETED
THIS IS SEGMENT 1
THIS IS SEGMENT 2
THIS IS SEGMENT 3
Explanation: The remote terminal is first formatted by the /FORMAT command, where default format DFSMO4 supports the input of four segments. This is followed by /BROADCAST with four segments.