WTOR
This command sends a message to one or more system consoles and returns an operator reply.
Command | Parameters |
|---|---|
WTOR | 'Msgtext' [JOBID(n)] [ROUTCDE(n1 ... nn)] [DESC(n1 ... nn)] [CONSOLE|CN(n)] [NAME(x) REPLY(Variable name) [WAIT(n)] [SSID( YES|NO)] |
The following table describes the parameters:
Parameter | Function | Notes |
|---|---|---|
Msgtext | Text of the message to send | The maximum length of the text depends on whether you specify SSID(NO) or SSID(YES). SSID(YES) is the default. Maximum length is 116 characters with SSID(YES). Maximum length is 122 characters with SSID(NO). |
JOBID | Job identifier to place in SYSLOG as message issuer If the JOBID parameter is not specified, the IMFEXEC WTOR command defaults to the JES job identifier for the BMC AMI Ops Automation subsystem. | Range is 1-8 characters alphanumeric, 1st character alpha. |
ROUTCDE | Routing codes to associate with the message Refer to the IBM documentation, Routing and Descriptor Codes, for more information. | See IBM documentation MVS Initialization and Tuning Reference for information about CONSOL xx. |
DESC | Descriptor codes to associate with the message | See IBM documentation, Routing and Descriptor Codes, for more information. However, only the descriptor codes of 7 and 13 or both may be specified for a WTOR. |
CONSOLE CN | Specific Console ID of console to receive the message | This parameter is a numeric identifier. You can specify NAME() or CONSOLE(), but you can not specify both. If you omit the CONSOLE|CN and NAME keywords, the system uses the routing code specified on the ROUTCODE keyword on the DEFAULT statement in the CONSOLxx member of SYS1.PARMLIB. See IBM documentation MVS Initialization and Tuning Reference for information about CONSOLxx. |
NAME | Specific name of console to receive the message | This parameter is optional. You can specify NAME() or CONSOLE(), but you cannot specify both. If you omit the CONSOLE|CN and NAME keywords, the system uses the routing code specified on the ROUTCODE keyword on the DEFAULT statement in the CONSOLxx member of SYS1.PARMLIB. |
REPLY | Variable name that receives the operators’ reply | Range is 1-32 alphanumeric characters. |
WAIT | Number of seconds to wait for the operators’ reply | If not specified, the EXEC will wait indefinitely. |
SSID | Appends subsystem identifier to the end of the message | This parameter is either YES or NO; the default is YES. |
Routing codes and descriptor codes are documented in the IBM publication, Routing and Descriptor Codes. However, only the descriptor codes of 7 and 13 or both may be specified for a WTOR.
Condition codes are listed in the following table:
Value | Description |
|---|---|
0 | Command was executed successfully. |
4 | This value is set when the WTOR is issued with Msgtext truncated because it exceeded the maximum length. |
6 | One or more descriptor codes specified for the message were invalid. The invalid descriptor codes have been ignored. |
8 | Invalid syntax is detected in the command. These errors are flagged by TSO/E messages IKJxxxxx or by BMC AMI Ops Automation short error messages or both. |
12 | A timeout failure has occurred while waiting for an operator response |
Example
The below example issues a WTOR. If the operator does not respond within 60 seconds or responds with an S, the CLIST branches to label STARTNET. Otherwise, execution continues sequentially.
Some common options are dependent.
'IMFEXEC WTOR 'NETWORK COMING UP IN 1 MINUTE, REPLY ''S'' TO STOP'',
'WAIT(60),REPLY(REP)'
IF IMFCC = 12 THEN SIGNAL STARTNET
IF REP ^= 'S' THEN SIGNAL STARTNET
CLIST example:
WAIT(60),REPLY(REP)
IF &IMFCC = 12 THEN GOTO STARTNET
IF &REP NE S THEN GOTO STARTNET
Related topic