Document revision date: 30 March 2001

%OPCOM, 24-DEC-2001 10:22:19.75, operator status for operator OPA0 CENTRAL, PRINTER, TAPES, DISKS, DEVICES, CARDS, NETWORK, CLUSTER, LICENSE, OPER1, OPER2, OPER3, OPER4, OPER5, OPER6, OPER7, OPER8, OPER9, OPER10, OPER11, OPER12

When the operator enters the REPLY/DISABLE command, OPCOM uses the following message to confirm that the terminal is no longer an operator terminal:

%OPCOM, 24-DEC-2001 10:03:23.48, operator disabled, operator OPA0

To grant specific operator status on a particular terminal, the operator includes one or more keywords after the /ENABLE qualifier. For example, to establish a terminal as an operator terminal that can receive messages pertaining to mounting and dismounting tapes and disks, the operator enters the following:

$ REPLY/ENABLE=(DISKS,TAPES)

%OPCOM, 24-DEC-2001 10:04:00.18, operator enabled, operator OPA0 $ %OPCOM, 24-DEC-2001 10:04:00.47, operator status for operator OPA0 TAPES, DISKS

OPCOM confirms that the terminal has operator status for tape and disk messages.

To discontinue specific operator status, the operator includes one or more keywords after the /DISABLE qualifier. For example, to inhibit an operator terminal from receiving messages pertaining to mounting and dismounting disks, the operator enters the following command:

$ REPLY/DISABLE=DISKS

%OPCOM, 24-DEC-2001 10:04:30.83, operator status for operator OPA0 TAPES

Note that OPCOM lists the specific operator status still assigned to the terminal.

When an operator disables operator status on all terminals, including the system console terminal, OPCOM records all subsequent messages in the operator log file, except user requests and messages requiring an operator reply.

%OPCOM-S-OPRNOTIF, operator notified, waiting. 10:06:03.25 %OPCOM-S-OPREPLY, %OPCOM 24-DEC-2001 10:06:03:25, no operator coverage

To determine the operator status and to obtain a list of pending requests for a particular terminal, the operator enters the following command:

$ REPLY/STATUS

This command also shows all outstanding requests for this operator.

Closing the Operator's Log File and Opening a New One

To close the current operator's log file and open a new one, the operator enters the REPLY/LOG command. If OPCOM is running, all subsequent messages are recorded in the new log file. To close the current log file without opening a new one, the operator enters the REPLY/NOLOG command. All subsequent messages are not recorded until the operator enters the REPLY/LOG command.

Qualifiers

/ABORT=identification-number

Sends a message to the user or magnetic tape file system corresponding to the unique identification number and cancels the request.

/ALL

Requires OPER (operator) privilege.

Broadcasts a message to all terminals that are attached to the system or cluster. These terminals must be turned on and have broadcast-message reception enabled. The /ALL qualifier is incompatible with the /USERNAME and /TERMINAL qualifiers.

/BELL

Rings a bell at the terminal receiving a message when entered with the /ALL, the /TERMINAL, or the /USERNAME qualifier; two bells when entered with the /URGENT qualifier; and three bells when entered with the /SHUTDOWN qualifier.

/BLANK_TAPE=identification-number

Requires VOLPRO (volume protection) privilege.

Sends a message to the magnetic tape file system indicated by the identification number to override the checking of volume label information. The volume label must be specified in the message-text parameter. The current terminal must be enabled as an operator terminal for TAPES.

/DISABLE[=(keyword[,...])]

Requires OPER (operator) privilege. Requires OPER and SECURITY privileges for security messages.

If the operator communication manager (OPCOM) is running, restores to normal (that is, nonoperator) status the terminal at which the command is entered. The /DISABLE qualifier cannot be entered from a batch job. To restrict the types of messages displayed on an operator's terminal, specify one of the following keywords:

CARDS	Inhibits messages sent to the card readers.
CENTRAL	Inhibits messages sent to the central system operator.
CLUSTER	Inhibits messages from the connection manager pertaining to cluster state changes.
DEVICES	Inhibits messages pertaining to mounting disks.
DISKS	Inhibits messages pertaining to mounting and dismounting disk volumes.
LICENSE	Inhibits messages pertaining to software licenses.
NETWORK	Inhibits messages pertaining to networks; the keyword CENTRAL must also be specified to inhibit network messages.
OPER1 to OPER12	Inhibits messages sent to operators identified as OPER1 to OPER12.
PRINTER	Inhibits messages pertaining to print requests.
SECURITY	Inhibits messages pertaining to security events; requires SECURITY privilege.
TAPES	Inhibits messages pertaining to mounting and dismounting tape volumes.

