0% found this document useful (0 votes)
198 views

ROSCOE - B001712e - System Commands Guide

ROSCOE - System Commands Guide

Uploaded by

pagbarros
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
198 views

ROSCOE - B001712e - System Commands Guide

ROSCOE - System Commands Guide

Uploaded by

pagbarros
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 150

Advantage CA-Roscoe

 

Interactive Environment

System Commands Guide


r6
This documentation and any related computer software help programs (hereinafter referred to as the
“Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at
any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in
part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA
and protected by the copyright laws of the United States and international treaties.

Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the documentation for
their own internal use, and may make one copy of the related software as reasonably required for back-up and
disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy.
Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for
the product are permitted to have access to such copies.

The right to print copies of the documentation and to make a copy of the related software is limited to the period
during which the applicable license for the Product remains in full force and effect. Should the license terminate for
any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the
Documentation have been returned to CA or destroyed.

EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY
APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING
WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY
LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT
LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY
ADVISED OF SUCH LOSS OR DAMAGE.

The use of any product referenced in the Documentation is governed by the end user’s applicable license
agreement.

The manufacturer of this Documentation is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the
restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-
7014(b)(3), as applicable, or their successors.

All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

Copyright  2005 CA. All rights reserved.


Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Chapter 1. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Chapter 2. System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1


2.1 SET PRIVILEGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
2.2 ACCT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3 AWS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
2.4 CONSOLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
2.4.1 AWS Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
2.4.2 CMD Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
2.4.3 CMM Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
2.4.4 END Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
2.4.5 MTT Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
2.4.6 NOAWS Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
2.4.7 STATUS Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
2.4.8 TERMIN Subcommand . . . . . . . . . . . . . . . . . . . . . . . . 2-15
2.4.9 UCB Subcommand . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
2.5 DEBUG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
2.6 DMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
2.7 ETSO-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
2.7.1 CANCEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
2.7.2 FREE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27
2.7.3 QUERY ALLOCATE . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28
2.7.4 QUERY CALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
2.8 LIBCACHE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33
2.9 LOOK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
2.10 MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
2.11 Operator Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39
2.11.1 ACCT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42
| 2.11.2 DISABLE/ENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
2.11.3 FLUSH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
2.11.4 INTERVAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
2.11.5 LERPRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-45
2.11.6 MESSAGES/NOM . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46
2.11.7 NETSTAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
2.11.8 OFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
2.11.9 REFRESH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
2.11.10 RESTART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49

Contents iii
2.11.11 RESTART (Line) . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
2.11.12 ROSLOG/NOROSLOG . . . . . . . . . . . . . . . . . . . . . . . 2-50
2.11.13 RPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
2.11.14 RTM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
2.11.15 SEND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
2.11.16 SEND (ALL)/NOSEND . . . . . . . . . . . . . . . . . . . . . . . 2-56
2.11.17 SEND (KEY/PFX) . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
2.11.18 SHUTDOWN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
2.11.19 SIGNON/NOSIGNON . . . . . . . . . . . . . . . . . . . . . . . 2-60
2.11.20 SPOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
2.11.21 STATUS/STATUSX . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
2.11.22 STOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
2.11.23 SUBMIT/NOSUBMIT . . . . . . . . . . . . . . . . . . . . . . . . 2-63
2.11.24 VTAM FORCINT . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
2.11.25 VTAM OPENINT . . . . . . . . . . . . . . . . . . . . . . . . . . 2-65
2.11.26 VTAM START . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-65
2.11.27 VTAM STOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
2.11.28 VTAM STOP FORCE . . . . . . . . . . . . . . . . . . . . . . . . 2-67
2.11.29 VTAM STOP QUICK . . . . . . . . . . . . . . . . . . . . . . . . 2-68
2.11.30 VTAM STOPINT . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
2.11.31 VTAM WARNINT . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69
2.12 PEEK (RPF Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-70
2.13 RCSTRACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-73
2.14 ROS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-78
2.15 ROZAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-82
2.16 RPS Commands For ACA . . . . . . . . . . . . . . . . . . . . . . . . . 2-86
2.16.1 PRINT CANCEL (For ACA) . . . . . . . . . . . . . . . . . . . . . 2-87
2.16.2 PRINT HOLD (For ACA) . . . . . . . . . . . . . . . . . . . . . . 2-89
2.16.3 PRINT MOD (For ACA) . . . . . . . . . . . . . . . . . . . . . . . 2-91
2.16.4 PRINT RELEASE (For ACA) . . . . . . . . . . . . . . . . . . . . . 2-92
2.16.5 PRINT ROUTE (For ACA) . . . . . . . . . . . . . . . . . . . . . . 2-94
2.17 RPS Commands For Privileged Users . . . . . . . . . . . . . . . . . . 2-96
2.17.1 PRINT CANCEL (For Privileged Users) . . . . . . . . . . . . . . 2-96
2.17.2 PRINT HOLD (For Privileged Users) . . . . . . . . . . . . . . . 2-98
2.17.3 PRINT MOD (For Privileged Users) . . . . . . . . . . . . . . . . 2-100
2.17.4 PRINT RELEASE (For Privileged Users) . . . . . . . . . . . . . . 2-101
2.17.5 PRINT RESTART (For Privileged Users) . . . . . . . . . . . . . 2-103
2.17.6 PRINT ROUTE (For Privileged Users) . . . . . . . . . . . . . . . 2-105
2.17.7 PRINT START (For Privileged Users) . . . . . . . . . . . . . . . 2-106
2.17.8 PRINT STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-107
2.17.9 PRINT STOP (For Privileged Users) . . . . . . . . . . . . . . . . 2-108
2.18 RTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-110
2.19 RTM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-112

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . X-1

iv System Commands Guide


About This Guide

The Advantage CA-Roscoe Interactive Environment System Commands Guide


contains detailed descriptions of the commands that are provided to assist the
individuals responsible for monitoring and maintaining Advantage CA-Roscoe.

Organization
The commands in this guide are arranged alphabetically. Each command
description includes:
■ A one-sentence description of the function the command performs.
■ The syntax of the command and an explanation of that syntax.
■ Notes about using the command.
■ Examples and explanations of displays, when appropriate.

About This Guide v


Summary of Revisions for Service Pack 5
Editorial and minor technical changes have been made throughout this
manual.

vi System Commands Guide


Summary of Revisions
Changes to Advantage CA-Roscoe Release 6.0 that affect this manual include:
■ Internal security was changed for Release 6.0. This change enables sites to
allocate specific privileges to specified users. The RO and AI accounts
have been enhanced with four privilege areas. They are the following:
1. OPER: Allows the use of the DEBUG, LIBCACHE, OPERATOR
(OPER), RCSTRACE, ROZAP commands, privileged use of the
MESSAGE command, and use of the PEEK function.
2. RPS: Allows use of the privileged operands of the PRINT command.
3. ACCT: Allows use of ACCT and RTM commands.
4. ETSO: Allows use of the privileged operands of the CANCEL, FREE,
and QUERY commands.
■ OPERATOR command: The new subcommands ENABLE and DISABLE
enable or disable users from using a Advantage CA-Roscoe command.
The subcommand NOMESSAGES has been changed to NOMSGS.
■ ROZAP command: Two new operands ENABLE and DISABLE can be
used to enable or disable users from using specified Advantage CA-Roscoe
commands.
■ SET PRIVILEGE command: Determines a user's ability to issue system
(privileged) commands.
■ Editorial and minor technical changes have been made throughout this
manual.

About This Guide vii


Advantage CA-Roscoe Publications
The following publications are supplied with Advantage CA-Roscoe Interactive
Environment. They are divided into a User Series and a System Series.

User Series Contents


Name
Command Reference Describes all Advantage CA-Roscoe primary and
Guide line commands and Monitor commands.
Extended Development Describes how: 1) the Application Programming
Tools Guide Interface (API) can be used by applications
executing under ETSO to take advantage of
Advantage CA-Roscoe facilities, and 2) the
interactive facilities provided by SKETCH can be
used to generate and maintain panels used in
programs running under CICS or IMS.
Getting Started Introduces Advantage CA-Roscoe to
non-programmers.
Release Guide Provides a summary of the enhancements included
in this release.
RPF Language Guide Describes all components of the RPF language and
how to write RPF programs. It also describes the
Dialog Management Facility (DMF) which can be
used to develop, maintain and execute panel-driven
RPF applications.
User Guide Provides task-oriented descriptions of how to use
Advantage CA-Roscoe.

viii System Commands Guide


System Series Contents
Name
Extended Facilities for Describes how sites can make extensions to their
System Programmers Advantage CA-Roscoe system. This includes
Guide creating site-written Monitor routines and
customizing security and other online exits.
Installation Guide Describes the steps to follow when installing or
upgrading Advantage CA-Roscoe.
Messages and Codes Explains all messages that might be received by
Guide individuals using Advantage CA-Roscoe or by the
individual responsible for maintaining Advantage
CA-Roscoe.
Programs and Utilities Describes Advantage CA-Roscoe execution
Guide requirements. Also describes maintenance and
reporting programs for the accounting facility,
Active Work Space (AWS), library system, and user
profile system.
Security Administration Describes implementation of internal and external
Guide security to protect your Advantage CA-Roscoe
system.
System Commands Guide Describes commands used to control and monitor
Advantage CA-Roscoe and to obtain performance
information about that execution.
System Reference Guide Intended for the individual responsible for
maintaining Advantage CA-Roscoe. It describes
Advantage CA-Roscoe and its components.

Related Publications
The following publications relate to Advantage CA-Roscoe and are supplied by
Computer Associates:

Name Version Operating System


Advantage CA-Earl MVS Reference Guide 5.0 MVS
Unicenter CA-JCLCheck MVS Message 6.0 MVS
Guide
CAIRIM Component Supplement 1.0 MVS
Product Services 1.0 MVS

About This Guide ix


Reading Syntax Diagrams
The formats of all statements and some basic language elements are illustrated
using syntax diagrams. Read syntax diagrams from left to right and top to
bottom.

The following terminology, symbols, and concepts are used in syntax


diagrams.

Keywords: Appear in uppercase letters, for example, COMMAND or PARM.


These words must be entered exactly as shown.

Variables: Appear in italicized lowercase letters, for example, variable.

Required Keywords and Variables: Appear on a main line.

Optional Keywords and Variables: Appear below a main line.

Default Keywords and Variables: Appear above a main line.

Double Arrowheads Pointing to the Right: Indicate the beginning of a


statement.

Double Arrowheads Pointing to Each Other: Indicate the end of a


statement.

Single Arrowheads Pointing to the Right: Indicate a portion of a statement,


or that the statement continues in another diagram.

Punctuation Marks or Arithmetic Symbols: If punctuation marks or


arithmetic symbols are shown with a keyword or variable, they must be
entered as part of the statement or command. Punctuation marks and
arithmetic symbols can include:

, comma > greater than symbol


. period < less than symbol
( open parenthesis = equal sign
) close parenthesis ¬ not sign
+ addition − subtraction
* multiplication / division

x System Commands Guide


The following is an example of a statement without parameters.

Statement Without Parameters


──COMMAND─────────────────────────────────────────────────────

You must write:

COMMAND

Required parameters appear on the same horizontal line (the main path of the
diagram) as the command or statement. The parameters must be separated by
one or more blanks.

Statement with Required Parameters


──COMMAND──PARM1──PARM2───────────────────────────────────────

You must write:

COMMAND PARM1 PARM2

Delimiters such as parentheses around parameters or clauses must be included.

Delimiters Around Parameters


──COMMAND──(PARM1)──PARM2='variable'──────────────────────────

If the word variable is a valid entry, you must write:

COMMAND (PARM1) PARM2='variable'

Where you see a vertical list of parameters as shown in the following example,
you must choose one of the parameters. This indicates that one entry is
required and only one of the displayed parameters is allowed in the statement.

Choice of Required Parameters


──COMMAND──┬─PARM1─┬──────────────────────────────────────────
├─PARM2─┤
└─PARM3─┘

You can choose one of the parameters from the vertical list, such as in the
following examples:

COMMAND PARM1
COMMAND PARM2
COMMAND PARM3

About This Guide xi


When a required parameter in a syntax diagram has a default value, it
indicates the value for the parameter if the command is not specified. If you
specify the command, you must code the parameter and specify one of the
displayed values.

Default Value for a Required Parameter


┌─YES─┐
──COMMAND──PARM1=─┴─NO──┴───PARM2─────────────────────────────

If you specify the command, you must write one of the following:

COMMAND PARM1=NO PARM2


COMMAND PARM1=YES PARM2

A single optional parameter appears below the horizontal line that marks the
main path.

Optional Parameter
──COMMAND──┬───────────┬──────────────────────────────────────
└─PARAMETER─┘

You can choose (or not) to use the optional parameter, as shown in the
following examples:

COMMAND
COMMAND PARAMETER

If you have a choice of more than one optional parameter, the parameters
appear in a vertical list below the main path.

Choice of Optional Parameters


──COMMAND──┬───────┬──────────────────────────────────────────
├─PARM1─┤
└─PARM2─┘

You can choose any of the parameters from the vertical list, or you can write
the statement without an optional parameter, such as in the following
examples:

COMMAND
COMMAND PARM1
COMMAND PARM2

xii System Commands Guide


For some statements, you can specify a single parameter more than once. A
repeat symbol indicates that you can specify multiple parameters. The
following examples include the repeat symbol.

Repeatable Variable Parameter


┌──
──────────┐
─variable─┴───────────────────────────────────────
──COMMAND───

In the preceding example, the word variable is in lowercase italics, indicating


that it is a value you supply, but it is also on the main path, which means that
you are required to specify at least one entry. The repeat symbol indicates that
you can specify a parameter more than once. Assume that you have three
values named VALUEX, VALUEY, and VALUEZ for the variable. Some of
your choices are:

COMMAND VALUEX
COMMAND VALUEX VALUEY
COMMAND VALUEX VALUEX VALUEZ

If the repeat symbol contains punctuation such as a comma, you must separate
multiple parameters with the punctuation. The following example includes the
repeat symbol, a comma, and parentheses.

Separator with Repeatable Variable and Delimiter


