iv

INCONTROLTM
for OS/390 and z/OS
Utilities Guide

Version 6.1.00

June 13, 2002

Copyright 2002 BMC Software, Inc., as an unpublished work. All rights reserved.
BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks
or trademarks of BMC Software, Inc. IBM and DB2 are registered trademarks of International Business Machines Corp. All
other registered trademarks or trademarks belong to their respective companies.
THE USE AND CONTENTS OF THIS DOCUMENTATION ARE GOVERNED BY THE SOFTWARE LICENSE
AGREEMENT ENCLOSED AT THE BACK OF THIS DOCUMENTATION.

Restricted Rights Legend

U.S. GOVERNMENT RESTRICTED RIGHTS. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT
LAWS OF THE UNITED STATES. Use, duplication, or disclosure by the U.S. Government is subject to restrictions set
forth in FAR Section 52.227-14 Alt. III (g)(3), FAR Section 52.227-19, DFARS 252.227-7014 (b) or DFARS 227.7202, as
amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101 CityWest Blvd., Houston, TX
77042-2827, USA. Any contract notices should be sent to this address.

Contacting BMC Software

You can access the BMC Software Web site at http://www.bmc.com. From this Web site, you can obtain information
about the company, its products, corporate offices, special events, and career opportunities.

United States and Canada

Outside United States and Canada

Address

Telephone

(01) 713 918 8800

Fax

(01) 713 918 8000

BMC Software, Inc.

2101 CityWest Blvd.
Houston TX 77042-2827

Telephone

713 918 8800 or

800 841 2031

Fax

713 918 8000

Customer Support
You can obtain technical support by using the Support page on the BMC Software Web site or by contacting Customer
Support by telephone or e-mail. To expedite your inquiry, please see Before Contacting BMC Software.

Support Web Site

You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support.html.
From this Web site, you can

read overviews about support services and programs that BMC Software offers
find the most current information about BMC Software products
search a database for problems similar to yours and possible solutions
order or download product documentation
report a problem or ask a question
subscribe to receive e-mail notices when new product versions are released
find worldwide BMC Software support center locations and contact information, including e-mail addresses, fax
numbers, and telephone numbers

Support by Telephone or E-mail

In the United States and Canada, if you need technical support and do not have access to the Web, call 800 537 1813.
Outside the United States and Canada, please contact your local support center for assistance. To find telephone and e-mail
contact information for the BMC Software support center that services your location, refer to the Contact Customer Support
section of the Support page on the BMC Software Web site at www.bmc.com/support.html.

Before Contacting BMC Software

Before you contact BMC Software, have the following information available so that Customer Support can begin working on
your problem immediately:

product information

product name
product version (release number)
license number and password (trial or permanent)

operating system and environment information

machine type
operating system type, version, and service pack or other maintenance level such as PUT or PTF
system hardware configuration
serial numbers
related software (database, application, and communication) including type, version, and service pack or
maintenance level

sequence of events leading to the problem

commands and options that you used

messages received (and the time and date that you received them)

product error messages

messages from the operating system, such as file system full
messages from related software

iii

iv

INCONTROL for OS/390 and z/OS Utilities Guide

Contents
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
Chapter 1

Introduction
Summary of Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
IOA Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
CONTROL-M Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
CONTROL-M/Analyzer Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
CONTROL-D and CONTROL-V Utilities. . . . . . . . . . . . . . . . . . . . . 1-6
CONTROL-O Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
CONTROL-M/Tape Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Chapter 2

IOA Utilities
IOABLCAL Build Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
IOACABPR Emergency CAB Control Block Disconnect . . . . . . . . . . 2-12
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
IOACLCND Clean the IOA Conditions File . . . . . . . . . . . . . . . . . . . . . 2-13
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Specifying AutoEdit Variables and Functions . . . . . . . . . . . . . . . . . . 2-15
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
IOACLRES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
IOACND Perform IOA Condition File or CONTROL-M Resources File
Adjustments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Parameters for Processing Prerequisite Conditions . . . . . . . . . . . . . . 2-18
Parameters for Processing Control Resources . . . . . . . . . . . . . . . . . . 2-19
Parameters for Processing Quantitative Resources . . . . . . . . . . . . . . 2-19
Activating the Utility (and Examples) . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22

BMC Software, Inc., Confidential and Proprietary Information

Contents

IOACCND Copy or Resize IOA Conditions File. . . . . . . . . . . . . . . . . . 2-23

Parameters and DDNAMEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
Activating the Utility (Example). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
IOACPLOG Copy the IOA Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
Copying to a Sequential File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
Copying to a Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
IOADBF Allocate or Format an IOA Access Method File . . . . . . . . . . 2-28
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28
DD Statement DAFILE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
IOA Access Method File Definition Parameters . . . . . . . . . . . . . . . . 2-29
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34
Multiple Extents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
Using the IOADPT Utility for Space Management . . . . . . . . . . . . . . 2-35
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
CONTROL-M/Analyzer Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
IOA Samples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
IOADBIB Rebuild Index Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
IOADBSR Sort Records in IOA Access Method Data Component. . . . 2-40
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40
Sort Control Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42
IOADCPY Recover an IOA Access Method File . . . . . . . . . . . . . . . . . 2-43
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
IOADIG Verify Integrity of IOA Access Method File Data Component2-46
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
IOA Samples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
IOADII Verify Integrity of IOA Access Method File Index Component2-49
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
IOADLD Load IOA Access Method File Contents . . . . . . . . . . . . . . . . 2-51
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-51
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52

BMC Software, Inc., Confidential and Proprietary Information

vi

INCONTROL for OS/390 and z/OS Utilities Guide

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
IOA Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-53
IOADPT Print IOA Access Method File Content . . . . . . . . . . . . . . . . . 2-54
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
IOA Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
IOADUL Unload IOA Access Method File Contents . . . . . . . . . . . . . . 2-56
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-56
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
IOA Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
IOAFRLOG - Allocate and Format the IOA Log File . . . . . . . . . . . . . . . 2-59
IOAFRNRS - Allocate and Format the IOA Manual Conditions File . . . 2-59
IOALDNRS Load IOA Conditions File . . . . . . . . . . . . . . . . . . . . . . . . 2-60
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
IOANOTE Write a Message to the IOA Log File . . . . . . . . . . . . . . . . . 2-63
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
IOAOPR - Issue Operator Commands using a Job or STC . . . . . . . . . . . 2-65
IOASDISC Emergency Subsystem Disconnect. . . . . . . . . . . . . . . . . . . 2-66
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
IOATEST Simulate Production Environment Events . . . . . . . . . . . . . . 2-67
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-67
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
IOAVERFY Verify IOA File Installation and Status . . . . . . . . . . . . . . . 2-69
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Trace Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Chapter 3

CONTROL-M Utilities
CTMAESIM Test AutoEdit Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11

BMC Software, Inc., Confidential and Proprietary Information

Contents

vii

CTMBGRP Convert Regular Scheduling Tables to Group Scheduling

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Statements and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
CTMBLDAE Build AutoEdit Symbols Member . . . . . . . . . . . . . . . . . 3-16
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Handling Duplicate Members Using PARM=MERGE . . . . . . . . . . . 3-18
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
CTMBLT Create Scheduling Tables . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29
Calling the CTMBLT Utility from Another Program. . . . . . . . . . . . . 3-30
Building Tables in Memory Followed by Immediate Ordering . . . . . 3-32
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
Job Scheduling Definition Parameter Tables . . . . . . . . . . . . . . . . . . . 3-40
CTMCAJF Maintain the Active Jobs File . . . . . . . . . . . . . . . . . . . . . . 3-49
Statements and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49
Compressing the Active Jobs File. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-52
Cleaning the Active Jobs File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-53
Changing the Size of the Active Jobs File . . . . . . . . . . . . . . . . . . . . . 3-53
Activating the COMPRESS Function. . . . . . . . . . . . . . . . . . . . . . . . . 3-54
Activating the CLEANUP Function . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54
Activating the COPY Function (Active Jobs File) . . . . . . . . . . . . . . . 3-54
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
CTMCRES Copy or Resize the CONTROL-M Resource File . . . . . . 3-57
Parameters and DDNAMEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
How to change the size of a CONTROL-M Resources file . . . . . . . . 3-58
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
CTMHCLN Maintain the History Jobs File. . . . . . . . . . . . . . . . . . . . . 3-59
SELECT/IGNORE Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Specifying AutoEdit Variables and Functions . . . . . . . . . . . . . . . . . . 3-60
Activating the utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
CTMHCOP Copy or Expand History Jobs File . . . . . . . . . . . . . . . . . . 3-62
Statements and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
File Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Changing the Size of the History Jobs File. . . . . . . . . . . . . . . . . . . . . 3-63
Activating the COPY Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-63
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-64
CTMJOB Order Jobs to the Active Jobs File . . . . . . . . . . . . . . . . . . . . 3-65

BMC Software, Inc., Confidential and Proprietary Information

viii

INCONTROL for OS/390 and z/OS Utilities Guide

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-67
Format of the ORDER, SELECT, and IGNORE Statements . . . . . . 3-67
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-68
SELECT and IGNORE TAG Logic . . . . . . . . . . . . . . . . . . . . . . . . . . 3-70
SELECT and IGNORE TAG Examples. . . . . . . . . . . . . . . . . . . . . . . 3-71
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-72
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-73
CTMJSA Job Statistics Accumulation . . . . . . . . . . . . . . . . . . . . . . . . 3-74
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-75
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-75
CTMRAFL Produce Active Jobs File Job Flow Report . . . . . . . . . . . 3-77
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-77
CTMRCAL Create a Calendar Using the Job Plan Report . . . . . . . . . 3-78
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-78
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
CTMRELRS Release Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-80
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-81
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-81
Examples of Activating the Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . 3-82
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-82
CTMRES Allocate and Format the CONTROL-M Resources File . . 3-83
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-84
CTMRFLW Produce a Scheduling Table Job Flow Report. . . . . . . . . 3-85
EXEC Statement Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-86
Report Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-87
Example Chart Page Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89
Example JCLs for Text Format: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89
List of scheduling tables to be included in Job Flow report. . . . . . . . 3-89
Fields of the Job Flow Report in Text format . . . . . . . . . . . . . . . . . . 3-92
Sample Job Flow Report Output in Graphic Format . . . . . . . . . . . . . 3-94
Sample Prerequisite Condition Cross Reference List . . . . . . . . . . . . 3-95
Sample Control Resources Cross Reference List. . . . . . . . . . . . . . . . 3-96
Sample Quantitative Resources Cross Reference List . . . . . . . . . . . . 3-97
CTMRNSC Produce Night Schedule Report. . . . . . . . . . . . . . . . . . . . 3-98
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
Example of JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
Example of Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-99
CTMROGR Produce an Overnight Execution Graph . . . . . . . . . . . . . 3-100
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
Example of JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-102
CTMRPFL Produce a Job Plan and Job Flow Report . . . . . . . . . . . . . 3-104
Example JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105
CTMRPLN Job Plan Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Example of JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-107

BMC Software, Inc., Confidential and Proprietary Information

Contents

ix

Sample Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-108

Sample CTMRPLN Job Plan Report Type 0S Report . . . . . . . . . . . . 3-109
Sample CTMRPLN Job Plan Report Type 1S Report . . . . . . . . . . . . 3-109
Sample CTMRPLN Job Plan Report Type 1 Report . . . . . . . . . . . . . 3-110
CTMRSTR Restore the CONTROL-M Active Jobs File. . . . . . . . . . . 3-111
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-111
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
CTMSLC Schedule Library Cleanup Utility . . . . . . . . . . . . . . . . . . . . 3-113
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
CTMTBUPD Update Job Scheduling Tables. . . . . . . . . . . . . . . . . . . . 3-116
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
Fields Requiring Complex Updates . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
Condition or Resource Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
Subparameter Qualifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-123
Updating Conditions and Resources. . . . . . . . . . . . . . . . . . . . . . . . . . 3-124
Partial Names (Generic Changes). . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-125
Miscellaneous Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-126
Utility Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-126
JCL Required to Execute CTMTBUPD . . . . . . . . . . . . . . . . . . . . . . . 3-127
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-127
CTMXRF Create Cross-Reference Reports . . . . . . . . . . . . . . . . . . . . . 3-130
Cross Reference Report Action Statements . . . . . . . . . . . . . . . . . . . . 3-130
Utility Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-132
JCL Required to Execute CTMXRF. . . . . . . . . . . . . . . . . . . . . . . . . . 3-132
Sample Output Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-133
CTMRJDS Produce Job Dataset Cross Reference Report . . . . . . . . . . 3-136
Procedure CTMJDS Generating the Job Dataset List . . . . . . . . . . . 3-136
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-137
FORMCKP Allocate, Format, and Resize the Active Jobs File. . . . . . 3-138
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-138
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-139
FORMHST Allocate and Format the History Jobs File . . . . . . . . . . . . 3-140
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-140
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-141
Chapter 4

CONTROL-M/Analyzer Utilities
CTBABI Initialize Active Balancing File . . . . . . . . . . . . . . . . . . . . . . . 4-3
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
CTBCMP Compile Rule Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

BMC Software, Inc., Confidential and Proprietary Information

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBCP Increase Size of a Database File . . . . . . . . . . . . . . . . . . . . . 4-5

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Procedure CTBDBCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
CTBDBIB Rebuild a CONTROL-M/Analyzer Index File . . . . . . . . . . 4-8
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
CTBDBVCG Change Number of Variable Generations . . . . . . . . . . . . 4-11
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
CTBDBVCP Copy Variables or Groups to Another File . . . . . . . . . . . 4-14
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
CTBDBVDL Delete Variables or Groups from Variable or Group Files4-17
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
CTBDBVIG Check the Integrity of Variable or Group Files . . . . . . . . 4-19
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
CTBFRM Compress the Active Balancing File . . . . . . . . . . . . . . . . . . 4-21
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
CTBJAFCP Copies Entries in Rule Activity or Report Files . . . . . . . . 4-23
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
CTBJAFDL Deletes Entries from Rule Activity or Report Files . . . . . 4-26
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
CTBJAFIG Check the Integrity of Rule Activity or Report Files . . . . . 4-28
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29

BMC Software, Inc., Confidential and Proprietary Information

Contents

xi

CTBVXRF Cross-Reference Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30

Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Report Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Chapter 5

CONTROL-D and CONTROL-V Utilities

BKPRESET Reset the Backup Mission Status . . . . . . . . . . . . . . . . . . 5-4
CTDBLXRP Rebuild Print Control Records in the Active User File . 5-5
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
CTDCAMF Compress or Copy Active Missions File . . . . . . . . . . . . . 5-6
Compressing the Active Missions File . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Copying the Active Missions File. . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Changing the Size of the Active Missions File. . . . . . . . . . . . . . . . . . 5-7
CTDCATF Compress or Copy Active Transfer File . . . . . . . . . . . . . . 5-9
Compressing the Active Transfer File . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Copying the Active Transfer File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Changing the Size of the Active Transfer File . . . . . . . . . . . . . . . . . . 5-10
CTDCA2P Copy Active User Report File to Permanent . . . . . . . . . . . 5-11
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
CTDCCFRS Create or Update Resource File from XEROX Resource
Tape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
CCIFRES Output File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
XERRES Input Tape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
INCLUDE / EXCLUDE Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
CTDCCU Delete Unneeded CDAM Files . . . . . . . . . . . . . . . . . . . . . . 5-17
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
CTDCLHIS Clean History User Report List File . . . . . . . . . . . . . . . . 5-20
MODE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
NOSYS Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Resolving Insufficient Memory Problems . . . . . . . . . . . . . . . . . . . . . 5-21
CTDCP2A Copy Permanent User Report File to Active . . . . . . . . . . . 5-22
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
CTDDELRP Delete Reports that are not Needed . . . . . . . . . . . . . . . . 5-25

BMC Software, Inc., Confidential and Proprietary Information

xii

INCONTROL for OS/390 and z/OS Utilities Guide

Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
DAYS Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
CTDDELRP Deletion Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
CTDDIB Rebuild Index Component of a User Report List File . . . . . 5-34
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
CTDDIG User Report List File Integrity Check . . . . . . . . . . . . . . . . . 5-36
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
CTDGBPRT Print Data from Global Index Database . . . . . . . . . . . . . 5-38
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
CTDSMFRP Paper Usage Report for Defined Users . . . . . . . . . . . . . 5-41
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
CTDSMFRP Sample Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
CTDUFUPD Global Scan or Change of User Files . . . . . . . . . . . . . . 5-45
Selection Criteria Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Change To Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Fields for After a SELECT Statement . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Fields for After SELECT and CHANGE TO Statements . . . . . . . . . 5-50
Work Flow of the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
CTDULD User File Report List Load . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
CTDUPBKP Update Backup and Migration Details. . . . . . . . . . . . . . 5-55
Converting from CA-DISPATCH. . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57
Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58
CHANGETO Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-59
Report Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-61
CTVCLMIG Clean Migrated CDAM Files . . . . . . . . . . . . . . . . . . . . . 5-64
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
CTVDELI Delete Index Files from DASD . . . . . . . . . . . . . . . . . . . . . 5-66
EXEC Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67
DAYS Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67

BMC Software, Inc., Confidential and Proprietary Information

Contents

xiii

INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 5-68

Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
CTVGICL Clean Global Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74
CTVJAR Job Archiving Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
Index Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
EXEC Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-77
CTVUNMIG Unmigrate Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
CTVUPGDB Update Global Index Database . . . . . . . . . . . . . . . . . . . 5-81
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
MIGRESET Reset the Migration Mission Status. . . . . . . . . . . . . . . . . 5-86
RSTRESET Reset the Restore Mission Status. . . . . . . . . . . . . . . . . . . 5-87
Chapter 6

CONTROL-O Utilities
CTOALOCP Backing Up the Automation Log . . . . . . . . . . . . . . . . . . . 6-3
Automation Log Backup Utility Examples . . . . . . . . . . . . . . . . . . . 6-4
CTOCSF Copy the Message Statistics File . . . . . . . . . . . . . . . . . . . . . . 6-6
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
CTOCTA List Programs Running in an Address Space. . . . . . . . . . . . . 6-8
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
CTOCTI Generate Input for the SYSIMAGE Facility. . . . . . . . . . . . . . 6-10
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Input File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
Utility Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
CTORSTM Statistics Report Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
SORT Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Fields of the Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
CTOMVDSC Emergency ON MVALERT Disconnect . . . . . . . . . . . . . 6-17
Activating the CTOMVDSC Utility . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
CTOSMDSC Emergency ON SMS Disconnect. . . . . . . . . . . . . . . . . . . 6-18
Activating the CTOSMDSC Utility . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18

BMC Software, Inc., Confidential and Proprietary Information

xiv

INCONTROL for OS/390 and z/OS Utilities Guide

Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18

CTOTEST Simulate Messages and/or Commands . . . . . . . . . . . . . . . . 6-19
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
Format of the Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
CTOUSMDSC Emergency USS Support Disconnect . . . . . . . . . . . . . . 6-23
Activating the CTOUSMDSC Utility . . . . . . . . . . . . . . . . . . . . . . . . 6-23
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23
Chapter 7

CONTROL-M/Tape Utilities
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Control Statement Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Record Selection Logic (INCLUDE / EXCLUDE Statements). . . . . 7-6
Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
CTTACP Copy Trace File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
CTTAFR Format and Initialize Trace File. . . . . . . . . . . . . . . . . . . . . . . 7-17
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
CTTBIX Rebuild Media Database Index . . . . . . . . . . . . . . . . . . . . . . . 7-18
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
CTTCTRC Allocate and Format Trace File . . . . . . . . . . . . . . . . . . . . . 7-21
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
CTTDBIB Rebuild Indexes of Stacking Database . . . . . . . . . . . . . . . . 7-23
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
CTTDLD Add, Delete, or Convert Volumes . . . . . . . . . . . . . . . . . . . . . 7-25
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27
Example 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
Example 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
Example 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28

BMC Software, Inc., Confidential and Proprietary Information

Contents

xv

Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
CTTGVL User Interface to Stacking Facility . . . . . . . . . . . . . . . . . . . . 7-30
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-30
Using a Call Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Using a Link command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Output Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-32
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-32
CTTIDB Check Integrity of the Media Database . . . . . . . . . . . . . . . . . 7-33
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-35
CTTMER Merge Records Into the Media Database . . . . . . . . . . . . . . . 7-36
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-36
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-37
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38
CTTMUP Manually Update the CONTROL-M/Tape Repository . . . . . 7-39
Updating the Media Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-39
Updating the Stacking Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-41
Media Database Update Control Statements . . . . . . . . . . . . . . . . . . . 7-42
Stacking Database Update Control Statements . . . . . . . . . . . . . . . . . 7-45
Trace Update Control Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-46
Special Notes Regarding Media Database Control Statements . . . . . 7-46
Specifying Fields and Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
CTTRCV Recover the Media Database Using Trace File . . . . . . . . . . . 7-52
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-56
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-56
CTTRPT Database Extraction and Report Utility . . . . . . . . . . . . . . . . . 7-58
Primary Key, Primary Fields and Primary Lines in Report Generation
7-58
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-59
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-59
Extract Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
Report Formatting Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-61
Special Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-68
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-69

BMC Software, Inc., Confidential and Proprietary Information

xvi

INCONTROL for OS/390 and z/OS Utilities Guide

Sample Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-70

CTTRSM Recover Tape Activity From SMF Records . . . . . . . . . . . . . 7-79
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-79
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-83
CTTRTM Perform Retention Management. . . . . . . . . . . . . . . . . . . . . . 7-84
Scratch Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
RECALC Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
Exits Used by Utility CTTRTM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
Relevant Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-90
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97
CTTSBD Perform Dataset Stacking in Batch Mode . . . . . . . . . . . . . . . 7-100
Utility Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-101
Execution Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
Resource Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
Exit CTTX011 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Retention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Batch Stacking and Vault Management . . . . . . . . . . . . . . . . . . . . . . . 7-104
Volume and Dataset Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-104
Dataset Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Volume Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Stacking Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Batch Stacking and Dynamic Dataset Stacking . . . . . . . . . . . . . . . . . 7-106
Dataset Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-106
Determination of Output Dataset Location . . . . . . . . . . . . . . . . . . . . 7-107
Masking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
Stopping Utility CTTSBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-110
Simulation Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-111
Unstacking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-111
Recovery From Abends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-112
Relevant Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-113
Preparation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-114
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-115
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-115
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-127
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-127
CTTSCA Dataset Contention Detection . . . . . . . . . . . . . . . . . . . . . . . . 7-131
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136
CTTSPL Copies or Moves Media Database Records . . . . . . . . . . . . . . 7-138
Split and Merge Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-138
Data Integrity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-139

BMC Software, Inc., Confidential and Proprietary Information

Contents

xvii

Simulation Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-139

Volume Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Recovery from Abends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Undoing Splits and Merges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Activating the CTTSPL Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-141
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-142
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
CTTSTK Build and Update Stacking Database . . . . . . . . . . . . . . . . . . . 7-145
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
INCLUDE / EXCLUDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
Gathering Statistics for Datasets with Non-specific Retention. . . . . . 7-147
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-147
CTTSTKR Stacking Statistics Report Utility . . . . . . . . . . . . . . . . . . . . 7-148
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-150
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-150
CTTSYNC Synchronize Automated Tape Libraries with the Media
Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-152
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-153
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-153
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
CTTTPI Tape Initialization, Information Mapping, and Tape Erasure . 7-156
Safe Tape Initialization Function INITT . . . . . . . . . . . . . . . . . . . . . 7-156
Media Information Mapping Function TAPEMAP . . . . . . . . . . . . . 7-157
Safe Tape Erasure Function TAPERAS. . . . . . . . . . . . . . . . . . . . . . 7-159
CTTTPI and I/O Error Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-160
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-161
Passing Parameters using the EXEC Statement . . . . . . . . . . . . . . . . . 7-161
Passing Parameters using DD Statement SYSIN . . . . . . . . . . . . . . . . 7-162
Input Parameters SYSIN DD File . . . . . . . . . . . . . . . . . . . . . . . . . . 7-162
Invoking CTTTPI From Another Program . . . . . . . . . . . . . . . . . . . . . 7-167
Activating Utility CTTTPI From the StorageTek Host Software
Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-168
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-169
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-170
CTTTRB Synchronize Trace File and Media Database Backup . . . . . . 7-171
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-171
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-171
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-172
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-172
CTTVTM Perform Vault Management . . . . . . . . . . . . . . . . . . . . . . . . . 7-173
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-175
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-176
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-179

BMC Software, Inc., Confidential and Proprietary Information

xviii

INCONTROL for OS/390 and z/OS Utilities Guide

Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-180
Index

BMC Software, Inc., Confidential and Proprietary Information

Contents

xix

BMC Software, Inc., Confidential and Proprietary Information

xx

INCONTROL for OS/390 and z/OS Utilities Guide

Figures
Figure 2-1
Figure 2-2
Figure 2-3
Figure 2-4
Figure 2-5
Figure 2-6
Figure 2-7
Figure 2-8
Figure 2-9
Figure 3-1
Figure 3-2
Figure 3-3
Figure 3-4
Figure 3-5
Figure 3-6
Figure 3-7
Figure 3-8
Figure 3-9
Figure 3-10
Figure 3-11
Figure 3-12
Figure 3-13
Figure 3-14
Figure 3-15
Figure 3-16
Figure 3-17
Figure 3-18
Figure 3-19
Figure 3-20
Figure 3-21
Figure 3-22
Figure 3-23
Figure 3-24
Figure 3-25

IOACLCND Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16

IOACLCND Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
IOACCND Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
IOACPLOG Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
IOACPLOG Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27
DEFACT Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34
IOADBSR Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42
IOALDNRS Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
IOATEST Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
CTMAESIM Multiple Member Specification Example 1 . . . . . . . . 3-8
CTMAESIM Multiple Member Specification Example 2 . . . . . . . . 3-8
CTMAESIM Multiple Job Specification . . . . . . . . . . . . . . . . . . . . . . . 3-9
CTMAESIM Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
CTMAESIM Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
CTMBLDAE Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
CTMBLDAE Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
CTMBLDAE Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21
CTMBLT Input Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
CTMBLT Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-35
CTMBLT Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36
CTMBLT Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37
CTMBLT Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38
CTMBLT Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-40
DD Statement DAJOB Method 1 Example . . . . . . . . . . . . . . . . . . . . 3-65
DD Statement DAJOB Method 2, Example 1 . . . . . . . . . . . . . . . . . . 3-65
DD Statement DAJOB Method 2, Example 2 . . . . . . . . . . . . . . . . . . 3-66
CTMJOB Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71
CTMJOB Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-73
Utility CTMRELRS Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-82
CTMRFLW Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-90
CTMRFLW Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-90
CTMRFLW Example of TABLES Format . . . . . . . . . . . . . . . . . . . 3-91
CTMRFLW Sample Job Flow Report . . . . . . . . . . . . . . . . . . . . . . 3-91
CTMRFLW Job Flow Report Output . . . . . . . . . . . . . . . . . . . . . . . . 3-94

BMC Software, Inc., Confidential and Proprietary Information

Figures

xxi

Figure 3-26
Figure 3-27
Figure 3-28
Figure 3-29
Figure 3-30
Figure 3-31
Figure 3-32
Figure 3-33
Figure 3-34
Figure 3-35
Figure 3-36
Figure 3-37
Figure 3-38
Figure 3-39
Figure 3-40
Figure 3-41
Figure 3-42
Figure 3-43
Figure 3-44
Figure 3-45
Figure 3-46
Figure 3-47
Figure 3-48
Figure 4-1
Figure 4-2
Figure 4-3
Figure 4-4
Figure 4-5
Figure 4-6
Figure 4-7
Figure 4-8
Figure 4-9
Figure 4-10
Figure 5-1
Figure 5-2
Figure 5-3
Figure 5-4
Figure 5-5
Figure 5-6
Figure 5-7
Figure 5-8
Figure 5-9
Figure 5-10
Figure 5-11
Figure 5-12
Figure 5-13
Figure 5-14

CTMRFLW Sample Prerequisite Condition Cross Reference List . . 3-95

CTMRFLW Sample Control Resources Cross Reference List . . . . . 3-96
CTMRFLW Sample Quantitative Resources Cross Reference List . . 3-97
CTMRNSC Example of Instructions . . . . . . . . . . . . . . . . . . . . . . . 3-99
CTMROGR Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-102
CTMRPFL Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105
CTMRPLN Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-107
Utility CTMRPLN Sample Input Parameters . . . . . . . . . . . . . . . . . 3-108
CTMRPLN Report Type 0S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
CTMRPLN Report Type 1S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
CTMRPLN Job Plan Report Type 1 . . . . . . . . . . . . . . . . . . . . . . . . . 3-110
CTMTBUPD Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-128
CTMTBUPD Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-128
CTMTBUPD Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-129
CTMTBUPD Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-129
CTMXREF Job Name or Table Name Cross Reference Report . . . 3-133
CTMXREF Resource Name / Job Name Cross Reference Report . 3-133
CTMXREF Calendar Name or Job Name Cross Reference Report 3-133
CTMXREF Schedule Tag or Job Name Cross Reference Report . . 3-134
CTMXREF From - Until - Due Out Time or Job Name Cross Reference
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-134
CTMXREF Condition Name Cross-Reference Report . . . . . . . . . . 3-134
CTMXREF Library Name or Job Name Cross Reference Report . . 3-135
CTMJDS Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-137
CTBDBVCG Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
CTBDBVCG Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
CTBDBVCP Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
CTBDBVDL Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
CTBJAFCP Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
CTBJAFDL Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
CTBJAFDL Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
CTBVXRF Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
CTBVXRF Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
CTBVXRF Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
Active User Report List File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Permanent User Report List File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Permanent User Report List File After Utility Run . . . . . . . . . . . . . . 5-13
CTDCCFRS XEROX Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
CTDCCU Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
CTDCCU Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
CTDCCU Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Permanent User Report List File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
Active User Report List File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
CTDDELRP Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
CTDGBPRT Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
CTDGBPRT Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
CTDGBPRT Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
Sample Report 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42

BMC Software, Inc., Confidential and Proprietary Information

xxii

INCONTROL for OS/390 and z/OS Utilities Guide

Figure 5-15
Figure 5-16
Figure 5-17
Figure 5-18
Figure 5-19
Figure 5-20
Figure 5-21
Figure 5-22
Figure 5-23
Figure 5-24
Figure 5-25
Figure 5-26
Figure 5-27
Figure 5-28
Figure 5-29
Figure 5-30
Figure 5-31
Figure 5-32
Figure 5-33
Figure 5-34
Figure 5-35
Figure 6-1
Figure 6-2
Figure 6-3
Figure 7-1
Figure 7-2
Figure 7-3
Figure 7-4
Figure 7-5
Figure 7-6
Figure 7-7
Figure 7-8
Figure 7-9
Figure 7-10
Figure 7-11
Figure 7-12
Figure 7-13
Figure 7-14
Figure 7-15

Sample Report 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43

Sample Report 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Sample Report 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
CTDUFUPD Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
CTDUFUPD Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52
CTDUFUPD Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-53
CTDUFUPD Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-53
RECVOL DD Statement Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56
CTDUPBKP Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57
CTDUPBKP Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62
CTDUPBKP Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62
CTDUPBKP Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63
CTDUPBKP Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63
CTVDELI Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
CTVGICL Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73
CTVJAR Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-78
CTVUNMIG Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79
CTVUPGDB Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
CTVUPGDB Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
CTVUPGDB Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
CTVUPGDB Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-85
CTOCTI Sample Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
CTORSTM Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
CTORSTM Sample Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
INCLUDE / EXCLUDE Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
CTTACP Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
CTTACP Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
CTTACP Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
CTTRPT Report Formatting Parameters . . . . . . . . . . . . . . . . . . . . . . 7-61
CTTRPT Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-73
CTTRPT Sample Report 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
CTTRPT Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-76
CTTRPT Sample Report 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-77
CTTSCA Sample Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-137
CTTSPL Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-141
CTTSTKR Output Report Example . . . . . . . . . . . . . . . . . . . . . . . . 7-151
CTTSYNC Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-153
CTTSYNC Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-155

BMC Software, Inc., Confidential and Proprietary Information

Figures

xxiii

BMC Software, Inc., Confidential and Proprietary Information

xxiv

INCONTROL for OS/390 and z/OS Utilities Guide

Tables
Table 1-1
Table 1-2
Table 1-3
Table 1-4
Table 1-5
Table 1-6
Table 1-7
Table 1-8
Table 1-9
Table 1-10
Table 1-11
Table 1-12
Table 1-13
Table 1-14
Table 1-15
Table 2-1
Table 2-2
Table 2-3
Table 2-4
Table 2-5
Table 2-6
Table 2-7
Table 2-8
Table 2-9
Table 2-10
Table 2-11
Table 2-12
Table 2-13
Table 2-14
Table 2-15
Table 2-16

IOA Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

CONTROL-M Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
CONTROL-M/Analyzer Database, Group and Variable File Handling
Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
CONTROL-M/Analyzer Report and Rule Activity File Handling Utilities 1-5
CONTROL-M/Analyzer Active Balancing File Utilities . . . . . . . . . . 1-5
IOA Access Method File Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Miscellaneous Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
CONTROL-D and CONTROL-V Utilities . . . . . . . . . . . . . . . . . . . . . 1-6
CONTROL-O Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
CONTROL-M/Tape Trace Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
CONTROL-M/Tape Stacking Utilities . . . . . . . . . . . . . . . . . . . . . . . . 1-8
CONTROL-M/Tape Media Database Utilities . . . . . . . . . . . . . . . . . . 1-8
CONTROL-M/Tape Daily Management Utilities . . . . . . . . . . . . . . . . 1-8
CONTROL-M/Tape Database Handling Utilities (for the Media Database and
Stacking Database) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
CONTROL-M/Tape Miscellaneous Utilities . . . . . . . . . . . . . . . . . . . . 1-9
Scheduling Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
IOABLCAL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
IOABLCAL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
IOACABPR Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
CONTROL-M and CONTROL-D Statements . . . . . . . . . . . . . . . . . . 2-15
IOACLCND Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
IOACND Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
IOACCND Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
IOACCND Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
IOACPLOG Copy to Sequential File Parameters . . . . . . . . . . . . . . . 2-25
IOACPLOG Copy to Sequential File Return Codes . . . . . . . . . . . . . 2-26
IOACPLOG Copy to Log File Parameters . . . . . . . . . . . . . . . . . . . . 2-26
IOACPLOG Copy to Log File Return Codes . . . . . . . . . . . . . . . . . . 2-27
IOADBF Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28
IOADBF Access Method Parameters . . . . . . . . . . . . . . . . . . . . . . . . 2-29
IOADBF CONTROL-M/Analyzer Sample Formatting Jobs . . . . . . 2-36

BMC Software, Inc., Confidential and Proprietary Information

Tables

xxv

Table 2-17
Table 2-18
Table 2-19
Table 2-20
Table 2-21
Table 2-22
Table 2-23
Table 2-24
Table 2-25
Table 2-26
Table 2-27
Table 2-28
Table 2-29
Table 2-30
Table 2-31
Table 2-32
Table 2-33
Table 2-34
Table 2-35
Table 2-36
Table 2-37
Table 2-38
Table 2-39
Table 2-40
Table 2-41
Table 2-42
Table 3-1
Table 3-2
Table 3-3
Table 3-4
Table 3-5
Table 3-6
Table 3-7
Table 3-8
Table 3-9
Table 3-10
Table 3-11
Table 3-12
Table 3-13
Table 3-14
Table 3-15
Table 3-16
Table 3-17
Table 3-18
Table 3-19
Table 3-20
Table 3-21

IOADBF CONTROL-M/Analyzer Sample Formatting and Rebuilding Jobs

2-36
IOADBF IOA Sample Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
IOADBIB Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
IOADBIB Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
IOADBIB Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
IOADBSR Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40
IOADBSR Sort Control Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41
IOADCPY Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
IOADCPY Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
IOADIG Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
IOADIG Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
IOADII Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
IOADLD Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
IOADLD Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-53
IOADPT Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54
IOADPT Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
IOADUL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
IOADUL Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
IOALDNRS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
IOALDNRS Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
IOANOTE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
IOANOTE Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
IOASDISC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
IOATEST Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-67
IOAVERFY Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69
IOAVERFY Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
CTMAESIM JCL Library Mode Parameters . . . . . . . . . . . . . . . . . . . . 3-5
CTMAESIM Scheduling Mode Parameters . . . . . . . . . . . . . . . . . . . . . 3-6
CTMAESIM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
CTMAESIM Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
CTMBGRP Required Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
CTMBGRP Required Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
CTMBGRP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
CTMBLDAE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
CTMBLDAE Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
CTMBLT Job Scheduling Definition Parameters . . . . . . . . . . . . . . . 3-24
CTMBLT Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26
CTMBLT Calling Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30
CTMBAPI Parameters Used by CTMBLT . . . . . . . . . . . . . . . . . . . . . 3-32
CTMBLT Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
CTMBLT General Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
CTMBLT Scheduling Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
CTMBLT Runtime Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-44
CTMBLT Post-Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . 3-44
CTMBLT Special Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48
CTMCAJF Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49
CTMCAJF SELECT/IGNORE Statements . . . . . . . . . . . . . . . . . . . . 3-50

BMC Software, Inc., Confidential and Proprietary Information

xxvi

INCONTROL for OS/390 and z/OS Utilities Guide

Table 3-22
Table 3-23
Table 3-24
Table 3-25
Table 3-26
Table 3-27
Table 3-28
Table 3-29
Table 3-30
Table 3-31
Table 3-32
Table 3-33
Table 3-34
Table 3-35
Table 3-36
Table 3-37
Table 3-38
Table 3-39
Table 3-40
Table 3-41
Table 3-42
Table 3-43
Table 3-44
Table 3-45
Table 3-46
Table 3-47
Table 3-48
Table 3-49
Table 3-50
Table 3-51
Table 3-52
Table 3-53
Table 3-54
Table 3-55
Table 3-56
Table 3-57
Table 3-58
Table 3-59
Table 3-60
Table 4-1
Table 4-2
Table 4-3
Table 4-4
Table 4-5
Table 4-6
Table 4-7
Table 4-8
Table 4-9

CTMCAJF SELECT/IGNORE Statement Parameters . . . . . . . . . . . 3-51

CTMCAJF File Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-52
CTMCAJF Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
CTMCRES Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
CTMCRES Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
CTMCRES Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
CTMHCLN SELECT/IGNORE Statements . . . . . . . . . . . . . . . . . . . 3-59
CTMHCLN SELECT/IGNORE Parameters . . . . . . . . . . . . . . . . . . . 3-60
CTMHCLN Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
CTMHCOP Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
CTMHCOP File Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
CTMHCOP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-64
CTMJOB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-68
Utility CTMJOB Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-73
CTMJSA Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-75
CTMRCAL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
Utility CTMRELRS Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . 3-82
CTMRES Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-84
CTMRFLW Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-85
CTMRFLW Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-86
CTMRFLW Report Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-87
CTMRFLW Job Flow Report Fields . . . . . . . . . . . . . . . . . . . . . . . . . 3-92
CTMRNSC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
CTMROGR Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
CTMRPFL Report Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-104
CTMRPLN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
CTMRSTR Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-111
CTMRSTR Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
CTMSLC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
CTMTBUPD Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
CTMTBUPD Field Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
CTMTBUPD Miscellaneous Parameters . . . . . . . . . . . . . . . . . . . . . 3-126
CTMTBUPD Utility Control Statements . . . . . . . . . . . . . . . . . . . . 3-126
CTMTBUPD Schedule Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-129
CTMXREF Cross-Reference Statements . . . . . . . . . . . . . . . . . . . . 3-130
CTMXREF Utility Control Statements . . . . . . . . . . . . . . . . . . . . . . 3-132
CTMJDS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-136
FORMCKP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-139
FORMHST Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-141
CTBABI Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
CTBABI Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
CTBCMP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
CTBDBCP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
CTBDBCP File Type Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
CTBDBCP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
CTBDBIB Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
CTBDBIB Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
CTBDBIB Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

BMC Software, Inc., Confidential and Proprietary Information

Tables

xxvii

Table 4-10
Table 4-11
Table 4-12
Table 4-13
Table 4-14
Table 4-15
Table 4-16
Table 4-17
Table 4-18
Table 4-19
Table 4-20
Table 4-21
Table 4-22
Table 4-23
Table 4-24
Table 4-25
Table 4-26
Table 4-27
Table 4-28
Table 4-29
Table 4-30
Table 4-31
Table 4-32
Table 4-33
Table 5-1
Table 5-2
Table 5-3
Table 5-4
Table 5-5
Table 5-6
Table 5-7
Table 5-8
Table 5-9
Table 5-10
Table 5-11
Table 5-12
Table 5-13
Table 5-14
Table 5-15
Table 5-16
Table 5-17
Table 5-18
Table 5-19
Table 5-20
Table 5-21
Table 5-22
Table 5-23
Table 5-24

CTBDBIB Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10

CTBDBVCG EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
CTBDBVCG SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
CTBDBVCG Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
CTBDBVCP EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
CTBDBVCP SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
CTBDBVCP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
CTBDBVDL EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
CTBDBVDL SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
CTBDBVDL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
CTBDBVIG EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
CTBDBVIG Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
CTBFRM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
CTBFRM Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
CTBJAFCP Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
CTBJAFCP EXEC Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
CTBJAFCP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
CTBJAFDL EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
CTBJAFDL SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
CTBJAFDL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
CTBJAFIG EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
CTBJAFIG Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
CTBVXRF Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
CTBVXRF Report Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
CTDBLXRP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
CTDCA2P Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
CTDCA2P Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
CTDCCFRS EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
CTDCCFRS SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
CTDCCU Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17
CTDCLHIS MODE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
CTDCLHIS Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
CTDCP2A Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
CTDCP2A Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
CTDDELRP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
CTDDELRP DAYS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
CTDDELRP Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
CTDDELRP Additional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
CTDDIB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
CTDDIB Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
CTDDIB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
CTDGBPRT Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
CTDGBPRT Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
CTDSMFRP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
CTDUFUPD SELECT Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
CTDUFUPD SELECT Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
CTDUFUPD SELECT and CHANGE TO Statements . . . . . . . . . . . 5-50
CTDUFUPD CONTROL Statement Fields . . . . . . . . . . . . . . . . . . . . 5-51

BMC Software, Inc., Confidential and Proprietary Information

xxviii

INCONTROL for OS/390 and z/OS Utilities Guide

Table 5-25
Table 5-26
Table 5-27
Table 5-28
Table 5-29
Table 5-30
Table 5-31
Table 5-32
Table 5-33
Table 5-34
Table 5-35
Table 5-36
Table 5-37
Table 5-38
Table 5-39
Table 5-40
Table 5-41
Table 5-42
Table 5-43
Table 6-1
Table 6-2
Table 6-3
Table 6-4
Table 6-5
Table 6-6
Table 6-7
Table 6-8
Table 6-9
Table 6-10
Table 6-11
Table 6-12
Table 6-13
Table 6-14
Table 7-1
Table 7-2
Table 7-3
Table 7-4
Table 7-5
Table 7-6
Table 7-7
Table 7-8
Table 7-9
Table 7-10
Table 7-11
Table 7-12
Table 7-13
Table 7-14
Table 7-15

CTDULD Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54

CTDUPBKP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56
CTDUPBKP SELECT Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58
CTDUPBKP CHANGETO Parameters . . . . . . . . . . . . . . . . . . . . . . . 5-59
CTDUPBKP Report Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-61
CTDUPBKP Detail Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-61
CTVCLMIG Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64
CTVCLMIG Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
CTVDELI Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67
CTVDELI DAYS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67
CTVDELI INCLUDE / EXCLUDE Parameters . . . . . . . . . . . . . . . . 5-68
CTVGICL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
CTVGICL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73
CTVJAR Index Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
CTVJAR EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-77
CTVJAR SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-77
CTVUNMIG Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
CTVUPGDB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
CTVUPGDB Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
CTOALOCP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
CTOCTA Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
CTOCTA Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
CTOCTI Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
CTOCTI Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
CTORSTM SORT Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
CTORSTM INCLUDE / EXCLUDE Parameter . . . . . . . . . . . . . . . . 6-14
CTORSTM Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
CTOMVDSC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
CTOSMDSC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
CTOTEST EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
CTOTEST CMDMSGFL Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
CTOTEST Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
CTOUSDSC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23
Expressions for INCLUDE / EXCLUDE Examples . . . . . . . . . . . . . 7-11
New CONTROL-M/Tape Database Utilities . . . . . . . . . . . . . . . . . . . 7-12
CTTACP EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
CTTACP SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
CTTACP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
CTTAFR Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
CTTBIX EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
CTTBIX Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
CTTCTRC Parameters for Data File Creation . . . . . . . . . . . . . . . . . 7-21
CTTCTRC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
CTTDBIB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
CTTDBIB Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
CTTDLD Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
CTTDLD Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
CTTDLD Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27

BMC Software, Inc., Confidential and Proprietary Information

Tables

xxix

Table 7-16
Table 7-17
Table 7-18
Table 7-19
Table 7-20
Table 7-21
Table 7-22
Table 7-23
Table 7-24
Table 7-25
Table 7-26
Table 7-27
Table 7-28
Table 7-29
Table 7-30
Table 7-31
Table 7-32
Table 7-33
Table 7-34
Table 7-35
Table 7-36
Table 7-37
Table 7-38
Table 7-39
Table 7-40
Table 7-41
Table 7-42
Table 7-43
Table 7-44
Table 7-45
Table 7-46
Table 7-47
Table 7-48
Table 7-49
Table 7-50
Table 7-51
Table 7-52
Table 7-53
Table 7-54
Table 7-55
Table 7-56
Table 7-57
Table 7-58
Table 7-59
Table 7-60
Table 7-61
Table 7-62
Table 7-63

CTTGVL Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31

CTTGVL Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
CTTGVL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-32
CTTIDB Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
CTTIDB Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
CTTMER Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-37
CTTMER Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38
CTTMUP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-41
CTTMUP Media Database Update Control Statements . . . . . . . . . . . 7-42
CTTMUP Stacking Database Update Control Statements . . . . . . . . . 7-45
Trace Update Control Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-46
CTTMUP Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
CTTMUP Field Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
CTTMUP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
CTTRCV SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-54
CTTRCV Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-56
CTTRPT Extract Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
CTTRPT Report Formatting Parameters . . . . . . . . . . . . . . . . . . . . . . 7-62
CTTRPT Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-68
CTTRPT Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-69
CTTRPT Sample Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-71
CTTRPT Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-72
CTTRSM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
CTTRTM Pool Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
CTTRTM Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
CTTRTM Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
CTTRTM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-90
CTTRTM Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
CTTSBD Resource Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
CTTSBD Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-107
CTTSBD Masks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
CTTSBD Mask Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
Relevant CONTROL-M/Tape Installation Parameters . . . . . . . . . . . 7-113
CTTSBD General Utility Parameters . . . . . . . . . . . . . . . . . . . . . . . . 7-116
CTTSBD Additional Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-123
CTTSBD Dataset Group Statements and Parameters . . . . . . . . . . . 7-124
CTTSBD Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-127
CTTSCA EXEC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
CTTSCA SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-133
CTTSCA Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136
CTTSPL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-138
CTTSPL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-141
CTTSPL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-142
CTTSPL Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
CTTSTK Media Database and Trace File . . . . . . . . . . . . . . . . . . . . 7-145
CTTSTK Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
CTTSTK Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-147
CTTSTKR Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148

BMC Software, Inc., Confidential and Proprietary Information

xxx

INCONTROL for OS/390 and z/OS Utilities Guide

Table 7-64
Table 7-65
Table 7-66
Table 7-67
Table 7-68
Table 7-69
Table 7-70
Table 7-71
Table 7-72
Table 7-73
Table 7-74
Table 7-75
Table 7-76

CTTSTKR Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CTTSYNC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTSYNC Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTPI Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTPI Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTPI SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTPI Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTPI Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTRB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTTRB Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Relevant CONTROL-M/Tape Installation Parameters . . . . . . . . . .
CTTVTM SYSIN Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CTTVTM Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7-150
7-153
7-154
7-156
7-158
7-163
7-167
7-169
7-171
7-172
7-174
7-176
7-179

BMC Software, Inc., Confidential and Proprietary Information

Tables

xxxi

BMC Software, Inc., Confidential and Proprietary Information

xxxii

INCONTROL for OS/390 and z/OS Utilities Guide

xxxviii

About This Guide

This guide describes special featuresutilitiesdesigned to help you
perform specific tasks, and discusses the utilities available for each
INCONTROL product.
Basic information about how INCONTROL products operate is provided in
user manuals for each product.
Administration information for each product is found in the INCONTROL for
OS/390 and z/OS Administrator Guide.

BMC Software, Inc., Confidential and Proprietary Information

About This Guide

xxxiii

Conventions Used in This Guide

Notational conventions that may be used in this guide are explained below.

Standard Keyboard Keys

Keys that appear on the standard keyboard are identified in boldface, for
example, Enter, Shift, Ctrl+S (a key combination), or Ctrl S (a key sequence).
Warning!

The commands, instructions, procedures, and syntax illustrated

in this guide presume that the keyboards at your site are mapped
in accordance with the EBCDIC character set. Certain special
characters are referred to in this documentation, and you must
ensure that your keyboard enables you to generate accurate
EBCDIC hex codes. This is particularly true on keyboards that
have been adapted to show local or national symbols. You should
verify that
$ is mapped to x5B
# is mapped to x7B
@ is mapped to x7C

If you have any questions about whether your keyboard is

properly mapped, contact your system administrator.

Preconfigured PFKeys

Many commands are preconfigured to specific keys or key combinations.

This is particularly true with regard to numbered PF keys, or pairs of
numbered PFKeys. For example, the END command is preconfigured to, and
indicated as, PF03/PF15. To execute the END command, press either the
PF03 key or the PF15 key.
Instructions to enter commands may include

only the name of the command, such as, enter the END command
only the PF keys, such as, press PF03/PF15
or both, such as, press PF03/PF15, or enter the END command

BMC Software, Inc., Confidential and Proprietary Information

xxxiv

INCONTROL for OS/390 and z/OS Utilities Guide

Command Lines and Option Fields

Most screens contain a command line, which is primarily used to identify a

single field where commands, or options, or both, are to be entered. These
fields are usually designated COMMAND, but they are occasionally
identified as COMMAND/OPT or COMMAND/OPTION.
Option field headings appear in many screens. These headings sometimes
appear in the screen examples as OPTION, or OPT, or O.

Names of Commands, Fields, Files, Functions, Jobs, Libraries,

Members, Missions, Options, Parameters, Reports, Subparameters, and
Users

The names of commands, fields, functions, jobs, libraries, members,

missions, options, parameters, reports, subparameters, users, and most files,
are shown in standard UPPERCASE font.

User Entries

In situations where you are instructed to enter characters using the keyboard,
the specific characters to be entered are shown in this UPPERCASE BOLD
text, for example, type EXITNAME.

Syntax statements

In syntax, the following additional conventions apply:

A vertical bar ( | ) separating items indicates that you must choose one
item. In the following example, you would choose a, b, or c:
a| b | c

An ellipsis ( . . . ) indicates that you can repeat the preceding item or

items as many times as necessary.

Square brackets ( [ ] ) around an item indicate that the item is optional. If

square brackets ( [ ] ) are around a group of items, this indicates that the
item is optional, and you may choose to implement any single item in the
group. Squae brackets can open ( [ ) and close ( ] ) on the same line of
text, or may begin on one line of text and end, with the choices being
stacked, one or more lines later.

BMC Software, Inc., Confidential and Proprietary Information

About This Guide

xxxv

Braces ({ }) around a group of items indicates that the item is mandatory,

and you must choose to implement a single item in the group. Braces can
open ( { ) and close ( } ) on the same line of text, or may begin on one
line of text and end, with the choices being stacked, one or more lines
later.

Screen Characters

All syntax, operating system terms, and literal

examples are presented in this typeface. This includes
JCL calls, code examples, control statements, and system messages.
Examples of this are:
calls, such as
CALL CBLTDLI

code examples, such as

FOR TABLE owner.name USE option, . . . ;

control statements, such as

//PRDSYSIN DD * USERLOAD PRD(2) PRINT

system messages, both stand-alone, such as You are not logged on
to database database_name, and those embedded in text, such as
the message You are not logged on to database
database_name, are displayed on the screen.

Variables

Variables are identified with italic text. Examples of this are:

In syntax or message text, such as

In regular text, such as

replace database database_name1 with database database_name2 for the
current session
In a version number, such as
EXTENDED BUFFER MANAGER for IMS 4.1.xx

Specify database database_name

Special elements

This book includes special elements called notes and warnings:

Note:

Notes provide additional information about the current subject.

Warning!

Warnings alert you to situations that can cause problems, such as

loss of data, if you do not follow instructions carefully.

BMC Software, Inc., Confidential and Proprietary Information

xxxvi

INCONTROL for OS/390 and z/OS Utilities Guide

Information New to This Version

Where substantive additions and modifications to the content of this guide
occur, revision bars have been inserted in the margin.
Additional information that is new to this version is described in Appendix C
of the INCONTROL for OS/390 and z/OS Upgrade Guide.

Related Publications
INCONTROL for OS/390 and z/OS Administrator Guide

Information for system administrators about customizing and maintaining

INCONTROL products.

INCONTROL for OS/390 and z/OS Installation Guide

A step-by-step guide to installing INCONTROL products using the

INCONTROL Installation and Customization Engine (ICE) application.

INCONTROL for OS/390 and z/OS Messages Manual

A comprehensive listing and explanation of all INCONTROL messages and

codes.

INCONTROL for OS/390 and z/OS Security Guide

Step-by-step guide to implementing security in INCONTROL products using

the ICE application.

User Guides for the INCONTROL Family of Products

Product-specific guides containing comprehensive information about the

operation and implementation of each INCONTROL product.

BMC Software, Inc., Confidential and Proprietary Information

About This Guide

xxxvii

BMC Software, Inc., Confidential and Proprietary Information

xxxviii

INCONTROL for OS/390 and z/OS Utilities Guide

10

Chapter 1

Introduction

This chapter includes the following topics:

Summary of Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
IOA Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
CONTROL-M Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
CONTROL-M/Analyzer Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
CONTROL-D and CONTROL-V Utilities. . . . . . . . . . . . . . . . . . . . . 1-6
CONTROL-O Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
CONTROL-M/Tape Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

BMC Software, Inc., Confidential and Proprietary Information

Chapter 1 Introduction

1-1

Summary of Utilities

Summary of Utilities
The following list provides a short description of each utility used in the
INCONTROL environment. Unless otherwise noted, all utilities are fully
described later in this guide.
Note:

Some utilities prefixed by IOA replace corresponding utilities

prefixed by CTM, CTD, and/or CTB in previous versions. In such
cases, the old utilities are supported for your convenience; however,
you should use the IOA utilities.

IOA Utilities
Table 1-1

IOA Utilities (Part 1 of 2)

Utility

Description

IOABLCAL

Builds calendars.

IOACABPR

Forces a disconnect of the CAB control block, a cross-product

control block used to anchor information.

IOACLCND

Cleans the IOA Conditions file. Called IOACLRES prior to version

6.0.00.

IOACND

Performs IOA Conditions file or CONTROL-M Resources file

adjustments.

IOACCND

Copies or resizes the IOA Conditions file.

IOACPLOG

Copies contents of the IOA Log file to a sequential file or to

another Log file.

IOADBF

Allocates and formats an IOA Access Method files data and

index components.

IOADBIB

Rebuilds index files for various IOA Variable Database data files.

IOADBSR

Sorts the records in an IOA Access Method files data component

in the same logical order as the records in the associated IOA
Access Method files index component.

IOADCPY

Recovers an IOA Access Method file from the dual mirror image
copy and vice versa.

IOADIG

Verifies the integrity of an IOA Access Method files data

component structure, and optionally corrects detected errors.

IOADII

Verifies the integrity of an IOA Access Method files index

component structure.

IOADLD

Loads an IOA Access Method files contents from a sequential

file previously created by utility IOADUL.

IOADPT

Prints IOA Access Method file data and index records in SNAP
dump format.

IOADUL

Unloads an IOA Access Method files data components record

contents to a sequential file.

BMC Software, Inc., Confidential and Proprietary Information

1-2

INCONTROL for OS/390 and z/OS Utilities Guide

Summary of Utilities

Table 1-1

IOA Utilities (Part 2 of 2)

Utility

Description

IOALDNRS

Creates or loads the IOA Manual Conditions list.

IOANOTE

Writes a message to the IOA Log file.

IOAOPR

Issues operator commands.

IOASDISC

Provides a means to disconnect the IOA subsystem in an

emergency.

IOATEST

Simulates various events in the IOA environment.

IOAVCND

For VM/CMS environments. Sets prerequisite conditions in a

CONTROL-M monitor running on an NJE-connected MVS
machine.

IOAVERFY

Verifies file installation, locates errors, optionally implements

corrections and produces status reports for various IOA files.

CONTROL-M Utilities
Table 1-2

CONTROL-M Utilities (Part 1 of 2)

Utility

Description

CTMAESIM

Tests the syntax of AutoEdit control statements.

CTMBGRP

Converts regular scheduling tables to Group scheduling tables.

CTMBLDAE

Builds AutoEdit symbols members using IOA calendars as

input.

CTMBLT

Builds CONTROL-M scheduling tables.

CTMCAJF

Compresses, cleans or changes the size of the CONTROL-M

Active Jobs file.

CTMCRES

Converts the old Condition/Resources file to the version 6.0.00

CONTROL-M Resources file.

CTMHCLN

Performs special maintenance functions on the History Jobs

file.

CTMHCOP

Copies the History Jobs file to a new History Jobs file.

CTMJOB

Orders jobs into the Active Jobs file.

CTMJSA

Accumulates job statistical data in the CONTROL-M Job

Statistics file.

CTMRAFL

Provides job flow information about the jobs in the Active Jobs
file.

CTMRCAL

Creates calendars for each job defined in the CONTROL-M

showing the actual execution dates of the job.

CTMRELRS

Releases resources from a job step.

CTMRES

Allocates and formats the CONTROL-M Resources file.

CTMRFLW

Provides report of job flow information about jobs in scheduling

tables.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 1 Introduction

1-3

Summary of Utilities

Table 1-2

CONTROL-M Utilities (Part 2 of 2)

Utility

Description

CTMRNSC

Provides a summary report of each job that has executed

within specified time range.

CTMROGR

Provides graph of job workloads for planning or adjustment.

CTMRPFL

Provides job flow information report for jobs in a scheduling

table.

CTMRPLN

Provides a list of all jobs that are planned for a specified range
of dates.

CTMRSTR

Restores the Active Jobs file.

CTMSIM

Activates the Simulation and Forecasting facility, described in

the simulating forecasting facility chapter of the CONTROL-M
for OS/390 and z/OS User Guide.

CTMSLC

Facilitates the removal of old job scheduling definitions from

the schedule library.

CTMTAPUL

Produces a Tape Pull list, described in the simulating

forecasting facility chapter of the CONTROL-M for OS/390 and
z/OS User Guide.

CTMTBUPD

Updates CONTROL-M group or job scheduling definition

parameters in batch mode.

CTMXRF

Produces a variety of cross reference reports.

CTMRJDS

Provides a cross reference report, by dataset, of jobs that

access the dataset.
Note: Applicable to CONTROL-M/Restart.

FORMCKP

Allocates, formats, and resizes a CONTROL-M Active Jobs file.

FORMHST

Allocates and formats the CONTROL-M History Jobs file.

FORMRES

Allocates and formats the CONTROL-M Resources file.

CONTROL-M/Analyzer Utilities
Table 1-3

CONTROL-M/Analyzer Database, Group and Variable File

Handling Utilities (Part 1 of 2)

Utility

Description

CTBDBCP

Copies the contents of a specified source file to a specified target

file. All relevant aspects of the file are copied, including (pointers
to) variable definitions, variable generations, and group
information.

CTBDBVCP

Copies a specified variable or group of variables to another set of

variable or group files.

CTBDBVDL

Deletes a variable or a group of variables from variable or group

files.

BMC Software, Inc., Confidential and Proprietary Information

1-4

INCONTROL for OS/390 and z/OS Utilities Guide

Summary of Utilities

Table 1-3

CONTROL-M/Analyzer Database, Group and Variable File

Handling Utilities (Part 2 of 2)

Utility

Description

CTBDBVIG

Checks the integrity of variable or group data files.

CTBDBVCG

Changes the number of generations of a Database variable.

Table 1-4

CONTROL-M/Analyzer Report and Rule Activity File Handling

Utilities

Utility

Description

CTBJAFCP

Copies invocation and report entries to other Rule Activity and

Report files.

CTBJAFDL

Deletes unnecessary entries from the Rule Activity and Report

files.

CTBJAFIG

Checks the integrity of Rule Activity and Report data files.

Table 1-5

CONTROL-M/Analyzer Active Balancing File Utilities

Utility

Description

CTBABI

Initializes the Active Balancing file after creation.

CTBFRM

Compresses the Active Balancing file (usually on a daily basis as

part of the New Day procedure).

Table 1-6

IOA Access Method File Utilities

Utility

Description

CTBDBIB

Rebuilds the indexes of specified CONTROL-M/Analyzer data

files.

CTBDBST

Replaced by utility IOADPT, described in Table 1-1 on page 1-2.

Note:

For more information about IOA Access Method utilities (IOADBF,

IOADCPY, IOADIG, IOADII, and IOADPT), see Chapter 2, IOA
Utilities. For information about other IOA utilities, see IOA
Utilities on page 1-2.

Table 1-7

Miscellaneous Utilities

Utility

Description

CTBCMP

Checks syntax of rule definitions.

CTBVXRF

Produces a report that cross-references CONTROL-M/Analyzer

Database variables and the rules by which they are created and
accessed.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 1 Introduction

1-5

Summary of Utilities

CONTROL-D and CONTROL-V Utilities

Table 1-8

CONTROL-D and CONTROL-V Utilities (Part 1 of 2)

Utility

Description

BKPRESET

Resets the Backup Mission Status.

CTDAMUTI

Copies, moves and deletes CDAM files, described in the CDAM

chapter of the CONTROL-D User Guide.

CTDBLXRP

Deletes and rebuilds all print control records.

CTDCAMF

Compresses or changes the size of the Active Missions file.

CTDCATF

Compresses or changes the size of the Active Transfer file.

CTDCA2P

Copies new report or user entries from the Active User Report
List file to the Permanent User Report List file.

CTDCCFRS

Creates and/or updates a CCF Resources file according to

resources extracted from a XEROX printer tape.

CTDCCU

Identifies CDAM files not referenced by the Active User Report

List file and optionally deletes them.

CTDCLHIS

Deletes entries in the History Reports List file and makes a list of
backup tapes that have expired based on parameter # OF DAYS
or GENERATIONS TO KEEP.

CTDCP2A

Copies empty report or user entries from the Permanent User

Report List file to the Active User Report List file.

CTDDELRP

Moves report entries from the Active to the Migrated and/or

History Report List file and erases their compressed datasets
from DASD storage.

CTDDIB

Rebuilds a CONTROL-D User Report List files index component.

CTDDIG

Checks the integrity of Active, Permanent, History and Migration

User Report List files.

CTDGBPRT

Prints data from the Global Index Database.

CTDSMFRP

Produces a paper usage report for defined users.

CTDUFUPD

Updates Active, Migration, History, or Permanent User files.

CTDULD

Copies records from a sequential file to the current Active,

Permanent, History or Migrated User Report List file.

CTDUPBKP

Updates backup information in User Report List files (Active,

Migration, History, or Permanent).

CTVCLMIG

Cleans entries from the Migrated User Report List file and erases
or uncatalogs their CDAM datasets.

CTVDELI

Deletes unneeded index files from disk based on user-specified

selection groups.

CTVGICL

Removes report entries that no longer exist in Active or Migrated

user files.

CTVJAR

Consolidates reports that are created by Job Archiving.

CTVUNMIG

Reads a migrated CDAM file and recreates the original CDAM file
on DASD.

BMC Software, Inc., Confidential and Proprietary Information

1-6

INCONTROL for OS/390 and z/OS Utilities Guide

Summary of Utilities

Table 1-8

CONTROL-D and CONTROL-V Utilities (Part 2 of 2)

Utility

Description

CTVUPGDB

Updates all index values of an index file in the Global Index

database.

MIGRESET

Resets the Migration Mission Status.

RSTRESET

Resets the Restore Mission Status.

Note:

For more information about IOA Access Method utilities (IOADBF,

IOADBSR, IOADCOPY, IOACPY, IOADIG, IOADII, IOADLD,
IOADPT, and IOADUL), see Chapter 2, IOA Utilities. For
information about other IOA utilities, see IOA Utilities on
page 1-2.

CONTROL-O Utilities
Table 1-9

CONTROL-O Utilities

Utility

Description

CTOALOCP

Backs up the Automation log.

CTOCSF

Copies the Message Statistics file.

CTOCTA

Lists programs running in an address space.

CTOCTI

Generates input for the COSMOS SYSIMAGE facility.

CTORSTM

Produces reports on message statistics.

CTOSMDSC

Forces a disconnect of ON SMS support in emergency

situations.

CTOTEST

Simulates messages or commands to trigger CONTROL-O rules.

CTOUSMDSC

Emergency USS Support Disconnect.

Note:

For more information about IOA Access Method utilities (IOADBF,

IOADBSR, IOADCOPY, IOACPY, IOADIG, IOADII, IOADLD,
IOADPT, and IOADUL), see Chapter 2, IOA Utilities. For
information about other IOA utilities, see IOA Utilities on
page 1-2.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 1 Introduction

1-7

Summary of Utilities

CONTROL-M/Tape Utilities
Table 1-10

CONTROL-M/Tape Trace Utilities

Utility

Description

CTTACP

Copies the Trace file.

CTTAFR

Formats and initializes the Trace file.

CTTCTRC

Allocates and formats the Trace file.

CTTRSM

Recovers Tape Activity from SMF records.

CTTTRB

Synchronizes the Trace file and the Media Database backup

process.

Table 1-11

CONTROL-M/Tape Stacking Utilities

Utility

Description

CTTGVL

Provides a user interface to the Stacking facility.

CTTSBD

Performs dataset stacking in batch mode.

CTTSCA

Detects dataset contentions.

CTTSTK

Builds and updates the Stacking Database.

CTTSTKR

Generates Stacking Statistics reports.

Table 1-12

CONTROL-M/Tape Media Database Utilities

Utility

Description

CTTBIX

Rebuilds the index of the Media Database.

CTTDLD

Adds non-scratch volumes, adds and deletes scratch volumes

and converts from other tape management systems.

CTTIDB

Checks the integrity of the Media Database.

CTTMER

Merges records from an extract file (created by utility CTTSPL)

into the Media Database.

CTTMUP

Performs manual update of the CONTROL-M/Tape Repository.

CTTRCV

Recovers Media Database contents using the Trace file.

CTTSPL

Copies or moves (splits) specified records from the Media

Database.

CTTSYNC

Synchronizes the automated tape libraries with the

CONTROL-M/Tape Media Database.

Table 1-13

CONTROL-M/Tape Daily Management Utilities

Utility

Description

CTTRTM

Performs retention management.

CTTVTM

Performs vault management.

BMC Software, Inc., Confidential and Proprietary Information

1-8

INCONTROL for OS/390 and z/OS Utilities Guide

Summary of Utilities

Table 1-14

CONTROL-M/Tape Database Handling Utilities (for the Media

Database and Stacking Database)

Utility

Description

CTTCRDF

Allocates and formats various data and/or index files.

CTTDBDLD

Loads Media Database and Stacking Database data components

from a sequential dataset.

CTTDBDUL

Unloads Media Database and Stacking Database components to

a sequential dataset.

CTTDBF

Formats existing data and/or index files.

CTTDBIB

Rebuilds the indexes of the Stacking Database.

CTTDBID

Checks the integrity of a data file.

CTTDBII

Checks the integrity of an index file.

CTTDBPRT

Prints (in dump format) records from a database file to a sysout.

Table 1-15

CONTROL-M/Tape Miscellaneous Utilities

Utility

Description

CTTRPT

Generates reports and from extracted Media Database

information.

CTTTPI

Initializes tapes, erases tapes and produces a detailed report of

the logical and physical contents of a volume.

Note:

For more information about IOA Access Method utilities (IOADBF,

IOADBSR, IOADCOPY, IOACPY, IOADIG, IOADII, IOADLD,
IOADPT, and IOADUL), see Chapter 2, IOA Utilities. For
information about other IOA utilities, see IOA Utilities on
page 1-2.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 1 Introduction

1-9

Summary of Utilities

BMC Software, Inc., Confidential and Proprietary Information

1-10

INCONTROL for OS/390 and z/OS Utilities Guide

Chapter 2

IOA Utilities

This chapter includes the following topics:

Note:

Some utilities prefixed by IOA replace corresponding utilities

prefixed by CTM in previous versions. In such cases, the old utilities
are supported for your convenience; however, you should use the
IOA utilities.

IOABLCAL Build Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
IOACABPR Emergency CAB Control Block Disconnect . . . . . . . . . . 2-12
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
IOACLCND Clean the IOA Conditions File . . . . . . . . . . . . . . . . . . . . . 2-13
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Specifying AutoEdit Variables and Functions . . . . . . . . . . . . . . . . . . 2-15
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
IOACLRES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
IOACND Perform IOA Condition File or CONTROL-M Resources File
Adjustments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Parameters for Processing Prerequisite Conditions . . . . . . . . . . . . . . 2-18
Parameters for Processing Control Resources . . . . . . . . . . . . . . . . . . 2-19
Parameters for Processing Quantitative Resources . . . . . . . . . . . . . . 2-19
Activating the Utility (and Examples) . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
IOACCND Copy or Resize IOA Conditions File . . . . . . . . . . . . . . . . . 2-23
Parameters and DDNAMEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
Activating the Utility (Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
IOACPLOG Copy the IOA Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-1

Copying to a Sequential File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25

Copying to a Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
IOADBF Allocate or Format an IOA Access Method File . . . . . . . . . . 2-28
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28
DD Statement DAFILE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
IOA Access Method File Definition Parameters . . . . . . . . . . . . . . . . 2-29
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34
Multiple Extents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
Using the IOADPT Utility for Space Management . . . . . . . . . . . . . . 2-35
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
CONTROL-M/Analyzer Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
IOA Samples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
IOADBIB Rebuild Index Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
IOADBSR Sort Records in IOA Access Method Data Component. . . . 2-40
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40
Sort Control Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42
IOADCPY Recover an IOA Access Method File . . . . . . . . . . . . . . . . . 2-43
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44
IOADIG Verify Integrity of IOA Access Method File Data Component2-46
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
IOA Samples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
IOADII Verify Integrity of IOA Access Method File Index Component2-49
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50
IOADLD Load IOA Access Method File Contents . . . . . . . . . . . . . . . . 2-51
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-51
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
IOA Samples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-53
IOADPT Print IOA Access Method File Content . . . . . . . . . . . . . . . . . 2-54

BMC Software, Inc., Confidential and Proprietary Information

2-2

INCONTROL for OS/390 and z/OS Utilities Guide

Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
IOA Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
IOADUL Unload IOA Access Method File Contents . . . . . . . . . . . . . . 2-56
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-56
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
CONTROL-D Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
CONTROL-M/Tape Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
IOA Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
IOAFRLOG - Allocate and Format the IOA Log File . . . . . . . . . . . . . . . 2-59
IOAFRNRS - Allocate and Format the IOA Manual Conditions File . . . 2-59
IOALDNRS Load IOA Conditions File . . . . . . . . . . . . . . . . . . . . . . . . 2-60
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
IOANOTE Write a Message to the IOA Log File . . . . . . . . . . . . . . . . . 2-63
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
IOAOPR - Issue Operator Commands using a Job or STC . . . . . . . . . . . 2-65
IOASDISC Emergency Subsystem Disconnect. . . . . . . . . . . . . . . . . . . 2-66
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
IOATEST Simulate Production Environment Events . . . . . . . . . . . . . . 2-67
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-67
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
IOAVERFY Verify IOA File Installation and Status . . . . . . . . . . . . . . . 2-69
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Trace Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-3

IOABLCAL Build Calendars

IOABLCAL Build Calendars

The scheduling of jobs, missions and rules in the IOA environment is
frequently based on calendars. A data center can use different calendars for
different scheduling requirements.
Table 2-1

Scheduling Calendars

Calendar

Description

WORKDAYS

All working days in the year

HOLIDAYS

All nonstandard holidays

ENDOFMON

Business end-of-month scheduling

NOTEOFMN

All working days except end-of-month days

In many cases, a calendar is related to, or derived from, another calendar or a

combination of two other calendars. For example, in the calendars listed
above, calendar NOTEOFMN can be derived from a combination of the
WORKDAYS and ENDOFMON calendars.
When calendars are related, a change to one calendar frequently affects other
calendars. This can make manual maintenance of calendars time consuming
and error prone. Utility IOABLCAL simplifies and automates calendar
maintenance.
Through parameters supplied to the utility, the user specifies two existing
calendars and the operation (or formula) that determines how the calendars
are combined to build a new calendar.
The new calendar created by the utility is a regular calendar. It can be viewed
using Option 8 (Calendars) of the IOA Primary Option menu and it can be
used as an input calendar in subsequent runs of the utility. Thus, using several
basic calendars, numerous other calendars can be created.
It is recommended that all steps that calculate calendars be collected into one
job, and that the job be run once a day. This refreshes the calendars in the
event that changes are made to the basic calendars.

BMC Software, Inc., Confidential and Proprietary Information

2-4

INCONTROL for OS/390 and z/OS Utilities Guide

IOABLCAL Build Calendars

Parameters
Parameters are supplied to the utility either using DD statement DABCLIN
(or SYSIN) or using PARM. You can specify any number of parameter
statements. The parameter statement syntax is
calendar1 operator calendar2 = calendar3
where
Table 2-2

IOABLCAL Parameters

Parameter

Description

calendar1,
calendar2

Input calendars.

operator

One of the following operators:

+, , *, <W nn, >W nn, <>W, ><W

calendar3

Resulting calendar.

If the operation is +, calendar3 contains all days scheduled in calendar1 and

additionally all days scheduled in calendar2.
If the operation is , calendar3 contains all days scheduled in calendar1
excluding those days scheduled in calendar2.
If the operation is *, calendar3 contains all days scheduled in calendar1 that
are also scheduled in calendar2. The day has to be marked for execution in
both calendars in order to be marked for execution in calendar3.
If calendar2 is a relative calendar, additional logic is required to handle the *
operation mentioned above. (A relative calendar is a calendar that contains
days marked + or - instead of, or in addition to, days scheduled or not
scheduled.) Each day in calendar2 that contains a + or sign is checked
against the same day in calendar1. If the day is marked for execution in
calendar1, it is marked for execution in calendar3. However, if the day is not
marked for execution in calendar1, the result depends on how the day was
marked in calendar2:

If the day was marked + in calendar2, the closest next day marked for
execution in calendar1 is marked for execution in calendar3.

If the day was marked in calendar2, the closest previous day marked
for execution in calendar1 is marked for execution in calendar3.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-5

IOABLCAL Build Calendars

Operations <W nn and >W nn create a new calendar (calendar3) by shifting

the days in an old calendar (calendar1) a specified number of working days
according to the specified workdays calendar (calendar2):

Symbol < indicates that days are shifted to the left (meaning, to
preceding days).

Symbol > indicates that days are shifted to the right (meaning, to
subsequent days).

The number of working days to shift is nn.

The logic for operations <W nn and >W nn is as follows:

Each day marked for execution in calendar1 is checked against

calendar2.
If the same day is a working day in calendar2, nn working days in
calendar2 are counted in the direction of the shift and the resulting
day is marked as a working day in calendar3.
If the same day is not a working day in calendar2, the closest
working day in the direction of the shift is identified in calendar2.
From that working day, nn working days in calendar2 are counted in
the direction of the shift and the resulting day is marked as a working
day in calendar3.

If operation <>W or ><W is specified, then for each working day

(meaning, day marked for execution) in calendar1:
If the same day is a working day in calendar2, it is marked as a
working day in calendar3.
If the same day is not a working day in calendar2, the closest
working day (in either direction) is marked as a working day in
calendar3.
If two working days are equally close (meaning, the same number of
days before and after), the day selected depends on the parameter
specified:

If <>W was specified, the earlier working day is selected as the

working day for calendar3.

BMC Software, Inc., Confidential and Proprietary Information

2-6

INCONTROL for OS/390 and z/OS Utilities Guide

IOABLCAL Build Calendars

Note:

If ><W was specified, the later working day is selected as the

working day for calendar3.

If specifying operator <W nn, >W nn, <>W, or ><W, calendars must
be defined in year order, must contain the same years, and must not
contain more than 15 years.

Activating the Utility

// EXEC IOABLCAL
calendar1 operator calendar2 = calendar3

where operator is +, , *, <W nn, >W nn, <>W or ><W

Return Codes
Table 2-3

IOABLCAL Return Codes

Code

Description

Operation performed successfully

8 and above

Operation failed

Examples
Example 1

The following parameter specification is passed to the utility:

calendar1 * calendar2 = calendar3

Assuming the following calendars:

S ----------- S
1 2 3 4 5 6 7 8
Y Y Y Y Y
Y
S ----------- S

----------- S ------9 + 1 2 3 4 5 6 7 8 9
Y Y Y Y Y
Y
----------- S -------

calendar1

and

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-7

IOABLCAL Build Calendars

S ----------- S ----------- S ------1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9

Y Y + +
+
S ----------- S ----------- S -------

calendar2

The resulting new calendar is:

S ----------- S ----------- S ------1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9
Y Y Y Y
Y
Y
Y
S ----------- S ----------- S -------

calendar3

Note the following points in this example:

Since the operation is *, days 2 and 3, that are marked for execution in
both calendar1 and calendar2, is marked for execution in calendar3.

Day 4 is marked + in calendar2 and is marked for execution in

calendar1. Therefore, it is marked for execution in calendar3.

Day 5 is marked in calendar2 and is marked for execution in

calendar1. Therefore, it is marked for execution in calendar3.

Day 6 is not marked in calendar2. Therefore, even though it is scheduled

in calendar1, it is not be marked for execution in calendar3. This same
reasoning applies to days 8, 9, 10, 11, 12, 13 and 19. However, days 8, 13
and 19 are marked for execution for other reasons described below.

Day 7 is marked + in calendar2 and is not marked for execution in

calendar1. The closest following day marked for execution in calendar1
is day 8. Therefore, day 8 is marked for execution in calendar3.

Day 14 is marked + in calendar2 and is not marked for execution in

calendar1. The closest following day marked for execution in calendar1
is day 19. Therefore, day 19 is marked for execution in calendar3.

Day 16 is marked in calendar2 and is not marked for execution in

calendar1. The closest preceding day marked for execution in calendar1
is day 13. Therefore, day 13 is marked for execution in calendar3.

Example 2

The following parameter specification is passed to the utility:

OLDCAL <W 2 WORKDAYS = NEWCAL

Assuming the following calendars:

BMC Software, Inc., Confidential and Proprietary Information

2-8

INCONTROL for OS/390 and z/OS Utilities Guide

IOABLCAL Build Calendars

S - - - - - - S - - - - - - S - - - 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9
Y
Y Y Y
Y
S - - - - - - S - - - - - - S - - - -

OLDCAL

and
S - 1 2 3
Y
S - -

4
Y
-

5
Y
-

6
Y
-

- S - - 7 8 9 + 1
Y
Y Y
- S - - -

2
Y
-

- - S 3 4 5 6
Y
- - S -

7
Y
-

8
Y
-

9
Y
-

WORKDAYS

The resulting new calendar is:

S - - - - - - S - - - - - - S - - - 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9
Y
Y Y
Y Y
S - - - - - - S - - - - - - S - - - -

NEWCAL

Note the following points in this example:

Operation <W 2 specifies that for each working day in OLDCAL, utility
IOABLCAL finds the corresponding working day in WORKDAYS, and
then shift two workdays to the left.

The first workday in OLDCAL is day 5. This is also a workday in

WORKDAYS. The 2nd workday to the left of day 5 in WORKDAYS is
day 3, that becomes a workday in NEWCAL.

The next workday in OLDCAL is day 10. This is also a workday in

WORKDAYS. The 2nd workday to the left of day 10 in WORKDAYS is
day 6, that becomes a workday in NEWCAL.

The next workday in OLDCAL is day 11. This is also a workday in

WORKDAYS. The 2nd workday to the left of day 11 in WORKDAYS is
day 7, that becomes a workday in NEWCAL.

The next workday in OLDCAL is day 12. This is also a workday in

WORKDAYS. The 2nd workday to the left of day 12 in WORKDAYS is
day 10, that becomes a workday in NEWCAL.

The next workday in OLDCAL is day 15. This is not a workday in

WORKDAYS. The closest workday to the left, in WORKDAYS, is day
13. The 2nd workday to the left of day 13 in WORKDAYS is day 11, that
becomes a workday in NEWCAL.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-9

IOABLCAL Build Calendars

Example 3

The following parameter specification is passed to the utility:

OLDCAL ><W

WORKDAYS = NEWCAL

Assuming the following calendars:

S - - - - - - S - - - - - - S - - - 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9
Y
Y Y
Y
Y
S - - - - - - S - - - - - - S - - - -

OLDCAL

and
S - 1 2 3
Y
S - -

4
Y
-

5
Y
-

6
Y
-

- S - - 7 8 9 + 1
Y
Y Y
- S - - -

2
Y
-

- - S 3 4 5 6
Y
- - S -

7
Y
-

8
Y
-

9
Y
-

WORKDAYS

The resulting new calendar is:

S - - - - - - S - - 1 2 3 4 5 6 7 8 9 + 1
Y
Y
Y
S - - - - - - S - - -

- - - S - - - 2 3 4 5 6 7 8 9
Y
Y
- - - S - - - -

NEWCAL

Note the following points in this example:

Operation ><W specifies that for each working day in OLDCAL, utility
IOABLCAL finds the closest working day in WORKDAYS, and make
that day a workday in NEWCAL.

The first workday in OLDCAL is day 5. This is also a workday in

WORKDAYS, so it becomes a workday in NEWCAL.

The next workday in OLDCAL is day 8. This is not a workday in

WORKDAYS. The next closest workday in WORKDAYS is day 7, so
day 7 becomes a workday in NEWCAL.

The next workday in OLDCAL is day 9. This is not a workday in

WORKDAYS. The next closest workday in WORKDAYS is day 10, so
day 10 becomes a workday in NEWCAL.

The next workday in OLDCAL is day 12. This is also a workday in

WORKDAYS, so it becomes a workday in NEWCAL.

BMC Software, Inc., Confidential and Proprietary Information

2-10

INCONTROL for OS/390 and z/OS Utilities Guide

IOABLCAL Build Calendars

The next workday in OLDCAL is day 15. This is not a workday in

WORKDAYS. The next closest workdays in WORKDAYS are days 13
and 17 (that are equally close to day 15). Since the parameter operation
statement ><W began with symbol >, the value to the right (meaning, the
subsequent day) is chosen. Therefore, day 17 becomes a workday in
NEWCAL.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-11

IOACABPR Emergency CAB Control Block Disconnect

IOACABPR Emergency CAB Control Block

Disconnect
Utility IOACABPR forces a disconnect of the CAB control block, a
cross-product control block used to anchor information. The CAB control
block is anchored indirectly from the MVS CVT, at offset xAC of the
customer table.
Note:

This utility is used in appropriate emergencies only. It is

recommended that it not be used unless specifically advised by BMC
Software Customer Support.

The utility can be activated using job IOACABJ located in the

IOAprefix.INSTALL library. The utility procedure, IOACABPR, is located in
the IOAprefix.PROCLIB library.

Activating the Utility (and Example)

//CABSTEP EXEC IOACABPR,FUNC=DISC

Return Codes
Table 2-4

IOACABPR Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

2-12

INCONTROL for OS/390 and z/OS Utilities Guide

IOACLCND Clean the IOA Conditions File

IOACLCND Clean the IOA Conditions File

Note:

Prior to version 6.0.00, this utility was called IOACLRES and it

cleaned the IOA Conditions/Resources file. As of version 6.0.00, that
file has been split into separate files, the IOA Conditions file and the
CONTROL-M Resources file, and the utility now cleans only the
IOA Conditions file.

This utility cleans the IOA Conditions file of conditions that are no longer
required. It is recommended that this utility be activated as part of IOA
maintenance.
Note:

If the IOA Conditions file is shared across multiple CPUs, use an

enqueue manager (such as MIM or GRS) to prevent simultaneous
update of the file. For more information, see the description of the
QNAME and SHRQNAM parameters in the IOA installation chapter
of the INCONTROL for OS/390 and z/OS Installation Guide.

Parameters
Unless the utility is instructed otherwise using parameters, it deletes all
prerequisite conditions (except those whose date reference is STAT) in the
IOA Conditions file.
The utility outputs a list of all the deleted prerequisite conditions.
Prerequisite conditions that must not be deleted (for example, prerequisite
conditions needed throughout the year) are specified by means of control
statements, that are specified using DD statement DACRSIN or SYSIN. The
formats of these statements are displayed below, followed by explanations:

COND
date
date
IGNORE ------------------------- { cond prefix } FROM ----------- TO -----------
CONDIN

YES
CONTROLM ------------
NO

YES
CONTROLD ------------
NO

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-13

IOACLCND Clean the IOA Conditions File

IGNORE statements instruct the utility not to delete the indicated

prerequisite conditions, as follows:

An IGNORE COND statement instructs the utility not to delete the

indicated prerequisite condition under any circumstances.

An IGNORE CONDIN statement instructs the utility not to delete the

indicated prerequisite conditions if the utility determines that the
prerequisite conditions are referenced conditions. A referenced condition
is a prerequisite condition appearing in the IOA Conditions file at the
same time that it appears as an IN condition in an active job, mission or
rule (for example, one that is currently present in the Active Jobs file or
Active Missions file).

cond-prefix specifies the prefix of prerequisite conditions that are not

deleted. An asterisk indicates all prerequisite conditions.

If a FROM or TO combination is supplied, a specified condition is not

deleted if its date is in the date range. Conditions not in the date range are
deleted, unless they are referred to by another IGNORE statement.

date can be either a specific date in the site defined standard (mmddyy,
ddmmyy or yymmdd) or a relative date. A relative date is specified in the
format n, where n is the number of days before the current date (for
example, 5 means five days before the current date). Relative and
specific dates can be mixed (for example, a specific FROM date and a
relative TO date).

When a FROM and/or TO date is not specified, the current date is the default
for the unspecified date. The TO date (regardless of whether specific, relative
or assumed) cannot precede the FROM date.
Note:

Prerequisite conditions whose date reference is STAT are ignored by

this utility.

CONTROLM and CONTROLD statements indicate whether the utility

checks prerequisite conditions in the Active Jobs file and/or the Active
Missions file, respectively, if an IGNORE CONDIN statement is specified.
By default, each of these files is checked if its respective product is installed
(according to IOA installation options). These statements can be used to
override the default. You can specify either, both or neither of these
statements.
These statements can impact the result of an IGNORE CONDIN statement
because the utility cannot determine that a prerequisite condition is
referenced unless it can check the Active Jobs or Missions file for the job or
mission containing the IN prerequisite condition.

BMC Software, Inc., Confidential and Proprietary Information

2-14

INCONTROL for OS/390 and z/OS Utilities Guide

IOACLCND Clean the IOA Conditions File

Valid values for these statements are described below:

Table 2-5

CONTROL-M and CONTROL-D Statements

Statement

Description

CONTROLM

Determines whether the CONTROL-M Active Jobs file is checked

during the cleanup process of the IOA Conditions file. Optional.
Valid values are:
YES Check the Active Jobs file. Default (if CONTROL-M is
installed).
NO Do not check the Active Jobs file. Default (if
CONTROL-M is not installed).

CONTROLD

Determines whether the CONTROL-D Active Missions file is

checked during the cleanup process of the IOA Conditions file.
Optional. Valid values are\\\\\\\\\\\;
YES Check the Active Jobs file. Default (if CONTROL-M is
installed).
NO Do not check the Active Jobs file. Default (if
CONTROL-M is not installed).

The utility can be run simultaneously with the CONTROL-M and the
CONTROL-D monitors.
If the job is submitted under CONTROL-M, AutoEdit variables are
supported.

Activating the Utility

// EXEC IOACLCND

Specifying AutoEdit Variables and Functions

AutoEdit variables can be specified for any of the above parameters. These
variables are especially useful for specifying relative date ranges in the
FROM and TO parameters.
AutoEdit functions can be used to set variables and these variables can then
be used in the parameters of the utility. The lines in which the variables are
set must have an asterisk (*) in the first column of the line. Such lines are
resolved by the AutoEdit facility and are interpreted as comments by the
utility. Regular comments can also be specified in lines with an asterisk in the
first column.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-15

IOACLCND Clean the IOA Conditions File

Return Codes
Table 2-6

IOACLCND Return Codes

Code

Description

Operation performed successfully.

Execution error, operation stopped.

8 and above

Critical error, task not performed.

Examples
Example 1

You should run this job weekly. Since this job contains AutoEdit variables, it
must be submitted directly using the CONTROL-M monitor. (The example
assumes date standard mmddyy. For ddmmyy format, the AutoEdit variable is
%%ODAY.%%OMONTH.%%OYEAR. For yymmdd format, the AutoEdit
variable is %%OYEAR.%%OMONTH.%%ODAY.)
Figure 2-1

// EXEC
IGNORE
IGNORE
IGNORE

IOACLCND Example 1

IOACLCND
COND * FROM -10 TO %%OMONTH.%%ODAY.%%OYEAR
COND CICS
COND DB-

Example 2

Clean the IOA Conditions file of all prerequisite conditions not referenced by
jobs in the Active Jobs file, except those prerequisite conditions beginning
with CICS (prerequisite conditions beginning with CICS are not deleted). Do
not check the Active Missions file to see if a prerequisite condition is
referenced.
Figure 2-2

IOACLCND Example 2

// EXEC
IOACLCND
IGNORE CONDIN * CONTROLD NO
IGNORE COND CICS

BMC Software, Inc., Confidential and Proprietary Information

2-16

INCONTROL for OS/390 and z/OS Utilities Guide

IOACLRES

IOACLRES
Note:

As of version 6.0.00, utility IOACLRES has been renamed

IOACLCND. For details, see IOACLCND Clean the IOA
Conditions File on page 2-13.

IOACND Perform IOA Condition File or

CONTROL-M Resources File Adjustments
This utility adds, verifies the existence of, deletes, or modifies prerequisite
conditions in the IOA Conditions file and/or resources in the CONTROL-M
Resources file. It can be activated by the operator as a started task (STC),
from TSO, or from within a user program.
The addition, deletion, modification or verification is recorded three ways: in
the job sysout, as a message on the operator console and as an event in the
IOA Log file.
Parameters can be received by the utility in two ways: using DD statement
DACNDIN (or SYSIN), or using PARM. The parameters required depend on
whether prerequisite conditions, control resources or quantitative resources
are being processed. If an input parameter file is specified, its block size must
not exceed 8000.
If it is necessary to add, delete, verify or modify prerequisite conditions or
resources during a job step, IOACND can be called as a procedure from
within the application program. For more information, see Activating the
Utility on page 2-15.
Note:

If the IOA Conditions file and/or the CONTROL-M Resources file is

shared across multiple CPUs, use an enqueue manager (such as MIM
or GRS) to prevent simultaneous update of the file. For more
information, see the description of the QNAME and SHRQNAM
parameters in the IOA installation chapter in the INCONTROL for
OS/390 and z/OS Installation Guide.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-17

IOACND Perform IOA Condition File or CONTROL-M Resources File Adjustments

Parameters for Processing Prerequisite Conditions

operation COND condition condition_date

where:

operation is the action to be performed by the utility. Valid values are

ADD Add the specified prerequisite condition.
DELETE Delete the specified prerequisite condition.
CHECK Verify the existence of the specified prerequisite
condition.

condition is the name of the prerequisite condition.

condition_date is the date associated with the prerequisite condition.

Valid values are
mmdd, ddmm Any specific date (in format mmdd or ddmm,
depending on the site standard).
DATE Current Gregorian date.
WDATE IOA working date.
STAT Static. Indicates that the condition (for example,
IMS-ACTIVE) is not date-dependent.

Date character masking for DELETE and CHECK functions is supported as

follows:

* represents any value in the corresponding position of the date (format

mmdd or ddmm depending on the site standard). Up to four asterisks can
be specified. For example:

**** represents any date.

BMC Software, Inc., Confidential and Proprietary Information

2-18

INCONTROL for OS/390 and z/OS Utilities Guide

IOACND Perform IOA Condition File or CONTROL-M Resources File Adjustments

Parameters for Processing Control Resources

operation CONTROL resource control

where

operation is the action to be performed by the utility. Valid values are

ADD Add the specified Control resource under the specified type
of control.
DELETE Delete the specified resource that is under the specified
type of control.

resource is the name of the resource.

control is the type of control. Valid values are

E Exclusive control.
S Shared control.

Parameters for Processing Quantitative Resources

operation RESOURCE resource quantity

where

operation is the action to be performed by the utility. Valid actions are

ADD Add the specified Quantitative resource with the quantity
specified. quantity is mandatory.
DELETE Delete the resource (and the entire existing quantity).
quantity must not be specified.
CHANGE Adjust the existing quantity of the Quantitative resource
to or by the value specified in quantity. quantity is mandatory.

resource is the quantitative resource name.

quantity is the quantity of the Quantitative resource.

For CHANGE operations, valid values can have the format n, +n, or n
where n is an integer. When n is specified, the quantity of the
Quantitative resource is set to n. When +n or n is specified, the quantity
is increased or decreased by n.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-19

IOACND Perform IOA Condition File or CONTROL-M Resources File Adjustments

For ADD actions, valid values can only have the format n, where n is the
quantity of the Quantitative resource to be added.

Activating the Utility (and Examples)

Utility IOACND can be activated as a step in a job or from an application
program (as illustrated in the following examples). In these cases, proper
protocol is ensured. However, if you use a different method to invoke utility
IOACND, follow the rules below to ensure that the proper protocol is
maintained:

When utility IOACND receives control, register 1 must contain the

address of a fullword.

To indicate this is the last, and only, parameter, the high-order byte must
contain X'80'.

The three low order bytes of the fullword must contain the address of a
halfword field.

The halfword field must be the count of the number of bytes of

information contained in the parameter list.

The parameters must immediately follow the halfword field.

As a job step:
//CND1 EXEC IOACND
ADD COND JOB-A-ENDED-OL 0505
DELETE COND JOB-A-DID-NOT-RUN 0505
CHANGE RESOURCE TAPE -1
ADD RESOURCE INIT-CPUA 3
DELETE RESOURCE INIT-CPUB
ADD CONTROL PROD-DATA-BASE E

As a job containing AutoEdit variables, submitted through the

CONTROL-M monitor:
//CND1 EXEC IOACND
ADD COND
AR-FILE-009-CREATED

%%OMONTH.%%ODAY

As an operator command:
S IOACND,PARM=ADD COND END-CICS 0102

BMC Software, Inc., Confidential and Proprietary Information

2-20

INCONTROL for OS/390 and z/OS Utilities Guide

IOACND Perform IOA Condition File or CONTROL-M Resources File Adjustments

As a called procedure in an application program:

CALL
LTR
BNZ
...
PARMCOND DC
DC
CL80ADD

IOACND,(PARMCOND),VL
R15,R15
ERROR
AL2(80)
COND CICS-FILE-CLOSED 0102

As invoked from a REXX exec:

parm = ADD COND cond_name odat
address linkmvs ioacnd parm
Note:

Program IOACND works in 24-bit addressing mode and is reusable

(but not reentrant).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-21

IOACND Perform IOA Condition File or CONTROL-M Resources File Adjustments

Return Codes
Table 2-7

IOACND Return Codes

Action

Code

Description

ADD

Prerequisite condition or resource added

Prerequisite condition or resource already exists

12 and above

Function failed

Prerequisite condition deleted

Prerequisite condition or resource to be deleted does not exist

12 and above

Function failed

Prerequisite condition exists

Prerequisite condition or resource does not exist

12 and above

Function failed

Quantity of Quantitative resource adjusted successfully

Quantitative resource does not exist

12 and above

Function failed

DELETE

CHECK

CHANGE

Note:

If you are working in a VM/CMS environment, the IOAVCND utility

can be used to set prerequisite conditions in a CONTROL-M monitor
running on an NJE-connected MVS machine.
The EXEC statement for utility IOAVCND utilizes standard
IOACND input and sends a job to the MVS node to set the
conditions.
Example:
EXEC

IOAVCND

ADD COND VM-READY

STAT

BMC Software, Inc., Confidential and Proprietary Information

2-22

INCONTROL for OS/390 and z/OS Utilities Guide

IOACCND Copy or Resize IOA Conditions File

IOACCND Copy or Resize IOA Conditions File

This utility copies the contents of the IOA Conditions file to another file that
may or may not be the same size or version.
To change the size of the IOA Conditions perform the following steps:
1. Enter the INCONTROL Installation and Customization Engine (ICE)
Customize activity for IOA.
2. Select major step Customize IOA Dataset Parameters.
3. Change the parameter values.
4. Perform step Save Parameters into Product Libraries.
5. Perform step Format IOA Conditions File.
6. Run utility IOACCND. The utility copies the current IOA Conditions to
the new file.

Parameters and DDNAMEs

Table 2-8

IOACCND Parameters

Parameter

Description

PARM

MODE=COPY when old file is version 6.0.00

'MODE=CONVERT' when old file is version 5.x.xx

OLDCND

Name of the old IOA Conditions file

NEWCND

Name of the new IOA Conditions file

For details, see sample job IOACCND in the IOA JCL library.

Activating the Utility (Example)

Figure 2-3

IOACCND Example

// EXEC PGM=IOACPC,PARM=COPY
// OLDCND=IOA.old.CND, OLD CONDITIONS FILE
// NEWCND=IOA.new.CND, NEW CONDITIONS FILE

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-23

IOACCND Copy or Resize IOA Conditions File

Return Codes
Table 2-9

IOACCND Return Codes

Code

Description

Operation performed successfully.

Failure to initialize the IOAENV environment because the SNC

file is in use.

28

Insufficient storage. Increase the amount of storage specified in

the REGION parameter.

32

Unable to open the input IOA Conditions file.

36

Unable to open the output IOA Conditions file.

40

Unable to open the output IOA Conditions file.

44

After migration from version 5.x.x to version 6.0.00, the

version 6.0.00 IOA Conditions file resulted in fewer conditions per
day than in the version 5.x.x IOA Conditions/Resources file.
Ensure that the CNDREC# installation parameter is set to greater
than or equal to the RESREC# installation parameter used in
version 5.x.x. For more information on the CNDREC# installation
parameter, refer to the INCONTROL for OS/390 and z/OS
Installation Guide.

52

Unsupported PARM value. The currently supported PARM values

are MODE=CONVERT and MODE=COPY

BMC Software, Inc., Confidential and Proprietary Information

2-24

INCONTROL for OS/390 and z/OS Utilities Guide

IOACPLOG Copy the IOA Log File

IOACPLOG Copy the IOA Log File

Utility IOACPLOG copies the contents of the IOA Log file. The contents can
be copied to a sequential file or to another Log file. Usage of the utility
depends on the type of target file.

Copying to a Sequential File

The IOA Log file is generally copied to a sequential file for archiving. The
sequential file can be restored for access under ISPF (for example, browsing)
and for use by report generators.
A date range for the log records to be copied can be specified. If a date range
is not specified, the entire Log file is copied.
The target sequential file is referenced by DD statement DALOGSEQ. The
existing Log file is referenced by DD statement DALOGCUR.
You should use the utility daily to copy the contents of the IOA Log file to a
sequential file. Use of AutoEdit parameters can simplify the process.

Parameters

Parameters are supplied using DD statement DALCPPRM (or SYSIN).

Table 2-10

IOACPLOG Copy to Sequential File Parameters

Parameter

Description

COPYTOSEQ

Indicates that the utility is being used to copy records from the
IOA Log file to a sequential file.

FROMDATE
yymmdd

Date of the earliest Log record to be copied. AutoEdit variables

are supported.

TODATE
yymmdd

Date of the latest Log record to be copied. AutoEdit variables are

supported.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-25

IOACPLOG Copy the IOA Log File

Activating the Utility (and Example)

Figure 2-4

IOACPLOG Example 1

//* %%SET %%D = %%CALCDATE %%ODATE -1

//
EXEC IOACPLOG
//DALOGSEQ DD DSN=prefix.seqfile,DISP=... Target sequential file
//DALCPPRM DD *
COPYTOSEQ
FROMDATE %%D
TODATE %%D
//

Return Codes
Table 2-11

IOACPLOG Copy to Sequential File Return Codes

Code

Description

Operation performed successfully

Other

Operation failed

Copying to a Log File

This function is generally used to copy one Log file to another. The target
Log file size can be different from the source Log file size. However, if the
target Log file is smaller, the oldest records in the source Log file may be
deleted.
The target Log file is referenced by DD statement DALOG.

Parameters

One parameter is supplied using DD statement DALCPPRM (or SYSIN).

The existing Log file is referenced by DD statement DALOGCUR.
Table 2-12

IOACPLOG Copy to Log File Parameters

Parameter

Description

COPYTOLOG

Indicates that the utility is being used to copy the IOA Log file to
another Log file.

BMC Software, Inc., Confidential and Proprietary Information

2-26

INCONTROL for OS/390 and z/OS Utilities Guide

IOACPLOG Copy the IOA Log File

Activating the Utility (and Example)

Figure 2-5

IOACPLOG Example 2

// EXEC IOACPLOG
//DALOG DD DSN=prefix.logfile,DISP=...Target Log file
//DALCPPRM DD *
COPYTOLOG
//

Note:

Subparameters FROMDATE and TODATE cannot be used with

parameter COPYTOLOG.

Return Codes
Table 2-13

IOACPLOG Copy to Log File Return Codes

Code

Description

Operation performed successfully

Other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-27

IOADBF Allocate or Format an IOA Access Method File

IOADBF Allocate or Format an IOA Access Method

File
The IOADBF utility is used to allocate and format the data and index
components of an IOA Access Method file. This utility uses database
definition statements stored in specified members to perform a requested
operation. These members are created by ICE during product installation, and
can be managed through the ICE Customize option.

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADBF JCL procedure:
Table 2-14

IOADBF Parameters

Parameter

Description

FUNC

Function to be performed:
INIT Allocates and initializes (formats) a new IOA Access
Method file component.
FORM Reformats an existing IOA Access Method file
component.
EXTEND Allocates and formats a new secondary extent
for an existing IOA Access Method file component.
CHANGE Changes or updates an IOA Access Method
file components internal attribute settings. This function is
used when it is necessary to change the settings of
parameters in an IOA Access Method file definition after
the file has been created.
DUALOK Resets the flag that indicated a corrupted Dual
Mirror Image file (DUALBAD). This function is used after a
corrupted Dual Mirror Image file has been restored using
utility IOADCPY.

Dataset name suffix of the IOA library containing the IOA

Access Method file Definition Statements member. The
member name is specified using parameter M below.

Name of the IOA library member that contains the IOA

Access Method file Definition Statements and whose dataset
name suffix is specified using parameter D above.
Note: Each product creates its own database member during
the ICE installation process.

BMC Software, Inc., Confidential and Proprietary Information

2-28

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBF Allocate or Format an IOA Access Method File

DD Statement DAFILE
When executing utility IOADBF with parameter FUNC set to EXTEND or
CHANGE, a DAFILE DD statement, specifying the name of the IOA Access
Method file components primary dataset extent, must be included in the JCL
step executing the utility.

IOA Access Method File Definition Parameters

The following IOA Access Method file definition parameters can be specified
as input to utility IOADBF in the IOA library and member referred to above
by EXEC statement parameters D and M:
Table 2-15

IOADBF Access Method Parameters (Part 1 of 5)

Parameter

Description

BLKSIZE

Block size of the IOA Access Method file, in bytes. For all
index components and for data components with variable
length records, it is recommended that the block size be set
to the maximum half track capacity of the device on that the
IOA Access Method file is allocated, as follows:
19068 3350 DASD devices.
23476 3380 DASD devices.
27998 3390 DASD devices.
22928 9345 DASD devices.
For data components with fixed length records, where the
block size must be a multiple of the record length, it is
recommended that the block size be set as close to, without
exceeding, the devices half track capacity.
Parameter BLKSIZE is not applicable when executing utility
IOADBF with the FORM or CHANGE function specified.

BUFL

Number of I/O buffers for which extended storage is obtained

to access the IOA Access Method file.
Note: This parameter cannot be used with
CONTROL-M/Analyzer files.
Buffer length is determined by parameter BLKSIZE,
described above. A larger number improves I/O throughput at
the expense of increased storage requirements. A smaller
number reduces storage requirements at the expense of
degrading I/O throughput.

COMPRS

Name of the IOA supplied routine to perform Data component

record compression. This parameter must not be specified for
index components.
The setting for COMPRS is IOA application dependent and
must not be modified unless instructed otherwise by BMC
Software Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-29

IOADBF Allocate or Format an IOA Access Method File

Table 2-15

IOADBF Access Method Parameters (Part 2 of 5)

Parameter

Description

COMPTB

Name of the IOA supplied compression table to be used by

the compression routine when performing data component
record compression. Do not specify this parameter for index
components.
Note: If parameter COMPRS is specified, parameter
COMPTB must also be specified.
Parameters COMPRS and COMPTB are not available when
executing utility IOADBF with the FORM or CHANGE function
specified.
Parameters COMPRS and COMPTB are not available when
executing utility IOADBF on a CONTROL-M/Analyzer or
CONTROL-O file.
The setting for COMPTB is IOA application dependent and
must not be modified unless instructed otherwise by BMC
Software Customer Support.

DSN

The dataset name of the IOA Access Method file, excluding

the extent number suffix (.E000 through .E255) that the
IOADBF utility appends automatically when the IOA Access
Method file is allocated.
The DSN parameter is not applicable when executing the
IOADBF utility with the FORM or CHANGE function specified.

DUAL

Whether to allocate a dual mirror image of the specified file,

which provides maximum data recovery capabilities when the
disk or contents of the primary file become damaged or
inaccessible. BMC Software recommends setting this
parameter to Y for the Data component file.
Valid values are:
Y (Yes)Allocate a dual mirror image copy. The dual mirror
image files contents are kept synchronized with the
contents of the primary file.
N (No)Do not allocate a dual mirror image copy.
Note: For CONTROL-M/Tape, this parameter must be set
to N.

DUALM

Whether to terminate or continue execution if a

nonrecoverable I/O error occurs while processing the dual
mirror image copy of the file.
Valid values are:
Y (Yes)Terminate execution.
N (No)Continue execution.

DUALST

Whether to perform timestamp checkpoint processing is

internally to ensure that the primary and dual mirror image
copies of the file are fully synchronized. Enabling this option
insures greater data integrity at the expense of increasing I/O
processing overhead.
Valid values are:
Y (Yes)Perform timestamp checkpoint processing
N (No)DO not perform timestamp checkpoint processing.
For more information, see the CONTROL-M/Analyzer
installation chapter in the INCONTROL for OS/390 and z/OS
Installation Guide.

BMC Software, Inc., Confidential and Proprietary Information

2-30

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBF Allocate or Format an IOA Access Method File

Table 2-15

IOADBF Access Method Parameters (Part 3 of 5)

Parameter

Description

EXTEND

Specifies secondary extent to be allocated.

Valid values are:
A Causes a secondary extent to be automatically
allocated when an out-of-space condition is detected.
Default
M Requires a secondary extent to be manually allocated
after an out-of-space condition is detected by executing the
utility with the EXEC parameter FUNC set to EXTEND.
This parameter is ignored if no secondary space amount is
specified using the SPACE parameter. It is not applicable
when executing the IOADBF utility with the FORM or
CHANGE function specified.
Note: For CONTROL-M/Tape, this parameter must be set to
M. In addition, this parameter cannot be used with
CONTROL-M/Analyzer files.

KEYLEN

Record key length for IOA Access Method file index

components only. This parameter must not be specified for
data components.
Parameter KEYLEN is not applicable when executing utility
IOADBF with the CHANGE function specified.
The setting for KEYLEN is IOA application dependent and
must not be modified unless instructed otherwise by BMC
Software Customer Support.

LRECL

Logical record length for IOA Access Method file data

components only. This parameter must not be specified for
index components.
The setting for parameter LRECL is IOA application
dependent and must not be modified unless instructed
otherwise by BMC Software Customer Support.
Parameter LRECL is not applicable when executing utility
IOADBF with the FORM or CHANGE function specified.

PRODUCT

Product that uses the file to be allocated or formatted. Valid

values are:
DCONTROL-D or CONTROL-V
BCONTROL-M/Analyzer
OCONTROL-O
TCONTROL-M/Tape

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-31

IOADBF Allocate or Format an IOA Access Method File

Table 2-15

IOADBF Access Method Parameters (Part 4 of 5)

Parameter

Description

SPACE

The amount of space, in blocks, to be allocated for the

primary and, optionally, for each secondary IOA Access
Method file extent.
Note: Secondary extents cannot be specified for
CONTROL-M/Analyzer files or CONTROL-M/Tape index files.
To avoid termination of the CONTROL-D or CONTROL-O
monitor when the primary extent becomes full and an
out-of-space condition is detected, specify an amount for a
secondary extent.
If an out-of-space condition occurs, secondary extent
allocations can be set by
1. specifying a secondary amount in the SPACE parameter
2. executing the IOADBF utility with the EXEC parameter
FUNC set to CHANGE
This stores the new setting internally within the IOA
Access Method file.
3. restarting the CONTROL-D or CONTROL-O monitor.
For more information about secondary extents, see Multiple
Extents on page 2-35.
Example 1
SPACE (1500)
A 1500-block IOA Access Method file is allocated. If the file
becomes full, the application terminates with a corresponding
error message.
Example 2
SPACE (1500,300)
A 1500-block IOA Access Method file is allocated. If the file
becomes full and a secondary extent is automatically or
manually allocated, each newly allocated extent is 300 blocks
in size. For more information, see EXTEND on page 2-31.
Note: The amount of space for the primary extent is not
applicable when executing the IOADBF utility with the FORM
or CHANGE function specified.

TYPE

IOA Access Method file type. Valid values are:

FData component, fixed record format.
VData component, variable record format. This value is
not valid for use with CONTROL-M/Analyzer and
CONTROL-M/Tape files.
IIndex component.
The TYPE parameter is not applicable when executing utility
IOADBF with the FORM or CHANGE function specified.

UNIT

Name of the DASD unit to be used when allocating a new

IOA Access Method file extent (for example, 3390).

UNITD

Name of the DASD unit to be used when allocating a new

dual mirror image file extent (for example, 3390).

BMC Software, Inc., Confidential and Proprietary Information

2-32

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBF Allocate or Format an IOA Access Method File

Table 2-15

IOADBF Access Method Parameters (Part 5 of 5)

Parameter

Description

VOL

List of one to six DASD volume serial numbers, enclosed in

parenthesis and separated by commas, in which the IOA
Access Method files extents can be allocated.
All volumes must be defined to MVS as being associated with
the unit name specified in the UNIT parameter, described on
page 2-32.
To obtain SMS support for IOA Access Method files, omit this
parameter and specify the UNIT parameter for the SMS
space area in the DEFxxx members. SMS allocates all the
IOA Access Method extents according to SMS rules.
If there is insufficient space for the extents in the specified
volumes, the process accessing the volumes (for example,
the CONTROL-D or CONTROL-O monitor) automatically
attempts to allocate a new extent on those volumes. If there is
insufficient space for even these extents, the process
terminates.
In this event, you can modify the VOL parameter to specify a
new set of volumes (up to a maximum of six volumes). After
modifying this parameter, run the IOADBF utility with EXEC
parameter FUNC set to CHANGE, to store the new setting
internally within the IOA Access Method file, and then restart
the relevant process.
Note: You can also use this method to manually allocate
extents that failed by setting the EXEC parameter FUNC to
EXTEND.
If you do not specify the VOL parameter, the IOA Access
Method file is allocated using only the UNIT parameter.

VOLD

List of one to six DASD volume serial numbers, enclosed in

parenthesis and separated by commas, on which the dual
mirror image files extents can be allocated.
All volumes must be defined to MVS as being associated with
the unit name specified in parameter UNITD above.
To obtain SMS support for IOA Access Method files, omit
parameter VOLD and specify the UNIT parameter for the
SMS space area in the DEFxxx members. SMS allocates all
the IOA Access Method extents according to SMS rules.
Note: To ensure greater data integrity, specify different
volumes for the primary and dual mirror copy of each file. For
more information, see the VOL parameter in Table 2-15 on
page 2-29.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-33

IOADBF Allocate or Format an IOA Access Method File

Examples
Example 1
//INIT

EXEC

IOADBF,FUNC=INIT,D=INSTWORK,M=DEFACT

Contents of member DEFACT in the IOA.INSTWORK library:

Figure 2-6

DEFACT Contents

TYPE=V
DSN=CTD.V600.ACT
BLKSIZE=27998
LRECL=27974
SPACE=(1000,200)
BUFL=100
UNIT=3390
VOL=(PRD021,PRD022,PRD023,PRD024,PRD025,PRD026)
COMPRS=CTDUFCM
COMPTB=CTDUFCMA

Example 2
//CHANGE
//DAFILE

EXEC
DD

IOADBF,FUNC=CHANGE,D=INSTWORK,M=DEFHSTI
DISP=SHR,DSN=CTD.V600.HSTI.E000

Example 3

To change the qname of a file from the current dataset qname to the default
qname of the environment under which the utility is run, append (BYPASS)
to the DSN specified in DD statement DAFILE.
//*** RESET QNAME OF CTB.V600.GRPD.E000 TO
//*** DEFAULT ENV. QNAME
//GRP EXEC IOADBF,FUNC=CHANGE,D=INSTWORK,
//
M=DEFGRPD,ILPREFA=IOA.V600
//DAFILE DD DISP=SHR,DSN=CTB.V600.GRPD.E000(BYPASS)

BMC Software, Inc., Confidential and Proprietary Information

2-34

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBF Allocate or Format an IOA Access Method File

Multiple Extents
IOA Access Method files can contain multiple extents. Each extent is a
separate sequential file that contains a maximum of 65534 blocks and is
allocated without a secondary space allocation.
If an IOA Access Method file has more than 65534 blocks, specify a space
parameter, by an expression such as SPACE=(65534,30000). In this case, the
IOA Access Method allocates a first extent of 65,534 blocks and a second
extent of 30,000 blocks as separate OS/2390 or z/OS sequential files.
However, the IOA Access Method treats the two files as one file with two
extents. The new extent is allocated when records are written to the file if the
first extent does not have sufficient free space for the new records.
The maximum size for secondary extents is also 65,534 blocks. The IOA
Access Method supports a maximum of 256 extents.

Using the IOADPT Utility for Space Management

To display information about the space remaining in an IOA Access Method
file, run the IOADPT utility with the FUNC parameter set to DB0, as
follows.
//AMSPACE EXEC IOADPT,FUNC=DB0,DBFILE=ACT

This information enables you to manage space allocations and provide extra
extents before they are created. For details and examples, see IOADPT
Print IOA Access Method File Content on page 2-54.

CONTROL-D Samples
For information about using CONTROL-D to allocate and format IOA
Access Method files, see Customize CONTROL-D User Files in the ICE
Customize activity.

CONTROL-M/Tape Samples
For information about using CONTROL-M/Tape to allocate and format IOA
Access Method files, see Customize CONTROL-M/Tape Datasets in the
ICE Customize activity.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-35

IOADBF Allocate or Format an IOA Access Method File

CONTROL-M/Analyzer Samples
The following jobs in the CONTROL-M/Analyzer JCL library can be used as
samples for formatting existing data and index files:
Table 2-16

IOADBF CONTROL-M/Analyzer Sample Formatting Jobs

Job

Description

JOBFABF

Active Balancing file

JOBFGRP

Group file

JOBFJAF

Rule Activity file

JOBFREP

Report file

The following jobs in the CONTROL-M/Analyzer JCL library can be used as

samples for formatting and rebuilding the index file for an existing data file:
Table 2-17

IOADBF CONTROL-M/Analyzer Sample Formatting and

Rebuilding Jobs

Job

Description

JOBBGRP

Group file

JOBBDM

Access Method Variable Basic file

JOBBDBV

Access Method Variable Generation file

JOBBJAF

Rule Activity file

JOBBREP

Report file

For example, if the index file of the Rule Activity file was damaged by a disk
crash but the data file was not damaged (meaning, the actual information
about invocations, and so on, is accurate), use member JOBBJAF to reformat
the index file and rebuild the index entries.

IOA Samples
Utility IOADBF is used by the following jobs in the IOA JCL library:
Table 2-18

IOADBF IOA Sample Jobs

Job

Description

IOADBSBF

Allocates and formats the IOA Variable Database Definition file

IOACOLBF

Allocates and formats the IOA Variable Database Column file

IOAVARBF

Allocates and formats the IOA Variable Database Variables file

BMC Software, Inc., Confidential and Proprietary Information

2-36

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBIB Rebuild Index Files

IOADBIB Rebuild Index Files

The IOADBIB utility rebuilds index files for various IOA Variable Database
data files. The new index files correspond to information contained in the
data files.
Note:

Use this utility only for core IOA databases. Other INCONTROL
products have their own utilities according to the following table.

INCONTROL
Product

Building Index Utility

CONTROL-D and
CONTROL-V

CTDDIB
For the CONTROL-V global index file, use CTDGBIB.

CONTROL-M/Analyzer

CTBDBIB

CONTROL-M/Tape

CTTBIX for the Media Database

CTTDBIB for the Stacking Database

This utility rebuilds the indexes of a specific data file. Previous contents of
the index file are erased.
Note:

The index file that is to be rebuilt must be allocated and formatted

prior to activating the utility.

This utility is used:

When the space remaining for the existing index file is insufficient, or the
relevant data file was reloaded. In this case:

Delete the index file.

Redefine the index file with the required amount of space.
Format the index file with utility IOADBF.
Rebuild the index file with utility IOADBIB.

In case of index file integrity problems that can be detected using utility
IOADII. For details, see IOADII Verify Integrity of IOA Access
Method File Index Component on page 2-49.

In case of data file integrity problems. In this case, correct the data file
and re-index it with utility IOADBIB to reproduce the corresponding
index file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-37

IOADBIB Rebuild Index Files

Parameter
The following parameter can be specified in the EXEC statement that invokes
the IOADBIB JCL procedure.
Table 2-19

IOADBIB Parameter

Parameter

Description

DBFILE

The identifier name (DBNAME) suffix of the IOA Access Method

file.

Note:

SYSIN parameters are provided in the keyxxx members in the

PARM library for your convenience. File name specifications are
hard coded (predefined) in these members.

Activating the Utility

// EXEC IOADBIB

Return Codes
Table 2-20

IOADBIB Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Example
//
//SYSIN
//DAGRP

EXEC IOADBIB,DBFILE=GRPD
DD
DSN=IOA.PROD.PARM(KEYGRP),DISP=SHR
DD
DSN=IOA.PROD.COLI,DISP=SHR

Utility IOADBIB is used by the following jobs in the IOA JCL library. For
additional examples, refer to these jobs:
Table 2-21

IOADBIB Jobs (Part 1 of 2)

Job

Description

IOADBSBI

Rebuilds the index of the Variable Database Definition file.

BMC Software, Inc., Confidential and Proprietary Information

2-38

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBIB Rebuild Index Files

Table 2-21

IOADBIB Jobs (Part 2 of 2)

Job

Description

IOACOLBI

Rebuilds the index of the Variable Database Column file.

IOAVARBI

Rebuilds the index of the Variable Database Variable file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-39

IOADBSR Sort Records in IOA Access Method Data Component

IOADBSR Sort Records in IOA Access Method

Data Component
Utility IOADBSR sorts the records in an IOA Access Method files data
component in the same logical order as the records in the associated IOA
Access Method files index component.
Sorting an IOA Access Method files data component improves I/O
performance.
Note:

The data component of the CONTROL-D Active User Report List

file can optionally be sorted automatically by the CONTROL-D
Monitor. For more information, see the CONTROL-D and
CONTROL-V chapter of the INCONTROL for OS/390 and z/OS
Administration Guide.

Warning!

This utility does not support CONTROL-M/Tape databases.

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADBSR JCL procedure:
Table 2-22

IOADBSR Parameters

Parameter

Description

DBPREFA

High level dataset name qualifier (prefix) of the IOA Access

Method file.

DBFILE

The identifier name (DBNAME) suffix of the IOA Access Method

file.

PARMLIB

The last qualifier of the INCONTROL product library containing

the input Sort Control statements.

Member name in the INCONTROL product dataset containing

the input Sort Control statements.

BMC Software, Inc., Confidential and Proprietary Information

2-40

INCONTROL for OS/390 and z/OS Utilities Guide

IOADBSR Sort Records in IOA Access Method Data Component

Sort Control Parameters

The following Sort Control parameters can be specified for dynamic sorting.
Parameters that are not applicable to batch sorting with utility IOADBSR are
indicated as such.
Table 2-23

IOADBSR Sort Control Parameters

Parameter

Description

ENABLE

Whether dynamic sort processing is disabled. This parameter is

ignored by utility IOADBSR. Valid values are:
Y (Yes) Enable dynamic sort processing.
N (No) Disable dynamic sort processing.

TIMEFROM

Earliest time of day, in hhmm format, at which time dynamic sort

processing can be performed. This parameter is ignored by utility
IOADBSR.

TIMETO

Latest time of day, in hhmm format, at which time dynamic sort

processing can be performed. This parameter is ignored by utility
IOADBSR.

RBAOFS

Offset location within an index record of a four-byte field

containing the address of the associated data record.

INTERVAL

Interval, in hhmm format, at which dynamic sort processing

automatically starts during the time range specified by
parameters TIMEFROM and TIMETO. This parameter is ignored
by utility IOADBSR.

DELYBLK

Amount of time, as a four-digit value in hundredths of seconds,

that dynamic sort processing waits before processing a new
block. For example, a value of 0001, 0010 or 0100 sets the delay
time to one hundredth, one tenth or one full second, respectively.

START-WHENOVER

Limit of different Database file data component blocks referred to

by all index records within any single index component block that
automatically triggers dynamic sort processing.
This parameter is for internal use only and must not be modified
unless instructed otherwise by BMC Software Customer Support.

STOP-WHENOVER

Maximum number of different data component blocks that can be

referred to by all index records within any single index component
block when dynamically sorting the index component block.
Parameter STOP-WHEN-OVER is for internal use only and must
not be modified unless instructed otherwise by BMC Software
Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-41

IOADBSR Sort Records in IOA Access Method Data Component

Example
Figure 2-7

//
//
//
//

IOADBSR Example

EXEC IOADBSR,DBPREFA=CTD,
DBFILE=ACT,
PARMLIB=CTD.PROD.PARM,
M=DBSRTPRM

For an example of how to sort the data component of the CONTROL-D

History User Report list, refer to sample job CTDUFSR in the CONTROL-D
JCL library.

BMC Software, Inc., Confidential and Proprietary Information

2-42

INCONTROL for OS/390 and z/OS Utilities Guide

IOADCPY Recover an IOA Access Method File

IOADCPY Recover an IOA Access Method File

The IOADCPY utility is used to recover an IOA Access Method file from the
dual mirror image copy.
If an IOA Access Method file is used with dual file support, and either the
working copy or the dual mirror image copy is corrupted or becomes
unavailable, the damaged or missing file must be recovered. Utility
IOADCPY restores the damaged or missing copy of the file from the copy
that is still intact and available (including all file extents). If the dual copy is
corrupted, the utility also resets the parameter in the control block of the IOA
Access Method file that indicated a corrupted dual mirror image file
(DUALBAD).
Note:

This IOADCPY utility is not relevant for IOA Variable Database

files. Additionally, because CONTROL-M/Tape databases cannot be
defined with a dual mirror image option, this utility is not relevant for
CONTROL-M/Tape databases.

Activating the Utility

//COPY

EXEC

IOADCPY,DBFILE=ACT,SUFFIX=E000

When executing this utility, DD statement DAIN must be included in the JCL
stream and must specify the full name of the uncorrupted (valid, intact) IOA
Access Method file.
Note:

When using this utility, the activities of all the relevant applications
are stopped. For more information, see the relevant product chapter
on the recovery process.
Utility IOADCPY cannot be used for IOA Variable Database files.

Examples
If the dual mirror image copy of the CONTROL-D Active User Report List is
corrupted, the DAIN DD statement specifies the name of the main copy:
//DAIN DD DISP=SHR,DSN=CTD.PROD.ACT.E000

If the main copy of the CONTROL-D Active User Report List is corrupted,
the DAIN DD statement specifies the name of the dual mirror image copy:
//DAIN DD DISP=SHR,DSN=CTD.PROD.ACT.D000

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-43

IOADCPY Recover an IOA Access Method File

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADCPY JCL procedure:
Table 2-24

IOADCPY Parameters

Parameter

Description

SUFFIX

Suffix of the dataset name of the uncorrupted file.

E000If the dual mirror image copy is corrupted, specify the
suffix of the main copy of the IOA Access Method file.
D000If the main copy is corrupted, specify the suffix of the
dual mirror image copy of the IOA Access Method file.

UNIT

Name of the DASD unit to be used when allocating new extents

for the damaged or missing file.

VOL

List of one to six DASD volume serial numbers, enclosed in

parenthesis and separated by commas, on which the new extents
of the damaged or missing file can be allocated.
All volumes must be defined to MVS as being associated with the
unit name specified in parameter UNIT above.
If VOL is not specified, the extents are allocated using only
parameter UNIT.

The above parameters are optional and are used only when it is necessary to
override the UNIT and VOL (or UNITD and VOLD) parameters specified in
the IOA Access Method file definition member when the IOA Access
Method file was first created (member DEFxxx in the IOA INSTWORK
library). After running the utility with these parameters, run utility IOADBF
with FUNC set to CHANGE to update the new values for these parameters in
the IOA Access Method file control block.

Return Codes
Table 2-25

IOADCPY Return Codes (Part 1 of 2)

Code

Description

Operation performed successfully.

Missing DD statement or open error occurred for SYSPRINT file.

Missing DD statement or open error occurred for input IOA

Access Method file.

12

Error in input parameters.

16

Error in IOA Access Method file name.

20

Error occurred in dynamic allocation.

24

Internal error occurred.

28

Insufficient storage.

BMC Software, Inc., Confidential and Proprietary Information

2-44

INCONTROL for OS/390 and z/OS Utilities Guide

IOADCPY Recover an IOA Access Method File

Table 2-25

IOADCPY Return Codes (Part 2 of 2)

Code

Description

32

Missing DD statement or open error occurred for output IOA

Access Method file.

36

Error in input parameters volume serial number was not

supplied.

For more information about how to use this utility, see sample member
CTDUFCPY in the CONTROL-D JCL library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-45

IOADIG Verify Integrity of IOA Access Method File Data Component

IOADIG Verify Integrity of IOA Access Method File

Data Component
The IOADIG utility is used to verify the integrity of the data component
structure an IOA Access Method file by scanning the active and free record
chain lists in the file, and reporting any detected errors. Optionally, this utility
can correct the detected errors.
Note:

All file-related activity of the relevant product must be stopped

before this utility is run:

If the file being processed is a CONTROL-D file, all

CONTROL-D monitors must be down when running this utility.

If the file being processed is an IOA file, all monitors must be

down when running this utility.

If the file being processed is a CONTROL-M/Analyzer file, all

CONTROL-M/Analyzer activities must be held. For example, no
CONTROL-M/Analyzer rules must be invoked while this utility
is running.

If the file being processed is a CONTROL-M/Tape file, all

CONTROL-M/Tape activities in the system may be locked until
the utility terminates.

Activating the Utility

//CHECK EXEC IOADIG,DBFILE=logical_filename,
//
FUNC=R|W[,DBPREFA=prefix_filename]
Note:

If you omit the DBPREFA parameter, the IOA database prefix is

used by default.

BMC Software, Inc., Confidential and Proprietary Information

2-46

INCONTROL for OS/390 and z/OS Utilities Guide

IOADIG Verify Integrity of IOA Access Method File Data Component

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADIG JCL procedure.
Table 2-26

IOADIG Parameters

Parameter

Description

DBFILE

The identifier name (DBNAME) suffix of the IOA Access

Method file.

FUNC

The function to be performed on the file. Valid values are:

R Report errors detected.
W Report and correct errors detected.
Note: As a precaution, BMC Software recommends that a
backup copy be made of the IOA Access Method file data
component before executing the IOADIG utility with FUNC set
to W.

DBPREFA

The high level qualifier of the database file. Instead of

specifying a prefix file name, you can use the &DBPREFx
variable, where x is one of the following database product
IDs:
B CONTROL-M/Analyzer
D CONTROL-D
T CONTROL-M/Tape

Example
To verify the integrity of the CONTROL-D history (HIST) file, use the
following JCL statement:
//CHECK EXEC IOADIG,DBFILE=HST,FUNC=R,DBPREFA=&DBPREFD

IOA Samples
The IOADIG utility is used by the following jobs in the IOA JCL library:
Table 2-27

IOADIG Jobs

Job

Description

IOADBSIG

Verifies the integrity of the IOA Variable Database Definition file.

IOACOLIG

Verifies the integrity of the IOA Variable Database Column file.

IOAVARIG

Verifies the integrity of the IOA Variable Database Variables file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-47

IOADIG Verify Integrity of IOA Access Method File Data Component

CONTROL-D Samples
For an example of how to check the structural integrity of a CONTROL-D
IOA Access Method file data component, see the CTDUFCHK sample job in
the CONTROL-D JCL library.

CONTROL-M/Tape Samples
The IOADIG utility is used by the CTTDIG job in the CONTROL-M/Tape
JCL library.

BMC Software, Inc., Confidential and Proprietary Information

2-48

INCONTROL for OS/390 and z/OS Utilities Guide

IOADII Verify Integrity of IOA Access Method File Index Component

IOADII Verify Integrity of IOA Access Method File

Index Component
The IOADII utility is used to verify the integrity of the index component
structure of an IOA Access Method file. If errors are detected, format the
index file component using the IOADBF utility, and then rebuild the index
using the appropriate index rebuilding utility. For information about index
rebuilding utilities for IOA Access Method in the IOA administration chapter
of the INCONTROL for OS/390 and z/OS Administration Guide.
This utility also indicates the number of records in the file.
Note:

The IOADII utility is not relevant for IOA Variable Database files.

Activating the Utility

//CHECK EXEC IOADII,DBFILE=logical_filename[,
//
DBPREFA=prefix_filename]
Note:

If you omit the DBPREFA parameter, the IOA database prefix is

used by default.

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADII JCL procedure.
Table 2-28

IOADII Parameters

Parameters

Description

DBFILE

The identifier name (DBNAME) suffix of the IOA Access

Method file.

DBPREFA

The high level qualifier of the database file. Instead of

specifying a prefix file name, you can use the &DBPREFx
variable, where x is one of the following database product
IDs:
B CONTROL-M/Analyzer
D CONTROL-D
T CONTROL-M/Tape

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-49

IOADII Verify Integrity of IOA Access Method File Index Component

Example
To verify the integrity of the CONTROL-M/Tape media (MDB) database
index file, use the following JCL statement:
//CHECK

EXEC

IOADII,DBFILE=MDBI,DBPREFA=&DBPREFT

CONTROL-D Samples
For an example of how to check the structural integrity of a CONTROL-D
IOA Access Method file data component, see the CTDUFCHK sample job in
the CONTROL-D JCL library.

CONTROL-M/Tape Samples
The IOADII utility is used by the CTTDII job in the CONTROL-M/Tape JCL
library.

BMC Software, Inc., Confidential and Proprietary Information

2-50

INCONTROL for OS/390 and z/OS Utilities Guide

IOADLD Load IOA Access Method File Contents

IOADLD Load IOA Access Method File Contents

Utility IOADLD is used to load an IOA Access Method files contents from a
sequential file previously created by utility IOADUL.
Note:

All file-related activity of the relevant product must be stopped

before this utility is run:

If the file being loaded is a CONTROL-D file, all CONTROL-D

monitors must be down when running this utility.

If the file being loaded is an IOA file, all monitors must be down
when running this utility.

Utility IOADLD cannot be run on CONTROL-M/Analyzer files.

This utility is typically used to migrate an IOA Access Method file to another
DASD volume. In this case, perform the following steps:
1. Run utility IOADUL to unload the IOA Access Method file data
components records to a sequential dataset.
2. Allocate and format a new IOA Access Method file on a new DASD
volume using the IOADBF utility.
3. Run the IOADLD utility to reload the IOA Access Method file data
component records from the sequential dataset previously produced by
utility IOADUL.
4. Run the appropriate index rebuilding utility to rebuild the IOA Access
Method file index component, based on the contents of the data
component:

for IOA databases, use the IOADBID utility

for CONTROL-D, use the CTDDIB utility
for the CONTROL-V global index file, use the CTDGBIB utility
for the CONTROL-M/Tape media database, use the CTTBIX utility
for the CONTROL-M/Tape stacking database, use the CTTDBIB
utility

Activating the Utility

//LOAD

EXEC

IOADLD

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-51

IOADLD Load IOA Access Method File Contents

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADLD JCL procedure:
Table 2-29

IOADLD Parameters

Parameter

Description

SQFILE

The dataset name suffix of the input sequential file.

DBFILE

The identifier name (DBNAME) suffix of the IOA Access

Method file.

DISPI

The MVS dataset disposition of the input file.

Valid values are:
KEEP (default)
DELETE

DBPREFA

The high level qualifier of the database file. Instead of

specifying a prefix file name, you can use the &DBPREFx
variable, where x is one of the following database product
IDs:
B CONTROL-M/Analyzer
D CONTROL-D
T CONTROL-M/Tape

Example
//LOAD EXEC IOADLD,SQFILE=ACTSEQ,DBFILE=ACT,
DBPREFA=&DBPREFD

CONTROL-D Samples
For an example of how to load CONTROL-D IOA Access Method file data
component records from a sequential dataset and then rebuild the IOA
Access Method files index component, see the CTDUFRST sample job in
the CONTROL-D JCL library.

CONTROL-M/Tape Samples
The IOADLD utility is used by the CTTDBDLD job in the
CONTROL-M/Tape JCL library.

BMC Software, Inc., Confidential and Proprietary Information

2-52

INCONTROL for OS/390 and z/OS Utilities Guide

IOADLD Load IOA Access Method File Contents

IOA Samples
Utility IOADLD is used by the following jobs in the IOA JCL library:
Table 2-30

IOADLD Jobs

Job

Description

IOADBSLD

Loads the IOA Variable Database Definition file.

IOACOLLD

Loads the IOA Variable Database Column file.

IOAVARLD

Loads the IOA Variable Database Variables file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-53

IOADPT Print IOA Access Method File Content

IOADPT Print IOA Access Method File Content

Utility IOADPT prints IOA Access Method file data and index records in
SNAP dump format.

Activating the Utility

//PRINT EXEC IOADPT

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADPT JCL procedure.
Table 2-31

IOADPT Parameters

Parameter

Description

FUNC

The print function to be performed. Valid values are:

0 Print IOA Access Method file index and data
components.
1 Print IOA Access Method file index component only.

DB0

The print IOA Access Method file index and data component
control records.

DBFILE

The identifier name (DBNAME) suffix of the IOA Access

Method data file.

KEYFROM

The value of the record key from which to print. Optional.

KEYTO

The value of the record key until which to print. Optional.

RBAOFF

The RBA offset in the index record key pointing to the data
component record. The default setting for this parameter is 0.
Note: For CONTROL-M/Tape, this parameter can be set to 0,
because the offset is automatically calculated within the utility
program.

DBPREFA

The high level qualifier of the database file. Instead of

specifying a prefix file name, you can use the &DBPREFx
variable, where x is one of the following database product
IDs:
B CONTROL-M/Analyzer
D CONTROL-D
T CONTROL-M/Tape

DBINDEX

The identifier name (DBNAME) suffix of the IOA Access

Method data index file. The default setting for this parameter
is the DBFILE parameter followed by I.

BMC Software, Inc., Confidential and Proprietary Information

2-54

INCONTROL for OS/390 and z/OS Utilities Guide

IOADPT Print IOA Access Method File Content

This utility processes both the data and index components of a IOA Access
Method file.
If KEYFROM and KEYTO parameters are not specified or are specified as
blank, all records are printed.

Example
To print the CONTROL-D history database (HST) in SNAP dump format,
use the following JCL statement:
//PRINT EXEC IOADPT,FUNC=0,DBFILE=HST,DBPREFA=&DBPREFD

CONTROL-D Samples
For an example of how to print CONTROL-D IOA Access Method file
record contents, see the CTDUFDPT sample job in the CONTROL-D JCL
library.

CONTROL-M/Tape Samples
The IOADPT utility is used by the CTTDPT job in the CONTROL-M/Tape
JCL library.

IOA Samples
Utility IOADPT is used by the following jobs in the IOA JCL library:
Table 2-32

IOADPT Jobs

Job

Description

IOADBSPT

Prints the IOA Variable Database Definition file.

IOACOLPT

Prints the IOA Variable Database Column file.

IOAVARPT

Prints the IOA Variable Database Variables file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-55

IOADUL Unload IOA Access Method File Contents

IOADUL Unload IOA Access Method File Contents

The IOADUL utility is used to unload the record contents of an IOA Access
Method file data component a sequential file.
Note:

When using the IOADUL utility, consider the following:

This utility can run in parallel with IOA monitors. It is not

necessary to shut down monitors for any INCONTROL product
when running this utility.

IOADUL cannot be used for CONTROL-M/Analyzer files.

This utility is typically run to migrate an IOA Access Method file to another
DASD volume. In this case, perform the following steps:
1. Run the IOADUL utility to unload the IOA Access Method file data
components records to a sequential dataset.
2. Allocate and format a new IOA Access Method file on a DASD volume
using the IOADBF utility.
3. Run the IOADLD utility to reload the IOA Access Method file data
component records from the sequential dataset previously produced by
the IOADUL utility.
4. Run the appropriate index rebuilding utility to rebuild the IOA Access
Method file index component, based on the contents of the data
component:

for IOA databases, use the IOADBID utility

for CONTROL-D, use the CTDDIB utility
for the CONTROL-V global index file, use the CTDGBIB utility
for the CONTROL-M/Tape media database, use the CTTBIX utility
for the CONTROL-M/Tape stacking database, use the CTTDBIB
utility

Activating the Utility

//UNLOAD EXEC IOADUL,
//
DBFILE=logical_data_filename,SQFILE=seqfilename0[,
//
RBAOFF=offset][,FROMKEY=fkey][,TOKEY=tkey][,
//
DBPREFA=prefix_filename][,
//
DBINDEX=logical_index_filename]
//
DISPO=jcl_disp_val

BMC Software, Inc., Confidential and Proprietary Information

2-56

INCONTROL for OS/390 and z/OS Utilities Guide

IOADUL Unload IOA Access Method File Contents

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the IOADUL JCL procedure.
Table 2-33

IOADUL Parameters

Parameter

Description

DBFILE

The identifier name (DBNAME) suffix of the IOA Access

Method file.

SQFILE

The output sequential files dataset name suffix.

RBAOFF

The RBA offset in the index record key pointing to the data
component record. The default setting for this parameter is 0.
Note: For CONTROL-M/Tape, this parameter can be set to 0,
because the offset is automatically calculated within the utility
program.

FROMKEY

The value of the record key from which to copy. Optional.

TOKEY

The value of the record key until which to copy. Optional.

DBPREFA

The high level qualifier of the database file. Instead of

specifying a prefix file name, you can use the &DBPREFx
variable, where x is one of the following database product
IDs:
B CONTROL-M/Analyzer
D CONTROL-D
T CONTROL-M/Tape

DBINDEX

The identifier name suffix of the IOA Access Method index

file. The default is the DBFILE parameter concatenated
with I.

DISPO

The allocation disposition for the output sequential file. The

value of the DISPO parameter is assigned to the JCL DISP
parameter of the output sequential file. The default is
(,CATLG).

If FROMKEY and TOKEY parameters are not specified or are specified as

blank, all records are copied.
Note:

For a complete list of the files this utility supports, see the IOA
administration chapter of the INCONTROL for OS/390 and z/OS
Administrator Guide.

Example
//UNLOAD EXEC IOADUL,DBFILE=PRM,SQFILE=PRMSEQ,
DBPREFA=&DBPREFB

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-57

IOADUL Unload IOA Access Method File Contents

CONTROL-D Samples
For an example of how to print CONTROL-D IOA Access Method file
record contents, see the CTDUFDUL sample job in the CONTROL-D JCL
library.

CONTROL-M/Tape Samples
The IOADUL utility is used by the CTTDBDUL job in the
CONTROL-M/Tape JCL library.

IOA Samples
The IOADUL utility is used by the following jobs in the IOA JCL library:
Table 2-34

IOADUL Jobs

Job

Description

IOADBSUL

Unloads the IOA Variable Database Definition file.

IOACOLUL

Unloads the IOA Variable Database Column file.

IOAVARUL

Unloads the IOA Variable Database Variables file.

BMC Software, Inc., Confidential and Proprietary Information

2-58

INCONTROL for OS/390 and z/OS Utilities Guide

IOAFRLOG - Allocate and Format the IOA Log File

IOAFRLOG - Allocate and Format the IOA Log File

Note:

This utility is obsolete. To format the IOA Log File (maintaining or

modifying the size of the file), use the ICE Customize activity for
IOA step Customize IOA Dataset Parameters.

IOAFRNRS - Allocate and Format the IOA Manual

Conditions File
Note:

This utility is obsolete. To format the IOA Manual Conditions (NRS)

File and the IOA Manual Conditions Synchronization (NSN) file,
use the ICE Customize activity for IOA step Customize IOA
Dataset Parameters.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-59

IOALDNRS Load IOA Conditions File

IOALDNRS Load IOA Conditions File

This utility creates and loads the IOA Manual Conditions file that can be
viewed using the IOA Manual Conditions screen described in the online
facilities chapter of the INCONTROL product-specific user guides. The
utility is usually run every day after the New Day procedure finishes
executing.
To identify conditions that are placed in the IOA Manual Conditions file, the
utility first performs a search for all prerequisite IN conditions required for
the submission of jobs, missions, or reports on the particular day. The search
for prerequisite IN conditions is performed by checking the job scheduling
definitions of all jobs in the Active Jobs file and by checking the mission
definitions of missions in the Active Missions file.
Once the prerequisite IN conditions have been identified, the utility
eliminates non-manual conditions from the list to arrive at the list of manual
conditions that need loading. A prerequisite IN condition is not included in
the IOA Manual Conditions file if it satisfies either of the following criteria:

The prerequisite condition is added to the IOA Conditions file by an

OUT or DO COND statement in a job, mission, or report that is active
that day.

The prerequisite condition already exists in the IOA Conditions file.

All prerequisite IN conditions that do not meet the above criteria are assumed
manual conditions and are placed in the IOA Manual Conditions list.
Through parameters passed to the utility, it is possible to exclude the Active
Jobs file and/or the Active Missions file from the search for manual
conditions. Of course, if both files are excluded, no manual conditions are
found, even if they exist.
Every time the utility is activated, the IOA Manual Conditions file is
recreated and all previous conditions are automatically deleted from the file.
It is possible to override this default by using parameter ADDMODE.
This utility can be used in conjunction with KeyStroke Language utility
ADDMNCND, which is referred to in the CONTROL-M for OS/390 and z/OS
User Guide.
The conditions to be included in the file can be limited by control statements
supplied using DD statement DALNRIN (or SYSIN).

BMC Software, Inc., Confidential and Proprietary Information

2-60

INCONTROL for OS/390 and z/OS Utilities Guide

IOALDNRS Load IOA Conditions File

Parameters
Table 2-35

IOALDNRS Parameters (Part 1 of 2)

Parameter

Description

IGNORE

Indicates conditions to be ignored during the building of the

IOA Manual Conditions file. Valid values are:
IN prefix All conditions beginning with the specified prefix
are ignored when the file is created.
OUT prefix Conditions defined in an IGNORE statement
in parameter OUT that begin with the specified prefix are
ignored by the algorithm used to build the IOA Manual
Conditions file. An asterisk (*) signifies that all OUT
parameters are ignored.
CODES prefix Conditions defined in an IGNORE
statement in parameter DO COND that begin with the
specified prefix are ignored by the algorithm used to build
the IOA Manual Conditions file. An asterisk (*) signifies that
all DO COND parameters are ignored.
Note: Specifying IGNORE xxx (OUT/CODES) exempts the
xxx (OUT or DO COND) condition from the rule stated earlier.
A prerequisite IN condition is not included in the IOA Manual
Conditions file if it is added to the IOA Conditions file by an
OUT or DO COND statement in a job, mission, or report that
is active that day.
WHEN prefix Conditions defined in an IGNORE
statement in parameter WHEN DO COND that begin with
the specified prefix are ignored by the algorithm used to
build the IOA Manual Conditions file. An asterisk (*)
signifies that all WHEN DO COND parameters are ignored.
CTM STATUS ENDED IN conditions for jobs in the Active
Jobs file that have finished executing (ended OK or
NOTOK) are ignored by the algorithm used to build the IOA
Manual Conditions file. OUT conditions set by these jobs
are not ignored. If this parameter is used, parameter
CONTROLM must be set to YES.
CTD STATUS ENDED Manual conditions for missions in
the Active Missions file that have finished executing (ended
OK or NOTOK) are ignored by the algorithm used to build
the IOA Manual Conditions file. If this parameter is used,
parameter CONTROLD must be set to YES.

CONTROLM

Determines whether information in the CONTROL-M Active

Jobs file are used in the calculation that builds the IOA
Manual Conditions list. Optional. Default taken from
installation parameters. Valid values are:
Y (Yes) Include CONTROL-M information in the
calculation that builds the IOA Manual Conditions file.
N (No) Build the IOA Manual Condition file based on
CONTROL-D or CONTROL-V information only.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-61

IOALDNRS Load IOA Conditions File

Table 2-35

IOALDNRS Parameters (Part 2 of 2)

Parameter

Description

CONTROLD

Determines whether information in the CONTROL-D Active

Missions file is used in the calculation that builds the IOA
Manual Conditions file. Optional. Default taken from
installation parameters. Valid values are:
YES Include CONTROL-D information in the calculation
that builds the IOA Manual Conditions file.
NO Build the IOA Manual Conditions file based on
CONTROL-M information only.

ADDMODE

If this parameter is specified, when the existing Manual

Conditions file is deleted, only manual conditions from that
file that were added (using the ADD command) to the IOA
Conditions file are retained and appear in the new Manual
Conditions file.

When CONTROL-M, and CONTROL-D or CONTROL-V, are active, you

should use a shared control parameters member.

Activating the Utility (and Example)

Figure 2-8

IOALDNRS Example

// EXEC IOALDNRS
//DALNRIN DD *
IGNORE IN CICS
IGNORE IN IMS
IGNORE OUT DB-FILE
IGNORE CODES DB-FILE
CONTROLM YES

Return Codes
Table 2-36

IOALDNRS Return Codes

Code

Description

Operation performed successfully

File is full; no more space to add conditions

Critical error, list not created

BMC Software, Inc., Confidential and Proprietary Information

2-62

INCONTROL for OS/390 and z/OS Utilities Guide

IOANOTE Write a Message to the IOA Log File

IOANOTE Write a Message to the IOA Log File

This utility writes a message to the IOA Log file. It can be invoked as a
started task (STC), as a job step, or from another program. On terminals
supporting color, messages written by utility IOANOTE appear on the Log
screen in a different color than other messages, making them more readily
identifiable.

Parameter
The message to be written to the Log file is specified using the following
parameter.
Table 2-37

IOANOTE Parameter

Parameter

Description

PARM

Text of the message to be written.

Activating the Utility

As a job step:
// EXEC IOANOTE,PARM=text

As a started task:
S IOANOTE,PARM='text'

From another program:

CALL CTMNOTE,(NOTELENG)
...
NOTELENG DC H80
DC CL80any customer message text

Before executing the call to CTMNOTE, you must place the program into
AMODE 24. The message generated by the IOANOTE utility is written to
the IOA log under message ID MSG999I.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-63

IOANOTE Write a Message to the IOA Log File

Return Codes
Table 2-38

IOANOTE Return Codes

Code

Description

Operation performed successfully

No parameters passed to utility program

Operation failed

Example
// EXEC IOANOTE,PARM=PAYROLL APPLICATION MESSAGES BEGIN HERE

BMC Software, Inc., Confidential and Proprietary Information

2-64

INCONTROL for OS/390 and z/OS Utilities Guide

IOAOPR - Issue Operator Commands using a Job or STC

IOAOPR - Issue Operator Commands using a Job or

STC
Utility IOAOPR can be used to issue operator commands (MVS, JES2, JES3,
VTAM, and so on). It can be activated as a job step or as a started task, and
allows full control over when a command is issued and what to do
afterwards. If CONTROL-M is installed, it is also possible to send the
command to any computer (because CONTROL-M can schedule a started
task in any computer).
Each command issued by the utility is recorded in the IOA Log file.
The utility can execute commands from a list supplied in DD statement
DA34F. To activate the utility (for example, as a job step):
//

EXEC IOAOPR,CMDMEM=mem_name

where mem_name is the name of a member containing a list of operator

commands to be executed.
To activate the utility for one command, use the PARM parameter, as follows:
//

EXEC IOAOPR,PARM=command

If CONTROL-M is installed, it is possible to activate the utility using

CONTROL-M facilities. The following is an example of a schedule
definition for a single command in a specified computer:
MEMNAME IOAOPR

Note:

MEMLIB M3,PARM=$PIA
TASKTYPE STC

Use of this utility or program is limited to authorized personnel.

Most popular security products support control of the use of
programs by program name.
The utility can also issue JES3 commands (under a JES3
environment). A JES3 command is identified as such only if it begins
with the IOA JESCHAR. Under JES3 it is possible to specify
commands starting with more than one type of character. A
command that starts with a valid JES3 command prefix and not with
the IOA JESCHAR is sent for execution but cannot be executed by
JES (without any indication from utility IOAOPR).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-65

IOASDISC Emergency Subsystem Disconnect

IOASDISC Emergency Subsystem Disconnect

Utility IOASDISC forces the Subsystem Vector Table (SSVT) to disconnect
from the Subsystem Control Table (SSCT) control block of the IOA
subsystem.
Note:

Use this utility only when directed during upgrades or in an

emergency situation. Do not use this utility without the advice of
BMC Software Customer Support.

The utility procedure, IOASDISC, is located in the IOA.PROCLIB library.

Activating the Utility (and Example)

S IOASDISC,SSNAME=xxxx

where xxxx is the name of the installed IOA subsystem to be disconnected.

Return Codes
Table 2-39

IOASDISC Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

2-66

INCONTROL for OS/390 and z/OS Utilities Guide

IOATEST Simulate Production Environment Events

IOATEST Simulate Production Environment Events

This utility simulates various events in the production environment. For
example, it can simulate step termination codes or cause a step to wait a
specified interval.

Parameters
Table 2-40

IOATEST Parameters (Part 1 of 2)

Parameter

Description

CMD

Issue an operator command. The command can be either an

MVS/JES command or, when MVS is running under VM, a CP
command. (CP commands must start with characters CP.)
Maximum text length: 76 characters.

WTO

Write message to operator console. Maximum text length: 76

characters.

WTOR

Write message to operator console with reply. Maximum text

length: 75 characters.

WTOM

Issue multiline message. major is the primary message line.

Subsequent minor lines are secondary message lines, delimited
by a +++ line. A maximum of ten message lines are permitted.
Example

WTOM= major
Minor 1
Minor 2
minor n
+++
ROUT

Valid route code from 0 through 16 (0 meaning no route code).

Default: all route codes.

DESC

Valid descriptor code from 0 through 16. Default: 0 (none).

CONID

Console ID to which the message is issued. Valid range: 0 999.

Default: 0.

CONNAME

Name of the console to which the message is sent, or on that the

command is issued.

SYSTEM

Name of the system (meaning, the MVSIMAGE) to which the

message is sent, or on that the command is issued.

JOBNAME

Name of the job that issued the message.

JOBID

The JES2 or JES3 job ID of the job that issued the message.
Note: Parameters SYSTEM, JOBNAME and/or JOBID can be
used to simulate messages coming from another member of a
Sysplex environment or JES3 complex.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-67

IOATEST Simulate Production Environment Events

Table 2-40

IOATEST Parameters (Part 2 of 2)

Parameter

Description

DEFDELAY

The period, in hundredths of a second, that the program waits

before a WTO or WTOR or WTOM message or command is
executed and the program ends. 1 to 4 digits. Default: 100 (one
second)

WAIT

Cause the step to wait n seconds. Valid range: 0 999.

TERM=Cnnnn

Condition code to be simulated. Valid range for nnnn: 0000

4095.

TERM=Unnnn

User abend code to be simulated. Valid range for nnnn: 0000

4095.

TERM=Snnn

System abend code to be simulated. Valid hexadecimal range for

nnn: 000 FFF.

WTO, ROUT, DESC, CONID, CMD, WAIT and TERM can also be specified
in the PARM keyword of the EXEC job step. If this method is used, only the
PARM parameters are executed in the following order: WTO, WAIT, TERM.
When using PARM, DEFDELAY is always 0.

Example
//EXEC IOATEST,
// PARM=WTO=PROGRAM ERROR,WAIT=10,TERM=U0008

Issues WTO message with the text PROGRAM ERROR, waits 10 seconds
and terminates the step with user abend U0008.
Figure 2-9

IOATEST Example

// EXEC IOATEST
//SYSIN DD *
CMD=D T
TERM=C0004
//

Issues the operator command D T and then terminates with condition code
C0004.

BMC Software, Inc., Confidential and Proprietary Information

2-68

INCONTROL for OS/390 and z/OS Utilities Guide

IOAVERFY Verify IOA File Installation and Status

IOAVERFY Verify IOA File Installation and Status

Utility IOAVERFY can be used to perform the following tasks:

Verify INCONTROL product installation.

Produce reports on the utilization of various IOA files.

Produce a report describing invalid records in the IOA Conditions file,

the CONTROL-M Resources file, the CONTROL-M Active Jobs file, or
the CONTROL-M History Jobs file. (Invalid records can be
automatically corrected during the same run.)

Verify and replace specified data in records of the CONTROL-M Active

Jobs file.

Note:

At least one of the following parameters must be specified to

produce utility output: DISPLAY, VERIFY, LIST, DIAGNOSE, or
VER/REP.

Parameters
Table 2-41

IOAVERFY Parameters (Part 1 of 5)

Parameter

Description

DISPLAY

Controls the scope of display. Optional. Multiple DISPLAY

statements can be specified. Valid parameters for this statement:
ALL Information, warning, and error messages are displayed.
Default.
ERROR Only error and warning messages are displayed.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-69

IOAVERFY Verify IOA File Installation and Status

Table 2-41

IOAVERFY Parameters (Part 2 of 5)

Parameter

Description

VERIFY

Displays and verifies information about the requested items.

Multiple VERIFY statements can be specified. A VERIFY
statement remains in effect until the next VERIFY statement is
specified.
VERIFY statement formats:
VERIFY SYSTEM GENERAL
Displays general information about the system environment.
VERIFY PASSWORD
Displays CPU identification information required before
requesting a new password.
VERIFY FILE file_type
where
file_type indicates files to be displayed and verified in this run of
utility IOAVERFY. Valid values:
ALL Includes all files listed below.
AJF or CKP CONTROL-M Active Jobs file.
HST CONTROL-M History Jobs file.
AMF CONTROL-D Active Missions file.
CND IOA Conditions file.
RES CONTROL-M Resources file.
NRS IOA Manual Conditions file.
LOG IOA Log file.
Note: CKP and AJF are two names for the same CONTROL-M
file. Both names are supported.
If VERIFY FILE ALL is specified, the program determines which
products are installed and displays information on all relevant
filetypes.

LIST

Displays subsystem control blocks and IOA parameter tables.

This statement helps BMC Software Customer Support during
problem determination. Multiple LIST statements can be
specified.
LIST statement format:
LIST SUBSYS subsys_name
where
subsys_name is the name of subsystem whose control blocks
are to be displayed. Optional. If omitted, the subsystem name
specified in member IOAPARM is used. A snapshot dump is
taken of all the data areas relating to the subsystem.

BMC Software, Inc., Confidential and Proprietary Information

2-70

INCONTROL for OS/390 and z/OS Utilities Guide

IOAVERFY Verify IOA File Installation and Status

Table 2-41

IOAVERFY Parameters (Part 3 of 5)

Parameter

Description

DIAGNOSE

Checks the integrity of files processed by the utility. Produces a

report describing all records containing errors. Multiple
DIAGNOSE statements can be specified.
If optional keyword CORRECT (described below) is specified,
records containing errors are automatically corrected.
Note: Utility IOAVERFY cannot be run with the CORRECT
function while the CONTROL-M monitor is active. However,
online users can remain logged on.
It is strongly recommended that you not run the CORRECT
function while the CONTROL-D monitor, the CONTROL-O
monitor, or the IOA Functional monitor is active.
If the Active Jobs file is corrected by utility IOAVERFY, it is highly
recommended that you compress it afterwards. For information
about how to compress the Active Jobs file, see the CTMCAJF
utility in Chapter 3, CONTROL-M Utilities.
Valid formats for a DIAGNOSE statement:
DIAGNOSE file_type
or
DIAGNOSE file_type CORRECT
where
file_type indicates files to be processed by the DIAGNOSE
statement. Valid values:
ALL Includes all files listed below.
AJF CONTROL-M Active Jobs file.
HST CONTROL-M History Jobs file.
CND IOA Conditions file.
RES CONTROL-M Resources file.

CORRECT

Optional keyword. Records are automatically corrected only if

this keyword is specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-71

IOAVERFY Verify IOA File Installation and Status

Table 2-41

IOAVERFY Parameters (Part 4 of 5)

Parameter

Description

VER

Indicates information that is replaced with information in the REP

statement that immediately follows. Each VER statement must be
followed by one REP statement.
Note: VER statements and REP statements can be specified
only for records in the CONTROL-M Active Jobs file.
The VER statement is rejected if the data at the specified offset
does not match the data specified in the VER statement. If a
VER statement is rejected, the REP statement that follows it is
ignored.
An appropriate error message is produced for each record that is
rejected because of a VER/REP failure.
VER operands must appear between columns 1 and 80. VER
statement format:

VER rba type offset ver_format ver_data

where:
rba is the RBA of the record to be verified. The RBA must be
specified as a hexadecimal value of two, four, or six digits.
type is the type of offset:
X Hexadecimal value.
D Decimal value.
offset is the location of the data to be replaced with the data in
the REP statement. The first byte of the record always has an
offset of 0.
If type X is specified, the offset must be a hexadecimal value with
two or four digits. The maximum value cannot exceed 03FF.
If type D is specified, the offset must be a decimal value of one to
four digits and cannot exceed 1023.
ver_format Format of the data (specified in value ver_data) to
be verified:
X ver_data contains hexadecimal digits.
C ver_data contains alphanumeric characters.
ver_data Value to be replaced by the data specified in the
REP statement that follows. The specified value must be
enclosed in either single or double quotes.
If verformat is X, verdata must be specified as pairs of
hexadecimal digits. A maximum of 48 hex digits (meaning, 24
pairs) can be specified.
If verformat is C, verdata must be a string of alphanumeric
characters. Maximum length: 48 characters.

BMC Software, Inc., Confidential and Proprietary Information

2-72

INCONTROL for OS/390 and z/OS Utilities Guide

IOAVERFY Verify IOA File Installation and Status

Table 2-41

IOAVERFY Parameters (Part 5 of 5)

Parameter

Description

REP

Indicates data that replaces the information in the immediately

preceding VER statement. Optional, but each REP statement
must be preceded by one VER statement.
Note: VER statements and REP statements are specified only
for records in the CONTROL-M Active Jobs file.
REP operands must appear between columns 1 and 80. REP
statement format:
REP rba type offset rep_format rep_data
where
rba, type and offset must be identical to the rba, type and
offset specified in the preceding VER statement.
ver_format is the format of the data to be verified:
rep_format is the format of the specified rep_data:
Xrep_data contains hexadecimal digits.
DDecimal value.
rep_data is the data that replaces the data specified in the
preceding REP statement. The specified data must be
enclosed in either single or double quotes.
If repformat is X, repdata must be specified as pairs of
hexadecimal digits. A maximum of 48 hex digits (meaning, 24
pairs) can be specified.
If repformat is C, repdata must be a string of alphanumeric
characters. Maximum length: 48 characters.
The data specified in the VER statement and the data specified
in the REP statement must indicate strings of equal length.
Therefore, if ver_data and rep_data are specified in different
formats, the data that is specified in hexadecimal characters
must contain twice as many characters as the data specified in
alphanumeric characters, as illustrated in Example 2.
Note: Utility IOAVERFY cannot be run with the VER/REP
function while the CONTROL-M monitor is active. However,
online users can remain logged on.
Samples of VER statements and REP statements:
Example 1
Change the record with RBA 0 at offset x3F from x0003E8
through x00045D.
VER 00 X 3F X '0003E8'
REP 00 X 3F X '00045D'
Example 2
Change the record with RBA 0 at offset x0103 from x000000
through character string JB1.
VER 00 X 0103 X '000000'
REP 00 X 0103 C 'JB1'
Example 3
Change the record with RBA 1A95 at decimal offset 20 from
character string N28 through character string M04.
VER 1A95 D 20 C 'N28'
REP 1A95 D 20 C 'M04'

END

Terminates input to the utility. Optional. Only one END statement

can be specified, at the end of the utility statements.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 2 IOA Utilities

2-73

IOAVERFY Verify IOA File Installation and Status

Activating the Utility

A sample job can be found in member IOAVERIFY in the IOA JCL library.

Return Codes
Table 2-42

IOAVERFY Return Codes

Code

Description

Operation performed successfully.

Warning message.

8 and above

Severe error found.

Trace Facility
If you encounter errors when running utility IOAVERFY, you may be
requested to run the utility with optional parameter TRACE.
This parameter activates the trace facility of utility IOAVERFY. If TRACE is
specified, information about internal data areas is printed when the utility is
run.
Parameter TRACE is specified in the EXEC statement of the utility in the
following format:
//VERIFY EXEC IOAVERFY,TRACE=level

where level is the trace level to be activated. Valid value: 121.

Note:

This parameter is used only if requested by your BMC Software

Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

2-74

INCONTROL for OS/390 and z/OS Utilities Guide

142

Chapter 3

CONTROL-M Utilities

This chapter provides a detailed description of the CONTROL-M utilities.

Note:

Some utilities prefixed by IOA replace corresponding utilities

prefixed by CTM in previous versions. In such cases, the old utilities
are supported for your convenience; however, you should use the
IOA utilities.

CTMAESIM Test AutoEdit Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
CTMBGRP Convert Regular Scheduling Tables to Group Scheduling
Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Statements and Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
CTMBLDAE Build AutoEdit Symbols Member . . . . . . . . . . . . . . . . 3-16
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Handling Duplicate Members Using PARM=MERGE . . . . . . . . . . . 3-18
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
CTMBLT Create Scheduling Tables . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29
Calling the CTMBLT Utility from Another Program . . . . . . . . . . . . 3-30
Building Tables in Memory Followed by Immediate Ordering . . . . . 3-32
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
Job Scheduling Definition Parameter Tables . . . . . . . . . . . . . . . . . . . 3-40
CTMCAJF Maintain the Active Jobs File . . . . . . . . . . . . . . . . . . . . . . 3-49

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-1

Statements and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49

Compressing the Active Jobs File. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-52
Cleaning the Active Jobs File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-53
Changing the Size of the Active Jobs File . . . . . . . . . . . . . . . . . . . . . 3-53
Activating the COMPRESS Function. . . . . . . . . . . . . . . . . . . . . . . . . 3-54
Activating the CLEANUP Function . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54
Activating the COPY Function (Active Jobs File) . . . . . . . . . . . . . . . 3-54
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
CTMCRES Copy or Resize the CONTROL-M Resource File . . . . . . 3-57
Parameters and DDNAMEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
How to change the size of a CONTROL-M Resources file . . . . . . . . 3-58
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
CTMHCLN Maintain the History Jobs File. . . . . . . . . . . . . . . . . . . . . 3-59
SELECT/IGNORE Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Specifying AutoEdit Variables and Functions . . . . . . . . . . . . . . . . . . 3-60
Activating the utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
CTMHCOP Copy or Expand History Jobs File . . . . . . . . . . . . . . . . . . 3-62
Statements and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
File Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Changing the Size of the History Jobs File. . . . . . . . . . . . . . . . . . . . . 3-63
Activating the COPY Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-63
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-64
CTMJOB Order Jobs to the Active Jobs File . . . . . . . . . . . . . . . . . . . . 3-65
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-67
Format of the ORDER, SELECT, and IGNORE Statements . . . . . . 3-67
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-68
SELECT and IGNORE TAG Logic . . . . . . . . . . . . . . . . . . . . . . . . . . 3-70
SELECT and IGNORE TAG Examples . . . . . . . . . . . . . . . . . . . . . . . 3-71
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-72
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-73
CTMJSA Job Statistics Accumulation . . . . . . . . . . . . . . . . . . . . . . . . . 3-74
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-75
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-75
CTMRAFL Produce Active Jobs File Job Flow Report. . . . . . . . . . . . 3-77
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-77
CTMRCAL Create a Calendar Using the Job Plan Report . . . . . . . . . 3-78
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-78
Activating the Utility (and Example) . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
CTMRELRS Release Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-80
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-81
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-81
Examples of Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-82
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-82

BMC Software, Inc., Confidential and Proprietary Information

3-2

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRES Allocate and Format the CONTROL-M Resources File . . 3-83

Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-84
CTMRFLW Produce a Scheduling Table Job Flow Report. . . . . . . . . 3-85
EXEC Statement Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-86
Report Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-87
Example Chart Page Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89
Example JCLs for Text Format: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89
List of scheduling tables to be included in Job Flow report. . . . . . . . 3-89
Fields of the Job Flow Report in Text format . . . . . . . . . . . . . . . . . . 3-92
Sample Job Flow Report Output in Graphic Format . . . . . . . . . . . . . 3-94
Sample Prerequisite Condition Cross Reference List . . . . . . . . . . . . 3-95
Sample Control Resources Cross Reference List. . . . . . . . . . . . . . . . 3-96
Sample Quantitative Resources Cross Reference List . . . . . . . . . . . . 3-97
CTMRNSC Produce Night Schedule Report. . . . . . . . . . . . . . . . . . . . 3-98
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
Example of JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
Example of Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-99
CTMROGR Produce an Overnight Execution Graph . . . . . . . . . . . . . 3-100
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
Example of JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-102
CTMRPFL Produce a Job Plan and Job Flow Report . . . . . . . . . . . . . 3-104
Example JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105
CTMRPLN Job Plan Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Example of JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-107
Sample Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-108
Sample CTMRPLN Job Plan Report Type 0S Report . . . . . . . . . . . . 3-109
Sample CTMRPLN Job Plan Report Type 1S Report . . . . . . . . . . . . 3-109
Sample CTMRPLN Job Plan Report Type 1 Report . . . . . . . . . . . . . 3-110
CTMRSTR Restore the CONTROL-M Active Jobs File . . . . . . . . . . 3-111
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-111
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
CTMSLC Schedule Library Cleanup Utility . . . . . . . . . . . . . . . . . . . . 3-113
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
CTMTBUPD Update Job Scheduling Tables . . . . . . . . . . . . . . . . . . . 3-116
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
Fields Requiring Complex Updates . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
Condition or Resource Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
Subparameter Qualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-123
Updating Conditions and Resources . . . . . . . . . . . . . . . . . . . . . . . . . 3-124
Partial Names (Generic Changes) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-125
Miscellaneous Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-126
Utility Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-126
JCL Required to Execute CTMTBUPD. . . . . . . . . . . . . . . . . . . . . . . 3-127
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-127

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-3

CTMXRF Create Cross-Reference Reports . . . . . . . . . . . . . . . . . . . . . 3-130

Cross Reference Report Action Statements . . . . . . . . . . . . . . . . . . . . 3-130
Utility Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-132
JCL Required to Execute CTMXRF. . . . . . . . . . . . . . . . . . . . . . . . . . 3-132
Sample Output Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-133
CTMRJDS Produce Job Dataset Cross Reference Report . . . . . . . . . . 3-136
Procedure CTMJDS Generating the Job Dataset List . . . . . . . . . . . 3-136
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-137
FORMCKP Allocate, Format, and Resize the Active Jobs File. . . . . . 3-138
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-138
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-139
FORMHST Allocate and Format the History Jobs File . . . . . . . . . . . . 3-140
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-140
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-141

BMC Software, Inc., Confidential and Proprietary Information

3-4

INCONTROL for OS/390 and z/OS Utilities Guide

CTMAESIM Test AutoEdit Syntax

CTMAESIM Test AutoEdit Syntax

Utility CTMAESIM simulates the actions of the CONTROL-M submission
mechanism. It checks AutoEdit syntax and JCL setup. A command specified
in an input statement determines how the simulation works. For more
information, see the JCL and AutoEdit facility chapter in the CONTROL-M
for OS/390 and z/OS User Guide.

Parameters
The utility receives the following parameters using DD statement DASIM.
Either JCL Library Mode parameters or Scheduling Mode parameters (but
not both) must be specified to run the utility. These parameters determine the
mode in which the utility operates. In addition, other general simulation
parameters are specified.
Table 3-1

CTMAESIM JCL Library Mode Parameters

Parameter

Description

LIBRARY

JCL library name.

MEMBER

Member name. Character masking is supported (in batch

only).

OWNER

Owner ID. Optional.

APPL

Name of the application (as specified in field APPL in the job

scheduling definition). Optional.

GROUP

Name of the group to which the job belongs, such as

BACKUPS, RESERVATIONS, INVENTORY, and so on.

SCHEDULE TAG

Unique identifier to be applied to the accompanying set of

scheduling criteria. Multiple sets of scheduling criteria can be
defined, each with its own tag.

SCHENV

Used only in JES2. Name of the workload management

scheduling environment to be associated with the job.

SYSID

In JES2, the identity of the system in which the job must be

initiated and executed.
In JES3, the identity of the processor on which the job must
be executed.

NJE NODE

Identifies the node in the JES system at which the job must
execute.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-5

CTMAESIM Test AutoEdit Syntax

Table 3-2

CTMAESIM Scheduling Mode Parameters

Parameter

Description

SCHEDLIB

Name of the library containing the job scheduling definition.

TABLE

Name of the scheduling table containing the job scheduling

definition.

JOB

Name of the job scheduling definition. Character masking is

supported.

Note:

When specifying Scheduling Library Mode parameters, the owner,

application name, JCL library and JCL member of the job,
scheduling environment, system ID, and NJE node name are not
specified because the utility takes these values directly from the
specified job scheduling definition.
If a value is specified for parameter OVERLIB in the job scheduling
definition, that value (instead of parameter MEMLIB) is used as the
name of the JCL member.

Table 3-3

CTMAESIM Parameters (Part 1 of 2)

Parameter

Description

WDATE

Working date. Optional.

ODATE

Original scheduling date of the job. Optional.

SETVAR

Assigns values to AutoEdit variables (in batch only):

In JCL Library mode, parameter SETAVAR assigns AutoEdit
variable values without referencing the scheduling library.
In Scheduling Library mode, parameter SETAVAR can be used
to test values that are not set in the job scheduling definition.

BMC Software, Inc., Confidential and Proprietary Information

3-6

INCONTROL for OS/390 and z/OS Utilities Guide

CTMAESIM Test AutoEdit Syntax

Table 3-3

CTMAESIM Parameters (Part 2 of 2)

Parameter

Description

$SIGN

Assigns a value to the %%$SIGN System variable.

command

Determines how the simulation works. Valid values:

LIST CONTROL-M checks the JCL and writes the results to
SYSPRINT only.
SEND Same as LIST. This command is supported for
reasons of backward compatibility. Command LIST is the
preferred command.
SUBMIT CONTROL-M checks the JCL and writes the results
to both SYSPRINT and to the file referenced by DD statement
DASUBMIT. If you specify INTRDR for the RDR parameter, the
job is submitted for execution and the JCL is also checked by
MVS.
SUBSCAN Same as SUBMIT except that the statement
TYPRUN=SCAN is added to the job statement. If you specify
INTRDR for RDR, the job is submitted but not executed. The
JCL is checked by MVS.
Use this function if a JCL-checking product is in use at the site.
The utility creates a copy of the JCL member with all
CONTROL-M AutoEdit variables resolved. The JCL-checking
product can then be invoked against this copy. If JOB/SCAN is in
use at the site, consider using the on-line version of the
CTMAESIM utility, which is described in the CONTROL-M for
OS/390 and z/OS User Guide.

Any number of members can be submitted for testing in one simulation run.
If multiple members are specified, not all parameters need to be specified for
each member. The first member always requires a complete set of
parameters. Subsequent members require specification of the member name,
command, and any parameter statements whose values differ from the values
of the preceding member. For all unspecified parameters, the simulation uses
the corresponding value provided for the preceding member as the default.

Examples

Following is an example of multiple member specification, where only the

member name varies, in JCL Library mode:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-7

CTMAESIM Test AutoEdit Syntax

Figure 3-1

OWNER
WDATE
ODATE
MEMBER
LIBRARY
LIST
MEMBER
LIST
MEMBER
LIST

CTMAESIM Multiple Member Specification Example 1

owner ID
060600
060600
member1
jcl.library
member2
member3

Following is an example of multiple member specification, where the owner

also varies (both member2 and member3 are from owner-b), in JCL Library
mode.
Figure 3-2

OWNER
WDATE
ODATE
MEMBER
LIBRARY
LIST
OWNER
MEMBER
LIST
MEMBER
LIST

CTMAESIM Multiple Member Specification Example 2

owner-a
060600
060600
member1
jcl.library
owner-b
member2
member3

BMC Software, Inc., Confidential and Proprietary Information

3-8

INCONTROL for OS/390 and z/OS Utilities Guide

CTMAESIM Test AutoEdit Syntax

Following is an example of multiple job specification in Scheduling Library

mode.
Figure 3-3

CTMAESIM Multiple Job Specification

ODATE
SCHEDLIB
TABLE
JOB
LIST
JOB
LIST
TABLE
JOB
LIST

060600
scheduling-library
scheduling-table1
job name1
job name2
scheduling-table2
job name3

Activating the Utility

You can activate the utility either through a batch JCL or invoking it from
another program.

Batch JCL

The following is a sample batch JCL used to invoke CTMAESIM:

// .... JOB ....
// EXEC CTMAESIM
//DASIM DD *

Invocation from Another Program

The following is sample code used to invoke CTMAESIM from another

program:

...
DUMMY

CALL

CTMAES,(DUMMY)

DC

F0

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-9

CTMAESIM Test AutoEdit Syntax

When you invoke CTMAESIM from another program, observe the following
conventions:

The procedure that executes the invoking program must allocate all the
files that are necessary to execute AutoEdit simulation.

There must be no conflict between the DD names required by the

programand by AutoEdit simulation (for example, the DD name
SYSPRINT).

Because CTMAES is an authorized module, you must ensure that any

program that calls it must also be authorized and resides in an authorized
library.

All the loadlibs in the STEPLIB concatenation must be authorized.

INCLUDE the CTMAES module from the IOA loadlib in the link-edit
step.

Prior to calling CTMAES, the invoking program must be placed into

AMODE 31.

The calling program must be in RMODE 24.

The module must not be linked as RENT (reenterable) or REUS

(reusable).

Even though CTMAES does not require any parameters, when invoked
from a high-level language such as COBOL or PL/1, it must be called
with a dummy parameter containing zeros (0).

Return Codes
Table 3-4

CTMAESIM Return Codes

Code

Description

Operation performed successfully

Other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

3-10

INCONTROL for OS/390 and z/OS Utilities Guide

CTMAESIM Test AutoEdit Syntax

Examples
Example 1

The following jobs are checked by CONTROL-M and if no errors are found,
they are submitted (but not executed) and checked by the MVS JCL checking
mechanism.
Figure 3-4

CTMAESIM Example 1

// . . . JOB . . .
//
EXEC CTMAESIM,RDR=INTRDR
//DASIM DD *
USERID
SY01
WDATE
060600
ODATE
060600
$SIGN
2
MEMBER
JOBDAY01
LIBRARY
SYS3.CTM.JOBS
SUBMIT
OWNER
SY01
WDATE
060600
ODATE
060600
MEMBER
JOBWEKLY
LIBRARY
SYS3.CTM.JOBS
SUBMIT

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-11

CTMAESIM Test AutoEdit Syntax

Example 2

The following jobs are checked in Scheduling Library mode and the results
appear in the sysout.
Figure 3-5

CTMAESIM Example 2

// . . . JOB . . .
// . . . EXEC CTMAESIM,RDR=INTRDR
//DASIM DD *
ODATE
060600
SCHEDLIB
SYS3.CTM.JOBS
TABLE
DEFSCHED3
JOB
TAPE01
LIST
JOB
TAPE02
LIST
TABLE
DEFSCHD4
JOB
JOB1
LIST

BMC Software, Inc., Confidential and Proprietary Information

3-12

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBGRP Convert Regular Scheduling Tables to Group Scheduling Tables

CTMBGRP Convert Regular Scheduling Tables to

Group Scheduling Tables
Utility CTMBGRP automatically converts regular scheduling tables into
group scheduling tables.
During conversion from a regular scheduling table to a group table, the
following actions are automatically performed by the utility:

A group entity is created for the table.

A group name is defined and added (in protected mode) to the GROUP
field in each job scheduling definition.

The format of the regular job scheduling definitions is modified to match

the format of job scheduling definitions in Group scheduling tables
(meaning, the SCHEDULE TAG field is added to, and supported in, the
job scheduling definitions).

By default, the value of parameter MAXWAIT is obtained from the

group definition. However, if parameter TAGMAXWT in member
CTMPARM of the IOA PARM library is set to N (No), the value of this
parameter is obtained from the job definition.

Note:

Compress jobs within a table (meaning, job scheduling definitions

with the MINIMUM and PDS fields defined) are converted, but these
jobs are not assigned SCHEDULE TAG fields. Instead, their only
scheduling criteria after the conversion are the MINIMUM and PDS
criteria. However, a SCHEDULE TAG field can be manually added
following conversion.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-13

CTMBGRP Convert Regular Scheduling Tables to Group Scheduling Tables

Statements and Parameters

The utility receives parameters using DD statement SYSIN. All utility
messages are written to the SYSPRINT file. In addition, the START or END
conversion messages are also written to the IOA Log file.

Statements

The required datasets are referenced by the following DD statements:

Table 3-5

CTMBGRP Required Datasets

Dataset

Description

DALOG

References the IOA Log file.

SYSPRINT

References the utility message file. This file can be a SYSOUT

file.

SYSIN

References the utility input file.

Keywords in the SYSIN statements must be specified beginning in column 1

and in the exact sequence indicated. Lines with an asterisk (*) in column 1
are treated as comment lines.

Parameters
Table 3-6

CTMBGRP Required Keywords

Keyword

Description

IN-TABLE

Old (regular) scheduling table library and member.

OUT-TABLE

New (Group) scheduling table library and member.

GROUP

Group name (1 20 characters) to be assigned to the

jobs in the scheduling table.

Multiple tables can be converted in a single run of the utility by passing

multiple sets of IN, OUT, or GROUP lines. These sets can be separated by
one or more comment lines.
Note:

The value assigned to OUT-TABLE cannot be identical to value of

IN-TABLE.

BMC Software, Inc., Confidential and Proprietary Information

3-14

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBGRP Convert Regular Scheduling Tables to Group Scheduling Tables

Activating the Utility (and Example)

A job to activate the utility can be found in member CTMBGRP in the
CONTROL-M JCL library.

Return Codes
Table 3-7

CTMBGRP Return Codes

Code

Description

All scheduling tables were successfully converted.

All scheduling tables were successfully converted, but at least

one of the tables contained at least one compress job. Compress
jobs are not assigned SCHEDULE TAG fields during conversion.

At least one table was not converted due to error. An error

message identifying the unconverted table, and the error, was
issued for each unconverted table.

16

Initialization failed. No tables were converted. A message

indicating the error was issued.

20

Insufficient memory. No tables were converted.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-15

CTMBLDAE Build AutoEdit Symbols Member

CTMBLDAE Build AutoEdit Symbols Member

Utility CTMBLDAE automatically builds AutoEdit symbol members using
regular and periodic IOA calendars as input. For more information about
types of AutoEdit symbols and instructions, see the JCL and AutoEdit
facility chapter in the CONTROL-M for OS/390 and z/OS User Guide.
For every scheduled date in the specified calendar, utility CTMBLDAE
creates one line in an AutoEdit member. The content of this line is
determined according to a user-defined generation (GEN) card. The GEN
card is a string used to create records in the output member (one record for
each scheduled date in the calendar).
Note:

This utility must be executed outside of the CONTROL-M

environment or with a %%RESOLVE OFF AutoEdit statement
preceding the SYSIN parameter.

Parameters
The parameters for the CTMBLDAE utility are specified in blocks in the
SYSIN file. Blocks consist of the following mandatory parameters (described
below).
CALLIB=input-calendar-library
CALMEM=input-calendar-member
OUTLIB=output-library
OUTMEM=[/]output-member
GEN=string
ENDCAL

More than one block of parameters can be specified.

Each parameter must be specified in each block. However, the parameters

in each block can be specified in any order.
Note:

In a parameter block, each parameter is specified only once.

However, if a parameter is specified more than once in a block,
only the last occurrence of the parameter in the block is
accepted.

If more than one parameter block is specified, each parameter block must
be delimited by parameter ENDCAL.

Comment lines can be specified by coding * in column 1.

BMC Software, Inc., Confidential and Proprietary Information

3-16

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLDAE Build AutoEdit Symbols Member

Blocks of parameters are specified in the following format:

Table 3-8

CTMBLDAE Parameters

Parameter

Description

CALLIB

Name of the library containing the calendar to be used as input to

the utility.

CALMEM

Name of the member containing the calendar to be used as input

to the utility.

OUTLIB

Name of the library to which the AutoEdit member, created by the

utility, is written.

OUTMEM

Name assigned to the AutoEdit member created by the utility.

GEN

String that forms the basis of the AutoEdit variables created by

the utility. The usual format for this string is:
variable=expression
where
variable is a user-defined AutoEdit variable
expression is a value or expression that resolves to a specific
value
The variable and/or expression can contain any of the following
reserved words (substrings) that are replaced with the
corresponding date values:
ODAT represents the date scheduled in the calendar, in
yymmdd format.
NEXT represents the next date scheduled in the calendar, in
yymmdd format.
PREV represents the previous date scheduled in the
calendar, in yymmdd format.
ODAY represents the day scheduled in the calendar, in dd
format.
OMONTH represents the month scheduled in the calendar,
in mm format.
OYEAR represents the year scheduled in the calendar, in yy
format.
$ODAT represents the date scheduled in the calendar, in
yyyymmdd format.
$NEXT represents the next date scheduled, in yyyymmdd
format.
$PREV represents the previous date scheduled in the
calendar, in yyyymmdd format.
$OYEAR represents the year scheduled in the calendar, in
yyyy format.
$OCENT represents the the first two digits, in the yyyy date
format (for example, 20 in 2000).
The variable and/or expression can also contain the following
reserved substring:
%%## represents a sequential line number for each line
generated by the utility.
Note: Values PREV, $PREV, NEXT and $NEXT are relative
expressions that are intended for use with ODATE and/or other
date expressions.

ENDCAL

Delimits parameter blocks. Mandatory.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-17

CTMBLDAE Build AutoEdit Symbols Member

Handling Duplicate Members Using PARM=MERGE

If the user specifies the same output member (meaning, the same OUTLIB or
OUTMEM combination) in more than one block, normally only the results of
the last occurrence of that member are saved.
To retain the results of all occurrences of that output member, use the
expression PARM=MERGE in the JCL EXEC statement. If you use this
statement, the results of each occurrence of the output member are
concatenated in the member.
If the OUTMEM parameter is specified using the format
OUTMEM=/member-name, the expression PARM=MERGE is ignored for
the block.

Activating the Utility

Activate the utility using member CTMBLDAE in the CONTROL-M JCL
library.

Return Codes
Table 3-9

CTMBLDAE Return Codes

Code

Description

Operation performed successfully

8 and above

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

3-18

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLDAE Build AutoEdit Symbols Member

Examples
Example 1

Figure 3-6

CTMBLDAE Example 1

//SYSIN
DD
*
CALLIB=CTM.PROD.CAL
CALMEM=PAYROLL
OUTLIB=CTM.PROD.SYMBOLS
OUTMEM=PAYCHECK
GEN=%%DATE_TYPE_OF_ODAT=REGULAR
//

Input calendar PAYROLL looks like the following (in September 2000):

-----S-------------S-------------S-------------S-------------S-------------S
1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 +
09
Y
Y
Y
Y
-----S-------------S-------------S-------------S-------------S-------------S

An AutoEdit table named PAYCHECK is created, as follows:

%%DATE_TYPE_OF_000908=REGULAR
%%DATE_TYPE_OF_000915=REGULAR
%%DATE_TYPE_OF_000922=REGULAR
%%DATE_TYPE_OF_000929=REGULAR

Example 2

A job requires as input a dataset whose name contains the date

PREFIX.%%RL%% created on the date of the programs last run. The JCL
for the job contains the following statements:
Figure 3-7

CTMBLDAE Example 2

//JCL JOB
//* %%LIBSYM CTM.PROD.SYMBOLS %%MEMSYM RLPREVD
//
EXEC PGM=RLPGM
//SYSUT1 DD DSN=PREFIX.%%RL%%ODATE,DISP=SHR
//SYSUT2 DD DSN=PREFIX.%%RL%%ODATE,DISP=(NEW,CATLG)

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-19

CTMBLDAE Build AutoEdit Symbols Member

Utility CTMBLDAE is submitted with the following statements:

%%RESOLVE OFF
CALLIB=CTM.PROD.CAL
CALMEM=RLRUN
OUTLIB=CTM.PROD.SYMBOLS
OUTMEM=RLPREVD
GEN=%%RLODAT=RLPREV

Input calendar RLRUN looks as follows (in September 2000):

-----S-------------S-------------S-------------S-------------S-------------S
1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 +
09
Y
Y
Y
Y
-----S-------------S-------------S-------------S-------------S-------------S

An AutoEdit symbols member named RLPREVD is created:

%%RL990907=RL000831
%%RL990914=RL000907
%%RL990921=RL000914
%%RL990928=RL000921
%%RL991005=RL000928

The submitted JCL DD statements on September 14, 2000:

//SYSUT1
//SYSUT2

DD
DD

DSN=PREFIX.RL000907,DISP=SHR
DSN=PREFIX.RL000914,DISP=(NEW,CATLG)

Example 3

For JOB2, CTMBLDAE merges all the GEN statements for member
PAYCHECK.

BMC Software, Inc., Confidential and Proprietary Information

3-20

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLDAE Build AutoEdit Symbols Member

Figure 3-8

CTMBLDAE Example 3

//SYSIN
DD
*
CALLIB=CTM.PROD.CAL
CALMEM=PAYROLL
OUTLIB=CTM.PROD.SYMBOLS
OUTMEM=PAYCHECK
GEN=%%DATE_TYPE_OF_ODAT=REGULAR
ENDCAL
CALLIB=CTM.PROD.CAL
CALMEM=PAYROLL
OUTLIB=CTM.PROD.SYMBOLS
OUTMEM=PAYCHECK
GEN=%%DATE_TYPE_OF_$ODAT=REGULAR
ENDCAL
CALLIB=CTM.PROD.CAL
CALMEM=PAYROLL
OUTLIB=CTM.PROD.SYMBOLS
OUTMEM=PAYCHECK
GEN=%%DATE_TYPE_OF_ODAT_NEXT=REGULAR
ENDCAL
//

Input calendar PAYROLL looks as follows (in September 2000):

-----S-------------S-------------S-------------S-------------S-------------S
1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 +
09
Y
Y
Y
Y
-----S-------------S-------------S-------------S-------------S-------------S

An AutoEdit table named PAYCHECK is created:

%%DATE_TYPE_OF_000908=REGULAR
%%DATE_TYPE_OF_000915=REGULAR
%%DATE_TYPE_OF_000922=REGULAR
%%DATE_TYPE_OF_000929=REGULAR
%%DATE_TYPE_OF_20000908=REGULAR
%%DATE_TYPE_OF_20000915=REGULAR
%%DATE_TYPE_OF_20000922=REGULAR
%%DATE_TYPE_OF_20000929=REGULAR
%%DATE_TYPE_OF_000908_000915=REGULAR
%%DATE_TYPE_OF_000915_000922=REGULAR
%%DATE_TYPE_OF_000922_000929=REGULAR

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-21

CTMBLT Create Scheduling Tables

CTMBLT Create Scheduling Tables

The CTMBLT utility automatically builds CONTROL-M regular or group
scheduling tables containing job scheduling definitions according to a set of
specified input statements, and optionally orders or forces them.
The utility builds scheduling tables that can contain multiple job scheduling
definitions. At least one scheduling table must be defined in each library
specified. At least one job scheduling definition must be defined in each
table.
For a description of other output files created by the utility see Activating
the Utility on page 3-9.

Parameters
Utility CTMBLT receives parameters from an input file referenced by
DD statement DAINPRM. The syntax of the input statements is:
Figure 3-9

CTMBLT Input Syntax

[{LIBRARY=libraryname}
{MEM-OVERWRITE=Y|N|ADD|ADDG|ORDER|FORCE}
{ADD-GLOBAL=Y|N}
{OPTION=opt}
[
{Super Global Parameter Statements}
TABLE=tablename
{Global Parameter Statements}
[
{GROUP-ENTITY=groupname}
MEMNAME=jobname
{Optional Local Parameter Statements}
{SCHEDULE-TAG=tagname}
]
]
]

BMC Software, Inc., Confidential and Proprietary Information

3-22

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Note the following points about this syntax:

Parameters enclosed in braces { } are optional.

Parameters not enclosed in braces { } are mandatory.

Note:

It is not necessary to define mandatory parameters locally if their

corresponding global definitions have been provided.

The set of parameters enclosed in a matching pair of brackets [ ] can be

specified more than once.

The line length is 80. The first 79 characters can contain parameters
and/or comments. Parameters can start in any column of the line. No
spaces are included between keywords and parameters.

One parameter is permitted per line. Subparameters can follow a main

parameter on the same line, separated from the main parameter by a
comma. Comments can be placed on the same line, separated from the
parameter by a space.

To use a double-byte character set (DBCS) in free text fields, enclose the
free-text parameter values (for example, DESC, SHOUT MSG) between
shift-out (xOE) and shift-in (xOF) delimiter bytes to indicate the
beginning and end of DBCS text.

Lines beginning with an asterisk (*) are treated as comments.

Any parameters whose values contain special characters (for example,

DESC='this description, contains blanks and commas') are enclosed in
either single quotes or parentheses.

The parameters specified in the input file are divided into the following
groups:

General Parameters
These parameters specify scheduling library names (LIBRARY),
scheduling table names (TABLE), job or Group-entity scheduling
definition names, (MEMNAME and GROUP-ENTITY) and schedule
tags (SCHEDULE-TAG).
This group of parameters also contains the following control parameters:
MEM-OVERWRITE, ADD-GLOBAL, and OPTION. These control
parameters can be specified any number of times, in any order, anywhere
in the input stream. Each control parameter applies to the table definition
in which it is embedded, and all subsequent table definitions, until a new
value for the parameter is specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-23

CTMBLT Create Scheduling Tables

Job Scheduling Definition Parameters

These parameters correspond to the parameters of the job scheduling
definition screen. They can be defined in the ways shown in the
following table:

Table 3-10

CTMBLT Job Scheduling Definition Parameters

Parameter

Description

Local

Apply only to the job scheduling definition for which they are
specified.

Global

Apply to all job scheduling definitions in the table in which they

are specified. When multiple occurrences of a parameter are not
permitted, and there are no Local definitions specified, the Global
definition of the parameter is applied. Global definitions are
specified by placing such parameters between the TABLE
parameter and the first MEMNAME or GROUP-ENTITY
parameter in the table.

Super Global

Super Global parameters, if specified, must be specified before

the first TABLE parameter and after any control parameters in the
input stream. Alternatively, they can be specified after parameter
TABLE=*END that is used to delimit the scope of the Super
Global parameters (rather than to define a new table). Any job
scheduling definition parameter defined as a Super Global
parameter remains in effect as a Global parameter across all the
tables in the input run stream until a TABLE=*END parameter is
encountered or until the end of the run stream.

Special Parameters
The MODEL parameter is currently the only parameter in this category.
By using this parameter when creating a new job scheduling definition,
you can significantly reduce the number of job scheduling parameters
you need to code. You achieve this by specifying an existing job
scheduling definition to serve as a model or skeleton. When you do, the
effect is as if you had effectively specified every possible CTMBLT job
scheduling parameter, with values corresponding to those contained in
the job scheduling definition of the model.
MODEL must be the first parameter specified in the job scheduling
definition; it must be specified immediately after the MEMNAME or
GROUP-ENTITY parameters.
You cannot specify MODEL as a global or super-global parameter.

BMC Software, Inc., Confidential and Proprietary Information

3-24

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

After specifying MODEL, you can specify any number of job scheduling
parameters to modify or add to the model definition, subject to the
following restrictions:
Job scheduling parameters specified after MODEL must not be
inconsistent with the model. If, for example, the model definition
contains DAYS values and you specify a DATES parameter,
CTMBLT will produce an error message.
If the model you specify contains a SCHEDULE TAG which is not
defined in the group entity to which the current job belongs,
CTMBLT will accept the model, but will produce an error message
after displaying the job scheduling definition.
If the model you specify contains a SCHEDULE TAG, but the
current job does not belong to a group, the SCHEDULE TAG is
ignored.
You can only specify a model group entity following a
GROUP-ENTITY general parameter.
The sequence in which the parameters appear in the input file is important as
it determines

which job and Group-entity scheduling definitions belong in which table,

and which tables belong in which library

whether job scheduling definition parameters are interpreted as Super

Global, Global or Local

When duplicate parameters are specified as Global or Super Global

parameters, only the last takes effect.
The parameters of the input file are described below, according to group.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-25

CTMBLT Create Scheduling Tables

General Parameters
Table 3-11

CTMBLT Parameters (Part 1 of 3)

Parameter

Description

ADD-GLOBAL

Determines if Global parameter definitions and/or Super

Global parameters are added when Local definitions for the
parameter exist. Local parameter definitions are always
applied. Therefore, this parameter is relevant only for
parameters that can be specified more than once in a job
scheduling definition.
Valid values are:
Y (Yes) Add Global or Super Global parameter definitions
after the local parameter definitions. Default.
N (No) Ignore Global parameter definitions.

END

Terminates the processing of input control statements from

the DAINPRM file. This parameter is optionalit is necessary
only when calling CTMBLT from other programs under certain
circumstances; see the line# parameter in Table 3-12 on
page 3-30.

GROUPENTITY

Specifies, in not more than 20 characters, the name of the

Group entity in a Group scheduling definition. When
GROUP-ENTITY is used before the MEMNAME parameter in
a table, the table is a Group scheduling table instead of a
regular table. All parameters that follow the GROUP-ENTITY
parameter, until the next MEMNAME parameter, define the
Group entity.

LIBRARY

Specifies the name of the library in which the scheduling

table is saved.
The LIBRARY parameter is optional, but if specified, it must
be the first parameter specified to the utility. If the LIBRARY
parameter is not specified, add DD statement DASCHD, as
explained in Activating the Utility on page 3-9. The
CTMBLT utility runs more efficiently when a DD statement
is specified in place of the LIBRARY parameter.
The LIBRARY parameter must be followed by at least one
TABLE parameter.
The LIBRARY parameter applies to all subsequent TABLE
parameters until another LIBRARY parameter, or the end of
the input file, is encountered.

MEMNAME

Specifies the JCL member name of the job (and therefore the
name of the job scheduling definition)a.
Since each job scheduling definition applies to a specific JCL
member, the name assigned to the job scheduling definition
is the name of the JCL member.
At least one MEMNAME parameter must be specified after
each TABLE or GROUP-ENTITY parameter. Each occurrence
of the MEMNAME parameter indicates the beginning of a
new job scheduling definition.

BMC Software, Inc., Confidential and Proprietary Information

3-26

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Table 3-11

CTMBLT Parameters (Part 2 of 3)

Parameter

Description

MEMOVERWRITE

Determines how the table (and its jobs) is handled.

Valid values are:
Y (Yes) Overwrite the current table if a table with the
same name already exists in the library.
N (No) Do not overwrite the current table if a table with
the same name already exists in the library. Display an
error message. Default.
ADD If the table does not exist, add it to the library. If a
table with the same name already exists, add the new jobs
to the existing table.
ADDG Adds jobs to a Group table. If a Group table with
the same name already exists, add the new jobs to the
existing Group table.
ORDER or FORCE Do not write the table to a library.
Directly order or force jobs to the Active Jobs file without
creating CONTROL-M job scheduling definitions. However,
if OPTION=S is specified, job schedule tables are created
Warning! Use caution if specifying Y (Yes) in this parameter
because the old contents of all overwritten members are
irretrievably lost.

SCHEDULETAG

Specifies the name of a schedule tag to be created in the

Group entity (up to 20 characters). This parameter can only
be used in conjunction with a Group entity. The list of
parameters that can follow a SCHEDULE-TAG parameter is
found in Table 2 (Scheduling Criteria) below. It cannot be
followed by the D-CAT, MINIMUM and PDS parameters. An
unlimited number of SCHEDULE-TAG parameters can be
specified in the job scheduling definition. All parameters
following the SCHEDULE-TAG parameter define the
scheduling criteria for that tag, until the next occurrence of the
SCHEDULE-TAG parameter. The special keyword
SCHEDULE-TAG=*END must be specified after the
scheduling criteria of the last SCHEDULE-TAG parameter to
identify the end of those scheduling parameters.
Global or Super Global basic scheduling parameters (DAYS,
WDAYS, and so on.) are not applied to schedule-tags defined
in the Group entity definition.
Schedule-tag definitions (that is, the schedule-tag name
together with its basic scheduling parameters) cannot be
specified within Global or Super Global parameters.

TABLE

Specifies the name of the scheduling table (member) to be

created.
A table name must be a valid partitioned dataset (PDS)
member name.
At least one TABLE parameter must be specified after each
LIBRARY parameter.
At least one MEMNAME parameter (identifying a job
scheduling definition) must follow each TABLE parameter.
The TABLE parameter applies to all subsequent job
scheduling definitions until the next TABLE parameter or
the end of the input file is encountered.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-27

CTMBLT Create Scheduling Tables

Table 3-11

CTMBLT Parameters (Part 3 of 3)

Parameter

Description

OPTION

Enables customization of the utility operation. Valid values

are:
/xxx Overrides the values specified by xxx, where xxx is
DAYS, DATES, or WDAYS. This value is especially useful
when used after the MODEL parameter to override, instead
of add to, the existing values of the parameters specified in
the model job schedule definition.
O Prevents the utility from failing (and issuing messages
CTM391S and BLT895I) due to multiple, contradictory
values. Setting OPTION to O instructs the utility to use the
last-specified contradictory value to override all previous
contradictory values.
For example, if WDAYS=1 is specified and followed by
WDAYS=-1, WDAYS=-1 overrides WDAYS=1 if OPTION=O
is specified.
E Writes the scheduling table to the scheduling library
(subject to any specified MEM-OVERWRITE override) even
if an error occurred during processing of a table input
parameter.
Note: The utility ignores the OPTION=E parameter when
creating Group scheduling tables.
M Causes additional information messages to be
produced by the utility. (Expanded message option.)
Q When the CTMBLT utility tries to create or update a
scheduling table that is being updated or edited by another
task simultaneously, it produces the following error
message:

dsn in use
If OPTION is set to Q, the CTMBLT utility waits until the
other task completes updating the scheduling table and no
error message is produced. Ensure that an enqueue
management product issues periodic reminders that a
resource conflict must be resolved. (Alternate serialization
enqueue method.)
S[/subopt] Indicates that the job scheduling definition is
saved in the scheduling library after the job is ordered or
forced. If value ORDER or FORCE has been specified for
parameter MEM-OVERWRITE, OPTION=S can be used to
specify as a subopt value one of the usual values of
MEM-OVERWRITE (that is, Y (Yes), N (No), ADD, or ADDG).
The specified value has the same meaning and application as
if specified in parameter MEM-OVERWRITE.
If OPTION is set to S, the LIBRARY parameter, if specified,
must contain the name of an existing scheduling library.
a

Although MEMNAME is a job scheduling definition parameter, it is included here as

a general parameter because it determines the name of the job scheduling definition
and cannot be defined globally.

BMC Software, Inc., Confidential and Proprietary Information

3-28

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Job Scheduling Definition Parameters

These parameters correspond to the parameters of the CONTROL-M job

scheduling definition screen. For a detailed description of what each
parameter does, refer to the job production parameters chapter in the
CONTROL-M for OS/390 and z/OS User Guide. For a brief description of
each parameter, see Job Scheduling Definition Parameter Tables on
page 3-40.
Some parameters, including DATES, IN, CONTROL, RESOURCE, OUT,
CODES, MAIL-TO, and MAIL-CC, can be repeated by specifying more than
one value for the parameter.

Examples
Example 1
IN=(condname,date,condname,date...)
MAIL-TO=(email-address1,email-address2,...)

Multiple occurrences for job scheduling definition parameters can also be

defined (when permitted) by repeating the keyword for each occurrence.

Example 2
SETVAR=%%A=%%ODAT
SETVAR=%%B=53

Normally, these parameters are defined for the specific job scheduling
definition in which they appear (meaning, they are defined as local). To
simplify specification of the input parameters for the utility, all job
scheduling definition parameters in a table (except the general parameter) can
also be defined as Global or Super Global. Global definitions are used as
defaults for all jobs in the table. Super Global definitions are used as defaults
for all tables within their scope.
If a combination of Global, Super Global, and Local values for a parameter
are specified, the order of precedence of the parameter values is as follows:
Local, Global and Super Global. The Global and Super Global parameter
definitions may or may not be used depending on the following:

For parameters that do not permit multiple occurrences, the order of

precedence is as above.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-29

CTMBLT Create Scheduling Tables

For parameters that permit multiple occurrences:

If Local values appear and N (No) was specified in parameter
ADD-GLOBAL, Global and Super Global values are ignored.
If Y (Yes) was specified in parameter ADD-GLOBAL, Global and
Super Global values are used in addition to Local values.

Some parameters, when defined as Global and Super Global parameters,

are ignored when a Group entity is built. These parameters are processed
normally when job scheduling definitions are built in the Group table. for
For the parameters that fall into this category, see Table 3-15 through
Table 3-19.

Input job scheduling definition parameters are validated in the same manner
as in the online environment.

Calling the CTMBLT Utility from Another Program

The CTMBLT utility can be called from another program. The calling
program passes required control statements to the CTMBLT utility using a
table residing in memory (rather than from a data set referenced by
DD statement DAINPRM). CTMBLT can also pass back to the calling
program replies on the activities it performed.
To call CTMBLT from another program and pass a table of control
statements residing in memory to the CTMBLT utility, specify the following
parameters in the calling statement.
Note:

Except for the cnt parameter, not all the parameters are required. If a
parameter is not required, you should specify 0 as the value, unless it
is the last parameter in the list, in which case you can omit it.

Table 3-12

CTMBLT Calling Parameters (Part 1 of 2)

Parameter

Description

cnt

Specifies the number of parameters that follow (valid values are

2, 3, and 4). This parameter must be a halfword.

line#

Specifies the number of control statements being passed to the

CTMBLT utility. This parameter must be a full word.
This parameter is mandatory if an address of a table residing in
memory is also specified, unless an END statement has been
included in the table containing the CTMBLT control statements.

taddress

Specifies the address of the table residing in memory. This table

contains CTMBLT control statements, and each element in the
table must be an 80-byte card image.

BMC Software, Inc., Confidential and Proprietary Information

3-30

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Table 3-12

CTMBLT Calling Parameters (Part 2 of 2)

Parameter

Description

altaddress

Specifies the address of the table of alternate ddnames that

CTMBLT uses. This table provides alternate ddnames for the
following files:
DAINPRM
DAPRINT
DASCHD
DATABERR.
This parameter points to a table containing these four 8-byte
alternate ddnames, in the order shown. A DD name for which the
user does not want to supply an alternate must be left blank. You
must use this table when the calling program is already using one
of these ddnames.
Note: Do not use DAMSG as an alternate DD name, and do not
use DD name LIBOUT as an alternate for DASCHD.

replyaddr

Specifies the address of a parameter list used when requesting

replies from CTMBLT and any program that it calls, such as
CTMJOB when setting MEM-OVERWRITE to ORDER or
FORCE. These replies usually contain information about each
table built by CTMBLT, and about jobs ordered by CTMJOB.
The parameter list must be formatted as specified in macro
CTMBAPI, which is supplied in the IOA MAC library, as shown in
Table 3-13. The BAPIRPLS and BAPIRPLE parameters must be
specified. These parameters indicate the beginning and end (last
byte) address of a reply area, which the user must supply.
Optionally, the user can specify the BAPICMDA and BAPICMDL
parameters instead of the corresponding line# and taddress
parameters in the CTMBLT calling list.
Replies from CTMBLT and the programs that it calls are returned
to the area addressed by BAPIRPLS. CTMBLT returns as many
replies as can be fit in this area, which is determined by
BAPIRPLE. The number of replies is returned in BAPIRPL#. The
format and size of the each reply slot is mapped by macro
CTMBAPO in the IOA MAC library. If the supplied reply area is
insufficient to hold all replies, a Reason Code of 286 is placed in
BAPIRSN. The final utility return code is placed in BAPIURC.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-31

CTMBLT Create Scheduling Tables

Table 3-13 shows the CTMBAPI parameters used when requesting replies
from CTMBLT and programs that it calls.
Table 3-13

CTMBAPI Parameters Used by CTMBLT

BAPICMDA

Address of CTMBLT input control statements

BAPICMDL
BAPIRPLS

Address of reply area slots mapped by CTMBAPO

BAPIRPLE
BAPIRPL#
BAPIRSN
BAPIURC

Note:

Although there are other CTMBAPI parameters, they are reserved for
program use, and should be initialized to binary zero.

For example, in Assembler the following statement format is used:

CALL

CTMBLT,(cnt,line#,taddress,altaddr,replyaddr)

If utility CTMBLT cannot build a job scheduling table, a non-zero return

code is placed in register 15 (R15) and an error message is written to the file
referenced by DD statement DAPRINT.

Building Tables in Memory Followed by Immediate Ordering

Utility CTMBLT can create job scheduling tables in memory (instead of in a
scheduling library) and order or force them.
This functionality enables users to order or force jobs to the Active Jobs file
without saving CONTROL-M job scheduling definitions in a scheduling
library.
To create scheduling tables in memory and then order or force them, specify
the same parameters as when creating scheduling tables in a library.
However, note the following point about the syntax:
MEM-OVERWRITE={ORDER|FORCE}[({SDATE|WDATE|yymmdd})]

BMC Software, Inc., Confidential and Proprietary Information

3-32

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

The MEM-OVERWRITE statement must be specified in this syntax. An

order or force action must be specified, followed by one of the following date
references:

SDATE Current system date.

WDATE Current CONTROL-M working date (default).
yymmdd Any valid 6 character date.

Activating the Utility

A sample job to activate the utility can be found in member CTMBLT in the
CONTROL-M JCL library.

Considerations
The file referenced by DD statement DAPRINT holds all messages produced
by the utility. This file can alternatively be specified as a dataset instead of a
sysout print file.
The file referenced by DD statement DATABERR holds parameters from the
file referenced by DD statement DAINPRM that could not be processed due
to syntax errors or other errors. Statement DATABERR is optional. Omitting
this DD statement improves the performance (meaning, reduces the elapse
time) of the utility; therefore, for very large runs of utility CTMBLT, consider
removing this statement from the JCL.
Parameters in the file referenced by DD statement DAINPRM can be
specified either as in-stream data or as 80-byte card image data.
It is unnecessary to specify DD statements for scheduling libraries because
the utility dynamically allocates job-scheduling libraries according to
parameter LIBRARY. A DASCHD DD statement is required when
parameter LIBRARY is not specified as the first input parameter of the
utility. For example:
//DASCHD DD DISP=SHR,DSN=ctm.schedule.lib

Use of this DD statement is also recommended in any of the following

situations:

Utility CTMBLT creates a single job-scheduling library.

Many members are created within the library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-33

CTMBLT Create Scheduling Tables

Return Codes
Table 3-14

CTMBLT Return Codes

Code

Description

Utility CTMBLT ended successfully.

An error occurred while analyzing the input stream.

Check the output referenced by DD statement DAPRINT for a
message indicating the cause of the problem. Correct the
definitions and resubmit the job.

12

A severe error occurred.

Check the output of the job for messages indicating the source of
the problem. If you are unable to correct the problem, contact
your INCONTROL administrator.

Examples
Example 1

The following example creates two scheduling tables (INITJOBS and

PRDDAILY) in the CTM.PROD.SCHEDULE library. In table INITJOBS,
two job scheduling definitions (PNADCICW and PNADCIC1) are created. In
table PRDDAILY, one job scheduling definition (CHKACC) is created.
Global parameters GROUP=INIT-JOBS-1 and MEMLIB=GENERAL are
defined for table INITJOBS, and apply to the two job scheduling definitions
in that table. They are identified as Global definitions because they are
positioned between parameter TABLE=INITJOBS and parameter
MEMNAME=PNADCICW, which is the first MEMNAME parameter in the
table.

BMC Software, Inc., Confidential and Proprietary Information

3-34

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Figure 3-10

CTMBLT Example 1

//DAINPRM
DD *
LIBRARY=CTM.PROD.SCHEDULE
MEM-OVERWRITE=N
ADD-GLOBAL=Y
TABLE=INITJOBS
GROUP=INIT-JOBS-1
MEMLIB=GENERAL
MEMNAME=PNADCICW
OWNER=OPSUSER
DESC=CO - POST ONLINE COPY IMAGE FOR PHASE3
IN=(PNADCICW-OK,PREV)
OUT=(PNADCICW-OK,ODAT,+)
MEMNAME=PNADCIC1
OWNER=OPSUSER
OUT=(PNADCIC1-OK,ODAT,+)
TABLE=PRDDAILY
MEMNAME=CHKACC
MEMLIB=GENERAL
OWNER=OPSUSER
TASKTYP=JOB
GROUP=CHECK-ACCOUNTS
WDAYS=(2,3,4,5)
IN=(PNADCICW-OK,ODAT)
ONPGM
STEP=ANYSTEP
CODES=NOTOK
DO=SYSOUT
SYSOUT-OP=C
SYSOUT-FRM=R
SYSOUT-PRM=M
SHOUT-WHEN=NOTOK
DEST=OPER-12
MSG=JOB CHKACC HAS AN ERROR CHECK IT
URG=U
CTBSTART
CTBS-TYPE=RULE
CTBS-NAME=CHKBRL
CTBS-ARGS=1 TO 45 CHARS
CTBEND
CTBE-TYPE=MISSION
CTBE-NAME=ENDMI1
CTBE-ARGS=1 TO 45 CHARS

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-35

CTMBLT Create Scheduling Tables

Example 2

In the following example, the MEM-OVERWRITE statement indicates that

scheduling tables TABLE1 and TABLE2 are created in memory and
immediately ordered.
In table TABLE1, a job scheduling definition, MYMEM1, is created and then
ordered. In table TABLE2, a job scheduling definition, MYMEM2, is created
and forced. (Both jobs are ordered or forced without saving external job
scheduling definitions.)
Figure 3-11

CTMBLT Example 2

//DAINPRM
DD *
LIBRARY=name1
MEM-OVERWRITE=ORDER(WDATE)
ADD-GLOBAL=Y
TABLE=TABLE1
GROUP=GROUP1
MEMLIB=GENERAL
MEMNAME=MYMEM1
OWNER=CTMBLT
DESC='ORDER JOB MYMEM1
DAYS=ALL
OUT=(MYMEM1-OK,ODAT,+)
LIBRARY=name2
MEM-OVERWRITE=FORCE
TABLE=TABLE2
GROUP=GROUP2
MEMLIB=GENERAL
MEMNAME=MYMEM2
OWNER=CTMBLT
DESC='FORCE JOB MYMEM2'
IN=(MYMEM1-OK,ODAT)
//

(Since the tables are created in memory, any library name can be specified. It
does not need to correspond to an actual library or file.)

BMC Software, Inc., Confidential and Proprietary Information

3-36

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Example 3

The following, simplified example calls CTMBLT from another program and
passes required control statements to CTMBLT. CTMBLT uses a table in
memory to force the MYJOB job.
In this example, a DAINPRM DD statement was not needed to execute the
JCL. Usually, situations require CTMBLT control statements to be read from
an external file or dynamically constructed into a GETMAIN area within the
program. Also, any output normally routed to DD name DATABERR is
written to DD name ERROR.
In addition, CTMBLT returns replies from itself and from the CTMJOB
utility, which is invoked to perform the job order. For a look at the format of
the reply areas, see the CTMBAPO member.
Figure 3-12

FOUR DC
TBLADDR
ALTDDP
ALTDDL

*
RPLYP

RPLYAREA
*
INCORETB

CTMBLT Example 3

CALL
LTR
BNZ
...
H4
DC
DC
DC
DC
DC
DC

CTMBLT,(FOUR,0,TBLADDR,ALTDDP,RPLYP)
R15,R15
error-routine

A(INCORETB)
A(ALTDDL)
CL8
CL8
CL8
CL8ERROR

DS
DC
DC
DS
DS
DS
DS
DS
DS
DS

6A
A(RPLYAREA)
A(RPLYAREA+(10*64)-1)
F
A
26C
H
H
XLn
10CL64
(see

DS
DC
DC
DC
DC
DC
DC

0CL80 TABLE OF CTMBLT CARD-IMAGE CONTROL STMTS

CL80LIBRARY=*INCORE*
CL80MEM-OVERWRITE=FORCE
CL80TABLE=MYTABLE
CL80MEMLIB=GENERAL
CL80MEMNAME=MYJOB
CL80END
(a linecount parameter is not necessary)

4 PARAMETERS

(see CTMBAPI details)

BAPIRPLS
BAPIRPLE
BAPIRPL#

BAPIRSN
BAPIURC
(n=remaining length)
CTMBAPO for details) Room for 10 replies

Example 4

The following example illustrates the creation of Group scheduling tables and
Super Globals.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-37

CTMBLT Create Scheduling Tables

Figure 3-13

CTMBLT Example 4

MEM-OVERWRITE=Y
ADD-GLOBAL=Y
DOCLIB=SUPER.GLOBAL.DOCLIB
APPL=SUPER-GLOBAL-APPL
ONPGM
STEP=ANYSTEP
CODES=C0008
DO=COND
CONDS=(SUPER-GLOBAL-COND,ODAT,+)
TABLE=@INITJOB
OWNER=GLBLOWN
SCHEDULE-TAG=X
ADJUST-CONDS=Y
PRIORITY=GL
MEMLIB=GLBL-MEMLIB
APPL=GLOBAL-APPL
OVERLIB=OVER.LIB.GLOBAL
ONPGM
STEP=ANYSTEP
CODES=C0000
DO=COND
CONDS=(GLOBAL-COND,ODAT,+)
CONTROL=(CONTROL-RESOURCE,E)
RESOURCE=(QUANTIT-RESGLOBL,0009)
GROUP-ENTITY=GRROUP-ENTITY1
ONPGM
STEP=GROUPEND
ON GROUPEND
CODES=NOTOK
DO=SHOUT
MSG=GROUP-ENT SHOUT
DEST=OPER-2,URG=U
SCHEDULE-TAG=TAG1
WDAYS=6
EXT-SHIFT=+7
CONFCAL=GRPDCAL
SCHEDULE-TAG=TAG3
DATES=(1010,0202,0909)
MAXWAIT=03
SCHEDULE-TAG=TAG4
DAYS=10
WDAYS=0
SCHEDULE-TAG=X
SCHEDULE-TAG=*END
***====== GROUP ENTITY (NON-TAG) DEFINITIONS ==
ADJUST-CONDS=Y
IN=(GROUP-IN-COND,ODAT)
OUT=(GROUP-OUT-COND,ODAT,+)
ONPGM
STEP=GROUPEND
ON GROUPEND
CODES=OK
DO=SHOUT
MSG=FIRST MSG
DEST=OPER-1,URG=V
SHOUT-WHEN=OK
MSG=SHOUT-WHEN
DEST=OPER-3
*
MEMNAME=PNADCICW
DAYS=+15
DCAL=CALENDR
OWNER=MKGRP
MEMLIB=GENERAL-LIB
MAXRERUN=233
INTERVAL=0001440
IN=(PNADCICW,PREV)
OUT=(PNADCICW-OK,ODAT,+)
TAG-RELATION=A
SCHEDULE-TAG=TAG1
RESOURCE=(JOB-RESOURCE,0099)
SCHEDULE-TAG=TAG3
SCHEDULE-TAG=*
MEMNAME=PNADCICX
APPL=LOCAL-APPL
IN=(PNADCICX,PREV)
OUT=(PNADCICX-OK,ODAT,+)

SUPER
SUPER
SUPER
SUPER
SUPER
SUPER
SUPER

GLOBAL
GLOBAL
GLOBAL
GLOBAL
GLOBAL
GLOBAL
GLOBAL

BMC Software, Inc., Confidential and Proprietary Information

3-38

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

SCHEDULE-TAG=TAG1
MEMNAME=ANOTHER
MEMLIB=GENERAL
IN=(ANOTHER,ODAT)
TABLE=@INITJO2
MEMLIB=GLBL-MEMLIB2
GLOBAL
GROUP-ENTITY=GRROUP-ENTITY2
SCHEDULE-TAG=TAG8
DAYS=5
DCAL=GRPDCAL
SCHEDULE-TAG=TAG9
PERIOD=L2P3
DCAL=PERCAL2
SCHEDULE-TAG=TAG10
DATES=(1111,1212,0808)
SCHEDULE-TAG=*END
DOCMEM=TABLE2
MEMNAME=PNADCCW2
SCHEDULE-TAG=TAG8
SCHEDULE-TAG=TAG9
MEMNAME=PNADCCX2
IN=(PNADCICW,PREV)
SCHEDULE-TAG=TAG10
MEMNAME=ANOTHER
IN=(ANOTHER,ODAT)
TABLE=@INITJO3
=== NOT A GROUP TABLE ===
GROUP=GLBL-GROUP3
GLOBAL
MEMLIB=GLBL-MEMLIB3
GLOBAL
DAYS=5
MEMNAME=PNADCCW3
GROUP=INIT-JOBS
DESC=THIS IS A BATCH JOB/TABLE GENERATION
OUT=(PNADCICW-OK,ODAT,+)
MEMNAME=PNADCCX3
IN=(PNADCICW,PREV)
PREVENT-NCT2=L
*** ======= SPECIFIY NEW SET OF SUPER GLOBALS ==========
TABLE=*END
ADD-GLOBAL=Y
DOCLIB=SUPER.GLOBAL.DOCLIB2
SUPER GLOBAL
APPL=SUPER-GLOBAL-APPL2
SUPER GLOBAL
TABLE=@INITJPB
OWNER=GLBLOWN9
GROUP=GLBL-GROUP9
SCHEDULE-TAG=X
MEMLIB=GLBL-MEMLIB
OVERLIB=OVER.LIB.GLOBAL9
CONTROL=(CONTROL-RESOURCE9,E)
GROUP-ENTITY=GRROUP-ENTITY1
SCHEDULE-TAG=TAG1
WDAYS=6
SCHEDULE-TAG=TAG4
WDAYS=0
SCHEDULE-TAG=X
SCHEDULE-TAG=*END
OUT=(GROUP-OUT-COND,ODAT,+)
MEMNAME=PNADCICW
MEMLIB=GENERAL-LIB
MAXRERUN=233
INTERVAL=0001440
INTERVAL-TYP=E
IN=(PNADCICW,PREV)
TAG-RELATION=A
SCHEDULE-TAG=TAG1
RESOURCE=(JOB-RESOURCE,0099)
SCHEDULE-TAG=*
MEMNAME=PNADCICX
APPL=LOCAL-APPL
IN=(PNADCICX,PREV)
SCHEDULE-TAG=TAG1
MEMNAME=ANOTHER
IN=(ANOTHER,ODAT)

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-39

CTMBLT Create Scheduling Tables

Example 5

You want to create a new job scheduling definition JOBB in scheduling table
TABLEB of library SCHED.LIBB. It will be identical to the scheduling
definition of JOBA in scheduling table TABLEA of library SCHED.LIBA,
except for the value of the OVERLIB parameter, which you want to set to
JCL.OVERLIB.
Figure 3-14

CTMBLT Example 5

LIBRARY=SCHED.LIBB
TABLE=TABLEB
MEMNAME=JOBB
MODEL=(SCHED.LIBA,TABLEA,JOBA)
OVERLIB=JCL.OVERLIBB

Job Scheduling Definition Parameter Tables

The following parameters can be defined as Local or Global parameters using
utility CTMBLT. For complete descriptions of these parameters, see the Job
Production parameters chapter in the CONTROL-M for OS/390 and z/OS
User Guide.
Note the following:

A + in column M indicates that multiple occurrences of the parameter are

allowed.

The GROUP USAGE column indicates special usage information.

Possible values in this column and their meanings are listed in the table
below:
1. The parameter can appear in a job scheduling definition of a Group
scheduling table.
2. The parameter can appear in the Group entity of a Group scheduling
table.
3. The parameter can appear in a scheduling tag definition.
4. The parameter cannot appear in a regular scheduling table.
5. When the parameter is defined as a Global and/or Super Global
parameter, it is ignored when the Group entity is built.

BMC Software, Inc., Confidential and Proprietary Information

3-40

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

6. The parameter can only occur in a regular scheduling table.

Table 3-15

CTMBLT General Job Parameters (Part 1 of 2)

Parameter

M Value

Description

Default

Group
Usage

ADJUST-CONDS

Y (Yes) or N (No)

Adjust conditions indicator.

For Group entities only.

MEMLIB

1 through 44 characters

Library containing JCL

member.

GENERAL

OWNER

1 through 8 characters

User-identification.

USER who
submitted
the job.
jobname, if
user is
unknown.

1,2

TASKTYP

3 characters

Type of task.

JOB

1,5

PREVENT-NCT2

Y, N, F, L, or blank

Prevent NOT CATLGD 2

errors.

APPL

1 through 20 characters

Application name.

1,2

GMEMNAME

1 through 20 characters

Group entity name.

GROUP

1 through 20 characters

Group name.

DESC

1 through 50 characters

Description of job.

1,2

OVERLIB

1 through 44 characters

Overriding JCL library

name.

1,5

SCHENV

1 through 16 characters

Workload management
scheduling environment
name.

SYSTEM-ID

1 through 4 characters

System affinity name.

NJE-NODE

1 through 8 characters

NJE node name.

1 through 66 characters
%%varname=value

Set AutoEdit value.

If value contains delimiter
characters (for
example, commas), enclose
the entire parameter text in
quotes or apostrophes (for
example, %%varname=val
ue).

1,2

DOCMEM

1 through 8 characters To
leave DOCMEM blank,
specify
DOCMEM = /

Documentation member.

DOCLIB

1 through 44 characters

Documentation library.

1,2

CTBSTART

None

Define
CONTROL-M/Analayzer
step as first job step.

1,5

SETVAR

2,4

TABLE
name

Same as
MEMNAME

2,4

1,2

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-41

CTMBLT Create Scheduling Tables

Table 3-15

Parameter

CTMBLT General Job Parameters (Part 2 of 2)

M Value

Description

Default

Group
Usage

CTBS-TYPE

RULE or MISSION

Type of
CONTROL-M/Analyzer
entity associated with the
CTBSTART step.

1,5

CTBS-NAME

1 through 8 characters

Name of the
CONTROL-M/Analyzer
mission or rule associated
with the CTBSTART step.

1,5

CTBS-ARGS

1 through 45 characters
within apostrophes

Arguments passed to
CONTROL-M/Analyzer.

1,5

CTBEND
CTBE-TYPE

RULE or MISSION

Type of
CONTROL-M/Analyzer
entity associated with the
CTBEND step.

1,5
1,5

CTBE-NAME

1 through 8 characters

Name of the
CONTROL-M/Analyzer
mission or rule associated
with the CTBEND step.

1,5

CTBE-ARGS

1 through 45 characters
within apostrophes

Arguments passed to
CONTROL-M/Analyzer.

1,5

Table 3-16

CTMBLT Scheduling Parameters (Part 1 of 2)

Default

Group
Usage

Parameter

M Value

Description

DAYS

1 through 3 characters
For information, see the Job
Production parameters
chapter in the CONTROL-M
for OS/390 and z/OS User
Guide

Scheduling days
(non-periodic).

1,3

PERIOD

4 through 5 characters
(DnPi or LnPi)

Periodic scheduling days.

1,3

DCAL

1 through 8 characters

DAYS calendar name.

1,3

RELATION

A or O

AND or OR relation
between DAYS or WDAYS.

1,3

WDAYS

1 through 4 characters
For information, see the Job
Production parameters
chapter in the CONTROL-M
for OS/390 and z/OS User
Guide

Weekly scheduling days

(non-periodic).

1,3

WPERIOD

4 through 5 characters
(DnPi or LnPi)

Periodic weekly scheduling

days.

1,3

1 through 8 characters

WDAYS calendar name.

1,3

WCAL

BMC Software, Inc., Confidential and Proprietary Information

3-42

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Table 3-16

CTMBLT Scheduling Parameters (Part 2 of 2)

Parameter

M Value

Description

Default

Group
Usage

MONTHS

1 through 3 characters
1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
11, 12, ALL

MONTHS scheduling.

ALL

1,3

DATES

4 characters

DATES scheduling.

1,3

CONFCAL

1 through 8 characters

Confirmation calendar
name.

1,3

SHIFT

1 character
Blank, >, <, @

Shift on confirmation
calendar.

1,3

EXT-SHIFT

2 through 3 characters

Additional shift.

Blank

No additional shift.

nn

Shift n days backward.

+nn

Shift n days forward.

RETRO

Y (Yes) or N (No)

Retroactive selection.

Value
specified in
optional
Wish
WM2548.

1,3

MAXWAIT

2 digits (00...98,99)

Maximum days job is

retained.

Value
specified in
optional
Wish
WM2367.

1,2,3

CATEGORY

1 through 20 characters

Category for CONTROL-D.

MINIMUM

3 digits

Minimum tracks left free.

PDS

1 through 44 characters

Full name of PDS Library to

be checked.

ACTIVE-FROM

6 digit date in the format

yymmdd

Date in the SCHEDULE

TAG ACTIVE FROM or
DEFINITION ACTIVE
FROM fields

1,3

ACTIVE-UNTIL

6 digit date in the format

yymmdd

Date in the SCHEDULE

TAG ACTIVE UNTIL or
DEFINITION ACTIVE
UNTIL fields

1,3

1 through 20 characters

Schedule tag name.

1,3,4

SCHEDULE-TAG

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-43

CTMBLT Create Scheduling Tables

Table 3-17

CTMBLT Runtime Parameters

Parameter

M Value

Description

Default

IN

(cond,date)
cond 1 through 20
characters
date 4 characters
Boolean characters |( }
Note: Closing parenthesis
) is not supported. Instead
of this character, use the
closing brace } (Hex value
D0)

IN condition.
Name of IN condition.

Group
Usage
1,2

Date reference of IN
condition.

CONTROL

(control,type)
control 1 through 20
characters
type S or E

Control resource.
Name of Control resource.
Usage type:
Shared or
Exclusive.

1,2

RESOURCE

(resource,number)
resource 1 through 20
digits
number 4 characters

Quantitative resource.
Name of resource.
Quantity of resource.

1,5

PIPE

pipe name (1 to 44
characters)

MAINVIEW Batch Optimizer

(MVBO)/Job Optimizer
Pipes pipe namea.

1,5

TIMEFROM

hhmm

Earliest time to submit job.

1,2

TIMEUNTIL

hhmm
>

Latest time to submit job

Submit as soon as possible.

1,2

TIME ZONE

1 through 3 characters

Time zone designation

1, 2

PRIORITY

1 to 2 characters

Priority.

1,2

SAC

1 character (P, N, -, +,
blank)

Schedule Adjustment for

Conversion.

1,2

DUE-OUT

hhmm

Time when the job finishes

executing.

CONFIRM

Y (Yes) or N (No)

Confirmation for scheduling.

1,2

This field is supported only if MAINVIEW Batch Optimizer (MVBO) is installed at your site.

Table 3-18

CTMBLT Post-Processing Parameters (Part 1 of 4)

Parameter

M Value

OUT

AUTOARC

Description

Default

Group
Usage
1,2

(out,date,option)
out 1 through 20 chars
date 4 characters
option +/-

Name of OUT condition.

Date reference.
Function: ADD or DELETE.

Y (Yes) or N (No)

Archive SYSDATA.

Y (Yes)

BMC Software, Inc., Confidential and Proprietary Information

3-44

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Table 3-18

CTMBLT Post-Processing Parameters (Part 2 of 4)

Parameter

M Value

Description

Default

Group
Usage

Y (Yes)

SYSDB

Y (Yes) or N (No)

Archive to common dataset.

MAXDAYS

2 digits

Expiration period.

MAXRUNS

3 digits

Max number of runs.

SYSOUT-OP

1 character (C,F,N,D,R)

SYSOUT option.

SYSOUT-FRM

1 character

SYSOUT option FROM

CLASS.

SYSOUT-PRM

For SYSOUT-OP:
C 1 character
F 1 through 44 chars
N 8 characters
D none
R none

SYSOUT parameter
according to SYSOUT
option SYSOUT-OP.

MAXRERUN

3 characters. Up to 256
minutes

Maximum number of reruns.

MAXRERUNCYC

4 digits, 0 through 9999

Maximum number of cyclic

runs. Effective only if
TASKTYPE is set to CYC

RERUNMEM

1 through 8 characters

Name of rerun job.

INTERVAL

4 digits, 0 through 64800

Time interval between

reruns.

INTERVAL-TYP

S, E, T

Start or End of Interval or

Target.

END

INTERVL-UNIT

M, H, D

The units in which

INTERVAL is expressed
(Minutes, Hours, or Days)

RET-DAYS

3 digits

Retention number of days.

RET-GENS

2 digits

Retention number of
generations.

1 through 7 characters

Step Range name.

FROMPGM

1 through 8 characters

FROM PGM STEP in step

range.

1,5

FROMPROC

1 through 8 characters

FROM PROC STEP in step

range.

1,5

TOPGM

1 through 8 characters

TO PGM STEP in step

range.

1,5

TOPROC

1 through 8 characters

TO PROC STEP in step

range.

1,5

Identifies the beginning of

an ON block.

1,2,5

STEPRNG

ONPGM

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-45

CTMBLT Create Scheduling Tables

Table 3-18

CTMBLT Post-Processing Parameters (Part 3 of 4)

Parameter
STEP

Description

PROGRAM STEP name for

ON block.
ON GROUPEND
parameters for Group
entities only. Codes OK and
NOTOK.

1,2,5

1 through 8 characters
GROUPEND

Default

Group
Usage

M Value

PROCS

1 through 8 characters

PROC STEP name for ON

block.

1,5

CODES

(5 chars,5 chars,...)

ON block codes.

1,2,5

ON-RELATE

A or O

AND or OR relation.

1,5

DO = OK

OK

Changes the status of a job

step or Group from NOTOK
to OK.

1,2,5

DO = NOTOK

NOTOK

Changes the status of a job

step or Group from OK to
NOTOK.

1,2,5

DO = RERUN

RERUN

Reschedules jobs following

an unsuccessful job run.

1,5

DO=COND

CONDS

DO=FORCEJOB

1,2,5
(out,date,option)

OUT condition

1,2,5

1,2,5

FORCE-TAB

1 through 8 characters

Table name

1,2,5

FORCE-JOB

1 through 8 characters

Job name

1,2,5

FORCE-DATE

6 characters

Date

1,2,5

FORCE-LIB

1 through 44 characters

Library name

1,2,5

DO=IFRERUN

1,5

IFRERN-FROM

1 through 16

charactersa
b

From

1,5

IFRERN-TO

1 through 16 characters

To

1,5

IFRERN-CONF

Y (Yes) or N (No)

Confirm

1,5

DO=CTB

1,5

CTB-RULE

1 through 45 characters

Rule name

1,5

CTB-ARG

1 through 36 characters

Arguments

1,5

DO=SET
SETVAR

1,2,5
1 through 66 characters
%%varname=value

Set AutoEdit value.

If value contains delimiter
characters (for
example, commas), enclose
the entire parameter text in
quotes or apostrophes (for
example, %%varname=val
ue).

1,2

BMC Software, Inc., Confidential and Proprietary Information

3-46

INCONTROL for OS/390 and z/OS Utilities Guide

CTMBLT Create Scheduling Tables

Table 3-18

CTMBLT Post-Processing Parameters (Part 4 of 4)

Parameter

M Value

DO=SHOUT

Description

Default

Group
Usage
1,2

MSG

1 through 70 characters

SHOUT message

1,2

DEST

1 through 16 characters

SHOUT destination

1,2

URG

1 character (R,U,V)

SHOUT urgency
This subparameter must
always be the last
subparameter in the block,
(meaning, after TIME, MSG,
and DEST).

1,2

Stops reruns of cyclic jobs.

1,5

DO=STOPCYCL
DO=SYSOUT

1,5

SYSOUT-OP

1 character (C,F,N,D,R)

SYSOUT option

1,5

SYSOUT-FRM

1 character

SYSOUT option FROM

CLASS.

1,5

SYSOUT-PRM

For SYSOUT-OP:
C 1 character
F 1 through 44 chars
N 8 characters
D none
R none

SYSOUT parameter
according to SYSOUT
option SYSOUT-OP.

1,5

DO=MAIL

1.2

MAIL-TO

(addr1,addr2,...) c

e-mail TO addresses

1.2

MAIL-CC

(addr1,addr2,...) c

e-mail CC addresses

1,2

MAIL-SUBJ

subject-line

e-mail subject line

1,2

MAIL-TEXT

text-lined

e-mail text line

1,2

SHOUT-WHEN

OK or NOTOK or
EXECTIME or RERUN

Indicates start of SHOUT

block.

1,2

TIME

4 characters

SHOUT on LATE or
LATESUB or EXECTIME.
Defaults to "*" when no
TIME value is specified for
the LATE or LATESUB
parameters. This
subparameter must precede
subparameter DEST.

1,2

MSG

1 through 70 characters

SHOUT message

1,2

DEST

1 through 16 characters

SHOUT destination

1,2

URG

1 character (R,U,V)

SHOUT urgency.
This subparameter must
always be the last
subparameter in the block,
(meaning, after TIME, MSG,
and DEST).

1,2

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-47

CTMBLT Create Scheduling Tables

IFRERN-FROM is a 16 character field whose value consists of an 8 character program step name and an 8
character proc step name. If a proc step name is specified and the program step name is less than 8 characters,
then the program step name must be padded with blanks and the value must be enclosed by delimiters.

IFRERN-TO is the same as described in the footnote above.

There is a limit of 255 MAIL-TO and 255 MAIL-CC addresses.

There is a limit of 255 MAIL-TEXT lines.

Table 3-19

Parameter
MODEL

CTMBLT Special Parameter

M Value
library-name,
table-name, job-name

Description

Default

Job definition skeleton

Group
Usage
1,2

BMC Software, Inc., Confidential and Proprietary Information

3-48

INCONTROL for OS/390 and z/OS Utilities Guide

CTMCAJF Maintain the Active Jobs File

CTMCAJF Maintain the Active Jobs File

Utility CTMCAJF performs special maintenance functions on the Active
Jobs file. The operator is warned in advance when the file is nearly full. The
operator can use utility CTMCAJF to perform any of the following actions:

Compress the file.

Delete entries from the Status screen.
Change the size of the file by copying the file to a different size file.

Statements and Parameters

The utility receives parameters, that designate the required function, using
DD statement DACOPPRM (or SYSIN). Any of the following functions can
be requested:
Table 3-20

CTMCAJF Parameters

Parameter

Description

COMPRESS

Make room in the Active Jobs file by physically deleting all jobs
marked DELETED or ENDED OK.

CLEANUP

Logically delete all jobs marked DELETED or ENDED OK in the

Active Jobs file. These jobs remain in the Active Jobs file until the
New Day procedure is run. The space these jobs occupy in the
file cannot be reused.
Logically deleted jobs can be restored using the U (Undelete)
option in the CONTROL-M Active Environment screen (screen
3).

COPY

Copy the Active Jobs file to a different size file, generally a larger
file.

Note:

The COMPRESS and COPY functions cannot run in parallel with

the CONTROL-M monitor. If the monitor is not shut down, the
utility terminates. Online users can remain logged on.
The CLEANUP function must run simultaneously with the
CONTROL-M monitor. Do not shut down the monitor when running
the utility with this function.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-49

CTMCAJF Maintain the Active Jobs File

SELECT/IGNORE Statements

SELECT/IGNORE statements are optional and can only be specified for

COMPRESS and CLEANUP functions. They identify jobs that are deleted or
not deleted, as follows:
Table 3-21

CTMCAJF SELECT/IGNORE Statements

Statement

Description

IGNORE
statements

Identify jobs that are not deleted.

SELECT
statements

Identify jobs that are deleted.

Note:

If a CLEANUP is being performed, SELECT/IGNORE statements

are applied in addition to (not instead of) the default
SELECT/IGNORE statements specified in the New Day procedure.
New Day procedure default SELECT/IGNORE statements are
applied by this utility.

Up to 500 SELECT/IGNORE statements can be specified. Jobs are handled

according to the first statement for which the criteria are met.
One or more of the parameters described in Table 3-22 can be specified in
any SELECT/IGNORE statement (in any order).

BMC Software, Inc., Confidential and Proprietary Information

3-50

INCONTROL for OS/390 and z/OS Utilities Guide

CTMCAJF Maintain the Active Jobs File

Table 3-22

CTMCAJF SELECT/IGNORE Statement Parameters

Parameter

Description

GROUP
groupname

Name of the group appearing in the job scheduling definition.

JOBNAME
jname or
MEMBER
memname

jnameName of the job appearing in both the JOB statement

and the JOBNAME field of the Status screen.
memnameName of the JCL member (specified in the
MEMNAME field in the job scheduling definition).
jname or memname (but not both) can be specified in one
statement.

STATUS status

Valid values are:

ACTIVE
Note: ACTIVE status includes all statuses except WAITSCHED,
ENDOK and ENDNOTOK. This status enables the user to select
or ignore jobs that are in ACTIVE status.

ENDOK
ENDNOTOK
HELD
WAITSCHED
GRP-ACTIVE (This status means that at least one job in the
group has not completed processing.)

FROM date

Starting ODATE in yymmdd format

TO date

Ending ODATE in yymmdd format

Note:

A prefix can be specified instead of a full group name, job name or

member name by placing an asterisk (*) at the end of the string (for
example, PROD*).

Specifying AutoEdit Variables and Functions

AutoEdit variables can be specified for any of the above parameters. These
variables are especially useful for specifying relative date ranges in the
FROM and TO parameters.
AutoEdit functions can be used to set variables and these variables can then
be used in the parameters of the utility. The lines in which the variables are
set must have an asterisk (*) in the first column of the line. Such lines are
resolved by the AutoEdit facility and are interpreted as comments by the
utility. Regular comments can also be specified in lines with an asterisk in the
first column.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-51

CTMCAJF Maintain the Active Jobs File

Example

*
*
*

IGNORE MEMBERS PREFIXED WITH BR14 that WERE ORDERED

WITHIN THE LAST THREE DAYS.
%%SET %%F = %%CALCDATE %%DATE -3
IGNORE MEMBER BR14*
FROM %%F

The following AutoEdit terms cannot be used in the input for this utility:

%%ODATE
%%OYEAR
%%OMONTH
%%ODAY
%%OWDAY
%%INCLIB
%%INCMEM

File Statements

File statements are mandatory for COPY functions. They cannot be specified
for COMPRESS or CLEANUP functions. OLDAJF and NEWAJF statements
must be specified for COPY functions:
Table 3-23

CTMCAJF File Statements

Statement

Description

OLDAJF

Name of the old Active Jobs file.

NEWAJF

Name of the new Active Jobs file.

Compressing the Active Jobs File

The Active Jobs file often contains entries for jobs that are no longer needed
(jobs with a status of DELETED or ENDED OK). Compression makes room
in the Active Jobs file by physically removing these unneeded entries from
the file. Removed entries are no longer displayed in the Status screen.

BMC Software, Inc., Confidential and Proprietary Information

3-52

INCONTROL for OS/390 and z/OS Utilities Guide

CTMCAJF Maintain the Active Jobs File

Cleaning the Active Jobs File

Normally, the Active Jobs file is cleaned (meaning, unneeded job entries are
deleted) once a day by the New Day procedure. By default, all jobs with
status ENDOK that are not being held are deleted during this cleanup. The
defaults can be overridden by using SELECT/IGNORE statements (that
select or ignore jobs for deletion).
Utility CTMCAJF can be run as often as necessary to clean the Active Jobs
file.
Unlike the cleanup performed by the New Day procedure, the cleanup
function of utility CTMCAJF does not actually delete the unneeded jobs.
Instead, it marks the job entries as deleted so that they are ignored by
CONTROL-M and so that, by default, the job entries do not appear in the
Status screen. (To display these logically deleted jobs in the Active
Environment Status screen, specify Y (Yes) in the DELETED field in the
Show Screen Filter window (3.SHOW) of the Status screen.)
Logically deleted jobs are physically deleted the next time the New Day
procedure or COMPRESS function is run.
When utility CTMCAJF is run to clean up the Active Jobs file, it applies the
cleanup criteria of the New Day procedure in addition to the cleanup criteria
specified with the utility. If the cleanup criteria of the New Day procedure are
not desired when running utility CTMCAJF, they are overridden by
SELECT/IGNORE statements specified in the utility.

Changing the Size of the Active Jobs File

Note:

If online, do not access the CONTROL-M Active Environment

screen in the IOA Online facility while the size of the Active Jobs
file is being changed.

To change the size of the CONTROL-M Active Jobs file, perform the
following steps:

Enter the INCONTROL Installation and Customization Engine (ICE)

CUSTOMIZE activity under for product ID CTM.

Select Customize CONTROL-M Dataset Parameters.

Select step CONTROL-M Dataset Parameters, update the AJFSIZE

parameter and exit the step.

Select step Save Parameters into Product Libraries.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-53

CTMCAJF Maintain the Active Jobs File

Select step Format the Active Jobs File, and reply Y (Yes) when asked
to replace existing copy of the job.

Change the dsname, unit and volser as required and run the job. This step
allocates and formats a new Active Jobs file and its associated BKP file.

Run utility CTMCAJF. The utility copies the current Active Jobs file to
new Active Jobs file.

Rename the old Active Jobs file.

Rename the new Active Jobs file to the former name of the old file.

Activating the COMPRESS Function

//COMP
EXEC CTMCAJF
COMPRESS
//

Activating the CLEANUP Function

//CLEANUP EXEC CTMCAJF
CLEANUP
//

Activating the COPY Function (Active Jobs File)

//COPY EXEC CTMCAJF
//
OLDAJF=CTM.PROD.CKP,
//
NEWAJF=CTM.PROD.NEWCKP
COPY
//

OLD ACTIVE JOBS FILE

NEW ACTIVE JOBS FILE

A sample job to activate the COPY function of the utility can be found in
member CTMCAJF2 in the CONTROL-M JCL library.

BMC Software, Inc., Confidential and Proprietary Information

3-54

INCONTROL for OS/390 and z/OS Utilities Guide

CTMCAJF Maintain the Active Jobs File

Return Codes
Table 3-24

CTMCAJF Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Examples
Example 1

Delete all jobs of the night batch from the Active Jobs file, except those with
a WAIT SCHEDULE status. In addition, delete jobs that ended OK and jobs
whose MAXWAIT interval has been exceeded if such jobs do not have
WAITSCHED status.
//COMP EXEC CTMCAJF
COMPRESS
IGNORE STATUS WAITSCHED
SELECT GROUP NIGHT-BATCH

Example 2

Delete only jobs in group G1, G2 and G3.

//COMP EXEC CTMCAJF
COMPRESS
SELECT GROUP G1
SELECT GROUP G2
SELECT GROUP G3
IGNORE GROUP *

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-55

CTMCAJF Maintain the Active Jobs File

Example 3

Delete all jobs except job A622451C.

//COMP EXEC CTMCAJF
COMPRESS
IGNORE MEMBER A622451C
SELECT MEMBER *

BMC Software, Inc., Confidential and Proprietary Information

3-56

INCONTROL for OS/390 and z/OS Utilities Guide

CTMCRES Copy or Resize the CONTROL-M Resource File

CTMCRES Copy or Resize the CONTROL-M

Resource File
The CTMCRES utility copies the contents of the CONTROL-M Resource
file to another file that may or may not be the same size, or converts a version
5.x.x IOA Conditions/Resources file to the current version of the
CONTROL-M Resource file. For more information, see the CONVERT
parameter in Table 3-25.
Note:

Utility CTMCRES cannot run simultaneously with the

CONTROL-M monitor. Online users can remain logged on but must
not access the online facility while the size of the CONTROL-M
Resources file is being changed.

A sample JCL to execute the utility can be found in member CTMCRES in

the CONTROL-M JCL library.

Parameters and DDNAMEs

The utility accepts one parameter using PARM of the EXEC statement, as
follows:
Table 3-25

CTMCRES Parameters

Parameter

Description

COPY

Copy an existing file to a new (larger) file.

CONVERT

Convert an old IOA Conditions/Resources file from version 5.x.xx

to the version 6.0.00 new CONTROL-M Resources file.

The following DD statements must be changed to correctly point to the old

and new files:
Table 3-26

CTMCRES Statements

Statement

Description

DAOLDRES

Name of the source CONTROL-M Resource file, or the old IOA

Conditions/Resources file.

DARESF

Name of the new CONTROL-M Resources file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-57

CTMCRES Copy or Resize the CONTROL-M Resource File

How to change the size of a CONTROL-M Resources file

To change the size of an existing CONTROL-M Resources file perform the
following steps:
1. Enter the ICE CUSTOMIZE activity for product ID CTM.
2. Select major step Customize CONTROL-M Dataset Parameters, and
then minor step CONTROL-M Datasets Parameters.
3. Change parameters RESBQNT#, RESQNT# and/or RESCNTL#
(depending on which part of the file is enlarged), and exit the step. For
more information about these parameters, see the CONTROL-M chapter
in the INCONTROL for OS/390 and z/OS Installation Guide.
4. Perform step Save Parameters into Product Libraries.
5. Perform step Format the Resource File and submit the job. This job
allocates and formats a new CONTROL-M Resources file (make sure
you use a different name for the newly-formatted file that the
DD statement DARESF points to).
6. Run utility CTMCRES, specifying the original CONTROL-M Resources
file in DD statement DAOLDRES and the newly-created CONTROL-M
Resources file in DD statement DARESF. This utility copies the original
CONTROL-M Resources file to the new file.
7. Rename the original CONTROL-M Resources file using any new name,
and then rename the new CONTROL-M Resources file to the original file
name.
8. Resume all activities that use the new file (that is, start CONTROL-M
monitor, reenter the OA online environment, and so on.)

Return Codes
Table 3-27

CTMCRES Return Codes

Code

Description

Operation performed successfully

8 and above

Operation failed, see message in the job

BMC Software, Inc., Confidential and Proprietary Information

3-58

INCONTROL for OS/390 and z/OS Utilities Guide

CTMHCLN Maintain the History Jobs File

CTMHCLN Maintain the History Jobs File

Utility CTMHCLN performs special maintenance functions on the History
Jobs file. The operator is warned in advance when the file is nearly full. The
operator can use utility CTMHCLN to delete entries from the Status screen.

SELECT/IGNORE Statements
The utility receives parameters in the form of SELECT/IGNORE statements
that designate the required function, using DD statement DAFRMIN (or
SYSIN). They identify jobs that are deleted or not deleted, as follows:
Table 3-28

CTMHCLN SELECT/IGNORE Statements

Statement

Description

IGNORE statements

Identify jobs that are not deleted.

SELECT statements

Identify jobs that are deleted.

Note:

The default action of utility CTMHCLN is to delete jobs in the

History Jobs file based on their retention criteria. To override this
default use the SELECT/IGNORE statements.

Up to 500 SELECT/IGNORE statements can be specified. Jobs are handled

according to the first statement for which the criteria are met.
One or more of the parameters described in Table 3-29 can be specified in
any SELECT/IGNORE statement (in any order).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-59

CTMHCLN Maintain the History Jobs File

Table 3-29

CTMHCLN SELECT/IGNORE Parameters

Parameter

Description

GROUP
groupname

Name of the group appearing in the job scheduling definition.

JOBNAME
jname or
MEMBER
memname

jnameName of the job appearing in both the JOB statement

and the JOBNAME field of the Status screen.
memnameName of the JCL member (specified in the
MEMNAME field in the job scheduling definition).
jname or memname (but not both) can be specified in one
statement.

STATUS status

Valid values are:

ACTIVE
Note: ACTIVE status includes all statuses except WAITSCHED,
ENDOK and ENDNOTOK. This status enables the user to select
or ignore jobs that are in ACTIVE status.

ENDOK
ENDNOTOK
HELD
WAITSCHED

GRP-ACTIVE

(This status means that at least one job in the group has not
completed processing.)

FROM date

Starting ODATE in yymmdd format.

TO date

Ending ODATE in yymmdd format.

Note:

A prefix can be specified instead of a full group name, job name or

member name by placing an asterisk (*) at the end of the string (for
example, PROD*).

Specifying AutoEdit Variables and Functions

AutoEdit variables can be specified for any of the above parameters. These
variables are especially useful for specifying relative date ranges in the
FROM and TO parameters.
AutoEdit functions can be used to set variables and these variables can then
be used in the parameters of the utility. The lines in which the variables are
set must have an asterisk (*) in the first column of the line. Such lines are
resolved by the AutoEdit facility and are interpreted as comments by the
utility. Regular comments can also be specified in lines with an asterisk in the
first column.
Note:

The following AutoEdit terms cannot be used in the input for this
utility: %%ODATE, %%OYEAR, %%OMONTH, %%ODAY, %%OWDAY,
%%INCLIB, and %%INCMEM.

BMC Software, Inc., Confidential and Proprietary Information

3-60

INCONTROL for OS/390 and z/OS Utilities Guide

CTMHCLN Maintain the History Jobs File

Activating the utility

A sample job to activate the utility can be found in member CTMHCLN in
the CONTROL-M JCL library.

Return Codes
Table 3-30

CTMHCLN Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Example
Delete jobs belonging to group G1, G2 and G3 regardless of their retention
criteria and process all other jobs according to their retention criteria.
SELECT GROUP G1
SELECT GROUP G2
SELECT GROUP G3

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-61

CTMHCOP Copy or Expand History Jobs File

CTMHCOP Copy or Expand History Jobs File

Utility CTMHCOP copies the History Jobs file to a new History Jobs file.
The utility can be used to change the size of the file by copying the file to a
different size file.

Statements and Parameters

The utility receives a parameter, which designates the required function,
using DD statement DACOPPRM (or SYSIN). The following function can be
requested:
Table 3-31

CTMHCOP Parameter

Parameter

Description

COPY

Copy the History Jobs file to a different file, either the same size
or a larger file.

File Statements
File statements are mandatory for the COPY function. OLDHST and
NEWHST statements must be specified as follows:
Table 3-32

CTMHCOP File Statements

Statement

Description

OLDHST

Name of the old History Jobs file. If omitted, the current HST file
is used.

NEWHST

Name of the new History Jobs file.

BMC Software, Inc., Confidential and Proprietary Information

3-62

INCONTROL for OS/390 and z/OS Utilities Guide

CTMHCOP Copy or Expand History Jobs File

Changing the Size of the History Jobs File

Note:

Online users must not access the CONTROL-M History

Environment screen in the IOA Online facility while the size of the
History Jobs file is being changed.

To change the size of the CONTROL-M History Jobs file, perform the
following steps:
1. Enter CUSTOMIZE facility under ICE for product ID CTM.
2. Select Customize CONTROL-M Dataset Parameters.
3. Select step CONTROL-M Dataset Parameters, update the HSTSIZE
parameter, and exit the step.
4. Select step 3, Save Parameters into Product Libraries.
5. Select step 7, Format the History Jobs File, and reply Y (Yes) when
asked to replace existing copy.
6. Edit member FORMHST, changing the dsname, unit, and volser as
required and run the job.
7. Run utility CTMHCOP. The utility copies the current History Jobs file to
new History Jobs file.
8. Rename the old History Jobs file.
9. Rename the new History Active Jobs file to the former name of the old
file.

Activating the COPY Function

A sample job to activate the utility can be found in member CTMHCOP in
the CONTROL-M JCL library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-63

CTMHCOP Copy or Expand History Jobs File

Return Codes
Table 3-33

CTMHCOP Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

3-64

INCONTROL for OS/390 and z/OS Utilities Guide

CTMJOB Order Jobs to the Active Jobs File

CTMJOB Order Jobs to the Active Jobs File

The CTMJOB utility is a job ordering utility that can be invoked from a job
step or by calling the program from a TSO environment and/or application
program, such as batch or CICS.
Job ordering instructions are passed to CTMJOB using one of the following:

DD statement DAJOB.
When ordering jobs using DD statement DAJOB, job orders can be
specified either:
by concatenating scheduling tables in the JCL (Method 1)
This method requires that the user specify the name of a scheduling
table and library directly in the JCL, in the format
DSN=sched_library(table)

For example:
Figure 3-15

//DAJOB
//
//

DD Statement DAJOB Method 1 Example

DD
DD
DD

DISP=SHR,DSN=sched_library(table1)
DISP=SHR,DSN=sched_library(table2)
DISP=SHR,DSN=sched_library(table3)

or
as ORDER control statements (Method 2)
Figure 3-16

//DAJOB

DD Statement DAJOB Method 2, Example 1

DD

DISP=SHR,DSN=parm_library(member)

where member contains ORDER, SELECT, IGNORE statements.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-65

CTMJOB Order Jobs to the Active Jobs File

Figure 3-17

//DAJOB
ORDER .
[SELECT
[IGNORE
.
.
.

DD Statement DAJOB Method 2, Example 2

DD *
. .
TAG tagname1]
TAG tagname2]

The format of the these statements is described in Format of the

ORDER, SELECT, and IGNORE Statements on page 3-67.
Method 2 provides the following advantages over Method 1:
Changes required can be made to the member in the PARM
library without changing the JCL.
Individual jobs can be specified.
An entire library can be specified in one order statement.

PARM parameter in an EXEC statement in the JCL. This method can

only be used to order a single table or job. For more information, see
Activating the Utility on page 3-9.

By default, the CTMJOB utility stops running when a User Daily job
discovers an error in one of the job scheduling definitions. Alternately, if
your INCONTROL administrator sets the CNTERCRD parameter to Y (Yes)
in the CTMPARM member of the IOA PARM library, the CTMJOB utility
continues processing job scheduling definitions after an error occurs. In
either case, the message JOB536S is issued. If the job scheduling definition
that contains an error belongs to a Group entity or to a job belonging to a
Group, and the processing continues, the utility skips the entire group and
continue processing the next job or group.
The CTMJOB utility can also be used to order scheduling tables with a
particular ODATE (for example, to emulate a User Daily job with a specific
date) by setting the target date to the desired ODATE for the jobs to be
ordered. All other dates must be set for one day earlier. For more information
about scheduling tables with a particular ODATE, see the discussion of
alternative methods of job ordering in the CONTROL-M chapter in the
INCONTROL for OS/390 and z/OS Administrator Guide.

BMC Software, Inc., Confidential and Proprietary Information

3-66

INCONTROL for OS/390 and z/OS Utilities Guide

CTMJOB Order Jobs to the Active Jobs File

Example
The following example shows how the DATEREC file (pointed to by
DD statement DACHK) orders jobs with an ODATE of March 21, 2000
(using MDY format).
032100

032000

032000

032000

032000

032000

Format of the ORDER, SELECT, and IGNORE Statements

ORDER, SELECT and IGNORE statements must be in the following format:
ORDER{DSN=schedlib|DDNAME=dd|DD=dd},{MEMBER=table|MEM=table}[,JOB=jobnm]
[,ODATE=date|DATE=date][,ODATEOPT={VALUE|VAL|RUN}][,FORCE]
[,INTOGRP=group rba],[DUP/NODUP],[NEWG]
[SELECT TAG tagname1]
[IGNORE TAG tagname2]

To order an entire library with one order statement use the following format:
ORDER DSN=sched.library MEMBER=*

At least one ORDER statement must be specified. SELECT and IGNORE

statements are optional. Multiple statements of each type are permitted.
An ORDER statement can be written from column 1 through column 72 only.
If you try to continue beyond column 72, the CTMJOB utility fails and the
error message JOBL34E is issued. If you want to use a very long ORDER
statement, insert a minus sign (-) preceded by a space at the end of the line,
before you reach column 72, and continue the statement on the next line. If
you do so, the program will treat the contents of the two lines as one long
line.
For example, the following would be treated as one line:
ORDER DSNAME=long_dataset_name, MEMBER=member_name

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-67

CTMJOB Order Jobs to the Active Jobs File

Parameters
Table 3-34

CTMJOB Parameters (Part 1 of 2)

Parameter Syntax

Description

ORDER

Indicates a specific table member (or job) to be ordered.

DSN=schedlib

Specifies the name of the scheduling library. You must specify

either this parameter or parameter DDNAME, but not both.

DDNAME=dd | DD=dd

Specifies a preallocated DD name that points to the scheduling

library. You must specify either this parameter or parameter DSN,
but not both.

MEMBER={table | *} | MEM={table | *}

Specifies the name of the scheduling table that contains the job
scheduling definitions. If an asterisk (*) is specified, all tables in the
library are processed. Mandatory.

JOB{jobnm | *}

Specifies the name of a job scheduling definition in the scheduling

table. Optional. If a job name is not specified, or if an asterisk (*) is
specified, the entire table is processed.

ODATE={date | ODATE | DATE} |

DATE={date |ODATE | DATE}

Specifies the order date of the jobs in the table, in mmddyy,

ddmmyy, or yymmdd format, depending on the site standard. This
parameter overrides the checkpoint date specified in DD statement
DACHK. Optional.
The default is the date from the checkpoint record. However, if it is
run with PARM or from an application program, the DATEREC
(DACHK) is ignored and the default is the current CONTROL-M
working date. Valid values:
date specific order date in mmddyy, ddmmyy, or yymmdd
format, depending on the site standard
ODATE CONTROL-M working date
DATE system date

ODATEOPT
or ODOPT

Whether to wait for a specific date, or process the Order or Force

request immediately.
Valid values are:
VALUE or VAL The Order or Force request is processed
immediately. Default.
RUN The Order or Force request is not executed before the
date set in the ODATE field, even if all required conditions and
resources are available.

INTOGRP=group_rba

Dynamically inserts a job into a group, where group_rba is the RBA

of a group which was already ordered and exists in the Active Jobs
File.
You must also use the JOB parameter of the ORDER statement to
identify the job you wish to insert into the group.
Before performing the insertion, CTMJOB checks that the job
specified in the ORDER statement belongs to the group entity
specified in the RBA. It is not possible to insert a job into a group
entity to which it does not belong.
The insertion is done as a FORCE, that is, the scheduling criteria of
the job are not checked before it is inserted.
Even though a job may already have been ordered, it can be
inserted again, as a duplicate, by means of the DUP parameter.

DUP | NODUP

DUP allows, and NODUP prohibits, the dynamic insertion of

duplicate jobs, that is of jobs that already exist in the group.

BMC Software, Inc., Confidential and Proprietary Information

3-68

INCONTROL for OS/390 and z/OS Utilities Guide

CTMJOB Order Jobs to the Active Jobs File

Table 3-34

CTMJOB Parameters (Part 2 of 2)

Parameter Syntax

Description

NEWG

Orders a new group entity together with the job that was specified
in the JOB parameter.

FORCE

Places the job order in the Active Jobs file regardless of the jobs
Basic Scheduling parameters. Optional.

SELECT TAG tagname

and
IGNORE TAG tagname

Specify Schedule Tags whose associated jobs are either ordered or

not ordered. A Schedule Tag is a set of Basic Scheduling criteria
specified in a Group Entity that is used to schedule specific jobs in
the Group Definition table. For more information, see the Job
Production parameters chapter in the CONTROL-M for OS/390 and
z/OS User Guide.
SELECT TAG or IGNORE TAG statements can be specified only
if the table specified in the preceding ORDER statement is a
Group Scheduling table.
SELECT TAG statements indicate Schedule Tags to be used to
select jobs to be ordered.
IGNORE TAG statements indicate Schedule Tags to be used to
prevent jobs from being ordered.
Each SELECT TAG statement or IGNORE TAG statement must
appear on a separate line.
Each block of SELECT TAG or IGNORE TAG statements must be
preceded by an ORDER statement.
An asterisk (*) can be included as a masking character for the
suffix of the Schedule Tag name, or for the entire Schedule tag
name. For more information about character masking, see the
online facilities chapter in the CONTROL-M for OS/390 and z/OS
User Guide.
Any number of SELECT TAG and IGNORE TAG statements can
be specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-69

CTMJOB Order Jobs to the Active Jobs File

SELECT and IGNORE TAG Logic

By default, all Schedule Tags for the Group Entity in the specified Group
Scheduling table are examined for scheduling eligibility. Therefore, to ignore
specific Schedule Tags and select all others, you need only specify the
appropriate IGNORE TAG statement. For an illustration, see Example 1 in
the topic SELECT and IGNORE TAG Examples on page 3-71.
If a Schedule Tag name matches more than one SELECT TAG or
IGNORE TAG statement, the first statement that matches the Schedule Tag
name is applied.
To select specific Schedule Tags and ignore all others, first indicate the
specific Schedule Tags to be selected in SELECT TAG statements and then
specify a generic IGNORE TAG statement as the last statement in that
SELECT TAG or IGNORE TAG block. For an illustration, see Example 2 in
the topic SELECT and IGNORE TAG Examples on page 3-71.
The scheduling of specific jobs depends on whether optional keyword
FORCE is specified in the preceding ORDER statement:

If FORCE is not specified, Schedule Tags specified in an IGNORE TAG

statement are treated as if their basic scheduling criteria are not satisfied,
that is, no jobs are scheduled according to these tags.
A job is scheduled when either of the following is true for the scheduling
definition of the job:
O (Or) is specified for parameter RELATIONSHIP; and the basic
scheduling criteria and/or the scheduling criteria of a selected
Schedule Tag associated with the job are satisfied.
A (And) is specified for parameter RELATIONSHIP; and both the
basic scheduling criteria and the criteria of a selected Schedule Tag
are satisfied.
Note:

If no Schedule tag is specified for a job, the scheduling of that

job is dependent only on the basic scheduling criteria of the job.

If FORCE is specified, a job is scheduled if either of the following

conditions exists:
At least one of the selected Schedule Tags is associated with the job.
or
No Schedule Tags were specified in the job scheduling definition.

BMC Software, Inc., Confidential and Proprietary Information

3-70

INCONTROL for OS/390 and z/OS Utilities Guide

CTMJOB Order Jobs to the Active Jobs File

SELECT and IGNORE TAG Examples

Example 1
ORDER DSN=mylib,MEMBER=sample
IGNORE TAG ACCT*

Ignores all Schedule Tags with a prefix of ACCT. All other Schedule Tags are
automatically selected.

Example 2
ORDER DSN=mylib,MEMBER=sample
SELECT TAG ACCT1
SELECT TAG ACCT2
IGNORE TAG *

Selects only Scheduled tags ACCT1 and ACCT2 and ignores all others.

Activating the Utility

Figure 3-18

CTMJOB Activation

//S1 EXEC
//STEPLIB
//DAPARM
//
//DAALOCIN
//DACHK
//SYSPRINT
//DAJOB

PGM=CTMJOB[,PARM=parameters]
DD DISP=SHR,DSN=ioa.loadlib
DD DISP=SHR,DSN=IOA.Vxxx.PARM
DD DISP=SHR,DSN=IOA.Vxxx.IOAENV
DD DISP=SHR,DSN=ioa.v600.IOAENV(ALCMJOBP)
DD DISP=SHR,DSN=ctm.daterec
DD message file
DD scheduling tables or ORDER statements

Note the following:

DD statement STEPLIB is only necessary if the CTMJOB utility does

not reside in a system link-listed library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-71

CTMJOB Order Jobs to the Active Jobs File

DD statement DACHK, which references the Date Control record, is

described in detail in Implementing New Day Processing in the
CONTROL-M chapter in the INCONTROL for OS/390 and z/OS
Administrator Guide.
Note:

When activating the utility, parameter PARM with a value of

NODACHK can be specified in the EXEC statement. When
PARM is set to NODACHK, the Date Control record is ignored,
and DD statement DACHK is unnecessary.

The file referenced by DD statement SYSPRINT holds all messages

produced by the utility. This file can alternatively be specified as a
dataset or a system print file (sysout).

DD statement DAJOB is described in detail on page 3-65.

The following example shows how to specify job order statements using
the PARM statement in the EXEC statement:

Examples

//ORDERJOB EXEC
PGM=CTMJOB,
//
PARM=ORDER DSN=IOA.PROD.SCHEDULE TABLE=TABLE1 JOB=SORT ODATE=070700

To invoke CTMJOB from an Assembler program, specify the call as

shown below:

CALL

CTMJOB,(JOBPARM),VL
.
.
JOBPARM DC
Y(LORDERREQ)
ORDERREQ DC
CORDER DSN=IOA.PROD.SCHEDULE TABLE=TABLE1 JOB=SORT DATE=070700

To invoke utility CTMJOB from TSO, issue the following command:

CALL ioa.prod.load(CTMJOB) ORDER DSN=IOA.PROD.SCHEDULE TABLE=TABLE1

JOB=SORT,DATE=070700

The following example shows how to specify job order statements using
DD statement DAJOB.

//ORDERJOB EXEC PGM=CTMJOB

//ORDERDD DD
DSN=IOA.PROD.SCHEDULE DISP=SHR
//DAJOB
DD
*
ORDER DDNAME=ORDERDD MEMBER=TABLE1 FORCE
ORDER DDNAME=ORDERDD MEMBER=TABLE2
ORDER DDNAME=ORDERDD MEMBER=TABLE3 JOB=JOB1
. . .
//

BMC Software, Inc., Confidential and Proprietary Information

3-72

INCONTROL for OS/390 and z/OS Utilities Guide

CTMJOB Order Jobs to the Active Jobs File

To invoke utility CTMJOB from a CICS application, parameters are

passed to the API CTMCIOR using a COMMAREA described by the
DSECT CTMCIAOR. The API and DSECT can be found in the IOA
CICSSAMP library. Program CTMCIOR passes the parameters to utility
CTMJOB.

The following example shows how the API is called from a CICS
application using fields defined in the DSECT.

Figure 3-19

CTMJOB Example

PARMAREA DS
PARMARLN EQU
MVC
MVC
MVC
MVC
EXEC

DSNAME
TBLNAME
JOBNAME
DATE

(CMORDLEN)C
*-PARMAREA
CMORDDSN,DSNAME
PARAMETERS
CMORDTBL,TBLNAME
CMORDJOB,JOBNAME
CMORDDAT,DATE
CICS LINK PROGRAM (CTMCIOR)
COMMAREA (PARMAREA)
LENGTH (=Y(PARMARLN))
. . .
DC
CL44CTM.PROD.SCHEDULE
DC
CL8DEFSCHD1
DC
CL8JOBA
DC
CL6090600

*
*

Return Codes
Table 3-35

Utility CTMJOB Return Codes

Code

Description

Operation performed successfully

At least one job was not ordered because of: missing calendar,
PREV or NEXT date conditions missing, Exit1 cancelled the
order, or no job orders were requested

8 and above

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-73

CTMJSA Job Statistics Accumulation

CTMJSA Job Statistics Accumulation

Utility CTMJSA is used to keep the Statistics file up to date. The utility
scans the IOA Log file for message SPY281I. If the parameter AUTOTAPE
in member CTMPARM in IOA PARM library is set to Y (Yes), the
Automatic Tape Drive Quantity Adjustment feature is activated and the utility
additionally scans the IOA Log file for message SPY28GI. Messages
SPY281I and SPY28GI contain information that is used to update the
Statistics file. The utility updates the Statistics file for every job that ended
OK within a specified date range.
Statistical records can optionally be deleted from the Statistics file. Refer to
parameter CLEANUP in Table 3-36, CTMJSA Parameters, on page 75.
A number of features that significantly improve production handling and
flow rely on the data in the Statistics file. Therefore, it is important to keep
this data as up to date as possible. It is recommended that utility CTMJSA be
run once a day during New Day processing before production jobs are
ordered.
CONTROL-M accumulates data for up to 20 successful runs of each job.
Statistical data is not accumulated in the following cases:

The job finished with a status of NOTOK.

The job was queued for re-execution by command $EJ.
For jobs rerun using a DO RERUN statement, statistics are not
accumulated for any but the last job run.

When the accumulation of statistical information has been properly

automated, the information can be effectively used for the following facilities
and reports:

Simulation and forecasting

Automatic Tape Drive Resource adjustment
Deadline scheduling
CONTROL-M/Enterprise Manager live simulation
SHOUT processing that uses job elapsed times (EXECTIME)
QUIESCE facility (planned shutdown)

BMC Software, Inc., Confidential and Proprietary Information

3-74

INCONTROL for OS/390 and z/OS Utilities Guide

CTMJSA Job Statistics Accumulation

Parameters
The following parameters can be specified for the CTMJSA utility:
Table 3-36

CTMJSA Parameters

Parameter

Description

ODATE

Date reference for use by the FROMDATE or TODATE

parameter, or both. Mandatory if a relative date is specified for
either of these parameters; otherwise, optional.
The date specified for this parameter can be a specific date (in
mmddyy, ddmmyy, or yymmdd format, depending on the site
standard) or an AutoEdit variable that resolves to a specific date.

Note: You must specify either the FROMDATE and TODATE pair of parameters, or
the CLEANUP parameter.
FROMDATE

Date from which to accumulate statistical data from the IOA Log
file. Mandatory if the TODATE parameter is specified.
The date can be a specific date (in mmddyy, ddmmyy or yymmdd
format, depending on the site standard), or a relative negative
number (including 0) of days from the date specified in
parameter ODATE.

TODATE

Date until which to accumulate statistical data from the IOA Log
file. Mandatory if the FROMDATE parameter is specified.
The date can be a specific date (in mmddyy, ddmmyy or yymmdd
format, depending on the site standard), or a relative negative
number (including 0) of days from the date specified in
parameter ODATE.

CLEANUP

Date from which to keep records. Records that have not been
updated on or after the specified date are deleted from the
Statistics file.
The date specified for this parameter can be a specific date (in
mmddyy, ddmmyy, or yymmdd format, depending on the site
standard) or an AutoEdit variable that resolves to a specific date.

Activating the Utility

BMC Software recommends that the CTMJSA utility be activated daily. A
sample job can be found in member CTMJSA in the CONTROL-M JCL
library. The following example illustrates the accumulation of statistics for a
single day:
//DAJSAIN DD *
ODATE %%OMONTH.%%ODAY.%%OYEAR
FROMDATE -3
TODATE -1
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-75

CTMJSA Job Statistics Accumulation

The statistical accumulation for the above example always works on jobs that
have executed from three days ago until the day before today. The same jobs
data is not accumulated twice.
Note:

The above sample job contains AutoEdit variables and must

therefore be submitted directly by CONTROL-M.

At most sites, the CLEANUP parameter is specified only occasionally to

delete inactive records from the Statistics file. The following sysout
illustrates a run of utility CTMJSA during which entries were removed from
the Statistics file because a date was specified for parameter CLEANUP.
CLEANUP 010600
09.43.56
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57
09.43.57

JSA921I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA909I
JSA922I

ACCUMULATION
JOB @BR14
JOB CTMJSA
JOB IEBGEN
JOB IEFBR14
JOB ISRA2MEM
JOB JOBA
JOB JSA514
JOB NJER
JOB QM12A
JOB QM17D
JOB RUNCTMJS
JOB TAPE22
ACCUMULATION

OF JOB EXECUTION STATISTICS STARTED

GROUP
DATE 220500 WAS
GROUP
DATE 140500 WAS
GROUP
DATE 100500 WAS
GROUP
DATE 090500 WAS
GROUP
DATE 090500 WAS
GROUP
DATE 090500 WAS
GROUP
DATE 220500 WAS
GROUP
DATE 110500 WAS
GROUP
DATE 090500 WAS
GROUP THEQMGRP
DATE 010500 WAS
GROUP
DATE 090500 WAS
GROUP
DATE 220500 WAS
OF JOB EXECUTION STATISTICS ENDED WELL

REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED
REMOVED

BMC Software, Inc., Confidential and Proprietary Information

3-76

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRAFL Produce Active Jobs File Job Flow Report

CTMRAFL Produce Active Jobs File Job Flow

Report
Utility CTMRAFL provides job flow information about the jobs in the Active
Jobs file. Information is sorted and presented in execution order by group.
A similar utility, CTMRFLW, is also provided. In most respects, CTMRAFL
and CTMRFLW are identical:

Both CTMRAFL and CTMRFLW provide a Job Flow report and a Cross
Reference.

The two reports use virtually the same parameters.

The reports have almost identical report output (in text format).

The basic differences between the report outputs of utilities CTMRAFL and
CTMRFLW are

Report CTMRFLW provides information about jobs in scheduling tables,

report CTMRAFL provides information about jobs in the Active Jobs
file.

Report CTMRAFL does not accept SYSIN report parameters.

Report CTMRAFL provides the Job Flow report in text format only;
therefore the graphic format parameters of report CTMRFLW do not
apply to report CTMRAFL.

In CTMRAFL, original scheduling date (ODATE) information (from the

Active Jobs file) is provided in the report output. In CTMRFLW, other
scheduling information extracted from the job scheduling definitions
(TYP, CALENDR, scheduling data) is provided.

Activating the Utility

To activate the utility, use the sample job found in member CTMRAFL in the
CONTROL-M JCL library. For more details, see CTMRFLW Produce a
Scheduling Table Job Flow Report on page 3-85.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-77

CTMRCAL Create a Calendar Using the Job Plan Report

CTMRCAL Create a Calendar Using the Job Plan

Report
This utility creates calendars that contain all the dates on which the job is
scheduled to execute. The calendars are based on the Job Plan report
produced by utility CTMRPLN.
The name of the calendar created for each job scheduling definition is the
name of the job in parameter MEMNAME. This calendar is completely valid
for all purposes. It can be viewed using Option 8 (Calendars) of the IOA
Primary Option menu and it can be used by any CONTROL-M or IOA utility.
The utility is composed of two steps:

The first step produces the regular CTMRPLN report. For more details
about this report, see CTMRPLN Job Plan Report on page 3-106.

The second step produces calendars for the job schedules analyzed by the
first step. The calendars are written to the library referenced by
DD statement DACAL (of the second step). The sample utility is
supplied with the library prefix.version.CALJOB, which is not
automatically allocated during CONTROL-M installation.

If multiple jobs exist with the same name, each job causes the program to
assign a unique calendar name. To maintain cross-references between job and
calendar names, a DAXREF file is created that cross-references every
calendar to its corresponding job name.
When PARM=MERGE is specified in the JCL EXEC statement of the
second step, jobs with the same name create only one calendar containing all
schedule days merged from all jobs with the same name.
When PARM=REPLACE is specified in the JCL EXEC statement of the
second step, jobs with the same name cause any pre-existing calendars with
that name to be replaced.

Parameters
The parameters for the first step of the utility are identical to the parameters
for utility CTMRPLN. For more information on these parameters, see
CTMRPLN Job Plan Report on page 3-106.
Note:

For parameter REPTYPE, only report types 0S, 1S, and 2S are valid
for use in this utility.

BMC Software, Inc., Confidential and Proprietary Information

3-78

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRCAL Create a Calendar Using the Job Plan Report

Activating the Utility (and Example)

The utility can be activated for one or many scheduling tables (concatenated
to DD statement DAPLNJOB). CTMRPLN treats all scheduling table entries
with the same job name and group name as a single job, and outputs one line
containing all the dates that the job can run.
A sample job to activate the utility can be found in the CTMRCAL member
in the CONTROL-M JCL library.

Return Codes
Table 3-37

CTMRCAL Return Codes

Code

Description

Operation performed successfully

Other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-79

CTMRELRS Release Resources

CTMRELRS Release Resources

This utility releases (deallocates) Quantitative or Control resources that are
allocated to, but no longer needed by, a job that is still executing.
The utility can be used only for jobs that are submitted by the CONTROL-M
monitor. It cannot be used for started tasks activated by the CONTROL-M
monitor. A job can only request the release of resources that are allocated to
it.
The utility is useful in situations in which resources used in the first steps of
the job are not needed in later steps of the job. If the utility is not used, the
resources are released or deleted only at the end of the job. Alternatively,
such resources could be released or deleted by dividing the job into two jobs.
After the appropriate step, the utility notifies CONTROL-M that the resource
is not needed so CONTROL-M can use the resource for other jobs. The
release is recorded in the following ways: in the jobs sysout as a message, on
the operator console, and as an event in the IOA Log file.
If it is necessary to release or delete resources during a job step, CTMRLR
can also be called as a program from within the application program. For
more information, see Examples of Activating the Utility on page 3-82.
Note:

The Simulation and Forecasting facility does not use this utility;
instead it releases the resources only at the end of job execution.
Therefore, actual production results may be better than the
simulation results.
If the CONTROL-M Resources file is shared across multiple CPUs,
use an enqueue manager (such as MIM or GRS) to prevent
simultaneous update of the file. For more information, see the
description of the QNAME and SHRQNAM parameters in the IOA
installation chapter of the INCONTROL for OS/390 and z/OS
Installation Guide.

BMC Software, Inc., Confidential and Proprietary Information

3-80

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRELRS Release Resources

Parameters
Parameters can be received by the utility in two ways: using DD statement
DARELIN (or SYSIN) or using PARM=...
Multiple commands can be specified in the same control statement.
Parameters can be specified in either of the following formats:
RELEASE RESOURCE res-name-1 quant-1; res-name2 quant-2; ...

or
CHANGE RESOURCE res-name-1 quant-1; res-name-2 quant-2; ...

or
DELETE CONTROL cntl-res CONTROL-type

where:

res-name-n is the name of the Quantitative resource (20 characters

maximum).
quant-n is the value indicating a quantity (4 digits maximum).
cntl-res is the Control resource name (20 characters maximum).
control-type is the type of control. Valid values are
E Exclusive control
S Shared control

When the RELEASE format is used, the specified quantity is deducted from
the resources allocated to the job.
When the CHANGE format is used, the quantity of resources allocated to the
job is changed to the specified quantity.
When the DELETE format is used, the specified resource is deleted that is
under the specified type of control.

Example
Assume 10 initiators (INIT) are allocated to a job:

If RELEASE RESOURCE INIT 3 is specified, 7 initiators remain

allocated.

If CHANGE RESOURCE INIT 3 is specified, 3 initiators remain

allocated.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-81

CTMRELRS Release Resources

Examples of Activating the Utility

As a step in the job:

//REL EXEC CTMRELRS
RELEASE RESOURCE TAPE 1

From an application program:

Figure 3-20

PARMCOND
PARMCNDE
PARMCNDA

Note:

Utility CTMRELRS Example

LA
L
BALR
LTR
BNZ
...
DC
DC
EQU
DC

R1,PARMCNDA
R15,=V(CTMRLR)
R14,R15
R15,R15
ERROR
AL2(PARMCNDE-PARMCOND)
RELEASE RESOURCE ADABAS-POWER 0005
*
A(PARMCOND)

Program CTMRLR works in 24-bit addressing mode.

Return Codes
Table 3-38

Utility CTMRELRS Return Codes

Code

Description

Operation performed successfully.

Action could not be performed.

Syntax error in DARELIN input statement.

12

Fatal error. Program terminated.

other

Operation failed.

BMC Software, Inc., Confidential and Proprietary Information

3-82

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRES Allocate and Format the CONTROL-M Resources File

CTMRES Allocate and Format the CONTROL-M

Resources File
Utility CTMRES allocates and formats the CONTROL-M Resources file
(RES). Use this utility to enlarge the current CONTROL-M Resources file.
When you run these steps make sure that the CONTROL-M monitor is not
active, and that online users are not logged on to the IOA environment.

Activating the Utility

1. Enter the ICE CUSTOMIZATION activity for product ID CTM.
2. Select major step Customize CONTROL-M Dataset Parameters, and
then minor step CONTROL-M Datasets Parameters.
3. Change parameters RESBQNT#, RESQNT#, and RESCNTL# to the
values required in the new CONTROL-M Resources file.
4. Perform step Format the Resource File and submit the job. This step
allocates and formats the new CONTROL-M Resources file. Make sure
to use a different name for the newly formatted file.
5. Rename the original CONTROL-M Resources file, using any new name,
then rename the new CONTROL-M Resources file to the original file
name.
6. Resume all activities using the new file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-83

CTMRES Allocate and Format the CONTROL-M Resources File

Return Codes
Table 3-39

CTMRES Return Codes

Code

Description

Operation performed successfully

12

One of the following errors occurred:

IOAENV FAILED
PARAMETER 'CONTROL' - NUM OF CONTROL RECORDS EXCEEDS MAXIMUM
PARAMETER 'QUANT' - NUM OF QUANTITATIVE
RESOURCE RECORDS - EXCEEDS MAXIMUM
PARAMETER 'BASEQUANT' - NUM OF POSSIBLE
RESOURCE DEFINITIONS - EXCEEDS MAXIMUM
OPEN OF DARESF FILE FAILED
ONE OF THE PARAMETERS SUPPLIED CONTAINED
ILLEGAL CHARACTER
GETMAIN FAILED
ENQ FAILED

BMC Software, Inc., Confidential and Proprietary Information

3-84

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

CTMRFLW Produce a Scheduling Table Job Flow

Report
Utility CTMRFLW produces a report that provides job flow information
about jobs in scheduling tables.
The utility can generate two types of output:

Job Flow Report

This report displays the job dependencies of the jobs in the scheduling
tables. This output is always generated. Jobs are presented in order of
execution. The jobs can be sorted by group, in which case they are
presented in order of execution by group. This report can be generated in
the following formats:

Table 3-40

Format

Description

Text format

Report consists of printed text. This format is always generated.

Chart format

A graphic presentation of job dependencies (in addition to the

text format). Job flow is displayed from left to right in chart format
(that is, leftmost jobs are not dependent on other jobs). When
sorted by group, one group appears in each chart.

Note:

CTMRFLW Formats

The Job Flow chart can also be viewed online by specifying

option G (Graphic Jobflow) in the Table List screen in the
Scheduling Definition facility. For details, see Chapter 2, IOA
Utilities.

Cross Reference lists

Lists the conditions and resources added, deleted, and/or required by the
jobs in the tables. The following separate lists can be produced:
prerequisite conditions list
control resource list
quantitative resource list
The contents of each list are sorted alphabetically. The Cross Reference
lists can be useful for identifying various job requirements. For example:

Jobs that require more than three tape drives.

Jobs that require IMS to be active before they can be executed.
Jobs that update a particular VSAM file.
Job interdependency.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-85

CTMRFLW Produce a Scheduling Table Job Flow Report

By default, the number of lines in a report page is 60. This default can be
modified in the EXEC statement.
Furthermore, by default, all jobs in the scheduling tables are included in
the report. This default can be modified in the EXEC statement by
specifying a successor or a predecessor job:

If you specify a successor job, information is provided only for the

predecessor jobs leading up to that successor job.

If you specify a predecessor job, information is provided only for the

successor jobs that follow the predecessor job.

EXEC Statement Parameters

//CTMRFLW EXEC CTMRFLW[,]
[PARM=LINECNT=linecount[,SUCCESR=jobname|PREDESR=jobname]]

The following parameters can be included in the EXEC statement:

Table 3-41

CTMRFLW Parameters

Parameter

Description

LINECNT

Number of lines per report page. This parameter does not impact
the chart format. Default: 60.

SUCCESR

Name of the successor job. If specified, only predecessor jobs of

this job is included in the report. This parameter cannot be
specified if parameter PREDESR is specified.

PREDESR

Name of the predecessor job. If specified, only successor jobs of

this job is included in the report. This parameter cannot be
specified if parameter SUCCESR is specified.

BMC Software, Inc., Confidential and Proprietary Information

3-86

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

Report Parameters
Report parameters are optional. They are supplied using DD statement
DAFLWPRM (or SYSIN).
Table 3-42

CTMRFLW Report Parameters (Part 1 of 2)

Parameter

Description

JOBSDD ddname

DD name of the library. If specified, all members of the library are processed
by the utility (unless limited by the TABLES parameter). This makes it
unnecessary to specify a concatenation of DD statements (one statement for
each table) in the JCL.

GROUP [ALL|UNITED|
groupname]

Indicates which groups to include in the report, and the sort order of
information included. Valid values are:
ALL Sorts the jobs according to group as defined in parameter GROUP in
the job scheduling definitions. Jobs are displayed in order of execution within
each group. Default.
UNITED All jobs in the scheduling tables are considered as one group.
Jobs are displayed in order of execution.
Groupname Includes the jobs of only the groups specified. Up to 20
groups can be specified, each on a different GROUP line. Jobs are
displayed in order of execution within each group. Do not specify group
names if ALL or UNITED is specified.
Character masking of specified group names is supported, as follows:
? represents any one character.
* represents any number of characters (including no characters).

CONTROLO

If specified, utility CTMRFLW reads the CONTROL-O table specified in

DD statement DACTO. Utility CTMRFLW then marks all manual conditions
added by CONTROL-O rules with an asterisk (*), to distinguish them from
other manual conditions. If this parameter is not specified, the CONTROL-O
table is not read.

JOBFLOW
XREFCOND
REPORT
XREFCNTL
XREFQUANT

CHART [YES|NO]

Indicates the type of report to print. Each REPORT line can contain only one
report type, but multiple REPORT lines can be specified. If no REPORT lines
are specified, all report types are printed. Valid values:
JOBFLOW Job Flow report
XREFCOND Cross Reference list prerequisite conditions
XREFCNTL Cross Reference list control resources
XREFQUANT Cross Reference list quantitative resources

Indicates whether to print the Job Flow report in Graphic (chart) format. Valid
values are:
YES Produce a chart in addition to the Job Flow report.
NO Produce only the Job Flow report. Default.
Note: The following parameters apply only if CHART YES is specified (that is,
the chart is to be produced).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-87

CTMRFLW Produce a Scheduling Table Job Flow Report

Table 3-42

CTMRFLW Report Parameters (Part 2 of 2)

Parameter

Description

PRINTER [LASER|IMPACT]

Type of printer on which the chart is to be produced. Valid values are

LASER IBM 38xx laser printer or compatible only. Default.
IMPACT Any impact printer (1403, 3211, 3203, 3262, and so on).
Note: If you are using a laser printer but you specify the printer as IMPACT, the
report is printed to the laser printer, but no graphic features are printed.

FONT font_code

Valid only if PRINTER LASER is specified. FONT affects the quality and type
of drawing in the chart. Valid font codes:
1 Fine line.
2 Medium line. Default.
3 Heavy line.
4 Very small characters.
9 High quality IBM character set. This font is not available at all IBM sites.
Contact your IBM representative if you do not have this font.

LINESIZE col_num

Maximum number of columns in a line of the logical page, where col_no is a

multiple of 16, between 16 and 240. Default: 128.

MAXCARDS num_rcds

Maximum number of job scheduling definition records that can be processed.

This parameter is useful when processing large numbers of records. Maximum
limit: 9999999. Default: 96000.

PAGESIZE line_no

Maximum number of lines in a logical page, where line-no is a multiple of 4,

between 12 and 120. Default: 80.
Note: The logical PAGESIZE and LINESIZE must not exceed that of the
physical page. For best results, define the maximum PAGESIZE and LINESIZE
that the physical page can accommodate.

PAGESEQ [YES|NO]

A chart can exceed the physical page size of the paper in width and in length.
In such cases, the chart is printed on multiple pages of paper. Use the
PAGESEQ parameter to assist in placing the physical pages in order. Valid
values are:
YES Default: Page location is printed on the upper-right corner of the chart
in the format:

PAGE = xx,yy
where:
xx Positional page number from the left side of the chart
yy Positional page number from the top of the chart
Example
PAGE = 01,02 indicates that the current page is the first page from the left
and the second from the top.
NO Page location is not printed.
TABLES tbl1,tbl2,...

Tables to be processed within the library identified by parameter JOBSDD. If

parameter JOBSDD is specified without parameter TABLES, the entire library
is processed. Supports full masking. For information about character masking,
see Chapter 2, IOA Utilities.

BMC Software, Inc., Confidential and Proprietary Information

3-88

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

Example Chart Page Sequence

If a chart spans three pages in length and two pages in width, combine the
sequentially printed pages 1, 2, 3, 4, 5 and 6 in the following order:
1

A sample job can be found in member CTMRFLW in the CONTROL-M JCL

library.

Example JCLs for Text Format:

The following JCL produces a Job Flow report in text format:
//CTMRFLW
//DAJOB
//
//
//

EXEC
DD
DD
DD
DD

CTMRFLW
DISP=SHR,DSN=LIB(TABLE1)
DISP=SHR,DSN=LIB(TABLE2)
DISP=SHR,DSN=LIB(TABLE3)
DISP=SHR,DSN=LIB(TABLE4)
.
.

List of scheduling tables to be included in Job Flow report

.
.
//SYSIN DD
*
GROUP UNITED

The following sample JCLs produce a Job Flow report in chart (as well as
text) format.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-89

CTMRFLW Produce a Scheduling Table Job Flow Report

Example 1

Figure 3-21

//CTMRFLW
//DAJOB
//
//
//

CTMRFLW Example 1

EXEC
DD
DD
DD
DD

//DAFLWPRM DD
CHART YES
GROUP UNITED
PRINTER LASER
FONT 1
PAGESIZE 80
LINESIZE 160
//

CTMRFLW
DISP=SHR,DSN=LIB(TABLE1)
DISP=SHR,DSN=LIB(TABLE2)
DISP=SHR,DSN=LIB(TABLE3)
DISP=SHR,DSN=LIB(TABLE4)
.
.
.
*

Example 2

Figure 3-22

CTMRFLW Example 2

//CTMRFLW EXEC CTMRFLW

//ALLTBL
DD
DISP=SHR,DSN=LIB
//DAFLWPRM DD
*
JOBSDD ALLTBL
CHART YES
GROUP UNITED
PRINTER LASER
FONT 1
PAGESIZE 80
LINESIZE 160

BMC Software, Inc., Confidential and Proprietary Information

3-90

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

Figure 3-23

CTMRFLW Example of TABLES Format

//CTMRFLW EXEC CTMRFLW

//SCHEDLIB DD DISP=SHR,DSN=LIB
//DAFLWPRM DD *
PRINTER IMPACT
GROUP UNITED
JOBSDD SCHEDLIB
REPORT JOBFLOW
PREDESR DAT006V
TABLES GR,M71*
//

Sample Output Job Flow Report in Text Format

Figure 3-24 illustrates a sample Job Flow report in text format. A description
of the report fields follows.
Figure 3-24

CTMRFLW Sample Job Flow Report

PRODUCED BY CONTROL-M 6.0.00

GROUP
BMC SOFTWARE, INC.

JOBS FLOW REPORT - BY GROUP

DAILY-PROD-YH

===========================

LVL
MEMBER
DEPEND ON
DESCRIPTION
TYP CALENDR CMP,DAYS IN WEEK/MONTH GROUP DEPENDENT
MANUAL COND
TAPE
--------------------------------------------------------------------------------------+--------------------------------------------1 PRODYJCL
CREATE INPUT FILES # 2
M BANKDAYS
|
YH-INPUT-FILE-2-OK 0001
FROM 1700 UNTIL 0645 |
1 PRODYHC2
CREATE INPUT FILE # 2
M BANKDAYS
|
YH-INPUT-FILE-2-OK 0001
1 PROJYFOT
BEGIN OF EVENING PROCESS
M BANKDAYS
|
YH-START-EVENING-RUN
1 PROLYPAR
NIGHT INPUT COLLECTION # 1
M STOCKDAY
|
YH-NIGHT-INPUT-1-OK 0001
FROM 2300 UNTIL
|
1 PROLYPAG
NIGHT INPUT COLLECTION # 2
M DAYSOFF
|
YH-NIGHT-INPUT-2-OK 0001
FROM 2200 UNTIL
|
2 PRODYHTK PRODYJCL PROCESS INPUT DATA FOR
M BANKDAYS
|
PRODYHST
FROM 1000 UNTIL 1400 |
2 PRODYBCK PRODYHC2 PROCESS INPUT DATA FOR
M BANKDAYS
|
PRODYIDK
|
2 PROJYMRG PROJYFOT EVENING UPDATE PROCEDURE
M BANKDAYS
|
2 PROLYKLT PROLYPAR MERGE OF INPUT FILES
M BANKDAYS
|
0002
PROLYPAG
|
3 PRODYIDK PRODYBCK UPDATE # 1
M BANLDAYS
|
3 PROJYMTI PROJYMRG VERIFICATION PROCESS OF
M BANKDAYS
|
EVENING UPDATE
|
3 PROJYHO1 PROJYMRG SPECIAL CALCULATIONS FOR
M BANKDAYS
|
ACCOUNTING DEPARTMENT
|
3 PROJYDPY PROJYMRG UPDATE OF ON-LINE FILES
M BANKDAYS
|
3 PROLYUPD PROLYKLT NIGHT UPDATE PROCEDURE
M BANKDAYS
|
4 PRODYHST PRODYHTK UPDATE # 2
M BANKDAYS
|
PRODYIDK
FROM 1000 UNTIL 1445 |
4 PRODYIZN PRODYIDK REPORTS FOR BRANCH MANAGERS
M BANKDAYS
|
<+>4 PROJYHO2 PROJYHO1 REPORTS FOR ACCONTING
M-BANKDAYS
|
DEPARTMENT
|
4 PROJYDTK PROJYDPY REPORTS OF ON-LINE FILES
W BANKDAYS >1
|
4 PROJYDLI PROJYDPY CREATE DUAL ON-LINE FILE
W BANKDAYS >1<+>
|
4 PROLYMIZ PROLYUPD NIGHT UPDATE PROCEDURE - NEW M BANKDAYS
|
UPDATE
|
5 PRODYBTL PRODYHST REPORTS FOR BRANCHES
M BANKDAYS
|
FROM 1000 UNTIL 1445 |
5 PRODYEND PRODYIZN REPORTS FOR MAIN OFFICE
M BANKDAYS
|
5 PROYH11 PROJYDTK YH APPLICATION UPDATE
W BANKDAYS >1
|
PROJYDLI
|
5 PROLYBCK PROLYMIZ BACKUP MAIN FILE
M BANKDAYS
|
0001
5 PROLYFMZ PROLYMIZ REPORTS FOR MAIN OFFICE
M BANKDAYS L01
|

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-91

CTMRFLW Produce a Scheduling Table Job Flow Report

5
5
5
5

PROLYBCK
PROLYFMZ
PROLYBME
PROLYDM1

PROLYMIZ
PROLYMIZ
PROLYMIZ
PROLYMIZ

6 PROJYFIN PROJYDPY
6 PROLYDOC PROLYBCK
6 PROLYDEL PROLYFMZ
6 PROLYDM2 PROLYDM1
7 PROJYBNK PROJYFIN
8 PROJEND

PROJYBNK

BACKUP MAIN FILE

REPORTS FOR MAIN OFFICE
CREATE EXTERNAL TAPE
ARCHIVE YH APPLICATION DATA
SET #1
CLEAN-UP FOR YH APPLICATION
PROYH11
BACKUP FILES STATUS REPORTS
DELETE TEMPORARY "REPORT"
FILES
ARCHIVE YH APPLICATION DATA
SETS #2
VERIFICATION OF BRANCH
BALANCES
FINAL YH APPLICATION
PROCEDURE

M
M
M
M

BANKDAYS
BANKDAYS L01
BANKDAYS L01
BANKDAYS >01

M BANKDAYS
M BANKDAYS
M BANKDAYS L01
M BANKDAYS >01
M BANKDAYS
M BANKDAYS L01

|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|

0001
0001
0001

0001

Fields of the Job Flow Report in Text format

The following information is presented for each job in the Job Flow report.
Table 3-43

CTMRFLW Job Flow Report Fields

Field

Description

LVL

Submission level of the job in the group. For example, 1 first job
in the group, 2 a job that depends on one (or more) jobs in
Level 1, and so on.

MEMBER

The member name (from parameter MEMNAME).

DEPEND ON

The names of the members (jobs) in the group, which are

prerequisites for execution of the job.

DESCRIPTION

Short description of the job optionally supplied in the job

scheduling definition.

TYPa

Schedule type. possible values:

M By DAYS, MONTH and/or DCAL parameters.
W By WDAYS, MONTH and/or WCAL parameters.
D By the DATES parameter.
C By PDS and MINIMUM parameters.
F Confirmation by CONFCAL calendar.

CALENDR

Name of the calendar, if scheduled by a calendar.

scheduling
data

The days in the month, or the days of the week, or specific dates,
or the name of the library to be checked for free space. If a time
limit is specified for the job, that appears, as well.

GROUP
DEPENDENT

Prerequisite condition that is added (created) by a job belonging

to another group.

MANUAL
COND

Prerequisite conditions that are added manually (that is,

conditions that are not added automatically by any job analyzed
in the job flow).

TAPE

Quantity required for a Quantitative resource whose name starts

with TAPE.

M and W schedule types can be preceded by an AND sign (&) or an OR sign (|),
indicating AND/OR logic.

BMC Software, Inc., Confidential and Proprietary Information

3-92

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

Job flows that are cyclic can be defined to CONTROL-M. Since it is

impossible to determine which job in a cycle runs first, the Job Flow report
program makes an arbitrary decision where to break the cycle. The job
selected is marked by an asterisk (*) to the left of the member name, and a
warning message is issued.
Figure 3-25 on page 3-94 illustrates a sample output of a Job Flow report.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-93

CTMRFLW Produce a Scheduling Table Job Flow Report

Sample Job Flow Report Output in Graphic Format

Figure 3-25

CTMRFLW Job Flow Report Output

BMC Software, Inc., Confidential and Proprietary Information

3-94

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

Sample Prerequisite Condition Cross Reference List

Figure 3-26

CTMRFLW Sample Prerequisite Condition Cross Reference List

PRODUCED BY CONTROL-M 6.0.00

BMC SOFTWARE, INC.
.

CROSS REFERENCE LIST - PREREQUISITE CONDITIONS

==============================================

CONDITION
ODATE TYPE OPT
GROUP NAME
MEMBER
---------------------------------------------------------------------------------------+-----PROJ-FIN-MAY-GO
ODAT IN
DAILY-PROD-YH
PROJYFIN
PROJ-FIN-MAY-GO
ODAT OUT
+ DAILY-PROD-YH
PROYH11
PRCH-BCK-END
ODAT IN
DAILY-PROD-YH
PRODYIDK
PRCH-BCK-END
ODAT OUT
+ DAILY-PROD-YH
PRODYBCK
PRCH-BTL-END
ODAT OUT
+ DAILY-PROD-YH
PRODYBTL
PRCH-END-END
ODAT OUT
+ DAILY-PROD-YH
PRODYEND
PRCH-HTK-END
ODAT IN
DAILY-PROD-YH
PRODYHST
PRCH-HTK-END
ODAT OUT
+ DAILY-PROD-YH
PRODYHTK
PRCH-HTK-END
ODAT CODES + DAILY-PROD-YH
PRODYJCL
PRCH-IDK-END
ODAT IN
DAILY-PROD-YH
PRODYHST
PRCH-IDK-END
ODAT IN
DAILY-PROD-YH
PRODYIZN
PRCH-IDK-END
ODAT OUT
+ DAILY-PROD-YH
PRODYIDK
PRCH-IZN-END
ODAT IN
DAILY-PROD-YH
PRODYEND
PRCH-IZN-END
ODAT OUT
+ DAILY-PROD-YH
PRODYIZN
PRCH-JCL-END
ODAT IN
DAILY-PROD-YH
PRODYHTK
PRCH-JCL-END
ODAT OUT
+ DAILY-PROD-YH
PRODYJCL
JOBS-DHT-END
ODAT IN
DAILY-PROD-YH
PRODYBTL
JOBS-DHT-END
ODAT OUT
+ DAILY-PROD-YH
PRODYHST
JOBS-KLT-END
ODAT IN
DAILY-PROD-YH
PRODYBCK
JOBS-KLT-END
ODAT OUT
+ DAILY-PROD-YH
PRODYHC2
PROJ-BNK-END
ODAT IN
DAILY-PROD-YH
PROJEND
PROJ-BNK-END
ODAT OUT
+ DAILY-PROD-YH
PROJYBNK
PROJ-DLI-END
ODAT IN
DAILY-PROD-YH
PROYH11
PROJ-DLI-END
ODAT OUT
+ DAILY-PROD-YH
PROJYDLI
PROJ-DPY-END
ODAT IN
DAILY-PROD-YH
PROJYDTK
PROJ-DPY-END
ODAT IN
DAILY-PROD-YH
PROJYDLI
PROJ-DPY-END
ODAT IN
DAILY-PROD-YH
PROJYFIN
PROJ-DPY-END
ODAT OUT
+ DAILY-PROD-YH
PROJYDPY
PROJ-DTK-END
ODAT IN
DAILY-PROD-YH
PROYH11
PROJ-DTK-END
ODAT OUT
+ DAILY-PROD-YH
PROJYDTK
PROJ-FIN-END
ODAT IN
DAILY-PROD-YH
PROJYBNK
PROJ-FIN-END
ODAT OUT
+ DAILY-PROD-YH
PROJYFIN
PROJ-FOT-END
ODAT IN
DAILY-PROD-YH
PROJYMRG
PROJ-FOT-END
ODAT OUT
+ DAILY-PROD-YH
PROJYFOT
PROJ-HO1-END
ODAT IN
DAILY-PROD-YH
PROJYHO2
PROJ-HO1-END
ODAT OUT
+ DAILY-PROD-YH
PROJYHO1
PROJ-HO2-END
ODAT OUT
+ DAILY-PROD-YH
PROJYHO2
PROJ-MRG-END
ODAT IN
DAILY-PROD-YH
PROJYMTI
PROJ-MRG-END
ODAT IN
DAILY-PROD-YH
PROJYHO1
PROJ-MRG-END
ODAT IN
DAILY-PROD-YH
PROJYDPY
PROJ-MRG-END
ODAT OUT
+ DAILY-PROD-YH
PROJYMRG
PROJ-MTI-END
ODAT OUT
+ DAILY-PROD-YH
PROJYMTI
PROJ-RCV-UEGP
ODAT CODES + DAILY-PROD-YH
PROJYFOT
PRDL-BCK-END
ODAT IN
DAILY-PROD-YH
PROLYDOC
PRDL-BCK-END
ODAT OUT
+ DAILY-PROD-YH
PROLYBCK
PRDL-BME-END
ODAT OUT
+ DAILY-PROD-YH
PROLYBME
PRDL-DEL-END
ODAT OUT
+ DAILY-PROD-YH
PROLYDEL
PRDL-DMS-END
ODAT IN
DAILY-PROD-YH
PROLYDM2
PRDL-DMS-END
ODAT OUT
+ DAILY-PROD-YH
PROLYDM1
PRDL-DM2-END
ODAT OUT
+ DAILY-PROD-YH
PROLYDM2
PRDL-DOC-END
ODAT OUT
+ DAILY-PROD-YH
PROLYDOC
PRDL-FMZ-END
ODAT IN
DAILY-PROD-YH
PROLYDEL
PRDL-FMZ-END
ODAT OUT
+ DAILY-PROD-YH
PROLYFMZ

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-95

CTMRFLW Produce a Scheduling Table Job Flow Report

Sample Control Resources Cross Reference List

Figure 3-27

CTMRFLW Sample Control Resources Cross Reference List

PRODUCED BY CONTROL-M 6.0.00

BMC SOFTWARE, INC.

CROSS REFERENCE LIST - CONTROL RESOURCES

========================================

RESOURCE NAME
S/E GROUP NAME
MEMBER
---------------------------------------------------------------------------------------+--------HN.KDAM.INPUT
S DAILY-PROD-YH
PRODYHC2
PRAD-ADAKOV-M203UTIL
E DAILY-PROD-YH
PRODYBCK
PRAD-ADAKOV-M206UTIL
E DAILY-PROD-YH
PROLYBCK
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYHST
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYJCL
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYBTL
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYHC2
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYBCK
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYIDK
PRAD-MPM203-IN-USE
S DAILY-PROD-YH
PRODYIZN
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PRODYHC2
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYFOT
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYMTI
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYHO1
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYHO2
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYDPY
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYDTK
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYDLI
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYFIN
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJYBNK
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROJEND
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYKLT
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYUPD
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYMIZ
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYBCK
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYDOC
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYFMZ
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYDEL
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYDM2
PRAD-MPM206-IN-USE
S DAILY-PROD-YH
PROLYDM1
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROJYDPY
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROJYDTK
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROJYDLI
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROLYKLT
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROLYUPD
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROLYDOC
PRAD-M206F093-IN-USE
S DAILY-PROD-YH
PROLYFMZ
PRPR-ADAKOV-M203F008
S DAILY-PROD-YH
PRODYHC2
PRPR-ADAKOV-M203F021
E DAILY-PROD-YH
PRODYHC2
PRPR-ADAKOV-M203F021
E DAILY-PROD-YH
PRODYBCK
PRPR-ADAKOV-M203F021
E DAILY-PROD-YH
PRODYIDK
PRPR-ADAKOV-M203F022
E DAILY-PROD-YH
PRODYHC2
PRPR-ADAKOV-M203F022
E DAILY-PROD-YH
PRODYBCK
PRPR-ADAKOV-M203F022
E DAILY-PROD-YH
PRODYIDK
PRPR-ADAKOV-M203F023
E DAILY-PROD-YH
PRODYHC2
PRPR-ADAKOV-M203F023
E DAILY-PROD-YH
PRODYBCK
PRPR-ADAKOV-M203F023
E DAILY-PROD-YH
PRODYIDK
PRPR-ADAKOV-M203F024
E DAILY-PROD-YH
PRODYHC2
PRPR-ADAKOV-M203F024
E DAILY-PROD-YH
PRODYBCK
PRPR-ADAKOV-M203F024
E DAILY-PROD-YH
PRODYIDK
PRPR-ADAKOV-M203F024
S DAILY-PROD-YH
PRODYHST
PRPR-ADAKOV-M203F025
E DAILY-PROD-YH
PRODYBCK
PRPR-ADAKOV-M203F025
E DAILY-PROD-YH
PRODYIDK

BMC Software, Inc., Confidential and Proprietary Information

3-96

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRFLW Produce a Scheduling Table Job Flow Report

Sample Quantitative Resources Cross Reference List

Figure 3-28

CTMRFLW Sample Quantitative Resources Cross Reference List

PRODUCED BY CONTROL-M 6.0.00

BMC SOFTWARE, INC.

CROSS REFERENCE LIST - QUANTITATIVE RESOURCES

=============================================

RESOURCE NAME
NUMBER GROUP NAME
MEMBER
-------------------------------------------------------------------------------------+----------INIT-E
0001 DAILY-PROD-YH
PRODYEND
INIT-E
0001 DAILY-PROD-YH
PROLYPAR
INIT-E
0001 DAILY-PROD-YH
PROLYPAG
INIT-U
0001 DAILY-PROD-YH
PRODYHTK
INIT-U
0001 DAILY-PROD-YH
PROJYFOT
INIT-U
0001 DAILY-PROD-YH
PROJYHO1
INIT-U
0001 DAILY-PROD-YH
PROJYHO2
INIT-U
0001 DAILY-PROD-YH
PROJYDTK
INIT-U
0001 DAILY-PROD-YH
PROJYFIN
INIT-W
0001 DAILY-PROD-YH
PRODYIZN
INIT-W
0001 DAILY-PROD-YH
PROJYMRG
INIT-W
0001 DAILY-PROD-YH
PROJYMTI
INIT-W
0001 DAILY-PROD-YH
PROJYDPY
INIT-W
0001 DAILY-PROD-YH
PROJYDLI
INIT-W
0001 DAILY-PROD-YH
PROJYBNK
INIT-W
0001 DAILY-PROD-YH
PROJEND
INIT-W
0001 DAILY-PROD-YH
PROLYKLT
INIT-W
0001 DAILY-PROD-YH
PROLYUPD
INIT-W
0001 DAILY-PROD-YH
PROLYMIZ
INIT-W
0001 DAILY-PROD-YH
PROLYBCK
INIT-W
0001 DAILY-PROD-YH
PROLYFMZ
INIT-W
0001 DAILY-PROD-YH
PROLYDEL
MPM203
0001 DAILY-PROD-YH
PRODYHST
MPM203
0001 DAILY-PROD-YH
PRODYJCL
MPM203
0001 DAILY-PROD-YH
PRODYBTL
MPM203
0001 DAILY-PROD-YH
PRODYHC2
MPM203
0001 DAILY-PROD-YH
PRODYBCK
MPM203
0001 DAILY-PROD-YH
PRODYIDK
MPM203
0001 DAILY-PROD-YH
PRODYIZN
MPM206
0001 DAILY-PROD-YH
PRODYHC2
MPM206
0001 DAILY-PROD-YH
PROJYFOT
MPM206
0001 DAILY-PROD-YH
PROJYMTI
MPM206
0001 DAILY-PROD-YH
PROJYHO1
MPM206
0001 DAILY-PROD-YH
PROJYHO2
MPM206
0001 DAILY-PROD-YH
PROJYDPY
MPM206
0001 DAILY-PROD-YH
PROJYDTK
MPM206
0001 DAILY-PROD-YH
PROJYDLI
MPM206
0001 DAILY-PROD-YH
PROJYFIN
MPM206
0001 DAILY-PROD-YH
PROJYBNK
MPM206
0001 DAILY-PROD-YH
PROJEND
MPM206
0001 DAILY-PROD-YH
PROLYKLT
MPM206
0001 DAILY-PROD-YH
PROLYUPD
MPM206
0001 DAILY-PROD-YH
PROLYMIZ
REEL
0001 DAILY-PROD-YH
PROLYKLT
REEL
0001 DAILY-PROD-YH
PROLYFMZ
TAPE
0001 DAILY-PROD-YH
PRODYJCL
TAPE
0001 DAILY-PROD-YH
PRODYHC2
TAPE
0001 DAILY-PROD-YH
PROLYPAR
TAPE
0001 DAILY-PROD-YH
PROLYPAG
TAPE
0001 DAILY-PROD-YH
PROLYBCK
TAPE
0001 DAILY-PROD-YH
PROLYBME

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-97

CTMRNSC Produce Night Schedule Report

CTMRNSC Produce Night Schedule Report

This utility produces a report that provides a summary of each job that has
executed within the specified time range, including its start time, end time,
elapsed time, CPU time and system ID. The report can be sorted by
combinations of group name, job start time, and job end time.
Report parameters are supplied using DD statement SYSIN (or
DANSCPRM). Columns 73 through 80 of each statement are ignored.
Note:

It is possible to change the default number of lines per page (60) by

specifying PARM=LINECNT=xxx in the EXEC statement of the
job.

Parameters
Table 3-44

CTMRNSC Parameters

Parameter

Description

REPSTART yymmddhhnn

Date and time of start of night schedule report information.

REPEND yymmddhhnn

Date and time of end of night schedule report information.

ENDTIMEISTARTIME
ENDTIMEIGROUP
SORTBY GROUPiENDTIME
GROUPiSTARTIME
STARTTIMEiGROUP
STARTTIMEiENDTIME

Sort by end-time or start-time or group

Sort by end-time or group or start-time
Sort by group or end-time or start-time
Sort by group or start-time or end-time
Sort by start-time or group or end-time
Sort by start-time or end-time or group

INCLUDE GROUPNAME groupname

Group name or mask to be included (up to a maximum of 10).

INCLUDE JOBNAME jobname

Job name or mask to be included (up to a maximum of 10).

Example of JCL
//RNSC
EXEC CTMRNSC
//DALOGIN DD
...
A log file.

The input of the report is a file in the format of the IOA Log file. It can be the
IOA log (for a report of last nights schedule) or the Simulation log (for a
report of a forecasted night schedule).

BMC Software, Inc., Confidential and Proprietary Information

3-98

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRNSC Produce Night Schedule Report

Example of Instructions
Figure 3-29

CTMRNSC Example of Instructions

REPSTART 0005061600
REPEND
0005062300
SORTBY
STARTTIME ENDTIME
15.08.00 NSC391I NIGHT SCHEDULE REPORT STARTED
REPSTART 0005062000
REPEND
0005062200
SORTBY
STARTTIME ENDTIME
15.08.07 NSC393I NIGHT SCHEDULE REPORT ENDED
PRODUCED BY CONTROL-M (6.0.00)
NIGHT SCHEDULE REPORT
FROM 00/05/06-20:00
BMC SOFTWARE, INC.
=====================
UNTIL 00/05/06-22:00
MEMBER
JOBNAME
JOBID STARTED
ENDED
ELAPSED GROUP-NAME
CPUTIME SYSID

BRIVPCC
BRIVPCC
03370 05/06/00-20:00 05/06/00-20:35
35:12 BR-PRODUCTION
2:16.02 SYS1
BRCC0001 BRCC0001 03381 05/06/00-20:01 05/06/00-20:46
46:27 BR-PRODUCTION
4:02.03 SYS1
BRCC0002 BRCC0002 03409 05/06/00-20:01 05/06/00-20:19
18:41 BR-PRODUCTION
1:00.05 SYS2
BRCC0003 BRCC0003 03414 05/06/00-20:06 05/06/00-20:16
10:02 BR-PRODUCTION
0:42.43 SYS1
PRUPDT02 PRUPDT02 03483 05/06/00-20:08 05/06/00-20:23
15:36 PR-APPLICATION
1:15.28 SYS2
CRCCEND
CRCCEND
03484 05/06/00-20:13 05/06/00-20:23
20:01 CR-GROUP
2:19.31 SYS2
INTR0001 INTR0001 03577 05/06/00-20:13 05/06/00-21:01
48:19 INTER-APPLICATION
5:16.06 SYS2
INTR0002 INTR0002 03578 05/06/00-20:13 05/06/00-20:19
6:58 INTER-APPLICATION
0:26.52 SYS2
BRCCIND
BRCCIND
03601 05/06/00-20:19 05/06/00-20:31
12:17 BR-PRODUCTION
0:21.26 SYS2
BRUPDT02 BRUPDT02 03618 05/06/00-20:44 05/06/00-21:20
36:10 BR-PRODUCTION
3:47.20 SYS1
BRREP001 BRREP001 03617 05/06/00-20:45 05/06/00-21:02
17:34 BR-PRODUCTION
2:42.51 SYS1
BRREP002 BRREP002 03625 05/06/00-20:45 05/06/00-20:57
12:03 BR-PRODUCTION
1:37.24 SYS2
PRDKPL01 PRDKPL01 03627 05/06/00-20:52 05/06/00-21:25
33:48 KPL-PRODUCTION
4:45.25 SYS1
PRDKPL02 PRDKPL02 03628 05/06/00-21:11 05/06/00-21:27
16:51 KPL-PRODUCTION
2:59.37 SYS2
CRSREF
PRCRREF
03638 05/06/00-21:11 05/06/00-21:36
25:00 USER-CROSS REF
6:14.02 SYS2
BRIVPCCE BRIVPCCE 03869 05/06/00-21:12 05/06/00-21:57
45:14 BR-PRODUCTION
2:01.54 SYS1
INTR0003 INTR0003 03917 05/06/00-21:15 05/06/00-21:59
44:43 INTER-APPLICATION
1:39.49 SYS2
INTR0004 INTR0004 03923 05/06/00-21:15 05/06/00-21:16
1:36 INTER-APPLICATION
0:05.86 SYS2
PRYHINP
PRYHINP
03929 05/06/00-21:24 05/06/00-21:40
16:35 YH-DAILY-PRODUCTION
2:05.83 SYS2

SORTBY

STARTTIME ENDTIME

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-99

CTMROGR Produce an Overnight Execution Graph

CTMROGR Produce an Overnight Execution

Graph
The Overnight Execution graph provides a clear and easy way to display job
workloads for the purposes of planning or adjustment. Utility CTMROGR
produces this graph.
Group execution times are graphically presented. The graph can be used to
display both previous execution times, and anticipated future execution times.
The report can be used to point out problems in job execution flow (for
example, certain jobs not executing at certain times, too many jobs executing
at a given time, and so on), or simply to provide general information about
job flow and workload. For example:

By running the report in the morning, the operations manager can get a
picture of the production workload from the night before, and assess the
need for adjustments to the job flow.

On the 15th of the month, the report can simulate end-of-month

processing, to facilitate planning.

The report is designed as follows:

For specified intervals within a time range, the graph indicates whether
any job executions for the group occurred during the interval.

An asterisk (*) indicates job execution for the group during the time
interval. A blank space indicates no job execution for the group during
the interval.

The report can be requested in either of two presentation modes:

Single mode
Each group is represented on one line. For each group, no more than one
* can appear in each time interval. An * indicates that at least one job in
the group was executing during that time interval.

Parallel mode
The number of lines representing each group varies. For each group, the
number of asterisks within a time interval varies according to the number
of jobs in the group executing in that interval. Multiple asterisks for the
same group and time interval appear on successive lines.

BMC Software, Inc., Confidential and Proprietary Information

3-100

INCONTROL for OS/390 and z/OS Utilities Guide

CTMROGR Produce an Overnight Execution Graph

Note:

Multiple asterisks for a time interval (in the same or different group)
do not necessarily indicate simultaneous execution. They can
indicate separate execution times within the same interval.

Input for the report is extracted from either the IOA Log file (for actual
execution results) or the Simulation log (for forecasted results).
Report parameters are supplied using DD statement SYSIN (or
DAOGRPRM). Columns 73 through 80 of each card are ignored.

Parameters
Note:

It is possible to change the default number of lines per page (60) by

specifying PARM=LINECNT=xxx in the EXEC statement of the
job.

Table 3-45

CTMROGR Parameters

Parameter

Description

REPSTART yymmddhhmm

Earliest start date and time for jobs included in the

report.

REPEND yymmddhhmm

Latest end date and time for jobs included in the

report.

INTERVAL nn

Time interval, in minutes, for which job execution in

a group is indicated. Each interval is represented
by one column of the report. Valid values are: 01
through 60.
Note: The total number of intervals (columns) must
not exceed 210 and the start and end dates must
not be more than nine days apart, or an error
message is displayed and the report is not run.

MODE {SINGLE|PARALLEL}

Presentation mode of the report.

SINGLE Represent all job executions for a
group and interval by a single *.
PARALLEL Represent multiple job executions
for a group and interval separately, by multiple
asterisks.

GROUP {groupname|ALL}

Groups to be included in the report. Up to 10

individual group names can be specified, or the
value ALL can be specified to display all groups.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-101

CTMROGR Produce an Overnight Execution Graph

Example of JCL
Figure 3-30
//CTMROGR
//DALOGIN
//DAOGRPRM

CTMROGR Example
EXEC
CTMROGR
DD
. . .
A log file
DD
*
REPSTART 0005062000
REPEND 0005072300
INTERVAL 05
MODE PARALLEL
GROUP ALL

//
PRODUCED BY CONTROL-M 6.0.00
BMC SOFTWARE, INC.
MODE DISPLAYED: SINGLE

OVERNIGHT EXECUTION GRAPH

=========================

FROM 00/05/06 11:15 UNTIL 00/05/07-10:30

IN 15 MINUTE INTERVALS

START END
ELAPSED
GROUP NAME
TIME TIME
TIME
<..12..13..14..15..16..17..18..19..20..21..22..23..00..01..02..03..04..05..06..07..08..09..10..>
-----------------------------------------<---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|--|-->
BR-COND-UPDATE
13:40 05:34
954
*
** *
BR-GENERAL
13:00 07:23
1103
****
*
**
*
* **************
PR-BATCH-JOBREQ
07:02 07:05
3
*
PROD-KPL-ALOC001
19:34 03:47
493
*
*
PROD-KPL-ALOC002
19:31 03:32
481
*
*
PROD-KPL-FREE001
19:24 01:02
338
*
*
PROD-KPL-FREE002
18:23 02:46
503
*
*
PROD-KPL-FREE003
18:23 00:00
337
*
* *
PROD-KPL-FREE004
18:23 06:00
697
*
*
PROD-CONTROLD
12:00 12:02
2
*
PR-CICSP-ALOC001
18:33 23:55
322
*
*
PR-CICSP-ALOC002
18:33 23:55
322
*
*
PR-CICSP-ALOC003
18:34 23:55
321
*
*
PR-CICSP-ALOC004
18:34 00:12
338
*
*
PR-CADACAD3
04:04 04:04
*
PR-CADACAD6
04:16 04:16
*
PR-CADACMC6
02:11 02:11
*
PR-CADAC186
18:30 18:39
9
*
PR-CADAOAD3
04:38 04:38
*
PR-CADAOAD6
05:36 05:36
*
PR-CADAOMC6
02:25 02:25
*
PR-JOBDAILY-1
17:00 07:01
841
*
*
Q-PR-CLOCK
04:00 04:02
2
*
Q-PR-CONTM
03:01 08:00
299
*
Q-PR-EADA-BACKUP
16:14 06:48
874
***
************
******
**
* * **
Q-PR-EADA-CHEKPOINT 07:30 08:07
37
***
Q-PR-GENERAL
16:00 06:51
891
*
**
* ******
Q-PR-INITS
14:52 08:10
1038
*
**
* *
*** *
PRODUCED BY CONTROL-M 6.0.00
OVERNIGHT EXECUTION GRAPH
BMC SOFTWARE, INC.
=========================
FROM 00/05/06 11:15 UNTIL 00/05/07-10:30
MODE DISPLAYED: PARALLEL
IN 15 MINUTE INTERVALS

START END
ELAPSED
GROUP NAME
TIME TIME
TIME
<..12..13..14..15..16..17..18..19..20..21..22..23..00..01..02..03..04..05..06..07..08..09..10..>
---------------------------------------<---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|-->
BR-COND-UPDATE
13:40 05:34
954
*
BR-GENERAL

13:00 07:23

1103

PR-BATCH-JOBREQ

07:02 07:05

PROD-KPL-ALOC001
PROD-KPL-ALOC002
PROD-KPL-FREE001
PROD-KPL-FREE002
PROD-KPL-FREE003
PROD-KPL-FREE004
PROD-CONTROLD

19:34
19:31
19:24
18:23
18:23
18:23
12:00

03:47
03:32
01:02
02:46
00:00
06:00
12:02

493
481
338
503
337
697
2

PR-CICSP-ALOC001
PR-CICSP-ALOC002

18:33 23:55
18:33 23:55

322
322

***
* *
* *
***
***
*
*
*
**

*
*
*
*
*
*
*
*
*

*
*
*
*
**
*
*
*
*
**

*
*
*
*
*
*

*
*

** *
*
* ***** * ******
****** **
*
*** * *
** * *
*** * *
*
* *
*
* *
*
*
** *
***
**
*
*
*
*

*
*
* *
*

*
*
*
*
*

*
*

BMC Software, Inc., Confidential and Proprietary Information

3-102

INCONTROL for OS/390 and z/OS Utilities Guide

CTMROGR Produce an Overnight Execution Graph

PR-CICSP-ALOC003
PR-CICSP-ALOC004
PR-CADACAD3
PR-CADACAD6
PR-CADACMC6
PR-CADAC186

18:34
18:34
04:04
04:16
02:11
18:30

23:55
00:12
04:04
04:16
02:11
18:39

321
338

PR-CADAOAD3
PR-CADAOAD6
PR-CADAOMC6
PR-JOBDAILY-1

04:38
05:36
02:25
17:00

04:38
05:36
02:25
07:01

841

Q-PR-CLOCK
Q-PR-CONTM
Q-PR-EADA-BACKUP

04:00 04:02
03:01 08:00
16:14 06:48

2
299
874

Q-PR-EADA-CHEKPOINT

07:30 08:07

37

Q-PR-GENERAL

16:00 06:51

891

Q-PR-INITS

14:52 08:10

1038

*
*

*
*
*
*
*

*
*
*
*
*
*

*
*
*

***

************
*
**

****
***

*
**

*
* * *
**
*
***

*
*

**
**

**
*
*
*
*

*
*

* * ****
*****
***
**
*
*
*

*
*

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-103

CTMRPFL Produce a Job Plan and Job Flow Report

CTMRPFL Produce a Job Plan and Job Flow

Report
Utility CTMRPFL provides job flow information for jobs in a scheduling
table that are scheduled in a specified date range.
Utility CTMRPFL can best be understood in context of the features (and
limitations) of the following reports, described on pages page 3-106,
page 3-85, and page 3-77, respectively:
Table 3-46

CTMRPFL Report Features

Feature

Description

CTMRPLN

Produces a list of all jobs that are planned for a specified date
range. However, this report does not contain job flow information.

CTMRFLW

Produces a job flow report for jobs in a scheduling table.

However, this report includes jobs regardless of whether they are
scheduled in a particular date range (that is, the report does not
exclude unscheduled jobs).

CTMRAFL

Produces a job flow report for all jobs currently in the Active Jobs
file.

Utility CTMRPFL uses the same parameters as, and combines the features
of, utility CTMRPLN and CTMRFLW, as follows:

Utility CTMRPLN parameters are used to generate a list of jobs

scheduled in a specified date range.

This list is then used, in combination with the parameters of utility

CTMRFLW, to generate a job flow report for those jobs in the specified
scheduling table that are included in the list.

Utility CTMRPFL can generate the same reports (Job Flow, Cross Reference)
in the same formats (text, chart) as utility CTMRFLW.
Utility CTMRPFL also generates a report identical to the CTMRPLN report.
(This report output can be suppressed. However, the list required as input for
the job flow report is generated.)
Utility CTMRPFL receives two sets of parameters:

The first set of parameters, input using DD statement SYSIN1, is

identical to those of utility CTMRPLN. However, only REPTYPE values
1, 1S, 2, or 2S are used. (In utility CTMRPLN, REPTYPE 0 or 0S can
also be specified.)

BMC Software, Inc., Confidential and Proprietary Information

3-104

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRPFL Produce a Job Plan and Job Flow Report

The second set of parameters, input using DD statement SYSIN2 is

identical to those of utility CTMRFLW.

Note:

For detailed information on the parameters used by utility

CTMRPFL, see CTMRPLN Job Plan Report on
page 3-106, and CTMRFLW Produce a Scheduling Table
Job Flow Report on page 3-85.

Example JCL
A sample job can be found in member CTMRPFL in the CONTROL-M JCL
library.
Figure 3-31

CTMRPFL Example

//DAPLNJOB DD DISP=SHR,DSN=scheduling-library(table1)
//
DD DISP=SHR,DSN=scheduling-library(table2)
.
.
.
//SYSIN1
DD *
REPSTART 000808
REPEND
000808
REPTYPE 2S
//SYSIN2
DD *
GROUP
UNITED
CHART
YES
PAGESEQ YES
PAGESIZE 60
LINESIZE 160
PRINTER IMPACT
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-105

CTMRPLN Job Plan Report

CTMRPLN Job Plan Report

This report provides a list of all the jobs that are planned for a specified range
of dates.
Report parameters are supplied using DD statement SYSIN (or
DAPLNPRM).
Note:

It is possible to change the default number of lines per page (60) by

using PARM=LINECNT=xxx in the EXEC statement of the job.

Parameters
Table 3-47

CTMRPLN Parameters (Part 1 of 2)

Parameter

Description

REPSTART
yymmdd

Start date of report. Mandatory.

REPEND yymmdd

End date of end of report. Mandatory.

REPTYPE n

Type of report (0, 0S, 1, 1S, 2 or 2S). Default: 0.

Type 0 and 0S Displays a day-by-day list of planned jobs
(in the specified date range). The jobs displayed for each
day can be sorted according to member name or according
to group. For each member in the list, the member name,
group and description are displayed.
Type 1 and 1S Displays a month by month table of
planned jobs (in the specified date range), indicating days
on which the jobs are planned for execution. This format is
useful for drawing the entire months plan.
Type 2 and 2S This report is identical to the Type 1
report, except that it also displays the job description for
each job.
Notes:
If the S is specified in the identifier, the report displays the
library and member names of the job, instead of the job
description.
Type 2 reports require a laser printer or a wide printer.

JOBSDD ddname

DD name of the library. If specified, all members of the library

are processed by the utility. This makes it unnecessary to
specify a concatenation of DD statements (one statement for
each table) in the JCL. Optional.

SORTBY
{MEMNAME|
GROUP}

Sort option. Default: MEMNAME. This parameter is relevant

only for REPTYPE 0.

BMC Software, Inc., Confidential and Proprietary Information

3-106

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRPLN Job Plan Report

Table 3-47

CTMRPLN Parameters (Part 2 of 2)

Parameter

Description

IGNORE
CALENDAR
calname

Ignore jobs that reference calendar calname. This statement

is optional. A maximum of eight IGNORE statements can be
supplied.
This statement excludes a job from the report if its MONTHS
parameter is filled with Y values and either of the following
criteria is satisfied:
WDAYS is defined as ALL (or blank) and its associated
WCAL is specified in the IGNORE statement.
DAYS is defined as ALL (or blank) and its associated DCAL
is specified in the IGNORE statement.

TABLES abc*, xyz*

Enables use of generic table names to process individual or

multiple tables. Used together with the JOBSDD parameter.
Only the members satisfying the pattern criteria specified in
the TABLES parameter are selected from the library specified
in the JOBSDD parameter and processed. Supports full
masking. Optional.

Example of JCL
A sample job can be found in member CTMRPLN in the CONTROL-M JCL
library.
Figure 3-32

//PLAN
//DAPLNJOB
//
//

CTMRPLN Example

EXEC
DD
DD
DD

//DAPLNPRM DD

CTMRPLN
DISP=SHR,DSN=scheduling-library(table1)
DISP=SHR,DSN=scheduling-library(table2)
DISP=SHR,DSN=scheduling-library(table3)
.
.
.
*

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-107

CTMRPLN Job Plan Report

Sample Input Parameters

Figure 3-33
REPSTART
REPEND
REPTYPE
SORTBY
REPSTART
REPEND
REPTYPE
SORTBY

Utility CTMRPLN Sample Input Parameters

000601
000630
0
MEMNAME

000501
000530
0
MEMNAME

PRODUCED BY CONTROL-M 6.0.00

UNTIL 000530
BMC SOFTWARE, INC.
JOBS PLANNED FOR TUESDAY 06/01/00

JOBS PLAN REPORT

FROM 000501

================

MEMNAME
GROUP
DESCRIPTION
--------------------------------------------------------------------------------
BRCCIND
BR-IVP-CC
PREPARE SPECIAL UPDATE INFO
BRCC0001 BR-IVP-CC
PERFORM QUALITY CHECKING ON INPUT DATA PROD1-A
BRCC0002 BR-IVP-CC
COLLECT INPUT DATA SETS FOR PROD1-B EXECUTION
BRCC0003 BR-IVP-CC
FINAL INPUT DATA SETS VARIFICATION
BRIVPCC
BR-IVP-CC
COLLECT INPUT DATA SETS FOR PROD1-A EXECUTION
BRIVPCCE BR-IVP-CC
UPDATE JOB OF EXTRA BALANCING
BRREP001 BR-IVP-CC
PRODUCE SUM REPORTS
BRREP002 BR-IVP-CC
PRODUCE SPECIAL REPORTS
BRUPDT02 BR-IVP-CC
UPDATE JOB
CRCCEND
BR-IVP-CC
NOTIFY END OF PRODUCTION PROCESS
MTFIT01
MT-PRODUCTION
MT INPUT RUN # 1
MTFIT02
MT-PRODUCTION
MT INPUT RUN # 2
MTFIT03
MT-PRODUCTION
MT INPUT RUN # 3
MTFIT04
MT-PRODUCTION
MT INPUT RUN # 4
MTFIT05
MT-PRODUCTION
MT INPUT RUN # 5
MTFRTH01 MT-PRODUCTION
MT MERGE INPUT FILES
MTRUN001 MT-PRODUCTION
MT UPDATE - FIRST RUN
MTRUN002 MT-PRODUCTION
MT UPDATE - SECOND RUN
MTTRD02
MT-PRODUCTION
MT REPORTS
MTUPDT
MT-PRODUCTION
MT UPDATE TO ON-LINE FILES
PRDDRPT1 PROD-KPL
REPORTS AFTER PRODUCTION UPDATES FOR PROD-KPL
PRDDRPT2 PROD-KPL
REPORTS AFTER PRODUCTION EXECUTION FOR PROD KPL
PRDKPLW1 PROD-KPL
WEEKLY PRODUCTION INPUT FILES FROM PROD-KPL #1
PRDKPLW2 PROD-KPL
WEEKLY PRODUCTION UPDATE OF PROD-KPL #2
PRDKPLW3 PROD-KPL
WEEKLY PRODUCTION UPDATE OF PROD-KPL #3
PRDKPLW4 PROD-KPL
WEEKLY EXECUTIONS AFTER DAILY FROM PROD-KPL
PRDKPL01 PROD-KPL
DAILY PRODUCTION - START OF APPL-PROD-KPL
PRDKPL02 PROD-KPL
DAILY PRODUCTION - COLLECT TAPE FILES OF PROD-KPL
PRDTT001 PR-PRODUCTION
TAPE COLLECTION FOR PR PRODUCTION
PRERRPRT PR-PRODUCTION
ERROR REPORTS FOR APPLICATION PR
PRFKL01
PR-PRODUCTION
STATISTICS REPORTS FOR PR APPLICATION
PRUPDOLV PR-PRODUCTION
UPDATE ON-LINE REPORTS

BMC Software, Inc., Confidential and Proprietary Information

3-108

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRPLN Job Plan Report

Sample CTMRPLN Job Plan Report Type 0S Report

Figure 3-34
REPSTART
REPEND
REPTYPE
SORTBY

CTMRPLN Report Type 0S

000501
000530
0S
MEMNAME

PRODUCED BY CONTROL-M 6.0.00

000105
BMC SOFTWARE, INC.

JOB

PLAN REPORT

FROM 000105 UNTIL

================

JOBS PLANNED FOR WEDNESDAY 05/01/00

MEMNAME
TABLE
LIBRARY
--------------------------------------------------------------------------------IEBCOPY1 TABLE1
CTMP.PROD.SCHEDULE
IEBGENE2 TABLE1
CTMP.PROD.SCHEDULE
IEFBR14
TABLE1
CTMP.PROD.SCHEDULE
ISP4JJC0 US166248 M71.LIB.SCHEDULE
JOB1
TABLE1
CTMP.PROD.SCHEDULE
LONG
TABLE1
CTMP.PROD.SCHEDULE
IND$FILE GET M71.REP0S.CTMRPLN.SAMPLE ASCII CRLF
IND$FILE GET M71.REP0S.CTMRPLN.SAMPLE ASCII CRLF
IND$FILE GET CTMRPLNS.DOC ASCII CRLF
IND$FILE GET M71.REP0S.CTMRPLN.SAMPLE ASCII CRLF

Sample CTMRPLN Job Plan Report Type 1S Report

Figure 3-35

CTMRPLN Report Type 1S

REPSTART 000501
REPEND
000530
REPTYPE 2S
SORTBY
MEMNAME1
PRODUCED BY CONTROL-M 6.0.00
BMC SOFTWARE, INC.
JOBS PLANNED FOR 01 2000

JOB

PLAN REPORT
FROM 000105 UNTIL 000105
================

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17
20 21 22 23 24 25 26 27 28 29 30 31
TABLE
LIBRARY
SA SU MO TU WE TH FR SA SU MO TU WE TH FR SA SU MO
TU WE TH FR SA SU MO TU WE TH FR SA SU MO
-----------------------------------------------------+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+-IEBCOPY1 TABLE1
CTMP.PROD.SCHEDULE
*
18

19

IEBGENE2 TABLE1

CTMP.PROD.SCHEDULE

IEFBR14

CTMP.PROD.SCHEDULE

TABLE1

ISP4JJC0 US166248 M71.LIB.SCHEDULE

JOB1

TABLE1

LONG

-----------------------------------------------------+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+-TABLE1
CTMP.PROD.SCHEDULE
*

MCHISH

TABLE1

NOTFIXED DEMO

CTMP.PROD.SCHEDULE

CTMP.PROD.SCHEDULE

CTMP.PROD.SCHEDULE

-----------------------------------------------------+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+--

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-109

CTMRPLN Job Plan Report

Sample CTMRPLN Job Plan Report Type 1 Report

Figure 3-36

CTMRPLN Job Plan Report Type 1

REPSTART 000501
REPEND
000530
REPTYPE 1S
SORTBY
MEMNAME

PRODUCED BY CONTROL-M 6.0.00

BMC SOFTWARE, INC.

JOBS PLAN REPORT

================

FROM 000501 UNTIL 000530

JOBS PLANNED FOR 05 2000

BRCCIND
BRCC0001
BRCC0002
BRCC0003
BRIVPCC
MTFIR01
MTFIT01
MTFIT02
MTFIT03
MTFIT04
MTFIT05
MTFRTH01
MTRUN001
MTRUN002
MTSCN01
MTTRD01
MTTRD02
MTUPDT
PRDDRPT1
PRDDRPT2
PRDKPLW1
PRDKPLW2
PRDKPLW3
PRDKPLW4
PRDKPL01
PRDKPL02
PRDTT001
PRDTT01
PRERRPRT
PRFKL01
PRPRTH01
PRRPT01
PRRPT02
PRRPT03
PRRPT04
PRRPT05
PRTRD01
PRTRD04
PRUPDOLV

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
MO TU WE TH FR SA SU MO TU WE TH FR SA SU MO TU WE TH FR SA SU MO TU WE TH FR SA SU MO TU
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
|
| * | * | * | * | * |
|
| * | * | * | * | * |
|
| * | * | * | * | * |
|
| * | * | * | * | * |
|
| * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| * | * | * | * | * |
|
| * | * | * | * | * |
|
| * | * | * | * | * |
|
| * | * | * | * | * |
|
| * |
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |
| * | * | * |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| * |
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
| * |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
| * |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * | * | * | * | * |
| * | * |

BMC Software, Inc., Confidential and Proprietary Information

3-110

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRSTR Restore the CONTROL-M Active Jobs File

CTMRSTR Restore the CONTROL-M Active Jobs

File
When restoration of the CONTROL-M Active Jobs file is necessary, utility
CTMRSTR can be run to perform this task. Optionally, prerequisite
conditions in the IOA Conditions file can also be restored.
The utility uses the CONTROL-M Journal file in conjunction with the
CKPJNL and CND JNL files to perform a forward restoration of the Active
Jobs file from the last time New Day processing was performed.
Note:

Do not perform restoration of the IOA Conditions file and/or the

CONTROL-M Resources file if multiple INCONTROL products
have been updating these files.
CONTROL-M Application Server must be down when running
utility CTMRSTR. If CONDITIONS NO is specified, CONTROL-D
and CONTROL-O are not affected by running this utility.
CONTROL-M and CONTROL-M Application Server must be
activated after running utility CTMRSTR. Other INCONTROL
products need not be reactivated.

Parameters
The following parameters are passed to the utility using the DD SYSIN file:
Table 3-48

CTMRSTR Parameters (Part 1 of 2)

Parameter

Description

ENDTIME
yyyymmddhhmmssth

Time until which the CONTROL-M Active Jobs file is to be

restored. The Active Jobs file image (after the New Day
procedure) is updated to reflect the image of the file at the
specified time. The time parameter consists of the
following subparameters:
yyyy 4-character year.
mm Month (1 12).
dd Day (1 31).
hh Hour (00 24).
mm Minute (00 59).
ss Second (00 59).
th Hundredths of a second (00 99).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-111

CTMRSTR Restore the CONTROL-M Active Jobs File

Table 3-48

CTMRSTR Parameters (Part 2 of 2)

Parameter

Description

CONDITIONS

Indicates whether to restore the IOA Conditions file and

the CONTROL-M Resources file:
Y (Yes) Restore the IOA Conditions file and/or the
CONTROL-M Resources file to its image at the time
specified.
N (No) Do not restore the IOA Conditions file and/or
the CONTROL-M Resources file. Default.

Example
A sample job can be found in the CTMRSTR member of the CONTROL-M
JCL library.
Restore the contents of the CONTROL-M Active Jobs file to the image it
contained at 12 noon on July 1, 2000. In addition, restore the prerequisite
conditions in the IOA Conditions file to the same point in time.
//RESTORE EXEC CTMRSTR
//SYSIN DD *
ENDTIME 200007011200000000
CONDITIONS YES
//

Return Codes
Table 3-49

CTMRSTR Return Codes

Code

Description

Operation performed successfully

Warning message issued

Verification check failed prior to initialization of restoration

AJF verification
CTMPARM verification
Endtime specification mismatch
Unexpected program error

12

Addition or deletion of a condition in the IOA Conditions file failed

16

Unable to open file or obtain storage for processing

BMC Software, Inc., Confidential and Proprietary Information

3-112

INCONTROL for OS/390 and z/OS Utilities Guide

CTMSLC Schedule Library Cleanup Utility

CTMSLC Schedule Library Cleanup Utility

The CTMSLC utility enables you to remove old job scheduling definitions
from the schedule library.
A job within a regular (that is, non-group) table is considered old if the date
specified in the DEFINITION ACTIVE UNTIL field of the job scheduling
definition has already passed.
A job within a group table is considered old if either

the date specified in the DEFINITION ACTIVE UNTIL field of the job
scheduling definition has already passed

or

the dates specified in the SCHEDULE TAG ACTIVE UNTIL fields of all
job schedule tags in the group scheduling definition have already passed,
and the relationship between the schedule tags and the basic scheduling
criteria of the job is AND

Note:

If the date specified in the DEFINITION ACTIVE UNTIL field has

already passed, but the date specified in the DEFINITION ACTIVE
FROM field is later than that date, the job is not considered old.
Similarly, if the date specified in the SCHEDULE TAG ACTIVE
UNTIL field of a schedule tag has already passed, but the date
specified in the SCHEDULE TAG ACTIVE FROM field of that tag
is later than that date, jobs containing that tag are not considered old.

The CTMSLC utility receives control statements, in DD statement SYSIN,

with the following syntax:
CLEANUP [DSNAME=dataset_name | DDNAME=ddname] ,
[MEMBER=member_name] , [JOB=jobname] , [DATE=date],
[MODE=SIMULATION | NORMAL]

where

dataset_name is the dataset name of the library being cleaned

ddname is a DD statement pointing to the library being cleaned

Note:

Specify either DSNAME or DDNAME, but do not specify both.

member_name is the name of the library member containing the job table
that is to be cleaned

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-113

CTMSLC Schedule Library Cleanup Utility

Either the full member name or a prefix followed by an * (asterisk) can

be specified. If this parameter is omitted, all the members in the library
are eligible for cleanup.

jobname is the name of each job in the job table that is to be cleaned
Either the full job name or a prefix followed by an * (asterisk) can be
specified. If this parameter is omitted, all the jobs in the table will be
eligible for cleanup.

date is the date, in the format used at your site, that will be used to
determine if a job is old
The default value of date is the current date.

MODE is the desired operation mode of the utility

There are two options:
SIMULATION
In this mode, when a job is found to be old the utility issues an
appropriate message but does not delete the job. This is the default
setting.
NORMAL
In this mode, when a job is found to be old, it is deleted.

Example
A sample job can be found in the CTMSLC member of the CONTROL-M
JCL library.
Remove all jobs with names that begin with JOB1 from table TABLE1 in
scheduling library CTM.SCHED.LIB, if they should be considered old by
010203.
//RESTORE EXEC PGM=CTMSLC,REGION=0M
//SYSIN DD *
CLEANUP DSNAME=CTM.SCHED.LIB,MEMBER=TABLE1,
JOB=JOB1*,DATE=010203,MODE=NORMAL
//

BMC Software, Inc., Confidential and Proprietary Information

3-114

INCONTROL for OS/390 and z/OS Utilities Guide

CTMSLC Schedule Library Cleanup Utility

Return Codes
Table 3-50

CTMSLC Return Codes

Code

Description

Operation performed successfully, at least one job was deleted.

Operation performed successfully, no jobs were deleted.

Scheduling table is in use by another user.

12

Member does not exist or is not a scheduling table.

16

Syntax error in control statement.

20

Operation failed. Check the job output for messages that indicate
the cause of the problem.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-115

CTMTBUPD Update Job Scheduling Tables

CTMTBUPD Update Job Scheduling Tables

The CTMTBUPD utility updates CONTROL-M group or job scheduling
definition parameters in batch mode.
This utility receives parameters from an input file referenced by
DD statement DAINPRM. This file contains the following types of
statements and parameters:

Selection statements that specify job scheduling definition selection

criteria.

Statements containing update parameters that specify values to be added

to, changed in, or deleted from, the job scheduling definition fields.

Utility control statements that control the operation of the utility.

Comment statements (that contain an asterisk in column one).

The parameters in these statements are discussed under Parameters below.

These statements must not contain sequence numbers in columns 72 through
80.

Parameters
Selection Control Statement

The selection control (SEL) statement is mandatory. This statement contains

selection parameters that specify on which scheduling tables, job scheduling
definitions, applications, groups and/or group schedule tags the utility is to
operate. Format:
SEL [TBL=tbl_name][,JOB=job_name][,APPL=app_name]
[,GRP=grp_name][,TAG=sched_tag]

where

tbl_name specifies the scheduling tables in the scheduling library to be

selected

job_name specifies the job scheduling definitions in the scheduling tables

to be selected
This parameter must match the value of the MEMNAME parameter in
the job scheduling definition.

BMC Software, Inc., Confidential and Proprietary Information

3-116

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

app_name specifies the applications to be selected

This parameter must match the value of the APPL parameter in the job
scheduling definition.

grp_name specifies the groups to be selected

This parameter must match the value of the GROUP parameter in the job
scheduling definition.

sched_tag specifies the group schedule tags to be selected.

This parameter must match the value of the SCHEDULE TAG parameter
in the Group Entity scheduling definition.

The selection control statement must precede all update parameters, begin in
column 1, and be entirely contained in one record. Note the following points:

You can specify any, all, or none of the these parameters in any order in
the SEL statement.
Note:

If you do not specify any parameters, subsequent update

parameters will modify every job in each scheduling table in the
scheduling library.

Each parameter can appear no more than one time in any SEL statement,
and it can have no more than one value assigned to it. Prefix values can
be specified by placing an asterisk at the end of the value string. For
more information, see Utility Control Statements on page 3-126.

When multiple parameters are specified, they are connected by an

implicit logical AND relationship.

When parameter TAG is specified, only basic scheduling parameters

(DAYS, WDAYS, and so on.) in Schedule Tags of Group entities are
processed. Only the first matching Schedule Tag in a Group Entity is
processed. The Schedule Tag name itself can be changed.

To exclude modifications to Group Entity fields, specify parameter JOB.

A selection group consists of a SEL statement, followed by associated

update parameters, and closed by an ENDSEL statement. You can
include multiple SEL groups in a single execution of utility
CTMTBUPD.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-117

CTMTBUPD Update Job Scheduling Tables

Update Parameters

Update parameters generally correspond to the parameters of the

CONTROL-M Job Scheduling Definition screen. Not all fields in the Job
Scheduling Definition screen can be updated using the utility. Fields that can
be updated are listed and described below. For a detailed description of each
parameter, see the Job Production parameters chapter in the CONTROL-M for
OS/390 and z/OS User Guide.
Fields to be updated can fall into either of two categories:

fields easily updated by simple specification of the new value

fields that require complex value specifications

Fields Easily Updated

You can update the fields shown in Table 3-51 by specifying the new desired
values in the following format:
parm_name=new_value

where

parm_name is the name of the parameter in the job scheduling definition.

new_value is the new value for the parameter

Note:

In Table 3-51, an asterisk in column * indicates that character

masking can be specified for the parameter as follows:
If an asterisk is specified following a character string, the character
string is treated as a prefix (meaning, only the first n characters of the
parameter, corresponding to the number of characters preceding the
*, participate in the modification).
If the character string begins with one or more asterisks, the number
of characters at the start of the parameter value corresponding to the
number of asterisks specified do not participate in the modification.

Table 3-51

CTMTBUPD Parameters (Part 1 of 3)

Parameter

Col

Value

Description

APPL

1 through 20 characters

Application name

AUTOARC

Y (Yes) or N (No)

Archive SYSDATA

CATEGORY

1 through 20 characters

Category for CONTROL-D

CONFCAL

1 through 8 characters

Confirmation calendar name

CONFIRM

Y (Yes) or N (No)

Confirmation for schedule

BMC Software, Inc., Confidential and Proprietary Information

3-118

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

Table 3-51

CTMTBUPD Parameters (Part 2 of 3)

Parameter

Col

Value

Description

DATES

4 digit dates, separated by commas

DATES scheduling

DAYS

For information, see the Job

Production parameters chapter of
the CONTROL-M for OS/390 and
z/OS User Guide

Scheduling days

DCAL

1 through 8 characters or "*"

DAYS calendar name

DESC

1 through 50 characters

Description of job

DOCLIB

1 through 44 characters

Documentation library name

DOCMEM

1 through 8 characters

Documentation member name

[+/-]hhmm

Due out time

1 through 20 characters

Group name

INTERVAL

4 digits

Minutes between reruns

INTERVAL-TYP

1 character: S, E, T

Interval type
S Start
E End
T Target

MAXDAYS

2 digits

Expiration period

MAXRERUN

3 digits

Maximum number of reruns

MAXRUNS

3 digits

Maximum number of runs

MAXWAIT

2 digits

Maximum days job is retained

DUE-OUT
GROUP

MEMLIB

1 through 44 characters

Library containing JCL member

MEMNAME

1 through 8 characters

JCL member name

1 through 8 characters

NJE node identifier

NJE-NODE
OVERLIB

1 through 44 characters

Overriding JCL library name

OWNER

1 through 8 characters

User-identification

PREVENT-NCT2

Y (Yes) or N (No) or F or L

Prevent NOT CATLGD 2 errors

PRIORITY

1 to 2 characters

Priority

RELATION

A or O

AND or OR relation

RETDAYS

3 digits

Maximum number of days to retain

RETGENS

2 digits

Maximum number of generations to retain

RETRO

Y (Yes) or N (No) - Y (Yes) is not

valid in group tables

Retroactive selection

SCHENV

1 through 16 characters

Workload management scheduling

environment

SHIFT

1 character: >, <, @, blank

Shift on confirmation calendar

SHIFT-EXT

3 characters: nn, or blank

For a description, see the SHIFT parameter

in the Job Production parameters chapter of
the CONTROL-M for OS/390 and z/OS User
Guide

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-119

CTMTBUPD Update Job Scheduling Tables

Table 3-51

Parameter

CTMTBUPD Parameters (Part 3 of 3)

Value

Description

SAC

1 character (P, N, -, +, blank)

Schedule adjustment for conversion

SYSDB

Y (Yes) or N (No)

Archive to common dataset

SYSTEM-ID

1 through 4 characters

SYSTEM-ID identifier

1 through 20 characters

Schedule Tag name

TASKTYPE

3 characters

Type of task (job, started task, and so on.)

TIMEFROM

[+/-]hhmm

Earliest time to submit job

TIMEUNTIL

[+/-]hhmm,>

Latest time to submit job, submit as soon as

possible

TIME-ZONE

3 characters

Time zone designation

WCAL

1 through 8 characters or "*"

WDAYS calendar name

WDAYS

For information, see the Job

Production parameters chapter of
the CONTROL-M for OS/390 and
z/OS User Guide

Weekly scheduling days

TAG

Col

Notes

You can use a blank ( ) as the value for any parameter in Table
3-51, except for the MEMLIB, MEMNAME, and OWNER
parameters.

Certain parameters cannot be specified with other parameters. For

example, if you specify the DATES parameter, you cannot specify
the MONTHS and RELATION parameters. For the rules governing
valid parameter combinations, see the Job Production parameters
chapter in the CONTROL-M for OS/390 and z/OS User Guide.

Multiple values for the DAYS and WDAYS parameters must be

specified in a single statement separated by commas.

For Group scheduling tables, to update parameters defined in

Schedule Tags (DAYS, WDAYS, and so on.) or to change the
Schedule Tag name, selection parameter TAG must be specified.
A Schedule Tag name of * cannot be changed, and a Schedule Tag
name cannot be changed to *. To delete a Schedule Tag and all of
its corresponding job scheduling definitions from the Group Entity,
specify the name of the Schedule Tag to be deleted in the TAG
selection parameter and specify a null TAG update parameter.

BMC Software, Inc., Confidential and Proprietary Information

3-120

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

For parameters TIMEFROM, TIMEUNTIL and DUE-OUT, the

hhmm value can be preceded by a + or -. This indicates that the
specified hhmm value is to be added to or subtracted from the
existing (non-blank) hhmm value in the FROM, UNTIL, DUE OUT
parameter in the job scheduling definition.

If you want to run the CTMTBUPD utility through CONTROL-M

scheduling, and any of the utility control statements contains the
string %% (such as SETVAR), you must specify the AutoEdit
statements %%RESOLVE OFF and %%RESOLVE ON before and
after the control statement, respectively.

Fields Requiring Complex Updates

For purposes of update by this utility, fields are divided into two categories:
Table 3-52

CTMTBUPD Field Categories

Category

Description

Condition or
Resource
Parameters

This category includes parameters IN, OUT, CONTROL and

RESOURCE.

Miscellaneous
Parameters

This category includes parameters SETVAR and MONTHS.

Each of these categories requires a different method of handling.

Condition or Resource Parameters

Updates to the IN, OUT, CONTROL, and RESOURCE parameters require
statements that often provide additional information beyond just the new
value.
The format of the update statement for condition or resource parameters is:
parmname,[N=(name,qualifier)][,O=(name,qualifier)][,P={po
sition|*}]

where

parmname is the parameter to be updated (IN, OUT, CONTROL, or

RESOURCE) in the job scheduling definition.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-121

CTMTBUPD Update Job Scheduling Tables

N is the new parameter value.

This parameter is used without an O= parameter when adding a new
condition or resource, and is used with an O= parameter when replacing
an existing condition or resource value. Subparameters are
name Condition or resource name.
qualifier Parameter qualifier (for example, condition date, resource
quantity). For details, see Subparameter Qualifier on page 3-123.

O is the old (existing) parameter value.

This parameter is used without an N parameter when deleting an existing
condition or resource, and is used with an N parameter when replacing an
existing condition or resource value. Subparameters are
name Condition or resource name.
qualifier Parameter qualifier (for example, condition date, resource
quantity). For details, see Subparameter Qualifier on page 3-123.

P is the starting character position. This parameter is used when partial

names are specified in parameter N or O (for generic updating). For
details, see Partial Names (Generic Changes) on page 3-125.

Note the following points:

Parameter parmname is mandatory.

An N parameter and/or an O parameter must be specified.
Parameter P must be specified if parameter N or parameter O in the
statement is to be treated as a partial value (meaning, not a full
20-character name padded with trailing blanks).

The specified parameters must be in the order indicated in the format

statement (meaning, parmname must be first, N cannot follow O or P,
and O cannot follow N or P).

When both parameters N and O are specified, the length of the name
value need not be the same for each of the parameters.

Whether this statement applies to an IN, OUT, CONTROL or

RESOURCE parameter is determined by the parmname value. This, in
turn, determines the format and valid values of the subparameters in
parameters N and O.
Valid values for subparameter qualifier are generally determined by
the values allowed in job scheduling definitions.

BMC Software, Inc., Confidential and Proprietary Information

3-122

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

In many cases, question marks can be specified as the value for

subparameter qualifier.
Note:

Question marks indicate that the specified qualifier (meaning,

subparameters in the job scheduling definition such as condition
date or resource quantity) is not considered during processing.
This topic is discussed at greater length later.

Format and valid values for subparameter qualifier are described immediately
below. Usage of these values, including question marks, is discussed later.

Subparameter Qualifier

When parmname = IN, subparameter qualifier is four characters. Valid

values are:
Valid date value for parameter IN (date, ODAT, PREV, STAT, ****
or $$$$)
???? (four question marks)

When parmname = OUT, subparameter qualifier is five characters. Valid

values are:
Two concatenated values:
dateValid, 4-character date or symbolic date value for parameter
OUT (date, ODAT, NEXT, PREV, STAT, **** or $$$$)
optValid OUT option (+ or -) (for example, ODAT+)
????? (five question marks)

When parmname = RESOURCE, subparameter qualifier is four

characters. Valid values are:
Valid 4-digit resource quantity for parameter RESOURCE
???? (four question marks)

When parmname = CONTROL, subparameter qualifier is one character.

Valid values are:
Valid status values for parameter CONTROL (E or S)
? (one question mark)

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-123

CTMTBUPD Update Job Scheduling Tables

Updating Conditions and Resources

Note:

Use of partial names is described later.

When updating various types of conditions and resources (IN, OUT,

RESOURCE or CONTROL as identified in parameter parmname), the type
of update performed is determined by the combination of N and O
parameters specified. Specify these parameters as follows:

To delete an existing condition or resource, specify the condition or

resource name in an O parameter (but do not specify an N parameter), as
follows:
To delete a specific occurrence of the condition or resource, specify
the occurrence value in subparameter qualifier.
To delete all occurrences of the condition or resource, specify
question marks in the subparameter qualifier.

To add a new condition or resource, specify the condition or resource

name in parameter N and specify a value in subparameter qualifier (but
do not specify parameter O). Question marks cannot be specified in
subparameter qualifier.

To replace or change the value of an existing condition or resource,

specify both parameter N and parameter O. Apply the following rules to
achieve the desired result.
To change a condition or resource name, specify the new name in
parameter N and the old name in parameter O.
To leave the condition or resource name unchanged, (meaning, when
only changing qualifiers), specify the same name in both the N and O
parameter.
To change the qualifier of a condition or resource, specify the new
value in subparameter qualifier in parameter N.
To leave the existing qualifier of the condition or resource unchanged
(for example, when changing only the condition or resource name),
set subparameter qualifier to question marks in parameter N.
To change only a specific occurrence of an existing condition or
resource, specify the existing occurrence data in subparameter
qualifier of parameter O.
To change all occurrences of an existing condition or resource, set
subparameter qualifier to question marks in parameter O.

BMC Software, Inc., Confidential and Proprietary Information

3-124

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

Partial Names (Generic Changes)

Parameter P=position is used to indicate that names in parameters N= and O=
are partial names.
(When parameter P is not specified, the condition or resource names in both
parameter N and parameter O are treated as full 20-byte names, padded with
trailing blanks if necessary.)
Either of two values can be specified for subparameter P:

A 1-digit or 2-digit numeric value less than or equal to 20, indicating a

character position within the condition or resource name in the job
scheduling definition. This character position represents the first
character position of the name to be used.

When a numeric value is specified, the name specified in parameter N

and/or parameter O is assumed to be a partial name that begins at the
specified position in the condition or resource name.

Example

Assume parameters O=BKP and P=5 are specified.

If parameter N is not specified, condition or resource TAPEBKP01 is

deleted.

If parameter N=BAC is specified, condition or resource TAPEBKP01 is

renamed TAPEBAC01.

P=*
This value indicates that the character string in the condition or resource
name field that matches the name or string specified in parameter O= is
replaced by the name or string specified in parameter N=, regardless of
character position. In this case, multiple replacements can occur.
If, in attempting to replace a string with a longer string, and the condition
or resource name becomes longer than 20 characters, the change is not
performed.
Note:

When parameter P=* is specified, the value of subparameter

qualifier in both parameter N and parameter O is treated as if ?s
were specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-125

CTMTBUPD Update Job Scheduling Tables

Miscellaneous Parameters
The following parameters are used to add, update, or delete job scheduling
parameters that can occur multiple times in the job scheduling definition:
Table 3-53

Parameter
SETVAR

CTMTBUPD Miscellaneous Parameters

Description
The format of parameter SETVAR is

SETVAR=%%variable=var-value
If the variable name obtained by resolving %%variable is found in
the job scheduling definition, its original value is replaced by
var-value. Otherwise, a new SETVAR parameter is created by
setting the resolved variable name to var-value.
If var-value is null, the variable to which %%variable resolves is
deleted from the job scheduling definition.
MONTHS

The format of parameter MONTHS is

MONTHS=xxxxxxxxxxxx (12-character value)

where each x can be Y (Yes), N (No), blank or ?.
Each blank, Y (Yes) or N (No) value replaces the original value of
the corresponding month in parameter MONTHS. Each value of
? causes the corresponding month in parameter MONTHS to be
retained.

Note:

No update parameter in the file referenced by DD statement

DAINPRM can appear more than once in a SEL group.

Utility Control Statements

Table 3-54

CTMTBUPD Utility Control Statements (Part 1 of 2)

Statement

Description

SCHDMAX=
nnnnn

Maximum number of job scheduling tables in the

CONTROL-M job scheduling library specified in the CTMSCH
DD statement. The SCHDMAX control statement must
precede the first SEL group. 1 to 5 digits. Default: 10000.

SLINMAX=
nnnnn

Maximum number of lines contained in a job scheduling table.

The SLINMAX control statement must precede the first SEL
group. 1 through 5 digits. Default: 40000.

BMC Software, Inc., Confidential and Proprietary Information

3-126

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

Table 3-54

CTMTBUPD Utility Control Statements (Part 2 of 2)

Statement

Description

ENDSEL

End of a SEL group. Mandatory if more than one SEL group

is specified.

GENERIC-CHAR=
alt_char

By default, both selection control statements (described on

page 3-116) and update parameters (described in Table 3-51
on page 3-118) use the asterisk (*) to indicate generic
processing. However, because an asterisk can also be a valid
part of a parameter value, you can designate an alternate
character as the generic indicator.
To specify an alternate indicator, use the GENERIC-CHAR
statement, where alt_char is any single character except a
blank ( ), comma (,), period (.), or question mark (?).

The GENERIC-CHAR control statement can appear anywhere in the

DAINPRM file and can be specified multiple times with different values.

JCL Required to Execute CTMTBUPD

A sample JCL can be found in member CTMTBUPD in the CONTROL-M
JCL library.

Examples
Example 1

In every job scheduling definition

Change the following:

DAYS value to: D7,-5,+9

WDAYS value to: L1,D2W3
PRIORITY value to: *5
MEMLIB prefix to: NEWPREF

Add Control resource ENQUE-RES in share mode.

Delete AutoEdit variable %%ABC (using SETVAR).

Add one hour to all FROM time values.

To make the above changes, place the following statements in the DAINPRM
file:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-127

CTMTBUPD Update Job Scheduling Tables

Figure 3-37

CTMTBUPD Example 1

SEL
DAYS=D7,-5,+9
WDAYS=L1,D2W3
PRIORITY=*5
CONTROL,N=(ENQUE-RES,S)
SETVAR=%%ABC=
MEMLIB=NEWPREF.*
TIMEFROM=+0100
ENDSEL

Example 2

In job scheduling definitions beginning with XYZ in tables beginning with

QRS:

Change all underscore characters to dashes in the IN and OUT

conditions.

Change quantitative resources that begin with prefix TAPE to prefix

CARTRIDGE.

Change Exclusive Control resource EXCLUSIVE_RES to Shared

Control resource SHARE_RES.

To make the above changes, place the following statements in the DAINPRM
file:
Figure 3-38

CTMTBUPD Example 2

SEL TBL=QRS*,JOB=XYZ*
IN,N=(-,????),O=(_,????),P=*
OUT,N=(-,?????),O=(_,?????),P=*
RESOURCE,N=(CARTRIDGE,????),O=(TAPE,????),P=1
CONTROL,N=(SHARE_RES,S),O=(EXCLUSIVE_RES,E)
ENDSEL

Example 3

In all job scheduling definitions in group GROUP1 whose application name

begins with OLD:

Change the application name prefix to NEW.

Add IN condition NEW-COND with a date option of PREV.

BMC Software, Inc., Confidential and Proprietary Information

3-128

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Update Job Scheduling Tables

Change OUT condition OUT-COND to OUT-COND with a date option

of ODAT+, regardless of the conditions original date.

Specify that jobs are not scheduled in April and May. Do not change the
monthly scheduling criteria for any other months.

Delete all the Quantitative resources that have value DISK3330

beginning in column 5 of the resource name.

To make the above changes, specify the DAINPRM file as follows:

Figure 3-39

CTMTBUPD Example 3

SEL GRP=GROUP1,APPL=OLD*
APPL=NEW*
IN,N=(NEW-COND,PREV)
OUT,N=(OUT-COND,ODAT+),O=(OUT-COND,?????)
MONTHS=???NN???????
RESOURCE,O=(DISK3330,????),P=5
ENDSEL

Example 4

In all group scheduling definitions, in schedule tags whose names begin with
GRP-TAG change:
Table 3-55

CTMTBUPD Schedule Tags

DAYS value to:

D1P*

DCAL value to:

PERIODIC

CONFCAL value to:

blanks

MONTHS value to:

blanks

To make the above changes, specify the DAINPRM file as follows:

Figure 3-40

CTMTBUPD Example 4

SEL
TAG=GRP-TAG*
DAYS=D1P*
DCAL=PERIODIC
CONFCAL=
MONTHS=
ENDSEL

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-129

CTMXRF Create Cross-Reference Reports

CTMXRF Create Cross-Reference Reports

Utility CTMXRF produces the following cross-reference reports:

Calendar Name / Job Name

Condition Name
Job Name / Scheduling Table Name
Resources / Job Name
Library Name / Job Name
Schedule Tag / Job Name
Time / Job Name

Utility CTMXRF receives parameters from an input file referenced by

DD statement DAXRFIN. This input file can contain the following types of
statements:

Cross reference report action statements, which specify types of reports.

Control statements, which control the operation of the utility.
Comment statements, which contain an asterisk in column one.

DAXRFIN must be an 80-byte card image file and the control statements
must begin in column one. Embedded blanks are not allowed.

Cross Reference Report Action Statements

Format of the cross-reference report action statement is:
XRF=report-type[,PARM=parm]

Valid values for report-type:

Table 3-56

CTMXREF Cross-Reference Statements (Part 1 of 2)

Statement

Description

CAL

Produces the Calendar/Job Name Cross Reference report. This

report identifies job scheduling definitions that use a calendar
and indicates whether the calendar is a DCAL, WCAL, or
CONFCAL calendar.
To restrict the report to jobs whose calendar name begins with
the prefix calpref, specify PARM=calpref*.

BMC Software, Inc., Confidential and Proprietary Information

3-130

INCONTROL for OS/390 and z/OS Utilities Guide

CTMXRF Create Cross-Reference Reports

Table 3-56

CTMXREF Cross-Reference Statements (Part 2 of 2)

Statement

Description

CND

Produces the Job Condition Name Cross Reference report. This

report lists conditions that are contained in:
CONTROL-M job scheduling tables
CONTROL-O SolveWare and/or rules
CONTROL-M/Tape rules
CONTROL-D or CONTROL-V or CONTROL-M/Analyzer report
and/or mission condition
Each entry in the report indicates the table name, job name,
product code (M for CONTROL-M, O for CONTROL-O, and so
on), condition type (I=IN, O=OUT, C or T=DOCOND), and status
(+/-) for the condition.
To restrict the report to condition names that begin with the prefix
condpref, specify PARM=condpref*.
To restrict the report to a specific condition date reference,
specify PARM=|dateref where dateref can be a specific date
reference (in ddmm or mmdd format according to the site
standard), or a specific date keyword such as STAT, PREV,
NEXT, ****.
(The first character of dateref above is a vertical bar, hex code
4F.)
To restrict the report to long conditions (conditions with condition
names longer than 20 characters), specify PARM=|CONT.

JOB

Produces the Job Name/Scheduling Table Name Cross

Reference report. This report identifies which job scheduling
tables contain jobs.
To restrict the report to tables whose job names begin with the
prefix jobpref, specify PARM=jobpref*.

RES

Produces the Resources/Job Name Cross Reference report. This

report identifies CONTROL-M jobs or CONTROL-O rules that
use resources and indicates the type, quantity and state of the
resources.
To restrict the report to resource names that begin with the prefix
respref, specify PARM=respref*.

LIB

Produces the Library Name/Scheduling Table Name Cross

Reference report. This report identifies which jobs specify
MEMLIB, OVERLIB, DOCLIB or PDS libraries.
To restrict the report to libraries of a specific type, specify
PARM=libtype. Valid libtype values: MEM, OVR, DOC and PDS.

TAG

Produces the Schedule Tag Name/Job Name Cross Reference

report. This report identifies which jobs or groups specify
schedule tags.
To restrict the report to jobs or groups whose schedule tags
begin with the prefix tagpref, specify PARM=tagpref*.

TIM

Produces the Time/Job Name Cross Reference report. This

report identifies jobs with a time criteria (TIME FROM, TIME
UNTIL or DUE OUT TIME).
To group reports by time intervals, specify PARM=n, where n=2,
3 or 4.
n=2 groups jobs by hourly intervals.
n=3 groups jobs by 10 minute intervals.
n=4 groups jobs by 1 minute intervals.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-131

CTMXRF Create Cross-Reference Reports

Utility Control Statements

Utility control statements are only necessary if the program default values are
inadequate.
Table 3-57

CTMXREF Utility Control Statements

Statement

Description

SCHDMAX=
nnnnnn

Maximum number of members in the CONTROL-x library or

libraries being searched. 1 through 6 digits. Default: 10000

SLINMAX=
nnnnnn

Maximum number of lines contained in a member of the

CONTROL-x library or libraries. 1 through 6 digits.
Default: 40000.

All utility control statements must precede the first action statement.

JCL Required to Execute CTMXRF

A sample JCL to run the utility can be found in member CTMXRF in the
CONTROL-M JCL library.
Note:

Do not code DD DUMMY or DSN=NULLFILE for any

DD statement whose DD name begins with CTx. If a DD statement is
not needed to run the utility, remove it.

Example

Produce the following cross-reference reports:

Condition name cross-reference reports for all STAT (static) conditions.

Calendar name cross-reference of all calendars in use in the

CONTROL-M job scheduling library.

Three time or job name cross-reference reports (FROM, UNTIL and

DUE OUT time) grouped by 10 minute time intervals.

To produce the above reports, specify the file referenced by DD statement

DAXRFIN as follows:
XRF=CND,PARM=|STAT
XRF=CAL
XRF=TIM,PARM=3

BMC Software, Inc., Confidential and Proprietary Information

3-132

INCONTROL for OS/390 and z/OS Utilities Guide

CTMXRF Create Cross-Reference Reports

Sample Output Reports

Figure 3-41

CTMXREF Job Name or Table Name Cross Reference Report

CONTROL-M 6.0.00
JOB-NAME/TABLE-NAME CROSS REFERENCE REPORT
BMC SOFTWARE, INC.
===================================================================
PAGE
JOBNAME
CYCLIC
DAILYPRD
DAILYSYS
DEMO1
DISKLOG1
DROOR
DUMMY
EMPTY
ENDEV*
ENDEVOR
EXIT2JOB
E05TEST1
FIRSTJOB
IEFBR14

T A B L E
DEMO
MAINDAY
MAINDAY
N86
ADABASM
N86
E01SCHED
DEMO
SENDEVOR
SENDEVOR
OPHIR4
E05TEST
N86
DANNY
N86

Figure 3-42

N A M E S

N88dsktp N88GRP

N88GRP1

CTMXREF Resource Name / Job Name Cross Reference Report

CONTROL-M 6.0.00
RESOURCE NAME/JOB NAME CROSS REFERENCE REPORT
BMC SOFTWARE, INC.
===================================================================
PAGE

RESOURCE NAME
TYP TABLENAM JOB/RULE QU/ST TABLENAM JOB/RULE QU/ST TABLENAM JOB/RULE QU/ST
ASA
C N88TST
JOB13
E
N88TST
JOB63
E
N88TST1 JOB63
E
N88TST2 JOB13
E
N88TST2 JOB63
E
N88TST3 JOB63
E
N88TST4 JOB13
E
N88TST4 JOB63
E
CARTINIT
Q N88dsktp WAIT
0010 N88TEST WAIT
0010 N88TEST1
CONT1
C N88TST
JOB4
S
N88TST
JOB52
S
N88TST1 JOB52
S
N88TST2 JOB4
S
N88TST2 JOB52
S
N88TST3 JOB52
S
DBA-ADAFILE-12
C ADABASM BACKUP12 E
DBA-ADAFILE-7
C ADABASM BACKUPF7 E
ADABASM READF7
S
DISK-MVS003
C DEMO
BEACH
E
DORES
T MK
MKJOBARR 1111 MK
STR2
1111
DORES2
T MK
MKJOBARR 2222- MK
STR2
2222DORES3
T MK
MKJOBARR 0333+ MK
STR2
0333+
E02.NU1
C NU1
JOB1
E
NU1
JOB2
S
NU1
JOB2
S
C NU1
JOB2
E
NU1
JOB2
E
NU1
JOB2
E

Figure 3-43

CTMXREF Calendar Name or Job Name Cross Reference Report

CONTROL-M 6.0.00
CALENDAR NAME/JOB NAME CROSS REFERENCE REPORT
BMC SOFTWARE, INC. ===============================================================
CALENDAR TYP TABLENAM
ALLWEEK
W CALENDW
ALLYEAR
D CALENDY
CALENDM
HOLIDAY
C N88GRP
CONFC
C E01SCHED
DCAL
D E01SCHED
WCAL
W E01SCHED
WEEKCAL
W N88GRP
WORKDAYS W CALENWK

JOB/GRP
JOB3
VACN
NIS3
VACN
DUMMY
DUMMY
DUMMY
VACN
WKDAY

PAGE

TABLENAM JOB/GRP

TABLENAM JOB/GRP

TABLENAM JOB/GRP

TABLENAM JOB/GRP

N88TEST
N88TEST

N88TEST
N88TEST

N88TEST

N88TEST

IEFBR14
NIS4

JOB1
NIS5

JOB2

NIS1

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-133

CTMXRF Create Cross-Reference Reports

Figure 3-44

CTMXREF Schedule Tag or Job Name Cross Reference Report

CONTROL-M 6.0.00
SCHEDULE TAG/JOB NAME CROSS REFERENCE REPORT
BMC SOFTWARE, INC. ===============================================================
SCHEDULE TAG
A

JOB/GRP
A
T4
GRP1
GRP2
GRP3
GRP4
GRPTEST

TABLENAM JOB/GRP
ECSGRP
ECSGR1
GRP
T5

TABLENAM JOB/GRP
ECSGRP
J1
GRP
T6

N88GRP1

N88GRP1

PAGE

SCHEDTAG1000
SCHEDTAG1001
SCHEDTAG1002
SCHEDTAG1002
ALL

Figure 3-45

CTMXREF From - Until - Due Out Time or Job Name Cross Reference Report

IEFBR14

TABLE JOB/GRP
ECSGR
GRP

TABLENAM
A1
GRP
N88GRP
N88GRP
N88GRP
N88GRP
N88GRP1

TABLE JOB/GRP

IEFBR15

CONTROL-M 6.0.00
FROM
TIME/JOB NAME CROSS REFERENCE REPORT
** INTERVAL=60 MINUTES **
BMC SOFTWARE, INC. ===============================================================
PAGE
1
TIME
0000
0600
0800
1100
1400
1700

TABLENAM
ADABASM
MAINDAY
DEMO
N86
N88TST
TABLE01

JOB/GRP
NOMPM
CTMCLRES
BEACH
DEMO1
JOB100
BACKUPF7

TABLENAM JOB/GRP

N86
N88TST1
M37A

TABLENAM JOB/GRP

FIRSTJOB N86
JOB100
N88TST2
M37BR14

IEFBR14
JOB100

TABLENAM JOB/GRP

TABLENAM JOB/GRP

N88TST3

N88TST4

JOB100

JOB100

CONTROL-M 6.0.00 UNTIL TIME/JOB NAME CROSS REFERENCE REPORT

** INTERVAL=60 MINUTES **
BMC SOFTWARE, INC. ===============================================================
PAGE
TIME
0900
1700
1900
2100
2300

TABLENAM
MAINDAY
DEMO
M37A
N86
TABLE01

JOB/GRP TABLENAM JOB/GRP TABLENAM JOB/GRP

CTMCLRES M37A
M37BR14
BEACH
M37BR14
DEMO1
N86
FIRSTJOB N86
IEFBR14
BACKUPF7

TABLENAM JOB/GRP

TABLENAM JOB/GRP

CONTROL-M 6.0.00
DUEOUT TIME/JOB NAME CROSS REFERENCE REPORT
** INTERVAL=60 MINUTES **
BMC SOFTWARE, INC. ===============================================================
PAGE
1
TIME
1200
1500
2000

TABLENAM
N86
N88GRP
N88TST

JOB/GRP
IEFBR14
QQQQ
JOB100

Figure 3-46

TABLENAM JOB/GRP

TABLENAM JOB/GRP

TABLENAM JOB/GRP

TABLENAM JOB/GRP

N88TEST
N88TST1

N88TEST
N88TST2

N88TST3

N88TST4

NIS4
JOB100

NIS5
JOB100

JOB100

CTMXREF Condition Name Cross-Reference Report

CONTROL-M 6.0.00
CONDITION NAME CROSS REFERENCE REPORT
BMC SOFTWARE, INC. ===============================================================
CONDITION-NAME
+
%%APPLID-RUNNING
A
JOHN1-OK
JOHN2-OK
JOHN3-OK
ANG-1
ANG1WT1
ANG1WT1-OUT

JOB100

TABLE JOB/RUL/CAT O
E06QA
ANG1RD1 MI
SAMPLES CONTROL OT+
N88TST
JOB22
MC+
N88TST1 JOB42
MC+
M37A
M37BR14 MI
M37A
M37BR14 MI
M37A
M37BR14 MO+
E01ANLZ ANG1RD1 MI
E06QA
ANG1RD1 MI
E02OS390 ANG1RD1 MI

TABLE

JOB/RUL/CAT O

N88TST
N88TST1
M37A
M37A

JOB42
JOB72
M37BR14
M37BR14

E01ANLZ ANG1WT1
E06QA
ANG1RD2
E02OS390 ANG1RD2

TABLE

PAGE

JOB/RUL/CAT O

MC+ N88TST
MC+ N88TST1
MO+
MI M37A

TABLE

1
JOB/RUL/CAT O

JOB92
JOB22

MC+ N88TST1
MC+ N88TST2

M37BR1

MO+

MO+
MI E06QA
ANG1WT
MI E02OS390 ANG1WT

MO+
MO+

JOB22
JOB42

MC+
MC+

BMC Software, Inc., Confidential and Proprietary Information

3-134

INCONTROL for OS/390 and z/OS Utilities Guide

CTMXRF Create Cross-Reference Reports

Figure 3-47

CTMXREF Library Name or Job Name Cross Reference Report

CONTROL-M 6.0.00
LIBRARY NAME/JOB NAME CROSS REFERENCE REPORT
BMC SOFTWARE, INC ===============================================================
LIBRARY NAME
*
CTL.DUMMY.LIB
CTM.V600.JCLP%%OMONTH.%%ODAY
CTMP.UPG5.DOC
DOC CTRDEMO

PRODJOB1 CTRDEMO

TYP TABLENAM
MEM ADABASM
MEM CTLJCLTB
MEM REPTS
DOC A1
ECSGRP
J2
PRODJOB2 CTRDEMO PRODJOB3

JOBNAME
DISKLOG1
CTLJOB
REPTSJ1
A
N88GRP

PAGE

TABLENAM JOBNAME TABLENAM JOBNAME

ADABASM DISKLOG2 ADABASM MPMXXX
REPTS
REPTSJ2
ECSGRP
A4
IEFBR16 N88TEST

ECSGRP
G3
SYSOUT CTMP.V600.DOC

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-135

CTMRJDS Produce Job Dataset Cross Reference Report

CTMRJDS Produce Job Dataset Cross Reference

Report
The CTMRJDS utility provides a cross reference report, by dataset, of jobs
that access the dataset.
Note:

This utility is available and can be run only if CONTROL-M/Restart

is installed at your site.

For the report to be generated, it is first necessary to generate a list of datasets

accessed by the job. This list can be generated in either of the following
ways:

Use the Job Dataset List utility (Online Utility option R3, described in
the CONTROL-M/Restart User Guide).

Use supplied procedure CTMJDS (described below) to generate the list

for one or all of the jobs in a scheduling table.

In either case, the Job Dataset list is generated in the Statistics file.

Procedure CTMJDS Generating the Job Dataset List

Procedure CTMJDS can be used to generate the Job Dataset list in the
Statistics file. This list is required by the procedure that generates the Job
Dataset Cross Reference report.
Note:

This utility is available and can be run only if CONTROL-M/Restart

is installed at your site.

Parameters for utility CTMRJDS are submitted in blocks. If multiple blocks

are specified, all mandatory parameters must be specified in each block.
(parameters WDATE and ODATE are always optional.)
The following parameters are supplied to procedure CTMJDS.
Table 3-58

CTMJDS Parameters (Part 1 of 2)

Parameters

Description

SCHEDLIB

Name of the scheduling library. Mandatory.

TABLE

Scheduling table member name. Mandatory.

JOB

Name of one single job, or asterisk for the whole table.

Mandatory.

BMC Software, Inc., Confidential and Proprietary Information

3-136

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRJDS Produce Job Dataset Cross Reference Report

Table 3-58

CTMJDS Parameters (Part 2 of 2)

Parameters

Description

WDATE

Working date of the job, in 6character date format according

to the site standard. Optional.

ODATE

Original scheduling date of the job, in 6character date format

according to the site standard. Optional.

SUBMIT

CONTROL-M attempts to resolve the AutoEdit statements. If

successful, the JCL member lines are also written to the file
referenced by DD statement DASUBMIT, and the member is
submitted by the utility for execution. In this case, MVS also
checks the JCL. This option can also be used to submit jobs
when the CONTROL-M monitor is not active (for example, if
there is a severe technical problem). Mandatory.

Example
Figure 3-48

CTMJDS Example

//JDSN EXEC CTMJDS

//SYSIN
DD *
SCHEDLIB CTM.PROD.SCHEDULE
TABLE
N04
JOB
@BR14
[{WDATE|ODATE} date]
SUBMIT
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-137

FORMCKP Allocate, Format, and Resize the Active Jobs File

FORMCKP Allocate, Format, and Resize the

Active Jobs File
Utility FORMCKP allocates and formats the Active Jobs file (AJF, formerly
called file CKP), and its associated backup file (BKP, which is used as a
recovery file to recover from procedure CONTDAY failures). Usually this
utility is used in order to enlarge the current AJF and its associated BKP files.
When you run these steps make sure you stop CONTROL-M, and that online
users are not logged onto the IOA environment.

Activating the Utility

Step 1

Enter the ICE CUSTOMIZE activity for product ID CTM.

Step 2

Select major step Customize CONTROL-M Dataset Parameters, minor step

CONTROL-M Datasets Parameters.

Step 3

Change parameter AJFSIZE with the new AJF size.

Step 4

Perform step Save Parameters into Product Libraries.

Step 5

Perform step Format the Active Jobs File, and submit the job. This step
allocates and format a new AJF and its associated BKP, and you must make
sure you use different name for the newly formatted files.

Step 6

If DUALDB is active at your site, you must run step Format the Dual Active
Jobs file. Also, this step is necessary to allocate and format a new Dual AJF
based on the same AJF size.

Step 7

If Journaling is active at your site, you must run step Format the Journaling
Active Jobs file. Also, this step is necessary to allocate and format a new
Journal Active Jobs file based on the same AJF size.

Step 8

Rename the original AJF and its associated BKP files (and the ALTCKP and
CKPJNL, if you run steps 6 and/or 7 above), using any new name, then
rename the new AJF and BKP files (and ALTCKP and CKPJNL) to the
original file name.

Step 9

If you want to copy the contents of the old AJF, use utility CTMCAJF, and
set the appropriate old and new AJF files accordingly. There is no need to
copy the BKP, ALTCKP and CKPJNL files, since at startup CONTROL-M
takes care of these files.

Step 10

Resume all activities against the new files (meaning, start CONTROL-M
monitor, reenter IOA online environment, and so on.)

BMC Software, Inc., Confidential and Proprietary Information

3-138

INCONTROL for OS/390 and z/OS Utilities Guide

FORMCKP Allocate, Format, and Resize the Active Jobs File

Return Codes
Table 3-59

FORMCKP Return Codes

Code

Description

Operation performed successfully

One of the following errors occurred:

OPEN FAILED FOR DCBOUT (MESSAGES) FILE OR THE
AJF or BKP FILE
AJF or BKP FILE COULD NOT BE FORMATTED
OPEN or LOAD OF LOG FAILED

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-139

FORMHST Allocate and Format the History Jobs File

FORMHST Allocate and Format the History Jobs

File
Utility FORMHST allocates and formats the History Jobs file (HST). Usually
this utility is used in order to enlarge the current History Jobs file. When you
run these steps make sure that online users are not logged-on to the IOA
environment.

Activating the Utility

Step 1

Enter ICE Customize activity for CTM.

Step 2

Select major step "Customize CONTROL-M Dataset Parameters", minor step

"CONTROL-M Datasets Parameters".

Step 3

Change parameter HSTSIZE with the new History Jobs file size

Step 4

Perform step "Save Parameters into Product Libraries".

Step 5

Perform step Format the History Active Jobs File, and submit the job. This
step allocates and formats a new HST file. The DD statement points to the
History Active Jobs file.

Step 6

Rename the original HST file, using any new name, then rename the new
HST file to the original file name.

Step 7

If you want to copy the contents of the old HST, use utility CTMHCOP, and
set the appropriate old and new HST files accordingly.

Step 8

Resume all activities against the new file (meaning, reenter IOA online
environment)

BMC Software, Inc., Confidential and Proprietary Information

3-140

INCONTROL for OS/390 and z/OS Utilities Guide

FORMHST Allocate and Format the History Jobs File

Return Codes
Table 3-60

FORMHST Return Codes

Code

Description

Operation performed successfully

One of the following errors occurred:

OPEN FAILED FOR DCBOUT (MESSAGES) FILE OR THE
HST FILE
HST FILE COULD NOT BE FORMATTED
OPEN or LOAD OF LOG FAILED

BMC Software, Inc., Confidential and Proprietary Information

Chapter 3 CONTROL-M Utilities

3-141

FORMHST Allocate and Format the History Jobs File

BMC Software, Inc., Confidential and Proprietary Information

3-142

INCONTROL for OS/390 and z/OS Utilities Guide

34

Chapter 4

CONTROL-M/Analyzer
Utilities

This chapter provides a detailed description of the CONTROL-M/Analyzer

utilities.
Note:

Some utilities prefixed by IOA replace corresponding utilities

prefixed by CTB in previous versions. In such cases, the old utilities
are supported for your convenience; however, you should use the
IOA utilities.

CTBABI Initialize Active Balancing File . . . . . . . . . . . . . . . . . . . . . . . 4-3

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
CTBCMP Compile Rule Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
CTBDBCP Increase Size of a Database File . . . . . . . . . . . . . . . . . . . . . 4-5
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Procedure CTBDBCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
CTBDBIB Rebuild a CONTROL-M/Analyzer Index File . . . . . . . . . . 4-8
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
CTBDBVCG Change Number of Variable Generations . . . . . . . . . . . . 4-11
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
CTBDBVCP Copy Variables or Groups to Another File . . . . . . . . . . . 4-14

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-1

Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
CTBDBVDL Delete Variables or Groups from Variable or Group Files4-17
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
CTBDBVIG Check the Integrity of Variable or Group Files. . . . . . . . . 4-19
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
CTBFRM Compress the Active Balancing File . . . . . . . . . . . . . . . . . . . 4-21
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
CTBJAFCP Copies Entries in Rule Activity or Report Files. . . . . . . . . 4-23
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
CTBJAFDL Deletes Entries from Rule Activity or Report Files. . . . . . 4-26
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
CTBJAFIG Check the Integrity of Rule Activity or Report Files . . . . . 4-28
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
CTBVXRF Cross-Reference Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Report Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32

BMC Software, Inc., Confidential and Proprietary Information

4-2

INCONTROL for OS/390 and z/OS Utilities Guide

CTBABI Initialize Active Balancing File

CTBABI Initialize Active Balancing File

Utility CTBABI initializes both the Active Balancing file and its backup file,
ABFBKP. Activate utility CTBABI whenever utility IOADBF reformats
these files.

Parameters
The following parameter must be specified in the EXEC statement that
invokes the CTBABI JCL procedure.
Table 4-1

CTBABI Parameters

Parameter

Description

DBFILEB

Name of the file to initialize:

ABF Active Balancing file.
ABFBKP Backup file of the Active Balancing file.

Activating the Utility

//

EXEC CTBABI, DBFILEB=[ABF|ABFBKP]

Return Codes
Table 4-2

CTBABI Return Codes

Code

Description

Operation successful

other

Operation failed

Example
//

EXEC CTBABI,DBFILEB=ABF

This utility is used by the CREFABF and CREFBKP jobs, located in the
INSTWORK library, when the Active Balancing file and its backup file are
created. For additional examples, see these jobs.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-3

CTBCMP Compile Rule Definitions

CTBCMP Compile Rule Definitions

Utility CTBCMP checks the syntax of rule definitions. It is especially useful
for checking rule definitions created using a standard editor.

Parameters
Parm=-irulename

where rulename is the name of the rule definition that must be checked for
syntax errors. The rule name is preceded by the prefix i (that can be
uppercase or lowercase). The rule name and the i prefix must be specified
between quotes.

Activating the Utility

//

EXEC CTBCMP,PARM=-irulename

Return Codes
Table 4-3

CTBCMP Return Codes

Code

Description

No syntax errors were found

other

Syntax errors were found

Example
//
EXEC CTBCMP,PARM=-ICOMPTOTS
//DABRUL DD DISP=SHR,DSN=CTB.PROD.RULES

BMC Software, Inc., Confidential and Proprietary Information

4-4

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBCP Increase Size of a Database File

CTBDBCP Increase Size of a Database File

This utility copies the contents of a specified source file to a specified target
file. All relevant aspects of the file are copied, including (pointers to) variable
definitions, variable generations, and group information.
The sizes of the source and target files can differ. Therefore, utility
CTBDBCP is useful for increasing the size of a file. Usually, this utility
copies data from a source file to a larger target file.
Copying a file is composed of the following stages:

Create and format a new file (target file).

Copy the data from the source file to the newly created target file.
Delete the source file.

Utility CTBDBVCP can modify all CONTROL-M/Analyzer database files

simultaneously. However, utility CTBDBCP is more efficient than utility
CTBDBVCP when modifying a single file.

Parameters
The following parameters must be specified in the EXEC statement that
invokes the CTBDBCP JCL procedure.
Table 4-4

CTBDBCP Parameters (Part 1 of 2)

Parameter

Description

DBFILE

Name of the file to be enlarged. (Add the suffix .OLD to the name
of the input file before the JCL procedure is executed.) The
specified name becomes the name of the enlarged output file.
Mandatory.
Valid names must contain one of the following suffixes:

OLDQNAME

FILE TYPE

SUFFIX

Group
Database Variable
Variable Generation
Report
Rule Activity

GRP
MOD
VAR
REP
JAF

QNAME of the input file (for validity checking only). Mandatory.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-5

CTBDBCP Increase Size of a Database File

Table 4-4

CTBDBCP Parameters (Part 2 of 2)

Parameter

Description

KEY

Type of index file to be generated. Mandatory. Valid values are:

FILE TYPE

VALUE

Group
Database Variable
Variable Generation
Report
Rule Activity

KEYGRP
KEYDBM
KEYDBV
KEYREP
KEYJAFJ

Note: The KEY value matches an existing descriptor member

supplied in the CONTROL-M/Analyzer PARM library.
DUAL

Indicates if a mirror image file is maintained. Mandatory. Valid

values:
TRUE Use this value if DUAL is set to Y (Yes) in the
respective DEF* member in the INSTWORK library.
FALSE Use this value if DUAL is set to N (No) (the default
value) in the respective DEF* member in the INSTWORK
library.

Activating the Utility

//
//

EXEC IOADBF,FUNC=INIT,D=INSTWORK,M=DEFxxxD
EXEC CTBDBCP,DBFILE=xxx,OLDQNAME=qname,KEY=KEYyyy

allocate new file

copy old contents

Valid values for xxx and yyy are:

Table 4-5

CTBDBCP File Type Values

File Type

xxx

yyy

Group

GRP

GRP

Database Variable

MOD

DBM

Variable Generation

VAR

DBV

Report

REP

REP

Rule Activity

JAF

JAFJ

Return Codes
Table 4-6

CTBDBCP Return Codes

Code

Description

Copy operation performed successfully

other

Descriptive execution error, copy operation failed

BMC Software, Inc., Confidential and Proprietary Information

4-6

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBCP Increase Size of a Database File

Procedure CTBDBCP
Member CTBDBCP of the IOA PROCLIB library contains a procedure that
calls a series of programs to automatically enlarge a database file. The
following explanation assumes that the name of the file that needs to be
enlarged is ...GRPD. Before using this procedure, perform the following
steps:
1. Rename the source input file from ...GRPD... to ...GRPD...OLD. For
example, rename file CTB.V600.GRPD.E000 to
CTB.V600.GRPD.E000.OLD
2. If DUAL is set to Y (Yes) in member DEFGRPD in the INSTWORK
library, rename file CTB.V600.GRPD.D000 to
CTB.V600.GRPD.D000.OLD.
3. Modify member DEFGRPD in the INSTWORK library by increasing the
space allocated for the file.
4. Run the job in member CREFGRP of the INSTWORK library.
When the procedure described above is called, the following actions are
performed:
1. Program IOADBF formats a new preallocated IOA Access Method
output file.
2. Program CTBDBCP copies data from the input file to the output file.
3. Program IOADIG verifies the integrity of the output file data component.
4. Program IOADBF reformats the existing index component for the file.
5. Program IOADIB rebuilds the index component.
6. Program IOADPT prints index and data component control records to the
output file.
For additional information, see sample member JDBCP in the JCL library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-7

CTBDBIB Rebuild a CONTROL-M/Analyzer Index File

CTBDBIB Rebuild a CONTROL-M/Analyzer Index

File
Utility CTBDBIB rebuilds index files for various CONTROL-M/Analyzer
data files. The new index files correspond to information contained in the
data files.
This utility rebuilds the indexes of a specific data file.
Note:

The index file that is to be rebuilt must be allocated and formatted

prior to activating the utility.

This utility is used:

When the space remaining for the existing index file is insufficient. In
this case:

Delete the index file.

Redefine the index file with the required amount of space.
Format the index file with utility IOADBF.
Rebuild the index file with utility CTBDBIB.

In case of index file integrity problems: Index file integrity problems can
be detected using utility IOADII, described later in this guide.

In case of data file integrity problems: Correct the data file and re-index
it with utility CTBDBIB to reproduce the corresponding index file.

Parameter
The following parameter can be specified in the EXEC statement that invokes
the CTBDBIB JCL procedure.
Table 4-7

CTBDBIB Parameter

Parameter

Description

DBFILE

Name of data file to be processed.

Note:

SYSIN parameters are provided in the KEYyyy members in the

CONTROL-M/Analyzer PARM library for your convenience. File
name specifications are hard coded (predefined) in these members.

BMC Software, Inc., Confidential and Proprietary Information

4-8

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBIB Rebuild a CONTROL-M/Analyzer Index File

Activating the Utility

//
EXEC
//SYSIN DD
//DAyyy DD

CTBDBIB,DBFILE=xxxD
DSN=CTB.PROD.PARM(KEYyyy),DISP=SHR
DSN=CTB.PROD.xxxI,DISP=SHR

Valid values for xxx and yyy are:

Table 4-8

CTBDBIB Values

File Type

xxx

yyy

Group

GRP

GRP

Database
Variable

MOD

DBM

Variable
Generation

VAR

DBV

Report

REP

REP

Rule Activity

JAF

JAFJ

Return Codes
Table 4-9

CTBDBIB Error Codes

Code

Description

Operation performed successfully

other

Operation failed

Example

//
EXEC
//SYSIN
DD
//DAGRP
DD

CTBDBIB,DBFILE=GRPD
DSN=CTB.PROD.PARM(KEYGRP),DISP=SHR
DSN=CTB.PROD.GRPI,DISP=SHR

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-9

CTBDBIB Rebuild a CONTROL-M/Analyzer Index File

Utility CTBDBIB is used by the following jobs in the JCL library. For
additional examples, see the following jobs:
Table 4-10

CTBDBIB Jobs

Job

Description

JOBBDBM

Rebuilds the index of the Database Variable Basic file.

JOBBDBV

Rebuilds the index of the Generation file.

JOBBGRP

Rebuilds the index of the Group file.

JOBBJAF

Rebuilds the index of the Rule Activity file.

JOBBREP

Rebuilds the index of the Report file.

BMC Software, Inc., Confidential and Proprietary Information

4-10

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBVCG Change Number of Variable Generations

CTBDBVCG Change Number of Variable

Generations
This utility changes the maximum number of generations specified for one or
more database variables. It is useful whenever the number of generations
must be changed but is most often used when changing the status (mode) of
variables from test to production. The utility can be invoked in batch mode as
described in Activating the Utility.
The number of generations to be retained in the database can be increased or
decreased. The content of existing variable generations can be retained or
deleted. All other relevant aspects of the variables are retained, including
definitions and group information.
It is possible to change the number of generations of all variables, groups of
variables (with a common group name prefix), or one or more variables of
the same group (with a common variable name prefix) in one activation of
utility CTBDBVCG.

Parameters
The following parameters can be specified in the EXEC statement that
invokes the CTBDBVCG JCL procedure. These parameters dynamically
specify source (input) file names and indicate whether the current content of
existing generations must be retained or deleted.
Table 4-11

CTBDBVCG EXEC Parameters

Parameter

Description

DIMOD

Prefix of the third qualifier of the name of the source (input)

Database Variable Basic Data file.

DIVAR

Prefix of the third qualifier of the name of the source (input)

Database Variable Generation Data file.

DIGRP

Prefix of the third qualifier of the name of the source (input)

Group file.

COPY

Valid values are:

Y (Yes) Retain current contents of existing generations.
Default.
N (No) Delete current contents, if any, of existing
generations.

Parameters can also be supplied using DD statement SYSIN. The following

parameters are mandatory:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-11

CTBDBVCG Change Number of Variable Generations

Table 4-12

CTBDBVCG SYSIN Parameters

Parameter

Description

GROUP

Group name (or prefix) of variables to be affected. A group name

prefix can be specified only if parameter VARIABLE contains an
asterisk (*).
Examples:
GROUPINV
Variables of group INV are changed.
GROUPINV*
Variables of all groups that begin with INV (for example, INV,
INVENTORY, INVESTMENTS) are changed.
To change the number of variables for all groups, the SYSIN
input file must be empty (and no GROUP or VARIABLE names
are specified).
Note: Parameter GROUP can be specified only if an asterisk (*)
is specified in parameter VARIABLE.

VARIABLE

Variable name (or prefix) of variables whose number of

generations is changed.
Examples:
GROUP=INV
VARIABLE=TOT
Variable TOT of group INV is changed.
GROUP=INV TOT
VARIABLE=TOT*
Variables of group INV that begin with TOT (for example, TOT,
TOTAL, TOT01, TOT02) are changed.

NUMGEN

New number of generations to be specified for the variable. If not

specified, NUMGEN is set to the default number of generations in
System Variable SYSDBVARGENS.

Activating the Utility

Figure 4-1

CTBDBVCG Activation

// EXEC CTBDBVCG,DIMOD=mod,DIVAR=var,DIGRP=grp,COPY=YES|NO
//SYSIN DD *
GROUP=group
VARIABLE=variable
NUMGEN=new-maximum-#-of-generations
//

BMC Software, Inc., Confidential and Proprietary Information

4-12

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBVCG Change Number of Variable Generations

Return Codes
Table 4-13

CTBDBVCG Return Codes

Code

Description

Operation performed successfully

other

Execution error, operation failed

Figure 4-2

CTBDBVCG Example

//
EXEC CTBDBVCG,DIMOD=MGMT,DIVAR=ACTG,DIGRP=TAX,COPY=YES
//SYSIN DD *
GROUP=BONDS
VARIABLE=COST*
NUMGEN=24
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-13

CTBDBVCP Copy Variables or Groups to Another File

CTBDBVCP Copy Variables or Groups to Another

File
This utility copies the contents of specified group or variable files (meaning,
data from source files) to another set of group or variable files (meaning,
target files). All relevant aspects of the variables are copied, including
definitions, generations and group information.
The sizes of the source and target files can differ. Therefore, utility
CTBDBVCP is useful for increasing the size of variable files. Usually, this
utility copies variables from source files to larger target files.
Copying variables is composed of the following stages:

Create and format a new set of group or variable files (target files).

Copy the data from the source files to the newly created target group or
variable files.

Delete the source files.

It is possible to copy all variables, groups of variables (with a common group

name prefix), or one or more variables of the same group (with a common
variable name prefix) in one activation of utility CTBDBVCP.

Parameters
The following parameters can be specified in the EXEC statement that
invokes the CTBDBVCP JCL procedure. These parameters dynamically
specify the prefix of the third qualifier for the source and destination files
listed below:
Table 4-14

CTBDBVCP EXEC Parameters (Part 1 of 2)

Parameter

Description

DIMOD

Source (input) Database Variable Basic Data file.

DIVAR

Source (input) Database Variable Generation Data file.

DIGRP

Source (input) Group file.

Note: At least one of the above parameters must be specified.
For each input file specified, the parameter (below) for the
corresponding output file must also be specified.

DOMOD

Destination (output) Database Variable Basic file.

DOVAR

Destination (output) Database Variable Generation file.

BMC Software, Inc., Confidential and Proprietary Information

4-14

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBVCP Copy Variables or Groups to Another File

Table 4-14

CTBDBVCP EXEC Parameters (Part 2 of 2)

Parameter

Description

DOGRP

Destination (output) Group file.

REPLACE

Flag that indicates if the source variable overwrites an existing

variable of the same name in the target. Optional.
YES Overwrite the target variable. Default.
NO Do not overwrite the target variable.

COPY

Flag that indicates whether entire records or only variables are

copied. Optional.
YES Copy entire records from the Group file.
NO Copy only variables. Default.

Parameters can also be supplied using DD statement SYSIN. Only one

parameter can be specified on each line.
Table 4-15

CTBDBVCP SYSIN Parameters (Part 1 of 2)

Parameter

Description

GROUP

Group name (or prefix) of variables to be copied. Mandatory. A

group name prefix can be specified only if parameter VARIABLE
contains an *.
Examples:
INV
Variables of group INV are copied. Mandatory.
INV*
Variables of all groups that begin with INV (for example, INV,
INVENTORY, INVESTMENTS) are copied.
Note: Parameter GROUP can be specified only if * is specified
in parameter VARIABLE.

VARIABLE

Variable name (or prefix) to be copied.

Examples:
GROUP=INV VARIABLE=TOT
Variable TOT of group INV is copied.
GROUP=INV VARIABLE=TOT*
Variables of group INV that begin with TOT (for example, TOT,
TOTAL, TOT01, TOT02) are copied.

NUMGEN

Number of generations to be created for the variable during the

copy. If not specified, the number matches the source variables
number of generations. Do not specify more than the number of
existing generations.

FROMGEN

Most recent generation to copy from the source to the target. If

FROMGEN is not specified, CONTROL-M/Analyzer begins
copying with the current (most recent) source generation.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-15

CTBDBVCP Copy Variables or Groups to Another File

Table 4-15

CTBDBVCP SYSIN Parameters (Part 2 of 2)

Parameter

Description

TOGEN

Oldest generation to copy from the source to the target. If

TOGEN is not specified, CONTROL-M/Analyzer. Copies
successively older generations until the number of generations
copied equals the existing value of TOGEN FROMGEN + 1.
Examples:
GROUP=INV
VARIABLE=TOT
NUMGEN=20
FROMGEN=5
TOGEN=10
Assume the source variable has at least 10 generations.
The target variable can have a maximum of 20 generations. The
first six generations of the target variable contain the values of
the 5th through 10th generations of the source variable.

Activating the Utility

// EXEC CTBDBVCP [DIMOD, DIVAR, DIGRP, DOMOD, DOVAR, DOTRP,
REPLACE=YES|NO, COPY=YES|NO]

Return Codes
Table 4-16

CTBDBVCP Return Codes

Code

Description

Copy operation performed successfully

other

Descriptive execution error, copy operation failed

Figure 4-3

//
//
//

CTBDBVCP Example

EXEC CTBDBVCP,DIMOD=MOD,DIVAR=VAR,DIGRP=GRP,
DOMOD=TARGMOD,DOVAR=TARGVAR,DOGRP=TARGGRP
SYSIN DD*
GROUP=CURRENCY
VARIABLE=TOT*

//

For additional information, see sample member JOBDBVCP in the JCL

library.

BMC Software, Inc., Confidential and Proprietary Information

4-16

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBVDL Delete Variables or Groups from Variable or Group Files

CTBDBVDL Delete Variables or Groups from

Variable or Group Files
Utility CTBDVBDL deletes specified records from CONTROL-M/Analyzer
Database Variable files. Mandatory.

Parameters
The following parameters can be specified in the EXEC statement that
invokes the CTBDBVDL JCL procedure. These parameters provide dynamic
specification of source and destination file names:
Table 4-17

CTBDBVDL EXEC Parameters

Parameter

Description

DMOD

Prefix of the third qualifier of the name of the Database Variable

Basic file.

DVAR

Prefix of the third qualifier of the name of the Database Variable

Generation file. Mandatory.

DGRP

Prefix of the third qualifier of the name of the Group file.

Mandatory.

DELGR

Flag that indicates if the entire group is deleted. Valid values are:
Y (Yes) Delete the entire group if no variables exist for this
group.
N (No) Do not delete the entire group. Default.

Parameters can also be supplied using DD statement SYSIN. Only one

parameter can be specified on each line.
Table 4-18

CTBDBVDL SYSIN Parameters (Part 1 of 2)

Parameter

Description

GROUP

Group name (or prefix) of variables to be deleted. A group name

prefix can be specified only if parameter VARIABLE contains
an *.
Examples:
GROUP=INV Variables of group INV are deleted.
GROUP=INV* Variables of all groups that begin with INV (for
example, INV, INVENTORY, INVESTMENTS) are deleted.
Note: GROUP=* cannot be specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-17

CTBDBVDL Delete Variables or Groups from Variable or Group Files

Table 4-18

CTBDBVDL SYSIN Parameters (Part 2 of 2)

Parameter

Description

VARIABLE

Variable name (or prefix) to be deleted.

Note: Parameter VARIABLE can be specified only if *' is not
specified for parameter GROUP.
Example:
GROUP=INV VARIABLE=TOT
Variable TOT of group INV is deleted.
GROUP=INV VARIABLE=TOT*
Variables of group INV that begin with TOT (for example, TOT,
TOTAL, TOT01, TOT02) are deleted.

Activating the Utility

// EXEC CTBDBVDL

Return Codes
Table 4-19

CTBDBVDL Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Example
Figure 4-4

CTBDBVDL Example

// EXEC CTBDBVDL,DMOD=MOD,DVAR=VAR,DGRP=GRP,DELGR=YES
// SYSIN DD *
GROUP=CURRENCY
VARIABLE=TOT*
//

For additional information, see sample member JOBDBVDL in the JCL

library.

BMC Software, Inc., Confidential and Proprietary Information

4-18

INCONTROL for OS/390 and z/OS Utilities Guide

CTBDBVIG Check the Integrity of Variable or Group Files

CTBDBVIG Check the Integrity of Variable or

Group Files
Utility CTBDBVIG checks the integrity of the Database Variable Basic and
Generation files. The utility reports errors that are detected in the logical
organization of these files. Optionally, CTBDBVIG corrects errors that are
detected. File integrity errors are listed in the sysout of the job.

Parameters
You can specify the following parameters in the EXEC statement that invokes
the CTBDBVIG JCL procedure:
Table 4-20

CTBDBVIG EXEC Parameters

Parameter

Description

ACT

Flag that indicates if integrity errors are corrected. Valid values

are:
R Report errors, but do not correct them. Default.
W Report errors and correct them.

Note:

Index file integrity is not checked. Therefore, after running utility

CTBDBVIG, run jobs JOBBDBM and JOBBDBV to rebuild the
index files according to the corrected state of the data file.
You should first run utility CTBDBVIG without requesting
corrections (with ACT set to R) and make a backup copy of Database
variable files before running utility CTBDBFIG with ACT set to W.

Activating the Utility

// EXEC CTBDBVIG DMOD=dmod,DVAR=dvar,DGRP=dgrp[,DELGR=YES|NO]

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-19

CTBDBVIG Check the Integrity of Variable or Group Files

Return Codes
Table 4-21

CTBDBVIG Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Example
// EXEC CTBDBVIG,ACT=R

BMC Software, Inc., Confidential and Proprietary Information

4-20

INCONTROL for OS/390 and z/OS Utilities Guide

CTBFRM Compress the Active Balancing File

CTBFRM Compress the Active Balancing File

Utility CTBFRM compresses the Active Balancing file. The utility usually
runs as part of the New Day procedure before potential missions are placed
as entries in the Active Balancing file. The utility can also be run as a
stand-alone job when parameter FORCE is set to y.
The utility deletes entries from the Active Balancing file that are no longer
processed by CONTROL-M/Analyzer. The Active Balancing file is then
compressed.
A backup of the Active Balancing file is created automatically by this utility.

Parameters
Table 4-22 shows the values that are valid for the parameters specified in the
EXEC statement that invokes the CTBFRM JCL procedure.
Table 4-22

CTBFRM Parameters

Parameter

Valid Values

DBABFB

Third qualifier of the Active Balancing file name. Mandatory.

Default: ABF

DBBKPB

Third qualifier of backup file name. Mandatory.

Default: ABFBKP

FORCE

Indicates whether the utility is being run in stand-alone mode

(forced) or being invoked by the New Day procedure.
Optional.
Y (Yes) The utility is being run in stand-alone mode
without checking dates in member CTBDATE in the
CONTROL-M/Analyzer PARM library.
N (No) The utility is being invoked by the
CONTROL-M/Analyzer New Day procedure. Default.

Activating the Utility

// EXEC CTBFRM,DATABFB=balfile,DTBBKPB=backup file,FORCE={Y|N}

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-21

CTBFRM Compress the Active Balancing File

Return Codes
Table 4-23

CTBFRM Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Example
// EXEC CTBFRM,FORCE=N,DBABFB=ABF,DBBKPB=ABFBKP

For additional information, see sample member JOBFRM in the JCL library.

BMC Software, Inc., Confidential and Proprietary Information

4-22

INCONTROL for OS/390 and z/OS Utilities Guide

CTBJAFCP Copies Entries in Rule Activity or Report Files

CTBJAFCP Copies Entries in Rule Activity or

Report Files
Utility CTBJAFCP copies invocation and report entries to other Rule Activity
and/or Report files.

Parameters
Table 4-24

CTBJAFCP Parameter

Parameter

Description

FILE

File to be copied. Mandatory.

JAF

Only the Rule Activity file is copied.

REP

Only the Report file is copied.

ALL

Both the Rule Activity file and corresponding reports from the
Report file are copied.

The following parameters can be specified in the EXEC statement that

invokes the CTBJAFCP JCL procedure:
Table 4-25

CTBJAFCP EXEC Parameter

Parameter

Description

DBJAFI

Prefix of the third qualifier of the source (input) Rule Activity file
name.

DBREPI

Prefix of the third qualifier of the source (input) Report file name.

DBJAFO

Prefix of the third qualifier of the destination (output) Rule Activity

file name.

DBREPO

Prefix of the third qualifier of the destination (output) Report file

name.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-23

CTBJAFCP Copies Entries in Rule Activity or Report Files

INCLUDE / EXCLUDE Statements

INCLUDE / EXCLUDE statements are supplied using DD statement SYSIN.
The suffix * is permitted at the end of any of these parameters. * represents
any number of characters (including no characters).
The scope of the copy can be limited by one or more INCLUDE /
EXCLUDE statements. Each INCLUDE / EXCLUDE statement contains job
name prefixes that limit the entries that are copied. If one or more INCLUDE
statements are specified, only entries specified in the INCLUDE statements
are copied. If one or more EXCLUDE statements are specified, the entries
specified in the EXCLUDE statements are not copied. There is an OR
relationship between multiple INCLUDE statements and between multiple
EXCLUDE statements.
Each INCLUDE / EXCLUDE statement must be listed on a separate line.
Parameter JOBNAME can be specified in INCLUDE / EXCLUDE
statements. This parameter represents the job name.
Note:

If the SYSIN file contains no INCLUDE / EXCLUDE statements, all

records from the source file are copied.

Activating the Utility

// EXEC CTBJAFCP FILE={JAF|REP|ALL}
// SYSIN DD
*
//

Return Codes
Table 4-26

CTBJAFCP Return Codes

Code

Description

Syntax error in the input parameters stream (SYSIN cards).

12

Insufficient memory to run the utility.

16

Unable to open a CONTROL-M/Analyzer Database file.

100+

Internal error.

108

ENQ of the Rule Activity and Report files failed. Run the utility again
later.

BMC Software, Inc., Confidential and Proprietary Information

4-24

INCONTROL for OS/390 and z/OS Utilities Guide

CTBJAFCP Copies Entries in Rule Activity or Report Files

Example
Figure 4-5

CTBJAFCP Example

// EXEC CTBJAFCP,FILE=ALL,DBJAFI=JAF,DBREPI=REP,DBJAFO=JAFNEW,DBREPO=REPNEW
// SYSIN DD *
INCLUDE JOB2*
EXCLUDE JOB22
EXCLUDE JOB23*
//

To copy the files, perform the following steps:

Step 1

Allocate a new set of Rule Activity and Report files using utility CTBCRDF.

Step 2

Copy the existing files, or a portion of these files (for example, only relatively
new invocations), into the new files using utility CTBJAFCP.

Step 3

Delete the old files.

Step 4

Rename the new files to the names of the original files.

For additional information, see sample member JOBJAFCP in the JCL
library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-25

CTBJAFDL Deletes Entries from Rule Activity or Report Files

CTBJAFDL Deletes Entries from Rule Activity or

Report Files
Utility CTBJAFDL cleans unnecessary entries from the Rule Activity file
and/or the Report file.

Parameters
The following parameters can be specified in the EXEC statement that
invokes the CTBJAFDL JCL procedure:
Table 4-27

CTBJAFDL EXEC Parameters

Parameter

Description

DBJAFB

Prefix of the third qualifier of the Rule Activity file name.

DBREPB

Prefix of the third qualifier of the Report file name.

PRINT

Flag that indicates if deleted entries are printed.

PRINT

Information about deleted entries is printed.

NOPRINT

Information about deleted entries is not printed.

The following parameters are supplied using DD statement SYSIN. The

suffix * is permitted at the end of any of these parameters. * represents any
number of characters (including no characters).
Table 4-28

CTBJAFDL SYSIN Parameters

Parameter

Description

DAYS

Non-negative number of days to retain entries in the Rule Activity

file or Report file. To delete all entries, specify 0. Mandatory.

INCLUDE or
EXCLUDE

The scope of the deletion can be limited by one or more

INCLUDE or EXCLUDE statements. Each INCLUDE or
EXCLUDE statement contains job name prefixes that limit the
entries that are deleted. If one or more INCLUDE statements are
specified, only entries specified in the INCLUDE statements are
deleted. If one or more EXCLUDE statements are specified, the
entries specified in the EXCLUDE statements are not deleted.
There is an OR relationship between multiple INCLUDE
statements and between multiple EXCLUDE statements.

Parameter JOBNAME can be specified in INCLUDE or EXCLUDE

statements. This parameter represents the job name.
Each INCLUDE or EXCLUDE statement must be listed on a separate line.

BMC Software, Inc., Confidential and Proprietary Information

4-26

INCONTROL for OS/390 and z/OS Utilities Guide

CTBJAFDL Deletes Entries from Rule Activity or Report Files

Activating the Utility

Figure 4-6

CTBJAFDL Activation

// EXEC CTBJAFDL,DBJAFB=jaf prefix,DBREPB=rep prefix,PRINT=PRINT|NOPRINT

// SYSIN DD *
DAYS n
[INCLUDE {PARAMETERS}]
[EXCLUDE {PARAMETERS}]
//

Return Codes
Table 4-29

CTBJAFDL Return Codes

Code

Description

Operation performed successfully.

104

ENQ of the Rule Activity and Report files failed. Run the utility
again later.

other

Operation failed.

Example
Figure 4-7

CTBJAFDL Example

// EXEC CTBJAFDL,DBJAFB=JAF,DBREPB=REP,PRINT=PRINT
// SYSIN DD *
DAYS 4
INCLUDE JOB2*
EXCLUDE JOB22
EXCLUDE JOB23*
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-27

CTBJAFIG Check the Integrity of Rule Activity or Report Files

CTBJAFIG Check the Integrity of Rule Activity or

Report Files
Utility CTBJAFIG checks the integrity of Rule Activity and Report files. The
utility reports errors detected in the logical organization of these files. If
requested, utility CTBJAFIG corrects the errors that are detected. File
integrity errors are listed in the sysout of the job.

Parameters
The following parameters can be specified in the EXEC statement that
invokes the CTBJAFIG JCL procedure:
Table 4-30

CTBJAFIG EXEC Parameters

Parameter

Description

FILE

File to be checked or corrected. Mandatory. Valid values are

JAF Rule Activity file. Default.
REP Report file.
BTH Both of the files (without logical links).
ALL Both the Job Activity and Report files (and their
logical links).

Flag to indicate if integrity errors must be corrected. Optional.

Valid values are:
Y (Yes) Correction is requested.
N (No) Correction is not requested. Default.

Note:

Index file integrity is not checked. Therefore, after running utility

CTBJAFIG with option C set to Y (Yes), run jobs JOBBJAF and
JOBBREP to rebuild the index files based on the corrected data file.
You should first run utility CTBJAFIG without requesting correction
(C set to N), and be sure to make a backup copy of the files before
running utility CTBJAFIG with C set to Y (Yes).

Activating the Utility

// EXEC CTBJAFIG FILE={JAF|REP|BTH|ALL}[C={Y|N}]

BMC Software, Inc., Confidential and Proprietary Information

4-28

INCONTROL for OS/390 and z/OS Utilities Guide

CTBJAFIG Check the Integrity of Rule Activity or Report Files

Return Codes
Table 4-31

CTBJAFIG Return Codes

Code

Description

Operation performed successfully

other

Operation failed

Example
//

EXEC CTBJAFIG,FILE=ALL,C=N

For additional information, see sample member JOBJAFIG in the JCL

library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-29

CTBVXRF Cross-Reference Utility

CTBVXRF Cross-Reference Utility

Utility CTBVXRF produces a report that cross-references Database variables
and the rules by that they are created and accessed. This utility gives the user
more control over rule definition and maintenance.

Parameters
This utility receives parameters using DD statement DACMD.
Note:

All parameters are mandatory. The order of the parameters must be

as specified under Activating the Utility below.

Table 4-32

CTBVXRF Parameters

Parameter

Description

LIB

Specifies the library that contains the rules that are

cross-referenced.

RULE

Specifies the rule members to be cross-references. Mask

characters * and? are supported.
For example:
RULE=RUL* Process all rules (in the library specified in
parameter LIB) whose names start with characters RUL.
RULE=RUL?BC Process all rules in the library specified
in parameter LIB whose names start with characters RUL
followed by any single character, and then followed by
characters BC.

SORT

Determines the format and order of the output report. Valid

values are:
RULE Output is formatted in chapters, one rule per
chapter, sorted by rule name. Variables in the rule are
sorted by variable name.
VAR Output is formatted as a list of variables. Each entry
is a Database variable that is accessed by one of the
specified rules. The list is sorted by Database variable
name.

BLOCKS

Specifies the level of detail in the output report. Valid values

are:
YES The cross-reference report relates to individual
blocks within each rule (meaning, if a Database variable is
referenced by two or more blocks of the same rule, the
report contains one line for each block).
NO The report contains one reference per Database
variable name per rule.

BMC Software, Inc., Confidential and Proprietary Information

4-30

INCONTROL for OS/390 and z/OS Utilities Guide

CTBVXRF Cross-Reference Utility

Report Format
The Cross-reference report is formatted according to parameter SORT as
described above.
Each report line contains the following items:
Table 4-33

CTBVXRF Report Formats

Format

Description

VARIABLE

Database variable name. The name is printed as it appears in the

rule. Variables names referenced in the rule definition that
include the AutoEdit symbol are not resolved; these variables are
printed with the%% prefix (for example, DB_VAR%%NUM).
If a variable is accessed that is not associated with a group name
but the rule definition that accesses the variable does specify a
group name, this group name is printed between parentheses as
part of the variable name (for example, DB_(CTB_DEMO).VAR).

RULE

Rule name (when parameter SORT is set to VAR).

BLOCK

Block name (when parameter BLOCKS is set to YES).

EXTRACT or
SET or USED

Counters indicating the number of times the variable was

extracted, set or accessed within a rule.
When BLOCKS is set to YES, only references to the variable
within the current block are counted. When BLOCKS is set to
NO, all references to the variable within the rule are counted.

Activating the Utility

Figure 4-8

CTBVXRF Activation

// EXEC CTBVXRF
// DACMD DD *
LIB=rule-library
RULE=rule-list
SORT=sort-option
BLOCKS=YES/NO
//

Note:

Columns 73 to 80 must not contain line numbers. Use the ISPF

UNNUM command to remove them.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-31

CTBVXRF Cross-Reference Utility

Examples
Example 1

Figure 4-9

CTBVXRF Example 1

INPUT FOR CROSS REFERENCE REPORT:

LIB=CTBP.PROD.RULES
RULE=ARWARN*
SORT=RULE
BLOCKS=YES
CONTROL-M/Analyzer-B VERSION 6.0.02 DATABASE VARIABLE CROSS-REFERENCE REPORT
BMC SOFTWARE, INC.
RULES IN CTBP.PROD.RULES (ARWARN*)
************
* ARWARN01 *
************
NO DATABASE VARIABLES FOUND.
************
* ARWARN02 *
************
NO DATABASE VARIABLES FOUND.
************
* ARWARN03 *
************
NO DATABASE VARIABLES FOUND.
************
* ARWARN04 *
************
VARIABLE
| BLOCK
EXTRACT
SET
USED
--------------------------------------+--------------------------------DB_(INTRAC).COST%%D
| ENDJOB
1
DB_(INTRAC).INVAMT%%D
| ENDJOB
1
DB_(INTRAC).PROCESS_MONTH
| CHKDETL
1
--------------------------------------+--------------------------------************
* ARWARN05 *
************
VARIABLE
| BLOCK
EXTRACT
SET
USED
--------------------------------------+--------------------------------DB_(INTRAC).COST01
| ACCUMSLS
1
DB_(INTRAC).COST02
| ACCUMSLS
1
DB_(INTRAC).COST03
| ACCUMSLS
1
DB_(INTRAC).INVAMT01
| ACCUMSLS
1
DB_(INTRAC).INVAMT02
| ACCUMSLS
1
DB_(INTRAC).INVAMT03
| ACCUMSLS
1
--------------------------------------+---------------------------------

TUE MAR 02 2000 16:52:31

PAGE 1

************
* ARWARN06 *
************
NO DATABASE VARIABLES FOUND
************
* ARWARN4A *
************
VARIABLE
| BLOCK
EXTRACT
SET
USED
--------------------------------------+--------------------------------DB_(INTRAC).COST%%D
| ENDJOB
1
DB_(INTRAC).INVAMT%%D
| ENDJOB
1
DB_(INTRAC).PROCESS_MONTH
| CHKDETL
1
-----------------------------------------------------------------------END OF REPORT

BMC Software, Inc., Confidential and Proprietary Information

4-32

INCONTROL for OS/390 and z/OS Utilities Guide

CTBVXRF Cross-Reference Utility

Example 2

Figure 4-10

CTBVXRF Example 2

INPUT FOR CROSS REFERENCE REPORT:

LIB=CTBP.PROD.RULES
RULE=ARWARN*
SORT=VAR
BLOCKS=YES
CONTROL-M/Analyzer-B VERSION 6.0.02
BMC SOFTWARE, INC.
RULES IN CTBP.PROD.RULES (ARWARN*)

DATABASE VARIABLE CROSS-REFERENCE REPORT

TUE MAR 02 2000 16:53:19

PAGE 1

VARIABLE
| RULE
BLOCK
EXTRACT
SET
USED
--------------------------------------+------------------- ---------------------DB_(INTRAC).COST%%D
| ARWARN04 ENDJOB
1
DB_(INTRAC).COST%%D
| ARWARN4A ENDJOB
1
DB_(INTRAC).COST01
| ARWARN05 ACCUMSLS
1
DB_(INTRAC).COST02
| ARWARN05 ACCUMSLS
1
DB_(INTRAC).COST03
| ARWARN05 ACCUMSLS
1
DB_(INTRAC).INVAMT%%D
| ARWARN04 ENDJOB
1
DB_(INTRAC).INVAMT%%D
| ARWARN4A ENDJOB
1
DB_(INTRAC).INVAMT01
| ARWARN05 ACCUMSLS
1
DB_(INTRAC).INVAMT02
| ARWARN05 ACCUMSLS
1
DB_(INTRAC).INVAMT03
| ARWARN05 ACCUMSLS
1
DB_(INTRAC).PROCESS_MONTH
| ARWARN04 CHKDETL
1
DB_(INTRAC).PROCESS_MONTH
| ARWARN4A CHKDETL
1
--------------------------------------+-----------------------------------------END OF REPORT

BMC Software, Inc., Confidential and Proprietary Information

Chapter 4 CONTROL-M/Analyzer Utilities

4-33

CTBVXRF Cross-Reference Utility

BMC Software, Inc., Confidential and Proprietary Information

4-34

INCONTROL for OS/390 and z/OS Utilities Guide

88

Chapter 5

CONTROL-D and
CONTROL-V Utilities

This chapter provides a detailed description of the CONTROL-D and

CONTROL-V utilities.
Note:

Some utilities prefixed by IOA replace corresponding utilities

prefixed by CTD in previous versions. In such cases, the old utilities
are supported for your convenience; however, you should use the
IOA utilities.

BKPRESET Reset the Backup Mission Status . . . . . . . . . . . . . . . . . . 5-4

CTDBLXRP Rebuild Print Control Records in the Active User File . 5-5
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
CTDCAMF Compress or Copy Active Missions File . . . . . . . . . . . . . 5-6
Compressing the Active Missions File. . . . . . . . . . . . . . . . . . . . . . . . 5-6
Copying the Active Missions File . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Changing the Size of the Active Missions File . . . . . . . . . . . . . . . . . 5-7
CTDCATF Compress or Copy Active Transfer File . . . . . . . . . . . . . . 5-9
Compressing the Active Transfer File . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Copying the Active Transfer File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Changing the Size of the Active Transfer File . . . . . . . . . . . . . . . . . . 5-10
CTDCA2P Copy Active User Report File to Permanent. . . . . . . . . . . 5-11
INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
CTDCCFRS Create or Update Resource File from XEROX Resource
Tape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
CCIFRES Output File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
XERRES Input Tape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-1

INCLUDE / EXCLUDE Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16

CTDCCU Delete Unneeded CDAM Files . . . . . . . . . . . . . . . . . . . . . . 5-17
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
CTDCLHIS Clean History User Report List File . . . . . . . . . . . . . . . . 5-20
MODE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
NOSYS Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Resolving Insufficient Memory Problems . . . . . . . . . . . . . . . . . . . . . 5-21
CTDCP2A Copy Permanent User Report File to Active . . . . . . . . . . . 5-22
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
CTDDELRP Delete Reports that are not Needed . . . . . . . . . . . . . . . . 5-25
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
DAYS Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
INCLUDE / EXCLUDE Statements. . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
CTDDELRP Deletion Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
CTDDIB Rebuild Index Component of a User Report List File . . . . . 5-34
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
CTDDIG User Report List File Integrity Check . . . . . . . . . . . . . . . . . 5-36
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
CTDGBPRT Print Data from Global Index Database . . . . . . . . . . . . . 5-38
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
CTDSMFRP Paper Usage Report for Defined Users. . . . . . . . . . . . . . 5-41
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
CTDSMFRP Sample Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
CTDUFUPD Global Scan or Change of User Files . . . . . . . . . . . . . . . 5-45
Selection Criteria Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Change To Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Fields for After a SELECT Statement . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Fields for After SELECT and CHANGE TO Statements. . . . . . . . . . 5-50

BMC Software, Inc., Confidential and Proprietary Information

5-2

INCONTROL for OS/390 and z/OS Utilities Guide

Work Flow of the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51

CTDULD User File Report List Load . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
CTDUPBKP Update Backup and Migration Details. . . . . . . . . . . . . . 5-55
Converting from CA-DISPATCH. . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57
Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58
CHANGETO Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-59
Report Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-61
CTVCLMIG Clean Migrated CDAM Files . . . . . . . . . . . . . . . . . . . . . 5-64
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
CTVDELI Delete Index Files from DASD . . . . . . . . . . . . . . . . . . . . . 5-66
EXEC Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67
DAYS Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67
INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . 5-68
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
CTVGICL Clean Global Indexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74
CTVJAR Job Archiving Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
Index Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
EXEC Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-77
CTVUNMIG Unmigrate Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
CTVUPGDB Update Global Index Database . . . . . . . . . . . . . . . . . . . 5-81
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
MIGRESET Reset the Migration Mission Status . . . . . . . . . . . . . . . . 5-86
RSTRESET Reset the Restore Mission Status . . . . . . . . . . . . . . . . . . 5-87

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-3

BKPRESET Reset the Backup Mission Status

BKPRESET Reset the Backup Mission Status

If a backup mission abends during the analysis step, the status of the backup
mission remains BACKUP IN PROCESS. If this occurs, reset the backup
mission status to ENDED as follows:
Step 1

Run the BKPRESET job in the CONTROL-D JCL library once for each
backup mission displayed in the Mission Status screen (screen A) that has the
BACKUP IN PROCESS status.
Note:

Step 2

If there are no such missions, run BKPRESET only once.

Restart the backup mission.

BMC Software, Inc., Confidential and Proprietary Information

5-4

INCONTROL for OS/390 and z/OS Utilities Guide

CTDBLXRP Rebuild Print Control Records in the Active User File

CTDBLXRP Rebuild Print Control Records in the

Active User File
Print control records are used by printing missions to create print plans.
Utility CTDBLXRP deletes all existing print control records in the Active
User Reports file and rebuilds them. These records are rebuilt by scanning the
Active User Reports file, creating new print control records and inserting
pointers to reports in WAIT PRINT status.
Use this utility if

reports that have WAIT PRINT status are not selected for printing
many CTD908S error messages with a return code of 16 are issued when
a printing mission is building a print plan

This utility can be run in parallel with other CONTROL-D activities

(decollation, printing, online viewing, and so on.)

Parameters
This utility has no parameters.

Activating the Utility

Utility CTDBLXRP is activated by the following EXEC statement:
//

EXEC CTDBLXRP

Return Codes
Table 5-1

CTDBLXRP Return Codes

Code

Description

Operation performed successfully

Execution error

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-5

CTDCAMF Compress or Copy Active Missions File

CTDCAMF Compress or Copy Active Missions

File
This utility can compress or copy the Active Missions file (AMF), or change
its size.
Message CTDF63W is issued if the AMF is about to become full. Message
CTD533S is issued if the AMF does become full. There are two solutions:
increase the size of the file or compress the file.
The CTDCAMF utility receives control parameters using DD statement
DACOPPRM (or SYSIN). The parameters designate the required function
(compress or copy).
Note:

This utility cannot run simultaneously with the CONTROL-D

monitor. Results are unpredictable if the monitor is not shut down.
Online users can remain logged on.

Compressing the Active Missions File

The AMF contains entries for jobs that are no longer required, such as
missions whose status is DELETED or ENDED OK. By removing the
unneeded entries from the file, utility CTDCAMF provides space for new
entries.

Example

//COMP EXEC CTDCAMF

COMPRESS
//

Copying the Active Missions File

The AMF can be copied

to another system
to another user
to create a backup

BMC Software, Inc., Confidential and Proprietary Information

5-6

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCAMF Compress or Copy Active Missions File

Example
//CAMF EXEC D54FRM,NEWAMF=CTDP.V504.NEWAMF,OUTDUMP=X

For an example of how to implement this utility, see sample job CTDCAMF
in the CONTROL-D JCL library.

Changing the Size of the Active Missions File

Note:

Online users must not access the Online facility while the size of the
Active Transfer file is being changed. You should stop all access to
the AMF until the process is complete.

Perform the following steps to change the size of the AMF:

Step 1

Rename the current AMFwhich is the input file for the copy operation and
its backup fileusing, for example ISPF 3.2 or 3.4.
Note:

Step 2

The backup Active Missions file suffix is AMB.

Perform the following steps in the INCONTROL Installation and

Customization Engine (ICE):
2.A

Specify CTD as the product ID.

2.B

Select the CUSTOMIZE activity (Option 6 in the Main Menu).

2.C

Select major step 3, Customize CONTROL-D Dataset Parameters.

2.D

Select minor step 2, CONTROL-D Dataset Parameters.

2.E

Change the size of the new AMF by modifying the value of the
AMFSIZE parameter from, for example, 1100 blocks to 1200 blocks.

2.F

Select minor step 3, Save Parameters into Product Libraries.

2.G

Select minor step 6, Format the Active Missions File.

2.H

Set the TYPE parameter to NEWAMF/NEWAMB.

2.I

Submit the job and create a new Active Missions file (with the suffix
NEWAMF).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-7

CTDCAMF Compress or Copy Active Missions File

Step 3

Edit the CTDCAMF member in the CONTROL-D JCL library. Change the
OLDAMF parameter to match the name specified in Step 1, as follows:
//CAMF EXEC CTDAMF,OLDNAME=old-dsname,NEW AMF=new-dsname
COPY
//

where

old-dsname is the name specified in Step 1

new-dsname is the new dsn with the suffix NEWAMF

Step 4

Run the CTDCAMF utility to copy the current AMF to the new AMF. You
must terminate the utility with a return code of 0.

Step 5

Restart the CONTROL-D monitor and resume operations.

BMC Software, Inc., Confidential and Proprietary Information

5-8

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCATF Compress or Copy Active Transfer File

CTDCATF Compress or Copy Active Transfer File

This utility can compress or copy the Active Transfer file (ATF), or change
its size.
If the ATF becomes full, there are two solutions: increase the size of the file
or compress the file.
The CTDCATF utility receives control parameters using the EXEC
statement. The parameters designate the required function (compress or
copy).
Note:

This utility cannot run simultaneously with the CONTROL-D

monitor. Results are unpredictable if the monitor is not shut down.
Online users can remain logged on.

Compressing the Active Transfer File

The ATF often contains entries for packets that are no longer required (for
example, packets whose status is DELETED or TRANSFERRED OK). By
removing the unneeded entries from the file, utility CTDCATF provides
space for new entries.

Example

//COMP EXEC CTDCATF

//

Copying the Active Transfer File

The ATF can be copied

to another system
to another user
to create a backup

Example

//CATF EXEC D51CATF,OUTATF=CTDP.V514.ATF,P=COPY,DEL=DUMMY ,

//
INATF=CTDP.V310.ATF

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-9

CTDCATF Compress or Copy Active Transfer File

Changing the Size of the Active Transfer File

Note:

Online users must not access the Online facility while the size of the
ATF is being changed.

Perform the following steps to change the size of the ATF:

Step 1

Rename the current ATFwhich is the input file for the copy operation and
its backup fileusing, for example, ISPF 3.2 or 3.4.
Note:

Step 2

Step 3

The backup Active Transfer file suffix is ATB.

Perform the following steps in ICE:

2.A

Specify CTD as the product ID.

2.B

Select the CUSTOMIZE activity (Option 6 in the Main Menu).

2.C

Select major step 3, Customize CONTROL-D Dataset Parameters.

2.D

Select minor step 2, CONTROL-D Dataset Parameters.

2.E

Change the size of the new ATF by modifying the value of the
ATFBLK parameter from, for example, 300 blocks to 400 blocks.

2.F

Select minor step 3, Save Parameters into Product Libraries.

2.G

Select minor step 6, Format the A.T.F. File.

2.H

Submit the job and create a new ATF.

Edit the CTDCATF member in the CONTROL-D JCL library. Change DD

statement INATF to match the name specified in Step 1, as follows:
// EXEC CTDCATF,P=COPY,
// INATF=old-dsname, OLD ACTIVE TRANSFER FILE
// OUTATF=new-dsname

where

old-dsname is the name specified in Step 1

new-dsname is the new dsn

Step 4

Run the CTDCATF utility to copy the current ATF to the new ATF. You must
terminate the utility with a return code of 0.

Step 5

Restart the CONTROL-D monitor and resume operations.

BMC Software, Inc., Confidential and Proprietary Information

5-10

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCA2P Copy Active User Report File to Permanent

CTDCA2P Copy Active User Report File to

Permanent
This utility copies new user, report, job or category entries from the Active
User Report List file to the Permanent User Report List file. The Permanent
User Report List file contains a list of all the reports that each user can
receive at any point in time. When a new report is defined, or when a user
becomes a report recipient (because of new data from the application), this
information is placed in the Active User Report List file after decollation.
This utility copies new entries from the Active User Report List file to the
Permanent User Report List file. In this way, the list of reports that the user
can receive is maintained automatically.
You should run utility CTDCA2P on a daily basis. For more information, see
the CONTROL-D and CONTROL-V chapter in the INCONTROL for OS/390
and z/OS Administrator Guide.

INCLUDE / EXCLUDE Statements

The scope of the copy can be limited by one or more INCLUDE /
EXCLUDE statements. Each INCLUDE / EXCLUDE statement contains
parameters that limit the user or report list entries that are copied. For
information about prefixing, masking and the INCLUDE / EXCLUDE logic
used to determine record selection, see the topic Record Selection Logic
(INCLUDE / EXCLUDE Statements) on page 7-6 in Chapter 7,
CONTROL-M/Tape Utilities.

Parameters in INCLUDE / EXCLUDE Statements

The parameters that can be specified in INCLUDE / EXCLUDE statements:

Table 5-2

CTDCA2P Parameters

Parameter

Description

JOBNAME

Job name

USER

User name

REPNAME

Report name

CATEGORY

Category name

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-11

CTDCA2P Copy Active User Report File to Permanent

Activating the Utility

// EXEC CTDCA2P
[INCLUDE {parameters}]
[EXCLUDE {parameters}]

The new report entries are assigned the current CONTROL-D working date
(not the computer system date).
This utility can be run simultaneously with the CONTROL-D monitor.

Return Codes
Table 5-3

CTDCA2P Return Codes

Code

Description

Operation performed successfully

I/O error, execution stopped

Example
//

EXEC CTDCA2P
INCLUDE REPNAME=PROD-JCL

The following is the status of the files before the utility is run:
Figure 5-1

--USER-ACCTSRCV
ACCTSRCV
BRANCH01
BRANCH02

Figure 5-2

--USER-BRANCH01
BRANCH02
BRANCH03

Active User Report List File

------REPORT------- ---JOB-- ----CATEGORY---ACCOUNTS-RECEIV-REPT D4ACCRCV QUARTERLY

ACCOUNTS-RECEIV-REPT D4ACCRCV WEEKLY
DAILY-BALANCE-REPORT D4DAILYB DAILY
DAILY-BALANCE-REPORT D4DAILYB MONTHLY

Permanent User Report List File

-------REPORT------DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT

---JOB-D4DAILYB
D4DAILYB
D4DAILYB

----CATEGORY--DAILY
MONTHLY
DAILY

BMC Software, Inc., Confidential and Proprietary Information

5-12

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCA2P Copy Active User Report File to Permanent

Figure 5-3 shows the status of the Permanent User Report List file after the
utility is run.
Figure 5-3

--USER-ACCTSRCV
ACCTSRCV
BRANCH01
BRANCH02
BRANCH03

Note:

Permanent User Report List File After Utility Run

-------REPORT------ACCOUNTS-RECEIV-REPT
ACCOUNTS-RECEIV-REPT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT

--JOB-D4ACCRCV
D4ACCRCV
D4DAILYB
D4DAILYB
D4DAILYB

----CATEGORY-QUARTERLY
WEEKLY
DAILY
MONTHLY
DAILY
1

In Figure 5-3, note the following:

User ACCTSRCV, Category QUARTERLY This entry was

copied from the Active User Report List file, because it did not
exist on the Permanent User Report List file.

User BRANCH01, Categories DAILY and MONTHLY These

entries were not copied from the Active User Report List file,
because they already existed in the Permanent User Report List
file.

User BRANCH03, Category DAILY This entry was not

modified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-13

CTDCCFRS Create or Update Resource File from XEROX Resource Tape

CTDCCFRS Create or Update Resource File from

XEROX Resource Tape
Create and/or update a CCF Resource file according to resources extracted
from a XEROX printer tape.
Utility CTDCCFRS receives control parameters using DD statement
CCIFRES. The corresponding output file must be created with the following
characteristics: logical record length 8192, block size 8192, record format
FB.

CCIFRES Output File

The CCIFRES output file can contain any valid resources. If some input
resources are already located in the Resource file, the new resources replace
the ones currently in the Resource file.
Resources can be added to the Resource file using the CCF Manager. Note
that any resources added by this method are also deleted if this utility is run
afterwards using the NEW parameter. For information, see Parameters on
page 5-15.
The resource FONTS.TXT must be added to the Resource file by one of the
following methods:

Using this utility. FONTS MAPPING must be defined in the FONTS DD

statement.

Using the CCF Manager in RECORD-ORIENTED mode.

If the utility is run in New mode, or in Update mode while adding or

replacing FONTS.TXT, *.JSL or *.JSI members, the Resource file must be
transferred to the PC without translation and without CRLF.
Member FONTS.TXT must be defined according to the DVS ruler. If there is
no input DD statement under the FONTS DD statement, no changes are
made in the existing FONTS.TXT member. This DD statement is optional.
In the PC, the CCF Resource file must be processed by the CCF Manager to
add required resources and to be recompiled (PDL, PDI and PDF compiler).
Once this has been done, it must be returned to the mainframe where it is
ready for use.

BMC Software, Inc., Confidential and Proprietary Information

5-14

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCCFRS Create or Update Resource File from XEROX Resource Tape

If the Resource file was processed in update mode and no FONTS.TXT,

*.JSL or *.JSI members were added or replaced, the Resource file is ready to
be used as is, without processing by the CCF Manager.

XERRES Input Tape

The tape is created using the following XEROX commands:
Figure 5-4

TAPE
COPY
COPY
COPY
COPY
COPY
COPY
TAPE
END

CTDCCFRS XEROX Commands

VOLINT 6250
TAPE WRITE LABEL
TAPE WRITE LABEL
TAPE WRITE LABEL
TAPE WRITE LABEL
TAPE WRITE LABEL
TAPE WRITE LABEL
ENDFILE

*.JSL
*.FNT
*.FRM
*.IMG
*.LGO
*.ICT

Activating the Utility

Utility CTDCCFRS is activated by the following EXEC statement:
//

EXEC CTDCCFRS

Parameters
Table 5-4

CTDCCFRS EXEC Parameters

Parameter

Description

NEW

A new Resource file is created and any existing members in the

existing Resource file (if any) are deleted.

UPD

If new resources exist on the tape, they are added to the

Resource file. Resources that appear with the same name in
both the Resource file and the tape are updated in the Resource
file according to the member on the tape.

Parameters are also passed to the utility using DD statement SYSIN.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-15

CTDCCFRS Create or Update Resource File from XEROX Resource Tape

Table 5-5

CTDCCFRS SYSIN Parameters

Parameter

Descriptions

INCLUDE /
EXCLUDE

The resources can be filtered by one or more INCLUDE /

EXCLUDE statements. For more information on using
INCLUDE / EXCLUDE statements, see the topic Record
Selection Logic (INCLUDE / EXCLUDE Statements) on
page 7-6 in Chapter 7, CONTROL-M/Tape Utilities.
Mask characters (for example, * wildcard) can be used when
specifying INCLUDE / EXCLUDE statements.

INCLUDE / EXCLUDE Examples

INCLUDE RES_NAME.EXT1, RES_NAME.EXT2
EXCLUDE RES_NAME.EXT1, RES_NAME.EXT2

BMC Software, Inc., Confidential and Proprietary Information

5-16

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCCU Delete Unneeded CDAM Files

CTDCCU Delete Unneeded CDAM Files

This utility identifies CDAM files that are not referenced by the Active User
Report List file (as SYSDATA entries) and optionally deletes them.
CDAM files created using the JCL parameter SUBSYS are not always
decollated. Since they are not referenced by the Active User Report List file
(ACTUSR), CTDDELRP does not delete these CDAM files. This utility
identifies or deletes these CDAM files.

Parameters
Table 5-6

CTDCCU Parameters (Part 1 of 2)

Parameter

Description

DATE

Specifies the date range for selecting CDAM files.

Format: fromdate - todate
where fromdate is mandatory; todate is optional.
Date is in format mmddyy, ddmmyy, or yymmdd, depending
on the site standard. todate must not exceed the run date
minus one (that is, the day before the run date), unless
parameter SIMULATION is set to YES.
If todate is not specified, it defaults to the specified fromdate.

PREFIX

Specifies the CDAM prefix. At least one PREFIX command is

required. Multiple PREFIX commands are supported.
Maximum length: 17 characters.

SIMULATION

Creates a report on non-referenced CDAM files, and specifies

whether to delete CDAM files during the run of the utility.
Valid Values are\;
YES Create report. Do not delete CDAM files. In this
mode, you can specify the run date in subparameter todate
of parameter DATE. Default.
NO Create report. Delete all non-referenced CDAM files.
Note: Run utility CTDCCU first in Simulation mode to verify
that only the correct files are deleted.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-17

CTDCCU Delete Unneeded CDAM Files

Table 5-6

CTDCCU Parameters (Part 2 of 2)

Parameter

Description

VERIFY-INHISTORY

Searches the History User Report file for references to CDAM

files not in the Active User Report List file. Valid values are
YES Perform search. Issue a message indicating
whether such references were found. This parameter does
not influence the identification of the CDAM files to be
deleted.
NO Do not search the History User Report List file.
Default.

DELSYSDATA

Deletes SYSDATA records from the Active User Report List

file when the corresponding CDAM files are not found. Valid
values are:
YES Delete the SYSDATA records when the
corresponding CDAM files are not found.
NO Do not delete the SYSDATA records when the CDAM
files are not found.

Activating the Utility

Figure 5-5

CTDCCU Activation

// EXEC CTDCCU
DATE=fromdate [- todate]
PREFIX=prefix
[SIMULATION={YES|NO}]
[VERIFY-IN-HISTORY={YES|NO}]

Examples
Figure 5-6

CTDCCU Example 1

// EXEC CTDCCU
DATE=082100-083000
PREFIX=CTDRSV

In this example, CDAM files satisfying all of the following criteria are listed
in the report but not deleted:

Prefixed CTDRSV.
Created August 21 30, 2000 (mmddyy format).
Not referenced by the Active User Report List file.
Still on disk.

BMC Software, Inc., Confidential and Proprietary Information

5-18

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCCU Delete Unneeded CDAM Files

Figure 5-7

CTDCCU Example 2

// EXEC CTDCCU
DATE=210800-300800
PREFIX=CTDRSV
PREFIX=CTDALL
SIMULATION=NO
VERIFY-IN-HISTORY=YES

In this example, CDAM files satisfying all of the following criteria are
deleted:

Prefixed by CTDRSV or CTDALL.

Created 21 30 August 2000 (ddmmyy format).
Not referenced by the Active User Report List file.
Still on disk.

Deleted CDAM files are checked against the History User Report List file.
The report indicates if the deleted CDAM files are referenced in the History
User Report List file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-19

CTDCLHIS Clean History User Report List File

CTDCLHIS Clean History User Report List File

This utility cleans entries from the History User Report List file. The History
User Report List file contains entries describing backed up user reports. Each
report has a retention period. The utility scans the History User Report List
file for all the reports whose retention period has passed (meaning, the
backup is no longer needed) and deletes them.
This utility produces a list of all tapes that are no longer needed and can
therefore be returned to the global tape pool.

MODE Parameter
This optional parameter in the EXEC Statement determines whether utility
CTDCLHIS is run in Production mode or Simulation (Test) mode. If the
parameter is not specified, the default is Production mode. You should run
this utility in Simulation mode before running it in Production mode.
Table 5-7

CTDCLHIS MODE Parameters

Parameter

Description

PROD

The utility runs in Production mode, deleting report entries that

satisfy the requirements specified by other parameters. Default.

TEST

The utility runs in Simulation mode, performing analysis and

reporting but not changing or deleting any files.

NOSYS Parameter
This optional parameter in the EXEC statement determines whether the
CTDCLHIS utility checks for orphan user records (that is, user records that
do not have corresponding SYSDATA records).
When the NOSYS parameter is not specified or is set to Y (Yes), the
CTDCLHIS utility checks for orphan entries and issues a message for each
one found. Default.
When the NOSYS parameter is set to N (No), the utility does not check for
orphan entries. However, the performance of the utility is substantially
improved.
When the NOSYS parameter is set to S (SYSDATA), the utility checks for
orphan SYSDATA records and issues a message for each one found.

BMC Software, Inc., Confidential and Proprietary Information

5-20

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCLHIS Clean History User Report List File

Activating the Utility

// EXEC CTDCLHIS [MODE=TEST|PROD,NOSYS=Y|N|S]

Return Codes
Table 5-8

CTDCLHIS Return Codes

Code

Description

Operation performed successfully

Operation performed successfully (for HSM backup utility)

Execution error

11

Operation performed successfully (in TEST mode)

12

Invalid input parameters

Resolving Insufficient Memory Problems

The CTDCLHIS utility processes History User Report List entries by
JOBNAME. The utility allocates memory to read all $SYSDATA records for
each of these JOBNAMEs. If there are too many $SYSDATA records and not
enough memory to read them, the DSH948E message is issued. To resolve
this problem increase the memory allocation for $SYSDATA records that can
be set as the DATA parameter value in optional Wish WD2403.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-21

CTDCP2A Copy Permanent User Report File to Active

CTDCP2A Copy Permanent User Report File to

Active
This utility copies job, user, report, or category entries from the Permanent
User Report List file to the Active User Report List file. This process is
performed once a day to create new empty entries (in WAIT
DECOLLATION status) for each job, user, report, category, odate (original
scheduling date).
Any job, user, report, category, or ODATE entries that are already present in
the Active User Report List file are not copied (meaning, are not duplicated).

INCLUDE / EXCLUDE Statements

The scope of the copy can be limited by one or more INCLUDE /
EXCLUDE statements. Each INCLUDE / EXCLUDE statement contains
parameters that limit the user or report list entries that are copied. For
information about prefixing, masking and the INCLUDE / EXCLUDE logic
used to determine record selection, see the topic Record Selection Logic
(INCLUDE / EXCLUDE Statements) on page 7-6 in Chapter 7,
CONTROL-M/Tape Utilities.

Parameters in INCLUDE / EXCLUDE Statements

The parameters that can be specified in INCLUDE / EXCLUDE statements:

Table 5-9

CTDCP2A Parameters

Parameter

Description

JOBNAME

Job name

USER

User name

REPNAME

Report name

CATEGORY

Category name

Activating the Utility

// EXEC CTDCP2A
[INCLUDE {PARAMETERS}]
[EXCLUDE {PARAMETERS}]

BMC Software, Inc., Confidential and Proprietary Information

5-22

INCONTROL for OS/390 and z/OS Utilities Guide

CTDCP2A Copy Permanent User Report File to Active

The new report entries are assigned the current CONTROL-D working date
(not the computer system date). It is possible to specify a specific date by
setting parameter PARM to date (format mmddyy, ddmmyy, or yymmdd,
depending on the site standard).
The utility can be run simultaneously with the CONTROL-D monitor.

Return Codes
Table 5-10

CTDCP2A Return Codes

Code

Description

Operation performed successfully

I/O error, execution stopped

Example
// EXEC CTDCP2A,PARM=date
INCLUDE REPNAME=PROD-JCL

The following is the status of the files before the utility is run:
Figure 5-8

--USER-BRANCH01
BRANCH02
BRANCH03

Figure 5-9

Permanent User Report List File

-------REPORT------DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT

---JOB-D4DAILYB
D4DAILYB
D4DAILYB

----CATEGORY--DAILY
MONTHLY
DAILY

Active User Report List File

-USER-- ------REPORT------ --JOB-ACCTSRCV ACCOUNTS-RECEIV-REPT D4ACCRCV

ACCTSRCV ACCOUNTS-RECEIV-REPT D4ACCRCV
BRANCH01 DAILY-BALANCE-REPORT D4DAILYB
BRANCH02 DAILY-BALANCE-REPORT D4DAILYB

--CATEGORYQUARTERLY
WEEKLY
DAILY
MONTHLY

-ODATE070700
070700
070700
070700

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-23

CTDCP2A Copy Permanent User Report File to Active

The following is the status of the Active User Report List file after the utility
is run on the 7 July:
--USER-ACCTSRCV
ACCTSRCV
BRANCH01
BRANCH02
BRANCH02
BRANCH03

-------REPORT------ACCOUNTS-RECEIV-REPT
ACCOUNTS-RECEIV-REPT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT
DAILY-BALANCE-REPORT

---JOB-D4ACCRCV
D4ACCRCV
D4DAILYB
D4DAILYB
D4DAILYB
D4DAILYB

----CATEGORY---QUARTERLY
WEEKLY
DAILY
MONTHLY
MONTHLY
DAILY

-ODATE070700
070700
070700
070700
070700
070700

BMC Software, Inc., Confidential and Proprietary Information

5-24

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDELRP Delete Reports that are not Needed

CTDDELRP Delete Reports that are not Needed

This utility cleans unneeded user, report, and job entries from the Active User
Report List file and erases them from the disk compressed (CDAM) datasets
that have no entries in the Active User Report List file. The utility can also
move a report entry from the Active User Report List file to either the History
User Report List file or the Migrated User Report List file. To do this, the
following must be true:

the DASD retention period for that report has expired

the report has been backed up or migrated successfully

The utility determines which reports are no longer needed for backup,
migration, Online viewing, or printing, by means of user-specified selection
groups. A selection group consists of a DAYS statement and optional
INCLUDE / EXCLUDE statements. The DAYS statement contains a
retention period that specifies the number of days that the reports remain
online, after which they are deleted by the utility. The optional INCLUDE /
EXCLUDE statements further qualify which reports belong to the selection
group.
By specifying multiple selection groups, each with its own retention period
and INCLUDE / EXCLUDE statements, groups of entries with differing
retention periods can be deleted by a single execution of utility CTDDELRP.
For information about prefixing, masking and the INCLUDE / EXCLUDE logic
used to determine record selection, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6. Selection groups are scanned
sequentially. The processing of a report is determined by the selection groups
whose INCLUDE / EXCLUDE criteria match the report.
Utility CTDDELRP performs the following steps:
Step 1

Records to be deleted from the Active User Report List file are selected
according to the parameters specified for the utility, and written to a
temporary file.
Records for reports that have been backed up are written to the History User
Report List file. CDAM files to be deleted are written to an intermediate file.

Step 2

The temporary file is read and the records it contains are deleted from the
Active User Report List file.

Step 3

CDAM files stored in the intermediate file, in Step 1, are deleted.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-25

CTDDELRP Delete Reports that are not Needed

Parameter
Table 5-11

CTDDELRP Parameters

Parameter

Description

MODE

This optional parameter in the EXEC statement determines if

utility CTDDELRP is run in Production mode or Simulation mode.
If the parameter is not specified, the default is Production mode.
You should run this utility in Simulation mode before running it in
Production mode. Valid values are
PROD The utility runs in Production mode, changing and
deleting report entries and CDAM files that satisfy the
requirements specified by other parameters. Default.
TEST The utility runs in Simulation mode, performing
analysis and reporting but not changing or deleting any files.

DAYS Statement
The DAYS statement can contain the following parameters:
Table 5-12

CTDDELRP DAYS Parameters (Part 1 of 2)

Parameter

Description

Retention period, in days, after which the report expires and is

selected for deletion from the Active User Report List file by the
selection group. This parameter must be the first parameter in
the statement. Mandatory.
By default, the report expires n days from the original scheduling
date (ODATE) of the report decollating mission. The
INCONTROL administrator can change the default so that n is
calculated from the decollation date. For details, see Optional
Wish WD1377 in member IOADFLTC of the MAC library.
To delete reports created on future ODATEs, n can be a negative
number, but it cannot exceed 9999.

FORCE

When not specified, reports with WAIT BACKUP status are not
deleted. Optionally, reports awaiting backup are also deleted.

WAITPRINT

Optionally, reports with WAIT PRINT status are not deleted. If not
specified, reports waiting to be printed are also deleted.

WAITDEC or
NOTWD

WAITDEC deletes only reports having Wait Decollation status.

NOTWD excludes from the selection group reports having Wait
Decollation status. If neither parameter is specified, Wait
Decollation status does not affect report deletion. Both
parameters cannot be specified in the same selection group.

BMC Software, Inc., Confidential and Proprietary Information

5-26

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDELRP Delete Reports that are not Needed

Table 5-12

CTDDELRP DAYS Parameters (Part 2 of 2)

Parameter

Description

RESTORED or
NOTRST

RESTORED deletes only reports having Restored status.

NOTRST excludes from the selection group reports having
Restored status. If neither parameter is specified, Restored
status does not affect report deletion. Both parameters cannot be
specified in the same selection group.
Note: Parameters FORCE, WAITPRINT, WAITDEC, NOTWD,
RESTORED and NOTRST apply only to the specific selection
group in which they appear. They can be specified for as many
selection groups as necessary.

NOREPORT

Deletes any SYSDATA entries and their CDAM datasets (original

reports data) if the SYSDATA is not pointed to by any user entries
(for example, the user entries have been manually deleted),
regardless of the retention value specified in the DAYS parameter
and all other selection group parameters.

KEEPDSN

Deletes reports from the Active User Report List file but does not
delete CDAM datasets. The CDAM datasets can then be
re-decollated.

NOINDEX

Prevents migrated indexes from being deleted from DASD by

utility CTDDELRP (when a report is deleted and its control
records are moved to the Migrated User file), even if the indexes
are defined as nonresident. This parameter is valid only for
CONTROL-V.
This parameter is designed to retain nonresident indexes on
DASD for an indefinite period of time after the report has
migrated. These indexes can be deleted by utility CTVDELI at
any time.
Note: Parameters NOREPORT, KEEPDSN and NOINDEX apply
to all selection groups regardless of the criteria specified for
them.

STORED or
NOTSTOR

STORED deletes only those reports created by a printing mission

with a value of Y (Yes) in field STORE. NOTSTOR excludes from
the selection group reports created by a printing mission with a
value of Y (Yes) in field STORE. If neither parameter is specified,
reports created by a printing mission with a value of Y (Yes) in
field STORE do not affect report deletion. Both parameters
cannot be specified in the same selection group.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-27

CTDDELRP Delete Reports that are not Needed

INCLUDE / EXCLUDE Statements

Each INCLUDE / EXCLUDE statement must be specified on a separate line.
Multiple INCLUDE / EXCLUDE statements can be specified. Each
statement can contain any or all of the parameters listed below, separated by a
space. However, each parameter can appear no more than once in each
statement.
For more information about INCLUDE / EXCLUDE statements, see Record
Selection Logic (INCLUDE / EXCLUDE Statements) on page 7-6.

General Parameters in INCLUDE / EXCLUDE Statements

Each INCLUDE / EXCLUDE statement must contain at least one of the

following parameters:
Table 5-13

CTDDELRP Statements

Parameter

Description

JOBNAME

Job name (or prefix)

JOBID

Job ID (format Jnnnnn)

USER

User name (or prefix)

CLASS

Class

REPNAME

Report name (or prefix). If the report name contains embedded

spaces, replace each embedded space with the @ character.

CATEGORY

Category of report decollation mission

By default, the values specified for JOBNAME, USER, and REPNAME are
treated as prefixes. To prevent a value from being considered a prefix, place
the special character < after the value.

BMC Software, Inc., Confidential and Proprietary Information

5-28

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDELRP Delete Reports that are not Needed

CDAM Dataset Parameters in INCLUDE / EXCLUDE Statements

The following additional parameters can be specified for CDAM datasets that
are created using the JCL SUBSYS parameter:
Table 5-14

CTDDELRP Additional Parameters

Parameter

Description

PGMSTEP

Job step name (that created the report)

PROCSTEP

Procedure step name (that created the report)

DDNAME

DD name (that created the report)

Note:

PGMSTEP refers to the job step, and PROCSTEP refers to the

procedure step name.

CTDDELRP Deletion Rules

CONTROL-D and CONTROL-V reports are identified by user entries,
SYSDATA entries, and CDAM compressed datasets. Each user entry can
point to one or more SYSDATA entries. Each SYSDATA entry points to one
CDAM dataset. Each CDAM dataset is pointed to by one or more SYSDATA
entries.
When deleting reports, CTDDELRP maintains the integrity of this data
structure according to the following rules:

A CDAM compressed dataset is deleted when all SYSDATA entries

pointing to it are deleted.

A SYSDATA entry is deleted when all user entries pointing to it are

selected for deletion.

A user entry is deleted

when all SYSDATA entries to which it points are selected for

deletion, or

when every SYSDATA entry to which it points no longer exists,

meaning, the SYSDATA entries were deleted using the
CONTROL-D or CONTROL-V Online facility.

Utility CTDDELRP issues a message if it finds a SYSDATA entry that is not

pointed to by any user entry, meaning, the user entries were deleted using the
CONTROL-D or CONTROL-V Online facility. If parameter NOREPORT
was specified, this SYSDATA entry is automatically deleted.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-29

CTDDELRP Delete Reports that are not Needed

Activating the Utility

Figure 5-10

CTDDELRP Activation

//
EXEC CTDDELRP[,MODE=TEST|PROD]
//SYSPRINT DD SYSOUT=*
//SYSIN DD *
DAYS n [FORCE] [WAITPRINT] [WAITDE|NOTWD] [RESTORED|NOTRST][NOREPORT]
[KEEPDSN]
[INCLUDE [JOBNAME=Job name] [JOBID=jobid] [USER=user] [CLASS=class]
[REPNAME=repname] [PGMSTEP=pgmstep] [PROCSTEP=procstep]
[DDNAME=ddname]
.
.
.
[EXCLUDE [JOBNAME=Job name] [JOBID=jobid] [USER=user] [CLASS=class]
[REPNAME=repname] [PGMSTEP=pgmstep] [PROCSTEP=procstep]
[DDNAME=ddname]
.
.
.
[
DAYS statement
[INCLUDE statement]
.
.
.
[EXCLUDE statement]
.
.
]

Note:

To concatenate data sets to a data set defined with a DDNAME

parameter, the unnamed DD statements must follow the DD
statement that contains the DDNAME parameter, not the referenced
DD statement that defines the data set. For further information, see
chapters "12.17.5, Location in the JCL" and "12.17.6, Referenced
DD Statement" in IBM publication OS/390 MVS JCL Reference.
Document Number GC28-1757-09. Program Number 5647-A01."

Examples
Example 1
//S1 EXEC CTDDELRP
DAYS 3

The utility deletes reports that are older than three days if they have been
backed up and have either WAIT PRINT or PRINTED status.

Example 2
//S1 EXEC CTDDELRP
DAYS 0 WAITPRINT

BMC Software, Inc., Confidential and Proprietary Information

5-30

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDELRP Delete Reports that are not Needed

The utility deletes reports that were backed up and printed. Reports waiting
for migration, print and/or backup are not deleted.

Example 3

//S1 EXEC CTDDELRP

DAYS 5
INCLUDE REPNAME=PROD-JCL

The utility deletes reports with name prefix PROD-JCL that are more than
five days old, unless they have not yet been backed up.

Example 4

//S1 EXEC CTDDELRP

DAYS 0 FORCE
INCLUDE JOBNAME=Y99BUP01 JOBID=J01923

The utility deletes reports of the specified job name and job ID, regardless of
WAIT BACKUP or WAIT PRINT status.
Assume the following report names exist: ACCT, ACCT-REC, ACCT-PAY.

Example 5

//S1 EXEC CTDDELRP

DAYS 0
INCLUDE REPNAME=ACCT*

The utility deletes all the above reports.

Example 5A

//S1 EXEC CTDDELRP

DAYS 0
INCLUDE REPNAME=ACCT<

The utility deletes only report ACCT.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-31

CTDDELRP Delete Reports that are not Needed

Example 6

//S1 EXEC CTDDELRP

DAYS 0 WAITPRINT
EXCLUDE REPNAME=PROD-JCL
EXCLUDE CLASS=X
EXCLUDE JOBNAME=P00*

The utility deletes from DASD all reports that have already been migrated,
printed, and backed up, if backup was requested, except the following:

production JCL reports

reports produced on output class X
reports produced by jobs with names beginning P00

Example 7

//S1 EXEC CTDDELRP

DAYS 7 WAITPRINT
INCLUDE JOBNAME=PROD*
DAYS 3 FORCE
INCLUDE JOBNAME=TEST*

The utility deletes reports older than seven days and created by jobs with
names beginning PROD, except reports waiting for print. Reports older than
three days and created by jobs with names beginning TEST are deleted,
regardless of WAIT BACKUP or WAIT PRINT status.

Example 8

//S1 EXEC CTDDELRP

DAYS 3 WAITPRINT RESTORED
DAYS 1 WAITDEC
DAYS 10 WAITPRINT NOT RST NOT WD
DAYS 0
INCLUDE USER=SCRAP

The utility deletes reports that were restored at least three days ago, except
reports still waiting for print.
The utility deletes report entries with a status of WAIT DECOLLATION that
were created using utility CTDCP2A, and that are older than one day.

BMC Software, Inc., Confidential and Proprietary Information

5-32

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDELRP Delete Reports that are not Needed

The utility deletes reports older than ten days, with neither RESTORE nor
WAIT DECOLLATION status, and which have already printed.
The utility deletes report entries belonging to user name SCRAP.

Example 9
//S1 EXEC CTDDELRP
DAYS 4 NOREPORT

The utility deletes reports older than four days.

The utility deletes reports that have only a SYSDATA record (no user record
points to them), even if the SYSDATA record is one day old.

Example 10

//S1 EXEC CTDDELRP

DAYS 30
INCLUDE JOBNAME=PROD*
INCLUDE JOBNAME=FIRST*
DAYS 15 WAITPRINT
INCLUDE JOBNAME=TEST*
DAYS 5 FORCE
EXCLUDE JOBNAME=PROD*
EXCLUDE JOBNAME=FIRST*
EXCLUDE JOBNAME=TEST*

The utility deletes reports older than 30 days and created by jobs with names
beginning PROD or FIRST, unless they have not yet been backed up. The
utility deletes reports that have been printed, backed up and migrated, that are
older than 15 days, and that were created by jobs with names that begin with
TEST. The utility deletes all other reports more than five days old.
Note:

This utility is fully recoverable. If an abend occurs at any step of the

utility, fix the problem and rerun the utility from the first step.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-33

CTDDIB Rebuild Index Component of a User Report List File

CTDDIB Rebuild Index Component of a User

Report List File
Utility CTDDIB is used to rebuild a CONTROL-D User Report List files
index component. The new index component corresponds to information
currently contained in the IOA Access Method files data component.
Previous contents of the index component are erased.
Note:

The index component that is to be rebuilt must be allocated and

formatted prior to activating the utility.

This utility is used when an integrity problem is detected in an IOA Access

Method files index component. In this case:

Delete and reallocate the index component.

Format the index component with utility IOADBF.
Rebuild the index component with utility CTDDIB.

Activating the Utility

//BUILD

EXEC

CTDDIB, DBFILE={ACT|PRM|HST|MIG}

Parameters
The following parameter can be specified to the utility in the EXEC
statement that invokes the CTDDIB JCL procedure.
Table 5-15

CTDDIB Parameters

Parameter

Description

DBFILE

CONTROL-D IOA Access Method files dataset name suffix. Valid

values are:
ACT Active User Report List file
PRM Permanent User Report List file
HST History User Report List file
MIG Migrated User Report List file (CONTROL-V only)

BMC Software, Inc., Confidential and Proprietary Information

5-34

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDIB Rebuild Index Component of a User Report List File

Example
//BUILD

EXEC

CTDDIB,DBFILE=HST

For an example of how to rebuild a IOA Access Method file index

component, see sample job CTDUFDIB in the CONTROL-D JCL library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-35

CTDDIG User Report List File Integrity Check

CTDDIG User Report List File Integrity Check

Utility CTDDIG checks the integrity of the User Report List files (that is,
Active, Permanent, History, and Migration Report List files) by comparing
the data and index components of these files. Optionally, detected errors can
be corrected. This utility can detect and correct the following types of errors:

More than one data record exists with the same key.
A data record exists without a corresponding index record.
An index record exists without a corresponding data record.
A data record and its corresponding index record do not have the same
update timestamp.

Utility CTDDIG is executed in two sequential stages, as follows:

Table 5-16

CTDDIB Stages

Stage

Description

Stage 1

Information is read from the specified User Report List file.

Stage 2

Integrity is checked and (optionally) corrupted records are

repaired.

This utility can be run while CONTROL-D and the Online monitors are
active. However, it locks the specified User Report List file so other
applications cannot modify it.

If MODE is set to TEST, the specified file is locked during only Stage 1.
If MODE is set to CHANGE, the specified file is locked during both
Stage 1 and Stage 2.

You should run this utility in TEST mode before running it in CHANGE
mode.

BMC Software, Inc., Confidential and Proprietary Information

5-36

INCONTROL for OS/390 and z/OS Utilities Guide

CTDDIG User Report List File Integrity Check

Parameters
The following parameters can be specified in the EXEC statement that
invokes the CTDDIG JCL procedure:
Table 5-17

CTDDIB Parameters

Parameter

Description

DBFILE

File to be checked. Mandatory. Valid values are:

ACT Active User Report List file
PRM Permanent User Report List file
HST History User Report List file
MIG Migration User Report List file

MODE

Mode in that the utility is run. Optional. Valid values are:

TEST Messages are issued about detected problems but
errors are not fixed. Default.
CHANGE Messages are issued and errors are fixed.

Activating the Utility

// EXEC CTDDIG,DBFILE={ACT|PRM|HST|MIG}[,MODE=TEST|CHANGE]

JCL for executing this utility is in member CTDUFDIG in the CONTROL-D

JCL library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-37

CTDGBPRT Print Data from Global Index Database

CTDGBPRT Print Data from Global Index

Database
This utility prints the following data from the Global Index database:

A list of index path names

A list of index values for a specific path name
A list of VSA keys for a specific path according to the index value prefix

Parameters
Table 5-18

CTDGBPRT Parameters

Parameter

Description

DO

Mandatory function. This parameter tells the utility which

information to print from the Global Index Database. Value
values are:
LISTINDEX List of index path names
LISTIXVAL List of index values for a specific path name
LISTVSA List of VSA keys for a specific path name

IXPATH

Path of index names (prefix). The index names in the path are
separated by blanks. IXPATH is optional for the LISTINDEX
function. If this parameter is not specified, all index
pathnames are printed. Mandatory for LISTIXVAL and
LISTVSA functions (prefix not allowed.)

IXVAL

The index value (prefix) specified in the IXPATH path. May be

specified only for LISTIXVAL and LISTVSA functions.
Optional. All index values for a specified IXPATH are printed if
IXVAL is not provided.

Activating the Utility

// EXEC CTDGBPRT
// SYSIN DD*
DO={LISTINDEX / LISTIXVAL / LISTVSA}
[ixpath=PATH NAME]
[ixval =VALUE]
/*

BMC Software, Inc., Confidential and Proprietary Information

5-38

INCONTROL for OS/390 and z/OS Utilities Guide

CTDGBPRT Print Data from Global Index Database

Return Codes
Table 5-19

CTDGBPRT Return Codes

Code

Description

Operation performed successfully

Operation ended with warnings

Error occurred during processing

16

Severe error

Examples
Figure 5-11

CTDGBPRT Example 1

// EXEC CTDGBPRT
// SYSIN DD*
DO=LISTINDEX
/*

All index pathnames contained in the Global Index Database are printed.
Figure 5-12

CTDGBPRT Example 2

// EXEC CTDGBPRT
// SYSIN DD*
DO=LISTIXVAL
IXPATH=ACCOUNT SUM
IXVAL=001
/*

Index values with the prefix "001" for path name ACCOUNT SUM are
printed.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-39

CTDGBPRT Print Data from Global Index Database

Figure 5-13

CTDGBPRT Example 3

// EXEC CTDGBPRT
// SYSIN DD*
DO=LISTVSA
IXPATH=ACCOUNT SUM
IXVAL=001 2000
/*

Index values with the prefix "001 2000" and all VSA keys for each value for
path name ACCOUNT SUM are printed.

BMC Software, Inc., Confidential and Proprietary Information

5-40

INCONTROL for OS/390 and z/OS Utilities Guide

CTDSMFRP Paper Usage Report for Defined Users

CTDSMFRP Paper Usage Report for Defined

Users
This utility creates a paper usage report by user (recipient). The report is
available in detail format with page and line count data for each report, or in
summary format with the same data summarized by user.

Parameters
Table 5-20

CTDSMFRP Parameters

Parameter

Description

RETYPE

Report type. Valid values are:

D Detail report. Page and line count data is provided
for each report
S Summary report (by user)

USER

User ID

REPNAME

Report name

CATEGORY

Category name

ACCOUNT

Account number

FROMDATE

Earliest date of reports to be included

TODATE

Latest date of reports to be included

Prefixes can be specified in the USER, REPNAME, CATEGORY and

ACCOUNT parameters. In the event that a specific name is also a prefix, all
reports with that prefix are included. To prevent the name from being
considered a prefix, place the special character < after the specified name.
Note:

It is possible to change the default number of lines per page (60) by

setting parameter PARM to LINECNT=nnn in the EXEC
statement of the job.

Activating the Utility

// EXEC CTDSMFRP
{parameters}

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-41

CTDSMFRP Paper Usage Report for Defined Users

Example
// EXEC CTDSMFRP
// DASYSIN DD *
REPTYPE D
USER MGT
CATEGORY ACCT

CTDSMFRP Sample Reports

Figure 5-14

Sample Report 1

BMC SOFTWARE, INC.

CONTROL-D SMF REPORT (VER 6.0.00)

DATE 08/08/00 TIME 23.56

PAGE

CONTROL-D: SMF RECORDS FOUND FOR USER - MGT

-----------------------------------------------PAGES- NO. OF PAGES

DATE
-------08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00
08/08/00

TIME
-------10:15:17
10:15:20
11:02:21
11:25:05
15:26:14
15:28:47
19:42:20
19:30:23
21:01:58
21:19:14
21:20:32
23:06:02
23:12:51
23:54:55

JOB NAME
-------PBNKRPT2
PEMPRPT
PBRNCHLS
PMONUPDT
PBRNMGRS
MSURGRFS
GLRPT17A
PTBAL1A
PRINVRPT
ACCSUMRS
ACCEXCPR
ACCDAILY
SLRRPTR1
SLRRPTR2

LINES- NO. OF LINES

FORM- FORM NUMBER
REPORT NAME
-------------------BANKING REPORT
EMPLOYEES REPORT-S
BRANCH LISTS
MONTHLY UPDATE
BRANCH MGRS REP
MKT SURVEY GRAFHS
GENERAL LEDGER
TRIAL BALANCE
INVENTORY REPORT
SUMMARY ACC REPORT
EXCEPTION ACC REPORT
DAILY ACCOUNTS
SALARY REPORT RUN #1
SALARY REPORT RUN #2

COPY- NO. OF COPIES

ACCOUNT- ACCOUNT INFO FROM JOBCARD

CATEGORY NAME
PAGES
LINES
COPY ODATE
FORM
ACCOUNT
-------------------- ------ ------------- ---- -------- ---- -----------BI-WEEKLY
49
2542
3 08/08/00 STD
DAILY
1
10
1 08/08/00 STD
DAILY
5631
269029
1 08/08/00 STD
MONTHLY
1086
52191
1 08/08/00 STD
WEEKLY
24
1002
1 08/08/00 STD
WEEKLY
8
401
5 08/08/00 SPL
DAILY
293
15866
1 08/08/00 STD
DAILY
76
3764
1 08/08/00 STD
DAILY
9
427
1 08/08/00 STD
DAILY
236
11872
1 08/08/00 STD
DAILY
53
1697
1 08/08/00 STD
DAILY
468
20171
1 08/08/00 STD
WEEKLY
107
5705
1 08/08/00 STD
WEEKLY
108
5724
2 08/08/00 STD

--------------------------------------------------------------------------------------------------------------------------*****
TOTAL PAGES AND LINES PRINTED FOR USER - MGT
8149
390401

BMC Software, Inc., Confidential and Proprietary Information

5-42

INCONTROL for OS/390 and z/OS Utilities Guide

CTDSMFRP Paper Usage Report for Defined Users

Figure 5-15

Sample Report 2

BMC SOFTWARE, INC.

CONTROL-D SMF REPORT (VER 6.0.00)

DATE 08/08/00 TIME 23.57

PAGE

29

CONTROL-D: SUMMARY SMF REPORT

-------------------------------------

REPORTS - NO. OF REPORTS

PAGES - NO. OF PAGES
USERS
------------BR126
BR126FC
BR126LO
BR126SA
BR127
BR127FC
BR127LO
BR127SA
BR128
BR128FC
BR128LO
BR128SA
BR129
BR129FC
BR129LO
BR129SA
BR130
BR130FC
BR130LO
BR130SA
BR131
BR131FC
BR131LO
BR131SA
BR132
BR132FC
BR132LO
BR132SA
BR133
BR133FC
BR133LO
BR133SA
BR134
BR134FC
BR134LO
BR134SA
BR135
BR135FC
BR135LO
BR135SA
DEV
GEN-MNGR
MGT
MKT
PROD
PRODCNTL

REPORTS
------------7
4
2
6
7
4
2
6
7
4
2
6
7
4
2
6
7
4
2
6
7
4
2
6
8
4
2
6
7
4
2
6
7
4
2
6
7
4
2
6
12
4
29
16
8
72

DATES - DATES OF FIRST AND LAST REPORTS

LINES - NO. OF LINES
PAGES
------------63
182
49
2,590
51
129
35
1,203
62
194
48
2,008
41
115
138
1,996
67
221
196
2,804
62
198
245
2,053
1,012
176
98
1,916
59
238
172
2,141
66
198
206
1,391
65
222
201
1,870
392
48
495
125
197
441

LINES
------------3,184
7,095
2,553
133,479
2,336
4,602
1,614
53,237
3,293
8,114
1,683
94,733
1,498
5,321
5,632
67,682
3,663
10,569
10,930
135,006
1,988
7,117
9,285
73,194
38,449
5,667
4,214
59,480
1,672
8,363
5,118
81,336
2,757
8,452
6,220
58,413
2,352
9,221
7,264
71,095
13,659
2,447
20,794
6,998
10,562
8,668

D A T E S
-------------------08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00
08/08/00 - 08/08/00

-------------------------------------------------------------------------------T O T A L
1452
276,516
13,274,601

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-43

CTDSMFRP Paper Usage Report for Defined Users

Figure 5-16

Sample Report 3

BMC SOFTWARE, INC.

IOA KEY-STROKE REPORTING LANGUAGE (VER 6.0.00)
L I S T
O F
T H E
R E P O R T S
F O R T H E
U S E R

DATE 08/08/00 TIME 16.49 PAGE 000001

=========
MGT
=========
---------------------------------------------------------------------:
REPORT
:
STATUS
: COPIES : PAGES : LINES :
---------------------------------------------------------------------: EMPLOYEES REPORT-S : PRINTED-WAIT BKP
: 001
:
1 :
10 :
---------------------------------------------------------------------: BANKING REPORT
: DECOLLATED
: 000
:
49 :
2542 :
---------------------------------------------------------------------: BRANCH LISTS
: DECOLLATED
: 000
: 5631 : 269029 :
---------------------------------------------------------------------: MONTHLY UPDATE
: PRINTED-WAIT BKP
: 001
: 1086 : 52191 :
---------------------------------------------------------------------: BRANCH MGRS REP
: WAIT PRINT
: 001
:
24 :
1002 :
---------------------------------------------------------------------: GENERAL LEDGER
: PRINTED-WAIT BKP
: 001
:
293 : 15866 :
---------------------------------------------------------------------: TRIAL BALANCE
: PRINTED
: 001
:
76 :
3764 :
---------------------------------------------------------------------: INVENTORY REPORT
: PRINTED-WAIT BKP
: 001
:
9 :
427 :
---------------------------------------------------------------------: SUMMARY ACC REPORT : WAIT PRINT
: 002
:
236 : 11872 :
---------------------------------------------------------------------: EXCEPTION ACC REPORT: DECOLLATED
: 000
:
53 :
1697 :
---------------------------------------------------------------------: DAILY ACCOUNTS
: WAIT PRINT
: 001
:
468 : 20171 :
---------------------------------------------------------------------: SALARY REPORT RUN #1: PRINTED
: 001
:
107 :
5706 :
---------------------------------------------------------------------: SALARY REPORT RUN #2: PRINTED
: 003
:
108 :
5724 :
----------------------------------------------------------------------

Figure 5-17

Sample Report 4

BMC SOFTWARE, INC.

C O N T R O L
PRODREPS
PRDKPL03
PRDKPL06
GPLIR16B
PYHIZNRS
PBUPDRR
BLUEFORM
BKP0031D
RST0060M
RSTADHOC

080800
080800
080800
080800
080800
080800
080800
080800
080800
080800

REP
REP
REP
REP
REP
REP
PRT
BKP
CRS
RST

M24A
M18
M18
M22A
M01
M24
M22
M22
M22
M22

C O N T R O L

IOA KEY-STROKE REPORTING LANGUAGE (VER 6.0.00)

D
A C T I V E
E N V I R O N M E N T
-

WAIT
WAIT
WAIT
WAIT
WAIT
HELD
WAIT
WAIT
WAIT
WAIT

DATE 08/08/00 TIME 18.24 PAGE 000001

M I S S I O N S
L E F T

SCHEDULE
SCHEDULE
SCHEDULE
SCHEDULE
SCHEDULE
WAIT PROCESS
SCHEDULE
PROCESS
PROCESS
PROCESS

A C T I V E

E N V I R O N M E N T

M I S S I O N S

L E

F T

BMC Software, Inc., Confidential and Proprietary Information

5-44

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUFUPD Global Scan or Change of User Files

CTDUFUPD Global Scan or Change of User Files

This utility is primarily used to update History, Migration, Active, or
Permanent User files. Selection parameters are used as criteria for selecting
records to be changed. Change parameters specify the fields to be updated
and the values for those fields.
This utility can also be used to print and/or delete User file records that meet
the selection criteria.
The utility receives SELECT control statements followed by either CHANGE
TO statements or a DELETE statement.
The utility scans the files that are specified using FILE parameters, selects
the records that match the selection criteria, and either modifies those records
according to the parameters specified after the CHANGE TO statement, or
deletes the selected records if a DELETE statement is present.

Selection Criteria Processing

Eighteen fields can be used for specifying selection criteria. Thirteen of these
fields can be modified by CHANGE TO processing as described in the
following material.
There is no predefined order in which selection criteria must be listed. Values
specified for different fields are connected by a logical AND. Different
values specified for the same field are connected by a logical OR.

Examples
Example 1

SELECT
FILE=ACT
USER=ANDY
REPORT=MYREPORT

means that Active User file records containing USER=ANDY and

REPORT=MYREPORT are selected.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-45

CTDUFUPD Global Scan or Change of User Files

Example 2

SELECT
FILE=ACT
USER=ANDY
USER=MARY
REPORT=MYREPORT

means that Active User File records containing ((USER=ANDY or

USER=MARY) and REPORT=MYREPORT) are selected.
The * and ? masking characters can be used when specifying selection
criteria. For example, if USER=A* is specified, records whose USER field
starts with A is selected. If USER=B?D?F is specified, records whose USER
field contains B as the first letter, D as the third letter and F as the fifth letter
are selected.
At least one selection field value must be specified.

Change To Processing
All values specified after a CHANGE TO statement, until the end of the JCL
stream or until the next SELECT statement, replace the existing values in the
selected records. The ? wild-character can be used when specifying change
to values.
For example:
CHANGE TO
USER = a???????

means that the first character in the USER field is replaced with a and the
remaining 7 characters are not changed.
USER = a?b?????

means that the first character in the USER field is replaced with a, the third
character is replaced with b, and the other 6 characters are not changed.

BMC Software, Inc., Confidential and Proprietary Information

5-46

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUFUPD Global Scan or Change of User Files

Activating the Utility

Figure 5-18

CTDUFUPD Activation

//UFCH EXEC CTDUFUPD

//SYSIN DD *
SELECT
[FILE=ACT]
[FILE=HST]
[FILE=MIG]
[FILE=PRM]
[PRINT=DETAILS|SHORT]
[PRINT_LIMIT=nnn]
[SIMULATE=YES]
[WRITE_TO_FILE]
[USERFILE=DD_NAME]
[USER
= user
]
[DEC_TIME = ddmmyy[,hhmmss][ - ddmmyy[,hhmmss]]]
[TYPE
= type
]
[JOBNAME = jobname ]
[JOBID
= jobid
]
[ODATE
= odate
]
CHANGE TO
[USER
= user
]
[REPORT
= report ]
[CATEGORY = category]
[REMARK
= remark ]
[CLASS
= class
]
[DEST
= dest
]
[UDEST
= udest
]
[EXTWTR
= extwtr ]
[FORM
= form
]
[OUTPUT
= output ]
[PAGEDEF = pagedef ]
[FORMDEF = formdef ]
[FROMUSER = fromuser]
[CHARS
= chars
]
[COPY
= copies ]
SELECT
[FILE=ACT]
[FILE=HST]
[FILE=MIG]
[FILE=PRM]
[PRINT=DETAILS]
[SIMULATE=YES]

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-47

CTDUFUPD Global Scan or Change of User Files

[USER
[REPORT
[DEC_TIME
[TYPE
[JOBNAME
[JOBID
[ODATE
DELETE
//

=
=
=
=
=
=
=

user
]
report ]
ddmmyy[,hhmmss][ - ddmmyy[,hhmmss]]]
type
]
jobname ]
jobid
]
odate
]

Parameters
Selection Parameters

The following parameters can be specified after the SELECT statement:

Table 5-21

CTDUFUPD SELECT Parameters (Part 1 of 2)

Parameter

Description

FILE

Type of file to be acted upon. Specify at least one of the

following files:
ACT Active User Report List file.
HIST History User Report List file.
MIG Migration User Report List file.
PRM Permanent User Report List file. Mandatory.

PRINT

Indicates whether the search and update specifications are

written to the file referenced by DD statement PRINTDET. Valid
values:
DETAILS These protocols are written.
SHORT These protocols are not written.
Optional. Default: SHORT.

PRINT_LIMIT

Maximum number of lines that can be written to DD statement

PRINTDET. This parameter enables you to limit the number of
lines written when large User files are used. Optional. Default:
no limit.

SIMULATE

Files are not changed. However, a report of all records to be

updated or deleted is produced. Default.
Records are actually updated or deleted.

BMC Software, Inc., Confidential and Proprietary Information

5-48

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUFUPD Global Scan or Change of User Files

Table 5-21

CTDUFUPD SELECT Parameters (Part 2 of 2)

Parameter

Description

WRITE_TO_FILE

When used, this parameter causes all selectable fields of

either the selected primary or default USER records to be
written to the file referenced by DD statement WR2FILE. All
fields are written without delimiters, and both the full source
record key and the letter designating the source User Report
List file are added at the end of each record.

USERFILE

Enables you to specify a DD statement that references a

dataset containing the list of single USER field values or pairs
of USER field values.
When the referenced dataset contains single USER values, the
values are used to select matching source records.
When the referenced dataset contains pairs of USER values,
the first value of each pair is used to select the source record,
which is then replaced by the second value. Replacements
take place only after all changes are performed according to a
CHANGE TO statement.

Fields for After a SELECT Statement

Table 5-22

CTDUFUPD SELECT Fields (Part 1 of 2)

Field

Description

DECTIME

Earliest (and latest) decollation date and time of reports to be

selected. Optional.
Format:

date, time( - date,time)

Latest decollation date or time is optional even when the
earliest decollation date or time is specified. Decollation time
cannot be specified unless decollation date is also specified.
Records whose decollation date or time is within the specified
range are selected.
Date format is mmddyy, ddmmyy or yymmdd (depending on
the site standard defined in installation member IOAPARM).
Time format is hhmmss.
TYPE

Type of user record. Valid values are

U Default user record
R Primary user record for report
C Continuation record
Optional.

JOBNAME

Name of the job that produces the reports. Optional.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-49

CTDUFUPD Global Scan or Change of User Files

Table 5-22

CTDUFUPD SELECT Fields (Part 2 of 2)

Field

Description

JOBID

Job ID (maximum: 5 digits) of the job that produces the

reports. Optional.

ODATE

Order date of reports to be selected.

Format:

date[ - date]
Date format is mmddyy, ddmmyy or yymmdd (depending on
the site standard defined in installation member IOAPARM).
Optional.

Fields for After SELECT and CHANGE TO Statements

Table 5-23

CTDUFUPD SELECT and CHANGE TO Statements (Part 1 of 2)

Statement

Description

USER

Name of the user. Alphabetic characters. Maximum length: 8

characters without blanks. Optional.

REPORT

Name of the report. Alphabetic characters. Maximum length: 20

characters. Single () or double () quotes can be used if it is
necessary to include blanks. Optional.
Example: My report name or report name with quotes.

CATEGORY

Name of the category. Alphabetic characters. Maximum length:

20 characters. Single () or double () quotes can be used if it is
necessary to include blanks. Optional.
Example: My category name or category name with quotes.

REMARK

Name of exec remark. Alphabetic characters. Maximum length:

16 characters. Single () or double () quotes can be used if it is
necessary to include blanks. Optional.
Example: This is a remark or this is a remark with quotes.

CLASS

Original sysout class. Single character. Optional.

DEST

Destination of the report. Alphabetic characters. Maximum

length: 8 characters without blanks. Optional.

UDEST

TSO or CMS user ID. Second part of parameter

DEST=(node,userid). Alphabetic characters. Maximum length: 8
characters length without blanks. Optional.

EXTWTR

External writer name. Alphabetic characters. Maximum length: 8

characters without blanks. Optional.

FORM

Full form ID. Alphabetic characters. Maximum length: 4

characters without blanks. Optional.

OUTPUT

Output DD statement name. Alphabetic characters. Maximum

length: 8 characters without blanks. Optional.

PAGEDEF

PAGEDEF name. Alphabetic characters. Maximum length: 6

characters without blanks. Optional.

FORMDEF

FORMDEF name. Alphabetic characters. Maximum length: 6

characters without blanks. Optional.

BMC Software, Inc., Confidential and Proprietary Information

5-50

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUFUPD Global Scan or Change of User Files

Table 5-23

CTDUFUPD SELECT and CHANGE TO Statements (Part 2 of 2)

Statement

Description

FROMUSER

User ID of the user from whom the record was received.

Alphabetic characters. Maximum length: 8 characters without
blanks. Optional.

CHARS

Name of character arrangement tables. Alphabetic characters.

Maximum length: 4 characters without blanks.

COPY

Number of report copies to be printed with a print mission.

Numerical. Maximum length: 4 digits.

Work Flow of the Utility

The utility reads the SELECT and CHANGE TO or DELETE control
statements. For each file name defined in the FILE statement, the utility finds
the records that meet the selection criteria and updates or deletes each
selected record based on the CHANGE TO or DELETE control statement.
If the PRINT parameter is set to DETAILS, each selected record is written to
the file referenced by DD statement PRINTDET. If CHANGE TO is
specified, updated records are written to the same file so that changes to the
records can be seen.
If the WRITE_TO_FILE parameter is used, all the selectable fields of either
the selected primary or default USER records are written to the file
referenced by DD statement WR2FILE. These fields are written without
delimiters. The full source record key (that is, the concatenation of the
VSAUSER, VSAXKEY, and VSACOUNT fields) and the letter designating
the corresponding User Report List file are appended to the file referenced by
WR2FILE. Table 5-24 describes the VSAUSER, VSAXKEY, and
VSACOUNT fields:
Table 5-24

CTDUFUPD CONTROL Statement Fields

Field Name

Length

Description

VSAUSER

Name of the user

VSAXKEY

Job or beginning of report name

VSACOUNT

Timestamp of record creation

Instead of specifying selection criteria, you can optionally use the

USERFILE parameter to specify a file that contains the USER values of
source records to be changed or deleted.
Other selection criteria used in conjunction with parameter USERFILE are
processed together with the set of USER values contained in the file
referenced by DD statement specified in parameter USERFILE.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-51

CTDUFUPD Global Scan or Change of User Files

For example:
USERFILE=USFILEDD
USER=N52*

In this case, only records whose USER field starts with N52 and belong to
the set of records identified in the file referenced by DD statement
USFILEDD are selected.
The USERFILE parameter enables you to select a set of records that cannot
be easily selected using selection criteria. For example, using the
WRITE_TO_FILE parameter, you can create one list of users from the
Permanent User file and a second list of users from the Active User file. You
can then combine these two lists, using system tools, to prepare a file of
USER values that exist in the Permanent User file, but not in the Active User
file. This file of USER values can then be used with the USERFILE
parameter to delete unneeded records from the Permanent User file.
You can also use the USERFILE parameter to switch the first specified
USER values with the second specified values in the specified User Report
files. The corresponding pairs of USER values must be specified
consecutively, without delimiters, for each record in the dataset referenced by
the USERFILE parameter. These pairs must be located at the beginning of
each record.
Figure 5-19

CTDUFUPD Example 1

//UPDATE
EXEC CTDUFUPD
//SYSIN DD *
SELECT
FILE=ACT
USER=USER1*
DEC_TIME = 072500
PRINT=DETAILS
//

In this example, the utility selects Active User file records whose USER field
starts with USER1 and whose decollation date is 25 July 2000. All the
selected records are written to the file referenced by DD statement
PRINTDET.

BMC Software, Inc., Confidential and Proprietary Information

5-52

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUFUPD Global Scan or Change of User Files

Figure 5-20

CTDUFUPD Example 2

//UPDATE
EXEC CTDUFUPD
//SYSIN DD *
SELECT
FILE = ACT
USER = USER1*
USER = USER3*
DEC_TIME = 071700 - 081600
PRINT = DETAILS
SIMULATE = NO
CHANGE TO
USER = BMCU????
//

In this example, the utility selects Active User file records where the USER
field value begins with USER1 or USER3 and the decollation date is between
17 July 2000 and 16 August 2000. In the selected records, field USER is
updated by changing the first 4 characters to BMCU and not changing the
remaining characters.
Because SIMULATE is set to NO, records are actually updated.
Figure 5-21

CTDUFUPD Example 3

//UPDATE
EXEC CTDUFUPD
//SYSIN DD *
SELECT
FILE = ACT
USER = USER5*
DEC_TIME = 071700 081600
ODATE =
PRINT = DETAILS
SIMULATE = NO
DELETE
//

In this example, the utility selects Active User file records where the value of
field USER begins with USER5, the decollation date is between 17 July 2000
and 16 August 2000, and the ODATE field is blank. All the selected records
are deleted from the Active User file.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-53

CTDULD User File Report List Load

CTDULD User File Report List Load

Utility CTDULD copies records from a sequential file to the current User
Report List file (meaning, an Active, Permanent, History or Migrated User
Report List file). This utility can be run simultaneously with other
applications (for example, the CONTROL-D or CONTROL-V Online
facility) that use the specified file. It is not necessary to close the
CONTROL-D or Online monitors when this utility runs.
Utilities IOADLD (Load IOA Access Method File Contents) and CTDDIB
(Rebuild Index Component of a User Report List File) can be used for the
same purpose but cannot be run simultaneously with other applications that
use the specified file.

Parameters
The following parameters are specified in the EXEC statement that invokes
the CTDULD JCL procedure:
Table 5-25

CTDULD Parameters

Parameter

Description

DBFILE

File to be updated. Mandatory. Valid values are:

ACT Active User Report file.
PRM Permanent User Report file.
HST History User Report file.
MIG Migration file.

SEQ

Name of the sequential input file. Mandatory.

REPLACE

Indicates whether existing records with the same key are

replaced. Optional. Valid values are:
Y (Yes) Replace existing records that have the same key.
N (No) Do not replace existing records. Input records with the
same key are rejected. Default.

Activating the Utility

// EXEC CTDULD,DBFILE=ACT|PRM|HST|MIG,SEQ=input-file[,REPLACE=Y|N]

Member CTDUFLD of the CONTROL-D JCL library contains a sample job

for using this utility.

BMC Software, Inc., Confidential and Proprietary Information

5-54

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUPBKP Update Backup and Migration Details

CTDUPBKP Update Backup and Migration Details

This utility is primarily used to update retention period and backup volume
serial numbers in History, Migration, or Active User Report List files.
This utility can also be used:

To aid in the conversion from CA-DISPATCH. For details, see

Converting from CA-DISPATCH on page 5-55.

To switch PRIMARY and SECONDARY information in the Migrated

User Report List file.

The utility receives the following groups of parameters:

Selection parameters
CHANGETO parameters
Report parameters

The utility scans the files that are specified using the Selection parameters
and modifies the specified records in those files according to the
CHANGETO parameters. Report parameters specify characteristics of the
report to be produced.

Converting from CA-DISPATCH

When converting from CA-DISPATCH, this utility enables you to change the
archive volume name and the number of files that were backed up by
CA-DISPATCH. This functionality is provided using parameter RECVOL
(described under Selection Parameters below) and DD Statement RECVOL
(described here).

DD Statement RECVOL

If the value of selection parameter RECVOL is set to YES, utility

CTDUPBKP retrieves the volume name from DD statement RECVOL.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-55

CTDUPBKP Update Backup and Migration Details

The format of the RECVOL DD statement is:

OLDVOL(OFLE)

NEWVOL(NFLE)

where
Table 5-26

CTDUPBKP Parameters

Statement

Description

OLDVOL

The volser of the old archive (specified at column 1).

OFLE

The number of the old file. Optional. For converting from

CA-DISPATCH only.

NEWVOL

The volser of the new archive.

NFLE

The new file number. Optional. For converting from

CA-DISPATCH only.

If parameters OFLE the NFLE are specified in one of the DD statements,

they must be specified in all other DD statements.
If parameters OLDVOL and OFILE match a report entry, the corresponding
fields in the reports SYSDATA records are changed to the NEWVOL and
NFLE values in the input flow.
Figure 5-22

RECVOL DD Statement Examples

//RECVOL DD *
VOLO01(0012) VOLN01(0005)
........
........
........
........
/*

//RECVOL DD *
VOLO03
VOLN03
........
........
........
........
/*

BMC Software, Inc., Confidential and Proprietary Information

5-56

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUPBKP Update Backup and Migration Details

Activating the Utility

Figure 5-23

CTDUPBKP Activation

//UPDATE
EXEC CTDUPBKP
//DAUIN
DD *
SELECT
[FILE=ACT]
[FILE=HST]
[FILE=MIG]
[JOBNAME=jobname]
[JOBID=jobid]
[DECFROM=ddmmyy,hhmmss]
[DECTO=ddmmyy,hhmmss]
[BKPFROM=ddmmyy,hhmmss]
[BKPTO=ddmmyy,hhmmss]
[BKPMIS=backup migration mission name]
[PLATTER=platter name]
[VOLSER=old volser]
[REVOL=YES|NO]
[SIMULATE=YES|NO]
CHANGE TO
[GENER=number of generation|NONE]
[RETPD=retention period]
[VOLSER=new volser]
[SECONDARY|PRIMARY]
NEWBKP=new-backup-mission
NEWMIG=new-migrat-mission
/*
//DAULST
DD *
[PRINTSYS]
[DETAIL]
[UNMATCH=ALL|VOLSER]
/*
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-57

CTDUPBKP Update Backup and Migration Details

Selection Parameters
The following parameters can be specified in the SELECT statement:
Table 5-27

CTDUPBKP SELECT Parameters (Part 1 of 2)

Parameter

Description

FILE

Type of file to be acted upon. Mandatory. Specify at least one

of the following files:
ACT Active User Report List file.
HST History User Report List file.
MIG Migration User Report List file.

JOBNAME

Name of the job that produced the reports. Optional.

JOBID

Job ID (maximum: 5 digits) of the job that produced the

report. Optional.

DECFROM

Earliest decollation date and time of reports to be selected for

update.
Format: date, time
Both parameters are optional, but time cannot be specified
without specifying date.
Date format is mmddyy, ddmmyy or yymmdd (depending on
the site standard defined in installation member IOAPARM).
Time format is hhmmss.

DECTO

Latest decollation date and time of reports to be selected for

update.
Format: date, time
Both parameters are optional, but time cannot be specified
without specifying date.
Date format is mmddyy, ddmmyy or yymmdd (depending on
the site standard defined in installation member IOAPARM).
Time format is hhmmss.

BKPFROM

Earliest backup date and time of reports to be selected for

update.
Format: date, time
Both parameters are optional, but time cannot be specified
without specifying date.
Date format is mmddyy, ddmmyy or yymmdd (depending on
the site standard defined in installation member IOAPARM).
Time format is hhmmss.

BKPTO

Latest backup date and time of reports to be selected for

update. Format: date, time. Both parameters are optional, but
time cannot be specified without specifying date.
Date format is mmddyy, ddmmyy or yymmdd (depending on
the site standard defined in installation member IOAPARM).
Time format is hhmmss.

BKPMIS

Backup or migration mission name. Validity checks are

identical to those of DO BACKUP or DO MIGRATE in the
decollation mission definition. Optional.

BMC Software, Inc., Confidential and Proprietary Information

5-58

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUPBKP Update Backup and Migration Details

Table 5-27

CTDUPBKP SELECT Parameters (Part 2 of 2)

Parameter

Description

VOLSER

Volume serial number (maximum 6 characters) to be

updated. A maximum of 10 volume serial numbers can be
specified. Optional. Example: 444444, 555555, 666666.
Parameter VOLSER cannot be used with parameter
RECVOL.

RECVOL

The volume to be updated is retrieved from DD statement

RECVOL (instead of from parameter VOLSER). This
parameter enables users who converted from CA-DISPATCH
to CONTROL-D to change the archive volume name and the
number of files that were backed up in CA-DISPATCH. Valid
values are:
NO The volume to be updated is retrieved from
parameter VOLSER. Default.
YES Both the volume to be updated, and the value to use
when updating, are retrieved from DD statement RECVOL.
Parameter RECVOL cannot be used with parameter
VOLSER.

PLATTER

Platter name.(maximum: 9 characters.) This parameter is

used as a selection parameter for migration files and can be
specified for Kodak OptiStar Storage System (OSS) only.

SIMULATE

Valid values are:

YES Files are not updated. Only a report of all records to
be updated is produced. Default.
NO Files are actually updated.

CHANGETO Parameters
The following parameters can be specified in the CHANGETO area:
Table 5-28

CTDUPBKP CHANGETO Parameters (Part 1 of 2)

Parameter

Description

GENER

Number of generations. Valid values are:

nnnn Valid numeric value greater than zero. Only the FILE
and BKPMIS parameters can be defined in the SELECT area.
The RETPD parameter, described in this table, must not be
defined in the CHANGETO area. Reports belonging to the
Backup mission are switched from DAYS TO KEEP method to
the GENERATIONS TO KEEP method. The value of DAYS
TO KEEP is automatically set to 0000. If there is no
corresponding Backup control record in the History file, this
utility creates it.
NONE The RETPD parameter must be defined in the
CHANGETO area. Reports belonging to the Backup mission
are switched from GENERATIONS TO KEEP method to the
DAYS TO KEEP method.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-59

CTDUPBKP Update Backup and Migration Details

Table 5-28

CTDUPBKP CHANGETO Parameters (Part 2 of 2)

Parameter

Description

RETPD

Four-digit value identical to the # DAYS TO KEEP value in the

Backup mission.
If this parameter is specified without specifying parameter
GENER, the value of parameter GENERATIONS TO KEEP must
be 0 in the corresponding Backup control record in the History
Report List file. Otherwise, utility CTDUPBKP produces an error
message.

VOLSER

A new volume serial number (maximum 6 characters) for the

volume be updated. A maximum of 10 volsers can be specified
(for example, 111111, 222222, 333333). The number of volsers
specified must be identical to the number of volsers specified in
the SELECT area (described above).
Note: If the RECVOL parameter, described in Table 5-27, is
specified in the Selection group of parameters, the new volume
serial number is based on the specifications in DD statement
RECVOL.

PRIMARY

If utility CTDUPBKP was previously run with parameter

SECONDARY specified, running this utility again with parameter
PRIMARY causes the primary migrated copy of CDAM and index
files to be used when accessing the migrated report. Parameter
FILE must be set to MIG in the SELECT area.

SECONDARY

If utility CTDUPBKP is run with parameter SECONDARY

specified, the secondary migrated copy of CDAM and index files
are used when accessing the migrated report. Parameter FILE
must be set to MIG in the SELECT area. If there is no secondary
migration information, in SYSDATA or the index record, this
parameter is ignored.
Note: Parameters PRIMARY and SECONDARY are relevant if a
value was specified for parameter SECONDARY was specified in
the Migration Mission Definition screen.

NEWBKP

Name for the new backup mission. This parameter is relevant

only for reports that have yet to be backed up (meaning, not for
reports that have already been backed up, even if the
corresponding User and SYSDATA records are located in the
Active User file).

NEWMIG

Name for the new migration mission. This parameter is relevant

only for reports located in the Migration file and for reports
located in the Active user file not for reports that have already
been migrated, even if the corresponding User and SYSDATA
records are located in the Active User file.

BMC Software, Inc., Confidential and Proprietary Information

5-60

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUPBKP Update Backup and Migration Details

Report Parameters
By default the utility produces a report for all the SYSDATA records that
were selected according to the SELECT parameters. The report contains the
most up-to-date backup information in these SYSDATA records. Additional
reports are available by specifying the following parameters in DD statement
DAULST:
Table 5-29

CTDUPBKP Report Parameters

Parameter

Description

UNMATCH

Produce a report listing all volsers in the files that did not match
any of the old volsers defined in the input file referenced by DD
statement DAUIN.

ALL

Produces this report in any case.

VOLSER

Produces a report only if volser update was requested.

PRINTSYS

Produce a report detailing all SYSDATA records.

If parameter VOLSER is specified in the CHANGETO area, a report can be

produced containing a list of old and new VOLSERs. This report is produced
if parameter DETAIL is specified in the Report parameters.
Table 5-30

CTDUPBKP Detail Parameter

Parameter

Description

DETAIL

Print a detailed report for all volsers found in the files, including
the backup job name, date and time. This report is available only
when a new volser is requested. This report replaces the default
report.

Note:

If parameter DETAIL is specified without specifying parameter

VOLSER in the CHANGETO area, the default report is also not
produced.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-61

CTDUPBKP Update Backup and Migration Details

Figure 5-24

CTDUPBKP Example 1

//UPDATE
EXEC CTDUPBKP
//DAUIN
DD *
SELECT
FILE=HST
DECFROM=250600,1000
DECTO=270600,1500
BKPFROM=260600,1000
BKPTO=280600,1500
BKPMIS=BKP001
SIMULATE=YES
CHANGETO
/*
//DAULST
DD *
//

The utility creates a report for the History file. Every SYSDATA that was
created from 25/06/00 at 10 a.m. until 27/06/00 at 3 p.m. and was backed up
from 26/06/00 at 10 a.m. until 28/06/00 at 3 p.m. by backup mission BKP001
is printed in this report.
Figure 5-25

CTDUPBKP Example 2

//UDPATE
EXEC CTDUPBKP
//DAUIN
DD *
SELECT
FILE=ACT
FILE=HST
BKPFROM=260600,1000
BKPTO=280600,1500
BKPMIS=BKP001
VOLSER=VOL001
SIMULATE=NO
CHANGETO
RETPD=0100
VOLSER=VOL002
//DAULST
DD *
PRINTSYS
DETAIL

If a CDAM was backed up to volser VOL001 from 26/06/00 at 10 a.m. until

28/06/00 at 3 p.m. by backup mission BKP001, the corresponding SYSDATA
from the Active User Report List file and History User Report List file are
changed. The new value of RETPD is 100 and the new value of VOLSER is
VOL002. A report about every SYDATA from the Active User Report List
file and the History User Report List file and a detailed report about every
changed SYSDATA is produced.

BMC Software, Inc., Confidential and Proprietary Information

5-62

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUPBKP Update Backup and Migration Details

Figure 5-26

CTDUPBKP Example 3

//UPDATE
EXEC CTDUPBKP
//DAUIN
DD *
SELECT
FILE=MIG
BKPMIS=MIG001
PLATTER=PLATTER01
SIMULATE=YES
CHANGETO
SECONDARY
//DAULST
DD *

In this example, a simulation is performed for switching SYSDATA and

INDEX records of the Migrated User Report List file to use the secondary
migrated CDAM files. Only the SYSDATA and INDEX records for CDAM
files that migrated to platter PLATTER01 by migration mission MIG001 are
selected. The result of this simulation is a report of the selected SYSDATA
records. No change is made to the records themselves.
Figure 5-27

CTDUPBKP Example 4

//UPDATE
EXEC CTDUPBKP
//DAUIN
DD *
SELECT
FILE=HST
BKPMIS=BKP001
SIMULATE=NO
CHANGETO
GENER=0005
//DAULST
DD *

SYSDATA records referring to backup mission BKP001 are set to use the #
o f G E N E R AT I O N S TO K E E P method. (In this example, 5 generations
are used.) A report for the modified SYSDATA records is produced.
For an example of how to update backup information in CONTROL-D User
Report List files, see sample job CTDUBKPJ in the CONTROL-D JCL
library.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-63

CTVCLMIG Clean Migrated CDAM Files

CTVCLMIG Clean Migrated CDAM Files

This CONTROL-V utility cleans entries from the Migrated User Report List
file and erases and/or uncatalogs the CDAM datasets and index files that
belong to these entries.
The Migrated User Report List file contains entries describing migrated user
reports and indexes. Each report has a retention period. The utility scans the
Migrated User Report List file for all the reports whose retention period has
passed or for that a new stage has been successfully created and deletes them
from the Migrated User Report List file.
For non-DASD reports, the utility produces a list of cartridges that can be
returned to the global tape pool. However, a list of expired cartridges is not
produced when using continuous migration to cartridge because each
cartridge contains files with different expiration dates.
For FileTek migrated reports, a temporary file with report names and their
MEDIA type is created. This file is processed by the next step that deletes
them from the FileTek SM.

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the CTVCLMIG JCL procedure:
Table 5-31

CTVCLMIG Parameters (Part 1 of 2)

Parameter

Description

MODE

Determines whether utility CTVCLMIG is run in Production

mode or Simulation (Test) mode. Optional. You should run
this utility in Simulation mode before running it in Production
mode.
PROD The utility runs in Production mode, changing and
deleting report entries and CDAM files that satisfy the
requirements specified by other parameters. Default.
TEST The utility runs in Simulation mode, performing
analysis and reporting but not changing or deleting any
files.

BMC Software, Inc., Confidential and Proprietary Information

5-64

INCONTROL for OS/390 and z/OS Utilities Guide

CTVCLMIG Clean Migrated CDAM Files

Table 5-31

CTVCLMIG Parameters (Part 2 of 2)

Parameter

Description

NOSYS

Determines if utility CTVCLMIG checks for orphan User

records; meaning, User records that do not have
corresponding SYSDATA records. Optional. When parameter
NOSYS is set to Y (Yes) or is not specified, utility CTVCLMIG
checks for orphan entries and issues a message for each one
found. Default.
When parameter NOSYS is set to N (No), the utility does not
check for orphan entries. However, the performance of the
utility is substantially improved.

NOLOCATE

This optional parameter bypasses the LOCATE action for all

migrated files. This parameter can only be specified if the
LIST OF TAPES TO DELETE is not produced by utility
CTVCLMIG (when Wish WV0241 is applied).
Utility CTVCLMIG normally performs a LOCATE action for
each migrated CDAM file. This LOCATE action can be
bypassed by specifying parameter NOLOCATE. Skipping the
LOCATE action can save a significant amount of time, but the
utility may not detect files that were accidentally erased.

Activating the Utility

// EXEC CTVCLMIG[,MODE=TEST|PROD,NOSYS=Y|N,LOC=NOLOCATE]

Return Codes
Table 5-32

CTVCLMIG Return Codes

Code

Description

Operation performed successfully

Operation performed successfully (for HSM backup utility)

Execution error

11

Operation performed successfully (in TEST mode)

12

Invalid input parameters

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-65

CTVDELI Delete Index Files from DASD

CTVDELI Delete Index Files from DASD

This CONTROL-V utility scans the Migrated User Report List file and erases
from the disk index files that are no longer needed on DASD. The utility
determines which indexes to delete based on user-specified selection groups.
Note:

Indexes deleted from DASD by utility CTVDELI are retrieved from

the migrated media when required.

A selection group consists of a DAYS statement and optional INCLUDE /

EXCLUDE statements. The DAYS statement contains a retention period that
specifies the number of days the indexes remain on DASD, after that they are
deleted by the utility. The optional INCLUDE / EXCLUDE statements
further qualify which indexes belong to the selection group.
By specifying multiple selection groups, each with its own retention period
(and INCLUDE / EXCLUDE statements), groups of entries with differing
retention periods can be deleted by a single execution of utility CTVDELI.
For information about prefixing, masking and the INCLUDE / EXCLUDE
logic used to determine record selection, see the topic Record Selection
Logic (INCLUDE / EXCLUDE Statements) on page 7-6 in Chapter 7,
CONTROL-M/Tape Utilities.
Selection groups are scanned sequentially. The processing of a report is
determined by the first selection group whose INCLUDE / EXCLUDE
criteria match the index. INCLUDE / EXCLUDE criteria in other selection
groups are ignored for that index.
$INDEX records are not deleted from the Migrated User Report List file
because they are needed for accessing the migrated index file.
After an index file is deleted, a flag indicating INDEX DELETED FROM
DASD is placed in the corresponding $INDEX record.

BMC Software, Inc., Confidential and Proprietary Information

5-66

INCONTROL for OS/390 and z/OS Utilities Guide

CTVDELI Delete Index Files from DASD

EXEC Statement
The EXEC statement can contain the following parameter:
Table 5-33

CTVDELI Parameters

Parameter

Description

MODE

Determines whether utility CTVDELI is run in Production

mode or Simulation mode. Optional. You should run this utility
in Simulation mode before running it in Production mode.
PROD The utility runs in Production mode, deleting index
files that satisfy the requirements specified by other
parameters. Default.
TEST The utility runs in Simulation mode, performing
analysis and reporting but not deleting any indexes.

DAYS Statement
Parameters in the DAYS Statement

The DAYS statement can contain the following parameters:

Table 5-34

CTVDELI DAYS Parameters

Parameter

Description

Retention period (in days) after that the index expires and is
selected for deletion from the Active User Report List file by the
selection group. Mandatory. This parameter must be the first
parameter in the statement.
By default, the index expires n days from the Original Scheduling
Date (ODATE) of the Report decollating mission. The
INCONTROL administrator can change the default so that n is
calculated from the decollation date.
n can be a negative number (to delete reports created on future
ODATEs) and cannot exceed 9999.

RESIDENT

If RESIDENT is specified, resident indexes are deleted.

Otherwise, resident indexes are not deleted.
Parameter RESIDENT only applies to the specific selection
group in which it appears. It can be specified for as many
selection groups as necessary.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-67

CTVDELI Delete Index Files from DASD

INCLUDE / EXCLUDE Statements

If multiple INCLUDE / EXCLUDE statements are specified, each statement
can contain any or all of the parameters listed below separated by a space.
However, each parameter can appear no more than once in each statement.
For more information about INCLUDE / EXCLUDE statements, see the
topic Record Selection Logic (INCLUDE / EXCLUDE Statements) on
page 7-6 in Chapter 7, CONTROL-M/Tape Utilities.

Parameters in INCLUDE / EXCLUDE Statements

Each INCLUDE / EXCLUDE statement must contain at least one of the

following parameters:
Table 5-35

CTVDELI INCLUDE / EXCLUDE Parameters

Parameter

Description

JOBNAME

Job name or prefix.

JOBID

Job ID (format Jnnnnn).

REPNAME

Report name or prefix.

If the report name contains embedded spaces, replace each
embedded space with the @ character.

IXNAME

Index name or prefix.

By default, the values specified for JOBNAME, REPNAME and IXNAME

are treated as prefixes. To prevent a value from being considered a prefix,
place the special character < after the value.

BMC Software, Inc., Confidential and Proprietary Information

5-68

INCONTROL for OS/390 and z/OS Utilities Guide

CTVDELI Delete Index Files from DASD

Activating the Utility

Figure 5-28

CTVDELI Activation

// EXEC CTVDELI[,MODE=TEST|PROD]
DAYS
n
[RESIDENT]
[INCLUDE
[JOB NAME=Jobname]
[IXNAME=indexname]
[EXCLUDE
[JOB NAME=Jobname]
[IXNAME=indexname]
DAYS statement
[INCLUDE statement]
.
.
[EXCLUDE statement]
.
.
.

[JOBID=jobid]
[REPNAME=repname]
[JOBID=jobid]
[REPNAME=repname]

Examples
Example 1
//S1

EXEC

CTVDELI
DAYS 3

All nonresident indexes that are older than three days are deleted.

Example 2
//S1

EXEC CTVDELI
DAYS 0

A disk space saver. All nonresident indexes are deleted.

Example 3

//S1

EXEC CTVDELI
DAYS 5
INCLUDE REPNAME=PROD-JCL

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-69

CTVDELI Delete Index Files from DASD

All indexes of reports with name prefix PROD-JCL that are more than five
days old are deleted.

Example 4

//S1

EXEC CTVDELI
DAYS 0
RESIDENT
INCLUDE JOBNAME=Y99BUP01

JOBID=01923

All indexes (including resident indexes) with the specified job name and job
ID are deleted.

Example 5

Assume the following index names exist: ACCT, ACCT-REC, ACCT-PAY.

//S1

EXEC CTVDELI
DAYS 0
INCLUDE IXNAME=ACCT

All of the above indexes are deleted.

//S1

EXEC CTVDELI
DAYS 0
INCLUDE IXNAME=ACCT<

Only index ACCT is deleted.

Example 6

//S1

EXEC CTVDELI
DAYS 0
EXCLUDE IXNAME=PROD-NDX

JOBNAME=P01

All nonresident indexes are deleted from DASD except:

Indexes whose name begins with PROD-NDX.

Indexes for reports produced by jobs whose name begins with P01.

BMC Software, Inc., Confidential and Proprietary Information

5-70

INCONTROL for OS/390 and z/OS Utilities Guide

CTVGICL Clean Global Indexes

CTVGICL Clean Global Indexes

CONTROL-V utility CTVGICL removes report entries that no longer exist in
Active or Migrated User Report files. The utility determines which Global
Index Database records and which Active and Migrated User Report files to
scan, according to specified input parameters.

Parameters
The following parameters can be specified to the utility in the SYSIN DD
statement.
Table 5-36

CTVGICL Parameters (Part 1 of 3)

Parameter

Description

MODE

Determines whether utility CTVGICL is run in Production

mode or Simulation (Test) mode. Optional.
BMC Software recommends running this utility in Simulation
mode before running it in Production mode.
Valid values are:
PROD The utility runs in Production mode, performing
the actual index deletions. Default.
TEST The utility runs in Simulation mode, performing
analysis and reporting, but not deleting any indexes.

DO

Indicates whether to delete an index path, report entries, or a

selected index value. Mandatory.
Valid values are:
DELPATH Delete an index path
DELRPT Delete a report
DELVAL - Delete an index value

TRACE

Indicates whether to perform a trace during utility execution.

Optional.
Valid values are:
NO Do not perform a trace. Default.
YES Perform a trace.

DELPATH

Specifies the index path to delete. Mandatory and valid only if

the DO parameter was set to DELPATH or DELVAL.
If this parameter is not followed by the VAL parameter, all
index values of the specified index path are removed.
Otherwise, only the index values specified in the VAL
statement are removed.
Note: This parameter can be specified multiple times for
multiple paths. Locations are separated by a slash, in the
format pathlevel1/level2/level3/...

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-71

CTVGICL Clean Global Indexes

Table 5-36

CTVGICL Parameters (Part 2 of 3)

Parameter

Description

VAL

Specifies the index value to delete. Optional.

The value should include all index levels without separators.
Specify any values that contain blanks within apostrophes.
Note: Up to 100 VAL statements for different index values
can follow the DELPATH parameter.

The following parameters are valid only if the DO parameter was set to DELRPT.
Only VSA keys that apply to the selection criteria are candidates for deletion. This
enables you to minimize the amount of work the utility must perform, or allows the
deletions to be spread over several runs of the utility
FROMPATH

Specifies the prefix of path names from which VSA keys are
read.
This parameter is not used for the Global Index if it is
implemented above DB2.

TOPATH

Specifies the prefix of path names to which VSA keys are

read.
This parameter is not used for the Global Index if it is
implemented above DB2.

FROMVAL

Specifies the prefix of value names from which VSA keys are
read.
This parameter is not used for the Global Index if it is
implemented above DB2.

TOVAL

Specifies the prefix of value names to which VSA keys are

read.
This parameter is not used for the Global Index if it is
implemented above DB2.

AGE

Specifies the time that must pass before a VSA key is

deleted.
The timestamp in the VSA key is checked. If the report is
newer than the specified timestamp, the report is not checked
for deletion. The timestamp of the VSA key is the time the
report was entered into CONTROL-D.

JOBNAME

Specifies the job name prefix.

Only VSA keys with this job name prefix are checked for
deletion.

REPORT

Specifies the report name prefix.

Only VSA keys with this report name prefix are checked for
deletion.
Note: Wish WD1164 determines whether the report key
holds a job name or a report name. Specify the appropriate
JOBNAME or REPORT parameter to the utility. If both
parameters are specified to the utility, only the relevant
parameter is checked

USER

Specifies the list of user name prefixes.

BMC Software, Inc., Confidential and Proprietary Information

5-72

INCONTROL for OS/390 and z/OS Utilities Guide

CTVGICL Clean Global Indexes

Table 5-36

CTVGICL Parameters (Part 3 of 3)

Parameter

Description

DB2TABLE

Specifies the name of the DB2 table where the entries should
be removed. Can be specified several times or can be
omitted. If this parameter is omitted all DB2 tables specified in
the CTDGIDB2 member are checked for deletion
This parameter is not used for the Global Index if it is
implemented above the IOA Access Method.

PORTION

Specifies the number of deleted entries after witch commit is

performed. Default: 1000
This parameter is not used for the Global Index if it is
implemented above the IOA Access Method.

REPLIST

Indicates whether to use the list of deleted reports produced

by the CTDDELRP or CTVCLMIG utility. This parameter is
used only for the Global Index if it is implemented above DB2.
Optional.
Valid values are:
NO The utility determines which VSA entries no longer
exist in Active and Migrated User files. Default.
YES The utility uses the input list of deleted reports
produced by the CTDDELRP or CTVCLMIG utility. Only
VSA keys included in this list are deleted; all Selection
criteria are ignored.

Activating the Utility

Figure 5-29

CTVGICL Activation

// EXEC CTVGICL
MODE={PROD|TEST} DO={DELPATH|DELRPT|DELVAL}
[TRACE=YES|NO] [DELPATH=path] [VAL=index_value]
[FROMPATH=pathprefix] [TOPATH=pathprefix]
[FROMVAL=valueprefix] [TOVAL=valueprefix]
[JOBNAME=jobnamprefix] [REPORT=repnamprefix] [AGE=period]
[USER=(list of user prefixes)] [DB2TABLE=DB2_table_name]
[PORTION=portion] [REPLIST=NO]

Return Codes
Table 5-37

CTVGICL Return Codes (Part 1 of 2)

Code

Description

All paths and reports were successfully deleted.

The utility ended with a warning. For further information, see the
specific warning message.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-73

CTVGICL Clean Global Indexes

Table 5-37

CTVGICL Return Codes (Part 2 of 2)

Code

Description

An error occurred during the process. For details, see the error
messages for each input file.

16

A severe error occurred during the process. For details, see the
error messages for each input file.

Examples
Example 1

// EXEC CTVGICL
//SYSIN DD *
DO=DELRPT MODE=PROD FROMPATH=STATE
TOPATH=STATE TRACE=YES
//

For the Global Index implemented above the IOA Access Method. In
Production mode, delete report entries from the path beginning with the
prefix STATE. Issue trace messages during the utility run.

Example 2

// EXEC CTVGICL
DO=DELPATH DELPATH=INDEXA MODE=PROD
//

For the Global Index implemented above the IOA Access Method. In
Production mode, delete the index path INDEXA and its subpaths.

Example 3

// EXEC CTVGICL
DO=DELRPT MODE=PROD DB2TABLE=CTD.GIR
PORTION=2000 JOBNAME=K06*
//

For the Global Index implemented above DB2. In production mode, delete
report entries for the job names beginning with the prefix K06, from DB2
table CTD.GIR. Commit is issued after every 2000 entries are deleted.

BMC Software, Inc., Confidential and Proprietary Information

5-74

INCONTROL for OS/390 and z/OS Utilities Guide

CTVGICL Clean Global Indexes

Example 4

// EXEC CTVGICL
DO=DELRPT MODE=PROD TABLE=CTD.GIR
REPLIST=YES
//

For the Global Index implemented above DB2. In production mode, delete all
report entries according to the list of deleted reports produced by the
CTDDELRP or CTVCLMIG utilities. Commit is issued after every 1000
entries are deleted.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-75

CTVJAR Job Archiving Utility

CTVJAR Job Archiving Utility

Utility CTVJAR consolidates reports that are contained in the same CDAM
file and creates a new report, JOBNAME, whose index points to each jobs
data. This utility economizes by reducing the number of user $SYSDATA and
$INDEX records in the database. This is especially important for migrated
reports, since they are usually kept for a long period of time.

Index Format
Table 5-38

CTVJAR Index Formats

Format

Description

JOBNAME

Name of the job.

JOBID

ID of the job.

SMFID

SMF ID of the system in which the job ran.

COMP-CODE

Completion code of the job.

DATE

Date of the job.

START-TIME

Start time of the job.

END-TIME

End time of the job.

When the option to define a DDNAMES index for the reports in the initial
decollation is selected, utility CTVJAR creates an index as a subindex in the
new report. For more information, see the discussion about job archiving in
the CONTROL-D and CONTROL-V chapter in the INCONTROL OS/390
and z/OS Administrator Guide.)
The utility determines which reports to consolidate based on input parameters
specified in DD statement SYSIN. The utility also verifies that it is a
JOBSDSN1 decollation.
Note:

If reports from the current date are consolidated, the utility

synchronizes its activity with the decollation process. For a further
description, see CTDDELRP Delete Reports that are not
Needed on page 5-25. This avoids a situation in which utility
CTVJAR attempts to collect reports that are still being created by the
decollation process.

Activating the Utility

//JCLARC
EXEC
//SYSIN DD *

PGM=CTVJAR[,MODE=PROD, TEST]

BMC Software, Inc., Confidential and Proprietary Information

5-76

INCONTROL for OS/390 and z/OS Utilities Guide

CTVJAR Job Archiving Utility

EXEC Statement
The EXEC statement can contain the following parameters:
Table 5-39

CTVJAR EXEC Parameters

Parameter

Description

MODE

Determines whether utility CTVJAR is run in Production or

Simulation mode. Optional. You should run this utility in
Simulation mode before running it in Production mode.
PROD The utility runs in Production mode, consolidating
reports and creating the JOBNAME report. Default.
TEST The utility runs in Simulation mode, producing a
sysout that indicates the operations that are performed in
Production mode.

The following parameters are passed to the utility using DD statement

SYSIN:
Table 5-40

CTVJAR SYSIN Parameters

Parameter

Description

PREFIX

Prefix of the CDAMs that are to be consolidated.

FODATE

From ODATE of the consolidated reports in DD/MM/YY format.

TODATE

To ODATE of the consolidated reports in DD/MM/YY format.

Note: If both FODATE and TODATE are not specified or specified
as blank, all reports in the Active User Report List file that were
created until yesterday are consolidated. If only one of these
parameters is specified, reports with this ODATE are
consolidated. If both FODATE and TODATE are specified, reports
whose ODATE is within the specified range are consolidated.

REPNAME

Name of the newly created report. If blanks or apostrophes are

included in the report name, they must be specified between
apostrophes and the apostrophes of the report name must be
doubled.

USER

Name of the user for whom the new report are created.

MIGMIS

Migration mission name for the new report.

BKPMIS

Backup mission names for the new report. Up to 6 names can be

specified within brackets separated by a comma.

PRTMIS

Print mission names for the new report. Up to 5 names can be

specified within brackets separated by a comma.

SYNC

Indicates whether or not to synchronize with decollation.

Optional. Valid values are:
YES Synchronize with decollation. Accumulation of jobs into
a currently open CDAM is stopped and a new CDAM is
opened.
NO Do not synchronize with decollation. Jobs of currently
opened CDAM files are not consolidated. Default.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-77

CTVJAR Job Archiving Utility

Figure 5-30

CTVJAR Example

//CTVJAR
EXEC PGM=CTVJAR,PARM=PROD
//STEPLIB DD DSN=IOAP.V600.LOAD,DISP=SHR
//DATRACE DD SYSOUT=*,HOLD=YES
//ERRLOG
DD SYSOUT=*,HOLD=YES
//DALOG
DD DISP=SHR,DSN=IOAP.V600.LOG
//DATREE
DD DISP=SHR,DSN=CTDP.V60.PARM(CTDTREE)
//SYSPRINT DD SYSOUT=*,HOLD=YES
//SORTIN
DD UNIT=SYSALLDA,SPACE=(CYL,(20,40))
//SORTOUT DD UNIT=SYSALLDA,SPACE=(CYL,(20,40))
//SORTWK01 DD UNIT=SYSALLDA,SPACE=(CYL,(20,40))
//SYSOUT
DD SYSOUT=*,HOLD=YES
//DAACT
DD DISP=SHR,DSN=CTDP.V600.ACT.E000
//DAACTI
DD DISP=SHR,DSN=CTDP.V600.ACTI.E000
//SYSIN
DD *
REPNAME=MANAGEMENT REPORTS
USER=MGT
PREFIX=CTDP.E3 BKPMIS=(BKP1,BKP2,BKP3) MIGMIS=MIGDASD
PRTMIS=(PRT1,PRT22,PRT56)
//SYSUDUMP DD SYSOUT=*,HOLD=YES
//

BMC Software, Inc., Confidential and Proprietary Information

5-78

INCONTROL for OS/390 and z/OS Utilities Guide

CTVUNMIG Unmigrate Utility

CTVUNMIG Unmigrate Utility

This utility reads a migrated CDAM file and recreates the original CDAM
file on DASD.
The utility can work in standalone mode. Stand-alone mode is applicable for
disaster recovery (when the IOA version 6.0.00 environment, Log messages
and IOASPRM table content are not available). In standalone mode, all IOA
related files can be omitted from the job if they are not available when the job
is submitted. The utility issues error messages for unavailable load modules,
assumes that the migrated CDAM is a standard sequential file (migrated to
either DISK or CART) and tries to re-create the original report file.

Activating the Utility

Sample JCL for invoking utility CTVUNMIG is contained in member
CTVUNMIG of the CONTROL-D JCL library. CDAM file names are passed
to utility CTVUNMIG using DD statement SYSIN. This sample JCL is
reproduced here:
Figure 5-31

CTVUNMIG Activation

//%JOBNAME%UM JOB %JOBCARD%

%JCL1%
%JCL2%
//*******************************************************************
//*
UNMIGRATE UTILITY JOB
*
//*
---------------------*
//* THIS MEMBER CONTAINS SAMPLE JCL FOR THE UNMIGRATE UTILITY
*
//*
*
//* IN PARM FIELD SPECIFY THE MEDIA NAME AS IT IS WRITTEN
*
//* IN IOASPARM, AND UNIT NAME FOR CDAM FILE ALLOCATION
*
//* IN SYSIN DD SPECIFY THE MIGRATED FILES NAMES.
*
//*******************************************************************
//
JCLLIB ORDER=IOA.V610.PROCLIB
//
INCLUDE MEMBER=IOASET
//UNMIGR
EXEC PGM=CTVUMG,COND=EVEN,REGION=3000K,
//
PARM=CART,DASD
//
INCLUDE MEMBER=&IOAENV
//SYSPRINT DD SYSOUT=*,HOLD=YES
//SYSABEND DD SYSOUT=*,HOLD=YES
//PRTDBG DD SYSOUT=*,HOLD=YES
//SYSIN DD *
OPV.CTDP.E2.N50TRPTI.J15637.D2460924.N000500
OPV.CTDP.E2.N50TRPTI.J15637.D2451624.N000500
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-79

CTVUNMIG Unmigrate Utility

Parameters
Specify the following parameter in the job that invokes utility CTVUNMIG:
PARM = media-name[,unit-name]

where

media-name specifies the media name as specified in member

IOASPARM. Mandatory.

unit-name specifies a device type (such as 3380) or an esoteric name

(such as DASD, SYSDA or SYSALLDA). Optional.

Include the migrated files names in the input stream after the SYSIN DD
statement. Each file name must begin in the first column.

Return Codes
Table 5-41

CTVUNMIG Return Codes

Code

Description

All original CDAMs were recreated successfully.

Error encountered during the process. For details, see specific

error messages on each input file.

16

Error opening file (input or output).

BMC Software, Inc., Confidential and Proprietary Information

5-80

INCONTROL for OS/390 and z/OS Utilities Guide

CTVUPGDB Update Global Index Database

CTVUPGDB Update Global Index Database

The CTVUPGDB utility loads the CONTROL-V index values with
corresponding report keys into the Global Index Database that is
implemented above the IOA Access Method, or unloads them to a flat file
that can be used for loading this information into the Global Index DB2
tables..

Parameters
The CTVUPGDB utility determines which indexes to add to the Global
Index database, based on the following user-specified selection parameters.
The parameters are specified in DD statement SYSIN.
Table 5-42

CTVUPGDB Parameters (Part 1 of 3)

Parameter

Description

LOAD

The function (command) keyword that instructs the utility to

load index values to the Global Index Database. Mandatory.

USER

The name of the recipients or mask patterns for which the

indexes are added. Mandatory.
Up to 15 users or masks can be specified using the format

USER=(USERA,M*,D??45)
JOBNAME

The job name or mask of the reports for which indexes are
added. Optional.

JOBID

The job ID of the report for which indexes are added.

Optional.
The format is Jnnnnn
where nnnnn is the job ID number.

REPNAME

The name of the reports or mask patterns for which the

indexes are added to the Global Index database. Optional.
If the report name contains embedded spaces, place the
report name between apostrophes.

FODATE

The From ODATE of the report. This is the earliest order date
from which indexes are selected. Optional.
The date contains slashes, and is in the format dd/mm/yy,
mm/dd/yy, or yy/mm/dd, depending on the site standard
defined in the IOAPARM member.The parameter can also be
specified in the format -N, where N is number of days (0
-99999) preceding to the current date.

TODATE

The To ODATE of the report. This is the latest order date from
which indexes are selected. Optional.
The date contains slashes and is in the format dd/mm/yy,
mm/dd/yy, or yy/mm/dd, depending on the site standard
defined in the IOAPARM member. The parameter can also be
specified in the format -N, where N is number of days (0
-99999) preceding to the current date.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-81

CTVUPGDB Update Global Index Database

Table 5-42

CTVUPGDB Parameters (Part 2 of 3)

Parameter

Description

FORCE

The action to perform on indexes that have already been

added to the Global Index database. Use this parameter for
utility runs that were abnormally terminated.
Valid values are:
NO Do not add indexes of reports that have already been
added to the Global Index database. Default.
YES Add indexes of reports that have been previously
added to the Global Index database. Only index values that
were not already updated are updated.

TRACE

The action to perform on trace messages. Optional.

Valid values are:
NO Do not issue trace messages. Default.
YES Issue trace messages.
ALL Issue trace messages and list all index values added
to the Global Index database.

MAXINDX

The maximum number of reports to add to the Global Index

database during one run of the utility. Optional. Default: 100.

STORED

The action to perform on reports that are the result of a print

mission with the STORE parameter set to YES. Optional.
Valid values are:
NO Do not add reports that are the result of print mission
with the STORE parameter set to YES.
YES Add only reports that are the result of a print
mission with the STORE parameter set to YES, but do not
add the original report.
ALL Add both stored and not stored reports. Default.

CHKPTID

The name of the member that includes checkpoint

information about the checkpoint dataset. This member is
located in the CONTROL-D PARM library.
The checkpoint dataset, pointed to by DD statement
DACTDPRM, is allocated on the same device as the index
files, according to the definitions in the CTVPARM member of
the IOA.INSTWORK library. It allows the CTVUPGDB utility to
continue processing when a previous run of the utility ends
abnormally, without the need to set the FORCE parameter to
YES. Default: GLOBIDB

MIGRATE

The action to perform on reports from the Migration User file.

For Migrated reports, only resident indexes, which are
indexes that reside on DASD, are processed.
Valid values are:
NO Do not process reports from the Migration User file,
but only from the Active User files. Default.
YES Process reports from the Migration User file, as well
as from the Active User files.
ONLY Process reports only from the Migration User only,
not from the Active User files.

BMC Software, Inc., Confidential and Proprietary Information

5-82

INCONTROL for OS/390 and z/OS Utilities Guide

CTVUPGDB Update Global Index Database

Table 5-42

CTVUPGDB Parameters (Part 3 of 3)

Parameter

Description

LIST

Whether to produce a flat file pointed to by the DACTVLST

DD cart containing the list of the selected report entries, that
is, a list of all paths and all values with their corresponding
Report Keys. This parameter also determines whether the
information is added to the Global Index file that is
implemented above the IOA Access method.
Valid values are:
NO Do not create a list of the selected report entries, but
update the Global Index file. Default.
YES Create a list of the selected report entries and
update the Global Index database.
ONLY Create only a list of the selected report entries. Do
not update the Global Index file.
DB2 Create only a list of the selected report entries. Add
to each entry the Path number from the CTDGIDB2
member. Only paths existing in the CTDGIDB2 member are
added to the list. The created list is then used to load
entries into the Global Index DB2 tables.

PATH

The index path. Optional.

Locations are separated by a slash, using the following
syntax:

main-ixname/sub-index1/sub-index2...
If this parameter is specified, all index paths must be
specified.
If this parameter is not specified, add all index paths for all
levels (that is, with all their sub-indexes). Default.
If the ALT or BASELEN parameter is also specified, the PATH
parameter must be specified before them.
ALT

Whether to create the specified path as an alternate path. An

alternate path is created with no reports. Only the index
portion of the Value records is created. Optional.
Valid values are:
NO Do not create an alternate path. Instead, create a
regular path. Default.
YES Create an alternate path. This parameter can only
be specified if the PATH parameter is specified first.
This parameter is not used for the Global Index if it is
implemented above DB2.

BASELEN

For Short Value paths, determines the length of the base part
of the index value. Optional.
This parameter determines the length of the Global Index
values that the utility creates in the Index portion of the
Global Index Database. The rest of value is kept, along with
the REPORT KEY, in the DATA portion of the Global Index
Database.
Default: Full index value.
This parameter can only be specified if the PATH parameter is
specified first.
This parameter is not used for the Global Index if it is
implemented above DB2.

SORTNBL

The number of blocks for allocating SORTIN and SORTOUT

files. Optional. Default: 100.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-83

CTVUPGDB Update Global Index Database

Activating the Utility

Figure 5-32

CTVUPGDB Activation

// EXEC CTVUPGDB
LOAD USER=username [JOB NAME=jobname] [JOBID=jobid] [REPNAME=repname]
[FODATE=dd/mm/yy] [TODATE=dd/mm/yy] [FORCE=YES|NO]
[TRACE=NO|YES|ALL] [MAXINDX=nnnnn] [STORED=NO|YES|ALL]
[CHKPTID=memname] [STORED=NO|YES|ALL] [MIGRATE=NO|YES|ONLY]
[LIST=NO|YES|ONLY] [PATH=path] [ALT=YES|NO] [BASELEN=nnn] [SORTNBL=3000]

Return Codes
Table 5-43

CTVUPGDB Return Codes

Code

Description

All requested indexes were added to the Global Index

database.

The utility ended with a warning. For further information, see

the specific warning message.

An error was encountered during the process. For details,

see the error messages for each input file.

16

An error was detected in the input parameters.

Figure 5-33

CTVUPGDB Example 1

//S1 EXEC CTVUPGDB

LOAD USER=MKT JOBNAME=N54REP1

A maximum of 100 reports of user MKT that have the job name N54REP1
are processed. All indexes (if any) of the reports are added to the Global
Index database.
Figure 5-34

CTVUPGDB Example 2

//S1 EXEC CTVUPGDB

//SYSIN DD *
LOAD
USER=MKT JOBNAME=N54REP1 REPNAME=ACCOUNT SA*
FODATE=22/07/00 TODATE=22/07/00 PATH=ACCOUNT
PATH=ACCOUNT/SUM

BMC Software, Inc., Confidential and Proprietary Information

5-84

INCONTROL for OS/390 and z/OS Utilities Guide

CTVUPGDB Update Global Index Database

The index path ACCOUNT/SUM is added to the Global Index database for
each report of user MKT that has the job name N54REP1, an ODATE of
22 July 2000, and a report name that begins with ACCOUNT SA.
Figure 5-35

CTVUPGDB Example 3

//STEP01
EXEC CTVUPGDB
//DACTVLST DD DISP=(,PASS),UNIT=SYSDA,DSN=&&DATA,
//
SPACE=(CYL,(100,100),RLSE)
//SYSIN DD *
LOAD
PATH=ACCOUNT/DATE
PATH=ACCOUNT/NAME
LIST=DB2
/*

The list of report entries for the two index paths, ACCOUNT/DATE and
ACCOUNT/NAME, is produced in the temporary flat file. This file can be
used in the next step to load the Global index DB2 table.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-85

MIGRESET Reset the Migration Mission Status

MIGRESET Reset the Migration Mission Status

If a migration mission abends during the analysis step, the status of the
migration mission remains MIGRATION IN PROCESS. If this occurs, reset
the migration mission status to ENDED as follows:
Step 1

Run the MIGRESET job in the CONTROL-D JCL library at least once, until
the following message is displayed:
BKC495E NO PENDING BACKUP/MIGRATE MISSION FOUND...

Step 2

Restart the migration mission.

BMC Software, Inc., Confidential and Proprietary Information

5-86

INCONTROL for OS/390 and z/OS Utilities Guide

RSTRESET Reset the Restore Mission Status

RSTRESET Reset the Restore Mission Status

If a restore mission abends during the analysis step, the status of the restore
mission remains RESTORE IN PROCESS. If this occurs, reset the restore
mission status to ENDED as follows:
Step 1

Run the RSTRESET job in the CONTROL-D JOB library.

Step 2

Perform all the restore requests again, using option R in the History User
Report List of Screen U. The restore mission finishes with the ENDED
NOTOK status.
Note:

Rerun the restore mission from the last step (that is, submit it again
without restarting).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 5 CONTROL-D and CONTROL-V Utilities

5-87

RSTRESET Reset the Restore Mission Status

BMC Software, Inc., Confidential and Proprietary Information

5-88

INCONTROL for OS/390 and z/OS Utilities Guide

24

Chapter 6

CONTROL-O Utilities

This chapter provides a detailed description of the CONTROL-O utilities.

CTOALOCP Backing Up the Automation Log. . . . . . . . . . . . . . . . . . . 6-3
Automation Log Backup Utility Examples. . . . . . . . . . . . . . . . . . . 6-4
CTOCSF Copy the Message Statistics File . . . . . . . . . . . . . . . . . . . . . . 6-6
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
CTOCTA List Programs Running in an Address Space . . . . . . . . . . . . 6-8
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
CTOCTI Generate Input for the SYSIMAGE Facility . . . . . . . . . . . . . 6-10
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
Utility Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
CTORSTM Statistics Report Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
SORT Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Fields of the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
CTOMVDSC Emergency ON MVALERT Disconnect. . . . . . . . . . . . . 6-17
Activating the CTOMVDSC Utility. . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
CTOSMDSC Emergency ON SMS Disconnect . . . . . . . . . . . . . . . . . . 6-18
Activating the CTOSMDSC Utility . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
CTOTEST Simulate Messages and/or Commands . . . . . . . . . . . . . . . . 6-19
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
Format of the Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
CTOUSMDSC Emergency USS Support Disconnect . . . . . . . . . . . . . . 6-23

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-1

Activating the CTOUSMDSC Utility . . . . . . . . . . . . . . . . . . . . . . . . . 6-23

Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23

BMC Software, Inc., Confidential and Proprietary Information

6-2

INCONTROL for OS/390 and z/OS Utilities Guide

CTOALOCP Backing Up the Automation Log

CTOALOCP Backing Up the Automation Log

Utility CTOALOCP copies the contents of one Automation Log file to
another Automation Log file or to a sequential dataset. The utility can be
used to perform any of the following functions, depending on the parameters
specified.

Backing up the Automation Log to another Automation Log. Automation

Log backup files can be displayed, just like the current Automation Log
file, using the Automation Log screen (option OL).

Increasing the size of the current Automation Log file.

Copying the Automation Log to a sequential file. The sequential file can
be processed by a report generator utility or restored and displayed later
as an Automation Log file.

Restoring a sequential backup file to the format of an Automation Log

file.

Changing the dataset organization of an Automation Log.

Parameters are passed to utility CTOALOCP using DD statement

DALCPPRM.
The following parameters can be specified:
Table 6-1

CTOALOCP Parameters (Part 1 of 2)

Parameter

Description

STARTDATE

Earliest date of the log records to be copied. Format:

yymmdd. Default: Date of the earliest record in the log.

STARTTIME

Earliest time of the log records to be copied. Format:

hhmmss. Default: 000000

ENDDATE

Latest date of the log records to be copied. Format: yymmdd.

Default: Date of the latest record in the log.

ENDTIME

Latest time of the log records to be copied. Format: hhmmss.

Default: 240000

FROMDSN

Name of the input dataset for the copy operation. Default:

Name of the operational Automation Log file.

FROMTYPE

Organization of the input dataset.

Valid values are: S and blank.
Type S must be specified if the input dataset is a sequential
file.
For all other input dataset types, the field must be blank.

TODSN

Name of the output dataset for the copy operation.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-3

CTOALOCP Backing Up the Automation Log

Table 6-1

CTOALOCP Parameters (Part 2 of 2)

Parameter

Description

TOTYPE

Organization of the output dataset. Optional.

Valid values are:
V DIV (VSAM Linear) dataset.
D Direct Access (BDAM) dataset.
S Sequential file.
The default is the type of the operational Automation Log
(meaning, the value of parameter AUTOMLOG in member
CTOPARM). For more information about parameter
AUTOMLOG, see the CONTROL-O chapter of the
INCONTROL OS/390 and z/OS Installation Guide.

TOVOLUME

Name (volser) of the volume on that the dataset named in

parameter TODSN resides. This parameter is mandatory for
an output dataset of type V (whether specified explicitly with
parameter TOTYPE or by default).

TOUNIT

Name of the unit to which the output dataset is allocated.

Default: SYSALLDA

TORECNUM

Number of records allocated to the output file. (This value is

used to determine the size of the output dataset.)
Default: number of records in the input file.
Valid values are:
nnnnnnnn Specified number of records.
MINIMAL The number of records copied from the input
dataset, based on date and time specified limits.

Automation Log Backup Utility Examples

Example 1

Copy the entire operational Automation log to another file of the same size:
TODSN
TOVOLUME
TOUNIT

SYS3.MYLOG
WORK02
DISK

Example 2

Copy the entire operational Automation log to a larger file:

TODSN
TOVOLUME
TOUNIT
TORECNUM

SYS3.MYLOG
WORK02
DISK
100000

BMC Software, Inc., Confidential and Proprietary Information

6-4

INCONTROL for OS/390 and z/OS Utilities Guide

CTOALOCP Backing Up the Automation Log

Example 3

Restore a sequential file to the format of a direct access (BDAM) Automation

Log file:
FROMTYPE
TODSN
TOTYPE
TOVOLUME
TOUNIT

S
SYS3.MYLOG.DTYPE
D
WORK02
DISK

Example 4

Back up part of the operational Automation log to a file on the basis of date
or time limits. (The output file contains only the records selected.) With
CONTROL-M, the date or time can be set using the CONTROL-M AutoEdit
facility.
STARTDATE
STARTTIME
ENDDATE
ENDTIME
TODSN
TOVOLUME
TOUNIT
TORECNUM

001027
150000
001027
200000
SYS3.MYLOG.D2710.F15T20
WORK02
DISK
MINIMAL

Example 5

Copy part of the operational Automation log file to a sequential file:

STARTDATE
ENDDATE
TODSN
TOTYPE
TOVOLUME
TOUNIT
TORECNUM

001020
001021
SYS6.MYLOG.F20T21
S
WORK02
DISK
MINIMAL

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-5

CTOCSF Copy the Message Statistics File

CTOCSF Copy the Message Statistics File

Utility CTOCSF copies the Message Statistics file. The utility is generally
used to create a new Message Statistics file whose size is better adapted to
the sites needs.
Before copying the file, the following steps must be followed:
Step 1

If the CONTROL-O monitor is active, stop the CONTROL-O statistics

collection task using the command:
F CONTROLO,STOPSTAT

Message CTO189I indicates that statistics accumulation has stopped.

Step 2

Verify that no users have allocated the Message Statistics file using
CONTROL-O screen OM.

Step 3

Rename the current Message Statistics file (input file for the copy operation),
for example, using ISPF 3.2 or 3.4.

Step 4

Perform the following steps in the INCONTROL Installation and

Customization Engine (ICE):
4.A

Specify CTO as the Product ID.

4.B

Select the CUSTOMIZE activity from the menu.

4.C

Select major step Customize CCONTROL-O Dataset Parameters.

4.D

Select minor step CONTROL-O Dataset Parameters.

4.E

Change parameter STREC# from (for example) 10000 records to

20000 records to change the size of the new Message Statistics file.

4.F

Select minor step Save Parameters Into Product Libraries.

4.G

Select minor step "Allocate and Format CTO Statistics Files.

4.H

Create and format a target statistics file using the CTOFRSTF

program.

4.I
Step 5

Submit the job and create a new Statistics file.

Edit member CTOCSFJ in the CONTROL-O JCL library. Change DD

statement DASTF DSN to match the name specified in Step 3.

BMC Software, Inc., Confidential and Proprietary Information

6-6

INCONTROL for OS/390 and z/OS Utilities Guide

CTOCSF Copy the Message Statistics File

Example
//COPYST JOB
//COPYFILE EXEC CTOCSF
//DASTF DD DISP=SHR,DSN=old-dsname
//

where old-dsname is the name specified in Step 3 above.

After the Message Statistics file has been copied, the statistics collection task
can be restarted using operator command:
F CONTROLO,STARTSTAT

Message CTO184I indicates that statistics accumulation has started.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-7

CTOCTA List Programs Running in an Address Space

CTOCTA List Programs Running in an Address

Space
Utility CTOCTA enables you to determine which programs are running in a
specific address space. This utility is used primarily for gathering information
to be included in the input file of utility CTOCTI below.
Note:

The address space being analyzed must be running when this utility
is run.

Activating the Utility

Use the following JCL to activate the utility (sample job is located in the
CONTROL-O JCL library):
//
//
//
//
//

I600INCT JOB ,IOA600,MSGCLASS=X,CLASS=A

JCLLIB ORDER=IOAP.V600.PROCLIB
INCLUDE MEMBER=IOASET
DISPGMNM EXEC PGM=CTOCTA,PARM=ASNAME

Parameter
The following parameter must be specified in the EXEC statement that
invokes the CTOCTA JCL procedure.
Table 6-2

CTOCTA Parameter

Parameter

Description

PARM

Name of the address space to check. The utility analyzes this

address space and displays the names of the programs it is
running.

Return Codes
Table 6-3

CTOCTA Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

6-8

INCONTROL for OS/390 and z/OS Utilities Guide

CTOCTA List Programs Running in an Address Space

Example
If the utility is run to check address space M70TEST, the following output
messages may be generated:
CTO660I
CTO666I
CTO666I
CTO666I
CTO666I
CTO666I
CTO666I
CTO664I

ADDRESS
PROGRAM
PROGRAM
PROGRAM
PROGRAM
PROGRAM
PROGRAM
ADDRESS

SPACE M70TEST
IEAVAR00 FOUND
IEESB605 FOUND
IEFSD060 FOUND
IEFIIC
FOUND
TESTPGM FOUND
IEAVTSDT FOUND
SPACE M70TEST

WILL BE PROCESSED NOW

IN THE RB CHAIN
IN THE RB CHAIN
IN THE RB CHAIN
IN THE RB CHAIN
IN THE RB CHAIN
IN THE RB CHAIN
ACTIVE

When determining which program name is specified in the input file for
utility CTOCTA, ignore programs IEAVAR00, IEESB605, IEFSD060,
IEFIIC and IEAVTSDT. These are system programs used by all started tasks
and batch programs. In the above example, TESTPGM is the program name
specified in the input file for utility CTOCTI.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-9

CTOCTI Generate Input for the SYSIMAGE Facility

CTOCTI Generate Input for the SYSIMAGE Facility

SYSIMAGE is a facility used by the CONTROL-O Status Monitoring
System (COSMOS) to automatically generate an Object database that reflects
your current environment. Utility CTOCTI is part of the SYSIMAGE facility
to accumulate the information necessary for creation of the Object database.
A sample input file (CTOOBJFL) is supplied with information about the
objects in a typical environment. Edit this file to reflect your environment and
the objects you want COSMOS to manage. The input file is described in
detail below.
For more information about COSMOS, see the CONTROL-O/COSMOS
OS/390 and z/OS User Guide.

Activating the Utility

Use the following JCL to activate the utility (sample job is located in the
CONTROL-O JCL library):
//
//
//
//
//
//

I600INCT JOB ,IOA600,MSGCLASS=X,CLASS=A

JCLLIB ORDER=IOAP.V600.PROCLIB
INCLUDE MEMBER=IOASET
BLDCOSDB EXEC PGM=CTOCTI
OBJFILE
DD DISP=SHR,DSN=&OLPREFO..PARM(CTOOBJFL)

where OLPREFO is the prefix name of the CONTROL-O PARM library and
is usually resolved automatically from IOASET.

BMC Software, Inc., Confidential and Proprietary Information

6-10

INCONTROL for OS/390 and z/OS Utilities Guide

CTOCTI Generate Input for the SYSIMAGE Facility

Input File
Object names and program names used as input for the utility are specified in
sample input file CTOOBJFL located in the CONTROL-O PARM library.

Sample segment of the input file

*OBJECT_DETAIL__OBJECT CLASS____AS_NAME_PGMNAME_X
ELD
ETILOADR
PDS MANAGER
PDSMOPR
TEST PDS MANAGER
PDSMANT PDSMOPR X
BB CSA MONITOR
PMGCSWRN
RESOLVE
ASTXA1MN
ENDEAVOR
LDMMAIN
CONTROL-D
CTDMON
TSO
IKTCAS00
PCAUTH
PCAUTH IEAVXMASX
RASP
RASP
IARDINITX
TRACE
TRACE
IEAVETAIX
XCFAS
XCFAS
IXCINJSTX
GRS
GRS
ISGNASIMX

Format of the Input File

Table 6-4

CTOCTI Formats

Columns

Description

columns 01 16

Object description. The SYSIMAGE facility copies the

description in these columns to the DETAIL column in the
Object database generated from the input file. Mandatory.

columns 17 32

Object class name. You can use this field to create logical
groups of objects. For a description of the CLASS column, see
the component details chapter of the CONTROL-O/COSMOS
OS/390 and z/OS User Guide. Optional.

columns 33 40

Address space name. Optionally, the CTOCTI utility searches

for the specified program name, described in this table, running
in this address space. If no address space name is specified,
CTOCTI matches the entry with the active objects program
name. Optional.

columns 41 48

Program name. This is the primary field used by CTOCTI for

identifying the system object. Mandatory.

column 49

Exclude field. Used to indicate that the object in this row is not
managed by COSMOS. Valid values are:
X The program and/or address space in this row is ignored
by the utility.
blank The object is processed by this utility and is included
in the input for the SYSIMAGE facility.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-11

CTOCTI Generate Input for the SYSIMAGE Facility

Modifying the Input File

Before running utility CTOCTI, it is recommended that you modify the input
file in the following ways:

Exclude system resources from the utility output by placing an X in

column 49 of the rows describing the resource objects.

Add rows for objects (started tasks) not listed in the input file. At least an
object name and program name must be specified for each new row.

Modify object and/or class names to conform to your site standards.

If a started task that is running in the system is not listed in the input file, it is
listed in the output of the utility. Instead of a specific object name and
description, **UNDEF_OBJECT** is returned.
The program name associated with a specific address space can be
determined using utility CTOCTA (described above).

Return Codes
Table 6-5

CTOCTI Return Codes

Code

Description

The utility completed successfully

The utility ended with errors. For details, see messages issued
by the utility.

Utility Output
The output of utility CTOCTI is a series of messages describing objects
(resources) at your site. These messages are used to trigger the SYSIMAGE
facility and generate an Object database to be used by COSMOS.

BMC Software, Inc., Confidential and Proprietary Information

6-12

INCONTROL for OS/390 and z/OS Utilities Guide

CTOCTI Generate Input for the SYSIMAGE Facility

The following is a sample output for this utility:

Figure 6-1

CTOCTI Sample Output

CTO657I OBJECT_NAME/DESC | CLASS_NAME/DESCR | ADDRSPAC | STATUS__ J CTO658I

---------------------|------------------------|----------------------|-----------------CTO659I ELD
N/A
N/A
INACTIVE
CTO659I PDS MANAGER
N/A
PDSMAN
ACTIVE
CTO659I TEST PDS MANAGER
N/A
PDSMANT
INACTIVE
CTO659I BB CSA MONITOR
N/A
N/A
INACTIVE
CTO659I RESOLVE
N/A
RESOLVE
ACTIVE
CTO659I ENDEAVOR
N/A
N/A
INACTIVE
CTO659I CONTROL-D
N/A
GADTROLD
ACTIVE
IOSAS
N/A
IOSAS
EXCLUDED
CATALOG
N/A
CATALOG
EXCLUDED
THIS JOB
N/A
M19XB4CT
ACTIVE
**UNDEF OBJECT**
*UNDEFINEDCLASS*
GRS
ACTIVE

Certain messages return an object name of **UNDEF_OBJECT**. These

messages describe started tasks that were active in the environment, but were
not listed in the input file for the utility. The SYSIMAGE facility creates
objects for undefined address spaces. However, such objects are not assigned
values in the DETAIL and CLASS columns of the Object database.
To ensure that no started tasks are omitted from the Object database created
from the utility output:
Step 1

Run utility CTOCTI (not using the SYSIMAGE facility while the rule
CTO659I of CONTROL-O/COSMOS is not loaded or held).

Step 2

Check the messages generated by the utility for undefined objects.

Step 3

Edit the input file for utility CTOCTI in the following way:

Step 4

3.A

Add rows for the missing started tasks.

3.B

Specify an appropriate object name for each started task.

3.C

Determine the program name for each started task (using utility
CTOCTA) and specify it in the input file.

When all started tasks have been defined in the input file for utility CTOCTI,
rerun this utility using the SYSIMAGE facility.
The SYSIMAGE facility uses the utility output to create an Object database
that includes all started tasks not excluded using the input file to the utility.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-13

CTORSTM Statistics Report Utility

CTORSTM Statistics Report Utility

Utility CTORSTM generates statistical reports based on information
provided by the Message Statistics facility. CTORSTM output can be used to
analyze site automation requirements and the progress of the automation
process. CTORSTM output can also be used as input for report generator
utilities (such as SAS, SP/SS, or EASYTRIEVE).
A sample JCL that invokes procedure CTORSTM can be found in member
CTORSTMJ in the CONTROL-O JCL library. The output report is written to
SYSPRINT. Report parameters are passed to utility CTORSTM using DD
statement DAREPIN.

SORT Parameter
The following parameter can be specified to sort the report data.
Table 6-6

CTORSTM SORT Parameter

Parameter

Description

SORTBY

Sort report by message ID or by message count with

the most frequent messages appearing first. Valid
values are:
COUNT Sort by message count. Default.
MSGID Sort by message ID

INCLUDE / EXCLUDE Statements

The scope of the copy can be limited by one or more INCLUDE /
EXCLUDE statements. Each INCLUDE / EXCLUDE statement contains
parameters that limit the messages for that statistics are collected.

Parameters in INCLUDE / EXCLUDE Statements

The parameters that can be specified in INCLUDE / EXCLUDE statements:

Table 6-7

CTORSTM INCLUDE / EXCLUDE Parameter

Parameter

Description

msg

Message ID (for example, DFH1799) or mask (for example,

DFH*). Defaults:
INCLUDE * Include all messages.
EXCLUDE blank Do not exclude any messages.

BMC Software, Inc., Confidential and Proprietary Information

6-14

INCONTROL for OS/390 and z/OS Utilities Guide

CTORSTM Statistics Report Utility

Example
Figure 6-2

CTORSTM Example

//REPORT EXEC CTORSTM

//DAREPIN DD *
INCLUDE DFH*
INCLUDE $HASP*
EXCLUDE $HASP100
SORTBY MSGID
/*

The following is a sample output for this utility:

Figure 6-3

CTORSTM Sample Output

1---------------------------------- ---------------------------------------------------CONTROL-O STATISTIC REPORT- INVOCATION PARAMETERS

- LAST RESET ON 00/07/12 13:57:41
1
PRODUCED BY CONTROL-O VERSION 6.0.00
- REPORT TIME - 00/08/10 11:50:31
OS35
---------------------------------- ---------------------------------------------------INCLUDE $DFH*
00130000
INCLUDE $HASP*
00130000
EXCLUDE $HASP100
00130000
SORTBY COUNT
00140000
--------------------------------- -----------------------------------------------------CONTROL-O STATISTIC REPORT- SORTED BY COUNT
- LAST RESET ON 00/07/12 13:57:41
PRODUCED BY CONTROL-O VERSION 6.0.00
- REPORT TIME - 00/08/10 11:50:31
--------------------------------- -----------------------------------------------------MESSAGE ID
T COUNT
HANDLED
SUPRESSED MESSAGE EXT
------------ - ---------- ---------- ---------- -------- ------------------------------$HASP373
M
45289
45289
0 $HASP373 M54T
STARTED - INIT 2
- CLASS A - SYS OS35
$HASP395
M
44650
44650
0 $HASP395 M26A
ENDED
$HASP250
M
40644
40644
0 $HASP250 M04TTXLM PURGED -- (JOB KEY WAS B402CAE1)
$HASP309
M
17522
17522
0 $HASP309 INIT 2
INACTIVE ******** C=A
$HASP890
M
9734
9734
0 $HASP890 JOB(M04TTXLM)
$HASP686
M
9181
9181
0 $HASP686 OUTPUT(N61SRULE) OUTGRP=1.1.1 CANCELLED
$HASP375
M
7990
7990
0 $HASP375 N16PRPS ESTIMATED LINES EXCEEDED
$HASP006
M
3758
3758
0 $HASP006 $CJ2201,P
TRANSLATED BY EXIT HASX05C TO $CJ(2201),P
$HASP125
M
2698
2698
0 $HASP125 INTRDR
SKIPPING FOR JOB CARD FROM TSU15147 K06
$HASP301
M
633
633
0 $HASP301 N16PRPS - DUPLICATE JOB NAME - JOB DELAYED
$HASP880
M
475
475
0 $HASP880 LINE1
UNIT=SNA,STATUS=ACTIVE/NODE6,DISCON=NO
$HASP003
M
471
471
0 $HASP003 RC=(52),
$HASP263
M
455
455
0 $HASP263 WAITING FOR ACCESS TO JES2 CHECKPOINT VOLUME NDS8H2
$HASP679
M
441
441
0 $HASP679 $SN,A=JES06
REJECTED - ALREADY IN SESSION WITH JES06
$HASP881
M
235
235
0 $HASP881 LOGON1
APPLID=JES07,STATUS=ACTIVE

PAGE
SYSTEM ID

PAGE
SYSTEM ID

2
OS35

, RC=08

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-15

CTORSTM Statistics Report Utility

Fields of the Report

Report information is displayed according to the following fields:
Table 6-8

CTORSTM Fields

Field

Description

MESSAGE ID

For messages, the message code. For commands, the

command text (for example, S for S OPER1).
Note: Message or command IDs may have been redefined
using a DO SET %%$STATID statement in the rule definition.

Indicates whether the current line describes a message or a

command. Valid values are:
M Message
C Command

COUNT

Number of times the message or command has been

intercepted by CONTROL-O (from the start of accumulation).

HANDLED

Number of message or command occurrences for which at

least one rule has been triggered by CONTROL-O.

SUPPRESSED

Number of message or command occurrences that have

been suppressed by CONTROL-O.

MESSAGE TEXT

Text of the first occurrence of the message or command after

creation of the Statistics file.
When text length exceeds the text field length, the RIGHT
command (PF11 or PF23) can be used to shift more text into
view, or the WRAP command can be used to continue the
text display in the following lines.
For messages or commands that have been locally reset, the
REDATE command can be used to alternate between display
of the message text and display of the reset date and time.

HANDLED

Total number of messages or commands handled by

CONTROL-O.

SUPPRESSED

Total number of messages or commands suppressed by

CONTROL-O.

BMC Software, Inc., Confidential and Proprietary Information

6-16

INCONTROL for OS/390 and z/OS Utilities Guide

CTOMVDSC Emergency ON MVALERT Disconnect

CTOMVDSC Emergency ON MVALERT Disconnect

The CTOMVDSC utility forces a disconnect of ON MVALERT support in
emergency situations. It functions in much the same way as the following
command:
F CONTROLO,STOPMVI,FORCE
Warning!

Use this utility only in appropriate emergencies. Do not use

unless specifically advised by BMC Software Customer Support.

The utility can be activated using job CTOMVDSC located in the

IOAprefix.INSTWORK library. The utility procedure, CTOMVDSC, is
located in the IOAprefix.PROCLIB library.

Activating the CTOMVDSC Utility

You can activate the CTOMVDSC utility

as a JCL job statement, for example:

//DISCONCT EXEC CTOMVDSC

as an emergency MVS started task command, entered from the console,

for example:
S CTOMVDSC

Return Codes
Table 6-9

CTOMVDSC Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-17

CTOSMDSC Emergency ON SMS Disconnect

CTOSMDSC Emergency ON SMS Disconnect

The CTOSMDSC utility forces a disconnect of ON SMS support in
emergency situations. It functions in much the same way as the following
command:
F CONTROLO,STOPSMS,FORCE
Warning!

Use this utility only in appropriate emergencies. Do not use

unless specifically advised by BMC Software Customer Support.

The utility can be activated using job CTOSMDSC located in the

IOAprefix.INSTWORK library. The utility procedure, CTOSMDSC, is
located in the IOAprefix.PROCLIB library.

Activating the CTOSMDSC Utility

You can activate the CTOSMDSC utility

as a JCL job statement, for example:

//DISCONCT EXEC CTOSMDSC

as an emergency MVS started task command, entered from the console,

for example:
S CTOSMDSC

Return Codes
Table 6-10

CTOSMDSC Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

6-18

INCONTROL for OS/390 and z/OS Utilities Guide

CTOTEST Simulate Messages and/or Commands

CTOTEST Simulate Messages and/or Commands

Utility CTOTEST simulates messages and commands used to trigger
CONTROL-O rules. The messages or commands are specified in a dataset
used as input for the utility. When the utility is run, CONTROL-O responds
to the specified messages as if they had been issued in the usual manner.
This utility can be used to:

Check the performance of a rule or group of rules.

Check if an existing rule handles a specific message or command.
Check CONTROL-O response to a series of commands and/or messages.

Utility CTOTEST is run on each record in the input file. A pair of messages
is generated for each run of the utility. The first message describes the record
being processed. The second message describes the CONTROL-O response
to the input record. A return code (described below) is supplied as part of the
second message.

Activating the Utility

// CTOSIM EXEC PGM=CTOTEST,PARM=N500
// INCLUDE MEMBER=ioaenv
// CMDMSGFL DD DSN=dsname,DISP=SHR

Parameters
The following parameter must be specified in the EXEC statement that
invokes the CTOTEST procedure.
Table 6-11

CTOTEST EXEC Parameters

Parameter

Description

PARM

CONTROL-O subsystem name specified in parameter SSNAME

in member IOAPARM.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-19

CTOTEST Simulate Messages and/or Commands

The following parameter must be specified in DD statement CMDMSGFL:

Table 6-12

CTOTEST CMDMSGFL Parameter

Parameter

Description

DSN

Name of the dataset containing the messages and/or commands

to be processed by the simulated CONTROL-O environment.
The format of the input dataset is described below.

Format of the Input File

The input file for utility CTOTEST has the following characteristics:

Physical sequential
Record length: 127
Record format: Fixed or Fixed block

Records in the input file have the following format:

nyyyyyyyyyyyy

where

n Single digit indicating the type of message or command to be

simulated. Valid values are

1 MVS operator command

2 MVS or JES2 message
3 JES3 command
4 JES3 message
5 JES2 command

yyyyyyyyyyy Text of the message or command to be simulated.

Maximum length: 126 characters. Comment lines (indicated by an
asterisk in column one) can also be included in the input dataset.

BMC Software, Inc., Confidential and Proprietary Information

6-20

INCONTROL for OS/390 and z/OS Utilities Guide

CTOTEST Simulate Messages and/or Commands

Return Codes
The following return codes may be returned by each run of utility CTOTEST.
If an internal error is detected while processing an input record, that record is
ignored and processing continues with the next record of the input dataset.
Table 6-13

CTOTEST Return Codes

Code

Description

Input record was processed successfully or no CONTROL-O rule

has been defined for the specified message or command.

Message was suppressed.

Message was changed, or a JES2 command or message rule

was processed.

12

Specified CONTROL-O subsystem is inactive.

Other

Internal error.

Example
Below is a sample JCL and input for utility CTOTEST followed by the
messages returned as output.

JCL
// CTOSIM
EXEC PGM=CTOTEST,PARM=N500
// CMDMSGFL DD *

Input File
5$D MODULE(HASPCOMM)
1IEC301A S JOB T56E DSNAME
1IEF403I M70TT123 STARTED

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-21

CTOTEST Simulate Messages and/or Commands

Output Messages

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
CTO500I INPUT LEN=019 REC=$D MODULE(HASPCOMM)
CTO503I RC000 LEN=000 REC=
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
CTO500I INPUT LEN=025 REC=IEC301A S JOB T56E DSNAME
CTO503I RC000 LEN=000 REC=
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
CTO500I INPUT LEN=024 REC=IEF403I M70TT123 STARTED
CTO503I RC000 LEN=000 REC=
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

BMC Software, Inc., Confidential and Proprietary Information

6-22

INCONTROL for OS/390 and z/OS Utilities Guide

CTOUSMDSC Emergency USS Support Disconnect

CTOUSMDSC Emergency USS Support

Disconnect
The CTOUSDSC utility forces a disconnect of USS support in emergency
situations. It functions in much the same way as the following command:
F CONTROLO,STOPUSS,FORCE
Warning!

Use this utility only in appropriate emergencies. Do not use

unless specifically advised by BMC Software Customer Support.

The utility can be activated using job CTOUSDSC located in the

IOAprefix.INSTWORK library. The utility procedure, CTOUSDSC, is
located in the IOAprefix.PROCLIB library.

Activating the CTOUSMDSC Utility

You can activate the CTOUSDSC utility

as a JCL job statement, for example:

//DISCONCT EXEC CTOUSDSC

as an emergency MVS started task command, entered from the console,

for example:
S CTOUSDSC

Return Codes
Table 6-14

CTOUSDSC Return Codes

Code

Description

Operation performed successfully

other

Operation failed

BMC Software, Inc., Confidential and Proprietary Information

Chapter 6 CONTROL-O Utilities

6-23

CTOUSMDSC Emergency USS Support Disconnect

BMC Software, Inc., Confidential and Proprietary Information

6-24

INCONTROL for OS/390 and z/OS Utilities Guide

180

Chapter 7

CONTROL-M/Tape Utilities

This chapter includes the following topics:

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Control Statement Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Record Selection Logic (INCLUDE / EXCLUDE Statements). . . . . 7-6
Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
CTTACP Copy Trace File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
CTTAFR Format and Initialize Trace File. . . . . . . . . . . . . . . . . . . . . . . 7-17
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
CTTBIX Rebuild Media Database Index . . . . . . . . . . . . . . . . . . . . . . . 7-18
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
CTTCTRC Allocate and Format Trace File . . . . . . . . . . . . . . . . . . . . . 7-21
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
CTTDBIB Rebuild Indexes of Stacking Database . . . . . . . . . . . . . . . . 7-23
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
CTTDLD Add, Delete, or Convert Volumes . . . . . . . . . . . . . . . . . . . . . 7-25
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-1

Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27

Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
CTTGVL User Interface to Stacking Facility . . . . . . . . . . . . . . . . . . . . 7-30
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-30
Using a Call Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Using a Link command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Output Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-32
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-32
CTTIDB Check Integrity of the Media Database . . . . . . . . . . . . . . . . . 7-33
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-35
CTTMER Merge Records Into the Media Database . . . . . . . . . . . . . . . 7-36
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-36
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-37
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38
CTTMUP Manually Update the CONTROL-M/Tape Repository . . . . . 7-39
Updating the Media Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-39
Updating the Stacking Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-41
Media Database Update Control Statements . . . . . . . . . . . . . . . . . . . 7-42
Stacking Database Update Control Statements . . . . . . . . . . . . . . . . . 7-45
Trace Update Control Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-46
Special Notes Regarding Media Database Control Statements . . . . . 7-46
Specifying Fields and Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
CTTRCV Recover the Media Database Using Trace File . . . . . . . . . . . 7-52
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-56
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-56
CTTRPT Database Extraction and Report Utility . . . . . . . . . . . . . . . . . 7-58
Primary Key, Primary Fields and Primary Lines in Report
Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-58
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-59
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-59
Extract Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60

BMC Software, Inc., Confidential and Proprietary Information

7-2

INCONTROL for OS/390 and z/OS Utilities Guide

INCLUDE / EXCLUDE Statements . . . . . . . . . . . . . . . . . . . . . . . . . 7-60

Report Formatting Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-61
Special Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-68
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-69
Sample Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-70
CTTRSM Recover Tape Activity From SMF Records . . . . . . . . . . . . . 7-79
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-79
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-83
CTTRTM Perform Retention Management. . . . . . . . . . . . . . . . . . . . . . 7-84
Scratch Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
RECALC Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
Exits Used by Utility CTTRTM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
Relevant Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-90
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97
CTTSBD Perform Dataset Stacking in Batch Mode . . . . . . . . . . . . . . . 7-100
Utility Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-101
Execution Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
Resource Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
Exit CTTX011 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Retention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Batch Stacking and Vault Management . . . . . . . . . . . . . . . . . . . . . . . 7-104
Volume and Dataset Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-104
Dataset Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Volume Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Stacking Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Batch Stacking and Dynamic Dataset Stacking . . . . . . . . . . . . . . . . . 7-106
Dataset Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-106
Determination of Output Dataset Location . . . . . . . . . . . . . . . . . . . . 7-107
Masking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
Stopping Utility CTTSBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-110
Simulation Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-111
Unstacking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-111
Recovery From Abends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-112
Relevant Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-113
Preparation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-114
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-115
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-115
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-127
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-127
CTTSCA Dataset Contention Detection . . . . . . . . . . . . . . . . . . . . . . . . 7-131
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-3

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136
CTTSPL Copies or Moves Media Database Records . . . . . . . . . . . . . . 7-138
Split and Merge Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-138
Data Integrity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-139
Simulation Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-139
Volume Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Recovery from Abends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Undoing Splits and Merges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Activating the CTTSPL Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-141
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-142
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
CTTSTK Build and Update Stacking Database . . . . . . . . . . . . . . . . . . . 7-145
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
INCLUDE / EXCLUDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
Gathering Statistics for Datasets with Non-specific Retention. . . . . . 7-147
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-147
CTTSTKR Stacking Statistics Report Utility . . . . . . . . . . . . . . . . . . . . 7-148
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-150
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-150
CTTSYNC Synchronize Automated Tape Libraries with the Media
Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-152
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-153
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-153
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
CTTTPI Tape Initialization, Information Mapping, and Tape Erasure . 7-156
Safe Tape Initialization Function INITT . . . . . . . . . . . . . . . . . . . . . 7-156
Media Information Mapping Function TAPEMAP . . . . . . . . . . . . . 7-157
Safe Tape Erasure Function TAPERAS. . . . . . . . . . . . . . . . . . . . . . 7-159
CTTTPI and I/O Error Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-160
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-161
Passing Parameters using the EXEC Statement . . . . . . . . . . . . . . . . . 7-161
Passing Parameters using DD Statement SYSIN . . . . . . . . . . . . . . . . 7-162
Input Parameters SYSIN DD File . . . . . . . . . . . . . . . . . . . . . . . . . . 7-162
Invoking CTTTPI From Another Program . . . . . . . . . . . . . . . . . . . . . 7-167
Activating Utility CTTTPI From the StorageTek Host Software
Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-168
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-169
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-170
CTTTRB Synchronize Trace File and Media Database Backup . . . . . . 7-171
Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-171
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-171
Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-172
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-172

BMC Software, Inc., Confidential and Proprietary Information

7-4

INCONTROL for OS/390 and z/OS Utilities Guide

CTTVTM Perform Vault Management . . . . . . . . . . . . . . . . . . . . . . . . . 7-173

Activating the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-175
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-176
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-179
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-180

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-5

Overview

Overview
This chapter provides a detailed description of the CONTROL-M/Tape
utilities.

Control Statement Syntax

The following rules apply to the syntax for control statements specified for
CONTROL-M/Tape utilities:

Multiple INCLUDE / EXCLUDE statements can be specified for each

run of a utility.

Each control statement (meaning, an INCLUDE / EXCLUDE statement

or a CONTROL-M/Tape TYPERUN statement) can span multiple lines.

Specification for each parameter in a control statement must be contained

in a single line.

To specify a value that includes blank spaces, the value must be enclosed
in single quotes (for example, This is a value with spaces).

All control statements must be specified in columns 1 through 71.

(Comments can be specified in any column.)

If not all parameters of a statement fit on a line, place a comma

immediately after the last parameter that fits on the line and continue
specifying subsequent parameters on the next line.

To add a comment to a line, separate it from the code on the line by one
or more blank spaces. For example:

INCLUDE DSNAME=DB2*

Select all DB2 datasets for processing

Record Selection Logic (INCLUDE / EXCLUDE Statements)

General

Certain utilities accept selection criteria that determine which records are
processed when the utility runs. These selection criteria are specified as
expressions in INCLUDE / EXCLUDE statements that are supplied as
parameters to the utility.

BMC Software, Inc., Confidential and Proprietary Information

7-6

INCONTROL for OS/390 and z/OS Utilities Guide

Overview

INCLUDE / EXCLUDE statements are grouped into blocks. An INCLUDE /

EXCLUDE block consists of INCLUDE statements followed by
corresponding EXCLUDE statements.
A combined maximum of 1000 INCLUDE / EXCLUDE statements can be
specified.
INCLUDE / EXCLUDE expressions, statements and blocks are described on
the following pages.

Expressions

Expressions are used to specify selection criteria. The format of an

expression:
key operator value

where

key is a parameter (field) in the record. Each key listed in each

INCLUDE / EXCLUDE statement must be unique.

operator is a relational symbol used to compare the key to the value.

Supported symbols include:
= equal
or ! not equal
< less than
> greater than

value Number or character string (that can include mask characters)

against which to compare the key.

Note:

When specifying Hexadecimal numbers, these values must be

prefixed with an X (for example, DVLRBA=X01234567 instead of
DVLRBA=01234567), except in relation to VER and REP fields. For
valid values that can be specified in INCLUDE / EXCLUDE
statements in CONTROL-M/Tape, see the discussion about logical
field names for the CONTROL-M/Tape in Appendix D of the
INCONTROL for OS/390 and z/OS Administrator Guide.

Only the =, and ! operators can be specified when the key and value are of
type character (meaning, non-numeric).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-7

Overview

Mask characters can be specified:

for expressions whose operator is either =, or !

-and-

as part of a character string.

For additional information about masking, see the online facilities chapter in
the appropriate user guide.

INCLUDE Statements

INCLUDE statements determine which records are processed by the utility

according to selection criteria.
INCLUDE statements are composed of expressions (at least one) separated
by commas.
The format of an INCLUDE statement:
INCLUDE Expression1, Expression2, ... , ExpressionN

All the expressions in an INCLUDE statement must be true for the statement
to be true (meaning, the relationship between the expressions within one
INCLUDE statement is AND).

EXCLUDE Statements

EXCLUDE statements determine which records are not processed by the

utility according to selection criteria.
EXCLUDE statements are composed of expressions (at least one) separated
by commas.
The format of an EXCLUDE statement:
EXCLUDE Expression1, Expression2, ... , ExpressionN

All the expressions in an EXCLUDE statement must be true for the

EXCLUDE statement to be true (meaning, the relationship between the
expressions within one EXCLUDE statement is AND).

BMC Software, Inc., Confidential and Proprietary Information

7-8

INCONTROL for OS/390 and z/OS Utilities Guide

Overview

INCLUDE / EXCLUDE Block

An INCLUDE / EXCLUDE block is composed of any number of INCLUDE

statements followed by any number of its corresponding EXCLUDE
statements.
The format of an INCLUDE / EXCLUDE block:
Figure 7-1

INCLUDE / EXCLUDE Statements

The relationship between multiple INCLUDE statements in a block is OR.

The relationship between multiple EXCLUDE statements in a block is OR.
The relationship between an INCLUDE statements and the following
EXCLUDE statements in a block is AND.

Single INCLUDE / EXCLUDE Block Processing

If even one EXCLUDE statement of a block is true (meaning, a record

satisfies the EXCLUDE statement), the record is not selected and the next
record is examined.
If all EXCLUDE statements in the block are false, the INCLUDE statement
is evaluated against the record

if the INCLUDE statement is true, the record is selected.

if the INCLUDE statement is false, the record is not selected and the next
record is examined.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-9

Overview

Multiple INCLUDE / EXCLUDE Blocks

Multiple INCLUDE / EXCLUDE blocks can be specified.

If multiple INCLUDE / EXCLUDE blocks are specified, the relationship

between the blocks is OR and the blocks are checked sequentially.

If a record is not selected after being checked against an INCLUDE /

EXCLUDE block, it is checked against the next INCLUDE / EXCLUDE
block. Once a record is selected based on an INCLUDE / EXCLUDE
block, the record is included and not checked against other blocks.

If only EXCLUDE statements are specified in the first block (meaning,

no INCLUDE statements are specified), only records not excluded by the
first block are considered for selection by subsequent INCLUDE /
EXCLUDE blocks.

Figure 7-2

INCLUDE / EXCLUDE Blocks

BMC Software, Inc., Confidential and Proprietary Information

7-10

INCONTROL for OS/390 and z/OS Utilities Guide

Overview

INCLUDE / EXCLUDE Examples

The following examples illustrate INCLUDE / EXCLUDE logic. For all but
the last example, assume the following expressions, all of which evaluate to
True.
Table 7-1

Expressions for INCLUDE / EXCLUDE Examples

Expression

Evaluates To:

Key1=Value1

True

Key2=Value2

True

Key3=Value3

True

Example 1

Select all records that match these expressions:

INCLUDE Key1=Value1,Key2=Value2,Key3=Value3

Example 2

Select all records that match these expressions, using another method:
INCLUDE Key1=Value1
EXCLUDE Key2Value2
EXCLUDE Key3Value3

Example 3

Select all records that match the first expression and either the second or third
expressions:
INCLUDE Key1=Value1
EXCLUDE Key2Value2,Key3Value3

Example 4

Select all records that do not match these expressions:

INCLUDE Key1Value1
INCLUDE Key2Value2
INCLUDE Key3Value3

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-11

Overview

Example 5

Select all records that match either the second or third expression, but do not
match the first expression:
INCLUDE
EXCLUDE
INCLUDE
EXCLUDE

Key2=Value2
Key1=Value1
Key3=Value3
Key1=Value1

Example 6

The following example utilizes actual values (instead of the terms KeyN and
ValueN).
Select the records of all volumes starting with FD whose dataset name starts
with BACKUP, except for those volumes starting with FD but ending with
102. Furthermore, independent of the preceding selection criteria, select
records created by jobs whose job names start with CTT.
INCLUDE VOLSER=FD*,DSNAME=BACKUP*
EXCLUDE VOLSER=FD?102
INCLUDE CREJBN=CTT*

Utilities
As of version 6.1.00, all CONTROL-M/Tape databases (that is, the Media
and Stacking databases) are managed as IOA Access Method databases.
Therefore, several new IOA Access Method database utilities have replaced
the corresponding previous utilities. Table 7-2 lists the new utilities and the
old utilities which they replace.
Note:

The CONTROL-M/Tape trace file is not a database, and is therefore

managed as it was in previous versions.

Table 7-2

New CONTROL-M/Tape Database Utilities

New Utilities

Old Utilities

Description

IOADBF

CTTDBF and
CTTCRDF

Allocates and formats an IOA Access

Method file.

IOADIG

CTTDBID

Verifies the integrity of an IOA Access

Method file data component.

IOADII

CTTDBII

Verifies the integrity of an IOA Access

Method file index component.

IOADLD

CTTDBDLD

Loads IOA Access Data components from

a sequential dataset.

BMC Software, Inc., Confidential and Proprietary Information

7-12

INCONTROL for OS/390 and z/OS Utilities Guide

Overview

Table 7-2

New CONTROL-M/Tape Database Utilities

New Utilities

Old Utilities

Description

IOADPT

CTTDBPRT

Prints records, in dump format, from an IOA

Access Method database to a sysout.

IOADUL

CTTDBDUL

Unloads IOA Access Data components to a

sequential dataset.

For more information on these IOA Access Method database utilities, see
Chapter 2, IOA Utilities.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-13

CTTACP Copy Trace File

CTTACP Copy Trace File

This utility can be used to:

Copy a Trace file to another preformatted Trace file.

Copy a Trace file to a sequential variable-blocked file, enabling the

output to be formatted to a Hexadecimal or Dump display format.

Note:

If the Trace file is 100% full, no tape activity can be recorded in it. In
this case, use JCL parameter EXPDT=00000 when the Trace file is
copied to tape.

Copy a sequential, variable-blocked file containing Trace data back to a

formatted Trace dataset. If this Trace dataset contains data, the contents
of the sequential file are appended to it.

Note:

The Trace file that is to be created must be formatted prior to

activating the utility.

Activating the Utility

Figure 7-3

CTTACP Activation

//EXEC
CTTACP
//SYSIN
DD
*
COPY
FROM=TRACE|SEQ,TO=TRACE|SEQ
<INCLUDE/EXCLUDE STATEMENTS>
OUTPUT
TYPE=T|C|X|D|F,LINESIZE=size
//

BMC Software, Inc., Confidential and Proprietary Information

7-14

INCONTROL for OS/390 and z/OS Utilities Guide

CTTACP Copy Trace File

Parameters
The following parameters can be specified to the utility in the EXEC
statement that invokes the CTTACP JCL procedure:
Table 7-3

CTTACP EXEC Parameters

Parameter

Description

TRCIN

Name of source file.

TRCOUT

Name of target file.

Parameters can also be supplied using DD statement SYSIN:

Table 7-4

CTTACP SYSIN Parameters

Parameter

Description

COPY

Copy statement type. Mandatory.

FROM Source dataset type. Valid values are:
TRACE Source is a CONTROL-M/Tape Trace file.
SEQ Source is a sequential, variable-blocked file.
TO Target dataset type. Valid values:
TRACE Target is a CONTROL-M/Tape Trace file.
SEQ Target is a sequential, variable-blocked file.

INCLUDE /
EXCLUDE

The records written to the output dataset can be filtered by one

or more INCLUDE / EXCLUDE statements. INCLUDE /
EXCLUDE statements for this utility can filter records according
to any of the keywords used with trace type records, listed in the
appendix that discusses logical field names for the
CONTROL-M/Tape Repository in the INCONTROL for OS/390
and z/OS Administrator Guide. For more information, see
Record Selection Logic (INCLUDE / EXCLUDE Statements) on
page 7-6 in this guide.

OUTPUT

Output formatting. Valid values are:

TYPE Output format type. Valid Values are:
T Trace file records are unchanged. Default.
C Output contains only printable characters.
X Output is written in Hexadecimal format.
D Output is written in dump format (a combination of C and
X types).
F Output is formatted. A comprehensive list of Logical Field
Names and relevant values is written for each volume or
dataset record.
LINESIZE Output record size. Valid values: 70 to 132
characters; Default: 80.

Note:

The LINESIZE parameter and C, X, D and E values for the TYPE

parameter are only valid when the output is a sequential dataset.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-15

CTTACP Copy Trace File

Return Codes
Table 7-5

CTTACP Return Codes

Code

Description

Operation ended successfully

Missing DD statements or open failed

12

Control card error

16

Loading CONTROL-M/Tape environments failed

20

I/O error on input or output files

Examples
Copy a Trace file to a second preformatted Trace file:
Figure 7-4

//EXEC
//SYSIN
COPY
//

CTTACP Example 1

CTTACP,TRCOUT= CTT.BACKUP.TRC
DD
*
FROM=TRACE,TO=TRACE

Copy the Trace file to a sequential variable-blocked file. Only records from
job TAPEJOB are included. The output is in dump format. The line size is
132 bytes.
Figure 7-5

//EXEC
//SYSIN
COPY
INCLUDE
OUTPUT
//

CTTACP Example 2

CTTACP,TRCOUT=CTT.JOB.ACTIVITY
DD
*
FROM=TRACE,TO=SEQ
JOBNAME=TAPEJOB
TYPE=D,LINESIZE=132

BMC Software, Inc., Confidential and Proprietary Information

7-16

INCONTROL for OS/390 and z/OS Utilities Guide

CTTAFR Format and Initialize Trace File

CTTAFR Format and Initialize Trace File

The CTTAFR utility formats and initializes the Trace file. The physical block
number of the Trace file is automatically specified in the PARM parameter of
the JCL EXEC statement. This value is the same as the IOA variable
TRCBLKS, which was set in the ICE environment.
Note:

For more information about calculating the trace file size, see the
CONTROL-M/Tape installation chapter of the INCONTROL for
OS/390 and z/OS Installation Guide.

Activating the Utility

//EXEC
//

CTTAFR

Parameters
No parameters are specified for this utility.

Return Codes
Table 7-6

CTTAFR Return Codes

Code

Description

Operation performed successfully.

DCB open error.

12

The utility cannot run because CONTROL-M/Tape is active.

16

Loading CONTROL-M/Tape environment failed.

Example
Format the Trace file.
//EXEC
//

CTTAFR

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-17

CTTBIX Rebuild Media Database Index

CTTBIX Rebuild Media Database Index

This utility rebuilds the index file for the Media Database. The new index file
corresponds to information currently contained in the Media Database data
file.
Note:

The index file to be rebuilt must be allocated and formatted prior to

activating the utility.
Run the CTTBIX utility only if CONTROL-M/Tape is down or
suspended. For further information, see CTTBIX EXEC
Parameters on page 7-19.

Use this utility:

When the amount of space remaining for the existing index file is
insufficient. In this case:
Delete the index file.
Redefine and format the index file with the required amount of space,
using the IOADBF utility.
Rebuild the index file.

For performance improvement

After recovery

After converting volumes from other tape management systems (for

example, CA-1, CA-TLMS) to CONTROL-M/Tape

Activating the Utility

//EXEC CTTBIX,TYPERUN={B|C|F|N}
//

BMC Software, Inc., Confidential and Proprietary Information

7-18

INCONTROL for OS/390 and z/OS Utilities Guide

CTTBIX Rebuild Media Database Index

Parameters
The TYPERUN parameter is contained in the EXEC statement.
Table 7-7

CTTBIX EXEC Parameters

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
B The utility is run in BUILD mode; the index file is
rebuilt. If CONTROL-M/Tape is active, utility CTTBIX must
not run.
C The utility is run in CONVERT mode. This mode is
specified when converting the database from another tape
management system to CONTROL-M/Tape. If
CONTROL-M/Tape is active, utility CTTBIX must not run.
F The utility is run in FORCED BUILD mode; the index
file is rebuilt. No checking is performed for
CONTROL-M/Tape status. This mode forces building of the
index file.
N The utility is run in FORCED CONVERT mode. No
checking is performed for CONTROL-M/Tape status. This
mode forces the building of the Index file.
Specify this mode when converting the database from
another tape management system to CONTROL-M/Tape.
This index file can be built and checked in a test
environment while the production environment is still active.

Note:

Do not set parameter TYPERUN to F if the CTTBIX utility is

running on the production Media Database (that is,
CONTROL-M/Tape is active). Running this utility on the production
Media Database can cause unpredictable results.

Return Codes
Table 7-8

CTTBIX Return Codes (Part 1 of 2)

Code

Description

Operation performed successfully.

Inconsistency error detected execution continues index

file built successfully (manually correct logical errors in the
data).

12

Error in parameters Execution terminates.

16

Error opening DCB Execution terminates.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-19

CTTBIX Rebuild Media Database Index

Table 7-8

CTTBIX Return Codes (Part 2 of 2)

Code

Description

24

Unsuccessful sort.

28

Media Database access error.

32

Loading CONTROL-M/Tape environment failed.

40

Index is not empty. Before running the utility, format the index
using the IOADBF utility.

44

CONTROL-M/Tape is active Utility CTTBIX cannot run in

the specified mode while CONTROL-M/Tape is active.

Example
//EXEC
//

CTTBIX,TYPERUN=B

BMC Software, Inc., Confidential and Proprietary Information

7-20

INCONTROL for OS/390 and z/OS Utilities Guide

CTTCTRC Allocate and Format Trace File

CTTCTRC Allocate and Format Trace File

The CTTCTRC utility creates and formats CONTROL-M/Tape Trace files.

Activating the Utility

//EXEC CTTCTRC

This utility is used during CONTROL-M/Tape installation by the job that

creates the CONTROL-M/Tape trace file.

Parameters
Parameters are supplied to the utility by invoking a JCL procedure.
Table 7-9

CTTCTRC Parameters for Data File Creation

Parameter

Description

DBPREFT

The high level qualifier of the dataset trace file. The default is the
value of the ICE variable &DBPREFT, set during ICE installation
step 3.1.
Note: The full name of the newly-created trace file is
&DBPREFT..TRC.

TRCUNITT

The unit on which the file is to be created. The default is the

value of the ICE variable &TRCUNITT, set during ICE installation
step 3.1.

TRCVOL

The volume on which the file resides. The default is the value of
the ICE variable &TRCVOL, set during ICE installation step 5.3.

TRCBLKS

The number of blocks that the data file contains. The default is
the value of the ICE variable &TRCBLKS, set during ICE
installation step 5.3.
To calculate the required number of records, see the topics on
Media Database and Stacking Database calculations in the
CONTROL-M/Tape chapter of the INCONTROL for OS/390 and
z/OS Installation Guide.

TRCBLK

The block size of the newly-created trace file. The default is the
value of the ICE variable &TRCBLK, set during ICE installation
step 5.3.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-21

CTTCTRC Allocate and Format Trace File

Return Codes
Table 7-10

CTTCTRC Return Codes

Code

Description

Operation performed successfully.

DCB open error.

12

Loading CONTROL-M/Tape environment failed.

16

The utility cannot run because CONTROL-M/Tape is active.

Example
//EXEC CTTCTRC,DBUNITT=3390,TRCBLKS=1700

BMC Software, Inc., Confidential and Proprietary Information

7-22

INCONTROL for OS/390 and z/OS Utilities Guide

CTTDBIB Rebuild Indexes of Stacking Database

CTTDBIB Rebuild Indexes of Stacking Database

Utility CTTDBIB rebuilds an index file from the CONTROL-M/Tape
Stacking Database (called the Stacking Statistics file prior to version 5.1.4)
Data file. The new index file corresponds to information currently contained
in the Stacking Database Data file.
Previous contents of the index file are erased.
Note:

Before activating the utility, the index file to be rebuilt must be

allocated and formatted using the IOADBF utility.

Use this utility:

when the amount of space remaining in the existing index file is

insufficient.
In this case:
Delete the index file.
Redefine and format the index file with the required amount of space,
using the IOADBF utility.
Rebuild the index file with utility CTTDBIB.

for performance improvement

Activating the Utility

//EXEC CTTDBIB

Parameters
The following parameter can be specified to the utility in the EXEC
statement that invokes the CTTDBIB JCL procedure:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-23

CTTDBIB Rebuild Indexes of Stacking Database

Table 7-11

CTTDBIB Parameters

Parameter

Description

DBRPEFT

The high level qualifier of the database files. The default in the
high-level qualifier of the CONTROL-M/Tape database
installation.

Note:

SYSIN parameters are provided in the KEYSTK member in the

PARM library for your convenience. The information in this member
is predefined and is used internally by the utility.

Return Codes
Table 7-12

CTTDBIB Return Codes

Code

Description

The operation was performed successfully.

The SYSIN parameter was set to a non-numeric string.

12

Memory allocation error.

16

Loading CONTROL-M/Tape environment failed.

Other

The operation failed.

Example
//EXEC CTTDBIB
//SYSIN DD DSN=CTT.PROD.PARM(KEYSTK),DISP=SHR

BMC Software, Inc., Confidential and Proprietary Information

7-24

INCONTROL for OS/390 and z/OS Utilities Guide

CTTDLD Add, Delete, or Convert Volumes

CTTDLD Add, Delete, or Convert Volumes

This utility adds volumes to, and deletes volumes from, the Media Database.
It can also convert volumes from other tape management systems (for
example, CA-1, CA-TLMS).
Use this utility:

To add a range of scratch or non-scratch volumes to the Active library

(MAINLIB). Records for these volumes are added to the Media
Database. This is called ADD mode.

To delete a range of scratch volumes from the Active Library

(MAINLIB). Records for these volumes are deleted from the Media
Database. This is called DELETE mode.

To build data from an external source of information and add it to the

data component of the Media Database. This is called CONVERT mode.
Usually CONVERT mode is used to convert another tape management
systems database (for example, CA-1, CA-TLMS) to
CONTROL-M/Tape.

Activating the Utility

ADD mode:
//EXEC
//SYSIN
TYPERUN
RANGE

CTTDLD
DD
*
MODE=ADD
FIRST=firstvol,LAST=lastvol,MEDIA=type,
SCRATCH=Y|N,VENDOR=vendor,RENAME=prefix

//

DELETE mode:
//EXEC
//SYSIN
TYPERUN
RANGE
//

CTTDLD
DD
*
MODE=DELETE
FIRST=firstvol,LAST=lastvol

CONVERT mode:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-25

CTTDLD Add, Delete, or Convert Volumes

//EXEC
//SYSIN
TYPERUN
RANGE

CTTDLD,INP=source-dataset
DD
*
MODE=CONVERT
FIRST=firstvol,LAST=lastvol,MEDIA=type,
VENDOR=vendor,RENAME=prefix

//

Note:

The INP parameter in the CTTDLD procedure is mandatory and

valid only in CONVERT mode.

The CTTDLD utility is used by the following jobs in the CONTROL-M/Tape

installation library:
Table 7-13

CTTDLD Jobs

Job

Description

CONVTMDB

Converts CA-TLMS tape management system reports to the

CONTROL-M/Tape Media Database.

CONVC4MD or
CONVC5MD

Converts from CA-1 (version 4 or 5) to the CONTROL-M/Tape

Media Database.

CONVLCTL

Converts from MVS Catalog to the CONTROL-M/Tape Media

Database.

CONVRMDB

Converts from RMM to the CONTROL-M/Tape Media Database.

To browse these jobs, use ICE minor option 3 (Tailor Job) under major option
7 (Housekeeping).

Parameters
Table 7-14

Parameter

CTTDLD Parameters (Part 1 of 2)

Description

The following parameter is specified in the EXEC statement:

INP

Name of the input file containing the data (VWR records) to be

converted. Mandatory and valid only in CONVERT mode.

The following parameters are supplied using DD statement SYSIN:

BMC Software, Inc., Confidential and Proprietary Information

7-26

INCONTROL for OS/390 and z/OS Utilities Guide

CTTDLD Add, Delete, or Convert Volumes

Table 7-14

CTTDLD Parameters (Part 2 of 2)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run of
this utility.
Valid subparameters are:
MODE Operation mode. Valid values are:
ADD Add volume entries to the Media Database.
DELETE Delete scratch volume entries from the Media
Database.
CONVERT Convert volume entries from another tape
management products database to CONTROL-M/Tape
Media Database format.

RANGE

Volume range and attributes. Valid values are:

FIRSTFirst volume serial number in the range. Mandatory.
LASTLast volume serial number in the range. Mandatory.

MEDIA

One of the media types defined in member CTTPARM.

Mandatory and valid only in ADD and CONVERT modes.

SCRATCH

Indication of whether the volume is added as scratch. Mandatory

and valid in ADD mode only. Valid values are:
Y (Yes) Volume is added as scratch.
N (No) Volume is not added as scratch.

VENDOR

Vendor of the media. Optional. Valid only in ADD and CONVERT

modes.

RENAME

String to replace the prefix of the volume serial number (volser).

The SL-name of the volume remains unchanged. Optional. The
use of this parameter is valid only in ADD and CONVERT modes.
The length of this string must not exceed the length of the prefix
in parameters FIRST and LAST (above).

Return Codes
Table 7-15

CTTDLD Return Codes

Code

Description

Operation performed successfully

Minor errors occurred Operation continues

Error in parameters Execution terminates

12

Loading CONTROL-M/Tape environment failed.

16

Error opening DCB Execution terminates

Greater than
16

Other error the error is accompanied by an appropriate

message indicating the problem Execution terminates

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-27

CTTDLD Add, Delete, or Convert Volumes

Example 1
Add 3400 type media non-scratch volumes numbered K00100-K00500, made
by IBM.
//EXEC
//SYSIN
TYPERUN
RANGE

CTTDLD
DD *
MODE=ADD
FIRST=K00100,LAST=K00500,MEDIA=3400,
SCRATCH=N,VENDOR=IBM

//

Example 2
Delete volumes numbered K00100-K00500.
//EXEC
//SYSIN
TYPERUN
RANGE
//

CTTDLD
DD *
MODE=DELETE
FIRST=K00100,LAST=K00500

Example 3
Convert 3480 type volumes numbered K00100-K00500 to
CONTROL-M/Tape.
//EXEC
//SYSIN
TYPERUN
RANGE
//

CTTDLD,INP=tape.convert
DD *
MODE=CONVERT
FIRST=K00100,LAST=K00500,MEDIA=3480

Example 4
If you are consolidating two tape libraries and both libraries contain tapes
with the same volsers, you can rename the volsers for one set of tapes so that
no conflict appears in the Media Database.

BMC Software, Inc., Confidential and Proprietary Information

7-28

INCONTROL for OS/390 and z/OS Utilities Guide

CTTDLD Add, Delete, or Convert Volumes

In this example, active 3480 type volumes made by IBM with volsers
FX0001-FX0100 are converted to CONTROL-M/Tape, renamed and added
to the Media Database.
Volsers FX0001-FX0100 are renamed MA0001-MA0100. The SL-names
(the internal labels of the volumes) remain FX0001-FX0100.
// EXEC
//SYSIN
TYPERUN
RANGE

CTTDLD,INP=TAPE.CONVERT
DD *
MODE=CONVERT
FIRST=FX0001,LAST=FX0100,MEDIA=3480,
VENDOR=IBM,RENAME=MA

//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-29

CTTGVL User Interface to Stacking Facility

CTTGVL User Interface to Stacking Facility

Utility CTTGVL assigns a volume to a specific dataset before the dataset is
allocated. The utility returns a volume serial number (according to user
specifications) for the file that the user wants to create.
When utility CTTGVL returns a volume serial number, the volume is
assigned a status of In-Use. This status prevents selection of the volume by
other users. When a dataset is written to the selected volume, the In-Use
status is removed from the volume.
If, for some reason, (for example, because no dataset was written to the
volume) a volume selected by utility CTTGVL remains with a status of
In-Use for three days, the status is removed by retention management utility
CTTRTM (that is normally run as part of the CONTROL-M/Tape New Day
procedure).
To select the appropriate volume, utility CTTGVL scans the
CONTROL-M/Tape rules (according to supplied parameters) so that the
volume that is returned is allocated from the appropriate pool.
The utility can optionally activate the CONTROL-M/Tape Stacking facility,
that searches the Media Database to locate a volume that has enough free
space to hold the new file. Upon user request, or if such a volume cannot be
located, a scratch volume can be returned instead.
Utility CTTGVL uses the active CONTROL-M/Tape environment (in
ECSA). Therefore, the utility can be called only on a CPU on that the
CONTROL-M/Tape environment is initialized.
If utility CTTGVL is run simultaneously on more than one CPU, an enqueue
manager (for example, GRS) must be used to ensure that no volume is
selected more than once by the utility.
The utility requires APF authorization. Therefore, it must reside in an
authorized library and the load module that contains it (if linked to the user
program) must also be authorized (parameter AC must be set to 1).

Activating the Utility

This utility is not a standalone utility. It must be called by an application
using one of the following methods. See the CTTGVLD sample in the IOA
SAMPLE library.

BMC Software, Inc., Confidential and Proprietary Information

7-30

INCONTROL for OS/390 and z/OS Utilities Guide

CTTGVL User Interface to Stacking Facility

Using a Call Command

CALL CTTGVL,(dataset,jobname,stackid,volser,label),VL

Using a Link command

LINK EP=CTTGVL,PARAM=(dataset,jobname,stackid,volser,label),VL

Parameters
Utility CTTGVL receives parameters in the standard method (Register 1
points to a list of addresses). The following parameters are passed to the
utility.

Input Parameters
Table 7-16

CTTGVL Input Parameters

Parameter

Description

DATASET

Name of the dataset. Maximum length: 44 characters.

Mandatory.

JOBNAME

Name of the job. Maximum length: 8 characters. Optional.

STACKID

Indicator (one character in length) specifying whether stacking is

enabled or disabled. Valid values are:
Y (Yes) Stacking is enabled.
N (No) Stacking is disabled.

Output Parameters
Table 7-17

CTTGVL Output Parameters

Parameter

Description

VOLSER

Volume serial number. Six characters must be specified.

LABEL

Hexadecimal representation (two bytes in length) of the label

number.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-31

CTTGVL User Interface to Stacking Facility

Return Codes
Table 7-18

CTTGVL Return Codes

Code

Description

Function completed successfully

No matching volume found

Invalid stacking indicator

12

CONTROL-M/Tape is not active

16

Database access failed a detailed message can be found in the

Job log or System log

Example
This utility must be called from an application program using one of the
following methods:

Using a Call command:

CALL CTTGVL,(DSN,JOBNAME,STACKID,VOLSER,LABEL),VL

Using a Link command:

LINK EP=CTTGVL,PARAM=(DSN,JOBNAME,STACKID,
VOLSER,LABEL),VL

Assume the following definitions for either of the above methods:

DSN
JOBNAME
STACKID
VOLSER
LABEL

DC
DC
DC
DS
DS

CL44MY.DSN
CL8MYJOB
CY
CL6123456
H01

Dataset name
jobname
Stacking indicator
Volume serial number
Label

BMC Software, Inc., Confidential and Proprietary Information

7-32

INCONTROL for OS/390 and z/OS Utilities Guide

CTTIDB Check Integrity of the Media Database

CTTIDB Check Integrity of the Media Database

Utility CTTIDB checks the integrity of the Media Database (MDB) and
provides statistical information. Warning messages are provided if database
inconsistencies are detected.
These inconsistencies may occur during conversion from another database, or
as a result of system crashes, utility abends, and so on, during processing.
Examples of inconsistencies:

Errors in the chain links that connect volumes in a multi-volume chain.

Existence of active volumes that do not contain datasets.
Existence of scratch volumes that do contain datasets.
Discrepancies between various Media Database records.

Note:

The CTTIDB utility checks the logical integrity of the database,

while the IOADIG utility checks the integrity of the physical
structure of a file, without referring to its logical data.

Upon completion, utility CTTIDB provides statistics about the Media

Database. The utility can be run for statistical purposes. The statistics
provided include:

Number of used data records.

Number of used index records.
Number of free data records.
Number of free index records.
Totals by type of record (volume, dataset, scratch).

It is recommended that this utility be run immediately after conversion from

another database, after a system crash, or after a CONTROL-M/Tape utility
abends during processing. This utility can be run whenever Media Database
statistics are desired.
Note:

Utility CTTIDB requires exclusive access to the Media Database.

Other utilities that access the Media Database (for example,
CTTRTM or CTTVTM) cannot run concurrently with this utility.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-33

CTTIDB Check Integrity of the Media Database

Activating the Utility

Note:

The SYSIN statement and the TYPERUN parameter are optional.

//EXEC
//SYSIN
TYPERUN

CTTIDB
DD *
MODE=CHECK[,USEDAYS=n]

Parameters
The following parameter is supplied using DD statement SYSIN:
Table 7-19

CTTIDB Parameter

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run of
this utility.
Valid subparameters are:
MODE Operation mode. Mandatory.
The only valid value is CHECK. Only messages related to
inconsistencies are
provided.
USEDAYS Threshold number of days since the volume
was last accessed. Messages are only generated for
volumes that are in use for more than the specified number
of days. Default: 7 (days)

Return Codes
Table 7-20

CTTIDB Return Codes

Code

Description

Operation performed successfully.

Problem detected in the Media Database. Execution continues.

12

Invalid control parameter given. Execution terminates.

16

Error opening DCB. Execution terminates.

32

Loading CONTROL-M/Tape environment failed.

Greater than
32

Severe error. The error is accompanied by an appropriate

message indicating the problem. Execution terminates.

BMC Software, Inc., Confidential and Proprietary Information

7-34

INCONTROL for OS/390 and z/OS Utilities Guide

CTTIDB Check Integrity of the Media Database

Example
In the following example, the CTTIDB utility checks the logical integrity of
the Media database and issues the appropriate error messages. Volumes that
have the IN USE status for more than six days are also reported.
//EXEC
//SYSIN
TYPERUN

CTTIDB
DD *
MODE=CHECK,USEDAYS=6

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-35

CTTMER Merge Records Into the Media Database

CTTMER Merge Records Into the Media Database

The CTTMER utility is used to merge Media Database records into a target
Media Database using an extract file created by utility CTTSPL.
Note:

There is no need to shut down CONTROL-M/Tape while running

this utility.

The CTTMER utility is used together with the CTTSPL utility in the split
and merge process. Before using the CTTMER utility, see Split and Merge
Processing on page 7-138.

After running the CTTMER utility, BMC Software recommends that you run
the CTTVTM utility in SLOTBLD mode to rebuild the slot definitions. After
completion of the CTTVTM utility, run the CTTIDB utility to check the
integrity of the target Media Database.

The CTTMER utility automatically updates the Media Database index

component. There is no need to run the CTTBIX utility after the run of this
utility.

Activating the Utility

//EXEC
//DAIN
TYPERUN
/*

CTTMER,MRGIN=repdata-file
DD *
MODE=NORMAL|SIMULATE|RSIMULAT[,DBGLEVEL=nnn]

BMC Software, Inc., Confidential and Proprietary Information

7-36

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMER Merge Records Into the Media Database

Parameters
Table 7-21

CTTMER Parameters

Parameter

Description

repdata-file

Extract file created by utility CTTSPL. The name of this file is

supplied using parameter MRGIN. Mandatory.
The extract file is a predefined sequential file
(olpreft.olvert.REPDATA) allocated as one of the
CONTROL-M/Tape operations libraries at time of
CONTROL-M/Tape installation (at the site containing the
source Media Database).

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility. Specify this parameter using DD statement
DAIN.
Valid subparameters are:
MODE Operation mode. Mandatory. Valid values are:
NORMAL Normal operation mode. Records in the
extract
file are merged into the Media Database. Default.
SIMULATE Simulation mode. No changes are made to
the Media Database. Messages describing simulated
operations are sent to the Utility log.
RSIMULAT Restart simulation. If a first run of utility
CTTMER abended, the utility can be rerun in this mode
prior
to rerunning it in NORMAL mode and thus causing an
automatic restart. Only the deletion of records already
merged into the Media Database is simulated.
Note: Only the deletion of data records, V-keys, D-keys
and
T-keys is simulated. Deletion of L-keys is not simulated.
DBGLEVEL Debug level. A numeric value from 1
through 255 can be specified. Optional.
Note: Use this parameter only if requested by BMC
Software Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-37

CTTMER Merge Records Into the Media Database

Example
In this example utility CTTMER merges all records in the extract file
(CTT.V600.REPDATA) into the Media Database.
//EXEC
//DAIN
TYPERUN
/*

CTTMER,MRGIN=CTT.V600.REPDATA
DD *
MODE=NORMAL

Return Codes
Table 7-22

CTTMER Return Codes

Code

Description

Operation performed successfully.

Initialization problem.

12

Merge failed some of the records to be merged already exist in

the target Media Database.

16

Unable to access the restart information from the Trace file.

20

Simulation mode is not allowed while restart is required.

24

Another utility is currently executing the Media Database is

locked.

28

Restart processing failed.

Greater than
28

Severe error the error is accompanied by a message

describing the problem.

BMC Software, Inc., Confidential and Proprietary Information

7-38

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

CTTMUP Manually Update the CONTROL-M/Tape

Repository
Utility CTTMUP can be used to update information in the Media Database,
the Stacking Database (called the Stacking Statistics file prior to version
5.1.4) and the Trace file. This utility is especially useful for modification of
information for a small number of datasets or volumes (for example, to
correct file integrity errors that resulted from a system crash or a utility
abend).
Warning!

Note:

Utility CTTMUP modifies your tape management information.

Use this powerful utility with caution.

Before running the CTTMUP utility, it is important to familiarize

yourself with the structure of the file you are planning to update, as
described in CONTROL-M/Tape chapter of the INCONTROL for
OS/390 and z/OS Administrator Guide. Attempting to update tape
management information without proper understanding of the
structure of the relevant file can lead to integrity errors.

Updating the Media Database

Utility CTTMUP can update fields of a volume or dataset record in the
Media Database (MDB). Update is performed independently for volume
and/or dataset records. When updating a volume record, the CTTMUP utility
does not automatically update the corresponding dataset records and vice
versa. (For example, the dataset count in a volume record is not updated
when the CTTMUP utility adds a dataset.) Therefore, when using this utility,
be sure to update all connected records. For more information, see Special
Notes Regarding Media Database Control Statements on page 7-46.
When a dataset is added, utility CTTMUP can optionally search the rules (as
if the dataset is being created on removable media) to determine retention and
vaulting criteria to be assigned to the dataset and the volume containing the
dataset.
For a general description of how this utility can be used to update the Media
Database, see the CONTROL-M/Tape chapter of the INCONTROL for
OS/390 and z/OS Administrator Guide.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-39

CTTMUP Manually Update the CONTROL-M/Tape Repository

Updating the Stacking Database

Run utility CTTMUP to update fields in the Stacking Database (called the
Stacking Statistics file prior to version 5.1.4). For example, utility CTTMUP
can modify the expected length of a dataset, or indicate if a dataset is
stackable.
Before updating the Stacking Database using utility CTTMUP, it is
recommended that you run utility CTTSTKR to generate a report from
information currently in the Stacking Database. This report helps you
determine what (if any) changes need to be made to the Stacking Database.

Activating the Utility

//EXEC
//SYSIN
TYPERUN

CTTMUP
DD *
MODE=NORMAL|SIMULATION[,RULEINFO=YES|NO][,
CHECK=YES|NO][,APPLY=GROUP][,DBGLEVEL=nnn]
<CONTROL STATEMENTS>

Parameters
The following parameters can be specified for utility CTTMUP.
Note:

Only parameter MODE is relevant for updates to the Stacking

Database. If other parameters are specified, they are ignored while
the utility is updating stacking statistics records.

BMC Software, Inc., Confidential and Proprietary Information

7-40

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

Table 7-23

CTTMUP Parameters

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Operation mode. Mandatory.
NORMAL Normal operation is performed.
SIMULATION Simulation mode is performed.
RULEINFO Whether to apply rule information (for
example, Retention criteria) when adding a dataset to the
Media Database.
Y (Yes) Apply rule information to the Media Database
record. Default.
N (No) Do not apply rule information to the Media
Database record.
CHECK Whether to check Media Database integrity
after performing the requested changes.
Y (Yes) Check the integrity of the Media Database.
Default.
N (No) Do not check the integrity of the Media
Database.
APPLY Determines which volumes are affected by the
VOLUPD control statement. Optional. Valid value:
GROUP The VOLUPD statement is applied to all
volumes in the multi-volume chain containing the volume
specified in the VOLSER field of the VOLUPD
statement.
Note: If parameter APPLY is not specified, the VOLUPD
statement is applied only to the volume specified in the
VOLSER field of the VOLUPD statement.
DBGLEVEL Debug level. A numeric value from 1
through 255 can be specified. Optional.
Note: Use this parameter only if requested by BMC Software
Customer Support.

Control Statements
Control statements specify the update function to be performed, the fields to
be updated and the update values.
This topic lists valid control statement functions for Media Database updates,
Stacking Database updates, and Trace updates, followed by information on
specifying fields and values.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-41

CTTMUP Manually Update the CONTROL-M/Tape Repository

Media Database Update Control Statements

Some of the functions are valid for volume type records only and some
functions are valid for dataset records only. For a list of Media Database
fields that can be updated by this utility, see the appendix that discusses
logical field names for the CONTROL-M/Tape Repository in the
INCONTROL for OS/390 and z/OS Administrator Guide. (They are the same
fields that can be specified in INCLUDE / EXCLUDE statements of other
utilities.)
Table 7-24

CTTMUP Media Database Update Control Statements

(Part 1 of 4)

Statement

Description

VOLADD

Add volume. One field is mandatory for this function:

VOLSER Volume serial number.

VOLUPD

Update volume. The VOLSER field is mandatory for this

function:
VOLSER Volume serial number.

VOLDEL

Delete volume. The volume to be deleted must be identified

by one of two fields (either field is mandatory):
VOLSER Volume serial number
or
DVLRBA Internal database record identifier
If DVLRBA is used to identify the volume, VOLSER can also
be specified for verification.

VOLSCR

Expire all the datasets in the volume and change the status of
the volume to scratch.
VOLSER Volume serial number. Mandatory.
DEFERRED Choose deferred (or immediate) scratch.
Optional. Possible values are:
Y (Yes) Perform deferred scratch.
N (No) Perform immediate scratch. Default.

VOLBIX

Rebuild the indexes of a volume and of all its datasets. The

volume must be identified by one of two fields (either field is
mandatory):
VOLSER Volume serial number.
or
DVLRBA Internal database record identifier.
If DVLRBA is specified to identify the volume, VOLSER can
also be specified for verification.

GRPSCR

Expire all datasets of all the volumes in the group and change
the status of those volumes to scratch.
VOLSER Volume serial number of one of the volumes in
the group.
DEFERRED Choose deferred (or immediate) scratch.
Optional. Valid values are:
Y (Yes) Perform deferred scratch.
N (No) Perform immediate scratch. Default.

BMC Software, Inc., Confidential and Proprietary Information

7-42

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

Table 7-24

CTTMUP Media Database Update Control Statements

(Part 2 of 4)

Statement

Description

GRPBIX

Rebuild the indexes of all the volumes and of all the datasets
in the group. One of the volumes in the group must be
identified by one of two fields (either field is mandatory):
VOLSER Volume serial number of a volume in the group.
or
DVLRBA Internal database record identifier of a volume
in the group.
If DVLRBA is used to identify the volume, VOLSER can also
be specified for verification.

DSNUPD

Update dataset record. The record to be updated must be

identified either by specifying both
DSVOLSER Datasets volume serial number
and
DSLABELDatasets label number (file sequence),
or by specifying
DDSRBA Internal database record identifier.
One of these two sets of fields is mandatory.
If DSNAME is specified, it is used for verification only. The
dataset name cannot be modified.

DSNUPDN

Update dataset name (the DSNAME field in the dataset

record). Only the following parameters are valid for this
control statement.
NEWNAME New dataset name. Mandatory.
DSNAME The current dataset name (before update).
This parameter is used for verification only. The dataset
cannot be modified.
The record to be updated must be identified either by
specifying both
DSVOLSER Datasets volume serial number
and
DSLABEL Datasets label number (file sequence).
or by specifying
DDSRBA Internal database record identifier.
One of these two sets of fields is mandatory.

DSNADD

Add dataset record. Three fields are mandatory for this

function:
DSVOLSER Datasets volume serial number.
DSLABEL Datasets label number.
DSNAME Dataset name.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-43

CTTMUP Manually Update the CONTROL-M/Tape Repository

Table 7-24

CTTMUP Media Database Update Control Statements

(Part 3 of 4)

Statement

Description

DSNDEL

Delete dataset record. The record to be deleted must be

identified by specifying both
DSVOLSER Datasets first volume
and
DSLABEL Datasets label number
or
DDSRBA Internal database record identifier.
One of these two sets of fields is mandatory.
If DDSRBA is used to identify the record, DSVOLSER and
DSLABEL can also be specified for verification.
If DSNAME is specified, it is used for verification only.

DSDELL

Delete L-type key for a volume. Two fields are mandatory for
this function:
DSVOLSER Datasets volume serial number.
DSLABEL Datasets label number.

DSNEXT

Extend the retention of a dataset by a specific number of

days. Three fields are mandatory for this function:
DSVOLSER Datasets volume serial number.
DSLABEL Datasets label number.
DAYS Number of days by which to extend the dataset.

RECDEL

Delete Media Database record (any type). One field is

mandatory for this function:
RBAInternal database record identifier.

RECUPD

Modify records of any type in the Media Database (for

example, Restart Control records, Slot Definition records).
This function includes the following control statements:
RECUPD RBA=rba
VER
offset data
REP
offset data

ENDUPD
Statement RECUPD selects a records from the Media
Database for update. It must be the first statement specified.
This statement includes the following parameters:
RBA Update internal database record identifier.
VER Verify existing data before updating the record.
REP Replace existing data with new data.

BMC Software, Inc., Confidential and Proprietary Information

7-44

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

Table 7-24

Statement

CTTMUP Media Database Update Control Statements

(Part 4 of 4)

Description
ENDUPD Identifies the end of the RECUPD function. It
must be the last statement in this function.
An unlimited number of paired VER and REP statements can
follow the RECUPD statement. These statements are
formatted like the VER and REP statements of MVS utility
AMASPZAP:
Data is provided in both the VER and REP statements, as
follows:
offset Offset of the data from the beginning of the record
(four digits in hexadecimal format, from 0000 through
01CC).
data Record data for verification or replacement (in
hexadecimal ZAP format).
Example
This example updates the volume record with the statement
RBA=00000104. Two status bytes are verified on offset 0005
and status IN-USE then set.

RECUPD
VER
REP
ENDUPD
VOLSCRF

RBA=00000104
0005 8000
0005 8002

Scratch a volume in the Media Database regardless of

integrity errors. One field is mandatory for this function:
VOLSER Volume serial number.

Stacking Database Update Control Statements

Stacking Database fields that can be updated by this utility are listed in
Table 7 in Appendix D.
Table 7-25

CTTMUP Stacking Database Update Control Statements

(Part 1 of 2)

Statement

Description

STKADD

Add a record to the Stacking Database. The following fields are

mandatory for this function:
JOBNAME Name of the job that created the first generation
of the dataset.
DSNAME Dataset name.

STKUPD

Update a record in the Stacking Database. The following fields

are mandatory for this function:
JOBNAME Name of the job that created the first generation
of the dataset.
DSNAME Dataset name.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-45

CTTMUP Manually Update the CONTROL-M/Tape Repository

Table 7-25

CTTMUP Stacking Database Update Control Statements

(Part 2 of 2)

Statement

Description

STKDEL

Delete a record from the Stacking Database (STK). The following

fields are mandatory for this function:
JOBNAME Name of the job that created the first generation
of the dataset.
DSNAME Dataset name.

Trace Update Control Statement

Table 7-26

Trace Update Control Statement

Statement

Description

TRCUPDQ

Change the QNAME in the CONTROL-M/Tape Trace file to

the QNAME in the IOAPARM member.

Special Notes Regarding Media Database Control Statements

DSNEXT Function

This function is intended for use with datasets that have a specific retention
date. Datasets that have a non-specific retention type (for example, MVS
Catalog, Permanent) cannot be extended using this function. When a datasets
retention is extended, the retention date is added to the number of specified
days.
Note:

This function can be used with DAYS set to 0 to remove

"pending-scratch" status from a dataset, without actually extending
its retention date.

This function can also be used to unscratch datasets. When DSNEXT is used
against a scratch dataset, the dataset becomes active. If the volume itself was
also scratch, the entire volume and its datasets become active. The new
retention date becomes the current date plus the number of days specified.

VOLBIX Function

This function is intended for use only when the CTTIDB utility detected
errors with V-indexes (volume indexes). Do no use this function for L-index
problems.

BMC Software, Inc., Confidential and Proprietary Information

7-46

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

GRPBIX Function

Be sure that you have corrected all V-indexes before using this function.
This function corrects problems of L-indexes and D-indexes. It can be
applied for a single volume as well as for a multi-volume group.

VOLUPD Function

When this function is used to update the MEDIA, LOCATION, or

SLOTNUM fields of the volume, the slot in which a vaulted volume
resided remains in status IN USE.
In this case, to synchronize the Slot Definition Records in the Media
Database, run the CTTVTM utility with the following control statement:
TYPEVLT MODE=SLOTBLD

A single status bit can be set in a specific status byte of a volume or

dataset record.
For example, to turn on the PVLT (Potential Vault) status on a volume
record, include the following statement:
VOLUPD.....,VOLIND=+PVLT

To turn off the above status bit include the following:

VOLUPD.....,VOLIND=-PVLT

VOLSCR and GRPSCR Functions

Immediate scratch of volumes or groups of volumes is not reflected in

subsequent scratch reports of the CTTRTM utility. If you want to include
these volumes in the next scratch report, set DEFERRED to YES. This way,
volumes are scratched during the next run of the CTTRTM utility.

VOLSCRF Function

This function is intended for use only after integrity errors occurred while
trying to scratch records using the VOLSCR or GRPSCR function.
This function affects single volumes only. To scratch a multi-volume group,
specify this function for each volume separately.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-47

CTTMUP Manually Update the CONTROL-M/Tape Repository

Specifying Fields and Values

Consider the following points when specifying fields and values for this
utility:
Table 7-27

CTTMUP Fields

Field

Description

Date Fields

Format is yymmdd or yyyymmdd.

Time Fields

Format is hhmmss.

Numeric Fields

Leading zeroes are not required. Hexadecimal values must be

prefixed with an X (for example, DVLRBA=X01234567 instead of
DVLRBA=01234567). The only exception to this is the VER and
REP fields.

Embedded
Blanks

Use only if the value is enclosed in either single or double

quotes.

Quotation
Marks ( or )

If the value begins and ends with either single or double quotes,
the quotation marks are interpreted as markers of the beginning
and end of the value. To include a quote mark in a string (value),
use the other type of quote mark to mark the beginning and end
of the string. For example, a single quote (apostrophe) can only
be included in the value if the value is enclosed in double quotes
().

Null Values

Specify a null value for a field by specifying the field without a

value (for example, VOLSER=).

Retention
Criteria Fields

Specification of retention criteria requires two fields or values:

Retention type
Retention data
If retention data is specified without specifying the retention type,
the retention type defaults to DATE.

Fields with
Predefined
Valid Values

Certain fields have a predefined set of valid values (for example,

valid values for field VOLSTAT are ACTIVE, VAULTED).
Valid values for these fields are listed in Appendix D. Values can
also be specified in hexadecimal format (for example,
VOLSTAT=X88 meaning Active and Vaulted).

Status Bits

A single status bit can be set in a specific status byte of a volume

or dataset record.
For example, to turn on status PVLT (Potential Vault) on a volume
record, include the following statement:

VOLUPD.... ,VOLIND=+PVLT
To turn off the above status bit, include the following:

VOLUPD.... ,VOLIND=-PVLT

BMC Software, Inc., Confidential and Proprietary Information

7-48

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

Specific Field Recommendations

Table 7-28

CTTMUP Field Recommendations

Field

Description

LBLNUM

Last label number on the volume. This value cannot be less than
the value of ACTIVEDS (number of active datasets on the
volume). If not specified, LBLNUM defaults to the value of
ACTIVEDS.

Return Codes
Table 7-29

CTTMUP Return Codes

Code

Description

Operation performed successfully

Minor errors occurred during the update process, or errors were

found during the logical integrity check of the database.
Operation continues in either case.

Missing DD statements or open error occurred.

12

Load of other CONTROL-M/Tape programs failed

16

I/O error

20

Input Control Statement error

24

Authorization failure (by security exit)

28

Invalid return code from routine CTTEXP

Example
Example 1

Convert scratch volume DDD020 to active status and add dataset FILE7 to
the volume.
//EXEC
//SYSIN
TYPERUN
VOLUPD
DSNADD

CTTMUP
DD *
MODE=NORMAL
VOLSER=DDD020,ACTIVEDS=1,VOLSTAT=ACTIVE
DSVOLSER=DDD020,DSLABEL=1,DSNAME=FILE7,
CREDT=990622,CRETM=142500,CREJBN=JOB1

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-49

CTTMUP Manually Update the CONTROL-M/Tape Repository

Example 2

Rebuild a chain of two volumes. The first volume, PRD001, has two datasets
on it. The second dataset reached the end of the first volume and continued
on the second volume, PRD002.
//JOB NAME
//CTTMUP
//SYSIN
TYPERUN
VOLUPD

VOLUPD

DSNADD
DSNADD

JOB ....
EXEC CTTMUP
DD *
MODE=NORMAL,RULEINFO=YES,CHECK=NO
VOLSER=PRD001,VOLSTAT=ACTIVE,VOLSEQ=1,
ACTIVEDS=2,LBLNUM=2,MEDIA=3480,
LOCATION=MAINLIB,FIRSTVOL=PRD001,
NEXTVOL=PRD002,PREVVOL=
VOLSER=PRD002,VOLSTAT=ACTIVE,VOLSEQ=2,
ACTIVEDS=1,LBLNUM=2,MEDIA=3480,
LOCATION=MAINLIB,FIRSTVOL=PRD001,
NEXTVOL=,PREVVOL=PRD001
DSVOLSER=PRD001,DSLABEL=1,
DSNAME=PROD.BACKUP.G0001V00,VOLSNUM=1
DSVOLSER=PRD001,DSLABEL=2,
DSNAME=PROD.BACKUP.G0002V00,VOLSNUM=2

//

Considerations

This example assumes that PRD001 and PRD002 are defined in the
Media Database and are in SCRATCH status. If these volumes are not
defined in the Media Database, you must change the first two control
cards from VOLUPD to VOLADD.

Parameter ACTIVEDS is set to 2 for PRD001 because PRD002 contains

the two datasets. PRD002 contains only the second dataset, so
ACTIVEDS is set to 1 for PRD002.

LBLNUM is set to 2 for both volumes because the highest label number
on both of volumes is label 2.

The second dataset, PROD.BACKUP.G0002V00 has VOLSNUM set to 2

because it spans the two volumes.

The expression RULEINFO=YES indicates that retention and vaulting

attributes are automatically taken from the rules. It is therefore
unnecessary to specify retention and vaulting information.

BMC Software, Inc., Confidential and Proprietary Information

7-50

INCONTROL for OS/390 and z/OS Utilities Guide

CTTMUP Manually Update the CONTROL-M/Tape Repository

Example 3

Update a record in the Stacking Database to indicate that dataset ACCT.JAN1

is stackable and update a different record in this file to indicate new
maximum and minimum lengths for dataset ACCT.FEB2.
//CTTMUP
//SYSIN
TYPERUN
STKUPD
STKUPD

EXEC CTTMUP
DD *
MODE=NORMAL,CHECK=NO
DSNAME=ACCT.JAN1,JOBNAME=JOB1,STATUS=STK
DSNAME=ACCT.FEB2,JOBNAME=JOB2,
MAXSIZE=20480,MINSIZE=1024

//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-51

CTTRCV Recover the Media Database Using Trace File

CTTRCV Recover the Media Database Using Trace

File
The CTTRCV utility recovers damaged Media Database (MDB) contents
according to trace data recorded during MDB update operations. The utility
can perform either a physical or a logical recovery.

Physical Recovery (Roll Forward)

Physical recovery assumes that the last available backed up MDB was
restored to disk, as described in the topic CTTTRB Synchronize Trace
File and Media Database Backup on page 7-171. From this point
forward, recovery is performed according to trace data.
Note:

By default, the CONTROL-M/Tape daily job uses the

DFSMSdss to back up the MDB. In this case, you must use the
DFSMSdss RESTORE command to restore the backed up MDB.

Trace records are read starting with the first record after the Media
Database backup record. Recovery continues until the last trace record is
reached. When the process is finished, the MDB returns to the condition
it was in before it was damaged.
In situations where no MDB backup has been performed, the recovery
can be started from the first trace record.
To prevent unpredictable results, the CONTROL-M/Tape environment
must be inactive while the physical recovery process is running.

Logical Recovery (Roll Back)

Logical recovery rolls back selected changes from the current MDB. This
type of recovery can be performed when a user modifies the status of one
or more MDB records and then discovers that these modifications must
be reversed. A good example of this scenario is when a job is run that
scratches a series of active volumes or moves a series of volumes to a
vault incorrectly.
When this type of recovery is used, the trace records are read backward
(that is, starting from the last record towards the first record). The
improper modifications are reversed in a way that restores the MDB to
the condition it was in prior to the improper modifications.
To maintain the logical consistency of the MDB, the CTTRCV utility
verifies that the current contents of the MDB match the tracked
information in the Trace file.

BMC Software, Inc., Confidential and Proprietary Information

7-52

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRCV Recover the Media Database Using Trace File

For example, if the status of a volume was changed from Active to

Scratch by TSO user ABC and a logical recovery is performed on all
operations performed by user ABC, the utility verifies that the current
volume status in the MDB is Scratch before the recovery reverses the
operation.
Note:

You can bypass this check by setting FORCE to either YES or

LOGICAL. However, this may cause unpredictable results.

Activating the Utility

//EXEC
CTTRCV
//SYSIN
DD *
RECOVER TYPE=PHYSICAL|LOGICAL[,
MODE=SIMULATION|NORMAL][,
FROMREC=LASTBKP|FIRSTREC][,CHECKACT=YES|NO][,
RECAT=YES|NO][,FORCE=YES|NO]
<INCLUDE/EXCLUDE STATEMENTS>
//

Warning!

This utility updates the database using the tracked RBA record
from the Trace file. To prevent a possible integrity error in the
database, you must perform the following steps in sequence after
running the CTTRCV utility:
Run the IOADIG utility with the FUNC parameter set to W.
Rebuild the index with the CTTBIX utility.

Parameters
Utility parameters are supplied using DD statement SYSIN:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-53

CTTRCV Recover the Media Database Using Trace File

Table 7-30

CTTRCV SYSIN Parameters (Part 1 of 3)

Parameter

Description

RECOVER

Determines which type of recovery is performed.

TYPE Type of the recovery. Mandatory.
PHYSICAL A physical (roll forward) recovery is to be
performed.
LOGICAL A logical (roll back) recovery is to be
performed.
MODE Mode of recovery. Optional.
SIMULATION Simulation mode. Trace records, and
Media Database records when needed, are read. The
Media Database is not updated and datasets are not
recataloged.
NORMAL Normal mode. Default. Trace records, and
Media Database records when needed, are read.
Updates are actually performed on the Media Database
(that is, the Media Database is updated).

BMC Software, Inc., Confidential and Proprietary Information

7-54

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRCV Recover the Media Database Using Trace File

Table 7-30

Parameter

CTTRCV SYSIN Parameters (Part 2 of 3)

Description
FROMREC Starting point of the recovery. Can only (and
must) be specified when TYPE is set to PHYSICAL.
LASTBKP The recovery starts from the point where
the Media Database was last backed up.
FIRSTREC The recovery starts from the first Trace
record. This option is useful for new sites that have not
yet performed any Media Database backups.
CHECKACT Check if CONTROL-M/Tape is active before
starting the recovery. When recovery is performed, the
CONTROL-M/Tape Real-time environment must not be
active (that is, it must be down or suspended). In simulation
mode, this parameter has no effect.
Y (Yes) If CONTROL-M/Tape is active, recovery is|
not started.
N (No) Recovery is started regardless of whether
CONTROL-M/Tape is active.
Warning: If N (No) is specified when CONTROL-M/Tape is
active, Media Database integrity can be lost and
unpredictable results can occur.
Use this value to initiate a recovery in a test environment on a
test Media Database while the production environment is still
active.
RECAT In logical (roll back) recovery, recatalog datasets
that were uncataloged by utility CTTRTM.
Y (Yes) Recatalog all datasets that were uncataloged.
Note: The same catalog environment that existed for the
CTTRTM utility is required by the CTTRCV utility.
N (No) Do not recatalog datasets.
FORCEIn logical (roll back) recovery, indicates whether a
check is performed to verify that the current contents of the
Media Database match the operation that is reversed.
Y (Yes) Perform the reversal operation without
performing the check.
Warning: Specifying Y (Yes) can cause unpredictable results
and the loss of Media Database integrity.
L (Logical)Perform the check. The changes for the
Media Database records that pass this check (and
therefore match the operation being reversed) are rolled
back. Records that do not pass the check are not
affected.
N (No)Perform the reversal operation only if all checks
were completed successfully.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-55

CTTRCV Recover the Media Database Using Trace File

Table 7-30

CTTRCV SYSIN Parameters (Part 3 of 3)

Parameter

Description

INCLUDE /
EXCLUDE

The scope of the utility can be limited by one or more

INCLUDE / EXCLUDE statements. INCLUDE / EXCLUDE
statements are optional and are valid only when a logical
(rollback) recovery is performed (meaning, TYPE is set to
LOGICAL).
For more information about INCLUDE / EXCLUDE
statements for this utility, refer to Logical Field Names for the
CONTROL-M/Tape Repository in Appendix D.
For additional information on INCLUDE / EXCLUDE
statements, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6.

Return Codes
Table 7-31

CTTRCV Return Codes

Code

Description

Recovery operation performed successfully.

Input statements missing.

DCB open error occurred.

12

Input statement parsing error or validation error occurred.

16

Loading CONTROL-M/Tape environment failed.

24

Media Database or Trace file I/O error occurred.

28

Logical error in Media Database (for TYPE=LOGICAL).

32

CONTROL-M/Tape Real-time environment is active.

Examples
Example 1

Recover a damaged Media Database. The last available Media Database

backup has been restored to disk.
//EXEC
//SYSIN

CTTRCV
DD *
RECOVER TYPE=PHYSICAL,FROMREC=LASTBKP

BMC Software, Inc., Confidential and Proprietary Information

7-56

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRCV Recover the Media Database Using Trace File

Example 2

Reverse all changes performed by user M27A from July 19th, 13.40.00, to
July 22nd, 12.24.45:
//EXEC
//SYSIN

CTTRCV
DD *
RECOVER TYPE=LOGICAL,RECAT=YES
INCLUDE
JOBNAME=M27A,DATE=20000719,TIME>134000
INCLUDE JOBNAME=M27A,DATE>20000719
EXCLUDE DATE>20000721
INCLUDE JOBNAME=M27A,DATE=20000722,TIME<122445

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-57

CTTRPT Database Extraction and Report Utility

CTTRPT Database Extraction and Report Utility

Utility CTTRPT extracts data from the Media Database (MDB) using Extract
parameters and generates reports from the extracted data using Report
Formatting parameters.
Data extraction and report generation are performed in a single utility run.
Both Extraction parameters and Report Formatting parameters are specified
in the utility run.
Instead of extracting entire records, the utility only extracts information
required for the report from the Media Database (or from the extracted
dataset described above) and produces the report. There is no need to create a
dataset for saving the extracted information, although this can be done if
desired.
This method of report generation is the most efficient when a single report is
required.
It is also most efficient when all the data requirements of subsequent reports
can be satisfied from the extracted data (meaning, when no additional data is
required by subsequent reports). In this case, the extracted data is saved in a
dataset for subsequent runs of the utility.
At least one group of parameters must be specified, such as Extract
parameters or Report Formatting parameters.
The dataset for holding extracted information is specified in DD statement
REPDATA.

Primary Key, Primary Fields and Primary Lines in Report

Generation
The user can define up to two lines that comprise the report output (meaning,
the user determines which fields are included in the report lines).
Many fields in a report maintain the same value for many records (for
example, vault name for a multi-volume group). These fields are called
primary fields and one of them is the primary key. (The field that is the
primary key and the fields that are the primary fields are determined by the
type of report being created.)
By setting parameter ID to P (Primary) or S (Secondary), the user can
designate a report line as a primary line. Primary lines are only printed when
the primary key changes value.

BMC Software, Inc., Confidential and Proprietary Information

7-58

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

The primary key and the primary fields are determined as follows:

In the GENERAL report, the primary key is determined by the PATH

parameter specified in the EXTRACT statement.
If PATH is set to VOLUME/ALLDATASETS or to
VOLUME/FIRSTDATASET, the primary key is the volser and the
primary fields are the fields extracted from volume record.
If PATH is set to DATASET/ALLVOLUMES or to
DATASET/FIRSTVOLUME, the primary key is the volser and sequence
number of the dataset; and the primary fields are the fields extracted from
the dataset record.

In the DISTRIB report, the primary key is the volser of the volume (or
the volser of the first volume in a multi-volume chain) and the primary
fields are the fields that have the same value for all volumes in the chain
(for example, From Location and To Location) and the fields extracted
from the dataset record that determined the vaulting pattern.

In the SCRATCH report, the primary key is the volumes volser (or the
first volumes volser in a multi-volume chain) and the primary fields are
the fields extracted from the expiration dataset record.

Activating the Utility

//EXEC
CTTRPT
//REPDATA DD DSN=extract-dataset
//SYSIN
DD *
[
<EXTRACT parameters>
<REPORT parameters>
]

Parameters
Utility parameters are supplied using DD statement SYSIN:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-59

CTTRPT Database Extraction and Report Utility

Extract Parameters
EXTRACT PATH=VOLUME|
VOLUME/FIRSTDATASET|
VOLUME/ALLDATASETS|
DATASET|
DATASET/FIRSTVOLUME|
DATASET/ALLVOLUMES
<INCLUDE/EXCLUDE statements>

The syntax
EXTRACT PATH=rectype

specifies the type of records to be extracted. Valid values:

Table 7-32

CTTRPT Extract Parameter Values

Value

Description

VOLUME

Volume records are extracted.

VOLUME/
FIRSTDATASET

Volume records with only their first dataset records are

extracted. Abbreviation: VOLUME/FIRSTDS.

VOLUME/
ALLDATASETS

Volume records with all their dataset records are extracted.

Abbreviation: VOLUME/ALLDS

DATASET

Dataset records are extracted.

DATASET/
FIRSTVOLUME

Dataset records with only their first volume records are

extracted. Abbreviation: DATASET/FIRSTVOL

DATASET/
ALLVOLUMES

Dataset records with all their volume records are extracted.

Abbreviation: DATASET/ALLVOLS

Multiple EXTRACT statements can be specified in DD statement SYSIN, but

each additional EXTRACT statement must follow the INCLUDE /
EXCLUDE statements (if any) and the Report Parameter statements of the
preceding EXTRACT statement. When saving extracted data in a dataset, if
several EXTRACT statements are specified, only the data extracted by the
last EXTRACT statement is stored.

INCLUDE / EXCLUDE Statements

The scope of extraction can be limited by a combined maximum of 1000
INCLUDE / EXCLUDE statements.
INCLUDE / EXCLUDE statements can be specified only immediately after
the EXTRACT statement.

BMC Software, Inc., Confidential and Proprietary Information

7-60

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Subparameters specified in INCLUDE / EXCLUDE statements must not

contradict the PATH parameter of the EXTRACT statement. For example, if
PATH is set to DATASET, subparameters specified in the INCLUDE /
EXCLUDE statements must not include fields from volume records.
For a list of subparameters that can be specified in INCLUDE / EXCLUDE
statements, see the appendix that discusses logical field names for the
CONTROL-M/Tape Repository in the INCONTROL for OS/390 and z/OS
Administrator Guide. For additional information about INCLUDE /
EXCLUDE statements, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6.

Report Formatting Parameters

Figure 7-6

CTTRPT Report Formatting Parameters

REPORT NAME=GENERAL,TITLE=text,FOLD=YES|NO,
PAGESIZE=p,LINESIZE=s,MARGINS=m-n,
SUMMARY=YES|NO,OUTDD=ddname
FIELDS field 1/options-1,field 2/options-2,...,
field n/options-n,ID=P|S
SORTBY field 1/options-1,field 2/options-2,...,
field n/options-n
ATTR
FIELD=name,LENGTH=t,TITLE=text,EDIT=mask
BREAK FIELD=name,COLUMN=c,SUMTITLE=text,
EDIT=numeric mask

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-61

CTTRPT Database Extraction and Report Utility

Table 7-33

CTTRPT Report Formatting Parameters (Part 1 of 7)

Parameter

Description

REPORT

Activates report formatting. The following subparameters can

be specified:
NAMEReport name. Mandatory. Valid value:
GENERALGeneral report of information extracted from
the Media Database.
TITLEReport title. Optional. The maximum length is 64
characters. Default: General Report.
FOLDIndicates whether all report data is printed in
uppercase. Valid values are:
Y (Yes)Print all report data in uppercase.
N (No)Print report data in upper and lowercase.
Default.
PAGESIZE Maximum lines in a page, where p is a
numeric value greater than 20. Optional. Default: 63.
LINESIZE Maximum characters in a line, where s is a
numeric value not greater than 255. Optional. Default: 127.
MARGINS=m-n Lowest (m) and highest (n) columns in a
line, where m is a numeric value greater than 0 and n is a
numeric value greater than m but not greater than s (the
value of LINESIZE). Optional. Defaults: m=1 and n=s.
SUMMARY= YES|NO Indicates whether to show a
summary line for each field break. Optional. Default: NO.
A field break occurs when there is a change in value for a
field that is specified in a SORTBY statement with option
/BRK, (or /B).
OUTDDJCL DD name of the output. Default: REPOUT.

BMC Software, Inc., Confidential and Proprietary Information

7-62

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Table 7-33

CTTRPT Report Formatting Parameters (Part 2 of 7)

Parameter

Description

FIELDS

Output fields (meaning, fields required in the report) and the

options that can be applied to each field. Mandatory.
The GENERAL report can contain volume and dataset fields
that can be specified as INCLUDE / EXCLUDE
subparameters and special fields that cannot be specified as
INCLUDE / EXCLUDE subparameters (described with their
attributes later in this utility).
OptionsOptions can be added as a suffix to any output
field in the list (optional for each field). The slash (/)
preceding the option is required to distinguish the option
from the field. Any number of options can be added to an
output field. Available options:
/LnLength of the output field. n must be a numeric
value that does not exceed the length defined in the list
of available fields. This option is used for Alphanumeric
and Hexadecimal fields only. Optional.
This value, if specified, overrides a LENGTH value
specified in the ATTR statement, described in this table.
/CnColumn in which the field begins in the printed
output. If specified for a field, it must be specified for all
preceding fields. n must be a numeric value greater than
the last column of the preceding field (determined by the
preceding fields beginning column and field length).
IDP|S Output line indicator. This parameter designates an
output line as a Primary Line (P) or Secondary Line (S).
These values determine whether duplicate lines are printed
from Volume and Dataset data. Optional.
PPrimary line indicator. The line is only printed when a
primary key changes value.
SSecondary line indicator. A line is printed for each
record. Default.

SORTBY

Sort order of the output fields, described in FIELDS in this

table. Optional.
Options Options can be added as a suffix to any output field
in the list (optional for each field). The slash (/) preceding the
option is required to distinguish the option from the field. Any
number of options can be added to an output field. Available
options:
/BRK or /BInsert a page break in the report when the field
changes its value. If specified for a field, it must be
specified for all preceding fields.
/ASC Sort the field in ascending order. Default.
/DSC Sort the field in descending order.
/RSR Reset the row number whenever the value of the
field changes. This option is effective only when field
ROWID is specified in the FIELDS statement
/RSP Reset the row number whenever the value of the
field changes. This option automatically activates option
/RSR.
Note: Primary fields in a SORTBY statement must be
specified before non-primary fields.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-63

CTTRPT Database Extraction and Report Utility

Table 7-33

Parameter

CTTRPT Report Formatting Parameters (Part 3 of 7)

Description
Example 1
SORTBY LOCATION /BRK (or /B)
POOL/BRK/DSC,MEDIA/ASC
Output is sorted by vault (LOCATION) in ascending order (the
default) by pool (POOL) within a vault in descending order
and by media (MEDIA) within a pool in ascending order. A
page break is inserted each time the vault or pool changes.
Example 2
SORTBY LOCATION /BRK/RSP,
MEDIA/BRK/RSR,EXPDT/DSC
Output is sorted by vault (LOCATION) in ascending order (the
default) by media (MEDIA) within a vault in ascending order
(by default) and by expiration date (EXPDT) within a media in
descending order. A page break is inserted for every change
in vault and media and the page number (and, by default, the
row number) is also reset each time the vault changes. The
row number is reset each time the media changes.

ATTR

Overrides default attributes defined for a field. Optional.

At least one optional parameter must be specified for
statement ATTR.
An ATTR statement can be specified for any field, even a field
not included in a FIELD statement. The report, however, is
not effected by an ATTR for a field until the field is included in
a FIELD statement. (This means that an ATTR statement can
be defined in advance for each field, for use when the field
appears in a FIELD statement.)
Member ATTRGEN in the CONTROL-M/Tape PARM library
contains sample ATTR statements for the GENERAL report.
The following parameters apply to the field whose attributes
are changed:
FIELD name Name of the field. Mandatory.
LENGTH Length of the output field. Must be a numeric
value that must not exceed the field length specified in the
list of available fields. Optional. A /Ln value, if specified for
the same field in the FIELDS statement, overrides this
value.
TITLE text Field header. text is any character string
(enclosed in apostrophes). To split the header between
lines, insert a slash (/) before each line break. The number
of header lines in the report is determined by the field
whose TITLE parameter text has the highest number of
lines. Optional.
For example, if the following is specified:
ATTR FIELD VOLSER
TITLE=Volume or Serial or Number
The header for field VOLSER spans three output lines as
follows:

Volume
Serial
Number

BMC Software, Inc., Confidential and Proprietary Information

7-64

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Table 7-33

Parameter

CTTRPT Report Formatting Parameters (Part 4 of 7)

Description
EDIT=mask Field format, as specified through a mask.
The mask must be enclosed in apostrophes. Parameter
EDIT cannot be specified for character and hexadecimal
fields. Valid mask formats:
Numeric Format For numeric fields only. The mask can
consist of Zs and 9s and commas, where 9 represents any
digit, Z represents a digit that is suppressed if its value is a
leading zero and comma is a separator between digits.
When specifying a numeric format, the following rules
apply:
A 9 cannot precede a Z in the mask.
A comma cannot be the first or last character of the
mask.
Example
Assume number 1234 is being edited (and b indicates
blank)
Mask Specified Result
ZZ,ZZ9
b1,234
Z,999
1,234
999999
001234
ZZZ,ZZZ
bb1,234
Date Format
For Date fields. Valid mask combinations can have no more
than one day symbol, one month symbol and one year
symbol.
Valid symbols:
DD Day (values 1 31).
MM Month (values 1 12).
MMM Month (values Jan Dec).
YY Year (last two digits, meaning, 00 99).
YYYY 4-digit year (for example, 2000).
Symbols can be optionally separated by one or more
separation characters: /, ., -, blank, and so on.
Example
Assume the date being formatted is August 23, 2000.
Mask Specified
Result
DD/MM/YY
23/08/00
YYYY.MM.DD
2000.08.23
MM-DD-YYYY
08-23-2000
DD MMM YYYY
23 Aug 2000
MMM DD YYYY Aug 23 2000
YY/MM
00/08

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-65

CTTRPT Database Extraction and Report Utility

Table 7-33

Parameter

CTTRPT Report Formatting Parameters (Part 5 of 7)

Description
Boolean Format
For Boolean fields (meaning, fields that contain a True or
False, or Yes or No condition). The specified FIELD is
checked for a true or false condition in the record.
The mask can contain either one value or two values
separated by a slash (/). A null value can be specified on
either side of the slash.
When one mask value is specified, the value is printed in the
report only if the FIELD checks true in the record. (If the
FIELD checks false, the mask value is not printed; blanks
are printed instead.)
When two values are specified, the first value is printed in the
report if the FIELD checks true in the record. The second
value is printed if the field checks false.
Examples
(1) ATTR FIELD=SCRATCH,
TITLE=Scratch,EDIT=Yes or No
(2) ATTR FIELD=ACTIVE,
TITLE=Type,EDIT=Active or Scratch
(3)ATTR FIELD=VAULTED, TITLE=V,EDIT=v
(4) ATTR FIELD=EDM, TITLE=Edm,EDIT=/No
The following table shows the results of Boolean editing for
these examples.

Example

Field Tested

(1)

SCRATCH

(2)

ACTIVE

(3)

VAULTED

(4)

EDM

BMC Software, Inc., Confidential and Proprietary Information

7-66

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Table 7-33

CTTRPT Report Formatting Parameters (Part 6 of 7)

Parameter

Description

BREAK

Attributes of the summary line printed at the bottom of the

page when a field break occurs. Optional.
For each field break, the user can specify a header and
variables that indicate the number of primary and secondary
lines printed and the value of the field before the break
occurred.
At least one optional parameter of the BREAK statement
must be specified.
A BREAK statement can be specified for any field, even a
field that is not included in a SORTBY statement. The report,
however, is not effected by a BREAK for a field until the field
is included in a SORTBY statement with option /BRK and
SUMMARY=YES has been specified in the REPORT
statement.
This means that a BREAK statement can be defined in
advance for each field when the field appears in a SORTBY
statement and report summaries are included.
FIELD name Name of the field. Mandatory.
COLUMNColumn of the output line in which the
summary title begins printing. column must be numeric.
Optional. The default is the report start margin specified
in parameter MARGINS of the REPORT statement.
SUMTITLE= textSummary text to be printed when the
value of a field changes. text can be any string of
characters. It must be enclosed in apostrophes and can
contain one or more of the following variables:
%FIELDValue of the field before the break occurred.
%COUNTPNumber of primary lines printed before the
break occurred.
%COUNTNumber of secondary lines printed before the
break occurred.
The default value of SUMTITLE text is:
TOTAL IN %FIELD IS %COUNT
Note: If parameter ID is not specified in the FIELDS
statement or there is only one FIELDS statement, the value of
%COUNT is equal to the value of %COUNTP.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-67

CTTRPT Database Extraction and Report Utility

Table 7-33

CTTRPT Report Formatting Parameters (Part 7 of 7)

Parameter

Description
EDIT=numeric mask Numeric format of %COUNT and
%COUNTP variables. Optional. The default is ZZ,ZZ9. For
more information, see the Numeric format example for the
EDIT parameter of the ATTR statement, described in this
table.
Example
REPORT NAME=DISTRIB,SUMMARY=YES
FIELDS ...
SORTBY
TOLOC/BRK/RSR/RSP,
FROMLOC/BRK (or /B)
TOSLOT,FROMSLOT,
VOLSER
BREAK
FIELD=TOLOC,
SUMTITLE=Total Volumes Moved To %FIELD is
%COUNT, EDIT=Z,ZZ9
BREAK
FIELD=FROMLOC,
SUMTITLE=Total Volumes Moved From %FIELD is
%COUNT, EDIT=Z,ZZ9
ATTR ...

Special Fields
The following table contains a list of derived fields that can be included in
the GENERAL report. These fields do not exist in the Media Database
records, but their values are derived from either volume or dataset records, as
indicated, where:
V indicates the source is a volume record.
D indicates the source is a dataset record.
ROWID is a calculated field and therefore no source is indicated.
These fields cannot be subparameters of INCLUDE / EXCLUDE statements.
Table 7-34

CTTRPT Fields (Part 1 of 2)

Field Name

Source

Type

Default Size
in Bytes

DSEXPDTA

Character

36

Complete dataset expiration

information.

DSPOOL

Character

15

Pool name derived from the volser of

the dataset record.

Description

BMC Software, Inc., Confidential and Proprietary Information

7-68

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Table 7-34

CTTRPT Fields (Part 2 of 2)

Field Name

Source

Type

Default Size
in Bytes

DSSTAT

Character

12

Dataset statuses as shown below the

header STATUS in Screen TI. For
more information, see the description
of Screen TI in the online facilities
chapter of the CONTROL-M/Tape
User Guide.

DSTATX

Hexadecimal

Dataset statuses in Hexadecimal

representation.

POOL

Character

15

Pool name derived from the volser of

the volume record.

Numeric

Row (line) number. Can be specified

for either Primary or Secondary lines
but not for both.

ROWID

Description

VOLSTAT

Character

12

Volume statuses as shown below the

header STATUS in Screen TI. For
more information, see the description
of Screen TI in the online facilities
chapter of the CONTROL-M/Tape
User Guide.

VSTATX

Hexadecimal

Volume statuses in Hexadecimal

representation.

Return Codes
Table 7-35

CTTRPT Return Codes (Part 1 of 2)

Code

Description

Operation performed successfully.

Missing DD statements or open error occurred.

12

Control card error.

16

Operation code not found.

20

Invalid operation code.

24

Syntax error in FIELDS or SORTBY statement.

28

Field name specified in FIELDS or SORTBY list is undefined.

32

Same parameter specified more than once.

36

Field name exceeds maximum length.

40

Invalid relation specified (must always be an equal sign).

44

Report NAME is undefined.

48

BRK not specified for the preceding field in the SORTBY list.

52

FIELDS statement not specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-69

CTTRPT Database Extraction and Report Utility

Table 7-35

CTTRPT Return Codes (Part 2 of 2)

Code

Description

56

Total of all field lengths requested in the FIELDS statement

exceeds the line size.

60

Continuation card expected but not received.

64

Invalid numeric value.

68

Option in the FIELDS or SORTBY statement already specified.

72

ROWID specified in the BREAK or SORTBY statement.

76

EDIT parameter in the ATTR statement is invalid for specified

FIELDS.

80

EDIT mask is not valid.

84

Specified number not in permitted range.

For example, end column of a MARGIN statement exceeds the
LINESIZE or a column in a FIELDS statement is outside the
reports margins.

88

Column option (/C) not specified in the preceding field.

92

Specified column in a FIELDS statement is less than the sum of

the previous fields column and length.

96

Second EXTRACT statement did not come after report

statements.

100

Load of CONTROL-M/Tape programs failed.

104

Load of POOL table failed.

108

Insufficient memory.

116

Loading CONTROL-M/Tape environment failed.

200

Fields in the FIELDS or SORTBY statements do not fit the PATH

parameter of the EXTRACT statement.

Sample Reports
The reports listed below can be created using utility CTTRPT. These reports
are located in the IOA SAMPLE library.
Some of these sample reports contain question marks (??) where
customization is necessary. Replace the question marks with the desired
values and use the appropriate job to produce the report.

BMC Software, Inc., Confidential and Proprietary Information

7-70

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Reports
Table 7-36

CTTRPT Sample Reports (Part 1 of 2)

Report

Description

CTTRFSCR

Full-scratch report. Lists all volumes with SCRATCH status in the

Media Database.

CTTRINV

Vault inventory report. Lists all vaulted volumes and datasets in a

specified location.

CTTRINVT

Comprehensive inventory report. Lists all volumes and datasets

in the Media Database.

CTTRSCRD

Lists all volumes scratched on a specified date and the datasets

residing on these volumes.

CTTRDELV

Lists all volumes with DELETED status.

CTTRCLN

Clean report. Lists volumes that need to be cleaned (meaning,

each volume that has more than a specified threshold number of
permanent I/O errors).

CTTRRTNP

Lists all datasets (and their volumes) according to expiration date

type (for example, CYCLE or CATALOG).

CTTRLACV

Lists all volumes accessed today.

CTTRDCRE

Lists all datasets created yesterday.

CTTRMOVW

Lists all volumes moved within the last seven days.

CTTRCHKI

Lists all external volumes checked-in during the last 30 days).

CTTRUTIL

Lists volumes that are under-utilized (less than less than 10

megabytes).

CTTRLAVJ

Lists all volumes that were last accessed by a certain job since a
specified date.

CTTRWDCP

Lists all datasets that were written in a certain system (CPU)

since a specified date.

CTTROUTL

Lists all volumes in an out-location (borrower volumes).

CTTRLRTV

Lists all volumes with high retention dates (for example, after
year 2001).

CTTRM10V

Lists all multi-volume datasets that span more than ten volumes.

CTTRMACV

Lists the most active volumes (accessed more than ten times
since they became active).

CTTREDM

Lists all EDM volumes.

CTTRRCLV

Lists all RECALLed volumes.

CTTRVUPD

Lists all volumes that were manually updated by a specified user.

CTTRDUPD

Lists all datasets that were manually updated by a specified user.

CTTRM25D

Lists all volumes containing more than 25 active datasets.

CTTRVBOX

Lists the volumes stored in a specified box.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-71

CTTRPT Database Extraction and Report Utility

Table 7-36

CTTRPT Sample Reports (Part 2 of 2)

Report

Description

CTTRBXLC

Lists all volumes that are stored in boxes, according to location

and BOXID.

CTTRNRTR

Lists all borrowed volumes that have not yet been returned.

Jobs for Report Production

The above reports are produced using the following jobs (that are located in
the JCL library):
Table 7-37

CTTRPT Jobs

Job

Description

REPFSCR

Produces report CTTRFSCR (full-scratch report).

REPINV

Produces report CTTRINV (comprehensive inventory report).

REPSJOB

Produces all other reports. This job requires customizations to

indicate the desired report.

Example 1

Extract all datasets from location VAULT1 and generate a report showing all
VAULT1 datasets and their volumes sorted by their pool name (DSPOOL)
that is derived from dataset volser.

BMC Software, Inc., Confidential and Proprietary Information

7-72

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Figure 7-7

CTTRPT Example 1

//EXTRACT EXEC CTTRPT

//SYSIN
DD *
EXTRACT PATH=DATASET/ALLVOLS
INCLUDE LOCATION=VAULT1
REPORT NAME=GENERAL,SUMMARY=YES,MARGINS=1-080,LINESIZE=080,
TITLE=Datasets in Vault VAULT1
FIELDS ROWID,FIRSTVOL,
DSNAME,DSLABEL,CREJBN,CREDT,LRECL,RECFM,
ID=P
FIELDS VOLSER/C13,MOVEDATE,VOLSEQ,SLOTNUM,
ID=S
SORTBY DSPOOL/BRK/RSP,FIRSTVOL,DSLABEL,VOLSEQ,SLOTNUM
BREAK FIELD=DSPOOL,COLUMN=10,EDIT=Z,ZZ9,
SUMTITLE=%FIELD Datasets in VAULT1: %COUNTP
ATTR FIELD=ROWID,TITLE=Row/Id,EDIT=ZZ,ZZ9
ATTR FIELD=FIRSTVOL,TITLE=First/Volume
ATTR FIELD=DSNAME,TITLE=/Dataset Name,LENGTH=24
ATTR FIELD=DSLABEL,TITLE=Ds/Seq.,EDIT=ZZ9
ATTR FIELD=CREJBN,TITLE=Create/Job
ATTR FIELD=CREDT,TITLE=Create/Date,EDIT=DD MMM YY
ATTR FIELD=LRECL,TITLE=Record/Length,EDIT=ZZ,ZZ9
ATTR FIELD=RECFM,TITLE=Record/Format
ATTR FIELD=DSPOOL,TITLE=Pool/Name
ATTR FIELD=VOLSER,TITLE=/Volser
ATTR FIELD=MOVEDATE,TITLE=Move/Date,EDIT=DD MMM YYYY
ATTR FIELD=VOLSEQ,TITLE=Vol/Seq.,EDIT=Z9
ATTR FIELD=SLOTNUM,TITLE=Slot/No.,EDIT=Z,ZZ9

A sample of the output report from the above example is illustrated below:

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-73

CTTRPT Database Extraction and Report Utility

Figure 7-8

CTTRPT Sample Report 1

BMC SOFTWARE,INC.

CONTROL-M/TAPE REPORT

(VER 6.1.00)

Datasets in Vault VAULT1

------------------------Pool Name:
Row
Id

POOL-NUMBER-1

First
Volume Dataset Name

Ds
Create
Create
Record Record
Seq. Job
Date
Length Format
Move
Vol
Slot
Volser
Date
Seq.
No.
------ ------------------------------------- ------------------ ------ -----58 016475 FDRABR.VTSO006.C1004900
27 ZCOBKUPD 13 Jun 00
0 U
012517
23 Jun 2000
55
74
015692
23 Jun 2000
56
163
015646
23 Jun 2000
57
162
016024
23 Jun 2000
58
177
59 016475 FDRABR.VESAD1A.C1002800
016024
23 Jun 2000
015722
23 Jun 2000
016048
23 Jun 2000
012771
23 Jun 2000

28 ZCOBKUPD 13 Jun 00
58
59
60
61

60 016475 FDRABR.VVSAM00.C1001300
012771
23 Jun 2000
010096
23 Jun 2000
018862
23 Jun 2000
018839
23 Jun 2000
012914
23 Jun 2000
016314
23 Jun 2000
016296
23 Jun 2000
016211
23 Jun 2000
61 016475 FDRABR.VSCLM02.C1003500
016211
23 Jun 2000
016201
23 Jun 2000
016127
23 Jun 2000
016337
23 Jun 2000
016322
23 Jun 2000
015072
23 Jun 2000
62 016475 FDRABR.VVSAM12.C1006800
015072
23 Jun 2000
015062
23 Jun 2000
011488
23 Jun 2000
011035
23 Jun 2000
010970
23 Jun 2000
010967
23 Jun 2000
63 017244 CA.BKUPMSTR.G0502V00
017244
23 Jun 2000
013076
23 Jun 2000
018149
23 Jun 2000
015278
23 Jun 2000
019308
23 Jun 2000
013099
23 Jun 2000
64 018042 TS63.CATALOG.VWGL507.BAC
018042
23 Jun 2000
018137
23 Jun 2000
013684
23 Jun 2000
011951
23 Jun 2000
011932
23 Jun 2000

29 ZCOBKUPD 13
61
62
63
64
65
66
67
68
30 ZCOBKUPD 13
68
69
70
71
72
73
31 ZCOBKUPD 13
73
74
75
76
77
78
1 CALDPBK 12
1
2
3
4
5
6
1 ZTSVSMB4 13
1
2
3
4
5

Jun 00

Jun 00

Jun 00

Jun 00

Jun 00

0 U
177
167
178
90
0
90
16
223
222
96
190
187
184
0
184
183
181
193
192
148
0
148
147
44
31
29
28
8,287
113
110
114
112
115
111
32,756
9
10
7
5
61

VB

VBS

BMC Software, Inc., Confidential and Proprietary Information

7-74

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

BMC SOFTWARE,

INC.

CONTROL-M/TAPE REPORT

(VER 6.1.00)

Datasets in Vault VAULT1

------------------------Pool Name:
Row
Id

POOL-NUMBER-1

First
Volume Dataset Name

Ds
Create
Create
Record Record
Seq. Job
Date
Length Format
Move
Vol
Slot
Volser
Date
Seq.
No.
------ ------------------------------------- ------------------ ------ -----64 018042 TS63.CATALOG.VWGL507.BAC
1 ZTSVSMB4 13 Jun 00 32,756 VBS
011257
23 Jun 2000
6
40
010885
23 Jun 2000
7
25
010870
23 Jun 2000
8
24
017991
23 Jun 2000
9
209
017509
23 Jun 2000
10
203
014339
23 Jun 2000
11
136
015050
23 Jun 2000
12
145
015097
23 Jun 2000
13
149
65 018228 TS63.CATALOG.VMVSCAT.BAC
018228
23 Jun 2000

1 ZTSVSMB1 13 Jun 00 32,756 VBS

1
11

66 018288 TS63.CATALOG.VWGL83A.BAC
018288
23 Jun 2000
018280
23 Jun 2000

1 ZTSVSMBA 13 Jun 00 32,756 VBS

1
13
2
12

67 018358 TS63.CATALOG.VWGL514.BAC
018358
23 Jun 2000

1 ZTSVSMB3 13 Jun 00 32,756 VBS

1
14

POOL-NUMBER-1 Datasets in VAULT1:

67

Example 2

Extract all volumes located in VAULT1 that were created by job ZCOIBKUP
during June 2000.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-75

CTTRPT Database Extraction and Report Utility

Figure 7-9

CTTRPT Example 2

//EXTRACT EXEC CTTRPT

//SYSIN DD *
EXTRACT PATH=VOLUME/ALLDS
INCLUDE LOCATION=VAULT1,CREJBN=ZCOIBKUP
EXCLUDE CREDT<20000601
EXCLUDE CREDT>20000630
REPORT NAME=GENERAL,SUMMARY=YES,MARGINS=1-80,LINESIZE=80,
TITLE=Inventory Report
FIELDS ROWID,VOLSER,VOLSTAT,MOVEDATE,VOLSEQ,SLOTNUM,VOLEXPDT,
ID=P
FIELDS DSNAME/C13,DSLABEL,CREJBN,CREDT,BLOCKCT,DSEXPDT,
ID=S
SORTBY ACTIVE/BRK/RSP,POOL/BRK/RSP,
LOCATION/BRK/RSR,VOLSER,DSLABEL
BREAK FIELD=LOCATION,EDIT=ZZ9,
SUMTITLE=Total number of volumes in %FIELD: %COUNTP
BREAK FIELD=ACTIVE,EDIT=ZZ,ZZ9,
SUMTITLE=Number of %FIELD Volumes: %COUNTP
BREAK FIELD=POOL,EDIT=ZZ9,
SUMTITLE=Total number of volumes in %FIELD: %COUNTP(%COUNT)
ATTR FIELD=ROWID,TITLE=Row/Id,EDIT=ZZ,ZZ9
ATTR FIELD=VOLSER,TITLE=/Volser
ATTR FIELD=VOLSTAT,TITLE=Volume/Status
ATTR FIELD=MOVEDATE,TITLE=Move/Date,EDIT=DD MMM YYYY
ATTR FIELD=VOLSEQ,TITLE=Vol/Seq.,EDIT=Z9
ATTR FIELD=SLOTNUM,TITLE=Slot/No.,EDIT=Z,ZZ9
ATTR FIELD=VOLEXPDT,TITLE=Volume/Expiration,EDIT=DD MMM YYYY
ATTR FIELD=DSNAME,TITLE=/Dataset Name,LENGTH=24
ATTR FIELD=DSLABEL,TITLE=Ds/Seq.,EDIT=ZZ9
ATTR FIELD=CREJBN,TITLE=Create/Job
ATTR FIELD=CREDT,TITLE=Create/Date,EDIT=DD MMM YY
ATTR FIELD=BLOCKCT,TITLE=Block/Count,EDIT=ZZ,ZZ9
ATTR FIELD=DSEXPDT,TITLE=Dataset/Expiration,EDIT=YYYY-MMM-DD
ATTR FIELD=ACTIVE,TITLE=Type,EDIT=ACTIVE/SCRATCH
ATTR FIELD=LOCATION,TITLE=Location
ATTR FIELD=POOL,TITLE=Pool/Name
/*

The following is a sample output produced by the above example. Note the
following about the output:
1. The page number, date and time are not printed unless the LINESIZE
specified in the REPORT statement is at least 127.
2. During printing, if there is insufficient room on the current page for
secondary lines, the primary line is reprinted as part of the page header
on the next page.
3. A field specified with option /BRK in a SORTBY statement is shown in
the page header following the report title and any slashes (/) specified in
the TITLE definition are suppressed to blanks.

BMC Software, Inc., Confidential and Proprietary Information

7-76

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRPT Database Extraction and Report Utility

Figure 7-10
BMC SOFTWARE,

Type:

ACTIVE

Row
Id

Volser

CTTRPT Sample Report 2

INC.

CONTROL-M/TAPE REPORT

(VER 6.1.00)

Inventory Report
---------------Pool Name: POOL-NUMBER-1

Location:

Volume
Status

VAULT1

Move
Date

Vol
Slot
Volume
Seq.
No.
Expiration
Ds
Create
Create
Block
Dataset
Dataset Name
Seq.
Job
Date
Count
Expiration
---------------------------- ----------------------------------------------1
010222
Vaulted
Jun 20-2000
2
427
21 Jun 2000
FDRABR.VPROD02.C1005204
6 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
FDRABR.VPROD01.C1008804
5 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
FDRABR.VSAS001.C1006504
4 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
FDRABR.VTSO006.C1004804
3 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
FDRABR.VTSO003.C1015904
2 ZCOIBKUP 14 Jun 00
999 2000-Jun-21
2

010372
Vaulted
FDRABR.VTSO003.C1015904
FDRABR.VTSO002.C1015904

Jun 20-2000
2 ZCOIBKUP
1 ZCOIBKUP

1
433
14 Jun 00
14 Jun 00

21 Jun 2000
999 2000-Jun-21
999 2000-Jun-21

011938
Vaulted
FDRABR.VWGLE00.C1035504
FDRABR.VWGLE1C.C1027404
FDRABR.VMVS89C.C1005304
FDRABR.VMVS89D.C1005304
FDRABR.VMVSR1A.C1028204
FDRABR.VWGL800.C1006704

Jun 20-2000
17 ZCOIBKUP
16 ZCOIBKUP
15 ZCOIBKUP
14 ZCOIBKUP
13 ZCOIBKUP
12 ZCOIBKUP

14
14 Jun
14 Jun
14 Jun
14 Jun
14 Jun
14 Jun

487
00
00
00
00
00
00

21 Jun 2000
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21

011954
Vaulted
FDRABR.VWGL514.C1041704
FDRABR.VWGLE13.C1031304
FDRABR.VMVSRES.C1018704
FDRABR.VWGLE00.C1035504

Jun 20-2000
20 ZCOIBKUP
19 ZCOIBKUP
18 ZCOIBKUP
17 ZCOIBKUP

15
14 Jun
14 Jun
14 Jun
14 Jun

492
00
00
00
00

21 Jun 2000
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21

012016
Vaulted
FDRABR.VWGL800.C1006704
FDRABR.VSCLM03.C1001304

Jun 20-2000
12 ZCOIBKUP
11 ZCOIBKUP

13
506
14 Jun 00
14 Jun 00

21 Jun 2000
0 2000-Jun-21
0 2000-Jun-21

012191
Vaulted
FDRABR.VPROD04.C1016204
FDRABR.VPROD02.C1005204

Jun 20-2000
7 ZCOIBKUP
6 ZCOIBKUP

3
529
14 Jun 00
14 Jun 00

21 Jun 2000
0 2000-Jun-21
0 2000-Jun-21

012271
Vaulted
FDRABR.VSCLM03.C1001304

Jun 20-2000
11 ZCOIBKUP

9
539
14 Jun 00

21 Jun 2000
0 2000-Jun-21

012313
Vaulted
FDRABR.VSCLM03.C1001304

Jun 20-2000
11 ZCOIBKUP

12
544
14 Jun 00

21 Jun 2000
0 2000-Jun-21

013315
Vaulted
FDRABR.VPROD06.C1016204
FDRABR.VPROD05.C1015904
FDRABR.VPROD04.C1016204

Jun 20-2000
9 ZCOIBKUP
8 ZCOIBKUP
7 ZCOIBKUP

4
551
14 Jun 00
14 Jun 00
14 Jun 00

21 Jun 2000
0 2000-Jun-21
0 2000-Jun-21
0 2000-Jun-21

10

014347
Vaulted
FDRABR.VSCLM03.C1001304

Jun 20-2000
11 ZCOIBKUP

11
568
14 Jun 00

21 Jun 2000
0 2000-Jun-21

11

014743
Vaulted
FDRABR.VSCLM03.C1001304

Jun 20-2000
11 ZCOIBKUP

10
572
14 Jun 00

21 Jun 2000
0 2000-Jun-21

12

016465
Vaulted
FDRABR.VSCLM01.C1008904

Jun 20-2000
10 ZCOIBKUP

5
583
14 Jun 00

21 Jun 2000
0 2000-Jun-21

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-77

CTTRPT Database Extraction and Report Utility

Type:

ACTIVE

Row
Id

Volser

Inventory Report
---------------Pool Name: POOL-NUMBER-1
Volume
Status

Location:

VAULT1

Move
Date

Vol
Slot
Volume
Seq.
No.
Expiration
Ds
Create
Create
Block
Dataset
DataSet Name
Seq. Job
Date
Count
Expiration
---------------------------- ----------------------------------------------12
016465
Vaulted
Jun 20-2000
5
583
21 Jun 2000
FDRABR.VPROD06.C1016204
9 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
13
017248
Vaulted
Jun 20-2000
6
587
21 Jun 2000
FDRABR.VSCLM01.C1008904
10 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
14
018377
Vaulted
Jun 20-2000
8
596
21 Jun 2000
FDRABR.VSCLM03.C1001304
11 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
FDRABR.VSCLM01.C1008904
10 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
15
018393
Vaulted
Jun 20-2000
7
596
21 Jun 2000
FDRABR.VSCLM01.C1008904
10 ZCOIBKUP 14 Jun 00
0 2000-Jun-21
Total number of volumes in VAULT1 :
POOL-NUMBER-1 Volumes:
Number of ACTIVE

73 ,

Volumes:

15

POOL-NUMBER-1 Datasets:

581

221

BMC Software, Inc., Confidential and Proprietary Information

7-78

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRSM Recover Tape Activity From SMF Records

CTTRSM Recover Tape Activity From SMF

Records
Utility CTTRSM recovers tape activity not recorded in the Media Database
from data in SMF records. This utility can be used to extract information
about tape activity performed when CONTROL-M/Tape was not active.
Before running utility CTTRSM, SMF records must be accumulated and
loaded into one or more sequential files using appropriate MVS utilities (for
example, IFASMFDP). Specify the sequential files containing the SMF
records in DD statement DASMFIN of utility CTTRSM. The SMF records in
the sequential file must be only type 14 and type 15 SMF records.

Activating the Utility

//EXEC
CTTRSM
//DASMFIN DD DISP=SHR,DSN=SMF-file-#1
//
DD DISP=SHR,DSN=SMF-file-#2
...
//SYSIN DD *
TYPERUN MODE=NORMAL|SIMULATION[,DYNVOL=Y|N][,
DYNDS=Y|N][,ACCTYPE=CREATE|UPDATE|ALL][,
SYNCHLVL=MATCH|FORCE][,X98000=SKIP|UPDATE]
<INCLUDE/EXCLUDE statements>
REPORT NAME=SMFRCV
FIELDS ...
[SORTBY ...]
[ATTR ...]
[BREAK ...]
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-79

CTTRSM Recover Tape Activity From SMF Records

Parameters
Table 7-38

CTTRSM Parameters (Part 1 of 4)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Mode in which the utility runs. Mandatory. Valid
values:
NORMAL SMF records are read and the Media
Database is updated according to the tape activity
recorded in the SMF records. Default.
The utility produces a report that lists the tape activity
extracted from SMF records.
SIMULATION SMF records are read but the Media
Database is not updated. The utility produces a report of
tape activity from SMF records without updating the
Media Database.
DYNVOL Instructions for handling volumes that were
accessed but do not exist in the Media Database. Optional.
Y (Yes) Create a volume record for each of these
volumes automatically. This value is not valid if
DYNDS is set to N (described below). Default.
E (External) Create a volume record that describes the
volume as an external tape. This value is not valid if
DYNDS is set to N (described below).
N (No) Do not create a volume record for the volume.
Information about datasets on the volume and the volume
chain to which it belongs is not recorded in the
CONTROL-M/Tape Media Database.
DYNDS Instructions for handling datasets that were
accessed for Read or Update but are not defined in the
Media Database. This parameter is ignored if CREATE is
specified for parameter ACCTYPE (described below).
Optional.
Y (Yes) Create a Dataset record for each of these
datasets and insert the appropriate information. Default.
N (No) Do not create Dataset records for these
datasets
(meaning, do not record tape activity for these datasets).
ACCTYPE Types of tape activity to be processed during
this run of the utility. Optional.
CREATE Process only SMF records that describe
creation of new datasets.
UPDATE Process only SMF records that describe an
update of a tape dataset (including creation of new
datasets).
ALL Process all SMF records of tape activity that were
stored in the sequential files specified as input to the
utility. Default.

BMC Software, Inc., Confidential and Proprietary Information

7-80

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRSM Recover Tape Activity From SMF Records

Table 7-38

Parameter

CTTRSM Parameters (Part 2 of 4)

Description
SYNCHLVL Instructions for handling conflicts (for
example, when an SMF record indicates creation of a
dataset that overwrites an existing dataset) between the
Media Database and the SMF records. Optional.
MATCH If a conflict occurs, the conflict is described in
the utility report. The Media Database is not updated with
the conflicting information. Default.
FORCE If a conflict occurs, the Media Database is
modified to reflect the changes described in the SMF
record.
X98000 Instructions for handling datasets for which
LABEL=EXPDT=98000 was specified. Optional.
SKIP Do not process datasets specified with
LABEL=EXPDT=98000. Default.
UPDATE Process all datasets regardless of their
EXPDT specification.

INCLUDE /
EXCLUDE

Utility CTTRSM reads SMF records that describe tape

access. The SMF records are in sequential files referenced
by DD statement DASMFIN. These records can be filtered by
one or more INCLUDE / EXCLUDE statements.
The INCLUDE / EXCLUDE statements can reference the
following fields:
BLOCKCT
BLKSIZE
CPUID
CREDT
DDNAME
DENSITY
DSEXCP
DSLABEL
DSNAME
DSOPNTIM
DSVOLSER
JCLEXPDT
JOBNAME
JSTRTDAT
JSTRTTIM
LBLTYP
LRECL
RECFM
TRTCH
UNITADR
USERID
VOLSER
For more detailed information on these fields, see the
INCONTROL for OS/390 and z/OS Administrator Guide.

For more information about INCLUDE / EXCLUDE statements, see Record

Selection Logic (INCLUDE / EXCLUDE Statements) on page 7-6. Optional.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-81

CTTRSM Recover Tape Activity From SMF Records

Table 7-38

CTTRSM Parameters (Part 3 of 4)

Parameter

Description

REPORT

Indicates the report to be created by the utility. Mandatory.

The following parameter must be specified:
NAME = SMFRCV
An SMF recovery report is produced by the utility, listing all
datasets whose access (or creation) is described in the SMF
records processed by the utility. The fields in this report are
determined by the FIELDS statement (described below).

FIELDS

Indicates which fields to include in the report that the utility

creates. You can include the following fields:
ACCTYPE
BLOCKCT
BLKSIZE
CPUID
CREDT
DDNAME
DENSITY
DSEXCP
DSLABEL
DSNAME
DSOPNTIM
DSVOLSER
JCLEXPDT
JOBNAME
JSTRTDAT
JSTRTTIM
LBLTYP
LRECL
RECFM
TRTCH
UNITADR
USERID
VOLSER
For more detailed information on these fields, see the
INCONTROL for OS/390 and z/OS Administrator Guide.
In addition to the fields above, you can include the following
special field:
STATUSIndicates the action performed on the dataset
record by utility CTTRSM. This field is empty if the dataset
was processed successfully. Otherwise, this field contains a
rejection reason that explains why the dataset was not
processed.

SORTBY

Order in which the report is sorted. Optional. Valid sort fields

are all dataset record and volume record fields, described in
the appendix that discusses logical field names for the
CONTROL-M/Tape Repository in the INCONTROL for
OS/390 and z/OS Administrator Guide.

ATTR

Override of default attributes defined for a field in the report.

Optional.

BMC Software, Inc., Confidential and Proprietary Information

7-82

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRSM Recover Tape Activity From SMF Records

Table 7-38

CTTRSM Parameters (Part 4 of 4)

Parameter

Description

BREAK

Attributes of the summary header lines printed when a field

break occurs. Optional.

Note: For a description of the parameters for these statements, see the FIELDS,
SORTBY, ATTR and BREAK statements in CTTRPT Database Extraction and
Report Utility on page 7-58.

Example
The following example recovers all tape datasets accessed by jobs with
names prefixed by ABC. Volumes and datasets that are not defined in the
Media Database are automatically defined. Conflicts with the Media
Database are reported as errors.
//EXEC
CTTRSM
//DASMFIN DD DISP=SHR,DSN=N00.ACCUM.SMFRECS
//SYSIN
DD *
TYPERUN MODE=SIMULATION,DYNDS=Y,DYNVOL=Y
INCLUDE CREJBN=ABC*
REPORT
NAME=SMFRCV
FIELDS
DSNAME,DSVOLSER,DSLABEL,STATUS

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-83

CTTRTM Perform Retention Management

CTTRTM Perform Retention Management

This utility performs batch retention management functions. Perform batch
retention management daily to check expiration criteria and determine which
datasets are marked scratch. When all the datasets on a volume have expired,
the volume becomes a scratch volume. Run the utility as part of the
CONTROL-M/Tape New Day procedure (CTTDAY).
Utility CTTRTM supports a number of different types of retention. For a list
of the supported retention types, see the discussion about retention
management in the organization and administration chapter in the
CONTROL-M/Tape User Guide.
Utility CTTRTM does not perform retention management for the following
volumes:

Vaulted volumes.
Volumes with a status of Pend-Vault.
Volumes that have been recalled from a vault.
Volumes with a status of Act-Use.
Deleted volumes.
EDM controlled volumes.
Volumes not in the currently active library (meaning, volumes with a
status of Act-Out).

Note:

Retention information for these volumes is updated by utility

CTTRTM if either CONVERT or RECALC is specified for
parameter TYPERET (described later). However, these volumes (and
the datasets they contain) are not expired by the utility (meaning,
they are not marked as scratched).
Utility CTTRTM requires exclusive access to the Media Database.
Jobs can access tapes during the run of this utility. However, other
utilities that access the Media Database (for example, CTTIDB or
CTTVTM) are not allowed to run concurrently with this utility.

BMC Software, Inc., Confidential and Proprietary Information

7-84

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

Scratch Report
Utility CTTRTM can produce a Scratch report at the end of processing. The
Scratch report contains a list of all volumes that have expired (become
scratch) as a result of this utility run.
Note:

Full Scratch report FULLSCR is no longer generated by utility

CTTRTM. Instead, this report can be generated as part of the
GENERAL report by utility CTTRPT. For more information, see
CTTRPT Database Extraction and Report Utility on page 7-58.

Utility CTTRTM adds the following special pool names in the POOLNAME
field of certain volume records in the Scratch report:
Table 7-39

CTTRTM Pool Names

Pool

Description

EXTERNAL

External volumes not deleted from the Media Database.

EXT-DEL

External volumes deleted from the Media Database.

EXT-DUP

External volumes that are not deleted from the Media Database
but whose SL-NAME and VOLSER are different.

DUPLICATE
VOL

Internal volumes whose SL-NAME and VOLSER are different.

The special pool name is written over the previous name in field
POOLNAME (if one existed).
Using utility CTTTPI, re-initialize scratched volumes with different
SL-NAMEs and VOLSERs. Set the SL-NAME to the value of the VOLSER
as listed in the EXT-DUP and DUPLICATE VOL pools.
Use parameters MAXDSNO and MAXVOLNO of utility CTTRTM to
indicate a maximum number of datasets and/or volumes that can be scratched
during a run of the utility. Before scratch is performed, the utility checks if
the maximum specified (using one of these parameters) was exceeded.
If a specified maximum is exceeded, no changes are made to any datasets or
volumes. An error message is issued and a scratch report is produced
describing all potential scratches were the maximum not specified.

RECALC Report
If utility CTTRTM is used to recalculate retention periods (meaning, the
MODE parameter is set to RECALC in the TYPERET statement) a
RECALC report can optionally be generated.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-85

CTTRTM Perform Retention Management

The RECALC report contains information about datasets whose expiration

dates were changed as a result of the run of the utility.
The information provided about each dataset depends on the field names
specified in the FIELDS control statement for the RECALC report. Special
field names can be used to indicate the various retention types that were
specified for a dataset and the AND/OR relationship between them. For more
information, see Table 7-42, CTTRTM Parameters, on page 90.

Recovery From Abends

Since utility CTTRTM updates the Media Database in several stages, a

CANCEL operation, job abend or system crash can lead to logical
inconsistencies in the database.
CONTROL-M/Tape can recover from abends occurring during the run of
utility CTTRTM. The type of recovery depends on the stage of the utility in
which the abend occurred. Utility CTTRTM performs retention management
in the following stages:
1. A physical file is produced that contains the information necessary for
updating the relevant records in the Media Database.
2. The Media Database records are updated.
3. A Scratch report is produced.
If an abend occurred during Step 1, no updates were performed on the Media
Database and the utility can be rerun normally.
If an abend occurred while the Media Database was being updated (Step 2)
the next time utility CTTRTM is run it automatically enters RESTART mode
and continue updating the Media Database from where the previous run
terminated. (The utility uses the physical file created in Step 1 and a
timestamp that indicates where the previous run of utility CTTRTM was
interrupted.)
If an abend occurred after all updates of the Media Database were performed
but the Scratch report was not produced, this report can be generated by
rerunning the utility with the following parameters:
TYPERUN
REPORT
FIELDS
SORTBY

MODE=NORMAL
NAME=SCRATCH
fields
fields

BMC Software, Inc., Confidential and Proprietary Information

7-86

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

where fields are the same fields that were specified in the FIELDS and
SORTBY statements in the original run of utility CTTRTM.
Note:

Do not specify a value for parameter TYPERET in this run of utility

CTTRTM.

Exits Used by Utility CTTRTM

The following exits can be used to influence a run of utility CTTRTM:
Table 7-40

CTTRTM Exits

Exit

Description

CTTX006

Receives control immediately before updates are made to

dataset or volume records in the Media Database. This exit
can be used to accept or reject expiration of a dataset record
and/or to update a dataset or volume record before it is
marked as scratched.

CTTX008

Receives control when the Scratch report is used to update

the information in the automated tape library (if one exists at
your site). This exit can be used to scan the scratch report
and to determine which volume records are updated in the
automated tape library database.

Relevant Installation Parameters

Installation parameters, specified in the CTTPARM member, determine how
utility CTTRTM operates. The following table describes these parameters:
Table 7-41

CTTRTM Installation Parameters (Part 1 of 3)

Parameter

Description

CTLGWAIT

Defines the number of wait days before utility CTTRTM

checks a catalog-controlled dataset (meaning, one for that
the DO RETENTION parameter is set to MVS CATALOG). In
some cases, a dataset is created during a job step and
cataloged at the end of a later job step. If utility CTTRTM is
executed after the dataset is created but before it is
cataloged, the utility expires the dataset. Parameter
CTLGWAIT causes utility CTTRTM to wait a specified
number of days before checking if the dataset is cataloged.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-87

CTTRTM Perform Retention Management

Table 7-41

CTTRTM Installation Parameters (Part 2 of 3)

Parameter

Description

CYCLECNT

Defines how to calculate cyclic datasets. Valid values:

DATE Handles datasets with the same dataset name
and creation date as a single cycle. Default.
NONE Handles datasets with the same dataset name as
separate cycles. The creation date is ignored.
JOB Handles datasets with the same dataset name and
job name as a single cycle. The creation date is ignored.
JOBDATE Handles datasets with the same dataset
name, creation date and job name as a single cycle.

EXPDTYPE

Determines expiration logic depending on the type of

retention criteria and value specified:
When DATE or DAYS retention criteria are assigned to a
dataset:
CA1 CA-1 expiration logic applies. DATE or DAYS
specifies the day on that the dataset volumes with vault
until date are moved to the next vault or are returned to
mainlib on the same day as mentioned in the rule. Default.
TLMS TLMS expiration logic applies. DATE or DAYS
specifies the last day of retention. Volumes only move to
the next vault on the next day, one day later than
mentioned in rule.
NONE Expiration date in standard MVS format.
When cyclic retention criteria are specified:
CA1 CA-1 expiration logic applies. Only primary
datasets (datasets with LABEL set to 1) are considered in
the expiration calculation. Default.
Other All cyclic datasets are considered regardless of
label number.

GRACECAT

Defines the number of extended retention days added to the

catalog controlled dataset (when DO RETENTION is set to
MVS CATALOG).

GRACECYC

Defines the number of extended retention days added to the

cycle controlled dataset (when DO RETENTION is set to
CYCLES).

MODE

Determines whether to uncatalog expired datasets in the

operating system catalog. Valid values are:
TEST Datasets are not uncataloged.
PROD or PHASE Datasets are uncataloged if no TEST
rules match the expired datasets. For details, see the
TESTRUL parameter in this table.

RTNTYPE

Specifies when the datasets on the volume are scratched.

VOL Each dataset on the volume is marked scratch only
if all datasets on the volume have expired. This option is
recommended for compatibility with CA-1 and CA-TLMS.
DSN Each dataset records expiration criteria in the
Media Database is independent of other datasets on the
volume.
Note: A multivolume chain functions independently of
parameter RTNTYPE. Only if all datasets on each volume
have expired are all the datasets of the chain marked scratch
and all volumes of the chain become scratch.

BMC Software, Inc., Confidential and Proprietary Information

7-88

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

Table 7-41

CTTRTM Installation Parameters (Part 3 of 3)

Parameter

Description

SMSINTR

Determines whether the CONTROL-M/Tape to DF/SMS

interface is active. If this interface is active and expiration
dates are defined by SMS-managed classes, retention is
dependent on expiration dates specified in SMS Management
Classes.
Y (Yes) The CONTROL-M/Tape to DF/SMS interface is
active.
Note: If CDAM files are allocated on SMS volumes, these
volumes must be defined with PARTIAL RELEASE set to
NO.
N (No) The CONTROL-M/Tape to DF/SMS interface is
not active.

TESTRUL

Determines whether test rules are used in the production

environment (global MODE is set to PROD or PHASED). If an
expired dataset matches a test rule, do not uncatalog the
dataset.
Y (Yes) Test rules are used. The utility loads and scans
the CONTROL-M/Tape rules.
N (No) Test rules are not used. The utility does not load
and scan the CONTROL-M/Tape rules. Default.

For additional information see the discussion on specifying retention and

vault parameters in the CONTROL-M/Tape chapter of the INCONTROL for
OS/390 and z/OS Installation Guide.

Activating the Utility

//EXEC
CTTRTM
//SYSIN DD *
TYPERUN MODE=NORMAL|SIMULATION|[,DATE=date][,
TRACE=YES|NO][,DBGLEVEL=level][,
RESTART=YES|NO][,LIST=YES|NO|FULL][,
MAXDSNO=nnn][,MAXVOLNO=nnn]
TYPERET MODE=REGULAR|RECALC|CA1CONV|CONVERT[,
UNCTLG=YES|NO][,UPDVOL=YES|NO]
<INCLUDE/EXCLUDE statements>
REPORT NAME={SCRATCH|RECALC}
FIELDS ...
SORTBY ...
ATTR
...
BREAK ...
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-89

CTTRTM Perform Retention Management

Parameters
Utility parameters are supplied using DD statement SYSIN:
Note:

Although both the TYPERET and the REPORT parameters are

optional, at least one of them must be specified.

Table 7-42

CTTRTM Parameters (Part 1 of 7)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Operation mode. Mandatory.
NORMAL Normal operation is performed. The Media
Database is updated as required by the CTTRTM utility.
SIMULATION Simulation is performed. No changes
are made to the Media Database. In this mode,
CONTROL-M/Tape keeps in memory a list of Media
Database records that would have been updated if the
utility ran in NORMAL mode.
Note: Running the CTTRTM utility in SIMULATION mode
requires a much larger region than running the utility in
NORMAL mode. The required region size depends on the
number of updated Media Database records that this utility
stores in memory.
You cannot run more than one instance of the CTTRTM utility
in NORMAL mode at the same time.
DATE Operation date in 6-character or 8-character
format according to site standard. For example, the date
can be specified in mmddyy or mmddyyyy format. Optional.
TRACE Specifies whether the Trace file is used during
CTTRTM run. Optional. Valid values are:
Y (Yes) The Trace file is used. Default.
N (No) The Trace file is not used.
DBGLEVEL Debug level. A numeric value from 1 to 255
can be specified.
Note: Use this parameter only if requested by BMC Software
Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

7-90

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

Table 7-42

Parameter

CTTRTM Parameters (Part 2 of 7)

Description
RESTART Specifies whether to enable Automatic
Restart mode when the utility is run after an abend or
cancellation of the previous run of the utility.
Valid values are:
Y (Yes) Enable Automatic Restart mode. Default.
N (No) Disable Automatic Restart mode.
LIST Specifies whether diagnostic messages
CTT301I, CTT302I, CTT493I and CTT494I are be
produced. The messages are sent to SYSPRINT.
Valid values are:
N (No) None of these messages are produced.
Y (Yes) Messages CTT301I, CTT302I and CTT493I
are produced. Default.
FULL All of these diagnostic messages are produced.
MAXDSNO Maximum number of datasets that can be
scratched by this run of the utility. Optional. A value from
1 through 999999 can be specified.
If this limit is exceeded, the utility stops, a message is
issued, no changes are made to the Media Database,
and the Scratch report (if requested) is produced
describing all dataset and/or volume scratches that were
to be performed (if the maximum had not been
exceeded).
Default: Any number of datasets can be scratched by the
utility (that is, no limit is assumed).
MAXVOLNO Maximum number of volumes that can be
scratched by this run of the utility. Optional. A value from 1
through 999999 can be specified.
If this limit is exceeded, the utility stops, a message is
issued, no changes are made to the Media Database and
the Scratch report (if requested) is produced describing
all dataset and/or volume scratches that were to be
performed (if the maximum had not been exceeded).
Default: Any number of volumes can be scratched by the
utility (that is, no limit is assumed).
Note: A Scratch report is only produced by utility CTTRTM if
a REPORT control statement describing the report was
specified.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-91

CTTRTM Perform Retention Management

Table 7-42

CTTRTM Parameters (Part 3 of 7)

Parameter

Description

TYPERET

Retention management type. Optional if parameter REPORT

is specified. If TYPERET is not specified, retention
processing is not performed, but the report produced by the
last run of utility CTTRTM is regenerated. Valid values are:
MODE Retention management mode. Valid values:
REGULAR Retention management is performed
according to the retention criteria currently specified in
dataset records in the Media Database.
CONVERT This parameter is used after conversion
from a different tape management system (for example,
CA-TLMS).
When MODE is set to CONVERT, expiration date
information is extracted from one of the following
locations, depending on CONTROL-M/Tape
installation parameters:
CONTROL-M/Tape rules
JCL EXPDT parameters
SMS Management Classes
Default values defined in member CTTPARM
The extracted retention information is used to update
dataset records in the Media Database. However, no
actual expiration is performed. This enables the user to
check that the conversion works as planned, before
retention management is implemented.
Note: Set MODE to CONVERT only in the following cases:
This is the first run of utility CTTRTM since conversion from
the previous tape management system, and retention
information does not exist in the dataset records created as
a result of this conversion (for example, CA-TLMS).
Rules were defined with new retention information that
must be incorporated into the dataset records in the Media
Database.
RECALC Retention information in dataset records in
the Media Database is updated and expiration is
performed.
Running utility CTTRTM with MODE set to RECALC
has the same effect as running this utility twice: once
with MODE set to CONVERT and a second time with
MODE set to REGULAR.
If MODE is set to RECALC, a special RECALC report
can be generated. For more information, see control
statement REPORT in this table.
CA1CONV This parameter is used only after CA-1
conversion. In this mode, no retention actions are taken.
This mode is used to fill in the dataset names prefix
length (as defined in CONTROL-M/Tape rules) in the
Media Database dataset records.
This information is later used for retention management
of cyclic datasets.
Note: If the CTTRTM utility has already been run with
MODE set to CONVERT, it is not necessary to run it
again with MODE set to CA1CONV.

BMC Software, Inc., Confidential and Proprietary Information

7-92

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

Table 7-42

Parameter

CTTRTM Parameters (Part 4 of 7)

Description
Basic Scheduling parameters are checked when rules are
loaded and not when datasets are created or retention
information is updated. Therefore, when running the
CTTRTM utility with MODE set to RECALC, CONVERT, or
CA1CONV, the rules applied may differ from the rules
normally applied at dataset creation. For more information,
see the online facilities chapter in the CONTROL-M/Tape
for OS/390 and z/OS User Guide.
UNCTLG Specifies whether to uncatalog datasets after
scratching the dataset records from the Media Database.
Optional. Valid values are:
YES Uncatalog the datasets. Default.
NO Do not uncatalog the datasets.
UPDVOL Specifies whether to copy the retention
information from the dataset records to the volume where
the datasets reside. The highest retention period is stored
in the volume record. Applies only if MODE is set to
RECALC or CONVERT. Valid values are:
YES Copy retention information to the volume record.
NO Do not copy the retention information to the
volume record. Default.
Setting UPDVOL to NO can significantly improve
performance time when running the utility in CONVERT
or RECALC mode.
However, accurate retention information is only
available using inquiry of dataset records in the Media
Database (that is, an inquiry of the volume records may
not yield accurate retention information).

INCLUDE /
EXCLUDE

The scope of the utility can be limited by one or more

INCLUDE / EXCLUDE statements. INCLUDE / EXCLUDE
statements are specified immediately after the TYPERET
parameter and are applied to retention processing.
For additional information on INCLUDE / EXCLUDE
statements, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6, and the appendix that
discusses logical field names for the CONTROL-M/Tape
Repository in the INCONTROL for OS/390 and z/OS
Administrator Guide.

With few exceptions, the parameters and options of the REPORT, FIELDS,
SORTBY, ATTR and BREAK statements are identical to those found in the
CTTRPT utility. For a complete description of these parameters and options, see
the CTTRPT utility on page 7-58. Differences between the parameters and options
of the CTTRTM and CTTRPT utilities are noted where applicable.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-93

CTTRTM Perform Retention Management

Table 7-42

CTTRTM Parameters (Part 5 of 7)

Parameter

Description

REPORT

Produces one of the following reports. Optional if a TYPERET

parameter is specified.
NAME Report name. Mandatory. Valid values are:
SCRATCH Report listing volumes that expired based
on the execution results of the CTTRTM utility.
Note: Full scratch report FULLSCR is no longer generated by
the CTTRTM utility. Instead, this report can be generated as
part of the GENERAL report by the CTTRPT utility. A sample
Full Scratch report can be found in the REPFSCR member of
the CONTROL-M/Tape JCL library.
RECALC Report listing datasets whose expiration
date changed during this run of the utility.
This report can only be generated if MODE is set to
RECALC when the utility is run.
Note: Either or both of these reports can be generated during
a single run of the CTTRTM utility.

FIELDS

Fields to print in the report. The fields are printed in the order
they are specified. The fields that can be specified for each
report type are as follows:
Fields of the SCRATCH Report
MEDIA Media type.
POOL Pool name.
VOLSER Volume serial number.
SL-NAME Standard label name of the volume.
UNAME Unit name.
FIRSTVOL First volser in a multi-volume chain.
DSNAME Name of the first dataset in the volume.
CREDS Creation date of the first dataset in the volume.
EXPDS Expiration date of the first dataset in the volume.
EXPDT Expiration date of the volume.
LACCDT Last access date of the volume.
LOCATION Location.
CHKINDT Check-in date.
IOERR Number of input or output errors.
LCLNDT Last clean date.
VOLSTAT Statuses of the volume.

BMC Software, Inc., Confidential and Proprietary Information

7-94

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

Table 7-42

Parameter

CTTRTM Parameters (Part 6 of 7)

Description
Fields of the RECALC Report
Each of the following fields can be specified for each dataset
in a RECALC report:
VOLSER Volume serial number.
LABEL Dataset label number.
VOLSNUM Number of volumes on which the dataset
resides.
CREDT Creation date.
CRETM Creation time.
READDT Date the dataset was last opened for READ
access.
READTM Time the dataset was last opened for READ
access.
WRITEDT Date the dataset was last opened for WRITE
access.
WRITETM Time the dataset was last opened for WRITE
access.
DSSTAT Dataset status.
LASTACC Type of last access (meaning, CREATE,
READ or WRITE).
SMSCL SMS management class.
CREUSER User ID that created the dataset.
CREJOBID Creating Job ID.
JCLEXPDT Dataset expiration date as specified in the
JCL.
Retention Type Fields for Report RECALC
The following fields describe the retention types specified for
each dataset and the and/or relationships between them.
Fields prefixed by OLD indicate retention types before the
utility was run. Fields prefixed by NEW indicate retention
types after the utility was run.
OLDEXDT1 First expiration criterion before
recalculation.
OLDXDTR1 Relation between the first and second old
expiration dates.
OLDEXDT2 Second expiration criterion before
recalculation.
OLDXDTR2 Relation between second and third old
expiration dates.
OLDEXDT3 Third expiration criterion before
recalculation.
NEWEXDT1 First expiration criterion after recalculation.
NEWXDTR1 Relation between first and second new
expiration dates.
NEWEXDT2 Second expiration criterion after
recalculation.
NEWXDTR2 Relation between second and third new
expiration dates.
NEWEXDT3 Third expiration date after recalculation.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-95

CTTRTM Perform Retention Management

Table 7-42

CTTRTM Parameters (Part 7 of 7)

Parameter

Description

SORTBY

Order in which the report is sorted. (Available fields are listed

above under parameter FIELDS.) The /B (or /BRK) option (or
/BRK) can be added as a suffix to any field to indicate that a
page break is inserted in the report when the field changes its
value.

ATTR

Override of default attributes defined for a field. For more

information, see the FIELDS parameter in this table. Optional.

BREAK

Attributes of the summary header lines printed when a field

break occurs. Optional.

Note: For a description of the options of these statements, see the FIELDS,
SORTBY, ATTR, and BREAK statements of the CTTRPT utility in Table 7-33 on
page 7-62.

Return Codes
Table 7-43

CTTRTM Return Codes

Code

Description

Operation performed successfully.

Missing DD statements or open error occurred.

12

Control card error.

16

Load of CONTROL-M/Tape routines failed.

20

Sort error occurred.

24

Media Database input or output error occurred.

28

Internal error occurred.

32

Error in report printing utility occurred.

36

Load of rule, pool or vault table failed.

40

Authorization error (by security exit).

44

Media Database file in use.

48

Insufficient storage.

52

Logical error in Media Database.

56

Number of datasets or volumes to be scratched exceeded the

limit.

BMC Software, Inc., Confidential and Proprietary Information

7-96

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

Examples
In the following example, retention management is performed according to
the current retention specifications in the Media Database. Report SCRATCH
is printed, listing volser and media type and is sorted according to pool name.
The list for each media type starts on a new page.

Example 1

//EXEC
//SYSIN
TYPERUN
TYPERET
REPORT
FIELDS
SORTBY
//

CTTRTM
DD *
MODE=NORMAL
MODE=REGULAR
NAME=SCRATCH
POOL,VOLSER,MEDIA
POOL,MEDIA/B,VOLSER

In the following example, retention information is updated for all datasets

whose name begins with prefix BKP.

Example 2

//EXEC
//SYSIN
TYPERUN
TYPERET
INCLUDE
REPORT
FIELDS
SORTBY
//

CTTRTM
DD *
MODE=NORMAL
MODE=CONVERT
DSNAME=BKP*
NAME=SCRATCH
EXPDT,MEDIA,VOLSER,POOL
EXPDT

In the following example, the utility is used to produce the scratch report
from the last finished run of utility CTTRTM.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-97

CTTRTM Perform Retention Management

Example 3

//EXEC
//SYSIN
TYPERUN
REPORT
FIELDS
SORTBY
//

CTTRTM
DD *
MODE=NORMAL
NAME=SCRATCH
fields
fields

In the following example, retention information is recalculated for all

datasets in the Media Database. A RECALC report is produced listing the
datasets whose retention information changed and the old and new expiration
information for these datasets.

Example 4

TYPERUN
TYPERET
REPORT
FIELDS

FIELDS

ATTR
ATTR
ATTR
ATTR
ATTR
ATTR
ATTR
ATTR
ATTR
ATTR
ATTR

MODE=NORMAL
MODE=RECALC
NAME=RECALC
VOLSER/C4/L6,LABEL/C12/L3,DSNAME/C17/L44,
OLDEXDT1/C63/L10,OLDXDTR1/C75/L1,
OLDEXDT2/C78/L11,OLDXDTR2/C91/L1,
OLDEXDT3/C94/L10,ID=P
NEWEXDT1/C63/L10,NEWXDTR1/C75/L1,
NEWEXDT2/C78/L11,NEWXDTR2/C91/L1,
NEWEXDT3/C94/L10,ID=S
FIELD=OLDXDTR1,TITLE= ,LENGTH=1
FIELD=OLDXDTR2,TITLE= ,LENGTH=1
FIELD=NEWXDTR1,TITLE= ,LENGTH=1
FIELD=NEWXDTR2,TITLE= ,LENGTH=1
FIELD=OLDEXDT1,TITLE=OLD-
FIELD=NEWEXDT1,TITLE=NEW-
FIELD=OLDEXDT2,TITLE=EXPIRATION-
FIELD=NEWEXDT2,TITLE=EXPIRATION-
FIELD=OLDEXDT3,TITLE=DATA
FIELD=NEWEXDT3,TITLE=DATA
FIELD=LABEL,TITLE=LBL,EDIT=999

BMC Software, Inc., Confidential and Proprietary Information

7-98

INCONTROL for OS/390 and z/OS Utilities Guide

CTTRTM Perform Retention Management

The following report is generated by this example:

BMC SOFTWARE, LTD.

CONTROL-M/TAPE REPORT (Ver 6.1.00)

DATE 27/11/2000 TIME 15.10

PAGE 1

List of Datasets With Recalculated Expiration

---------------------------------------------

First
Volume
-----B21002

B21002

B21003

B21003

LBL

--001

002

001

002

DATASET
NAME
-------------------------------------------M27.BACKUP.BD1.D971111

M27.BACKUP.BD2.D971111

M27.BACKUP.NBD3.D971112

M27.BACKUP.NBD4.D971112

OLD-

EXPIRATION-

NEW---------Catalog
Cycl+0003

O
A

EXPIRATION----------01/04/2000
Catalog

01/04/2000
Cycl+0003

Catalog
Cycl+0003

DATA

DATA
----------

25/05/2000

Catalog

25/05/2000

Catalog

25/05/2000

Cycl+0005
Cycl+0003

A
A

Catalog
Catalog

25/05/2000

Cycl+0005

CHKINE

001

N89.CHKIN.SET

01/01/2000
23/09/1999

CHKINF

001

N89.CHKIN.SET

01/01/2000
23/09/1998

CHKING

001

N89.CHKIN.SET

01/01/2000
23/09/1998

CHKINH

001

N89.CHKIN.SET

01/01/2000
24/09/1998

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-99

CTTSBD Perform Dataset Stacking in Batch Mode

CTTSBD Perform Dataset Stacking in Batch Mode

Utility CTTSBD copies datasets residing on removable media. It supplements
the CONTROL-M/Tape Dynamic Dataset Stacking facility, which controls
the placement of datasets at time of creation.
Utility CTTSBD enables you to copy existing datasets (input datasets) from
one location to another. Output datasets (the new copies) can be new datasets
with their own names and retention or they can replace input datasets by
taking over relevant catalog entries and assuming certain attributes of the
input datasets.
Note:

If you are working in an SMS-managed environment, it is important

to ensure that no DATACLASS ACS routines modify or set attributes
of datasets created by utility CTTSBD (for example, using keywords
RECFM, LRECL or BLKSIZE).

Utility CTTSBD enables you to:

Copy multiple input datasets to a single output volume or a multi-volume

chain (stacking).

Copy each dataset from an input volume or volume chain to a separate

output volume (unstacking).

Select input datasets and volumes according to various criteria.

Control grouping of output datasets in a volume (or volume chain).

Copy the attributes of input datasets to the output datasets. Attributes

describing dataset name, catalog reference, retention information,
creating job, and so on, can be copied.

Analyze free (available) space in the tape library and associated costs.

Running utility CTTSBD to stack multiple datasets is called Batch stacking.

Batch stacking helps you:

Increase the number of available (scratch) tapes in a tape library.

Free scratch volumes to satisfy immediate production needs.

Simplify stacking implementation at your site.

Control the growth of your cartridge inventory.

Refresh old media.

BMC Software, Inc., Confidential and Proprietary Information

7-100

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Migrate datasets from one media type to another.

Implement new or modified site standards regarding which datasets (for

example, datasets created by different applications) can or cannot reside
on the same volumes.

Create additional copies of existing datasets for backup, shipping off-site

or usage by other applications.

Reclaim space occupied by expired datasets on multi-file volumes.

Utility Logic
Utility CTTSBD searches the Media Database for datasets and volumes that
satisfy selection criteria specified in INCLUDE / EXCLUDE statements.
Selected volumes are sorted according to the volser of the first volume in
each input volume chain. Each dataset on each selected volume chain is then
copied to a new volume or volume chain. Various parameters are used to
control the actions taken by utility CTTSBD. For example:

Whether to copy expired datasets.

Which datasets can reside together on the same output volume chain.
How many datasets or volumes can be in a volume chain.

When a dataset is successfully copied, CTTSBD updates the relevant Media

Database records and catalog information according to user specifications.
using the parameters of utility CTTSBD, the user can indicate:

Cataloging of the output dataset (parameter OUTCAT).

Retention of output and/or input datasets (parameters OUTRET and

INRET).

Copying of certain historical information about the input dataset to the

output dataset record (parameter COPYATTR).

The CTTSBD utility terminates when one of the following occurs:

All selected volumes have been processed.

An operator command is issued (see Modify Command).

A specified number of input volumes have been processed (parameter

NUMVOL).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-101

CTTSBD Perform Dataset Stacking in Batch Mode

A specified maximum amount of time has passed (parameter TIMELIM).

Processing of a specified maximum allowed number of input volume

chains is stopped due to runtime errors (parameter MAXERR).

Execution Considerations
Run utility CTTRTM after running utility CTTSBD to scratch newly freed
volumes. Utility CTTVTM can also be run after running utility CTTSBD to
update vault information effected by the CTTSBD run. For more information,
see Batch Stacking and Vault Management on page 7-104.
Note:

Utility CTTSBD is not designed to handle vaulted volumes. For

more information on this issue, see Batch Stacking and Vault
Management on page 7-104.
Utility CTTSBD does not handle external or EDM-managed
volumes.

Resource Requirements
Resource requirements can help you decide when is the best time to run
utility CTTSBD. The duration of resource consumption depends primarily on
the number of volumes selected for processing by utility CTTSBD. Below is
a description of the various resources used by this utility.
Table 7-44

CTTSBD Resource Requirements

Resource

Description

Disk
processing

CTTSBD disk processing includes sequential processing of the

Media Database and multiple sort phases.
In NORMAL mode, disk processing is performed during the
selection phase only. After the first volume is mounted for
copying, disk processing becomes minimal.
In SIMULATION mode, volume selection is the primary action
performed by the utility. In this mode, the utility runs faster even
though disk processing continues during most of the run.

Tape
processing

CTTSBD tape resource consumption is similar to that of any

other tape-to-tape copy or backup program that uses two tape
drives.

Memory
Requirements

CTTSBD uses memory resident information about volumes and

datasets. Storage is allocated as new volume chains are created.
Virtual storage requirements for this utility depend on:
The number of output volume chains created by the utility.
The maximum number of datasets allowed in each output
volume chain.

BMC Software, Inc., Confidential and Proprietary Information

7-102

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Exit CTTX011
CONTROL-M/Tape Exit CTTX011 enhances the functionality of utility
CTTSBD by allowing placement of output files to be dependent on stacking
criteria that cannot be specified using utility parameters (for
example, security constants).
Information passed to this exit describes:

The input dataset name.

The candidate output volume.
The datasets already residing on the output volume chain being
considered as a location for the output dataset.

This exit examines the information provided and does one of the following:

Allows placement of the output dataset on the candidate output volume.

Rejects placement of the output dataset on the candidate output volume.
Forces placement of the output dataset on a scratch volume.
Grants the candidate output volume preferred status.
Passes (meaning, the exit does not influence CTTSBD processing).

For more information about this exit, see member CTTX011 in the IOA
SAMPEXIT library.

Retention
When an output dataset is written by utility CTTSBD, it is subjected to
CONTROL-M/Tape rules for retention and vaulting. When the dataset is
successfully copied, retention of the output dataset can be modified according
to the setting for utility parameters OUTRET and OUTCAT.
It is recommended that you run utility CTTRTM after running utility
CTTSBD to scratch newly freed volumes. It is not necessary to specify mode
RECALC for this run of CTTRTM.
Note:

If datasets with CYCLE type retention are to be handled by utility

CTTSBD, a specific number must be specified for utility parameter
INRET and/or OUTRET.
If a dataset with CYCLE type retention is detected and no specific
value was specified for at least one of these parameters, the dataset is
ignored (skipped) and the utility continues to process the next dataset
in the current input volume chain.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-103

CTTSBD Perform Dataset Stacking in Batch Mode

Batch Stacking and Vault Management

Utility CTTSBD copies datasets on volumes that reside in the main library
and are not scheduled for storage in an off-site vault. By default, volumes that
are in a vault or are scheduled to be transferred to a vault, are not selected by
CTTSBD, even if specified INCLUDE / EXCLUDE statements explicitly
state otherwise.
Some sites use vault management for administrative purposes other than
off-site storage. At such a site, use parameter VAULTED to indicate that
vaulted (and to-be-vaulted) volumes are processed by utility CTTSBD.
Note:

If VAULTED is set to YES for utility CTTSBD, vaulted or

to-be-vaulted volumes can be stacked together (meaning, in the same
volume chain) with volumes that have no specified vaulting pattern.

Vault patterns of output volumes are determined by CONTROL-M/Tape rules

that are active at time of output dataset creation. These vault patterns are also
influenced by various attributes copied from the input datasets (for example,
creation date). The resulting vault pattern can be inappropriate and must be
reset using user-defined vaulting rules. For information on vaulting rules, see
the topic on online vault definitions in the online facilities chapter of the
CONTROL-M/Tape User Guide.
Run utility CTTVTM to refresh vaulting information for newly created
datasets. Mode RECALC can be specified but does not necessarily correct all
inconsistencies. It is highly recommended to use INCLUDE statements to
limit operation of the utility to necessary tapes only.

Volume and Dataset Information

When an output dataset is created by utility CTTSBD, the Media Database
initially describes the dataset as a new file. There is no indication that this file
is a copy of another dataset.
After the output dataset is successfully written, various attributes can be set
by utility CTTSBD in the relevant Media Database records. For more
information, see the COPYATTR parameter in General Utility Parameters
on page 7-116.

BMC Software, Inc., Confidential and Proprietary Information

7-104

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Dataset Record
When a dataset is copied, CONTROL-M/Tape assigns various attributes to it.
For example:

Creation date (the date utility CTTSBD was run).

Retention information (subject to active CONTROL-M/Tape rules).

Utility CTTSBD can optionally be instructed to copy certain attributes of the

input dataset to the dataset record of the output dataset and to override the
above settings. For more information, see the OUTRET and COPYATTR
parameters in General Utility Parameters on page 7-116.
Note:

Certain physical attributes of the output dataset are not modified by

utility CTTSBD. These physical attributes include volume serial
numbers label number, blocking and size.

Volume Record
No volume information from the input volume records is copied to the output
volume records. Output volume records are not modified by utility CTTSBD
and contain information relevant to only the output volumes.

Stacking Logic
Utility CTTSBD augments the CONTROL-M/Tape Dynamic Dataset
Stacking facility by allowing multiple pre-existing datasets to be copied and
stacked according to specified criteria.
Datasets are placed on output volumes according to stacking parameters and
runtime parameters specified by the user.
Output dataset size is calculated according to the known size of input datasets
and runtime information about output volumes. The output dataset size is
used to determine whether there is sufficient space in a given volume chain to
stack the dataset.
Output datasets are stacked only on volumes that became active during the
current run of utility CTTSBD. If no appropriate volume is found, the dataset
is written on a scratch volume.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-105

CTTSBD Perform Dataset Stacking in Batch Mode

Batch Stacking and Dynamic Dataset Stacking

Datasets written by utility CTTSBD are not stacked by the
CONTROL-M/Tape Dynamic Dataset Stacking facility. DO STACK, DO
STKRULE and DO STKGROUP statements in relevant CONTROL-M/Tape
rules are ignored by utility CTTSBD.
Use utility CTTSBD to implement dataset grouping similar to the grouping
produced by DO STKGROUP statements. Also, to force stacking of datasets
that are not normally stacked by the Dynamic Dataset Stacking facility.
Batch stacking can be used to complement the Dynamic Dataset Stacking
facility in the following way:

Datasets are normally stacked using the CONTROL-M/Tape Dynamic

Dataset Stacking facility at time of creation.

Utility CTTSBD can be run periodically to consolidate under-utilized

volumes and to alter dataset placement according to site needs.

Dataset Groups
A dataset group is a collection of datasets for which stacking statements can
be specified.

A group name is assigned to each dataset.

Each group name is associated with a set of stacking statements that

determine where (and with which datasets) members of the dataset group
can be stacked.

To apply a stacking statement to a dataset, the dataset must first be

associated with a dataset group.

Group names are re-assigned each time utility CTTSBD is run.

All statements specified for dataset groups are applied using input dataset
names. Prefixes and/or suffixes (parameters OUTPREF and OUTSUFF)
added to dataset names do not affect application of dataset group stacking
statements during the current run of the utility. However, these prefixes may
affect future runs of the utility.

BMC Software, Inc., Confidential and Proprietary Information

7-106

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Example

Assume the following:

Input datasets ACCT.JAN00 and ACCT.FEB00 are assigned to group

ACCT.

A prefix of NEW is added to output dataset names for group ACCT.

Input datasets NEW.ACCT.NOV99 and NEW.ACCT.DEC99 are assigned

to group NEW. (These datasets may have been created by a previous run
of utility CTTSBD.)

No prefix is added to output dataset names for group NEW.

Utility CTTSBD selects all datasets from group ACCT and group NEW.

The following output datasets are created by this run of utility CTTSBD:
Table 7-45

CTTSBD Datasets

Input Dataset
Name

Input
Dataset
Group

Output Dataset
Name

Output
Dataset
Group

ACCT.JAN00

ACCT

NEW.ACCT.JAN00

ACCT

ACCT.FEB00

ACCT

NEW.ACCT.FEB00

ACCT

NEW.ACCT.NOV99

NEW

NEW.ACCT.NOV99

NEW

NEW.ACCT.DEC99

NEW

NEW.ACCT.DEC99

NEW

Note that the group name assigned to each input dataset is automatically
assigned to the corresponding output dataset (regardless of the output dataset
name).

Determination of Output Dataset Location

Utility CTTSBD determines placement for output datasets in the following
way:
Utility CTTSBD first attempts to place the current dataset on the current
output volume chain (meaning, the chain on that the previous dataset was
stacked).

If the dataset cannot be placed on the current volume chain, utility

CTTSBD attempts to place the dataset on the first volume chain created
during this run of the utility.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-107

CTTSBD Perform Dataset Stacking in Batch Mode

If the first volume chain is not suitable, the second one is considered, and
so on. Utility CTTSBD considers each chain created during this run (in
the order in which they were created) as a possible location for the
current dataset until either a suitable volume chain is found or all chains
have been considered.

If no suitable volume chain is found, the dataset is placed on a scratch

volume.

Datasets can be stacked on volumes (or multi-volume chains) created during

a run of utility CTTSBD even after the volumes have been dismounted.
Each volume chain considered as a possible location for the current dataset is
processed in the following way:
1. The dataset group definition associated with the current dataset is
compared with the dataset group definition of each dataset on the
candidate volume chain.
If a statement specified in any dataset group definition does not allow the
datasets to coexist in the same volume chain (due to group name, job
name or dataset name) utility CTTSBD rejects the volume chain and
attempts to place the dataset on the next volume chain. (Dataset group
stacking parameters are described in detail later is this guide.)
2. Utility CTTSBD searches the dataset group definitions for a WITHGRP
statement that indicates that the current dataset must be stacked together
with the datasets on the candidate volume chain. An appropriate
WITHGRP statement can exist in the dataset group definition of the
current dataset and/or a dataset on the candidate volume chain.
(WITHGRP statements are described in detail later in this guide.)

If a matching WITHGRP statement is found, utility CTTSBD copies the

dataset to the volume chain (as long as limits specified to the utility have
not been exceeded).
Note:

You can maximize media utilization by instructing utility

CTTSBD to create output volume chains containing a large
number of volumes (using parameter OUTMVLIM). You can
also control the number of datasets in an output volume chain
using parameter MAXLABEL.
If the specified maximum number of volumes in a chain is
exceeded during the writing of a multi-volume dataset (for
example, due to an inaccurate prediction concerning dataset
length) utility CTTSBD continues writing the dataset on as many
volumes as required.

BMC Software, Inc., Confidential and Proprietary Information

7-108

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

If no matching WITHGRP statement is found, utility CTTSBD rejects

the volume chain and attempts to place the dataset on the next volume
chain.
Note:

Exit CTTX011 (if implemented) is invoked at various stages in

the above process to modify or force a stacking decision. For
more information, see Exit CTTX011 on page 7-103 and the
CTTX011 member in the IOA SAMPEXIT library.

Masking
Mask characters are supported for many of the parameters of utility
CTTSBD. The ability to use mask characters is indicated in the description of
the relevant parameters. The following mask characters can be used:
Table 7-46

CTTSBD Masks

Mask

Description

Represents any one character.

Represents any number of characters (or no characters). This

mask character is only supported when at the end of a mask.

Examples
Table 7-47

CTTSBD Mask Examples

Example

Description

JBN?

Matches JBN1, JBN2, and so on.

J?N?

Matches JBN1, JAN1, JUN2, and so on.

JBN*

Matches JBN1, JBN2, JBN123, JBN, JBN1234, and so on.

*BN

Invalid mask.

Stopping Utility CTTSBD

Utility CTTSBD may run for a long time. If you need to free up resources
(for example, tape drives) for other processing, you can stop utility CTTSBD
using the following operator command:
F

jobname,STOP

where jobname is the name of the job or started task that is executing utility
CTTSBD.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-109

CTTSBD Perform Dataset Stacking in Batch Mode

When the above STOP command is issued, utility CTTSBD acknowledges

this fact (using an operator message) and continues processing the remaining
datasets in the current input volume chain. When the current chain has been
completely processed, utility CTTSBD stops.
If utility CTTSBD is restarted, you may need to modify the INCLUDE /
EXCLUDE statements so that previously processed volume chains are not
processed again.

Reports
Utility CTTSBD produces a variety of reports detailing information relevant
to the run of the utility.

Media Utilization Report

Lists the number of volumes and the amount of available space in each of
several media categories (scratch tapes, non-scratch tapes, and so on.)

Input Volume Inventory

Lists all input volumes selected for the run of utility CTTSBD and the
datasets residing on those volumes.

Output Volume Inventory

Lists all output volumes created during the run of utility CTTSBD and
the datasets residing on those volumes.
Note:

The output volume inventory identifies output datasets whose

names are identical to the corresponding input dataset names and
neither the input nor the output dataset is cataloged. using this
report, such datasets can be tracked, making it easier for you to
take action (if necessary).

Detailed Input or Output Report

For each input volume, the utility lists the input datasets and the
corresponding output datasets, output volumes, label numbers and
retention information.
Note:

Expiration dates listed in this report for input datasets are the
expiration dates after the datasets have been processed by utility
CTTSBD. The original expiration date for these datasets is listed
in the Input Volume Inventory (described above).

BMC Software, Inc., Confidential and Proprietary Information

7-110

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Output Volume Access Report

Lists output datasets (in the order in which they were created) and the
output volume on that each output dataset was written. This report serves
as a log for output volume mounts.

You can generate additional reports from the Media Database using utility
CTTRPT. For more information, see CTTRPT Database Extraction and
Report Utility on page 7-58.

Simulation Reports
Utility CTTSBD can be run in simulation mode. This mode can be used to
experiment with various stacking configurations (meaning, dataset group
definitions) without effecting dataset location in the tape library.
In simulation mode, utility CTTSBD calculates output volume capacity
according to the value specified for parameter OUTVOLMB. A very large
value can be specified for parameter OUTVOLMB to indicate virtually
unlimited capacity for output volumes. This is useful for determining how
many logical sets of output files are produced by a run of utility CTTSBD.
Multiple runs of utility CTTSBD in simulation mode can be used to compare
the results of batch stacking with various combinations of input volumes.
The reports produced are described above.
Note:

The reports generated by a run of utility CTTSBD in simulation

mode assume that arbitrary scratch volumes are mounted and
numbered with fictitious volume serial numbers (volsers) such as
000001, 000002, 000003, and so on. Simulated mounts are listed
according to the volsers of the fictitious scratch volumes.

Unstacking
Utility CTTSBD can unstack volume chains containing multiple datasets.
Unstacking is the process of copying each dataset to a different scratch tape,
without stacking additional datasets on the output volumes.
Input datasets are unstacked by specifying stacking statements (in dataset
group definitions) that prohibit each dataset in a specified group from
coexisting on a volume with any other dataset or by limiting the number of
datasets that can be stacked on a single volume.
For more information, see Example 2 on page 7-128.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-111

CTTSBD Perform Dataset Stacking in Batch Mode

Recovery From Abends

Utility CTTSBD can perform recovery operations in the following situations:

Upon encountering a recoverable error during a run of the utility.

Upon initialization of the utility following a run of the utility that was
terminated due to a nonrecoverable error or a system crash.

Recovery is performed in the following way:

If an input dataset was uncataloged and failure occurred before the

corresponding output dataset was cataloged, utility CTTSBD attempts to
recatalog the input dataset during the recovery process.
Note:

Utility CTTSBD attempts to recatalog a dataset only once. If the

recatalog attempts fails, the dataset has to be recataloged
manually.

In all other cases, input and output datasets remain in the state they were
in at time of failure (meaning, the abend or system crash).

This recovery logic ensures that at least one copy of each dataset is always
retained and, if necessary, cataloged. It may be necessary to scratch a single
unneeded output dataset created by an incomplete run of utility CTTSBD.
During recovery, CTTSBD must process no more than one dataset - the
dataset that was being processed at time of abend. Datasets processed prior to
the abend require no further processing.
Note:

If utility CTTSBD abended due to a physical or logical error in the

Media Database, use standard CONTROL-M/Tape methods to
perform recovery. For more information, see the section that
discusses repository backup and recovery in the CONTROL-M/Tape
chapter of the INCONTROL for OS/390 and z/OS Administrator
Guide.

BMC Software, Inc., Confidential and Proprietary Information

7-112

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Relevant Installation Parameters

Certain CONTROL-M/Tape installation parameters (specified in member
CTTPARM) may be relevant to CTTSBD utility operations. These
parameters are described below.
Table 7-48

Relevant CONTROL-M/Tape Installation Parameters

Parameter

Description

DYNSTK

Determines whether the CONTROL-M/Tape Dynamic Dataset

Stacking facility is activated. Utility CTTSBD performs Batch
stacking even if DYNSTK is set to N (No).

MEDIA

Specifies a CONTROL-M/Tape logical media definitions.

Utility CTTSBD uses media definitions specified during
CONTROL-M/Tape installation (and other information) during
calculation of output volume capacity.
If volume capacity information produced during a run of CTTSBD
appears to be inaccurate, it may be necessary to modify the
media definition for the relevant volumes.

MODE

Determines CONTROL-M/Tape operation mode. Utility CTTSBD

is fully functional only when MODE is set to PROD. However,
CTTSBD can be run in simulation mode while CONTROL-M/Tape
is operating in any mode (TEST, PHASED or PROD) or even
when CONTROL-M/Tape is not active.

RTNTYPE

Determines whether retention is performed on a dataset level or

on a volume level.
Input datasets are considered expired by utility CTTSBD only if
they have already been marked as expired by CONTROL-M/Tape
(for example, using utility CTTRTM).
If RTNTYPE is set to DSN in member CTTPARM, datasets
whose expiration conditions are met are expired by
CONTROL-M/Tape. If COPYEXPF is set to NO in utility CTTSBD,
these datasets are not copied during batch stacking.
If RTNTYPE is set to VOL in member CTTPARM, datasets
whose expiration criteria are met are not expired by
CONTROL-M/Tape until all datasets on the volume can be
expired. These datasets are copied during batch stacking
regardless of the value specified for CTTSBD parameter
COPYEXPF.

STKMODE

Determines the search algorithm to be used by the

CONTROL-M/Tape Dynamic Dataset Stacking facility. Utility
CTTSBD ignores the setting for this parameter. Parameter
CHAINRET (described later) provides similar controls for utility
CTTSBD.

For more information on the above installation parameters, see the topic
about specifying stacking parameters in the CONTROL-M/Tape chapter of
the INCONTROL for OS/390 and z/OS Installation Guide.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-113

CTTSBD Perform Dataset Stacking in Batch Mode

Preparation Steps
The following steps must be performed before the first run of utility
CTTSBD at your site:
1. Allocate and format utility CTTSBDs Checkpoint-Restart dataset using
batch job CTTSBF in the CONTROL-M/Tape JCL library.
2. Implement security considerations.
CONTROL-M/Tape utility CTTSBD reads and writes datasets in your
sites library. Relevant Media Database records are subsequently updated.
Therefore, the user ID associated with the job or started task that
executes the utility must be authorized to:
Read selected input datasets.
Create and write the output datasets (whose names may or may not
be the same as the names of the input datasets).
Read and update Media Database records.
Consult your security administrator to ensure that the required authorization
is defined for the user that runs utility CTTSBD.

BMC Software, Inc., Confidential and Proprietary Information

7-114

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Activating the Utility

//EXEC
//SYSIN
TYPERUN

CTTSBD
DD *
MODE=NORMAL|SIMULATION[,NUMVOL=n][,
TIMELIM=n],INUNIT=xxxx,OUTUNIT=xxxx,
OUTRET=RULE|SAME|nnnn,COPYATTR=YES|NO[,
CHAINRET=ONE|ANY][,OUTPREF=xxx|NONE][,
OUTSUFF=xxx|NONE]OUTCAT=YES|NO|RECAT[,
COPYEXPF=YES|NO][,OUTMVLIM=n][,MAXLABEL=n][,
VAULTED=YES|NO|ONLY],INRET=nnnn|SAME[,
OUTVOLMB=nnnnnn][,MAXERR=n][,CARTCOST=n][,
PROCESS=CHAIN|DATASET][,DBGLEVEL=n]
[INCLUDE/EXCLUDE statements]

/*
//CTTSBGRP
GROUP

DD *
NAME=groupname[,OUTMVLIM=n][,
MAXLABEL=nnnn][,OUTPREF=xxx|NONE][,
OUTSUFF=xxx|NONE][,INUNIT=xxxx][,
OUTUNIT=xxxx]
DATASET [DSNAME=dsname-mask][,
CREJBN=jobname-mask]
DATASET ...
[WITHGRP NAME=SAME|mask]
...
[NOTWGRP NAME=SAME|mask|OTHER]
...
[NOTWJOB NAME=SAME|mask]
...
[NOTWDSN NAME=SAME|mask]
...
GROUP ...

...

Parameters
Parameters specified for utility CTTSBD are arranged in the following way:

General utility parameters are specified using the SYSIN DD statement.

These parameters are arranged in one mandatory TYPERUN statement
followed by one or more INCLUDE / EXCLUDE statements. The
parameters that can be included in these statements are described below.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-115

CTTSBD Perform Dataset Stacking in Batch Mode

Dataset group parameters are specified using DD statement CTTSBGRP.

Each group is defined by a single GROUP statement followed by any
number of DATASET, WITHGRP, NOTWGRP, NOTWDSN and
NOTWJOB statements in any order. For valid statements and parameters
for dataset group stacking, see Dataset Group Stacking Parameters on
page 7-123.

General Utility Parameters

Utility parameters are supplied using DD statement SYSIN:

Table 7-49

CTTSBD General Utility Parameters (Part 1 of 7)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Operation mode. Mandatory. Valid values are:
NORMAL Utility CTTSBD copies specified datasets
and updates the MVS Catalog and the
CONTROL-M/Tape Media Database as specified by
utility parameters. The utility also produces various
reports that describe the operations it performed.
SIMULATION Utility CTTSBD selects input volumes
according to specified INCLUDE or EXCLUDE
statements and produces a report indicating how input
datasets are distributed in output volume chains if utility
CTTSBD were run in NORMAL mode. No input or output
volumes are accessed.
NUMVOL Specifies a maximum number of input
volumes to be processed. Optional. A value from 0 through
9999 can be specified.
When the specified number of input volumes is reached,
utility CTTSBD finishes processing the datasets in the
current input volume chain before stopping.
If no value is specified for this parameter, all selected
volumes and datasets are processed.
TIMELIM Elapsed time (in minutes) beyond which the
utility is stopped. A value from 0 through 9999 can be
specified. Default: No time limit.
If the specified time limit is reached, utility CTTSBD
finishes processing the datasets in the current input volume
chain before stopping.
INUNIT Unit name or unit address to be used by utility
CTTSBD for allocation of each input dataset. A name of up
to eight characters can be specified. Mandatory.
This parameter can be overridden for specific datasets
using parameter INUNIT in a dataset group definition.

BMC Software, Inc., Confidential and Proprietary Information

7-116

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-49

Parameter

CTTSBD General Utility Parameters (Part 2 of 7)

Description
OUTUNIT Unit name or unit address to be used by utility
CTTSBD for allocation of each output dataset. A name of
up to eight characters can be specified. Mandatory.
This parameter can be overridden for specific datasets
using parameter OUTUNIT in a dataset group definition.
OUTRET Indicates retention information to be used
for the output dataset. Mandatory. Valid values are:
nnnn The specific number of days to retain output
datasets. A number from 1 through 9999 can be
specified.
SAME Copy retention information (for example,
retention type and expiration date) from input dataset.
Fields RTNFROM, JCLEXPDT, DSEXPTYP, and
DSEXPDT are copied from the input dataset record. If
the expiration date of the input file is known to
CONTROL-M/Tape when the dataset is copied, the
output dataset is set to expire on that same date.
Retention of an input dataset with retention type DAYS
is calculated according to creation date. The output
dataset is created on a later date.
However, if utility CTTSBD is not run, the output dataset
expires on the date of the input dataset.
RULE Apply CONTROL-M/Tape rules to determine
retention of the newly created output dataset.
COPYATTR Indicates whether certain attributes of an
input dataset are copied to the corresponding output
dataset. Mandatory. Valid values are:
Y (Yes) Copy dataset attributes (for example, creation
date, creating job and creating program) from the input
dataset to the output dataset. This information replaces
the attributes assigned by CONTROL-M/Tape to the
newly created dataset.
The following fields are copied from the input dataset
record:
ACCOUNT
CREDDN
CREJOBID
CREUAD
DSUSECT
READCC
READDT
READSTEP
WRITECCL
WRITEDT
WRITESTP

CRECC
CREDT
CRESTEP
CREUSER
DUSRDATA
READCPU
READJBN
READTM
WRITECPU
WRITEJBN
WRITETM

CRECPU
CREJBN
CRETM
DSEXCP
LASTACCS
READDDN
READPGM|
READUAD
WRITEDDN
WRITEPGM
WRITEUAD

For more information on the content of these fields, see

the appendix that discusses logical field names for the
CONTROL-M/Tape Repository in the INCONTROL for
OS/390 and z/OS Administrator Guide.
N (No) Do not copy attributes from the input dataset
to the output dataset.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-117

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-49

Parameter

CTTSBD General Utility Parameters (Part 3 of 7)

Description
CHAINRET Determines whether utility CTTSBD forces a
uniform retention type on output volume chains.
Valid values are:
ONE All datasets placed on a given output chain
must have the same retention type (for example,
specific date or CATALOG). An output dataset is added
to an existing chain only if its retention type is identical
to that of datasets already in the chain.
ANY Datasets with different retention types can
reside on the same output volume chain. Default.
OUTPREF Prefix to be added to the names of output
datasets. A period is inserted between the new prefix and
the original dataset name. Valid values are:
xxx Prefix to be added (1 to 20 characters). A period
can be specified as part of the OUTPREF value.
NONE Add no prefix to the dataset name. Default.
This parameter can be overridden for specific datasets
using parameter OUTPREF in a dataset group definition.
Note: If a new dataset name exceeds 44 characters, utility
CTTSBD stops processing the current input volume chain.
OUTSUFF Suffix to be added to output dataset names.
A period is inserted between the original dataset name and
the new suffix. Valid values are:
xxx Suffix to be added (1 to 20 characters). A period
can be specified as part of the OUTSUFF value.
NONE Add no suffix to the dataset name. Default.
This parameter can be overridden for specific datasets
using parameter OUTSUFF in a dataset group definition.
Note: If a new dataset name exceeds 44 characters, utility
CTTSBD stops processing the current input volume chain.
OUTCAT Indicates whether the output dataset must be
cataloged. Mandatory. Valid values are:
Y (Yes) The action taken depends on whether the
input and output datasets have the same name.
If the input dataset and the output dataset have the
same name (meaning, no prefix or suffix was added)
catalog the output dataset. If the input dataset was
cataloged, uncatalog it.
If the input and the output datasets do not have the
same name, catalog the output dataset. If the input
dataset was cataloged, it remains cataloged. If the
output dataset name was already cataloged, the utility
stops processing the current input volume chain.
N (No) Do not catalog the output dataset.
RECAT Catalog the output dataset only if the input
dataset was cataloged. Uncatalog the input dataset.

BMC Software, Inc., Confidential and Proprietary Information

7-118

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-49

Parameter

CTTSBD General Utility Parameters (Part 4 of 7)

Description
COPYEXPF Specifies whether input datasets previously
marked as expired by CONTROL-M/Tape are copied during
this run of utility CTTSBD. Optional. Valid values are:
Y (Yes) Copy all datasets to output volumes.
N (No) Do not copy datasets marked as expired.
Default.
Note: If an expired dataset is copied by utility CTTSBD, its
status is changed to ACTIVE (meaning, it is unscratched).
OUTMVLIM Specifies a maximum number of volumes
for multi-volume chains created by utility CTTSBD.
Optional. A value from 1 through 20 can be specified.
Default: 1
Parameter OUTMVLIM in a dataset group definition can
override this parameter for specific datasets.
Note: Datasets can be stacked on volumes (or multi-volume
chains) created in a given run of utility CTTSBD even after
they have been dismounted. If the specified limit is exceeded
during the writing of a multi-volume dataset (for example, due
to inaccurate information about dataset length) utility
CTTSBD continues writing the dataset on as many volumes
as required.
MAXLABEL Specifies a maximum number of datasets to
be stored in an output volume chain created by utility
CTTSBD. A value from 1 through 9999 can be specified.
Default: 100
This parameter can be overridden for specific datasets
using parameter MAXLABEL in a dataset group definition.
Note: Datasets can be stacked on volumes (or multi-volume
chains) created in a given run of utility CTTSBD even after
they have been dismounted.
VAULTED Specifies if selected input volumes that are in
a vault or are scheduled to be vaulted, are processed by
utility CTTSBD. Valid values are:
YES Process vaulted (and to-be-vaulted) volumes.
NO Do not process vaulted (or to-be-vaulted)|
volumes. Default.
ONLY Process only vaulted (and to-be-vaulted)
volumes.
INRET Indicates retention for input datasets. This
parameter specifies how long input datasets are retained
after they are copied. Mandatory. Valid values are:
nnnn Retain input datasets nnnn days before
scratching them. A number from 0 through 9999 can be
specified.
SAME Do not modify type or duration of retention for
input datasets.
Note: If either YES or RECAT is specified for parameter
OUTCAT and the retention type of the input dataset is
CATALOG, the input dataset is expired when it is uncataloged
by utility CTTSBD.
To retain these input datasets for a longer period, you must
indicate a specific retention period using parameter INRET.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-119

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-49

Parameter

CTTSBD General Utility Parameters (Part 5 of 7)

Description
OUTVOLMB Indicates the capacity (in megabytes) of an
output volume. This parameter is most useful for prediction
of utility results when running in simulation mode.
A value from 1 through 1000000 can be specified.
Default: 200
A very large value can be used during simulation to
determine how many logical sets of output datasets are
created by a run of utility CTTSBD. For more information,
see Simulation Reports on page 7-111.
MAXERR Maximum number of allowable severe runtime
errors. Normally when the program encounters a severe
error, utility CTTSBD abandons the current input volume
chain and skips to the next input volume chain. This
parameter can be used to specify a maximum number of
abends that can be encountered during the run of utility
CTTSBD. If the specified number of abends is exceeded,
the utility shuts down. A value from 0 through 100 can be
specified. Default: 1
Note: If MAXERR is set to 0, utility CTTSBD shuts down
when the first severe error is encountered.
CARTCOST Cost of a single volume (cartridge) in the
tape library. This value includes media, slot space,
automated tape library, and management costs. A value
from 1 through 1000000 can be specified. Default:20
This parameter can be used to estimate savings resulting
from a run of utility CTTSBD at your site.
PROCESS Instructions for handling datasets that exist
on the same input volume chain as a dataset that matches
an INCLUDE / EXCLUDE statement. Valid values are:
CHAIN The INCLUDE / EXCLUDE statement applies
to all datasets in the same input volume chain (meaning,
either all or none of the datasets are processed).
Default.
If one or more datasets in an input volume chain match
and INCLUDE statement, all datasets in the chain are
selected.
If one or more datasets in an input volume chain were
rejected by the INCLUDE / EXCLUDE statements, no
datasets in the chain are processed.
DATASET Only datasets that match the specified
INCLUDE selection criteria and are not rejected by
subsequent EXCLUDE statements are processed.

BMC Software, Inc., Confidential and Proprietary Information

7-120

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-49

Parameter

CTTSBD General Utility Parameters (Part 6 of 7)

Description
The following examples describe how parameter PROCESS
can influence the processing of an input volume chain.
All examples below apply to an input volume chain containing
the following datasets:
SYS1 Begins on volume VOL001 and ends on VOL002.
SYS2 Begins on volume VOL002 and ends on VOL003.
SYS3 Resides on VOL003.
Example 1
The following INCLUDE / EXCLUDE statements are
specified:

INCLUDE VOLSER=*
EXCLUDE DSNAME=SYS1
The results are as follows:
If PROCESS is set to CHAIN, none of the datasets are
processed by the utility.
If PROCESS is set to DATASET, only SYS2 and SYS3
datasets are processed by the utility.
Example 2
The following INCLUDE / EXCLUDE statements are
specified:

INCLUDE VOLSER=
INCLUDE DSNAME=SYS3
EXCLUDE DSNAME=SYS1
The results are as follows:
If PROCESS is set to CHAIN, none of the datasets are
processed by the utility.
If PROCESS is set to DATASET, only datasets SYS2 and
SYS3 are processed by the utility.
Example 3
The following INCLUDE / EXCLUDE statements are
specified:

INCLUDE VOLSER=VOL003
The results are as follows:
If PROCESS is set to CHAIN, all datasets (SYS1, SYS2
and SYS3) are processed by the utility.
If PROCESS is set to DATASET, only SYS2 and SYS3
datasets are processed by the utility.
DBGLEVEL

Debug level. A numeric value from 1 through 255 can be

specified.
Use this parameter only if requested by BMC Software
Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-121

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-49

CTTSBD General Utility Parameters (Part 7 of 7)

Parameter

Description

INCLUDE /
EXCLUDE

Statements specifying the volumes and datasets to be used

as input for utility CTTSBD. These statements are specified
immediately after the TYPERUN statement. At least one
INCLUDE / EXCLUDE statement must be specified.
Note: If no INCLUDE statement is specified (meaning, only
EXCLUDE statements are specified) an implicit INCLUDE
statement, which selects all volumes and datasets, is
assumed.
Each INCLUDE / EXCLUDE statement specifies conditions
for the selection of a volume record and/or a dataset record
from the Media Database. If volume and dataset information
are specified in an INCLUDE / EXCLUDE statement, utility
CTTSBD checks each dataset record together with the record
of the each volume in the chain on that the dataset resides.
If a dataset on a volume chain matches an EXCLUDE
statement, the other datasets that exist together with it on the
same volume chain may or may not be processed depending
on the value specified for parameter PROCESS (described
earlier).
The following fields can be specified in INCLUDE / EXCLUDE
statements for utility CTTSBD:
Dataset Record Fields
ACCOUNT
CRECPU
CREPGM
DSEXPDT
DSNAME
SMSMC

BLKSIZE
CREDT
DCHANGED
DSEXPTYP
DSVOLSER
VOLSNUM

BLOCKCT
CREJBN
DSCSIZE
DSLABEL
DUSRDATA

Volume Record Fields

ACTIVEDS
LBLNUM
VAULT
VOLEXPTY
VOLSEQ

MEDIA
LOCATION
VFREEKB
VOLODESC
VOLSER

LACCDT
USERDATA
VOLEXPDT
VOLOWNER
VUSEDKB

These fields enable you to select datasets and volumes according to

application, age, usage, size, free space, and so on.
For more information on these fields and INCLUDE / EXCLUDE statement
format, see Record Selection Logic (INCLUDE / EXCLUDE Statements)
on page 7-6, and the appendix that discusses logical field names for the
CONTROL-M/Tape Repository in the INCONTROL for OS/390 and z/OS
Administrator Guide.

BMC Software, Inc., Confidential and Proprietary Information

7-122

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

The following additional fields are created from information calculated by

utility CTTSBD and can also be specified in INCLUDE / EXCLUDE
statements as selection criteria for input datasets and input volumes:
Table 7-50

CTTSBD Additional Fields

Field

Description

VOLGROUP

Dataset group name.

VOLPCT

Percent of occupied space on a single volume or the last

volume of an input volume chain.
Volumes in a volume chain that are not the last volume of the
chain are always considered 100 percent full.

VOLSBAGE

For volume chains created by a previous run of utility

CTTSBD, the number of days that have passed since the
volume chain was created.

Example
INCLUDE

VOLPCT<5,DSNAME=ACCT.*

Selects all datasets on volume chains in which the last (or only) volume is
less than 5 percent full and contains a dataset with a prefix of ACCT.

Dataset Group Stacking Parameters

Dataset groups are groups of datasets for which special stacking information
is specified. A group name is assigned to each dataset in a sequential
matching process. Each dataset is assigned the group name of the first group
whose description matches the attributes of the dataset. The group name
assigned to each dataset remains assigned to the dataset for the duration of
the current run of utility CTTSBD.
Dataset groups and relevant information are defined in the file referenced by
DD statement CTTSBGRP.
Each dataset group is defined by a GROUP statement followed by one or
more DATASET statements. Many additional statements can be added in any
order to determine how datasets in the group are stacked.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-123

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-51

CTTSBD Dataset Group Statements and Parameters

(Part 1 of 3)

Parameter

Description

GROUP

Statement used to specify characteristics of a dataset group.

This statement is followed by various other statements that
indicate stacking rules for the dataset group. All statements
listed between this GROUP statement and the next GROUP
statement determine stacking rules for this dataset group.
Note: All datasets that are in the same group will not be
stacked together unless the input statement
WITHGRP NAME=SAME is included in the relevant group
definition.
Valid values are:
NAME Name of the dataset group, from 1 through 20
characters. Datasets that satisfy at least one of the
DATASET statements below are assigned this group name.
OUTMVLIM Maximum number of volumes in a chain,
from 1 through 20. Datasets in this group are not added to
multi-volume chains with more than the specified number of
volumes.
Datasets in this group are also not added to a multivolume
chain with the specified number of volumes if the
anticipated dataset size is larger than the remaining space
on the volume.
If no value is specified for this parameter, the value
specified in parameter OUTMVLIM in the TYPERUN
statement of utility CTTSBD is used.
MAXLABEL Maximum number of datasets in an output
volume (or multi-volume chain), from 1 through 999.
Datasets in this group are not added to a volume (or chain)
that already contains the specified number of datasets or
more.
If no value is specified for this parameter, the value
specified in parameter MAXLABEL in the TYPERUN
statement of utility CTTSBD is used.

BMC Software, Inc., Confidential and Proprietary Information

7-124

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-51

Parameter

CTTSBD Dataset Group Statements and Parameters

(Part 2 of 3)

Description
OUTPREF Prefix to be added to the names of output
datasets in this group. A period is inserted between the
new prefix and the original dataset name. Valid values:
xxxPrefix to be added (1 to 20 characters). A period can
be specified as part of the OUTPREF value.
NONEAdd no prefix to the dataset name.
If a value is specified for OUTPREF in the group
definition, that value overrides the OUTPREF value
specified in the TYPERUN statement of utility CTTSBD.
OUTSUFF Suffix to be added at the end of output
dataset names in this group. A period is inserted between
the original dataset name and the new suffix.
xxxSuffix to be added (1 to 20 characters). A period can
be specified as part of the OUTSUFF value.
NONEAdd no suffix to the dataset name.
If a value is specified for OUTSUFF in the group definition,
that value overrides the OUTSUFF value specified in the
TYPERUN statement of utility CTTSBD.
INUNIT Unit name to be used by utility CTTSBD for
allocation of each input dataset in this group. A name of up
to eight characters can be specified.
If a value is specified for INUNIT in the group definition,
that value overrides the INUNIT name specified in the
TYPERUN statement of utility CTTSBD.
OUTUNIT Unit name to be used by utility CTTSBD for
allocation of each output dataset in this group. A name of
up to eight characters can be specified.
If a value is specified for OUTUNIT in the group definition,
that value overrides the OUTUNIT name specified in the
TYPERUN statement of utility CTTSBD.

DATASET

Statement used to determine which datasets belong to the

group.
All datasets that match the specified masks are associated
with the last specified group name. Multiple values specified
in a single DATASET statement have an AND relationship.
Multiple DATASET statements have an OR relationship.
The following fields can be specified:
DSNAMEDataset name or mask.
CREJBNCreating job name or mask.
Note: You can set a default group name by specifying
DATASET DSNAME=* in the last GROUP definition.
For Generation Data Groups (GDG datasets) the last qualifier
(GnnnnVnn) is excluded from the comparison of dataset
names.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-125

CTTSBD Perform Dataset Stacking in Batch Mode

Table 7-51

CTTSBD Dataset Group Statements and Parameters

(Part 3 of 3)

Parameter

Description

WITHGRP

Specifies a dataset group (or groups) with which datasets in

this group are stacked.
grpnameGroup name or mask with which datasets in the
current group are stacked. A name from 1 through 20
characters in length can be specified.
SAMEStack the datasets in the current group with
datasets from the same group.
If more than one WITHGRP statement is included in a group
definition, an OR relationship is assumed (meaning, the
output dataset can be stacked with any of the specified
groups).
If no appropriate output volume (or volume chain) is located,
the dataset is written to a scratch volume.

NOTWGRP

Specifies a dataset group name or mask with which the

datasets in the current group will not be stacked. If more than
one NOTWGRP statement is specified, the output dataset is
not stacked with datasets from any of the specified groups.
grpnameGroup name or mask with which datasets in the
current group are not stacked. A name from 1 through 20
characters in length can be specified.
SAMEDo not stack datasets in the current group with
other datasets from the same group.
OTHERDo not stack datasets in the current group on
volumes with datasets from any other group (meaning,
allow stacking only with datasets from the group specified
in the WITHGRP statement).

NOTWJOB

Specifies a job (or jobs) that create datasets that are not
stacked with the datasets in the current dataset group.
jnameJob name or mask. Datasets in the current group
are not stacked with datasets created by the specified jobs.
Specify a jobname or mask from 1 through 8 characters in
length.
SAMEDo not stack a dataset in the current group with
other datasets that have the same creating job name.

NOTWDSN

Specifies a dataset name or mask with which datasets in the

current dataset group are not stacked.
dsnameDataset name or mask. Do not allow datasets
from the current group to be stacked on volumes with
datasets whose original names match the specified name
or mask.
Prefixes and/or suffixes added to output dataset names are
ignored by this parameter. Utility CTTSBD compares the
specified dataset name (or mask) with the input dataset
names that correspond to the output datasets on the
candidate volumes.
SAMEDo not allow datasets in the current group to be
stacked on volumes containing datasets with the same
original input dataset name.
Note: For Generation Data Groups (GDG datasets) the last
qualifier (GnnnnVnn) is excluded from the comparison of
dataset names.

BMC Software, Inc., Confidential and Proprietary Information

7-126

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

Return Codes
Table 7-52

CTTSBD Return Codes

Code

Description

Utility CTTSBD completed successfully without errors.

Utility CTTSBD completed successfully, but at least one

recoverable error was encountered.

Missing DD statements or an error occurred while opening a

file.

12

Control statement error.

16

Load of CONTROL-M/Tape routines failed.

20

Sort error occurred.

24

Media Database input or output error occurred.

28

Internal error occurred.

32

Error in report printing utility occurred.

40

Authorization error (by security exit).

48

Insufficient storage.

52

Logical error in Media Database.

56

Failure while allocating, opening or processing a dataset.

Examples
Example 1

This example copies all datasets residing on chains whose last volume is less
than 5% utilized. The datasets are divided into three dataset groups that are
stacked separately:

System files (SYS*)

Accounting files (ACCT*)
All other files

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-127

CTTSBD Perform Dataset Stacking in Batch Mode

SYSIN DD Statement Example 1A

TYPERUN MODE=NORMAL,INRET=2,
OUTRET=SAME,OUTPREF=NONE,
OUTSUFF=NONE,COPYEXPF=NO,
OUTMVLIM=3,MAXLABEL=100,
VAULTED=NO,CARTCOST=10,
INUNIT=460,OUTUNIT=461,
MAXERR=30,OUTCAT=RECAT,
COPYATTR=YES,CHAINRET=ANY,
OUTVOLMB=200
INCLUDE DSNAME=*,VOLPCT<5

CTTSBGRP DD Statement (Dataset Group Definitions) Example 1B

GROUP NAME=SYS
DATASET DSNAME=SYS*
WITHGRP NAME=SAME
GROUP NAME=ACCT
DATASET DSNAME=ACCT*
WITHGRP NAME=SAME
GROUP NAME=ALL
DATASET DSNAME=*
WITHGRP NAME=SAME

Example 2

This example unstacks all multi-volume chains that contain at least one
dataset beginning with a prefix of ACCT and whose last volumes are less
than 10% utilized.

SYSIN DD Statement Example 2A

TYPERUN MODE=NORMAL,INRET=2,
OUTRET=SAME,OUTPREF=NONE,
OUTSUFF=NONE,COPYEXPF=NO,
OUTMVLIM=1,MAXLABEL=1,
VAULTED=NO,CARTCOST=10,
INUNIT=460,OUTUNIT=461,
MAXERR=30,OUTCAT=RECAT,
COPYATTR=YES,CHAINRET=ANY,
OUTVOLMB=200
INCLUDE DSNAME=ACCT*,VOLSEQ>1,VOLPCT<10

BMC Software, Inc., Confidential and Proprietary Information

7-128

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Perform Dataset Stacking in Batch Mode

CTTSBGRP DD Statement (Dataset Group Definitions) Example 2B

The sites standard group definitions can be included in this file. Unstacking
is indicated by setting parameter MAXLABEL to 1 (specified in the
TYPERUN Statement) and there is therefore no need for additional group
definitions.
GROUP NAME=ANY
DATASET DSNAME=*

Example 3

This example stacks all datasets with the prefix ACCT and makes sure that
no two datasets with the same name are written to the same output volume
chain.

SYSIN DD Statement Example 3A

TYPERUN MODE=NORMAL,INRET=2,
OUTRET=SAME,OUTPREF=NONE,
OUTSUFF=NONE,COPYEXPF=NO,
OUTMVLIM=3,MAXLABEL=100,
VAULTED=NO,CARTCOST=10,
INUNIT=460,OUTUNIT=461,
MAXERR=30,OUTCAT=RECAT,
COPYATTR=YES,CHAINRET=ANY,
OUTVOLMB=200
INCLUDE DSNAME=ACCT*

CTTSBGRP DD Statement (Dataset Group Definitions) Example 3B

GROUP NAME=ACCT
DATASET DSNAME=ACCT*
NOTWDSN NAME=SAME

Example 4

This example performs a run of utility CTTSBD in simulation mode. In this

run, copying of all the sites datasets from 3480 cartridges to 3590 cartridges
is simulated. New names are assigned to the output datasets.
Dataset groups are determined according to first letter of each input dataset
name.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-129

CTTSBD Perform Dataset Stacking in Batch Mode

SYSIN DD Statement Example 4A

TYPERUN MODE=SIMULATION,INRET=SAME,
OUTRET=7,OUTPREF=TST3590,
OUTSUFF=TST,COPYEXPF=YES,
OUTMVLIM=20,MAXLABEL=999,
VAULTED=NO,CARTCOST=1,
INUNIT=3480,OUTUNIT=3590,
MAXERR=30,OUTCAT=YES,
COPYATTR=YES,CHAINRET=ANY,
OUTVOLMB=30000
INCLUDE DSNAME=*

CTTSBGRP DD Statement (Dataset Group Definitions) Example 4B

Although the NOTWGRP statements in these dataset group definitions may

appear redundant, they are included to protect each group definition from
new or modified group definitions (specifying current group names in
WITHGRP statements) that can be added to the file.
GROUP NAME=GROUP-A
DATASET DSNAME=A*
WITHGRP NAME=SAME
NOTWGRP NAME=OTHER
GROUP NAME=GROUP-B
DATASET DSNAME=B*
WITHGRP NAME=SAME
NOTWGRP NAME=OTHER
GROUP NAME=GROUP-C
DATASET DSNAME=C*
WITHGRP NAME=SAME
NOTWGRP NAME=OTHER
.
.
.
GROUP NAME=GROUP-Z
DATASET DSNAME=Z*
WITHGRP NAME=SAME
NOTWGRP NAME=OTHER

BMC Software, Inc., Confidential and Proprietary Information

7-130

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSCA Dataset Contention Detection

CTTSCA Dataset Contention Detection

Utility CTTSCA analyzes SMF records to detect potential dataset
contentions, meaning, a situation in which two datasets on the same volume
need to be accessed at the same time.
The SMF records processed by utility CTTSCA are read from a sequential
file referenced by DD statement DASMFIN. The sequential file must contain
relevant accumulated type 14 and type 15 SMF records.
Utility CTTSCA performs one or both of the following tasks for each
potential contention:

Creates CONTROL-M/Tape rules that disallow stacking the datasets on

the same volume.

Adds the dataset pair to a report produced by the utility.

Run this utility before implementing the Dynamic Dataset Stacking facility.
Review rules created by the utility and, if appropriate, add them to a rule
table that is listed in CONTROL-M/Tape Rule Table member RULLIST in
the CONTROL-M/Tape PARM library.
After implementing the Dynamic Dataset Stacking facility, run utility
CTTSCA periodically (for example, once a month) to check for new dataset
contentions. How often this utility is run depends on the number of tape
mounts performed daily at your site.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-131

CTTSCA Dataset Contention Detection

Activating the Utility

//EXEC

CTTSCA,RULELIB=rule-library,
RULEMEM=rule-table-name
//DASMFIN
DD DISP=SHR,DSN=smf=flat-file
//SYSIN
DD *
TYPERUN LEVEL={ALL|JOB}[,JOBPREF=prefix][,
DURATION=nn]
RULEINFO CREFULE={YES|NO},RULEPREF=prefix[,
CONTSEAR=Y|N][,MODE=PROD|TEST][,
PRIORITY=nn]
INCLUDE/EXCLUDE STATEMENTS
REPORT NAME=CONFLICT
FIELDS ...
[SORTBY ...]
[ATTR ...]
[BREAK ...]
//

Parameters
The following parameters are supplied using the EXEC statement:
Table 7-53

CTTSCA EXEC Parameters

Parameter

Description

RULELIB

Library to contain CONTROL-M/Tape rules that are created

by the utility.

RULEMEM

Name of the member to contain the CONTROL-M/Tape rules

that are created by the utility.

The following control statements and parameters are supplied using DD

statement SYSIN:

BMC Software, Inc., Confidential and Proprietary Information

7-132

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSCA Dataset Contention Detection

Table 7-54

CTTSCA SYSIN Parameters (Part 1 of 4)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
LEVEL Level of contention to be detected. Mandatory.
Valid values are:
JOB Search only for pairs of datasets that are
accessed
simultaneously by the same job.
ALL Search for all pairs of datasets opened
simultaneously regardless of whether they are accessed
by the same job. This is the recommended value.
JOBPREF Prefix for jobs whose SMF records are
checked for contention problems. A prefix of one to eight
characters can be specified. Optional.
If LEVEL is set to JOB, the utility searches for pairs of
datasets that are accessed simultaneously by the same
job (for jobs with the specified prefix).
If LEVEL is set to ALL, the utility searches for all datasets
that are accessed by jobs with the specified prefix at the
same time as other datasets accessed by jobs with the
specified prefix. Default.
DURATION Tolerated contention duration in minutes.
Optional. Default: 5 minutes.
Contention duration is the amount of time during which a
pair of datasets was simultaneously accessed. For
example, if dataset DSA was accessed from 10:00 until
10:10 and dataset DSB was accessed from 10:05 until
10:30, the duration of contention between these two
datasets is five minutes.
If the detected dataset contention lasts for less than the
specified duration, the contention is tolerated (meaning, no
rule is created to prevent stacking these two datasets
together).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-133

CTTSCA Dataset Contention Detection

Table 7-54

CTTSCA SYSIN Parameters (Part 2 of 4)

Parameter

Description

RULEINFO

Used to specify rule information parameters that affect the

general functioning of the utility. Mandatory. Only one
RULEINFO statement can be specified for each run of utility
CTTSCA.
The following parameters can be included in the RULEINFO
statement.
CRERULE Indicates whether CONTROL-M/Tape rules
are created by the utility. Mandatory.
Y (Yes) Create two rules for each pair of datasets
detected by the utility.
For example, if datasets DSA and DSB are accessed at the
same time, one rule is created to prevent DSA from being
stacked with DSB. Another rule is created to prevent DSB
from being stacked with DSA.
N (No) Do not create rules during this run of utility
CTTSCA.
RULEPREF Prefix for rules created by the utility. The
value of this parameter must be alphanumeric. Maximum
length: 4 characters. Mandatory if CRERULE is set to YES.
CONTSEAR Value to be inserted in the
CONTINUE SEARCH field of CONTROL-M/Tape rules
created in this run of the utility. Optional.
Y (Yes) Set the CONTINUE SEARCH field to Y (Yes).
Default.
N (No) Set the CONTINUE SEARCH field to N (No).
MODE Value to be inserted in the MODE field of
CONTROL-M/Tape rules created in this run of the utility.
Optional.
PROD Set the MODE field to PROD. Default.
TEST Set the MODE field to TEST.
PRIORITY Value to be inserted in the
SEQUENCE PRIORITY field in CONTROL-M/Tape rules
created in this run of the utility. Optional.
The value specified must be two alphanumeric characters.
For more information about valid values for this parameter,
see the rule parameters chapter of the CONTROL-M/Tape
User Guide.
If no value is specified, the SEQUENCE PRIORITY field is
blank in rules created by the utility.

INCLUDE /
EXCLUDE

SMF records that describe tape access are used as input for
utility CTTSCA. The SMF records to be processed by the
utility can be filtered by one or more INCLUDE / EXCLUDE
statements. For more information about INCLUDE /
EXCLUDE statements, see Record Selection Logic
(INCLUDE / EXCLUDE Statements) on page 7-6. Optional.
Values that can be specified in INCLUDE / EXCLUDE
statements of utility CTTSCA are listed in the appendix that
discusses logical field names for the CONTROL-M/Tape
Repository in the INCONTROL for OS/390 and z/OS
Administrator Guide.
If no INCLUDE / EXCLUDE statement is specified for utility
CTTSCA, all SMF records describing actions on tape
datasets are processed by the utility.

BMC Software, Inc., Confidential and Proprietary Information

7-134

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSCA Dataset Contention Detection

Table 7-54

CTTSCA SYSIN Parameters (Part 3 of 4)

Parameter

Description

REPORT

Report to be generated by the utility. Mandatory.

The NAME parameter must be set to CONFLICT.
A contention detection report, produced by the utility, lists all
detected pairs of datasets. The fields in this report are
determined by the FIELDS statement (described below).

FIELDS

Fields that are printed in the report produced by the utility.

Mandatory.
Fields are included in the report produced by the utility in the
order in which they are specified in the FIELDS control
statement. Valid field names:
CPUID1 CPU ID of the first dataset.
CPUID2 CPU ID of the second dataset.
DSNAME1 First dataset name.
DSNAME2 Second dataset name.
DURATION The duration of the detected contention.
JOBNAME1 Jobname of the first dataset.
JOBNAME2 Jobname of the second dataset.
VOLUME1 First volume of the first dataset.
VOLUME2 First volume of the second dataset.
DATE1 Date the first dataset was opened.
DATE2 Date the second dataset was opened.
TIME1 Time of day first dataset was opened.
TIME2 Time of day second dataset was opened.
CRERULE1 Indication whether a rule was generated to
prevent the first dataset from being stacked with the second
dataset.
CRERULE2 Indication whether a rule was generated to
prevent the second dataset from being stacked with the first
dataset.
REASON1 Reason for not creating a rule to prevent the
first dataset from being stacked with the second dataset.
Possible reasons:
USER REQ The user set CRERULE to NO.
TOLERATED The time during which the two datasets
were both accessed was shorter than the time specified for
parameter DURATION.
REASON2R Reason for not creating a rule to prevent the
second dataset from being stacked with the first dataset.
RULENAM1 Name of the rule created to prevent the first
dataset from being stacked with the second dataset.
RULENAM2 Name of the rule created to prevent the
second dataset from being stacked with the first dataset.

SORTBY

Order in which the report is sorted. Optional. Available fields

are listed in under the FIELDS parameter in this table. The /B
(or /BRK) option can be added as a suffix to any field to
indicate that a page break is inserted in the report when the
field changes its value.

ATTR

Override of default attributes defined for a field. For more

information, see the FIELDS parameter in this table. Optional.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-135

CTTSCA Dataset Contention Detection

Table 7-54

CTTSCA SYSIN Parameters (Part 4 of 4)

Parameter

Description

BREAK

Attributes of the summary header lines printed when a field

break occurs. Optional.

Note: For a description of the options of these statements, see the FIELDS,
SORTBY, ATTR, and BREAK statements in CTTRPT Database Extraction and
Report Utility on page 7-58.

Return Codes
Table 7-55

CTTSCA Return Codes

Code

Description

Operation performed successfully.

Report statement not provided. Report not created.

Missing DD statements or open error occurred.

12

An error was detected in a control statement specified to the

utility.

16

Sort error occurred. For more information about the error, see
the SYSOUT file.

20

Loading CONTROL-M/Tape environment failed.

Example
The following example requests detection of all possible contentions,
creation of preventive rules and a contention report.

Example for SYSIN Statements

//SYSIN
DD *
TYPERUN LEVEL=ALL
RULEINFO CRERULE=YES,RULEPREF=NEWR,CONTSEAR=Y
REPORT
NAME=CONFLICT
FIELDS
CPUID1/C3,JOBNAME1/C12,DSNAME1/C23,
DATE1/C69,TIME1/C78,DURATION/C87,
CRERULE1/C98,REASON1/C107,RULENAM1/C119,ID=P
FIELDS
CPUID2/C4,JOBNAME2/C13,DSNAME2/C24,
DATE2/C69,TIME2/C78,
CRERULE2/C98,REASON2/C107,RULENAM2/C119,ID=S
/*

BMC Software, Inc., Confidential and Proprietary Information

7-136

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSCA Dataset Contention Detection

Below is a sample portion of a report produced by utility CTTSCA. Each line

in the report describes a pair of datasets that can be in possible contention.
Rules created by the utility (to prevent Dataset 1 from being stacked together
with Dataset 2 and vice versa) are also listed in this report.
Figure 7-11

CTTSCA Sample Report

BMC SOFTWARE, INC.

CONTROL-M/TAPE REPORT (Ver 6.1.00)

DATE 16/11/2000 TIME 15.30

PAGE

Contention Detection Report

---------------------------

CpuId 1

Jobname 1

Dataset 1

Open
Date 1
CpuId 2 Jobname 2 Dataset 2
Open
Date 2
-------- ---------- --------------------------------------------- -------MVSP
DFHSM
DFHSM.HMIGTAPE.DATASET (GDG)
12/10/00
MVSP
UH56VPM0
HZ.PROD.RDADLSQC.SEQ
12/10/00

Open
Time 1
Open
Time 2
-------08:12:36
08:10:10

Possible
Rule 1
Contention Created?
Duration
Rule 2
Created?
---------- -------00:03:34
NO
YES

Reason 1
Reason 2
---------TOLERATED

Rule
Name 1
Rule
Name 2
-------NEWR0001

MVSP
MVSP

DFHSM
DFHSM

DFHSM.HMIGTAPE.DATASET (GDG)
DFHSM.BACKTAPE.DATASET (GDG)

12/10/00 09:47:19 00:00:44

12/10/00 09:45:58

NO
YES

TOLERATED

MVSP
MVSP

UC95VPM0
DFHSM

HZ.PROD.RDADLSQC.SEQET
DFHSM.HMIGTAPE.DATASET (GDG)

12/10/00 09:47:40 00:01:09

12/10/00 09:47:19

NO
YES

TOLERATED

MVSP
MVSP

UC95VPM0
DFHSM

HZ.PROD.RDADLSQC.SEQET
DFHSM.BACKTAPE.DATASET (GDG)

12/10/00 09:47:40 00:00:23

12/10/00 09:45:58

NO
YES

TOLERATED

MVSP
MVSP

PMS6105M
UC95VPM0

MS.PROD.MGSRT.SEQSEQET
HZ.PROD.RDADLSQC.SEQET

12/10/00 09:48:36 00:05:30

12/10/00 09:47:40

YES
YES

MVSP
MVSP

PMS6105M
DFHSM

MS.PROD.MGSRT.SEQSEQET
DFHSM.HMIGTAPE.DATASET (GDG)

12/10/00 09:48:36 00:00:13

12/10/00 09:47:19

NO
YES

TOLERATED

MVSP
MVSP

PMS6105M
UC95VPM0

MS.PROD.MDSRT.SEQSEQET
HZ.PROD.RDADLSQC.SEQET

12/10/00 09:50:07 00:03:59

12/10/00 09:47:40

NO
YES

TOLERATED

NEWR0002

NEWR0003

NEWR0004
NEWR0005
NEWR0006

NEWR0007

NEWR0008

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-137

CTTSPL Copies or Moves Media Database Records

CTTSPL Copies or Moves Media Database

Records
Utility CTTSPL extracts (meaning, moves or copies) Media Database records
for transfer to a different Media Database. Before using this utility, it is
important to review the information in Split and Merge Processing below.
Note:

There is no need to shut down CONTROL-M/Tape while running

this utility.
Utility CTTMER (used to merge information extracted using utility
CTTSPL) automatically updates the Media Database index
component. There is no need to run utility CTTBIX after running this
utility.

Split and Merge Processing

The split and merge process is the method by which information is extracted
(split) from one Media Database and inserted (merged) into another Media
Database (usually at a different site). This process is especially useful when a
decision is made to join two Media Databases or to split a large Media
Database in two or more smaller Media Databases.
The split and merge process is performed using utilities CTTSPL and
CTTMER.

Utility CTTSPL extracts records from the source Media Database

according to specified selection criteria. This utility can be used with
either of two functions.

Table 7-56

CTTSPL Functions

Function

Description

MOVE

Moves selected records to the extract file and deletes them from
the source Media Database.

COPY

Copies selected records from the source Media Database to the

extract file. The source Media Database is not altered when this
function is specified.

The output of utility CTTSPL (the extract file) is a predefined sequential

file (olpreft.olvert.REPDATA) allocated as one of the
CONTROL-M/Tape operations libraries at time of CONTROL-M/Tape
installation.

BMC Software, Inc., Confidential and Proprietary Information

7-138

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSPL Copies or Moves Media Database Records

Utility CTTMER merges the extracted Media Database records into the
Media Database in the target system. Utility CTTMER uses the extract
file created by CTTSPL as input.

If utility CTTSPL is being used to move (not copy) Media Database records,
the selected records are deleted from the source Media Database.
If the target Media Database is in a different site, the extract file (REPDATA)
produced by utility CTTSPL must be transferred to the target site.

Data Integrity
Utilities CTTSPL and CTTMER do not check Media Database integrity.
It is highly recommended that utility CTTIDB be used to check the integrity
of the source Media Database before execution of utility CTTSPL. To avoid
transfer of data errors to the target Media Database, integrity errors detected
by utility CTTIDB must be fixed in the source Media Database before
execution of utility CTTSPL.
It is also recommended that utility CTTIDB be used after the split and merge
process to check the integrity of the:

Source Media Database after running utility CTTSPL (if the MOVE
function was specified).

Target Media Database after execution of utility CTTMER.

Simulation Mode
Utilities CTTSPL and CTTMER can be executed in simulation mode. In this
mode, no Media Database updates are performed. In simulation mode,
messages are sent to the utility log to record the updates that had been
performed on the Media Database if the utility were running in normal mode.
If the last run of the utility abended, simulation mode is not allowed. If an
attempt is made to run the utility in simulation mode, the utility is terminated
and an appropriate message is displayed.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-139

CTTSPL Copies or Moves Media Database Records

A special restart simulation mode is available for utility CTTMER. For more
information, see the description of the MODE parameter in CTTMER
Merge Records Into the Media Database on page 7-36.
Note:

Since the Media Database is not updated in simulation mode, it is

possible that a run of one of these utilities in simulation mode could
end successfully. However a corresponding run in normal mode
could abend, perhaps due to a lack of free space in the Media
Database.

Volume Status
Utilities CTTSPL and CTTMER do not check volume status. Volume records
are split and merged regardless of volume status. For some volumes (for
example, those with a status of VAULTED or PENDING-VAULT) this can
result in inaccurate slot definitions.
To correct this problem, it is necessary to run utility CTTVTM in SLOTBLD
mode to rebuild the Slot Definition Records. Utility CTTVTM is run against
both the source Media Database and the target Media Database after
completion of the split and merge process.

Recovery from Abends

CONTROL-M/Tape can recover from abends occurring during the run of
utilities CTTSPL and CTTMER. If the utility has abended during update of
the Media Database (deletion of records in utility CTTSPL or addition of
records in utility CTTMER), when the utility is run again it automatically
enters RESTART mode and recovers from the abend.
The extract file (REPDATA) must not be altered (or deleted) prior to restart
of utilities CTTSPL or CTTMER. It is highly recommended that this file be
backed up after each run of utility CTTSPL to facilitate recovery.

Undoing Splits and Merges

You can choose to undo the actions of the Split and Merge utilities as
follows:

BMC Software, Inc., Confidential and Proprietary Information

7-140

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSPL Copies or Moves Media Database Records

Table 7-57

CTTSPL Functions

Function

Description

Splits

If utility CTTSPL was run with the MOVE function, use utility
CTTMER to merge the extracted records from the extract
(REPDATA) file back into the source Media Database. Specify the
source Media Database as the target Media Database.
Note: If the extract file no longer exists but the extracted records
have been merged into the target Media Database, they can be
extracted (copied or moved) from the target Media Database into
another extract file and then merged back into the source Media
Database.
If utility CTTSPL was run with the COPY function, the source
Media Database is unchanged and there is no need to undo
anything.

Merges

To remove records that have been merged into the target Media
Database, use utility CTTSPL with the MOVE function to extract
the necessary Media Database records from the target Media
Database. The selection statements passed to the utility must
include only the volumes added previously by utility CTTMER.

Activating the CTTSPL Utility

Figure 7-12

CTTSPL Activation

//EXEC
CTTSPL
//SYSIN DD *
EXTRACT PATH=ALL
<INCLUDE/EXCLUDE statements>
/*
//DAIN
DD *
TYPERUN FUNCTION=COPY|MOVE[,MODE=NORMAL|SIMULATE][,
DBGLEVEL=XXX]
/*

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-141

CTTSPL Copies or Moves Media Database Records

Parameters
Table 7-58

CTTSPL Parameters

Parameter

Description

EXTRACT
PATH=ALL

EXTRACT statement specified using DD statement SYSIN.

This is the only EXTRACT statement allowed with utility
CTTSPL. Mandatory.

INCLUDE /
EXCLUDE

The scope of the utility can be limited by one or more

INCLUDE and/or EXCLUDE statements.
INCLUDE / EXCLUDE statements are specified immediately
after the EXTRACT statement in the SYSIN DD statement.
For more information, see Record Selection Logic (INCLUDE
/ EXCLUDE Statements) on page 7-6.

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility. Specify this parameter using DD statement
DAIN.
Valid subparameters are:
FUNCTION The function to be performed. Mandatory.
Valid values are:
COPY Records are copied from the source Media
Database to the extract file (REPDATA). Copied records
are not deleted from the source Media Database.
MOVE Records are moved from the source Media
Database to the extract file. Moved records are deleted
from the source Media Database.
MODE The operation mode. Optional. Valid values are:
NORMAL Normal operation mode. Default.
SIMULATE Simulation mode. No changes are made to
the Media Database. Messages are sent to the utility log
to show which changes would have been made to the
Media Database if the run were in NORMAL mode.
Note: The result of running utility CTTSPL in simulation mode
is identical to running it with the FUNCTION parameter set to
COPY. The resulting extract file (REPDATA) can be used as
input for a regular (or simulation mode) run of utility CTTMER.
DGBLEVEL The debug level. A numeric value from 1 to
255 can be specified. Optional.
Note: Use this parameter only if requested by BMC Software
Customer Support.

BMC Software, Inc., Confidential and Proprietary Information

7-142

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSPL Copies or Moves Media Database Records

Examples
Example 1

In this example, utility CTTSPL extracts the records for all volumes
beginning with VOL. The records for the volumes and their associated
datasets are removed (deleted) from the source Media Database and placed in
the extract file (REPDATA) to be used later as input for utility CTTMER.
//EXEC
CTTSPL
//SYSIN DD *
EXTRACT PATH=ALL
INCLUDE VOLSER=VOL*
/*
//DAIN
DD *
TYPERUN FUNCTION=MOVE

Example 2

In this example, utility CTTSPL extracts the records of all datasets beginning
with MY.FILE. The records for these datasets and the associated volumes are
copied (not deleted) from the source Media Database and placed in the
extract file (REPDATA) to be used later as input for utility CTTMER.
//EXEC
CTTSPL
//SYSIN DD *
EXTRACT PATH=ALL
INCLUDE DSNAME=MY.FILE*
/*
//DAIN
DD *
TYPERUN FUNCTION=COPY
/*

Return Codes
Table 7-59

CTTSPL Return Codes (Part 1 of 2)

Code

Description

Operation performed successfully.

Initialization problem.

12

Extract failed.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-143

CTTSPL Copies or Moves Media Database Records

Table 7-59

CTTSPL Return Codes (Part 2 of 2)

Code

Description

16

Split failed.

20

Simulation mode is not allowed while restart is required.

Greater than
20

Severe error the error is accompanied by a message

describing the problem.

BMC Software, Inc., Confidential and Proprietary Information

7-144

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSTK Build and Update Stacking Database

CTTSTK Build and Update Stacking Database

This utility builds and updates the Stacking Database (called the Stacking
Statistics file prior to version 5.1.4). Run the utility on a regular basis using
job CTTDAY.
The utility accepts input from one of the following three types of datasets:

System Management Facilities (SMF) accumulated type 15 records (not

the actual SMF files)

Media Database records

Trace file records

The purposes, advantages, and disadvantages of using Media Database and

Trace file input are described in the table below. SMF type 15 records can be
used to supplement Trace file input, if necessary, to decrease the time
required to accumulate comprehensive statistics in the Statistics Database.
Table 7-60

CTTSTK Media Database and Trace File

Media Database

Trace File (and SMF type 15 Records)

Purpose

To load the Stacking Database when

installing the Dynamic Dataset Stacking
facility.

To update the Stacking Database with the latest

statistics on a daily basis.

Advantages

The Stacking Database has statistics for

most datasets.

All statistics transferred to the Stacking Database

are accurate and up-to-date.

Disadvantages

Some data transferred to the Stacking

Database comes from scratched
dataset records. This data may be
inaccurate and out-of-date.

When the Trace file is full, its oldest records are

overwritten. Consequently, only statistics for
recently used datasets are transferred to the
Stacking Database. It may require several
updates for the Stacking Database to accumulate
comprehensive statistics.

Input records can be selected according to INCLUDE / EXCLUDE

statements, described on page 7-146, supplied to the utility. Record
timestamps are inserted in the dataset. Records from different utility runs
with earlier timestamps are considered duplicate records and are dropped.
Therefore, records with overlapping timestamps from different source
computers must not be supplied to the utility in the same run.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-145

CTTSTK Build and Update Stacking Database

Activating the Utility

//EXEC
CTTSTK
//SYSIN DD *
TYPERUN MODE=SMF|TRC|MDB
<INCLUDE/EXCLUDE STATEMENTS>
//

Parameters
Utility parameters are supplied using DD statement SYSIN:
Table 7-61

CTTSTK Parameters

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Source of input records. Mandatory. Valid values
are:
SMF Input records come from accumulated SMF
type 15 records.
In this mode, parameter SMFIN (supplied to procedure
CTTSTK) specifies the name of a file containing
accumulated SMF records.
TRC Input records come from the Trace file. Use this
mode for regular updates of the Stacking Database as
part of the CONTROL-M/Tape New Day procedure.
MDB Input records come from the Media Database.
Use this mode only for the first run of utility CTTSTK
when the Stacking Database is empty.

INCLUDE / EXCLUDE
The scope of the utility can be limited by one or more INCLUDE /
EXCLUDE statements. The subparameters that can be specified in
INCLUDE / EXCLUDE statements are listed in the appendix that discusses
logical field names for the CONTROL-M/Tape Repository in the
INCONTROL for OS/390 and z/OS Administrator Guide.
For additional information on INCLUDE / EXCLUDE Statements, see
Record Selection Logic (INCLUDE / EXCLUDE Statements) on page 7-6.

BMC Software, Inc., Confidential and Proprietary Information

7-146

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSTK Build and Update Stacking Database

Gathering Statistics for Datasets with Non-specific Retention

Utility CTTSTK gathers additional statistical information for datasets with
non-specific retention (meaning, retention types CYCLES, CATALOG and
LAST ACCESS). The average life span of a scratched dataset with
non-specific retention is calculated by the utility and saved in the Stacking
database. This information is calculated only for datasets that were scratched
during execution of utility CTTRTM. The average life span is not calculated
for datasets that are manually scratched (meaning, scratched by using option
E in the TI screen).
For information about how a datasets average life span is used by the
Dynamic Stacking facility, see the topic that discusses stacking datasets with
non-specific retention in the organization and administration chapter of the
CONTROL-M/Tape User Guide.

Return Codes
Table 7-62

CTTSTK Return Codes

Code

Description

Operation performed successfully.

Input statements missing.

DCB open error occurred.

12

Input statement parsing error occurred.

16

Loading CONTROL-M/Tape environment failed.

20

Sort error occurred.

24

Media Database or Stacking Database or Trace file I/O error

occurred.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-147

CTTSTKR Stacking Statistics Report Utility

CTTSTKR Stacking Statistics Report Utility

Utility CTTSTKR extracts data from the Stacking Database (called the
Stacking Statistics file prior to version 5.1.4) and generates reports from the
extracted data. Various parameters can be used to format and to filter the
report produced by this utility (for example, to describe only statistics for
specified datasets).

Activating the Utility

//EXEC
CTTSTKR
//SYSIN DD *
<INCLUDE/EXCLUDE STATEMENTS>
REPORT NAME=STACKING
FIELDS ...
[SORTBY ...]
[ATTR ...]
[BREAK ...]
//

Parameters
Table 7-63

CTTSTKR Parameters (Part 1 of 3)

Parameter

Description

INCLUDE /
EXCLUDE

The information to be processed can be filtered by one or

more INCLUDE / EXCLUDE statements. Valid values that
can be specified in these INCLUDE / EXCLUDE statements
are listed in the appendix that discusses logical field names
for the CONTROL-M/Tape Repository in the INCONTROL for
OS/390 and z/OS Administrator Guide.
If no INCLUDE / EXCLUDE statement is specified, a report is
created for all records in the Stacking Database.
For more information about INCLUDE / EXCLUDE
statements, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6. Optional.

BMC Software, Inc., Confidential and Proprietary Information

7-148

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSTKR Stacking Statistics Report Utility

Table 7-63

CTTSTKR Parameters (Part 2 of 3)

Parameter

Description

REPORT

The report to be produced by the utility. Mandatory.

NAME Report name. Mandatory. Valid value is:
STACKING Stacking Statistics Report listing all
requested statistics for the CONTROL-M/Tape controlled
datasets.
FOLD Indicates whether all report data is printed in
uppercase. Valid values are:
YES Print all report data in uppercase.
NO Print report data in upper and lowercase.
Default.
PAGESIZE Maximum lines in a page, where p is a
numeric value greater than 20. Optional. Default: 63.
LINESIZE Maximum characters in a line, where s is a
numeric value not greater than 255. Optional. Default: 127.
MARGINS=m-n Lowest (m) and highest (n) columns in a
line, where m is a numeric value greater than 0 and n is a
numeric value greater than m but not greater than s (the
value of LINESIZE). Optional. Defaults: m=1 and n=s.
SUMMARY= YES|NO Indicates whether to show a
summary line for each field break. Optional. Default: NO
A field break occurs when there is a change in value for a
field that is specified in a SORTBY statement with option
/BRK, (or /B).
OUTDD JCL DD name of the output. Default: REPOUT

FIELDS

Fields to print in the report. The fields are printed in the order
specified. Available fields:
JOBNAME Name of the job that created the dataset.
DSNAME Name of the dataset.
STATUS Whether the dataset is stackable.
UNIT Unit name on which the dataset was created.
DENSITY Density with which the dataset was recorded.
OBSERVE Number of observations of the dataset that
were used to determine statistics for the dataset.
MAXSIZE Maximum dataset size in Kilobytes (KB).
MINSIZE Minimum dataset size in Kilobytes (KB).
TOTSIZQ Sum of the square of dataset size for all
previous observations in Kilobytes (KB).
STDDEV Standard deviation (in Kilobytes) of dataset size
for all observations.
AVGSIZEa Average dataset size in Kilobytes (KB).
PREDICTD Predicted dataset size in Kilobytes (KB).
AVGSIZEU Average uncompressed dataset size in
Kilobytes.
PREDICTU Average predicted uncompressed dataset
size in Kilobytes.
LIFEOBS Total number of observations of the dataset
(including observations that were not used to calculate
dataset statistics). This field is relevant only for datasets
with nonspecific retention (for example, CATALOG or LAST
ACCESS).
LIFESPAN Average life span of the dataset in days. This
field is relevant only for datasets with nonspecific retention
(for example, CATALOG or LAST ACCESS).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-149

CTTSTKR Stacking Statistics Report Utility

Table 7-63

CTTSTKR Parameters (Part 3 of 3)

Parameter

Description

SORTBY

Order in which the report is sorted. Optional. (Available fields

are listed above, under parameter FIELDS.) The /B (or /BRK)
option can be added as a suffix to any field to indicate that a
page break is inserted in the report when the field changes its
value.

ATTR

Override of default attributes defined for a field. For more

information, see the FIELDS parameter in this table. Optional.

BREAK

Attributes of the summary header lines printed when a field

break occurs. Optional.

Note: For a description of the options of these statements, see the FIELDS,
SORTBY, ATTR, and BREAK statements in CTTRPT Database Extraction and
Report Utility on page 7-58.
a

Prior to CONTROL-T version 5.1.4, this field was called FOOTAGE.

Return Codes
Table 7-64

CTTSTKR Return Codes

Code

Description

Operation performed successfully.

Missing DD statements or open error occurred.

12

Control card error.

16

Loading CONTROL-M/Tape environment failed.

Example
The following example extracts stacking statistics information and produces
reports for datasets that:

Have a maximum size of less than 70 Kilobytes.

Were created and monitored under the control of CONTROL-M/Tape
less than 15 times (generations).

//EXEC
CTTSTKR
//SYSIN DD *
INCLUDE OBSERVE<15,MAXSIZE<70
REPORT NAME=STACKING
FIELDS JOBNAME,DSNAME,STATUS,DENSITY,MAXSIZE,
MINSIZE,TOTSIZQ,OBSERVE,AVGSIZE
/*

BMC Software, Inc., Confidential and Proprietary Information

7-150

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSTKR Stacking Statistics Report Utility

Figure 7-13

CTTSTKR Output Report Example

1BMC SOFTWARE, INC.

CONTROL-M/TAPE REPORT (VER 6.1.00)

DATE 20/11/2000 TIME 11.21

PAGE

Stacking Statistics Report

--------------------------

Jobname

Dataset name

Stackable?

Density

Maximum Minimum
Size(KB) Size(KB)

-------M27EXIT
M27S
M27STK
M27SVC
N22SB05
N22SB05
N22SB05
N22SB05
N22T01
N22T01
N22T01
N22T01
N65CHAIN
N65DFDSS
N70STACK
N70STACK
N70STACK
N89GENER
N89GENER
N89GENER
N89GENE1

-------------------------------------------M27.NEW.DIMENS
M27.TRY1
M27.TRY1
M27.SVC
N22.SB.F001
N22.SB.F002
N22.SB.F003
N22.SB.F004
N22.SB.F001
N22.SB.F002
N22.SB.F003
N22.SB.F004
N65.TRY.DS
N65.TRY.DFDSS
N70.STACK.DSN1
N70.STACK.DSN2
N70.STACK.DSN3
N89.EXPDT.Y2000.FILE1
N89.NON.SPECIFIC
N89.PERM.FILE1
N89.ACCT.CAT3

---------YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES

-------BPI38KE
BPI38KE
BPI38KE
BPI38K
BPI38KE
BPI38KE
BPI38KE
BPI38KE
BPI38K
BPI38K
BPI38K
BPI38K
BPI38KE
BPI38KE
BPI38KE
BPI38KE
BPI38KE
BPI38K
BPI38K
BPI38K
BPI38K

------2
2
2
2
28
67
28
67
28
67
28
67
2
5
2
2
2
7
7
7
7

------2
2
2
2
28
67
28
67
28
67
28
67
2
5
2
2
2
7
7
7
7

Total
Square
Size
-----4
4
4
4
784
4489
784
4489
784
4489
784
4489
4
25
8
52
4
49
49
49
49

Observations
------1
1
1
1
1
1
1
1
1
1
1
1
1
1
2
13
1
1
1
1
1

Average
Size
(KB)
------1
1
1
1
3
6
3
6
3
6
3
6
1
1
1
1
1
1
1
1
1

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-151

CTTSYNC Synchronize Automated Tape Libraries with the Media Database

CTTSYNC Synchronize Automated Tape Libraries

with the Media Database
The CTTSYNC utility synchronizes information in the CONTROL-M/Tape
Media Database with the database of the automated tape library or Virtual
Tape Server (VTS) machine in use at your site.
This utility automatically performs synchronization with all other automated
tape libraries, such as IBM and StorageTek, used at your site. The
CONTROL-M/Tape installation parameter, RBTTYPE, determines which
automated tape libraries to synchronize with the Media Database.
For more information about the automated tape library and
CONTROL-M/Tape support, see the chapter that discusses the automated
tape library interface in the CONTROL-M/Tape Implementation Guide.
The utility can be used to

Check and update the status (that is, SCRATCH or ACTIVE) of volumes
in the automated tape library database according to their statuses as
indicated in the Media Database.

Check the automated tape library database to determine if volumes in the

Media Database are or are not in the automated tape library and update
the status and location of the volume in the CONTROL-M/Tape Media
Database accordingly.

Perform both of the functions.

The actual operations performed by utility CTTSYNC depend on the value

specified for parameter UPDATE (described below).
When the utility finishes processing, messages describing the results are
issued.
Note:

Depending on the automated tape libraries in use at your site, this

utility usually updates information about the internal location of each
selected volume within the automated tape library.

BMC Software, Inc., Confidential and Proprietary Information

7-152

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSYNC Synchronize Automated Tape Libraries with the Media Database

Activating the Utility

Figure 7-14

CTTSYNC Activation

//EXEC
CTTSYNC
//SYSIN DD *
TYPERUN UPDATE=MDB|RDB|BOTH,MODE=NORMAL|SIMULATION
<INCLUDE/EXCLUDE STATEMENTS>
//

Parameters
The following parameters are supplied using DD statement SYSIN:
Table 7-65

CTTSYNC Parameters (Part 1 of 2)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
UPDATE The type of data to be synchronized.
Mandatory. Valid values are:
MDB Check if volumes that are listed in the Media
Database are in the automated tape library. If necessary,
update the volumes status and location in the Media
Database.
RDB Check the status (meaning, ACTIVE or
SCRATCH) of each volume in the Media Database.
Update the automated tape library database so that it
indicates the same status.
BOTH Perform both of the above described
operations.
MODE Mode in which the utility is run. Optional.
Valid values are:
NORMAL Checks are performed, appropriate
messages are issued and the Media Database or
automated tape library database is updated accordingly.
Default.
SIMULATION Checks are performed and messages
are issued, but the Media Database and automated tape
library database are not updated. This mode can be
used to determine the extent to which the automated
tape library database and Media Database are
out-of-sync without modifying either database.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-153

CTTSYNC Synchronize Automated Tape Libraries with the Media Database

Table 7-65

CTTSYNC Parameters (Part 2 of 2)

Parameter

Description

INCLUDE /
EXCLUDE

The volumes to be processed can be filtered by one or more

INCLUDE / EXCLUDE statements. Valid values that can be
specified in these INCLUDE / EXCLUDE statements are
listed in the appendix that discusses logical field names for
the CONTROL-M/Tape Repository in the INCONTROL for
OS/390 and z/OS Administrator Guide.
If no INCLUDE / EXCLUDE statements are specified for utility
CTTSYNC, all volumes in the Media Database are
processed.
For more information about INCLUDE / EXCLUDE
statements, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6. Optional.

Return Codes
Table 7-66

CTTSYNC Return Codes

Code

Description

Operation performed successfully.

Either warning error messages were reported, or no

automated tape library was defined (the RBTTYPE parameter
was set to NONE.)

Missing DD names or file open error.

12

Error in control statement specified to the utility.

16

Loading CONTROL-M/Tape environment failed.

20

Read or update of the Media Database failed.

24

Automated tape library interface service has failed.

Example
The following example searches for volumes in the Media Database with a
volser prefixed by V001 and then checks the automated tape library database
to determine if these volumes are in the automated tape library. If an
In ATL indication in the Media Database is incorrect, it is updated
accordingly.

BMC Software, Inc., Confidential and Proprietary Information

7-154

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSYNC Synchronize Automated Tape Libraries with the Media Database

Figure 7-15

CTTSYNC Example

//EXEC
CTTSYNC
//SYSIN DD *
TYPERUN UPDATE=RDB
INCLUDE VOLSER=V001*
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-155

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

CTTTPI Tape Initialization, Information Mapping,

and Tape Erasure
The utility provides the following major functions:
Table 7-67

CTTTPI Functions

Function

Description

Safe Tape
Initialization
(INITT)

Initializes tapes and cartridges. Checks that a volume is not

active before initializing it, thereby ensuring that active
volumes are not accidentally initialized.

Media Information
Mapping
(TAPEMAP)

Produces a detailed report about the logical and physical

content of a volume including logical files, labels, tape marks
and unreadable areas (I/O errors).

Safe Tape Erasure

(TAPERAS)

Physically erases the contents of a volume. Checks that a

volume is not active before erasing it, thereby ensuring that
active volumes are not accidentally erased.

These functions are described in detail below.

Multiple jobs or started tasks can run utility CTTTPI in parallel on separate
tape drives for distinct ranges of volume serial numbers.

Safe Tape Initialization Function INITT

Utility CTTTPI protects active volumes from initialization by checking the
specified volume serial number and the mounted volume before creating tape
labels. Volumes are protected regardless of whether they appear in the Media
Database (MDB).
Utility CTTTPI initializes magnetic media (reel tape and cartridges) with
standard labels (SL) or with ANSI standard labels (AL).
The initialization function is generally invoked as a started task using
command:
S

CTTTPI,V=volser,[U=unitname|devnum,]F=INIT

This command invokes the utility with the single control statement:
INITT SER=volser,NUMBTAPE=999

When invoked in this manner, the utility first checks that the specified target
volume serial number is either not in the Media Database or is in the Media
Database with scratch status.

BMC Software, Inc., Confidential and Proprietary Information

7-156

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

If the target volume serial number passes the first check, the utility requests
that the operator mount the physical volume. Once the volume is mounted,
the utility reads it to verify that it is not an active volume in the Media
Database.
If both the specified target volume and the physical mounted volume pass the
checks, the desired label is written on the mounted volume.
If the specified volser is numeric, the utility requests successive volumes in
ascending order until stopped or canceled by the operator.
The utility issues messages (for example, CTT289A) and sometimes prompts
the operator for a reply or decision.
If CONTROL-O or CONTROL-O/PC is installed at your site, responses to
the messages can usually be automated.
Depending on specified parameters, the Media Database can be updated by
the utility.

Media Information Mapping Function TAPEMAP

Utility CTTTPI can produce a detailed report about the logical and physical
content of a volume including logical files, labels, tape marks and unreadable
areas (I/O errors).
This function is especially useful when recovering files and/or data that have
been partially overwritten on magnetic media (for example, a longer file
partially overwritten by a shorter file or multifile volumes in which the first
few files have been overwritten).
The tape mapping function is generally invoked as a started task using
command:
S

CTTTPI,[V=volser,][U=unitname|devnum,]F=MAP

This command invokes utility CTTTPI with the single control statement:
TAPEMAP SER=volser

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-157

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

The TAPEMAP function produces a report that contains a single line for each
of the following elements:
Table 7-68

CTTTPI Elements

Element

Description

VOL1

Volume label.

HDR1

First part (and sometimes the only part) of a header label that
describes a standard label dataset.

HDR2

Second part of a dataset label.

DATA BLOCKS

Actual data portion of a file on the media.

EOF1

First part of a dataset trailer label.

EOF2

Second part of a dataset trailer label.

EOV1

First part of an End-Of-Volume tape label. This element

appears when the preceding standard label dataset continues
on another volume.

EOV2

Second part of an End-Of-Volume tape label.

Tape Mark

Physical indication on the media that separates one physical

file from another and separates standard labels from data.
Two consecutive tape marks commonly determine the logical
end of the recorded area on the media.

I/O Error

Area that could not be read by CTTTPI.

The TAPEMAP function reports information extracted from the above

elements such as the dataset name (meaning, the full dataset name if it does
not exceed 17 characters, or the last 17 characters of a longer dataset name)
creation date, creating job name, block size, physical and logical file
sequence numbers.
Physical file sequence numbers are counted by tape marks. Each tape mark
on the tape indicates an end-of-file. Logical file sequence numbers are
extracted from HDR1. If there is no HDR1 on the tape (for example, an NL
tape) the logical file sequence number is blank.
If a map of the complete media is requested (parameter STOP set to N,
described later) datasets written beyond the present logical end of the
recorded area can be examined.

BMC Software, Inc., Confidential and Proprietary Information

7-158

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Safe Tape Erasure Function TAPERAS

The CTTTPI utility protects active volumes from being erased by comparing
the specified volume serial number and the volser of the mounted volume,
before erasing the data on the tape. Volumes are protected regardless of
whether they appear in the Media Database.
CTTTPI uses an operating system function (Data Security Erase EXCP) to
erase tapes. This function writes a random pattern of data on the specified
tape.
The erase function is generally invoked as a started task using the following
command:
S CTTTPI,V=volser,[U=unitname|devnum],F=ERAS

where

volser is the volume serial number of the tape to be erased

unitname is the type of the unit in which the specified tape is loaded
devnum is the number of the device in which the specified tape is loaded

This command invokes the utility with the following single control statement:
TAPERAS SER=volser,NUMBTAPE=999

When invoked in this manner, the utility first checks that the specified target
volume serial number is either not in the Media Database or is in the Media
Database with scratch status.
If the target volume serial number passes the first check, the utility requests
that the operator mount the physical volume. Once the volume is mounted,
the utility reads it to verify that it is not an active volume in the Media
Database.
The mounted volume is erased only if the volser of the mounted volume
matches the volser specified in the JCL for the utility.
If the specified volser is numeric, the utility requests successive volumes in
ascending order until stopped or canceled by the operator.
The utility issues messages (for example, CTT289A) and sometimes prompts
the operator for a reply or decision. If CONTROL-O or CONTROL-O/PC is
installed at your site, responses to these messages can usually be automated.
Depending on specified parameters, the Media Database can be updated by
the utility.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-159

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

CTTTPI and I/O Error Recovery

Because utility CTTTPI thoroughly examines magnetic tapes in unknown
condition, it may encounter more I/O errors than ordinary programs. In
particular, CTTTPI encounters I/O errors when reading a new tape to which
data has never been written. While CTTTPI handles most of these errors
successfully, the user may observe pertinent error messages originated by the
operating system. Normally these messages can be ignored. If automation
procedures are driven by these messages, you can make adjustments to
exclude tape initialization and media swapping jobs.
To minimize the overhead of I/O error recovery, CTTTPI turns off
DDR/SWAP capability in the allocated device for a short duration while it
reads the label of a mounted tape to be initialized. If CTTTPI is canceled
during that short period, the device may be left in a state where it is not a
candidate for DDR/SWAP.
The operator can increase control over DDR/SWAP using operating system
commands G OFF and G ON.
Note:

In some cases the I/O error encountered by CTTTPI is due to

incompatible recording formats of different device types. To avoid
the destruction of media originally created by another device, take
care when handling the mounted volume, examining the I/O error
messages on the console and in specifying the CTTTPI protection
parameters.

In particular, utility CTTTPI recognizes volumes that have never been

accessed by the occurrence of an I/O error when it reads the label. If a 3480
device attempts to read a cartridge written by a 3490 device, an I/O error
message is issued by the operating system that indicates format
incompatibility, and the cartridge is treated by CTTTPI as a media to which
data has never been written. In some cases the cartridges can be overwritten
by a 3480 device. If your site has both media types and you want enhanced
protection against the accidental mounting of cartridges created by a 3490
device and their re-initialization by a 3480 device, set PROTECT to
PROMPT.

BMC Software, Inc., Confidential and Proprietary Information

7-160

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Activating the Utility

The utility can be activated as a job, started task (STC) or program called
from within another program.
Parameters can be passed to the utility in either of the following ways:

using the EXEC statement.

using the SYSIN DD statement.

However, do not use both methods at the same time.

Passing Parameters using the EXEC Statement

When passing parameters using the EXEC statement, the statement format is:
// EXEC
CTTTPI,V=volser,[U=unitname|devnum,]F=INIT|MAP|ERAS

where

V 6-character volume serial number. Valid for INIT, MAP or ERAS

functions. Optional.

F Function to be performed using default control statements. Valid

functions:
INIT Initialize the tape (reel or cartridge). Create a volume label.
MAP Map the tape: Provide information about the contents of a
reel or cartridge.
ERAS Erase the data on the tape. Write a random pattern from the
beginning until the physical end-of-tape.

U Tape drive to be allocated for use by the utility. Valid values are a
generic or esoteric unit name or a specific device number.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-161

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Passing Parameters using DD Statement SYSIN

When passing parameters using DD statement SYSIN, the syntax is:
//EXEC
CTTTPI
//SYSIN DD *
TYPERUN [MODE=NORMAL|SIMULATION][,
PROTECT=ALL|MDB|PROMPT|NOREAD][,
MDBUPDAT=Y|N][,ADD=N|Y|E|P]
INITT
SER=volser[,DDNAME=ddname][,OWNER=owner][,
NUMBTAPE=number][,LABTYPE=AL][,
ACCESS=char][,ERASE=Y|N][,
MEDIA=media-type][,VENDOR=vendor-name][,
VERSION=version-name]
TAPEMAP SER=volser[,DDNAME=ddname][,
NUMERR=number][,STOP=Y|N][,MODE=S|E]
TAPERAS SER=volser,[DDNAME=ddname][,
NUMBTAPE=number][,ERASELBL=Y|N]

Input Parameters SYSIN DD File

Note:

Throughout the documentation, the term specified volser refers to

the volume serial number specified in parameter SER. The term
mounted volume refers to the physical volume (and its label, if one
exists) that was mounted with the intent of writing a new volume
label on it.

BMC Software, Inc., Confidential and Proprietary Information

7-162

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Table 7-69

CTTTPI SYSIN Parameters (Part 1 of 5)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Optional. Valid only for function INITT.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Controls the operation of function INITT.
Optional. Valid values are:
NORMAL The utility creates labels on the media and
performs other requested functions. Default.
SIMULATION The utility only verifies that the
specified target volume either does not appear in the
Media Database or it appears in the Media Database in
scratch status. The physical mounted volume, however,
is not read and not initialized.
When this mode is used, mounting the target volume is
not required.
PROTECT Controls the protection of the physical
mounted volume. Optional. Valid only for function INITT.
Valid values are:
ALL Default. Protects all mounted volumes, as
follows:
Mounted volumes that are active in the Media
Database are rejected without a prompt to the
operator.
Mounted volumes that are not formatted are accepted
without a prompt to the operator.
Note: Media formatted for a 3490 device is treated as
unformatted by a 3480 device. For more information, see
CTTTPI Tape Initialization, Information Mapping, and Tape
Erasure on page 7-156.
Mounted SL volumes that are not in the Media
Database result in a prompt to the operator.
NL volumes that contain data result in a prompt to the
operator.
A mounted SL scratch volume whose volume serial
number is the same as the specified target volser is
accepted without a prompt to the operator
(re-initializing the existing volume).
A mounted SL volume whose volume serial number
exists in the Media Database in scratch status but
whose volume serial number is not the same as the
specified target volser results in a prompt to the
operator.
MDB Protects mounted volumes only if they are in the
Media Database. The mounted volume is protected in
the same manner as in PROTECT=ALL, except that SL
volumes that are not in the Media Database are
accepted without a prompt.
NOREAD Mounted volumes are not read or otherwise
protected before writing a new label on them.
Note: Verification of the specified target volume serial
number is still performed subject to other parameters.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-163

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Table 7-69

Parameter

CTTTPI SYSIN Parameters (Part 2 of 5)

Description
PROMPT Mounted volumes are read and the operator
is requested to approve the initialization of the mounted
volume.
MDBUPDAT Controls updates to the Media Database
record of the specified target volume. Optional. Valid for
function INITT only. Cannot be used in SIMULATION
mode. Valid values are:
Y (Yes) If the volume is already in the Media
Database, the information in its record is reset,
including volume statistics and information regarding
scratch datasets that have resided on the volume.
Default.
The value of the last job to access the volume is
changed to *CTTTPI*.
If the volume is not in the Media Database and
ADD is set to Y (Yes), the volume record is added
to the Media Database.
N (No) No changes are made to the Media Database
as a result of the initialization process.
If MDBUPDAT is set to N, parameter ADD is
ignored.
ADD Controls the handling of specified volume serial
numbers that are not in the Media Database. Optional.
Valid for function INITT only. Cannot be used in
SIMULATION mode. Valid values are:
N (No) A volume record is not added to the Media
Database. Default.
Y (Yes) A volume record is added to the Media
Database.
E (External) A volume record is added to the Media
Database and marked External.
P (Prompt) The operator is prompted to decide
whether to add a record to the Media Database.

INITT

Initialization function. Controls initialization (or initialization

simulation) of magnetic media volumes. Optional. If this
control statement is used, at least one optional subparameter
must be specified:
SER Volume serial number to be initialized (up to six
alphanumeric characters). Mandatory.
This parameter is identical to the SER parameter in the
IBM utility IEHINITT.
Note: A volume serial number specified with the command
// EXEC CTTTPI,V=volser, or passed to the program
using the expression PARM=CTTTPIV=volser, overrides
this value.

BMC Software, Inc., Confidential and Proprietary Information

7-164

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Table 7-69

Parameter

CTTTPI SYSIN Parameters (Part 3 of 5)

Description
NUMBTAPE Maximum number of tapes to be initialized.
Optional.
After the first specified volume is processed, the numeric
suffix of the volume serial number (if one exists) is
repeatedly incremented by one to generate additional serial
numbers, until the number of tapes initialized equals the
value of NUMBTAPE or until a volume is initialized with a
volser whose suffix is all 9s. NUMBTAPE must be an
integer between 1 and 9999. The default is 1.
OWNER Owner identification to be recorded on the
volume label. Maximum: 10 alphanumeric characters. (This
parameter is identical to the OWNER parameter in IBM
utility IEHINITT.) Optional.
LABTYPE Type of label to create. Optional. (This
parameter is identical to parameter LABTYPE in IBM utility
IEHINITT.) If this parameter is omitted, an IBM standard
label is created. Otherwise, the following value is valid:
ALCreate an ANSI standard label.
ACCESS Protection character for ANSI standard label.
This parameter is identical to the ACCESS parameter of
the IBM utility IEHINITT. Optional.
DDNAME DD name for the tape drive to be used by
CTTTPI. The DD name must start with the characters
CTTTPI. The default value is CTTTPITP. Optional.
MEDIA Volume media name to be recorded in the Media
Database for volumes being added to the Media Database
as part of the initialization process. The media must be
defined in member CTTPARM. If no value is specified, the
media name is derived from the device type of the
assigned tape drive (for example, MEDIA=3480). Optional.
VENDOR Media vendor name to be recorded in the
Media Database for volumes being added to the Media
Database as part of the initialization process. Optional.
VERSION When the LABTYPE parameter is set to AL,
the VERSION parameter indicates whether the format will
be Version 3 or Version 4. This parameter is identical to the
VERSION parameter of the IBM utility IEHINITT. Optional.
ERASE Indicates whether to erase all data on the tape
from after the label until the physical end-of-tape. Valid
values are:
Y (Yes) Erase the data on the tape.
N (No) Do not erase the data on the tape.
Note: Because the ERAS function physically writes a
random pattern of data until the physical end of the tape, a
run of the CTTTPI utility in which ERASE is set to Y (Yes)
can be a time-consuming process.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-165

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Table 7-69

CTTTPI SYSIN Parameters (Part 4 of 5)

Parameter

Description

TAPERAS

Erase function. Controls erase (or erase simulation) of

magnetic media volumes. Optional. These subparameters are
available for this function:
SER Volume serial number to be erased (up to six
alphanumeric characters). Mandatory.
Note: A volume serial number can also be specified with the
command // EXEC CTTTPI,V=volser, or it can be
passed to the program using the expression
PARM=CTTTPIV=volser, which overrides the volser in
the EXEC statement. Both of these statements override the
value specified with the SER parameter.
NUMBTAPE Maximum number of tapes to be erased.
Optional.
After the first specified volume is processed, the numeric
suffix of the volume serial number (if one exists) is
repeatedly incremented by one to generate additional serial
numbers, until the number of tapes erased equals the value
of NUMBTAPE or until a volume is erased with a volser
whose suffix is all 9s. NUMBTAPE must be an integer
between 1 and 9999. The default is 1.
DDNAME DD name for the tape drive to be used by
utility CTTTPI. The DD name must start with the characters
CTTTPI. The default value is CTTTPITP. Optional.
ERASELBL Indicates whether to erase the label of the
volume. Optional.
Y (Yes) ERASE the label.
N (No) Keep the label. Default.

TAPEMAP

Tape mapping function. Optional. If this parameter is used, at

least one optional subparameter must be specified:
SER The volume serial number to appear in the mount
message. This volume serial number does not have to
match the volume serial number recorded on the media.
Optional.
DDNAME The name of the DD statement identifying the
tape drive to be used by CTTTPI. The DD name must start
with CTTTPI. The default value is CTTTPITP. Optional.
NUMERR The number of I/O errors (between 1 and
999) that cause the CTTTPI utility to terminate. Default:1.
Optional.
STOP Controls termination of the TAPEMAP function.
Optional.
Y (Yes) Default. The TAPEMAP function ends when
one of the following occurs:
Logical End-of-Volume, which is indicated either by
two consecutive tape marks, or by an End-of-Volume
label followed by a tape mark
The maximum number of permitted I/O errors,
specified by the NUMERR parameter, has occurred.
N (No) Function TAPEMAP ends only when canceled
by the operator or when it encounters an error it cannot
ignore.

BMC Software, Inc., Confidential and Proprietary Information

7-166

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Table 7-69

Parameter

CTTTPI SYSIN Parameters (Part 5 of 5)

Description
Note: Processing a volume with STOP set to N may
cause unexpected operational problems, such as a tape
running off a reel or unusual I/O errors.
Set STOP to N only in a test environment where unexpected
problems cannot disrupt production.
MODE Controls both the extent of the report produced
by the TAPEMAP function and the way in which this
function reads the tape.
E (Extended) Produces a report on all datasets that
exist on the volume including datasets that exist after
the logical end of data, as discussed in the TAPEMAP
subparameter STOP. When operating in this mode, utility
CTTTPI physically reads every byte on the volume. This
mode is therefore time-consuming. Default.
S (Standard) Produces a report on all datasets that
exist on the volume up to the logical end of data. The
utility scans the datasets on the volume, it does not
physically read the data. This mode is therefore quicker
than Extended mode.
When MODE is set to S, the STOP subparameter is
ignored and field LARGEST BLOCK produced by utility
CTTTPI is set to zero.

Invoking CTTTPI From Another Program

When calling CTTTPI as a program from within another program:

Pass input parameters for CTTTPI using DD statement SYSIN only. Do

not specify input parameters in the JCL EXEC statement.

Linkage and parameter passing conventions for utility CTTTPI are the
same as for IBM utilities. For more information, refer to the IBM Utilities
Manual.

Utility CTTTPI supports substitution of DD names for its SYSIN and

SYSPRINT statements using the same parameters used by IBM utilities.
For more information, refer to the IBM Utilities Manual.

When constructing jobs that invoke CTTTPI, copy the DD statements from
the CTTTPI JCL procedure as follows:
Table 7-70

CTTTPI Statements (Part 1 of 2)

Statement

Description

SYSIN

Input Stream.

SYSPRINT

Output stream for CTTTPI. This DD statement must point to a

SYSOUT file or the results can be unpredictable.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-167

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Table 7-70

CTTTPI Statements (Part 2 of 2)

Statement

Description

DAMDB

Media Database Data component.

DAMDI

Media Database Index component.

DALOG

IOA Log file.

DATRC

CONTROL-M/Tape Trace file.

CTTTPITP

Tape drive for tape initialization.

Activating Utility CTTTPI From the StorageTek Host Software

Component
The initialization program of the StorageTek Host Software Component
(HSC) invokes a media initialization program specific to the site. To indicate
that you want to use the CTTTPI utility for volume initialization, follow the
instructions above and the instructions for the cartridge initialization utility in
the StorageTek reference manual with the following modifications.
1. Specify PROG(ctttpiname) to StorageTek utility SLUADMIN.
where
ctttpiname is either CTTTPI or (if you renamed utility CTTTPI as
described in the final adjustments to CONTROL-M/Tape installation)
IEHINITT.
2. Pass the CTTTPI input control statements to StorageTeks Host Software
Component using DD statement SLSINIT.
3. Specify ****** (six asterisks) for CTTTPI parameter SER.
For a sample JCL that activates utility CTTTPI from StorageTeks HSC
Software component, see Example 2 on page 7-170.
For more information about the CONTROL-M/Tape interface to StorageTek
automated tape libraries, see the Automated Tape Library Interface and
Virtual Tape Server chapter in the CONTROL-M/Tape Implementation Guide.

BMC Software, Inc., Confidential and Proprietary Information

7-168

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Return Codes
Upon completion, CTTTPI returns one of the following return codes (in
register 15):
Table 7-71

CTTTPI Return Codes

Code

Description

Successful completion.

Operator requested termination by typing CANCEL in

response to a program prompt.

The specified target volume is a non-scratch volume in the

Media Database.

12

The Media Database could not be updated.

MDBUPDAT was set to Y (Yes), but the specified target
volume is not in the Media Database and the volume could
not be added (meaning, either ADD was set to N (No), or the
operator responded negatively to the ADD prompt).

16

Syntax error in control statements or parameters.

20

IEHINITT (or the specified substitute) failed or was stopped

by the operator.

24

Error while opening the IOA Log file.

28

Error while loading IOA modules or tables.

32

Unable to open DD file CTTTPIxx for accessing a tape drive.

36

Unable to open DD file SYSPRINT or its replacement.

40

Unable to open DD file SYSIN or its replacement.

44

Error while accessing the Media Database.

48

Erase of INITT failed.

52

TAPERASE command failed.

56

TAPEMAP EXCP command failed.

60

INITT command failed.

64

Automated tape library interface load failed.

68

Unable to change a volume status to active in a 3495 silo.

72

Unable to scratch a volume in a 3495 silo.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-169

CTTTPI Tape Initialization, Information Mapping, and Tape Erasure

Examples
Example 1

Below is a sample of TAPEMAP output with STOP set to N.

15.33.04 CTT704I CONTROL-M/TAPE UTILITY CTTTPI
STARTED
15.33.04 CTT700I
TAPEMAP SER=CTTMAP,STOP=N
VOL1
V=V00001
HDR1
DSN=...NOPOOL.F.G0028V00 FIRST=V00100 VOLSEQ=0002
FILESEQ=0002 CREDT=99346
HDR2
CREAT-JOB=N77MUL01 BLKSZ=00080 LRECL=00080
RECFM=F
TAPE-MARK --------DATA BLOCKS: COUNT=00000005 LARGEST-BLKSZ=00080 LOGICAL-FILE
-SEQ=0002 PHYSICAL-FILE-SEQ=00002
TAPE-MARK --------EOF1
DSN=...NOPOOL.F.G0028V00
EOF2
TAPE-MARK --------TAPE-MARK --------**** LOGICAL END OF RECORDED AREA ****
IO-ERROR
*********
DATA BLOCKS: COUNT=00000051 LARGEST-BLKSZ=03120 LOGICAL-FILE
-SEQ=PHYSICAL-FILE-SEQ=00005
TAPE-MARK --------EOF1 DSN=NNN.TSC1
EOF2
TAPE-MARK --------TAPE-MARK --------. . .

Example 2

The following sample JCL demonstrates how to use utility CTTTPI to

initialize tapes in a StorageTek silo (automated cartridge system), from
another program:
//INITAPE
JOB ,USER,MSGCLASS=X,CLASS=A
//INITT EXEC PGM=SLUADMIN,PARM=MIXED
//STEPLIB DD DISP=SHR,DSN=SYS3.HSC
HCS LOADLIB
//
DD DISP=SHR,DSN=SYS2.IOA.LOAD
CTT LOADLIB
//SLSTAPE DD DISP=NEW,UNIT=(3480,,DEFER)
<=== UPDATE UNIT
//SLSIN
DD *
INITIALIZE CAP(000:00) PROG(CTTTPI) OPT(SCR) CNTLDD(SYSIN)
//SLSINIT DD *
INITT OWNER=ABCD,SER=******
//*
//SLSPRINT DD SYSOUT=*
SLUADMIN MSGS
//SYSPRINT DD SYSOUT=*
CTTPI MSGS
//SYSIN
DD UNIT=DISK,SPACE=(TRK,1)
CTTTPI SYSIN
//CTTTPITP DD UNIT=AFF=SLSTAPE,DISP=NEW
UNIT=AFF=SLSTAPE
//DAMDB
DD DISP=SHR,DSN=SYS2.CTT.MDBD
<=== UPDATE CTT MDBD
//DAMDI
DD DISP=SHR,DSN=SYS2.CTT.MDBI
<=== UPDATE CTT MDBI
//DATRC
DD DISP=SHR,DSN=SYS2.CTT.TRC
<=== UPDATE CTT TRC
//DALOG
DD DISP=SHR,DSN=SYS2.CTT.LOG
<=== UPDATE CTT LOG

BMC Software, Inc., Confidential and Proprietary Information

7-170

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTRB Synchronize Trace File and Media Database Backup

CTTTRB Synchronize Trace File and Media

Database Backup
This utility marks records in the Trace file that are no longer needed, so that
they can be overwritten. Run this utility immediately before and after each
backup of the Media Database and the Trace file.
The Trace file is used primarily to trace actions performed on the Media
Database. When the Trace file becomes full, all CONTROL-M/Tape
functioning is halted and an appropriate message is issued. This situation can
be avoided by running utility CTTTRB on a regular basis. This utility is
called by the CONTROL-M/Tape New Day procedure before and after the
daily backup of the Media Database and the Trace file.

Activating the Utility

//EXEC

CTTTRB,PARM=BKP=START|END

Parameters
Utility parameters are supplied in the JCL PARM library:
Table 7-72

CTTTRB Parameters

Parameter

Description

BKP

Indicates if the Backup procedure is beginning or ending.

Valid value are:
START Backup procedure of Media Database has
started.
END Backup procedure of Media Database has ended.

The steps for implementing utility CTTTRB are as follows:

Step 1

Run the utility before backup of the Media Database and the Trace file. In
this run, set parameter BKP to START. This run of the utility marks the most
recently filled record in the Trace file.

Step 2

Perform the necessary backups. Any local site backup procedures can be
used to perform this task.

Step 3

After the backup has been successfully completed, run utility CTTTRB with
parameter BKP set to END. This run marks all Trace file records before the
record marked in the previous run of the utility (Step 1 above).

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-171

CTTTRB Synchronize Trace File and Media Database Backup

Return Codes
Table 7-73

CTTTRB Return Codes

Code

Description

Operation performed successfully.

DCB open error occurred, TCT load failed or PARM error.

12

I/O error on Trace file occurred.

16

Loading CONTROL-M/Tape environment failed.

Example
//EXEC
//EXEC
...
//EXEC

CTTTRB,PARM=BKP=START
PGM=ADRDSSU
CTTTRB,PARM=BKP=END

BMC Software, Inc., Confidential and Proprietary Information

7-172

INCONTROL for OS/390 and z/OS Utilities Guide

CTTVTM Perform Vault Management

CTTVTM Perform Vault Management

This utility performs vault management functions. Run this utility on a
regular basis using job CTTDAY.
The utility checks each volume records vault specifications in the Media
Database and determines which volumes to move to a new location according
to their vault patterns. The current volume location in the volume record is
updated.
This utility can produce a distribution report at the end of processing, which
lists all volumes that are moved to a new location or assigned a new slot
number.
Note:

Inventory report INVENT is no longer produced by utility

CTTVTM. Instead, this report can be produced as part of the
GENERAL report by utility CTTRPT. For more information, see
CTTRPT Database Extraction and Report Utility on page 7-58.
Utility CTTVTM requires exclusive access to the Media Database.
Real-time jobs that access tapes can be run at the same time as utility
CTTVTM, However, other utilities that access the Media Database
(for example, CTTRTM or CTTIDB) cannot run concurrently with
this utility.

Since the utility handles a large number of Media Database records, a

CANCEL operation, job abend or system crash can lead to logical
inconsistencies in the database. After any of these situations, the next
execution of the utility automatically operates in Restart mode. In Restart
mode, the utility completes execution of the failed process, thereby
eliminating the logical errors from the Media Database. The utility does not
move any additional volumes during Restart execution.
Certain installation parameters (specified in member CTTPARM) determine
how utility CTTVTM operates. Table 7-74 describes these parameters.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-173

CTTVTM Perform Vault Management

Table 7-74

Relevant CONTROL-M/Tape Installation Parameters

Parameter

Description

VLTBYDS1

Specifies which dataset can determine how the vaulting

pattern of a volume is chosen. Valid values are:
Y (Yes) Only the first dataset of the volume determines
the vaulting pattern for the volume. This improves
performance of CTTVTM (and is compatible with other tape
management systems vaulting methods). Default.
N (No) Any dataset can determine the vaulting pattern for
the volume.

SLOTRNG1

Specifies how CONTROL-M/Tape performs the slot

assignment in the vault. Valid values are:
N (No) Each media type is assigned to a separate slot
range. Default.
Y (Yes) All different media types are assigned to a single
slot range in each vault. When using this option you must
define the media 'ALLMEDIA' in each vault definition.
After modifying the SLOTRNG1 parameter, you must invoke
CTTVTM in SLOTBLD mode to build the in-use slot bitmap
inside the Media database.
Note: Before setting this parameter to Y, make sure that no
slot number is being used by more than one volume in the
same vault. Use the CTTMUP utility to assign new slots to
duplicate in-use slots.

CYCLECNT

Defines how to handle cyclic datasets.

EXPDTYPE

Determines expiration logic depending on the type of

retention criteria and value specified:
When DATE or DAYS retention criteria are assigned to a
dataset:
CA1 CA-1 expiration logic applies. DATE or DAYS
specifies the day on that the dataset volumes with vault
until date are moved to the next vault or are returned to
the Active Library (MAINLIB) on the same day as
mentioned in the rule. Default.
TLMS TLMS expiration logic applies. DATE or DAYS
specifies the last day of retention. Volumes only move to
the next vault on the next day, one day later than
mentioned in rule.
NONE Expiration date in standard MVS format.

For additional information refer to Retention and Vault Parameters in the

INCONTROL for OS/390 and z/OS Installation Guide.

BMC Software, Inc., Confidential and Proprietary Information

7-174

INCONTROL for OS/390 and z/OS Utilities Guide

CTTVTM Perform Vault Management

Activating the Utility

//EXEC
CTTVTM
//SYSIN DD *
TYPERUN MODE=NORMAL|SIMULATION[,DATE=date][,
TRACE=YES|NO][,DBGLEVEL=val][,
RESTART=YES|NO][,BOXLIM=num]
TYPEVLT MODE=REGULAR|RECALC|CONVERT|SLOTBLD|BOXBLD[,
RESLOT=YES|NO]
<INCLUDE/EXCLUDE STATEMENTS>
REPORT
NAME=DISTRIB,...
FIELDS...
SORTBY...
ATTR ...
BREAK ...
//

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-175

CTTVTM Perform Vault Management

Parameters
Utility parameters are supplied using DD statement SYSIN:
Table 7-75

CTTVTM SYSIN Parameters (Part 1 of 4)

Parameter

Description

TYPERUN

Used to specify both the parameters that affect the general

functioning of the utility, and the execution mode of the utility.
Mandatory.
Only one TYPERUN statement can be specified for each run
of this utility.
Valid subparameters are:
MODE Operation mode. Mandatory.
NORMAL Normal operation is performed.
SIMULATION Simulation is performed. No actual
changes are made to the Media Database.
DATE Operation date in 6- or 8-character format
according to site standard with separating slashes. (For
example, the date in MDY format can be specified
mm/dd/yy or mm/dd/yyyy). Optional.
The utility assumes that the specified date is the current
date and performs vaulting accordingly. This parameter can
be used together with parameter MODE set to SIMULATE
(described above) to simulate vaulting to be done on a
specific date in the future.
TRACE Specifies whether the Trace file is used during
the CTTVTM run. Optional.
YES The Trace file is used. Default.
NO The Trace file is not used. If NO is specified,
recovery of the lost updates to the Media Database is
impossible. TRACE is set to NO for the run of this utility
during conversion from another product, but is not
otherwise recommended.
DBGLEVEL Debug level. A numeric value from 1
through 255 can be specified. Optional.
RESTART Specifies whether to enable Automatic
Restart mode when the utility is run after an abend or
cancellation of the previous run of the utility. Optional. Valid
values are:
YES Enable Automatic Restart mode. Default.
NO Disable Automatic Restart mode. It is highly
recommended not to set RESTART to NO, as this can
result in integrity errors in the Media Database and loss
of important information.
BOXLIM Minimum number of volumes a box can
contain. If the number of volumes is below the minimum,
the volumes are placed in a slot instead of a box. Optional.
Default:1.

BMC Software, Inc., Confidential and Proprietary Information

7-176

INCONTROL for OS/390 and z/OS Utilities Guide

CTTVTM Perform Vault Management

Table 7-75

CTTVTM SYSIN Parameters (Part 2 of 4)

Parameter

Description

TYPEVLT

Vault management type. Optional if parameter REPORT is

specified. If TYPEVLT is not specified, vault processing is not
performed but reports are produced.
MODE Vault management mode. Valid values are:
REGULAR Vault management is performed according
to the vault patterns currently specified for the volumes
(in Media Database volume records).
RECALC Rule definitions are reloaded and the vault
pattern of each volume is recalculated.
CONVERT This parameter is used following
conversion from another tape management system. Rule
definitions are reloaded, the vault pattern for each
volume is calculated and the current location of each
volume is reserved within the vault pattern.
Note: Basic Scheduling parameters are checked when
rules are loaded, and not when datasets are created or
retention information is updated. Therefore, when running
the CTTVTM utility in RECALC or CONVERT mode,
the rules applied may differ from the rules normally applied
at dataset creation.
For more information, see the discussion of basic
scheduling parameters in the rule parameters chapter of
the
CONTROL-M/Tape User Guide.
SLOTBLD The slot map is built in the Media
Database. This mode cannot be specified if RESLOT is
set to YES.
BOXBLD Box records are built in the Media Database
from the vault definition and volume records. This mode
cannot be specified if RESLOT is set to YES.
Warning! If you specify INCLUDE or EXCLUDE
statements when running the CTTVTM utility in SLOTBLD
or BOXBLD mode, the utility does not re-create the slot or
box bitmaps, but only performs updates.
RESLOT Specifies whether to reassign slot numbers to
vaulted volumes. Optional. Valid values are:
Y (Yes) New slot numbers are assigned.
N (No) Existing slot numbers are preserved. Default.

INCLUDE /
EXCLUDE

The scope of the utility can be limited by one or more

INCLUDE / EXCLUDE statements. INCLUDE / EXCLUDE
statements are specified immediately after the TYPEVLT
parameter and are applied to vault processing. The
subparameters that can be specified in INCLUDE /
EXCLUDE statements are listed in Tables 1 and 2 in Logical
Field Names for the CONTROL-M/Tape Repository in
Appendix D.
For additional information on INCLUDE / EXCLUDE
statements, see Record Selection Logic (INCLUDE /
EXCLUDE Statements) on page 7-6.
Note: With few exceptions, the parameters and options of the
REPORT, FIELDS, SORTBY, ATTR and BREAK statements
are identical to those found in utility CTTRPT. For a complete
description of these parameters and options, see CTTRPT
Database Extraction and Report Utility on page 7-58.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-177

CTTVTM Perform Vault Management

Table 7-75

CTTVTM SYSIN Parameters (Part 3 of 4)

Parameter

Description

REPORT

Activates report utility. Optional if the TYPEVLT parameter is

specified.
NAME Report name. Mandatory. Valid value is:
DISTRIB Distribution Report listing volumes that need
to change location as a result of this utility run.
Note: Inventory report INVENT is no longer produced by
utility CTTVTM. Instead, this report can be produced as part
of the GENERAL report by utility CTTRPT. A sample
Inventory report can be found in member REPINV in the
CONTROL-M/Tape JCL library.
For a description of the other parameters and options of the
REPORT statement, see the REPORT statement in
CTTRPT Database Extraction and Report Utility on
page 7-58.

FIELDS

Fields to print in the report. The fields are printed in the order
they are specified.
The following fields can be printed on the Distribution report:
MEDIA Media type.
POOL Pool name.
VOLSTAT Status(es) of the volume.
VOLSER Volume serial number.
SL-NAME Standard label name of the volume.
VOLCNT Number of volumes in a multi-volume chain.
FIRSTVOL First volser in a multi-volume chain.
FROMLOC From vault location of the volume.
TOLOC To vault location of the volume.
FROMSLOT From slot number in the vault.
TOSLOT To slot number in the vault.
NEXTLOC Next location in the vault pattern.
NEXTLCDT Date the volume is moved to the next
location in the vault pattern.
BOXID Name of the box in which the volume resides.
EXPDT Expiration date.
LBLTYP Label type.
DSNAME Dataset name.
VOLSEQ Volume sequence number.
LOCSEQ Sequence number of the location in the vault
pattern.
CREJBN Creating jobs name.
CREDT Creation date.
CRETM Creation time.
Note: For a description of the options of the FIELDS
statement, see the FIELDS statement in CTTRPT
Database Extraction and Report Utility on page 7-58.

SORTBY

Sort order of the output fields with the options that can be
applied to each field. For more information, see the FIELDS
parameter in this table. Optional.
Note: For a description of the parameters and options of the
SORTBY statement, see the SORTBY statement in CTTRPT
Database Extraction and Report Utility on page 7-58.

BMC Software, Inc., Confidential and Proprietary Information

7-178

INCONTROL for OS/390 and z/OS Utilities Guide

CTTVTM Perform Vault Management

Table 7-75

CTTVTM SYSIN Parameters (Part 4 of 4)

Parameter

Description

ATTR

Override of default attributes defined for a field. For more

information, see the FIELDS parameter in this table. Optional.
Note: For a description of the parameters of the ATTR
statement, see the ATTR statement in CTTRPT Database
Extraction and Report Utility on page 7-58.

BREAK

Attributes of the summary header lines printed when a field

break occurs. Optional.
Note: For a description of the parameters of the BREAK
statement, see the BREAK statement in CTTRPT
Database Extraction and Report Utility on page 7-58.

Return Codes
Table 7-76

CTTVTM Return Codes

Code

Description

Operation performed successfully.

Minor errors detected. For more information, see

accompanying messages.

Major errors detected. For more information, see

accompanying messages.

12

Control card error.

16

Load of CONTROL-M/Tape programs failed.

20

Sort error occurred.

24

Media Database input or output error occurred.

28

Internal error occurred.

32

Error in report printing utility occurred.

36

Rule or vault or pool load failed.

40

Insufficient storage.

44

Authorization failed.

48

Media Database in use by another utility.

52

Missing DD statement or Open failed.

56

Missing box definition record.

BMC Software, Inc., Confidential and Proprietary Information

Chapter 7 CONTROL-M/Tape Utilities

7-179

CTTVTM Perform Vault Management

Examples
Example 1

Vault management is performed according to the current vault pattern

specifications in the Media Database. Report DISTRIB is printed, listing the
MEDIA, VOLSER, VOLSEQ, FROMLOC and TOLOC fields.
//EXEC
CTTVTM
//SYSIN DD *
TYPERUN MODE=NORMAL
TYPEVLT MODE=REGULAR
REPORT NAME=DISTRIB
FIELDS MEDIA,VOLSER,VOLSEQ,FROMLOC,TOLOC
SORTBY FROMLOC/B,TOLOC,VOLSER
//

The report is sorted according to the location from which each volume is
being moved (FROMLOC). The report is then sorted according to the
destination (TOLOC) and the volser name (VOLSER). A page break is
inserted after each FROMLOC location listed in the report (meaning, each
group of volumes from a specific location begins a new page).

Example 2

The location of all volumes whose volume serial numbers start with DIV1 is
modified. The volumes are assigned new slot numbers. Rule definitions are
reloaded to recalculate the vaulting patterns.
//EXEC
CTTVTM
//SYSIN DD*
TYPERUN MODE=NORMAL
TYPEVLT MODE=RECALC,RESLOT=YES
INCLUDE VOLSER=DIV1*
REPORT
NAME=DISTRIB
FIELDS
MEDIA,VOLSER,POOL,FROMLOC,TOLOC
SORTBY
FROMLOC/B,VOLSER,POOL
//

BMC Software, Inc., Confidential and Proprietary Information

7-180

INCONTROL for OS/390 and z/OS Utilities Guide

30

Index
Subparameter Qualifier 3-123

Operator
IOABLCAL Utility 2-5

Symbols
2-5, 5-41
$INDEX Records
CTVDELI Utility 5-66
CTVJAR Utility 5-76
$SIGN Parameter
Testing AutoEdit Syntax 3-7
$SYSDATA Records
CTVJAR Utility 5-76
%%$SIGN
Testing AutoEdit Syntax 3-7
%%RESOLVE OFF
AutoEdit Statement 3-16
%COUNTP Parameter
CTTRPT Utility 7-67
%FIELD Parameter
CTTRPT Utility 7-67
* Character
Job Scheduling 3-68
Subparameter Qualifier 3-125
* Operator
IOABLCAL Utility 2-5
+ Operator
IOABLCAL Utility 2-5
> 2-5
> Symbol
Prefixing 5-41
>W Operator 2-5
? Character

Numerics
3490 Tape Cartridge
CTTTPI Utility 7-160

A
ABFBKP File
CTBABI Utility 4-3
CTBFRM 4-21
ACCESS Parameter
CTTTPI Utility 7-165
ACCOUNT Parameter
CTDSMFRP Utility 5-41
ACT Parameter
CTBDBVIG utility 4-19
Activating CTMCND Utility 2-20
Active Balancing File
Formatting 2-36
Initialization 4-3
Active Jobs File
Changing Size 3-53, 3-63
Cleaning 3-53
Compressing 3-52
CTMRAFL Report 3-77
Active Library
Adding Volumes 7-25
Active Missions File
Changing Size 5-7
Compressing 5-6

BMC Software, Inc., Confidential and Proprietary Information

Index

Active Report List

Copy from Permanent 5-22
Copying 5-11
Deleting Reports 5-25
Active Transfer File
Changing Size 5-10
Compressing 5-9
Active User File
Backup Utility 5-55
ACTIVEDS Parameter
CTTMUP Utility 7-49
ADD Parameter
CTTTPI Utility 7-164
Adding
MDB Volume 7-42
Volumes to MDB 7-25
ADDMODE Statement
IOALDNRS Utility 2-62
Address Space
Checking 6-8
ADDGLOBAL Parameter
CTMBLT Utility 3-26
AGE Parameter
CTVGICL Utility 5-72
Allocating
Trace Files (CTT) 7-21
ALT Parameter
CTVUPGDB Utility 5-83
APF Authorization
CTTGVL Utility 7-30
APPL Parameter
Testing AutoEdit Syntax 3-5
UtilityCTMTBUPD 3-118
ATTR Statement
CTTRPT Utility 7-64
CTTRSM Utility 7-82
CTTRTM Utility 7-96
CTTSCA Utility 7-135
CTTSTKR Utility 7-150
CTTVTM Utility 7-179
AUTOARC Parameter
CTMTBUPD Utility 3-118
AutoEdit Statement
%%RESOLVE OFF 3-16
Automation Log
Backup Utility 6-3
Changing Size 6-3

BMC Software, Inc., Confidential and Proprietary Information

INCONTROL for OS/390 and z/OS Utilities Guide

B
Backup
Automation Log 6-3
MDB and Trace File 7-171
Retention and Volser (CTD) 5-55
BASELEN Parameter
CTVUPGDB Utility 5-83
Batch Stacking
CTTSBD Utility 7-104, 7-106
BKP Parameter
CTTTRB Utility 7-171
BKPFROM Parameter
CTDUPBKP Utility 5-58
BKPMIS Parameter
CTDUPBKP Utility 5-58
CTVJAR Utility 5-77
BKPRESET Utility 5-4
BKPTO Parameter
CTDUPBKP Utility 5-58
BLKSIZE Parameter
IOADBF Utility 2-29
BLOCK Field
CTBVXRF Report 4-31
BLOCKS Parameter
CTBVXRF Utility 4-30
BOXLIM Parameter
CTTVTM Utility 7-176
BREAK Parameter
CTTRTM Utility 7-96
BREAK Statement
CTTRPT Utility 7-67
CTTRSM Utility 7-83
CTTSCA Utility 7-136
CTTSTKR Utility 7-150
CTTVTM Utility 7-179
BUFL Parameter
IOADBF Utility 2-29
Building
Manual Conditions File 2-60
Stacking Statistics File 7-145

C
C Parameter
Utility CTBJAFIG 4-28
CA-1

Compatibility 7-88
Conversion of Retention Information 7-92
Conversion Utility 7-26
CAB Control Block
Emergency Disconnect Utility 2-12
CA-DISPATCH
Converting using CTDUPBKP Utility 5-55
Calendar
CONFCAL Calendar 3-130
DCAL Calendar 3-130
WCAL Calendar 3-130
Calendar Creation
IOABLCAL Utility 2-4
Calendar Facility
Generation 3-17
Calendar Generation
CTMBLDAE Utility 3-16
Calendar Name / Job Name Cross Ref
CTMXRF Utility 3-133
Calendar Option
Primary Option Menu 2-4
Calendar/Job Name Report
CTMXRF Utility 3-130
CALENDR Field
Job Flow Report 3-92
CALL Command
CTTGVL Utility 7-31
CALLIB Parameter
CTMBLDAE Utility 3-17
CALMEM Parameter
CTMBLDAE Utility 3-17
CATALOG Retention
CTTSTK Utility 7-147
Cataloging
Datasets (Utility CTTRCV) 7-55
CATEGORY Parameter
CTDSMFRP Utility 5-41
CTDUFUPD Utility 5-50
CTMTBUPD Utility 3-118
CA-TLMS
Compatibility 7-88
Conversion of Retention Information 7-92
Conversion Utility 7-26
CCIFRES DD Statement
CTDCCFRS Utility 5-14
CCIFRES Utility
NEW Parameter 5-15
UPD Parameter 5-15

CDAM
Deleting Files 5-17
CDAM File
CTVJAR Utility 5-76
CHANGETO Parameters
CTDUPBKP Utility 5-59
Character Prefixing
Prefixing 5-41
CHARS Parameter
CTDUFUPD Utility 5-51
CHART Parameter
CTMRFLW Report 3-87
CHECK Parameter
CTTMUP Utility 7-41
CHKINDT Field
SCRATCH Report 7-94
CHKPTID Parameter
CTVUPGDB Utility 5-82
CLASS Parameter
CTDUFUPD Utility 5-50
Cleaning
Active Jobs File 3-53
Global Indexes 5-71
History User Report List 5-20
Migrated Report List 5-64
CLEANUP Function
CTMCAJF Utility 3-49
Cleanup Utility 3-113
CMD Parameter
IOATEST Utility 2-67
COLUMN Parameter
CTTRPT Utility 7-67
Combinatorial Logic
IOABLCAL Utility 2-5
Commands
JES3 2-65
LIST 3-7
SUBMIT 3-7
SUBSCAN 3-7
COMP-CODE Field
CTVJAR Parameter 5-76
Compiling
Rule Definitions (CTB) 4-4
COMPRESS Function
CTMCAJF Utility 3-49
Compressing
Active Jobs File 3-52
Active Missions File 5-6

BMC Software, Inc., Confidential and Proprietary Information

Index

Active Transfer File 5-9

Condition Code
CTMBLT Utility 3-34
Condition Name Cross Ref
CTMXRF Utility 3-134
Condition Names Report
CTMXRF Utility 3-130
Conditions File
IOACND Utility 2-17
CONDITIONS Parameter
CTMRSTR Utility 3-111
Conditions/Resources
Date References 3-123
IOACND Utility 2-17
Parameters 3-121
Partial Name Changes 3-125
Updating 3-124
CONFCAL Calendar
Description 3-130
CONFCAL Parameter
CTMTBUPD Utility 3-118
CONFIRM Parameter
CTMTBUPD Utility 3-118
Control Resource
Adding 2-17
Cross Reference List 3-85, 3-96
Deleting 2-17
Job Flow Report 3-85
Control Statements
CTTMUP Utility 7-41
CONTROL-D
Utilities 5-1
CONTROLD Statement
IOACLCND Utility 2-15
IOALDNRS Utility 2-62
CONTROL-D Utilities
Summary 1-6
CONTROL-M
Active Jobs File 3-49
CONTROL-M Monitor
CTMRSTR Utility 3-111
CONTROL-M Resource file 3-83
CONTROLM Statement
IOALDNRS Utility 2-61
CONTROL-M Utilities
Summary 1-3
CONTROL-M/Analyzer
Compile Rule Definitions 4-4

BMC Software, Inc., Confidential and Proprietary Information

INCONTROL for OS/390 and z/OS Utilities Guide

Database Integrity 4-19

Deleting Variables 4-17
Initialize Active Balancing File 4-3
Rebuild Index 4-8
Rule Activity File Integrity 4-28
Variable Generations 4-11
CONTROL-M/Tape
Utilities 7-6
Utility Statement Syntax 7-6
CONTROL-M/Tape Utilities
Summary 1-8
CONTROLO Parameter
CTMRFLW Report 3-87
CONTROL-V
Utilities 1-6
CONTROLB Utilities
Summary 1-4
CONTROLO
Simulation Utility 6-19
Utilities 6-6
CONTROLO Utilities
Summary 1-7
CONVC4MD Job
CTTDLD Utility 7-26
CONVC5MD Job
CTTDLD Utility 7-26
Conventions Used in This Guide xxxiv
CONVERT Mode
CTTVTM Utility 7-177
Converting
Volume Records 7-25
CONVLCTL Job
CTTDLD Utility 7-26
CONVRMDB Job
CTTDLD Utility 7-26
CONVTMDB Job
CTTDLD Utility 7-26
COPY Parameter
CTBDBVCG Utility 4-11
CTBDBVCP Utility 4-15
CTDUFUPD Utility 5-51
Copying
Active Report List 5-11
CTB File 4-5
Database Records 7-138
IOA Log File 2-25
Message Statistics File 6-6
Trace File (CTT) 7-14

Variable Files (CTB) 4-14

COPYTOLOG Parameter
IOACPLOG Utility 2-26
COPYTOSEQ Parameter
IOACPLOG Utility 2-25
COSMOS
CTOCTI Utility 6-11
COUNT Field
Message Statistics Screen 6-16
COUNT Parameter
CTTRPT Utility 7-67
CREDS Field
SCRATCH Report 7-94
CREFABF Job
CTBABI Utility 4-3
CREFBKP Job
CTBABI Utility 4-3
Cross Reference
CTMRFLW Report 3-85
CTMXRF Utility 3-130
Prerequisite Condition 3-95
Quantitative Resource 3-97
CTBABI Utility 4-3
Active Balancing File 4-3
Summary 1-5
CTBCMP Utility 4-4
Compile Rules 4-4
CTBDBCP Utility 4-5
Copy CTB File 4-5
Description 4-5
Summary 1-4
CTBDBIB Utility 4-8
Rebuild CTB Index 4-8
Summary 1-5
CTBDBST Utility
Summary 1-5
CTBDBVCG Utility 4-11
Summary 1-5
Variable Generations 4-11
CTBDBVCP Utility 4-14
Copy CTB Variables 4-14
Summary 1-4
CTBDBVDL Utility 4-17
Deleting Variables 4-17
Sujmmary 1-4
CTBDBVIG Utility 4-19
Summary 1-5
Variable File Integrity 4-19

CTBFRM Utility 4-21

Description 4-21
Summary 1-5
CTBJAFCP Utility 4-23
Rule Activity File 4-23
Summary 1-5
CTBJAFDL Utility 4-26
Rule Activity File 4-26
Summary 1-5
CTBJAFIG Utility 4-28
Rule Activity File Integrity 4-28
Summary 1-5
CTBVXRF Utility
Activating 4-31
Description 4-30
CTDAMUTI Utility
Summary 1-6
CTDBLXRP Utility 5-5
Description 5-5
Summary 1-6
CTDCA2P Utility 5-11
Copy User Report List 5-11
Summary 1-6
CTDCAMF Utility 5-6
Compress Active Missions File 5-6
Summary 1-6
CTDCATF Utility 5-9
Compress Active Transfer File 5-9
Summary 1-6
CTDCCFRS Utility 5-14
Description 5-14
INCLUDE/EXCLUDE Statements 5-16
Summary 1-6
CTDCCU Utility 5-17
Deleting CDAM Files 5-17
CTDCLHIS Utility 5-20
Clean History Report List 5-20
Summary 1-6
CTDCP2A Utility 5-22
Copy User Report List 5-22
Summary 1-6
CTDDELRP Utility 5-25
Deleting Reports 5-25
Summary 1-6
CTDDIB Utility 5-34
Access Method Index 5-34
Summary 1-6
CTDDIG Utility 5-36

BMC Software, Inc., Confidential and Proprietary Information

Index

Description 5-36
Summary 1-6
CTDSMFRP Utility 5-41
Description 5-41
Example 5-41
PaperUsage Report 5-41
Summary 1-6
CTDUFUPD Utility
Description 5-45
Example 5-52
Parameters 5-48
Summary 1-6
CTDUFUPDUtility
Work Flow 5-51
CTDULD Utility 5-54
Description 5-54
Summary 1-6
CTDUPBKP Utility 5-55
Backup Retention and Volser Info 5-55
Converting from CADISPATCH 5-55
DD Statement RECVOL 5-55
NEWBKP Parameter 5-60
NEWMIG Parameter 5-60
Summary 1-6
CTMAESIM
Invoking from a batch JCL 3-9
Invoking from another program 3-9
CTMAESIM Utility
Description 3-5
LIST Command 3-7
Summary 1-3
CTMAS
CTMRSTR Utility 3-111
CTMBGRP Utility 3-13
Group Scheduling Table 3-34
Group Scheduling Tables 3-13
Summary 1-3
CTMBLDAE Utility
CTMRCAL Calendar 3-78
Example 3-18
Summary 1-3
CTMBLT Utility
Called From Another Program 3-30
General Parameters 3-23
Job Scheduling 3-29
Job Scheduling Parameters 3-24
Parameter Syntax 3-23
Special Parameters 3-24

BMC Software, Inc., Confidential and Proprietary Information

INCONTROL for OS/390 and z/OS Utilities Guide

Summary 1-3
CTMCAJF Utility 3-49
Active Jobs File 3-49
Summary 1-3
CTMJDS Procedure
CTMRJDS Report 3-136
CTMJOB
CNTERCRD 3-66
Dynamic Insertion Facility 3-68
CTMJOB Utility
Description 3-65
Example 3-72
Formats 3-67
Parameter Syntax 3-68
Summary 1-3
CTMJSA Utility 3-74
Description 3-74
Summary 1-3
CTMJTXRF Utility 3-131
Job Name / Table Name Xref Report 3-131
CTMRAFL Report
Comparison with CTMRPFL 3-104
Description 3-77
CTMRCAL Utility 3-78
Description 3-78
Example 3-79
Summary 1-3
CTMRELRS Utility 3-80
Description 3-80
Example 3-82
Summary 1-3
CTMRES 3-83
CTMRFLW Report
Comparison with CTMRPFL 3-104
Description 3-85
Example 3-91
JCL 3-86, 3-89
LINESIZE Parameter 3-88
MAXCARDS Parameter 3-88
PAGESEQ Parameter 3-88
PAGESIZE Parameter 3-88
Parameters 3-86
TABLES Parameter 3-88
CTMRJDS Report
Dataset Cross Reference 3-136
CTMRLR Program
Example 3-82
Quantitative Resource Release 3-80

CTMRNSC Report
Description 3-98
Example 3-100
JCL 3-98
Parameter 3-98
CTMROGR Report
Description 3-100
JCL 3-102
Parameters 3-101
CTMRPFL Report
Description 3-104
CTMRPLN Report
Comparison with CTMRPFL 3-104
Description 1-4, 3-106
IGNORE CALENDAR Parameter 3-107
JCL 3-107
JOBSDD DD Name 3-106
Parameters 3-106
REPEND Parameter 3-106
REPSTART Parameter 3-106
RETYPE Parameter 3-106
SORTBY Parameter 3-106
TABLES Parameter 3-107
CTMRSTR Utility 3-111
Description 3-111
Summary 1-4
CTMSCH DD Statement 3-126, 3-132
CTMSIM Utility 1-4
Summary 1-4
CTMSLC Utility
Control Statement Syntax 3-113
Definition of Old Job 3-113
Generally 3-113
NORMAL Mode 3-114
SIMULATION Mode 3-114
Summary 1-4
CTMTAPUL Utility
Summary 1-4
CTMTBUPD Utility 3-116
Job Scheduling Table Update 3-116
Summary 1-4
Update Parameters 3-118
CTMXREF Utility
Control Statements 3-132
CTMXRF Report
Condition Name Cross Ref 3-134
CTMXRF Utility 3-132
Calendar Name / Job Name Cross Ref 3-133

Description 3-130
Due Out Time / Job Name Cross Ref 3-134
From Time / Job Name Cross Ref 3-134
JCL 3-132
Job Name / Table Name Cross Ref 3-133
Job Name Cross Ref 3-134
Library Name / Job Name Cross Ref 3-135
Resource Name / Job Name Cross Ref 3-133
Schedule Tag / Job Name Cross Ref 3-134
Until Time / Job Name Cross Ref 3-134
CTOALOCP Utility 6-3
Back Up Automation Log 6-3
CTOCOLBF Job
Variable Databae Column File 2-36
CTOCSF Utility 6-6
Copy Statistics File 6-6
Summary 1-7
CTOCSFJ Member
Message Statistics 6-6
CTOCTA Utility 6-8
Check Address Space 6-8
Summary 1-7
CTOCTI Utility 6-10
Generate SYSIMAGE Input 6-10
Summary 1-7
SYSIMAGE Facility 6-12
CTODBSBF Job
Variable Database Definition File 2-36
CTOMVDSC Job
Emergency ON MVALERT Disconnect 6-17
CTOMVDSC Utility 6-17
Emergency ON MVALERT Disconnect 6-17
CTOOBJFL File
CONTROL-O PARM Library 6-11
CTORSTM Utility 6-14
Message Statistics Report 6-14
Summary 1-7
CTOSMDSC Job
Emergency ON SMS Disconnect 6-18
CTOSMDSC Utility 6-18
Emergency ON SMS Disconnect 6-18
Summary 1-7
CTOTEST Utility 6-19
Simulate CTO Environment 6-19
Summary 1-7
CTOUSDSC Job
Emergency USS Support Disconnect 6-23
CTOUSDSC Utility 6-23

BMC Software, Inc., Confidential and Proprietary Information

Index

Emergency USS Support Disconnect 6-23

CTOUSMDSC Utility
Summary 1-7
CTTACP Utility 7-14
Copy Trace File 7-14
CTTAFR Utility 7-17
Format/Initialize Trace File 7-17
Summary 1-8
CTTBIX Utility 7-18
Rebuild MDB Index 7-18
Summary 1-8
CTTCCU Utility
Summary 1-6
CTTCRDF Utility
Summary 1-9
CTTCTRC Utility 7-21
Allocate/Format Trace File 7-21
Summary 1-8
CTTDBDLD Utility
Summary 1-9
CTTDBDUL Utility
Summary 1-9
CTTDBIB Utility 7-23
Rebuild Stacking Statistics Index 7-23
Summary 1-9
CTTDBID Utility
Summary 1-9
CTTDBII Utility
Summary 1-9
CTTDBPRT Utility
Summary 1-9
CTTDLD Utility 7-25
Add/Delete/Convert Volumes 7-25
Summary 1-8
CTTGVL Utility 7-30
Description 7-30
Summary 1-8
CTTIDB Utility 7-33
Description 7-33
Summary 1-8
CTTMEDDF Installation Parameter
CTTSBD Utility 7-113
CTTMER Utility 7-36
Merge Records 7-36
Summary 1-8
CTTMUP Utility 7-39
Examples 7-49
Field/Value Specification 7-48

BMC Software, Inc., Confidential and Proprietary Information

INCONTROL for OS/390 and z/OS Utilities Guide

Return Codes 7-49

Summary 1-8
CTTRBXLC Report
CTTRPT Utility 7-72
CTTRCHK1 Report
CTTRPT Utility 7-71
CTTRCLN Report
CTTRPT Utility 7-71
CTTRCV Utility 7-52
Examples 7-56
MDB Recovery 7-52
Return Codes 7-56
Summary 1-8
CTTRDCRE Report
CTTRPT Utility 7-71
CTTRDELV Report
CTTRPT Utility 7-71
CTTRDUPD Report
CTTRPT Utility 7-71
CTTREDM Report
CTTRPT Utility 7-71
CTTRFSCR Report
CTTRPT Utility 7-71
CTTRINV Report
CTTRPT Utility 7-71
CTTRINVT Report
CTTRPT Utility 7-71
CTTRLACV Report
CTTRPT Utility 7-71
CTTRLAVJ Report
CTTRPT Utility 7-71
CTTRLRTV Report
CTTRPT Utility 7-71
CTTRM10V Report
CTTRPT Utility 7-71
CTTRM25D Report
CTTRPT Utility 7-71
CTTRMACV Report
CTTRPT Utility 7-71
CTTRMOVW Report
CTTRPT Utility 7-71
CTTRNRTR Report
CTTRPT Utility 7-72
CTTROUTL Report
CTTRPT Utility 7-71
CTTRPT Utility 7-58
Report Generation 7-58
Sample Reports 7-70

Summary 1-9
CTTRRCLV Report
CTTRPT Utility 7-71
CTTRRTNP Report
CTTRPT Utility 7-71
CTTRSCRD Report
CTTRPT Utility 7-71
CTTRSM Utility 7-79
Description 7-79
Summary 1-8
CTTRTM Utility 7-84
Condition Codes 7-96
CTTSBD Utility 7-103
Examples 7-97
Parameters 7-90
Retention Management 7-30, 7-84
Summary 1-8
CTTRUTIL Report
CTTRPT Utility 7-71
CTTRVBOX Report
CTTRPT Utility 7-71
CTTRVUPD Report
CTTRPT Utility 7-71
CTTRWDCP Report
CTTRPT Utility 7-71
CTTSBD Utility 7-100
Description 7-100
Parameters 7-115
Summary 1-8
CTTSBGRP DD Statement
CTTSBD Utility 7-123
CTTSCA Utility 7-131
Description 7-131
Summary 1-8
CTTSPL Utility 7-138
CTTMER Utility 7-36
Extract MDB Info 7-138
Summary 1-8
CTTSTK Utility 7-145
Build/Update STK File 7-145
Summary 1-8
CTTSTKR Utility 7-148
Description 7-148
Summary 1-8
CTTSYNC Utility 7-152
Description 7-152
Summary 1-8
CTTTPI Utility 7-156

Activation 7-161
Examples 7-170
Invoking 7-167
Return Codes 7-169
StorageTek Robot Support 7-168
Summary 1-9
Tape Init/Erase/Mapping 7-156
CTTTPITP DD Statement
CTTTPI Utility 7-168
CTTTRB Utility 7-171
Backup MDB and Trace File 7-171
Summary 1-8
CTTVTM Utility 7-173
CTTSBD Utility 7-104
Examples 7-180
Summary 1-8
Vault Management 7-173
CTTX006 User Exit
CTTRTM Utility 7-87
CTTX008 User Exit
CTTRTM Utility 7-87
CTTX011 User Exit
CTTSBD Utility 7-103
CTVCLMIG Utility 5-64
Clean Migrated Report List 5-64
Summary 1-6
CTVDELI Utility 5-66
Deleting DASD Index Files 5-66
Summary 1-6
CTVGICL Utility 5-71
Clean Global Indexes 5-71
Summary 1-6
CTVJAR Utility 5-76
Description 5-76
Summary 1-6
CTVUNMIG Utility 5-79
Summary 1-6
CTVUNMIG Utiltiy
Description 5-79
CTVUPGDB Utility
Example 5-84
Global Index Database 5-81
Parameters 5-81
Return Codes 5-84
Summary 1-7
CYCLE Type Retention
CTTSBD Utility 7-103
CYCLECNT Parameter

BMC Software, Inc., Confidential and Proprietary Information

Index

CTTPARM Member 7-88

CYCLES Retention
CTTSTK Utility 7-147
Cyclic Job
Job Flow Report 3-93

D
D Parameter
IOADBF Utility 2-28
DA34F DD Statement
IOAOPR Utility 2-65
DAALPPRM DD Statement
CTOALOCP Utility 6-3
DABCLIN DD Statement
IOABLCAL Utility 2-5
DACAL DD Statement
Calendar Library 3-78
DACMD DD statement
CTBVXRF Utility 4-30
DACOPPRM DD Statement
CTDCAMF Utility 5-6
CTMCAJF Utility 3-49, 3-62
DACRSIN DD Statement
IOACLCND Utility 2-13
DAFILE DD statement
IOADBF Utility 2-29
DAFLWPRM DD Statement
CTMRFLW Report 3-87
DAINPRM DD Statement
CTMBLT Utility 3-22, 3-33
CTMTBUPD Utility 3-126
DAJOB DD Statement
CTMJOB Utility 3-65, 3-72
DALCPPRM DD Statement
IOACPLOG Utility 2-25
DALOG DD Statement
CTMBGRP Utility 3-14
CTTTPI Utility 7-168
IOACPLOG Utility 2-26
DALOGCUR DD Statement
IOACPLOG Utility 2-25
DALOGSEQ DD Statement
Copy IOA Log 2-25, 2-26
DAMDB DD Statement
CTTTPI Utility 7-168
DAMDI DD Statement

BMC Software, Inc., Confidential and Proprietary Information

10

INCONTROL for OS/390 and z/OS Utilities Guide

CTTTPI Utility 7-168

DANSCPRM DD Statement
CTMRNSC Report 3-98
DAOGRPRM DD Statement
CTMROGR Report 3-101
DAPLNJOB DD Statement
CTMRCAL Utility 3-79
DAPLNPRM DD Statement
CTMRPLN Report 3-106
DAPRINT DD Statement
CTMBLT Utility 3-33
DARELIN DD Statement
CTMRELRS Utility 3-81
DAREPIN DD Statement
CTORSTM Utility 6-14
DASD
Deleting Index Files 5-66
DASIM DD Statement
CTMAESIM Parameters 3-5
DASMFIN DD Statement
CTTRSM Utility 7-79
CTTSCA Utility 7-131
Data Extraction
Media Database 7-58
Data File Parameters
CTTCTRC Utility 7-21
DATABERR DD Statement
CTMBLT Utility 3-33
Dataset Group Stacking
CTTSBD Utility 7-123
Dataset Groups
CTTSBD Utility 7-106
Dataset Job Cross Reference
CTMRJDS Report 3-136
DATASET Parameter
CTTGVL Utility 7-31
DATE Field
CTVJAR Parameter 5-76
DATE Parameter
CTDCCU Utility 5-17
CTTRTM Utility 7-90
CTTVTM Utility 7-176
ORDER Record 3-68
Date Range
IOA Log 2-25
Date Reference
Conditions/Resources 3-123
DATES Parameter

CTMTBUPD Utility 3-119

DATRC DD Statement
CTTTPI Utility 7-168
DAXREF File
CTMRCAL Utility 3-78
DAXRFIN DD Statement
CTMXRF Utility 3-130
DAYS Parameter
CTBJAFDL Utility 4-26
CTMTBUPD Utility 3-119
DAYS Statement
CTDDELRP Utility 5-26
CTVDELI Utility 5-67
DBABFB Parameter
CTBFRM Utility 4-21
DBBKPB Parameter
CTBFRM Utility 4-21
DBFILE Parameter
CTBDBCP Utility 4-5, 4-6
CTBDBIB Utility 4-8
CTDDIG Utility 5-37
CTDULD Utility 5-54
IOADBIB Utility 2-38
IOADBSR Utility 2-40
IOADIG Utility 2-47
IOADPT Utility 2-54
IOADUL Utility 2-57
DBFILEB Parameter
CTBABI Utility 4-3
DBGLEVEL Parameter
CTTRTM Utility 7-90
CTTSBD Utility 7-121
CTTVTM Utility 7-176
DBJAFB Parameter
CTBJAFDL Utility 4-26
DBJAFI Parameter
CTBJAFCP Utility 4-23
DBJAFO Parameter
CTBJAFCP Utility 4-23
DBPREFA Parameter
IOADBSR Utility 2-40
IOADIG Utility 2-47
IOADII Utility 2-49
IOADLD Utility 2-52
IOADPT Utility 2-54
IOADUL Utility 2-57
DBPREFT Parameter
CTTCTRC Utility 7-21

DBREPB Parameter
CTBJAFDL Utility 4-26
DBREPI Parameter
CTBJAFCP Utility 4-23
DBREPO Parameter
CTBJAFCP Utility 4-23
DCAL
Calendar 3-130
DCAL Parameter
CTMTBUPD Utility 3-119
DD Statement
DA34F 2-65
DABCLIN 2-5
DACAL 3-78
DACHK 3-68
DAFLWPRM 3-87
DAINPRM 3-22, 3-33
DANSCPRM 3-98
DAOGRPRM 3-101
DAPLNJOB 3-79
DAPLNPRM 3-106
DAPRINT 3-33
DARELIN 3-81
DASIM 3-5
DATABERR 3-33
DD Statement RECVOL
CTDUPBKP Utility 5-55
DDNAME Parameter
CTTTPI Utility 7-165, 7-166
ORDER Record 3-68
DDNAMES Index
CTVJAR Utility 5-76
DDSRBA Keyword
CTTMUP Utility 7-43
DDSTAT DD Statement
CTMJOB Utility 3-72
Deallocation
Quantitative Resource 3-80
DECFROM Parameter
CTDUPBKP Utility 5-58
DECTIME Parameter
CTDUFUPD Utility 5-49
DECTO Parameter
CTDUPBKP Utility 5-58
Deleting
CDAM Files 5-17
CTB Variables 4-17
DASD Index Files 5-66

BMC Software, Inc., Confidential and Proprietary Information

Index

11

MDB Volume 7-42

Prerequisite Conditions 2-13
Reports (CTD) 5-25
Unneeded Jobs 3-53
Volumes from MDB 7-25
Deletion Rules
Utility CTDDELRP 5-29
DELGR Parameter
CTBDBVDL Utility 4-17
DELSYSDATA Parameter
CTDCCU Utility 5-18
DELYBLK Parameter
IOADBSR Utility 2-41
DEPEND ON Field
Job Flow Report 3-92
DESC Parameter
CTMTBUPD Utility 3-119
IOATEST Utility 2-67
DESCRIPTION Field
Job Flow Report 3-92
DEST Parameter
CTDUFUPD Utility 5-50
DETAIL Parameter
CTDUPBKP Utility 5-61
DGRP Parameter
CTBDBVDL Utility 4-17
DIAGNOSE Parameter
IOAVERFY Utiility 2-71
DIGRP Parameter
CTBDBVCG Utility 4-11
CTBDBVCP Utility 4-14
DIMOD Parameter
CTBDBVCG Utility 4-11
CTBDBVCP Utility 4-14
DISPLAY Parameter
IOAVERFY Utility 2-69
Distribution Report
CTTVTM Utility 7-173
DIVAR Parameter
CTBDBVCG Utility 4-11
CTBDBVCP Utility 4-14
DMOD Parameter
CTBDBVDL Utility 4-17
DOCLIB Parameter
CTMTBUPD Utility 3-119
DOCLIB Parameter (CTM)
CTMTBUPD Utility 3-120
DOCMEM Parameter

BMC Software, Inc., Confidential and Proprietary Information

12

INCONTROL for OS/390 and z/OS Utilities Guide

CTMTBUPD Utility 3-119

DOGRP Parameter
CTBDBVCP Utility 4-15
Dollar Sign
$ ... 5-41
DOMOD Parameter
CTBDBVCP Utility 4-14
DOVAR Parameter
CTBDBVCP Utility 4-14
DSDELL Statement
CTTMUP Utility 7-44
DSLABEL Keyword
CTTMUP Utility 7-43
DSN Parameter
CTOTEST Utility 6-19
IOADBF Utility 2-30
ORDER Record 3-68
DSN=sched_library(table)
User Daily Job 3-65
DSNADD Statement
CTTMUP Utility 7-43
DSNAME Field
SCRATCH Report 7-94
DSNAME Keyword
CTTMUP Utility 7-43
DSNDEL Statement
CTTMUP Utility 7-44
DSNEXT Statement
CTTMUP Utility 7-44, 7-46
DSNUPD Statement
CTTMUP Utility 7-43
DSNUPDN Statement
CTTMUP Utility 7-43
DSVOLSER Keyword
CTTMUP Utility 7-43
Dual Mirror Image File
Recovery 2-43
DUAL Parameter
IOADBF Utility 2-30
DUALM Parameter
IOADBF Utility 2-30
DUALST Parameter
IOADBF Utility 2-30
DUE-OUT Parameter
CTMTBUPD Utility 3-119
DUP Parameter
ORDER Record 3-68
DUPLICATE-VOL Pool Name

CTTRTM Utility 7-85

DVAR Parameter
CTBDBVDL Utility 4-17
DVLRBA Keyword
CTTMUP Utility 7-42
Dynamic Dataset Stacking
CTTSBD Utility 7-106
Dynamic Insertion Facility
CTMJOB Utility 3-68
DYNSTK Installation Parameter
CTTSBD Utility 7-113

E
EDIT Parameter
CTTRPT Utility 7-65
ENABLE Parameter
IOADBSR Utility 2-41
END Parameter
IOAVERFY Utility 2-73
ENDDATE Parameter
CTOALOCP Utility 6-3
END-TIME Field
CTVJAR Parameter 5-76
ENDTIME Parameter
CTMRSTR Utility 3-111
CTOALOCP Utility 6-3
ENDUPD Statement
CTTMUP Utility 7-45
Enqueue Manager
CTMRELRS Utility 3-80
ERASE Parameter
CTTTPI Utility 7-165
ERASELBL Parameter
CTTTPI Utility 7-166
Erasing
Information on a Tape 7-159
EXCLUDE Statement
CTTSBD Utility 7-121
CTTSCA Utility 7-134
CTTSTKR Utility 7-148
CTTSYNC Utiility 7-154
Syntax 7-6
EXCLUDE Statements
Format (CTT) 7-8
Record Selection (CTT) 7-7
EXEC Statement

CTTTPI Utility 7-161

EXPDT Field
SCRATCH Report 7-94
EXPDTYPE Parameter
CTTPARM Member 7-88, 7-174
EXT-DEL Pool Name
CTTRTM Utility 7-85
EXT-DUP Pool Name
CTTRTM Utility 7-85
EXTEND Parameter
IOADBF Utility 2-31
EXTERNAL Pool Name
CTTRTM Utility 7-85
Extract File
CTTMER Utility 7-37
EXTRACT PATH Statement
CTTRPT Utility 7-60
EXTRACT/SET/USED Field
CTBVXRF Report 4-31
EXTWTR Parameter
CTDUFUPD Utility 5-50

F
FIELD Parameter
CTTRPT Utility 7-64
FIELDS Parameter
CTTRSM Utility 7-82
CTTRTM Utility 7-94
CTTSCA Utility 7-134
CTTSTKR Utility 7-148
FIELDS Statement
CTTRPT Utility 7-63
CTTVTM Utility 7-178
File Definition
IOA Access Method 2-29
FILE Parameter
CTBJAFCP Utility 4-23
CTBJAFIG Utility 4-28
CTDUFUPD Utility 5-48
CTDUPBKP Utility 5-58
FIRST Parameter
CTTDLD Utility 7-27
FIRSTVOL Field
SCRATCH Report 7-94
FODATE Parameter
CTVJAR Utility 5-77

BMC Software, Inc., Confidential and Proprietary Information

Index

13

CTVUPGDB Utility 5-81

FONT Parameter
CTMRFLW Report 3-88
FORCE Argument
ORDER Record 3-69
FORCE Parameter
CTBFRM Utility 4-21
CTDDELRP Utility 5-26
CTMJOB Utility 3-70
CTVUPGDB Utility 5-82
Forecasting
Resource Release 3-80
FORM Parameter
CTDUFUPD Utility 5-50
FORMATF Member
INSTWORK Library 5-8, 5-10
Formatting
Active Balancing File 2-36
CTB Files 2-36
Group File (CTB) 2-36
Report File (CTB) 2-36
Rule Activity File (CTB) 2-36
Trace File (CTT) 7-17, 7-21
FORMCKP Utility
Summary 1-4
FORMDEF Parameter
CTDUFUPD Utility 5-50
FORMRES Utility
Summary 1-4
FORMUFx Sample Job
IOA Access Method Files 2-35
FROM Parameter
CTMFRM Program 3-51, 3-60
FROMDATE Parameter
CTDSMFRP Utility 5-41
CTMJSA Utility 3-75
IOACPLOG Utility 2-25
FROMDSN Parameter
CTOALOCP Utility 6-3
FROMGEN Parameter
CTBDBVCP Utility 4-15
FROMKEY Parameter
IOADUL Utility 2-57
FROMPATH Parameter
CTVGICL Utility 5-72
FROMTYPE Parameter
CTOALOCP Utility 6-3
FROMUSER Parameter

BMC Software, Inc., Confidential and Proprietary Information

14

INCONTROL for OS/390 and z/OS Utilities Guide

CTDUFUPD Utility 5-51

FROMVAL Parameter
CTVGICL Utility 5-72
FUNC Parameter
IOADBF Utility 2-28
IOADIG Utility 2-47
IOADPT Utility 2-54
FUNCTION Parameter
CTTSPL Utility 7-142

G
G Option
Table List Screen 3-85
GEN Parameter
CTMBLDAE Utility 3-17
GENER Parameter
CTDUPBKP Utility 5-59
General Job scheduling definition
Parameter Tables 3-40
Generations
CTB Variables 4-11
Global Index Database
CTVUPGDB Utility 5-81
Global Indexes
Cleaning 5-71
Global Parameter
CTMBLT Utility 3-24
Graphic Format Parameters
CTMRAFL Report 3-77
Graphic Jobflow
Table List Screen 3-85
Greater Than Character 5-41
GROUP Dependent
Job Flow Report 3-92
Group File (CTB)
Copying 4-14
Formatting 2-36
Rebuilding 2-36
Group Output
CTMRFLW Report 3-94
GROUP Parameter
CTBDBVCG Utility 4-12
CTBDBVCP Utility 4-15
CTBDBVDL Utility 4-17
CTMAESIM Utility 3-5
CTMBGRP Utility 3-14

CTMRFLW Report 3-87

CTMROGR Report 3-101
CTMTBUPD Utility 3-119
CTTSBD Utility 7-123
Group Name Identification 3-5
IGNORE/SELECT Statements (CTM) 3-51,
3-60
Group Scheduling Table
CTMBGRP Utility 3-13, 3-34
GRPBIX Statement
CTTMUP Utility 7-43, 7-47
GRPSCR Statement
CTTMUP Utility 7-42
GRPSCRF Statement
CTTMUP Utility 7-47

H
HANDLED Field
Message Statistics Screen 6-16
History Report List
Cleaning 5-20
CTDCCU Utility 5-18
CTDDELRP Utility 5-25
History User File
Backup Utility 5-55

I
ID Field
Message Statistics Screen 6-16
ID Parameter
CTTRPT Utility 7-63
IFASMFDP Utility
CTTRSM Utility 7-79
IGNORE CALENDAR Parameter
CTMRPLN Report 3-107
IGNORE Statement
CTMJOB Utility 3-66
IOACLCND Utility 2-14
IOALDNRS Utility 2-61
IGNORE TAG Logic
CTMJOB Utillity 3-70
IGNORE TAG Parameter
CTMJOB Utility 3-69
ORDER Record 3-69

User Daily Job (CTM) 3-69

INCLUDE GROUPNAME Parameter
CTMRNSC Report 3-98
INCLUDE JOBNAME Report
CTMRNSC Report 3-98
INCLUDE Statement
CTTRTM Utility 7-93
CTTSBD Utility 7-101, 7-121
CTTSCA Utility 7-134
CTTSTKR Utility 7-148
CTTSYNC Utiility 7-154
Syntax 7-6
INCLUDE/EXCLUDE Statements
CTBJAFCP Utility 4-24
CTBJAFDL Utility 4-26
CTDCA2P Utility 5-11
CTDCCFRS Utility 5-16
CTDCP2A Utility 5-22
CTDDELRP Utility 5-25, 5-28
CTORSTM Utility 6-14
CTTACP Utility 7-15
CTTRCV Utility 7-56
CTTRPT Utility 7-60
CTTRSM Utility 7-81
CTTSTK Utility 7-145, 7-146
CTVDELI Utility 5-66, 5-68
Examples 7-11
Format (CTT) 7-8
Record Selection (CTT) 7-7
Record Selection Logic 7-6
Index File
Deleting from DASD 5-66
IOA Access Method 5-34
Media Database 7-18
Rebuild Stacking Index 7-23
Index Format
CTVJAR Utility 5-76
Index Value
CTVUPGDB Utility 5-81
Initialization
Tape Initialization 7-156
Trace File 7-17
INITT Function
CTTTPI Utility 7-164
INP Parameter
CTTDLD Utility 7-26
IN-TABLE Parameter
CTMBGRP Utility 3-14

BMC Software, Inc., Confidential and Proprietary Information

Index

15

Integrity
Access Method Index 2-49
IOA Access Method 2-46
Media Database 7-41, 7-139
Rule Activity File (CTB) 4-28
Variable Files (CTB) 4-19
INTERVAL Parameter
CTMROGR Report 3-101
CTMTBUPD Utility 3-119
IOADBSR Utility 2-41
INTERVAL-TYP Parameter
CTMTBUPD Utility 3-119
INTOGRP Parameter
ORDER Record 3-68
Inventory Report
Vault Management 7-173
IOA
Rebuild Index 2-37
IOA Access Method
File Definition 2-29
Index Integrity 2-49, 5-34
Index of CTD Files 5-34
Integrity 2-46
Loading Files 2-51
Printing Files 2-54
Recovery 2-43
Sorting Files 2-40
Unloading Files 2-56
IOA Log
Copying 2-25
IOA Log File
Log File 3-101
IOA Utilities
Summary 1-2
IOABLCAL Utility 2-4, 3-78
Calendar Creation 2-4
CTMRCAL Calendar 3-78
Example 2-7
Logic 2-5
Summary 1-2
IOACABJ Job
Emergeny CAB Control Block Disconnect
2-12
IOACABPR Utility 2-12
Emergeny CAB Control Block Disconnect
2-12
Summary 1-2
IOACCND Utility

BMC Software, Inc., Confidential and Proprietary Information

16

INCONTROL for OS/390 and z/OS Utilities Guide

Description 2-23
IOACLCND Utility 2-13
Description 2-13
IOACLRES Utility 2-17
Description 2-17
Summary 1-2
IOACND
Activating CTMCND Utility 2-20
IOACND Utility 2-17
Description 2-17
Manage Conditions/Resources 2-17
Summary 1-2
IOACOLBI Job
IOADBIB Utility 2-39
IOACPLOG Utility 2-25
Copy Log File 2-25
Summary 1-2
IOADBF Utility 2-28, 4-3
Description 2-28
Summary 1-2
IOADBIB Utility 2-37
Description 2-37
Rebuild IOA Index 2-37
Summary 1-2
IOADBSBI Job
IOADBIB Utility 2-38
IOADBSR Utility 2-40
Sort Access Method Files 2-40
Summary 1-2
IOADCPY Utility 2-43
Access Method File Recovery 2-43
Summary 1-2
IOADIG Utility 2-46
Access Method File Integrity 2-46
Summary 1-2
IOADII Utility 2-49
Access Method Index Integrity 2-49
Summary 1-2
IOADLD Utility 2-51
Load Access Method Files 2-51
Summary 1-2
IOADPT Utility 2-54
Print Access Method Files 2-54
Space Management 2-35
Summary 1-2, 1-5
IOADUL Utility 2-56
Summary 1-2
Unload Access Method Files 2-56

IOALDNRS Utility 2-60

Manual Conditions File 2-60
Summary 1-3
IOANOTE Utility 2-63
Sending a Message 2-63
Summary 1-3
IOAOPR Utility 2-65
Description 2-65
Summary 1-3
IOASPRM Table
CTVUNMIG Utility 5-79
IOATEST Utility 2-66, 2-67
Simulation 2-66, 2-67
Summary 1-3
IOAVARBI Job
IOADBIB Utility 2-39
IOAVCND Utility 2-22, 2-23
Description 2-22
Summary 1-3
IOAVERFY Utility 2-69
Description 2-69
Summary 1-3
IOERR Field
SCRATCH Report 7-94
IXNAME Parameter
CTVDELI Utility 5-68

J
JCL
CTMRFLW Report 3-86, 3-89
CTMRNSC Report 3-98
CTMROGR Report 3-102
CTMRPLN Report 3-107
JCL Library Mode
Parameters 3-5
JCL LIBRARY Parameter
AutoEdit Simulation 3-5
JES Command
IOAOPR Utility 2-65
JES3
Command Prefix 2-65
JES3 Command
IOAOPR Utility 2-65
JESCHAR Command Prefix
IOAOPR Utility 2-65
Job

Job Name / Scheduling Table Name Xref

Report 3-131
Job Dataset Cross Reference
CTMRJDS Report 3-136
Job Dependency
Job Flow Report 3-85
Job Flow Report
CTMRAFL Report 3-77
CTMRFLW Report 3-85
Cyclic Job Flow 3-93
Fields 3-92
JCL 3-89
Job Dependency 3-85
Scheduling Data 3-92
Text Format 3-91
Job Name / Table Name Cross Ref
CTMXRF Utility 3-133
Job Name Cross Ref
CTMXRF Utility 3-134
Job Name/Scheduling Table Name Report
CTMXRF Utility 3-130
JOB Parameter
ORDER Record 3-68
Testing AutoEdit Syntax 3-6
Job Plan
CTMRCAL Utility 3-78
CTMRPLN Report 1-4, 3-106
Job Scheduling
CTMBLT Utility 3-24
Parameter Tables 3-40
Job Scheduling Tables
Updating 3-116
Job Statistics
CTMJSA Utiility 3-74
Job Workload
Overnight Execution Graph 3-100
JOBBBDM Job
Rebuild Access Method Variable File 2-36
JOBBDBM Job
CTBDBIB Utility 4-10
JOBBDBV Job
CTBDBIB Utility 4-10
Rebuild Access Method Variable File 2-36
JOBBGRP Job
CTBDBIB Utility 4-10
Rebuild Group File 2-36
JOBBJAF Job
CTBDBIB Utility 4-10

BMC Software, Inc., Confidential and Proprietary Information

Index

17

Rebuild Rule Activity File 2-36

JOBBREP Job
CTBDBIB Utility 4-10
Rebuild Report File 2-36
JOBFABF Job
Format Active Balancing File 2-36
JOBFGRP Job
Format Group File 2-36
JOBFJAF Job
Format Rule Activity File 2-36
JOBFREP Job
Format Report File 2-36
JOBID Field
CTVJAR Parameter 5-76
JOBID Parameter
CTDUPBKP Utility 5-58
CTVDELI Utility 5-68
CTVUPGDB Utility 5-81
JOBID ParameterCTDUFUPD Utility 5-50
JOBNAME Field
CTVJAR Parameter 5-76
JOBNAME Parameter
CTDUFUPD Utility 5-49
CTDUPBKP Utility 5-58
CTTGVL Utility 7-31
CTVDELI Utility 5-68
CTVGICL Utility 5-72
CTVUPGDB Utility 5-81
Jobs
CTOMSDSC 6-18
CTOMVDSC 6-17
CTOUSDSC 6-23
IOACABJ 2-12
JOBSDD DD Name
CTMRFLW Report 3-87
CTMRPLN Report 3-106

K
KEEPDSN Parameter
CTDDELRP Utility 5-27
KEYFROM Parameter
IOADPT Utility 2-54
KEYLEN Parameter
IOADBF Utility 2-31
KEYTO Parameter
IOADPT Utility 2-54

BMC Software, Inc., Confidential and Proprietary Information

18

INCONTROL for OS/390 and z/OS Utilities Guide

KEYxxx Members
PARM library 7-24

L
LABEL Parameter
CTTGVL Utility 7-31
LABTYPE Parameter
CTTTPI Utility 7-165
LACCDT Field
SCRATCH Report 7-94
Laser Printer
Specified as IMPACT 3-88
LAST ACCESS Retention
CTTSTK Utility 7-147
LAST Parameter
CTTDLD Utility 7-27
LBLNUM Parameter
CTTMUP Utility 7-49
LCLNDT Field
SCRATCH Report 7-94
LENGTH Parameter
CTTRPT Utility 7-64
LIB Parameter
CTBVXRF Utility 4-30
Library Name / Job Name Cross Ref
CTMXRF Utility 3-135
LIBRARY Parameter
CTMAESIM Utility 3-5
CTMBLT Utility 3-26, 3-34
Library/Job Name Report
CTMXRF Utility 3-130
LINECNT Parameter
CTMRFLW Procedure 3-86
LINESIZE Parameter
CTMRFLW Report 3-88
CTTRPT Utility 7-62, 7-149
LINK Command
CTTGVL Utility 7-31
LIST Command
CTMAESIM Utility 3-7
LIST Parameter
CTTRTM Utility 7-91
IOAVERFY Utility 2-70
LOAD Parameter
CTVUPGDB Utility 5-81
Loading

IOA Access Method Files 2-51

LOCAL Parameter
CTMBLT Utility 3-24
LOCATION Field
SCRATCH Report 7-94
Log File
Copying the IOA Log 2-25
CTMROGR Report 3-101
Logical Recovery
Media Database 7-52
LRECL Parameter
IOADBF Utility 2-31
LVL Field
Job Flow Report 3-92

M
M Parameter
IOADBF Utility 2-28
IOADBSR Utility 2-40
Maintenance
Active Jobs File 3-49
Manual
JCL Override 3-132
MANUAL COND Field
Job Flow Report 3-92
Manual Conditions List
Building 2-60
Manual IN Condition
JCL_OVERIDE Prefix 3-132
Manual Update
Media Database 7-39
Stacking Statistics 7-40
Mapping
Media Information 7-157
MARGINS Parameter
CTTRPT Utility 7-62, 7-149
Mask Characters
INCLUDE/EXCLUDE Statements 7-8
Masking
CTDUFUPD Utility 5-46
CTTSBD Utility 7-109
MAXCARDS Parameter
CTMRFLW Report 3-88
MAXDAYS Parameter
CTMTBUPD Utility 3-119
MAXINDX Parameter

CTVUPGDB Utility 5-82

MAXRERUN Parameter
CTMTBUPD Utility 3-119
MAXRUNS Parameter
CTMTBUPD Utility 3-119
MAXWAIT Parameter
CTMTBUPD Utility 3-119
MDBUPDAT Parameter
CTTTPI Utility 7-164
Media Database
Adding Volumes 7-25
Backup Utility 7-171
Converting Volumes 7-25
CTTSTK Utility 7-145
Deleting Volumes 7-25
Integrity 7-41
MERGE Utility 7-36
Rebuild Index 7-18
Recovery 7-52
Split/Merge Process 7-138
Statistics 7-33
UPDATE Utility 7-39
MEDIA Field
SCRATCH Report 7-94
Media Information
Tape Mapping 7-157
MEDIA Parameter
CTTDLD Utility 7-27
CTTTPI Utility 7-165
MEMBER Field
Job Flow Report 3-92
MEMBER Parameter
CTMAESIM Utility 3-5
ORDER Record 3-68
MEMLIB Parameter
CTMTBUPD Utility 3-119
MEMNAME Parameter
CTMBLT Utility 3-26
CTMTBUPD Utility 3-119
MEMNAME Value
CTMRCAL Calendar 3-78
MEM-OVERWRITE Parameter
CTMBLT Utility 3-26
MEMOVERWRITE Parameter
CTMBLT Utility 3-27
MERGE Value
CTMRCAL Utility 3-78
Merging

BMC Software, Inc., Confidential and Proprietary Information

Index

19

MDB Records 7-36

Message Statistics Facility (CTO)
Copy Statistics File 6-6
Report Utility 6-14
Message Statistics Screen
Fields 6-16
Message to Log File
IOANOTE Utility 2-63
Messages
CTD533S 5-6
CTDF63W 5-6
CTO184I 6-7
CTO189I 6-6
MIGMIS Parameter
CTVJAR Utility 5-77
MIGRATE Parameter
CTVUPGDB Utility 5-82
Migrated User Report List
Backup Utility 5-55
Cleaning 5-64
MIGRESET Utility 5-86
Summary 1-7
Mirror Image File
Recovery 2-43
MODE Installation Parameter
CTTSBD Utility 7-113
MODE Parameter
CTDCLHIS Utility 5-20
CTDDELRP Utility 5-26
CTDDIG Utility 5-37
CTTPARM Member 7-88
CTTRTM Utility 7-90, 7-116
CTTSPL Utility 7-142
CTTTPI Utility 7-163
CTTVTM Utility 7-176, 7-177
CTVCLMIG Utility 5-64
CTVDELI Utility 5-67
CTVGICL Utility 5-71
CTVJAR Utility 5-77
MODE Report
CTMROGR Report 3-101
MONTHS Parameter
job scheduling definition 3-126
Moving
Database Records 7-138
MRGIN Parameter
CTTMER Utility 7-37
MVS

BMC Software, Inc., Confidential and Proprietary Information

20

INCONTROL for OS/390 and z/OS Utilities Guide

Catalog Conversion 7-26

N
N (New) Parameter
Conditions Resources 3-122
NAME Parameter
CTTRPT Utility 7-62
New Parameter
CCIFRES Utility 5-15
NEWAJF File Statement
CTMCAJF Utility 3-62
NEWBKP Parameter
CTDUPBKP Utility 5-60
NEWEXDTn Field
CTTRTM Utility 7-95
NEWG Parameter
ORDER Record 3-69
NEWMIG Parameter
CTDUPBKP Utility 5-60
NEWNAME Parameter
CTTMUP Utility 7-43
NEWXDTRn Field
CTTRTM Utility 7-95
Night Schedule Report
CTMRNSC Report 3-98
Sample 3-100
NJE NODE Parameter
CTMAESIM Utility 3-5
JES Node Identification 3-5
NJE-NODE Parameter
CTMTBUPD Utility 3-119
NODUP Parameter
ORDER Statement 3-68
NOPRINT Parameter
CTBJAFDL Utility 4-26
NOREPORT Parameter
CTDDELRP Utility 5-27
NOSYS Parameter
CTVCLMIG Utility 5-64
NOLOCATE Utility 5-64
NOTRST Parameter
CTDDELRP Utility 5-27
NOTWD Parameter
CTDDELRP Utility 5-26
NOTWDSN NAME Parameter
CTTSBD Utility 7-126

NUMBTAPE Parameter
CTTTPI Utility 7-165, 7-166
NUMERR Parameter
CTTTPI Utility 7-166
NUMGEN Parameter
CTBDBVCG Utility 4-12
CTBDBVCP Utility 4-15

O
O (Old) Parameter
Conditions Resources 3-122
ODATE
CTMAESIM Utility 3-6
CTMJOB Utility 3-68
ODATE Parameter
AutoEdit Simulation 3-137
CTDUFUPD Utility 5-50
ORDER Record 3-68
ODATEOPT Parameter
CTMJOB Utility 3-68
ODOPT Parameter
CTMJOB Utility 3-68
OLDAJF File Statement
CTMCAJF Utility 3-52
OLDEXDTn Field
CTTRTM Utility 7-95
OLDQNAME Parameter
CTBDBCP Utility 4-5, 4-6
OLDXDTRn Field
CTTRTM Utility 7-95
ON MVALERT
Emergency Disconnect Utility 6-17
ON SMS
Emergency Disconnect Utility 6-18
Operator Commands
F CONTROLO,STARTSTATS 6-7
F CONTROLO,STOPSTATS 6-6
Option 8
Primary Option Menu 2-4
Option G
Table List Screen 3-85
Options
Graphic Jobflow 3-85
Table List 3-85
ORDER Parameter
User Daily Job (CTM) 3-68

ORDER Statement
CTMJOB Utility 3-66
Format 3-67
OUTDD Parameter
CTTRPT Utility 7-62, 7-149
OUTLIB Parameter
CTMBLDAE Utility 3-17
OUT-TABLE Parameter
CTMBGRP Utility 3-14
OVERLIB Parameter
CTMAESIM Utility 3-6
CTMTBUPD Utility 3-119
Overnight Execution Graph
CTMROGR Report 3-100
OWNER Parameter
CTMAESIM Utility 3-5
CTMTBUPD Utility 3-119
CTTTPI Utility 7-165

P
P Parameter
Conditions Resources 3-122
PAGEDEF Parameter
CTDUFUPD Utility 5-50
PAGESEQ Parameter
CTMRFLW Report 3-88
PAGESIZE Parameter
CTMRFLW Report 3-88
CTTRPT Utility 7-62, 7-149
PaperUsage Report
CTDSMFRP Utility 5-41
Parameter Table
PostProcessing 3-44
Scheduling Criteria 3-42
PARM Parameter
CTMRCAL Utility 3-78
CTOCTA Utility 6-8
CTOTEST Utility 6-19
PARMLIB Parameter
IOADBSR Utility 2-40
PATH Parameter
CTVGICL Utility 5-71
CTVUPGDB Utility 5-83
Permanent Report List
Copy from Active 5-11
Copy to Active 5-22

BMC Software, Inc., Confidential and Proprietary Information

Index

21

Physical Recovery
Media Database 7-52
POD-API applications
CTVUPGDB Utility 5-81
POOL Field
SCRATCH Report 7-94
PostProcessing Parameter
Parameter Table 3-44
PREDESR Parameter
CTMRFLW Procedure 3-86
Prefix Field
ACCOUNT 5-41
CATEGORY 5-41
REPNAME 5-41
USER 5-41
PREFIX Parameter
CTDCCU Utility 5-17
CTVJAR Utility 5-77
Prefixing
5-41
CTDUFUPD Utility 5-46
Prerequisite Condition
Adding/Deleting/Verifying 2-17
Cross Reference 3-85, 3-95
Deleting 2-13
IOACND Utility 2-17
Job Flow Report 3-85
PREVENT-NCT2 Parameter
CTMTBUPD Utility 3-119
Primary Key
CTTRPT Utility 7-58
PRIMARY Parameter
CTDUPBKP Utility 5-60
PRINT Parameter
CTBJAFDL Utility 4-26
CTDUFUPD Utility 5-48
PRINT_LIMIT Parameter
CTDUFUPD Utility 5-48
PRINTER Parameter
CTMRFLW Report 3-88
Printing
IOA Access Method Files 2-54
PRINTSYS Parameter
CTDUPBKP Utility 5-61
PRIORITY Parameter
CTMTBUPD Utility 3-119
PROTECT Parameter
CTTTPI Utility 7-163

BMC Software, Inc., Confidential and Proprietary Information

22

INCONTROL for OS/390 and z/OS Utilities Guide

PRTMIS Parameter
CTVJAR Utility 5-77

Q
Quantitative Resource
Adding/Deleting/Modifying 2-17
Changing 3-97
Cross Reference 3-85, 3-97
Job Flow Report 3-85
Release 3-80

R
RBAOFF Parameter
IOADUL Utility 2-57
RBAOFS Parameter
IOADBSR Utility 2-41
RDR=INTRDR Parameter
CTMAESIM Utility 3-7
Rebuilding
Access Method Variable File (CTB) 2-36
CTB Index 4-8
Group File (CTB) 2-36
IOA Index 2-37
Report File (CTB) 2-36
Rule Activity File (CTB) 2-36
RECALC Report
CTTRTM Utility 7-85, 7-95
RECAT Parameter
CTTRCV Utility 7-55
RECDEL Statement
CTTMUP Utility 7-44
Record Selection Logic
INCLUDE/EXCLUDE Statements
CTT Utilities 7-6
Recovery
CTTRTM Utility 7-86
CTTTPI Utility 7-160
MDB from Trace File 7-52
Split/Merge Process (CTT) 7-140
RECUPD Statement
CTTMUP Utility 7-44
RELATION Parameter
CTMTBUPD Utility 3-119
REMARK Parameter

CTDUFUPD Utility 5-50

RENAME Parameter
CTTDLD Utility 7-27
REP Parameter
IOAVERFY Utility 2-73
REPEND Parameter
CTMRNSC Report 3-98
CTMROGR Report 3-101
CTMRPLN Report 3-106
REPFSCR Job
CTTRPT Utility 7-72
REPLACE Parameter
CTBDBVCP Utility 4-15
CTDULD Utility 5-54
REPLACE Value
CTMRCAL Utility 3-78
REPNAME Parameter
CTDSMFRP Utility 5-41
CTVDELI Utility 5-68
CTVJAR Utility 5-77
CTVUPGDB Utility 5-81
Report
Deleting (CTD) 5-25
Job Name / Scheduling Table Name Xref
3-131
Scratch Report (CTT) 7-85
Report File (CTB)
Formatting 2-36
Rebuilding 2-36
Report Generation (CTT)
CTTRPT Utility 7-58
Sample Reports 7-70
REPORT Parameter
CTDUFUPD Utility 5-50
CTTRSM Utility 7-81
CTTRTM Utility 7-94
CTTSCA Utility 7-134
CTTSTKR Utility 7-148
CTVGICL Utility 5-72
Report Parameter
CTDUPBKP Utility 5-61
REPORT Statement
CTTRPT Utility 7-62
CTTVTM Utility 7-178
Reporting Facility
CTDSMFRP Utility 5-41
Reports
CTTSBD Utility 7-110

REPSTART Parameter
CTMRNSC Report 3-98
CTMROGR Report 3-101
CTMRPLN Report 3-106
REPTYPE Parameter
CTDSMFRP Utility 5-41
CTMRPLN Report 3-106
RES file 3-83
RESIDENT Parameter
CTVDELI Utility 5-67
RESLOT Parameter
CTTVTM Utility 7-177
Resource Name / Job Name Cross Ref
CTMXRF Utility 3-133
Resource Utilization
Forecasting 3-80
IOACND Utility 2-17
Simulation 3-80
Resources
Updating 3-124
Resources/Job Name Report
CTMXRF Utility 3-130
RESTART Parameter
CTTRTM Utility 7-91
CTTVTM Utility 7-176
RESTORED Parameter
CTDDELRP Utility 5-27
RETDAYS Parameter
CTMTBUPD Utility 3-119
Retention
CTTSBD Utility 7-103
Retention Management
CTTRTM Utility 7-84
Retention Period
CTDCLHIS Utility 5-20
Migrated Report List 5-64
Retention, Non-specific
CTTSTK Utility 7-147
RETGENS Parameter
CTMTBUPD Utility 3-119
RETPD Parameter
CTDUPBKP Utility 5-60
RETRO Parameter
CTMTBUPD Utility 3-119
Return Code
CTVUPGDB Utility 5-84
RMM
Conversion Utility 7-26

BMC Software, Inc., Confidential and Proprietary Information

Index

23

Roll Back Recovery

Media Database 7-52
Roll Forward Recovery
Media Database 7-52
ROUT Parameter
IOATEST Utility 2-67
RSTRESET Utility 5-87
Summary 1-7
RTNTYPE Installation Parameter
CTTSBD Utility 7-113
RTNTYPE Parameter
CTTPARM Member 7-88
Rule Activity File (CTB)
Formatting 2-36
Rebuilding 2-36
RULE Field
CTBVXRF Report 4-31
Rule Parameters
CTBVXRF Utility 4-30
RULEINFO Parameter
CTTSCA Utility 7-134
RULELIB Parameter
CTTSCA Utility 7-132
RULEMEM Parameter
CTTSCA Utility 7-132

S
SAC
Schedule Adjustment for Conversion 3-120
SCHDMAX= Control Statement 3-126, 3-132
Schedule Library Cleanup Utility 3-113
Schedule Tag / Job Name Cross Ref
CTMXRF Utility 3-134
SCHEDULE TAG Field
Utility CTMBGRP 3-13
SCHEDULE TAG Parameter
Group Entity 3-5
Schedule Tag/Job Name Report
CTMXRF Utility 3-130
Scheduling Calendar
IOABLCAL Utility 2-4
Scheduling Criteria
Parameter Table 3-42
Scheduling Definition
Reports 3-77, 3-93
Scheduling Information

BMC Software, Inc., Confidential and Proprietary Information

24

INCONTROL for OS/390 and z/OS Utilities Guide

CTMRAFL Report 3-77

Job Flow Report 3-92
Scheduling Library Mode
Parameter 3-6
SCHEDULING LIBRARY Parameter
AutoEdit Simulation 3-6
Scheduling Parameters
CTTVTM Utility 7-177
Scheduling Table
Scheduling Table Name / Job Name Xref
Report 3-131
Scheduling Tables
Regular to Group Conversion 3-13
SCHENV Parameter
CTMAESIM Utility 3-5
CTMTBUPD Utility 3-119
Workload Management Scheduling
Environment 3-5
SCRATCH Parameter
CTTDLD Utility 7-27
SCRATCH Report
Fields 7-94
Scratch Report
CTTRTM Utility 7-85
SECONDARY Parameter
CTDUPBKP Utility 5-60
SEL Group
DAINPRM DD Statement 3-126
SELECT Statement
CTMJOB Utility 3-66
SELECT Statements
CTDUFUPD Utility 5-46
SELECT TAG
CTMJOB Utility 3-69
ORDER Parameter (CTM) 3-69
SELECT TAG Logic
CTMJOB Utillity 3-70
SELECT TAG Parameter
ORDER Record 3-69
Selection Criteria
CTDUFUPD Utility 5-45
INCLUDE/EXCLUDE Statements (CTT)
7-7
SEND Command
CTMAESIM Utility 3-7
SEQ Parameter
CTDULD Utility 5-54
Sequential File

IOA Log 2-25

SER Parameter
CTTTPI Utility 7-164, 7-166
SETVAR Parameter
job scheduling definition 3-126
Testing AutoEdit Syntax 3-6
SHIFT Parameter
CTMTBUPD Utility 3-119
SHIFT-EXT Parameter
CTMTBUPD Utility 3-119
SIMULATE Parameter
CTDUFUPD Utility 5-48
CTDUPBKP Utility 5-59
Simulation
CTDCCU Utility 5-17
CTO Environment 6-19
CTVDELI Utility 5-67
IOATEST Utility 2-66, 2-67
Resource Release 3-80
Simulation Log
CTMROGR Report 3-101
SIMULATION Parameter
CTDCCU Utility 5-17
Simulation Reports
CTTSBD Utility 7-111
Size
Active Missions File 5-7
Active Transfer File 5-10
Automation Log 6-3
SLINMAX= Control Statement 3-126, 3-132
SL-NAME Field
SCRATCH Report 7-94
Slot Numbers
Vaulted Volumes 7-177
SMF
Type 15 Records 7-145
SMF Records
CTDSMFRP Utility 5-41
CTTRSM Utility 7-79
SMFID Field
CTVJAR Parameter 5-76
SMS-Managed Environment
CTTSBD Utility 7-100
SORT Parameter
CTBVXRF Utility 4-30
SORTBY Parameter
CTMRPLN Report 3-106
CTTRSM Utility 7-82

SORTBY Statement
CTTRPT Utility 7-63
CTTRTM Utility 7-96
CTTSCA Utility 7-135
CTTSTKR Utility 7-150
CTTVTM Utility 7-178
Utility CTORSTM 6-14
Sorting
Access Method Files 2-40
SPACE Parameter
IOADBF Utility 2-32
Split/Merge Process
Description (CTT) 7-138
Merge Utility 7-36
SPY281I Message
CTMJSA Utiility 3-74
SPY28GI Message
CTMJSA Utiility 3-74
SQFILE Parameter
IOADLD Utility 2-52
IOADUL Utility 2-57
ssname Parameter
CTOTEST Utility 6-20
STACKID Parameter
CTTGVL Utility 7-31
Stacking Logic
CTTSBD Utility 7-105
Stacking Statistics File
Build/Update Utility 7-145
Rebuild Index 7-23
Update Utility 7-40
STARTDATE Parameter
CTOALOCP Utility 6-3
STARTSTATS Command
CTO Message Statistics 6-7
START-TIME Field
CTVJAR Parameter 5-76
STARTTIME Parameter
Utility CTOALOCP 6-3
START-WHEN-OVER Parameter
IOADBSR Utility 2-41
STAT Date Reference
IOACLCND Utility 2-13
IOACLRES Utility 2-17
STAT Parameter
CTMPARM Member 3-74
Statistics
Media Database 7-33

BMC Software, Inc., Confidential and Proprietary Information

Index

25

Message Statistics File 6-6

STATUS Field
CTTRSM Utility 7-82
STATUS Parameter
IGNORE/SELECT Statements (CTM) 3-51,
3-60
STEPLIB DD Statement
CTMJOB Utility 3-71
STKADD Parameter
CTTMUP Utility 7-45
STKDEL Parameter
CTTMUP Utility 7-45
STKMODE Installation Parameter
CTTSBD Utility 7-113
STKUPD Parameter
CTTMUP Utility 7-45
STOP Parameter
CTTTPI Utility 7-166
STOPSTATS Command
CTO Message Statistics 6-6
STORED Parameter
CTVUPGDB Utility 5-82
SUBMIT Command
CTMAESIM Utility 3-7
SUBSCAN Command
CTMAESIM Utility 3-7
SUBSYS JCL Parameter
CDAM Files 5-17
Utility CTDDELRP 5-29
SUCCESR Parameter
CTMRFLW Procedure 3-86
SUFFIX Parameter
IOADCPY Utility 2-44
SUMMARY Parameter
CTTRPT Utility 7-62, 7-149
SUPPRESSED Field
Message Statistics Screen 6-16
SYNC Parameter
CTVJAR Utility 5-77
Syntax
Rule Definitions (CTB) 4-4
SYSDATA Entry
CTDDELRP Utility 5-27, 5-29
SYSDB Parameter
CTMTBUPD Utility 3-120
SYSID Parameter
CTMAESIM Utility 3-5
System or Processor Identity 3-5

BMC Software, Inc., Confidential and Proprietary Information

26

INCONTROL for OS/390 and z/OS Utilities Guide

SYSIMAGE Facility
CTOCTI Utility 6-11
Input Generation 6-10
SYSIN DD Statement
CTMBGRP Utility 3-14
CTTTPI Utility 7-162, 7-167
SYSPRINT DD Statement
CTMAESIM Utility Results 3-7
CTMBGRP Utility 3-14
CTMJOB Utility 3-72
CTTTPI Utility 7-167
SYSTEM-ID Parameter
CTMTBUPD Utility 3-120

T
Table List Screen
Graphic Jobflow Option 3-85
TABLE Parameter
CTMBLT Utility 3-27
Testing AutoEdit Syntax 3-6
TABLES Parameter
CTMRFLW Report 3-88
CTMRPLN Report 3-107
Tape Erasure 7-159
TAPE Field
Job Flow Report 3-92
Tape Initialization 7-156
Tape Mapping 7-157
Tape Pool
CTDCLHIS Utility 5-20
TAPEMAP Function
CTTTPI Utility 7-166
TAPERAS Function
CTTTPI Utility 7-166
TASKTYPE Parameter
CTMTBUPD Utility 3-120
TERM Parameter
IOATEST Utility 2-68
TESTRUL Parameter
CTTPARM Member 7-89
TEXT Field
Message Statistics Screen 6-16
Time/Job Name Report
CTMXRF Utility 3-130
TIMEFROM Parameter
CTMTBUPD Utility 3-120

IOADBSR Utility 2-41

Timestamp
CTTSTK Utility 7-145
TIMETO Parameter
IOADBSR Utility 2-41
TIMEUNTIL Parameter
CTMTBUPD Utility 3-120
TIME-ZONE Parameter
CTMTBUPD Utility 3-120
TITLE Parameter
CTTRPT Utility 7-64
TO Parameter
CTMFRM Program 3-51, 3-60
TODATE Parameter
CTDSMFRP Utility 5-41
CTVJAR Utility 5-77
CTVUPGDB Utility 5-81
TODSN Parameter
CTOALOCP Utility 6-3
TOKEY Parameter
IOADUL Utility 2-57
TOPATH Parameter
CTVGICL Utility 5-72
TOTYPE Parameter
CTOALOCP Utility 6-4
TOUNIT Parameter
CTOALOCP Utility 6-4
TOVAL Parameter
CTVGICL Utility 5-72
TOVOLUME Parameter
CTOALOCP Utility 6-4
TRACE Facility
IOAVERFY Utility 2-74
Trace File
Backup Utility 7-171
Copying 7-14
CTTRTM Utility 7-90
CTTSTK Utilitiy 7-145
CTTVTM Utility 7-176
Formatting/Creating 7-21
Formatting/Initializing 7-17
MDB Recovery 7-52
Utilities 1-8
TRACE Parameter
CTTRTM Utility 7-90
CTTVTM Utility 7-176
CTVGICL Utility 5-71
CTVUPGDB Utility 5-82

TRCBLK Parameter
CTTCTRC Utility 7-21
TRCBLKS Parameter
CTTCTRC Utility 7-21
TRCIN Parameter
CTTACP Utility 7-15
TRCOUT Parameter
CTTACP Utility 7-15
TRCSIZE Parameter
CTTPARM Member 7-17
TRCUNITT Parameter
CTTCTRC Utility 7-21
TRCUPDQ Statement
CTTMUP Utility 7-46
TRCVOL Parameter
CTTCTRC Utility 7-21
TYP Field
Job Flow Report 3-92
Message Statistics Screen 6-16
TYPE Parameter
IOADBF Utility 2-32
TYPE ParameterCTDUFUPD Utility 5-49
TYPERET Parameter
CTTRTM Utility 7-92
TYPERUN Parameter
CTTSCA Utility 7-132
TYPERUN Statement
Syntax 7-6
TYPEVLT Statement
CTTVTM Utility 7-177
TYPRUN=SCAN Statement
CTMAESIM Utility 3-7

U
UDEST Parameter
CTDUFUPD Utility 5-50
UNAME Field
SCRATCH Report 7-94
UNCTLG Parameter
CTTRTM Utility 7-93
UNIT Parameter
IOADBF Utility 2-32
IOADCPY Utility 2-44
UNITD Parameter
IOADBF Utility 2-32
Unloading

BMC Software, Inc., Confidential and Proprietary Information

Index

27

IOA Access Method Files 2-56

UNMATCH Parameter
CTDUPBKP Utility 5-61
Unstacking
CTTSBD Utiility 7-111
UPD Parameter
CCIFRES Utility 5-15
Updating
Job Scheduling Tables 3-116
MDB Volume 7-42
Media Database 7-39
Stacking Statistics 7-40
Stacking Statistics File 7-145
UPDVOL Parameter
CTTRTM Utility 7-93
USEDAYS Parameter
CTTIDB Utility 7-34
User File Updating
CTDUFUPD Utility 5-45
USER Parameter
CTDSMFRP Utility 5-41
CTDUFUPD Utility 5-50
CTVJAR Utility 5-77
CTVUPGDB Utility 5-81
USS Support
Emergency Disconnect Utility 6-23
Utilities
Control Statement Syntax 7-6
Summary 1-2
Utility
Job Name / Table Name Xref Report
(CTMJTXRF) 3-131

V
VARIABLE Field
CTBVXRF Report 4-31
Variable Generations
CTBDBVCG Utility 4-11
VARIABLE Parameter
CTBDBVCG Utility 4-12
CTBDBVCP Utility 4-15
CTBDBVDL Utility 4-18
Vault Management
CTTSBD Utility 7-104
CTTVTM Utility 7-173
VAULTED Parameter

BMC Software, Inc., Confidential and Proprietary Information

28

INCONTROL for OS/390 and z/OS Utilities Guide

CTTSBD Utility 7-104

VENDOR Parameter
CTTDLD Utility 7-27
CTTTPI Utility 7-165
VER Parameter
IOAVERFY Utility 2-72
VERIFY FILE Parameter
IOAVERFY Utility 2-70
VERIFY Parameter
IOAVERFY Utility 2-70
VERIFY-IN-HISTORY Parameter
CTDCCU Utility 5-18
VERSION Parameter
CTTTPI Utility 7-165
VLTBYDS1 Parameter
CTTPARM 7-174
VOL Parameter
IOADBF Utility 2-33
IOADCPY Utility 2-44
VOLADD Statement
CTTMUP Utility 7-42
VOLBIX Statement
CTTMUP Utility 7-42, 7-46
VOLD Parameter
IOADBF Utility 2-33
VOLDEL Statement
CTTMUP Utility 7-42
VOLSCR Statement
CTTMUP Utility 7-42, 7-47
VOLSCRF Statement
CTTMUP Utility 7-45, 7-47
VOLSER Field
SCRATCH Report 7-94
VOLSER Parameter
CTDUPBKP Utility 5-59, 5-60
CTTGVL Utility 7-31
CTTMUP Utility 7-42
VOLSTAT Field
SCRATCH Report 7-94
Volume Expiration
CTTRTM Utility 7-85
VOLUPD Statement
CTTMUP Utility 7-42, 7-47

W
W Operator 2-5

WAIT PRINT Status

CTDBLXRP Utility 5-5
WAITDEC Parameter
CTDDELRP Utility 5-26
WAITPRINT Parameter
CTDDELRP Utility 5-26
WCAL Parameter
Calendar 3-130
CTMTBUPD Utility 3-120
WDATE Parameter
AutoEdit Simulation 3-137
CTMAESIM Utility 3-6
WDAYS Parameter
CTMTBUPD Utility 3-120
WM2367, optional Wish 3-43
WM2548, optional Wish 3-43
WM2744 Wish
CTMJSA Utiility 3-74
WR2FILE DD Statement
CTDUFUPD Utility 5-51
WRITE_TO_FILE Parameter
CTDUFUPD Utility 5-49
WTO Parameter
IOATEST Utility 2-67
WTOM Parameter
IOATEST Utility 2-67
WTOR Parameter
IOATEST Utility 2-67

X
XRF Parameter
CTMXRF Utility 3-130

BMC Software, Inc., Confidential and Proprietary Information

Index

29

BMC Software, Inc., Confidential and Proprietary Information

30

INCONTROL for OS/390 and z/OS Utilities Guide

END USER LICENSE AGREEMENT

NOTICE
BY OPENING THE PACKAGE, INSTALLING, PRESSING "AGREE" OR "YES" OR USING THE PRODUCT, THE ENTITY OR INDIVIDUAL
ENTERING INTO THIS AGREEMENT AGREES TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE WITH ANY OF
THESE TERMS, DO NOT INSTALL OR USE THE PRODUCT, PROMPTLY RETURN THE PRODUCT TO BMC OR YOUR BMC RESELLER,
AND IF YOU ACQUIRED THE LICENSE WITHIN 30 DAYS OF THE DATE OF YOUR ORDER CONTACT BMC OR YOUR BMC RESELLER FOR
A REFUND OF LICENSE FEES PAID. IF YOU REJECT THIS AGREEMENT, YOU WILL NOT ACQUIRE ANY LICENSE TO USE THE
PRODUCT.
This Agreement ("Agreement") is between the entity or individual entering into this Agreement ("You") and BMC Software Distribution, Inc., a
Delaware corporation located at 2101 CityWest Blvd., Houston, Texas, 77042, USA or its affiliated local licensing entity ("BMC"). "You" includes
you and your Affiliates. "Affiliate" is defined as an entity which controls, is controlled by or shares common control with a party. THIS
AGREEMENT WILL APPLY TO THE PRODUCT, UNLESS (1) YOU AGREED TO A WEB BASED LICENSE AGREEMENT WITH BMC WHEN
ORDERING THE PRODUCT, IN WHICH CASE THAT WEB BASED LICENSE AGREEMENT GOVERNS THE USE OF THE PRODUCT, OR (2) IF
YOU DID NOT AGREE TO A WEB BASED LICENSE AGREEMENT WITH BMC WHEN ORDERING THE PRODUCT AND YOU HAVE A
WRITTEN LICENSE AGREEMENT WITH BMC, THEN THAT WRITTEN AGREEMENT GOVERNS THE USE OF THE PRODUCT. THE
ELECTRONIC AGREEMENT PROVIDED WITH THE PRODUCT AS PART OF THE INSTALLATION OF THE PRODUCT WILL NOT APPLY. In
addition to the restrictions imposed under this Agreement, any other usage restrictions contained in the Product installation instructions or release
notes shall apply to Your use of the Product.
PRODUCT AND CAPACITY. "Software" means the object code version of the computer programs provided, via delivery or electronic
transmission, to You. Software includes computer files, enhancements, maintenance modifications, upgrades, updates, bug fixes, and error
corrections.
"Documentation" means all written or graphical material provided by BMC in any medium, including any technical specifications, relating to the
functionality or operation of the Software.
"Product" means the Software and Documentation.
"License Capacity" means the licensed capacity for the Software with the pricing and other license defining terms, including capacity restrictions,
such as tier limit, total allowed users, gigabyte limit, quantity of Software, and/or other capacity limitations regarding the Software. For licenses
based on the power of a computer, You agree to use BMCs current computer classification scheme, which is available at http://www.bmc.com or
can be provided to You upon request.
ACCEPTANCE. The Product is deemed accepted by You, on the date that You received the Product from BMC.
LICENSE. Subject to the terms of this Agreement, as well as Your payment of applicable fees, BMC grants You a non-exclusive, non-transferable,
perpetual (unless a term license is provided on an order) license for each copy of the Software, up to the License Capacity, to do the following:
(a) install the Software on Your owned or leased hardware located at a facility owned or controlled by You in the country where You acquired the
license;
(b) operate the Software solely for processing Your own data in Your business operations; and
(c) make one copy of the Software for backup and archival purposes only (collectively a "License").
If the Software is designed by BMC to permit you to modify such Software, then you agree to only use such modifications or new software
programs for Your internal purposes or otherwise consistent with the License. BMC grants You a license to use the Documentation solely for Your
internal use in Your operations.
LICENSE UPGRADES. You may expand the scope of the License Capacity only pursuant to a separate agreement with BMC for such expanded
usage and Your payment of applicable fees. There is no additional warranty period or free support period for license upgrades.
RESTRICTIONS: You agree to NOT:
(a) disassemble, reverse engineer, decompile or otherwise attempt to derive any Software from executable code;
(b) distribute or provide the Software to any third party (including without limitation, use in a service bureau, outsourcing environment, or
processing the data of third parties, or for rental, lease, or sublicense); or
(c) provide a third party with the results of any functional evaluation or benchmarking or performance tests, without BMCs prior written approval,
unless prohibited by local law.
TRIAL LICENSE. If, as part of the ordering process, the Product is provided on a trial basis, then these terms apply: (i) this license consists solely
of a non-exclusive, non-transferable evaluation license to operate the Software for the period of time specified from BMC or, if not specified, a 30
day time period ("Trial Period") only for evaluating whether You desire to acquire a capacity-based license to the Product for a fee; and (ii) Your use
of the Product is on an AS IS basis without any warranty, and BMC, ITS AFFILIATES AND RESELLERS, AND LICENSORS DISCLAIM ANY
AND ALL WARRANTIES (INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON-INFRINGEMENT) AND HAVE NO LIABILITY WHATSOEVER RESULTING FROM THE USE OF THIS
PRODUCT UNDER THIS TRIAL LICENSE ("Trial License"). BMC may terminate for its convenience a Trial License upon notice to You. When
the Trial Period ends, Your right to use this Product automatically expires. If You want to continue Your use of the Product beyond the Trial Period,
contact BMC to acquire a capacity-based license to the Product for a fee.
TERMINATION. This Agreement shall immediately terminate if You breach any of its terms. Upon termination, for any reason, You must uninstall
the Software, and either certify the destruction of the Product or return it to BMC.

OWNERSHIP OF THE PRODUCT. BMC or its Affiliates or licensors retain all right, title and interest to and in the BMC Product and all intellectual
property, informational, industrial property and proprietary rights therein. BMC neither grants nor otherwise transfers any rights of ownership in the
BMC Product to You. BMC Products are protected by applicable copyright, trade secret, and industrial and intellectual property laws. BMC
reserves any rights not expressly granted to You herein.
CONFIDENTIAL AND PROPRIETARY INFORMATION. The BMC Products are and contain valuable confidential information of BMC
("Confidential Information"). Confidential Information means non-public technical and non-technical information relating to the BMC Products
and Support, including, without limitation, trade secret and proprietary information, and the structure and organization of the Software. You may not
disclose the Confidential Information to third parties. You agree to use all reasonable efforts to prevent the unauthorized use, copying, publication
or dissemination of the Product.
WARRANTY. Except for a Trial License, BMC warrants that the Software will perform in substantial accordance with the Documentation for a
period of one year from the date of the order. This warranty shall not apply to any problems caused by software or hardware not supplied by BMC
or to any misuse of the Software.
EXCLUSIVE REMEDY. BMCs entire liability, and Your exclusive remedy, for any defect in the Software during the warranty period or breach of the
warranty above shall be limited to the following: BMC shall use reasonable efforts to remedy defects covered by the warranty or replace the
defective Software within a reasonable period of time, or if BMC cannot remedy or replace such defective copy of the Software, then BMC shall
refund the amount paid by You for the License for that Software. BMCs obligations in this section are conditioned upon Your providing BMC prompt
access to the affected Software and full cooperation in resolving the claim.
DISCLAIMER. EXCEPT FOR THE EXPRESS WARRANTIES ABOVE, THE PRODUCT IS PROVIDED "AS IS." BMC, ITS AFFILIATES AND
LICENSORS SPECIFICALLY DISCLAIM ALL OTHER WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. BMC DOES NOT WARRANT THAT THE
OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR FREE, OR THAT ALL DEFECTS CAN BE CORRECTED.
DISCLAIMER OF DAMAGES. IN NO EVENT IS BMC, ITS AFFILIATES OR LICENSORS LIABLE FOR ANY SPECIAL, INDIRECT,
INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES RELATING TO OR ARISING OUT OF THIS AGREEMENT, SUPPORT, AND/OR
THE PRODUCT (INCLUDING, WITHOUT LIMITATION, LOST PROFITS, LOST COMPUTER USAGE TIME, AND DAMAGE OR LOSS OF USE
OF DATA), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IRRESPECTIVE OF ANY NEGLIGENCE OF BMC OR
WHETHER SUCH DAMAGES RESULT FROM A CLAIM ARISING UNDER TORT OR CONTRACT LAW.
LIMITS ON LIABILITY. BMCS AGGREGATE LIABILITY FOR DAMAGES IS LIMITED TO THE AMOUNT PAID BY YOU FOR THE LICENSE TO
THE PRODUCT.
SUPPORT. If Your order includes support for the Software, then BMC agrees to provide support (24 hours a day/7 days a week) ("Support"). You
will be automatically re-enrolled in Support on an annual basis unless BMC receives notice of termination from You as provided below. There is a
free support period during the one year warranty period.
(a) Support Terms. BMC agrees to make commercially reasonable efforts to provide the following Support: (i) For malfunctions of supported
versions of the Software, BMC provides bug fixes, patches or workarounds in order to cause that copy of the Software to operate in substantial
conformity with its then-current operating specifications; and (ii) BMC provides new releases or versions, so long as such new releases or versions
are furnished by BMC to all other enrolled Support customers without additional charge. BMC may refuse to provide Support for any versions or
releases of the Software other than the most recent version or release of such Software made available by BMC. Either party may terminate Your
enrollment in Support upon providing notice to the other at least 30 days prior to the next applicable Support anniversary date. If You re-enroll in
Support, BMC may charge You a reinstatement fee of 1.5 times what You would have paid if You were enrolled in Support during that time period.
(b) Fees. The annual fee for Support is 20% of the Softwares list price less the applicable discount or a flat capacity based annual fee. BMC may
change its prices for the Software and/or Support upon at least 30 days notice prior to Your support anniversary date.
VERIFICATION. If requested by BMC, You agree to deliver to BMC periodic written reports, whether generated manually or electronically, detailing
Your use of the Software in accordance with this Agreement, including, without limitation, the License Capacity. BMC may, at its expense, audit
Your use of the Software to confirm Your compliance with the Agreement. If an audit reveals that You have underpaid fees, You agree to pay such
underpaid fees. If the underpaid fees exceed 5% of the fees paid, then You agree to also pay BMCs reasonable costs of conducting the audit.
EXPORT CONTROLS. You agree not to import, export, re-export, or transfer, directly or indirectly, any part of the Product or any underlying
information or technology except in full compliance with all United States, foreign and other applicable laws and regulations.
GOVERNING LAW. This Agreement is governed by the substantive laws in force, without regard to conflict of laws principles: (a) in the State of
New York, if you acquired the License in the United States, Puerto Rico, or any country in Central or South America; (b) in the Province of Ontario,
if you acquired the License in Canada (subsections (a) and (b) collectively referred to as the "Americas Region"); (c) in Singapore, if you acquired
the License in Japan, South Korea, Peoples Republic of China, Special Administrative Region of Hong Kong, Republic of China, Philippines,
Indonesia, Malaysia, Singapore, India, Australia, New Zealand, or Thailand (collectively, "Asia Pacific Region"); or (d) in the Netherlands, if you
acquired the License in any other country not described above. The United Nations Convention on Contracts for the International Sale of Goods is
specifically disclaimed in its entirety.
ARBITRATION. ANY DISPUTE BETWEEN YOU AND BMC ARISING OUT OF THIS AGREEMENT OR THE BREACH OR ALLEGED BREACH,
SHALL BE DETERMINED BY BINDING ARBITRATION CONDUCTED IN ENGLISH. IF THE DISPUTE IS INITIATED IN THE AMERICAS
REGION, THE ARBITRATION SHALL BE HELD IN NEW YORK, U.S.A., UNDER THE CURRENT COMMERCIAL OR INTERNATIONAL, AS
APPLICABLE, RULES OF THE AMERICAN ARBITRATION ASSOCIATION. IF THE DISPUTE IS INITIATED IN A COUNTRY IN THE ASIA
PACIFIC REGION, THE ARBITRATION SHALL BE HELD IN SINGAPORE, SINGAPORE UNDER THE CURRENT UNCITRAL ARBITRATION
RULES. IF THE DISPUTE IS INITIATED IN A COUNTRY OUTSIDE OF THE AMERICAS REGION OR ASIA PACIFIC REGION, THE
ARBITRATION SHALL BE HELD IN AMSTERDAM, NETHERLANDS UNDER THE CURRENT UNCITRAL ARBITRATION RULES. THE
COSTS OF THE ARBITRATION SHALL BE BORNE EQUALLY PENDING THE ARBITRATORS AWARD. THE AWARD RENDERED SHALL
BE FINAL AND BINDING UPON THE PARTIES AND SHALL NOT BE SUBJECT TO APPEAL TO ANY COURT, AND MAY BE ENFORCED IN
ANY COURT OF COMPETENT JURISDICTION. NOTHING IN THIS AGREEMENT SHALL BE DEEMED AS PREVENTING EITHER PARTY
FROM SEEKING INJUNCTIVE RELIEF FROM ANY COURT HAVING JURISDICTION OVER THE PARTIES AND THE SUBJECT MATTER OF
THE DISPUTE AS NECESSARY TO PROTECT EITHER PARTYS CONFIDENTIAL INFORMATION, OWNERSHIP, OR ANY OTHER

PROPRIETARY RIGHTS. ALL ARBITRATION PROCEEDINGS SHALL BE CONDUCTED IN CONFIDENCE, AND THE PARTY PREVAILING IN
ARBITRATION SHALL BE ENTITLED TO RECOVER ITS REASONABLE ATTORNEYS FEES AND NECESSARY COSTS INCURRED
RELATED THERETO FROM THE OTHER PARTY.
U.S. GOVERNMENT RESTRICTED RIGHTS. The Software under this Agreement is "commercial computer software" as that term is described in
48 C.F.R. 252.227-7014(a)(1). If acquired by or on behalf of a civilian agency, the U.S. Government acquires this commercial computer software
and/or commercial computer software documentation subject to the terms of this Agreement as specified in 48 C.F.R. 12.212 (Computer Software)
and 12.211 (Technical Data) of the Federal Acquisition Regulations ("FAR") and its successors. If acquired by or on behalf of any agency within
the Department of Defense ("DOD"), the U.S. Government acquires this commercial computer software and/or commercial computer software
documentation subject to the terms of this Agreement as specified in 48 C.F.R. 227.7202 of the DOD FAR Supplement and its successors.
MISCELLANEOUS TERMS. You agree to pay BMC all amounts owed no later than 30 days from the date of the applicable invoice, unless
otherwise provided on the order for the License to the Products. You will pay, or reimburse BMC, for taxes of any kind, including sales, use, duty,
tariffs, customs, withholding, property, value-added (VAT), and other similar federal, state or local taxes (other than taxes based on BMCs net
income) imposed in connection with the Product and/or the Support. This Agreement constitutes the entire agreement between You and BMC and
supersedes any prior or contemporaneous negotiations or agreements, whether oral, written or displayed electronically, concerning the Product
and related subject matter. No modification or waiver of any provision hereof will be effective unless made in a writing signed by both BMC and
You. You may not assign or transfer this Agreement or a License to a third party without BMCs prior written consent. Should any provision of this
Agreement be invalid or unenforceable, the remainder of the provisions will remain in effect. The parties have agreed that this Agreement and the
documents related thereto be drawn up in the English language. Les parties exigent que la prsente convention ainsi que les documents qui sy
rattachent soient rdigs en anglais.

SW EULA Int 030102

Notes


 

 

 

 
*15840*