When an operator logs out from a remote or a dial-in terminal, the operator terminal is automatically disabled.

/ENABLE[=(keyword[,...])]

Requires OPER (operator) privilege. Requires OPER and SECURITY privileges for security messages.

Designates as an operator's terminal the terminal at which the REPLY command is entered, if OPCOM is running. The /ENABLE qualifier cannot be entered from a batch job. To enable the following types of messages displayed on an operator's terminal, specify one of the following keywords:

CARDS	Displays messages sent to the card readers.
CENTRAL	Displays messages sent to the central system operator.
CLUSTER	Displays messages from the connection manager pertaining to cluster state changes.
DEVICES	Displays messages pertaining to mounting disks.
DISKS	Displays messages pertaining to mounting and dismounting disk volumes.
LICENSE	Diplays messages pertaining to software licenses.
NETWORK	Displays messages pertaining to networks; the keyword CENTRAL must also be specified to inhibit network messages.
OPER1 to OPER12	Displays messages sent to operators identified as OPER1 to OPER12.
PRINTER	Displays messages pertaining to print requests.
SECURITY	Allows messages pertaining to security events; requires SECURITY privilege.
TAPES	Allows messages pertaining to mounting and dismounting tape volumes.

/INITIALIZE_TAPE=identification-number

Sends a message to the magnetic tape file system indicated by the identification number to initialize a magnetic tape volume. This qualifier can be used whenever the file system requests the mounting of a new volume. The system performs normal protection and expiration checks before initializing the volume. The current terminal must be enabled as an operator terminal for TAPES.

If the tape drive cannot read the volume, the mount fails and an error message is returned. Use the /BLANK_TAPE qualifier to override the checking of information on a volume label.

/LOG

/NOLOG

Requires OPER (operator) privilege.

Closes the current operator's log file and opens a new one if OPCOM is running. The /NOLOG qualifier closes the current log file, but does not open a new log file. The current terminal must be enabled as an operator terminal. The operator can then examine the contents of the previous log file.

/NODE[=(node-name[,...])]

Sends a message to the local cluster node only. The optional parameter list allows you to specify which nodes will receive the message. Default sends messages to all cluster nodes.

/NOTIFY (default)

/NONOTIFY

Sends a message describing success back to the originating terminal.

/PENDING=identification-number

Requires OPER privilege.

Sends a message to the user specified by the identification number and prevents the user from entering other commands until the operator fulfills or aborts the request. The current terminal must be enabled as an operator terminal.

/SHUTDOWN

Sends a message beginning "SHUTDOWN..."; if used with the /BELL qualifier, rings three bells at terminals receiving the message.

/STATUS

Requires OPER (operator) privilege.

Reports the current operator status and all outstanding user requests for the terminal from which this command was entered. The current terminal must be enabled as an operator terminal.

/TEMPORARY

Designates the terminal at which the command is entered to be an operator's terminal for the current interactive session only. This qualifier is meaningful only when used with the /ENABLE qualifier.

/TERMINAL=(terminal-name[,...])

Requires OPER (operator) privilege.

Broadcasts the message to specified terminals, where the terminal-name parameter is the device name of the terminal. Incompatible with the /ALL and /USERNAME qualifiers.

/TO=identification-number

Requires OPER (operator) privilege.

Sends a message to the user or file system specified by the identification number and completes the request. The current terminal must be enabled as an operator terminal.

Note that you can also use a variation of the REPLY/TO command in response to a MOUNT/ASSIST command where you redirect the mount operation to another device. Whenever you must substitute a device, load the user's volume on the alternate device and prepare the device for connection before entering the REPLY command. Use the following syntax:

REPLY/TO=identification-number "SUBSTITUTE device-name"

You can abbreviate the word SUBSTITUTE to S and can use uppercase or lowercase characters. After a space, use the remainder of the message-text space to name the substituted device.

/URGENT

Sends a message beginning "URGENT..."; if used with the /BELL qualifier, rings two bells at terminals receiving the message.

/USERNAME[=(username[,...])]

Requires OPER (operator) privilege.

Broadcasts a message to all terminals at which users are logged in to the system (or OpenVMS Cluster), or only to the terminals of the specified users. Incompatible with the /ALL and /TERMINAL qualifiers.

/WAIT

Sends a message synchronously and then waits. The default is to send a message to OPCOM, which does the actual I/O. On a cluster, the message is sent to the local node.

Examples

$ REPLY/ALL/BELL "SYSTEM GOING DOWN FOR BACK-UP. PLEASE LOG OFF."
 
      

The REPLY command in this example broadcasts a message to all terminals on the system. When the message appears at the user's terminal, it is prefixed with the terminal name, the user name of the sender, and (when DECnet for OpenVMS is installed) the node name. The bell sounds at the terminal as the message is displayed.