┌─,────────┐
─variable─┴──)─────────────────────────────────
──COMMAND──(───

In the preceding example, the word variable is in lowercase italics, indicating


that it is a value you supply. It is also on the main path, which means that
you must specify at least one entry. The repeat symbol indicates that you can
specify more than one variable and that you must separate the entries with
commas. The parentheses indicate that the group of entries must be enclosed
within parentheses. Assume that you have three values named VALUEA,
VALUEB, and VALUEC for the variable. Some of your choices are:

COMMAND (VALUEC)
COMMAND (VALUEB,VALUEC)
COMMAND (VALUEB,VALUEA)
COMMAND (VALUEA,VALUEB,VALUEC)

The following example shows a list of parameters with the repeat symbol.

Optional Repeatable Parameters


┌──
─────────┐ ┌──
─────────┐ ┌──
─────────┐
┬───────┬┴───
──COMMAND─── ┬───────┬┴───
┬───────┬┴──────────────
└─PARM1─┘ └─PARM2─┘ └─PARM3─┘

About This Guide xiii


Some choices you can make include:

COMMAND PARM1
COMMAND PARM1 PARM2 PARM3
COMMAND PARM1 PARM1 PARM3

For example, YES in the following diagram, its special treatment indicates it is
the default value for the parameter. If you do not include the parameter when
you write the statement, the result is the same as if you had actually specified
the parameter with the default value.

Default Value for a Parameter


──COMMAND──┬─────────────────┬──PARM2─────────────────────────
│ ┌─YES─┐ │
└─PARM1=─┴─NO──┴──┘

Because YES is the default in the example preceding, if you write:

COMMAND PARM2

you have written the equivalent of:

COMMAND PARM1=YES PARM2

In some syntax diagrams, a set of several parameters is represented by a single


reference, as in this example:

Variables Representing Several Parameters


──COMMAND──┬─────────────────────┬────────────────────────────
├─PARM1───────────────┤
└─┤ parameter-block ├─┘
parameter-block:
├──┬──────────────────┬──────────────────────────────────────────┤
├─PARM2────────────┤
└─PARM3─┬───────┬──┘
├─PARM4─┤
└─PARM5─┘

The parameter-block can be displayed in a separate syntax diagram.

Choices you can make from this syntax diagram therefore include (but are not
limited to) the following:

COMMAND PARM1
COMMAND PARM3
COMMAND PARM3 PARM4
Note: Before you can specify PARM4 or PARM5 in this command, you must
specify PARM3.

xiv System Commands Guide


A note in a syntax diagram is similar to a footnote except that the note appears
at the bottom of the diagram box.

──COMMAND──┬─────────┬────────────────────────────────────────
(1)
└─PARM1─── ┘
Note:
1 This is a note about the item.

About This Guide xv


xvi System Commands Guide
Chapter 1. Getting Started

The commands and facilities described in this manual are provided to assist
sites in monitoring and controlling the activities occurring during an execution
of Advantage CA-Roscoe.

The following charts contain a synopsis of these activities. They also introduce
the command that can be used to control or monitor those activities.

Accounting Activity Command


What is the current status of the accounting ACCT & OPR ACCT
buffers, files or subsystem?
How can the facility be activated? ACCT & OPR ACCT
How can files be 'switched'? ACCT & OPR ACCT

AWS Activity Command


What is the current configuration? AWS
What is the current status? AWS
What is the current AWS cache status? AWS

Device Activity Command


How many terminals defined to Advantage ROS
CA-Roscoe?
How many can be concurrently signed on? ROS
How many are currently active and/or inactive? ROS
What is the current status of a specific device? ROS
What device is a specific user signed on to? ROS
Who is using a specific device? ROS
How can a device be flushed? OPR FLUSH & ROZAP
How can information about lines and devices OPR STATUS & OPR
signed on be displayed? STATUSX

Chapter 1. Getting Started 1-1


Device Activity Command
How can line error statistics be printed? OPR LERPRT
How can a remote BTAM line/cluster be restarted? OPR RESTART
How can a local BTAM device be restarted? OPR RESTART
How can a line/cluster be shutdown? OPR STOP
How often was a device active during a Advantage RTF
CA-Roscoe execution?
How can response-times be monitored? RTM

ETSO Activity Command


How do you terminate execution of an CANCEL
application?
How do you deallocate files? FREE
How do you determine the status of allocated files? QUERY ALLOC
How do you determine the status of executing QUERY CALL
applications?

Monitor Routine Activity Command


What routines are currently available? MONITOR
How many users have or are currently using these MONITOR
routines?
What is the current status of each routine? MONITOR
What is the entry point of each routine? MONITOR
How many routines have been reloaded? MONITOR
How do you reload a routine? ROZAP
How many routines have been locked/unlocked? MONITOR
How do you lock/unlock a routine? ROZAP
How can the pause limit be changed? ROZAP

RPF Routine Activity Command


Who is currently executing programs? DMS
What programs are currently being executed? DMS
What is the status of the currently executing DMS
programs?

1-2 System Commands Guide


RPF Routine Activity Command
What resources are those programs using? DMS
How large is the RDM? DMS
How many permanent variables are defined? DMS
What is the current RPF loop limit? DMS

RPS (Printing Services) Activity Command


How do you cancel one or more outstanding print PRINT CANCEL
requests?
How do you hold one or more print requests? PRINT HOLD
How do you change the current printing location? PRINT MOD
How do you assign an alias? PRINT MOD
How do you release a held request? PRINT RELEASE
How do you reroute print requests? PRINT ROUTE
How do you determine the current status of RPS? PRINT STATUS
How do you stop RPS? PRINT STOP & OPR
RPS
How do you restart RPS? PRINT START & OPR
RPS
How do you stop and start RPS? PRINT RESTART &
OPR RPS

System Activity Command


How can Advantage CA-Roscoe be shutdown? OPR SHUTDOWN &
ROZAP
How can Advantage CA-Roscoe/VTAM -
communications be: OPR STOP
Stopped? OPR START
Started? OPR RESTART
Stopped and restarted?
How can Advantage CA-Roscoe/VTAM OPR NETSTAT
communications status be displayed?

Chapter 1. Getting Started 1-3


System Activity Command
How can Advantage CA-Roscoe/VTAM intervals -
be: OPR INTERVAL
Displayed? OPR FORCINT, OPR
Changed? OPENIT, OPR
STOPINT & OPR
WARNINT
How can information be obtained about: -
Storage used by the Data Set Facility? DMS
Enabling VTAM trace facility? ROZAP
Spool volumes allocated to Advantage OPR SPOOL
CA-Roscoe? ROS
Advantage CA-Roscoe system status? CONSOLE MTT
MVS Master Trace Table? CONSOLE STATUS
UCB addresses of currently active consoles? CONSOLE UCB
Displaying messages directed to specific consoles?
How can informational Advantage CA-Roscoe -
messages to the console be: OPR NOROSLOG
Disabled? OPR ROSLOG
Enabled?
How can messages be sent to: -
One or more active users? OPR SEND
All users? OPR SEND ALL
One or more users? OPR SEND KEY/PFX
How can command execution be disabled? OPR DISABLE &
ROZAP
How can command execution be enabled? OPR ENABLE &
ROZAP
How can job submission be disabled? OPR NOSUBMIT &
ROZAP
How can job submission be enabled? OPR SUBMIT &
ROZAP
How can user sign-ons be disabled? OPR NOSIGNON &
ROZAP
How can user sign-ons be enabled? OPR SIGNON &
ROZAP
How can a user/device be forced off Advantage OPR FLUSH, OPR OFF
CA-Roscoe? & ROZAP
How can a user be forced off Advantage OPR FLUSH, OPR OFF
CA-Roscoe? & ROZAP
What commands have users executed? RTF

1-4 System Commands Guide


System Activity Command
What activities did users perform when signed on? RTF
How many users have split-screens? ROS
How can user response-times be monitored? RTM

Chapter 1. Getting Started 1-5


1-6 System Commands Guide
Chapter 2. System Commands

The commands in this guide are used to control and monitor Advantage
CA-Roscoe and can only be issued by users having privileged authority. The
SET PRIVILEGE command determines the use of these commands.

The system command descriptions are arranged alphabetically following the


SET PRIVILEGE command.

Chapter 2. System Commands 2-1


2.1 SET PRIVILEGE

2.1 SET PRIVILEGE


FUNCTION: Controls the use of privileged commands.

SYNTAX

SET PRIVILEGE Command


┌─OFF─┐
──SET PRIVILEGE──┴─ON──┴──────────────────────────────────────

OFF Disables a user's ability to issue privileged commands.


ON Allows the use of privileged commands.

NOTES:

Additional information about using this command:


■ The default is SET PRIVILEGE OFF.
■ When OFF is in effect, users will receive the following message:
CMD5 COMMAND REJECTED BY SITE MANAGEMENT
■ To give a userid consistant access to privileged commands, include the
SET PRIVILEGE ON command in the sign-on procedure.
■ The system variable S.PRIV contains the setting of the SET PRIVILEGE
command. S.PRIV will contain the value ON or OFF depending upon the
use of the SET PRIVILEGE command.

2-2 System Commands Guide


2.2 ACCT

2.2 ACCT
FUNCTION: Activates the accounting facility, switches accounting files and
displays accounting status information.

SYNTAX

ACCT Command
──ACCt──┬─BUFfers───┬─────────────────────────────────────────
├─FILes─────┤
├─ROSCOE ON─┤
├─SMF ON────┤
├─STAtus────┤
└─SWITCH────┘

BUFfers Displays information about the status of the accounting


buffers.
FILes Displays status information about the accounting files.
ROSCOE ON Activates the accounting facility.
SMF ON Activates the SMF accounting facility.
STAtus Displays the current status of the accounting subsystem.
SWITCH Causes the accounting facility to switch to the next
ROSACTnn file.

NOTES: Additional information about using this command:


■ ACCT may also be issued as an Operator Command.
■ Using ROSCOE ON:
ACCT ROSCOE ON causes Advantage CA-Roscoe to attempt to activate
the accounting facility using the values specified with the ACCTBUFF
initialization parameter. If initialization is successful, a message is
displayed showing the number of buffers and their sizes.
If the accounting facility cannot be activated, the following message is
displayed:
NO FILES AVAILABLE TO START ACCOUNTING
If all of the files are full, the ACCTDUMP program must be executed to
clear the files. The ACCT ROSCOE ON command can then be reissued.
If the Advantage CA-Roscoe accounting DD statements contain an error or
are missing, the following message is displayed:
ROSCOE OPTION PERMANENTLY DISABLED

Chapter 2. System Commands 2-3


2.2 ACCT

■ Using SMF ON:


ACCT SMF ON causes Advantage CA-Roscoe accounting records to be
written to SMF files. This command may only be issued if the Advantage
CA-Roscoe JCL contains the initialization parameter ACCTSMF=INACT.
■ Using SWITCH:
ACCT SWITCH is honored only if the next sequentially numbered
ROSACTnn file is empty. If the operation is successful, a message is
displayed identifying the file to which Advantage CA-Roscoe has
switched.
■ ACCT BUFFERS Display:
The following screen illustrates the type of information provided by the
ACCT BUFFERS command.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
ROSCOE ACCOUNTING BUFFER STATUS 15:39:1

SIZE 28 1


NUMBER 2 2

TOTAL WAITS FOR A BUFFER  3


TOTAL USERS WHO WAITED  4

POSTED OUT OF SEQUENCE  5

6 7 8 9 1 11


BUFFER BYTE REM USERS OPTION(S) RECORDS NOTES
-------- -------- ----- --------- -------- --------------------------
1CC8 212  ROS 6 CURR CHRN
1CC 24  
 
1 SIZE: Size of the accounting buffer as defined by the ACCTBUFF=
initialization parameter.
2 NUMBER: Number of accounting buffers defined by the
ACCTBUFF= initialization parameter.
3 TOTAL WAITS FOR A BUFFER: Number of times a user had to
wait for a buffer.
Note: If the number is not zero, increase the size of the buffers or
the number of buffers.
4 TOTAL USERS WHO WAITED: Total number of users who had to
wait for a buffer.

2-4 System Commands Guide


2.2 ACCT

5 POSTED OUT OF SEQUENCE: Number of buffers that were ready


to be written before the chronological buffer was posted.
Note: If the number is not zero, increase the size of the buffers or
the number of buffers.
6 BUFFER: Address of the buffer.
7 BYTE REM: Number of available bytes remaining in the buffer.
8 USERS: Number of users currently accessing the buffer.
9 OPTION(S): Accounting system to which the records are being
written, shown as ROS (for Advantage CA-Roscoe) or SMF.
1 RECORDS: Number of records written to the buffer.
11 NOTES: Current status of the buffer which can be:
CUR Buffer currently in use.
CHRON
This buffer is chronologically the next one to be written.
LREF Last referenced buffer about to be FREMAINed.
FULL Buffer is currently full.
POSQ Buffer was posted out of sequence.
■ ACCT FILES Display:
The following screen illustrates the type of information provided by the
ACCT FILES command.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
ROSCOE ACCOUNTING FILE STATUS 15:51:48
1 2 3 4 5
TRACKS
DDNAME STATUS USED FREE DATA SET NAME / VOLSER - DEVICE
-------- ------- ----- ----- ----------------------------------------
ROSACT ACTIVE 13 2 ROSCOE.SAMP.ROSACT
MUROS2 338
ROSACT1 EMPTY  15 ROSCOE.SAMP.ROSACT1
MUROS2 338

 
1 DDNAME: Name of the DD statement.
2 STATUS: Current status of the file, which can be:
ACTIVE Currently in use.
EMPTY File is available for use.

Chapter 2. System Commands 2-5


2.2 ACCT

FULL File is not available for use until it has been


cleared by the ACCTDUMP program.
3 TRACKS: Number of tracks that have been used and that are
available for use.
4 DATA SET NAME: Name of the file.
5 VOLSER - DEVICE: Volume serial number and type of device on
which the file resides.
■ ACCT STATUS Display:
The following screen illustrates the type of information provided by the
ACCT STATUS command.

_ 
> APPLID(DROSBTZ) USER(RO,ROSCOE.CONTROL) L PENDING
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
ROSCOE ACCOUNTING STATUS 15:57:54
ACCOUNTING FACILITY ROSCOE SMF
------------------- -------- --------
STATUS ACTIVE DISABLED 1
RECORDS WRITTEN 26  2
BUFFERS WRITTEN 29 3
DATE INITIALIZED 5/3/9 4
TIME INITIALIZED 1.13.3 5

 
1 STATUS: Current status of the subsystem, which can be:
ACTIVE In use.
DISABLED Not used during this execution of Advantage
CA-Roscoe.
2 RECORDS WRITTEN: Number of records written during the current
execution of Advantage CA-Roscoe.
3 BUFFERS WRITTEN: Number of buffers written to the accounting
files during the current execution of Advantage CA-Roscoe.
4 DATE INITIALIZED: Date the accounting subsystem was activated.
5 TIME INITIALIZED: Time the accounting subsystem was activated.

2-6 System Commands Guide


2.3 AWS

2.3 AWS
FUNCTION: Displays information about the AWS configuration, status and
performance.

SYNTAX:

AWS Command
──AWS──┬────┬─────────────────────────────────────────────────
├─-A─┤
├─-C─┤
├─-M─┤
└─-S─┘

With no operand, displays the current configuration and status


information.
-A writes all information to the active AWS. If omitted, the information is
displayed at the terminal.
-C displays information about the current AWS configuration.
-M displays information about the AWS Cache Facility.
-S displays information about the current status of the AWS.

NOTES:

Additional information about using this command:


■ AWS is a Monitor command. As distributed, the use of this command is
not restricted.
■ Additional AWS statistics are written to the accounting files every time
Advantage CA-Roscoe is shutdown. To obtain a hardcopy of these
statistics, use the Advantage CA-Earl program, as described in the
Advantage CA-Roscoe Interactive Environment Programs and Utilities Guide.
■ AWS-C Display:
The following screen illustrates the type of information provided by the
AWS-C command.

_ 

>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
MAXIMUM SEQUENCE NUMBER 999999 1 MAXIMUM NUMBER OF LINES 32 6
NUMBER OF AWS'S 25 2 NUMBER OF ACTIVE AWS'S 54 7
MAXIMUM ACTIVE AWS'S 74 3 MINIMUM AVAILABLE AWS'S 176 8
DATA BLOCK SIZE 256 4 INDEX BLOCK SIZE 512 9
NUMBER OF DATA FILES 3 5 NUMBER OF INDEX FILES 1 1

Chapter 2. System Commands 2-7


2.3 AWS

1 MAXIMUM SEQUENCE NUMBER: Highest sequence number


allowed in the AWS.
2 NUMBER OF AWS'S: Number of AWSs defined by the site.
3 MAXIMUM ACTIVE AWS'S: Largest number of AWSs used during
the current execution.
4 DATA BLOCK SIZE: Block size defined by the site.
5 NUMBER OF DATA FILES: Number of files defined by the site.
6 MAXIMUM NUMBER OF LINES: Total number of lines that can be
in the AWS.
7 NUMBER OF ACTIVE AWS'S: Number of AWSs currently active.
8 MINIMUM AVAILABLE AWS'S: Fewest number of AWSs available
during the current session.
Note: If this number gets close to 0, additional AWSs should be
added.
9 INDEX BLOCK SIZE: Block size established by Advantage
CA-Roscoe.
1 NUMBER OF INDEX FILES: Number of files defined by the site.
■ AWS-M Display:
The following screen illustrates the type of information provided by the
AWS-M command.

_ 

>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
THE AWS CACHE IS ACTIVE
1 2 3 4
ALLOCATION CURRENT CURRENTLY CURRENTLY
LIMIT ALLOCATION IN USE AVAILABLE
INDEX - BLOCKS 88 88 56 32
BYTES 45,56 45,56 28,672 16,384

DATA - BLOCKS 392 392 243 149


BYTES 1,3,52 1,3,52 622,8 381,44

5 6 7 8


READS WRITES READ HITS HIT%
INDEX 713 9,72 713 1
DATA 45,248 37,529 42,9 93
 
1 ALLOCATION LIMIT: Maximum amount of storage that can be
acquired for this execution, as specified by the AWSCACHE=
initialization parameter.

2-8 System Commands Guide


2.3 AWS

2 CURRENT ALLOCATION: Amount of storage that is currently


acquired.
3 CURRENTLY IN USE: Amount of acquired storage that is currently
in use.
4 CURRENTLY AVAILABLE: Amount of acquired storage that
remains available for use.
5 READS: Number of times a read was requested.
6 WRITES: Number of writes to the AWSCACHE (and disk file(s)).
7 READ HITS: Number of times the contents of the AWSCACHE
satisfied a read request.
8 HIT %: Percentage of read requests that were satisfied.
■ AWS-S Display:
The following screen illustrates the type of information provided by the
AWS-S command.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
FILE TOTAL FREE USED HWM LWM
BLOCKS BLOCKS BLOCKS USED FREE
1 2 3 4 5
SYSAWSP 2752 234 448 6 2152
SYSAWS1 224 1888 352 896 1344
SYSAWS2 224 1888 352 88 136
SYSAWS3 224 194 336 88 136

1 TOTAL BLOCKS: Number of AWS blocks defined.


Note: Adding the number of Free Blocks and Used Blocks should
equal the Total Blocks.
Adding the HWM Used and the LWM Free should equal
Total Blocks.
2 FREE BLOCKS: Number of blocks currently available.
3 USED BLOCKS: Number of blocks currently in use.
4 HWM USED: (High-Water Mark) Greatest number of blocks used
during the current execution.
5 LWM FREE: (Low-Water Mark) Fewest number of blocks available
during the current execution.
Note: If this number gets close to 0, increase the size of the pointer
and/or data files.

Chapter 2. System Commands 2-9


2.4 CONSOLE

2.4 CONSOLE
FUNCTION: Executes operator commands and displays:
1. Messages written to the master or designated console,
2. The MVS Master Trace Table, and
3. Currently active console addresses.

SYNTAX:

CONSOLE Command
──┬─────┬──CONsole──┬──────────────────────┬──────────────────
└─RUN─┘ ├──┬────┬──┬────────┬──┤
│ └─-X─┘ └─string─┘ │
└─┬─────────────┬──────┘
└─-A─┬─────┬──┘
└─mem─┘

With no operand, displays the messages written to the master system


console.
RUN required when the subcommand is to be read from a library member.
-X executes the subcommand specified as the string, writes the results to
the terminal and prompts for the next subcommand.
If no string is specified, prompts for a subcommand, executes the
subcommand, write the results to the terminal and prompts for the
next subcommand.
If -X is omitted, executes the subcommand, writes the results to the
terminal and stops.
string is the subcommand to be executed.
-A causes the subcommand to be read from the designated library
member. If no member name is specified, the subcommand is read
from the active AWS.
mem is the name of the library member containing the subcommand.

NOTES: Additional information about using this command:


■ CONSOLE is a Monitor command. As distributed, it is not restricted.
■ With the -A operand, if the end-of-file condition is reached before the END
subcommand is found, CONSOLE prompts for a subcommand to be
entered from the terminal.
■ CONSOLE commands can also be executed from a panel environment. The
Advantage CA-Roscoe Job Facility RPF (AJOB) provides an Operator
Control panel from which you can execute the CONSOLE CMD, CMM,

2-10 System Commands Guide


2.4 CONSOLE

MTT, S, and UCB commands. See the Advantage CA-Roscoe Interactive


Environment User Guide for more information.

2.4.1 AWS Subcommand


FUNCTION: Directs all subsequent output to the active AWS instead of the
terminal

SYNTAX

AWS Subcommand
──CONsole──AWS────────────────────────────────────────────────

There are no operands.

NOTES: Additional information about using this command:


■ Use the NOAWS subcommand to reset the output destination.

2.4.2 CMD Subcommand


FUNCTION: Executes operator commands and displays the contents of the
master console buffer.

SYNTAX

CMD Subcommand
──CONsole──CMD string─────────────────────────────────────────

string is any valid operator command.

NOTES: Additional information about using this command:


■ Following the execution of this subcommand, an acknowledgement
message is displayed; CONSOLE waits approximately one second and then
displays the contents of the master console buffer.
Use the CMM subcommand if the master console display is not desired.
■ VM Sites:
You can issue CP commands and receive the response from those
commands.
■ JES3 Sites:
You can issue JES3 operator commands. There is no response from these
commands.

Chapter 2. System Commands 2-11


2.4 CONSOLE

Caution
When a command is issued that begins with #CP (at a VM site) or an 8 or *
(at a JES3 site), CONSOLE passes the command. It does not verify any CP
or JES3 commands. You must, therefore, be aware of the consequences of
issuing any of these commands. For example, at VM sites, #CP LOGOFF
brings down your site's MVS virtual machine; while at JES3 sites,
*RETURN brings down JES3. It is strongly recommended that sites write
an exit routine to monitor the commands that are entered. (See the
Advantage CA-Roscoe Interactive Environment Extended Facilities for System
Programmers Guide for information on writing a CONEXIT routine.)

■ Using COMCHAR Initialization Parameter:


If your site has included the COMCHAR initialization parameter in the
Advantage CA-Roscoe JCL, you may issue operator commands in the
form:
CONSOLE CMD c rosid [oprcmd]
where:
c is the special character defined by the COMCHAR= parameter.
rosid is the unique identifier assigned to each Advantage CA-Roscoe
running at your site. It may be omitted if each Advantage
CA-Roscoe has it own unique communications character (defined
by COMCHAR). It is required if multiple Advantage CA-Roscoes
are using the same communications character.
oprcmd is the operator command to be executed.
Whether your site is using the facility provided by COMCHAR, you may
enter operator commands in the form:
CONSOLE CMD F jobname, oprcmd
where jobname is the name of the Advantage CA-Roscoe job and oprcmd
is the operator command to be executed.

EXAMPLES: Examples illustrating the use of this command:


1. To set job number 521 to class A:
CONSOLE CMD $TJ521,C=A
2. To execute the RTM command:
CONSOLE CMD F ROSCOE, RTM LIST
or
CONSOLE CMD / RTM LIST

2-12 System Commands Guide


2.4 CONSOLE

2.4.3 CMM Subcommand


FUNCTION: Executes operator commands

SYNTAX

CMM Subcommand
──CONsole──CMM string─────────────────────────────────────────

string is any valid operator command.

NOTES:

Additional information about using this command:


■ Following the execution of this command, an acknowledgement message is
displayed.
Use the CMD subcommand to display the contents of the master console
buffer.
■ VM Sites:
You can issue CP commands. See the description of the CMD
subcommand for additional information.
■ JES3 Sites:
You can issue JES3 operator commands. See the description of the CMD
subcommand for additional information.
■ Using The COMCHAR Initialization Parameter:
See the description of the CMD subcommand for additional information.

2.4.4 END Subcommand


FUNCTION: Terminates the CONSOLE command.

SYNTAX

END Subcommand
──CONsole──END────────────────────────────────────────────────

There are no operands.

Chapter 2. System Commands 2-13


2.4 CONSOLE

2.4.5 MTT Subcommand


FUNCTION: Displays the MVS Master Trace Table.

SYNTAX

MTT Subcommand
──CONsole──MTT────────────────────────────────────────────────

There are no operands.

NOTES: Additional information about using this command:


■ The MTT subcommand is recognized only if the IBM option SU64 is
installed at the site.
■ The entire Master Trace Table is displayed.

2.4.6 NOAWS Subcommand


FUNCTION: Directs all subsequent output to the terminal, instead of the active
AWS.

SYNTAX

NOAWS Subcommand
──CONsole──NOAWS──────────────────────────────────────────────

There are no operands.

2.4.7 STATUS Subcommand


FUNCTION: Displays the ucb address of defined consoles that are currently
active in the system.

SYNTAX

STATUS Subcommand
──CONsole──Status─────────────────────────────────────────────

There are no operands.

2-14 System Commands Guide


2.4 CONSOLE

2.4.8 TERMIN Subcommand


FUNCTION: Directs CONSOLE to read subsequent subcommands from the
terminal.

SYNTAX

TERMIN Subcommand
──CONsole──TERMIN─────────────────────────────────────────────

There are no operands.

2.4.9 UCB Subcommand


FUNCTION: Displays messages written to the designated console.

SYNTAX

UCB Subcommand
──CONsole──UCB ucb────────────────────────────────────────────

ucb
is the address of the console whose messages are to be displayed.

NOTES: Additional information about using this command:


■ Use the STATUS subcommand to obtain the ucb addresses of the
site-defined consoles.

Chapter 2. System Commands 2-15


2.5 DEBUG

2.5 DEBUG
FUNCTION: Allows the region size of the executing online task, as well as the
amount of free storage in that region, to be displayed at the terminal. In
addition, allows the contents of storage to be displayed at the terminal and
modified.

SYNTAX:

DEBUG Command
──DEBUG──┬─ADD epname,eploc─┬────────────────────────────────────────
├─ANY──────────────┤
├─Cx──┤ Cx ├───────┤
├─Dx──┤ Dx ├───────┤
├─DELete──epname───┤
├─LAST─────────────┤
├─NAME─────────────┤
├─NEW──exitname────┤
├─NOSDUMP──────────┤
├─NOSUBTST─────────┤
├─ONLY─────────────┤
├─SDUMP────────────┤
├─SIZE─────────────┤
├─SPACE────────────┤
├─SPIE─────────────┤
└─SUBTEST──────────┘
Cx:
├──┬──────────┬──┬─=hexdig─────────────┬──┬─────────┬──,──string────────┤
└─nodename─┘ ├─epname─┬─────────┬──┤ └─,length─┘
│ └─+/-disp─┘ │
└──┬─────────┬───────┘
└─+/-disp─┘
Dx:
├──┬──────────┬──┬─=hexdig─────────────┬──┬─────────┬──┬───────┬────────┤
└─nodename─┘ ├─epname─┬─────────┬──┤ └─,length─┘ └─,type─┘
│ └─+/-disp─┘ │
└──┬─────────┬───────┘
└─+/-disp─┘

ADD adds an entry point name to the user-defined lookup table. (A


maximum of eight entry points may be added.) A name in
the user-defined table overrides and replaces an identical
name in the Advantage CA-Roscoe (pre-set) lookup table.
epname is the one- to eight-character name to be
assigned to the entry point address.
eploc is the two- to six-digit hexadecimal address of
the entry point.
ANY removes the restriction that the change operand (Cx) can
modify on the Advantage CA-Roscoe region.
C changes the contents of storage.

2-16 System Commands Guide


2.5 DEBUG

x defines the manner in which the epname or * is to be


interpreted when calculating the address of the storage
area to be modified. Specify either:
A causes the displacement to be added to the entry
point name to give the effective address of the
storage area to be modified.
L defines the entry point name as the address of a
fullword-aligned address constant containing
another address which is to be incremented by the
displacement given with the epname or * to give
the effective address of the storage area to be
modified.
nodename
is the nodename of the terminal whose control blocks are
to be changed if the epname is specified as ATT1, ATT2,
PCB, RCSNCB, RCSRB or SCB.
=hexdig
is the absolute address of the area of memory to be
modified, given as a one- to six-digit hexadecimal string.
Note: The change operands must be CA. No
displacement field can be given.
The address is always assumed to lie within the
Advantage CA-Roscoe address space.
epname
is the entry point name in either the Advantage
CA-Roscoe default table or the user-defined table.
The entry point names in the Advantage CA-Roscoe
| table are Advantage CA-Roscoe load module names and
| aliases, and identified entry points.
* reuses the effective address most recently calculated for
a C or D operand. (The effective address is always saved
between DEBUG commands.)
disp is the one- to six-digit hexadecimal displacement,
modifying the entry point name or effective address. It is
connected by a plus sign (+) indicating a positive
displacement or a minus sign (-) indicating a negative
displacement.
length
is a numeric value or an asterisk.
If a value is specified, it represents the number of bytes
of storage to be modified. If the data is in hex format,
specify a value between one and 80. If the data is in
character format, specify a value between one and 256. If

Chapter 2. System Commands 2-17


2.5 DEBUG

the data is in fullword or halfword format, the length


operand is ignored.
If an asterisk is coded, the number of bytes of storage to
be modified is the number of storage bytes processed by
the most most recently executed Cx or Dx operand.
If length is omitted, the number of bytes of storage to be
modified is the number of bytes needed to contain the
new data represented by string.
string
is the data to be placed in the specified area of storage.
It can be coded as either a string of characters enclosed
in apostrophes and preceded by a C (for example,
C'DATA') or a string of hexadecimal digits enclosed in
apostrophes and preceded by an X (for example,
X'C4C1E3C1'). If length is included, it must be exactly
equal to the number of bytes needed to contain the
specified string.
Note: An attempt to change storage outside the Advantage
CA-Roscoe region is rejected unless the ANY operand
has been previously specified.
D displays the contents of storage.
x defines the manner in which the epname or * is to be
interpreted when calculating the address of the storage
area to be displayed. Specify either:
A causes the displacement to be added to the entry
point name to give the effective address of the
storage area to be displayed.
L defines the entry point as the address of a
fullword-aligned address constant containing
another address, which is to be incremented by the
displacement given in the epname or * to give the
effective address of the storage area to be modified.
nodename
is the nodename of the terminal whose control blocks are
to be displayed if the epname is specified as: ATT1,
ATT2, PCB, RCSNCB, RCSRB or SCB.
=hexdig
is the absolute address of the area of memory to be
displayed, given as a one- to six-digit hexadecimal
string.
Note: The display operand must be DA. No
displacement field can be given.

2-18 System Commands Guide


2.5 DEBUG

The address is always assumed to lie within the


Advantage CA-Roscoe address space.
epname
is the entry point name in either the Advantage
CA-Roscoe default or user-defined table. The entry
point names in the Advantage CA-Roscoe table are
| Advantage CA-Roscoe load module names and aliases,
| and identified entry points.
* reuses the effective address most recently calculated for
a Cx or Dx operand. (The effective address is always
saved between DEBUG commands.)
disp is the one- to six-digit hexadecimal displacement
modifying the entry point name or effective address. It is
connected by a plus sign (+) indicating a positive
displacement or a minus sign (-) indicating a negative
displacement.
length
is a numeric value or an asterisk.
If a value is specified, it represents the number of bytes
of storage to be displayed. If the data is in hex format,
specify a value between one and 80. If the data is in
character format, specify a value between one and 256. If
the data is in fullword or halfword format, the length
operand is ignored.
If an asterisk is coded, the number of bytes of storage to
be displayed is the number of storage bytes processed by
the most recently executed Cx or Dx operand.
If length is omitted, the number of bytes of storage to be
displayed is the number of bytes needed to contain the
new data represented by string.
type is a one-character code representing the format to be
used when the data is displayed. If omitted, default is
hexadecimal. If specified, it must be one of the following:
C display in character format.
F display as a four-byte decimal number.
H display as a two-byte decimal number.
X display in hexadecimal format.
DELETE deletes an entry point name from the user-defined lookup
table.
epname
is the one- to eight-character name to be deleted.
LAST displays the effective address and effective length calculated
by the most recently executed Cx or Dx operand.

Chapter 2. System Commands 2-19


2.5 DEBUG

NAME displays all names in the user-defined lookup table.


| NEW causes the specified exit to be reloaded.
| exitname name of the exit routine.
| Caution
| This keyword is only to be used in a TEST environment.
| Advantage CA-Roscoe should be initialized as a test
| system, using the TEST initialization parameter.
| Extreme caution must be used when this keyword is
| specified. Users should not be using the exit at the time
| DEBUG NEW is issued. Unpredictable results can occur.

NOSDUMP sets a flag so that if Advantage CA-Roscoe should abend, no


attempt is to be made to direct the dump to a SYS1.DUMPxx
data set.
Use this operand to override the SDUMP operand.
NOSUBTST deactivates the facility that causes jobs to be submitted to a
SYSOUT data set. (See the SUBTST operand.)
ONLY restricts the scope of the Cx operand to the Advantage
CA-Roscoe region only. This is the preset default.
SDUMP sets a flag so that if Advantage CA-Roscoe should abend, an
attempt is to be made to direct the dump to a SYS1.DUMPxx
data set.
Use this operand to override the NOSDUMP operand and/or
the Advantage CA-Roscoe initialization parameter
NOSDUMP.
SIZE At MVSESA and MVS/XA sites: Displays the requested region
size for the Advantage CA-Roscoe job, the low and high
bounds of the private area and the largest block currently
available, in the form:
size low TO high AVAILABLE block
At non-XA sites: Displays the size and storage boundaries of
the private area and the size of the longest contiguous block
of storage available.
SPACE synonym for SIZE.
SPIE deactivates Advantage CA-Roscoe's SPIE exit. (If an abend
should occur, no attempt is made to process it as a 998
abend.)
SUBTST causes jobs to be submitted to a SYSOUT data set; not to the
internal reader. (The SYSOUT class is the class specified with
the MSGCLASS= initialization parameter.)

2-20 System Commands Guide


2.5 DEBUG

Note: This facility is in effect only for the person who issues
the command (the individuals assigned operator
privleges); if the person has a split screen, it is only in
effect for that screen. It remains in effect until DEBUG
NOSPIE is issued or the session ends.

NOTES: Additional information about using this command:


■ Use of this command is restricted to the individuals assigned operator
privileges.
■ The DEBUG command is a Advantage CA-Roscoe system development
tool and, therefore, is normally used only by a systems programmer who
has made own-code modifications to Advantage CA-Roscoe that must be
debugged.

Chapter 2. System Commands 2-21


2.6 DMS

2.6 DMS
FUNCTION: Displays information about the current use of storage by:
1. AWSs,
2. The Data Set Facility,
3. The Library Facility, and/or
4. RPF program execution.

SYNTAX:

DMS Command
──DMS──┬───┬──┬─────────┬─────────────────────────────────────
└─A─┘ ├─AWS─────┤
├─DSF─────┤
├─KEY=key─┤
└─LIB─────┘

With no operand, displays all available storage information about all users
currently signed on.
A writes the information to the active AWS. If omitted, the
information is written to the terminal.
AWS displays information about all individuals using an AWS.
DSF displays information about all individuals using the Data Set
Facility.
KEY=key is the sign-on key of the user for whom all available storage
information is desired.
LIB displays information about all individuals using the Library
Facility.

NOTES: Additional information about using this command:


■ DMS (Data Manager Statistics) is a Monitor command. As distributed, the
use of this command is not restricted.
■ DMS Display:
As illustrated in the following sample screen, entering DMS with no
operand or with KEY= provides all available storage information.

2-22 System Commands Guide


2.6 DMS

x 

>
> 1 2 3
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
BLKSZ-496 #PERVAR-32 LOOPCNT- 3276
========================================================================

9 1 11 12 13 14 15 16 17 18 19
AREA L# B# #GETS MEM #CMPS DEAD USED FIRSTPGM PROGNAME S
===== == === ===== ===== ===== ===== ==== ============ ============ =

4 5 6 7 8


