Broadcast Services Interface › $BSCALL OPT=SEND

$BSCALL OPT=SEND

Sends a broadcast.

&CONTROL NOSHRVARS NOVARSEG
-EXEC $BSCALL     OPT=SEND
                  TYPE={ALL | APPL | EASINET | TERMINAL |
                          MAIAPPL | NCLAPPL | USERID | NOTIFY }
                [ B1=textline1 ]
                [ B2=textline2 ]
                [ B3=textline3 ]
                [ B4=textline4 ]
                [ IMM={ YES | NO } ]
                [ MASK=usermask ]
                [ RETAIN={ PERM | VIEWED | NO } ]
                [ APPLPROC=procname ]

Operands:

OPT=SEND

Specifies a broadcast that is to be sent and which users are to receive it.

TYPE={ALL | APPL | EASINET | TERMINAL |MAIAPPL | NCLAPPL | USERID | NOTIFY }

Specifies the type of broadcast to send.

ALL

Broadcasts to all users. This includes EASINET users (where the &BROLINE1 to 4 variables will be updated) and all product region users who are currently logged on (executes the $NMBRO notification procedure).

APPL

Specifies that an NCL application wishes to broadcast a message to specific users. The broadcast will be actioned for signed on users whose user ID matches the string specified on the MASK operand. The APPLPROC operand is specified with this operand for a customized notification procedure.

Note: The RETAIN=PERM operand cannot be specified with TYPE=APPL.

EASINET

Broadcasts to specific EASINET terminals. This only updates the &BROLINE1 to 4 variables. The MASK operand must specify an LU name.

TERMINAL

Broadcasts to specific terminals, both EASINET and product region. This includes EASINET users (where the &BROLINE1-4 variables will be updated) and all product region users who are currently logged on (executes the $NMBRO notification procedure). The MASK operand must specify an LU name.

MAIAPPL

Broadcasts to MAI users of an application. The broadcast is sent based on the results of a SHOW MAI=ALL command. The MASK operand must specify a string that matches an MAI application name.

NCLAPPL

Broadcasts to users of NCL applications. This is based on the results of a SHOW NCL=ALL command. The MASK operand must specify a string that matches either the base or current procedure.

USERID

Broadcasts to specific users. The broadcast will be actioned for signed-on users whose user ID matches the string specified on the MASK operand.

If the mask contains a user ID which does not contain any wildcard characters, and RETAIN=PERM is specified, and the user ID is not currently logged on to a region, the broadcast will be retained until the broadcast is reviewed when the user logs on.

NOTIFY

Broadcasts to the user specified using the MASK operand, using their preferred method of notification. The method of notification is defined in the user's UAMS profile. (See the chapter “Working with UAMS” in the Security Guide.)

The default method is a standard broadcast (option U) with RETAIN=NO.

B1=textline1

Specifies the text for broadcast line 1.

B2=textline2

Specifies the text for broadcast line 2.

B3=textline3

Specifies the text for broadcast line 3.

B4=textline4

Specifies the text for broadcast line 4.

IMM={ YES | NO }

This operand is only used for broadcasts to product region users (that is, TYPE=ALL, ALLMASK, APPL, USERID, MAIAPPL and NCLAPPL). IMM=YES causes the $NMBRO notification procedure to be executed immediately, and the broadcast will interrupt the user's current work. This option is not recommended as data is lost if the user is currently typing.

IMM=NO means that the broadcast will not be actioned until the next user input, such as pressing Enter.

MASK= usermask

This operand is mandatory for the following types: NCLAPPL, MAIAPPL, APPL, USERID, ALLMASK, EASINET, and NOTIFY.

An asterisk is used as a wildcard character anywhere within the mask string for any type of broadcast except NOTIFY, which requires an exact user ID.

RETAIN={ PERM | VIEWED | NO }

Specifies the required retention of the broadcast.

PERM means that the broadcast that is sent shall be permanently retained, but not across region restarts.

VIEWED causes the broadcast to be retained until it has been viewed by all receivers. This is the default.

NO means that the broadcast will not be retained. That is, it will only be available to users who are currently logged on.

APPLPROC=procname

Specifies the name of the procedure that the $NMBRO notification procedure is to execute. The broadcast text is shared with the procedure in the variables &$BSB1-4. This is valid only with OPT=APPL.

Return Codes:

&RETCODE = 0

$BSCALL completed successfully.

&RETCODE = 8

An error occurred. &SYSMSG is set with an error message.

Example: OPT=SEND

&CONTROL NOSHRVARS NOVARSEG 
&TEXT = &STR PRODUCTION SYSTEM IS NOW AVAILABLE 
-EXEC $BSCALL OPT=SEND TYPE=ALL B1=&TEXT RETAIN=NO

Note: If the text entered in the B1-4 fields contains imbedded blanks, $BSCALL must be invoked with &CONTROL NOVARSEG in effect.