$ REPLY/ENABLE=DISKS
%OPCOM, 24-DEC-2001, 10:17:09.02, operator enabled, operator OPA0
$
%OPCOM, 24-DEC-2001 10:17:10.30, operator status for operator OPA0
DISKS
 
      

The REPLY/ENABLE command in this example designates the terminal OPA0 as an operator terminal that can receive messages pertaining to mounting and dismounting disks. The OPCOM message confirms that terminal OPA0 is established as an operator's terminal.

%OPCOM, 24-DEC-2001 10:19:33.21, request 5, from user SYSTEM
OPA0, Please mount OPGUIDE on DKA3:
$ REPLY/PENDING=5 "YOU'LL HAVE TO WAIT... -
_$ THERE ARE SEVERAL REQUESTS BEFORE YOURS"
   .
   .
   .
$ REPLY/TO=5
24-DEC-2001 10:20:25.50, request 5 completed by operator OPA0
 
      

In this example the OPCOM message indicates that a user wants the operator to place the disk volume labeled OPGUIDE on the disk drive DKA3 and prepare the device for connection. The REPLY/PENDING command indicates that the operator can perform the task but not immediately; the /PENDING qualifier prevents the user from entering other commands until the operator fulfills or aborts the request. After mounting the disk on the drive the operator sends a message indicating that the request has been fulfilled. When no message is specified, OPCOM sends a standard message indicating that the task has been performed.

%%%%%%%%%%  OPCOM, 24-DEC-2001 10:20:50.39  %%%%%%%%%%%
request 5 from user ROBINSON
Please mount volume GRAPHIC_FILES in device _DUA11:
Shelf 4 - slot B
$ REPLY/TO=5 "SUBSTITUTE  DUA4"
 
      

The REPLY/TO command with the SUBSTITUTE syntax in this example is used in response to a MOUNT/ASSIST command entered by user ROBINSON. The MOUNT device is switched to DUA4, and the logical name specified by the user in the MOUNT command is defined with an equivalence name of DUA4 rather than the drive originally specified.

$ REPLY/STATUS
%OPCOM, 24-DEC-2001 10:20:50.39, operator status for operator OPA0
DISKS
 
      

The REPLY/STATUS command in this example requests that the operator terminal status for terminal OPA0 be displayed. The response from OPCOM indicates that terminal OPA0 is enabled to receive messages from disk devices.

$ REPLY/BELL/TERMINAL=TTC1: "YOUR FILE HAS COMPLETED PRINTING. BOB S."
 
      

The REPLY command in this example sends a message to the user logged in at terminal TTC1. When the message displays, a bell rings at that terminal.

$ REPLY/ENABLE
%OPCOM, 24-DEC-2001 10:22:19.75, operator status for operator OPA0
CENTRAL, PRINTER, TAPES, DISKS, DEVICES, CARDS, NETWORK, CLUSTER,
LICENSE, OPER11, OPER12
 
   .
   .
   .
$ REPLY/DISABLE=(PRINTER, TAPES)
%OPCOM, 24-DEC-2001 10:22:26.07, operator disabled, operator OPA0
 
      

The REPLY/ENABLE command in this example designates terminal OPA0 to receive messages from all facilities. Later, the REPLY/DISABLE command selectively disables OPA0 from receiving messages pertaining to print devices and tapes.

Displays a message at a system operator's terminal and optionally requests a reply. All messages are logged at the operator's console and in the operator's log file, if that file is initialized.

To use this command, you must start the operator communication process (OPCOM) at boot time by specifying the DCL command @SYS$SYSTEM:STARTUP OPCOM in the site-specific startup command file, SYS$MANAGER:SYSTARTUP.COM.

Format

REQUEST message-text

Parameter

message-text

Specifies the text of the message to be displayed. The string can be up to 128 characters. If the string contains spaces, special characters, or lowercase characters, enclose it in quotation marks (" ").

Description

When you use the REQUEST command to send a message to an operator, the message is displayed at the operator terminals specified with the /TO qualifier.

If you specify the /REPLY qualifier, the message is assigned an identification number, so the operator can respond to the message. The system displays the following message:

%OPCOM-S-OPRNOTIF, operator notified, waiting...hh:mm:ss

When the operator responds to your request, the system displays a message such as the following:

%OPCOM-S-OPREPLY, message text entered by operator

If you request a reply, you cannot enter any commands until the operator responds. If you press Ctrl/C, the system displays the following message:

REQUEST - Enter message or cancel with ^Z REQUEST - Message?