PFX- ABC KEY- JONES UID- K6L37Z4 TYP- 327 RDM- 1
========================================================================
PERM1  1-1 2 248  124 198 PX.MYSIGN PX.MYSIGN L
LEVEL  1-1 2 496   661 PX.MYSIGN PX.MYSIGN L
LIB1 INACTIVE AM-24= (K) AM-31= 114 (2K)
2 21 22 23
...
DSF TOTALS: 24 AM-24= (K) AM-31= 516 (5K)
LIB TOTALS: 25 AM-24= (K) AM-31= 26592 (26K)
AWS TOTALS: 26 AM-24= (K) AM-31= 9984 (1K)
 
1 BLKSZ: Size of an internal work area used by the RDM. (The block
size is set by the RDMBLOCK= initialization parameter.)
2 #PERMVAR: Number of permanent variables that can be used by an
RPF program. (This value is set by the PERMVARS= initialization
parameter.)
3 LOOPCNT: Number of RPF statements that can be executed without
any intervening read or write operation. (This value is set by the
LOOPDFLT= initialization parameter.)
The preceding three fields contain information about RPF program
executions. The next five fields identify each user.
4 PFX-: Prefix of the user.
5 KEY-: Sign-on key of the user.
6 UID-: Terminal identification.
7 TYP-: Terminal type.
8 RDM-: Constant value, equal to one.
The following fields contain RPF information about each user.
9 AREA: Area being reported on, identified as PERM1 or LEVEL.
1 L#: Current execution level (number of EXECs that have been issued).
11 B#: Two numeric values separated by a hyphen, where the first value
is the number of GETMAINed blocks the RPF is using per area and
the second value is the total number of GETMAINed blocks
outstanding per user for each area. (The second number is one
greater than the first if the previous RPF or level required more
blocks than the current RPF or level.)

Chapter 2. System Commands 2-23


2.6 DMS

12 #GETS: Total number of GETMAINed blocks obtained for the user so
far this session.
13 MEM: Total amount of storage outstanding.
14 #CMPS: Number of RDM compressions that have occurred for the
user so far this session.
15 DEAD: Number of unusable bytes in the RDM.
16 USED: Number of bytes used in the last GETMAINed block.
17 FIRSTPGM: Prefix and name of the initiating program (the program
name entered by the user).
18 PROGNAME: Prefix and name of the last or currently executing
program.
19 S: A code indicating the current status of the PCB, where:
A RPF is currently executing.
P RPF is currently paused.
L No RPF is executing. (FIRSTPGM and PROGNAME show the
name of the last executing RPF.)
S RPF is suspended.
N No RPF has been executed so far this session. (FIRSTPGM and
PROGNAME show 'N/A'.)
Note: If an individual is using split screens when DMS is executed,
two sets of RPF statistics are provided, one for each PCB. The
display thus includes some information from the PCBs. The
majority, however, is from the RDM (ROSCOE Data
Manager).
This information is followed by:
2 The presentation area being reported on.
If the area represents a full screen or the upper half of a full screen, it
is identified as: AWS1, DSF1 or LIB1.
If the area represents a full screen or the lower half of a full screen, it
is identified as: AWS2, DSF2 or LIB2.
21 The user's current status, shown as:
ACTIVE AWS, Data Set Facility or Library Facility is being
used and is displayed.
SUSPENDED Data Set or Library Facility is being used but is not
displayed. D and/or L PENDING is probably
displayed at the terminal.
INACTIVE Data Set or Library Facility is terminated.

2-24 System Commands Guide


2.6 DMS

22 (AMODE 24) The size of an internal work area (in bytes and rounded
up to the nearest K) being used. At MVSESA and MVS/XA sites, this
area is below the 16MB line.
23 (AMODE 31) The size of an internal work area (in bytes and rounded
to the nearest K) being used above the 16MB line. (This field is
applicable at MVSESA and MVS/XA sites only.)
24 Total amount of storage used by the Data Set Facility work areas (in
bytes and rounded up to the nearest K) being used.
25 Total amount of storage used by the Library Facility work areas (in
bytes and rounded up to the nearest K) being used.
26 Total amount of storage used by the AWS work (in bytes and
rounded up to nearest K) being used.
■ When DMS DSF is issued and the status is ACTIVE, the display includes:
the display includes:
DSN= Name of the data set to which Advantage CA-Roscoe has
an enqueue.
VOLUME= Serial number of the volume on which the data set
resides. If the data set resides on multiple volumes, only
the serial number of the first volume is displayed.

Chapter 2. System Commands 2-25


2.7 ETSO-Related Commands

2.7 ETSO-Related Commands


SUMMARY: Commands that are restricted to the use of the individuals
assigned ETSO privileges and the console operator:
CANCEL Terminates an ETSO application that is currently
executing.
FREE Releases one or more files allocated by any user.
QUERY ALLOCATE Displays status information about allocated files for a
specific user.
QUERY CALL Displays status information about currently executing
applications.

Commands that may be issued by all Advantage CA-Roscoe users are


described in the Advantage CA-Roscoe Interactive Environment Command Reference
Guide and include:
ALLOCATE Allocates the terminal, AWS, a Advantage CA-Roscoe library
member or an external data set as an input/output file that is
to be accessible to an application.
CALL Initiates execution of an application.
FREE Releases previously allocated files.
SET ESCAPE Designates an escape sequence that can be used to signal an
end-of-input or to terminate the application.

2.7.1 CANCEL
FUNCTION: Terminates execution of an ETSO application belonging to the
designated user.

SYNTAX

|
| CANCEL Command
| ──CANCEL──┬─KEY=signonkey─┬─────────────────┬──┬──────────────
| │ └────/screenid────┘ │
| └─ETSO───────────────────────────────┘

KEY=key is the sign-on key of the user whose application is to be


terminated. The key may be qualified with:
screenid is the number of the presentation area in which the application is
currently executing. If omitted, the default is 1.
ETSO causes the currently suspended ETSO application to be
terminated.

2-26 System Commands Guide


2.7 ETSO-Related Commands

NOTES: Additional information about using this command:


■ Using 'screenid':
Use the screenid operand when the designated user is executing an ETSO
application while in split-screen mode. Use the QUERY CALL KEY=
command to obtain the screenid.
■ Using ETSO:
The ETSO operand only cancels suspended applications associated with
the individual issuing the command. To cancel another user's executing
application, that user's sign-on key must be specified.

2.7.2 FREE
FUNCTION: Deallocates one or more files previously allocated for use by an
application executing under ETSO.

SYNTAX

|
| FREE Command
| ──FREE──┬─ALL──────────────────┬──┬────────────────────────┬──
| │ ┌──
──────────┐ │ └─KEY=key─┬───────────┬──┘
| ┬────────┬┴─┘
└─ddname─── └─/screenid─┘
| └─ddname─┘

ALL releases all files allocated by the user signed on.


ddname is the DD name of the file to be deallocated. A maximum of ten
files can be deallocated.
KEY=key is the sign-on key of the user whose files are to be deallocated.
The key may be qualified with:
screenid is the number of the presentation area in which the file is
allocated. If omitted, the default is 1.

NOTES: Additional information about using this command:


■ Using ALL or 'ddname':
Deallocating a file by the keyword ALL or by DD name releases the file(s)
allocated by the user signed on. To release a file allocated by another user,
use the KEY= operand.
If a program that uses the designated file(s) is currently executing, the
file(s) cannot be deallocated.
■ Using 'screenid':
Use the screenid operand when the designated user is in split-screen
mode. Use the QUERY CALL KEY= command to obtain the screen id.

Chapter 2. System Commands 2-27


2.7 ETSO-Related Commands

2.7.3 QUERY ALLOCATE


FUNCTION: Displays status information about the files allocated for use by an
application executing under ETSO.

SYNTAX

|
| QUERY ALLOCATE Command
| ──Query ALLOCate──┬───────────────────────────────────┬────────
| ├─ALL───────────────────────────────┤
| ├─DSN=dsname────────────────────────┤
| ├─KEY=key─┬───────────┬──┬───────┬──┤
| │ └─/screenid─┘ └─SPLIT─┘ │
| └─SPLIT─────────────────────────────┘
──┬─────┬──────────────────────────────────────────────────────
└─AWS─┘

With no operand, displays any allocations for the issuing user.


ALL displays information pertaining to all files allocated by all
terminal users.
DSN=dsname is the data set name of the file for which allocation
information is desired.
KEY=key is the sign-on key of the user for whom allocation information
is desired. Qualify with:
screenid is the number of the presentation area about which
information is desired. If omitted, the default is 1.
AWS writes information to the active AWS. If omitted, the
information is written to the terminal.
| SPLIT causes information from both sessions (PCBs) to be displayed
| (SPLIT is not valid with the ALL or DSN operands).

NOTES: Additional information about using this command:


■ Using 'screenid':
Use the screenid operand when the designated user is in split-screen
mode. Use the QUERY CALL KEY= command to obtain the screen ID.
■ QUERY ALLOCATE Display
The following screen illustrates the information provided when QUERY
ALLOCATE is entered with no operands.

2-28 System Commands Guide


2.7 ETSO-Related Commands

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
DDNAME TYPE DISP MEMBER DATA-SET NAME
------ ---- ---- ------ -------------
SYSIN AWS ROS1
1 2 3 4 5

1 DDNAME: DD name of the file.


2 TYPE: File allocation, shown as:
– * (terminal),
– AWS,
– DATASET (sequential),
– GDG (generation data group),
– LIBRARY (Advantage CA-Roscoe member),
– PDS (PDS member or AllFusion CA-Librarian module),
– RPS, or
– SYSOUT.
3 DISP: Disposition of the file (shown only if TYPE contains
DATASET, GDG, or PDS).
4 MEMBER: Name of the allocated AWS, Advantage CA-Roscoe
library member or PDS member.
5 DATA-SET NAME:
– Name of allocated data set (shown only if TYPE contains
DATASET, GDG or PDS),
– Class and destination (if TYPE contains RPS), or
– Class, destination and form (if TYPE contains SYSOUT).
■ QUERY ALLOCATE ALL and QUERY ALLOCATE DSN= Display
The following screen illustrates the information provided when the ALL
or DSN= operand is specified:

_ 
> APPLID(DROSBTZ) USER(RO,ROSCOE.CONTROL) L PENDING
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
DDNAME ROSCOE KEY # D DATA-SET NAME
------ ---------- - - -------------
SYSIN JONES 1 AWS
1 2 3 4 5

1 DDNAME: DD name of the file.


2 ROSCOE KEY: User's sign-on key.
3 #: Screen identification number (shown as 1 or 2).

Chapter 2. System Commands 2-29


2.7 ETSO-Related Commands

4 D: (Data set disposition) The disposition can be:


S shr
O old
N new
M mod
5 DATA-SET NAME:
– Name of allocated external data set,
– AWS,
– Library member name,
– RPS plus class and destination, or
– Class, program name and form.
■ QUERY ALLOCATE KEY= Display:
The following screen illustrates the information provided when the KEY=
operand is specified:

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
JONES 1 PCB NUMBER 1 2

DDNAME TYPE DISP MEMBER DATA-SET NAME


------ ---- ---- ------ -------------
SYSIN AWS ROS1

3 4 5 6 7

1 sign-on key: Sign-on key specified with the command.


2 PCB NUMBER: Screen identification number (shown as 1 or 2).
3 DDNAME: DD name of the file.
4 TYPE: File allocation, shown as:
– * (terminal),
– AWS,
– DATASET (sequential),
– GDG (generation data group),
– LIBRARY (Advantage CA-Roscoe library member),
– PDS (PDS member or AllFusion CA-Librarian module),
– RPS, or
– SYSOUT.
5 DISP: Disposition of the file (if TYPE contains DATASET, GDG or
PDS).
6 MEMBER: Name of allocated AWS, Advantage CA-Roscoe library
member or PDS member.

2-30 System Commands Guide


2.7 ETSO-Related Commands

7 DATA-SET NAME:


– Name of allocated data set (if TYPE contains DATASET, GDG or
PDS),
– Class and destination (if TYPE contains RPS), or
– Class, destination and form (if TYPE contains SYSOUT).

2.7.4 QUERY CALL


FUNCTION: Displays status information about currently executing ETSO
applications.

SYNTAX

|
| QUERY CALL Command
| ──QUERY CALL──┬─ALL────────────────────────────┬──┬─────┬─────
| ├─KEY=─┬───────────┬──┬───────┬──┤ └─AWS─┘
| │ └─/screenid─┘ └─SPLIT─┘ │
| └─SPLIT──────────────────────────┘

With no operand, displays information about executing applications associated


with the user signed on.
ALL displays information about all applications currently executing
under ETSO.
KEY=key is the sign-on key of the user for whom information is desired.
The key may be qualified with:
screenid is the number of the presentation area about which information is
desired. If omitted, the default is 1.
AWS writes information to the active AWS. If omitted, the information
is written to the terminal.
| SPLIT causes information from both sessions (PCBs) to be displayed
| (SPLIT is not valid with the ALL operand).

NOTES: Additional information about using this command:


■ Using 'screenid':
Use the screenid operand when the designated user is in split-screen
mode. Use the QUERY CALL KEY= command to obtain the screen ID.

Chapter 2. System Commands 2-31


2.7 ETSO-Related Commands

■ QUERY CALL Display:

The following screen illustrates the information provided by QUERY CALL:

 
> APPLID(ROSCOE1) USER(PFX,USERID)
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
ROSCOE KEY PCB# PROGRAM START CPU GETMAIN PROGRAM TYPE
---------- ---- ------- ----- --- ------- ------------
USERID 1 ISPF 15.6.3 1 1344 PROBLEM PROGRAM
AM31=51496
1 2 3 4 7
5 6

1 ROSCOE KEY: User sign-on key.


2 PCB#: Number of the presentation area in which the application is
executing.
3 PROGRAM: Name of the executing application(s).
4 START: Time application execution started.
5 CPU: Number of CPU time slices used.
6 GETMAIN: Amount of memory used. Also included below is the
amount of AM31 memory used, if any.
7 PROGRAM TYPE: Type of program executing.

2-32 System Commands Guide


2.8 LIBCACHE

2.8 LIBCACHE
FUNCTION: Controls and monitors the Library Cache Facility.

SYNTAX

LIBCACHE Command
──LIBCACHE──┬─ON────┬─────────────────────────────────────────
├─STATS─┤
├─PURGE─┤
└─OFF───┘

ON enables the cache facility.


STATS displays information about the cache facility.
PURGE
purges the cache of all data.
OFF deactivates the cache facility.

NOTES: Additional information about using this command:


■ Except for LIBCACHE STATS, the use of this command is restricted to the
individuals assigned operator privileges.
■ LIBCACHE STATS Display:

Chapter 2. System Commands 2-33


2.8 LIBCACHE

The following screen illustrates the information provided by the LIBCACHE


STATS command.

_ 

>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
ROSCOE LIBRARY SYSTEM - CACHE STATISTICS

THE CACHE IS ACTIVE

ACHE READS 29,438 1


ACHE READ HITS 28,213 95% 2

ACHE UPDATES 1,241 3


ACHE PURGES 54 4

TORAGE USED 1,47,4 5


TORAGE FREE  6

NDEX CACHE READS 11,923 7


NDEX CACHE HITS 11,86 99% 8
NDEX READ RETRIES 16 9
 
1 CACHE READS: Number of times a read was requested.
2 CACHE READ HITS: Number and percentage of times the read request
was satisfied.
3 CACHE UPDATES: Number of times a block is stored in the cache (the
data was not present in the cache) and the cache was read.
4 CACHE PURGES: Number of times blocks in the cache were deleted
because the corresponding members were updated/deleted.
5 STORAGE USED: Amount of acquired storage that is currently in use.
6 STORAGE FREE: Amount of acquired storage that remains available for
use.
7 INDEX CACHE READS: Number of times a read was requested of the
master index blocks.
8 INDEX CACHE HITS: Number and percentage of times the read request
was satisfied.
9 INDEX READ RETRIES: Number of times a 'real' read was done
because of an inconsistency encountered when reading from the cache.

2-34 System Commands Guide


2.9 LOOK

2.9 LOOK
FUNCTION: Introduction to a Unicenter CA-Look facility.

Sites that have Unicenter CA-Look can obtain performance information about
the current execution of Advantage CA-Roscoe using the D ROSCOE
command.

The major components of the LOOK D ROSCOE command introduced below.

SYNTAX

LOOK Command
──LOOK──D ROSCOE──┬───────────┬───────────────────────────────
├─,ACTIVE───┤
├─,AWS──────┤
├─,IO───────┤
├─,LIBRARY──┤
├─,MONITORS─┤
├─,RELEASE──┤
├─,RESPONSE─┤
├─,STATUS───┤
└─,SYSTEM───┘

ACTIVE samples the activity and types of waits for one or more users
and displays: 1) the percentage of time an individual was using
and waiting for the CPU; 2) AWS, library and terminal I/O
wait information; and 3) statistics on subtask, MPL, enqueue
and other waits.
The information can be about all users, the last user dispatched,
a specific user, the user at a specific terminal, the user with a
specific SCB address or the user with a specific PCB address.
AWS displays the AWS configuration, the current status of each data
set comprising the AWS, and page load activity.
IO provides summary and file-specific information about I/O
activity. The summary information shows the number of EXCPs
during the sampling period and I/O waits for specific types of
files.
The file-specific information includes the DD name, EXCPs, the
percentage of time the data was found to be busy during the
sampling period, the average arm movement in cylinders
during the sampling period, the volume serial number on
which the data set resides and the data set name. (The
information can be limited to a specific data set, the AWS,
library and/or dynamically allocated data sets.)

Chapter 2. System Commands 2-35


2.9 LOOK

LIBRARY displays information on the library space and buffer usage


during the execution of Advantage CA-Roscoe. Also shows the
data sets that are currently enqueued, by whom and the type of
enqueue (by operating system and by job step).
MONITORS displays information about the current status of all Monitor
routines defined for the current execution of Advantage
CA-Roscoe. The information can be qualified to show only
disabled Monitor routines and/or those that are defined in the
RUN initialization parameter with the V attribute.
RELEASE supplies site-specific information about Advantage CA-Roscoe.
The information includes: 1) the release and version of the
currently executing Advantage CA-Roscoe, 2) the number of
the zaps and warning notices that have been applied, and 3)
the values of such initialization parameters as LIBXLIB, MPL,
TERMSO, RDMBLOCK, LOOP and ARRAYMAX.
RESPONSE collects and reports terminal user response times. The
information includes the maximum and average response times
for the current interval, last interval and since startup. The
values used in calculating the complexity of each user's
transactions are also available.
STATUS provides a snapshot of the activity of all or specific users at the
time the command is entered. The snapshot information
includes the sign-on keys of the active users, each user's status,
the time spent in the indicated status, the cumulative number
of terminal and disk I/Os, the PCB address(es), and the name
and nesting level of the most current RPF, Monitor routine, or
CALLed ETSO program being executed for each PCB.
SYSTEM provides information that is global to the current execution of
Advantage CA-Roscoe or unique to a specific component. The
information provided can be used to determine whether the
values specified with the LIBXLIB, MPL and TERMSO
initialization parameters are appropriate.

NOTES: Additional information about using this command:


■ If Unicenter CA-Look is installed at your site, refer to the:
– Advantage CA-Roscoe Interactive Environment System Reference Guide for
information on accessing Unicenter CA-Look and using the D ROSCOE
command during a Advantage CA-Roscoe session.
– Unicenter CA-Look RTM Command Reference for additional information
about using Unicenter CA-Look and the D ROSCOE command.

2-36 System Commands Guide


2.10 MONITOR

2.10 MONITOR
FUNCTION: Displays status information about one or all of the Monitor
routines that are defined for the current execution of Advantage CA-Roscoe.

SYNTAX

MONITOR Command
──MONitor──┬────┬──┬─────┬────────────────────────────────────
└─-A─┘ └─cmd─┘

-A directs the status information to the active AWS. If omitted, the


information is displayed at the terminal.
cmd are the first three characters of the name of the Monitor routine about
which information is desired. If omitted, information about all Monitor
routines is provided.

NOTES: Additional information about using this command:


■ MONITOR is a Monitor command. As distributed, the use of this
command is not restricted.
■ MONITOR Display:
The following screen illustrates the information displayed by the
MONITOR command.

x 

>
> MORE...
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
1 2 3 4 5 6 7 8 9 1
CURRENT TOTAL
NAME USERS USERS STATUS EPA RELOADS LOCKS UNLOCKS SPIE FOLD
---- ------- ----- ---------------- -------- ------- ----- ------- ---- ----
ALK  1 ACTIVE VPE    NO YES
AMS   ACTIVE 2561A8    NO YES
AWS  5 ACTIVE 2A5FD8    NO YES
COB   ACTIVE 2ABA8    NO YES
CON  29 ACTIVE 2B3E2    YES YES
DIS  234 ACTIVE 2B67B    YES YES
DMS  3 ACTIVE 2B8DE8    NO YES
EXP  16 ACTIVE 2BC34    NO YES
IMP  21 ACTIVE 2C4AA8    YES YES
JCK   ACTIVE F15    YES NO
LOO  18 ACTIVE 2D8B98    NO YES
MON 1 2 ACTIVE 1F4B    NO YES
OPE   ACTIVE 2AB388    NO YES
 

Chapter 2. System Commands 2-37


2.10 MONITOR

1 NAME: Names of Monitor routines defined for use during the
current execution.
2 CURRENT USERS: Number of individuals who are currently using
the individual Monitor routines.
3 TOTAL USERS: Total number of individuals who have used the
Monitor routine during this execution of Advantage CA-Roscoe.
4 STATUS: Current status of the Monitor routine, shown as ACTIVE
or LOCKED. If the status is LOCKED, one of the following reason
codes is included:
ABEND An S0Cx abend has occurred.
BLDL A BLDL failure occurred.
ERROR An internal error has occurred.
GBLINIT A failure occurred during the initialization of CONSOLE
or DISPLAY (GBLINIT failure).
NOTEXEC The Linkage-Editor has marked the Monitor
nonexecutable.
ROSX A failure occurred during extended initialization
(ROSXINIT failure).
ROZAP Locked by the ROZAP LOCK command
VPEINIT A failure occurred during initialization or a Monitor
that has a V attribute.
5 EPA: Entry point address, or
VPE (if the Monitor is defined with the V attribute), or
N/A (if the Monitor is defined but not found).
6 RELOADS: Number of ROZAP RELOADs that have been issued for
the Monitor during this execution.
7 LOCKS: Number of times the Monitor has been locked during this
execution. (A Monitor may be locked due to: 1) the ROZAP LOCK
command, 2) an internal error, or 3) an 0Cx abend.)
8 UNLOCKS: Number of times the Monitor has been unlocked using
the ROZAP UNLOCK command.
9 SPIE: Indication of whether the Monitor has a pseudo-SPIE exit.
1 FOLD: Indication of whether terminal user's input is to be translated
to uppercase characters or left as entered.

2-38 System Commands Guide


2.11 Operator Commands

2.11 Operator Commands


SUMMARY: Operator commands may be used to:
1. Control the execution of Advantage CA-Roscoe,
2. Start and stop BTAM lines, and
3. Control Advantage CA-Roscoe/VTAM communications.

Table 2-1 (Page 1 of 2). Advantage CA-Roscoe Operator Commands


Functions Command
BTAM-Specific:
Print Line Error Recording Block OPERATOR LERPRT
Restart Lines OPERATOR RESTART LINE = ...
OPERATOR RESTART [ UNIT ]=...
Stop Lines OPERATOR STOP LINE= ...
Control Response-Time Monitoring OPERATOR RTM operands
Display:
Accounting Status OPERATOR ACCT ...
Spool Status OPERATOR SPOOL [FREE ddname]
Line/Terminal OPERATOR STATUS
OPERATOR STATUSX [ id ]
Enable/Disable:
Commands OPERATOR ENABLE
OPERATOR DISABLE
Sign-ons OPERATOR SIGNON
OPERATOR NOSIGNON
Batch Submissions OPERATOR SUBMIT
OPERATOR NOSUBMIT
Sign-on, Sign-off & Submit Messages OPERATOR ROSLOG
OPERATOR NOROSLOG
User to Operator Messages OPERATOR MESSAGE
OPERATOR NOM
Send Messages to Users: OPERATOR SEND
OPERATOR SEND ALL msg
OPERATOR NOSEND
OPERATOR SEND {KEY=/PFX=}
Terminate:
Sign User Off OPERATOR OFF
Force User Off OPERATOR FLUSH ...
Shut Down Advantage CA-Roscoe OPERATOR SHUTDOWN ...
VTAM-Specific:

Chapter 2. System Commands 2-39


2.11 Operator Commands

Table 2-1 (Page 2 of 2). Advantage CA-Roscoe Operator Commands


Functions Command
Communications -
Start OPERATOR VTAM START
Stop OPERATOR VTAM STOP
OPERATOR VTAM STOP FORCE
OPERATOR VTAM STOP QUICK
Display Intervals OPERATOR INTERVAL
Display Status OPERATOR NETSTAT
Change Interval OPERATOR VTAM FORCINT n
OPERATOR VTAM OPENINT n
OPERATOR VTAM STOPINT n
OPERATOR VTAM WARNINT n

NOTES: Additional information about using these commands:


■ Issuing the Commands:
The commands described in this section may be issued by the console
operator or users having operator privileges.
If Advantage CA-Roscoe is not ready to process the command, it is
rejected. It may be reentered a few minutes later.
■ Issued By the Console Operator:
If the site has included the COMCHAR initialization parameter in the
Advantage CA-Roscoe JCL, the operator can issue commands in the form:

──c─┬───────┬───oprcmd────────────────────────────────────
└─rosid─┘

where:
c is the special character defined by the COMCHAR= parameter.
rosid is the unique identifier assigned to each Advantage CA-Roscoe
running at the site. It may be omitted if each Advantage
CA-Roscoe has its own unique communications character (defined
by COMCHAR). It is required if multiple Advantage CA-Roscoes
are using the same communications character.

