$WTO – JES2 Write to operator

Format description – List form


>>-+--------+--$WTO--+---------------+-------------------------->
   '-symbol-'        '-length-absexp-'   

>--+--------------------+--+---------------------+-------------->
   |            .-YES-. |  |             .-YES-. |   
   '-,--JOB--=--+-NO--+-'  '-,--WAIT--=--+-NO--+-'   

>--+-----------------------+--+-------------------+------------->
   |             .-SVC35-. |  '-,--ROUTE--=--code-'   
   '-,--TYPE--=--+-SVC34-+-'                          

>--+--------------------------+--+------------------------+----->
   |              .-$NORMAL-. |  |                .-YES-. |   
   '-,--CLASS--=--+-$DOMACT-+-'  '-,--DOMTERM--=--+-NO--+-'   
                  +-$ALWAYS-+                                 
                  +-$ACTION-+                                 
                  '-$TRIVIA-'                                 

>--+--------------------+--+------------------+----------------->
   |            .-$ST-. |  '-,--MF--=--+-L--+-'   
   '-,--PRI--=--+-$HI-+-'              '-LX-'     
                '-$LO-'                           

>--+--------------------+--+--------------------+--------------><
   |            .-NO--. |  |            .-NO--. |   
   '-,--RMT--=--+-YES-+-'  '-,--UCM--=--+-YES-+-'

message

Specifies the address of a message which is to be displayed on the designated consoles or the address of a console message buffer (CMB) where the message resides if CMB=YES is specified. If register notation is used, the address must be loaded into the designated register before the execution of this macro instruction.

If you specify TYPE=SVC35, or allow TYPE= to default, the message must have the same format as a message generated by the $MSG macro.

length

Specifies the length of the above message. If register notation is used, the value must be loaded into the rightmost byte of the register (R0) before the execution of the macro instruction. The rest of the register must be 0 unless the message is being sent to a remote terminal (see RMT operand). The maximum message length is 125 bytes if JOB=NO is specified and 116 bytes if JOB=YES is specified.

Note: When using the execute and list forms of the macro instruction, the length must be specified in one of the macro instructions but not both.

CLASS=

Specifies the class of the message as one of the following:

$DOMACT: The message requires immediate action and is always written. (MCS descriptor code 2)
The $DOMACT specification is reserved for $WTOs issued to logical consoles. On return from $WTO processing, register 1 contains the address of the console message buffer (CMB) containing the message. The CMB is retained in the system until a corresponding $DOM is executed using the returned pointer.
$ALWAYS: The message is essential and is always written.
Note: Issue $DOM to empty a full console message buffer (CMB).
$ACTION: The message requires eventual operator action.
$NORMAL: The message is considered important to normal computer operations. (MCS descriptor code 4)
$TRIVIA: The message is considered unimportant to normal computer operations.

If you omit this operand, $NORMAL is assumed.

CMB=

Specifies whether the user of the $WTO macro instruction has provided a console message buffer for use by console services as follows:

NO

A console message buffer has not been provided, and the message operand refers to message text.

YES

A console message buffer has been provided, and the message operand refers to the console message buffer containing the user's message.

If this operand is omitted, CMB=NO is assumed.

Note:

If CMB=YES is specified, the message must appear in the appropriate locations within the console message buffer as follows:
JOB=YES

Message starts in CMBTEXT field

JOB=NO

Message starts in CMBJOBN field
If CMB=YES is specified, the CMB must have been obtained with the $GETCMB macro instruction.
Use the $MSG macro instruction to generate the message text or, if dynamically generated, at least the message identification section.

DOMTERM=

Enables you to specify whether an outstanding action message is to be deleted when JES2 terminates.

YES

To delete this outstanding action message when JES2 terminates, code DOMTERM=YES or omit DOMTERM=. This applies to messages issued with CLASS=$DOMACT.

When issuing a message for which DOMTERM=YES has been specified, JES2 uses descriptor code 7 in addition to currently used descriptor codes.

YES is the default.

NO

If you want this outstanding action message to still be displayed after JES2 terminates, code DOMTERM=NO.

JOB=

Specifies whether the job identification and job name from the job control table (JCT) or the job queue element (JQE) are appended to the start of the messages as follows:

YES: The job information is inserted in the message and passed to WTO.
NO: The job information is not inserted in the message.

If this operand is omitted, JOB=YES is assumed.

Note: If JOB=YES is specified, register 10 must be loaded with the address of either the job control table entry, the job queue element, or zero (0) before the execution of this macro instruction, or the job information printed is unpredictable. When R10 is zero (0), the JQE in PCEJQE will be used to obtain job information.

PRI=

Specifies the priority of the message as one of the following:

$HI: High priority
$ST: Standard priority
$LO: Low priority

If this operand is omitted, $ST priority is assumed.

RMT=

Specifies whether the display location is to be a JES2 remote work station.

NO

