ROSCOE - B001673e - Programs and Utilities Guide

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 326

Advantage CA-Roscoe

 

Interactive Environment

Programs and Utilities 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Chapter 1. Advantage CA-Roscoe . . . . . . . . . . . . . . . . . . . . . . . . 1-1


1.1 Advantage CA-Roscoe Configuration . . . . . . . . . . . . . . . . . . . . 1-2
1.2 Executing Multiple Advantage CA-Roscoes . . . . . . . . . . . . . . . . 1-3
1.3 Providing a Batch Session . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
1.3.1 Executing a Batch Session . . . . . . . . . . . . . . . . . . . . . . . . 1-4
1.3.2 Defining Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
1.4 Startup Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.4.1 Initialization Parameter Location Definitions . . . . . . . . . . . . . 1-6
1.4.1.1 Omitting PARM= and SYSIN . . . . . . . . . . . . . . . . . . . 1-6
1.4.1.2 Using Only SYSIN . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
1.4.1.3 Using Only PARM= . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
1.4.1.4 Using Both PARM= and SYSIN . . . . . . . . . . . . . . . . . . 1-7
1.4.2 Validation and Error Recovery . . . . . . . . . . . . . . . . . . . . . 1-8
1.4.2.1 Automatic Restart . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
1.4.2.2 Operator Prompting . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
1.4.3 Console Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
1.5 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.5.1 EXEC Statement Requirements . . . . . . . . . . . . . . . . . . . . 1-11
1.5.2 Initialization Parameters . . . . . . . . . . . . . . . . . . . . . . . . 1-12
1.5.3 JES2 Dynamic Spool Pack Configuration . . . . . . . . . . . . . . 1-27
1.6 Accounting-Related Parameters . . . . . . . . . . . . . . . . . . . . . . 1-28
1.6.1 ACCTBUFF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-28
1.6.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
1.6.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
1.6.2 ACCTOPT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
1.6.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29
1.6.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29
1.6.3 ACCTREC= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
1.6.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
1.6.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
1.6.4 ACCTROS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
1.6.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
1.6.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
1.6.5 ACCTSMF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
1.6.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
1.6.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33
1.7 ATTACH JOB and DISPLAY-Related Parameters . . . . . . . . . . . 1-34

Contents iii
1.7.1 AJOB Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
1.7.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
1.7.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
1.7.2 DISAUTHO= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-34
1.7.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
1.7.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
1.7.3 NOTIFY Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
1.7.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
1.7.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
1.7.4 ROSGBL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
1.7.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
1.7.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
1.8 AWS-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
1.8.1 AWSCACHE= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-36
1.8.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
1.8.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
1.8.2 AWSDAYS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-37
1.8.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
1.8.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
1.8.3 AWSLIM= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
1.8.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
1.8.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
1.8.4 RECVRAWS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-38
1.8.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
1.8.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
1.9 Data Set-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . 1-39
1.9.1 ALLRECAL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-39
1.9.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
1.9.2 DSNBLDL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
1.9.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
1.9.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
1.9.3 DSNCFRMD= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-40
1.9.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-40
1.9.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-40
1.9.4 DSNCFRMM= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-40
1.9.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-40
1.9.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41
1.9.5 DSNCLIST= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-41
1.9.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41
1.9.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41
1.9.6 DSNCMENQ= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-41
1.9.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
1.9.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
1.9.7 DSNCMLIM= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-42
1.9.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
1.9.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
1.9.8 DSNCMLST= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-43
1.9.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-43
1.9.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-43
1.9.9 DSNCMPGM= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-43
1.9.9.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-43

iv Programs and Utilities Guide


1.9.9.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
1.9.10 DSNCNT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
1.9.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
1.9.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
1.9.11 DSNEMPTY= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-44
1.9.11.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-45
1.9.11.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-45
1.9.12 DSNINDEX= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-45
1.9.12.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-45
1.9.12.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-45
1.9.13 DSNLPRD2= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-46
1.9.13.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
1.9.13.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
1.9.14 DSNLPSWD= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-46
1.9.14.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
1.9.14.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.9.15 DSNRECAL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.9.15.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.9.15.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.9.16 ENQTYPE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.9.16.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.9.16.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.9.17 IMPASIS Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.9.17.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.9.17.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.9.18 INFRECAL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.9.18.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.9.19 LIBRCCF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
1.9.19.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
1.9.19.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
1.9.20 RECALNUM= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-49
1.9.20.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
1.9.21 RECALVOL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-50
1.9.21.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
| 1.9.22 RECALVL2= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-50
| 1.9.22.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
| 1.9.23 RECALVL3= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-51
| 1.9.23.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-51
1.10 Environment-Related Parameters . . . . . . . . . . . . . . . . . . . . 1-52
1.10.1 ACFEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
1.10.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
1.10.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
1.10.2 AUTINTVL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-52
1.10.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
1.10.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
1.10.3 AUTOFF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
1.10.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
1.10.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
1.10.4 AUTOFVAL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-53
1.10.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54

Contents v
1.10.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54
1.10.5 AUTTLOCK= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-54
1.10.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54
1.10.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54
1.10.6 AUTTLVAL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-55
1.10.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
1.10.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
1.10.7 BREAK= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
1.10.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
1.10.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-56
1.10.8 CHAR= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-56
1.10.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-56
1.10.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-56
1.10.9 CHARDFLT= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-57
1.10.9.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
1.10.9.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
1.10.10 CLLEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
1.10.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-58
1.10.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-58
1.10.11 CMDISABL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-58
1.10.11.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-58
1.10.11.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-58
1.10.12 CMQE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
1.10.12.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
1.10.12.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
1.10.13 COMCHAR= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-59
1.10.13.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
1.10.13.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
1.10.14 CRBUF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-60
1.10.14.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-60
1.10.14.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-60
1.10.15 DATEFORM= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-60
1.10.15.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-60
1.10.15.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.16 DISABLE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.16.1 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.17 END Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.17.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.17.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.18 EXTSEC= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
1.10.18.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-62
1.10.18.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-62
1.10.19 JOBEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
1.10.19.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
1.10.19.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
1.10.20 LIBEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
1.10.20.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
1.10.20.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
1.10.21 MONEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-64
1.10.21.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64
1.10.21.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64

vi Programs and Utilities Guide


1.10.22 MPL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64
1.10.22.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64
1.10.22.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64
1.10.23 MSGCLASS= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-65
1.10.23.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
1.10.23.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
1.10.24 NOLRM Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
1.10.24.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
1.10.24.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
1.10.25 NONSWAP Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-66
1.10.25.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
1.10.25.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
1.10.26 NOSDUMP Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-66
1.10.26.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
1.10.26.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
1.10.27 NOSPIE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.27.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.27.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.28 NSNAATTN= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.28.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.28.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.29 PASSWORD= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-67
1.10.29.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
1.10.29.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
1.10.30 PRVEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
1.10.30.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
1.10.30.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
1.10.31 PSCBUNIT= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-69
1.10.31.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
1.10.31.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
1.10.32 PUSHDEF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-69
1.10.32.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
1.10.32.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
1.10.33 RESHLQ= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-70
1.10.33.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-70
1.10.33.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-70
| 1.10.34 ROSGNAME= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-70
| 1.10.34.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-70
| 1.10.34.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-70
1.10.35 ROSID= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
1.10.35.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
1.10.35.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
1.10.36 RPFEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
1.10.36.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
1.10.36.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72
1.10.37 SRTDDPFX= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-72
1.10.37.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72
1.10.37.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72
1.10.38 SRTREGN= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-72
1.10.38.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72

Contents vii
1.10.38.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-73
1.10.39 SRTSTORG= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-73
1.10.39.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-73
1.10.39.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-73
1.10.40 TEST Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-73
1.10.40.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
1.10.40.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
1.10.41 UPSEXT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
1.10.41.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
1.10.41.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
1.11 ETSO-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.1 ESCAPE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.2 ETSALLOC= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
1.11.3 ETSOEPL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-76
1.11.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-76
1.11.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-76
1.11.4 ETSOEXEC= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-76
1.11.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-76
1.11.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
1.11.5 ETSOLIB= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
1.11.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
1.11.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
1.11.6 ETSOPGMS= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-77
1.11.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-77
1.11.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-78
1.11.7 ETSOSRCH= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-78
1.11.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-78
1.11.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-78
1.11.8 ETSOXIT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-78
1.11.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-79
1.11.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-79
1.11.9 ETSRPS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-79
1.11.9.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-79
1.11.9.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-79
1.11.10 ETSSLICE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-80
1.11.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-80
1.11.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-80
1.11.11 ETSSRCH= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-80
1.11.11.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-80
1.11.11.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-81
1.11.12 PRELOAD= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-81
1.11.12.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-81
1.11.12.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-81
1.11.13 PSCBUID= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-82
1.11.13.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82
1.11.13.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82
1.11.14 PSCBUSER= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-82

viii Programs and Utilities Guide


1.11.14.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-82
1.11.14.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-83
1.12 Library-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . 1-84
1.12.1 DELETE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-84
1.12.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-84
1.12.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-84
1.12.2 HELPPFX= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-84
1.12.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-84
1.12.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-85
1.12.3 HELPPFX1= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-85
1.12.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-85
1.12.4 LIBACCES= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-85
1.12.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-85
1.12.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-86
1.12.5 LIBALTER= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-86
1.12.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-86
1.12.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-86
1.12.6 LIBCACHE= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-87
1.12.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87
1.12.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87
1.12.7 LIBCFRMM= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-87
1.12.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-87
1.12.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-88
1.12.8 LIBXLIB= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-88
1.12.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-88
1.12.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-88
1.13 Monitor-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . 1-89
1.13.1 PAUSE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-89
1.13.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-89
1.13.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-89
1.13.2 RUN= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-89
1.13.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-89
1.13.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-90
1.14 Operator-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.1 CONSOLE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.2 NOPROMPT Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-91
1.14.3 ROSLOG= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-92
1.14.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-92
1.14.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-92
1.14.4 ROSMSG= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-92
1.14.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-92
1.14.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-92
1.15 RCS-Related Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . 1-93
1.15.1 NTOATTN= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-93
1.15.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-93
1.15.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-93

Contents ix
1.15.2 RCSGEN= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-93
1.15.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-93
1.15.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-94
1.15.3 RCSTRACE= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-94
1.15.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-94
1.15.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-94
1.15.4 ROSAPPL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-94
1.15.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-94
1.15.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-95
1.15.5 ROSPRTCT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-95
1.15.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-95
1.15.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-95
1.15.6 TERMSO= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-95
1.15.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-95
1.15.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-96
1.15.7 VTAM= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-96
1.15.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-96
1.15.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-96
1.15.8 XTPM= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-96
1.15.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-97
1.15.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-97
1.15.9 RCSESCCH= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-97
1.15.9.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-97
1.15.9.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-97
1.15.10 RCSESCPF= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-98
1.15.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-98
1.15.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-98
1.16 RPF-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 1-99
1.16.1 ARRAYMAX= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-99
1.16.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-99
1.16.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-99
1.16.2 BYPSRPF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-99
1.16.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-99
1.16.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-100
1.16.3 DOTPFX= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-100
1.16.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-100
1.16.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-100
1.16.4 DMFPFX= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-100
1.16.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-100
1.16.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-101
1.16.5 EXECPFX= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-101
1.16.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-101
1.16.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-101
1.16.6 LOOP= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-101
1.16.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-101
1.16.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-102
1.16.7 LOOPDFLT= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-102
1.16.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-102
1.16.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-102
1.16.8 LOOPRST= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-102
1.16.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-102

x Programs and Utilities Guide


1.16.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-103
1.16.9 Using LOOP=, LOOPDFLT= and LOOPRST=: . . . . . . . . . . 1-103
1.16.10 OFF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-103
1.16.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-103
1.16.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-104
1.16.11 ONRPF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-104
1.16.11.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-104
1.16.11.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-104
1.16.12 OFFRPF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-104
1.16.12.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-104
1.16.12.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-105
1.16.13 PERMVARS= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-105
1.16.13.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-105
1.16.13.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-105
1.16.14 PUSHDEF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-105
1.16.14.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-106
1.16.14.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-106
1.16.15 RDMBLOCK= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-106
1.16.15.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-106
1.16.15.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-106
1.16.16 RPFLABEL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-107
1.16.16.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-107
1.16.16.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-107
1.17 RPS-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 1-108
1.17.1 ETSRPS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-108
1.17.2 LIBXLIB= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-108
1.17.3 RESTART= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-108
1.17.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-108
1.17.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-108
1.17.4 RPSCSECT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-109
1.17.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-109
1.17.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-109
1.17.5 RPSKEY= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-109
1.17.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-109
1.17.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-110
1.17.6 RPSPFX= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-110
1.17.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-110
1.17.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-110
1.18 RTM-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 1-111
1.18.1 RTM= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-111
1.18.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-111
1.18.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-111
1.18.2 RTMCFCMD= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-111
1.18.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-111
1.18.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-112
1.18.3 RTMCFCPU= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-112
1.18.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-112
1.18.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-112
1.18.4 RTMCFDIO= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-112
1.18.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-112

Contents xi
1.18.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-112
1.18.5 RTMCMARK= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-113
1.18.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-113
1.18.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-113
1.18.6 RTMINTVL= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-113
1.18.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-113
1.18.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-113
1.18.7 RTMLIB= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-114
1.18.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-114
1.18.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-114
1.18.8 RTMSYNC= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-114
1.18.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-114
1.18.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-114
1.18.9 RTMTMARK= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-115
1.18.9.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-115
1.18.9.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-115
1.18.10 RTMXMIT= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-115
1.18.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-115
1.18.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-115
1.19 SET Default Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 1-116
1.19.1 AUTOIND= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-116
1.19.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-116
1.19.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-116
1.19.2 AUTOINS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-116
1.19.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-116
1.19.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.3 CHARDFLT= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.4 CMDLINES= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.5 CURSOR= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.5.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-117
1.19.5.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-118
1.19.6 DELIMIT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-118
1.19.6.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-118
1.19.6.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-118
1.19.7 EDITCHNG= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-118
1.19.7.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-118
1.19.7.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-119
1.19.8 EOF= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-119
1.19.8.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-119
1.19.8.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-119
1.19.9 ESCAPE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-119
1.19.10 FILL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-119
1.19.10.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-120
1.19.10.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-120
1.19.11 MASTER= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-120
1.19.11.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-120
1.19.11.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-120
1.19.12 MIX= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-120
1.19.12.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-121

xii Programs and Utilities Guide


1.19.12.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-121
1.19.13 MODE= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-121
1.19.13.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-121
1.19.13.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.14 MONLEVEL= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.14.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.14.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.15 MONTRAP= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.15.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.15.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-122
1.19.16 PFKDELIM= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-123
1.19.16.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-123
1.19.16.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-123
1.19.17 PFSPLIT= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-123
1.19.17.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-123
1.19.17.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-123
1.19.18 PRESERVE= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-124
1.19.18.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-124
1.19.18.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-124
1.19.19 RESPLINE= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-124
1.19.19.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-124
1.19.19.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-124
1.19.20 RPSNOTFY= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-125
1.19.20.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-125
1.19.20.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-125
1.19.21 SAVEATTR= Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-125
1.19.21.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-125
1.19.21.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-126
1.19.22 SCROLL= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-126
1.19.22.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-126
1.19.22.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-126
1.19.23 SEARCH= Parameter . . . . . . . . . . . . . . . . . . . . . . . . 1-127
1.19.23.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-127
1.19.23.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-127
1.19.24 STANDARD= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-128
1.19.24.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-128
1.19.24.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-128
1.19.25 STATS= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-128
1.19.25.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-128
1.19.25.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.26 SUBINCL Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.26.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.26.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.27 SUBNOSEQ Parameter . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.27.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.27.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-129
1.19.28 SUBWIDTH= Parameter . . . . . . . . . . . . . . . . . . . . . . 1-130
1.19.28.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-130
1.19.28.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-130
1.20 Sign On-Related Parameters . . . . . . . . . . . . . . . . . . . . . . . 1-131

Contents xiii
1.20.1 HELLO= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 1-131
1.20.1.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-131
1.20.1.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-131
1.20.2 SEND= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-131
1.20.2.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-131
1.20.2.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-132
1.20.3 SIGNON= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-132
1.20.3.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-132
1.20.3.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-132
1.20.4 SONMSG= Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 1-132
1.20.4.1 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-132
1.20.4.2 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-133
1.20.4.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . 1-133
1.20.5 JCK Monitor Routine Requirements . . . . . . . . . . . . . . . . 1-135
1.20.6 Access Method-Dependent Requirements . . . . . . . . . . . . . 1-136
1.20.7 Codes Identifying Local Printers . . . . . . . . . . . . . . . . . . 1-137
1.21 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-139
1.22 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-140

Chapter 2. Accounting Maintenance Programs . . . . . . . . . . . . . . . . 2-1


2.1 Prepare Accounting Files (ACCTDUMP Program) . . . . . . . . . . . . 2-2
2.1.1.1 Description of Report . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.1.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.1.2.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.1.2.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . . 2-5
2.1.2.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
2.1.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.1.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.2 Producing Accounting Reports (Using Advantage CA-Earl) . . . . . . 2-7
2.2.1 Execution Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
2.2.1.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
2.2.2 Descriptions of Reports . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
2.2.3 AWS Statistics Report . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
2.2.4 Advantage CA-Roscoe Component Statistics Report . . . . . . . 2-12
2.2.5 Advantage CA-Roscoe User Activity Report . . . . . . . . . . . . 2-13
2.2.6 Monitor/ETSO Usage Report . . . . . . . . . . . . . . . . . . . . . 2-15
2.2.7 RPF Execution Activity Report . . . . . . . . . . . . . . . . . . . . 2-16
2.2.8 RPS Usage Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
2.2.9 RTM Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
2.2.10 RTM Statistics Explanation . . . . . . . . . . . . . . . . . . . . . . 2-22
2.2.11 Counting Transactions . . . . . . . . . . . . . . . . . . . . . . . . 2-22
2.2.12 Saving Preliminary Statistics . . . . . . . . . . . . . . . . . . . . . 2-22
2.2.13 Determining Response Time . . . . . . . . . . . . . . . . . . . . . 2-22
2.2.14 Evaluating Transactions . . . . . . . . . . . . . . . . . . . . . . . 2-23
2.2.15 Recording Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
2.2.16 Analyzing Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25

Chapter 3. AWS Maintenance Programs . . . . . . . . . . . . . . . . . . . 3-1


3.1 Format AWS Files (FAWSDS Program) . . . . . . . . . . . . . . . . . . 3-2
3.1.1 Description of Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
3.1.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

xiv Programs and Utilities Guide


3.1.2.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . . 3-3
3.1.2.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . . 3-3
3.1.2.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
3.1.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
3.1.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
3.2 Recover User AWSs (SAVEAWS Program) . . . . . . . . . . . . . . . . 3-5
3.2.1 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.2.1.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.2.1.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . . 3-5
3.2.1.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
3.2.2 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.2.2.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6

Chapter 4. Library Maintenance Program Summaries . . . . . . . . . . . 4-1


4.1 Library Backup (LIBBKUP Program) . . . . . . . . . . . . . . . . . . . . 4-2
4.1.1 Backup User Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
4.1.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
4.1.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.4 Backup Added/Changed Members . . . . . . . . . . . . . . . . . . 4-4
4.1.5 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
4.1.6 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
4.1.6.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
4.1.7 Backup Specific Member(s) . . . . . . . . . . . . . . . . . . . . . . . 4-5
4.1.8 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
4.1.9 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
4.1.9.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
4.2 Inactive Member Report (LIBINACT Program) . . . . . . . . . . . . . . 4-7
4.2.1 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
4.2.1.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . . 4-7
4.2.1.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . . 4-7
4.2.2 KEY Control Statement . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
4.2.3 LIST Control Statement . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
4.2.3.1 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
4.2.4 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
4.2.4.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
4.2.4.2 Sample LIBINACT Reports . . . . . . . . . . . . . . . . . . . 4-11
4.3 Library Member Maintenance (LIBSERVE Program) . . . . . . . . . . 4-12
4.3.1 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
4.3.1.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . 4-13
4.3.1.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . 4-13
4.3.2 COL Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-15
4.3.3 DELETE Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-16
4.3.4 DISKADR Control Statement . . . . . . . . . . . . . . . . . . . . . 4-16
4.3.5 EDIT Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-17
4.3.6 KEY Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-20
4.3.7 LIBRARY Control Statement . . . . . . . . . . . . . . . . . . . . . 4-21
4.3.8 LIST Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-23
4.3.9 LISTMON Control Statement . . . . . . . . . . . . . . . . . . . . . 4-24
4.3.10 PURGE Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-26

Contents xv
4.3.11 RENAME Control Statement . . . . . . . . . . . . . . . . . . . . 4-27
4.3.12 SCALE Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-28
4.3.13 SCAN Control Statement . . . . . . . . . . . . . . . . . . . . . . . 4-29
4.3.13.1 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
4.3.14 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
4.3.14.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
4.4 Library Management (LIBUTIL Program) . . . . . . . . . . . . . . . . 4-33
4.4.1 Add User Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
4.4.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
4.4.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
4.4.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35
4.4.4 Alter Reserve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35
4.4.5 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-36
4.4.6 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36
4.4.6.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
4.4.7 Backup User Libraries . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
4.4.8 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
4.4.9 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
4.4.9.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
4.4.10 Backup User Key . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
4.4.11 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-38
4.4.12 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
4.4.12.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
4.4.13 Format User Libraries . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
4.4.14 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-40
4.4.15 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
4.4.15.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
4.4.16 List Backup File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
4.4.17 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-41
4.4.18 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
4.4.18.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
4.4.19 Reclaim Unused Blocks . . . . . . . . . . . . . . . . . . . . . . . . 4-42
4.4.20 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-43
4.4.21 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
4.4.21.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44
4.4.22 Restore User Libraries . . . . . . . . . . . . . . . . . . . . . . . . 4-44
4.4.23 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-45
4.4.24 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
4.4.24.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
4.4.25 Restore Members by User Key . . . . . . . . . . . . . . . . . . . 4-47
4.4.26 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-47
4.4.27 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-49
4.4.27.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-49
4.4.28 Restore Members to User Key . . . . . . . . . . . . . . . . . . . . 4-49
4.4.29 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-49
4.4.30 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51
4.4.30.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51
4.4.31 Restore Members by User Prefix . . . . . . . . . . . . . . . . . . 4-51
4.4.32 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-51
4.4.33 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-53
4.4.33.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-53

xvi Programs and Utilities Guide


4.4.34 Restore Specific Members . . . . . . . . . . . . . . . . . . . . . . 4-53
4.4.35 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4-53
4.4.36 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-55
4.4.36.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-55
4.5 Copy Member(s) to a Data Set (ROSCOPY Program) . . . . . . . . . 4-56
4.5.1 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-56
4.5.1.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . 4-56
4.5.1.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . 4-56
4.5.2 COPY Control Statement . . . . . . . . . . . . . . . . . . . . . . . 4-57
4.5.3 MEMBER Control Statement . . . . . . . . . . . . . . . . . . . . . 4-58
4.5.4 -FRONT Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-59
4.5.5 -END Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-59
4.5.5.1 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-60
4.5.6 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-61
4.5.6.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-61
4.6 Copy Member(s) from a Data Set (ROSDATA Pgm) . . . . . . . . . . 4-62
4.6.1 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-62
4.6.1.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . 4-63
4.6.1.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . 4-63
4.6.2 $ADD Control Statement . . . . . . . . . . . . . . . . . . . . . . . 4-64
4.6.3 $CLEAR Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-69
4.6.4 $FILL Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-70
4.6.5 $FROM Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-70
4.6.6 $KEY Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-71
4.6.6.1 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-72
4.6.7 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-73
4.6.7.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-75
4.7 Library Member Information (ROSMAILS Program) . . . . . . . . . . 4-76
4.7.1 Description of Reports . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
4.7.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-77
4.7.2.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . 4-77
4.7.2.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . 4-77
4.7.3 KEY Control Statement . . . . . . . . . . . . . . . . . . . . . . . . 4-78
4.7.4 SYSTEM Control Statement . . . . . . . . . . . . . . . . . . . . . . 4-78
4.7.4.1 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-79
4.7.5 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-79
4.7.5.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
4.8 Library Statistics (ROSTAT Program) . . . . . . . . . . . . . . . . . . . 4-81
4.8.1 Description of Report . . . . . . . . . . . . . . . . . . . . . . . . . . 4-81
4.8.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4-82
4.8.2.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . 4-82
4.8.2.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . 4-83
4.8.2.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83
4.8.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83
4.8.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83

Chapter 5. Miscellaneous Programs . . . . . . . . . . . . . . . . . . . . . . 5-1


5.1 DISPLAY Authorization (DISAUTHO Program) . . . . . . . . . . . . . 5-2
5.1.1 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
5.1.1.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Contents xvii
5.1.1.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . . 5-3
5.1.1.3 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
5.1.2 GROUP Control Statement . . . . . . . . . . . . . . . . . . . . . . . 5-4
5.1.2.1 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
5.1.2.2 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
5.1.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
5.1.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
5.2 RTF Report (TREPORT Program) . . . . . . . . . . . . . . . . . . . . . . 5-6
5.2.1 Description of Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
5.2.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
5.2.2.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . . 5-7
5.2.2.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . . 5-8
5.2.2.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
5.2.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
5.2.3.1 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
5.3 User Profile Information (UPSLIST Program) . . . . . . . . . . . . . . 5-11
5.3.1 Description of Report . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
5.3.2 Program Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
5.3.2.1 PARM Field Options . . . . . . . . . . . . . . . . . . . . . . . 5-12
5.3.2.2 SYSIN Control Statements . . . . . . . . . . . . . . . . . . . . 5-13
5.3.2.3 DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
5.3.3 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
5.3.3.1 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
5.3.3.2 Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14

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

xviii Programs and Utilities Guide


About This Guide

The Programs and Utilities Guide provides information about executing


Advantage CA-Roscoe and the various utility programs that are distributed
with Advantage CA-Roscoe.

About This Guide xix


Organization

CHAPTER DESCRIPTION
1 Describes Advantage CA-Roscoe startup considerations,
program requirements plus information about executing
multiple Advantage CA-Roscoes and providing batch user
sessions.
2 Describes how to execute the distributed accounting-related
program ACCTDUMP and how to produce accounting
reports using Advantage CA-Earl.
3 Describes when and how to execute the distributed AWS
maintenance programs FAWSDS and SAVEAWS.
4 Describes when and how to use the distributed library
maintenance programs: LIBBKUP, LIBINACT, LIBSERVE,
LIBUTIL, ROSCOPY, ROSDATA, ROSMAILS, and ROSTAT.
5 Describes when and how to use the additional programs
distributed with Advantage CA-Roscoe. These include
DISAUTHO, TREPORT, TRANS, and UPSLIST.
Index Provides a quick way to find specific information.

xx Programs and Utilities Guide


Revisions and Enhancements
The following information has been provided as a quick reference regarding
revisions and enhancements that have been made in the the core release and
the Service Packs that followed.

Summary of Revisions for Service Pack 7


Privileged administrator privileges are available for the user.

Summary of Revisions for Service Pack 6


To allow multiple archiving products, two new Advantage CA-Roscoe start-up
parameters (RECALVL2 and RECALVL3) have been added.

When installing and using the JCK monitor to check JCL in Advantage
CA-Roscoe's AWS, a blank screen is often encountered without any error
messages or indication of any kind that there is a problem. Messages and
options have been added to specify and list out the options passed to
JCLCHECK. New options for JCL include: -D, -X, and -A. JCK-D display
parms passed to JCLCHECK. JCK-X turns off Advantage CA-Roscoe's SVC
screening of issues and JCK-A places output to an Advantage CA-Roscoe
AWS.

New messages have been added to describe problems that can occur during
execution of JCK that would have normally returned with no indication of a
problem.

Summary of Revisions for Service Pack 5


The current signon facility in Advantage CA-Roscoe executes a users signon
RPF, defined by a user, and allows the session to be customized. A new
initialization parameter (BYPSRPF=YES) has been added to disable executing
the users signon RPF. With the BYPSRPF=YES parameter, applications can
now run without concern that no settings will be altered during initialization.

A new system variable, S.BYPSRPF, has also been provided to allow the user
RPF to detect BYPSRPF setting.

OFFRPF= has been added to the initialization parameters which identifies the
library member containing the RPF program used as the global sign-off
procedure.

RELCALNUM is a new parameter used to designate whether Advantage


CA-Roscoe should wait for the archival product to supply the recall request
number.

JES2 provides a facility to dynamically add and delete spool data sets through
the use of the operator commands ($S SPL, $P SPL, and $Z SPL). However,

About This Guide xxi


Advantage CA-Roscoe does not recognize the dynamic addition or deletion of
spool packs. Therefore, if one of the above commands is issued to dynamically
alter the spool configuration, Advantage CA-Roscoe must be recycled.

The CONVACCT that was used to convert accounting records from their
pre-Advantage CA-Roscoe Release 5.5 SESSION format to the SRECORD
format has been removed.

Summary of Revisions for This Edition


Added DCB information to 1.3.1, “Executing a Batch Session” on page 1-4.

Added a parameter related to processing recall package request numbers. See


1.9.20, “RECALNUM= Parameter” on page 1-49 for more information.

Added a parameter related to identifying the library member that contains the
RPF program to be used as the global signoff procedure. See 1.16.12,
“OFFRPF= Parameter” on page 1-104 for more information.

Summary of Revisions
The following information describes initialization parameters that have been
added, changed, or deleted.

The following parameters are new:


■ ACFEXT=: Determines the use of internal or external security calls for user
sign-on.
■ CLLEXT=: Determines the use of internal or external security calls to
control user access to the program calls made by ETSO.
■ JOBEXT=: Determines the use of internal or external security calls to
control user access to the JES SPOOLs via Attach Job.
■ LIBEXT=: Determines the use of internal or external security calls to enable
user execution of Advantage CA-Roscoe Library Administrator functions.
■ MIX=: Establishes the default setting for the SET MODE MIX/NOMIX
command.
■ MONEXT=: Determines the use of internal or external security calls to
control user access to monitor routines.
■ PFSPLIT=: Establishes the default setting for the SET SPLIT command.
■ PRESERVE=: Establishes the default setting for the SET MODE
PRESERVE/NOPRESERVE command.
■ PRVEXT=: Determines the use of internal or external security calls to
control user execution of restricted commands.
■ RPFEXT=: Determines the use of internal or external security calls to
control user access to RPFs.

xxii Programs and Utilities Guide


■ UPSEXT=: Determines the use of internal or external security calls to
control user access to UPS functions.

The following parameter has been changed:


■ PERMVARS=: The maximum number of permanent variables that can be
used in an RPF program has been increased to 128.
:

Miscellaneous

■ A new control statement, EDIT, has been added to LIBSERVE. EDIT


searches one or more members for the first or every occurrence of a
specified search string, and replaces it with the specified replacement
string.
■ The LIBUTIL program can now incorporate the BEXEXIT to provide
security for the Advantage CA-Roscoe user library system.
■ Release 6.0 now provides for multiple Library and UPS Administrators.
The LIBSERVE and ROSDATA program descriptions have been updated to
describe and define Library privileges.
The UPSLIST report will contain two new privileged user codes, U and L,
when applicable.

About This Guide xxiii


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.

xxiv Programs and Utilities 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.

About This Guide xxv


Related Publications
The CA Common Services r11 for z/OS SP6 (formerly known as Unicenter
TNG Framework for OS/390 and CA Common Services for z/OS and OS/390
Services) documentation can be found on http://supportconnect.ca.com.

The following manuals relate to Advantage CA-Roscoe and are on


http://supportconnect.ca.com.

Title Contents
Advantage CA-Earl Reference Guide Contains detailed information about
Advantage CA-Earl statements,
parameters, and coding rules. Also
explains the Advantage CA-Earl
Reporting Service.
Advantage CA-Earl User Guide Designed for users interested in
learning about Advantage CA-Earl. It
presents an introduction to
Advantage CA-Earl features and
capabilities.
Advantage CA-Earl Systems Lists the installation options for
Programmer Guide Advantage CA-Earl and instructions
for modifying them. Also describes
size requirements and program
execution.
Advantage CA-Earl Examples Guide Contains sample programs that show
a variety of common applications.

xxvi Programs and Utilities Guide


CA Common Services for z/OS
CA Common Services for z/OS are a common set of services that may be used
by any MVS Computer Associates product. These services are maintained
separately from the product and are documented and installed separately as
well. Advantage CA-Roscoe uses CAIRIM for installation services and security.

Licensing Management Program (LMP)

Advantage CA-Roscoe now interfaces with CAIRIM services to determine


product licensing authorization.

About This Guide xxvii


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

xxviii Programs and Utilities Guide


Below 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 below, 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
examples below:

COMMAND PARM1
COMMAND PARM2
COMMAND PARM3

About This Guide xxix


A single optional parameter appears below the horizontal line that marks the
main path. 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

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

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

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 examples below:

COMMAND
COMMAND PARM1
COMMAND PARM2

For some statements, you can specify a single parameter more than once. A
repeat symbol (a backward-pointing arrow above the main horizontal line)
indicates that you can specify multiple parameters. Below are examples which
include the repeat symbol.

xxx Programs and Utilities Guide


Repeatable Variable Parameter
┌──
──────────┐
─variable─┴───────────────────────────────────────
──COMMAND───

In the above 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. Below is an example which
includes the repeat symbol, a comma, and parentheses.

Separator with Repeatable Variable and Delimiter


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

In the above 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─┘

Some choices you can make include:

COMMAND PARM1
COMMAND PARM1 PARM2 PARM3

About This Guide xxxi


COMMAND PARM1 PARM1 PARM3

When a parameter in a syntax diagram is above the line, for example, YES in
the diagram below, 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 above, 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.

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

xxxii Programs and Utilities Guide


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

About This Guide xxxiii


xxxiv Programs and Utilities Guide
Chapter 1. Advantage CA-Roscoe

This chapter contains the information needed to execute Advantage


CA-Roscoe. This information includes:
■ Executing multiple Advantage CA-Roscoes
■ Executing Advantage CA-Roscoe in batch
■ Startup considerations that include:
– Defining how initialization parameters are to be passed
– Explaining initialization parameter validation procedures and how to
use error recovery procedures
– Describing how the console operator can add additional initialization
parameters
■ Program requirements that include:
– EXEC statement requirements
– Detailed descriptions of the initialization parameters
– Information about the required and optional DD statements
■ JCL examples that illustrate the various ways in which you can specify
Advantage CA-Roscoe initialization parameters

Chapter 1. Advantage CA-Roscoe 1-1


1.1 Advantage CA-Roscoe Configuration

1.1 Advantage CA-Roscoe Configuration


The Advantage CA-Roscoe configuration is dynamically established when the
Advantage CA-Roscoe job stream is submitted for execution. The Advantage
CA-Roscoe initialization phase determines which load components are to be
used and how much user memory space (in the form of buffers, control blocks,
and so on) is to be acquired. This determination is based on the information
obtained from:
■ Options specified on the EXEC statement
■ Internal representation of the JCL in the TIOT
■ Parameters defined in either the library member named in the PARM field
of the EXEC statement or the SYSIN file

The initialization phase collects information from these sources, validates the
information and then establishes the configuration that is required.

Caution
The first time Advantage CA-Roscoe is executed after each MVS IPL, an
MVS System Address Space is created. This address space is an extension
of Advantage CA-Roscoe. Sites must not attempt to remove this address
space. See Appendix A in the Advantage CA-Roscoe Interactive Environment
System Reference Guide for additional information.

1-2 Programs and Utilities Guide


1.2 Executing Multiple Advantage CA-Roscoes

1.2 Executing Multiple Advantage CA-Roscoes


Sites can execute two or more Advantage CA-Roscoes concurrently. Before
doing this, sites should review the following items:
■ Advantage CA-Roscoe Files:
The following files can be shared between concurrently executing
Advantage CA-Roscoes:
– Advantage CA-Roscoe user libraries
– User profiles (The profiles are maintained as part of the user libraries.)
– Advantage CA-Roscoe Source, Load, object and macro libraries
The following files cannot be shared between concurrently executing
Advantage CA-Roscoes:
– Advantage CA-Roscoe accounting files
– AWS files (A unique pointer file and one or more data files must be
established for each Advantage CA-Roscoe.)
■ Sharing RPS Definitions:
Each Advantage CA-Roscoe can share or have a unique RPS Printing
Network Environment Definition. See the description of the RPS-related
initialization parameters for details.
■ Execution JCL Considerations:
– If the Advantage CA-Roscoe user libraries are being shared, the
initialization library member named in the PARM field of the EXEC
statement must be unique.
– A unique ROSID= initialization parameter must be specified for each
Advantage CA-Roscoe. Ensure that all Advantage CA-Roscoe users
know which ROSIDs they are to use.
– At VTAM sites, the APPLID identified through the ROSAPPL=
initialization parameter must be unique for each Advantage
CA-Roscoe.
– At BTAM sites, review the Advantage CA-Roscoe DD statements to
ensure that the terminals and printers are unique for each Advantage
CA-Roscoe.

Chapter 1. Advantage CA-Roscoe 1-3


1.3 Providing a Batch Session

1.3 Providing a Batch Session


There may be occasions when a site wants to simulate a single-terminal
Advantage CA-Roscoe system to test site-written exit routines or Monitor
commands. There may also be occasions when a site wants to ensure that one
or more Advantage CA-Roscoe or Monitor commands are executed as soon as
Advantage CA-Roscoe is started. These types of situations can be handled by
providing commands to Advantage CA-Roscoe through a batch session.

1.3.1 Executing a Batch Session


1. Verify that the RCSGEN macro, as defined in the Advantage CA-Roscoe
Communication Services (RCS) definition, includes AMETHS=BATCH.
(See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of RCS and the RCSGEN macro.)
2. VTAM-only sites: Remove the VTAM= initialization parameter or specify it
as VTAM=0 if the Advantage CA-Roscoe Printing Services (RPS) is to be
available.
3. BTAM-only and mixed access method sites: Remove all DD statements
from the Advantage CA-Roscoe JCL relating to terminals. If RPS is to be
available, do not remove the DD statements defining printers.
4. Add the ROSBSIN and ROSBSOUT DD statements to the Advantage
CA-Roscoe JCL. The DCB parameters for the ROSBSOUT DD statement
are: DSORG=PS and LRECL=132.

When Advantage CA-Roscoe is started, the commands defined in ROSBSIN


are read and executed. Both the commands and the responses to those
commands are written to the output file defined by ROSBSOUT.

1.3.2 Defining Commands


The commands defined by ROSBSIN are executed as though they were entered
at a typewriter device. Therefore, any command restrictions that apply to
typewriter devices are applicable to a batch Advantage CA-Roscoe session as
well (for example, RPF programs containing panels cannot be executed during
a batch session). In addition:
■ The first command in the file must be the sign-on key for the user whose
library members are to be involved in the execution. If the user has a
password, the password must be specified on the second line.
■ If the INPUT command is included, the data to be placed in the active
AWS must immediate follow the command. One or more lines of data can
be specified. To indicate the end of input, follow the last input data line
with the escape sequence established by the SET ESCAPE command. (The
default escape sequence is '..'.)

1-4 Programs and Utilities Guide


1.3 Providing a Batch Session

■ To terminate the batch session, the last command in ROSBSIN should be


OFF. If this command is omitted, an OFF command is simulated when the
end of the file is reached.

If all of the commands in ROSBSIN are to be executed before Advantage


CA-Roscoe users can sign on, the initialization library member must contain
the parameter:
SIGNON=OFF

When this is done, the sign-on key specified in ROSBSIN must belong to a
userid with OPERATOR privileges since those users are the only individuals
who are allowed to sign on when SIGNON=OFF is in effect. (If SIGNON=OFF
is not specified, other users can sign on to Advantage CA-Roscoe during the
batch session.)

To permit other users to sign on to Advantage CA-Roscoe after the batch


session ends, add the OPERATOR SIGNON command before the OFF
command in the ROSBSIN file. (The OPERATOR command can only be issued
by a user with OPERATOR privileges.)

Chapter 1. Advantage CA-Roscoe 1-5


1.4 Startup Considerations

1.4 Startup Considerations


Every time Advantage CA-Roscoe is executed, its configuration can be
redefined through its initialization parameters. This section describes:
■ The ways parameters can be passed to Advantage CA-Roscoe.
■ The action that is to occur if an error is encountered while the parameters
are being processed.
■ How to allow the operator to add additional parameters to the input
stream.

1.4.1 Initialization Parameter Location Definitions


The location of the parameters to be used for a given execution is defined by
the presence or absence of the SYSIN DD statement or the PARM= option on
the EXEC statement. Table 1-1 summarizes the various ways initialization
parameters can be presented for initialization processing.

Table 1-1. Initialization Parameter Presentation Methods Summary

Found Action
Omit SYSIN and PARM Use RO.jobname.
Use only SYSIN Use SYSIN; create/update
RO.jobname.
Use only PARM
With one member name Use contents of that member.
With two member names Use contents of first member. If error,
use contents of second member.
Use SYSIN and PARM
With one member name Use SYSIN; create/update named
member.
With two member names Use SYSIN; create/update first
member. If error, use contents of
second member.

1.4.1.1 Omitting PARM= and SYSIN

If you do not include either PARM= or a SYSIN DD statement, the


initialization parameters for this execution are assumed to be in the library
member named RO.jobname (where jobname is the name of the job that
executes Advantage CA-Roscoe).

1-6 Programs and Utilities Guide


1.4 Startup Considerations

1.4.1.2 Using Only SYSIN

If you include a SYSIN DD statement, the initialization parameters are read


from that file. They are validated and written to a library member named
RO.jobname (where jobname is the name of the job that executes Advantage
CA-Roscoe). If the member exists, its contents is updated. If the member does
not exist, it is created and assigned a restricted access attribute.

1.4.1.3 Using Only PARM=

If you include PARM=, its format is:

PARM= DD Statement
──PARM=──'──┬──────┬──mem1──┬─────────────────┬──'────────────
└─pfx.─┘ └─'─┬──────┬─mem2─┘
└─pfx.─┘

If you specify:
■ One library member name - that member is assumed to contain the
initialization parameters which are to be used for this execution.
■ Two member names - the first member is assumed to contain replacement
parameters (that is, it is a 'test' definition). The second member is assumed
to contain previously validated parameters (that is, it is the 'production'
definition). The parameters defined in the second member are used only in
the event an error is encountered while processing the first member.

Note: A prefix may be omitted if the library member(s) reside in the library
of the individual assigned the RO prefix.

1.4.1.4 Using Both PARM= and SYSIN

If you include both PARM= and a SYSIN DD statement and PARM= is


specified with:
■ One library member name - the parameters for this execution are read
from the SYSIN file. They are validated and the library member named
through the PARM= is created or updated.
■ Two member names - the parameters are read from the SYSIN file. They
are validated and written to the first library member named through the
PARM= (that is, creating or updating a permanent copy of the 'test'
definition).
The second member is assumed to contain the 'production' definition. The
parameters defined in this member are used only in the event an error is
encountered while processing the SYSIN file.

Note: A prefix may be omitted if the library member(s) reside in the library
of the individual assigned the RO prefix.

Chapter 1. Advantage CA-Roscoe 1-7


1.4 Startup Considerations

1.4.2 Validation and Error Recovery


In the event an error is encountered while processing initialization parameters,
Advantage CA-Roscoe either:
■ Invokes an automatic restart, if two member names are specified with
PARM=, or
■ Prompts for the correct parameter, if NOPROMPT has not been
encountered in the parameters processed thus far.

Table 1-2 summarizes the actions taken in the event an error is encountered
while processing initialization parameters.

Table 1-2. Error Recovery Procedures Summary

Found Action
No SYSIN or PARM Use RO.jobname
If error in RO.jobname Prompt
No SYSIN or PARM or RO.jobname Terminate
Only PARM with two members Use first member
If first member not found or contains error Restart using second member
If second member not found or contains error Terminate
SYSIN and PARM with two members Use SYSIN
If SYSIN contains error Restart using second member
If second member not found or contains error Terminate
Only SYSIN Use SYSIN
If error Prompt
Only PARM with one member Use first member
If error Prompt
SYSIN and PARM with one member Use SYSIN
If error and member one contains error Prompt
PROMPTING OCCURS ONLY IF 'NOPROMPT' NOT SPECIFIED

1-8 Programs and Utilities Guide


1.4 Startup Considerations

1.4.2.1 Automatic Restart

When two library member names are specified with PARM= on the EXEC
statement, the automatic restart facility is in effect. During initialization, the
input stream is checked for the presence of a SYSIN DD statement.
■ If SYSIN is found, the parameters defined there are processed. If an error
is encountered, a message is directed to the console. Initialization restarts
using the parameters defined in the second member.
■ If SYSIN is not found, Advantage CA-Roscoe initialization looks for the
first member named. If the first member is not found or contains an error,
a message is directed to the console. Initialization restarts using the
parameters defined in the second member.

In both of the preceding cases, if the second member named is not found or
contains an error, initialization terminates.

1.4.2.2 Operator Prompting

The operator prompting facility is automatically activated whenever PARM= is


omitted from the EXEC statement or specified with only one library member
name. When this facility is in effect, Advantage CA-Roscoe first determines
the location of the initialization parameters.
■ If there is no PARM= and no SYSIN DD statement, the member
RO.jobname is assumed to contain the initialization parameters. (If this
member cannot be found, initialization terminates.)
■ If PARM= is omitted and there is a SYSIN DD statement, the parameters
are read from the SYSIN file.
■ If PARM= is specified, the contents of the specified member is processed.
(Even if specified, SYSIN is ignored.)

Initialization processing validates each parameter as it is encountered. If a


parameter is found to be invalid, a message is directed to the console. If the
operator chooses to correct the problem and resume initialization, the next
parameter in the input stream is validated. This process continues until the
end of the input is reached or the NOPROMPT initialization parameter is
encountered.

When a prompt is directed to the console, the prompt message indicates the
cause of the error. The operator may enter:
■ The command ABORT or GO, where:
ABORT terminates prompting and initialization.
GO terminates prompting and resumes initialization. (If the
operator does not correct the invalid parameter, its default
value is used. If the parameter has no default. the parameter is

Chapter 1. Advantage CA-Roscoe 1-9


1.4 Startup Considerations

ignored.) Processing of subsequent parameters in the input


stream resumes.
■ The correct parameter.
After the parameter is processed, the operator is prompted for additional
parameters. Note that the operator may not enter:
– The PASSWORD parameter.
– Parameters already processed. If such parameters are entered, error
messages are displayed at the console.
– Parameters that are subsequently specified in the input stream. If such
parameters are entered, error messages will be displayed when the
parameters are subsequently encountered in the input stream.
Prompting for additional parameters continues until the operator enters
either GO or ABORT.

Operator prompting is disabled when the NOPROMPT initialization parameter


is included in the input stream. As soon as this parameter is encountered, no
operator prompting will occur. If an error is encountered while subsequent
parameters are being processed, Advantage CA-Roscoe initialization
terminates.

1.4.3 Console Input


Sites have the option of allowing the operator to add additional initialization
parameters to the input stream.
■ To disable operator input:
Include the NOPROMPT parameter in the input stream.
■ To enable operator input:
Include the CONSOLE parameter in the input stream and verify that
NOPROMPT is omitted.
When CONSOLE is used, a message is directed to the operator console
after all other initialization parameters have been successfully processed.
The message starts a prompting session which allows the operator to add
additional initialization parameters. Note that the operator cannot:
– Issue the PASSWORD parameter.
– Override previously specified parameters.
To terminate the prompting session, the operator must enter one of the
following:
GO Resumes initialization processing
ABORT Terminates initialization

1-10 Programs and Utilities Guide


1.5 Program Requirements

1.5 Program Requirements


This section describes the EXEC statement requirements, initialization
parameters and DD statements that are used by Advantage CA-Roscoe.

1.5.1 EXEC Statement Requirements


The EXEC statement for Advantage CA-Roscoe should be specified according
to the following format:

//ROSCOE EXEC PGM=ROSCOE,


// TIME=1439,
// REGION=region,
// PARM=...

PGM= identifies the program name as ROSCOE.


TIME= defines the amount of time Advantage CA-Roscoe is to execute.
Any time may be set. 1439 is recommended since Advantage
CA-Roscoe is a never-ending task.
REGION= specifies the size of the virtual region to be used by Advantage
CA-Roscoe. The minimum is 2480K. The actual size is dependent
upon the number of Advantage CA-Roscoe users and the
Advantage CA-Roscoe configuration.
PARM= identifies the Advantage CA-Roscoe library member(s) containing
the initialization parameters for this execution.
See the description beginning on page 1-6 for information about
how PARM= and the SYSIN DD statement can be define this
execution of Advantage CA-Roscoe.

Advantage CA-Roscoe is not a resource intensive process, but rather it is


almost entirely I/O bound. Its responsiveness can be somewhat degraded by
competing with resource intensive processes. We suggest that all sites place
Advantage CA-Roscoe in a performance group which will give it a higher
dispatching priority higher than CICS or a similar terminal system. Advantage
CA-Roscoe should also have a higher dispatching priority than most resource
intensive system tasks.

Chapter 1. Advantage CA-Roscoe 1-11


1.5 Program Requirements

1.5.2 Initialization Parameters


All initialization parameters should be specified for every execution of
Advantage CA-Roscoe. The exceptions to this rule are:
1. PASSWORD= need only be specified when the universal password is to be
changed. (For security purposes, Advantage CA-Roscoe records the
password in the first block of ROSLIB00.)
2. Parameters whose default values are appropriate for site needs may be
omitted. For example, the HELPPFX= parameter may be omitted if the site
is using the default prefix RHE for the the key assigned the HELP facility.
3. Parameters that are not needed. For example, a BTAM site need not
specify any VTAM-oriented initialization parameters.

The following rules apply when defining initialization parameters in a library


member or the SYSIN file:
■ Only one parameter can be coded per line.
■ If a parameter accepts multiple operands, the operands must be separated
by commas, not spaces. The operands may optionally be bound by
parentheses.
■ An asterisk in the first position of the line causes the entire line to be
treated as a comment (that is, ignored).
■ A comment may be specified with a parameter provided the comment
follows the parameter on the line and is separated from the parameter by
at least one space.
■ A line containing spaces in positions 1 through 71 is treated as a separator
line and is ignored.

For convenience, the descriptions of the parameters have been grouped into
the following categories:

Table 1-3 (Page 1 of 2). Initialization Parameter Categories

Category Description Beginning


Page
Accounting Parameters used to control the accounting 1-28
information generated by Advantage
CA-Roscoe.
ATTACH JOB Parameters used to establish the 1-34
and DISPLAY environment for obtaining information
about jobs executed in batch.
AWS Parameters used to define the site's use of 1-36
the AWS.

1-12 Programs and Utilities Guide


1.5 Program Requirements

Table 1-3 (Page 2 of 2). Initialization Parameter Categories

Category Description Beginning


Page
Data Set Parameters used to define the site's use of 1-39
the Data Set Facility.
Environment Parameters used to define the current 1-52
Advantage CA-Roscoe environment.
ETSO Parameters that facilitate the use of ETSO. 1-75
Library Parameters used to define the site's use of 1-84
the Library Facility.
Monitor Parameters that facilitate the use of 1-89
commands that extend the Advantage
CA-Roscoe command language.
Operator Parameters used to control console 1-91
communications.
RCS Parameters used to define the 1-93
communications network to be used with
this execution of Advantage CA-Roscoe.
RPF Parameters used to establish site maximum 1-99
values used in RPF programs.
RPS Parameters that identify the ROSCOE 1-108
Printing Services printing network
environment definition.
RTM Parameters used to activate and customize 1-111
the Response-Time Monitor.
SET Parameters used to establish site default 1-116
values for the majority of SET commands.
Signon Parameters used to control user sign-on 1-131
processing.

Use Table 1-4 to reference parameters alphabetically. This table also gives a
description of each parameter and the category under which each is listed.

Table 1-4 (Page 1 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


ACCTBUFF= Establishes the number and size of the Accounting
buffers to be used to hold accounting
records.
ACCTOPT= Designates whether library statistics are Accounting
to be calculated when the user signs off.

Chapter 1. Advantage CA-Roscoe 1-13


1.5 Program Requirements

Table 1-4 (Page 2 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


ACCTREC= Defines the type of records that are to Accounting
be produced.
ACCTROS= Designates whether Advantage Accounting
CA-Roscoe accounting records are to be
written to the Advantage CA-Roscoe
accounting files.
ACCTSMF= Designates whether Advantage Accounting
CA-Roscoe accounting records are to be
written to the SMF files.
ACFEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls for user sign-on.
AJOB= Activates ATTACH JOB processing. AJOB and
Display
| ALLRECAL= Establishes recall specification for the Data Set
| ALLOC DSN command.
ARRAYMAX= Defines the number of elements that RPF
may be assigned to a named
DECLARed variable.
AUTINTVL= Defines how long Advantage CA-Roscoe Environment
is to wait before rechecking for inactive
terminals.
AUTOFF= Controls the use of the automatic signoff Environment
facility.
AUTOFVAL= Sets the amount of time the terminal Environment
may be inactive before being
automatically signed off.
AUTOIND= Establishes the default setting for the SET
SET AUTOINDENT command.
AUTOINS= Establishes the default setting for the SET
SET AUTOINSERT command.
AUTTLOCK= Controls the use of the automatic Environment
terminal lock facility.
AUTTLVAL= Sets the amount of time the terminal Environment
may be inactive before the Terminal
Lock screen is automatically displayed.

1-14 Programs and Utilities Guide


1.5 Program Requirements

Table 1-4 (Page 3 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


AWSCACHE= Enables the AWS Cache Facility and sets AWS
the maximum amount of storage to be
acquired by this facility.
AWSDAYS= Defines the number of days a AWS
SAVAWSnn member will remain in a
user's library before it is deleted.
AWSLIM= Defines the maximum number of AWSs AWS
an individual user may use during a
Advantage CA-Roscoe session.
| BYPSRPF= Signifies whether Advantage CA-Roscoe RPF
| is to bypass execution of the user
| sign-on procedure.
BREAK= Sets the maximum number of lines that Environment
can be written at a TTY device before
pausing.
CHAR= Defines the language code(s) which Environment
identify the character set(s) that may be
entered and displayed at the terminal.
CHARDFLT= Defines the language code that is to be Environment
the default character set.
CLLEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to control user access to the
program calls made by ETSO.
CMDISABL= Defines the library member that contains Environment
a list of the commands that are to be
disabled during Advantage CA-Roscoe
initialization.
CMDLINES= Establishes the default setting for the SET
SET CMDLINES command.
CMQE= Defines the number of command queue Environment
elements in the system pool that are to
be allocated in common storage.
COMCHAR= Defines the special character that is to Environment
be used in place of 'F jobname,' in
operator commands.
CONSOLE= Causes an operator prompting session to Operator
begin after the initialization parameters
have been processed.

Chapter 1. Advantage CA-Roscoe 1-15


1.5 Program Requirements

Table 1-4 (Page 4 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


CRBUF= Defines the size of the buffer that is Environment
used for command recall (using the +
pseudo-command).
CURSOR= Establishes the default setting for the SET
SET CURSOR command.
DATEFORM= Designates the date format to be used at Environment
user terminals and included in the
Advantage CA-Roscoe job log.
DELETE= Controls the display of the DELETE Library
confirmation request.
DELIMIT= Establishes the default setting for the SET
SET command.
DISAUTHO= Identifies the library member containing AJOB and
the DISPLAY Authorization Table. Display
DMFPFX= Identifies the prefix associated with the RPF
profile that is used by the Dialog
Management Facility (DMF).
DOTPFX= Identifies the prefix associated with the RPF
profile that is used by the pseudo
execution library.
DSNBLDL= Designates whether Advantage Data Set
CA-Roscoe should issue a BLDL to
locate a PDS member.
DSNCFRMD= Establishes the default setting for data Data Set
set delete confirmation.
DSNCFRMM= Establishes the default setting for data Data Set
set member delete confirmation.
DSNCLIST= Defines the number of catalog entries Data Set
that should fit within an acquired work
area.
DSNCMENQ= Defines the level of data set control that Data Set
is to be required for COMPRESS
processing.
DSNCMLIM= Defines the number of COMPRESS Data Set
requests that may be concurrently
active.

1-16 Programs and Utilities Guide


1.5 Program Requirements

Table 1-4 (Page 5 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


DSNCMLST= Defines the condition under which the Data Set
ZZZZZCMP library member should not
be created or updated.
DSNCMPGM= Identifies the program that is to be Data Set
invoked to process COMPRESS requests.
DSNCNT= Establishes the default and maximum Data Set
number of lines to be searched within a
data set object.
DSNEMPTY= Designates whether the Data Set Facility Data Set
is to attempt to read data sets whose
DSCB (Data Set Control Block) indicate
that they are empty.
DSNINDEX= Defines the maximum amount of Data Set
storage (in K) to be acquired for line
queue elements when a user attaches a
sequential data set, PDS member or
AllFusion CA-Librarian module.
DSNLPRD2= Designates whether PROD2 modules Data Set
should be included in an AllFusion
CA-Librarian Selection List if the user
fails to provide the proper management
code (MCD).
DSNLPSWD= Designates whether AllFusion Data Set
CA-Librarian master file module
password protection for read operations
is to be ignored.
DSNRECAL= Designates the action to be taken when Data Set
an operation is to be performed on a
data set migrated by the IBM program
product DFHSM.
EDITCHNG= Establishes the default setting for the SET
SET EDITCHNG command.
END= Marks the end of the Advantage Environment
CA-Roscoe initialization parameters.
ENQTYPE= Establishes how Advantage CA-Roscoe Data Set
is to handle processing of partition data
set (PDS) and AllFusion CA-Librarian
master files.
EOF= Establishes the default setting for the SET
SET EOF command.

Chapter 1. Advantage CA-Roscoe 1-17


1.5 Program Requirements

Table 1-4 (Page 6 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


ESCAPE= Defines the character string that is to be ETSO
used as the default setting for the SET
ESCAPE command.
ETSALLOC= Defines the maximum number of files ETSO
that a user may allocate per session.
ETSOEPL= Signifies whether the Advantage ETSO
CA-Roscoe Eligible Program List (EPL)
must contain an entry for any TSO
command executed from the Advantage
CA-Roscoe command line or from an
RPF. At least one EPL entry is required,
for the Advantage CA-Roscoe command
processor, ROSTMP itself.
ETSOEXEC= Signifies whether TSO exec processing ETSO
will be enabled.
ETSOLIB= Signifies whether the ETSOLIB ETSO
concatenation will be searched to
resolve commands executed with the
TSO command.
ETSOPGMS= Identifies the library member that ETSO
contains the Eligible Program List (EPL)
that is to be used for this execution of
Advantage CA-Roscoe.
ETSOSRCH= Signifies whether the Eligible Program ETSO
List (EPL) will be searched for
commands invoked through the TSO
command.
ETSOXIT= Signifies whether the CLLEXIT routine ETSO
will be called for commands invoked
through the TSO command.
ETSRPS= Designates whether SYSOUT data sets ETSO
(allocated under ETSO) may be directed
to 328x-type printers defined to RPS.
ETSSLICE= Defines the amount of time that is to be ETSO
allotted to a time slice.
ETSSRCH= Designates the location of programs that ETSO
may be called by a user.
EXECPFX= Identifies the prefix associated with the RPF
profile that is used as the RPF Execution
Library.

1-18 Programs and Utilities Guide


1.5 Program Requirements

Table 1-4 (Page 7 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


EXTSEC= Identifies your site's security package. Environment
FILL= Establishes the default setting for the SET
SET FILL command.
HELLO= Identifies the library member containing Signon
the newsletter/message that is to be
displayed after a user signs on to
Advantage CA-Roscoe.
HELPPFX= Defines the prefix of the profile Library
containing the HELP facility members.
HELPPFX1= Defines the prefix of the profile Library
containing the user specified HELP
facility members.
IMPASIS= Forces the IMPORT Monitor routine to Data Set
always use ASIS (that is, binary data is
retrieved with binary character
replacement).
| INFRECAL= Establishes recall specification for the Data Set
| INFO DSN command.
JOBEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to control user access to the JES
SPOOLs through ATTACH JOB.
LIBACCES= Establishes the display for Library Library
Facility member lists.
LIBALTER= Establishes the default Library Facility Library
Selection List field modification setting.
LIBCACHE= Defines the maximum amount of Library
storage to be acquired by the Library
Cache Facility.
LIBCFRMM= Establishes the default setting for Library
Library Facility member delete
confirmation.
LIBEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to enable user execution of
Advantage CA-Roscoe Library
Administrator functions.

Chapter 1. Advantage CA-Roscoe 1-19


1.5 Program Requirements

Table 1-4 (Page 8 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


LIBRCCF= Identifies the location of an AllFusion Data Set
CA-Librarian CCF Master File Definition
Table (member $CHGT004) that is to be
processed.
LIBXLIB= Defines the number of: 1) library buffers Library
to be available, and 2) printers that are
expected to be simultaneously active.
LOOP= Defines the maximum number of RPF RPF
statements that can be executed without
an intervening read or write operation.
LOOPDFLT= Defines the default number of RPF RPF
statements that can be executed without
an intervening read or write operation.
LOOPRST= Controls the use of the RESET operand RPF
with the SET STMTCNT command.
MASTER= Establishes the default setting for the SET
SET MASTER command.
MIX= Establishes the default setting for the SET
SET MODE MIX/NOMIX command.
MODE= Establishes the default display format SET
setting for the SET DISPLAY command.
MONEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to control user access to Monitor
routines.
MONLEVEL= Establishes the default setting for the SET
SET MONLEVEL command.
MONTRAP= Establishes the default setting for the SET
SET MONTRAP command.
MPL= Defines the number of 10K user Environment
execution areas (that is,
Multi-Programming Levels) that are to
be available for this execution of
Advantage CA-Roscoe.
MSGCLASS= Defines the internal reader message Environment
class. (For use by JES2 and JES3 sites.)

1-20 Programs and Utilities Guide


1.5 Program Requirements

Table 1-4 (Page 9 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


NOLRM= Disables the interface that allows sites Environment
with Unicenter CA-Look to issue the
Unicenter CA-Look command D
ROSCOE during this execution of
Advantage CA-Roscoe.
NONSWAP Causes the main task components of Environment
Advantage CA-Roscoe to be designated
as non-swappable.
NOPROMPT Prevents prompts from being directed to Operator
the operator console during Advantage
CA-Roscoe initialization.
NOSDUMP Prevents Advantage CA-Roscoe from Environment
attempting to direct a dump to a
SYS1.DUMPnn data set if Advantage
CA-Roscoe should abend. (All other
termination processing does occur.)
NOSPIE Deactivates Advantage CA-Roscoe's Environment
SPIE exit.
NOTIFY= Causes JES2/JES3 status messages to be AJOB and
written to the user's terminal. Display
NSNAATTN= Defines the PA key that is to be the site Environment
attention key.
NTOATTN= Detects an 'attention with data' Environment
condition.
OFF= Designates whether the OFF or OFFON RPF
commands may be issued from within
an RPF program.
| OFFRPF= Identifies the library member containing RPF
| the RPF program that is to be used as
| the global signoff procedure.
ONRPF= Identifies the library member containing RPF
the RPF program that is to be used as
the global sign-on procedure.
PASSWORD= Defines the universal Advantage Environment
CA-Roscoe password.
PAUSE= Sets the Monitor command pause count. Monitor
PERMVARS= Defines the maximum number of RPF
permanent variables that can be used in
an RPF program.

Chapter 1. Advantage CA-Roscoe 1-21


1.5 Program Requirements

Table 1-4 (Page 10 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


PFKDELIM= Establishes the default special character SET
that is to be used as a delimiter when
assigning multiple commands to a PF
key.
PFSPLIT= Establishes the default setting for the SET
SET SPLIT command.
PRELOAD= Identifies a program that is to be ETSO
preloaded at Advantage CA-Roscoe
startup.
PRESERVE= Establishes the default setting for the SET
SET MODE PRESERVE/NOPRESERVE
command.
PRVEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to control user execution of
restricted (Privileged) commands.
PSCBUID= Designates how Advantage CA-Roscoe ETSO
is to build the PSCBUSER field in the
PSCB.
PSCBUNIT= Defines a unit name that is used by Environment
dynamic allocation when an allocation
request is received that requires a unit
name and none is specified.
PSCBUSER= Designates the contents of the ETSO
PSCBUSER field in Advantage
CA-Roscoe's pseudo-PSCB.
PUSHDEF= Establishes the default setting for the Environment
PUSH command when executed from
within an RPF.
RCSESCCH= Identifies the special character that is to RCS
be used to prefix the one-character RCS
escape sequence commands.
RCSESCPF= Identifies the PF key that is to be used RCS
to indicate direct escape sequence
command input to RCS.
RCSGEN= Identifies the member on CAI.RO60LIB RCS
containing the Communication Network
definition that is to be used for this
execution of Advantage CA-Roscoe.

1-22 Programs and Utilities Guide


1.5 Program Requirements

Table 1-4 (Page 11 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


RCSTRACE= Designates whether RCS tracing is to be RCS
active during Advantage CA-Roscoe
initialization.
RDMBLOCK= Defines the size of an internal work area RPF
used by the ROSCOE Data Manager
(RDM) to store local variable
information for each user.
| RECALNUM= Indicates whether Advantage CA-Roscoe Data Set
| processes request numbers from recall
| packages.
| RECALVOL= Designates the volume serial to be used Data Set
| when accessing migrated data sets.
| RECALVL2= Designates the volume serial to be used Data Set
| when accessing migrated data sets.
| RECALVL3= Designates the volume serial to be used Data Set
| when accessing migrated data sets.
RECVRAWS= Control execution of the SAVEAWS AWS
program during Advantage CA-Roscoe
initialization.
RESHLQ= Designates whether the security Environment
resource high level qualifier, ROSID,
should precede Advantage CA-Roscoe
resource names.
RESPLINE= Establishes the default setting for the SET
SET SYSID and SET USERID
commands.
RESTART= Establishes how outstanding requests RPS
are to be handled when RPS is restarted
after a normal or abnormal termination.
ROSAPPL= Identifies the Advantage CA-Roscoe RCS
VTAM application name. APPL macro
for Advantage CA-Roscoe.
ROSGBL= Identifies the version of the ROSGBL AJOB and
load module that is to be used for this Display
execution of Advantage CA-Roscoe.
ROSID= Assigns an identification code to Environment
Advantage CA-Roscoe.
ROSLOG= Designates whether messages are to be Operator
directed to the operator console.

Chapter 1. Advantage CA-Roscoe 1-23


1.5 Program Requirements

Table 1-4 (Page 12 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


ROSMSG= Controls the use of the Advantage Operator
CA-Roscoe command MESSAGE.
ROSPRTCT= Identifies the password coded on the RCS
VTAM APPL macro for Advantage
CA-Roscoe.
RPFEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to control user access to RPFs.
RPFLABEL= Designates whether an RPF program RPF
must start with a label.
RPSCSECT= Identifies the member on CAI.RO60LIB RPS
containing the RPS printing network
environment definition that is to be
used for this execution of Advantage
CA-Roscoe.
RPSKEY= Identifies the sign-on key associated RPS
with the profile that is to be used as the
RPS spool queue.
RPSNOTFY= Establishes the default setting for the SET Cmd.
SET RPSNOTIFY (or RPSNOTIFY)
command.
RPSPFX= Identifies the prefix associated with the RPS
profile that is to be used as the RPS
spool queue.
RTM= Controls the activation of the RTM
Response-Time Monitor.
RTMCFCMD= Defines the complexity factor to be RTM
associated with the number of
commands processed.
RTMCFCPU= Defines the complexity factor to be RTM
associated with the number of CPU
timer units used.
RTMCFDIO= Defines the complexity factor to be RTM
associated with the disk I/O complexity
factor.
RTMCMARK= Defines one to three values that indicate RTM
the number of RTM complexity level
markers and the value to be associated
with each.

1-24 Programs and Utilities Guide


1.5 Program Requirements

Table 1-4 (Page 13 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


RTMINTVL= Defines the interval (that is, number of RTM
minutes) to be used in writing the RTM
records (that is, the PSE) to the
accounting files.
RTMLIB= Identifies the library member that RTM
contains a list of users or terminals that
are to be included or excluded from
monitoring.
RTMSYNC= Designates whether the interval defined RTM
by RTMINTVL= is to be synchronized
with the hour.
RTMTMARK= Defines one to five values that indicate RTM
the number of RTM time buckets and
the value to be associated with each.
RTMXMIT= Designates whether computed response RTM
time is to include CPU processing time
and data transmission time.
RUN= Identifies the Monitor commands that Monitor
are to be available for this execution of
Advantage CA-Roscoe.
SAVEATTR= Establishes the default access attribute SET
setting for the SET SAVEATTR
command.
SCROLL= Establishes the default setting for the SET
SET SCROLL command.
SEARCH= Establishes the default setting for the SET
SET SEARCH command.
SEND= Sends a message to each user after they Sign-on
have signed on to Advantage
CA-Roscoe.
SIGNON= Controls the users ability to sign on to Sign-on
Advantage CA-Roscoe.
SONMSG= Displays a one-line message on the Sign-on
Advantage CA-Roscoe sign-on screen.
SRTDDPFX= Establishes the four character prefix Environment
used by the site sort utility to construct
the sort work DD name.

Chapter 1. Advantage CA-Roscoe 1-25


1.5 Program Requirements

Table 1-4 (Page 14 of 14). Advantage CA-Roscoe Initialization Parameter Summary

Parameter Description Category


SRTREGN= Defines the maximum amount of Environment
storage that a site SORT utility is
permitted to use.
SRTSTORG= Defines the maximum amount of Environment
storage that Advantage CA-Roscoe's
SORT utility is permitted to use.
STANDARD= Establishes the character translation SET
default for the SET MODE command.
STATS= Establishes the default setting for the SET
SET STATS command.
SUBINCL= Establishes the default for +INC SET
statement expansion used by the SET
SUBMIT command.
SUBNOSEQ= Establishes the default for sequence SET
number inclusion used by the SET
SUBMIT command.
SUBWIDTH= Establishes the default width used by SET
the SET SUBMIT command.
TERMSO= Defines the number of concurrent RCS
Advantage CA-Roscoe subsessions that
can be active.
TEST Initializes a Advantage CA-Roscoe Environment
system as a test system.
UPSEXT= Signifies whether Advantage CA-Roscoe Environment
is to use external or internal security
calls to control user access to UPS
functions.
VTAM= Defines the number of VTAM terminals RCS
that can be concurrently signed on to
Advantage CA-Roscoe.
XTPM= Defines the number of Advantage RCS
CA-Roscoe sessions that can be
dedicated to XTPM sessions.

1-26 Programs and Utilities Guide


1.5 Program Requirements

1.5.3 JES2 Dynamic Spool Pack Configuration


The spool is the repository for all input jobs and most system output
(SYSOUT) that JES2 manages. To maximize spool efficiency due to fluctuating
workload requirements, such as month-end processing or to correct
maintenance problems such as I/O errors and hardware failures, JES2 provides
a facility to dynamically add and delete spool data sets through the use of the
operator commands ($S SPL, $P SPL, and $Z SPL).

Advantage CA-Roscoe does not recognize the dynamic addition or deletion of


spool packs. If the operator issues one of the above commands to dynamically
alter the spool configuration, Advantage CA-Roscoe must be recycled.

Chapter 1. Advantage CA-Roscoe 1-27


1.6 Accounting-Related Parameters

1.6 Accounting-Related Parameters


The following initialization parameters are used to control the accounting
information generated by Advantage CA-Roscoe.

1.6.1 ACCTBUFF= Parameter


Establishes the number and size of the buffers to be used to hold accounting
records.

1.6.1.1 Syntax

ACCTBUFF Function
┌─2───┐ ┌─28─┐
──ACCTBUFF=──┴─num─┴──,──┴─size─┴─────────────────────────────

num is a value between 2 and 10 that represents the number of internal


buffers to be used for this execution.
size is a value between 1024 and 32760 that represents the size of the
internal buffers to be used to hold the accounting records.

1.6.1.2 Notes

Additional information about this initialization parameter:


■ The default is ACCTBUFF=2,2008.
■ When an internal buffer is full, it is written to the accounting files.
Therefore, the size of the internal buffers must be compatible with the
block size of the accounting files. If the sizes are not equal, Advantage
CA-Roscoe opens the file with:
– The internal buffer size - if it is: 1) larger than the file block size, or 2)
smaller than the block size but all of the files are empty.
– The file block size - if it is larger than the internal buffer size and the
starting file is partially full. When this occurs, Advantage CA-Roscoe
sets the internal buffer size to the value of the block size.

1.6.2 ACCTOPT= Parameter


Designates whether library statistics are to be calculated when the user signs
off.

1-28 Programs and Utilities Guide


1.6 Accounting-Related Parameters

1.6.2.1 Syntax

ACCTOPT Function
┌─LIBSTAT───┐
──ACCTOPT=──┴─NOLIBSTAT─┴─────────────────────────────────────

LIBSTAT causes library statistics to be calculated and added to the user's


sign-off accounting record.
NOLIBSTAT prevents library statistics from being calculated.

1.6.2.2 Notes

Additional information about this initialization parameter:


■ The default is ACCTOPT=LIBSTAT.
■ This parameter provides library statistics for those users who sign on to
Advantage CA-Roscoe. To obtain library usage information about everyone
defined to Advantage CA-Roscoe, specify the LIBSTAT option when
executing the ACCTDUMP program.

Chapter 1. Advantage CA-Roscoe 1-29


1.6 Accounting-Related Parameters

1.6.3 ACCTREC= Parameter


Defines the type of records that are to be produced.

1.6.3.1 Syntax

ACCTREC Parameter
──ACCTREC=──┬─┬─ACCT─┬─────┬──────────────────────────────────
│ ├─MON──┤ │
│ ├─SOFF─┤ │
│ ├─SON──┤ │
│ └─VPE──┘ │
├─AWS──────────┤
├─DSF──────────┤
├─┬─DSFAUDIT─┬─┤
│ ├─DSFALIAS─┤ │
│ ├─DSFALLOC─┤ │
│ ├─DSFATT───┤ │
│ ├─DSFCAT───┤ │
│ ├─DSFCOMP──┤ │
│ ├─DSFCOPY──┤ │
│ ├─DSFDEL───┤ │
│ ├─DSFDPOS──┤ │
│ ├─DSFGDG───┤ │
│ ├─DSFINFO──┤ │
│ ├─DSFPRT───┤ │
│ ├─DSFREAD──┤ │
│ ├─DSFREL───┤ │
│ ├─DSFREN───┤ │
│ └─DSFUCAT──┘ │
├─RPF──────────┤
├─RPS──────────┤
├─RSR──────────┤
├─RTM──────────┤
└─USER─────────┘

ACCT activates and produces Monitor, Sign-off, Sign-on and VPE


records.
To produce specific records, specify one or more of the
following:
MON produces Advantage CA-Roscoe-written
Monitor records.
SOFF produces sign-off records.
SON produces sign-on records.
VPE produces VPE (for example, ETC) records.

1-30 Programs and Utilities Guide


1.6 Accounting-Related Parameters

AWS activates and produces AWS statistics records.


DSF activates Data Set Facility recording.
DSFAUDIT produces all types of Data Set Facility records.
To produce specific records, specify one or more of the
following:
DSFALIAS produces define alias records.
DSFALLOC produces allocate data set records.
DSFATT produces attach data set records.
DSFCAT produces catalog data set records.
DSFCOMP produces compress data set records.
DSFCOPY produces copy data set records.
DSFDEL produces delete data set records.
DSFDPDS produces delete PDS member records.
DSFGDG produces define GDG records.
DSFINFO produces INFO data set records.
DSFPRT produces print data set records.
DSFREAD produces READ DSN records.
DSFREL produces release space records.
DSFREN produces rename data set records.
DSFUCAT produces uncatalog data set records.
RPF activates and produces RPF program execution records.
RPS activates and produces RPS PRINT request accounting records.
RSR activates and produces MPL=, LIBXLIB= AWSCACHE= and
Data Set Facility records.
RTM activates and produces RTM Response-Time Monitor records.
USER activates and produces site-written accounting records.

1.6.3.2 Notes

Additional information about this initialization parameter:


■ The default is:
ACCTREC=ACCT
ACCTREC=AWS
ACCTREC=DSF
ACCTREC=DSFAUDIT
ACCTREC=RTM
ACCTREC=USER
■ Specify one ACCTREC= for each type of record to be written.
■ When ACCTREC=RPF is in effect, Advantage CA-Roscoe performance may
be adversely affected since an accounting record is written every time an
RPF program is executed (from the terminal or from within an RPF
program).

Chapter 1. Advantage CA-Roscoe 1-31


1.6 Accounting-Related Parameters

1.6.4 ACCTROS= Parameter


Designates whether Advantage CA-Roscoe accounting records are to be
written to the Advantage CA-Roscoe accounting files.

1.6.4.1 Syntax

ACCTROS Parameter
┌─OFF─┐
──ACCTROS=──┴─ON──┴───────────────────────────────────────────

OFF disables writing accounting records to the Advantage CA-Roscoe


accounting files.
ON enables writing accounting records.

1.6.4.2 Notes

Additional information about this initialization parameter:


■ The default is ACCTROS=OFF.
■ This parameter provides library statistics for those users who sign on to
Advantage CA-Roscoe. To obtain library usage information about everyone
defined to Advantage CA-Roscoe, specify the LIBSTAT option when
executing the ACCTDUMP program.

1.6.5 ACCTSMF= Parameter


Designates whether Advantage CA-Roscoe accounting records are to be
written to the SMF files.

1.6.5.1 Syntax

ACCTSMF Parameter
┌─OFF────────────────────┐
──ACCTSMF=──┼─INACT──────────────────┼────────────────────────
│ ┌─,SVC83─────┐ │
└─ON,nnn─┼────────────┼──┘
├─,NOSVC─────┤
└─,NOSUSPEND─┘

OFF prohibits writing Advantage CA-Roscoe accounting records to the


SMF files.
INACT prohibits writing Advantage CA-Roscoe accounting to the SMF files
but allows this facility to be activated by the ACCT SMF ON
command.

1-32 Programs and Utilities Guide


1.6 Accounting-Related Parameters

ON causes accounting records to be written to the SMF files. ON must


be qualified with:
nnn is a value from 128 to 255 representing the user SMF
record number that Advantage CA-Roscoe is to use.
ON may optionally be further qualified with:
SVC issues SVC83 to write to the SMF data set. (Default.)
NOSVC causes a branch-enter to the SMF Writer module.
(Use this only when the SMFEWTM macro is
included in your site's SYS1.MACLIB.)
NOSUSPEND
causes a branch-enter to the SMF Writer module.
Advantage CA-Roscoe is not suspended if an SMF
buffer shortage condition occurs (that is, no SMF
record is written). (Use this only when the
SMFEWTM macro is in your site's SYS1.MACLIB

1.6.5.2 Notes

Additional information about this initialization parameter:


■ The default is ACCTSMF=OFF.
■ If multiple operands are specified, they must be separated by commas and
bound by delimiters (for example, (ON,128,SVC)).
■ Unless ACCTOPT=NOLIBSTAT is specified, the records contain library
statistics about users who have signed on to Advantage CA-Roscoe. The
ACCTDUMP program can be used to obtain library statistics about all
users.

Chapter 1. Advantage CA-Roscoe 1-33


1.7 ATTACH JOB and DISPLAY-Related Parameters

1.7 ATTACH JOB and DISPLAY-Related Parameters


The following initialization parameters are used to establish the environment
for obtaining information about jobs executed in batch.

1.7.1 AJOB Parameter


Activates ATTACH JOB processing.

1.7.1.1 Syntax

AJOB Parameter
──AJOB──(no operands)─────────────────────────────────────────

1.7.1.2 Notes

Additional information about this initialization parameter:


■ If omitted, users are not able to view job output at their terminals through
the ATTACH JOB command.

1.7.2 DISAUTHO= Parameter


Identifies the library member containing the DISPLAY Authorization Table.

1.7.2.1 Syntax

DISAUTHO Parameter
┌─RO.DISAUTHO─┐
──DISAUTHO=──┴─mem─────────┴──────────────────────────────────

mem is the name of a library member. If no prefix is specified, RO is


assumed.

1.7.2.2 Notes

Additional information about this initialization parameter:


■ The default is DISAUTHO=RO.DISAUTHO.
■ See the description of the DISAUTHO program for additional information.

1-34 Programs and Utilities Guide


1.7 ATTACH JOB and DISPLAY-Related Parameters

1.7.3 NOTIFY Parameter


Causes JES2/JES3 status messages to be written to the user's terminal.

1.7.3.1 Syntax

NOTIFY Parameter
──NOTIFY──(no operands)───────────────────────────────────────

1.7.3.2 Notes

Additional information about this initialization parameter:

■ If NOTIFY is omitted, NOTIFY processing is not performed.


■ For additional information, see the Advantage CA-Roscoe Interactive
Environment System Reference Guide.

1.7.4 ROSGBL= Parameter


Identifies the version of the ROSGBL load module that is to be used for this
execution of Advantage CA-Roscoe.

1.7.4.1 Syntax

ROSGBL Parameter
──ROSGBL=──┬──────┬───────────────────────────────────────────
└─code─┘

code is a one- or two-character code identifying the ROSGBL load


module version to be used.

1.7.4.2 Notes

Additional information about this initialization parameter:


■ If ROSGLB= is omitted or specified with no code, the macro is assumed to
be named ROSGBL.
■ For additional information, see the description of the ROSGBL macro in
the Advantage CA-Roscoe Interactive Environment System Reference Guide.

Chapter 1. Advantage CA-Roscoe 1-35


1.8 AWS-Related Parameters

1.8 AWS-Related Parameters


The following initialization parameters are used to define the site's use of
AWSs.

1.8.1 AWSCACHE= Parameter


Enables the AWS Cache Facility and sets the maximum amount of storage to
be acquired by this facility.

1.8.1.1 Syntax

AWSCACHE Parameter
──AWSCACHE=──int1,──┬──────┬──────────────────────────────────
└─int2─┘

int1 is one or two integers. If you specify:


■ a single integer
When a single integer is specified, it is divided between cache
index and data blocks. It is suggested that you specify a single
value and allow Advantage CA-Roscoe to subdivide the space.
■ a pair of integers
When two integers are specified, they must be separated by a
comma (for example, AWSCACHE=nnn,nnn). The first value is
the amount of storage to be allocated for the cache index blocks;
the second value is the amount of storage to be allocated for the
cache data blocks.
The integer(s) may be suffixed with a K (for kilobytes) or M (for
megabytes). If neither K nor M is specified, bytes is assumed.

1.8.1.2 Notes

Additional information about this initialization parameter:


■ If AWSCACHE= is omitted, the AWS Cache Facility is not available.
■ See the description of the AWS Cache Facility in the Advantage CA-Roscoe
Interactive Environment System Reference Guide for suggested initial values.

1-36 Programs and Utilities Guide


1.8 AWS-Related Parameters

1.8.2 AWSDAYS= Parameter


Defines the number of days a SAVAWSnn member will remain in a user's
library before it is deleted.

1.8.2.1 Syntax

AWSDAYS Parameter
┌─5───┐
──AWSDAYS=──┴─num─┴───────────────────────────────────────────

num is a value between 0 and 999 representing the maximum number of


days a SAVAWSnn member will remain in an active user's library
before it is deleted.

1.8.2.2 Notes

Additional information about this initialization parameter:

■ An active user is one who is signed on.


■ The default is AWSDAYS=5.

1.8.3 AWSLIM= Parameter


Defines the maximum number of AWSs an individual user may use during a
Advantage CA-Roscoe session.

1.8.3.1 Syntax

AWSLIM Parameter
┌─5─────────────────┐
──AWSLIM=──┴─m─┬────┬──┬────┬──┴──────────────────────────────
└─,n─┘ └─,─┘

m is a numeric value between 2 and 64 that defines the maximum


number of AWSs per user session.
n is a numeric value between 2 and 64 that must be less than or equal
to m. It defines the maximum number of SESSION/SPLIT AWSs
per user session. If specified, a comma must separate n from m (for
example, AWSLIM=6,4).
o is a numeric value between 2 and 64 that must be less than or equal
to m. It defines the maximum number of recoverable AWSs per
user session. If specified, a comma must separate o from the other
operands (for example, AWSLIM=10,6,5).

Chapter 1. Advantage CA-Roscoe 1-37


1.8 AWS-Related Parameters

1.8.3.2 Notes

Additional information about this initialization parameter:


■ The default is AWSLIM=5.
■ If both/either n or o are omitted, there will be no limit imposed for this
AWS type, up to the maximum number, m.

1.8.4 RECVRAWS= Parameter


Control execution of the SAVEAWS program during Advantage CA-Roscoe
initialization.

1.8.4.1 Syntax

RECVRAWS Parameter
┌─ON─────────────────┐
──RECVRAWS=──┴─OFF─┬───────────┬──┴───────────────────────────
└─,NOMAXLIB─┘

ON causes the SAVEAWS program to be executed. (YES is a


synonym for ON.)
OFF prevents the SAVEAWS program from being executed. (NO is
a synonym for OFF.)
NOMAXLIB causes a SAVAWSnn member to be created for a user even if
this causes the user's library line limit to be exceeded. If
specified, a comma must separate NOMAXLIB from the
preceding operand (for example,
RECVRAWS=ON,NOMAXLIB).
If NOMAXLIB is omitted, the member is created only if the line
limit will not be exceeded.

1.8.4.2 Notes

Additional information about this initialization parameter:


■ The default is RECVRAWS=ON.

1-38 Programs and Utilities Guide


1.9 Data Set-Related Parameters

1.9 Data Set-Related Parameters


The following initialization parameters are used to define the site's use of the
Data Set Facility.

1.9.1 ALLRECAL= Parameter


Recall specification for the ALLOC DSN command.

1.9.1.1 Syntax

ALLRECAL Parameter
┌─WAIT───┐
──ALLRECAL=──┼─NOWAIT─┼───────────────────────────────────────
└─NONE───┘

WAIT recalls data sets through foreground requests.


NOWAIT recalls data sets through background requests.
NONE prohibits data sets from being recalled.

1.9.2 DSNBLDL= Parameter


Designates whether Advantage CA-Roscoe should issue a BLDL to locate a
PDS member.

1.9.2.1 Syntax

DSNBLDL Parameter
┌─NO──┐
──DSNBLDL=──┴─YES─┴───────────────────────────────────────────

NO do not issue a BLDL to locate the PDS member about to be


attached.
YES issue a BLDL to locate the PDS member about to be attached.

1.9.2.2 Notes

Additional information about this initialization parameter:


■ The default is DSNBLDL=NO.
■ Sites should only have DSNBLDL=YES if they have PDS member level
security in effect. When YES is in effect, Advantage CA-Roscoe issues a
BLDL each time a member of a PDS is about to be attached. This could
lead to excessive overhead, and should be avoided if at all possible.

Chapter 1. Advantage CA-Roscoe 1-39


1.9 Data Set-Related Parameters

■ When DSNBLDL=NO is in effect, Advantage CA-Roscoe does not issue a


BLDL to locate a PDS member. Therefore, if access is granted to the PDS, it
is also granted to all members in the selection list.

1.9.3 DSNCFRMD= Parameter


Establishes the default setting for data set delete confirmation.

1.9.3.1 Syntax

DSNCFRMD Parameter
┌─YES─┐
──DSNCFRMD=──┴─NO──┴──────────────────────────────────────────

YES sets the CONFIRM DELETE DSN: field of the Data Set Facility main
menu to YES for all users who do not have a DSN profile record in
the UPS. Users are required to confirm deletion of data sets.
NO sets the CONFIRM DELETE DSN: field of the Data Set Facility main
menu to NO for all users who do not have a DSN profile record in
the UPS. Data sets are deleted without user confirmation.

1.9.3.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCFRMD=YES.
■ Users who do not have a DSN profile record in the UPS account (as stated
above) include new users and those users who have never had a DSN
session.

1.9.4 DSNCFRMM= Parameter


Establishes the default setting for data set member delete confirmation.

1.9.4.1 Syntax

DSNCFRMm Parameter
┌─YES─┐
──DSNCFRMm=──┴─NO──┴──────────────────────────────────────────

YES sets the CONFIRM DELETE MEM: field of the Data Set Facility
main menu to YES for all users who do not have a DSN profile
record in the UPS. Users will be required to confirm deletion of
data set members.

1-40 Programs and Utilities Guide


1.9 Data Set-Related Parameters

NO sets the CONFIRM DELETE MEM: field of the Data Set Facility
main menu to NO for all users who do not have a DSN profile
record in the UPS. Data sets members will be deleted without user
confirmation.

1.9.4.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCFRMM=YES.
■ Users who do not have a DSN profile record in the UPS account (as stated
above) include new users and those users who have never had a DSN
session.

1.9.5 DSNCLIST= Parameter


Defines the number of catalog entries that should fit within an acquired work
area.

1.9.5.1 Syntax

DSNCLIST Parameter
┌─1─┐
──DSNCLIST=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 1 and 999999 representing the


number of catalog entries that are to fit within the acquired
work area.

1.9.5.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCLIST=100.
■ Advantage CA-Roscoe GETMAINs an area large enough to accommodate
the specified number of catalog entries. For additional information see the
Advantage CA-Roscoe Interactive Environment System Reference Guide.

1.9.6 DSNCMENQ= Parameter


Defines the level of data set control that is to be required for COMPRESS
processing.

Chapter 1. Advantage CA-Roscoe 1-41


1.9 Data Set-Related Parameters

1.9.6.1 Syntax

DSNCMENQ Parameter
┌─EXCLUSIVE─┐
──DSNCMENQ=──┴─SHARED────┴────────────────────────────────────

EXCLUSIVE exclusive control of the data set must be available in order for
it to be compressed.
SHARED while exclusive control of the data is preferable, shared data set
control is acceptable.

1.9.6.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCMENQ=EXCLUSIVE.

1.9.7 DSNCMLIM= Parameter


Defines the number of COMPRESS requests that may be concurrently active.

1.9.7.1 Syntax

DSNCMENQ Parameter
┌─4───┐
──DSNCMLIM=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 1 and 99999.


When specifying this value, take into consideration the resource
requirements (storage and I/O usage) of the utility program,
identified by the DSNCMPGM= parameter, that is performing
the compress processing.

1.9.7.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCMLIM=4.
■ If a COMPRESS request causes the limit to be reached. the user is placed
in a wait for two seconds before the request is retried. This process
continues until the user: 1) is able to compress the data set, or 2) cancels
the operation by signalling an attention interrupt.

1-42 Programs and Utilities Guide


1.9 Data Set-Related Parameters

1.9.8 DSNCMLST= Parameter


Defines the condition under which the ZZZZZCMP library member should not
be created or updated.

1.9.8.1 Syntax

DSNCMLST Parameter
┌─ERROR─┐
──DSNCMLST=──┴─INFO──┴────────────────────────────────────────

ERROR create/update the member only when a COMPRESS request


fails.
INFO create/update the member after each COMPRESS request
regardless of the outcome.

1.9.8.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCMLST=ERROR.
■ The library member named ZZZZZCMP is designed to contain
COMPRESS request diagnostic messages. DSNCMLST= designates whether
this member is created or updated.
■ No library line limit checking is performed when creating/updating the
ZZZZZCMP member in the user's library.

1.9.9 DSNCMPGM= Parameter


Identifies the program that is to be invoked to process COMPRESS requests.

1.9.9.1 Syntax

DSNCMPGM Parameter
┌─IEBCOPY─┐
──DSNCMPGM=──┴─pgm─────┴──────────────────────────────────────

pgm is the one- to eight-character name of the program to be invoked.

Chapter 1. Advantage CA-Roscoe 1-43


1.9 Data Set-Related Parameters

1.9.9.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCMPGM=IEBCOPY.
■ The program is invoked through a LINK SVC and must be capable of
processing an IEBCOPY-type parameter list. It receives control with
register 1 containing the address of the parameter list in supervisor state,
protect key 8 with APF authorization. The program may change state or
key but must return control to Advantage CA-Roscoe in the original state
and key. Sites specifying programs that do not adhere to the IEBCOPY
parameter list standard are responsible for performing any pre-processing
required to invoke their COMPRESS utility program.

1.9.10 DSNCNT= Parameter


Establishes the default and maximum number of lines to be searched within a
data set object.

1.9.10.1 Syntax

DSNCNT Parameter
┌─5,99999─┐
──DSNCNT=──┴─dflt,max───┴─────────────────────────────────────

dflt is the number of lines to be searched if nothing is specified with the


FIRST, LAST, NEXT, PREV, INCL, or EXCL command. The default
value must be equal to or less than the maximum value.
max is the maximum value that a user can specify with the SET
DSNCNT command. The maximum value cannot exceed 999999.

1.9.10.2 Notes

Additional information about this initialization parameter:


■ The default is DSNCNT=5000,99999.

1.9.11 DSNEMPTY= Parameter


Designates whether the Data Set Facility is to attempt to read data sets whose
DSCB (Data Set Control Block) indicate that they are empty.

1-44 Programs and Utilities Guide


1.9 Data Set-Related Parameters

1.9.11.1 Syntax

DSNEMPTY Parameter
┌─OFF──────┐
──DSNEMPTY=──┼─ON───────┼─────────────────────────────────────
├─PROHIBIT─┤
├─INHIBIT──┤
└─NEVER────┘

OFF prohibits attempts to read a data set marked empty.


ON causes an attempt to be made to read a data seet marked empty.
PROHIBIT, INHIBIT, or NEVER
prohibits attempts to read an empty data set and disables the use of
the SET DSNEMPTY command.

1.9.11.2 Notes

Additional information about this initialization parameter:


■ The default is DSNEMPTY=OFF.
■ As long as DSNEMPTY=PROHIBIT (or INHIBIT, or NEVER) is not
specified, users can issue the SET DSNEMPTY command to override this
parameter for a given session.

1.9.12 DSNINDEX= Parameter


Defines the maximum amount of storage (in K) to be acquired for line queue
elements when a user attaches a sequential data set, PDS member or AllFusion
CA-Librarian module.

1.9.12.1 Syntax

DSNINDEX Parameter
┌─8───┐
──DSNINDEX=──┴─num─┴──────────────────────────────────────────

num is the maximum amount of storage (in K) to be acquired. The value


must be at least 4K.

1.9.12.2 Notes

Additional information about this initialization parameter:


■ The default is DSNINDEX=8.
■ For additional information, see the Advantage CA-Roscoe Interactive
Environment System Reference Guide.

Chapter 1. Advantage CA-Roscoe 1-45


1.9 Data Set-Related Parameters

1.9.13 DSNLPRD2= Parameter


Designates whether PROD2 modules should be included in an AllFusion
CA-Librarian Selection List if the user fails to provide the proper management
code (MCD).

1.9.13.1 Syntax

DSNLPRD2 Parameter
┌─YES─┐
──DSNLPRD2=──┴─NO──┴──────────────────────────────────────────

YES Will list all modules in a master file bypassing member level
security. QUICK list so no checking is done. Check on member level
will then be done if module is attached.
NO Will check member level security and not list modules that do not
have read access.

1.9.13.2 Notes

Additional information about this initialization parameter:


■ The default is DSNLPRD2=YES.

1.9.14 DSNLPSWD= Parameter


Designates whether AllFusion CA-Librarian master file module password
protection for read operations is to be ignored.

1.9.14.1 Syntax

DSNLPSWD Parameter
┌─NO──┐
──DSNLPSWD=──┴─YES─┴──────────────────────────────────────────

NO ignore AllFusion CA-Librarian master file module password


protection for read operations (for example, ATTACH) even when
the master file was initialized with the AllFusion CA-Librarian
NOBYPP option.
YES enforce AllFusion CA-Librarian master file module password
protection for read operations if the master file was initialized with
the AllFusion CA-Librarian NOBYPP option.

1-46 Programs and Utilities Guide


1.9 Data Set-Related Parameters

1.9.14.2 Notes

Additional information about this initialization parameter:


■ The default is DSNLPSWD=NO.
■ Password protection is always enforced for non-read operations (for
example, DELETE and RENAME) if the master file was initialized with the
AllFusion CA-Librarian NOBYPP option.

1.9.15 DSNRECAL= Parameter


Designates the action to be taken when an operation is to be performed on a
data set migrated by the IBM program product DFHSM.

1.9.15.1 Syntax

DSNRECAL Parameter
┌─WAIT───┐
──DSNRECAL=──┼─NOWAIT─┼───────────────────────────────────────
└─NONE───┘

WAIT recalls data sets through foreground requests.


NOWAIT recalls data sets through background requests.
NONE prohibits data sets from being recalled.

1.9.15.2 Notes

Additional information about this initialization parameter:


■ The default is DSNRECAL=WAIT.

1.9.16 ENQTYPE= Parameter


Establishes how Advantage CA-Roscoe is to handle processing of partition
data set (PDS) and AllFusion CA-Librarian master files.

1.9.16.1 Syntax

ENQTYPE Parameter
┌─OS───┐
──ENQTYPE──┴─ISPF─┴───────────────────────────────────────────

OS Advantage CA-Roscoe is to use standard OS ENQ/DEQ logic.


ISPF Advantage CA-Roscoe is to use ISPF ENQ/DEQ logic.

Chapter 1. Advantage CA-Roscoe 1-47


1.9 Data Set-Related Parameters

1.9.16.2 Notes

Additional information about this initialization parameter:


■ The default is ENQTYPE=OS.
■ For additional information, see the section "Enqueue Logic" in the
Advantage CA-Roscoe Interactive Environment System Reference Guide.

1.9.17 IMPASIS Parameter


Forces the IMPORT Monitor routine to always use ASIS (that is, binary data is
retrieved with binary character replacement).

1.9.17.1 Syntax

IMPASIS Parameter
──IMPASIS──(no operands)──────────────────────────────────────

1.9.17.2 Notes

Additional information about this initialization parameter:


■ If IMPASIS is omitted, IMPORT translates all non-printable,
non-displayable characters to spaces.
The user can enable this facility on a per IMPORT execution basis by
issuing the ASIS operand.
■ If IMPASIS is specified, the user cannot disable this facility.

1.9.18 INFRECAL= Parameter


Recall specification for the INFO DSN command.

1.9.18.1 Syntax

INFRECAL Parameter
┌─WAIT───┐
──INFRECAL=──┼─NOWAIT─┼───────────────────────────────────────
└─NONE───┘

WAIT recalls data sets through foreground requests.


NOWAIT recalls data sets through background requests.
NONE prohibits data sets from being recalled.

1-48 Programs and Utilities Guide


1.9 Data Set-Related Parameters

1.9.19 LIBRCCF= Parameter


Identifies the location of an AllFusion CA-Librarian CCF Master File Definition
Table (member $CHGT004) that is to be processed.

1.9.19.1 Syntax

LIBRCCF Parameter
──LIBRCCF=──pfx───────────────────────────────────────────────

pfx is the two- or three-character prefix identifying the location of a


table.

1.9.19.2 Notes

Additional information about this initialization parameter:


■ If LIBRCCF= is omitted, there are no data set names for which restricted
processing will be performed.
■ A maximum of 255 unique LIBRCCF= parameters may be specified any
parameters beyond the limit are ignored. If multiple LIBRCCF= parameters
are specified and duplicate entries are found, the Access Control
Information Table entry is marked to indicate that only the lowest common
access level permitted by all the entries is to be allowed.
■ LIBRCCF= is valid with AllFusion CA-Librarian release 3.7 and beyond.
It allows a site using the AllFusion CA-Librarian Change Control Facility
(CCF) to specify the location of the Master File Definition Tables that are to
be used by Advantage CA-Roscoe to create Access Control Information
Tables for master files under CCF control. These tables are used by the
Data Set Facility and the EXPORT and IMPORT Monitor routines to
determine whether access to a master file index or module is to be
allowed.

1.9.20 RECALNUM= Parameter


Indicates whether Advantage CA-Roscoe should wait for the archival product
to supply recall request number.

Chapter 1. Advantage CA-Roscoe 1-49


1.9 Data Set-Related Parameters

1.9.20.1 Syntax

RECALNUM Parameter
┌─YES─┐
──RECALNUM──=──┴─NO──┴────────────────────────────────────────

YES indicates that Advantage CA-Roscoe is to process request numbers


from the recall package (default).
NO indicates that recall package does not provide request numbers and
Advantage CA-Roscoe will not process them.
Note: To specify RECALNUM=Y (YES), each recall package must support
the recall request number feature. Otherwise specify
RECALNUM=N(NO). Recall packages such as Sam's Disk and FDR
ABR do not supply recall numbers.

1.9.21 RECALVOL= Parameter


Designates the volume serial to be used when accessing migrated data sets.

1.9.21.1 Syntax

RECALVOL Parameter
┌─MIGRAT─┐
──RECALVOL──┴─ARCIVE─┴────────────────────────────────────────

MIGRAT indicates that the volume serial number to be used when accessing
migrated data sets is MIGRAT (default).
ARCIVE indicates that the volume serial number to be used when accessing
migrated data sets is ARCIVE.

|1.9.22 RECALVL2= Parameter


| Designates the volume serial to be used when accessing migrated data sets
| when archiving multiple volsers.

|1.9.22.1 Syntax
|
| RECALVL2 Parameter
| ┌─MIGRAT─┐
| ──RECALVL2──┴─ARCIVE─┴────────────────────────────────────────

| MIGRAT indicates that the volume serial number to be used when accessing
| migrated data sets is MIGRAT (default).

1-50 Programs and Utilities Guide


1.9 Data Set-Related Parameters

| ARCIVE indicates that the volume serial number to be used when accessing
| migrated data sets is ARCIVE.

|1.9.23 RECALVL3= Parameter


| Designates the volume serial to be used when accessing migrated data sets
| when archiving multiple volsers.

|1.9.23.1 Syntax
|
| RECALVL3 Parameter
| ┌─MIGRAT─┐
| ──RECALVL3──┴─ARCIVE─┴────────────────────────────────────────

| MIGRAT indicates that the volume serial number to be used when accessing
| migrated data sets is MIGRAT (default).
| ARCIVE indicates that the volume serial number to be used when accessing
| migrated data sets is ARCIVE.

Chapter 1. Advantage CA-Roscoe 1-51


1.10 Environment-Related Parameters

1.10 Environment-Related Parameters


The following initialization parameters are used to establish the Advantage
CA-Roscoe environment.

1.10.1 ACFEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls for user sign-on.

1.10.1.1 Syntax

ACFEXT Parameter
┌─NO──┐
──ACFEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.1.2 Notes

Additional information about this initialization parameter:


■ The default is ACFEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

1.10.2 AUTINTVL= Parameter


Defines how long Advantage CA-Roscoe is to wait before rechecking for
inactive terminals.

1.10.2.1 Syntax

AUTINTVL Parameter
┌─1───┐
──AUTINTVL=──┴─num─┴──────────────────────────────────────────

num is the number of minutes, ranging from 1 to 1440 (24 hours),


Advantage CA-Roscoe is to wait.
Specifying AUTINTVL with no value (that is, AUTINTVL=) is
comparable to specifying AUTINTVL=1.

1-52 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.2.2 Notes

Additional information about this initialization parameter:


■ The default is AUTINTVL=1.
■ AUTINTVL= is used by the automatic sign-off parameter AUTOFVAL=
and the automatic terminal lock parameter AUTTLVAL=
If AUTOFVAL= or AUTTLVAL= is specified, their values must be equal to
or a multiple of the value specified with AUTINTVL=. If they are not,
their values are adjusted internally. For example, if the parameters are
specified as:
AUTINTVL=5
AUTOFVAL=8,8,2
AUTTLVAL=2,5
the values of AUTOFVAL= and AUTTLVAL= are internally changed to:
AUTOFVAL=1,1,5
AUTTLVAL=5,5

1.10.3 AUTOFF= Parameter


Controls the use of the automatic sign-off facility.

1.10.3.1 Syntax

AUTOFF Parameter
┌─NO──┐
──AUTOFF=──┴─YES─┴────────────────────────────────────────────

NO deactivates the facility. (OFF is a synonym for NO).


YES activates the facility. (ON is a synonym for YES).

1.10.3.2 Notes

Additional information about this initialization parameter:


■ The default is AUTOFF=NO.
■ Users may enable this facility for themselves using the SET AUTOFF
command.

1.10.4 AUTOFVAL= Parameter


Sets the amount of time the terminal may be inactive before being
automatically signed off.

Chapter 1. Advantage CA-Roscoe 1-53


1.10 Environment-Related Parameters

1.10.4.1 Syntax

AUTOFVAL Parameter
┌─3,3,2──────────────────┐
──AUTOFVAL=──┴─ses─┬──────┬──┬───────┬──┴─────────────────────
└─,max─┘ └─,sign─┘

ses is the number of minutes a terminal may be signed on, with a


session in progress and there is no activity. The minimum is 1; the
default is 30; the maximum if 1440 (24 hours).
max is the maximum number of minutes a user can specify with the SET
AUTOFF command. The default is 30; the maximum is 1440. (This
value must be equal to or greater than the value specified as 30.)
sign is the number of minutes a Advantage CA-Roscoe sign-on screen
may be displayed and there is is no activity. The minimum is 1; the
default is 2; the maximum is 1440.

1.10.4.2 Notes

Additional information about this initialization parameter:


■ The default is AUTOFVAL=30,30,2.
■ The values specified for 'ses', 'max' and 'sign' must be equal to or a
multiple of the value specified with AUTINTVL=.

1.10.5 AUTTLOCK= Parameter


Controls the use of the automatic terminal lock facility.

1.10.5.1 Syntax

AUTTLOCK Parameter
┌─NO──┐
──AUTTLOCK=──┴─YES─┴──────────────────────────────────────────

NO deactivates the facility. (OFF is a synonym for NO.)


YES activates the facility. (ON is a synonym for YES.)

1.10.5.2 Notes

Additional information about this initialization parameter:

■ The default is AUTTLOCK=NO.


■ Users may enable this facility for themselves using the SET TLOCK
command.

1-54 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.6 AUTTLVAL= Parameter


Sets the amount of time the terminal may be inactive before the Terminal Lock
screen is automatically displayed.

1.10.6.1 Syntax

AUTTLVAL Parameter
┌─5────┐ ┌─,5───┐
──AUTTLVAL=──┼──────┼──┼──────┼───────────────────────────────
└─sign─┘ └─,max─┘

sign is the number of minutes a terminal may be signed on, with a


session in progress, and there is no activity. The minimum is the
value specified with the AUTINTVL= parameter; the default is 5;
the maximum is 1440 (24 hours).
max is the maximum number of minutes a user can specify with the SET
TLOCK command. The default is 5; the maximum is 1440.

1.10.6.2 Notes

Additional information about this initialization parameter:


■ The default is AUTTLVAL=5,5.
■ The values 'sign' and 'max' must be equal to or greater than the value
specified with AUTINTVL=.

1.10.7 BREAK= Parameter


Sets the maximum number of lines that can be written at a TTY device before
pausing.

1.10.7.1 Syntax

BREAK Parameter
┌────┐
──BREAK=──┴─num─┴─────────────────────────────────────────────

num is the number of lines to be written before pausing. The value can
range from 0 to 32760.

Chapter 1. Advantage CA-Roscoe 1-55


1.10 Environment-Related Parameters

1.10.7.2 Notes

Additional information about this initialization parameter:


■ The default is BREAK=0.
■ BREAK= is for TTY devices where the hardware break feature is not used.
This value is used by the BREAK command.

1.10.8 CHAR= Parameter


Defines the language code(s) which identify the character set(s) that may be
entered and displayed at the terminal.

1.10.8.1 Syntax

CHAR Parameter
┌─USENGLISH─┐
──CHAR=──┴─code──────┴────────────────────────────────────────

code is one of the language codes shown in the following chart.

1.10.8.2 Notes

Additional information about this initialization parameter:


■ The default is CHAR=USENGLISH.
■ If multiple language character sets are desired, specify one CHAR=
parameter for each character set that Advantage CA-Roscoe is to recognize.
When you specify multiple language codes, you only need to define the
character that is to be the default with the CHARDFLT= parameter.

Language Character Set Codes

Code Code Code


ALTAUSTRIAN CYRILLIC KANJI
ALTDANISH DANISH NEWBELGIAN
ALTFINNISH FINISH NEWSWISSFRENCH
ALTGERMAN FRENCH NEWSWISSGERMAN
ALTNORWEGIAN FRENCHAZERTY NORWEGIAN
ALTPORTUGUESE GERMAN PORTUGUESE
ALTSPANISH GREEK SPANISH
ALTSWEDISH HANGEUL SPANISHSPEAKING
ARABIC HEBREW SWEDISH
ARABIC2 HEBREWN SWISS
AUSTRIAN HEBREWO SWISSFRENCH
BELGIAN ICELANDIC SWISSGERMAN
BRAZILIAN INTERNATIONAL TURKISH

1-56 Programs and Utilities Guide


1.10 Environment-Related Parameters

Code Code Code


CANADIANBILINGUAL ITALIAN UKENGLISH
CANADIANFRENCH JAPANESEENGLISH USENGLISH
CPROG KATAKANA YUGOSLAV

Code Abbreviations

Abbr. Code Abbr. Code


A (Austrian) I (Italian)
B (Belgian) INTL (International)
CH (Swiss) JPENGLISH (JapaneseEnglish)
D (German) KANA (Katakana)
DK (Danish) N (Norwegian)
E (Spanish) S (Swedish
F (French) UK (UKEnglish)
GB (UKEnglish) USA (USEnglish)

1.10.9 CHARDFLT= Parameter


Defines the language code that is to be the default character set.

1.10.9.1 Syntax

CHARDFLT Parameter
┌─USENGLISH─┐
──CHARDFLT=──┴─code──────┴────────────────────────────────────

code is one of the language codes shown in the preceding chart and
specified through the CHAR= parameter.

1.10.9.2 Notes

Additional information about this initialization parameter:


■ The default is CHARDFLT=USENGLISH.
■ Users may override the default language character set through the SET
CHARSET command.

1.10.10 CLLEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to control user access to the program calls made by ETSO.

Chapter 1. Advantage CA-Roscoe 1-57


1.10 Environment-Related Parameters

1.10.10.1 Syntax

CLLEXT Parameter
┌─NO──┐
──CLLEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.10.2 Notes

Additional information about this initialization parameter:


■ The default is CLLEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of Internal and External security.

1.10.11 CMDISABL= Parameter


Defines the library member that contains a list of the commands that are to be
disabled during Advantage CA-Roscoe initialization.

1.10.11.1 Syntax

CMDISABL Parameter
──CMDISABL=──mem──────────────────────────────────────────────

mem is the library member name.

1.10.11.2 Notes

Additional information about this initialization parameter:


■ If no prefix is specified for the library member, it is assumed to be in the
library of the individual assigned the RO prefix.
■ The syntax for this member is one command per line, and each command
must begin in column 1.
■ Comments can be included by preceding the comment with a blank or by
placing an '*' in column 1 of the line.

1-58 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.12 CMQE= Parameter


Defines the number of command queue elements in the system pool that are to
be allocated in common storage.

1.10.12.1 Syntax

CMQE Parameter
┌─1──┐
──CMQE=──┴─num─┴──────────────────────────────────────────────

num is a numeric value between 2 and 100.

1.10.12.2 Notes

Additional information about this initialization parameter:


■ The default is CMQE=10.
■ The system pool is used to hold operator commands that are awaiting
processing.

1.10.13 COMCHAR= Parameter


Defines the special character that is to be used in place of 'F jobname,' in
operator commands.

1.10.13.1 Syntax

COMCHAR Parameter
──COMCHAR=──char──────────────────────────────────────────────

mem is the library member name.

1.10.13.2 Notes

Additional information about this initialization parameter:


■ If no special character is defined, then 'F jobname,' must precede each
operator command.
■ If your site is running multiple Advantage CA-Roscoes, either a unique
communications character must be defined for each Advantage CA-Roscoe
or the unique Advantage CA-Roscoe ID (specified through the ROSID=
parameter) must be included with the command. For example, if
COMCHAR= is omitted, the operator command must be specified as:
... F ROSCOE,SHUTDOWN NOW

Chapter 1. Advantage CA-Roscoe 1-59


1.10 Environment-Related Parameters

If COMCHAR=/ and ROSID=ROSC are specified, the same command can


be entered as:
/SHUTDOWN NOW or ... /ROSC SHUTDOWN NOW
See the description of the operator commands in the Advantage CA-Roscoe
Interactive Environment System Commands Guide for additional information.

1.10.14 CRBUF= Parameter


Defines the size of the buffer that is used for command recall (via the +
pseudo-command).

1.10.14.1 Syntax

CRBUF Parameter
┌─256──┐
──CRBUF=──┴─size─┴────────────────────────────────────────────

size is a size, in bytes, between 0 and 32760. Recommended sizes are 256
or 512. If CRBUF=0 is specified, no command recall buffer is
created.

1.10.14.2 Notes

Additional information about this initialization parameter:


■ The default is CRBUF=256.
■ At MVSESA or MVS/XA sites, CRBUF acquires space above the 16
megabyte line.

1.10.15 DATEFORM= Parameter


Designates the date format to be used at user terminals and included in the
Advantage CA-Roscoe job log.

1.10.15.1 Syntax

DATEFORM Parameter
┌─A─┐
──DATEFORM=──┼─E─┼──┬───┬─────────────────────────────────────
└─I─┘ └─L─┘

A use the American format (mm/dd/yy).


E use the European format (dd/mm/yy).
I use the International format (yy/mm/dd).

1-60 Programs and Utilities Guide


1.10 Environment-Related Parameters

L cause the year to be shown as four digits. For example, specifying


DATEFORM=A,L causes dates in the American format to be shown
as mm/dd/yyyy. This 'long' date format is applicable only with the
RPF function DATEFUN and the RPF session variable S.DATE.

1.10.15.2 Notes

Additional information about this initialization parameter:


■ The default is DATEFORM=A.
■ The date stays in American format in those places used by CA Technical
Support for debugging purposes (for example, the SYSPRINT module
cross-reference generated at startup)

1.10.16 DISABLE= Parameter

1.10.16.1 Notes

Additional information about this initialization parameter:


■ DISABLE= is not applicable with this release.

1.10.17 END Parameter


Marks the end of the Advantage CA-Roscoe initialization parameters.

1.10.17.1 Syntax

END Parameter
──END──(no operands)──────────────────────────────────────────

1.10.17.2 Notes

Additional information about this initialization parameter:


■ END is optional. The end-of-file condition on a library member serves the
same purpose.

1.10.18 EXTSEC= Parameter


Identifies your site's security package.

Chapter 1. Advantage CA-Roscoe 1-61


1.10 Environment-Related Parameters

1.10.18.1 Syntax

EXTSEC Parameter
──EXTSEC=──name───────────────────────────────────────────────

name is the name of your site's security package. The accepted names are:
ACF2 ALERT RACF SAC SECURE TSS NONE

1.10.18.2 Notes

Additional information about this initialization parameter:


■ If used, Advantage CA-Roscoe invokes package-specific processing and
prevents user passwords from being visible on the UPSMAINT display or
included in the UPSLIST report.
■ If omitted, package-specific processing does not occur and user passwords
are visible. Note that any site-written Advantage CA-Roscoe exit routines
are still in effect.
■ A value of NONE for EXTSEC= is only applicable to user sign-on
processing. It has no effect on external security processing for privileged
commands, data set access, ETSO programs, library maintenance, monitor
routines, RPF commands, or JES spool access. Contrary to its implication,
it does not prevent an external security package from being invoked.
When EXTSEC=NONE, password scrambling is not performed. It is
performed when EXTSEC= a specific external security package.
If you do not want to invoke an external security package during
Advantage CA-Roscoe processing, specify 'NO' for all of the following
initialization (SYSIN) parameters:
ACFEXT=NO
CLLEXT=NO
JOBEXT=NO
LIBEXT=NO
MONEXT=NO
PRVEXT=NO
RPFEXT=NO
UPSEXT=NO
Refer to the descriptions of each parameter for complete information about
their use.

1-62 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.19 JOBEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to control user access to the JES SPOOLs through ATTACH JOB.

1.10.19.1 Syntax

JOBEXT Parameter
┌─NO──┐
──JOBEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.19.2 Notes

Additional information about this initialization parameter:


■ The default is JOBEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

1.10.20 LIBEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to enable user execution of Advantage CA-Roscoe Library Administrator
functions.

1.10.20.1 Syntax

LIBEXT Parameter
┌─NO──┐
──LIBEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.20.2 Notes

Additional information about this initialization parameter:


■ The default is LIBEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

Chapter 1. Advantage CA-Roscoe 1-63


1.10 Environment-Related Parameters

1.10.21 MONEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to control user access to Monitor routines.

1.10.21.1 Syntax

MONEXT Parameter
┌─NO──┐
──MONEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.21.2 Notes

Additional information about this initialization parameter:


■ The default is MONEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

1.10.22 MPL= Parameter


Defines the number of 10K user execution areas (that is, Multi-Programming
Levels) that are to be available for this execution of Advantage CA-Roscoe.

1.10.22.1 Syntax

MPL Parameter
┌─1──┐
──MPL=──┴─num─┴───────────────────────────────────────────────

num is a numeric value representing the number of user execution areas


that are to be available. The value can range from 1 to 256.

1.10.22.2 Notes

Additional information about this initialization parameter:


■ The default is MPL=10.
■ The user execution areas represent the number of users who are expected
to be simultaneously active.
■ The formula to determine the number of execution areas is:
3 + (TERMSO / 5 truncated)

1-64 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.23 MSGCLASS= Parameter


Defines the internal reader message class. (For use by JES2 and JES3 sites.)

1.10.23.1 Syntax

MSGCLASS Parameter
┌─A─────┐
──MSGCLASS=──┴─class─┴────────────────────────────────────────

class is the internal reader message class.

1.10.23.2 Notes

Additional information about this initialization parameter:


■ The default is MSGCLASS=A.
■ For a description of the internal reader, see the IBM manual System
Programming Library: Job Management.

1.10.24 NOLRM Parameter


Disables the interface that allows sites with Unicenter CA-Look to issue the
Unicenter CA-Look command D ROSCOE during this execution of Advantage
CA-Roscoe.

1.10.24.1 Syntax

NOLRM Parameter
──NOLRM──(no operands)────────────────────────────────────────

1.10.24.2 Notes

Additional information about this initialization parameter:


■ If NOLRM is not specified, the LOOK interface is enabled.
■ For an overview of the information provided by the Unicenter CA-Look D
ROSCOE command, see the Advantage CA-Roscoe Interactive Environment
Command Reference Guide.

Chapter 1. Advantage CA-Roscoe 1-65


1.10 Environment-Related Parameters

1.10.25 NONSWAP Parameter


Causes the main task components of Advantage CA-Roscoe to be designated
as non-swappable.

1.10.25.1 Syntax

NONSWAP Parameter
──NONSWAP──(no operands)──────────────────────────────────────

1.10.25.2 Notes

Additional information about this initialization parameter:


■ If NONSWAP is not specified, Advantage CA-Roscoe is swappable.
■ Advantage CA-Roscoe should be non-swappable. This can be done by
always including this parameter or by defining Advantage CA-Roscoe as
non-swappable in the MVS Program Property Table (PPT). See the
appropriate IBM Job Management manual for information about the PPT.

1.10.26 NOSDUMP Parameter


Prevents Advantage CA-Roscoe from attempting to direct a dump to a
SYS1.DUMPnn data set if Advantage CA-Roscoe should abend. (All other
termination processing does occur.)

1.10.26.1 Syntax

NOSDUMP Parameter
──NOSDUMP──(no operands)──────────────────────────────────────

1.10.26.2 Notes

Additional information about this initialization parameter:


■ If omitted, Advantage CA-Roscoe attempts to direct the dump to a
SYS1.DUMPnn data set.
■ Dumps for user-called programs through ETSO are controlled by the
DUMP flag in the ETSO EPL member.

1-66 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.27 NOSPIE Parameter


Deactivates Advantage CA-Roscoe's SPIE exit.

1.10.27.1 Syntax

NOSPIE Parameter
──NOSPIE──(no operands)───────────────────────────────────────

1.10.27.2 Notes

Additional information about this initialization parameter:


■ If an abend occurs when NOSPIE is in effect, U998 abend processing is
bypassed - a system/user abend occurs.

1.10.28 NSNAATTN= Parameter


Defines the PA key that is to be the site attention key.

1.10.28.1 Syntax

NSNAATTN Parameter
──NSNAATTN=──┬─PA1─┬──────────────────────────────────────────
├─PA2─┤
└─PA3─┘

1.10.28.2 Notes

Additional information about this initialization parameter:


■ If omitted, no attention support is provided for non-SNA VTAM or BTAM
terminals.
■ Advantage CA-Roscoe always supports the VTAM SNA ATTN key. See
the Advantage CA-Roscoe Interactive Environment System Reference Guide for
additional information.

1.10.29 PASSWORD= Parameter


Defines the universal Advantage CA-Roscoe password.

Chapter 1. Advantage CA-Roscoe 1-67


1.10 Environment-Related Parameters

1.10.29.1 Syntax

PASSWORD Parameter
┌─OPENSESAME─┐
──PASSWORD=──┴─pswd───────┴───────────────────────────────────

pswd is a one- to ten-character string that is to be used as the universal


Advantage CA-Roscoe password.

1.10.29.2 Notes

Additional information about this initialization parameter:


■ If PASSWORD is never specified, the default is
PASSWORD=OPENSESAME.
■ For security purposes, the password is saved in the first block of
ROSLIB00. Thus, you should remove PASSWORD= once you have
established a password.
■ The password is masked in the SYSPRINT listing of the parameters.
■ The universal password is not recognized when a site's security system is
used. If a user forgets his or her password, the appropriate security
recourse must be taken.

1.10.30 PRVEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to control user execution of restricted (Privileged) commands.

1.10.30.1 Syntax

PRVEXT Parameter
┌─NO──┐
──PRVEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.30.2 Notes

Additional information about this initialization parameter:


■ The default is PRVEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

1-68 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.31 PSCBUNIT= Parameter


Defines a unit name that is used by dynamic allocation when an allocation
request is received that requires a unit name and none is specified.

1.10.31.1 Syntax

PSCBUNIT Parameter
┌─SYSALLDA─┐
──PSCBUNIT=──┴─unit─────┴─────────────────────────────────────

unit is a one- to eight-character generic or esoteric unit name.

1.10.31.2 Notes

Additional information about this initialization parameter:


■ The default is PSCBUNIT=SYSALLDA.
■ The site-assigned name is placed in the PSCB control block created by
ETSO when a user executes a TSO command processor.

1.10.32 PUSHDEF= Parameter


Establishes the default setting for the PUSH command when executed from
within an RPF.

1.10.32.1 Syntax

PUSHDEF Parameter
┌─OVERLAY─┐
──PUSHDEF=──┴─CREATE──┴───────────────────────────────────────

OVERLAY saves the session attributes currently in effect. Previously


specified attributes are overlaid by the comparable 'saved'
attributes.
CREATE saves the session attributes currently in effect, but previously
specified options are not overlaid.

1.10.32.2 Notes

Additional information about this initialization parameter:


■ The default is PUSHDEF=OVERLAY.

Chapter 1. Advantage CA-Roscoe 1-69


1.10 Environment-Related Parameters

1.10.33 RESHLQ= Parameter


Designates whether the security resource high level qualifier, ROSID, should
precede Advantage CA-Roscoe resource names.

1.10.33.1 Syntax

RESHLQ Parameter
┌─NONE──┐
──RESHLQ=──┴─ROSID─┴──────────────────────────────────────────

NONE does not add a high level qualifier to the beginning of Advantage
CA-Roscoe resource names.
ROSID causes the high level qualifier 'ROSID' to be added to the beginning
of all Advantage CA-Roscoe resource names.

1.10.33.2 Notes

Additional information about this initialization parameter:


■ The default is RESHLQ=NONE.

|1.10.34 ROSGNAME= Parameter


| Designates whether Advantage CA-Roscoe is to setup a VTAM GENERIC
| RESOURCE.

|1.10.34.1 Syntax
|
| ROSGNAME Parameter
| ──ROSGNAME=──xxxxxxxx─────────────────────────────────────────

| xxxxxxxx is a one to eight character VTAM Generic Resource Name. The


| default is none.

|1.10.34.2 Notes

| Additional information about this initialization parameter:


| ■ This parameter may be used to even out the workload between multiple
| Advantage CA-Roscoe systems. See the section "Balancing the Workload"
| in Chapter 9 of the Advantage CA-Roscoe Systems Reference Guide.

1-70 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.35 ROSID= Parameter


Assigns an identification code to Advantage CA-Roscoe.

1.10.35.1 Syntax

ROSID Parameter
──ROSID=──code────────────────────────────────────────────────

code is a unique four-character Advantage CA-Roscoe identification code.


The character must be alphabetic or a currency symbol. The
remaining characters may be alphabetic.

1.10.35.2 Notes

Additional information about this initialization parameter:


■ ROSID= is REQUIRED.
■ The Advantage CA-Roscoe ID code is used to:
– identify messages from Advantage CA-Roscoe to the operator's
console, and
– direct operator commands to the appropriate Advantage CA-Roscoe.
■ If your site is running multiple Advantage CA-Roscoes, each Advantage
CA-Roscoe must have a unique ID assigned.

1.10.36 RPFEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to control user access to RPFs.

1.10.36.1 Syntax

RPFEXT Parameter
┌─NO──┐
──RPFEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

Chapter 1. Advantage CA-Roscoe 1-71


1.10 Environment-Related Parameters

1.10.36.2 Notes

Additional information about this initialization parameter:

■ The default is RPFEXT=NO.


■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

1.10.37 SRTDDPFX= Parameter


Establishes the four-character prefix used by the site sort utility to construct
the sort work DD name.

1.10.37.1 Syntax

SRTDDFPX Parameter
┌─SORT─┐
──SRTDDFPX=──┴─pfx──┴─────────────────────────────────────────

pfx is the prefix to be used to construct the sort work DD name. It must
be 4 characters in length.

1.10.37.2 Notes

Additional information about this initialization parameter:


■ The default is SRTDDPFX=SORT.

1.10.38 SRTREGN= Parameter


Defines the maximum amount of storage that a site sort utility is permitted to
use.

1.10.38.1 Syntax

SRTREGN Parameter
┌─264K─┐
──SRTREGN=──┴─num──┴──────────────────────────────────────────

num is a numeric value between 4K and 16M that represents the amount
of storage to be used by the site's sort utility.

1-72 Programs and Utilities Guide


1.10 Environment-Related Parameters

1.10.38.2 Notes

Additional information about this initialization parameter:


■ The default is SRTREGN=264K.

1.10.39 SRTSTORG= Parameter


Defines the maximum amount of storage that Advantage CA-Roscoe's sort
utility is permitted to use.

1.10.39.1 Syntax

SRTSTORG Parameter
──SRTSTORG=──num──────────────────────────────────────────────

num is a numeric value representing the amount of storage given to the


Advantage CA-Roscoe internal sort routine. This value should be:

Operating System Default Maximum Minimum


MVSSP 20K 16M 1K
MVSXA or MVSESA 100K 16M 1K

1.10.39.2 Notes

Additional information about this initialization parameter:


■ If storage requirements needed to call the Advantage CA-Roscoe internal
sort routine exceed the SRTSTORG= amount, Advantage CA-Roscoe
engages the site sort utility.
■ For MVSXA and MVSESA sites, storage needed is GETMAINed above the
line.
■ Advantage CA-Roscoe's internal sort routine allows concurrent SORTing
and ORDERing to occur (it is not single threaded.)

1.10.40 TEST Parameter


Initializes a Advantage CA-Roscoe system as a test system.

Caution
This parameter is to be used ONLY in a TEST environment. It is not for
normal production use. Unpredictable results may occur if not used
properly.

Chapter 1. Advantage CA-Roscoe 1-73


1.10 Environment-Related Parameters

1.10.40.1 Syntax

TEST Parameter
──TEST──(no operands)─────────────────────────────────────────

1.10.40.2 Notes

Additional information about this initialization parameter:


■ This parameter establishes Advantage CA-Roscoe as a test environment
from which the DEBUG NEW exitname command can be used to reload
an exit. Again, caution should be used with this command.

1.10.41 UPSEXT= Parameter


Signifies whether Advantage CA-Roscoe is to use external or internal security
calls to control user access to UPS functions.

1.10.41.1 Syntax

UPSEXT Parameter
┌─NO──┐
──UPSEXT=──┴─YES─┴────────────────────────────────────────────

NO results in internal security calls.


YES results in external security calls.

1.10.41.2 Notes

Additional information about this initialization parameter:


■ The default is UPSEXT=NO.
■ See the Advantage CA-Roscoe Interactive Environment Security Administration
Guide for a description of internal and external security.

1-74 Programs and Utilities Guide


1.11 ETSO-Related Parameters

1.11 ETSO-Related Parameters


The following parameters are provided to facilitate the use of ETSO.

1.11.1 ESCAPE= Parameter


Defines the character string that is to be used as the default setting for the SET
ESCAPE command.

1.11.1.1 Syntax

ESCAPE Parameter
┌─..──┐
──ESCAPE=──┴─str─┴────────────────────────────────────────────

str is a one- to three-character string.

1.11.1.2 Notes

Additional information about this initialization parameter:


■ The default is ESCAPE=..
■ The string is used as an escape sequence from an application executing
under ETSO.

1.11.2 ETSALLOC= Parameter


Defines the maximum number of files that a user may allocate per session.

1.11.2.1 Syntax

ETSALLOC Parameter
┌─19──┐
──ETSALLOC=──┴─num─┴──────────────────────────────────────────

num is numeric value between 1 and 32760.

1.11.2.2 Notes

Additional information about this initialization parameter:


■ The default is ETSALLOC=19.
■ If the user splits the screen into two logical presentation areas, the user
may allocate the maximum number of files in each area.

Chapter 1. Advantage CA-Roscoe 1-75


1.11 ETSO-Related Parameters

1.11.3 ETSOEPL= Parameter


Signifies whether the Advantage CA-Roscoe Eligible Program List (EPL) must
contain an entry for any TSO command executed from the Advantage
CA-Roscoe command line or from an RPF. At least one EPL entry is required,
for the Advantage CA-Roscoe command processor, ROSTMP.

1.11.3.1 Syntax

ETSOEPL Parameter
┌─NO──┐
──ETSOEPL=──┴─YES─┴───────────────────────────────────────────

NO no entry needed in the EPL for TSO commands executed from the
Advantage CA-Roscoe command line or an RPF.
YES EPL entries are required for TSO commands.

1.11.3.2 Notes

Additional information about this initialization parameter:

■ The default is ETSOEPL=NO.


■ See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of the EPL.

1.11.4 ETSOEXEC= Parameter


Signifies whether TSO exec processing will be enabled.

1.11.4.1 Syntax

ETSOEXEC Parameter
┌─NO──┐
──ETSOEXEC──┴─YES─┴───────────────────────────────────────────

NO TSO exec processing is disabled. Any attempt to use a TSO exec


will result in an error during EXEC SVC 109 processing.
YES TSO exec processing is enabled.

1-76 Programs and Utilities Guide


1.11 ETSO-Related Parameters

1.11.4.2 Notes

Additional information about this initialization parameter:


■ The default is ETSOEXEC=NO.
■ If ETSOEXEC=YES is specified, you must also apply Advantage
CA-Roscoe USERMOD MRO6026, which is found in the installation sample
JCL library. MRO6026 will install a modified ISPF default parameter
module IRXISPRM, which is necessary to execute CLISTs and REXX
procedures under Advantage CA-Roscoe.
■ See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of TSO exec processing.

1.11.5 ETSOLIB= Parameter


Signifies whether the ETSOLIB concatenation will be searched to resolve
commands executed with the TSO command.

1.11.5.1 Syntax

ETSOLIB Parameter
┌─NO──┐
──ETSOLIB=──┴─YES─┴───────────────────────────────────────────

NO the ETSOLIB will not be searched for TSO command processing.


YES causes the ETSOLIB to be searched.

1.11.5.2 Notes

Additional information about this initialization parameter:

■ The default is ETSOLIB=NO.


■ See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of TSO exec processing.

1.11.6 ETSOPGMS= Parameter


Identifies the library member that contains the Eligible Program List (EPL) that
is to be used for this execution of Advantage CA-Roscoe.

1.11.6.1 Syntax

ETSOPGMS Parameter
┌─RO.ETSOPGMS─┐
──ETSOPGMS=──┴─mem─────────┴──────────────────────────────────

Chapter 1. Advantage CA-Roscoe 1-77


1.11 ETSO-Related Parameters

mem is the name of a library member. If no prefix is specified, RO is


assumed.

1.11.6.2 Notes

Additional information about this initialization parameter:

■ The default is ETSOPGMS=RO.ETSOPGMS.


■ See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of the EPL.

1.11.7 ETSOSRCH= Parameter


Signifies whether the Eligible Program List (EPL) will be searched for
commands invoked through the TSO command.

1.11.7.1 Syntax

ETSOSRCH Parameter
┌─YES─┐
──ETSOSRCH=──┴─NO──┴──────────────────────────────────────────

YES causes Advantage CA-Roscoe to search the EPL for TSO commands.
NO the EPL is not searched when TSO commands are invoked.

1.11.7.2 Notes

Additional information about this initialization parameter:


■ The default is ETSOSRCH=YES.
■ TSO commands not found in the EPL will cause Advantage CA-Roscoe to
set defaults for EPL control variables, such as max storage and max
numbers of users. These defaults will be defined by the user in the EPL
entry for the Advantage CA-Roscoe command processor, ROSTMP.
■ See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of TSO exec processing.

1.11.8 ETSOXIT= Parameter


Signifies whether the CLLEXIT routine will be called for commands invoked
through the TSO command.

1-78 Programs and Utilities Guide


1.11 ETSO-Related Parameters

1.11.8.1 Syntax

ETSOXIT Parameter
┌─NO──┐
──ETSOXIT=──┴─YES─┴───────────────────────────────────────────

NO the CLLEXIT will not be invoked for TSO command processing.


YES causes the CLLEXIT to be invoked for TSO command processing.

1.11.8.2 Notes

Additional information about this initialization parameter:

■ The default is ETSOXIT=NO.


■ See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for a description of TSO exec processing.

1.11.9 ETSRPS= Parameter


Designates whether SYSOUT data sets (allocated under ETSO) may be directed
to 328x-type printers defined to RPS.

1.11.9.1 Syntax

ETSRPS Parameter
──ETSRPS=──sysout,class───────────────────────────────────────

sysout is one alphabetic character, in the range A through Z. The character


should be unique. (If it matches a system printer SYSOUT class, the
RPS class takes precedence.)
class is one numeric character, in the range 0 through 9. If multiple
parameters are specified, each value must be unique.

1.11.9.2 Notes

Additional information about this initialization parameter:


■ If omitted, SYSOUT data sets may not be directed to these RPS printers.
■ If multiple SYSOUT classes are desired, one ETSRPS= parameter must be
specified for each each class.

Chapter 1. Advantage CA-Roscoe 1-79


1.11 ETSO-Related Parameters

1.11.10 ETSSLICE= Parameter


Defines the amount of time that is to be allotted to a time slice.

1.11.10.1 Syntax

ETSSLICE Parameter
┌─5─┐
──ETSSLICE=──┴─num──┴──┬───┬──────────────────────────────────
└─S─┘

num is a numeric value specified in:


■ microseconds (ranging from 100 to 10000000), or
■ seconds (ranging from 1S to 10S), where 'S' designates seconds.

1.11.10.2 Notes

Additional information about this initialization parameter:


■ The default is ETSSLICE=5000.

1.11.11 ETSSRCH= Parameter


Designates the location of programs that may be called by a user.

1.11.11.1 Syntax

ETSSRCH Parameter
┌─DD──┐
──ETSSRCH=──┴─ALL─┴───────────────────────────────────────────

DD indicates that the program is in a data set concatenated to the


ETSOLIB DD statement.
ALL indicates the program can be in:
1. ETSOLIB (or a data set concatenated to it),
2. JOBLIB/STEPLIB (or a data set concatenated to it),
3. the Link Pack Area, or
4. a data set defined in a linklist concatenation.

1-80 Programs and Utilities Guide


1.11 ETSO-Related Parameters

1.11.11.2 Notes

Additional information about this initialization parameter:


■ The default is ETSSRCH=DD.
■ If ETSSRCH=ALL is specified, the linklist must be authorized.
■ If ETSSRCH=ALL and the linklist is authorized, allocating ISPLLIB or
STEPLIB to a load library contained in the linklist will cause the load
library to be treated as non-APF authorized and a S306-C abend may result
in ISPMAIN calling ISPF. No pre-allocation is necessary in this case.

1.11.12 PRELOAD= Parameter


Identifies a program that is to be preloaded at Advantage CA-Roscoe startup.

1.11.12.1 Syntax

PRELOAD Parameter
──PRELOAD=──pgm──┬──────────┬─────────────────────────────────
└─,ETSOLIB─┘

pgm is the name of the program to be preloaded. The name may be


qualified with:
ETSOLIB causes only the ETSO load library concatenation to be
searched for the program. This operand can be specified
as E or ETSOLIB.
If ETSOLIB is omitted, the program must exist in one of
the libraries available to Advantage CA-Roscoe through
the STEPLIB, the system link list, or in the Link Pack
Area.

1.11.12.2 Notes

Additional information about this initialization parameter:


■ If omitted, no programs are preloaded.
■ There must be one PRELOAD= for each program to be preloaded.
■ Candidate programs might be those that are called many times under
ETSO, the Advantage CA-Roscoe/DB2 prtopams ROSRUSTI and
ROSUCNTL, and the Advantage CA-Roscoe/AllFusion CA-Librarian
program CCFIREAD.
■ Any program that is to be preloaded must be link-edited as reentrant.
■ If the program is to be executed as part of Advantage CA-Roscoe
initialization, see the description of ROSXINIT in Advantage CA-Roscoe
Extended Facilities for System Programmers.

Chapter 1. Advantage CA-Roscoe 1-81


1.11 ETSO-Related Parameters

1.11.13 PSCBUID= Parameter


Designates how Advantage CA-Roscoe is to build the PSCBUSER field in the
PSCB.

1.11.13.1 Syntax

PSCBUID Parameter
┌─PFX───┐
──PSCBUID=──┼─KEY───┼─────────────────────────────────────────
└─SECID─┘

PFX causes the PSCBUSER field to be built by combining the Advantage


CA-Roscoe prefix and attaching 'ETSO' to the end (for example, for
a prefix of "USR", the PSCBUSER field will contain "USRETSO".)
KEY causes Advantage CA-Roscoe to build the PSCBUSER field from the
first seven characters of the Advantage CA-Roscoe key. If the key is
less than seven characters, PSCBUSER will be the key. If the
Advantage CA-Roscoe key contains a period ('.'), PSCBUSER will be
the characters preceding the period.
SECID causes the external security ID to be used to build the PSCBUSER
field. If security is inactive, the default (PFX) will be used.

1.11.13.2 Notes

Additional information about this initialization parameter:


■ The default is PSCBUID=PFX.

1.11.14 PSCBUSER= Parameter


Designates the contents of the PSCBUSER field in Advantage CA-Roscoe's
pseudo-PSCB.

1.11.14.1 Syntax

PSCBUSER Parameter
┌─JOBNAME───┐
──PSCBUSER=──┴─'literal'─┴────────────────────────────────────

JOBNAME causes the first seven characters of the Advantage CA-Roscoe job
name to be placed in the PSCBUSER field.
'literal' is a one- to seven-character string that can contain alphabetic
and/or numeric characters plus the $, # or @.

1-82 Programs and Utilities Guide


1.11 ETSO-Related Parameters

1.11.14.2 Notes

Additional information about this initialization parameter:


■ The default is PSCBUSER=JOBNAME.
■ See the section describing installing ETSO in the Advantage CA-Roscoe
Interactive Environment System Reference Guide for additional information.

Chapter 1. Advantage CA-Roscoe 1-83


1.12 Library-Related Parameters

1.12 Library-Related Parameters


The following initialization parameters are used to define the site's use of the
Library Facility.

1.12.1 DELETE= Parameter


Controls the display of the DELETE confirmation request.

1.12.1.1 Syntax

DELETE Parameter
┌─LET─────┐
──DELETE=──┴─CONFIRM─┴────────────────────────────────────────

LET prevents the confirmation request from being issued.


CONFIRM issues a confirmation request before a member is deleted from the
library through the DELETE command.

1.12.1.2 Notes

Additional information about this initialization parameter:


■ The default is DELETE=LET.
■ If DELETE=CONFIRM is in effect and a DELETE command is issued from
an RPF program, no confirmation request is issued.

1.12.2 HELPPFX= Parameter


Defines the prefix of the profile containing the HELP facility members.

1.12.2.1 Syntax

HELPPFX Parameter
┌─RHE─┐
──HELPPFX=──┴─pfx─┴───────────────────────────────────────────

pfx is a two- to three-character prefix.

1-84 Programs and Utilities Guide


1.12 Library-Related Parameters

1.12.2.2 Notes

Additional information about this initialization parameter:


■ The default is HELPPFX=RHE.

1.12.3 HELPPFX1= Parameter


Defines the prefix of the profile containing the user specified HELP facility
members.

1.12.3.1 Syntax

HELPPFX1 Parameter
──HELPPFX1=──pfx──────────────────────────────────────────────

pfx is a two- to three-character prefix. This prefix must be different than


the one set with HELPPFX=. There is no default.

For additional information, see the SET HELPPFX command in the Advantage
CA-Roscoe Interactive Environment Command Reference Guide.

1.12.4 LIBACCES= Parameter


Establishes the display for Library Facility member lists.

1.12.4.1 Syntax

LIBACCES Parameter
┌─ALL───┐
──LIBACCES=──┼─OWN───┼────────────────────────────────────────
└─GROUP─┘

ALL allows users to display library member lists containing members


with all access attributes.
OWN allows users to display member lists containing only their own
members.
GROUP allows users to to display member lists containing only those
members he/she is permitted to attach.
A call is made to the UPS interface with the function of ATTACH.
If the interface indicates that the user is not permitted to attach the
member, the member is excluded from the member list.

Chapter 1. Advantage CA-Roscoe 1-85


1.12 Library-Related Parameters

1.12.4.2 Notes

Additional information about this initialization parameter:


■ The default is LIBACCES=ALL.
■ The LIBACCES=GROUP is designed to have Advantage CA-Roscoe
perform access checking (through UPS). Sites will no longer need to code a
LIBEXIT for most common security-type issues.
The LIBEXIT will continue to be called (exclusion call) for any member not
excluded in the UPS interface.

1.12.5 LIBALTER= Parameter


Establishes the default Library Facility Selection List field modification setting.

1.12.5.1 Syntax

LIBALTER Parameter
┌─Explicit─┐
──LIBALTER=──┴─Implicit─┴─────────────────────────────────────

Explicit sets the LIB ALTER field of the Library Facility Menu to EXPLICIT
for all users who do not have a library profile record in the UPS
account. The AT line command will be required in order to modify
the Selection List fields.
Specify as EXPLICIT or E.
Implicit sets the LIB ALTER field of the Library Facility Menu to IMPLICIT
for all users who do not have a library profile record in the UPS
account. Selection List fields can be modified directly by overtyping
data.
Specify as IMPLICIT or I.

1.12.5.2 Notes

Additional information about this initialization parameter:


■ The default is LIBALTER=EXPLICIT.
■ Users who do not have a library profile record in the UPS account (as
stated above) include new users and those users who have never had a
library session.
■ The fields of the Library Selection List that are modifiable are:
– description
– access attribute
– sequence number

1-86 Programs and Utilities Guide


1.12 Library-Related Parameters

1.12.6 LIBCACHE= Parameter


Defines the maximum amount of storage to be acquired by the Library Cache
Facility.

1.12.6.1 Syntax

LIBCACHE Parameter
──LIBCACHE=──num──┬───┬───────────────────────────────────────
├─K─┤
└─M─┘

num is the amount of storage to be acquired. This value must


1. indicate the number of bytes of storage required,
2. be a multiple of the library buffer size, and
3. at minimum, be large enough to accommodate the master index
blocks.
The value may be suffixed with a K (for kilobytes) or M (for
megabytes). If neither K nor M is specified, bytes is assumed.

1.12.6.2 Notes

Additional information about this initialization parameter:


■ If omitted (or specified with an inadequate value), the Library Cache
Facility is not available.
■ Because each site's Advantage CA-Roscoe configuration and usage varies,
it is impossible to provide a specific value for LIBCACHE=. A suggestion
is to start with:
LIBCACHE=124K
and then use the LIBCACHE command to monitor storage usage. (See the
Advantage CA-Roscoe Interactive Environment System Reference Guide for
additional information.)

1.12.7 LIBCFRMM= Parameter


Establishes the default setting for Library Facility member delete confirmation.

1.12.7.1 Syntax

LIBCFRMM Parameter
┌─YES─┐
──LIBCFRMM=──┴─NO──┴──────────────────────────────────────────

Chapter 1. Advantage CA-Roscoe 1-87


1.12 Library-Related Parameters

YES sets the CONFIRM DELETE field of the Library Facility main menu
to YES for all users who do not have a library profile record in the
UPS. Users will be required to confirm deletion of library members.
NO sets the CONFIRM DELETE field of the Library Facility main menu
to NO for all users who do not have a library profile record in the
UPS. Members will be deleted without user confirmation.

1.12.7.2 Notes

Additional information about this initialization parameter:


■ The default is LIBCFRMM=YES.
■ Users who do not have a library profile record in the UPS account (as
stated above) include new users and those users who have never had a
library session.

1.12.8 LIBXLIB= Parameter


Defines the number of: 1) library buffers to be available, and 2) printers that
are expected to be simultaneously active.

1.12.8.1 Syntax

LIBXLIB Parameter
┌─2──┐
──LIBXLIB=──┴─num─┴───────────────────────────────────────────

num is a numeric value ranging from 2 to 254.

1.12.8.2 Notes

Additional information about this initialization parameter:


■ The default is LIBXLIB=20.
■ Use the following formula to determine the initial value:
(2  mpl) + (2  rps)
where:
mpl is a numeric value that is two times the value of the MPL=
parameter. This value represents the number of extra library
buffers to be available during the Advantage CA-Roscoe
execution for use by: a) Monitor commands using the LIBI
Interface, b) multi-level RPF programs, and c) Advantage
CA-Roscoe commands.
rps is a numeric value that is two times the number of printers
defined to RPS that are expected to simultaneously active
during the execution.

1-88 Programs and Utilities Guide


1.13 Monitor-Related Parameters

1.13 Monitor-Related Parameters


The following parameters are used to establish and control the Monitor
commands that are to be available to users.

1.13.1 PAUSE= Parameter


Sets the Monitor command pause count.

1.13.1.1 Syntax

PAUSE Parameter
┌─12─┐
──PAUSE=──┴─num─┴─────────────────────────────────────────────

num is a numeric value between 1 and 257, inclusive.

1.13.1.2 Notes

Additional information about this initialization parameter:


■ The default is PAUSE=120.
■ A value of 257 disables the pause counter. See the Advantage CA-Roscoe
Interactive Environment Extended Facilities for System Programmers Guide for
further details.

1.13.2 RUN= Parameter


Identifies the Monitor commands that are to be available for this execution of
Advantage CA-Roscoe.

1.13.2.1 Syntax

RUN Parameter
──RUN=──cmd──┬────────┬───────────────────────────────────────
└─(code)─┘

cmd are the first three letters of the Monitor command name.
code is one or more of the following codes, specified without any
intervening spaces or commas:
S monitor has pseudo-SPIE exit.
V monitor uses VPE.
X user input to the Monitor is accepted as entered. If
omitted, the input is translated to uppercase characters.

Chapter 1. Advantage CA-Roscoe 1-89


1.13 Monitor-Related Parameters

1.13.2.2 Notes

Additional information about this initialization parameter:


■ If omitted, no Monitor commands are available for this execution of
Advantage CA-Roscoe.
■ There must be one RUN= parameter for each Monitor command that is to
be available. A maximum of 255 Monitor commands can be specified.

EXAMPLES:
RUN=AMS
RUN=COB(S)
RUN=JCL(SX)

1-90 Programs and Utilities Guide


1.14 Operator-Related Parameters

1.14 Operator-Related Parameters


The following parameters are used to control console communications.

1.14.1 CONSOLE Parameter


Causes an operator prompting session to begin after the initialization
parameters have been processed.

1.14.1.1 Syntax

CONSOLE Parameter
──CONSOLE──(no operands)──────────────────────────────────────

1.14.1.2 Notes

Additional information about this initialization parameter:


■ If omitted, this facility is not enabled.
■ CONSOLE is ignored if NOPROMPT is also specified.
■ The facility provided by CONSOLE allows the operator to add additional
initialization parameters.

1.14.2 NOPROMPT Parameter


Prevents prompts from being directed to the operator console during
Advantage CA-Roscoe initialization.

1.14.2.1 Syntax

NOPROMPT Parameter
──NOPROMPT──(no operands)─────────────────────────────────────

1.14.2.2 Notes

Additional information about this initialization parameter:

■ If omitted, operator prompting is enabled.


■ When NOPROMPT is in effect, the operator is not able to:
– respond to prompts in the event an initialization processing error
occurs
– enter initialization parameters if the CONSOLE parameter is specified

Chapter 1. Advantage CA-Roscoe 1-91


1.14 Operator-Related Parameters

1.14.3 ROSLOG= Parameter


Designates whether messages are to be directed to the operator console.

1.14.3.1 Syntax

ROSLOG Parameter
┌─ON──┐
──ROSLOG=──┴─OFF─┴────────────────────────────────────────────

ON writes messages to the console. (YES is a synonym for ON.)


OFF prevents messages from being written to the console. (NO is a
synonym for OFF.)

1.14.3.2 Notes

Additional information about this initialization parameter:


■ The default is ROSLOG=ON.
■ ROSLOG= affects only messages written to the operator console; it does
not affect messages written to SYSLOG or JOBLOG. The messages affected
are signon, signoff, connect, disconnect and submit.

1.14.4 ROSMSG= Parameter


Controls the use of the Advantage CA-Roscoe command MESSAGE.

1.14.4.1 Syntax

ROSMSG Parameter
┌─ON──┐
──ROSMSG=──┴─OFF─┴────────────────────────────────────────────

ON allows users to use the command to messages to the console


operator. (YES is a synonym for ON.)
OFF prevents users from using this command. (NO is a synonym for
OFF.)

1.14.4.2 Notes

Additional information about this initialization parameter:


■ The default is ROSMSG=ON.
■ ROSMSG= affects only messages written to the operator console; it does
not affect messages written to SYSLOG or JOBLOG. The messages affected
are signon, signoff, connect, disconnect and submit.

1-92 Programs and Utilities Guide


1.15 RCS-Related Parameters.

1.15 RCS-Related Parameters.


The following initialization parameters are used to define the Advantage
CA-Roscoe Communications Services (RCS) network for this execution of
Advantage CA-Roscoe.

1.15.1 NTOATTN= Parameter


Detects an 'attention with data' condition.

1.15.1.1 Syntax

NTOATTN Parameter
┌─IBM default─┐
──NTOATTN=──┴─num─────────┴───────────────────────────────────

num is a two-digit hexadecimal value that corresponds to the value


specified on the VTAM NTOLINE EDIT= operand.

1.15.1.2 Notes

Additional information about this initialization parameter:


■ If omitted, the IBM default is used.
■ NTOATTN= is needed for NTO devices. The specified value is used to
detect an 'attention with data' condition.

1.15.2 RCSGEN= Parameter


Identifies the member on CAI.RO60LIB containing the Communication
Network definition that is to be used for this execution of Advantage
CA-Roscoe.

1.15.2.1 Syntax

RCSGEN Parameter
┌─RCSDEF─┐
──RCSGEN=──┴─dsnmem─┴─────────────────────────────────────────

dsnmem is the name of a member on CAI.RO60LIB.

Chapter 1. Advantage CA-Roscoe 1-93


1.15 RCS-Related Parameters.

1.15.2.2 Notes

Additional information about this initialization parameter:


■ If RCSGEN= is omitted or specified with no member name, the default
member name RCSDEF is used.

1.15.3 RCSTRACE= Parameter


Designates whether RCS tracing is to be active during Advantage CA-Roscoe
initialization.

1.15.3.1 Syntax

RCSTRACE Parameter
┌─OFF─┐
──RCSTRACE=──┴─ON──┴──────────────────────────────────────────

OFF deactivates tracing during Advantage CA-Roscoe initialization. (NO


is a synonym for OFF.)
ON activates tracing during Advantage CA-Roscoe initialization. (YES is
a synonym for ON.)

1.15.3.2 Notes

Additional information about this initialization parameter:


■ The default is RCSTRACE=OFF.
■ For additional information, see the description the RCSTRACE command
in the Advantage CA-Roscoe Interactive Environment Command Reference
Guide.

1.15.4 ROSAPPL= Parameter


Identifies the Advantage CA-Roscoe VTAM application name. APPL macro
for Advantage CA-Roscoe.

1.15.4.1 Syntax

ROSAPPL Parameter
┌─ROSCOE─┐
──ROSAPPL=──┴─name───┴────────────────────────────────────────

name is the Advantage CA-Roscoe VTAM application name.


If ROSAPPL= is specified with no operand, the stepname on the
EXEC statement is used.

1-94 Programs and Utilities Guide


1.15 RCS-Related Parameters.

1.15.4.2 Notes

Additional information about this initialization parameter:


■ The default is ROSAPPL=ROSCOE.
■ The specified name is presented as the application name when Advantage
CA-Roscoe opens its ACB. It must correspond to the APPLID specified on
the VTAM APPL macro.

1.15.5 ROSPRTCT= Parameter


Identifies the password coded on the VTAM APPL macro for Advantage
CA-Roscoe.

1.15.5.1 Syntax

ROSPRTCT Parameter
┌─ROSCOE─┐
──ROSPRTCT=──┴─pswd───┴───────────────────────────────────────

pswd is the password coded on the VTAM APPL macro for Advantage
CA-Roscoe.

1.15.5.2 Notes

Additional information about this initialization parameter:


■ If ROSPRTCT is omitted or specified with no operand, the default is
ROSPRTCT=ROSCOE.

1.15.6 TERMSO= Parameter


Defines the number of concurrent Advantage CA-Roscoe subsessions that can
be active.

1.15.6.1 Syntax

TERMSO Parameter
──TERMSO=──num────────────────────────────────────────────────

num is a numeric value ranging from 0 to 256.

Chapter 1. Advantage CA-Roscoe 1-95


1.15 RCS-Related Parameters.

1.15.6.2 Notes

Additional information about this initialization parameter:


■ If TERMSO= is omitted, the sum of the value(s) specified with the VTAM=
and XTPM= parameters, the TERMnn, TERMnnMx and PRNTnnMx DD
statements and/or the RCSDVICE macros are used as the value.
■ Subsessions consist of the number of users signed on plus the number of
users who have split the screen (for example, if three users sign on and
one is using split-screens, there are four active subsessions).
■ At VTAM-only sites, there is no advantage in specifying a TERMSO= value
that is less than the VTAM= value.
■ At sites with BTAM devices, specifying a value that is less than the total
number of terminals limits the number of subsessions that can be
concurrently active. For example, if a site defines 50 terminals to
Advantage CA-Roscoe and specifies TERMSO=15, only 15 unique
subsessions may be active at any one time.

1.15.7 VTAM= Parameter


Defines the number of VTAM terminals that can be concurrently signed on to
Advantage CA-Roscoe.

1.15.7.1 Syntax

VTAM Parameter
──VTAM=──num──────────────────────────────────────────────────

num is a numeric value ranging from 0 to 256.

1.15.7.2 Notes

Additional information about this initialization parameter:


■ If omitted or specified as 0, the VTAM component of RCS is not activated.
■ The number specified with VTAM= is a factor used when defining the
TERMSO= parameter.

1.15.8 XTPM= Parameter


Defines the number of Advantage CA-Roscoe sessions that can be dedicated to
XTPM sessions.

1-96 Programs and Utilities Guide


1.15 RCS-Related Parameters.

1.15.8.1 Syntax

XTPM Parameter
──XTPM=──num──────────────────────────────────────────────────

num is a numeric value ranging from 0 to 254.

1.15.8.2 Notes

Additional information about this initialization parameter:


■ If omitted or specified as 0, the XTPM component of RCS is not activated.
■ The number specified with XTPM= is a factor used when defining the
TERMSO= parameter.
■ This parameter should only be specified by sites that access Advantage
CA-Roscoe through CICS/VS terminals, TSO and/or another Advantage
CA-Roscoe. See the Advantage CA-Roscoe Interactive Environment Installation
Guide for additional information about XTPM.
The following two parameters may be used to customize how a user is to
communicate directly with RCS.

1.15.9 RCSESCCH= Parameter


Identifies the special character that is to be used to prefix the one-character
RCS escape sequence commands.

1.15.9.1 Syntax

RCSESCCH Parameter
┌─:────┐
──RCSESCCH=──┴─char─┴─────────────────────────────────────────

char is any special character.

1.15.9.2 Notes

Additional information about this initialization parameter:


■ The default is RCSESCCH=:.

Chapter 1. Advantage CA-Roscoe 1-97


1.15 RCS-Related Parameters.

1.15.10 RCSESCPF= Parameter


Identifies the PF key that is to be used to indicate direct escape sequence
command input to RCS.

1.15.10.1 Syntax

RCSESCPF Parameter
┌─PF12─┐
──RCSESCPF=──┴─PFn──┴─────────────────────────────────────────

PFn specify n as a numeric value between 1 and 24.

1.15.10.2 Notes

Additional information about this initialization parameter:


■ The default is RCSESCPF=PF12.

This facility allows a user to escape from an application that is currently in


control of the terminal (for example, Advantage CA-Roscoe, an application
executing under ETSO or CA-eMAIL is bypassed.)

For example, assume the parameter defaults are in effect and an RPF panel or
a CA-eMAIL screen is currently displayed. If a user enters:
:L

and presses PF12, the one-character RCS command L is recognized and the
Terminal Lock screen is displayed.

1-98 Programs and Utilities Guide


1.16 RPF-Related Parameters

1.16 RPF-Related Parameters


The following initialization parameters are used to establish site defaults and
maximums.

1.16.1 ARRAYMAX= Parameter


Defines the number of elements that may be assigned to a named DECLARed
variable.

1.16.1.1 Syntax

ARRAYMAX Parameter
┌─1─┐
──ARRAYMAX=──┴─num─┴──────────────────────────────────────────

num is numeric value between 1 and 255.

1.16.1.2 Notes

Additional information about this initialization parameter:


■ The default is ARRAYMAX=100.

1.16.2 BYPSRPF= Parameter


Signifies whether Advantage CA-Roscoe is to bypass execution of the user
sign-on procedure.

1.16.2.1 Syntax

BYPSRPF Parameter
┌─NO──┐
──BYPSRPF=──┴─YES─┴───────────────────────────────────────────

NO execute user sign-on procedure during sign-on and split screen


processing.
YES bypass user sign-on procedure during sign-on and split screen
processing.

Chapter 1. Advantage CA-Roscoe 1-99


1.16 RPF-Related Parameters

1.16.2.2 Notes

Additional information about this initialization parameter:


■ The default is BYPSRPF=NO.
■ The global sign-on procedure is not affected by this parameter.
■ The sign-on procedure will always be executed for a restricted user.

1.16.3 DOTPFX= Parameter


Identifies the prefix associated with the profile that is used by the pseudo
execution library.

1.16.3.1 Syntax

DOTPFX Parameter
┌─RO──┐
──DOTPFX=──┴─pfx─┴────────────────────────────────────────────

pfx is a two- or three-character prefix.

1.16.3.2 Notes

Additional information about this initialization parameter:


■ The default is DOTPFX=RO.
■ This is the prefix used when a user enters the name of an RPF program in
the form:
.prog-name

1.16.4 DMFPFX= Parameter


Identifies the prefix associated with the profile that is used by the Dialog
Management Facility (DMF).

1.16.4.1 Syntax

DMFPFX Parameter
┌─RDF─┐
──DMFPFX=──┴─pfx─┴────────────────────────────────────────────

pfx is a two- or three-character prefix.

1-100 Programs and Utilities Guide


1.16 RPF-Related Parameters

1.16.4.2 Notes

Additional information about this initialization parameter:


■ The default is DMFPFX=RDF.

1.16.5 EXECPFX= Parameter


Identifies the prefix associated with the profile that is used as the RPF
Execution Library.

1.16.5.1 Syntax

EXECPFX Parameter
──EXECPFX=──pfx───────────────────────────────────────────────

pfx is a two- or three-character prefix.

1.16.5.2 Notes

Additional information about this initialization parameter:


■ If omitted, the Execution Library is unavailable.
■ If EXECPFX= is specified and a user enters a program name that is not
preceded by the EXEC command, a library member prefix or a period, the
command hierarchy is altered so that Advantage CA-Roscoe examines the
contents of the Execution Library if the program name does not match a
member in the user's library.

1.16.6 LOOP= Parameter


Defines the maximum number of RPF statements that can be executed without
an intervening read or write operation.

1.16.6.1 Syntax

LOOP Parameter
┌─496─┐
──LOOP=──┴─num──┴─────────────────────────────────────────────

num is a numeric value beween 1 and 32760. This value should be less
than the value of LOOP=.

Chapter 1. Advantage CA-Roscoe 1-101


1.16 RPF-Related Parameters

1.16.6.2 Notes

Additional information about this initialization parameter:


■ The default is LOOP=4096.
■ See page 1-103 for additional information about using LOOP=,
LOOPDFLT= and LOOPRST.

1.16.7 LOOPDFLT= Parameter


Defines the default number of RPF statements that can be executed without an
intervening read or write operation.

1.16.7.1 Syntax

LOOPDFLT Parameter
┌─LOOPRST─┐
──LOOPDFLT=──┴─num─────┴──────────────────────────────────────

num is a numeric value beween 1 and the value specified with LOOP=.
This value should be less than the value of LOOP=.

1.16.7.2 Notes

Additional information about this initialization parameter:


■ If omitted, the value of LOOP= is used.
■ See page 1-103 for additional information about using LOOP=,
LOOPDFLT= and LOOPRST.

1.16.8 LOOPRST= Parameter


Controls the use of the RESET operand with the SET STMTCNT command.

1.16.8.1 Syntax

LOOPRST Parameter
┌─NO──┐
──LOOPRST=──┴─YES─┴───────────────────────────────────────────

NO prohibit RESET from being specified.


YES allow RESET to be specified.

1-102 Programs and Utilities Guide


1.16 RPF-Related Parameters

1.16.8.2 Notes

Additional information about this initialization parameter:


■ The default is LOOPRST=NO.
■ For additional information about using LOOP=, LOOPDFLT=, and
LOOPRST, see the following.

1.16.9 Using LOOP=, LOOPDFLT= and LOOPRST=:


As a program executes, each line is counted. If the default number of
statements are executed without an intervening read or write operation, the
program is paused and the user is given the option of terminating or
continuing the program. The default limit (as set by LOOPDFLT=) should,
therefore, be set to a value that permits the 'average' program to execute
without being paused.

For those programs that manipulate a lot of data (that is, execute many
statements without an intervening read or write), sites can set LOOP= to a
value greater than LOOPDFLT=. The individual writing the RPF program can
then set the statement count higher than the default through the SET
STMTCNT command. (SET STMTCNT resets the limit to a value between 1
and the LOOP= value.)

Finally, if the site specifies LOOPRST=YES their users are allowed to override
the statement count limits entirely. When LOOPRST=YES is in effect, the
RESET operand of the SET STMTCNT command is recognized. RESET causes
Advantage CA-Roscoe's counter to be reset every time the command is
executed (that is, program execution is not paused). If the RESET operand of
SET STMTCNT is not used carefully, however, there is nothing to prevent the
RPF program from going into an endless loop.

1.16.10 OFF= Parameter


Designates whether the OFF or OFFON commands may be issued from within
an RPF program.

1.16.10.1 Syntax

OFF Parameter
┌─NOPROC─┐
──OFF=──┴─INPROC─┴────────────────────────────────────────────

NOPROC OFF may not be issued.


INPROC OFF may be issued.

Chapter 1. Advantage CA-Roscoe 1-103


1.16 RPF-Related Parameters

1.16.10.2 Notes

Additional information about this initialization parameter:


■ The default is OFF=NOPROC.
■ This parameter has no effect on OFF or OFFON when executed from
within the RPF program of a restricted user. See the Advantage CA-Roscoe
Interactive Environment System Reference Guide for additional information
about restricted users.

1.16.11 ONRPF= Parameter


Identifies the library member containing the RPF program that is to be used as
the global sign-on procedure.

1.16.11.1 Syntax

ONRPF Parameter
──ONRPF=──mem─────────────────────────────────────────────────

mem is a library member name. If no prefix is specified, RO is assumed.

1.16.11.2 Notes

Additional information about this initialization parameter:


■ If ONRPF= is omitted, no global sign-on procedure is executed.
■ If a global sign-on procedure is established, it is executed after the
Newsletter is displayed and before the user's own sign-on procedure. See
the Advantage CA-Roscoe Interactive Environment System Reference Guide for
information about creating a Newsletter and a global sign-on procedure.

1.16.12 OFFRPF= Parameter


Identifies the library member containing the RPF program that is to be used as
the global signoff procedure.

1.16.12.1 Syntax

OFFRPF Parameter
──OFFRPF=──member─────────────────────────────────────────────

member is a library member name. If no prefix is specified, RO is assumed.

1-104 Programs and Utilities Guide


1.16 RPF-Related Parameters

1.16.12.2 Notes

Additional information about this initialization parameter:


■ If OFFRPF= is omitted, no global signoff procedure is executed.
■ If a global signoff procedure is established, it is executed when a signoff is
initiated through:
– OFF command
– OFFON command
– OFF option entered on TLOCK screen
– AUTOFF
■ The global signoff procedure must contain an OFF or OFFON command to
complete the signoff process. See the Advantage CA-Roscoe Interactive
Environment System Reference Guide for information about creating a global
signoff procedure.

1.16.13 PERMVARS= Parameter


Defines the maximum number of permanent variables that can be used in an
RPF program.

1.16.13.1 Syntax

PERMVARS Parameter
┌─32──┐
──PERMVARS=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 1 and 128.

1.16.13.2 Notes

Additional information about this initialization parameter:


■ The default is PERMVARS=32.
■ PERMVARS= must be at least 32 (can be up to 128) if your site is using the
online training aids TUTORIAL and TRAINING.

1.16.14 PUSHDEF= Parameter


Establishes the default setting for the PUSH command when executed from
within an RPF.

Chapter 1. Advantage CA-Roscoe 1-105


1.16 RPF-Related Parameters

1.16.14.1 Syntax

PUSHDEF Parameter
┌─OVERLAY─┐
──PUSHDEF=──┴─CREATE──┴───────────────────────────────────────

OVERLAY saves the session attributes currently in effect. Previously


specified attributes are overlaid by the comparable 'saved'
attributes.
CREATE saves the session attributes currently in effect, but previously
specified options are not overlaid.

1.16.14.2 Notes

Additional information about this initialization parameter:


■ The default is PUSHDEF=OVERLAY.

1.16.15 RDMBLOCK= Parameter


Defines the size of an internal work area used by the Advantage CA-Roscoe
Data Manager (RDM) to store local variable information for each user.

1.16.15.1 Syntax

RDMBLOCK Parameter
┌─4───┐
──RDMBLOCK=──┴─num─┴──────────────────────────────────────────

num is the numeric value 2, 4, 6, or 8.

1.16.15.2 Notes

Additional information about this initialization parameter:


■ The default is RDMBLOCK=4.
■ The area is acquired immediately after a user signs on. If this area becomes
insufficient, Advantage CA-Roscoe acquires additional blocks (up to a
maximum of eight), where each block is the size specified by
RDMBLOCK=.
Each user also has available a 2K area for permanent variable information.
If this space becomes insufficient, Advantage CA-Roscoe acquires
additional space that is equal to the size specified with RDMBLOCK=.

1-106 Programs and Utilities Guide


1.16 RPF-Related Parameters

1.16.16 RPFLABEL= Parameter


Designates whether an RPF program must start with a label.

1.16.16.1 Syntax

RPFLABEL Parameter
┌─OPT─┐
──RPFLABEL=──┴─REQ─┴──────────────────────────────────────────

OPT labels are optional.


REQ labels are required.

1.16.16.2 Notes

Additional information about this initialization parameter:


■ The default is RPFLABEL=OPT.

Chapter 1. Advantage CA-Roscoe 1-107


1.17 RPS-Related Parameters

1.17 RPS-Related Parameters


The parameters described in this section must be included when Advantage
CA-Roscoe Printing Services (RPS) are used.

1.17.1 ETSRPS= Parameter


(See page 1-79 for a the description of ETSRPS=.)

1.17.2 LIBXLIB= Parameter


(See page 1-88 for a the description of LIBXLIB=.)

1.17.3 RESTART= Parameter


Establishes how outstanding requests are to be handled when RPS is restarted
after a normal or abnormal termination.

1.17.3.1 Syntax

RESTART Parameter
┌─WARM─┐
──RESTART=──┴─COLD─┴──────────────────────────────────────────

WARM keeps outstanding requests on the RPS queue. The status of the
requests after the restart is determined by the status of the requests
before the termination, as shown in the following figure.
COLD deletes outstanding requests. This includes all previously queued
requests and associated RPS library members.

1.17.3.2 Notes

Additional information about this initialization parameter:


■ The default is RESTART=WARM.

Status Before Termination Status After Request


HELD (ASIS or TOP) HELD (ASIS or TOP)
READY (ASIS or TOP) READY (ASIS or TOP)
ACTIVE READY (ASIS)

Note: ASIS means that printing resumes with the first line of the last partially
printed page or the first page of the next request. TOP means that
printing resumes with the first line of the first page of the request.

1-108 Programs and Utilities Guide


1.17 RPS-Related Parameters

1.17.4 RPSCSECT= Parameter


Identifies the member on CAI.RO60LIB containing the RPS printing network
environment definition that is to be used for this execution of Advantage
CA-Roscoe.

1.17.4.1 Syntax

RPSCSECT Parameter
──RPSCSECT=──dsnmem───────────────────────────────────────────

dsnmem is the name of a member on CAI.RO60LIB.

1.17.4.2 Notes

Additional information about this initialization parameter:


■ If RPSCSECT is omitted or specified with no member name, RPS is
disabled for this execution of Advantage CA-Roscoe. If the member name
is invalid, RPS is unavailable until a privileged PRINT START or RPS
START command is issued.
■ If your site is concurrently executing multiple Advantage CA-Roscoes and
the RPS definition is:
– Shared -- The Advantage CA-Roscoe JCL for each job must include:
— An RPSCSECT= parameter identifying the shared RPS definition.
— Either an RPSKEY= or RPSPFX= parameter identifying the user
profile that is to be used as the RPS spool queue. One Advantage
CA-Roscoe can use the key/prefix specified in the RPS definition;
all others must use RPSKEY=/RPSPFX= to establish a unique spool
queue.
– Not shared - The Advantage CA-Roscoe JCL for each job must include
an RPSCSECT= parameter identifying a unique RPS definition.

1.17.5 RPSKEY= Parameter


Identifies the sign-on key associated with the profile that is to be used as the
RPS spool queue.

1.17.5.1 Syntax

RPSKEY Parameter
──RPSKEY=──key────────────────────────────────────────────────

key is a sign-on key.

Chapter 1. Advantage CA-Roscoe 1-109


1.17 RPS-Related Parameters

1.17.5.2 Notes

Additional information about this initialization parameter:


■ By default, the sign-on key or prefix specified in the RPS definition
(identified by RPSCSECT=) is used to identify the RPS spool queue. You
can use either RPSKEY= or RPSPFX= to override that definition.
■ RPSKEY= and RPSFPX= are mutually exclusive.

1.17.6 RPSPFX= Parameter


Identifies the prefix associated with the profile that is to be used as the RPS
spool queue.

1.17.6.1 Syntax

RPSPFX Parameter
──RPSPFX=──pfx────────────────────────────────────────────────

pfx is a two- or three-character prefix.

1.17.6.2 Notes

Additional information about this initialization parameter:


■ By default, the sign-on key or prefix specified in the RPS definition
(identified by RPSCSECT=) is used to identify the RPS spool queue. You
can use either RPSKEY= or RPSPFX= to override that definition.
■ RPSKEY= and RPSFPX= are mutually exclusive.

1-110 Programs and Utilities Guide


1.18 RTM-Related Parameters

1.18 RTM-Related Parameters


The following initialization parameters are used to activate and customize the
Response-Time Monitor.

1.18.1 RTM= Parameter


Controls the activation of the Response-Time Monitor.

1.18.1.1 Syntax

RTM Parameter
┌─NO──┐
──RTM=──┴─YES─┴───────────────────────────────────────────────

NO do not activate
YES activate

1.18.1.2 Notes

Additional information about this initialization parameter:


■ The default is RTM=NO.
■ For additional information, see the description of the RTM report
(produced by Advantage CA-Earl) and the RTM system command.

1.18.2 RTMCFCMD= Parameter


Defines the complexity factor to be associated with the number of commands
processed.

1.18.2.1 Syntax

RTMCFCMD Parameter
┌─13─┐
──RTMCFCMD=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 0 and 32767 that represents the


command complexity factor.

Chapter 1. Advantage CA-Roscoe 1-111


1.18 RTM-Related Parameters

1.18.2.2 Notes

Additional information about this initialization parameter:


■ The default is RTMCFCMD=130.

1.18.3 RTMCFCPU= Parameter


Defines the complexity factor to be associated with the number of CPU timer
units used.

1.18.3.1 Syntax

RTMCFCPU Parameter
┌─1───┐
──RTMCFCPU=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 0 and 32767 that represents the CPU
complexity factor.

1.18.3.2 Notes

Additional information about this initialization parameter:


■ The default is RTMCFCPU=1.

1.18.4 RTMCFDIO= Parameter


Defines the complexity factor to be associated with the disk I/O complexity
factor.

1.18.4.1 Syntax

RTMCFDIO Parameter
┌─52─┐
──RTMCFDIO=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 0 and 32767 that represents the disk
I/O complexity factor.

1.18.4.2 Notes

Additional information about this initialization parameter:


■ The default is RTMCFDIO=520.

1-112 Programs and Utilities Guide


1.18 RTM-Related Parameters

1.18.5 RTMCMARK= Parameter


Defines one to three values that indicate the number of RTM complexity level
markers and the value to be associated with each.

1.18.5.1 Syntax

RTMCFDIO Parameter
┌─5,25,15─┐
│ ┌─,────────┐ │
┬────────┬┴───┴───────────────────────────────
──RTMCFDIO=──┴──
└─,──num─┘

num is a numeric value between 0 and 65535 that is to be associated


with a complexity level marker. If multiple values are specified,
they must be separated by commas and in ascending order.

1.18.5.2 Notes

Additional information about this initialization parameter:


■ The default is RTMCMARK=500,2500,15000.

1.18.6 RTMINTVL= Parameter


Defines the interval (that is, number of minutes) to be used in writing the RTM
records (that is, the PSE) to the accounting files.

1.18.6.1 Syntax

RTMINTVL Parameter
┌─1──┐
──RTMINTVL=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 2 and 120.

1.18.6.2 Notes

Additional information about this initialization parameter:


■ The default is RTMINTVL=10.

Chapter 1. Advantage CA-Roscoe 1-113


1.18 RTM-Related Parameters

1.18.7 RTMLIB= Parameter


Identifies the library member that contains a list of users and terminals that are
to be included or excluded from monitoring.

1.18.7.1 Syntax

RTMLIB Parameter
──RTMLIB=──mem────────────────────────────────────────────────

mem is the name of a library member. If no prefix is specified, RO is


assumed.

1.18.7.2 Notes

Additional information about this initialization parameter:


■ The default is to monitor all users if RTM=YES is specified.
■ For information about creating this member, see the description of the
RTM command in the Advantage CA-Roscoe Interactive Environment System
Commands Guide.

1.18.8 RTMSYNC= Parameter


Designates whether the interval defined by RTMINTVL= is to be synchronized
with the hour.

1.18.8.1 Syntax

RTMSYNC Parameter
──RTMSYNC=──num───────────────────────────────────────────────

num is a value between 0 and 59 that represents the number of minutes


after the hour at which synchronization is to occur.

1.18.8.2 Notes

Additional information about this initialization parameter:


■ The default is that the interval is not synchronized with the hour.

1-114 Programs and Utilities Guide


1.18 RTM-Related Parameters

1.18.9 RTMTMARK= Parameter


Defines one to five values that indicate the number of RTM time buckets and
the value to be associated with each.

1.18.9.1 Syntax

RTMTMARK Parameter
┌─5,1,3,1,3─┐
│ ┌─,──────┐ │
┬──────┬┴──────┴──────────────────────────────
──RTMTMARK=──┴──
└─,num─┘

num is a numeric value that represents tenths of seconds (for example, 5


represents .5 seconds; while 10 represents 1.0 seconds). If multiple
values are specified, they must be separated by commas and in
ascending order. Specify a value ranging from 0 to 65535.

1.18.9.2 Notes

Additional information about this initialization parameter:


■ The default is RTMTMARK=5,10,30,100,300.

1.18.10 RTMXMIT= Parameter


Designates whether computed response time is to include CPU processing time
and data transmission time.

1.18.10.1 Syntax

RTMXMIT Parameter
┌─NO──┐
──RTMXMIT=──┴─YES─┴───────────────────────────────────────────

NO use only CPU processing time to compute response time.


YES use CPU processing time plus the data transmission time to
compute response time.

1.18.10.2 Notes

Additional information about this initialization parameter:


■ The default is RTMXMIT=NO.

Chapter 1. Advantage CA-Roscoe 1-115


1.19 SET Default Parameters

1.19 SET Default Parameters


The following parameters are used to establish the site default values for the
majority of SET commands.

1.19.1 AUTOIND= Parameter


Establishes the default setting for the SET AUTOINDENT command.

1.19.1.1 Syntax

AUTOIND Parameter
┌─OFF─┐
──AUTOIND=──┴─ON──┴───────────────────────────────────────────

OFF deactivates the automatic indentation facility.


ON activates the automatic indentation facility.

1.19.1.2 Notes

Additional information about this initialization parameter:


■ The default is AUTOIND=OFF.

1.19.2 AUTOINS= Parameter


Establishes the default setting for the SET AUTOINSERT command.

1.19.2.1 Syntax

AUTOINS Parameter
┌─OFF─┐ ┌─1───┐
──AUTOINS=──┴─ON──┴──┼─────┼──────────────────────────────────
└─num─┘

OFF deactivates the automatic line insertion facility.


ON activates the automatic line insertion facility.
num is the number of lines that are to be used as the line insertion value.
If omitted, the default is 1. The maximum value is 255.

1-116 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.2.2 Notes

Additional information about this initialization parameter:


■ The default is AUTOINS=OFF.

1.19.3 CHARDFLT= Parameter


(See page 1-57 for a the description of CHARDFLT=.)

1.19.4 CMDLINES= Parameter


Establishes the default setting for the SET CMDLINES command.

1.19.4.1 Syntax

CMDLINES Parameter
┌─3,1──────┐
──CMDLINES=──┴─cur,next─┴─────────────────────────────────────

cur is a numeric value between 1 and 3 that represents the number of


lines that are to comprise the Command Area of the current
presentation area.
next is a numeric value between 1 and 3 that represents the number of
command lines that are to be used in each presentation area the
next time the screen is split.

1.19.4.2 Notes

Additional information about this initialization parameter:


■ The default is CMDLINES=3,1.

1.19.5 CURSOR= Parameter


Establishes the default setting for the SET CURSOR command.

1.19.5.1 Syntax

CURSOR Parameter
┌─INIT─┐
──CURSOR=──┼─HOME─┼───────────────────────────────────────────
└─DATA─┘

INIT places the cursor in the first line of the Command Area when data
is initially attached. Thereafter, the cursor remains in the area
appropriate for the type of command just executed.

Chapter 1. Advantage CA-Roscoe 1-117


1.19 SET Default Parameters

HOME places the cursor in the first line of the Command Area when data
is initially attached. Thereafter, the cursor returns to the Command
Area following the execution of any primary, Monitor or line
command.
DATA places the cursor in the first modifiable field of the Execution Area
when data is initially attached. Thereafter, the cursor remains in the
area appropriate for the type of command just executed.

1.19.5.2 Notes

Additional information about this initialization parameter:


■ The default is CURSOR=INIT.

1.19.6 DELIMIT= Parameter


Establishes the default setting for the SET command.

1.19.6.1 Syntax

DELIMIT Parameter
┌─&────┐
──DELIMIT=──┴─char─┴──────────────────────────────────────────

char is the special character that is to be used as the default command


delimiter.

1.19.6.2 Notes

Additional information about this initialization parameter:


■ The default is DELIMIT=&.

1.19.7 EDITCHNG= Parameter


Establishes the default setting for the SET EDITCHNG command.

1.19.7.1 Syntax

EDITCHNG Parameter
┌─OFF─┐
──EDITCHNG=──┴─ON──┴──────────────────────────────────────────

OFF deactivates the use of the change indicator.


ON activates the use of the change indicator (that is, the sequence
number field of any line affected by an edit operation is to contain
a change indicator).

1-118 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.7.2 Notes

Additional information about this initialization parameter:


■ The default is EDITCHNG=OFF.

1.19.8 EOF= Parameter


Establishes the default setting for the SET EOF command.

1.19.8.1 Syntax

EOF Parameter
┌─DELETE1─┐
──EOF=──┼─DELETE──┼───────────────────────────────────────────
└─ERASE───┘

DELETE1 allows the line to be deleted if the cursor is in the first position of
the line. If the cursor is placed anywhere else, the contents of the
line, from the cursor position to the end of the display, is deleted.
DELETE allows the line to be deleted if the cursor is in the first displayed
position of the line. If the cursor is placed anywhere else on the line,
the contents of the line, from the cursor position to the end of the
display, is deleted.
ERASE allows the contents of a line to be deleted, from the cursor position
to the end of the display. The line containing the text is not deleted.

1.19.8.2 Notes

Additional information about this initialization parameter:


■ The default is EOF=DELETE1.

1.19.9 ESCAPE= Parameter


(See page 1-75 for a the description of ESCAPE=.)

1.19.10 FILL= Parameter


Establishes the default setting for the SET FILL command.

Chapter 1. Advantage CA-Roscoe 1-119


1.19 SET Default Parameters

1.19.10.1 Syntax

FILL Parameter
┌─NULL──┐
──FILL=──┴─BLANK─┴────────────────────────────────────────────

NULL null fill lines


BLANK blank fill lines

1.19.10.2 Notes

Additional information about this initialization parameter:


■ The default is FILL=NULL.

1.19.11 MASTER= Parameter


Establishes the default setting for the SET MASTER command.

1.19.11.1 Syntax

MASTER Parameter
──MASTER=──(libr─┬─────┬─)────────────────────────────────────
└─,ON─┘

libr is the name of the AllFusion CA-Librarian master file to be used to


expand -INC statements encountered in a submitted job.
ON activates -INC expansion. If ON is omitted, -INC expansion is not
initially enabled.

1.19.11.2 Notes

Additional information about this initialization parameter:


■ If omitted, no default AllFusion CA-Librarian master file is available and
-INC expansion is not enabled.

1.19.12 MIX= Parameter


Establishes the default setting for the SET MODE MIX/NOMIX command.

1-120 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.12.1 Syntax

MIX Parameter
┌─NO──┐
──MIX=──┴─YES─┴───────────────────────────────────────────────

NO designates that search commands are case sensitive.


YES designates that search commands are NOT case sensitive.

1.19.12.2 Notes

Additional information about this initialization parameter:


■ The default is MIX=NO.
■ Users may issue the SET MODE MIX command to override the system
default.
■ The M operand on search specific commands will still be valid.

1.19.13 MODE= Parameter


Establishes the default display format setting for the SET DISPLAY command.

1.19.13.1 Syntax

MODE Parameter
┌─NUMX──┐
──MODE=──┼─NUM───┼────────────────────────────────────────────
├─NONUM─┤
└─NUM2──┘

NUMX causes each display line to begin with an unprotected six-digit


sequence number field, followed by a data field.
NUM causes seach display line to begin with a protected six-digit
sequence number field, followed by a data field.
NONUM causes each display line to consist of a single data field; there is no
sequence number.
NUM2 causes each display line to occupy two lines. The first line is the
line number and the second line is the data line.

Chapter 1. Advantage CA-Roscoe 1-121


1.19 SET Default Parameters

1.19.13.2 Notes

Additional information about this initialization parameter:


■ The default is MODE=NUMX.

1.19.14 MONLEVEL= Parameter


Establishes the default setting for the SET MONLEVEL command.

1.19.14.1 Syntax

MONLEVEL Parameter
┌─ERROR─┐
──MONLEVEL=──┴─INFO──┴────────────────────────────────────────

ERROR displays only error messages;informational messages are


suppressed.
INFO displays informational and error messages.

1.19.14.2 Notes

Additional information about this initialization parameter:


■ The default is MONLEVEL=ERROR.

1.19.15 MONTRAP= Parameter


Establishes the default setting for the SET MONTRAP command.

1.19.15.1 Syntax

MONTRAP Parameter
┌─OFF─┐
──MONTRAP=──┴─ON──┴───────────────────────────────────────────

ON suppresses error messages and prompts.


OFF displays error messages and prompts.

1.19.15.2 Notes

Additional information about this initialization parameter:


■ The default is MONTRAP=OFF.

1-122 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.16 PFKDELIM= Parameter


Establishes the default special character that is to be used as a delimiter when
assigning multiple commands to a PF key.

1.19.16.1 Syntax

PFKDELIM Parameter
┌─/────┐
──PFKDELIM=──┴─char─┴─────────────────────────────────────────

char is any special character.

1.19.16.2 Notes

Additional information about this initialization parameter:


■ The default is PFKDELIM=/.
■ Users may issue the SET PFKDELIM command to establish a different
character.

1.19.17 PFSPLIT= Parameter


Establishes the default setting for the SET SPLIT command.

1.19.17.1 Syntax

PFSPLIT Parameter
┌─CSR──┐
──PFSPLIT=──┼─FULL─┼──────────────────────────────────────────
└─PART─┘

CSR Causes the screen to be split based on the cursor location.


FULL Causes the screen to invoke a full screen split regardless of the
cursor position.
PART Causes the screen to invoke a partial screen split regardless of the
cursor position.

1.19.17.2 Notes

Additional information about this initialization parameter:


■ The default is PFSPLIT=CSR.
■ Users may issue the SET SPLIT command to establish a different character.

Chapter 1. Advantage CA-Roscoe 1-123


1.19 SET Default Parameters

1.19.18 PRESERVE= Parameter


Establishes the default setting for the SET MODE PRESERVE/NOPRESERVE
command.

1.19.18.1 Syntax

PRESERVE Parameter
┌─NO──┐
──PRESERVE=──┴─YES─┴──────────────────────────────────────────

NO designates that non-displayable AWS data is not to be preserved


when characters on the same line are changed.
YES designates that non-displayable AWS data is to be preserved when
characters on the same line are changed.

1.19.18.2 Notes

Additional information about this initialization parameter:


■ The default is PRESERVE=NO.

1.19.19 RESPLINE= Parameter


Establishes the default setting for the SET SYSID and SET USERID commands.

1.19.19.1 Syntax

RESPLINE Parameter
┌─SYSID──┐
──RESPLINE=──┴─USERID─┴───────────────────────────────────────

SYSID displays Advantage CA-Roscoe's applid (at VTAM sites) or jobname


(at BTAM sites) on the Response Line. If omitted, this information is
not displayed.
USERID displayes the user's prefix and sign-on key on the Response Line. If
omitted, this information is not displayed.

1.19.19.2 Notes

Additional information about this initialization parameter:


■ If omitted, no information is displayed on the Response Line.
■ If both operands are used, they may be specified in any order and must be
separated by a comma (for example, RESPLINE=(USERID,SYSID).

1-124 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.20 RPSNOTFY= Parameter


Establishes the default setting for the SET RPSNOTIFY (or RPSNOTIFY)
command.

1.19.20.1 Syntax

RPSNOTFY Parameter
┌─OFF───┐
──RPSNOTFY=──┼─ON────┼────────────────────────────────────────
└─NEVER─┘

OFF deactivates the RPS notification facility.


ON activates the RPS notification facility which causes a message to be
displayed when a user's RPS request is printed.
NEVER prevents any user from activating the RPS notification facility.

1.19.20.2 Notes

Additional information about this initialization parameter:


■ The default is RPSNOTIFY=OFF.
■ If ON or OFF are specified, the user can override the setting using the SET
RPSNOTIFY command and/or the NOTIFY/NONOTIFY operands of the
PRINT command.
■ The command can be specified as SET RPSNOTIFY or SET RPSNOTFY.

1.19.21 SAVEATTR= Parameter


Establishes the default access attribute setting for the SET SAVEATTR
command.

1.19.21.1 Syntax

SAVEATTR Parameter
┌─Shared─────┐
──SAVEATTR=──┴─Restricted─┴───────────────────────────────────

Shared sets the attribute to allow anyone to access or execute a member;


only the owner can change or delete it. This operand can be
specified as S or SHARED.
Restricted
sets attributes to allow only the owner to execute, access, change or
delete a member. This operand can be specified as R or
RESTRICTED.

Chapter 1. Advantage CA-Roscoe 1-125


1.19 SET Default Parameters

1.19.21.2 Notes

Additional information about this initialization parameter:


■ The default is SAVEATTR=SHARED.

1.19.22 SCROLL= Parameter


Establishes the default setting for the SET SCROLL command.

1.19.22.1 Syntax

SCROLL Parameter
┌─FULL─┐
──SCROLL=──┼─FRAM─┼───────────────────────────────────────────
├─HALF─┤
├─CSR──┤
├─PAGE─┤
└─num──┘

FULL scrolls the display one line less than a full frame.
FRAM scrolls the display the number of data lines in the execution area.
(PAGE is a synonym for FRAM.)
HALF scrolls the display one-half frame.
CSR scrolls the display to begin or end with:
1. the line containing the cursor when scrolling forward or
backward, or
2. the column containing the cursor when scrolling left or right.
PAGE scrolls the display one page.
num is the number of lines the display is to scroll.

1.19.22.2 Notes

Additional information about this initialization parameter:

■ The default is SCROLL=FULL.


■ This parameter is only valid at 3270-type terminals.

1-126 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.23 SEARCH= Parameter


Establishes the default setting for the SET SEARCH command.

1.19.23.1 Syntax

SCROLL Parameter
┌─NODCBCS─┐ ┌─CJUSTIFIED─┐
──SCROLL=──┴─DBCS────┴──┼─JUSTIFIED──┼────────────────────────
├─LOCKED─────┤
└─CENTERED───┘

NODBCS designates that the data to be searched does not include a


double-byte character set.
DBCS designates that the data to be searched includes a double-byte
character set.
CJUSTIFIED alters the display margins only if the matching string does not
fall within the current margins.
JUSTIFIED alters the display margins so that the first character of the
matching string begins in the left-most position of the line.
LOCKED the display margins are never altered even if the matching
string occurs to the left or right of the current margins.
CENTERED alters the display margins to center the matching string on the
line.

1.19.23.2 Notes

Additional information about this initialization parameter:


■ The SEARCH= parameter establishes two search criteria defaults.
1. Whether the data searched may be encoded in DBCS format.
2. The screen positioning displayed when the data is located.
To set a default for both search criteria, specify the SEARCH= parameter
twice, one for each setting. (For example, SEARCH=DBCS and
SEARCH=LOCKED.)
■ The default for encoded data is SEARCH=NODBCS.
■ The default for screen positioning is SEARCH=CJUSTIFIED.

Chapter 1. Advantage CA-Roscoe 1-127


1.19 SET Default Parameters

1.19.24 STANDARD= Parameter


Establishes the character translation default for the SET MODE command.

1.19.24.1 Syntax

STANDARD Parameter
┌─BASIC───┐
──STANDARD=──┴─XTENDED─┴──────────────────────────────────────

BASIC uppercases alphabetic, numeric and special characters.


XTENDED accepts uppercase and lowercase alphabetic, numeric and
special characters.

1.19.24.2 Notes

Additional information about this initialization parameter:


■ The default is STANDARD=BASIC.

1.19.25 STATS= Parameter


Establishes the default setting for the SET STATS command.

1.19.25.1 Syntax

STATS Parameter
┌─ASIS─┐
──STATS=──┬─┴──────┴──┬─────────┬─┬───────────────────────────
│ └─INHIBIT─┘ │
├─ON──┬─────────┬───────┤
│ └─INHIBIT─┘ │
└─OFF───────────────────┘

ASIS causes only existing directory information to be updated.


ON causes SPF directory information to be added or updated to the
directory entry for a member.
OFF prevents directory information from being added.
INHIBIT prevents the user from changing the default setting.

1-128 Programs and Utilities Guide


1.19 SET Default Parameters

1.19.25.2 Notes

Additional information about this initialization parameter:


■ The default is STATS=ASIS.

1.19.26 SUBINCL Parameter


Establishes the default for +INC statement expansion used by the SET SUBMIT
command.

1.19.26.1 Syntax

SUBINCL Parameter
──SUBINCL──(no operands)──────────────────────────────────────

1.19.26.2 Notes

Additional information about this initialization parameter:


■ If SUBINCL is omitted, +INC statements are not to be expanded.
■ If SUBINCL is specified, +INCL statements are expanded when
encountered within submitted jobs streams.

1.19.27 SUBNOSEQ Parameter


Establishes the default for sequence number inclusion used by the SET
SUBMIT command.

1.19.27.1 Syntax

SUBNOSEQ Parameter
──SUBNOSEQ──(no operands)─────────────────────────────────────

1.19.27.2 Notes

Additional information about this initialization parameter:


■ If SUBNOSEQ is omitted, sequence numbers are included and placed in
the location designated by the AWS or library member attribute.
■ If SUBNOSEQ is specified, sequence numbers are not to be included in the
data.

Chapter 1. Advantage CA-Roscoe 1-129


1.19 SET Default Parameters

1.19.28 SUBWIDTH= Parameter


Establishes the default width used by the SET SUBMIT command.

1.19.28.1 Syntax

SUBWIDTH Parameter
┌─8──┐
──SUBWIDTH=──┴─num─┴──────────────────────────────────────────

num is a numeric value between 8 and 254.

1.19.28.2 Notes

Additional information about this initialization parameter:


■ The default is SUBWIDTH=80.
■ This value sets the default width for the data submitted through the
SUBMIT command.
■ It is invalid for a non-JES2 site to set a width to a value other than 80.

1-130 Programs and Utilities Guide


1.20 Sign On-Related Parameters

1.20 Sign On-Related Parameters


The following parameters are used to control user sign-on processing.

1.20.1 HELLO= Parameter


Identifies the library member containing the newsletter/message that is to be
displayed after a user signs on to Advantage CA-Roscoe.

1.20.1.1 Syntax

HELLO Parameter
┌─RO.HELLO─┐
──HELLO=──┴─mem──────┴────────────────────────────────────────

mem is the name of a Advantage CA-Roscoe library member. If no prefix


is specified, RO is assumed.

1.20.1.2 Notes

Additional information about this initialization parameter:


■ The default is HELLO=RO.HELLO.
■ The HELLO member must have SHR access attribute and it must be stored
under a profile associated with a group that permits universal SHR access.
See the Advantage CA-Roscoe Interactive Environment System Reference Guide
for additional information about creating and maintaining the newsletter.)

1.20.2 SEND= Parameter


Sends a message to each user after they have signed on to Advantage
CA-Roscoe.

1.20.2.1 Syntax

SEND Parameter
──SEND=──'msg'────────────────────────────────────────────────

msg is a one- to 64-character message that must be bound with


apostrophes.

Chapter 1. Advantage CA-Roscoe 1-131


1.20 Sign On-Related Parameters

1.20.2.2 Notes

Additional information about this initialization parameter:


■ This is known as the operator's global message and may be updated by the
SEND ALL command (described in the Advantage CA-Roscoe Interactive
Environment Command Reference Guide).

1.20.3 SIGNON= Parameter


Controls the users ability to sign on to Advantage CA-Roscoe.

1.20.3.1 Syntax

SIGNON Parameter
┌─YES─┐
──SIGNON=──┴─NO──┴────────────────────────────────────────────

YES permits users to sign on. (ON is a synonym for YES.)


NO prevents users from signing on. (OFF is a synonym for NO).

1.20.3.2 Notes

Additional information about this initialization parameter:


■ The default is SIGNON=ON.

1.20.4 SONMSG= Parameter


Displays a one-line message on the Advantage CA-Roscoe sign-on screen.

1.20.4.1 Syntax

SONMSG Parameter
──SONMSG=──'msg'──────────────────────────────────────────────

msg is a one- to 59-character message that is to be displayed on the


Advantage CA-Roscoe sign-on screen. Bound the message with
apostrophes. Advantage CA-Roscoe centers messages less than 59
characters.

1-132 Programs and Utilities Guide


1.20 Sign On-Related Parameters

1.20.4.2 Notes

Additional information about this initialization parameter:


■ If SONMSG= is not specified, no message is displayed.

1.20.4.3 DD Statements

The following DD statements are required:


ROSACT00 - ROSACTnn
identifies the output files to hold the current accumulation of
accounting records for each Advantage CA-Roscoe user. One
unique DD statement must be included for each file. (These
files are used as input to the ACCTDUMP program.)
ROSLIB00, ROSLIB01, ROSLIB02, ROSLIBnn
identifies the files comprising the user library system. One
unique DD statement must be included for each file and each
file should have a disposition of SHR.
STEPLIB identifies the Advantage CA-Roscoe and Unicenter CA-Look
common component execution libraries (CAI.RO60LIB).
SYSAWSP, SYSAWS1, SYSAWSn
identifies the files comprising the AWS. One unique DD
statement must be included for each file. All AWS files must
be defined as DISP=OLD.
SYSUDUMP identifies the output file to be used in case Advantage
CA-Roscoe should abend.

The following DD statements are optional:


ROSBSIN identifies the input file containing the sequence of Advantage
CA-Roscoe or Monitor commands to be tested. Required when
executing a batch Advantage CA-Roscoe session.
ROSBSOUT identifies the output file that is to contain the responses to the
commands defined in ROSBSIN. Required when executing
batch Advantage CA-Roscoe session.
ROSNAP identifies the output file that is to be used to hold snap data. It
is used in the event Advantage CA-Roscoe intercepts an abend
and can recover. The file is dynamically allocated if it is not
specified and a Monitor abend occurs. (It is allocated as a
SYSOUT file with the message class under which Advantage
CA-Roscoe is running.)
SORTLIB, SORTWKnn
identifies the SORTLIB and SORTWKnn DD statements. If the
SORT Monitor routine is used at your site, you must specify a
SORTLIB and six SORTWKnn DD statements. (These DD

Chapter 1. Advantage CA-Roscoe 1-133


1.20 Sign On-Related Parameters

statements are included in the Advantage CA-Roscoe JCL


generated during installation.)
SYSIN identifies the input file containing Advantage CA-Roscoe
initialization parameters. If it is used, the parameters are read
from the file, used for the current execution of Advantage
CA-Roscoe and written to either the library member named in
the PARM= field or to a default library member. (See page
&INITPARM for a detailed description about how initialization
parameters may be defined.)
SYSPRINT identifies the output file that is to hold: 1) a list of the
initialization parameters, 2) a module cross-reference listing,
and 3) the ROSGBL definition in effect for this execution.
SYSUTnnn identifies volumes containing data sets that users access to do
reads (using commands like IMPORT and ATTACH DSN). In
practice, one unique DD statement may need to be defined for
each direct access device at your site.
If omitted, the volumes are dynamically allocated when
accessed. Also, defining SYSUTnnn does not prevent volumes
from being allocated; if the volume is needed (for ATTACH,
IMPORT, and so on) it will be allocated as needed, even if
SYSUTnnn is defined.
It is suggested that volumes containing frequently accessed
data set be defined to avoid unnecessary system overhead.
The following illustrate how the DD statements may be
defined:
//SYSUT1 DD UNIT=335,VOL=SER=MCT,DISP=SHR
//SYSUT2 DD VOL=REF=SYS1.PROCLIB,DISP=SHR
//SYSUT3 DD UNIT=338,VOL=SER=WRKPK1,DISP=SHR
No concatenated volumes are permitted. No DD parameters
other than those show above may be supplied. The disposition
may be coded as either OLD or SHR.
Note: Using IMPORT from an AllFusion CA-Panvalet library
requires a dynamic allocation. SYSUTnnn DD
statements should be avoided for volumes containing
AllFusion CA-Panvalet libraries which are accessed
frequently through Advantage CA-Roscoe IMPORT.
ETSO-refer identifies a data set that users may identify through the JCLDD
operand of the ETSO ALLOCATE command. One unique DD
statement is required for each data set.
If omitted, the data sets are dynamically allocated when a user
issues the ALLOCATE command. It is suggested that
frequently accessed data sets be defined to Advantage
CA-Roscoe through DD statements to avoid unnecessary
system overhead.

1-134 Programs and Utilities Guide


1.20 Sign On-Related Parameters

If such data sets are included in the Advantage CA-Roscoe JCL,


the data sets must have a disposition of SHR. Also, the users be
told what DD names to use to allocate these data sets. (These
data are allocated to Advantage CA-Roscoe for the length of its
execution. Users issuing the FREE command release but not
deallocate the data sets.)
TRACEDD identifies the output file that is to be used for RCS tracing.
To direct the trace information to a printer, specify the
statement as:
//TRACEDD DD SYSOUT=class
To direct the information to a buffer that is included in the
Advantage CA-Roscoe dump, specify the statement as:
//TRACEDD DD DUMMY
If this statement is omitted and RCS tracing is requested, the
trace facility SYSOUT file is dynamically allocated with the
same message class under which Advantage CA-Roscoe is
executing.

1.20.5 JCK Monitor Routine Requirements


Sites using the JCK Monitor routine (which permits Advantage CA-Roscoe
users to use the common component of Unicenter CA-Look) should review the
following DD statements to determine whether they need to be added to the
Advantage CA-Roscoe JCL:
JCHKFREE required if the DEQUE option of JCK is to be used. This DD
statement must be specified as DUMMY and precede the DD
statements for the data sets that might be dequeued through
the DEQUE option.
JENDFREE required if the DEQUE option of JCK is to be used. This DD
statement must be specified as DUMMY and follow the DD
statements for the data sets that might be dequeued through
the DEQUE option.
JOBCAT or STEPCAT
required if the VSAM option of JCK is not used. This statement
defines a VSAM catalog.

Sites should also be aware that any libraries allocated to Advantage CA-Roscoe
by the JCHKPLIB DD statement will not be available to the EXPORT
command. Advantage CA-Roscoe uses an exclusive enqueue to gain control of
the library to ensure updates are single threaded. Since these libraries are
allocated DISP=SHR to Advantage CA-Roscoe, the message DATASET
UNAVAILABLE, TRY AGAIN LATER will be generated.

Chapter 1. Advantage CA-Roscoe 1-135


1.20 Sign On-Related Parameters

To determine enqueue processing for Advantage CA-Roscoe, use


ENQTYPE={OS | ISPF}, as described on 1-47. The default is OS. If this is in
effect, you can follow the directions below:
The Unicenter CA-Look DEQUE option provides an easy solution to this
problem by dequeueing these data sets. This is most easily accomplished
by adding a step to invoke CAZ2DEQ, prior to the Advantage CA-Roscoe
online step. The necessary JCL is shown in the sample job in the
PPOPTION library. The DD statements between the JCHFREE DD
statements must be the same (ddname and dsname) as the PROCLIB DD
statements added to the Advantage CA-Roscoe online step.

//ROSCOE JOB
///
///
//JCLDEQ EXEC PGM=CAZ2DEQ
//SYSPRINT DD SYSOUT=A

//JCHKFREE DD DUMMY MARK START OF GROUP TO FREE


//JCHKPLIB DD DSN=SYS1.PROCLIB.DISP=SHR
// DD DSN=SYS2.PROCLIB.DISP=SHR
// DD DSN=SYS1.IMS.PROCLIB.DISP=SHR
//JENDFREE DD DUMMY MARK END OF GROUP TO FREE
//SYSIN DD DATA.DLLM=ZZ
// EXEC PGM=IEFBR14 (SOME JCL TO ANALYZE)
ZZ
///
///
//ONLINE EXEC PGM=ROSCOE
///
///
//JCHKPLIB DD DSN=SYS1.PROCLIB.DISP=SHR
// DD DSN=SYS2.PROCLIB.DISP=SHR
// DD DSN=SYS1.IMS.PROCLIB.DISP=SHR
///
///

Figure 1-1. Advantage CA-Roscoe Jobstream Modification for the DEQUE Option

Note:
■ If Advantage CA-Roscoe is invoked from a cataloged procedure,
the SYSIN DD in the JCLCheck step must be converted to refer to a
sequential data set or member of a partitioned data set.
■ Be sure to specify the same DD names and data set names in the
Advantage CA-Roscoe step as you use in the JCLDEQ step.

1.20.6 Access Method-Dependent Requirements


Sites using only VTAM or VTAM and XTPM must ensure that all of the
following DD statements are omitted from the Advantage CA-Roscoe JCL.

Sites using BTAM must include the appropriate following DD statements. One
unique DD statement must be included for each local terminal, local printer,
remote line or typewriter device that is to be assigned to Advantage

1-136 Programs and Utilities Guide


1.20 Sign On-Related Parameters

CA-Roscoe. (They are dedicated to Advantage CA-Roscoe for the current


execution.)
PRNTnnMx identifies a local printer. One unique DD statement must be
included for each printer, where:
nn is any unique two-character identifier.
x is a code (shown in the following chart) identifying
the type, model and buffer sizes available.

Printer Buffer Size


Code Type(s) Model Primary Alternate
blank 3262 & 1 480 960
2 3287 & 2 1920 1920
3 3289 3 1920 2560
4 4 1920 3440
5 5 1920 3564
blank 3284 & blank blank
1 3286 & 1 480
2 3288 2 1920

1.20.7 Codes Identifying Local Printers


RTERMn identifies a remote 3270 line group. One unique DD statement
must be included for each group. The value of n can be any
unique one-character identifier.
TERMnn identifies a typewriter device. One unique DD statement must
be included for each device. The value of nn may be any
two-character identifier. There is no restriction on the order in
which these statements may appear.
TERMnnfx identifies a local 3270-type device. One unique DD statement
must be included for each device, where:
nn is any unique two-character identifier.
f is the feature code M (for standard data stream
support), or Q (for extended data stream support).
x is a code (shown in the following chart) identifying
the type, model and screen size of device.

Chapter 1. Advantage CA-Roscoe 1-137


1.20 Sign On-Related Parameters

Display Buffer Size


Code Type(s) Model Primary Alternate
blank 3275 & 1 not supported not supported
0 3277 2 24x80
blank 3275 & 2 not supported not supported
2 3278 2 24x80 24x80
3 3 24x80 32x80
4 4 24x80 43x80
5 5 34x80 27x132
2 3279 2 24x80 24x80
3 3 24x80 32x80
see Note 1 obtained from
implicit
partition query
reply

Codes Identifying 3270-Type Devices

Notes:
1. To support devices whose presentation size can be altered by local setup
between Advantage CA-Roscoe sessions or whose matrix is not the
standard models 2 through 5 (for example, 3180 and 3290 devices.)
2. The only valid parameter for the PRNTnnMx, RTERMn, TERMnn and
TERMnnfx DD statements is UNIT=, identifying a control unit address. If
the assignment is DUMMY, it is bypassed (that is, not added to the run
list.)
■ If no PRNT... or TERM... DD statements are coded, the local BTAM
component of RCS is not activated.
■ If no RTERMn DD statements are coded, the remove BTAM
component of RCS is not activated.

Sites using ACF/TCAM to simulate VTAM need to include the following DD


statement:
//ROSCOE DD QNAME=rosappl
where rosappl is the Advantage CA-Roscoe application ID specified to VTAM.

1-138 Programs and Utilities Guide


1.21 Return Codes

1.21 Return Codes


The codes and messages produced by Advantage CA-Roscoe are described in
Advantage CA-Roscoe Interactive Environment Messages and Codes Guide.

Chapter 1. Advantage CA-Roscoe 1-139


1.22 Sample JCL

1.22 Sample JCL


This section contains examples that illustrate:
1. Sample Initialization Parameter Definitions:
The following examples illustrate the various ways in which the
initialization parameters may be defined.
■ To use the default library member RO.jobname when PARM= is
omitted from the EXEC statement and there is no SYSIN DD
statement:

//ROSCOE JOB ...


// EXEC PGM=ROSCOE,TIME=1439,REGION=248K
...

■ To use the parameters defined in the SYSIN DD statement for this


execution and to create/update the default library member
RO.jobname:

//ROSCOE JOB ...


// EXEC PGM=ROSCOE,TIME=1439,REGION=248K
...
//SYSIN DD 
SIGNON=YES
...

■ To use the parameters defined in the member RO.ROSPARM for this


execution, where the RO prefix is assumed since no prefix is specified
with the member name:

//ROSCOE JOB ...


// EXEC PGM=ROSCOE,TIME=1439,REGION=248K,
// PARM='ROSPARM'
...

■ To use the parameters defined in ABC.NEWPARM. If a problem is


encountered, initialization is to automatically restart using the
parameters defined in RO.ROSPARM:

//ROSCOE JOB ...


// EXEC PGM=ROSCOE,TIME=1439,REGION=248K,
// PARM='ABC.NEWPARM,ROSPARM'
...

1-140 Programs and Utilities Guide


1.22 Sample JCL

■ To use the parameters defined in the SYSIN file and to update/create


the member named ABC.NEWPARM:

//ROSCOE JOB ...


// EXEC PGM=ROSCOE,TIME=1439,REGION=248K,
// PARM='ABC.NEWPARM'
...
//SYSIN DD 
SIGNON=YES

■ To use the parameters defined in the SYSIN file and to create/update


the member ABC.NEWPARM. If an error is encountered, initialization
is to automatically restart using the parameters defined in
ROS.ROSPARM:

//ROSCOE JOB ...


// EXEC PGM=ROSCOE,TIME=1439,REGION=248K,
// PARM='ABC.NEWPARM,ROSPARM'
...
//SYSIN DD 
SIGNON=YES

2. Sample Advantage CA-Roscoe Job Stream:


The following sample JCL assumes a BTAM site with local and remote
devices.

//ROSCOE JOB ...


//ROSCOE EXEC PGM=ROSCOE,TIME=1439,REGION=248K,PARM='RO.ROSPARM'
//STEPLIB DD DSN=CAI.RO6LIB,DISP=SHR
//SYSUDUMP DD SYSOUT=A
//ROSACT DD DSN=ROSCOE.ROSACT,DISP=SHR
//ROSACT1 DD DSN=ROSCOE.ROSACT1,DISP=SHR
//SYSAWSP DD DSN=ROSCOE.SYSAWSP,DISP=OLD
//SYSAWS1 DD DSN=ROSCOE.SYSAWS1,DISP=OLD
//ROSLIB DD DSN=ROSCOE.ROSLIB,DISP=SHR
//ROSLIB1 DD DSN=ROSCOE.ROSLIB1,DISP=SHR
//ROSLIB2 DD DSN=ROSCOE.ROSLIB2,DISP=SHR
// START OF BTAM TERMINAL GROUPS
//TERM1 DD UNIT=3 TTY 1
//TERM4 DD UNIT=21 TTY 2
//TERM9M3 DD UNIT=49 327 LOCAL 1
//RTERM1 DD UNIT=A8 327 REMOTE LINE GROUP 1
//PRNT1M4 DD UNIT=5 327 PRINTER
// END OF BTAM TERMINAL COMPLEMENT
//SYSPRINT DD SYSOUT=A
//SYSIN DD 
initialization parameter(s)

Chapter 1. Advantage CA-Roscoe 1-141


1.22 Sample JCL

3. Sample Batch Advantage CA-Roscoe Session:


| The following example shows how the ROSBSIN and ROSBSOUT DD
statements might be included in the Advantage CA-Roscoe JCL. (The
ROSBSIN DD statement shows the type of commands that might be
included in this file.)

...
//ROSBSIN DD 
MYKEY User signon key
MYPASS Include password, if needed
FETCH SAMPLE Command
EDIT /ABC/DEF/ Command
U  Command
EXEC MYRPF RPF program that does not contain a panel
TESTMON Site-written Monitor command
OFF
/
//ROSBSOUT DD SYSOUT=A
...

1-142 Programs and Utilities Guide


Chapter 2. Accounting Maintenance Programs

The Advantage CA-Roscoe accounting facilities can be used to obtain SMF and
Advantage CA-Roscoe accounting information. Once the information is
obtained, it can be used to provide a variety of reports describing how
Advantage CA-Roscoe and its facilities are being used at the site.

Accounting information can be obtained through the ACCTDUMP program.


This program counts and copies the records on the Advantage CA-Roscoe
accounting files to a holding file.

The accumulated accounting information on the holding file can then be used
as input to Advantage CA-Earl. The reports produced by Advantage CA-Earl
provide:
1. AWS statistics
2. Advantage CA-Roscoe component statistics
3. Advantage CA-Roscoe usage activity information
4. Monitor command and ETSO usage information
5. RPS (Advantage CA-Roscoe Printing Services) usage information.
6. RTM (Response-Time Monitor) statistics
7. RPF (Advantage CA-Roscoe Programming Facility) program execution
statistics

Chapter 2. Accounting Maintenance Programs 2-1


2.1 Prepare Accounting Files (ACCTDUMP Program)

2.1 Prepare Accounting Files (ACCTDUMP Program)


The ACCTDUMP program counts and then copies the records on the
Advantage CA-Roscoe accounting files to the holding file OUTPUT1. The
records are copied in chronological order. (Chronological order is determined
by the date and time of the first record of the input data set, not the date the
data set was last accessed.) When all of the files have been copied, the files
are cleared.

Optionally, in addition to the accounting files, input about Advantage


CA-Roscoe library usage statistics can come from the Advantage CA-Roscoe
user libraries.

The output from ACCTDUMP consists of the OUTPUT1 file and a report that
summarizes the copied information and the status of the accounting file(s).
Optionally, a copy of the output data can be written to a second file named
OUTPUT2.

Notes:
■ When To Run ACCTDUMP:
The ACCTDUMP program may be executed at any time. If the program
detects that one of the accounting data sets identified in the JCL is empty
or is currently being used by Advantage CA-Roscoe, the data set is
ignored.
■ Requesting Library Statistics:
You have the option of obtaining library statistics about:
– All Users
If you specify the PARM field option LIBSTAT, a library statistics
record is generated for every user defined to Advantage CA-Roscoe.
– Active Users
If the Advantage CA-Roscoe initialization parameter
ACCTOPT=LIBSTAT is in effect, each active user's sign-off record will
contain library statistics.
If neither the option nor the parameter is specified, no library statistics are
obtained.

2-2 Programs and Utilities Guide


2.1 Prepare Accounting Files (ACCTDUMP Program)

Sites directing Advantage CA-Roscoe accounting records to SMF files will


get the information when the ACCTOPT=LIBSTAT initialization parameter
is in effect. To get the library statistics records produced by the LIBSTAT
option, you can execute the ACCTDUMP program, specifying the LIBSTAT
option and including a ROSACTnn DD DUMMY statement, as in:
// EXEC PGM=ACCTDUMP,PARM='LIBSTAT'
//ROSACT DD DUMMY
...
//ROSLIB DD DSN=CAI.ROSCOE.ROSLIB,DISP=SHR
...
//OUTPUT1
■ Handling Problems:
If a problem should occur while ACCTDUMP is executing, the program
can be rerun. The accounting files are cleared only after all of the records
from all of the files have been successfully copied to OUTPUT1.
■ Using Multiple Data Set Names/DD Names:
While Advantage CA-Roscoe supports a maximum of 10 accounting data
sets (named CAI.ROSCOE.ROSACT00 through CAI.ROSCOE.ROSACT09),
a maximum of 100 DD names (named ROSACT00 through ROSACT99)
may be specified in the ACCTDUMP JCL. This is useful when, for
example, a site uses multiple accounting data set per day and does not
execute the ACCTDUMP program daily. For example, a site might include
in their JCL:
// EXEC PGM=ACCTDUMP
//ROSACT DD DSN=CAI.ROSCOE.MONDAY.ROSACT,...
//ROSACT1 DD DSN=CAI.ROSCOE.MONDAY.ROSACT1,...
...
//ROSACT1 DD DSN=CAI.ROSCOE.TUESDAY.ROSACT,...
...

2.1.1.1 Description of Report

ACCTDUMP produces a two-part report.


1. The first part contains the following information about the accounting
records:
RECORD DESCRIPTION
Brief explanation of the type of account record
written.
RECORD TYPE Code representing the type of account record
written.
RECORDS WRITTEN
Total number of records written for that record type.
TOTAL Total number of records written to OUTPUT1 for
this execution.

Chapter 2. Accounting Maintenance Programs 2-3


2.1 Prepare Accounting Files (ACCTDUMP Program)

2. The second part of the report contains information about the accounting
files themselves and includes:
INPUT DATA SET DD name of the accounting file.
RECORDS Total number of records that file contained.
LOW DATE Date of the oldest record on that file.
LOW TIME Time of the oldest record on that file.
HIGH DATE Date of the newest record on that file.
HIGH TIME Time of the newest record on that file.
STATUS Condition of the file after ACCTDUMP terminates.
The status may be:
COPIED File successfully copied.
CLEARED File successfully cleared.
IN USE BY ANOTHER TASK
File currently active.
EMPTY File contains no data.
I/O ERROR I/O error occurred on input data set.

2.1.2 Program Requirements


This section describes the EXEC statement and DD statements used by the
ACCTDUMP program. There are no SYSIN control statements.

2.1.2.1 PARM Field Options

The PARM field options that can be specified on the EXEC statement are:
NOLIBSTAT prevents library usage statistics from being gathered.
Note: If neither LIBSTAT nor NOLIBSTAT is specified, the
default is NOLIBSTAT.
LIBSTAT causes library usage statistics to be obtained for all users
defined to CA-CAI.ROSCOE.

EXIT=name is the one- to eight-character name of the site-written exit


routine that is to complete the user accounting field (SRUAF) in
every library accounting record. (See the Advantage CA-Roscoe
Interactive Environment Extended Facilities for System Programmers
Guide for additional information.
EXIT= is valid only when LIBSTAT is specified

2-4 Programs and Utilities Guide


2.1 Prepare Accounting Files (ACCTDUMP Program)

2.1.2.2 SYSIN Control Statements

There are no SYSIN control statements.

2.1.2.3 DD Statements

The required DD statements are:


OUTPUT1 identifies the output file that is to contain the accounting
records. When allocating this file:
■ BLKSIZE= must be at least 1024.
■ LRECL= must be a multiple of BLKSIZE= minus 4 (for
example, 1020).
■ SPACE= must be large enough to accommodate all of the
accounting records contained in the ROSACTnn files.
■ DISP= should be MOD to ensure existing data is not
overwritten. (Existing data is overwritten with OLD.)
■ RECFM= should be VB.
ROSACTnn identifies the input files containing the accounting records.
There must be a unique DD statement for each accounting file
included in the JCL. They need not be specified in ascending
order. When allocating these files:
■ BLKSIZE= must be at least 1024.
■ LRECL= must be a multiple of BLKSIZE= minus 4 (for
example, 1020).
■ SPACE= depends on the number of files and the frequency
with which this program is executed.
■ DISP= must be SHR if ACCTDUMP is executed while
Advantage CA-Roscoe is executing.
SYSPRINT identifies the output file that is to be used for messages and
diagnostics.

The optional DD statements are:


OUTPUT2 identifies the outfile file that is to contain a second copy of the
accounting records.
As with OUTPUT1, this file must be allocated with sufficient
space to accommodate all of the accounting records in the in
the ROSACTnn files. A disposition of MOD should be specified
to ensure that existing data on the file is not overwritten.
ROSLIBnn identifies the files comprising the user library system. These
DD statements are required to obtain library usage statistics. If
included, there must be one unique DD statement for each file
in the library system.

Chapter 2. Accounting Maintenance Programs 2-5


2.1 Prepare Accounting Files (ACCTDUMP Program)

2.1.3 Return Codes


The ACCTDUMP program returns the following codes:

Table 2-1. ACCTDUMP Return Codes

Code Meaning
0 Successful execution.
4 Unable to open the SYSPRINT file.
8 Unable to open the OUTPUT1 data set.
12 No valid ROSACTnn data sets.
16 An I/O error occurred while attempting to read from one of the
input data sets.
20 Error in library statistics record production.
24 Invalid PARM - PARM option not recognized.
28 Invalid PARM - Invalid exit name.

2.1.3.1 Sample JCL

Default sample JCL to execute program ACCTDUMP is included in your


installation sample JCL library.

The member name on the installation tape will correspond to the program
name.

2-6 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

2.2 Producing Accounting Reports (Using Advantage


CA-Earl)
Advantage CA-Roscoe accounting reports are produced using Advantage
CA-Earl. Advantage CA-Earl (Easy Access Report Language) is a
comprehensive programming system that provides the user with a:
■ File management facility
■ Report generation system
■ High-level programming language

Sites that do not currently have Advantage CA-Earl can use the Advantage
CA-Earl common component that is distributed and installed from the CA
Common Services for z/OS tape.

2.2.1 Execution Requirements


To use Advantage CA-Earl to produce Advantage CA-Roscoe accounting
reports, you must:
1. Review the sample JCL provided in the member EARLJCL in the
installation sample JCL library to verify that it conforms to site
requirements. (During installation a member named EARLJCL is added to
the library of the individual assigned the RO prefix.) A JCL example is
provided in Sample JCL on page 2-8.
Note: STEPLIB must define both the Advantage CA-Earl and Advantage
CA-Roscoe load libraries. (The Advantage CA-Roscoe load library
contains ROSEARL which is a required Advantage CA-Earl input
exit.)
Also, EARLDEF defines the file containing the Advantage
CA-Roscoe accounting records that are to be used as input to
Advantage CA-Earl.
For additional information about the JCL requirements, see the Advantage
CA-Earl MVS Reference Guide.
2. Review the report definitions contained in each of the following members
in the installation sample JCL library:
EARLAWS produces an AWS statistics report.
EARLMON produces a Monitor/ETSO report that includes information
about Monitor routine usage and applications executing
under ETSO.
EARLROSC produces a report about Advantage CA-Roscoe, that
contains information about the online activity of all
Advantage CA-Roscoe users during the reporting period.

Chapter 2. Accounting Maintenance Programs 2-7


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

EARLRPF produces an RPF program execution activity report.


EARLRPS produces an RPS usage report.
EARLRSR produces a report about Advantage CA-Roscoe, that
contains statistical information about specific components
of CA-CAI.ROSCOE.
EARLRTM produces a Response-Time Monitor report.

The next section contains a sample of EARLJCL and describes the information
provided in the reports produced by these definitions. Sites that would like to
change these definitions should see the Advantage CA-Earl MVS Reference Guide.

2.2.1.1 Sample JCL

//EARLJOB JOB (ACCOUNTING),'CA-Roscoe',CLASS=A,MSGCLASS=X,


// MSGLEVEL=(1,1),NOTIFY=USERID
//-------------------------------------------------------------------
// Sample JCL to produce CA-Roscoe accounting reports using 
// CA-EARL. 
// 
// COPYRIGHT (C) 1994 - COMPUTER ASSOCIATES INTERNATIONAL, INC. 
// 
//-------------------------------------------------------------------
//EARL EXEC PGM=EARL
//STEPLIB DD DSN=CAI.RO6LIB,DISP=SHR
DD DSN=CAI.CAILIB,DISP=SHR
//EARLLIB DD DSN=CAI.RO6.SAMPJCL,DISP=SHR
//EARLOBJ DD UNIT=DISK,SPACE=(CYL,(1,1))
//ROSFILE DD DSN=ROSCOE.OUTPUT1,DISP=SHR
//SORTLIB DD DSN=SYS1.SORTLIB,DISP=SHR
//SORTIN DD UNIT=DISK,SPACE=(CYL,(1,1))
//SORTOUT DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUT1 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUT2 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUT3 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUT4 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUT5 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUT6 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SORTWK1 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SORTWK2 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SORTWK3 DD UNIT=DISK,SPACE=(CYL,(1,1))
//SYSUDUMP DD SYSOUT=
//SYSPRINT DD SYSOUT=
//SYSOUT DD SYSOUT=
//SYSIN DD 
Place the Advantage CA-Earl accounting program here....
/

2-8 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

2.2.2 Descriptions of Reports


This section describes the Advantage CA-Roscoe reports that can be produced
through Advantage CA-Earl.

2.2.3 AWS Statistics Report


The JCL and report definition in EARLAWS in the installation sample JCL
library produces the AWS Report which includes the following information:

CA-ROSCOE ACCOUNTING REPORT UTILITY


AWS REPORT

ROSCOE JOB name INITIALIZED hh:mm:ss ON mm/dd/yy


1 SHUTDOWN hh:mm:ss ON mm/dd/yy

MAXIMUM NUMBER OF LINES PER AWS 2


MAXIMUM SEQUENCE NUMBER 999999 2

3 4 5 6


PAGE LOADS FAILURES DATA FILES INDEX FILES
---------- -------- ---------- -----------
TOTAL 2 GETMAIN  NUMBER 1 NUMBER 1
IMMEDIATE 2 PAGE LOAD  BLOCK SIZE 256 BLOCK SIZE 512
INTERVALS 6 AWS AQUISITION 
INTV TEST 16

8 9 1


7 IN USE AT MAXIMUM MAXIMUM
TOTAL # SHUTDOWN IN USE % USED
---------- --------- ---------- ----------
AWSS 1  2 .2
INDEX BLOCKS 64  16 .25
DATA FILES
FILE 1 672  32 .47

Figure 2-1. AWS Report

1 ROSCOE JOB Name of the job executing CA-CAI.ROSCOE.


INITIALIZED Time and date the Advantage CA-Roscoe execution
started.
SHUTDOWN Time and date the Advantage CA-Roscoe execution
ended.
2 MAXIMUM Total number of lines that can be in an AWS.
NUMBER OF
LINES PER AWS
MAXIMUM Highest sequence number allowed in an AWS.
SEQUENCE
NUMBER

Chapter 2. Accounting Maintenance Programs 2-9


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

3 PAGE LOADS Information includes:


TOTAL Number of page loads during the execution of
CA-CAI.ROSCOE.
IMMEDIATE Number of times during the current interval that the
page was already in memory (that is, a page fault
did not occur).
INTERVALS 60 seconds initially. (See Note for details.)
INTV TEST Number 16 or a multiple of 16. (See Note for details.)
4 FAILURES Information includes:
GETMAINS Number of GETMAIN failures during the execution
of CA-CAI.ROSCOE. If any failures occur, you
should increase the size of the Advantage CA-Roscoe
region.
PAGE LOAD Number of page load SVCs that failed. This
condition should never occur and indicates a serious
problem with CA-CAI.ROSCOE.
AWS Number of times Advantage CA-Roscoe tried to get
ACQUISITION an AWS and none was available. If any failures
occur, you should add additional AWSs.
5 DATA FILES Information includes:
NUMBER Number of data files defined by the site.
BLOCK SIZE Block size defined by the site.
6 INDEX FILES Information includes:
NUMBER Number of index files defined by the site.
BLOCK SIZE Block size defined by the site.

Information about the AWS configuration and usage:

7 TOTAL # Number of AWSs, index blocks and data blocks


defined for the execution of CA-CAI.ROSCOE.
8 IN USE AT Number of AWSs, index blocks and data blocks in
SHUTDOWN use when Advantage CA-Roscoe was shutdown
9 MAXIMUM IN Maximum number of AWSs, index blocks and data
USE blocks used during the execution of
CA-CAI.ROSCOE.
10 MAXIMUM % Percentage of the AWSs, index blocks and data
USED blocks used during the execution.

2-10 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

Note:

Paging, a function of the operating system, moves storage between real storage
and paging data sets (that is, virtual storage). When a storage location is
referenced, the system checks to see if the page containing the referenced
location is in real storage. If it is not, a 'page fault' occurs. The system must
then replace a page currently in real storage with the referenced page.

If the page being replaced has been changed since it was last written to the
paging data set, it must be written out again (a pageout). The referenced page
is then copied into real storage (a pagein).

Although paging is fairly fast, it still requires I/O operations during which the
entire Advantage CA-Roscoe address space must wait.

The AWS was designed to reduce page faults. First, all AWS control blocks for
a user are contiguously allocated on a 4K page boundary. This reduces total
paging.

Second, the AWS uses PGLOAD. PGLOAD is a system service which requests
that a page be brought into real storage without forcing all of Advantage
CA-Roscoe to wait. While this should reduce the number of page faults, total
paging will not change.

Since there is a certain amount of overhead associated with PGLOAD, the


AWS Manager uses an algorithm to eliminate unnecessary PGLOADs (that is,
those where the page is already in real storage.) The algorithm is:
■ If the time between requests for a particular AWS is greater than the Page
Load Interval, a PGLOAD is issued to force the user's AWS areas into real
storage. The Total Page Load counter is incremented. If the page is already
in real storage, the Immediate Page Load counter is also incremented.
■ When the Total Page Load counter exceeds the Page Load Interval End,
the AWS Manager analyzes what has happened in the interval just
completed.
■ If the Immediate Page Load counter is 0 or 1, it means that most of the
time the page was not in real storage. The Page Load Interval is decreased
by 1.
■ If the Immediate Page Load counter is equal to or greater than 5, the
referenced areas are often already in real storage. The Page Load Interval
is incremented by 1.
■ If the Immediate Page Load counter is 2 through 4, the interval is
unchanged.
■ In any case, the Page Load Interval End is increased by 16 and the
Immediate Page Load counter is cleared.
■ Note that the Page Load Interval will not be less than 2 or greater than 300
(5 minutes).

Chapter 2. Accounting Maintenance Programs 2-11


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

This process continues through the execution of CA-CAI.ROSCOE. Over a


period of time, the Page Load Interval time will be adjusted to a value where
PGLOADs are issued only when necessary.

2.2.4 Advantage CA-Roscoe Component Statistics Report


The JCL and report definition in EARLRSR in the installation sample JCL
library can be used to produce the Advantage CA-Roscoe Statistics Report
which provides information about specific areas of CA-CAI.ROSCOE.

CA-ROSCOE ACCOUNTING REPORT UTILITY


ROSCOE STATISTICS REPORT

ROSCOE STATISTICS RECORDED DURING SHUT FOR name mm/dd/yy AT hh:mm:ss

 MPL STATISTICS 

RESOURCES AVERAGE MAXIMUM AVERAGE MAXIMUM MAX WAIT AVG WAIT AVAILABLE UNAVAILABLE
USED USED QUEUED QUEUED TIME TIME PERCENT PERCENT
1 1 1     1 

 LIBXLIB STATISTICS 

RESOURCES AVERAGE MAXIMUM AVERAGE MAXIMUM MAX WAIT AVG WAIT AVAILABLE UNAVAILABLE
USED USED QUEUED QUEUED TIME TIME PERCENT PERCENT
2 1 2     1 

 AWS CACHE STATISTICS - CACHE ACTIVE 

ALLOCATION CURRENT CURRENTLY CURRENTLY


LIMIT ALLOCATION IN USE AVAILABLE
INDEX - BLOCKS 88 8 1 7
BYTES 4556 496 512 3584
DATA - BLOCKS 392 8 1 7
BYTES 1352 248 256 1792

READS WRITES READ HITS HITS%


INDEX  2  
DATA  2  

 LIBRARY CACHE STATISTICS - CACE ACTIVE xxx

CACHE READS CACHE READ HITS CACHE READ HITS %


1 9 9

CACHE UPDATES CACHE PURGES STORAGE USED STORAGE FREE


1 124 147 552

INDEX CACHE READS INDEX CACHE READ HITS INDEX CACHE READ HITS % INDEXREADRETRIES
1 9 9 

 DATA SET FACILITY STATISTICS 

DSNCLIST DSNCLIST SUFFICIENT/ DSNINDEX DSNINDEX SUFFICIENT/


VALUE VALUE (K-BYTES) INSUFFICIENT VALUE VALUE (K-BYTES) INSUFFICIENT
1 5  8192 8 
 

CATALOG LIST REQUESTS AVG. NUMBER ENTRIES


 1

Figure 2-2. CA-Roscoe Statistics Report

2-12 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

The information recorded for each RTM interval and at shutdown includes:
MPL STATISTICS MPL activity during the reporting period(s).
Besides monitoring MPL activity, this information
can be used to determine whether to adjust the
value specified with the MPL= initialization
parameter.
LIBXLIB STATISTICS Library buffer usage during the reporting period(s).
Besides monitoring the activity and use of the extra
library buffers, this information can be used to
determine whether to adjust the value specified
with the LIBXLIB= initialization parameter.
AWS CACHE STATISTICS
AWS cache activity during the reporting period(s).
This information, provided in a form comparable to
that provided by the AWS-M command, can be
used to determine whether to adjust the value
specified with the AWSCACHE= initialization
parameter.
LIBRARY CACHE STATISTICS
Advantage CA-Roscoe library cache activity during
the reporting period(s).
This information, provided in a form comparable to
that provided by the LIBCACHE command, can be
used to determine whether to adjust the value
specified with the LIBCACHE= initialization
parameter.
DATA SET FACILITY STATISTICS
Data Set Facility usage summary messages.
This information, also written to the Advantage
CA-Roscoe Job Log as message ROS204I, can be
used to determine whether to adjust the value
specified with the DSNCLIST= or DSNINDEX=
initialization parameters.

2.2.5 Advantage CA-Roscoe User Activity Report


The JCL and report definition in EARLROSC in the installation sample JCL
library can be used to produce a Advantage CA-Roscoe report that provides
information about the online activity of all Advantage CA-Roscoe users during
the reporting period.

Chapter 2. Accounting Maintenance Programs 2-13


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

CA-ROSCOE ACCOUNTING REPORT UTILITY


DETAIL REPORT

1 2 3 4 5 6 7 8

FORMAL KEY JOB NAME TERM ID DATE ON TIME ON CPU USAGE DISK IO MON RUNS LIB BLKS
SIGNON KEY SYS ID P CONNECT CPU:CONN TERM IO DSF JOB
---------------------- -------- -------- ------- ----------- ------------ ------- -------- --------

ABC.SMITH TESTROSC K6L22ZO 8/2/9 16:37:47.64 ::.6 6


SMITH RTEST ::12.84 .5 9  

------- -------- --------


 USER KEY  ABC.SMITH TESTROSC K6L33ZO 16:37:47.64 ::.6 67  1632
SMITH RTEST ::12.84 .5 9  

------- -------- --------


------- -------- --------
 FORMAL KEY  ABC.SMITH TESTROSC K6L33ZO 16:37:47.64 ::.6 67  1632
SMITH RTEST ::12.84 .5 9  

------- -------- --------


------- -------- --------
GRAND TOTAL ABC.SMITH TESTROSC K6L22ZO 16:37.47.64 ::. 67  1632
SMITH RTEST ::. . 9  

Figure 2-3. ROSCOE Report

The information includes:

1 FORMAL Formal key and sign-on key assigned to each user


KEY/SIGNON who signed on to Advantage CA-Roscoe during the
KEY reporting period.
2 JOB Name of job executing the Advantage CA-Roscoe the
NAME/SYSID user signed on to, and name of system on which
Advantage CA-Roscoe is executing.
3 TERMID/P Eight-character terminal id, and universal password
indicator.
4 DATE ON Date when the session occurred.
5 TIME Time the user signed on and length of the session.
ON/CONNECT
6 CPU USAGE/ CPU usage during the session, and the ratio of CPU
CPU:CONNECT: to connect time.
7 DISK IO/TERM Number of disk accesses and terminal reads/writes
IO: during the reporting period.
8 MON RUN/DSF Number of Monitor command executions and
applications executed under ETSO, and the number
of Data Set Facility records.
9 LIB BLKS/JOB Total number of Advantage CA-Roscoe library blocks
COUN in use for the reporting period (or 0 if the LIBSTAT
PARM field option was not specified in the
ACCTDUMP program), and the number of jobs
submitted during the session.

2-14 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

Summary information is provided when the sign-on key changes, the formal
key changes, and the reporting period ends.

2.2.6 Monitor/ETSO Usage Report


The JCL and report definition in EARLMON in the installation sample JCL
library can be used to produce the Monitor Report which includes usage
information about Monitor commands and applications executing under ETSO.

CA-ROSCOE ACCOUNTING REPORT UTILITY


MONITOR REPORT

1 2 3 4 5

FORMAL KEY TIME ON ALL ATTJOB AWS CON DIS EXP IMP HEX
SIGNON KEY CONNECT DATE ON TOTAL LOOK ETSO SORT UTI VCA ZAP VTOC COB/PLI/JCL
------------------- ---------- ---------- ----- -------- -------- -------- -------- -------- -------- -------- ----------

718.JONES 13:1:7.41 1/16/9 3  1  2    


JONES :5:34.39        

718.JONES 13:2:.12 1/16/9 4  2  2    


JONES 1:25:34:7        

----- -------- -------- -------- -------- -------- -------- -------- --------


718.JONES 1/16/9 8  3  4    
JONES 1:32:8.46

718.JONES 1:4:.32 1/17/9 2  1  1    


JONES 3:54:34:41        

----- -------- -------- -------- -------- -------- -------- -------- --------


718.JONES 1:4:.32 1/17/9 2  1  1    
JONES 5:26:43.27

----- -------- -------- -------- -------- -------- -------- -------- --------


----- -------- -------- -------- -------- -------- -------- -------- --------
718.JONES 1:4:.32 1  4  1    
JONES 5:26:43.27

Figure 2-4. Monitor Report

The detailed information provided by this report includes:

1 FORMAL Formal key and sign-on key assigned to each user


KEY/SIGNON who signed on to Advantage CA-Roscoe during the
KEY reporting period.
2 TIME Time the user signed on and the length of the
ON/CONNECT session.
3 DATE ON Date the user signed on.
4 TOTAL Total number of Monitor commands and ETSO
applications executed by the user during the
reporting period.
5 IDs Monitor commands (identified by the first three
characters of their names) plus a heading for ETSO.
Each column shows the number of times each
command or ETSO application was executed.

Chapter 2. Accounting Maintenance Programs 2-15


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

Summary information is provided when:

■ The time changes.


■ The date changes.
■ The sign-on key changes.
■ The formal key changes.
■ The reporting period ends.

2.2.7 RPF Execution Activity Report


The JCL and report definition in EARLRPF in the installation sample JCL
library can be used to produce an RPF (Advantage CA-Roscoe Programming
Facility) program execution activity report.

The report includes:


SIGNON KEY Sign-on key of the user executing the RPF program.
DATE Date the user executed the program.
TIME Time the user executed the program.
ORIGINATING RPF Name of the RPF program the user initially
invoked.
CURRENT RPF Name of the executing RPF program. This name
may be the same as the 'originating' RPF program,
or it may be the name of a program invoked by
that RPF program.

2.2.8 RPS Usage Report


The JCL and report definition in EARLRPS in the installation sample JCL
library can be used to produce a Advantage CA-Roscoe Printing Services (RPS)
report that contain information about RPS usage during the reporting period.

2-16 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

CA-ROSCOE ACCOUNTING REPORT UTILITY


ROSCOE PRINTING SERVICES REPORT

1 2 3 4 5 6 7 8 9

ROSCOE DATE SIGNON DESTINATION PRINTER REQUEST PAGES APPLICATION SEPARATORS


JOB KEY NAME NAME NUMBER USED NAME USED

ROSCOE 4/27/9 SMITH PR17 K18P217 1 4 ROSCOE YES


ROSCOE 4/3/9 SMITH PR17 K18P217 1  ROSCOE YES
ROSCOE 5/3/9 JONES PR17 K6P32N 1 4 ROSCOE YES
ROSCOE 5/1/9 SMITH PR12 K18LDP29 4 2 ROSCOE NO
ROSCOE 5/1/9 JONES PR12 K18LDP29 5 1 ROSCOE NO
ROSCOE 5/1/9 SMITH PR12 K18LDP29 1 1 ROSCOE NO
ROSCOE 5/1/9 SMITH PR12 K18LDP29 2 1 ROSCOE NO
ROSCOE 5/1/9 BROWN PR17 K6P32N 3 5 ROSCOE YES
ROSCOE 5/28/9 SMITH RMT198 RMT198 6 3 ROSCOE YES
ROSCOE 5/28/9 SMITH RMT199 RMT199 5 3 ROSCOE YES
ROSCOE 5/28/9 SMITH RMT2 RTM2 2 3 ROSCOE YES
ROSCOE 5/28/9 JONES RMT199 RTM199 3 3 ROSCOE YES
TROS 5/3/9 BROWN PR17 K18P217 5 4 ROSCOE YES
TROS 5/3/9 SMITH PR17 K18P217 6 4 ROSCOE YES
ROSCOE 6/3/9 JONES RMT198 RMT198 1 3 ROSCOE YES
ROSCOE 6/6/9 JONES PR12 K18LDP29 1 1 ROSCOE NO
ROSCOE 6/6/9 BROWN PR12 K18LDP29 1 1 ROSCOE NO
ROSCOE 6/6/9 BROWN PR12 K18LDP29 1  ROSCOE NO
ROSCOE 6/6/9 BROWN PR12 K18LDP29 1 1 ROSCOE NO
TROS 6/19/9 SMITH PR17 K18P217 1 4 ROSCOE YES
TRSO 6/19/9 SMITH PR17 K18P217 2 4 ROSCOE YES
TROS 6/19/9 SMITH PR17 K18P217 2 8 ROSCOE YES

Figure 2-5. RPS Report

The report includes:

1 ROSCOE JOB Name of the Advantage CA-Roscoe to which the


user is signed on.
2 DATE Date the user issued the PRINT command.
3 SIGNON KEY Sign-on key of the user issuing the PRINT command.
4 DESTINATION Name of the printing location at which the print
NAME request was printed.
5 PRINTER NAME Site-defined name of the printer that printed the
request.
6 REQUEST Number assigned by Advantage CA-Roscoe to the
NUMBER user's print request.
7 PAGES USED Number of pages printed.
8 APPLICATION Source of the print request, shown as ROSCOE, VPE
NAME or ETSO. (VPE and ETSO indicate that either
CA-eMAIL, CA-ETC or an application executing
under ETSO was in control of the terminal when the
user issued.
8 SEPARATORS Indicates whether the separator pages were used.
USED Shown as YES or NO.

Summary information is provided when:


■ The destination changes
■ The sign-on key changes

Chapter 2. Accounting Maintenance Programs 2-17


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

■ The Advantage CA-Roscoe job name changes


■ The date changes

2.2.9 RTM Report


This section describes the RTM (Response-Time Monitor) statistics report. It
also includes an explanation about how these statistics are obtained, what they
mean, and how they can be used.

Report Description:

The JCL and report definition in EARLRTM in the installation sample JCL
library can be to produce the Response-Time Monitor Report that shows the
response and resource statistics collected during the prior execution of
CA-CAI.ROSCOE.

The report is divided into three segments that include:


1. Monitoring Criteria

CA-ROSCOE ACCOUNTING REPORT UTILITY


RESPONSE TIME MONITOR REPORT

INITIALIZED ON 8/3/9 AT 13:2:7.57

COMPLEXITY FACTORS:CPU 1 COMPLEXITY LEVELS 


DIS 1 52 TIME BUCKETS 2 6
CMD 13

3
COMPLEXITY LEVEL MARKERS: 5 25 15
TIME BUCKET MARKERS (SECONDS): .5 1. 3. 1. 3.

Figure 2-6. RTM Report - Part 1

The first part of the report contains the monitoring criteria. It begins by
reporting the date and time when monitoring started and includes:

1 COMPLEXITY Values used to balance the number of CPU timer


FACTORS units (CPU) against the number of disk I/Os (DIS)
against the number of executed commands for a
transaction (CMD).
2 COMPLEXITY Number of levels used in reporting.
LEVELS
TIME BUCKETS Number of transaction counters within each
complexity level.
3 COMPLEXITY One marker denoting the beginning or end of a
LEVEL complexity level.
MARKERS
TIME BUCKET One marker denoting the beginning or end of a time
MARKERS bucket.

2-18 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

2. User Statistics
The second part of the report contains information for each user or
terminal included in the reporting. One record is written for each
user/terminal active during the reporting interval.

CA-ROSCOE ACCOUNTING REPORT UTILITY


RESPONSE TIME MONITOR REPORT

INTERVAL SPANS FROM 8/3/9 AT 18:57:52.59 UNTIL 8/3/9 AT 19:5:.

1 2 3 4 5 6 7 8

RESPONSE TIME
FORMAL KEY TERMINAL AVERAGE CPU/ DIO/ CMD/ NUM OF --- NUMBER OF TRANSACTIONS WITH RESPONSE:
PFX ID MAXIMUM /TRANS /TRANS /TRANS TRANS < .5 < 1. < 3. < 1. < 3. > 3.
--------------------- -------- ------------- --------- --------- --------- ------ ------- ------- ------- ------- ------- -------

ROSCOE.CONTROL K18L29 :. :. . .       



RO :.

ROSCOE.CONTROL K18L29 :5.48 :. 2.5 19.25 4   1 2 1 1



RO :13.29

ROSCOE.CONTROL2 ROSBSIN :.7 :. 3.55 15.66 9 8 1    



AI :.69

Figure 2-7. RTM Report - Part 2

1 FORMAL KEY Formal key assigned to the user being traced.


PFX Advantage CA-Roscoe prefix assigned to the user
being traced. If the user signs off, the prefix is
preceded by an asterisk (*).
2 TERMINAL ID Identification of the terminal used.
3 RESPONSE AVERAGE
TIME Average is top time, and maximum if bottom time.
Average length of time the user/terminal waited
during the interval.
Note: If the initialization parameter RTMXMIT=YES
is specified, the time includes the CPU
processing time plus the data transmission
time (that is, the time the user had to wait). If
RTMXMIT= is omitted or specified as
RTMXMIT=NO, only the CPU processing
time is used.
MAXIMUM
Maximum length of time* the user/terminal waited
during the interval.
4 CPU/TRANS Average amount of CPU time (in microseconds) used
per transaction.
5 DIO/TRANS Average number of disk I/Os per transaction.

Chapter 2. Accounting Maintenance Programs 2-19


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

6 CMD/TRANS Average number of commands executed per


transaction.
7 NUM OF TRANS Total number of transactions for the interval.
8 NUMBER OF Number of transactions that fall within each of the
TRANSACTIONS time buckets.
WITH
RESPONSE

The preceding descriptions apply whether DETAIL or SUMMARY are


specified on the SYSIN control statement. If DETAIL is specified, the report
also includes complexity level information. Specifically, all of the totals
provided for each user or terminal are broken down to show how that
information falls within each complexity level.
3. System Performance
The final part of the report shows the system performance over the past
interval. (The date and time when that interval began and ended is
included in the report.)

CA-ROSCOE ACCOUNTING REPORT UTILITY


RESPONSE TIME MONITOR REPORT

SYSTEM PERFORMANCE FROM 8/3/9 AT 18:57:52.59 UNTIL 8/3/9 AT 19:5:.


ACTIVE PSE 1
DELETED PSES 2
PSE TOTAL 3

SUBTASK WAITS 

CPX# AVG RESP MAX RESP CPU/TRANS DIO/TRANS CMD/TRANS # TRANS < .5 < 1. < 3. < 1. < 3. > 3.
---- --------- --------- --------- --------- --------- -------- -------- -------- -------- -------- -------- --------
1 :2.2 :13.29 :. . 1. 1 7   2 1 
2 :.1 :.1 :.1 . 1. 1 1     
3 :. :. :. . .       
4 :1.17 :1.66 :.3 21. 13.5 2  1 1   

> :1.74 :13.29 :. 3.23 16.76 13 8 1 1 2 1 

SYSTEM PERFORMANCE FROM 8/3/9 AT 18:57:52.59 UNTIL 8/3/9 AT 19:5:.


ACTIVE PSE 1
DELETED PSES 2
PSE TOTAL 3

SUBTASK WAITS 
INTERVALS ACCUMULATED 1

CPX# AVG RESP MAX RESP CPU/TRANS DIO/TRANS CMD/TRANS # TRANS < .5 < 1. < 3. < 1. < 3. > 3.
---- --------- --------- --------- --------- --------- -------- -------- -------- -------- -------- -------- --------
1 :2.2 :13.29 :. . 1. 1 7   2 1 
2 :.1 :.1 :.1 . 1. 1 1     
3 :. :. :. . .       
4 :1.17 :1.66 :.3 21. 13.5 2  1 1   

> :1.74 :13.29 :. 3.23 16.76 13 8 1 1 2 1 

Figure 2-8. RTM Report - Part 3

The information begins by presenting the date and time the interval began
and ended. Additional information includes:

2-20 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

ACTIVE PSE: Number of Performance Statistic Elements (PSE) in


use at the time the interval ended. There is one PSE
for each active user.
DELETED PSWS: Number of Performance Statistic Elements that are
deleted at the end of the interval. A PSE is marked
for deletion when a user signs off or an RTM EXCL
command is issued against him.
PSE TOTAL: Total number of PSEs used during the interval.
SUBTASK WAITS: Number of times the subtask had to wait for a user
to complete transaction processing before writing the
user's PSE.
The following information is presented for each of the Complexity Levels
(CPX#) and for the system since startup:
AVG RESP: Average time users had to wait, within each complexity
level, during the past execution of CA-CAI.ROSCOE.
MAX RESP: Maximum time users had to wait, within each
complexity level, during the past execution of
CA-CAI.ROSCOE.
CPU/TRANS: Average amount of CPU time (in hundredths of seconds)
used, within each complexity level, per transaction.
DIO/TRANS: Average number of disk I/Os, within each complexity
level, per transaction.
CMD/TRANS: Average number of commands executed, within each
complexity level, per transaction.
# TRANS: Total number of transactions, within each complexity
level, for the session.
< time: Number of transactions that occurred within the range
assigned to the first time bucket.
< time: Number of transactions that occurred within the range
assigned to the second time bucket.
< time: Number of transactions that occurred within the range
assigned to the third time bucket.
< time: Number of transactions that occurred within the range
assigned to the fourth time bucket.
< time: Number of transactions that occurred within the range
assigned to the fifth time bucket.
> time: Number of transactions that occurred within the range
assigned to the sixth time bucket.

Chapter 2. Accounting Maintenance Programs 2-21


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

2.2.10 RTM Statistics Explanation


When response-time monitoring is active, Advantage CA-Roscoe keeps track of
the number of transactions per user, how long it takes to complete each
transaction and how complex each transaction is (that is, how many
commands were processed and what resources were required to complete the
transaction).

This information can be obtained either online through the RTM command or
by the report produced by Advantage CA-Earl

The following description explains how Advantage CA-Roscoe obtains and


evaluates transaction information. It assumes that the default time bucket
markers and complexity levels are in effect. (These values can be changed by
Advantage CA-Roscoe initialization parameters. See the description beginning
on page 1-111 for additional information.)

2.2.11 Counting Transactions


Advantage CA-Roscoe adds one to each eligible user's transaction counter each
time the user presses the Enter key or a PF or PA key.

2.2.12 Saving Preliminary Statistics


When a user presses the Enter or a PF/PA key (that is, following completion
of a terminal read request but before the user is dispatched), Advantage
CA-Roscoe saves the current time, number of CPU timer units and the number
of disk I/O accesses.
Note: A timer unit is equal to 26 microseconds.

When the user's transaction is complete, Advantage CA-Roscoe saves the new
time, CPU timer unit value and number of disk I/O accesses. Advantage
CA-Roscoe also saves the number of commands that have just been processed.
(Note that the definition of when a transaction is complete depends on the use
of the RTMXMIT= initialization parameter. If it is omitted or specified as
RTMXMIT=NO, the transaction is complete when Advantage CA-Roscoe is
ready to send a response to the terminal. If it is specified as RTMXMIT=YES,
the transaction is complete when Advantage CA-Roscoe issues a read to the
terminal.)

2.2.13 Determining Response Time


To calculate the response time per transaction, Advantage CA-Roscoe subtracts
the 'old' time from the 'new' time. The result is then compared against the time
bucket markers. (These markers are used to designate the beginning or end of
the time buckets used to hold transaction time statistics.) For example:

2-22 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

< .5 (if less than a half second, transaction falls in Time Bucket 1)
< 1. (if less than one second, transaction falls in Time Bucket 2)
< 3. (if less than three seconds, transaction falls in Time Bucket 3)
<1. (if less than ten seconds, transaction falls in Time Bucket 4)
<3. (if less than 3 seconds, transaction falls in Time Bucket 5)
>3. (if more than 3 seconds, transaction falls in Time Bucket 6)
Thus, if a transaction takes 2 seconds to complete, it would fall within Time
Bucket 3. To determine whether this 2-second response is good or not,
Advantage CA-Roscoe must now evaluate the transaction to find out how
complex it is.

2.2.14 Evaluating Transactions


Not all transactions are alike. For example, one transaction may involve the
user depressing a PF key to scroll while another transaction causes an RPF
program containing multiple IMPORT and EXPORT commands to be executed.

In order to obtain meaningful statistics, you need to know more about each
transaction than just how long it took to be processed. Specifically, you need
to know how many commands were involved, how much CPU time was used
and how many disk I/Os were required.

Once you know the resources used by one transaction, you need to be able to
compare that transaction against others. Advantage CA-Roscoe uses complexity
factors to balance the CPU and disk I/O counts against the number of
commands processed. The algorithm can be represented as:
(CPU timer units used  CPU complexity factor)
+ (I/O count  I/O complexity factor)
+ (commands processed + command complexity factor)

After Advantage CA-Roscoe has calculated the complexity factors, it checks the
complexity level markers to determine to which complexity level the transaction
belongs.

To illustrate how transaction complexity is determined, assume that a


transaction consists of the following commands:
FETCH mem & ATTACH & SEARCH /string/

Further assume that this transaction takes 10 CPU timer units, and 20 disk
I/Os to complete. To determine how complex the transaction is, Advantage
CA-Roscoe multiplies the transaction information by the complexity factors, as
in:
(1 timer units  CPU complexity factor of 1) = 1
+ (2 I/Os  I/O complexity factor of 52) = 14
+ ( 3 commands  cmd complexity factor of 13) = 39
Total = 18

Chapter 2. Accounting Maintenance Programs 2-23


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

Advantage CA-Roscoe then compares this total against the complexity level
markers, as in:
< 5 (if less, transaction falls in Complexity Level 1)
< 25 (if less, transaction falls in Complexity Level 2)
< 15 (if less, transaction falls in Complexity Level 3)
> 15 (if more, transaction falls in Complexity Level 4)

Since the total is 10800, this transaction falls within the range of complexity
level 3.

2.2.15 Recording Statistics


An internal matrix called the Performance Statistic Element (PSE) is maintained
for each user/terminal being monitored. After Advantage CA-Roscoe
determines the transaction complexity and computes the response time, the
appropriate element in the matrix is incremented.

Assuming the default complexity levels and time bucket markers, the matrix
looks like the following example:

Complexity Time Buckets


Levels 1 2 3 4 5 6
1
2
3
4

To keep its own resource usage to a minimum, Advantage CA-Roscoe


periodically writes all of the information from each active PSE to accounting
data sets (CAI.ROSCOE.ROSACCTnn). By default, the PSE information is
written to the file at 10 minute intervals. At that time, Advantage CA-Roscoe
also updates an area called the System Statistics Element (SSE). The SSE
contains information about the PSEs. Specifically, the SSE keeps track of the
number of active and deleted PSEs and the number of subtasks waits. It also
records complexity level information from each PSE for the last full interval
and then maintains cumulative complexity level totals since monitoring was
activated.
Note: When displaying information through the RTM command, information
about the prior and current intervals is displayed. The prior
information applies to the full 10 minute period. The current interval
information applies to what has occurred thus far in the interval.

2-24 Programs and Utilities Guide


2.2 Producing Accounting Reports (Using Advantage CA-Earl)

2.2.16 Analyzing Statistics


All of the statistics collected during monitoring are available via the RTM
command or the ACCTREPT program. But what do these statistics really
mean?

It depends on the site, the site's hardware configuration and the RTM-related
initialization parameters in effect. It is suggested that sites obtain response-time
and resource statistics over a period of time so that a 'baseline' can be
established. (Transactions with similar resource characteristics should have
similar response times and a strong correlation should be evident between
resource usage and response time.)

Once a baseline is established, sites can begin evaluating response-time


problems. For example, suppose an individual feels he is experiencing long
response times. Sites can begin the evaluation process by asking such questions
as:
■ How does this individual's response-time statistics compare to the
baseline?
If his statistics are about the same, then the response times he is
experiencing may be 'normal'.
■ If they are higher, how complex are his transactions compared to the
others?
Is he frequently accessing external data sets? Does he execute a lot of
complex RPF programs? What type of applications is he executing under
ETSO?
If his transactions are usually more complex, his response times probably
should be higher.
■ If the comparison of transaction complexity is about the same, are the
other individuals on the same line or cluster also experiencing long
response times?
If they are, there may be a problem with that line or cluster.

Chapter 2. Accounting Maintenance Programs 2-25


2-26 Programs and Utilities Guide
Chapter 3. AWS Maintenance Programs

The AWS is comprised of two or more files. It provides the Advantage


CA-Roscoe user with temporary work areas. The The AWS is created and
maintained by the FAWSDS program. The SAVEAWS program copies the
contents of each user's AWSs into the user libraries.
FAWSDS Formats the AWS files.
SAVEAWS Recovers the contents of each user's AWSs in the event of an
unscheduled Advantage CA-Roscoe shutdown.

Chapter 3. AWS Maintenance Programs 3-1


3.1 Format AWS Files (FAWSDS Program)

3.1 Format AWS Files (FAWSDS Program)


The FAWSDS program can be used to format the AWS.

Input to the FAWSDS program is the PARM field options. Output is the
reformatted AWS files and a report describing the files after they are
reformatted.
Note: The AWSSPACE RPF program (described in the Advantage CA-Roscoe
Interactive Environment System Reference Guide) can be used to determine
the number of blocks required for each data file and for the index file.
This information can then be used to determine the AWS space
requirements. The space for the AWS files can be allocated either before
or during an execution of Advantage CA-Roscoe.

3.1.1 Description of Report


The report produced by the FAWSDS program includes the following
information:
PARM FIELD shows the options specified in the FAWSDS JCL.
PARAMETERS shows all AWS options and their values. If an option is
omitted from the JCL, the default value is shown.
RESULTS shows each of the files comprising the AWS and the
number of records they contain after reformatting. Also, lists
the total number of index blocks and the total number of
data blocks.

CA-ROSCOE FORMAT AWS UTILITY V5.8 mm/dd/yy hh.mm.ss PAGE 1

PARM FIELD: SZ=32,A#=13,D#=1

PARAMETERS:

AWSAWS#: 13 AWSDBLK: 256 AWSSIZE: 32 AWSDS#: 1

RESULTS:

SYSAWSP FORMATTED WITH 137 RECORDS


SYSAWS1 FORMATTED WITH 224 RECORDS
TOTAL INDEX BLOCKS: 137
TOTAL DATA BLOCKS: 224

AWS SUCCESSFULLY FORMATTED

Figure 3-1. FAWSDS Report

3-2 Programs and Utilities Guide


3.1 Format AWS Files (FAWSDS Program)

3.1.2 Program Requirements


This section describes the PARM field options and the DD statements that are
used by the FAWSDS program. There are no SYSIN control statements.

3.1.2.1 PARM Field Options

The FAWSDS program has four options. For a detailed explanation of each
option, see the description of the AWS in the Advantage CA-Roscoe Interactive
Environment System Reference Guide.
Note: Any option that is not specified, its default value is used.
AWSAWS#=num is the number of AWSs that could be needed when
Advantage CA-Roscoe is executing. The default is 32; the
minimum is 2; the maximum is 2048. (Abbreviation:
A#=)
AWSDBLK=size is the physical block size of the AWS data files. The
default size is 2560; the minimum is 1024; the maximum
is the full-track capacity of the device. (Abbreviation:
DB=)
AWSDS#=num is the number of physical AWS data files. The default is
1; the minimum is 1; the maximum is 16. (Abbreviation:
D#=)
AWSSIZE=num is the maximum number of records a user may have in
the AWS at one time. The default is 32000; the minimum
is 100; the maximum is 32000. (Abbreviation: SZ=)

3.1.2.2 SYSIN Control Statements

There are no SYSIN control statements.

3.1.2.3 DD Statements

The following DD statements are required:


AWSPRINT identifies the output file that is to contain the: 1 ) date and time
of the run, 2) PARM field entries, 3) options used for
formatting, and 4) results of the run.
SYSAWSP identifies the AWS index file.
SYSAWSnn identifies the AWS data file(s). The number of DD statements
must be equal to the values of the AWSDS# option. Leading
zeros (for example, 01) are invalid.

Chapter 3. AWS Maintenance Programs 3-3


3.1 Format AWS Files (FAWSDS Program)

The SYSAWSP and SYSAWSnn data sets should be allocated as:


SPACE=(size,num,,CONTIG,ROUND)
where size is the block size and num is the number of blocks as determined by
the RPF program AWSSPACE. (as described in the Advantage CA-Roscoe
Interactive Environment System Reference Guide.)

3.1.3 Return Codes


Diagnostics are written to the programmer (WTO with ROUTCDE=11) during
execution. The return codes are as follows:

Code Meaning
0 Successful execution.
4 One or more errors occurred. FAWSDS terminates.

If the cause of the problem can be determined, perform the indicated remedial
action. If the cause cannot be determined or cannot be remedied through JCL,
rerun FAWSDS, making sure that the JOB card contains the parameter
MSGLEVEL=(1,1), and include in the JCL a SYSUDUMP DD statement, as
follows:
//SYSUDUMP DD SYSOUT=A
Report this error to CA Technical Support. (International sites should contact
their local representative.)

3.1.3.1 Sample JCL

Default sample JCL to execute program FAWSDS is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

3-4 Programs and Utilities Guide


3.2 Recover User AWSs (SAVEAWS Program)

3.2 Recover User AWSs (SAVEAWS Program)


The SAVEAWS program can be used to recover the data found in each
recoverable AWS at the time of an unscheduled or unexpected Advantage
CA-Roscoe shutdown. Its function is to copy the data into a SAVAWSnn
member (where nn is a unique identifier) for each user whose recoverable
AWSs contain data.

The SAVEAWS program should be executed either prior to or as part of


Advantage CA-Roscoe initialization.
■ To execute the program during initialization, specify the Advantage
CA-Roscoe parameter:
RECVRAWS=ON
■ If this program is executed prior to Advantage CA-Roscoe initialization,
the Advantage CA-Roscoe JCL should contain:
RECVRAWS=OFF

The advantage of executing SAVEAWS prior to Advantage CA-Roscoe is that


it reduces the amount of time it takes to bring Advantage CA-Roscoe up.

The disadvantage is that data may be lost if the creation of the SAVAWSnn
members causes the user's library line limit to be exceeded. (When this
program is executed as part of Advantage CA-Roscoe initialization, the
parameter RECVRAWS=ON,NOMAXLIB can be used to cause the user's
library line limit to be ignored so that no data is lost.

3.2.1 Program Requirements


This section describes the DD statements that are used by the SAVEAWS
program. There are no PARM field options or SYSIN control statements.

3.2.1.1 PARM Field Options

There are no EXEC statement parameters.

3.2.1.2 SYSIN Control Statements

There are no SYSIN control statements.

3.2.1.3 DD Statements

The required DD statements are:


ROSLIBnn identifies the user library system. One unique DD statement
must be included for each file comprising the user library
system. The disposition should be SHR.

Chapter 3. AWS Maintenance Programs 3-5


3.2 Recover User AWSs (SAVEAWS Program)

SYSAWSP identifies the AWS index file. The disposition should be SHR.
SYSAWSnn identifies the AWS data file(s). One unqiue DD statement must
be included for each file comprising the AWS. The disposition
should be OLD.

3.2.2 Return Codes


The SAVEAWS program returns the following codes:

Code Meaning
0 Successful execution. A WTO gives the count of user AWS files
saved.
4 One or more errors were encountered. A WTO with appropriate
diagnostics is issued.

3.2.2.1 Sample JCL

Default sample JCL to execute program SAVEAWS is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

3-6 Programs and Utilities Guide


Chapter 4. Library Maintenance Program Summaries

The library system consists of at least three files and must be handled as a
single entity. The library should be backed up daily using either the LIBBKUP
or LIBUTIL program. The library should be restored using LIBUTIL.
LIBBKUP creates a full, partial or selective backup of the Advantage
CA-Roscoe libraries.
LIBINACT produces a report about inactive Advantage CA-Roscoe library
members.
LIBSERVE produces library member listings, renames or deletes library
members and scans members for a specific character string.
LIBUTIL creates a full or selective backup of the Advantage CA-Roscoe
libraries; restores all or selected members (by member name,
user key or prefix); adds data files to the libraries; and formats
the libraries.
ROSCOPY writes one or more library members to an OS data set.
ROSDATA creates one or more library members from batch input.
ROSMAILS lists the members of each user's library (sorted by sign-on key),
and optionally deletes members belonging to specific users.
ROSMAILS also produces the line count violation report which
identifies those individuals who have exceeded the maximum
number of lines that they may save in the library.
ROSTAT produces a report that lists statistics on library usage, the
current values of the Advantage CA-Roscoe initialization
parameters and the current AWS configuration.

Note: The User Profile System (UPS) is used to identify each person that may
access Advantage CA-Roscoe. The individual profile information is kept
as members in the library under the UPS key. Since UPS is part of the
Advantage CA-Roscoe library system, it is automatically affected
whenever any of the library maintenance programs are executed.

Chapter 4. Library Maintenance Program Summaries 4-1


4.1 Library Backup (LIBBKUP Program)

4.1 Library Backup (LIBBKUP Program)


The LIBBKUP program provides a library backup function. It can be used to
create a:
■ Full backup of the Advantage CA-Roscoe library system.
■ Partial (or delta) backup of the Advantage CA-Roscoe library system. This
backup contains only those members that have been added or changed
since the last backup.
■ Selective backup of one or more specific library members.

The backup tape produced by LIBBKUP is identical to that produced by the


BACKUP option of LIBUTIL; therefore, sites can backup their Advantage
CA-Roscoe library system using either LIBUTIL or LIBBKUP.

Notes:
■ If LIBBKUP is to be used to perform full or partial backups, a full backup
must be performed the first time LIBBKUP is executed.
■ A date control file is required when doing a full or partial backup. This file
is identified by the DATEIN and DATEOUT DD statements and can be
allocated as follows:
//stepname EXEC PGM=IEFBR14
//SYSUT1 DD DSN=CAI.ROSCOE.BKUPCNTL,DISP=(NEW,CATLG),
// UNIT=disk,VOL=SER=volser,SPACE=(TRK,1),
// DCB=(RECFM=F,LRECL=8,BLKSIZE=8)
Since the first execution of LIBBKUP must be a full backup run, there is no
need to initialize this data set with any information. A full backup run
causes LIBBKUP to write on this file without first reading it.
■ Use the LIBUTIL program to perform library restore operations.

4.1.1 Backup User Libraries


This section describes how to backup the entire contents of the user library
system.

4.1.2 Program Requirements


The full backup function of LIBBKUP requires:
■ PARM Field Options
There are no PARM field options.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements

4-2 Programs and Utilities Guide


4.1 Library Backup (LIBBKUP Program)

The required DD statements are:


BACKUP identifies the output file that is to hold the backup data.
Either a tape or disk file may be used. No DCB parameters
are required. The default block size is 16384; the minimum
is 2000. If omitted or specified as less than 2000, 16384 is
used.
DATEOUT identifies the output file that is to be the date control file
onto which LIBBKUP records the date control information
for the current backup run.
ROSLIBnn identifies the user library system. One DD statement must
be included for each file comprising the user library
system. Each file must have a disposition of OLD.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.ROSCOE.ROSLIB).
SYSPRINT identifies the output file that is to contain messages and
diagnostics.
SYSUT1 identifies the work file that is to contain the index records
(as mapped by the Advantage CA-Roscoe macro LBINDEX)
of all Advantage CA-Roscoe library members to be written
to the backup file.
The following DD statement is optional:
SYSLOG identifies the output file that is to contain a report of the
backup file contents.

4.1.3 Return Codes


The full backup function of LIBBKUP returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.1.3.1 Sample JCL

Default sample JCL to execute program LIBBKUP for a full backup is included
in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

Chapter 4. Library Maintenance Program Summaries 4-3


4.1 Library Backup (LIBBKUP Program)

4.1.4 Backup Added/Changed Members


Performing a backup of only those library members that have been added or
changed since the last backup is useful when only a percentage of all
Advantage CA-Roscoe library members are either added or changed per day.
For example, if only 10% of all members are affected, the backup file will be
10% the size of a full backup and will be produced in 10% of the time. (A
backup of changed members is called a 'delta' backup.)

4.1.5 Program Requirements


The partial/delta backup function of LIBBKUP requires:
■ PARM Field Options
There are no PARM field options.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
BACKUP identifies the output file that is to hold the backup data.
Either a tape or disk file may be used. No DCB parameters
are required. The default block size if 16384; the minimum
size allowed is 2000. If omitted or specified as less than
2000, 16384 is used.
DATEIN identifies an input file that containing the date control
information of the previous full or delta backup run.
DATEOUT identifies an output file onto which LIBBKUP is to record
the date control information for the current backup run.
ROSLIBnn identifies the user library system. One DD statement is
required for each file in the user library system. Each file
must have a disposition of OLD.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.ROSCOE.ROSLIB).
SYSPRINT identifies the output file that is to contain messages and
diagnostics.
SYSUT1 identifies the work file that is to contain the index records
(as mapped by the Advantage CA-Roscoe macro LBINDEX)
of all Advantage CA-Roscoe library members to be written
to the backup file.

4-4 Programs and Utilities Guide


4.1 Library Backup (LIBBKUP Program)

The following DD statement is optional:


SYSLOG identifies an output file that is to contain a report of the
backup file contents.

4.1.6 Return Codes


The partial/delta backup function of LIBBKUP returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.1.6.1 Sample JCL

Default sample JCL to execute program LIBBKUP for adding/changing


members is included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.1.7 Backup Specific Member(s)


This section describes how to backup one or more specific library members.

4.1.8 Program Requirements


The member backup function of LIBBKUP requires:
■ PARM Field Options
There are no PARM field options.
■ SYSIN Control Statements
The SYSIN control statement is:
pfx.mem
One control statement must be specified for each member to be backed up.
Each control statement must begin in the first position of the line and
include the owner's prefix and a period following the prefix. The
statements must be in ascending order.
■ DD Statements
The required DD statements are:
BACKUP identifies a sequential output file that is to hold the backup
data. Either a tape or disk file may be used. No DCB
parameters are required. The default block size is 16384; the

Chapter 4. Library Maintenance Program Summaries 4-5


4.1 Library Backup (LIBBKUP Program)

minimum size allowed is 2000. If omitted or specified as


less than 2000, 16384 is used.
ROSLIBnn identifies the user library system. One DD statement is
required for each file in the user library system. Each file
must have a disposition of OLD.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.ROSCOE.ROSLIB).
SYSIN identifies an input file containing one or more control
statements.
SYSPRINT identifies an output file that is to contain messages and
diagnostics.
SYSUT1 identifies a work file that is to contain the index records (as
mapped by the Advantage CA-Roscoe macro LBINDEX) of
all Advantage CA-Roscoe library members to be written to
the backup file.
The optional DD statement is:
SYSLOG identifies an output file that is to contain a report of the
backup file contents.

4.1.9 Return Codes


This function of LIBBKUP returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.1.9.1 Sample JCL

Default sample JCL to execute program LIBBKUP for selected members is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4-6 Programs and Utilities Guide


4.2 Inactive Member Report (LIBINACT Program)

4.2 Inactive Member Report (LIBINACT Program)


The LIBINACT program can be used to produce reports of inactive Advantage
CA-Roscoe library members.

LIBINACT scans the Advantage CA-Roscoe library index for members that
have not been accessed for a specified number of days. The index entry for
each such member is included in the reports produced by the program.

RO Privileges

The owner of the RO prefix can scan the index for all prefixes in the system, or
for particular prefixes. Other users are allowed to scan the index only for
members saved under their own prefix.

4.2.1 Program Requirements


The SYSIN control statements and DD statements used by the LIBINACT
program are described in the following section. There are no PARM field
options.

4.2.1.1 PARM Field Options

There are no PARM field options.

4.2.1.2 SYSIN Control Statements

The SYSIN control statements are:


KEY identifies the user executing the program and the user's password if
the key is password protected.
LIST identifies the type of reports that are to be produced by the
program.

LIBINACT control statements should be coded within the following guidelines:


■ A KEY control statement must be the first control statement in the SYSIN
data set.
■ Only one KEY control statement may be used per execution of the
program.
■ The KEY control statement may be followed by any number of LIST
control statements.
■ Control statements may begin in any column but may not extend beyond
column 71.
■ Operands are separated by commas.

Chapter 4. Library Maintenance Program Summaries 4-7


4.2 Inactive Member Report (LIBINACT Program)

4.2.2 KEY Control Statement


Identifies the user executing the program and the user's password, if the key is
password protected.

SYNTAX

KEY Control Statement


──KEY──key──┬────────────────┬────────────────────────────────
└─,PASSWORD=pswd─┘

key is the sign-on key of the user executing the program.


PASSWORD=pswd
is the password associated with the specified sign-on key. It is
required only if the key is password protected.

NOTES:

Additional information about using this control statement:


■ The KEY statement is required. It must be the first control statement in the
SYSIN data set.
■ Only one KEY statement may be specified per execution of the program.
■ Program execution terminates if one of the following occurs :
– Specified key does not exist
– Specified key is password protected, and no password is supplied (or
an invalid password is supplied)
– Specified key belongs to the owner of the UPS prefix
■ The KEY statement is not listed in the SYSPRINT file.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To indicate that the user whose sign-on key is JONES and whose password
is XXXX is executing LIBINACT:
KEY=JONES,PASSWORD=XXXX

Note: If PASSWORD= is specified on the KEY statement, the password will


get verified against the password in the user's profile record.

4-8 Programs and Utilities Guide


4.2 Inactive Member Report (LIBINACT Program)

4.2.3 LIST Control Statement


Identifies the type of report to be produced.

SYNTAX

LIST Control Statement


──LIST──┬────────────────┬──,AGE=num──────────────────────────
│ ┌─$ALL─┐ │
└─Key=──┴─key──┴─┘

KEY= identify the user about whom reports are to be produced by


specifying either:
$ALL produces reports for all keys in the Advantage
CA-Roscoe system.
key is a sign-on key identifying the user to be included in
the report.

AGE=num is the age, in days, at which members are to be considered


inactive. Specify a value between one and four digits in length.
Zero is invalid.

NOTES:

Additional information about using this control statement:


■ There is no limit to the number of LIST statements that may be included in
the SYSIN file.
■ Program execution terminates if the following occurs if the:
– KEY operand is used by an individual other than the owner of the RO
prefix
– Specified key is invalid
– Specified key belongs to the owner of the UPS prefix
■ If the KEY=$ALL option is used, the reports produced are sorted by prefix,
with page breaks between the listings for each prefix.
■ Summary information for each LIST request is printed in the SYSPRINT
data set. This information includes the number of library index entries
checked, the number of inactive members found, and the number of
inactive records found.
■ The value specified in the AGE= operand is subtracted from the current
date to obtain the date used to determine whether a member is inactive.
Members that have not been accessed on or after this date are considered
inactive and are included in the inactivity report.

Chapter 4. Library Maintenance Program Summaries 4-9


4.2 Inactive Member Report (LIBINACT Program)

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To produce a report identifying all of the members belonging to the
individual assigned the sign-on key JONES that have not been accessed in
30 days:
LIST KEY=JONES,AGE=3

4.2.3.1 DD Statements

The following DD statements are required:


ROSLIBnn identifies the user library system. One DD statement must be
included for each file in the library system. The disposition
must be SHR.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.ROSCOE.ROSLIB).
SYSIN identifies the input file containing the SYSIN control
statements. The LRECL of this file is 80. If a block size is
specified, it must be a multiple of 80. If it is not specified, a
default of 80 is used.
SYSLIST identifies an output file that is to contain the reports produced
by this program. The LRECL of this file is 121. If a block size is
specified, it must be a multiple of 121. If it is not specified, a
default of 121 is used.
SYSPRINT identifies an output file that is to contain the listing of the
SYSIN control statements, diagnostic messages and summary
information. The LRECL of this file is 121. If a block size is
specified, it must be a multiple of 121. If it is not specified, a
default of 121 is used.

4.2.4 Return Codes


LIBINACT returns the following codes:

Code Meaning
0 Successful execution, no errors found.
4 Syntax error found in SYSIN control statement. A diagnostic
message is written; execution continues with the next control
statement.
8 Execution was terminated due to a serious error condition.

4-10 Programs and Utilities Guide


4.2 Inactive Member Report (LIBINACT Program)

4.2.4.1 Sample JCL

Default sample JCL to execute program LIBINACT is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.2.4.2 Sample LIBINACT Reports

There are two reports produced by the LIBINACT program. The report
containing the listing of the SYSIN control statements, diagnostic messages,
and summary information is directed to the SYSPRINT DD statement. The
report containing the listing of the reports produced by the LIST statements in
the SYSIN DD statement is directed to the SYSLIST file. An example of the
SYSPRINT report is:

DATE: mm/dd/yy LIBINACT ROSCOE LIBRARY UTILITY PAGE 1

CONTROL STATEMENT/DIAGNOSTIC MESSAGE LISTING

LIST KEY=$ALL,AGE=365

 SUMMARY 

TOTAL NO. MEMBERS SAVED IN LIBRARY: 45

TOTAL NO. INACTIVE MEMBERS: 328

TOTAL NO. INACTIVE LINES: 33525

>>>>>LIBIA END-OF-FILE REACHED IN SYSIN DATA SET, PROCESSING TERMINATED: NO ERRORS FOUND

An example of the SYSLIST reports are:

KEY: ROSPRIV LIBINACT ROSCOE LIBRARY UTILITY PAGE 1

DATE: mm/dd/yy LISTING OF MEMBERS NOT ACCESSED IN THE LAST 365 DAYS

MEMBER MEMBER DATE LAST LAST


NAME DESCRIPTION CREATED UPDATE ACCESSED LINES SEQ

ROS.DBCSDATA DAT: SAMPLE DBCS DATA 8/23/88 6/3/89 3/22/9 9 NOSEQ


ROS.DBCSPRT DAT: SAMPLE DBCS PRINT DATA 11/15/88 6/3/89 2/27/9 16 NOSEQ
ROS.I168939 DAT: TEST DATA FOR KANJI PRINT 4/3/88 6/3/89 1/3/9 1 NOSEQ
ROS.PRTZAP RPF: USE DCF TO PRT ZAP 9/27/87 9/27/87 1/3/9 16 NOSEQ
ROS.SORT RPF: CALL SORT UNDER ETSO 7/9/88 6/3/89 1/3/9 17 73,8
ROS.SORTFLDS DAT: SORTFLDS FOR SORT 7/9/88 6/3/89 1/3/9 4 73,8
ROS.STEPLIB JCL: STEPLIB CONCATENATION 7/31/88 6/3/89 2/27/9 3 73,8
ROS.TESTPRT DAT: TEST DATA FOR RPSEXIT 1/5/88 6/3/89 2/27/9 12 NOSEQ

TOTAL NO. INACTIVE MEMBERS: 8


TOTAL NO. INACTIVE LINES: 78

Chapter 4. Library Maintenance Program Summaries 4-11


4.3 Library Member Maintenance (LIBSERVE Program)

4.3 Library Member Maintenance (LIBSERVE Program)


Caution

As distributed, only the PARM field stands between the user and complete
access to the user libraries. If security of library data is a consideration, do
the following:
1. Move LIBSERVE from the Advantage CA-Roscoe load library to a
protected private library known and accessible to authorized users
only. If necessary, rename LIBSERVE.
2. Write a BEXEXIT exit routine. This batch exit is incorporated within
LIBSERVE and can be used to provide necessary site security checks.
(BEXEXIT is described in the Advantage CA-Roscoe Interactive
Environment Extended Facilities for System Programmers Guide.)

The LIBSERVE program can be used to perform a variety of library member


maintenance functions.

While Advantage CA-Roscoe is active, LIBSERVE can be used to perform the


following:
■ Delete a library member
■ List all or part of one or more library members
■ List the library index entries for members saved under one or more
sign-on keys
■ Provide the disk address and module control block table address of library
members
■ Rename a library member
■ Scan one or more library members for the occurrence of up to 100 specified
character strings

When Advantage CA-Roscoe is not executing, LIBSERVE can be used to:


■ Delete SAVAWSnn library members, members whose names begin with
ZZZZZ and members added by Monitor commands.
■ Edit one or more library members specifying up to 200 search/replacement
string pairs.

Library Administrator Privileges

In addition to the preceding, users who have library administrator privileges


can have the LIBRARY, LIST, LISTMON, SCAN, and EDIT control statements
affect all or specific Advantage CA-Roscoe users.

4-12 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

A Library Administrator is a user that has been assigned the privileged


command of LIBADM through UPSMNTxx (Internal security).

4.3.1 Program Requirements


This section describes the EXEC statement parameters, SYSIN control
statements and DD statements that are used by the LIBSERVE program.

4.3.1.1 PARM Field Options

The LIBSERVE program uses three PARM field options.


key is the one- to 22-character Advantage CA-Roscoe sign-on key of the
user executing the program. The sign-on key must be the first
parameter in the PARM field. If it is missing or invalid, execution is
terminated.
To use the privileged facilities of LIBSERVE, the sign-on key must
be for the owner of the RO prefix.
line-cnt is a two- to three-digit number indicating how many lines are to be
printed per page on the output listing produced by the program. If
included, it must be separated from the sign-on key by a comma.
The value given may not be greater than 150 or less than 25. If
omitted, 56 lines are printed on each output page.
PURGE causes the following catagory of library members to be deleted:
■ Members named SAVAWSnn
■ Most members names beginning with ZZZZZ
■ Members placed in the library by Monitor commands
PURGE may only be specified by the owner of the RO prefix.
PURGE may not be used when Advantage CA-Roscoe is executing.
When this option is specified, the SYSIN file must either:
■ Contain only a PURGE control statement, or
■ Be omitted or null (that is, DUMMY). If it is, all qualifying
members that are more than five days old are deleted; a library
listing is printed for each purged member.

4.3.1.2 SYSIN Control Statements

The SYSIN control statements are:


COL changes the column limits used by a subsequent SCAN control
statement.
DELETE deletes designated library members.
DISKADR provides the disk address and module control table address of
library members. (This function is provided for the use of the
Library Administrator or the individual assigned the RO prefix.

Chapter 4. Library Maintenance Program Summaries 4-13


4.3 Library Member Maintenance (LIBSERVE Program)

See Library Administrator Privileges on page 4-12 for more


information about Library Administrators.)
EDIT searches one or more members for the first or every occurrence
of a specified search string, and replaces it with the specified
replacement string.
KEY identifies the sign-on key of the user whose members are to be
involved in the action of subsequent control statements. (This
function is provided for the use of the Library Administrator or
the individual assigned the RO prefix. See Library
Administrator Privileges on page 4-12 for more information
about Library Administrators.)
LIBRARY produces a listing of library index entries for all members
saved under one or all sign-on keys.
LIST produces a listing of all or portions of one or more library
members.
LISTMON produces a listing of all or portions of one or more library
members created by a Monitor command.
PURGE deletes SAVAWSnn members, members whose names begin
with ZZZZZ and members created by Monitor commands.
(This function is provided for the use of the the individual
assigned the RO prefix.)
RENAME changes the name of an existing library member.
SCALE prints a scale line at the top and bottom of each output page
produced through the LIST, LISTMON and SCAN control
statements.
SCAN scans one or more members for every occurrence of one or
more character strings.

Within the following guidelines, LIBSERVE control statements can be coded in


free format:
■ Control statements should appear in the SYSIN file in the order in which
they are to be executed.
■ The statement may begin at any column in the record, but cannot extend
beyond column 71.
■ Operands should be separated by commas.
■ Individual keywords and operands (with their associated values) must be
complete within a record.

Most of the control statements expect a library member name as an operand.


The name can be specified in either alphabetic/numeric characters or as a
string of hexadecimal characters.

If hexadecimal characters are used, the string must not exceed 11 characters.
Also, the member name must be prefixed. With a two-character prefix, a space

4-14 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

(X'40') must separate the prefix from the member name, so that:
AA.ABCD5678 becomes X'C1C140C1C2C3C4F5F6F7F8'

With a three-character prefix, the X'40' must be omitted as shown following:


AAA.ABCD5678 becomes X'C1C1C1C1C2C3C4F5F6F7F8'

4.3.2 COL Control Statement


Changes the column limits used by a subsequent SCAN control statement.

SYNTAX

COL Control Statement


┌─1─────┐
──COL=──┼───────┼──┬────────────┬─────────────────────────────
└─start─┘ │ ┌─255─┐ │
└─,─┴─end─┴──┘

With no operand, resets the starting and ending column numbers to


1 and 255, respectively.
start is the number of the column at which the scan operation is to
begin. The maximum value is 255. The default is 1.
end is the number of the column at which the scan operation is to end.
The maximum value is 255. The default is 255.

NOTES:

Additional information about using this control statement:


■ Until a COL control statement is encountered, the column limits are 1 and
255. Once limits are specified, they remain in effect for the remainder of
the execution or until a new COL control statement is encountered.
■ If only one column boundary is specified, only that boundary is changed.
If start and end specify the same column, only that column is scanned. The
value of end must be equal to or greater than the value of start.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To change the starting and ending columns:
//SYSIN DD 
COL 81,2
■ To change only the ending column:
//SYSIN DD 
COL ,132

Chapter 4. Library Maintenance Program Summaries 4-15


4.3 Library Member Maintenance (LIBSERVE Program)

4.3.3 DELETE Control Statement


Deletes a member from the Advantage CA-Roscoe library that is saved under
the prefix of the user executing the program.

SYNTAX

DELETE Control Statement


──DELETE──┬──────┬──mem───────────────────────────────────────
└─pfx.─┘

mem is the name of the library member to be deleted. The prefix is


optional.

NOTES: Additional information about using this control statement:


■ Users may only delete members saved under their own prefix.
■ Include a separate DELETE control statement for each member to be
deleted.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To delete two members from the library:
//SYSIN DD 
DELETE TESTLIB
DELETE RSSCGET

4.3.4 DISKADR Control Statement


Provides the disk address and module control table address of library
members.

SYNTAX

DISLADR Control Statement


┌─NO──┐
──DISKADR──┴─YES─┴────────────────────────────────────────────

NO prohibits information from being provided.


YES causes information to be provided.

NOTES:

Additional information about using this control statement:


■ The default is DISKADR=NO.

4-16 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

■ While any user may use this control statement, it is provided for the use of
the Library Administrator or the owner of the RO prefix (see Library
Administrator Privileges on page 4-12 for more information about Library
Administrators.)
■ If DISKADR is omitted, no addresses are provided.
■ DISKADR must be used in conjunction with the LIBRARY control
statement, as in:
//SYSIN DD 
DISKADR=YES
LIBRARY
■ When DISKADR=YES is specified, the disk address of the member is
positioned in columns 113 through 120 of the LIBRARY information. The
module control block address is positioned in columns 123 through 130.
Each address is eight digits in length. The first two are the Advantage
CA-Roscoe data file number; the next two are always zeros; the last four
are the relative block number of the data files. For example:
12E ........ addresses block 2E on ROSLIB1

21B ........ addresses block 1B on ROSLIB2

4.3.5 EDIT Control Statement


Searches one or more library members for the first occurrence on each line, or
every occurrence of the specified search string and replaces it with the
specified replacement string.

SYNTAX

EDIT Control Statement


──EDIT──┬─MEMBER=─┬──────┬─mem─┬──┬────────┬───────────────────
│ └─pfx.─┘ │ └─,First─┘
└─ALL──────────────────┘
──┬──────────────────┬──┬───────┬──┬─────────────────┬──────────
│ ┌─NO──┐ │ └─,PAGE─┘ └─,KEY=─┬─$ALL─┬──┘
└─,TRUNC=─┴─ALL─┴──┘ └─key──┘
┌─/────────────────────────────────────────────┐
Search_string/replace_string/─┬─────────────┬─┴─────────────
───
└─start── end─┘

MEMBER=mem
is the name of the library member to be searched. The prefix
is optional.

ALL causes all members saved under the designated user's sign-on
key to be searched.

Chapter 4. Library Maintenance Program Summaries 4-17


4.3 Library Member Maintenance (LIBSERVE Program)

FIRST causes only the first occurrence of the search string found on
each line to be replaced. (Specify FIRST or F.)
TRUNC designates whether all data to the right of the original string
within column boundaries is to be shifted right, and all
characters that are shifted past these boundaries or column 255
are to be lost.
NO line containing the search string will be included in the
output listing, the edit will not occur, and an
informational message indicating that truncation would
have occurred will also be included.
YES edit will proceed and data shifted beyond column
boundaries or column 255 will be lost.
Note: If neither are specified, the default is NO.
PAGE causes each new member to begin on a new page. If omitted,
several blank lines separate the listing produced for each
member; a new page starts only when the previous page is full.
KEY= designate the extent of the operation by specifying either:
key is the sign-on key of the individual whose members
are to be searched.
$ALL causes the members associated with all users to be
searched.
search_string Must be bound by delimiters and not exceed 50 characters in
length. A maximum of 200 search strings may be defined in a
single EDIT control statement.
replace_string Must follow ending delimiter or search string, and must be
followed by a delimiter. It must not exceed 50 characters in
length and a maximum of 200 replacement strings may be
defined in a single EDIT control statement.
Note: A maximum of 200 SCAN search strings and EDIT
search/replacement string pairs (in total) may be
specified concurrently.

NOTES:

Additional information about using this control statement:


■ The operands MEMBER= and KEY=$ALL are also mutually exclusive.
■ If the KEY= operand is:
– omitted and no prefix is specified with the member name, the member
is assumed to belong to the user identified in the PARM field or with
the last KEY= control statement.
– specified, the member is assumed to belong to the designated user.
(KEY= is provided for the use of the individual assigned the RO prefix.

4-18 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

See Library Administrator Privileges on page 4-12 for more


information about Library Administrators.)
KEY=$ALL should be used prudently since scanning every member in a
large Advantage CA-Roscoe library can be a very expensive operation.
■ If a member does not contain any of the specified search strings, it does
not appear in the output listing.
■ Every line containing the specified string is included in the output listing.
■ EDIT statements are parsed differently from other LIBSERVE control
statements. They should be coded according to the following guidelines:
1. Each string must be bound by delimiters. The delimiter can be any
special character that does not appear within the string.
2. Any number of strings can be included in a single record as long as
they do not extend beyond column 71. A string cannot be continued; it
must be complete within a single record.
3. The maximum number of string pairs that may be associated with a
single EDIT control statement is 200. (If more than 200 string pairs are
involved, the string should be specified over multiple EDIT control
statements.)
4. If more strings are wanted than will fit on a single record, additional
records may be included. No formal continuation indication is needed.
LIBSERVE determines from the first nonblank character of the next
input record whether it contains more search strings or is the start of
the next control statement.
■ To restrict the edit operation to a specific range of lines, place the starting
and ending line numbers immediately after the trailing delimiter of the
string. If no line range is indicated, all lines of the member(s) are searched.
■ To restrict the edit search operation to specific columns, use the COL
control statement. If no column limits are specified, columns 1 through 80
are searched.

EXAMPLES: The following examples illustrate the use of this control


statement:
1. To EDIT all members saved under the key USER1 for multiple character
strings:
//SYSIN DD 
EDIT ALL,KEY=USER1 /CONTROL-BREAKS/CONTROL-BREAK/
/SUBSCRIPTS/SUBSCRIPT/
/REPORT-CONTROLS/REPORT-CONTROL/
/PAGE-COUNT/PAGE-COUNTS/
2. To EDIT a string in a particular library member, limiting the operation to
lines 1 through 850:
//SYSIN DD 
EDIT MEMBER=US1.CUSTMAST /PAGE-COUNT/PAGE-COUNTS/1,85

Chapter 4. Library Maintenance Program Summaries 4-19


4.3 Library Member Maintenance (LIBSERVE Program)

3. To EDIT a string in a library member, limiting the scan operation to lines 1


through 500 and columns 7 through 72:
//SYSIN DD 
COL 7,72
EDIT MEMBER=US1.INVMAST /INV-FILE/IN-FILE/ 1,5
4. To EDIT all members saved under the key specified in the PARM field for
the string ROSCOE.CONTROL:
//SYSIN DD 
EDIT ALL /ROSCOE.CONTROL/ROSCOE.CONTROL2/
The edit above would produce the following:

KEY: LIBRARY ADMINISTRATOR ROSCOE LIBRARY UTILITY mm/dd/yy hh:mm:ss

EDIT ALL,KEY=$ALL /ROSCOE.CONTROL/

---------- MODULE RO.LIBSERVE ----------


6 // EXEC PGM=LIBSERVE,PARM=('ROSCOE.CONTROL')
// EXEC PGM=LIBSERVE,PARM=('ROSCOE.CONTROL2')

---------- MODULE UPS.KEYTABLE----------


1 AI ROSCOE.CONTROL ROSCOE
AI ROSCOE.CONTROL2 ROSCOE

END OF INPUT. NO ERRORS FOUND

4.3.6 KEY Control Statement


Identifies the sign-on key of the user whose members are to be involved in the
action of subsequent control statements.

SYNTAX

KEY Control Statement


──KEY──┬─$ALL─┬───────────────────────────────────────────────
└─key──┘

$ALL causes the library members belonging to all users to be involved in


subsequent control statement functions.
key is the sign-on key of the user whose members are to be involved in
subsequent control statement functions.

NOTES: Additional information about using this control statement:


■ While any user may use this control statement, it is provided for the use of
the Library Administrator or the owner of the RO prefix (see Library
Administrator Privileges on page 4-12 for more information about Library
Administrators.)

4-20 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

It causes all subsequent LIBRARY, LIST, LISTMON and SCAN control


statements to access the members whose prefix is associated with the
designated sign-on key. This sign-on key remains in effect until:
– Superseded by another KEY control statement, or
– Overridden for the execution of a particular control statement by the
KEY= operand.
■ Syntax for this statement can also be specified with an equal sign (=), for
example:
KEY=$ALL

EXAMPLES: The following examples illustrate the use of this control


statement:
// EXEC PGM=LIBSERVE,PARM=(ROSCOE)
...
//SYSIN DD 
KEY USERID Change key to USERID
LIBRARY Produce library listing for key USERID
LIST ALL,KEY=USER2 List all members stored under key USER2
SCAN ALL 'TAPE' Scan all members stored under key USERID
KEY USERID Change key to USERID

4.3.7 LIBRARY Control Statement


Produces a listing of library member index entries for all members saved
under one or all sign-on keys.

SYNTAX

LIBRARY Control Statement


──LIBRARY──┬────────────────┬─────────────────────────────────
└─KEY=─┬─$ALL─┬──┘
└─key──┘

With no operand, provides library information about all members


owned by the person identified in the PARM field or with the last
KEY control statement.

KEY= designate the extent of the operation by specifying either:


$ALL causes the members associated with all users to be
included in the report.
key is the sign-on key of the individual whose members are
to be included in the report.

Chapter 4. Library Maintenance Program Summaries 4-21


4.3 Library Member Maintenance (LIBSERVE Program)

NOTES: Additional information about using this control statement:


■ If KEY= is specified, the library information pertains to members owned
by the designated user. (KEY= is provided for the use of the individual
assigned the RO prefix.)
■ The listing includes the:
– name of each member,
– description of the member (if one is available),
– date of creation,
– date of last update (if any),
– date of last access (if any),
– number of records in the member,
– sequence number attribute,
– access attribute,
– any special attributes associated with the member (such as created by
ROSDATA, and so on).

EXAMPLES: The following examples illustrate the use of this control


statement:
1. To produce library information about members owned by the user's whose
sign-on key appears in the PARM field:
//SYSIN DD 
LIBRARY
2. To produce library information about members owned by the user
identified within the control statement:
// EXEC PGM=LIBSERVE,PARM=ROSCOE
...
//SYSIN DD 
LIBRARY KEY=JONES
The listing produced would look like the one below.

KEY: LIBRARY ADMINISTRATOR ROSCOE LIBRARY UTILITY 4/13/92 17:45:4 PAGE 1

LIBRARY KEY=ROSCOE

ROS.DBCSDATA DAT: SAMPLE DBCS DATA 8/23/88 6/3/89 3/22/9 9 NSEQ
ROS.DBCSPRT DAT: SAMPLE DBCS PRINT DATA 11/15/88 6/3/89 2/27/9 16 NSEQ
ROS.HELLO 5/28/9 4/13/92 3 NSEQ
ROS.HEXTABLE DAT: TABLE OF HEX CHARS 8/22/87 8/23/87 2/17/92 17 NSEQ ROSD
ROS.I168939 DAT: TEST DATA FOR KANJI PRINT 4/3/88 6/3/89 1/3/9 1 NSEQ
ROS.PRTZAP RPF: USE DCF TO PRT ZAP 9/27/87 9/27/87 1/3/9 16 NSEQ
ROS.SORT RPF: CALL SORT UNDER ETSO 7/9/88 6/3/89 1/3/9 17 NSEQ
ROS.SORTFLDS DAT: SORTFLDS FOR SORT 7/9/88 6/3/89 1/3/9 4 NSEQ
ROS.STEPLIB JCL: STEPLIB CONCATENATION 7/31/88 6/3/89 2/27/9 3 NSEQ
ROS.STICKS DAT: SAMPLE SOURCE MEMBER 9/4/89 3/3/92 69 NSEQ
ROS.TESTPRT DAT: TEST DATA FOR RPSEXIT 1/5/88 6/3/89 2/27/9 12 NSEQ
ROS.ZZZZZLOC 4/6/92 4/6/92 4/6/92 16 NSEQ
ROS.ZZZZZRTM RESPONSE TIME MONITOR LIST 4/7/92 4/9/92 4/9/92 6 73,8
ROS.ZZZZZSTA 4/6/92 4/7/92 4/7/92 3 NSEQ

TOTAL DATA SETS - 14


TOTAL LINES - 192

4-22 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

4.3.8 LIST Control Statement


Lists all or part of one or more library members.

SYNTAX

LIST Control Statement


──LIST──┬─MEMBER=─┬──────┬─mem─┬───────────────────────────────
│ └─pfx.─┘ │
└─ALL──────────────────┘
──┬────────────────────────────────────────────────────┬───────
│ ┌─1──┐ │
└─,──LINES=──┼─num─┼──┬───────┬──┬─────────────────┬─┘
└─ALL─┘ └─,PAGE─┘ └─,KEY=─┬─$ALL─┬──┘
└─key──┘

MEMBER=mem is the name of the member to be listed. The prefix is


optional.

ALL causes all members saved under the prefix of the designated
user to be listed.
LINES= designate the number of lines from each member to be printed.
The default is LINES=10. Specify either:
num is a numeric value between 1 and 9999, inclusive.
ALL causes the entire member to be listed.
PAGE causes each new member to begin on a new page. If omitted,
several blank lines separate the listing of each member; a new
page starts only when the previous page is full.
KEY= designate the extent of the operation by specifying either:
key is the sign-on key of the individual whose members
are to be listed.
$ALL causes the members of all users to be listed.

NOTES: Additional information about using this control statement:


■ The operands MEMBER= and KEY=$ALL are mutually exclusive.
■ If the KEY= operand is:
– omitted and no prefix is specified with the member name, the member
is assumed to belong to the user identified in the PARM field or with
the last KEY= control statement.
– specified, the member is assumed to belong to the designated user.
(KEY= is provided for the use of the Library Administrator or the
owner of the RO prefix. See Library Administrator Privileges on
page 4-12 for more information about Library Administrators.)

Chapter 4. Library Maintenance Program Summaries 4-23


4.3 Library Member Maintenance (LIBSERVE Program)

EXAMPLES: The following examples illustrate the use of this control


statement:
1. To list the first 10 lines of all members saved under the key of the user
executing the program, with a page break after the listing of each member:
//SYSIN DD 
LIST ALL,PAGE
2. To list every line of two members, with a page break between the listings:
//SYSIN DD 
LIST MEMBER=EDITDATA,LINES=ALL,PAGE
LIST MEMBER=UTIPROC,LINES=ALL
3. To list the first 20 lines of a member that belongs to the individual whose
sign-on key is SMITH:
// EXEC PGM=LIBSERVE,PARM=ROSCOE
...
//SYSIN DD 
LIST MEMBER=STICKS,LINES=25,KEY=SMITH
The list would look like the one below.

KEY: LIBRARY ADMINISTRATOR ROSCOE LIBRARY UTILITY mm/dd/yy hh:mm:ss

LIST MEMBER=STICKS,LINES=2,KEY=SMITH

SMT.STICKS DAT: SAMPLE SOURCE MEMBER 9/19/89 1/3/92 69 NSEQ

1 <<STICKS>>
2 PUSH
3 SET MODE BASIC
4 LET P1 = 16
5 WRITE 'PICK UP STICKS. THERE ARE 16 STICKS IN THE PILE.'
6 WRITE 'THE ONE WHO TAKES THE LAST STICK LOSES.'
7 <<WRITE>>
8 WRITE 'YOU MAY REMOVE 1, 2, OR 3 STICKS ON ANY TURN.'
9 WRITE ''
1 WRITE 'YOUR TURN:'
11 <<READ>>
12 : VERIFY USER'S ENTRY IS VALID
13 READ L1
14 IF (L1 LT 1)
15 GOTO <<WRITE>>
16 ELSE
17 IF (L1 GT 3)
18 GOTO <<WRITE>>
19 ELSE
2 IF (CONFORM(L1 'N') NE 1)

4.3.9 LISTMON Control Statement


Lists all or part of one or more library members created by a Monitor
command.

4-24 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

SYNTAX

LISTMON Control Statement


──LISTMON──┬─MEMBER=─┬──────┬─mem─┬────────────────────────────
│ └─pfx.─┘ │
└─ALL──────────────────┘
──┬────────────────────────────────────────────────────┬───────
│ ┌─1──┐ │
└─,──LINES=──┼─num─┼──┬───────┬──┬─────────────────┬─┘
└─ALL─┘ └─,PAGE─┘ └─,KEY=─┬─$ALL─┬──┘
└─key──┘

MEMBER=mem is the name of the member to be listed. The prefix is


optional.

ALL causes all members created by Monitor commands that are


saved under the prefix of the designated user to be listed.
LINES= designate the number of lines from each member to be printed.
The default is LINES=10. Specify either:
num is a numeric value between 1 and 9999, inclusive.
ALL causes the entire member to be listed.
PAGE causes each new member to begin on a new page. If omitted,
several blank lines separate the listing of each member; a new
page starts only when the previous page is full.
KEY= designate the extent of the operation by specifying either:
key is the sign-on key of the individual whose
Monitor-created members are to be listed.
$ALL causes all Monitor-created members associated with
all users to be listed.

NOTES: Additional information about using this control statement:


■ The LIST control statement can be used to list both regular library
members and those members created by Monitor commands.
■ The operands MEMBER= and KEY=$ALL are mutually exclusive.
■ If the KEY= operand is:
– omitted and no prefix is specified with the member name, the member
is assumed to belong to the user identified in the parm field or with
the last KEY= control statement.
– specified, the member is assumed to belong to the designated user.
(KEY= is provided for the use of the Library Administrator or the
owner of the RO prefix. See Library Administrator Privileges on
page 4-12 for more information about Library Administrators.)

Chapter 4. Library Maintenance Program Summaries 4-25


4.3 Library Member Maintenance (LIBSERVE Program)

EXAMPLES: The following examples illustrate the use of this control


statement:
1. To list all of the members created by Monitor commands saved under the
key specified in the PARM field or in a preceding KEY control statement
and to have each listing start a new page:
//SYSIN DD 
LISTMON ALL,PAGE
2. To list only the first 25 lines of the members created by Monitor
commands that are associated with the individual whose sign-on key is
JONES:
//SYSIN DD 
LISTMON ALL,LINES=25,KEY=JONES
3. To list all of the members created by Monitor commands that are
associated with all users:
//SYSIN DD 
LISTMON ALL,KEY=$ALL

4.3.10 PURGE Control Statement


Deletes SAVAWSnn members, most members whose names begin with ZZZZZ
and members added by Monitor commands that have not be accessed within a
specific time period.

SYNTAX

PURGE Control Statement


──PURGE──┬───────────────┬──┬──────────┬──┬───────────┬────────
│ ┌─5───┐ │ └─,LIBRARY─┘ └─,NOSAVAWS─┘
└─AGE=──┴─num─┴─┘
──┬────────┬───────────────────────────────────────────────────
└─,NOMON─┘

AGE=num is the number of days during which a member has not been
accessed. Zero (0) is invalid. The default is 5.

LIBRARY causes a complete listing of the offline file is to be produced.


The listing includes an asterisk by the names of the members
that have been deleted. If omitted, only the names of the
deleted members are listed.
NOSAVAWS excludes SAVAWSnn members from the purge operation.
NOMON excludes member created by Monitor commands from the
purge operation.

4-26 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

NOTES: Additional information about using this control statement:


■ While any user may use this control statement, it is provided for the use of
the owner of the RO prefix.
■ Purge operations may only be performed when:
– Advantage CA-Roscoe is not executing,
– The PURGE option is specified in the EXEC statement, and
– The SYSIN file:
— Contains a single PURGE control statement, or
— Is omitted or specified as DUMMY. When this occurs, the default
is to delete all SAVAWSnn, ZZZZZ... and Monitor-created
members that have been on the library for more than five days. A
listing of each deleted member is printed.

■ If NOSAVAWS and NOMON are both specified, LIBSERVE execution


terminates.
■ PURGE also deletes any member from the library whose name is found to
be invalid, regardless of the operands specified in the control statement.
■ The scope of PURGE is global (that is, all members meeting the criteria are
deleted for all users of the system). If a more selective method of purging
is desired, the facilities provided via the ROSMAILS program should be
used, instead of LIBSERVE.
■ Exceptions:
SAVAWSnn members are not deleted when they are created as the result
of a normal sign-off (that is, a user enters OFF or OFFON and the AWS
contains data). Members named ZZZZZDIR and ZZZZZMSG are not
deleted.

4.3.11 RENAME Control Statement


Changes the name of a library member saved under the prefix of the user
executing the program.

SYNTAX

RENAME Control Statement


┌─,───────────┐
─┬──────┬─mem┴─────────────────────────────────────
──RENAME───
└─pfx.─┘

mem1 is the name of the library member to be renamed. The prefix is


optional.

Chapter 4. Library Maintenance Program Summaries 4-27


4.3 Library Member Maintenance (LIBSERVE Program)

mem2 is the new name for the library member. It must comply with
Advantage CA-Roscoe member naming conventions and cannot
already exist. The prefix is optional.

NOTES:

Additional information about using this control statement:


■ Users may only rename members saved under their own prefix.
■ Advantage CA-Roscoe naming conventions require that a member name be
one to eight characters in length and begin with an alphabetic or national
character. The remainder of the name may be any combination of
alphanumeric and national characters.

EXAMPLES: The following examples illustrate the use of this control


statement:
1. To rename a member named LIBIPROC to ACCLIB:
//SYSIN DD 
RENAME LIBIPROC,ACCLIB

4.3.12 SCALE Control Statement


Specifies whether a Scale Line is to be printed at the top and bottom of each
output page produce through the LIST, LISTMON and SCAN control
statements.

SYNTAX

SCALE Control Statement


┌─ON──┐
──SCALE──┼─────┼──────────────────────────────────────────────
└─OFF─┘

With no operands, equivalent to SCALE ON.


ON causes scale lines to be printed on subsequent pages until a SCALE
OFF control statement is encountered.
OFF prevents scale lines from being printed.

NOTES:

Additional information about using this control statement:


■ The Scale Line begins in the first column of the listing. It can be used to
determine the column positions of data listed by the LIST, LISTMON, or
SCAN control statements.

4-28 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

4.3.13 SCAN Control Statement


Searches one or more members for every occurrence of a specific character
string.

SYNTAX

SCAN
: Control Statement
──SCAN──┬─MEMBER=─┬──────┬─mem─┬──┬───────┬────────────────────
│ └─pfx.─┘ │ └─,PAGE─┘
└─ALL──────────────────┘
──┬─────────────────┬───────────────────────────────────────────
└─,KEY=─┬─$ALL─┬──┘
└─key──┘
┌──
─────────────────────┐
┬───────────────────┬┴──────────────
──/string/─┬───────────┬───
└─start end─┘ └─/string/start end─┘

MEMBER=mem
is the name of the library member to be searched. The prefix is
optional.
ALL causes all members saved under the designated user's sign-on
key to be searched.
PAGE causes each new member to begin on a new page. If omitted,
several blank lines separate the listing produced for each
member; a new page starts only when the previous page is full.
KEY= designate the extent of the operation by specifying either:
key is the sign-on key of the individual whose members
are to be searched.
$ALL causes the members associated with all users to be
searched.
string is the search string. It must be bound by delimiters and not
exceed 50 characters in length. A maximum of 100 search
strings may be defined in a single SCAN control statement.
start,end is the number of the line at which the scan operation is to
begin and end.

NOTES: Additional information about using this control statement:


■ The operands MEMBER= and KEY=$ALL are also mutually exclusive.
■ If the KEY= operand is:
– omitted and no prefix is specified with the member name, the member
is assumed to belong to the user identified in the PARM field or with
the last KEY= control statement.

Chapter 4. Library Maintenance Program Summaries 4-29


4.3 Library Member Maintenance (LIBSERVE Program)

– specified, the member is assumed to belong to the designated user.


(KEY= is provided for the use of the Library Administrator or the
owner of the RO prefix. See Library Administrator Privileges on
page 4-12 for more information about Library Administrators.)
KEY=$ALL should be used prudently since scanning every member in a
large Advantage CA-Roscoe library can be a very expensive operation.
■ If a member does not contain any of the specified search strings, it does
not appear in the output listing.
■ Every line containing the specified string is included in the output listing.
■ SCAN statements are parsed differently from other LIBSERVE control
statements. They should be coded according to the following guidelines:
1. Each string must be bound by delimiters. The delimiter can be any
special character that does not appear within the string.
2. Any number of strings can be included in a single record as long as
they do not extend beyond column 71. A string cannot be continued; it
must be complete within a single record.
3. The maximum number of strings that may be associated with a single
SCAN control statement is 100. (If more than 100 strings are involved,
the string should be specified over multiple SCAN control statements.)
4. If more strings are wanted than will fit on a single record, additional
records may be included. No formal continuation indication is needed.
LIBSERVE determines from the first nonblank character of the next
input record whether it contains more search strings or is the start of
the next control statement.
■ To restrict the scan operation to a specific range of lines, place the starting
and ending line numbers immediately after the trailing delimiter of the
string. If no line range is indicated, all lines of the member(s) are scanned.
■ To restrict the scan operation to specific columns, use the COL control
statement. If no column limits are specified, columns 1 through 80 are
scanned.

EXAMPLES: The following examples illustrate the use of this control


statement:
1. To scan all members saved under the key USER1 for multiple character
strings:
//SYSIN DD 
SCAN ALL,KEY=USER1 /CONTROL-BREAKS/ /SUBSCRIPTS/
/REPORT-CONTROLS/ /PAGE-COUNT/
2. To scan for a string in a particular library member, limiting the scan
operation to lines 1 through 850:
//SYSIN DD 
SCAN MEMBER=CUSTMAST /PAGE-COUNT/ 1,85

4-30 Programs and Utilities Guide


4.3 Library Member Maintenance (LIBSERVE Program)

3. To scan for a string in a library member, limiting the scan operation to


lines 1 through 500 and columns 7 through 72:
//SYSIN DD 
COL 7,72
SCAN MEMBER=INVMAST /INV-FILE/ 1,5
4. To scan all members saved under the key specified in the PARM field for
the string ROSCOE.CONTROL:
//SYSIN DD 
SCAN ALL /ROSCOE.CONTROL/
The scan above would produce the following:

KEY: LIBRARY ADMINISTRATOR ROSCOE LIBRARY UTILITY mm/dd/yy hh:mm:ss

SCAN ALL,KEY=$ALL /ROSCOE.CONTROL/

---------- MODULE RO.LIBSERVE ----------


6 // EXEC PGM=LIBSERVE,PARM=('ROSCOE.CONTROL')

---------- MODULE UPS.KEYTABLE----------


1 AI ROSCOE.CONTROL2 ROSCOE
6 RO ROSCOE.CONTROL ROSCOE

END OF INPUT. NO ERRORS FOUND

4.3.13.1 DD Statements

The following DD statements are required:


ROSLIBnn identifies the user library system. Include one DD statement for
each file in the user library system.
If the PURGE option is used, specify DISP=OLD; otherwise,
specify DISP=SHR.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.ROSCOE.ROSLIB).
SYSIN identifies an input file containing the SYSIN control statements.
The defaults are: DSORG=PS, RECFM=FB, LRECL=80 and
BLKSIZE=80. If a block size is specified, it must be a multiple
of 80. If it is not specified, a default of 80 is used.
If the PURGE option is specified, this file may be omitted or
specified as DUMMY.
SYSPRINT identifies an output file that is to contain the listings produced
by LIBSERVE. The defaults are DSORG=PS, RECFM=FBM,
LRECL=133 and BLKSIZE=931. If a block size is specified, it
must be a multiple of 133.

Chapter 4. Library Maintenance Program Summaries 4-31


4.3 Library Member Maintenance (LIBSERVE Program)

4.3.14 Return Codes


LIBSERVE returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors were found in the SYSIN control statement.
These might include invalid library member names, syntax
errors, and so forth.
The control statement containing the error is ignored; execution
continues with the next SYSIN statement.
8 An error was found in the parameters passed in the PARM field
or in the JCL used to execute the program. Such errors might
include an invalid key in the PARM field, incorrect definition of
the Advantage CA-Roscoe library, missing DD statements, and
so forth.
Execution terminates. Messages are written to the SYSPRINT
data set. (If SYSPRINT is not open at the time of the error, the
message is written to the job log by a WTO macro.)

4.3.14.1 Sample JCL

Default sample JCL to execute program LIBSERVE is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4-32 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4 Library Management (LIBUTIL Program)


The LIBUTIL program can be used to create and maintain the Advantage
CA-Roscoe user library system. Specifically, LIBUTIL can be used to:
■ Add data files to the user library system.
■ Alter the type of RESERVE issued by Advantage CA-Roscoe for the library
system.
■ Backup the entire user library system.
■ Backup all members for one or more sign-on keys.
■ Format the Advantage CA-Roscoe user libraries.
■ List the names and, optionally, attributes of the library members on a
backup file.
■ Reclaim unused (that is, dead) blocks in the user library data files.
■ Restore the entire user library from a backup file.
■ Restore all members from a backup file to a specific sign-on key.
■ Restore all members from a backup file for a specific sign-on key.
■ Restore all members from a backup file to a specific user prefix.
■ Restore specific members from a backup file.

Each of these function is controlled by option(s) specified in the PARM field of


the EXEC statement.

Caution

If your site is concerned about security of library data, a BEXEXIT exit


routine can be coded for that purpose. The BEXEXIT is incorporated within
LIBUTIL and can be used to provide necessary site security checks.
(BEXEXIT is described in the Advantage CA-Roscoe Interactive Environment
Extended Facilities for System Programmers Guide.

LIBUTIL is different from other batch utilities which can use the BEXEXIT,
because the PARM field is not used to obtain the USERID. Instead, the
USERID from the ACEE of the job is used.

Chapter 4. Library Maintenance Program Summaries 4-33


4.4 Library Management (LIBUTIL Program)

4.4.1 Add User Library


This section describes how to add a data file to the library system. The new
data file is formatted and the index file (ROSLIB00) is modified accordingly.

This option is useful when a site wants to increase user library space without
having to do a complete backup, reallocation and restore. With ADDLIB, the
new data file can be formatted while Advantage CA-Roscoe is executing. To
use the new file, add the appropriate ROSLIBnn DD statement to the
Advantage CA-Roscoe JCL the next time Advantage CA-Roscoe is started.

4.4.2 Program Requirements


The add-a-file function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
ADDLIB Required.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
ROSLIBnn identifies the user library system. Include one DD
statement for each file (new and existing) in the user library
system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics.

4.4.3 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4-34 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.3.1 Sample JCL

Default sample JCL to execute program LIBUTIL to add user libraries is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.4 Alter Reserve


This section describes how to alter the type of RESERVE issued by Advantage
CA-Roscoe for the library system.
Note: If your site is executing a single Advantage CA-Roscoe, you need not
be concerned about this LIBUTIL function. This function only applies to
sites executing multiple Advantage CA-Roscoes.
Prior to Release 5.7, sites running multiple Advantage CA-Roscoes on the same
CPU where each Advantage CA-Roscoe has its own library system
occasionally encountered library contention problems due to the way
Advantage CA-Roscoe issued the RESERVE for the library system.

While enhancements to Advantage CA-Roscoe 5.7 eliminated these problems,


the current and prior RESERVE techniques are not compatible. Therefore, use
the chart in Table 4-1 to determine whether your library system(s) need to be
converted.

Table 4-1. Advantage CA-Roscoe Library Conversion


Multiple Releases Shared Libraries Nonshared Libraries
All at same release Can all be either VERSION1 Can all be either VERSION1
or VERSION2 or VERSION2 VERSION2 is
VERSION2 is recommended.
recommended.
At different releases Pre-5.7: Must all be Pre-5.7: Must all be
VERSION1 5.7 and later: VERSION1 5.7 and later: Can
Can be either VERSION1 or be either VERSION1 or
VERSION2; VERSION2 is VERSION2; VERSION2 is
recommended. recommended.

When Release 5.7 becomes the lowest level release, use this function to convert
the library system to VERSION2.
Note: No other programs affecting the Advantage CA-Roscoe library system
should be running when this function is executed.

Chapter 4. Library Maintenance Program Summaries 4-35


4.4 Library Management (LIBUTIL Program)

4.4.5 Program Requirements


This function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
ALTVERSN required.
VERSION1 designates that the library system is to be converted to use
the pre-Release 5.7 RESERVE technique.
VERSION2 designates that the library system is to be converted to use
the 'new' technique.
Either VERSION1 or VERSION2 must be specified.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system. Specify
DISP=OLD to ensure that no other jobs can access the
library system during this execution of LIBUTIL.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics.

4.4.6 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4-36 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.6.1 Sample JCL

Default sample JCL to execute program LIBUTIL to convert to the RESERVE


technique is included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.7 Backup User Libraries


This section describes how to backup the contents of the entire library system
to a tape or disk backup file.
Note: Library members with incorrectly formatted names are not backed up.

4.4.8 Program Requirements


The backup function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
BACKUP required.
NOLIST optional. It suppresses the listing of backed-up library
member names. Specify as: PARM='BACKUP,NOLIST'.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
BACKUP identifies a sequential output file that is to hold the backup
data. Either a tape or disk file may be used. No DCB
parameters are required. You may specify a block size to
override the default of 16K.
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system. Each file
must have a disposition of OLD.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is contain messages and
diagnostics. The names of the backed up members are
excluded if the NOLIST option is specified.
SYSIN identifies an input file containing one or more SYSIN
control statements.

Chapter 4. Library Maintenance Program Summaries 4-37


4.4 Library Management (LIBUTIL Program)

The optional DD statement is:


RPFRPT identifies an output file that is contain a report identifying
each library member containing lines ending with a
hyphen. The lines are identified by number and content.

4.4.9 Return Codes


The backup function of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

If a read error on a data block occurs, the block is ignored and processing
continues; a message identifying the user library member in which the I/O
error occurred is written to SYSPRINT. The library member in which the error
occurred will be incomplete on the backup file.

If a read error on an index block occurs, no further processing is possible and


the program abends. The library system must be restored from the most recent
backup tape.

4.4.9.1 Sample JCL

Default sample JCL to execute program LIBUTIL to do a full library backup is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.10 Backup User Key


This section describes how to backup all members belonging to one or more
specific Advantage CA-Roscoe sign-on key(s).

4.4.11 Program Requirements


The backup-by-key function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
BKUPKEY required.

4-38 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

NOLIST optional. It suppresses the listing of backed-up library


member names. Specify as: PARM='BKUPKEY,NOLIST'.
■ SYSIN Control Statements
The SYSIN control statement is:
KEY=key
where key is the sign-on key assigned to the individual whose members
are to be backed up.
One control statement must be specified for each user whose members are
to be backed up. Each control statement must begin in the first position of
the line and contain valid Advantage CA-Roscoe sign-on key.
■ DD Statements
The required DD statements are:
BACKUP identifies a sequential output file that is to hold the backup
data. Either a tape or disk file may be used. No DCB
parameters are required. You may specify a block size to
override the default of 16K.
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies the output file that is to contain messages and
diagnostics. The names of the members backed up are
excluded if the NOLIST option is specified.
SYSIN identifies an input file containing one or more SYSIN
control statements.

4.4.12 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

Chapter 4. Library Maintenance Program Summaries 4-39


4.4 Library Management (LIBUTIL Program)

4.4.12.1 Sample JCL

Default sample JCL to execute program LIBUTIL to do backup by key is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.13 Format User Libraries


This section describes how to initialize the user library files that are to be used
in the system. This is normally done when:
■ Advantage CA-Roscoe is first installed at a site and the files do not exist,
or
■ The physical extents or DCB attributes of the library system have to be
changed.

If the allocation for the library files was performed by an earlier step (for
example, using IEFBR14), LIBUTIL examines the DSCB to validate block size,
space and other variables. If the allocation has not been performed, LIBUTIL
examines the DD statement for this information.

4.4.14 Program Requirements


The formatting function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
FORMAT required.
VERSIONn optional. Indicates the type of RESERVE that Advantage
CA-Roscoe is to issue for the library system. If omitted, the
default is VERSION2. (See page 4-35 for additional
information.)
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
ROSLIBnn identifies the user library system. Include one DD
statement for each file comprising the user library system.
SYSPRINT identifies an output file that is to contain messages and
diagnostics.

4-40 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.15 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.4.15.1 Sample JCL

Default sample JCL to execute program LIBUTIL to format user libraries is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.16 List Backup File


This section describes how to list the contents of a backup file.

4.4.17 Program Requirements


The list backup file function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain either:
BKUPSUM lists the names of the library members on the backup file.
Note: BKUPSUM and BKUPLIST are mutually exclusive.
BKUPLIST lists the names and attributes of the library members on the
backup file.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
BACKUP identifies the input file defining the backup file being used.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies the output file that is to contain the list of
member names.

Chapter 4. Library Maintenance Program Summaries 4-41


4.4 Library Management (LIBUTIL Program)

SYSPUNCH identifies the output file that is to contain the member


name, data set name, volume serial number and creation
data of the backup file.

4.4.18 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.4.18.1 Sample JCL

Default sample JCL to execute program LIBUTIL to list backup file contents is
included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.19 Reclaim Unused Blocks


This section describes how to reclaim the unused (that is, dead) blocks in the
user library data files.

Dead blocks are automatically reclaimed whenever the library system is


restored from a backup file. The RECLAIM function allows sites to reclaim
these blocks at any time (that is, without doing a RESTORE run).

To obtain information about dead blocks, sites can either execute:


■ ROSTAT - to obtain the number of dead blocks.
■ LIBUTIL with 'RECLAIM,SIMULATE' - to obtain the number and
condition of the dead blocks.

Caution

When this function is executed, a RESERVE is issued to prevent any other


Advantage CA-Roscoe or batch program from accessing the user library.
Thus, you should ensure that there is no other activity that might affect the
Advantage CA-Roscoe user library while this function is executing.

In order to perform a reclaim operation, LIBUTIL must be executed from an


authorized load library.

4-42 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.20 Program Requirements


The reclaim function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
RECLAIM required.
SIMULATE optional. It causes the reclaim operation to be simulated
(that is, not actually performed). Statistical information is
written to the SYSPRINT file.
NOSNAP optional. It prevents a snap (dump) of invalid data blocks
to be written to the SNAP file.
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
ROSLIBnn identifies the user library system. Include one DD
statement for each file (new and existing) comprising the
user library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics.
SNAP identifies an output file that is to contain information about
invalid data blocks found during the RECLAIM operation.
This DD statement is required if the NOSNAP option is
omitted.

4.4.21 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

Chapter 4. Library Maintenance Program Summaries 4-43


4.4 Library Management (LIBUTIL Program)

4.4.21.1 Sample JCL

Default sample JCL to execute program LIBUTIL to reclaim unused blocks is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.22 Restore User Libraries


Normally, the most recent backup should be used when restoring the libraries.
One way to avoid errors in selecting the correct backup file is to use a
generation data set group (GDG). The GDG should be set up so that selection
of the correct backup file can be automatically determined by the generation
index. A cycle of no less than five (5) generation members should be used.

To ensure that the correct backup file is being used, LIBUTIL issues a message
to the operator at the start of the run. The message gives the backup file's
creation date and time. The message has a descriptor code of 2 so that it
cannot be deleted from the operator's console except by operator intervention.

It is possible for a restore run to fail because there is no space left in the index
file. This can occur even when the same space allocation prior to the restore
run was sufficient to handle the same number of library members. The
situation occurs because the space needed to hold a given number of library
members depends on the order in which the members are added, with a
restore run representing a worst case. The general rule is that the number of
library members to be restored must be less than one half of the maximum
index capacity. This latter count can be obtained from the ROSTAT report (see
the description of the ROSTAT program).

4-44 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.23 Program Requirements


The library restore function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
RESTORE required.
NOCLEAR optional. It prevents initialization of the libraries.
(PARM='RESTORE,NOCLEAR'.)
When NOCLEAR is specified, anything already in the
library system remains there. The members from the
backup file are simply added to the members already in the
libraries.
Use NOCLEAR when merging several libraries into a single
library. For example, use NOCLEAR if you are.
– restoring the library system from a series of
partial/delta backup files produced by the LIBBKUP
program.
– consolidating libraries (for example, if Advantage
CA-Roscoe is running at two sites and a site wishes to
consolidate the libraries).
If a member on the backup file also exists in the library, the
version from the backup file replaces the one already in the
library.
If NOCLEAR is omitted, the restored members are evenly
distributed between the Advantage CA-Roscoe library data
files. Performance of the RESTORE operation is
significantly improved if NOCLEAR is not specified.
Note: NOCLEAR and NOFORMAT are mutually
exclusive.
NOFORMAT optional. It can be used to bypass formatting the library
system. (PARM='RESTORE,NOFORMAT'.)
The formatting portion of the restore may be omitted when
the contents of the backup file are to be restored onto the
original disk libraries (that is, the ROSLIBnn files have not
been reallocated and are still present in the original
extents).
NOFORMAT always reinitializes the index file ROSLIB00.
If NOFORMAT is specified and the control blocks on
ROSLIB00 are invalid, execution fails. If this occurs, remove
the NOFORMAT option from the PARM field and resubmit
the job.

Chapter 4. Library Maintenance Program Summaries 4-45


4.4 Library Management (LIBUTIL Program)

NOLIST optional. It suppresses the listing of restored library


member names. (PARM='RESTORE,NOLIST'.)
NOREPLACE optional. It prevents a library member that is being restored
from overlaying the contents of an existing library member
with the same name.
Note: The NOCLEAR option must be specified when
NOREPLACE is used. If NOCLEAR is omitted,
NOREPLACE is ignored.
VERSIONn optional. It indicates the type of RESERVE that Advantage
CA-Roscoe is to issue for the library system. If omitted and:
– NOFORMAT is specified - the type of RESERVE
currently in effect is assumed.
– NOFORMAT is omitted - the default is VERSION2.
(See page 4-35 for additional information.)
■ SYSIN Control Statements
There are no SYSIN control statements.
■ DD Statements
The required DD statements are:
BACKUP identifies an input file that defines the backup file being
used.
ROSLIBnn identifies the user library system. Include one DD
statement for each file comprising the user library system.
Each file must have a disposition of OLD.
The DD statements need not be the same as for the original
format run (or prior restore run). The number of files, space
allocations, block size, and so on, for this run are totally
independent of earlier library configurations. The backup
file is essentially configuration-independent, and restores
into any valid configuration specified through the DD
statements in the restore run.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics. The names of the restored library members are
included if the NOLIST option is omitted.

4-46 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.24 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

If a read error on the backup file occurs, the library member containing the
I/O error is dropped in its entirety and an attempt is made to skip to valid
data for the next member. Appropriate error messages are issued describing
what has occurred. You can then attempt to restore the bad members from an
earlier backup file using the selective restore (SELREST) option.

4.4.24.1 Sample JCL

Default sample JCL to execute program LIBUTIL to restore all library members
is included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.25 Restore Members by User Key


This section describes how to restore all members belonging to a specific
Advantage CA-Roscoe sign-on key.

4.4.26 Program Requirements


The restore member function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
SELKEY required.
NOLIST optional. It suppresses the listing of restored library
member names. (PARM='SELKEY,NOLIST'.)
NOREPLACE optional. It prevents a library member that is being restored
from overlaying the contents of of an existing member with
the same name.
If NOREPLACE is omitted and the user receiving the
library member(s) has a member whose name matches a
member name on the backup file, the member from the
backup file replaces the existing member.

Chapter 4. Library Maintenance Program Summaries 4-47


4.4 Library Management (LIBUTIL Program)

■ SYSIN Control Statements


The SYSIN control statement is:
KEY=key
where key is the sign-on key assigned to the individual whose members
are to be restored.
One control statement must be specified for each user whose members are
to be restored. Each control statement must begin in the first position of
the line and contain valid Advantage CA-Roscoe sign-on key.
Notes:
– To restore all members from the backup file:
— For a specific user and assign them to a different user - use the
SELPFX option.
— To one key - use the RESTKEY option.
– To restore specific members, use the SELREST option.
– If the backup file contains a full library backup, only those members
belonging to the designated sign-on key(s) are restored.
– Since the control statements need not be specified in ascending order,
LIBUTIL performs an internal sort. Therefore, the number of control
statements that may be specified is determined by the available main
storage.
■ DD Statements
The required DD statements are:
BACKUP identifies an input file that defines the backup file being
used.
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics. The names of the restored library members are
excluded if NOLIST is specified.
SYSIN identifies an input file containing one or more SYSIN
control statements.

4-48 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.27 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.4.27.1 Sample JCL

Default sample JCL to execute program LIBUTIL to restore by user key is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.28 Restore Members to User Key


This section describes how to restore all members on the backup file to the
designated sign-on key.

Caution
Before using the RESTKEY option, determine what backup file is to be
used. (Does the file contain a full, partial or selected backup?) Regardless of
how the backup file was produced, its entire contents is restored to the user
identified by the OUTKEY= SYSIN control statement.

4.4.29 Program Requirements


The restore-to-key function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
RESTKEY required.
NOLIST optional. It suppresses the listing of restored library
member names. (PARM='RESTKEY,NOLIST'.)
NOREPLACE optional. It prevents a library member that is being restored
from overlaying the contents of an existing member with
the same name.
If NOREPLACE is omitted and the user receiving the
member(s) has a member whose name matches a member

Chapter 4. Library Maintenance Program Summaries 4-49


4.4 Library Management (LIBUTIL Program)

name on the backup file, the member from the backup file
is restored.
If the backup file consists of the members associated with
multiple sign-on keys and each key has a member with the
same name (for example, SAVAWS01):
– If the NOREPLACE option is specified, either:
— No replacement occurs if the member name already
exists, or
— The first occurrence of the member is restored if the
member name does not currently exist.
– If NOREPLACE is omitted, the last occurrence of the
member is always restored.
■ SYSIN Control Statements
The SYSIN control statement is:
INKEY=*,OUTKEY=key
where key is the sign-on key assigned to the individual who is to receive
ALL of the library members from the backup file.
Only one control statement is processed per execution. It must begin in the
first position of the line and contain a valid Advantage CA-Roscoe sign-on
key.
Notes:
– To restore all members from the backup file:
— For a specific user - use the SELKEY or SELPFX option.
— For a specific user and assign them to another user - use the
SELPFX option.
– To restore specific members - use the SELREST option.
■ DD Statements
The required DD statements are:
BACKUP identifies an input file that defines the backup file being
used.
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics. The names of the restored library members are
excluded if the NOLIST option is specified.

4-50 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

SYSIN identifies an input file containing one or more SYSIN


control statements.

4.4.30 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.4.30.1 Sample JCL

Default sample JCL to execute program LIBUTIL to restore to a user key is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.31 Restore Members by User Prefix


This section describes how to restore all members belonging to one or more
specific Advantage CA-Roscoe prefix(es).

4.4.32 Program Requirements


The selective prefix restore function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
SELPFX required.
NOLIST optional. It suppresses the listing of restored library
member names. (PARM='SELPFX,NOLIST'.)
NOREPLACE optional. It prevents a library member that is being restored
from overlaying the contents of an existing member with
the same name.
If NOREPLACE is omitted and the user receiving the
member(s) has a member whose name matches the member
name on the backup file, the member from the backup file
is restored.
■ SYSIN Control Statements
The SYSIN control statement is:

Chapter 4. Library Maintenance Program Summaries 4-51


4.4 Library Management (LIBUTIL Program)

IN=in-prefix,OUT=out-prefix
where in-prefix is the user's prefix associated with the members when they
were backed up, and out-prefix they were backed up and 'out-prefix' is the
prefix of is the prefix of the user who is to receive the members.
One control statement must be specified for each user whose members are
to be restored. Each control statement must begin in the first position of
the line and contain valid Advantage CA-Roscoe prefixes.
Notes:
– To restore all members from the backup file:
— For a specific user - use the SELKEY option.
— To one key - use the RESTKEY option.
– To restore specific members, use the SELREST option.
– If a prefix not previously owned is used as the out-prefix, its members
exist as unowned by any key. To define a key for the prefix used in
out-prefix, use UPSMNTnn.
– If the backup file was created by BACKUP (that is, backing up the
entire library), only those members belonging to the prefix identified
by IN= are restored.
– Since the control statements need not be specified in ascending order,
LIBUTIL performs an internal sort. Therefore, the number of control
statements that may be specified is determined by the available main
storage.
■ DD Statements
The required DD statements are:
BACKUP identifies an input file that defines the backup file being
used.
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics. The names of the restored library members are
excluded in the NOLIST option is specified.
SYSIN identifies an input file containing one or more SYSIN
control statements.

4-52 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.33 Return Codes


This option of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

4.4.33.1 Sample JCL

Default sample JCL to execute program LIBUTIL to restore by user prefix is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4.4.34 Restore Specific Members


This section describes how to restore one or more library members from a
backup file and place them on the user libraries.

4.4.35 Program Requirements


The selective member restore function of LIBUTIL requires:
■ PARM Field Options
The PARM field of the EXEC statement must contain:
SELREST required.
NOLIST optional. It suppresses the listing of restored library
member names. (PARM='SELREST,NOLIST'.)
NOREPLACE optional. It prevents a library member that is being restored
from overlaying the contents of an existing member with
the same name.
If NOREPLACE is omitted and the user receiving the
member(s) has a member whose name matches a member
name on the backup file, the member from the backup file
is restored.
If the member(s) being restored are also being renamed (for
example, pfx.OLDNAME,pfx.NEWNAME), then the new
name must not exist in the user's library for the restore to
complete successfully when NOREPLACE is specified.
NOCONS optional. It suppresses the WTO message.

Chapter 4. Library Maintenance Program Summaries 4-53


4.4 Library Management (LIBUTIL Program)

■ SYSIN Control Statements


The SYSIN control statement is:

┌─,─────┐
pfx.mem┴───────────────────────────────────────────────
───

where pfx.mem1 is the prefixed name of the library member to be restored.


Optionally, use pfx.mem2 to change the name of that member.
One SYSIN control statement must be specified for each member to be
restored. The member name must begin in the first position of the line and
include the appropriate prefix. The names may be specified in any order.
Notes:
– A library member name may only be specified once per execution. To
restore the same member to the library of multiple users, separate
executions of this function are required.
– To restore all members from the backup file:
— For a specific user - use the SELKEY or SELPFX option.
— For a specific user and assign them to another user - use the
SELPFX option.
— To one key - use the RESTKEY option.
– Since the control statements need not be specified in ascending order,
LIBUTIL performs an internal sort. Therefore, the number of control
statements that may be specified is determined by the available main
storage.
■ DD Statements
The required DD statements are:
BACKUP identifies an input file that defines the backup file being
used.
ROSLIBnn identifies the user library system. Include one DD
statement for each file in the user library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies an output file that is to contain messages and
diagnostics. The names of the restored library members are
excluded if the NOLIST option is specified.
SYSIN identifies the input file containing one or more SYSIN
control statements.

4-54 Programs and Utilities Guide


4.4 Library Management (LIBUTIL Program)

4.4.36 Return Codes


The selective restore function of LIBUTIL returns the following codes:

Code Meaning
0 Successful execution. A message to that effect is written to the
SYSPRINT file.
4 One or more errors occurred. A message describing the error(s)
is written to the SYSPRINT file.

If a library member cannot be found on the backup file, an appropriate


message is written to SYSPRINT.

4.4.36.1 Sample JCL

Default sample JCL to execute program LIBUTIL to restore specific members is


included in your installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

Chapter 4. Library Maintenance Program Summaries 4-55


4.5 Copy Member(s) to a Data Set (ROSCOPY Program)

4.5 Copy Member(s) to a Data Set (ROSCOPY Program)


The ROSCOPY program can be used to copy one or more Advantage
CA-Roscoe library members to a data set. ROSCOPY allows you to:
■ Copy one or more library members to a sequential data set or to a member
of a partitioned data set.
■ Include supplementary input data in the SYSIN data set.
■ Specify when and where line numbers are to appear in the OS data set.
■ List the output data set.

4.5.1 Program Requirements


This section describes the EXEC statement parameters, SYSIN control
statements and DD statements used by ROSCOPY.

4.5.1.1 PARM Field Options

The ROSCOPY program uses the following PARM field option:


key is the one- to 22-character Advantage CA-Roscoe sign-on key of the
user executing the program. If it is missing or invalid, execution
terminates.

4.5.1.2 SYSIN Control Statements

ROSCOPY uses the following control statements:


COPY sets the options to be used in creating, updating, or adding to a
data set.
MEMBER identifies the Advantage CA-Roscoe library member(s) to be used
as input in creating, updating or adding to a data set.
-FRONT causes supplementary data in the SYSIN file to be placed before
the library member data in a data set.
-END causes supplementary data in the SYSIN file to be placed after the
library member data in a data set.

ROSCOPY control statements should be coded according to the following


guidelines:
■ The COPY statement must be the first record in the SYSIN file.
■ Only one COPY and one MEMBER statement may be coded per execution
of ROSCOPY.
■ The COPY and MEMBER control statements should not begin in column 1.
■ -FRONT and -END control statements must begin in column 1 and should
follow the COPY and MEMBER statements.

4-56 Programs and Utilities Guide


4.5 Copy Member(s) to a Data Set (ROSCOPY Program)

■ Control statements may be coded up to column 71 (data after column 71 is


ignored).
■ Each operand must be complete within a SYSIN record.
■ Continuations are indicated by placing a comma after the last operand on
the record. The continuation must begin in column 16 of the following
record. There is no limit to how many continuation records may be used.

4.5.2 COPY Control Statement


Sets the options to be used in creating, or adding to, a data set.

SYNTAX

COPY Control Statement


──COPY──MAXNAME=num──┬────────────────────────┬────────────────
└─,RENUMBER=(start,incr)─┘
──┬────────────────────┬──┬────────┬───────────────────────────
└─,FIELD=(start,len)─┘ └─,NOSEQ─┘

MAXNAME=num
is the number of library member names specified through
the MEMBER control statement.
RENUMBER= designates that the members being copied are to be
renumbered and specifies:
start is the starting sequence number.
incr is the increment value.
start and incr may be a maximum of six digits each, but
should not cause a sequence number greater than 999999 to
be generated.
FIELD= designated the location of the sequence number field and
identifies:
start is the starting column of the sequence number
field
len is the length of field, which must be two to eight
characters in length.
If data appears in the area designated as the sequence
number field, the operation is not performed.
NOSEQ prohibits sequence numbers from being inserted.

NOTES: Additional information about using this control statement:


■ The COPY control statement is required. It must be the first control
statement in the SYSIN data set.

Chapter 4. Library Maintenance Program Summaries 4-57


4.5 Copy Member(s) to a Data Set (ROSCOPY Program)

■ The operands of the COPY statement may be coded in any order.


■ NOSEQ is mutually exclusive with RENUMBER= and FIELD=.
If neither NOSEQ nor FIELD= is specified, the member's current sequence
numbers are placed in columns 73 through 80 of the SYSOUT data.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To specify that six members are to be copied from the Advantage
CA-Roscoe library; that they should be renumbered sequentially from one
by one; and that the new sequence numbers should be inserted in columns
1 through six of the SYSOUT data:
//SYSIN DD 
COPY MAXNAME=6,RENUMBER=(1,1),FIELD=(1,6)
■ To specify that one member is to be copied from the Advantage
CA-Roscoe library, without any sequence numbers being inserted in the
SYSOUT data:
//SYSIN DD 
COPY MAXNAME=1,NOSEQ

4.5.3 MEMBER Control Statement


Identifies the Advantage CA-Roscoe library member(s) that are to be used as
input in creating, updating or adding to a data set.

SYNTAX

MEMBER Control Statement


┌─,──────────┐
┬──────────┬┴──)────────────────
──MEMBER──NAME=──(──pfx.mem───
└─,pfx.mem─┘

NAME=mem is the prefixed name(s) of the library member(s) to be used as


input. The names must be enclosed in parentheses, even if
there is only one name.

NOTES: Additional information about using this control statement:


■ Only one MEMBER statement may be specified per execution of
ROSCOPY.
■ Library members that are saved under another user's prefix may be used
as input if they have the SHARED access attribute.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To identify a single library member as input to ROSCOPY:

4-58 Programs and Utilities Guide


4.5 Copy Member(s) to a Data Set (ROSCOPY Program)

MEMBER NAME=(WEN.TESTDATA)
■ To identify three members as input to ROSCOPY:
MEMBER NAME=(WEN.COBJCL,SLP.INVREPT,WEN.LKED)

4.5.4 -FRONT Control Statement


Causes supplementary input data in the SYSIN file to be placed before library
member data.

SYNTAX

-FRONT Control Statement


──-FRONT──(no operands)───────────────────────────────────────

NOTES: Additional information about using this control statement:


■ -FRONT must begin in column 1.
■ If RENUMBER= or FIELD= are specified in the COPY control statement,
the supplementary data is renumbered.
■ Records following a -FRONT control statement that have a hyphen (-) in
column 1 but are not -FRONT or -END control statements are treated as
data records by ROSCOPY and are written to the SYSOUT data set exactly
as they appear in the SYSIN data set.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To include a series of JCL statements before library member data in the
data set being written to:
-FRONT
//INVSREPT JOB 515,CORP.GREGG,CLASS=X
//STEP1 EXEC COBC,PARM='NOCLIST'
//COB.SYSIN DD 

4.5.5 -END Control Statement


Causes supplementary input data in the SYSIN file to be placed after library
member data.

SYNTAX

-END Control Statement


──-END──(no operands)─────────────────────────────────────────

Chapter 4. Library Maintenance Program Summaries 4-59


4.5 Copy Member(s) to a Data Set (ROSCOPY Program)

NOTES: Additional information about using this control statement:


■ -END must begin in column 1.
■ If RENUMBER= or FIELD= are specified in the COPY control statement,
the supplementary data is renumbered.
■ Records following a -END control statement that have a hyphen in
column 1 but are not -FRONT or -END control statements are treated as
data records by ROSCOPY and are written to the SYSOUT data set exactly
as they appear in the SYSIN data set.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To include a series of test data records after the library member data in the
OS data set being written to:
-END
569569JOHN JENSSEN 45CORPORATEX415
56957HAROLD SMITH 32CORPORATEX4121
569571SUSAN HARRON 51CORPORATEX4136

4.5.5.1 DD Statements

The following DD statements are required:

ROSLIBnn identifies the user library system. One DD statement must be


included for each file comprising the library. The disposition
must be SHR.
STEPLIB identifiies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSIN identifies the input file containing the ROSCOPY control
statements and, optionally, inline data that is to be included in
the data set.
The LRECL for this file is 80. If a block size is specified, it
must be a multiple of 80. If it is omitted, the default is 80.

4-60 Programs and Utilities Guide


4.5 Copy Member(s) to a Data Set (ROSCOPY Program)

SYSOUT identifies an output file that defines the data set being created,
updated or added to by ROSCOPY. It may be a sequential
data set or a member of a PDS.
The RECFM for this file may be F, FB, V, VB, FA, or FBA
The LRECL of fixed-length data sets must be between one and
255. If it is smaller than the actual number of characters in
the library member records, the member records are truncated.
The block size for variable-length data sets must be at least
263. If no block size is specified, the following default DCB
parameters are used: DSORG=PS, RECFM=F, LRECL=80, and
BLKSIZE=80. If a block size is specified, no defaults are used.
SYSPRINT identifies an output file that is to contain the ROSCOPY
control statements and error messages, if any.

The following DD statement is optional:


SYSLIST identifies an output file that is to contain a listing of the output data
set. The first 80 characters of fixed-length records are listed.
Variable-length records are not listed.

4.5.6 Return Codes


ROSCOPY returns the following codes:

Code Meaning
0 Successful execution no errors found.
4 One or more errors occurred.

If a diagnostic message is issued, execution terminates. The messages are


written to the SYSPRINT data set. (If SYSPRINT is not open at the time of the
error, the messages are written to the job log by a WTO macro.)

4.5.6.1 Sample JCL

Default sample JCL to execute program ROSCOPY is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

Chapter 4. Library Maintenance Program Summaries 4-61


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)


The ROSDATA program creates or replaces one or more Advantage
CA-Roscoe library members from a data set. ROSDATA allows you to:
■ Assign library member attributes (that is, sequence attribute, access
attribute) and a description to the member being created
■ Concatenate several input data sets to create a single library member
■ Create multiple library members from a single input data set
■ Perform basic editing of the input before it is saved in the Advantage
CA-Roscoe library

To be copied, the data set must have a:


■ Record format (RECFM=) of F, FB, V, or VB.
■ Logical record length between 10 and 255 (for fixed-length or fixed-length
blocked records) or between 1 and 255 (for variable-length or
variable-length blocked records).
■ Data set organization of physical sequential (PS) or partitioned (PO).

Library Administrator Privileges

When the sign-on key associated with the Library Administrator or the
individual assigned the RO prefix is specified in the PARM field of the EXEC
statement, the created/replacement library members can be assigned to specific
users.

A Library Administrator is a user that has been assigned the privileged


command of LIBADM through UPSMNTxx (Internal security). A user defined
as a Library Administrator through External security cannot create/replace
library members for a specific user. The owner of the RO prefix will have to be
specified. However, sites that have defined an allr (users) as a Library
Administrator through External security may also want to define the same
user(s) as Library Administrator through UPSMNTxx.

4.6.1 Program Requirements


This section describes the EXEC statement parameters, SYSIN control
statements and DD statements that are used by the ROSDATA program.

4-62 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

4.6.1.1 PARM Field Options

The ROSDATA program uses the following PARM field option:


key is a one- to 22-character sign-on key of the user executing the
program. This parameter is required. If it is missing or invalid,
execution terminates.
To use the privileged facilities of ROSDATA, the sign-on key
must be the owner of the RO prefix.

4.6.1.2 SYSIN Control Statements

ROSDATA uses the following control statements:


$ADD creates or replaces one or more Advantage CA-Roscoe library
members from one or more input data sets and assigns
attributes and descriptions to the members.
$CLEAR clears specified fields in the input records.
$FILL forces a character string into specified fields of the input
records.
$FROM identifies auxiliary input data sets that are to be used in
addition to the SYSIN data set.
$KEY identifies the sign-on key of the use who is to receive
subsequent library members. (This function is provided for the
use of a Library Administrator or the owner of the RO prefix.
See the section 4-62 for more information about Library
Administrators.)

The following rules should be observed when coding ROSDATA control


statements:
■ Control statements must appear in the SYSIN data set in the order in
which they are to be executed.
■ The control statement must begin in column 1. Each statement must begin
with the special character used to identify control statements. (The default
special character is the $.) Except for data in $FROM data sets, no other
input in the SYSIN stream may contain the same special character in
column 1.
■ The control statement and its first operand must be separated by one
space.
■ Control statement operands may be coded up to column 71. Continuations
are indicated by placing a comma after the last operand on the record.
Continuations may begin in any column, as long as they are preceded by
at least one blank space and do not extend beyond column 71.
■ Operands are separated by commas.

Chapter 4. Library Maintenance Program Summaries 4-63


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

■ Comments can be included on control statements, provided there is at least


one space between the comment and the control statement and its
operands.

4.6.2 $ADD Control Statement


Creates or replaces one or more library members and assigns attributes and a
description to each member.

SYNTAX

$ADD Control Statement


──$ADD──MEMBER=mem──┬──────────────┬───────────────────────────
└─,KEY=userkey─┘
──┬─────────────────────┬──┬─────────────────────┬──────────────
│ ┌─ALL─────┐ │ │ ┌─1─┐ │
└─,LIST=─┼─────────┼──┘ └─,MAXSIZE=─┼──────┼──┘
├─NONE────┤ ├─num──┤
└─CONTROL─┘ ├─EOF──┤
└─OFF──┘
──┬─────────────────┬──┬─────────────────┬──────────────────────
│ ┌─1─┐ │ │ ┌─1─┐ │
└─,SEQ1=─┴─num─┴──┘ └─,INCR=─┴─num─┴──┘
──┬────────────────┬──┬──────────────────────┬──┬────────┬──────
└─,USE=start,len─┘ │ ┌─73,8──────┐ │ └─,NOSEQ─┘
└─,SEQ=─┼───────────┼──┘
├─start,len─┤
└─COBOL─────┘
──┬────────────────┬──┬──────────────────────────┬─────────────
└─,DESC='string'─┘ │ ┌─SHARED─────┐ │
└─,ACCESS=─┼────────────┼──┘
├─EXECONLY───┤
└─RESTRICTED─┘

MEMBER=mem is the name of the library member to be created or


replaced. The name must conform to Advantage
CA-Roscoe library member naming conventions. If the
name already exists, the new data overlays the data in the
existing member.
Note: The optional pfx operand is for the use of the
Library Administrator or the owner of the RO
prefix (see the section on page 4-62 for more
information about Library Administrators.) If pfx is
not specified, the member is assumed to belong to
the individual executing the job. The only exception
to this is if the individual has update authority for
the member(s), ROSDATA allows the same update
authority as native Advantage CA-Roscoe.

4-64 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

KEY=userkey is the sign-on key of the user to receive the library


member.
One or more KEY= operands may be specified. If you
specify multiple operands, each must identify the sign-on
key of the user to receive the new member(s).
Note: If KEY= is used and the sign-on key in the PARM
field of the EXEC statement does not belong to a
Library Administrator or the owner of the RO
prefix ROSDATA terminates. (See the section on
page 4-62 for more information about Library
Administrators.)
A prefix and the KEY= operand are mutually
exclusive.

LIST= specify the type of output to be listed. The default is


LIST=ALL. Specify either:
ALL causes all input data and control statements to be
included in the SYSPRINT file. The data records
are listed after all editing and sequencing
operations are performed.
NONE causes the input data and control statements to be
suppressed. Error messages, if generated, are
listed.
CONTROL causes the input data to be suppressed. Control
statements and error messages are listed.
MAXSIZE= specify the number of lines to be included in a library member
before segmentation occurs. (See Notes for a description of
segmentation.) The default is MAXSIZE=1000. Specify either:
num is an unsigned integer indicating the number of
lines to be included in a member before
segmentation occurs.
EOF causes segmentation to occur every time an
end-of-file condition is encountered in the auxiliary
data set(s), as specified in $FROM control
statements.
OFF suppresses segmentation. If a line number greater
than 999999 is generated, ROSDATA terminates.
SEQ1=num is the sequence number to be assigned to the first line in the
member being created or replaced. The default is 100.
INCR=num is the increment to be used in generating subsequent sequence
numbers for the member. The default is 100.

Chapter 4. Library Maintenance Program Summaries 4-65


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

USE=start,len is the number of the starting column and length of the


sequence number field in the input data.
If specified, the sequence numbers in the input records are
used (that is, ROSDATA does not generate new sequence
numbers).
Note: USE= is mutually exclusive with SEQ1= and INCR=.

SEQ= specify the sequence number attribute to be assigned to the


member being created or replaced. If specified with no values
or if omitted, the default is SEQ=73,8. Specify either:
start,len is the number of the starting column and the length
of the sequence number.
COBOL sets columns 1 through 6 as the sequence number
field.
Note: SEQ= and NOSEQ are mutually exclusive.

NOSEQ sets the sequence number attribute which prevents sequence


numbers from being inserted in the records when the data is
PRINTed or SUBMITted.
DESC= is the description to be assigned to the member being created
or replaced. The description must be bound by apostrophes (')
and not exceed 30 characters in length.
ACCESS= specify the access attribute to be assigned to the member being
created or replaced. The default is ACCESS=SHARED. Specify
either:
SHARED allows any user to access or execute the
member; only the owner can also change or
delete it.
EXECONLY allows any user to execute the member; only
the owner can access, change or delete it.
RESTRICTED allows only the owner to execute, access,
change or delete the member.

NOTES:

Additional information about using this control statement:


■ The default values described with this syntax can be changed by site
management.

4-66 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

■ The name specified with the MEMBER= operand must conform to


Advantage CA-Roscoe naming conventions (that is, the name must not
exceed eight characters in length and begin with an alphabetic or currency
character. The remaining characters may be any combination of
alphanumeric or currency characters.) The name SAVAWSnn is reserved
and rejected if specified.
Caution
If the name specified with the MEMBER= operand currently exists in
the user's library, the output from ROSDATA overlays the contents of
the existing member.

■ If the KEY= operand is omitted and no prefix is included with the library
member name, ROSDATA uses the prefix of the key specified in the
PARM field.
■ The USE= operand is mutually exclusive with any segmentation except
MAXSIZE=OFF or MAXSIZE=EOF.
If the line number identified by USE= is not numeric or in ascending
order, ROSDATA terminates. ROSDATA also terminates if a line number
greater than 999999 is encountered.
■ When a new $ADD statement or end-of-input is encountered, all input
data read to that point is used to create or replace the designated library
member, according to the options established by the preceding $ADD
statement. All operands are then reset to their default values which may be
altered by a subsequent $ADD statement.
■ When segmentation is in effect (MAXSIZE=v or MAXSIZE=EOF), the
names of the library members being created/replaced are formed as
follows:
1. The first six characters of the name specified with the MEMBER=
operand are used to form a base name.
2. An index (in the range 00 through 36) is suffixed to the base name
each time a segmentation break occurs.
When a segmentation break occurs, all input read to that point is used to
create/replace the appropriate member and the member name is suffixed
with an index value.
Subsequent member names are created by suffixing successive indexes to
the base name. For example, if MEMBER=TESTNAME and MAXSIZE=100
are specified and the input consists of 550 lines, the data is saved in the
members TESTNA00 through TESTNA05. (The first five members contain
100 lines each; the last member contains 50 lines.)

Chapter 4. Library Maintenance Program Summaries 4-67


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

The first line number of succeeding members (that is, other than the first
member created) is set to the value specified in the SEQ1= operand, unless
the USE= operand is specified, in which case sequence numbers from the
input data are used.
If more than 37 member might be created with the same base name (that
is, the indexes 00 through 36 have been exhausted), ROSDATA terminates
after creating 37 members.
■ When LIST=ALL is specified, the format of the listing depends on the
input data.
1. With variable-length input, three lines are printed for each original
input record. Angle brackets point to the beginning of each original
record. The record is split into the following print lines:
Line 1 contains columns 1 through 100
Line 2 contains columns 101 through 200
Line 3 contains columns 201 through 255
2. With fixed-length input, the number of print lines for each input
record depends on how many characters there are in the records,
where:
0 to 100 characters --> 1 line printed
101 to 200 characters --> 2 lines printed
201 to 255 characters --> 3 lines printed
When fixed-length records must be split, the records are split at the
same columns that variable-length records are split. The beginning of
each record is indicated by angle brackets.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To create a library member, suppress segmentation and list only error
messages:
//SYSIN DD 
$ADD MEMBER=LOOKSTAT,LIST=NONE,MAXSIZE=OFF
■ To create a library member and assign a description, access attribute and
sequence attribute to it:
//SYSIN DD 
$ADD MEMBER=IEBSTUFF,DESC='JCL: IEBSTUFF UTILITY',
ACCESS=SHARED,NOSEQ

4-68 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

4.6.3 $CLEAR Control Statement


Clears specified fields in the input records.

SYNTAX

$CLEAR Control Statement


┌─,───────────┐
┬───────────┬┴─────────────────────────────────────
──$CLEAR───
└─start,len─┘

With no operands, disables the prior $CLEAR control statement.


start,len is the number of the column at which the operation is to start and
the length of that field.

NOTES: Additional information about using this control statement:


■ Comments may not be included in a $CLEAR statement that has no
operands.
■ A maximum of 10 fields may be cleared by a single $CLEAR statement.
Optionally, the list may be enclosed in parentheses. No check is made for
overlapping fields.
■ The $CLEAR statement remains in effect until another $CLEAR statement,
a $ADD statement, or end-of-input is encountered.
■ There is no limit to how many $CLEAR statements can be specified. Each
statement disables the previous statement. This permits new columns to be
cleared in the middle of an input data stream.
■ Clear operations are performed immediately after sequencing operations
and just before fill operations.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To clear columns 73 through 80:
$CLEAR 73,8
■ To clear multiple columns:
$CLEAR 1,6,73,8

Chapter 4. Library Maintenance Program Summaries 4-69


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

4.6.4 $FILL Control Statement


Forces a character string into a specified field in the input data.

SYNTAX

$FILL Control Statement


──$FILL──┬───────────────┬────────────────────────────────────
└─/string/start─┘

With no operands, disables any prior $FILL statement in effect.


/string/ is the character string to be forced into the specified columns of the
input records.
start is the number of the column as which the fill operation is to begin.

NOTES: Additional information about using this control statement:


■ Comments may not be included in a $FILL statement that has no
operands.
■ There is no limit on how many strings can be specified in a $FILL
statement. Each string must be complete within a record. To continue a
$FILL statement, place a comma after the start operand on each record that
is to be continued.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To fill columns 73 through 80 with an eight-character string:
$FILL /IEBGENER/,73

4.6.5 $FROM Control Statement


Identifies auxiliary data sets that are to be used as input in addition to the
SYSIN data set.

SYNTAX

$FROM Control Statement


──$FROM──ddname──┬───────┬────────────────────────────────────
└─(mem)─┘

ddname is the name of the DD statement that defines the auxiliary data set.
mem is the name of the PDS member on the auxiliary data set that
contains the input.

4-70 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

NOTES: Additional information about using this control statement:


■ A $FROM statement must be preceded by a $ADD statement.
■ When a $FROM statement is encountered in the SYSIN data set, input is
read from the designated data set. When end-of-file is reached in that data
set, ROSDATA resumes reading from SYSIN.
■ One or more $FROM statements may be specified where each identifies a
different data set.
■ ROSDATA control statements (or any record having $ in column 1)
encountered in $FROM data sets are not interpreted as control statements.
They are treated as data records and are included in the library member
created or replaced.

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To specify that input is to be read from the sequential data set identified
by the CARDF DD statement:
$FROM CARDF
■ To specify that input is to be read from member INVREPT of the
partitioned data set identified by the SOURCE DD statement:
$FROM SOURCE(INVREPT)

4.6.6 $KEY Control Statement


Identifies the sign-on key of the user who is to receive the subsequent library
members.

SYNTAX

$KEY Control Statement


──$KEY=──key──────────────────────────────────────────────────

key is the sign-on key of the user who is to receive the library
member(s).

NOTES: Additional information about using this control statement:


■ When $KEY is encountered, any prior data is saved under the prior
controls. The designated sign-on key is then used to obtain the prefix that
is to be associated with the library member(s) created by subsequent $ADD
control statements.
■ ROSDATA terminates if one or more $KEY control statements are coded
and the sign-on key in the PARM field does not belong to a Library
Administrator or the owner of the RO prefix (see the section on page 4-62
for more information about Library Administrators.)

Chapter 4. Library Maintenance Program Summaries 4-71


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

EXAMPLES: The following examples illustrate the use of this control


statement:
■ To create/replace library members and assign them to different Advantage
CA-Roscoe users:
// EXEC ROSDATA,PARM='ROSCOE'
...
//SYSIN DD 
$ADD MEMBER=SAMPLE1
$ADD MEMBER=SAMPLE2,KEY=JONES
$KEY=USERID1
$ADD MEMBER=SAMPLE3
...
The member identified by the first $ADD is to be created and added to the
library of the user identified in the PARM field. The second member is to
be created and added to the library of the user whose sign-on key is
JONES. The last member and any subsequent members are to be created
and added to the library of the user whose key is USERID1.

4.6.6.1 DD Statements

The following DD statements are required:


ROSLIBnn identifies the user library system. One DD statement must be
included for each file in the library system. The disposition
must be SHR.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSPRINT identifies the output file that is to contain the input data,
control statement and error messages, if any.
The RECFM is VBM. The LRECL is 120. If a block size is
specified, it must be a multiple of 120 plus an additional four
bytes. If a block size is not specified, the default is 3520.
SYSIN identifies the input file containing the ROSDATA control
statements. This file may also contain input data to be used in
creating or replacing a library member.
The RECFM may be F, FB, V or VB. If LRECL and BLKSIZE are
omitted, the defaults are RECFM=F, LRECL=80 and
BLKSIZE=80

The following DD statement is optional:


ddname is the input file identified by the $FROM control statement. There is
no limit to the number of such files that may be identified.

4-72 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

4.6.7 Return Codes


If errors are encountered during execution of ROSDATA, a message is written
to the SYSPRINT listing and ROSDATA terminates. The message is a one-line
explanation of the error. If it is:
■ Invalid control statements or missing JCL - the error can be corrected and
the job resubmitted.
■ An I/O error on any of the data sets accessed by ROSDATA - the job
should be resubmitted; if the I/O error persists, the SYSPRINT listings
should be reviewed to determine the cause of the error.

Certain error conditions, which are not considered serious but cause
termination of ROSDATA, create a member with the name assigned in the
$ADD control statement. Instead of the data being added, this member
contains the message that appears on the printer listing.

ROSDATA returns the following codes:

Code Meaning
0 Successful execution no errors found.
4 An unrecoverable I/O error occurred while ROSDATA was
attempting to access an input data set. NOTE: This error occurs
only when ROSDATA is called as a subprogram from within
another program.
8 An unrecoverable I/O error occurred while accessing the SYSIN
data set.
12 An unrecoverable I/O error occurred while accessing the data set
specified through a $FROM control statement.
16 The UPSREAD subroutine could not access the Advantage
CA-Roscoe library.
20 An I/O error occurred while accessing the Advantage CA-Roscoe
library files.
24 One of the following errors occurred: 1) an unrecoverable I/O
error occurred while access the library index file; or 2) there is
insufficient space in the library index file to store another directory
entry.
28 A library protection check occurred.
32 The library member name specified in a $ADD statement: 1) is a
reserved name (for example, SAVAWSnn); or 2) does not conform
to Advantage CA-Roscoe naming conventions.
36 The key specified in the PARM field does not exist.

Chapter 4. Library Maintenance Program Summaries 4-73


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

Code Meaning
40 The data set specified through a $FROM control statement has an
invalid DCB.
44 The data specified in a $FROM control statement has an
incomplete DCB or does not contain the specified PDS member.
48 The PARM field is null, blank or contains more than 22 characters
of data.
52 A SYSIN record was read that does not contain a ROSDATA
control statement or contains an invalid operand.
56 One of the following errors occurred: 1) no member name was
specified through a $ADD statement; or 2) the first character in the
SYSIN record does not contain the special control statement
character when a control statement is expected.
60 An input data set specified through a $FROM control statement
does not contain any records.
64 The sequence number of the next record to be added to the library
member exceeds 999999.
68 Segmentation limit is exceeded (that is, all 37 segmentation indexes
for a base name are used).
72 Reserved.
76 Reserved.
80 One of the following errors occurred: 1) ROSDATA can not obtain
enough main storage to execute; or 2) the program issued a
GETMAIN that cannot be satisfied.
84 Sequence numbers taken from the input data set are not suitable
for use in creating sequence numbers for the library member.
88 Reserved.
92 Access to ROSDATA denied by site exit routine.
96 The user attempted to replace a member saved under the UPS
prefix.
100 The member name specified with a $ADD control statement does
not conform to Advantage CA-Roscoe naming conventions.
104 Mutually exclusive operands are specified on a $ADD control
statement.
108 The prefix specified with the MEMBER= operand of a $ADD
control statement is not defined to Advantage CA-Roscoe.

4-74 Programs and Utilities Guide


4.6 Copy Member(s) from a Data Set (ROSDATA Pgm)

4.6.7.1 Sample JCL

Default sample JCL to execute program ROSDATA is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

Chapter 4. Library Maintenance Program Summaries 4-75


4.7 Library Member Information (ROSMAILS Program)

4.7 Library Member Information (ROSMAILS Program)


Input to ROSMAILS consists of EXEC parameters, SYSIN control statements,
and the Advantage CA-Roscoe user libraries. Output is as follows:
1. ROSMAILS report which describes the library members belonging to each
Advantage CA-Roscoe user
2. Line Count Violation Report
3. Listing of control statements

Optionally, during execution, ROSMAILS can also be used to:


■ Delete members that are unowned (that is, members belonging to users
who are no longer defined to Advantage CA-Roscoe).
■ Delete members belonging to specific sign-on keys.

ROSMAILS can also delete members that are marked for deletion by an
optional site-written exit routine. (The optional ROSMAILS exit is described in
Advantage CA-Roscoe Interactive Environment Extended Facilities for System
Programmers Guide.)

4.7.1 Description of Reports


The ROSMAILS program produces the following reports:
1. ROSMAILS Report
This two-part report shows:
a. The names of the library members that have been deleted because they
were unowned, identified through the KEY SYSIN control statement,
or marked for deletion by a site-written exit routine.
b. Information about the members remaining in the library. The
information includes:
Member name
Description
Date created
Date last updated
Date last accessed
Number of lines in member
Attributes of member
Charges (the contents of this field is supplied by site management)
Comments (the contents of this field is supplied by site
management)
The report is sorted by the Formal Key. The subtotal provided for
each user includes the total number of library members, lines and
blocks. At the end of the report, total information is provided for all
users.

4-76 Programs and Utilities Guide


4.7 Library Member Information (ROSMAILS Program)

2. Line Count Violation Report


This report lists each user who has saved more lines in the library than are
permitted by site management. (The library line limit is defined for each
individual in their UPS profile, which is described in the Advantage
CA-Roscoe Interactive Environment System Reference Guide.)

4.7.2 Program Requirements


This section describes the EXEC statement parameters, SYSIN control
statements and DD statements used by the ROSMAILS program.
Note: Running ROSMAILS with PARM=DELETE may cause ROSCOE to
hang with an enqueue conflict. ROSMAILS PARM=DELETE should be
run when ROSCOE is down.

4.7.2.1 PARM Field Options

The ROSMAILS program uses the following PARM field options:


DELETE causes all unowned members (that is, members for
which no user profile can be found in the User Profile
System (UPS)) to be deleted.
Note: This is in addition to the library members that
may be explicitly deleted through the KEY=
control statement or a site-written exit routine.
If DELETE is omitted, no 'unowned' library members are
deleted.
EXIT=name is the name of the site-written exit routine that is to be
called during processing.
LINECNT=num is a value between 10 and 112 that represents the
number of lines per page that are to be generated when
producing the ROSMAILS report.
NOREPORT suppresses the ROSMAILS report.
SORTSIZE=numK is the amount of memory to be used by the SORT phage.
The value must be specified as numK, where num is the
number of K-bytes. The default is 48K.

4.7.2.2 SYSIN Control Statements

The SYSIN control statements are:


KEY= identifies the user whose library members are to be deleted.
SYSTEM adds a site-defined header to the report.

Chapter 4. Library Maintenance Program Summaries 4-77


4.7 Library Member Information (ROSMAILS Program)

4.7.3 KEY Control Statement


Identifies the user whose library members are to be deleted.

SYNTAX

KEY Control Statement


──KEY=──key───────────────────────────────────────────────────

key is an Advantage CA-Roscoe sign-on key as defined in the User


Profile System (UPS).

NOTES: Additional information about this control statement:


■ The sign-on keys:
– Need not be presented in collating sequence.
– Must be the user sign-on keys. If a formal sign-on key is specified,
ROSMAILS terminates.
■ Only one KEY control statement may be specified per record and each
must begin in the first position of the record. Positions 36 through 80 of
the record may contain comments. Any number of statements can be
included in the SYSIN file.
■ A maximum of 170 KEY control statements may be specified per
ROSMAILS execution.

4.7.4 SYSTEM Control Statement


Designates a header that is to be added to the top of each report produced by
ROSMAILS.

SYNTAX

SYSTEM Control Statement


──SYSTEM=──string─────────────────────────────────────────────

string is a character string not exceeding 20 characters in length.

NOTES: Additional information about this control statement:


■ Only one SYSTEM control statement may be specified per execution. It
must begin in the first position of the record. Positions 36 through 80 of
the record may contain comments.
■ If a SYSTEM= control statement is specified, it must be the first statement
in the SYSIN file, preceding all KEY= control statements.

4-78 Programs and Utilities Guide


4.7 Library Member Information (ROSMAILS Program)

4.7.4.1 DD Statements

The following DD statements are required:


REPORT identifies an output file that is to contain information about
each user's library members.
ROSLIBnn identifies the user library system. One DD statement must be
included for each file in the library system.
SORTIN identifies the sort input file.
SORTLIB identifies the sort load library.
SORTWRKnn
identifies the sort work files. The number of files required
depends on the site's sort procedure.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSIN identifies an input file containing the control statements. This
file may be empty or specified as DD DUMMY if there are no
control statements.
SYSOUT identifies an output file that is to contain SORT diagnostics, if
any.
SYSPRINT identifies an output file that is to contain a listing of the library
members marked for deletion by either the control statements
or the user exit.

The following DD statement is optional:


SYSWARN identifies the output file that is to contain the Line Count
Violations Report.

4.7.5 Return Codes


The ROSMAILS program returns the following codes:

Code Meaning
0 Execution has completed successfully.

Chapter 4. Library Maintenance Program Summaries 4-79


4.7 Library Member Information (ROSMAILS Program)

Code Meaning
4 or 16 Execution failed for any of the following reasons:
■ Invalid PARM field option
■ Incorrect format of SYSIN control statement
■ Key designated on the control statement cannot be found
■ Incorrect library JCL (ROSLIBnn statements)
■ I/O error on any file
■ Incorrect user exit return code

4.7.5.1 Sample JCL

Default sample JCL to execute program ROSMAILS is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

4-80 Programs and Utilities Guide


4.8 Library Statistics (ROSTAT Program)

4.8 Library Statistics (ROSTAT Program)


The input to the ROSTAT program are the Advantage CA-Roscoe initialization
parameters, the Advantage CA-Roscoe libraries and the AWS pointer file.

The output is a report containing the configuration statistics for the library and
AWS plus a listing of the Advantage CA-Roscoe initialization parameters for
the currently executing Advantage CA-Roscoe. The report shows the:
1. Statistics on the amount of space being used in the Advantage CA-Roscoe
library system
2. Current values of the Advantage CA-Roscoe initialization parameters
3. Current AWS configuration

ROSTAT should be run every day as part of standard maintenance. The


recommended job stream is:
■ LIBUTIL (to backup the user libraries),
■ ROSTAT (to monitor user library space usage), and
■ LIBSERVE/PURGE (to delete transient user library members).
Note: ROSTAT should be run when Advantage CA-Roscoe is not executing. If
Advantage CA-Roscoe is executing, the user library statistics will be
affected by the type and amount of user activity at the time ROSTAT is
executed. The report may not reflect a true picture of library usage.

4.8.1 Description of Report


The report produced by ROSTAT has three sections:
1. User Library Statistics:
This section includes the date of the last format run, number of data files,
library block size, total number of user library members, total number of
all user records, average, maximum and minimum index capacities, total
number of data blocks, free data blocks and dead data blocks.
Summary lines report on the number of data blocks and free blocks in each
Advantage CA-Roscoe library data file (that is, ROSLIB01, ROSLIB02, and
so on).
2. AWS Configuration Variables:
This section includes the:
■ number of AWSs
■ number of lines in the AWS
■ block size of the data files
■ number (extents) of data files
3. Site Variables from Preceding Run

Chapter 4. Library Maintenance Program Summaries 4-81


4.8 Library Statistics (ROSTAT Program)

This section contains a listing of the Advantage CA-Roscoe initialization


parameters for the most recent execution of Advantage CA-Roscoe. The
name of the library member containing the initialization parameters is also
included with this information.
Note: Library Index Capacities:

Periodically, compare the total number of library members against the


index capacities. For optimum performance, the number of library
members should be less than the average index capacity.
■ The maximum index capacity is calculated by multiplying the
number of index blocks by the number of entries per block.
■ The average index capacity is one-half the maximum index
capacity.
■ The minimum index capacity is calculated by multiplying the
number of free index blocks by the number of entries per block.

If the number of members is greater than the average index capacity,


the index file should be reallocated with a larger index capacity and
restored.

If the minimum index capacity is low:


■ The number of library members is close to the average index
capacity, reallocate the index file and restore the libraries.
■ The number of library members is 50% of the average index
capacity, restore the library files. (It need not be reallocated.)

4.8.2 Program Requirements


This section describes the EXEC parameter and DD statements used by the
ROSTAT program. There are no SYSIN control statements.

4.8.2.1 PARM Field Options

The ROSTAT program uses the following PARM field option.


mem is the name of the library member containing the Advantage
CA-Roscoe initialization parameters.

The library member name is not required. It is recommended that a name


always be specified. If it is not, the name of the job executing ROSTAT must
be the same as the name of the job executing Advantage CA-Roscoe.

4-82 Programs and Utilities Guide


4.8 Library Statistics (ROSTAT Program)

4.8.2.2 SYSIN Control Statements

The ROSTAT program has no SYSIN control statements.

4.8.2.3 DD Statements

The following DD statements are required:


SYSPRINT identifies the output file that is to contain the report.
ROSLIBnn identifies the user library system. One DD statement must be
included for each file in the library system. If ROSTAT is
executed when Advantage CA-Roscoe is running, the
disposition must be SHR.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSAWSP identifies the AWS pointer file. The disposition of this file must
be OLD.

4.8.3 Return Codes


The ROSTAT program returns the following codes:

Code Meaning
0 Successful completion.
4 One or more errors occurred execution terminated.

4.8.3.1 Sample JCL

Default sample JCL to execute program ROSTAT is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

Chapter 4. Library Maintenance Program Summaries 4-83


4-84 Programs and Utilities Guide
Chapter 5. Miscellaneous Programs

The miscellaneous programs distributed with Advantage CA-Roscoe include:


DISAUTHO Extends the subcommand privileges of the DISPLAY Monitor
command to specific individuals.
TRANS Converts uppercase and lowercase text to uppercase only.
TREPORT Formats and lists data collected by the Advantage CA-Roscoe
Trace Facility (RTF).
UPSLIST Lists produces a listing of user profile information sorted by
informal sign-on key, formal sign-on key or user prefix.

Chapter 5. Miscellaneous Programs 5-1


5.1 DISPLAY Authorization (DISAUTHO Program)

5.1 DISPLAY Authorization (DISAUTHO Program)


The DISAUTHO program creates and maintains a DISPLAY Authorization
Table. This optional table can be used in conjunction with the ROSGBL table
and the DISEXIT exit routine to control the use of DISPLAY subcommands.
Note: ROSGBL is described in the Advantage CA-Roscoe Interactive Environment
System Reference Guide. DISEXIT is described in Advantage CA-Roscoe
Extended Facilities for System Programmers.

For example, assume that your site wants to: 1) allow every Advantage
CA-Roscoe user to issue the JOB subcommand of DISPLAY, and 2) restricts the
use of other subcommands to specific users. To do this, your site might:
■ Define CMDTAB=J in the ROSGBL table. This allows every Advantage
CA-Roscoe user to display job status information.
■ Define a DISPLAY Authorization Table that designates those individuals
allowed to execute the remaining subcommands. (Subcommands entered
by unauthorized individuals are rejected.)

A DISPLAY Authorization table consists of lists of authorized users and the


subcommands that those individuals may use. By default, the table is kept in
the library member named DISAUTHO in the library of the individual
assigned the RO prefix. (The Advantage CA-Roscoe initialization parameter
DISAUTHO= can be used to designate a default different prefix or member
name.)

5.1.1 Program Requirements


This section describes the EXEC statement parameters, SYSIN control
statements and DD statements that are used by the DISAUTHO program.

5.1.1.1 PARM Field Options

The PARM field options are:


D delete existing table.
L list existing table.
Note: D and L are mutually exclusive.
If neither D nor L is specified, the default is to create (or
update) and list the table.
mem is the name of the library member that is to contain the
Authorization Table. If no prefix is specified, RO is assumed.
If omitted, the default is either RO.DISAUTHO or the prefix and
member specified with the Advantage CA-Roscoe initialization
parameter DISAUTHO=.

5-2 Programs and Utilities Guide


5.1 DISPLAY Authorization (DISAUTHO Program)

If both PARM field options are specified, they must be separated by


a comma. If only a member name is specified, the comma is still
required.

Examples:
■ To update the Authorization Table saved in the default member (usually
named RO.DISAUTHO):
PARM=','
If the member does not exist, it is created.
■ To update the table saved in the member named DISTBL1:
PARM=',DISTRL1'
Since no prefix is specified, RO is assumed.
■ To list the the contents of the table saved in the member XX.DISTBL2:
PARM='L,XX.DISTBL1'
■ To delete the table saved in the member named RO.DISAUTHO:
PARM='D'

5.1.1.2 SYSIN Control Statements

DISAUTHO uses the following control statements:


ALLOW associates specific subcommands with a specific group.
GROUP defines the users in a group.

Control statements must be coded in accordance with the following


conventions:
■ If the optional label is specified, it must begin in the first position of a line.
If the label is not specified, each control statement may begin in any
location past the first position of a line and must be preceded by at least
one space.
■ The parameters must be separated by commas and may be entered on
successive lines.

ALLOW Control Statement

Associates a specific set of subcommands with a specific group of users.

[label] ALLOW COMMANDS=(subcmd1,...subcmdn),GROUP=name

label is a name not exceeding eight characters in length.

Chapter 5. Miscellaneous Programs 5-3


5.1 DISPLAY Authorization (DISAUTHO Program)

COMMANDS=subcmd
is one or more of the following codes, where the codes
identify the subcommands that are to be allowed for
each group. If multiple codes are specified, they must
be separated by a comma.

Table 5-1. DISAUTHO Subcommands

Code Subcommand
A ACTIVE
AR ACTIVE,remote
AS ACTIVE,TASK (STC)
AT ACTIVE,TSO (TSO)
ALL ACTIVE,ALL
D DEVICES
I INIT
J JOB
N NAME
NC NAME,class
NR NAME,remote
Q QUEUE
QC QUEUE,class
QR QUEUE,remote

GROUP=name is a name not exceeding eight characters in length.

5.1.1.3 Notes

■ A maximum of 100 ALLOW control statements may be coded.


■ The group name is also used with the GROUP control statement to
associate users with the designated subcommands.

5.1.2 GROUP Control Statement


Assigns users to a group.

[label] GROUP name=(key1,...keyn)

label is a name not exceeding eight characters in length.

5-4 Programs and Utilities Guide


5.1 DISPLAY Authorization (DISAUTHO Program)

name is a group name not exceeding eight characters in length.


key is one or more sign-on keys, identifying each user to be assigned to
the group. If multiple sign-on keys are specified, they must be
separated by a comma.

5.1.2.1 Notes

■ The group name must also be specified with the GROUP= operand of the
ALLOW control statement.
■ A user may belong to only one group.
■ There is no limit to the number of groups that can be specified.

5.1.2.2 DD Statements

The following DD statements are required:


ROSLIBnn identifies the user library system. One DD statement must be
included for each file in the library system. If DISAUTHO is
executed when Advantage CA-Roscoe is executing, the
disposition must be SHR.
SYSIN identifies the input file containing the control statements.
SYSPRINT identifies the output file that is to contain messages and
diagnostics.

5.1.3 Return Codes


The DISAUTHO program returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors occurred.

If an error is found during processing, no changes are made to the


Authorization Table.

5.1.3.1 Sample JCL

Default sample JCL to execute program DISAUTHO is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

Chapter 5. Miscellaneous Programs 5-5


5.2 RTF Report (TREPORT Program)

5.2 RTF Report (TREPORT Program)


The TREPORT program formats and lists Advantage CA-Roscoe Trace Facility
(RTF) records.

Use the RTF Monitor command to invoke the trace facility. Once invoked, the
facility collects data on specific internal Advantage CA-Roscoe events. The data
on these events can be collected for individual sign-on keys, terminals or line
groups. The TREPORT program formats and lists the collected data in either
chronological order or by user session.

It is expected that sites will write their own analysis programs to provide
information on such areas as system bottlenecks and user response time. (The
RTF records can be mapped by the DSECT named TRC, which is generated by
the ROSTRACE macro.)

5.2.1 Description of Report


The report produced by TREPORT contains information on each trace event.
The following list identifies the report's column headings and explains their
meaning.
DATE date the event occurred.
TIME clock time the event occurred in 10**-4 seconds
(hh.mm.ss.dddd).
SESSID Advantage CA-Roscoe session-ID (which is unique for
each user sign-on) associated with the event.
KEY user sign-on key associated with the event.
CPU cumulative user session CPU in 10**-4 seconds
(hh.mm.ss.dddd).
EVENT identifies the traceable events.
VARIABLE DATA identifies additional information provided with certain
events.

The traceable events and associated variable data are:


TRACE INIT trace facility activated.
TRACE ON tracing started for the KEY, UNIT, NAU or ALL operand
as specified with the START. The variable data includes
the type of tracing.
TRACE OFF tracing ended for the KEY, UNIT, NAU or ALL operand as
specified with STOP.
ROSCOE WAIT Advantage CA-Roscoe has no users on the ready queue
and has entered an OS wait state.

5-6 Programs and Utilities Guide


5.2 RTF Report (TREPORT Program)

USER SIGNON tracing started for this user. (Either RTF is activated and
then the user signs on, or the user is already signed on and
RTF is activated.) The variable data includes the user's
prefix and terminal type.
USER SIGNOFF tracing ended for this user. (Either the user signed off
while RTF is active, or RTF is deactivated and the user is
still signed on.)
USER DISPATCH user transition from ready to running state.
COMMAND BEGIN
Advantage CA-Roscoe has received a data line that is
determined to be a command. The variable data includes
the command.
COMMAND END
a preceding command logically completed. Note: There are
circumstances where COMMAND END is not preceded by
COMMAND BEGIN.
TERMINAL READ
terminal read operation beginning.
TERMINAL WRITE
terminal write operation beginning.
LIBRARY I/O library I/O operation beginning.
AWS I/O AWS I/O operation beginning.
TIMEOUT Advantage CA-Roscoe waiting for an AWS or extra library
buffer.
USER PAUSE a USER PAUSE causes an immediate placement on the
ready queue.
REAL WAIT wait on ECB from Monitor command.

5.2.2 Program Requirements


This section describes the EXEC statement parameter, SYSIN control statements
and DD statements used by the TREPORT program.

5.2.2.1 PARM Field Options

The TREPORT program uses the following PARM field option:


SORTSIZE=numK is the amount of memory to be used by the SORT phase.
The value must be specified as numK where num is the
number of K-bytes. The default is 48K.

SORTSIZE= is needed only when the ORDER=SESSION control statement is


specified and the default is inappropriate.

Chapter 5. Miscellaneous Programs 5-7


5.2 RTF Report (TREPORT Program)

The parameters passed to SORT are:

RECORD TYPE=V,LENGTH=(96,,,32,32)
SORT FIELDS=(5,4,BI,A,9,4,BI,A,17,8,BI,A)

where:

RECORD specifies that the longest record is 96, the shortest is 32 and the most
frequent record size is 32.

SORT specifies that the sort is to be by Advantage CA-Roscoe run


identification user session identification and then time stamp.

5.2.2.2 SYSIN Control Statements

The optional SYSIN control statements are coded in free format with the
restriction that only one control statement may be specified per line.

The SYSIN control statements are:


DATE= format of dates included in the listing. The default is AMER.
Specify either:
AMER causes dates to be printed in the format MMDDYY.
EUOR causes dates to be printed in the format DDMMYY.
HEADER=

string optional heading that is to appear at the top of each page of the
report. The heading must be a character string that is delimited by
any special character that is not used within the string itself.
Multiple HEADER= statements can be specified with the string in
subsequent HEADER= statements concatenated to the end of the
previous string. The maximum length of the string is 132 characters.
LINECOUNT=

num is the number of lines to be printed per page. The number must be
between 10 and 112, inclusive. The default is 56.
ORDER= is the order in which the input records are to be sorted. The
default is ORDER=CHRON. Specify either:
CHRON causes trace records to be listed in chronological order.
SESSION causes trace records to be sorted and listed by user
session.

5-8 Programs and Utilities Guide


5.2 RTF Report (TREPORT Program)

5.2.2.3 DD Statements

The following DD statements are required:


ROSPRINT identifies the output file that is to contain the TRACE report.
The file must be defined with: RECFM=FBA, LRECL=133 and
BLKSIZE=133.
ROSTRACE identifies the input file containing trace records created by RTF.
The file must be defined with: RECFM=VB, LRECL=256 and
BLKSIZE=4092.
ROSLIBnn identifies the user library system. One DD statement must be
included for each file in the library system.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSIN identifies the input file containing SYSIN control statements.
The file must be defined with: RECFM=FB, LRECL=80 and
BLKSIZE=800.

The following DD statements are optional:


SORTIN identifies the sort input file. This file is used only when the
control statement ORDER=SESSION is specified.
SORTLIB identifies the sort load library.
SORTWRKnn
identifies the sort work files. The number of files required
depends on the site's sort procedure.
SYSOUT identifies the output file that is to contain SORT messages.
SYSPRINT identifies the output file that is to contain diagnostics. The file
must be defined with: RECFM=FBA, LRECL=81 and
BLKSIZE=810.
SYSUDUMP identifies the output dump data set file.

5.2.3 Return Codes


The TREPORT program returns the following codes:

Code Meaning
0 Successful execution.
4 One or more errors occurred but execution continued.
8 A serious error occurred and execution terminated.

Chapter 5. Miscellaneous Programs 5-9


5.2 RTF Report (TREPORT Program)

5.2.3.1 Sample JCL

Default sample JCL to execute program TREPORT is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

5-10 Programs and Utilities Guide


5.3 User Profile Information (UPSLIST Program)

5.3 User Profile Information (UPSLIST Program)


The UPSLIST program produces a listing containing the individual profiles,
shorted by informal key, formal key or prefix.
Note: User profiles are created and maintained online, as described in the
Advantage CA-Roscoe Interactive Environment System Reference Guide
Input to the UPSLIST program is the Advantage CA-Roscoe libraries and
optional EXEC parameters. Output is a listing of the sorted profile information.

5.3.1 Description of Report


The report produced by UPSLIST contains the following information about
each user defined to Advantage CA-Roscoe:
■ User sign-on key.
■ Formal sign-on key, if one is specified.
■ Password, if one is specified.
Note: This field is asterisk-filled if the user prefix is RO, AI, UPS, a
Library Administrator, or a UPS Administrator.
■ Password change code.
■ Password required code.
■ Sign-on procedure name, if one is specified.
■ Sign-on procedure change code.
■ User prefix.
■ Maximum number of lines the user can save in the library. This field is
blank if no limit was set.
■ Number of lines the user currently has saved in the library. This field is
blank if no limit was set. UPSLIST output is NOT based on the current
(online) statistics but the values saved.
■ Security group name.
■ Restricted user code.
■ Privileged user codes:
O User has Operator privileges.
| G User has Priviliged administrator privileges.
P User has RPS administrator privileges.
A User has Accounting administrator privileges.
E User has ETSO administrator privileges.
L User has Library administrator privileges.
U User has UPS administrator privileges.

A sample of this report is on the next page.

Chapter 5. Miscellaneous Programs 5-11


5.3 User Profile Information (UPSLIST Program)

4/9/92 BY KEY CA-ROSCOE UPS ACCOUNT LISTING PAGE 1

SIGNON KEY FORMAL KEY PASSWORD C R SIGNON PGM C PREFIX MAXREC CURREC GROUP R PRIVILEGES
---------------------- ---------------------- ---------- - - ------------ - --- ------ ------ ------- - ----------

USER1 FIRST1.LASTNAME Y N Y UR1 ROSCOE N A


USER2 FIRST2.LASTNAME Y N Y UR2 ROSCOE N OPAE
ROSCOE.CONTROL ROSCOE.CONTROL  Y N Y RO ROSCOE N OPAE
ROSCOE.CONTROL2 ROSCOE.CONTROL2  Y N Y AI ROSCOE N OPAE
ROSCOE.DB2 ROSCOE.DB2 Y N Y R2D ROSCOE N
ROSCOE.HELP ROSCOE.HELP Y N Y RHE ROSCOE N
ROSCOE.PROFILE ROSCOE.PROFILE  Y N Y UPS ROSCOE N O
ROSCOE.RPF ROSCOE.RPF Y N Y RPF ROSCOE N
ROSCOE.RPS ROSCOE.RPS Y N Y RPS ROSCOE N P
ROSCOE.RTX ROSCOE.RTX Y N Y RTX ROSCOE N E

TOTAL ACCOUNTS ==> 1

5.3.2 Program Requirements


This section describes the EXEC statement parameters and DD statements.
There are no SYSIN control statements.

5.3.2.1 PARM Field Options

The UPSLIST program uses the following five PARM field options.
line-cnt is a two-digit number indicating the number of lines to be printed
per page. The value must be between 10 and 99. The default is 55.
KEY causes the output to be sorted by the user sign-on keys.
FKEY causes the output to be sorted by the formal sign-on keys.
PREFIX causes the output to be listed by the user prefixes.
GROUP causes the output to be sorted by the user GROUP field.
NOSORT produces an unsorted list.

Only one of the sort criteria (that is, KEY, FKEY or PREFIX) may be specified
in the PARM field per execution. The specified sort criterion is indicated on
the report header.

If a line count value is:


■ specified - it must be the first option in the PARM field and the options
must be separated by a comma.
■ omitted - do not code a comma to show it absence.

If no PARM field options are specified, the default is to: 1) sort by user sign-on
key, and 2) print 55 lines per page.

5-12 Programs and Utilities Guide


5.3 User Profile Information (UPSLIST Program)

5.3.2.2 SYSIN Control Statements

There are no SYSIN control statements.

5.3.2.3 DD Statements

The following DD statements are required:


ROSLIBnn identifies the user library system. One unique DD statement
must be included for each file in the library system.
SORTLIB identifies the sort load library.
SORTWRKnn identifies the sort work files. The number of files required
depends on the site's sort procedure.
STEPLIB identifies the Advantage CA-Roscoe execution library
(CAI.RO60LIB).
SYSOUT identifies the output file that is to contain SORT messages, if
any.
SYSPRINT identifies the output file that is to contain the listing of sorted
profile information. The RECFM is FBA, the logical record
length is 133, and the default blocksize is 1330 or any multiple
of 133.

5.3.3 Return Codes


The UPSLIST program returns the following codes:

Code Meaning
0 Successful execution.
4 Either error due to missing DD statement, or I/O errors. (A
WTO diagnostic is written to the job log.)

5.3.3.1 Notes

■ If a return code greater than 4 is produced, there is a SORT error. SORT


diagnostics are written to the SYSPRINT file.
■ If there is an error in the PARM field, a WTO diagnostic is produced and
the defaults are assumed so that execution can continue.

Chapter 5. Miscellaneous Programs 5-13


5.3 User Profile Information (UPSLIST Program)

5.3.3.2 Sample JCL

Default sample JCL to execute program UPSLIST is included in your


installation sample JCL library.

The member name on the installation sample JCL library will correspond to
the program name.

5-14 Programs and Utilities Guide


Index

ACCTDUMP Program (continued)


Special Characters SYSIN control statements 2-5
-END control statement (ROSCOPY program) 4-59 ACCTOPT= Initialization Parameter 1-28
-FRONT control statement (ROSCOPY ACCTREC= Initialization Parameter 1-30, 1-31
program) 4-59 ACCTROS= Initialization Parameter 1-32
$ADD control statement ACCTSMF= Initialization Parameter 1-32
ROSDATA program 4-64—4-68 ACFEXT= Initialization Parameter 1-52
$CLEAR control statement (ROSDATA) 4-69 Add
$FILL control statement (ROSDATA) 4-70 Library members from data set (ROSDATA
$FROM control statement (ROSDATA) 4-70 program) 4-64, 4-65, 4-67, 4-68
$KEY control statement (ROSDATA) 4-71 User library (LIBUTIL program 4-34
+INC expansion, set default 1-129 ADDLIB option (LIBUTIL program) 4-34
Address Space
A System 1-2
Advantage CA-Earl
Accounting
Report definitions members 2-7, 2-8
Advantage CA-Roscoe initialization
Reports
parameters 1-28—1-32
Advantage CA-Roscoe statistics 2-12, 2-13
Buffers
Advantage CA-Roscoe usage 2-13
Define 1-28
AWS statistics 2-9—2-12
Define record types desired 1-30, 1-31
ETSO usage 2-15
Dumping files (ACCTDUMP program) 2-2, 2-3
Monitor usage 2-15
Generate Advantage CA-Roscoe records 1-32
RPF execution 2-16
Generate SMF records 1-32
RPS usage 2-16
Parameters
RTM statistics 2-18—2-21
Accounting 1-32
Using to produce reports 2-7, 2-8
Producing reports
Advantage CA-Roscoe
Using Advantage CA-Earl 2-7, 2-8
See also Initialization Parameters' . 'See Advantage
Programs, Summary of 2-1
CA-Roscoe initialization'
Report about dumped files 2-3
Assign id code 1-71
Accounting files
balance workload 1-70
DD statement requirements 1-133
Batch session
ACCTBUFF= Initialization Parameter 1-28
DD statement requirement 1-133
ACCTDUMP Program
Description 1-4, 1-5
DD statements 2-5
JCL example 1-142
Description 2-2, 2-3
Configuration 1-2
PARM field options 2-4
Control use of SYS1.DUMPnn data sets 1-66
Report, description of 2-3
Executing
Return Codes 2-6
Multiple Advantage CA-Roscoes 1-3
Sample JCL 2-6
Return codes 1-139

Index X-1
Advantage CA-Roscoe (continued) AllFusion CA-Librarian
Files Control module password read protection 1-46
Sharing 1-3 Control PROD2 module inclusion 1-46
Initialize test system 1-73 Define enqueue type 1-47
PUSH Command Default Setting 1-69, 1-105 Define master file definition table 1-49
Region requirement 1-11 Set SET MASTER default 1-120
Security Resource High Level Qualifier 1-70 ALLOW control statement (DISAUTHO
Set Advantage CA-Roscoe sort storage 1-73 program) 5-3
Set nonswappable 1-66 ALLRECAL= Recall specification Parameter 1-39
Set site sort storage 1-72 ALTVERSN option (LIBUTIL program) 4-35
Set sort DD name prefix 1-72 Arithmetic symbols (syntax diagrams) xxviii
Startup 1-8—1-10 ARRAYMAX= Initialization Parameter 1-99
Statistics report 2-12, 2-13 Arrays, RPF
Universal password, define 1-67 Define maximum number allowed 1-99
Usage report ATTACH JOB command
Using Advantage CA-Earl 2-13 Activate facility 1-34
Advantage CA-Roscoe initialization Advantage CA-Roscoe initialization
Console input 1-10 parameters 1-34
Error recovery 1-8—1-10 Attention Handling
JCL samples 1-140, 1-141 Define PA key 1-67
Parameters AUTINTVL= Initialization Parameter 1-52
Accounting 1-28 AUTOFF= Initialization Parameter 1-53
ATTACH JOB 1-34—1-35 AUTOFVAL= Initialization Parameter 1-53
AWS 1-36—1-38 AUTOIND= Initialization Parameter 1-116
Data set 1-39—1-51 AUTOINS= Initialization Parameter 1-116
Define location of 1-6, 1-7 Automatic sign-off facility
Description of 1-12, 1-13 See Terminal 1-53
DISPLAY 1-34, 1-35 Automatic terminal lock facility
Environment 1-52—1-73 See Terminal 1-54
ETSO-related 1-75—1-82 AUTTLOCK= Initialization Parameter 1-54
Library Facility 1-84—1-88 AUTTLVAL= Initialization Parameter 1-55
Monitor-related 1-89, 1-90 AWS
Operator-related 1-91, 1-92 Advantage CA-Roscoe initialization
RCS-related 1-93—1-98 parameters 1-36—1-38
RPF-related 1-99—1-107 Define maximum number per user 1-37
RPS-related 1-108—1-110 Establish
RTM-related 1-111—1-115 Data files block size (FAWSDS program) 3-3
SET defaults 1-116—1-130 Number of AWSs (FAWSDS program) 3-3
Sign on 1-131, 1-132 Number of data files (FAWSDS program) 3-3
Preload programs 1-81 Size of each AWS (FAWSDS program) 3-3
See also Initialization parameters, Advantage Format
CA-Roscoe 1-12 Description 3-2
Validation 1-8, 1-9, 1-10 Initialization parameters
Advantage CA-Roscoe JCL Used in current execution (ROSTAT
DD statements 1-133 program) 4-81
EXEC statement requirements 1-11 Maintenance
PARM field options 1-11 Summary of Programs 3-1
Region requirement 1-11 Paging technique 2-11, 2-12
Samples 1-142 Produce accounting records 1-30, 1-31
AJOB Initialization Parameter 1-34 Recovery
During initialization 1-38
SAVEAWS program 3-5

X-2 Programs and Utilities Guide


AWS (continued) CHAR= Initialization Parameter 1-56
Reports Character Set
Reformatted file statistics (FAWSDS Define default 1-57
program) 3-2 Define languages 1-56
AWS Cache Facility Character Translation
Activate and define 1-36 Set Default 1-128
AWS files CHARDFLT= Initialization Parameter 1-57
DD statement requirements 1-133 CLLEXT= Initialization Parameter 1-57
AWS Reports CMDISABLE= Initialization Parameter 1-58
Using Advantage CA-Earl 2-9, 2-10, 2-12 CMDLINES= Initialization Parameter 1-117
AWSAWS#= option CMQE= Initialization Parameter 1-59
FAWSDS program 3-3 COL control statement (LIBSERVE program) 4-15
AWSCACHE= Initialization Parameter 1-36 COMCHAR= Initialization Parameter 1-59
AWSDAYS= Initialization Parameter 1-37 Comma repeat symbol xxxi
AWSDBLK= option Command Delimiter
FAWSDS program 3-3 Set default
AWSDS= option For PF/PA Keys 1-123
FAWSDS program 3-3 For Primary Commands 1-118
AWSLIM= Initialization Parameter 1-37 For Screen Split 1-123
AWSSIZE= option Command queue elements, define number of 1-59
FAWSDS program 3-3 Command recall buffer, define size of 1-60
Commands
Disable at Initialization 1-58
B COMPRESS command
BACKUP option Control ZZZZZCMP member creation 1-43
(LIBUTIL program) 4-37 Define level of data set control 1-41
Backup procedures Define maximum concurrent requests 1-42
Added/changed members Define program invoked 1-43
LIBBKUP program 4-4 Console control
All members Advantage CA-Roscoe initialization
(LIBUTIL program) 4-37 parameters 1-91
LIBBKUP program 4-2 Entering Advantage CA-Roscoe initialization
List backup file contents (LIBUTIL parameters 1-10
program) 4-41 CONSOLE Initialization Parameter 1-91
Members by key Console messages, control Advantage
(LIBUTIL program) 4-38 CA-Roscoe 1-92
Selected members (LIBBKUP program) 4-5 Control Statements
Batch Advantage CA-Roscoe execution ACCTDUMP program 2-5
DD statement requirement 1-133 DISAUTHO program 5-3, 5-4
Description 1-4, 1-5 FAWSDS program 3-3
JCL example 1-142 LIBBKUP program
BKUPKEY option (LIBUTIL program) 4-38 All members 4-2
BKUPLIST option (LIBUTIL program) 4-41 Backup added/changed members 4-4
BKUPSUM option (LIBUTIL program) 4-41 Backup selected members 4-5
BREAK= Initialization Parameter 1-55 LIBINACT program 4-7
BYPSRPF= Initialization Parameter 1-99 LIBSERVE program 4-13—4-31
LIBUTIL program
C Add library 4-34
Alter RESERVE 4-36
CCFIREAD, preload 1-81
Backup by key 4-39
Backup, full 4-37
Format libraries 4-40

Index X-3
Control Statements (continued) DD Statements (continued)
LIBUTIL program (continued) LIBUTIL program
List backup file contents 4-41 Add library 4-34
Reclaim dead blocks 4-43 Alter RESERVE 4-36
Restore all member 4-46 Backup by key 4-39
Restore by key 4-48 Backup, full 4-37
Restore by member 4-54 Format libraries 4-40
Restore by prefix 4-51 List backup file contents 4-41
Restore to key 4-50 Reclaim dead blocks 4-43
ROSCOPY program 4-56—4-59 Restore all member 4-46
ROSDATA program 4-63—4-71 Restore by key 4-48
ROSMAILS program 4-77, 4-78 Restore by member 4-54
ROSTAT program 4-83 Restore by prefix 4-52
SAVEAWS program 3-5 Restore to key 4-50
TREPORT program 5-8 ROSCOE program 1-133—1-138
UPSLIST program 5-13 ROSCOPY program 4-60, 4-61
COPY control statement (ROSCOPY program) 4-57, ROSDATA program 4-72
4-58 ROSMAILS program 4-79
CRBUF= Initialization Parameter 1-60 ROSTAT program 4-83
CURSOR= Initialization Parameter 1-117 SAVEAWS program 3-5
TREPORT program 5-9
UPSLIST program 5-13
D Dead blocks, Reclaim library (LIBUTIL
D PARM field option (DISAUTHO program) 5-2 program) 4-42
Data Set Facility DECLARE statement
Advantage CA-Roscoe initialization Assign arrays
parameters 1-39—1-51 Define maximum 1-99
Define enqueue type 1-47 Default values (syntax diagrams) xxxii
Define search limit defaults 1-44 DELETE (PARM field option)
DSCB empty control 1-44 ROSMAILS program 4-77
Produce accounting records 1-30, 1-31 DELETE command
Data Set Recall Require member confirmation 1-84
Set action taken for DFHSM migrated data DELETE control statement
sets 1-47 LIBSERVE program 4-16
DATE control statement DELETE= Initialization Parameter 1-84
TREPORT program 5-8 Deleting
Date Format All members for key (ROSMAILS program) 4-78
Define 1-60 DISPLAY authorization table (DISAUTHO
DATEFORM= Initialization Parameter 1-60 program) 5-2
DATEFUN Function Inactive members (LIBSERVE program) 4-26,
Define date format 1-60 4-27
DD Statements Members with invalid names (LIBSERVE
ACCTDUMP Program 2-5 program) 4-26, 4-27
DISAUTHO program 5-5 Monitor-created members (LIBSERVE
FAWSDS program 3-3, 3-4 program) 4-26, 4-27
LIBBKUP program SAVAWSnn members (LIBSERVE
All members 4-2, 4-3 program) 4-26, 4-27
Backup added/changed members 4-4, 4-5 Specific members (LIBSERVE program) 4-16
Backup selected members 4-5, 4-6 ZZZZZ-named members (LIBSERVE
LIBINACT program 4-10 program) 4-26, 4-27
LIBSERVE program 4-31

X-4 Programs and Utilities Guide


DELIMIT= Initialization Parameter 1-118 EARLRPS (report definition) 2-16
Delimiters EARLRSR (report definition) 2-12, 2-13
syntax diagrams, use in xxix EARLRTM (report definition) 2-18, 2-19, 2-20, 2-21
Delta backup (LIBBKUP program) 4-4 Edit
Dialog management facility (DMF) see Locate 4-17
Define prefix 1-100 String in member, offline (LIBSERVE
DISABLE= Initialization Parameter 1-61 program) 4-20
DISAUTHO program EDIT control statement (LIBSERVE program) 4-17,
DD statements 5-5 4-20
Description 5-2 EDITCHNG= Initialization Parameter 1-118
JCL, sample 5-5 END Initialization Parameter 1-61
PARM field options 5-2 ENQTYPE= Initialization Parameter 1-47
Return codes 5-5 EOF= Initialization Parameter 1-119
SYSIN control statements 5-3, 5-4 Escape sequence commands
Using DISAUTHO= initialization parameter 1-34 Define PF key 1-98
DISAUTHO= Initialization Parameter 1-34 Define special character 1-97
DISKADR control statement (LIBSERVE ESCAPE= Initialization Parameter 1-75
program) 4-16 ETSALLOC= Initialization Parameter 1-75
DISPLAY authorization table ETSO
Define member containing 1-34 Advantage CA-Roscoe initialization
DISPLAY routine parameters 1-75—1-82
Advantage CA-Roscoe initialization CLLEXIT used for TSO commands 1-78
parameters 1-34 DD statement requirement 1-134
DMF Defining
see Dialog management facility 1-100 Maximum number of allocatable file 1-75
DMFPFX= Initialization Parameter 1-100 Member containing EPL 1-77
DOTPFX= Initialization Parameter 1-100 Search criteria for called programs 1-80
DSNBLDL= Initialization Parameter 1-39 SET ESCAPE string 1-75
DSNCFRMD= Initialization Parameter 1-40 SYSOUT data set use 1-79
DSNCFRMM= Initialization Parameter 1-40 Time Slice Value 1-80
DSNCLIST= Initialization Parameter 1-41 Enable TSO exec processing 1-76
DSNCMENQ= Initialization Parameter 1-41 EPL entry for TSO commands 1-76
DSNCMLIM= Initialization Parameter 1-42 Preload programs 1-81
DSNCMLST= Initialization Parameter 1-43 Search EPL for TSO commands 1-78
DSNCMPGM= Initialization Parameter 1-43 Search ETSOLIB concatenation for TSO
DSNCNT= Initialization Parameter 1-44 commands 1-77
DSNEMPTY= Initialization Parameter 1-44 Usage report
DSNINDEX= Initialization Parameter 1-45 Using Advantage CA-Earl 2-15
DSNLPRD2= Initialization Parameter 1-46 ETSOEPL= Initialization Parameter 1-76
DSNLPSWD= initialization parameter 1-46 ETSOEXEC= Initialization Parameter 1-76
DSNRECAL= initialization parameter 1-47 ETSOLIB= Initialization Parameter 1-77
ETSOPGMS= Initialization Parameter 1-77
ETSOSRCH= Initialization Parameter 1-78
E ETSOXIT= Initialization Parameter 1-78
EARLAWS (report definition) 2-9, 2-10 ETSRPS= Initialization Parameter 1-79
EARLDEF (file definition) 2-7, 2-8 ETSSLICE= Initialization Parameter 1-80
EARLJCL, Sample 2-8 ETSSRCH= Initialization Parameter 1-80
EARLMON (report definition) 2-15 EXECPFX= Initialization Parameter 1-101
EARLROSC (report definition) 2-13 EXIT option
EARLRPF (report definition) 2-16 (ACCTDUMP program) 2-4

Index X-5
EXIT= (PARM field option) Initialization parameters, Advantage CA-Roscoe
ROSMAILS program 4-77 ACCTBUFF= 1-28
EXTSEC= Initialization Parameter 1-61 ACCTOPT= 1-28
ACCTREC= 1-30, 1-31
ACCTROS= 1-32
F ACCTSMF= 1-32
FAWSDS program ACFEXT= 1-52
DD statements 3-3, 3-4 AJOB 1-34
Description 3-2 ALLRECAL= 1-39, 1-48
JCL, sample 3-4 ARRAYMAX= 1-99
PARM field options 3-3 AUTINTVL= 1-52
Report, description of 3-2 AUTOFF= 1-53
Return codes 3-4 AUTOFVAL= 1-53
SYSIN control statements 3-3 AUTOIND= 1-116
FILL= Initialization Parameter 1-119 AUTOINS= 1-116
FKEY PARM field option (UPSLIST program) 5-12 AUTTLOCK= 1-54
FORMAT option (LIBUTIL program) 4-40 AUTTLVAL= 1-55
Formatting AWSCACHE= 1-36
AWS (FAWSDS program) 3-2 AWSDAYS= 1-37
Libraries (LIBUTIL program) 4-40 AWSLIM= 1-37
Full library backup BREAK= 1-55
LIBBKUP program 4-2 BYPSRPF= 1-99
LIBUTIL program 4-37 CHAR= 1-56
CHARDFLT= 1-57
G CLLEXT= 1-57
CMDISABL= 1-58
GROUP control statement (DISAUTHO
CMDLINES= 1-117
program) 5-4
CMQE= 1-59
COMCHAR= 1-59
H CONSOLE 1-91
HEADER control statement CRBUF= 1-60
TREPORT program 5-8 CURSOR= 1-117
HELLO message DATEFORM= 1-60
Advantage CA-Roscoe initialization DELETE= 1-84
parameter 1-131 DELIMIT= 1-118
HELLO= Initialization Parameter 1-131 DISABLE= 1-61
HELP facility DISAUTHO= 1-34
Define prefix DMFPFX= 1-100
HELPPFX 1-84 DOTPFX= 1-100
HELPPFX1 1-85 DSNBLDL= 1-39
HELPPFX= Initialization Parameter 1-84 DSNCFRMD= 1-40
HELPPFX1= Initialization Parameter 1-85 DSNCFRMM= 1-40
DSNCLIST= 1-41
DSNCMENQ= 1-41
I DSNCMLIN= 1-42
IMPASIS Initialization Parameter 1-48 DSNCMLST= 1-43
IMPORT command DSNCMPGM= 1-43
Define translation default 1-48 DSNCNT= 1-44
IN= control statement (LIBUTIL program) 4-51 DSNEMPTY= 1-44
INFRECAL= Recall specification Parameter 1-48 DSNINDEX= 1-45
DSNLPRD2= 1-46

X-6 Programs and Utilities Guide


Initialization parameters, Advantage CA-Roscoe Initialization parameters, Advantage CA-Roscoe
(continued) (continued)
DSNLPSWD= 1-46 NSNAATTN= 1-67
DSNRECAL= 1-47 NTOATTN= 1-93
EDITCHNG= 1-118 OFF= 1-103
END 1-61 OFFRPF= 1-104
ENQTYPE= 1-47 ONRPF= 1-104
EOF= 1-119 Overview 1-12, 1-13
ESCAPE= 1-75 PASSWORD= 1-67
ETSALLOC= 1-75 PAUSE 1-89
ETSOEPL= 1-76 PERMVARS= 1-105
ETSOEXEC= 1-76 PFKDELIM= 1-123
ETSOLIB= 1-77 PFSPLIT= 1-123
ETSOPGMS= 1-77 PRELOAD= 1-81
ETSOSRCH= 1-78 PRESERVE= 1-124
ETSOXIT= 1-78 PRVEXT= 1-68
ETSRPS= 1-79 PSCBUID= 1-82
ETSSLICE= 1-80 PSCBUNIT= 1-69
ETSSRCH= 1-80 PSCBUSER= 1-82
EXECPFX= 1-101 PUSHDEF= 1-69, 1-105
EXTSEC= 1-61 RCSESCCH= 1-97
FILL= 1-119 RCSESCPF= 1-98
HELLO 1-131 RCSGEN= 1-93
HELPPFX= 1-84 RCSTRACE= 1-94
HELPPFX1= 1-85 RDMBLOCK= 1-106
IMPASIS 1-48 RECALNUM= 1-49
JOBEXT= 1-63 RECALVL2= 1-50
LIBACCES= 1-85 RECALVL3= 1-51
LIBALTER= 1-86 RECALVOL= 1-50
LIBCACHE= 1-87 RECVRAWS= 1-38
LIBCFRMM= 1-87 RESHLQ= 1-70
LIBEXT= 1-63 RESPLINE= 1-124
LIBRCCF= 1-49 RESTART= 1-108
LIBXLIB= 1-88 ROSAPPL= 1-94
LOOP= 1-101 ROSGBL= 1-35
LOOPDFLT= 1-102 ROSGNAME= 1-70
LOOPRST= 1-102 ROSID= 1-71
MASTER= 1-120 ROSLOG= 1-92
MIX= 1-120 ROSMSG= 1-92
MODE= 1-121 ROSPRTCT= 1-95
MONEXT= 1-64 RPFEXT= 1-71
MONLEVEL= 1-122 RPFLABEL= 1-107
MONTRAP= 1-122 RPSCSECT= 1-109
MPL= 1-64 RPSKEY= 1-109
MSGCLASS= 1-65 RPSNOTFY= 1-125
NOLRM 1-65 RPSPFX= 1-110
NONSWAP 1-66 RTM= 1-111
NOPROMPT 1-91 RTMCFCMD= 1-111
NOSDUMP 1-66 RTMCFCPU= 1-112
NOSPIE 1-67 RTMCFDIO= 1-112
NOTIFY 1-35 RTMCMARK= 1-113

Index X-7
Initialization parameters, Advantage CA-Roscoe JCL, sample (continued)
(continued) Library members (continued)
RTMINTVL= 1-113 Backup all (LIBBKUP) 4-3
RTMLIB= 1-114 Backup all (LIBUTIL) 4-38
RTMSYNC= 1-114 Backup by key (LIBUTIL) 4-40
RTMTMARK= 1-115 Backup selected (LIBBKUP) 4-6
RTMXMIT= 1-115 Copy from data set (ROSDATA) 4-75
RUN= 1-89 Copy to data set (ROSCOPY) 4-61
SAVEATTR= 1-125 List attributes/description 4-80
SCROLL= 1-126 List backup file contents 4-42
SEARCH= 1-127 List inactive (LIBINACT) 4-11
See also Advantage CA-Roscoe Maintenance (LIBSERVE) 4-32
initialization 1-12 Restore all (LIBUTIL) 4-47
SEND= 1-131 Restore by key (LIBUTIL) 4-49
SIGNON= 1-132 Restore by prefix (LIBUTIL) 4-53
SONMSG= 1-132 Restore to key (LIBUTIL) 4-51
SRTDDPFX 1-72 LIBUTIL program
SRTREGN 1-72 Restore by member 4-55
SRTSTORG 1-73 Line count violation report 4-80
STANDARD= 1-128 List members on backup file 4-42
STATS= 1-128 Produce ROSTAT report 4-83
SUBINCL 1-129 Restore
SUBNOSEQ 1-129 All members (LIBUTIL) 4-47
SUBWIDTH 1-130 Members by key (LIBUTIL) 4-49
TERMSO= 1-95 Members by prefix (LIBUTIL) 4-53
TEST 1-73 Members to key (LIBUTIL) 4-51
UPSEXT= 1-74 ROSCOE program 1-140, 1-141, 1-142
VTAM= 1-96 TREPORT program 5-10
XTPM= 1-96 UPSLIST program 5-14
INKEY= control statement (LIBUTIL program) 4-50 JES2
Define internal reader message class 1-65
dynamic spool pack configuration 1-27
J operator commands 1-27
JCK routine JES3
DD statement requirements 1-135 Define internal reader message class 1-65
JCL, sample JOBEXT= Initialization Parameter 1-63
Acconting files, dump (ACCTDUMP) 2-6
Advantage CA-Earl Reports 2-8
AWS K
Format (FAWSDS program) 3-4 KEY control statement
Recover user (SAVEAWS program) 3-6 LIBINACT program 4-8
Backup libraries LIBSERVE program 4-20
By key (LIBUTIL) 4-40 ROSMAILS program 4-78
Full (LIBUTIL) 4-38 Key option
DISAUTHO program 5-5 LIBSERVE program 4-13
Libraries, user ROSCOPY program 4-56
Add library (LIBUTIL) 4-35 ROSDATA program 4-63
Alter RESERVE (LIBUTIL) 4-37 KEY PARM field option (UPSLIST program) 5-12
Format libraries (LIBUTIL) 4-41 KEY= control statement
Reclaim unused blocks (LIBUTIL) 4-44 LIBUTIL program 4-39
Library members
Backup added/changed (LIBBKUP) 4-5

X-8 Programs and Utilities Guide


Keywords (syntax diagrams) xxviii Libraries, user (continued)
Compare library index capacity vs
members 4-82
L DD statement requirements 1-133
L PARM field option (DISAUTHO program) 5-2 Dead blocks, reclaim (LIBUTIL program) 4-42
Language Character Set Format (LIBUTIL program) 4-40
Codes 1-56 Gather statistics about 1-28
LIBACCES= Initialization Parameter 1-85 Line count violations
LIBALTER= Initialization Parameter 1-86 (ROSMAILS program) 4-76
LIBBKUP program List Contents
Backup added/changed members Backup file (LIBUTIL program) 4-41
DD statements 4-4, 4-5 Member 4-23
PARM field options 4-4 Monitor member 4-24, 4-26
Return codes 4-5 Maintenance
Sample JCL 4-5 Summary of Programs 4-1
SYSIN control statements 4-4 Produce library index entries listing 4-21, 4-22
Backup selected members RESERVE
DD statements 4-5, 4-6 Change only (LIBUTIL program) 4-35
PARM field options 4-5 Change when formatting (LIBUTIL
Return codes 4-6 program) 4-40
Sample JCL 4-6 Change with restore (LIBUTIL program) 4-44
SYSIN control statements 4-5 Restore
Description 4-2 All members (LIBUTIL program) 4-44
Full backup By key (LIBUTIL program) 4-47, 4-49
DD statements 4-2, 4-3 By member (LIBUTIL program) 4-53, 4-54,
JCL, sample 4-3 4-55
PARM field options 4-2 By prefix (LIBUTIL program) 4-51, 4-52, 4-53
Return codes 4-3 To key (LIBUTIL program) 4-49, 4-51
SYSIN control statements 4-2 Statistics report on (ROSTAT program) 4-81
LIBCACHE= Initialization Parameter 1-87 Library Administrator
LIBCFRMM= Initialization Parameter 1-87 LIBSERVE 4-12
LIBEXT= Initialization Parameter 1-63 ROSDATA 4-62
LIBINACT program LIBRARY control statement (LIBSERVE
DD statements 4-10 program) 4-21, 4-22
Description 4-7 Library Facility
PARM field options 4-7 Advantage CA-Roscoe initialization
Return codes 4-10 parameters 1-84—1-88
Sample JCL 4-11 Set
Sample Reports 4-11 Member Delete Confirmaton 1-87
SYSIN control statements 4-7, 4-8, 4-9, 4-10 Member List Access 1-85
Libraries, user Selection List Modification 1-86
Add library (LIBUTIL program) 4-34 Library Member
Alter RESERVE (LIBUTIL program) 4-35 Access Attribute
Backup Set Default 1-125
Added/changed members (LIBBKUP Add from data set (ROSDATA
program) 4-4 program) 4-64—4-68
By key (LIBUTIL program) 4-38 Attribute information, get (ROSMAILS
Full (LIBBKUP program) 4-2 program) 4-76
Full (LIBUTIL program) 4-37 Backup
Selected members (LIBBKUP program) 4-5 Added/changed members (LIBBKUP
Cache Facility program) 4-4
Define size of 1-87 Full (LIBBKUP program) 4-2

Index X-9
Library Member (continued) LIBSTAT option (ACCTDUMP program) 2-4
Backup (continued) LIBUTIL program
Selected members (LIBBKUP program) 4-5 Add library
Copying DD statements 4-34
From data set (ROSDATA program) 4-62 Description 4-34
To data set (ROSCOPY program) 4-56 PARM field options 4-34
Deleting Return codes 4-34
All for key (ROSMAILS program 4-78 Sample JCL 4-35
Inactive (LIBSERVE program) 4-26, 4-27 SYSIN control statements 4-34
Invalidly named (LIBSERVE program) 4-26, Alter RESERVE
4-27 DD statements 4-36
Monitor-created (LIBSERVE program) 4-26, Description 4-35
4-27 PARM field options 4-36
SAVAWSnn (LIBSERVE program) 4-26, 4-27 Return codes 4-36
Specific (LIBSERVE program) 4-16 Sample JCL 4-37
Unowned (ROSMAILS program) 4-76 SYSIN control statements 4-36
ZZZZZ-named (LIBSERVE program) 4-26, Backup by key
4-27 DD statements 4-39
Disk address of 4-16 Description 4-38
Edit string, offline (LIBSERVE program) 4-20 PARM field options 4-38
Exceeding line count maximum (ROSMAILS Return codes 4-39
program) 4-77 Sample JCL 4-40
Inactive members, list 4-7 SYSIN control statements 4-39
List Backup, full
Contents, all or specific 4-23 DD statements 4-37
Inactive 4-7 Description 4-37
Monitor member contents 4-24, 4-26 PARM field options 4-37
Locate string, offline (LIBSERVE program) 4-29, Return codes 4-38
4-31 Sample JCL 4-38
Module control table address of 4-16 SYSIN control statements 4-37
Produce library index entries listing 4-21, 4-22 Description 4-33
Renaming Format libraries
LIBSERVE program 4-27 DD statements 4-40
LIBUTIL program) 4-54 Description 4-40
Replace string, offline (LIBSERVE program) 4-17 PARM field options 4-40
Restore Return codes 4-41
All (LIBUTIL program) 4-44 Sample JCL 4-41
By key (LIBUTIL program) 4-47, 4-49 SYSIN control statements 4-40
By member (LIBUTIL program) 4-53, 4-54, Library members
4-55 Restore specific (LIBUTIL) 4-55
By prefix (LIBUTIL program) 4-51, 4-52, 4-53 List backup file contents
To key (LIBUTIL program) 4-49, 4-51 DD statements 4-41
Size of (ROSMAILS program) 4-76 Description 4-41
LIBRCCF= Initialization Parameter 1-49 PARM field options 4-41
LIBSERVE program Return codes 4-42
DD statements 4-31 Sample JCL 4-42
Description 4-12, 4-13 SYSIN control statements 4-41
PARM field options 4-13 Reclaim dead blocks
Return codes 4-32 DD statements 4-43
Sample JCL 4-32 Description 4-42
SYSIN control statements 4-13—4-31 PARM field options 4-43
Return codes 4-43

X-10 Programs and Utilities Guide


LIBUTIL program (continued) LISTMON control statement (LIBSERVE
Reclaim dead blocks (continued) program) 4-24, 4-26
Sample JCL 4-44 Locate
SYSIN control statements 4-43 String in member, offline (LIBSERVE
Restore all members program) 4-29, 4-31
DD statements 4-46 String to replace (LIBSERVE program) 4-17
Description 4-44 LOOP= Initialization Parameter 1-101
PARM field options 4-45, 4-46 LOOPDFLT= Initialization Parameter 1-102
Return codes 4-47 LOOPRST= Initialization Parameter 1-102
Sample JCL 4-47
SYSIN control statements 4-46
Restore by key M
DD statements 4-48 MASTER= Initialization Parameter 1-120
Description 4-47 MEMBER control statement (ROSCOPY
PARM field options 4-47 program) 4-58
Return codes 4-49 MESSAGE command
Sample JCL 4-49 Control use of 1-92
SYSIN control statements 4-48 MIX= Initialization Parameter 1-120
Restore by member MODE= Initialization Parameter 1-121
DD statements 4-54 MONEXT= Initialization Parameter 1-64
Description 4-53, 4-54 Monitor commands
PARM field options 4-53 see Monitor routines 2-15
Return codes 4-55 Monitor Routines
SYSIN control statements 4-54 Advantage CA-Roscoe Initialization
Restore by prefix parameters 1-89, 1-90
DD statements 4-52 Controlling
Description 4-51, 4-52 Informatinal message display 1-122
PARM field options 4-51 Prompt/error message display 1-122
Return codes 4-53 Usage report
Sample JCL 4-53 Using Advantage CA-Earl 2-15
SYSIN control statements 4-51 Used in current execution (ROSTAT
Restore specific members (LIBUTIL) 4-55 program) 4-81
Restore to key Monitor writing
Description 4-49 Define
PARM field options 4-49 Commands to be available to users 1-89
Return codes 4-51 Pause count 1-89
Sample JCL 4-51 Monitor-created members
SYSIN control statements 4-50 Deleting (LIBSERVE program) 4-26, 4-27
LIBXLIB= Initialization Parameter 1-88 List contents of all or specific 4-24, 4-26
Line Count Violations Report MONLEVEL= Initialization Parameter 1-122
Description (ROSMAILS program) 4-76, 4-77 MONTRAP= Initialization Parameter 1-122
LINECNT control statement MPL= Initialization Parameter 1-64
TREPORT program 5-8 MSGCLASS= Initialization Parameter 1-65
LINECNT= (PARM field option)
LIBSERVE program 4-13
ROSMAILS program 4-77
N
Newsletter Facility
List
Advantage CA-Roscoe initialization
see Reports 4-7
parameter 1-131
LIST control statement
NOCLEAR option
LIBINACT program 4-9, 4-10
LIBUTIL program 4-45
LIBSERVE program 4-23

Index X-11
NOCONS option ONRPF= Initialization Parameter 1-104
Restore by member (LIBUTIL program) 4-53 Operator
NOFORMAT option Advantage CA-Roscoe initialization
LIBUTIL program 4-45 parameters 1-91, 1-92
NOLIBSTAT option (ACCTDUMP program) 2-4 Controlling
NOLIST option Advantage CA-Roscoe console messages 1-92
Backup by key (LIBUTIL program) 4-38 Initialization prompting 1-91
Restoring MESSAGE command 1-92
All members (LIBUTIL program) 4-46 Define communications character 1-59
By key (LIBUTIL program) 4-47 ORDER control statement
By member (LIBUTIL program) 4-53 TREPORT program 5-8
By prefix (LIBUTIL program) 4-51 OUT= control statement (LIBUTIL program) 4-51
To key (LIBUTIL program) 4-49 OUTKEY= control statement (LIBUTIL
With BACKUP option (LIBUTIL program) 4-37 program) 4-50
NOLRM Initialization Parameter 1-65 Overview
Non-Displayable Characters Advantage CA-Roscoe initialization
Set default 1-124 parameters 1-12, 1-13
NONSWAP Initialization Parameter 1-66 Maintenance programs
NOPROMPT Initialization Parameter 1-91 Accounting 2-1
NOREPLACE option AWS 3-1
Restoring Libraries, user 4-1
By key (LIBUTIL program) 4-47
By member (LIBUTIL program) 4-53
By prefix (LIBUTIL program) 4-51 P
libraries (LIBUTIL program) 4-46 Parentheses
To key (LIBUTIL program) 4-49 syntax diagrams, use in xxix
NOREPORT (PARM field option) PARM field options
ROSMAILS program 4-77 ACCTDUMP program 2-4
NOSDUMP Initialization Parameter 1-66 DISAUTHO program 5-2
NOSNAP option (LIBUTIL program) 4-43 FAWSDS program 3-3
NOSPIE Initialization Parameter 1-67 LIBBKUP program
Notify All members 4-2
Job complete Backup added/changed members 4-4
Display JES status messages 1-35 Backup selected members 4-5
RPS print request complete LIBINACT program 4-7
Activate 1-125 LIBSERVE program 4-13
NOTIFY Initialization Parameter 1-35 LIBUTIL program
NSNAATTN= Initialization Parameter 1-67 Add library 4-34
NTOATTN= Initialization Parameter 1-93 Alter RESERVE 4-36
Backup by key 4-38
Backup, full 4-37
O Format libraries 4-40
OFF command List backup file contents 4-41
Control use in Reclaim dead blocks 4-43
RPF Programs 1-103 Restore all member 4-45, 4-46
OFF= Initialization Parameter 1-103 Restore by key 4-47
OFFON command Restore by member 4-53
Control use in Restore by prefix 4-51
RPF Programs 1-103 Restore to key 4-49
OFFRPF= Initialization Parameter 1-104 ROSCOE program 1-11
ROSCOPY program 4-56

X-12 Programs and Utilities Guide


PARM field options (continued) RCS (continued)
ROSDATA program 4-63 Escape sequence commands
ROSMAILS program 4-77 Define PF key 1-98
ROSTAT program 4-82 Define special character 1-97
SAVEAWS program 3-5 Trace facility
TREPORT program 5-7 Activate during Advantage CA-Roscoe
UPSLIST program 5-12 initialization 1-94
Partial library backup DD statement requirement 1-135
Added/changed members (LIBBKUP RCSESCCH= Initialization Parameter 1-97
program) 4-4 RCSESCPF= Initialization Parameter 1-98
Selected members (LIBBKUP program) 4-5 RCSGEN= Initialization Parameter 1-93
Password, define universal 1-67 RCSTRACE= Initialization Parameter 1-94
PASSWORD= Initialization Parameter 1-67 RDM (RPF Data Management)
PAUSE Initialization Parameter 1-89 Define size 1-106
PERMVARS= Initialization Parameter 1-105 RDMBLOCK= Initialization Parameter 1-106
PFKDELIM= Initialization Parameter 1-123 RECALNUM= Recall Package Parameter 1-49
PFSPLIT= Initialization Parameter 1-123 RECALVL2= Volume serial Parameter 1-50
PREFIX PARM field option (UPSLIST RECALVL3= Volume serial Parameter 1-51
program) 5-12 RECALVOL= Volume serial Parameter 1-50
PRELOAD= Initialization Parameter 1-81 RECLAIM option (LIBUTIL program) 4-43
PRESERVE= Initialization Parameter 1-124 RECVRAWS program 1-38
Profiles, list all (UPSLIST program) 5-11 RECVRAWS= Initialization Parameter
Programs (ROSCOE program) 1-38
comma REGION= parameter (ROSCOE) 1-11
repeat symbol, use in xxxi RENAME control statement (LIBSERVE
parentheses program) 4-27
syntax diagrams, use in xxix Renaming
punctuation Library member (LIBSERVE) 4-27
syntax diagrams, use in xxviii Report
PRVEXT= Initialization Parameter 1-68 DISPLAY authorization table, list (DISAUTHO
PSCBUID= Initialization Parameter 1-82 program) 5-2
PSCBUNIT field Reports
Define default unit name 1-69 Accounting
PSCBUNIT= Initialization Parameter 1-69 About dumped files (ACCTDUMP) 2-3
PSCBUSER field AWS
Building 1-82 Configuration (ROSTAT program) 4-81
Define contents of 1-82 Formatting information (FAWSDS
PSCBUSER= Initialization Parameter 1-82 program) 3-2
Punctuation marks (syntax diagrams) xxviii Statistics (Using Advantage
PURGE control statement (LIBSERVE CA-Earl) 2-9—2-12
program) 4-26, 4-27 Deleted library Members (LIBSERVE
PURGE option program) 4-26, 4-27
LIBSERVE program 4-13 ETSO usage
PUSHDEF= Initialization Parameter 1-69, 1-105 Using Advantage CA-Earl 2-15
Library members
All restored (LIBUTIL program) 4-44
R Attribute information (ROSMAILS
RCS program) 4-76
Advantage CA-Roscoe initialization Backed up (LIBUTIL program) 4-37
parameters 1-93—1-98 Contents of all or specific members 4-23
Define member containing definition 1-93 Contents of all or specific Monitor
members 4-24, 4-26

Index X-13
Reports (continued) Response-Time Monitor (RTM)
Library members (continued) Activate monitoring 1-111
Copied from data set (ROSDATA) 4-72 Advantage CA-Roscoe initialization
Copied to data set (ROSCOPY) 4-60 parameters 1-111—1-115
Dead block statistics 4-42 Defining
Deleted as unowned (ROSMAILS Complexity factors 1-111
program) 4-76 Complexity levels 1-113
Inactive members 4-7 How time computed 1-115
Index entries listing 4-21, 4-22 Interval 1-113
List inactive members (LIBINACT) 4-11 Member containing monitoring criteria 1-114
Member names on backup file (LIBUTIL Synchronization requirement 1-114
program) 4-41 Time buckets 1-115
Restored by key (LIBUTIL program) 4-47, Report
4-49 Using Advantage CA-Earl 2-18—2-21
Restored by Member (LIBUTIL Statistics explanation 2-22, 2-24, 2-25
program) 4-53, 4-54, 4-55 RESTART= Initialization Parameter 1-108
Restored by prefix (LIBUTIL program) 4-51, RESTKEY option
4-52, 4-53 Restore to key (LIBUTIL program) 4-49
Restored to key (LIBUTIL program) 4-49, Restore
4-51 User AWSs
Size of (ROSMAILS program) 4-76 During initialization 1-38
Statistics (ROSTAT program) 4-81 SAVEAWS program 3-5
Line count violations, Library member Restore members, all (LIBUTIL program) 4-44
(ROSMAILS program) 4-77 RESTORE option
Members backed up by key 4-39 LIBUTIL program 4-45
Monitor usage Return codes
Using Advantage CA-Earl 2-15 ACCTDUMP Program 2-6
ROSCOE initialization parameters (ROSTAT DISAUTHO program 5-5
program) 4-81 FAWSDS program 3-4
ROSCOE statistics 2-12, 2-13 LIBBKUP program
ROSCOE usage All members 4-3
Using Advantage CA-Earl 2-13 Backup added/changed members 4-5
RPF Backup selected members 4-6
Hyphens ending lines, report on 4-37 LIBINACT program 4-10
RPF executions 2-16 LIBSERVE program 4-32
RPS usage 2-16 LIBUTIL program
RTM statistics Add library 4-34
Statistics explanation 2-22, 2-24, 2-25 Alter RESERVE 4-36
Using Advantage CA-Earl 2-18—2-21 Backup by key 4-39
TREPORT report 5-6, 5-7 Backup, full 4-38
UPS profiles (UPSLIST program) 5-11 Format libraries 4-41
Users defined to Advantage CA-Roscoe (UPSLIST List backup file contents 4-42
program) 5-11 Reclaim dead blocks 4-43
RESERVE, user library Restore all member 4-47
Change (LIBUTIL program) 4-35 Restore by key 4-49
Change when formatting (LIBUTIL Restore by member 4-55
program) 4-40 Restore by prefix 4-53
Change with restore (LIBUTIL program) 4-44 Restore to key 4-51
RESHLQ= Initialization Parameter 1-70 ROSCOE program 1-139
RESPLINE= Initialization Parameter 1-124 ROSCOPY program 4-61
ROSDATA program 4-73, 4-74

X-14 Programs and Utilities Guide


Return codes (continued) ROSTAT program (continued)
ROSMAILS program 4-79 Return codes 4-83
ROSTAT program 4-83 SYSIN control statements 4-83
SAVEAWS program 3-6 ROSTAT report 4-81
TREPORT program 5-9 ROSTRACE macro 5-6
UPSLIST program 5-13 ROSUCNTL
ROSACTnn files Preload 1-81
See Accounting files 1-133 RPF Programs
ROSAPPL= Initialization Parameter 1-94 Advantage CA-Roscoe initialization
ROSCOPY program parameters 1-99—1-107
DD statements 4-60, 4-61 Control use of OFF 1-103
Description 4-56 Control use of OFFON 1-103
PARM field options 4-56 Define
Return codes 4-61 Label requirement 1-107
Sample JCL 4-61 Maximum elements in array 1-99
SYSIN control statements 4-56—4-59 Permanent variables 1-105
ROSDATA program Prefix for execution library 1-101
DD statements 4-72 Prefix for pseudo execution library 1-100
Description 4-62 Looping
JCL, sample 4-75 Define default 1-102
PARM field option 4-63 Define maximum allowed 1-101
Return codes 4-73, 4-74 Define RESET use 1-102
SYSIN control statements 4-63—4-71 Permanent variables, define maximum number
ROSEARL (input exit) 2-7, 2-8 of 1-105
ROSGBL Macro Produce accounting records 1-30, 1-31
Define load module version 1-35 Report on hyphens ending lines 4-37
ROSGBL= Initialization Parameter 1-35 Usage report 2-16
ROSGNAME= Initialization Parameter 1-70 RPFEXT= Initialization Parameter 1-71
ROSID= Initialization Parameter 1-71 RPFLABEL= Initialization Parameter 1-107
ROSLIBnn files RPS
See libraries, user 1-133 See also Definition' . 'See RPS definition'
ROSLOG= Initialization Parameter 1-92 Advantage CA-Roscoe initialization
ROSMAILS program parameters 1-108, 1-109, 1-110
DD statements 4-79 Control request completion notification 1-125
Description 4-76 Defining
JCL, sample 4-80 Restart default 1-108
PARM field options 4-77 SYSOUT data set use 1-79
Reports 4-76 Produce accounting records 1-30, 1-31
Return codes 4-79 Usage report 2-16
SYSIN control statements 4-77, 4-78 RPS Definition
ROSMAILS report 4-76 Define member containing definition 1-109
ROSMSG= Initialization Parameter 1-92 Define prefix for spool queue 1-110
ROSPRTCT= Initialization Parameter 1-95 Define sign-on key for spool queue 1-109
ROSRUSTI Sharing 1-3
Preload 1-81 RPSCSECT= Initialization Parameter 1-109
ROSTAT program RPSKEY= Initialization Parameter 1-109
DD statements 4-83 RPSNOTFY= Initialization Parameter 1-125
Description 4-81 RPSPFX= Initialization Parameter 1-110
JCL, sample 4-83 RTM
PARM field options 4-82 Produce accounting records 1-30, 1-31
Report, description of 4-81

Index X-15
RTM= Initialization Parameter 1-111 Selective (continued)
RTMCFCMD= Initialization Parameter 1-111 Restore
RTMCFCPU= Initialization Parameter 1-112 By key (LIBUTIL program) 4-47, 4-49
RTMCFDIO= Initialization Parameter 1-112 By member (LIBUTIL program) 4-53, 4-54,
RTMCMARK= Initialization Parameter 1-113 4-55
RTMINTVL= Initialization Parameter 1-113 By prefix (LIBUTIL program) 4-51, 4-52, 4-53
RTMLIB= Initialization Parameter 1-114 To key (LIBUTIL program) 4-49, 4-51
RTMSYNC= Initialization Parameter 1-114 SELKEY option
RTMTMARK= Initialization Parameter 1-115 LIBUTIL program
RTMXMIT= Initialization Parameter 1-115 Restore by key 4-47
RUN= Initialization Parameter 1-89 SELPFX option (LIBUTIL program) 4-51
SELREST option (LIBUTIL program) 4-53
SEND= Initialization Parameter 1-131
S SET AUTOINDENT command
SAVAWSnn members Set default 1-116
Define saving period 1-37 SET AUTOINSERT Command
Deleting (LIBSERVE program) 4-26, 4-27 Set default 1-116
Recover (SAVEAWS program) 3-5 SET CMDLINES command
SAVEATTR= Initialization Parameter 1-125 Set default 1-117
SAVEAWS program SET command
DD statements 3-5 Set default 1-118
Description 3-5 SET CURSOR command
JCL, sample 3-6 Set default 1-117
PARM field options 3-5 SET DISPLAY command
Return codes 3-6 Set defaults 1-121
SYSIN control statements 3-5 SET EDITCHNG command
SAVEAWS= initialization parameter Set default 1-118
With SAVEAWS program 3-5 SET EOF command
SCALE control statement (LIBSERVE Set default 1-119
program) 4-28 SET ESCAPE command
Scan Define default string 1-75
see Locate 4-29 SET FILL command
SCAN control statement (LIBSERVE program) 4-29, Set default 1-119
4-31 SET MASTER command
SCROLL= Initialization Parameter 1-126 Set defaults 1-120
Search SET MODE command
see Locate 4-29 Set default 1-124, 1-128
SEARCH= Initialization Parameter 1-127 Set search command defaults 1-120
Security SET MONTRAP Command
Define ETSO User Access 1-57 Set default 1-122
Define JES SPOOL User Access 1-63, 1-68 SET PFKDELIM command
Define Library Administrator Functions 1-63 Set default 1-123
Define Monitor Routine Access 1-64 SET RPSNOTFY Command
Define RPF User Access 1-71 Set default 1-125
Define to Advantage CA-Roscoe 1-61 SET SAVEATTR command
Define UPS User Access 1-74 Set default 1-125
Define User Sign-on Security 1-52 SET SCROLL command
Selective Set default 1-126
Backup SET SEARCH command
Added/changed members (LIBBKUP Set default 1-127
program) 4-4
Specific members (LIBBKUP program) 4-5

X-16 Programs and Utilities Guide


SET SPLIT command SUBNOSEQ Initialization Parameter 1-129
Set default 1-123 Subsession
SET STATS command Define number of concurrent 1-95
Set default 1-128 Definition 1-95
SET STMTCNT command SUBWIDTH Initialization Parameter 1-130
Define default 1-101, 1-102 Syntax diagrams xxviii
SET SUBMIT command reading (how to) xxviii—xxxiii
Set +INC statement expansion 1-129 SYSAWSn files
Set default width 1-130 See AWS files 1-133
Set use of sequence numbers 1-129 System address space 1-2
SET SYSID command SYSTEM control statement
Set default 1-124 (ROSMAILS program) 4-78
SET USERID command
Set default 1-124
Sign off T
Procedure, global Terminals
Define member containing 1-104 Define inactive period 1-53
Sign on Define inactivity rechecking period 1-52
Advantage CA-Roscoe initialization Lock facility
parameters 1-131, 1-132 Activate 1-54
Disable Define inactive period 1-55
Using initialization parameter 1-132 Sign-off facility, activate 1-53
Enable TERMSO= Initialization Parameter 1-95
Using initialization parameter 1-132 TEST Initialization Parameter 1-73
Messages TIME= parameter (ROSCOE) 1-11
Using initialization parameter 1-131, 1-132 TREPORT program
Newsletter/HELLO DD statements 5-9
Advantage CA-Roscoe initialization Description 5-6
parameter 1-131 JCL, sample 5-10
Procedure, global PARM field options 5-7
Define member containing 1-104 Report, description of 5-6, 5-7
Sign-off facility Return codes 5-9
See Terminal 1-53 SYSIN control statements 5-8
SIGNON= Initialization Parameter 1-132 TTY (and compatible) terminals
SIMULATE option (LIBUTIL program) 4-43 Defining
SONMSG= Initialization Parameter 1-132 Break value 1-55
SORTSIZE= (PARM field option)
ROSMAILS program 4-77
Space requirements
U
Unicenter CA-Look
Advantage CA-Roscoe region 1-11
Disable D ROSCOE command 1-65
SPIE exit
Universal password, define 1-67
Disable 1-67
UPS
SRTDDPFX= Initialization Parameter 1-72
List profiles (UPSLIST program) 5-11
SRTREGN= Initialization Parameter 1-72
UPSEXT= Initialization Parameter 1-74
SRTSTORG= Initialization Parameter 1-73
UPSLIST program
STANDARD= Initialization Parameter 1-128
DD statements 5-13
STATS= Initialization Parameter 1-128
Description 5-11
SUBINCL Initialization Parameter 1-129
JCL, sample 5-14
Submitting job(s)
PARM field options 5-12
Set defaults 1-129
Report, description of 5-11

Index X-17
UPSLIST program (continued)
Return codes 5-13
SYSIN control statements 5-13

V
Variables (syntax diagrams) xxviii
VERSIONn option (LIBUTIL program)
Designate type when foramtting 4-40
To change RESERVE 4-35
When restoring members 4-46
VTAM
Defining
Advantage CA-Roscoe application name 1-94
Advantage CA-Roscoe password on APPL
macro 1-95
Number of concurrent sessions 1-96
Value with NTOLINE EDIT= 1-93
VTAM= Initialization Parameter 1-96

X
XTPM
Define number of sessions 1-96
XTPM= Initialization Parameter 1-96

Z
ZZZZZ-prefixed members
Delete (LIBSERVE program) 4-26, 4-27

X-18 Programs and Utilities Guide

You might also like