2-40 System Commands Guide


2.11 Operator Commands

oprcmd is the Advantage CA-Roscoe operator command to be executed.


Whether or not the site is using the facility provided by COMCHAR, the
operator can communicate with Advantage CA-Roscoe using the operating
system MODIFY command, in the form:

──F──jobname,oprcmd───────────────────────────────────────

where jobname is the name of the Advantage CA-Roscoe job and oprcmd
is one of the commands described in this section.
Note: The operating system STOP command (P jobname) is comparable
to:

──/SHUTDOWN NOW────────────────────────────────────

or

──F──jobname,SHUTDOWN NOW──────────────────────────

■ Issued by users with operator privileges:


Users having operator privileges may communicate with Advantage
CA-Roscoe using the OPERATOR command, in the form:

──OPERATOR──oprcmd────────────────────────────────────────

where oprcmd is one of the commands described in this section.


(OPERATOR may be abbreviated as OPR.)

Chapter 2. System Commands 2-41


2.11 Operator Commands

2.11.1 ACCT
FUNCTION: Activates the accounting facility, switches accounting files and
displays accounting status information.

SYNTAX

ACCT Operator Command


──┬─────┬──ACCT──┬───────────┬────────────────────────────────
└─OPR─┘ ├─BUFfers───┤
├─FILes─────┤
├─ROSCOE ON─┤
├─SMF ON────┤
├─STAtus────┤
└─SWITCH────┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must


be used when this command is issued by individuals assigned
OPERATOR privileges. It must not be used by the console
operator.
BUFfers displays information about the status of the accounting
buffers.
FILes displays status information about the accounting files.
ROSCOE ON activates the accounting facility.
SMF ON activates the SMF accounting facility.
STAtus displays the current status of the accounting subsystem.
SWITCH causes the accounting facility to switch to the next ROSACTnn
file.

NOTES: Additional information about using this command:


■ Using ROSCOE ON:
OPR ACCT ROSCOE ON causes Advantage CA-Roscoe to attempt to
activate the accounting facility using the values specified with the
ACCTBUF initialization parameter. If initialization is successful, a message
is displayed showing the number of buffers and their sizes.
If the accounting facility cannot be activated, the following message is
displayed:
NO FILES AVAILABLE TO START ACCOUNTING
If all of the files are full, the ACCTDUMP program must be executed to
clear the files. The OPR ACCT ROSCOE ON command can then be
reissued.

2-42 System Commands Guide


2.11 Operator Commands

If the Advantage CA-Roscoe accounting DD statements contain an error or


are missing, the following message is displayed.
ROSCOE OPTION PERMANENTLY DISABLED
■ Using SMF ON:
OPR ACCT SMF ON causes Advantage CA-Roscoe accounting records to
be written to SMF files. This command may only be issued if the
Advantage CA-Roscoe JCL contains the initialization parameter
ACCTSMF=INACT.
■ Using SWITCH:
OPR ACCT SWITCH is honored only if the next sequentially numbered
ROSACTnn file is empty. If the operation is successful, a message is
displayed identifying the file to which Advantage CA-Roscoe has
switched.
■ ACCT Displays:
See the description of the ACCT command for an explanation of the
displays.

|2.11.2 DISABLE/ENABLE
| FUNCTION: Disables or enables the use of a Advantage CA-Roscoe command.

| SYNTAX:

|
| DISABLE/ENABLE Operator Command
| ──┬─────┬──┬─DISABLE─┬──command.──────────────────────────────
| └─OPR─┘ └─ENABLE──┘

| OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


| used when this command is issued by individuals assigned
| operator privileges. It must not be used by the console operator.
| command 1-to-8 character Advantage CA-Roscoe command.

| NOTES: Additional information about using this command:


| ■ Command abbreviations are not valid for this operand unless the
| abbreviation is not the first 1 or 3 characters of the command.

Chapter 2. System Commands 2-43


2.11 Operator Commands

2.11.3 FLUSH
FUNCTION: Flushes the designated user or logical unit.

SYNTAX

FLUSH Operator Command


──┬─────┬──FLUSH──┬─KEY=key───┬──┬────┬───────────────────────
└─OPR─┘ ├─ID=id.────┤ └─,F─┘
└─LU=luname─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned
operator privileges. It must not be used by the console operator.
KEY=key is the sign-on key of the user to be forced off.
ID=id is the internal logical line number of the user to be forced off.
LU=luname is the name of the logical unit for which a CLSDST is to be
issued.
F causes the designated user/unit to be forces off regardless of
what activity may be occurring.
If omitted, the user to be flushed is observed for ten seconds to
determine if there is any activity. If there is, FLUSH ignored. If
there is no activity, the FLUSH is attempted.

NOTES: Additional information about using this command:


■ The ROZAP command can also be used to flush users.
■ Use the OPERATOR STATUSX or the ROS command to obtain the internal
logical line number.
■ If a FLUSH command is entered that refers to a terminal for which a
VTAM I/O operation is in progress, Advantage CA-Roscoe attempts to
half the operation by means of an asynchronous reset. If the reset fails,
FLUSH cannot be performed.

2.11.4 INTERVAL
FUNCTION: Display information about the timing intervals that Advantage
CA-Roscoe uses when attempting to establishing or terminate communications
with VTAM.

SYNTAX

2-44 System Commands Guide


2.11 Operator Commands

INTERVAL Operator Command


──┬─────┬──INTERVAL───────────────────────────────────────────
└─OPR─┘

OPR
is the abbreviation of OPERATOR. OPR (or OPERATOR) must be used
when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ INTERVAL Display. Illustrates the information displayed by this
command.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
NCC13I: TOTL= CURR=1 OPEN=1 STOP=1 WARN=6 FORC=3

■ The timing intervals displayed by this command represent the current


settings used when:
– Forcing the network to a STOPPED status after the ACB is closed. This
interval can be changed by the command VTAM FORCINT.
– Attempting to establish communications with VTAM after the VTAM
START command is issued and the OPEN ACB fails. This interval can
be changed by the command VTAM OPENINT.
– Testing to determine if terminals and printers are still in session after
the HALF or VTAM STOP command is issued. This interval can be
changed by the command VTAM STOPINT
– Resending warning messages to the terminal after the HALF or VTAM
STOP command is issued. This interval can be changed by the
command VTAM WARNINT.

2.11.5 LERPRT
FUNCTION: Prints the active line error recording block. (BTAM 3270 remote
lines only.)

SYNTAX

LERPRT Operator Command


──┬─────┬──LERPRT───┬──────┬─=─┬─ALL─┬────────────────────────
└─OPR─┘ └─UNIT─┘ └─cuu─┘

Chapter 2. System Commands 2-45


2.11 Operator Commands

OPR
is the abbreviation of OPERATOR. OPR (or OPERATOR) must be used
when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
ALL prints the line error recording block for all lines.
cuu is the physical device address of the line for which the line error
recording block is to be printed.

NOTES: Additional information about using this command:


■ LERPRT is only valid when the line error recording option has been
included in the system. The message is numbered IEC802I and is a
standard system message.
■ If the Advantage CA-Roscoe error thresholds are reached for any remote
line, the contents of the line error recording block are printed automatically
as though the LERPRT command had been issued.

2.11.6 MESSAGES/NOM
FUNCTION: Enables or disables the users' ability to send messages to the
operator.

SYNTAX

MESSAGES Operator Command


──┬─────┬──┬─Messages─┬───────────────────────────────────────
└─OPR─┘ └─NOM──────┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ Abbreviations MESSAGES can be abbreviated as M or MSGS.
■ Using MESSAGES:
When MESSAGES is issued, users are permitted to send messages to the
operator using the Write-To-Operator (WTO) facility.
■ Using NOM:
When NOM is issued, users are prevented from sending messages to the
operator.
The operator may continue to send messages to all users by means of the
operator SEND command.
The individual assigned operator privileges can always send messages to
the operator.

2-46 System Commands Guide


2.11 Operator Commands

2.11.7 NETSTAT
FUNCTION: Displays Advantage CA-Roscoe/VTAM status information.

SYNTAX

NETSTAT Operator Command


──┬─────┬──NETSTAT────────────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ NETSTAT Display:
As illustrated in the following screen, NETSTAT displays information
about the status of the session between Advantage CA-Roscoe and VTAM.
It provides such information as the current applid, whether the network is
started or stopped, the status of the ACB (OPEN/CLOSED) and the
number of active VTAM terminal and printer sessions.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
NCC1I: TESTROS =STARTED ACB=OPENED
NCC11I: TERMSESS=1 PRNTSESS= FUNC=NONE STOP=NONE
NCC12I: FLAGS=  AFF FF 

This information is useful when you want to restart Advantage


CA-Roscoe/VTAM communications or are in the process of stopping
communications. It is also useful in determining the problem when users
cannot logon to VTAM terminals.

2.11.8 OFF
FUNCTION: Signs one or more active users off.

SYNTAX

OFF Operator Command


──┬─────┬──OFF──┬─ALL───┬──┬─────────┬────────────────────────
└─OPR─┘ └─ID=id─┘ └─message─┘

Chapter 2. System Commands 2-47


2.11 Operator Commands

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
ALL causes all active users to be signed off.
ID=id is the internal logical line number of the user to be signed off.
message
is a one- to 64-character message that is to be sent to the user(s)
immediately prior to their being signed off. If omitted, active users are
informed they are being signed off at operation request.

NOTES: Additional information about using this command:


■ Either form of OFF replaces any pending messages that were established in
OFF or SEND command.
■ OFF has no effect if a terminal is inactive (the user is not entering
commands or responding to terminal output). Use the FLUSH command
instead.
■ Use the OPERATOR STATUSX or ROS command to obtain the internal
logical line number.

2.11.9 REFRESH
FUNCTION: Updates the member UPS.KEYTABLE and rebuilds a
memory-resident key table.

SYNTAX

REFRESH Operator Command


──┬─────┬──REFRESH UPS────────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ Individuals assigned operator privileges may issue the ROZAP REFRESH
UPS command.

2-48 System Commands Guide


2.11 Operator Commands

2.11.10 RESTART
FUNCTION: Reinitializes I/O operations at a local 3270 device or TTY that
BTAM found to be inoperable but that Advantage CA-Roscoe has not marked
as such.

SYNTAX

RESTART Operator Command


──┬─────┬──RESTART───┬──────┬─=cuu────────────────────────────
└─OPR─┘ └─UNIT─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
cuu is the physical device address of the device to be reinitialized.

NOTES: Additional information about using this command:


■ Restart the device after the cause of this condition has been found and
remedied (terminal controller offline, and so forth).
■ Incorrect entry of the cuu is flagged by Advantage CA-Roscoe and no
action is taken.
■ If storage is not available, Advantage CA-Roscoe sends the operator a
message to that effect and no action is taken.
■ If the restart fails, Advantage CA-Roscoe again sends the initial error
message.
■ RETRY is a synonym for RESTART.

2.11.11 RESTART (Line)


FUNCTION: Restarts one or more remote 3720 BTAM lines or clusters that
have been stopped.

SYNTAX

RESTART (Line) Operator Command


──┬─────┬──RESTART LINE=──┬─ALL───────────┬───────────────────
└─OPR─┘ └─cuu─┬──────┬──┘
└─,cua─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

Chapter 2. System Commands 2-49


2.11 Operator Commands

ALL restarts all stopped remote lines.


cuu is the physical device address of the line to be restarted. When
restarting a cluster, qualify with:
cua is a two-digit number between 00 and 31, inclusive, which is the
hardware cua (control unit address) of the cluster to be restarted.

NOTES: Additional information about using this command:


■ This command restarts a remote line or cluster that has been stopped by a
user having a privileged userid, by the operator request (STOP command)
or due to repeated hardware errors.

2.11.12 ROSLOG/NOROSLOG
FUNCTION: Enables or disables Advantage CA-Roscoe messages written to
the console.

SYNTAX

ROSLOG/NOROSLOG Operator Commands


──┬─────┬──┬─Roslog───┬───────────────────────────────────────
└─OPR─┘ └─NORoslog─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ Using ROSLOG:
When ROSLOG is issued, sign-on, sign-off and submit messages are
displayed at the console.
■ Using NOROSLOG:
When NOROSLOG is issued, sign-on, sign-off and submit messages are
not displayed at the console.

2.11.13 RPS
FUNCTION: Stops and starts the RPS subtask.

SYNTAX

2-50 System Commands Guide


2.11 Operator Commands

RPS Operator Command


┌─WARM─┐
──┬─────┬──RPS──┬─RESTART─┬───────────────┬──┼──────┼──┬──────
└─OPR─┘ │ └─CSECT──string─┘ └─COLD─┘ │
│ ┌─WARM─┐ │
├─START─┬───────────────┬──┼──────┼────┤
│ └─CSECT──string─┘ └─COLD─┘ │
└─STOP─────────────────────────────────┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must