The destination is not a remote work station and therefore must be logical routing or UCM.

YES

The destination is a work station, and the following action is required before executing execution forms of the macro instruction:

For standard or MF=E forms, the remote number is set in register 0 (R0); bits 32-39 must be 0, the remote number must be set into bits 40-55, and the length of the message must be set into bits 56-63. You must specify R0 in the executing macro instruction's length operand.
For MF=EX form, you must place the remote number in the MF=LX halfword field corresponding to CMBRMT field of the CMB.

ROUTE=

When using standard and MF=L forms, specifies the JES2 logical routings that are converted to operating system equivalent routings as follows:

Designation: Console Specified
$LOG: Hard-copy console (MCS route code 0)
$ERR: Error consoles (MCS route code 10)
$UR: Unit-record operations area (MCS route code 7)
$TP: Teleprocessing operations area (MCS route code 8)
$TAPE: Tape operations area (MCS route codes 3,4,5 and 6)
$MAIN: Chief operator's area (MCS route codes 1 and 2)
$ALL: All of the above consoles
0: JES2 automatically determines route codes (if needed) based on the message type.

Note: You can specify multiple values, for example, ROUTE=$LOG+$UR.

When using the MF=LX format, unless UCM=YES or RMT=YES is specified, the operating system console routings must be specified directly using the X'xxxx' or B'xxxxxxxxxxxxxxxx' form.

If this operand is omitted, the $LOG console is assumed unless UCM=YES or RMT=YES is specified.

Note: The name $ALL should not be used with any ROUTE= values. It should only be specified alone; otherwise, results are unpredictable.

TYPE=

Specifies the logical meaning of the ROUTE operand as follows:

SVC35

The message is to be displayed on the dynamically designated remote work station console or the operating system consoles that have been set to receive the message category.

Note:

If this option is selected, use only one of the following specifications: ROUTE=, UCM=, or RMT=.
If you specify TYPE=SVC35, or allow TYPE= to default, the message must have the same format as a message generated by the $MSG macro.

SVC34

The message is to be given to the operating system as a command. If this option is selected, ROUTE=, UCM=, and RMT= have no meaning.

WAIT=

Specifies the action to be taken if console message buffers are not available as follows:

YES

Return is not made until a console message buffer has become available and the message has been queued.

If you code WAIT=YES or omit WAIT, exit 10, when it receives control, will be told that it can take an action that will result in a $WAIT.

NO

An immediate return is made with the condition code set as follows:

CC=0: No console message buffers are available. The message was not accepted and the macro instruction must be reissued.
CC≠0: The message was accepted.
(NO,DEMAND): Return will not be made without queueing message. The console message buffer will GETMAINed if required.

relexp

A location to which control is returned if CMB=YES is not specified and no console message buffers are available.

If this operand is omitted, WAIT=YES is assumed.

Note:

The specification of WAIT=NO has no meaning when the console message buffer is provided by the user and CMB=YES is specified.
The specification of WAIT=relexp has no meaning if MF=L or LX.

UCM=

Specifies whether the display location is to be a specific operating system console identified by a console ID.

NO: The destination is not a specific console and therefore must be logical routing or RMT.
YES: The destination is a console ID set in CMBUCMID of the CMB DSECT.
Note: You must use the MF=LX form of this macro, and you must set the 4–byte console ID in the CMBUCMID field of the macro parameter list.

Note:

MF=L specifies the list form of the $WTO macro instruction. MF=L or MF=E are forms of the $WTO macro instruction that allow the predefinition of parameter lists similar to MVS™ supervisor services macros specified with the “execute” or “list” forms.
MF=LX specifies the extended list form of the $WTO macro instruction. MF=(E,name) specifies the extended execute form of the $WTO macro instruction using a remote control program parameter list. MF=(EX,name) specifies the execute form of the $WTO macro instruction using a remote control program parameter list.
MF=LX or MF=EX are extended forms of MF=L or MF=E, respectively. You can use these extended forms to specify the $WTO macro instruction without using $GETCMB, formatting the CMB in detail, and using $WTO CMB=YES.
The CMBTO field in the CMB can be filled out to route messages to another node in the JES2 network or to another member in the multi-access spool JES2 complex. Field CMBUCMID can be set to indicate the 4–byte console id. CMBUCMA should be set to indicate the console area. MLWTOs can be used with explicit route and descriptor codes. To do this, you must format the console area with the CMB mapping and the MF=EX form of the $WTO macro instruction.
The MF=LX form of the $WTO macro instruction only allows explicit route codes through ROUTE=B'xxxxxxxxx...' or X'xxxx'. Descriptor codes cannot be specified using the MF=LX form of the $WTO macro.
The CMB mapping starts with the CMBFLAG field and not the CMB DSECT field.
ROUTE=$LOG with no other route codes instructs JES2 to route messages to hardcopy only.

Format description – Standard form

Format description – Execution form

Format description – List form

Environment