SNDBRKMSG (Send Break Message)

SNDBRKMSG Command syntax diagram

 

Purpose

The Send Break Message (SNDBRKMSG) command is used by the system operator to send an immediate message to one or more work station message queues. An immediate message is a message that is not predefined and is not stored in a message file. The command causes the message to be delivered always in break mode. The DSPMSG display is shown for the message when it is received, regardless of the setting of the message queue's delivery mode, severity, and break handling program. However, the message may not be displayed in some cases, depending on the BRKMSG job attribute. This command is primarily intended for the system operator's use.

 

Restrictions

1. This command can be used to send break messages to work station message queues only.
2. This command cannot send inquiry messages (specified by MSGTYPE(INQ)) to multiple work stations.

 

Required Parameters

MSG

Specifies the message text that is sent. A maximum of 512 characters can be specified. The message must be enclosed in apostrophes if it contains blanks or other special characters.

Coded Character Set Identifier (CCSID) Considerations

The text supplied on the MSG parameter is assumed to be in the CCSID of the job running this command unless a coded character set identifier is supplied on the CCSID parameter. For more information about the message handler and its use of CCSIDs, see the Globalization topic in the Information Center.

TOMSGQ

Specifies the qualified names of one or more work station message queues to which the break message is sent. Only the names of work station message queues can be specified.

*ALLWS: The break message is sent to all work stations and Personal Computer message queues. This value cannot be specified if *INQ is specified on the MSGTYPE parameter.

The name of the message queue can be qualified by one of the following library values:

*LIBL: All libraries in the job's library list are searched until the first match is found.

*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

message-queue-name: Specify the name of the message queue to which the break message is being sent.

 

Optional Parameters

MSGTYPE

Specifies the type of message that is sent in break mode. Only informational or inquiry message types can be specified.

*INFO: An information-only message is sent in break mode.

*INQ: An inquiry message is sent in break mode; the work station receiving the message is expected to reply to it. Inquiry messages can be sent to only one work station at a time.

RPYMSGQ

Specifies, only if an inquiry message is sent, the name of the message queue to which the work station user's reply is sent.

The name of the message queue can be qualified by one of the following library values:

*LIBL: All libraries in the job's library list are searched until the first match is found.

*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

QSYSOPR: The replies to the break message are sent to the system operator's message queue, QSYSOPR.

message-queue-name: Specify the name of the message queue to which a reply to the break message is sent. Only a user or work station message queue can be specified.

CCSID

Specifies the coded character set identifier (CCSID) that the supplied message text is in. The text specified by the MSG parameter is assumed to be in the CCSID supplied by this parameter. For more information about the message handler and its use of CCSIDs, see the Globalization topic in the Information Center.

*JOB: The message text is assumed to be in the CCSID of the job running this command.

*HEX: The message text is not converted. CCSID 65535 is used.

coded-character-set-identifier: Specify a valid CCSID in which you want your message text to be considered in. Valid values range from 1 through 65535. See the Globalization topic in the Information Center for a list of valid CCSID values. This command will validate the CCSID.

Examples for SNDBRKMSG

Example 1: Sending a Message

SNDBRKMSG   MSG('The inventory application
  shuts down at 4:00 pm today.')

This command sends the message 'The inventory application shuts down at 4:00 pm today.' to all work station message queues. If the work station is signed on, the message will be delivered in break mode regardless of the delivery attribute setting of those message queues. The message is also added to the work station message queues of those work stations that are not signed on.

Example 2: Sending an Immediate Message

SNDBRKMSG   MSG('Your printed output is ready.')
  TOMSGQ(GEORGEMSGQ)

This example shows a typical use of the SNDBRKMSG command by the system operator to send an immediate message to a work station user.

Error messages for SNDBRKMSG

*ESCAPE Messages

CPF2428

Message queue parameter is not valid.

CPF2469

Error occurred when sending message &1.

CPF247E

CCSID &1 is not valid.

CPF9838

User profile storage limit exceeded.