be used when this command is issued by individuals assigned
operator privileges. It must not be used by the console
operator.
CSECT string is the name of the CSECT to be loaded. If omitted, the last
definition is used (either the definition specified with the
RPSCSECT initialization parameter or with the last
start/restart operation. If specified with an invalid name, RPS
is disabled (no PRINT-related command are allowed until a
valid CSECT is loaded).
WARM causes outstanding requests to be kept on the RPS queue.
Note: If neither WARM nor COLD is specified, the default is
WARM.
COLD causes outstanding requests to be deleted. This includes all
previously queued requests and associated RPS library
members.

NOTES: Additional information about using this command:


■ Using RPS RESTART:
When RPS RESTART is issued, RPS subtask termination starts. When
STOP processing completes, START processing immediately begins. If a
user attempts to issue any of the PRINT-related commands while the
queues are being rebuilt, the command is rejected with a message stating
that RPS initialization is in progress
■ Using RPS START:
RPS START allows the RPS subtask to be restarted. The subtask is
reattached with either the CSECT specified by the RPSCSECT=
initialization parameter or the CSECT specified with the command.
After the CSECT is successfully loaded, the RPS queues are rebuilt and any
requests held by the issuance of the PRINT STOP RPS or OPERATOR RPS
STOP command are automatically placed on the ready queue for
immediate processing.
■ Using RPS STOP:

Chapter 2. System Commands 2-51


2.11 Operator Commands

RPS STOP allows the RPS subtask to be terminated. When issued, any
print requests currently printing are held and all printers owned by RPS
are closed. The subtask is detached and appropriate shutdown messages
are written to the console.
Users issuing the informational commands (for example, PRINT
LOCATION or PRINT STATUS) receive the appropriate information. Users
issuing the commands that need subtask processing receive a message
stating that RPS is disabled.

2.11.14 RTM
FUNCTION: Controls response-time monitoring.

SYNTAX

RTM Operator Command


──┬─────┬──RTM──┬─ON─┬─────┬─────────────────────────┬────────
└─OPR─┘ │ └─mem─┘ │
├─OFF────────────────────────────────┤
│ ┌──
───────┐ │
┬─────┬┴───┬───────┤
├─INCL─┬─KEY key──
│ │ └─key─┘ │ │
│ │ ┌──
───────┐ │ │
│ ┬─────┬┴───┤
├─PFX pfx── │
│ │ └─pfx─┘ │ │
│ │ ┌──
──────┐ │ │
│ ├─TERMID id── ┬────┬┴──┤ │
│ │ └─id─┘ │ │
│ ├─NEW─────────────────┤ │
│ └─ALL─────────────────┘ │
│ ┌──
───────┐ │
┬─────┬┴───┬───────┤
├─EXCL─┬─KEY key──
│ │ └─key─┘ │ │
│ │ ┌──
───────┐ │ │
│ ┬─────┬┴───┤
├─PFX pfx── │
│ │ └─pfx─┘ │ │
│ │ ┌──
──────┐ │ │
│ ├─TERMID id── ┬────┬┴──┤ │
│ │ └─id─┘ │ │
│ └─NEW─────────────────┘ │
├─LIST─┬──────────┬──────────────────┤
│ └─NOARRACH─┘ │
└─Display─┬───────────────────────┬──┘
├─KEY key─┬──────────┬──┤
│ └─NOATTACH─┘ │
├─PFX pfx───────────────┤
├─TERMID id─────────────┤
├─ALL───────────────────┤
└─SYStem────────────────┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

2-52 System Commands Guide


2.11 Operator Commands

ON activates the Response-Time Monitor and monitors all users. Qualify


with:
mem is the name of a library member that identifies the specific
users/terminals to be monitored.
OFF deactivates the Response-Time Monitor.
INCL adds one or more users or terminals to those eligible for monitoring.
Specify one of the following:
KEY key is the sign-on key of the user to be monitored. A
maximum of 11 keys can be specified, provided they
fit on a single line.
PFX pfx is the prefix of the user to be monitored. A maximum
of 11 prefixes can be specified, provided they fit on a
single line.
TERMID id is the ID of the terminal to be monitored. A
maximum of 11 terminal IDs can be specified,
provided they fit on a single line.
At VTAM sites: Use the terminal's VTAM ID.
With BTAM remote 3270-type terminals: Use the label
specified on the RCSDVICE macro of the RCSGEN.
With BTAM local 3270-type terminals and TTYs: Use
the DD name specified in the Advantage CA-Roscoe
JCL.
NEW allows all new eligible users signing on to be
monitored.
ALL causes all users to be eligible for monitoring.
EXCL excludes one or more users or terminals from monitoring. Specify
one of the following:
KEY key is the sign-on key of the user to be excluded. A
maximum of 11 keys can be specified, provided they fit
on a single line.
PFX pfx is the prefix of the user to be excluded. A maximum of
11 prefixes can be specified, provided they fit on a single
line.
TERMID id is the ID of the terminal to be excluded. A maximum of
11 terminal IDs can be specified, provided they fit on a
single line.
At VTAM sites: Use the terminal's VTAM ID.
With BTAM remote 3270-type terminals: Use the label
specified on the RCSDVICE macro of the RCSGEN.

Chapter 2. System Commands 2-53


2.11 Operator Commands

With BTAM local 3270-type terminals and TTYs: Use the


DD name specified in the Advantage CA-Roscoe JCL.
NEW prevents all new eligible users from being monitored.
LIST places a list of all users and terminals currently eligible for monitoring
in the member ZZZZZRTM. Qualify with:
NOATTACH
prevents the member from being displayed. If omitted,
the member is displayed.
DISPLAY
places response-time information about all or selected users currently
signed on or summary information about the current interval in the
member ZZZZZRTM. (Abbreviate DISPLAY as D.)
With no qualification, information about all users is displayed. (This
is equivalent to specifying RTM DISPLAY ALL.) The display can be
qualified by specifying one of the following:
KEY key is the sign-on key of the user about whom
response-time information is desired.
PREFIX pfx is the prefix of the user about whom response-time
information is desired.
TERMID id is the ID of the terminal about which reponse-time
information is desired.
At VTAM sites: Use the terminal's VTAM ID.
With BTAM remote 3270-type terminals: Use the label
specified on the RCSDVICE macro of the RCSGEN.
With BTAM local 3270-type terminals and TTYs: Use
the DD name specified in the Advantage CA-Roscoe
JCL.
ALL displays information about all users being monitored.
SYStem displays summary information about the current
interval.
NOATTACH prevents the member ZZZZZRTM from being
displayed. If omitted, the member is displayed.

NOTES: Additional information about using this command:


■ Using INCL ALL:
All users and terminals are marked as eligible for monitoring; overriding
any previously issued EXCLs.
■ Using EXCL NEW:

2-54 System Commands Guide


2.11 Operator Commands

Users signing on after the command is issued are not monitored. This is
useful in cases when you want to monitor the first 'x' number of users that
sign on, regardless of who they are.
■ Using INCL NEW:
INCL NEW can be used to permit monitoring of subsequent users signing
on.
■ See the description of the RTM command for additional information.

2.11.15 SEND
FUNCTION: Sends a message to one or more terminal users who are currently
active.

SYNTAX

SEND Operator Command


──┬─────┬──SEND──┬───────┬──message───────────────────────────
└─OPR─┘ └─ID=id─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
ID=id is the internal logical line number of the user to receive the message.
If omitted, the message is sent to all users who are currently active.
message
is the one- to 64-character message.

NOTES: Additional information about using this command:


■ To obtain the internal logical line number, use the OPERATOR STATUSX
or ROS command.
■ Delimit the message with apostrophes if it begins with the word ALL.
Without delimiters, Advantage CA-Roscoe interprets the command as
SEND ALL.
■ When the message is displayed, it is preceded by a date and time field.
■ A SEND message is lost if it is not delivered before another SEND (even
one addressing a different logical line) or OFF command is issued. The
message is not affected by SEND ALL messages, which are maintained
differently.
■ Use SEND ALL to send a high-priority message to all Advantage
CA-Roscoe users.
■ Use SEND KEY/PFX to send a message to a user who may or may not be
currently active.

Chapter 2. System Commands 2-55


2.11 Operator Commands

2.11.16 SEND (ALL)/NOSEND


FUNCTION: Sends or cancels a high-priority message.

SYNTAX

SEND (ALL)/NOSEND Operator Command


──┬─────┬──┬─SEND ALL─┬──message──────────────────────────────
└─OPR─┘ └─NOSEND───┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
message
is the one- to 64-character message to be transmitted to all terminal
users.

NOTES: Additional information about using this command:


■ Using SEND ALL:
– When SEND ALL is issued, a high-priority message is written to the
Response Line of every user at sign-on and to every user who is
currently active. The message is preceded by a data and data and time
field.
If the user's screen does not show a Response Line, the message is not
received. Individuals who might not receive a message include:
1. restricted users whose Advantage CA-Roscoe session is controlled
by full-screen RPF programs, and
2. users execution applications under ETSO, where the application
uses the full screen.
– A SEND ALL message replaces any previous SEND ALL message.
– SEND ALL messages are maintained separately from messages sent by
the other forms of the SEND command.
■ Using NOSEND:
When NOSEND is issued, all outstanding SEND ALL messages are
cancelled.

2-56 System Commands Guide


2.11 Operator Commands

2.11.17 SEND (KEY/PFX)


FUNCTION: Sends a message to a Advantage CA-Roscoe user who may or
may not be currently active.

SYNTAX

SEND (KEY/PFX) Operator Command


──┬─────┬──SEND──┬─KEY=key─┬──┬─────┬──┬───────────┬──────────
└─OPR─┘ └─PFX=pfx─┘ ├─AWS─┤ └─/message/─┘
└─mem─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
KEY=key is the sign-on key of the person to receive the message.
PFX=pfx is the Advantage CA-Roscoe prefix of the person to receive the
message.
AWS designates that the active AWS contains the text.
mem is the name of the library member containing the text.
message is the text, not exceeding 64 characters in length, that is to be
sent.

NOTES: Additional information about using this command:


■ The message is displayed on the Response Line. It is also saved as the
member ZZZZZMSG in the user's library.
■ If the first word following SEND is not KEY= or PFX=, Advantage
CA-Roscoe checks to see if it is all (and assumes the command is SEND
ALL). If any other word is used, it is assumed to be the first word of the
message and the SEND command is assumed.
■ A user assigned operator privileges can use the AWS or a library member
to send a message that is greater than 64 characters in length. (See the
description of the SEND command in the Advantage CA-Roscoe Interactive
Environment Command Reference Guide for details.)
The operator can only send a one- to 64-character message.

Chapter 2. System Commands 2-57


2.11 Operator Commands

2.11.18 SHUTDOWN
FUNCTION: Terminates Advantage CA-Roscoe execution.

SYNTAX

SHUTDOWN Operator Command


──┬─────┬──SHUTDOWN────────────────────────────────────────────
└─OPR─┘
──┬─NOW───────────────────────────────────────────────────┬────
├──┬────┬─num1─┬─WARN─┬──────┬──┬───────────────────────┤
│ └─IN─┘ │ └─num4─┘ │ │
│ └─NOWARN─────────┘ │
├──┬────┬─tod1─┬─WARN─┬──────┬──┬───────────────────────┤
│ └─AT─┘ │ └─num4─┘ │ │
│ └─NOWARN─────────┘ │
├──┬───────┬──┬──────┬─BY─┬─num3─┬──┬─WARN─┬──────┬──┬──┤
│ └─AFTER─┘ ├─num2─┤ └─tod3─┘ │ └─num4─┘ │ │
│ └─tod2─┘ └─NOWARN─────────┘ │
├─NOWARN────────────────────────────────────────────────┤
└─CANCEL────────────────────────────────────────────────┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned
operator privileges. It must not be used by the console operator.
NOW terminates Advantage CA-Roscoe immediately.
IN num1 is the number or hours or minutes Advantage CA-Roscoe is to
wait before beginning shutdown processing. Suffix the value with
an H (for hours) or M (for minutes), as in: 2H or 60M.
AT tod1 is the time of day when Advantage CA-Roscoe is to shutdown.
The time is based on a 24-hour clock and should be specified in
the form: hh:mm.
AFTER designates when Advantage CA-Roscoe is to begin checking for
signed on terminals. If omitted, Advantage CA-Roscoe begins
checking immediately. Specify as either:
num2 is the number of hours or minutes Advantage
CA-Roscoe is to wait before checking for signed on
terminals.
tod2 is the time of day when Advantage CA-Roscoe is to
begin checking for sign-on terminals.
BY designates when Advantage CA-Roscoe is to begin shutdown
processing, specified as either:
num3 is the number of hours or minutes Advantage
CA-Roscoe is to wait before beginning shutdown
processing.

2-58 System Commands Guide


2.11 Operator Commands

tod3 is the time of day when Advantage CA-Roscoe is to


shutdown.
WARN causes warning messages to be sent to user terminals at
calculated intervals. Qualify with:
num4 is the time between Advantage CA-Roscoe warning
messages. The value must be suffixed with an H (for
hours) or M (for minutes).
NOWARN prevents warning messages from being sent to user terminals.
CANCEL cancels a previously scheduled shutdown.

NOTES: Additional information about using this command:


■ SHUTDOWN may be entered as a Advantage CA-Roscoe command, an OS
MODIFY command (F jobname) or an OS STOP command (P jobname).
■ During shutdown, Advantage CA-Roscoe performs normal SAVEAWS
processing and writes a sign-off accounting record for each active session.
■ Scheduled Shutdown:
– When specifying time-of-day, specify midnight as 00:00. Also, if the
first digit in the time is a 0, it may be omitted (for example, 08:00 and
8:00 are both valid).
– During the time that a shutdown is scheduled:
1. users may continue to sign on and off of Advantage CA-Roscoe at
will, and
2. the shutdown time can be displayed by the OPERATOR STATUS
command.
– With BY, Advantage CA-Roscoe begins checking the number of signed
on terminals when the specified (or default) AFTER time is reached. If
the number of terminals becomes zero at any point between the
AFTER and BY times, shutdown occurs.
– If neither NOWARN nor a qualified WARN is specified, the default is
WARN with no value. The default causes the first warning message to
be sent to user terminals either:
1. two hours before shutdown is scheduled, or
2. when the command is entered if there is less than two hours to
shutdown.

Chapter 2. System Commands 2-59


2.11 Operator Commands

The interval value is recomputed after each message is sent. The


formula used to calculate the next interval is:
(remaining time until shutdown) / 2
No messages are sent if the remaining time is less than one minute.

EXAMPLES: Examples illustrating the use of this command:


■ To terminate Advantage CA-Roscoe in two hours:
SHUTDOWN IN 2H
■ To terminate Advantage CA-Roscoe at 8:00 pm:
SHUTDOWN AT 2:
■ To terminate Advantage CA-Roscoe after 2:00 pm and by 3:00 pm, sending
users a warning message every 15 minutes:
SHUTDOWN AFTER 14: BY 15: WARN 15M

2.11.19 SIGNON/NOSIGNON
FUNCTION: Enables or disables users from signing on to Advantage
CA-Roscoe.

SYNTAX

SIGNON/NOSIGNON Operator Command


──┬─────┬──┬─SIGNON───┬───────────────────────────────────────
└─OPR─┘ └─NOSIGNON─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges from UPS. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ Using SIGNON:
When SIGNON is issued, users are permitted to sign on to Advantage
CA-Roscoe. (This is normally the mode when Advantage CA-Roscoe is
initially brought up.)
■ Using NOSIGNON:
When NOSIGNON is issued, users are prevented from signing on to
Advantage CA-Roscoe. An appropriate message is written to any user
attempting to sign on. Users already signed on are unaffected by this
command.
Abbreviate NOSIGNON as NOS.
Note: A user assigned operator privileges can always sign on.

2-60 System Commands Guide


2.11 Operator Commands

2.11.20 SPOOL
FUNCTION: Displays the status of spool volumes allocated to Advantage
CA-Roscoe.

SYNTAX

SPOOL Operator Command


──┬─────┬──SPOOL──┬──────────────┬────────────────────────────
└─OPR─┘ └─FREE──ddname─┘

With no operand, displays the status of all spool volumes allocated to


Advantage CA-Roscoe under JES2/JES3.
OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must
be used when this command is issued by individuals assigned
operator privileges. It must not be used by the console
operator.
FREE ddname is the one- to eight-character DD name of the JES2 spool
volume to be deallocated.

NOTES: Additional information about using this command:


| ■ During initialization, Advantage CA-Roscoe dynamically allocates all spool
| volumes required for the JES2 or JES3 interface. JES2 users may
| dynamically release allocated spool volumes by issuing the "SPOOL FREE"
| command.

2.11.21 STATUS/STATUSX
FUNCTION: Displays information about lines and terminals signed on.

SYNTAX

STATUS/STATUSX Operator Command


──┬─────┬──┬─STATUS──────────┬────────────────────────────────
└─OPR─┘ └─STATUSX──┬────┬─┘
└─id─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
id is the internal line number of the user for whom information is
desired.

Chapter 2. System Commands 2-61


2.11 Operator Commands

NOTES: Additional information about using this command:


■ Using STATUS:
As illustrated in the following sample screen, the STATUS command
displays the number of terminals signed on and the physical device
address of each of those terminals. If a shutdown is scheduled, the
shutdown time is also displayed.
STATUS enables the operator to monitor the terminal load in preparation
for a shutdown.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
ROS131I: TERMINALS ON: 2
ROS132I: LINES ON: 1=K6L37Z4 2=K6L33ZR

STATUS Display
■ Using STATUSX:
The STATUSX command displays the sign-on key of each user signed on
and the internal logical line number associated with each active user.
If 'id' is specified, only the sign-on key of the individual using that line is
displayed. If the line is not in use, a message is displayed.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
ROS133I: LINE1 SMITH LINE3 JONES

STATUSX Display

2-62 System Commands Guide


2.11 Operator Commands

2.11.22 STOP
FUNCTION: Shuts down the designated remote 3270 BTAM line or cluster.

SYNTAX

STOP Operator Command


──┬─────┬──STOP LINE=──┬─ALL───────────┬──────────────────────
└─OPR─┘ └─cuu─┬──────┬──┘
└─,cua─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
ALL shuts down all lines.
cuu is the physical device address of the line to be shutdown.
cua is a two-digit number between 00 and 31, inclusive, that is the
hardware cua (control unit address) of the cluster to be stopped.

NOTES: Additional information about using this command:


■ Using STOP:
All active users on the line or cluster are signed off and their AWS
contents saved before the line is stopped. The operator receives message
ROS709I, confirming the operation.
■ Restarting:
– To restart a single cluster, use the RESTART LINE=cuu,id command.
– To restart an entire line that was stopped one cluster at a time, use the
RESTART LINE=cuu command.

2.11.23 SUBMIT/NOSUBMIT
FUNCTION: Enables or disables the SUBMIT facility.

SYNTAX

SUBMIT/NOSUBMIT Operator Commands


──┬─────┬──┬─SUBMIT───┬───────────────────────────────────────
└─OPR─┘ └─NOSUBMIT─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

Chapter 2. System Commands 2-63


2.11 Operator Commands

NOTES: Additional information about using this command:


■ Using SUBMIT:
When SUBMIT is issued, the SUBMIT facility is enabled. (This is normally
the mode when Advantage CA-Roscoe is initially brought up.)
■ Using NOSUBMIT:
When NOSUBMIT is issued, the SUBMIT facility is disabled.
NOSUBMIT is normally entered only in response to a directive of the
systems programmer to prevent trouble when the job queue is
overflowing.
Execution of this command is confirmed by the message ROS134I, followed
by the normal messages comprising the reply to the STATUS command.
As long as the SUBMIT facility is disabled, message ROS134I is written
along with the standard response to the STATUS command.
■ When either command is issued, a message should be sent to all users (by
the SEND ALL command) informing them of the situation.

2.11.24 VTAM FORCINT


FUNCTION: Defines how long Advantage CA-Roscoe is to wait after the ACB
is closed before forcing the network to a STOPPED status.

SYNTAX

VTAM FORCINT Operator Command


──┬─────┬──VTAM FORCINT──n────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
n is the number of seconds Advantage CA-Roscoe is to wait after a
CLOSE ACB before forcing a STOP.

NOTES: Additional information about using this command:


■ As distributed, the default time period is 300 seconds (five minutes);
however, site management has the option of changing this value.
■ This value is used for emergency cases where the CLOSE ACB fails or
sessions cannot be terminated. When the interval expires, Advantage
CA-Roscoe terminates STOP processing and is ready to respond to a
VTAM START command.

2-64 System Commands Guide


2.11 Operator Commands

2.11.25 VTAM OPENINT


FUNCTION: Defines how long Advantage CA-Roscoe is to wait before
attempting to establish communications with VTAM.

SYNTAX

VTAM OPENINT Operator Command


──┬─────┬──VTAM OPENINT──n────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
n is the number of seconds Advantage CA-Roscoe is to wait before
attempting the OPEN ACB.

NOTES: Additional information about using this command:


■ As distributed, the default time period is 10 seconds. However, site
management has the option of changing this value.
■ This value is used when the VTAM START command is issued and the
OPEN ACB fails with an error code of 14 or 5C.

2.11.26 VTAM START


FUNCTION: Initiates communications between Advantage CA-Roscoe and
VTAM.

SYNTAX

VTAM START Operator Command


──┬─────┬──VTAM ;START────────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ The state of the Advantage CA-Roscoe/VTAM network is tested. If it is in
the process of stopping, the START is scheduled and executes as soon as
the network status is set to STOPPED.
■ Communications with VTAM is initiated by executing an OPEN ACB.

Chapter 2. System Commands 2-65


2.11 Operator Commands

If the OPEN ACB succeeds, a message is written to the console stating that
users may now sign on using Advantage CA-Roscoe's applid. Print
requests to VTAM destinations are restarted.
If the OPEN ACB or the SETLOGON START fails and the problem is:
– Temporary (the OPEN ACB failed with an error code of 14 or 5C):
Advantage CA-Roscoe directs a message to the console requesting the
operator to enter:
TERM to terminate this attempt to establish communications.
applid is a different applid that is to be used to retry the attempt to
establish communications.
If there is no response, Advantage CA-Roscoe retries the OPEN at the
interval defined by the VTAM OPENINT command (or the default).
– Serious (the error code is other than 14 or 5C):
Advantage CA-Roscoe writes a message to the console requesting the
operator to enter:
GO to retry the attempt to establish communications.
TERM to terminate this attempt to establish communications.
applid is a different applid that is to be used to retry the attempt to
establish communications.
If there is no response, the message remains displayed. Advantage
CA-Roscoe continues to be available to users using BTAM devices.

2.11.27 VTAM STOP


FUNCTION: Terminates communications between Advantage CA-Roscoe and
VTAM.

SYNTAX

VTAM STOP Operator Command


──┬─────┬──VTAM STOP──────────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ This command has no impact on the status of VTAM. It controls
Advantage CA-Roscoe's communications with VTAM terminals and
printers.

2-66 System Commands Guide


2.11 Operator Commands

■ After this command is executed:


– All users currently signed on to VTAM terminals receive warning
messages stating that the network is stopping and the user should sign
off. (The message is sent at the interval set by the VTAM WARNINT
command.)
– No new users are allowed to sign on to a VTAM terminals.
– Any print requests printing on VTAM printers are terminated and
placed on the hold queue.
At intervals set by the site, Advantage CA-Roscoe checks to see how many
VTAM terminals and printers are still active. When the count is zero, the
ACB is closed and the Advantage CA-Roscoe/VTAM network is set to
STOPPED.
■ An OPERATOR VTAM STOP QUICK may be necessary to close the ACB
if all of the users do not log off Advantage CA-Roscoe.

2.11.28 VTAM STOP FORCE


FUNCTION: Terminates communications between Advantage CA-Roscoe and
VTAM.

SYNTAX

VTAM STOP FORCE Operator Command


──┬─────┬──VTAM STOP FORCE────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ This command has no impact of the status of VTAM. It controls
Advantage CA-Roscoe's communications with VTAM terminals and
printers.
■ This command should be used in emergency cases only.
This command should be issued if the operator command HALT CANCEL
or HALT QUICK or the OPERATOR STOP QUICK command is issued and
the CLOSE ACB fails or the number of active VTAM terminals/printers
does not go to zero.
The state of the network is immediately set to STOPPED.

Chapter 2. System Commands 2-67


2.11 Operator Commands

2.11.29 VTAM STOP QUICK


FUNCTION: Terminates communications between Advantage CA-Roscoe and
VTAM.

SYNTAX

VTAM STOP QUICK Operator Command


──┬─────┬──VTAM STOP QUICK────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.

NOTES: Additional information about using this command:


■ This command has no impact of the status of VTAM. It controls
Advantage CA-Roscoe's communications with VTAM terminals and
printers.
■ After this command is executed:
– The ACB is immediately closed.
– All users currently signed on to VTAM terminals are signed off.
– No new users are allowed to sign on to a VTAM terminal.
– Any print requests printing on VTAM printers are terminated and
placed on the hold queue.
At intervals set by the site, Advantage CA-Roscoe checks to see how many
VTAM terminals and printers are still active. When the count is zero, the
Advantage CA-Roscoe/VTAM network is set to STOPPED.

2.11.30 VTAM STOPINT


FUNCTION: Defines how long Advantage CA-Roscoe is to wait before testing
to determine if terminals or printers are still in session with Advantage
CA-Roscoe.

SYNTAX

VTAM STOPINT Operator Command


──┬─────┬──VTAM STOPINT──n────────────────────────────────────
└─OPR─┘

2-68 System Commands Guide


2.11 Operator Commands

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
n is the number of seconds Advantage CA-Roscoe is to wait before
retesting the number of sessions.

NOTES: Additional information about using this command:


■ As distributed, the default time period is ten seconds. However, site
management has the option of changing this value.
■ This value is used when the HALT or VTAM STOP command is issued.
When the session count is zero, the ACB is closed and the status is set to
STOPPED.

2.11.31 VTAM WARNINT


FUNCTION: Defines how long Advantage CA-Roscoe is to wait before
resending a warning message to VTAM terminals.

SYNTAX

VTAM WARNINT Operator Command


──┬─────┬──VTAM WARNINT──n────────────────────────────────────
└─OPR─┘

OPR is the abbreviation of OPERATOR. OPR (or OPERATOR) must be


used when this command is issued by individuals assigned operator
privileges. It must not be used by the console operator.
n is the number of seconds Advantage CA-Roscoe is to wait before
resending the warning message.

NOTES: Additional information about using this command:


■ As distributed, the default time period is 60 seconds (one minute);
however, site management has the option of changing this value.
■ This value is used when the HALT or VTAM STOP command is issued.

Chapter 2. System Commands 2-69


2.12 PEEK (RPF Function)

2.12 PEEK (RPF Function)


FUNCTION: Returns the contents of a storage location.

SYNTAX

PEEK (RPF Function) Command


──PEEK──( 'expr1' 'expr2' 'expr3')────────────────────────────

expr1 is the absolute address (given as a one- to eight-digit hexadecimal


string), Advantage CA-Roscoe module name or Advantage CA-Roscoe
control block ID that may be followed by:
+ adds a subsequent one- to eight-character hexadecimal value
to the current base address.
- subtracts a subsequent one- to eight-character hexadecimal
value from the current base address.
% resets the current base using the value being pointed to by
the current base for the length of 4. (The high-order byte is
ignored.)
? resets the current base using the value being pointed to by
the current base for the length of 4. (All four bytes are
recognized.)
Prefix expr1 with an @ to get the EPA of a given module or the
location of a Advantage CA-Roscoe control block. (% and ? may not
be used when an @ is used.)
expr2 is the length (in hex) of the input field followed by the output display
type, separated by a comma.
The valid output display format types are:
CHAR Data to be returned asis. (Abbreviate as C.)
HEX Data to be returned in hex format. (Abbreviate as H or X.)
DUMP Data to be returned in dump format. (Abbreviate as D.)
If omitted, the data is returned in hexadecimal format for a Length of
four bytes. expr2 is ignored when requesting an EPA.
expr3 obtains information about the user identified via:
PFX=pfx is the prefix of the user.

2-70 System Commands Guide


2.12 PEEK (RPF Function)

KEY=key is the sign-on key of the user.


TERMID=id is the terminal ID.
At VTAM sites, use the terminal's VTAM ID.
With BTAM remote 3270-type terminals, use the label
specified on the RCSDVICE macro of RCSGEN.
With BTAM local 3270-type terminals and TTYs, use
the DD name specified on the Advantage CA-Roscoe
JCL.

NOTES: Additional information about using this command:


■ This function is only available to individuals assigned operator privileges.
■ In addition to an absolute address, expr1 can contain a:
– Advantage CA-Roscoe load module name or alias or an identified
entry point.
– Control block id (for example, ROT, ATT1, SCB, PCB, RSCNCB or
RCSRB).
– Id of a control block pointed to by the ROT (for example, AWSCT,
ECBLIST, LBCT, RCSACB, RCSANCHR, RCSVTAM, ROSGBL,
RPSACB, RPSENV, RTV, SCREEN1 through SCREEN5, TCT and XCT).
■ If the output display format specified with expr2 is:
CHAR The data is returned asis (for example, ACBDEFCH).
HEX The data is returned in hex format (for example, C1C2C3C4
C5C6C7C8 01010101).
DUMP The data is returned in dump format (for example, C1C2C3C4
C5C6C6C8 01010101 *ABCDEFCF....*).
■ S.PEEKADDR Session Variable
When the PEEK function is used, the S.PEEKADDR session variable
contains either the:
– Starting location of the data (when data is requested), or
– EPA or address of the control block (when an EPA/control block is
requested).

Chapter 2. System Commands 2-71


2.12 PEEK (RPF Function)

EXAMPLES: Examples illustrating the use of this command:


■ To return the contents of storage at ROT plus four bytes:
LET L1 = PEEK('ROT+4')
■ To return the contents of storage that is pointed to by the ROT plus four
bytes:
LET L1 = PEEK('ROT+4%')
■ To return the entry point address of the Advantage CA-Roscoe module
LIBMGR:
LET L1 = PEEK ('@LIBMGR')
■ To return the first 16 bytes of the ROT in a dump format:
LET L1 = PEEK ('ROT' '1,DUMP')
■ To return the location of the SCB associated with the user whose prefix is
USR:
LET L1 = PEEK ('@SCB' 'PFX=USR')
■ To return the first 16 bytes of the SCB associated with the user whose
sign-on key is ROSUSER:
LET L1 = PEEK('SCB' '1,DUMP' 'KEY=ROSUSER')

2-72 System Commands Guide


2.13 RCSTRACE

2.13 RCSTRACE
FUNCTION: Controls the extent of tracing information that is to be acquired.

Caution
This command is for debugging and diagnostic purposes only. It should
only be used under the direction of a member of the Advantage CA-Roscoe staff.
The output from this facility is voluminous unless properly controlled.

SYNTAX

RCSTRACE Command
┌─ALL──┐
──RCStrace──┬─ID─┼──────┼──────┬──────────────────────────────
│ │ ┌──┐ │ │
│ id┴─┘
└── │
│ ┌─ALL──┐ │
├─XID─┼──────┼─────┤
│ │ ┌──┐ │ │
│ id┴─┘
└── │
│ ┌─ALL────┐ │
├─NODE─┼────────┼──┤
│ │ ┌──
────┐ │ │
│ node┴─┘ │
└──
│ ┌─ALL────┐ │
├─AREA─┼────────┼──┤
│ │ ┌──
────┐ │ │
│ area┴─┘ │
└──
│ ┌─ALL─┐ │
├─BUFlen─┴─num─┴───┤
├─ON───────────────┤
├─OFF──────────────┤
└─STAtus───────────┘

ID designate the extent of tracing. If specified with no operand, the


default is ALL. Specify:
ALL includes all identifiers in the trace.
id is one or more of the following identifiers (if using more than
one, separate them by commas):
AWS General AWS trace.
BTL BTAM local device trace.
BTR BTAM remote device trace.
CMND Command trace.
COM General low level communications trace.
DSPL Display trace.
ETSO ETSO trace.
LIB General LIBIO trace.
LIN BTAM remote line handler 'line' trace.

Chapter 2. System Commands 2-73


2.13 RCSTRACE

LIO Logical RDS request.


PIO Physical RDS request.
PRTR Printer trace.
RDS General RDS high-level trace.
TEST Temporary test trace.
TTY TTY device trace.
TYP General typewriter trace.
VTM VTAM session trace.
XTP XTPM session trace.
3270 General 3270 device trace.
3767 3767 device trace
XID designates the extent of tracing to be excluded. If specified with no
operand, the default is ALL. Specify:
ALL excludes all identifiers from tracing.
id one or more of the identifiers described with the ID operand.
NODE designates terminals to be traced. If specified with no operand, the
default is ALL. Specify either:
ALL includes all terminals in the trace.
node1 the name of the terminal to be traced. A maximum of four
terminals names may be specified, where each is
eight-characters in length and blank-padded.
AREA designate the areas to be traced. If specified with no operand, the
default is ALL. Specify either:
ALL includes all areas.
area1 the name of the DSECT or control block to be traced.
BUFlen designate the communication buffers to be traced by specifying either:
ALL traces the entire contents of the communication data buffers.
v decimal value indicating the number of bytes of the
communications buffers that are to be traced. For example,
BUFLEN 10 causes the first ten bytes of the communications
data buffer to be traced.
The default buffer length is 32 bytes. If the length is changed,
the default value can only be reestablished by this operand.
ON activates the trace facility.
OFF deactivates the trace facility.
STAtus displays the current status of the trace facility.

2-74 System Commands Guide


2.13 RCSTRACE

NOTES: Additional information about using this command:


■ Command Usage:
– If ID, NOTE or AREA is specified, any previously specified value is
overridden. When adding an ID, node, or area, respecify the values
currently in effect when including the new value.
– RCSTRACE is a privileged command and may only be issued by the
individuals assigned operator privileges or by the console operator.
■ RCS Trace Facility Overview:
The RCSTRACE command is part of the ROSCOE Communications
Services (RCS) trace facility. This facility can be used to obtain information
about activity within the site's communications network defined to RCS.
In addition to the RCSTRACE command, this facility consists of:
– The TRACEDD DD Statement:
This DD statement directs the information obtained by the trace facility
to a system printer or data set.
If it is not specified and either the RCSTRACE initialization parameter
or RCSTRACE command is encountered, the trace facility SYSOUT file
is dynamically allocated with the same message class under which
Advantage CA-Roscoe is executing.
To avoid system overhead and to ensure the output is directed to the
appropriate destination, the DD statement should be included in the
Advantage CA-Roscoe JCL.
To direct the trace information to a printer, specify:
//TRACEDD DD SYSOUT=class
To direct the information to a buffer that is included in the Advantage
CA-Roscoe dump, specify:
//TRACEDD DD DUMMY
– The RCSTRACE Initialization Parameter:
By default, RCS tracing does not occur during Advantage CA-Roscoe
initialization. To activate tracing, the Advantage CA-Roscoe JCL should
contains:
RCSTRACE=ON
After Advantage CA-Roscoe initialization completes, use the
RCSTRACE command to control the extent of tracing that is to occur
during the execution of Advantage CA-Roscoe.

Chapter 2. System Commands 2-75


2.13 RCSTRACE

■ RCSTRACE STATUS Display:


Tth following screen illustrates the type of information provided by the
RCSTRACE STATUS command.

_ 
>
>
...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
RCSTRACE STATUS

STATE: ON 1
IDS: ALL 2
NODES: K18L29 3
AREAS: ALL 4

BUFFER LENGTH: ALL 5

1 STATE: Current tracing status, designated as ON or OFF.


2 IDS: Keyword ALL or the identifiers currently in effect.
3 NODES: Keyword ALL or the terminal id(s) currently being traced.
4 AREAS: Keyword ALL or the areas currently being traced.
5 BUFFER LENGTH: Keyword ALL or the number of bytes of the
communication data buffers being traced.
■ If the current status is OFF, the trace facility may not yet have been
activated or may have been deactivated by the user.
If the facility has been deactivated for any other reason. OFF is preceded
by one of the following messages:
– TERMINATED BY DCB ABEND EXIT
The data set is full. This causes the DCB's Abend Exit to be entered.
The data set is closed and tracing is turned off.
Sites should determine whether more space should be allocated to the
data set before attempting to reopen it. If the data set is defined with
DISP=SHR, it may be reopened by issuing the RCSTRACE ON
command; however, the data it contained is lost since the trace facility
begins writing at the start of the data set. If the data set is defined with
DISP=MOD, the data set cannot be reopened.
– TERMINATED BY DCB SYNAD EXIT
I/O errors occurred. This caused the DCB's Synad Exit to be entered;
tracing is terminated.

2-76 System Commands Guide


2.13 RCSTRACE

EXAMPLES: Examples illustrating the use of this command:


■ To obtain trace information about all facilities except ETSO:
RCS ID ALL
RCS XID ETSO
■ To then change the tracing requirements to obtain only printer
information:
RCSTRACE ID PRTR

Chapter 2. System Commands 2-77


2.14 ROS

2.14 ROS
FUNCTION: Provides Advantage CA-Roscoe system status information.

SYNTAX

ROS Command
┌─-S──────┐
──ROS──┬──────┬──┼─────────┼──┬───────────┬───────────────────
└─dest─┘ └─-status─┘ ├─KEY=key───┤
├─AM=access─┤
├─TYPE=type─┤
└─UNIT=unit─┘

With no operands, directs output to the site-defined


destination and provides system status information for all
appropriate keys, access methods, terminal types and units.
dest is the output destination identified as either A (for AWS) or T
(for terminal). If neither is specified, output is directed to the
site default destination.
-status is a code designating the type of status information desired. If
omitted, the default is -S. Specify one of the following:
-A display active status information.
-I display inactive status information.
-S display system status information.
KEY=key is the sign-on key of the user for whom status information is
desired. Use a plus sign to indicate general keys (for example,
KEY=70018+).
AM=access is the access method for which status information is desired.
Specify one of the following:
BTAM Combination of BTAML and BTAMR.
BTAML Local BTAM devices and TTYs.
BTAMR Remote BTAM devices only.
VTAM VTAM.
XTPM External TP monitor (3270 keyboard-displays only).

2-78 System Commands Guide


2.14 ROS

TYPE=type is the terminal type for which status information is desired.


Specify one of the following:
3270 Local and remote BTAM and VTAM.
3270B Local and remote BTAM.
3270L Local BTAM.
3270R Remote BTAM.
3270V VTAM only.
3270X External TP monitor.
3767 or 3767V
VTAM only.
TTY Local BTAM and VTAM
TTYB Local BTAM.
TTYL Local BTAM.
TTYV VTAM.
These codes allow you to qualify the extent of information (for
example, TYPE=3270 provides information about all 3270-type
terminals while TYPE=3270L provides information about local
BTAM 3270-type terminals).
UNIT=unit is the identifier of the unit(s) for which status information is
desired. The type of identifier depends on the access method.
For VTAM and XTPM, specify a logical unit name.
For BTAM remotes, specify:
cuu
cuu.cua
cuu.cudu
label on RCSDVICE macro
For BTAM locals, specify:
cuu
DD statement name

NOTES: Additional information about using this command:


■ ROS is a Monitor command. As distributed, the use of this command is
not restricted.
■ ROS Display:
The following screen illustrates the type of information provides when the
ROS command is entered with no operands.

Chapter 2. System Commands 2-79


2.14 ROS

_ 

>
>
1 2 3 4
.........1....+....2....+....3....+....4....+....5.....+....6....+....7....+....8
TERMSO: 85, TERMTO: 85, CONNECTED: 3, SUB-SESSIONS: 32
LINE AM TYPE NODENAME COM-ID I/O STATUS KEY
---- ----- ---- -------- -------- ---- -------- ----------------------
5 6 7 8 9 1 11 12
1 VTAM 327 K18L21ZL 652E 4 ACTIVE USER1
42 VTAM 327 A46LC5 4464 1298 ACTIVE USER2

ROS Display
When the ROS command is entered with no operand or when ROS-S is
entered, the following information is displayed:
1 TERMSO: Number of subsessions specified with the TERMSO=
initialization parameter that can be concurrently active.
2 TERMTO: Total number of devices defined to Advantage CA-Roscoe.
3 CONNECTED: Number of devices currently connected.
4 SUB-SESSIONS: Number of screen splits active.
The following information is displayed when ROS is entered with no
operand or when ROS-A or ROS-I is entered:
5 LINE: Terminal line number. This number is included in the
sign-on/sign-off messages written to the Advantage CA-Roscoe log.
6 AM: Access method.
7 TYPE: Terminal type.
8 MODENAME: Symbolic terminal name.
9 COM-ID: Terminal unit address (BTAM) or communication
identification (VTAM).
1 I/O: Number of terminal I/Os during the user's session (modulo
1000).
11 STATUS: Current status of the terminal, shown as ACTIVE,
INACTIVE or STOPPED. Terminals shown as INACTIVE include:
BTAM Terminals not in session, stopped (remote 3270) or not open
(start/stop).
VTAM Terminals pending logon.
12 KEY: User's sign-on key.