At this time, you can either enter another message, or press Ctrl/Z to cancel the request. If you enter another message, that message is sent to the operator, and you must continue to wait for a reply.

All messages are logged at the central operator's console and in the system operator's log file, if that file is initialized.

Qualifiers

/REPLY

Requests a reply to the message and issues a unique identification number to which the operator sends the response. The system displays a message that the operator has been notified; you cannot enter any commands until the operator responds. If you press Ctrl/C before the operator responds, you can then enter another message to the operator, or press Ctrl/Z to cancel the request.

/TO=(operator[,...])

Specifies one or more operators to whom you want to send the message. Possible keywords are as follows:

CARDS	Sends the message to operators designated to respond to card reader requests.
CENTRAL	Sends the message to the central system operator.
CLUSTER	Sends the message to operators designated to respond to cluster-related requests.
DEVICES	Sends the message to operators who mount and dismount disks.
DISKS	Sends the message to operators who mount and dismount disk volumes.
NETWORK	Sends the message to the network operator.
OPER1 to OPER12	Sends the message to operators identified as OPER1 to OPER12.
PRINTER	Sends the message to operators designated to handle print requests.
SECURITY	Sends the message to operators designated to respond to security-related requests.
TAPES	Sends the message to operators designated to mount and dismount tape volumes.

Examples

$ PRINT/COPIES=2/QUEUE=LQ_PRINT  REPORT.OUT/FORM=LETTER
  Job REPRT (queue LQA1, entry 401) pending
$ REQUEST/REPLY/TO=PRINTER -
_$"Have queued job 401 as FORM=LETTER;  can you print it?"
%OPCOM-S-OPRNOTIF, operator notified, waiting...10:42:16.10
%OPCOM-S-OPREPLY, AFTER 11:00
 14-DEC-2001 10:25:32.40, request 3 completed by operator OPA0
      

In this example the PRINT command requests that multiple copies of a file be printed using a special paper (/FORM=LETTER). After queueing the job to the printer, the REQUEST command sends a message to the system operator.

The operator sends a reply after completing the request.

$ REQUEST/REPLY  "Are you there?"
%OPCOM-S-OPRNOTIF, operator notified, waiting...14:54:30.33
[Ctrl/C]
REQUEST-Enter message or cancel request with ^Z
REQUEST-Message?[Ctrl/Z]
%OPCOM-S-OPRNOTIF, operator notified, waiting... 14:59:01.38
%OPCOM-F-RQSTCAN, request was canceled
      

In this example the REQUEST command issues a message and requests a response. When no operator replies to the question, Ctrl/C is used to interrupt the request; then Ctrl/Z is used to cancel it.

Terminates a GOSUB subroutine procedure and returns control to the command following the calling GOSUB command.

Format

RETURN [status-code]

Parameter

status-code

Defines a longword (integer) value or expression equivalent to an integer value that gives the exit status of the subroutine by defining a numeric value for the reserved global symbol $STATUS. The value can be tested by the next outer command level. The low-order 3 bits of the longword integer value change the value of the reserved global symbol $SEVERITY. If you specify a status code, DCL interprets the code as a condition code. Note that even numeric values produce warning, error, and fatal error messages, and that odd numeric values produce either no message or a success or informational message.

If you do not specify a status code, the current value of $STATUS is saved. When control returns to the outer command level, $STATUS contains the status of the most recently executed command or program.

Description

The RETURN command terminates the GOSUB subroutine and returns control back to the command following the calling GOSUB command.

When a DCL command, user program, or command procedure completes execution, the command interpreter saves the condition code value in the global symbol $STATUS. The system maintains this value in hexadecimal. If a RETURN command does not explicitly set a value for $STATUS, the command interpreter uses the current value of $STATUS to determine the error status.

The low-order 3 bits of the status value contained in $STATUS represent the severity of the condition. The reserved global symbol $SEVERITY contains this portion of the condition code. Severity values range from 0 to 4, as shown in the following table:

Value	Severity
0	Warning
1	Success
2	Error
3	Information
4	Severe (fatal) error

Note that the success and information codes have odd numeric values, and that warning and error codes have even numeric values.

Example

$ SHOW TIME 
  15-DEC-2001 14:25:42 
$ GOSUB SYMBOL 
$ EXIT 
$ SYMBOL: 
$     SHOW SYMBOL RED 
      RED = "SET DEFAULT [LOWE.DCL]" 
$     RETURN 1 
      

The GOSUB command transfers control to the subroutine labeled SYMBOL. After the subroutine is executed, the RETURN command transfers control back to the command following the calling GOSUB statement, giving $STATUS and $SEVERITY a value of 1. The procedure then exits.

	privacy and legal statement
9996PRO_045.HTML