2-80 System Commands Guide


2.14 ROS

EXAMPLES: Examples illustrating the use of this command:


■ To direct output to the site default destination, report on only active status
information and qualify that information so that it pertains to only remote
3270s:
ROS-A TYPE=327R

Chapter 2. System Commands 2-81


2.15 ROZAP

2.15 ROZAP
FUNCTION: Provides privileged users with restricted operator privileges.

SYNTAX:

ROZAP Command
──ROZAP──┬─nnn────────────────────────┬───────────────────────
├─ABEND──────────────────────┤
├─DISABLE command────────────┤
├─DUMP───────────────────────┤
├─ENABLE command─────────────┤
├─FLUSH─┬─KEY=key─┬────┬──┬──┤
│ │ └─,F─┘ │ │
│ ├─ID=id───────────┤ │
│ └─LU=lu───────────┘ │
├─LOCK mon───────────────────┤
├─NOSignon───────────────────┤
├─NOSUB──────────────────────┤
| ├─PRELOAD module─────────────┤
├─REFRESH UPS────────────────┤
├─RELOAD mon─────────────────┤
├─SHUTDOWN─┤ Shutdown ├──────┤
├─SIGNON─────────────────────┤
├─SUB────────────────────────┤
├─UNLOCKmon──────────────────┤
└─VTRACE─┬─────┬─────────────┘
├─ON──┤
└─OFF─┘
Shutdown:
├──┬─NOW─────────────────────────────────────────────────┬───────┤
├──┬────┬─num1─┬─WARN─┬──────┬──┬─────────────────────┤
│ └─IN─┘ │ └─num4─┘ │ │
│ └─NOWARN─────────┘ │
├──┬────┬─tod1─┬─WARN─┬──────┬──┬─────────────────────┤
│ └─AT─┘ │ └─num4─┘ │ │
│ └─NOWARN─────────┘ │
├─┬─────────────────────────────────────────────────┬─┤
│ └─AFTER─┬─num2─┬─BY─┬─num3─┬──┬─WARN─┬──────┬──┬──┘ │
│ └─tod2─┘ └─tod3─┘ │ └─num4─┘ │ │
│ └─NOWARN─────────┘ │
├─NOWARN──────────────────────────────────────────────┤
└─CANCEL──────────────────────────────────────────────┘

nnn is a numeric value between 1 and 257. If specified as 1 through


256, the Monitor pause limit is set to the specified value. If
specified as 257, the Monitor pause limit is disabled. is disabled.
(The pause limit is described in the Advantage CA-Roscoe
Interactive Environment Extended Facilities for System Programmers
Guide.)
ABEND causes Advantage CA-Roscoe to terminate with a user 998 abend.

2-82 System Commands Guide


2.15 ROZAP

DISABLE disables the use of a Advantage CA-Roscoe command. Specify:


command
1-to-8 character Advantage CA-Roscoe command.
Command abbreviations are not valid for this operand
unless the abbreviation is not the first 1 or 3 characters
of the command.
DUMP causes an SVC dump to be taken of the Advantage CA-Roscoe
address space; Advantage CA-Roscoe continues execution after
the dump is requested.

ENABLE enables the use of a Advantage CA-Roscoe command. Specify:


command
1-to-8 character Advantage CA-Roscoe command.
Command abbreviations are not valid for this operand
unless the abbreviation is not the first 1 or 3 characters
of the command.
FLUSH causes the designated user or logical unit to be forced off.
(Comparable to the operator's FLUSH command.) Specify:
KEY=key is the sign-on key of user to be forced off.
ID=id is the internal logical line number (as given in the
STATUSX command) of user to be forced off.
LU=lu is the name of logical unit for which a CLSDST is to
be issued.
F causes the designated user/unit to be forced off
regardless of the activity occurring.
If omitted, the user to be flushed is observed for 10
seconds to determine if there is any activity. If there
is, FLUSH is ignored. If there is no activity, the
FLUSH is attempted.
If FLUSH refers to a terminal for which a VTAM I/O operation is
in progress, Advantage CA-Roscoe attempts to halt the operation
by means of an asynchronous reset. If the reset fails, FLUSH
cannot be performed.
LOCK mon is the name of the Monitor routine whose use is to be prohibited.
Identify the Monitor routine with the first three characters of its
name.
| NOSignon prevents users from signing on to Advantage CA-Roscoe.
(Comparable to the operator's NOSIGNON command.)
NOSUB causes the SUBMIT command to be disabled. (Comparable to the
operator's NOSUBMIT command.)

Chapter 2. System Commands 2-83


2.15 ROZAP

| PRELOAD Reloads a module that was preloaded during Advantage


| CA-Roscoe initialization by the PRELOAD= SYSIN parameter.
| module The name of the preloaded module to be reloaded
| (required).
REFRESH UPS
updates the member UPS.KEYTABLE and rebuilds a
memory-resident key table. (Comparable to the operator's
REFRESH UPS command.)

RELOAD mon is the name of the Monitor routine that is to be reloaded. (If
the Monitor is locked, it is automatically unlocked.) Identify
the routine with the first three characters of its name. The
routine may be reloaded even if it is not included in the
current Advantage CA-Roscoe execution. It may not be
currently in use.
Do not reload any command with an attribute of V (for
example ETC or DOC).
Note: The monitor to be reloaded must be defined with a
RUN= in the Advantage CA-Roscoe initialization
parameters.
SHUTDOWN causes Advantage CA-Roscoe execution to terminate. One of
the following operands must be specified. (Comparable to the
operator's SHUTDOWN command.)
NOW shuts down Advantage CA-Roscoe
immediately.
IN num1 is the number of hours or minutes to wait
before shutdown processing starts. The value
must be specified with an H (for hours) or M
(for minutes), as in: 2H or 60M.
AT tod1 is the time of day when Advantage
CA-Roscoe is to shutdown. The time is based
on a 24-hour clock and should be specified in
the form: hh:mm.
AFTER num2 is the number of hours or minutes to wait
before checking for signed on terminals.
AFTER tod2 is the time of day when Advantage
CA-Roscoe is to begin checking for signed on
terminals.
If AFTER is omitted, Advantage CA-Roscoe
begins checking immediately.
BY num3 is the number of hours or minutes to wait
before beginning shutdown processing.

2-84 System Commands Guide


2.15 ROZAP

BY tod3 is the time of day when Advantage


CA-Roscoe is to shutdown.
WARN causes warning messages to be sent to user
terminals at calculated intervals. Qualify with:
num4 is the amount of time between
warning messages. Use either H (for
hours) or M (for minutes) with the
value.
NOWARN prohibits warning messages from being sent
to user terminals.

CANCEL prevents a previously scheduled shutdown from occurring.


SIGNON permits users to sign on to Advantage CA-Roscoe.
(Comparable to the operator's SIGNON command.)
SUB causes the SUBMIT command to be reenabled. (Comparable to
the operator's SUBMIT command.)
UNLOCK mon is the name of a previously LOCKed Monitor routine that is to
be enabled. Identify the routine with the first three characters
of its name.
VTRACE controls the display of the RCS666I message. With no
operand, the default is ON. Qualify with:
ON writes the message to the console when error return
codes indicate transmission problems.
OFF prevents the message from being written to the
console.

NOTES: Additional information about using this command:


■ The use of this command is restricted to the individuals having operator
privileges.
■ Using SHUTDOWN:
See the description of the operator SHUTDOWN command for additional
information about using this operand.

Chapter 2. System Commands 2-85


2.16 RPS Commands For ACA

2.16 RPS Commands For ACA


SUMMARY: Commands that may be issued by individuals designated as an
Alternate Control Account (ACA) for one or more printing locations:
PRINT CANCEL Cancels: 1) one or all print requests for a specific user at
a designated printing location, or 2) all or a class of
requests directed to a specific location.
PRINT HOLD Holds: 1) one or all print requests for a specific user at a
designated printing location, or 2) all or a class of
requests directed to a specific location. It can also be
used to control access to and from the print request
queue.
PRINT MOD Assigns an alias to a printing location.
PRINT RELEASE Frees: 1) one or all print requests for a specific user at a
designated printing location or 2) all or a class or
requests directed to a specific location. It can also be
used to control access to and from the print request
queue.
PRINT ROUTE Changes the printing location for: 1) all requests
associated with a specific location or another location, or
2) one or more requests belonging to a specific user.

NOTES: To use the ROSCOE Printing Services (RPS), your site must define
one or more printing network environments. An environment consists of all
terminals authorized to use RPS and all printers assigned to printing locations
that are accessible to those terminals. See the Advantage CA-Roscoe Interactive
Environment System Reference Guide for additional information.

When defining each printing location, your site has the option of assigning
Alternate Control Account (ACA) privileges to one or more individuals. People
assign these privileges may issue the commands described in this section for
the printing location(s) to which they are associated.

2-86 System Commands Guide


2.16 RPS Commands For ACA

2.16.1 PRINT CANCEL (For ACA)


FUNCTION: Cancels:
■ one or all print requests for a specific users at a designated printing
location, or
■ all or a class of requests directed to a specific location.

SYNTAX:

PRINT CANCEL (For ACA) Command


──Print──CANcel──Dest destname──┬─request─────────────┬───────
└──┬─────────┬─SYSTEM─┘
└─Class v─┘

Dest destname is the name of the printing location at which the outstanding
print requests are to be cancelled.
request is the request to be terminated, specified as:
tag is the name assigned by the user to the request.
number
is the number assigned by Advantage CA-Roscoe to
the request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the
command fits on a single line. Optionally, the request(s) may
be bound by parentheses.
The requests are assumed to belong to the user signed on
unless the name or number begins with the owner's prefix.
pfx.* causes all of the outstanding print requests scheduled
by the owner of the designated prefix to be cancelled.
Class v is the number of a printer class. All of the outstanding print
requests for that class are terminated at the designated
printing location. If omitted, all classes for the designated
destination are affected.
System causes all outstanding requests at the designated printing
location to be cancelled.

Chapter 2. System Commands 2-87


2.16 RPS Commands For ACA

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, CANCEL as C or CAN, DEST as
D or DES, CLASS as C or CLA, and SYSTEM as S or SYS.
■ ACA Information:
An individual with ACA authorization can cancel outstanding print
requests at the printing location(s) to which that individual's prefix is
assigned.
■ Multiple Matching Requests:
If you specify a tag and there are multiple requests with the same tag, the
first matching request is cancelled.
■ Using PRINT CANCEL:
– This is not a privileged command. It does, however, use the privileged
operands SYSTEM, pfx.request and pfx.*.
– If a request affected by the PRINT CANCEL command is:
— On the print request queue, the request is deleted from the queue.
— Printing when the command is entered, printing stops after the
current buffer is printed, request is terminated and the next
available request is selected for printing.
– All pending copies of the affected print requests are cancelled.
■ Error Handling:
If an error occurs when a list of requests is being terminated, requests up
to the request in error are terminated; the request in error and any
subsequent requests are not terminated.

EXAMPLES: Examples illustrating the use of this command:


■ To cancel all outstanding class 3 print requests at location LOC99:
PRINT CANCEL DEST LOC99 CLASS 3 SYSTEM
■ To cancel all outstanding print requests associated with the user whose
prefix is ABC at location LOC99:
PRINT CANCEL DEST LOC99 ABC.

2-88 System Commands Guide


2.16 RPS Commands For ACA

2.16.2 PRINT HOLD (For ACA)


FUNCTION: Holds:
■ one or all print requests for a specific user at a designated printing
location, or
■ all or a class of requests directed to a specific location.

It can also control, by printing location, access to and from the print request
queue.

SYNTAX

PRINT HOLD (For ACA) Command


──PRINT Hold──┬─Dest destname─┬─request─────────────┬──┬──────
│ └──┬─────────┬─System─┘ │
│ └─Class v─┘ │
└─Dest(destname─┬─IN────┬─)──────────────┘
├─OUT───┤
└─INOUT─┘

Dest destname is the name of the printing location at which the print requests
are to be held.
request is the request to be held, specified as:
tag is the name assigned by the user to the request.
number
is the number assigned by Advantage CA-Roscoe to
the request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the
command fits on a single line. Optionally, the request(s) may
be bound by parentheses.
The requests are assumed to belong to the user signed on
unless the name or number begins with the owner's prefix.
pfx.* causes all of the outstanding print requests scheduled
by the owner of the designated prefix to be held.
Class v is the number of a printer class. All of the outstanding print
requests for that class are held at the designated printing
location. If omitted, all classes for the designated destination
are affected.
System causes all outstanding requests at the designated printing
location to be held.
IN prevents any further requests for the designated destination
from being placed on the print request queue; queued
requests continue to print.

Chapter 2. System Commands 2-89


2.16 RPS Commands For ACA

OUT allows requests for the designated destination to be placed on


the print request queue; queued requests are not printed.

INOUT prevents further requests for the designated location from


being accepted; queued requests are not printed.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, HOLD as H or HOL, DEST as D
or DES, CLASS as C or CLA, and SYSTEM as S or SYS.
■ ACA Information:
An individual with ACA authorization can hold outstanding print requests
at the printing location(s) to which that individual's prefix is assigned.
■ Multiple Matching Requests:
If you specify a tag and there are multiple requests with the same tag, the
first matching request is held.
■ Using PRINT HOLD:
– This is not a privileged command. It does, however, use the privileged
operands SYSTEM, IN, OUT, INOUT, pfx.request and pfx.*.
– If a request affected by the PRINT HOLD command is printing when
the command is entered, printing stops and the request is placed at the
bottom of the hold queue.
– All pending copies of the affected print requests are held.
■ Using IN, OUT and INOUT:
The IN, OUT and INOUT operands can be used to control the requests to
be:
1. placed on the print request queue, and
2. selected for printing from the queue.
If used, the name of the printing destination to be affected and the
operand must be enclosed by parentheses (for example, DEST (LOC1 IN)).
■ Error Handling:
If an error occurs when a list of requests is being held, requests up to the
request in error are held; the request in error and any subsequent requests
are not held.

2-90 System Commands Guide


2.16 RPS Commands For ACA

EXAMPLES: Examples illustrating the use of this command:


■ To rearrange the print requests designated for a specific printing location:
PRINT HOLD DEST LOC1 SYSTEM
PRINT RELEASE AA.128 TOP
PRINT RELEASE DEST LOC1 SYSTEM
First, all outstanding print requests for printing location LOC1 are held.
Then, the appropriate print request is released (placed at the bottom of the
print request queue). Finally, the remaining requests for that location are
released. They are placed at the bottom of the queue (after AA.128) with
their original relative order unchanged.
■ To stop accepting requests directed to the destination LOC12:
PRINT HOLD DEST (LOC12 IN)
■ To stop selecting requests for printing at the destination LOC5:
PRINT HOLD DEST (LOC5 OUT)

2.16.3 PRINT MOD (For ACA)


FUNCTION: Assigns an alias to a printing location.

SYNTAX

PRINT MOD (For ACA) Command


──PRINT MOD──┬─Dest string1 TO string2─┬──────────────────────
└─REStore string3─────────┘

Dest string1 is the name of the printing location that is to be assigned


an alias.
TO string2 is the alias to be assigned to the location. It must be a
valid location defined by the site.
REStore string3 is the name of the printing location whose alias is to be
removed.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, and DEST as D.
■ The alias remains in effect for the terminal session or until removed by the
RESTORE operand.

Chapter 2. System Commands 2-91


2.16 RPS Commands For ACA

2.16.4 PRINT RELEASE (For ACA)


FUNCTION: Frees:
■ one or all print requests for a specific user at a designated printing
location, or
■ all or a class of requests directed to a specific location.

It can also control, by printing location, access to and from the print request
queue.

SYNTAX

PRINT RELEASE (For ACA) Command


──Print Release──┬─────┬───────────────────────────────────────
└─TOP─┘
──┬─Dest destname─┬─request─┬─────┬─────┬──┬───────────────────
│ │ └─TOP─┘ │ │
│ └──┬─────────┬─System─┘ │
│ └─Class v─┘ │
└─Dest(destname─┬─IN────┬─)──────────────┘
├─OUT───┤
└─INOUT─┘

TOP causes printing to resume with the first line of the first page
of the request.
If specified first, all released requests resume printing with the
first line of the first page.
If specified after a request, only that request resumes with the
first line of the first page.
Dest destname is the name of the printing location at which the print requests
are to be released.
request request(s) to be released, specified as:
tag is the name assigned by the user to the request.
number
is the number assigned by Advantage CA-Roscoe to
the request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the
command fits on a single line. Optionally, the request(s) may
be bound by parentheses.
The requests are assumed to belong to the user signed on
unless the name or number begins with the owner's prefix.
pfx.* causes all of the outstanding print requests scheduled
by the owner of the designated prefix to be released.

2-92 System Commands Guide


2.16 RPS Commands For ACA

Class v is the number of a printer class. All of the outstanding print


requests for that class are freed at the designated printing
location. If omitted, all classes for the designated destination
are affected.
System causes all outstanding requests at the designated printing
location to be released.
IN places requests for the designated destination on the print
request queue.
OUT makes queued requests for the designate destination available
for printing.
INOUT places requests for the designated location on the print request
queue; makes queued requests available for printing.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, RELEASE as R or REL, DEST as D
or DES, CLASS as C or CLA, and SYSTEM as S or SYS.
■ ACA Information:
An individual with ACA authorization can free outstanding print requests
at the printing location(s) to which that individual's prefix is assigned.
■ Multiple Matching Requests:
If you specify a tag and there are multiple requests with the same tag, the
first matching request is released.
■ Using PRINT RELEASE:
– This is not a privileged command. It does, however, use the privileged
operands SYSTEM, IN, OUT, INOUT, pfx.request and pfx.*.
– Released requests are placed at the bottom of the request queue.
– All pending copies of the affected print requests are freed.
■ Using IN, OUT and INOUT:
The IN, OUT and INOUT operands can be used to control the requests to
be:
1. placed on the print request queue, and
2. selected for printing from the queue.
If used, the name of the printing destination to be affected and the
operand must be enclosed by parentheses (for example, DEST (LOC1 IN)).
■ Error Handling:
If an error occurs when a list of requests is being released, requests up to
the request in error are released; the request in error and any subsequent
requests are not released.

Chapter 2. System Commands 2-93


2.16 RPS Commands For ACA

EXAMPLES: Examples illustrating the use of this command:


■ To release all held print requests at location LOC1 and have printing
resume with the first line of the first page of any request that might have
been printing when the PRINT HOLD command was issued:
PRINT RELEASE TOP DEST LOC1 SYSTEM
■ To release four print requests where two belong to the user signed on (no
prefix is specified) and to have only those two resume printing with the
first line:
PRINT RELEASE AB.128 PX.27 327 TOP 329 TOP
■ To start accepting requests from the destination LOC1:
PRINT RELEASE DEST (LOC1 IN)
■ To accept and select for printing the requests from the destination LOC5:
PRINT RELEASE DEST (LOC5 INOUT)

2.16.5 PRINT ROUTE (For ACA)


FUNCTION: Changes the printing location for: 1) all requests associated with a
specific location to another location, or 2) one or more requests belonging to a
specific user.

SYNTAX

PRINT ROUTE (For ACA) Command


──Print ROUte──┬─System Dest destnamem─┬──TO──destname────────
└─request───────────────┘

Dest destname name of the printing location where the print requests are
currently held.
TO destname name of the printing location to which the held requests are to
be routed.
request request(s) to be rerouted, specified as:
tag Name assigned by user to the request.
number
Number assigned by Advantage CA-Roscoe to the
request. Leading zeros are not required.
A maximum of 12 requests can be specified, provided that the
command fits on a single line. Optionally, the request(s) may
be bound by parentheses. The requests are assumed to belong
to the user signed on unless a prefix is specified.
pfx.* All of the outstanding print requests scheduled by
the owner of the designated prefix are to be rerouted.

2-94 System Commands Guide


2.16 RPS Commands For ACA

NOTES: Additional information about using this command:


■ The PRINT ROUTE command is not a privileged command. It does,
however, contain the privileged operands SYSTEM, pfx.request and pfx.*.
■ An individual granted alternate RPS control authorization can only route
outstanding print requests from printing location(s) to which that
individual's prefix is assigned. The individual can route to any valid
printing location.
■ A print request must be held before it can be rerouted to another printing
location. The request is automatically released when it is rerouted.
■ If a tag is specified and there are multiple requests with the same tag, the
first matching request is rerouted.
■ If a request affected by the PRINT ROUTE command is printing when the
command is entered, the command is ignored.
■ If an error occurs when a list of requests is being rerouted, requests up to
the request in error are rerouted; the request in error and any subsequent
requests are not.

EXAMPLES: Examples illustrating the use of this command:


■ To change the destination of a request from PS128 to RS97:

PRINT HOLD AA.128


PRINT ROUTE SYSTEM DEST PS128 TO RS97 AA.128
A print request must be held before it can be rerouted to another printing
location.

Chapter 2. System Commands 2-95


2.17 RPS Commands For Privileged Users

2.17 RPS Commands For Privileged Users


SUMMARY: Commands that may be issued by individuals assigned RPS
privileges:
PRINT CANCEL Cancels: 1) one or all requests for a specific user, 2) all
requests, or 3) all or a class of requests at a designated
printing location.
PRINT HOLD Holds: 1) one or all requests for a specific user, 2) all
requests, or 3) all or a class of requests at a designated
printing location. It can also be used to control access to
and from the print request queue.
PRINT MOD Defines the current printing location.
PRINT RELEASE Frees: 1) one or all requests for a specific user, 2) all
requests, or 3) all or a class of requests at a designated
printing location. It can also be used to control access to
and from the print request queues.
PRINT RESTART Use to: 1) restart locations that have printers which have
been previously disabled, or 2) stop and start the RPS
subtask.
PRINT ROUTE Changes the printing location for: 1) all requests, or 2)
one or more requests belonging to a specific user.
PRINT START Restarts the RPS subtask.
PRINT STATUS Displays information about: 1) RPS, and 2) outstanding
print requests.
PRINT STOP Terminates the RPS subtask.

2.17.1 PRINT CANCEL (For Privileged Users)


FUNCTION: Cancels:
■ one or all print requests for a specific users,
■ all requests, or
■ all or a class of requests directed to a specific location.

SYNTAX:

PRINT CANCEL Command


──Print Cancel──┬─request.────────────────────────────────┬───
└─System─┬─────────────────────────────┬──┘
└─ Dest destname─┬─────────┬──┘
└─Class v─┘

request is the request to be terminated, specified as:

2-96 System Commands Guide


2.17 RPS Commands For Privileged Users

tag is the name assigned by the user to the request.


number
is the number assigned by Advantage CA-Roscoe to the
request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the command
fits on a single line. Optionally, the request(s) may be bound by
parentheses.
The requests are assumed to belong to the user signed on unless the
name or number begins with the owner's prefix.
pfx.* causes all of the outstanding print requests scheduled by the
owner of the designated prefix to be cancelled.
System cancels all outstanding requests. The following operands can be used
to limit the scope of this operation.
Dest destname is the name of the printing location at which the
outstanding print requests are to be cancelled.
Class v is the number of a printer class. All of the
outstanding print requests for that class are
terminated at the designated printing location. If
omitted, all classes for the designated destination are
affected.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, CANCEL as C or CAN, DEST as
D or DES, SYSTEM as S, DEST as D or DES, and CLASS as C or CLA.
■ Multiple Matching Requests:
If you specify a tag and there are multiple requests with the same tag, the
first matching request is cancelled.
■ Using PRINT CANCEL:
– This is not a privileged command. It uses the privileged operands
SYSTEM, pfx.request and pfx.*.
– If a request affected by the PRINT CANCEL command is:
— On the print request queue, the request is deleted from the queue.
— Printing when the command is entered, printing stops after the
current buffer is printed, request is terminated and the next
available request is selected for printing.
– All pending copies of the affected print requests are cancelled.
■ Error Handling:

Chapter 2. System Commands 2-97


2.17 RPS Commands For Privileged Users

If an error occurs when a list of requests is being terminated, requests up


to the request in error are terminated; the request in error and any
subsequent requests are not terminated.

EXAMPLES: Examples illustrating the use of this command:


■ To cancel all outstanding print requests:
PRINT CANCEL SYSTEM
■ To cancel all outstanding class 3 print requests at printing location LOC99:
PRINT CANCEL SYSTEM DEST LOC99 CLASS 3
■ To cancel all outstanding print requests associated with the user whose
prefix is ABC:
PRINT CANCEL ABC.

2.17.2 PRINT HOLD (For Privileged Users)


FUNCTION: Holds:
■ one or all print requests for a specific user,
■ all requests, or
■ all or a class of requests directed to a specific location.

It can also control, by printing location, access to and from the print request
queue.

SYNTAX

PRINT HOLD Command


──Print Hold──┬─request────────────────────────────────┬──────
├─System─┬────────────────────────────┬──┤
│ └─Dest destname─┬─────────┬──┘ │
│ └─Class v─┘ │
└─Dest(destname─┬─IN────┬─)──────────────┘
├─OUT───┤
└─INOUT─┘

request is the request to be held, specified as:


tag is the name assigned by the user to the request.
number
is the number assigned by Advantage CA-Roscoe to the
request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the command
fits on a single line. Optionally, the request(s) may be bound by
parentheses.
The requests are assumed to belong to the user signed on unless the
name or number begins with the owner's prefix.

2-98 System Commands Guide


2.17 RPS Commands For Privileged Users

pfx.* causes all of the outstanding print requests scheduled by the


owner of the designated prefix to be held.
System causes all outstanding requests at the designated printing location to
be held. To limit the scope of this operation, specify:
Dest destname is the name of the printing location at which the print
requests are to be held.
Class v is the number of a printer class. All of the
outstanding print requests for that class are held at
the designated printing location. If omitted, all classes
for the designated destination are affected.
IN prevents any further requests for the designated destination from
being placed on the print request queue; queued requests continue to
print.
OUT places requests for the designated destination on the print request
queue; queued requests are not printed.
INOUT prevents further requests for the designated location from being
accepted; queued requests are not printed.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, HOLD as H or HOL, SYSTEM as
S or SYS, DEST as D or DES, and CLASS as C or CLA.
■ Multiple Matching Requests:
If you specify a tag and there are multiple requests with the same tag, the
first matching request is held.
■ Using PRINT HOLD:
– This is not a privileged command. It does, however, use the privileged
operands SYSTEM, IN, OUT, INOUT, pfx.request and pfx.*.
– If a request affected by the PRINT HOLD command is printing when
the command is entered, printing stops and the request is placed at the
bottom of the hold queue.
– All pending copies of the affected print requests are held.
■ Using IN, OUT and INOUT:
The IN, OUT and INOUT operands can be used to control the requests to
be:
1. placed on the print request queue, and
2. selected for printing from the queue.
If used, the name of the printing destination to be affected and the
operand must be enclosed by parentheses (for example, DEST (LOC1 IN)).
■ Error Handling:

Chapter 2. System Commands 2-99


2.17 RPS Commands For Privileged Users

If an error occurs when a list of requests is being held, requests up to the


request in error are held; the request in error and any subsequent requests
are not held.

EXAMPLES: Examples illustrating the use of this command:


■ To rearrange the print requests designated for a specific printing location:
PRINT HOLD SYSTEM DEST LOC1
PRINT RELEASE AA.128 TOP
PRINT RELEASE SYSTEM DEST LOC1
First, all outstanding print requests for printing location LOC1 are held.
Then, the desired print request is released (placed at the bottom of the
print request queue). Finally, the remaining requests for that location are
released. They are placed at the bottom of the queue (after AA.128) with
their original relative order unchanged.
■ To stop accepting requests directed to destination LOC12:
PRINT HOLD DEST (LOC12 IN)
■ To stop selecting requests for printing at destination LOC5:
PRINT HOLD DEST (LOC5 OUT)

2.17.3 PRINT MOD (For Privileged Users)


FUNCTION: Assigns an alias to a printing location.

SYNTAX

PRINT MOD Command


──Print MOD──┬─Dest string1 TO string2─┬──────────────────────
└─REStore string3─────────┘

Dest string1 is the name of the printing location that is to be assigned an


alias.
TO string2 is the alias to be assigned to the location. It must be a valid
location defined by the site.
REStore string3
is the name of the printing location whose alias is to be
removed.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, and DEST as D.
■ The alias remains in effect for the terminal session or until removed by the
RESTORE operand.

2-100 System Commands Guide


2.17 RPS Commands For Privileged Users

2.17.4 PRINT RELEASE (For Privileged Users)


FUNCTION: Frees:
■ one or all print requests for a specific user,
■ all requests, or
■ all or a class of requests directed to a specific location.

It can also control, by printing location, access to and from the print request
queue.

SYNTAX

PRINT RELEASE Command


──Print Release──┬─────┬───────────────────────────────────────
└─TOP─┘
──┬─request─┬─────┬────────────────────────┬───────────────────
│ └─TOP─┘ │
├─System─┬────────────────────────────┬──┤
│ └─Dest destname─┬─────────┬──┘ │
│ └─Class v─┘ │
└─Dest(destname─┬─IN────┬─)──────────────┘
├─OUT───┤
└─INOUT─┘

TOP causes printing to resume with the first line of the first page of the
request.
If specified first, all released requests resume printing with the first
line of the first page.
If specified after a request, only that request resumes with the first
line of the first page.
request is the request to be released, specified as:
tag is the name assigned by the user to the request.
number
is the number assigned by Advantage CA-Roscoe to the
request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the command
fits on a single line. Optionally, the request(s) may be bound by
parentheses.
The requests are assumed to belong to the user signed on unless the
name or number begins with the owner's prefix.
pfx.* causes all of the outstanding print requests scheduled by the
owner of the designated prefix to be released.

Chapter 2. System Commands 2-101


2.17 RPS Commands For Privileged Users

System causes all outstanding requests to be released. Use the following


operands to limit the scope of this operation:
Dest destname is the name of the printing location at which the print
requests are to be released.
Class v is the number of a printer class. All of the
outstanding print requests for that class are freed at
the designated printing location. If omitted, all classes
for the designated destination are affected.
IN places requests for the designated destination on the print request
queue.
OUT makes queued requests for the designate destination available for
printing.
INOUT places requests for the designated location on the print request queue;
makes queued requests available for printing.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, RELEASE as R or REL, SYSTEM
as S or SYS, DEST as D or DES, and CLASS as C or CLA.
■ Multiple Matching Requests:
If you specify a tag and there are multiple requests with the same tag, the
first matching request is released.
■ Using PRINT RELEASE:
– This is not a privileged command. It does, however, use the privileged
operands SYSTEM, IN, OUT, INOUT, pfx.request and pfx.*.
– Released requests are placed at the bottom of the request queue.
– All pending copies of the affected print requests are freed.
■ Using IN, OUT and INOUT:
The IN, OUT and INOUT operands can be used to control the requests to
be:
1. placed on the print request queue, and
2. selected for printing from the queue.
If used, the name of the printing destination to be affected and the
operand must be enclosed by parentheses (for example, DEST (LOC1 IN)).
■ Error Handling:
If an error occurs when a list of requests is being released, requests up to
the request in error are released; the request in error and any subsequent
requests are not released.

2-102 System Commands Guide


2.17 RPS Commands For Privileged Users

EXAMPLES: Examples illustrating the use of this command:


■ To release all held print requests at location LOC1 and have printing
resume with the first line of the first page of any request that might have
been printing when the PRINT HOLD command was issued:
PRINT RELEASE TOP SYSTEM DEST LOC1
■ To release four print requests where two belong to the user signed on (no
prefix is specified) and to have only those two resume printing from the
first line:
PRINT RELEASE AB.128 PX.27 327 TOP 329 TOP
■ To start accepting requests from the destination LOC1:
PRINT RELEASE DEST (LOC1 IN)
■ To accept and select for printing the requests from the destination LOC5:
PRINT RELEASE DEST (LOC5 INOUT)

2.17.5 PRINT RESTART (For Privileged Users)


FUNCTION: Use to:
1. restart locations that have printers which were previously disabled, or
2. stop and start the RPS subtask.

SYNTAX:

PRINT RESTART Command


──Print RESTART──┬─Dest destname───────────────────┬──────────
├─DLIST destlistname──────────────┤
├─ALL─────────────────────────────┤
│ ┌─WARM─┐ │
└─RPS─┬──────────────┬──┼──────┼──┘
└─CSECT string─┘ └─COLD─┘

Dest string1 is the name of the printing location at which the printers are
to be restarted.
DLIST destlistname
is the name of a valid destination list defined in the RPS
network. If requests are waiting to print at any of the locations
in that list, those printing locations are restarted.
ALL restarts all printing loctions defined the the RPS network that
have requests queued to print (in the ready state).
RPS restarts RPS. You can qualify this operation by specifying:
CSECT string is the name of the CSECT to be loaded. If
specified with an invalid name, RPS is
disabled (no PRINT-related is allowed until a
valid CSECT is loaded).

Chapter 2. System Commands 2-103


2.17 RPS Commands For Privileged Users

If omitted, the last definition is used (the


definition identified by either the RPSCSECT=
initialization parameter or the last
start/restart operations).
WARM causes outstanding requests to be kept on the
RPS queue.
COLD causes outstanding requests to be deleted.
This includes all previously queued requests
and associated RPS library members.
If neither COLD nor WARM is specified, the default is
WARM.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, and DEST as D.
■ Using PRINT RESTART:
The PRINT RESTART RPS form of the command is privileged. It may only
be issued by individuals having RPS priviliges.
■ When restarting destinations:
– If a location is closed or held, it remains in that state and ignored by
this command.
– If no requests are on the ready queue for printing locations to be
restarted, a message is returned saying so.
– This command is useful when requests are queued but never become
active. This occurs as the result of a previous error on the printer,
(deactivation, I/O error, and so forth.).
– When RPS is initializing with a warm start and a printer is not yet
active, requests directed to that printer remain on the queue and
simlogon errors appear on the console. If the printer is then activated,
the requests remain on the queue until another print request is
directed to the same destination or the PRINT RESTART command is
executed.
■ When stopping and starting RPS:
When PRINT RESTART RPS is issued, RPS subtask termination starts.
When STOP processing completes, START processing immediately begins.
If a user attempts to issue any PRINT-related commands while the queues
are being rebuilt, the commands are rejected with a message stating that
RPS initialization is in progress.

2-104 System Commands Guide


2.17 RPS Commands For Privileged Users

2.17.6 PRINT ROUTE (For Privileged Users)


FUNCTION: Changes the printing location for: 1) all requests or 2) one or
more requests belonging to a specific user.

SYNTAX

PRINT ROUTE Command


──Print ROUte──┬─System─┬───────────────┬──┬──TO destname─────
│ └─Dest destname─┘ │
└─request───────────────────┘

Dest destname name of the printing location where the print requests are
currently held. If DEST is omitted, all outstanding requests are
routed to the TO printing location.
TO destname name of the printing location to which the held requests are to
be routed.
request request(s) to be rerouted, specified as:
tag name assigned by user to the request.
number
Number assigned by Advantage CA-Roscoe to the
request. Leading zeros are not required.
A maximum of 12 requests can be specified, provided that the
command fits on a single line. Optionally, the request(s) may
be bound by parentheses. The requests are assumed to belong
to the user signed on unless a prefix is specified.
pfx.* All of the outstanding print requests scheduled by
the owner of the designated prefix are to be rerouted.

NOTES: Additional information about using this command:


■ The PRINT ROUTE command is not a privileged command. It does,
however, contain the privileged operands SYSTEM, pfx.request and pfx.*.
■ A print request must be held before it can be rerouted to another printing
location. The request is automatically released when it is rerouted.
■ If a tag is specified and there are multiple requests with the same tag, the
first matching request is rerouted.
■ If a request affected by the PRINT ROUTE command is printing when the
command is entered, the command is ignored.
■ If an error occurs when a list of requests is being rerouted, requests up to
the request in error are rerouted; the request in error and any subsequent
requests are not.

Chapter 2. System Commands 2-105


2.17 RPS Commands For Privileged Users

EXAMPLE: Example illustrating the use of this command:


■ To change the destination of a request from PS128 to RS97:

PRINT HOLD AA.128


| PRINT ROUTE SYSTEM DEST PS128 TO RS97
A print request must be held before it can be rerouted to another printing
location.

2.17.7 PRINT START (For Privileged Users)


FUNCTION: Allows the RPS subtask to be restarted. The subtask is reattached
with the CSECT identified by either the RPSCSECT= initialization parameter or
by this command.

SYNTAX

PRINT START Command


┌─WARM─┐
──Print START RPS──┬──────────────┬──┼──────┼─────────────────
└─CSECT string─┘ └─COLD─┘

CSECT string is the name of the CSECT to be loaded. If specified with an


invalid name, RPS is disabled (no PRINT-related is allowed
until a valid CSECT is loaded).
If omitted, the last definition is used (the definition identified
by either the RPSCSECT= initialization parameter or the last
start/restart operations).
WARM causes outstanding requests to be kept on the RPS queue.
COLD causes outstanding requests to be deleted. This includes all
previously queued requests and associated RPS library
members.

If neither COLD nor WARM is specified, the default is WARM.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT.
■ Using PRINT RESTART:
The PRINT START RPS is a privileged command. It may only be issued by
users assigned RPS privileges.
■ When starting RPS:
After the CSECT is successfully loaded, the RPS queues are rebuilt and any
requests held by the issuance of the PRINT STOP RPS or OPERATOR RPS

2-106 System Commands Guide


2.17 RPS Commands For Privileged Users

STOP command are automatically placed on the ready queue for


immediate processing.

2.17.8 PRINT STATUS


FUNCTION: Displays information about: 1) RPS, and 2) outstanding print
requests.

SYNTAX

PRINT STATUS Command


──Print Status──┬──────────────────────────────────────────┬──
├─RPS──────────────────────────────────────┤
├─ALL──────────────────────────────────────┤
├─request──────────────────────────────────┤
├─System───────────────────────────────────┤
├─┬─────────────┬──┬─────────┬──┬────────┬─┤
│ └─Dest string─┘ └─Class v─┘ └─System─┘ │
└─┬──────────┬──┬───────────┬──────────────┘
└─NOAttach─┘ └─REPly mem─┘

With no operands, acts as though PRINT STATUS ALL was entered.


The information is written to the member ZZZZZSTA which is then
attached for display.
RPS displays one of the following messages about the status of the RPS
network:
RPS PRINTING SERVICES DISABLED
or
RPS PRINTING SERVICES CURRENTLY ACTIVE.
ALL provides status information on all of the user's outstanding print
requests.
request is the request for which status information is desired, specified as:
tag is the name assigned by the user to the request.
number
is the number assigned by Advantage CA-Roscoe to the
request. Leading zeros are optional.
A maximum of 12 requests can be specified, provided the commands
fits on a single line. Optionally, the request(s) may be bound by
parentheses.
Requests are assumed to belong to the user signed on unless a prefix
is specified.
pfx.* provides status information on all outstanding print requests
for the owner of the designated prefix.

Chapter 2. System Commands 2-107


2.17 RPS Commands For Privileged Users

System provides status information on all outstanding print requests.


When used with DEST and/or CLASS, SYSTEM provides status
information for all outstanding print requests at the designated
printing location.
Dest destname is the name of the printing location for which status
information is to be provided.
If specified with SYSTEM, the information is about all print
requests at that destination. If SYSTEM is omitted, information
is provided only about the outstanding requests belonging to
the user signed on.
Class v is the number of the printer class for which status information
is to be displayed. If omitted, all printer classes are assumed.
NOAttach suppresses the display of information written to the
appropriate library member.
REPly mem is the name of the library member that is to contain the status
information. The default is ZZZZZSTA.
If the appropriate member does not exist, it is created in the
user's library. If the member exists, its contents are updated.

NOTES: Additional information about using this command:


■ Additional Abbreviations:
You may abbreviate PRINT as P or PRI, STATUS as S, SYSTEM as S or
SYS, DEST as D or DES, CLASS as C or CLA, and NOATTACH as NOA
or NOATT.
■ Using PRINT STATUS:
Neither this command nor its operands are privileged. However, the RPS
operand only has meaning to individuals having privileged userids.

2.17.9 PRINT STOP (For Privileged Users)


FUNCTION: Terminates the RPS subtask.

SYNTAX

PRINT STOP Command


──Print STOP RPS──────────────────────────────────────────────

There are no operands.

NOTES: Additional information about using this command:


■ Additional Abbreviations:

2-108 System Commands Guide


2.17 RPS Commands For Privileged Users

You may abbreviate PRINT as P or PRI,.


■ Using PRINT STOP:
This is a privileged command. It may only be issued by individuals having
RPS privileges.
■ When starting RPS:
When this command is issued, any requests currently printing are held
and all printers owned by RPS are closed. The subtask is detached and
appropriate shutdown messages are written to the console.
Users issuing the informational commands (PRINT LOCATION, PRINT
DEVICE and PRINT STATUS) receive the appropriate information. Users
issuing the commands that need subtask processing receive a message
stating that RPS is disabled.

Chapter 2. System Commands 2-109


2.18 RTF

2.18 RTF
FUNCTION: Invokes the ROSCOE Trace Facility.

SYNTAX

RTF Command
──RTF──┬─END──────────────────┬───────────────────────────────
├─HELP─────────────────┤
├─START─┬─ALL───────┬──┤
│ ├─KEY=key───┤ │
│ ├─LU=id─────┤ │
│ └─UNIT=unit─┘ │
├─STATUS───────────────┤
├─STOP─┬─ALL───────┬───┤
│ ├─KEY=key───┤ │
│ ├─LU=id─────┤ │
│ └─UNIT=unit─┘ │
└─TERMINATE────────────┘

END terminates command execution.


HELP displays RTF operands.
START activates tracing. Designate the class of users to be traced by
specifying:
ALL traces all users.
KEY=key is the sign-on key of the user to be traced.
LU=id is the ID of the terminal to be traced whenever it is
signed on to Advantage CA-Roscoe.
UNIT=unit is the ID of the unit to be traced whenever signed
on to Advantage CA-Roscoe.
STATUS displays the status of RTF, including the number of events traced
and the active trace classes.
STOP terminate tracing. Designated the class of users to be terminated
by specifying:
ALL stops tracing all users.
KEY=key is the sign-on key of the user for whom tracing is to
stop.

2-110 System Commands Guide


2.18 RTF

LU=id is the ID of the terminal for which tracing is to stop.


UNIT=unit is the ID of the unit for which tracing is to stop.
TERMINATE
terminates all RTF classes terminated and closes the RTF file.

NOTES: Additional information about using this command:


■ RTF is a Monitor command. As distributed, only the owner of the RO or
AI prefix can issue this command.
Caution
When tracing is active, RTF is entered twice for each user dispatch.
This overhead (5% to 15%) means that tracing should be used on an
exception basis, not as part of normal Advantage CA-Roscoe
procedures. RTF employs a double-buffering techniques to eliminate
performance problems caused by I/O waits.

■ If RTF is entered with:


– an operand, the operand is read and executed at once and RTF
terminates.
– no operand, the user is prompted for an operand. Prompting continues
until the END operand is entered.
■ The classes specified with START and STOP can overlay and a user can be
traced as long as at least one class is active for the user. For example,
assume the following commands were entered:
RTF START ALL
RTF START KEY=USER1
RTF STOP ALL
Tracing remains active for the user identified as USER1.

EXAMPLES: Examples illustrating the use of this command:


■ To start tracing for all users currently signed on and for all new users as
they sign on:
RTF START ALL
■ To trace Advantage CA-Roscoe whenever it is signed on:
RTF START KEY=ROSCOE
■ To trace device 1 on cluster 0 on unit 043 whenever it is signed on:
RTF START UNIT=43..1
■ To stop tracing for any user who is not included by some other tracing
specification:
RTF STOP ALL

Chapter 2. System Commands 2-111


2.19 RTM

2.19 RTM
FUNCTION: Use to:
1. Activate or deactivate monitoring.
2. Modify the list of users and/or terminals eligible for monitoring.
3. Display a list of users and terminals currently eligible for monitoring.
4. Display statistics about all or specific users and/or terminals plus
summary information about the current reporting interval.

SYNTAX:

RTM Command
──RTM──┬─ON─┬─────┬───────────────────────────┬───────────────
│ └─mem─┘ │
├─OFF──────────────────────────────────┤
│ ┌──
───────┐ │
┬─────┬┴───┬─────────┤
├─INCL─┬─KEY key──
│ │ └─key─┘ │ │
│ │ ┌──
───────┐ │ │
│ ┬─────┬┴───┤
├─PFX pfx── │
│ │ └─pfx─┘ │ │
│ │ ┌──
──────┐ │ │
│ ├─TERMID id── ┬────┬┴──┤ │
│ │ └─id─┘ │ │
│ ├─NEW─────────────────┤ │
│ └─ALL─────────────────┘ │
│ ┌──
───────┐ │
┬─────┬┴───┬─────────┤
├─EXCL─┬─KEY key──
│ │ └─key─┘ │ │
│ │ ┌──
───────┐ │ │
│ ┬─────┬┴───┤
├─PFX pfx── │
│ │ └─pfx─┘ │ │
│ │ ┌──
──────┐ │ │
│ ├─TERMID id── ┬────┬┴──┤ │
│ │ └─id─┘ │ │
│ └─NEW─────────────────┘ │
├─LIST─┬──────────┬────────────────────┤
│ └─NOAttach─┘ │
└─Display─┬───────────┬──┬──────────┬──┘
├─KEY key───┤ └─NOAttach─┘
├─PFX── pfx─┤
├─TERMID id─┤
├─ALL───────┤
└─SYStem────┘

2-112 System Commands Guide


2.19 RTM

ON activates the Response-Time Monitor and monitors all users.


ON may be qualified with:
mem is the name of the library member that identifies the
specific users/terminals to be monitored.
OFF deactivates the Response-Time Monitor.
INCL adds one or more users or terminals to those eligible for
monitoring. Specify one of the following:
KEY key is the sign-on key of the user to be monitored. A
maximum of 11 sign-on keys can be specified,
provided they fit on a single line.
PFX pfx is the prefix of the user to be monitored. A
maximum of 11 prefixes can be specified,
provided they fit on a single line.
TERMID id is the ID of the terminal to be monitored. A
maximum of 11 terminal IDs can be specified,
provided they fit on a single line.
At VTAM sites: Use the terminal's VTAM ID.
With BTAM remote 3270-type terminals: Use the
label specified on the RCSDVICE macro of the
RCSGEN. With BTAM local 3270-type terminals
and TTYs: Use the DD name specified in the
Advantage CA-Roscoe JCL.
NEW allows all new eligible users signing on to be
monitored.
ALL causes all users to be eligible for monitoring.
EXCL excludes one or more users and/or terminals from
monitoring. Specify one of the following:
KEY key is the sign-on key of the user to be excluded.
A maximum of 11 keys can be specified,
provided they fit on a single line.
PREFIX pfx is the prefix of the user to be excluded. A
maximum of 11 prefixes can be specified,
provided they fit on a single line.
TERMID id is the ID of the terminal to be excluded. A
maximum of 11 terminal IDs can be specified,
provided they fit on a single line.
At VTAM sites: Use the terminal's VTAM ID.
With BTAM remote 3270-type terminals: Use
the label specified on the RCSDVICE macro
of the RCSGEN.

Chapter 2. System Commands 2-113


2.19 RTM

With BTAM local 3270-type terminals and


TTYs: Use the DD name specified in the
Advantage CA-Roscoe JCL.
NEW prevents all new eligible users from being
monitored.

LIST places a list of all users and/or terminals currently eligible for
monitoring in the member ZZZZZRTM. The display of this
member is controlled by:
NOAttach
prevents the member from being displayed. If omitted,
the member is displayed.
DISPLAY places response-time information about all or selected users
currently signed on or summary information about the current
interval in the member ZZZZZRTM.
With no qualification, information about all users is displayed.
(This is equivalent to specifying RTM DISPLAY ALL.) The
display can be qualified by specifying one of the following:
KEY key is the sign-on key of the user about whom
response-time information is desired.
PFX pfx is the prefix of the user about whom
response-time information is desired.
TERMID id is the ID of the terminal about which
response-time information is desired.
At VTAM sites: Use the terminal's VTAM ID.
With BTAM remote 3270-type terminals: Use the
label specified on the RCSDVICE macro of the
RCSGEN.
With BTAM local 3270-type terminals and TTYs:
Use the DD name pecified in the Advantage
CA-Roscoe JCL.
ALL displays information about all users being
monitored.
SYStem displays summary information about the current
interval.
NOAttach prevents the member ZZZZZRTM from being
displayed. If omitted, the member is displayed.

NOTES: Additional information about using this command:


■ Using INCL ALL:
INCL ALL causes all users and/or terminals to be marked as eligible for
monitoring. It overrides any previously issued EXCLs.

2-114 System Commands Guide


2.19 RTM

■ Using EXCL NEW:


EXCL NEW prevents users signing on after the command is issued from
being monitored. This is useful in cases where you only want to monitor
the first x number of users that sign on, regardless of who they are.
■ Using INCL NEW:
INCL NEW can be used to permit monitoring of subsequent users signing
on.
■ RTM DISPLAY Displays:
The following screen illustrates the information provided when you enter
RTM DISPLAY or RTM DISPLAY ALL. In both cases, the display contains
information about all users being monitored.
To qualify or limit the display, use RTM DISPLAY KEY, RTM DISPLAY
PFX or RTM DISPLAY TERMID.

_ 

>
> LIB(AA.ZZZZZRTM) SCRL FUL COLS 1 73 LINE 1
> <...+....1....+....2....+....3....+....4....+....5....+....6....+....7..
=============================== T O P =================================
1 RESPONSE TIME SUMMARY AS OF 14:53:35 PRIOR LVL 14:34:58 - 14:44:58
2 USER LVL MAX RESP AVG RESP CPU TIME DISK I/O NUM CMDS NUM TRNS
3 ------------- --- -------- -------- -------- -------- -------- --------
1 2 3 4 5 6 7 8
4 JONES
5 AA K6L37Z4 CUR 1.1 1.1 .1 16 1 1
6 PRI 1.99 .78 .28 261 35 31
7 SMITH
8 XTZ K18L29 CUR NO TRANSACTIONS IN THIS INTERVAL
============================ B O T T O M ==============================

 
RTM DISPLAY
The display begins by identifying the current time at which the summary
information is provided plus the starting and ending times of the prior
interval.
1 USER: Two-line entry where the first line contains the user's sign-on
key and the second line contains the user's prefix and terminal ID.
2 LVL Two-line entry where the first line CUR, indicating the current
interval and the second line contains PRI, indicating the prior
interval.
3 MAX RESP: Maximum amount of time the user had to wait during
the current and prior interval.

Chapter 2. System Commands 2-115


2.19 RTM

4 AVG RESP: Average amount of time the user had to wait during the
current and prior interval.
5 CPU TIME: Amount of CPU time used per transaction during the
current and prior interval.
6 DISK I/O: Number of I/Os per transaction during the current and
prior interval.
7 NUM CMDS: Number of commands issued per transaction during
the current and prior interval.
8 NUM TRNS: Number of transactions during the current and prior
interval.
■ RTM DISPLAY SYSTEM Display:
As illustrated in the following screen, this command provides summary
information gathered for the current interval for all users currently signed
on and eligible for monitoring.

- 

>
> LIB(RO.ZZZZZRTM) SCRL CSR COLS 1 73 LINE 1
> <...+....1....+....2....+....3....+....4....+....5....+....6....+....7..
=============================== T O P =================================
1
2 SYSTEM RESPONSE TIME SUMMARY FROM 15:14:59 TO 15:16:39
3 1 2 3 4 5 6 7
4 TOTAL # OF PSE MAX RESP AVG RESP CPU TIME DISK I/O NUM CMDS NUM TRNS
5 --------------- -------- -------- -------- -------- -------- --------
6 1 1.1 .94 .2 32 2 2
7
8 TIME BUCKETS: < .5 < 1. < 3. < 1. < 3. > 3.
9 8 -------- -------- -------- -------- -------- --------
1  1 1   
11 .% 5.% 5.% .% .% .%
============================ B O T T O M ==============================

 
RTM DISPLAY SYSTEM
1 TOTAL # OF PSE: Number of Performance Statistics Elements in
use. (There is one PSE for each active user.)
2 MAX RESP: Maximum response time for all users being monitored.
(See Note.)
3 AVG RESP: Average response time for all users being monitored.
(See Note.)
4 CPU TIME: Total amount of CPU time used by all users being
monitored.
5 DISK I/O: Total number of I/Os for all users being monitored.

2-116 System Commands Guide


2.19 RTM

6 NUM CMDS: Total number of commands processed for all users
being monitored.
7 NUM TRANS: Total number of transactions for all users being
monitored.
8 TIME BUCKETS: Three-line entry showing: 1) the markers indicating
each time bucket, 2) the number of transactions that occurred within
the time bucket periods, and 3) the percentage of those transactions
that occurred within those periods.
Note: If the initialization parameter RTMXMIT=YES is specified, the time
includes the CPU processing time plus the data transmission time
(the time the user had to wait). If RTMXMIT is omitted or specified
as RTMXMIT=NO, only the CPU processing time is used.
■ RTM LIST Display:
The RTM LIST command writes information about the users and/or
terminals currently eligible for monitoring to the member ZZZZZRTM.

 
>
> LIB(RO.ZZZZZRTM) SCRL CSR COLS 1 73 LINE 1
> <...+....1....+....2....+....3....+....4....+....5....+....6....+....7..
=============================== T O P =================================
1 ========== EXCLUDED USERS ==========
2 ========== INCLUDED USERS ==========
3 KEYS:
4  ALL 
5 PREFIXES:
6 TERMINAL IDS:
============================ B O T T O M ==============================

RTM LIST Display


The displayed member is divided into two segments. The first segment
(labeled == EXCLUDED USERS ==) identifies who is excluded from
monitoring. The second segment (labeled == INCLUDED USERS==)
identifies who is eligible for monitoring.
Each segment identifies the individual's by KEY, PREFIXES, and
TERMINAL IDS.
■ Using The Response-Time Monitor:
The Response-Time Monitor allows you to monitor and record response
and resource usage statistics by transaction for all or selected users. The
collected information can then be viewed online or used as input to
produce batch reports.
With the statistics provided by the Response-Time Monitor, you can:
– Determine response problems
– Do performance tuning.
– Do long-range capacity planning.
The Response-Time Monitor includes:

Chapter 2. System Commands 2-117


2.19 RTM

– The RTM command and the OPERATOR RTM command.


– Advantage CA-Roscoe initialization parameters.
Use these parameters to: 1) control whether monitoring is to be
activated when Advantage CA-Roscoe is initially started, and 2)
change default values used in calculating the statistics. The parameters
are described in the Advantage CA-Roscoe Interactive Environment
Programs and Utilities Guide.
– A Advantage CA-Earl report.
Advantage CA-Earl produces a report showing: 1) summary
information, 2) individual/terminal statistics, and 3) system statistics.
Advantage CA-Earl is also described in the Advantage CA-Roscoe
Interactive Environment Programs and Utilities Guide.
■ Library Member Requirements:
The library member named with the RTM command and the Advantage
CA-Roscoe initialization parameter RTMLIB identifies the users and/or
terminals to be monitored. The member can contain any combination of
the following statements:
INCLUDE-ALL Monitor all users or terminals unless specifically
excluded by subsequent statements.
INCLUDE-KEY Identify the users to be monitored by their sign-on
keys immediately after this statement. Specify one
sign-on key per line.
INCLUDE-PFX Identify the users to be monitored by their prefixes
immediately after this statement. Specify one prefix
per line.
INCLUDE-TERMID Identify the terminals to be monitored by their ID
immediately after this statement. Specify one
terminal id per line.
EXCLUDE-KEY Identify the users not to be monitored by their
sign-on keys immediately after this statement.
Specify one sign-on key per line.
EXCLUDE-PFX Identify the users not to be monitored by their
prefixes immediately after this statement. Specify
one prefix per line.
EXCLUDE-TERMID Identify the terminals not to be monitored by their
IDs immediately after this statement. Specify one
terminal ID per line.
Each control statement must begin in the first position of a line and be the
only statement on the line. Each sign-on key, prefix and terminal ID must
also begin in the first position of a line and be the only entry on the line.
When TERMID is used:

2-118 System Commands Guide


2.19 RTM

– With VTAM, use the terminal's VTAM ID.


– With BTAM remote 3270-type terminals, use the label specified on the
RCSDVICE macro of the RCSGEN.
– With BTAM local 3270-type terminals and TTYs, use the DD name
specified in the Advantage CA-Roscoe JCL.
A library member may contain a maximum of 72 sign-on keys, prefixes
and terminal IDs.

Examples:
1. To monitor all Advantage CA-Roscoe users except the individual with the
sign-on key of USER2 and the individual with the prefix of USR:
INCLUDE-ALL
EXCLUDE-KEY
USER2
EXCLUDE-PFX
USR
If INCLUDE-ALL followed the two EXCLUDE statements, all users would
be eligible for monitoring. INCLUDE-ALL overrides any EXCLUDE
statements that precede it.
2. To monitor only three Advantage CA-Roscoe users:
INCLUDE-KEY
USER1
USER2
INCLUDE-PFX
US1

Chapter 2. System Commands 2-119


2.19 RTM

2-120 System Commands Guide


Index

Advantage CA-Roscoe (continued)


A Displaying (continued)
ABEND Operand (ROZAP Command) 2-82 System Status 2-78—2-81
Abends Force Users Off
Force 998 (ROZAP Command) 2-82 ROZAP Command 2-83
Force SVC Dump With No Abend (ROZAP Stopping
Command) 2-83 Operator Command 2-58, 2-59, 2-60
ACA ROZAP Command 2-84
RPS 2-89, 2-90, 2-91 With 998 Abend 2-82
Accounting Trace Facility, Command 2-110, 2-111
Activate Online Advantage CA-Roscoe/VTAM Communications
ACCT Command 2-3—2-6 Commands
Operator Command 2-42, 2-43 INTERVAL 2-44
Commands NETSTAT 2-47
ACCT 2-3—2-6 VTAM FORCINT 2-64
Operator Command 2-42, 2-43 VTAM OPENINT 2-65
Displaying VTAM START 2-65, 2-66
Accounting Buffers (ACCT VTAM STOP 2-66
Command) 2-3—2-6 VTAM STOP FORCE 2-67
Accounting Buffers (Operator VTAM STOP QUICK 2-68
Command) 2-42, 2-43 VTAM STOPINT 2-68
Accounting File Status (ACCT VTAM WARNINT 2-69
Command) 2-3—2-6 Alternate Control Account (ACA)
Accounting File Status (Operator RPS 2-89—2-91
Command) 2-42, 2-43 AM Operand (ROS Command) 2-78
Accounting Status (ACCT ANY Operand (DEBUG Command) 2-16
Command) 2-3—2-6 AREA Operand (RCSTRACE Command) 2-74
Accounting Status (Operator Arithmetic symbols (syntax diagrams) x
Command) 2-3—2-6, 2-42, 2-43 AWS
Switch Files Displaying
ACCT Command 2-3—2-6 Cache Information 2-7, 2-8, 2-9
Operator Command 2-42, 2-43 Current Configuration 2-7, 2-8, 2-9
ACCT Current Status 2-7, 2-8, 2-9
Command 2-3—2-6 Work Area Used 2-22, 2-23, 2-24
Operator Command 2-42, 2-43 AWS Command 2-7, 2-8, 2-9
ADD Operand (DEBUG Command) 2-16 AWS Operand (DMS Command) 2-22
Advantage CA-Roscoe AWS Routine
Displaying Command Syntax 2-7, 2-8, 2-9
Spool Volume Status 2-61
Storage (Using DEBUG) 2-16—2-20
Storage (Using PEEK) 2-70—2-72

Index X-1
AWS Subcommand (CONSOLE Command) 2-11 Displaying (continued)
Advantage CA-Roscoe-Allocated Spool Volume
Status 2-61
B Advantage CA-Roscoe/VTAM Status
BTAM Information 2-47
Line Error Recording Block 2-45 Advantage CA-Roscoe/VTAM Timing
Restart Device/Cluster/Line 2-49 Intervals 2-44
Stop Cluster/Line 2-63 AWS Statistics 2-7, 2-8, 2-9
BUFLEN Operand (RCSTRACE Command) 2-74 AWS Work Area Usage 2-22, 2-23, 2-24
Data Set Facility Work Area Usage 2-22, 2-23,
C 2-24
ETSO
C Operand (DEBUG Command) 2-16
Executing Application 2-31, 2-32
Cache Facility
File Allocated For Use 2-28, 2-29, 2-30
AWS
LIBCACHE Status 2-33, 2-34
Display Information 2-7—2-9
Library Facility Work Area Usage 2-22, 2-23,
CANCEL Command (ETSO) 2-26
2-24
Cancel RPS Print Request
Master Console Buffer Contents 2-11, 2-12
By Alternate Control Account 2-87, 2-88
Messages Written to Specific Console 2-15
By Privileged 2-96, 2-97
Monitor Routine Information 2-37, 2-38
CMD Subcommand (CONSOLE Command) 2-11,
MVS Master Trace Table 2-14
2-12
RPF Work Area Usage 2-22, 2-23, 2-24
CMM Subcommand (CONSOLE Command) 2-13
Sign-on Keys of Users Signed On 2-61
Comma
Storage
repeat symbol, use in xiii
Using DEBUG 2-16, 2-17, 2-18, 2-19, 2-20
CONSOLE Command 2-10
Using PEEK 2-70, 2-71, 2-72
CONSOLE Routine
Terminals Signed On 2-61
Command Syntax 2-10
UCB Addresses of Active Consoles 2-14
DMS Command 2-22, 2-23, 2-24
D DMS Routine
D Operand (DEBUG Command) 2-18 Command Syntax 2-22, 2-23, 2-24
D ROSCOE Command (Unicenter CA-Look DSF Operand (DMS Command) 2-22
Command) 2-35, 2-36 DUMP Operand (ROZAP Command) 2-83
Data Set Facility
Display Work Area Used 2-22, 2-23, 2-24
Deallocate ETSO Files 2-27
E
ENABLE
DEBUG Command 2-16—2-20
Operator Command 2-43
Debugging
Use of Advantage CA-Roscoe Commands 2-43
Own Code 2-16, 2-17, 2-18, 2-19, 2-20
ENABLE Operand (ROZAP Command) 2-83
Default values (syntax diagrams) xiv
END Subcommand
DELETE Operand (DEBUG Command) 2-19
CONSOLE Command 2-13
Delimiters
ETSO
syntax diagrams, use in xi
Commands
DISABLE
CANCEL 2-26
Operator Command 2-43
FREE 2-27
Use of Advantage CA-Roscoe Commands 2-43
QUERY ALLOCATE 2-28, 2-29, 2-30
DISABLE Operand (ROZAP Command) 2-83
QUERY CALL 2-31, 2-32
Displaying
Deallocate ETSO Files 2-27
Accounting Information
Displaying
ACCT Command 2-3, 2-4, 2-5, 2-6
Allocated File Status 2-28, 2-29, 2-30
Operator Command 2-42, 2-43
Executing Application 2-31, 2-32

X-2 System Commands Guide


ETSO (continued)
Terminate Executing Applications M
CANCEL 2-26 Master Trace Table, Displaying 2-14
EXCL Operand (RTM Command) 2-113 MESSAGES (Operator Command) 2-46
Messages, Send/Receive
Operator 2-46
F MONITOR Command 2-37, 2-38
FLUSH MONITOR Routine
Operator Command 2-44 Command Syntax 2-37, 2-38
ROZAP Command 2-83 Display Information About 2-37, 2-38
Force Users Off Advantage CA-Roscoe MTT Subcommand (CONSOLE Command) 2-14
Operator Command 2-44 MVS
ROZAP Command 2-83 Display Master Trace Table 2-14
FREE Command 2-27

N
H NAME Operand (DEBUG Command) 2-20
Holding NETSTAT (Operator Command) 2-47
RPS Print Request NEW Operand (DEBUG Command) 2-20
By Alternate Control Account 2-89, 2-90, 2-91 NOAWS Subcommand
By Privileged 2-98, 2-99, 2-100 CONSOLE Command 2-14
NODE Operand (RCSTRACE Command) 2-74
NOM(Operator Command) 2-46
I NOROSLOG (Operator Command) 2-50
ID Operand (RCSTRACE Command) 2-73 NOSDUMP Operand (DEBUG Command) 2-20
INCL Operand (RTM Command) 2-53, 2-113 NOSEND (Operator Command) 2-56
INTERVAL (Operator Command) 2-44 NOSIGNON
Operator Command 2-60
K ROZAP Command Operand 2-83
NOSUB Operand (ROZAP Command) 2-83
KEY Operand
NOSUBMIT (Operator Command) 2-63
DMS Command 2-22
NOSUBTST Operand (DEBUG Command) 2-20
ROS Command 2-78
Keytable (UPS)
Refresh 2-48 O
Keywords (syntax diagrams) x OFF (Operator Command) 2-47
ONLY Operand (DEBUG Command) 2-20
L Operator
Commands, Execute
LAST Operand (DEBUG Command) 2-19
Advantage CA-Roscoe-Specific 2-39
LERPRT (Operator Command) 2-45
CONSOLE CMD 2-11, 2-12
LIB Operand (DMS Command) 2-22
CONSOLE CMM 2-13
LIBCACHE Command 2-33, 2-34
Displaying
Libraries, user
Messages to Specific Consoles 2-15
Cache Facility 2-33, 2-34
UCB Addresses of Consoles 2-14
Library Facility
Send Messages
Display Work Area Used 2-22, 2-23, 2-24
To All Users 2-56
LOCK Operand (ROZAP Command) 2-83
To One or More Users 2-55
LOOK Routine
To Specific Users 2-57
D ROSCOE Command, Description 2-35, 2-36

Index X-3
P RCS
Trace Facility 2-73—2-75
Parentheses RCSTRACE Command 2-73, 2-74, 2-75
syntax diagrams, use in xi RDM (RPF Data Management)
PEEK Function (RPF) 2-70—2-72 DMS Command 2-22
PRELOAD REFRESH UPS
ROZAP Command Operand 2-84 Operator Command 2-48
PRINT CANCEL Command ROZAP Command Operand 2-84
ACA 2-87, 2-88 Release
Privileged 2-96, 2-97 RPS Print Request
PRINT HOLD Command By Alternate Control Account 2-92, 2-93
ACA 2-89—2-91 By Privileged 2-101—2-103
Privileged 2-98—2-100 RELOAD Operand (ROZAP Command) 2-84
PRINT MOD Command Reroute RPS Print Request
ACA 2-91 By Alternate Control Account 2-94, 2-95
Privileged 2-100 By Privileged 2-105
PRINT RELEASE Command Response-Time Monitor
ACA 2-92, 2-93 Operator Command 2-52—2-54
Privileged 2-101—2-103 Response-Time Monitor (RTM)
PRINT RESTART Command Command 2-112—2-118
Privileged 2-103, 2-104 Description 2-117
PRINT ROUTE Command Information Displayed, Sample 2-115
ACA 2-94, 2-95 Library Member Requirements 2-118
Privileged 2-105 RTM Command 2-112—2-118
PRINT START Command RESTART (Operator Command) 2-49
Privileged 2-106 Restarting
PRINT STATUS Command RPS
Privileged 2-107, 2-108 Operator Command 2-50, 2-51
PRINT STOP Command PRINT RESTART Command 2-103, 2-104
Privileged 2-108 Starting
Privileged Commands RPS 2-50
Enable/Disable 2-2 ROS Command 2-78—2-81
Problems ROS Routine
Debugging Own Code 2-16—2-20 Command Syntax 2-78—2-81
Programs ROSLOG (Operator Command) 2-50
comma ROZAP Command 2-82—2-85
repeat symbol, use in xiii RPS
parentheses ACA Commands
syntax diagrams, use in xi PRINT CANCEL 2-87, 2-88
punctuation PRINT HOLD 2-89—2-91
syntax diagrams, use in x PRINT MOD 2-91
Punctuation marks (syntax diagrams) x PRINT RELEASE 2-92, 2-93
PRINT ROUTE 2-94, 2-95
Q Assign Alias To Print Location
ACA Command 2-91
QUERY ALLOCATE Command (ETSO) 2-28—2-30
Privileged Command 2-100
QUERY CALL Command (ETSO) 2-31, 2-32
Cancel Requests
ACA Command 2-87, 2-88
R Privileged Command 2-96, 2-97
Hold Requests
ACA Command 2-89—2-91
Privileged Command 2-98—2-100

X-4 System Commands Guide


RPS (continued) Sign On (continued)
Privileged Commands Enable (continued)
PRINT CANCEL 2-96, 2-97 ROZAP Command 2-85
PRINT HOLD 2-98—2-100 SIGNON
PRINT MOD 2-100 Operator Command 2-60
PRINT RELEASE 2-101, 2-102, 2-103 ROZAP Command Operand 2-85
PRINT RESTART Command 2-103, 2-104 SIZE Operand (DEBUG Command) 2-20
PRINT ROUTE 2-105 SPACE Operand (DEBUG Command) 2-20
PRINT START Command 2-106 SPIE Operand (DEBUG Command) 2-20
PRINT STATUS Command 2-107, 2-108 SPOOL (Operator) Command 2-61
PRINT STOP Command 2-108 Spool Volume Status, Displaying 2-61
Release Requests Starting
ACA Command 2-92, 2-93 Accounting Facility
Privileged Command 2-101—2-103 ACCT Command 2-3—2-6
Reroute Requests Advantage CA-Roscoe/VTAM
ACA Command 2-94, 2-95 Communications 2-65, 2-66
Privileged Command 2-105 RPS
Restart Operator Command 2-50, 2-51
Operator Command 2-50, 2-51 PRINT START Command 2-106
PRINT RESTART 2-103, 2-104 STATUS
Start CONSOLE subcommand 2-14
Operator Command 2-50, 2-51 Operator Command 2-61
PRINT START Command 2-106 STATUS Command
Stop RCSTRACE Operand 2-74
Operator Command 2-50, 2-51 Status Of
PRINT STOP Command 2-108 Accounting Subsystem 2-3—2-6
RPS RESTART (Operator Command) 2-50, 2-51 Advantage CA-Roscoe
RPS START (Operator Command) 2-50, 2-51 System Information 2-78, 2-79, 2-80, 2-81
RPS STOP (Operator Command) 2-50, 2-51 Advantage CA-Roscoe/VTAM 2-47
RTF Command 2-110, 2-111 AWS 2-7, 2-8, 2-9
RTM ETSO
Operator Command 2-52—2-54 Allocated Files 2-28
Executing Applications 2-31, 2-32
Library Cache Facility 2-33, 2-34
S Lines/Terminals Signed On 2-61
SDUMP Operand (DEBUG Command) 2-20 RPS And Print Requests 2-107, 2-108
SEND (Operator Command) 2-55 UCB Addresses 2-14
SEND ALL (Operator Command) 2-56 STATUSX (Operator Command) 2-61
SEND KEY (Operator Command) 2-57 STOP (Operator Command) 2-63
Sending Messages Stopping
To One or More Users Advantage CA-Roscoe
Operator 2-55 Operator Command 2-58—2-60
SET PRIVILEGE Command 2-2 ROZAP Command 2-84
SHUTDOWN With 998 Abend 2-82—2-85
Operator Command 2-58—2-60 Advantage CA-Roscoe/VTAM Communications
ROZAP Command Operand 2-84 VTAM STOP (Operator Command) 2-66
Sign On VTAM STOP FORCE (Operator
Disable Command) 2-67
Operator Command 2-60 VTAM STOP QUICK (Operator
ROZAP Command 2-83 Command) 2-68
Enable Applications under ETSO 2-26
Operator Command 2-60

Index X-5
Stopping (continued)
BTAM Cluster/Line 2-63 V
RPS Variables (syntax diagrams) x
Operator Command 2-50, 2-51 VTAM FORCINT (Operator Command) 2-64
PRINT STOP Command 2-108 VTAM OPENINT (Operator Command) 2-65
Users Session VTAM START (Operator Command) 2-65, 2-66
Operator FLUSH Command' 2-44 VTAM STOP (Operator Command) 2-66
Operator OFF Command' 2-47 VTAM STOP FORCE (Operator Command) 2-67
ROZAP Command' 2-83 VTAM STOP QUICK (Operator Command) 2-68
Storage VTAM STOPINT (Operator Command) 2-68
Display Contents of 2-70, 2-71, 2-72 VTAM WARNINT (Operator Command) 2-69
Displaying, Using DEBUG 2-16—2-20 VTAM/Advantage CA-Roscoe Communications
SUB Operand (ROZAP Command) 2-85 Advantage CA-Roscoe/VTAM
SUBMIT Communications 2-69
Operator Command 2-63 VTRACE Operand (ROZAP Command) 2-85
ROZAP Command 2-85
Submitting Job(s)
Disabling
X
XID Operand (RCSTRACE Command) 2-74
Operator Command 2-63
ROZAP Command 2-83
Enabling
Operator Command 2-63
ROZAP Command 2-85
SUBTST Operand (DEBUG Command) 2-20
Syntax diagrams
reading (how to) x—xv

T
TERMIN Subcommand (CONSOLE
Command) 2-15
Terminals
Display
Keys of Signed On Users 2-61
Terminal ID of Signed On Users 2-61
Flush
Operator Command 2-44
Terminate
See Stopping
Trace Facility
RTF 2-110, 2-111
TYPE Operand (ROS Command) 2-79

U
UCB Subcommand (CONSOLE Command) 2-15
UNIT Operand (ROS Command) 2-79
UNLOCK Operand (ROZAP Command) 2-85
UPS
Refresh KEYTABLE
Operator Command 2-48

X-6 System Commands Guide

You might also like