CONTROL-M

for OS/390 and z/OS

User Guide
Supporting
CONTROL-M for OS/ 390 and z/ OS Version 6.1.11
October 11, 2004
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 BMC Software, Inc.
2101 CityWest Blvd.
Houston TX 77042-2827
Telephone
Fax
(01) 713 918 8800
(01) 713 918 8000
Telephone 713 918 8800 or
800 841 2031
Fax 713 918 8000
Copyright 2004 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 is a registered trademark of International Business Machines Corporation.
DB2 is a registered trademark of International Business Machines Corporation.
All other trademarks belong to their respective companies.
BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this
information is subject to the terms and conditions of the applicable End User License Agreement for the product and the
proprietary and restricted rights notices included in this documentation.
Restricted Rights Legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE
COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the
U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS
252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, 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.
3
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_home. From this Web site, you can
s read overviews about support services and programs that BMC Software offers
s find the most current information about BMC Software products
s search a database for problems similar to yours and possible solutions
s order or download product documentation
s report a problem or ask a question
s subscribe to receive e-mail notices when new product versions are released
s 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 http:/ / www.bmc.com/ support_home.
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:
s product information
product name
product version (release number)
license number and password (trial or permanent)
s 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
s sequence of events leading to the problem
s commands and options that you used
s messages received (and the time and date that you received them)
product error messages
messages from the operating system, such as f i l e syst em f ul l
messages from related software
4 CONTROL-M for OS/390 and z/OS User Guide
Contents 5
Contents
About This Guide 31
Conventions Used in This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Information New to This Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Information Relating to CONTROL-M/ Restart Users . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Chapter 1 Introduction to CONTROL-M 39
INCONTROL Products and IOA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
IOA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
INCONTROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Functional Approach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Main Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Expanded CONTROL-M Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CONTROL-M Support for MAINVIEW Batch Optimizer . . . . . . . . . . . . . . . . . . . 55
Online User Interface to CONTROL-M . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
CONTROL-M Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
IOA Core and CONTROL-M Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Date Definition Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Date Standards and Date Field Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Job Ordering and Job Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Rerun and Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Order ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
SYSDATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Handling of Job Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Prerequisite Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Quantitative and Control Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Job Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Automatic Job Flow Adjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Chapter 2 Online Facilities 77
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IOA Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
General IOA Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IOA Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
IOA Primary Option Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Multi-Screen Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Fast Exit from the IOA Online Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Screen Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
6 CONTROL-M for OS/390 and z/OS User Guide
Commands and PFKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
AutoRefresh Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
IOA Under ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
IOA Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
IOA SET Command Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
IOA TSO Command Processor Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Scheduling Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Table List screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Job List Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Job Scheduling Definition Screen Defining Schedules . . . . . . . . . . . . . . . . . . . . 128
Exiting the Scheduling Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Ordering (Scheduling) Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Copying Jobs to Another Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Deleting Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Displaying Graphic Jobflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Displaying a Job Scheduling Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Tracking and Control Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Active Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Global View Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
View Graph Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Why Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Deleting a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Confirm Scheduling Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Confirm Rerun Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Restart Confirm Restart Window (Under CONTROL-M/ Restart) . . . . . . . . . 223
RestartRerun and/ or Restart Window (Under CONTROL-M/ Restart) . . . . . 223
RestartStep List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
RestartJob Order Execution History Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Restart Sysout Viewing Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Statistics Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Job Dependency Network Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Restart History Environment Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Force OK Confirmation Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
CMEM Rule Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Table List Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Rule List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Rule Definition Screen Defining Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Entering Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Editing CMEM Rule Definitions in the Edit Environment . . . . . . . . . . . . . . . . . . 257
Exiting the CMEM Rule Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Deleting Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Ordering CMEM Rule Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Copying Rules to Another Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
IOA Variables Database Facility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Contents 7
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Database List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Values of Database Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Variable Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Condition and Resource Handling Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
IOA Conditions/ Resources Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
IOA Manual Conditions Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
IOA Log Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
IOA Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
IOA Calendar Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Accessing the IOA Calendar Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Calendar List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Year List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Copying Years to Another Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Calendar Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Exiting the IOA Calendar Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Utilities Under ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
IOA Online Utilities Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
I1: Add, Check, or Delete a Prerequisite Condition . . . . . . . . . . . . . . . . . . . . . . . . 322
M1: Issue a Job Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
M2: Perform an AutoEdit Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
M3: Prepare Simulation/ Tape Pull List Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
M4: Parameter Prompting Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
M5: Quick Schedule Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
M6: End-User Job Order Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
U1: Invoke DOCU/ TEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Chapter 3 Job Production Parameters 375
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
General Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Basic Scheduling Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Runtime Scheduling Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Post-Processing Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
ADJUST CONDITIONS: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
APPL: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Restart AUTO-ARCHIVE: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . 398
CONFCAL: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
CONFIRM: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
CONTROL: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
CTB STEP: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
D-CAT: Basic Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
DATES: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
DAYS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
DEFINITION ACTIVE: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . 430
DESC: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
DO Statement: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
DO COND: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
8 CONTROL-M for OS/390 and z/OS User Guide
DO CTBRULE: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
DO FORCEJOB: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
RestartDO IFRERUN: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 446
DO MAIL: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
DO NOTOK: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
DO OK: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
DO RERUN: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
DO SET: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
DO SHOUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
DO STOPCYCL: Post-Processing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
DO SYSOUT: Post-Processing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
DOC: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
DOCLIB: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
DOCMEM: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
DUE OUT: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
GROUP: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
GRP MAXWAIT: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
IN: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
INTERVAL: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
MAXRERUN: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
MAXWAIT: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
MEMLIB: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
MEMNAME: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
MINIMUM: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
MONTHS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
NJE NODE: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
ON: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
ON GROUP-END: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
OUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
OVERLIB: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
OWNER: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
PDS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
PIPE: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
RestartPREVENT-NCT2:General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
PRIORITY: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
RELATIONSHIP: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
RERUNMEM: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
RESOURCE: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Restart RETENTION: # OF DAYS TO KEEP: PostProcessing Parameter . . . . . . 594
RestartRETENTION: # OF GENERATIONS TO KEEP: PostProcessing Parameter
596
RETRO: Basic Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
SAC: Run Time Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
SCHEDULE TAG: Basic Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
SCHEDULE TAG ACTIVE: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . 607
SCHENV: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
SET VAR: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
SHOUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
STEP RANGE: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Contents 9
SYSOUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
SYSTEM ID: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
TASKTYPE: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
TIME: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
TIME ZONE: Runtime Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
WDAYS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Chapter 4 CONTROL-M Event Manager (CMEM) 665
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Types of Events Managed by CMEM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Types of Actions That CMEM Can Perform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
CMEM Rule Ordering, Triggering and Deactivation. . . . . . . . . . . . . . . . . . . . . . . 668
CMEM AutoEdit Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
On Spool Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Support for ON DSNEVENT and ON STEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
CMEM Support for FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
CMEM Support for IBM FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Rule Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Event Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
General Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Action Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
DESCRIPTION: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
DO statement: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
DO COND: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
DO FORCEJOB: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
DO RULE: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
DO SHOUT: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
DO STOPJOB: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
GROUP: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
MODE: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
ON statement: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
ON DSNEVENT: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
ON JOBARRIV: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
ON JOBEND: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
ON STEP: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
OWNER: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
RUNTSEC: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
THRESHOLD: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Chapter 5 JCL and AutoEdit Facility 731
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Non-Date System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Date System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Special System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
User-Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Valid Characters in User-Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
10 CONTROL-M for OS/390 and z/OS User Guide
Local Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
JCL Setup Operation Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Rules of Variable Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Order of Precedence for Multiple Value Assignments. . . . . . . . . . . . . . . . . . . . . . 758
Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
%%GLOBAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
%%GOTO and %%LABEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
%%IF, %%ELSE, %%ENDIF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
%%INCLIB and %%INCMEM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
%%LIBSYM and %%MEMSYM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
%%RANGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
%%RESOLVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
%%SET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
%%$CALCDTE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
%%$GREG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
%%$JULIAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
%%$LEAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
%%$WCALC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
%%$WEEK# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
%%$WEEKDAY. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
%%$YEARWK# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
%%CALCDATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
%%SUBSTR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
%%$LENGTH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
%%$TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
%%$FUNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
Testing AutoEdit Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
AutoEdit Usage in the Job Scheduling Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Date Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
ODATE, RDATE and DATE Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
How to Obtain Date Formats 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
How to Obtain Date Formats 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
How to Obtain Date Formats 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
How to Obtain the Previous Months Last Business Date . . . . . . . . . . . . . . . . . . . 790
Automatic Job Order for the Next Day. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Tape Clearance System Stage 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Tape Clearance System Stage 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Tape Management System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Dynamic Job Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Controlling the Target Computer by Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Controlling the Target Computer by System Affinity . . . . . . . . . . . . . . . . . . . . . . 795
%%BLANKn Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
%%RANGE Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
SYSIN Parameter Containing %%. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
%%INCLIB and %%INCMEM Statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Contents 11
Boolean IF Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Chapter 6 Selected Implementation Issues 803
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Job Ordering Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Job Ordering Through Quick Submit Command CTMQSB. . . . . . . . . . . . . . . . . 805
Special Purpose Job Ordering From Special Environments: CTMAJO. . . . . . . . 807
Manual Conditions File and Maybe Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Loading the Manual Conditions File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Using the Manual Conditions File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Handling Manual Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Handling Unscheduled Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Handling Maybe Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Maybe Jobs in Group Scheduling Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
MAINVIEW Batch Optimizer Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Job-Related Considerations for Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Enhanced Runtime Scheduling Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
System-Related Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Parameter Prompting Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Parameter Prompting Facility Type 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Usage Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Parameter Prompting FacilityType 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Maintenance Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Chapter 7 Simulation and Forecasting Facility 833
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Simulation Procedure CTMSIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Activating the Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Preparatory Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Input Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Output Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
CONTROL-M Exits and Simulation Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Analyzing the Simulation Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Handling Manual Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
The CTMTAPUL Tape Pull List Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Activating the Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
JOB/ SCANDOCU/ TEXT Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Problem Determination for Tape Pull List Reports . . . . . . . . . . . . . . . . . . . . . . . . 850
Sample Tape Pull List Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Chapter 8 KeyStroke Language (KSL) 855
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
CTMAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
12 CONTROL-M for OS/390 and z/OS User Guide
KeyStroke Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Activating KeyStroke Language Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
KSL Command and Variable Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Principles of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Language Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
KSL Commands and Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
KSL Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Special KSL Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Sample KeyStroke Reports and Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Sample KSL Report Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 883
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Environment and Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
1. Order or Force Existing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Order or Force under Batch, REXX or CLIST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Order or Force Using Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Order or Force Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Order or Force Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Order or Force Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Order or Force Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
2. Create, Order, or Force New Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Invoking Create, Order or Force New Tables Using Program . . . . . . . . . . . . . . . 890
Create, Order or Force Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Create, Order or Force Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Create, Order or Force Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . 891
Create, Order or Force Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
3. AJF Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
AJF Action under Batch, REXX or CLIST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
AJF Action using Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
AJF Action Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
AJF Action Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
AJF Action Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
AJF Action Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
4. Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Search under Batch, REXX or CLIST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Invoking Search from a Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
Search Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Search Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Search Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Search Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
5. Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Global Variables under Batch REXX or CLIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Conditional Requests and Selection Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Performance Considerations for Selection Criteria. . . . . . . . . . . . . . . . . . . . . . . . . 901
Search Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Conversational Mode using Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Contents 13
Input and Output Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
CTMBAPI DSECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Status Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
The Status Reply DSECT (CTMBJSE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
Status Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Status Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Status Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Status Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Order Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Order Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Order Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Order or Force Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Order or Force Security Consideration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
AJF Action Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Identifying the Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Defining the Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Action Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Action AJF Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Action Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Global Variable Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Global Variable Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
Quantitative Resource Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
Quantitative Resource Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Quantitative Resource Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Quantitative Resource Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Create And/ Or Order or Force a Table (BLT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
BLT Action Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
BLT Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
BLT Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
BLT Resource Allocations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
CTMBAPO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
Date Format Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Appendix B CONTROL-M for OS/390 and z/OS Unix System Services (USS) 927
Implementation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
OS/ 390-Oriented Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Unix Oriented Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Integrating SAP R/ 3 running on USS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
CONTROL-M Support for SAP in the USS Environment . . . . . . . . . . . . . . . . . . . 931
Appendix C Editing Job Scheduling Definitions in the Edit Environment 935
Line Editing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Maintaining Valid Job Scheduling Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Appendix D Editing CMEM Rule Definitions in the Edit Environment 949
Line Editing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
14 CONTROL-M for OS/390 and z/OS User Guide
Maintaining Valid Rule Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Appendix E AutoEdit Facility in KSL 955
System Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
AutoEdit System Variables: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
User-Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Rules of Variable Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
AutoEdit Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
%%$CALCDATE Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
%%$SUBSTR Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
%%$TIMEINT Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
%%$PARSE Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Appendix F MVS Job Restart Without CONTROL-M/Restart 975
Index 979
Figures 15
Figures
Establishing Job Dependency by Prerequisite Conditions . . . . . . . . . . . . . . . . . . . . . . 70
IOA Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
IOA Primary Option Menu where only CONTROL-M is Installed . . . . . . . . . . . . . . 86
IOA Primary Option Menu when all INCONTROL Products are Installed . . . . . . . 88
IOA Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
IOA Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
PFKey Assignment Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
IOA Help Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
IOA Editor Edit Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
IOA Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
IOA SET Command Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
IOA TSO Command Processor Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
CONTROL-M Scheduling Definition Facility - Entry Panel . . . . . . . . . . . . . . . . . . . . 118
CONTROL-M Scheduling Definition Facility - Entry Panel Search Window . . . . . 120
CONTROL-M Scheduling Definition Facility Table List Screen . . . . . . . . . . . . . . . . 122
CONTROL-M Scheduling Definition Facility Job List Screen . . . . . . . . . . . . . . . . . . 125
Job Scheduling Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
General Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Basic Scheduling Parameters - Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Basic Scheduling Parameters - Group Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Runtime Scheduling Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Post-Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Group Entity Scheduling Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Editing Job Scheduling Definitions in the Edit Environment Screen . . . . . . . . . . . . 146
Job Scheduling Definition DOC lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Save Documentation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Job List Screen Exit Option Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Order and Force Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
The Double Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Window for Copying Jobs to Another Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Delete Table Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Graphic Jobflow for Color Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Graphic Jobflow for Non-Color Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Job Scheduling Plan Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Job Scheduling Plan Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
CONTROL-M Active Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Display Type D (Default) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Display Type A (All Fields) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
IOA Log Screen Display Filters Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Show Screen Filter Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
16 CONTROL-M for OS/390 and z/OS User Guide
Global View Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
View Graph Screen Format for Color Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
View Graph Screen Format for Non-Color Terminals . . . . . . . . . . . . . . . . . . . . . . . . . 203
Active Environment Why Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Why Screen Add Condition or Delete NOT-COND Confirmation Window . . . . . . 208
Active Environment Screen Delete Confirmation Window . . . . . . . . . . . . . . . . . . . . 211
Active Messages Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
CONTROL-M Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Zoom Screen for Group Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Adding or Editing a Job Order Note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Exiting the Zoom Screen Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Active Environment Screen Confirm Rerun Window . . . . . . . . . . . . . . . . . . . . . . . . . 222
Restart Active Environment Rerun and/ or Restart Confirmation Window . . . . 224
Restart Rerun and/ or Restart Step List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Restart Job Order Execution History Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Restart Sysout Viewing Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Active Environment Statistics Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Tape Device Usage Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Job Dependency Network Display Type N (Network) . . . . . . . . . . . . . . . . . . . . . . . . 237
Restart History Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
CONTROL-M Active Environment FORCE OK Confirmation Window . . . . . . . . . 242
CMEM Rule Definition Facility Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
CMEM Definition Facility Table List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
CMEM Rule Definition Rule List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Rule Definition Screen - Defining Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
CMEM Rule Definition Event Selection Parameters - Example . . . . . . . . . . . . . . . . . 252
General Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Rule Definition Screen Comment Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Entering Edit Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Rule List Screen Exit Option Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Rule Definition Facility Delete Table Confirmation Window . . . . . . . . . . . . . . . . . . . 261
Order and Force Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Window for Copying Rules to Another Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
IOA Variable Database Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
IOA Variable Database Facility Database List Screen . . . . . . . . . . . . . . . . . . . . . . . . . 268
IOA Values of Database Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Variable Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
IOA Conditions/ Resources Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
IOA Conditions/ Resources COND Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
IOA Conditions/ Resources DELETE Confirmation Window . . . . . . . . . . . . . . . . . . 282
IOA Conditions/ Resources CHANGE Option Window . . . . . . . . . . . . . . . . . . . . . . . 283
IOA Manual Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
IOA Manual Conditions Screen NEW Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
IOA Manual Conditions Screen ERASE Confirmation Window . . . . . . . . . . . . . . . . 288
IOA Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
IOA Log Screen Display Filters Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
IOA Log Show Screen Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
IOA Log Show Screen Window at Sites where Multiple INCONTROL Products are
Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Figures 17
IOA Calendar Facility Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Calendar List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Year List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Calendar List Screen Copy Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Calendar Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Use of Reserved String ==PERIODIC== . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Periodic Calendar Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Periodic Calendar Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Calendar List Screen Delete Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Year List Screen Exit Option Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
IOA Online Utilities Menu when all INCONTROL Products are Installed . . . . . . . 321
Prerequisite Condition Utility Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Job Request Utility Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
CONTROL-M AutoEdit Simulation Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
CONTROL-M Simulation and Forecasting Facility and Tape Pull List . . . . . . . . . . 330
Parameters Prompting Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Parameter Prompting Facility (Type 1) Primary Menu . . . . . . . . . . . . . . . . . . . . . . . . 338
Define Parameters and Condition - New Master Table Screen . . . . . . . . . . . . . . . . . 339
Define Parameters/ and Conditions - Master Table Definition Screen . . . . . . . . . . 340
Define Parameters and Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Define Parameters and Conditions Save Screen Window . . . . . . . . . . . . . . . . . . . . . 343
Update Parameters and Set conditions - Table Selection Screen . . . . . . . . . . . . . . . . 344
Table Selection Screen Delete Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . 345
Update Parameters and Set Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Update Parameters and Set Conditions - Confirm Parameter Update Actions . . . . 347
Parameter Prompting Facility (Type 2) Primary Menu . . . . . . . . . . . . . . . . . . . . . . . . 349
Primary Prompting Facility Define or Update a Master Plan . . . . . . . . . . . . . . . . . 350
Parameter Prompting Facility Master Plan Definition . . . . . . . . . . . . . . . . . . . . . . . 351
Define Parameters in the Master Plan Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Fetch a Plan Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Exec/ Order a Plan (CTMEXEC) Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Plan Selection Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Update Parameters Values Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
CONTROL-M Quick Schedule Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
CONTROL-M Quick Search Schedule Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Quick Schedule Definition Job List Screen Entered . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Quick Schedule Definition Facility Exit Option Window . . . . . . . . . . . . . . . . . . . . . . 369
Scheduling Definition Screen Quick Schedule Definition Example . . . . . . . . . . . . . 371
Job List Screen Entered Through the End-User Job Order Interface . . . . . . . . . . . . . 372
Job Scheduling Date and FORCE Options Window . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Job Scheduling Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Group Entity Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Group Scheduling Flowchart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
ADJUST CONDITIONS Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
ADJUST CONDITIONS Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
APPL Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
APPL Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Restart AUTO-ARCHIVE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Restart AUTO-ARCHIVE Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
18 CONTROL-M for OS/390 and z/OS User Guide
CONFCAL Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Days When Job Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
CONFIRM Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
CONFIRM Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
CONTROL Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
CONTROL Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
CONTROL Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
CONTROL Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
CTB STEP Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
CTB STEP Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
DCAT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
DCAT Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
DATES Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
DATES Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
DAYS Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
DAYS Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
DAYS Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
DAYS Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
DAYS Parameter Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
DAYS Parameter Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
DAYS Parameter Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
DAYS Parameter Example 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
DAYS Parameter Example 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
DAYS Parameter Example 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
DAYS Parameter Example 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
DEFINITION ACTIVE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
DESC Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
DESC Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
DO Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
DO COND Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Long DO COND Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
DO COND Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
DO CTBRULE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
DO CTBRULE Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
DO FORCEJOB Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
DO FORCEJOB Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Restart DO IFRERUN Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Restart DO IFRERUN Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
DO MAIL Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
DO MAIL Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
DO NOTOK Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
DO NOTOK Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
DO OK Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
DO OK Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
DO RERUN Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
DO RERUN Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
DO SET Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
DO SET Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
DO SHOUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Figures 19
DO SHOUT Subparameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
DO STOPCYCL Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
DO STOPCYCL Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
DO SYSOUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Effect of Merging Multiple SYSOUT Statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
DO SYSOUT Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
DO SYSOUT Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
DOC Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
DOC Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
DOCLIB Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
DOCLIB Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
DOCMEM Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
DOCMEM Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
DUE OUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
DUE OUT Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
GROUP Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
GROUP Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
GRP MAXWAIT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
GRP MAXWAIT Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
IN Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Long IN Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
IN Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
IN Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
IN Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
IN Parameter Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
IN Parameter Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
IN Parameter Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
INTERVAL Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
INTERVAL Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
MAXRERUN Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
MAXRERUN Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
MAXWAIT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
MAXWAIT Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
MAXWAIT Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
MEMLIB Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
MEMLIB Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
MEMNAME Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
MEMNAME Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
MINIMUM Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
MINIMUM Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
MINIMUM Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
MONTHS Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
MONTHS Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
NJE NODE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
ON Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
ON Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
ON Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
ON Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
ON GROUP-END Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
20 CONTROL-M for OS/390 and z/OS User Guide
ON GROUP-END Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
OUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Long OUT Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
OUT Parameter Example 1 First Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
OUT Parameter Example 1 Second Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
OUT Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
OUT Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
OVERLIB Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
OVERLIB Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
OWNER Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
OWNER Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
PDS Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
PDS Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
PIPE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
PIPE Parameter Example Job CTLIVPWR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
PIPE Parameter Example Job CTLIVPRD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Restart PREVENT-NCT2 Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Restart PREVENT-NCT2 Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
PRIORITY Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
RELATIONSHIP Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
RELATIONSHIP Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
RERUNMEM Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
RERUNMEM Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
RESOURCE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
RESOURCE Parameter Example 1A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
RESOURCE Parameter Example 1B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
RESOURCE Parameter Example 1C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Restart RETENTION: # OF DAYS TO KEEP Parameter Format . . . . . . . . . . . . . . 594
Restart RETENTION: # OF DAYS TO KEEP Parameter Example . . . . . . . . . . . . 595
Restart RETENTION: # OF GENERATIONS TO KEEP Parameter Format . . . 596
Restart RETENTION: # OF GENERATIONS TO KEEP Parameter Example . . . 597
RETRO Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
RETRO Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
SAC Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
SAC Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
SCHEDULE TAG Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
SCHEDULE TAG Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
SCHEDULE TAG Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
SCHEDULE TAG ACTIVE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
SCHENV Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
SET VAR Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
SET VAR Parameter Example 2A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
SET VAR Parameter Example 2B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
SHOUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
SHOUT Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
SHOUT and DO SHOUT Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
STEP RANGE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
STEP RANGE Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
SYSOUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Figures 21
Merging SYSOUT and DO SYSOUT Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
SYSOUT Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
SYSTEM ID Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
TASKTYPE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
TASKTYPE Parameter Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
TIME Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
TIME Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
TIME ZONE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
WDAYS Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
WDAYS Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
WDAYS Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
WDAYS Parameter Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
WDAYS Parameter Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
WDAYS Parameter Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
WDAYS Parameter Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
WDAYS Parameter Example 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
WDAYS Parameter Example 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
WDAYS Parameter Example 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
WDAYS Parameter Example 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
CMEM Rule Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
DESCRIPTION Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
DESCRIPTION Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
DO Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
DO COND Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
DO COND Parameter Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
DO COND Parameter Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
DO FORCEJOB Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
DO FORCEJOB Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
DO FORCEJOB Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
DO RULE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
DO RULE Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
DO SHOUT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
DO SHOUT Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
DO STOPJOB Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
DO STOPJOB Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
GROUP Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
GROUP Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
MODE Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
MODE Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
ON Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
ON DSNEVENT Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
ON DSNEVENT Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
ON JOBARRIV Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
ON JOBARRIV Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
ON JOBEND Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
ON JOBEND Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
ON STEP Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
ON STEP Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
OWNER Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
22 CONTROL-M for OS/390 and z/OS User Guide
OWNER Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
RUNTSEC Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
RUNTSEC Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
THRESHOLD Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
THRESHOLD Parameter Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Illustration 1A: How CONTROL-M Formerly Handled A New Tape . . . . . . . . . . . 817
Illustration 1B: Steps Formerly Performed by the User . . . . . . . . . . . . . . . . . . . . . . . . 818
Illustration 2A: How CONTROL-M Now Handles A New Tape . . . . . . . . . . . . . . . 819
Illustration 2B: Single Step Now Performed by the User . . . . . . . . . . . . . . . . . . . . . . 820
Parameter Prompting Facility Type 2: Definition Phase . . . . . . . . . . . . . . . . . . . . . . . 822
Parameter Prompting Facility Type 2: Fetch Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Parameter Prompting Facility Type 2: EXEC Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
The FETCH A PLAN Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
The EXEC / ORDER A PLAN Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
PPF2DEL Utility Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
CONTROL-M Simulation Exit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Sample Tape Pull List Report 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Sample Tape Pull List Report 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
Sample Tape Pull List Report 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Sample Tape Pull List Report 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Output from KSL Library Sample KSLREPSCHED . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
JCL for USS Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
CONTROL-M Architecture for Unix-Oriented MVS Implementation . . . . . . . . . . . 929
Architecture of SAP R/ 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Communication with the R/ 3 Application Layer - DB/ 2 Database . . . . . . . . . . . . . 932
Communication with the R/ 3 Application - SAP/ R3 Database . . . . . . . . . . . . . . . . 933
The Edit Environment in The Job Scheduling Definition Screen . . . . . . . . . . . . . . . . 935
Example - Inserting A DO Statement - Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Example - Inserting A DO Statement - After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Example - Deleting A Block - Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Example - Deleting A Block - After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Example - Moving Statements - Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Example - Moving Statements - After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Example - Copying Statements - Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Example - Copying Statements - After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Example - Inserting A Line - Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Example - Inserting A Line - After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
The Edit Environment in The Rule Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . 949
Example - Repeating A DO Block - Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Example - Repeating A DO Block - After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Example - Automatic Restart - CONTROL-M Only . . . . . . . . . . . . . . . . . . . . . . . . . . . 977
Tables 23
Tables
List of INCONTROL Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Job Scheduling Definition Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Runtime Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Conditions and Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
NJE Network Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Event Types Handled by CMEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
KSL Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
IOA Core Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Date Definition Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Gregorian Date Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Supported Gregorian Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Julian Date Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Group Handling Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Prerequisite Condition Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Runtime Scheduling Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Prefixing Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Masking Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
INCONTROL Shared IOA Functions and Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
CONTROL-M Functions and Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
IOA Primary Option Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
IOA Transfer Control Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Basic IOA Screen Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Common PFKey Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Additional Key Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Scrolling Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Scrolling Amounts in the SCROLL Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ISPF Commands that must be defined for PFKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
PFKey Functions Within the IOA Editor Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
IOA Editor Command Line Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
IOA Editor Row Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Scheduling Definition Facility Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Scheduling Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Options of the Table List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Commands of the Job List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Options of the Job List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Parameters of the Job Scheduling Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . 130
General Job Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Basic Scheduling Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Runtime Scheduling Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Post-Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
24 CONTROL-M for OS/390 and z/OS User Guide
Parameters of the Group Entity Scheduling Definition Screen . . . . . . . . . . . . . . . . . 142
Commands of the Job Scheduling Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Save Documentation Window Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Commands for Exiting the Rule Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Options for Manually Ordering Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Order and Force Confirmation Window Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Fields in the Window for Copying Jobs to Another Table . . . . . . . . . . . . . . . . . . . . . 157
Color Change Options on Graphic Jobflow Window . . . . . . . . . . . . . . . . . . . . . . . . . 160
Job Scheduling Plan Window Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Job Scheduling Plan Screen Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Default Colors for Active Missions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Predefined Display Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Fields in the Default Display Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Fields for Each Job Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Other Information in the STATUS Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Fields in the All Fields Display Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Commands of the Active Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Options of the Active Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Job Statuses for the Active Environment screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Group Statuses for the Active Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Field of the Display Filters Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Options of the Display Filters window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Fields of the Show Screen Filter Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Show Screen Filter Window Selection Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Show Screen Filter Window - Closing Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Fields of the Global View Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Fields of the View Graph Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Job Status Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Fields of the View Graph Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Job Graph Status Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Fields of the Add Condition or Delete NOT-COND Confirmation Window . . . . . 208
Fields of the Job Scheduling Definition Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . 214
Commands of the Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Restart Fields of the Active Environment Rerun and/ or Restart Confirmation
Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Restart Options of the Rerun and/ or Restart Step List Window . . . . . . . . . . . . . . 229
Restart Default Display Type Fields of Job Order Execution History Screen . . . 230
Restart Fields in the Job Order Execution History Screen . . . . . . . . . . . . . . . . . . . . 231
Restart Commands of the Sysout Viewing Screen . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Statistics Screen Individual Execution Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Statistics Screen Group Entity Execution Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Fields of the Job Dependency Network Display Type N (Network) . . . . . . . . . . . . . 238
Parameter of the REFRESH Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Rule Definition Facility Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Fields of the Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Options of the Table List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Fields of the Rule List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Commands of the Rule List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Options of the Rule List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Tables 25
CMEM Rule Definition Event Selection Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
CMEM Rule Definition General Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
CMEM Rule Definition Action Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Commands of the Rule Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Commands for Exiting the Rule Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Options for Ordering Rule Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Fields in the Window for Copying Rules to Another Table . . . . . . . . . . . . . . . . . . . . 265
IOA Variable Database Facility Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Fields of the IOA Values of Database Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Options of the Values of Database Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Display Types of the Variable Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Options of the Variable Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Fields of the IOA Conditions/ Resources Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
IOA Conditions/ Resources Retrieval Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
IOA Conditions/ Resources ADD Command Formats . . . . . . . . . . . . . . . . . . . . . . . . 280
Options of the IOA Conditions/ Resources Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
IOA Conditions/ Resources DELETE Confirmation Window Options . . . . . . . . . . 282
COUNT Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Fields of the IOA Manual Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Retrieval Criterion for IOA Manual Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . 285
Options of the IOA Manual Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Fields of the IOA Manual Conditions Screen ERASE Confirmation Window . . . . 289
Fields of the IOA Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Commands of the IOA Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
IOA Log Screen Predefined Display Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Fields of the Display Filters Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Options of the Display Filters Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Fields of the IOA Log Show Screen Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
IOA Log Show Screen Window Selection Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
IOA Log Show Screen window - Closing Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
IOA Calendar Facility Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Fields of the IOA Calendar Facility Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Options of the Calendar List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Commands of the Year List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Options of the Year List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Fields of the Calendar List Screen Copy Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Fields of the Calendar Definition Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Commands for Exiting the Calendar Definition Screen . . . . . . . . . . . . . . . . . . . . . . . 318
Prerequisite Condition Utility Screen Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Parameters of the Job Request Utility Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
JCL Library Mode Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Scheduling Library Mode Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
AutoEdit Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Fields of the CONTROL-M Simulation and Forecasting and Tape Pull List Screen . .
331
Define Parameters and Conditions Screen Format . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Define Parameters and Conditions Screen Options . . . . . . . . . . . . . . . . . . . . . . . . . 342
Fields of the Update Parameters and Set Conditions Screen . . . . . . . . . . . . . . . . . . . 346
Fields of the Define Parameters in the Master Plan Screen . . . . . . . . . . . . . . . . . . . . 352
26 CONTROL-M for OS/390 and z/OS User Guide
Options of the Define Parameters in the Master Plan Screen . . . . . . . . . . . . . . . . . . . 355
Define Parameters in the Master Plan Screen - Exit Screen Commands . . . . . . . . . . 355
Fetch Plan Screen OVERRIDE DAILY PLAN Values . . . . . . . . . . . . . . . . . . . . . . . . . 356
Format of the Update Parameter Values Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Quick Schedule Definition Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Fields of the CONTROL-M Quick Schedule Definition Screen . . . . . . . . . . . . . . . . . 363
Prerequisite Condition Format Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Formats for Prerequisite Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Fields that Affect Prerequisite Conditions Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Fields in the Job List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Options of the Job List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
General Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Category A, B, C, and D Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Runtime Scheduling Parameter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Final Job Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Parameters Performed When the Job Ends OK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Conditional Processing Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Return and Cyclic Post-Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Group Entity Post-Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
ADJUST CONDITION Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Restart AUTO-ARCHIVE Subparameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Optional CONFCAL Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Optional CONFIRM Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Mandatory CONTROL Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Optional CTB STEP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
DAYS Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Non-Periodic Scheduling Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Periodic Scheduling Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
DEFINITION ACTIVE Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
DO Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Relationship of DO Statements with Other Statements . . . . . . . . . . . . . . . . . . . . . . . . 435
DO COND Mandatory Subparameter Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Prerequisite Condition Symbolic Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
DO CTBRULE Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
FORCEJOB Subparameter Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Restart DO IFRERUN Subparameter Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
DO MAIL Subparameter Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
DO SET Subparameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
DO SHOUT Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
DO SYSOUT Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Varying Effect of SYSOUT Handling Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
GRP MAXWAIT Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
IN Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Date Reference Values Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
INTERVAL Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
MAXWAIT Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
MEMLIB Parameter Values for Non-Started Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
MEMLIB Parameter Formats for Started Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
MONTHS Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Tables 27
ON Parameter Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
ON and DO Statements Relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
ON Parameter CODES Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
ON Parameter Code Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
ON GROUP-END Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
OUT Mandatory Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
OVERLIB Parameter: Algorithm for LIbraries Used when Option J (JCL) is Specified
565
Restart PREVENT-NCT2 Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
RELATIONSHIP Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
RELATIONSHIP Parameter Scheduling Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
RESOURCE Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
RETENTION: # OF DAYS TO KEEP Parameter Values . . . . . . . . . . . . . . . . . . . . . . . 594
Restart RETENTION: # OF GENERATIONS TO KEEP Values . . . . . . . . . . . . . . 596
RETRO Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
SAC Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
SCHEDULE TAG ACTIVE Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
SHOUT Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
STEP RANGE Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
SYSOUT Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
TASKTYPE Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
TASKTYPE Basic Type Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
WDAYS Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Non-Periodic Scheduling Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Periodic Scheduling Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Events handled by CMEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
CMEM AutoEdit Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
CMEM Event Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
CMEM General Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
CMEM Action Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
DO Parameter Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
DO COND Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
DO FORCEJOB Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
DO RULE Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
DO SHOUT Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
DO SHOUT OPER Subparameter Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
MODE Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
ON Parameter Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
DSNEVENT Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Valid STEPRC Code Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
ON JOBARRIV Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
JOBEND Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
ON STEP Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
ON STEP Subparameter STEPRC Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Valid RUNTSEC Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
AutoEdit Control Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Non-Date AutoEdit System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Date AutoEdit System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
4 Character Year Date AutoEdit System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
28 CONTROL-M for OS/390 and z/OS User Guide
Special AutoEdit System Variables Resolved after Job End . . . . . . . . . . . . . . . . . . . . 742
Special AutoEdit System Variable Resolved after Job Submission . . . . . . . . . . . . . . 743
IOA Global Variable Database Structure Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Chart for Determining Priorities of Value Assignment Sources . . . . . . . . . . . . . . . . 759
%%RESOLVE Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
AutoEdit Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Date Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Alternative Job Ordering Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Parameter Prompting Facility Type 2: Use of CLISTS . . . . . . . . . . . . . . . . . . . . . . . . . 825
The FETCH A PLAN Screen: Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
The EXEC / ORDER A PLAN Screen: Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Files Used as Input during Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Files Produced as Output of Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Parameters Passed to the Utility by DASIMPRM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Online Simulation Environment File Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Overrides To Be Specified on IOALDNRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Overrides To Be Specified on ADDMNCND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Override To Be Specified for Simulation Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
CTMTAPUL Subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
DD Statements Used by CTMTAPUL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Keystroke Language Important DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Return Codes for Procedure IOARKSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
KSL Screen Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
KSL Flow Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
KSL Print Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
KSL Processing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
KSL Special Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Step-by-Step Explanation of Script Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
KSL Screen Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
KSL Flow Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
KSL Print Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
KSL Processing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Special KSL Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Report Scripts in the IOA KSL Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Utility Scripts in the IOA KSL Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Order or Force Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Files Accessed during the Order or Force Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Create and/ or Order or Force New Tables Return Codes . . . . . . . . . . . . . . . . . . . . . 891
Files Accessed during the Create, Order or Force Process . . . . . . . . . . . . . . . . . . . . . 892
AJF Action Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Files Accessed during the AJF Action Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Search Action Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Files Accessed during the AJF Action Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Selection Criteria Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Selection Criteria Parameter Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Files Accessed during the AJF Action Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Contents of Registers on Input to CTMAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Fixed Part Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Status Extension Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
Tables 29
Statuses Returnable under the Status Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
Status Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Files Accessed during the AJF Action Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Order Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Order Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
AJF Action Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
AJF Action BAPIAACT Field Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
CTMAPI Action Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Global Variable Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Global Variable Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
CTMAPI Quantitative Resource Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
CTMAPI Quantitative Resource Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
CTMAPI Quantitative Resource File Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
BLT Action Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
CTMAPI Quantitative Resource File Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
CTMAPI Reply Mechanism Trigger Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Subjects of Line Editing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Line Editing Commands - Delete Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Line Editing Commands - Copy Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Line Editing Commands - Move Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Line Editing Commands - Repeat Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Line Editing Commands - Insert Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Line Editing Commands - Location Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Line Editing Commands - Delete Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Line Editing Commands - Copy Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Line Editing Commands - Move Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Line Editing Commands - Repeat Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Line Editing Commands - Insert Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Line Editing Commands - Location Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
AutoEdit System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
AutoEdit Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
30 CONTROL-M for OS/390 and z/OS User Guide
About This Guide 31
About This Guide
CONTROL-M is a component member of the INCONTROL by BMC Software
family of products. The CONTROL-M for OS/390 and z/OS User Guide is the main
publication that describes the components and usage of CONTROL-M software.
This guide is designed for use by everyone who defines job schedules or who uses
CONTROL-M to actively control jobs in the production environment.
This guide provides detailed information on all CONTROL-M functions and
facilities. It contains the following chapters:
Chapter 1Introduction
CONTROL-M introduction and overview. This chapter briefly describes the main
components of CONTROL-M from a functional perspective, and introduces the user
to CONTROL-M facilities and features, concepts and logic. INCONTROL and IOA
components and concepts are also described.
It is highly recommended that all users read this chapter before reading other
chapters in the guide.
Chapter 2Online Facilities
Guide to using CONTROL-M and IOA online facilities. CONTROL-M and IOA
screens are illustrated and discussed in logical sequence.
Chapter 3Job Production Parameters
Detailed description, accompanied by examples, of the parameters and statements in
the CONTROL-M Job Scheduling Definition screen.
Chapter 4CONTROL-M Event Manager (CMEM)
Overview of CONTROL-M Event Manager logic and a detailed description of the
parameters and statements in CMEM rule definitions. This facility enables
CONTROL-M to respond to external events (that is, events in the MVS environment
that occur outside of CONTROL-M's direct control).
32 CONTROL-M for OS/390 and z/OS User Guide
Chapter 5JCL and AutoEdit Facility
Guide to the CONTROL-M AutoEdit facility, and its application to JCL. Usage of
AutoEdit terms in the JCL can eliminate the need for manual changes to the JCL prior
to job submission.
Chapter 6Selected Implementation Issues
Provides concepts, hints, and procedures for successful implementation and
maintenance of CONTROL-M.
Chapter 7Simulation and Forecasting Facility
Guide to simulating the effects of operations and procedures in your production
environment and forecasting the potential impact of proposed changes.
Chapter 8KSL Facility
Description of the KeyStroke Language (KSL), which emulates the Online facility in
batch. The use of KSL scripts for utilities and report generation is discussed.
Appendix AEditing Job Scheduling Definitions in the Edit Environment
Usage of the IOA Edit environment for editing job scheduling definitions.
Appendix BEditing CMEM Rule Definitions in the Edit Environment
Usage of the IOA Edit environment for editing CMEM rule definitions.
Appendix CAutoEdit Facility in KSL
Description of the AutoEdit facility usage in KSL scripts.
Appendix DMVS Job Restart Without CONTROL-M/Restart
Instructions for using CONTROL-M to perform an MVS restart (for sites that do not
have CONTROL-M/ Restart installed).
Index
About This Guide 33
Conventions Used in This Guide
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).
$ is mapped to x'5B'
# is mapped to x'7B'
@is mapped to x'7C'
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
s only the name of the command, such as, enter the END command
s only the PF keys, such as, press PF03/PF15
s or both, such as, press PF03/PF15, or enter the END command
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.
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
34 CONTROL-M for OS/390 and z/OS User Guide
Conventions Used in This Guide
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:
s 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
s An ellipsis ( . . . ) indicates that you can repeat the preceding item or items as many
times as necessary.
s 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. Square 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.
s 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.
About This Guide 35
Conventions Used in This Guide
Screen Characters
Al l synt ax, oper at i ng syst em t er ms, and l i t er al exampl es ar e
pr esent ed i n t hi s t ypef ace. This includes JCL calls, code examples, control
statements, and system messages. Examples of this are:
s calls, such as
s code examples, such as
s control statements, such as
s system messages, both stand-alone, such as You ar e not l ogged on t o
dat abase dat abase_name, and those embedded in text, such as the message
You ar e not l ogged on t o dat abase dat abase_name, are displayed on
the screen.
Variables
Variables are identified with italic text. Examples of this are:
s In syntax or message text, such as
Speci f y dat abase database_name
s In regular text, such as
replace database database_name1 with database database_name2 for the current
session
s In a version number, such as
EXTENDED BUFFER MANAGER for IMS 4.1.xx
Special elements
This book includes special elements called notes and warnings:
CALL CBLTDLI
FOR TABLE owner . name USE opt i on, . . . ;
/ / PRDSYSI N DD * USERLOAD PRD( 2) PRI NT
NOTE
Notes provide additional information about the current subject.
36 CONTROL-M for OS/390 and z/OS User Guide
Information New to This Version
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.
Information Relating to CONTROL-M/Restart
Users
Certain information presented in the CONTROL-M for OS/ 390 and z/ OS User Guide
is relevant only to CONTROL-M users who have CONTROL-M/ Restart installed at
their site.
CONTROL-M/ Restart information is identified in this guide by the Restart symbol,
which is shown at the beginning of the CONTROL-M/ Restart information. This
symbol is shown using the following guidelines:
s If an entire topic level is dedicated to CONTROL-M/ Restart material, the heading
of that topic begins with the Restart symbol. Similarly, if there are lower level
topics within that level that are also dedicated to CONTROL-M/ Restart material,
the headings of those lower level topics will also begin with the Restart symbol.
This provision also applies to CONTROL-M/ Restart paragraphs, each of which
will begin with the Restart symbol, or, on occasion, to single sentences, or even
phrases or words, if they exclusively pertain to CONTROL-M/ Restart material.
WARNING
Warnings alert you to situations that can cause problems, such as loss of data, if you
do not follow instructions carefully.
NOTE
CONTROL-M/ Restart was called CONTROL-R in earlier versions.
About This Guide 37
Information Relating to CONTROL-M/Restart Users
s The same Restart symbol is placed at the conclusion of each unbroken block of
text material that contains CONTROL-M/ Restart material, regardless of whether
the material spans more than one heading level, paragraph, or sentence. For
example, if a first level CONTROL-M/ Restart topic includes second and/ or third
and/ or fourth and/ or fifth level topic headings, with no intervening material that
is not related to CONTROL-M/ Restart, the Restart symbol will be placed at the
end of the text in the lowest level sentence of unbroken CONTROL-M/ Restart
material.
s If a figure or table is used exclusively to identify or explain CONTROL-M/ Restart
material, the following statement will appear immediately preceding the figure
title or the table title:
Restart The following (figure)(table) is for users who have CONTROL-M/ Restart
installed at their site.
s If CONTROL-M/ Restart material is included only in part of a figure or table
otherwise used to illustrate standard CONTROL-M material, the Restart symbol
will be used within the figure or table to identify the information relevant only to
CONTROL-M/ Restart users.
If CONTROL-M/ Restart is not installed at your site, you can skip any material in this
guide that is identified with the Restart symbol.
38 CONTROL-M for OS/390 and z/OS User Guide
Related Publications
Related Publications
CONTROL-M for OS/390 and z/OS Getting Started Guide
Explanation of CONTROL-M facilities. Online, step-by-step instructions are
provided.
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
<Times9>TM
Installation and Customization Engine (ICE) application.
INCONTROL for OS/390 and z/OS Messages Manual
A comprehensive listing and explanation of all IOA and INCONTROL messages and
codes.
INCONTROL for OS/390 and z/OS Security Guide
A step-by-step guide to implementing security in INCONTROL products using the
ICE application.
INCONTROL for OS/390 and z/OS Utilities Guide
Describes utilities designed to perform specific administrative tasks that are available
to INCONTROL products.
Chapter 1 Introduction to CONTROL-M 39
Chapt er
1
1 Introduction to CONTROL-M
This chapter includes the following topics:
INCONTROL Products and IOA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
IOA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
INCONTROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Functional Approach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Main Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Expanded CONTROL-M Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CONTROL-M Support for MAINVIEW Batch Optimizer . . . . . . . . . . . . . . . . . . . 55
Online User Interface to CONTROL-M . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
CONTROL-M Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
IOA Core and CONTROL-M Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Date Definition Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Date Standards and Date Field Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Job Ordering and Job Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Rerun and Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Order ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
SYSDATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Handling of Job Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Prerequisite Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Quantitative and Control Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Job Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Automatic Job Flow Adjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
INCONTROL Products and IOA
40 CONTROL-M for OS/390 and z/OS User Guide
INCONTROL Products and IOA
The CONTROL-M Automated Production Control and Scheduling System is a
component member of the INCONTROL family of products, a fully integrated suite
designed to automate, manage and streamline operations on the OS/ 390 or z/ OS
mainframes. The INCONTROL family also includes client and server products that
facilitate the automation of other platforms.
IOA
The Integrated Operations Architecture (IOA) is at the heart of the INCONTROL
family of products. IOA has a common core of shared code as the foundation of its
architecture design. INCONTROL's IOA environment has several inherent design
advantages, including a common user interface and a shared data repository. A key
feature of the IOA environment is its integrated application design, which includes:
s Integrated User Notification
s Management by Exception
s Integrated Scheduling
s Interdependency and Interrelationship Handling
s Common Help Facility
s Integrated Management Reporting
s Common Method for Sharing Information
s Unified Installation and Maintenance
s Unified Security Implementation
s Open Interface Design
INCONTROL Products and IOA
Chapter 1 Introduction to CONTROL-M 41
INCONTROL
The INCONTROL family of products includes:
Table 1 List of INCONTROL Products (Part 1 of 2)
Product Description
CONTROL-M Automated Production Control and Scheduling System
Manages and automates the setup, scheduling and
execution of jobs in the data center.
CONTROL-M/Restart Restart Management System
Automates the activities that must be performed when
restarting failed jobs, including the scratching and
uncataloging of data sets created by failed jobs.
CONTROL-M/Tape Removable Media Management System
Increases utilization of removable media and controls
retention periods. Prevents misuse of media, and
provides tape library and vault control.
CONTROL-M/Analyzer Automated Information Integrity System
Performs in-stream validation, accuracy, and
reasonability checks on information used by data center
production tasks (for example, reports, databases).
CONTROL-D Output Management System Automatically schedules
and controls every aspect of report processing and
distribution, including report decollating, bundling,
printing, online viewing, and archiving.
CONTROL-V Quick Access Archive Viewing System
Provides online access to archived reports and
documents by indexed data retrieval.
CONTROL-D/
Page On Demand
Report Retrieval and Display System
Enables end users to retrieve and view pages of reports
that reside on mainframe storage in real time. Indexed
reports can be retrieved by index name and value. AFP
and XEROX reports can also be retrieved and displayed
using CONTROL-D/ WebAccess Server or
CONTROL-D/ Page On Demand API.
INCONTROL Products and IOA
42 CONTROL-M for OS/390 and z/OS User Guide
CONTROL-D/ Image Image Output Management System
Enables output from commercial imaging equipment to
be imported into either CONTROL-D or CONTROL-V
for decollation, distribution and viewing, and into
CONTROL-V for archiving and indexed retrieval.
CONTROL-O Console Automation System and Desired State
Monitoring System
Monitors and automatically responds to messages,
commands, and data set events, as well as various other
system events.
The CONTROL-O/ COSMOS feature allows for status
monitoring while maintaining all critical system objects
in a desired and ideal status.
Table 1 List of INCONTROL Products (Part 2 of 2)
Product Description
Functional Approach
Chapter 1 Introduction to CONTROL-M 43
Functional Approach
CONTROL-M automates job processing in your data center.
s It performs virtually all the job handling tasks of computer operators.
s It provides an interface that enables the user to intervene in the process of
production management.
s It provides continual data and status information regarding job processing.
CONTROL-M contains many facilities and components. Working together, they
automate the data center. This chapter introduces the CONTROL-M facilities and
components from a functional perspective, beginning with the major components
that comprise the heart of CONTROL-M and progressing to the more minor
components that enhance the functionality of CONTROL-M.
Main Components
The following components are essential to CONTROL-M:
s Job scheduling definitions
s Active Jobs file
s CONTROL-M monitor
Job Scheduling Definitions
A job scheduling definition specifies criteria that identify decisions to be made, and
actions to be taken, regarding the handling of a particular job. Each job scheduling
definition contains the following sections:
Table 2 Job Scheduling Definition Sections (Part 1 of 2)
Section Description
General Parameters General information about the job (for example,
identifies the library and member in which the JCL is
stored).
Basic Scheduling
Parameters
Criteria according to which CONTROL-M schedules the
job.
Functional Approach
44 CONTROL-M for OS/390 and z/OS User Guide
Job scheduling definitions only need be defined once for each job in the production
environment. The mechanism used to define job scheduling definitions is discussed
in Chapter 2, Online Facilities. Once defined, a job scheduling definition is saved. It
can be modified later if required, and the changes saved.
Job scheduling definitions are stored in members in partitioned data sets (libraries),
as follows:
s Job scheduling definitions for related applications are generally placed in a single
member, called a scheduling table.
s Multiple scheduling tables are stored in partitioned data sets, called scheduling
libraries.
s Multiple scheduling libraries can be defined.
Active Jobs File
As mentioned above, each job scheduling definition contains criteria that determine
whether the job must be scheduled on a given day. If based on these criteria a job
must be scheduled, a copy of its job scheduling definition is placed in a file called the
Active Jobs file. The mechanism by which job scheduling definitions are placed in the
Active Jobs file is discussed in Job Ordering and Job Forcing on page 66.
Only jobs in the Active Jobs file are candidates for submission by the CONTROL-M
monitor.
Runtime Scheduling
Parameters
Runtime requirements that must be satisfied before
CONTROL-M submits the job.
Post-processing
Parameters
Actions CONTROL-M performs after the job ends,
depending upon the outcome of job execution. For
example, CONTROL-M performs one set of actions if the
job ends OK, but another set of actions if an abend
occurs.
Table 2 Job Scheduling Definition Sections (Part 2 of 2)
Section Description
Functional Approach
Chapter 1 Introduction to CONTROL-M 45
CONTROL-M Monitor
The CONTROL-M monitor handles and controls job processing:
s It checks the runtime requirements specified in each job scheduling definition in
the Active Jobs file, monitors available resources and conditions in the
environment, and if it determines that the conditions and resources required by a
job are available, it allocates the resources and submits the job.
s It monitors the execution of the job.
s It implements post-processing decisions based on instructions in the job
scheduling definition and the results of the job execution.
The CONTROL-M monitor operates continually. It evaluates the production
environment and implements decisions.
Expanded CONTROL-M Functionality
This section describes facilities, features and capabilities of CONTROL-M which
supplement the main components of the program.
Automating Job Scheduling: New Day Processing
One of the main purposes of CONTROL-M is to automate job scheduling.
We have already explained that basic scheduling criteria for each job are defined in its
job scheduling definition, and that a copy of the job scheduling definition is placed in
the Active Jobs file when the basic scheduling criteria are satisfied.
The mechanism used to place job scheduling definitions automatically in the Active
Jobs file is called New Day processing.
At a set time each day (defined during installation as the start of day at the site),
CONTROL-M performs New Day processing, during which:
s CONTROL-M performs a number of maintenance and cleanup functions that the
operator would otherwise have to perform manually.
s Job scheduling definitions are selected from the scheduling tables (based on their
basic scheduling criteria) and are placed in the Active Jobs file. These jobs can then
be submitted and tracked by the CONTROL-M monitor.
Functional Approach
46 CONTROL-M for OS/390 and z/OS User Guide
The implementation of automated job scheduling and New Day processing, and the
components of New Day processing, are discussed in detail in the INCONTROL for
OS/390 and z/OS Administrator Guide.
Automatic JCL Update: JCL and AutoEdit Facility
In the production environment, JCL must often be manually modified prior to
submission of a job, as in the following cases:
s changing a parameter or a date card
s supplying tape numbers in JCL procedures
s eliminating steps under different run conditions, for example, when end of month
processing differs from normal daily run
Manual modification of the JCL is inconvenient at best, and it can be error-prone and
lead to serious problems. The JCL and AutoEdit facility offers an automated
alternative to manual JCL update.
The JCL and AutoEdit facility permits AutoEdit terms, such as AutoEdit variables,
functions, and control statements, to be specified in the JCL in place of values that
change from job submission to job submission. AutoEdit terms are prefixed by %%,
which distinguishes them from non-AutoEdit terms. For example, the term
%%ODAY is recognized as an AutoEdit term.
The values of user-defined variables that have been defined as Sysplex-wide, using
the XAE facility, remain both in memory and in a Coupling facility. These values can
be used for additional triggering of the same job or other CONTROL-M jobs, in the
same computer or in different computers of the same Sysplex.
At time of job submission, AutoEdit terms in the JCL are resolved to their actual
values.
The inclusion of AutoEdit terms into the job stream and job scheduling definitions
can eliminate the need to change JCL once it is defined. AutoEdit usage can be further
simplified and enhanced through the Parameter Prompting facility, which is
described in M4: Parameter Prompting Facilities on page 335 and Parameter
Prompting Facilities on page 816.
As of version 6.1.00, CONTROL-M/ eTrigger can be used as an alternative to the
Parameter Prompting Facility. AutoEdit parameter values can be passed together
with the job scheduling definition when using the CONTROL-M/ Enterprise
Manager to order an unscheduled job. If this is done, these AutoEdit parameter
values are substituted for those already in the job scheduling definition prior to
submission.
For more information on CONTROL-M/ eTrigger, see the CONTROL-M/eTrigger
Administrator Guide.
Functional Approach
Chapter 1 Introduction to CONTROL-M 47
The JCL and the AutoEdit facility is described in detail in Chapter 5, JCL and
AutoEdit Facility.
Automated Job Submission
Once a job has been placed in the Active Jobs file, the CONTROL-M monitor does not
submit the job unless all its runtime scheduling criteria, as defined in the job
scheduling definition, are satisfied. Several types of runtime criteria can be defined.
Examples
Monitoring of Resources
Three types of runtime criteria require CONTROL-M to monitor the existence of
conditions and the availability of resources system-wide. These conditions and
resources are mentioned briefly below and are discussed in greater detail in
CONTROL-M Concepts on page 61:
The condition and resource requirements of a job are defined in the job scheduling
definition.
Table 3 Runtime Criteria
Criteria Description
Time Submission must occur during a defined time range.
Priority Jobs can be assigned internal priorities, so that if two jobs are
ready for submission at the same time, the higher-priority job is
submitted first.
Due Out If two jobs with the same priority are ready for submission, the job
with the earlier due out time is submitted first.
Table 4 Conditions and Resources
Condition or Resource Description
Quantitative resources Quantity of a resource required by the job. For example,
a job may require two tape drives.
Control resources Mode (exclusive or shared) in which a resource is
required. For example, a backup job may require
exclusive access to a specified data set.
Prerequisite conditions User-defined conditions that must exist before a job is
submitted. A major use of prerequisite conditions is to
establish job dependencies.
Functional Approach
48 CONTROL-M for OS/390 and z/OS User Guide
Prerequisite conditions are tracked by the IOA Conditions file. Existing and available
Quantitative resources and Control resources are tracked by the CONTROL-M
Resources file. Prior to version 6.0.00, conditions and resources were stored in a single
file, the Conditions/ Resources file.
When the prerequisite conditions and resources required by a job are available, the
job can be submitted by the monitor, if all other runtime scheduling criteria are
satisfied.
Immediate Detection and Notification of Problems: Shout
Facility
When a problem or an unexpected situation or delay occurs, CONTROL-M can notify
the appropriate personnel. These situations and problems are detected by analysis of
a job sysout.
Notification is issued by the Shout facility, which can send messages to a variety of
destinations including the operator console, a TSO user, and the IOA Log file.
CONTROL-M can also be instructed to issue a SHOUT message in the event an
exception occurs at time of job submission and/ or during job execution, such as when
a job completes before, or later than, its anticipated completion time.
Restart History Jobs File
During New Day processing, jobs that have ended OK or whose retention period has
expired according to job scheduling definition parameters are deleted from the Active
Jobs file.
If CONTROL-M/ Restart is installed, these jobs can be placed in the History Jobs file
during New Day processing. This is an optional feature that can be activated by the
INCONTROL administrator. Activation of this feature is described under the HIST
parameter in the INCONTROL for OS/390 and z/OS Administrator Guide.
Jobs in the History Jobs file can by request be restored to the Active Jobs file, for
subsequent restart.
Jobs remain in the History Jobs file until they are deleted according to criteria defined
in the job scheduling definition.
The contents of the History Jobs file can be viewed from the History Environment
screen, which is described in Chapter 2, Online Facilities.
Functional Approach
Chapter 1 Introduction to CONTROL-M 49
Journaling and Restoration Capability
The CONTROL-M Journal file collects data about changes occurring in the
CONTROL-M Active Jobs file, the IOA Conditions file and the CONTROL-M
Resources file during the CONTROL-M working day. This permits forward recovery
of the CONTROL-M environment to any time of the day you may choose.
The Journal file is initialized each day during New Day processing. From that point
on, for the rest of the working day, the CONTROL-M monitor records in the Journal
file all job processing activities that impact the CONTROL-M Active Jobs file, and all
prerequisite condition additions to and deletions from the IOA Conditions file and
the CONTROL-M Resources file.
If the CONTROL-M Active Jobs file, and optionally the IOA Conditions file and the
CONTROL-M Resources file, need to be restored, for example, following a system
crash, the CTMRSTR utility can be run to restore the files. The utility uses data from
the Journal file to restore the files to the status they had at any specific time after the
last run of the New Day procedure.
The CONTROL-M Journal file is initialized each day during New Day processing.
Therefore, the time at which the New Day procedure initialized the Journal file is the
earliest time to which the CONTROL-M Active Jobs file, the CONTROL-M Resources
file, or the IOA Conditions file can be restored.
Journaling and Restoration is an optional feature that can be activated by the
INCONTROL administrator. It is described in the INCONTROL for OS/390 and z/OS
Administrator Guide. Activation of this feature is described under the JRNL parameter
in the INCONTROL for OS/390 and z/OS Installation Guide.
IOA Log Facility
Messages issued by CONTROL-M are written to the IOA Log file. The IOA Log file is
a repository for messages issued by all INCONTROL products. Through the IOA Log
facility, the user can examine messages issued by CONTROL-M during the
processing of a job.
Automated Job Post-Processing
Once the job has executed, the CONTROL-M monitor implements the
post-processing instructions defined in the job scheduling definition. Post-processing
instructions can be defined for virtually any situation, such as job ended successfully,
job abended, a particular condition code occurred in a particular step, and so on.
Functional Approach
50 CONTROL-M for OS/390 and z/OS User Guide
As part of post-processing, CONTROL-M can do the following:
s add a prerequisite condition to, or delete a prerequisite condition from, the IOA
Conditions file
This can trigger or prevent the submission of a job in the Active Jobs file.
s force the placement of a job scheduling definition into the Active Jobs file,
regardless of the basic scheduling criteria of the job
s set AutoEdit variables
s send (shout) a specified message to a specified location through the SHOUT
facility or by electronic mail
s send a message by mail to the recipient identified by the mail name prefix
s change the final status of a job to OK or NOTOK
s handle the job SYSOUT
This includes changing its class, deleting it, rerouting it to another node, releasing
it for printing, or copying it to another location.
s if CONTROL-M/ Analyzer is active, invoke a CONTROL-M/ Analyzer rule
s rerun a job
s perform an MVS job restart; for more information, see OUT: PostProcessing
Parameter on page 554
s Restart if CONTROL-M/ Restart is active, perform a CONTROL-M/ Restart job
restart
s Restart if CONTROL-M/ Restart is active, automatically archive certain portions
of the job output
s stop recycling of cyclic jobs
Utilities
Utilities provided with CONTROL-M are used to perform a variety of management
functions and generate reports that assist in the efficient use of CONTROL-M. Batch
utilities are described in the INCONTROL for OS/390 and z/OS Utilities Guide. Online
utilities are described in Chapter 2, Online Facilities.
Functional Approach
Chapter 1 Introduction to CONTROL-M 51
Handling Jobs in the NJE Network
The CONTROL-M monitor handles the control of complex distributed production
environments where jobs may be routed for execution to different nodes of the NJE
network according to the business needs of the enterprise.
CONTROL-M differentiates between host and remote nodes in the NJE network as
follows:
An NJE job is a job submitted by the CONTROL-M monitor for execution on a remote
node. CONTROL-M can detect the status of jobs running on a remote node so that
once these jobs finish executing, CONTROL-M can assign a status to them.
Handling External Events: CMEM Facility
External events are events in the system that occur outside the control of the
CONTROL-M monitor, such as the submission of a job. The CONTROL-M Event
Manager (CMEM) facility enables CONTROL-M to respond to and handle such
events.
Through rules defined online through the CMEM Rule Definition facility, which is
described in Chapter 2, Online Facilities, the user specifies actions CONTROL-M
must perform in response to external events.
The following types of events are handled by the CMEM facility:
Table 5 NJE Network Nodes
Node Description
Host node NJE network node under which the CONTROL-M monitor is
active and the NJE job is submitted to MVS/ JES by the monitor.
Remote node NJE network node to which a job was sent from the host node.
Table 6 Event Types Handled by CMEM
Event Description
Job Arrival Arrival of a job on the JES spool, from any source.
Job End Completion of a job, regardless of its source.
Dataset Event Either the setting of a data set disposition at deallocation time or
the occurrence of a NOT CATLGD 2 event.
Step Termination of a procedure (and optionally, a program) step.
Functional Approach
52 CONTROL-M for OS/390 and z/OS User Guide
The following actions can be performed by the CMEM facility:
s force one or more CONTROL-M jobs
For more information, see Job Ordering and Job Forcing on page 66.
s add prerequisite conditions to, or delete prerequisite conditions from, the IOA
Conditions file and the CONTROL-M Resources file
s stop the job in which the event occurs
s invoke a CONTROL-O rule, if CONTROL-O is active at the site
s send a message to a specified location using the CONTROL-O SHOUT facility, if
CONTROL-O is active at the site
s bring under the control of the CONTROL-M monitor a job submitted outside the
control of the CONTROL-M monitor, such as a job submitted by a TSO user
Such a job is called an On Spool job, and the control of On Spool jobs is one of the
most important functions of CMEM.
The CMEM facility, and On Spool jobs, are described in Chapter 4, CONTROL-M
Event Manager (CMEM).
Using Calendars to Schedule Jobs: IOA Calendar Facility
Specification of scheduling criteria for jobs can be simplified by using calendars. A
calendar is a defined schedule that can be applied to jobs, such as Mondays through
Fridays in each week in each month.
Calendars are defined in the Calendar facility. Each calendar is assigned a unique
name that can be specified in job scheduling definitions. A particular calendar (that is,
schedule) need only be defined once.
Specifying the name of a calendar in job scheduling definitions causes that calendar
to be used to schedule those jobs.
Two types of calendars can be defined:
s regular
s periodic
Regular Calendars
Regular calendars consist of scheduling dates or days of the week that can be defined
according to monthly patterns.
Functional Approach
Chapter 1 Introduction to CONTROL-M 53
For example
s WEEKDAYS schedules jobs each Monday through Friday in each month.
s WEEKENDS schedules jobs on every Saturday and Sunday in each month.
s QUARTERLY schedules jobs on the last date in each quarter: March 31, June 30,
September 30, December 31.
Regular calendars are especially useful when many jobs have the same schedule.
Defining the schedule once in a calendar, and entering the calendar name in the job
scheduling definition of the jobs with that schedule, makes it unnecessary to
individually define that schedule in each job scheduling definition.
Periodic Calendars
Periodic calendars are especially useful when scheduling dates do not easily conform
to fixed date or day of the week or month patterns.
For example
s PAYCAL Calendar used for jobs that are scheduled every other Wednesday
(such as payroll jobs). Scheduling occurs on the first, third, and (if there is one) fifth
Wednesday of some months. Scheduling may occur on the second and fourth
Wednesday of other months.
The IOA Calendar facility is described in Chapter 2, Online Facilities.
Accumulating Statistics: Statistics Facility
As part of the post-processing for each job, CONTROL-M determines the elapsed run
time of the job. All accumulated information regarding job execution, including the
elapsed run time, is written to the IOA Log file.
Periodically, a statistics utility may be used to scan and analyze the IOA Log file. This
utility gathers information about the start time of each job, its elapsed run time, CPU
utilization time, and so on. The utility places this information in the Statistics file,
where averages of these values can be maintained for each job.
Statistics facility averages may be used for several purposes:
s to determine if the execution time of a job falls outside of a statistically normal
range of time, which would indicate an execution delay or problem)
s to calculate DUE-IN time for use by the Deadline Scheduling facility, which is
discussed under Automatic Job Flow Adjustment on page 74
Functional Approach
54 CONTROL-M for OS/390 and z/OS User Guide
s to determine when a shout message must be issued based on the elapsed time of
the job
s to simulate job executions and forecast the impact of changes to the system
(described briefly below)
s to determine if a job can complete execution before the CONTROL-M planned
shutdown time (QUIESCE command)
Simulating Job Execution and Forecasting Resource Usage:
Simulation and Forecasting Facility
Using statistics accumulated by the Statistics facility, the Simulation and Forecasting
facility simulates the actions of the CONTROL-M monitor under the conditions
specified in simulation parameters.
The Simulation and Forecasting facility enables you to forecast anticipated job load
for a specified time in the future, and to forecast the effects of possible changes to the
system, such as the impact of:
s removing four tape drives
s increasing CPU power by 30%
s changing the time at which certain jobs are executed
The Simulation and Forecasting facility can improve the efficiency of your site. It can
help with resource and configuration decisions, and it can help with the planning of
workload scheduling to achieve maximum utilization of resources.
Automatic Tape Adjustment
The Automatic Tape Adjustment facility collects and analyzes statistics regarding
tape drive usage, and automatically allocates the appropriate number of tape drives
at job order time. This facility, which can be implemented by your INCONTROL
administrator, overrides any tape drive Quantitative resource value specified in the
job scheduling definition. For more information, see Statistics Screen on page 233
and RESOURCE: Runtime Scheduling Parameter on page 588.
Reporting Facility
CONTROL-M supports a comprehensive reporting facility, which can produce the
following types of reports:
Functional Approach
Chapter 1 Introduction to CONTROL-M 55
Sample reports are provided in the IOA SAMPLE library. The Reporting facility is
described in Chapter 8, KeyStroke Language (KSL).
Minus-One Support
Minus-One support is provided as part of CONTROL-M and enhances Parallel
Sysplex support (CTMPLEX). With Minus-One support, CONTROL-M users that
implement several CONTROL-M monitors in a Sysplex environment can run several
installations of CONTROL-M with different maintenance releases or different
versions, in parallel. This enables CONTROL-M users to implement installation and
upgrade procedures without having to shut down their entire complex.
Minus-One support is available even at sites that are not operating in a Sysplex
environment.
CONTROL-M Support for MAINVIEW Batch Optimizer
CONTROL-M provides scheduling support for jobs that use pipes at sites that have
MAINVIEW Batch Optimizer (MVBO)/ Job Optimizer Pipes installed. A pipe is a
processor storage buffer that enables data to be passed between applications without
using DASD or tape.
Table 7 KSL Report Types
Reports Description
Keystroke
Language Reports
These are reports generated with the Keystroke Language
(KSL). KSL is a general purpose reporting language, based on
the Online facility, capable of producing numerous reports
from the database, and is described in Chapter 8, KeyStroke
Language (KSL).
Special Purpose
Reports
These reports include the Job Flow reports that are generally
used to track the dependencies between jobs, and the Job Plan
reports that are used to anticipate which jobs are scheduled
each day.
WARNING
When upgrading a specific CONTROL-M instance to a new release, you must not
utilize features of the new release until all other components (members of the
Sysplex, application servers, and so on) are similarly migrated. Doing so may lead to
unpredictable results on CONTROL-Ms which have not been migrated.
Functional Approach
56 CONTROL-M for OS/390 and z/OS User Guide
MVBO/ Job Optimizer Pipes uses pipes to replace sequential job processing with
parallel processing wherever feasible. Jobs and job steps normally run sequentially
because they depend on data files that become available only after the application
that creates them completes execution. When pipes are used, an application does not
need to finish running before the data it generates is available to other applications.
This significantly reduces I/ O operations and delays, and speeds up processing,
because pipes enable movement of data using processor storage instead of writing
and reading data to and from external storage.
CONTROL-M scheduling support for MVBO/ Job Optimizer Pipes consist of the
following components:
s job scheduling definition support
s enhanced runtime scheduling algorithm
These are described in the following paragraphs.
Job Scheduling Definition Support
A PIPE statement can be specified in the CONTROL-M job scheduling definition for
each pipe accessed by the job. Each PIPE statement contains the pipe (data set) name.
The job scheduling definition of a participant includes a PIPE statement for each pipe
accessed by the job.
Enhanced Runtime Scheduling Algorithm
Jobs sharing a pipe are called pipe participants. CONTROL-M recognizes each set
of interrelated pipes and participants as a single, comprehensive unit called a
Collection. All pipe participants are submitted concurrently, after verification that all
required resources, such as prerequisite conditions or Quantitative resources, are
available. This method ensures that participants do not wait for other participants to
start executing, for example, at synchronization points.
For more information, see MAINVIEW Batch Optimizer Considerations on
page 813
Online User Interface to CONTROL-M
Until now, we have seen how CONTROL-M automates the production environment
and we have discussed a number of available facilities that enhance the functionality
of CONTROL-M.
Functional Approach
Chapter 1 Introduction to CONTROL-M 57
However, as mentioned earlier, CONTROL-M provides an online user interface that
enables the user to:
s interface with most of the previously described facilities
s intervene in the process of production management
s immediately access up-to-date information from the production environment
The online user interface is provided through online facilities that are accessed
through the IOA Primary Option menu.
Certain online facilities are unique to CONTROL-M, and other facilities are shared by
many or all products.
All IOA and CONTROL-M online facilities are discussed in detail in Chapter 2,
Online Facilities. They are all outlined briefly on the following pages.
Scheduling Definition Facility
The CONTROL-M Scheduling Definition facility is accessed through option 2 of the
Primary Option menu. It is the main online facility for creating, defining, modifying,
and deleting
s scheduling tables
s job scheduling definitions
In addition, this facility can be used to
s edit the JCL of a job
s produce a job (scheduling) plan
s display job statistics
s copy a job definition
s graphically display a job flow of the jobs in a table
s manually order or force jobs
NOTE
Your INCONTROL administrator can limit the options displayed on a user-by-user
basis and can modify option numbers and customize option descriptions. Default
options are discussed in this overview.
NOTE
Ordering places the requested job in the Active Jobs file only if its basic scheduling
criteria are met. Forcing places the requested job in the Active Jobs file regardless
of its basic scheduling criteria.
Functional Approach
58 CONTROL-M for OS/390 and z/OS User Guide
Active Environment (Status) Screen: Online Tracking and
Control Facility
The Online Tracking and Control facility is accessed through option 3 of the IOA
Primary Option menu. It is the main user interface to the monitoring of the jobs
scheduled for the day. This facility consists of a number of screens, each providing
the user with relevant information and options.
The main screen of this facility is the Active Environment screen. (Prior to version
6.0.00, this screen, which displays the status of each job order in the Active Jobs file,
was referred to as the Status screen.) All screens and windows available in the Online
Tracking and Control facility are accessed through the Active Environment screen. In
the Online Tracking and Control facility, you can perform the following functions:
s view the status of each job order in the Active Jobs file
s place a job in HELD status or free a HELD job
s delete a job order
s obtain a statistical overview of the status of jobs in the Active Environment screen
s see why a job in the Active Jobs file has not been submitted. If job submission is
held up due to missing prerequisite conditions, you can optionally add those
conditions manually
s display the Log file of a job to view all messages issued for the job
s zoom in on the parameters of a job order
This includes not only the job scheduling definition parameters, but also
parameters determined by the CONTROL-M monitor at runtime. Manual update
of some of these parameters for the job order is permitted.
s view the documentation of a job
s add notes to a job, for example, to document actions that were taken
s confirm the scheduling, rerun, or restart (if CONTROL-M/ Restart is active), of a
job that has been defined as requiring manual confirmation
s Restart view the execution history of all orders of a job, and view the job order
sysouts
s view the accumulated statistics of successful executions of a job
Functional Approach
Chapter 1 Introduction to CONTROL-M 59
s view the list of job dependencies for a specific job, that is, the predecessor and
successor jobs of the selected job, and perform manual job flow adjustment, such as
priority adjustment
You can filter which jobs in the Active Jobs file are displayed in the Active
Environment screen.
CMEM Rule Definition Facility
The CMEM Rule Definition facility is accessed through option C of the INCONTROL
Primary Option menu. CMEM rules enable CONTROL-M to respond to external
events. The CMEM Rule Definition facility is an online facility that enables the user to
create, define, modify and delete
s CMEM rule tables
s CMEM rules
The user can load rule tables to memory from the CMEM Rule Definition facility.
Rule tables can also be loaded to memory by an operator command.
IOA Conditions/Resources Screen
The IOA Conditions/ Resources screen is accessed through option 4 of the IOA
Primary Option menu. It displays information from the IOA Conditions file, which
contains the list of all existing prerequisite conditions, and the CONTROL-M
Resources file, which contains the list of Quantitative resources and Control
resources. The IOA Conditions/ Resources screen enables the user to
s view IOA prerequisite conditions
s view CONTROL-M Quantitative resources
s add or delete prerequisite conditions and/ or resources
s change the available quantity of Quantitative resources
IOA Log Screen
The IOA Log screen, accessed through option 5 of the IOA Primary Option menu,
displays the IOA Log file. The IOA Log file contains messages that record every
significant event in the life of all jobs or started tasks, rules, missions, and other
functions that are under the control of IOA products. This includes messages
generated for normal processing, such as job submitted, error conditions (if any)
encountered during processing, and messages directed to the Log file from the
SHOUT facility.
The user can filter IOA Log file contents displayed in the IOA Log screen.
Functional Approach
60 CONTROL-M for OS/390 and z/OS User Guide
IOA Manual Conditions Screen
The IOA Manual Conditions screen is accessed through option 7 of the IOA Primary
Option menu. It displays the IOA Manual Conditions file, which contains the list of
prerequisite conditions that must be added manually. These are IN conditions that
are required by scheduled jobs but are not added by scheduled jobs, that is, these
conditions are not listed as OUT or DO COND conditions in the Active Jobs file.
These conditions fall into the following categories:
s conditions that are never automatically added by scheduled jobs because manual
confirmation is always desired, for example, TAPE-ARRIVED
s conditions that are normally added automatically by scheduled jobs, but the jobs
that add them are not scheduled
For the conditions listed in the Manual Conditions screen to be added to the IOA
Conditions file, manual intervention is required.
The Manual Conditions list is described in Chapter 6, Selected Implementation
Issues.
The IOA Manual Conditions screen enables the user to:
s view the list of Manual Conditions
s select and add listed conditions, as desired, to the IOA Conditions file
IOA Calendar Facility
The IOA Calendar facility is accessed through option 8 of the IOA Primary Option
menu. IOA calendars allow definition of common scheduling patterns that simplify
the entering of basic scheduling criteria in job scheduling definitions.
The IOA Calendar facility enables the user to create, define, modify and delete IOA
calendars.
Online Utility Screens (Under ISPF)
When CONTROL-M and other INCONTROL products (if any) are active under ISPF,
a number of utilities and facilities can be activated online. The IOA Online Utilities
menu is accessed through option 6 of the IOA Primary Option menu (under ISPF).
The IOA Online Utilities menu displays available utilities from which the desired
utility or facility can be selected.
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 61
CONTROL-M Concepts
Having discussed CONTROL-M from a functional viewpoint, and having briefly
outlined the online user interface to CONTROL-M, it is now worthwhile to discuss
certain important concepts in CONTROL-M functioning.
IOA Core and CONTROL-M Repository
A differentiation is made between files belonging to a particular INCONTROL
product such as CONTROL-M, and IOA files that are shared among INCONTROL
products.
Shared IOA files are collectively referred to as the IOA Core. The IOA Core consists of
the following files:
Table 8 IOA Core Files (Part 1 of 2)
File Description
IOA Log file File in which all events related to job processing are recorded.
IOA Conditions
file
a

File that lists the available conditions identified and tracked by
the CONTROL-M monitor.
IOA Manual
Conditions file
File listing prerequisite conditions that must be added
manually, that is, prerequisite conditions required by jobs that
have been ordered to the Active Jobs file and which are not
automatically added by other jobs in the Active Jobs file.
IOA Calendar
tables
Files containing IOA calendar definitions.
Dynamic
Destination table
File containing a list of destinations for messages issued by the
IOA Shout facility.
Mail Destination
table
File containing a list of mail destinations for messages issued
by the IOA Shout facility.
Files belonging to a particular INCONTROL product are called the repository of
that product. The CONTROL-M Repository consists of the following files:
Active Jobs file File used to hold copies of the job scheduling definitions of
those jobs that have been ordered that working day.
CONTROL-M
Resources file
a

File that lists the available resources identified and tracked by
the CONTROL-M monitor.
Scheduling tables Files containing job scheduling definitions.
CMEM Rule tables Files containing CMEM rule definitions.
Job Statistics file File containing the execution statistics of all jobs.
Job Network file File containing dependency information about the jobs in the
Active Jobs file.
CONTROL-M Concepts
62 CONTROL-M for OS/390 and z/OS User Guide
Date Definition Concepts
INCONTROL recognizes the following types of date definitions. Depending on the
INCONTROL product, either all of them, or some of them, are relevant. All these
types are relevant for CONTROL-M:
Restart History
Jobs file
File containing jobs that ended OK or expired.
Journal file File containing data about changes to the CONTROL-M Active
Jobs file, the CONTROL-M Resources file, and the IOA
Conditions file
a
, and which can be used for Restoration
purposes.
a
Prior to version 6.0.00, conditions and resources were stored in a single file, the IOA
Conditions/ Resources file.
Table 9 Date Definition Types
Date Definition Description
System date Date as supplied by the operating system. This date must be
the actual calendar date starting and ending at midnight.
Working date Many sites do not use midnight as the formal time for
changing to a new date. A site, for example, may determine
that all processing performed between the hours of midnight
and 6:00 a.m. belongs to the previous day. In this case, the
installation working date at the site changes at 6:00 a.m., not at
midnight.
The working date, that is, the time at which the date changes at
the site, is defined in the CONTROL-M installation
parameters. New Day processing generally begins at the start
of the new working date.
Original scheduling
date
Job orders and prerequisite conditions managed by
CONTROL-M are assigned an original scheduling date, which
is referred to as ODATE. For the full implications of using
ODATE, see ODATE on page 154. For details of the
enhanced meaning of ODATE as of version 6.1.00, see
Enhanced Definition of ODATE on page 63.
Table 8 IOA Core Files (Part 2 of 2)
File Description
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 63
Example 1
A computer is down for repairs on February 2nd and 3rd. When it is brought up on
February 4th, a two-day backlog of jobs must be run in addition to the jobs of the
current day.
When the New Day procedure scans scheduling tables on February 4th, it places job
orders in the Active Jobs file for all three days. Jobs that ought to have run on
February 2nd are assigned an ODATE of February 2nd, jobs for February 3rd are
assigned an ODATE of February 3rd, and so on.
In this manner, each job is executed as if it had run on the working date on which it
was originally scheduled.
Example 2
ODATES are calculated according to the working date, and not the calendar date.
If you define a job to run on 5 December at 3 A.M., and the working day begins (and
the New Day procedure operates) at 5 A.M., the job will not run until 3 A.M. on
6 December, because that is still part of the working day of 5 December.
Enhanced Definition of ODATE
As of version 6.1.00, ODATE has an enhanced definition. ODATE can also be one of
the runtime criteria, such as IN conditions, that must be satisfied before a job can be
submitted. Runtime criteria are explained in Automated Job Submission on page 47
and Monitoring of Resources on page 47.
While prior to version 6.1.00 the ODATE was only a VALUE date, it can now be both
a RUN date and a VALUE date.
ODATE with the Attribute VALUE
In most cases, ODATE by default has the attribute VALUE. This means that it is a
VALUE date, and is not one of the runtime criteria.
When ODATE has the attribute VALUE, it has the following characteristics:
s ODATE is a logical date that is used by CONTROL-M when adding jobs to the
Active Jobs file for execution. The ODATE is assigned to a job by manual order or
by operation of the New Day procedure.
s The ODATE is a 24 hour period. It begins at the New Day time. During the 24 hour
period that follows that New Day time, all job scheduling is based on the ODATE,
which corresponds to the calendar date at that New Day time, rather than the
calendar date at the time when the job runs.
CONTROL-M Concepts
64 CONTROL-M for OS/390 and z/OS User Guide
s The ODATE can coincide with, precede, or follow the calendar date. If no value is
set for the DAYTIMEM parameter in the CTMPARM member, the ODATE
coincides with the calendar date. If the DAYTIMEM parameter is set using a -
(Minus) sign, the ODATE precedes the calendar date by the number of hours and
minutes specified in that parameter. If a + (Plus) sign is used, the ODATE follows
the calendar date in a similar manner.
For more information on the DAYTIMEM parameter, see the description of
operational parameters in the CONTROL-M chapter of the INCONTROL for
OS/390 and z/OS Installation Guide.
s When a job is eligible to be ordered on an ODATE, it is placed in the Active Jobs
file, and is immediately eligible for submission as soon as all its runtime criteria,
such as TIME FROM and TIME UNTIL, have been met.
s When the end of the ODATE arrives, the New Day procedure may remove jobs
with that ODATE from the Active Jobs file, depending on the setting of the
MAXWAIT parameter of the specific job. Jobs removed in this way cease to be
eligible for submission.
ODATE with the Attribute RUN
Although by default ODATE has the attribute VALUE, it may also have the attribute
RUN, if either set by the user, or the New Day procedure. In such cases, a job can only
run when its ODATE is the same as, or after, the CONTROL-M logical date. In other
words, the ODATE becomes a runtime criteria.
In this context, runtime criteria are the criteria that determine the eligibility
window for the submission of the job, that is, the period of time during which the
job can be submitted. This eligibility window is determined by the ODATE and the
TIME ZONE parameter setting.
For information on changing the attribute of ODATE from VALUE to RUN, see the
description of the Time Zone feature in the INCONTROL for OS/390 and z/OS
Administrator Guide, and the description of the CTMJOB utility in the INCONTROL for
OS/390 and z/OS Utilities Guide.
Date Standards and Date Field Formats
Date standards and date field formats use either Gregorian or Julian dates.
Gregorian Dates
Gregorian dates are indicated in the guide by the following symbols:
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 65
Whether a field holds a 4-character date (month and day), a 6-character date (month,
day and 2-digit year) or an 8-character date (month, day and 4-digit year) depends on
the field definition. However, the format of the 4-character, 6-character or 8-character
date depends on the date standard defined during installation.
INCONTROL products support three date standards for Gregorian dates. Each
standard has an 8-character format, a 6-character format and a 4-character format.
Only one Gregorian date standard is defined at any site.
These supported Gregorian date standards are described in the chart below.
Julian Dates
Julian dates (also supported by INCONTROL products) are indicated in the guide by
the following symbols:
Table 10 Gregorian Date Notation
Symbol Description
dd Day of the month (01 31)
mm Month (01 12)
yy Last two digits of the year
a
a
If the last two digits in the specified year are a number less than 56, IOA presumes that the
year is in the 21
st
century; for example, if yy=15, the year 2015 would be presumed.
Otherwise, IOA presumes that the year is in the 20
th
century; for example, if yy=80, the year
1980 would be presumed.
yyyy Four digits of the year
Table 11 Supported Gregorian Dates
Standard 4-Character Date 6-Character Date 8-Character Date
MDY mmdd mmddyy mmddyyyy
DMY ddmm ddmmyy ddmmyyyy
YMD mmdd yymmdd yyyymmdd
Table 12 Julian Date Notation
Symbol Description
jjj or ddd Day of the year (001 365 or 366, as appropriate for the year)
yy Last two digits of the year
yyyy Four digits of the year
CONTROL-M Concepts
66 CONTROL-M for OS/390 and z/OS User Guide
Julian date fields have either three, five, or seven characters. Whether a Julian date
field holds a 3-character date (day of year only), 5-character date (day of year and
2-digit year) or a 7-character date (day of year and 4-digit year) depends on the field
definition. However, the format of the date depends on the installation-defined date
standard.
For example, the Julian date for the calendar date of 28 February 2001 would be
represented in jjj or ddd format as 059, in yyjjj or yyddd format as 01059, and in
yyyyjjj or yyyyddd format as 2001059.
Job Ordering and Job Forcing
Job ordering is the placing of a job scheduling definition in the Active Jobs file when
the basic scheduling criteria of the job are satisfied.
Most production jobs are automatically ordered during New Day processing.
However, jobs can be manually ordered, as well.
Job forcing is the placing of a job scheduling definition in the Active Jobs file
regardless of the basic scheduling criteria of the job.
Although any job can be forced, job forcing is generally requested for special purpose,
or exception, jobs that are not normally scheduled:
s Jobs can be automatically forced as part of the post-processing of another job. For
example, a particular job may be required only if a certain other job abends. In this
case, it is forced during the post-processing for the abended job.
s Jobs can also be forced manually. For example, a routine job that is generally
ordered automatically according to its scheduling criteria can be manually forced,
if required, on a day it is not normally scheduled.
Rerun and Restart
Rerun and restart are two distinct, though related, concepts.
Rerun is the re-execution of a job from the beginning. Job rerun is a CONTROL-M
feature.
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 67
Restart is the re-execution of a job from a predefined step. Restart is usually
performed from the step that failed, although it can be performed from an earlier
step, if necessary. Restart utilizes the successful steps from the failed job execution,
thereby limiting the amount of processing required to complete successful job
execution. This results in lower CPU overhead, and can make a big difference in the
timely completion of processing.
A basic MVS restart capability is available, and is described in OUT: PostProcessing
Parameter on page 554. BMC Software do not recommend this method. This type of
restart starts execution of the job from the failed step. However, no auxiliary restart
functions are performed.
Restart By contrast, at sites in which CONTROL-M/ Restart is installed, restart
under CONTROL-M/ Restart is available. In addition to performing restart from the
desired step, with the capability of automatic step rollback when necessary,
CONTROL-M/ Restart automatically performs auxiliary restart functions. These
include the cataloging and scratching of data sets, prevention of NOT CATLGD 2
errors, and so on.
Restart Instructions for rerun and restart can be defined in the job scheduling
definition. Rerun is defined with the DO RERUN statement. Restart is defined with
the DO IFRERUN statement. They can be defined to be performed automatically or to
be performed upon manual confirmation. For more information, see DO RERUN:
PostProcessing Parameter on page 459, RestartDO IFRERUN: PostProcessing
Parameter on page 446, and the CONTROL-M/Restart User Guide. Restart
Order ID
CONTROL-M can handle multiple orders of the same job. To distinguish between the
job orders, CONTROL-M assigns each job order a unique order ID. Therefore, it is not
uncommon to see the same job name with multiple order IDs, each representing a
different job order, in the Active Environment screen.
SYSDATA
SYSDATA is the term used to designate the data in three job sysout data sets:
s job log (console messages)
s expanded JCL
s system output messages
CONTROL-M Concepts
68 CONTROL-M for OS/390 and z/OS User Guide
SYSDATA data sets are usually produced for each execution of a job or started task.
However, not all three data sets are necessarily present in all cases. For example, in
JES2, if a job is canceled by the operator before execution, the system output messages
data set might not be produced.
For jobs, the output class for this data is defined by one of the following:
s MSGCLASS parameter on the job card, which is added or overwritten by
CONTROL-M during job submission
s JCL job-level / / OUTPUT statement using the JESDS subparameter
s default values defined in JES initialization parameters
s for started tasks, in JES initialization parameters
When CONTROL-M/ Restart is installed, it uses the SYSDATA to analyze the
execution of a job order, beginning with the archived SYSDATA of the most recent
non-restarted run.
Handling of Job Groups
Normally, the handling of each job in a table is independent of the handling of the
other jobs in the table. Each job is handled according to the criteria specified in its
own job scheduling definition.
However, the Scheduling Definition facility also supports the handling of jobs as a
group. Such jobs are defined in a special scheduling table, called a Group scheduling
table. Each Group scheduling table has a special job scheduling definition, called a
Group Entity. Group handling criteria for the entire group of jobs are specified in this
Group Entity. These include:
Table 13 Group Handling Criteria
Criteria Description
Basic Scheduling criteria Scheduling criteria to be applied to jobs in the group.
Runtime Scheduling
criteria
Required runtime criteria for all scheduled jobs in the
group.
Post Processing actions Actions to be performed when all scheduled jobs in the
group have finished executing with the appropriate
status.
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 69
Dynamic Group Insert
When a group is ordered, the group entity and some or all of its jobs are placed on the
Active Jobs File. The Dynamic Group Insert facility makes it possible to insert
additional jobs belonging to this group into the group entity that is already on the
Active Jobs File.
The additional jobs must be jobs that belong to the group. They may be either or both
of the following:
s jobs that were not scheduled at the current time
s additional copies of jobs that are already in the Active Jobs File
For more information about using the Dynamic Group Insert facility, see the
description of the job ordering facility CTMJOB in the CONTROL-M Utilities chapter
of the INCONTROL for OS/390 and z/OS Utilities Guide.
Prerequisite Conditions
The prerequisite condition concept is one of the key concepts of CONTROL-M
production control.
Prerequisite conditions enable the establishment of job dependencies and, when a job
normally requires manual intervention, such as determination that a cartridge
arrived on-site, ensures that the manual conditions are satisfied before the job is
submitted.
A prerequisite condition is a user-defined, descriptive name given to a certain
situation or condition. Prerequisite conditions can be specified in any of three types of
statements in a job scheduling definition:
Table 14 Prerequisite Condition Statements (Part 1 of 2)
Statement Description
IN statements These statements must be satisfied (that is, the prerequisite
condition must exist) before the job can be submitted.
CONTROL-M Concepts
70 CONTROL-M for OS/390 and z/OS User Guide
In its most basic form, a prerequisite condition is defined in an IN statement in one
job, and as an OUT (or DO COND) statement in another job. This makes the
execution of the one job dependent on the execution of the other job.
Example
Figure 1 Establishing Job Dependency by Prerequisite Conditions

Payroll-calculating job PAYCALC must be run before Payroll-check-printing job
PRINTPAY. To create the necessary job dependency, a prerequisite condition is
defined as follows:
s Prerequisite condition PAYCALC-ENDED-OK is defined as a runtime scheduling
criteria in the job scheduling definition for job PRINTPAY.
OUT statements These statements are performed, that is, the prerequisite
conditions are added or deleted, only when the job ends OK.
DO COND
statements
Whether these statements are performed (that is, the
prerequisite conditions are added or deleted) depends on the
execution results of the job.
DO statements in a job scheduling definition accompany ON
statements. The ON statements define step and code criteria. If
the specified code criteria are satisfied for the specified steps,
the accompanying DO statements are performed.
Table 14 Prerequisite Condition Statements (Part 2 of 2)
Statement Description
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 71
s Prerequisite condition PAYCALC-ENDED-OK is defined as a post-processing
parameter for job PAYCALC, only when job PAYCALC terminates successfully.
Because the condition required by job PRINTPAY is not created unless job PAYCALC
terminates successfully, the dependency of job PRINTPAY on job PAYCALC is
established.
Job dependencies do not have to be as simple as the above example illustrates. An
almost unlimited number of conditions and job dependencies can be created:
s jobs can be dependent on more than one prerequisite condition
s jobs can add and/ or delete more than one prerequisite condition
s the same prerequisite condition can be added by more than one job (caution must
be used)
s the same prerequisite condition can be used as an IN condition for more than one
job
In Group scheduling tables (described in Handling of Job Groups on page 1-68),
prerequisite conditions can be defined as IN, OUT and/ or DO COND conditions in
the Group Entity. In this case, they apply to the entire set of scheduled jobs.
Prerequisite Condition Dates
IN, OUT, and DO COND statements provide a field for specifying a date to
accompany each prerequisite condition. An OUT or DO COND prerequisite
condition that is added with a particular date cannot satisfy the same IN prerequisite
condition if the IN statement specifies a different date.
Example
JOB_A and JOB_B each run daily, and JOB_B is dependent on JOB_A.
(JOB_A has prerequisite condition JOB_A_ENDED_OK as an OUT condition, and
JOB_B has the same condition as an IN condition.)
The date associated with a condition is important because it is absolutely necessary
that, on a given day, JOB_B not be triggered by an occurrence of the condition
JOB_A_ENDED_OK from a previous day.
Certain Date keywords can be specified in place of, and resolve to, actual date values.
For example, keyword ODAT is automatically replaced by the original scheduling
date of the job.
CONTROL-M Concepts
72 CONTROL-M for OS/390 and z/OS User Guide
Another important keyword for use in place of an actual date is STAT. STAT is used
as a date reference for conditions that are static, that is, not date-dependent.
For example, condition IMS_ACTIVE is added when IMS is brought up, and only
deleted if IMS is brought down. The date of the condition is irrelevant to jobs
requiring that condition. Therefore, this condition would be referenced with a date
value of STAT.
Deleting Conditions
The last job to require a particular prerequisite condition, that is, in an IN statement,
can also mark that condition for deletion, that is, in an OUT statement. The deletion of
unnecessary conditions can serve the following purposes:
It can eliminate unnecessary clutter from the IOA Conditions file and the
CONTROL-M Resources file, and the IOA Conditions/ Resources screen.
When dependent jobs are scheduled multiple times each day, it can prevent the
execution of the earlier scheduled predecessor job from incorrectly causing the
submission of the later scheduled successor job.
Conditions Requiring Manual Intervention
Prerequisite conditions can be used to ensure that a required manual operation has
been performed. The following example illustrates such a condition.
Example
The job scheduling definition of JOB-A specifies prerequisite condition
TAPE-ARRIVED as runtime scheduling criteria. When the operator sees that JOB-A is
waiting for this condition to be satisfied, the operator can verify that the required
external tape has arrived at the site, and then use the online facility to manually add
the condition to the IOA Conditions file (through the Manual Conditions screen, the
IOA Condition/ Resources screen, or the Why screen). The job can then be submitted
by CONTROL-M.
NOTE
Before STAT was introduced, date 0101 was recommended to be used in conditions
that were not date-dependent. Unlike 0101, STAT is not a date, and it operates
differently. Always use STAT when defining conditions that are not date-dependent.
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 73
Maybe Jobs
In some cases, job dependencies created by prerequisite conditions are desired only if
the predecessor jobs are scheduled. If the predecessor jobs are not scheduled, ignore
the dependencies.
Such dependencies are called Maybe dependencies, and the unscheduled predecessor
jobs that are ignored if they are not scheduled are called Maybe jobs. Conditions set
by unscheduled Maybe jobs appear in the Manual Conditions file.
The Manual Conditions file and the handling of Maybe jobs are discussed in
Chapter 6, Selected Implementation Issues.
Quantitative and Control Resources
To prevent bottlenecks and help guarantee successful execution of jobs,
CONTROL-M provides tools to ensure that a job is not submitted for execution until
all resources required by the job are available.
Quantitative Resources
Specification of Quantitative resource requirements for a job provides a solution for
the allocation of quantitative computer resources, such as cartridge drives, CPU
utilization, and database access-rate. It increases computer throughput by controlling
access to these resources, thus preventing execution bottlenecks.
CONTROL-M maintains a continuously updated status of the Quantitative resources
of the site in the CONTROL-M Resources file.
When a Quantitative resource is specified for a job, CONTROL-M determines if a
sufficient quantity of the specified resource is available before submitting the job.
When the job is submitted, the specified quantity of resource is allocated to that job
and is unavailable to other jobs. When the job finishes executing, the resource is made
available to other jobs.
The quantity of each resource that is available in the data center is specified using
CONTROL-M utilities. An authorized user can dynamically change these quantities
manually from the IOA Conditions/ Resources screen.
Control Resources
Specification of resource control requirements for a job provides a solution for the
problem of resource sharing between different jobs. The mode (Exclusive or Shared)
in which a resource is required by a job can be specified.
CONTROL-M Concepts
74 CONTROL-M for OS/390 and z/OS User Guide
For example, a job that reads a database without performing updates can access the
database in Shared mode; any other job requiring read-only access to the database
can access the database at the same time. Conversely, a job that updates the database
may require Exclusive control of the database at the time of update such that no other
jobs can share the database.
In the example just presented, the database can be defined as a Control resource, and
the type of control required by the job (Exclusive or Shared) can be specified for the
resource.
CONTROL-M considers the mode of resource usage required when allocating
Control resources and prevents jobs whose resource usage is incompatible from
executing simultaneously.
Job Priority
The job scheduling definition may include a specification of an internal priority for
the job. When competing for the same resource, jobs with higher priority take
precedence over jobs with lower priority. Users can also assign a critical path
priority to jobs that must be submitted with the least delay possible. A job with
critical path priority is allocated required resources as the resources become available.
When all its required resources are available, the job is submitted.
Noncritical jobs are not allocated resources until all required resources are available
at the same time.
Automatic Job Flow Adjustment
Predecessor and successor job flows are established through the use of prerequisite
conditions that are defined in the job scheduling definition. Successor and
predecessor jobs are identified as either immediate or eventual, relative to a
specified job:
s An immediate predecessor and successor relationship exists between jobs when
one job is directly dependent on prerequisite conditions added by the other job.
s An eventual predecessor and successor relationship exists between jobs if their
dependency is indirectly established through a chain of immediate predecessor
and successor jobs.
From the network of predecessor and successor jobs, critical paths can be identified.
A critical path is a chain of jobs that must be executed in their appropriate sequence in
order for a specified job to run. A job can have more than one critical path, if different
jobs set the same OUT condition, or if a job has OR logic in its IN conditions.
CONTROL-M Concepts
Chapter 1 Introduction to CONTROL-M 75
The Job Dependency Network screen, accessed through the Active Environment
screen, enables you to view the network of predecessor and successor jobs for a
specified job and determine the critical paths for the job.
Although it is prerequisite conditions that define predecessor and successor job
relationships, the actual job flow along a critical path can be greatly impacted by the
following runtime scheduling criteria in the job scheduling definition:
In some cases, it may become desirable to adjust the priorities or due-out times of
certain job orders.
Examples
s A high priority successor job is waiting for the submission (and completion) of a
lower priority predecessor job.
s A predecessor job cannot terminate early enough for a successor job to terminate
by the due-out time of the successor.
Both types of job flow adjustments can be requested from the Job Dependency
Network screen:
s Priority Propagation
The priority value of each non-Held predecessor and successor job is checked and
(if necessary) modified so all jobs in the chain have a priority, and no job has a
lower priority than any of its successor jobs.
s Deadline Adjustment
Starting with the latest eventual successor job in the job flow, the anticipated
elapsed time (that is, anticipated execution time) is subtracted from the DUE OUT
time to determine DUE OUT time of the immediate predecessors of that job.
This process of subtracting elapse times of a job to determine the DUE OUT time of
the immediate predecessor jobs are repeated until the DUE OUT time of the initial
or current job is determined.
s If the user entered an ELAPSE time value in the Online Tracking and Control
facility Zoom screen, this value is used for the above calculation.
Table 15 Runtime Scheduling Criteria
Criteria Description
PRIORITY As mentioned earlier in Job Priority, a PRIORITY value affects
the selection order of the job (relative to other jobs).
DUE OUT The time by which the job must finish executing.
CONTROL-M Concepts
76 CONTROL-M for OS/390 and z/OS User Guide
s If the user did not enter an ELAPSE time value, the anticipated elapse time is
determined by the average runtime taken from the CONTROL-M Statistics file.
Note the following points:
s By subtracting the ELAPSE time of a job from its DUE OUT time, the
CONTROL-M monitor calculates a DUE IN time (that is, the time by which the job
must be submitted) for each job. This value is also displayed in the Job
Dependency Network screen.
s The ELAPSE, DUE OUT, DUE IN and PRIORITY values for a job are also
displayed in the Zoom screen, which is accessed through the Active Environment
screen.
s DUE OUT, ELAPSE and PRIORITY values can also be manually modified in the
Zoom screen, but it is recommended that this not be done, and that automatic job
flow adjustment be requested instead.
Chapter 2 Online Facilities 77
Chapt er
2
2 Online Facilities
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IOA Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
General IOA Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IOA Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
IOA Primary Option Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Multi-Screen Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Fast Exit from the IOA Online Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Screen Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Commands and PFKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
AutoRefresh Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
IOA Under ISPF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
IOA Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
IOA SET Command Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
IOA TSO Command Processor Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Scheduling Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Table List screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Job List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Job Scheduling Definition Screen Defining Schedules . . . . . . . . . . . . . . . . . . . . 128
Exiting the Scheduling Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Ordering (Scheduling) Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Copying Jobs to Another Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Deleting Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Displaying Graphic Jobflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Displaying a Job Scheduling Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Tracking and Control Facility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Active Environment Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Global View Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
View Graph Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Why Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Deleting a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Log Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
78 CONTROL-M for OS/390 and z/OS User Guide
Confirm Scheduling Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Confirm Rerun Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Restart Confirm Restart Window (Under CONTROL-M/ Restart) . . . . . . . . . 223
RestartRerun and/ or Restart Window (Under CONTROL-M/ Restart) . . . . . 223
RestartStep List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
RestartJob Order Execution History Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Restart Sysout Viewing Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Statistics Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Job Dependency Network Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Restart History Environment Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Force OK Confirmation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
CMEM Rule Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Table List Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Rule List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Rule Definition Screen Defining Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Entering Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Editing CMEM Rule Definitions in the Edit Environment . . . . . . . . . . . . . . . . . . 257
Exiting the CMEM Rule Definition Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Deleting Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Ordering CMEM Rule Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Copying Rules to Another Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
IOA Variables Database Facility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Database List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Values of Database Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Variable Zoom Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Condition and Resource Handling Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
IOA Conditions/ Resources Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Condition and Resource Handling Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
IOA Manual Conditions Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
IOA Log Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
IOA Log Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
IOA Calendar Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Accessing the IOA Calendar Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Entry Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Calendar List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Year List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Copying Years to Another Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Calendar Definition Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Exiting the IOA Calendar Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Utilities Under ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
IOA Online Utilities Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
I1: Add, Check, or Delete a Prerequisite Condition . . . . . . . . . . . . . . . . . . . . . . . . 322
M1: Issue a Job Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
M2: Perform an AutoEdit Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
M3: Prepare Simulation/ Tape Pull List Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
M4: Parameter Prompting Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
M5: Quick Schedule Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Chapter 2 Online Facilities 79
M6: End-User Job Order Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
U1: Invoke DOCU/ TEXT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Overview
80 CONTROL-M for OS/390 and z/OS User Guide
Overview
The Online facility is the basic means of communication between the user and
CONTROL-M for OS/ 390 and z/ OS.
Online job scheduling definition gives users the ability to define and modify job
production parameters in the CONTROL-M production environment.
Online tracking displays the current status of all variables relating to a specific job, a
group of jobs or all jobs scheduled under CONTROL-M.
Online control enables authorized users to modify variables relating to a specific job,
a group of jobs or all jobs scheduled under CONTROL-M.
The following pages describe the main features available under the Online facility.
IOA Features
This section discusses the IOA features common to all INCONTROL products.
General IOA Features
General IOA features include:
s Customization
s Environment Support
s Terminal Support
s Special Character Usage on Terminals
s Color Support
s Prefixing
s Character Masking
Customization
IOA screens, constants, messages, colors, commands, and PFKey definitions can be
site-modified to adapt them to local needs. For further details, see the INCONTROL
for OS/390 and z/OS Installation Guide.
IOA Features
Chapter 2 Online Facilities 81
INCONTROL products can be customized globally, that is, for the whole site, using
the INCONTROL Installation and Customization Engine (ICE), according to profile
variables defined during installation.
In addition, INCONTROL products can be customized to respond differently to
individual users if these profile variables are specified in user profile members.
For example, depending on the setting of a variable in a particular user profile
member, upon exit from a screen in which changes have been requested, this
INCONTROL product may either perform the requested changes automatically or
display a confirmation window before performing the changes.
Customization issues are discussed in the INCONTROL for OS/390 and z/OS
Installation Guide.
Environment Support
The Online facility can be activated under the following environments:
s TSO (native)
s TSO/ ISPF
s ROSCOE/ ETSO
s CICS
s VTAM
s IMS/ DC
s IDMS/ DC
s COM-PLETE
Cross memory interfaces (to the Online monitor) are optional under native TSO,
TSO/ ISPF, and ROSCOE/ ETSO. They are always used under the other
environments.
There are slight differences in the operation of the Online facility under the different
environments. Special notes are provided in this guide where applicable.
NOTE
Due to customization, the screens and examples illustrated in this guide may differ
from the ones used at your site. The $$ACTDOC member of the IOA MSG library
contains information that is useful for customizing the CONTROL-M Active
Environment screen and creating and modifying display types for screens 3, 3.N, 3.G
and the History Environment screen.
IOA Features
82 CONTROL-M for OS/390 and z/OS User Guide
Terminal Support
IOA supports the following models of IBM 3270 terminals:
s Model 2 24 lines, 80 columns
s Model 4 43 lines, 80 columns
s Model 3 32 lines, 80 columns
s Model 5 27 lines, 132 columns
IOA adjusts to the screen size in order to use the maximum available data area on the
screen.
Special Character Usage on Terminals
In certain cases, special keyboard characters, such as $, #, and @, are assigned special
meanings. The characters specified appear on standard American terminals but may
not be available on other keyboards. In addition, some special characters on your
keyboard may be assigned different hexadecimal values than the ones recognized by
IOA. Special keyboard mapping requirements, and a complete discussion of the
conventions used in this guide, are shown in Conventions Used in This Guide on
page 33.
Color Support
When INCONTROL products are activated from a screen with extended seven-color
support, they make extensive use of the color attributes of the screen. The concept of
management by color is emphasized in INCONTROL screens.
Like all screen attributes, the color attribute for each field is defined externally to the
program and can be locally modified by the site.
At this time, IOA does not support extended color attributes under
COM-PLETE.
NOTE
When using the IOA online facility under IMS/ DC and IDMS/ DC, all model types
display 24 lines and 80 columns.
NOTE
IOA does not automatically recognize IMS/ DC and IDMS/ DC terminals as
supporting extended color attributes. If your IMS/ DC or IDMS/ DC terminal
supports extended color attributes and you want IOA to recognize this, refer to the
INCONTROL for OS/390 and z/OS Administrator Guide for more information.
IOA Features
Chapter 2 Online Facilities 83
Due to ISPF characteristics, color changes cannot occur in adjacent columns but
must be separated by an attribute byte without color, that is, black. Therefore,
some IOA screens have a different appearance under ISPF than under other
online environments, such as native TSO and CICS.
Prefixing
For fields that automatically support prefixing, selection strings are always treated as
prefixes. Selection is made if a segment of the text beginning with the first letter, that
is, any prefix, matches the selection criteria.
Examples
Assume the following names exist: A3, A4, M, M01, M03, M12, M13, M22, M23, M30,
M33, M103, M135, M301.
If a field supports prefixing, this fact is indicated in its description.
Character Masking
For fields that support masking, mask characters function as follows:
s * represents any number of characters, including no characters
s ? represents any one character
For fields that do not automatically support prefixing, a prefix value can be specified
by ending the selection string with an asterisk.
Table 16 Prefixing Examples
Entry Matching Value
blank All of the above values
A A3, A4
M M, M01, M03, M12, M13, M22, M23, M30, M33, M103, M135, M301
M1 M12, M13, M103, M135
M13 M13, M135

IOA Features
84 CONTROL-M for OS/390 and z/OS User Guide
Examples
Assume the following names exist: A3, M, M3, M01, M03, M13, M23, M33, M103,
M435, M2243.
If a field supports masking, this fact is indicated in its description.
IOA Entry Panel
Enter the IOA Online facility according to the instructions of your INCONTROL
administrator. Upon entering the IOA Online facility, the IOA entry panel may be
displayed.
Table 17 Masking Examples
Entry Matching values
* All the above values
M?3 M03, M13, M23, M33
M?3* M03, M13, M23, M33, M435
M??3 M103
M*3 M3, M03, M13, M23, M33, M103, M2243
M* M, M3, M01, M03, M13, M23, M33, M103, M435, M2243
Since the last character in this example is *, M is treated as a
prefix.
NOTE
Display of the IOA Entry Panel is optional. If your INCONTROL administrator
determined that the entry panel is bypassed, the IOA Primary Option menu, which is
discussed in the following section, is displayed.
IOA Features
Chapter 2 Online Facilities 85
Figure 2 IOA Entry Panel
Type your user ID and password and press Enter. If you enter a correct user ID and
password, the IOA Primary Option menu is displayed.
The IOA Online facility allows three attempts to enter a valid user ID and password
combination. After the third unsuccessful attempt, the program is terminated.
To change a password, type the new password twice: Once in the NEW PASSWORD
field and once in the confirmation field to the right of the NEW PASSWORD field.
IOA Primary Option Menu
The IOA Primary Option menu is the primary interface to functions available under
the various INCONTROL products. The options displayed in the menu depend on
the INCONTROL products installed at the site, and the functions and facilities that
have been authorized to you.
If only CONTROL-M is installed at your site, and you are authorized to access all
functions and facilities, the following screen is displayed:
- - - - - - - - - - - - - - - - - - - - - - - - - - - I OA ENTRY PANEL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -




+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| |
| USER I D ===> |
| |
| PASSWORD ===> |
| | a
| NEWPASSWORD ===> ===> |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +








PLEASE FI LL I N USER I D AND PASSWORD AND PRESS ENTER 18. 30. 18
IOA Features
86 CONTROL-M for OS/390 and z/OS User Guide
Figure 3 IOA Primary Option Menu where only CONTROL-M is Installed
To select an option, type the option number or letters in the OPTION field and press
Enter. Alternatively, for a number option, press the PFKey with the same number.
For example, to select the LOG option, press PF05/PF17.
NOTE
When the Online facility is activated as an ISPF application, option 6 is displayed as
6 UTILITIES Online Utilities. In this case, option 6 activates the Online utilities
under ISPF. When the Online facility is not activated under TSO or TSO/ ISPF, option
6 is inactive.
- - - - - - - - - - - - - - - - - - - - - I OA PRI MARY OPTI ON MENU - - - - - - - - - - - - - - - - - - ( 1)
OPTI ON ===> USER N22A
DATE 19. 08. 01





2 JOB SCHEDULE DEF CTM Job Schedul i ng Def i ni t i on
3 ACTI VE ENV. CTM Act i ve Envi r onment Di spl ay
C CMEM DEFI NI TI ON CTM Event Manager Rul e Def i ni t i on
4 COND- RES I OA Condi t i ons/ Resour ces Di spl ay
5 LOG I OA Log Di spl ay
6 TSO Ent er TSO Command
7 MANUAL COND I OA Manual Condi t i ons Di spl ay
8 CALENDAR DEF I OA Cal endar Def i ni t i on
I V VARI ABLE DATABASE I OA Var i abl e Dat abase Def i ni t i on Faci l i t y






COMMANDS: X - EXI T, HELP, I NFO OR CHOOSE A MENU OPTI ON 17. 59. 32
NOTE
Your INCONTROL administrator can limit the options displayed on a user-by-user
basis, and can alter option numbers and customize option descriptions.
Product-supplied default options are discussed in this guide.
IOA Features
Chapter 2 Online Facilities 87
Certain IOA commands, functions, and facilities (options) are shared by all
INCONTROL products. These shared IOA commands, functions and facilities are
described later in this chapter, and outlined in Table 18.
The following commands, functions, and facilities (options) are applicable to
CONTROL-M:
Table 18 INCONTROL Shared IOA Functions and Facilities
Option Function Description
4 COND/ RES Display and update the status of the IOA
Conditions file and the CONTROL-M Resources
file.
5 LOG View audit trail information about jobs, missions,
and rules scheduled under the supervision of
INCONTROL products.
6 TSO
a
a
When the Online facility is activated as an ISPF application, option 6 is displayed as 6
UTILITIES Online Utilities. In this case, option 6 activates the Online utilities under ISPF.
When the Online facility is not activated under TSO or TSO/ ISPF, option 6 is inactive.
Perform TSO commands.
7 MANUAL COND Display the list of prerequisite conditions that
must be confirmed manually by operations
personnel.
8 CALENDAR DEF Define scheduling calendars.
X EXIT Exit the Online facility.
INFO INFO Display a window in the IOA Primary Option
Menu. The window contains information about
installed INCONTROL products. For more details
on the information displayed by this command,
see IOA Version Information on page 90.
NOTE
Entering =1 in the command line of any other screen returns you to the IOA Primary
Option Menu that is displayed at your site.
Table 19 CONTROL-M Functions and Facilities (Part 1 of 2)
Option Function Description
IV VARIABLE DATABASE Define, display, and update IOA
Database variables.
2 JOB SCHEDULE DEF Define and modify job production
parameters.
IOA Features
88 CONTROL-M for OS/390 and z/OS User Guide
The following IOA Primary Option menu is displayed at sites supporting all
currently available INCONTROL mainframe products.
When the IOA online facility is activated as an ISPF application, option 6 is displayed
as 6 UTILITIES Online Utilities. In this case, option 6 activates the Online utilities
under ISPF. When the online facility is not activated under TSO or TSO/ ISPF, option
6 is inactive.
Figure 4 IOA Primary Option Menu when all INCONTROL Products are Installed
3 JOB STATUS Display and update status of jobs
scheduled under CONTROL-M.
C CMEM DEFINITION Define and modify CMEM rules.
NOTE
Option OK (KOA Recorder facility) is available only under IOATSO, and not under
IOAISPF or IOAMON.
- - - - - - - - - - - - - - - - - - - - - I OA PRI MARY OPTI ON MENU - - - - - - - - - - - - - - - - - - ( 1)
OPTI ON ===> USER N06

I OA CONTROL- D/ V CONTROL- O

4 COND- RES A MI SSI ON STATUS OR RULE DEFI NI TI ON
5 LOG M MI SSI ON DEF OM MSG STATI STI CS
6 TSO R REPORT DEF OS RULE STATUS
7 MANUAL COND T RECI PI ENT TREE OL AUTOMATI ON LOG
8 CALENDAR DEF U USER REPORTS OA AUTOMATI ON OPTS
I V VARI ABLE DATABASE F PC PACKET STATUS OC COSMOS STATUS
DO OBJECTS OK KOA RECORDER


CONTROL- M & CTM/ Rest ar t CONTROL- M/ Anal yzer CONTROL- M/ Tape

2 JOB SCHEDULE DEF BB BALANCI NG STATUS TR RULE DEFI NI TI ON
3 ACTI VE ENV. BM MI SSI ON DEF TP POOL DEFI NI TI ON
C CMEM DEFI NI TI ON BV DB VARI ABLE DEF TV VAULT DEFI NI TI ON
BR RULE DEFI NI TI ON TI I NQ/ UPD MEDI A DB
BA RULE ACTI VI TY TC CHECK I N EXT VOL


COMMANDS: X - EXI T, HELP, I NFO OR CHOOSE A MENU OPTI ON 16. 20. 21
NOTE
Entering =1 in the command line of any other screen returns you to the IOA Primary
Option Menu that is displayed at your site.
Table 19 CONTROL-M Functions and Facilities (Part 2 of 2)
Option Function Description
IOA Features
Chapter 2 Online Facilities 89
For a description of the options for other INCONTROL products, see the user guides
of the respective products.
Additional options available on the IOA Primary Option Menu when operating
CONTROL-M with other INCONTROL products are listed in Table 20.
Table 20 IOA Primary Option Menu Options (Part 1 of 2)
Option Name Description
A MISSION STATUS Display and update active mission
status.
M MISSION DEF Define migration, printing, backup,
and restore missions.
R REPORT DEF Define decollating missions (including
indexing).
T RECIPIENT TREE Display and update the recipient tree.
U USER REPORTS Display and update the status of user
reports. View reports online.
F PC PACKET STATUS Display the status of reports (packets)
scheduled for transfer from the
mainframe to a PC.
DO OBJECTS Manage CONTROL-D objects.
Note: Options A, M, R, T, U, F, and DO are available only at sites where
CONTROL-D or CONTROL-V are installed.
BB BALANCING STATUS Display and update the status of active
balancing missions.
BM MISSION DEF Define balancing missions.
BV DB VARIABLE DEF Define, display and update Database
variables.
BR RULE DEFINITION Define balancing rules.
BA RULE ACTIVITY Display rule activity and the result of
invoking CONTROL-M/ Analyzer
rules.
Note: Options BB, BM, BV, BR, and BA are available only at sites where
CONTROL-M/ Analyzer is installed.
OR RULE DEFINITION Define rules.
OM MSG STATISTICS View message statistics.
OS RULE STATUS View Rule Status screen.
OL AUTOMATION LOG Display commands, messages and/ or
traces.
OA AUTOMATION OPTS Display available operator
productivity tools.
IOA Features
90 CONTROL-M for OS/390 and z/OS User Guide
IOA Version Information
Enter INFO (or I) in the OPTION field of the IOA Primary Option menu to display
the IOA Version Information window, as illustrated in Figure 5. This window lists the
version and level of each INCONTROL product installed at the site, plus the CPU ID
and current system date. The IOA Version Information window also identifies the
unique IOA QNAME assigned to the site. For further information about the IOA
QNAME, see the IOA operational parameters step, the IOAPLEX parameters step,
and the adding IOA structures to the CFRM step, all in the INCONTROL for OS/390
and z/OS Installation Guide. Press Enter or END (PF03/PF15) to exit the window and
return to the IOA Primary Option menu.
OC COSMOS STATUS Display or modify the status of
COSMOS-controlled objects and
databases.
OK KOA RECORDER Record VTAM scripts.
Note: Options OR, OM, OS, OL, OA, OV, OC, and OK are available only at sites
where CONTROL-O is installed.
TR RULE DEFINITION Define rules.
TP POOL DEFINITION Define pools.
TV VAULT DEFINITION Define vaults.
TI INQ/ UPD MEDIA DB Display the Inquire/ Update screen.
TC CHECK IN EXT VOL Check in external volumes.
Note: Options TR, TP, TV, TI, and TC are available only at sites where
CONTROL-M/ Tape is installed.
Table 20 IOA Primary Option Menu Options (Part 2 of 2)
Option Name Description
IOA Features
Chapter 2 Online Facilities 91
Figure 5 IOA Version Information
Multi-Screen Control
It is not necessary to return to the IOA Primary Option menu to move from one
online facility to another.
To speed up transfer of control between screens of different facilities and to enable
you to manage several online facilities at the same time, transfer control commands
can be specified. Transfer commands take you directly from your current screen to
the requested screen. Transfer commands can be used to reach any screen that can be
accessed by the IOA Primary Option menu at your site.
Each transfer control command consists of an equal sign immediately followed by
one of the options of the IOA Primary Option menu, which represents the target
screen of the transfer. For example, from any screen, enter:
If you use a transfer command to reach another screen, the state of the current screen
remains unchanged when you return to it by another transfer command.
- - - - - - - - - - - - - - - - - - - - - I OA PRI MARY OPTI ON MENU - - - - - - - - - - - - - - - - - - ( 1)
OPTI ON ===> USER N06

I OA CONTROL- D/ V CONTROL- O
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
4 COND- RES | I OA VERSI ON I NFORMATI ON | EFI NI TI ON
5 LOG | | ATI STI CS
6 TSO | I OA Ver si on 6. 1. 00 | TATUS
7 MANUAL CON | I OAGATE Ver si on 6. 1. 00 | TI ON LOG
8 CALENDAR D | CONTROL- M Ver si on 6. 1. 00 | TI ON OPTS
I V VARI ABLE D | CONTROL- M/ RESTART Ver si on 6. 1. 00 | STATUS
| CONTROL- M/ ANALYZER Ver si on 6. 1. 00 | CORDER
| CONTROL- M/ TAPE Ver si on 6. 1. 00 |
| CONTROL- D Ver si on 6. 1. 00 |
CONTROL- M & CTM | CONTROL- V Ver si on 6. 1. 00 | ape
| CONTROL- O Ver si on 6. 1. 00 |
2 JOB SCHEDU | | EFI NI TI ON
3 ACTI VE ENV | | EFI NI TI ON
C CMEM DEFI N | DATE 19. 08. 01 CPUI D 02078D 7060 | DEFI NI TI ON
| I OA QNAME I OAR610 | D MEDI A DB
| | I N EXT VOL
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

COMMANDS: X - EXI T, HELP, I NFO OR CHOOSE A MENU OPTI ON 17. 00. 29
Table 21 IOA Transfer Control Commands
Command Description
=5 to access the IOA Log screen
=4 to access the IOA Conditions/ Resources screen
=1 to access the IOA Primary Option menu
IOA Features
92 CONTROL-M for OS/390 and z/OS User Guide
The INCONTROL administrator can globally deactivate any or all of the transfer
commands.
Fast Exit from the IOA Online Facility
To exit immediately from the IOA Online facility, type =X on the command line and
press Enter.
In most cases, the =X command has the same effect as pressing END (PF03/PF15) in all
open screens and then entering X (Exit) in the IOA Primary Option menu. Any
window, such as the Exit Option window, that would be displayed when exiting an
open screen is displayed when the =X command is entered.
However, when the =X command is entered while definition screens such as the
Calendar Definition screen are open, changes to the open definition screens are
cancelled. Changes currently in definition facility list screens, for example, changes to
previously closed definition screens, are not cancelled. Those screens and all other
open screens are treated as if END (PF03/PF15) has been entered.
Screen Layout
Most IOA screens are divided into four basic areas. The example used in this section
is the IOA Log screen.

NOTE
The =X command is intentionally not supported on certain screens.
Table 22 Basic IOA Screen Areas (Part 1 of 2)
Screen Area Description
Screen Description
and Message Line
This line at the top of the screen describes the purpose of the
screen (in the example screen, IOA Log). A screen identifier
may appear in the upper right corner (in the example screen,
5). This line is also used to display messages.
Screen Header and
Command Area
This area is used for online commands, and, where applicable,
headings of the screen data.
IOA Features
Chapter 2 Online Facilities 93
Figure 6 IOA Log Screen
Commands and PFKeys
Commands are entered by typing a command in the COMMAND field and then
pressing Enter, or by pressing a predefined PFKey, or a combination of both.
It is not necessary to enter the full command name; the shortest unique abbreviation
of the command is sufficient. If the abbreviation is ambiguous, an appropriate
message is displayed in the message area.
IOA commands are flexible; you can change command syntax or provide aliases
(synonyms) to suit your site. If you want to add or change a command syntax, consult
BMC Software Customer Support. The examples provided in this chapter exhibit the
original command syntax supplied with this INCONTROL product.
Data Area On some screens, the data area can be scrolled. For more
information, see Scrolling Commands on page 96.
Screen Bottom This area of the screen usually contains a list of available
commands or options (In the example screen, SHOW, GROUP,
CATEGORY, and SHPF), or a brief explanation about screen
usage. The current time is displayed in the lower right corner.
FI LTER: - - - - - - - - - - - - - - - - I OA LOG - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( 5)
COMMAND ===> SCROLL===> CRSR
SHOWLI MI T ON ==> DATE 291201 - 010102
DATE TI ME ODATE USERI D CODE - - - - - - M E S S A G E - - - - - - - - - - - - - - - - - - - -
311201 184915 311201 K48 SUB13AI JOB K48RUN1 / OI D=005W9 SUBMI TTER STARTED
PROCESSI NG JOB ON SYSTEM: OS35
311201 184915 311201 K48 SUB133I JOB K48RUN1 K48RUN / 27255 OI D=005W9
SUBMI TTED FROM LI BRARY ( P) K48. LI B. JOB
311201 184918 311201 K48 SPY28GI JOB K48RUN1 K48RUN / 27255 OI D=005W9 TAPE
DRI VE UNI TS USED=00 00
311201 184918 311201 K48 SPY281I JOB K48RUN1 K48RUN / 27255 OI D=005W9 START
01365. 1849 STOP 01365. 1849 CPU 0MI N
00. 05SEC SRB 0MI N 00. 00SEC 0. 00 4AOS35
311201 184918 311201 K48 SPY254I JOB K48RUN1 K48RUN / 27255 OI D=005W9
SCANNED
311201 184918 311201 K48 SEL216WJOB K48RUN1 K48RUN / 27255 OI D=005W9
UNEXPLAI NED COND CODE 0015 STEP EXEC /
311201 184918 311201 K48 SEL214I JOB K48RUN1 K48RUN / 27255 OI D=005W9 RERUN
NEEDED
311201 184918 311201 K48 SEL205I JOB K48RUN1 K48RUN / 27255 OI D=005W9 RERUN
I N PROCESS USI NG MEM K48RUN1
311201 184918 311201 K48 SEL286I JOB K48RUN1 K48RUN / 27255 OI D=005W9
WAI TI NG FOR CONFI RMATI ON
CMDS: SHOW, GROUP, CATEGORY, SHPF 08. 57. 11
Table 22 Basic IOA Screen Areas (Part 2 of 2)
Screen Area Description
IOA Features
94 CONTROL-M for OS/390 and z/OS User Guide
PFKey command assignments can be site-customized. It is possible to assign PFKeys
differently for each screen. To change PFKey command assignments, see your
INCONTROL administrator.
Supplied PFKey definitions are consistent throughout most of the screens. For
example: PF08/PF20 is used to scroll down (forward) on all INCONTROL screens
where scrolling is possible.
To see the PFKey assignment of the screen with which you are working, type
reserved command SHPF in the command line and press Enter. A window describing
the current PFKey assignment appears on the screen. Press Enter again to close the
window.
Table 23 Common PFKey Definitions
PFKey Description
PF01/PF13 HELP
PF02/PF14 SHOW (where applicable)
Note: When the IOA Online facility is activated in ISPF mode
(as an ISPF application), PF02/ PF14 are usually assigned the
ISPF SPLIT command. For more information, see IOA Under
ISPF on page 102.
PF03/PF15 END exit current screen and go back one level
PF04/PF16 RESET (where applicable)
PF05/PF17 FIND (where applicable)
PF06/PF18 =6 transfer to TSO screen/ application or to UTILITIES
screen
Note: Disabled under ROSCOE/ ETSO, CICS, VTAM, IMS/ DC,
IDMS/ DC, COM-PLETE, and TSO cross memory option.
PF07/PF19 UP scroll backward
PF08/PF20 DOWN scroll forward
PF10/PF22 LEFT or PREV (where applicable)
PF11/PF23 RIGHT or NEXT (where applicable)
PF12 RETRIEVE retrieves a sequence of commands and options
entered by the user during the current session. These
commands and options are displayed in reverse order on the
command line of the current screen.
PF24 SHPF
IOA Features
Chapter 2 Online Facilities 95
Figure 7 PFKey Assignment Window
If you type text in the COMMAND field and press a PFKey, the text in the
COMMAND field is treated as a subparameter of the command assigned to the
PFKey.
FI LTER: - - - - - - - - - - - - - - - - I OA LOG - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( 5)
COMMAND ===> SCROLL===> CRSR
SHOWLI MI T ON ==> DATE 291201 - 010102
DATE TI ME ODATE USERI D CODE - - - - - - M E S S A G E - - - - - - - - - - - - - - - - - - - -
311201 184915 311201 K48 SUB13AI JOB K48RUN1 / OI D=005W9 SUBMI TTER STARTED
PROCESSI NG JOB ON SYSTEM: OS35
311201 184915 311201 K48 SUB133I JOB K48RUN1 K48RUN / 27255 OI D=005W9
SUBMI TTED FROM LI BRARY ( P) K48. LI B. JOB
311201 184918 311201 K48 SPY28GI JOB K48RUN1 K48RUN / 27255 OI D=005W9 TAPE
DRI VE UNI TS USED=00 00
311201 184918 311201 K48 SPY281I JOB K48RUN1 K48RUN / 27255 OI D=005W9 START
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| |
| ENTER ENTER PF13 HELP |
| PF01 HELP PF14 SHOW |
| PF02 SHOW PF15 END |
| PF03 END PF16 RESET |
| PF04 RESET PF17 FI ND |
| PF05 FI ND PF18 =6 |
| PF06 =6 PF19 UP |
| PF07 UP PF20 DOWN |
| PF08 DOWN PF24 SHPF |
| PF12 RETRI EVE |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
IOA Features
96 CONTROL-M for OS/390 and z/OS User Guide
Two additional key definitions are:
For information on changing IOA PFKey definitions, see the appendix in the
INCONTROL for OS/390 and z/OS Administrator Guide, which deals with modifying
IOA Online Facility Commands.
Scrolling Commands
Scrolling conventions are very similar to the ISPF conventions of IBM. Two basic
commands are used for scrolling:
The commands can be entered by typing the command in the COMMAND field or by
pressing the predefined PFKey.
The scrolling amount is determined by the content of the SCROLL field in the right
corner of the screen header. Valid scrolling amounts are:
Table 24 Additional Key Assignments
Key Description
PA1 ABORT forced exit
If you press PA1 while in AutoRefresh mode (described on
page 102), AutoRefresh mode is canceled.
PA2 Under native TSO and ROSCOE, the first time you press this
key, the screen is refreshed. The second consecutive time, a
copy of the screen is sent to be printed, or to a file, using a
PRTDBG DD statement. For terminal models supporting PA3,
the PA3 key is defined in exactly the same way as PA2.
When the IOA online facility is activated as an ISPF
application, PA2 is controlled by ISPF, and only refreshes the
screen. To print the screen, see IOA Under ISPF on page 102.
Under other online environments, such as CICS and VTAM,
PA2 serves as a refresh only. Usually one of the PA keys is
assigned a local print function.
Table 25 Scrolling Commands
Command PFKey Description
UP (PF07/PF19) Scroll up (backward)
DOWN (PF08/PF20) Scroll down (forward)
IOA Features
Chapter 2 Online Facilities 97
It is only necessary to type the first letter of the new amount in the SCROLL field in
order to change the scrolling amount.
A scrolling amount other than that shown in the SCROLL field can be used by
entering the amount directly after the scroll command itself, or by entering the scroll
amount in the COMMAND field and pressing the appropriate scrolling PFKey. The
scrolling amount in the SCROLL field remains unchanged.
Example
If PAGE is the value in the SCROLL field, to scroll to the bottom, type M (MAX) in the
COMMAND field and press PF08 (DOWN).
LOCATE Command
The LOCATE command, and its abbreviation, L, can be used to search for items in the
NAME field in all directory type screens that contain scrollable data, such as the
Calendar List screen. The syntax of the command is
where string is the search string. Apostrophes (single quotes) or quotation marks
(double quotes) are not required.
The search proceeds from the top of the list to the first item in the list that starts with
the specified string. The cursor is positioned on the OPTION field at the beginning of
the line containing the string, if found, or on the OPTION field of the alphabetically
closest preceding value if the specified value is not found.
Table 26 Scrolling Amounts in the SCROLL Field
Scrolling Amount Description
PAGE Scroll a full page.
HALF Scroll a half page.
CRSR Scroll by cursor position. If the cursor is outside the data area,
a full page is scrolled.
MAX Scroll maximum available; for example, UP MAX scrolls to the
top.
LOCATE st r i ng
IOA Features
98 CONTROL-M for OS/390 and z/OS User Guide
FIND Command
The FIND command, and its abbreviation, F, can be used in all screens that contain
scrollable data to find and display the next occurrence of a character string. The
syntax of the command is
where:
s string is the search string
Mandatory.
s fromcol is the first column in the search range
Optional.
s tocol is the last column in the search range
Optional.
s PREV is the indicator that the search must move backward, instead of forward,
from the current cursor position
Optional.
General Rules
If the string contains blanks, enclose the string with apostrophes (single quotes) or
quotation marks (double quotes). For example:
The column range searched can be limited by entering fromcol or tocol values, or by
entering both fromcol and tocol values.
The search for the string proceeds from the current cursor position forward, or
backward if PREV is entered. If the string is found, the cursor is positioned at the start
of the string.
To repeat the find, to the next or previous occurrence of the string, press PF05/PF17.
FI ND st r i ng [ f r omcol ] [ t ocol ] [ PREV]
FI ND ' WAI T SCHEDULE'
NOTE
The following situations outline where the FIND command can, or should, be further
modified to enhance its functionality.
IOA Features
Chapter 2 Online Facilities 99
s Some screens enable the user to limit the number of lines searched by a FIND
command. This is discussed in the relevant screen descriptions.
s In some screens, the FIND command does not detect information that is to
the right or left of the information displayed in the monitor. To ensure
detection of the desired string, the screen must be displayed in wraparound
mode, when available, before executing the FIND command.
Text String Searches
The FIND command can also be used to search for text strings, in which case the
command will find all instances of the string, regardless of whether the characters
within the string are lowercase, uppercase, or mixed case. To search for a text string,
include the letter T immediately before a quoted string.
For example,
will find WAIT SCHEDULE, and it will also find wait schedule, and Wait Schedule, and
any other case variant.
Text string searches are the default. If your system default is for text strings, You do
not need to include the T if you perform a text string search. Your INCONTROL
administrator can change the default to character string. In this case you do not need
to include the C if you perform a character string search.
Character String Searches
The FIND command can be used to search for character strings, in which case the
command will find all instances of the string, but only where the string contains
characters that match the case specified. To search for a character string, include the
letter C immediately before a quoted string.
For example,
will find WAIT SCHEDULE, but it will not find wait schedule, or Wait Schedule, or any
other case variant.
CANCEL and RESET Commands
CANCEL and RESET commands are entered in the COMMAND field.
FI ND T' WAI T SCHEDULE'
FI ND C' WAI T SCHEDULE'
IOA Features
100 CONTROL-M for OS/390 and z/OS User Guide
The CANCEL command cancels changes made in a definition screen, such as the IOA
Calendar Definition screen, and exits the screen.
The RESET command (PF04/PF16) cancels Edit environment options specified in a
definition screen. It does not cancel changes already made and it does not exit the
screen or cancel Edit environment mode. For more information about the Edit
environment, see Appendix A, The CONTROL-M Application Program Interface
(CTMAPI).
The RESET command (PF04/PF16) can also be used in most windows, for example, the
Show Screen Filter window, to cancel changes and close the window.
Online Help
The following types of online help are available for INCONTROL screens:
Screen help
Provides information about the entire screen. This help is available on all
INCONTROL screens and is accessed by pressing the HELP key (PF01/PF13) while the
cursor is positioned on the COMMAND field in the screen.
Line-Sensitive Help
Provides information about the fields on a particular line on a screen. This help is
available on several INCONTROL screens. It is accessed by pressing the HELP key
(PF01/PF13) while the cursor is positioned on the desired line of the screen.
If line-sensitive help is not supported in a screen, pressing the HELP key (PF01/PF13)
from anywhere in the screen displays the beginning of the Help panel.
IOA Features
Chapter 2 Online Facilities 101
Figure 8 IOA Help Screen
Help can be scrolled using standard scrolling conventions.
To return to the original screen, use the END command (PF03/PF15).
The Help member name appears on the right in the Help screen header. Members
containing the Help descriptions can be found in the IOA MSG library.
AutoRefresh Mode
Certain INCONTROL screens, as noted in this chapter where appropriate, support
AutoRefresh mode. A screen display in AutoRefresh mode is automatically updated
periodically with the most current data.
AutoRefresh mode can only be activated under native TSO or under ISPF.
AutoRefresh mode is activated by the AUTO command. The format of the command
is
where n is any number of seconds from 1 through 99.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - I OA HELP SCREEN - - - - - - - - - - - - - - - - - - - - - ( CTMHDT2 )
COMMAND ===> SCROLL===> CRSR

Cal endar Li st Scr een
====================

The Cal endar Li st scr een di spl ays a l i st of cal endar s ( member s) i n t he
speci f i ed l i br ar y. Thi s scr een can be ent er ed di r ect l y f r om t he ent r y
panel or upon exi t i ng t he Year Li st scr een.

By def aul t , onl y cal endar names ar e l i st ed i n t he scr een. However , i f
t he def aul t has been modi f i ed at t i me of i nst al l at i on, st at i st i cal
i nf or mat i on i s di spl ayed f or each cal endar name.

Use t he scr ol l i ng PFKeys t o scr ol l f or war d ( PF08/ PF20) and backwar d
( PF07/ PF19) on t he Cal endar Li st .

To r et ur n t o t he ent r y panel , pr ess END ( PF03/ PF15) .


Opt i ons of t he Cal endar Li st Scr een
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
To r equest one of t he f ol l owi ng opt i ons, speci f y t he opt i on i n t he OPT
ENTER END OR PF03/ PF15 TO EXI T THE HELP SCREEN 08. 55. 40
AUTO n
IOA Features
102 CONTROL-M for OS/390 and z/OS User Guide
The screen is updated when the AUTO command is issued, and then periodically
updated according to the interval (in seconds) specified in the AUTO command. A
counter at the top of the screen displays the number of times the screen has been
refreshed.
Example
The AUTO 5 command refreshes the screen every 5 seconds.
Cancelling AutoRefresh Mode
Under native TSO, the recommended method of cancelling AutoRefresh mode is as
follows:
s For short interval values Press Enter. Whenever Enter is pressed, or a command
is issued, AutoRefresh mode is automatically cancelled at the end of the current
interval.
s For long interval values Press Attn (PA1) once.
Under ISPF, press Attn (PA1) or Esc once to cancel AutoRefresh mode.
IOA Under ISPF
The IOA Online facility can be activated as an ISPF application. As such, it can work
in ISPF split screen mode like any other ISPF application.
The command line of the IOA Online facility is controlled by IOA. It is not possible to
enter ISPF commands in an IOA screen. Two ISPF commands must be defined to
PFKeys:
The rest of the PFKeys are controlled by IOA PFKey definitions, which are in the IOA
PARM library.
It is possible to assign TSO/ ISPF commands such as PRINT to PFKeys, or to change
PFKey definitions by performing the following steps:
Table 27 ISPF Commands that must be defined for PFKeys
Command PFkey
SPLIT (usually PF02/PF14)
SWAP (usually PF09/PF21)
IOA Features
Chapter 2 Online Facilities 103
1 Exit from IOA and ISPF to the READY prompt.
2 Type the following command and press Enter:
This command brings you to ISPF.
3 Type the KEYS command and press Enter. A set of key definitions is displayed.
4 Modify the key definitions as desired and exit from ISPF.
Under ISPF, IOA Option 6 activates the Online Utilities panel, which is described
in IOA Online Utilities Menu on page 321. For more information about these
utilities, see the INCONTROL for OS/390 and z/OS Utilities Guide.
For more information on changing IOA PFKey definitions, see the appendix in the
INCONTROL for OS/390 and z/OS Administrator Guide that deals with modifying
IOA Online Facility Commands.
I SPSTART PANEL( I SR@PRI M) NEWAPPL( CTM)
NOTE
ISPF KEY definitions for the following ISPF commands take precedence over IOA
PFKey definitions: SPLIT, SWAP, KEYS, PRINT, PFSHOW. For example, if PF02 is
defined as SPLIT in ISPF, an IOA definition for PF02 is ignored in online screens.
For all other ISPF commands, such as UP or DOWN, the key definitions in ISPF are
ignored and the PFKey is interpreted according to the definition in the IOA Online
facility.
IOA Features
104 CONTROL-M for OS/390 and z/OS User Guide
IOA Editor
The IOA Editor enables you to edit members of a partitioned data set (PDS) using an
editor similar to the ISPF editor. Enter EDMEM in the command line of any screen to
display the Edit Entry Panel window, as shown in Figure 9.
Figure 9 IOA Editor Edit Entry Panel
To create a new member or edit an existing member, fill in the LIBRARY and
MEMBER parameters and press Enter. The IOA Editor screen is opened for editing, as
shown in Figure 10.
- - - - - - - - - - - - - - - - - - - - - I OA PRI MARY OPTI ON MENU - - - - - - - - - - - - - - - - - - ( 1)
OPTI ON ===> USER N06

I OA CONTROL- D/ V CONTROL- O

4 COND/ RES A MI SSI ON STATUS OR RULE DEFI NI TI ON
5 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +I CS
6 | EDI T ENTRY PANEL |
7 | | LOG
8 | LI BRARY ==> | OPTS
I V | | US
| MEMBER ==> | R
| |
| FI LL I N PARAMETERS AND PRESS ENTER TO CONTI NUE OR PF3 TO EXI T|
CONTR| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
2 JOB SCHEDULE DEF BB BALANCI NG STATUS TR RULE DEFI NI TI ON
3 ACTI VE ENV. BM MI SSI ON DEF TP POOL DEFI NI TI ON
C CMEM DEFI NI TI ON BV DB VARI ABLE DEF TV VAULT DEFI NI TI ON
BR RULE DEFI NI TI ON TI I NQ/ UPD MEDI A DB
BA RULE ACTI VI TY TC CHECK I N EXT VOL


COMMANDS: X - EXI T, HELP, I NFO OR CHOOSE A MENU OPTI ON 19. 12. 05
NOTE
If the member already exists in the specified library, the member is displayed for
editing in the IOA Editor. Similarly, if you accessed the IOA Editor screen from line
option J in either screen 2 or screen 3, the member in the library referred to in the
schedule definition member will be displayed for editing.
IOA Features
Chapter 2 Online Facilities 105
Figure 10 IOA Editor
IOA Editor PFKey Functions
While working within the IOA Editor, PFKeys perform the functions shown in
Table 28:
Commands of the IOA Editor Screen
Table 29 describes editing commands that can be executed by entering the command
in the COMMAND line.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - I O A E D I T O R - - - - - - - - - - - - - - - - - - - ( EDMEM)
COMMAND ===> SCROLL===> CRSR
ROW PROD. V610. DEMO( TEST) COL 001 072

. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
* * * * * * * * * * * * * * * * * * * * * * * * B O T T O M O F D A T A * * * * * * * * * * * * * * * * * * * * * * * * * *








OPTI ONS: I I NSERT D DELETE R REPEAT C COPY M MOVE UC/ LC UPPER/ LOWER CASE
Table 28 PFKey Functions Within the IOA Editor Screen
PFKeys Description
PF01/ PF13 Activates online help.
PF02/ PF14 Saves the current member.
PF03/ PF15 Terminates the editing session. If the edited member has been
changed the member will be saved automatically.
PF04/ PF16 Cancels the editing session without saving changes.
PF05/ PF17 Invokes the Find facility.
PF07/ PF19 Scrolls forward.
PF08/ PF20 Scrolls backward.
PF10/ PF22 Scrolls left.
PF11/ PF23 Scrolls right.
IOA Features
106 CONTROL-M for OS/390 and z/OS User Guide
Table 30 describes editing commands that can be executed by entering the command
in the left-most position of the applicable row.
Table 29 IOA Editor Command Line Commands
Command Description
SAVE Saves all new data without terminating the edit session.
CANCEL Terminates the edit session without saving new data.
COPY Enables you to import a member from a specific library.
Table 30 IOA Editor Row Commands (Part 1 of 2)
Command Description
I Inserts a new line below the current line.
To insert more than one line for new data, enter Inn, where nn
indicates the number of new lines to be inserted below the
current line.
D Deletes the current line.
To delete more than one line, enter Dnn, where nn indicates
the number of lines to be deleted below the current line.
You can delete a block of lines by typing DD at the beginning
of the first line of the block, and then entering DD at the
beginning of the last line of the block.
R Repeats the current line.
To repeat a single line one or more times, enter Rnn, where nn
indicates the number of times the current line is to be repeated.
You can repeat a block of lines by typing RR at the beginning
of the first line of the block, and then entering RR at the
beginning of the last line of the block.
C Identifies the source line for a copy operation.
To copy more than a single line, enter Cnn, where nn indicates
the number of lines to be copied.
You can also copy a block of lines by typing CC at the
beginning of the first line of the block, and then entering CC at
the beginning of the last line of the block.
M Identifies the source line for a move operation.
To move more than a single line, enter Mnn, where nn
indicates the number of lines to be moved.
You can also move a block of lines by typing MM at the
beginning of the first line of the block, and then entering MM
at the beginning of the last line of the block.
A Identifies the destination of a copy or move operation.
When a line or block of lines has been selected for copying or
moving, enter A at the point after which the copied lines are to
be inserted.
IOA Features
Chapter 2 Online Facilities 107
IOA SET Command Panel
The IOA SET Command Panel enables you to set and stop TRACE levels, and choose
the language that will be used in online screens. Enter SET in the command line of
any screen to display the SET Command Panel window, as shown in Figure 11.
Figure 11 IOA SET Command Panel
B Identifies the destination of a copy or move operation.
When a line or block of lines has been selected for copying or
moving, enter B at the point before which the moved lines are
to be inserted.
LC Changes text in a line from uppercase to lowercase.
To change text in more than a single line to lowercase, enter
LCnn, where nn indicates the number of lines to be changed to
lowercase.
UC Changes text in a line from lowercase to uppercase.
To change text in more than a single line to uppercase, enter
UCnn, where nn indicates the number of lines to be changed to
uppercase.
- - - - - - - - - - - - - - - - - - - - - I OA PRI MARY OPTI ON MENU - - - - - - - - - - - - - - - - - - ( 1)
OPTI ON ===> USER N06

I OA CONTROL- D/ V CONTROL- O
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
4 | SET Command Panel | I ON
5 | | CS
6 | |
7 | TRACE l evel , ON ( Tr ace l evel 001- 256, ON or OFF) | OG
8 | | PTS
I V | | S
| LANGUAGE ENG - Engl i sh |
| FRA - Fr ench |
| GER - Ger man |
CONTR| JPN - Japanese |
| |
2 | | I ON
3 | FI LL I N PARAMETERS AND PRESS ENTER TO CONTI NUE OR PF3 TO EXI T | I ON
C | | TI ON
| | A DB
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + VOL


COMMANDS: X - EXI T, HELP, I NFO OR CHOOSE A MENU OPTI ON 18. 01. 49
Table 30 IOA Editor Row Commands (Part 2 of 2)
Command Description
IOA Features
108 CONTROL-M for OS/390 and z/OS User Guide
The process of setting TRACE levels and turning off a particular TRACE, and the
process of setting language preferences for online screens and messages, begins in the
SET Command Panel.
Using the SET Command Panel to set and end TRACE Levels
Setting the TRACE level can help you monitor certain IOA Online facility and
INCONTROL functions, such as security checks.
The following steps explain how to set or turn off a TRACE level:
1 Type a TRACE level number, from 1 through 256, in the TRACE level field of the
SET Command Panel.
2 In the (Trace level 1-256, ON or OFF) field, type ON to set a TRACE level, or OFF to
turn off a TRACE level.
3 Press Enter to confirm the setting, in which case the following message is
displayed:
CTMA2AI TRACE LEVEL nnn WAS SET xxx
where
s nnn is the TRACE level number
s xxx indicates whether the TRACE level was set ON or turned OFF
Using the SET Command Panel to set Language Preferences
Setting the LANGUAGE influences the online screens and messages in subsequent
sessions.
The following steps explain how to set language preferences:
1 In the LANGUAGE field, type one of the following sets of characters to select a
language preference:
s ENG, to set English as the preferred language
s FRA, to set French as the preferred language
s GER, to set German as the preferred language
s JPN, to set Japanese as the preferred language
NOTE
TRACE level settings take effect immediately.
IOA Features
Chapter 2 Online Facilities 109
2 Press Enter to confirm the setting, in which case the following message is
displayed:
CTMA27I THE NEW LANGUAGE WILL BE USED FROM THE NEXT LOGON
TO IOA
IOA TSO Command Processor Screen
The IOA TSO Command Processor screen can be entered only when the IOA Online
facility is activated as a TSO application. It cannot be entered when the IOA Online
facility is activated as an ISPF application or activated under a non-TSO environment.
The TSO screen enables activation of any TSO command without exiting the IOA
Online facility. For example, a typical program activated under the TSO screen is
ISPF. Therefore all ISPF/ PDF facilities and functions, such as editing a member or
scanning job output, can be activated while you are working under the IOA Online
facility.
To activate a TSO command, type the command in the COMMAND field and press
Enter.
NOTE
Language preference settings do not take effect until your next logon to the system.
IOA Features
110 CONTROL-M for OS/390 and z/OS User Guide
Figure 12 IOA TSO Command Processor Screen
TSO commands can also be activated directly from any IOA online screen by typing
TSO in the COMMAND field.
Transfer of Control Between the TSO Application and the
IOA Online Facility
You can return to the IOA Online facility from the TSO application by simply exiting
the TSO application in a normal manner. However, this method can be time
consuming and inconvenient if an ISPF application or a similar TSO application is
activated.
If the TSO application can issue a TSO command, it is possible to transfer control to
the IOA Online facility, and vice versa, without exiting the TSO application.
While working under the TSO application, for example, under ISPF, issue the
command:
- - - - - - - - - - - - - - - - - - - - - - - - - - I OA TSO COMMAND PROCESSOR - - - - - - - - - - - - - - - - - - - - - - - ( 6)
COMMAND ===> I SPF





















PLEASE ENTER TSO COMMAND 15. 32. 52
NOTE
CLISTs cannot be activated from the TSO screen. To activate a CLIST, first activate
ISPF and then execute the CLIST under ISPF.
TSO CTMTTRA { n | =n}
Scheduling Definition Facility
Chapter 2 Online Facilities 111
where n is the online screen number.
The requested screen is displayed as it was when you transferred from it.
To return to the TSO application, use the =6 command (PF06/PF18). The application
remains in the same state as when you transferred from it.
It is recommended that you simplify transfer between screens by permanently
assigning one of your PFKeys under ISPF (or SDSF, and so on) to the command TSO
CTMTTRA. Once this key assignment is made, you no longer need to type the full
transfer command. Instead, you merely type the IOA option number or code in the
COMMAND field and press the assigned PFKey. You are transferred to the desired
screen.
Scheduling Definition Facility
The CONTROL-M Scheduling Definition facility enables you to create, view, or
modify job scheduling definitions for the jobs in your environment. A job scheduling
definition consists of parameters that correspond to the decisions and actions of the
operator when handling the scheduling, submission, and post-processing of a job.
The job scheduling definition for a job needs to be defined only once. Once defined,
the definition is saved and used as necessary for managing job processing. Job
scheduling definitions can be modified or deleted as required.
Job scheduling definitions are stored in members called scheduling tables. Any
number of scheduling tables can be defined, and each scheduling table can contain
any number of job scheduling definitions.
In many production environments, related applications are scheduled together as a
group. In these cases, it is common to define all such related applications in a single
scheduling table, and to schedule all the jobs in the table together, as a group.
Scheduling tables (members) are stored in scheduling libraries (partitioned data sets).
You can define any number of scheduling libraries. The number of scheduling tables
in a library, the number of job scheduling definitions in a scheduling table, and the
size of each job scheduling definition, are all calculated dynamically.
NOTE
You must activate ISPF under the IOA Online facility if you want to use the control
transfer feature.
Scheduling Definition Facility
112 CONTROL-M for OS/390 and z/OS User Guide
Accessing the Scheduling Definition Facility
The Scheduling Definition facility contains the following screens:
To enter the Scheduling Definition facility, select option 2 on the IOA Primary Option
menu. The Scheduling Definition Facility entry panel is displayed.
Handling of Job Groups
A group of jobs whose processing (for example, scheduling, submission, and post
processing) is handled as a group, is defined in its own scheduling table, called a
Group scheduling table. This table must be created with G (Group) inserted in the
TYPE field of the Scheduling Definition facility entry panel.
At time of creation of a Group scheduling table, a special scheduling definition, called
a Group Entity, is created. The Group Entity is used to define job processing criteria
for the group as a whole. These include:
NOTE
The CONTROL-M Scheduling Definition facility does not support members that have
been compressed using the ISPF PACK option.
Table 31 Scheduling Definition Facility Screens
Screen Definition
Scheduling Facility
entry panel
Enables specification of parameters that determine which
screen is displayed.
Table List screen Displays the list of tables (members) in the specified
scheduling library.
Job List screen Displays the list of jobs (job scheduling definitions) in the
selected table.
Job Scheduling
Definition screen
(Screen 2)
Displays the parameters of the selected job scheduling
definition or Group Entity. This is the main screen of the
facility.
NOTE
Scheduling tables contain scheduling criteria and other job production parameters.
They do not contain the JCL of the jobs.
Scheduling Definition Facility
Chapter 2 Online Facilities 113
The Group Entity also contains a field (ADJUST CONDITIONS) that enables job
dependencies based on prerequisite conditions to apply only if predecessor jobs in
the group are scheduled.
CONTROL-M internally tracks each job group and the jobs in the group. Each order
of each group of jobs is identified as a unit.
The status of each job group that has been ordered can be viewed using option G
(Group) of the Job Status screen (Active Environment screen).
Table 32 Scheduling Criteria
Criterion Description
Basic Scheduling
Criteria
Any number of sets of basic scheduling criteria can be
specified in the Group Entity. At least one of these sets must be
satisfied before the group, or any job in the group, can be
scheduled.
Each set of basic scheduling criteria in the Group Entity is
assigned a unique name called a Schedule Tag.
These Schedule Tag names can be entered in job scheduling
definitions in the table. When a set of basic scheduling criteria
in the Group Entity is satisfied, job scheduling definitions that
specify the corresponding Schedule Tag are scheduled that
day.
Job scheduling definitions can also contain their own basic
scheduling criteria, and be scheduled according to those
criteria, provided that the group itself can be scheduled.
Runtime
Scheduling Criteria
Before any job in a group can be considered for submission, all
group runtime scheduling criteria specified in the Group
Entity must be satisfied. Once these are satisfied, a job is
submitted only if its own specified runtime scheduling criteria
are satisfied.
Post-processing
Actions
Post-processing actions can be defined for the group, in the
Group Entity. These are performed once the group has
finished processing (that is, all jobs in the group have
terminated).
These actions can be made conditional upon whether all
submitted jobs in the Group scheduling table ended OK, or
whether at least one job did not end OK.
Scheduling Definition Facility
114 CONTROL-M for OS/390 and z/OS User Guide
Creating Tables
Tables can be created in any of the following ways:
s by typing the new table name in the entry panel and pressing Enter
The name of a new job scheduling definition for the new table can also be entered.
s by using the SELECT command to choose the new table name in the Table List
screen and pressing Enter
The SELECT command is described in The SELECT Command on page 123.
Upon entering the create table request using either of the above methods, a skeletal
job scheduling definition (that is, one with most fields not filled in) is displayed in the
Job Scheduling Definition screen.
Fill in and save this job scheduling definition. The table is created and the job
scheduling definition is the first and only job scheduling definition in the Job list of
the table. As additional job scheduling definitions are created in the table (described
below), they are added to the Job list.
NOTE
When the IN conditions of a Group entity are satisfied (for example, they have been
added to the IOA Conditions file), the jobs in the group begin execution, assuming
that their other runtime criteria are satisfied.
By default, if jobs in a group have already begun execution and an IN condition for
the job group is deleted from the IOA Conditions file, this change does not affect the
processing of the jobs in the group; the jobs continue execution as if all the IN
conditions were still satisfied. This default is overridden if the GRPRECHK
parameter in the CTMPARM member in the IOA PARM library is set to Yes, in which
case IN conditions in the Group entity are checked before each job is selected.
NOTE
Upon exiting the Job List screen, if changes were made in at least one job scheduling
definition, an Exit Option window is displayed. One field of the window displays the
table name. This value can be changed to a new table name. This creates a new table
in which the job scheduling definitions are saved.
Under ISPF, tables can also be created using the M5 online utility. This method is
described in M5: Quick Schedule Definition on page 361, and is not included in this
discussion.
Scheduling Definition Facility
Chapter 2 Online Facilities 115
Creating Job Scheduling Definitions
Job scheduling definitions can be created using two basic methods:
s A skeletal job scheduling definition can be created by typing the name of a new job
scheduling definition in the entry panel. The table specified in the entry panel can
be either a new or an existing table. In this case, virtually all fields of the job
scheduling definition are empty.
s A copy of an existing job scheduling definition can be created using the INSERT
option in the Job List screen, described in Options of the Job List Screen. In this
case, most fields of the new job scheduling definition have the same values as the
fields in the copied job scheduling definition.
Performing Operations on Tables and Jobs
Many operations can be performed on tables and on the job scheduling definitions in
them. These operations are performed through commands and options in the various
screens of the Scheduling Definition facility.
Some of the major operations possible within the facility are described in the
following pages. Options and commands that have not yet been explained are
explained in detail following the summary.
Accessing (Editing or Browsing) a Table and its Jobs
A table (that is, the job scheduling definitions in the table) can be browsed or edited.
When browsed, the table cannot be modified or updated. When the table is edited,
new job scheduling definitions can be added and existing job scheduling definitions
can be modified or deleted.
Browsing, however, has advantages:
s Access and exit are quicker than in editing.
s Job lists and job scheduling definitions that are in use by another user can be
viewed.
NOTE
Under ISPF, job scheduling definitions can also be created using the M5 online utility.
This method is described in M5: Quick Schedule Definition on page 361, and is not
included in this discussion.
Scheduling Definition Facility
116 CONTROL-M for OS/390 and z/OS User Guide
s Access for browsing might be granted, even though access for editing might be
denied due to site security requirements.
To browse a table (and its job list and job scheduling definitions) use the BROWSE
option in the Table List screen.
Entering the table name in the entry panel or using the SELECT option in the Table
List screen provides edit access.
Depending on user profile definitions, if the table requested for editing is in use,
either access is granted in Browse mode or access is not granted.
Accessing the JCL of a Job
When IOA is activated under ISPF, the member containing the JCL of a job can be
accessed by the JCL command in the Job List screen. Whether the member can be
modified and updated depends on whether the Job List screen was accessed in
Browse or Edit mode.
Copying a Job to Another Table
Jobs can be copied from one table to another by the COPY option in the Job List
screen. For more information, see Options of the Job List Screen on page 368.
Deleting a Table or a Job
Unneeded jobs can be deleted using the DELETE option in the Job List screen. For
more information, see Options of the Job List Screen on page 368. Unneeded tables
can be deleted by the DELETE option in the Table List screen. For more information,
see Deleting Tables on page 158.
Displaying Jobflow in Graphic Format
The job flow of jobs in a table can be displayed in graphic format by the GRAPHIC
FLOW option in the Table List screen. For more information, see Displaying Graphic
Jobflow on page 159.
Displaying Job Statistics
The statistics for a job can be displayed by performing any of the following:
s Typing S (STAT) next to the job name in the Active Environment screen.
s Typing T (JOBSTAT) next to the job name in the Job List screen.
s Typing the primary command JOBSTAT in the Job Scheduling Definition screen
(or the Active Environment screen).
Scheduling Definition Facility
Chapter 2 Online Facilities 117
Manually Scheduling Jobs
Manually ordering a job results in the job being scheduled only if its basic scheduling
criteria are satisfied. Manually forcing a job results in its being scheduled even if its
basic scheduling criteria are not satisfied.
s To manually order all the jobs in a table, type ORDER for the table in the Table List
screen. Multiple tables can be ordered.
s To manually force all the jobs in a table, type FORCE for the table in the Table List
screen. Multiple tables can be forced.
s To manually order specific jobs in a table, type ORDER for the jobs in the Job List
screen.
s To manually force specific jobs in a table, type FORCE for the jobs in the Job List
screen.
For more information, see Ordering (Scheduling) Jobs on page 151.
Displaying the Schedule Plan of a Job
The schedule of a job for a specified period of time, based on the basic scheduling
criteria of the job, can be displayed in calendar format by PLAN option in the Job List
screen. For more information, see Displaying a Job Scheduling Plan on page 162.
Saving Modifications
All changes made to a table and its job scheduling definitions are kept in memory
until the table is exited. Upon exiting the table, you can choose to save or cancel the
changes. For more information, see Exiting the Scheduling Definition Facility on
page 149.
Scheduling Definition Facility
118 CONTROL-M for OS/390 and z/OS User Guide
Entry Panel
The entry panel is displayed upon entering the Scheduling Definition facility (Option
2 in the IOA Primary Option menu).
Figure 13 CONTROL-M Scheduling Definition Facility - Entry Panel
To open the desired display, fill in Entry Panel fields LIBRARY, TABLE, and JOB as
described below. Type J (scheduling table for individual jobs) or G (scheduling table
for jobs handled as a group) for TYPE OF TABLE if you are creating a new scheduling
table. If you are not creating a new table, the TYPE OF TABLE field is ignored and all
types of tables are displayed.
Type Y (Yes) or N (No) in the SHOW JOB DOCUMENTATION field to determine
whether job documentation lines appear when the Job Scheduling Definition screen is
displayed. Type Y (Yes) or N (No) in the AUTO-SAVE DOCUMENTATION field to
determine whether changes made to documentation are automatically saved when
updating the job scheduling definition.
s To display the list of tables in a library, do the following:
1. Type the library name.
2. Either leave the table name blank, or type part of a table name together with
mask characters (* and ?).
3. Press Enter.
s To display the list of jobs of a specific table, do the following:
- - - - - - - - - - - CONTROL- M SCHEDULI NG DEFI NI TI ON FACI LI TY - ENTRY PANEL - - - - - - - - - ( 2)
COMMAND ===>



SPECI FY LI BRARY, SCHEDULI NG TABLE, JOB

LI BRARY ===> CTM. PROD. SCHEDULE
TABLE ===> ( Bl ank f or t abl e sel ect i on l i st )
JOB ===> ( Bl ank f or j ob sel ect i on l i st )

TYPE OF TABLE ===> ( J Job - def aul t
G Gr oup - f or new t abl es onl y)



SHOWJOB DOCUMENTATI ON ===> N ( Y/ N)
AUTO- SAVE DOCUMENTATI ON ===> N ( Y/ N)



USE THE COMMAND SHPF TO SEE PFK ASSI GNMENT 23. 00. 04
Scheduling Definition Facility
Chapter 2 Online Facilities 119
1. Type the library name.
2. Type the table name.
3. Press Enter.
If the table does not exist, the screen for defining a new job in the table is displayed.
s To display the details of a specific job (Job Scheduling Definition screen), do the
following:
1. Type the library name.
2. Type the table name.
3. Type the job name.
4. Press Enter.
If the table does not exist, or the job for the specified table does not exist, the screen
for defining a new job in the table is displayed.
s To display the Search Window (described below), do the following:
1. Type the library name.
2. Type the job name.
3. Either leave the table name blank, or type part of a table name together with
mask characters (* and ?).
4. Press Enter.
s To create a new table, do the following:
1. Type a new table name.
2. Type the table type.
3. Press Enter.
NOTE
If you enter the screen for defining a new job and want to leave the screen without
defining a job, use the CANCEL command.
Scheduling Definition Facility
120 CONTROL-M for OS/390 and z/OS User Guide
The Job Scheduling Definition screen, for defining the first job in the new table, is
displayed.
Search Window
The Search window enables you to search for the specified job in tables in the
specified library. Tables in which the job has been found are then displayed in the
Table List screen.
Figure 14 CONTROL-M Scheduling Definition Facility - Entry Panel Search Window
To close the Search Window without performing any action, press END (PF03/PF15).
To perform a search, select one of the following choices and press Enter:
Searches all tables in the specified library.
The search continues uninterrupted unless and until you select Option 1 (Stop Search
Immediately).
- - - - - - - - - - - CONTROL- M SCHEDULI NG DEFI NI TI ON FACI LI TY - ENTRY PANEL - - - - - - - - ( 2)
COMMAND ===>



SPECI FY LI BRARY, SCHEDULI NG TABLE, JOB

LI BRARY ===> CTM. PROD. SCHEDULE
TABLE ===> ( Bl ank f or t abl e sel ect i on l i st )
JOB ===> CTMCLRES ( Bl ank f or j ob sel ect i on l i st )
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
TYPE OF TABLE ===> | |
| PLEASE SELECT ONE OF THE FOLLOWI NG: |
| |
| 1 - STOP SEARCH I MMEDI ATELY |
| 2 - ASK AGAI N AFTER 000010 TABLES |
SHOWJOB DOCUMENTATI ON ===> N| 3 - UNCONDI TI ONAL SEARCH |
AUTO- SAVE DOCUMENTATI ON ===> N| |
| NUMBER OF TABLES I N LI BRARY: 000015 |
| NUMBER OF SEARCHED TABLES: 000000 |
| NUMBER OF SELECTED TABLES: 000000 |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
USE THE COMMAND SHPF TO SEE PFK ASSI GNMENT 12. 11. 54
3 UNCONDI TI ONAL SEARCH
2 ASK AGAI N AFTER number TABLES
Scheduling Definition Facility
Chapter 2 Online Facilities 121
Searches the specified number of tables in the specified library, and then pauses. The
search number can be modified. Default: 10.
s Continue the search by pressing Enter.
s Stop the search by selecting option 1 (Stop Search Immediately).
If any tables are found, the Table List is displayed listing those tables.
During the search, the following information is displayed at the bottom of the
window:
s Number of tables in library. Lists the total number of tables in the specified library.
s Number of searched tables. Lists the cumulative number of tables searched. For
example, if you perform three searches with a specified number of 10, the figure
displayed is 30.
s Number of selected tables. Lists the cumulative number of tables selected that
contain the job being searched.
If any tables are selected during the search, the Table List is displayed listing those
tables. If no tables are selected, the Search Window is closed and a message is
displayed.
Table List screen
The Table List screen displays a list of scheduling tables (members) in the specified
library. This screen can be entered directly from the entry panel or upon exiting the
Job List screen.
By default, only table names are listed in the screen. However, if the default has been
modified at time of installation, statistical information is displayed for each table
name, as shown in the following screen example.
Scheduling Definition Facility
122 CONTROL-M for OS/390 and z/OS User Guide
Figure 15 CONTROL-M Scheduling Definition Facility Table List Screen
s To scroll down the Table list, press PF08/PF20. To scroll up the Table list, press
PF07/PF19.
s To return to the entry panel, press END (PF03/PF15).
Options of the Table List Screen
To request one of the following options, type the option in the OPT field to the left of
the table names and press Enter.
LI ST OF TABLES I N CTM. PROD. SCHEDULE - - - - - - - - - - - - - ( 2)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - - VV. MM CREATED CHANGED SI ZE I NI T MOD I D
ADABAS 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 70 70 0 O01
APPLNTN 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 180 180 0 O01
APPLPRDI 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 41 41 0 O01
ARCNI GHT 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 5 5 0 S07
ASMBTR1 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 9 9 0 S07
ASMBTR2 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 14 14 0 S07
BACKUP 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 5 5 0 S07
CI CSJOBS 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 70 70 0 O01
CI CSPROD 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 180 180 0 O01
CI CSTEST 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 41 41 0 O01
CI CSUPT 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 5 5 0 S07
CLI ENTS 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 9 9 0 S07
DB2EXE 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 14 14 0 S07
DLOAD 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 5 5 0 S07
MAI NDAY 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 180 180 0 O01
MAI NT 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 41 41 0 O01
MAI NTPL 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 5 5 0 S07
ONSPOOL 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 9 9 0 S07
ONSPOOLT 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 14 14 0 S07
OPERCLN 01. 00 01/ 02/ 14 01/ 06/ 12 00: 50 5 5 0 S07
OPTI ONS S SELECT O ORDER F FORCE G GRAPHI C FLOW B BROWSE D DELETE 15. 38. 37
Table 33 Options of the Table List Screen (Part 1 of 2)
Option Description
S (SELECT) Display the list of jobs in the table for any purpose, including
editing and modification. Only one table can be selected at a
time.
B (BROWSE) Display a list of jobs in a table for browsing. Only one table can
be browsed at a time.
O (ORDER) Order all the jobs in the table, provided that their basic
scheduling criteria, as described in Basic Scheduling
Parameters on page 132, are satisfied. Multiple tables can be
ordered.
Scheduling Definition Facility
Chapter 2 Online Facilities 123
Commands of the Table List Screen
The following command can be entered in the COMMAND field of the Table List
screen.
The SELECT Command
The SELECT command can be used to create a new table in the library. The format of
the command is:
Valid types are:
s GRP For Group scheduling tables.
s JOB For regular scheduling tables.
If no type is entered, the default type is JOB.
F (FORCE) Order all the jobs in the table, regardless of their basic
scheduling parameters, which are described in Basic
Scheduling Parameters on page 132. Multiple tables can be
forced.
G (GRAPHIC)
FLOW
Display a graphic presentation of the job flow of the jobs in the
table, as described in Displaying Graphic Jobflow on
page 159. Only one table at a time can be selected for graphic
display.
D (DELETE) Delete the table (member) from the library. Multiple tables can
be deleted, as described in Deleting Tables on page 158.
NOTE
If your access to options has been limited by the INCONTROL administrator, you can
only access the BROWSE option.
SELECT t abl ename t ype
NOTE
If the SELECT command is entered for an existing table, it acts like the S (SELECT)
line option, which is described in Table 33, and displays the list of jobs in the table.
Table 33 Options of the Table List Screen (Part 2 of 2)
Option Description
Scheduling Definition Facility
124 CONTROL-M for OS/390 and z/OS User Guide
If there are no jobs currently in the table, that is, the command is being used to create
a new table, the Job List screen is not displayed. Instead
s A skeletal job scheduling definition is displayed in the Job Scheduling Definition
screen if a Job scheduling table is being created.
s A skeletal Group Entity scheduling definition is displayed in the Scheduling
Definition screen if a Group scheduling table is being created.
Job List Screen
The Job List screen displays the list of jobs in a scheduling table in a specified library.
This screen can be entered directly from the entry panel or the Table List screen, or
upon exiting from the Job Scheduling Definition screen.
NOTE
The names displayed on the Job List screen are the names of the members that contain
the JCL of the jobs, which is specified in the MEMNAME parameter in the job
scheduling definition, or, in the case of started tasks, the name of the STC.
If the S (Select) option was entered in the Table List screen for a table that is currently
in use (selected) by another user, either the Job List screen is not displayed and the
Table List screen remains displayed (the default), or the Job List screen is displayed in
Browse mode (if a user profile definition overrides the default). In either case, an
appropriate message is displayed.
Scheduling Definition Facility
Chapter 2 Online Facilities 125
Figure 16 CONTROL-M Scheduling Definition Facility Job List Screen
Format of the Job List Screen
Next to each job name in the Job list, certain information can be displayed. The type
and format of this information depends on whether the screen is displayed in DESC
format, in DATA format or in STAT format, and whether the list is displayed for a
Group scheduling table, as follows:
s In DESC format, the description of the job, taken from the DESC field of the job
scheduling definition, is displayed. Default.
s In DATA format, the application and group names of the job, taken from the APPL
and GROUP fields of the job scheduling definition, are displayed.
s In STAT format, ISPF-like statistical information about the job is displayed.
s If the job list is displayed for a Group scheduling table, the type of job scheduling
definition is also displayed in the DESC, DATA, and STAT formats. Type
information is not displayed for regular scheduling tables. Valid values are:
G Group Entity; this is always the first entry in the Job list
J Job
By default, the job list is displayed in DESC format. To change formats, use the DESC,
DATA or STAT commands, described below.
JOB LI ST LI B: CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - TYP - - - DESCRI PTI ON - - - - - GROUP: GRPWK1 - - - - - - - - - - - - - - - - - - - - - -
STARTBKP G START OF DAI LY BACKUP
BACKPL01 J DAI LY BACKUP OF DATA SETS FROM APPL- L
BACKPL02 J DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
BACKPLW1 J WEEKLY BACKUP OF FI LES FROM APPL- L #1
BACKPLW2 J WEEKLY BACKUP OF FI LES FROM APPL- L #2
BACKPLW3 J WEEKLY BACKUP OF FI LES FROM APPL- L #3
BACKPLW4 J WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- L +
DASDRPT1 J DASD REPORTS AFTER BACKUPS FOR APPL- L
DASDRPT2 J DASD STATI STI CS REPORT AFTER BACKUP FOR APPL- L
ENDPLBKP J END OF BACKUP I NDI CATI ON FOR APPL- L
BACKAC01 J DAI LY BACKUP OF DATA SETS FROM APPL- ACCOUNT
BACKAC02 J DAI LY BACKUP OF SPECI AL FI LES FROM APPL- ACCOUNT
BACKACW1 J WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #1
BACKACW2 J WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #2
BACKACW3 J WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #3
BACKACW4 J WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- ACC +
DASDRPT3 J DASD REPORTS AFTER BACKUPS FOR APPL- ACCOUNT
DASDRPT4 J DASD REPORTS AFTER BACKUP FOR APPL- ACCOUNT
ENDACBKP J END OF BACKUP I NDI CATI ON FOR APPL- ACCOUNT
BACKDD01 J DAI LY BACKUP OF DATA SETS FROM APPL- DD
OPTI ONS S SEL D DEL I I NS O ORDER F FORCE J JCL C COPY P PLN T JOBSTAT 15. 37. 39
Scheduling Definition Facility
126 CONTROL-M for OS/390 and z/OS User Guide
The order in which the jobs are displayed in the Job List screen can be sorted by the
SORT command (described below).
Commands of the Job List Screen
The following commands can be entered in the COMMAND field of the Job List
screen:
Options of the Job List Screen
To request one of the following options, type the option in the OPT field to the left of
the job name and press Enter.
Table 34 Commands of the Job List Screen
Command Description
DESC Command DESC displays the job description next to the job
name. The description is taken from the DESC field in the job
scheduling definition.
DATA Command DATA displays the Application name and Group
name of the job next to the job name. The Application name
and Group name are taken from the corresponding fields in
the job scheduling definition.
STAT Command STAT displays (next to the job name) the following
ISPF-like statistical information about the job: version and
modification numbers, creation date, last modification date,
and user ID.
SORT Command SORT sorts the list of jobs in the Job List screen
according to specified criteria. Format of the command is:
SORT key
Where key is one of the following values:
s J (Job) Sorted according to job name.
s G (Group) Sorted according to group name.
s A (Application) Sorted according to application name.
Scheduling Definition Facility
Chapter 2 Online Facilities 127
NOTE
Option O (Order) is not available if the Job List screen is displayed for a Group scheduling
table.
Options D (Delete), I (Insert) and J (JCL) are not available for Group Entities.
If the Job List screen is displayed in Browse mode, options D (Delete) and I (Insert)
are not available.
Table 35 Options of the Job List Screen (Part 1 of 2)
Option Description
S (SEL) Display the Job Scheduling Definition screen, with details of
the selected job. Only one job can be selected at a time.
If the Job List screen is not displayed in Browse mode, the job
scheduling definition can be edited and updated. If the Job List
screen is displayed in Browse mode, the job scheduling
definition can only be browsed; it cannot be modified.
D (DEL) Delete a job from the Job list (member). Multiple jobs can be
selected.
I (INS) Insert a new job in the list (member). The Job Scheduling
Definition screen appears, with the same details of the job
marked I, but the MEMNAME and DESCRIPTION
parameters are empty for you to fill in. The new job is added
after the job marked I. Only one new job can be inserted at a
time.
O (ORDER) Order a job provided that its basic scheduling criteria, as
described in Basic Scheduling Parameters on page 132, are
satisfied. Multiple jobs can be selected.
F (FORCE) Force a job order regardless of the basic scheduling criteria of
the job, as described in Basic Scheduling Parameters on
page 132. Multiple jobs can be selected.
Scheduling Definition Facility
128 CONTROL-M for OS/390 and z/OS User Guide
Job Scheduling Definition Screen Defining Schedules
The CONTROL-M Job Scheduling Definition screen is used to define, display and
modify production parameters of a specific job. This screen can be entered directly
from the entry panel or from the Job List screen. Update of parameters is not
permitted in Browse mode.
J (JCL) Edit the member that contains the JCL of the job. Entering this
option brings you directly into the JCL member in ISPF Edit
mode. By default, if the JCL member exists in the OVERLIB
library, that member is edited. If the JCL member does not
exist in the OVERLIB library, the member is edited in the
MEMLIB library. You can only edit the JCL of one job.
For more information on the OVERLIB and MEMLIB libraries,
see OVERLIB: General Job Parameter on page 563 and
MEMLIB: General Job Parameter on page 519.
In ISPF Edit mode, if the name in the MEMNAME parameter
contains a mask character (for example, if it is a generic name
such as PRODJOB*), using the J option displays all PDS
members in the library with names that match the mask.
C (COPY) Copy the job to another table. Multiple jobs can be selected.
For more information, see Copying Jobs to Another Table on
page 157.
PLN Display a schedule plan for the job. You can only display the
schedule plan of one job. For more information, see
Displaying a Job Scheduling Plan on page 162.
JOBSTAT Displays the statistics for the job in the CONTROL-M Statistics
screen, described in Statistics Screen on page 233.
NOTE
The format of the Job Scheduling Definition screen for Group Entities is slightly
different than the format shown below and is described in Scheduling Definition for
Group Entities on page 140.
Table 35 Options of the Job List Screen (Part 2 of 2)
Option Description
Scheduling Definition Facility
Chapter 2 Online Facilities 129
Figure 17 Job Scheduling Definition Screen
The job scheduling definition occupies more than one screen.
JOB: BACKPL02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME BACKPL02 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG
RELATI ONSHI P ( AND/ OR) O
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- BACKUP ODAT
CONTROL
RESOURCE I NI T 0001 CART 0001
PI PE CTM. PROD. PI PE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT BAKCKPL02- ENDED- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 27. 41
NOTE
The SCHEDULE TAG and RELATIONSHIP parameters appear only in job
scheduling definitions belonging to Group scheduling tables.
The PIPE parameter is displayed only if MAINVIEW Batch Optimizer (MVBO) is
installed.
RETENTION parameters # OF DAYS TO KEEP and # OF GENERATIONS TO KEEP
are displayed only at sites that use the History Jobs file.
Scheduling Definition Facility
130 CONTROL-M for OS/390 and z/OS User Guide
To delete a parameter on the screen, simply erase it with the EOF key or blank it out.
If additional action is required, CONTROL-M issues appropriate instructions.
Parameters of the Job Scheduling Definition Screen
The Job Scheduling Definition screen is divided into the following sections.
These sections are divided by a delimiter line.
A brief description of all parameters in each section of the Job Scheduling Definition
screen is provided on the following pages. A detailed explanation of these parameters
is provided in Chapter 3, Job Production Parameters.
Table 36 Parameters of the Job Scheduling Definition Screen
Parameter Description
General Job
Parameters
In this section, you can enter specific information about the job
itself in which member and library the JCL is found, who is
the owner of the job, and so on.
Basic Scheduling
Parameters
In this section, you can enter scheduling criteria (for example,
the days of the week or month on which the job must be
submitted).
Runtime
Scheduling
Parameters
In this section, you can enter submission criteria including
conditions that must be fulfilled (generally, successful
completion of a preceding job) before submission of the job,
resources required by the job, and time limitations on job
submission.
Post-Processing
Parameters
In this section, you can enter fixed or conditional actions to
perform upon job completion, or upon the execution of
specified job steps. For example, you can set conditions that
trigger the submission of other jobs, you can send messages to
the operator console, or you can rerun the job.
NOTE
Parameters marked with the symbol M can have multiple occurrences. Whenever you
fill in the last occurrence of the parameter on the screen, CONTROL-M adds a new
empty occurrence of the parameter that you may fill in. The only limit to the number
of occurrences is the region size available for the application.
Scheduling Definition Facility
Chapter 2 Online Facilities 131
General Job Parameters
Figure 18 General Job Parameters
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME BACKPL02 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC
============================================================================
Table 37 General Job Parameters (Part 1 of 2)
Parameter Description
MEMNAME Name of the member that contains the JCL of the job, or name
of the started task.
MEMLIB Name of the library that contains either the JCL of the job or
identifying information and parameters of the started task.
OWNER ID of a user who requests CONTROL-M services. This field is
used for security purposes.
TASKTYPE Type of task to be performed by CONTROL-M (for example,
job JOB, started task STC).
Restart
PREVENT-NCT2
Indicator (Y/ N/ F/ L) specifying whether (and how) to
perform data set cleanup prior to the original job submission.
The subparameter DFLT is a protected field that indicates the
PREVENT-NCT2 default value at this site.
APPL Name of the application to which the group of the job belongs.
GROUP Name of the group to which the job belongs, such as
BACKUPS, RESERVATIONS, INVENTORY, and so on.
DESC Description of the job (free text) that is displayed next to the
job name in the Job List screen.
OVERLIB Name of a library that overrides the library specified in
MEMLIB.
SCHENV Name of the workload management scheduling environment
to be associated with the job.
SYSTEM ID 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.
Scheduling Definition Facility
132 CONTROL-M for OS/390 and z/OS User Guide
Basic Scheduling Parameters
Figure 19 Basic Scheduling Parameters - Job
Figure 20 Basic Scheduling Parameters - Group Entity
NJE NODE Identifies the node in the JES system at which the job must
execute.
SET VARM Statement assigning a value to an AutoEdit variable, which
can be used in the submitted job.
CTB STEP CONTROL-M/ Analyzer definition to be activated as the first
or last (as entered) step of the job. The type of
CONTROL-M/ Analyzer definition (rule or mission) and its
name are also entered.
DOCMEM Name of a member in which the job documentation resides.
DOCLIB Name of the library in which the job documentation member
resides.
===============================================================================
SCHEDULE TAG
RELATI ONSHI P ( AND/ OR) O
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===============================================================================
SCHEDULE TAG
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL WORKDAYS SHI FT RETRO N MAXWAI T 04
SCHEDULE TAG ACTI VE FROM UNTI L
Table 38 Basic Scheduling Parameters (Part 1 of 4)
Parameter Description
The following parameters apply only when defining a Group Entity. For more
information on how these parameters are applied to jobs in Group Tables, see
Chapter 3, Job Production Parameters.
SCHEDULE TAGM Tags identifying the sets of scheduling criteria defined in the
Group Entity that can be used to schedule the job.
Table 37 General Job Parameters (Part 2 of 2)
Parameter Description
Scheduling Definition Facility
Chapter 2 Online Facilities 133
RELATIONSHIP And/ Or indicator that determines whether or not the criteria
of the specified schedule tag and the basic scheduling criteria
of the individual job must both be satisfied.
The following parameters are used when defining both Group Entities and
individual jobs. For more information on how these parameters are applied to jobs
in Group Tables, see Chapter 3, Job Production Parameters.
DAYS Days of the month to schedule the job. A maximum of two
lines can be entered. Subparameters are:
s DCAL identifies a DAYS calendar containing predefined
scheduling dates
s AND/ OR conjunctional subparameter used to link the
DAYS and WDAYS parameters when both are scheduled
WDAYS Days of the week to schedule the job. A maximum of two lines
can be entered.
The WCAL subparameter identifies a calendar containing
working days on which a job can be scheduled.
MONTHS Months to run the job.
DATES Specific dates in the year to run the job.
CONFCAL Name of a calendar used to confirm job scheduling dates.
The optional subparameter SHIFT indicates when and if a job
must be scheduled.
RETRO Yes or No (Y/ N) indicator specifying whether the job is to be
scheduled (retroactively) after the original scheduling date has
passed.
MAXWAIT Number of extra days within which to try to execute a job in
the Active Jobs file if the date of the job has passed.
D-CAT Name of a CONTROL-D report decollating mission category.
If specified, the report decollating mission is scheduled
whenever the job is scheduled under CONTROL-M.
MINIMUM Minimum number of free tracks required by the library
specified in the PDS parameter . The job is executed if the
number of free tracks is less than the minimum.
PDS Name of a partitioned data set to be checked for free space. If
the PDS has less than the minimum number of required free
tracks, as specified in the MINIMUM parameter , the job is
executed. Not supported for PDSE-type libraries.
Table 38 Basic Scheduling Parameters (Part 2 of 4)
Parameter Description
Scheduling Definition Facility
134 CONTROL-M for OS/390 and z/OS User Guide
The following parameters apply only when defining individual jobs. For more
information on these parameters, see Chapter 3, Job Production Parameters.
DEFINITION
ACTIVE FROM
When a date is entered in this field within a job scheduling
definition, the job will only be ordered if the current date is
later than that date. Valid values are:
s Date in the format ddmmyy, or mmddyy, or yymmdd,
depending on your site format, as set by the DATETYP
parameter in the IOAPARM member in the IOA PARM
library.
s (Blank)
DEFINITION
ACTIVE UNTIL
When a date is entered in this field within a job scheduling
definition, the job will only be ordered if the current date is
earlier than that date. Valid values are:
s Date in the format ddmmyy, or mmddyy, or yymmdd,
depending on your site format, as set by the DATETYP
parameter in the IOAPARM member in the IOA PARM
library.
s (Blank)
The following parameters apply only when defining a Group Entity. For more
information on how these parameters are applied to jobs in Group Tables, see
Chapter 3, Job Production Parameters.
SCHEDULE TAG
ACTIVE FROM
When a date is entered in this field within a Group scheduling
definition, a job which refers to this Schedule Tag will only be
ordered if the current date is later than that date. Valid values
are:
s Date in the format ddmmyy, or mmddyy, or yymmdd,
depending on your site format, as set by the DATETYP
parameter in the IOAPARM member in the IOA PARM
library.
s (Blank)
Table 38 Basic Scheduling Parameters (Part 3 of 4)
Parameter Description
Scheduling Definition Facility
Chapter 2 Online Facilities 135
Runtime Scheduling Parameters
Figure 21 Runtime Scheduling Parameters
SCHEDULE TAG
ACTIVE UNTIL
When a date is entered in this field within a Group scheduling
definition, a job which refers to this Schedule Tag will only be
ordered if the current date is earlier than that date. Valid
values are:
s Date in the format ddmmyy, or mmddyy, or yymmdd,
depending on your site format, as set by the DATETYP
parameter in the IOAPARM member in the IOA PARM
library.
s (Blank)
===========================================================================
I N START- DAI LY- BACKUP ODAT
CONTROL
RESOURCE I NI T 0001 CART
PI PE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
Table 39 Runtime Scheduling Parameters (Part 1 of 2)
Parameter Description
INM Prerequisite conditions for the job.
CONTROLM Shared or exclusive control over resources required for the job.
RESOURCEM Quantitative resources required for the job.
PIPE Name of a data set replaced by a pipe during the run of the
job. Available only at sites in which MAINVIEW Batch
Optimizer (MVBO) is installed.
TIME Time limit (from, until) for job submission.
TIME ZONE Enables automatic adjustment of the times specified in the job
definition to the corresponding times in a different time zone.
PRIORITY Job priority in receiving CONTROL-M services or critical path
priority.
DUE OUT Time by which the job must finish executing.
Table 38 Basic Scheduling Parameters (Part 4 of 4)
Parameter Description
Scheduling Definition Facility
136 CONTROL-M for OS/390 and z/OS User Guide
Post-Processing Parameters
Figure 22 Post-Processing Parameters
SAC Enables scheduled runs of a job that was converted from
another job scheduling product, such as CA-7, to be shifted to
their proper scheduling days.
CONFIRM Yes or No indicator (Y/ N) specifying whether manual
confirmation is required before the job can be submitted.
===========================================================================
OUT BAKCKPL02- ENDED- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES C0008 U0048 A/ O
DO
Table 40 Post-Processing Parameters (Part 1 of 2)
Parameter Description
OUT
M
Prerequisite conditions to be added and/ or deleted when the
job finishes OK.
Restart
AUTO-ARCHIVE
Yes or No indicator (Y/ N) specifying whether to automatically
archive SYSDATA. Subparameters are:
SYSDB Yes or No indicator specifying whether to archive
SYSDATA of jobs to a common data set (Y) or to unique data
sets (N)
MAXDAYS maximum number of days (from 00 through 98,
or 99) to retain archived SYSDATA of jobs that ended NOTOK
MAXRUNS maximum number of runs (from 000 through
999) for which the archived SYSDATA must be retained for
jobs that ended NOTOK
Table 39 Runtime Scheduling Parameters (Part 2 of 2)
Parameter Description
Scheduling Definition Facility
Chapter 2 Online Facilities 137
Restart
RETENTION
Either of the following subparameters (but not both) can be
used to specify how long the job must remain in the History
Jobs file:
# OF DAYS TO KEEP number of days the job must be
retained
# OF GENERATIONS TO KEEP number of runs of the job
that must be retained
SYSOUT Action to perform with the job sysout when the job finishes
OK.
MAXRERUN Maximum number of reruns to be performed for the job, if DO
RERUN is requested. (Called RERUN MAXRERUN prior to
version 6.0.00.)
RERUNMEM Name of member to be submitted in case of a DO RERUN
request. (Called RERUN RERUNMEM prior to version
6.0.00.)
INTERVAL Amount of time, in minutes, to wait between reruns or
between cycles of a cyclic job.
STEP RANGEM Step range (FROM or TO PGMST, and optionally PROCST)
name to be referenced by ON statements.
ONM Step and code event criteria that determine if the
accompanying DO actions are performed
s PGMST/ PROCST program step (and optionally the
procedure step) to check for the specified code criteria
s CODESM execution event codes, such as U0234, SB37,
and C0004
s A/ O AND/ OR conjunctional parameter that opens (and
links) additional ON statements
DO actionM Actions to be performed when the ON step/ code event criteria
are satisfied. Valid DO actions are described in DO Actions
below.
SHOUTM Message to be sent to a specified destination in a specified
situation:
s WHEN Situations under which to send the message.
s TO Destination of the message.
s URGN Urgency of message.
s MS The message, in free text. CONTROL-M AutoEdit
System variables are supported.
Table 40 Post-Processing Parameters (Part 2 of 2)
Parameter Description
Scheduling Definition Facility
138 CONTROL-M for OS/390 and z/OS User Guide
DO Actions
The following are a description and example of each of the DO actions.
DO COND Add or delete a prerequisite condition.
DO CTBRULE Invoke the CONTROL-M/ Analyzer Runtime environment and
execute the specified CONTROL-M/ Analyzer rule, which performs the balancing
operations defined in the rule on SYSDATA. Arguments can be passed to
CONTROL-M/ Analyzer. Available only at sites in which CONTROL-M/ Analyzer is
active.
DO FORCEJOB Force (schedule) a job under CONTROL-M.
Restart DO IFRERUN Perform a restart under CONTROL-M/ Restart when the
job is manually or automatically rerun. This DO action is available if you have
CONTROL-M/ Restart installed at your site.
DO MAIL Send an e-mail message to the specified recipients.
ON PGMST UPDATE PROCST CODES S* * * U* * * * A/ O
DO COND PL- BACKOUT- REQUI RED ODAT +
DO
ON PGMST ANYSTEP PROCST CODES OK A/ O
DO CTBRULE = BALKPL ARG DOREPORT, UPDATEDB
DO
ON PGMST UPDATE PROCST CODES S* * * U* * * * A/ O
DO FORCEJOB TABLE PLPROD JOB PLBCKOUT DATE ODAT
LI BRARY GENERAL
DO
ON PGMST ANYSTEP PROCST CODES S0C1 A/ O
DO I FRERUN FROM GLSTEP01 . GLPROC02 TO GLSTEP05 . GLPROC03 CONFI RM N
DO
ON PGMST UPDATE PROCST CODES C0000 A/ O
DO MAI L
TO ACCT- SMI TH
CC
SUBJ VERI FI CATI ON
TEXT CHECK OK
DO
Scheduling Definition Facility
Chapter 2 Online Facilities 139
DO NOTOK Define the termination status of the job as NOTOK.
DO OK Define the event within the job as OK.
DO RERUN Indicate that a job must be rescheduled for a rerun.
DO SET Assign a value to a CONTROL-M AutoEdit variable.
DO SHOUT Message to be sent to specified location.
DO STOPCYCL Stop recycling a cyclic task.
ON PGMST UPDATE PROCST CODES C0004 A/ O
DO NOTOK
DO
ON PGMST ANYSTEP PROCST CODES C0008 U0048 A/ O
DO OK
DO
ON PGMST ANYSTEP PROCST CODES S0C1 A/ O
DO I FRERUN FROM GLSTEP01 . GLPROC02 TO GLSTEP05 . GLPROC03 CONFI RM N
DO RERUN
DO
ON PGMST ANYSTEP PROCST CODES C0008 U0048 A/ O
DO SET VAR= %%RUNTYPE=CHK
DO
NOTE
Since DO SET values are dependent upon fulfillment of ON step or codes criteria, the
values are assigned after job execution and used for subsequent cyclic runs and rerun.
ON PGMST UPDATE PROCST CODES S* * * U* * * * A/ O
DO SHOUT TO OPER2 URGENCY R
= A BACKOUT OF FI LE- XXXX I S GOI NG TO RUN SOON
DO SHOUT TO USER- DBA URGENCY R
= ABEND OF THE UPDATE STEP, PLEASE CHECK I T
DO
ON PGMST ANYSTEP PROCST CODES >C0008 A/ O
DO STOPCYCL
DO
Scheduling Definition Facility
140 CONTROL-M for OS/390 and z/OS User Guide
DO SYSOUT Action to perform with the job sysout.
Scheduling Definition for Group Entities
A Group Entity must be defined for each Group scheduling table before the job
scheduling definitions in the table can be defined.
A skeletal scheduling definition for a Group Entity is automatically displayed when
creating a Group scheduling table.
The scheduling definition for a Group Entity can also be entered directly from the
Entry Panel or from the Job List screen.
The job scheduling definition for Group Entities varies somewhat from the job
scheduling definition for jobs.
The parameters of the Group Entity are used to define basic scheduling criteria,
runtime scheduling criteria, and post-processing actions to be performed, for the jobs
in the group.
During New Day processing, if at least one set of basic scheduling criteria in the
Group Entity is satisfied, a copy of the Group Entity is placed in the Active Jobs file,
and the jobs in the Group Entity become eligible for scheduling.
The final status of the Group Entity job order is assigned after all scheduled jobs in
the table have been terminated. This Group Entity status is determined by the
execution results of those jobs:
s If all the scheduled jobs in the table ended OK, the Group Entity is assigned an end
status of OK.
s If at least one scheduled job in the table did not end OK, the Group Entity is
assigned an end status of NOTOK.
The performance of post-processing actions defined in the Group Entity is directly
affected by the end status of the Group Entity.
ON PGMST UPDATE PROCST CODES S* * * U* * * * A/ O
DO SYSOUT OPT C PRM P FRM
DO
Scheduling Definition Facility
Chapter 2 Online Facilities 141
Figure 23 Group Entity Scheduling Definition Screen
The Group Entity scheduling definition supports the same commands and PFKey
conventions as any job scheduling definition.
Parameters of the Group Entity Scheduling Definition
Screen
The parameters of the Group Entity scheduling definition are almost identical in
appearance and usage as those in a regular job scheduling definition, which are
described briefly in Parameters of the Job Scheduling Definition Screen on
page 130.
Differences in the parameters of the Group Entity scheduling definitions are
described below.
GRP ACCOUNTS_GROUP CTM. PROD. SCHEDULE( GRP)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
GROUP ACCOUNTS_GROUP MEMNAME ACCOUNTS
OWNER N04B
APPL
DESC
ADJUST CONDI TI ONS N GRP MAXWAI T 00
SET VAR
DOCMEM ACCOUNTS DOCLI B CTM. PROD. DOC
==============================================================================
SCHEDULE TAG ALL_DAYS
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
=============================================================================
SCHEDULE TAG
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
=============================================================================
I N
CONTROL
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
=============================================================================
OUT
ON GROUP- END NOTOK
DO COND ACCTS- CHK- REQUI RED ODAT +
SHOUT WHEN TO URGN
MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 19. 14
Scheduling Definition Facility
142 CONTROL-M for OS/390 and z/OS User Guide
All parameters of the Job Scheduling Definition screen are described in detail in
Chapter 3, Job Production Parameters.
Table 41 Parameters of the Group Entity Scheduling Definition Screen (Part 1 of 2)
Parameter Description
GROUP Name of the group. This parameter also appears, in a different
location, in regular job scheduling definitions. Mandatory in
Group Entities. When defined in a Group Entity, the value is
automatically assigned to all job scheduling definitions in the
Group table.
MEMNAME In a Group Entity, this field does not indicate a member name.
Instead, it is used to indicate an abbreviated group name. This
abbreviated group name is then displayed, when appropriate,
in other screens, such as the Active Environment screen.
ADJUST
CONDITIONS
Yes or No indicator specifying whether prerequisite
conditions normally set by predecessor jobs are removed from
job orders if the relevant predecessor jobs are not scheduled.
This parameter only appears in the Group Entity, and applies
to all jobs in the table awaiting prerequisite conditions from
unscheduled jobs. Use of this parameter can simplify the
handling of Maybe jobs.
GRP MAXWAIT Number of extra days beyond the original scheduling date the
Group Entity can be maintained in the Active Jobs file if it does
not have a status of ENDED OK.
However, if one of its jobs remains in the Active Jobs file
beyond this number of days, the Group Entity remains in the
Active Jobs file as long as the job remains there.
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.
A set of criteria defined in a Group Entity can be applied to a
job by specifying the identifying tag in the job scheduling
definition.
At least one set of basic scheduling criteria in the Group Entity
must be satisfied before the jobs in that Group scheduling
table become eligible for scheduling on any day.
Basic Scheduling
Parameters
The Group Entity does not contain parameters DCAT, PDS,
and MINIMUM, which are found in job scheduling
definitions.
Scheduling Definition Facility
Chapter 2 Online Facilities 143
Commands of the Job Scheduling Definition Screen
The following commands can be entered in the COMMAND field of the Job
Scheduling Definition screen.
Runtime
Scheduling
Parameters
These parameters, IN, TIME FROM/ UNTIL, PRIORITY, DUE
OUT, and CONFIRM, apply to all scheduled jobs in the group.
All runtime scheduling criteria in the Group Entity must be
satisfied before any of the scheduled jobs are eligible for
submission. Any runtime criteria defined for a particular job
must also be satisfied before the job can be submitted.
Post-Processing
Parameters
Non-conditional Post-processing parameters (OUT, SHOUT)
are performed only if all scheduled jobs in the table have
ended OK.
ON GROUP-END
Group Entity end status indicator. This parameter appears
only in the Group Entity. DO statements immediately
following this parameter are performed only if the Group
Entity is assigned the indicated status. Valid values are:
s OK Subsequent DO actions are performed for each job in
the group only if the end status of the Group Entity is OK
(that is, all scheduled jobs in the table ended OK).
s NOTOK Subsequent DO actions are performed for each
job in the group if the end status of the Group Entity is
NOTOK (that is, at least one job in the group ended
NOTOK).
Table 42 Commands of the Job Scheduling Definition Screen (Part 1 of 3)
Command Description
EDIT Alternately places the job scheduling definition in, and
removes the job scheduling definition from, an ISPF-like Edit
environment.
For a brief overview, see Editing Job Scheduling Definitions
in the Edit Environment on page 145. For more complete
details, see Appendix A, The CONTROL-M Application
Program Interface (CTMAPI).
Table 41 Parameters of the Group Entity Scheduling Definition Screen (Part 2 of 2)
Parameter Description
Scheduling Definition Facility
144 CONTROL-M for OS/390 and z/OS User Guide
DOC Alternately displays and hides the job documentation.
For more information, see Job Documentation on page 146.
PLAN Enables display of the job's scheduling plan.
When the PLAN command is entered, a window for entering
the date range of the plan is displayed. When the date range is
entered, the scheduling plan for the job is displayed in the Job
Scheduling Plan screen.
For more information, see Displaying a Job Scheduling Plan
on page 162.
JOBSTAT Displays the Statistics screen, which provides statistics for the
job.
To display statistics for the currently displayed job, type:
JOBSTAT ( abbr evi at ed J)
To display statistics for any job other than the current job,
format of the command is:
JOBSTAT j obname gr oupname
Entering a group name is optional, but if no group name is
entered, statistics are displayed only for jobs not belonging to
any group.
For more information, see Statistics Screen on page 233.
CHANGE Replaces an existing string with a new string.
The format of the command is:
CHANGE ol dst r i ng newst r i ng
where:
s oldstring is the existing string to be replaced
s newstring is the string that replaces the existing string
Table 42 Commands of the Job Scheduling Definition Screen (Part 2 of 3)
Command Description
Scheduling Definition Facility
Chapter 2 Online Facilities 145
If a string contains embedded spaces, enclose the string in apostrophes (') or
quotation marks (").
To repeat a CHANGE command, press PF09/PF21.
Editing Job Scheduling Definitions in the Edit Environment
Job scheduling definition parameters can be edited, that is, moved, copied, deleted, or
repeated, by performing IOA Line Editing commands, similar to standard ISPF line
commands, from within the CONTROL-M Edit environment.
The Edit Environment in the Job Scheduling Definition screen is accessed by typing
EDIT in the COMMAND field and pressing Enter.
NEXT The NEXT command (PF11/PF23) keeps the changes to the
current job scheduling definition in memory and
automatically displays the next job scheduling definition in
the scheduling table.
For more information, see Exiting the Job Scheduling
Definition Screen on page 149.
PREV The PREV command (PF10/PF22) keeps the changes to the
current job scheduling definition in memory and
automatically displays the previous job scheduling definition
in the scheduling table.
For more information, see Exiting the Job Scheduling
Definition Screen on page 149.
Table 42 Commands of the Job Scheduling Definition Screen (Part 3 of 3)
Command Description
Scheduling Definition Facility
146 CONTROL-M for OS/390 and z/OS User Guide
Figure 24 Editing Job Scheduling Definitions in the Edit Environment Screen
A 2-character Line Editing command field, marked by underscores, is displayed for
each line on the screen.
Editing commands are typed directly onto these underscores.
Specified Line Editing commands are processed when Enter is pressed.
Details and examples of the editing of job scheduling definitions in the Edit
environment are provided in Appendix C, Editing Job Scheduling Definitions in the
Edit Environment.
Job Documentation
Display and Non-Display of Documentation
Depending on the value of the Show Job Documentation field in the scheduling
facility entry panel, job documentation, in the form of DOC lines, is either displayed
or hidden when you first enter the Job Scheduling Definition screen:
s If the Show Job Documentation field is set to Y, job documentation is displayed
upon entry to the Job Scheduling Definition screen.
s If the Show Job Documentation field is set to N, documentation is hidden upon
entry to the Job Scheduling Definition screen.
JOB: BACKP02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
- - MEMNAME BACKP02 MEMLI B CTM. PROD. JOBLI B
- - OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
- - APPL APPL- L GROUP BKP- PROD- L
- - DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
- - OVERLI B CTM. OVER. JOBLI B
- - SCHENV SYSTEM I D NJE NODE
- - SET VAR
- - CTB STEP AT NAME TYPE
- - DOCMEM BACKP02 DOCLI B CTM. PROD. DOC
- - ===========================================================================
- - DAYS DCAL
- - AND/ OR
- - WDAYS WCAL
- - MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
- - DATES
- - CONFCAL WORKDAYS SHI FT RETRO N MAXWAI T 04 D- CAT
- - MI NI MUM PDS
- - DEFI NI TI ON ACTI VE FROM UNTI L
- - ===========================================================================
- - I N START- DAI LY- BACKUP ODAT
- - CONTROL
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
Scheduling Definition Facility
Chapter 2 Online Facilities 147
DOC Command
The DOC command alternately displays and hides the job documentation.
Below is an example of the Job Scheduling Definition screen with the documentation
(DOC lines) displayed.
Figure 25 Job Scheduling Definition DOC lines
Editing Documentation
Documentation can be edited when the DOC lines of the Job Scheduling Definition
screen are displayed. Modify the DOC lines as desired. When you fill in the last DOC
line and press Enter, a new DOC line is displayed.
When modifying DOC lines, text must be left in at least one DOC line in order to save
the modifications. Changes resulting in an empty DOCMEM member are not saved.
JOB: BACKPL02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME BACKPL02 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC
===========================================================================
DOC THI S JOB BACKS UP SPECI AL " L" FI LES. I T PERFORMS THE FOLLOWI NG STEPS:
DOC 1: VERI FY SPACE REQUI REMENTS
DOC 2- 5: BACKUP THE FI LES
DOC 6: RECATALOG THE NEWFI LES
DOC 7: PRI NT THE SHORT- VERSI ON LI STI NG REPORT
DOC
===========================================================================
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
NOTE
If DOCU/ TEXT is installed at your site, you can specify a DOCU/ TEXT library and
member with up to 132 characters per line. However, if more than the first 71
characters in a line are used, the line is truncated and Browse mode is forced. Browse
mode is also forced if a line has an unprintable character.
Scheduling Definition Facility
148 CONTROL-M for OS/390 and z/OS User Guide
Job documentation is written to the library and member specified in the DOCLIB and
DOCMEM fields on the Job Scheduling Definition screen. Therefore, it is also possible
to edit the documentation member directly through ISPF. This is recommended when
documentation is lengthy or the editing required is very complex.
Auto-Save and Saving Documentation
Documentation changes can be saved upon exiting the Job Scheduling Definition
screen. When there are documentation changes, a Save Documentation window may
be displayed depending on the value of the AUTO-SAVE DOCUMENTATION field
in the Scheduling Facility entry panel:
s If the AUTO-SAVE DOCUMENTATION field was set to Y, documentation
changes are automatically saved and the Save Documentation window is not
displayed.
s If the AUTO-SAVE DOCUMENTATION field was set to N, documentation
changes are not automatically saved and the Save Documentation window is
displayed. This window lets you save or cancel the documentation changes.
Figure 26 Save Documentation Window
The following parameters can be specified in the Save Documentation window:
NOTE
For LIBRARIAN and PANVALET users, the DOC command displays and hides job
documentation in Browse mode. Changes to the documentation are not permitted.
JOB: PRUPDT02 LI B CTM. PROD. SCHEDULE TABLE: PRPROD
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + ===> CRSR
+- - - - - | | - - - - - - - - +
MEMN | SAVE DOCUMENTATI ON ==> ( Y/ N) |
OWNE | |
APPL | LI BRARY CTM. PROD. DOC |
DESC | MEMBER PRUPDT02 |
OVER | |
SCHE +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SET
CTB STEP AT NAME TYPE
DOCMEM DOCLI B
========================================================================
DOC PROGRAMMER RESPONSI BLE - JOHN SMI TH
DOC MODI FI CATI ONS:
DOC 1. NEWDD CARD ADDED ' I NP002' FOR NEWI NPUT FI LE - FEB. 2001
DOC 2. ADDI TI ONAL REPORT CREATED I N STEP 04 - MAR. 2001
DOC
========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- 2- 3- 4- 5- 6- 7- 8- 9- 10- 11- 12-
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
Scheduling Definition Facility
Chapter 2 Online Facilities 149
Modify the LIBRARY and MEMBER values if desired, and type Y or N in the SAVE
DOCUMENTATION field; then press Enter.
If there are no documentation changes, the Save Documentation window is not
displayed.
Exiting the Scheduling Definition Facility
When exiting the Scheduling Definition facility, screens are exited in the following
sequence:
s Job Scheduling Definition screen
s Job List screen
s Table List screen
Entry Panel
The commands and options available when exiting screens depend on the screen
being exited and on whether changes have been made. If changes have been made,
the selected exit options and commands determine whether the changes are saved.
Exit options and commands are discussed below on a screen-by-screen basis.
Exiting the Job Scheduling Definition Screen
Use any of the following commands, or press the corresponding PFKey, to exit the
Job Scheduling Definition screen:
Table 43 Save Documentation Window Fields
Field Description
SAVE
DOCUMENTATIO
N
Valid values are:
s Y (Yes) save documentation changes
s N (No) do not save documentation changes
LIBRARY Name of the library containing the documentation member.
MEMBER Name of the member containing the documentation.
NOTE
If the Table List screen was bypassed when you entered the Scheduling Definition
facility, that is, if you entered a TABLE value in the entry panel, the Table List screen
is not displayed upon exiting the Job List screen; instead, the entry panel is displayed.
Scheduling Definition Facility
150 CONTROL-M for OS/390 and z/OS User Guide
Exiting the Job List Screen
Press END (PF03/PF15) to exit the Job List screen. If changes made to at least one job
scheduling definition have been kept in memory, as discussed in the preceding
section, Exiting the Job Scheduling Definition Screen, and/ or if changes have been
made to the Job List screen, the Exit Option window is displayed.
Figure 27 Job List Screen Exit Option Window
Table 44 Commands for Exiting the Rule Definition Screen
Command Description
CANCEL Cancel the changes made to the job scheduling definition and
return to the Job List screen.
Note: The following exit commands retain changes to the job scheduling definition
in memory. To permanently save the changes to disk, you must request that the
changes be saved when you exit the Job List screen. If documentation changes have
been made, the Save Documentation window, described in Auto-Save and Saving
Documentation on page 148, may be displayed.
END
(PF03/PF15)
Keep changes to the job scheduling definition in memory and exit
to the Job List screen.
NEXT
(PF11/PF23)
Keep changes to the job scheduling definition in memory and
display the next job scheduling definition from the Job list.
PREV
(PF10/PF22)
Keep changes to the job scheduling definition in memory and
display the previous job scheduling definition from the Job list.
JOB LI ST LI B: CTMP. V610. SCHEDULE TABLE: BACKUP
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + ===> CRSR
OPT N | PLEASE SELECT EXI T OPTI ON | - - - - - - - - -
S | |
B | SAVE CREATE |
B | |
B | LI BRARY CTMP. V610. SCHEDULE |
B | TABLE ZEMER1 |
B | | <<< =====
B +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
D
DASDRPT2 DASD STATI STI CS REPORT AFTER BACKUP FOR APPL- L
ENDPLBKP END OF BACKUP I NDI CATI ON FOR APPL- L
BACKAC01 DAI LY BACKUP OF DATA SETS FROM APPL- ACCOUNT
BACKAC02 DAI LY BACKUP OF SPECI AL FI LES FROM APPL- ACCOUNT
BACKACW1 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #1
BACKACW2 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #2
BACKACW3 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #3
BACKACW4 WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- ACC +
DASDRPT3 DASD REPORTS AFTER BACKUPS FOR APPL- ACCOUNT
DASDRPT4 DASD REPORTS AFTER BACKUP FOR APPL- ACCOUNT
ENDACBKP END OF BACKUP I NDI CATI ON FOR APPL- ACCOUNT
BACKDD01 DAI LY BACKUP OF DATA SETS FROM APPL- DD
OPTI ONS S SEL D DEL I I NS O ORDER F FORCE J JCL C COPY P PLN T JOBSTAT 08. 07. 23
Scheduling Definition Facility
Chapter 2 Online Facilities 151
The LIBRARY and TABLE fields indicate the library and table in which the job
scheduling definitions will be saved. The specified values can be modified, for
example, to save the job scheduling definitions in a new or different table.
Fill in the Exit Option window as follows:
s To save all changes currently in memory and exit the Job List screen, type Y (Yes)
after the word SAVE or CREATE:
Type Y after SAVE if a table with the same name already exists in the specified
library.
Type Y after CREATE if a table with the same name does not exist in the
specified library.
s To cancel changes currently in memory and exit the Job List screen, type N (No)
after the word SAVE or CREATE.
s To close the Exit Option window and remain in the Job List screen, with the
changes remaining in memory, press RESET (PF04/PF16).
Exiting the Table List Screen
Press the END key (PF03/PF15) to exit the Table List screen.
Exiting the Entry Panel
Press the END key (PF03/PF15) to exit the entry panel.
Ordering (Scheduling) Jobs
Although job scheduling in the production environment is generally handled by
CONTROL-M automatically (for more information, see Chapter 6, Selected
Implementation Issues), CONTROL-M provides several mechanisms for scheduling
jobs manually. Among these are options to manually request job scheduling from the
Table List screen and the Job List screen.
NOTE
If you create a new table, the table name does not appear in the Table List screen
upon exiting the Job List screen; it first appears when you reenter the Table List
screen from the entry panel.
Scheduling Definition Facility
152 CONTROL-M for OS/390 and z/OS User Guide
s When manually requesting job scheduling from the Job List screen, specific jobs
are selected. Multiple jobs can be specified.
s When manually requesting job scheduling from the Table List screen, tables are
selected and each request applies to all the jobs in the selected tables. Multiple
tables can be specified.
Either of two options, O (Order) and F (Force), can be used in either of these screens
to manually request job scheduling. These options work as follows:
The exception is: Option O (Order) cannot be entered for individual jobs in Group
scheduling tables.
When you use the O and F options, a confirmation window is opened. The default
confirmation window in the case where the O option has been entered for more than
one job is illustrated in Figure 28. If the O or the F option is entered for only one job,
the second line, which contains the ASK FOR EACH ONE field, does not appear.
Table 45 Options for Manually Ordering Jobs
Option Description
O (ORDER) Basic scheduling parameters of the jobs are checked against
the requested scheduling date. If the job must be scheduled for
that day, a job order is placed on the Active Jobs file.
F (FORCE) Basic scheduling parameters of the jobs are not checked. A job
order is placed on the Active Jobs file that day even if the
scheduling criteria of the job are not satisfied.
NOTE
With one exception, options O (Order) and F (Force) can be used in both the Job List
screen and Table List screen for either regular scheduling tables or Group scheduling
tables.
Scheduling Definition Facility
Chapter 2 Online Facilities 153
Figure 28 Order and Force Confirmation Window
The default confirmation window contains the following fields:
JOB LI ST LI B: CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
STARTBKP +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
BACKPL01 | CONFI RM ODATE 060601 WAI T FOR ODATE N |
O BACKPL02 <- - - - - - - - - - | ASK FOR EACH ONE Y |
BACKPLW1 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
BACKPLW2 WEEKLY BACKUP OF FI LES FROM APPL- L #2
BACKPLW3 WEEKLY BACKUP OF FI LES FROM APPL- L #3
BACKPLW4 WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- L +
DASDRPT1 DASD REPORTS AFTER BACKUPS FOR APPL- L
DASDRPT2 DASD STATI STI CS REPORT AFTER BACKUP FOR APPL- L
ENDPLBKP END OF BACKUP I NDI CATI ON FOR APPL- L
BACKAC01 DAI LY BACKUP OF DATA SETS FROM APPL- ACCOUNT
O BACKAC02 DAI LY BACKUP OF SPECI AL FI LES FROM APPL- ACCOUNT
BACKACW1 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #1
BACKACW2 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #2
BACKACW3 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #3
BACKACW4 WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- ACC +
DASDRPT3 DASD REPORTS AFTER BACKUPS FOR APPL- ACCOUNT
DASDRPT4 DASD REPORTS AFTER BACKUP FOR APPL- ACCOUNT
O ENDACBKP END OF BACKUP I NDI CATI ON FOR APPL- ACCOUNT
BACKDD01 DAI LY BACKUP OF DATA SETS FROM APPL- DD
OPTI ONS S SEL D DEL I I NS O ORDER F FORCE J JCL C COPY P PLN T JOBSTAT 15. 37. 39
Table 46 Order and Force Confirmation Window Fields (Part 1 of 3)
Field Description
CONFIRM Whether to process the Order or Force request.
Valid values are:
s Y (Yes) Process the Order or Force request.
s N (No) Cancel the request.
Scheduling Definition Facility
154 CONTROL-M for OS/390 and z/OS User Guide
ODATE Scheduling date of the job or table, in mmddyy, ddmmyy or
yymmdd format, depending on the site standard. The
specified date can be modified.
Note: The job is only ordered if the basic job scheduling
criteria are satisfied at the ODATE. However, the job is not
necessarily executed on the ODATE. If the job is ordered, it
becomes eligible for execution immediately when its run-time
criteria have been satisfied.
ODATE has the following additional functions:
s If an IN or OUT condition uses a relative dateref (for
example if the value of dateref is ODAT, PREV, or NEXT),
ODATE is used to set the dateref. For more information on
IN and OUT conditions, see IN: Runtime Scheduling
Parameter on page 497 and OUT: PostProcessing
Parameter on page 554.
s The calculation of the MAXWAIT of a job is based on the
ODATE of the job, and not on the actual date on which the
job is ordered. For more information on the MAXWAIT
parameter, see MAXWAIT: Basic Scheduling Parameter
on page 515.
s It is used by the WAIT FOR ODATE option (as described
in this table).
For more information on the meaning of ODATE, see the
discussion of Time Zone support in the CONTROL-M chapter
of the INCONTROL for OS/390 and z/OS Administrator Guide.
WAIT FOR ODATE Whether to wait for a specific date, or process the Order or
Force request immediately.
Valid values are:
s Y (Yes) 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.
s N (No) The Order or Force request is processed
immediately. Default.
Table 46 Order and Force Confirmation Window Fields (Part 2 of 3)
Field Description
Scheduling Definition Facility
Chapter 2 Online Facilities 155
Fill in the confirmation window and press Enter. If at least one order or force request
has been specified for a table or job, the original list screen disappears and a message
screen is displayed. This screen displays messages that contain the following
information about the jobs that were scheduled.
Each iteration of the message screen displays job information for one table only. Press
END (PF03/PF15) to exit the message display for that table. If multiple tables, or jobs in
multiple tables, have been scheduled, the messages for the next table are displayed.
When messages for all tables have been displayed, pressing END displays the Table
or Job list screen.
The Double Confirmation Window
Any request to order or force a job can, if you prefer, only be processed if it has been
confirmed twice. This option is selected by means of the SSCHTBO parameter.
The SSCHTBO parameter is one of the parameters set in the Presentation Modes
minor step in the Profile Variables major step of the Customize option (Option 6) of
the INCONTROL Installation and Customization Engine (ICE). The default setting is
N (No), meaning that when a table is ordered or forced, a regular confirmation
window is opened, and not a double confirmation window.
The SSCHTBO parameter can be modified at any time. If the setting of the SSCHTBO
parameter is modified to Y (Yes), a window that requires double confirmation is
opened in response to any order or force request. An example of this window is
shown in Figure 29.
ASK FOR EACH
ONE
This line is displayed only if more than one order or force
option is requested. It determines whether individual
confirmation is required for each order or force request.
Valid values are:
s Y (Yes) Individual confirmation is required for each
order or force request. The specified CONFIRM value (Y or
N) applies only to the current order or force request.
s N (No) Individual confirmation is not required for each
order or force request. The specified CONFIRM operation
is applied to all order or force requests. If CONFIRM is Y,
all order or force requests are processed; if CONFIRM is N,
no order or force requests are processed.
JOB name ODATE dat e I D=or der ed PLACED ON ACTI VE JOBS FI LE- descr
Table 46 Order and Force Confirmation Window Fields (Part 3 of 3)
Field Description
Scheduling Definition Facility
156 CONTROL-M for OS/390 and z/OS User Guide
Figure 29 The Double Confirmation Window
NOTE
If you change the setting of the parameter, you must exit and then reenter the IOA
online environment before the change can take effect.
LI ST OF TABLES I N CTMP. BKUP. SCHEDULE - - - - - - - - - - - - - ( 2)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - - - VV. MM CREATED CHANGED SI ZE I NI T MOD I D
BACKPER0 01. 01 00/ 12/ 12 01/ 10/ 16 15: 20 180 25 0 K33
BACKPER1 01. 07 00/ 12/ 12 01/ 10/ 16 15: 25 143 53 0 K33
O BACKPER2 02. 60 00/ 12/ 12 01/ 10/ 16 15: 30 74 28 0 K33
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| |
| +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + |
| | ALL OF THE JOBS I N TABLE BACKPL02 | |
| | WI LL BE ORDERED. PLEASE CONFI RM | |
| | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | |
| | ORDER ALL JOBS I N TABLE BACKPL02 | |
| | ODATE 120601 CONFI RM AGAI N WAI T FOR ODATE N | |
| +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
BACKACC1 01. 09 00/ 12/ 12 01/ 10/ 16 15: 35 57 10 0 K33
BACKACC2 01. 02 00/ 12/ 12 01/ 10/ 16 15: 37 25 21 0 K33
BACKACC3 02. 43 00/ 12/ 12 01/ 10/ 16 15: 41 127 29 0 K33
BACKACC4 01. 12 00/ 12/ 12 01/ 10/ 16 15: 43 36 18 0 K33
BACKADM1 01. 06 00/ 12/ 12 01/ 10/ 16 15: 18 23 21 0 K33
BACKADM2 01. 12 00/ 12/ 12 01/ 10/ 16 15: 16 27 25 0 K33
OPTI ONS S SEL D DEL I I NS O ORDER F FORCE J JCL C COPY P PLN T JOBSTAT 15. 37. 39
Scheduling Definition Facility
Chapter 2 Online Facilities 157
Copying Jobs to Another Table
To copy one or more jobs from the current table to another table, type C (Copy) in the
OPT column of the Job List screen, next to the job names, and press Enter. The
following window is displayed:
Figure 30 Window for Copying Jobs to Another Table
The window contains the fields shown in the following table. Some fields contain
default values that can be modified.
JOB LI ST LI B: CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - DESCRI PTI ON - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
STARTBKP START OF DAI LY BACKUP
BACKPL01 DAI LY BACKUP OF DATA SETS FROM APPL- L
BACKPL02 DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
BACKPLW1 WEEKLY BACKUP OF FI LES FROM APPL- L #1
BACKPLW2 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
BACKPLW3 | |
C BACKPLW4 | SPECI FY DESTI NATI ON LI BRARY, TABLE AND JOB NAME |
DASDRPT1 | |
DASDRPT2 | LI BRARY : CTM. PROD. SCHEDULE |
ENDPLBKP | TABLE : |
BACKAC01 | JOB : BACKPLW4 |
BACKAC02 | |
BACKACW1 | PRESS END/ RESET TO CANCEL ENTER TO PERFORM THE COPY |
BACKACW2 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
BACKACW3 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #3
BACKACW4 WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- ACC +
DASDRPT3 DASD REPORTS AFTER BACKUPS FOR APPL- ACCOUNT
DASDRPT4 DASD REPORTS AFTER BACKUP FOR APPL- ACCOUNT
ENDACBKP END OF BACKUP I NDI CATI ON FOR APPL- ACCOUNT
BACKDD01 DAI LY BACKUP OF DATA SETS FROM APPL- DD
OPTI ONS S SEL D DEL I I NS O ORDER F FORCE J JCL C COPY P PLN T JOBSTAT 15. 37. 39
Table 47 Fields in the Window for Copying Jobs to Another Table
Field Description
Library Library containing the table into which the jobs must be
copied. Must be an existing library. Default is the current
library.
Table Name of the table into which the job must be copied.
Notes: A job can only be copied to another table. It cannot be
copied to its own table (even if the job is renamed).
If the specified table does not exist, the table is created when
the request is performed.
Job Name of the job to be copied. If multiple jobs are selected, the
window initially display with the first selected job. As each
request is performed or canceled, the next requested job name
is displayed.
Scheduling Definition Facility
158 CONTROL-M for OS/390 and z/OS User Guide
To perform a request, press Enter.
To cancel a request, press END (PF03/PF15) or RESET (PF04/PF16).
Group entities cannot be copied. If a job in a Group scheduling table is copied to a
regular scheduling table, it is copied as a regular job; scheduling tags are dropped
from the job scheduling definition. If a job in a Group scheduling table is copied to a
nonexisting table, the table that is created is a regular table, not a group table.
Deleting Tables
Tables can be deleted from the Table List screen.
To delete tables, type D (Delete) by the table names in the Table List screen and press
Enter.
The confirmation window illustrated below is displayed, in sequence, for each table
selected for deletion.
NOTE
When a job from a regular table is copied to a Group scheduling table, the job retains
its basic scheduling criteria and an empty SCHEDULE TAG field is inserted in the job
scheduling definition.
When a job from a Group scheduling table is copied to a Group scheduling table, the
job retains its original scheduling tags.
Scheduling Definition Facility
Chapter 2 Online Facilities 159
Figure 31 Delete Table Confirmation Window
Type Y (Yes) in the window to confirm the delete request.
Type N (No) in the window to cancel the delete request.
A message is written to the IOA Log file for each table deleted.
Displaying Graphic Jobflow
The Graphic Jobflow screen provides a graphic presentation of the job flow
dependencies in a given scheduling table. It is displayed when option G (Graphic
Flow) is specified for a table in the Table List screen.
Use the shifting PFKeys to shift the Graphic Jobflow right (PF11/PF23) and left
(PF10/PF22).
The FIND command (PF05/PF17), described in FIND Command on page 98, is
supported in the Graphic Jobflow screen.
To return to the Table list, press the END key (PF03/PF15).
LI ST OF TABLES I N CTM. PROD. SCHEDULE - - - - - - - - - - - - - ( 2)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - +- - - - - - - - - - - - - - - - - - - - - - - - - - + E I NI T MOD I D
ADABAS | CONFI RM DELETE OPTI ON | 0 70 0 O01
D APPLNTN <- - - - - - - - - - - | ( Y/ N) | 0 180 0 O01
APPLPRDI +- - - - - - - - - - - - - - - - - - - - - - - - - - + 1 41 0 O01
ARCNI GHT 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 5 5 0 S07
ASMBTR1 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 9 9 0 S07
D ASMBTR2 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 14 14 0 S07
BACKUP 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 5 5 0 S07
CI CSJOBS 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 70 70 0 O01
CI CSPROD 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 180 180 0 O01
CI CSTEST 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 41 41 0 O01
CI CSUPT 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 5 5 0 S07
CLI ENTS 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 9 9 0 S07
DB2EXE 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 14 14 0 S07
DLOAD 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 5 5 0 S07
MAI NDAY 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 180 180 0 O01
MAI NT 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 41 41 0 O01
MAI NTPL 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 5 5 0 S07
ONSPOOL 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 9 9 0 S07
D ONSPOOLT 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 14 14 0 S07
OPERCLN 01. 00 01/ 02/ 09 01/ 06/ 07 00: 50 5 5 0 S07
OPTI ONS S SELECT O ORDER F FORCE G GRAPHI C FLOW B BROWSE D DELETE 15. 38. 37
NOTE
If PDSMAN is operational at your site, $$$SPACE members are not deleted.
Scheduling Definition Facility
160 CONTROL-M for OS/390 and z/OS User Guide
Two formats for the Graphic Jobflow screen are available, one for color displays and
one for non-color displays.
Graphic Jobflow for Color Terminals
Figure 32 Graphic Jobflow for Color Terminals
On color terminals, the colors used to display the boxes and arrows can be changed
by request. Available colors are sequenced in a loop. Each request changes to the next
color in the sequence. Colors can be changed as follows:
- - - - - - - - - - - - - - - - - - - GRAPHI C JOBFLOW- TABLE PRODYH - - - - - - - - - - - - - - - - - - - - - ( 2. G)
COMMAND ===> SCROLL===> CRSR

PRODYJCL - - - > PRODYHTK - - - - - - - - - - - - - - - - - - - > PRODYHST

PRODTHC2 - - - > PRODYBCK - - - > PRODYI DK - - - > - - - > PRODYBTL

- - - > PRODYI ZN - - - > PRODYEND


PROJYFOT - - - > PROJYMRG - - - > PROJYMTI


- - - > PROJYHO1 - - - > PROJYHO2

- - - > PROJYDPY - - - > PROJYDTK - - - > PROYH11 - - -


- - - > PROJYDLI - - - >

PRESS END TO RETURN. LEFT AND RI GHT TO SEE MORE. COLUMNS: 001 - 080 15. 38. 44
NOTE
Size limits for the online display are narrower than the size limits for the printed
chart. The online display is limited to 15 levels of dependencies. If the chart cannot be
displayed online because it is too large, it can still be printed. For more information,
see the description of the CTMRFLW utility in the CONTROL-M chapter of the
INCONTROL for OS/390 and z/OS Utilities Guide.
Table 48 Color Change Options on Graphic Jobflow Window
Option Description
Change the color of the
boxes
Press PF04/PF16
Change the color of arrows Type ARROW in the COMMAND field and press
Enter.
a

a
PF05/PF17, which used to change the color of arrows, now performs the FIND command.
Scheduling Definition Facility
Chapter 2 Online Facilities 161
Graphic Jobflow for Non-Color Terminals
Figure 33 Graphic Jobflow for Non-Color Terminals
- - - - - - - - - - - - - - - - - - - - GRAPHI C JOBFLOW- TABLE PRODYH - - - - - - - - - - - - - - - - - - - - - ( 2. G)
COMMAND ===> SCROLL===> CRSR
. - - - - - - - - - - . . - - - - - - - - - - . . - - - - - - - - - - .
| PRODYJCL | - - - >| PRODYHTK | - - - >- - - >- - - >- - - >- - - >| PRODYHST |
` - - - - - - - - - - ' ` - - - - - - - - - - ' | |
. - - - - - - - - - - . . - - - - - - - - - - . . - - - - - - - - - - . | | . - - - - - - - - - - .
| PRODTHC2 | - - - >| PRODYBCK | - - - >| PRODYI DK | - - - >| | - - - >| PRODYBTL |
` - - - - - - - - - - ' ` - - - - - - - - - - ' | | ` - - - - - - - - - - ' ` - - - - - - - - - - '
| | . - - - - - - - - - - . . - - - - - - - - - - .
| | - - - >| PRODYI ZN | - - - >| PRODYEND |
` - - - - - - - - - - ' ` - - - - - - - - - - ' ` - - - - - - - - - - '
. - - - - - - - - - - . . - - - - - - - - - - . . - - - - - - - - - - .
| PROJYFOT | - - - >| PROJYMRG | - - - >| PROJYMTI |
` - - - - - - - - - - ' | | ` - - - - - - - - - - '
| | . - - - - - - - - - - . . - - - - - - - - - - .
| | - - - >| PROJYHO1 | - - - >| PROJYHO2 |
| | ` - - - - - - - - - - ' ` - - - - - - - - - - '
| | . - - - - - - - - - - . . - - - - - - - - - - . . - - - - - - - - - - .
| | - - - >| PROJYDPY | - - - >| PROJYDTK | - - - >| PROYH11 | - -
` - - - - - - - - - - ' | | ` - - - - - - - - - - ' | |
| | . - - - - - - - - - - . | |
| | - - - >| PROJYDLI | - - - >| |
| | ` - - - - - - - - - - ' ` - - - - - - - - - - '
PRESS END TO RETURN. LEFT AND RI GHT TO SEE MORE. COLUMNS: 001 - 080 15. 38. 44
NOTE
Size limits for the online display are narrower than the size limits for the printed
chart. If the chart cannot be displayed online because it is too large, it may still be
printed. For more information, see Chapter 8, KeyStroke Language (KSL).
Scheduling Definition Facility
162 CONTROL-M for OS/390 and z/OS User Guide
Displaying a Job Scheduling Plan
To display the scheduling plan of a job or group entity in calendar format, either type
P (Plan) by the job or group entity name in the Job List screen and press Enter, or
enter command PLAN in the Job Scheduling Definition screen. The following
window is displayed:
Figure 34 Job Scheduling Plan Window
The window contains the following fields with default values that can be modified:
To display the plan, modify the defaults if desired. Press Enter. The Job Scheduling
Plan screen is displayed.
To close the window without displaying the plan, press END (PF03/PF15) or RESET
(PF04/PF16).
JOB LI ST LI B: CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - DESCRI PTI ON - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
STARTBKP START OF DAI LY BACKUP
BACKPL01 DAI LY BACKUP OF DATA SETS FROM APPL- L
BACKPL02 DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
BACKPLW1 WEEKLY BACKUP OF FI LES FROM APPL- L #1
BACKPLW2 WEEKLY BACKUP OF FI LES FROM APPL- L #2
BACKPLW3 WEEKLY BACKUP OF FI LES FROM APPL- L #3
BACKPLW4 WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- L +
DASDRPT1 DASD REPORTS AFTER BACKUPS FOR APPL- L
DASDRPT2 DASD STATI STI CS REPORT AFTER BACKUP FOR APPL- L
ENDPLBKP +- - - - - - - - - - - - - - - - - - - - - +
BACKAC01 | FROM DATE 050101 |
P BACKAC02 | TO DATE 053101 |
BACKACW1 +- - - - - - - - - - - - - - - - - - - - - +
BACKACW2
BACKACW3 WEEKLY BACKUP OF FI LES FROM APPL- ACCOUNT #3
BACKACW4 WEEKLY BACKUP OF FI LES AFTER DAI LY FROM APPL- ACC +
DASDRPT3 DASD REPORTS AFTER BACKUPS FOR APPL- ACCOUNT
DASDRPT4 DASD REPORTS AFTER BACKUP FOR APPL- ACCOUNT
ENDACBKP END OF BACKUP I NDI CATI ON FOR APPL- ACCOUNT
BACKDD01 DAI LY BACKUP OF DATA SETS FROM APPL- DD
OPTI ONS S SEL D DEL I I NS O ORDER F FORCE J JCL C COPY P PLN T JOBSTAT 15. 37. 39
Table 49 Job Scheduling Plan Window Fields
Field Description
FROM DATE First date to be included in the job scheduling plan. Default is
current working date.
TO DATE Last date to be included in the job scheduling plan. Default is
one day less than one month after the current working date.
Scheduling Definition Facility
Chapter 2 Online Facilities 163
Job Scheduling Plan Screen
For each month in the requested date range, beginning with the first month in the
range, the Job Scheduling Plan screen displays a calendar that indicates the schedule
of the job.
The dates within the date range on which the job is scheduled, according to its basic
scheduling criteria, are marked with an asterisk.
Enter NEXT (PF08/PF11/PF20/PF23) or PREV (PF07/PF10/PF19/PF22) in the COMMAND
field, or press the appropriate PFKey, to see the next or previous calendar month in
the date range.
Press the END key (PF03/PF15) to exit the Job Scheduling Plan screen and return to the
Job List screen.
Figure 35 Job Scheduling Plan Screen
The screen indicates the following:
NOTE
The months (within the date range) in which the job (or jobs for a group schedule) is
not scheduled are not displayed.
JOB NAME: BACKPL02 JOB SCHEDULI NG DATES : 010601 - 300601
COMMAND ===> SCROLL===>
06 2001 MON TUE WED THU FRI SAT SUN
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
* * * * *




CMDS: NEXT, PREV, END 19. 30. 51
Tracking and Control Facility
164 CONTROL-M for OS/390 and z/OS User Guide
Tracking and Control Facility
The Tracking and Control facility provides relevant information about the status of
each job and task in the Active environment and enables you to manually intervene in
the processing of jobs.
The Active environment contains all the jobs in the Active Jobs file, that is, all jobs
that have recently executed, are currently executing, or are scheduled for possible
execution in the near future.
The main screen of the Tracking and Control facility is the Active Environment
screen, which displays a list of all jobs and their statuses in the Active environment.
The Active Environment screen is accessed by requesting option 3 on the IOA
Primary Option menu.
From the Active Environment screen you can request specific actions in relation to a
job, or request the display of other screens that provide additional information and
capabilities. Possible requests include
s Change the screen display type to display different information about the jobs in
the Active environment.
s View only jobs belonging to a specific group.
s View statistical information about all jobs in the Active environment.
s Display the reasons why a job has not executed.
s Place a job in Hold status.
s Delete a job from the Active environment.
Table 50 Job Scheduling Plan Screen Fields
Field Description
Job Name of the job for which the schedule is requested.
Range Requested date range, in mmddyy, ddmmyy, or yymmdd format,
depending on the site standard.
Month/ Year Month and Year currently displayed.
Calendar Calendar (day of the week and date) for the currently displayed
month.
Schedule An asterisk under a date indicates that the job is scheduled on that
day.
Tracking and Control Facility
Chapter 2 Online Facilities 165
s Delete a Group entity and all its jobs from the Active environment.
s Undelete a job that has been deleted from the Active environment.
s Free a held job.
s Display the log messages of a job.
s Zoom in on the scheduling details of a job and modify certain parameters.
s Rerun a job.
s Confirm the restart and/ or rerun of a job.
s View the list of all runs (job orders) of a particular job, and view the sysout of any
or all of those job orders.
s Display the execution statistics of a job.
s Display and edit the JCL of a job.
s Display the list or network of predecessor and successor jobs of a specific job, and
display critical path information.
s Force END OK termination of a job that has not been submitted or that ended
NOTOK.
s Reactivate a job that has disappeared or that has failed with status Reason
Unknown.
s Restart Display the list of archived jobs (in the History file) and restore desired
archived jobs to the Active environment. Restart
Tracking and Control Facility
166 CONTROL-M for OS/390 and z/OS User Guide
Active Environment Screen
To enter the Tracking and Control facility, select option 3 on the IOA Primary Option
menu. The Active Environment screen is displayed.
Figure 36 CONTROL-M Active Environment Screen
It is assumed that you want to see the most recently ordered jobs first. Therefore, by
default, the bottom of the Job list is displayed upon entry to the Active Environment
screen. This default can be altered by setting Profile variable SACTMOD to T, in
which case jobs are displayed from the top of the Job list. Profile variable SACTMOD
is described in the INCONTROL for OS/390 and z/OS Administrator Guide.
AutoRefresh mode is available in this screen.
To exit the Active Environment screen, press the END key (PF03/PF15).
For color terminals, jobs with different statuses are displayed in different colors. Each
of the colors in the following table has been defined as the default for one of these
statuses. These statuses are described more fully in Table 64, on page 2-193.
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - UP <D> ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - - St at us - - - - - - - - - - -
CI CSPROD M22 060601 CI CSPROD/ 04368 CST Execut i ng ( Run 1)
CI CSTEST M22 060601 CI CSTEST/ 04372 CST Execut i ng ( Run 2)
BRI VPCC I VP 060601 GRP Act i ve
BRCC0001 I VP 060601 BRCC0001/ 04382 JOB Hel d Wai t Schedul e
BRCC0002 I VP 060601 BRCC0002/ 04383 JOB Hel d Ended " OK" ( Run3)
Pr i or Run: Ended " OK"
BRCCI ND I VP 060601 BRCCI ND / 04385 JOB Ended " OK"
BRUPDT02 I VP 060601 BRUPDT02/ 04387 JOB Ended " OK"
BRREP002 I VP 060601 BRREP002/ 04389 JOB Ended " OK"
BRI VPCCE I VP 060601 / JOB Wai t Schedul e
CRCCEND I VP 060601 / JOB Wai t Schedul e
I NTR0001 M22 060601 / JOB Ended- Not " OK" Due t o CC -
Rer un Needed ( Run 3)
Pr i or Run: Ended- Not " OK" Due
t o CC - Rer un was Needed
I NTR0003 M22 060601 / JOB Wai t Schedul e
BRREP003 I VP 060601 BRREP003/ 04391 JOB Ended " OK"
BRREP004 I VP 060601 BRREP004/ 04393 JOB Ended " OK"
I NTR0004 M22 060601 I NTR0004/ 04397 JOB Ended- Not " OK" - Abended
Commands: OPt DI spl ay Show HI st or y RBal REFr esh Aut o Jobst at SHPF Not e Tabl e
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 15. 15. 48
NOTE
To change color definitions, see your INCONTROL administrator.
Tracking and Control Facility
Chapter 2 Online Facilities 167
Display Types of the Active Environment Screen
The information in the Active Environment screen can be displayed in different
formats or display types. A number of predefined display types are available.
While in the Active Environment screen, the display type can be changed by the
DISPLAY command. The DISPLAY command is described in Commands of the
Active Environment Screen on page 172.
The INCONTROL administrator can use display type support to tailor the display
layout by adding lines, fields, changing colors, and so on. Additional information
about display type support is provided in the section on customizing IOA display
format members in the INCONTROL for OS/390 and z/OS Administrator Guide.
Upon reentering the screen, the last used display type is displayed.
The Default and All Info predefined display types, and the fields they contain, are
discussed in Format of the Active Environment Screen on page 169.
Table 51 Default Colors for Active Missions Screen
Color Corresponding Status
Blue and White Jobs waiting to be scheduled
Yellow Jobs that are executing or about to execute
Red Jobs that are in error or ended NOTOK or LATE (submitted
and/ or executing jobs)
Green Jobs that ended OK or were forced OK
Pink Jobs that require special user action (such as Wait
Confirmation)
Table 52 Predefined Display Types
Type Description
D Default display type.
A All info display type.
N Network display type.
NOTE
The $$ACTDOC member in the IOA MSG library contains information that is useful
for customizing the CONTROL-M Active Environment screen and creating and
modifying display types for screens 3, 3.N, 3.G and the History Environment screen.
Tracking and Control Facility
168 CONTROL-M for OS/390 and z/OS User Guide
The Network display type, although available in this screen, is generally useful only
in the Job Dependency Network screen, and is described in Job Dependency
Network Screen on page 236.
Primary and Alternate Bottom Lines
The last two lines of the Active Environment screen are used to display the list of
available commands and options.
Because there are too many commands and options to list at once, the list is divided
into two parts, each part consisting of two lines, as follows:
s Upon entry to the screen, the set of available commands is displayed. Because this
list is displayed upon entry to the screen, it is referred to as the Primary Bottom
line.
s Upon request (using command OPT), the set of available options is displayed (in
place of the set of commands). The list of available options is referred to as the
Alternate Bottom line.
To toggle back and forth between the two sets of bottom lines, type OPT in the
COMMAND field and press Enter.
Available commands are described in Commands of the Active Environment
Screen on page 172. Available options are described in Options of the Active
Environment Screen on page 180.
Commands: OPt DI spl ay Show HI st or y RBal REFr esh Aut o Jobst at SHPF Not e Tabl e
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 15. 15. 48
Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 15. 46. 06
Tracking and Control Facility
Chapter 2 Online Facilities 169
Format of the Active Environment Screen
Display Type D (Default)
Below is an example of the Default display type. It contains the most relevant
information about the job.
Figure 37 Display Type D (Default)
Fields of Display Type D (Default)
Fi l t er : DEFAULT - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - UP <D> ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
CI CSPROD M22 060601 CI CSPROD/ 04368 CST Execut i ng ( Run 1)
CI CSTEST M22 060601 CI CSTEST/ 04372 CST Execut i ng ( Run 2)
BRI VPCC I VP 060601 GRP Act i ve
BRCC0001 I VP 060601 BRCC0001/ 04382 JOB Hel d Wai t Schedul e
BRCC0002 I VP 060601 BRCC0002/ 04383 JOB Hel d Ended " OK" ( Run3)
Pr i or Run: Ended " OK"
BRCCI ND I VP 060601 BRCCI ND / 04385 JOB Ended " OK"
BRUPDT02 I VP 060601 BRUPDT02/ 04387 JOB Ended " OK"
BRREP002 I VP 060601 BRREP002/ 04389 JOB Ended " OK"
BRI VPCCE I VP 060601 / JOB Wai t Schedul e
CRCCEND I VP 060601 / JOB Wai t Schedul e
I NTR0001 M22 060601 / JOB Ended- Not " OK" Due t o CC -
Rer un Needed ( Run 3)
Pr i or Run: Ended- Not " OK" Due
t o CC - Rer un was Needed
I NTR0003 M22 060601 / JOB Wai t Schedul e
BRREP003 I VP 060601 BRREP003/ 04391 JOB Ended " OK"
BRREP004 I VP 060601 BRREP004/ 04393 JOB Ended " OK"
I NTR0004 M22 060601 I NTR0004/ 04397 JOB Ended- Not " OK" - Abended
Commands: OPt DI spl ay Show HI st or y RBal REFr esh Aut o Jobst at SHPF Not e Tabl e
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 15. 15. 48
Table 53 Fields in the Default Display Type
Field Description
Filter Name of the currently active screen filter. For more
information, see Filtering the Active Environment Screen
Display on page 189.
CONTROL-M
Status
Indicator of whether CONTROL-M monitor is UP, DOWN or
SUSP (suspended).
Display Type Indicator of the currently used display type, such as D for the
Default display type.
Tracking and Control Facility
170 CONTROL-M for OS/390 and z/OS User Guide
The following is displayed for each job:
The information in the following table can be displayed by request, along with the
STATUS information. For more information, see Commands of the Active
Environment Screen on page 172.
Table 54 Fields for Each Job Default
Field Description
O(ption) Field for requesting options to be activated on jobs.
Name Name of the member containing the JCL of the job, or name of
the started task.
Owner ID of the owner of the job.
Odate Original scheduling date of the job. For more information, see
Date Definition Concepts on page 62.
Jobname Job name generally available only after job submission.
JobID Job number generally available only after job submission.
Typ Task type or GRP.
Status Job (task) status, For more information, see Job Statuses on
page 185.
Table 55 Other Information in the STATUS Field
Type Descriptions
GROUP Group name of the job, discussed in Chapter 3, Job
Production Parameters.
CPU ID of the CPU on which the job is executing or has executed.
The CPU ID is displayed only for those jobs subjected to
dynamic resource acquisition (that is, jobs for which
CONTROL-M dynamically decided to which CPU they would
be submitted). Dynamically acquired resources are identified
by a $ character in the Quantitative resource name. For more
information, see CPUID on page 177.
OrderID Order ID of the job. For more information, see ORDERID on
page 179.
Desc Job description. For more information, see DESC on
page 131.
Table Scheduling library and table of the job. For more information,
see TABLE on page 176.
Note First line of the note (if one exists). For more information, see
NOTE on page 187.
Tracking and Control Facility
Chapter 2 Online Facilities 171
Display Type A (All Info)
The following is an example of the All Info display type. In addition to the Default
information, it contains statistical information about the job run.
Figure 38 Display Type A (All Fields)
Fields of the Display Type A (All Info)
Below is a description of fields in the All Info display type that do not appear in the
Default display type. The fields that appear in the Default display type are described
in the preceding section.
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
TO5SP115 TO5 060601 / JOB Wai t Schedul e Gr oup=NRD- GRP
CPU=A Or der I D=0003E ===>BACKUP
SCHED- LI B=CTM. PROD. BKP( SPBKP)
* * * Not e * * *
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - DOWN <A> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
DAI LYPRD PRODMNGR 060601 JOB Wai t Schedul e
Or der I D 001Q6 Gr p CTM- CONTROL
MaxRC Res. Use: Y
Ti me Fr : Ti me Un: Pr i or i t y: 00
Due- I n: 0859 Due- Out : 0859 Lat e:
Avg El aps: 0000 RBA: 000002
DAI LYSYS SYSTEM 060601 JOB Wai t Schedul e
Or der I D 001Q7 Gr p CTM- CONTROL
MaxRC Res. Use: Y
Ti me Fr : Ti me Un: Pr i or i t y: 00
Due- I n: 0859 Due- Out : 0859 Lat e:
Avg El aps: 0000 RBA: 000003
CTMLDNRS PRODMNGR 060601 JOB Wai t Schedul e
Or der I D 001Q8 Gr p CTM- CONTROL
MaxRC Res. Use: Y
Ti me Fr : Ti me Un: Pr i or i t y: 00
Due- I n: 0859 Due- Out : 0859 Lat e:
Avg El aps: 0000 RBA: 000004
CTMCLRES PRODMNGR 060601 JOB Wai t Schedul e
Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 14. 50. 56
Table 56 Fields in the All Fields Display Type (Part 1 of 2)
Field Description
Grp Name of the group.
MaxRC Highest return code returned for the job.
Res. Use Indicates (yes or no) whether the job uses (Control and/ or
Quantitative) resources.
Time Fr Time the job began execution.
Tracking and Control Facility
172 CONTROL-M for OS/390 and z/OS User Guide
Commands of the Active Environment Screen
The commands in the following table can be requested by typing the command in the
COMMAND field of the Active Environment screen and pressing Enter.
Time Un Time the job ended execution.
Priority Priority at which the job executed.
Due-In Time by which the job was to be submitted.
Due-Out Time by which the job execution must complete.
Late Indicates if the job is late. Valid (Late) values:
s I Late In - the job was submitted late
s X Late Execution - the job execution time was outside
predefined limits
s O Late Out - the job ended outside the predefined time
limit
Avg Elaps Average elapsed run time of the job.
RBA Relative Byte address of the job in the Active Jobs file.
Table 57 Commands of the Active Environment Screen (Part 1 of 8)
Command Description
OPT Toggles between the Primary Bottom line (composed of most
of the available Primary commands) and the Alternate Bottom
line (composed of all available options).
Table 56 Fields in the All Fields Display Type (Part 2 of 2)
Field Description
Tracking and Control Facility
Chapter 2 Online Facilities 173
DISPLAY Used to change display types. The format of the command is
DI SPLAY x ( abbr evi at ed DI x)
where x is the desired display type. For example, DI A
displays the All Info display type.
Note: For a list of display types, enter DISPLAY ? to show the
Display Options window. To select a display type in the
window, type S in the Option field next to the ID. To exit the
window without selecting a display type, press the END key
(PF03/PF15).
Example
DI N
displays the Net fields display.
Valid predefined displays are:
s D Default Display Type. For more information, see
Display Type D (Default) on page 169.
s N Net Fields Display Type. For more information, see
Display Type N (Network) on page 237.
s A All Fields Display Type. For more information, see
Display Type A (All Info) on page 171.
Table 57 Commands of the Active Environment Screen (Part 2 of 8)
Command Description
Tracking and Control Facility
174 CONTROL-M for OS/390 and z/OS User Guide
SHOW
Activates the specified screen filter, or opens the Show Screen
Filter window or the Display Filters window, depending on
the format of the command. For more information, see
Filtering the Active Environment Screen Display on
page 189.
Valid formats are:
s SHOW name Activates the selected filter.
s SHOW ? Opens the Display Filters window that lists all
available filters.
s SHOW (PF02/PF14) Opens the Show Screen Filter
window, displaying the settings of the currently active
filter. This enables editing of the selected filter.
s SHOW name EDIT Opens the Show Screen Filter
window of the selected filter, displaying its settings. This
enables editing of the selected filter.
Note: Reserved filter name DEFAULT can be used to activate
or edit the default filter for the Active Environment screen.
Only jobs conforming to selection criteria specified in the filter
are displayed in the Active Environment screen
HISTORY Displays the jobs in the History Jobs file in the History
Environment screen, which is described in Restart History
Environment Screen on page 239.
RBAL Scrolls the Active Environment screen so that the job with the
specified relative byte address (RBA) is displayed at the top of
the screen.
The format of the command is
RBAL r ba ( abbr evi at ed RB r ba)
where rba is the relative byte address of the job.
This command is especially useful for determining which job
is using a particular resource. The RBA of the job using a
resource is indicated in the IOA Conditions/ Resources screen
(Screen 4).
Table 57 Commands of the Active Environment Screen (Part 3 of 8)
Command Description
Tracking and Control Facility
Chapter 2 Online Facilities 175
REFRESH Initiates recalculation of job dependency information.
The recalculation
s updates the list of dependent jobs in the Job Dependency
Network screen, recalculates logical dependencies for all
job orders currently present in the Active Jobs file and
updates the Job Dependency Network screen
s adjusts DUE OUT times for all job orders in the Active Jobs
file that are not Held
s adjusts the priority of predecessor jobs
s simultaneously activates processes NET, DEADLINE, and
PROPAGATE in the CONTROL-M monitor
Note: Although available in the Active Environment screen,
this command is generally used in the Job Dependency
Network screen.
AUTO Activates AutoRefresh mode.
The format of the command is
AUTO n
where n is any number of seconds within the range 1 through
99. For more information, see AutoRefresh Mode on
page 101
JOBSTAT Displays the Statistics screen, which provides statistics for the
specified job. For more information, see Statistics Screen on
page 233.
Unlike Option S (STAT), which can be entered only for jobs
appearing in the Active Environment screen, the JOBSTAT
command can be entered for any job. Format of the command
is
JOBSTAT j obname gr oupname
Specification of a group name is optional, but if no group
name is specified, statistics are displayed only for jobs not
belonging to any group.
SHPF Displays the PFKey assignment of the screen. For more
information, see Commands and PFKeys on page 93
Table 57 Commands of the Active Environment Screen (Part 4 of 8)
Command Description
Tracking and Control Facility
176 CONTROL-M for OS/390 and z/OS User Guide
NOTE Displays or hides the first line of a note (if one exists).
The format of the command is
NOTE { ON| OFF}
where
s ON Displays the first line of the note
s OFF Hides the note
If no ON of OFF qualifier is entered, the NOTE command
toggles between displaying and hiding the first line of the
note.
The current setting is kept in the user profile for the next time
the screen is displayed.
TABLE Displays or hides the name of the job scheduling library and
table from which the job was ordered.
The format of the command is
TABLE { ON| OFF}
where
s ON displays the name of the job scheduling library and
table
s OFF hides the name of the job scheduling library and
table
If no ON of OFF qualifier is entered, the TABLE command
toggles between displaying and hiding the name of the job
scheduling library and table.
The current setting is kept in the user profile for the next time
the screen is displayed.
Table 57 Commands of the Active Environment Screen (Part 5 of 8)
Command Description
Tracking and Control Facility
Chapter 2 Online Facilities 177
CPUID Displays or hides the CPU ID of jobs subjected to dynamic
resource acquisition. When displayed, the CPU ID on which
the job is running (or executed on) appears after the job status.
The format of the command is:
CPUI D { ON| OFF}
where:
s ON displays the CPU ID
s OFF hides the CPU ID
If no ON or OFF qualifier is entered, the CPUID command
toggles between displaying and hiding the CPU ID.
The current setting is kept in the user profile for the next time
the screen is displayed.
DESC Displays or hides the description of each job.
The format of the command is:
DESC { ON| OFF}
where
s ON Displays the description
s OFF Hides the description
If no ON or OFF qualifier is entered, the DESC command
toggles between displaying and hiding the description.
The current setting is kept in the user profile for the next time
the screen is displayed.
Table 57 Commands of the Active Environment Screen (Part 6 of 8)
Command Description
Tracking and Control Facility
178 CONTROL-M for OS/390 and z/OS User Guide
DUMP Used in special circumstances when requested by BMC
Software Customer Support. The command is used to capture
abends resulting from either internal or external events.
The format of the command is:
DUMP { ON| OFF}
where
s ON provides a DUMP
s OFF does not provide a DUMP
If no ON of OFF qualifier is entered, the DUMP command
toggles between providing and not providing a DUMP.
The current setting is kept in the user profile for the next time
the screen is displayed.
When DUMP ON is requested, the DUMP ON indicator is
displayed in the first line of the screen.
GROUP
(PF11/PF23)
Displays or hides the group name. When displayed, the name
of the group appears after the job status.
The format of the command is:
GROUP { ON| OFF}
where:
s ON displays the group name
s OFF hides the group name
If no ON or OFF qualifier is entered, the GROUP command
toggles between displaying and hiding the group name.
The current setting is kept in the user profile for the next time
the screen is displayed.
Table 57 Commands of the Active Environment Screen (Part 7 of 8)
Command Description
Tracking and Control Facility
Chapter 2 Online Facilities 179
OIDL Scrolls the Active Environment screen so that the job with the
specified order-ID is displayed at the top of the screen.
The format of the command is:
OI DL or d_I D
where or d_I D is the or der - I D of the job.
ORDERID Displays or hides the order ID of each job.
The format of the command is:
ORDERI D { ON| OFF}
where:
s ON Displays the order ID
s OFF Hides the order ID
If no ON of OFF qualifier is entered, the ORDERID command
toggles between displaying and hiding the order ID.
The current setting is kept in the user profile for the next time
the screen is displayed.
VIEW
(PF04/PF16)
Displays the Global View screen, which provides a statistical
overview of the status of jobs running under CONTROL-M.
For more information, see Global View Screen on page 198.
VIEW GRAPH
(VG)
Displays the View Graph screen, which provides a graphic
statistical overview of the status of jobs running under
CONTROL-M. For more information, see View Graph
Screen on page 200.
Table 57 Commands of the Active Environment Screen (Part 8 of 8)
Command Description
Tracking and Control Facility
180 CONTROL-M for OS/390 and z/OS User Guide
Options of the Active Environment Screen
Select an option by typing it in the O (Option) field to the left of the job order and
pressing Enter. The following table describes the available options:
Table 58 Options of the Active Environment Screen (Part 1 of 5)
Option Description
? (Why) Display the Why screen, which shows the reasons the job is in
Wait Schedule status. For more information, see Why Screen
on page 205.
L (Log) Display the Log screen, which shows all IOA Log messages for
the specified job. For more information, see IOA Log Screen
on page 290.
H (Hold) Hold CONTROL-M operations on the job order. Only
CONTROL-M operations concerning the job order are halted.
The flow of the job through the operating system is not held.
The HOLD request is recorded in the IOA Log file. The status
of the job is changed to REQUESTED HELD. If the
CONTROL-M monitor is active, the status changes to HELD.
In some cases, a HOLD request may be rejected by the
monitor.
Z (Zoom) Display the Zoom screen, which zooms in on job details. For
more information, see Zoom Screen on page 213.
R (Rerun) Rerun the job. A Rerun window is displayed. For more
information, see Confirm Rerun Window on page 222.
A (Activate) Reactivate a job or started task that has a status of either
DISAPPEARED or FAILED REASON UNKNOWN.
CONTROL-M searches the MVS/ JES queues for the
disappeared or failed job or started task.
A job or started task is assigned a DISAPPEARED status if it
has been accidentally deleted. Also, if JES is very busy, it
sometimes sets the status of a job or started task to
DISAPPEARED even though the job or started task actually
exists.
A job or started task is assigned a status of FAILED REASON
UNKNOWN whenever CONTROL-M encounters a problem
reading the SYSDATA files of the job and therefore cannot
check the completion status of the job.
O (Force OK) Force the job to complete with ENDED OK status. For more
information, see Force OK Confirmation Window on
page 241.
Tracking and Control Facility
Chapter 2 Online Facilities 181
Restart V (View
Sysout)
View the execution history of the job in the Job Order
Execution History screen. From this screen, the Sysout
Viewing screen, which displays the archived SYSDATA of the
job, can be requested. For more information on these screens,
see RestartJob Order Execution History Screen on
page 229, and Restart Sysout Viewing Screen on page 231.
N (Net) Display the Job Dependency Network screen, which shows all
the predecessor and successor jobs for the selected job. For
more information, see Job Dependency Network Screen on
page 236.
D (Del) Delete the job. For more information, see Delete Confirmation
Window on page 210.
Note: If you delete a Group entity, all jobs which are part of
that Group are also deleted.
F (Free) Free a held job order. All CONTROL-M operations for the job
order are resumed. If the job is currently in the job queue of the
operating system in HOLD state, the job is not released. The
FREE request is recorded in the IOA Log file. The status of the
job is changed to REQUESTED FREE. If the monitor is active,
the FREE request is accepted after a few seconds.
S (Stat) Display the Statistics screen, which shows job run statistics.
Statistics for a job that is not in the Active environment can be
displayed using command JOBSTAT. For more information,
see Statistics Screen on page 233.
G (Group) Display the Group Entity (GRP entry) and all jobs that are part
of that group. This option can be entered next to a GRP entry,
or next to any job that is part of a group. Jobs that are part of a
group are marked with the letter G to the right of the group
name under display type A.
Option G must be entered as the last option in the screen.
When the Group option is requested, the name of the selected
group appears in the title line of the screen.
U (Undelete) Cancel a previously requested Delete. Valid only for jobs
deleted by request. The job is returned to its status prior to the
delete request.
Note: If you undelete a job that is part of a deleted Group, the
Group entity is undeleted, together with the individual job.
However, if you undelete a deleted Group, only the Group is
undeleted, and not the jobs in the Group. If you want also to
undelete a job or jobs that are part of that Group, you must
undelete each job individually.
Table 58 Options of the Active Environment Screen (Part 2 of 5)
Option Description
Tracking and Control Facility
182 CONTROL-M for OS/390 and z/OS User Guide
J (JCL Edit) Edit the member that contains the JCL of the job.
By default, if the specified JCL member exists in the OVERLIB
library, that member is edited. If the JCL member does not
exist in the OVERLIB library, the member is edited in the
MEMLIB library.
C (Confirm) Confirm that this job is to be scheduled. A window is
displayed to permit user confirmation. Entering Y sets the
status of the job to WAIT SCHEDULE. For more information,
see Confirm Scheduling Window on page 221.
% (Simulation) Simulates the action of the CONTROL-M Submission
mechanism for a job that was previously placed in the Active
Jobs file. This option is similar to the CTMAESIM utility,
which is described in the section concerning testing AutoEdit
syntax in Chapter 5, JCL and AutoEdit Facility. The option
produces the JCL stream for the job and a report of the process.
The IOA Editor directs the output of the AutoEdit simulation
to the users screen, with the following header line displayed:
CONTROL- M_AUTOEDI T_SI MULATI ON( memname)
where memname is the name of the JCL member of the job.
The report consists of two parts:
s the messages produced by CONTROL-M during the
simulated job processing
s the JCL stream as it would be submitted by the
CONTROL-M Monitor to the MVS internal reader if the job
is rerun
The user can use the IOA editor to edit the output, and save it
as a member in a library.
Notes:
s For DUMMY jobs, no JCL stream is generated.
s To activate this function, the user must have read-access
security authorization to the JCL library (MEMLIB).
Table 58 Options of the Active Environment Screen (Part 3 of 5)
Option Description
Tracking and Control Facility
Chapter 2 Online Facilities 183
B (Bypass) Displays the BYPASS option window. This option enables you
to specify criteria and resources to be ignored for those jobs
that have a status of WAIT SCHEDULE.
By default, all fields in the BYPASS option window are set to
N.
You may set any or all these fields to Y, with the following
effects:
s Time Limit All the time limit selection criteria of the job,
such as TIME FROM, TIME UNTIL, DUE OUT, and NEXT,
are ignored. The job is submitted when all other criteria are
satisfied.
s IN Conditions All IN conditions of the job are ignored.
The job is submitted when all other criteria are satisfied.
s Quantitative Resources All quantitative resources of the
job are ignored. The job is submitted when all other criteria
are satisfied.
s CONTROL Resources All CONTROL resources of the job
are ignored. The job is submitted when all other criteria are
satisfied.
s Pipes All PIPE statements of the job are ignored. The job
is removed from the pipe sharing job collection of which it
is part, and is submitted when all other criteria are
satisfied.
s JCL The member and library specified in the
MEMNAME, MEMLIB, and OVERLIB statements of the
job are ignored. When all run-time criteria are satisfied, a
dummy job is submitted.
Note: When BYPASS JCL is specified, CONTROL-M
handles post-processing of the job as if it were a dummy
job and will ignore all ON PGMSTEP pgmstep DO blocks
in the job.
Table 58 Options of the Active Environment Screen (Part 4 of 5)
Option Description
Tracking and Control Facility
184 CONTROL-M for OS/390 and z/OS User Guide
B (Bypass) cont
s All BYPASS options Enters Y in all the fields in the
BYPASS option window.
When any BYPASS option has been set to Y, the status field
of the job in the Active Environment Screen will show that
the BYPASS feature is in use, with the relevant activated
field identified. For example, the status may show
BYPASS(Time + IN + QUANT), to indicate that the Time
Limit, IN Conditions, and Quantitative Resources fields
were set to Y, and that those criteria are being ignored.
If you set any field in the BYPASS window to Y, that
setting only remains valid for the current run of the job.
When the job is rerun or restarted, all BYPASS fields are
reset to N.
s Using BYPASS does not require that the job be HELD. It is
therefore possible that by the time CONTROL-M comes to
handle the BYPASS request, the status of the job may no
longer be WAIT SCHEDULE. If this occurs, the monitor
ignores the BYPASS setting, and issues an appropriate
message to the IOA log.
Warning: You cannot perform BYPASS unless authorized to
ZOOM and SAVE the job.
W
(MVBO/
Job Optimizer)
Display the MVBO/ Job Optimizer screen for the selected job.
Valid only for jobs under the control of MAINVIEW Batch
Optimizer (MVBO). The MVBO/ Job Optimizer screen is
described in the MAINVIEW Batch Optimizer/Job Optimizer
Reference Manual.
Table 58 Options of the Active Environment Screen (Part 5 of 5)
Option Description
Tracking and Control Facility
Chapter 2 Online Facilities 185
Job Statuses
The following job statuses can appear in the Active Environment screen:
Table 59 Job Statuses for the Active Environment screen (Part 1 of 4)
Status Description
ACTIVE The job is a dummy job that has not yet reached
the post-processing phase.
BUT NOT FOUND n TIMES If a job is not found at least once, this status
displays the number of times (n) CONTROL-M
has looked for the job. If the job is still not found
after 10 times, the status is changed to
DISAPPEARED.
Example
JOB SUBMI TTED BUT NOT FOUND 5 TI MES
The job was submitted, but may have been
purged. After checking 10 times, CONTROL-M
changes the status to DISAPPEARED.
Note: This default number can be changed by
your INCONTROL administrator.
Restart CLEANUP Job is being run for Cleanup.
DELETED The job order was deleted by an authorized
user.
DISAPPEARED Job disappeared completely. This status only
occurs after a NOT FOUND status.
ENDED NOT OK Job ended NOT OK.
ENDED NOT OK ABENDED Job abended.
ENDED NOT OK DUE TO CC Condition code that is not defined as OK has
occurred.
ENDED NOT OK FAILED
REASON UNKNOWN
This usually occurs following a system crash.
ENDED NOT OK JCL ERROR Job failed due to JCL error.
ENDED NOT OK RERUN
NEEDED
Rerun is needed for the job.
ENDED NOT OK RERUN
WAS NEEDED
Rerun was required for the previous execution
of the job.
ENDED NOT OK TERM ON
NCT2
The job was terminated by CONTROL-M due to
a NOT CATLGD 2 error.
ENDED OK Job finished executing OK.
ENDED OK FORCED OK Job ended OK due to a Force OK request.
Tracking and Control Facility
186 CONTROL-M for OS/390 and z/OS User Guide
EXECUTING Job is executing.
EXECUTING (SYSOUT IN HOLD
STATUS)
Job was placed in HOLD status by an operator
issued JES HOLD command before
CONTROL-M could read the jobs output.
GOING TO START Started task is eligible to be run and is about to
be activated.
(GRP HELD) The Group entity of which the job is part is in
Held status, and as a result, the job itself is being
logically held. (While the jobs Group entity is
being held, actions that require a Held status,
such as Delete, Zoom, and Save, can be
performed against the job. In addition, the
CONTROL-M monitor does not handle the job.
For example, if the job is in WAIT SCHEDULE
status it is not selected for submission.)
HELD Job is in hold status.
LATE Job did not finish executing by the time
specified in a SHOUT WHEN LATE statement.
LATE EXECUTION The elapsed runtime of the job is outside the
acceptable limits defined in a SHOUT WITHIN
EXECTIME statement.
LATE SUBMISSION Job was not submitted by the time specified in a
SHOUT WHEN LATESUB statement.
NJE JOB The job is not currently found in either Remote
or Host node, but is in the process of
transmission between nodes. (Either the job is
being transmitted to the Remote node for
execution, or the sysdata output of the job is
being transmitted to the Host node.)
CONTROL-M continues to search for the job
until it is located on one of the nodes.
BMC Software recommends that you do not
purge jobs on the Remote node. However, if you
do purge a job on the Remote node, you must
notify CONTROL-M of the event by changing
the value in the NJE field in the Active
Environment Zoom screen (Screen 3.Z) to
' ' (Blank). After a short time, the job status
changes to Disappeared.
Table 59 Job Statuses for the Active Environment screen (Part 2 of 4)
Status Description
Tracking and Control Facility
Chapter 2 Online Facilities 187
NJE JOB (ID CHANGED) The job ID of the NJE job has changed. When
the jobs sysdata output was transmitted back to
the Host NJE node, the CONTROL-M monitor
detected that the original job ID of the NJE job is
occupied by another job. The CONTROL-M
monitor continues to search for a job to match
the new job ID.
NOT FOUND Job not found in the queue. Check that the job or
its sysout has not been accidentally deleted.
This status may also appear when JES is very
busy. In such a case, CONTROL-M waits for JES
until it confirms that the job is lost.
NOT STARTED Starting of the started task failed.
NOT SUBMITTED Submission of the job failed.
NOTE A Note has been added to the job, through the
Zoom screen.
ON OUTPUT QUEUE Job is on the output queue of the remote NJE
node or on the output queue of the host node
with a changed job ID.
PRIOR RUN Termination status of the previous job (or cyclic
task) execution (for jobs that have been rerun).
PROBLEMS READING SYSOUT Usually means that problems prevent the
CONTROL-M monitor from reading the jobs
output.
PSEUDO At the time when the job was ordered,
CONTROL-M automatically converted it to a
DUMMY job.
RELEASED On Spool job has been released and is waiting to
be executed.
REQUESTED CHANGE Job parameters were changed using the Zoom
option, but the request has not yet been
performed by the CONTROL-M monitor.
REQUESTED FORCE OK A Force OK request was issued for a held job,
but the request has not yet been performed by
the CONTROL-M monitor.
REQUESTED FREE A free request was issued for a held job, but the
request has not yet been performed by the
CONTROL-M monitor.
REQUESTED HELD A hold request was issued for the job, but the
request has not yet been performed by the
CONTROL-M monitor.
Table 59 Job Statuses for the Active Environment screen (Part 3 of 4)
Status Description
Tracking and Control Facility
188 CONTROL-M for OS/390 and z/OS User Guide
REQUESTED REACT An activate request was issued for a job, but the
request has not yet been performed by the
CONTROL-M monitor.
REQUESTED RERUN A rerun request was issued for the job, but the
request has not yet been performed by the
CONTROL-M monitor.
Restart RESTARTED) Job has run (executed) with the restart step
under CONTROL-M/ Restart (that is, a restart
has been performed).
RESTORED This job was restored from the History file.
If this status is displayed in the History
Environment screen, the job has been restored,
rerun, and then copied to the History file as part
of the New Day or a User Daily procedure.
RUN n Run number. Incremented each time a cyclic
task is executed or a job is rerun.
STARTED Started task started, but is not yet in the
operating systems job queue.
SUBMITTED Job submitted, but is not yet in the operating
systems job queue.
WAIT CONFIRMATION (FOR
SCHEDULE)
Job is waiting for manual confirmation before it
can be scheduled.
Restart WAIT
CONFIRMATION (WITH
RESTART)
Job is waiting for manual restart confirmation.
WAIT EXECUTION Job is in the operating systems job queue
waiting to be executed.
WAIT RELEASE On Spool job is eligible to be run and is about to
be released.
WAIT SCHEDULE Job is waiting to be scheduled.
WAIT SCHEDULE ON SPOOL Job is waiting to be scheduled but is already in
input queue on spool.
WAIT SCHEDULE (PIPE) For MAINVIEW Batch Optimizer (MVBO)
users. Job is waiting to be scheduled and is a
participant in a Pipe (Collection).
WAIT SUBMISSION Job is eligible to be run and is about to be
submitted.
Restart (WITH RESTART) The restart step under CONTROL-M/ Restart
will be added to the JCL of the job when the job
is submitted (that is, a restart will be
performed).
Table 59 Job Statuses for the Active Environment screen (Part 4 of 4)
Status Description
Tracking and Control Facility
Chapter 2 Online Facilities 189
Group Statuses
The following Group statuses can appear for the group entity in the Active
Environment screen:
Filtering the Active Environment Screen Display
Screen filters may be used to filter the Active Environment screen display.
A filter consists of a set of record selection criteria (selection fields and their values).
Only records that conform to selection criteria specified in the filter are displayed on
the screen.
The INCONTROL administrator may predefine filters and place them in the General
profile.
Each user can activate an existing filter in the Active Environment screen by typing
the command SHOW in the COMMAND line of the Active Environment screen.
The filtering feature utilizes two different windows, the Show Screen Filter window
and the Display Filters window:
Table 60 Group Statuses for the Active Environment Screen
Status Description
ACTIVE All runtime criteria for the Group entity have been satisfied,
but at least one job in the group has not ended and no job in
the group has ended NOTOK.
ACTIVE - IN
ERROR
All runtime criteria for the Group entity have been satisfied,
but at least one job in the group has not ended and one or
more jobs in the group ended NOTOK.
ENDED NOTOK All jobs in the group have ended. At least one job ended
NOTOK.
ENDED OK All jobs in the group ended OK.
(ORDERING) A Group entity has been ordered to the Active Jobs file, but
not all of its jobs have been placed in the Active Jobs file, or
connected to the Group entity. The ORDERING status
disappears when all jobs in the Group appear in the Active
Jobs file and are connected to the Group. Status ORDERING
is an add-on to the Groups regular status.
REQUESTED
DELETE
A delete request was issued for the Group entity, but the
request has not yet been performed.
Tracking and Control Facility
190 CONTROL-M for OS/390 and z/OS User Guide
s Each user can define and name multiple filters for the screen by using the Show
Screen Filter window, which is described in Editing Filter Criteria on page 192.
User-defined filters are stored in the user profile. Filters that are kept in the user
profile can be activated only by the user who defined the filter.
s Users can display the list of all available filters by opening the Display Filters
window.
A predefined default filter (DEFAULT) is supplied for the Active Environment
screen. Site-defined defaults determine whether the last filter used or the DEFAULT
filter is activated upon reentry to the Active Environment screen.
Activating a Known Filter in the Active Environment screen
The SHOW command may be used to activate an existing filter when you know the
filter name. To activate an existing filter in the Active Environment screen, type the
command SHOW in the COMMAND field, as follows:
where name is the name of the filter to be activated.
Displaying the List of Available Filters
If you do not know the name of a filter, you can display the list of available filters in
the Display Filters window. The display includes Global filters that are available to all
users, and user-defined filters that are only available to the individual user.
You can then select a filter from the Display Filters window for activation or editing.
To open the Display Filters window, type the command SHOW ? in the COMMAND
field. The Display Filters window is opened.
SHOWname
NOTE
Filters that are included with CONTROL-M are those appearing in the Display Filters
window. These system-provided filters do not display descriptions.
Tracking and Control Facility
Chapter 2 Online Facilities 191
Figure 39 IOA Log Screen Display Filters Window
The Display Filters window displays the following information:
To select a filter in the list for activation or editing, type the appropriate option in the
O (Option) field to the left of the filter name, and press Enter.
Fi l t er : DEFAULT - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - DOWN <D> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
CI CSPR M96 270601 JOB Hel d Wai t Schedul e ( Pi pe)
CI CSPR M96 270601 JOB Hel d Wai t Schedul e ( Pi pe)
BRI VPC M96 270601 JOB Hel d Wai t Schedul e ( Pi pe)
KA +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + JOB Hel d Wai t Schedul e ( Pi pe)
KA | DI SPLAY FI LTERS | JOB Hel d Wai t Schedul e ( Pi pe)
DE | CMD ==> SCROLL==> CRSR | GRP Hel d Act i ve
NO | O NAME DESCRI PTI ON | JOB Hel d Ended " OK" For ced OK
DA | CONFI RM WAI T CONFI RM. JOBS | JOB Hel d Ended- " OK"
DE | DEL ONLY DELETED JOBS | GRP Act i ve
I O | END ALL ENDED JOBS | JOB Hel d Ended " OK"
I E | ENDNOTOK ENDED NOT- OK JOBS | JOB Hel d Wai t Schedul e
DA | ENDOK ENDED OK JOBS | JOB Wai t Schedul e
DA | EXEC EXECUTI NG JOBS | JOB Wai t Schedul e
CT | LATE LATE JOBS | JOB Wai t Schedul e
CT | WAI T JOBS ON WAI T QUEUE | JOB Wai t Schedul e
I E | ECSALL ALL JOBS I N AJF | JOB Ended " OK"
NO | =========>>> BOTTOM <<<========== | JOB Wai t Schedul e
NO | | JOB Wai t Schedul e
NO | OPTI ONS S SELECT E EDI T | JOB Wai t Schedul e
Comm +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + r esh Aut o Jobst at SHPF Not e Tabl e
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 15. 21. 28
Table 61 Field of the Display Filters Window
Field Description
NAME Name of the filter as it appears in the General or user profile.
DESCRIPTION Description of the filter.
NOTE
When you create a user-defined filter and provide a description for that filter, the
filter, and its description, are both displayed in the Display Filters window.
Table 62 Options of the Display Filters window
Option Description
S (SELECT) Activate the filter. The display of jobs in the Active
Environment screen is filtered according to the filter criteria.
E (EDIT) Display the filter's filtering criteria in the Show Screen Filter
window to enable editing of the filter.
Tracking and Control Facility
192 CONTROL-M for OS/390 and z/OS User Guide
Editing Filter Criteria
The Show Screen Filter window enables you to create or modify a filter.
s To open an existing filter for editing, either:
Type SHOW name EDIT in the Active Environment screen, where name is the
name of the filter.
Type E (Edit) next to the filter name in the Display Filters window and press
Enter.
s To edit the currently active filter, it is unnecessary to type the name or Edit. Just
type SHOW in the COMMAND field and press Enter, or press PF02/PF14.
s To create a new filter, open any existing filter and enter a new name and
description in the FILTER and DESC fields, which are described in Table 63 on
page 193.
The Show Screen Filter window is displayed:
Figure 40 Show Screen Filter Window
Fi l t er : DEFAULT - - - - - - CONTROL- M Act i ve Envi r onment - - - - - UP <D> - ( 3)
COMMAND ===> +- - - - - - - - - - - - - - - - - - Show Scr een Fi l t er - - - - - - - - - - ( 3. SHOW) +
O Name Owner | Fi l t er DEFAULT Save ( Y/ N) Desc: |
TST144 TEST | Memname |
TST57 TEST | Gr oup |
TST84 TEST | |
TST43 TEST | I n Pr ocess Y | Ended Y | St at e Y |
TST71 TEST | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - |
TST453 TEST | Wai t Sched Y | Ended " OK" Y | Fr ee Y |
TST44 TEST | Wai t Conf i r m Y | Not " OK" Y | Hel d Y |
TST85 TEST | Wai t SUB Y | Rer un Y | On Request Y |
TST72 TEST | Submi t t ed Y | Di sappear ed Y | Del et ed N |
PRD1 PROD | Wai t Exec Y | Abended Y | Lat e ONLY N |
| Execut i ng Y | Unexpect ed CC Y | Pseudo N |
PRD2 PROD | On Out put Que Y | JCL Er r or Y | |
| Task Type: Job Cyc Emr St c Cst Est Ecj Ecs Wr n Gr p |
PRD3 PROD | Y Y Y Y Y Y Y Y Y Y |
| Res Name |
DAI LYPRD PRODMNG | Resour ce Type: I n Y Out Y Conds Y Resour ce Y Cont r ol Y|
DAI LYSYS SYSTEM | Owner |
CTMLDNRS PRODMNG | Odat e: Fr om To Pr i or i t y |
CTMCLRES PRODMNG | Pi pe : |
Commands: OPt DI sp +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 12. 25. 21
NOTE
Depending on user profile definition, the Late ONLY field may be replaced by the Late
field.
Tracking and Control Facility
Chapter 2 Online Facilities 193
Fields of the Show Screen Filter Window
The Show Screen Filter window contains the following fields:
The fields listed in Table 64 define the selection criteria to be applied to the screen. Fill
in these selection criteria as desired.
Table 63 Fields of the Show Screen Filter Window
Field Description
Filter User-assigned name of the filter.
The name entered in the Filter field may be modified.
If there are unsaved changes to a filter in memory (discussed
in Closing the Show Screen Filter Window on page 197), an
asterisk appears to the right of the filter name.
Save (Y/ N) Specifies whether to save modifications to the filter upon
closing the window.
Desc: User-defined description of the filter. The description entered
here appears next to the name in the Display Filters window.
NOTE
The selection criteria shown in Table 64 marked with the symbol
P
act on a prefix
basis. For example, entering value D4 in the MEMNAME field results in the retrieval
of all members (jobs) whose names start with D4.
Table 64 Show Screen Filter Window Selection Criteria (Part 1 of 5)
Criterion Description
MemnameP Show only jobs of the specified member name. A maximum of
five member names may be specified.
GroupP Show only jobs of the specified group. A maximum of four
groups may be specified.
Tracking and Control Facility
194 CONTROL-M for OS/390 and z/OS User Guide
status Select only jobs that conform to the status selection criteria.
Statuses are divided into three groups under the following
headings: In Process, Ended, and State.
For statuses under the In Process and Ended columns, the
following logic applies:
s Typing Y in the column heading enables further filtering of
jobs on a status-by-status basis. Typing Y in a field in this
column enables all jobs with this status to be shown, while
typing N in a field in this column prevents jobs with that
status from being shown.
s Typing N in the column heading filters out any job with a
status listed under that heading, even if the status is
marked Y.
Table 64 Show Screen Filter Window Selection Criteria (Part 2 of 5)
Criterion Description
Tracking and Control Facility
Chapter 2 Online Facilities 195
status (continued) In Process This heading is for the status of jobs that are not
yet finished.
s Wait Sched Jobs waiting to be scheduled.
s Wait Confirm Jobs waiting for confirmation.
s Wait Sub Jobs waiting to be submitted.
s Submitted Jobs submitted but not yet in queue.
s Wait Exec Jobs waiting to be executed.
s Executing Jobs that are currently executing.
s On Output Que. Jobs on the output queue that have not
yet been processed by CONTROL-M, for example, because
of a system crash
Ended This heading is for the status of finished jobs.
s Ended OK Jobs that ended OK.
s Not OK Jobs that ended NOTOK.
s Rerun Jobs that require rerun.
s Disappeared Jobs that disappeared from the job queue.
s Abended Jobs that abended.
s Unexpected CC Jobs that ended with a condition code
that is not defined as OK.
s JCL Error Jobs that ended (or did not run) because of a
JCL error.
For statuses under the State column, the following logic
applies:
s Typing Y in the column heading enables further filtering of
jobs on a status-by-status basis. Typing Y in a field in this
column enables all jobs conforming to this status to be
shown, while typing N in a field in this column prevents
jobs with that status from being shown.
s Unlike the logic of the previous two columns (In Process
and Ended), typing N in the column heading of the State
column disables any further selection on a status-by-status
basis. All the jobs in these statuses are to be shown (as if
selected using value Y).
The status Late ONLY is an exception. Whenever the column
heading is set to Y and this field is also set to Y, only Late jobs
are displayed, regardless of what is entered in the other fields.
Only those jobs that are in Late status are shown.
Table 64 Show Screen Filter Window Selection Criteria (Part 3 of 5)
Criterion Description
Tracking and Control Facility
196 CONTROL-M for OS/390 and z/OS User Guide
status (continued)
State This heading is for state criteria that can further filter
the statuses under the other headings (for example, WAIT
SCHEDULE HELD, WAIT SCHEDULE).
s Free, Held, Deleted Jobs that are in the specified state
s On Request Jobs for which a change in job status has been
requested by a CONTROL-M user, but the request has not
yet been processed by the monitor
s Late ONLY/ Late Jobs that were submitted, or finished
executing, late; or jobs with an elapsed execution time
outside of specified limits
By default, the Late ONLY field is displayed. If the user profile
has been modified accordingly, the Late field is displayed.
If Y (Yes) is entered in the Late ONLY field, only late jobs are
displayed. If Y is entered in the Late field, late jobs are
displayed along with other jobs in the display. Whenever N
(No) is entered, this criteria has no effect on the display.
Task Type Limit the task types of jobs to be displayed. Valid task types
are:
s Job Regular job
s Cyc Cyclic job
s Emr Emergency job
s Stc Started task
s Cst Cyclic started task
s Est Emergency started task
s Ecj Emergency cyclic job
s Ecs Emergency cyclic started task
s Wrn Warnings. Supported for historical reasons
s Grp Group Entity
Res NameP An additional cross reference for all jobs that are using a
Control resource, Quantitative resource, or prerequisite
condition. A maximum of two names may be specified. The
resources and conditions are searched according to those
specified as Y (Yes) in Resource Type (described immediately
below).
Table 64 Show Screen Filter Window Selection Criteria (Part 4 of 5)
Criterion Description
Tracking and Control Facility
Chapter 2 Online Facilities 197
Closing the Show Screen Filter Window
The filter you have edited can be activated with or without saving changes,
depending on the value entered in the Save field, as follows:
s To activate and save the filter, type Y (Yes) in the Save field. Changes to the filter
are permanently saved.
s To activate the filter without saving it, type N (No) in the Save field. Changes are
kept in memory only, but not saved.
After typing a value in the Save field, press one of the following keys:
Resource Type Type of Resource or prerequisite condition to be used to filter
the display of the Active Environment screen.
s In All prerequisite conditions appearing in IN statements
s Out All prerequisite conditions appearing in OUT
statements
s Conds All prerequisite conditions appearing in DO
COND statements
s Resource All Quantitative resources
s Control All Control resources
OwnerP Show only jobs of the identified owner. A maximum of five
owners may be identified.
Odate Show only jobs whose original scheduling date falls within the
specified From/ To date range. Date format is mmddyy,
ddmmyy, or yymmdd, depending on the site standard.
If a From date is specified without a To date, the current date
is used as the To date.
Priority Show only jobs with the specified priority.
PipeP Show only job participants in the specified pipe.
Table 64 Show Screen Filter Window Selection Criteria (Part 5 of 5)
Criterion Description
Tracking and Control Facility
198 CONTROL-M for OS/390 and z/OS User Guide
The window is closed and the filter is activated as defined or modified.
To cancel changes made in the Show Screen Filter window, use the RESET command
(PF04/PF16). The changes are canceled regardless of the value entered in the Save
field. The window is closed, and the filter that was previously in effect is restored.
By default, using the END command (PF03/PF15) in the window works like pressing
Enter. However, the default may be modified so that END works like RESET.
Global View Screen
The Global View screen is displayed by typing the command VIEW (abbreviated V)
in the COMMAND field of the Active Environment screen and pressing Enter, or by
pressing PF04/PF16 in the Active Environment screen.
This screen provides a statistical overview of the status of the jobs running under
CONTROL-M. Information is presented by GROUP name, by date (that is, separate
statistics for the same group name on different dates).
Table 65 Show Screen Filter Window - Closing Values
PFKey Description
Enter Filtering begins with the first job currently displayed in the
screen and continues downward.
PF07/PF19 (UP) Filtering begins with the first job in the Active Job list and
continues downward.
PF08/PF20 (DOWN) Filtering begins with the last job in the Active Job list and
continues upward.
NOTE
All jobs having the same group name are grouped together, including jobs from
different tables of different types.
Tracking and Control Facility
Chapter 2 Online Facilities 199
Figure 41 Global View Screen
AutoRefresh mode is available under this screen.
To update the screen, press the REFRESH key (PF04/PF16).
To return to the Active Environment screen, press the END key (PF03/PF15).
Fields of the Global View Screen
- - - - - - - - - - - - - - - - - - - - - - - - - - GLOBAL VI EW- BY GROUP - - - - - - - - - - - - - - - - - - - - ( 3. VI EW)
COMMAND ===> SCROLL===> CRSR
TOTAL WAI T SCHEDULE 647 EXECUTI NG 19 END NOTOK 9 END OK 2014
STAT GROUP- - - - - - - - - - - - - - ODATE #WSC #EXC #END MEMNAME - - - - - JOB STATUS- - - - - -
WS CTM- CONTROL 060601 1 4 CTMCLRES WAI T SCHEDULE
ER PROD- ONSPOOL 060601 43 P0* ENDED NOTOK S0C4
* EN DD- DAY- PROD 060601 42
WS BR- I VP- CC 060601 8 28 BRI VPCCE WAI T SCHEDULE
WS SYSTEMS- JOBS 060601 4 22 SMFCLEAN WAI T SCHEDULE
WS PROD- KPL 060601 47 PRDKPL01 WAI T SCHEDULE
ER MT- PRODUCTI ON 060601 10 24 MTPRQV ENDED NOTOK S0C1
MTRRU04 ENDED NOTOK U0016
ER APPL- PROD- I NTERNAL 060601 9 2 2 I NTPRD02 ENDED NOTOK C0008
I NTPRD01 EXECUTI NG
I NTPRD1A WAI T EXECUTI ON
RN PR- PRODUCTI ON 060601 10 6 24 PRDI NP6A EXECUTI NG
PRDRPT99 EXECUTI NG
PRDDFN EXECUTI NG
PRDRPT10 EXECUTI NG
PRDUPD12 EXECUTI NG
PRDUPD14 WAI T EXECUTI ON
RN VI J- JOBS 060601 4 42 VI JJBNX ENDED NOTOK NOMEM
VI JRUN22 ENDED NOTOK JNRUN
COMMANDS: REFRESH ( VI EWDATA) END ( RETURN TO ACTI VE SCREEN) 15. 35. 49
Table 66 Fields of the Global View Screen (Part 1 of 2)
Field Description
TOTAL Displays the totals from the data. The following summary
information is displayed for all jobs in the Active Jobs file
except emergency jobs:
s WAIT SCHEDULE Total number of jobs waiting to be
scheduled
s EXECUTING Total number of jobs executing
s END NOTOKG Total number of jobs currently in ended
NOTOK status
s END OK Total number of jobs that ended OK
Data lines Display the following information about each group:
Tracking and Control Facility
200 CONTROL-M for OS/390 and z/OS User Guide
View Graph Screen
The View Graph screen is displayed by typing the VIEW GRAPH command
(abbreviated V G) in the COMMAND field of the Active Environment screen and
pressing Enter.
This screen provides a statistical overview of the status of the jobs running under
CONTROL-M, in graph form. Information is presented by GROUP name.
STAT Status of the group:
s WS Wait Scheduling. All jobs are waiting to be scheduled
(no jobs have begun running).
s ER Error. At least one job has finished running and had
an error.
s RN Running. At least one job is running (executing) or
has ended; not all jobs have finished executing; and no jobs
have ended NOTOK.
s * EN Ended OK. All jobs have finished running and
ended OK.
GROUP Name of the group.
ODATE Original scheduling date of the group, discussed in ODATE
on page 154.
#WSC Number of jobs in Wait Schedule state.
#EXC Number of jobs executing (or in the input queue).
#END Number of jobs that have finished executing.
MEMNAME Name of each active member (job) in the group. The members
that are displayed are those
s executing (or in the input queue)
s ended NOTOK
If none of the above is found within the group, the first job that
is waiting to be scheduled is displayed.
JOB STATUS Status of each job in the group. In case of error, the type of
error is shown (for example, abend code).
Table 66 Fields of the Global View Screen (Part 2 of 2)
Field Description
Tracking and Control Facility
Chapter 2 Online Facilities 201
AutoRefresh mode is available under this screen.
To update the screen, type the command REFRESH and press Enter, or press
PF04/PF16.
To return to the Active Environment screen, press the END key (PF03/PF15).
Two formats for the View Graph screen are available, one for color displays and one
for non-color displays. They are discussed on the following pages.
View Graph Screen Format for Color Terminals
Figure 42 View Graph Screen Format for Color Terminals
NOTE
All jobs having the same group name are grouped together, including jobs from
different tables of different types.
- - - - - - - - - - - - - - - - - - - - - - - - - - - VI EWGRAPH - BY GROUP - - - - - - - - - - - - - - - - - - - - ( 3. GRAPH)
COMMAND ===> SCROLL===> CRSR
TOTAL WAI T SCHEDULE 674 EXECUTI NG 28 END NOTOK 11 END OK 1549
GROUP NAME - - - - - - - - - - - - - SUM %- - - +- - - 20- - - - +- - - 40- - - - +- - - 60- - - - +- - - 80- - - - +- - 100%
EBD- PRODUCTI ON 27 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
GPL- PRODUCTI ON 35 G100GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG
MT- PRODUCTI ON 40 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
VEJ- JOBS 39 G100GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG
PROD- KPL 16 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
I NTER- PRODUCTI ON 42 RR50RRRRRRRRRRRRRRRRRRRRRGG50GGGGGGGGGGGGGGGGGGGGG
NTN- APPLI CATI ON 35 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
APPL- PROD- I NTERNAL 37 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
CLI ENTS- STATEMENTS 38 R100RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
PR- PRODUCTI ON 40 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BR- I VP- CC 10 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
SYSTEMS- JOBS 36 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
CI CS- BATCH- JOBS 28 G100GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG
DD- NI GHT- PROD 37 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BKP- PROD- L 10 BB20BBBBBBYY20YYYYYYRR40RRRRRRRRRRRRRRRRGG20GGGGGG
BKP- PROD- ACCOUNT 9 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BKP- PROD- DD 14 R100RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
FDS- JOBS 39 R100RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
JJL- NI GHT- PROD 33 B100BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
COMMANDS: REFRESH ( VI EWDATA) END ( RETURN TO ACTI VE SCREEN) 01. 26. 56
Tracking and Control Facility
202 CONTROL-M for OS/390 and z/OS User Guide
Fields of the View Graph Screen
Job Graph
In the job graph (D), job statuses are differentiated by color, as follows:
Table 67 Fields of the View Graph Screen
Field Description
TOTAL Displays the totals from the data. The following summary
information is displayed for all jobs in the Active Jobs file
except emergency jobs:
s WAIT SCHEDULE Total number of jobs waiting to be
scheduled
s EXECUTING Total number of jobs executing
s END NOTOKG Total number of jobs currently in ended
NOTOK status
s END OK Total number of jobs that ended OK
The data lines display the following information for each group:
GROUP NAME Name of the group.
SUM Total number of jobs in the group.
JOB GRAPH Job graph indicates the number of jobs in each status, in each
group.
Scale Scale line used to simplify reading the percentage of jobs of
each status in the group. The scale used (that is, the number
of jobs represented by each column) automatically adjusts
based on the number of jobs in the group containing the most
jobs.
NOTE
Because this guide is printed in black and white, the different colors in the screen are
represented by different shadings in this guide.
Table 68 Job Status Color (Part 1 of 2)
Color Description
Blue WAIT SCHEDULE
Yellow EXECUTING
Tracking and Control Facility
Chapter 2 Online Facilities 203
For each group in the graph, the number of columns of a particular color depends on
the number of jobs having that status.
View Graph Screen Format for Non-Color Terminals
Figure 43 View Graph Screen Format for Non-Color Terminals
Red END NOTOK
Green END OK
- - - - - - - - - - - - - - - - - - - - - - - - - - - VI EWGRAPH - BY GROUP - - - - - - - - - - - - - - - - - - - - ( 3. GRAPH)
COMMAND ===> SCROLL===> CRSR
TOTAL WAI T SCHEDULE 674 EXECUTI NG 28 END NOTOK 11 END OK 1549
GROUP NAME - - - - - - - - - - - - - SUM - - - - +- - - 20- - - - +- - - 40- - - - +- - - 60- - - - +- - - 80- - - - +- - 100%
EBD- PRODUCTI ON 27 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
GPL- PRODUCTI ON 35 %100%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
MT- PRODUCTI ON 40 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
VEJ- JOBS 39 %100%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
PROD- KPL 16 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
I NTER- PRODUCTI ON 42 * * 50* * * * * * * * * * * * * * * * * * * * * %%50%%%%%%%%%%%%%%%%%%%%%
NTN- APPLI CATI ON 35 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
APPL- PROD- I NTERNAL 37 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
CLI ENTS- STATEMENTS 38 * 100* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
PR- PRODUCTI ON 40 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
BR- I VP- CC 10 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
SYSTEMS- JOBS 36 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
CI CS- BATCH- JOBS 28 %100%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DD- NI GHT- PROD 37 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
BKP- PROD- L 10 $$20$$$$$$++20++++++* * 40* * * * * * * * * * * * * * * * %%20%%%%%%
BKP- PROD- ACCOUNT 9 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
BKP- PROD- DD 14 * 100* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
FDS- JOBS 39 * 100* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
JJL- NI GHT- PROD 33 $100$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
COMMANDS: REFRESH ( VI EWDATA) END ( RETURN TO ACTI VE SCREEN) 01. 26. 56
Table 68 Job Status Color (Part 2 of 2)
Color Description
Tracking and Control Facility
204 CONTROL-M for OS/390 and z/OS User Guide
Fields of the View Graph Screen
The data lines display the following information about each group:
Job Graph
In the job graph, job statuses are differentiated by symbols, as follows:

For each group in the graph, the number of columns containing a particular symbol
depends on the number of jobs having that status.
Table 69 Fields of the View Graph Screen
Field Description
TOTAL Displays the totals from the data. The following summary
information is displayed for all jobs in the Active Jobs file
except emergency jobs:
s WAIT SCHEDULE Total number of jobs waiting to be
scheduled.
s EXECUTING Total number of jobs executing.
s END NOTOKG Total number of jobs currently in ended
NOTOK status.
s END OK Total number of jobs that ended OK.
GROUP NAME Name of the group.
SUM Total number of jobs in the group.
JOB GRAPH Job graph indicates the number of jobs in each status, in each
group.
Scale Scale line used to simplify reading the percentage of jobs of
each status in the group. The scale used (that is, the number of
jobs represented by each column) automatically adjusts based
on the number of jobs in the group containing the most jobs.
Table 70 Job Graph Status Symbols
Symbol Description
$ WAIT SCHEDULE
+ EXECUTING
* END NOTOK
% END OK
Tracking and Control Facility
Chapter 2 Online Facilities 205
Why Screen
The Why screen (Screen 3.?) is displayed when the ? (Why) option is entered on the
Active Environment screen. The Why screen shows the reasons why a job is in WAIT
SCHEDULE status.
Figure 44 Active Environment Why Screen
To return to the Active Environment screen, press the END key (PF03/PF15).
Possible WHY reasons are:
s ALL RUNTIME CRITERIA SATISFIED. JOB WILL BE SUBMITTED SOON
s CONTROL-M MONITOR IS NOT ACTIVE
s IN HOLD STATE
s WAIT CONFIRMATION
s TIME LIMIT FROM hhmm UNTIL hhmm
s NEXT RERUN/ CYCLIC RUN FROM hhmm
s CONDITION condition-name ODATE mmdd
Prerequisite condition required by the job, along with its original scheduling date.
s RESOURCE resource-name [R] QUANTITY quantity BY priority memname
Name and quantity of a Quantitative resource not currently available for the job.
For critical path jobs, a job with a higher path priority than the current job is also
identified.
- - - - - - - - - - - - - - - - - - - - - - - - PRUPDT02 SCHEDULI NG ANALYSI S - - - - - - - - - - - - - - - - - - - - ( 3. ?)
COMMAND ===> SCROLL===> CRSR
OPT DESCRI PTI ON

TI ME LI MI T FROM 1730 UNTI L 0200
RESOURCE DB2- POWER QUANTI TY 0030
HELD BY PRDKPL01 ( U) QUANTI TY 0022
HELD BY GPLI R17A ( U) QUANTI TY 0020
HELD BY I NTR0002 ( U) QUANTI TY 0015
HELD BY PRUPDOLV ( U) QUANTI TY 0010
HELD BY MTPRQV ( U) QUANTI TY 0025
RESOURCE CARTRI DGE QUANTI TY 0002
HELD BY PRDKPL01 ( U) QUANTI TY 0001
HELD BY GPLI R17A ( U) QUANTI TY 0002
I N HOLD STATE
CONDI TI ON PRUPDT01- ENDED- OK ODATE 0606
NOT- COND PRPLD03- ENDED- NOTOK ODATE 0606
GROUP SCHEDULI NG ANALYSI S FOR GROUP ACCOUNT ( ACCOUNT- GROUP)
GROUP' S RUNTI ME CRI TERI A SATI SFI ED
====== >>>>>>>>>>>>>>>>>>>>> END OF " WHY" LI ST <<<<<<<<<<<<<<<<<<<<< =====



OPTI ON: A ADD CONDI TI ON D DELETE NOT- COND 10. 32. 27
Tracking and Control Facility
206 CONTROL-M for OS/390 and z/OS User Guide
s CONTROL OVER resource TYPE type BY priority memname [ownership type]
Name and type of a Control resource currently being used by another job order
which is identified by name. For critical path jobs, path priority of the owner is also
identified.
s JOB WAIT FOR PIPES COLLECTION
PIPE pipename
The job was not run for one of the following reasons:
CONTROL-M is waiting for the minimum number of participants in the
indicated pipe.
At least one prerequisite (prerequisite condition, resource, confirmation, and so
on) for a participant in the indicated pipe is not satisfied.
If the job belongs to a Group scheduling table, the Why screen displays messages
related to both the selected job and the group to which the job belongs. In this case,
the reasons indicated above may be applicable to the selected job and/ or to the
group.
To enable you to distinguish between job reasons and group reasons, the job
reasons appear in the screen before the group reasons, and the two sets of reasons are
separated by the following line:
In addition to the above line, the following reasons can appear only for a job in a
Group scheduling table:
s JOBS RUNTIME CRITERIA SATISFIED
This reason applies to the job.
s GROUPS RUNTIME CRITERIA SATISFIED
This reason applies to the group.
Adding Conditions in the Why Screen
If the Why screen indicates that a job is waiting for prerequisite conditions, the
indicated conditions can be manually added using the Why screen by typing A (Add
Condition) in the OPT (Option) field next to the condition.
GROUP SCHEDULI NG ANALYSI S FOR GROUP gr oup- memname ( gr oupname)
Tracking and Control Facility
Chapter 2 Online Facilities 207
Type A for every condition to be added, and press Enter.
When adding conditions, a confirmation window may be displayed depending on
user profile customization. The confirmation window is described in The Why
Screen Add Condition or Delete NOT-COND Confirmation Window on page 207.
Deleting Negative Conditions in the Why Screen
A negative condition is a condition that prevents a job from running.
Negative conditions can be seen in the Why screen. They can be identified by the
description NOT-COND.
If the Why screen indicates that a job is waiting for a NOT-COND (negative
condition) that is preventing the job from running, the NOT-COND can be deleted
manually. This enables the job to run despite the fact that the NOT-COND is true.
To delete a NOT-COND manually, type D (Delete NOT-COND) in the OPT (Option)
field next to the condition.
Type D for every NOT-COND to be deleted, and press Enter.
When deleting NOT-COND conditions, a confirmation window may be displayed
depending on user profile customization. The confirmation window is described in
the following paragraphs.
The Why Screen Add Condition or Delete NOT-COND
Confirmation Window
When adding conditions or deleting NOT-COND conditions, a confirmation window
may be displayed depending on user profile customization:
s By default, when A or D is entered in the Why screen, a confirmation window is
displayed only when the date reference of the condition is **** or $$$$. Addition or
deletion of conditions without generic date references is performed without
confirmation from the user.
s If, however, the user profile has been customized accordingly, the following
confirmation window is always displayed when either A or D is entered.
Tracking and Control Facility
208 CONTROL-M for OS/390 and z/OS User Guide
Figure 45 Why Screen Add Condition or Delete NOT-COND Confirmation Window
Fill in or modify the fields of the confirmation window as follows and press Enter.
- - - - - - - - - - - - - - - - - - - - - - - - WRUPDT02 SCHEDULI NG ANALYSI S - - - - - - - - - - - - - - - - - - - - ( 3. ?)
COMMAND ===> SCROLL===> CRSR
OPT DESCRI PTI ON +- - - - - - - - - - - - - - - - - - - - - - - - - +
| CONFI RM MMDD 0606 |
A CONDI TI ON PROD- WRUPDT03- GO <- - - - - - - - | ASK FOR EACH ONE Y |
A CONDI TI ON PROD- WRUPDT03- CHECK +- - - - - - - - - - - - - - - - - - - - - - - - - +
D NOT- COND PRPLDT03- ENDED- NOTOK ODATE 0606
====== >>>>>>>>>>>>>>>>>>> END OF " WHY" LI ST <<<<<<<<<<<<<<<< ======















OPTI ON: A ADD CONDI TI ON D DELETE NOT- COND 18. 15. 36
Table 71 Fields of the Add Condition or Delete NOT-COND Confirmation Window
(Part 1 of 2)
Field Description
CONFIRM Confirms whether to process the Add Condition or Delete
NOT-COND request. Valid values are:
s Y (Yes) Process the Add Condition or Delete
NOT-COND request.
s N (No) Cancel the request.
date Date of the listed condition.
s If the date reference of the listed condition contains **** or
$$$$, the date field of the window is unprotected and you
must explicitly enter the date in the date field.
s If the date reference of the listed condition is a specific date
(in either mmdd or ddmm format, depending on the
standard in use at the site), the date field of the window is
protected and its value cannot be changed.
Tracking and Control Facility
Chapter 2 Online Facilities 209
Deleting a Job
CONTROL-M only allows deletion of WAIT SCHEDULE jobs, or jobs that have
finished executing. To be deleted, a job must be in HELD status. The deletion request
is recorded in the IOA Log file. The job is logically deleted, that is, flagged as deleted,
from the Active Jobs file immediately. It is physically deleted from the disk the next
time cleanup (for example, New Day processing) is performed.
To delete a job, type D (Delete) in the Option field to the left of the job and press
Enter.
Deleting Critical Path Jobs
Critical path jobs (even in HELD status) that hold a Control or Quantitative resource
can only be deleted through the following steps:
ASK FOR EACH
ONE
This line is displayed only if more than one Add Condition or
Delete NOT-COND is requested. It determines whether
individual confirmation is required for each Add Condition or
Delete NOT-COND request. Valid values are:
s Y (Yes) Individual confirmation is required for each Add
Condition or Delete NOT-COND request. The specified
CONFIRM value (Y or N) applies only to the current Add
Condition or Delete NOT-COND request.
s N (No) Individual confirmation is not required for each
Add Condition or Delete NOT-COND request. The
specified CONFIRM operation is applied to all Add
Condition and Delete NOT-COND requests. (If CONFIRM
is Y, all Add Condition and Delete NOT-COND requests
are processed; if CONFIRM is N, no Add Condition or
Delete NOT-COND requests are processed.)
NOTE
Logically deleted jobs can be undeleted by option U (Undelete). When jobs are
undeleted they are added back to the Active Jobs file with the same status they had
prior to deletion.
Table 71 Fields of the Add Condition or Delete NOT-COND Confirmation Window
(Part 2 of 2)
Field Description
Tracking and Control Facility
210 CONTROL-M for OS/390 and z/OS User Guide
1 Remove the critical path priority of the job using the Zoom screen (Screen 3.Z).
2 Free the job.
3 When the job reverts to WAIT SCHEDULE status, hold the job.
4 Delete the job.
Deleting Group Entities
When a Group entity is deleted, all the jobs belonging to that group are deleted.
When a group is deleted, and a job within that group is undeleted, the Group entity
itself is undeleted together with the job. To delete a group of jobs, the Group entity
containing the jobs must first be in WAIT or END status. Place the Group entity in
HELD status. Once a Group entity is in HELD status, you can delete the Group entity.
If all the jobs within a group are deleted, you can delete the Group Entity itself
through the following steps:
1 Put the group on hold. If it is already held, free it, then put it on hold again.
2 Delete the Group Entity.
The reason for freeing a held group and then putting it on hold again before
attempting to delete it is that, for efficiency, when a group is held, CONTROL-M does
not check the status of the jobs in it.
Delete Confirmation Window
When requesting job deletions, a Delete Confirmation window may be displayed,
depending on user profile customization:
s By default, when option D is entered in the Active Environment screen, deletion
requests are performed without confirmation from the user.
s If, however, the user profile has been customized accordingly, the following Delete
Confirmation window is displayed, in sequence, for each deletion request.
Tracking and Control Facility
Chapter 2 Online Facilities 211
Figure 46 Active Environment Screen Delete Confirmation Window
Fill in the window as follows and press Enter.
To confirm the delete request, type Y (Yes) in the window.
To cancel the delete request, type N (No) in the window.
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - UP <D> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
PRD1 PROD 060601 JOB Wai t Schedul e ( Pi pe)
I EFBR14T TEST 060601 M70TEST0/ 24897 JOB Ended " OK"
PRD1 PROD 060601 JOB Wai t Schedul e ( Pi pe)
I EFBR14T +- - - - - - - - - - - - - - - - - - - - - - - - + Ended " OK"
D SELI GRP <- - - - - - - - | Del et e ( Y/ N) | Ended- Not " OK"
GRPJOB1 +- - - - - - - - - - - - - - - - - - - - - - - - + Ended " OK"
GRPJOB2 TEST 060601 M70TEST2/ 24929 JOB Ended " OK"
GRPJOB3 TEST 060601 M70TEST3/ 24930 JOB Ended- Not " OK" - Abended
========= >>>>>>>>>>>>> Bot t om of Jobs Li st <<<<<<<<<<<<< ========










Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 16. 28. 18
Tracking and Control Facility
212 CONTROL-M for OS/390 and z/OS User Guide
Log Screen
To display the Log screen, type option L (Log) in the Active Environment screen. The
Log screen displays all Log messages of the specified job.
Figure 47 Active Messages Log Screen
Usage of the Log screen is explained in detail in IOA Log Screen on page 290.
However, if you entered the Log screen by option L on the Active Environment
screen instead of by option 5 on the IOA Primary Option menu, note the following
differences in usage:
s The SHOW command cannot be used with any parameters or qualifiers.
s Only filter options related to CONTROL-M (and CMEM) are displayed in the
Show Screen Filter window.
s Only the default job filter can be displayed.
If you enter L (Log) in the O (Option) column for multiple jobs in the Active
Environment screen, the log displays are stacked. Each time the END key (PF03/PF15)
is pressed, the next log in the stack is displayed, until all logs have been displayed.
To return to the Active Environment screen, press END (PF03/PF15).
FI LTER: - - LOG MESSAGES FOR JOB( S) I NTR0004 - - - - - - - - - - - - - - - - - ( 3. LOG)
COMMAND ===> SCROLL===> CRSR
SHOWLI MI T ON ==> DATE 060601 - 060601
DATE TI ME ODATE USERI D CODE - - - - - - M E S S A G E - - - - - - - - - - - - - - - - - - - -
060601 131143 060601 M22 JOB511I JOB I NTR0004 ODATE 060601 I D=00019 PLACED
ON ACTI VE JOBS FI LE -
060601 131148 060601 M22 SEL203I JOB I NTR0004 ELI GI BLE FOR RUN
060601 131150 060601 M22 SUB133I JOB I NTR0004 SUBMI TTED
060601 131651 060601 M22 SPY281I JOB I NTR0004 I NTR0004/ 04371 START
98253. 1316 STOP 98253. 1316 CPU 0MI N
00. 04SEC SRB 0MI N 00. 00SEC 0. 19 9QFDSF
060601 131651 060601 M22 SPY254I JOB I NTR0004 I NTR0004/ 04371 SCANNED
060601 131652 060601 M22 SEL206WJOB I NTR0004 I NTR0004/ 04371 ABENDED CC
SB37 STEP STEP01
060601 131652 060601 M22 SEL219I JOB I NTR0004 I NTR0004/ 04371 ENDED " NOT
OK"
060601 132814 060601 M22 CTM659I RERUN OF TASK I NTR0004 ODATE 060601
PERFORMED
060601 132817 060601 M22 SEL220I JOB I NTR0004 WI LL BE RERUN
060601 132818 060601 M22 SEL203I JOB I NTR0004 ELI GI BLE FOR RUN
060601 132818 060601 M22 SUB133I JOB I NTR0004 SUBMI TTED
======== >>>>>>>>>>>>>>>> NO MORE LOG MESSAGES <<<<<<<<<<<<<<<<< ========

CMDS: SHOW, GROUP, CATEGORY, SHPF 13. 24. 01
Tracking and Control Facility
Chapter 2 Online Facilities 213
Zoom Screen
The Zoom screen zooms in on the details of a specific job order. To display the
Zoom screen, type Z (Zoom) on the Active Environment screen.
Figure 48 CONTROL-M Zoom Screen
NOTE
To save changes made in the Zoom screen, the job must be placed in HELD state
before entering the Zoom screen.
- - - - - - - - - - - - - - - - - - - - - - - - - CONTROL- M ZOOM SCREEN - - - - - - - - - - - - - - - - - - - - - - - - - - ( 3. Z)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 DFLT N
SCHDTAB MI KLE SCHDLI B CTMP. V524. SCHEDULE
APPL PROD GROUP KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
JOBNAME JOBI D ODATE 060601 ORDERI D 0005C MAXWAI T 04
RESTART DECI SI ON- FROM . TO . CONFI RM N
DESC DAI LY PRODUCTI ON - START OF PRODUCTI ON GROUP KPL
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
=============================================================================
NOTE
=============================================================================
DOC
=============================================================================
I N DAI LY- PROD- KPL- GO 0606
CONTROL DB2- MAI N- FI LE E
RESOURCE I NI T 0001 CART 0001
PI PE CTM. PROD. PI PE
TI ME: FROM UNTI L PRI ORI TY 00 CONFI RM N
DUE I N 1311 ELAPSE 0003 DUE OUT 1314
TI ME ZONE: WAI T FOR ODATE:
CPU-ID NODE NAME NJE SEARCH COUNTER 00000
=============================================================================
OUT PROD- PRDKPL01- OK 0606 +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP C ( C, D, F, N, R) 2 FROM
MAXRERUN MEMBER I NTRVL FROM END NXT RUN
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST PROCST CODES A/ O *
DO
SHOUT WHEN NOTOK TO OPER2 URGN R
MS DAI LY PRODUCTI ON JOB PRDKPL01 ENDED NOT OK. NOTI FY PRODUCTI ON MANAGER
SHOUT WHEN TO URGN
MS
====== >>>>>>>>>>>>>>>>>>> END OF JOB PARAMETERS <<<<<<<<<<<<<<<<<<<<<<< ======
COMMANDS: CANCEL DOC NOTE 18. 33. 28
Tracking and Control Facility
214 CONTROL-M for OS/390 and z/OS User Guide
The Zoom screen is similar to the Job Scheduling Definition screen used for defining
job production parameters, but it is different in several respects:
s The Zoom screen contains fields that do not appear in the Job Scheduling
Definition screen (and vice versa).
s Some fields on the Zoom screen cannot be modified at all. Other fields can or
cannot be modified depending on the status of the job.
s Changes to a field in the Zoom screen affect only the current job order, not the job
scheduling definition.
For information about most fields in the Zoom screen, see Job Scheduling Definition
Screen Defining Schedules on page 128.
Fields of the Zoom screen that are not in the Job Scheduling Definition screen are
described below:
NOTE
The Zoom screen is displayed in Browse mode if the requested job order is already
being zoomed by another user. In this case, updates are not permitted.
Table 72 Fields of the Job Scheduling Definition Zoom Screen (Part 1 of 4)
Field Description
SCHDTAB Name of the scheduling table from which the job was ordered.
SCHDLIB Name of the scheduling library from which the job was
ordered.
ORIGLIB The original value of the MEMLIB parameter before
CONTROL-M changed it to DUMMY.
This line appears only in PSEUDO jobs, meaning jobs in a
group that were automatically changed by CONTROL-M into
DUMMY jobs when they were ordered.
For more information on PSEUDO jobs, see ADJUST
CONDITIONS: General Job Parameter on page 392.
JOBNAME Name of the job (available only after job submission).
JOBID Job number (available only after job submission).
ODATE Original scheduling date assigned to the job.
ORDERID Unique job order ID in CONTROL-M.
Tracking and Control Facility
Chapter 2 Online Facilities 215
Restart RESTART
DECISION
This has the following subparameters:
s FROM Program step (and, optionally, procedure step)
names at which to begin processing the job restart.
s TO Program step (and, optionally, procedure step)
names at which the restarted job terminates processing.
This parameter is optional. If the FROM parameter is
specified and the TO parameter is not specified, the job is
rerun until the last step.
s CONFIRM Valid values are:
Y (Yes) If the job is to be resubmitted as a result of a
DO RERUN statement, manual confirmation is required
(using the Active Environment screen).
N (No) If the job is resubmitted as a result of a DO
RERUN statement, manual confirmation is not required.
NOTE Text of a note has been added to the job order. For more
information, see Adding or Editing a Job Order Note on
page 219.
DUE IN Recommended time by which the job must be submitted in
order to be completed by the DUE OUT time. This value is
calculated by subtracting the ELAPSE time from the DUE OUT
time. By default, a job is still submitted if it has passed its DUE
IN time, unless the DUEINCHK parameter in the CTMPARM
member in the IOA PARM library has been set to Yes, in
which case the job must wait until the next day to be
submitted if its DUE IN time has passed. For more details, see
DUE OUT: Runtime Scheduling Parameter on page 490.
ELAPSE Anticipated elapse time (that is, anticipated job execution
time). The value used is the average of the run times of the job
in the CONTROL-M Statistics file.
Table 72 Fields of the Job Scheduling Definition Zoom Screen (Part 2 of 4)
Field Description
Tracking and Control Facility
216 CONTROL-M for OS/390 and z/OS User Guide
WAIT FOR ODATE Whether a job can be executed even though ODATE is a future
date.
Valid values are:
s Y The job cannot be executed until ODATE arrives.
s N The job can be executed even if ODATE has not yet
arrived.
When the Job Scheduling Definition Zoom screen is displayed,
the value that appears in this field varies as follows:
s When the CTMJOB utility was used to order the job, if the
ODATEOPT parameter was set to RUN, the value is Y.
s If the job was pre-ordered using the Time Zone feature in
the New Day procedure, and the ODATEOPT parameter
was automatically set to RUN, the value is Y.
s If the job was ordered or forced from the Job List Screen,
and the WAIT FOR ODATE field in the Job List Exit
Option window was set to Y, the value that appears in the
Zoom screen is also Y.
You can change the value that appears in this field.
CPU-ID CPUID on which the job executes (if $ Quantitative resources
were specified). This field contains the selected $ value, that is,
the CPUID. For more details, see RESOURCE: Runtime
Scheduling Parameter on page 588.
NODE NAME Node on which the job executes (as specified in the JCL).
NJE When this field contains a Y, the job has been sent for
execution to a computer that is connected to a CONTROL-M
computer by NJE, that is, it does not have a shared spool with
CONTROL-M. Normally, do not modify the value in this field.
BMC Software recommends that you do not purge jobs from
the spool on the Remote node. However, if a job was purged
from the spool on the Remote node, you must notify
CONTROL-M of the event by changing the value in the NJE
field back to ' ' (Blank). After a short time, the job status
changes to Disappeared.
Table 72 Fields of the Job Scheduling Definition Zoom Screen (Part 3 of 4)
Field Description
Tracking and Control Facility
Chapter 2 Online Facilities 217
SEARCH
COUNTER
Number of times CONTROL-M has looked for a job that is not
found. (This value is displayed (as n) in job status BUT NOT
FOUND n TIMES.) When this value equals the maximum
number of searches allowed, the job status changes to
DISAPPEARED.
Note: The default value is 10. This value can be changed by
your INCONTROL administrator, using the #JNFRT
parameter in the CTMPARM member in the IOA PARM
library.
You may change the value of this counter. Two instances in
which this might be helpful are:
s As the counter approaches the maximum number of
searches allowed, set the SEARCH COUNTER back to zero
if you do not want the status changed to DISAPPEARED.
s If the search is pointless (for example, you know the job
has been deleted from spool), change the SEARCH
COUNTER to 99999 thereby causing a DISAPPEARED
status.
NXT RUN For rerun situations or for cyclic jobs that use the INTERVAL
option, this field indicates the next time the job is submitted (if
other submission criteria are satisfied). Format: yymmdd
hhmm.
ON PGMST trigger This field appears at the end of the ON PGMST line, to the
right of the A/ O field. In Figure 48 an asterisk can be seen in
this field. The field is used to indicate if the ON PGMST
statement was triggered. Possible values are:
s * (Asterisk) ON PGMST statement was triggered.
s (Blank) ON PGMST statement was not triggered.
Note: If more than one ON PGMST statement has been
specified:
s If the statements are joined by an OR relationship, related
DO actions were performed if an asterisk appears in this
field for any ON PGMST statements.
s If the statements are joined by an AND relationship,
related DO actions were performed only if an asterisk
appears in this field for all joined ON PGMST statements.
Table 72 Fields of the Job Scheduling Definition Zoom Screen (Part 4 of 4)
Field Description
Tracking and Control Facility
218 CONTROL-M for OS/390 and z/OS User Guide
Only specific dates (or ****, $$$$ or STAT) can be used as valid condition date
references. Therefore, if symbolic date references (such as ODAT or PREV) are
entered as condition date references (in the parameters IN, OUT, CODES, COND,
and so on) in the job scheduling definition, the real date values are derived and
displayed in the Zoom screen.
Restart The restart decision parameters (FROM, TO, CONFIRM) contain a value
other than blank only if
s the DO IFRERUN parameters have been specified in the Job Scheduling Definition
screen (Screen 2)
and
s the job was executed.Restart
When and if the job is restarted, these parameters are used. You can modify the value
of these parameters.
The DOC command can be used to alternately display and hide the documentation
(DOC lines). Documentation cannot be updated in the Zoom screen.
Zoom Screen for Group Entities
An example of the Zoom screen for Group Entities is shown below.
As noted earlier, a job must be placed in the Held state before entering the Zoom
screen if changes are to be saved. When a Group entity is held, changes to jobs within
the Group can be saved without having to separately place a hold on each job.
All information applicable to the regular Zoom screen applies to the Group Entity
Zoom screen as well. All fields in the Group Entity Zoom screen also appear in the
Zoom screen for regular job scheduling definitions. For a description of the fields in
the Group Entity Zoom screen, refer to the descriptions of the regular Zoom screen,
the Job Scheduling Definition screen, and the Group Entity screen.
Tracking and Control Facility
Chapter 2 Online Facilities 219
Figure 49 Zoom Screen for Group Entities
Zoom Screen Commands
The following commands are displayed in the Zoom screen.
Adding or Editing a Job Order Note
You can add, delete or change a note for the job order in the Zoom screen. For
example, you might use a note to document a manual intervention in a job run. First,
however, the job must be placed in Held status.
To add a note, type NOTE in the command line of the Zoom screen and press Enter.
A new NOTE line is opened for entering additional notational text.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - CONTROL- M ZOOM SCREEN - - - - - - - - - - - - - - - - - - - - - - ( 3. Z)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OWNER N04A TASKTYPE GRP
SCHDTAB SPDCRP SCHDLI B CTM. PROD. SCHED
APPL GROUP ACCCOUNTI NG
SCHENV SYSTEM I D NJE NODE
JOBNAME JOBI D ODATE 060601 ORDERI D 000I H GRP MAXWAI T 00
DESC
SET VAR
DOCMEM ACCOUNT DOCLI B CTM. CMEM. DOC
===========================================================================
I N
CONTROL
TI ME: FROM UNTI L PRI ORI TY CONFI RM N
DUE I N 1311 ELAPSE 0003 DUE OUT 1314
TI ME ZONE: WAI T FOR ODATE:
===========================================================================
OUT
ON GROUP- END OK
DO COND ACCOUNTI NG- OK 0909 +
SHOUT WHEN TO URGN
MS
====== >>>>>>>>>>>>>>>>>>> END OF JOB PARAMETERS <<<<<<<<<<<<<<<<<<<<<<< =====



COMMANDS: CANCEL DOC NOTE 11. 41. 46
Table 73 Commands of the Zoom Screen
Command Description
SAVE Command SAVE in the Zoom screen saves changes to the
screen.
DOC Command DOC alternately displays or hides the job
documentation. For more information, see Job
Documentation on page 146.
NOTE Command NOTE opens a note and adds it to the job order.
Tracking and Control Facility
220 CONTROL-M for OS/390 and z/OS User Guide
Figure 50 Adding or Editing a Job Order Note
Add or edit the text in the note lines as desired. When text is added to an empty note
line, a new blank note line is opened. To delete a note, delete all note lines.
When the note is as you want it, type SAVE in the Command line and press Enter.
After all changes to the Zoom screen are made, free the Held job in the Active
Environment screen. When a job order contains a note, an indicator is placed in the
Status field of the Active Environment screen.
Exiting the Zoom Screen
The method of exiting the Zoom screen and saving changes can be customized using
the user profile.
s By default, END (PF03/PF15) performs a cancel, and the changes are not saved (that
is, no changes are made to the job entry on the Active Jobs file). To save changes,
the SAVE command must be entered.
s If customized, END (PF03/PF15) performs a save. In this case, the following
confirmation window is displayed if changes have been made.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - CONTROL- M ZOOM SCREEN - - - - - - - - - - - - - - - - - - - - - - ( 3. Z)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 DFLT N
SCHDTAB MI KLE SCHDLI B CTMP. SCHEDULE
APPL PROD GROUP KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
JOBNAME JOBI D ODATE 060601 ORDERI D 0005C MAXWAI T 04
RESTART DECI SI ON- FROM . TO . CONFI RM N
DESC DAI LY PRODUCTI ON - START OF PRODUCTI ON GROUP KPL
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
NOTE
===========================================================================
DOC
===========================================================================
I N DAI LY- PROD- KPL- GO 0606
CONTROL DB2- MAI N- FI LE E
RESOURCE I NI T 0001 CART 0001
COMMANDS: CANCEL DOC NOTE 09. 13. 15
Tracking and Control Facility
Chapter 2 Online Facilities 221
Figure 51 Exiting the Zoom Screen Confirmation Window
Fill in the fields of the window as follows and press Enter:
s Type Y (Yes) in the window to save the changes.
s Type N (No) in the window to cancel the changes.
To bypass the window if it is normally displayed, exit the Zoom screen as follows:
s Type SAVE in the Zoom screen to save changes (not available in Browse mode).
s Type CANCEL in the Zoom screen to cancel changes.
Upon saving changes, the status of the job becomes REQUESTED CHANGE HELD.
Wait until the REQUESTED CHANGE status disappears (indicating that the
CONTROL-M monitor has accepted the change), and then free the job in the Active
Environment screen.
Confirm Scheduling Window
If a job scheduling definition contains a value of Y in the runtime scheduling
parameter CONFIRM, the job requires manual confirmation before it can be
considered for submission. When such a job is placed in the Active Jobs file, it
appears in the Active Environment screen with status of WAIT CONFIRMATION.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - CONTROL- M ZOOM SCREEN - - - - - - - - - - - - - - - - - - - - - - ( 3. Z)
COMMAND ===> +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - | | - - - - - - - - - - - - - - - +
MEMNAME BACKP02 | CONFI RM CHANGES ==> ( Y/ N) |
OWNER M44 | |
APPL APPL- L +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + L
OVERLI B CTM. OVER.
SCHENV SYSTEM I D NJE NODE
JOBNAME JOBI D ODATE 060601 ORDERI D 0007N MAXWAI T 04
RESTART DECI SI ON- FROM . TO . CONFI RM N
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKP02 DOCLI B CTM. PROD. DOC
===========================================================================
I N START- DAI LY- BACKUP 0606
CONTROL
RESOURCE I NI T 0001 CART 0001
PI PE
TI ME: FROM UNTI L PRI ORI TY 00 CONFI RM N
DUE I N 1311 ELAPSE 0003 DUE OUT 1314
TI ME ZONE: WAI T FOR ODATE:
CPU- I D NODE NAME NJE SEARCH COUNTER 00000
ENTER CANCEL TO I GNORE CHANGES. 18. 54. 43
Tracking and Control Facility
222 CONTROL-M for OS/390 and z/OS User Guide
To confirm the scheduling of the job for submission, type C (Confirm) for the job, in
the Active Environment screen. A confirmation window is then opened. The same
confirmation window is opened when requesting the rerun of a job in the Active
Environment screen. For the description and an example of the confirmation
window, see Confirm Rerun Window.
Confirm Rerun Window
If a job scheduling definition does not contain an appropriate DO RERUN statement,
or if the specified MAXRERUN limit was reached, a job is not automatically rerun if
the job execution fails.
In such cases, however, rerun of the job can be manually requested by entering R
(Rerun) in the Active Environment screen.
The following confirmation window is opened when either option R (Rerun) or
option C (Confirm) is entered in the Active Environment screen.
Figure 52 Active Environment Screen Confirm Rerun Window
NOTE
Restart If CONTROL-M/ Restart is available, a different window is opened for job
rerun. For more information, see RestartRerun and/ or Restart Window (Under
CONTROL-M/ Restart) on page 223.
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - DOWN <D> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - - St at us - - - - - - - - - - -
PRD71 PROD 060601 JOB Hel d Wai t Schedul e
PRD453 PROD 060601 JOB Hel d Wai t Schedul e
PRD44 PROD 060601 JOB Hel d Wai t Schedul e
PRD85 PROD 060601 JOB Hel d Wai t Schedul e
PRD72 PROD 060601 JOB Hel d Wai t Schedul e
DAI LYPRD PRODMNGR 060601 JOB Wai t Schedul e
DAI LYSYS SYSTEM 060601 JOB Wai t Schedul e
CTMLDNRS PRODMNGR 060601 JOB Wai t Schedul e
CTMCLRES +- - - - - - - - - - - - - - - - - - - - - - - - + Wai t Schedul e
C SELI GRP <- - - - - - - - | Conf i r m ( Y/ N) | Ended- Not " OK"
GRPJOB3 +- - - - - - - - - - - - - - - - - - - - - - - - + Ended- Not " OK" - Abended
DAI LYPRD PRODMNGR 060601 JOB Wai t Schedul e
DAI LYSYS SYSTEM 060601 JOB Wai t Schedul e
CTMLDNRS PRODMNGR 060601 JOB Wai t Schedul e
CTMCLRES PRODMNGR 060601 JOB Wai t Schedul e
TST3 TEST 060601 JOB Ended " OK"
TST3 TEST 060601 JOB Ended " OK"
TST1 TEST 060601 JOB Request ed Rer un Ended " OK"
( Run 2)
Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 12. 17. 59
Tracking and Control Facility
Chapter 2 Online Facilities 223
Fill in the CONFIRM field with one of the following values, and press Enter:
s Y (Yes) Submission or rerun of the job is requested
The status of the job is changed to WAIT SCHEDULE, and the job is eligible for
submission by CONTROL-M once all other runtime criteria are satisfied.
s N (No) No action is taken
The status of the job remains unchanged and the job is not submitted.
Restart Confirm Restart Window (Under
CONTROL-M/Restart)
When CONTROL-M/ Restart is available, and the job scheduling definition of a job
whose execution fails contains a DO IFRERUN statement, the job can be restarted.
Manual intervention is required for the job restart if the job appears in the Active
Environment screen with a status of WAIT CONFIRMATION (WITH RESTART). For
a job requiring restart, this status appears when all the following conditions exist:
s A DO RERUN statement is defined following the DO IFRERUN statement,
indicating that the job must be scheduled for restart or rerun.
s The CONFIRM field in the DO IFRERUN statement contains a value of Y (Yes),
indicating that confirmation is required before the job is restarted.
s A MAXRERUN value greater than zero is defined in the job scheduling definition,
but the number of reruns specified in this field has not yet been performed. In this
case, restart can be confirmed by entering option C (Confirm) for the job.
To confirm restart or rerun for such a job, enter option C (Confirm) for the job. A
restart confirmation window is then opened. The same confirmation window is
opened when requesting the rerun (option R) of a restart job in the Active
Environment screen. For the description and an example of the confirmation
window, see the following section. RestartRerun and/ or Restart Window (Under
CONTROL-M/ Restart).
RestartRerun and/or Restart Window (Under
CONTROL-M/Restart)
When CONTROL-M/ Restart is available, and the job scheduling definition of a job
whose execution fails contains a DO IFRERUN statement, the job can be restarted.
Tracking and Control Facility
224 CONTROL-M for OS/390 and z/OS User Guide
Manual intervention is required for the job restart in the following cases:
s No DO RERUN statement is defined following the DO IFRERUN statement in the
job scheduling definition. In this case, the job appears in the Active Environment
screen with a failed job status.
s The CONFIRM field of the DO IFRERUN statement contains a value of Y (Yes). In
this case, job appears in the Active Environment screen with a failed job status.
s No maximum number of reruns is defined in field MAXRERUN, or the maximum
number reruns defined in field MAXRERUN has been performed. In this case, the
job appears in the Active Environment screen with a status of ENDED NOT OK
RERUN NEEDED.
To manually request rerun and/ or restart for such a job, enter option R (Rerun) for
the job.
The following confirmation window is opened when either option R (Rerun) or
option C (Confirm) is entered in the Active Environment screen for a job requiring
rerun and/ or restart under CONTROL-M/ Restart.
Figure 53 Restart Active Environment Rerun and/or Restart Confirmation Window
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - DOWN <D> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - - St at us - - - - - - - - - - -
SALEGRP ACTG 060601 GRP Ended- Not " OK"
R GRPJOB3 ACTG 060601 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( 3. R) + nded
DAI LYPRD PRODMNGR 060601 | Job GRPJOB3 I s t o be Rer un |
DAI LYSYS SYSTEM 060601 | Pl ease Conf i r m ( Y/ N) |
CTMLDNRS PRODMNGR 060601 | Wi t h Rest ar t Y ( ?/ Y/ N) |
CTMCLRES PRODMNGR 060601 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - |
PRD3 PROD 060601 | Fr om St ep/ Pr oc . |
PRD3 PROD 060601 | To St ep/ Pr oc . |
PRD1 PROD 060601 | Recapt ur e Abend Codes ( Y/ N) | d OK"
| Recapt ur e Cond Codes ( Y/ N) |
| St ep Adj ust ment ( Y/ N) |
PRD2 PROD 060601 | Rest ar t Par m Member Name GRPJOB3 | d OK"
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Pr i or Run: Ended " OK"
PRD3 PROD 060601 JOB Request ed Rer un Ended " OK"
( Run 2)
Pr i or Run: Ended " OK"
I EFBR14 TEST 060601 N91NOP / 26911 JOB Ended " OK"
I EFBR14 TEST 060601 N91NOP / 26923 JOB Ended " OK"
Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 12. 03. 10
Tracking and Control Facility
Chapter 2 Online Facilities 225
Fill in the fields of the window as follows, and press Enter:
Table 74 Restart Fields of the Active Environment Rerun and/or Restart
Confirmation Window (Part 1 of 3)
Field Description
Confirm Valid values are:
s Y (Yes) Job rerun is requested. The job is returned for
possible resubmission by CONTROL-M (provided that all
runtime conditions are met). The status of the job is
changed according to the value of the With Restart field.
s N (No) No action is taken. The job is not rerun. The status
of the job remains unchanged.
With Restart This field is applicable only if Y is entered for Confirm. If N is
entered for Confirm, this field is ignored. Valid values are:
s Y (Yes) When the job is rerun, it is restarted using the
Restart facilities of CONTROL-M/ Restart . The status of
the job is changed to WAIT SCHEDULE (WITH
RESTART).
s N (No) The Restart facilities of CONTROL-M/ Restart are
not used. The status of the job is changed to WAIT
SCHEDULE.
s ? Opens the Restart Step List window, which contains a
list of the jobs steps. This list can then be used for
specifying From Step and To Step values. For more
information, see RestartStep List Window on
page 228.
From Step/ Proc The pgmstep (and optionally procstep) names at which the
restart of the job is to be attempted.
To Step/ Proc The pgmstep (and optionally procstep) names at which the
restarted job terminates processing. Optional.
The From Step/ Proc and To Step/ Proc fields display from and
to step values specified in the DO IFRERUN statement. These
values may be modified.
If a From Step/ Proc value is specified, and the To Step/ Proc
field is blank, the job is rerun up to and including the last step.
Tracking and Control Facility
226 CONTROL-M for OS/390 and z/OS User Guide
Recapture Abend
Codes
Whether to enable abend code recapture. This field is
applicable only if Y is entered for WITH RESTART. (If N is
entered for WITH RESTART, this field is ignored.) Valid
values are:
s Y (Yes) Automatic abend code recapture is performed.
s N (No) Abend code recapture is prevented.
s ' ' (Blank) The job member or the $DEFAULT member in
the CTR.PARM library is used. If the $DEFAULT member
is not found, the CONTROL-M/ Restart default is used to
perform the recapture.
Note: If ordering a restart of a job from a step after an abended
step, type N in this field. If not, only steps that specify the JCL
parameters COND=ONLY or COND=EVEN run during
restart.
Recapture Cond
Codes
This field is applicable only if Y is entered for With Restart. (If
N is entered for With Restart, this field is ignored.) Valid
values are:
s Y (Yes) Automatic condition code recapture is performed
s N (No) Condition code recapture is prevented
s ' ' (Blank) The job member or the $DEFAULT member in
the CTR.PARM library is used. If the $DEFAULT member
is not found, the CONTROL-M/ Restart default is used to
perform the recapture.
Step Adjustment This field is applicable only if Y is entered for With Restart. (If
N is entered for With Restart, this field is ignored.) Valid
values are:
s Y (Yes) Automatic step adjustment is performed.
s N (No) Step adjustment is prevented.
s ' ' (Blank) The job member or the $DEFAULT member in
the CTR.PARM library is used. If the $DEFAULT member
is not found, the CONTROL-M/ Restart default is used to
perform the step adjustment.
Table 74 Restart Fields of the Active Environment Rerun and/or Restart
Confirmation Window (Part 2 of 3)
Field Description
Tracking and Control Facility
Chapter 2 Online Facilities 227
Note the following points about From Step/ Proc and To Step/ Proc values:
s Pgmstep name can be any specific program step name or $FIRST. $FIRST resolves
to the first step of the job if procstep name is blank. Otherwise, $FIRST resolves to
the first step in the procedure identified by procstep.
s $ABEND and $EXERR are not recognized by CONTROL-M/ Restart and must not
be specified as restart steps in this window. ($ABEND and $EXERR are valid only
in job scheduling definitions.)
s If specifying a procstep name when there are nested procedures, specify the
procstep name of the innermost procedure in which the program is included.
s Entering $FIRST in the first From Step/ Proc field followed by $CLEANUP in the
adjacent (second) From Step/ Proc field reruns the job for Cleanup (that is, run the
CONTROL-M/ Restart cleanup step and flushes the job). All other parameters
entered in the Restart window are ignored.
The RERUN request and, in CONTROL-M/ Restart, the RESTART decision are
recorded in the IOA Log file. If the CONTROL-M monitor is active, the RERUN
request is accepted after a few seconds.
Note: Values specified for Recapture Abend Codes, Recapture Cond Codes and Step
Adjustment override all other parameter specifications and the default. They apply
to the current restart only.
Restart Parm
Member Name
Name of the member that contains control parameters for the
job restart. The specified value must be a valid member name
of 1 through 8 characters. The default value, displayed in the
window, is the member that contains the JCL of the job. This
member is either the value in the MEMNAME field of the
Zoom screen, or the NAME field of the Active Environment
screen.
NOTE
AutoEdit resolution is performed at time of cleanup job submission. For example, if a
job with AutoEdit date variable %%DATE is submitted for cleanup the day after the
original run, the resolution of the variable during cleanup varies from that of the
original run.
Table 74 Restart Fields of the Active Environment Rerun and/or Restart
Confirmation Window (Part 3 of 3)
Field Description
Tracking and Control Facility
228 CONTROL-M for OS/390 and z/OS User Guide
RestartStep List Window
A list of the job steps from the previous job run, with the completion codes of each
step, can be displayed from the Restart window in the Active Environment screen.
Steps from this list can then be selected as From Step/ Proc and/ or To Step/ Proc
values in the Restart window.
To display the list of job steps, type a ? symbol in the With Restart field of the Restart
window, and press Enter. The Step List window, below, is opened. This window
within a window contains the list of job steps.
Figure 54 Restart Rerun and/or Restart Step List Window
To locate a specific step, type the LOCATE command in the Command field of the
CONTROL-M/ Restart Stop List window and press Enter. The format of the
command is:
Steps selected in the Step List window are displayed in the appropriate field of the
Restart window. To select steps, type the appropriate selection values in the Option
(O) field by the step names. Valid selection values are shown in Table 75.
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - UP <D> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - - St at us - - - - - - - - - - -
PRD71 PROD 060601 JOB Hel d Wai t Schedul e
PRD453 PROD 060601 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( 3. R) +
PRD44 PROD 060601 | Job GRPJOB3 I s t o be Rer un |
PRD85 PROD 060601 | Pl ease Conf i r m ( Y/ N) |
PRD72 PROD 060601 | +- - - - - - - - - - - CONTROL- R St ep Li st - - - - - - - - - - - - +
SELI GRP M70 060601 | | Command ==> |
R GRPJOB3 M70 060601 | | O Num Pgm- st p Pr oc- st p Pgm= Comp |
TST1 TEST 060601 | | 001 STEP1 I EBGENER C0000 |
TST2 TEST 060601 | | 002 STEP2 XYZA7891 S806 |
TST3 TEST 060601 | | |
DAI LYPRD PRODMNGR 060601 | | |
DAI LYSYS SYSTEM 060601 | | |
CTMLDNRS PRODMNGR 060601 +- | |
CTMCLRES PRODMNGR 060601 | |
I EFBR14 PROD 060601 N9 | |
I EFBR14 PROD 060601 N9 | |
I EFBR14 PROD 060601 N2 | |
I EFBR14 PROD 060601 | Opt : F Fr om T To O Onl y |
========= >>>>>>>>>>>>> +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + =
Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 12. 43. 09
LOCATE st epname
Tracking and Control Facility
Chapter 2 Online Facilities 229
Pressing the END key (PF03/PF15) closes the Step List window and automatically
updates the From Step/ Proc and To Step/ Proc fields of the Restart window with the
appropriate steps.
Typing the command RESET, or pressing the RESET key (PF04), closes the Step List
window without updating the Restart window.
RestartJob Order Execution History Screen
The Job Order Execution History screen is displayed when option V (View Sysout) is
entered on the Active Environment screen. The Job Order Execution History screen
lists all runs of the job and displays relevant execution information for each run.
This option is used for jobs that have executed at least once and whose SYSDATA has
been automatically archived by the CONTROL-M monitor as part of
CONTROL-M/ Restart processing (Auto-Archive=Y). The V option does not support
the viewing of output on the spool or output that has been archived by a
CONTROL-M SYSOUT F function.)
Table 75 Restart Options of the Rerun and/or Restart Step List Window
Option Description
F (From) Restart begins at the indicated step. The indicated step
becomes the From Step/ Proc parameter.
T (To) Restart ends at the indicated step. The indicated step becomes
the To Step/ Proc parameter.
O (Only) Restart begins and ends at the indicated step. The indicated
step becomes the From Step/ Proc and To Step/ Proc
parameter. This value cannot be specified with an F or a T
value.
NOTE
If a step cannot be used as a From Step/ Proc and/ or To Step/ Proc for restart, the
Option field is protected, and an option cannot be entered, for that step.
Tracking and Control Facility
230 CONTROL-M for OS/390 and z/OS User Guide
Figure 55 Restart Job Order Execution History Screen
By default, older data are displayed before more recent data (that is, in FIFO order
first in, first out), so that the first run of the job is shown first. If, however, the user
profile has been customized accordingly, data is displayed in LIFO order (last in, first
out).
The Job Order Execution History screen is pre-configured to the D (Default) display
type. Additional display types may be defined by the INCONTROL administrator. To
display a different display type on the screen, type command DISPLAY x
(abbreviated DI x) where x is the identifying letter of the display type (such as DI D).
To return to the Active Environment screen, press the END key (PF03/PF15).
Restart Format of the Job Order Execution History Screen
The following information about the job is displayed in the Default display type of
the Job Order Execution History screen.
- - - - - - - - - - - - - - - - - - - - - - - - JOB ORDER EXECUTI ON HI STORY - - - - - - - - - - - - - - - - - - - - - ( 3. V)
COMMAND ===> SCROLL===> CRSR
MEMNAME MSGCMPR OWNER M05A ORDERI D 00051 ODATE 060601
O JOBNAME JOBI D DATE START ELAPSED PAGES MAX RC - - - - - - - - - STATUS - - - - - - - - -
PRDYLLM 01318 060601 21: 40 1. 46 00007 S222 ENDED- NOT " OK" - ABENDED
PRDYLLM 01425 060601 21: 56 1. 21 00014 C0008 ENDED- NOT " OK" DUE TO CC
PRDYLLM 01447 060601 22: 01 1. 50 00014 ENDED- OK
======= >>>>>>>>>>> BOTTOM OF ACTI VE JOB ORDER HI STORY LI ST <<<<<<<<<<< =======















OPTI ON: S SELECT 11. 41. 04
Table 76 Restart Default Display Type Fields of Job Order Execution History
Screen
Field Description
MEMNAME Name of the member containing the jobs JCL.
OWNER User ID of the owner of the job.
ORDERID Job order ID.
ODATE Original scheduling date of the job.
Tracking and Control Facility
Chapter 2 Online Facilities 231
For each execution of the job, the following information is displayed:
Restart Displaying Job Sysout
Job execution sysout, which is displayed in the Sysout Viewing screen, can be
requested from the Job Order Execution History screen in the following ways:
s To display job sysout for specific executions of the job, type the option S (Select) in
the OPTION field of the selected executions and press Enter.
s To display job sysout for all executions of the job, type the command VIEWALL
(abbreviated V) in the COMMAND field and press Enter.
Restart Sysout Viewing Screen
The Sysout Viewing screen is displayed when the option S (Select) is entered for
specific job executions, or when the command VIEWALL is entered, in the Job Order
Execution History screen.
This screen displays the job execution sysout, as follows:
s If the option S (Select) was typed in the Job Order Execution History screen for
specific executions of the job, the sysout for those executions are displayed.
s If the command VIEWALL was entered in the Job Order Execution History screen,
the sysout for all executions is displayed.
Table 77 Restart Fields in the Job Order Execution History Screen
Field Description
O Option field.
JOBNAME Job name.
JOBID JES job number.
DATE Execution date of the job.
START Start time of the job execution (format hh:mm).
ELAPSED Total elapsed time of the job execution (format mmmm.nn
where mmmm is minutes, and nn is hundredths of minutes).
PAGES Number of pages in the sysout.
MAX RC Highest return code of the job execution.
STATUS Status assigned to the job by CONTROL-M, based on
execution results.
Tracking and Control Facility
232 CONTROL-M for OS/390 and z/OS User Guide
Figure 56 Restart Sysout Viewing Screen
Job orders are displayed in the same order (LIFO/ FIFO) in this screen as in the Job
Order Execution History screen.
To return to the Job Order Execution History screen, press END (PF03/PF15).
The following commands are supported:
For color terminals, display colors for the sysout are defined in the user profile. If you
want to change the default colors, see your INCONTROL administrator.
- - - - - - - - - - - - CONTROL- M/ CONTROL- R SYSOUT VI EWI NG - - - - - - - - PAGE 1 OF 12
COMMAND ===> SCROLL===> CRSR
MEMNAME PRDKPL01 OWNER M22 JOBNAME PRDKPL01 ODATE 060601
- - - +- - - - 1- - - - +- - - - 2- - - - +- - - - 3- - - - +- - - - 4- - - - +- - - - 5- - - - +- - - - 6- - - - +- - - - 7- - - - +- - - - 8
J E S 2 J O B L O G - - S Y S T E M F D S F - - N O
18. 31. 20 JOB 8666 $HASP373 PRDKPL01 STARTED - I NI T 1 - CLASS A - SYS FDSF
18. 31. 20 JOB 8666 I EF403I PRDKPL01 - STARTED - TI ME=18. 31. 20
18. 35. 21 JOB 8666 PRDKPL01. STEP01 . #01; - COMPLETI ON CODE=0000
18. 39. 22 JOB 8666 PRDKPL01. STEP01A . #02; - COMPLETI ON CODE=0000
18. 42. 22 JOB 8666 PRDKPL01. STEP02 . #03; - COMPLETI ON CODE=0000
18. 50. 23 JOB 8666 PRDKPL01. STEP03 . #04; - COMPLETI ON CODE=0000
18. 51. 25 JOB 8666 I EF450I PRDKPL01 STEP04 - ABEND S0C4 U0000 - TI ME=18. 51. 25
18. 51. 25 JOB 8666 PRDKPL01. STEP04 . #05; - COMPLETI ON CODE=S00C4 - ABENDED####
18. 51. 25 JOB 8666 PRDKPL01. STEP05 . #06; - COMPLETI ON CODE=NOT RUN
18. 51. 25 JOB 8666 PRDKPL01. STEP06 . #07; - COMPLETI ON CODE=NOT RUN
18. 51. 25 JOB 8666 PRDKPL01. STEP07 . #08; - COMPLETI ON CODE=NOT RUN
18. 51. 26 JOB 8666 PRDKPL01. STEP08 . #09; - COMPLETI ON CODE=NOT RUN
18. 51. 26 JOB 8666 PRDKPL01. STEP09 . #10; - COMPLETI ON CODE=NOT RUN
18. 51. 26 JOB 8666 PRDKPL01. STEP10 . #11; - COMPLETI ON CODE=NOT RUN
18. 51. 26 JOB 8666 I EF404I PRDKPL01 - ENDED - TI ME=18. 51. 26
18. 51. 26 JOB 8666 $HASP395 PRDKPL01 ENDED
- - - - - - JES2 JOB STATI STI CS - - - - - -
COMMANDS: LEFT, RI GHT, FI ND st r , FI ND st r PREV, N n, P n, END 18. 56. 48
Table 78 Restart Commands of the Sysout Viewing Screen
Command Description
LEFT Shift display to the left.
RIGHT Shift display to the right.
Note: Terminals with 132-character lines display the entire data line. Therefore,
LEFT and RIGHT do not affect the display on those terminals.
FIND str Find next occurrence of the string.
FIND str PREV Find previous occurrence of the string.
NEXT n Scroll forward n number of print pages (can be abbreviated
N n).
PREV n Scroll backward n number of print pages (can be abbreviated
P n).
END Exit the screen.
Tracking and Control Facility
Chapter 2 Online Facilities 233
Statistics Screen
The Statistics screen displays the most current run statistics for a particular job. The
screen is displayed when any of the following actions is performed:
s Option S (STAT) is typed next to the jobname in the Active Environment screen.
s Option T (JOBSTAT) is typed next to the job name in the Job List screen.
s Command JOBSTAT is typed in Command field of the Job Scheduling Definition
screen or the Active Environment screen.
Job statistics are collected for executions that ended OK. A separate set of statistics is
collected for each group on each computer in which the job is run. Statistics for a job
are retained for a maximum of 20 executions (that ended OK) in each group on each
computer.
Figure 57 Active Environment Statistics Screen
To return to the Active Environment screen, press the END key (PF03/PF15).
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - PLUPDT02 STATI STI CS - - - - - - - - - - - - - - - - - - - - - - - - ( 3. S)
COMMAND ===> SCROLL===> CRSR
JOBI D STRT DATE/ TI ME END DATE/ TI ME ELAPSED CPU SRB USER DATA
AVERAGE: SYSI D: 1 SMFI D: SYS1 27. 40 1: 16. 91 0: 20. 53
02395 03/ 02/ 01 20: 19 03/ 02/ 01 20: 45 26. 14 0: 58. 08 0: 19. 39
06433 02/ 01/ 01 17: 56 02/ 01/ 01 18: 24 28. 42 1: 05. 18 0: 21. 08
03996 02/ 02/ 01 20: 35 02/ 02/ 01 21: 01 26. 17 0: 58. 46 0: 19. 41
21412 03/ 07/ 01 17: 59 03/ 07/ 01 18: 25 26. 53 0: 59. 32 0: 20. 08
04937 07/ 03/ 01 17: 40 07/ 03/ 01 18: 08 28. 40 1: 03. 44 0: 21. 07
06198 07/ 04/ 01 20: 07 07/ 04/ 01 20: 35 28. 19 1: 03. 03 0: 21. 41
08881 08/ 02/ 01 23: 11 08/ 02/ 01 23: 39 28. 22 1: 04. 43 0: 21. 43
17234 04/ 04/ 01 17: 52 04/ 04/ 01 18: 19 27. 56 1: 01. 59 0: 20. 44


AVERAGE: SYSI D: 14 SMFI D: OS32 5. 00 0: 00. 07 0: 00. 00
12838 14/ 11/ 00 15: 20 14/ 11/ 00 15: 25 5. 00 0: 00. 07 0: 00. 00
12826 14/ 11/ 00 15: 11 14/ 11/ 00 15: 16 5. 00 0: 00. 08 0: 00. 00
12812 14/ 11/ 00 15: 00 14/ 11/ 00 15: 05 5. 00 0: 00. 07 0: 00. 00
12790 14/ 11/ 00 14: 47 14/ 11/ 00 14: 52 5. 00 0: 00. 07 0: 00. 00




PRESS END PFK TO RETURN TO ACTI VE SCREEN 12. 31. 15
NOTE
The INCONTROL administrator determines whether statistics are collected at a site.
Update of the Statistics file is performed by the CTMJSA utility, which must be
scheduled periodically. The CTMJSA utility is described in the INCONTROL for
OS/390 and z/OS Utilities Guide.
Tracking and Control Facility
234 CONTROL-M for OS/390 and z/OS User Guide
Fields of the Statistics Screen
For each computer with statistics on the job, an Average Statistics line is displayed
followed by individual job or Group Entity statistics for each execution. Individual
job and Group Entity statistics are listed in descending chronological order, with the
most recently ended job at the top.
Average Statistics Line
The Average Statistics Line contains the SYSID and SMF ID of the computer for
which statistics are calculated, as well as the average ELAPSED, CPU and SRB time
for the job on that computer.
Individual Execution Statistics
WARNING
If statistics that exist for a job are not displayed, refresh the display by entering the
REFRESH command (PF04/PF16).
NOTE
As of version 6.x.10, the SYSID consists of one or two digits, left-justified.
Table 79 Statistics Screen Individual Execution Statistics
Field Description
JOBID Job number under JES.
STRT DATE/ TIME Date and time the job began executing.
Date format: mmddyy, yymmdd or ddmmyy depending on
site standard.
Time format: hh:mm, where hh=hours and mm=minutes.
END DATE/ TIME Date and time the job finished executing. Same format as STRT
DATE/ TIME.
ELAPSED Elapsed runtime. Format: mmmm.ss, where mmmm is
minutes and ss is seconds.
CPU CPU time used. Format mmmm:ss.nn, where mmmm is
minutes, ss is seconds and nn is hundredths of seconds.
SRB SRB (System Request Block) time used. Format: mmmm:ss.nn,
where mmmm is minutes, ss is seconds and nn is hundredths
of seconds.
USER DATA Optionally supplied data from the user data area in the
CONTROL-M Statistics file (edited by user Exit CTMX013).
Tracking and Control Facility
Chapter 2 Online Facilities 235
Group Entity Execution Statistics
Fields of the Group Entity Execution statistics have different meanings than
corresponding fields of the Individual Execution statistics.
Tape Device Usage Statistics
If the AUTOTAPE parameter in the CTMPARM member in the IOA PARM library is
set to Yes, tape device usage information is accumulated for every CONTROL-M job
execution that ended OK. This information is used by the Automatic Tape
Adjustment facility to automatically allocate the appropriate number of tape drives
for a job at job order time. This allocated value overrides any specified tape device
usage value in the RESOURCE parameter. For more information, see the discussion
of using the automatic tape adjustment facility in the INCONTROL for OS/390 and
z/OS Administrator Guide.
This information (shown below) can be displayed by scrolling to the right of the
Statistics screen (using PF11/PF23):
Figure 58 Tape Device Usage Statistics
The tape usage information consists of fields JOBID and START date (from the
Statistics screen) so that tape usage of a specific job execution can be easily identified,
and an additional field, DEVICES USED, which is described below.
Table 80 Statistics Screen Group Entity Execution Statistics
Field Description
JOBID Order ID of the group entity.
STRT DATE/ TIME Date and time the group began executing.
Date format: mmdd or ddmm depending on site standard.
Time format: hh:mm (where hh=hours and mm=minutes).
END DATE/ TIME Date and time the group finished executing. Same format as
STRT DATE/ TIME.
ELAPSED Elapsed time from the time the first job in the group began
executing until the time the last job in the group finished
executing.
CPU 0
SRB 0
USER DATA Blank
JOBI D STRT DATE DEVI CES USED
AVERAGE: SYSI D:
0239 05/ 02/ 01 TAPE=1; CARTRI DGE=1;
0643 06/ 02/ 01 TAPE=1; CARTRI DGE=1;
0399 07/ 02/ 01 TAPE=1; CARTRI DGE=1;
2141 12/ 02/ 01 TAPE=1; CARTRI DGE=1;
0493 13/ 02/ 01 TAPE=1; CARTRI DGE=1;
Tracking and Control Facility
236 CONTROL-M for OS/390 and z/OS User Guide
The DEVICES USED field contains tape device types and number of devices of each
type that were used by the job. This field has the following format:
where:
s devtype A tape device type used by the job.
s quant The number of tape devices of the specified type used by the job.
Tape device types are displayed in the order specified by the INCONTROL
administrator in the UNITDEF member of the IOA PARM library.
If the tape device usage information occupies more than the visible screen, scroll
again to the right (using PF11 or PF23) to view additional device usage information.
The maximum length of tape device usage data is 255 characters.
Job Dependency Network Screen
The Job Dependency Network screen is displayed when option N (Network) is
entered on the Active Environment screen. The Job Dependency Network screen
displays all the predecessor and successor jobs (including eventual successors and
predecessors) for the selected job.
Job dependencies are determined according the prerequisite IN and OUT conditions
of the job. DO COND statements are not used for this purpose because the
dependencies they create are conditional rather than constant.
The Job Dependency Network screen is a special case of the Active Environment
screen, and therefore contains most of the same features. A filter that is active in the
Active Environment screen also remains active in the Job Dependency Network
screen (and vice versa).
Jobs are listed in job flow order (that is, level) relative to the selected job. The selected
job is indicated by level 0. Predecessor jobs are indicated by a minus sign and
successor jobs are indicated by a plus sign.
The network of jobs is maintained by the CONTROL-M monitor, and is refreshed
only by request. The REFRESH Command is described in Commands of the Job
Dependency Network Screen on page 239. The time of the last network refresh is
displayed on the top line of the Job Dependency Network screen.
To return to the Active Environment screen, press the END key (PF03/PF15).
devt ype1=quant 1; devt ype2=quant 2; . . . devt ypex=quant x;
Tracking and Control Facility
Chapter 2 Online Facilities 237
Features of the Job Dependency Network screen that have already been described
earlier for the Active Environment screen are not described below. Refer to the Active
Environment screen for information about those features. However, note the
following points:
s The RBAL command of the Active Environment screen is not supported in the Job
Dependency Network screen. This difference is also reflected in the Primary
Bottom lines of the two screens.
s The N (Network) display type is specifically oriented to the Job Dependency
Network screen, and is therefore described in the following section. It is also
available in the Active Environment screen.
For a description of the fields in the D (Default) display type and the A (All Info)
display type, see Format of the Active Environment Screen on page 169.
Format of Job Dependency Network Information
Display Type N (Network)
The Network display type is intended for use by the INCONTROL administrator and
operations personnel. Basic information is displayed for each job.
Figure 59 Job Dependency Network Display Type N (Network)
Fi l t er : DEFAULT - - - - - - - CONTROL- M NETWORK OF BGPCBHK6 - - - - - - UP <N> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Level - - - - - N a m e - - - - - DueI N/ Out El aps Lat e Pr i o Res - - - - - - St at us - - - - -
- 6 JOBPREP1 1206 1209 0003 9 WAI T SCHEDULE
- 5 CHECKFL1 1209 1212 0003 9 WAI T SCHEDULE
- 5 JOBPREP2 1212 1215 0003 9 WAI T SCHEDULE
- 5 CHECKFL2 1215 1218 0003 9 WAI T SCHEDULE
- 4 CHECKFL3 1218 1221 0003 9 WAI T SCHEDULE
- 4 LOGLI ST 1221 1224 0003 9 WAI T SCHEDULE
- 4 FLOWCHK 1224 1227 0003 9 WAI T SCHEDULE
- 3 MAI NTST 1227 1230 0003 9 WAI T SCHEDULE
- 2 SAMP 1230 1233 0003 9 WAI T SCHEDULE
- 1 FLOWPRT 1233 1236 0003 9 WAI T SCHEDULE
- - > RGL1 1236 1239 0003 9 WAI T SCHEDULE
+1 RGL2 1239 1242 0003 9 WAI T SCHEDULE
+2 RGLCHK 1242 1245 0003 9 WAI T SCHEDULE
+3 RGL3 1245 1248 0003 9 WAI T SCHEDULE
+4 DELCHK 1248 1251 0003 9 WAI T SCHEDULE
+5 DELLOG 1251 1254 0003 2 WAI T SCHEDULE
+6 DELRUN 1254 1257 0003 2 WAI T SCHEDULE
+7 CLEANUP 1257 1300 0003 2 WAI T SCHEDULE
========= >>>>>>>>>>>>> Bot t om of Jobs Li st <<<<<<<<<<<<< =========
Commands: OPt DI spl ay Show HI st or y REFr esh Aut o Jobst at SHPF Not e Tabl e
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 15. 15. 48
Tracking and Control Facility
238 CONTROL-M for OS/390 and z/OS User Guide
Table 81 Fields of the Job Dependency Network Display Type N (Network)
Field Description
Filter Name of the currently active screen filter. For more
information, see Filtering the Active Environment Screen
Display on page 189.
CONTROL-M
status
Indicator of whether the CONTROL-M monitor is UP, DOWN
or SUSP (suspended).
Display Type
Indicator
Indicator of the currently used display type, for example, N for
the Network display type.
The following are displayed for each job:
O(ption) Field for requesting options to be activated.
Level Successor or predecessor level relative to the selected job. The
current job is indicated by -->. Predecessor jobs are indicated
by a minus sign and successor jobs are indicated by a plus
sign. Jobs that have several paths to or from the selected job
appear with the shortest possible route as their level number.
Name Name of the member containing the jobs JCL, or name of the
started task.
DueIN Due in time. Time by which the job must be submitted.
DueOut Due out time. Time by which the job must finish executing.
Elaps Elapse time. Expected time (in minutes) for the job to execute.
Late Indication that a job is late. Possible values:
s X Actual execution has not completed within the
expected execution time. Also indicates that SHOUT
WHEN EXECTIME was issued.
s I Job was not submitted in time. Also indicates that
SHOUT WHEN LATESUB was issued.
s O Job is late. Also indicates that SHOUT WHEN LATE
was issued.
Prio CONTROL-M priority of the job.
Res Indicator that the job accesses Quantitative resources. Valid
values are:
s ' ' (Blank) Quantitative resources are not accessed
s Y (Yes) Quantitative resources are accessed
Status Job (task) status.
Tracking and Control Facility
Chapter 2 Online Facilities 239
Commands of the Job Dependency Network Screen
Except for command REFRESH, detailed descriptions of the Job Dependency
Network screen commands can be found in Commands of the Active Environment
Screen on page 172.
Command REFRESH is described here in detail because this command is most
relevant to the Job Dependency Network screen.
Command REFRESH causes the CONTROL-M monitor to recalculate job
dependencies. During the refresh, that is, from the time the refresh is initiated until
the refresh is completed, a special status message is displayed at the top of the screen.
The format of the command is:
where parm is the type of refresh to be performed.
The following parameters may be entered with the REFRESH command:
Restart History Environment Screen
If CONTROL-M/ Restart is installed, jobs can be automatically moved from the
Active Jobs file to the History Jobs file during the subsequent New Day processing.
REFRESH par m
Table 82 Parameter of the REFRESH Command
Parameter Description
NET Update the list of dependent jobs in the Job Dependency
Network screen. As soon as possible, the monitor recalculates
logical dependencies for all job orders currently present in the
Active Jobs file and updates the Job Dependency Network
screen. Default.
DEADLINE Adjust DUE OUT times, if necessary, for all job orders in the
Active Jobs file that are not Held. For an explanation of the
method used to recalculate DUE OUT time, see Automatic
Job Flow Adjustment on page 74.
PROPAGATE Check and adjust the priority of predecessor jobs. For more
information, see Automatic Job Flow Adjustment on
page 74.
ALL Activates the processes described above (NET, DEADLINE
and PROPAGATE) simultaneously in the CONTROL-M
monitor.
Tracking and Control Facility
240 CONTROL-M for OS/390 and z/OS User Guide
Jobs in the History Jobs file can be displayed in the History Environment screen.
The History Environment screen is a special case of the Active Environment screen. It
is displayed when command HISTORY is typed in the Command field in the Active
Environment screen.
Figure 60 Restart History Environment Screen
Because the History Environment screen is a special case of the Active Environment
screen, the features of the two screens are almost identical, and are described in
Active Environment Screen on page 166. Differences between the screens are as
follows:
The selection of line options available in the History Environment screen is different
than the selection of line options available in the Active Environment screen. Below is
the Alternate Bottom line of the History Environment screen.
The OPT command toggles between Commands and Options display.
Upon exiting the History Environment screen (by pressing PF03/PF15), the Active
Environment screen is displayed.
Fi l t er : DEFAULT - - - - - - - CONTROL- M Hi st or y Envi r onment - - - - - - DOWN - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
DAI LYSYS SYSTEM 060601 JOB Wai t Schedul e
CTMLDNRS PRODMNGR 060601 JOB Wai t Schedul e
CTMCLRES PRODMNGR 060601 JOB Wai t Schedul e
GEN1 PRODMNGR 060601 PRDGEN1 / 17048 JOB Ended " OK"
GEN2 PRODMNGR 060601 PRDGEN2 / 17049 JOB Ended " OK"
GEN3 PRODMNGR 060601 PRDGEN3 / 17050 JOB Ended " OK"
GEN4 PRODMNGR 060601 PRDGEN4 / 17051 JOB Ended " OK"
GEN5 PRODMNGR 060601 PRDGEN5 / 17053 JOB Ended " OK"
TPCI CS47 TP05 060601 TPCI CS47/ 18081 JOB Ended " OK"
TPCI CS12 TP01 060601 TPCI CS12/ 18082 JOB Ended " OK"
GEN1 PRODMNGR 060601 PRDGEN1 / 18084 JOB Ended " OK"
GEN2 PRODMNGR 060601 PRDGEN2 / 18085 JOB Ended " OK"
TPCI CS05 TP05 060601 TPCI CS05/ 18090 JOB Ended " OK"
Y01ACCB ACCT 060601 Y01ACCB / 19053 JOB Ended " OK"
Y01ACCC ACCT 060601 Y01ACCB / 19150 JOB Ended " OK"
Y01ACCD ACCT 060601 Y01ACCB / 19230 JOB Ended " OK"
Y01ACCE ACCT 060601 Y01ACCB / 19232 JOB Ended " OK"
Y01ACCF ACCT 060601 Y01ACCB / 19233 JOB Ended " OK"
Y01ACCG ACCT 060601 Y01ACCB / 19501 JOB Ended " OK"
Commands: OPt DI spl ay Show HI st or y RBal REFr esh Aut o Jobst at SHPF Not e Tabl e
OPt command t oggl es bet ween Commands and Opt i ons di spl ay 14. 55. 34
Opt : L Log Z Zoom S St at R Rest or e J JCL Edi t V Vi ew Sysout
Tracking and Control Facility
Chapter 2 Online Facilities 241
Options of the History Environment Screen
The History Environment screen has the same options as the Active Environment
screen, with the addition of R Restore.
The R Restore option restores the specified job to the Active Jobs file and marks it as
deleted in the History Jobs file.
For a description of the remaining options, see Options of the Active Environment
Screen on page 180.
Force OK Confirmation Window
To change the status of a job to ENDED OK, type O (Force OK) in the option field to
the left of the job order and press Enter.
Status changes are performed as follows:
s If the job status is WAIT SCHEDULE, the status is changed to ENDED OK without
submitting the job. As a result, all resources required by the job are freed, and OUT
and SHOUT WHEN OK job post-processing are performed as if the job terminated
with status ENDED OK.
s If the job has an ON PGMST code of FORCE, and it terminates with status ENDED
NOTOK, the status is changed to ENDED OK. In addition, ON PGMST post
processing is performed for the following DO actions: DO COND, DO FORCEJOB,
DO SETVAR, and DO SHOUT. For more information about the code FORCE, see
the table of parameter values for use with the ON Post Processing Parameter in
ON: PostProcessing Parameter on page 534.
The same effect is achieved if a job has the ON PGMST parameter with value
ANYSTEP specified with the code OK, if the FRCOKOPT parameter in the
CTMPARM member in the IOA PARM library is set to Y, and if the command
FORCE OK is requested.
In the case of a cyclic job, Force OK works only after the job has reached an ENDED
status, such as the result of a DO STOPCYCLE command.
NOTE
If CONFIRM=Y was entered in the DO IFRERUN parameter in the job scheduling
definition, and you want to implement a Force OK request, you must type
C (Confirmation) and respond with CONFIRM=Y in the restart confirmation
window. This does not cause the job to restart, but instead implements the Force OK
request.
CMEM Rule Definition Facility
242 CONTROL-M for OS/390 and z/OS User Guide
A Force OK request is not performed if the job is currently being executed or rerun.
In the case of a Group Entity, Force OK works only if the Group Entity has an ENDED
status.
When requesting Force OK, the Force OK Confirmation window is displayed, unless
the user profile has been modified to suppress the window.
Figure 61 CONTROL-M Active Environment FORCE OK Confirmation Window
Fill in the window as follows and press Enter.
To confirm the Force OK request, type Y (Yes) in the window.
To cancel the Force OK request, type N (No) in the window.
CMEM Rule Definition Facility
The CONTROL-M Event Manager (CMEM) Rule Definition facility enables you to
create, view, or modify CMEM rules for the handling of events in your environment.
A CMEM rule consists of parameters that correspond to the decisions and actions to
be taken when handling the occurrence of specified external events.
A CMEM rule for a specific situation needs to be defined only once. Once defined, the
rule is saved and used as necessary for managing events. CMEM rules may be
modified or deleted as required.
Fi l t er : - - - - - - - CONTROL- M Act i ve Envi r onment - - - - - - UP <D> - ( 3)
COMMAND ===> SCROLL ==> CRSR
O Name Owner Odat e Jobname JobI D Typ - - - - - - - - - - - St at us - - - - - - - - - - - -
PRFUPRT P15 060601 PRFUPRT / 04587 JOB Ended " OK"
PRDKPL2 060601 PRDKPL2 / 04590 JOB Ended " OK"
PRDKPL03 +- - - - - - - - - - - - - - - - - - - - - - - - + Wai t Schedul e
O M44TEST <- - - - - - - - | For ce OK ( Y/ N) | Hel d Wai t Schedul e
PRLMBCK +- - - - - - - - - - - - - - - - - - - - - - - - + Wai t Schedul e
======= >>>>>>>>>>>>> Bot t om of Jobs Li st <<<<<<<<<<<< ========












Opt : ? Why L Log H Hol d Z Zoom R Rer un A Act i vat e O For ce OK V Vi ew Sysout
N Net D Del F Fr ee S St at G Gr oup U Undel et e J JCL Edi t C Conf i r m 14. 50. 56
CMEM Rule Definition Facility
Chapter 2 Online Facilities 243
CMEM rules are stored in members called rule tables. In many environments, several
rules can work together as a group to handle a specific situation. In these cases, it is
common to define all such related rules in a single rule table.
Any number of rule tables may be defined, and each rule table may contain any
number of CMEM rules.
CMEM rule tables (members) are stored in rule libraries (partitioned data sets). You
may define any number of rule libraries.
The number of rule tables in a library, the number of rules in a rule table, and the size
of each rule definition, are all calculated dynamically and are not dependent on
parameter specifications.
Accessing the CMEM Rule Facility
The CMEM Rule Definition facility contains the following screens:
To enter the CMEM Rule facility, type C in the OPTION field in the IOA Primary
Option menu and press Enter. The CMEM Rule entry panel is displayed.
Creating Tables
CMEM rule tables can be created in one of the following ways:
NOTE
The CMEM Rule Definition facility does not support members that have been
compressed using the ISPF PACK option.
Table 83 Rule Definition Facility Screens
Screen Definition
CMEM Rule entry
panel
Allows specification of parameters that determine which
screen is displayed.
Table List screen Displays the list of tables (members) in the specified CMEM
rule library.
Rule List screen Displays the list of rules in the selected table.
Rule Definition
screen
Displays the parameters of the selected CMEM rule. This is the
main screen of the facility.
CMEM Rule Definition Facility
244 CONTROL-M for OS/390 and z/OS User Guide
1. By typing the new table name in the entry panel and pressing Enter. The name of a
new rule for the new table may also be entered.
Upon using this method to request that a table be created, a skeletal CMEM rule
(that is, one with most fields not filled in) is displayed in the CMEM Rule
Definition screen.
Fill in and save this rule definition. The table is created and the rule is the first and
only rule in the Rule list of the table. As additional rules are created in the table
(described below), they are added to the Rule list.
2. Upon exiting the Rule List screen, if changes have been made to at least one rule,
an Exit Option window is displayed. One option of the window allows creation of
a new table in which the rules are saved.
Creating CMEM Rules
CMEM rules can be created using the following basic methods:
1. A skeletal rule definition can be created by typing the name of a new rule in the
entry panel. The table specified in the entry panel may be either a new or an
existing table. In this case, the fields in the rule definition are empty.
2. A basic copy of an existing rule can be created using the INSERT option in the Rule
List screen. In this case, most fields of the new rule definition contain the same
values as the fields in the copied rule. The INSERT option is described in Options
of the Rule List Screen on page 250.
Performing Operations on CMEM Tables and Rules
Many operations can be performed on CMEM rule tables and on the rules contained
within them. These operations are performed through commands and options in the
various screens of the CMEM Rule Definition facility.
Below is a brief summary of some of the major operations possible in the facility.
Options and commands that have not yet been explained are explained in detail
following the summary.
Accessing (Editing or Browsing) a Table and its Rules
A table (actually, the rules in the table) can be browsed or edited.
When browsed, the table cannot be modified or updated. When the table is edited,
new rules may be added and existing rules may be modified or deleted.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 245
Browsing, however, has advantages:
s Access and exit are quicker than in editing.
s A rule list and/ or rules that are in use by another user can be viewed.
s Access for browsing might be granted, even though access for editing might be
denied due to site security requirements.
To browse a table, and its rule list and the rules it contains, use the BROWSE option in
the Table List screen.
Typing the table name in the entry panel or using the SELECT option in the Table List
screen provides edit access.
Depending on user profile definitions, if the table requested for editing is in use,
either access is granted in Browse mode or access is not granted.
Deleting a Table or a Rule
Unneeded rules can be deleted by the DELETE option in the Rule List screen,
described in Options of the Rule List Screen on page 250. Unneeded tables can be
deleted by the DELETE option in the Table List screen, described in Deleting Tables
on page 158.
Ordering Rule Tables
Rule tables are ordered by option ORDER or FORCE in the Table List screen,
discussed in Ordering CMEM Rule Tables on page 261.
Saving Modifications
All changes made to a table and its rules are kept in memory until the table is exited.
Upon exiting the table, you may choose to save or cancel the changes, as described in
Exiting the CMEM Rule Definition Facility on page 258.
CMEM Rule Definition Facility
246 CONTROL-M for OS/390 and z/OS User Guide
Entry Panel
The entry panel is displayed upon entering the CMEM Rule Definition facility (option
C on the IOA Primary Option menu).
Figure 62 CMEM Rule Definition Facility Entry Panel
Fields of the Entry Panel
Fill in the following fields and press Enter.
- - - - - - - - - - - - - - - - - CMEM RULE DEFI NI TI ON FACI LI TY - ENTRY PANEL - - - - - - - - - - - - - - ( C)
COMMAND ===>



SPECI FY LI BRARY, TABLE NAME, RULE NAME

LI BRARY ===> CTM. PROD. RULES
TABLE ===> ( Bl ank f or t abl e sel ect i on l i st )
RULE ===> ( Bl ank f or r ul e sel ect i on l i st )













USE THE COMMAND SHPF TO SEE PFK ASSI GNMENT 22. 35. 51
Table 84 Fields of the Entry Panel (Part 1 of 2)
Field Description
LIBRARY Name of the desired CMEM rule library. Mandatory.
If this field is specified without filling in the TABLE field, the
list of tables in the specified library is displayed in the Table
List screen.
TABLE Name of the desired rule table. Optional.
If this field is specified without filling in the RULE field, the
list of rules in the specified member is displayed in the Rule
List screen. If a new table name is specified, a new rule
definition is displayed in the Rule Definition screen.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 247
Table List Screen
The Table List screen displays a list of rule tables (members) in the specified library.
This screen can be entered directly from the entry panel or upon exiting the Rule List
screen.
By default, only table names are listed in the screen. However, if the default has been
modified at time of installation, statistical information is displayed for each table
name (as shown below).
Figure 63 CMEM Definition Facility Table List Screen
To return to the entry panel, press the END key (PF03/PF15).
RULE Name of the desired rule. Optional.
This field can be specified only if a TABLE value is entered. If
specified, the requested rule is displayed in the Rule Definition
screen.
TABLES OF LI BRARY CTM. PROD. RULES - - - - - - - - - - - - - ( C)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - VV. MM CREATED CHANGED SI ZE I NI T MOD I D
PRDJACCT 01. 06 01/ 02/ 07 01/ 06/ 06 14: 29 56 56 0 M06
PRDJPYRL 01. 03 01/ 02/ 07 01/ 06/ 06 10: 11 56 56 0 M86B
PRDJFNC 01. 01 01/ 02/ 07 01/ 06/ 06 13: 06 6 6 0 N04A
PRDJMRKT 01. 01 01/ 02/ 07 01/ 06/ 06 15: 08 5 5 0 N04B
BACKUP 01. 01 01/ 02/ 07 01/ 06/ 06 14: 35 61 56 0 M06
TESTJ 01. 06 01/ 02/ 07 01/ 06/ 06 11: 16 6 56 0 M06
======= >>>>>>>>>>>>>>>> NO MORE TABLES I N THI S LI BRARY <<<<<<<<<<<<<< =======













OPTI ONS: S SELECT O ORDER F FORCE B BROWSE D DELETE 12. 11. 50
Table 84 Fields of the Entry Panel (Part 2 of 2)
Field Description
CMEM Rule Definition Facility
248 CONTROL-M for OS/390 and z/OS User Guide
Options of the Table List Screen
To request one of the following options, type the option in the OPT field to the left of
the table names and press Enter.
Rule List Screen
The Rule List screen displays the list of CMEM rules in the specified CMEM table.
The following fields are listed for each rule:
Table 85 Options of the Table List Screen
Option Description
S (SELECT) Display the list of rules in the table for any purpose, including
editing or modification. Only one table can be selected at a
time.
O (ORDER) Order all rules in the table, as described in Ordering CMEM
Rule Tables on page 261. Multiple tables can be ordered.
B (BROWSE) Display a list of rules in the table for browsing. Only one table
at a time can be browsed.
F (FORCE) Order all rules in the table. Because CMEM rules have no basic
scheduling parameters, this option works like the Order
option. Multiple tables can be forced.
D (DELETE) Delete the table (member) from the library. This is discussed in
Deleting Tables on page 158. Multiple tables can be deleted.
NOTE
Users whose access to options has been limited by the INCONTROL administrator
can only access the Browse option.
Table 86 Fields of the Rule List Screen (Part 1 of 2)
Field Description
OPT Select, Delete and Insert options can be entered in this field, as
described in Options of the Rule List Screen on page 250.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 249
This screen can be entered directly from the entry panel or the Table List screen, or
upon exiting from the Rule Definition screen.
Figure 64 CMEM Rule Definition Rule List Screen
TYPE The event type of the rule. The following event type codes
exist:
s R Job arrival
s X Job end
s D Data set
s Z Step
DESCRIPTION The description of the rule. This appears in the DESCRIPTION
field of the rule definition.
NOTE
If the S (Select) option was typed in the Table List screen for a table that is currently in
use (selected) by another user, either the Rule List screen is not displayed and the
Table List screen remains displayed (the default), or the Rule List screen is displayed
in Browse mode (if a user profile definition overrides the default). In either case, an
appropriate message is displayed.
RULES OF LI BRARY: CTM. PROD. RULES TABLE: TESTJ
COMMAND ===> SCROLL===> CRSR
OPT RULE TYP - - - - - - - - - - - - - - DESCRI PTI ON - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
JOBNAM1 R ON JOB JOBNAM1 ARRI VAL FORCEJOB
JOBN* 2 R ON JOB JOBN* 2 ARRI VAL ADDCOND
JOBNAM3 X ON JOB JOBNAM3 JOBEND FORCEJOB
JOBN* 4 X ON JOB JOBN* 4 JOBEND DELCOND
JOBDST* D ON JOB JOBDST* DATASET * DELETE FORCEJOB
MERGE D ON JOB MERGE DATASET * NCT 2
CI CSP D ON JOB CI CSP DATASET * CATLG ADDCOND
PROD* D ON JOB PROD* DATASET * NCT 2
======= >>>>>>>>>>>>>>>>> NO MORE RULES I N THI S TABLE <<<<<<<<<<<<<<<<< =======











OPTI ONS: S SELECT D DELETE I I NSERT C COPY 12. 22. 27
Table 86 Fields of the Rule List Screen (Part 2 of 2)
Field Description
CMEM Rule Definition Facility
250 CONTROL-M for OS/390 and z/OS User Guide
Commands of the Rule List Screen
The following commands may be typed in the COMMAND field of the Rule List
screen.
Options of the Rule List Screen
To request one of the following options, type the option in the OPT field to the left of
the rule names and press Enter.
Table 87 Commands of the Rule List Screen
Command Description
DESC The DESC command displays the rule description next to the
rule name. The description is taken from the DESCRIPTION
field in the rule.
STAT The STAT command displays the following ISPF-like
statistical information about the rule next to the rule name:
version and modification numbers, creation date, last
modification date, and user ID.
NOTE
If the Rule List screen is displayed in Browse mode, options D (Delete) and I (Insert)
are not available.
Table 88 Options of the Rule List Screen
Option Description
S (SELECT) Display the Rule Definition screen with details of the specific
rule. Only one rule can be selected at a time.
If the Rule List screen is not displayed in Browse mode, the
rule definition may be edited and updated. If the Rule
Definition screen is displayed in Browse mode, the rule
definition may only be browsed; it cannot be modified.
D (DELETE) Delete a rule from the Rule list (member). Multiple rules can
be selected for deletion.
I (INSERT) Insert a new rule in the list. The Rule Definition screen
appears, with the same details of the rule marked I. Only
one rule may be inserted at a time.
C (COPY) Copy the rule to another table. Multiple rules can be selected.
For more information, see Copying Rules to Another Table
on page 264.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 251
Rule Definition Screen Defining Rules
The Rule Definition screen is used to define, display and modify parameters of a
specific CMEM rule.
This screen can be entered directly from the entry panel or from the Rule List screen.
Update of parameters is not permitted in Browse mode.
The rule definition may take up more than one screen.
To delete a parameter on the screen, simply erase it by the EOF key or blank it out. If
additional action is required, CONTROL-M issues appropriate instructions.
Figure 65 Rule Definition Screen - Defining Rules
Rule parameters are divided into the following basic groups:
s Event Selection parameters
s General parameters
s Action parameters
A brief explanation of available parameters follows. For a detailed explanation of
each rule parameter, see Chapter 4, CONTROL-M Event Manager (CMEM).
RL: BKP* LI B CMEM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = BKP* JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON MONI TOR STARTUP OF BACKUP JOBS
DESCRI PTI ON
===========================================================================
/ * TELL CONTROL- M TO MONI TOR THI S JOB
/ *
DO FORCEJOB = TABLE BACKUP JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
/ *
DO
=============================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====







FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
CMEM Rule Definition Facility
252 CONTROL-M for OS/390 and z/OS User Guide
Event Selection Parameters
Event Selection parameters specify selection criteria under which actions are
performed by CMEM.
Figure 66 CMEM Rule Definition Event Selection Parameters - Example
NOTE
Parameters marked with the
M
symbol may have many occurrences. Whenever you
fill in the last occurrence of the parameter on the screen, CONTROL-M adds a new
empty occurrence of the parameter that can be filled in. The only limit to the number
of occurrences is the region size available for the application.
ON JOBARRI V = A* JTYPE J SMFI D SYSTEM And/ Or / Not O
ON JOBARRI V = C* JTYPE J And/ Or / Not
OWNER ADMI N GROUP CI CS MODE RUNTSEC

ON JOBEND = CI CSPROD JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE PROD RUNTSEC

ON DSNEVENT = PRD0001 JTYPE SMFI D SYSTEM
DSN PROD. * DI SP NCT2
PROCSTEP PGMSTEP STEPRC And/ Or / Not
OWNER ADMI N GROUP PRODJOBS MODE RUNTSEC

ON STEP = PRD0001 JTYPE SMFI D SYSTEM
PROCSTEP STEP2 PGMSTEP STEPRC OK And/ Or / Not
OWNER CTMCTLM GROUP MODE PROD RUNTSEC NONE
CMEM Rule Definition Facility
Chapter 2 Online Facilities 253
General Parameters
The following are General parameters that apply to the rule.
Figure 67 General Parameters
Table 89 CMEM Rule Definition Event Selection Parameter
Parameter Description
ON statementM Conditions under which the rule is to be performed.
Subparameters may be displayed.
Valid ON statement values are:
s ON JOBARRIV Job name (or mask) of a job or started
task that arrived on the JES spool from any source.
s ON JOBEND Job name (or mask) of a job or started task
that terminated.
s ON DSNEVENT Name (or mask) of a job or started task
or TSO user to be monitored for data set events (including
NOT CATLGD 2 events).
s ON STEP Name (or mask) of a job procedure step (and
optionally, program step) that terminated, and its desired
return code.
AND/ OR/ NOTM Conjunctional subparameter that enables linking of ON
statements.
ON JOBARRI V = BKP* JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON MONI TOR STARTUP OF BACKUP JOBS
DESCRI PTI ON
Table 90 CMEM Rule Definition General Parameters
Parameter Description
OWNER ID of user requesting CMEM services.
GROUP Logical name of a group of rules.
MODE CMEM rule operation mode.
RUNTSEC Type of runtime security checks to be performed by the rule.
DESCRIPTION Free text description of the rule definition that appears in the
Rule List screen.
CMEM Rule Definition Facility
254 CONTROL-M for OS/390 and z/OS User Guide
Action Parameters
Action parameters specify actions to be performed by CMEM.
The following DO statements are available in CMEM only if CONTROL-O is
installed. For more information on the subparameters of the DO parameter which
appear in these illustrations, see the CONTROL-O User Guide.
Table 91 CMEM Rule Definition Action Parameters
DO statementM Actions to be performed when the rule is triggered. They are
performed sequentially. Valid DO statements are illustrated
below:
DO COND = FI LE- RECEI VED ODAT +

DO COND Add or delete a prerequisite condition.
DO FORCEJOB = TABLE BACKUP JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
DO
DO FORCEJOB Force one or more jobs under CONTROL-M.
DO STOPJOB
DO
DO STOPJOB Stop execution of the remaining steps of the job that triggered
the rule.
DO SHOUT = TO TSO- DBA URGENCY U SYSTEM
MESSAGE DB2 MASTER ENDED - PLEASE CHECK!
DO
DO SHOUT Issue a message to a console, TSO user, ROSCOE user, IOA
Log or the system administrator using the CONTROL-O Shout
facility.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 255
Commands of the Rule Definition Screen
The following commands may be typed in the COMMAND field of the Rule
Definition screen.
Commands used to exit the Rule Definition screen are described in Exiting the Rule
Definition Screen on page 258.
DO RULE = PROCFI LE %%$DSN OWNER PROD
TABLE PRODRULE LI BRARY CTO. PROD. RULES
SYSTEM SHARELOC NO TI MEOUT NO
DO
DO RULE Invoke a CONTROL-O rule from within the current rule.
Table 92 Commands of the Rule Definition Screen
Command Description
CAPS By default, all entries of lowercase characters are converted
and saved as uppercase. In CMEM rules, certain fields, such as
the string entered in the ON SHOUT MS field, can be enabled
to accept and save lowercase characters, by using the CAPS
OFF command, as described below. Valid formats are:
s CAPS OFF Enables certain user entries to be saved and
displayed in lowercase characters.
s CAPS ON Forces all user entries to be displayed in
uppercase characters, regardless of the case in which they
were entered. Default.
s CAPS Indicates whether CAPS ON or CAPS OFF mode is
active.
Note: JCL jobs used by CONTROL-M do not support
lowercase characters. Using lowercase characters to define
IOA variables is not recommended if those variables are
shared by CONTROL-M through IOAVAR.
EDIT Alternately enters and exits the Edit environment of the Rule
Definition screen. The Edit environment provides ISPF-like
line editing commands to the Rule Definition screen. For more
information, see Appendix D, Editing CMEM Rule
Definitions in the Edit Environment.
SHPF Shows the current PFKey assignments.
CMEM Rule Definition Facility
256 CONTROL-M for OS/390 and z/OS User Guide
Entering Comments
Comments are free text descriptions of rule definition parameters that are stored in a
rule definition. It is recommended that comments be inserted within rule definitions
for clarification and documentation purposes. Comment lines begin with the symbols
/ * , and are not processed during rule execution.
Use one of the following methods to insert comment lines:
s Decide where you want the comment to be inserted. Position the cursor on the
preceding line, and press CMNT (PF04/PF16) to open the comment line. If you need
more than one line, press Enter at the end of each line.
s Type CMNT in the COMMAND field and move the cursor to the line before which
the comment is to be inserted. Press Enter.
s To insert comments between DO statements an additional method is available.
Type /* in an empty DO statement and press Enter.
Comment usage is illustrated in the following Rule Definition screen:
Figure 68 Rule Definition Screen Comment Usage
An unlimited number of comment lines may be entered within a rule definition.
RL: BKP* LI B CMEM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = BKP* JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON MONI TOR STARTUP OF BACKUP JOBS
DESCRI PTI ON
==========================================================================
/ * TELL CONTROL- M TO MONI TOR THI S JOB
/ *
DO FORCEJOB = TABLE BACKUP JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
/ * m
DO
===========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====






FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 21. 00. 36
CMEM Rule Definition Facility
Chapter 2 Online Facilities 257
Editing CMEM Rule Definitions in the Edit Environment
Rule Definition parameters can be edited (moved, copied, deleted, repeated) using
CMEM Line Editing commands, similar to standard ISPF line commands, from
within the CMEM Edit environment.
The Edit environment in a Rule Definition screen is accessed by typing EDIT in the
COMMAND field and pressing Enter.
Figure 69 Entering Edit Commands
A 2-character Line Editing command field, marked by underscores, is displayed for
each line on the Rule Definition screen.
Editing commands are typed directly onto these underscores.
The Line Editing commands you enter are processed when Enter is pressed.
Details and examples of the editing CMEM rule definitions in the Edit environment
are provided in Appendix D, Editing CMEM Rule Definitions in the Edit
Environment.
RL: BKP* LI B CMEM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ ON JOBARRI V = BKP* JTYPE SMFI D SYSTEM And/ Or / Not
__ OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
__ THRESHOLD
__ DESCRI PTI ON MONI TOR STARTUP OF ACKUP JOBS
__ DESCRI PTI ON
__ ==========================================================================
__ / * TELL CONTROL- M TO MONI TOR THI S JOB
__ / *
__ DO FORCEJOB = TABLE BACKUP JOB DATE ODAT
__ LI BRARY CTM. PROD. SCHEDULE
__ / *
__ DO
__ ==========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< ====






FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 21. 00. 36
CMEM Rule Definition Facility
258 CONTROL-M for OS/390 and z/OS User Guide
Exiting the CMEM Rule Definition Facility
When exiting the CMEM Rule Definition facility, screens are exited in the following
sequence:
s Rule Definition screen
s Rule List screen
s Table List screen
s Entry panel
The commands and options available when exiting screens depend on the screen
being exited and on whether changes have been made. If changes have been made,
the selected exit options and commands determine whether the changes are saved.
Exit options and commands are discussed below on a screen-by-screen basis.
Exiting the Rule Definition Screen
Use any of the following commands, or press the corresponding PFKey, to exit the
Rule Definition screen:
NOTE
If the Table List screen was bypassed when you entered the CMEM Rule Definition
facility (that is, if you entered a TABLE value in the entry panel), the Table List
screen is not displayed upon exiting the Rule List screen; instead, the entry panel is
displayed.
Table 93 Commands for Exiting the Rule Definition Screen
Command Description
CANCEL Cancel the changes made to the rule and return to the Rule List
screen.
END (PF03/PF15) Keep changes to the rule in memory and exit to the Rule List
screen.
NOTE
The END command retains changes to the rule in memory. To permanently save the
changes to disk, you must request that the changes be saved when you exit the Rule
List screen.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 259
Exiting the Rule List Screen
Use the END command (PF03/PF15) to exit the Rule List screen. If changes made to at
least one rule have been kept in memory (as described in the preceding section)
and/ or if any changes have been made to the Rule List screen, the Exit Option
window is displayed.
Figure 70 Rule List Screen Exit Option Window
Fill in the Exit Option window as follows:
The LIBRARY and TABLE fields indicate the library and table in which the rule
definitions are saved. The specified values can be modified (for example, to save the
rule definitions in a new or different table).
s To save all changes currently in memory and exit the Rule List screen, type Y (Yes)
after the word SAVE or CREATE:
Type Y after SAVE if a table with the same name already exists in the specified
library.
Type Y after CREATE if a table with the same name does not exist in the
specified library.
RULES OF LI BRARY: CTM. PROD. RULES TABLE: TESTJ
COMMAN ++ ===> CRSR
OPT R | PLEASE SELECT EXI T OPTI ON | - - - - - - - -
J | |
J | SAVE CREATE |
J | |
J | LI BRARY CTM. PROD. RULES |
J | TABLE BACKUP | FORCEJOB
M | |
C ++ ADDCOND
======= >>>>>>>>>>>>>>>>> NO MORE RULES I N THI S TABLE <<<<<<<<<<<<<<<<< =======












OPTI ONS: S SELECT D DELETE I I NSERT C COPY 13. 00. 12
CMEM Rule Definition Facility
260 CONTROL-M for OS/390 and z/OS User Guide
s To cancel changes currently in memory and exit the Rule List screen, type N (No)
after the word SAVE or CREATE.
s To close the Exit Option window and remain in the Rule List screen (with the
changes remaining in memory), press the RESET key (PF04/PF16).
Exiting the Table List Screen
Press the END key (PF03/PF15) to exit the Table List screen.
Exiting the Entry Panel
Press the END key (PF03/PF15) to exit the entry panel.
Deleting Tables
Tables can be deleted from the Table List screen.
To delete tables, type option D (Delete) by the table names in the Table List screen
and press Enter.
The confirmation window illustrated below is displayed, in sequence, for each table
selected for deletion.
NOTE
If you create a new table, the table name does not appear in the Table List screen
upon exiting the Rule List screen; it first appears when you reenter the Table List
screen from the entry panel.
CMEM Rule Definition Facility
Chapter 2 Online Facilities 261
Figure 71 Rule Definition Facility Delete Table Confirmation Window
Type Y (Yes) in the window to confirm the delete request.
Type N (No) in the window to cancel the delete request.
A message is written to the IOA Log file for each table deleted.
Ordering CMEM Rule Tables
A rule definition that resides in a library is not active until it has been ordered. Rule
tables can be ordered automatically when CMEM is started, as described in the
INCONTROL for OS/390 and z/OS Administrator Guide, or they can be ordered
manually. Regardless of the method used to order them, CMEM rule tables only need
to be ordered once. Once a rule table is ordered, it remains active unless replaced or
deleted by an operator command, or until CMEM is stopped.
When rule definitions are updated or modified, the rule table must be ordered again.
The newly ordered version of the rule table automatically replaces the previous
version of the rule table. Rule tables can be deleted from the Active environment by
an operator command. For details, see Chapter 6, Selected Implementation Issues.
TABLES OF LI BRARY CTMP. V600TST. RULES - - - - - - - - - - - - - ( C)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - - - - VV. MM CREATED CHANGED SI ZE I NI T MOD I D
PRDJACCT 01. 06 01/ 02/ 14 01/ 06/ 06 14: 29 56 56 0 M06
PRDJPYRL 01. 03 01/ 02/ 14 01/ 06/ 06 10: 11 56 56 0 M86B
PRDJFNC +- - - - - - - - - - - - - - - - - - - - - - - - - - + 6 6 0 N04A
PRDJMRKT | CONFI RM DELETE OPTI ON | 5 5 0 N04B
D BACKUP <- - - - - - - - - - - | ( Y/ N) | 61 56 0 M06
TESTJ +- - - - - - - - - - - - - - - - - - - - - - - - - - + 6 56 0 M06
======= >>>>>>>>>>>>>>>> NO MORE TABLES I N THI S LI BRARY <<<<<<<<<<<<<<< =======













OPTI ONS: S SELECT O ORDER F FORCE B BROWSE D DELETE 13. 05. 52
NOTE
If PDSMAN is operational at your site, $$$SPACE members are not deleted.
CMEM Rule Definition Facility
262 CONTROL-M for OS/390 and z/OS User Guide
To order a rule table, type O (Order) or F (Force) in the OPT field to the left of the
table name in the Table List screen. Because there are no basic scheduling criteria in
CMEM rules, the Order and Force options work the same way. More than one rule
table can be ordered at the same time.
When you order rule tables, the following default confirmation window is opened. If
the default has been modified in the user profile, a double confirmation window is
opened. For more information on the double confirmation window, see The Double
Confirmation Window on page 155.
Figure 72 Order and Force Confirmation Window
TABLES OF LI BRARY CTM. PROD. RULES - - - - - - - - - - - - - ( C)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - - - - VV. MM CREATED CHANGED SI ZE I NI T MOD I D
PRDJACCT 01. 06 01/ 02/ 14 01/ 06/ 06 14: 29 56 56 0 M06
PRDJPYRL +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + 56 0 M86B
PRDJFNC | CONFI RM ODATE 060601 | 6 0 N04A
O PRDJMRKT <- - - - - - - - - - - | ASK FOR EACH ONE Y | 5 0 N04B
O BACKUP +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + 56 0 M06
TESTJ 01. 06 01/ 06/ 06 01/ 06/ 06 11: 16 6 56 0 M06
======= >>>>>>>>>>>>>>>> NO MORE TABLES I N THI S LI BRARY <<<<<<<<<<<<<<< =======













OPTI ONS: S SELECT O ORDER F FORCE B BROWSE D DELETE 12. 11. 50
Table 94 Options for Ordering Rule Tables (Part 1 of 2)
Option Description
CONFIRM Whether to process the order request. Valid values are:
s Y (Yes) Process the request
s N (No) Cancel the request
ODATE Current date (in mmddyy, ddmmyy or yymmdd format,
depending on the site standard).
CMEM Rule Definition Facility
Chapter 2 Online Facilities 263
When you press Enter, the results of the order request are displayed in a message at
the top of the screen. If more than one message is required, the original list screen
disappears and the messages appear in a new screen. If the messages span more than
one screen, you may scroll up and down on the messages list. Press the END key
(PF03/PF15) to return to the Table List screen.
Wish WO0945
As a result of the Order or Force request an MVS MODIFY command is sent to the
CMEM monitor. Some installations may protect the MVS command. If the user is not
authorized to issue an MVS MODIFY command the Order or Force fails.
After applying this wish, by specifying WO0943 APPLY=YES in the IOADFLTL
member, the MODIFY command will be executed under the CMEM monitor.
Therefore, authority to issue a MVS MODIFY command is required only for the
CMEM or CMEM monitor USERID.
Wish WO0945 also introduces
s the following AutoEdit system variables that return Wish WO0943 with a status of
Y or N
%%$WO0943
%%$MODIFY_O_F
s the following CMEM MODIFY command
F controlo,WISH=WO0943=xxxxx
where xxxxxx - ENABLE or DISABLE
ASK FOR EACH
ONE
This line is displayed only if more than one table order is
requested. It determines whether individual confirmation is
required for each order request. Valid values are:
s Y (Yes) Individual confirmation is required for each
order request. The selected CONFIRM value (Y or N)
applies only to the current order or request.
s N (No) Individual confirmation is not required for each
order request. The selected CONFIRM operation is
applied to all order requests. If CONFIRM is Y, all order
requests are processed; if CONFIRM is N, no order
requests are processed.
Table 94 Options for Ordering Rule Tables (Part 2 of 2)
Option Description
CMEM Rule Definition Facility
264 CONTROL-M for OS/390 and z/OS User Guide
This command allows the user to enable or disable optional Wish WO0943 without
stopping CONTROL-O.
Copying Rules to Another Table
To copy one or more rules from the current table to another table, type C (Copy) in
the OPT column of the Rule List screen, next to the rule names, and press Enter. The
following window is displayed:
Figure 73 Window for Copying Rules to Another Table
The window contains the fields shown in the following table. Some fields contain
default values that can be modified.
NOTE
This is a temporary change to the Wish only. In order to make the change
permanent, Wish WO0943 must set to the required value, YES or NO, in member
IOADFLTL.
RULES OF LI BRARY: CTM. PROD. RULES TABLE: TESTJ
COMMAND ===> SCROLL===> CRSR
OPT RULE TYP - - - - - - - - - - - - - - DESCRI PTI ON - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
JOBNAM1 R ON JOB JOBNAM1 ARRI VAL FORCEJOB
JOBN* 2 R ON JOB JOBN* 2 ARRI VAL ADDCOND
JOBNAM3 X ON JOB JOBNAM3 JOBEND FORCEJOB
C JOBN* 4 X ON JOB JOBN* 4 JOBEND DELCOND
JOBDST* +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MERGE | |
CI CSP | SPECI FY DESTI NATI ON LI BRARY AND TABLE |
PROD* | |
======= >>>>>>> | LI BRARY : CTM. PROD. RULES |
| TABLE : |
| RULE : JOBN* 4 |
| |
| PRESS END/ RESET TO CANCEL ENTER TO PERFORM THE COPY |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +






OPTI ONS: S SELECT D DELETE I I NSERT C COPY 12. 22. 27
IOA Variables Database Facility
Chapter 2 Online Facilities 265
To perform a request, press Enter.
To cancel a request, press END (PF03/PF15) or RESET (PF04/PF16).
IOA Variables Database Facility
The IOA Variable Database facility is composed of a series of screens that enable you
to view, create, and modify Global AutoEdit variables in IOAVAR, the IOA Global
Variable database.
As of version 6.0.00, this facility is available to CONTROL-M and/ or CONTROL-O
users only, and is available only if CMEM and/ or CONTROL-O are installed.
CONTROL-O users can also create and modify other variable databases.
Table 95 Fields in the Window for Copying Rules to Another Table
Field Description
LIBRARY Library containing the table into which the rules must be
copied. Must be an existing library. Default is the current
library.
TABLE Name of the table into which the rule must be copied.
Notes: A rule can only be copied to another table. It cannot be
copied to its own table (even if the rule is renamed).
If the selected table does not exist, the table is created when the
request is performed.
RULE Name of the rule to be copied. If multiple rules are selected,
the window initially display with the first selected rule. As
each request is performed or canceled, the next requested rule
name is displayed.
NOTE
If CONTROL-O is installed, the CMEM facility is controlled by the CONTROL-O
monitor instead of the CMEM monitor. In this case, references to the CMEM monitor
apply instead to the CONTROL-O monitor, and operator commands must contain
CONTROLO in place of CTMCMEM.
Certain screens and features of the IOA Variable Database Facility are relevant to
CONTROL-O but not to CONTROL-M. If CONTROL-O is installed, and you are
using the IOA Variable Database Facility with CONTROL-O, refer to the description
of the IOA Variable Database facility in the CONTROL-O User Guide.
IOA Variables Database Facility
266 CONTROL-M for OS/390 and z/OS User Guide
Global variables may be defined in variable database IOAVAR. They can be accessed
and updated by all CONTROL-M jobs and/ or CONTROL-O rules on that computer.
In addition, if Sysplex support is installed, these variables can be accessed and
updated by all CONTROL-M jobs and CONTROL-O rules across the Sysplex. IOA
Global variable database administration and Sysplex support are described in detail
in the INCONTROL for OS/390 and z/OS Administrator Guide.
The IOA Variable Database facility consists of several screens, some of which are
relevant only to the INCONTROL administrator, and some of which are relevant to
all users. The following screens are relevant to all users. Screens relevant only to
administrators are described in the INCONTROL for OS/390 and z/OS Administrator
Guide.
To enter the Variable Database facility, select option IV in the IOA Primary Option
menu. The IOA Variables Entry Panel is displayed.
NOTE
In addition to using the online IOA Variable Definition facility to define Global
variables, Global variables can be defined or updated through SET VAR and DO SET
statements in CONTROL-M job scheduling definitions, through SET statements in
the jobs JCL, and through SETOGLB statements in a KSL or KOA script.
Table 96 IOA Variable Database Facility Screens
Screen Description
Variable Database
entry panel
Enables specification of a database name. If no database name
is entered, the Database List screen is displayed.
Database List screen Displays the list of variable databases.
Values of Database
screen
Displays the list of variables, and their values, in the selected
database.
Variable Zoom
screen
Displays the complete variable name and the complete
variable value of the selected variable, and enables update of
the variable value.
IOA Variables Database Facility
Chapter 2 Online Facilities 267
Entry Panel
The following entry panel is displayed upon specification of option IV in the IOA
Primary Option menu:
Figure 74 IOA Variable Database Entry Panel
s To display the list of all variable databases: Press Enter. The Database List screen is
displayed.
s To display the list of variables in a specific variable database: Type the database
name in the DATABASE field and press Enter. The Values of Database screen for
the specified database is displayed. An asterisk (*) can be used as a mask character
in the DATABASE field of this screen.
s To enter the IOA Variables Database facility as a regular user: Leave the MODE
field blank. In this case, you will be able to view the variables in the databases, but
you will not be able to perform administration functions.
s To enter the IOA Variables Database facility with full administrator
functionality: Type ADMIN in the MODE field.
- - - - - - - - - - - - - - - - - - - - - - - I OA Var i abl es - ENTRY PANEL - - - - - - - - - - - - - - - - - - - - - - ( I V)
COMMAND ===>



SPECI FY DATABASE NAME

DATABASE ===> ( Bl ank f or Dat abase sel ect i on l i st )






MODE ===> ( Bl ank or ADMI N f or Admi ni st r at i on mode)








USE THE COMMAND " SHPF" TO SEE PFK ASSI GNMENT 16. 21. 43
NOTE
CONTROL-O can have multiple variable databases; CONTROL-M can only use the
IOAVAR database.
IOA Variables Database Facility
268 CONTROL-M for OS/390 and z/OS User Guide
Database List Screen
The Database List screen (also called the IOA Variables In Use screen) displays a list
of the variable databases currently defined. This screen can be entered directly from
the entry panel or when returning from the Variable List screen.
Figure 75 IOA Variable Database Facility Database List Screen
A short description is displayed for each database. You should create a description
when creating a new database.
NOTE
The additional functions available in administration mode are described in the
INCONTROL for OS/390 and z/OS Administrator Guide.
NOTE
For a CONTROL-O variable database to be loaded into memory, the database must
be listed in the DAGLBLST DD statement of the CMEM monitor. For more
information, see the description of the IOA Variable Database facility in the
INCONTROL for OS/390 and z/OS Administrator Guide.
LI ST OF DATABASES - - - - - I OA VARI ABLES I N USE - - - - - - - - - - - - - - - - - - - - - - - - - - - ( I V)
COMMAND ===> SCROLL===> CRSR
OPT NAME DESCRI PTI ON
COSALLMT COSMOS - DEMO - METHODS DATABASE
COSALLPR COSMOS - DEMO - PREREQUI SI TES DATABASE
COSI MGOB COSMOS - DEMO - SYSI MAGE WORKI NG DATABASE
I OAVAR I OA GLOBAL VARI ABLE DATABASE
PRDALLMT COSMOS - PROD - METHODS DATABASE
PRDALLPR COSMOS - PROD - PREREQUI SI TES DATABASE
PRDSTCOB COSMOS - PROD - STC WORKI NG DATABASE
PRDSTCSD COSMOS - PROD - STC SOURCE DATABASE
PRDVTMOB COSMOS - PROD - VTAM WORKI NG DATABASE
PRDVTMSD COSMOS - PROD - VTAM SOURCE DATABASE
TUTORI AL AUTOEDI T DATABASES - TUTORI AL
XAES1D01 XESXAE - DEMO - S1 - TEMP
XAES1D02 XESXAE - DEMO - S1 - I NPUT
XAES1D03 XESXAE - DEMO - S1 - PROT ( S1PROT SAME AS I NPUT)
XAES1D04 XESXAE - DEMO - S1 - I NOUT ( S1I NOUT SAME AS I NPUT)
XAES2D01 XESXAE - DEMO - S2 - TEMP
XAES2D02 XESXAE - DEMO - S2 - I NPUT
XAES2D03 XESXAE - DEMO - S2 - PROT ( S2PROT SAME AS I NPUT)
XAES2D04 XESXAE - DEMO - S2 - I NOUT
===== >>>>>>>>>>>>>>>>>>>>>>> NO MORE DATABASES <<<<<<<<<<<<<<<<<<<<<< =====
OPTI ONS: V VI EWVARS 08. 15. 55u
IOA Variables Database Facility
Chapter 2 Online Facilities 269
Options of the Database List Screen
To request an option, type the option in the OPT field to the left of the database name,
and press Enter. The V (VIEW VARS) option is available for all users. This option
displays the variables of the database in the Values of Database screen.
Values of Database Screen
The Values of Database screen can be entered directly from the entry panel or from
the Database List screen.
Each line in the screen represents a variable in the database. Variables and their
values are loaded into memory automatically at CONTROL-M startup.
Figure 76 IOA Values of Database Screen
The Values of Database screen displays the following information about the variables
in the IOAVAR database:
NOTE
Only option V is intended for all users. The remaining options
(I - Insert, U - Update, and S - Select) are intended for INCONTROL administrators
only, and are described in the INCONTROL for OS/390 and z/OS Administrator Guide.
VALUES OF DATABASE: I OAVAR ( I V. V)
COMMAND ===> SCROLL===> CRSR
ROW VARNAME VALUE

00022889 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_1 045673
00023866 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_2 1045683
00024902 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_3 045677
00025863 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_4 043433
00026943 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_5 045543
00027792 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_6 045556
00028972 %%\ M\ ACCTS\ BCKP\ PDTAPE_0001_7 045666
00029831 %%\ M\ ACCTS\ EMPLY\ EMP_00123_SCHOOL STATE UNI VERSI TY OF NEWYORK A
00030765 %%\ M\ OPER\ KPL\ SPACE_TYPE_5 TRK
00031985 %%\ M\ SYS\ DBLG\ NAME_OF_COMPUTER_1 A
00032972 %%\ M\ SYS\ DBLG\ NAME_OF_COMPUTER_2 D
00033769 %%\ M\ SYS\ DBLG\ NAME_OF_COMPUTER_3 K
00034919 %%\ M\ SYS\ DBLG\ NAME_OF_COMPUTER_4 W
00035955 %%\ M\ OPER\ GRPBKP\ GENERATI ON_NUMBER_A 001
00036932 %%\ M\ OPER\ GRPBKP\ GENERATI ON_NUMBER_B 001
00037778 %%\ M\ OPER\ GRPBKP\ GENERATI ON_NUMBER_C 003
00038808 %%\ M\ OPER\ GRPBKP\ GENERATI ON_NUMBER_D 002
======== >>>>>>>>>>>>>>> NO MORE ROWS FOR THI S DATABASE <<<<<<<<<<<<<< ========

OPTI ONS: Z ZOOM I I NSERT D DELETE R REPEAT 09. 19. 41
IOA Variables Database Facility
270 CONTROL-M for OS/390 and z/OS User Guide
Use the scrolling PFKeys to scroll the variable database LEFT (PF10/PF22) and RIGHT
(PF11/PF23).
Options of the Values of Database Screen
To request one of the following options, type the option in the first column of the row
number to the left of the variable name and press Enter.
Table 97 Fields of the IOA Values of Database Screen
Field Description
ROW Each variable is assigned its own row in the database. This
column displays the row number of the variable.
VARNAME The variable path and name, with the following format:
%%\ M\ app_name\ group_name\ job_name\ var_name
where:
s %% Indicates that the string is a variable. Constant.
s M Indicates that the string is a CONTROL-M variable.
Constant. Mandatory.
s app_name The CONTROL-M application where var_name
resides. Optional.
s group_name The CONTROL-M group within app_name
where var_name resides. Optional.
s job_name The CONTROL-M job within group_name where
var_name resides. Optional.
s var_name The variable name. Mandatory.
Up to 30 characters of the VARNAME string are displayed. If
the VARNAME string is longer, the full variable path and
name can be viewed in the Variable Zoom screen, which is
described in Variable Zoom Screen on page 272.
Note: All levels in the path within the VARNAME string are
separated by a \ (backslash).
VALUE Value of the variable. Up to thirty characters of the value are
displayed. If the value is longer, the full value can be viewed
in the Variable Zoom screen, which is described in Variable
Zoom Screen on page 272.
IOA Variables Database Facility
Chapter 2 Online Facilities 271
Adding a Row (Variable)
A row (variable) can be added to the database using either option I or option R:
s Option I (Insert)
This option is useful for defining a variable that is not similar to the one it follows.
When option I is typed next to a variable, a row is immediately inserted below the
selected row, and a row value is assigned, as explained in Row Numbering on
page 272. However, the VARNAME and VALUE fields are blank.
s Option R (Repeat)
This option is useful for defining a variable that is similar to the one it follows.
When option R is typed next to a variable, a row is immediately inserted below the
selected row, and a row value is assigned, as explained in Row Numbering on
page 272. The new row contains the same VARNAME and VALUE as the selected
row.
Using either method, the new row must be edited:
s If Option I was entered, a VARNAME and VALUE must be added to the new row.
s If Option R was entered, the repeated VARNAME must be changed because each
variable in the database must be unique. The VALUE may also be changed if
desired.
The VARNAME and VALUE in the new row can only be edited in the Variable Zoom
screen, described below.
Table 98 Options of the Values of Database Screen
Option Description
Z (ZOOM) Display the full variable and value of the selected row
(variable) in the Variable Zoom screen. The displayed
variables may be edited in this screen, as well. For more
information, see Variable Zoom Screen on page 272.
I (INSERT) Insert a new row in the variable database. For more
information, see Adding a Row (Variable) on page 271.
D (DELETE) Delete the selected row (variable).
R (REPEAT) Insert a new row that is identical to the one for which this
option is selected. For more information, see Adding a Row
(Variable) on page 271
IOA Variables Database Facility
272 CONTROL-M for OS/390 and z/OS User Guide
Row Numbering
Row numbers in a variable database are initially incremented by 1000.
s When a new row is inserted (by option I or R), it is assigned an intermediate
number incremented by 100.
s Rows inserted between row numbers with a hundreds value are assigned numbers
incremented by ten.
s Rows inserted between row numbers with a tens value are assigned numbers
incremented by one.
For example, a row inserted immediately after row 2000 is assigned a number of 2100.
A maximum of 999 rows may be inserted between two original rows in a variable
database.
Row numbers can be refreshed (that is, assigned new numbers incremented by 1000)
in the following way:
1. Unload the IOA Variable Database Variables file using job IOAVARUL in the IOA
JCL library. This job invokes the IOADUL utility.
2. Reload the file using job IOAVARLD in the IOA JCL library. This job runs the
IOADLD utility with the RENUM parameter specified.
For more information about the IOADUL and IOADLD utilities, see the INCONTROL
for OS/390 and z/OS Utilities Guide.
Variable Zoom Screen
The Variable Zoom screen is used to display the full variable name and path, and the
full variable value. The screen is also used to update the variable name and path, and
its assigned value.
The full name and path of each variable, and the value of each variable, can be up to
140 characters in length. However, only thirty characters each of the variable and its
value can be displayed in the Values of Database screen.
The Variable Zoom screen enables display of the full variable name and path, and its
value. To display the Variable Zoom screen for a row (variable), type option Z
(Zoom) in the first column of the desired row in the Values of Database screen.
IOA Variables Database Facility
Chapter 2 Online Facilities 273
The Variable Zoom screen is displayed.
Figure 77 Variable Zoom Screen
Display Types of the Variable Zoom Screen
The following predefined display types are available for the Variable Zoom screen.
Changing Display Types
While in the Variable Zoom screen, the display type can be changed using the
DISPLAY command. Format of the command is:
VALUES OF DATABASE: I OAVAR ROW: 00029831 < D > ( I V. V. Z)
COMMAND ===> SCROLL===> CRSR
O NAME VALUE
VARNAME %%\ M\ ACCTS\ EMPLY\ EMP_00123_SCHOOL
VALUE STATE UNI VERSI TY OF NEWYORK AT STONY BROOK
======== >>>>>>>>>>>>>>>> NO MORE COLUMNS I N THI S ROW<<<<<<<<<<<<<<<< ========

















OPTI ONS: A ADDI TI ONAL I NFORMATI ON 14. 31. 38
Table 99 Display Types of the Variable Zoom Screen
Type Description
D (Default display
type)
Includes the first 64 characters of both the variable name and
path, and the variable value for the selected database row.
An additional line containing the remainder of the variable
name and path (up to 76 characters), and an additional line
containing the remainder of the variable value (up to 76
characters) can be displayed by option A (Additional
Information), which is described in Table 99.
B (Blank Line
display type)
This display type displays the second line for all variables and
values, regardless of whether the line contains additional
information.
IOA Variables Database Facility
274 CONTROL-M for OS/390 and z/OS User Guide
where x is the identifying letter for the desired type.
DISPLAY can be abbreviated to DI.
Example
displays the Blank Line display type
Options of the Variable Zoom Screen
The following option is available in the Default display type of the Variable Zoom
screen:
Exiting the Variable Zoom Screen
s To exit the Variable Zoom screen and save the changes, press END (PF03/PF15).
s To exit the Variable Zoom screen without implementing the changes, press RESET
(PF04/PF16), or type CANCEL in the COMMAND line and press Enter.
Changes made to the Variable database through the online Variable Database facility
are not available to CONTROL-M or CONTROL-O until the modified database is
reloaded into memory by the appropriate operator command
(F CTMCMEM,LOADGLOBAL=IOAVAR), as described in the INCONTROL for
OS/390 and z/OS Administrator Guide.
However, changes made to the Variable database through DO SET and SET VAR
statements in CONTROL-M, and SET statements in the JCL, are kept in memory. The
Variable database file is automatically updated during the next internal
CONTROL-M interval cycle (or when the CONTROL-O or CMEM monitor is
stopped.)
DI SPLAY x
DI B
Table 100 Options of the Variable Zoom Screen
Option Description
A (Additional
Information)
Display a second line for the selected variable. This option can
be entered for the VARNAME and/ or the VALUE lines. If
used, it displays the second line containing the remainder (up
to 76 characters) of the value.
Condition and Resource Handling Facility
Chapter 2 Online Facilities 275
Condition and Resource Handling Facility
Options 4 and 7 in the IOA Primary Option menu are directly related to the handling
of IOA conditions and CONTROL-M resources. The screens displayed by these
options are discussed on the following pages.
IOA Conditions/Resources Screen
The IOA Conditions/ Resources screen is accessed through Option 4 of the IOA
Primary Option menu. It displays information from the IOA Conditions file, which
contains the list of all existing prerequisite conditions, and the CONTROL-M
Resources file, which contains the list of Quantitative resources and Control
resources. The IOA Conditions/ Resources screen enables you to
s view IOA prerequisite conditions
s view CONTROL-M Quantitative resources
s add or delete prerequisite conditions or resources or both
s change the available quantity of CONTROL-M Quantitative resources
For a description of prerequisite conditions, see Prerequisite Conditions on page 69
To enter the IOA Conditions/ Resources screen, select option 4 on the IOA Primary
Option menu.
NOTE
Prior to version 6.0.00 a single file, the IOA Conditions/ Resources File, contained all
IOA conditions and all Control and Quantitative resources. As of version 6.0.00, the
IOA Conditions/ Resources File has been replaced by two files:
s IOA Conditions file - contains all IOA conditions
s CONTROL-M Resources file - contains all Control and Quantitative resources
Condition and Resource Handling Facility
276 CONTROL-M for OS/390 and z/OS User Guide
Figure 78 IOA Conditions/Resources Screen
To return to the IOA Primary Option menu, press the END key (PF03/PF15).
Fields of the IOA Conditions/Resources Screen
The information displayed in each screen line is shown in Table 101:
- - - - - - - - - - - - - - - - - - - - - - - - - - I OA CONDI TI ONS/ RESOURCES - - - - - - - - - - - - - - - - - - - - - - - - ( 4)
COMMAND ===> SCROLL ===> CRSR
PREFI X ===> COND Y CONTROL Y RES Y STAT Y DATE 0606 - 0606
OPT TYPE CONDI TI ON/ RESOURCE I OAI D USE QUANTI TY MAX * P RBA DATE
CONTROL CONTROLM 01 E ( 00000)
RESOURCE TAPEP B 0003 0003
RESOURCE CPU1 B 0098 0100
RESOURCE CPU2 B 0197 0200
RESOURCE TAPEP 01 U 0002 ( 00091)
RESOURCE CPU1 01 U 0002 ( 00091)
RESOURCE CPU2 01 U 0003 ( 00092)
RESOURCE TAPEP 01 R 0002 1 ( 00093)
COND BR- BRI VPCC- ENDED- OK 0909
COND BR- BRCC0001- ENDED- OK 0909
COND BR- BRCC0002- ENDED- OK 0909
COND BR- BRCC0003- ENDED- OK 0909
COND BR- BRCCI ND- ENDED- OK 0909
COND BR- BRUPDT02- ENDED- OK 0909
COND BR- BRREP001- ENDED- OK 0909
COND BR- BRREP002- ENDED- OK 0909
COND GL- GLI NP001- ENDED- OK 0909
COND EBD- APPL- STARTED 0909
COND CI CS- PROD- I S- UP STAT
OPTI ONS: D DELETE C CHANGE COMMANDS: ADD 14. 07. 08
Table 101 Fields of the IOA Conditions/Resources Screen (Part 1 of 2)
Field Description
OPT Option to be activated on the condition or resource.
TYPE Type of condition or resource:
s COND Prerequisite condition
s CONTROL Control resource
s RESOURCE Quantitative resource
CONDITION/
RESOURCE
Name of the condition or resource.
IOAID ID of the IOA installation that is using the particular Control
or Quantitative resource. This value is significant when
multiple IOA installations share the same resources.
Condition and Resource Handling Facility
Chapter 2 Online Facilities 277
USE Resource usage indicator for Control or Quantitative
resources. Valid values depend on the type of resource.
For Control resources, valid values are:
s E Resource is being used in Exclusive mode
s S Resource is being used in Shared mode
For Quantitative resources, valid values are:
s B Line indicates the initial definition for the resource
s U Line indicates an instance of resource usage
s R Line indicates an unfulfilled critical path request (that
is, a request with an *-type priority) for the resource
QUANTITY Quantity of a Quantitative resource. What the quantity
represents depends on the value in the USE field, as follows:
Use Quantity
B Quantity available. If the maximum quantity
is more than 1 but only 1 is available, 0001 is
displayed in pink for color terminals. If the
maximum quantity is more than 1 but none
is available, 0000 is displayed in red for color
terminals.
U Quantity in use by the particular process.
R Quantity requested by the particular
process, but unfulfilled.
MAX Maximum available quantity of a Quantitative resource.
*P Priority of the job requesting a CONTROL-M resource using
*-type priority. For more information, see PRIORITY:
Runtime Scheduling Parameter on page 580.`
RBA Internal CONTROL-M ID (relative byte address) of the job
currently holding a CONTROL-M resource. An RBA value of
000000 indicates that the resource was added manually.
Note: Line indicates an unfulfilled critical path request (that is,
a request with an *-type priority) for the resource.
DATE Original date reference of a prerequisite condition (format
mmdd or ddmm depending on the site standard, or the value
STAT).
Table 101 Fields of the IOA Conditions/Resources Screen (Part 2 of 2)
Field Description
Condition and Resource Handling Facility
278 CONTROL-M for OS/390 and z/OS User Guide
Specifying Retrieval Criteria
You can control the type and amount of information displayed in the screen by
specifying retrieval criteria.
Table 102 IOA Conditions/Resources Retrieval Criteria (Part 1 of 2)
Field Description
PREFIX prefix If specified, limits the display to conditions with the specified
prefix.
To display only conditions containing a specific string, enter
the string preceded by an *.
Example:
If *OK is entered, the following conditions are included in the
display:
UPDATE- ENDED- OK
OK- RUN
OK
COND Determines whether prerequisite conditions are displayed.
Valid values are:
s Y (Yes) Display prerequisite conditions. Default.
s N (No) Do not display prerequisite conditions.
CONTROL Determines whether Control resources are displayed. Valid
values are:
s Y (Yes) Display Control resources. Default.
s N (No) Do not display Control resources.
RES Determines whether Quantitative resources are displayed.
Valid values are:
s Y (Yes) Display Quantitative resources. Default.
s N (No) Do not display Quantitative resources.
Condition and Resource Handling Facility
Chapter 2 Online Facilities 279
Adding Conditions and Resources The ADD Command
From the Command field, use the ADD command to add conditions to the IOA
Conditions file or resources to the CONTROL-M Resources file.
The format of the command is:
where type is one of the following:
s COND Add a prerequisite condition. Special care must be taken when adding
prerequisite conditions, because added conditions can trigger job submission.
s LCOND Add a long prerequisite condition (a condition name that exceeds 20
characters).
s RESOURCE Add a Quantitative resource. Only authorized personnel should add
Quantitative resources.
s CONTROL Add a Control resource. A Control resource entry may be added
manually even if a job is holding the resource. Only authorized personnel should
add Control resources.
STAT Determines whether prerequisite conditions with a date value
of STAT are displayed. (Applies only if Y is specified for
COND.) Valid values are:
s Y (Yes) Include prerequisite conditions with a date value
of STAT.
s N (No) Do not include prerequisite conditions with a
date value of STAT.
DATE from to Limits the display of prerequisite conditions to the selected
date range. Valid values are:
s from Earliest date in the date range, in mmdd or ddmm
format (depending on the site standard). The default value
is three days prior to the current date. This default can be
modified in the Profile member by the INCONTROL
administrator.
s to Latest date in the date range, in mmdd or ddmm
format (depending on the site standard). The default value
is the current date.
ADD t ype
Table 102 IOA Conditions/Resources Retrieval Criteria (Part 2 of 2)
Field Description
Condition and Resource Handling Facility
280 CONTROL-M for OS/390 and z/OS User Guide
When the ADD command is entered, an appropriate window is opened. The window
shown in Figure 79 opens when ADD COND is entered.
Figure 79 IOA Conditions/Resources COND Window
Fill in the window fields as described in Table 103 according to the specified ADD
command:
- - - - - - - - - - - - - - - - - - - - - - - - - - I OA CONDI TI ONS/ RESOURCES - - - - - - - - - - - - - - - - - - - - - - - - ( 4)
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + L ===> CRSR
PREFI X | PLEASE FI LL I N COND NAME, DATE AND PRESS ENTER | 0606 - 0606
OPT TY | | BA DATE
CO | NAME ===> DDMM ===> | 00)
RE | |
RE +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
RE
RESOURCE TAPEP 01 U 0002 ( 00091)
RESOURCE CPU1 01 U 0002 ( 00091)
RESOURCE CPU2 01 U 0003 ( 00092)
RESOURCE TAPEP 01 R 0002 1 ( 00093)
COND BR- BRI VPCC- ENDED- OK 0606
COND BR- BRCC0001- ENDED- OK 0606
COND BR- BRCC0002- ENDED- OK 0606
COND BR- BRCC0003- ENDED- OK 0606
COND BR- BRCCI ND- ENDED- OK 0606
COND BR- BRUPDT02- ENDED- OK 0606
COND BR- BRREP001- ENDED- OK 0606
COND BR- BRREP002- ENDED- OK 0606
COND GL- GLI NP001- ENDED- OK 0606
COND EBD- APPL- STARTED 0606
COND CI CS- PROD- I S- UP STAT
OPTI ONS: D DELETE C CHANGE COMMANDS: ADD 14. 07. 08
Table 103 IOA Conditions/Resources ADD Command Formats
Format Description
ADD COND Enter the name of the prerequisite condition. The current
working date is displayed as the default date. This date can be
modified.
ADD LCOND Same as ADD COND, but for use only when the length of the
condition name is from 21 through 39 characters.
ADD RESOURCE Enter the name of the Quantitative resource and the quantity
to be added.
ADD CONTROL Enter the name of the Control resource and the control type
(E Exclusive; S Shared).
Note: If a Control resource is manually added with a type of E
(Exclusive), no jobs in WAIT SCHEDULE status that require
this resource are submitted.
If a Control resource is manually added with a type of S
(Shared), no jobs in WAIT SCHEDULE status that require
exclusive access to this resource are submitted.
Condition and Resource Handling Facility
Chapter 2 Online Facilities 281
After filling in the window, press Enter to add the condition or resource.
To close the window without adding the condition or resource, press the RESET key
(PF04/PF16).
Options of the IOA Conditions/Resources Screen
The following options can be selected for conditions and resources by typing the
option in the OPT field to the left of the resource or condition name and pressing
Enter. Available options are shown in Table 104:
These options are discussed in detail on the following pages.
Deleting Conditions and Resources The DELETE Option
To delete conditions and/ or resources, type D (Delete) in the OPT field to the left of
the conditions and resources being deleted and press Enter.
A confirmation window may be displayed, depending on user profile customization:
s By default, conditions and resources are deleted without confirmation from the
user.
s The User profile can be customized to display a confirmation window with an
arrow pointing to a delete request (beginning with the first request).
Table 104 Options of the IOA Conditions/Resources Screen
Option Description
D (DELETE) Delete a condition or resource from the list. The event is
recorded in the IOA Log file.
C (CHANGE) Change the maximum available quantity of a Quantitative
resource. The event is recorded in the IOA Log file.
Condition and Resource Handling Facility
282 CONTROL-M for OS/390 and z/OS User Guide
Figure 80 IOA Conditions/Resources DELETE Confirmation Window
If a confirmation window is displayed, fill in the window as shown in Table 105 and
press Enter:
- - - - - - - - - - - - - - - - - - - - - - - - - - I OA CONDI TI ONS/ RESOURCES - - - - - - - - - - - - - - - - - - - - - - - - ( 4)
COMMAND ===> SCROLL ===> CRSR
PREFI X ===> COND Y CONTROL Y RES Y STAT Y DATE 0606 - 0606
OPT TYPE CONDI TI ON/ RESOURCE I OAI D USE QUANTI TY MAX * P RBA DATE
COND SALARY- PRSL01A- OK 0909
COND SALARY- PRSL002- OK +- - - - - - - - - - - - - - - - - - - - - - +
COND SALARY- PRSL003- OK | CONFI RM |
D COND CBT- TAPE- ARRI VED <- - - - - - - - - | ASK FOR EACH ONE Y |
D COND KPL- PRKPL03- OK +- - - - - - - - - - - - - - - - - - - - - - +
COND KPL- PRKPL04- OK 0606
======== >>>>>>>>>>>>>>>> B O T T O M O F L I S T <<<<<<<<<<<<<<<< ========












OPTI ONS: D DELETE C CHANGE COMMANDS: ADD 14. 07. 08
Table 105 IOA Conditions/Resources DELETE Confirmation Window Options
Option Description
CONFIRM Whether to process the delete request. Valid values are:
s Y (Yes) Process the request.
s N (No) Cancel the request.
ASK FOR EACH
ONE
This line is displayed only if more than one delete is requested.
It determines whether individual confirmation is required for
each delete request. Valid values are:
s Y (Yes) Individual confirmation is required for each
delete request. The specified CONFIRM value applies only
to the current order or request.
s N (No) Individual confirmation is not required for each
delete request. The specified CONFIRM value is applied to
all delete requests. (If CONFIRM is Y, all delete requests
are processed; if CONFIRM is N, no delete request is
processed.)
Condition and Resource Handling Facility
Chapter 2 Online Facilities 283
Changing the Quantity of a Resource The CHANGE Option
To request a change to the maximum available quantity of a resource, type
C (Change) in the OPT field to the left of the resource and press Enter. The window
shown in Figure 81 is opened.
Figure 81 IOA Conditions/Resources CHANGE Option Window
The NAME value in the window is protected and cannot be changed.
The COUNT parameter consists of two values: sign and quantity. Fill in the COUNT
parameter as shown in Table 106 and press Enter:
- - - - - - - - - - - - - - - - - - - - - - - - - - I OA CONDI TI ONS/ RESOURCES - - - - - - - - - - - - - - - - - - - - - - - - ( 4)
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + L ===> CRSR
PREFI X | PLEASE FI LL I N QUANT RES NAME, COUNT AND PRESS ENTER | 0606 - 0606
OPT TY | | BA DATE
CO | NAME ===> TAPEP COUNT ===> | 000)
C RE | |
RE +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
RE
RESOURCE TAPEP 01 U 0002 ( 00091)
RESOURCE CPU1 01 U 0002 ( 00091)
RESOURCE CPU2 01 U 0003 ( 00092)
RESOURCE TAPEP 01 R 0002 1 ( 00093)
COND BR- BRI VPCC- ENDED- OK 0606
COND BR- BRCC0001- ENDED- OK 0606
COND BR- BRCC0002- ENDED- OK 0606
COND BR- BRCC0003- ENDED- OK 0606
COND BR- BRCCI ND- ENDED- OK 0606
COND BR- BRUPDT02- ENDED- OK 0606
COND BR- BRREP001- ENDED- OK 0606
COND BR- BRREP002- ENDED- OK 0606
COND GL- GLI NP001- ENDED- OK 0606
COND EBD- APPL- STARTED 0606
COND CI CS- PROD- I S- UP STAT
OPTI ONS: D DELETE C CHANGE COMMANDS: ADD 14. 07. 08
Table 106 COUNT Parameter Values
Value Description
sign
Valid values (one character):
+ (Plus) Add the selected quantity to the current maximum available
quantity to give a new maximum available quantity.
- (Minus) Subtract the selected quantity from the current maximum
available quantity to give a new maximum available quantity.
' ' (Blank) Set the maximum available quantity to the selected quantity.
quantity Quantity to be used to adjust the maximum quantity of the resource (four
digits) according to the specified sign. Leading zeros are required.
Condition and Resource Handling Facility
284 CONTROL-M for OS/390 and z/OS User Guide
IOA Manual Conditions Screen
The IOA Manual Conditions screen displays a list of prerequisite conditions that
must be confirmed manually by operations personnel.
The list of manual conditions is created by utility IOALDNRS. The utility is described
in the INCONTROL for OS/390 and z/OS Utilities Guide. This utility is intended for use
at sites where CONTROL-M and/ or CONTROL-D are installed.
The utility scans the jobs in the CONTROL-M Active Jobs file, and/ or missions in the
CONTROL-D Active Missions file, for all conditions requested in IN statements that
s are not resolved by an OUT statement
s are not resolved by ON PGMST or DO COND statements
s do not exist in the IOA Conditions file
The utility automatically places the conditions conforming to the above criteria into
the IOA Manual Conditions file. This file is used as a checklist for manual operations
that operations personnel are expected to perform.
To enter the IOA Manual Conditions screen, select Option 7 on the IOA Primary
Option menu.
Figure 82 IOA Manual Conditions Screen
To exit the IOA Manual Conditions screen, press END (PF03/PF15).
- - - - - - - - - - - - - - - - - - - - - - - - - - - I OA MANUAL CONDI TI ONS - - - - - - - - - - - - - - - - - - - - - - - - - - ( 7)
COMMAND ===> SCROLL ===> CRSR
PREFI X ===> PENDI NG Y ADDED Y STAT Y DATE 0606 - 0606
OPT TYPE CONDI TI ON DATE ADDED
COND USR- GOT- TAX- TAPE 0606
COND DBA- RUN- UPDATE 0606 Y
COND OP- EXTERNAL- TAPE- OK 0606 Y
COND USR- GOT- BANK- TAPE 0606
COND OP- SHUT- THE- SYSTEM 0606
COND DBA- START- MPMXXX 0606
COND USR- GOT- SALARY- TAPE 0606 Y
COND OP- COMMUNI CATI ON- DOWN 0606
======== >>>>>>>>>>>>>>>> B O T T O M O F L I S T <<<<<<<<<<<<<<<< ========










OPTI ONS: A ADD TO COND/ RES LI ST ( SCREEN 4) E ERASE COMMANDS: NEW18. 33. 47
Condition and Resource Handling Facility
Chapter 2 Online Facilities 285
Fields of the IOA Manual Conditions Screen
The information displayed on each screen line is shown in Table 107:
Specifying Retrieval Criteria
You can control the type and amount of information displayed in the screen by
specifying retrieval criteria.
Table 107 Fields of the IOA Manual Conditions Screen
Field Description
OPT Option to be activated on the condition.
TYPE Type of condition, meaning, COND for prerequisite condition.
CONDITION Condition name.
DATE Date reference of prerequisite condition. Format is either
mmdd or ddmm depending on the site standard, or the date
value STAT.
ADDED Indicates whether the condition has been manually added to
the IOA Conditions file.
s N (No) Condition has not been added.
s Y (Yes) Condition has been added.
Table 108 Retrieval Criterion for IOA Manual Conditions Screen (Part 1 of 2)
Criterion Description
PREFIX prefix Limits the display to conditions with the selected prefix.
Default: Blank (no limit).
To display only those conditions containing a specific string,
enter the string preceded by an *.
Example:
If *OK is entered, the following conditions are included in the
display:
UPDATE- ENDED- OK
OK- RUN
OK
PENDING Determines whether conditions not yet added are displayed.
Valid values are:
s Y (Yes) Display pending conditions.
s N (No) Do not display pending conditions.
Condition and Resource Handling Facility
286 CONTROL-M for OS/390 and z/OS User Guide
Adding a New Prerequisite Condition NEW Command
To add a prerequisite condition to the IOA Manual Conditions file, type NEW COND
in the COMMAND field and press Enter. The window shown in Figure 83 is opened.
To add a condition with a name from 20 through 39 characters in length, type NEW
LCOND in the COMMAND field and press Enter. The window shown in Figure 83 is
opened.
ADDED Determines whether added conditions are displayed. Valid
values are:
s Y (Yes) Display added conditions.
s N (No) Do not display added conditions.
STAT Determines whether prerequisite conditions with a date value
of STAT are displayed. Valid values are:
s Y (Yes) Display prerequisite conditions with a date value
of STAT.
s N (No) Do not display prerequisite conditions with a
date value of STAT.
DATE from to Limits the display of prerequisite conditions to the selected
date range. Valid values are:
s from Earliest date in the date range, in mmdd or ddmm
format (depending on the site standard). The default value
is three days before the current date.
s to Latest date in the date range, in mmdd or ddmm
format (depending on the site standard). The default value
is the current date.
Table 108 Retrieval Criterion for IOA Manual Conditions Screen (Part 2 of 2)
Criterion Description
Condition and Resource Handling Facility
Chapter 2 Online Facilities 287
Figure 83 IOA Manual Conditions Screen NEW Window
In the NAME field of the window, type the name of the condition to be added. If the
condition has a date other than the current working date, enter the date in the date
field of the window, in the format DDMM or MMDD, depending on the site
standard.
s To add the condition, press Enter.
s To close the window without adding the condition, press RESET (PF04/PF16).
Options of the IOA Manual Conditions Screen
To add a condition to the IOA Conditions file, or to erase a condition from the IOA
Manual Conditions file, type the appropriate option in the OPT field to the left of the
condition name and press Enter. Valid options are shown in Table 109:
- - - - - - - - - - - - - - - - - - - - - - - - - - - I OA MANUAL CONDI TI ONS - - - - - - - - - - - - - - - - - - - - - - - - - - ( 7)
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + L ===> CRSR
PREFI X | PLEASE FI LL COND NAME AND DATE AND PRESS ENTER | 0606 - 0606
OPT TY | |
CO | NAME ===> MMDD ===> |
CO | |
CO +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
CO
COND OP- SHUT- THE- SYSTEM 0606
COND DBA- START- MPMXXX 0606
COND USR- GOT- SALARY- TAPE 0606 Y
COND OP- COMMUNI CATI ON- DOWN 0606
======== >>>>>>>>>>>>>>>> B O T T O M O F L I S T <<<<<<<<<<<<<<<< ========










OPTI ONS: A ADD TO COND/ RES LI ST ( SCREEN 4) E ERASE COMMANDS: NEW18. 33. 47
NOTE
Adding a new condition to the IOA Manual Conditions file does not affect the IOA
Conditions file.
Condition and Resource Handling Facility
288 CONTROL-M for OS/390 and z/OS User Guide
Erasing (Deleting) Conditions
To erase prerequisite conditions, type E in the OPT field to the left of the condition
names being erased and press Enter.
A confirmation window may be displayed, depending on user profile customization:
s By default, conditions are deleted without confirmation from the user.
s If, however, the user profile member has been customized accordingly, a
confirmation window is displayed with an arrow pointing to an erase request
(beginning with the first request).
Figure 84 IOA Manual Conditions Screen ERASE Confirmation Window
Table 109 Options of the IOA Manual Conditions Screen
Option Description
A (ADD) Add the condition to the IOA Conditions file (screen 4), and
mark it Added (Y) in the IOA Manual Conditions file. The
event is recorded in the IOA Log file.
E (ERASE) Erase (Delete) a condition from the IOA Manual Conditions
file. This does not affect the IOA Conditions file. This option is
discussed in more detail below.
- - - - - - - - - - - - - - - - - - - - - - - - - - - I OA MANUAL CONDI TI ONS - - - - - - - - - - - - - - - - - - - - - - - - - - ( 7)
COMMAND ===> SCROLL ===> CRSR
PREFI X ===> PENDI NG Y ADDED Y STAT Y DATE 0401 - 0701
OPT TYPE CONDI TI ON ++
E COND USR- GOT- TAX- TAPE <| CONFI RM ( Y/ N) |
COND DBA- RUN- UPDATE ++
COND OP- EXTERNAL- TAPE- OK 0606 Y
COND USR- GOT- BANK- TAPE 0606
COND OP- SHUT- THE- SYSTEM 0606
COND DBA- START- MPMXXX 0606
COND USR- GOT- SALARY- TAPE 0606 Y
COND OP- COMMUNI CATI ON- DOWN 0606
======== >>>>>>>>>>>>>>>> B O T T O M O F L I S T <<<<<<<<<<<<<<<< ========











OPTI ONS: A ADD TO COND/ RES LI ST ( SCREEN 4) E ERASE COMMANDS: NEW11. 30. 02
IOA Log Facility
Chapter 2 Online Facilities 289
If a confirmation window is displayed, fill in the window as follows and press Enter:
IOA Log Facility
The IOA Log facility places automatically generated messages, which record every
significant event in the life of a job, rule or mission, in the IOA Log file. Significant
events recorded in the IOA Log file include normal processing occurrences, such as
job submitted, as well as error conditions encountered during processing, such as job
abends. Shout facility notifications and user remarks may also be recorded in the IOA
Log file.
Table 110 Fields of the IOA Manual Conditions Screen ERASE Confirmation Window
Field Description
CONFIRM Indicates whether to process the erase (delete) request. Valid
values are:
s Y (Yes) Process the request.
s N (No) Cancel the request.
ASK FOR EACH
ONE
This line is displayed only if more than one erase is requested.
It determines whether individual confirmation is required for
each erase request. Valid values are:
s Y (Yes) Individual confirmation is required for each erase
request. The selected CONFIRM value applies only to the
current order or request.
s N (No) Individual confirmation is not required for each
erase request. The selected CONFIRM value is applied to
all erase requests. If CONFIRM is Y, all erase requests are
processed; if CONFIRM is N, no erase request are
processed.
IOA Log Facility
290 CONTROL-M for OS/390 and z/OS User Guide
IOA Log Screen
The IOA Log screen enables you to view the information contained in the Log file. To
enter the IOA Log screen, select option 5 on the IOA Primary Option menu. Upon
entry, the screen displays the most recent messages currently in the IOA Log file.
Figure 85 IOA Log Screen
To return to the IOA Primary Option menu, press END (PF03/PF15).
Fields of the IOA Log Screen
FI LTER: - - - - - - - - - - - - - - - - I OA LOG - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( 5)
COMMAND ===> SCROLL===> CRSR
SHOWLI MI T ON ==> DATE 060601 - 060601
DATE TI ME ODATE USERI D CODE - - - - - - - - M E S S A G E - - - - - - - - - - - - - - - - - -
060601 092144 060601 M22 SPY254I JOB CT085955 CT085955/ 01835 SCANNED
060601 092144 060601 M22 SEL208I JOB CT085955 CT085955/ 01835 ENDED " OK"
060601 092150 060601 M22 SPY254I JOB CT085956 CT085956/ 01836 SCANNED
060601 092150 060601 M22 SEL208I JOB CT085956 CT085956/ 01836 ENDED " OK"
060601 092156 060601 I VP SPY254I JOB BRI VPCC BRI VPCC / 01843 SCANNED
060601 092157 060601 I VP SEL208I JOB BRI VPCC BRI VPCC / 01843 ENDED " OK"
060601 092157 060601 DBA CTM659I FREE OF TASK BRCC0001 ODATE 060601
PERFORMED
060601 092201 060601 M22 SPY281I JOB I NTR0004 I NTR0004/ 04371 START
98253. 1316 STOP 98253. 1316 CPU 0MI N
00. 04SEC SRB 0MI N 00. 00SEC 0. 19
060601 092201 060601 M22 SPY254I JOB I NTR0004 I NTR0004/ 04371 SCANNED
060601 092201 060601 M22 SEL206WJOB I NTR0004 I NTR0004/ 04371 ABENDED CC
SB37 STEP STEP01
060601 092201 060601 M22 SEL219I JOB I NTR0004 I NTR0004/ 04371 ENDED " NOT
OK"
060601 092208 060601 I VP SEL203I JOB BRCC0001 ELI GI BLE FOR RUN
060601 092208 060601 I VP SUB133I JOB BRCC0001 BRCC0002/ 01958 SUBMI TTED
060601 092208 060601 I VP SEL203I JOB BRCC0002 ELI GI BLE FOR RUN
CMDS: SHOW, GROUP, CATEGORY, SHPF 09. 43. 00
Table 111 Fields of the IOA Log Screen (Part 1 of 2)
Field Description
SHOW LIMIT ON Identifies which selection criteria other than yes or no were
entered in the IOA Log Show Screen window (USERID,
MEM/ MIS, JOBNAME, CATEGORY, GROUP). For more
information, see Filtering the IOA Log Screen Display on
page 293.
DATE Date on which the message was issued.
TIME Time at which the message was issued.
IOA Log Facility
Chapter 2 Online Facilities 291
ODATE Original scheduling date of the job associated with the
message. Format is mmddyy, ddmmyy or yymmdd,
depending on the site standard.
Note: When the display type is set to RBA display using the
DISPLAY command, the Relative Byte Address (RBA) of the
message within the IOA Log file is displayed instead of the
ODATE. For more information on changing the screen
display, see Changing IOA Log Screen Display Types on
page 293.
USERID User ID of the job issuing the message, or user ID of the user
writing to the log.
CODE IOA message code.
MESSAGE Text of the message. If the message is longer than the space
available on the screen, the message is split and continues on
the following line. Messages relating to a job have the
following format:
t askt ype memname j obname/ j obi d message
fromdate todate Log information displayed in the screen can be limited to the
specified date range in mmddyy, ddmmyy or yymmdd
format, depending on the site standard. If the DATE or the
ODATE value for a message is in the range selected, the
message is included in the IOA Log display. Valid values are:
s fromdate Earliest date in the date range.
s todate Latest date in the date range.
Table 111 Fields of the IOA Log Screen (Part 2 of 2)
Field Description
IOA Log Facility
292 CONTROL-M for OS/390 and z/OS User Guide
Commands of the IOA Log Screen
The following commands can be entered in the COMMAND field.
Table 112 Commands of the IOA Log Screen
Command Description
SHOW The SHOW command activates the specified screen filter,
opens the IOA Log Show Screen window, or opens the Display
Filters window, depending on the format of the command. For
more information on filtering the IOA Log Screen, see
Filtering the IOA Log Screen Display on page 293. Valid
formats are:
s SHOW name Activates the specified filter.
s SHOW ? Opens the Display Filters window, which lists
all available filters.
s SHOW (PF02/PF14) Opens the IOA Log Show Screen
window for the currently active filter, and allows editing of
that filter.
s SHOW name EDIT Opens the IOA Log Show Screen
window for the specified filter, and allows editing of that
filter.
Note: Reserved filter name DEFAULT can be used to activate
or edit the default filter for the status screen. For example,
SHOW DEFAULT EDIT opens the IOA Log Show Screen
window for the default filter.
Only jobs conforming to selection criteria specified in the filter
are displayed in the IOA Log screen. For more information, see
Filtering the IOA Log Screen Display on page 293.
GROUP The GROUP Command alternately displays or hides the
GROUP name (if any) that is associated with the relevant job,
mission or rule definition. When displayed, the name of the
group appears after the job, mission or rule status.
CATEGORY The CATEGORY command alternately displays and hides the
CATEGORY of the relevant CONTROL-D mission. This
command applies to CONTROL-D generated messages only.
When displayed, the name of the category appears after the
mission status.
Note: At sites where CONTROL-D is active.
IOA Log Facility
Chapter 2 Online Facilities 293
Changing IOA Log Screen Display Types
While in the IOA Log screen, the display type can be changed through the DISPLAY
command. The format of the command is:
where x is a 1-character code that identifies the desired display type. DISPLAY can be
abbreviated DI.
Example
displays the No Reverse display.
Valid predefined displays are:
Filtering the IOA Log Screen Display
Screen filters can be used to filter the IOA Log screen display.
A filter consists of a set of record selection criteria (selection fields and their values).
Only records that conform to the selection criteria specified in the filter are displayed
on the screen.
The INCONTROL administrator can predefine filters and place them in the General
profile.
DI SPLAY x
NOTE
For a list of display types, enter DISPLAY ? to show the Display Options window. To
select a display type in the window, type S in the Option field next to the ID. To exit
the window without selecting a display type, press the END key (PF03/PF15).
DI B
Table 113 IOA Log Screen Predefined Display Types
Display Description
A Show RBA (Relative Byte Address) display (displays the RBA
of the message within the IOA Log file in place of the ODATE)
D Default display
B No Reverse display (display is in No Reverse mode)
IOA Log Facility
294 CONTROL-M for OS/390 and z/OS User Guide
Each user can activate an existing filter in the IOA Log screen by entering the SHOW
command in the COMMAND line of the IOA Log screen.
Each user can define multiple filters for the screen, through the IOA Log Show Screen
window, which is described in Fields of the IOA Log Show Screen Window on
page 296. User-defined filters belong to, are assigned names by, and can only be
activated by, the user who defined them. They are stored in the user profile.
You can see the list of all available filters by opening the Display Filters window.
A predefined default filter (DEFAULT) is defined for the IOA Log screen.
Site-defined defaults determine whether the last filter used or the DEFAULT filter is
activated upon reentry to the IOA Log screen.
Activating an existing filter in the IOA Log screen
The SHOW command can be used to activate an existing filter when you know the
name of the filter.
s To activate an existing filter in the IOA Log screen, enter the SHOW command in
the COMMAND field, as follows:
where name is the name of the filter to be activated.
s To activate the DEFAULT filter, use DEFAULT as the name of the filter.
Display Filters Window
When you do not know the name of a filter, you can still activate a filter from the list
of available filters by opening the Display Filters window. This window displays the
list of all available filters. These include Global filters that are available to all users, as
well as user-defined filters that are only available to the individual user. You can
activate a filter from the Display Filters window, or switch to the IOA Log Show
Screen window, where you can edit or define a filter.
SHOWname
IOA Log Facility
Chapter 2 Online Facilities 295
To enter the Display Filters window, type SHOW? in the COMMAND field of the IOA
Log screen and press Enter.
Figure 86 IOA Log Screen Display Filters Window
Fields of Display Filters Window
The Display Filters window contains the fields shown in Table 114:
Options of the Display Filters Window
To request one of the following options, type the option in the OPT field to the left of
the filter name and press Enter.
FI LTER: DEFAULT - - - - - - - - - - - - - - - - I OA LOG - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( 5)
COMMAND ===> SCROLL===> CRSR
SHOWLI MI T ON ==> DATE 060601 - 060601
DATE TI ME ODATE USERI D CODE - - - - - - M E S S A G E - - - - - - - - - - - - - - - - - - - -
060601 092144 060601 M22 SPY254I JOB CT085955 CT085955/ 01835 SCANNED
060601 092144 060601 M22 SEL208I JOB CT085955 CT085955/ 01835 ENDED " OK"
0 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + B CT085956 CT085956/ 01836 SCANNED
0 | DI SPLAY FI LTERS | B CT085956 CT085956/ 01836 ENDED " OK"
0 | CMD ==> SCROLL==> CRSR | B BRI VPCC BRI VPCC / 01843 SCANNED
0 | O NAME DESCRI PTI ON | B BRI VPCC BRI VPCC / 01843 ENDED " OK"
0 | CONFI RM | EE OF TASK BRCC0001 ODATE 080800
| DEL | RFORMED
0 | END | B I NTR0004 I NTR0004/ 04371 START
| ENDNOTOK | 253. 1316 STOP 98253. 1316 CPU 0MI N
| ENDOK | . 04SEC SRB 0MI N 00. 00SEC 0. 19
0 | EXEC | B I NTR0004 I NTR0004/ 04371 SCANNED
0 | LATE | B I NTR0004 I NTR0004/ 04371 ABENDED CC
| WAI T | 37 STEP STEP01
0 | ECSALL | B I NTR0004 I NTR0004/ 04371 ENDED " NOT
| =========>>> BOTTOM <<<========== | "
0 | | B BRCC0001 ELI GI BLE FOR RUN
0 | OPTI ONS S SELECT E EDI T | B BRCC0001 BRCC0002/ 01958 SUBMI TTED
0 +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + B BRCC0002 ELI GI BLE FOR RUN
CMDS: SHOW, GROUP, CATEGORY, SHPF 09. 43. 00
Table 114 Fields of the Display Filters Window
Field Description
NAME Name of the filter as it appears in the General or user profile.
DESCRIPTION Description of the filter.
Table 115 Options of the Display Filters Window
Option Description
S (SELECT) Filters the entries that are displayed in the Automation Log
Screen according to the criteria specified in the selected filter.
E (EDIT) Opens the IOA Log Show Screen window, where the filter
criteria are displayed. You can modify the filter criteria.
IOA Log Facility
296 CONTROL-M for OS/390 and z/OS User Guide
IOA Log Show Screen Window
The IOA Log Show Screen window in the IOA Log screen enables you to create or
modify a filter.
s To open an existing filter for editing, enter the following command:
SHOWfiltername EDI T
where filtername is the name of the filter to be displayed in the IOA Log Show
Screen window.
s To edit the currently active filter, it is not necessary to enter the name of the filter or
the EDIT keyword. Enter the SHOW command in the COMMAND field, or press
PF02/PF14. The following IOA Log Show Screen window is displayed:
Figure 87 IOA Log Show Screen Window
s To create a new filter, open any existing filter and enter a new name and
description in the FILTER and DESC fields (described in Fields of the IOA Log
Show Screen Window, below).
Fields of the IOA Log Show Screen Window
The IOA Log Show Screen window contains the following fields:
FI LTER: DEFA +- - - - - - - - - - - - - - - - - - - - I OA LOG SHOWSCREEN - - - - - - - - - - - - - - - - - - - ( 5)
COMMAND ===> | FI LTER DEFAULT SAVE ( Y/ N) DESC: |
SHOWLI MI T O | CM : D JOB M JOB SHOUT USER GENERAL D I NT M I NT STAT |
DATE TI ME | Y Y Y N N N N Y |
060601 14131 | CMEM : GENERAL |
| |
| |
060601 14131 | |
060601 14131 | |
060601 14153 | |
| |
060601 14155 | |
| CODE |
| URGENCY: REGULAR Y URGENT Y VERY- URGENT Y |
060601 14155 | TASK TYPE CM: JOB CYC EMR STC CST EST ECJ ECS WRN GRP |
060601 14155 | Y Y Y Y Y Y Y Y Y Y |
060601 14173 | |
| |
060601 14174 | USERI D N54A |
| MEM/ MI S MI GDASD |
| JOBNAME |
060601 14174 | CATEGORY |
060601 14174 | GROUP |
CMDS: SHOW, +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
IOA Log Facility
Chapter 2 Online Facilities 297
Fields that define the selection criteria to be applied to the screen are described below.
Fill in the selection criteria as necessary.
Table 116 Fields of the IOA Log Show Screen Window
Field Description
FILTER User-assigned name of the filter. The name entered in the
FILTER field can be modified.
If changes to a filter have not been saved, an asterisk is
displayed to the right of the filter name. For more information,
see Closing the IOA Log Show Screen Window on page 301.
SAVE (Y/ N) Specifies whether to save modifications to the filter upon
closing the window.
Desc: User-defined description of the filter. The description entered
here appears next to the name in the Displaying Filters
window.
NOTE
The INCONTROL administrator can limit which installed INCONTROL products
and options each user may access. However, because all INCONTROL products and
the messages they issue are integrated, it may be important for users to see the
messages of products and options to which they have no access. Therefore, the types
of messages for all INCONTROL products are listed in the IOA Log Show Screen
window, and by default, the messages of all installed products are listed in the IOA
Log screen.
NOTE
The selection criteria marked with the
P
symbol act on a prefix basis. For example,
typing D4 in the JOBNAME field causes the retrieval of all jobs whose names start
with D4.
IOA Log Facility
298 CONTROL-M for OS/390 and z/OS User Guide
Table 117 IOA Log Show Screen Window Selection Criteria (Part 1 of 2)
Criteria Description
CM message type To limit the type of log messages displayed, enter Y (Yes) or N
(No) under the desired message type.
Valid CONTROL-M message type codes are:
s D JOB Messages related to jobs produced during New
Day processing.
s M JOB Job-related messages produced by the
CONTROL-M monitor. The majority of job messages are of
this type.
s SHOUT Messages written to the Log file by the SHOUT
parameter. For more information, see SHOUT:
PostProcessing Parameter on page 618.
s USER Messages resulting from manual intervention of
authorized users in the operation of CONTROL-M; for
example, the addition of a prerequisite condition, HOLD
or RERUN of the job, and so on.
s GENERAL General messages on CONTROL-M
operation.
s D INT Internal messages generated during New Day
processing. For use mainly by maintenance personnel.
s M INT Certain CMEM messages, and internal messages
of the CONTROL-M monitor.
s STAT Statistical information about job execution.
CMEM message type To limit the type of log messages displayed, enter Y (Yes) or N
(No) under the desired message type. Valid CMEM message
type code:
s GENERAL General messages on CMEM operation.
Note: Selection criteria identified by CM message type and CMEM message
type are specific to CONTROL-M and CMEM, respectively. Other selection criteria,
such as those described below, are primarily applicable to other INCONTROL
products, but may also be available to CONTROL-M and CMEM.
CODEP

Show only IOA Log file messages with the specified message
IDs or prefix(es). A maximum of 6 message IDs (or prefixes)
can be specified.
IOA Log Facility
Chapter 2 Online Facilities 299
IOA Log Show Screen window (at Sites Where Multiple IOA
Products Are Active)
The IOA Log Show Screen window displays different selection criteria depending on
which INCONTROL products are operational at your site.
URGENCY Mark Y (Yes) or N (No) to specify the desired urgency of
messages. Urgent and very urgent messages are highlighted.
TASK TYPE When job messages are selected, limit the task types to be
displayed. Type Y to include or N to exclude the following
task types:
s JOB Regular job.
s CYC Cyclic job.
s EMR Emergency job.
s STC Started task.
s CST Cyclic started task.
s EST Emergency started task.
s ECJ Emergency cyclic job.
s ECS Emergency cyclic started task.
s WRN Warnings. Supported for historical reasons only.
s GRP Group Entity.
USERIDP Show only messages of the selected user IDs. A maximum of
five user IDs can be specified.
Note: Selection criteria MEM/ MIS, JOBNAME, and GROUP, described below, only
affect the display of messages related to a job. Messages not related to a job are not
affected by these selection criteria and are displayed unless suppressed by other
selection criteria.
CATEGORY is not relevant to CONTROL-M.
MEM/ MISP Limit displayed job messages to the selected member names.
A maximum of five member names can be specified. Messages
not related to a job are not affected by this show limit.
JOBNAMEP Limit displayed job messages to the selected job names. A
maximum of five job names can be specified. Messages not
related to a job are not affected by this show limit.
CATEGORY CONTROL-D category. This selection field is not relevant to
CONTROL-M and does not filter CONTROL-M jobs.
GROUPP Limit displayed job messages to the selected groups. A
maximum of four groups can be specified. Messages not
related to a job are not affected by this show limit.
Table 117 IOA Log Show Screen Window Selection Criteria (Part 2 of 2)
Criteria Description
IOA Log Facility
300 CONTROL-M for OS/390 and z/OS User Guide
The IOA Log Show Screen window at sites where all INCONTROL products are
active is illustrated in Figure 88.
Figure 88 IOA Log Show Screen Window at Sites where Multiple INCONTROL
Products are Active
The CONTROL-M selection criteria are described in Table 117 on page 298. For
descriptions of the selection options for other INCONTROL products, see the user
guides of the respective products.
FI LTER: DEFA +- - - - - - - - - - - - - - - - - - - - I OA LOG SHOWSCREEN - - - - - - - - - - - - - - - - - - - ( 5)
COMMAND ===> | FI LTER SAVE ( Y/ N) |
SHOWLI MI T O | CM : D JOB M JOB SHOUT USER GENERAL D I NT M I NT STAT |
DATE TI ME | Y Y Y Y Y N N N |
060800 21354 | CO+CMEM: GENERAL SHOUT JOBS GENERAL WPI PE WJOB W |
| Y Y Y |
060601 22040 | CD+CV : SBSYS REP MI S SHOUT USER GENERAL DAI LY MONI T STAT |
060601 22040 | Y Y Y Y Y Y N N N |
060601 22040 | CB : RUNTI ME SHOUT DAI LY GENERAL STATI STI CS |
| Y Y Y Y Y |
060601 22040 | CT : GENERAL SHOUT REAL- TI ME UTI LI TI ES |
060601 22040 | Y Y Y Y |
060601 22040 | CODE |
| URGENCY: REGULAR Y URGENT Y VERY- URGENT Y |
060601 23034 | TASK TYPE CM: JOB CYC EMR STC CST EST ECJ ECS WRN GRP |
060601 23040 | Y Y Y Y Y Y Y Y Y Y |
060601 23040 | CD: REP PRT BKP/ MI G RST EMR NOEMR CYC NOCYC |
060601 23040 | Y Y Y Y Y Y Y Y |
| USERI D N54A |
060601 23040 | MEM/ MI S MI GDASD |
060601 23040 | JOBNAME |
060601 23040 | CATEGORY |
| GROUP |
CMDS: SHOW, +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
NOTE
The INCONTROL administrator can limit which installed INCONTROL products
and options each user can access. However, because all INCONTROL products and
the messages they issue are integrated, it may be important for users to see the
messages of products and options to which they have no access. Therefore, the types
of messages for all INCONTROL products are listed in the IOA Log Show Screen
window, and by default, the messages of all installed products are listed in the IOA
Log screen.
IOA Calendar Facility
Chapter 2 Online Facilities 301
Closing the IOA Log Show Screen Window
You can activate an edited filter with or without saving changes, depending on the
value you type in the SAVE field, as follows:
s To activate and save the filter, type Y (Yes) in the SAVE field. Changes to the filter
are permanently saved.
s To activate the filter without saving it, type N (No) in the SAVE field. Changes are
kept in memory only, but are not saved.
After entering a value in the SAVE field, press one of the following keys:
The window is closed and the filter is activated as defined or modified.
To cancel changes made in the IOA Log Show Screen window, press RESET
(PF10/PF22). The changes are canceled regardless of the value entered in the SAVE
field, the window is closed, and the filter that was previously in effect is restored.
By default, pressing END (PF03/PF15) in the window works like pressing Enter.
However, the default can be modified so that pressing END works like pressing
RESET.
IOA Calendar Facility
The IOA Calendar facility enables you to create, view, or modify calendar definitions.
Calendars simplify the scheduling of INCONTROL product jobs, missions, rules, and
so on. When a particular schedule is used in many job scheduling, mission, and/ or
rule definitions, a calendar can be defined for that schedule, and the name of that
calendar can be specified in all the job, mission, or rule definitions that use that
particular schedule.
Table 118 IOA Log Show Screen window - Closing Values
Key Description
Enter Filtering begins with the first message currently displayed in
the screen and continues downward.
PF07 (UP) Filtering begins with the first message in the IOA Log file and
continues downward.
PF08 (DOWN) Filtering begins with the last message in the IOA Log file and
continues upward.
IOA Calendar Facility
302 CONTROL-M for OS/390 and z/OS User Guide
For example, calendars may be defined to handle the normal scheduling needs for
workdays, holidays, weekends, beginning of month, end of month, and so on.
Exception calendars may also be created.
A calendar definition consists of parameters that specify when scheduling occurs.
Calendar definitions are stored in members. A member usually contains multiple
calendar definitions, as follows:
s A member contains the calendars required for a specific type of scheduling need.
For example, the calendar member WORKDAYS may contain the calendar
definitions for normal workday scheduling.
s Each calendar definition in that member defines the schedule for a given year. For
example, the calendar member WORKDAYS may contain calendar definitions
2001, 2002, and 2003. Each of those definitions contains the normal workday
schedule for the corresponding year.
The IOA Calendar facility also enables the definition of varied work periods
throughout the year, in special calendars called periodic calendars.
A calendar definition needs to be created only once. Once defined, the definition is
saved and used as necessary for scheduling. Calendar definitions can be modified or
deleted as required.
Any number of calendar members can be defined. Calendar members are stored in
calendar libraries (partitioned data sets). Generally one calendar library is defined at
time of installation, and referenced by the DACAL DD statement.
Ensure that each IOA calendar that you define contains entries for the years
preceding and following the period you want to define. The entries for the preceding
and following years can be dummy entries, provided that these years contain at least
one day set to Y. If an IOA calendar does not contain entries for the preceding and
following years, problems may arise when CONTROL-M resolves scheduling
criteria, in which event the CTM707E message is displayed.
NOTE
The IOA Calendar facility does not support members that have been compressed
using the ISPF PACK option.
IOA Calendar Facility
Chapter 2 Online Facilities 303
Accessing the IOA Calendar Facility
The IOA Calendar facility contains the screens shown in Table 119:
To enter the Calendar facility, select Option 8 in the IOA Primary Option menu. The
Calendar facility entry panel is displayed.
Depending on the values entered in the entry panel, you can bypass the Calendar List
screen and/ or the Year List screen.
Table 119 IOA Calendar Facility Screens
Screen Description
IOA Calendar
Facility entry panel
Enables specification of parameters that determine which
records are displayed in subsequent screens.
Calendar List screen Displays the list of calendar members in the selected calendar
library.
Year List screen Displays the list of years for which there is a calendar
definition in the selected calendar member.
Calendar Definition
screen
Displays the parameters of the selected calendar for the
selected year. This is the main screen of the facility.
IOA Calendar Facility
304 CONTROL-M for OS/390 and z/OS User Guide
Entry Panel
The entry panel is displayed upon entering the IOA Calendar facility (Option 8 in the
IOA Primary Option menu).
Figure 89 IOA Calendar Facility Entry Panel
Fields of the Entry Panel
Fill in the fields shown in Table 120 and press Enter.
- - - - - - - - - - - - - - - - - - - - - I OA CALENDAR FACI LI TY - ENTRY PANEL - - - - - - - - - - - - - - - - - - ( 8)
COMMAND ===>



SPECI FY LI BRARY, CALENDAR, YEAR

LI BRARY ===> I OA. PROD. CAL
CALENDAR ===> ( Bl ank f or cal endar sel ect i on l i st )
YEAR ===> ( Bl ank f or year sel ect i on l i st )













USE THE COMMAND " SHPF" TO SEE PFK ASSI GNMENT 10. 58. 42
Table 120 Fields of the IOA Calendar Facility Entry Panel (Part 1 of 2)
Field Description
LIBRARY Name of the desired calendar library. Mandatory.
If you make an entry in this field without filling in the
CALENDAR field, the list of calendars in the selected library is
displayed in the Calendar List screen.
If you make an entry in this field, you can restrict the list of
calendars that are displayed by entering in the CALENDAR
field part of a Calendar name together with a mask character
or characters (? and *).
IOA Calendar Facility
Chapter 2 Online Facilities 305
Calendar List Screen
The Calendar List screen displays a list of calendars (members) in the selected library.
This screen can be entered directly from the entry panel or upon exiting the Year List
screen.
By default, only calendar names are listed in the screen. However, if the default has
been modified at time of installation, statistical information is displayed for each
calendar name, as shown in Figure 90.
Figure 90 Calendar List Screen
CALENDAR Name of the desired calendar member. Optional.
If you make an entry in this field without filling in the YEAR
field, the list of years in the selected calendar member is
displayed in the Year List screen.
YEAR Year of the desired calendar definition. Optional.
This field can be used only if a CALENDAR value is also
entered. If specified, the calendar definition is displayed in the
Calendar Definition screen.
CALENDARS I N LI B I OA. PROD. CAL - - - - - - - - - - - - ( 8. D)
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - - - - - - - - - - VV. MM CREATED CHANGED SI ZE I NI T MOD I D
BANKDAYS 01. 00 02/ 01/ 28 01/ 06/ 29 09: 50 104 104 0 I OAPROD
DAYSOFF 01. 00 02/ 01/ 28 01/ 06/ 29 09: 50 30 30 0 I OAPROD
HOLI DAYS 01. 00 02/ 01/ 28 01/ 06/ 29 09: 50 15 15 0 I OAPROD
PERI OD1O 01. 00 02/ 01/ 28 01/ 06/ 29 09: 50 45 45 0 I OAPROD
SACAYCLN 01. 01 02/ 01/ 28 01/ 11/ 29 17: 43 26 26 0 L3051
SPMONCLN 01. 01 02/ 01/ 29 01/ 11/ 30 15: 00 117 104 0 M16A
SPWEKCLN 01. 01 02/ 01/ 29 01/ 11/ 30 15: 10 117 104 0 M16A
STOCKDAY 01. 00 02/ 01/ 30 01/ 06/ 31 09: 50 45 45 0 I OAPROD
WORKDAYS 01. 01 02/ 01/ 30 01/ 11/ 31 17: 43 26 26 0 L3051
======= >>>>>>>>>>>>>>>> NO MORE CALENDARS I N LI BRARY <<<<<<<<<<<<<<<< ======










OPTI ONS: S SELECT B BROWSE D DELETE 13. 54. 14
Table 120 Fields of the IOA Calendar Facility Entry Panel (Part 2 of 2)
Field Description
IOA Calendar Facility
306 CONTROL-M for OS/390 and z/OS User Guide
To return to the entry panel, press END (PF03/PF15).
Options of the Calendar List Screen
To request one of the following options, type the option in the OPT field to the left of
the calendar names, and press Enter.
Year List Screen
The screen displays the list of years for which a specified calendar is defined. This
screen can be entered directly through the entry panel or the Calendar List screen, or
upon returning from the Year Definition screen.
If a calendar description was defined in the Calendar Definition screen, the definition
is displayed to the right of the year.
Table 121 Options of the Calendar List Screen
Option Description
S (SELECT) Display the list of years for the calendar for any purpose,
including editing or modification. Only one calendar can be
selected at a time.
B (BROWSE) Display the list of years for the calendar for browsing. Only
one calendar can be selected at a time.
D (DELETE) Delete the calendar (member) from the library. Multiple
calendars can be selected.
NOTE
If the S (Select) option was entered in the Calendar List screen for a calendar that is
currently in use (selected) by another user, either the Year List screen is not displayed
and the Calendar List screen remains displayed (the default), or the Year list screen is
displayed in Browse mode (if a user profile definition overrides the default). In either
case, an appropriate message is displayed.
IOA Calendar Facility
Chapter 2 Online Facilities 307
Figure 91 Year List Screen
To return to the Calendar List screen press END (PF03/PF15).
Format of the Year List Screen
Next to each year in the Year list, certain information can be displayed. The type and
format of this information depends on whether the screen is displayed in DESC
format or in STAT format:
s In DESC format, the description of the year, taken from the DESC field of the
calendar definition, is displayed. Default.
s In STAT format, the ISPF statistical information for the calendar definition is
displayed.
By default, the Year list is displayed in DESC format. To change formats, use the
DESC or STAT commands, described in Table 122.
Commands of the Year List Screen
The following commands can be entered in the COMMAND field of the Year List
screen.
LI ST OF YEARS I N I OA. PROD. CAL CALENDAR WORKDAYS
COMMAND ===> SCROLL===> CRSR
OPT YEAR - - - - - - - - - - - - - - - - - - DESCRI PTI ON - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2001 REGULAR WORKI NG DAYS I N 2001
2002 REGULAR WORKI NG DAYS I N 2002
2003 REGULAR WORKI NG DAYS I N 2003
2004 REGULAR WORKI NG DAYS I N 2004
2005 REGULAR WORKI NG DAYS I N 2005
======= >>>>>>>>>>>>>>>> NO MORE YEARS I N CALENDAR <<<<<<<<<<<<<<<< =====














OPTI ONS: S SELECT D DELETE I I NSERT WI NSERT BY WEEK DAYS C COPY 08. 52. 54
IOA Calendar Facility
308 CONTROL-M for OS/390 and z/OS User Guide
Options of the Year List Screen
To request one of the options shown in Table 123, type the option in the OPT field to
the left of the year and press Enter.
Table 122 Commands of the Year List Screen
Command Description
DESC The DESC command displays the calendar description next to
the year. The description is taken from the DESCRIPTION field
in the calendar definition.
STAT The STAT command displays the following ISPF-like
statistical information about the calendar next to the year:
version and modification numbers, creation date, last
modification date, and user ID.
NOTE
If the Year List screen is displayed in Browse mode, options D (Delete), I (Insert), and
W (Insert By Week Days) are not available.
Table 123 Options of the Year List Screen (Part 1 of 2)
Option Description
S (SELECT) Display the calendar definition for the specific year.
Parameters can be edited and updated only if the Calendar
Definition screen is not displayed in Browse mode. If the
Calendar Definition screen is displayed in Browse mode, the
screen can only be browsed and parameters cannot be
modified.
D (DELETE) Delete the calendar definition for the specified year.
I (INSERT) Insert a new year in the Year List screen and display the
Calendar Definition screen with a predefined year definition
for editing. The predefined calendar definition is defined with
the same dates as the year next to which the I (Insert) request
was specified. For more information, see Inserting a New
Year on page 309.
IOA Calendar Facility
Chapter 2 Online Facilities 309
Inserting a New Year
All calendar definitions identified in the same Year List usually have the same fixed
scheduling pattern. Often, this scheduling pattern is based either on dates within a
month or on days of the week within the month. For example:
s Calendar QUARTERLY might always indicate scheduling for the last day of
March, June, September and December (that is, a scheduling pattern based on
dates).
s Calendar WEEKEND might always indicate scheduling all Saturdays and/ or
Sundays in each month (that is, a scheduling pattern based on days of the week).
This scheduling pattern also applies to new calendar definitions resulting from the
insertion of a new year in the Year List screen.
When a year is inserted in the Year List, the IOA Calendar facility automatically
generates a predefined calendar definition for the new year, based on the scheduling
pattern of the calendar by which the insert request was specified. This frees the user
from having to manually define the new calendar. This automatically generated
calendar definition can be displayed and modified.
In calendar definitions, a defined scheduling date is described by both the date
(month and day) and the day of the week. Because a particular date falls on a
different day of the week in different years, it is necessary to indicate whether the
scheduling pattern is based on the date or on the days of the week. This is indicated
by the specified insert option.
W (INSERT BY
WEEK DAYS)
Insert a new year in the Year List screen and display the
Calendar Definition screen for editing a predefined year
definition. The predefined year definition is defined with the
same days of the week as the year next to which the W (Insert
by Week Days) request was specified. For more information,
see Inserting a New Year.
C (COPY) Copy the year to another calendar, as described in Copying
Years to Another Calendar on page 310. Multiple years can
be selected.
NOTE
The Year list must be kept in ascending order without missing years (for example,
2001, 2002, 2003, 2004, 2005). Each new year must be added at the end of the list.
Table 123 Options of the Year List Screen (Part 2 of 2)
Option Description
IOA Calendar Facility
310 CONTROL-M for OS/390 and z/OS User Guide
s To define the calendar with the same scheduling dates (although corresponding
days of the week may vary, for example, calendar QUARTERLY described above),
type option I (INSERT).
s To define the calendar so that scheduling takes place on the same weekdays as in
the previous calendar (although the corresponding dates may vary, for example,
calendar WEEKEND described above), type option W (INSERT BY WEEK DAYS).
s If the scheduling pattern is mixed (for example, calendar HOLIDAYS always
indicates scheduling on both January 1 and the first Monday in September),
specify the more appropriate option and correct the new calendar definition
manually.
Copying Years to Another Calendar
Years currently displayed in the Year List screen can be copied to another calendar.
To copy the desired years, type option C (COPY) next to each desired year in the
screen and press Enter. The window shown in Figure 92 is displayed:
Figure 92 Calendar List Screen Copy Window
The window contains the fields shown in Table 124 (some fields contain default
values that can be modified):
LIST OF YEARS IN: IOA.PROD.CAL CALENDAR: CALEN1
COMMAND ===> SCROLL===> CRSR
OPT YEAR -------- DESCRIPTION ------------------------------------------------
2001 REGULAR WORKING DAYS IN 2001
C 2002 REGULAR WORKING DAYS IN 2002
2003 REGULAR WORKING DAYS IN 2003
2004 REGULAR WORKING DAYS IN 2004
+-----------------------------------------------------------+
| |
| SPECIFY DESTINATION LIBRARY,CALENDAR AND RULE NAME |
| |
| LIBRARY : IOA.PROD.CAL |
| CALENDAR: |
| YEAR : 2005 |
| |
| PRESS END/RESET TO CANCEL ENTER TO PERFORM THE COPY |
+-----------------------------------------------------------+






OPTIONS: S SELECT D DELETE I I NSERT WI NSERT BY WEEK DAYS C COPY 15.37.39
IOA Calendar Facility
Chapter 2 Online Facilities 311
To perform a request, press Enter.
To cancel a request, press END (PF03/PF15) or RESET (PF04/PF16).
Table 124 Fields of the Calendar List Screen Copy Window
Field Description
LIBRARY Library containing the calendar into which the years must be
copied. Must be an existing library. Default: The current
library.
CALENDAR Name of the calendar into which the year must be copied.
Note: A year can only be copied to another calendar. It cannot
be copied to its own calendar (even if the year is renamed).
If the selected calendar does not exist in the Calendar List, the
calendar is created when the request is performed.
YEAR Name of the year to be copied. If multiple years are selected,
the window is initially displayed with the first selected year.
As each request is performed or canceled, the next requested
year name appears.
IOA Calendar Facility
312 CONTROL-M for OS/390 and z/OS User Guide
Calendar Definition Screen
This screen is used to define, display and modify dates in a calendar for a specific
year. This screen can be entered directly from the entry panel or from the Year List
screen.
Figure 93 Calendar Definition Screen
Fields of the Calendar Definition Screen
- - - - - - - - - - - - - - - - - - - - - - - - - - - I OA CALENDAR - WEEKDAYS - - - - - - - - - - - - - - - - - - - - - - ( 8. Y)
COMMAND ===> SCROLL===> CRSR
YEAR 2002 REGULAR WORKDAYS I N 2002

- - - - - 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 + 1
01 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
- - - - - 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
02 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
- - - - - 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 + 1
03 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
- - - - - 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 +
04 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
- - - - - 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 + 1
05 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
- - - - - 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 +
06 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
- - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - -
TYPE Y I N ALL THE EXECUTI ON DAYS 14. 37. 10
Table 125 Fields of the Calendar Definition Screen (Part 1 of 2)
Field Description
YEAR Year of the calendar. This value can be modified. When
modified, the values indicated for each date in each month
(described below) are shifted to the appropriate day of the
week.
description User-supplied, free text description of the calendar. Optional.
IOA Calendar Facility
Chapter 2 Online Facilities 313
Periodic Calendars
Some jobs must be scheduled periodically, according to schedules that are not easily
expressed in terms of fixed days and dates within months. In these cases, monthly, or
even yearly, scheduling definition is awkward. For example:
s A payroll job needs to be scheduled every other Wednesday:
In some months, the job may be scheduled on the first, third, and even fifth
Wednesday in the month. In other months, it may be scheduled on the second
and fourth Wednesday in the month.
In some years, the job may be scheduled beginning on the first Wednesday of
the year. In other years, it may be scheduled beginning on the second
Wednesday of the year.
month/ dates Each month of the year (01 through 12) of the calendar consists
of the following:
s Separator line. Sunday (or Saturday) is marked S
(according to the default at your site).
s Month label (01 through 12).
s Date label for the day of the month.
Updatable field for defining execution dates. Valid values are:
s Y (Yes) Select the job on that date.
s N (No) or ' ' (Blank) Do not select the job for execution on
that date.
s + For a relative calendar, select the closest next date.
s - For a relative calendar, select the closest previous
date.
Note: A relative calendar is a calendar used in a formula to
create other calendars. It cannot be specified in a DCAL,
WCAL, or CONFCAL field. For details, see the description of
the IOABLCAL utility in the INCONTROL for OS/ 390 and
z/ OS Utilities Guide.
Table 125 Fields of the Calendar Definition Screen (Part 2 of 2)
Field Description
IOA Calendar Facility
314 CONTROL-M for OS/390 and z/OS User Guide
s A job must be scheduled every 25 days, regardless of date. Such a job is scheduled
on different dates each month and each year.
The IOA Calendar facility provides special calendars, called periodic calendars, to
allow specification of these scheduling requirements. These periodic calendars are
very flexible.
To designate a calendar as periodic, you must type reserved string ==PERIODIC== in
the first 12 positions of the description field. Any text can be entered in the rest of the
description field. This is illustrated in Figure 94.
Figure 94 Use of Reserved String ==PERIODIC==
The following are characteristics of periodic calendars:
s In a periodic calendar, days are not marked using the letters Y (Yes) or N (No).
Instead, a period identifier is used to mark working days in a period. A period
identifier can be any letter from A to Z (except Y and N), any number from 0 to 9,
or any other printable sign. If you need more characters, use characters falling
within the hexadecimal range 4A through F9. All working days within the same
period must be marked using the same period identifier character so that different
identifier characters indicate different periods. Days that are not marked are
nonworking days because they do not belong to any period in this calendar.
s Identifiers from different periods can be interspersed throughout a periodic
calendar.
s A periodic calendar can consist of smaller units that do not correspond to regular
months, in that they can be longer or shorter than regular months.
s A periodic calendar can span a period, called a logical year, which can be longer
or shorter than one regular calendar year.
When a periodic calendar spans parts of two regular calendar years, special
considerations are likely to arise. For more information, see Special Year-End
Handling of Periodic Calendars on page 316.
s A period can span any number of days, but no more than a preset number of days
can elapse after the appearance of one identifier in a period until the appearance of
the next matching identifier in the same period. After that period expires, the next
matching identifier starts a new period.
By default, this period is preset to 33 days. Once the length of the gap between
matching identifiers exceeds 33 days, the period automatically closes.
COMMAND ===> SCROLL===> CRSR
YEAR 2002 - ==PERI ODI C== GENERAL WORKDAY CALENDAR
IOA Calendar Facility
Chapter 2 Online Facilities 315
For more information on the use of periodic calendars, see DAYS: Basic Scheduling
Parameter on page 420 and WDAYS: Basic Scheduling Parameter on page 654.
Examples
Figure 95 shows examples of periodic calendars:
Figure 95 Periodic Calendar Example 1
This example contains two periods: A and B.
s Period A starts on December 13 and ends on December 23. During this period, the
defined working days are December 13, December 18, December 20, and December
23.
s Period B spans more than one calendar year. It starts on December 21 and ends on
January 24. During this period, the defined working days are December 21,
January 4, and January 24.
Figure 96 Periodic Calendar Example 2
This example includes a period B that begins on March 9. The last marked working
day of the period is March 21, which is followed by a 33-day gap. Assuming that
Wish WM2888 has not been used to alter the default period of 33 days, period B
automatically ends on April 23, and April 24 marks the beginning of a new period B.
If no more B identifiers are added, this new B period ends on May 27.
NOTE
The length of the default period can be changed from 33 days by the INCONTROL
administrator, using optional Wish WM2888.
- - - - - 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 + 1
12 A A A B A
- - - - - 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 + 1
01 B B
- - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- -
- - - - - 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 + 1
03 B A B A
- - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - 0- - - 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 +
04 B
- - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- - - - - - - - - - - - - S- -
IOA Calendar Facility
316 CONTROL-M for OS/390 and z/OS User Guide
Special Year-End Handling of Periodic Calendars
Jobs or missions may be improperly scheduled if both the following are true:
s a periodic calendar contains one or more periods that start in one year and
continue into the next year
s the first occurrence of the matching identifier in one logical year falls within the
default gap that began at the last occurrence of the matching identifier in a prior
logical year, possibly as a result of changes made using optional Wish WM2888
In such cases, the period in the prior logical year overlaps the period in the later
logical year, causing a scheduled job not to run in the later logical year as expected.
To avoid this problem, remove logical years from periodic calendars as soon as they
are no longer needed.
Example
s Logical year FISCAL01 extends from April 1, 2001 through March 31, 2002.
s Logical year FISCAL01 contains a period identified as Period A that has been
defined to begin on December 28, 2001 and to continue through January 15, 2002.
s Logical year FISCAL02 extends from April 1, 2002 through March 31, 2003 .
s Logical year FISCAL02 also contains a period identified as Period A, defined to
begin on April 20, 2002 and continue through May 3, 2002.
s Job X is scheduled for the seventh day of Period A in each logical year, through the
job definition DAYS=D7PA.
In a case where the default gap is 33 days, Job X runs in January 2002, and again in
April 2002, as expected.
In a case where the default gap is changed from 33 days to a longer period, such as
120 days, the first day of Period A in logical year FISCAL02 occurs less than 120 days
after the last appearance of Period A in logical year FISCAL01. As a result, what
appears to be the seventh day in Period A in April 2002 is not recognized as such,
because the old Period A overlaps the new Period A. Consequently, Job X does
not run again when the user may have expected it to run.
Deleting Calendars
To delete calendars, type option D next to the calendar names in the Calendar List
screen and press Enter.
IOA Calendar Facility
Chapter 2 Online Facilities 317
The confirmation window shown in Figure 97 is displayed, in sequence, for each
calendar selected for deletion.
Figure 97 Calendar List Screen Delete Confirmation Window
Type Y (Yes) in the window to delete the calendar.
Type N (No) in the window to cancel the delete request.
For each calendar deleted, a message is written to the IOA Log file.
Exiting the IOA Calendar Facility
When exiting the IOA Calendar facility, screens are exited in the following sequence:
1. Calendar Definition screen
2. Year List screen
3. Calendar List screen
CALENDARS I N LI B I OA. PROD. CAL - - - - - - - - - - - - ( 8. D)
COMMAND ===> +- - - - - - - - - - - - - - - - - - - - - - - - - - + SCROLL===> CRSR
OPT NAME - - - | CONFI RM DELETE OPTI ON | E I NI T MOD I D
D BANKDAYS <- - - - - - - - - - - | ( Y/ N) | 4 104 0 I OAPROD
DAYSOFF +- - - - - - - - - - - - - - - - - - - - - - - - - - + 0 30 0 I OAPROD
HOLI DAYS 01. 00 02/ 01/ 28 01/ 06/ 29 09: 50 15 15 0 I OAPROD
PERI OD1O 01. 00 02/ 01/ 28 01/ 06/ 29 09: 50 45 45 0 I OAPROD
D SACAYCLN 01. 01 02/ 01/ 28 01/ 11/ 29 17: 43 26 26 0 L3051
SPMONCLN 01. 01 02/ 01/ 29 01/ 11/ 30 15: 00 117 104 0 M16A
SPWEKCLN 01. 01 02/ 01/ 29 01/ 11/ 30 15: 10 117 104 0 M16A
STOCKDAY 01. 00 02/ 01/ 30 01/ 06/ 31 09: 50 45 45 0 I OAPROD
WORKDAYS 01. 01 02/ 01/ 30 01/ 11/ 31 17: 43 26 26 0 L3051
======= >>>>>>>>>>>>>>>> NO MORE CALENDARS I N LI BRARY <<<<<<<<<<<<<<<< ======










OPTI ONS: S SELECT D DELETE I I NSERT WI NSERT BY WEEK DAYS C COPY 13. 54. 14
NOTE
If PDSMAN is operational at your site, $$$SPACE members are not deleted.
IOA Calendar Facility
318 CONTROL-M for OS/390 and z/OS User Guide
Calendar Facility Entry Panel
The commands and options available when exiting screens depend on the screen
being exited and on whether changes have been made. If changes have been made,
the selected exit options and commands determine whether the changes are saved.
Exit options and commands are discussed below on a screen by screen basis.
Exiting the Calendar Definition Screen
Use any of the following commands, or press the corresponding PFKey, to exit the
Calendar Definition screen:
NOTE
If the Calendar List screen was bypassed as you entered the IOA Calendar facility
(that is, if you entered a CALENDAR value in the entry panel), the Calendar List
screen is not displayed upon exiting the Year List screen; instead, the entry panel is
displayed.
Table 126 Commands for Exiting the Calendar Definition Screen
Command Description
CANCEL Cancel the changes made to the calendar definition and return
to the Year List screen.
Note: The following exit commands retain changes to the calendar definition in
memory. To permanently save the changes to disk, you must also request that the
changes be saved when you exit the Year List screen.
END (PF03/PF15)
Enter
Keep changes to the calendar definition in memory and exit to
the Year List screen.
NEXTYEAR
(PF11/PF23)
Keep changes to the calendar definition in memory and
display the next calendar definition in the Year List screen.
PREVYEAR
(PF10/PF22)
Keep changes to the calendar definition in memory and
display the previous calendar definition in the Year List
screen.
IOA Calendar Facility
Chapter 2 Online Facilities 319
Exiting the Year List Screen
Press END (PF03/PF15) to exit the Year List screen. If changes made to at least one
calendar definition have been kept in memory or if any changes have been made to
the Year List screen, the Exit Option window is displayed. For more information, see
Exiting the Calendar Definition Screen on page 318.
Figure 98 Year List Screen Exit Option Window
Fill in the Exit Option window as follows:
The LIBRARY and TABLE (member) fields indicate the library and member in which
the calendar definitions must be saved. The specified values can be modified (for
example, to save the calendar definitions in a different member).
s To save all changes currently in memory and exit the Year List screen, type Y (Yes)
after the word SAVE or CREATE:
Type Y after the word SAVE if a member with the same calendar name already
exists in the specified library.
Type Y after the word CREATE if a member with the same calendar name does
not exist in the specified library.
LI ST OF YEARS I N I OA. PROD. CAL CALENDAR WORKDAYS
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + ===> CRSR
OPT N | PLEASE SELECT EXI T OPTI ON |
1 | |
1 | SAVE CREATE |
1 | |
====== | LI BRARY I OA. PROD. CAL | << =====
| TABLE WORKDAYS |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +













OPTI ONS: S SELECT D DELETE I I NSERT WI NSERT BY WEEK DAYS C COPY 08. 53. 50
Utilities Under ISPF
320 CONTROL-M for OS/390 and z/OS User Guide
s To cancel changes currently in memory and exit the Year List screen, type N (No)
after the word SAVE or CREATE.
s To close the Exit Option window and remain in the Year List screen (with the
changes remaining in memory), press RESET (PF04/PF16).
Exiting the Calendar List Screen
Press END (PF03/PF15) to exit the Calendar List screen.
Exiting the Entry Panel
Press END (PF03/PF15) to exit the entry panel.
Utilities Under ISPF
Several IOA facilities can only be activated under ISPF. To activate these facilities,
select option 6 on the IOA Primary Option menu (under ISPF) or invoke the IOAUTIL
CLIST from the TSO Command Processor. The IOA Online Utilities menu is
displayed.
NOTE
If you create a new calendar member, the member name does not appear in the
Calendar List screen upon exiting the Year List screen; it first appears when you
reenter the Calendar List screen from the entry panel.
NOTE
The INCONTROL administrator can remove user authority to access option 6 on the
IOA Primary Option menu. In this case, the IOA Online Utilities menu is not
displayed.
Utilities Under ISPF
Chapter 2 Online Facilities 321
IOA Online Utilities Menu
Depending on the INCONTROL products that are available at your site, different
online utility options are displayed in the On-line Utilities menu. Figure 99 shows the
IOA On-line Utilities menu that is displayed when all applicable INCONTROL
products are active.
Figure 99 IOA Online Utilities Menu when all INCONTROL Products are Installed
To access an available utility, type the desired option number in the OPTION field
and press Enter.
Options I1, M1, M2, M3, M4, M5, and M6, which are also available when
CONTROL-M is installed as a standalone product are described on the following
pages. For the descriptions of other utilities on the menu, see the user guides of the
relevant products.
Online utility screens utilize standard ISPF profile capabilities.
Quick transfer to a utility can be performed by entering =opt from another utility
screen, or =6.opt from a non-utility screen (for example, the IOA Log screen), where
opt is the 2-character option identified on the IOA Online Utilities menu.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ON- LI NE UTI LI TI ES - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
USERI D - N06
TI ME - 13: 40
TERMI NAL - 3278

D1 DECOLLATI NG - Schedul e a Repor t Decol l at i ng Mi ssi on
D2 PRI NT - Schedul e a Pr i nt i ng Mi ssi on
D3 BACKUP/ MI GRATI ON - Schedul e a Backup/ Mi gr at i on Mi ssi on
D4 RESTORE - Schedul e a Rest or e Mi ssi on
I 1 PREREQ CONDI TI ON - Add/ Check/ Del et e a Pr er equi si t e Condi t i on
M1 JOB ORDER I SSUE - I ssue a Job Or der
M2 AUTOEDI T SI MUL - Per f or m an Aut oEdi t Si mul at i on
M3 SI MUL/ TAPE PULL - Pr epar e Si mul at i on/ Tape Pul l Li st Job
M4 PARAM PROMPTI NG - Par amet er Pr ompt i ng Faci l i t i es
M5 QUI CK SCHEDULE - Qui ck Schedul e Def i ni t i on
M6 USER I NTERFACE - End- User Job Or der I nt er f ace
R1 CTM/ RESTART SI M - CONTROL- M/ Rest ar t Si mul at i on
R2 DATASET CLEANUP - CONTROL- M/ Rest ar t Dat aset Cl eanup
R3 JOB DATASET LI ST - Pr epar e a Job Dat aset Li st
R4 STANDALONE - CONTROL- M/ Rest ar t St andal one
T1 CONTROL- M/ Tape SI MUL - Si mul at e CONTROL- M/ Tape Rul es
X EXI T - Exi t Thi s Menu

OPTI ON ===>
NOTE
If DOCU/ TEXT has also been installed at your site, an additional utility, option U1, is
displayed in the Online Utilities menu.
Utilities Under ISPF
322 CONTROL-M for OS/390 and z/OS User Guide
I1: Add, Check, or Delete a Prerequisite Condition
This utility adds prerequisite conditions to, checks the existence of prerequisite
conditions in, and deletes prerequisite conditions from, the IOA Conditions file.
The Prerequisite Condition Utility screen, shown in Figure 100, can be displayed in
the following ways:
s Select option I1 in the Online Utilities menu.
s Invoke the IOACCND CLIST from the TSO Command Processor screen.
Figure 100 Prerequisite Condition Utility Screen
To activate the utility, fill in the fields shown in Table 127 and press Enter:
- - - - - - - - - - - - - - - - - - - - - - - PREREQUI SI TE CONDI TI ON UTI LI TY - - - - - - - - - - - - - - - - - - - - -
COMMAND ===>




FUNCTI ON ===> ADD ( ADD/ CHECK/ DELETE)

CONDI TI ON NAME ===> SALARY_RPT_OK

Ent er ei t her dat e or STAT:

CONDI TI ON DATE ===> STAT ( DDMM OR STAT)



ENTER YES TO CONTI NUE ===> YES







Utilities Under ISPF
Chapter 2 Online Facilities 323
To exit the screen without activating the utility, press PF03/PF15.
M1: Issue a Job Order
This utility is used to issue manual job orders.
Although most job orders are requested by User Daily jobs that are automatically
submitted by CONTROL-M, it is sometimes necessary to issue a job order manually,
as in the following situations:
s to order a special purpose job
s to issue a job order for a different working date, for example
to reschedule a job run from the 1st of the next month to the 30th of this month
to reschedule the run of an entire scheduling table from the 4th of the month to
the 5th of the month because all job runs in the table must be performed again
Table 127 Prerequisite Condition Utility Screen Fields
Field Description
FUNCTION Function to be performed. Valid values are:
s ADD Add the specified condition to the IOA Conditions
file.
s CHECK Check if the specified condition exists in the IOA
Conditions file.
s DELETE Delete the specified condition from the IOA
Conditions file.
CONDITION
NAME
Name of the prerequisite condition (1 through 39 characters) to
be added, checked, or deleted. If CONDITION NAME values
contain the special characters ampersand (&) or apostrophe (),
they must be repeated in order to appear on the screen.
CONDITION
DATE
4-character date associated with the specified condition. Valid
values are:
s date Valid date in date in mmdd or ddmm format, depending
on the site standard.
s STAT Static. Value assigned to conditions that are not
date-dependent, such as DATABASE-OK.
ENTER YES TO
CONTINUE
Confirmation field to prevent the unintentional addition or
deletion of a condition. When blank, the operation is not
performed. Type YES to add, check or delete the condition.
Utilities Under ISPF
324 CONTROL-M for OS/390 and z/OS User Guide
The utility screen (Figure 101) is displayed in the following ways:
s Select option M1 on the Online Utilities menu.
s Activate CLIST CTMJOBRQ from the TSO Command Processor.
Figure 101 Job Request Utility Screen
To activate the utility, fill in the fields shown in Table 128 and press Enter:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - JOB REQUEST UTI LI TY - - - - - - - - - - - - - - - - - - - - - - - - - - -
COMMAND ===>



SCHEDULI NG LI BRARY ===> CTM. PROD. SCHEDULE

TABLE NAME ===>

JOB NAME ===> ( * f or al l j obs)

SCHEDULED RUN DATE ===> 06 06 01 ( ODATE - f or mat MM DD YY)

FORCED SCHEDULI NG ===> NO ( YES, NO)

ENTER YES TO CONTI NUE ===>

CALENDAR LI BRARY ===> I OA. PROD. CAL






Table 128 Parameters of the Job Request Utility Screen
Parameter Description
SCHEDULING
LIBRARY
Name of the scheduling library containing the table or jobs to
be scheduled.
TABLE NAME Name of the scheduling table (member).
JOB NAME Name of the job to be scheduled.
If you type an asterisk (*) in this field, all jobs in the specified
table are ordered.
SCHEDULED RUN
DATE
Original scheduling date of the job or jobs. The default is the
current working date.
Utilities Under ISPF
Chapter 2 Online Facilities 325
To exit the screen without activating the utility, press PF03/PF15.
M2: Perform an AutoEdit Simulation
This utility checks AutoEdit control statement syntax in jobs. It is essential that the
syntax of AutoEdit control statements be checked while the member is being
prepared. Otherwise, CONTROL-M may detect an AutoEdit syntax error during job
submission in the production environment and cancel the submission.
The utility can be initiated either online (through this screen) or by batch procedure
CTMAESIM. For more information, see Testing AutoEdit Syntax on page 782.
To activate the utility online, display the utility screen in either of the following ways:
s Select option M2 on the Online Utilities menu
s Activate CLIST CTMCAES from the TSO Command Processor
FORCED
SCHEDULING
Determines whether the specified job or jobs are forced.
Valid values are:
s Y (YES) Schedule the job (or jobs) even if the requested
date is not a scheduling date for the job according to its
basic scheduling parameters.
s N (NO) Schedule the job (or jobs) only if the requested
date satisfies the basic scheduling criteria of the job.
Note: Jobs in group scheduling tables must be forced. Merely
ordering them is not sufficient.
ENTER YES TO
CONTINUE
Confirmation field to help prevent the job (or jobs) from being
unintentionally run.
Valid values are:
s Y (Yes) The job will run.
s ' ' (Blank) The job will not run.
CALENDAR
LIBRARY
Name of the calendar library (if used) for scheduling the job or
jobs. If no calendar library name is specified, the utility uses
the calendar library or libraries that are allocated to the
DACAL DD name in the online environment.
Table 128 Parameters of the Job Request Utility Screen
Parameter Description
Utilities Under ISPF
326 CONTROL-M for OS/390 and z/OS User Guide
The CTMCAES utility can operate in either JCL library mode or scheduling library
mode:
s In JCL Library mode, the utility checks the AutoEdit statements in the jobs JCL.
s In scheduling library mode, the utility not only checks the AutoEdit statements in
the jobs JCL, it also checks the impact that SET VAR statements in the job
scheduling definition have on the jobs JCL.
This facility simulates the actions of the CONTROL-M submission mechanism and
produces a printed report of the process.
The output of the simulation process is a standard print file containing
s input control statements
s log messages of the submission process
s actual lines that are submitted under the same conditions
NOTE
Started tasks (STCs) are not supported in scheduling library mode.
NOTE
During AutoEdit simulation, some variables may not contain valid or expected
values. For example, %%$TAG is always blank and %%ORDERID is ZZZZZ.
Utilities Under ISPF
Chapter 2 Online Facilities 327
Figure 102 CONTROL-M AutoEdit Simulation Screen
The submission simulation utilizes control statements that are written to
DD statement DASIM. These control statements are based on the parameters
described below.
Depending on the mode in which the utility operates, either JCL library mode or
scheduling library mode parameters (but not both) must be specified. In addition,
General simulation parameters must also be specified.
To activate the utility, fill in the parameters and press Enter.
JCL Library Mode Parameters
- - - - - - - - - - - - - - - - - - - PERFORM CONTROL- M AUTOEDI T SI MULATI ON - - - - - - - - - - - - - - - - - - - -
COMMAND ===>

SPECI FY JCL LI BRARY OR SCHEDULE LI BRARY I NFORMATI ON

JCL LI BRARY MODE:
JCL LI BRARY ===> CTM. PROD. JCL
MEMBER NAME ===> BRCCI ND
OWNER ===> M21
APPLI CATI ON NAME ===>
GROUP NAME ===>
SCHEDULE TAG NAME ===>

SCHEDULI NG LI BRARY MODE:
SCHEDULI NG LI BRARY ===>
TABLE NAME ===>
JOB NAME ===>

PARAMETER LI BRARY ===> CTMP. PROD. PARM
WDATE ===> 06 06 01 ( DD MM YY)
ODATE ===> 06 06 01 ( DD MM YY)
FUNCTI ON ===> LI ST ( LI ST/ SUBSCAN/ SUBMI T)

Ent er YES t o cont i nue ===>
Table 129 JCL Library Mode Parameters
Parameter Description
JCL LIBRARY Name of the JCL library from which the required JCL is to be
submitted by the AutoEdit simulation.
MEMBER NAME Name of the JCL member to be submitted by the AutoEdit
simulation.
OWNER User ID of the jobs owner.
APPLICATION
NAME
Name of the application as specified in field APPL in the job
scheduling definition.
GROUP NAME Name of the group to which the job belongs.
Utilities Under ISPF
328 CONTROL-M for OS/390 and z/OS User Guide
Scheduling Library Mode Parameters
Table 130 Scheduling Library Mode Parameters
Parameter Description
SCHEDULING
LIBRARY
Name of the library containing the job scheduling definition.
TABLE NAME Name of the scheduling table containing the job scheduling
definition.
JOB NAME Name of the job scheduling definition.
NOTE
When specifying scheduling library mode parameters, values for owner, application
name, and the JCL library and member of the job are not specified because the utility
takes these values directly from the specified job scheduling definition.
The name of the JCL member is obtained from the OVERLIB parameter (if specified)
instead of the MEMLIB member.
Table 131 AutoEdit Simulation (Part 1 of 2)
Parameter Description
CONTROL-M
GLOBAL LIBRARY
Name of the library that contains the members referenced by
AutoEdit statement %%GLOBAL.
WDATE Working date of the job.
ODATE Original scheduling date of the job.
Utilities Under ISPF
Chapter 2 Online Facilities 329
To exit the screen without activating the utility, press PF03/PF15.
FUNCTION Function to be performed by the simulation. Valid values are:
s LIST The utility simulates submission of the member
from the designated library using the specified date and
user ID parameters. CONTROL-M checks the JCL. The
output is displayed on the terminal. The JCL is not actually
submitted.
s SUBMIT CONTROL-M attempts to resolve the AutoEdit
statements. If successful, the JCL member lines are also
written to the file referenced by the DASUBMIT
DD statement 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).
s SUBSCAN This function is similar to SUBMIT except that
it adds a TYPRUN=SCAN parameter to the job card before
performing simulation. As a result, the job is submitted
and the JCL is checked by MVS but the job is not executed.
Utilize this function also if a JCL-checking product (other than
JOB/ SCAN) 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.
s JOBSCAN This option is available at sites where the
JOB/ SCAN product is installed, but only if the utility is
activated from the Online Utilities menu. (This option is
not displayed and cannot be used if the utility is activated
by a CLIST or batch procedure.) This function is similar to
SUBMIT except that if CONTROL-M finds no JCL errors,
JCL is checked by JOB/ SCAN before it is written to the file
referenced by the DASUBMIT DD statement.
Enter YES to
continue
Confirmation field to help prevent the simulation jobs from
being unintentionally run. When blank, the jobs do not run.
Enter YES to enable the job run.
Table 131 AutoEdit Simulation (Part 2 of 2)
Parameter Description
Utilities Under ISPF
330 CONTROL-M for OS/390 and z/OS User Guide
M3: Prepare Simulation/Tape Pull List Job
This screen is used to activate the Simulation procedure or the Tape Pull List
procedure. The screen can be displayed in the following ways:
s Select option M3 from the Online Utilities menu
s Activate CLIST CTMCSIM from the TSO Command Processor
Figure 103 CONTROL-M Simulation and Forecasting Facility and Tape Pull List
The Simulation facility simulates the actions of the CONTROL-M monitor under the
conditions specified in the simulation parameters.
Online simulation is performed in the CPU without updating the simulation input
files, or without performing any other I/ O procedure.
The Tape Pull List procedure creates a list of all tapes to be mounted in a specified
period, taking into account the expected order of job execution and the order of
creation of tape data sets. The list can be sorted and edited in various ways.
This utility also provides the following benefits:
- - - - - - - CONTROL- M SI MULATI ON AND FORECASTI NG FACI LI TY AND TAPE PULL LI ST - - - - -
COMMAND ===>

RUN SI MULATI ON ===> Y ( Y- t o r un, N- ski p t o r epor t s)
Fr om ===> 200106030900 ( For mat YYYYMMDDhhmm)
Unt i l ===> 200106031600 ( For mat YYYYMMDDhhmm)
ON Today' s- cur r ent AJF ===> Y ( Y/ N I f " N" , f i l l i n t he dat e)
Anot her day - DATE ===> ( DD MM YY)
Cr eat e new AJF ===> N ( Y/ N)
Or der dai l y j obs ===> N ( Y/ N)
Keep out put AJF, RES ===> Y ( Y/ N)
Par amet er s member ===> SI MPARM ( Si mul at i on par amet er s)
REPORTS Jobs l ef t ===> Y ( Y/ N)
Ni ght schedul e ===> Y ( Y/ N)

TAPE PULL LI ST ===> N ( Y/ N)
Repor t by VOLSER ===> Y ( Y/ N)
Repor t by TI ME ===> Y ( Y/ N)
Repor t by JOBNAME ===> N ( Y/ N)
Repor t by DSN ===> N ( Y/ N)
Par amet er s member ===> TAPULPRM ( Tape pul l par amet er s)

Ent er YES t o cont i nue ===> YES or END key t o EXI T
NOTE
At sites supporting the JOB/ SCAN DOCU/ TEXT Interface, the lower portion of the
Simulation screen is modified to contain the INVOKE JOBSCAN parameters.
Utilities Under ISPF
Chapter 2 Online Facilities 331
s It checks the syntax of all AutoEdit statements in all jobs that are planned for the
given period.
s It checks the JCL syntax.
s It produces a list of data sets that are not available. These are usually input data
sets due to arrive, but they may indicate JCL errors. For more information, see the
discussion of CTMRNSC, the night schedule report, in the INCONTROL for OS/390
and z/OS Utilities Guide.
For more information about Simulation and Tape Pull List procedures, see Chapter 7,
Simulation and Forecasting Facility.
To activate this online utility, fill in the fields and sub-fields shown in Table 132, and
press Enter.
NOTE
For the Tape Pull List procedure to execute properly, authority must be granted for
the submission of jobs to the internal reader (INTRDR).
Table 132 Fields of the CONTROL-M Simulation and Forecasting and Tape Pull List
Screen (Part 1 of 5)
Field Description
RUN SIMULATION Fields:
RUN SIMULATION Whether to run the simulation. Valid values are:
s Y (Yes) Run the simulation. The results of the
simulation run are kept in the Log file and the
Active Jobs file (AJF) and can be used for
producing reports and/ or the tape pull list.
Default.
s N (No) Do not run the simulation. Use the
results of a prior simulation to produce reports
and/ or the tape pull list.
From Simulation start date and time, in the format
yyyymmddhhmm.
Until Simulation end date and time, in the format
yyyymmddhhmm.
Utilities Under ISPF
332 CONTROL-M for OS/390 and z/OS User Guide
ON Fields:
ON Todays-current AJF Whether to use Todays data (that is, the data
currently in the AJF) as input for the simulation.
Valid values are:
s Y (Yes) Use Todays data. If you choose this
option, BMC Software recommends that you run
the simulation after Todays jobs have been
placed on the AJF using New Day processing.
Default.
s N (No) Use data from the date specified in the
Another Day - DATE field.
Another day - DATE Date to use for scheduling or ordering simulation
jobs. The format is ddmmyy, mmddyy, or yymmdd,
depending on your site standard. A valid date must
be entered when not using Todays data (that is, if
N is entered in the Todays-current AJF field.)
Create new AJF Whether to allocate a new AJF to contain jobs for the
simulation. Valid values are:
s Y (Yes) Allocate a new AJF. This value must be
specified when not using the data currently in the
AJF, that is, if N is entered in the
Todays-current AJF field.
s N (No) Do not allocate a new AJF. This value
must be specified when using the data currently
in the AJF, that is, if Y is entered in the
Todays-current AJF field. Default.
Table 132 Fields of the CONTROL-M Simulation and Forecasting and Tape Pull List
Screen (Part 2 of 5)
Field Description
Utilities Under ISPF
Chapter 2 Online Facilities 333
Order daily jobs Whether to load into the new AJF all the jobs that are
scheduled to execute on the specified date. Valid
values are:
s Y (Yes) Load the jobs into the AJF. A User Daily
step is entered into the job. This step schedules all
the jobs based on their basic scheduling criteria. It
is the users responsibility to ensure that the Table
list for this job is up-to-date.
This value must be specified when not using
Todays data and when creating a new AJF, that
is, if N is entered in the Todays-current AJF field
and Y is entered in the Create new AJF field.
s N (No) Do not load the jobs into the AJF. This
value is generally specified when using todays
data or when not creating a new AJF (that is, if Y
is entered in the Todays-current AJF field or N is
entered in the Create new AJF field.) Default.
Keep output AJF,RES Specifies whether to save the output AJF, the IOA
Conditions file, and the CONTROL-M Resources file
(that is, the files as they appear at the end of the
simulation.) The output files must be kept if you plan
to produce reports, such as a Jobs Left report, based
on these files. Valid values are:
s Y (Yes) Keep the output files. Default.
s N (No) Do not keep the output files.
Parameters member Name of the member in the CTM PARM library that
contains the simulation parameters. This member
may contain parameters such as INTERVAL, ADD
COND, and so on.
Default: SIMPARM
REPORTS Fields:
Types of reports to be produced. Valid values for each report type are:
s Y the report type is generated
s N the report type is not generated
Note: This part of the panel is often site-modified. The following are the default
report types:
Table 132 Fields of the CONTROL-M Simulation and Forecasting and Tape Pull List
Screen (Part 3 of 5)
Field Description
Utilities Under ISPF
334 CONTROL-M for OS/390 and z/OS User Guide
Jobs left This report lists the jobs that did not end OK by the
end of the simulation (jobs in status WAIT
SCHEDULE, EXECUTING, ENDED NOTOK, and so
on). This report is identical to KeyStroke Sample
report REPJOBMO in the IOA.KSL library. Default: Y
Night schedule This report provides a job execution time summary.
For more information, see the discussion of
CTMRNSC, the night schedule report, in the
INCONTROL for OS/390 and z/OS Utilities Guide.
Default: Y
TAPE PULL LIST Fields:
TAPE PULL LIST Specifies whether to run the Tape Pull List procedure.
The accompanying Report by fields specify
whether to generate individual Tape Pull reports.
Valid values for this field and the accompanying
Report by fields are:
s Y (Yes) Generate the report.
s N (No) Do not generate the report
Report by VOLSER This report is sorted by volume serial number (this
includes all tapes from the tape library). Default: Y
Report by TIME This report is sorted by the expected mount time.
Default: Y
Report by JOBNAME This report is sorted by job name. Default: N
Report by DSN This report is sorted by data set name. Default: N.
Parameters member Name of the member in the CTM PARM library that
contains the Tape Pull parameters. This member may
contain parameters such as REPBYVOL,
REPBYTIME, or REPBYJOB. Default: TAPULPRM
INVOKE JOBSCAN Fields:
INVOKE JOBSCAN These parameters apply only if the
JOB/ SCAN-DOCU/ TEXT Interface is installed at
your site. Valid values for the accompanying fields
are Y (Yes) or N (No). Only one Y value can be
entered.
s Y (Yes) JOBSCAN is invoked, the check is
performed, and the appropriate report is
displayed in the utility output.
s N (No) The specified check is ignored.
Table 132 Fields of the CONTROL-M Simulation and Forecasting and Tape Pull List
Screen (Part 4 of 5)
Field Description
Utilities Under ISPF
Chapter 2 Online Facilities 335
To exit the screen without activating either facility, press PF03/PF15.
M4: Parameter Prompting Facilities
CONTROL-M Parameter Prompting facilities provide an automatic online interface
for assigning values to AutoEdit parameters in the JCL. These facilities prompt the
user for values requiring manual modification.
These facilities eliminate the need to remember which AutoEdit parameters require
assignment each day, the location of AutoEdit members, and the manual conditions
that need to be added (Screen 7).
To display the Parameter Prompting entry panel (below), select option M4 on the
Online Utilities menu.
JCL Checking If Y is entered
s checks the JCL specified in the member
referenced by the DAJCLOUT DD statement for
errors
and
s checks for adequate DASD disk space allocation.
Errors Only If Y is entered, checks for JCL errors only.
Space Report If Y is entered, checks for adequate DASD disk space
allocation only.
Enter YES to continue Field:
Enter YES to continue When set to blank, the jobs are not generated. This
prevents the simulation or tape pull list jobs from
being unintentionally generated.
Type YES to enable the job run. The file of the
simulation job as tailored to your specifications is
displayed in ISPF EDIT. You can submit it, save it for
future use, and so on.
Default: YES
Table 132 Fields of the CONTROL-M Simulation and Forecasting and Tape Pull List
Screen (Part 5 of 5)
Field Description
Utilities Under ISPF
336 CONTROL-M for OS/390 and z/OS User Guide
Figure 104 Parameters Prompting Entry Panel
Two different prompting facilities are available:
s Parameter Prompting facility TYPE 1
s Parameter Prompting facility TYPE 2
Using these facilities requires a basic understanding of JCL, the AutoEdit facility, and
the concept of prerequisite conditions.
An brief introduction to each of these two types of facilities is presented before the
description of the screens in that facility.
Introduction to Parameter Prompting Facility - Type 1
The Parameter Prompting facility Type 1 is an ISPF table based facility that provides
automatic prompting for AutoEdit parameter values and setting of prerequisite
conditions.
- - - - - - - - - - - - - - - - - - - CONTROL- M PARAMETER PROMPTI NG - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OPTI ON ===>
USERI D - M14
TI ME - 21: 05
TERMI NAL - 3278


1 CTMCFMNU - Par amet er Pr ompt i ng Faci l i t y - TYPE 1

2 CTMCAMNU - Par amet er Pr ompt i ng Faci l i t y - TYPE 2





X EXI T - Ter mi nat e t hi s menu








NOTE
For a much more detailed explanation of how the Parameter Prompting facilities
work, how they differ from each other, and how to choose the facility that best suits
your operational needs, see the discussion of that topic in Parameter Prompting
Facilities on page 816.
Utilities Under ISPF
Chapter 2 Online Facilities 337
This facility is the recommended method for updating AutoEdit parameter members
when the parameter value requires manual specification or modification. Frequently,
such parameters are associated with prerequisite conditions that must also be
manually added to the IOA Conditions file (from the Manual Conditions file).
Example
Tape ABC, which is required by a particular job, arrives from an external location.
The volume serial number must specified in the AutoEdit parameter
%%ABC_TAPENO, and the condition TAPE_ABC_ARRIVED must be added to
the IOA Conditions file, before the job can run.
Without this facility, the user (generally operations personnel) must access the
appropriate AutoEdit member and update the parameter value, and must enter the
Manual Conditions screen to manually add the required condition to the IOA
Conditions file.
With this facility, the user is prompted for the required value. The facility
automatically updates the AutoEdit member and adds the related condition to the
IOA Conditions file.
Parameter Prompting facility Type 1 works basically as follows:
1. Using the first option of the facility (DEFINE PARAMETERS AND CREATE A
NEW MASTER TABLE), groups of AutoEdit parameters that require value
assignment are defined once. These parameters are grouped into a Master
Prompting table, the Master table. Default parameter values can be assigned. In
addition, prerequisite conditions to be associated with parameters are designated.
The administration of the parameter prompting facility can be decentralized by
user groups or applications by choosing a unique CONTROL-M Prompt library on
the Primary menu for each application. Master tables defined in a specific Prompt
library will be available for update (in option 2) only when that Prompt library is
coded on the primary menu. This permits different applications to be concerned
only with the master tables associated with that application without
cross-interference with other user groups or applications. This design also
simplifies security issues.
2. During daily processing, specification of values is made using option 2 (UPDATE
PARAMETERS AND SET CONDITIONS). The user selects the desired table from
the list of Master tables and is presented with Daily Prompting table - an
automatically created copy of the Master table for the current date.
The Daily Prompting table consists of parameter names, (optional) descriptions,
and default values. The user updates the desired parameters with the appropriate
values.
The facility automatically adds the appropriate conditions to the IOA Conditions
file and updates the daily AutoEdit member with the specified values.
Utilities Under ISPF
338 CONTROL-M for OS/390 and z/OS User Guide
Screens of the Parameter Prompting Facility (Type 1)
After selecting option 1 of the CONTROL-M Parameter Prompting entry panel, the
screen shown in Figure 105 is displayed:
Figure 105 Parameter Prompting Facility (Type 1) Primary Menu
This screen displays the following options:
1. Define Parameters and Create a New Master Table
This option defines groups of parameters. The definition and association with any
prerequisite condition is performed only once per parameter.
2. Update Parameters and Set Conditions
This option is accessed daily (or multiple times in one day) to assign values to
parameters and set prerequisite conditions.
The IOA Core Prefix used at your site appears as a default. Files with this prefix are
accessed by the Parameter Prompting facility to add prerequisite conditions. Usually,
there is no need to change the value of this field.
- - - - CONTROL- M - PARAMETER PROMPTI NG FACI LI TY ( TYPE 1) PRI MARY MENU - - - - - - - - ( P)
OPTI ON ===>


1 DEFI NE PARAMETERS AND CREATE A NEWMASTER TABLE


2 UPDATE PARAMETERS, SET CONDI TI ONS AND DELETE TABLES


OPTI ONS:
PARAMETER DESCRI PTI ON WI LL BE DI SPLAYED ===> NO ( YES/ NO)

I OA CORE PREFI X ===> I OA. PROD

CONTROL- M PROMPT LI B ===> CTM. PROD. PROMPT

CONFI RM PARAMETER UPDATE ACTI ONS ===> YES ( YES/ NO)

ENTER END COMMAND OR PF3 TO TERMI NATE




NOTE
You can enter this screen directly by activating CLIST CTMCFMNU.
Utilities Under ISPF
Chapter 2 Online Facilities 339
The library in which the CONTROL-M prompting tables will be placed appears as a
default, and can be changed. The ability to decentralize the administration of the
parameter prompting facility by using different CONTROL-M prompting libraries is
discussed in Introduction to Parameter Prompting Facility - Type 1 on page 336.
The Confirm Parameters Update Actions field determines whether a confirmation
window is displayed following update requests in the Update Parameters and Set
Conditions screen, which is described in Option 2: Update Parameters and Set
Conditions on page 344.
Option 1: Define Parameters and Create a New Master Table
After selecting option 1 of the Parameter Prompting facility (Type 1) Primary menu,
the screen shown in Figure 106 is displayed:
Figure 106 Define Parameters and Condition - New Master Table Screen
Fill in a Table Name Prefix (a maximum of three characters) and press Enter.
A Master table is usually defined for a group of AutoEdit parameters controlled by
one person or project.
- - - - CONTROL- M - P. P. F. - DEFI NE PARAMETERS AND CONDI TI ONS - - - - - - - - - - - - - - - ( P. 1)
COMMAND ===>


TABLE NAME PREFI X ===>







Pl ease f i l l i n t he TABLE NAME PREFI X and pr ess ENTER


ENTER END COMMAND OR PF3 TO TERMI NATE








Utilities Under ISPF
340 CONTROL-M for OS/390 and z/OS User Guide
If the table does not exist (because you are attempting to define a new table), the
screen shown in Figure 107 is displayed:
Figure 107 Define Parameters/ and Conditions - Master Table Definition Screen
You can create a new table or exit the screen. To create a new table, enter a table
description and press Enter.
- - - - CONTROL- M - P. P. F. - MASTER TABLE DEFI NI TI ON - - - - - - - - - - - - - - - - - - - - - - ( P. 1. 2)
COMMAND ===>
CTMB14E MASTER TABLE TAPTMSTR WAS NOT FOUND. YOU MAY CREATE I T, OR EXI T

TABLE NAME PREFI X ===> TAP

DESCRI PTI ON ===> EXTERNAL TAPE DATA



Pl ease f i l l i n t he Tabl e Descr i pt i on and pr ess ENTER


ENTER END COMMAND OR PF3 TO TERMI NATE










Utilities Under ISPF
Chapter 2 Online Facilities 341
Define Parameters and Conditions Screen
After creation of a new table, or if the table exists, the following screen is displayed. If
the table exists, the previously defined parameters and associated conditions are
displayed for modification.
Figure 108 Define Parameters and Conditions Screen
This screen is used to define, display and modify parameters and optional
prerequisite conditions that are used for prompting on a daily basis.
Specifying Retrieval Criteria
The display of parameters can be limited to parameters beginning with a specific
prefix by filling in the PARM PREFIX field.
To display the first occurrence of a parameter at the top of a screen, use the line
command L xxxx, where xxxx is a specific parameter or parameter prefix.
Define Parameters and Conditions Screen Format
The following information can be defined, displayed, or modified for each parameter:
- - - - CONTROL- M - P. P. F - DEFI NE PARAMETERS AND CONDI TI ONS - - - - - - - ROW1 OF
COMMAND ===> SCROLL ===> PAGE
PARM PREFI X ===> TABLE NAME : TAPTMSTR
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PARM ===> I RS_TAPE
VALUE ===>
DESC. ===> WEEKLY TAPE FROM I RS
CONDI TI ON => I RS- TAPE- ARRI VED
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PARM ===> A_BANK_TAPE
VALUE ===> XXXX
DESC. ===> TAPE FROM BANK GROUP A
CONDI TI ON => MN- A- BANK- TAPE- READY
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *










Utilities Under ISPF
342 CONTROL-M for OS/390 and z/OS User Guide
Define Parameters and Conditions Screen Options
To request one of the following options, type the option in the field to the left of the
word PARM and press Enter.
Changes made to a parameter are updated in the plan when you press Enter, even if
no option is specified.
Define Parameters and Conditions Screen How to Exit
To exit the Define Parameters and Conditions screen, press END (PF03/PF15).
If additions or modifications have been made, the Save window shown in Figure 109
is displayed:
Table 133 Define Parameters and Conditions Screen Format
Format Description
PARM Name of the AutoEdit parameter.
CONDITION Name of a prerequisite condition to be added to the IOA
Conditions file when this parameter is updated. Optional.
VALUE A default parameter value. Optional.
DESC A meaningful description of the parameter.
Table 134 Define Parameters and Conditions Screen Options
Option Description
DELETE Delete a parameter from the table.
REPEAT Duplicate a parameter.
ADD Add a parameter (same as option R).
INSERT Insert a new parameter in the table. INSERT typed on the
Command line inserts a new parameter at the top of the table.
Utilities Under ISPF
Chapter 2 Online Facilities 343
Figure 109 Define Parameters and Conditions Save Screen Window
Type Y (Yes) to save the changes.
Type N (No) to cancel the changes.
- - - - CONTROL- M - P. P. F. - DEFI NE PARAMETERS AND CONDI TI ONS - - - - - - - - - - - - - - - - - - - -
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| PLEASE SELECT EXI T OPTI ON |
| |
| SAVE ( Y/ N) |
| |
| LI BRARY CTM. PROD. PROMPT |
| TABLE TAP |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +














Utilities Under ISPF
344 CONTROL-M for OS/390 and z/OS User Guide
Option 2: Update Parameters and Set Conditions
After selecting option 2 of the Parameter Prompting facility (Type 1) Primary menu,
the Table Selection screen is displayed.
Figure 110 Update Parameters and Set conditions - Table Selection Screen
This screen displays a list of Daily Prompting tables available for update. A Daily
table is a copy of a Master Table specific to a particular business day. It is accessed in
order to assign values to (previously defined) parameters and to set conditions. The
Daily table can be accessed multiple times on the same day.
When you enter this screen, the current date is displayed for each Daily Table. You
can overwrite the date to select a different date.
Table deletion can be performed from this screen by typing option D (Delete) in the
selection field to the left of TABLE NAME and pressing Enter. A Delete Confirmation
window is displayed.
- - - - CONTROL- M - P. P. F. - TABLE SELECTI ON - - - - - - - - - - - - - - - - - - - - - - - - - Row 1 of 3
COMMAND ===> SCROLL ===> PAGE
TABLE PREFI X ===>
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ TABLE NAME ===> BAK DATE ===> 06 / 06
LI BRARY : CTM. PROD. PROMPT
DESCRI PTI ON: BACKUP CRI TERI A
_ TABLE NAME ===> REP DATE ===> 06 / 06
LI BRARY : CTM. PROD. PROMPT
DESCRI PTI ON: REPORTI NG CRI TERI A
_ TABLE NAME ===> TAP DATE ===> 06 / 06
LI BRARY : CTM. PROD. PROMPT
DESCRI PTI ON: EXTERNAL TAPE DATA
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *










Utilities Under ISPF
Chapter 2 Online Facilities 345
Figure 111 Table Selection Screen Delete Confirmation Window
The Delete Confirmation window also enables you to choose the type of deletion
desired.
Type Y (Yes) to confirm the deletion. When deletion is requested, then by default the
table is deleted from the Table list, and both the Master Prompting table and the
current Daily table are deleted from the Prompting library.
To delete the current daily table without deleting the table from the Table list and
without deleting the Master Prompting table from the Prompting library, type Y in
the DELETE DAILY TABLE ONLY field. In this case, only the current daily table and
the corresponding daily AutoEdit member are deleted. The setting of the DELETE
DAILY TABLE ONLY field is preserved in a profile variable for ease of subsequent use.
This is useful if the Master Prompting table has been updated. To reflect those
changes in the Daily table and the AutoEdit member, the current Daily table must be
deleted, and then be reselected again.
To select a table for any action other than deletion, enter any character except D in the
selection field to the left of TABLE NAME and press Enter.
The display of tables can be limited to those tables beginning with a prefix of 1
through 3 characters by filling in the TABLE PREFIX field. The TABLE PREFIX is
retained as an ISPF profile variable from one invocation of the Table Selection screen
to the next.
To display the first occurrence of a table at the top of the screen, use the line
command L xxxx, where xxxx is a specific parameter or parameter prefix (under the
command line).
- - - - CONTROL- M - P. P. F. - TABLE SELECTI ON - - - - - - - - - - - - - - - - - - - - - - - - - Row 1 of 3
COMMAND ===> SCROLL ===> PAGE
TABLE PREFI X ===> +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
- - - - - - - - - - - - - - - - - - - - - - - | CONFI RM DELETE OPTI ON | - - - -
D TABLE NAME ===> BAK | <<=== < N > ( Y/ N) |
LI BRARY | |
DESCRI PTI O | DELETE DAI LY PROMPT TABLE ONLY ===> N ( Y/ N) |
_ TABLE NAME ===> REP +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
LI BRARY : CTM. PROD. PROMPT
DESCRI PTI ON: REPORTI NG CRI TERI A
_ TABLE NAME ===> TAP DATE ===> 06 / 06
LI BRARY : CTM. PROD. PROMPT
DESCRI PTI ON: EXTERNAL TAPE DATA
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *










Utilities Under ISPF
346 CONTROL-M for OS/390 and z/OS User Guide
Update Parameters and Set Conditions Screen
After table selection, the screen shown in Figure 112 is displayed:
Figure 112 Update Parameters and Set Conditions Screen
This screen displays a list of all AutoEdit parameters for which values can be
updated. The following information is presented for each parameter:
The display of parameters can be limited to parameters beginning with a specific
prefix by filling in the PARM PREFIX field (under the command line).
To display the first occurrence of a parameter at the top of a screen, use the line
command L parm, where parm is a specific parameter or parameter prefix.
- - - - CONTROL- M - P. P. F. - UPDATE PARAMETERS AND SET CONDI TI ONS - - - Row 1 of 2
COMMAND ===> SCROLL ===> PAGE
PARM PREFI X ===> TAPT1112 UPDATED ON
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ VALUE ===>
OF ===> I RS- TAPE
WEEKLY TAPE FROM I RS
_ VALUE ===> XXXX
OF ===> A- BANK- TAPE 06 06
TAPE FROM BANK GROUP A
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *














Table 135 Fields of the Update Parameters and Set Conditions Screen
Field Description
VALUE Default value of the parameter. This value can be modified.
OF Parameter name.
Description This description appears only if the value YES was entered in the
PARAMETER DESCRIPTION WILL BE DISPLAYED field on the
Parameter Prompting facility (Type 1) Primary menu.
Date Updated The date of update is displayed in either mm dd or dd mm format
depending on the site standard.
Utilities Under ISPF
Chapter 2 Online Facilities 347
From this screen, conditions can be added to the IOA Conditions file, with or without
changing the value of the parameter.
s To add the condition without changing the parameter value, enter any character in
the selection field to the left of the VALUE field.
s To update a parameter value and add the condition, update the value as desired
and press Enter.
If Y (Yes) was entered for the Confirm Parameter Update Actions option in the
Type 1 Primary menu, the following confirmation window is displayed. Type Y to
confirm the updates (or N to cancel them).
Figure 113 Update Parameters and Set Conditions - Confirm Parameter Update
Actions
After an update request is completed in the screen, all changes are immediately saved
in the Daily table. Any manual condition associated with this parameter prompt is
added to the IOA Conditions file.
Press END (PF03/PF15) to exit the screen.
Introduction to Parameter Prompting Facility - Type 2
The Parameter Prompting facility Type 2 provides automatic prompting for
AutoEdit parameter values for manually scheduled jobs. This may be very useful in a
distributed environment where user departments are responsible for manually
ordering jobs and specifying required parameters.
- - - - CONTROL- M - P. P. F. - UPDATE PARAMETERS AND SET CONDI TI ONS - - - Row 1 f r om 2
COMMAND ===> SCROLL ===> PAGE
PARM PREFI X ===> TAPT1112 UPDATED ON
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ VALUE ===>
OF ===> I RS- TAPE +- - - - - - - - - - - - - - - - - - - - - - - - +
WEEKLY TAPE FRO | CONFI RM UPDATE ACTI ON |
_ VALUE ===> XXXX | <<=== < N > ( Y/ N) |
OF ===> A- BANK- TAPE +- - - - - - - - - - - - - - - - - - - - - - - - +
TAPE FROM BANK GROUP A
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *













Utilities Under ISPF
348 CONTROL-M for OS/390 and z/OS User Guide
On any given day, the user selects scheduling tables for execution. The user is then
prompted for parameter values required for the execution of those jobs.
The Parameter Prompting facility Type 2 works as follows:
s First, relevant scheduling tables are defined or placed in the Master Scheduling
Tables library.
Then, using the CREATE AND UPDATE A MASTER PLAN option of the facility,
the user defines a Master Prompting Plan (MPP) for each scheduling table in the
library. The MMP is placed in the Master Prompting Plan library. It contains all
AutoEdit variables used by all jobs in the scheduling table. Default values and
value validity checks can also be defined.
Once all definitions are complete, the facility is ready for use on any given day, as
needed.
s The user uses the second option of the facility, FETCH A PLAN, to select a plan for
execution by CONTROL-M on any specific day.
When a FETCH option is executed for a specific plan (or set of plans), a Daily
scheduling table is automatically created and placed in the Daily Scheduling
Tables library. The Daily Scheduling table is a subset of the Master Scheduling
table, and contains the job scheduling definition of each job in the Master
Scheduling table scheduled that day.
The FETCH also creates a User Prompting Plan (UPP), which is placed in the
Daily Prompting Plan library. The UPP is a subset of the Master Prompting
Plan, and contains only parameters that are required by the jobs scheduled to
run on that day.
A Daily JCL library is also created containing JCL for the days jobs.
s Using the third option of the facility, EXEC A PLAN, the user may then accept or
update the default values of all the parameters appearing in the daily UPP.
A daily AutoEdit parameters member, which is accessed at the time of job
submission, is automatically created and placed in the Daily AutoEdit Parameter
library.
Utilities Under ISPF
Chapter 2 Online Facilities 349
Screens of Parameter Prompting Facility (Type 2)
After selecting option 2 of the CONTROL-M Parameter Prompting entry panel, the
following menu is displayed:
Figure 114 Parameter Prompting Facility (Type 2) Primary Menu
This screen displays three options:
1. CREATE AND UPDATE A MASTER PLAN
This option defines groups of parameters in a Master Prompting Plan.
2. FETCH A PLAN (CTMFETCH)
This option places a User Prompting Plan (a copy of the Master Prompting Plan)
and related job scheduling definitions in Daily libraries. A fetch is required
before assigning parameter values and ordering plan execution with Option 3.
3. EXEC A PLAN (CTMEXEC)
This option assigns values to parameters and orders a Plan for execution.
- - - - CONTROL- M - PARAMETER PROMPTI NG FACI LI TY ( TYPE 2) PRI MARY MENU - - - - - - - - ( P)
OPTI ON ===>


1 CREATE AND UPDATE A MASTER PLAN


2 FETCH A PLAN ( CTMFETCH)


3 EXEC A PLAN ( CTMEXEC)



ENTER END COMMAND OR PF3 TO TERMI NATE









NOTE
You can enter this screen directly by activating CLIST CTMCAMNU.
Utilities Under ISPF
350 CONTROL-M for OS/390 and z/OS User Guide
Option 1: Create and Update a Master Plan
After selecting Option 1 of the Parameter Prompting facility (Type 2) Primary menu,
the following screen is displayed:
Figure 115 Primary Prompting Facility Define or Update a Master Plan
A Master Plan is usually defined for a group of jobs and their AutoEdit parameters
that are controlled by one person or project.
Type a maximum of six characters in PLAN NAME PREFIX and press Enter.
The name of the default library in which the Master Plan is placed is displayed. It
may be changed.
If the plan does not exist (because you are defining a new plan), the following screen
is displayed:
- - - - CONTROL- M - P. P. F. - DEFI NE OR UPDATE A MASTER PLAN - - - - - - - - - - - - - - - - - ( P. 1)
COMMAND ===>

PLAN NAME I S:

PLAN NAME PREFI X ===> REPTS


LI BRARY ===> CTM. PROD. PLANMSTR



Pl ease f i l l i n t he Pl an Name Pr ef i x and pr ess ENTER


ENTER END COMMAND OR PF3 TO TERMI NATE








Utilities Under ISPF
Chapter 2 Online Facilities 351
Figure 116 Parameter Prompting Facility Master Plan Definition
You can create a new plan or exit the screen. To create a new plan, enter a plan
description and press Enter.
- - - - CONTROL- M - P. P. F. - MASTER PLAN DEFI NI TI ON - - - - - - - - - - - - - - - - - - - - - - - ( P. 1. 2)
COMMAND ===>
CTMB14E MASTER PLAN REPTS NOT FOUND. YOU MAY CREATE I T, OR EXI T

PLAN PREFI X NAME ===> REPTS

DESCRI PTI ON ===> DAI LY REPORTS

LI BRARY ===> CTM. PROD. PLANMSTR


Pl ease f i l l i n t he Pl an Descr i pt i on and pr ess ENTER


ENTER END COMMAND OR PF3 TO TERMI NATE







Utilities Under ISPF
352 CONTROL-M for OS/390 and z/OS User Guide
Define Parameters in the Master Plan
After creation of a new plan, or if the requested plan exists, the following screen is
displayed. If the plan exists, the previously defined parameters are displayed for
modification.
Figure 117 Define Parameters in the Master Plan Screen
This screen is used to define, display and modify parameters that are used for
prompting on a daily basis.
Define Parameters in the Master Plan Screen Format
The following information can be defined, displayed, or modified for each parameter:
- - - - CONTROL- M - P. P. F. - DEFI NE PARAMETERS I N THE MASTER PLAN - - - ROW1 OF 3
COMMAND ===> SCROLL ===> CSR
PARM PREFI X ===> PLAN NAME: REPTS
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PARM NAME ===> REPT_NAME OCCUR NO. ===> 01
JOB NAME ===> SLSREPTS PROMPT I ND ===> Y ( Y/ N)
DEFAULT ===>
TYPE ===> NONBLANK, MAXL 8
MESSAGE ===> Ent er name of sal es r epor t r equi r ed
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PARM NAME ===> DEPT_NUMBER OCCUR NO. ===>
JOB NAME ===> * * * * * * * * PROMPT I ND ===> Y ( Y/ N)
DEFAULT ===> 035
TYPE ===> NUM, MAXL 3
MESSAGE ===> Ent er depar t ment number ( used f or al l r epor t s)
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PARM NAME ===> REPT_NAME OCCUR NO. ===> 02
JOB NAME ===> EXPREPTS PROMPT I ND ===> Y ( Y/ N)
DEFAULT ===>
TYPE ===> NONBLANK, MAXL 8
MESSAGE ===> Ent er name of expense r epor t r equi r ed
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *


Table 136 Fields of the Define Parameters in the Master Plan Screen (Part 1 of 3)
Field Description
PARM NAME Name of the AutoEdit parameter.
OCCUR NO. Occurrence number (2 digits). Differentiates between use of
the same parameter name for different purposes in different
jobs (for example, assign OCCUR NO. 01 to occurrence of
%%PARM1 in Job A; assign OCCUR NO. 02 to occurrence of
%%PARM1 in Job B).
Utilities Under ISPF
Chapter 2 Online Facilities 353
JOB NAME Name of the job using the parameter.
If the parameter and its assigned value are shared by more
than one job in the plan, enter ******** in this field. It is not
necessary to redefine the parameter. (If the value assigned is
different for each job, refer to the OCCUR NO. parameter
above.)
PROMPT IND Prompting Indicator:
s Y (Yes) Promptable. The user is prompted for a value for
this parameter.
s N (No) Non-promptable. The value is fixed in the Master
Prompting Plan and is not modifiable in the EXEC phase.
DEFAULT Default value for the parameter that is displayed during the
EXEC phase.
This field is mandatory if PROMPT IND is set to N
(non-promptable).
BLANK Type the word BLANK to set a value of .
Table 136 Fields of the Define Parameters in the Master Plan Screen (Part 2 of 3)
Field Description
Utilities Under ISPF
354 CONTROL-M for OS/390 and z/OS User Guide
The display of parameters can be limited to parameters beginning with a specific
prefix by filling in the PARM PREFIX field (under the command line).
To display the first occurrence of a parameter at the top of a screen, use the line
command L xxxx, where xxxx is a specific parameter or parameter prefix.
Define Parameters in the Master Plan Screen Options
To request one of the following options, type the option in the field to the left of the
words PARM NAME and press Enter.
TYPE Type of parameter value that can be entered. A validation
check is performed during both the plan definition and EXEC
phases.
Valid types:
s NUM Limits the value to digits only (0 through 9).
s ALPHA Limits the value to letters only (a-z, A-Z, and
$,#,@).
s CHAR Alphanumeric.
s BLANK Field must be blank.
s NONBLANK Any non-blank value.
s MINL n Limits the value to a specified minimum
character length, where n is any number from 1 through
70.
s MAXL n Limits the value to a specified maximum
character length, where n is any number between 1 and 70.
MINL, MAXL, and NONBLANK can be combined with NUM
or ALPHA.
Example: NUM MAXL 8 limits the parameter value to a
numeric value with a maximum length of 8 characters.
MESSAGE Prompting message to be displayed during the EXEC phase.
Table 136 Fields of the Define Parameters in the Master Plan Screen (Part 3 of 3)
Field Description
Utilities Under ISPF
Chapter 2 Online Facilities 355
Changes made to a parameter are updated in the plan when you press Enter, even if
no option is specified.)
Define Parameters in the Master Plan Screen How to Exit
To exit the Define Parameters in the Master Plan screen, type one of the following
commands on the command line:
Table 137 Options of the Define Parameters in the Master Plan Screen
Option Description
D (DELETE) Delete a parameter from the plan.
R (REPEAT) Duplicate a parameter.
A (ADD) Add a parameter (same as option R).
I (INSERT) Insert a new parameter in the plan. INSERT typed on the
Command line inserts a new parameter at the top of the plan.
Table 138 Define Parameters in the Master Plan Screen - Exit Screen Commands
Command Description
END Keep all plan changes, and exit.
CANCEL Exit without saving plan changes.
Utilities Under ISPF
356 CONTROL-M for OS/390 and z/OS User Guide
Option 2: Fetch a Plan (CTMFETCH)
After selecting option 2 of the Parameter Prompting facility (Type 2) Primary menu,
the following screen is displayed:
Figure 118 Fetch a Plan Screen
This screen places a daily User Prompting Plan (a copy of the Master Prompting Plan)
and related job scheduling definitions in Daily libraries. Fill in the details in the
screen (libraries and the current date appear as defaults) and press Enter.
The PLAN NAME is the same as the Master Prompting Plan PREFIX.
You can designate two characters to serve as a suffix to the Plan Name. This permits
execution of a specific plan more than once a day.
Valid values for OVERRIDE DAILY PLAN:
- - - - CONTROL- M - P. P. F. - - - - - - FETCH A PLAN - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( P. 2)
COMMAND ===>

PLAN NAME ===> REPTS

PLAN NAME SUFFI X ===> ( For mul t i pl e pl ans i n t he same day)

OVERRI DE DAI LY PLAN ===> NO ( YES / NO)

ODATE ===> 080800


Pl ease f i l l i n t he Pl an Name and pr ess ENTER


MASTER SCHEDULI NG LI B ===> CTM. PROD. SCHEDULE
DAI LY SCHEDULI NG LI B ===> CTM. PROD. SCHD
MASTER PLANS LI B ===> CTM. PROD. PLANMSTR
DAI LY PROMPT PLANS LI B ===> CTM. PROD. PLAN
MASTER JCL LI B ===> CTM. PROD. JCLPROMP
DAI LY JCL LI B ===> CTM. PROD. JCLP

ENTER END COMMAND OR PF3 TO TERMI NATE

Table 139 Fetch Plan Screen OVERRIDE DAILY PLAN Values
Value Description
YES A duplicate fetch of a plan (with a suffix, if one has been
designated) replaces an existing copy of a plan with the same
PLAN NAME (and same suffix) for that day.
NO Multiple fetches of a plan are not permitted on the same day.
Default.
Utilities Under ISPF
Chapter 2 Online Facilities 357
Option 3: Exec / Order a Plan (CTMEXEC)
After selecting option 3 of the Parameter Prompting facility (Type 2) Primary menu,
the following screen is displayed:
Figure 119 Exec/Order a Plan (CTMEXEC) Screen
This screen orders a plan for parameter updating and plan execution. Fill in the
details in the screen (libraries and the current date appear as defaults) and press
Enter.
The PLAN NAME is the same as the Master Prompting Plan PREFIX. You can
designate two characters to serve as a suffix to the PLAN NAME. This permits
execution of a specific plan more than once a day.
The REMAINING PARAMETERS field determines whether you are automatically
prompted in the Update Parameter Values screen for parameter values that have yet
to be updated for active plans. Valid values are:
s YES Prompt
s NO Do not prompt
The ODATE field specifies the original scheduling date for executing the plan.
The FORCED FROM TIME field specifies a time (format hhmm) before which the jobs
cannot run.
If you leave PLAN NAME blank on the Exec / Order a Plan screen, the Plan Selection
screen is displayed:
- - - - CONTROL- M - P. P. F. - - - - EXEC / ORDER A PLAN - - - - - - - - - - - - - - - - - - - - - - - - - ( P. 3)
COMMAND ===>

PLAN NAME ===> REPTS ( Bl ank f or pl an sel ect i on l i st )

PLAN NAME SUFFI X ===> ( For mul t i pl e pl ans i n t he same day)

REMAI NI NG PARAMETERS ===> NO ( YES / NO)

ODATE ===> 080800

FORCED FROM TI ME ===>


Pl ease f i l l i n t he Pl an Name ( or bl anks) and pr ess ENTER


DAI LY SCHEDULI NG LI B ===> CTM. PROD. SCHD
USER PROMPT PLANS LI B ===> CTM. PROD. PLAN
DAI LY PARAMETERS LI B ===> CTM. PROD. AEDI


ENTER END COMMAND OR PF3 TO TERMI NATE
Utilities Under ISPF
358 CONTROL-M for OS/390 and z/OS User Guide
Figure 120 Plan Selection Screen
This screen displays a list of active Daily Plans.
PLAN ORDERED ALREADY: indicates whether the plan was already ordered. If the
plan has already been ordered, it is possible to select a plan for parameter value
updating only.
To select a plan, enter any character in the field to the left of the PLAN NAME.
- - - - CONTROL- M - P. P. F. - PLAN SELECTI ON - - - - - - - - - - - - - - - - - - - - - - - - - Row 1 FROM 2
COMMAND ===> SCROLL ===> PAGE
PLAN PREFI X ===> PLAN ORDERED ALREADY:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PLAN NAME ===> REPTS ===> NO
ORDER TI ME :
_ PLAN NAME ===> BACKUP ===> YES
ORDER TI ME :
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *














Utilities Under ISPF
Chapter 2 Online Facilities 359
Update Parameter Values Screen
After selecting a plan from the Plan Selection screen or specifying a particular plan on
the Exec / Order a Plan screen, the Update Parameter Values screen is displayed:
Figure 121 Update Parameters Values Screen
This screen displays a list of all AutoEdit parameters for which values can be entered.
Press END (PF03/PF15) to exit the screen.
The Master Prompting Plan for the PLAN NAME is copied from the Master
Prompting Library to the Daily Prompting Library to create or replace the
corresponding User Prompting Plan (UPP). Only parameters that belong to jobs that
meet both of the following criteria are copied into the UPP.
s The job names, which are specified in the DEFINE PARAMETERS IN THE
MASTER PLAN screen (option 1), reference a job that appears in the Daily
Scheduling table.
s The jobs must be scheduled to run on the specified day (today). The CTMJOB
utility is invoked to determine which jobs run today.
The display of parameters can be limited to plans beginning with a specific prefix
using the PARM PREFIX field (under the command line).
To display the first occurrence of a parameter at the top of the screen, type the line
command L xxxx, where xxxx is a specific parameter or parameter prefix.
After all variables in a plan have been updated or have had their defaults approved,
you receive screen messages indicating the jobs from each plan that were ordered
automatically.
- - - - CONTROL- M - P. P. F. - UPDATE PARAMETER VALUES - - - - - - - - - - - - - - - - - - - - - - ( P. 3. 1)
COMMAND ===> SCROLL ===> CSR
PARM PREFI X ===> PLAN NAME: REPTS
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ PARM NAME ===> REPT_NAME OCCUR NO. ===> 01 NO DEFAULT
VALUE ===>
Ent er name of sal es r epor t r equi r ed
_ PARM NAME ===> DEPT_NUMBER OCCUR NO. ===> DEF EXI STS
VALUE ===> 035
Ent er depar t ment number ( used f or al l r epor t s)
_ PARM NAME ===> REPT_NAME OCCUR NO. ===> 02 NO DEFAULT
VALUE ===>
Ent er name of expense r epor t r equi r ed
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Bot t om of Dat a * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *







Utilities Under ISPF
360 CONTROL-M for OS/390 and z/OS User Guide
Special Options
A special option, activated by typing YES in the REMAINING PARAMETERS field
on the Exec / Order a Plan screen, prompts you automatically for parameter values
that have yet to be updated from all active plans (that is, those plans fetched for the
day). The parameters are presented on consecutive Update Parameter Values screens.
s YES You are presented with remaining (non-updated) parameters from active
plans.
s NO After updating the current plan, the Exec / Order a Plan screen is displayed
or, if Plan Name was left blank, the Plan Selection screen containing all active plans
is displayed. Default.
Table 140 Format of the Update Parameter Values Screen
Field Description
PARM PREFIX Plan prefix. If a value is entered in this field, the display of
parameters is limited to plans beginning with the specified
prefix.
PLAN NAME Name of the User Prompting Plan ordered for execution.
PARM NAME Name of the parameter available for update.
VALUE Default value of the parameter. This value can be modified;
embedded blanks are permitted.
MESSAGE Prompting message.
OCCUR NO. Occurrence number (2 digits). Differentiates between use of
the same parameter name for different purposes in different
jobs (for example, assign OCCUR NO. 01 to occurrence of
%%PARM1 in Job A; assign OCCUR NO. 02 to occurrence of
%%PARM1 in Job B).
DEFAULT STATUS Indication of default:
s NO DEFAULT No associated default value.
s DEF EXISTS Parameter has an associated default value
that has not yet been approved by the user.
s DEF CONFIRMED Default value has been approved.
s DEF CHANGED Default value is not being used.
Parameter has been assigned a different value.
SELECTION FIELD Type S in this field (A) to accept the default, if a default exists.
Utilities Under ISPF
Chapter 2 Online Facilities 361
M5: Quick Schedule Definition
The Quick Schedule Definition facility is an automatic online interface for creating
scheduling tables for regular jobs that have common scheduling parameters. (Group
tables are not supported.) This facility speeds up the process of defining a schedule
by eliminating the need to individually define parameters for each job and its job
interdependencies.
Twenty-one jobs and their interdependencies can be defined on one screen with
CONTROL-M automatically providing space for additional jobs.
The utility can be requested in the following ways:
Select option M5 on the Online Utilities menu
Activate CLIST CTMQUICK from the TSO Command Processor
Quick Schedule Definition Process
Four simple steps are performed one time only in order to create a complete
scheduling table for an unlimited number of jobs.
These steps are described in detail below.
Step 1: Create a Skeleton Job
In this step you create a job in a scheduling table to be used as a skeleton, or model,
for all the jobs in the automatically created scheduling table (output table).
Enter the CONTROL-M Scheduling Definition facility and create a standard
CONTROL-M scheduling table containing one skeleton job. For more information,
see Scheduling Definition Facility on page 111.
Table 141 Quick Schedule Definition Process
No. Step Where Performed
1. Create a skeleton job. Screen 2, Scheduling Definition facility.
2. Specify general table information
and prerequisite conditions format.
Quick Schedule Definition entry panel.
3. List job interdependencies. Quick Definition Job List screen.
4. Exit the Quick Schedule Definition
facility.
Note: The scheduling table is
automatically created upon exit from
the Quick Schedule Definition facility.
Utilities Under ISPF
362 CONTROL-M for OS/390 and z/OS User Guide
Specify in the skeleton job all parameter values that are to be common to (the same in)
all the jobs in the automatically created table.
It is not necessary to specify IN and OUT parameters. IN and OUT prerequisite
conditions are automatically created by CONTROL-M in the output scheduling table.
MEMNAME, MEMLIB, and DOCLIB fields are overridden by CONTROL-M during
automatic table creation.
The data in all other fields is copied into each of the new jobs in the output table.
Therefore, it is important to verify the data carefully.
If variable %%JOBNAM, a non-AutoEdit variable specific to the Quick Schedule
Definition facility, is specified in a SHOUT statement, it is resolved during table
creation to the member name in each job.
If system variable %%JOBNAME is specified in a SHOUT statement, it is resolved at
runtime to the name of the job. If the job name is not known, %%$MEMNAME can be
used in its place.
Step 2: Specify General Table Information and Prerequisite Conditions Format
In this step, you display the Quick Schedule Definition entry panel and specify
general table information and the desired format for automatically defined
prerequisite conditions.
The entry panel can be displayed either by requesting option M5 on the Online
Utilities menu, or by activating CLIST CTMQUICK from the TSO Command
Processor. The following screen is displayed:
%%JOBNAM and %%JOBNAME Var i abl es
Utilities Under ISPF
Chapter 2 Online Facilities 363
Figure 122 CONTROL-M Quick Schedule Definition Screen
Fill in the following general table information fields:
To exit this screen, press END (PF03/PF15).
- - - - - - - - - - - - - - - - - - - CONTROL- M QUI CK SCHEDULE DEFI NI TI ON - - - - - - - - - - - - - - - - - - - - - - -
COMMAND ===>

SPECI FY LI BRARY, OUTPUT SCHEDULI NG TABLE, SKELETON SCHEDULI NG TABLE

LI BRARY ===> CTM. PROD. SCHEDULE
TABLE ===> PAYROLL ( Schedul i ng t abl e t o be cr eat ed)
SKELETON ===> DAI LY ( Skel et on schedul i ng t abl e)

OWNER i n t he out put t abl e S ( T: your TSO User I D)
( S: OWNER f r om t he skel et on t abl e)

PREREQUI SI TE CONDI TI ONS FORMAT ( CHOOSE ONE)

GROUP- FROMJOB- SUFFI X ===> Y ( Y/ N)
FROMJOB- TOJOB- SUFFI X ===> N ( Y/ N)
PREFI X- FROMJOB- TOJOB ===> N ( Y/ N)
TOJOB- FROMJOB- SUFFI X ===> ( Y/ N)

PREFI X OR SUFFI X ===> OK

GROUP ===> FI NANCE SERVI CES ( For gr oup- f r omj ob- suf f i x opt i on)

CONNECTOR CHARACTER ==>


Table 142 Fields of the CONTROL-M Quick Schedule Definition Screen
Field Description
LIBRARY Name of the library that contains the skeleton member created
in Step 1 and that will contain the output scheduling table.
TABLE Name of the scheduling table to be created.
SKELETON Member name of the model scheduling table containing
common parameter values (created in Step 1 above). The
member must exist in the library specified above.
OWNER Value to be entered in the OWNER field in the output
scheduling definitions. Valid values are:
s T Your TSO user ID is used as the value for OWNER in
the output tables.
s S The value of OWNER in the skeleton table is used for
OWNER in the output tables.
Utilities Under ISPF
364 CONTROL-M for OS/390 and z/OS User Guide
Prerequisite Condition Format Fields
Job dependencies are established by prerequisite conditions that are defined in the
job scheduling definitions.
The utility defines prerequisite conditions automatically. Therefore, naming
conventions for these conditions must be specified. Prerequisite conditions created by
the utility must consist of a combination of the following elements:
CONTROL-M can create prerequisite conditions based on the above elements in
several different formats. These formats are described below. Select one of the
formats by typing Y (Yes) to the right of one desired format, and N (No), to the right
of the remaining formats. IN and OUT prerequisite conditions are automatically
created in the job scheduling definitions in the selected format.
Table 143 Prerequisite Condition Format Fields
Field Description
FROMJOB Name of the predecessor job in the dependency.
For example, if JOB-A must terminate before JOB-B can be
submitted, JOB-A is the FROMJOB.
TOJOB Name of the successor job in the dependency. For example, if
JOB-B must be submitted after JOB-A terminates, JOB-B is the
TOJOB.
GROUPNAME Name of the group to which the jobs in the dependency
belong.
PREFIX Constant to be added as a prefix to the condition.
SUFFIX Constant to be added as a suffix to the condition.
NOTE
Job dependencies are defined in Step 3, described in Step 3: Specify Job
Interdependencies on page 366.
Table 144 Formats for Prerequisite Conditions (Part 1 of 2)
Format Description
GROUPNAME-FROMJOB
-SUFFIX
If Y is entered, creates conditions in the following
format (for example): BACKUP-BKP00010-OK.
FROMJOB-TOJOB-SUFFIX If Y is entered, creates conditions in the following
format (for example): BKP00010-BKP00020-OK.
Utilities Under ISPF
Chapter 2 Online Facilities 365
The following fields affect the above formatted conditions. The GROUP field also
affects the GROUP value in the job scheduling definition.
Proceeding to the Job List Screen
Once you have filled in the fields in the Quick Definition entry panel, press Enter.
s If the table that you specified in the TABLE field does not already exist in the
library, the Job List screen is displayed and you can proceed with Step 3.
s If the table that you specified in the TABLE field already exists in the library, the
Overwrite Confirmation window is displayed:
PREFIX-FROMJOB-TOJOB If Y is entered, creates conditions in the following
format (for example): VALCHK-BKP00010-BKP00020.
TOJOB-FROMJOB-SUFFIX If Y is entered, creates conditions in the following
format (for example): BKP00020-BKP00010-OK
Table 145 Fields that Affect Prerequisite Conditions Formats
Field Description
PREFIX OR SUFFIX Constant to be used as a prerequisite condition prefix or suffix
(depending on the format selected). Mandatory. Valid values
are: 1 through 9 characters.
GROUP 1 through 20 character group name (no embedded spaces) to
be used in the job scheduling definitions. Optional, except for
format GROUP-FROMJOB-SUFFIX (for which it is
mandatory).
If specified, the value in this field is used as the GROUP value
in the created job scheduling definitions (that is, in place of the
GROUP value in the skeleton).
If the GROUP-FROMJOB-SUFFIX format is requested, an
*(Asterisk) can be entered in this field. In this case, the group
name is omitted from the prerequisite condition (such as
BKP00010-OK), but the created job scheduling definitions still
contain the group name defined in the skeleton.
CONNECTOR
CHARACTER
Character used to concatenate the components of the condition
names. Mandatory. Valid values are: one non-blank character
other than '&' (Ampersand), for example, '-'.
Table 144 Formats for Prerequisite Conditions (Part 2 of 2)
Format Description
Utilities Under ISPF
366 CONTROL-M for OS/390 and z/OS User Guide
Figure 123 CONTROL-M Quick Search Schedule Definition
Type Y (Yes) to overwrite the existing table. The current contents of the table are
erased, and an empty table (Job List screen) is displayed.
Type N (No) if you do not want to overwrite the current contents of the table.
The window is closed. You can now type a different table name in the TABLE
field and press Enter again.
Step 3: Specify Job Interdependencies
In this step you fill in a list of jobs, a description of each job, and the jobs upon which
they depend.
After you fill in the Quick Schedule Definition entry panel (and, if necessary, the
Overwrite Confirmation window) and press Enter, the Job List screen is displayed:
- - - - - - - - - - - - - - - - - - - CONTROL- M QUI CK SCHEDULE DEFI NI TI ON - - - - - - - - - - - - - - - - - - - - - - -
COMMAND ===>

+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| |
| LI BRARY CTM. PROD. SCHEDULE |
| TABLE PAYROLL |
| |
| ALREADY EXI STS. |
| |
| THI S PROCEDURE WI LL OVERWRI TE THE DATA I N THE TABLE. |
| |
| DO YOU WI SH TO CONTI NUE ( Y/ N) |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +








Utilities Under ISPF
Chapter 2 Online Facilities 367
Figure 124 Quick Schedule Definition Job List Screen Entered
Fill in one line for each job (the fields are detailed below). CONTROL-M provides
additional lines on the screen, as necessary. When you have finished filling in the list,
press Enter. The entries are validated.
Fields in the Job List Screen
JOB LI ST LI B: CTM. PROD. SCHEDULE TABLE: PAYROLL
COMMAND ===> SCROLL===> PAGE
O NR MEMNAME DEPENDS ON- - - - - - - - - - - - - - - - - - - - - - - - - - - - - DESCRI PTI ON - - - - - - - - - - - -
1 CHECKCAL * TI ME- CARDS- DONE CALCULATE CHECKS
2 CHECKPRT - PRI NT CHECKS
3 GOVTREPT CHECKCAL REPORTS TO GOVERNMENT
4 BANKTAPE 1 REPORTS FOR MANAGEMENT
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Table 146 Fields in the Job List Screen (Part 1 of 2)
Field Description
O Field for specifying options, which are described in Table 147
on page 369.
NR Line number. This number can be referenced in the DEPENDS
ON field of another job.
MEMNAME Name of the member containing the JCL of the job.
Utilities Under ISPF
368 CONTROL-M for OS/390 and z/OS User Guide
Options of the Job List Screen
To use one of the following options, type the option in the O field to the left of the line
number. These options are similar to ISPF line commands.
DEPENDS ON Jobs and/ or external prerequisite conditions on which this job
depends. Valid formats for the dependencies:
s name Name of the job (MEMNAME) upon which the
current job depends.
s position-number Number of the job on the screen. This
number is automatically adjusted when an option changes
the position of the current job or the job upon which it
depends.
s - (Minus sign) The Minus sign represents the previous job
in the list.
s *in-condition Name of an external prerequisite condition,
that is, a prerequisite condition other than job
interdependencies that are automatically created. It must
be preceded by an asterisk (*) and be the last dependency
entered on the job line. The date reference ODAT is
automatically associated with the in-condition.
More than one dependency can be listed by separating each
name by a comma. Format types may be mixed on a line.
Examples:
s CHECKCAL Job CHECKCAL
s 1 Job on line 1 of the list
s - (Minus sign) Job on the preceding line
s -3,*SALES-DATA Job on line 3 of the list plus an external
IN condition.
DESCRIPTION Description of the job in free text.
Table 146 Fields in the Job List Screen (Part 2 of 2)
Field Description
Utilities Under ISPF
Chapter 2 Online Facilities 369
After performing requested options, CONTROL-M automatically handles
renumbering and adjusts the relevant DEPENDS ON parameter values on the screen.
Step 4:Exit the Quick Schedule Definition Facility (and Create the Scheduling
Table)
To exit the Quick Schedule Definition facility after entering the data for a table, press
the END (PF03/PF15) key. An Exit Option window is opened:
Figure 125 Quick Schedule Definition Facility Exit Option Window
Table 147 Options of the Job List Screen
Option Description
I Insert a blank line immediately after the current line.
P Insert a blank line immediately preceding this line. This
enables addition of data before the first line in the list.
R Repeat this line immediately after the current line.
D Delete this line. If a job depends upon this line, you receive an
error message.
A Indicates that the target of a copy or move is directly after this
line.
B Indicates that the target of a copy or move is directly before
this line.
C Copy this line to the target.
M Move this line to the target.
JOB LI ST LI B: CTM. PROD. SCHEDULE TABLE: PAYROLL
COMMAN +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| PLEASE SELECT EXI T OPTI ON |
| |
| SAVE CREATE |
| |
| LI BRARY CTM. PROD. SCHEDULE |
| TABLE PAYROLL |
| |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +














Utilities Under ISPF
370 CONTROL-M for OS/390 and z/OS User Guide
The schedule can be saved (to replace a table of the same name that previously
existed in the library), or created (to store a new table in the library), by typing Y in
the appropriate exit option. The job schedule is automatically created as you exit.
If N is entered, the table is not saved, and the schedule is not produced. You return to
the Utilities screen or other screen, depending on how you entered the utility.
If no changes have been made, the Exit Option window is not opened.
To exit to the Quick Schedule Definition entry panel without saving your entries (and
without creating the job schedule), press RESET (PF04).
The screen below illustrates job GOVTREPT selected from the jobs listed in the Job
List screen in Step 3 above. Note particularly the automatically created MEMNAME,
IN and OUT parameters, and the job name inserted into the SHOUT message by
using the %%JOBNAM variable.
Utilities Under ISPF
Chapter 2 Online Facilities 371
Figure 126 Scheduling Definition Screen Quick Schedule Definition Example
M6: End-User Job Order Interface
By ordering jobs through the End-User Job Order Interface, you can bypass the rest of
the CONTROL-M Online facility.
The Job List screen (Figure 127) can be displayed in one of the following ways:
s Select option M6 on the Online Utilities menu.
s Activate CLIST CTMJBINT from the TSO Command Processor.
JOB: GOVTREPT LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME GOVTREPT MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC REPORTS TO GOVERNMENT
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM GOVTREPT DOCLI B
=============================================================================
DAYS DCAL
AND/ OR O
WDAYS ALL WCAL
MONTHS 1- N 2- N 3- N 4- N 5- N 6- N 7- Y 8- N 9- Y 10- N 11- N 12- N
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
=============================================================================
I N FI NANCE- CHECKCAL- OK ODAT
CONTROL
RESOURCE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
=============================================================================
OUT FI NANCE- GOVTREPT- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES NOTOK A/ O
DO SHOUT TO TSO- M44 URGENCY R
= JOB GOVTREPT ENDED " NOT OK"
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< =======
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 20. 28. 53
Utilities Under ISPF
372 CONTROL-M for OS/390 and z/OS User Guide
Figure 127 Job List Screen Entered Through the End-User Job Order Interface
This screen displays a list of jobs that the particular user is permitted to order. The
INCONTROL administrator determines which jobs each user is permitted to order.
1. Do one of the following:
s Press PF03/PF15 to exit the screen.
s To order jobs, type S in the OPT field to the left of each job to be ordered and press
Enter.
JOB LI ST M6 - END USER JOB ORDER I NTERFACE UTI LI TY CONTROL: @@USRT
COMMAND ===> SCROLL===> CRSR
OPT NAME - - - TABLNAME - SCHEDULI NG LI BRARY NAME - - - - - - - DESCRI PTI ON - - - - - - - - - -
PAYCALC PAYROLL CTMP. V610. SCHEDULE
PERF ASSESS CTMP. V610. SCHEDULE WDAYS=2( TUE) , G+3
====== >>>>>>>>>>>>>>>>>>>> NO MORE JOBS I N TABLE <<<<<<<<<<<<<<<< =====


















Utilities Under ISPF
Chapter 2 Online Facilities 373
For each job selected, in sequence, a new screen is displayed. The header of the screen
contains the names of the library and table. Under the command line, the Please Enter
Scheduling Date/ Force Options window is displayed (see Figure 128) .
2. In this window, do one or more of the following:
s replace the date displayed with another date
s change the scheduling date of the job to the CONTROL-M working date, by
typing Y in the OR USE CONTROL-M WORKING DATE field
s FORCE the job by typing YES in the FORCE JOB? field
3. After selecting these options, you have the following further options:
s Press Enter to complete the order request.
s Press PF03/PF15 to cancel the order request.
s Press PF04/PF16 to cancel the changes and exit the Job List screen.
Figure 128 Job Scheduling Date and FORCE Options Window
JOB LI ST LI B: CTMP. V610. SCHEDULE TABLE: PAYROLL
COMMAND ===>
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| PLEASE ENTER SCHEDULI NG DATE/ FORCE OPTI ONS |
| |
| JOB PAYCALC DATE 23 05 04 ( DD MM YY) |
| OR USE CONTROL- M WORKI NG DATE? ( Y/ N) |
| |
| FORCE JOB? NO ( YES/ NO) |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Utilities Under ISPF
374 CONTROL-M for OS/390 and z/OS User Guide
U1: Invoke DOCU/TEXT
This option is available only at sites that have installed DOCU/ TEXT, a product of
Diversified Systems Software, Inc. DOCU/ TEXT provides automated, online JCL
documentation, and this option provides a direct interface to DOCU/ TEXT. It can be
activated by requesting option U1 on the Online Utilities menu or by activating
CLIST CTMCDOCU directly.
For details about product usage refer to your DOCU/ TEXT user guide.
Chapter 3 Job Production Parameters 375
Chapt er
3
3 Job Production Parameters
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
General Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Basic Scheduling Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Runtime Scheduling Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Post-Processing Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
ADJUST CONDITIONS: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
APPL: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Restart AUTO-ARCHIVE: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . 398
CONFCAL: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
CONFIRM: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
CONTROL: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
CTB STEP: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
D-CAT: Basic Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
DATES: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
DAYS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
DEFINITION ACTIVE: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 430
DESC: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
DO Statement: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
DO COND: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
DO CTBRULE: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
DO FORCEJOB: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
RestartDO IFRERUN: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . 446
DO MAIL: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
DO NOTOK: PostProcessing Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
DO OK: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
DO RERUN: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
DO SET: PostProcessing Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
DO SHOUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
DO STOPCYCL: Post-Processing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
DO SYSOUT: Post-Processing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
DOC: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
DOCLIB: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
DOCMEM: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
376 CONTROL-M for OS/390 and z/OS User Guide
DUE OUT: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
GROUP: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
GRP MAXWAIT: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
IN: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
INTERVAL: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
MAXRERUN: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
MAXWAIT: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
MEMLIB: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
MEMNAME: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
MINIMUM: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
MONTHS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
NJE NODE: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
ON: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
ON GROUP-END: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
OUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
OVERLIB: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
OWNER: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
PDS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
PIPE: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
RestartPREVENT-NCT2:General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
PRIORITY: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
RELATIONSHIP: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
RERUNMEM: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
RESOURCE: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Restart RETENTION: # OF DAYS TO KEEP: PostProcessing Parameter . . . . . . 594
RestartRETENTION: # OF GENERATIONS TO KEEP: PostProcessing Parameter
596
RETRO: Basic Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
SAC: Run Time Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
SCHEDULE TAG: Basic Scheduling Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
SCHEDULE TAG ACTIVE: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . 607
SCHENV: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
SET VAR: General Job Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
SHOUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
STEP RANGE: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
SYSOUT: PostProcessing Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
SYSTEM ID: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
TASKTYPE: General Job Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
TIME: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
TIME ZONE: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
WDAYS: Basic Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Overview
Chapter 3 Job Production Parameters 377
Overview
Job scheduling definitions consist of parameters that correspond to the decisions
made and actions performed when handling the scheduling, submission and
post-processing of a job. Job scheduling definitions are defined in the Job Scheduling
Definition screen (shown below), the main screen of the Scheduling Definition
facility.
Figure 129 Job Scheduling Definition Screen
JOB: BACKPL02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME BACKPL02 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG
RELATI ONSHI P ( AND/ OR) O
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL WORKDAYS SHI FT RETRO N MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- BACKUP ODAT
CONTROL
RESOURCE I NI T 0001 CART 0001
PI PE CTM. PROD. PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT BAKCKPL02- ENDED- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< ====
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 19. 17. 13
Overview
378 CONTROL-M for OS/390 and z/OS User Guide
The PIPE parameter is displayed only if MAINVIEW Batch Optimizer (MVBO)
is installed.
RETENTION parameters # OF DAYS TO KEEP and # OF GENERATIONS TO
KEEP are displayed only at sites that use the History Jobs file.
If the scheduling table is a Group scheduling table, a Group Entity (shown below)
must be defined before the job scheduling definitions.
Figure 130 Group Entity Definition Screen
NOTE
Fields SCHEDULE TAG and RELATIONSHIP only appear in job scheduling
definitions belonging to Group scheduling tables.
GRP ACCOUNTS_GROUP CTM. PROD. SCHEDULE( GRP)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
GROUP ACCOUNTS_GROUP MEMNAME ACCOUNTS
OWNER N04B
APPL
DESC
ADJUST CONDI TI ONS N GRP MAXWAI T 00
SET VAR
DOCMEM ACCOUNTS DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG ALL_DAYS
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
SCHEDULE TAG
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT
ON GROUP- END NOTOK
DO COND ACCTS- CHK- REQUI RED ODAT +
SHOUT WHEN TO URGN
MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 19. 17. 13
Overview
Chapter 3 Job Production Parameters 379
Most parameters in the Group Entity definition are the same as in the job scheduling
definition, but they apply to the group as a whole. Therefore:
s At least one set of basic scheduling criteria in the Group Entity must be satisfied
before any job in the group can be scheduled.
s Runtime scheduling criteria in the Group Entity must be satisfied before any job in
the group can be executed.
s Post-processing statements in the Group Entity are applied only after all jobs in the
group have finished executing.
The following parameters in the Group Entity are not found in the job scheduling
definition:
s ADJUST CONDITIONS
s ON GROUP-END
s SCHEDULE TAG ACTIVE FROM and UNTIL
Usage and operation of the Scheduling Definition facility, including entry and exit of
the Job Scheduling Definition screen, is described in the INCONTROL for OS/390 and
z/OS Utilities Guide.
In addition to defining jobs through the Scheduling Definition facility, jobs can also
be defined using the batch utility CTMBLT, described in the INCONTROL for OS/390
and z/OS Utilities Guide, or using the online utility QUICKDEF. The QUICKDEF
utility, the Quick Schedule Definition facility, is available under ISPF only. For more
information about it, see Utilities Under ISPF on page 320.
This chapter provides a detailed description of the job scheduling definition
parameters and statements.
The parameters of the Job Scheduling Definition screen are divided into the following
categories:
s General parameters
s Basic Scheduling parameters
s Runtime Scheduling parameters
s Post-processing parameters
A brief summary of the parameters in each category is provided on the following
pages. This is followed by a detailed description of each parameter, in alphabetical
order.
Overview
380 CONTROL-M for OS/390 and z/OS User Guide
General Parameters Summary
General parameters provide general information about the job and certain
information required by the JCL. Information about the following parameters is
provided in this chapter:
Table 148 General Parameters (Part 1 of 2)
Parameter Description
MEMNAME Member containing the JCL.
MEMLIB Library containing the JCL member.
OWNER Owner of the job.
TASKTYPE Type of job or task.
Restart PREVENT
NCT2
Whether to perform data set cleanup before the original job
run.
DFLT Protected field indicating the PREVENT-NCT2
default value of the site.
APPL Application to which the job belongs.
GROUP Group to which the job belongs.
DESC Brief description of the job.
OVERLIB Library containing a special case JCL for the job.
SCHENV Name of the workload management scheduling
environment to be associated with the job.
SYSTEM ID 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.
SET VAR Mechanism for setting the value of a JCL user-defined
variable.
CTB STEP CONTROL-M/ Analyzer step to be added to the execution
of the job.
DOCMEM Member containing detailed information about the job.
DOCLIB Library containing the member specified in the DOCMEM
parameter.
DOC Detailed job documentation.
The following General parameters are in the Group Entity only:
Overview
Chapter 3 Job Production Parameters 381
Basic Scheduling Parameters Summary
Basic Scheduling parameters determine if the job is a candidate for execution on a
specific date. If a job is a candidate for execution on a specific date, a job order is
automatically placed in the Active Jobs file during New Day processing.
Each job order placed in the Active Jobs file is associated with an original scheduling
date. This is the date the job is to run according to the Basic Scheduling parameters.
This date is not necessarily the same as the current system date or the current
working date. For further information, see Date Definition Concepts on page 62
Basic Scheduling parameters and subparameters allow different methods of
expressing a job schedule.
The SCHEDULE TAG parameter appears only in Group tables, in both job
scheduling definitions and in the Group Entity.
Each set of basic scheduling criteria in the Group Entity must be uniquely labeled by
a SCHEDULE TAG value. At least one Schedule Tag must be defined.
In job scheduling definitions, SCHEDULE TAG is optional. Each specified
SCHEDULE TAG value in the job scheduling definition must match a SCHEDULE
TAG value in the Group Entity. The associated basic scheduling criteria can then be
applied to the job.
The RELATIONSHIP parameter appears only in job scheduling definitions in Group
scheduling tables.
The RELATIONSHIP parameter defines the relationship (AND/ OR) between
schedule tag criteria and the basic scheduling criteria of the job, that is, whether one
or both sets of criteria are to be satisfied.
The Basic Scheduling parameters, except SCHEDULE TAG and RELATIONSHIP, are
listed below by category. When defining basic scheduling criteria for jobs in regular
or Group scheduling tables, or when defining basic scheduling criteria for Group
Entities, the following rules apply to these categories of parameters:
ADJUST
CONDITIONS
Allows conditions to be removed from job orders if the
predecessor jobs that set the conditions are not scheduled.
GRP MAXWAIT Number of additional days after the original scheduling
date that the Group Entity can remain in the Active Jobs file
if it does not have a status of ENDED OK (and none of its
jobs currently appear in the Active Jobs file).
Table 148 General Parameters (Part 2 of 2)
Parameter Description
Overview
382 CONTROL-M for OS/390 and z/OS User Guide
s Parameters must be selected from one and only one of the first three categories
(A, B, or C).
s Parameters in the last two categories (D and E) are optional.
Category C Parameters
Schedule the job if the number of free tracks in the specified partitioned data set
(PDS) is less than the minimum number of tracks specified. This set of criteria is
intended for jobs or started tasks that clean, compress or enlarge libraries or that issue
warning messages if the minimum number of free tracks is not available.
Table 149 Category A, B, C, and D Parameters
Category Parameter
A s MONTHS Schedule the job during the specified months.
s DAYS Schedule the job on specified days (in the
above-specified months) and/ or select days from a
specified calendar.
s WDAYS Schedule the job on specified days of the week
(in the above-specified months) and/ or select days from a
specified calendar.
s CONFCAL Confirm scheduling days against a specified
calendar.
B s DATES Schedule the job on specified dates.
s WDAYS Schedule the job on specified days of the week.
s CONFCAL Confirm scheduling days against a specified
calendar.
C s PDS PDS to be checked for minimum number of tracks.
s MINIMUM Minimum number of tracks.
D RETRO Schedule the job even if the original scheduling date
has passed.
E s MAXWAIT Maximum number of days to keep the job in
the Active Jobs file awaiting execution after its original
scheduling date has passed.
s D-CAT CONTROL-D category of the job. (Documented
as CATEGORY prior to version 5.1.4.)
Overview
Chapter 3 Job Production Parameters 383
Basic Scheduling Parameters
Each Basic Scheduling parameter is described in this chapter. However, the
interrelationships between some of these parameters are described briefly below.
DAYS, DCAL, WDAYS, WCAL
These parameters are all optional.
The DAYS parameter identifies days of the month on which the job must be
scheduled, such as first day of the month, third working day of the month. Several
formats are available for specifying DAYS values.
The WDAYS parameter identifies days of the week on which the job must be
scheduled, such as the first day of the week, the second day of each week, and so on.
Several formats are available for specifying WDAYS values.
A calendar name can be specified in the DCAL and/ or WCAL fields. A calendar
specifies days of the year on which a rule can be scheduled, known as working days.
For more information on calendars and the IOA Calendar facility, see IOA Calendar
Facility on page 301.
When both the DAYS and DCAL parameters are specified, they work as a
complementary unit, as described in DAYS: Basic Scheduling Parameter on
page 420. Similarly, when both WDAYS and WCAL are specified, they also work as a
complementary unit as described in WDAYS: Basic Scheduling Parameter on
page 654.
When values for both DAYS (/ DCAL) and WDAYS (/ WCAL) are specified in the
same job scheduling definition, the resulting schedule is determined by the value
specified in field AND/ OR.
CONFCAL and SHIFT
A calendar specified in CONFCAL is not used for job scheduling, but is used instead
for validating a scheduled date. Only jobs that have satisfied all other specified basic
scheduling criteria are checked against the CONFCAL calendar. If the day is a
working day in the CONFCAL calendar, the job is scheduled on that day. Otherwise,
the job is either shifted to (scheduled on) another day according to the value entered
in the SHIFT parameter, or the job is not scheduled (if no SHIFT value has been
specified).
CONFCAL calendars are especially useful for handling holidays and other
scheduling exceptions.
Overview
384 CONTROL-M for OS/390 and z/OS User Guide
Defining a Schedule Internal Scheduling Logic
When defining scheduling tables, it is useful to understand the IOA Scheduling
facility logic, which determines whether to order a job on a specific day. This logic is
described below.
1. ACTIVE FROM and UNTIL parameters are checked first. If the current date falls
outside the time range specified, no further checking is performed.
2. DAYS and DCAL parameters are checked independently and a first tentative
scheduling decision is created.
3. WDAYS and WCAL parameters are checked independently and a second tentative
scheduling decision is created.
4. A third tentative scheduling decision is created based on the above two decisions
and the AND/ OR value linking them.
(If DAYS and/ or DCAL are not specified, this third temporary scheduling decision
is identical to the second scheduling decision. If WDAYS and/ or WCAL are not
specified, this third scheduling decision is identical to the first scheduling decision.
5. If CONFCAL and/ or SHIFT are specified, this third scheduling decision is
adjusted according to the CONFCAL and SHIFT criteria.
6. This third scheduling decision (as adjusted) becomes the final scheduling decision.
The IOA Scheduling facility determines whether to schedule a job based on this
final scheduling decision.
Scheduling Jobs in Group Scheduling Tables
The following scheduling algorithm applies to Group scheduling tables:
1. Before jobs in a group can be scheduled, the group must be eligible for scheduling
(that is, at least one of the tagged sets of basic scheduling criteria in the Group
Entity has been satisfied).
2. If (and only if) the group is eligible for scheduling, each job scheduling definition
in the scheduling table is individually checked for possible scheduling.
3. For each job scheduling definition:
s Schedule tags in the job scheduling definition are checked sequentially
beginning with the first tag. The SCHEDULE TAG ACTIVE FROM and UNTIL
parameters are checked first. If the current date falls outside the time range
specified, no further checking is performed.
Overview
Chapter 3 Job Production Parameters 385
If the criteria of a schedule tag are satisfied, no further checks are performed on
the remaining schedule tags. The criteria belonging to the satisfied tag are used
in the scheduling algorithm.
s The RELATIONSHIP parameter (AND/ OR) is checked.
If a schedule tag was satisfied and the defined relationship is OR, the satisfied
schedule tag is sufficient and the job is scheduled according to criteria of this
tag. No further checks are performed.
If no schedule tag was satisfied and the defined relationship is AND (that is,
the job requires that the schedule tag be satisfied), the job is not scheduled.
No further checks are performed.
If a schedule tag was satisfied and the defined relationship is AND, or if no
schedule tag was satisfied and the defined relationship is OR, the basic
scheduling criteria of the job must be satisfied (that is, the algorithm
continues with the next step).
s The basic scheduling criteria of the job are checked.
If the basic scheduling criteria of the job are not satisfied, the job is not
scheduled.
If the basic scheduling criteria of the job are satisfied, the job is scheduled.
The basic scheduling criteria of the job, not the scheduling tag criteria, are used for
scheduling. This is a concern only if there are conflicting MAXWAIT values in the
scheduling tag criteria and the basic scheduling criteria of the job. In this case, the
MAXWAIT value from the basic scheduling criteria of the job is used.
Overview
386 CONTROL-M for OS/390 and z/OS User Guide
Figure 131 Group Scheduling Flowchart

Overview
Chapter 3 Job Production Parameters 387
Runtime Scheduling Parameters Summary
Runtime Scheduling parameters define job submission criteria. The job is not
submitted unless all submission criteria are satisfied. The following criteria can be
defined:
Post-Processing Parameters Summary
Actions to be performed after job execution generally depend on the results of the job
execution:
s Certain actions may be required when the job ends successfully.
s Certain actions may be required when the job fails, depending on the reason for
failure.
s Certain actions may be required in any and all situations.
The CONTROL-M monitor tracks each job execution. Following the termination of a
job, the CONTROL-M monitor checks the execution results of each step in the job.
Based on the results, the CONTROL-M monitor determines a final status of the job.
Either of two final job statuses can be assigned:
Table 150 Runtime Scheduling Parameter Criteria
Parameter Description
IN Required prerequisite conditions.
CONTROL Required exclusive or shared Control resources.
RESOURCE Quantitative resources and the required quantity.
PIPE Name of each data set that is replaced by a pipe during the run
of the job. Available only at sites where MAINVIEW Batch
Optimizer (MVBO) is installed.
TIME Time range during which the job must be submitted.
TIME ZONE Enables automatic adjustment of the times specified in the job
definition to the corresponding times in a different time zone.
PRIORITY Job priority and critical path priority.
DUE OUT Time by which the job must finish executing, which can
determine the time by which the job must be submitted.
CONFIRM Manual confirmation required before the job is submitted.
Overview
388 CONTROL-M for OS/390 and z/OS User Guide
If a post-processing error occurs after a job ends OK (including FORCE OK), it
indicates that there is a problem with the post-processing statements defined in the
job scheduling definition. For example, a post-processing statement may have
indicated an action that the owner of the job was not authorized to perform.
Post-processing parameters can be divided into the following groups:
Parameters Performed When the Job Ends OK
Conditional Processing or Processing in All Situations
Most conditional processing is specified through a combination of ON and DO
statements. ON and DO statement definition consists of defining ON statement step
and code events (for example, ON PGMST STEP1 CODE C0016), followed by DO
statement actions (for example, DO SHOUT, DO FORCEJOB), which are performed
when the ON step and code criteria are satisfied.
Table 151 Final Job Statuses
Status Description
OK Job ended OK. This status is usually assigned when all steps in
the job end with a condition code less than or equal to C0004.
NOTOK Job ended NOTOK. This status is assigned when any step ends
with a condition code greater than or equal to C0005. It is also
assigned if the job abends or is not run.
The following statuses are subsets of end status NOTOK:
s JNRUN Job not run due to JCL syntax error.
s EXERR Execution error (that is, one that occurred after
the job has started running).
s JFAIL JCL error was encountered during job step
initiation. This status is also a subset of status EXERR.
Table 152 Parameters Performed When the Job Ends OK
Parameter Description
OUT Adds or deletes prerequisite conditions.
Restart
AUTO-ARCHIVE
Archives sysout.
Restart
RETENTION
Specifies retention criteria of a job in the History Jobs file.
SYSOUT Specifies sysout processing.
Overview
Chapter 3 Job Production Parameters 389
A range of steps for use in the ON statement can be defined in the STEP RANGE
parameter.
ON and DO statements also specify actions that are to be performed in any and all
cases. To ensure that the ON statement is activated for all step and code events, enter
reserved word ANYSTEP as the ON step name and ***** as the ON code.
Return and Cyclic Post-processing Parameters

Table 153 Conditional Processing Statements
DO Statement Description
DO statements allow specification of a wide variety of actions to be performed when
the ON criteria are satisfied:
DO COND Add or delete prerequisite conditions.
DO CTBRULE Activate a CONTROL-M/ Analyzer rule.
DO FORCEJOB Force a job.
Restart DO
IFRERUN
Perform CONTROL-M/ Restart job restart.
DO MAIL Send an e-mail to the specified recipients.
DO NOTOK Set the status of the step to NOTOK.
DO OK Set the status of the step to OK.
DO RERUN Rerun the job.
DO SET Set the value of an AutoEdit variable.
DO SHOUT Send a message.
DO STOPCYCL Stop recycling a cyclic task.
DO SYSOUT Handle sysout processing.
The following parameter specifies the condition that determines if and when
processing is performed.
SHOUT Sends a message to a specified destination in specified
situations (for example, if the job was submitted late).
Table 154 Return and Cyclic Post-Processing Parameters
Parameter Description
MAXRERUN Maximum number of times to rerun the job (used only for
automatic job rerun or cyclic jobs). (Called RERUN
MAXRERUN prior to version 6.0.00).
RERUNMEM Member containing the JCL to be used for automatic rerun.
(Called RERUN RERUNMEM prior to version 6.0.00.)
INTERVAL Minimum time interval between runs of a rerun or cyclic job.
This parameter acts as a Runtime Scheduling parameter for the
subsequent rerun or cyclic runs of the job.
Overview
390 CONTROL-M for OS/390 and z/OS User Guide
Group Entity Post-processing Parameters

Table 155 Group Entity Post-Processing Parameters
Parameter Description
The following parameter is found only in the Group Entity definition:
ON GROUP-END The table-processing termination status that determines
whether the accompanying DO statements are performed.
The following DO statements are permitted following an ON
GROUP-END statement:
s DO COND
s DO OK
s DO MAIL
s DO FORCEJOB
s DO SET
s DO NOTOK
s DO SHOUT
NOTE
DO OK and DO NOTOK statements change the final status of the group (not the
status of each job or job step in the group).
Parameter Descriptions
Chapter 3 Job Production Parameters 391
Parameter Descriptions
The following pages contain detailed descriptions of all parameters available in the
CONTROL-M Job Definition screen. Parameters are arranged in alphabetical order.
Within each parameter, subparameters are arranged according to the order of the
fields on the screen.
Each parameter begins on a new page, including:
s A brief explanation of the purpose of the parameter.
s The format required for defining the parameter within an extract of the
CONTROL-M screen.
s General information explaining the parameter and its usage.
s Where applicable, some practical examples illustrating implementation of the
parameter.
For more information on the Job Definition facility, see Chapter 2, Online Facilities.
ADJUST CONDITIONS: General Job Parameter
392 CONTROL-M for OS/390 and z/OS User Guide
ADJUST CONDITIONS: General Job Parameter
Determines how CONTROL-M handles a requirement for a prerequisite condition by
successor jobs in a Group scheduling table. This parameter appears in the Group
Entity only and applies only to Group scheduling tables.
Figure 132 ADJUST CONDITIONS Parameter Format

Optional. Valid values are:
General Information
This parameter is applied to all jobs in the Group scheduling table. It provides the
following options when job dependency is defined between jobs in a group by their
respective conditions.
Table 156 ADJUST CONDITION Parameter Values
Value Description
Y (Yes) CONTROL-M erases from each group job on the Active Jobs
file any IN prerequisite condition that is triggered by a
predecessor job that will not be ordered during the current
day.
N (No) CONTROL-M does not erase any IN prerequisite conditions.
Default.
D (Dummy) CONTROL-M orders as a PSEUDO job any job with
scheduling criteria that are not satisfied on the current
ODATE, with the MEMLIB parameter of the job set to
DUMMY.
ADJUST CONDITIONS: General Job Parameter
Chapter 3 Job Production Parameters 393
s If you enter the value Y for the ADJUST CONDITIONS parameter, the following
principles apply:
CONTROL-M erases IN conditions from each job in the group that is placed on
the AJF. The following criteria must be met before an IN condition is erased:
s The IN condition in the job is triggered by a predecessor job.
s The scheduling criteria of the predecessor job are such that the predecessor
job will not be ordered during the current day.
The erasing of these IN conditions frees the successor job from its dependency
on the predecessor job.
Only the image of the job on the AJF is affected. The original job scheduling
definition remains unchanged.
The erased condition does not appear in the Zoom screen.
s If you enter the value N for the ADJUST CONDITIONS parameter, CONTROL-M
runs normally. You must release any jobs that are likely to wait indefinitely on the
AJF because they are dependent on predecessor jobs with scheduling criteria such
that they will not be ordered. To release the dependent jobs, use one of the manual
options, such as those available in
the IOA Conditions/ Resources screen (Screen 4)
the IOA Manual Conditions file (Screen 7)
ADJUST CONDITIONS: General Job Parameter
394 CONTROL-M for OS/390 and z/OS User Guide
s If you enter the value D for the ADJUST CONDITIONS parameter, the following
principles apply:
CONTROL-M places all the jobs in the group onto the AJF when the group is
ordered.
Jobs in the group with scheduling criteria that fit the current ODATE remain
unchanged.
Jobs in the group with scheduling criteria that do not fit the current ODATE are
placed on the AJF as PSEUDO jobs. The value of the MEMLIB parameter in the
case of each such job is changed to DUMMY.
Only the image of the job on the AJF is affected. The original job scheduling
definition remains unchanged.
The processing of DUMMY jobs is similar to that of regular jobs, but they are
never submitted to JES. When the IN conditions and other CONTROL-M
submission criteria are satisfied, they trigger their respective OUT conditions.
The original logical flow of the group is maintained even when some jobs in the
group are not executed (because their scheduling criteria do not fit the current
ODATE).
Examples
Example 1
If a predecessor job is not scheduled, the requirement for the prerequisite conditions
that the predecessor job would have normally placed in the IOA Conditions file is
erased in the successor jobs.
ADJUST CONDITIONS: General Job Parameter
Chapter 3 Job Production Parameters 395
Figure 133 ADJUST CONDITIONS Parameter Example
Example 2
Assume that a Group Entity defines a chain of jobs, in the order
DAILY-1 > DAILY-2 > DAILY-3 > WEEKLY-1 > DAILY-4.
s The user wants the following:
Each of the DAILY jobs must run every day, in the order
DAILY-1 > DAILY-2 > DAILY-3 > DAILY-4.
The WEEKLY-1 job must run only on each Tuesday.
When WEEKLY-1 runs, it must run after DAILY-3 and before DAILY-4.
s DAILY-1, DAILY-2, DAILY-3, WEEKLY-1, and DAILY-4 contain IN and OUT
conditions to ensure that they run in the required order.
Unless some step is taken, on the days when WEEKLY-1 does not run, DAILY-4
cannot be executed, because its IN condition causes it to wait for WEEKLY-1 to end.
If the ADJUST CONDITIONS parameter is set to D, WEEKLY-1 is ordered daily.
Every day except Tuesday, its scheduling conditions prevent it running, and it is
ordered as a PSEUDO job. Each Tuesday, it is ordered and executed normally. The
logical job flow is maintained throughout.
GRP ACCOUNTS_GROUP CTM. PROD. SCHEDULE( GRP)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
GROUP ACCOUNTS_GROUP MEMNAME ACCOUNTS
OWNER N04B
APPL
DESC
ADJUST CONDI TI ONS Y GRP MAXWAI T 00
SET VAR
DOCMEM ACCOUNTS DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG ALL_DAYS
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
SCHEDULE TAG SUNDAYS
DAYS 01 DCAL
AND/ OR
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 44. 31
APPL: General Job Parameter
396 CONTROL-M for OS/390 and z/OS User Guide
APPL: General Job Parameter
Descriptive name of the application to which the group of the job belongs. Used as a
common descriptive name for a set of related groups (of jobs).
Figure 134 APPL Parameter Format

APPL specifies an application name of 1 through 20 characters. Only trailing blanks
are allowed.
By default, the APPL parameter is optional. It can be modified in the user profile.
General Information
The parameter facilitates the handling of groups of production jobs.
NOTE
Use of the APPL parameter is highly recommended to facilitate implementation of
CONTROL-M/ Enterprise Manager functions and future CONTROL-M options. For
details, see the CONTROL-M/Enterprise Manager User Guide.
APPL: General Job Parameter
Chapter 3 Job Production Parameters 397
Example
Job OPERCOMP belongs to group MAINTENANCE, which is part of application
OPER.
Figure 135 APPL Parameter Example
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B GENERAL
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 44. 00
Restart AUTO-ARCHIVE: PostProcessing Parameter
398 CONTROL-M for OS/390 and z/OS User Guide
Restart AUTO-ARCHIVE: PostProcessing
Parameter
Controls SYSDATA archiving.
Figure 136 Restart AUTO-ARCHIVE Parameter Format
Optional. The AUTO-ARCHIVE parameter consists of the following subparameters:
Table 157 Restart AUTO-ARCHIVE Subparameter Format (Part 1 of 2)
Subparameter Description
AUTO-ARCHIVE Determines whether SYSDATA is to be archived. Valid values
are:
s Y (Yes) Archive SYSDATA. Default.
s N (No) Do not archive SYSDATA. If this value is
specified for a job, restart of the job under
CONTROL-M/ Restart and SYSDATA viewing under
CONTROL-M is not possible.
SYSDB Determines whether all SYSDATA outputs are to be archived
to one predesignated data set or whether each SYSDATA
output is to be archived to its own data set. Valid values are:
s Y (Yes) SYSDATA of all jobs containing a SYSDB value of
Y are archived to a common data set. When the common
data set is full, another is automatically allocated and used
by the system. This is the recommended method. Default.
s N (No) SYSDATA of each job containing a SYSDB value
of N is archived to a unique data set.
Restart AUTO-ARCHIVE: PostProcessing Parameter
Chapter 3 Job Production Parameters 399
General Information
The AUTO-ARCHIVE subparameter allows you to decide whether to archive
SYSDATA, which is defined in SYSDATA on page 67. While archiving SYSDATA
is normally desirable, it might not be desirable for cyclic jobs, started tasks, or
frequently repeated jobs that do not require restart.
If archiving, the SYSDB subparameter allows you to decide whether SYSDATA for
different jobs must be archived to a common data set (Y) or whether to use a separate
data set for each run (N). If Y is entered, a single archived SYSDATA data set is used
for archiving until it is full. Then, another SYSDATA data set is allocated and used.
This is the recommended method.
Creating a separate data set for each run is not recommended because:
s Creating many data sets consumes a large amount of space in the disk VTOC.
s Each data set is allocated on a track basis. If the SYSDATA does not completely fill
the track, large amounts of disk space may be wasted.
The MAXDAYS and MAXRUNS subparameters define retention criteria for the
archived SYSDATA of jobs that ended NOTOK. Defaults are defined in the
CONTROL-M/ Restart installation parameters. You can specify either or both
parameters to override the defaults. If both parameters are specified, retention is
limited by the condition that is fulfilled first.
When archiving SYSDATA, BMC Software recommends that you do not enter the
value 99 in the MAXWAIT parameter for cyclic jobs or started tasks. Otherwise, these
jobs, which are never automatically deleted from the Active Jobs file, may cause the
disk to fill up with unnecessary archived SYSDATA. The MAXWAIT parameter is
described in MAXWAIT: Basic Scheduling Parameter on page 515.
MAXDAYS Maximum number of days to retain archived SYSDATA value
for jobs ended NOTOK. Must be a 2-digit number in the range
00 through 98 or 99. 99 means retain for an unlimited number
of days (until deleted by request).
MAXRUNS Maximum number of runs for which the archived SYSDATA
must be retained when the job ended NOTOK. Must be a
3-digit number in the range of 000 through 998 or 999. 999
means retain the SYSDATA of all runs.
Table 157 Restart AUTO-ARCHIVE Subparameter Format (Part 2 of 2)
Subparameter Description
Restart AUTO-ARCHIVE: PostProcessing Parameter
400 CONTROL-M for OS/390 and z/OS User Guide
AUTO-ARCHIVE and the History File
Restart SYSDATA is archived in the History Jobs file, as defined by the values set
for the MAXDAYS and MAXRUNS parameters, and under the following conditions:
s The HIST parameter in the CTMPARM member in the IOA PARM library is set to
Y (Yes), so that History file archiving is enabled.
s History file retention is specified in the job.
Restart However, if the HIST parameter is set to N (No) and a job is deleted from
the Active Jobs file, the SYSDATA relating to that job is deleted regardless of the
values set for the MAXDAYS and MAXRUNS parameters.
Restart For more information, see the description of maintaining previous runs in
the History Jobs file in the CONTROL-M/Restart User Guide.
NOTE
Specified parameters take effect only during execution of the New Day procedure
(CONTDAY) or the CTMCAJF utility. Therefore, it is possible to find more
generations of the same job than the current value of MAXRUNS.
Restart AUTO-ARCHIVE: PostProcessing Parameter
Chapter 3 Job Production Parameters 401
Example
Archive the SYSDATA to a common data set. Retain the archived SYSDATA for 7
days or 20 runs, whichever occurs first.
Figure 137 Restart AUTO-ARCHIVE Parameter Example
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS 07 MAXRUNS 020
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====








COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 44. 00
CONFCAL: Basic Scheduling Parameter
402 CONTROL-M for OS/390 and z/OS User Guide
CONFCAL: Basic Scheduling Parameter
Specifies the name of a calendar that is used to confirm the scheduling of the job.
Related parameters are DAYS: Basic Scheduling Parameter on page 420, WDAYS:
Basic Scheduling Parameter on page 654, and DATES: Basic Scheduling Parameter
on page 418.
Figure 138 CONFCAL Parameter Format

Optional. CONFCAL subparameters are described below.
Table 158 Optional CONFCAL Subparameters (Part 1 of 3)
Subparameter Description
CONFCAL A valid 1 through 8 character calendar (member) name.
This calendar is used for:
s validating scheduling dates
s determining the scheduled work day
Jobs to be scheduled on a day, based on other specified Basic
Scheduling criteria, are checked against the CONFCAL
calendar, as follows:
s If the day is a working day in the CONFCAL calendar, the
job is tentatively scheduled on that day. This day is
referred to as the original scheduling date. Actual
scheduling of the job is then determined by the value
entered in the SHIFT subparameter (described in this
table).
CONFCAL: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 403
s If the day is not a working day in the CONFCAL calendar,
the SHIFT subparameter is checked. Depending on the
SHIFT value, the job may be scheduled on an earlier or
later day, may be scheduled on that day, or may be
cancelled.
SHIFT Determines when and if the job must be scheduled. Optional.
The format of the SHIFT subparameter is xyyy, where
s x indicates how to shift scheduling of the job if the original
scheduling day of the job is not a working day in the
CONFCAL calendar. Valid values are:
' ' (Blank) No shifting occurs. The job is not scheduled.
Default.
> Job scheduling is shifted to the next working day in
the CONFCAL calendar. Additional shifting may be
performed, depending on the yyy value, described
below.
'< Job scheduling is shifted to the previous working
day in the CONFCAL calendar. Additional shifting may
or may not be performed, depending on the yyy value,
described below.
@ Tentatively schedule the job for the current day,
even if the current day is not a working day. Additional
shifting may or may not be performed, depending on
the yyy value, described below.
s yyy shifts scheduling of the job forward or backward the
specified number of working days, as defined in the
CONFCAL calendar. Valid values are:
' ' (Blank) Do not shift job scheduling any additional
time. Default.
+nn Shift job scheduling forward to next nth working
day, where n can be as many as 62 working days in the
future.
-nn Shift job scheduling backward to the previous nth
working day, where n can be as many as 62 working
days in the past.
Table 158 Optional CONFCAL Subparameters (Part 2 of 3)
Subparameter Description
CONFCAL: Basic Scheduling Parameter
404 CONTROL-M for OS/390 and z/OS User Guide
General Information
CONFCAL calendars are useful for handling holidays and other scheduling
exceptions.
CONFCAL is optional. If no value is set for the CONFCAL parameter, jobs are
scheduled according to other basic scheduling criteria without confirmation.
CONFCAL must not contain the name of a periodic calendar. If it does, no day can
pass the confirmation.
CONFCAL cannot be used with the PDS and MINIMUM parameters.
The SHIFT Subparameter
If no CONFCAL calendar is specified, no value can be entered in the SHIFT
subparameter, and this field has no effect on job scheduling.
The format and valid values of the SHIFT subparameter are described in Table 158.
The interaction between the x value and the yyy value of the SHIFT subparameter is
as follows:
s If the original scheduling day of the job is a working day in the CONFCAL
calendar, the x value is ignored and the yyy value determines when the job is
scheduled.
s If the original scheduling day of the job is not a working day in the CONFCAL
calendar, job scheduling is shifted according to the x value and then shifted again
according to the yyy value (if specified) to determine when the job is scheduled.
If the original scheduling day is not a working day and the x value is blank, the job is
not scheduled (regardless of whether a yyy value is specified).
If the result of shifting by yyy days is a day that is not allowed, that is, if -n was
entered for that day in the DAYS parameter of the job scheduling definition, the job is
shifted again to the next allowed working day (for a forward shift) or to the previous
allowed working day (for a backward shift).
Note: For more information on the use of the SHIFT
subparameter, see The SHIFT Subparameter below.
Table 158 Optional CONFCAL Subparameters (Part 3 of 3)
Subparameter Description
CONFCAL: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 405
Example 1
This example is based on the following assumptions:
s The current month is September 2001.
s Working days are defined in calendar WORKDAYS, which contains the following
working days (indicated by Y) for September 2001:
s Start of the week is defined as Monday. Weeks start on the following dates in
September: 3rd, 10th, 17th, and 24th.
Schedule the rule on the 1st, 7th and 15th day of the month if they are both Saturdays
and working days in WORKDAYS. If the day of the month (1st, 7th, 15th) is not a
Saturday, do not schedule the rule. If the day of the month is a Saturday but is not a
working day, schedule the rule on the next working day.
The rule is scheduled on the days of the month indicated by an asterisk:
Figure 139 Days When Job Scheduled
NOTE
Prior to version 5.1.4, the SHIFT subparameter consisted of only the x value. If the
yyy value is not specified, CONFCAL and SHIFT work as they did prior to version
5.1.4, and version 5.1.4 job scheduling definitions do not need to be changed.
---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 +
Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
DAYS - 1, 7, 15
AND/ OR - AND
WDAYS - 6
CONFCAL - WORKDAYS
SHI FT - >
CONFCAL: Basic Scheduling Parameter
406 CONTROL-M for OS/390 and z/OS User Guide
Example 2
Assume that the IOA installation parameter SWEEK was set to SUN (meaning that
Sunday is the first working day of the week.)
Schedule the job on every Thursday, except when Friday is a holiday. If Friday is a
holiday, schedule the job on the working day prior to Thursday.
Set the following parameter values:
WDAYS 6
CONFCAL WORKDAYS
SHI FT <- 01
CONFIRM: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 407
CONFIRM: Runtime Scheduling Parameter
Ensures manual confirmation before the job is submitted.
Figure 140 CONFIRM Parameter Format

Optional. Valid values are:
General Information
If CONFIRM is set to Y, the job appears in the Active Environment screen with a
WAIT CONFIRMATION (FOR SCHEDULE) status. Option C (Confirm) must then be
entered in the Active Environment screen for the job to be submitted. When the job is
confirmed in the Active Environment screen, the CONFIRM value in the Zoom screen
changes to N. If CONFIRM is set to N or left blank, the job is automatically submitted
by CONTROL-M at the first available opportunity.
Table 159 Optional CONFIRM Parameter Values
Parameter Description
Y (Yes) Confirmation required. The job is not submitted unless
manual confirmation is entered in the Active Environment
screen.
N (No) No confirmation required. The job can be automatically
submitted by CONTROL-M without manual confirmation.
Default.
NOTE
In the case of cyclic jobs, confirmation applies to the first run only. Once confirmed,
the job is recycled without waiting for subsequent confirmation.
CONFIRM: Runtime Scheduling Parameter
408 CONTROL-M for OS/390 and z/OS User Guide
Example
Job OPERCOMP requires manual confirmation in order to be eligible for submission.
Manual confirmation can be provided from the Active Environment screen once the
job is displayed with a status of WAIT CONFIRMATION (FOR SCHEDULE).
Figure 141 CONFIRM Parameter Example
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE I NI T 0001
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM Y
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
CONTROL: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 409
CONTROL: Runtime Scheduling Parameter
Ensures exclusive and/ or shared control over runtime resources.
Figure 142 CONTROL Parameter Format

Optional. A maximum of two resources can be specified in each CONTROL line.
Upon specifying the second resource in a CONTROL line and pressing Enter, a new
line is opened (for specifying additional resources).
Each CONTROL specification consists of the following mandatory subparameters:
In addition, if the resource is in Exclusive state in the Group entity, it must not
be specified in any of the jobs belonging to the group; if the resource is in Shared
state in the Group, it must not be in Exclusive state in any of the jobs belonging
to the group.
Table 160 Mandatory CONTROL Subparameters
Subparameter Description
res-name User-supplied, descriptive name of 1 through 20 characters
used to identify the resource.
state Type of control the job requires of the resource. Valid values
are:
s E The job requires exclusive control of the resource
during processing.
s S The job requires shared control of the resource during
processing.
NOTE
Do not specify the same Control resource in both Exclusive (E) and Share (S) states in
the same job scheduling definition or Group entity, or the job and/ or group cannot
run.
CONTROL: Runtime Scheduling Parameter
410 CONTROL-M for OS/390 and z/OS User Guide
General Information
The CONTROL parameter is used to control parallel execution of jobs (and/ or
groups).
If a job requires a resource in exclusive state, it cannot share usage of that resource
with another job (that is, the jobs cannot run in parallel). For example:
s If JOBA requires exclusive control of a resource that is already in use by a different
job, JOBA must wait until the other job frees the resource regardless of whether the
other job is using the resource in shared or exclusive state.
s If JOBA already has exclusive control of a resource, any job requiring that resource
must wait until JOBA frees the resource, regardless of whether the job requires the
resource in shared or exclusive state.
If a job requires a resource in shared state, that job can run in parallel with other jobs
requiring the same resource in shared state. For example:
s If JOBA requires shared control of a resource that is already in shared use by
different jobs, JOBA can use that resource at the same time.
s If JOBA already has shared control of a resource, any job requiring that same
resource in shared state can use that resource at the same time.
However:
s If JOBA requires shared control of a resource that is already in exclusive use by a
different job, JOBA must wait until the other job frees the resource.
s If JOBA already has shared control of a resource, any job requiring that same
resource in exclusive state must wait until JOBA frees the resource.
For more information, see Quantitative and Control Resources on page 73
Example
The following three screens (job scheduling definitions) indicate how the CONTROL
parameter can control resource usage. All three job scheduling definitions require
resource (disk) DISK-VS0020:
s The first job, BKPVS020, is a backup job that requires exclusive control of disk
DISK-VS0020.
s The other two jobs, CMPRSJOB and CMPRSSRC, are both compress jobs. They do
not require exclusive control (that is, they can share control) of disk DISK-VS0020.
CONTROL: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 411
The result is as follows:
s Jobs CMPRSJOB and CMPRSSRC can be run in parallel with each other, but
neither can run in parallel with job BKPUS020.
s If job BKPVS020 is running, jobs CMPRSJOB and CMPRSSRC must wait.
s If either job CMPRSJOB and/ or CMPRSSRC is running, job BKPVS020 must wait.
This is the first of the three jobs in the example (job BKPVS020).
Figure 143 CONTROL Parameter Example 1
JOB: BKPVS020 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BKPVS020 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS 3, 0 WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL DI SK- VS0020 E
RESOURCE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
CONTROL: Runtime Scheduling Parameter
412 CONTROL-M for OS/390 and z/OS User Guide
This is the second of the three jobs in the example (job CMPRSSRC).
Figure 144 CONTROL Parameter Example 2
This is the third of three jobs in the example (job CMPRSJOB).
Figure 145 CONTROL Parameter Example 3
JOB: CMPRSSCR LI B CTM. PROD. SCHEDULE TABLE: OPMAI NT
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM CMPRSSCR DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- 2- 3- 4- 5- 6- 7- 8- 9- 10- 11- 12-
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM 025 PDS GSD. DEPO. SCR
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL DI SK- VS0020 S
RESOURCE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
JOB: CMPRSJOB LI B CTM. PROD. SCHEDULE TABLE: OPMAI NT
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM CMPRSJOB DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- 2- 3- 4- 5- 6- 7- 8- 9- 10- 11- 12-
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM 020 PDS GSD. DEPO. JOB
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL DI SK- VS0020 S
RESOURCE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
CTB STEP: General Job Parameter
Chapter 3 Job Production Parameters 413
CTB STEP: General Job Parameter
Adds CONTROL-M/ Analyzer steps as the first and/ or last step of the execution of
the job.
Figure 146 CTB STEP Parameter Format

Optional. The CTB STEP parameter consists of the following subparameters:
Table 161 Optional CTB STEP Parameters
Parameter Description
AT Indicates where to place the CONTROL-M/ Analyzer step in
the job. Mandatory. Valid values are:
s START The indicated CONTROL-M/ Analyzer step must
become the first step of the job.
s END The indicated CONTROL-M/ Analyzer step must
become the last step of the job.
NAME Name of the CONTROL-M/ Analyzer entity. Must be a valid
name of a CONTROL-M/ Analyzer rule or mission.
Mandatory.
TYPE Type of CONTROL-M/ Analyzer entity. Mandatory. Valid
values are:
s RULE Entity is a CONTROL-M/ Analyzer rule.
s MISSION Entity is a CONTROL-M/ Analyzer mission.
ARGUMENTS Arguments to be passed to the CONTROL-M/ Analyzer step.
Optional.
NOTE
The ARGUMENTS line is not displayed until the CTB STEP line is filled in and Enter
is pressed.
CTB STEP: General Job Parameter
414 CONTROL-M for OS/390 and z/OS User Guide
General Information
A maximum of two CTB STEP statements (that is, one START statement and one
END statement) can be entered.
Upon filling in the first CTB STEP line on the screen and pressing Enter, the
ARGUMENTS line and the second CTB STEP line are displayed. If the second CTB
STEP line is filled in and Enter is pressed, its ARGUMENTS line is displayed.
Multiple arguments must be separated by a comma without a space because they are
automatically passed to the CONTROL-M/ Analyzer step as a PARM=arguments
parameter in the JCL of the step.
CONTROL-M uses the status returned by CONTROL-M/ Analyzer as it would use
the return status of any job step.
s If CONTROL-M/ Analyzer returns a status of OK or TOLER (within accepted
tolerances), CONTROL-M considers the step as having ended OK.
s If CONTROL-M/ Analyzer returns a status of NOTOK or ABEND, CONTROL-M
considers the job step as having ended NOTOK.
Example
After successfully performing salary calculations, job SACALC01 invokes rule
CHKCALC to ensure that the results are reasonable, and then sets OUT condition
SALARY-OK.
CTB STEP: General Job Parameter
Chapter 3 Job Production Parameters 415
Figure 147 CTB STEP Parameter Example
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME SACALC01 MEMLI B GENERAL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL SAL GROUP SALARY
DESC SALARY CALCULATI ONS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT END NAME CHKCALC TYPE RULE
ARGUMENTS %%ODATE
CTB STEP AT NAME TYPE
DOCMEM SACALC01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01, 15 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT SALARY- OK ODAT +
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
D-CAT: Basic Scheduling Parameter
416 CONTROL-M for OS/390 and z/OS User Guide
D-CAT: Basic Scheduling Parameter
Name of a CONTROL-D report decollating mission category that must be scheduled
under CONTROL-D when the job is scheduled under CONTROL-M.
Figure 148 DCAT Parameter Format

Optional. The D-CAT parameter must be 1 through 20 characters, or * for all
categories.
If this parameter is specified when CONTROL-D is not installed, New Day
processing stops immediately after this job. For a description of New Day processing,
see Chapter 6, Selected Implementation Issues, and the INCONTROL for OS/390 and
z/OS Administrator Guide.
General Information
If the parameter is specified, whenever the job is scheduled, a search is made in the
CONTROL-D report decollating mission library for a job (member) with the name
entered in the MEMNAME parameter, which is described in MEMNAME: General
Job Parameter on page 524, and with the same category. (No search is made in the
case of job restarts.)
Generally, the selected category is forced and placed in the CONTROL-D Active
Missions file (that is, the output of the job must be decollated by CONTROL-D). If
D-CAT is set to *, all categories of the job are forced under CONTROL-D.
NOTE
Prior to version 5.1.4, the D-CAT parameter was called CATEGORY.
D-CAT: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 417
Example
The job output must be decollated by the CONTROL-D report decollating mission
category DAILY.
Figure 149 DCAT Parameter Example
NOTE
If the CTGFORC parameter of the CTMPARM member in the IOA PARM library is
set to NO, selected categories are scheduled (that is, not forced).
JOB: GNRLDR12 LI B CTM. PROD. SCHEDULE TABLE: GNRLDR
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME GNRLDR12 MEMLI B GENERAL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL GENERAL GROUP GENERAL- LEDGER
DESC GENERAL LEDGER DAI LY REPORTS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM GNRLDR12 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS ALL DCAL WORKDAYS
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT DAI LY
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
==========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DATES: Basic Scheduling Parameter
418 CONTROL-M for OS/390 and z/OS User Guide
DATES: Basic Scheduling Parameter
Specifies dates, by month and day, on which the job must be scheduled for execution.
Figure 150 DATES Parameter Format

Optional. The DATES parameter specifies a valid 4-character date, in either mmdd or
ddmm format, depending on site format.
A maximum of 12 dates can be specified.
General Information
The job is scheduled for execution only on the dates specified in the DATES
parameter.
The DATES parameter cannot be used with the PDS, MINIMUM, DAYS, and DCAL
parameters.
If values are set for both the MONTHS parameter and the DATES parameter, the
MONTHS parameter setting is ignored.
To specify more than 12 dates for one job, define the dates in a calendar (instead of
using this parameter) and specify the calendar in the DCAL (or WCAL)
subparameter.
As an alternative to using calendars for specifying more than twelve dates in jobs
belonging to a group, up to twelve dates can be specified in a Schedule Tag definition
in the Group entity, and multiple schedule tags of this type can be defined. These can
then be specified in the jobs.
The relationship between DATES and WDAYS and WCAL is OR. If the job is to be
scheduled according to the DATES parameter or according to the WDAYS and
WCAL combination, it is scheduled.
DATES: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 419
Examples
Example 1
Schedule a job for the 15th of January (mmdd format).
Example 2
Schedule job PRDKPL01 for the 21st of June and the 21st of December (ddmm
format).
Figure 151 DATES Parameter Example
DATES 0115
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES 2106 2112
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- PROD- KPL ODAT
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DAYS: Basic Scheduling Parameter
420 CONTROL-M for OS/390 and z/OS User Guide
DAYS: Basic Scheduling Parameter
The days of the month on which the job must be scheduled.
Related parameters are WDAYS: Basic Scheduling Parameter on page 654 and
CONFCAL: Basic Scheduling Parameter on page 402.
Figure 152 DAYS Parameter Format

Optional. The DAYS parameter specifies days of the month on which the job must be
scheduled, provided other basic scheduling criteria are met. Values for DAYS can be
specified alone, or they can be specified together with a calendar specified in the
DCAL subparameter. DAYS and DCAL can also be specified together with WDAYS
and WCAL (described under WDAYS: Basic Scheduling Parameter on page 654).
The DAYS subparameters are described below:
Table 162 DAYS Subparameters (Part 1 of 2)
Subparameter Description
days Days of the month on which to schedule a job. The months in
which to order jobs are specified in the MONTHS parameter,
described in MONTHS: Basic Scheduling Parameter on
page 529. Various formats (described later) can be used to
specify DAYS (for example, 2 means the second day of the
month, L2 means the day before the last day of the month,
D1PA means the first day in period A).
DAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 421
Assuming all other basic scheduling criteria are met:
s When DAYS are specified without DCAL, the job is scheduled on the specified
days (in the specified months).
s When DCAL is specified without DAYS, the job is scheduled on all working days
marked in the DCAL calendar.
s When DAYS and DCAL are both specified, scheduling depends on how the
working days are defined in the calendar and the values or format of the DAYS
parameter combine, as described in the following paragraphs.
s When both DAYS and WDAYS criteria are specified, scheduling depends on the
AND/ OR subparameter connecting them.
Valid Formats for DAYS
Valid formats for the DAYS parameter, and how they relate to DCAL, are described
in the following paragraphs.
DCAL Name of a calendar containing a predefined set of dates
(referred to as working days) on which a job must be
scheduled. A specified value must be either a valid member
name of 1 through 8 characters, or an * to indicate that the
calendar specified in the CONFCAL parameter must be used
for scheduling. For more information on how to define, use
and modify calendars, see IOA Calendar Facility on
page 301.
Note: A calendar specified in DCAL does not have to exist
when defining the DAYS parameter. It must exist when the job
is being ordered.
AND/ OR Conjunctional parameter used to link the DAYS and WDAYS
parameters when both are specified.
s A (AND) Both DAYS (/ DCAL) and WDAYS (/ WCAL)
criteria must be met in order for a job to be scheduled.
s O (OR) DAYS (/ DCAL) and/ or WDAYS (/ WCAL)
criteria must be met for a job to be scheduled. Default.
If A (AND) is specified when either DAYS or WDAYS is
specified (but not both), the missing DAYS or WDAYS value is
automatically set to ALL.
Table 162 DAYS Subparameters (Part 2 of 2)
Subparameter Description
DAYS: Basic Scheduling Parameter
422 CONTROL-M for OS/390 and z/OS User Guide
In the following non-periodic scheduling formats:
s n is an integer from 1 through 31.
s Multiple values can be specified (separated by commas) in any order.
s A calendar name specified for DCAL must not designate a periodic calendar.
Table 163 Non-Periodic Scheduling Formats (Part 1 of 2)
Parameter Description
ALL All days of the month. If ALL is specified, other DAYS values
cannot be specified with it.
If a DCAL calendar is not defined, schedule the job on all days
in the month. If a DCAL calendar is defined, schedule the job
only on the working days indicated in the calendar.
n, Specific days of the month.
If a DCAL calendar is not defined, schedule the job on the
specified days.
If a DCAL calendar is defined, schedule the job only when a
day is defined as a working day in both the DAYS parameter
and the DCAL calendar.
+n,... Days of the month in addition to the working days specified in
the DCAL calendar. DCAL is mandatory.
n,... Order the job on all days except the nth day from the
beginning of the month. DCAL is mandatory.
>n,... Order the job on the indicated day if it is a working day in the
DCAL calendar; otherwise, order the job on the next working
day that is not negated by a n value in this parameter. This
format is frequently used for holiday handling. DCAL is
mandatory.
<n,... Order the job on the indicated day if it is a working day in the
DCAL calendar; otherwise, order the job on the last previous
working day of the month that is not negated by a n value in
this parameter. This format is frequently used for holiday
handling. DCAL is mandatory.
Dn,... Order the job on the nth working day from the beginning of
the month. DCAL is mandatory.
Dn,... Order the job on all working days except the nth working day
from the beginning of the month. DCAL is mandatory.
DAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 423
In the following periodic scheduling formats:
s n is any integer from 1 through 63, and i is any valid period identifier.
s An * can be specified as the i value to represent all periods.
s An * can be specified as the n value in format DnPi to represent all days. (* is not a
valid n value in formats DnPi, LnPi and LnPi.)
s A period can span any number of days, but by default, no more than 33 days can
elapse after the appearance of one identifier in a period until the appearance of the
next matching identifier in the same period. Once a gap of 33 days has been
reached, the period automatically closes. However, the INCONTROL
administrator can change the 33-day default by changing the value in member
IOADFLT in the IOAENV library.
s The name of a periodic calendar must be specified in DCAL. For details about
periodic calendars, see IOA Calendar Facility on page 301.
Ln,... Order the job on the nth day (or nth working day if DCAL is
defined) counting backward from the end of the month. DCAL
is optional.
Ln,... If DCAL is defined, order the job on all working days except
the nth working day counting backward from the end of the
month. If DCAL is not defined, order the job on all days except
the nth day counting backward from the end of the month.
DCAL is optional.
Table 164 Periodic Scheduling Formats
Format Description
DnPi,... Order the job on the nth day of period i from the beginning of
the period.
DnPi,... Order the job on all days of period i except the nth day of
period i from the beginning of the period.
LnPi,... Order the job on the nth day of period i counting backward
from the last day of the period.
LnPi,... Order the job on all days of period i except the nth day of
period i counting backward from the last day of the period.
Table 163 Non-Periodic Scheduling Formats (Part 2 of 2)
Parameter Description
DAYS: Basic Scheduling Parameter
424 CONTROL-M for OS/390 and z/OS User Guide
General Information
Negative values take precedence over positive values when determining whether a
job must be scheduled on a certain date. If a negative value (that is, format n, Dn,
Ln, DnPi, or LnPi) in either the DAYS or WDAYS field prevents a job from being
scheduled on a date, the job is not scheduled on that date even if a positive value
(such as Ln) in a basic scheduling parameter would otherwise result in the job being
scheduled on that date.
A maximum of eight periodic values of type DnPi, DnPi, LnPi, and/ or LnPi can be
designated in any desired order.
If periodic and non-periodic values are mixed when specifying the DAYS parameter,
processing depends on the calendar type specified in the DCAL parameter:
s If a non-periodic calendar is specified in DCAL, only non-periodic values in the
DAYS parameter are processed; periodic values are ignored. In this case, negative
periodic values (that is, DnPi, LnPi) are also ignored and do not supersede other
values.
s If a periodic calendar is specified in DCAL, all periodic values and all negative
non-periodic values (such as n) in the DAYS parameter are processed; all
non-negative non-periodic values are ignored.
The MONTHS parameter is ignored when periodic values are specified in the DAYS
parameter.
For information about certain exceptional situations in the interaction of the DAYS
and MONTHS parameters, see MONTHS: Basic Scheduling Parameter on
page 529.
The DAYS parameter cannot be used with the PDS, MINIMUM, and DATES
parameters.
Examples
The examples in this chapter are based on the following assumptions:
s The current month is December, 2001.
s Working days are defined in calendar WORKDAYS, which contains the following
working days (indicated by Y) for December, 2001.
- - - 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 + 1
Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
DAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 425
s WDAYS are defined as working days beginning on Monday.
s Periodic calendar PERIDAYS contains the following periodic definition for
December 2001. These examples assume that all other days of this calendar are
blank.
s Start of the week is defined as Monday. Weeks start on the following dates in
December 2001: 3rd, 10th, 17th, 24th, and 31st.
At the end of each example, asterisks in a December 2001 calendar indicate the days
on which the job is scheduled.
Example 1
Schedule the job on the 17th day and the last day of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 153 DAYS Parameter Example 1
Example 2
Schedule the job on all working days of the month except the 6th day of the month,
and also schedule the job on the 1st day of the month.
- - - 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 + 1
B C A A B B C A A B B C A A B B C A A B B
DAYS 17, L1
DAYS +1, - 6
DCAL WORKDAYS
DAYS: Basic Scheduling Parameter
426 CONTROL-M for OS/390 and z/OS User Guide
The job is scheduled on the days of the month indicated by an asterisk:
Figure 154 DAYS Parameter Example 2
Example 3
Schedule the job on all working days of the month except the first and last working
days, and except the 17th day, of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 155 DAYS Parameter Example 3
Example 4
Schedule the job on the 8th day of the month. If it is not a working day, schedule the
job on the closest preceding working day.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 156 DAYS Parameter Example 4
DAYS - D1, - 17, - L1
DCAL WORKDAYS
DAYS <8
DCAL WORKDAYS
DAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 427
Example 5
Schedule the job on the 1st day of period A, and on all days, except the 2nd day, of
period B. Do not schedule the job on the 5th day of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 157 DAYS Parameter Example 5
Example 6
Schedule the job on each Monday and on the 1st day of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 158 DAYS Parameter Example 6
Example 7
Schedule the job on the 3rd day of the month provided it is a Monday.
DAYS - 5, D1PA, - D2PB
DCAL PERI DAYS
DAYS 1
AND/ OR OR
WDAYS 1
DAYS 3
AND/ OR AND
WDAYS 1
DAYS: Basic Scheduling Parameter
428 CONTROL-M for OS/390 and z/OS User Guide
The job is scheduled on the days of the month indicated by an asterisk:
Figure 159 DAYS Parameter Example 7
Example 8
Schedule the job on the last Monday of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 160 DAYS Parameter Example 8
Example 9
Schedule the job on the 1st, 7th and 15th days of the month if they are both Saturdays
and working days. If the day of the month (1st, 7th, 15th) is not a Saturday, do not
schedule the job. If the day of the month is a Saturday, but it is not a working day,
schedule the job on the next working day.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 161 DAYS Parameter Example 9
DAYS L1, L2, L3, L4, L5, L6, L7
AND/ OR AND
WDAYS 1
DAYS 1, 7, 15
AND/ OR AND
WDAYS 6
CONFCAL WORKDAYS
SHI FT >
DAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 429
Example 10
Schedule the job to run on the first Friday after the 15th of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 162 DAYS Parameter Example 10
Example 11
Schedule the job to run on the 15th day of every period, except for period G. The
periods are defined in periodic calendar PERCAL.
The following steps are required:
1 In the group entity of a group scheduling table, define a tag, TAG1, which contains
the following scheduling criteria:
DAYS - D15PG, D15P* DCAL PERCAL
2 In the actual job definition, specify the following:
SCHEDULE TAG TAG1
RELATI ONSHI P ( AND/ OR) A
DAYS D15P* DCAL PERCAL
DAYS 16, 17, 18, 19, 20, 21, 22
AND/ OR AND
WDAYS 5
DEFINITION ACTIVE: Basic Scheduling Parameter
430 CONTROL-M for OS/390 and z/OS User Guide
DEFINITION ACTIVE: Basic Scheduling
Parameter
Specifies the time limits (FROM, UNTIL) for using the job scheduling definition.
Figure 163 DEFINITION ACTIVE Parameter Format
Optional. The parameters include the following two subparameters.
The format of either the FROM or UNTIL subparameters may be ddmmyy, mmddyy,
or yymmdd, depending on your local site standard, as set by the DATETYP
parameter in the IOAPARM member in the IOA PARM library.
General Information
FROM and UNTIL dates together define a time frame for ordering the job. Unless
forced, a job can only be ordered during the specified time frame. However, if the job
is forced, the FROM and UNTIL parameters are ignored.
s If you specify both the FROM and UNTIL subparameters for a particular job, the
job can only be ordered on or later than the date specified in the FROM
subparameter, and on or earlier than the date specified in the UNTIL
subparameter. There are two possibilities:
Table 165 DEFINITION ACTIVE Subparameters
Subparameter Description
FROM 6-digit date. The job scheduling definition will only be used if
the ordering date is later than the date specified. Default:
(Blank)
UNTIL 6-digit date. The job scheduling definition will only be used if
the ordering date is earlier than the date specified. Default:
(Blank)
DEFINITION ACTIVE: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 431
1. The date specified in the FROM subparameter is earlier than that specified in the
UNTIL subparameter.
For example,
DEFI NI TI ON ACTI VE FROM 091002 UNTI L 011102
The job can only be ordered on or between October 9, 2002 and November 1,
2002.
2. The date specified in the FROM subparameter is later than that specified in the
UNTIL subparameter.
For example,
DEFI NI TI ON ACTI VE FROM 090502 UNTI L 010402
The job can only be ordered on or after May 9, 2002, or before or on April 1,
2002, but not between those dates.
s If you specify the FROM subparameter, but not the UNTIL subparameter, the job
cannot be ordered before the date specified, but can be ordered on or at any time
later than that date.
For example,
DEFI NI TI ON ACTI VE FROM 091002 UNTI L
The job can only be ordered on or after October 9, 2002.
s If you do not specify the FROM subparameter, but specify the UNTIL
subparameter, the job can be ordered on or at any time earlier than the date
specified, but not later than that date.
For example,
DEFI NI TI ON ACTI VE FROM UNTI L 011102
The job can only be ordered on or before November 1, 2002.
s If you do not specify either the FROM or UNTIL subparameters, there is no
restriction on the date when the job can be ordered.
For example,
DEFI NI TI ON ACTI VE FROM UNTI L
The job can be ordered on any date.
DESC: General Job Parameter
432 CONTROL-M for OS/390 and z/OS User Guide
DESC: General Job Parameter
Description of the job to be displayed in the Job List screen.
Figure 164 DESC Parameter Format

Optional. This parameter may consist of text of 1 through 50 characters.
General Information
The DESC parameter is informational. It does not affect job processing. It serves as
internal documentation, to let the user know the purpose of (or some other key
information about) the job.
The description specified in the DESC parameter appears to the right of the job name
in the Job List screen.
Text for the DESC parameter can be specified in any language.
For information on how to specify more detailed job documentation, see Job
Documentation on page 146
NOTE
For conversion customers prior to version 6.0.00, if the current job was converted
from another job scheduling product, such as CA-7, the string
SCHEDULE-PREV-DAY or SCHEDULE-PREV-ONLY may appear in the DESC field
for the job group. This string causes all scheduled runs of the job to be shifted back
one day. The SAC parameter is used instead.
DESC: General Job Parameter
Chapter 3 Job Production Parameters 433
Example
Job OPERCOMP appears in the Job List screen with the description: JOB RUN ON
THE 1ST OF THE MONTH.
Figure 165 DESC Parameter Example
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO Statement: PostProcessing Parameter
434 CONTROL-M for OS/390 and z/OS User Guide
DO Statement: PostProcessing Parameter
Actions taken when the ON step and codes event criteria are satisfied.
Figure 166 DO Parameter Format

Optional. Specify DO statements as follows:
s Type the action keyword (such as COND) in the DO field and press Enter.
s In many cases, subparameter fields are displayed. Fill in the subparameters and
press Enter again.
s Multiple DO statements can be specified. After entering a DO statement, another
DO line is automatically displayed.
The following are valid DO actions. Each is discussed in detail, later.
Table 166 DO Actions (Part 1 of 2)
DO Action Description
DO COND Adds and/ or deletes a prerequisite condition.
DO CTBRULE Invokes a CONTROL-M/ Analyzer rule.
DO FORCEJOB Forces a job order under CONTROL-M.
Restart DO
IFRERUN
If a rerun is necessary for the job, specifies restart parameters
for CONTROL-M/ Restart.
DO MAIL Sends an e-mail to the specified recipients.
DO NOTOK Sets the job step status to NOTOK.
DO OK Sets the job step status to OK.
DO RERUN Reschedules the job (for rerun).
DO SET Assigns a value to an AutoEdit variable.
DO SHOUT Sends a message to a specified destination.
DO Statement: PostProcessing Parameter
Chapter 3 Job Production Parameters 435
General Information
DO statements are generally paired with the preceding ON PGMST, ON PROCST, or
ON CODES statements (all of which are described in this chapter). Their implied
relationship is:
All specified DO statements have an AND relationship.
To add an empty DO statement between two existing DO statements, type the >
character over the first letter in the DO field of the earlier DO statement, and press
Enter.
Example
>OND is restored to its original value, COND, when Enter is pressed (the > character
disappears).
To delete unwanted DO statements, either delete the DO keyword and press Enter or
specify appropriate Line Editing commands in the Edit environment, which is
described in Appendix A, The CONTROL-M Application Program Interface
(CTMAPI),
DO STOPCYCL Stops recycling a cyclic task.
DO SYSOUT Handles the job output.
Table 167 Relationship of DO Statements with Other Statements
Statement Description
IF On step and code event criteria (specified in the ON PGMST,
ON PROCST, or ON CODES statements) are satisfied.
THEN Perform all actions specified in the DO statements.
DO >OND
Table 166 DO Actions (Part 2 of 2)
DO Action Description
DO COND: PostProcessing Parameter
436 CONTROL-M for OS/390 and z/OS User Guide
DO COND: PostProcessing Parameter
Specifies prerequisite conditions to be added or deleted if the accompanying ON step
and code criteria are satisfied.
Figure 167 DO COND Parameter Format

Optional. Type COND in the DO field and press Enter.
A maximum of two prerequisite conditions can be specified in each standard DO
COND line. One prerequisite condition can be specified in each long DO COND line.
When you specify the second prerequisite condition in a standard DO COND line, or
one prerequisite condition in a long DO COND line, and press Enter, a new DO
COND line is opened for specifying additional prerequisite conditions. For more
information, see Specifying Long DO COND Condition Names on page 440.
Each DO COND statement consists of the following mandatory subparameters:
NOTE
DO COND and OUT statements are similar, but not identical. The differences are
outlined in Differences between OUT and DO COND on page 441.
DO COND: PostProcessing Parameter
Chapter 3 Job Production Parameters 437
Table 168 DO COND Mandatory Subparameter Formats (Part 1 of 2)
Subparameter Description
cond-name User-supplied descriptive name of 1 through 39 characters,
used to identify the condition.
Note: A condition name must not begin with the symbols | ,
, or \ , and must not contain parentheses ( ), because each
of these characters has a special meaning.
AutoEdit variables specified for the COND-NAME
subparameter are not resolved, except for %%$GRID
variables. For more information on %%$GRID variables, see
Table 231, on page 5-737
dateref 4-character date reference. Valid values are:
s date A specific date, in either mmdd or ddmm format,
depending on the site standard
s ODAT Resolves to the original scheduling date. Default.
s PREV Resolves to the previous date on which the job
ought to have been scheduled, according to its basic
scheduling criteria (or ODATE1 for a forced job).
s NEXT Resolves to the next date on which the job is
scheduled, according to its basic scheduling criteria (or
ODATE+1, for a forced job.)
s STAT Static. Indicates that the condition (such as
IMS-ACTIVE) is not date-dependent.
Note: Before STAT was introduced, date 0101 was
recommended to be used in conditions that were not
date-dependent. Unlike 0101, STAT is not a date, and it
operates differently. Always use STAT when defining
conditions that are not date-dependent.
s **** Any scheduling date. Valid only with opt set to
- (Minus)
s $$$$ Any scheduling date. Valid only with opt set to
- (Minus)
Note: If a date reference is not specified, the value ODAT is
automatically inserted upon pressing Enter.
DO COND: PostProcessing Parameter
438 CONTROL-M for OS/390 and z/OS User Guide
General Information
When a DO COND statement is activated, the specified prerequisite conditions are
added to or deleted from the IOA Conditions file according to the value set for opt.
Prerequisite conditions are usually used to establish job dependencies or ensure
manual intervention when required.
s To establish a job dependency, define a prerequisite condition in an OUT or DO
COND statement in the job that must run first, and in an IN statement in the job
that must run afterwards.
The job containing a prerequisite condition in its IN statement is not submitted
unless that prerequisite condition has been added manually or by the job
containing an OUT or DO COND statement.
An OUT statement is used to add the prerequisite condition if the job ends OK.
Use a DO COND statement to add the prerequisite condition if the step and code
event criteria specified in the accompanying ON statement are satisfied.
s If the IN prerequisite condition can only be satisfied by manual intervention (for
example, TAPE1-ARRIVED is set by the operator after an external tape has arrived
insight), performance of the required manual intervention before job submission is
ensured.
OUT and DO COND statements can also be used to delete prerequisite conditions.
The OUT statement of the job can be used to delete the prerequisite condition after
the job ends OK. A DO COND statement can be used to delete prerequisite conditions
if the accompanying ON step and code criteria are satisfied.
These statements are generally used to delete prerequisite conditions either to
prevent a particular job from running or when the condition is no longer needed by
any other jobs in the Active Jobs file.
DO COND functions are performed after the functions of the OUT parameter.
opt Indicates whether to add or delete the specified prerequisite
condition. Valid values are:
s + (Plus) Add (create) the prerequisite condition
s - (Minus) Delete the prerequisite condition
Table 168 DO COND Mandatory Subparameter Formats (Part 2 of 2)
Subparameter Description
DO COND: PostProcessing Parameter
Chapter 3 Job Production Parameters 439
s If a prerequisite condition is added by the OUT parameter and deleted by the DO
COND parameter, the combined effect is the deletion of the prerequisite condition.
s If a prerequisite condition is deleted by the OUT parameter and added by the DO
COND parameter, the combined effect is the addition of that prerequisite
condition.
The following are examples of prerequisite conditions:
All prerequisite conditions are associated with a date reference that is used to
distinguish between different runs of the same job with different scheduling dates. If,
for example, a condition is being deleted, only the condition matching the specified
date is deleted. The same condition associated with a different date is not deleted.
When adding or deleting prerequisite conditions, the date associated with the
prerequisite condition can be a specific 4-character date or one of the following
symbolic dates:
Prerequisite conditions created by a DO COND statement can trigger the execution of
other jobs or processes.
Prerequisite conditions deleted by a DO COND statement can prevent the execution
of jobs and processes whose IN statements require those prerequisite conditions.
If two or more DO COND statements are contradictory, statements performed earlier
are overridden by statements that are performed later.
I MS- ACTI VE
JOB_PAYCALC_ENDED_OK
TAPE1_LOADED
Table 169 Prerequisite Condition Symbolic Dates
Symbolic Date Description
ODAT Adds or deletes the prerequisite condition with the original
scheduling date of the job.
PREV Adds or deletes the prerequisite condition with the previous
scheduling date of the job (or ODATE1 for a forced job).
STAT Adds or deletes prerequisite condition with the date value
STAT.
NEXT Adds or deletes the prerequisite condition with the next
scheduling date of the job (or ODATE+1 for a forced job).
**** Valid only when deleting prerequisite conditions. Deletes all
matching prerequisite conditions regardless of date.
$$$$ Valid only when deleting prerequisite conditions. Deletes all
matching prerequisite conditions regardless of date.
DO COND: PostProcessing Parameter
440 CONTROL-M for OS/390 and z/OS User Guide
For more information regarding prerequisite conditions, see IN: Runtime
Scheduling Parameter on page 497, ON: PostProcessing Parameter on page 534,
and OUT: PostProcessing Parameter on page 554, and see Prerequisite
Conditions on page 69.
Specifying Long DO COND Condition Names
Regular prerequisite conditions are not more than 20 characters in length. If you want
to specify a longer condition name, up to 39 characters in length, enter the string
LONG in the date reference field of an empty DO COND condition line. An (L)
appears at the beginning of the line. If the field already contains data, entering the
string LONG will open a new long DO COND parameter, with (L) appearing at the
beginning of the line. You can now insert a long condition name, as illustrated in
Figure 168.
Specify SHRT in the date reference field to revert back to condition names of standard
length.
Figure 168 Long DO COND Condition
NOTE
Long condition names cannot be used in CMEM rule definitions.
JOB: I EFBR14 LI B CTMP. V610. SCHEDULE TABLE: PHI LL1
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
I N CTM- DAI LYPRD- ENDEDXX ODAT CTM- DAI LYSYS- ENDEDXX ODAT
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
==========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST +EVERY PROCST STEP1 CODES SOC4 A/ O
DO COND ( L) THI S- I S- A- LONG- DO- C0ND- CONDI TI ON- NAME ODAT
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN NOTOK TO OPER2 URGN R
MS LOADI NG OF MANUAL CONDI TI ONS SCREEN FAI LED. CALL OP MANAGER.
SHOUT WHEN TO URGN
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 30. 17
DO COND: PostProcessing Parameter
Chapter 3 Job Production Parameters 441
Differences between OUT and DO COND
OUT and DO COND statements have the following differences:
s An OUT statement is applied only if the job ends OK. DO COND statements are
associated with accompanying ON statements and are applied only if the
accompanying ON step and code criteria are satisfied.
s An OUT statement appears in each job scheduling definition. No DO COND
statement appears unless specified. To specify a DO COND statement, type COND
in an empty DO field and press Enter.
s DO COND statements are processed after OUT statements and can therefore
override OUT statements.
s MVS restart can only be requested from an OUT statement, not a DO COND
statement.
Example
The following example provides a simplified demonstration of how CONTROL-M
can be used to monitor IMS. Prerequisite conditions, CHANGE-ACCUMULATION
and LOGCLOSE-NEEDED, can be used as IN prerequisite conditions to trigger the
execution of IMS maintenance jobs that depend on those conditions.
Figure 169 DO COND Parameter
JOB: I MSPROD LI B CTM. PROD. SCHEDULE TABLE: I MSPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT I MS- ACTI VE * * * * -
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST STEP01 PROCST CODES U0421 A/ O
DO COND CHANGE ACCUMULATI ON ODAT +
DO
ON PGMST STEP01 PROCST CODES U0428 A/ O
DO COND LOGCLOSE- NEEDED ODAT +
DO
ON PGMST STEP01 PROCST CODES U0426 A/ O
DO SHOUT TO U- DBA URGENCY V
= * * * I MSPROD ABENDED WI TH U0426 * * * *
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO CTBRULE: PostProcessing Parameter
442 CONTROL-M for OS/390 and z/OS User Guide
DO CTBRULE: PostProcessing Parameter
Invokes a CONTROL-M/ Analyzer rule to be executed during the processing of a
specific program step. Available only at sites utilizing CONTROL-M/ Analyzer.
Figure 170 DO CTBRULE Parameter Format

Optional. Type CTBRULE in the DO field and press Enter. The following
subparameters are displayed:
General Information
When DO CTBRULE is specified, balancing is performed by the
CONTROL-M/ Analyzer Runtime environment according to the specified rule
definition and using the specified arguments. The CONTROL-M/ Analyzer Runtime
environment is invoked once for each DO CTBRULE statement in the job scheduling
definition.
Table 170 DO CTBRULE Subparameters
Subparameter Description
rule_name Name of the CONTROL-M/ Analyzer rule that is to be
executed. The CONTROL-M/ Analyzer rule contains all
balancing specifications to be performed. The rule name can
be a maximum of eight characters. Mandatory.
arg Arguments that are passed to the CONTROL-M/ Analyzer
rule. Separate multiple arguments by commas. A maximum of
45 characters can be specified. Optional.
NOTE
If DO CTBRULE is specified under ON PGMST ANYSTEP, the
CONTROL-M/ Analyzer Runtime environment is invoked only once.
DO CTBRULE: PostProcessing Parameter
Chapter 3 Job Production Parameters 443
When CONTROL-M calls a CONTROL-M/ Analyzer rule, the
CONTROL-M/ Analyzer System variable SYSOPT contains the value CTMWORK.
This variable can then be tested within the CONTROL-M/ Analyzer rule definition to
determine if CONTROL-M invoked the CONTROL-M/ Analyzer Runtime
environment.
When the CONTROL-M/ Analyzer Runtime environment is invoked by
CONTROL-M, that is, the CONTROL-M/ Analyzer System variable SYSOPT is set to
CTMWORK, CONTROL-M/ Analyzer can analyze and balance SYSDATA. For more
information about invoking CONTROL-M/ Analyzer rules from CONTROL-M job
scheduling definitions, see the discussion of the interface to CONTROL-M in the
CONTROL-M/Analyzer FOR OS/390 and z/OS User Guide.
Example
If the job ends OK, execute CONTROL-M/ Analyzer balancing rule GOVTBAL.
Figure 171 DO CTBRULE Parameter Example
JOB: GOVTREPT LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT FI NANCE- GOVTREPT- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES OK A/ O
DO CTBRULE = GOVTBAL ARG DOREPORT, 10, %%ODATE
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN NOTOK TO TSO- M44 URGN R
MS JOB GOVTREPT ENDED " NOT OK"
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======

COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO FORCEJOB: PostProcessing Parameter
444 CONTROL-M for OS/390 and z/OS User Guide
DO FORCEJOB: PostProcessing Parameter
Force one or more jobs under CONTROL-M.
Figure 172 DO FORCEJOB Parameter Format

Optional. Type FORCEJOB in the DO field and press Enter. The following
subparameters are displayed:
General Information
The DO FORCEJOB statement schedules jobs under CONTROL-M even if the jobs are
not normally scheduled on the specified date (according to the Basic Scheduling
parameters of the job). It is similar to the FORCE option in the CONTROL-M Rule
List screen or Table List screen.
Table 171 FORCEJOB Subparameter Formats
Subparameter Description
TABLE Name of CONTROL-M scheduling table.
JOB Job name. If this field is blank, all jobs in the specified table are
forced.
DATE 6-character scheduling date for the jobs. Valid values are:
s date Specific date (in either mmddyy, ddmmyy or
yymmdd format, depending on the site standard).
s ODAT Resolves to the CONTROL-M original scheduling
date of the job. Default.
s DATE Resolves to the current system date.
LIBRARY Name of the scheduling library containing the specified table.
DO FORCEJOB: PostProcessing Parameter
Chapter 3 Job Production Parameters 445
If the DO FORCEJOB statement specifies a job name belonging to multiple jobs in the
table, the first job in the table with that job name is forced.
Without the DO FORCEJOB statement, emergency jobs and jobs that run in special
circumstances would require daily scheduling or manual forcing (from the Online
facility). By defining appropriate ON criteria and DO FORCEJOB statements,
emergency or other special jobs can be automatically forced when required without
being previously scheduled.
The DO FORCEJOB statement causes the CONTROL-M monitor to dynamically
allocate the job scheduling library specified in the LIBRARY parameter using the
DD name ONSPLT.
Example
On any system or user abend on any step in job PRDKPL01, force emergency job
PRDKPLSP.
Figure 173 DO FORCEJOB Parameter Example
NOTE
When a DO FORCEJOB request fails because the scheduling table is in use,
CONTROL-M may try again to execute the job, depending on the values set for the
FORCE#RT and FORCE#WI installation parameters. For more information on the
FORCE#RT and FORCE#WI installation parameters, see the customization chapter of
the INCONTROL for OS/390 and z/OS Installation Guide.
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT PRDKPL01- ENDED- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES S* * * U* * * * A/ O
DO FORCEJOB TABLE EMRJOBS JOB PRDKPLSP DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN NOTOK TO TSO- T43 URGN R
MS PRDKPL01 ENDED NOT OK, PLEASE CHECK I T
SHOUT WHEN LATE 0200 TO U- SHI FT- MANAGER URGN R
MS PRDKPL01 WAS NOT SUBMI TTED YET, PLEASE CHECK WHY
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
RestartDO IFRERUN: PostProcessing Parameter
446 CONTROL-M for OS/390 and z/OS User Guide
RestartDO IFRERUN: PostProcessing
Parameter
Job steps to be executed during restart of a job. Available only at sites utilizing
CONTROL-M/ Restart.
Figure 174 Restart DO IFRERUN Parameter Format
Optional. Type IFRERUN in the DO field and press Enter. The following
subparameters are displayed:
RestartDO IFRERUN: PostProcessing Parameter
Chapter 3 Job Production Parameters 447
Table 172 Restart DO IFRERUN Subparameter Formats (Part 1 of 2)
Subparameter Description
FROM Step at which the job must be restarted. Mandatory. Valid
values are:
s pgmstep program step within the job stream (see the
following note)
s pgmstep.procstep program step within the called
procedure (see the following note)
s $FIRST first step of the job
s $ABEND step of the job that ended NOTOK due to
system abend, user abend, condition code C2000 (PL/ 1
abend) or JFAIL (job failed on JCL error)
$ABEND is a subset of $EXERR (below)
s $FIRST.$ABEND first step of the abended procedure
s $FIRST.$CLEANUP this reserved keyword instructs
CONTROL-M to run a CONTROL-M/ Restart data set
cleanup for the job
Data set cleanup is performed from the first step of the job.
The job itself is not restarted
s $EXERR job step that ended with any error, including an
abend, or that ended with a condition code that is
redefined using the ON and DO statements as ENDED
NOTOK
Note: If, during a restart of the job, the CONTROL-M/ Restart
step itself ends NOTOK, you must manually correct the
problem encountered by the CONTROL-M/ Restart step and
then restart the job once again. In such a case,
CONTROL-M/ Restart does both of the following:
s It restores DO IF RERUN decisions to their state before the
last execution of the job.
s It deactivates the DO RERUN action.
This enables CONTROL-M/ Restart to ignore the occurrence
where the error arose during the operation of
CONTROL-M/ Restart itself. This prevents rerun processing
from looping.
RestartDO IFRERUN: PostProcessing Parameter
448 CONTROL-M for OS/390 and z/OS User Guide
General Information
When a DO IFRERUN statement is specified, the rerun is performed by the Restart
facility of CONTROL-M/ Restart using the specified restart subparameters.
TO Step at which the restarted job must terminate. Optional. Valid
values are:
s pgmstep Program step within the job stream (see the
following note).
s pgmstep.procstep Program step within the called
procedure (see the following note).
If not specified, the restarted job terminates at the last job step
that would normally be executed.
Note: For both FROM and TO steps, pgmstep is the name of the
step (EXEC statement) that executes the program from which
to begin or end the restart:
/ / pgmstep EXEC PGM=program
procstep is the name of the step (EXEC statement) that invokes
the procedure from which the above pgmstep program is
executed:
/ / procstep EXEC procedure
pgmstep and procstep values can each be 1 through 8 characters.
When specifying a procstep when the procedures are nested,
the innermost procstep in which the program is included must
be specified.
CONFIRM Specifies whether a manual confirmation is required before
the job is restarted. Valid values are:
s Y (Yes) Confirmation required. The job restart is not
submitted unless a manual confirmation is entered in the
Active Environment screen.
s N (No) No confirmation required. The job restart can be
automatically submitted (by the DO RERUN statement)
without a manual confirmation. Default.
Table 172 Restart DO IFRERUN Subparameter Formats (Part 2 of 2)
Subparameter Description
RestartDO IFRERUN: PostProcessing Parameter
Chapter 3 Job Production Parameters 449
s When DO IFRERUN is specified with a CONFIRM value of N (No):
If a DO RERUN statement follows, the job is automatically submitted for rerun.
If a DO RERUN statement does not follow, the job is not automatically rerun.
Instead, the job remains displayed with its error status in the Active
Environment screen.
In this case, to submit the job for rerun or restart, specify option R (Rerun) in the
Active Environment screen. The Rerun (with Restart) Confirmation Window is
displayed. Request the restart or rerun from the window.
s When DO IFRERUN is specified with a CONFIRM value of Y (Yes), the job
appears in the Active Environment screen with a WAIT CONFIRMATION (WITH
RESTART) status and is not restarted unless confirmed. Specify option C
(Confirm) to open the Confirm window to restart the job.
Restart For more information about job restart, see Active Environment Screen
on page 166.
Restart When a job is submitted for restart, if $FIRST is specified in the FROM
subparameter, a $FIRST step specification is passed as is to the CONTROLR step. If
$ABEND or $EXERR is specified, the specified $ABEND or $EXERR value is first
resolved to the appropriate step by the CONTROL-M monitor and then passed to the
CONTROLR step. If $FIRST.$ABEND is specified, the CONTROL-M monitor
determines which procedure abended and then passes the $FIRST step specification
for that procedure to the CONTROLR step. For information regarding the
CONTROLR step, refer to the CONTROL-M/Restart User Guide.
Restart The CONTROL-M parameter MAXRERUN determines the maximum
number of times the restart or rerun can be performed. For more information, see
MAXRERUN: PostProcessing Parameter on page 512.
RestartDO IFRERUN: PostProcessing Parameter
450 CONTROL-M for OS/390 and z/OS User Guide
Restart Example
Restart If the job abends on any step, restart (and automatically rerun) the job from
the first abended step.
Figure 175 Restart DO IFRERUN Parameter Example
JOB: PRDKL02 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST UPDA CODES S* * * * U* * * * C2000 A/ O
DO I FRERUN FROM $ABEND TO CONFI RM N
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====



COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 26. 42
DO MAIL: PostProcessing Parameter
Chapter 3 Job Production Parameters 451
DO MAIL: PostProcessing Parameter
Send an e-mail message to the specified recipients.
Figure 176 DO MAIL Parameter Format

Optional. Type MAIL in the DO field and press Enter. The following subparameters
are displayed:
Table 173 DO MAIL Subparameter Formats (Part 1 of 2)
Subparameters Description
TO Destination of the message. Mandatory.
Valid values are:
s the full e-mail address
s the e-mail prefix
If you use the prefix, the full e-mail address is supplied by
the MAILDEST table in the IOA PARM library. The
MAILDEST table also includes the value of the DFLTSFFX
field, which specifies the e-mail address suffix (such as
@MAIL.DOMAIN.COM), the SMTP STC name, and the
HOST name.
DO MAIL: PostProcessing Parameter
452 CONTROL-M for OS/390 and z/OS User Guide
General Information
The specified e-mail is sent to the specified destinations when the accompanying ON
statement criteria are satisfied. Although e-mail can be sent using a DO SHOUT
statement, the DO MAIL statement provides the following advantages:
s Using DO MAIL, you can specify any number of TO and CC recipients. With DO
SHOUT, you must specify the mail destination prefix, and you must define the
address in the MAILDEST table.
s Using DO MAIL, the e-mail text can exceed 70 characters. Both system and
user-defined AutoEdit variables are supported in the subject line and message text.
These variables are resolved when the DO MAIL statement is processed.
Subparameters TO and CC
Each of these parameters can contain more than one mail name address. When a
value is specified in the TO or CC field, a new empty line is displayed so that an
additional value can be specified (up to a maximum of 255 lines).
CC Destination to which a copy of the message is to be sent.
Optional.
Valid values are:
s the full e-mail address
s the e-mail prefix
If you use the prefix, the full e-mail address is supplied by
the MAILDEST table in the IOA PARM library. The
MAILDEST table also includes the value of the DFLTSFFX
field, which specifies the e-mail address suffix (such as
@MAIL.DOMAIN.COM), the SMTP STC name, and the
HOST name.
SUBJ Message subject of up to 70 characters. Optional.
TEXT Message text of up to 255 text lines, each with a maximum of
70 characters. Optional.
NOTE
The resolved value of an AutoEdit variable is truncated after 70 characters.
For information on the use of AutoEdit variables, see Chapter 5, JCL and AutoEdit
Facility.
Table 173 DO MAIL Subparameter Formats (Part 2 of 2)
Subparameters Description
DO MAIL: PostProcessing Parameter
Chapter 3 Job Production Parameters 453
Multiple addresses, separated by a semicolon (;), can be specified on a line.
If an address exceeds the length of a full line, it can be continued on the following
line.
Example
If the job is not run due to a JCL error, send an e-mail to the relevant users:
Figure 177 DO MAIL Parameter Example
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALES
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES JNRUN A/ O
DO MAI L
TO MAI L_ADDRESS_#1
TO MAI L_ADDRESS_#2
CC MAI L_ADDRESS_#3; MAI L_ADDRESS_#4
SUBJ WARNI NG MESSAGE
TEXT JCL ERROR I N SALES JOB! PLEASE CORRECT ERRORS AND RERUN THE JOB
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO NOTOK: PostProcessing Parameter
454 CONTROL-M for OS/390 and z/OS User Guide
DO NOTOK: PostProcessing Parameter
Set the status of the job step to NOTOK if the accompanying ON step and code
criteria are satisfied. If specified in a Group Entity, the termination status of the group
is set to NOTOK.
Figure 178 DO NOTOK Parameter Format

Optional. Type NOTOK in the DO field and press Enter. DO NOTOK has no
subparameters.
General Information
A DO NOTOK statement can change the status of a job step from OK to NOTOK. This
results in the job having a final termination status of ENDED NOTOK.
When specified in a Group Entity, a DO NOTOK statement changes the termination
status of the group (not the status of jobs or job steps).
The following paragraphs describe the relationship of job step status and the final
termination status of the job.
s CONTROL-M determines the status of each individual step in a job before
determining the final status of the job.
s After examining the results of a job step, CONTROL-M automatically assigns a
status of OK or NOTOK to the step:
By default, any job step ending with a condition code of C0000 through C0004 is
assigned a status of OK, but the INCONTROL administrator can change this.
If any other condition code, system or user abend code, or user event is
generated, the step is automatically assigned a status of NOTOK.
DO NOTOK: PostProcessing Parameter
Chapter 3 Job Production Parameters 455
s In general, if any of the steps in a job ends with a status of NOTOK, the job is
assigned a final status of ENDED NOTOK. For a job to be assigned a final status of
ENDED OK, each step in the job must be assigned a status of OK.
This logic suits most situations. Do not change it. However, there may be a situation
in which CONTROL-M assigned a step a status of OK, but the status ought to be
changed to NOTOK. Such a situation is described in the following example. The job
ended with a condition code of C0004, but in this particular situation, it is better that
the step have a status of NOTOK and the entire job be assigned a status of ENDED
NOTOK.
DO NOTOK cannot be specified for the same ON step and code event as DO OK.
When a DO NOTOK statement is performed for a step, the final status of the job is
ENDED NOTOK, even if was previously set to ENDED OK.
Example
When PROCST UPDA in PGMST STEP06 finishes executing with a condition code of
C0004, it is considered NOTOK.
Figure 179 DO NOTOK Parameter Example
JOB: PRDKPL02 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST STEP06 PROCST UPDA CODES C0004 A/ O
DO NOTOK
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======






COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 16. 03
DO OK: PostProcessing Parameter
456 CONTROL-M for OS/390 and z/OS User Guide
DO OK: PostProcessing Parameter
Set the status of the job step to OK if the accompanying ON step and code criteria are
satisfied. If specified in a Group Entity, the termination status of the group is set to
OK.
Figure 180 DO OK Parameter Format

Optional. Type OK in the DO field and press Enter. DO OK has no subparameters.
General Information
A DO OK statement can change the status of a job step from NOTOK to OK. If all
steps of a job have a status of OK the job is assigned a final termination status of
ENDED OK.
When specified in a Group Entity, a DO OK statement changes the termination status
of the group (not the status of jobs or job steps).
The relationship between job step status and the final termination status of the job is
as follows:
CONTROL-M determines the status of each individual step in a job before
determining the final status of the job.
After examining the results of a job step, CONTROL-M automatically assigns a status
of OK or NOTOK to the step:
s By default, any job step ending with a condition code of C0000 through C0004 is
assigned a status of OK, but the INCONTROL administrator can change this.
s If any other condition code, system or user abend code, or user event is generated,
the step is automatically assigned a status of NOTOK.
DO OK: PostProcessing Parameter
Chapter 3 Job Production Parameters 457
In general, if any of the steps in a job ends with a status of NOTOK, the job is assigned
a final status of ENDED NOTOK. For a job to be assigned a final status of ENDED
OK, each step in the job must be assigned a status of OK.
This logic suits most situations. Do not change it. However, there may be a situation
in which CONTROL-M assigned a step a status of NOTOK, but the status ought to be
changed to OK. Several such exceptional situations are described below:
s The NOTOK status is inappropriate for the job step. For example, a condition code
greater than C0004 was returned for a step that had an acceptable result.
s The NOTOK status is appropriate for the job step, but the job step is not critical,
and ought not to affect the final job status.
s User events created using Exit CTMX003 always result in a NOTOK status unless
DO OK is specified.
DO OK cannot be specified for the same ON step and code event as DO NOTOK and
DO RERUN.
A DO OK statement specified in the job scheduling definitions is ignored if
s any of the following status codes apply to any step:
EXERR
JNSUB
*REC0
*UKNW
-or-
s it was specified as part of an ON PGMSTEP ANYSTEP ..... CODE NOTOK
condition, because if that condition is satisfied, the status of the job has already
been set to NOTOK
For more information, see Valid CODES Values on page 542.
DO OK: PostProcessing Parameter
458 CONTROL-M for OS/390 and z/OS User Guide
Example
When PROCST UPDA in PGMST STEP08 finishes executing with a condition code
less than C0008, it is considered OK.
Figure 181 DO OK Parameter Example
JOB: PRDKPL02 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST STEP08 PROCST UPDA CODES <C0008 A/ O
DO OK
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======






COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 16. 03
DO RERUN: PostProcessing Parameter
Chapter 3 Job Production Parameters 459
DO RERUN: PostProcessing Parameter
Reschedules the job (for rerun) if the accompanying ON step and code criteria are
satisfied.
Figure 182 DO RERUN Parameter Format

Optional. Type RERUN in the DO field and press Enter. DO RERUN has no
subparameters.
General Information
The RERUN statement is intended for situations in which a job must be rescheduled
following an unsuccessful job run.
Rerun jobs remain in the Active Jobs file with a status of WAIT SCHEDULE, where
they wait to be submitted like any other job. However, other parameters, such as
CONFIRM and DO IFRERUN, can affect the status of the rerun job order and the
submission and processing of the job:
s A Y value specified in the CONFIRM parameter indicates that manual
confirmation is required before submitting the rerun job order. In this case, the
rerun job order is placed in the Active Jobs file with a status of WAIT
CONFIRMATION (FOR SCHEDULE). The job can be confirmed by option C
(Confirm) in the Active Environment screen.
s A DO IFRERUN statement before the DO RERUN statement indicates that a restart
is desired instead of a full rerun. The job order is placed in the Active Jobs file with
a status of WAIT SCHEDULE WITH RESTART, where the job waits to be
submitted from the indicated restart step. Confirmation can also be required for
restart jobs. This, too, is performed from the Active Environment screen. For more
information, see RestartDO IFRERUN: PostProcessing Parameter on
page 446.
DO RERUN: PostProcessing Parameter
460 CONTROL-M for OS/390 and z/OS User Guide
For information about confirmation, see Confirm Rerun Window on page 222 and
RestartRerun and/ or Restart Window (Under CONTROL-M/ Restart) on
page 223.
Job rerun is also affected by the MAXRERUN, RERUNMEM and INTERVAL
parameters.
s MAXRERUN specifies the maximum number of times the job must be scheduled
for rerun.
s RERUNMEM specifies the JCL member to be used for the rerun (if different from
the normal JCL member of the job).
s INTERVAL specifies the number of minutes to wait between reruns.
These parameters are described in this chapter.
DO RERUN cannot be specified for a cyclic job or a cyclic started task.
DO RERUN cannot be specified for the same ON step and code event as DO OK.
Do not specify DO RERUN for steps that have a specified ON statement code value of
OK.
Do not specify DO RERUN for steps that have a specified ON statement code value of
NOTOK because many of the causes of a NOTOK status, such as JCL not found,
preclude the possibility of a successful job rerun. Instead, specify an ON statement
code value of EXERR to accompany the DO RERUN statement.
When a DO RERUN statement is performed for a job (that is, the accompanying ON
step and code criteria are satisfied), the previously run job is automatically assigned a
final status of ENDED NOTOK, even if the job would have otherwise had a status of
ENDED OK.
DO RERUN: PostProcessing Parameter
Chapter 3 Job Production Parameters 461
Example
If job EF145TS abends during step name COLLECT, try to run another job from
member EF145TSR that continues from the same place.
Figure 183 DO RERUN Parameter Example
JOB: EF145TS LI B CTM. PROD. SCHEDULE TABLE: EFPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
============================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST COLLECT PROCST CODES S* * * U* * * * A/ O
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======





COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO SET: PostProcessing Parameter
462 CONTROL-M for OS/390 and z/OS User Guide
DO SET: PostProcessing Parameter
Assigns a value to an AutoEdit variable that can be used to set up the JCL of the next
submission of a cyclic or rerun or restarted job, or to define a Global variable in the
IOA Global Variable Database.
Figure 184 DO SET Parameter Format

Optional. Type SET in the DO field and press Enter. The following subparameter is
displayed:
NOTE
DO SET and SET VAR statements are similar, but not identical. The differences are
outlined in Differences between DO SET and SET VAR on page 464.
Table 174 DO SET Subparameter
Subparameter Description
VAR User-defined variable and the value to be assigned.
Mandatory.
Replace the %%?=? prompt with the desired parameter, in the
format:
%%variable=expression
where:
s %%variable is a valid AutoEdit user-defined variable.
s expression is any of the following components, provided
that it resolves to a single value:
Value (for example, 5).
AutoEdit system variable or previously defined
user-defined variable (such as %%ODATE).
Note: To specify embedded blanks in a DO SET expression, use AutoEdit variable
%%BLANKn (for example, %%A=TODAY%%BLANK1.IS%%BLANK1.SUNDAY).
DO SET: PostProcessing Parameter
Chapter 3 Job Production Parameters 463
General Information
A major advantage of using AutoEdit variables is that the JCL can be submitted with
different values for different executions without actually changing the JCL.
There are two types of AutoEdit variables:
s system variables, which are assigned values by the system
s user-defined variables, for which the user must supply values; these variables can
be either local or global
One method of supplying a value for a user-defined variable is by defining the
variable and its value in a DO SET statement.
During job processing, the value is assigned at time of job submission. However, DO
SET is a post-processing statement, which means that before it can be applied, its
accompanying ON criteria must be satisfied in a job run.
Therefore, the DO SET statement is generally useful for supplying local user-defined
variables for cyclic, rerun, or restarted jobs.
When the ON criteria of a DO SET statement that defines a local variable are satisfied
during a job run, CONTROL-M creates a SET VAR statement equivalent to the DO
SET statement (that is, containing the same variable and value) in the subsequent job
run.
At time of job submission, AutoEdit variables in the JCL are resolved in the order in
which they appear in the JCL. By default, if an AutoEdit variable cannot be resolved,
the job is not submitted. This default can be changed using an appropriate
%%RESOLVE AutoEdit control statement.
DO SET statements can also be used to define and update Global Variables in the IOA
Global Variable database. The database is updated as part of job post-processing,
when the DO SET statement is processed. For more information on Global Variables,
including Global Variable syntax, see Chapter 5, JCL and AutoEdit Facility.
An unlimited number of DO SET statements can be specified.
JCL Setup and the AutoEdit facility are described in depth in Chapter 5, JCL and
AutoEdit Facility.
NOTE
If the JCL contains an AutoEdit variable that is resolved in a subsequent run by a DO
SET statement, the variable must be resolved by some other method, such as a
SET VAR statement, in the original run, or the job is not submitted.
DO SET: PostProcessing Parameter
464 CONTROL-M for OS/390 and z/OS User Guide
Differences between DO SET and SET VAR
DO SET and SET VAR statements are similar but have the following differences:
s Local variables in SET VAR statements are always applied before the job is
submitted. DO SET is a post-processing statement that can only be applied after its
accompanying ON step and code criteria are satisfied. This means that a local
value specified in the DO SET statement can only be applied in the next
submission of the job (specifically, for cyclic and rerun or restarted jobs).
s Global variables specified in a SET VAR statement are defined or updated in the
IOA Global Variable database before job submission. Global variables specified in
a DO SET statement are defined or updated in the IOA Global Variable database as
part of job post-processing
s The SET VARstatement appears in each job scheduling definition. The DO
SETstatement does not appear unless specified. To specify a DO SET statement,
type SET in an empty DO field and press Enter.
s In the SET VAR statement, the parameter value is specified after the keyword
VAR. In the DO SET statement, the parameter value is specified after the keyword
VAR=.
DO SET: PostProcessing Parameter
Chapter 3 Job Production Parameters 465
Example
If the job execution fails on any step due to a system or user abend, resolve the
%%PARM parameter in the JCL to RESTART, restart from the first abended step, and
automatically rerun.
Figure 185 DO SET Parameter Example
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT PRDKPL01- ENDED- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 A/ O
DO I FRERUN FROM $ABEND . TO . CONFI RM N
DO RERUN
DO SET VAR= %%PARM=RESTART
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======



COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO SHOUT: PostProcessing Parameter
466 CONTROL-M for OS/390 and z/OS User Guide
DO SHOUT: PostProcessing Parameter
Specifies a message to be sent (shouted) to a specific destination when a specific
situation occurs.
Figure 186 DO SHOUT Parameter Format

Optional. Type SHOUT in the DO field and press Enter. The following
subparameters are displayed:
NOTE
DO SHOUT and SHOUT statements are similar, but not identical. The differences are
outlined in Differences between SHOUT and DO SHOUT on page 471.
DO SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 467
Table 175 DO SHOUT Subparameters (Part 1 of 3)
Subparameter Description
TO Destination of the message (1 through 16 characters).
Mandatory. Valid values are:
s U-userid or USERID-userid Writes the message to the IOA
Log file under the specified user ID. userid must be 1
through 8 characters.
s OPER[n] Sends a rollable message to the operator
console. n is an optional 2-digit route code. If a route code is
not specified, the default routes are Master Console and
Programmer Information (1 and 11), and optionally,
CONTROL-M/ Enterprise Manager. For more detailed
information regarding route codes, refer to the IBM
publication Routing and Descriptor Codes, GC38-1102.
s OPER2[n] Sends an unrollable, highlighted message to
the operator console. n is an optional 2-digit route code. If a
route code is not specified, the default routes are Master
Console and Programmer Information (1 and 11), and
optionally, CONTROL-M/ Enterprise Manager. For more
detailed information regarding route codes, refer to the IBM
publication Routing and Descriptor Codes, GC38-1102.
DO SHOUT: PostProcessing Parameter
468 CONTROL-M for OS/390 and z/OS User Guide
s [TSO - loginid | T - loginid] [;Nn | ;Mm | ;NnMm | ;Lname]
Sends the message to the specified ID (groupid or logonid). ID
is mandatory.
If a groupid is specified, it must be a valid ID found within
the IOA Dynamic Destination Table.
If a logonid is specified, it must be 1 through 7 characters.
An optional second value, indicating the computer and/ or
node (such as Mm) of the TSO logonid, can be specified, as
follows:
Under JES2:
Valid values are: Nn, Mm or NnMm, where:
m is the machine ID (the computer in JES2, not the
4-character SMF system ID). For more information, see
the discussion on specifying IOA CPUs in the description
of the customization process in the INCONTROL for
OS/ 390 and z/ OS Installation Guide.
n is the 1 to 2 character JES/ NJE node ID.
Under JES3:
The only valid value is Lname, where Lname is the logical JES
name of the machine (that is, the name as used in JES3
command *T, not the SMF system ID).
For more information, see the discussion on specifying IOA
CPUs in the description of the customization process in the
INCONTROL for OS/ 390 and z/ OS Installation Guide.
Note: A shout to a TSO user performs a TSO SEND command,
which may require authorization at the receiving node.
s U-M:mail-name-prefix Sends a message by mail to the
recipient identified by mail-name-prefix (1 through 12
characters).
s U-S:snmp_dest Sends an SNMP trap (message) to the
recipient identified by snmp_dest.
snmp_dest consists of from 1 through 12 characters, and can
be any of the following:
a host name
an IP address
a nickname defined in the SNMPDEST destination table
a group name defined in the SNMPDEST destination
table
s U-ECS Sends messages to the CONTROL-M/ Enterprise
Manager user. For more information on this feature, see
Shouting to CONTROL-M/ Enterprise Manager on
page 470.
Table 175 DO SHOUT Subparameters (Part 2 of 3)
Subparameter Description
DO SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 469
General Information
The message is sent to the required destination when the accompanying ON
statement criteria are satisfied.
DO SHOUT statements can also be defined in Group entities, where they are used in
a manner similar to jobs.
The TO Subparameter
Specify TO=USERID-userid to write the message to the IOA Log file under the user
ID specified in the parameter.
Specify TO=OPER[n] to send the message to the operator console (route code n). If
the n value is omitted, the message is sent to all consoles to which route codes 1 or 11
are assigned. For more detailed information regarding route codes, refer to the IBM
publication Routing and Descriptor Codes, GC38-1102. Optionally, the message can
also be sent to the CONTROL-M/ Enterprise Manager user, as described in Shouting
to CONTROL-M/ Enterprise Manager on page 470.
Specify TO=OPER2[n] to send a highlighted, unrollable message to the operator
console (route code n). If the n value is omitted, the message is sent to all consoles to
which route codes 1 or 11 are assigned. For more detailed information regarding
route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.
Optionally, the message can also be sent to the CONTROL-M/ Enterprise Manager
user, as described in Shouting to CONTROL-M/ Enterprise Manager on page 470.
Specify TO=TSO-id or T-id to send the message to a groupid or logonid. The Shout
facility first searches the IOA Dynamic Destination table for the specified ID. If the
table contains an entry (groupid) that matches the value, the content of the entry is
used as the target for the shouted message. The entire TO field is used. Therefore,
URGENCY Determines the priority level of the message. Valid values are:
s R Regular. Default.
s U Urgent
s V Very urgent
= Message text
Maximum length: 70 characters
AutoEdit variables (both system and user-defined) are
supported and automatically resolved (replaced) at the time the
SHOUT message is issued. For AutoEdit usage information, see
Chapter 5, JCL and AutoEdit Facility.
Table 175 DO SHOUT Subparameters (Part 3 of 3)
Subparameter Description
DO SHOUT: PostProcessing Parameter
470 CONTROL-M for OS/390 and z/OS User Guide
when directing the message to a remote user, do not append Nn or Mm. Instead, do
this in the IOA Dynamic Destination Table itself. For more information, see the
description of the Dynamic Destination Table in the INCONTROL for OS/ 390 and
z/ OS Administrator Guide.
If no matching ID is found in the Dynamic Destination table, the Shout facility
assumes the specified ID is a logonid. It then creates a TSO message that it hands over
to MVS. MVS then sends the message to that logonid. (If the logonid does not exist,
MVS cannot send the message, but no error message is generated.) When a second
value is used, the message is sent to the TSO logonid in the specified computer or
node (machine ID). To determine the machine ID under JES2, specify JES command
$LSYS.
Specify TO=U-M: mail-name-prefix to send the message by e-mail to the recipient
identified by the prefix. The full mail name address is supplied by the MAILDEST
table in the IOA PARM library. For more information about mail destinations, see the
INCONTROL for OS/ 390 and z/ OS Administrator Guide. The MAILDEST table also
includes DFLTSFFX, the mail address suffix, such as @MAIL.DOMAIN.COM, the
SMTP STC name, and the HOSTNAME.
Specify TO=U-S:snmp_dest to send the SNMP trap (message) to the recipient
identified by snmp_dest. This variable (snmp_dest) can be any of the following:
s a host name
s an IP address
s a nickname defined in the SNMPDEST table
s a group name defined in the SNMPDEST table
For more information about mail destinations, see the INCONTROL for OS/ 390 and
z/ OS Administrator Guide.
Shouting to CONTROL-M/Enterprise Manager
For CONTROL-M to be able to shout to CONTROL-M/ Enterprise Manager, the
following conditions must be satisfied at the site:
1. CONTROL-M/ Enterprise Manager must be installed and the ECS parameter must
be set to Y in member IOAPARM in the IOA PARM library.
2. File MG2 (the CONTROL-M/ Enterprise Manager Shout File) must be defined.
3. The following parameters in the IOAPARM member in the IOA PARM library
must be defined according to how messages are targeted to
CONTROL-M/ Enterprise Manager:
DO SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 471
s If TO=OPER and TO=OPER2 messages must be sent to
CONTROL-M/ Enterprise Manager, the OPER2ECS parameter must be set to Y
(Yes). Otherwise, it must be set to N (No).
When OPER2ECS is set to Y:
If these messages must also be sent to the MVS operator console, the
OPER2CON parameter must also be set to Y (Yes).
If these messages must not also be sent to the MVS operator console, the
OPER2CON parameter must also be set to N (No).
s If TO=U-ECS messages must be sent to CONTROL-M/ Enterprise Manager, the
UECS2ECS parameter must be set to Y (Yes); otherwise, it must be set to N (No).
Regardless of the value of this parameter, these messages are also sent to
CONTROL-M and the IOA Log.
Once the above conditions are satisfied, messages can be shouted to
CONTROL-M/ Enterprise Manager by specifying a destination of TO=OPER or
TO=OPER2 (without a route code qualifier), or TO=U-ECS.
Such messages are then placed by CONTROL-M in the M2G file. Once the shouted
message is in the M2G file, the CONTROL-M Application Server reads the file and
sends the message to the CONTROL-M/ Enterprise Manager user.
The URGENCY Subparameter
The URGENCY value indicates the urgency level of the message
In addition, if the destination is USERID-userid (or U-userid), the user can control,
according to urgency, which messages are displayed when the IOA Log file is
accessed. Urgent and very urgent messages are highlighted on the screen. For more
details, see IOA Log Facility on page 289
Differences between SHOUT and DO SHOUT
SHOUT and DO SHOUT statements have the following differences:
s A DO SHOUT statement is applied only if the accompanying ON criteria are
satisfied. Therefore a DO SHOUT statement does not contain subparameters for
specifying when to perform the shout.
By contrast, a SHOUT statement requires that a value be specified in subparameter
WHEN indicating when to shout the message. Messages can be shouted when the
job ends OK or NOTOK, when the job is late for submission or completion, or
when the job runs too long.
DO SHOUT: PostProcessing Parameter
472 CONTROL-M for OS/390 and z/OS User Guide
s A SHOUT statement appears in each job scheduling definition. A DO SHOUT
statement does not appear unless specified. To specify a DO SHOUT statement,
type SHOUT in an empty DO field and press Enter.
s The SHOUT URGN subparameter is equivalent to the DO SHOUT URGENCY
subparameter.
s The SHOUT MS subparameter is equivalent to the DO SHOUT subparameter.
Example
If the job is not run because of a JCL error, notify the user who sent the job.
Figure 187 DO SHOUT Subparameter Example
An urgent message is sent to the user ID that requested the job.
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
============================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES JNRUN A/ O
DO SHOUT TO TSO- U0014 URGENCY U
= * * * JCL ERROR I N SALARY JOB * * *
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======




COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO STOPCYCL: Post-Processing Parameter
Chapter 3 Job Production Parameters 473
DO STOPCYCL: Post-Processing Parameter
Stops recycling a cyclic task.
Figure 188 DO STOPCYCL Parameter Format
The DO STOPCYCL statement has no subparameters. Type the word STOPCYCL in
the DO field and press Enter.
General Information
DO STOPCYCL is intended for use with all cyclic tasks (cyclic job, cyclic STC,
emergency cyclic job and emergency cyclic STC). It interrupts a job cycle after the
current run, so that once the job completes its current run, it does not run again. This
parameter does not change the status (OK or NOTOK) assigned to job during the last
cycle.
After DO STOPCYCL has interrupted a job, commands RERUN or RESTART can be
used in the Active Environment screen to continue the job cycle from where it
stopped. Commands RERUN and RESTART resume the stopped cyclic tasks without
waiting for a cycling interval to occur. After the job restarts, it continues its normal
cyclic interval as before.
DO STOPCYCL: Post-Processing Parameter
474 CONTROL-M for OS/390 and z/OS User Guide
Example
If cyclic job SACALCO1 finishes with a status of NOTOK, the STOPCYCL parameter
interrupts the cycle.
Figure 189 DO STOPCYCL Parameter Example
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL 003 FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES NOTOK A/ O
DO STOPCYCL
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< ======





COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO SYSOUT: Post-Processing Parameter
Chapter 3 Job Production Parameters 475
DO SYSOUT: Post-Processing Parameter
Controls handling of job output if the accompanying ON step and code criteria are
satisfied.
Figure 190 DO SYSOUT Parameter Format

Optional. Type the word SYSOUT in the DO field and press Enter. The following
subparameters are displayed: e alw
NOTE
DO SYSOUT and SYSOUT statements are similar, but not identical. The differences
are outlined below in Differences between SYSOUT and DO SYSOUT on page 481."
Table 176 DO SYSOUT Subparameters (Part 1 of 2)
Subparameter Description
OPT Sysout option code. Mandatory. Valid values are:
s F Copy the job output to file.
s C Change the class of the job output.
s N Change the destination of the job output.
s D Delete (purge) the job output.
s R Release the job output.
PRM Relevant sysout data. Mandatory and valid only if the
specified OPT value is F, C or N. Valid values depend on the
OPT value, as follows:
s F File name.
s C New class (1 character). An asterisk (*) indicates the
original MSGCLASS of the job.
s N New destination (1 through 8 characters).
DO SYSOUT: Post-Processing Parameter
476 CONTROL-M for OS/390 and z/OS User Guide
General Information
The CONTROL-M monitor, unless otherwise instructed, leaves the job sysout in
HELD class in the output queue.
The DO SYSOUT parameter is used to request additional handling of these held
sysouts when the accompanying ON criteria are satisfied.
The CONTROL-M monitor sends all sysout handling requests to JES, which
processes the instructions. If, however, the copying of sysouts to a file is requested
(option F), CONTROL-M requests the sysouts from JES and then CONTROL-M
directly writes the sysouts to the file.
Since only one SYSOUT statement can be defined in a job scheduling definition, DO
SYSOUT statements can be used, as follows, to specify additional sysout handling
instructions when the job ends OK:
s To define DO SYSOUT statements that operate like a SYSOUT statement (that is,
that operate only when the job ends OK), define their accompanying ON statement
with PGMST value ANYSTEP and code value OK.
s The interrelationship between multiple sysout operations (by SYSOUT and DO
SYSOUT statements) is described in Multiple Sysout Operations on page 478.
Sysout Handling Operations
The sysouts that are affected by sysout handling operations are determined by
whether the sysouts are under JES2 or JES3, as follows:
FRM FROM class. Optional. Limits the sysout handling operation to
only sysouts from the specified class.
Note: If a FROM class is not specified, all sysout classes are
treated as a single, whole unit.
Table 177 Varying Effect of SYSOUT Handling Operations
Operation Effect
Under JES2: Operations are performed on all of the held sysouts, or held
portions of sysouts, of the job, unless otherwise restricted to a
specific FROM class by the FRM subparameter.
Under JES3: Operations are performed only on the sysouts of the job in the
CONTROL-M held class, as specified in the CONTROL-M
installation HLDCLAS parameter.
Table 176 DO SYSOUT Subparameters (Part 2 of 2)
Subparameter Description (continued)
DO SYSOUT: Post-Processing Parameter
Chapter 3 Job Production Parameters 477
Sysout handling operations are listed below:
s Copying sysouts to a file (OPT=F)
The sysouts of the job are copied (not moved) to the file specified in the data
subparameter.
The file name specified in the data subparameter can contain AutoEdit system
variables, and/ or user-defined AutoEdit variables, which are defined in the job
scheduling definition or the IOA Global Variable database, or which are loaded
into AutoEdit cache. If the AutoEdit variables cannot be resolved, the sysout is not
copied.
CONTROL-M allocates the file with DISP=(NEW,CATLG,DELETE) using the unit
and space attributes specified in the CONTROL-M installation parameters.
Sysouts can be archived by copying them. However, to reduce overhead, this
method is recommended only for small sysouts.
s Deleting sysouts (OPT=D)
The sysouts of the job are deleted (purged) from the output queue.
s Releasing sysouts (OPT=R)
The sysouts of the job are released for printing.
s Changing the class of sysouts (OPT=C)
The sysouts of the job are changed to the output class specified in the data
subparameter. Ensure that you specify a meaningful target output class.
Note the following points:
Changing a sysout class to a non-held class does not release the sysout because
the sysout attributes do not change (due to JES logic).
To ensure that the sysout is released, use DO SYSOUT statements to release the
sysout after changing its class. For example:
DO SYSOUT OPT C PRM R FRM A
NOTE
This operation works on all sysouts under JES2 or JES3 (regardless of held status or
class) unless otherwise restricted by the FRM subparameter.
DO SYSOUT: Post-Processing Parameter
478 CONTROL-M for OS/390 and z/OS User Guide
DO SYSOUT OPT R PRM FRM A
Changing a sysout class to a dummy class does not purge the sysout because the
sysout attributes do not change (due to JES logic).
To save the original MSGCLASS of a job and to restore it at output processing
time, specify a data value of *. The sysouts are changed to the original class of
the job.
s Moving sysouts to a new destination (OPT=N)
The sysouts of the job are moved to the output destination specified in the data
subparameter. Ensure that you specify a meaningful target output destination.
Multiple Sysout Operations
If multiple DO SYSOUT (or SYSOUT/ DO SYSOUT) operations are not specified for
the same FROM class, the order in which the operations are performed is not
significant.
However, if different DO SYSOUT (or SYSOUT/ DO SYSOUT) operations affect the
same FROM class, or if multiple operations are specified without a FROM class, the
order and method of implementation is significant.
CONTROL-M merges different operations for the same FROM class into a combined
instruction to JES. Likewise, CONTROL-M merges different operations without a
FROM class into a combined instruction to JES.
Operations without a specified FROM class treat the entire held sysout as a whole
unit, and are therefore not merged with sysout handling requests for a specific FROM
class.
JES does not necessarily process multiple sysout handling instructions in the order
they are issued by CONTROL-M. Therefore, the processing results can vary if the
merged instructions to JES include both FRM equals a specified class and FRM equals
blank.
BMC Software therefore recommends that you do not include in a job scheduling
definition both FROM class and no FROM class sysout handling instructions that
become operational under the same situations.
When CONTROL-M merges a set of operations into a combined instruction, some
operations override or cancel other operations, and some operations are performed
along with other operations. This is described below.
DO SYSOUT: Post-Processing Parameter
Chapter 3 Job Production Parameters 479
Operation Merging and Performance
CONTROL-M performs all copy to file operations (option F) first.
After performing all copy to file operations, CONTROL-M merges all operations
performed on a specific FROM class.
After merging operations on specific FROM classes, CONTROL-M merges the
operations performed on the sysout as a whole (where the FRM subparameter is set
to blank).
CONTROL-M then passes the merged sets of instructions to JES for processing.
The resulting combination of operations can vary depending on whether the
operation that was merged with a DO SYSOUT operation is a SYSOUT operation or
another DO SYSOUT operation.
Generally, DO SYSOUT operations override, or are performed along with, SYSOUT
statements.
The following chart and the accompanying numbered explanations indicate the result
of merging multiple DO SYSOUT statements. Note the following points about the
chart:
s Operations are indicated by their symbols (F,D,R,C,N), at the top and side of the
chart. The operations at the top of the chart represent DO SYSOUT operations. The
operations at the side of the chart represent SYSOUT or DO SYSOUT operations.
s Merging and processing operations are grouped, and explained, based on
operation type. Groups are delimited by lines, and are numbered (from 1 through
4). Within each group, operations are delimited by periods. Explanations of each
group are provided, by number, following the chart.
s The handling of the combination of operations is generally reflected in the chart by
a single operation code (such as D) or pair of operation codes, such as FR. In some
cases, the operations are merged. This is indicated by the word merged. In some
cases, handling depends on whether the combination consists of both a SYSOUT
and a DO SYSOUT statement, or multiple DO SYSOUT statements (that is, without
a SYSOUT statement). This is indicated by an asterisk (*). These are all explained in
the numbered explanations that follow the chart.
NOTE
For information about merging a SYSOUT and a DO SYSOUT statement, see
Operation Merging and Performance on page 479.
DO SYSOUT: Post-Processing Parameter
480 CONTROL-M for OS/390 and z/OS User Guide
Figure 191 Effect of Merging Multiple SYSOUT Statements.
The order of precedence in which CONTROL-M processes and merges operations is
as follows:
1. DO SYSOUT=F
Copy to file operations are performed first (directly by CONTROL-M) for DO
SYSOUT statements, regardless of whether FROM class is specified. Other
operations are then performed.
2. DO SYSOUT=D (Delete)
This operation supersedes all other DO SYSOUT operations (except copy to file
operations described above). Superseded operations are ignored, that is, they are
not performed.
3. DO SYSOUT combinations of R, C and N
In general, combinations of R, C, and N requests are merged, that is, they are all
performed. The exceptional cases indicated in the chart are described below:
If multiple C requests come from DO SYSOUT statements, perform only one of
the requests. Normally, do not specify this combination.
If multiple N requests come from DO SYSOUT statements, perform the request
that occurs first.
DO SYSOUT: Post-Processing Parameter
Chapter 3 Job Production Parameters 481
Differences between SYSOUT and DO SYSOUT
SYSOUT and DO SYSOUT statements have the following differences:
s The SYSOUT statement is applied only if the job ends OK. DO SYSOUT statements
are associated with accompanying ON statements and are applied only if the
accompanying ON step and code criteria are satisfied.
s A SYSOUT statement appears in each job scheduling definition. A DO SYSOUT
statement is not displayed unless requested. To request a DO SYSOUT statement,
type SYSOUT in an empty DO field and press Enter.
s Only one SYSOUT statement can be defined in the job scheduling definition. An
unlimited number of DO SYSOUT statements can be requested.
s The SYSOUT OP subparameter is equivalent to the DO SYSOUT OPT
subparameter.
s The SYSOUT data subparameter is equivalent to the DO SYSOUT PRM
subparameter.
s The SYSOUT FROM subparameter is equivalent to the DO SYSOUT FRM
subparameter.
DO SYSOUT: Post-Processing Parameter
482 CONTROL-M for OS/390 and z/OS User Guide
Examples
Example 1
If a job finishes executing OK, delete (purge) the sysout (DO SYSOUT OP D). If the
job finishes executing with condition code 0050-0059 in step STEP02, set the end
status of the job to OK and release the sysout for printing. If the job abends, move the
sysout to class D.
Figure 192 DO SYSOUT Parameter Example 1
Example 2 Use of the Sysout Archiving Facility
The MSGCLASS of the job is X (a held class). Reports are produced in class D. The
desired actions are:
s Archive the JCL messages and all the held output in class X, that is, the SYSPRINT
data sets, job log, and so on.
s If the job finishes executing OK, release the reports for print and delete the
MSGCLASS sysouts.
s If the job finishes executing NOTOK, delete the reports and keep the MSGCLASS
(JCL, job log, and so on) output in hold status.
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES OK A/ O
DO SYSOUT OPT D PRM FRM
ON PGMST STEP02 PROCST CODES C005* A/ O
DO OK
DO SYSOUT OPT R PRM FRM
DO
ON PGMST ANYSTEP PROCST CODES U* * * * S* * * * A/ O
DO SYSOUT OPT C PRM D FRM
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DO SYSOUT: Post-Processing Parameter
Chapter 3 Job Production Parameters 483
Figure 193 DO SYSOUT Parameter Example 2
Notice the use of the AutoEdit symbols in the name of the file to be archived. The
symbol %%JOBNAME, or %%$MEMNAME if the job name is not known, is replaced
with the job name, %%ODATE by the original scheduling date, and so on, producing
a file name such as PRD.PADD0040.D010306.N01342.T170843.
The file can be viewed by using ISPF Browse. A list of the outputs of the job can be
produced using ISPF option 3.4. For example, retrieval by the prefix
PRD.PAPD0040.D0103 lists all the names of the sysouts of the job in the month of
March 2001. It is possible to browse, edit, and print the desired sysout.
JOB: GPLUPDT1 LI B CTM. PROD. SCHEDULE TABLE: PRODGPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES * * * * * A/ O
DO SYSOUT OPT F PRM GPL. %%JOBNAME. D%%ODATE. N%%JOBI D. T%%TI ME FRM X
DO
ON PGMST ANYSTEP PROCST CODES OK A/ O
DO SYSOUT OPT D PRM FRM X
DO SYSOUT OPT R PRM FRM D
DO
ON PGMST ANYSTEP PROCST CODES NOTOK A/ O
DO SYSOUT OPT D PRM FRM D
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
NOTE
The File operation (sysout archival) is intended for small sysouts (such as JCL, sort
messages) and not for large volume reports. When the CONTROL-M monitor is
performing file operations, it does not analyze the results of other jobs. Therefore, if
large files are archived, production throughput may suffer.
DOC: General Job Parameter
484 CONTROL-M for OS/390 and z/OS User Guide
DOC: General Job Parameter
Detailed job documentation. This field can be displayed or hidden by request.
Figure 194 DOC Parameter Format

Optional. Upon filling in a DOC line with text and pressing Enter, a new DOC line is
opened for specifying additional documentation text.
General Information
DOC lines are used for specifying job documentation.
Upon entry to the job scheduling definition, DOC lines are displayed only if the value
Y was specified in field SHOW JOB DOCUMENTATION in the Scheduling
Definition Facility entry panel.
Command DOC can be used in the job scheduling definition to toggle between the
display and non display of job documentation.
The information specified in the DOC lines is saved in the member and library
specified in the DOCMEM and DOCLIB parameters. This member can also be edited
directly by ISPF edit.
When modifying DOC lines in the job scheduling definition, text must be left in at
least one DOC line in order to save the modifications. Changes resulting in an empty
DOCMEM member are not saved when exiting the job scheduling definition.
For more information regarding job documentation, including the saving of job
documentation changes, see Job Documentation on page 146
DOC: General Job Parameter
Chapter 3 Job Production Parameters 485
Example
The steps performed by the L-file backup job are documented in the DOC lines.
Figure 195 DOC Parameter Example
JOB: BACKPL02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME BACKPL02 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC
===========================================================================
DOC THI S JOB BACKS UP "L" FI LES. I T PERFORMS THE FOLLOWI NG STEPS:
DOC 1: VERI FY SPACE REQUI REMENTS
DOC 2- 5: BACKUP THE FI LES
DOC 6: RECATALOG THE NEWFI LES
DOC 7: PRI NT THE SHORT- VERSI ON LI STI NG REPORT
DOC
====================================================================
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DOCLIB: General Job Parameter
486 CONTROL-M for OS/390 and z/OS User Guide
DOCLIB: General Job Parameter
Name of the library in which the member specified in DOCMEM resides.
Figure 196 DOCLIB Parameter Format

Optional. The DOCLIB parameter identifies a valid data set name of 1 through 44
characters. The default is either defined at time of installation or is blank.
General Information
The library can be any standard partitioned data set. The record length must be 80.
Any number of documentation libraries can be used at a site. However, only one
documentation library can be specified in each job scheduling definition.
NOTE
Users with DOCU/ TEXT installed at their sites can specify a DOCU/ TEXT library
and member with up to 132 characters per line. However, if more than the first 71
characters in a line are used, the line is truncated and Browse mode is forced. Browse
mode is also forced if a line contains an unprintable character. Changes to the
documentation are not permitted in Browse mode.
DOCLIB: General Job Parameter
Chapter 3 Job Production Parameters 487
Example
Job documentation is written to the PRDKPL01 member in the CTM.PROD.DOC
library.
Figure 197 DOCLIB Parameter Example
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- PROD- KPL ODAT
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DOCMEM: General Job Parameter
488 CONTROL-M for OS/390 and z/OS User Guide
DOCMEM: General Job Parameter
Name of the member that contains job documentation.
Figure 198 DOCMEM Parameter Format

Optional. DOCMEM identifies a valid member name of 1 through 8 characters. The
default is either defined during installation or is blank.
General Information
DOCMEM identifies a member that is in the library identified by the DOCLIB
parameter. This member is used to save detailed documentation written in the DOC
lines of the Job Scheduling Definition screen (or Zoom screen).
When you enter the Job Scheduling Definition screen for the first time, DOCMEM
defaults to the value of MEMNAME. You can change this value, but it is
recommended that you not do so.
NOTE
Users with DOCU/ TEXT installed at their sites can specify a DOCU/ TEXT library
and member with up to 132 characters per line. However, if more than the first 71
characters in a line are used, the line is truncated and Browse mode is forced. Browse
mode is also forced if a line contains an unprintable character. Changes to the
documentation are not permitted in Browse mode.
DOCMEM: General Job Parameter
Chapter 3 Job Production Parameters 489
Example
Job documentation is written to member PRDKPL01 in the library CTM.PROD.DOC.
Figure 199 DOCMEM Parameter Example
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- PROD- KPL ODAT
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DUE OUT: Runtime Scheduling Parameter
490 CONTROL-M for OS/390 and z/OS User Guide
DUE OUT: Runtime Scheduling Parameter
Time by which the job must finish executing.
Figure 200 DUE OUT Parameter Format

Optional. The format for the parameter is hhmm
where:
s hh is the hour the job is due out (based on a 24-hour clock)
s mm is the minute the job is due out (based on a 24-hour clock)
General Information
The DUE OUT parameter is used to specify a time by which the job must finish
executing.
When two jobs with the same priority are available for submission, CONTROL-M
submits the job with the earlier DUE OUT time first.
When a DUE OUT time is specified, the CONTROL-M monitor can calculate a
DUE IN time for the job.
The DUE IN time is the recommended time by which the job must be submitted in
order to finish executing by the DUE OUT time. If the DUE IN time of a job has
passed, it is still submitted, unless the DUEINCHK parameter in the CTMPARM
member in the IOA PARM library has been set to Yes, in which case the job must wait
until the next day to be submitted.
To calculate the DUE IN time, the CONTROL-M monitor subtracts the anticipated
elapse time of the job from the DUE OUT time. The anticipated elapse time is the
average of the execution times of the job recorded in the CONTROL-M Statistics file.
DUE OUT: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 491
If DUE OUT time is not specified, the default DUE OUT time is the last minute of the
working day.
Automatic adjustment of DUE OUT times can be requested from the Job Dependency
Network screen.
For more information, see Automatic Job Flow Adjustment on page 74, and Job
Dependency Network Screen on page 236 For an explanation of how DUE OUT
affects job submission in the QUIESCE command, see the description of setting a
planned shutdown time in the INCONTROL for OS/390 and z/OS Administrator Guide.
Example
Job DISKLOG2 must finish execution by 6:00 a.m.
Figure 201 DUE OUT Parameter Example
JOB: DI SKLOG2 LI B CTM. PROD. SCHEDULE TABLE: ADABAS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM DI SKLOG2 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR O
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 99 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N DBA- CLEAN- LOG- 2 * * * *
CONTROL
RESOURCE TAPE 0001
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT 0600 SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 17. 14. 10
GROUP: General Job Parameter
492 CONTROL-M for OS/390 and z/OS User Guide
GROUP: General Job Parameter
Group to which a job belongs.
Figure 202 GROUP Parameter Format

The GROUP parameter identifies a group name of 1 through 20 characters. Only
trailing blanks are allowed.
s In a Group Entity, the parameter is mandatory.
In jobs in a Group scheduling table, the field is protected and contains the GROUP
name specified in the Group Entity.
s By default, the parameter is optional for jobs in regular scheduling tables, but this
can be modified in the user profile. The same value does not have to be specified
for all jobs in the table.
General Information
The way in which the GROUP parameter is applied depends on the type of
scheduling table in which the job scheduling definitions appear:
s In a Group scheduling table, the parameter affects job scheduling as well as the
retrieval and display of information.
s In a regular scheduling table, the parameter affects the retrieval and display of
information. It does not affect job scheduling.
GROUP: General Job Parameter
Chapter 3 Job Production Parameters 493
Group Job Scheduling
When a Group scheduling table is created, a value for the GROUP parameter must be
specified in the Group Entity. This value is automatically applied to the GROUP field
in all job scheduling definitions in the table.
Jobs in a Group scheduling table cannot be individually ordered. Jobs in this type of
table can only be ordered as a group, though they can be individually forced.
Before jobs in the Group scheduling table can be scheduled, a group must be eligible
for scheduling, meaning that a set of basic scheduling criteria in the Group Entity
must be satisfied.
Basic scheduling criteria, runtime scheduling criteria, and post-processing
parameters in the Group Entity apply to all scheduled jobs in the group.
For more information, see Handling of Job Groups on page 68 and page 112, and
Scheduling Jobs in Group Scheduling Tables on page 384.
Retrieving and Displaying Information
Regardless of scheduling table type, the GROUP parameter can be used as a selection
criteria that can make retrieval and display of information more efficient.
For example, display of information in the Active Environment screen can be limited
to jobs belonging to a specific group.
The group name appears in all important messages relating to the jobs in the group.
NOTE
BMC Software recommends the use of the GROUP parameter in all job scheduling
definitions to facilitate implementation of CONTROL-M/ Enterprise Manager
functions. For more information, see the CONTROL-M/Enterprise Manager User Guide.
GROUP: General Job Parameter
494 CONTROL-M for OS/390 and z/OS User Guide
Example
Job OPERCOMP (in a regular scheduling table) belongs to the MAINTENANCE
group.
Figure 203 GROUP Parameter Example
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
GRP MAXWAIT: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 495
GRP MAXWAIT: Basic Scheduling Parameter
Number of extra days the Group Entity can wait in the Active Jobs file if it does not
have an ENDED OK status. This parameter appears in and applies to the Group
Entity only.
Figure 204 GRP MAXWAIT Parameter Format

Optional. Valid values are: any 2-digit number in the range of 00-98, or 99.
If no value is specified, the default value of 00 is automatically inserted. This default
value may be changed by your INCONTROL administrator, by means of Wish
WM2367 in member IOADFLT in the IOA IOAENV library.
General Information
The GRP MAXWAIT parameter enables the Group Entity to remain in the Active Jobs
file for the specified number of days beyond the original scheduling date if the Group
Entity did not receive an ENDED OK status.
Table 178 GRP MAXWAIT Parameter Values
Value Description
00 If the Group Entity did not receive an ENDED OK status on its
original scheduling date, it cannot remain in the Active Jobs
file beyond its original scheduling date, unless jobs belonging
to the Group Entity are still in the Active Jobs file. Default.
nn Where nn = 01 98. If Group Entity did not receive an ENDED
OK status on its original scheduling date, it can remain in the
Active Jobs file up to nn additional days awaiting that status.
99 Group Entity remains in the Active Jobs file until deleted
manually, even if it has an ENDED OK status.
GRP MAXWAIT: Basic Scheduling Parameter
496 CONTROL-M for OS/390 and z/OS User Guide
This parameter is relevant only when there are no jobs belonging to the Group Entity
in the Active Jobs file. As long as a job belonging to the Group Entity is still in the
Active Jobs file, the Group Entity remains in the Active Jobs file regardless of the
value in the GRP MAXWAIT field.
For more information, see MAXWAIT: Basic Scheduling Parameter on page 515.
Example
If the original scheduling date of the Group Entity has passed, give it an extra three
days to receive a status of ENDED OK.
Figure 205 GRP MAXWAIT Parameter Example
GRP ACCOUNTS_GROUP CTM. PROD. SCHEDULE( GRP)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
GROUP ACCOUNTS_GROUP MEMNAME ACCOUNTS
OWNER N04B
APPL
DESC
ADJUST CONDI TI ONS Y GRP MAXWAI T 03
SET VAR
DOCMEM ACCOUNTS DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG ALL_DAYS
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
SCHEDULE TAG SUNDAYS
DAYS 01 DCAL
AND/ OR
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 44. 31
IN: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 497
IN: Runtime Scheduling Parameter
Prerequisite conditions that must be satisfied before the job can run.
Figure 206 IN Parameter Format

Optional. A maximum of two prerequisite conditions can be specified in each
standard IN line. One prerequisite condition can be specified in each long IN line.
When you specify the second prerequisite condition in a standard IN line, or one
prerequisite condition in a long IN line, and press Enter, a new IN line is opened for
specifying additional prerequisite conditions. For more information, see Specifying
Long IN Condition Names on page 499.
Each specified prerequisite condition consists of the following mandatory
subparameters:
Table 179 IN Subparameters (Part 1 of 2)
Subparameter Description
cond_name User-supplied descriptive name of 1 through 39 characters
used to identify the condition. Mandatory.
Note: A condition name must not begin with the symbols | ,
, or \ , and must not contain parentheses ( ), because each
of these characters has a special meaning. For more
information, see Logical Relations between Multiple
Conditions on page 500.
All system AutoEdit variables specified in the cond_name
subparameter are resolved at job ordering time. User AutoEdit
variables are not resolved.
IN: Runtime Scheduling Parameter
498 CONTROL-M for OS/390 and z/OS User Guide
General Information
A job cannot be submitted unless all the prerequisite condition criteria specified in
the IN statements have been satisfied.
Prerequisite conditions are usually used to establish job dependencies or to ensure
manual intervention when required:
s To establish job dependency, define a prerequisite condition in an OUT or DO
COND statement in the job that must run first, and in an IN statement in the job
that must run afterwards.
dateref 4-character date reference. Mandatory.
Valid values are:
s date Specific date (in either mmdd or ddmm format,
depending on the site standard).
s ODAT Resolves to the original scheduling date. Default.
s PREV Resolves to the previous date on which the job
ought to have been scheduled, according to its basic
scheduling criteria, or ODATE1 for a forced job
Note: for Group Scheduled Jobs: If the value of the
SCHEDULE TAG parameter has been set to * (asterisk),
PREV is resolved to the nearest previous date that satisfies
one or more Schedule Tags in the Group entity.
s STAT Static. Indicates that the condition, such as
IMS-ACTIVE, is not date-dependent.
Note: Before STAT was introduced, date 0101 was
recommended to be used in conditions that were not
date-dependent. Unlike 0101, STAT is not a date, and it
operates differently. Always use STAT when defining
conditions that are not date-dependent.
s **** Any scheduling date
s $$$$ Any scheduling date
Note: If a date reference is not specified, value ODAT is
automatically inserted when you press Enter.
Table 179 IN Subparameters (Part 2 of 2)
Subparameter Description
IN: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 499
The job containing a prerequisite condition in its IN statement is not submitted
unless that prerequisite condition has been added manually or by the job
containing the OUT or DO COND statement.
An OUT statement adds the prerequisite condition if the job ends OK.
The DO COND statement adds the prerequisite condition if the step and code
event criteria specified in the accompanying ON statement are satisfied.
s If the IN prerequisite condition can only be satisfied by manual intervention (for
example, TAPE1-ARRIVED is set by the operator after an external tape arrives
on-site), performance of the required manual intervention before job submission
can be ensured.
OUT and DO COND statements can also be used to delete prerequisite conditions
that are no longer needed. If an IN prerequisite condition for a job is not an IN
prerequisite condition for any other job, you can use the OUT statement of the job to
delete the prerequisite condition after the job ends OK.
The following are examples of prerequisite conditions:
All prerequisite conditions are created with a date reference. When specifying a
prerequisite condition as an IN condition, you must specify the date for the condition.
Only a prerequisite condition with the specified date can satisfy the IN requirement.
For more information regarding prerequisite conditions, see OUT: PostProcessing
Parameter on page 554, ON: PostProcessing Parameter on page 534, and DO
COND: PostProcessing Parameter on page 436, and see Prerequisite Conditions
on page 69
Specifying Long IN Condition Names
Regular prerequisite conditions are not more than 20 characters in length. If you want
to specify a longer condition name, up to 39 characters in length, enter the string
LONG in the date reference field of an empty IN condition line. An (L) appears at the
beginning of the line. If the field already contains data, entering the string LONG will
open a new long IN condition parameter, with (L) appearing at the beginning of the
line. You can now insert a long condition name, as illustrated in Figure 207 on
page 500.
Specify SHRT in the date reference field to revert back to condition names of standard
length.
I MS- ACTI VE
JOB_PAYCALC_ENDED_OK
TAPE1_LOADED
IN: Runtime Scheduling Parameter
500 CONTROL-M for OS/390 and z/OS User Guide
Figure 207 Long IN Condition
Logical Relations between Multiple Conditions
The IN condition parameter differs from other parameters that may be defined more
than once.
Where there are multiple IN condition definitions, they are not independent
parameters, as might at first appear. CONTROL-M takes them together and treats
them as a logical expression consisting of a series of connected terms, which appear
as condition names.
CONTROL-M resolves every such condition to a value of True or False, and then
evaluates the whole expression, using the logical operators which may have been
specified as part of each condition name. The run-time criteria for prerequisite IN
conditions are only satisfied if the overall value of the expression is calculated as
True. A condition name is evaluated as True if the name of that condition
appears in the IOA Conditions file.
Conditions may be added to or deleted from the IOA Conditions file automatically or
manually. Some typical means of adding and/ or deleting conditions are
s the CONTROL-M Monitor, by means of OUT or DO COND statements
NOTE
Long condition names cannot be used in CMEM rule definitions.
JOB: J13 LI B CTMP. V610. SCHEDULE TABLE: REV1
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
I N CTMLDNRS- NMI S- OK ODAT CTMLDNRS- NMI S- OK1 ODAT
( L) THI S- I S- A- LONG- I N- CONDI TI ON- NAMEXXXXXXX ODAT
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
============================================================================
OUT J1- ENDED ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) TO .
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN LATE 1300 TO TSO- N88 URGN R
MS BBB
SHOUT WHEN TO URGN
MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 09. 06. 50
IN: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 501
s the IOA Conditions/ Resources screen
s the IOA Manual Conditions screen
s the IOACND or IOACLND batch utilities
The following types of logical operator can be used to connect condition names:
s unitary
s binary
s group
Operators: Unitary
The logical NOT is the only unitary operator. It is represented in the condition name
by the symbol (Hex 5f) or \ (Hex e0). Conditions that have this type of symbol
associated with them are called inverted conditions. An inverted condition is only
True if that condition does not exist on the IOA Conditions File.
Operators: Binary
The following are the binary operators:
s logical AND
This is implicit, and has no explicit representation in the condition name.
s logical OR, represented by the symbol | (Hex 4f)
Where an expression contains conditions connected by an AND operator, both must
be present in the IOA Conditions File for the expression to be True.
An expression that contains conditions connected by an OR operator is True if
either expression is present in the IOA Conditions File.
Because logical OR operators are expressed as part of the condition name,
s all conditions connected by the logical OR must specify the OR symbol in their
condition name
This means that, for example, expressions of the form
NOTE
These operators are not referred to as Boolean, because the rules of these operators
do not follow formal Boolean logic, as shown in the following paragraphs. Logical
operators are the first physical characters in condition names, but they are not part of
the condition name.
IN: Runtime Scheduling Parameter
502 CONTROL-M for OS/390 and z/OS User Guide
A | B
must not be specified because their meaning is unclear, even though they will not
be syntactically rejected. In reality, because condition name A does not have an OR
symbol attached to it, no logical OR connection exists between A and B, and the
OR symbol attached to condition name B is ignored. The correct way to specify
Condition A OR Condition B is
(| A | B)
s all condition names that specify an OR symbol are processed first, before those
specifying an AND symbol
This has the effect of creating implicit parentheses among the terms of the
expression (explained under Operators: Group below); the terms of the
expression may also be rearranged.
For example, the expression
| B | C D | E
is processed as if the expression had been
( | B | C | E ) D
Operators: Group
The group operator is the pair of parentheses, Open, represented by the symbol ( ,
and Close, represented by the symbol ) . These must always appear in matched pairs.
Parentheses affect the order in which the other logical operators are applied to the
terms of the expression. Always specify parentheses when coding an expression that
contains different logical operators, to ensure that the terms are combined in the way
you want.
Various combinations of logical operators are permitted, subject to the following
limitations:
s only one level of parenthesis nesting is allowed
s double NOT operators are not supported
s an open parenthesis preceded by a NOT operator is not allowed
As in standard logic (de Morgans Rules), the following expressions express logical
equivalence:
A (| B | C) and | (A B) | (A C)
IN: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 503
| A | (B C) and (| A | B) (| A | C)
A A is always False.
Example
IN | A B
C | D
| (E F)
A job containing this combination of IN conditions will be selected for execution
when the following statements are both True.
s B exists and C does not exist
s A exists, or D does not exist, or (E does not exist and F exists)
IN Parameter Examples
The following are examples of the IN parameter.
Example 1
Schedule the job that produces the salary statistics report for top management when
the set of jobs that calculates the salaries finishes OK.
When the set of jobs that calculates the salaries finishes OK, it creates the prerequisite
condition SALARY-OK.
The report is produced twice a month, for the 1st and for the 15th. The report for the
15th is produced only if the prerequisite condition for the 15th, SALARY-OK, exists,
signifying that the salary job for the 15th ended OK. The existence of the prerequisite
condition for the 1st, SALARY-OK, does not cause submission of the report for the
15th.
IN: Runtime Scheduling Parameter
504 CONTROL-M for OS/390 and z/OS User Guide
Figure 208 IN Parameter Example 1
Example 2
This example is similar to Example 1. A monthly total report must be produced based
on data from the last two runs, and the job must run when IMS is active.
Figure 209 IN Parameter Example 2
JOB: EBDRPT1A LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
APPL EBD GROUP EBD- PRODUCTI ON
DESC EBD PRODUCTI ON SALARY REPORTS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDRPT1A DOCLI B CTM. PROD. DOC
============================================================================
DAYS 01, 15 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 06 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
============================================================================
I N SALARY- OK ODAT
CONTROL
RESOURCE
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
JOB: EBDRPT1A LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
DESC EBD PRODUCTI ON REPORTS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDRPT1A DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01, 15 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 06 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N SALARY- OK ODAT SALARY- OK PREV
I MS- ACTI VE STAT
CONTROL
RESOURCE
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
IN: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 505
Prerequisite condition IMS-ACTIVE is based on a static condition that exists only
when IMS is active. IMS itself can be monitored by CONTROL-M. When IMS is not
active, CONTROL-M deletes the prerequisite condition IMS-ACTIVE, thus
preventing abends of jobs that depend on IMS.
Example 3
Assume that there is a group of jobs that runs every day of the week except Saturday
and Sunday. It is very important that some of the jobs scheduled for the different
days of the week do not run simultaneously. The order of these jobs must be
maintained even if there are delays.
Figure 210 IN Parameter Example 3
The job is submitted only if the prerequisite condition DEPOSITS of the previous
schedule date exists. The prerequisite condition DEPOSITS is created only after the
group of jobs called DEPOSITS finishes.
JOB: EBDUPDT2 LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
APPL EBD GROUP EBD- PRODUCTI ON
DESC EBD PRODUCTI ON UPDATE
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDUPDT2 DOCLI B CTM. PROD. DOC
============================================================================
DAYS DCAL
AND/ OR
WDAYS 2, 3, 4, 5, 6 WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 08 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
============================================================================
I N DEPOSI TS PREV
CONTROL
RESOURCE
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
IN: Runtime Scheduling Parameter
506 CONTROL-M for OS/390 and z/OS User Guide
Example 4
This report must run after the database has been updated by either of two jobs,
EBDUPDT2 or EBDUPDT3, but only if IMS is active.
Figure 211 IN Parameter Example 4
This job is submitted only if IMS is active and if job EBDUPDT2 (or EBDUPDT3)
finished executing.
JOB: EBDRPT6C LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
DESC EBD PRODUCTI ON DATABASE REPORTS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDRPT6C DOCLI B CTM. PROD. DOC
============================================================================
DAYS 01, 15 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
============================================================================
I N | EBD- EBDUPDT2- ENDED ODAT | EBD- EBDUPDT3- ENDED ODAT
I MS- ACTI VE STAT
CONTROL
RESOURCE
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
IN: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 507
Example 5
Use of parentheses in the IN conditions is demonstrated in the following example. Job
EDBCLEAN requires that two conditions be satisfied before submission. The first
must be either condition CICSP1-IS-UP or condition CICSP2-IS-UP. The second must
be either condition OPR-CLEAN-REQUEST or condition SYS-CLEAN-REQUEST.
Figure 212 IN Parameter Example 5
Example 6
The following example provides a further explanation of the concept of the schedule
date reference:
Figure 213 IN Parameter Example 6
Today is the 15th September. The date reference values resolved in this job are
written in mmdd date format:
JOB: EBDCLEAN LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDCLEAN DOCLI B
============================================================================
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
============================================================================
I N ( CI CSP1- I S- UP 0101 | CI CSP2- I S- UP) 0101
( OPR- CLEAN- REQUEST ODAT | SYS- CLEAN- REQUEST) ODAT

CONTROL
RESOURCE I NI T 0001 CART 0001
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MEMNAME EBDRPT6D
MEMLI B EBD. PROD. JOB
DAYS 01, 15, 20
MONTHS 1- N 2- N 3- N 4- N 5- N 6- N 7- Y 8- N 9- Y 10- N 11- N 12- N
I N EBD- REPORTS- READY * * * *
IN: Runtime Scheduling Parameter
508 CONTROL-M for OS/390 and z/OS User Guide
Table 180 Date Reference Values Example 6
Subparameter Value
ODAT 0915
PREV 0901
**** Any date reference.
INTERVAL: PostProcessing Parameter
Chapter 3 Job Production Parameters 509
INTERVAL: PostProcessing Parameter
Minimum time to wait between reruns or cyclic runs of a job.
A related topic, cyclic jobs, is discussed in TASKTYPE: General Job Parameter on
page 643.
Figure 214 INTERVAL Parameter Format

Optional. INTERVAL consists of the following subparameters:
Table 181 INTERVAL Subparameters (Part 1 of 2)
Subparameter Description
interval_number A number from 0 through 64800, depending on the value
entered in the interval_type field, specifying the minimum time
to wait between reruns or cyclic runs. Leading zeros are not
required. Mandatory.
Default: 00000, indicating that there is no minimum time
interval between runs.
INTERVAL: PostProcessing Parameter
510 CONTROL-M for OS/390 and z/OS User Guide
General Information
The INTERVAL parameter defines a minimum interval between reruns or cyclic runs
of the same job.
Once the job has run, the CONTROL-M Monitor does not rerun or resubmit the job
unless both the following conditions are satisfied:
s the specified time has passed
s all runtime submission criteria, such as resources, conditions, and so on, are
satisfied
The FROM subparameter specifies the point from which the interval is measured.
The values set for this subparameter have the following effects:
s If STRT is specified, the interval is measured from the start time of the previous
run.
s If END is specified, the interval is measured from the time the previous run ended.
interval_type A single character describing the type of data specified in the
INTERVAL field. Valid values are:
s D (Days) Maximum INTERVAL value is 45
s H (Hours) Maximum INTERVAL value is 1080
s M (Minutes) Maximum INTERVAL value is 64800
Default: M
FROM Determinant of when the time to wait between reruns or cyclic
runs of a job begins. Valid values are:
s STRT Begin measuring the interval before the next cycle
of the job from the actual start of the current job run.
s END Begin measuring the interval before the next cycle
of the job from the end of the current job run. Default.
s TRGT Begin measuring the interval before the next cycle
of the job from when the current job run is scheduled.
Table 181 INTERVAL Subparameters (Part 2 of 2)
Subparameter Description
INTERVAL: PostProcessing Parameter
Chapter 3 Job Production Parameters 511
s If TRGT is specified, the interval is measured from the scheduling time of the
current job run.
If no value was specified in the TIME FROM parameter, the interval is measured
from the time the CONTROL-M Monitor scheduled the current job run.
For more information about the TIME FROM parameter, see TIME: Runtime
Scheduling Parameter on page 648.
Example
A backup for an ADABAS database failed because the database was being used by
another user. Backups are tried every 15 minutes after the job ends, to a maximum of
nine attempts.
Figure 215 INTERVAL Parameter Example
JOB: ADBBKPS LI B CTM. PROD. SCHEDULE TABLE: ADABAS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN 9 RERUNMEM I NTERVAL 0015 M FROM END
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST BACKUP PROCST CODES U0034 A/ O
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
===== >>>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<<< =====





COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MAXRERUN: PostProcessing Parameter
512 CONTROL-M for OS/390 and z/OS User Guide
MAXRERUN: PostProcessing Parameter
Maximum number of automatic reruns to be performed for the job. Called RERUN
MAXRERUN prior to version 6.0.00.
Figure 216 MAXRERUN Parameter Format

Optional. Valid values are: 0 through 255. Default: 0 (no automatic reruns).
General Information
When a job is first run, the MAXRERUN field in the Active environment, that is, in
the Zoom screen, contains the same value as the MAXRERUN parameter in the job
scheduling definition. However, in the Active environment MAXRERUN works as a
reverse-counter of automatic reruns. Each time the job is automatically rerun, the
value is decreased by one until the field contains a value of zero.
The automatic rerun process works as follows:
1. The CONTROL-M monitor determines that automatic rerun is possible only if the
job ENDS NOTOK and a specified DO RERUN statement is activated during
post-processing. If the monitor determines that automatic rerun is possible, it sets
the status of the job to ENDED NOTOK RERUN NEEDED.
2. The monitor then checks the value of MAXRERUN in the Active environment. If
the value is zero, automatic rerun is not possible and the job is not submitted for
rerun. If the value is greater than zero, rerun is possible and the monitor submits
the job for rerun when all runtime criteria are satisfied. Runtime criteria include
not only criteria in the Runtime Scheduling parameters, but also the INTERVAL
parameter, which specifies the minimum allowable interval between runs of the
same job.
MAXRERUN: PostProcessing Parameter
Chapter 3 Job Production Parameters 513
3. The JCL for the rerun job is taken from the member specified in the RERUNMEM
parameter. If no RERUNMEM value is specified, the JCL for the rerun is taken
from the regular JCL member of the job that is specified in the MEMNAME
parameter.
MAXRERUN applies only to automatic reruns. The MAXRERUN counter is not
affected by reruns performed manually using the Rerun option in the Active
Environment screen.
If a job is defined as cyclic by setting the TASKTYPE parameter to CYC, the
MAXRERUN parameter can be used to specify the number of iterations. This number
excludes the initial run of the job.
Examples
Example 1
A tape I/ O error occurred. Try two more times. If there are two more failures,
terminate:
MAXRERUN 2 RERUNMEM I NTERVAL 0015 M FROM END
ON PGMST STEP01 PROCST CODES S613
DO RERUN
MAXRERUN: PostProcessing Parameter
514 CONTROL-M for OS/390 and z/OS User Guide
Example 2
When a job abends for any reason, try to restart it two more times (at the abended
step).
Figure 217 MAXRERUN Parameter Example 2
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT PRDKPL01- ENDED- OK ODAT +
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN 2 RERUNMEM I NTERVAL 0015 M FROM END
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 A/ O
DO I FRERUN FROM $ABEND . TO . CONFI RM N
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< ======




COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MAXWAIT: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 515
MAXWAIT: Basic Scheduling Parameter
Number of extra days the job can wait in the Active Jobs file for submission.
Figure 218 MAXWAIT Parameter Format

Optional. Valid values are: any 2-digit number in the range from 00 through 98, or 99.
If no value is specified, the default value of 00 is automatically inserted. This default
value may be changed by your INCONTROL administrator, by means of Wish
WM2367 in the IOADFLT member in the IOA IOAENV library.
General Information
The MAXWAIT parameter is used to overcome the problem of delays in production.
A job that is scheduled for execution on a specific day does not always get executed
that same day. This can be due to a number of reasons, such as hardware failure or a
heavy production workload. Therefore, it may be desirable to specify an additional
number of days that the job must remain in the Active Jobs file awaiting execution.
When a job cannot be submitted for execution within the specified time limits, an
appropriate message is written to the IOA Log file, and the job is deleted from the
Active Jobs file.
Table 182 MAXWAIT Parameter Values
Value Description
00 Job is not executed if it did not execute on the original
scheduling date. Default.
nn Where nn = 01 98. If the job did not execute on its original
scheduling date, it is given an additional number of days to
execute. It can remain in the Active Jobs file up to nn days
awaiting execution.
99 Job remains in the Active Jobs file until deleted manually, even
if the job finished executing.
MAXWAIT: Basic Scheduling Parameter
516 CONTROL-M for OS/390 and z/OS User Guide
Jobs scheduled as a result of a Y value in the RETRO parameter are always given at
least one day within which to execute, even if the MAXWAIT parameter indicates
that they must no longer be in the Active Jobs file. This occurs when the current
working date exceeds the original scheduling date (ODATE) by more than the
number of days specified in the MAXWAIT parameter on the day the job is scheduled
by RETRO=Y. For more information, see RETRO: Basic Scheduling Parameter on
page 598.
Emergency jobs not belonging to a group are discarded if their specified MAXWAIT
periods have passed. An emergency job that belongs to a specific group (specified in
the GROUP parameter) and whose MAXWAIT period has not passed is not deleted
from the Active Jobs file until all of the regular jobs that belong to the same group
have finished executing. This is in case the job is needed at a later stage.
MAXWAIT Values for Jobs in a Group Scheduling Table
The MAXWAIT value for jobs in a Group scheduling table is normally determined by
the MAXWAIT parameter in the schedule tags defined in the Group entity. However:
s If the TAGMAXWT parameter in the CTMPARM member in the IOA PARM
library is set to N (No), the MAXWAIT value for each job in the group is instead
determined by the value of the MAXWAIT parameter in its job scheduling
definition.
s If AND is specified in the RELATIONSHIP parameter, the MAXWAIT value from
the job scheduling definition is used (regardless of the value of the TAGMAXWT
parameter).
s If a job in a group is forced, the MAXWAIT value is determined by the value of the
MAXWAIT parameter in the job scheduling definition, regardless of the value of
the TAGMAXWT parameter.
MAXWAIT: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 517
Examples
Example 1
If the original scheduling date of the job has passed, give the job an extra three days to
be submitted.
Figure 219 MAXWAIT Parameter Example 1
Assume that the job does not run due to the absence of the required runtime
resources. The job that is scheduled for the 2nd of the month can wait from the 2nd
through the 5th to be executed.
On the 6th, the MAXWAIT period expires and the job scheduled for the 2nd is not
executed. The jobs scheduled for the 4th and 6th wait for execution until the 7th and
9th.
Example 2
The job can wait for execution indefinitely, until the runtime requirements for the job
are satisfied:
JOB: OPERJOB LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERJOB MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN I N FI RST HALF OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERJOB DOCLI B CTM. PROD. DOC
==========================================================================
DAYS 02, 04, 06 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 03 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
==========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MAXWAI T 99
MAXWAIT: Basic Scheduling Parameter
518 CONTROL-M for OS/390 and z/OS User Guide
Example 3
Schedule the job for every working day, even if the computer is not active. Give the
job an extra day in which to be submitted.
Assume that calendar WORKDAYS, specified in the DCAL parameter, contains the
values 15, 16, 18, and 19. The computer was offline from the 16th up to and including
the 18th, and the 15th was the last date that the job was scheduled for execution.
Figure 220 MAXWAIT Parameter Example 3
Today is the 19th. The job is scheduled three times with the different original
scheduling dates of the 16th, 18th and 19th.
The jobs on the 16th and 18th are disregarded on the 20th if they have not yet
executed. The job on the 19th is disregarded only on the 21st.
Example 4
Schedule the job for every working day, even if the computer is not active. If it does
not execute within the scheduled day, remove it from the Active Job file:
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL WORKDAYS
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 01 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MAXWAI T 00
MEMLIB: General Job Parameter
Chapter 3 Job Production Parameters 519
MEMLIB: General Job Parameter
For a job (or warning messages): Name of the library containing the member specified
in the MEMNAME parameter.
For a started task: Required started task information.
A related parameter is discussed in OVERLIB: General Job Parameter on page 563.
Figure 221 MEMLIB Parameter Format

Mandatory. Format of the parameter depends on whether the job scheduling
definition applies to a job (or warning messages) or a started task:
s For a job (or warning messages):
Valid values are a valid data set name of 1 through 44 characters, or one of the
reserved values shown in Table 183.
Table 183 MEMLIB Parameter Values for Non-Started Tasks
Value Description
DUMMY For dummy jobs.
For warning messages, do not use DUMMY as a value for this
parameter.
USER=name For user-defined libraries.
GENERAL Specifies the library referenced by the DALIB DD statement in
the CONTROL-M procedure.
MEMLIB: General Job Parameter
520 CONTROL-M for OS/390 and z/OS User Guide
s For a started task:
Any of the formats shown in Table 184 can be used for the MEMLIB value.
General Information
Whether the job scheduling definition applies to a job, warning messages, or a started
task is determined by the values defined in the TASKTYPE parameter, which is
described in TASKTYPE: General Job Parameter on page 643.
AutoEdit variables can be specified and are resolved. Even the machine ID, which is
relevant for started task initiation, can be automatically replaced based on resource
allocation. For more information, see Chapter 5, JCL and AutoEdit Facility.
For Jobs (or Warning Messages)
The library can be any standard cataloged partitioned data set (PDS or PDSE),
LIBRARIAN or PANVALET. The record length must be 80.
Table 184 MEMLIB Parameter Formats for Started Tasks
Format Description
*.taskid Where taskid is the task ID. The STC is activated in the
computer in which the CONTROL-M monitor is active.
cpuid, stcparms Where cpuid is the ID of the computer in which the STC is to be
activated (see the following value cpuid); stcparms represents
STC parameters.
cpuid Where cpuid is the ID of the computer in which the STC is to be
activated. Valid cpuid values are:
s * The same computer where the CONTROL-M monitor is
active.
Under JES2:
s Nn Where n is the JES/ NJE node ID.
s Mm Where m is the machine ID.
s NnMm Where n is the JES/ NJE node ID, and m is the
machine ID.
Under JES3
s Lname Where name is the logical JES name of the machine,
that is, the name as used in the JES3 command *T, not the
SMF system ID.
MEMLIB: General Job Parameter
Chapter 3 Job Production Parameters 521
The library and the member do not have to exist when the job production parameters
are defined. Their existence is checked by CONTROL-M before actual submission of
the job.
If, during the access to a library by CONTROL-M (before submission), the library is
held exclusively by another user, such as a TSO user or job, the monitor tries to access
the library every few seconds until the library is released and the job can be
submitted. If the library is migrated, for example, through HSM, CONTROL-M
remains in a WAIT state until the library is recalled.
Use of the library name DUMMY is intended for scheduling events, for example,
adding a prerequisite condition without actually running the job. If the library name
DUMMY is used, the job is not submitted; submission and sysout checking are
skipped. In this case, the job is assumed to have ended OK (ON PGMST...DO
processing is not performed), and Post-Processing parameters associated with an
ENDED OK status are activated (OUT, SHOUT WHEN OK).
If the library name is GENERAL:
s The job is submitted from the library referenced by the DALIB DD statement of the
CONTROL-M procedure. This library must be a partitioned data set or a
concatenation of partitioned data sets.
s If you want to edit JCL members from within the IOA Online facility through the J
(JCL) option in either the Job List screen or the Active Environment screen, do the
following:
1. In the IOA Online (TSO Logon) procedure, concatenate the JCL libraries in
DD name DALIB.
2. Remove the DALIB reference in the ALCCTM member in the IOA PARM
library.
s If more than four JCL libraries are concatenated, CONTROL-M Exit CTMX014 (the
CTMX014G member in the IOA SAMPEXIT library) must be installed if the
members are going to be edited online through the J (JCL) option in the Job List
screen or the Active Environment screen.
s The prefix USER= must be specified when a special type of user library is used.
When using this prefix, the member is not read by CONTROL-M using the normal
mechanism. Instead CONTROL-M submission Exit CTMX002 must be coded to
handle access and submission of the library and member. For examples of the exit,
see the IOA SAMPEXIT library.
When specifying option J (JCL) in the Job List screen or the Active Environment
screen in order to edit the JCL member, CONTROL-M must determine which library
(MEMLIB or OVERLIB) to use.
MEMLIB: General Job Parameter
522 CONTROL-M for OS/390 and z/OS User Guide
For Started Tasks
A started task is activated in the specified computer ID. This is the ID of the computer
in JES, not the 4-character SMF ID. You can use the $LSYS JES command to determine
the JES ID. For more information, see the discussion on specifying IOA CPUs in the
description of the customization process in the INCONTROL for OS/390 and z/OS
Installation Guide. If the computer ID is followed by a comma and parameters, the
parameters are applied to the started task.
Examples
Example 1
Submit the job from the IMSBKUP member in the SYS2.IMS.JOB library:
Example 2
Activate started task COLCTSMF in the computer where the CONTROL-M monitor
is operating:
On September 5, the STC is activated by issuing the operator command:
Example 3
Activate started task GTF in the computer in which the CONTROL-M monitor is
operating; task ID is G01:
NOTE
The algorithm for this decision is described in Editing A Member through The J
(JCL) Option on page 565.
MEMNAME I MSBKUP
MEMLI B SYS2. I MS. JOB
MEMNAME COLCTSMF
MEMLI B * , DATE=%%ODATE
S COLCTSMF, DATE=000905
MEMNAME GTF
MEMLI B * . G01
MEMLIB: General Job Parameter
Chapter 3 Job Production Parameters 523
The STC is activated by issuing the operator command:
Example 4
Activate started task COLCTSMF on JES node 1:
Example 5
Activate started task COLCTSMF on machine 1 on JES node 1:
Example 6
The JCL for the job OPERCOMP is stored in the library CTM.MOD.JCL.
Figure 222 MEMLIB Example 6
S GTF. G01
MEMNAME COLCTSMF
MEMLI B N1, DATE=%%ODATE
MEMNAME COLCTSMF
MEMLI B N1M1, DATE=%%ODATE
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
=========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
=========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MEMNAME: General Job Parameter
524 CONTROL-M for OS/390 and z/OS User Guide
MEMNAME: General Job Parameter
Name of the member that contains one of the following (depending on the defined
task type):
s JCL of the job
s Started task procedure
s Warning messages
For more information, see MEMLIB: General Job Parameter on page 519.
Figure 223 MEMNAME Parameter Format

Mandatory. MEMNAME identifies a valid member name of 1 through 8 characters.
For On Spool jobs, mask characters * and ? are supported. For details, see Character
Masking on page 83 and On Spool Jobs on page 669.
General Information
The MEMNAME parameter identifies a member whose contents are determined by
the task type of the job scheduling definition. For more information, see TASKTYPE:
General Job Parameter on page 643.
NOTE
For a Group Entity, this parameter has a different meaning, which is explained in
For a Group Entity on page 525.
NOTE
CONTROL-M does not support members that have been compressed using the ISPF
PACK option.
MEMNAME: General Job Parameter
Chapter 3 Job Production Parameters 525
s If TASKTYPE contains the value JOB, CYC, EMR or ECJ, the job scheduling
definition is defined for a job and the MEMNAME parameter identifies the
member that contains the JCL of the job.
s If TASKTYPE contains the value STC, CST, EST or ECS, the job scheduling
definition is defined for a started task and the MEMNAME parameter identifies
the member that contains the started task procedure.
s If TASKTYPE contains the value WRN, the job scheduling definition is defined for
warning messages and the MEMNAME parameter identifies the member that
contains the warning messages.
For a Job
The member name may be the same as or different than the job name.
The member can contain the JCL of more than one job. By default, CONTROL-M
processes only the first job in the member. If, however, the MULTJOBS parameter in
the CTMPARM member in the IOA PARM library is set to Y (Yes), CONTROL-M
submits all the jobs in the member, but still only monitors the execution and results of
the first job in the member. Therefore, BMC Software recommends that each member
contain the JCL of only one job.
For a Group Entity
In a Group Entity, the MEMNAME parameter does not indicate a member name.
Instead, MEMNAME is used for descriptive purposes in certain screens, such as in
the NAME field of the Active Environment screen.
MEMNAME: General Job Parameter
526 CONTROL-M for OS/390 and z/OS User Guide
Example
The JCL for job OPERCOMP is located in the OPERCOMP member in the library
CTM.PROD.JCL.
Figure 224 MEMNAME Parameter Example
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
==========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
==========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MINIMUM: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 527
MINIMUM: Basic Scheduling Parameter
Minimum number of free tracks required by the library specified in the PDS
parameter.
A related parameter is discussed in PDS: Basic Scheduling Parameter on page 571.
Figure 225 MINIMUM Parameter Format

Optional. However, if PDS is specified, MINIMUM is mandatory. The MINIMUM
parameter specifies the minimum number of free tracks required. This must be a
positive 3-digit number; leading zeros are inserted if necessary.
The MINIMUM parameter cannot be used with the DAYS, WDAYS, MONTHS,
CONFCAL, RETRO and DATES parameters.
General Information
The MINIMUM and PDS parameters are always used together and are never used
with other Basic Scheduling parameters.
The PDS parameter identifies a library, and the MINIMUM parameter specifies the
minimum number of free tracks required by that library.
These parameters are intended for use (that is, definition) in jobs and started tasks
that compress, clean and/ or enlarge libraries, or which issue a warning message to
the IOA Log file (that is, if TASKTYPE=WRN) if the minimum number of free tracks
is not available.
If the MINIMUM and PDS parameters are defined for a job, the scheduling of the job
is not related to or dependent upon any date criteria. Instead, the job is scheduled if
the actual number of free tracks available in the specified library is below the
specified minimum at time of daily job ordering. The job or started task can then
compress, clean, or enlarge the library (or issue the appropriate warning).
MINIMUM: Basic Scheduling Parameter
528 CONTROL-M for OS/390 and z/OS User Guide
Examples
Example 1
Schedule the job when there are less than 20 unused tracks in the library
ALL.PARMLIB.
Figure 226 MINIMUM Parameter Example 1
Example 2
Send a warning message when there are less than 50 unused tracks in the library
USER.LIBRARY:
Figure 227 MINIMUM Parameter Example 2
NOTE
MINIMUM does not work with PDSE-type libraries because they always appear to be
100 percent full. MINIMUM only checks current extents.
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B GENERAL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP OPER- MAI NT
DESC COMPRESS OF ALL. PARMLI B
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
==========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- 2- 3- 4- 5- 6- 7- 8- 9- 10- 11- 12-
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM 020 PDS ALL. PARMLI B
DEFI NI TI ON ACTI VE FROM UNTI L
==========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MEMNAME MSG001
TASKTYPE WRN
PDS USER. LI BRARY
MI NI MUM 050
MONTHS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 529
MONTHS: Basic Scheduling Parameter
Months of the year in which the job must be scheduled.
Figure 228 MONTHS Parameter Format

Optional. The months in the year are represented by the numbers 1 through 12. A
value can be specified for each month. Valid values are:
General Information
In general, the job is scheduled for execution only during the months in which a value
of Y is specified. There are certain exceptions that are noted below.
The MONTHS parameter cannot be used with the PDS and MINIMUM parameters.
If values are set for both the MONTHS parameter and the DATES parameter, the
MONTHS parameter setting is ignored.
When the MONTHS parameter is used, at least one of the following must be
specified: DAYS, DCAL, WDAYS or WCAL. When specified with one of these
parameters, the MONTHS parameter works as a filter to limit the job schedule.
The MONTHS parameter is ignored when periodic values are specified in the DAYS
or WDAYS parameter.
Table 185 MONTHS Parameter Values
Value Description
Y (Yes) Schedule the job in that month. Default.
N (No) or blank Do not schedule the job in that month.
MONTHS: Basic Scheduling Parameter
530 CONTROL-M for OS/390 and z/OS User Guide
In the following exceptional cases, a job can be scheduled in a month not specified as
a working month:
s When Ln and/ or Dn values are specified in a week that overlaps two months, the
MONTHS value of the earlier month determines whether Dn or Ln values are
applied in the week:
If the first day of the week falls in a month with a MONTHS value of Y, all Dn
and Ln values in that week are applied, even those falling in the next or
previous month when that month has a MONTHS value of N.
If the first day of the week falls in a month with a MONTHS value of N, no Dn
or Ln values in that week are applied, not even those falling in the next or
previous month when that month has a MONTHS value of Y.
s If a greater than or less than qualifier in the DAYS specification shifts the
scheduling out of the current month, and the month to which it shifts is a
non-scheduled month, the job is nevertheless scheduled in that non-scheduled
month.
Example
If the values of the DAYS parameter >31, the MONTHS parameter indicates
JANUARY and MARCH (but not FEBRUARY).
The associated calendar has all days except JANUARY 31 as working days.
Then the job is scheduled on February 1.
Examples
Example 1
Schedule a job only in March and September:
MONTHS 1- N 2- N 3- Y 4- N 5- N 6- N 7- N 8- N 9- Y 10- N 11- N 12- N
MONTHS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 531
Example 2
Schedule job OPERCOMP on the first day of every month.
Figure 229 MONTHS Parameter Example 2
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
==========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
==========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
NJE NODE: General Job Parameter
532 CONTROL-M for OS/390 and z/OS User Guide
NJE NODE: General Job Parameter
Identifies the node in the JES network at which the job is to execute.
Figure 230 NJE NODE Parameter Format
NJE NODE specifies a node name of 1 through 8 characters. Only trailing blanks are
allowed.
By default, the NJE NODE parameter is optional.
General Information
The NJE NODE parameter is used to identify the node in the JES network at which
the job is to execute.
If a value is specified for the NJE NODE parameter, a JCL statement is generated. The
precise form of the statement depends on whether CONTROL-M is running under
JES2 or JES3.
Under JES2
If CONTROL-M is running under JES2, the NJE NODE parameter generates the
following JCL statement:
Under JES3
If CONTROL-M is running under JES3, the JCL statement generated by the NJE
NODE parameter differs slightly, taking the following form:
/ * ROUTE XEQ node_name
/ / * ROUTE XEQ node_name
NJE NODE: General Job Parameter
Chapter 3 Job Production Parameters 533
If a value is specified for the NJE NODE parameter, it will not override any node
name specified in the job statement unless the OVERJCLM parameter in the
CTMPARM library is set to Y.
Examples
Example 1
CONTROL-M is running under JES2. The following is specified:
The following statement is added to the JCL of the job:
and the job is executed at node OS35.
Example 2
CONTROL-M is running under JES3. The following is specified:
The following statement is added to the JCL of the job:
and the job is executed at node OS35.
DESC
OVERLI B
SCHENV SYSTEM I D NJE NODE OS35
/ * ROUTE XEQ OS35
DESC
OVERLI B
SCHENV SYSTEM I D NJE NODE OS35
/ / * ROUTE XEQ OS35
ON: PostProcessing Parameter
534 CONTROL-M for OS/390 and z/OS User Guide
ON: PostProcessing Parameter
Job processing step and code event criteria that determine whether the accompanying
DO statements are performed.
For more information, see STEP RANGE: PostProcessing Parameter on page 630.
Figure 231 ON Parameter Format

Optional. ON statements define event criteria that identify specific CONTROL-M job
steps and possible codes that result from the execution of those job steps.
The ON statement consists of the subparameters described below. When used, at
least one step and one code must be specified.
Table 186 ON Parameter Subparameters (Part 1 of 3)
Subparameter Description
PGMST Job step. The execution results of the program executed by the
job step are checked against the specified codes criteria. 1
through 8 characters. Mandatory. Valid values are:
s pgmstep Name of the step (EXEC statement):
/ / pgmstep EXEC PGM=program
The ON statement is satisfied only when the program
execution results from the specified step satisfy the
specified code criteria. For more information, see
PGMST on page 538.
s *rangename Range name. rangename is the name of a step
range defined in the STEP RANGE parameter. The asterisk
(*) preceding the name indicates to CONTROL-M that the
specified name is a range name, not a step name. For more
information, see STEP RANGE on page 539, and STEP
RANGE: PostProcessing Parameter on page 630.
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 535
Note: Some third party products produce JCL step names that
begin with an * (asterisk) character. If you specify a JCL step
name of this type in an ON PGMST statement, CONTROL-M
interprets this step name as a step range.
The solution is to define a workaround step range that
includes only the problematic step name.
For example, to process the step name *OMVSEX, use the
following:
STEP RANGE ONESTEP FR ( PRM. PROC) * OMVSEX . TO * OMVSEX
ON PGMST * ONESTEP PROCST CODES xxxxx
s ANYSTEP Any job step
Generally, the ON statement is satisfied when the program
execution results from any job step satisfy the specified
code criteria. For more information, including the
exceptions, see Step Name: ANYSTEP on page 539.
s +EVERY Every job step
The ON statement is satisfied if the program execution
results from every job step satisfying the specified code
criteria. For more information, see Step Name: +EVERY
on page 540.
PROCST Procedure step (EXEC statement) that invokes a procedure
from which the specified PGMST program is executed. 1 to 8
characters. Optional. Valid values are:
s blank When left blank, matching program step names
(PGMST) are checked regardless of whether they are
directly from the job or from a called procedure. Default.
The ON statement is satisfied if the PGMST criteria are
satisfied from any procedure directly from the job.
s Procstep Name of a specific procedure step:
/ / procstep EXEC procedure
If a specific procedure step is specified, only program steps
from the invoked procedure are checked to see if they
satisfy the code criteria. Program steps directly from the
job are not checked.
Table 186 ON Parameter Subparameters (Part 2 of 3)
Subparameter Description
ON: PostProcessing Parameter
536 CONTROL-M for OS/390 and z/OS User Guide
General Information
ON statements are usually, but not necessarily, followed by user-specified DO
actions. The implied relationship between ON statements and associated DO
statements is:
The combination of ON statements and DO statements enables you to specify
post-processing actions whose performance depends on the execution results of job
steps executed under CONTROL-M.
+EVERY
Matching program step names (PGMST) are checked from all
called procedures and from the job itself.
The ON statement is satisfied only when the code criteria for
the program step are satisfied for all occurrences (called
procedures and directly in the job stream). For more
information, see Step Name: +EVERY on page 540.
CODES Return codes or statuses that can satisfy the step or code event
criteria if returned upon termination of the specified job steps.
At least one code must be specified. CODES can be condition
codes, user abend codes, system abend codes, various end
codes and statuses, and certain keywords. CODES are
discussed in General Information, immediately below this
table.
A/ O Optional. Specifying either A (And) or O (Or) opens a new ON
statement in the ON block (described later) and links the new
statement to the statement containing the A/ O specification,
as follows:
s A (And) Indicates AND logic between the two ON
statements. ON block criteria are satisfied only if both ON
statements are satisfied.
s O (Or) Indicates OR logic between the two ON
statements. ON block criteria are satisfied if either (or both)
ON statements are satisfied.
Table 187 ON and DO Statements Relationship
Statement Description
IF ON statement step and code event criteria are satisfied,
THEN Perform the associated DO statements.
Table 186 ON Parameter Subparameters (Part 3 of 3)
Subparameter Description
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 537
Multiple ON Statements and ON Blocks
In a new job scheduling definition, an empty ON statement is followed by an empty
DO statement. Additional ON statements can be opened in the job scheduling
definition as follows:
s When you fill in an ON step and code value and press Enter, an empty ON and
DO statement is opened following the current ON and DO statements. The new
ON and DO statements, if filled in, are not logically connected to the preceding ON
and DO statements. They constitute a new ON block and DO block.
Multiple ON blocks are normally interpreted sequentially. If the conditions of an
ON block are satisfied, the accompanying DO actions are performed. The
conditions of more than one ON block can be satisfied; therefore, more than one set
of DO statements can be performed.
Example
One ON block specifies STEP1 as the program step, and >C0004 as the code.
A second ON block specifies ANYSTEP as the program step, and >C0008 as the
code.
If STEP1 results in a condition code of C0016, the ON step and code event criteria
for both ON statements are satisfied, and the DO actions accompanying both ON
blocks are performed.
s When you fill in the A/ O (And/ Or) subparameter of an ON statement, an empty
ON statement is opened immediately, that is, before the accompanying DO
statement. The specified And/ Or value logically connects the new ON statement
to the preceding ON statement. These two ON statements constitute a single ON
block.
Example
ON PGMST STEP1 . . . CODES C0004 . . . A/ O A
ON PGMST STEP5 . . . CODES S0C4 . . . A/ O
DO SHOUT . . .
In the above ON and DO statements, for the DO SHOUT action to be performed,
STEP1 must end with a condition code of C0004, and STEP5 must end with system
abend S0C4.
To add an empty ON statement between two existing ON statements, type the >
character over the first letter in the ON PGMST value of the previous ON line, and
press Enter.
ON: PostProcessing Parameter
538 CONTROL-M for OS/390 and z/OS User Guide
Example
If the program step name is STEP1:
adds an empty ON line after the current ON statement. Step name STEP1 is
restored to its original value when Enter is pressed (that is, the > character
disappears).
To delete unwanted ON statements, specify appropriate Line Editing commands in
the Edit environment, described in Appendix C, Editing Job Scheduling Definitions
in the Edit Environment, and in particular in Line Editing Commands on
page 937.
Restart Using All Runs of a Job Including Restarts
When processing ON blocks, CONTROL-M can incorporate the results of all previous
runs and restarts, filtering them for jobs restarted with the RESTART, RECAPTURE
CONDITION, and/ or ABEND CODES parameters. CONTROL-M/ Restart searches
previous runs to determine which steps must be considered part of the restarted job.
For example, if one step finished successfully during its original run and another step
finished successfully after a restart, the ON block check for the successful finish for
both steps produces a TRUE result and the ON statement is satisfied.
Activation of this facility requires that the ALLRUNS parameter in the CTRPARM
member be set to YES. When activated, this facility can apply to any specified step,
step range, or to step value +EVERY. Restart
Step Values
PGMST
Within an ON statement, the specified step is generally a program step, specified in
field PGMST. It may be a program executed directly within the job stream, in which
case no PROCST value is specified, or it may be a program executed by a called
procedure, in which case the called procedure is specified in PROCST.
ON PGMST >TEP1
NOTE
Post-processing of ON PGMST statements during a RESTART or RERUN is
independent of the post-processing of the same ON PGMST statements during the
earlier run. In these situations, you may get duplicate actions.
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 539
If the JCL contains nested procedures, the name of the EXEC procedure statement
that invokes the most deeply nested procedure, that is, the procedure that
immediately invokes the PGM step, must be specified in PROCST.
The same step name can appear in different ON statements in the same ON block, or
different ON blocks.
STEP RANGE
To check codes in a range of steps, first define the step range and assign it a name in
the STEP RANGE statement, which is described in STEP RANGE: PostProcessing
Parameter on page 630. Then specify the name, preceded by an asterisk, in the
PGMST field. The * indicates that the specified name is a range name, not a step
name. The range of steps is displayed, and you can check the codes that are displayed
within the defined range.
If CONTROL-M adds a CONTROL-M/ Restart step to a job, for example, if a job is
restarted by CONTROL-M/ Restart, or if PREVENT NCT2 is specified in the job
scheduling definition, the CONTROL-M/ Restart step is processed like all other job
steps.
Example
In the STEP RANGE statement, name DF2 is assigned to the range of program steps
STEP20 through STEP29A.
If *DF2 is specified in ON PGMST, the ON step and code criteria is satisfied if any of
the codes result from any of the steps in the range STEP20 through STEP29A.
Step Name: ANYSTEP
Value ANYSTEP can be specified in field PGMST. In general, it indicates that the DO
statements must be performed if the specified codes are found in any steps.
However, if ANYSTEP is specified with codes OK, NOTOK, EXERR, JLOST, JNRUN,
JSECU, JNSUB or *UKNW, the ON criteria are satisfied only if the entire job ends
with the specified code criteria.
If ANYSTEP is specified with code FORCE, no other codes can be specified in the
same ON block, and the PROCST parameter must be left blank. For a description of
code FORCE, see Valid CODES Values on page 542.
ON: PostProcessing Parameter
540 CONTROL-M for OS/390 and z/OS User Guide
Step Name: +EVERY
The value +EVERY is used without being accompanied by limiting step values when
the code criteria must be satisfied for every step. The following examples all have the
same impact the code criteria must be satisfied for every step in the job without
exception.
Examples
s ON PGMST +EVERY PROCST
s ON PGMST ANYSTEP PROCST +EVERY
The ANYSTEP value is not a limiting value. In this case, it has the same meaning as
+EVERY.
s ON PGMST +EVERY PROCST +EVERY
Value +EVERY is generally accompanied by a limiting step value when the code
criteria must be satisfied for every step within the specified limits, as follows:
s If the limiting value is a PROCST value, the code criteria must be satisfied by all job
steps from within the specified procedure.
Example
ON PGMST +EVERY PROCST STEP1
Every program step of procedure step STEP1 must be satisfied.
s If the limiting value is a PGMST value, the code criteria must be satisfied by all
executions of the specified job step (or range of steps if a range is specified), from
within the job steam and within all procedures.
Examples
ON PGMST St epA PROCST +EVERY
All executions of job step STEPA from within the job stream and within every
procedure must be satisfied.
ON PGMST * Range1 PROCST +EVERY
Executions of all job steps in Range1, from within the job stream and within every
procedure, must be satisfied.
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 541
Step name +EVERY can be specified with the following codes: Cnnnn, Sxxx,
Unnnn, *xxxx, FLUSH, SNRUN and *****.
s When step name +EVERY is specified with codes Cnnnn, Sxxx, Unnnn and *xxxx,
the following conditions must be satisfied to satisfy the ON statement:
If the steps that run (excluding FLUSH steps) satisfy the PGMST and PROCST
criteria, they must also not contradict the Cnnnn, Sxxx, Unnnn or *xxxx codes.
At least one step runs and fulfills the above conditions.
s When step name +EVERY is specified with codes FLUSH, SNRUN or *****, the
following apply:
ON PGMST +EVERY CODES FLUSH is satisfied if in each job step, a JCL
COND or JCL IF/ THEN/ ELSE statement caused the step not to run.
ON PGMST +EVERY CODES SNRUN is satisfied if each job step did not run.
ON PGMST +EVERY CODES ***** is satisfied if each defined job step ran and no
job step was flushed (that is, due to a JCL COND or JCL IF/ THEN/ ELSE
statement).
CODES Values
CODES can be condition codes, user abend codes, system abend codes, various end
codes and statuses, and certain keywords. They can also be prefaced by certain
qualifiers. All of these are described below.
A maximum of 245 values can be specified for CODES in any ON step statement, as
follows:
s Each line of an ON statement contains fields for specification of up to four values
for CODES.
s Whenever a fourth value is specified on a line for CODES, and Enter is pressed, a
new line within the same ON statement is opened, allowing specification of as
many as four additional CODES values.
ON: PostProcessing Parameter
542 CONTROL-M for OS/390 and z/OS User Guide
Valid CODES Values
NOTE
A DO OK statement specified in the job scheduling definitions is ignored if
s any of the following status codes apply to the job:
EXERR
JNSUB
*REC0
*UKNW
-or-
s the DO OK statement was specified as part of an ON PGMSTEP ANYSTEP
pgmstep CODE NOTOK condition, because if that condition is satisfied, the status
of the job has already been set to NOTOK
Table 188 ON Parameter CODES Values (Part 1 of 3)
Value Description
$EJ Job was queued for re-execution.
***** Any step that executes (including steps with JCL errors and
steps returned with an ABEND code). For reasons of
backward compatibility, the CODES value ***** does not
include steps with code FLUSH or SNRUN (described below).
The CODES value ***** does, however, include jobs not
submitted and jobs whose sysout was lost if ON PGMST
ANYSTEP is specified.
Note: Although the CODES value **** includes steps which
have returned any system abend code, the preferred method
of indicating these steps is S***.
*NCT2 A NOT CATLGD 2 or NOT RECATLGD 2 event occurred in
the job step. The default result of this event is a NOTOK status
for the step. A message containing the data set name is written
to the IOA Log file.
Note: If you do not want to be alerted to NOT RECATLGD 2
events, see your INCONTROL administrator.
*REC0 Rerun (recovery) is needed, but no more reruns are available.
Note: This status code is REC followed by a zero (not the letter
O).
*TERM Job terminated by CMEM due to an NCT2 event.
*UKNW An unknown error occurred, usually as a result of a computer
crash during job execution. This value can only be specified
with step value ANYSTEP.
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 543
*xxxx Any step completion code (condition, system abend, user
abend) that matches the string, where x can be any
hexadecimal character (0 through 9, A through F) in
user-defined events, which are turned on by Exit 3. Regarding
usage, see your INCONTROL administrator.
Cnnnn Step condition code, where nnnn is a 4-digit value.
EXERR Any type of execution error. It is the same as NOTOK, but is
triggered only if the job has actually started executing. This
value can only be specified with step value ANYSTEP.
FLUSH A JCL COND or JCL IF/ THEN/ ELSE statement caused a step
to not run. This CODES value is described in more detail
below.
FORCE This code applies when a job is FORCEd OK from the Active
Environment screen (Screen 3). To specify a code of FORCE,
all of the following must apply:
s No other code can be specified in the same statement.
s The PGMST value must be ANYSTEP.
s No PROCST value can be specified.
s No other ON statements can appear in the ON block.
Valid DO statements for code FORCE are: DO SHOUT, DO
COND, DO FORCEJOB, DO SETVAR, and DO MAIL.
JFAIL Job failed due to JCL error.
JLOST Job sysout was lost. This value can be specified only with step
value ANYSTEP.
JNRUN Job was canceled during execution or re-execution. This value
can be specified only with step value ANYSTEP.
JNSUB Job not submitted. Submission of a job or initiation of a started
task failed for any reason. This value can be specified only
with step value ANYSTEP.
JSECU Job failed due to security requirements (only under ACF2).
This value can be specified only with step value ANYSTEP.
Table 188 ON Parameter CODES Values (Part 2 of 3)
Value Description
ON: PostProcessing Parameter
544 CONTROL-M for OS/390 and z/OS User Guide
FLUSH
The CODES value FLUSH generally applies when a step does not run but no error is
indicated. This CODES value is assigned in the following cases:
s A JCL COND or JCL IF/ THEN/ ELSE statement caused the step not to run.
CONTROL-M detects CODES value FLUSH steps by message IEF272I (Step was
not executed).
NOTOK A status of execution of the whole job.
This CODES value can only be specified with step value
ANYSTEP. It indicates that at least one PGM step, or the whole
job, finished executing NOTOK, meaning, with a condition
code greater than that set as the upper limit. By default, this
limiting condition code is C0004, but the MAXCCOK
parameter in the CTMPARM member in the IOA PARM
library can be used to set the default condition code to another
value, such as C0000.
This CODES value covers all types of failures, including
non-execution errors such as job not run, JCL error, or job not
submitted.
OK A status of execution of the whole job.
This CODES value can only be specified with step value
ANYSTEP. It indicates that all non-flushed PGM steps
finished executing OK, meaning, with a condition code equal
to or less than the condition code set as the upper limit. By
default, this limiting condition code is C0004, but the
MAXCCOK parameter in the CTMPARM member in the IOA
PARM library can be used to set the default condition code to
another value, such as C0000.
If a job is FORCEd OK, the DO statements following an ON
PGMST ANYSTEP pgmstep CODES OK statement are
processed only if the FRCOKOPT parameter in the
CTMPARM member in the IOA PARM library is set to Y (Yes).
SNRUN A step did not run. This CODES value is described in more
detail below.
Sxxx Step system abend code, where xxx is a 3-character hex value.
Unnnn Step user abend code, where nnnn is a 4-digit value.
Table 188 ON Parameter CODES Values (Part 3 of 3)
Value Description
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 545
s Restart If a job was restarted by CONTROL-M/ Restart, and CONTROL-M is to
consider all job runs during post-processing (the ALLRUNS parameter is set to
YES in the CTRPARM member), a step is defined as FLUSH if:
either the step did not previously run, or CONTROL-M/ Restart did not
recapture a completion or abend code from a previous run
and either
it was not executed during the RESTART run because of a JCL COND or JCL
IF/ THEN/ ELSE statement
or
it was not executed due to a RESTART decision (message CTR103I)
Because a CODES value of FLUSH does not indicate that an error occurred during job
execution, assignment of this status does not cause a job status of NOTOK.
If a JCL statement other than the COND or IF/ THEN/ ELSE statement caused the
step not to run, it is not defined as a FLUSH step.
If the failure of a step causes subsequent steps not to be executed, these subsequent
steps are not defined as FLUSH steps.
For reasons of backward compatibility, that is, to ensure that the application of
CODES value ***** remains unchanged, CODES value ***** does not include FLUSH
steps.
SNRUN
A step is defined as CODES value SNRUN if it did not run. This code includes
s any step with a CODES value of FLUSH
s any step that does not appear in the job
s instances where a step does not run because of a JCL error in a prior step (the step
with the JCL error does not have a status of SNRUN)
s Restart if a job was restarted by CONTROL-M/ Restart, and CONTROL-M is to
consider all job runs during post-processing (the ALLRUNS parameter is set to
YES in the CTRPARM member), a step is defined as SNRUN if
either the step did not previously run, or CONTROL-M/ Restart did not
recapture a completion or abend code from a previous run.
ON: PostProcessing Parameter
546 CONTROL-M for OS/390 and z/OS User Guide
and
it was not executed during the RESTART run.
SNRUN cannot be specified together with ANYSTEP. Because SNRUN includes steps
that do not exist in a job, and ANYSTEP includes all step names even if they do not
exist in a job, specifying both in the same job causes a condition that SNRUN cannot
process.
A status of SNRUN does not indicate that an error occurred during a job execution,
nor does it cause a job status of NOTOK. It merely indicates that it did not run.
For reasons of backward compatibility, that is, to ensure that the application of
CODES value ***** remains unchanged, CODES value ***** does not include SNRUN
steps.
Code Qualifiers and Relationships
Any character in a condition code, system abend code or user abend code may be
replaced by an asterisk (*). An asterisk means any value for the character it
replaces. For example, if S*13 is specified, the code criteria for the step is satisfied by
codes S013, S613, S913, and so on.
The following qualifiers can be used in certain cases:
The relationship between multiple codes in an ON statement is OR, that is, the
appearance of any of the codes in the specified step satisfies the ON criteria, except
for range specifications such as >C0010 or <C0040.
Table 189 ON Parameter Code Qualifiers
Qualifier Description
> Greater than. Valid as a qualifier for condition codes and user
abend codes.
< Less than. Valid as a qualifier for condition codes and user
abend codes.
N Specifies not to perform the accompanying DO statements if
the specified code exists in the step. Valid as a qualifier for
condition codes, user abend codes and system abend codes.
NOTE
The N qualifier indicates that the DO statements must not be performed if the
specified condition exists. It does not indicate that the DO statements must be
performed if the specified condition does not exist.
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 547
However, code criteria qualified by N take precedence over all other code criteria. If a
code that is specified with an N qualifier is generated by the specified step,
accompanying DO actions are not performed even if other ON code criteria are
satisfied.
Examples
s If >C0008 NC0020 is specified, the codes criteria is satisfied (and the DO statements
performed) by the appearance of any condition code greater than 8 except
condition code 20.
s If the following are specified:
>U0999 NU1341 S* * * NS* 37 <C0004
The DO actions are triggered by one of the following:
a condition code less than C0004
a user abend code greater than U0999 except U1341
any system abend code except Sx37 (that is, except S037, S137, and so on)
s If only code NC0008 is specified:
The accompanying DO statements are never performed. The specified value only
indicates when not to perform the DO actions. There is no indication when the DO
actions are to be performed.
ON: PostProcessing Parameter
548 CONTROL-M for OS/390 and z/OS User Guide
Example 1
Any program step resulting in condition code C0008 or C0016 is considered OK.
Figure 232 ON Parameter Example 1
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST UPDA CODES C0008 C0016 A/ O
DO OK
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<< =====






COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 16. 03
ON: PostProcessing Parameter
Chapter 3 Job Production Parameters 549
Example 2
When procedure step UPDA in program step STEP08 finishes executing with a
condition code less than C0008, it is considered OK.
Figure 233 ON Parameter Example 2
JOB: PRDKPL02 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST STEP08 PROCST UPDA CODES <C0008 A/ O
DO OK
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< ====






COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 16. 03
ON: PostProcessing Parameter
550 CONTROL-M for OS/390 and z/OS User Guide
Example 3
When any program step in the step range DF2 (STEP20 STEP29A) finishes executing
with any system or user abend code, except U2030, rerun the job, and shout the
indicated message to TSO logon ID P43.
Figure 234 ON Parameter Example 3
JOB: PRDKPL03 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST * DF2 PROCST CODES S* * * U* * * * NU2030 A/ O
DO RERUN
DO SHOUT TO TSO- P43 URGENCY R
= JOB PRDKPL03 ABENDED; THE JOB I S RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====




COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 16. 03
ON GROUP-END: PostProcessing Parameter
Chapter 3 Job Production Parameters 551
ON GROUP-END: PostProcessing Parameter
Table-processing termination status for a group. This status determines whether the
accompanying DO statements are performed. Found in Group Entities only.
Figure 235 ON GROUP-END Parameter Format

Optional. Multiple ON GROUP-END parameters can be defined. Upon specifying an
ON GROUP-END value and pressing Enter, a new ON GROUP-END statement,
followed by a blank DO statement, is opened. Valid values are:
General Information
The ON GROUP-END parameter enables specification of DO statements to be
performed when the processing of the group ends with the indicated status.
By default, if not all jobs in the group ended OK, the DO statements accompanying an
ON GROUP-END NOTOK parameter are performed. This applies if at least one job
ended NOTOK, and it can also apply if a job in the group was deleted and all
remaining jobs in the group ended OK. However, if the GRPDELJB parameter in the
CTMPARM member in the IOA PARM library is set to Y (Yes), deleted jobs are not
considered, and status END NOTOK applies only if at least one job ended NOTOK.
If the job that ended NOTOK is subsequently successfully rerun, so that the
termination status of the group changes to OK, the DO statements accompanying an
ON GROUP-END OK parameter are then performed.
Table 190 ON GROUP-END Values
Value Description
OK Process the accompanying DO statements if all scheduled jobs
in the group ended OK.
NOTOK Process the accompanying DO statements if not every job in
the group ended OK.
ON GROUP-END: PostProcessing Parameter
552 CONTROL-M for OS/390 and z/OS User Guide
The following DO statements can be specified following an ON GROUP-END
statement:
s DO COND
s DO FORCEJOB
s DO NOTOK
s DO OK
s DO SET
s DO SHOUT
s DO MAIL
DO OK or DO NOTOK statements change the final status of the group, not the status
of each job or job step in the table.
Use of the ON GROUP-END parameter in the Group Entity can frequently reduce the
number of individual DO statements that would otherwise require definition in
individual job scheduling definitions.
For example, suppose that following the processing of the table, you want to force a
particular job if any of the jobs in the table ENDED NOTOK.
s This result can be achieved by defining an ON GROUP-END NOTOK statement
(in the Group Entity) followed by the appropriate DO FORCEJOB statement.
s To achieve this result without use of the ON GROUP-END parameter, the
following steps would be necessary:
In each job scheduling definition in the table, define an appropriate condition
that would be added to the IOA Conditions file when the job ends NOTOK.
In the table, define an additional job to be performed after the other jobs in the
table have terminated. This job would have as an IN condition the condition
added by the jobs that ended NOTOK, and would force the appropriate job.
ON GROUP-END: PostProcessing Parameter
Chapter 3 Job Production Parameters 553
Example
If a job in the Group scheduling table ACCOUNTS ended NOTOK, add condition
ACCTS-CHK-REQUIRED.
Figure 236 ON GROUP-END Parameter Example
GRP ACCOUNTS_GROUP CTM. PROD. SCHEDULE( GRP)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
SCHEDULE TAG
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT
ON GROUP- END NOTOK
DO COND ACCTS- CHK- REQUI RED ODAT +
SHOUT WHEN TO URGN
MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 19. 14
OUT: PostProcessing Parameter
554 CONTROL-M for OS/390 and z/OS User Guide
OUT: PostProcessing Parameter
Add or delete prerequisite conditions when the job ends OK.
Figure 237 OUT Parameter Format

Optional. A maximum of two prerequisite conditions can be specified in an OUT line.
One prerequisite condition can be specified in each long OUT line. When you specify
the second prerequisite condition in a standard OUT line, or one prerequisite
condition in a long OUT line, and press Enter, a new OUT line is opened for
specifying additional prerequisite conditions. For more information, see Specifying
Long OUT Condition Names on page 557.
Each specified prerequisite condition consists of the following mandatory
subparameters:
NOTE
OUT and DO COND statements are similar. If you are familiar with one of them, you
can easily use the other. However, familiarize yourself with the differences outlined
below in Differences between OUT and DO COND on page 558.
Table 191 OUT Mandatory Subparameters (Part 1 of 2)
Subparameter Description
cond_name User-supplied descriptive name of 1 through 39 characters
used to identify the condition.
Note: A condition name must not begin with the symbols | ,
, or \ , and must not contain parentheses (), because each
of these characters has a special meaning.
All system AutoEdit variables specified in the cond_name
subparameter are resolved at job ordering time. User
AutoEdit variables are not resolved.
OUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 555
General Information
If the job ends OK, the prerequisite conditions are added to or deleted from the IOA
Conditions file according to the value set for opt.
Prerequisite conditions are usually used to establish job dependencies or to ensure
manual intervention when required:
dateref 4-character date reference. Valid values are:
s date Specific date (in either mmdd or ddmm format,
depending on the site standard).
s ODAT Resolves to the original scheduling date. Default.
s PREV Resolves to the previous date on which the job
ought to have been scheduled, according to its basic
scheduling criteria (or ODATE1 for a forced job).
s NEXT Resolves to the next date on which the job is
scheduled according to its basic scheduling criteria (or
ODATE+1 for a forced job).
s STAT Static. Indicates that the condition, such as
IMS-ACTIVE, is not date-dependent.
Note: Before STAT was introduced, date 0101 was
recommended to be used in conditions that were not
date-dependent. Unlike 0101, STAT is not a date, and it
operates differently. Always use STAT when defining
conditions that are not date-dependent.
s **** Any scheduling date. Valid only when opt is set to .
s $$$$ Any scheduling date. Valid only with opt is set to .
If a date reference is not specified, value ODAT is
automatically inserted when you press Enter.
opt Indicates whether to add or delete the specified prerequisite
condition. Valid values are:
s + (Plus) Add (create) the prerequisite condition
s - (Minus) Delete the prerequisite condition
Table 191 OUT Mandatory Subparameters (Part 2 of 2)
Subparameter Description
OUT: PostProcessing Parameter
556 CONTROL-M for OS/390 and z/OS User Guide
s To establish job dependency, define a prerequisite condition in an OUT or DO
COND statement in the job that must run first, and in an IN statement in the job
that must run afterwards.
The job containing a prerequisite condition in an IN statement is not submitted
unless that prerequisite condition has been added manually or by a job containing
the OUT or DO COND statement.
An OUT statement is used to add the prerequisite condition if the job ends OK.
The DO COND statement is used to add the prerequisite condition if the step
and code event criteria specified in the accompanying ON statement are
satisfied.
s If the IN condition can only be satisfied by manual intervention, for example, if
TAPE1-ARRIVED is set by the operator after an external tape has arrived on-site,
performance of the required manual intervention before job submission can be
ensured.
OUT and DO COND statements can also be used to delete prerequisite conditions.
The OUT statement of the job can be used to delete a prerequisite condition after the
job ends OK. A DO COND statement can be used to delete prerequisite conditions if
the accompanying ON step and code criteria are satisfied.
These statements are generally used to delete prerequisite conditions either to
prevent a particular job from running or when the condition is no longer needed by
any other jobs in the Active Jobs file.
DO COND functions are performed after the functions of the OUT parameter:
s If a prerequisite condition is added by the OUT parameter and deleted by the DO
COND parameter, the combined effect is the deletion of the prerequisite condition.
s If a prerequisite condition is deleted by the OUT parameter and added by the DO
COND parameter, the combined effect is the addition of that prerequisite
condition.
The following are examples of prerequisite conditions:
s I MS- ACTI VE
s JOB_PAYCALC_ENDED_OK
s TAPE1_LOADED
All prerequisite conditions are associated with a date reference that is used to
distinguish between different runs of the same job with different scheduling dates. If,
for example, a condition is being deleted, only the condition matching the specified
date is deleted. The same condition from a different date is not deleted.
OUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 557
Prerequisite conditions created by the OUT parameter can trigger the execution of
other jobs or processes.
Prerequisite conditions deleted by the OUT parameter can prevent the scheduling of
jobs and processes that require those prerequisite conditions in their IN parameter.
For more information regarding prerequisite conditions, see IN: Runtime
Scheduling Parameter on page 497, ON: PostProcessing Parameter on page 534,
and DO COND: PostProcessing Parameter on page 436, and see Prerequisite
Conditions on page 69
Specifying Long OUT Condition Names
Regular prerequisite conditions are not more than 20 characters in length. If you want
to specify a longer condition name, up to 39 characters in length, enter the string
LONG in the date reference field of an empty OUT condition line. An (L) appears at
the beginning of the line. If the field already contains data, entering the string LONG
will open a new long OUT condition line, with (L) appearing at the beginning of the
line. You can now insert a long condition name, as illustrated in Figure 238.
Specify SHRT in the date reference field to revert back to condition names of standard
length.
NOTE
Long condition names cannot be used in CMEM rule definitions.
OUT: PostProcessing Parameter
558 CONTROL-M for OS/390 and z/OS User Guide
Figure 238 Long OUT Condition
OUT Conditions for Group Entities
Prerequisite conditions that are specified for Group entities in OUT statements
and/ or in ON GROUP-END DO COND statements enable you to establish
dependencies between Group scheduling tables, and between Group scheduling
tables and other jobs.
When all jobs in a Group scheduling table are ended or deleted, prerequisite
conditions are added to or deleted from the IOA Conditions file according to the OUT
statements and/ or ON GROUP-END DO COND statements in the Group entity.
Differences between OUT and DO COND
OUT and DO COND statements are similar but have the following differences:
s An OUT statement is applied only if the job ends OK. DO COND statements are
associated with ON statements and are applied only if the associated ON step and
code criteria are satisfied.
JOB: I EFBR14 LI B CTMP. V610. SCHEDULE TABLE: PHI LL1
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
I N CTMLDNRS- NMI S- OK ODAT CTMLDNRS- NMI S- OK1 ODAT
CTMLDNRS- NMI S- OK2 ODAT
CONTROL CECI - ZEBRA- CONT E
RESOURCE I NI TOS 0002
PI PE
TI ME: FROM 0800 UNTI L PRI ORI TY * 1 DUE OUT SAC CONFI RM N
TI ME ZONE:
============================================================================
OUT CTMLDNRS- NMI S- OK ODAT - CTMLDNRS- NMI S- OK1 ODAT -
( L) THI S- LI NE- CONTAI NS- A- LONG- OUT- CONDI TI ON- XXXX ODAT -

AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES * * * * A/ O
DO COND
DO
ON PGMST ANYSTEP PROCST CODES * * * * A/ O
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 49. 13
NOTE
A Group entity can be reassigned a status of ACTIVE after specified prerequisite
conditions have already been added or deleted. For example, if a job in the Group
scheduling table was deleted while in WAIT SCHEDULE status and was then
undeleted after the prerequisite conditions were added or deleted, the Group entity
returns to ACTIVE status.
OUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 559
s An OUT statement appears in each job scheduling definition. No DO COND
statement appears unless specified. To specify a DO COND statement, type COND
in an empty DO field and press Enter.
s DO COND statements are processed after OUT statements and can therefore
override OUT statements.
Examples
Example 1
This example consists of two jobs (screens):
SACALC01 Calculates salaries
SARPT001 Generates the Salary Statistics report
The report must be generated after the salaries have been successfully calculated.
Job SACALC01 runs first.
Figure 239 OUT Parameter Example 1 First Job
When job SACALC01 ends OK, the prerequisite condition SALARY-OK is added.
This triggered the execution of job SARPT001 that requires the condition in order to
run.
Job SARPT001 is not run unless job SACALC01 ended OK.
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
CTB STEP AT NAME TYPE
DOCMEM SACALC01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01, 15 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT SALARY- OK ODAT +
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
OUT: PostProcessing Parameter
560 CONTROL-M for OS/390 and z/OS User Guide
Figure 240 OUT Parameter Example 1 Second Job
The report (job SARPT001) is produced twice a month for the 1st and for the 15th. The
report of the 15th is produced only if the prerequisite condition of the 15th,
SALARY-OK, exists. The existence of the prerequisite condition of the 1st,
SALARY-OK, does not cause submission of the report of the 15th (job SARPT001).
The jobs on the 1st, SACALC01 and SARPT001 (report), do not have to run on the 1st
of the month. Suppose the salary job (SACALC01) finishes executing (OK) on the 3rd,
the prerequisite condition SALARY-OK for the 1st is added, because the prerequisite
condition is schedule date dependent.
Example 2
Some jobs (such as IMSBDUPD) must run only when the IMS is active
(IMS-ACTIVE):
The prerequisite condition IMS-ACTIVE is generic, and it only exists when IMS is
active. IMS itself is monitored by CONTROL-M. When IMS is brought down
successfully, CONTROL-M deletes the prerequisite condition IMS-ACTIVE for all
schedule dates. This prevents the abending of jobs that depend on IMS, such as job
IMSDBUPD in the above example. Job IMSDBUPD is not submitted if the
prerequisite condition IMS-ACTIVE does not exist.
JOB: SARPT001 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SET VAR
CTB STEP AT NAME TYPE
DOCMEM SARPT001 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01, 15 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N SALARY- OK ODAT
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
MEMNAME I MSDBUPD
DAYS 1, 15
I N I MS- ACTI VE STAT
OUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 561
Figure 241 OUT Parameter Example 2
Example 3
A group of jobs runs every day of the week except Saturday and Sunday. Several of
the different jobs for the different days must not run in parallel, and job sequence
must be maintained even in case of delay.
Figure 242 OUT Parameter Example 3
JOB: I MSPROD LI B CTM. PROD. SCHEDULE TABLE: I MSPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
CTB STEP AT NAME TYPE
DOCMEM I MSPROD DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 99 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N DEPOSI TS PREV
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT I MS- ACTI VE * * * * -
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
JOB: EBDUPDT2 LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
OVERLI B
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDUPDT2 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS 2, 3, 4, 5, 6 WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 08 D- CAT
MI NI MUM PDS
===========================================================================
I N DEPOSI TS PREV
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
===========================================================================
OUT DEPOSI TS ODAT +
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
OUT: PostProcessing Parameter
562 CONTROL-M for OS/390 and z/OS User Guide
The job is submitted only if the prerequisite condition DEPOSITS of the previous
schedule date exists. If the job finishes OK, the prerequisite condition DEPOSITS of
the same schedule date is added. This, in turn, triggers the next job in the sequence.
Example 4
The following example serves as a further explanation of the schedule date reference
concept:
Today is September 15. The date reference values resolved in this job are in mmdd
date format:
s ODAT 0915
s PREV 0901
s NEXT 0920
s **** Any date reference
MEMNAME EBDUPDT2
MEMLI B EBD. PROD. JOB
DAYS 1, 15, 20
MONTHS 1- N 2- N 3- N 4- N 5- N 6- N 7- Y 8- N 9- Y 10- N 11- Y 12- N
OUT EBD- I NPUT- READY * * * * -
OVERLIB: General Job Parameter
Chapter 3 Job Production Parameters 563
OVERLIB: General Job Parameter
Name of a JCL library that can override the library specification in the MEMLIB
parameter, which is discussed on page 519.
Figure 243 OVERLIB Parameter Format

Optional. Valid values are:
s a valid data set name of 1 through 44 characters. AutoEdit variables can be
specified.
s the reserved value DUMMY (for dummy jobs).
General Information
The OVERLIB parameter enables submission of a modified copy of the actual JCL of
the job, without changes to either the regular JCL (in the MEMLIB library) or the job
scheduling definition.
The library containing the regular JCL member of the job is specified in the MEMLIB
parameter. When temporary changes are desired, the JCL member can be copied to
the library specified in the OVERLIB field and modified as needed.
If the MEMNAME member is found in the OVERLIB JCL library, that member is
used. Otherwise, the member is taken from the MEMLIB library.
NOTE
When copying the regular JCL member to the OVERLIB library, do not change the
member name. CONTROL-M always looks for a JCL member whose name matches
the MEMNAME value.
OVERLIB: General Job Parameter
564 CONTROL-M for OS/390 and z/OS User Guide
When the job is scheduled, the OVERLIB field is scanned. If it is not empty,
CONTROL-M resolves AutoEdit variables in the field, if any are specified, and then
searches the OVERLIB library for the member specified in field MEMNAME.
The override can be canceled by deleting the MEMNAME member from the
OVERLIB library. If the MEMNAME member is not found in the OVERLIB library,
the member is taken from the MEMLIB library. Alternatively, the override can be
canceled by deleting the OVERLIB specification from the job scheduling definition.
The library can be any cataloged, standard partitioned data set, LIBRARIAN or
PANVALET. The record length must be 80.
GENERAL or USER=name, which are valid MEMLIB values, cannot be specified in
field OVERLIB.
The library and the member do not have to exist when the OVERLIB parameter is
defined. Their existence is checked by CONTROL-M before actual submission of the
job.
If, during the access to a library by CONTROL-M (before submission) the library is
held exclusively by another user (such as TSO user, job), the monitor re-tries to access
the library every few seconds until the library is released and the job can be
submitted.
Use of the library name DUMMY is intended for scheduling events (for example,
adding a prerequisite condition without actually running the job). If the library name
DUMMY is used, the job is not submitted (submission and sysout checking is
skipped). The job is assumed to have ended OK; ON PGMST...DO processing is not
performed. All Post-processing parameters associated with an ENDED OK status are
activated (OUT, SHOUT WHEN OK, and so on).
Three optional functions that were performed by the CTMX015C and CTMX015O
exits in previous versions are now incorporated into the CONTROL-M monitor.
These functions are controlled by the following installation parameters:
s COPMEM2O Copy the JCL member from the MEMLIB library to the OVERLIB
library if the job ended NOTOK.
s DELOVRER Delete the JCL member from the OVERLIB library if the rerun of the
job ended OK.
s DELOVRUN Delete the JCL member from the OVERLIB library if the rerun of
any job ended OK
NOTE
OVERLIB cannot be specified for a started task.
OVERLIB: General Job Parameter
Chapter 3 Job Production Parameters 565
For a description of these parameters, see the chapter that discusses customizing
INCONTROL products in the INCONTROL for OS/390 and z/OS Installation Guide.
Editing A Member through The J (JCL) Option
When specifying option J (JCL) in the Job List screen or the Active Environment
screen to edit the JCL member, CONTROL-M must determine which library
(MEMLIB or OVERLIB) to use.
The algorithm for this decision depends on:
s where the member exists, that is, whether it is only in the MEMLIB library, only in
the OVERLIB library, in both libraries, or in neither library)
s what CTMIMACx REXX EXECs (if any) are defined
s from which screen the J (JCL) option was requested
The following table indicates which libraries are used, depending on the above
criteria:
NOTE
You can only perform this function in an ISPF environment.
Table 192 OVERLIB Parameter: Algorithm for LIbraries Used when Option J (JCL) is Specified
(Part 1 of 2)
When the following
CTMIMAC is defined
(if any)...
...the member exists in
either library MEMLIB,
OVERLIB, both, or
neither
...and the screen of the J (JCL)
request is:
Job List, Active Environment,
or either screen
... and the edit is
performed in the
following library
None (default) MEMLIB only Either screen MEMLIB
OVERLIB only Either screen OVERLIB
Both Either screen OVERLIB
Neither Either screen MEMLIB
OVERLIB: General Job Parameter
566 CONTROL-M for OS/390 and z/OS User Guide
Note the following points:
s When using CTMIMAC1 or CTMIMAC2, more than four libraries cannot be
concatenated.
s When using CTMIMAC3, Exit CTMX014G, in the IOA SAMPEXIT library, is
required if libraries are concatenated.
CTMIMAC1 MEMLIB only Job List MEMLIB
Active Environment OVERLIB (copied
from MEMLIB)
OVERLIB only Job List MEMLIB (open
empty member)
Active Environment OVERLIB
Both Job List MEMLIB
Active Environment OVERLIB (not
copied)
Neither Job List MEMLIB
Active Environment OVERLIB
CTMIMAC2 MEMLIB only Either screen MEMLIB
OVERLIB only Either screen OVERLIB
Both Either screen OVERLIB
Neither Either screen OVERLIB
CTMIMAC3 MEMLIB only Job List MEMLIB
(But saved only if
changed)
Active Environment OVERLIB
OVERLIB only Job List MEMLIB (open
empty member)
Active Environment OVERLIB
Both Job List MEMLIB
Active Environment OVERLIB
Neither Job List MEMLIB
Active Environment OVERLIB
Table 192 OVERLIB Parameter: Algorithm for LIbraries Used when Option J (JCL) is Specified
(Part 2 of 2)
When the following
CTMIMAC is defined
(if any)...
...the member exists in
either library MEMLIB,
OVERLIB, both, or
neither
...and the screen of the J (JCL)
request is:
Job List, Active Environment,
or either screen
... and the edit is
performed in the
following library
OVERLIB: General Job Parameter
Chapter 3 Job Production Parameters 567
For concatenated libraries, if the &COPYMEM parameter in Exit CTMX014G is set
to YES, the saved member is placed in the first library of concatenation. If the
&COPYMEM parameter is set to NO, the saved member is placed back in the
original JCL library.
s The CTMIMACx REXX EXECs can be found in the IOA CLIST library. Instructions
for installing these REXX EXECs can be found in comments in the members
themselves.
s PANVALET and LIBRARIAN considerations when performing online JCL edits:
For PANVALET or LIBRARIAN support, sample exits CTMX014P or
CTMX014L, respectively, must be installed. However, CONTROL-M does not
support both products simultaneously.
When both MEMLIB and OVERLIB exist, and MEMLIB is either PANVALET or
LIBRARIAN, the edit function first copies the member to the OVERLIB before
performing the edit.
IF only MEMLIB exists, and it is LIBARIAN, the edit is performed directly in
MEMLIB.
If the MEMLIB library is PANVALET, editing can only be performed if a
non-PANVALET OVERLIB is defined.
OVERLIB: General Job Parameter
568 CONTROL-M for OS/390 and z/OS User Guide
Example
If a special, modified version of BACKPL02 JCL is required, it is defined in
CTM.OVER.JOBLIB. This JCL is used instead of the JCL in CTM.PROD.JOBLIB.
Figure 244 OVERLIB Parameter Example
JOB: BACKPL02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME BACKPL02 MEMLI B CTM. PROD. JOBLI B
OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL APPL- L GROUP BKP- PROD- L
DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
OVERLI B CTM. OVER. JOBLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL WORKDAYS SHI FT RETRO N MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- BACKUP ODAT
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
OWNER: General Job Parameter
Chapter 3 Job Production Parameters 569
OWNER: General Job Parameter
User who requests CONTROL-M services.
Figure 245 OWNER Parameter Format

Mandatory. OWNER must be 1 through 8 characters.
General Information
The OWNER parameter is used by the internal security mechanism of CONTROL-M
to determine which operations each user is authorized to perform and which
information each user is authorized to access. For example, access to options and
information on the Active Environment screen can be limited by the OWNER
parameter.
The OWNER parameter can also facilitate selection and handling of production jobs.
The OWNER parameter is passed to external security products, such as RACF, ACF2
and TOP SECRET. Certain security products require that the owner name not exceed
seven characters.
Default OWNER is dependent on the online environment of the site (CICS, TSO, and
so on). For TSO and TSO/ ISPF environments, the TSO user ID is the default. For
non-TSO environments, such as CICS, the default is the terminal ID.
OWNER: General Job Parameter
570 CONTROL-M for OS/390 and z/OS User Guide
Example
Job OPERCOMP belongs to owner SYS1.
Figure 246 OWNER Parameter Example
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B GENERAL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
PDS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 571
PDS: Basic Scheduling Parameter
Partitioned data set (library) that must be checked for the minimum number of
required free tracks. That number is specified in the MINIMUM parameter, which is
described on page 527.
Figure 247 PDS Parameter Format

Optional; however, if MINIMUM is specified, PDS is mandatory. The PDS parameter
specifies a data set name of 1 through 44 characters.
The PDS parameter cannot be used with any of the following parameters: DAYS,
WDAYS, MONTHS, CONFCAL, RETRO and DATES.
General Information
The data set must be cataloged, and it must be a partitioned data set.
The MINIMUM and PDS parameters are always used together and are never used
with other Basic Scheduling parameters.
The PDS parameter identifies a library. The MINIMUM parameter specifies the
minimum number of free tracks required by that library.
These parameters are intended for use (that is, definition) in jobs or started tasks that
compress, clean and/ or enlarge libraries, or which issue a warning message to the
IOA Log file, that is, if the TASKTYPE parameter is set to WRN.
If the MINIMUM and PDS parameters are defined for a job, the scheduling of the job
is not related to or dependent upon any date criteria. Instead, the job is scheduled if
the actual number of free tracks available in the specified library is below the
specified minimum when the New Day procedure is run. The job or started task can
then compress, clean, or enlarge the library, or issue the appropriate warning.
PDS: Basic Scheduling Parameter
572 CONTROL-M for OS/390 and z/OS User Guide
Example
Check the SYS1.LINKLIB library for a minimum of 20 unused tracks.
Figure 248 PDS Parameter Example
The MSG001 member in the CONTROL-M GENERAL JCL library contains a warning
message to compress the library.
NOTE
The PDS parameter does not work with PDSE-type libraries because they always
appear to be 100 percent full.
JOB: MSG001 LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME MSG001 MEMLI B GENERAL
OWNER SYS1 TASKTYPE WRN PREVENT- NCT2 DFLT N
APPL OPER GROUP OPER- MAI NT
DESC I NDI CATE COMPRESS I S NEEDED FOR SYS1. LI NKLI B
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM MSG001 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- 2- 3- 4- 5- 6- 7- 8- 9- 10- 11- 12-
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM 020 PDS SYS1. LI NKLI B
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
PIPE: General Job Parameter
Chapter 3 Job Production Parameters 573
PIPE: General Job Parameter
Indicates a data set to be replaced by a pipe with the same name. Displayed only if
MAINVIEW Batch Optimizer (MVBO) is installed.
Figure 249 PIPE Parameter Format

Optional. Valid value is a valid data set name (1 through 44 characters).
Each time a data set or pipe name is specified and Enter is pressed, a new empty line
is displayed to allow specification of an additional data set or pipe name.
General Information
Pipes are storage buffers that are used to replace data sets. Pipes are defined in, and
used by, MVBO/ Job Optimizer Pipes to replace sequential processing with parallel
processing.
For example, normally, that is, without pipes, if JOB1 writes to data set DS1 and then
JOB2 reads data set DS1, JOB2 waits until JOB1 is terminated before reading the data
set. However, if a pipe is used to replace data set DS1, then as JOB1 writes data to
pipe DS1, JOB2 can use the data without waiting for termination of JOB1.
Each pipe and its relevant parameters are defined in a MBVO/ Job Optimizer Pipes
rule. Each pipe must be defined with the same name as the data set it is replacing.
When a job is to use a pipe instead of a data set, the name of the data set or pipe must
be specified in the PIPE parameter of the CONTROL-M job scheduling definition for
the job.
For more information about Pipe processing, see Job-Related Considerations for
Pipes on page 813
PIPE: General Job Parameter
574 CONTROL-M for OS/390 and z/OS User Guide
Example
This example consists of two job scheduling definitions.
In job CTLIVPWR and job CTLIVPRD, data set CTL.IVP.FILE is replaced by a pipe
with the same name. Jobs such as CTLIVPWR below and CTLIVPRD on page 575 are
called a Collection because they are pipe participants of the same pipe.
Figure 250 PIPE Parameter Example Job CTLIVPWR
JOB: CTLI VPWR LI B CTMT. PROD. SCHEDULE TABLE: CTLI VP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME CTLI VPWR MEMLI B CTM. I VP. JCL
OWNER E02A TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL GROUP
DESC MAI NVI EWBATCH OPTI MI ZER VERI FI CATI ON - WRI TER JOB
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM CTLI VPWR DOCLI B CTMT. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT.
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N CTLI VPWR- I N ODAT
CONTROL
RESOURCE
PI PE CTL. I VP. FI LE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
PIPE: General Job Parameter
Chapter 3 Job Production Parameters 575
Figure 251 PIPE Parameter Example Job CTLIVPRD
JOB: CTLI VPRD LI B CTMT. PROD. SCHEDULE TABLE: CTLI VP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME CTLI VPRD MEMLI B CTM. I VP. JCL
OWNER E02A TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL GROUP
DESC MVBO VERI FI CATI ON - READER JOB
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM CTLI VPRD DOCLI B CTMT. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N CTLI VPWR- OUT ODAT
CONTROL
RESOURCE
PI PE CTL. I VP. FI LE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 13. 22. 07
RestartPREVENT-NCT2:General Job Parameter
576 CONTROL-M for OS/390 and z/OS User Guide
RestartPREVENT-NCT2:General Job
Parameter
Performs data set cleanup before the original job run.
Figure 252 Restart PREVENT-NCT2 Parameter Format
Optional. PREVENT-NCT2 consists of the following subparameters:
Table 193 Restart PREVENT-NCT2 Subparameters
Subparameter Description
PREVENT-NCT2 Whether, and how, to perform data set cleanup before the
original run of the job. Optional. Valid values are:
s Y (Yes) Perform data set cleanup before the original job
run; this value is not valid for started tasks
s N (No) Do not perform data set cleanup before the
original job run
s F (Flush) Halt processing of the job if any data set
cleanup error is detected, even if MVS would not have
stopped processing the job
s L (List) Do not perform data set cleanup before the
original job run; but generate the messages that would be
required for GDG adjustment during restart
DFLT Protected field indicating the PREVENT-NCT2 default value
for the site. The default is set in parameter NCAT2 in the
CTRPARM member in the IOA PARM library. A value
specified in the PREVENT-NCT2 parameter overrides the site
default.
RestartPREVENT-NCT2:General Job Parameter
Chapter 3 Job Production Parameters 577
General Information
If a job tries to create a data set that already exists, the job may fail with a
DUPLICATE DATASET ON VOLUME error. If a job tries to create a data set whose
name is already cataloged, the job may fail with an error message that indicates a
reason of NOT CATLGD for reason code 2; the CONTROL-M/ Restart term
PREVENT-NCT2 is derived from this error situation.
These problems can be avoided by performing data set cleanup. During data set
cleanup, CONTROL-M/ Restart does the following:
s Deletes and uncatalogs the old data sets. This prevents DUPLICATE DATSET ON
VOLUME and NOT CATLGD 2 errors.
s Performs Generation Dataset (GDG) Adjustment, which is described in the
CONTROL-M/Restart User Guide
CONTROL-M/ Restart automatically performs data set cleanup prior to restarts and
reruns. However, it may be desirable to perform data set cleanup before the original
job run, because data sets accessed by the job can have file-related errors that were
generated by an entirely different job.
When data set cleanup is performed as part of the original job request, it is called
PREVENT-NCT2 processing.
The site-defined default in NCAT2 in the CTRPARM member determines whether
data set cleanup is to be performed before the original job run. The value of this
site-defined default is displayed in protected field DFLT.
The PREVENT-NCT2 parameter can be used to override this default to determine
what data set cleanup instructions are provided to the original job run. Possible
values, and their effects, are described below:
s When value Y is specified:
CONTROL-M/ Restart performs data set cleanup before the original job run. It
deletes and uncatalogs all data sets that can cause NCT2 and duplicate data set
errors during execution, and performs GDG adjustment if necessary.
s When value F is specified:
If a file catalog error is detected, processing is halted, even if normal MVS
processing would not handle the problems as a fatal error, and an appropriate
error message is generated.
RestartPREVENT-NCT2:General Job Parameter
578 CONTROL-M for OS/390 and z/OS User Guide
s When value L is specified:
Data set cleanup is not performed for the original run, but messages that would be
required for GDG adjustment during restart are generated. Without these
messages, GDG adjustment might not be properly performed during restart. In
addition to the GDG adjustment messages, the same messages that are generated
during simulation of data set cleanup are also generated.
s When value N is specified:
No special action is taken by CONTROL-M/ Restart. Data set cleanup is not
performed.
If a value of Y, F, or L is specified, that is, if some kind of special NCT2 processing is
desired, a CONTROLR step is automatically added as a first step of the submitted job.
The PREVENT NCT2 parameter has no impact on restarts, because
CONTROL-M/ Restart automatically performs data set cleanup prior to restarts.
NOTE
If you would normally specify N, meaning CONTROL-M/ Restart processing is
not desired for the original run, but the JCL requires GDG processing, it is
recommended that you specify value L instead of value N.
RestartPREVENT-NCT2:General Job Parameter
Chapter 3 Job Production Parameters 579
Example
Prevent NOT CATLGD 2 errors for job PRDKPL01.
Figure 253 Restart PREVENT-NCT2 Parameter Example
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N START- DAI LY- PROD- KPL ODAT
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
PRIORITY: Runtime Scheduling Parameter
580 CONTROL-M for OS/390 and z/OS User Guide
PRIORITY: Runtime Scheduling Parameter
Internal CONTROL-M job priority.
Figure 254 PRIORITY Parameter Format

Optional. The PRIORITY parameter indicates a 1 to 2 character alphanumeric
priority. An asterisk (discussed later) may also be specified.
The default is blank, which is the lowest priority.
General Information
Priority helps determine the order in which jobs in the Active Jobs file are processed
by CONTROL-M.
Priority is determined in ascending order where: blank < A < Z < 0 < 9 < *
In general, the job with the highest priority code executes first if all its other runtime
scheduling requirements are satisfied.
When not all runtime requirements for a high priority job are satisfied, for example,
where a job requires two tape drives but only one is available, a job with a lower
priority whose other runtime requirements are satisfied may be run earlier.
This, however, is not always desirable. A job may be so important that lower priority
jobs must not be submitted until the important job has executed.
Such a job is called a critical path job. Critical path priority can be indicated by
prefixing the priority with an asterisk (*).
PRIORITY: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 581
A priority prefixed by an asterisk, such as priority *5, indicates that CONTROL-M
must submit the job before submitting any regular (non-*) priority jobs, such as
priority 10, and before submitting any critical path jobs of lower priority, such as
priority *3, even if the resources required for those other jobs are available.
Critical path priority is applied only after all the IN conditions for the job exist.
Examples
Example 1
The priority level of job EBDIN001 is 07, and it requires three tapes. The priority level
of job EBDIN002 is 02, and it requires only one tape:
If only two tapes are available, job EBDIN002 is submitted.
Example 2
The priority level of job EBDUPDT is *5, and it requires two tapes. The priority level
of job EBDEXEC is 04, and it requires one tape:
If one tape is available, neither job is submitted. When two tapes become available,
job EBDUPDT is submitted.
NOTE
Critical path priority applies to contention for Quantitative resources and for Control
resources required in exclusive state. Critical path priority does not apply to
contention for Control resources required in shared state.
MEMNAME EBDI N001
RESOURCE TAPE 0003
PRI ORI TY 07
MEMNAME EBDI N002
RESOURCE TAPE 0001
PRI ORI TY 02
MEMNAME EBDUPDT
RESOURCE TAPE 0002
PRI ORI TY * 5
MEMNAME EBDEXEC
RESOURCE TAPE 0001
PRI ORI TY 04
PRIORITY: Runtime Scheduling Parameter
582 CONTROL-M for OS/390 and z/OS User Guide
Example 3
The priority level of job EBDBKP is *8, and it requires three tapes. The priority level of
job EBDMAINT is *7, and it requires one tape:
If one tape is available, neither job is submitted. When three tapes become available,
job EBDBKP is submitted.
MEMNAME EBDBKP
RESOURCE TAPE 0003
PRI ORI TY * 8
MEMNAME EBDMAI NT
RESOURCE TAPE 0001
PRI ORI TY * 7
RELATIONSHIP: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 583
RELATIONSHIP: Basic Scheduling Parameter
Indicates the relationship (AND/ OR) between schedule tag criteria and the basic
scheduling criteria of the job, that is, whether either set of criteria, or both sets of
criteria, are to be satisfied. This parameter appears in job scheduling definitions in
Group tables only.
Figure 255 RELATIONSHIP Parameter Format

Optional. Valid values are:
General Information
For jobs in Group scheduling tables, two types of basic scheduling criteria can be
specified:
Table 194 RELATIONSHIP Parameter Values
Value Description
O (Or) If either set of criteria (a schedule tag or the basic scheduling
criteria of the job) are satisfied, the job is scheduled. Default.
A (And) Both a schedule tag and the basic scheduling criteria of the job
must be satisfied.
Table 195 RELATIONSHIP Parameter Scheduling Types
Type Description
Schedule Tags Pointers to sets of Group criteria (that is, basic scheduling
criteria defined for the table in the Group Entity).
Basic scheduling Basic scheduling criteria defined in, and belonging to, the job
scheduling definition. They are not connected to Group
criteria.
RELATIONSHIP: Basic Scheduling Parameter
584 CONTROL-M for OS/390 and z/OS User Guide
In some cases, it may be required that both sets of criteria be satisfied. In other cases,
satisfaction of either set of criteria is sufficient for job scheduling. This parameter
allows specification of the required combination:
s When either set of criteria is sufficient, specify value O (OR relationship).
s When both sets of criteria are required, specify value A (AND relationship).
If an AND relationship is specified when no schedule tags are defined in the job, the
job is never scheduled.
For more information, see Figure 131 Figure 131Group Scheduling Flowchart on
page 386.
Example
Create a table of employee hours each payday and on the last day of the year.
Figure 256 RELATIONSHIP Parameter Example
JOB: TABHOURS LI B CTM. PROD. SCHEDULE TABLE: ACCOUNTS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME TABHOURS MEMLI B CTM. PROD. JCL
OWNER N04B TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL GROUP ACCOUNT_GROUP
DESC TABULATE EMPLOYEE HOURS
OVERLI B
SET VAR
CTB STEP AT NAME TYPE
DOCMEM TABHOURS DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG PAYDAYS
SCHEDULE TAG
RELATI ONSHI P ( AND/ OR) O
DAYS 31 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- N 2- N 3- N 4- N 5- N 6- N 7- N 8- N 9- N 10- N 11- N 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
MI NI MUM PDS
===========================================================================
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 36. 07
RERUNMEM: PostProcessing Parameter
Chapter 3 Job Production Parameters 585
RERUNMEM: PostProcessing Parameter
Name of the JCL member to use when the job is automatically rerun. (Called RERUN
RERUNMEM prior to version 6.0.00.)
Figure 257 RERUNMEM Parameter Format

Optional. The RERUNMEM parameter identifies a valid member name of 1 through 8
characters.
General Information
Although the RERUNMEM parameter can be used to specify the name of a JCL
member to use for automatic rerun, note the following points:
s The DO FORCEJOB parameter provides a more flexible alternative to the
RERUNMEM parameter.
s CONTROL-M/ Restart users can use the DO IFRERUN parameter to restart the
failed job instead of using RERUNMEM to rerun the job.
The automatic rerun process works as follows:
s The CONTROL-M monitor determines that automatic rerun is possible only if the
job ENDS NOTOK and a specified DO RERUN statement is activated during
post-processing. If the monitor determines that automatic rerun is possible, it sets
the status of the job to ENDED NOTOK RERUN NEEDED.
RERUNMEM: PostProcessing Parameter
586 CONTROL-M for OS/390 and z/OS User Guide
s The monitor then checks the value of MAXRERUN in the Active environment. If
the value is zero, or no MAXRERUN value was specified, automatic rerun is not
possible and the job is not submitted for rerun. If the value is greater than zero,
rerun is possible, and the monitor submits the job for rerun when all runtime
criteria are satisfied. Runtime criteria include not only the Runtime Scheduling
parameters, but also the INTERVAL parameter, which specifies the minimum
allowable interval between runs of the same job.
s The JCL for the rerun job is taken from the member specified in the RERUNMEM
parameter. If no RERUNMEM value is specified, the JCL for the rerun is taken
from the regular JCL member of the job specified in the MEMNAME parameter.
Rules applying to the MEMNAME parameter also apply to the RERUN parameter.
The member name can be the same as, or different from, the job name.
The member specified in RERUNMEM must be in the library specified in the
MEMLIB parameter.
The RERUNMEM parameter overrides the MEMNAME value in the JCL, and the
MEMNAME value becomes irrelevant for reruns.
The RERUNMEM parameter cannot be specified for cyclic jobs and cyclic started
tasks.
The RERUNMEM parameter cannot be specified if a DO IFRERUN statement is
specified.
RERUNMEM: PostProcessing Parameter
Chapter 3 Job Production Parameters 587
Example
If job EF145TS abends during step name COLLECT, try to run another job from the
member EF145TSR that continues from the same place.
Figure 258 RERUNMEM Parameter Example
JOB: EF145TS LI B CTM. PROD. SCHEDULE TABLE: EFPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN 2 RERUNMEM EF145TSR I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST COLLECT PROCST CODES S* * * U* * * * A/ O
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====





COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
RESOURCE: Runtime Scheduling Parameter
588 CONTROL-M for OS/390 and z/OS User Guide
RESOURCE: Runtime Scheduling Parameter
Quantitative resources and their quantities required by the job.
Figure 259 RESOURCE Parameter Format

Optional. A maximum of two Quantitative resources can be specified in each
RESOURCE line. Upon specifying the second Quantitative resource in a line and
pressing Enter, a new line is opened, for specifying additional Quantitative resources.
Each specified Quantitative resource consists of the following mandatory
subparameters:
General Information
Quantitative resource specification can be used to prevent resource contention.
Quantitative resources, such as tape drives, CPU, and access rates to the spool, and
their maximum available quantities are defined for the site in the IOA
Conditions/ Resources screen (Screen 4).
Table 196 RESOURCE Subparameters
Subparameter Description
res_name User-supplied, descriptive name of 1 through 20 characters to
identify the quantitative resource.
quantity Quantity of the resource required by the job. The specified
value must be four digits (leading zeros must be specified).
RESOURCE: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 589
Examples
To eliminate bottlenecks and maximize throughput, a site can quantify processing
power and assign it a resource name, such as CPU or LPU (logical processing units).
The more powerful the CPU, the greater the maximum quantity that can be assigned
to it.
The RESOURCE parameter is used to specify the quantity of a resource required by
the job.
Before a job is submitted, CONTROL-M verifies that the required quantities of
resources, defined through RESOURCE statements, are available, that is, that they are
not in use by another job:
s If they are available, CONTROL-M allocates them to the job, and they become
unavailable to other jobs until they are freed.
s If the resources required by the job are unavailable, the job is not submitted.
Resource Allocation in Multi-CPU Environments
In multi-CPU environments, several resource allocation possibilities exist.
One possibility is to operate as if there is one large CPU and resource pool. In this
case, no logical differentiation between CPUs is made, and the CONTROL-M monitor
assigns resources, including CPU processing power, from the total resources
available.
Another possibility is to differentiate between CPUs and optionally to logically
associate quantities of resources with specific CPUs.
NOTE
If the AUTOTAPE parameter in the CTMPARM member in the IOA PARM library is
set to Y, any tape drive value defined in the RESOURCE parameter is ignored.
Instead, a value determined by the Automatic Tape Adjustment facility is used. For
more information, see Tape Device Usage Statistics on page 235, and the
description of using the Automatic Tape Adjustment facility in the INCONTROL for
OS/390 and z/OS Administrator Guide.
To remove selected Quantitative resources from job scheduling definitions, use the
CTMTBUPD utility described in the INCONTROL for OS/390 and z/OS Utilities Guide.
TAPE 12
CPU 80
WORK- SPACE 3000
RESOURCE: Runtime Scheduling Parameter
590 CONTROL-M for OS/390 and z/OS User Guide
This is generally achieved through the use of common identifiers, such as a suffix.
For example, suppose a site has three CPUs of differing processing capability. The
following representative resources and quantities might be defined in the IOA
Resources file:
In this example, it might also be desired to logically categorize other resources
according to CPU. For example, if 12 tape drives are available, the following
resources and quantities might also be defined in the IOA Resources file:
If this kind of differentiation is used, different resources in the job scheduling
definition can be specified with different suffixes, and the job still runs. For example,
a quantity of CPU-A can be specified along with a quantity of TAPE-B.
Rather than specifying a particular identifier when requesting a resource, resources
can be requested generically by specifying a $ in place of the identifier, for example
CPU-$ or TAPE-$. The $ indicates to CONTROL-M that it must select a specific
resource, that is, a resource with an identifier, to replace the generic resource, that is,
the resource with the $.
If a $ is specified for all required resource identifiers, the CONTROL-M monitor does
not assign the resources unless it can assign all resources with the same identifier, for
example, all resources with identifier A or all resources with identifier B.
When using the generic $ identifier, you can use one of the following methods to
ensure a specific CPU is used for processing the job:
s Use JCL AutoEdit system variable %%$SIGN to extract the CPU identifier assigned
by the CONTROL-M monitor and then to assign the job to that same CPU. System
variable %%$SIGN is discussed in Chapter 5, JCL and AutoEdit Facility.
s Use CONTROL-M submit Exit CTMX002.
CPU- A 50
CPU- B 75
CPU- C 100
TAPE- A 3
TAPE- B 4
TAPE- C 5
NOTE
If you use the $ to request generic resources, the $ must appear at the end of the
resource name.
RESOURCE: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 591
CONTROL-M Exit CTMX004 can also be used to help prevent bottlenecks caused by
resource contention.
For more information on CONTROL-M exits CTMX002 and CTMX004, see the
INCONTROL for OS/390 and z/OS Administrator Guide.
Example 1A
There are 12 tape drives in the data center connected to a single computer. Two tape
drives must always remain free for emergencies. Therefore, only 10 drives can be
used for production. The defined available quantity is set as follows: TAPE 0010.
Any user (job) wanting to use tape drives must specify the number of tapes required
in the job parameters.
Figure 260 RESOURCE Parameter Example 1A
CONTROL-M checks if there are two tape drives available. If there are, the tape
drives are given to the job. The total number of free tapes is now eight. When the
job finishes executing, the tape drives are returned to the general pool.
Suppose that many jobs are using tapes, and the available quantity is only one. A job
that requires two tape drives must wait. The job is not submitted until the required
number of tapes are available.
An authorized person decides that only one tape unit is needed for emergencies and
adds one tape unit to the global quantity available for use. Now the maximum
number of tape drives is eleven, and the number of available tape drives is two. The
job is submitted.
JOB: EBDI NPUT LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDI NPUT DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE TAPE 0002
PI PE CTM. PROD. PI PE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
RESOURCE: Runtime Scheduling Parameter
592 CONTROL-M for OS/390 and z/OS User Guide
Example 1B
The data center discussed in the previous example is expanding. It now has two
computers and 20 tape drives. The tape drive distribution is:
s CPU1 only 8
s CPU2 only 8
s Transferables 6
Currently, CPU1 is connected to four transferable drives, one transferable drive is
connected to CPU2, and one transferable drive is out of order. The situation is
presented to CONTROL-M as follows:
A job requests three tape drives, on any computer.
Figure 261 RESOURCE Parameter Example 1B
The result is that the available quantity of either TAPE1 or TAPE2 is reduced by three.
The CONTROL-M scheduling algorithm makes the optimal decision as to which of
the two computers to send the job. It is possible to intervene in this selection process.
For more information, see user Exit CTMX004 in the INCONTROL for OS/390 and
z/OS Administrator Guide.
TAPE1 12
TAPE2 7
JOB: EBDI NPUT LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDI NPUT DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE TAPE$ 0003
PI PE CTM. PROD. PI PE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
RESOURCE: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 593
Example 1C
A job requests three tape drives on CPU1.
Figure 262 RESOURCE Parameter Example 1C
The result is that the available quantity of the resource TAPE1 is reduced by three.
The tape drive that was out of order has been fixed. An operator makes it available
for use by jobs running on CPU2 by correcting the global available quantities to:
The shift manager decides to assign two tapes from CPU1 to CPU2. The new situation
as seen by CONTROL-M:
JOB: EBDI NPUT LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDI NPUT DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE TAPE1 0003
PI PE CTM. PROD. PI PE
TI ME: FROM UNTI L PRI ORI TY 00 DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
TAPE2 8
TAPE1 10
TAPE2 10
Restart RETENTION: # OF DAYS TO KEEP: PostProcessing Parameter
594 CONTROL-M for OS/390 and z/OS User Guide
Restart RETENTION: # OF DAYS TO KEEP:
PostProcessing Parameter
Number of days to retain the job in the History Jobs file.
Figure 263 Restart RETENTION: # OF DAYS TO KEEP Parameter Format
Optional. Valid values are:
The default is 0.
General Information
Jobs in the History Jobs file are easier to restore to the Active Jobs file, for example, for
restart, than jobs archived to CDAM. Therefore, it may be desirable to retain a job in
the History Jobs file for a period of time.
NOTE
At sites that do not use the History Jobs file, this parameter is not relevant and is not
displayed.
Table 197 RETENTION: # OF DAYS TO KEEP Parameter Values
Value Description
0 through 999 Retain the job for the specified number of days.
(Blank) Retain the job according to the RETENTION: # OF
GENERATIONS TO KEEP parameter.
Restart RETENTION: # OF DAYS TO KEEP: PostProcessing Parameter
Chapter 3 Job Production Parameters 595
# OF DAYS TO KEEP enables specification of a fixed number of days to keep the job
in the History Jobs file. Once the specified number of days has been reached, the job is
automatically deleted from the History Jobs file during the next New Day processing.
# OF DAYS TO KEEP and # OF GENERATIONS TO KEEP are mutually exclusive. A
value can be specified for either, but not both.
Example
Retain the archived job in the History Jobs file for 30 days.
Figure 264 Restart RETENTION: # OF DAYS TO KEEP Parameter Example
NOTE
When changing job criteria from retention-days to retention-generation (or
vice-versa), previous job criteria are lost and are not acted upon.
For retention criteria to hold across job executions, the jobs must be identical in all
respects. For example, if a job is transferred to a different group, it is treated as a
different job for purposes of retention. In this case, retention values are reset, and
retention is calculated from the moment of transfer.
JOB: PRDKPL02 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
CODES
DO I FRERUN FROM $ABEND . TO . CONFI RM Y
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 07. 06. 04
RestartRETENTION: # OF GENERATIONS TO KEEP: PostProcessing Parameter
596 CONTROL-M for OS/390 and z/OS User Guide
RestartRETENTION: # OF GENERATIONS TO
KEEP: PostProcessing Parameter
Maximum number of generations of the job to keep in the History Jobs file.
Figure 265 Restart RETENTION: # OF GENERATIONS TO KEEP Parameter Format
Optional. Valid values are:
The default is 0.
General Information
Jobs in the History Jobs file are easier to restore to the Active Jobs file, for example, for
restart, than jobs archived to CDAM. Therefore, it may be desirable to retain several
of the most current generations of the job in the History Jobs file.
NOTE
At sites that do not use the History Jobs file, this parameter is not relevant and is not
displayed.
Table 198 Restart RETENTION: # OF GENERATIONS TO KEEP Values
Value Description
0 through 99 Retain the specified number of generations of the job.
(Blank) Retain the job according to the RETENTION: # OF DAYS TO
KEEP parameter.
RestartRETENTION: # OF GENERATIONS TO KEEP: PostProcessing Parameter
Chapter 3 Job Production Parameters 597
# OF GENERATIONS TO KEEP enables specification of the number of generations of
the job to keep in the History Jobs file. Once the specified number of generations has
been reached, as a new generation is added to the History Jobs file, the earliest
remaining generation is deleted.
# OF DAYS TO KEEP and # OF GENERATIONS TO KEEP are mutually exclusive. A
value can be specified for either, but not both.
Example
Retain up to 10 generations of the archived job in the History Jobs file.
Figure 266 Restart RETENTION: # OF GENERATIONS TO KEEP Parameter Example
NOTE
When changing job criteria from retention-days to retention-generation, or vice versa,
previous job criteria are lost and are not acted upon.
For retention criteria to hold across job executions, the jobs must be identical in all
respects. For example, if a job is transferred to a different group, it is treated as a
different job for purposes of retention. In this case, retention values are reset, and
retention is calculated from the moment of transfer.
JOB: PRDKPL02 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP # OF GENERATI ONS TO KEEP 10
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
CODES
DO I FRERUN FROM $ABEND . TO . CONFI RM Y
DO RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 07. 6. 04
RETRO: Basic Scheduling Parameter
598 CONTROL-M for OS/390 and z/OS User Guide
RETRO: Basic Scheduling Parameter
Enables the job to be scheduled after its original scheduling date has passed.
Figure 267 RETRO Parameter Format

Optional. Valid values are:
General Information
The RETRO parameter is used to control situations where the computer has not been
working for a day or more due to holiday, hardware failure, and so on.
When such situations occur, it is necessary to instruct CONTROL-M whether the job
is to be retroactively scheduled for the days when the computer (or CONTROL-M)
was inactive.
s When Y is specified for the RETRO parameter, job orders are placed in the Active
Jobs file for all the days the job ought to have been originally scheduled.
Scheduling occurs from the last scheduling date to the current working date,
provided that those days were included in one of the Basic Scheduling parameters
(DAYS, DCAL, and so on). Each job order placed on the Active Jobs file is
associated with a different original scheduling date. For additional information see
MAXWAIT: Basic Scheduling Parameter on page 515.
Table 199 RETRO Values
Value Description
Y (Yes) Allow scheduling of the job after its original scheduling date
has passed
N (No) Do not allow scheduling of the job after its original scheduling
date has passed. Default.
RETRO: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 599
s When N is specified for the RETRO parameter, the job is scheduled only if the
current working date is a date on which the job is normally scheduled.
The RETRO parameter cannot be used with the MINIMUM and PDS parameters, nor
in group scheduled jobs; if specified in Group scheduled jobs, the parameter is
ignored.
Examples
Example 1
Schedule the job only on specified days of the month. If the date has passed, do not
schedule the job.
Figure 268 RETRO Parameter Example 1
Assume the computer was offline from the 16th up to and including the 18th, and the
15th was the last date that the job was scheduled for execution. Today is the 19th.
Therefore, the job is only scheduled for execution on the 19th.
Example 2
Schedule the job for all working days, even if the computer is not active:
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 15, 16, 18, 19, 20 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
DCAL WORKDAYS
RETRO Y
RETRO: Basic Scheduling Parameter
600 CONTROL-M for OS/390 and z/OS User Guide
Assume the WORKDAYS calendar contains the dates 15, 16, 18, and 19, and the same
conditions as above exist. The job is scheduled three times with the original
scheduling dates: the 16th, the 18th and the 19th.
SAC: Run Time Parameter
Chapter 3 Job Production Parameters 601
SAC: Run Time Parameter
This parameter is only used during conversions from other job scheduling products,
such as CA-7. It enables all scheduled runs of the job to be shifted to their proper
scheduling days.
A related parameter is discussed in DESC: General Job Parameter on page 432.
Figure 269 SAC Parameter Format

Optional. Valid values are:
General Information
Many scheduler products do not allow the site to define the time of the new working
day. Instead, those products fix the time, such as midnight. CONTROL-M, however,
allows the site to define when the new working day starts.
NOTE
Do not use the SAC parameter unless specifically required in conjunction with the
conversion. Check the Conversion Guide for your specific application.
Table 200 SAC Parameter Values
Value Description
P (Previous) Changes the scheduling of the job to the previous day.
N (Next) Changes the scheduling of the job to the next day.
(Group Previous) For jobs in Group tables only. Changes the scheduling of the
job to the previous day.
+ (Group Next) For jobs in a Group table only. Changes the scheduling of the
job to the next day.
(Blank) No changes need be made. Default.
SAC: Run Time Parameter
602 CONTROL-M for OS/390 and z/OS User Guide
In most cases, this added CONTROL-M flexibility can be utilized without additional
adjustment. Occasionally, however, an adjustment to the job schedule may be
required due to the differences between the start of the working day. The SAC
parameter is used to perform such an adjustment.
For information on the correct usage of the SAC parameter, see the Conversion Guide
provided for your specific product.
Example
Due to differences in the time of the start of the new working day, shift the
scheduling of the following converted job back to the previous day.
Figure 270 SAC Parameter Example
NOTE
Unless you are certain that SAC must be used, and you are certain how to use it, leave
this parameter blank.
JOB: CAPRKL1 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
DOCMEM I EFBR14 DOCLI B CTMP. DOC
===========================================================================
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 04 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL MK- 1 E
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC P CONFI RM
TI ME ZONE:
===========================================================================
OUT COND1 ODAT + COND2 ODAT -
COND3 ODAT + COND4 ODAT -
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 24. 05
SCHEDULE TAG: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 603
SCHEDULE TAG: Basic Scheduling Parameter
Identifies a set of scheduling criteria for Group scheduling. This parameter appears
only in Group scheduling tables.
Mandatory for Group Entities. Any alphanumeric value of 1 to 20 characters.
Optional for job scheduling definitions. Must be either a schedule tag value defined
in the Group Entity, or the value *.
A related parameter is RELATIONSHIP, which is described on page 583.
Figure 271 SCHEDULE TAG Parameter Format

Upon specifying a schedule tag value and pressing Enter, a new SCHEDULE TAG
field is opened, for specifying additional schedule tags. In Group Entities, a new set of
basic scheduling parameters is opened with the new SCHEDULE TAG field to allow
specification of criteria to be associated with the new tag.
General Information
A Group Entity contains sets of basic scheduling criteria to be applied to job
scheduling definitions in the Group scheduling table. Each set of basic scheduling
criteria in the Group Entity is assigned a unique label, specified in the SCHEDULE
TAG field, which is used for referencing that set of criteria.
At least one schedule tag, with basic scheduling criteria, must be defined in the
Group Entity.
To apply any sets of Group Entity basic scheduling criteria to a job scheduling
definition, specify the schedule tag names of the desired criteria in the SCHEDULE
TAG fields in the job scheduling definition.
SCHEDULE TAG: Basic Scheduling Parameter
604 CONTROL-M for OS/390 and z/OS User Guide
If multiple SCHEDULE TAG values are specified in the job scheduling definition,
tags are checked sequentially during job scheduling to determine if the criteria are
satisfied. Once a set of schedule tag criteria are satisfied, no other schedule tags in the
job are checked.
An asterisk (*) can be specified as a SCHEDULE TAG value in the job scheduling
definition. When checks are performed for a schedule tag with a value of *, the first
set of basic scheduling criteria in the Group Entity that is satisfied on the particular
day is applied to the job.
Each job scheduling definition can have its own basic scheduling criteria defined,
independent of the schedule tag criteria in the Group Entity.
Jobs in a Group scheduling table are eligible for scheduling on a particular day only if
at least one set of basic scheduling criteria in the Group Entity are satisfied.
If a group is eligible for scheduling on a particular day, a job in the group is
scheduled in any of the following cases:
s The value in the RELATIONSHIP parameter is O (OR), and either the basic
scheduling criteria of the job or a set of its schedule tag criteria (or both) are
satisfied.
s The value in the RELATIONSHIP parameter is A (AND), and its basic scheduling
criteria and a set of its schedule tag criteria are both satisfied.
SCHEDULE TAG: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 605
Examples
Example 1
For a Group Entity:
The Group Entity for group ACCOUNTS_GROUP in Group scheduling table
ACCOUNTS contains two sets of basic scheduling parameters. One set is identified
by schedule tag ALL_DAYS, and the other set is identified by schedule tag
SUNDAYS.
Figure 272 SCHEDULE TAG Parameter Example 1
GRP ACCOUNTS_GROUP CTM. PROD. SCHEDULE( GRP)
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
GROUP ACCOUNTS_GROUP MEMNAME ACCOUNTS
OWNER N04B
APPL
DESC
ADJUST CONDI TI ONS N GRP MAXWAI T
SET VAR
DOCMEM ACCOUNTS DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG ALL_DAYS
DAYS ALL DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
SCHEDULE TAG SUNDAYS
DAYS DCAL
AND/ OR
WDAYS 01 WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
SCHEDULE TAG ACTI VE FROM UNTI L
===========================================================================
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 19. 14
SCHEDULE TAG: Basic Scheduling Parameter
606 CONTROL-M for OS/390 and z/OS User Guide
Example 2
For a job scheduling definition:
Schedule job TABHOURS when the basic scheduling criteria identified by schedule
tag ALL_DAYS in the Group Entity (in Example 1A) are satisfied.
Figure 273 SCHEDULE TAG Parameter Example 2
JOB: TABHOURS LI B CTM. PROD. SCHEDULE TABLE: ACCOUNTS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME TABHOURS MEMLI B CTM. PROD. JCL
OWNER N04B TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL GROUP ACCOUNT_GROUP
DESC TABULATE EMPLOYEE HOURS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM TABHOURS DOCLI B CTM. PROD. DOC
===========================================================================
SCHEDULE TAG ALL_DAYS
SCHEDULE TAG
RELATONSHI P ( AND/ OR) O
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO N MAXWAI T 00 D- CAT
===========================================================================
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 36. 07
SCHEDULE TAG ACTIVE: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 607
SCHEDULE TAG ACTIVE: Basic Scheduling
Parameter
Specifies the time limits (FROM, UNTIL) for using the schedule tag.
Figure 274 SCHEDULE TAG ACTIVE Parameter Format
Optional. The parameter includes the following subparameters:
The format of either the FROM or UNTIL subparameters may be ddmmyy, mmddyy,
or yymmdd, depending on your local site standard, as set by the DATETYP
parameter in the IOAPARM member in the IOA PARM library.
General Information
The FROM and UNTIL dates together define a time frame for ordering jobs that have
a specific schedule tag within the Group that defines that schedule tag. However,
though the SCHEDULE TAG ACTIVE FROM and UNTIL parameters may prevent
individual jobs from being ordered, these parameters are ignored for the purpose of
ordering the Group Entity.
Table 201 SCHEDULE TAG ACTIVE Subparameters
Subparameter Description
FROM 6-digit date. A job that refers to this schedule tag will only be
ordered if the ordering date is later than the date specified.
Default: (Blank)
UNTIL 6-digit date. A job that refers to this schedule tag will only be
ordered if the ordering date is earlier than the date specified.
Default: (Blank)
SCHEDULE TAG ACTIVE: Basic Scheduling Parameter
608 CONTROL-M for OS/390 and z/OS User Guide
The following cases apply:
s If you specify both the FROM and UNTIL subparameters for a particular schedule
tag, jobs within the group that refer to that schedule tag can only be ordered on or
later than the date specified in the FROM subparameter, and on or earlier than the
date specified in the UNTIL subparameter. There are two possibilities:
1. The date specified in the FROM subparameter is earlier than that specified in the
UNTIL subparameter.
For example,
SCHEDULE TAG ACTI VE FROM 091001 UNTI L 011101
Jobs within the group that refer to this schedule tag can only be ordered on or
between October 9, 2001 and November 1, 2001.
2. The date specified in the FROM subparameter is later than that specified in the
UNTIL subparameter.
For example,
SCHEDULE TAG ACTI VE FROM 090501 UNTI L 010401
Jobs within the group that refer to this schedule tag can only be ordered on or
after May 9, 2001, or before or on April 1, 2001, but not between those dates.
s If you specify the FROM subparameter for a particular schedule tag, but not the
UNTIL subparameter, jobs within the group that refer to that schedule tag cannot
be ordered before the date specified, but can be ordered on that date or any date
later than that date.
For example,
SCHEDULE TAG ACTI VE FROM 091001 UNTI L
Jobs within the group that refer to this schedule tag can only be ordered on or after
October 9, 2001.
s If you do not specify the FROM subparameter for a particular schedule tag, but
specify the UNTIL subparameter, jobs within the group that refer to the same
schedule tag cannot be ordered after the date specified, but can be ordered on that
date or any date earlier than that date.
For example,
SCHEDULE TAG ACTI VE FROM UNTI L 011101
SCHEDULE TAG ACTIVE: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 609
Jobs within the group that refer to this schedule tag can only be ordered before or
on November 1, 2001.
s If you do not specify either the FROM or UNTIL subparameters, there is no
restriction on the date when jobs within the group can be ordered.
For example,
SCHEDULE TAG ACTI VE FROM UNTI L
Jobs within the group that refer to this schedule tag can be ordered on any date.
s If a job specifies more than one schedule tag and one of the Schedule Tag
definitions is such that the job can be ordered on a particular day, the job will be
ordered even if it would not be ordered under the terms of another of its schedule
tag definitions.
For example, if within a Group Entity one schedule tag is specified as
SCHEDULE TAG ACTI VE FROM 091001 UNTI L 011101
and another schedule tag is specified as
SCHEDULE TAG ACTI VE FROM UNTI L
jobs within the Group that have both these schedule tags can be ordered on any
date.
SCHENV: General Job Parameter
610 CONTROL-M for OS/390 and z/OS User Guide
SCHENV: General Job Parameter
Name of the workload management scheduling environment that is to be associated
with the job.
Figure 275 SCHENV Parameter Format
SCHENV specifies a scheduling environment of 1 through 16 characters. Only
trailing blanks are allowed.
By default, the SCHENV parameter is optional.
General Information
If a value is specified for the SCHENV parameter, the JCL job statement is modified
by the addition of a statement in the following form:
If a value is specified for the SCHENV parameter, it will not override any scheduling
environment specified in the job statement unless the OVERJCLM parameter in the
CTMPARM library is set to Y.
Example
If the scheduling environment of job ACCT01 is to be SCHD2, specify the following:
/ / SCHENV=schedul e_envi r onment
DESC
OVERLI B
SCHENV SCHD2 SYSTEM I D NJE NODE
SCHENV: General Job Parameter
Chapter 3 Job Production Parameters 611
The job statement is modified as follows:
/ / ACCT01 JOB , PROD1, CLASS=A, MSGCLASS=X,
/ / MSGLEVEL=( 1, 1) ,
/ / SCHENV=SCHD2
SET VAR: General Job Parameter
612 CONTROL-M for OS/390 and z/OS User Guide
SET VAR: General Job Parameter
Assigns a value to an AutoEdit variable that can be used to set up the JCL of the job or
to define a Global variable in the IOA Global Variable Database.
Figure 276 SET VAR Parameter Format

Optional. Valid values must be specified in the format:
%%var i abl e=expr essi on
where:
s %%variable is a user-defined AutoEdit variable
s expression is any of the following components, provided it resolves to a single
value:
a value (for example, 5)
an AutoEdit system variable or previously defined user-defined variable, for
example, %%ODATE
NOTE
SET VAR and DO SET statements are similar, but not identical. The differences are
outlined below in Differences between SET VAR and DO SET on page 614.
NOTE
To specify embedded blanks in a SET VAR expression, use AutoEdit variable
%%BLANKn, where n is the number of blanks. Up to 80 blanks can be specified.
For example,
%%A=TODAY%%BLANK1%%. I S%%BLANK1%%. SUNDAY
resolves to TODAY IS SUNDAY, whereas entering the same expression without
the %%BLANKn variables would resolve to TODAYISSUNDAY.
For further information see Non-Date System Variables on page 737.
SET VAR: General Job Parameter
Chapter 3 Job Production Parameters 613
General Information
A major advantage of using AutoEdit variables is that the JCL can be submitted with
different values for different executions without actually changing the JCL.
There are two types of AutoEdit variables:
s system variables that are assigned values by the system
s user-defined variables for which the user must supply values
These variables can be either local or global.
One method of supplying a value for a user-defined variable is by defining the
variable and its value in a SET VAR statement. The value is assigned at time of job
submission.
At the time of job submission, AutoEdit variables in the JCL are resolved in sequence.
By default, if an AutoEdit variable cannot be resolved, the job is not submitted. This
default can be changed using an appropriate %%RESOLVE AutoEdit control
statement.
SET VAR statements can also be used to define and update Global Variables in the
IOA Global Variable Database. For more information on Global Variables, including
Global Variable syntax, see Global Variables on page 5-748
As of version 6.0.00, SET VAR variables defined in a Group entity are available to all
the jobs in the group. However, they do not override SET VAR variables defined in
the job scheduling definition.
An unlimited number of SET VAR statements can be specified.
Upon filling in a SET VAR statement and pressing Enter, a new blank SET VAR
statement is displayed.
JCL Setup and the AutoEdit facility are described in depth in Chapter 5, JCL and
AutoEdit Facility.
AutoEdit Functions in SET VAR
The value of a SET VAR AutoEdit variable can be any of the following:
s an AutoEdit system variable
s a user-defined variable that has been defined previously
s an AutoEdit arithmetic function
s a date calculation function
SET VAR cannot be set to a value that contains any blanks.
SET VAR: General Job Parameter
614 CONTROL-M for OS/390 and z/OS User Guide
Differences between SET VAR and DO SET
SET VAR and DO SET statements are similar but have the following differences:
s Local variables in SET VAR statements are always applied before the job is
submitted. DO SET is a post-processing statement that can only be applied after its
accompanying ON step and code criteria are satisfied. This means that a local
value specified in the DO SET statement can only be applied in the next
submission of the job (that is, for cyclic and rerun or restarted jobs).
s Global variables specified in a SET VAR statement are defined or updated in the
IOA Global Variable database before job submission. Global variables specified in
a DO SET statement are defined or updated in the IOA Global Variable database as
part of job post-processing.
s A SET VAR statement appears in each job scheduling definition. A DO SET
statement does not appear unless specified. To specify a DO SET statement, type
SET in an empty DO field and press Enter.
s In a SET VAR statement, the parameter value is specified after the keyword VAR.
In a DO SET statement, the parameter value is specified after the keyword VAR.
Examples
Example 1
In this example, AutoEdit statements in the job scheduling definition and the JCL
allocate space for the job. If the job abends due to insufficient space, the AutoEdit
statements adjust the allocated space and rerun or restart the job.
The following step in the JCL of the job sets the quantity of available space to five
units of whatever type (track or cylinder) is specified in the job scheduling definition.
The job scheduling definition contains the following SET VAR statement that sets the
space type to track:
In this case, the second line in the above DD statement resolves to:
/ / STEP10 EXEC PGM=MYPGM
/ / OUTFI LE DD DSN=NEWFI LE, DI SP=( NEW, CATLG, DELETE) ,
/ / SPACE=( %%SPACE_TYPE, 5) , UNI T=SYSDA
SET VAR %%SPACE_TYPE=TRK
/ / SPACE=( TRK, 5) , UNI T=SYSDA
SET VAR: General Job Parameter
Chapter 3 Job Production Parameters 615
The job scheduling definition also contains the following statements that are
activated if the job abends due of lack of space (code S*37). These statements change
the space type to cylinder, which provides enough space, and rerun the job. If
CONTROL-M/ Restart is active, the job is restarted from the abended step.
If the job abends due to insufficient space, the second line of the earlier JCL
DD statement resolves to:
when the job is submitted for rerun (or restart).
Examples 2A and 2B
The following examples show how one job scheduling definition and one JCL
member can be used for both the test environment and the production environment
by changing the value of only one parameter, the SET VAR parameter.
Assume the following JCL for the job:
ON PGMST STEP10 CODES S* 37
DO SET %%SPACE_TYPE = CYL
[ DO I FRERUN FROM $ABEND] ===> I f CONTROL- R i s act i ve
DO RERUN
/ / SPACE=( CYL, 5) , UNI T=SYSDA
/ / PRDKPL01 JOB 0, M22, CLASS=A, MSGCLASS=X, REGI ON=4000K
/ / STEP01 EXEC %%PROC%%. I NPT
/ / STEP02 EXEC %%PROC%%. UPDT
/ / STEP03 EXEC %%PROC%%. RPTS
SET VAR: General Job Parameter
616 CONTROL-M for OS/390 and z/OS User Guide
Example 2A
The following job scheduling definition replaces the %%PROC variable in the EXEC
statements of the JCL with procedure name prefix TEST.
Figure 277 SET VAR Parameter Example 2A
When a SET VAR statement is used to specify %%PROC=TEST, the JCL is resolved as
follows:
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR %%PROC=TEST
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 36. 07
/ / PRDKPL01 JOB 0, M22, CLASS=A, MSGCLASS=X, REGI ON=4000K
/ / STEP01 EXEC TESTI NPT
/ / STEP02 EXEC TESTUPDT
/ / STEP03 EXEC TESTRPTS
SET VAR: General Job Parameter
Chapter 3 Job Production Parameters 617
Example 2B
The job scheduling definition has now been modified to replace the procedures
(%%PROC) used in the job with production (PROD) procedures.
Figure 278 SET VAR Parameter Example 2B
When a SET VAR statement is used to specify %%PROC=PROD, the JCL is resolved
as following:
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME PRDKPL01 MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL KPL GROUP PROD- KPL
DESC DAI LY PRODUCTI ON - START OF APPL- PROD- KPL
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR %%PROC=PROD
SET VAR
CTB STEP AT NAME TYPE
DOCMEM PRDKPL01 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 18. 36. 07
/ / PRDKPL01 JOB 0, M22, CLASS=A, MSGCLASS=X, REGI ON=4000K
/ / STEP01 EXEC PRODI NPT
/ / STEP02 EXEC PRODUPDT
/ / STEP03 EXEC PRODRPTS
SHOUT: PostProcessing Parameter
618 CONTROL-M for OS/390 and z/OS User Guide
SHOUT: PostProcessing Parameter
Sends (shouts) a message to a destination when a specific situation occurs.
Figure 279 SHOUT Parameter Format

Optional. Upon filling in the SHOUT statement and pressing Enter, a new SHOUT
statement is opened.
Each SHOUT statement consists of four subparameters: WHEN (situation), TO
(destination), URGN (urgency), and MS (message text).
NOTE
DO SHOUT and SHOUT statements are similar, but not identical. The differences are
outlined below in Differences between SHOUT and DO SHOUT on page 625.
SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 619
Table 202 SHOUT Subparameters (Part 1 of 4)
Subparameter Description
WHEN Situation in which to send the message. Valid values are:
s OK The message is sent if the job ends OK.
s NOTOK The message is sent if the job ends NOTOK.
s RERUN The message is sent if the job is rerun and DO
RERUN is specified in ON PGMST.
s LATESUB time The message is sent if the job is not
submitted by the specified time, where time is in the format
hhmm or an *. If * is specified, the CONTROL-M monitor
uses the calculated DUE IN time of the job, as displayed in
the Zoom screen, to determine if the job was not submitted
on time. For more information, see Automatic Job Flow
Adjustment on page 74
s LATE time The message is sent if the job does not finish
executing by the specified time, where time is either in the
format hhmm or an *. If * is specified, the CONTROL-M
monitor uses the calculated DUE OUT time of the job, as
displayed in the Zoom screen, to determine if the job is late.
For more information, see Automatic Job Flow
Adjustment on page 74
s EXECTIME limit The message is sent if the elapsed
runtime of the job is outside a specified limit. The limit can
be expressed as a runtime limit, or as a deviation from the
average runtime of the job. Valid formats for limit are
(where n is a 3-digit nonzero value):
>n The elapsed runtime of the job is greater than n
minutes. n cannot exceed 999
<n The elapsed runtime of the job is less than n
minutes. n cannot exceed 999
+n The elapsed runtime of the job exceeds the average
execution time of the job by at least n minutes.
n cannot exceed 999
n The elapsed runtime of the job is at least n minutes
less than its average execution time. n cannot
exceed 999.
+n% The elapsed runtime of the job exceeds its average
execution time by at least n%. n cannot exceed 900
n% The elapsed runtime of the job is at least n% less
than its average execution time. n cannot exceed
99.
SHOUT: PostProcessing Parameter
620 CONTROL-M for OS/390 and z/OS User Guide
TO Destination of the message (1 through 16 characters).
Mandatory. Valid values are:
s U-userid or USERID-userid Writes the message to the IOA
Log file under the specified user ID. userid must be 1
through 8 characters.
s OPER[n] Sends a rollable message to the operator
console. n is an optional 2-digit route code. If a route code is
not specified, the default routes are Master Console and
Programmer Information (1 and 11), and optionally,
CONTROL-M/ Enterprise Manager. For more detailed
information regarding route codes, refer to the IBM
publication Routing and Descriptor Codes, GC38-1102.
s OPER2[n] Sends an unrollable, highlighted message to
the operator console. n is an optional 2 through digit route
code. If a route code is not specified, the default routes are
Master Console and Programmer Information (1 and 11),
and optionally, CONTROL-M/ Enterprise Manager. For
more detailed information regarding route codes, refer to
the IBM publication Routing and Descriptor Codes,
GC38-1102.
Table 202 SHOUT Subparameters (Part 2 of 4)
Subparameter Description
SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 621
s [TSO - loginid | T - loginid] [;Nn | ;Mm | ;NnMm | ;Lname]
Sends the message to the specified ID (groupid or logonid).
ID is mandatory.
If a groupid is specified, it must be a valid ID found within
the IOA Dynamic Destination Table.
If a logonid is specified, it must be 1 through 7 characters.
An optional second value, indicating the computer and/ or
node (such as Mm) of the TSO logonid, can be specified, as
follows:
Under JES2:
Valid values are: Nn, Mm or NnMm, where:
m is the machine ID (the computer in JES2, not the
4-character SMF system ID). For more information, see
the description of specifying IOA CPUs in the discussion
of the customization process in the INCONTROL for
OS/ 390 and z/ OS Installation Guide.
n is the 1 to 2 character JES/ NJE node ID.
Under JES3:
The only valid value is Lname, where Lname is the logical
JES name of the machine (that is, the name as used in JES3
command *T, not the SMF system ID.
For more information, see the description of specifying IOA
CPUs in the discussion of the customization process in the
INCONTROL for OS/ 390 and z/ OS Installation Guide.)
Note: A shout to a TSO user performs a TSO SEND command,
which may require authorization at the receiving node.
s U-M:mail-name Sends a message by mail to the recipient
identified by the mail-name prefix (1 through 12 characters).
s U-S:snmp_dest Sends an SNMP trap (message) to the
recipient identified by snmp_dest.
snmp_dest consists of from 1 through 12 characters, and
can be any of the following:
a host name
an IP address
a nickname defined in the SNMPDEST destination table
a group name defined in the SNMPDEST destination
table
s U-ECS Sends messages to the CONTROL-M/ Enterprise
Manager user.
Note: If you want SHOUT Messages to be sent to the
CONTROL-M/ Enterprise Manager, you must install Sample
Exit IOAX034W, which is in the IOA SAMPEXIT library.
Table 202 SHOUT Subparameters (Part 3 of 4)
Subparameter Description
SHOUT: PostProcessing Parameter
622 CONTROL-M for OS/390 and z/OS User Guide
General Information
The message is sent to the specified destination when the WHEN condition is
satisfied. The relationship between multiple SHOUT statements is OR (that as, each
statement is evaluated and performed independently of the others).
AutoEdit variables (system- and/ or user-defined) in the message text are supported
and automatically resolved (replaced) when the SHOUT message is issued. For more
information, see Chapter 5, JCL and AutoEdit Facility.
SHOUT statements can also be defined in Group entities, where they are used in a
manner similar to jobs. For example, SHOUT WHEN OK is activated when all the
jobs in the group end OK.
The WHEN Subparameter
If SHOUT WHEN EXECTIME values are stated with a + or sign, that is, when
elapsed runtime is compared to average runtime, the shout applies only if there is a
Job Statistics record for the job, containing statistics for at least one of the last 20 runs
of the job.
If a Job Statistics record exists, all available elapsed-time statistics for the last 20 job
runs are averaged to generate the average runtime, and the current runtime is
compared to this figure according to the specified criteria.
If EXECTIME values are negative (that is, if they are n or n%), the check can be
performed only after the job has finished running.
When EXECTIME values are positive (that is, if they are +n or +n%), the check can be
performed (and if the elapsed runtime limits are exceeded, the message can be
shouted) before the job has finished running.
URGN Determines the priority level of the message. Valid values are:
s R Regular. Default.
s U Urgent.
s V Very urgent.
MS Message text. Maximum length: 70 characters.
AutoEdit variables (both system and user-defined) are
supported and automatically resolved (replaced) at the time
the SHOUT message is issued. For AutoEdit usage
information, see Chapter 5, JCL and AutoEdit Facility.
Table 202 SHOUT Subparameters (Part 4 of 4)
Subparameter Description
SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 623
When CONTROL-M calculates EXECTIME values, such as job start time, average
execution time, actual elapsed time, shout message time, and so on, calculations are
made only in minutes, and seconds are ignored. Therefore, the results of expressions
such as SHOUT WHEN EXECTIME >001 (or +001) are unpredictable. BMC Software
recommends that you use SHOUT WHEN EXECTIME only when you need to
monitor jobs of more than a few minutes duration.
Relative EXECTIME limits must not exceed 24 hours. When relative EXECTIME
limits exceed 24 hours (such as if +n(%) of the average runtime exceeds 24 hours), the
message is shouted if and when processing reaches 24 hours.
If a relative EXECTIME is not specified prior to job submission, but is specified
afterwards (that is, the job is held, the parameters changed in the Zoom screen, and
the job is then freed), the EXECTIME value is ignored.
When the New Day procedure runs, any unexecuted SHOUT statements that relate to
jobs ordered on the previous day are automatically cancelled.
If, when you order jobs, you often specify a LATE or LATESUB time that crosses the
New Day time, you should consider implementing Wish WM2344. This Wish enables
jobs to operate with a shifted New Day time for SHOUT purposes. You can find
Wish WM2344 in the IOADFLT member in the IOA IOAENV library.
If you want only some specific jobs to operate with a shifted New Day time for
SHOUT purposes, you may not want to implement Wish WM2344. An alternative
method for use in such a case is illustrated in Example 4 on page 628.
The TO Subparameter
Specify TO=USERID-userid to write the message to the IOA Log file under the user
ID specified in the parameter.
Specify TO=OPER[n] to send the message to the operator console (route code n). If
the n value is omitted, the message is sent to all consoles to which route codes 1 or 11
are assigned. For more detailed information regarding route codes, refer to the IBM
publication Routing and Descriptor Codes, GC38-1102. Optionally, the message can
also be sent to the CONTROL-M/ Enterprise Manager user. This is described in
Shouting to CONTROL-M/ Enterprise Manager on page 470.
Specify TO=OPER2[n] to send a highlighted, unrollable message to the operator
console (route code n). If the n value is omitted, the message is sent to all consoles to
which route codes 1 or 11 are assigned. For more detailed information regarding
route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.
Optionally, the message can also be sent to the CONTROL-M/ Enterprise Manager
user, as described in the following section, Shouting to CONTROL-M/ Enterprise
Manager.
SHOUT: PostProcessing Parameter
624 CONTROL-M for OS/390 and z/OS User Guide
Specify TO=TSO-id or T-id to send the message to a groupid or logonid. The Shout
facility first searches the IOA Dynamic Destination table for the specified ID. If the
table contains an entry (groupid) that matches the value, the content of the entry is
used as the target for the shouted message. (The entire TO field is used. Therefore,
when directing the message to a remote user, do not append Nn or Mm. Instead, do
this in the IOA Dynamic Destination Table itself. For more information, see the
discussion of Destination Tables in the INCONTROL for OS/ 390 and z/ OS
Administrator Guide.)
If no matching ID is found in the Dynamic Destination table, the Shout facility
assumes the specified ID is a logonid. It then creates a TSO message that it hands over
to MVS. MVS then sends the message to that logonid. (If the logonid does not exist,
MVS cannot send the message, but no error message is generated.) When a second
value is used, the message is sent to the TSO logonid in the specified computer or
node (machine ID). To determine the machine ID under JES2, specify JES command
$LSYS.
Specify TO=U-M: mail-name-prefix to send the message by e-mail to the recipient
identified by the prefix. The full mail name address is supplied by the MAILDEST
table in the IOA PARM library. For more information about mail destinations, see the
INCONTROL for OS/390 and z/OS Administrator Guide. The MAILDEST table also
includes DFLTSFFX, the mail address suffix, for example: @MAIL.DOMAIN.COM,
the SMTP STC name and the HOSTNAME.
Specify TO=U-S:snmp_dest to send the SNMP trap (message) to the recipient
identified by snmp_dest. This variable (snmp_dest) can be any of the following:
s a host name
s an IP address
s a nickname defined in the SNMPDEST table
s a group name defined in the SNMPDEST table
For more information about mail destinations, see the INCONTROL for OS/390 and
z/OS Administrator Guide.
Shouting to CONTROL-M/Enterprise Manager
For CONTROL-M to be able to shout to CONTROL-M/ Enterprise Manager, the
following conditions must be satisfied at the site:
1. CONTROL-M/ Enterprise Manager must be installed and the ECS parameter must
be set to Y in the IOAPARM member in the IOA PARM library.
2. File MG2 (the CONTROL-M/ Enterprise Manager Shout File) must be defined.
SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 625
3. The following parameters in the IOAPARM member in the IOA PARM library
must be defined according to how messages must be targeted to
CONTROL-M/ Enterprise Manager:
s If TO=OPER and TO=OPER2 messages must be sent to
CONTROL-M/ Enterprise Manager, set the OPER2ECS parameter to Y (Yes).
Otherwise, set it to N (No).
When OPER2ECS is set to Y:
If these messages must also be sent to the MVS operator console, set the
OPER2CON parameter to Y (Yes).
If these messages must not also be sent to the MVS operator console, set the
OPER2CON parameter to N (No).
s If TO=U-ECS messages must be sent to CONTROL-M/ Enterprise Manager, set
the ECS2ECS parameter to Y (Yes); otherwise, set it to N (No). Regardless of the
value of this parameter, these messages are (also) sent to CONTROL-M and the
IOA Log.
Once the above conditions are satisfied, messages can be shouted to
CONTROL-M/ Enterprise Manager by specifying a destination of TO=OPER or
TO=OPER2 (without a route code qualifier) or TO=U-ECS.
Such messages are then placed by CONTROL-M in the M2G file. Once the shouted
message is in the M2G file, the CONTROL-M Application Server reads the file and
sends the message to the CONTROL-M/ Enterprise Manager user.
The URGN Subparameter
The URGN value indicates the urgency level of the message.
In addition, if the destination is USERIDuserid (or Uuserid), the user can control,
according to urgency, which messages are displayed when the IOA Log file is
accessed. Urgent and very urgent messages are highlighted on the screen. For more
details, see IOA Log Facility on page 289
Differences between SHOUT and DO SHOUT
SHOUT and DO SHOUT statements have the following differences:
s A DO SHOUT statement is applied only if the accompanying ON criteria are
satisfied. Therefore a DO SHOUT statement does not contain subparameters for
specifying when to perform the shout.
SHOUT: PostProcessing Parameter
626 CONTROL-M for OS/390 and z/OS User Guide
By contrast, a SHOUT statement requires that a value be specified, in the WHEN
subparameter, indicating when to shout the message. Messages can be shouted
when the job ends OK or NOTOK, when the job is late for submission or
completion, or when the job runs too long.
s A SHOUT statement appears in each job scheduling definition. A DO SHOUT
statement does not appear unless specified. To specify a DO SHOUT statement,
type SHOUT in an empty DO field and press Enter.
s The SHOUT URGN subparameter is equivalent to the DO SHOUT URGENCY
subparameter.
The SHOUT MS subparameter is equivalent to the DO SHOUT subparameter.
Examples
Example 1
If the job finishes executing OK, write a message to the IOA Log file under the
specified user ID:
The message is written to the log under CONTROL-M userid-SHIFTMNGR.
MEMNAME GPLSP0007
DAYS 01, 15
SHOUT WHEN OK TO U- SHI FTMNGR URGN R
MS I HAVE FI NI SHED FOR TONI GHT
SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 627
Example 2
When IMS is not active, send a message to all operators.
Figure 280 SHOUT Parameter Example 2
If IMS finishes executing, an unrollable message is sent to the operator. A different
message is sent if IMS terminates abnormally.
JOB: I MSPROD LI B CTM. PROD. SCHEDULE TABLE: I MSPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN OK TO OPER2 URGN R
MS * * * * * * * I MS I S NOT ACTI VE * * * * * * *
SHOUT WHEN NOTOK TO OPER2 URGN R
MS * * * * * * * I MS I S NOT ACTI VE - ENDED ABNORMALLY * * * * * * *
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====




COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
SHOUT: PostProcessing Parameter
628 CONTROL-M for OS/390 and z/OS User Guide
Example 3
If the job is not run because of a JCL error, notify the user who sent the job.
Figure 281 SHOUT and DO SHOUT Example
An urgent message is sent to the user ID that requested the job.
Example 4
Perform a LATE shout after the New Day time has passed and a new working day
has begun.
Assume the following:
s New Day time at the site is 0600.
s A job, LONGWAIT, is ordered at 1400.
s The job LONGWAIT must shout if it has not finished executing by 0700 on the
following day.
However, the New Day process automatically cancels any shout requirements of jobs
ordered on any previous day.
There are two ways to achieve the required LATE shout
Method 1
JOB: SACALC01 LI B CTM. PROD. SCHEDULE TABLE: SALARY
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST ANYSTEP PROCST CODES JNRUN A/O
DO SHOUT TO TSO-U0014 URGENCY U
= *** JCL ERROR IN SALARY JOB ***
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< ======




COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
SHOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 629
1 Create a DUMMY job scheduling definition named TRIGGER, containing the
following elements:
s The TIME FROM parameter is set to 1400.
s The OUT parameter is set to TRIGGER-SHOUT.
2 Create a DUMMY job scheduling definition named SHOUT. This job must be
ordered at the New Day time, and must contain the following elements:
s The TIME FROM parameter is set to 0700.
s The TIME UNTIL parameter is set to 1300.
s The MAXWAIT parameter is set to 02.
s The IN parameter is set to TRIGGER-SHOUT.
s The SHOUT parameter is set to WHEN LATESUB 0700.
3 Add to the LONGWAIT JOB an OUT condition, TRIGGER-SHOUT, that deletes
the TRIGGER-SHOUT condition when it ends.
This procedure works as follows:
s The IN condition in the SHOUT job prevents it from executing between 0600
and 1359.
s At 1400 the TRIGGER job adds the IN condition.
s The TIME FROM and UNTIL parameter values prevent the SHOUT job from
running until after the next New Day procedure, but the MAXWAIT parameter
value ensures that the job remains on the Active Jobs file for the following day.
s At 0700 on the following day
if the LONGWAIT job has ended, it has removed the IN condition required
before the SHOUT job can run, so that there is no false shout at 0700
if the LONGWAIT job has not ended, the SHOUT job runs, and the shout is
produced as required
Method 2
Use IOA Exit 34, and set values for the SET VAR parameter in the job scheduling
definition.
For more information, see the IOAX034H sample exit in the IOA SAMPEXIT library.
STEP RANGE: PostProcessing Parameter
630 CONTROL-M for OS/390 and z/OS User Guide
STEP RANGE: PostProcessing Parameter
Step range in the job that can be used in an ON PGMST statement. For more
information, see ON: PostProcessing Parameter on page 534.
Figure 282 STEP RANGE Parameter Format

Optional. STEP RANGE consists of the following subparameters:
Table 203 STEP RANGE Subparameters
Subparameter Description
STEP RANGE Name for the range. A name of 1 through 7 characters can be
specified. Only trailing blanks are allowed in this field.
FR (PGM,PROC) First pgmstep or pgmstep,procstep in the range.
Note: pgmstep is the step name in the EXEC statement that
identifies the program to be executed:
/ / pgmst ep EXEC PGM=pgmname
procstep is the step name in the EXEC statement that invokes
the procedure: / / pr ocst ep EXEC pr ocname
pgmstep values and procstep values can each be 1 through 8
characters in length.
TO Last pgmstep or pgmstep,procstep in the range. For more
information, see the note to the preceding subparameter, FR.
Note: The TO subparameter is optional. If blank, its value
defaults to the last step in the job.
STEP RANGE: PostProcessing Parameter
Chapter 3 Job Production Parameters 631
General Information
Whenever a STEP RANGE statement is specified, it eliminates the need to define
separate ON PGMST, ON PROCST, and ON CODES statements and accompanying
DO actions for each step in the range. The defined STEP RANGE name can be used,
without redefining the range, in subsequent ON PGMST, ON PROCST, and ON
CODES statements, by specifying the step range name, preceded by an asterisk, in the
ON PGMST field. For more information on ON PGMST and ON PROCST, see ON:
PostProcessing Parameter on page 534. For more information on ON CODES, see
CODES Values on page 541.
Any number of step ranges can be specified. After entering a STEP RANGE
parameter, another STEP RANGE parameter line is automatically displayed.
Restart Using All Runs of a Job Including Restarts
When processing ON blocks, CONTROL-M can incorporate the results of all previous
runs and restarts, filtering them for jobs restarted with the parameters RESTART,
RECAPTURE CONDITION and/ or ABEND CODES. CONTROL-M/ Restart searches
previous runs to determine which steps must be considered part of the restarted job.
For example, if one step finished successfully during its original run and another step
finished successfully after a restart, the ON block check for the successful finish for
both steps produces a TRUE result and the ON statement is satisfied.
Activation of this facility requires that the ALLRUNS parameter in the CTRPARM
parameter be set to YES. When activated, this facility may apply to any specified step,
step range, or to step value +EVERY.
STEP RANGE: PostProcessing Parameter
632 CONTROL-M for OS/390 and z/OS User Guide
Example
Define program steps STEP20 through STEP29A as step range DF2. If any of these
steps produce any system or user abend (except user abend U2030), rerun the job and
shout a message to TSO-P43.
Figure 283 STEP RANGE Parameter Example
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
==========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP ( C, D, F, N, R) FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE DF2 FR ( PGM. PROC) STEP20 . TO STEP29A .
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST * DF2 PROCST CODES S* * * * U* * * * NU2030 A/ O
DO RERUN
DO SHOUT TO TSO- P43 URGENCY R
= JOB PRDKPL03 ABENDED, THE JOB I S RERUN
DO
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< ======


COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
SYSOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 633
SYSOUT: PostProcessing Parameter
Controls handling of job output after the job ended OK.
Figure 284 SYSOUT Parameter Format

Optional. SYSOUT consists of the following subparameters:
NOTE
SYSOUT and DO SYSOUT statements are similar, but not identical. The differences
are outlined below in Differences Between SYSOUT and DO SYSOUT on page 638.
Table 204 SYSOUT Subparameters
Subparameter Description
OP Sysout option code. Mandatory. Valid values are:
s F Copy the job output to file.
s D Delete (purge) the job output.
s R Release the job output.
s C Change the class of the job output.
s N Change the destination of the job output.
sysout_data Relevant sysout data. Mandatory and valid only if the
specified OP value is F, C, or N. Valid values depend on the
OP value, as follows:
s F File name
s C New class (1 character). An asterisk (*) indicates the
original MSGCLASS of the job
s N New destination (1 through 8 characters)
FROM FROM class. Optional. Limits the sysout handling operation to
only those sysouts from the specified class.
Note: If a FROM class is not specified, all sysout classes are
treated as a single, whole unit.
SYSOUT: PostProcessing Parameter
634 CONTROL-M for OS/390 and z/OS User Guide
General Information
When a job ends OK, the CONTROL-M monitor, unless otherwise instructed, leaves
the job sysout in HELD class in the output queue.
The SYSOUT parameter is used to request additional handling of these held sysouts
when the job ends OK.
The CONTROL-M monitor sends all sysout handling requests to JES, which
processes the instructions. If, however, the copying of sysouts to a file is requested
(option F), CONTROL-M requests the sysouts from JES and then CONTROL-M
directly writes the sysout to the file.
Only one SYSOUT statement can be defined in a job scheduling definition. To specify
additional sysout handling instructions in addition to the one SYSOUT statement,
define appropriate DO SYSOUT statements:
DO SYSOUT statements are activated when their accompanying ON step and code
event criteria are satisfied. To define DO SYSOUT statements that act like a SYSOUT
statement, that is, those that operate only when the job ends OK, define their
accompanying ON statement with PGMST set to ANYSTEP and CODES set to OK.
For more information, see ON: PostProcessing Parameter on page 534, and DO
SYSOUT: Post-Processing Parameter on page 475.
The interrelationship between multiple sysout operations, as in SYSOUT and DO
SYSOUT statements, is described in Multiple Sysout Operations on page 636.
Sysout Handling Operations
Which sysouts are affected by sysout handling operations depends on whether the
sysouts are under JES2 or JES3, as follows:
s Under JES2, operations are performed on all of the held sysouts, or held portions of
sysouts, of the job, unless otherwise restricted to a specific FROM class by the
FROM subparameter.
s Under JES3, operations are performed only on the sysouts of the job in the
CONTROL-M held class, which is specified in the CONTROL-M installation
parameter HLDCLAS.
Sysout handling operations are listed below:
s Copying sysouts to a file (OPT=F)
The job sysouts are copied (not moved) to the file specified in the data
subparameter.
SYSOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 635
The file name specified in the data subparameter can contain AutoEdit system
variables, and/ or user-defined AutoEdit variables, which are defined in the job
scheduling definition or the IOA Global Variable database, or which are loaded
into AutoEdit cache. If the AutoEdit variables cannot be resolved, the sysout is not
copied.
CONTROL-M allocates the file with DISP=(NEW,CATLG,DELETE) using the unit
and space attributes specified in the CONTROL-M installation parameters.
Sysouts can be archived by copying them to a file. However, to reduce overhead,
this method is recommended only for small sysouts.
s Deleting sysouts (OPT=D)
The job sysouts are deleted (purged) from the output queue.
s Releasing sysouts (OPT=R)
The job sysouts are released for printing.
s Changing the class of sysouts (OPT=C)
The job sysouts are changed to the output class specified in the data subparameter.
Ensure that you specify a meaningful target output class.
Note the following points:
Changing a sysout class to a non-held class does not release the sysout because
the sysout attributes do not change (due to JES logic).
To ensure that the sysout is released, use DO SYSOUT statements to release the
sysout after changing its class. For example,
DO SYSOUT OPT C PRM R FRM A
DO SYSOUT OPT R PRM FRM A
Changing a sysout class to a dummy class does not purge the sysout because the
sysout attributes do not change (due to JES logic).
To save the original MSGCLASS of the job and to restore it at output processing
time, specify a data value of *. The sysouts are changed to the original class of
the job.
NOTE
This operation works on all sysouts under JES2 or JES3, regardless of held status or
class, unless otherwise restricted by the FROM subparameter.
SYSOUT: PostProcessing Parameter
636 CONTROL-M for OS/390 and z/OS User Guide
s Moving sysouts to a new destination (OPT=N)
The job sysouts are moved to the output destination specified in the data
subparameter. Ensure that you specify a meaningful target output destination.
Multiple Sysout Operations
If multiple SYSOUT or DO SYSOUT operations are not specified for the same FROM
class, the order in which the operations are performed is not significant.
However, if different SYSOUT or DO SYSOUT operations affect the same FROM
class, or if multiple operations are specified without a FROM class, the order and
method of implementation is significant.
CONTROL-M merges different operations for the same FROM class into a combined
instruction to JES. Likewise, CONTROL-M merges different operations without a
FROM class into a combined instruction to JES.
Operations without a specified FROM class treat the entire held sysout as a whole
unit, and are therefore not merged with sysout handling requests for a specific FROM
class.
JES does not necessarily process multiple sysout handling instructions in the order
they are issued by CONTROL-M. Therefore, the processing results can vary if the
merged instructions to JES include both FROM equals a specified class and FROM
equals blank.
BMC Software therefore recommends that a job scheduling definition not contain
both FROM class and no FROM class sysout handling instructions, which
becomes operational under the same situations.
When CONTROL-M merges a set of operations into a combined instruction, some
operations override or cancel other operations, and some operations are performed
along with other operations. This is described below.
Operation Merging and Performance
CONTROL-M performs all copy to file operations (option F) first.
After performing all copy to file operations, CONTROL-M merges all operations
performed on a specific FROM class.
After merging operations on specific FROM classes, CONTROL-M merges the
operations performed on the sysout as a whole (that is, subparameter FROM is set to
blank).
CONTROL-M then passes the merged sets of instructions to JES for processing.
SYSOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 637
Generally, DO SYSOUT operations override, or are performed along with, SYSOUT
statements.
The following chart and the accompanying numbered explanations indicate the result
of merging SYSOUT and DO SYSOUT statements. Note the following points about
the chart:
s Operations are indicated by their symbols (F,D,R,C,N), at the top and side of the
chart. The operations at the top of the chart represent DO SYSOUT operations. The
operations at the side of the chart represent SYSOUT operations.
s Merging and processing operations are grouped, and explained, based on
operation type.
Groups are delimited by lines, and are numbered (from 1 through 4). Within each
group, operations are delimited by periods.
Explanations of each group are provided, by number, following the chart.
s The handling of the combination of operations is generally reflected in the chart by
a single operation code (such as D) or pair of operation codes (such as FR).
In some cases, the operations are merged. This is indicated by the word merged.
Operations are explained in the numbered descriptions that follow the chart.
Figure 285 Merging SYSOUT and DO SYSOUT Statements

SYSOUT: PostProcessing Parameter
638 CONTROL-M for OS/390 and z/OS User Guide
The order of precedence in which CONTROL-M processes or merges operations is as
follows:
1. SYSOUT=F and DO SYSOUT=F
Copy to file operations are performed first, directly by CONTROL-M, for both
SYSOUT and DO SYSOUT statements, whether FROM class is specified or not.
Then, other operations are performed.
2. DO SYSOUT=D (Delete)
This operation supersedes all SYSOUT operations, except copy to file operations
described above. Superseded operations are ignored (that is, not performed).
3. DO SYSOUT=R, C, or N, accompanied by a SYSOUT D (Delete) request
The DO SYSOUT statement is performed, and the SYSOUT delete request is
ignored.
4. SYSOUT or DO SYSOUT combinations of R, C and N
In general, combinations of R, C, and N requests are merged, that is, they are all
performed. The exceptional cases are described below:
For DO SYSOUT=R (Release job output) accompanied by a SYSOUT C (Change
class) request:
Perform just the DO SYSOUT R request and ignore the SYSOUT C request.
For C (Change class) requests from both a SYSOUT and a DO SYSOUT
statement:
Perform just the DO SYSOUT request and ignore the SYSOUT request.
For N (New Destination) requests from both a SYSOUT and a DO SYSOUT
statement:
Perform just the DO SYSOUT request and ignore the SYSOUT request.
Differences Between SYSOUT and DO SYSOUT
SYSOUT and DO SYSOUT statements have the following differences:
s The SYSOUT statement is applied only if the job ends OK. DO SYSOUT statements
are associated with accompanying ON statements and are applied only if the
accompanying ON step and code criteria are satisfied.
SYSOUT: PostProcessing Parameter
Chapter 3 Job Production Parameters 639
s A SYSOUT statement is displayed in each job scheduling definition. A DO
SYSOUT statement is not displayed unless requested. To request a DO SYSOUT
statement, type SYSOUT in an empty DO field and press Enter.
s Only one SYSOUT statement can be defined in the job scheduling definition. An
unlimited number of DO SYSOUT statements can be requested.
s The SYSOUT OP subparameter is equivalent to the DO SYSOUT OPT
subparameter.
s The SYSOUT data subparameter is equivalent to the DO SYSOUT PRM
subparameter.
s The SYSOUT FROM subparameter is equivalent to the DO SYSOUT FRM
subparameter.
Examples
Example 1
Delete the sysout after the job has finished executing OK:
MEMNAME EBMANT1
DAYS 1, 15
SYSOUT OP D ( C, D, F, N, R)
SYSOUT: PostProcessing Parameter
640 CONTROL-M for OS/390 and z/OS User Guide
Example 2
If the job finishes OK, reroute the sysout to printing class A.
Figure 286 SYSOUT Parameter Example 2
JOB: EBDMANT2 LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
===========================================================================
I N
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT
AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
SYSOUT OP C ( C, D, F, N, R) A FROM
MAXRERUN RERUNMEM I NTERVAL FROM
STEP RANGE FR ( PGM. PROC) . TO .
ON PGMST PROCST CODES A/ O
DO
SHOUT WHEN TO URGN
MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< ====

COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
SYSTEM ID: General Job Parameter
Chapter 3 Job Production Parameters 641
SYSTEM ID: General Job Parameter
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 execute.
Figure 287 SYSTEM ID Parameter Format
SYSTEM ID specifies a system identity of 1 through 4 characters. Only trailing blanks
are allowed.
By default, the SYSTEM ID parameter is optional.
General Information
The SYSTEM ID parameter has different effects, depending on which release of JES is
in use.
If a value is specified for the SYSTEM ID parameter, it will not override any system
identity specified in the job statement unless the OVERJCLM parameter in the
CTMPARM library is set to Y.
Under JES2
If CONTROL-M is running under JES2, the SYSTEM ID parameter is used to specify
the JES2 system on which the job is to be initiated and executed.
If a value is specified for the SYSTEM ID parameter, the following JCL statement is
generated:
/ * JOBPARM SYSAFF=sys_i d
SYSTEM ID: General Job Parameter
642 CONTROL-M for OS/390 and z/OS User Guide
Under JES3
If CONTROL-M is running under JES3, the SYSTEM ID parameter is used to specify
the JES3 processor which is to execute the job.
If a value is specified for the SYSTEM ID parameter, the following JCL statement is
generated:
Examples
Example 1: JES2
The following is entered:
The following statement is added to the JCL of the job:
and the job is executed on the JES2 system SYS3.
Example 2: JES3
The following is entered:
The following statement is added to the JCL of the job:
and the job is executed on processor PRC3.
/ / * MAI N SYSTEM=pr ocessor _i d
DESC
OVERLI B
SCHENV SYSTEM I D SYS3 NJE NODE
/ * JOBPARM SYSAFF=SYS3
DESC
OVERLI B
SCHENV SYSTEM I D PRC3 NJE NODE
/ / * MAI N SYSTEM=PRC3
TASKTYPE: General Job Parameter
Chapter 3 Job Production Parameters 643
TASKTYPE: General Job Parameter
Type of task.
Figure 288 TASKTYPE Parameter Format

Mandatory. Valid TASKTYPE values are:
General Information
The job scheduling definition can belong to one of three basic types of tasks:
s Job
s Started Task
s Warning Message
Jobs and started tasks can be normal, that is, submitted or activated once, or cyclic.
Furthermore, it is possible to define emergency versions of jobs and started tasks
(normal and/ or cyclic).
Table 205 TASKTYPE Parameter Values
Value Description
JOB Batch job. Default
CYC Cyclic job
STC Started task (STC)
CST Cyclic STC
EMR Emergency job
ECJ Emergency cyclic job
EST Emergency STC
ECS Emergency cyclic STC
WRN Warning message
TASKTYPE: General Job Parameter
644 CONTROL-M for OS/390 and z/OS User Guide
The three basic types of tasks are indicated by the following TASKTYPE values:
Jobs and Started Tasks
A regular job is submitted to the JES input queue for execution; it then waits in the
queue like any job submitted under the operating system.
After the job finishes executing, CONTROL-M analyzes the results and determines
what actions to take. The job is not submitted again unless the RERUN statement is
performed. For additional information, see MAXRERUN: PostProcessing
Parameter on page 512.
Started tasks differ from jobs in that they are not submitted to the queue; instead, they
are invoked by an operator START command issued by CONTROL-M. For details on
passing parameters to started tasks, see MEMLIB: General Job Parameter on
page 519.
A cyclic job or a cyclic started task is recycled for additional possible executions after
CONTROL-M has analyzed its execution results. The job or started task executes
again only after the number of minutes specified in the INTERVAL parameter has
passed since the last execution and the rest of its runtime scheduling criteria have
been satisfied.
If a cyclic job is executing at the time the New Day procedure is run, the New Day
procedure changes the job to a non-cyclic job and handles the job accordingly.
Use of the cyclic option precludes the use of RERUNMEM and DO RERUN
parameters.
Table 206 TASKTYPE Basic Type Values
Task Values
Job: JOB, CYC, EMR, ECJ
Started Task: STC, CST, EST, ECS
Warning: WRN
NOTE
PREVENT- NCT2=Y cannot be specified for started tasks (STCs).
NOTE
BMC Software recommends that a cyclic job delete the prerequisite conditions that
triggered its operation. Otherwise the job might continually be resubmitted.
TASKTYPE: General Job Parameter
Chapter 3 Job Production Parameters 645
Emergency Jobs and Started Tasks
An emergency job or emergency started task can be used to overcome any
irregularities in normal execution. The job remains in the Active Jobs file, waiting to
be scheduled, until all regular jobs of the same GROUP finish executing OK and are
checked by CONTROL-M. Then, when the emergency job is no longer needed, the job
is automatically removed from the Active Jobs file. For additional information, see
MAXWAIT: Basic Scheduling Parameter on page 515.
Emergency jobs can be filtered out of the job display in the Active Environment
screen and filtered out of reports.
Warning Messages
For tasktype WRN, warning messages are sent to the IOA Log file when the job is
ordered. The messages are taken from the member specified in the MEMNAME
parameter.
NOTE
Emergency jobs and started tasks are supported for backward compatibility, but
BMC Software recommends redefining them as regular jobs and started tasks that are
activated by DO FORCEJOB statements. CONTROL-M/ Restart users can also use a
DO IFRERUN statement. The DO FORCEJOB statement is described in DO
FORCEJOB: PostProcessing Parameter on page 444, and the DO IFRERUN
statement in RestartDO IFRERUN: PostProcessing Parameter on page 446.
NOTE
BMC Software recommends that the GROUP parameter be specified if you define
emergency jobs. If it is not specified, the job may stay indefinitely in the Active Jobs
file.
NOTE
The IOANOTE utility, which is described in the INCONTROL for OS/390 and z/OS
Utilities Guide, can also be used to issue warning messages. BMC Software
recommends that the IOANOTE utility be used in place of this tasktype wherever
possible.
NOTE
A job defined with tasktype WRN is not placed in the Active Jobs file.
TASKTYPE: General Job Parameter
646 CONTROL-M for OS/390 and z/OS User Guide
Examples
Example 1
Submit a regular job:
Example 2
Start a started task:
Example 3
Start an emergency job:
MEMNAME GNRLDR01
TASKTYPE JOB
MEMNAME CI CSPROD
TASKTYPE STC
MEMNAME RESTORE2
TASKTYPE EMR
TASKTYPE: General Job Parameter
Chapter 3 Job Production Parameters 647
Example 4
Job OPERCOMP is a regular job.
Figure 289 TASKTYPE Parameter Example 4
JOB: OPERCOMP LI B CTM. PROD. SCHEDULE TABLE: OPER
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME OPERCOMP MEMLI B CTM. PROD. JCL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL OPER GROUP MAI NTENANCE
DESC JOB RUN ON THE 1ST OF THE MONTH
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPERCOMP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS 01 DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
TIME: Runtime Scheduling Parameter
648 CONTROL-M for OS/390 and z/OS User Guide
TIME: Runtime Scheduling Parameter
Time limits (FROM, UNTIL) for submitting the job.
Figure 290 TIME Parameter Format

The TIME parameter is optional. It consists of two subparameters: FROM and UNTIL.
Either or both subparameters may be specified.
The FROM and UNTIL fields can contain valid times in the format hhmm (where hh
is hour and mm is minute). The character > can be entered in field UNTIL.
General Information
FROM and UNTIL times define a window of opportunity for job submission. A job
can only be submitted during the specified submission window.
If either a FROM or an UNTIL value is missing, that is, not specified, the New Day
Processing time is used as the default for the missing value. Therefore:
s To create a submission window from a particular time until time of New Day
processing, enter the desired From time in the FROM field and leave the UNTIL
field blank.
Example
FROM 22: 00 UNTI L ( bl ank)
creates a submission window from 10:00 p.m. until New Day Processing time.
s To create a submission window from time of New Day processing until a
particular time, enter the desired Until time in the UNTIL field and leave the
FROM field blank.
TIME: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 649
Example
FROM ( bl ank) UNTI L 13: 00
creates a submission window from New Day processing until 1:00 p.m.
When both a FROM and an UNTIL value are specified, the relationship of New Day
Processing time to these values (on a physical clock) determines the submission
window. The logic is as follows:
s If, when you move forward on the physical clock from the New Day Processing
time, you arrive at the FROM time before you arrive at the UNTIL time, it means
that New Day processing does not fall between the FROM time and UNTIL time.
In this case, the submission window runs from the FROM time to the UNTIL time,
regardless of when the job was ordered.
Example 1
Assume a New Day Processing time of 8:00 a.m.
FROM 14: 00 UNTI L 22: 00
creates a submission window from 2:00 p.m. until 10:00 p.m., a period of 8 hours
Example 2
Assume a New Day Processing time of 10:00 p.m.
FROM 23: 00 UNTI L 05: 00
creates a submission window from 11:00 p.m. until 5:00 a.m., a period of 6 hours
Example 3
Assume a New Day Processing time of 10:30 p.m.
FROM 23: 00 UNTI L 22: 00
creates a submission window from 11:00 p.m. until 10:00 p.m., a period of 23 hours
s If, when you move forward on the physical clock from the New Day Processing
time, you arrive at the UNTIL time before you arrive at the FROM time, it means
that New Day processing falls between the FROM time and UNTIL time.
TIME: Runtime Scheduling Parameter
650 CONTROL-M for OS/390 and z/OS User Guide
Batch jobs are frequently scheduled for submission from night until the morning.
Therefore, when the New Day Processing time intervenes between the FROM time
and the UNTIL time, it is likely that, following New Day Processing, the site still
wants the job to be submitted up until the UNTIL time, without first waiting for
the FROM time of the New Day.
For this reason, if New Day Processing comes between the FROM time and the
UNTIL time, then regardless of when the job was ordered, the job is eligible for
submission from both
the FROM time until New Day Processing time
New Day Processing time until the UNTIL time
The actual effect is that the submission window consists of all times except the
interval from the UNTIL time until the FROM time.
Example
Assume a New Day Processing time of 4:00 a.m.
FROM 23: 00 UNTI L 06: 00
creates a submission window from 11:00 p.m. until 4:00 a.m. and from 4:00 a.m.
until 6:00 a.m., giving a net submission window from 11:00 p.m. until 6:00 a.m. The
job cannot be submitted from 6:00 a.m. until 11:00 p.m.
The character > in the UNTIL field indicates that CONTROL-M must attempt to
submit the job at the FROM time if specified, and if this is not possible, CONTROL-M
must submit the job as soon afterwards as possible, even at a later date (unless the
MAXWAIT period has expired).
Example
Assume a New Day Processing time of 8:00 a.m.
FROM 22: 00 UNTI L >
creates a submission window that begins at 10:00 p.m. If the job has not been
submitted by the end of day, it can be submitted at any time from the beginning of
the next day.
The FROM parameter is ignored when a job is rerun or restarted on a subsequent day.
Specifying the same time in both the FROM and the UNTIL fields has the same
impact as entering no value in both fields.
TIME: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 651
Example
Submit the job after midnight:
Figure 291 TIME Parameter Example
In this example, if the start time of the new workday is 6:00 a.m., this job can only be
submitted between the hours of midnight and 6:00 a.m.
JOB: OPGENBKP LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM OPGENBKP DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 00 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N
CONTROL
RESOURCE
PI PE
TI ME: FROM 0000 UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
TIME ZONE: Runtime Scheduling Parameter
652 CONTROL-M for OS/390 and z/OS User Guide
TIME ZONE: Runtime Scheduling Parameter
Adjusts the values specified in the TIME parameter to those in a different time zone.
A related parameter is TIME: Runtime Scheduling Parameter on page 648.
Figure 292 TIME ZONE Parameter Format
Optional. TIME ZONE specifies a time zone using three characters.
General Information
The TIME ZONE parameter appears in the Job Scheduling Definition screen (Screen
2) and the Active Environment Zoom screen (Screen 3.z).
The TIME ZONE parameter uses three characters to define a time zone by reference
to Greenwich Mean Time (UTC). This enables automatic adjustment of the times
specified in some fields of the Job Scheduling Definition screen to the corresponding
times in a time zone other than that in which the system is operating. The fields that
are automatically adjusted are the following:
s TIME FROM
s TIME UNTIL
s DUE OUT
s SHOUT WHEN
If you set the TIME ZONE parameter appropriately, CONTROL-M calculates the
corresponding times automatically, and the job runs only during the hours you
require.
The three-character values used in the TIME ZONE parameter are defined in the
TIMEZONE member in the IOA PARM library. A sample TIMEZONE member is
provided, but you can edit the values as needed. For example, you can use EST or
NYC instead of G-5, which is the default value for US Eastern Standard Time.
TIME ZONE: Runtime Scheduling Parameter
Chapter 3 Job Production Parameters 653
Example
You are running CONTROL-M in London, but want a job to run only when the New
York Stock Exchange is open, between 0900 (9 A.M.) and 1600 (4 P.M.) in New York
(US Eastern Standard Time). US Eastern Standard Time is five hours behind London
time (GMT-5 hours).
1. In the Job Definition screen (Screen 2) or the Active Environment Zoom screen
(Screen 3.Z) set the TIME FROM parameter to 0900 and the UNTIL parameter to
1600.
2. The TIMEZONE member defines GMT-5 hours as EST.
3. Set the TIME ZONE parameter in the same screen to EST. When you press the
Enter key, the CONTROL-M interpretation of your specification is also displayed
in the format ( GMTxhh: mm)
where:
s x is + (Plus) or - (Minus)
s hh is the hours figure you specified
s mm is the minutes figure specified, either 00 or 30
4. The job will run between 2 P.M. and 9 P.M. at your site in London. These times
correspond respectively to 9 A.M. and 4 P.M. in New York, the hours when the
New York Stock Exchange is open. In other words, the job runs as if the TIME
FROM was set to 1400 and UNTIL to 2100.
NOTE
Daylight Saving Time is defined differently in different time zones. For more
information on Daylight Savings Time, see the CONTROL-M chapter in the
INCONTROL for OS/390 and z/OS Administrator Guide.
NOTE
In the Job Scheduling Definition screen (Screen 2) and the Active Environment Zoom
screen (Screen 3.Z), the times appear as you specified, as 0900 and 1600 respectively.
In the Active Environment Why screen (Screen 3.?), the times appear with their
converted values of 1400 and 2100 respectively.
WDAYS: Basic Scheduling Parameter
654 CONTROL-M for OS/390 and z/OS User Guide
WDAYS: Basic Scheduling Parameter
Days of the week on which the job must be scheduled.
Related parameters are DAYS: Basic Scheduling Parameter on page 420, and
CONFCAL: Basic Scheduling Parameter on page 402.
Figure 293 WDAYS Parameter Format

Optional. The WDAYS parameter specifies days of the week on which jobs must be
scheduled, provided other basic scheduling criteria are met.
Values for WDAYS can be specified alone, or they can be specified together with a
calendar specified in the WCAL subparameter. WDAYS and WCAL can also be
specified together with DAYS and DCAL, which are described under DAYS: Basic
Scheduling Parameter on page 420.
WDAYS subparameters are described below:
WDAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 655
Assuming all other basic scheduling criteria are met:
s When WDAYS are specified without WCAL, the job is scheduled on the specified
days of the week.
s When WCAL is specified without WDAYS, the job is scheduled on the working
days marked in the WCAL calendar.
s When WDAYS and WCAL are both specified, scheduling depends on the
combination of working days defined in the calendar and the values or format of
the WDAYS parameter (described below).
s When both DAYS and WDAYS criteria are specified, scheduling depends on the
connecting AND/ OR value specified. For more information, see subparameter
AND/ OR in Table 162 on page 420.
Table 207 WDAYS Subparameters
Subparameter Description
WDAYS Days of each week in the month on which to schedule a job.
(The months in which to order jobs are specified in the
MONTHS parameter.) Various formats (described later) can
be used to specify WDAYS; for example, 2 means the second
day of the week, L2 means the day before the last day of the
week.
Note: At time of installation, the INCONTROL administrator
selects either Sunday or Monday as the first day of the week.
Your INCONTROL administrator can tell you whether the
week begins on Sunday or Monday at your site.
The first six days of the week are coded 1 through 6. The last
day of the week is coded 0 (zero). All examples in this chapter
assume Monday is the first day of the week. In these examples,
Monday = 1, Tuesday = 2, ..., Saturday = 6, and Sunday = 0.
WCAL Name of a calendar containing a predefined set of dates,
referred to as working days, on which a job is to be scheduled.
A specified value must be either a valid member name of 1
through 8 characters, or an * to indicate that the calendar
specified in the CONFCAL parameter must be used for
scheduling. For more information about how to define, use
and modify calendars, see IOA Calendar Facility on
page 301.
Note: A calendar specified in WCAL does not have to exist
when defining the WDAYS parameter. However, it must exist
when the job is to be ordered.
WDAYS: Basic Scheduling Parameter
656 CONTROL-M for OS/390 and z/OS User Guide
Valid Formats for WDAYS
Valid formats for the WDAYS parameter, and how they relate to WCAL, are
described below.
In the following non-periodic scheduling formats, n is an integer from 1 through 6 or
0 (zero), where 1 = the first day of the week (Sunday or Monday, depending on the
standard at your site) and 0 = the last day of the week (Saturday or Sunday).
s Multiple values can be expressed, separated by commas, in any order.
s WCAL must not contain the name of a periodic calendar.
Table 208 Non-Periodic Scheduling Formats (Part 1 of 2)
Format Description
ALL All days of the week. If ALL is specified, other WDAYS values
cannot be specified with it.
If a WCAL calendar is not defined, schedule the job on all days
in the week.
If a WCAL calendar is defined, schedule the job only on the
working days indicated in the calendar.
n,... Specific days of the week.
If a WCAL calendar is not defined, schedule the job on the
specified days.
If a WCAL calendar is defined, schedule the job only when a
day is defined as a working day both in the WDAYS
parameter and in the WCAL calendar.
+n,... Days of the week in addition to the working days specified in
the WCAL calendar. WCAL is mandatory.
n,... Order the job on all days except the nth day from the
beginning of the week. WCAL is mandatory.
>n,... Order the job on the indicated day if it is a working day in the
WCAL calendar; otherwise, order the job on the next working
day (within the next seven days
a
) that is not negated by a n
value in the parameter. This format is frequently used for
holiday handling. WCAL is mandatory.
<n,... Order the job on the indicated day if it is a working day in the
WCAL calendar; otherwise, order the job on the last previous
working day (within the preceding seven days
a
) that is not
negated by a n value in the parameter. This format is
frequently used for holiday handling. WCAL is mandatory.
Dn,... Order the job on the nth working day from the beginning of
the week. WCAL is mandatory.
Dn,... Order the job on all working days except the nth working day
from the beginning of the week. WCAL is mandatory.
WDAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 657
In the following periodic scheduling formats:
s n is any integer from 0 through 6, and i is any valid period identifier.
s WDAYS periodic identifiers are counted on a week by week basis. Calculations do
not cross week boundaries, unlike DAYS periodic identifiers, which can cross
month boundaries.
s The name of a periodic calendar must be specified in WCAL. For details
concerning periodic calendars, see IOA Calendar Facility on page 301.
s A maximum of eight periodic values can be specified in any desired order.
Ln,... Order the job on the nth working day counting from the end of
the week. WCAL is mandatory.
Ln,... Order the job on all working days except the nth working day
counting backward from the end of the week. WCAL is
mandatory.
DnWm,... (Where m = 1 through 6). If WCAL is defined, order the job on
the nth working day of the mth week of the month. If WCAL is
not defined, order the job on the mth appearance of the nth day
of the week during the month. A maximum of eleven DnWm
values can be specified. WCAL is optional.
a
If none of those seven days is a working day, the job is not ordered.
Table 209 Periodic Scheduling Formats
Format Description
DnPi,... Order the job on the nth day of period i in each week, from the
beginning of the week. An * can be entered as the i value to
represent all periods.
DnPi,... Order the job on all days except the nth day of period i in each
week, from the beginning of the week. An * can be entered as
the i value to represent all periods.
LnPi,... Order the job on the nth day of period i in each week, counting
backward from the last periodic day of the week. An * can be
entered as the i value to represent all periods.
LnPi,... Order the job on all days in period i except the nth day of
period i in each week, counting from the last periodic day of
the week. An * can be entered as the i value to represent all
periods.
Table 208 Non-Periodic Scheduling Formats (Part 2 of 2)
Format Description
WDAYS: Basic Scheduling Parameter
658 CONTROL-M for OS/390 and z/OS User Guide
General Information
Negative values take precedence over positive values when determining whether a
job is scheduled on a certain date. If a negative value (that is, format n, Dn, Ln,
DnPi, or LnPi) in either the DAYS or WDAYS field prevents a job from being
scheduled on a date, the job is not scheduled on that date even if a positive value
(such as Ln) in a basic scheduling parameter would otherwise result in the job being
scheduled on that date.
If periodic and non-periodic values are mixed when specifying the WDAYS
parameter, processing depends on the calendar type specified in the WCAL
parameter:
s If a non-periodic calendar is specified in WCAL, only non-periodic values in the
WDAYS parameter are processed; periodic values are ignored. In this case,
negative periodic values (that is, DnPi, LnPi) are also ignored and do not
supersede other values.
s If a periodic calendar is specified in WCAL, all periodic values and all negative
non-periodic values (for example, n) in the WDAYS parameter are processed; all
non-negative non-periodic values are ignored.
The MONTHS parameter is ignored when periodic values are specified in the
WDAYS parameter.
The WDAYS parameter cannot be used with the PDS and MINIMUM parameters.
For certain exceptional situations regarding the interaction of the WDAYS and
MONTHS parameters, see MONTHS: Basic Scheduling Parameter on page 529.
Examples
The examples in this chapter are based on the following assumptions:
s The current month is December, 2001.
s Working days are defined in calendar WORKDAYS, which contains the following
working days (indicated by Y) for December, 2001.
- - - 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 + 1
Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
WDAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 659
s Periodic calendar PERIDAYS contains the following periodic definition for
December 2001. These examples assume that all other days of this calendar are
blank.
s Start of the week is defined as Monday. Weeks start on the following dates in
December 2001: 3rd, 10th, 17th, 24th, and 31st.
At the end of each example, asterisks in a December 2001 calendar indicate the days
on which the job is scheduled.
Example 1
Schedule the job on every Sunday and Monday.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 294 WDAYS Parameter Example 1

Example 2
Schedule the job on all working days and on all Saturdays.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 295 WDAYS Parameter Example 2

- - - 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 + 1
B C A A B B C A A B B C A A B B C A A B B
WDAYS 0, 1
WDAYS +6
WCAL WORKDAYS
WDAYS: Basic Scheduling Parameter
660 CONTROL-M for OS/390 and z/OS User Guide
Example 3
Schedule the job on Sunday, if it is a working day. If Sunday is not a working day,
schedule the job on the first preceding working day that is not a Friday.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 296 WDAYS Parameter Example 3
Example 4
Schedule the job on Monday of the 1st week.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 297 WDAYS Parameter Example 4

Example 5
Schedule the job on all working days except Mondays and Fridays.
WDAYS - 5, <0
WCAL WORKDAYS
WDAYS D1W1
WDAYS - D1, - L1
WCAL WORKDAYS
WDAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 661
The job is scheduled on the days of the month indicated by an asterisk:
Figure 298 WDAYS Parameter Example 5
Example 6
Each week, schedule the job on the 1st day of period A in that week, and on all days
of period B except the second day of period B in any week.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 299 WDAYS Parameter Example 6

Example 7
Schedule the job on each Monday and on the 1st day of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 300 WDAYS Parameter Example 7

WDAYS D1PA, - D2PB
WCAL PERI DAYS
DAYS 1
AND/ OR OR
WDAYS 1
WDAYS: Basic Scheduling Parameter
662 CONTROL-M for OS/390 and z/OS User Guide
Example 8
Schedule the job on the 3rd day of the month provided it is a Monday.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 301 WDAYS Parameter Example 8

Example 9
Schedule the job on the last Monday of the month.
The job is scheduled on the days of the month indicated by an asterisk:
Figure 302 WDAYS Parameter Example 9

Example 10
Schedule the job on the 1st, 7th and 15th day of the month if they are both Saturdays
and working days. If the day of the month (1st, 7th, 15th) is not a Saturday, do not
schedule the job. If the day of the month is a Saturday, but it is not a working day,
schedule the job on the next working day.
DAYS 3
AND/ OR AND
WDAYS 1
DAYS L1, L2, L3, L4, L5, L6, L7
AND/ OR AND
WDAYS 1
DAYS 1, 7, 15
AND/ OR AND
WDAYS 6
CONFCAL WORKDAYS
SHI FT >
WDAYS: Basic Scheduling Parameter
Chapter 3 Job Production Parameters 663
The job is scheduled on the days of the month indicated by an asterisk:
Figure 303 WDAYS Parameter Example 10

WDAYS: Basic Scheduling Parameter
664 CONTROL-M for OS/390 and z/OS User Guide
Chapter 4 CONTROL-M Event Manager (CMEM) 665
Chapt er
4
4 CONTROL-M Event Manager (CMEM)
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Types of Events Managed by CMEM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Types of Actions That CMEM Can Perform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
CMEM Rule Ordering, Triggering and Deactivation. . . . . . . . . . . . . . . . . . . . . . . 668
CMEM AutoEdit Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
On Spool Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
CMEM Support for IBM FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Rule Parameters Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Event Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
General Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Action Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
DESCRIPTION: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
DO statement: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
DO COND: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
DO FORCEJOB: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
DO RULE: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
DO SHOUT: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
DO STOPJOB: Action Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
GROUP: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
MODE: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
ON statement: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
ON DSNEVENT: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
ON JOBARRIV: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
ON JOBEND: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
ON STEP: Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
OWNER: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
RUNTSEC: General Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
THRESHOLD: Runtime Scheduling Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Overview
666 CONTROL-M for OS/390 and z/OS User Guide
Overview
The CONTROL-M Event Manager (CMEM) facility enables CONTROL-M to perform
specified actions in response to external events. External events are events in the
system that occur outside the direct control of CONTROL-M, such as submission of a
job not under the control of the CONTROL-M monitor.
The CMEM facility is an optional facility based on a monitor and a subsystem.
The CMEM facility utilizes sets of user-defined rules that specify events to monitor
and actions to perform if a specified event occurs. These rules are defined online
through the CMEM Rule Definition facility.
Multiple rules can be defined in a table (member) in a standard partitioned data set
(library). Related rules are usually defined in the same table. Multiple tables can be
defined in a library, and multiple CMEM rule libraries can be defined.
Types of Events Managed by CMEM
The CMEM facility handles the following events. These can be specified in ON
statements in the rule:
Table 210 Events handled by CMEM
Event Description
DSNEVENT Data set disposition, such as cataloged, deleted or kept, during
step termination or dynamic decollation, or the occurrence of a
NOT CATLGD 2 event, when a data set name is created in a
job step but not cataloged because its name already exists in
the MVS catalog. Specified in an ON DSNEVENT statement in
the rule.
JOBARRIV Arrival of a job on the JES spool from any source.
Examples are:
s jobs submitted by a TSO user or by CICS
s jobs received over an NJE network
Specified in an ON JOBARRIV statement in the rule.
JOBEND Completion of a job regardless of its source. Specified in an
ON JOBEND statement in the rule.
STEP Termination of a job step. Specified in an ON STEP statement
in the rule.
Overview
Chapter 4 CONTROL-M Event Manager (CMEM) 667
Types of Actions That CMEM Can Perform
Any combination of the following actions can be performed when the specified event
occurs. They are specified in DO statements in the rule:
s add or delete a prerequisite condition
Prerequisite conditions can be added to or deleted from the IOA Conditions file.
This may trigger the submission of jobs in the Active Jobs file. Specified in a DO
COND statement in the rule.
s force a job or table
A CONTROL-M scheduling table or individual job can be forced (that is, ordered
to the Active Jobs file regardless of its basic scheduling criteria). Specified in a DO
FORCEJOB statement in the rule.
Jobs can be forced for one of the following reasons:
to start a new process in CONTROL-M (that is, new job submission)
to enable CONTROL-M to assume full control of an externally submitted job
that triggers the event; these jobs are referred to as On Spool jobs, discussed
under On Spool Jobs on page 669.
s stop the job in which the event occurs
At the end of the current job step, terminate the job in which the event occurred.
Specified in a DO STOPJOB statement in the rule.
The following actions can be defined if CONTROL-O is installed:
s invoke a CONTROL-O rule
CONTROL-O rules can be invoked within the current rule. Specified in a DO
RULE statement in the rule.
s send a message
Messages can be sent to specified locations through the CONTROL-O Shout
facility. Specified in a DO SHOUT statement in the rule.
Overview
668 CONTROL-M for OS/390 and z/OS User Guide
CMEM Rule Ordering, Triggering and Deactivation
CMEM tables, along with their rules, are usually ordered (loaded to memory) when
CMEM is started. They can also be refreshed or loaded by an operator command, or
manually using the FORCE option in the CMEM Table List screen.
Once a CMEM rule has been loaded in memory, the occurrence of the events
specified in its ON statements trigger the rule. All DO statements in the rule are then
performed.
More than one rule can be triggered by the occurrence of an event. An event triggers
each rule whose ON statement matches the event.
Generally, all actions from all triggered rules are performed.
The one exception occurs when multiple rules are triggered by the same job arrival
event and each of the triggered rules contains DO FORCEJOB statements. In this case,
the DO FORCEJOB statements of the first triggered rule are performed, but the DO
FORCEJOB statements of the other rules triggered by the event are not performed.
For more information, see On Spool Jobs on page 669.
CMEM rules remain activated, that is, they remain in memory, until they are
overridden by the reloading of the rule table or deleted by an operator command.
CMEM AutoEdit Variables
The CMEM facility supports its own set of AutoEdit variables. No other AutoEdit
variables can be used by the CMEM facility. Furthermore, in CONTROL-M, these
variables can only be specified in CMEM rules, not in job scheduling definitions or
JCL.
CMEM AutoEdit variables are resolved upon triggering of the rule. Available CMEM
AutoEdit variables are:
Table 211 CMEM AutoEdit Variables (Part 1 of 2)
Variable Description
%%$Dn nth qualifier of the data set name. For example, if the data set
name is AAA.BBB.CCC, %%$D2 resolves to BBB. Valid only
for rules containing an ON DSNEVENT statement.
%%$DSN Name of the data set handled by the rule. Valid only for rules
containing an ON DSNEVENT statement.
Overview
Chapter 4 CONTROL-M Event Manager (CMEM) 669
On Spool Jobs
On Spool jobs are jobs or started tasks that are submitted externally to CONTROL-M,
such as jobs submitted by TSO users or CICS, or jobs received over the NJE network,
but are brought under the control of the CONTROL-M monitor using a CMEM rule.
The CMEM rule that causes a job to be an On Spool job, that is, a CMEM rule that
brings the external job under the control of the CONTROL-M monitor, must be an
ON JOBARRIV rule with a DO FORCEJOB statement. To inform CONTROL-M that
this is an On Spool job and not a regular FORCEJOB request, the job scheduling
definition forced by the DO FORCEJOB must match the arriving job, as described
below.
CONTROL-M controls the entire life cycle of the job, from determining when to
execute the job to performing job post-processing, according to the forced job
scheduling definition.
CONTROL-M processes On Spool jobs slightly differently than it processes regular
jobs. CONTROL-M does not submit the job because the job has already been
submitted. Instead, CONTROL-M releases the job (if held) when the runtime
scheduling criteria are met.
%%$DSNDISP Disposition of the data set handled by the rule. Valid only for
rules containing an ON DSNEVENT statement.
Possible values are:
s C cataloged
s D deleted
s K kept
s N NOT CATLG2
s R retained
s S scratched
s U uncataloged
%%$JNAME Job name. Valid in rules for all types of events.
%%$SABEND System abend code of the step whose termination triggered
the rule.
%%$STEPCC Completion code of the step whose termination triggered the
rule.
%%$UABEND User abend code of the step whose termination triggered the
rule.
Table 211 CMEM AutoEdit Variables (Part 2 of 2)
Variable Description
Overview
670 CONTROL-M for OS/390 and z/OS User Guide
Once the job starts execution, whether the job previously required releasing or not, it
is controlled by CONTROL-M in the same way that CONTROL-M controls regular
jobs. CONTROL-M waits for the job to finish, reads its sysout, and performs all
post-processing actions defined in the job scheduling definition.
Creating On Spool Jobs
The following components are necessary to create On Spool jobs:
1. job on spool
2. CMEM rule
3. job scheduling definition
Below is a detailed explanation of what must be defined for each of the above
components to create an On Spool job.
Job On Spool
The job must have the following characteristics:
s The job must be submitted with TYPRUN=HOLD to delay its execution and
permit CONTROL-M to determine when to run the job.
s The MSGCLASS sysout of the job:
for JES3 users: must be equal to the CONTROL-M SYSOUT held class
for JES2 users: can be any held SYSOUT class
This enables CONTROL-M to read the job sysout and perform post-processing
according to the job scheduling definition.
CMEM Rule
The CMEM rule definition must contain the following:
s ON JOBARRIV/ JOBEND statement
The job name specified in the ON JOBARRIV/ JOBEND statement in this rule must
match the name of the job to be monitored. It can be a full job name, or it can be a
mask if a group of jobs is to be monitored. For more information, see ON
JOBARRIV: Event Parameter on page 716.
Overview
Chapter 4 CONTROL-M Event Manager (CMEM) 671
s DO FORCEJOB statement
The first DO FORCEJOB statement in the rule must force a matching job
scheduling definition, described immediately below. For more information, see
DO FORCEJOB: Action Parameter on page 690.
Job Scheduling Definition
The job scheduling definition must have the following characteristics:
s The job scheduling definition must be forced by the first DO FORCEJOB statement
in the CMEM rule.
s The MEMNAME value in the job scheduling definition must match the name of
the external job. A mask can be specified in the MEMNAME field if the same job
scheduling definition is used for more than one job.
s Appropriate runtime scheduling criteria for the job must be defined in the job
scheduling definition. This enables CONTROL-M to control the execution of the
job, that is, when the job must be run.
s Desired post-processing actions must be defined in the job scheduling definition.
Handling On Spool Jobs
On Spool jobs are handled as follows:
s When the job arrival event occurs, CONTROL-M forces the requested table or job.
If the MEMNAME value in the requested table or job does not match the name of
the arriving job, the table or job is forced and processed regularly by CONTROL-M
(a job is submitted when its runtime scheduling criteria are met, and so on).
NOTE
CONTROL-O users are advised that message rules triggered by $HASP395 (under
JES2) or IEF404I (under JES3) are treated the same as JOBEND rules.
Overview
672 CONTROL-M for OS/390 and z/OS User Guide
If the MEMNAME value in the requested table or job matches the name of the
arriving job, the job becomes an On Spool job and CONTROL-M performs the
following actions:
replaces the MEMNAME mask (if a mask was specified in MEMNAME) with
the name of the arriving job
assigns the job ID of the job that triggered the event to the forced job
forces the job; for details and exceptions see On Spool Job Scheduling
Definition Considerations on page 672
The forced job appears in the Active Environment screen with status WAIT
SCHEDULE ON SPOOL.
s CONTROL-M starts processing the forced job when all runtime scheduling criteria
defined in the job scheduling definition are satisfied. If there are no runtime
scheduling criteria in the job scheduling definition, CONTROL-M starts processing
the job immediately.
s CONTROL-M looks for the job in the spool, to release it, if required.
If the external job is waiting for execution in HELD state, that is, if the job arrives
on spool with TYPRUN=HOLD, CONTROL-M releases it for execution.
Otherwise, CONTROL-M verifies that the job is still in the spool (waiting for
execution, executing or ended) before deciding to perform post-processing.
s CONTROL-M waits for the job to finish execution, reads its SYSOUT, analyzes the
execution results and performs all the post-processing actions defined in the job
scheduling definition.
On Spool Job Scheduling Definition Considerations
Job Forcing Considerations
Only one On Spool job can be created in response to a job arrival event. However, in
several cases, multiple DO FORCEJOB actions might match the arriving job. Each of
these cases and the job forcing logic applied to them, to prevent multiple On Spool
processes for the same external job, are described below.
NOTE
CONTROL-M can only handle NJE jobs as On Spool jobs when they originate on the
same NJE node as that on which CONTROL-M is running.
Overview
Chapter 4 CONTROL-M Event Manager (CMEM) 673
s The job arrival rule contains multiple DO FORCEJOB requests. Each might match
the arriving job. In this case, job forcing logic is as follows.
The On Spool process, the match between the external job name and MEMNAME,
is performed for the first DO FORCEJOB in the first matching job arrival rule only:
If a match is found, the job is an On Spool job.
If a match is not found, the job is not an On Spool job, even if subsequent DO
FORCEJOB actions might match.
In either case, all subsequent DO FORCEJOB statements in the same rule (if they
exist) are handled normally, that is, not as forcing On Spool jobs.
s The DO FORCEJOB forces a table in which more than one MEMNAME matches
the arriving job. In this case, job forcing logic is as follows.
If a table containing more than one job is forced, by the first DO FORCEJOB
statement in the rule, as described above, the first matching job causes the job to be
an On Spool job. All the other jobs in the table are forced as regular CONTROL-M
jobs, even if they match the job name of the external job.
s Multiple job arrival rules are triggered by the same job arrival event, and each rule
contains one or more DO FORCEJOB statements that might match the arriving job.
In this case, job forcing logic is as follows.
Only the DO FORCEJOB statements from the first triggered rule are executed, as
described above. DO FORCEJOB from all other triggered job arrival rules are
ignored.
JCL Management Considerations
When defining JCL, the following issues must be considered:
s Any attempt to rerun the job, that is, as a cyclic job, by a DO RERUN statement, or
by a manual rerun request, might fail if the JCL of the job is not found in the library
specified in the MEMLIB parameter of the job scheduling definition.
NOTE
If an On Spool job was purged from the spool but still remains in the Active Jobs file,
and another job with the same name arrives on spool and is assigned the same job ID,
that later job is not forced.
Overview
674 CONTROL-M for OS/390 and z/OS User Guide
s If the job is not submitted with TYPRUN=HOLD, CONTROL-M cannot determine
when the job runs, even if runtime scheduling criteria are defined. In this case, the
job might start executing before all the runtime scheduling criteria are satisfied.
Post-processing, however, is not performed by CONTROL-M until the runtime
scheduling criteria are satisfied.
s Since On Spool jobs are not submitted by CONTROL-M
The JCL of the On Spool job cannot contain AutoEdit statements, and SETVAR
statements in the job definition are ignored. This is because the job is not
submitted by CONTROL-M.
Because the job is not submitted by CONTROL-M, the following job scheduling
definition parameters are ignored:
s SCHENV
s SYSTEM ID
s NJE NODE
NJE enhanced tracking support is inoperative
Support for ON DSNEVENT and ON STEP
A DSNEVENT occurs when a file is deallocated, on the happening of one of the
following events:
s the dynamic deallocation of a file
s deallocation of a file on the termination of a job STEP
s deallocation of a file on the termination of a job
A STEP event occurs when a step ends.
To support the ON DSNEVENT and ON STEP parameters, CMEM intercepts the
messages written by JES2 or JES3 to JESYSMSG. JESYSMSG is the third SYSOUT of
the job.
Overview
Chapter 4 CONTROL-M Event Manager (CMEM) 675
The DSNEVENT process consists of the following parts:
1. When a job, or STC, or TSO user session starts, the system issues either the IEF403I
message or the IEF125I message. CMEM intercepts this message, and checks
whether there is at least one ON DSNEVENT or ON STEP rule for the job. If there
is at least one rule for the job, CMEM creates the DSNEVENT environment in the
address space.
2. CMEM intercepts allocation, deallocation, and step termination messages, and
determines whether there is at least one ON DSEVENT or ON STEP event. If so,
CMEM determines
s whether the DSNEVENT or STEP events fulfil the selection criteria in the rule
s whether, in the case of a DSNEVENT, the file is a new file or already exists
3. CMEM triggers the rule according to the following principles:
A. An ON STEP rule is always triggered when a STEP ends. However, a STEP is
ignored when a rule is not executed due to one of the following:
s a JCL error
s failure to encounter a previous step condition code
B. An ON DSNEVENT can occur when a deallocation message is written, or when
a step terminates. Whether it occurs depends on
s how the file is deallocated
s the setting of the STEPRC field in the DSNEVENT criteria, as follows:
If the value of STEPRC is null, the rule is triggered at the time of deallocation.
If the value of STEPRC is other than null, the rule is rechecked at the
termination of the step to ascertain the STEPRC criteria.
C. Deallocation occurs when
s the file is dynamically deallocated
s the step ends, in the case of all allocated files in this step, whether the files
were allocated by JCL or were dynamically allocated
s the job terminates, in the case of any file that was not released on step
termination, for example, if DISP is set to PASS
NOTE
A job can only be handled by one CMEM. Therefore, in an environment where more
than one CMEM can be active, for example, TEST and production, you must be
accurate in defining the ON DSEVENT.
Overview
676 CONTROL-M for OS/390 and z/OS User Guide
For CMEM actions to be triggered in this way, the following conditions must be
satisfied:
s Either the IEF403I message or the IEF125I message must appear in the job log.
s The job, STC, or TSO user session must have its MSGLEVEL set to (x,1), to ensure
that allocation, deallocation and step termination messages are written to the
JESYSMSG. It is not sufficient for these messages to appear only in the system log
or job log.
s At least one ON DSNEVENT or ON STEP rule must be ordered and ready before
the job, STC, or TSO user session starts.
Regular Allocation and Deallocation
In the case of regular files, meaning files not managed by SMS, CMEM traps the
following deallocation messages:
s IEF283I
s IEF285I
s IEF287I
SMS Support
In the case of SMS-managed data sets, CMEM traps the IGD101I and IGD104I
allocation and deallocation messages, and determines whether the file is new
according to the following rules:
s If both messages are issued, the file is new.
s If the IGD101I message is not found, CMEM treats the file as not new.
NOTE
If the value of ON DSNEVENT is * (asterisk), every job, STC, or TSO user session is
within the DSNEVENT environment. BMC Software recommends that you do not
use this type of DSNEVENT because of
s the overhead that results from CMEM analyzing every message written to the
JESYSMSG
s the CMEM limitation that only one CMEM can handle a DSNEVENT for a job
In an environment where more than one CMEM is active on the same system, this
definition may cause the wrong CMEM to trap the event.
Overview
Chapter 4 CONTROL-M Event Manager (CMEM) 677
Generation Data Sets (GDG)
For CMEM to support Generation Data Sets (GDG), the following messages must be
found:
s IGD105I
s IGD107I
s IGD108I
s IGD17101
CMEM Support for FTP
CMEM actions can be triggered by the transfer of files by FTP products.
In order to enable CMEM rules to be triggered by such file transfers, do the following:
1. Use one of the following methods to insert the expression MSGLEVEL=( 1, 1) in
the STC of the FTP product:
s Customize the JESxPARM member in the SYS1.PARMLIB library.
s Modify the job statement in the PROCLIB library member that contains the
procedure JCL for the STC of the FTP product.
2. Start the CMEM monitor with at least one DSNEVENT rule that refers to the STC
of the FTP product. You can use a dummy DSNEVENT rule that forces CMEM to
monitor the STC of the FTP product.
3. Start the FTP product.
4. Modify existing rules, or order new rules (or do both). Rules that have been
modified or ordered before a file reaches the FTP server are applied to all files
subsequently transferred by the FTP product.
CMEM triggers rules when the requirements of an ON DSNEVENT statement are
satisfied. If an FTP product fails to transmit a data set and issues a message relating to
this failure, CMEM cannot react to that message. However, you can use CMEM rules
to react to FTP product messages.
NOTE
The messages that are required by CMEM for the purposes of this and the preceding
sections are liable to be changed as a result of IBM changes in data set processing.
Overview
678 CONTROL-M for OS/390 and z/OS User Guide
CMEM Support for IBM FTP
The IBM FTP process is executed under the OMVS address space, which is BPXAS.
BPXAS address spaces do not usually write messages to the JESYSMSG.
In order to enable CMEM DSNEVENT support for IBM FTP, the following occurs:
1. When the CMEM monitor starts, it activates the OpenEdition interface for
processes in the BPXAS. Having done this, CMEM issues the following messages:
CTO782I SUBSYSTEM REGI STERED WI TH OPENEDI TI ON I NTERFACE
CTO783I I NI TI ALI ZATI ON OF OPENEDI TI ON ENVI RONMENT ENDED
SUCCESSFULLY
When CMEM initialization is complete, the CTO147I message is displayed. After
this, CMEM gets control every time that an OpenEdition process starts in the
BPXAS address space.
2. When a new process starts in the BPXAS, the interface routine issues the CTO403I
pseudo-message. This pseudo-message causes CMEM to simulate IEF403I
processing, which is described in Support for ON DSNEVENT and ON STEP on
page 4-674.
3. Under z/ OS, IBM FTP functions as a UNIX process running under z/ OS.
Therefore it follows the UNIX standard, one aspect of which is that the name of the
job is set to the user ID of the person who issued the FTP request. This UNIX
standard creates a problem, because the operator who writes the CMEM rule must
know at that stage which user will issue an FTP request.
The solution to this problem is to use the statement ON DSNEVENT FTP* . The
result is that any FTP process will trigger the rule.
NOTE
Do not use the STEPRC subparameter in conjunction with the FTP* setting for ON
DSNEVENT, because the same FTP procedure can serve many requests before being
terminated.
NOTE
Do not use the STEPRC subparameter in conjunction with the FTP* setting for ON
DSNEVENT, because the same FTP procedure can serve many requests before being
terminated.
Rule Parameters Summary
Chapter 4 CONTROL-M Event Manager (CMEM) 679
Rule Parameters Summary
Figure 304 CMEM Rule Definition Screen
The parameters of the CMEM Rule Definition screen are divided into the following
categories:
s Event Selection Parameters
s General Parameters
s Action Parameters
A brief summary of the parameters in each category is provided on the following
pages. This is followed by a detailed description of each parameter in alphabetical
order.
Event Selection Parameters
The following parameters identify the events that trigger the rule.
RL: JOBNAM1 LI B CTM. PROD. RULES TABLE: CMEMRULE
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = JOBNAM1 JTYPE SMFI D SYSTEM And/ Or / Not
OWNER CTMCTLM GROUP MODE PROD RUNTSEC NONE
THRESHOLD
DESCRI PTI ON CONVERSI ON: ON JOB JOBNAM1 ARRI VAL FORCEJOB
DESCRI PTI ON
===========================================================================
DO FORCEJOB = TABLE TABLE1 JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====









FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
Rule Parameters Summary
680 CONTROL-M for OS/390 and z/OS User Guide
Subparameters of these parameters are described in the detailed description of each
parameter later in this chapter.
General Parameters
The following parameters contain general information about the rule.
Table 212 CMEM Event Selection Parameters
Parameter Description
ON statement Event criteria that must be satisfied for the rule to be triggered.
Subparameters may be displayed. Valid ON statements are:
s ON DSNEVENT name (or mask) of the job to be
monitored for data set or NCT2 events
s ON JOBARRIV job name (or mask) of a job or started task
that arrived on the JES spool from any source
s ON JOBEND job name (or mask) of a job or started task
that terminated
s ON STEP job step whose termination is to be monitored
for a specified return code or status
Table 213 CMEM General Parameters
Parameter Description
OWNER ID of user who requests CMEM services
GROUP Name of a group of rules
MODE CMEM rule operation mode
RUNTSEC Type of runtime security checks to be performed for the rule
DESCRIPTION Free-text description of the rule definition
Rule Parameters Summary
Chapter 4 CONTROL-M Event Manager (CMEM) 681
Action Parameters
The following parameters (DO statements) specify actions to be performed.
Table 214 CMEM Action Parameters
Parameter Description
DO statement Action to be performed when the rule is triggered.
Subparameters may be displayed. Valid DO statements are:
s DO COND add or delete a prerequisite condition
s DO FORCEJOB force a job order under CONTROL-M
s DO STOPJOB stop execution of the remaining steps of
the job that triggered the rule
The following actions can be defined if CONTROL-O is
installed:
s DO RULE invoke a CONTROL-O rule from within the
current rule
s DO SHOUT issue a message to a specified destination
using the Shout facility
Parameter Descriptions
682 CONTROL-M for OS/390 and z/OS User Guide
Parameter Descriptions
The following pages contain detailed descriptions of all parameters available in the
CMEM Rule Definition screen. Parameters are arranged in alphabetical order. Within
each parameter, subparameters are arranged according to the order of the fields on
the screen.
Each parameter begins on a new page, including:
s a brief explanation of the purpose of the parameter
s the format required for defining the parameter within an extract of the CMEM
screen
s general information explaining the parameter and its usage
s where applicable, some practical examples illustrating implementation of the
parameter
For more information on the CMEM Rule Definition facility, see Chapter 2, Online
Facilities.
DESCRIPTION: General Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 683
DESCRIPTION: General Parameter
Description of the rule to be displayed in the Rule List screen.
Figure 305 DESCRIPTION Parameter Format

Optional. The DESCRIPTION parameter consists of one or more lines that can
contain free text. Each line is 61 characters in length. Upon typing text in a
DESCRIPTION line and pressing Enter, a new DESCRIPTION line is opened.
General Information
The DESCRIPTION parameter does not affect rule processing. The text entered in the
first DESCRIPTION line appears to the right of the rule name in the Rule List screen.
It is intended to let the user know at a glance the purpose of, or some other key
information about, the rule. The text can be typed in any language.
DESCRIPTION: General Parameter
684 CONTROL-M for OS/390 and z/OS User Guide
Example
The description START THE BATCH SHIFT appears next to the rule name in the Rule
List screen.
Figure 306 DESCRIPTION Parameter Example
RL: CI CSPROD LI B CTM. PROD. RULES TABLE: STCS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBEND = CI CSPROD JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON START THE BATCH SHI FT
DESCRI PTI ON
===========================================================================
/ * I NFORM CONTROL- M THAT THE BATCH CAN BE STARTED
DO COND = START- BATCH ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====









FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
DO statement: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 685
DO statement: Action Parameter
Actions to perform when the rule is triggered.
Figure 307 DO Parameter Format

At least one DO statement must be specified in each rule. Specify DO statements as
follows:
s Type the action keyword (such as COND) in the DO field and press Enter.
s When required, subparameter fields are displayed. Fill in the subparameters and
press Enter again.
Multiple DO statements can be specified. After entering a DO statement, another DO
line is automatically displayed. Multiple DO statements have an AND relationship
and are performed sequentially.
The following are valid DO actions. Each is discussed individually in this chapter.
Table 215 DO Parameter Actions
Action Description
DO COND Adds and/ or deletes one or more prerequisite conditions
DO FORCEJOB Forces a job
DO STOPJOB Stops execution of the job that triggered the rule, at the end of
the current step
If CONTROL-O is installed:
DO RULE Invokes a CONTROL-O rule
DO SHOUT Sends a message to a specified destination
DO COND: Action Parameter
686 CONTROL-M for OS/390 and z/OS User Guide
DO COND: Action Parameter
Add or delete prerequisite conditions.
Figure 308 DO COND Parameter Format

Optional. Type the word COND (or its abbreviation CON) in the DO field and press
Enter. The following subparameters are displayed:
Table 216 DO COND Subparameters (Part 1 of 2)
Subparameter Description
condition User-supplied, descriptive name of 1 through 20 characters
used to identify the condition. Only trailing blanks are
permitted
dateref 4-character date reference associated with the condition.
Valid values are:
s date specific date, in mmdd or ddmm format, depending
on the site standard
s ODAT resolves to the current installation working date
Default.
s DATE resolves to the current system date
s STAT static
Indicates that the condition, such as IMS-ACTIVE, is not
date-dependent
Note: Before STAT was introduced, date 0101 was
recommended to be used in conditions that were not
date-dependent. Unlike 0101, STAT is not a date, and it
operates differently. Always use STAT when defining
conditions that are not date-dependent.
s **** / $$$$ all dates
Valid only for deleting prerequisite conditions. Either
value (**** or $$$$) results in the deletion of all matching
prerequisite conditions regardless of date.
DO COND: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 687
General Information
When a rule containing a DO COND statement is triggered, the designated
prerequisite conditions are added or deleted (as specified) from the IOA Conditions
file by the CONTROL-M monitor.
A prerequisite condition can define any user-specified situation. The following are a
few examples of prerequisite conditions:
Prerequisite conditions created or deleted by the DO COND parameter can activate
or deactivate CONTROL-O rules, or trigger (or stop) the execution of processes (jobs,
and so on) in CONTROL-M, CONTROL-D and other environments.
CMEM AutoEdit System variable %%$JNAME and, for ON DSNEVENT events,
variables %%$Dx, %%$DSN, or %%$DSNDISP can be specified in condition names in
DO COND statements and are replaced (resolved) at time of rule triggering. For more
information, see CMEM AutoEdit Variables on page 668.
Representative dates (such as ODAT) are resolved to the actual corresponding date in
the site-standard format.
cond_opt Indicator of whether to add or delete the prerequisite
condition. Valid values are:
s + add the prerequisite condition
s - delete the prerequisite condition
I MS- ACTI VE
WEEKEND
SALARY- OK
NOTE
Long condition names cannot be used in CMEM rule definitions.
Table 216 DO COND Subparameters (Part 2 of 2)
Subparameter Description
DO COND: Action Parameter
688 CONTROL-M for OS/390 and z/OS User Guide
Example
Example 1
When job CICSPROD ends, this rule sets the condition necessary for the batch shift to
begin.
Figure 309 DO COND Parameter Example 1
RL: CI CSPROD LI B CTM. PROD. RULES TABLE: STCS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBEND = CI CSPROD JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON START THE BATCH SHI FT
DESCRI PTI ON
===========================================================================
/ * I NFORM CONTROL- M THAT THE BATCH CAN BE STARTED
DO COND = START- BATCH ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====









FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
DO COND: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 689
Example 2
When a data set with name prefix TRAN arrives by file transfer product CONNECT
DIRECT (formerly called NDM), add prerequisite condition FILE-RECEIVED to
notify CONTROL-M that the data set was received.
Figure 310 DO COND Parameter Example 2
RL: NDM LI B CTM. PROD. RULES TABLE: MGT
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON DSNEVENT = NDM JTYPE SMFI D SYSTEM
DSN TRAN. * DI SP CATLG
PROCSTEP PGMSTEP STEPRC OK And/ Or / Not
OWNER ADMI N GROUP NDM MODE RUNTSEC
THRESHOLD
DESCRI PTI ON NOTI FY CONTROL- M THAT TRAN DATASET ARRI VED VI A NDM
DESCRI PTI ON
===========================================================================
DO COND = FI LE- RECEI VED ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====








FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
DO FORCEJOB: Action Parameter
690 CONTROL-M for OS/390 and z/OS User Guide
DO FORCEJOB: Action Parameter
Force a job.
Figure 311 DO FORCEJOB Parameter Format

Optional. Type the word FORCEJOB (or its abbreviation F) in the DO field and press
Enter. The following subparameters are displayed:
General Information
DO FORCEJOB places a job order in the CONTROL-M Active Jobs file, even if the
basic scheduling criteria of the job are not satisfied. For more information, see Job
Ordering and Job Forcing on page 66.
Table 217 DO FORCEJOB Subparameters
Subparameter Description
TABLE Name of a scheduling table, up to eight characters. Mandatory.
JOB Name of the job to be triggered. Optional. If blank, all jobs in the
table are forced.
If AutoEdit System variable %%$JNAME is specified, it resolves
to the name of the job that triggered the rule.
DATE Scheduling date of the job.
Valid values are:
s date specific 6-digit date, in format mmddyy, ddmmyy, or
yymmdd, depending on the site standard
s ODAT resolves to the current installation working date
Default.
s DATE resolves to the current system date
LIBRARY Name of the scheduling library containing the specified table.
Mandatory.
DO FORCEJOB: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 691
The DO FORCEJOB statement in CMEM enables CONTROL-M to order
CONTROL-M scheduling tables based on the occurrence of an event, for example, job
arrival, job end, data set event, or step event.
The DO FORCEJOB statement is executed by the CONTROL-M monitor.
If the CONTROL-M monitor is not active, the DO FORCEJOB request is queued and
performed when the CONTROL-M monitor becomes active.
DO FORCEJOB logic works differently for job arrival events than for job end, data set
or step events:
Job End Events
DO FORCEJOB statements specified in a job end event rule are performed only if the
terminating job is not under CONTROL-M.
Data set or Step Events
Data data setset or step event rules are performed regardless of where the job was
submitted.
Job Arrival Events
For the first DO FORCEJOB statement in a rule:
s If the job that triggered the job arrival event was submitted by CONTROL-M, the
DO FORCEJOB statement is ignored.
s If the job that triggered the job arrival event was not submitted by CONTROL-M,
CONTROL-M forces the requested table or job. CONTROL-M scans the forced
table looking for a job whose MEMNAME value matches, or is a mask for, the
name of the job whose arrival triggered the rule.
If a matching job is found, it becomes an On Spool job. For more information,
see Creating On Spool Jobs on page 670.
If a matching job is not found, or more than one job is ordered, all other jobs are
not On Spool jobs, and are processed normally by CONTROL-M.
For other DO FORCEJOB statements in the same rule:
s DO FORCEJOB is performed regardless of the source of the job.
s The table is forced.
DO FORCEJOB: Action Parameter
692 CONTROL-M for OS/390 and z/OS User Guide
DO FORCEJOB is not executed if a preceding ON JOBARRIV rule with a DO
FORCEJOB action was already executed for this event.
Examples
Example 1
Control all jobs not submitted by CONTROL-M.
Figure 312 DO FORCEJOB Example 1
Scheduling table ANYJOB must contain at least one job scheduling definition.
NOTE
When a DO FORCEJOB request fails because the scheduling table is in use,
CONTROL-M may try again to execute the job, depending on the values set for the
FORCE#RT and FORCE#WI installation parameters. For more information on the
FORCE#RT and FORCE#WI installation parameters, see the customization chapter of
the INCONTROL for OS/390 and z/OS Installation Guide.
RL: * LI B CTM. PROD. RULES TABLE: JOBS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = * JTYPE J SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP EXTJOBS MODE RUNTSEC
THRESHOLD
DESCRI PTI ON CONTROL ALL JOBS NOT SUBMI TTED BY CONTROL- M
DESCRI PTI ON
==========================================================================
DO FORCEJOB = TABLE ANYJOB JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
DO
==========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====









FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
DO FORCEJOB: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 693
Example 2
Control all jobs submitted by CICS. These fall into the following groups: Jobs whose
name starts with A and jobs whose name starts with C.
Figure 313 DO FORCEJOB Example 2
Scheduling table CICSJOB must contain at least two job scheduling definitions:
s One must contain a MEMNAME value beginning with A.
s Another must contain a MEMNAME value beginning with B.
RL: A* LI B CTM. PROD. RULES TABLE: JOBS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = A* JTYPE J SMFI D SYSTEM And/ Or / Not O
ON JOBARRI V = C* JTYPE J SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE RUNTSEC
THRESHOLD
DESCRI PTI ON CONTROL ALL JOBS SUBMI TTED BY CI CS ( BEGI NNI NG WI TH A* OR C* )
DESCRI PTI ON
===========================================================================
DO FORCEJOB = TABLE CI CSJOB JOB %%$JNAME DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====








FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
DO RULE: Action Parameter
694 CONTROL-M for OS/390 and z/OS User Guide
DO RULE: Action Parameter
Invoke a CONTROL-O rule from within the current rule. Available only if
CONTROL-O is installed.
Figure 314 DO RULE Parameter Format

Optional. Type the word RULE (or its abbreviation RU) in the DO field and press
Enter. The following subparameters are displayed:
Table 218 DO RULE Subparameters
Subparameter Description
rulename Name of the CONTROL-O rule to be executed. A maximum of
eight characters can be entered.
Note: The rule to be executed must contain an ON RULE
statement with the same rule name specified in this parameter.
args Optional input and output arguments to be passed to the rule
can be specified, following the rulename and separated from it
by a blank. Arguments must be valid AutoEdit expressions
separated by commas. An unlimited number of arguments can
be specified. However, the combined length of the rulename
and arguments cannot exceed 45 characters.
OWNER Value of the OWNER field in the invoked rule. This
subparameter is used for security purposes. Optional.
TABLE Name of the CONTROL-O rule table in which the invoked
rule resides. When ALL is entered, it implies that the invoked
rule may reside in any rule table. If a table name is not entered,
the current rule table is assumed by default.
LIBRARY Name of the CONTROL-O rule table library where the
invoked rule resides. When ALL is entered, it implies that the
invoked rule may reside in any rule table library. If a library
name is not specified, the current rule table library is assumed
by default.
DO RULE: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 695
General Information
To define a DO RULE statement in a CMEM rule, and to access a CMEM rule
containing a DO RULE statement, CONTROL-O must be installed.
When a DO RULE statement is encountered during rule processing, CONTROL-O
invokes the specified rule. When processing of the invoked rule is completed,
processing continues sequentially from the point after the DO RULE statement in the
initial (calling) rule.
When a DO RULE statement is executed, the specified rule is searched for among the
loaded rules according to the specified rule name, table, library, and owner. If the rule
is found but is not active, for example, if the runtime scheduling criteria are not
satisfied, the invoked rule is not executed and the calling rule continues execution
with the next DO statement.
The CMEM calling rule can pass an argument string as input to the called rule. This
argument string can contain CMEM AutoEdit expressions that are resolved at time of
rule execution. The argument string can be accessed by the called rule through
CONTROL-O System variable %%$ARGS. If a called rule calls another CONTROL-O
rule, the %%$ARGS values passed in the earlier call are overwritten by the
%%$ARGS values passed by the later call. For information about the AutoEdit facility
in CONTROL-O, see the CONTROL-O User Guide.
A CONTROL-O rule specified with an ON RULE statement can be invoked any
number of times by DO RULE calls.
A called CONTROL-O rule can invoke other CONTROL-O rules using DO RULE
statements. Nesting of DO RULE calls, for example, rule 1 calls rule 2, that calls rule 3,
up to 20 deep is supported. A CONTROL-O rule can be called recursively.
NOTE
To order a CMEM rule containing a DO RULE statement and to invoke the
CONTROL-O rule specified in the CMEM DO RULE statement, CONTROL-O must
be active.
DO RULE: Action Parameter
696 CONTROL-M for OS/390 and z/OS User Guide
Example
When a data set named PROD.TRAN.* is cataloged by TCPIP, invoke a CONTROL-O
rule that starts a task to process it.
Figure 315 DO RULE Example
RL: TCPI P LI B CTM. PROD. RULES TABLE: TRANS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON DSNEVENT = TCPI P JTYPE SMFI D SYSTEM
DSN PROD. TRAN. * DI SP CATLG
PROCSTEP PGMSTEP STEPRC OK And/ Or / Not
OWNER ADMI N GROUP TCPI P MODE RUNTSEC
THRESHOLD
DESCRI PTI ON WHEN DATASET PROD. TRAN. * I S CATALOGED BY TCI P,
DESCRI PTI ON START A TASK TO PROCESS I T
DESCRI PTI ON
===========================================================================
/ * START A STARTED TASK TO PROCESS THE RECEI VED FI LE.
/ * WHEN THE DATASET I S CATALOGED, I NVOKE RULE PROCFI LE.
/ * PARAMETERS PASSED ARE THE STC NAME AND THE TI MEOUT VALUE.
DO RULE = PROCFI LE %%$DSN OWNER PROD
TABLE PRODRULE LI BRARY CTO. PROD. RULES
SYSTEM SHARELOC TI MEOUT
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< ======


FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 21. 00. 36
DO SHOUT: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 697
DO SHOUT: Action Parameter
Send (shout) a message to a specific destination. Available only if CONTROL-O is
installed.
Figure 316 DO SHOUT Parameter Format

Optional. Type SHOUT in the DO field and press Enter. The following
subparameters are displayed:
Table 219 DO SHOUT Subparameters (Part 1 of 3)
Subparameter Description
TO Destination of the message (1 through 16 characters).
Mandatory. Valid values are:
s U-userid or USERID-userid Writes the message to the IOA
Log file under the specified user ID. userid must be 1
through 8 characters.
s OPER [dd] [-{rrr | -ccc}] Sends the message to operator
consoles, according to the optional subparameters dd, rrr,
and ccc
dd Descriptor code (from 0 through 16). For more
detailed information regarding descriptor codes, refer to
the IBM publication Routing and Descriptor Codes,
GC38-1102.
rrr Route code (from 0 through 128). For more
detailed information regarding route codes, refer to the
IBM publication Routing and Descriptor Codes,
GC38-1102. Route code and console ID are mutually
exclusive.
-ccc Console ID number (preceded by a hyphen) of the
console to which the message is to be shouted. Console
ID and route code are mutually exclusive.
DO SHOUT: Action Parameter
698 CONTROL-M for OS/390 and z/OS User Guide
TSO - loginid [;Nn | ;Mm | ;NnMm | ;Lname] Sends the
message to the user identified by the specified logon ID.
logonid is mandatory (1 through 7 characters).
An optional second value, indicating the computer and/ or
node (such as Nn) of the TSO logonid, can be entered, as
follows:
Under JES2:
Valid values are: Mm, Nn or NnMm, where:
s m is the machine ID (the computer in JES2, not the
4-character SMF ID). For more information, see the
description of specifying IOA CPU in the discussion of the
customization process in the INCONTROL for OS/390 and
z/OS Installation Guide.
s n is the 1 or 2 character JES/ NJE node ID.
Under JES3:
The only valid value is Lname, where name is the logical JES
name of the machine (that is, the name as used in JES3,
command *T, not the SMF system ID).
For more information, see the description of specifying IOA
CPU in the discussion of the customization process in the
INCONTROL for OS/390 and z/OS Installation Guide.
Note: A shout to a TSO user performs a TSO SEND command
that may require authorization at the receiving node.
s U-M: mail-name-prefix Sends a message by mail to the
recipient identified by mail-name-prefix (1 through 12
characters).
s U-ECS Sends messages to the CONTROL-M/ Enterprise
Manager user. For more information on this feature, see
the section on shouting to CONTROL-M/ Enterprise
Manager in Chapter 3, Job Production Parameters.
URGENCY Determines the priority level of the message. For more
information, see The URGENCY subparameter on page 700.
Valid values are:
s R - Regular. Default.
s U - Urgent.
s V - Very urgent.
Table 219 DO SHOUT Subparameters (Part 2 of 3)
Subparameter Description
DO SHOUT: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 699
General Information
The message is sent to the required destination when the accompanying ON
statement criteria are satisfied.
It is also possible to shout to a ROSCOE user. For additional information, see your
INCONTROL administrator.
Subparameter TO
Type TO=USERID-userid to write the message to the IOA Log under the user ID
specified in the parameter.
Type TO=OPER[dd]-{rrr,-ccc} to send the message to all operator consoles, or to
operator consoles selected according to route code (rrr) or console ID number (-ccc).
The descriptor code (dd) determines the type of message displayed. The dd, rrr, and
-ccc parameters are optional and can be assigned any valid value. Dashes () are used
to separate the parameters specified.
For more detailed information regarding route and descriptor codes, refer to the IBM
publication Routing and Descriptor Codes, GC38-1102.
SYSTEM Name of the system (computer) where the message must be
directed. A name of one to eight alphanumeric characters can
be entered. Mask characters (* and ?) are supported for this
subparameter.
Note: If no SYSTEM value is specified, the message is sent
to the system identified by reserved user-defined variable
%%$COMMSYS in a preceding DO SET statement. For a
description of %%$COMMSYS, see the CONTROL-O User
Guide.
If %%$COMMSYS is not specified, the message is issued on
the current system.
Can be used only when CONTROL-O is installed.
CTO282I Indicates if the message ID is prefixed by CTO282I. Optional.
Valid values are:
s Y (Yes) The message ID is prefixed by CTO282I. Default.
s N (No) The message ID is the first word of the message
text.
MESSAGE Message text. Maximum Length: 60 characters. Mandatory.
Table 219 DO SHOUT Subparameters (Part 3 of 3)
Subparameter Description
DO SHOUT: Action Parameter
700 CONTROL-M for OS/390 and z/OS User Guide
Examples
Type TO=TSO-logonid to send the message to a groupid or logonid. The Shout facility
first searches the IOA Dynamic Destination table for the specified ID. If the table
contains an entry that matches the value, the content of the entry is used as the target
for the shouted message. The entire TO field is used. Therefore, when directing the
message to a remote user, do not append Nn or Mm. Instead, do this in the IOA
Dynamic Destination Table itself. For more information, see the description of
Dynamic Destination Tables in the INCONTROL for OS/390 and z/OS Administrator
Guide.
If no matching ID is found in the Dynamic Destination table, the Shout facility
assumes the specified ID is a logonid. It then creates a TSO message that it hands over
to MVS. MVS then sends the message to that logonid. If the logonid does not exist,
MVS cannot send the message, but no error message is generated. When a second
value is used, the message is sent to the TSO logonid in the specified computer or
node (machine ID). To determine the machine ID under JES2, enter JES command
$LSYS.
The URGENCY subparameter
The URGENCY value indicates the urgency level of the message.
In addition, if the destination is USERID-userid (or U-userid), the user can control,
according to urgency, which messages are displayed when the IOA Log file is
accessed. Urgent and very urgent messages are highlighted on the screen. For more
details, see IOA Log Facility on page 289
Table 220 DO SHOUT OPER Subparameter Examples
Subparameter Description
OPER Send the message to all operator consoles.
OPER2 Send a highlighted unrollable message (descriptor code 2) to
all operator consoles.
OPER-5 Send a message to operator consoles associated with route
code 5.
OPER2-5 Send a highlighted unrollable message to operator consoles
associated with route code 5.
OPER-4 Send a message to operator console ID 04.
OPER2-4 Send a highlighted unrollable message (descriptor code 2) to
operator console ID 04.
DO SHOUT: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 701
The CTO282I Subparameter
By default, the CTO282I subparameter has a value of Y, and CTO282I is placed as the
message ID preceding the message text. When CTO282I is set to N, the first word of
the message text becomes the message ID.
CONTROL-O AutoEdit Variables
CONTROL-O AutoEdit variables embedded in the TO and MSG subparameters are
automatically resolved at time of rule activation. For more information about the
AutoEdit facility, see Chapter 5, JCL and AutoEdit Facility, and Appendix E,
AutoEdit Facility in KSL,
Example
When started task DB2MSTR ends, issue a message to the DBA who is on duty.
Notice the use of the generic TSO user name, that the Dynamic Destination table
interprets to be one or more TSO users.
Figure 317 DO SHOUT Parameter Example
RL: DB2MSTR LI B CTM. PROD. RULES TABLE: STCS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBEND = DB2MSTR JTYPE S SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP DB2 MODE RUNTSEC
THRESHOLD
DESCRI PTI ON WARN DBA THAT DB2 MASTER ENDED
DESCRI PTI ON
===========================================================================
DO SHOUT = TO TSO- DBA URGENCY U SYSTEM CTO282I
MESSAGE DB2 MASTER ENDED - PLEASE CHECK!
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====









FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
DO STOPJOB: Action Parameter
702 CONTROL-M for OS/390 and z/OS User Guide
DO STOPJOB: Action Parameter
Stop execution of the job that triggered the rule after the current step.
Figure 318 DO STOPJOB Parameter Format

Optional. Type STOPJOB, or its abbreviation ST, in the DO field and press Enter.
General Information
When DO STOPJOB is performed, the job that triggered the rule is terminated after
the current step, and no further steps (including those marked COND=EVEN or
COND=ONLY) are executed. An appropriate message is written to the job log. If the
stopped job is controlled by CONTROL-M, it terminates with a status of ENDED
NOTOK.
DO STOPJOB is not executed for TSO users.
DO STOPJOB is meaningful only:
s for data set events or step events
s when there are additional steps in a job or started task
DO STOPJOB: Action Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 703
Example
If the production data set disposition is NOT CATLGD 2, stop the job.
Figure 319 DO STOPJOB Parameter Example
RL: PROD* LI B CTM. PROD. RULES TABLE: JOB
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON DSNEVENT = PROD* JTYPE J SMFI D SYSTEM
DSN PROD. * DI SP NCT2
PROCSTEP PGMSTEP STEPRC And/ Or / Not
OWNER ADMI N GROUP PRODJOBS MODE RUNTSEC
THRESHOLD
DESCRI PTI ON STOP THE JOB ON NCT2 DI SPOSI TI ON
DESCRI PTI ON
===========================================================================
/ * STOP THE JOB
DO STOPJOB
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====







FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
GROUP: General Parameter
704 CONTROL-M for OS/390 and z/OS User Guide
GROUP: General Parameter
Name of the group to which the rule belongs.
Figure 320 GROUP Parameter Format

Optional. Name of 1 through 20 characters, with no embedded blanks.
General Information
The GROUP parameter is used to provide more convenient handling of rules. It
enables retrieval of information on a group basis. The group name appears in all
important IOA Log file messages relating to the rules of the group.
GROUP: General Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 705
Example
The rule that instructs CONTROL-M to start the batch shift when CICSPROD ends
belongs to group CICS.
Figure 321 GROUP Parameter Example
RL: CI CSPROD LI B CTM. PROD. RULES TABLE: STCS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBEND = CI CSPROD JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON START THE BATCH SHI FT
DESCRI PTI ON
===========================================================================
/ * I NFORM CONTROL- M THAT THE BATCH CAN BE STARTED
DO COND = START- BATCH ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====









FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
MODE: General Parameter
706 CONTROL-M for OS/390 and z/OS User Guide
MODE: General Parameter
Rule operation mode.
Figure 322 MODE Parameter Format

Optional. Valid values, and their abbreviations, for the MODE parameter are:
General Information
Test mode provides the opportunity to test the effects of a rule definition without
actually performing the specified DO actions.
Log mode provides a transition between Test and Production mode. Like Production
mode, Log mode enables performance of the specified DO actions. However, Log
mode also records the trace information in the test journal for tracking purposes.
When tracking of the performed actions for test purposes is no longer required, the
rule can be placed in Production mode.
For sites in which CONTROL-O is not installed, or in which the CONTROL-O
Automation Log facility is not active, the trace information is written to the sysout
referenced by DD statement DAACTLOG.
Table 221 MODE Parameter Values
Value Description
PROD (P) Standard Production mode. The rule is processed normally.
Default.
TEST (T) Test mode. Actions are not performed, but are written to a test
journal.
LOG (L) Log mode. The rule is processed normally and all identified
events and actions are written to a test journal.
MODE: General Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 707
For CONTROL-O sites in which the Automation Log facility is active, the trace
information is recorded in the Automation log. For more information, see the
CONTROL-O User Guide.
Example
The rule that instructs CONTROL-M to start the batch shift when CICSPROD ends is
activated in Production mode.
Figure 323 MODE Parameter Example
RL: CI CSPROD LI B CTM. PROD. RULES TABLE: STCS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBEND = CI CSPROD JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE PROD RUNTSEC
DESCRI PTI ON START THE BATCH SHI FT
DESCRI PTI ON
===========================================================================
/ * I NFORM CONTROL- M THAT THE BATCH CAN BE STARTED
DO COND = START- BATCH ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====










FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
ON statement: Event Parameter
708 CONTROL-M for OS/390 and z/OS User Guide
ON statement: Event Parameter
Event selection criteria that trigger performance of the rule.
Figure 324 ON Parameter Format

Mandatory. At least one ON statement must be entered. Type an ON statement, or its
abbreviation, in the ON field and press Enter. Additional subparameters are
displayed.
The following are valid ON statements (and their abbreviations). Each is described in
detail later in this chapter.
The And/ Or/ Not subparameter is always displayed in each specified ON statement.
It is a conjunctional parameter for linking ON statements. Optional.
Entering a value for this subparameter opens a new ON statement and links the
newly opened statement to the current ON statement.
When multiple ON statements are entered, the combinations of ON statements that
can satisfy the selection criteria depend on the And/ Or/ Not values linking those ON
statements. The logic applied to And/ Or/ Not subparameters is described in
General Information, which follows.
Table 222 ON Parameter Statements
Statement Description
ON DSNEVENT
(D)
Name (or mask) of a job, started task, or TSO user to be
monitored for data set events
ON JOBARRIV (JA) Job name (or mask) of a job or started task that arrived on the
JES spool from any source
ON JOBEND (JE) Job name (or mask) of a job or started task that terminated
ON STEP (S) Name (or mask) of a procedure step (and optionally, program
step) to be monitored for termination
ON statement: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 709
Valid values are:
s A (And) indicates AND logic between the two statements
If both ON statements are true, the event criteria are satisfied.
s O (Or) indicates OR logic between the preceding and following ON statements
If either statement is true, the event criteria are satisfied.
s N (Not) indicates AND NOT logic between the two statements
If the prior statement is true and the subsequent statement is false, the event
criteria are satisfied.
General Information
Upon typing an ON parameter and pressing Enter, additional fields (subparameters)
are displayed. Each ON parameter and its subparameters comprise an ON statement.
At least one ON statement is required in a rule definition. Additional ON statements
can be entered using the And/ Or/ Not option.
The first eight characters of the event name appear as the name of the rule in the Rule
List screen.
And/Or/Not Subparameter Logic
The following logic is applied:
s AND and NOT logic are applied before OR logic
s NOT means AND NOT as represented below
s A NOT B is interpreted as A AND (NOT B)
s A OR B AND C is interpreted as A OR (B AND C)
s A AND B OR C NOT D is interpreted as [(A AND B) OR (C AND NOT D)]
Use of OR logic reduces the amount of redundant data in the CMEM rule library and
improves rule management.
ON statement: Event Parameter
710 CONTROL-M for OS/390 and z/OS User Guide
Character Masking
The following mask characters can be used when entering ON statement values:
s * represents any number of characters, including no characters
s ? represents any one character
NOTE
When entering multiple ON statements, ensure that the statements are not mutually
exclusive or not connected by an AND parameter. Rules containing mutually
exclusive ON statements connected by an AND parameter are never triggered. For
example:
ON DSNEVENT JOBA STEPA
AND
ON DSNEVENT JOBA STEPB
ON DSNEVENT: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 711
ON DSNEVENT: Event Parameter
Monitor a data set disposition event.
Figure 325 ON DSNEVENT Parameter Format

Optional. Type D (DSNEVENT) in the ON field and press Enter. The following
subparameters are displayed:
Table 223 DSNEVENT Subparameters (Part 1 of 3)
Subparameter Description
jobname Name (or mask) of the job to be monitored for data set events.
Mandatory.
JTYPE Type of job to be monitored for data set events:
s J (Job) batch job
s S (STC) started task
s T (TSU) TSO user
s blank any type of job; valid only if STEPRC is blank, that
is, the rule is processed immediately upon detection of the
data set event. Default.
If JTYPE is entered, only a data set event occurring in a job of
the specified type can trigger the rule.
SMFID SMF ID of the CPU to monitor for data set events. Mask
characters (*and ?) are supported. Default: current CPU.
SYSTEM Name of the system to monitor for data set events. Mask
characters (*and ?) are supported. Default: current system.
ON DSNEVENT: Event Parameter
712 CONTROL-M for OS/390 and z/OS User Guide
DSN Name of data set (or mask) to be monitored for this event
within the selected jobs. Mandatory.
Valid values are:
s DISP data set disposition
Mandatory. The abbreviation (that is, the first letter) of the
desired value can be entered. Valid values are:
CATLG cataloged (including SMS-managed files and
ROLLED-IN SMS-managed GDG files)
DELETE deleted
UNCATLG uncatalogued
KEEP kept (including SMS-managed files)
RETAIN cataloged or kept
SCRATCH deleted and uncatalogued (SMS managed
files)
ALL any of the above dispositions
NCT2 occurrence of a NOT CATLG 2 event when a
data set was created in a previous job step, but not
cataloged at deallocation because its name already
exists in the MVS catalog
* any of the above data set dispositions (including
NCT2)
PROCSTEP Name or mask of a step invoking a procedure or, for a started
task, task ID. Optional.
If omitted, all procedure steps in the selected jobs are
monitored.
Note: When a started task is initiated, it can be assigned a task
ID. For example, in command S GTF.G, the task ID of GTF is
G. If a task ID is not entered, MVS assigns a default task ID to
the started task, as follows:
s For a system started task with stepname IEFPROC, MVS
sets an internal task ID.
s For other started tasks, the default task ID equals the
procedure (started task) name.
Therefore, when using CMEM to monitor system started tasks,
if no task ID is entered in the START command, the
PROCSTEP parameter must not be specified.
Table 223 DSNEVENT Subparameters (Part 2 of 3)
Subparameter Description
ON DSNEVENT: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 713
General Information
ON DSNEVENT rules are triggered by the setting of data set disposition at time of
deallocation (during step termination or dynamic deallocation).
DO statements in the rule are executed either immediately upon detection of the data
set event or at the end of the job step that caused the data set event, depending on the
value entered in the STEPRC subparameter (described above).
PGMSTEP Name (or mask) of a step invoking a program. Optional.
If omitted, all program steps in the selected jobs are
monitored.
Note: When a system started task with stepname IEFPROC is
initiated, MVS assigns the step a default program step name.
Therefore, when using CMEM to monitor these system started
tasks, the PGMSTEP parameter must not be specified.
STEPRC Determines at which point in the job step, and under what
conditions in the job step, the DO statements are performed.
Valid values are:
s blank if no completion code is entered, the rule is
executed immediately upon detection of the specified data
set event
If any of the following values is entered for STEPRC, execution
of the DO statements is delayed until the end of the monitored
job step and is dependent upon how the jobstep ended:
s OK step ended with a condition code of zero
s NOTOK step ended with a nonzero code
s **** step ended (with any code)
s Cnnnn step ended with the indicated condition code
s Snnn step ended with the indicated system abend code
s Unnnn step ended with the indicated user abend code
Asterisks can be entered instead of code digits; condition
codes and abends can be preceded by code qualifiers (<, >, N).
For more information, see the following section, General
Information.
And/ Or/ Not Conjunctional parameter that opens a new ON statement and
links it to the previous ON statement. Optional. Valid values
are:
s A (And) indicates AND logic between the two ON
statements
s O (Or) indicates OR logic between the preceding and
following sets of ON statements
s N (Not) indicates AND NOT logic between the two ON
statements
Table 223 DSNEVENT Subparameters (Part 3 of 3)
Subparameter Description
ON DSNEVENT: Event Parameter
714 CONTROL-M for OS/390 and z/OS User Guide
Immediate execution is useful for performing actions when data sets are dynamically
de-allocated using long running address spaces (for example, CICS, TSO users, and
file transfer monitors).
ON DSNEVENT rules only intercept data set events for jobs, started tasks, or TSO
users that started after the rule was ordered.
ON DSNEVENT rules do not intercept data set events, such as cataloging,
uncataloging, or scratching, when they are performed using MVS CATALOG or
SCRATCH macros.
The following restrictions apply to ON DSNEVENT statements:
s Do not specify an ON DSNEVENT statement with any other type of ON statement
in a rule.
s Do not specify different STEPRC values in the same rule. If you do, the last
specified value is used.
Entering values for the optional subparameters PROCSTEP, PGMSTEP and STEPRC
limits the situations that can satisfy the step termination event. Conversely, if a
subparameter is blank, that subparameter is ignored.
Example
s If a PGMSTEP and PROCSTEP value are both entered, the rule is triggered only if
the specified PGMSTEP is completed in the specified PROCSTEP.
s If a PGMSTEP value is entered without a PROCSTEP value, the rule is triggered if
the PGMSTEP is completed anywhere within the job stream.
The STEPRC Subparameter
When entering a condition code or abend code in the STEPRC subparameter, any
characters in the code can be replaced by an asterisk (*). An asterisk means any
value for the character it replaces. For example, if S*13 is entered, the code criteria is
satisfied by codes S013, S613, S913, and so on.
When entering condition and/ or abend codes, the following qualifiers can be used as
indicated:
NOTE
To monitor data set events for a job, started task or TSO user, the job, started task or
TSO user must have MSGLEVEL=(1,1) and message IEF403I or IEF125I must appear
in the job log.
ON DSNEVENT: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 715
The SMFID and SYSTEM Subparameters
The default values for the SMFID and SYSTEM subparameters are the current system.
If no value is entered for either SMFID or SYSTEM, the rule is triggered only by
events that occur in the current system.
Example
When a new production data set is created, trigger a backup job.
Figure 326 ON DSNEVENT Parameter Example
Table 224 Valid STEPRC Code Qualifiers
Qualifier Description
< Greater than. Valid for condition codes and user abend codes.
> Less than. Valid for condition codes and user abend codes.
N Triggers the rule if the specified code does not exist in the step.
Valid as a qualifier for condition codes, user abend codes, and
system abend codes.
RL: PRDJ0003 LI B CTM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON DSNEVENT = PRDJ0003 JTYPE SMFI D SYSTEM
DSN PROD. * DI SP CATLG
PROCSTEP PGMSTEP STEPRC OK And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON NEWDATASET CREATED - TRI GGER A BACKUP JOB
DESCRI PTI ON
===========================================================================
/ * SCHEDULE A CONTROL- M JOB TO HANDLE THE BACKUP
/ *
DO FORCEJOB = TABLE BACKUP JOB BACKUP DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
/ *
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====




FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 21. 00. 36
ON JOBARRIV: Event Parameter
716 CONTROL-M for OS/390 and z/OS User Guide
ON JOBARRIV: Event Parameter
Monitor a job arrival event on the JES spool.
Figure 327 ON JOBARRIV Parameter Format

Optional. Type JA (JOBARRIV) in the ON field and press Enter. The following
subparameters are displayed:
Table 225 ON JOBARRIV Subparameters
Subparameter Description
jobname Job name (or mask). Mandatory. For more information, see
Character Masking on page 83.
JTYPE Type of job that can trigger the rule. Optional.
Valid values are:
s J (JOB) batch job
s S (STC) started task
s T (TSU) TSO user
s blank if no value is entered, the rule can be triggered by
any type of job. Default.
SMFID SMF ID of the CPU to monitor for job arrival events. Mask
characters (*and ?) are supported. Default: current CPU.
SYSTEM Name of the system to monitor for job arrival events. Mask
characters (*an ?) are supported. Default: current system.
And/ Or/ Not Conjunctional parameter that opens a new ON statement and
links it to the previous ON statement. Optional.
Valid values are:
s A (And) indicates AND logic between the two ON
statements
s O (Or) indicates OR logic between the preceding and
following sets of ON statements
s N (Not) indicates AND NOT logic between the two ON
statements
ON JOBARRIV: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 717
General Information
ON JOBARRIV statements can be used to trigger CONTROL-M actions based on the
appearance of a job on the JES spool.
Combination of an ON JOBARRIV statement and a DO FORCEJOB statement can be
used to control an external job through CONTROL-M. Such a job is called an On
Spool job. For more information, see On Spool Jobs on page 669.
The default values for the SMFID and SYSTEM subparameters are the current system.
If no value is entered for either SMFID or SYSTEM, the rule is triggered only by
events that occur in the current system.
Example
Backup jobs submitted outside CONTROL-M must be monitored by CONTROL-M.
Figure 328 ON JOBARRIV Parameter Example
RL: BKP* LI B CTM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = BKP* JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
DESCRI PTI ON MONI TOR EXTERNAL BACKUP JOBS
DESCRI PTI ON
===========================================================================
/ * TELL CONTROL- M TO MONI TOR THI S JOB
/ *
DO FORCEJOB = TABLE BACKUP JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
/ *
DO
===========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====







FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
ON JOBEND: Event Parameter
718 CONTROL-M for OS/390 and z/OS User Guide
ON JOBEND: Event Parameter
Monitor a job termination event.
Figure 329 ON JOBEND Parameter Format

Optional. Type JE (JOBEND) in the ON field and press Enter. The following
subparameters are displayed:
Table 226 JOBEND Subparameters
Subparameters Description
jobname Job name (or mask). Mandatory.
JTYPE Type of job whose termination can trigger the rule. Optional.
Valid values are:
s J (JOB) batch job
s S (STC) started task
s T (TSU) TSO user
s blank if no value is entered, the rule can be triggered by
the termination of any type of job. Default.
SMFID SMF ID of the CPU to monitor for job termination events.
Mask characters (*and ?) are supported. Default: current CPU.
SYSTEM Name of the system to monitor for job termination events.
Mask characters (*and ?) are supported. Default: current
system.
And/ Or/ Not Conjunctional parameter that opens a new ON statement and
links it to the previous ON statement. Optional.
Valid values are:
s A (And) indicates AND logic between the two ON
statements
s O (Or) indicates OR logic between the preceding and
following sets of ON statements
s N (Not) indicates AND NOT logic between the two ON
statements
ON JOBEND: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 719
General Information
ON JOBEND statements can be used to trigger CONTROL-M actions based on the
termination of a job.
The default values for the SMFID and SYSTEM subparameters are the current system.
If no value is entered for either SMFID or SYSTEM, the rule is triggered only by
events that occur in the current system.
Example
Instruct CONTROL-M to start the batch shift when CICSPROD ends.
Figure 330 ON JOBEND Parameter Example
RL: CI CSPROD LI B CTM. PROD. RULES TABLE: STCS
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBEND = CI CSPROD JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP CI CS MODE PROD RUNTSEC
DESCRI PTI ON START THE BATCH SHI FT
DESCRI PTI ON
===========================================================================
/ * I NFORM CONTROL- M THAT THE BATCH CAN BE STARTED
DO COND = START- BATCH ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====










FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
ON STEP: Event Parameter
720 CONTROL-M for OS/390 and z/OS User Guide
ON STEP: Event Parameter
Monitor a job step termination event.
Figure 331 ON STEP Parameter Format

Optional. Type S (STEP) in the ON field and press Enter. The following
subparameters are displayed:
Table 227 ON STEP Subparameters (Part 1 of 2)
Subparameter Description
job Name (or mask) of the job to be monitored for step
termination. Mandatory.
JTYPE Type of job to be monitored for step termination. Optional.
Valid values are:
s J (Job) batch job
s S (STC) started task
s blank any type of job. Default.
If JTYPE is entered, only the termination of steps from the
specified type of job can trigger the rule.
SMFID SMF ID of the CPU to monitor for data set events. Mask
characters (*and ?) are supported. Default: current CPU.
SYSTEM Name of the system to monitor for data set events. Mask
characters (*and ?) are supported. Default: current system.
PROCSTEP Name (or mask) of a step invoking a procedure or, for a
started task, task ID. Optional. If omitted, all procedure steps
in the selected jobs are monitored.
ON STEP: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 721
Note: When a started task is initiated, it can be assigned a task
ID. For example, in command S GTF.G, the task ID of GTF is
G. If a task ID is not entered, MVS assigns a default task ID to
the started task, as follows:
s For a system started task with stepname IEFPROC, MVS
sets an internal task ID.
s For other started tasks, the default task ID equals the
procedure (started task) name.
Therefore, when using CMEM to monitor system started tasks,
if no task ID is entered in the START command, do not specify
the PROCSTEP parameter.
PGMSTEP Name (or mask) of a step invoking a program. Optional. If
omitted, all program steps in the selected jobs are monitored.
Note: When a system started task with stepname IEFPROC is
initiated, MVS assigns the step a default program step name.
Therefore, when using CMEM to monitor these system started
tasks, do not specify the PGMSTEP parameter.
STEPRC Return codes and/ or statuses returned upon termination of
the specified steps that satisfy the step termination criteria.
Valid values are:
s (Blank) or **** step ended with any code or status
If no value or four asterisks are entered, the return code or
status is irrelevant.
s OK step ended with a condition code of 0
s NOTOK step ended with a nonzero code
s Cnnnn step ended with the indicated condition code
s Snnn step ended with the indicated system abend code
s Unnnn step ended with the indicated user abend code
Asterisks can be entered instead of code digits; condition
codes and abends can be preceded by code qualifiers (<, >, N).
For more information, see the following section, General
Information.
And/ Or/ Not Conjunctional parameter that opens a new ON statement and
links it to the previous ON statement. Valid values are:
s A (And) indicates AND logic between the two ON
statements
s O (Or) indicates OR logic between the preceding and
following sets of ON statements
s N (Not) indicates AND NOT logic between the two ON
statements
Table 227 ON STEP Subparameters (Part 2 of 2)
Subparameter Description
ON STEP: Event Parameter
722 CONTROL-M for OS/390 and z/OS User Guide
General Information
ON STEP rules are triggered when specified job steps terminate with specified return
codes or statuses.
Entering values for the optional subparameters PROCSTEP, PGMSTEP and STEPRC
limits the situations that can satisfy the step termination event. Conversely, if a
subparameter is blank, that subparameter is ignored.
s If a PGMSTEP and PROCSTEP value are both entered, the rule is triggered only if
the specified PGMSTEP is completed in the specified PROCSTEP.
s If a PGMSTEP value is entered without a PROCSTEP value, the rule is triggered if
the PGMSTEP is completed anywhere within the job stream.
The SMFID and SYSTEM Subparameters
The default values for the SMFID and SYSTEM subparameters are the current system.
If no value is entered for either SMFID or SYSTEM, the rule is triggered only by
events that occur in the current system.
The STEPRC Subparameter
When entering a condition code or abend code in the STEPRC subparameter, any
characters in the code can be replaced by an asterisk (*). An asterisk means any
value for the character it replaces. For example, if S*13 is entered, the code criteria is
satisfied by codes S013, S613, S913, and so on. When entering condition and/ or abend
codes, the following qualifiers can be used as indicated:
Table 228 ON STEP Subparameter STEPRC Qualifiers
Qualifier Description
> Greater than. Valid for condition codes and user abend codes.
< Less than. Valid for condition codes and user abend codes.
N Triggers the rule if the specified code does not exist in the step.
Valid as a qualifier for condition codes, user abend codes, and
system abend codes.
ON STEP: Event Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 723
Example
When step STEP2 in job PRD00010 is completed, add a prerequisite condition
indicating that a file has been created.
Figure 332 ON STEP Parameter Example
RL: PRD00010 LI B CTM. PROD. RULES TABLE: CMEMRULE
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON STEP = PRD00010 JTYPE SMFI D SYSTEM
PROCSTEP STEP2 PGMSTEP STEPRC OK And/ Or / Not
OWNER CTMCTLM GROUP MODE PROD RUNTSEC NONE
THRESHOLD
DESCRI PTI ON FOLLOWI NG STEP2 I N JOB PRD00010 ADD A CONDI TI ON
DESCRI PTI ON I NDI CATI NG THAT THE FI LE WAS CREATED
DESCRI PTI ON
===========================================================================
DO COND = FI LE- CREATED ODAT +
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====








FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
OWNER: General Parameter
724 CONTROL-M for OS/390 and z/OS User Guide
OWNER: General Parameter
Identifies the user requesting CMEM services.
Figure 333 OWNER Parameter Format

Mandatory. The OWNER parameter must be 1 through 8 characters.
General Information
The OWNER parameter is primarily used by the internal security mechanism of
CMEM to determine, together with an external security product, such as TOP
SECRET, RACF or ACF2, those operations each user is authorized to perform.
OWNER: General Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 725
Example
The INCONTROL administrator is authorized to use the rule used to monitor the
arrival of backup jobs.
Figure 334 OWNER Parameter Example
RL: BKP* LI B CTM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON JOBARRI V = BKP* JTYPE SMFI D SYSTEM And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC
THRESHOLD
DESCRI PTI ON MONI TOR STARTUP OF BACKUP JOBS
DESCRI PTI ON
===========================================================================
/ * TELL CONTROL- M TO MONI TOR THI S JOB
/ *
DO FORCEJOB = TABLE BACKUP JOB DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
/ *
DO
===========================================================================
======= >>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====






FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF 21. 00. 36
RUNTSEC: General Parameter
726 CONTROL-M for OS/390 and z/OS User Guide
RUNTSEC: General Parameter
Specifies the runtime security environment for the rule.
Figure 335 RUNTSEC Parameter Format

Optional. The abbreviation, that is, the first letter, of the desired value can be entered.
Valid values are:
Table 229 Valid RUNTSEC Values
Value Description
NONE Runtime security checks are not performed for this rule.
OWNER Runtime security checks are performed using the user ID
entered in the OWNER field of the rule.
TRIGGER Runtime security checks are performed using the user ID
associated with the started task, TSO user, or batch job that
invoked the rule.
(Blank) If CONTROL-O is not active, the default is OWNER.
If CONTROL-O is active, performance of runtime security
checks depend on the value of the Global parameter
RUNTDFT (NONE, OWNER, or TRIGGER) in the CTOPARM
member as entered at time of CONTROL-O installation.
NOTE
Value TRIGGER applies only to ON DSNEVENT, ON STEP, or ON JOBEND event
rules. If the value TRIGGER is entered for an ON JOBARRIV event rule, the value is
treated as OWNER.
RUNTSEC: General Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 727
General Information
The RUNTSEC parameter is used by the CMEM security interface for interaction with
external security products, such as CA-RACF, CA-TOP SECRET, and CA-ACF2. For
more information see the INCONTROL for OS/390 and z/OS Security Guide.
CMEM security checks are carried out in two stages: at order time and at runtime.
At order time, security checks are carried out to ascertain whether the owner of the
rule, as specified in the OWNER subparameter, is authorized to code each one of the
rule statements.
At runtime, additional security checks are carried out to determine whether the user
who owns the rule (RUNTSEC=OWNER) or the user who triggered the rule
(RUNTSEC=TRIGGER) is authorized to execute a DO COND or DO FORCEJOB
statement defined in the rule.
Example
Perform a backup using the security ID of the job that triggered the rule.
Figure 336 RUNTSEC Parameter Example
RL: PRDJ0003 LI B CTM. PROD. RULES TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
ON DSNEVENT = PRDJ0003 JTYPE SMFI D SYSTEM
DSN PROD. * DI SP CATLG
PROCSTEP PGMSTEP STEPRC OK And/ Or / Not
OWNER ADMI N GROUP BACKUP MODE PROD RUNTSEC TRI GGER
THRESHOLD
DESCRI PTI ON NEWDATASET CREATED - TRI GGER A BACKUP JOB
DESCRI PTI ON
===========================================================================
/ * SCHEDULE A CONTROL- M JOB TO HANDLE THE BACKUP
/ *
DO FORCEJOB = TABLE BACKUP JOB BACKUP DATE ODAT
LI BRARY CTM. PROD. SCHEDULE
/ *
DO
===========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<< =====




FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 21. 00. 36
THRESHOLD: Runtime Scheduling Parameter
728 CONTROL-M for OS/390 and z/OS User Guide
THRESHOLD: Runtime Scheduling Parameter
Limits the number of times that a rule can be triggered in one CMEM Monitor cycle.
Figure 337 THRESHOLD Parameter Format
Optional. Valid values are 1 through 999999999.
General Information
The THRESHOLD parameter is used to prevent unlimited loops within the system.
The value assigned to the parameter indicates the maximum number of times that
CMEM will trigger the rule in a single CMEM interval.
Before CMEM triggers a rule, it determines whether the rule has already been
triggered the maximum number of times in the current CMEM interval. If so, CMEM
does not trigger the rule again, but instead sets the STATUS of the rule to SUSPEND
and issues message CTO285W to the console.
If no value, or a value of 0, is entered for THRESHOLD, CMEM does not limit the
number of times that the rule can be triggered.
THRESHOLD: Runtime Scheduling Parameter
Chapter 4 CONTROL-M Event Manager (CMEM) 729
Example
Limit execution of the following rule to 10 executions. Do not allow the rule to be
triggered until it is released from SUSPEND status.
Figure 338 THRESHOLD Parameter Example
RL: PRDJOB01 LIB CTM.PROD.RULES TABLE: JOB
COMMAND ===> SCROLL===> CRSR
+-------------------------------------------------------------------------------
ON JOBARRIV = JOBNM233 JTYPE SMFID SYSTEM And/Or/Not
OWNER N18 GROUP MODE PROD RUNTSEC
THRESHOLD 000000010
DESCRIPTION
=========================================================================
DO COND = JOBNX-ARRIVED ODAT +
DO
==========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< ====











=====FILL IN RULE DEFINITION. CMDS: CAPS, EDIT, SHPF 13.21.53
THRESHOLD: Runtime Scheduling Parameter
730 CONTROL-M for OS/390 and z/OS User Guide
Chapter 5 JCL and AutoEdit Facility 731
Chapt er
5
5 JCL and AutoEdit Facility
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Non-Date System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Date System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Special System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
User-Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Valid Characters in User-Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Local Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
JCL Setup Operation Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Rules of Variable Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Order of Precedence for Multiple Value Assignments . . . . . . . . . . . . . . . . . . . . . 758
Control Statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
%%GLOBAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
%%GOTO and %%LABEL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
%%IF, %%ELSE, %%ENDIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
%%INCLIB and %%INCMEM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
%%LIBSYM and %%MEMSYM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
%%RANGE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
%%RESOLVE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
%%SET. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
%%$CALCDTE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
%%$GREG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
%%$JULIAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
%%$LEAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
%%$WCALC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
%%$WEEK# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
%%$WEEKDAY. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
%%$YEARWK# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
%%CALCDATE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
%%SUBSTR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Testing AutoEdit Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
732 CONTROL-M for OS/390 and z/OS User Guide
AutoEdit Usage in the Job Scheduling Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Date Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
ODATE, RDATE and DATE Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
How to Obtain Date Formats 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
How to Obtain Date Formats 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
How to Obtain Date Formats 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
How to Obtain the Previous Months Last Business Date . . . . . . . . . . . . . . . . . . . 790
Automatic Job Order for the Next Day. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Tape Clearance System Stage 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Tape Clearance System Stage 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Tape Management System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Dynamic Job Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Controlling the Target Computer by Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Controlling the Target Computer by System Affinity . . . . . . . . . . . . . . . . . . . . . . 795
%%BLANKn Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
%%RANGE Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
SYSIN Parameter Containing %%. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
%%INCLIB and %%INCMEM Statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Boolean IF Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Overview
Chapter 5 JCL and AutoEdit Facility 733
Overview
In the production environment, it is often necessary to manually modify JCL prior to
submission of a job, as in the following cases:
s changing a parameter or a date card
s supplying tape numbers in JCL procedures
s eliminating steps under different run conditions (for example, end of month
processing versus normal daily run)
Manual modification of JCL is inconvenient at best, and it may, in fact, be error prone
and lead to serious problems.
The AutoEdit facility offers an automated alternative to manual JCL modification.
This facility permits AutoEdit terms (variables, functions, and similar terms,
described in this chapter) to be specified in the JCL in place of values that change
from job submission to job submission. At time of job submission, these terms are
resolved to their actual values.
The inclusion of AutoEdit terms in the job stream can eliminate the need to
continually change the JCL. Some AutoEdit terms can also be used in job scheduling
definitions.
AutoEdit terms are prefaced by a %% symbol, which distinguishes them from terms
that are not AutoEdit terms. For example, the term %%ODAY is recognized as an
AutoEdit term.
The components of the AutoEdit facility are described briefly on the following pages
and in greater detail later in this chapter.
Variables
Variables are the main components of the AutoEdit facility. Variables are used to
replace manually changed values, generally within the JCL. AutoEdit variables can
be either of the following types:
NOTE
AutoEdit terms must be placed within the job stream submitted by CONTROL-M,
not within a catalogued JCL procedure.
The use of AutoEdit terms within started tasks (STCs) is not supported.
Overview
734 CONTROL-M for OS/390 and z/OS User Guide
s System Variables
System variables are predefined, reserved variables that represent information
about the system.
For example, System variable %%ODATE is replaced by the jobs original
scheduling date.
s User-Defined Variables
User-defined variables are created by the user. The user must provide the value (or
the tools to derive the value) that replaces the variable at time of job submission.
For example, the user can define a variable, %%SPACE-TYPE, to represent the type
of storage unit (cylinder or track) on disk.
User-defined variables are either:
local variables
Local variables are used only within the job stream. The value of a local variable
can be set or changed within the job stream by CONTROL-M, but the changed
value is kept only in memory for use during submission of that job stream. The
value is not passed to another job stream.
Global variables
Global variables are user-defined variables that are placed in the IOA Global
Variable database, from which they can be accessed and updated by other
CONTROL-M jobs and CONTROL-O rules.
System variables and user-defined variables are discussed in detail below. Local
variables and Global variables are also discussed in detail, under the topic of
user-Defined variables.
s control Statements
AutoEdit control statements in the JCL define the environment for user-defined
variables. The AutoEdit facility supports many AutoEdit control statements, and
this is discussed in detail later. Some of the more important Control Statements are
described here briefly.
Overview
Chapter 5 JCL and AutoEdit Facility 735
Operators
AutoEdit operators modify the values of AutoEdit variables in the JCL. For example,
in the following statement, operator %%PLUS assigns a number to a scratch tape that
is one higher than the previously assigned tape number:
/ / * %%SET %%SCRATCH=%%SCRATCH %%PLUS 1
Functions
AutoEdit functions perform functions on specified AutoEdit variables in the JCL. For
example, in the following statement, the %%CALCDATE function sets AutoEdit
variable %%NEXTDAY to one day after the current System variable %%ODATE:
/ / * %%SET %%NEXTDAY=%%CALCDATE %%ODATE +1
The format of a function statement depends on the function.
AutoEdit Components in the Job Scheduling Definition
Although the most important and common use of AutoEdit components is in JCL
setup, certain AutoEdit components can also be used in the job scheduling definition.
SET VAR and DO SET job scheduling definition statements assign values to
user-defined variables. These statements perform a similar function as, and work
together with, %%SET control statements specified in the JCL.
Other job scheduling definition statements (for example, SYSOUT, SHOUT,
MEMLIB) allow specification of system variables.
Table 230 AutoEdit Control Statements
Statement Description
%%GLOBAL
member
Identifies a member that contains a set of user-defined local
variables and their assigned values.
%%LIBSYM library
/ %%MEMSYM
member
Identifies a member and library that contain a set of
user-defined local variables and their assigned values.
%% SET
%%variable = value
Sets a value to a user-defined variable in the JCL.
Overview
736 CONTROL-M for OS/390 and z/OS User Guide
JCL Setup and AutoEdit Features
The rest of this chapter contains a description of the following JCL Setup and
AutoEdit topics:
s System Variables
s User-Defined Variables
s JCL Setup Operation Flow
s Rules of Variable Resolution
s Control Statements
s Operators
s Functions
s Testing AutoEdit Syntax
s AutoEdit Usage in the Job Scheduling Definition
s Examples
System Variables
Chapter 5 JCL and AutoEdit Facility 737
System Variables
CONTROL-M system variables are predefined, reserved, commonly used variables
whose values are automatically updated and maintained by CONTROL-M. The
system variable format is:
%%var
where var is the name of the System variable.
Each variable resolves to the corresponding system value. The length of the line is
changed accordingly. For example:
If the original scheduling date is June 5, 2001, the variables are resolved as follows:
Non-Date System Variables
The following AutoEdit system variables are supported by CONTROL-M (in both
JCL and in job scheduling definitions):
/ / EJ%%ODATE JOB ( 0, l 5, . . .
/ / EXEC ACCOUNTS, DAY=%%ODAY, MONTH=%%OMONTH
/ / EJ000603 JOB ( 0, l 5, . . .
/ / EXEC ACCOUNTS, DAY=05, MONTH=06
Table 231 Non-Date AutoEdit System Variables (Part 1 of 3)
Variable Description
%%. Concatenation symbol.
%%APPL Application to which the job belongs.
%%BLANK Blank.
System Variables
738 CONTROL-M for OS/390 and z/OS User Guide
%%BLANKn Resolves to n blanks, where n is a number from 1 through 80.
Note: When entering an AutoEdit variable assignment (such
as %%A = 1), any spaces (blanks) entered are ignored when
the variable is resolved. System variables %%BLANK and
%%BLANKn enable you to embed spaces in the variable
expression.
The variable assignment
%%A = Thi s%%BLANKi s%%BLANK1an%%BLANKexampl e,
using %%BLANK and %%BLANKn to create embedded
spaces, resolves to
Thi s i s an exampl e
%%BLANK and %%BLANK1 each produce the same result, a
single embedded space.
The similar variable assignment,
%%A = Thi s i s an exampl e, resolves to
Thi si sanexampl e.
%%$GRID Group Entity Order ID, primarily used within a job scheduling
definition. At job ordering time, this value is resolved to the
Order ID of the Group to which the job belongs.
If the job does not belong to a Group, or if the job is forced
from a Group table, %%$GRID is resolved to ?????.
%%$GRID is resolved in condition names, in IN, OUT or DO
COND parameters.
%%$GRID is especially useful in condition names, to enable
unique identification of condition names that are added by
multiple ordering of jobs from the same group table.
%%GROUP Group to which the job belongs.
%%JOBNAME Name of the submitted job as specified in the JCL job
statement. If %%JOBNAME is resolved before the job
submission (for example, %%JOBNAME is used in a SHOUT
WHEN LATESUB statement, and the job has not been
submitted), its value is assigned the %%$MEMNAME value.
%%ORDERID Unique job order ID under CONTROL-M (5 characters).
%%OWNER Owner of the job, as specified in the scheduling definition.
%%RN Run number (can exceed one for cyclic and rerun and restarted
jobs).
%%TIME Current time of day, in hhmmss format. This variable receives
the current time each time it is invoked.
Table 231 Non-Date AutoEdit System Variables (Part 2 of 3)
Variable Description
System Variables
Chapter 5 JCL and AutoEdit Facility 739
Date System Variables
Many system variables specify dates, or parts of dates, in various formats. Therefore,
it is useful to understand the categories of dates with which CONTROL-M is
concerned.
Dates are divided into the categories listed below. For a description of these
categories, see Date Definition Concepts on page 62
s Working Date
%%TIMEID Current time of day, in hhmmss format. This AutoEdit
variable receives the current time only when it is first resolved
in a job. Subsequent resolutions within that job do not update
the variable.
%%$MEMNAME Name of the JCL member from which the job is submitted.
(This corresponds to the value specified in the job scheduling
definition.)
%%$QNAME Qname (unique identifier) of the monitor that submitted the
job.
%%$SCHDLIB Name of the scheduling library that contains the job
scheduling definition of the job. This variable is resolved only
after the job has been ordered.
%%$SCHDTAB Name of the scheduling table that contains the job scheduling
definition of the job. This variable is resolved only after the job
has been ordered.
%%$SIGN 1-character ID of the computer on which the job is running.
The %%$SIGN variable is commonly used when assigning
system affinity, as in the following example:
/ * JOBPARM SYSAFF=CPU%%$SI GN
For more information, see Controlling the Target Computer
by System Affinity on page 795.
Note: The %%$SIGN variable is not resolved unless the job
scheduling definition from which the job is ordered contains a
resource name with a $ mask character used as a generic
indicator. For more information, see RESOURCE: Runtime
Scheduling Parameter on page 588.
%%$TAG Name of the schedule tag by which the job was scheduled. If
the Group scheduling table was forced, or if the job was
scheduled based on basic scheduling criteria other than a
schedule tag, this value resolves to blanks.
Table 231 Non-Date AutoEdit System Variables (Part 3 of 3)
Variable Description
System Variables
740 CONTROL-M for OS/390 and z/OS User Guide
System variables that specify working dates begin %%R (%%RDATE, %%RDAY,
and so on).
s Original Scheduling Date
System variables that specify original scheduling dates begin %%O (%%ODATE,
%%ODAY, and so on).
s System Date
System variables that specify system dates have no special prefix other than %%
(%%DATE, %%DAY, and so on).
Although these types of dates are resolved in Gregorian format, Julian formats can
also be requested (%%JULDAY, %%OJULDAY and %%RJULDAY).
The following date AutoEdit system variables are supported by CONTROL-M in JCL
and in certain job scheduling definition parameters (for more information, see
AutoEdit Usage in the Job Scheduling Definition on page 784):
Table 232 Date AutoEdit System Variables (Part 1 of 2)
Variable Description
%%$CENT First two digits in the current year (for example, 20 in the year
2000).
%%DATE Current system date (format yymmdd).
%%DAY Current system day (format dd).
%%MONTH Current system month (format mm).
%%YEAR Current system year (format yy).
%%WEEK Current week in the year (that is, 01 through 53).
%%WDAY Current system day of the week (Example: 1=Sunday, 2=Monday
and 0=Saturday).
a

%%$OCENT First two digits of the year in which the job was originally
scheduled.
%%ODATE Original scheduling date of the job (format yymmdd).
%%ODAY Original scheduling day of the job (format dd).
%%OMONTH Original scheduling month of the job (format mm).
%%OYEAR Original scheduling year of the job (format yy).
%%OWEEK Original scheduling week of the job (that is, 01 through 53).
%%OWDAY Original scheduling day of the week of the job (format d;
Example: 1=Sunday, 2=Monday and 0=Saturday).
1

%%$RCENT First two digits of the current working year.
%%RDATE Current working date (format yymmdd).
System Variables
Chapter 5 JCL and AutoEdit Facility 741
The following AutoEdit system variables, prefixed %%$, resolve to dates having
4-character years:
Special System Variables
Special system variables are resolved only during the post-processing phase of jobs,
and therefore can only be used with the Postprocessing parameters (such as SHOUT
and DO IFRERUN) of the job scheduling definition.
%%RDAY Current working day (format dd).
%%RMONTH Current working month (format mm).
%%RYEAR Current working year (format yy).
%%RWEEK Current working week (that is, 01 through 53).
%%RWDAY Current working day of the week (format d; Example: 1=Sunday,
2=Monday and 0=Saturday).
1

%%JULDAY Current system day (Julian format jjj).
%%OJULDAY Original scheduling day of the job in the year (Julian format jjj).
%%RJULDAY Current working day of the year (Julian format jjj).
a
Start of the week at a site depends upon an IOA installation parameter that specifies
whether 1=Sunday or 1=Monday. Your INCONTROL administrator can tell you whether
the week begins on Sunday or Monday at your site. The above reference assumes 1=Sunday,
2=Monday, 6=Friday, 0=Saturday.
Table 233 4 Character Year Date AutoEdit System Variables
Variable Description
%%$DATE Current system date (format yyyymmdd).
%%$YEAR Current system year (format yyyy).
%%$ODATE Original scheduling date of the job (format yyyymmdd).
%%$OYEAR Original scheduling year of the job (format yyyy).
%%$RDATE Current working date (format yyyymmdd).
%%$RYEAR Current working year (format yyyy).
%%$JULDAY Current system day (Julian format yyyyjjj).
%%$OJULDAY Original scheduling day of the job in the year (Julian format
yyyyjjj).
%%$RJULDAY Current working day of the year (Julian format yyyyjjj).
Table 232 Date AutoEdit System Variables (Part 2 of 2)
Variable Description
System Variables
742 CONTROL-M for OS/390 and z/OS User Guide
The following are the types of special system variables:
s those that can only be resolved after the job has ended
s those that can only be resolved after job submission
Special System Variables Resolved after End of Job
The special system variables in Table 234 can only be resolved after the job has ended.
These variables contain a blank value if the job ends OK or if no step in the job was
run.
Special System Variables Resolved after Job Submission
The special system variable shown in Table 235 can only be resolved after job
submission. This variable contains a blank value if the job ends OK or if no step in the
job was run.
Table 234 Special AutoEdit System Variables Resolved after Job End
Variable Description
%%JOBCC Job completion code that caused the job to end NOTOK.
%%MAXRC Highest return code in the job execution. For abended jobs, this
variable resolves to blanks.
%%$NODEID The value of the node name that appears in the Active
Environment Zoom screen. This variable is only resolved for NJE
jobs; for non-NJE jobs, it resolves to a null value.
%%STEP Job program step and procedure step (if it is defined) that
triggered the postprocessing instruction.
Format: 8-character program step (including blanks if necessary),
followed by the procedure step name (up to eight characters).
%%$PGMSTEP Job program step (equal to the first part of the %%STEP variable).
%%$PRCSTEP Procedure step (equal to the second part of the %%STEP variable).
NOTE
The effect of an ON PGMST...DO OK statement, or of the value of the MAXCCOK
parameter may be that CONTROL-M treats a non-zero return code of a step in a job
as OK. In such a case, the non-zero return code of that step is ignored by
CONTROL-M in calculating values for the %%JOBCC and %%MAXRC AutoEdit
system variables.
User-Defined Variables
Chapter 5 JCL and AutoEdit Facility 743
User-Defined Variables
The ability to specify user-defined variables provides additional flexibility. You can
define your own variables and assign values to them. CONTROL-M automatically
edits the job stream accordingly. This facility is especially useful when it is necessary
to share parameters or other information (for example, tape numbers) among jobs.
CONTROL-M assumes that strings beginning with %% are user-defined variables,
except those beginning with %%$, which are reserved system variables.
For a list of all system variables, see System Variables on page 737.
User-defined variables are defined as either:
s Local variables, which are discussed in Local Variables on page 745
s Global variables, which are discussed in Global Variables on page 748
Multiple AutoEdit variables can be joined with each other and with constants, and
periods (.) are often part of this process (for example,
JOB_%%JOBID%%._ENDED_OK). This is discussed in more detail in Rules of
Variable Resolution on page 755.
Backslashes (\ ) are used only in Global variable assignments, and differentiate Global
variables from local variables. For more information, see Global Variable
Assignment and Syntax on page 749.
Unlike system variables, which are predefined and which receive their values from
the system at time of job submission, two steps are performed for utilizing
user-defined variables:
s The first step consists of specifying (defining) user-defined variables, usually
within the JCL, instead of values that require manual modification.
s The second step consists of providing values to replace the user-defined variables
at time of job submission. (Since the values are not provided by the system, the
user must specify the appropriate values.) It is permissible, however, for
user-defined variables to take their values from system variables (for example,
%%SET %%VERSION = %%ODATE).)
Table 235 Special AutoEdit System Variable Resolved after Job Submission
Variable Description
%%JOBID JES job number
User-Defined Variables
744 CONTROL-M for OS/390 and z/OS User Guide
Valid Characters in User-Defined Variables
When defining AutoEdit variables, only certain characters can be used. The validity
of characters depends on the purpose for which they are being used.
AutoEdit Variable Names
The following characters can be used in AutoEdit variable names:
s any character from A through Z, both uppercase and lowercase
s any digits from 0 through 9
s the following special characters:
& (Ampersand)
$ (Dollar)
_ (Underscore)
# (Octothorp)
@(At)
s the following hexadecimal values:
from x'41' through x'49'
from x'51' through x'59'
from x'62' through x'69'
x'71'
AutoEdit Variable Value Fields
Any characters can be used in AutoEdit variable value fields except the following:
s ' ' (Blank)
s the following hexadecimal values:
x'00'
x'FE'
x'FF'
NOTE
BMC Software recommends that you do not use non-display hexadecimal values.
NOTE
BMC Software recommends that you do not use non-display hexadecimal values.
User-Defined Variables
Chapter 5 JCL and AutoEdit Facility 745
AutoEdit Variables in JCL
In any JCL line that contains AutoEdit variables, do not use the following
hexadecimal values unless their processing is excluded by a %%RANGE or a
%%RESOLVE OFF statement:
x'00'
x'FE'
x'FF'
Global AutoEdit Variables
The following characters have special meanings in Global AutoEdit variables:
s . (Period)
s \ (Backslash)
Do not use these characters in the variable name field unless you require the special
meaning assigned to them.
Local Variables
Local variables are user-defined variables that are only within the job stream. The
value of a local variable can be changed within the job stream, but the changed value
is kept only in memory for use during submission of that job stream. The value is not
passed to another job stream.
Local variables can be defined in either of two ways:
s by means of %%SET statements in the JCL and/ or SET VAR and DO SET
statements in the job scheduling definition
%%SET statements are described under Control Statements on page 760. SET
VAR statements are described in SET VAR: General Job Parameter on page 612,
and DO SET statements are described in DO SET: PostProcessing Parameter on
page 462.
s by placing the variables and their values in special variable members
Variable members are members dedicated to holding user-defined AutoEdit
variables and their values. These variables and values in these members can be
used by any number of CONTROL-M jobs or CONTROL-O rules that are given
access. However, these jobs and rules cannot update these members.
User-Defined Variables
746 CONTROL-M for OS/390 and z/OS User Guide
Members containing user-defined variables can be identified in either of two ways:
by a %%MEMSYM control statement
This member must reside in the library specified in the %%LIBSYM statement
that must accompany the %%MEMSYM statement. (The control statements
%%LIBSYM and %%MEMSYM are described Control Statements on
page 760.) Any number of such variable members can be defined.
by a %%GLOBAL control statement
This statement differs from the %%MEMSYM statement in that it does not have
an accompanying %%LIBSYM statement. Instead, the library in which the
%%GLOBAL member resides is pointed to by a DAGLOBAL DD statement.
For example, the user may specify variable %%BRANCH_TAPE in a JCL
statement:
/ / S001. I NPUT DD VOL=SER=%%BRANCH_TAPE
and the %%MEMSYM member (or %%GLOBAL member) that assigns values
might contain the following variable definition:
%%BRANCH_TAPE=045673
%%MEMSYM, %%LIBSYM and %%GLOBAL control statements are described in
Control Statements on page 760.
Loading %%GLOBAL Members to Cache
%%Global members can be placed in cache memory, from where they can be accessed
as needed. If the members are placed in cache, the JCL accesses the contents from the
cache, instead of accessing the members themselves.
This can be very advantageous if many jobs access %%Global members, because each
access of the member increases I/ O and processing overhead.
Only those %%GLOBAL members that are specifically requested are loaded to cache.
Requests are generally made by listing the desired %%GLOBAL members in a special
cache list member in the DAGLOBAL library. This cache list member (default name:
CACHLST) is pointed to by the AECACHL parameter in the CTMPARM member in
the IOA PARM library.
Members are listed in the cache list member in the following format:
%%GLOBAL memname
User-Defined Variables
Chapter 5 JCL and AutoEdit Facility 747
where memname is the name of the %%GLOBAL member in the Global library.
The cache list member can optionally contain the following control statement as its
first non-comment statement:
%%RESOLVE ALLCACHE
This control statement affects AutoEdit processing only if an AutoEdit variable has
not been resolved by searching the %%GLOBAL members identified in the job. The
statement instructs CONTROL-M to continue the variable resolution process by
checking all members loaded into cache. Members in cache are searched in the same
sequence they are listed in the cache list member.
%%GLOBAL members are loaded to cache at time of CONTROL-M startup.
To reload %%GLOBAL members to cache between CONTROL-M startups or to stop
using AutoEdit cache, see Loading %%GLOBAL Members to Cache on page 746,
and the corresponding topic in the INCONTROL for OS/390 and z/OS Administrator
Guide.
Format of Variable Members
A variable member (referenced by %%GLOBAL or %%MEMSYM statements) must
be a member in a partitioned data set with a record length of 80. It can contain the
following types of lines:
s Remark line: Line starting with an asterisk (*) in column 1. Remark lines are not
processed.
s Assignment line: Line that assigns a value to a variable. The format is:
Any number of user-defined variables (and their values) can be defined in a variable
member. To designate a null value, omit the value.
%%var name=val ue
User-Defined Variables
748 CONTROL-M for OS/390 and z/OS User Guide
Example
Global Variables
A Global variable is a user-defined variable that is placed in the IOA Global Variable
database.
%%SET statements in the JCL, and SET VAR or DO SET statements in the job
scheduling definition, enable CONTROL-M jobs and Group entities to define Global
variables and place them in the IOA Global Variable database.
However, since %%SET, SET VAR and DO SET statements also define local variables,
a distinguishing factor is needed to differentiate Local Variables from Global
variables. The distinguishing factor is provided by syntax (described below in
Global Variable Assignment and Syntax).
A Global variable from the IOA Global Variable database can be specified anywhere a
local variable can be specified in the JCL or the job scheduling definition (SHOUT,
DO SHOUT, SYSOUT, DO SYSOUT, MEMLIB and OVERLIB statements).
Structure of the IOA Global Variable Database
The IOA Global Variable database has a hierarchical structure consisting of several
levels. This structure mirrors the hierarchical structure of the CONTROL-M
components of which a CONTROL-M job is a part.
The levels in the IOA Global Variable database structure, starting from the lowest, are
as follows:
* Last banki ng day i n each mont h
*
%%LAST_BANKI NG_DAY_0001=010131
%%LAST_BANKI NG_DAY_0002=010228
%%LAST_BANKI NG_DAY_0003=010330
%%LAST_BANKI NG_DAY_0004=010430
%%LAST_BANKI NG_DAY_0005=010531
%%LAST_BANKI NG_DAY_0006=010629
%%LAST_BANKI NG_DAY_0007=010731
%%LAST_BANKI NG_DAY_0008=010831
%%LAST_BANKI NG_DAY_0009=010928
%%LAST_BANKI NG_DAY_0010=011031
%%LAST_BANKI NG_DAY_0011=011130
%%LAST_BANKI NG_DAY_0012=011231

User-Defined Variables
Chapter 5 JCL and AutoEdit Facility 749
The importance of this structure is discussed in the topic Global Variable
Assignment and Syntax immediately below.
Global Variable Assignment and Syntax
Whenever a job (or Group entity) creates a Global variable and places it in the IOA
Global Variable database, it assigns an owner to the variable.
The job that creates the variable can make itself the owner (for example, JOBA defines
a Global variable that is assigned to JOBA), but it does not have to do this. It can,
instead, assign a different owner to the variable (for example, JOBA defines a Global
variable that it assigns to GROUP_ABC).
In fact, when a Global variable is created, it can be assigned to any component (job,
group, application, or even to CONTROL-M) in the database. It is this ability to
assign variables that makes the structure of the IOA Global Variable database so
important.
The hierarchical structure of the IOA Global Variable Database, described above, is
similar to the directory and subdirectory structure in Unix and DOS. Therefore, the
same path structure and syntax that is used to describe directories and subdirectories
is used to define and identify Global variables.
Note the following points about Global variable assignment and syntax:
s Global variables are identified (and distinguished from Local variables) by a
backslash.
Example
Variable %%PROBID is a Local Variable.
Variable %%\ PROBID is a Global Variable.
Table 236 IOA Global Variable Database Structure Levels
Level Description
Variable Global variable in the IOA Global Variable database.
Job Name of the job (JCL member) that appears in the
MEMNAME field of the job scheduling definition.
Group Group to which the job belongs. The name of the group
appears in the GROUP field of the job scheduling definition.
Application Application to which the group and job and belong. The name
of the application appears in the APPL field of the job
scheduling definition.
Product M (CONTROL-M).
User-Defined Variables
750 CONTROL-M for OS/390 and z/OS User Guide
s In the IOA Global Variable database, the format for indicating a full path is as
follows:
%%\ product\ application\ group\ job\ variablename
s Two variables with the same name but different paths are different variables. (This
is comparable to the fact that two Unix or DOS files with the same name but
different paths are different files. For example, File A under directory \ A\ B\ C is a
different file than File A under directory \ D\ E\ F.)
Example
Due to the different paths, the following variables are all different from each other:
%%\ M\ APP_1\ GRP_1\ JOB_A\ VAR_XYZ
%%\ M\ APP_1\ GRP_1\ JOB_B\ VAR_XYZ
%%\ M\ APP_1\ GRP_1\ VAR_XYZ
s If the particular path has no Group and/ or no Application (for example, the job
does not belong to a group or application), CONTROL-M utilizes the keyword
values NO_APPL and NO_GROUP in the path, as needed.
s Paths can be specified using the same rules and shortcuts that are available with
directories and subdirectories (instead of the full path):
A job or Group Entity can assign a Global variable to itself by specifying a slash
immediately following the %% symbol.
Example
If job JOB1 belongs to group GRP_A, which belongs to application APP_1, then
the following SET VAR statement in JOB1:
SET VAR=%%\ PROBI D=123
creates the following variable assigned to JOB1 (with the indicated full path):
%%\ M\ APP_1\ GRP_A\ JOB1\ PROBI D=123
Paired dots with a backslash (..\ ) indicate movement to the next level up.
Example
If JOB1 belongs to group GRP_A, which belongs to application APP_1, then the
following SET VAR statement in JOB1:
SET VAR=%%. . \ PROBI D=123
User-Defined Variables
Chapter 5 JCL and AutoEdit Facility 751
creates the following variable assigned to GRP_A (with the indicated full path):
%%\ M\ APP_1\ GRP_A\ PROBI D=123
To move directly down the hierarchy, it is only necessary to indicate the levels
that are lower than the current level. (However, since only Group entities and
jobs utilize variables, only Group entities can move directly down a level.
Example
Assume Group entity GRP_A wants to assign variable %%A, with a value equal
to 7, (%%A = 7) to job JOB2. The following statement indicates the syntax of the
%% SET statement:
/ / * %%SET %%\ JOB2\ A=7
To move across the hierarchy (that is, to change paths), you can either:
s Specify a full path, or
s Move up to a component common to both paths, and then move down the
other path.
Example 1
Assume job JOB1, in group GRP_A, which is in application APP_A, wants to
assign variable %%A, with a value equal to 7, to job JOB2, which is in group
GRP_B and which does not have an application.
Either of the following %% SET statements work:
/ / * %%SET %%\ M\ NO_APPL\ GRP_B\ JOB2\ A=7
/ / * %%SET %%\ . . \ . . \ . . \ NO_APPL\ GRP_B\ JOB2\ A=7
Example 2
Assume job JOB1 in group GRP_A wants to assign variable %%A (with a value
equal to 7) to job JOB2 in the same group (and assume the group has no
application). Any of the following statements can be specified.
/ / * %%SET %%. . \ JOB2\ A=7
/ / * %%SET %%\ M\ NO_APPL\ GRP_A\ JOB2\ A=7
s If two statements assign the same Global variable to the same component, the later
assignment overwrites the earlier assignment.
User-Defined Variables
752 CONTROL-M for OS/390 and z/OS User Guide
Example
Assume job JOB1 belonging to group GRP_A is run before job JOB2 belonging to
the same group (and both belong to application APP_A).
If JOB1 contains the following SET VAR statement:
SET VAR=%%. . \ A=7
and JOB2 contains the following SET VAR statement:
SET VAR=%%. . \ A=8
At the end of the job run for JOB2, the IOA Global Variable database contains the
following variable (assigned to GRP_A):
%%\ M\ APP_A\ GRP_A\ A=8
s A job or Group entity can utilize a Global variable that has been assigned to it by
merely specifying the variable with the backslash, even if the variable was created
by a different job. (The full path is not required.)
Example
Assume job JOB1 contained the following statement that assigned the following
variable to JOB2.
DO SET VAR=%%\ M\ NO_APPL\ GRP_A\ JOB2\ PROBI D=123
JOB2 can then access this variable in a DO SHOUT statement without a full path
name by specifying the variable with a backslash.
DO SHOUT TO TSO- U0014 URGENCY U
=* * * Pr obl em Encount er ed. Pr obl em I D=%%\ PROBI D * * *
s When changing paths or assigning a variable to a higher level component on the
same path, a security check can be required.
s A job or Group entity can utilize a Global variable that has been assigned to a
different component by specifying the appropriate path. However, before the
variable could be utilized, security checks, if any, would have to be passed.
Example
If a Global variable is assigned to job JOB1, and JOB2 wants to access the variable,
it would have to specify the appropriate path name (and pass any required
security checks), as in the following statement:
JCL Setup Operation Flow
Chapter 5 JCL and AutoEdit Facility 753
DO SET VAR=%%\ M\ NO_APPL\ GRP_A\ JOB2\ PROBI D=123
JOB2 can then access this variable in a DO SHOUT statement without a full path
name by specifying the variable with a backslash.
DO SHOUT TO TSO- U0014 URGENCY U
=* * Pr obl em Occur r ed. I D=%%\ M\ NO_APPL\ GRP_A\ JOB1\ PROBI D* *
JCL Setup Operation Flow
All JCL setup operations are performed during job submission. At this time,
CONTROL-M processes the JCL of the job line by line.
CONTROL-M scans each line for AutoEdit terms (identified by the %% symbol) and
tries to resolve them (unless otherwise instructed). CONTROL-M resolves all
AutoEdit terms in a line before it moves to the next line.
All changes made during JCL processing (such as variable resolution) are retained
only until CONTROL-M has finished submission of the job.
CONTROL-M resolves system variables by taking the values from the system.
CONTROL-M resolves Global variables by taking the values from the IOA Global
Variable database.
Values for Local user-defined variables can be taken from any of several possible
sources (described below). When CONTROL-M detects a local user-defined variable
in the JCL line being processed, it checks these possible sources in a specific order
until a value is found for the variable. CONTROL-M creates a user-defined variable
environment in which it places each user-defined variable and its value.
The potential sources for local user-defined variable values are listed below in the
order in which they are generally checked:
s System variable values
s %%SET control statements
These statements can be specified in JCL lines, including JCL comment lines. They
assign values to variables.
s SET VAR and DO SET statements
JCL Setup Operation Flow
754 CONTROL-M for OS/390 and z/OS User Guide
These statements can be specified in the job scheduling definition. They can be
used to define new variables, or to assign new values to existing variables.
SET VAR statements can affect all job submissions.
DO SET statements can override values specified by a SET VAR or previous DO SET
statement. However, since DO SET statements are post-processing parameters, they
only affect subsequent runs of a job (rerun and restarted jobs).
s Local variables and values defined in members specified in %%LIBSYM /
%%MEMSYM control statements
These members define local variables and specify their values. Members are
searched in the order in which they appear in the JCL.
s Local variables and values defined in members specified in %%GLOBAL control
statements
These members define local variables and specify their values. Members are
searched in the order they appear in the JCL.
The order in which CONTROL-M checks potential sources for possible AutoEdit
variable resolution is important because once CONTROL-M has resolved a variable,
it generally stops checking other sources. Potential values from other sources are
ignored, and resolved values are not overridden except by %%SET statements in
subsequent JCL lines.
Because JCL is processed sequentially one line at a time, the line being processed can
only be affected by external members and %%SET control statements that have
previously been processed. If a line contains an undefined variable that is only
defined in a subsequent line, the variable cannot be resolved.
By default, if CONTROL-M cannot resolve a variable, it stops submission of the job.
This default, however, can be overridden by specifying the %%RESOLVE control
statement with a value of NO or OFF (described later in this chapter).
To stop submission of a job because of an unresolved variable, CONTROL-M creates
an intentional JCL error that prevents execution of the jobs already submitted JCL.
The job ends with the status NOT SUBMITTED for reason JNSUB. The erroneous JCL
remains on the spool, but does not affect other job executions except those that
depend on the successful execution of this job.
Local variable values taken from variable members (%%MEMSYM and %%GLOBAL
members) that are changed during job submission remain in effect only until
CONTROL-M finishes submission of the job. Therefore, a change made to such a
variable (using the %%SET control statement) affects only submission of that job and
does not affect any other job submission or the value of the variable in the variable
member.
Rules of Variable Resolution
Chapter 5 JCL and AutoEdit Facility 755
Rules of Variable Resolution
By default, columns 1 through 72 of JCL lines are searched for variables which are
then analyzed and resolved. If column 72 contains an asterisk (*), the active range for
resolution is columns 1 through 71 (to support continuation lines).
Multiple AutoEdit variables (and constants) can be joined together into a complex
term. When a term contains multiple variables, those variables are resolved from
right to left.
The methods of joining multiple variables together are described below.
s Two variables can be joined to form a single complex variable by linking them
together (such as %%A%%B).
Example 1
Example 2
s Two variables can be concatenated into two distinct but joined variables by placing
a period between them (such as %%A.%%B).
Given: %%A=1, %%B=2, %%A2=100
Resolve: %%A%%B
Explanation: The process of resolution is as follows:
Initial expression to resolve %%A%%B
Resolve %%B 2
Replace %%B with value 2 %%A2
(%%A%%B partially resolves to a single variable %%A2)
Resolve %%A2 100
Solution: %%A%%B resolves to 100
Given: The day is the 3rd of the month.
Resolve: //SYSBKP DD
UNIT=TAPE,VOL=SER=%%BACKUP_TAPE_%%ODAY,
Solution: This statement partially resolves to:
//SYSBKP DD UNIT=TAPE,VOL=SER=%%BACKUP_TAPE_03,
%%BACKUP_TAPE_03 is a single user-defined variable. If the
value of this variable is known to CONTROL-M as EE1022, the
statement would fully resolve to:
/ / SYSBKP DD UNIT=TAPE,VOL=SER=EE1022,
Rules of Variable Resolution
756 CONTROL-M for OS/390 and z/OS User Guide
Example 1
Example 2
On the 4th of December, %%ODAY.%%OMONTH resolves to 0412
(If the expression had been written %%ODAY%%OMONTH (without the period), it
would have partially resolved to %%ODAY12, which is a user-defined variable
requiring further resolution.)
s Two variables can be concatenated into two distinct variables joined by a period by
placing two periods between them (such as %%A..%%B).
Given: %%A=1, %%B=2, %%A2=100
Resolve: %%A.%%B
Explanation:

The process of resolution is as follows:
Initial expression to resolve %%A.%%B
Resolve %%B 2
(The partially resolved variable now reads %%A.2)
Resolve %%A 1
(The partially resolved variable now reads 1.2)
Final resolution of the two values (based on the
rule that two variables joined by a period
resolve to a concatenated value)
12
Solution: %%A.%%B resolves to 12
Rules of Variable Resolution
Chapter 5 JCL and AutoEdit Facility 757
Example 1
Example 2
On the 4th of December, %%ODAY..%%OMONTH resolves to 04.12
s A constant can be appended to a variable by prefixing the constant with the
concatenation symbol %%. For example, in expression %%AA%%.UP, constant UP
is appended to variable %%AA.
Without symbol %%., the constant would be treated as part of the variable (for
example, expression %%AAUP consists of one variable).
The %%. symbol is not required if the constant precedes the variable (for example,
UNIT%%AA) since the %% prefix of the variable differentiates it from the
constant.
Given: %%A=1, %%B=2, %%A2=100
Resolve: %%A..%%B
Explanation:

The process of resolution is similar to the
resolution of two variables joined by one
period:
Initial expression to resolve %%A..%%B
Resolve %%B 2
(The partially resolved variable now reads 1.2)
Resolve %%A 1
(The partially resolved variable now reads 1..2)
Final resolution of the two values (based on the
rule that two variables joined by two periods
resolve to two values joined by a period)
1.2
Solution: %%A..%%B resolves to 1.2
Rules of Variable Resolution
758 CONTROL-M for OS/390 and z/OS User Guide
Example
Order of Precedence for Multiple Value Assignments
If a particular AutoEdit variable can receive a value from more than one source, an
order of precedence is necessary to determine which of the possible values is
assigned.
The following chart indicates the order of precedence. The chart works as follows:
s Each row in the chart represents a possible source of a value for a variable.
s In each column, a single pair of value sources (rows) are selected and compared for
precedence:
The source that takes precedence in the pair is identified by label P.
The other source in the pair is identified by label O.
When many sources of value assignments are available for a variable, use the chart
below to compare those sources one pair at a time, as follows:
Given: %%MODE = PROD
Resolve: CTM.%%MODE%%.01.JCL
Explanation: The process of resolution is as
follows:
Initial expression to resolve CTM.%%MODE%%.01.JCL
Resolve %%MODE PROD
(The partially resolved variable now
reads CTM.PROD%%.01.JCL)
Final resolution (based on the rule
that symbol %%. joins a constant to a
variable)
CTM.PROD01.JCL
Solution: CTM.%%MODE%%.01.JCL resolves to CTM.PROD01.JCL
NOTE
To separate a constant (JCL) from a variable (%%MODE) by a period, specifying the
period is sufficient. For example: CTM.%%MODE.JCL would resolve to
CTM.PROD.JCL.
Rules of Variable Resolution
Chapter 5 JCL and AutoEdit Facility 759
s From the list of available sources for the particular variable, select any two sources
and use the chart to eliminate the source of lower priority. The list now has one less
source available.
s Repeat this process until only the source of highest priority remains.
If there are multiple value assignments for the same variable in the one member, the
last assignment in that member is used for the above calculation.
Table 237 Chart for Determining Priorities of Value Assignment Sources
Source of Value Assignment Paired Combinations of Value Sources
SET VAR (Job
Scheduling Definition)
O P P
JCL SET (earlier) P P P O
JCL SET (later) P
LIBSYM O O P P
LIBSYM2 O
GLOBAL O O O P
GLOBAL2 O
NOTE
JCL SET can apply to an actual AutoEdit SET statement in the JCL or to AutoEdit SET
statements embedded within an INCLIB member referenced in the JCL.
LIBSYM represents a member specified in an earlier statement; LIBSYM2 represents a
different member specified in a later statement. The same applies to GLOBAL and
GLOBAL2 respectively.
Control Statements
760 CONTROL-M for OS/390 and z/OS User Guide
Control Statements
Control statements define the AutoEdit environment and control AutoEdit
processing.
Control statements can appear anywhere in the JCL member to be submitted. When a
control statement is detected in a JCL line (for example, in a JCL remark statement),
the line containing the control statement is submitted as part of the job. If the control
statement appears in a non-JCL line (for example, a line beginning without a / /
symbol), the control statement is resolved and the resolved value can be applied to
subsequent JCL lines, but the control statement is not submitted as part of the job.
Available control statements are discussed on the following pages.
%%GLOBAL
Control statement %%GLOBAL defines a member that contains a set of user-defined
variables and values. Before job submission, the CONTROL-M monitor reads this
member from the library referenced by DD statement DAGLOBAL in the
CONTROL-M procedure. The content of the member is added to the user-defined
variable environment of the job.
You can specify more than one %%GLOBAL statement for a job. Each statement is
added to the user-defined variable environment of the job.
Global members can also be placed in cache, which can significantly improve
performance if the member is used by many jobs. For more information, see Loading
%%GLOBAL Members to Cache on page 746, and the corresponding topic in the
INCONTROL for OS/390 and z/OS Administrator Guide.
If CONTROL-M fails to access the variable member (member not found, and so on),
the job is not submitted and a warning message is issued to the user who requested
the job.
The format of the %%GLOBAL control statement is:
/ / * %%GLOBAL memname
where memname is a valid member name of 1 through 8 characters.
Example
/ / * %%GLOBAL TAPES
/ / * %%GLOBAL CURRENCY
Control Statements
Chapter 5 JCL and AutoEdit Facility 761
%%GOTO and %%LABEL
%%GOTO and %%LABEL control statements provide the AutoEdit facility with GO
TO logic, permitting simple inclusion or exclusion of job steps, DD statements, input
date, and so on.
The format of %%GOTO and %%LABEL statements is:
The %%GOTO statement transfers control to the location in the program designated
by a matching %%LABEL statement. The search for a matching %%LABEL labelname
is only performed downward (that is, loops are not supported).
All statements between a %%GOTO statement and its matching %%LABEL statement
are not processed (that is, no statements are submitted and AutoEdit statements are
not resolved).
%%GOTO and %%LABEL statements are generally used in conjunction with %%IF,
%%ELSE, and %%ENDIF control statements. Examples at the end of this chapter
demonstrate how these statements can be combined.
%%IF, %%ELSE, %%ENDIF
%%IF, %%ELSE, and %%ENDIF control statements provide the AutoEdit facility
with Boolean IF logic capability. These statements, in conjunction with %%GOTO
and %%LABEL control statements, permit branching based on submission time
criteria. Job steps, DD statements, and so on are easily excluded or included.
The format of %%IF, %%ELSE, %%ENDIF statements is:
where:
%%GOTO l abel name
%%LABEL l abel name
%%I F condi t i onal - expr essi on
st at ement s
[ %%ELSE]
st at ement s
%%ENDI F
Control Statements
762 CONTROL-M for OS/390 and z/OS User Guide
s conditional-expression is the condition that determines whether the accompanying
statements are performed. If the condition is satisfied, the statements
accompanying the %%IF statement are performed and the statements
accompanying the %%ELSE statement (if specified) are not performed. If the
condition is not satisfied, the statements accompanying the %%ELSE statement (if
specified) are performed and the statements accompanying the %%IF statement
are not performed.
The format of a conditional-expression is:
operand operator operand
where:
operand Any character string. It can contain AutoEdit terms.
operator One of the valid comparison operators listed below. Valid operators:
s EQ is equal to
s NE is not equal to
s GT is greater than
s GE is greater than or equal to
s LT is less than
s LE is less than or equal to
s statements are any statements specified in the JCL member, including AutoEdit
statements, JCL statements and non-JCL statements.
If an operand contains AutoEdit terms, they are resolved into a character string
before the conditional expression is analyzed.
An operand must not resolve to a null value (as in CLISTs). If it is possible that an
operand resolves to a null value, place a character before the first and second
operands in a way that would not affect the comparison. For example, if %%A
and/ or %%C in the statement:
%%I F %%A GT %%C
might resolve to null, use a substitute expression such as:
%%I F B%%A GT B%%C
Operands are compared as character strings from left to right. For example:
91 is greater than 1000 (because 9 is greater than 1).
An %%IF expression must be terminated with an %%ENDIF statement. If an %%IF
expression is not terminated in this way, an %%ENDIF statement is implied as the
last statement in the member.
Control Statements
Chapter 5 JCL and AutoEdit Facility 763
The %%ELSE statement is optional.
When the %%IF expression is true, all JCL statements (including non-AutoEdit
statements) between the %%IF expression and its %%ELSE statement (or its matching
%%ENDIF statement when no %%ELSE statement is present) are submitted by
CONTROL-M provided that all AutoEdit variables are resolved.
When the %%IF expression is not true and an %%ELSE statement exists, only
statements between the %%ELSE statement and the matching %%ENDIF statement
are submitted.
%%IF statements can be nested.
Example
Up to 100 nested %%IF statements can be specified.
%%I F expr essi on
%%I F expr essi on
st at ement s
.
[ %%ELSE ]
.
%%ENDI F
%%ELSE
%%I F expr essi on
st at ement s
.
[ %%ELSE ]
.
%%ENDI F
%%ENDI F
Control Statements
764 CONTROL-M for OS/390 and z/OS User Guide
%%INCLIB and %%INCMEM
%%INCLIB and %%INCMEM statements contain two elements that together describe
the member that is to be included in the current job stream, as follows:
s The %%INCLIB part of the statement defines the location of the member as one of
the following:
the library name
the DD name to be associated with a library or concatenation of libraries
s The %%INCMEM part of the statement defines the member.
These statements are useful for inserting the following types of information into the
JCL:
s JCL statements and parameters to be passed to the JCL (for example, sysin)
s AutoEdit control statements, including other %%INCLIB and %%INCMEM
statements
The format of the statement is:
%%I NCLI B [ l i bname | DDNAME=ddname ] %%I NCMEM memname
In this statement
s libname is a valid data set name, from 1 through 44 characters in length, of a
cataloged partitioned data set (library) with a record length of 80
s ddname is a valid DD name from 1 through 8 characters in length that points to a
cataloged library or concatenation of cataloged libraries
This DD name must be preallocated to the environment in which the %%INCLIB
statement is to be resolved, such as the CONTROL-M monitor or the IOA online
logon procedures.
s memname is a valid member name from 1 through 8 characters in length
You can specify multiple %%INCLIB and %%INCMEM statements in a job.
More than one job may contain identical %%INCLIB and %%INCMEM statements,
permitting maintenance of common, standardized code.
The %%INCMEM member is read by the CONTROL-M monitor just before job
submission, and the contents of the member are submitted as part of the current job.
As a result
Control Statements
Chapter 5 JCL and AutoEdit Facility 765
s a member created by one job in the job stream can be used by a later job in the job
stream
s if a job in the job stream updates a member and the member is subsequently used
by a later job in the job stream, the later job accesses the updated member
If the %%INCLIB statement is resolved within the JCL, ensure that there are no
unnecessary blank lines in the %%INCMEM member.
If CONTROL-M fails to access the included member (member not found, and so on),
the job is not submitted and a warning message is issued.
%%LIBSYM and %%MEMSYM
%%LIBSYM and %%MEMSYM control statements define a library and a member that
contain a set of user-defined variables and their assigned values. The member is read
by CONTROL-M before submission, and its content is added to the user-defined
variable environment of the job.
It is possible to specify more than one %%LIBSYM or %%MEMSYM statement for one
job. Each statement is added to the user-defined variable environment of the specific
job.
If CONTROL-M fails to access the variable member (member not found, security
constraints, and so on), the job is not submitted and a warning message is issued to
the user who requested the job.
The format of the statement is:
%%LI BSYM l i bname %%MEMSYM memname
where:
s libname Valid data set name of 1 through 44 characters. It must be a cataloged
partitioned data set (library) with a record length of 80.
s memname Valid member name of 1 through 8 characters.
%%RANGE
A %%RANGE statement limits the handling of AutoEdit functions and variables to a
specified column range. The contents of all columns outside the range remain
unchanged.
Control Statements
766 CONTROL-M for OS/390 and z/OS User Guide
This statement is useful when values must be specified in specific columns and when
not every AutoEdit statement need be resolved.
The format of the statement is:
%%RANGE f r omcol t ocol
where:
s fromcol First column in the range. Valid values are: 1 through 80. The default
(without a range statement) is 1.
s tocol Last column in the range. Valid values are: 1 through 80. tocol must be a
value equal to or greater than fromcol. The default (without a range statement)
is 72.
The %%RANGE statement can prevent the shifting of constants and variables that
appear after an AutoEdit variable in the same line. By limiting AutoEdit resolution to
a specified range, all constants and variables outside the specified range are kept in
their original positions regardless of the length of the resolved variables.
Each %%RANGE statement is valid until a new %%RANGE statement is specified.
Note, however, that the placement of the subsequent %%RANGE statement must be
within the column range of the preceding %%RANGE statement (or it is not
recognized as an AutoEdit statement).
Example
This example shows how a %%RANGE statement affects the resolution of a line. In
the original JCL, the %%RANGE statement affects the second occurrence of the
AutoEdit variable, but not the first. In the submitted JCL, note the impact on the
positioning of constant CONSTANT.
The original JCL:
NOTE
The minimum length of a %%RANGE statement with 2-digit fromcol and tocol
values is 12 characters. Do not, therefore, specify a range of fewer than 12 columns, or
you cannot use a subsequent %%RANGE statement to expand the range back to the
regular line length.
/ / * %%SET %%A_VERY_LONG_VARI ABLE=XXX
%%A_VERY_LONG_VARI ABLE CONSTANT
/ / * %%RANGE 1 25
%%A_VERY_LONG_VARI ABLE CONSTANT
Control Statements
Chapter 5 JCL and AutoEdit Facility 767
The submitted JCL:
%%RESOLVE
By default, CONTROL-M must resolve all AutoEdit terms in the JCL or the job is not
submitted. This default can be overridden by specifying an appropriate
%%RESOLVE statement in the JCL.
Valid %%RESOLVE statements are:
/ / * %%SET %%A_VERY_LONG_VARI ABLE=XXX
XXX CONSTANT
/ / * %%RANGE 1 25
XXX CONSTANT
Table 238 %%RESOLVE Statements (Part 1 of 2)
Statement Description
%%RESOLVE NO Try to resolve AutoEdit terms. If an AutoEdit term cannot
be resolved, submit the job with the AutoEdit term as is.
%%RESOLVE YES
%%RESOLVE MUST
%%RESOLVE (blank)
If YES, MUST or blank is specified and a subsequent
AutoEdit term cannot be resolved, the job is not submitted.
%%RESOLVE OFF Do not try to resolve AutoEdit terms except for other
%%RESOLVE statements. Submit the job with AutoEdit
terms as is.
Each %%RESOLVE statement remains in effect until the next %%RESOLVE
statement in the JCL is encountered.
Control Statements
768 CONTROL-M for OS/390 and z/OS User Guide
The following special case %%RESOLVE statement is relevant if %%GLOBAL
AutoEdit members are loaded to cache.
%%RESOLVE
ALLCACHE {OFF |
ON}
If an AutoEdit variable has not been resolved by searching
the %%GLOBAL members identified in the job, the
%%RESOLVE ALLCACHE statement instructs
CONTROL-M to continue the variable resolution process
by checking all members loaded into cache. Members in
cache are searched in the same sequence they are listed in
the cache list member.
A %%RESOLVE ALLCACHE statement without an ON or
OFF qualifier can only be specified as the first
non-comment statement in the cache list member used to
load %%GLOBAL members to cache. For more
information, see Loading %%GLOBAL Members to
Cache on page 746.
A %%RESOLVE ALLCACHE statement with an ON or
OFF qualifier can be specified anywhere in the JCL of the
job. It overrides the most current %%RESOLVE
ALLCACHE function, as follows:
s %%RESOLVE ALLCACHE ON Activates the
%%RESOLVE ALLCACHE function.
s %% RESOLVE ALLCACHE OFF Deactivates the
%%RESOLVE ALLCACHE function.
Table 238 %%RESOLVE Statements (Part 2 of 2)
Statement Description
Control Statements
Chapter 5 JCL and AutoEdit Facility 769
%%SET
A %%SET control statement sets the values of user-defined variables. The statement
may be placed in any part of the JCL stream.
The format of the statement is:
%%SET %%var name=expr essi on
where:
s varname a valid user-defined variable
s expression must resolve to a value according to the rules described in Rules of
Variable Resolution earlier in this chapter or submission of the job is canceled
(unless a %%RESOLVE NO control statement is specified). An expression can
consist of a:
value (for example, 5)
variable (for example, %%ODATE)
a combination of values, variables, operators, functions, and so on (for example,
%%GENERATION_NUMBER %%PLUS 1).
Example 1
%%SET %%BACKUP_UNI T=TAPE
User-defined variable %%BACKUP_UNIT is assigned the value TAPE.
Example 2
%%SET %%BACKUP_UNI T_%%WDAY=EE%%OMONTH. %%ODAY
On Monday the 24th of September, user-defined variable %%BACKUP_UNIT_1 is
assigned the value EE0924.
Example 3
When the initial value of SCRATCH is 3017, the result in the submitted member is:
/ / * %%SET %%SCRATCH=%%SCRATCH %%PLUS 1
/ / SYSUT1 DD UNI T=TAPE, VOL=SER=EE%%SCRATCH, DI SP=. . .
/ / * %%SET %%SCRATCH=3017 %%PLUS 1
/ / SYSUT1 DD UNI T=TAPE, VOL=SER=EE3018, DI SP=. . .
Operators
770 CONTROL-M for OS/390 and z/OS User Guide
Operators
AutoEdit operators are used to add or subtract values from AutoEdit variables in the
JCL. These operators can only be specified in a %%SET statement. Valid AutoEdit
operators are:
AutoEdit operators are generally used as follows:
%%SET var i abl e=oper and oper at or oper and
where:
s operand Expression that resolves to a numeric value.
s operator %%PLUS or %%MINUS.
Only one operator can be specified in each %%SET statement.
Example
Increase the number of generations (%%GENERATION_NUMBER) by one:
/ / %%SET %%GENERATI ON_NUMBER=%%GENERATI ON_NUMBER %%PLUS 1
If the value of %%GENERATION_NUMBER was initially 1, it is set to 2.
Functions
AutoEdit functions perform operations on specified AutoEdit variables in the JCL.
These functions can only be specified in %%SET statements. The following AutoEdit
functions are supported by CONTROL-M:
Table 239 AutoEdit Operators
Operator Description
%%PLUS Adds a value to an AutoEdit variable.
%%MINUS Subtracts a value from an AutoEdit variable.
Functions
Chapter 5 JCL and AutoEdit Facility 771
%%$CALCDTE
The %%$CALCDTE function performs date manipulation by adding or subtracting a
specified number of days from a specified date.
The format of the %%$CALCDTE function is:
%%$CALCDTE dat e [ quant i t y_t ype] quant i t y
where:
s date must be (or resolve to) a date in format yyyymmdd
s quantity_type optional 1-character description of the type of data specified as
quantity
Valid values are:
D days
M months
Y years
If no value is specified, the default value is D (days).
s quantity number (or numeric AutoEdit expression) of date units, depending on
the value specified for quantity_type to add to or subtract from the date
Valid values are: 1 through 999.
Example 1
/ / * %%SET %%A=%%$CALCDTE %%$ODATE - 1
If the original scheduling date is February 1, 2001, %%A is assigned a value of
20010131.
NOTE
This function replaces the old %%CALCDATE function, which is still supported for
backward compatibility. BMC Software recommends that you use the
%%$CALCDTE function rather than the %%CALCDATE function, to take advantage
of its increased versatility.
NOTE
In setting values for the quantity_type and quantity variables, ensure that the final
date is not later than the year 2054.
Functions
772 CONTROL-M for OS/390 and z/OS User Guide
Example 2
/ / * %%SET %%A=%%$CALCDTE %%$ODATE +M1
If the original scheduling date is January 30, 2002, %%A is assigned a value of
20020228.
Example 3
/ / * %%SET %%A=%%$CALCDTE %%$ODATE +Y1
If the original scheduling date is February 29, 2000, %%A is assigned a value of
20010228.
%%$GREG
The %%$GREG function converts a Julian date (with a 4-character year) to a
Gregorian date (with a 4-character year). The format of function %%$GREG is:
%%$GREG dat e
where date must be (or resolve to) a date in Julian format yyyyddd.
Example
/ / * %%SET %%A=%%$GREG 201196
%%A is assigned a value of 20010714
%%$JULIAN
The %%$JULIAN function converts a Gregorian date (with a 4-character year) to a
Julian date (with a 4-character year). The format of the %%$JULIAN function is:
%%$JULI AN dat e
NOTE
If as a result of adding months to a date, the number of days exceeds the maximum
number of days possible in the resulting month, CONTROL-M reduces the number of
days to the actual maximum.
Functions
Chapter 5 JCL and AutoEdit Facility 773
where date must be (or resolve to) a date in format yyyymmdd.
Example
/ / * %%SET %%A=%%$JULI AN 20010717
%%A is assigned a value of 2001197
%%$LEAP
The %%$LEAP function determines whether a specified Gregorian date (with a
4-character year) falls in a leap year. If the date is in a leap year, the variable resolves
to 1. If the date is not in a leap year, the variable resolves to 0. The format of the
%%$LEAP function is:
%%$LEAP dat e
where date must be (or resolve to) a date in format yyyymmdd.
Leap years are years whose last two digits are evenly divisible by 4, excluding those
years that are divisible by 100 but not by 400. Therefore, 2000 is a leap year but the
years 2100, 2200 and 2300 are not.
Example
/ / * %%SET %%A=%%$LEAP %%$ODATE
%%A is assigned a value of 1 for dates in the year 2000 and 0 for dates in the year
2001.
%%$WCALC
The %%$WCALC function performs a shift from the specified date to a working date
in the specified calendar, according to indicated instructions. The format of the
%%$WCALC function is:
%%$WCALC dat e i nst r uct i on cal endar
where:
s date must be (or resolve to) a date in format yyyymmdd
Functions
774 CONTROL-M for OS/390 and z/OS User Guide
s instruction shift instructions.
Valid values are:
+n Shift to the next nth working date in the calendar.
n Shift to the previous nth working date in the calendar.
> If the specified date is not a current working date, shift to the next working
date in the calendar. (If the specified date is a working date, do not shift.)
< If the specified date is not a current working date, shift to the previous
working date in the calendar. (If the specified date is a working date, do not
shift.)
s calendar name of the calendar to check for working dates
Example
s If calendar EXCPTCAL (for 2001) contains consecutive working dates 07/ 13 and
07/ 20, %%A resolves to 20000720 in both %%SET statements.
s If calendar EXCPTCAL (for 2001) contains consecutive working dates 07/ 17 and
07/ 24:
In the first %%SET statement (with the +1), %%A resolves to 20000724.
In the second %%SET statement (with the >), %%A resolves to 20000717.
%%$WEEK#
The %%$WEEK# function calculates in which week of the year (1 through 53) a
specified date falls. The function uses the site-defined start of the week (Sunday or
Monday) as the first day of each week, and assumes that January 1st falls in the first
week.
This function ensures that every day of the year falls into a week of that year, but it
also means that the first week of the year may possibly have a majority of its days
come from December of the preceding year.
/ / * %%SET %%A=%%$WCALC 20000717 +1 EXCPTCAL
/ / * %%SET %%A=%%$WCALC 20000717 > EXCPTCAL
Functions
Chapter 5 JCL and AutoEdit Facility 775
(By contrast, the %%$YEARWK# AutoEdit function, which also calculates in which
week of a year a date falls, counts the week that includes January 4th as the first week.
This ensures that the first week in the year has a majority of its days in January.
However, it also means that the first days of the year may possibly belong to the last
week of the preceding year, and the last days of the year may possibly belong to the
first week of the following year.)
The format of the %%$WEEK# function is:
%%$WEEK# dat e
where date is the date in format yyyymmdd (a 4-character year must be specified).
Example
/ / * %%SET %%A=%%$WEEK# 20010712
%%A is assigned a value of 28
%%$WEEKDAY
The %%$WEEKDAY function calculates on which day of the week a specified date
(with a 4-character year) falls. The resolved value is an integer from 1 through 6 or 0,
where 1 corresponds to the first day of the week (Sunday or Monday, depending on
the site-standard) and 0 corresponds to the last day of the week (Saturday or Sunday).
The format of the %%$WEEKDAY function is:
%%$WEEKDAY dat e
where date must be (or resolve to) a date in format yyyymmdd.
Example
/ / * %%SET %%A=%%$WEEKDAY 20000714
%%A is assigned a value of 6 (Friday)
Functions
776 CONTROL-M for OS/390 and z/OS User Guide
%%$YEARWK#
The %%$YEARWK# function calculates in which week of the year (1 through 53) a
specified date falls, and returns the year and the week number according to ISO8601
standards. In accordance with those standards, the function uses Monday as the first
day of each week (this is so even if the start of the week at your site is defined as
Sunday).
The %%$YEARWK# function assumes that the first week is the week that includes
January 4th
This function ensures that the first week in the year has a majority of its days in
January. However, it also means that the first days of the year may possibly belong to
the last week of the preceding year, and the last days of the year may possibly belong
to the first week of the following year.
By contrast, the %%$WEEK# AutoEdit function, which also calculates in which week
of a year a date falls, counts the week that includes January 1st as the first week. This
ensures that every day of the year is part of a week of that year. However, it also
means that the first week of the year may possibly have a majority of its days in
December of the preceding year.
The format of the %%$YEARWK# function is:
%%$YEARWK# dat e
where date is the date in format yyyymmdd (a 4-character year must be specified).
The value returned by the function is in the format:
yyyyWnn
where:
s yyyy year in which the week falls
s nn number of the week within the year
Example 1
/ / * %%SET %%A=%%$YEARWK# 20010214
%%A is assigned a value of 2001W06
Functions
Chapter 5 JCL and AutoEdit Facility 777
Example 2
/ / * %%SET %%A=%%$YEARWK# 20050101
%%A is assigned a value of 2004W52
Example 3
/ / * %%SET %%A=%%$YEARWK# 20011231
%%A is assigned a value of 2002W01.
%%CALCDATE
The %%CALCDATE function performs date manipulation by adding or subtracting a
specified number of days from a specified date.
The format of the %%CALCDATE function is:
%%CALCDATE dat e quant i t y
where:
s date must be (or resolve to) a date in format yymmdd
s quantity number (or numeric AutoEdit expression) of days (from 1 to 366) to add
to or subtract from the date
Example
/ / * %%SET %%A=554CALCDATE %%$ODATE - 1
If the original scheduling date is February 1, 2002, %%A is assigned a value of 020131.
NOTE
The %%CALCDATE function is supported for backward compatibility. BMC
Software recommends that you use the %%$CALCDTE function instead.
Functions
778 CONTROL-M for OS/390 and z/OS User Guide
%%SUBSTR
The %%SUBSTR function extracts a substring from a string.
The format of the %%SUBSTR function is
%%SUBSTR st r i ng st ar t pos l engt h
where
s string string from which the substring is extracted
s startpos character position in the original string from which the extraction begins
s length number of characters to extract
A new string is created composed of the characters extracted from the original string.
startpos and length must be a numeric value or AutoEdit expression that is greater
than zero.
When the starting position of the substring is greater than the argument string, the
function returns a null value.
When the starting position of the substring falls within the argument string, but the
length of the substring falls outside the range of the argument string (startpos + length
1), the function returns a substring containing the characters from the starting
position.
If the character positions of startpos + length 1 is greater than the string length,
submission of the member is stopped.
Example 1
On July 1, 2001:
%%A is assigned a value of 20010630
%%AMON is assigned a value of 06
/ / * %%SET %%A=%%$CALCDTE %%$ODATE - 1
/ / * %%SET %%AMON=%%SUBSTR %%A 5 2
Functions
Chapter 5 JCL and AutoEdit Facility 779
Example 2
%%SET %%A=%%SUBSTR CABLE 4 4
resolves to
%%A=LE
%%$LENGTH
The %%$LENGTH function returns the length of a character string.
The format of the %%$LENGTH function is
%%$LENGTH char _st r i ng
where char_string is, or resolves to, any character string.
Example
/ / * %%SET %%A=%%$LENGTH A123
%%A is assigned a value of 4.
%%$TYPE
The %%$TYPE function returns the type attribute of a character string. Possible type
attributes are:
s N numeric
s M negative numeric
s C character
s X alphanumeric
s 0 undefined or 0 length
The format of the %%$TYPE function is
%%$TYPE char _st r i ng
where char_string is, or resolves to, any character string.
Functions
780 CONTROL-M for OS/390 and z/OS User Guide
Example 1
/ / * %%SET %%A=%%$TYPE A123
%%A is assigned a value of X
Example 2
/ / * %%SET %%B=%%$TYPE XYZ
%%B is assigned a value of C
Example 3
/ / * %%SET %%C=%%$TYPE - 1239
%%C is assigned a value of M
%%$FUNC
%%$FUNC is an AutoEdit function that enables the creation of user-defined
functions. You can only use the %%$FUNC function as part of an AutoEdit %%SET
statement.
The syntax for such use of the %%$FUNC function is
%%SET out put _char _st r i ng = %%$FUNC f unc_name i nput _char _st r i ng
In its operation, it is equivalent to using assembler language to issue the following
CALL instruction
CALL f unc_name, ( i nput _char _st r i ng, out put _char _st r i ng)
In this instruction
s func_name is the name of the user-coded program module
s input_char_string is a string consisting of two parts in the following order:
the length of the source string
the source string
s output_char_string is a string consisting of two parts in the following order:
the length of the result string
the result string returned by func_name
Functions
Chapter 5 JCL and AutoEdit Facility 781
The AutoEdit processor passes these parameters as variable-length strings. Each
string consists of a half-word binary length field followed by the string itself. The
func_name program must return the output string in the same format, as illustrated in
the example below.
The source string can contain AutoEdit variables. If it does, these variables are
resolved before the function is activated.
The maximum length of the source string, after resolving any AutoEdit variables, is
240 characters.
The maximum length of the result string is also 240 characters.
Neither the source string nor the result string can contain non-displayable characters.
You can use AutoEdit simulation to test your program module. For more
information, see M2: Perform an AutoEdit Simulation on page 325.
Example
The user has a multiply function that is performed by a module named MULT.
The users JCL contains the following AutoEdit statements:
The last %%SET statement causes the CONTROL-M monitor to call the MULT
module as follows (using assembler notation):
CALL MULT, ( PRM1, PRM2)
NOTE
You can define your func_name program module as resident. A resident program
module is loaded once, kept in the storage, and entered by means of either the CALL
instruction or a LINK instruction. If you want to do this, the program module must
comply with both the following conditions:
s It must be able to work in AMODE 31.
s It must be reentrant.
To define program modules as resident, include them in the cache members list using
the following definition syntax:
%%$FUNC f unc_name
%%SET %%A = 20
%%SET %%B = 30
%%SET %%C = %%$FUNC MULT %%A %%B
Testing AutoEdit Syntax
782 CONTROL-M for OS/390 and z/OS User Guide
The PRM1 and PRM2 parameters are passed to MULT in the following format:
The MULT program returns results by updating the value of the second parameter,
PRM2, as follows:
The result is that the AutoEdit variable %%C is assigned a character value of 600.
Testing AutoEdit Syntax
When CONTROL-M detects an AutoEdit syntax error in a JCL member during
submission, the submission is canceled by CONTROL-M. Therefore, it is essential to
check the syntax of AutoEdit statements while the member is being prepared.
Furthermore, when the syntax is correct, you may want to verify that the AutoEdit
statements return the desired results. For example, you may want to check that you
specified the correct AutoEdit date variables for a job that performs end-of-year
processing.
The CTMAESIM utility tests AutoEdit syntax and JCL setup. This utility simulates
the actions of the CONTROL-M submission mechanism, which performs AutoEdit
processing and JCL setup, and produces a printed report of the process.
CONTROL-M has a customized interface with the JOB/ SCAN product. However,
this utility can be used with any JCL-checking product.
The CTMAESIM utility can operate in either JCL Library mode or Scheduling Library
mode:
s In JCL Library mode, the utility checks the AutoEdit statements in the jobs JCL.
s In Scheduling Library mode, the utility not only checks the AutoEdit statements in
the jobs JCL of the job, it also checks the impact that SET VAR statements in the job
scheduling definition have on the JCL of the job.
The utility enables system programmers to check the operation of CONTROL-M
submission exit CTMX002 without affecting production.
PRM1 DC H' 5'
DC C' 20 30'
PRM2 DC H' 0'
DC CL240' '
PRM2 DC H' 3'
DC C' 600'
Testing AutoEdit Syntax
Chapter 5 JCL and AutoEdit Facility 783
The CTMAESIM utility can be activated by a batch procedure or the Online facility,
as follows:
s Batch procedure using procedure CTMAESIM
s Online facility using option M2 in the Online Utilities menu or using CLIST
CTMCAES
The utility requires specification of various parameter statements that determine how
the simulation works, and which provide necessary information for the simulation.
Although the simulation works in much the same manner whether activated by a
batch procedure or online, the following differences depend on the method of
activation:
s Batch activation allows specification of multiple sets of parameter statements.
Online activation allows specification of only one set of parameter statements.
s Batch activation allows inclusion or omission of parameter RDR=INTRDR
(described below). This parameter cannot be specified online.
s Command JSCAN (available only at sites where JOB/ SCAN is installed) can only
be specified if the utility is activated through the Online Utilities menu. It cannot
be specified if the utility is activated by batch or by CLIST CTMCAES.
s Character masking is not supported in the Online utility. In the batch utility,
character masking is supported for the member name in JCL Library mode, and for
the job name in Scheduling Library mode. Valid mask characters are:
s * Represents any number of characters (including no characters)
s ? Represents any one character
s The SET VAR parameter, which can be specified outside the job scheduling
definition, is supported in batch mode only. However, SET VAR statements in the
job scheduling definition can be checked in both online and batch mode.
s The CONTROL-M GLOBAL LIBRARY parameter is specified only in the Online
utility, and only one library can be specified. In batch mode, global libraries are
referenced by the DAGLOBAL DD statement (multiple libraries can be
concatenated).
In addition, depending on the command type specified in a parameter statement, the
resulting JCL lines can also be written to the output file referenced by the DASUBMIT
DD statement.
When the JCL is written to the output file referenced by the DASUBMIT
DD statement, the output file can be routed to an internal reader by specifying the
parameter RDR=INTRDR in the EXEC statement. In this case, the DASUBMIT
DD statement is allocated as SYSOUT=(class,INTRDR) and the job is submitted.
AutoEdit Usage in the Job Scheduling Definition
784 CONTROL-M for OS/390 and z/OS User Guide
Submission of the job enables the JCL to be checked by the JCL checking mechanism
of MVS.
When activated using ISPF, the functioning of the utility is similar to its functioning
when activated from batch with the parameter RDR=INTRDR specified.
The CTMAESIM utility, as activated from the Online facility, is described in Chapter
2, Online Facilities. The CTMAESIM utility, as activated through a batch
procedure, is described in the INCONTROL for OS/390 and z/OS Utilities Guide.
AutoEdit Usage in the Job Scheduling
Definition
Certain AutoEdit components can be used in job scheduling definitions. In job
scheduling definitions, AutoEdit components in certain statements (SET VAR and
DO SET) directly affect JCL. In other statements (SYSOUT and DO SYSOUT, SHOUT
and DO SHOUT, MEMLIB and OVERLIB) they do not affect the JCL.
In the job scheduling definition, AutoEdit components can be specified in the
following parameters:
s SET VAR and DO SET statements
These two job scheduling definition statements and the %%SET control statements
are used to assign values to user-defined variables in the JCL.
Example
In this example, AutoEdit statements in the job scheduling definition and the JCL
allocate space for the job. If the job abends due to insufficient space, the AutoEdit
statements adjust the allocated space and rerun or restart the job.
The following step in the jobs JCL sets the quantity of available space to five units
of whatever type (track or cylinder) is specified in the job scheduling definition.
/ / STEP10 EXEC PGM=MYPGM
/ / OUTFI LE DD DSN=NEWFI LE, DI SP=( NEW, CATLG, DELETE) ,
/ / SPACE=( %%SPACE_TYPE, 5) , UNI T=SYSDA
NOTE
A DASUBMIT DD statement can also be used by the AutoEdit Simulation facility to
submit jobs for execution in emergency situations (for example, the CONTROL-M
monitor is inoperative due to a severe technical problem).
AutoEdit Usage in the Job Scheduling Definition
Chapter 5 JCL and AutoEdit Facility 785
The job scheduling definition contains the following SET VAR statement that sets
the space type to track:
SET VAR %%SPACE_TYPE=TRK
In this case, the second line in the above DD statement resolves to:
/ / SPACE=( TRK, 5) , UNI T=SYSDA
The job scheduling definition also contains the following statements that are
activated if the job abends due of lack of space (code S*37). These statements
change the space type to cylinder, which provides enough space, and rerun the
job. If CONTROL-M/ Restart is active, the job is restarted from the abended step.
ON STEP STEP10 CODES S* 37
DO SET %%SPACE_TYPE=CYL
[ DO I FRERUN FROM $ABEND] ===> I f CONTROL- M/ Rest ar t i s act i ve
DO RERUN
If the job abends as above, the second line of the earlier JCL DD statement resolves
to:
/ / SPACE=( CYL, 5) , UNI T=SYSDA
when the job is submitted for rerun (or restart).
s SYSOUT and DO SYSOUT
File names for SYSOUT and DO SYSOUT handling can be specified using
AutoEdit variables whenever SYSOUT option F (copy to file or sysout archiving) is
specified. For example:
SYSOUT OP F PRM GPL. %%JOBNAME. D%%ODATE. %%JOBI D. T%%TI ME
s SHOUT, DO SHOUT, and DO MAIL
System AutoEdit variables can be used in shouted messages. For example:
MSG JCL ERROR I N JOB %%JOBI D %%STEP
s MEMLIB and OVERLIB
System AutoEdit variables and variables defined in SET VAR parameters can be
used in the MEMLIB and OVERLIB fields to specify the appropriate library.
Examples of this usage are shown on the following pages.
s IN, OUT, and DO COND
AutoEdit Usage in the Job Scheduling Definition
786 CONTROL-M for OS/390 and z/OS User Guide
AutoEdit variable %%$GRID is resolved.
Examples
Chapter 5 JCL and AutoEdit Facility 787
Examples
Date Variables
The original JCL:
The JCL submitted on June 6, 2001:
ODATE, RDATE and DATE Usage
The original JCL:
Table 240 Date Variables
Original Scheduling Current Working Computer Format
%%ODATE %%RDATE %%DATE yymmdd
%%ODAY %%RDAY %%DAY dd
%%OMONTH %%RMONTH %%MONTH mm
%%OYEAR %%RYEAR %%YEAR yy
%%OWDAY %%RWDAY %%WDAY n (0-6)
%%OJULDAY %%RJULDAY %%JULDAY jjj
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / STEP01 EXEC PDUPDATE
/ / SYSI N DD *
%%DATE
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / STEP01 EXEC PDUPDATE
/ / SYSI N DD *
010606
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
. . . .
/ / STEP02 EXEC PDPRI NT, BUSDATE=%%ODATE
/ / SYSI N DD *
EXAMPLE- RDATE=%%RDATE
EXAMPLE- DATE=%%DATE
/ /
Examples
788 CONTROL-M for OS/390 and z/OS User Guide
On July 24th, we need to run the 22nd, 23rd, and 24th (of the same job) because of
delays. On the Active Jobs file we can find three job orders:
The job of the 22nd is submitted on July 24th at 2300. The result is:
The job of the 23rd is submitted on July 25th at 0025. The result is:
The job of the 24th is submitted on July 25th, 2001 at 0300. The result is:
How to Obtain Date Formats 1
Format ddmmyy:
Lets follow the variable substitution by stages for June 24, 2001:
PDPA0001 of 010722
PDPA0001 of 010723
PDPA0001 of 010724
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
. . . .
/ / STEP02 EXEC PDPRI NT, BUSDATE=010722
/ / SYSI N DD *
EXAMPLE- RDATE=010724
EXAMPLE- DATE=010724
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
. . . .
/ / STEP02 EXEC PDPRI NT, BUSDATE=000723
/ / SYSI N DD *
EXAMPLE- RDATE=010724
EXAMPLE- DATE=010725
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
. . . .
/ / STEP02 EXEC PDPRI NT, BUSDATE=000724
/ / SYSI N DD *
EXAMPLE- RDATE=010724
EXAMPLE- DATE=010725
/ /
%%ODAY. %%OMONTH. %%OYEAR
%%ODAY. %%OMONTH. 01
%%ODAY. 06. 01
%%ODAY. 0601
24. 0601
240601
Examples
Chapter 5 JCL and AutoEdit Facility 789
Remember Variable substitution is performed from right to left.
A period (.) between two AutoEdit variables is omitted.
How to Obtain Date Formats 2
Format dd mmm yy (where mmm is the month in character format):
The original JCL:
The CHARMON member (in the CONTROL-M Global library) contains:
The symbols substitution by stages:
The submitted member:
How to Obtain Date Formats 3
Format ddmmmyy (where mmm is the month in character format):
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%GLOBAL CHARMON
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%ODAY %%MONTH_I N_CHAR_%%OMONTH %%OYEAR
/ /
*
* MONTHS I N CHAR FORMAT
*
%%MONTH_I N_CHAR_01=JAN
%%MONTH_I N_CHAR_02=FEB
%%MONTH_I N_CHAR_03=MAR
.
.
%%MONTH_I N_CHAR_12=DEC
%%ODAY %%MONTH_I N_CHAR_%%OMONTH 00
%%ODAY %%MONTH_I N_CHAR_06 00
%%ODAY JUN 00
24 JUN 00
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%GLOBAL CHARMON
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
24 JUN 00
/ /
Examples
790 CONTROL-M for OS/390 and z/OS User Guide
According to the preceding example, we might try the following original JCL:
Variable substitution by stages would proceed as follows:
However, this results in the following error: Symbol %%MONTH_I N_CHAR_0601 i s
not r esol ved.
This error would not have occurred had we tried the following original JCL:
How to Obtain the Previous Months Last Business Date
The LBUSMON member in the CTM.LIB.SYMBOLS library contains:
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%GLOBAL CHARMON
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%ODAY. %%MONTH_I N_CHAR_%%OMONTH. %%OYEAR
/ /
%%ODAY %%MONTH_I N_CHAR_%%OMONTH. 00
%%ODAY %%MONTH_I N_CHAR_06. 01
%%ODAY %%MONTH_I N_CHAR_0601
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%GLOBAL CHARMON
/ / * %%SET %%A=%%MONTH_I N_CHAR_%%OMONTH
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%ODAY. %%A. %%OYEAR
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM LBUSMON
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_%%OMONTH. %%OYEAR
/ /
*
* LAST BUSI NESS DATE I N THE PREVI OUS MONTH
*
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_0101=001231
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_0201=010131
.
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_0601=010531
.
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_1201=011130
.
.
Examples
Chapter 5 JCL and AutoEdit Facility 791
Variable substitution by stages (during June 2001):
Automatic Job Order for the Next Day
In many data centers it is necessary to run certain jobs ahead of time on a regular
basis (such as run today with the business date of tomorrow). The %%$CALCDTE
and %%SUBSTR functions can be used to permit automatic scheduling of such jobs
on a daily basis by the CONTROL-M monitor. (The output is in mmddyy format.)
The %%$CALCDTE and %%SUBSTR AutoEdit functions can be used for any date
calculation that is needed in a production environment.
If you want to use the WAIT FOR ODATE option, which is described in WAIT FOR
ODATE on page 154, you can use the WAITODATE(YES) parameter.
For example
CTMCJOBS SCHEDLI B( CTM. LI B. SCHEDULE) TABLE( SDP00) -
ODAT( %%M. %%D. %%Y WAI TODAT( YES)
causes the job to wait for a specific date before being processed.
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_%%OMONTH. 00
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_06. 01
%%LAST_BUSI NESS_DATE_I N_PREV_MONTH_OF_0601
010531
NOTE
An alternate method, which avoids the need to use the MEMSYM member, requires
the use of the %%$WCALC function with the standard working day calendar. For
details, see %%$WCALC on page 773.
/ / TOMDAI LY JOB ( . . . . ) , BI LL, CLASS=A
/ / * %%SET %%A=%%$CALCDTE %%$ODATE +1
/ / * %%SET %%DD=%%SUBSTR %%A 7 2
/ / * %%SET %%MM=%%SUBSTR %%A 5 2
/ / * %%SET %%YY=%%SUBSTR %%A 3 2
/ / STEP01 EXEC PGM=I KJEFT01, REGI ON=1000K, DYNAMNBR=30
/ / SYSPRI NT DD SYSOUT=*
/ / SYSTSPRT DD SYSOUT=*
/ / SYSTSI N DD *
CTMCJOBS SCHEDLI B( CTM. LI B. SCHEDULE) TABLE( SDP00) -
ODAT( %%MM. %%DD. %%YY)
/ /
Examples
792 CONTROL-M for OS/390 and z/OS User Guide
Tape Clearance System Stage 1
The original JCL:
The member TAPES in the CTM.LIB.SYMBOLS library contains:
The submitted JCL:
The use of a central member for all external tapes is a very simple management tool.
The minute a tape arrives, its number is typed in the member, and the tape is sent to
the computer room. There is no need to keep the tapes at hand on the schedulers
table until the job is submitted. The function of receiving tapes can be centralized,
controlled, and independent of the production process.
Tape Clearance System Stage 2
The example provided on the previous page has one basic weakness. It cannot handle
delays. If a certain job does not run one day, and on the next day it must be run twice
(once for each execution day), there is a danger of overriding the tape number in the
control member. To solve this problem, lets improve our tape clearance system.
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM TAPES
/ / STEP02 EXEC PDI NP3
/ / S001. I NPUT DD VOL=SER=%%FEDERAL_BANK_TAPE
/ /
*
* EXTERNAL TAPES LI ST
*
%%FEDERAL_BANK_TAPE=045673
%%I RS_TAPE=XXXXX
%%STOCK_EXCHANGE_TAPE=YYYYYY
.
.
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM TAPES
/ / STEP02 EXEC PDI NP3
/ / S001. I NPUT DD VOL=SER=045673
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM TAPE%%OMONTH. %%ODAY
/ / STEP02 EXEC PDI NP3
/ / S001. I NPUT DD VOL=SER=%%FEDERAL_BANK_TAPE
/ /
Examples
Chapter 5 JCL and AutoEdit Facility 793
The TAPE0714 member in the CTM.LIB.SYMBOLS library contains:
There are other advantages:
s The ability to roll back several dates without losing the dynamic parameters.
s Complete documentation of a tapes usage.
Use a CONTROL-M job to automatically create a member, TAPEmmdd, for each
scheduling date, based on a master copy. For example:
Tape Management System
The original JCL:
:
*
* EXTERNAL TAPES LI ST
*
%%FEDERAL_BANK_TAPE=045673
%%I RS_TAPE=XXXXX
%%STOCK_EXCHANGE_TAPE=YYYYYY
.
.
/ / EXEC PGM=I EBCOPY
.
/ / SYSI N DD *
C I =I N, O=OUT
S M=( ( TAPES, TAPE%%OMONTH. %%ODAY) )
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. TAPES %%MEMSYM PDTAPES
/ / STEP02 EXEC PDBKP3
/ / S001. OUTPUT DD VOL=SER=%%PDTAPE_0001_%%OWDAY
/ /
Examples
794 CONTROL-M for OS/390 and z/OS User Guide
The PDTAPES member in the CTM.LIB.TAPES library contains:
We have created a cycle of seven tapes to be used by this application.
Dynamic Job Name
The required format:
/ / PDPAddxx JOB ( . . . . . . ) , BI LL, CLASS=A
where dd is the business day of the month, and xx varies according to the job in the
application.
The solution:
/ / PDPA%%ODAY%%. xx JOB ( . . . . . . ) , BI LL, CLASS=A
Controlling the Target Computer by Class
CONTROL-M can dynamically decide to which computer to send a job. The
following examples demonstrate the relation between CONTROL-M resource
acquisition parameters and local JCL standards implementation.
*
* TAPES OF DP APPLI CATI ON
*
%%PDTAPE_0001_1=045673
%%PDTAPE_0001_2=045683
%%PDTAPE_0001_3=045677
%%PDTAPE_0001_4=043433
%%PDTAPE_0001_5=045543
%%PDTAPE_0001_6=045556
%%PDTAPE_0001_7=045666
*
%%PDTAPE_0010_1=046600
NOTE
This example assumes that a $ generic resource was specified in the job scheduling
definition. For more information, see Resource Allocation in Multi-CPU
Environments on page 589
/ / * %%GLOBAL CLASSES
/ / PDPA0001JOB( . . . . . ) , BI LL, CLASS=%%FAST_CLASS_OF_%%$SI GN
Examples
Chapter 5 JCL and AutoEdit Facility 795
The CLASSES member in the CONTROL-M Global library contains:
Controlling the Target Computer by System Affinity
The SYSAFF member in the CONTROL-M Global library contains:
The submitted JCL (for CPU ID 2):
%%BLANKn Statement
A program expects to receive the day of the week and the time of day as structured
input:
s Day of the week in column 1
s Time of day in column 11
*
* DEFI NI TI ONS OF CLASSES I N THE COMPUTERS
*
%%FAST_CLASS_OF_1=A
%%FAST_CLASS_OF_2=D
%%FAST_CLASS_OF_3=K
%%SLOW_CLASS_OF_1=W
.
.
NOTE
This example assumes that a $ generic resource was specified in the job scheduling
definition. For more information, see Resource Allocation in Multi-CPU
Environments on page 589
/ / * %%GLOBAL SYSAFF
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ * J SYSAFF=%%NAME_OF_COMPUTER_%%$SI GN
*
* NAMES OF THE COMPUTERS
*
%%NAME_OF_COMPUTER_1=SYSA
%%NAME_OF_COMPUTER_2=SYSB
%%NAME_OF_COMPUTER_3=TEST
/ / * %%GLOBAL SYSAFF
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ * J SYSAFF=SYSB
Examples
796 CONTROL-M for OS/390 and z/OS User Guide
The original JCL:
The DAYTIME member in the CTM.LIB.SYMBOLS library contains the following
AutoEdit user symbols:
%%RANGE Statement
The original JCL:
The constant REPORT must be in column 40.
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM DAYTI ME
. . . .
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%H%%OWDAY%%. %%TI ME
/ /
%%H1=SUNDAY%%BLANK4
%%H2=MONDAY%%BLANK4
%%H3=TUESDAY%%BLANK3
%%H4=WEDNESDAY%%BLANK1
%%H5=THURSDAY%%BLANK2
%%H6=FRI DAY%%BLANK4
%%H0=SATURDAY%%BLANK2
Var i abl e subst i t ut i on by st ages:
%%H%%OWDAY%%. %%TI ME
%%H%%OWDAY. 085300
%%H1. 085300
SUNDAY 085300
The submi t t ed JCL:
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM DAYTI ME
. . . .
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
SUNDAY 085300
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM LBUSMON
/ / STEP02 EXEC PDPRT3
/ / * + + + +
/ / SYSI N DD *
%%LAST_BUSI NESS_DATE_I N_%%OMONTH REPORT1
/ /
Examples
Chapter 5 JCL and AutoEdit Facility 797
The submitted JCL:
The correct solution:
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM LBUSMON
/ / STEP02 EXEC PDPRT3
/ / * + + + +
/ / SYSI N DD *
030400 REPORT1
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / * %%LI BSYM CTM. LI B. SYMBOLS %%MEMSYM LBUSMON
/ / STEP02 EXEC PDPRT3
/ / * + + + +
/ / * %%RANGE 1 39
/ / SYSI N DD *
%%LAST_BUSI NESS_DATE_I N_%%OMONTH REPORT1
/ /
Examples
798 CONTROL-M for OS/390 and z/OS User Guide
SYSIN Parameter Containing %%
Disabling AutoEdit Resolution
The original JCL:
The solution:
If %%RESOLVE=NO is specified, the line is submitted as is.
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%VAR Do not r esol ve t he Aut oEdi t var i abl e on t hi s l i ne.
/ / EXEC . . . PARM=' %%ODATE'
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / STEP02 EXEC PDPRT3
/ / SYSI N DD *
%%RESOLVE OFF
%%VAR Do not r esol ve t he Aut oEdi t var i abl e on t hi s l i ne.
%%RESOLVE YES
/ / EXEC . . . PARM=' %%ODATE'
/ /
Examples
Chapter 5 JCL and AutoEdit Facility 799
%%INCLIB and %%INCMEM Statements
The original JCL:
The PDPRPT2 member in the CTM.LIB.COMJCL library contains:
The submitted JCL (on June 6, 2001):
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / STEP01 EXEC PDPRPT1
. . . .
/ / * %%I NCLI B CTM. LI B. COMJCL %%I NCMEM PDPRPT2
/ /
/ / STEP02 EXEC PDPRPT2
/ / SYSI N DD *
%%DATE
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / STEP01 EXEC PDPRPT1
. . . .
/ / * %%I NCLI B CTM. LI B. COMJCL %%I NCMEM PDPRPT2
/ / STEP02 EXEC PDPRPT2
/ / SYSI N DD *
000606
/ /
Examples
800 CONTROL-M for OS/390 and z/OS User Guide
Boolean IF Logic
Example 1
This example illustrates CONTROL-Ms ability to perform Boolean IF logic.
The original JCL:
The submitted JCL at 1:00 p.m.
The %%IF expression is not true since it is past 12:00 noon; therefore, the statements
following %%ELSE are executed. The program executed in STEP01 is AFTPGM.
Example 2
This example illustrates the use of CONTROL-Ms conditional logic in conjunction
with CONTROL-M INCLUDE and GO TO logic.
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / *
/ / * %%I F %%TI ME LT 120000
/ / * %%SET %%PGMA=MORNPGM
/ / * %%ELSE
/ / * %%SET %%PGMA=AFTPGM
/ / * %%ENDI F
/ / *
/ / STEP01 EXEC PGM=%%PGMA
. . .
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ /
/ / * %%I F %%TI ME LT 120000
/ / * %%ELSE
/ / * %%SET %%PGMA=AFTPGM
/ / * %%ENDI F
/ /
/ / STEP01 EXEC PGM=AFTPGM
. . .
/ /
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / *
/ / * %%I F %%WDAY NE 1
/ / * %%GOTO RUN_DAI LY
/ / * %%ELSE
/ / * %%I NCLI B CTM. LI B. COMJCL %%I NCMEM MONTHLY
/ / * %%ENDI F
/ / *
/ / * %%LABEL RUN_DAI LY
/ / STEPDAI EXEC PGM=DAI LY
. . .
/ /
Examples
Chapter 5 JCL and AutoEdit Facility 801
The MONTHLY member in the CTM.LIB.COMJCL library contains:
On the first day of the month both the DAILY and MONTHLY programs run. The
submitted JCL:
On any other day of the month, only the DAILY program runs. The submitted JCL:
//PDPA0001 JOB (......),BILL,CLASS=A
//*
//* %%IF 2 NE 1
//* %% GOTO RUN_DAILY
//* %%ELSE
//* %%ENDIF
//*
//* %%LABEL RUN_DAILY
//STEPDAI EXEC PGM=DAILY
...
//
/ / STEPMON EXEC PGM=MONTHLY
. . .
/ / PDPA0001 JOB ( . . . . . . ) , BI LL, CLASS=A
/ / *
/ / * %%I F 1 NE 1
/ / * %%ELSE
/ / * %%I NCLI B CTM. LI B. COMJCL %%I NCMEM MONTHLY
/ / STEPMON EXEC PGM=MONTHLY
. . .
/ / * %%ENDI F
/ / *
/ / * %%LABEL RUN_DAI LY
/ / STEPDAI EXEC PGM=DAI LY
. . .
/ /
Examples
802 CONTROL-M for OS/390 and z/OS User Guide
Chapter 6 Selected Implementation Issues 803
Chapt er
6
6 Selected Implementation Issues
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Job Ordering Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Job Ordering Through Quick Submit Command CTMQSB. . . . . . . . . . . . . . . . . 805
Special Purpose Job Ordering From Special Environments: CTMAJO. . . . . . . . 807
Loading the Manual Conditions File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Using the Manual Conditions File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Manual Conditions File and Maybe Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Handling Manual Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Handling Unscheduled Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Handling Maybe Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Maybe Jobs in Group Scheduling Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
MAINVIEW Batch Optimizer Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Job-Related Considerations for Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Enhanced Runtime Scheduling Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
System-Related Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Parameter Prompting Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Parameter Prompting Facility Type 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Usage Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Parameter Prompting FacilityType 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Maintenance Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Overview
804 CONTROL-M for OS/390 and z/OS User Guide
Overview
This chapter provides you with concepts and hints for successful implementation of
CONTROL-M. It also provides a detailed description of the procedures required for
implementation of CONTROL-M by the user and operator. The following
implementation concepts and instructions are discussed in this chapter:
s alternative methods of job ordering
s Manual Conditions list and Maybe jobs
s MAINVIEW Batch Optimizer (MVBO) considerations
s parameter prompting facilities
For information about the INCONTROL administrator's implementation of
CONTROL-M, see the INCONTROL for OS/390 and z/OS Administrator Guide.
Job Ordering Methods
Under CONTROL-M, job ordering is normally performed automatically by the New
Day procedure and User Daily jobs during New Day processing, as described in
detail in the INCONTROL for OS/390 and z/OS Administrator Guide.
However, at times it is desirable to perform job ordering using methods other than
the New Day procedure and User Daily jobs. For example, it may be necessary to
schedule special purpose jobs, or to order jobs for a different working date.
CONTROL-M provides several alternative methods of job ordering. Some methods of
job ordering are performed online; others in batch. Some are performed
automatically, while others are performed manually.
Below is a list of facilities and functions that enable jobs to be ordered without the
New Day procedure and User Daily jobs.
NOTE
Topics in this chapter require familiarity with background information presented in
Chapter 1, Introduction to CONTROL-M, and familiarity with relevant information
presented in other chapters.
Job Ordering Methods
Chapter 6 Selected Implementation Issues 805
Job Ordering Through Quick Submit Command CTMQSB
In many instances, the contents of the job are determined by an end user before
submission. For example, a user may maintain a member that contains the JCL and
parameters of a certain report. When someone requests the report, the user edits the
member, possibly using ISPF, changes the parameters of the report, and uses the ISPF
SUBMIT command to submit the job.
Table 241 Alternative Job Ordering Methods
Method Description
Table/ Job List
screen
Enables jobs to be ordered from Online facility screens. For
more information, see Ordering (Scheduling) Jobs on
page 151
Job Order panel Allows job ordering through the online utility (or CLIST)
CTMJOBRQ. For more information, see M1: Issue a Job
Order on page 323
End User Job Order
interface
Allows job ordering through the online utility (or CLIST)
CTMJBINT. For more information, see M6: End-User Job
Order Interface on page 371
Utility CTMJOB Described in the INCONTROL for OS/390 and z/OS Utilities
Guide.
Utility CTMBLT Described in the INCONTROL for OS/390 and z/OS Utilities
Guide.
TSO CLIST Allows job ordering directly from the TSO environment. For
more information, see the description of the CTMJOB utility in
the CONTROL M chapter in the INCONTROL for OS/390 and
z/OS Utilities Guide, which includes an example of such job
ordering.
Quick submit
command CTMQSB
Allows job ordering through CONTROL-M submit command
CTMQSB (instead the ISPF submit command). For more
information, see Job Ordering Through Quick Submit
Command CTMQSB on page 805.
Job ordering from
special
environments
Facilitates job ordering from other environments (CICS,
ROSCOE, and so on). For more information, see Special
Purpose Job Ordering From Special Environments: CTMAJO
on page 807.
Job Ordering Methods
806 CONTROL-M for OS/390 and z/OS User Guide
As described in the previous paragraphs, CONTROL-M can detect such jobs when
they appear on spool, and control their execution. However, there are a few
disadvantages to this method. The primary disadvantage is in handling job abends.
When an On Spool job abends, it is not clear which JCL member must be submitted to
perform a rerun. For example, in the above example, if the JCL has not been saved,
such as where the user exited ISPF EDIT using the CANCEL command, there is no
original member from which to perform the rerun.
This problem can be overcome using CONTROL-M command CTMQSB. When
submitting a job, use command CTMQSB instead of the regular ISPF SUBMIT
command. Just type it in the command line and press Enter. You may have to prefix it
by the % character to designate a CLIST.
It is possible to replace the ISPF SUBMIT command with the CONTROL-M CTMQSB
command. For more information, see the description of installing ISPF support in the
CONTROL-M Installation Procedure in the INCONTROL for OS/390 and z/OS
Installation Guide.
If the member contains JCL cards that start with / / *CONTROLM then special
processing takes place, that is, the member is not submitted. The CONTROL-M
submit command looks for two / / *CONTROLM cards with the following format
(order and position in the job are not important):
The current JCL member is written to the specified JCL library. The name of the
member is composed of the first three letters of the TSO user ID, and the
CONTROL-M order ID (5 characters). This method ensures that the name is unique.
The scheduling table is read from the specified library. The submit command
assumes that the table contains only one job scheduling definition. If the table
contains definitions for more than one job, only the first job scheduling definition is
taken into account; the remainder are ignored. The CTMQSB CONTROL-M
command replaces the original library and member names with the names of the JCL
library and member where the job has been stored, as described in the preceding
section. If the WM1822 optional wish is applied, the user ID (OWNER) of the job is
replaced by the TSO user ID. The WM1822 optional wish is in the IOADFLT member
in the IOA IOAENV library.
To avoid accumulation of old members, it is advisable that a new, empty JCL library
be used each day.
CONTROL-M job order security exit CTMX001 is invoked (as under CTMJOBRQ). If
the job order is valid, it is placed on the CONTROL-M Active Jobs file. The job is then
submitted based on the regular job scheduling criteria, such as IN, CONTROL, TIME.
/ / * CONTROLM TABLE schedul i ng- t abl es- l i br ar y t abl e- name
/ / * CONTROLM JCL JCL- l i br ar y
Job Ordering Methods
Chapter 6 Selected Implementation Issues 807
Scheduling tables that are referred to by / / *CONTROLM statements must not be
included in a batch User Daily or in New Day processing. They must contain a
skeleton of a job order, such as reports that require IMS to be up, reports that use
substantial IDMS resources, update to certain VSAM files, and so on.
It is possible to force the use of the CONTROL-M submit facility. When the
CONTROL-M CTMQSB command is activated, the contents of the member to be
submitted are passed to CONTROL-M User Exit CTMX010. This exit can
automatically add / / *CONTROLM cards to the submitted member. Use of this
technique results in a completely scheduled environment. All submitted jobs are
under CONTROL-M control.
Special Purpose Job Ordering From Special Environments:
CTMAJO
This section describes a special program, CTMAJO, that is supplied with
CONTROL-M.
CTMAJO was designed to handle a situation that sometimes arises, when the user
needs to order special jobs from any of various environments, such as CICS or
ROSCOE. However, the CTMBLT utility, which is described in the INCONTROL for
OS/ 390 and z/ OS Utilities Guide, now provides the same functions. You can use the
CTMBLT utility to dynamically build job scheduling definitions and to order
individual jobs when required.
BMC Software recommends that you use the CTMBLT utility instead of using the
CTMAJO program, which will not be supported in future versions of CONTROL-M.
If you prefer, you can achieve the same results by means of the CONTROL-M
Application Program Interface (CTMAPI), which is described in Appendix A, The
CONTROL-M Application Program Interface (CTMAPI).
NOTE
Each member processed using the command CTMQSB must contain only one job. If
one of these members contains more than one job, all the jobs are submitted; however,
a message is produced for only the last job. If the job is ordered, CONTROL-M
submits all the jobs in the member, but controls only the first job.
CTMQSB requires allocation of files SYSPRINT and DACKPT.
CONTROL-D users: The D-CAT field of the job scheduling table is ignored for jobs
that are scheduled using the CONTROL-M CTMQSB command. This means that a
report decollating mission is not automatically ordered for jobs that are scheduled by
the CTMQSB command.
Job Ordering Methods
808 CONTROL-M for OS/390 and z/OS User Guide
Since program CTMAJO is not environment-dependent, the INCONTROL
administrator must develop an application that enables the program to be used with
the particular environment. One such application, CTMQSB, is supplied with
CONTROL-M. CTMQSB is for use with CTMAJO under ISPF, and is described in
Job Ordering Through Quick Submit Command CTMQSB on page 805.
The CTMAJO program accepts the following parameters:
s the JCL of the job, which is already loaded into memory
s the name of a special purpose JCL library in which to place the JCL
s the name of a scheduling library
s the name of a scheduling table (in the above library) containing a single, skeletal,
job scheduling definition
s the requested scheduling date
To handle the special purpose request, CTMAJO performs the following:
s takes the JCL of the job to be submitted from memory and writes it to the specified
single purpose JCL library, using a unique member name
s takes the skeletal job scheduling definition from the scheduling table in the
scheduling library, and loads the job scheduling definition to the Active Jobs file
When placing the job order in the job scheduling definition, CONTROL-M overwrites
the MEMNAME value from the skeleton with the name of the special purpose JCL
member. It also specifies the requested scheduling date.
The job then comes under the control of the CONTROL-M monitor:
s If runtime scheduling criteria are specified in the skeletal job scheduling definition,
the job is not submitted until those criteria are satisfied.
s If post-processing parameters are specified, they are performed upon completion
of the job.
Using CTMAJO to order special purpose jobs under special environments is
preferable to bringing jobs under CONTROL-M control as On Spool jobs because
when CTMAJO is used, the JCL is available, if necessary, for job rerun. With On Spool
jobs, the JCL member may not be known.
For a sample call to the CTMAJO utility, see the ROSORDER member in the IOA
SAMPLE library.
Manual Conditions File and Maybe Jobs
Chapter 6 Selected Implementation Issues 809
Manual Conditions File and Maybe Jobs
The Manual Conditions file contains a list of prerequisite conditions that are required
by jobs in the Active Jobs file but which are not available, that is, added to the IOA
Conditions file, unless there is some form of user intervention.
Loading the Manual Conditions File
Conditions are added to the Manual Conditions file through the IOALDNRS utility.
This utility is run during New Day processing, but it must also be run following the
addition of a set of jobs in the Active Jobs file.
The IOALDNRS utility checks the IN conditions required by scheduled jobs against
the conditions available in the IOA Conditions file and against the OUT conditions
that can be set by the scheduled jobs.
All IN conditions that are not in the IOA Conditions file and that are not listed as
OUT conditions in a scheduled job are added to the Manual Conditions file.
Using the Manual Conditions File
The Manual Conditions file provides the user with a list of conditions for which
manual intervention is required if the conditions are to be added to the IOA
Conditions file.
To utilize this list effectively, the user must distinguish between two types of
conditions in the list because each requires a different type of intervention. From the
user perspective, the two types of conditions are:
s Manual Conditions
Conditions that always require manual intervention and are therefore never
automatically added by jobs as OUT or DO COND conditions.
Example
Job-X, which requires that a tape has arrived before the job is submitted, contains
IN prerequisite condition TAPE-ARRIVED.
This condition must not be automatically added to the IOA Conditions file by a
job, but must instead be manually added by the operator only after the tape has
arrived.
Manual Conditions File and Maybe Jobs
810 CONTROL-M for OS/390 and z/OS User Guide
s Unscheduled Conditions
Conditions that can be added automatically by a job, but which appear in the
Manual Conditions list because none of the jobs scheduled that day set the
condition.
Example
Job-B requires IN condition JOB-A-ENDED-OK. This condition is added as an
OUT condition by Job-A. Job-B is scheduled on a day during which Job-A is not
scheduled.
The distinction between the two types of conditions mentioned above is important
because each type requires a different user response, as described below.
Handling Manual Conditions
The handling of Manual Conditions, as defined above, is fairly straightforward. In the
above example, the user clearly does not want the condition added automatically, nor
does the user want the condition ignored. Simply put, Job-X must not be run unless
the required tape has arrived at the site, in which case the operator adds the
condition. For this type of condition, the only desired manual intervention is the
adding of the condition at the appropriate time. This can be performed by option A
(Add) in the Manual Conditions screen.
Handling Unscheduled Conditions
The handling of Unscheduled Conditions, as defined above, is more complex because
it concerns the issue of normal dependency versus Maybe dependency:
s Normal Dependency
A successor job is always dependent on the predecessor job, regardless of whether
the predecessor job is scheduled.
With this type of dependency, using the example cited above, successor Job-B must
not be submitted because predecessor Job-A was not scheduled and executed.
In this case, the dependency must not be ignored. The unscheduled prerequisite
condition is not added manually.
Manual Conditions File and Maybe Jobs
Chapter 6 Selected Implementation Issues 811
s Maybe Dependency
A successor job is dependent on the predecessor job only if the predecessor job is
scheduled that day. If the predecessor job is not scheduled that day, the successor
job can still be submitted, provided that other runtime scheduling criteria are
satisfied.
In this case, the predecessor job is referred to as a Maybe job.
With this type of dependency, using the example cited above, successor job Job-B
must be submitted, provided all other runtime scheduling criteria are satisfied,
because predecessor job Job-A was not scheduled.
In this case, the dependency must be ignored or bypassed. Methods for ignoring
Maybe dependencies are described below.
Handling Maybe Dependencies
The most common method of handling Maybe job dependencies is to add the
unscheduled conditions of Maybe jobs to the IOA Conditions file.
However, examining each condition in the Manual Conditions list to determine if it is
an unscheduled condition from a Maybe job, and manually adding each Maybe job
unscheduled condition, is a difficult process. The process can be greatly simplified
and automated, by following these steps:
1. Define a Unique Prefix for Maybe Job Prerequisite Conditions
When Maybe dependencies are defined, the prerequisite IN, OUT and DO COND
conditions must all have the same unique prefix (that is, a prefix that is not used
for other prerequisite conditions).
Using a unique prefix symbol makes it easier to see unscheduled conditions of
Maybe Jobs in the Manual Conditions list.
Normally, this prefix is either symbol # or @.
NOTE
If your site utilizes MVS restarts and uses symbol @in OUT conditions for the
restart, this symbol must not be used as a prefix for Maybe job conditions. In this
case, use the # symbol for Maybe conditions. For details, see Appendix F, MVS
Job Restart Without CONTROL-M/ Restart.
Manual Conditions File and Maybe Jobs
812 CONTROL-M for OS/390 and z/OS User Guide
2. Use the ADDMNCND KeyStroke Language utility to add the prerequisite
conditions. The ADDMNCND KSL utility automatically adds all conditions with a
specified prefix in the Manual Conditions file to the IOA Conditions file.
By specifying the above-defined unique prefix symbol in the utility, unscheduled
conditions from Maybe jobs are automatically added, making manual adding of
the conditions unnecessary.
After the above two steps have been implemented, the only manual intervention
required for unscheduled conditions of Maybe jobs is the executing of the
ADDMNCND KSL utility.
Maybe Jobs in Group Scheduling Tables
The above implementation for handling unscheduled conditions of Maybe jobs can
be applied to jobs and conditions in all types of scheduling tables.
However, an alternative method is available for conditions and jobs in Group
scheduling tables. Rather than add the unscheduled conditions of Maybe jobs to the
IOA Conditions file, the unscheduled conditions can be removed as runtime
scheduling criteria for the successor job orders.
The Group Entity definition in Group scheduling tables contains an ADJUST
CONDITIONS field. If a value of Y is specified in the ADJUST CONDITIONS field,
CONTROL-M checks the scheduled jobs for unscheduled conditions.
Unscheduled conditions normally added by other jobs in the same Group scheduling
table are removed from the IN statements of the scheduled job orders:
s These conditions do not appear in the Zoom screen. They are not, however, deleted
from the original job scheduling definition.
s These conditions also do not appear in the Manual Conditions file. Therefore, there
is no real advantage to defining them with a unique prefix, unless they are used as
IN conditions for jobs in a different table.
Note the following points
s Unscheduled conditions normally added by jobs in other scheduling tables are not
removed from the job order. They appear in the Manual Conditions file.
s As indicated above, ADJUST CONDITIONS applies only to jobs in the same
Group scheduling table. By contrast, the IOALDNRS utility detects unscheduled
conditions of Maybe jobs across scheduling tables, and the ADDMNCND KSL
utility adds these conditions to the IOA Conditions file regardless of scheduling
table.
Manual Conditions File and Maybe Jobs
Chapter 6 Selected Implementation Issues 813
For more information, see Chapter 3, Job Production Parameters.
MAINVIEW Batch Optimizer Considerations
MAINVIEW Batch Optimizer (MVBO) is a batch optimization system that enables
effective parallel processing and efficient resource utilization in the mainframe
environment. The Job Optimizer Pipes component of MVBO enhances this capability
using MVS Pipe technology. If MVBO/ Job Optimizer Pipes is installed at your site,
you can include the CONTROL-M PIPE parameter in a job scheduling definition in
order to use MVBO/ Job Optimizer Pipes functionality.
Job-Related Considerations for Pipes
The following job-related issues must be considered when using the PIPE parameter
in a CONTROL-M job scheduling definition:
s When using pipes for jobs submitted by CONTROL-M, the PIPE parameter must
be used if parallel submission of all pipe participants is to be ensured.
s Normally (that is, when pipes are not used), prerequisite conditions ensure desired
flow of predecessor and successor jobs.
However, when values are specified in the PIPE parameters of interrelated job
scheduling definitions, CONTROL-M uses them to create Collections. The jobs in a
Collection are not submitted until all prerequisite conditions required by all jobs in
the Collection are satisfied. If a dependency exists between an OUT condition of
one job and an IN condition of another job in the same Collection, it prevents
submission of all the jobs in the Collection. CONTROL-M resolves this problem by
ignoring the IN condition, thus bypassing the dependency between the jobs in the
Collection and enabling the submission of the jobs. If the job is removed from the
Collection, its ignored IN conditions reappear.
s When two jobs in the same Collection request the same Control resource, and at
least one of them requests the resource in exclusive mode, a deadlock situation
arisesthe Collection jobs are not submitted. To prevent this, CONTROL-M
ignores the Control resource requests of one of the jobs, as follows: If one of the
jobs requested the resource in shared mode, that resource request is ignored; if
both jobs requested the resource in exclusive mode, the resource request of the
job with the shorter average elapsed time is ignored. If the job is removed from the
Collection, its ignored Control resources reappear.
Manual Conditions File and Maybe Jobs
814 CONTROL-M for OS/390 and z/OS User Guide
s Jobs cannot be run in parallel if TIME FROM and TIME UNTIL specifications for
the jobs do not overlap.
This case must be considered individually at time of implementation.
s When PIPE definitions are added, the Quantitative resources defined for the jobs
in the Collection must be checked to see if some of the defined resources are no
longer necessary. For example, if a pipe replaces a tape data set, the tape resource
may not be required. Such resources must be removed from the job scheduling
definition.
s In a non-Sysplex environment, all jobs that are part of a Collection must run in the
same system. Therefore, BMC Software recommends that you avoid using
resources prefixed by a dollar sign ($) in jobs that are part of a Collection, to ensure
that all the jobs are submitted to the same system.
Enhanced Runtime Scheduling Algorithm
When jobs that are part of a Collection are scheduled, CONTROL-M treats the
Collection as one unit of work for processing runtime scheduling criteria in the
following ways:
s CONTROL-M ensures that the required number of participants, as defined for the
pipe in the MVBO/ Job Optimizer Pipes rule, access each pipe in the Collection. If a
participant is missing, the jobs in the Collection are not submitted. This ensures
that a job is not submitted when its participants are not scheduled on that day.
s CONTROL-M analyzes all resources, such as prerequisite conditions, Quantitative
resources, and time limits, required by all jobs in the Collection as a single set. All
participants are submitted together when all the resources required by the set are
available. This ensures the parallel submission of all pipe participants.
To ensure that the jobs begin execution on time, it is recommended that initiators
be handled as Quantitative resources. This ensures that submitted jobs do not wait
for initiators and delay other jobs in the Collection.
NOTE
To allow integration between CONTROL-M and MVBO/ Job Optimizer Pipes, the
pipe name specified in the CONTROL-M job scheduling definition must be
identical to the pipe name specified in the MVBO/ Job Optimizer Pipes rule.
Currently, this requirement is not forced by CONTROL-M.
Manual Conditions File and Maybe Jobs
Chapter 6 Selected Implementation Issues 815
s CONTROL-M checks if the MVBO/ Job Optimizer Pipes monitor is active before
submitting the jobs in the Collection. If the MVBO/ Job Optimizer Pipes monitor is
not active, the jobs in the Collection are not submitted. This ensures that, when
submitted, the jobs run in parallel, using pipes.
System-Related Considerations
The following system-related issues must be considered when using the PIPE
parameter in a CONTROL-M job scheduling definition.
s Parallel processing changes resource usage in the system. All resources required
for all the jobs in the Collection must be available when the jobs are submitted.
This means that more resources, such as initiators, tape drives, CPUs, are required
for shorter time periods; they become available after the jobs using the pipe finish
execution. Therefore, when using pipes, resource usage in the system in which the
jobs are to run must be reviewed to ensure that all required system resources are
available at the time the jobs are submitted.
s The change in resource usage may necessitate changing the maximum quantities
defined for CONTROL-M to satisfy the changed requirements.
Parameter Prompting Facilities
816 CONTROL-M for OS/390 and z/OS User Guide
Parameter Prompting Facilities
It is assumed that the reader is familiar with the following CONTROL-M facilities
and concepts:
s JCL and AutoEdit facility
s prerequisite conditions
s Manual Conditions (Screen 7) and the IOALDNRS utility
CONTROL-M provides two different types of Parameter Prompting facilities. The
online use of the two Parameter Prompting facilities is described in Chapter 2,
Online Facilities.
This chapter provides an explanation of how the Parameter Prompting facilities
work, how they differ from each other, and how to choose the facility that best suits
your operational needs. In addition, certain preparatory steps are detailed.
Parameter Prompting Facility Type 1
The Parameter Prompting facility Type 1 is an ISPF table-based facility that
provides automatic prompting for AutoEdit parameter values and setting of
prerequisite conditions. It is the recommended method for operations personnel to
automate the updating of AutoEdit parameter members.
The CONTROL-M JCL and AutoEdit facility eliminates the need for frequent manual
changes to job parameters. However, there are usually a few job parameter changes
that cannot be automated, for example, tape serial numbers, which are unknown
prior to tape arrival. These types of parameters require manual modification by the
user, generally operations personnel.
Old Method
To illustrate how prior versions of CONTROL-M solved this problem, consider the
daily arrival of IRS tape number 123456.
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 817
Figure 339 Illustration 1A: How CONTROL-M Formerly Handled A New Tape

The illustration above represents the one-time definitions required to prepare
CONTROL-M for handling the IRS tape.
1. JOB A requires input of the IRS tape number before it can run. The job must be
defined in a CONTROL-M scheduling table with an IN prerequisite condition of
IRS-TAPE-ARRIVED.
2. The JCL for JOB A must include %%LIBSYM and %%MEMSYM control statements
pointing to the AutoEdit Library CTM.LIB.SYMBOLS and the AutoEdit member
TAPES.
3. The AutoEdit member TAPES contains several AutoEdit parameters (from various
jobs), including the parameter %%IRS_TAPE.
On a given day, the Manual Conditions file created by the IOALDNRS utility
indicates that the prerequisite condition IRS-TAPE-ARRIVED must be added
manually by the user. This serves as a reminder to the operations personnel that a job
is waiting for an IRS tape number. When the tape arrives, the user must perform two
steps, as illustrated in the following figure:
Parameter Prompting Facilities
818 CONTROL-M for OS/390 and z/OS User Guide
Figure 340 Illustration 1B: Steps Formerly Performed by the User

1. Access the AutoEdit member TAPES and assign value 123456 to the %%IRS_TAPE
parameter.
2. Enter Screen 7 to manually add condition IRS-TAPE-ARRIVED.
When the condition IRS-TAPE-ARRIVED has been added to the IOA Conditions file,
and assuming all other runtime conditions are met, the CONTROL-M monitor
submits the job. When the job is submitted, the value of %%IRS_TAPE in the JCL of
JOB A is updated by the value in the TAPES member. The job parameter
VOL=SER=%%IRS_TAPE resolves to VOL=SER=123456.
New Method
In the current version, the same problem is resolved in a different way using the
Parameter Prompting facility Type 1.
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 819
Figure 341 Illustration 2A: How CONTROL-M Now Handles A New Tape

The illustration above represents the one-time definitions required to prepare
CONTROL-M for handling the IRS tape when using Parameter Prompting facility
Type 1.
1. JOB A requires input of the IRS tape number before it can run. The job must be
defined in a CONTROL-M scheduling table with IN prerequisite condition
IRS-TAPE-ARRIVED.
2. The JCL for JOB A includes %%LIBSYM and %%MEMSYM control statements
pointing to the CONTROL-M PROMPT prompting parameters library and the
TAPM%%OMONTH.%%ODAY daily AutoEdit member.
3. Using the first option of the Parameter Prompting facility Type 1, groups of
AutoEdit parameters that require value assignment are defined once. These
parameters are grouped into a Master Prompting table, the Master table. Default
parameter values may be assigned. In addition, prerequisite conditions to be
associated with parameters are designated. In this example, several parameters
from various jobs have been defined in the TAP Master table, including the
%%IRS_TAPE parameter from JOBA. Prerequisite condition IRS-TAPE-ARRIVED
has been associated with this parameter.
When the tape arrives, the user only performs one step (illustrated below):
Parameter Prompting Facilities
820 CONTROL-M for OS/390 and z/OS User Guide
Figure 342 Illustration 2B: Single Step Now Performed by the User

The user selects the TAP table from a list of Master tables and is presented with Daily
Prompting table TAPT1112, an automatically created copy of the Master table for the
current date. The Daily Prompting table consists of parameter names, (optional)
descriptions, and default values. The user updates the %%IRS_TAPE parameter with
the value 123456.
The facility automatically adds condition IRS-TAPE-ARRIVED to the IOA Conditions
file and updates the daily AutoEdit member TAPM1112.
Summary
By using Parameter Prompting facility Type 1, it is only necessary to update the
Daily table. The user no longer needs to remember which AutoEdit parameters in
which AutoEdit symbol member require changing, nor the prerequisite conditions
that require setting. The Parameter Prompting facility automatically handles
updating of the AutoEdit member, and adds any required conditions to the IOA
Conditions file.
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 821
Usage Notes
JCL Modifications
JCL members for jobs containing AutoEdit parameters defined in Master tables must
be modified as follows:
s The %%LIBSYM control statement must point to the CONTROL-M PROMPT
library.
s The %%MEMSYM control statement member name must be in the following
format:
@@@M%%OMONTH. %%ODAY
where @@@is the Table Name Prefix defined in Option 1 of the facility.
%%OMONTH.%%ODAY can be replaced with any date variable or date constant
in the format mmdd.
The IOALDNRS Utility
The Parameter Prompting facility automatically adds conditions to the IOA
Conditions file after parameter update. These conditions no longer require
submission through Screen 7, and therefore do not need to appear on the Manual
Conditions file. To exclude these parameters from the file, you can use the IGNORE
IN parameter in the IOALDNRS utility, which is described in the INCONTROL for
OS/390 and z/OS Utilities Guide.
Parameter Prompting FacilityType 2
The Parameter Prompting facility Type 2 is a manual job scheduling facility that
provides automatic prompting for AutoEdit parameter values. On a given day, the
user selects the scheduling tables for execution. The user is then automatically
prompted for parameter values required for the execution of the jobs scheduled to
run on the specified date.
This type of prompting facility is recommended for use in a distributed environment
where user departments are responsible for manually scheduling (ordering) their
jobs, and specifying required parameters.
A sample application of this type of scheduling facility is the maintenance of
confidential salary information in a payroll department. The payroll department
usually retains control over its jobs and their input parameters.
Parameter Prompting Facilities
822 CONTROL-M for OS/390 and z/OS User Guide
The Parameter Prompting facilityType 2 has three major phases:
Definition Phase
Figure 343 Parameter Prompting Facility Type 2: Definition Phase

1. Scheduling Table
First, a scheduling table is defined using the CONTROL-M Online facility. The
scheduling table contains job scheduling information for all of a departments jobs.
Any number or type of jobs with any valid date scheduling criteria can be
designated. The table is placed in a Master Scheduling Tables library.
2. Master Prompting Plan
Next, using the first option of the Parameter Prompting facility Type 2, a Master
Prompting Plan (MPP) is defined containing all AutoEdit variables used by all the
jobs in the scheduling table. Any default values can be assigned. Value validity
checks can also be defined. The MPP is placed in the Master Prompting Plan
library.
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 823
FETCH Phase
Figure 344 Parameter Prompting Facility Type 2: Fetch Phase

The second option of the Parameter Prompting facility Type 2, FETCH A PLAN,
allows the user to select a plan for execution by CONTROL-M on a specific day.
When a FETCH option is executed for a specific PLANID, or all PLANIDs with a
specific suffix, a daily scheduling table is automatically created. The Daily Scheduling
table, a subset of the Master Scheduling table, is placed in the Daily Scheduling
Tables library. The Daily Scheduling table contains the job scheduling definition of all
of the jobs in the Master Scheduling table scheduled to run on the specified date,
based on each jobs scheduling criteria.
Parameter Prompting Facilities
824 CONTROL-M for OS/390 and z/OS User Guide
The FETCH also creates a User Prompting Plan (UPP), a subset of the Master
Prompting Plan, which is placed in the Daily Prompting Plan library. The UPP
contains only parameters that are required by the jobs scheduled to run on the
specified date.
A Daily JCL library is also created containing JCL for todays jobs.
EXEC Phase
The third option of this facility, EXEC A PLAN, permits the user to update or accept
the default values of all the parameters appearing in the daily UPP. A daily AutoEdit
parameters member, which is accessed at the time of job submission, is automatically
created and placed in the Daily AutoEdit Parameter library.
Figure 345 Parameter Prompting Facility Type 2: EXEC Phase

Once values have been assigned to all the parameters, the prerequisite condition
RUN-%%PLANID is added. %%PLANID is resolved to the PLANID, and suffix if
supplied, designated in the FETCH phase.
The Daily Scheduling table is then ordered by CONTROL-M. The jobs are placed on
the Active Jobs file and run based on their scheduling parameters; that is, a job is
submitted only when all scheduling criteria, such as other prerequisite conditions,
have been met.
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 825
Tailoring to User Needs
The Parameter Prompting facility Type 2 is usually activated from the
CONTROL-M ISPF Utilities screen. However, it is possible to activate the FETCH and
EXEC phases using the following CLISTS:
CTMFETCH CLIST
When CLIST CTMFETCH is activated, the FETCH A PLAN screen is displayed:
Figure 346 The FETCH A PLAN Screen
Table 242 Parameter Prompting Facility Type 2: Use of CLISTS
CLISTS Purpose
CTMFETCH For fetching a plan (FETCH phase)
CTMEXEC For executing a plan (EXEC phase)
- - - - CONTROL- M - P. P. F. - - - - - - FETCH A PLAN - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( P. 2)
COMMAND ===>

PLAN NAME ===>

PLAN NAME SUFFI X ===> ( For mul t i pl e pl ans i n t he same day)

OVERRI DE DAI LY PLAN ===> NO ( YES / NO)

ODATE ===> 060601


Pl ease f i l l i n t he Pl an Name and pr ess ENTER


MASTER SCHEDULI NG LI B ===> CTMP. PROD. SCHEDULE
DAI LY SCHEDULI NG LI B ===> CTMP. PROD. SCHD
MASTER PLANS LI B ===> CTMP. PROD. PLANMSTR
DAI LY PROMPT PLANS LI B ===> CTMP. PROD. PLAN
MASTER JCL LI B ===> CTMP. PROD. JCLPROMP
DAI LY JCL LI B ===> CTMP. PROD. JCLP

ENTER END COMMAND OR PF3 TO TERMI NATE

Table 243 The FETCH A PLAN Screen: Parameters (Part 1 of 2)
Parameter Description
PLAN NAME Plan name (1 through 6 characters). Mandatory.
PLAN NAME
SUFFIX
Two character suffix to be added to the PLAN NAME in daily
libraries. Changing the suffix permits multiple daily plans.
Parameter Prompting Facilities
826 CONTROL-M for OS/390 and z/OS User Guide
OVERRIDE DAILY
PLAN
Whether to replace an existing plan.
Valid values are:
s YES a duplicate fetch of a plan (with suffix, if one has
been designated) replaces an existing copy of a plan with
the same PLAN NAME (and same suffix) for that day
s NO multiple fetches of a plan are not permitted on the
same day (default)
ODATE Specific date for which the plan is to be fetched. Default is the
current working date. Another date can be specified, in
mmddyy, ddmmyy or yymmdd format, depending on the site
standard.
MASTER
SCHEDULING LIB
Name of the Master Scheduling Tables library.
DAILY
SCHEDULING LIB
Name of the Daily Scheduling Tables library. The last qualifier
of the library name cannot exceed 4 characters. The CLIST
concatenates the date to this daily library name.
MASTER PLANS
LIB
Name of the Master Prompting Plans library.
DAILY PROMPT
PLANS LIB
Name of the User Daily Prompting Plans library. The last
qualifier of the library name cannot exceed 4 characters. The
CLIST concatenates the date to this daily library name.
MASTER JCL LIB Name of the Master JCL library.
DAILY JCL LIB Name of the Daily JCL library. The last qualifier of the library
name cannot exceed 4 characters. The ** symbol concatenates
the date to this daily library name.
Table 243 The FETCH A PLAN Screen: Parameters (Part 2 of 2)
Parameter Description
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 827
CTMEXEC CLIST
When CLIST CTMEXEC is activated, the EXEC / ORDER A PLAN screen is
displayed:
Figure 347 The EXEC / ORDER A PLAN Screen
- - - - CONTROL- M - P. P. F. - - - - - - FETCH A PLAN - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( P. 2)
COMMAND ===>

PLAN NAME ===>

PLAN NAME SUFFI X ===> ( For mul t i pl e pl ans i n t he same day)

OVERRI DE DAI LY PLAN ===> NO ( YES / NO)

ODATE ===> 060601


Pl ease f i l l i n t he Pl an Name and pr ess ENTER


MASTER SCHEDULI NG LI B ===> CTMP. PROD. SCHEDULE
DAI LY SCHEDULI NG LI B ===> CTMP. PROD. SCHD
MASTER PLANS LI B ===> CTMP. PROD. PLANMSTR
DAI LY PROMPT PLANS LI B ===> CTMP. PROD. PLAN
MASTER JCL LI B ===> CTMP. PROD. JCLPROMP
DAI LY JCL LI B ===> CTMP. PROD. JCLP

ENTER END COMMAND OR PF3 TO TERMI NATE
Table 244 The EXEC / ORDER A PLAN Screen: Parameters
Parameter Description
PLAN NAME Plan name (1 to 6 characters). Mandatory.
PLAN NAME SUFFIX 2-character suffix used to specify a specific plan.
REMAINING PARAMETERS Continuation instructions. Valid values are:
s Y The user is automatically presented with
remaining (non-updated) parameters from all
active plans
s N After updating the current plan, the user is
given options for choosing another plan (default)
ODATE Specific date on which the plan is ordered. Default is
the current working date. Another date (in
mmddyy, ddmmyy, or yymmdd format depending
on the site standard) can be specified.
FORCED FROM TIME Specific time in format hhmm, before which the jobs
cannot run.
DAILY SCHEDULING LIB Name of the Daily Scheduling Tables library.
USER PROMPT PLANS LIB Name of the User Prompting Plans library.
DAILY PARAMETERS LIB Name of the Daily Parameters library.
Parameter Prompting Facilities
828 CONTROL-M for OS/390 and z/OS User Guide
Usage Notes
s The PLAN NAME can be up to six characters in length. Use of the SUFFIX
parameter in the FETCH phase permits creation of multiple Daily User Prompting
Plans based on one Master Prompting Plan. This also makes it possible to duplicate
(by overriding) a fetch of the same plan by setting the OVERRIDE DAILY PLAN
parameter to YES on the FETCH A PLAN screen.
s Each job defined in the Master Scheduling table must contain an IN prerequisite
condition in the format:
RUN- %%PLANI D
This prerequisite condition is added during the EXEC phase only after all
parameters for a specific plan are assigned in the EXEC phase. %%PLANID
resolves to the PLAN NAME (and SUFFIX) designated in the FETCH phase.
Since each plan can be ordered multiple times for the same scheduling date, it is
highly recommended to distinguish between the dependencies of the jobs in the
plan based on PLAN NAME. Every prerequisite condition used for inter-plan
dependency must contain the string %%PLANID. It is automatically replaced by
the PLANID during the FETCH phase.
s The JCL of each job must be modified as follows:
The first AutoEdit control statement must point to an AutoEdit Parameters library
and the PLANID member. The PLANID member contains the unique PLANID of
the job (automatically handled by CONTROL-M).
Example
%%LI BSYM CTM. PROD. SYMBOLS %%MEMSYM PLANI D
The second AutoEdit control statement must point to the Daily AutoEdit
Parameters library and the member %%PLANID. CONTROL-M automatically
resolves %%PLANID to the PLAN NAME designated in the FETCH phase.
The Daily AutoEdit Parameter library must be suffixed by a date parameter that is
resolved by CONTROL-M. Example:
%%LI BSYM CTM. PROD. AEDI %%OMONTH. %%ODAY %%MEMSYM %%PLANI D
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 829
s The %%PLANID member of each plan (in the Daily AutoEdit Parameter library)
contains up to four configuration tables identified by AutoEdit variables.
Parameters and data that are repeatedly used in a data processing environment
can be defined in such a configuration table.
A configuration table is a member of the GLOBAL library, which is referenced by
the DAGLOBAL DD statement. Such a member contains a set of user-defined local
variables and their assigned values that can be referenced in the JCL of individual
jobs.
An AutoEdit variable identifies such a configuration table by a statement in the
form %%CONFn=config_tablename in the %%PLANID member.
Example
%%CONF1=I NDI CES
%%CONF2=WEEKCHAR
%%CONF3=
%%CONF4=
These values correspond to the values entered by the CTMFETCH CLIST (the
CONFn parameters).
To use the configuration tables parameters procedure, insert the following
AutoEdit statement in the JCL of each job:
/ / * %%I NCLI B CTM. PROD. PARM %%I NCMEM PPF2CONF
The PPF2CONF member uses the configuration table values specified in the
%%PLANID member to select the GLOBAL autoedit members to be included in
the JCL of the job. It contains the following AutoEdit code:
%%I F * %%CONF1 NE *
%%GLOBAL %%CONF1
%%ENDI F
%%I F * %%CONF2 NE *
%%GLOBAL %%CONF2
%%ENDI F
%%I F * %%CONF3 NE *
%%GLOBAL %%CONF3
%%ENDI F
%%I F * %%CONF4 NE *
%%GLOBAL %%CONF4
%%ENDI F
Parameter Prompting Facilities
830 CONTROL-M for OS/390 and z/OS User Guide
s The MEMLIB parameter of each job scheduling definition in the scheduling table
must point to the Daily JCL library. The library name is suffixed by the AutoEdit
date variables.
Example
CTM. PROD. JCLP%%OMONTH. %%ODAY
s Occurrence numbering:
It is recommended that all AutoEdit parameter names of jobs in the same plan be
unique. In some plans, duplicate names may be unavoidable, and more than one
job may share the same AutoEdit parameter name. If the parameters are to be
assigned different values, that is, used for different purposes, each parameter must
be assigned a different OCCUR NO during definition of the Master Prompting
Plan.
A %%SET statement specifying the OCCUR NO. must be included in the JCL of the
associated jobs as follows:
%%SET %%OC# = 01
When the AutoEdit parameter member is created, each AutoEdit parameter
includes the OCCUR NO. as a suffix.
s Using the Parameter Prompting facility Type 2 requires customizing the
CONTROL-M submit exit (CTMX002). This exit does the following:
It ensures that at the time when the job is submitted, the AutoEdit Parameters
library contains the PLANID member.
It places in the PLANID member an AutoEdit variable definition in the form
%%PLANI D=pl an_i d
in order to provide the job with a unique identity (plan_id). This is done using an
OUT condition in the job scheduling definition, as described in the source code
of the exit.
For information about modifying the exit, see the CTMX2PPF member in the IOA
SAMPEXIT library.
Parameter Prompting Facilities
Chapter 6 Selected Implementation Issues 831
Maintenance Utilities
The following jobs are located in the CONTROL-M JCL library.
PPF2DEL
This job can be run to delete sets of daily libraries according to specified date criteria.
Figure 348 PPF2DEL Utility Screen
/ / PPF2DEL JOB ACCNT, CTM, CLASS=A
/ / *
/ / * THI S JOB DELETES SETS OF DAI LY LI BRARI ES CREATED 3, 4, and 5
/ / * DAYS PRI OR TO THE CURRENT DATE ( %%ODATE) .
/ / *
/ / * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
%%SET %%DT3 = %%CALCDATE %%ODATE - 3
%%SET %%DELDATE3 = %%SUBSTR %%DT3 3 4
%%SET %%DT4 = %%CALCDATE %%ODATE - 4
%%SET %%DELDATE4 = %%SUBSTR %%DT4 3 4
%%SET %%DT5 = %%CALCDATE %%ODATE - 5
%%SET %%DELDATE5 = %%SUBSTR %%DT5 3 4
/ / DELLI B EXEC PGM=I DCAMS
/ / SYSPRI NT DD SYSOUT=*
/ / SYSI N DD *
DELETE CTM. PROD. PLAN%%DELDATE3
DELETE CTM. PROD. SCHD%%DELDATE3
DELETE CTM. PROD. JCLP%%DELDATE3
DELETE CTM. PROD. AEDI %%DELDATE3
DELETE CTM. PROD. PLAN%%DELDATE4
DELETE CTM. PROD. SCHD%%DELDATE4
DELETE CTM. PROD. JCLP%%DELDATE4
DELETE CTM. PROD. AEDI %%DELDATE4
DELETE CTM. PROD. PLAN%%DELDATE5
DELETE CTM. PROD. SCHD%%DELDATE5
DELETE CTM. PROD. JCLP%%DELDATE5
DELETE CTM. PROD. AEDI %%DELDATE5
/ /
Parameter Prompting Facilities
832 CONTROL-M for OS/390 and z/OS User Guide
PPF2DAY
This job allocates the daily libraries that are to be used by the Parameter Prompting
facility Type 2. It also copies the required jobs from the Master JCL library to the
Daily JCL library.
These are time consuming tasks normally performed as part of the FETCH and EXEC
phases of the Online facility. By scheduling this job daily under CONTROL-M, the
time required to execute the FETCH and EXEC phases is reduced.
Chapter 7 Simulation and Forecasting Facility 833
Chapt er
7
7 Simulation and Forecasting Facility
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Simulation Procedure CTMSIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Activating the Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Preparatory Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Input Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Output Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
CONTROL-M Exits and Simulation Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Analyzing the Simulation Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
The CTMTAPUL Tape Pull List Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Activating the Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
JOB/ SCANDOCU/ TEXT Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Problem Determination for Tape Pull List Reports . . . . . . . . . . . . . . . . . . . . . . . . 850
Sample Tape Pull List Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Overview
834 CONTROL-M for OS/390 and z/OS User Guide
Overview
The Simulation and Forecasting facility consists of two components.
s Simulation procedure CTMSIM
s Tape Pull List procedure CTMTAPUL
Simulation procedure CTMSIM tests the potential impact of proposed changes to the
configuration or production environment. It answers What if? questions, such as:
What if we ...
s add or remove four tape drives from the system?
s increase the CPU power by 30%?
s run a particular set of applications daily instead of weekly?
The Simulation procedure can also be used to forecast production runs such as the
next 24-hour run, end-of-month run, and so on. In this way, possible irregularities in
the schedule can be foreseen.
The CTMTAPUL Tape Pull List procedure creates a report of all tapes to be mounted
for a specific period. By running the procedure on a daily basis, all tapes required for
the daily production run can be prepared in advance for the operator or the robotic
tape library.
The Tape Pull List procedure uses the output of the Simulation procedure as input.
Therefore, the Simulation procedure must be executed before the Tape Pull List
procedure can be executed. However, the Simulation procedure can be executed
without executing the Tape Pull List procedure.

Simulation Procedure CTMSIM
Chapter 7 Simulation and Forecasting Facility 835
Simulation Procedure CTMSIM
The Simulation procedure mirrors the CONTROL-M monitor flow for a specified
period without actual job submission and without output processing. It takes into
consideration all scheduling criteria including prerequisite conditions, time limits,
quantitative, and CONTROL-M resources.
CONTROL-M and IOA files used as input to the simulation process are not updated
as a result of this process. The statuses of the files after simulation are written to
special simulation output files. The simulation assumes that each job ended execution
with a condition code of 0.
The following CONTROL-M and IOA files are used as input in the Simulation
procedure. These files may either be actual production files or special files created
specifically for forecasting purposes.
The simulation produces the following output files:
The Simulation procedure may contain several steps prior to the actual simulation
processing step, depending on the environment to be used as input to the simulation
run. For example
s It may be desirable to use the production Active Jobs file as input.
s It may be necessary to simulate the run of a specific day without relating to the
current production jobs.
Table 245 Files Used as Input during Simulation
File Description
AJF Active Jobs file
RES CONTROL-M Resources file
CND IOA Conditions file
STAT CONTROL-M Statistics file
Table 246 Files Produced as Output of Simulation
File Description
SIMOAJF Simulation Output Active Jobs file
SIMORES Simulation Output Resources file
SIMOCND Simulation Output Conditions file
SIMLOG Simulation Output Log file
Simulation Procedure CTMSIM
836 CONTROL-M for OS/390 and z/OS User Guide
s It may be necessary to resolve manual conditions prior to the simulation run so
that all jobs are submitted.
Activating the Procedure
The procedure can be invoked directly, that is, through / / EXEC CTMSIM, or
through a job generated by option M3 of the Online Utilities menu.
Option M3 is the preferred method of generating the job stream for the procedure
because the Online utility can automatically perform certain necessary preparatory
steps (mentioned above). If the Online utility is not used, the user must add these
steps, as necessary, to the JCL.
The M3 Online utility is discussed in M3: Prepare Simulation/ Tape Pull List Job on
page 330.
Preparatory Steps
The following preparatory steps must be added, as needed, to the simulation job.
Allocate IOA Conditions File
The DACNDF DD statement references the IOA Conditions file. It may refer to either
of the following files:
s the production IOA Conditions file
If this file is used, it only needs allocation.
s a test file used to simulate jobs planned for a future working day
If a test file is used, an initial job step must allocate and format the simulation
Active Jobs file. A date record is then generated for the date of the simulation. A
User Daily job step then loads the required job orders into the simulation Active
Jobs file.
This preparatory step can be automatically generated through the M3 online utility.
All jobs in the Active Jobs file participate in the simulation. For jobs that are currently
executing at the time the simulation is running, it is assumed that they have already
executed half of their average elapsed time.
Simulation Procedure CTMSIM
Chapter 7 Simulation and Forecasting Facility 837
Allocate CONTROL-M Resources File
The DACNDF DD statement references the CONTROL-M Resources file. It may refer
to either of the following files:
s the production CONTROL-M Resources file
If this file is used, it only needs allocation.
s a test file, which can be used to define Quantitative resources under simulation,
using the IOACND utility
Parameters
There are two ways of setting parameters for the utility.
Parameters can be passed to the utility using the SIMPARM member in the
CONTROL-M PARM library. This member is referenced by the DASIMPRM
DD statement in the Simulation procedure, if it is specified in option M3 (Prepare
Simulation/ Tape Pull List Job) of the Online Utilities.
Alternatively, parameters may be passed to the utility in-line, using the DASIMPRM
(or SYSIN) DD statement.
Table 247 Parameters Passed to the Utility by DASIMPRM
Parameter Description
SIMSTART Date and time at which the simulation must start, in
yymmddhhmm format. Mandatory.
SIMEND Date and time at which the simulation must end, in
yymmddhhmm format. Mandatory.
Note: Ordinarily the interval between specified SIMSTART
and SIMEND values should not exceed a 24 hour period
because there is no mechanism to simulate New Day
processing for the next day. However, it is possible to specify a
larger interval if one is required to enable existing jobs to
complete.
INTERVAL mm Simulation interval, in minutes. The simulation clock
advances by the interval specified. The shorter the interval, the
more accurate the simulation, but the longer the simulation
takes to run. The specified interval must not exceed one
working day. Mandatory.
Simulation Procedure CTMSIM
838 CONTROL-M for OS/390 and z/OS User Guide
NEWJOB For a job that has no execution statistics, this statement is used
to indicate the expected execution time of the job. Optional.
If the simulation encounters a job without statistics and this
statement is not supplied, a default execution time of three
minutes is used.
The format of the NEWJOB parameter is as follows:
NEWJOB memname EXECTI ME mmmm. xx [ GROUP
gr oupname] [ CPUI D i ]
The following subparameters can be specified:
s memname name of the member containing the JCL of the
job. This value helps identify the job order in the Active
Jobs file. Mandatory.
s mmmm.xx expected execution time, where mmmm is the
number of minutes and xx is hundredths of minutes. This
is the same format used in the sysout Log message of the
job. Mandatory.
s groupname name of the group to which the job belongs.
This value helps identify the job order in the Active Jobs
file. Optional.
s i CPU ID. In a multiple CPU environment, the job can
have different execution times on different CPUs.
Therefore, it is useful to specify the expected elapsed time
for each CPU on which the job may run. i must have the
same value as $SIGN, which is described in %%$SIGN
on page 739. Optional.
OLDJOB For a job with execution statistics, this statement can be used
to override the statistically estimated execution time. For
example, a longer execution time can be specified to test the
effect of adding more input data to the job. Optional.
Format of the OLDJOB parameter is as follows:
OLDJOB memname EXECTI ME mmmm. xx [ GROUP
gr oupname] [ CPUI D i ]
The same subparameters can be specified for the OLDJOB
parameter as those for the NEWJOB parameter (in this table).
Table 247 Parameters Passed to the Utility by DASIMPRM (continued)
Parameter Description
Simulation Procedure CTMSIM
Chapter 7 Simulation and Forecasting Facility 839
Input Files
The simulation procedure accepts the following input files:
s Active Jobs filecreated in the course of the preparatory steps described in
Preparatory Steps on page 836
s Job Execution Statistics filethe DASTAT DD statement references the
CONTROL-M Job Execution Statistics file; this file contains job execution statistics,
including the execution elapsed time
ADD
or
DELETE
Add or delete a prerequisite condition of a specific ODATE
(original scheduling date) at a specified simulation date and
time.
The format of the ADD or DELETE parameter is as follows:
{ ADD| DELETE} COND condname odat e ONDAYTI ME
yymmddhhmm
The following subparameters can be specified:
s ADD| DELETE action to be performed. Mandatory.
s condname name of the condition to be added or deleted.
Mandatory.
s odate original scheduling date associated with the
condition. Mandatory.
s yymmddhhmm simulation date and time at which the
condition must be added or deleted. Mandatory.
CHANGE
RESOURCE
Change the quantity of a given resource at a specified
simulation date and time.
Format of the CHANGE RESOURCE parameter is as follows:
CHANGE RESOURCE r esname quant i t y ONDAYTI ME
yymmddhhmm
The following subparameters can be specified:
s resname name of the resource whose quantity is to be
changed. Mandatory.
s quantity change in quantity for the resource. The quantity
change can be specified in any of the following formats:
nnnn set the quantity to the specified value
+nnnn add the specified quantity to the current
quantity
-nnnn subtract the specified quantity from the current
quantity
s yymmddhhmm simulation date and time at which the
resource quantity must be changed. Optional.
Table 247 Parameters Passed to the Utility by DASIMPRM (continued)
Parameter Description
Simulation Procedure CTMSIM
840 CONTROL-M for OS/390 and z/OS User Guide
s IOA Conditions filecreated in the course of the preparatory steps described in
Preparatory Steps on page 836
s CONTROL-M Resources filecreated in the course of the preparatory steps
described in Preparatory Steps on page 836
Output Files
The simulation run produces the following output files:
s Simulation Messages file
The DASIMOUT DD statement references a sequential file containing a list of the
simulation parameters used, and special messages for error codes, warning
situations, and so on. In addition, it contains all the SHOUT messages to
TSO/ ROSCOE users and to the computer operator.
s SIMLOGSimulation Log file
The DALOGOUT DD statement references a sequential output file in a format
similar to that of the IOA Log file.
At the end of the simulation process, this file contains all the log messages
describing events that occurred during the simulation run, for example, JOB
SUBMITTED, JOB ENDED OK, or COND xxxx ADDED.
This file can be used as input to all CONTROL-M reports that are normally
produced from the IOA Log file. The standard set of reports produced from the
IOA Log can be used to analyze the simulation run. Therefore, it is not necessary to
write special simulation reports.
s SIMOAJFActive Jobs file
The DACKPTOU DD statement references a file in the format of the Active Jobs
file. All jobs that were present in the input Active Jobs file are written to this file
with the status assigned to them during the simulation run, for example, ENDED
OK, EXECUTING, or WAIT SCHEDULE.
The file can be scanned online or in batch mode using standard CONTROL-M
facilities.
s SIMOCNDConditions file
The SIMOCND DD statement references a file in the format of the IOA Conditions
file. All conditions that were present at the end of the simulation run are written to
this file.
Simulation Procedure CTMSIM
Chapter 7 Simulation and Forecasting Facility 841
The file can be scanned online or in batch mode using standard CONTROL-M
facilities.
s SIMORESResources file
The SIMORES DD statement references a file in the format of the CONTROL-M
Resources file. All Quantitative resources and Control resources that were present
at the end of the simulation run are written to this file.
The file can be scanned online or in batch mode using standard CONTROL-M
facilities.
CONTROL-M Exits and Simulation Processing
The CONTROL-M Simulation and Forecasting facility functions in much the same
way as the CONTROL-M monitor, but is activated without performing real I/ O.
Therefore, some of the exits activated under the CONTROL-M monitor are also
activated during simulation.
Exit CTMX003 (output scanning) is invoked once for each job. The exit does not
receive any sysout. Since the simulation assumes that each job ended execution with a
condition code of 0, this exit can also be used to add events for certain jobs that end
with a nonzero condition code that influences the job flow.
Exit CTMX002 is not activated in simulation mode.
If the same exit is to be used in both the production and simulation environments, it
may be necessary to determine which environment is currently active. The
MCTSMIND field in the MCT can be checked as follows to determine whether the
exit is running under simulation:
TM MCTSMI ND, MCTSI MYS ARE WE UNDER SI MULATI ON?
BO SKI PPROD YES, SKI P PRODUCTI ON LOGI C
Simulation Procedure CTMSIM
842 CONTROL-M for OS/390 and z/OS User Guide
Sample Input
Figure 349 CONTROL-M Simulation Exit Screen
Analyzing the Simulation Run
The following tools can be used to analyze the simulation run and to diagnose
problems that may have occurred during simulation processing.
s output of the Simulation Run
s output of the KSL Step
s Night Schedule Report
s Online Simulation Environment
s the CTMRAFL utility
/ / EXEC CTMSI M
/ / SI M. DACKPTI N DD DSN=XXX. CTM. PROD. TESTAJF, DI SP=SHR
/ / SI M. SYSI N DD *
SI MSTART 0106060900
SI MEND 0106062200
I NTERVAL 15
NEWJOB D4TRY1 EXECTI ME 2. 30
NEWJOB D4TRY2 EXECTI ME 100. 00 CPUI D 1
NEWJOB D4TRY2 EXECTI ME 120. 00 CPUI D 2
CHANGE RESOURCE TAPE - 3 ONDAYTI ME 0106061600
ADD COND I R- TAPE- ARRI VED 0606 ONDAYTI ME 0106061800
ADD COND END- CI CS 0606 ONDAYTI ME 0106062100
/ /
. . SI M076I SI MULATI ON STARTED
SI MSTART 0112122100
SI MEND 0112122130
I NTERVAL 55
ADD COND TAP- TEST- OK 0606 ONDAYTI ME 0106062102
ADD COND TAP- TEST2- OK 0606 ONDAYTI ME 0106062102
ADD COND PUL2- OK 0606 ONDAYTI ME 0106062102
ADD COND PUL1- OK 0606 ONDAYTI ME 0106062102
ADD COND PUL2- OK 0606 ONDAYTI ME 0106062102
NEWJOB ASMMCTD EXECTI ME 0001. 00
NEWJOB ASMMCTM EXECTI ME 0001. 00
21. 00. 00 RUN100I CONTROL- M MONI TOR STARTED
21. 00. 00 SI M087WMEMBER PRDJBREG LI BRARY PROD. DAI LY. JOBS -
DEFAULT ELAPSED TI ME USED
21. 00. 00 SI M087WMEMBER PRDJBDAY LI BRARY PROD. DAI LY. JOBS -
DEFAULT ELAPSED TI ME USED
21. 02. 45 CTM567I COND PUL2- OK ODATE 0606 ADDED
21. 02. 45 CTM567I COND PUL1- OK ODATE 0606 ADDED
21. 02. 45 CTM587I COND PUL2- OK ODATE 0606 ALREADY EXI STS
21. 02. 45 CTM567I COND TAP- TEST2- OK ODATE 0606 ADDED
21. 02. 45 CTM567I COND TAP- TEST- OK ODATE 0606 ADDED
21. 31. 10 SI M098I TASK EXECDAY DI D NOT FI NI SH EXECUTI NG
21. 31. 10 SI M098I TASK PRDTEST DI D NOT FI NI SH EXECUTI NG
21. 31. 10 SI M099I TASK MPMXXX STI LL WAI TS SCHEDULE
21. 31. 10 SI M099I TASK MPMTST STI LL WAI TS SCHEDULE
21. 31. 10 RUN120I CONTROL- M MONI TOR SHUTTI NG DOWN
21. 31. 10 SI M078I SI MULATI ON ENDED
Simulation Procedure CTMSIM
Chapter 7 Simulation and Forecasting Facility 843
These tools are described below.
Output of the Simulation Run
The DASIMOUT DD statement references summary information about the
simulation run. It specifies which jobs ran, which are still in WAIT SCHEDULE
status, and which are still executing when the simulation terminates. The following
tools can be used to ascertain why certain jobs remain in WAIT SCHEDULE status
when the simulation run is terminated.
Output of the KSL Step
The REP3LEFT KSL script can be executed after the simulation step. REP3LEFT
generates a report that shows the reasons why certain jobs are still in WAIT
SCHEDULE status at the end of the simulation run. This report can be requested as
an option through the M3 Online utility.
Night Schedule Report
This report provides a summary of each job that fell within the time interval of the
simulation run. This report can be requested as an option through the M3 Online
utility.
Online Simulation Environment
A special online environment can be created for the allocation of the files written by
the simulation run. The online environment must include the following allocations:
For information about creating the online simulation environment, see the
INCONTROL for OS/390 and z/OS Administrator Guide.
The online environment can be used to determine not only which jobs were
submitted, but which jobs are waiting to be scheduled and why they remained in
WAIT SCHEDULE status at the termination of the simulation run.
Table 248 Online Simulation Environment File Allocations
Allocation Description
DACKPT DD statement Allocated to file SIMOAJF
DACNDF DD statement Allocated to file SIMORES
DACNDF DD statement Allocated to file SIMOCND
DALOG DD statement Allocated to file SIMLOG
Simulation Procedure CTMSIM
844 CONTROL-M for OS/390 and z/OS User Guide
The CTMRAFL Utility
The CTMRAFL utility, which is described in the INCONTROL for OS/390 and z/OS
Utilities Guide, can be run on the simulation input Active Jobs file to obtain
information on job dependencies and manual conditions. The CTMRAFL utility does
not check the IOA Conditions file. Therefore, conditions listed as manual
conditions may actually exist in the IOA Conditions file.
Handling Manual Conditions
Perform the following steps to incorporate manual conditions into the IOA
Conditions file that is used in the simulation procedure.
1. Create a Conditions file and a Manual Conditions file to be used for simulation
only. You can use the FORMCND and FORMNRS members in the IOA INSTALL
library to do this. The file name CND can be changed to SIMCND. The file names
NRS and NSN can be changed to SIMNRS and SIMNSN respectively.
2. Using the CTMCOPRS utility, copy the contents of the production IOA Conditions
file into the simulation Conditions file created in Step 1.
3. Integrate the IOALDNRS utility into the standard CTMSIM procedure so that it
runs against the simulation Active Jobs File, which has been loaded with
simulation jobs, to load the manual conditions into the simulation NRS file
SIMNRS.
Specify the following overrides when using the IOALDNRS procedure:
4. Integrate the ADDCMND job, which is in the CONTROL-M JCL library, into the
standard CTMSIM procedure to add the required manual Maybe conditions to the
simulation Conditions file.
Specify the following overrides when running ADDMNCND:
Table 249 Overrides To Be Specified on IOALDNRS
DDname DSname Suffix Override Suffix
DANRES NRS SIMNRS
DANSINC NSN SIMNSN
DACNDF CND SIMCND
The CTMTAPUL Tape Pull List Procedure
Chapter 7 Simulation and Forecasting Facility 845
5. Specify the following override for the simulation step:
The CTMTAPUL Tape Pull List Procedure
The Tape Pull List procedure creates a list of all tapes to be mounted in a specified
period. The list can be sorted and edited in various ways, such as
s all tapes to be mounted, sorted by the expected mount time
s all tapes to be mounted, sorted by volume serial number
The procedure takes into account the expected order of job execution and the order of
creation of tape data sets.
The procedure also does the following:
s checks the syntax of all AutoEdit statements in all jobs that are planned for the
given period
s checks the JCL syntax
s produces a list of data sets that are still missing for the execution.
These are usually input data sets due to arrive, but they may be JCL execution
errors
Table 250 Overrides To Be Specified on ADDMNCND
DDname DSname Suffix Override Suffix
DANRES NRS SIMNRS
DANSINC NSN SIMNSN
Table 251 Override To Be Specified for Simulation Step
DDname DSname Suffix Override Suffix
DACNDF CND SIMCND
NOTE
It is highly recommended that the simulation be run from the current time, that is, not
from a time in the future. Otherwise, the Tape Pull list results may be inaccurate
because new tape files may be cataloged in the time remaining before the start of the
simulation run.
The CTMTAPUL Tape Pull List Procedure
846 CONTROL-M for OS/390 and z/OS User Guide
The Tape Pull List procedure uses files from the Simulation procedure as input. In
preparation for the Tape Pull List procedure, run the Simulation procedure using the
production CONTROL-M Active Jobs file, CONTROL-M Resources file, and IOA
Conditions file.
The Tape Pull List procedure works as follows:
s The procedure looks for SUBMISSION messages in the simulation output LOG
file.
For each submission message, it looks for the appropriate job having a WAIT
SCHEDULE status on the simulation input Active Jobs file.
If a job is found, the Tape Pull List procedure actually submits the job with the
TYPRUN=SCAN parameter specification, reads the SYSOUT of the job,
retrieves the data set information, and produces the required reports.
s The procedure recognizes tape data sets by either the appropriate unit
specification in the JCL, such as UNIT=TAPE, or by retrieving information from
the system catalog. It is therefore not necessary to have all tape data sets cataloged
in the MVS catalog.
The procedure can detect that a certain tape is used by more than one job, and
which job creates it, as illustrated in the following example.
Job A creates a new generation of a tape data set:
/ / OUTUPD DD DSN=PFX. DATA( +1) , DI SP=( , CATLG) , . . .
Job B, a successor of Job A, accesses the same data set:
/ / I NUPD DD DSN=PFX. DATA( 0) , DI SP=SHR
The procedure detects that Job A is the creator of the data set used by Job B and
reports the same tape volser for both jobs.
NOTE
For the Tape Pull List procedure to be executed properly, the internal reader
(INTRDR) must have authority to submit jobs.
NOTE
A highlighted warning message appears on the operator console while the jobs are
being submitted. During this stage, the operator console may display several
messages regarding the job submission. The highlighted message disappears at the
end of this stage.
The CTMTAPUL Tape Pull List Procedure
Chapter 7 Simulation and Forecasting Facility 847
s After the job sysout has been analyzed, the sysout is deleted from spool.
s The next stage of the procedure produces reports according to the requested
parameters.
Activating the Procedure
The Tape Pull List procedure is activated as follows:
Parameters
There are two ways of setting parameters for the utility.
Parameters can be passed to the Tape Pull List utility using the TAPULPRM member
in the CONTROL-M PARM library. This member is referenced by the TAPULIN
DD statement in the Tape Pull List procedure, CTMTAPUL, if it is specified in option
M3 (Prepare Simulation/ Tape Pull List Job) of the Online Utilities.
Alternatively, parameters may be passed to the utility in-line, using the TAPULIN
DD statement.
/ / EXEC CTMTAPUL
/ / TAPULI N DD *
par amet er s
Table 252 CTMTAPUL Subparameters (Part 1 of 2)
Subparameter Description
REPBYVOL Produce a report sorted by volume serial number
(volser). All tapes from the tape library are included.
REPBYTIME Produce a report sorted by the expected mount time.
REPBYJOB Produce a report sorted by job name.
REPBYDSN Produce a report sorted by data set name.
The CTMTAPUL Tape Pull List Procedure
848 CONTROL-M for OS/390 and z/OS User Guide
The Tape Pull List job can be prepared using the (ISPF) Simulation panel (Option M3
in the IOA Online Utilities menu). A special section of the panel is designated for
Tape Pull List parameters. If you want to run the Tape Pull List procedure
1. Type Y in the TAPE PULL LIST field.
2. Type Y in the field next to the desired type of report.
The default control parameters member name appears on the screen. This member
contains IGNORE statements (procedure parameters). JOB/ SCAN parameters are
discussed in JOB/ SCANDOCU/ TEXT Interface on page 849.
After filling in the parameters, enter the edited JCL of a job to run the simulation and
the procedure. You can submit it, or save it for future use.
JCLFILE
{YES| NO| ONLY}
Whether a copy of every submitted job is written to the
file referenced by the DAJCLOUT DD statement.
Valid values are:
s YES A copy of every submitted job is written to the
file referenced by the DAJCLOUT DD statement.
s NO A copy of every submitted job is not written to
the file referenced by the DAJCLOUT DD statement.
Default.
s ONLY A copy of every submitted job is written to
the file referenced by the DAJCLOUT DD statement,
but
the procedure does not submit the job
the Tape Pull reports are not created
the procedure is run to create the JCL file only
Note: When dealing with submitted jobs, the utility, for
internal processing purposes, inserts the following
accounting code into the jobcard of the job:
CTM- FORCE- TPLNM
When operating under JES3, the following statement is
also inserted:
/ / * NET I D=AESUSER
IGNORE DSN dsn Data set name (or prefix) that must not appear in the
report. If the last character of dsn is *, it is treated as a
prefix.
IGNORE JOB jobname Job name (or prefix) that must not appear in the report. If
the last character of jobname is *, it is treated as a prefix.
Table 252 CTMTAPUL Subparameters (Part 2 of 2)
Subparameter Description
The CTMTAPUL Tape Pull List Procedure
Chapter 7 Simulation and Forecasting Facility 849
DD Statements
The following DD statements are used by procedure CTMTAPUL:
JOB/SCANDOCU/TEXT Interface
For users of JOB/ SCAN-DOCU/ TEXT.
When the JCLFILE parameter is specified, every job that is submitted by the
procedure for JCL scan is also written to the DAJCLOUT DD statement. At the end of
execution of the procedure, this data set (if allocated) contains all jobs that are
submitted during the execution period according to the order of submission. This file
can be used as input to JOB/ SCAN DOCU/ TEXT products.
Table 253 DD Statements Used by CTMTAPUL
DD Statement Description
DALOGIN Output Log file of the Simulation facility, which is input for
the Tape Pull List procedure.
DACKPTIN Active Jobs file used as input to the simulation, but remains
unmodified).
TAPULIN Procedure parameters.
DATAPNAM Member containing a list of local names used by the site to
describe tape units and cassettes or cartridges.
The TAPNAM member in the CONTROL-M PARM library
contains a sample list of local names used by the data center to
describe tapes, cassettes, cartridges and DASD units.
CONTROL-M recognizes IBM-supplied names such as 3480,
which do not need to be specified.
This member is referenced by this DATAPNAM DD statement
in the Tape Pull List procedure, CTMTAPUL.
The format of each line in the list is:
s Columns 1 through 8 Unit name
s Column 9 One of the following indicators:
T Tape
C Cassette or Cartridge
D DASD
DAREPOUT Reports output.
TAPULOUT Messages (of the procedure).
DAJCLOUT Job stream of the jobs that is submitted during the specified
period. For more information, see the following section,
JOB/ SCAN DOCU/ TEXT Interface.
The CTMTAPUL Tape Pull List Procedure
850 CONTROL-M for OS/390 and z/OS User Guide
In sites using the JOB/ SCAN DOCU/ TEXT Interface, the lower portion of the M3
Online utility, which is described in M3: Prepare Simulation/ Tape Pull List Job on
page 330, contains INVOKE JOB/ SCAN parameters.
Problem Determination for Tape Pull List Reports
The following conditions must be satisfied before the Tape Pull List procedure can
forecast tapes for a specific job:
s The submission message must be present in the simulation output Log file.
s The corresponding job has a WAIT SCHEDULE status in the simulation input
Active Jobs file.
Reports are not produced if one or more of the following situations exist:
s None of the submitted jobs required tapes.
s Jobs requiring tapes were not submitted by the simulation because their
submission criteria were not satisfied.
s An invalid Active Jobs file was specified as an input for the Tape Pull List
procedure.
s An invalid Log file was specified as an input for the Tape Pull List procedure.
s JCLFILE ONLY was specified as an input parameter for the procedure.
s No reports were requested from the procedure through the input parameters, that
is, the default was no reports.
s The procedure does not recognize tape data sets. For more information, see the
description of the Tape Pull list utility in the discussion of CONTROL-M
customization in the INCONTROL for OS/390 and z/OS Installation Guide.
Sample Tape Pull List Reports
The following pages show a series of samples of reports produced by CTMTAPUL. In
these samples, when the values M-N or M-O appear in the DISP (disposition) column,
they signify a disposition of MOD, either as a NEW (M-N) or OLD (M-O) data set.
The CTMTAPUL Tape Pull List Procedure
Chapter 7 Simulation and Forecasting Facility 851
Figure 350 Sample Tape Pull List Report 1
PRODUCED BY CONTROL- M PROD TAPE PULL LI ST
BMC SOFTWARE, I NC. ====================

JOBNAME USER ODATE TI ME MEMNAME VOLSER LAB# TYPE DI SP DSNAME PROCNAME STEPNAME DDNAME
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SMFSAVE M05 060601 09: 06 SMFSAVE 110050 0001 T M- O BKP. MONTH. CONT02( +0) STEP3 TAPE1
110051 T
110048 0001 T M- O BKP. MONTH. CONT02( - 1) STEP3 TAPE2
110049 T
110058 0001 T M- O BKP. MONTH. CONTO2( - 2) STEP3 TAPE3
110059 T
PRDI NPUT M05 060601 09: 02 PRDI NPUT 996713 0001 T NEW PRD. TP. FI LE1( +1) ST1 DD1
S#0001 0001 C NEW PRDW. FI LE. GDG. GRPM1( +1) BADSTEP BADD1
100047 0001 T M- O BKP. WEEK. CONT01( - 2) ASTEP1 OUT0
PRDUPDT1 M05 060601 09: 09 PRDUPDT1 114003 0001 T OLD PRDW. FI LE. GDG. GRP11( +0) RES TAP1GDG0
114002 0001 T OLD PRDW. FI LE. GDG. GRP11( - 1) RES TAP1GDG2
S#0004 0001 T NEW BKP. MONTH. CONT01( +1) RESTORE CYCLI C DACYCT
114003 0001 T OLD PRDW. FI LE. GDG. GRP11( +0) RESTORE CYCLI C TAPEGDG0
$#0005 0001 C NEW PRDO. TP. UPDT1 RESTORE CYCLI C CASSFI LE
PRDRPT2C M05 060601 09: 19 PRDRPT2C $#0006 0001 T NEW PRD. TP. DAI LY. REPORTS ASTEP1 OUT
113492 0001 T OLD PRD. CART. RPT2C BACKUP CYCLI C DACYCT
$#0007 0001 T NEW BKP. MONTH. CONT02( +1) BACKUP CYCLI C DACYCT
PRDRPT2D M05 060601 09: 22 PRDRPT2D 114003 0001 T OLD PRDW. FI LE. GDG. GRP11( +0) ST1 TAPE0
T00001 0001 T NEW PRD. SNG1912. TAPE1( +1) ST1 TAPE1
T00002 0002 T NEW PRD. SNG1912. TAPE1( +2) ST1 TAPE11
994529 0001 T NEW PRDW. FI LE. GDG. GRP21( +0) ST2 TAPE0
997892 0003 T NEW PRD. SNG1912. TAPE2( +1) ST2 TAPE2
S#0008 0001 T NEW &&NEWTEMP ST2 TAPETMP
996638 T NEW BKP. MONTH. CONT01( +3) ST2 TAPE8O2
PRDEXE2E M05 060601 09: 25 PRDEXE2E T00002 0002 T OLD PRD. SNG1912. TAPE1( +0) STEP1 I NTAPE1
T00001 0001 T OLD PRD. SNG1912. TAPE1( - 1) STEP1 I NTAPE11
S#0007 0001 T OLD BKP. MONTH. CONT02( +0) STEP2 TAPE5
110050 0001 T OLD BKP. MONTH. CONT02( - 1) STEP2 TAPE6
110051 T
110048 0001 T OLD BKP. MONTH. CONT02( - 2) STEP2 TAPE7
110049 T
110058 0001 T OLD BKP. MONTH. CONT02( - 3) STEP2 TAPE8
110059 T
110056 0001 T OLD BKP. MONTH. CONT02( - 4) STEP2 TAPE9
110057 T

SORTBY JOBNAME ( REPBYJOB)
The CTMTAPUL Tape Pull List Procedure
852 CONTROL-M for OS/390 and z/OS User Guide
Figure 351 Sample Tape Pull List Report 2
PRODUCED BY CONTROL- M PROD TAPE PULL LI ST
BMC SOFTWARE, I NC. ====================
DSNAME JOBNAME MEMNAME VOLSER DI SP TYPE PROCNAME STEPNAME DDNAME
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
&&NEWTEMP PRDRPT2D PRDRPT2D S#0008 NEW T ST2 TAPETMP
BKP. MONTH. CONT01( +1) PRDUPDT1 PRDUPDT1 S#0004 NEW T RESTORE CYCLI C DACYCT
BKP. MONTH. CONT01( +3) PRDRPT2D PRDRPT2D 996638 NEW T ST2 TAPE8O2
BKP. MONTH. CONT01( +0) SMFSAVE SMFSAVE 110050 M- O T STEP3 TAPE1
110051 M- O T STEP3 TAPE1
PRDEXE2E PRDEXE2E S#0007 OLD T STEP2 TAPE5
BKP. MONTH. CONT02( +1) PRDRPT2C PRDRPT2C S#0007 NEW T BACKUP CYCLI C DACYCT
BKP. MONTH. CONT02( - 1) SMFSAVE SMFSAVE 110048 M- O T STEP3 TAPE2
PRDEXE2E PRDEXE2E 110050 OLD T STEP2 TAPE6
110051 OLD T STEP2 TAPE6
BKP. MONTH. CONT02( - 2) SMFSAVE SMFSAVE 110058 M- O T STEP3 TAPE3
110059 M- O T STEP3 TAPE3
PRDEXE2E PRDEXE2E 110048 OLD T STEP2 TAPE7
100049 OLD T STEP2 TAPE7
BKP. MONTH. CONT02( - 3) PRDEXE2E PRDEXE2E 110058 OLD T STEP2 TAPE8
110059 OLD T STEP2 TAPE8
BKP. MONTH. CONT02( - 4) PRDEXE2E PRDEXE2E 110056 OLD T STEP2 TAPE9
110057 OLD T STEP2 TAPE9
BKP. WEEK. CONT01( - 2) PRDI NPUT PRDI NPUT 100047 M- O T ASTEP1 OUT0
PRD. SNG1912. TAPE1( +0) PRDEXE2E PRDEXE2E T00002 OLD T STEP1 I NTAPE1
PRD. SNG1912. TAPE1( +1) PRDRPT2D PRDRPT2D T00001 NEW T ST1 TAPE1
PRD. SNG1912. TAPE1( +2) PRDRPT2D PRDRPT2D T00002 NEW T ST1 TAPE11
PRD. SNG1912. TAPE1( - 1) PRDEXE2E PRDEXE2E T00001 OLD T STEP1 I NTAPE11
PRD. SNG1912. TAPE2( +0) PRDEXE2E PRDEXE2E 997892 OLD T STEP2 I NTAPE2
PRD. SNG1912. TAPE2( +1) PRDRPT2D PRDRPT2D 997892 NEW T ST2 TAPE2
PRD. TP. FI LE1( +1) PRDI NPUT PRDI NPUT 996713 NEW T ST1 DD1
PRDW. FI LE. GDG. GRPM1( +0) PRDI NPUT PRDI NPUT S#0001 OLD C BADSTEP BADD2
PRDW. FI LE. GDG. GRPM1( +1) PRDI NPUT PRDI NPUT S#0001 NEW C BADSTEP BADD1
PRDW. FI LE. GDG. GRPM8( +1) PRDI NPUT PRDI NPUT S#0003 NEW T ASTEP1 TAPEGDG8
PRDW. FI LE. GDG. GRP11( +0) PRDI NPUT PRDI NPUT 114002 OLD T ASTEP1 TAPEGDG0
PRDUPDT1 PRDUPDT1 114003 OLD T RES TAP1GDG0
PRDRPT2D PRDRPT2D 114003 OLD T ST1 TAPE0
T00002 NEW T ST1 TAPE12
PRDW. FI LE. GDG. GRP11( +1) PRDI NPUT PRDI NPUT 114003 NEW T ASTEP1 TAPEGDG2
PRDW. FI LE. GDG. GRP11( - 0) PRDI NPUT PRDI NPUT 114002 OLD T ASTEP1 TAPEGDG1
PRDUPDT1 PRDUPDT1 114003 OLD T RES TAP1GDG1
PRDRPT2D PRDRPT2D 114003 OLD T ST2 TAPE01
PRDW. FI LE. GDG. GRP11( - 0) PRDUPDT1 PRDUPDT1 114002 OLD T RES TAP1GDG2
SORTBY DSNAME ( REPBYDSN)
The CTMTAPUL Tape Pull List Procedure
Chapter 7 Simulation and Forecasting Facility 853
Figure 352 Sample Tape Pull List Report 3
PRODUCED BY CONTROL- M PROD TAPE PULL LI ST
BMC SOFTWARE, I NC. ====================

VOLSER TYPE JOBNAME ODATE TI ME DI SP LAB# DSNAME
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
S#0001 C PRDI NPUT 060601 22: 02 NEW 0001 PRDW. TESTFI LE. GDG. GRPM1( +1)
S#0002 T PRDI NPUT 060601 22: 02 NEW 0001 PRD. TP. TRANS
S#0003 T PRDI NPUT 060601 22: 02 NEW 0001 PRDW. TESTFI LE. GDG. GRPM8( +1)
S#0004 T PRDUPDT1 060601 22: 09 NEW 0001 BKP. MONTH. CONT01( +1)
T00001 T PRDRPT2D 060601 22: 22 NEW 0001 PRD. SNG1912. TAPE1( +1)
T00002 T PRDRPT2D 060601 22: 22 NEW 0002 PRD. SNG1912. TAPE1( +2)
100000 T PRDI NPUT 060601 22: 02 OLD 0001 PRDW. TESTFI LE. GDG. GRPM8( +0)
100047 T PRDI NPUT 060601 22: 02 M- O 0001 BKP. WEEK. CONT01( - 2)
100048 T PRDI NPUT 060601 22: 02 M- O 0001 BKP. WEEK. CONT01( - 2)
110048 T SMFSAVE 060601 22: 06 M- O 0001 BKP. MONTH. CONT02( - 1)
PRDEXE2E 060601 22: 25 OLD 0001 BKP. MONTH. CONT02( - 2)
110049 T SMFSAVE 060601 22: 06 M- O 0001 BKP. MONTH. CONT02( - 1)
PRDEXE2E 060601 22: 25 OLD 0001 BKP. MONTH. CONT02( - 2)
110050 T SMFSAVE 060601 22: 06 M- O 0001 BKP. MONTH. CONT02( +0)
PRDEXE2E 060601 22: 25 OLD 0001 BKP. MONTH. CONT02( - 1)
PRDRUN2F 060601 22: 28 M- O 0001 BKP. MONTH. CONT02( - 2)
110051 T SMFSAVE 060601 22: 06 M- O 0001 BKP. MONTH. CONT02( +0)
PRDEXE2E 060601 22: 25 OLD 0001 BKP. MONTH. CONT02( - 1)
PRDRUN2F 060601 22: 28 M- O 0001 BKP. MONTH. CONT02( - 2)
996713 T PRDI NPUT 060601 22: 02 NEW 0001 PRD. TP. FI LE1( +1)
997892 T PRDRPT2D 060601 22: 22 NEW 0003 PRD. SNG1912. TAPE2( +1)
PRDEXE2E 060601 22: 25 OLD 0003 PRD. SNG1912. TAPE2( +0)

SORTBY VOLUME ( REPBYVOL)
The CTMTAPUL Tape Pull List Procedure
854 CONTROL-M for OS/390 and z/OS User Guide
Figure 353 Sample Tape Pull List Report 4
PRODUCED BY CONTROL- M PROD TAPE PULL LI ST
BMC SOFTWARE, I NC. ====================
ODATE TI ME VOLSER TYPE JOBNAME DI SP DSNAME
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
060601 22: 02 996713 T PRDI NPUT NEW PRD. TP. FI LE1( +1)
S#0001 C NEW PRDW. FI LE. GDG. GRPM1( +1)
100047 T M- O BKP. WEEK. CONT01( - 2)
S#0002 T NEW PRD. TP. TRANS
060601 22: 06 110050 T SMFSAVE M- O BKP. MONTH. CONT02( +0)
110051 T
100048 T M- O BKP. MONTH. CONT02( - 1)
110049 T
110058 T M- O BKP. MONTH. CONT02( - 2)
110059 T
060601 22: 09 114003 T PRDUPDT1 OLD PRDW. FI LE. GDG. GRP11( +0)
114002 T OLD PRDW. FI LE. GDG. GRP11( - 1)
S#0004 T NEW BKP. MONTH. CONT01( +1)
114003 T OLD PRDW. FI LW. GDG. GRP11( +0)
S#0005 C NEW PRDO. TP. UPDT1
060601 22: 19 S#0006 T PRDRPT2C NEW PRD. TP. DAI LY. REPORTS
113492 T OLD PRD. CART. RPT2C
S#0007 T NEW BKP. MONTH. CONT02( +1)
060601 22: 22 114003 T PRDRPT2D OLD PRDW. FI LE. GDG. GRP11( +0)
T00001 T NEW PRD. SNG1912. TAPE1( +1)
T00002 T NEW PRD. SNG1912. TAPE1( +2)
994529 T NEW PRDW. FI LE. GDG. GRP21( +0)
997892 T NEW PRD. SNG1912. TAPE2( +1)
S#0008 T NEW &&NEWTEMP
996638 T NEW BKP. MONTH. CONT01( +3)
060601 22: 25 T00002 T PRDEXE2E OLD PRD. SNG1912. TAPE1( +0)
TOOOO1 T OLD PRD. SNG1912. TAPE1( - 1)
S#0007 T OLD BKP. MONTH. CONT02( +0)
110050 T OLD BKP. MONTH. CONT02( - 1)
110051 T
110048 T OLD BKP. MONTH. CONT02( - 2)
110049 T
110058 T OLD BKP. MONTH. CONT02( - 3)
110059 T
110056 T OLD BKP. MONTH. CONT02( - 4)
110057 T

SORTBY TI ME ( REPBYTI M)
Chapter 8 KeyStroke Language (KSL) 855
Chapt er
8
8 KeyStroke Language (KSL)
This chapter includes the following topics:
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
CTMAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
KeyStroke Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Activating KeyStroke Language Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
KSL Command and Variable Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Principles of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Language Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
KSL Commands and Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
KSL Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Special KSL Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Sample KeyStroke Reports and Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Sample KSL Report Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Overview
856 CONTROL-M for OS/390 and z/OS User Guide
Overview
This chapter deals with the following related topics:
s KeyStroke Language (KSL)
The IOA standard KeyStroke Language (KSL) is a general purpose language that
simulates, in batch, keystrokes that are entered in the IOA Online facility. KSL
language statements (commands) are specified in programs called scripts.
s Reporting facility
Two types of reports are available under CONTROL-M:
Reports produced in batch by KSL scripts. These are listed later in this chapter,
and samples of supported KSL scripts are located in the IOA KSL library.
CONTROL-M special reports that cannot readily be produced using the Online
facility or KSL. These are produced by utilities that are described in the
INCONTROL for OS/390 and z/OS Utilities Guide.
Some CONTROL-M reports are produced from information in the IOA Log file.
Other reports are produced from the Active Jobs file, Jobs Statistics file, Job
Network file and from scheduling tables.
KSL scripts and the Reporting facility can be activated at any time, even if the
CONTROL-M monitor is not active.
CTMAPI
Many of the functions performed using KSL can now be performed more easily and
efficiently using the CTMAPI feature. Full details of CTMAPI are provided in
Appendix A, The CONTROL-M Application Program Interface (CTMAPI). BMC
Software recommends that you use CTMAPI in preference to KSL whenever possible.
KeyStroke Language
The most common use of KSL scripts is to generate reports from the IOA Core and
INCONTROL product repositories. Utilities are also frequently written in KSL
scripts.
KeyStroke Language
Chapter 8 KeyStroke Language (KSL) 857
Once you are familiar with KSL, you can write your own scripts to create reports and
utilities. A KSL script only needs to be defined once, after which it can be used
repeatedly.
The CONTROL-M Active Environment screen (screen 3) supports mixed case
(uppercase and lowercase) characters. KSL also supports mixed case characters for
this screen, and product-supplied scripts have been updated accordingly.
If you are using a modified script, or a script that does not support mixed-case
characters, BMC Software recommends that you change your KSL scripts to be mixed
case compatible. As an alternative, you may change the format of the screen to
uppercase only in the $$ACT member in the IOA MSG library, but changing the
screen might affect the performance of other KSLs.
The IOA KSL and IOA SAMPLE libraries contain BMC Software-supported and
customer-contributed examples of KSL scripts.
NOTE
The performance or the accuracy of the output produced by a KSL script may be
affected if you have customized the IOA screens in certain ways.
For example, if you change the OWNER field in the Job Scheduling Definition screen
(Screen 2), to a protected field (from its default status as an unprotected field), KSL
REPCTRDF will no longer operate correctly.
NOTE
If the script is to execute successfully, the user submitting a KSL script must be
authorized to perform the Online functions performed by the script.
KeyStroke Language
858 CONTROL-M for OS/390 and z/OS User Guide
Activating KeyStroke Language Scripts
Procedure IOARKSL activates KeyStroke Language scripts:
Important DD statements are:
KSL can also be activated as a started task, by specifying the script name and script
parameters in the procedure. For example:
Procedure IOARKSL program can terminate with the following return codes:
/ / KSL EXEC I OARKSL
/ / DAKSLPRM DD *
par amet er s
/ /
Table 254 Keystroke Language Important DD Statements
Statement Description
/ / DAKSLPRM DD The script input parameters. Record length must be 80.
Columns 73 through 80 are ignored.
/ / DAKSLOUT DD A listing of all invoked command members and error and
execution messages. When TRACE ON is activated, it
contains a listing of all executed commands and screen
images of all input and output screen functions performed
during script execution.
/ / DAKSLREP DD Script output.
/ / DACALL DD Name of the library containing KSL script members (for the
CALLMEM command). Multiple libraries can be
concatenated.
S I OARKSL, PARM=' scr i pt name scr i pt - par amet er s'
Table 255 Return Codes for Procedure IOARKSL
Code Description
0 Ended OK
8 Error in input parameters
12 Severe execution error
other Generated by the script
KeyStroke Language
Chapter 8 KeyStroke Language (KSL) 859
KSL Command and Variable Summary
A brief summary of each command is listed below. The commands are grouped into
categories. Within each category, the commands are listed alphabetically.
Table 256 KSL Screen Commands
Command Description
CLEAR Presses Clear keyboard key.
CURSOR Moves the cursor.
ENTER Presses Enter keyboard key.
FIND Searches for text on screen.
Paxx Presses Program Attention keys.
Pfxx Presses Program Function keys.
SCREENSIZE Sets size of screen.
TYPE Operates the keyboard by typing text.
Table 257 KSL Flow Commands
Command Description
CALL Calls an external program.
CALLMEM Calls an external script.
END Terminates the script normally.
EXEC Executes an external program.
GOTO Branches to a labeled script command.
IFSCREEN Checks status of screen and reacts accordingly.
IFVAR Compares two values and reacts accordingly.
LABEL Identifies a statement to which script execution must branch.
MAXCOMMAND Limits the number of times a statement can be executed.
PAUSE Pauses script for a specified number of hundredths of seconds.
RETURN Returns to the calling script.
Table 258 KSL Print Commands
Command Description
BOTTOMLINE Specifies text for a footer.
BOTTOMSIZE Sets the size of bottom margin area.
HEADERLINE Specifies text for a header.
HEADERSIZE Sets the size of top margin area.
PAGESIZE Sets page size.
KeyStroke Language
860 CONTROL-M for OS/390 and z/OS User Guide
PRINTLINE Prints the indicated line.
PRINTNEWPAGE Skips to a new page.
PRINTSCREEN Prints screen contents starting at the specified cursor position.
SETLINE Sets the contents of a line for printing.
TRACE Activates the Trace (debug) facility.
Table 259 KSL Processing Commands
Command Description
ALLOC Dynamically allocates (and assigns an identifying name to) a
data set.
CLOSEFILE Closes the specified data set.
FREE Dynamically frees (and releases an identifying name from) a
data set.
GETFILE Stores the contents of the sequential data set record into a
variable.
OPENFILE Opens a data set for either read, write or update access.
PUTFILE Saves contents of a variable in the specified data set.
SETOGLB Creates a Global AutoEdit variable or changes its value.
SETOLOC Creates a local AutoEdit variable or changes its value.
SETVAR Creates a variable or changes a variables value.
SHOUT Sends a message to a specified destination.
Table 260 KSL Special Variables
Variable Description
%variable User-defined KSL variable set by a KSL command (such as
SETVAR).
%A1-%A9 Arguments to pass to a script.
%CALLRC Return code of the last CALL.
%FINDRC Return code of the last FIND.
%MSG Text of script termination that is logged.
%RC Return code of the script.
%SCRCOL Current column position of the cursor.
%SCRLINE Current line position of the cursor.
Table 258 KSL Print Commands (continued)
Command Description
KeyStroke Language
Chapter 8 KeyStroke Language (KSL) 861
AutoEdit Variables and Functions
AutoEdit variables and functions start with %%$ and are set using a SETOLOC
statement. These variables and functions are described in detail in Appendix E,
AutoEdit Facility in KSL..
Principles of Operation
KSL is composed of screen control commands and editing commands. Screen control
commands correspond to operations of the terminal keys. Editing commands are
required to edit the printed page.
At the beginning of a script, the user is positioned in the on-line field of the IOA
Primary Option menu. If the IOA entry panel is mandatory at your site, you are
positioned at the entry panel and you should include commands that enter your user
ID and password first.
The following is an example of a KSL script that prints the contents of a specific job
scheduling definition is illustrated below:
1. TYPE ' 2'
2. ENTER
3. TYPE ' DPTT. CTM. SCHEDULE'
4. CURSOR NEWLI NE
5. TYPE ' APD'
6. CURSOR NEWLI NE
7. TYPE ' APDP0020'
8. ENTER
9. PRI NTSCREEN 3 23
10. END
This script produces a printout of the first screen of the job scheduling definition. The
following explains each step of the above example.
WARNING
The KSL facility uses a different AutoEdit processor from that used by CONTROL-M.
As a result, the AutoEdit variables and functions described in Chapter 5, JCL and
AutoEdit Facility may not be identical with those described in Appendix E,
AutoEdit Facility in KSL. Therefore, when coding AutoEdit variables in KSL, refer
only to Appendix E.
KeyStroke Language
862 CONTROL-M for OS/390 and z/OS User Guide
A KSL script is a representation of your keystrokes while you are working with the
Online facility. Everything that you can display on the screen, you can print. Every
selection criterion that can be applied online can be applied in batch mode. The same
language is used to work on the screen and on the output of the KSL script.
An important advantage of using KSL is that once a script is created, it can be stored
in a member in a library. This enables requests to be submitted in batch mode as often
as required (daily, weekly, monthly, and so on), and during off-peak hours not
convenient for online requests.
The following example expands the previous script into a more general purpose
script.
1. TYPE ' 2'
2. ENTER
3. TYPE ' DPTT. CTM. SCHEDULE'
4. CURSOR NEWLI NE
5. TYPE ' APD'
6. CURSOR NEWLI NE
7. TYPE ' APDP0020'
8. ENTER
9. LABEL PRTSCR
Define a label to which we can later branch from another command (GOTO).
Table 261 Step-by-Step Explanation of Script Example
Step Command Description
1. TYPE ' 2' Equivalent to typing option 2 in the IOA
Primary Option menu.
2. ENTER Equivalent to pressing Enter on your
terminal. As a result, you are entering
the Online Scheduling Facility entry
panel.
3. TYPE ' DPTT. CTM. SCHEDULE On entry to the screen, the cursor is
always positioned on the library name
field. Type the scheduling library name.
4. CURSOR NEWLI NE The cursor moves to the table name field.
5. TYPE ' APD' Type the scheduling table name.
6. CURSOR NEWLI NE The cursor moves to the job name field.
7. TYPE ' APDP0020' Type the job name.
8. ENTER The job scheduling definition for the
specified job is displayed in the Job
Scheduling Definition screen.
9. PRI NTSCREEN 3 23 The contents of the screen from line 3
through 23 are printed.
10. END End of report.
KeyStroke Language
Chapter 8 KeyStroke Language (KSL) 863
10. PRI NTSCREEN 3 23
11. CURSOR POS 23 2
Position the cursor on the last line of the jobs data on the screen.
12. I FSCREEN ' ' GOTO ENDREPORT
13. I FSCREEN ' ======= >' GOTO ENDREPORT
If the last line of data on the screen is either blank or the end-of-data message, do
not print any more job data.
14. CURSOR HOME
Position the cursor on the Command field in the screen.
15. PF08
Scroll down one more page.
16. GOTO PRTSCR
Go to label PRTSCR and print the screen (loop again).
17. LABEL ENDREPORT
18. END
This script is easy to define, but filling in a different library, table name or job name
each time you want to print a job scheduling definition is awkward.
It would be much easier if you could supply the library name, table name and job
name at the time the script is executed.
In fact, you can do just that. Scripts can be defined with special variables (for
example, %A1, %A2, described later in this chapter) instead of hard-coded values.
When activating the script, the values for the special variables can be passed as
parameters.
In the following example, special variable %A3 represents the job name, %A2
represents the table name, and %A1 represents the library name. Other features, such
as a header for the report produced by this script, are also presented.
1. HEADERSI ZE 5
2. BOTTOMSI ZE 1
3. HEADERLI NE 3 1 ' SCHEDULE DEFI NI TI ON OF JOB'
4. HEADERLI NE 3 28 ' %A3'
5. HEADERLI NE 3 38 ' TABLE'
6. HEADERLI NE 3 48 ' %A2'
7. HEADERLI NE 3 58 ' LI BRARY'
8. HEADERLI NE 3 68 ' %A1'
9. HEADERLI NE 4 1 ' - - - - - - - - - - - - - - - - - - - - - - - - - '
10. HEADERLI NE 5
11. TYPE ' 2'
12. ENTER
13. TYPE ' %A1'
14. CURSOR BTAB
15. CURSOR NEWLI NE
16. TYPE ' %A2'
17. CURSOR BTAB
18. CURSOR NEWLI NE
KeyStroke Language
864 CONTROL-M for OS/390 and z/OS User Guide
19. TYPE ' %A3'
20. ENTER
21. LABEL PRTSCR
22. PRI NTSCREEN 3 23
23. CURSOR POS 23 2
24. I FSCREEN ' ' GOTO ENDREPORT
25. I FSCREEN ' ======= >' GOTO ENDREPORT
26. CURSOR HOME
27. PF08
28. GOTO PRTSCR
29. LABEL ENDREPORT
30. PF03
31. PF03
32. PF03
33. RETURN
Assume that the above script is kept in the REPJOB member. You can produce a
printout of two jobs from a scheduling library by the following request:
Language Syntax
s A command line is processed from column 1 to 72. A command cannot exceed
column 72. Columns 73 to 80 are ignored.
s A command line can contain all blanks.
s A command line with * in column 1 is considered a remark.
s Each line in a script can optionally have one continuation line. To add a
continuation line, place an asterisk (*) in column 72 of the initial line.
s A KSL variable must start with the character % and can be 2 through 40 characters
long. A blank designates the end of the variable name.
s KSL variables are only accessible by the KSL script in which they are defined. Any
reference to the same variable in another command member (or in another
invocation of the same command member) is totally independent and has no effect
on the current member environment.
s The value of an AutoEdit variable applies in all command members invoked by a
KSL script.
/ / KSL EXEC I OARKSL
CALLMEM REPJOB DPTT. CTM. SCHEDULE APD APDP0020
CALLMEM REPJOB DPTT. CTM. SCHEDULE APD APDP0035
END
KeyStroke Language
Chapter 8 KeyStroke Language (KSL) 865
s To share information between a KSL script and other command members invoked
in the same KSL run, either store the information in local AutoEdit variables, or
specify the relevant information using the CALL, CALLMEM, or EXEC command.
s Values for the variables %A1 through %A9 (arguments) cannot be set by the
SETVAR command. They can only be specified as parameters of a CALLMEM
command.
s Special variables %RC and %MSG are also valid during the same invocation of a
command member. Therefore, if you use the SETVAR command to assign a value
to the variable %RC and then execute RETURN, the value of the variable is lost.
s Special AutoEdit variables and functions must start with characters %%. They are
set using command SETOLOC and are resolved according to the same rules that
apply to the IOA AutoEdit facility.
s When an expression contains both KSL and special AutoEdit variables and
functions, the KSL variables are resolved first.
s A label is valid through the same invocation of a command member. Any reference
to the same label in another command member (or in another invocation of the
same command member) is totally independent and has no effect on the current
member environment.
s BMC Software recommends that you activate the TRACE ON command when
performing an update function with the KeyStroke Language. It is, of course, more
convenient to write new reports with the TRACE ON.
s The IOA SAMPLE library contains general purpose command members that can
be used to solve typical report functions (for example, scroll and print).
s KSL scripts may not work in a customized environment. For this reason, it is
highly recommended that you run KSL using backup libraries that specify the
default values for the IOA environment.
NOTE
KSL and CONTROL-M have different AutoEdit processors. Therefore, if a KSL script
containing KSL AutoEdit terms is submitted under CONTROL-M, the CONTROL-M
AutoEdit %%RANGE statement must be used in the JCL to ensure that the
CONTROL-M AutoEdit processor skips (that is, it does not process) the KSL script.
KSL Commands and Variables
866 CONTROL-M for OS/390 and z/OS User Guide
KSL Commands and Variables
The KSL commands are described below.
Braces ({ }) indicate that one of the items listed between the braces must be specified.
Square brackets ([ ]) denote optional additions; none or several of the items listed
between the brackets can be specified.
Certain commands accept KSL and/ or AutoEdit variables. When both KSL and
AutoEdit variables are specified, KSL variables are resolved (replaced) first.
KSL Commands
Table 262 KSL Screen Commands (Part 1 of 2)
Command Description
CLEAR Equivalent to pressing the Clear key on the keyboard.
CURSOR Depending on the parameters listed below, CURSOR
moves the cursor to the
s BTAB Beginning of the previous unprotected input
field on the screen.
s HOME First unprotected input field on the screen.
s NEWLINE First unprotected input field that
appears on the line following the current cursor
position line.
s POS line-no col-no Specific position on the screen.
line- no and col-no can contain constants, or any valid
expression consisting of KSL variables and/ or
AutoEdit variables.
s TAB Beginning of the next unprotected input field
on the screen.
ENTER Equivalent to pressing the Enter key on the keyboard.
FIND{textstring
| expression}
Searches for text on the screen from the current position of
the cursor. If the text is found, the cursor is positioned at
the beginning of the text. For more information, see special
variable %FINDRC, described in Table 266 on page 877.
s textstring A character string constant. When
specifying constants, quotes are not necessary unless
spaces are embedded in textstring. To specify a quote
inside the text, use two consecutive single quotes.
s expression Any expression consisting of constants,
KSL variables, and/ or AutoEdit variables.
KSL Commands and Variables
Chapter 8 KeyStroke Language (KSL) 867
PA01-PA03 Equivalent to pressing program attention keys on the
keyboard.
PF01-PF24 Equivalent to pressing program function keys on the
keyboard.
SCREENSIZE line-no col-no Defines the logical terminal size.
Valid terminal sizes are:
s 24 lines x 80 columns (Default)
s 32 lines x 80 columns
s 43 lines x 80 columns
s 27 lines x 132 columns
TYPE{textstring | expression} Operates the keyboard by typing the text on the screen
from the current position of the cursor. If the text is too
long for the current data field, an error message is
produced and the script stops executing.
s textstring A character string constant. When
specifying a constant, the text must be enclosed in
single quotes (). To specify a quote inside the text, use
two consecutive single quotes.
s expression Any valid expression consisting of KSL
variables and/ or AutoEdit variables. The expression
must be enclosed in single quotes ().
Table 263 KSL Flow Commands (Part 1 of 4)
Command Description
CALL progname [argument1 argument2
... argumentn]
Calls an external program (progname). The arguments are
optional. A maximum of nine arguments can be passed.
Use command CALL when the called program expects to
receive a list of parameters. The parameters are passed in a
format compatible with ASSEMBLER, COBOL and
FORTRAN.
s progname Name of the called program. progname can
consist of a constant, or may contain any valid KSL
and/ or AutoEdit expression.
s argumentx Any text (not containing blanks),
constant, KSL variable, or AutoEdit variable to be sent
to the called program. (The variable data can contain
blanks.)
Note: The return code of the called program is stored in
special variable %CALLRC, which is described in Table 266
on page 877.
Table 262 KSL Screen Commands (Part 2 of 2)
Command Description
KSL Commands and Variables
868 CONTROL-M for OS/390 and z/OS User Guide
CALLMEM memname [argument1
argument2 ... argumentn]
Calls a predefined KSL script that is located in the member
memname in the library allocated to the DACALL
DD statement. The arguments are optional. A maximum of
nine arguments can be passed.
Note: The return code of the called program is stored in
special variable %CALLRC, which is described in Table 266
on page 877.
END Indicates the end of the KSL script. This is a mandatory
command in the main script commands list. When
activated at any level, the script is terminated.
EXEC progname [argument1 argument2
... argumentn]
Calls an external program (progname). The arguments are
optional. A maximum of nine arguments can be passed.
Use command EXEC when the called program expects to
receive an argument in a format similar to JCLs EXEC
PGM argument format. (All arguments are merged into a
single argument.)
s progname Name of the called program. progname can
consist of a constant, or can contain any valid KSL
and/ or AutoEdit expression.
s arguments Text to be passed to the called program.
An argument can consist of any text (not containing
blanks), a constant, or a KSL and/ or AutoEdit variable.
(The variable data can contain blanks.)
(described later in this chapter).
Note: The return code of the called program is stored in
variable %CALLRC, which is described in Table 266 on
page 877.
GOTO label_name Branches to the specified label name, which must be in the
same command memberS.
If all parts of the conditional expression evaluate to true,
script flow branches to the specified label name, which
must be in the same command member. A parameter
cannot be specified more than once within the same
conditional expression.
Each part of the conditional expression is true if the:
s textstring Text on the screen at the current cursor
position is equal to the specified text. The text must be
enclosed in single quotes (). To specify a quote inside
the text, use two consecutive single quotes.
s expression Text on the screen at the current cursor
position is equal to the specified expression. expression
can be any expression consisting of KSL variables
and/ or AutoEdit variables. expression must be
enclosed in single quotes.
Table 263 KSL Flow Commands (Part 2 of 4)
Command Description
IFSCREEN
' textstring'
' expression'
COLOR col
ATTR attr
HILITE hilite
BEEP
GOTO label

KSL Commands and Variables

Chapter 8 KeyStroke Language (KSL) 869
COLOR col Color of the screen at the current cursor position is equal to
the specified color (col). Valid col values are:
s WHITE
s GREEN
s RED
s BLUE
s PINK
s YELLOW
s TURQUOISE
s NOCOLOR
ATTR attr Screen attribute at the current cursor position is equal to
the specified attribute (attr). Valid attr values are:
s U Unprotected
s P Protected
s L Low
s H High
s D Dark
s N Numeric
s S Skipped
s UL Unprotected and low
s UH Unprotected and high
s UD Unprotected and dark
s NL Numeric and low
s NH Numeric and high
s ND Numeric and dark
s PL Protected and low
s PH Protected and high
s PD Protected and dark
s SPL Skipped, protected and low
s SPH Skipped, protected and high
s SPD Skipped, protected and dark
HILITE hilite Highlight of the screen at the current cursor position is
equal to the hilite value specified. Valid hilite values are:
s REVERSE Reverse video
s USCORE Underline
s BLINK Blink
s NONE No highlight
BEEP Terminal beep
Table 263 KSL Flow Commands (Part 3 of 4)
Command Description
KSL Commands and Variables
870 CONTROL-M for OS/390 and z/OS User Guide
I FVAR oper and oper at or
oper and GOTO l abname
Where:
s operand is a KSL variable or constant and/ or AutoEdit
variable. Constants must be enclosed in single quotes.
s operator is one of the following operators. Used to
compare the specified operands.
EQ is equal to
NE is not equal to
GT is greater than
GE is greater than or equal to
LT is less than
LE is less than or equal to
s labnameLabel name to which script branches.
Specified using command LABEL (described below).
Note: Operands are compared as character strings from
left to right. For example, 91 is greater than 1000, because 9
is greater than 1.
IFVAR is used together with command GOTO to permit
branching based on different runtime conditions. If the
condition is true, flow branches to the specified label name
(must be in the same command member).
LABEL name Defines a label to which script flow can branch.
MAXCOMMAND number number is the maximum number of commands that can be
executed in the script. Default: 400. This is designed to
prevent an accidental loop.
PAUSE n Where n= hundredths of seconds. Causes the script to
wait the specified amount of time.
RETURN [ r et ur n- code] Returns to the calling script.
return-code must be a number from 0 through 4095. When
command RETURN is activated, control is passed to the
command after the CALLMEM command in the calling
member. The variable %CALLRC in the calling member is
set to the value of the return code. Default: 0.
Table 263 KSL Flow Commands (Part 4 of 4)
Command Description
KSL Commands and Variables
Chapter 8 KeyStroke Language (KSL) 871
Table 264 KSL Print Commands (Part 1 of 2)
Command Description
BOTTOMLINE line-no pos-in-line
{textstring| varname}
Assigns contents to a line in the page footer. The footer
contents are valid throughout the script until overridden
by another BOTTOMLINE command for the same line in
overlapping positions. Command BOTTOMSIZE overrides
the current BOTTOMLINE specifications.
s line-no is the relative number of the line in the footer.
s pos-in-line is the relative position in the line in the
footer.
s textstring must be enclosed in single quotes (). To
specify a quote inside the text, use two consecutive
single quotes.
s varname is a valid KSL variable.
BOTTOMSIZE line-no Specifies the number of lines in the report bottom (footer)
(1 minimum 15 maximum). The bottom size is valid
throughout the script until a new BOTTOMSIZE command
is activated.
HEADERLINE line-no pos-in-line
{textstring| varname}
Assigns contents to a line in the page header. The header
contents are valid throughout the script until overridden
by another HEADERLINE command for the same line in
overlapping positions. Command HEADERSIZE overrides
the current HEADERLINE specifications.
s line-no is the relative number of the line in the header.
s pos-in-line is the relative position in the line in the
header.
s textstring must be enclosed in single quotes (). To
specify a quote inside text, use two consecutive single
quotes.
s varname is a valid KSL variable.
HEADERSIZE line-no Specifies the number of lines in the report header (1
minimum 15 maximum). The header size is valid
throughout the script until a new HEADERSIZE command
is activated.
PAGESIZE line-no col-no Defines the maximum size of a printed page.
s line-no is the number of lines in the page. Default: 60.
s col-no is the column number. In the current version, the
column number must be 132.
PRINTLINE line-no Prints the contents of the line identified by line-no (a
number from 1 through 9999).
PRINTNEWPAGE Skips to a new page.
Each occurrence of command PRINTNEWPAGE in a KSL
script must be preceded by commands SCREENSIZE,
PAGESIZE, HEADERSIZE and BOTTOMSIZE.
KSL Commands and Variables
872 CONTROL-M for OS/390 and z/OS User Guide
PRINTSCREEN from-line until-line Prints the screen contents of the specified line range.
s from-line The first line of screen contents to be
printed.
s until-line The last line of screen contents to be
printed.
SETLINE identifier pos-in-line font
{textstring| varname}
Assigns contents to a line that is about to be printed.
s identifier is the number (from 1 through 9999) that
identifies a line.
s pos-in-line is the number that identifies a position in the
line.
s textstring must be enclosed in single quotes (). To
specify a quote inside the text, use two consecutive
single quotes.
s varname is a valid KSL variable.
TRACE {ON| OFF} Simplifies problem resolution using the TRACE (debug)
facility while defining a script.
s ON Produces a complete printed output of every
command execution, screen I/ O, and command
member invocation. It is highly recommended that KSL
utilities that are performing updates of any database
operate with TRACE ON to simplify problem
resolution. Command TRACE can be activated any
number of times within a script to turn on/ off the
TRACE facility.
s OFF Does not produce a printed output. Default.
Table 264 KSL Print Commands (Part 2 of 2)
Command Description
KSL Commands and Variables
Chapter 8 KeyStroke Language (KSL) 873
Table 265 KSL Processing Commands (Part 1 of 4)
Command Description
ALLOC DD ddname DS dsname[MEM
memname][{SHR| OLD| MOD}]
Dynamically allocates the data set dsname to the specified
DD name.
s memname Member name for PDS members.
Mandatory for PDS members. Must be left blank for
non-PDS members. memname can be any valid member
name consisting of a constant, KSL variable, or
AutoEdit variable.
s ddname Any DD name consisting of a constant, KSL
variable, or AutoEdit variable.
s dsname Any data set name consisting of a constant or
KSL variable.
s SHR, OLD, MOD Specify the data set disposition.
Optional. Default is SHR.
Before a data set can be accessed (for example, with
OPENFILE, GETFILE), it must be allocated and assigned a
DD name. Similarly, when the data set no longer needs to
be accessed, the data set and DD name must be released
(for more information, see command FREE in this table).
This DD name is local to the script that creates it.
CLOSEFILE ddname Closes sequential data set ddname.
ddname is any DD name consisting of a constant, KSL
variable, or AutoEdit variable.
FREE DD ddname Dynamically frees the data set allocated to the specified
DD name. (The DD name is assigned by command
ALLOC.) Activate this command when a data set no
longer needs to be accessed by the script.
GETFILE ddname INTO varname Stores in the specified variable the contents of the next
record in the sequential file referenced by ddname, where
s ddname is any DD name consisting of a constant, KSL
variable, or AutoEdit variable.
s varname is a KSL variable name where contents are
stored.
Opens sequential data set ddname for access.
s ddname is any DD name consisting of a constant, KSL
variable, or AutoEdit variable.
s INPUT opens the sequential data set as a read-only file.
No changes can be made to the file.
s OUTPUT allows data to be written to the file (write
access).
s UPDATE allows the file to be read and modified (read
and write access). Default.
s ENDFILE label specifies a label name to which script
processing flow branches when the end of sequential
data set ddname is reached. ENDFILE is mandatory
when ddname is opened for INPUT or UPDATE access.
[ ]
OPENFILE ddname
INPUT
OUTPUT
UPDATE
ENDFILE label

KSL Commands and Variables

874 CONTROL-M for OS/390 and z/OS User Guide
PUTFILE ddname FROM varname Writes the contents of variable varname in the next record
of the sequential file referenced by ddname.
s ddname is any DD name consisting of a constant, KSL
variable, and/ or AutoEdit variables.
s varname specifies a KSL variable whose contents are
written.
Note: AutoEdit variables (that is, variables beginning %%)
cannot be used with a PUTFILE command. Instead, such a
variable must be passed to a KSL variable (that is, a
variable beginning with a single %). The KSL variable
must be specified in the PUTFILE command.
Assigns the appropriate value to the variable name. This
command is used to create (set) a global AutoEdit variable.
expression may contain a KSL variable.
Note: This command is only available if CONTROL-O is
installed at your site. Global AutoEdit variables can only
be used when the CONTROL-O monitor is online. For
further information, see the DO SET statement in the
CONTROL-O User Guide.
Assigns the value of the expression to the variable name.
This command is used to create (set) a Local AutoEdit
variable. expression may contain a KSL variable.
SETVAR varname CURSOR length Assigns extracted text to variable varname. This command
is used to create (set) variables.
s varname is the name of the KSL variable in which the
text is stored.
s length is the length (in characters) of the extracted text.
The text at the current cursor position of the specified
length is extracted and assigned to the variable name.
SETVAR varname
DATA{textstring| expression}
Assigns a text string to variable varname. This command is
used to create (set) variables.
s varname is the name of the KSL variable in which the
text is stored.
s textstring is the textstring assigned to the variable
name. textstring is a character string constant. When
specifying a constant, the text must be enclosed in
single quotes (). To specify a quote in the text, type
two consecutive single quotes.
s expression is any valid expression containing KSL
variables and/ or AutoEdit symbols. expression must be
enclosed in single quotes if it contains embedded
blanks.
Table 265 KSL Processing Commands (Part 2 of 4)
Command Description
SETOGLB
%%var = value
%%var = expression
%%autoedit - control - statement

SETOLOC
%%var = value
%%var = expression
%%autoedit - control - statement

KSL Commands and Variables

Chapter 8 KeyStroke Language (KSL) 875
SETVAR varname SCREEN from-line
from-col length
Assigns extracted text to variable varname. This command
is used to create (set) variables.
s varname is the name of KSL variable in which the text is
stored.
Variable value is determined by the screen contents at a
specific screen position. The screen position is specified by:
s from-line Starting from this line position, screen
contents are extracted.
s from-col Starting from this column position, screen
contents are extracted.
s length The number of characters) in the extracted text.
SHOUT TO destination [URGENCY
urgency] TEXT {textstring| expression}
Sends (shouts) textstring to the specified destination.
s destination Specifies a 1 through 16 character
destination. Valid destination values are:
U-userid or USERID userid writes the message to
the IOA Log file under the specified user ID. userid
must be 1 through 8 characters.
OPER[-n] Sends a rollable message to the operator
console. n is an optional 2-digit route code. If a route
code is not specified, the default routes are Master
Console and Programmer Information (1 and 11).
Route codes are listed in Appendix D.
OPER2[-n] Sends an unrollable, highlighted
message to the operator console. n is an optional
2-digit route code. If a route code is not specified,
the default routes are Master Console and
Programmer Information (1 and 11). Route codes are
listed in Appendix D.
Table 265 KSL Processing Commands (Part 3 of 4)
Command Description
KSL Commands and Variables
876 CONTROL-M for OS/390 and z/OS User Guide
KSL Variables
KSL variables can be used to add flexibility to a KSL script. These variables are
assigned using a KSL command (such as SETVAR) and are resolved during the run of
the KSL script.
A KSL variable must start with % and can be 2 through 40 characters long. A blank
designates the end of the variable name.
s
Sends the message to a TSO user. logonid must be 1
through 7 characters, and can contain valid KSL and/ or
AutoEdit variables.
An optional second value, indicating the computer and/ or
node (such as Nn) of the TSO logonid, can be specified, as
follows.
When the ; option is used :
Under JES2:
Valid values are: Mm, Nn or NnMm, where:
m is the machine ID. (This is the ID of the computer
in JES2, not the 4-character SMF ID. You can use the
$LSYS JES command to determine the JES ID.)
n is the JES/ NJE node ID (up to two characters).
Under JES3:
Lname where Lname is the logical JES name of the
machine (as used in the JES3 command *T, not the
MVS/ SMF system ID).
s textstring Indicates the text that must be sent.
textstring is a constant character string. Quotes appear
in textstring exactly as they are typed in the KSL script.
s expression Expression containing KSL and/ or
AutoEdit variables can be specified. Quotes appear in
text exactly as they are typed in the KSL script.
s urgency Indicates situation urgency. Optional. Valid
values are:
R Regular, normal. Default.
U Urgent
V Very urgent
Table 265 KSL Processing Commands (Part 4 of 4)
Command Description
(
(
(

Lname ;
NnMm ;
Mm ;
logonid - TSO
KSL Commands and Variables
Chapter 8 KeyStroke Language (KSL) 877
KSL variables are only accessible by the KSL script in which they are defined. A
reference to the same variable in another command member (or in another invocation
of the same command member) is totally independent and has no effect on the
current member environment.
When an expression contains both KSL and special AutoEdit variables and functions,
KSL variables are resolved first.
For more information about syntax and KSL variables, see Language Syntax on
page 864.
Special KSL Variables
Some KSL variables are reserved by, and have a special meaning for, KSL:
NOTE
The second character in a KSL variable name must not be a percent sign. KSL assumes
that a variable beginning with %% is an AutoEdit variable.
If a KSL script is to search for a prerequisite condition whose name begins with a
single percent sign (%), KSL assumes it is a KSL user-defined variable and does not
recognize the searched-for condition.
Table 266 Special KSL Variables (Part 1 of 2)
Variable Description
%A1-%A9 Passes the specified arguments to a called script. The number
corresponds to the position of the argument in command
CALLMEM. The argument is replaced throughout the called
script member at invocation time.
%CALLRC Contains the return code specified in the RETURN command
when returning from command CALLMEM. Also contains the
return code from programs called by the CALL or EXEC
commands.
%FINDRC Provides the return code of the result of the last FIND. If the
last FIND was successful, has a value of 0. If the last FIND was
unsuccessful, %FINDRC has a value of 4.
%MSG Specifies text assigned at script termination, which appears as
a message in the jobs SYSLOG and the script execution listing.
Only the value of variable %MSG at the script member issuing
command END is displayed.
%RC Supplies the return code of the script. The value at successful
script termination is the condition code of the step. Valid
values are: 0 through 4095.
Sample KeyStroke Reports and Utilities
878 CONTROL-M for OS/390 and z/OS User Guide
Sample KeyStroke Reports and Utilities
The IOA KSL and IOA SAMPLE libraries contain sample scripts for a variety of
reports and utilities.
The following report scripts in the IOA KSL library are supported. The jobs to run
them are found in the CTM.JCL or IOA.JCL libraries (as indicated in the third column
of Table 8-14 and Table 8-15).
Scripts for the following utilities are in the IOA KSL library:
%SCRCOL Current column position of the cursor.
%SCRLINE Current line position of the cursor.
NOTE
If you choose to modify an existing sample report or utility, it is recommended that
you save the changed report under a different name and keep the original report
unchanged. This precaution can help in error detection if the altered KSL script does
not run as expected.
Table 267 Report Scripts in the IOA KSL Library
Script Description JCL Library
REP3GRUP Status of all the jobs of specified groups. CTM
REP3LEFT All jobs still in the Active Job File that did
not run during the previous night (wait
schedule, ended NOT OK, executing) and
the reasons for the problems.
CTM
REP3STAT Statistical summary of what must be done
tonight, or job status in the morning.
CTM
REP3TAPE Status of all jobs using tapes. CTM
REP3WHY All jobs in the Active Jobs file having a
WAIT SCHEDULE status.
CTM
REP5ABND All abends in a given period. IOA
REP5ALL All IOA Log file messages of a specified
period.
IOA
REP5MSGD All IOA Log file messages of specified
message codes for a specific period.
IOA
Table 266 Special KSL Variables (Part 2 of 2)
Variable Description
Sample KeyStroke Reports and Utilities
Chapter 8 KeyStroke Language (KSL) 879
You can use the above examples to design scripts for your own reports utilities.
In addition to the scripts in the IOA KSL library, the IOA SAMPLE library contains
many useful scripts. However, the scripts in the IOA SAMPLE library have been
developed and supplied by users. They have been placed in the IOA SAMPLE library
as examples. They have not been tested and they are not supported.

Table 268 Utility Scripts in the IOA KSL Library
Script Description JCL Library
ADDMNCND Add manual conditions based on prefix. IOA
HOLDGRUP Hold a group of jobs. CTM
MAYBEJOB Add prerequisite conditions for maybe jobs. CTM
RERUNJOB Rerun a job. CTM
Sample KeyStroke Reports and Utilities
880 CONTROL-M for OS/390 and z/OS User Guide
Sample KSL Report Outputs
The following sample outputs are the result of running job REPJBDEF (in the
CONTROL-M JCL library), which invokes sample KSLREPSCHED (in the IOA KSL
library).
Output #1 from the sample KSL Script:
Figure 354 Output from KSL Library Sample KSLREPSCHED

Output #2 from the sample KSL Script:
KEYSTROKE REPORTI NG LANGUAGE ( REL PROD. ) DATE 06/ 06/ 01 TI ME 10. 08 PAGE 000001
LI ST OF JOBS TABLE: PRODYH LI B: CTM. PROD. SCHEDULE
=============================================================================
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PRODYI DK UPDATE # 1
PRODYHST UPDATE # 2
PRODYJCL CREATE I NPUT FI LES # 2
PRODYBTL REPORTS FOR BRANCHES
PRODYHTK PROCESS I NPUT DATA FOR PRODYHST
PRODYHC2 CREATE I NPUT FI LE # 2
PRODYBCK PROCESS I NPUT DATA FOR PRODYI DK
PRODYI ZN REPORTS FOR BRANCH MANAGERS
PRODYEND REPORTS FOR MAI N OFFI CE
PROJYFOT BEGI N OF EVENI NG PROCESS
PROJYMRG EVENI NG UPDATE PROCEDURE
PROJYMTI VERI FI CATI ON PROCESS OF EVENI NG UPDATE
PROJYHO1 SPECI AL CALCULATI ONS FOR ACCOUNTI NG DEPARTMENT
PROJYHO2 REPORTS FOR ACCOUTI NG DEPARTMENT
PROJYDPY UPDATE OF ON- LI NE FI LES
PROJYDTK REPORTS OF ON- LI NE FI LES
PROJYDLI CREATE DUAL ON- LI NE FI LE
PROYH11 YH APPLI CATI ON UPDATE
PROJYFI N CLEAN- UP FOR YH APPLI CATI ON
PROJYBNK VERI FI CATI ON OF BRANCH BALANCES
PROJEND FI NAL YH APPLI CATI ON PROCEDURE
PROLYPAR NI GHT I NPUT COLLECTI ON # 1
PROLYDOC BACKUP FI LES STATUS REPORTS
PROLYFMZ REPORTS FOR MAI N OFFI CE
PROLYDEL DELETE TEMPORARY " REPORT" FI LES
PROLYBME CREATE EXTERNAL TAPE
PROLYDM2 ARCHI VE YH APPLI CATI ON DATA SETS #2
PROLYDM1 ARCHI VE YH APPLI CATI ON DATA SETS #1
======= >>>>>>>>>>>>>>>>>>> NO MORE JOBS I N TABLE <<<<<<<<<<<<<<<< =======
BMC SOFTWARE, I NC. I OA KEY- STROKE REPORTI NG LANGUAGE ( REL PROD. ) DATE 06/ 06/ 01 TI ME 10. 12
PAGE 000001
SCHEDULE DEFI NI TI ON OF MEMBER PRODYBCK I N TABLE PRODYH LI BRARY CTM. PROD. SCHEDULE
======================================
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| MEMNAME PRODYBCK MEMLI B CTM. PROD. SCHEDULE |
| OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N |
| APPL APPL- L GROUP BKP- PROD- L |
| DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L |
| OVERLI B CTM. OVER. JOBLI B |
Sample KeyStroke Reports and Utilities
Chapter 8 KeyStroke Language (KSL) 881
| SET VAR |
| . CTB STEP AT NAME TYPE |
| DOCMEM BACKPL02 DOCLI B CTM. PROD. DOC |
| =========================================================================== |
| DAYS DCAL |
| AND/ OR |
| WDAYS WCAL |
| MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y |
| DATES |
| CONFCAL WORKDAYS SHI FT RETRO N MAXWAI T 04 D- CAT |
| MI NI MUM PDS |
| =========================================================================== |
| I N START- DAI LY- BACKUP ODAT |
| CONTROL |
| RESOURCE I NI T 0001 CART 0001 |
| PI PE |
| TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM |
| =========================================================================== |
| OUT BAKCKPL02- ENDED- OK ODAT + |
| AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS |
| RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP |
| SYSOUT OP ( C, D, F, N, R) FROM |
| MAXRERUN RERUNMEM I NTERVAL FROM |
| STEP RANGE FR ( PGM. PROC) . TO . |
| ON PGMST PROCST CODES A/ O |
| DO |
| SHOUT WHEN TO URGN |
| MS |
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====
Sample KeyStroke Reports and Utilities
882 CONTROL-M for OS/390 and z/OS User Guide
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 883
Appendi x
A
A The CONTROL-M Application
Program Interface (CTMAPI)
This appendix discusses the CONTROL-M Application Program Interface (CTMAPI),
including the following topics:
s Overview, on page A-884
s Environment and Allocations, on page A-885
s Functions, on page 886, including
1. Order or Force Existing Jobs, on page 887
2. Create, Order, or Force New Tables, on page 890
3. AJF Actions, on page 892
4. Search, on page 896
5. Global Variables, on page 899
s Conditional Requests and Selection Criteria, on page 900
s Return Codes, on page 902
s Conversational Mode using Program, on page 904
s Input and Output Registers, on page 904
s CTMBAPI DSECT, on page 905
s Status Extension, on page 909
s Order Extension, on page 914
s AJF Action Extension, on page 917
s Global Variable Extension, on page 920
s Quantitative Resource Extension, on page 921
s Create And/ Or Order or Force a Table (BLT), on page 922
s Replies, on page 924
s CTMBAPO, on page 924
Overview
884 CONTROL-M for OS/390 and z/OS User Guide
Overview
The CONTROL-M Application Program Interface (CTMAPI) is an open interface
between the application environment and CONTROL-M. CTMAPI enables your
application program to interface with CONTROL-M so that you can access services
and extract data from CONTROL-M into your own programs.
CTMAPI is open to all application environments. It can be called from the following
programs or environments:
s High Level Language or Assembler programs, running under various
environments, such as CICS, IMS, or the like
s a batch job or step
s REXX or CLIST
However, not all functions of the API are applicable to all environments.
The API can call the CTMAPI module and pass it requests through either of the
following:
s a function (command line) passed to CTMAPI, as
a parameter from within a program
a parameter using PARM=variable in a JCL Batch step
an explicit command coded in a dedicated sequential file pointed to by the
DAAPI special DD statement
s conversational mode (CTMBAPI mode), using an area mapped by CTMBAPI
DSECT. It passes the request from an application program to CTMAPI, and the
results are returned to the calling program
These methods, functions and conversational mode, are explained in more detail in
this appendix.
NOTE
All examples in this Appendix are in Assembler language.
Environment and Allocations
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 885
Environment and Allocations
CTMAPI is a callable Load module that resides in the IOA LOAD library. It is located
below the line (RMODE=24), works in 31 bit addressing mode (AMODE=31), and can
be called by programs running in any AMODE.
The following requirements must be satisfied before CTMAPI can be called:
s The calling application must have access to the IOA LOAD library, either using
STEPLIB or using Linklist.
s The standard IOA DD statement DAPARM must be allocated to the calling
address space before calling CTMAPI, and must correctly point to the IOA PARM
and IOA IOAENV libraries. This allocation is essential for the correct loading of
CTMPARM, IOAPARM and other required parameter members, and to provide
the ability to issue messages, dynamically allocate files, and so on.
In addition to the above allocations, each service requires specific data sets to be
allocated for successful execution of the service. For example, to successfully order
jobs to CONTROL-M, the Active Jobs file (AJF) must be allocated.
CTMAPI relies on IOA dynamic allocation services to allocate the files appropriate to
the function, using an ALC member. This means that your program, REXX or batch
requires no knowledge of dynamic allocation.
For more information about IOA dynamic allocation and ALC members, see the
INCONTROL for OS/390 and z/OS Administrator Guide.
You can tailor CTMAPI to allocate the appropriate files in either of the following
ways:
s Let the function itself dynamically allocate the default data sets based on the site
standard naming convention (using the default ALC member). Under each
function, you can find which ALC member is used to dynamically allocate the
necessary files. If you do not require any unusual allocations, this is the
recommended method.
s If you want to use other allocations, you can prepare your own ALC member and
pass it to CTMAPI using the standard DAALOCIN DD statement pointing to your
own ALC member. If this method is chosen, it is recommended that you use the
default ALC member specified in the function as a basis for your own ALC
member.
If the caller is not allocated to DAALOCIN DD at the time CTMAPI is called, it is
assumed that the default allocations are to be performed. In this case, CTMAPI will
dynamically allocate files using the default ALC member.
Functions
886 CONTROL-M for OS/390 and z/OS User Guide
If CTMAPI is called under the IOA environment, none of the above is applicable. It is
assumed that all the necessary files are already correctly allocated, so no dynamic
allocation is performed by CTMAPI.
Functions
CTMAPI supports various types of services, but not all of them are supported under
all environments. Some of the functions can be executed using existing IOA or
CONTROL-M utilities. For example, CTMJOB can be used to order jobs. Other
functions, such as the Status request or the Action request, cannot be processed by
means of any existing program or utility.
Future enhancements will be provided first to the API rather than to the appropriate
utility. BMC Software therefore recommends that you use CTMAPI for all requests,
even functions that are supported using other utilities.
The following CTMAPI functions are available:
s order or force existing jobs into CONTROL-M
This function can currently also be performed using CTMJOB.
s create and/ or order or force a new table into CONTROL-M
This function can currently also be performed using CTMBLT.
s perform AJF actions equivalent to the following options of the Active Environment
screen (Screen 3):
Hold
Free
Delete
Undelete
Confirm
Rerun
Restart
React
Force OK
s search and query the status and other details of jobs in CONTROL-M
s resolve, set, and checkpoint variables in the IOA Variables Database
The above-listed functions are described in greater detail in this appendix.
Differences in calling the service from different environments are also discussed.
1. Order or Force Existing Jobs
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 887
IOAAPI, which is described in the INCONTROL for OS/390 and z/OS Administrator
Guide, can be used to perform the following functions:
s CHECK, ADD, or DELETE conditions
s send e-mail messages
s extract records from the IOA Log file
1. Order or Force Existing Jobs
The Order function can be used to order or force an existing scheduling table, or
selected jobs from an existing table, to CONTROL-M.
This service can be called from any environment, with few differences between
environments. The syntax for this service is as follows:
For a full description of each parameter, see the description of the CTMJOB utility in
the INCONTROL for OS/390 and z/OS Utilities Guide. The only change from the utility
is the syntax of the Ignore or Select Tags statement. In CTMJOB, it is coded separately
from the Order statements. Under CTMAPI, it should be coded as part of the Order
statement, substituting SELTAG for the keyword SELECT and IGNTAG for the
keyword IGNORE.
The if_statement part of the command is described under Conditional Requests and
Selection Criteria on page 900.
An appropriate message, JOB511I, is issued to the IOA LOG file for each job that is
ordered.
Order or Force under Batch, REXX or CLIST
When called from a batch job or step or from a REXX or CLIST, the Order statement is
specified as one of the following:
ORDER { DSN=schedl i b| DDNAME| DD=dd} , { MEMBER| MEM=t abl e}
[ JOB=j obnm] [ ODATE| DATE=dat e] [ ODATEOPT=VAL| RUN] [ FORCE]
[ I NTOGRP=gr p_r ba [ DUP| NODUP] ]
[ SELTAG=t ag] [ I GNTAG=t ag] [ I F i f _st at ement ]
NOTE
In this syntax, NODUP is the default in the expression
INTOGRP=grp_rba [DUP| NODUP].
1. Order or Force Existing Jobs
888 CONTROL-M for OS/390 and z/OS User Guide
s a statement in the format
s in a sequential file pointed to by the DAAPI DD statement
In this type of call, the SYSPRINT DD statement must be pre-allocated to the step,
and the output of CTMAPI written to this file.
A return code is returned in register R15. For a full list of valid return codes, see
Order or Force Return Codes on page 889.
Order or Force Using Program
When called from a program, the simplest method of requesting a job order is to pass
the Order statement to CTMAPI as a standard parameter. Alternatively, you can use
the conversational mode of interface, where the CTMBAPI area is passed as the
parameter, and fields in it identify the request. This mode, which is described in
Conversational Mode using Program on page 904, is most useful when the calling
program requires a reply to be returned to it, for example, to keep track of the Order
ID of ordered jobs.
The standard method of calling CTMAPI and passing it the Order request in an
Assembler program is
EXEC CTMAPI PARM= ORDER var i abl e
MVC CMORDDSN, DSNAME
MVC CMORDTBL, TBLNAME
MVC CMORDJOB, JOBNAME
MVC CMORDDAT, DATE
CALL CTMAPI , ( PARMAREA) , VL
.
.
.
PARMAREA DC Y( PARMLEN)
DC C' ORDER DSN='
CMORDDSN DS CL44
DC C' MEM='
CMORDTBL DS CL8
DC C' JOB='
CMORDJOB DS CL8
DC C' ODATE='
CMORDDAT DS CL6
PARMLEN EQU * - PARMAREA
DSNAME DC CL44' CTM. PROD. SCHEDULE'
TBLNAME DC CL8' DEFSCHD1'
JOBNAME DC CL8' JOBA'
DATE DC CL6' 090600'
1. Order or Force Existing Jobs
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 889
In the above sample, just one job is ordered from an existing table, and the calling
program receives only the return code indicating whether the call was successful or
unsuccessful.
Order or Force Allocations
The default ALC member used by the Order service is ALCMJOBP, which allocates
the AJF, calendars, CONTROL-M Statistics file and the UNITDEF member. If you
choose to prepare your own ALC member, you must allocate at least all the above
files.
The DATEREC file is ignored when you use CTMAPI to order jobs.
Order or Force Return Codes
Table 269 shows the return codes that can be returned to the caller (in register R15).
NOTE
The VL parameter of the CALL macro must be coded, in order to turn on the high order bit of
the parameter list.
Table 269 Order or Force Return Codes
Return Code Explanation
0 The operation was successfully performed.
4 At least one job was not ordered, due to one of the following:
s missing calendar
s a problem was encountered in the scheduling table
s a PREV or NEXT date condition was missing
s CTMX001 cancelled the order
8 An error occurred, and the order stopped while being processed.
12 Syntax error in the command.
16 or more Severe error in CTMAPI. The order stopped while being processed.
2. Create, Order, or Force New Tables
890 CONTROL-M for OS/390 and z/OS User Guide
Order or Force Performance Considerations
There are no specific performance considerations with regard to the Order itself.
However, using an IF statement can affect the overall performance. For information
regarding the impact of an IF statement on performance, see Performance
Considerations for Selection Criteria on page 901.
Order or Force Security Considerations
The exit called during the Order process is CTMSE01. The files that are accessed, and
the type of access, are summarized in Table 270.
2. Create, Order, or Force New Tables
CTMAPI enables the user to create job scheduling tables, then order or force those
tables. You can order or force a job scheduling table to the Active Jobs File (AJF) even
if that table is not in a scheduling library.
This service is similar to that provided by the CTMBLT utility. It is activated by
means of appropriate CTMBLT input control statements.
Invoking Create, Order or Force New Tables Using Program
The CTMBLT control statements can be specified in a sequential file pointed to by the
DAAPI DD statement, or in an in-core table containing the control statements as
80-byte card images. The first control statement must be the character string 'BLT',
beginning in column 1, to indicate that the statements that follow are input for
CTMBLT. The rest of the control statements must conform to the usual CTMBLT
syntax.
Table 270 Files Accessed during the Order or Force Process
File Name Type of Access
Active Jobs File Read and Write
Calendar Read
Statistics File Read
Unit Definition Read
2. Create, Order, or Force New Tables
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 891
For a full description of the CTMBLT parameters and how to specify whether the
scheduling tables should be optionally ordered or forced, see the description of the
CTMBLT utility in the INCONTROL for OS/390 and z/OS Utilities Guide.
The SYSPRINT DD statement must be pre-allocated to the step. The output of
CTMAPI is written to this file. A return code is returned in register R15. A full list of
valid return codes is provided in Order or Force Return Codes on page 889. When
M is specified in the CTMBLT control parameter OPTION, appropriate messages
(BLT89AI) are issued to the job log for each scheduling table that is created.
Create, Order or Force Allocations
The default ALC member used by the CTMBLT service is ALCMBLT. This allocates
the CONTROL-M AJF, IOA LOG, IOA calendars, CONTROL-M Statistics file, and
UNITDEF member. These files are required only if the user requests the ordering or
forcing of the scheduling tables that are built.
Create, Order or Force Return Codes
Table 271 shows the return codes that can be returned to the caller (in register R15).
Create, Order or Force Performance Considerations
There are no specific performance considerations with regard to CTMBLT itself.
Create, Order or Force Security Considerations
When using the CTMBLT service to create, order, or force a new table, the security
considerations are the same as those described in Order or Force Security
Considerations on page 890.
Table 271 Create and/or Order or Force New Tables Return Codes
Return Code Explanation
0 The operation was successfully performed.
8 An error occurred. The table was not built, or not ordered.
12 Syntax error in the command.
16 or more Severe error in CTMAPI.
3. AJF Actions
892 CONTROL-M for OS/390 and z/OS User Guide
Table 272 shows the files that are accessed when Order or Force is requested, and the
type of access.
3. AJF Actions
Using this type of call to CTMAPI, various actions can be performed against jobs
residing in the Active Jobs file (AJF). This service can be called from any environment,
with few differences between environments. The full syntax for this service is as
follows:
The if_statement part of the command is described in Conditional Requests and
Selection Criteria on page 900, and the selection criteria are detailed in Table 277 on
page 900.
You must ensure that the selection criteria that you specify are sufficiently detailed to
return only one job. If the criteria can fit more than one job, the action is not
performed.
An appropriate message (CTM65AI) is issued to the IOA Log file for each action that
is executed.
AJF Action under Batch, REXX or CLIST
When called from a batch job or step or from a REXX or CLIST, the AJF statement is
specified as one of the following:
s a statement in the format
Table 272 Files Accessed during the Create, Order or Force Process
File Name Type of Access
Active Jobs File Read and Write
Calendar File Read
Statistics File Read
Unit Definition File Read
AJF{ HOLD| FREE| DELETE| UNDELET| CONFI RM| RERUN| REACT| FORCEOK}
{ sel ect i on_cr i t er i a} [ sel ect i on_cr i t er i a]
[ I F i f _st at ement ]
EXEC CTMAPI PARM= AJF var i abl e
3. AJF Actions
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 893
s in a sequential file pointed to by a DAAPI DD statement
In this type of call, only a return code is returned in register R15. A full list of valid
return codes is provided in AJF Action Return Codes on page 895.
If multiple commands are entered in a DAAPI DD statement, the final return code is
the highest return code from any of the commands. For example, if three different
commands were entered to DAAPI, and only the second command failed, the final
return code will be the return code for the failing command. However, there is no
way of knowing which of the commands failed. BMC Software therefore
recommends that you use one command at a time, rather than multiple commands.
AJF Action using Program
When called from a program, the simplest method of requesting the appropriate
action against a job is to pass the above statement to CTMAPI as a standard
parameter. Alternatively, you can use the conversational mode of the interface, where
CTMBAPI area is passed as the parameter, and fields in it identify the request. This
mode is described in Conversational Mode using Program on page 904.
3. AJF Actions
894 CONTROL-M for OS/390 and z/OS User Guide
The standard method of calling CTMAPI and passing the Hold request to it in an
Assembler program is:
In this example of a Hold job, the MEMNAME is DEFSCHD1, its job name is JOBA,
the OrderID is 0AS45, and the ODATE is 090601. The HOLD command for the job is
issued only if its prior STATE was FREE. The calling program receives only the return
code that indicates whether the call was successful or unsuccessful.
AJF Action Allocations
The default ALC member used by the AJF Action service is ALCMAJF, which
dynamically allocates the AJF only. If you choose to prepare your own ALC member,
you must ensure that you allocate at least the above file.
MVC CMACTMEM, MEMNAME
MVC CMACTJOB, JOBNAME
MVC CMACTOI D, ORDERI D
MVC CMACTDAT, DATE
MVC CMACTFRE, FREE
MVC CMACTI F, CMACTSEL
CALL CTMAPI , ( PARMAREA) , VL
.
.
.
PARMAREA DC Y( PARMLEN)
DC C' HOLD'
CMACTSEL DC C' MEM='
CMACTMEM DS CL8
DC C' JOB='
CMACTJOB DS CL8
DC C' OI D='
CMACTOI D DS CL5
DC C' ODATE='
CMACTDAT DS CL6
CMACTLEN EQU * - CMACTSEL
DC C' I F STATE='
CMACTFRE DS CL4
DC CL1' '
CMACTI F DS CL( CMACTLEN)
PARMLEN EQU * - PARMAREA
MEMNAME DC CL8' DEFSCHD1'
JOBNAME DC CL8' JOBA'
ORDERI D DC CL5' 0AS45'
DATE DC CL6' 090600'
FREE DC CL4' FREE'
NOTE
The VL parameter of the CALL macro must be coded in order to turn on the high order bit of
the parameter list.
3. AJF Actions
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 895
AJF Action Return Codes
Table 273 shows the return codes that can be returned to the caller (in register R15).
AJF Action Performance Considerations
There are no specific performance considerations with regard to the Action itself.
However, the Selection Criteria or IF statement can significantly affect the overall
performance. For information regarding the impact of Selection Criteria and/ or IF
statements on performance, see Performance Considerations for Selection Criteria
on page 901.
AJF Action Security Considerations
The exit that is called during execution of the action is CTMSE08.
Table 274 shows the files that are accessed, and the type of access.
Table 273 AJF Action Return Codes
Return Code Explanation
0 The operation was successfully performed.
4 The operation was not performed. The selection criteria or IF
statement were not matched, or more than one job conformed to the
selection criteria.
8 The operation could not be performed.
12 Syntax error in the command.
16 or higher Severe error in CTMAPI.
Table 274 Files Accessed during the AJF Action Process
File Name Type of Access
Active Jobs File Read and write.
4. Search
896 CONTROL-M for OS/390 and z/OS User Guide
4. Search
The Search function can be used to check the existence of a job in the AJF. It can be
called from any environment. However, the AJF entry of the job can only be returned
to the caller by using the CTMBAPI mode. Under all other environments, only the
return code is returned to the caller, indicating whether or not the job exists in the
AJF.
This function should only be used when you want to execute your own process based
on the result of this search. If you want to execute one of the other CTMAPI functions
based on the Search result, it is recommended that you use the conditional form of
that function instead.
The full syntax for the Search call is as follows:
The various valid selection_criteria are described in Conditional Requests and
Selection Criteria on page 900 and Table 277 on page 900.
You must ensure that the selection criteria that you specify are sufficiently detailed to
return only one job. If the criteria can fit more than one job, the action is not
performed.
Search under Batch, REXX or CLIST
When called from a batch job or step or from a REXX or CLIST, the Order statement is
specified as one of the following:
s a statement in the format
s in a sequential file pointed to by DD statement DAAPI
In this type of call, only a return code is returned in register R15. A full list of valid
return codes is provided below.
If multiple commands are entered in DAAPI, the final return code is the highest
return code from any of the specified commands. For example, if three different
commands were entered to DAAPI, and only the second command failed, the final
return code will be the return code for the failing command. However, there is no
way to know which of the multiple commands failed. BMC Software therefore
recommends that you use one command at a time, rather than multiple commands.
SEARCH sel ect i on_cr i t er i a [ sel ect i on_cr i t er i a]
EXEC CTMAPI PARM= SEARCH var i abl e
4. Search
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 897
Invoking Search from a Program
When called from a program, the simplest method of searching for a job is to pass the
Search call statement to CTMAPI as a standard parameter. Alternatively, you can use
the conversational mode of the interface, where the CTMBAPI area is passed as the
parameter, and fields in it identify the requested job. This mode is described in
Conversational Mode using Program on page 904. As mentioned earlier, the
advantage of using the CTMBAPI mode is that your program gets back from
CTMAPI the entry of the job, mapped by CTMBJSE DSECT, as described in The
Status Reply DSECT (CTMBJSE) on page 910.
The standard method of calling CTMAPI and passing it the Search request in an
Assembler program is
In this sample SEARCH, the job has a MEMNAME of DEFSCHD1, with a job name of
JOBA, an OrderID of 0AS45, and an ODATE of 090601. The calling program receives
only the return code indicating whether the call was successful or unsuccessful.
MVC CMACTMEM, MEMNAME
MVC CMACTJOB, JOBNAME
MVC CMACTOI D, ORDERI D
MVC CMACTDAT, DATE
CALL CTMAPI , ( PARMAREA) , VL
.
.
.
PARMAREA DC Y( PARMLEN)
DC C' SEARCH'
DC C' MEM='
CMACTMEM DS CL8
DC C' JOB='
CMACTJOB DS CL8
DC C' OI D='
CMACTOI D DS CL5
DC C' ODATE='
CMACTDAT DS CL6
PARMLEN EQU * - PARMAREA
MEMNAME DC CL8' DEFSCHD1'
JOBNAME DC CL8' JOBA'
ORDERI D DC CL5' 0AS45'
DATE DC CL6' 090600'
NOTE
The VL parameter of the CALL macro must be coded in order to turn on the high order bit of
the parameter list.
4. Search
898 CONTROL-M for OS/390 and z/OS User Guide
Search Allocations
The default ALC member used by the Search service is ALCMAJF, which
dynamically allocates the AJF only. If you choose to prepare your own ALC member,
you must ensure that you allocate at least the above file.
Search Return Codes
Table 275 shows the return codes that can be returned to the caller (in register R15).
Search Performance Considerations
There are no specific performance considerations with regard to the Search itself.
However, the Selection Criteria can significantly affect the overall performance. For
information regarding the impact of Selection Criteria on performance, see
Performance Considerations for Selection Criteria on page 901.
Search Security Considerations
This function does not call any security exit during the Search process.
Table 275 shows the files that are accessed, and the type of access.
Table 275 Search Action Return Codes
Return Code Explanation
0 The job exists.
4 The job was not found, or more than one job conforming to the
selection criteria was found.
8 The operation could not be performed.
12 Syntax error in the command.
16 and higher Severe error in CTMAPI.
Table 276 Files Accessed during the AJF Action Process
File Name Type of Access
Active Jobs File Read
5. Global Variables
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 899
5. Global Variables
You can use CTMAPI to Set and Checkpoint variables in the IOA Variable Database.
The resolve option is available only when CTMAPI is called in Conversation mode.
The full syntax for this CTMAPI service is
The SET, SETCKP, CHECKPOINT and CKP options define the action to be
performed on the database. If the action to be performed is SET or SETCKP, the name
of the variable must be supplied. The keyword parameters are used to define the
variable name.
For more information on the actions and components of the variable name, see the
IOA administration chapter in the INCONTROL for OS/390 and z/OS Administrator
Guide.
Global Variables under Batch REXX or CLIST
If you are calling this function from a batch job, REXX, or CLIST, the GLOBAL
statement can be specified in one of the following:
s a statement with the following syntax
EXEC CTMAPI PARM=' GLOBAL act i on | var name'
where:
action has one of the following values:
s SET
s SETCKP
s CHECKPOINT
s CKP
varname is the name of a global variable
s a sequential file pointed to by the DAAPI DD statement
If you use a DAAPI file, you can insert multiple commands.
GLOBAL { SET | SETCKP | CHECKPOI NT | CKP}
{ I OA=xxxx, PRODUCT=x, APPL=xxxx, GROUP=xxxx, MEMBER=xxxx,
VAR=%%\ xxxxxx, VALUE=xxxx}
Conditional Requests and Selection Criteria
900 CONTROL-M for OS/390 and z/OS User Guide
Conditional Requests and Selection Criteria
Many services can be conditionally executed based on various terms and conditions.
This topic describes in more detail the various criteria that can be used.
Poor usage of selection criteria can dramatically impact the overall performance.
Before using such selection criteria, read Performance Considerations for Selection
Criteria on page 901.
Character fields marked with an * (Asterisk) to the right of the field are used as a
prefix for the specified selection criteria. No masking is allowed in any other field.
For example, if you specify MEM=ABC*, all jobs with the MEMNAME prefix "ABC"
will be selected.
The full syntax for the selection criteria is as follows:
Table 277 shows the meanings of the parameters in that statement.
I F { [ MEM=memname* ] | [ GROUP| GRP=gr oup_name* ] |
[ JOB=j ob_name* ] | [ JOBI D=j es_j ob_number ] |
[ OWNER=owner * ] | [ OI D=or der i d] | [ ODATE={ ODAT| dat e} ] |
[ STATUS={ WAI T_SCH
WAI T_CONF
WAI T_PI PE
WAI T_ORD
EXEC_ERR
EXEC_WSUB
EXEC_I NQ
END_OK
END_OK_FOK
END_NOK_ABND
END_NOK_JCLE
END_NOK_UNKW
END_NOK_CC
END_NOK_NSUB
END_NOK_DI SA
EXI ST
NOTEXI ST
DEL} ]
| [ STATE={ HOLD| FREE} ] }
[ { AND| OR} sel ect i on2 } ] . . .
Table 277 Selection Criteria Parameters (Part 1 of 2)
Parameter Description
MEM Member name of the job
GROUP (or GRP) Group name of the job
JOB Job name of the job (valid only after the job was submitted)
JOBID JES job number (valid only after the job was submitted)
OWNER Owner of the job
OID The CONTROL-M Order ID of the job
Conditional Requests and Selection Criteria
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 901
Multiple IF statements can be specified, connected to each other using regular
Boolean logic, including expressions inside parentheses.
Performance Considerations for Selection Criteria
The overall performance of each call to CTMAPI is largely dependent on the selection
criteria. These must be carefully considered.
An important factor affecting overall performance is the uniqueness of the selection
criteria. If very few jobs in the Active Jobs file conform to your selection criteria, then
very few job records will have to be handled. For example, if you search for a specific
Order ID, the result will be the reading of only a few index records and only one job
record. On the other hand, if you search for all jobs with a member name starting with
ABC, the API must read many job records as well as the index records.
You can greatly improve overall performance by using indexed fields in the selection
criteria. This results in a faster and more efficient search. The use of non-indexed
fields causes a sequential search through the Active Jobs file, which is very slow and
inefficient.
Table 278 shows the attributes of each selection criteria parameter.
ODATE The ODATE of the job. Valid values are:
s ODAT The current CONTROL-M ODATE
s date The full date, in the format YYMMDD, MMDDYY, or
DDMMYY, depending on your site format
STATUS For an explanation of these statuses, see Table 283 on page 911.
STATE Whether the job is held or free. Valid values are:
s HOLD The job is held.
s FREE The job is free.
selection2 Any of the above parameters.
Table 278 Selection Criteria Parameter Attributes (Part 1 of 2)
Parameter Indexed Unique Notes
MEM Yes No
GROUP Yes No
JOB Yes No Valid only after job submission
JOBID No No Valid only after job submission
OWNER Yes No
OID Yes Yes
Table 277 Selection Criteria Parameters (Part 2 of 2)
Parameter Description
Return Codes
902 CONTROL-M for OS/390 and z/OS User Guide
As Table 278 shows, OID is the best choice for selection criteria, since it is both
indexed and unique. On the other hand, ODATE and JOBID are the worst choices for
selection criteria, since they are neither indexed nor unique. If you must use one of
the non-indexed search criteria, BMC Software recommends using it in a combination
with other indexed criteria.
Another factor affecting overall performance is the complexity of any AND or OR
statements that qualify the selection criteria. Statements included in an AND or OR
section of the selection criteria are each handled separately, one by one, as if each is a
fully qualified selection criteria, and the whole Boolean sentence is verified only after
each such statement is checked.
Search Security Considerations
This function does not call any security exit during the Search process.
Table 279 shows the files that are accessed, and the type of access.
Return Codes
CTMAPI return codes are returned in register R15. They are also returned in the
following fields:
s BAPIRC
s BAPIRSN
s BAPIURC
The following are the types of failure of CTMAPI:
ODATE No No
STATUS Yes No EXIST and NONEXIST statuses are not
indexed.
STATE Yes No
Table 279 Files Accessed during the AJF Action Process
File Name Type of Access
Active Jobs File Read
Table 278 Selection Criteria Parameter Attributes (Part 2 of 2)
Parameter Indexed Unique Notes
Return Codes
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 903
s CTMAPI itself encountered a problem that prevented it from calling a service.
In this case
register R15 has a value higher than 8
the reason code is returned in the BAPIRSN field
s The service was activated, but failed to perform the desired action.
In this case
register R15 has a value of 8
the return code from the service is returned in the BAPIURC field
Conversational Mode using Program
904 CONTROL-M for OS/390 and z/OS User Guide
Conversational Mode using Program
This type of call is intended for use by programs. It enables the program to pass
requests, accept replies, respond on the basis of the reply, and maintain
communication between the program and the API.
The basic communication area, which is passed back and forth between the calling
program and the API, is mapped by the Assembler DSECT CTMBAPI, which can be
found in the IOA MAC library. Different fields in this DSECT identify the request,
specify the selection criteria, and pass the address of the area in which replies to the
caller are to be returned.
Input and Output Registers
On input to any CTMAPI service, the contents of the general-purpose registers
should be as shown in Table 280.
On return, all registers are restored by CTMAPI, and a return code is returned in
register R15. In this appendix, the return codes and their meanings are explained
under each service.
Table 280 Contents of Registers on Input to CTMAPI
Register Contents
R0 Irrelevant
R1 Address of parameter list, where the first (and only) parameter
points to CTMAPI DSECT, with its high-order bit turned on (the VL
parameter of the CALL macro)
R2 through R12 Irrelevant
R13 SAVE AREA address of caller
R14 Return address
R15 CTMAPI entry point address
CTMBAPI DSECT
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 905
CTMBAPI DSECT
This section describes in more detail
s how to use the CTMBAPI DSECT
s what fields the caller should set
s what fields are used to return the result
The explanation assumes the use of Assembler language. However, you can use other
high level languages to implement most of the services, provided the language you
use conforms to the standard calling conventions in Table 280.
The type of service is identified in one or both of the following ways
s as a command within a buffer
The start address of the buffer is passed to the API using the BAPICMDA field. The
command length is passed using the BAPICMDL field.
s using the BAPICMD field, which identifies the type of service
If both are specified, the command takes precedence.
CTMBAPI is composed of
s a fixed part
This is used to identify the requested service, together with other necessary fields.
s a variable (extension) part
This is in variable format, where each service uses a different extension.
For each service, the format of each extension is documented in the following sections
of this appendix, for example in Status Extension on page 909, Order Extension
on page 914,AJF Action Extension on page 917, and so on.
The fields in the fixed (header) part are summarized in Table 281. The values in the
columns in Table 281 have the following significance:
s In the column headed Optional or Mandatory
M means mandatory
O means Optional
s In the column headed In or Out
I means Input
O means Output
CTMBAPI DSECT
906 CONTROL-M for OS/390 and z/OS User Guide
s In the column headed Type
CLnn means a character field nn characters in length, padded with blanks to the
right.
If omitted, it must be set to blanks.
an *(Asterisk) to the right of the CLnn entry means that the characters in the
field are used as a prefix for the specified selection criteria.
For example, if you specify MEMNAME ABC*, all jobs with a MEMNAME
prefix of "ABC" will be selected.
A means Address, a 4-byte fullword field pointing to an area.
If omitted, it must be set to binary zero.
F means Fullword, a 4-byte fullword field containing a binary number.
If omitted, it must be set to binary zero.
H means Halfword, a 2-byte halfword field containing a binary number.
If omitted, it must be set to binary zero.
Flag means a Flag Byte, where each bit has a separate significance.
Table 281 Fixed Part Values (Part 1 of 3)
Field Name
Optional or
Mandatory
In or
Out Type Usage
BAPICMD O I CL1 One byte identifier of the requested
service
Note: If the BAPICMDA field is set
to a value other than zero, it takes
precedence over the BAPICMD field.
BAPICMDA O I A Address of command buffer. The
command syntax should be identical
with the syntax of the individual
CTMAPI functions described in this
appendix. If set to zero, the
requested service must be specified
in the BAPICMD field.
BAPICMDL O I F Length of the command in the
command buffer. Ignored if the
value in BAPICMDA is zero.
CTMBAPI DSECT
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 907
BAPIFLG1 O I Flag General purpose flag.
BAPIF1CN (X80) Do not release
the working area on return.
Applicable for programs that call the
API several times. It is the
responsibility of the caller to call the
API with the function BAPI_TERM
to allow the API to free storage, close
files, and so on. Failure to do so may
cause unpredictable results, such as
storage accumulation.
BAPIMCT M I or O A Address of IOA MCT used by the
API. The caller must set this field to
zero on the first call, and leave it
untouched between multiple calls.
BAPIRC Not applicable O H Return code returned to the caller.
Identical with register R15.
BAPIRPL# O O F Number of reply slots returned by
the API. The size of each slot
depends on the service requested.
BAPIRPLC O O F Address of the first free byte in the
reply area. Serves to indicate the end
of that area.
BAPIRPLE O I A End address of the reply buffer.
If BAPIRPLS (in this Table) is set to
zero, this field is ignored.
This field informs API of the size of
the reply buffer. In some services,
such as STATUS, if the reply buffer
space is exhausted, a special return
code indicating this is returned to the
caller. The caller can then again call
the API to obtain the rest of the
reply.
BAPIRPLS O I A Start address of the reply buffer.
s If set to zero, no reply is
returned.
s If set to a value other than zero,
the API returns its replies into
this buffer.
The reply that the API can return is
explained in relation to each service.
Table 281 Fixed Part Values (Part 2 of 3)
Field Name
Optional or
Mandatory
In or
Out Type Usage
CTMBAPI DSECT
908 CONTROL-M for OS/390 and z/OS User Guide
BAPIRSN Not applicable O H Reason code returned to the caller.
Valid reason codes are documented
internally in the CTMBAPI macro.
BAPISIGN M I CL4 DSECT eye-catcher BAPI
BAPIURC Not applicable O H Return code returned to CTMAPI
from the invoked utility if that utility
failed. This return code is set only if
CTMAPI ended with return code 8.
Otherwise, the CTMAPI return code
itself identifies the problem.
BAPIVERS M I CL1 DSECT Version. The current version
is 1.
BAPIWORK M I or O A Address of the API work area. This
field is used by the API to hold
information between calls when
more replies must be returned. The
caller must set this field to zero and
leave it untouched between multiple
calls.
Table 281 Fixed Part Values (Part 3 of 3)
Field Name
Optional or
Mandatory
In or
Out Type Usage
Status Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 909
Status Extension
The value of 2 (BAPI_M_STATUS) should be set in the BAPICMD field for the Status
function.
The Status function can be used to retrieve information about jobs in the Active Jobs
file. This service can be called from any environment, but only by using the
CTMBAPI mode, that is, using a program, and not by means of a batch statement,
REXX or CLIST.
On return, the status of and other information about the job is returned to the caller.
If you only requested one job, for example, Status using OID, the result is returned in
the Status extension itself. If more than one job may conform to the selection criteria,
for example, the status of MEMNAME ABC, a reply buffer must be supplied into
which the API can return a result for each and every job that conforms. If no such
buffer is supplied, no reply other than an appropriate return code is returned.
The Status extension fields are summarized in Table 282. If the caller filled in a field, it
is used as Search argument, and only jobs that conform to that field are returned. On
return from the API, if no reply area has been supplied, and if only one job conforms
to the selection criteria, the API will fill in all these fields with actual information
about this job. For example, if you specify ABC in BAPISMEM, and there is only one
job in the AJF with a matching MEMNAME, such as ABCXYZ, on return from the
API this field will hold the value ABCXYZ.
The values in the columns in Table 282 have the same significance as those in
Table 281.
Table 282 Status Extension Fields (Part 1 of 2)
Field Name Optional
In or
Out Type Usage
BAPISGRN O I or O CL20* Group name.
BAPISHLD O I or O CL1 Hold state. Valid values are:
s H (Hold)
s F (Free)
BAPISJID O I or O CL5 JES job ID (job number).
BAPISJNM O I or O CL8* Job name. Valid only after job
submission.
BAPISLIB O I or O CL44* Scheduling library from which the job
was ordered.
BAPISMEM O I or O CL8* MEMNAME.
BAPISODT O I or O CL6 ODATE of the job. This must be fully
specified. Prefixing is not supported.
Status Extension
910 CONTROL-M for OS/390 and z/OS User Guide
The Status Reply DSECT (CTMBJSE)
The DSECT that formats reply area entries is CTMBJSE. Each entry is 240 bytes long.
For REXX parsing, fields in this DSECT are separated by a blank.
You must always allocate an area of 12,000 bytes and code its address in the
BAPIRPLS field.
BAPISOID O I or O CL5 Order ID. If a value is entered, it must
include all five characters of the Order
ID.
Prefixing is not supported.
BAPISOWN O I or O CL8* Owner of the job.
BAPISRBA Not
applicable
O CL6 RBA of the job, in hexadecimal
format.
BAPISRBB Not
applicable
O CL3 RBA of the job, in binary format.
BAPISSTT O I or O CL15* Status of job. For a list of valid values,
see Table 283 on page 911.
The masking character * can be
used in any status value which
includes an underscore character _.
However, the * must follow
immediately after the _.
BAPISTAB O I or O CL8* Scheduling table from which the job
was ordered.
BAPISTYP O I or O CL3 Task type. Valid values are:
s JOB
s GRP
s STC
s CYC
s EMR
s CST
s ECJ
s EST
s ECS
s WRN
Except for GRP, each of these is
explained in TASKTYPE: General
Job Parameter on page 643. GRP is
explained in Table 54 on page 170.
Table 282 Status Extension Fields (Part 2 of 2)
Field Name Optional
In or
Out Type Usage
Status Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 911
The search criteria can fit multiple jobs on the AJF, up to a maximum of 50 jobs. For
example, if you want to process 25 jobs, prepare an area of 12,000 bytes and code its
address in the BAPIRPLS field. After returning from the API, the area will contain the
details of the 25 jobs. Each job line is detailed in the CTMBJSE DSECT and contains
relevant information about the located job.
The number of lines is returned in the BAPIRPL# field. When this field points to the
maximum, 50, it is possible that there are more lines that can be returned. In that case,
the value of the Utility Return Code field BAPIURC will be 4, and the Reason Code
field BAPIRSN will have the value "BAPI_HAVE_MORE_LINES." In such a case, the
user program can set bit BAPISPF8 in byte BAPISF1 and call CTMAPI again. This call
will retrieve the next 50 lines of output that match the search criteria. When multiple
lines are returned, the lines are in the order from the end (the most recent job) to the
beginning. There is an option for the calling program to receive only one line of
output, by specifying as the value in the BAPISF1 flag byte either BAPIS1ST (first
line) or BAPISLST (last line).
Except for field JSESTAT, the meanings of the fields are as described (internally) in
the macro CTMBJSE, which is in the IOA MAC library. The JSESTAT field returns the
status of the job in the AJF. The CTMAPI status function does not return all the
statuses detailed in the CONTROL-M for OS/390 and z/OS User Guide. A list of the
statuses that can be returned appears in Table 283.
Table 283 Statuses Returnable under the Status Function (Part 1 of 2)
Status Description
DEL Job was deleted.
END_NOK_ABND The job ended NOTOK because of an abend.
END_NOK_CC The job ended NOTOK because of the Condition Code of the job.
END_NOK_DISA The job ended NOTOK. It disappeared.
END_NOK_JCLE The job ended NOTOK because of a JCL error.
END_NOK_NSUB The job ended NOTOK. It was not submitted by JES.
END_NOK_UNKW The job ended NOTOK for an unknown reason.
END_OK The job ended OK.
END_OK_FOK The job was ForcedOK.
EXEC Job is executing.
EXEC_ERR Relevant only to group entities. Several of the jobs in the group are
still executing, but at least one of them has ended NOTOK.
EXEC_INQ The job was submitted to JES, but is not yet processing.
EXEC_WSUB Wait submission. The job was selected, but it is still waiting for
CONTROL-M to submit it to JES.
WAIT_CONF Wait for confirmation.
WAIT_ORD The ordering of a group is not yet complete. The group is still in the
order process.
WAIT_PIPE Waiting for all members of the pipe to be ready for submission.
Status Extension
912 CONTROL-M for OS/390 and z/OS User Guide
Status Allocations
The ALC member used by the Status service as the default is ALCMAJF, which
dynamically allocates the AJF only. If you choose to prepare your own ALC member,
you must ensure that you allocate at least the above file.
Status Return Codes
Table 284 shows the return codes that can be returned to the caller (in register R15).
Status Performance Considerations
The Status function searches the AJF for the requested jobs. More than one job may
conform to the selection criteria specified in the CTMBAPI DSECT. In that case, a Job
Status Element (JSE) entry is returned to the caller for each job.
The Selection Criteria can significantly affect overall performance.
WAIT_SCH Wait Schedule.
EXIST The job exists on the Active Jobs file.
NONEXIST The job does not exist on the Active Jobs file.
Table 284 Status Return Codes
Return Code Explanation
0 The operation was completed OK.
If a reply buffer was supplied, but was exhausted, meaning that not
all the statuses could be returned into the supplied buffer, a special
reason code, 286, is returned in the BAPIRSN field to indicate that
there are more replies.
4 The job was not found.
8 The operation could not be performed.
12 Syntax error in the command.
16 and higher Severe error in CTMAPI.
Table 283 Statuses Returnable under the Status Function (Part 2 of 2)
Status Description
Status Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 913
s The more specific the request, the fewer the jobs that must be read and returned to
the caller. For example, if you request status information for all jobs starting with
the letter A, the function must read a large part of the AJF, degrading its
performance.
s Pay special attention to whether your search criteria are indexed. If you ask for
status information about jobs with a selection criteria that is not indexed, for
example, from a specific ODATE, without any indexed selection criteria, the whole
AJF must probably be read.
The impact of Selection Criteria on overall performance is described in Performance
Considerations for Selection Criteria on page 901.
Status Security Considerations
This function does not call any security exit during the Status process.
The files that are accessed, and the type of access are summarized in the following
table:
Table 285 Files Accessed during the AJF Action Process
File Name Type of Access
Active Jobs File Read
Order Extension
914 CONTROL-M for OS/390 and z/OS User Guide
Order Extension
The value that should be set in the BAPICMD field for this function is 1
(BAPI_M_ORDER).
You can use the Order function to order jobs to the AJF. You can call this function
from any environment, but only by using the CTMBAPI mode. The function uses the
usual CONTROL-M order process to put the requested job on the AJF. The return
code will appear in the BAPIURC (Utility Return Code) field.
If CTMAPI fails to invoke the order process, register R15 will contain a value of 8 or
higher, and the reason code will appear in the BAPIRSN field.
You can request a detailed reply from the order process, using the following
procedure:
1 Prepare a memory area.
2 Pass the start address in the BAPIRPLS field.
3 Pass the address of the last byte of this area in the BAPIRPLE field.
After returning from the order process, the BAPIRPLC field will point to the last
byte replied. The BAPIRPL# field will contain the number of reply lines. For each
job processed by the order process, a reply line will be returned detailing the job
identifiers and the RC of the order for this specific job. This is in contrast to the
usual output lines of the order process that are issued only for jobs that have
actually been ordered. Details of the reply line are specified in the CTMBAPO
DSECT.
Table 286 contains a summary of the CTMBAPI Order input fields. You must
ensure that all fields whose type is CL are initialized with BLANKS, and those with
type X are initialized to binary zeros.
Table 286 Order Fields (Part 1 of 2)
Field Name Optional
In or
Out Type Usage
BAPIODSN N I CL44 Scheduling table DS name. Mutually
exclusive with BAPIODD.
BAPIOMEM N I CL8 Member name
BAPIODD O I CL8 Scheduling table DD name. Mutually
exclusive with BAPIODSN.
BAPIOJOB O I CL8 Job name. Enter (Blank) to order all
jobs in the table.
BAPIODAT O I CL6 ODATE. Default is the current Odate.
Order Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 915
Order Return Codes
Table 287 shows the return codes that can be returned to the caller (in register R15).
BAPIORBA O I CL6 RBA of the group entity when a
Dynamic Group Insert is performed.
BAPIOF1 O I XL1 Flags byte. Valid values are:
s X80 Force the table
s X40 Insert the job into a group
entity that already exists on the
AJF
s X20 Allow duplicate jobs in the
group when dynamically
inserting a job into the group
s From X10 through X01 These
bits are reserved for internal use
BAPITAG# O I XL2 Number of tag statements that follow
this field.
This field is for users who want to
implement the IGNORE and/ or
SELECT TAG logic that is discussed
on connection with the utility
CTMJOB in the CONTROL-M chapter
of the INCONTROL for OS/390 and
z/OS Utilities Guide.
After this field, you should code the
matching number of BAPITGNM
statements that define the tags
themselves.
BAPITGIN O I CL1 Ignore or Select indicator. Valid
values are:
s I Ignore
s S Select
BAPITGNM O I CL20 Tag name
Table 287 Order Return Codes (Part 1 of 2)
Return Code Explanation
0 Order completed OK. If a reply buffer is specified in the BAPIRPLS
field, a reply line is returned for each job.
4 Order completed OK, but the order process issued a warning. This
usually occurs when one of the specified calendars was not found.
Table 286 Order Fields (Part 2 of 2)
Field Name Optional
In or
Out Type Usage
Order Extension
916 CONTROL-M for OS/390 and z/OS User Guide
Order Reply
The conversational mode (BAPI) order process can return a reply line for each job
processed. The reply line is mapped by DSECT CTMBAPO, which is described in
more detail in CTMBAPO on page 924.
Order or Force Allocations
For full information, see 1. Order or Force Existing Jobs on page 887.
Order or Force Security Consideration
For full information, see 1. Order or Force Existing Jobs on page 887.
8 The operation could not be performed. The Order process
encountered a severe error.
12 Syntax error.
16 Severe error in CTMAPI, such as a failure to get memory or a failure
to open a file.
Table 287 Order Return Codes (Part 2 of 2)
Return Code Explanation
AJF Action Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 917
AJF Action Extension
The AJF Action function can be used to perform basic Active Environment screen
(Screen 3) actions upon jobs in the AJF. Using the BAPI interface, a user program is
able to perform actions such as holding, freeing, deleting jobs in the AJF in much the
same manner as the user can from Screen 3.
For this function, set the value in the BAPICMD field to 3 (BAPI_M_ACT).
The Action function can be called from any environment. The input contains the
following types of input:
s to identify the job
s to define the Action upon the job
s special input parameters for use when RERUN is required
These are described in the following sections.
Identifying the Job
The first type of input identifies the job, using the field names in Table 288.
CTMAPI uses this variable to find the job in the same way it does a search. For
information concerning performance and security, see Create, Order or Force
Performance Considerations on page 891.
Table 288 AJF Action Parameters
Field Name Optional
In or
Out Type Usage
BAPIAMEM O I CL8 Member name in table.
BAPIAJNM O I CL8 Job name, in JCL.
BAPIAOWN O I CL8 Owner ID of the job.
BAPIAJID O I CL5 JOBID as returned by JES.
BAPIAOID O I CL5 CONTROL-M ORDERID.
BAPIAGRN O I CL20 Group name.
BAPIRBAN O I XL3 RBA in binary format.
BAPIRBAC O I CL6 RBA of the job in characters, with
each character representing a
hexadecimal digit.
AJF Action Extension
918 CONTROL-M for OS/390 and z/OS User Guide
Defining the Action
To define the Action, you must set a 1-byte field called BAPIAACT with one of the
values in Table 289
Action Return Codes
The CTMAPI Action return code is returned in register R15. There are basically two
types of failure:
s The CTMAPI program itself encountered a problem which prevented it from
calling the service. In this case
register R15 has a value higher than 8
the reason code is returned in the BAPIRSN field
s The service was activated but failed to perform the desired action. In this case
register R15 has a value of 8
the return code from the service is returned in the BAPIURC field
Table 290 shows in more detail the return codes that can be returned to the caller (in
register R15).
Table 289 AJF Action BAPIAACT Field Values
Value Explanation
BAPIAHLD Hold
BAPIAFRE Free
BAPIADEL Delete
BAPIAUND Undelete
BAPIARER Rerun
BAPIARCT React
BAPIAFOK Force OK
BAPIACON Confirm
Table 290 CTMAPI Action Return Codes (Part 1 of 2)
Return Code Explanation
0 The action was successfully performed.
8 The action was not successfully performed.
The field BAPIURC contains a return code indicating the fault.
AJF Action Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 919
Action AJF Allocations
For information on AJF Actions, see 3. AJF Actions on page 892.
Action Security Considerations
For information on AJF Action security considerations, see 3. AJF Actions on
page 892.
12 Syntax error.
16 Severe error, such as failure to get memory, or failure to open a file.
Table 290 CTMAPI Action Return Codes (Part 2 of 2)
Return Code Explanation
Global Variable Extension
920 CONTROL-M for OS/390 and z/OS User Guide
Global Variable Extension
The Global Variable Extension is used to resolve, set, or checkpoint variables in the
IOA Variable Database. For more information on this facility, see the IOA
administration chapter in the INCONTROL for OS/390 and z/OS Administrator Guide.
The value for this function in the BAPICMD field is 6. For more information on the
BAPICMD field, see BAPICMD on page 906.
Table 291 contains a summary of the CTMBAPI Global Variable Extension input
fields. You must ensure that all fields whose type is CL are initialized with BLANKS,
and those with type X are initialized to binary zeros.
Table 291 Global Variable Fields
Field Name Optional In or Out Type Usage
BAPIGOPT N I XL1 Option byte.
Valid values are:
s X'00' Resolve
Obtain the value of a variable
from the database.
s X'80' Set
Set the value of a variable
from the database.
s X'40' Checkpoint
Force all changed variables to
be written to the database.
BAPIGIOA O I CL8 QNAME
Default: MCTQNAME
BAPIGAPL O I CL20 Application name.
Default: NO_APPL
BAPIGGRP O I CL20 Group name.
Default: NO_GROUP
BAPIGMEM O I CL20 Member name.
Default: NO_MEM
BAPIGVAR N I CL256 Variable name.
BAPIGVAL N I/ O CL256 Variable value.
BAPIGPRC O I CL1 INCONTROL product.
Default: 'M'
Quantitative Resource Extension
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 921
Global Variable Return Codes
Table 292 shows in more detail the Global Variable return codes that can be returned
to the caller (in register R15).
Quantitative Resource Extension
The Quantitative Resource Extension function is used to query the status of a
quantitative resource in the CONTROL-M Resources file. It can be called from any
environment by means of the CTMBAPI mode.
Use BAPI_M_RES to set the value for this function in the BAPICMD field to 4.
Table 292 Global Variable Return Codes
Return Code Explanation
0 The action was successfully performed.
8 The action was not successfully performed.
The field BAPIURC contains a return code indicating the fault.
12 Syntax error.
16 Severe error, such as failure to get memory, or failure to open a file.
Table 293 CTMAPI Quantitative Resource Fields
Field Name Optional
In or
Out Type Usage
BAPIRESN N I CL20 Name of the resource. This serves as
the sole key to the search.
BAPIRESX O XL2 Maximum quantity defined for this
resource.
BAPIRESQ O XL2 Quantity currently held by jobs in the
AJF.
BAPIRESP O XL1 If the resource is reserved for a critical
path job, this field will contain the
priority of this job, which will be from
1 through 9.
Create And/Or Order or Force a Table (BLT)
922 CONTROL-M for OS/390 and z/OS User Guide
Quantitative Resource Return Codes
The result is returned directly to the BAPI DSECT as specified below.
Quantitative Resource Security Considerations
The security exit called is IOASE07.
Quantitative Resource Allocations
The files that are accessed, and the type of access, are summarized in Table 295.
Create And/Or Order or Force a Table (BLT)
The BLT function invokes the CTMBLT utility to create, save, and optionally order a
table on the fly.
Unlike the other functions implemented through BAPI extension, this feature does
not contain a separate extension where you define the input parameters. Instead
1 Set the BAPICMD field to the value BAPI_M_BLT.
2 Prepare the input to the API in memory as a regular CTMBLT input stream, as
described in the INCONTROL for OS/390 and z/OS Utilities Guide, pointed to by the
CTMCMDA field.
Table 294 CTMAPI Quantitative Resource Return Codes
Return Code Explanation
0 The operation completed OK. The output fields in the BAPI DSECT
are updated.
4 The resource was not found in the file.
16 Severe error encountered, such as failure to get memory or error in
accessing the file.
Table 295 CTMAPI Quantitative Resource File Allocation
File Name Type of Access
RES Read
Create And/Or Order or Force a Table (BLT)
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 923
3 Set the length of the input, in bytes, in the BAPICMDL field. Each control input
statement must be an 80-byte card image.
4 Set the reply fields.
When requesting reply fields in this function, through the BAPI interface, you
receive reply lines from both the CTMBLT function and CTMJOB. For more
information on the reply input and output fields, see CTMBAPO on page 924.
BLT Action Return Codes
BLT Reply
The conversational mode (BAPI) BLT function can return a reply line for
s each Table that was saved
s each job that was processed
The reply line is mapped by the CTMBAPO DSECT, which is described in more detail
in CTMBAPO on page 924.
BLT Security Considerations
When creating and saving scheduling tables, no IOA security exits are invoked to
check the authority of the user to access the scheduling table. If the table must also be
ordered, CTMSE01 will be called to verify that the user has the authority to order the
table.
Table 296 BLT Action Return Codes
Return Code Explanation
0 The action was successfully performed.
8 The utility did not perform the action.
The field BAPIURC contains a return code indicating the fault.
12 Syntax error.
Replies
924 CONTROL-M for OS/390 and z/OS User Guide
BLT Resource Allocations
Table 297 shows the files that are accessed, and the type of access.
Replies
The BAPI feature returns output to the customer in the following ways:
s a return code
s setting output fields in the BAPI DSECT
These fields were individually described in CTMBAPI DSECT on page 905.
s an output buffer returned by the Status service and described by the CTMBJSE
DSECT
s the replies returned by the Order and BLT functions, as described in CTMBAPO
on page 924
CTMBAPO
When in CTMBAPI mode, CTMAPI serves as an interface between a user program
and a CONTROL-M service. Some CTMAPI services have been modified to enable
them to return lines of replies into customer-supplied memory to detail their activity.
Currently this facility can be provided by
s the BLT process
s the Order process
For example, if the proper instructions are given, the Order process will return a reply
line for each job which it processes. This contrasts with normal processing, where a
line of output is not written until a job is actually placed on the AJF or a severe error
has occurred. You can then act upon and/ or process the reply lines.
Table 297 CTMAPI Quantitative Resource File Allocation
File Name Type of Access
Active Jobs File Read and Write
Calendar File Read
Statistics File Read
Unit Definition File Read
CTMBAPO
Appendix A The CONTROL-M Application Program Interface (CTMAPI) 925
To use this facility, you must supply the API with the pointers required to trigger the
reply mechanism. These are supplied through the calling program. Table 298 shows
the pointers and the fields in which they are supplied.
When BAPI returns, the BAPIRPLC field will point to the last byte actually written to
the reply buffer, and the BAPIRPL# field will contain the number of lines put there.
The API ensures that the value in the BAPIRPLC field never exceeds that set by the
BAPIRPLE field. Each line added to the reply buffer will start with the current
BAPIRPLC and will update it. BMC Software recommends that this field be
initialized to zero. If this field is not zero, API treats the value as the starting address
of the next reply line. This can be used by an application to accumulate reply lines
across several invocations of CTMAPI.
Each line in the buffer is mapped by the CTMBAPO DSECT. Each line starts with a
half-word that contains its length (BAPOLEN), and another two bytes that identify
the service that produced the reply line (BAPOID). The identification of each reply
line is mandatory, since a called service can call other CONTROL-M services which,
in turn, will place their reply lines in the buffer. By using the identification of each
reply line together with the contents of the BAPIRPLC field and the BAPIRPL# field,
you can code a routine to scan and filter reply lines.
Date Format Considerations
The format of all the date fields, both input and output, depends on your site
standard. It follows that when you prepare the input to CTMAPI, you must know
your site standard.
Table 298 CTMAPI Reply Mechanism Trigger Pointers
Field Information Required
BAPIRPLS The starting address of the reply buffer.
BAPIRPLE The address of the last byte in the reply buffer.
CTMBAPO
926 CONTROL-M for OS/390 and z/OS User Guide
Appendix B CONTROL-M for OS/390 and z/OS Unix System Services (USS) 927
Appendi x
B
B CONTROL-M for OS/390 and z/OS
Unix System Services (USS)
This Appendix discusses the implementation of CONTROL-M in the IBM OS/ 390 or
z/ OS Unix Systems Services (USS) environment.
In this appendix, the term MVS includes MVS, S/ 390, OS/ 390, and z/ OS.
Implementation Options
The use of USS with CONTROL-M for OS/ 390 and z/ OS can be implemented in
different ways, depending on your system and the way in which you use it.
Choose one of the following implementation options:
s Use MVS to run USS applications.
s Have MVS support USS in the same manner as it supports other Unix platforms,
such as CONTROL-M/ Enterprise Manager, CONTROL-M/ Server, and
CONTROL-M/ Agent.
s Integrate the architecture of SAP R/ 3 running on USS with the MVS platform.
These options are discussed individually in this Appendix.
OS/390-Oriented Implementation
928 CONTROL-M for OS/390 and z/OS User Guide
OS/390-Oriented Implementation
CONTROL-M for OS/ 390 and z/ OS fully supports the USS environment without any
need for modifications.
CONTROL-M for OS/ 390 and z/ OS manages all USS batch processes and integrates
them with batch activities on
s the local MVS system
s all other platforms across the network
For CONTROL-M to submit and control all USS executions, all that is required is the
definition of a single JCL member. This member contains a USS shell activation
program that is supported by the MVS operating system. AutoEdit variables are used
to define all elements of the USS task, such as the name of the script, the script
parameters, the job name and the script location. When CONTROL-M submits the
JCL, all the AutoEdit values are resolved and the JCL is submitted with its
corresponding values. The JCL then submits the appropriate script under USS.
CONTROL-M reads the return code of the script execution from the JCL sysout, and
proceeds accordingly.
A sample JCL member is shown in Figure 355.
In the CONTROL-M job definition that submits the JCL, use the SET VAR parameter
to assign a value to the %%MYSCRPT AutoEdit variable, as follows:
SET VAR %%MYSCRI PT=uss_scr i pt _name
Unix Oriented Implementation
To enable Unix operators to use their expert skills, CONTROL-M provides a
Unix-oriented MVS implementation for USS jobs.
Figure 355 JCL for USS Execution
/ / j obname JOB ( account _i nf o) , REGI ON=5000K
/ / STEPNAME EXEC PGM=BPXBATCH
/ / PARM=' sh / u/ usr _i d/ %%MYSCRPT'
/ / STDOUT DD PATH=' / u/ usr _i d/ st dout . f ' , PATHOPTS=( OWRONLY, OCREAT, OTRUNC) ,
/ / PATHMODE=SI RWXU
/ / STDERR DD PATH=' / u/ usr _i d/ st der r . f ' , PATHOPTS=( OWRONLY, OCREAT, OTRUNC) ,
/ / PATHMODE=SI RWXU
Unix Oriented Implementation
Appendix B CONTROL-M for OS/390 and z/OS Unix System Services (USS) 929
CONTROL-M incorporates 3-tier architecture that includes CONTROL-M/ Enterprise
Manager, CONTROL-M/ Server, and CONTROL-M/ Agent platforms. CONTROL-M
treats USS as an additional supported platform, just like any other supported Unix
platform.
This architecture is illustrated in Figure 356.
Figure 356 CONTROL-M Architecture for Unix-Oriented MVS Implementation
If you have a CONTROL-M/ Agent installed on several Unix computers, you can also
install it on a USS computer, using the same architecture. You can then implement
CONTROL-M in USS through a CONTROL-M/ Agent that allows Unix operators to
use the tools with which they are familiar.
Integrating SAP R/3 running on USS
930 CONTROL-M for OS/390 and z/OS User Guide
Integrating SAP R/3 running on USS
In many data centers, the heaviest batch application running on USS is SAP R/ 3.
The architecture of SAP is shown in Figure 357.
Figure 357 Architecture of SAP R/3
You can integrate this 3-tier architecture with the CONTROL-M MVS platform in the
following ways:
s You can use DB/ 2 as the SAP database, with MVS running the entire SAP database
layer. Many users of SAP employ this configuration.
Integrating SAP R/3 running on USS
Appendix B CONTROL-M for OS/390 and z/OS Unix System Services (USS) 931
s You can install both of the following in USS:
the database layer, using DB/ 2 running under MVS
the application layer
This configuration is popular among organizations that require the stability,
scalability, and security of the MVS platform.
CONTROL-M Support for SAP in the USS Environment
CONTROL-M support for the USS environment ensures complete automation and
integration of business processes both inside and outside the SAP application
environment.
CONTROL-M/ Enterprise Management for distributed systems supports SAP R/ 3 by
means of the CONTROL-M Option for SAP R/ 3. This product is certified by SAP in
accordance with the SAP Complementary Software Program.
The combination of CONTROL-M with the CONTROL-M Option for SAP R/ 3
enables all jobs and tasks to be managed in the same way, regardless of whether the
task is
s MVS JCL
s a Unix script
s an SAP task
The SAP R/ 3 standard Business Application Program Interface (BAPI) enables you to
define jobs through either the R/ 3 or CONTROL-M job definition process.
Once installed on a Windows NT or Unix platform, CONTROL-M Option for R/ 3
communicates with the R/ 3 Application layer. The database location is totally
transparent to CONTROL-M.
The Application layer can be in either
s SAP R/ 3
s USS
SAP R/3 Application Layer
If the Application layer is in SAP R/ 3 in a Unix computer, the communication process
between CONTROL-M Option for SAP R/ 3 and the R/ 3 Application layer is as
shown in Figure 358. In this figure, the database is an MVS (DB/ 2) database.
Integrating SAP R/3 running on USS
932 CONTROL-M for OS/390 and z/OS User Guide
Figure 358 Communication with the R/3 Application Layer - DB/2 Database
USS Application Layer
If the Application layer is in USS, use the same Windows NT or Unix CONTROL-M
Option for SAP R/ 3.
CONTROL-M Option for SAP R/ 3 communicates with the R/ 3 Application layer in
the same way that the product communicates with other platforms. The
communication process is shown in Figure 359.
Integrating SAP R/3 running on USS
Appendix B CONTROL-M for OS/390 and z/OS Unix System Services (USS) 933
Figure 359 Communication with the R/3 Application - SAP/R3 Database
Integrating SAP R/3 running on USS
934 CONTROL-M for OS/390 and z/OS User Guide
Appendix C Editing Job Scheduling Definitions in the Edit Environment 935
Appendi x
C
C Editing Job Scheduling Definitions in
the Edit Environment
Job scheduling definition parameters can be edited, moved, copied, deleted, or
repeated, by performing IOA Line Editing commands, similar to standard ISPF line
commands, from within the Edit environment.
The Edit environment in the Job Scheduling Definition screen is accessed by typing
EDIT in the COMMAND field and pressing Enter.
Figure 360 The Edit Environment in The Job Scheduling Definition Screen
A 2-character Line Editing command field, marked by underscores, is displayed for
each line on the screen.
Editing commands are typed directly onto these underscores.
JOB: BACKP02 LI B CTM. PROD. SCHEDULE TABLE: BACKUP
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ MEMNAME BACKP02 MEMLI B CTM. PROD. JOBLI B
__ OWNER M44 TASKTYPE JOB PREVENT- NCT2 Y DFLT N
__ APPL APPL- L GROUP BKP- PROD- L
__ DESC DAI LY BACKUP OF SPECI AL FI LES FROM APPL- L
__ OVERLI B CTM. OVER. JOBLI B
__ SCHENV SYSTEM I D NJE NODE
__ SET VAR
__ CTB STEP AT NAME TYPE
__ DOCMEM BACKP02 DOCLI B CTM. PROD. DOC
__ ===========================================================================
__ DAYS DCAL
__ AND/ OR
__ WDAYS WCAL
__ MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
__ DATES
__ CONFCAL WORKDAYS SHI FT RETRO N MAXWAI T 00 D- CAT
__ MI NI MUM PDS
__ DEFI NI TI ON ACTI VE FROM UNTI L
__ ===========================================================================
__ I N START- DAI LY- BACKUP ODAT
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 44. 31
936 CONTROL-M for OS/390 and z/OS User Guide
Incorrectly specified Line Editing commands can be corrected by typing over them
correctly. Line Editing commands can be deleted by blanking them out or by
specifying the RESET command in the COMMAND field.
The Line Editing commands you enter are processed when Enter is pressed.
CONTROL-M performs Automatic Syntax Checking to ensure that the job scheduling
definition is still syntactically correct after editing. If an edit may invalidate the job
scheduling definition, a message is displayed at the top of the screen and the edit is
not performed. For recommendations for editing job scheduling definitions, see
Maintaining Valid Job Scheduling Definitions on page 939.
All operations available in the Job Scheduling Definition screen can be performed
while in the Edit environment. For example, parameter values can be changed, and
the job scheduling definition can be saved and exited.
To exit the Edit environment, retype EDIT in the COMMAND field and press Enter.
Line Editing command fields are removed from the display.
Line Editing commands can be performed on the following:
NOTE
Edit commands cannot be applied to the first line of an IN block or an OUT block.
Table 299 Subjects of Line Editing Commands (Part 1 of 2)
Subject Description
Single Lines One single line on the screen.
Examples:
s Additional lines of the IN parameter.
s Single-lined DO statement (such as DO COND).
Logical Lines All parameter lines for a specific parameter, including its
subparameters.
Examples:
s A DO SHOUT statement, whose subparameters are
distributed over more than one line.
s A single-lined DO statement, such as DO COND.
Line Editing Commands
Appendix C Editing Job Scheduling Definitions in the Edit Environment 937
Line Editing Commands
The following types of line editing commands exist in the Edit environment.
Logical Blocks Functional group of parameter lines. Job scheduling
definitions consist of at least one logical block an ON block.
Example:
ON block, which consists of its respective parameter lines and
the DO statement lines.
Multiple Lines User-specified group of parameter lines.
Example:
A series of DO statements.
Table 300 Line Editing Commands - Delete Commands
Command Description
DS Delete a single line.
DL Delete a logical line.
DB Delete a logical block or sub-block.
DD Delete lines between two DD specifications.
D Delete a line. CONTROL-M determines whether to delete a single
or logical line based on the line type.
Table 301 Line Editing Commands - Copy Commands
Command Description
CS Copy a single line.
CL Copy a logical line.
CB Copy a logical block or sub-block.
CC Copy lines between two CC specifications.
C Copy a line. CONTROL-M determines whether to copy a single or
logical line based on the line type.
Copy commands are used in conjunction with Location commands. The lines and
blocks are placed at the position indicated by Location command A or B (described
below).
Table 299 Subjects of Line Editing Commands (Part 2 of 2)
Subject Description
Line Editing Commands
938 CONTROL-M for OS/390 and z/OS User Guide
Table 302 Line Editing Commands - Move Commands
Command Description
MS Move a single line.
ML Move a logical line.
MB Move a logical block or sub-block.
MM Move lines between two MM specifications.
M Moves a line. CONTROL-M determines whether to move a single
or logical line based on line type.
Move commands are used in conjunction with Location commands. The lines and
blocks are placed at the position indicated by Location command A or B, which are
described in Table 305 on page 938.
Table 303 Line Editing Commands - Repeat Commands
Command Description
RS Repeat a single line.
RL Repeat a logical line.
RB Repeat a logical block or sub-block.
RR Repeat lines between two RR specifications.
R Repeat a line. CONTROL-M determines whether to repeat a single
or logical line based on line type.
The repeated lines and blocks are placed immediately after the lines and blocks
marked with the command.
Table 304 Line Editing Commands - Insert Command
Command Description
I Inserts a new logical line or block after the logical line or block
marked with an I.
Table 305 Line Editing Commands - Location Commands
Command Description
Indication of the position where lines or blocks must be placed.
A (After) Indicates that lines or blocks must be placed after the line marked
with an A.
B (Before) Indicates that lines or blocks must be placed before the line
marked with a B.
Location commands A and B are used in conjunction with Copy (C, CS, CL, CC, CB),
and Move (M, MS, ML, MM, MB) commands.
Maintaining Valid Job Scheduling Definitions
Appendix C Editing Job Scheduling Definitions in the Edit Environment 939
Maintaining Valid Job Scheduling Definitions
Since job scheduling definitions must be syntactically correct at all times, the user
must consider the following issues when specifying Line Editing commands:
s The result of a Line Editing command is dependent on the line on which the
command is specified. For example, command D deletes either a single or a logical
line based on the line type.
s Logical lines form a unit and cannot be separated.
When a logical command is specified within a logical line, that is, on a
subparameter line or an additional parameter line, the specified operation is
performed on the entire logical line.
s Block commands must be specified on the main lines of the block. For example, to
delete an ON block, specify command DB (Delete Block) on the ON line.
s Blank parameter lines are added automatically by CONTROL-M, to allow the user
to specify additional parameters, and cannot be deleted.
s BMC Software recommends that, wherever possible, you use commands D, C, R,
and M for editing, instead of DS, DL, CS, CL, RS, RL, MS, and ML, because these
commands automatically retain the logical structure of the job scheduling
definition.
Maintaining Valid Job Scheduling Definitions
940 CONTROL-M for OS/390 and z/OS User Guide
Example 1
Before: Insert additional DO statements within a DO block using command I (Insert).
Figure 361 Example - Inserting A DO Statement - Before
After
Figure 362 Example - Inserting A DO Statement - After
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ SYSOUT OP ( C, D, F, N, R) FROM
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ MAXRERUN 3 RERUNMEM I NTERVAL FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
I _ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
__ ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
__ MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====





COMMANDS: EDI T, DOC, PLAN, JOBSTAT 16. 44. 31
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ SYSOUT OP ( C, D, F, N, R) FROM
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ MAXRERUN 3 RERUNMEM I NTERVAL FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO
__ DO RERUN
__ DO
__ ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
__ MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====




COMMANDS: EDI T, DOC, PLAN, JOBSTAT 14. 49. 42
Maintaining Valid Job Scheduling Definitions
Appendix C Editing Job Scheduling Definitions in the Edit Environment 941
Example 2
Before: Delete an ON PGMST block. Use of the DB (Delete Block) command is the
preferred method. The DB command removes all parameters, comments,
continuation lines, and separator lines of the specified block. DB must be specified on
a main line of the block, that is, ON PGMST. In this example, the ON PGMST block is
deleted.
Figure 363 Example - Deleting A Block - Before
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ ==========================================================================
__ OUT
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO
DB ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
__ ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
__ MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====



COMMANDS: EDI T, DOC, PLAN, JOBSTAT 14. 52. 02
Maintaining Valid Job Scheduling Definitions
942 CONTROL-M for OS/390 and z/OS User Guide
After: The ON PGMST ANYSTEP block has been deleted.
Figure 364 Example - Deleting A Block - After
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ ==========================================================================
__ OUT
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
__ MS
======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULI NG PARAMETERS <<<<<<<<<<<<<<<< =====








COMMANDS: EDI T, DOC, PLAN, JOBSTAT 14. 53. 58
Maintaining Valid Job Scheduling Definitions
Appendix C Editing Job Scheduling Definitions in the Edit Environment 943
Example 3
Before: Move multiple DO statements from one sub-block to another. Command MM
(Multiple Move) is specified at the beginning and end of the DO statements that are
moved. Command A (After) specifies the location after which these lines are placed.
Figure 365 Example - Moving Statements - Before
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ OUT
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
MM DO COND STEP5_DONE ODAT +
__ DO SHOUT TO TSO- M22 URGENCY R
MM = STEP STEP05 PROCESSED
__ DO
__ ON PGMST STEP05 PROCST CODES S* * * A/ O
A_ DO I FRERUN FROM $ABEND . TO . CONFI RM N
__ DO
__ ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 03. 25
Maintaining Valid Job Scheduling Definitions
944 CONTROL-M for OS/390 and z/OS User Guide
After: The two specified DO statements have been moved to the specified location.
Figure 366 Example - Moving Statements - After
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ OUT
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
__ ON PGMST STEP05 PROCST CODES S* * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM N
__ DO COND STEP5_DONE ODAT +
__ DO SHOUT TO TSO- M22 URGENCY R
__ = STEP STEP05 PROCESSED
__ DO
__ ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 5. 06. 09
Maintaining Valid Job Scheduling Definitions
Appendix C Editing Job Scheduling Definitions in the Edit Environment 945
Example 4
Before: Copy ON PGMST and some of its DO statements to another ON PGMST
block. Command CC (Multiple Copy) is specified at the beginning and the end of the
parameters that is copied. Command B (Before) specifies the location before which
these lines are placed.
Figure 367 Example - Copying Statements - Before
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
CC ON PGMST STEP05 PROCST CODES S* * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM N
CC DO COND STEP5_DONE ODAT +
__ DO SHOUT TO TSO- M22 URGENCY R
__ = STEP STEP05 PROCESSED
__ DO
B ON PGMST PROCST CODES A/ O
__ DO
__ SHOUT WHEN TO URGN
__ MS
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 14. 32. 29
Maintaining Valid Job Scheduling Definitions
946 CONTROL-M for OS/390 and z/OS User Guide
After: The specified ON PGMST and DO statements have been copied.
Figure 368 Example - Copying Statements - After
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 * * * * * A/ O
__ CODES
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
__ ON PGMST STEP05 PROCST CODES S* * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM N
__ DO COND STEP5_DONE ODAT +
__ DO SHOUT TO TSO- M22 URGENCY R
__ = STEP STEP05 PROCESSED
__ DO
__ ON PGMST STEP05 PROCST CODES S* * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM N
__ DO COND STEP5_DONE ODAT +
__ DO
__ ON PGMST PROCST CODES A/ O
__ DO
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 19. 53
Maintaining Valid Job Scheduling Definitions
Appendix C Editing Job Scheduling Definitions in the Edit Environment 947
Example 5
Before: Insert a continuation line between existing continuation lines. It is
recommended that command RS (Repeat Single) or R (Repeat) be used to repeat the
previous line.
Figure 369 Example - Inserting A Line - Before
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ TI ME ZONE:
__ ===========================================================================
__ OUT
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 C3000 A/ O A
RS CODES C4000 C5000 C6000 C7000
__ CODES C1200
__ ON PGMST STEP04 PROCST CODES * * * * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
__ ON PGMST STEP05 PROCST CODES S* * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM N
__ DO COND STEP5_DONE ODAT +
__ DO SHOUT TO TSO- M22 URGENCY R
__ = STEP STEP05 PROCESSED
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 22. 46
Maintaining Valid Job Scheduling Definitions
948 CONTROL-M for OS/390 and z/OS User Guide
After: The continuation line has been repeated. The repeated line can be modified as
necessary.
Figure 370 Example - Inserting A Line - After
JOB: PRDKPL01 LI B CTM. PROD. SCHEDULE TABLE: PRODKPL
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ TI ME ZONE:
__ ==========================================================================
__ OUT
__ AUTO- ARCHI VE Y SYSDB Y MAXDAYS MAXRUNS
__ RETENTI ON: # OF DAYS TO KEEP 030 # OF GENERATI ONS TO KEEP
__ SYSOUT OP ( C, D, F, N, R) FROM
__ MAXRERUN 3 RERUNMEM I NTERVAL. FROM
__ STEP RANGE FR ( PGM. PROC) . TO .
__ ON PGMST ANYSTEP PROCST CODES S* * * U* * * * C2000 C3000 A/ O A
__ CODES C4000 C5000 C6000 C7000
__ CODES C4000 C5000 C6000 C7000
__ CODES C1200
__ ON PGMST STEP04 PROCST CODES * * * * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM Y
__ DO RERUN
__ DO
__ ON PGMST STEP05 PROCST CODES S* * * A/ O
__ DO I FRERUN FROM $ABEND . TO . CONFI RM N
__ DO COND STEP5_DONE ODAT +
__ DO SHOUT TO TSO- M22 URGENCY R
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 15. 23. 46
Appendix D Editing CMEM Rule Definitions in the Edit Environment 949
Appendi x
D
D Editing CMEM Rule Definitions in the
Edit Environment
CMEM rule definition parameters can be edited (moved, copied, deleted, repeated)
by performing IOA Line Editing commands, similar to standard ISPF line commands,
from within the IOA Edit environment.
The Edit environment in a Rule Definition screen is accessed by typing EDIT in the
COMMAND field and pressing Enter.
Figure 371 The Edit Environment in The Rule Definition Screen
A 2-character Line Editing command field, marked by underscores, is displayed for
each line on the Rule Definition screen.
Editing commands are typed directly onto these underscores.
RL: JOBNAM1 LI B CTM. PROD. RULES TABLE: CMEMRULE
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ ON JOBARRI V = JOBNAM1 JTYPE SMFI D SYSTEM And/ Or / Not
__ OWNER CTMCTLM GROUP MODE PROD RUNTSEC NONE
__ DESCRI PTI ON CONVERSI ON: ON JOB JOBNAM1 ARRI VAL FORCEJOB
__ DESCRI PTI ON
__ ==========================================================================
__ DO FORCEJOB = TABLE TABLE1 JOB DATE ODAT
__ LI BRARY CTM. PROD. SCHEDULE
__ DO
__ ==========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====










FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 20. 10. 46
Line Editing Commands
950 CONTROL-M for OS/390 and z/OS User Guide
Incorrectly specified Line Editing commands can be corrected by typing over them
correctly. Line Editing commands can be deleted by blanking them out or by
specifying the RESET command in the COMMAND field.
The Line Editing commands you enter are processed when Enter is pressed.
The CMEM facility performs Automatic Syntax Checking to ensure that the rule
definition is still syntactically correct after editing. If an edit may invalidate the rule
definition, a message is displayed at the top of the screen and the edit is not
performed. For guidelines and recommendations for editing rule definitions, see
Maintaining Valid Rule Definitions on page 953.
All operations available in the Rule Definition screen can be performed while in the
Edit environment. For example, parameter values can be changed, and the Rule
Definition screen can be saved and exited.
To exit the Edit environment, re-type EDIT in the COMMAND field and press Enter.
Line Editing command fields are removed from the display.
Line Editing commands can be performed on any single ON or DO statement or on a
block of ON or DO statements.
All lines of a single statement, for example, the two lines of a DO FORCEJOB
statement, constitute a logical line.
Line Editing Commands
The following types of line editing commands exist in the Edit environment.
Table 306 Line Editing Commands - Delete Commands
Command Description
DS Delete a single line.
DL Delete a logical line.
DD Delete lines between two DD specifications.
D Delete a line. CONTROL-M determines whether to delete a single
or logical line based on the line type.
Table 307 Line Editing Commands - Copy Commands (Part 1 of 2)
Command Description
CS Copy a single line.
CL Copy a logical line.
Line Editing Commands
Appendix D Editing CMEM Rule Definitions in the Edit Environment 951
CC Copy lines between two CC specifications.
C Copy a line. CONTROL-M determines whether to copy a single or
logical line based on the line type.
Copy commands are used in conjunction with Location commands. The lines and
blocks are placed at the position indicated by Location command A or B (described
below).
Table 308 Line Editing Commands - Move Commands
Command Description
MS Move a single line.
ML Move a logical line.
MM Move lines between two MM specifications.
M Moves a line. CONTROL-M determines whether to move a single
or logical line based on line type.
Move commands are used in conjunction with Location commands. The lines and
blocks are placed at the position indicated by Location command A or B, described
in Table 311 on page 952.
Table 309 Line Editing Commands - Repeat Commands
Command Description
RS Repeat a single line.
RL Repeat a logical line.
RR Repeat lines between two RR specifications.
R Repeat a line. CONTROL-M determines whether to repeat a single
or logical line based on line type.
The repeated lines and blocks are placed immediately after the lines and blocks
marked with the command.
Table 310 Line Editing Commands - Insert Command
Command Description
I Inserts a new logical line or block after the logical line or block
marked with an I.
Table 307 Line Editing Commands - Copy Commands (Part 2 of 2)
Command Description
Line Editing Commands
952 CONTROL-M for OS/390 and z/OS User Guide
Table 311 Line Editing Commands - Location Commands
Command Description
Indication of the position where lines or blocks must be placed.
A (After) Indicates that lines or blocks must be placed after the line marked
with an A.
B (Before) Indicates that lines or blocks must be placed before the line
marked with a B.
Location commands A and B are used in conjunction with Copy (C, CS, CL, CC),
and Move (M, MS, ML, MM) commands.
Maintaining Valid Rule Definitions
Appendix D Editing CMEM Rule Definitions in the Edit Environment 953
Maintaining Valid Rule Definitions
Since rule definitions must be syntactically correct at all times, you must consider the
following issues when specifying Line Editing commands:
s The result of a Line Editing command is dependent on the line on which the
command is specified. For example, command D deletes either a single or a logical
line based on the line type.
s Logical lines function as a unit and cannot be separated.
When a logical command is specified within a logical line, that is, on a
subparameter line, or a continuation line, the specified operation is performed on
the entire logical line.
s Blank parameter lines added automatically by CMEM, to allow the user to specify
additional parameters, cannot be deleted.
It is recommended that, wherever possible, commands D, C, R, and M be used for
editing, instead of DS, DL, CS, CL, RS, RL, MS, and ML, because these commands
automatically retain the logical structure of the rule definition.
Example
Before: Repeat a DO block in the Rule Definition screen.
Figure 372 Example - Repeating A DO Block - Before
RL: JOBNAM1 LI B CTM. PROD. RULES TABLE: CMEMRULE
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ ON JOBARRI V = JOBNAM1 JTYPE SMFI D SYSTEM And/ Or / Not
__ OWNER CTMCTLM GROUP MODE PROD RUNTSEC NONE
__ DESCRI PTI ON CONVERSI ON: ON JOB JOBNAM1 ARRI VAL FORCEJOB
__ DESCRI PTI ON
__ ==========================================================================
R_ DO FORCEJOB = TABLE TABLE1 JOB DATE ODAT
__ LI BRARY CTM. PROD. SCHEDULE
__ DO
__ ==========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====










FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 20. 10. 46
Maintaining Valid Rule Definitions
954 CONTROL-M for OS/390 and z/OS User Guide
After: The DO block has been repeated.
Figure 373 Example - Repeating A DO Block - After
RL: JOBNAM1 LI B CTM. PROD. RULES TABLE: CMEMRULE
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
__ ON JOBARRI V = JOBNAM1 JTYPE SMFI D SYSTEM And/ Or / Not
__ OWNER CTMCTLM GROUP MODE PROD RUNTSEC NONE
__ DESCRI PTI ON CONVERSI ON: ON JOB JOBNAM1 ARRI VAL FORCEJOB
__ DESCRI PTI ON
__ ==========================================================================
__ DO FORCEJOB = TABLE TABLE1 JOB DATE ODAT
__ LI BRARY CTM. PROD. SCHEDULE
__ DO FORCEJOB = TABLE TABLE1 JOB DATE ODAT
__ LI BRARY CTM. PROD. SCHEDULE
__ DO
__ ==========================================================================
======= >>>>>>>>>>>>>>> END OF RULE DEFI NI TI ON PARAMETERS <<<<<<<<<<<<<<< =====








FI LL I N RULE DEFI NI TI ON. CMDS: CAPS, EDI T, SHPF, 20. 32. 47
Appendix E AutoEdit Facility in KSL 955
Appendi x
E
E AutoEdit Facility in KSL
The AutoEdit facility provides additional data manipulation capabilities. It is
composed of the following types of AutoEdit symbols and instructions:
s system variables
s user-defined variables
s operators
s functions
These components can be used in certain KSL commands, as described in Chapter 8,
KeyStroke Language (KSL), and are resolved according to the AutoEdit rules
described in this appendix.
NOTE
KSL and CONTROL-M use different AutoEdit processors. Therefore, if a KSL script
containing KSL AutoEdit terms is submitted under CONTROL-M, the CONTROL-M
AutoEdit %%RANGE statement must be used in the JCL to ensure that the
CONTROL-M AutoEdit processor skips, that is, that it does not process, the KSL
script.
System Variables
956 CONTROL-M for OS/390 and z/OS User Guide
System Variables
System variables are predefined, commonly used variables whose values are
automatically updated and maintained by the AutoEdit facility.
The System variable format is:
where var represents the name of the System variable.
Each AutoEdit variable begins with %%. Each variable resolves to (is replaced by)
the corresponding system value. AutoEdit System variables are described on the
following pages.
Example
resolves on the 12th of December 2001 to
AutoEdit System Variables:
%%$var
TYPE ' %%$DATE'
TYPE ' 011010'
NOTE
In the following table, the

symbol following an AutoEdit System variable indicates

that if the variable is specified without the $ in the prefix, the variable is still
supported.
Table 312 AutoEdit System Variables (Part 1 of 3)
Variable Description
%%.

Concatenation character
%%$BLANK

Resolves to one blank

%%$BLANKn

Resolves to n blanks, where n is a number between 1

and 99.
System Variables
Appendix E AutoEdit Facility in KSL 957
%%$D2X num Hexadecimal number resulting from the conversion of
the decimal number num. The largest number that can
be converted is 2147483647 (that is, 231 1).
For example: %%$D2X 4095 converts to FFF.
%%$DATE

Current system date (format yymmdd).

%%$DAY

Current system day (format dd).

%%$JULDAY

Current system day (Julian format jjj).

%%$LENGTH varname

Length of variable varname.

%%$MONTH

Current system month (format mm).

%%$MVSLEVEL MVS product version (eight characters) under which
IOA is running. Examples: SP3.1.1, SP4.2.2
%%$NULL

Indicates a null variable (a variable with length 0).

%%$PARSRC Return code from a %%$PARSE function. Indicated
whether the parsed string matched all string patterns in
the template. Possible values are:
s 0 The parsed string fully matched the string
patterns in the template.
s 4 At least one string pattern in the template was
not matched.
%%$RDATE

Current working date (format yymmdd).

%%$RDAY

Current working day (format dd).

%%$RJULDAY

Current working day of the year (Julian format jjj).

%%$RMONTH

Current working month (format mm).

%%$RWDAY

Current working day of the week. Format is d, where d

is 1 through 6 or 0 (for example, 1=Sunday, 2=Monday,
... 6=Friday, 0=Saturday).
Note: Start of the week depends on an IOA installation
parameter specifying whether 1=Sunday or 1=Monday.
For your site standard, see your INCONTROL
administrator.
%%$RYEAR

Current working year (format yy).

%%$SMFID

The SMF ID of the CPU running the KSL script.

%%$SSNAME

Name of the IOA subsystem.

%%$SUBSTR varname pos
len

Substring of variable varname starting at position pos
with length len.
%%$TIME

Time of day (format hhmmss).

Table 312 AutoEdit System Variables (Part 2 of 3)
Variable Description
System Variables
958 CONTROL-M for OS/390 and z/OS User Guide
User-Defined Variables
The user-defined variables capability is designed to provide additional flexibility.
You can define your own symbols using the KSL command SETOLOC and use them
in other KSL commands. They are automatically resolved when the KSL is executed.
A user-defined variable can be any alphanumeric string starting with %%. The
characters @# $ _ are also valid. Lowercase characters are resolved, but upon
resolution they remain lowercase and are not translated to uppercase characters.
When the AutoEdit facility identifies a string that starts with %%, the string is
assumed to be an AutoEdit variable or instruction. If the string is a reserved AutoEdit
symbol or a System variable, it is interpreted as such. Otherwise the string is assumed
to be a user-defined variable.
%%$UNDEF

Indicates an undefined variable. This variable can be

used:
s To test whether a variable is defined:
I F %%var i abl e EQ %%$UNDEF
s To delete a variable:
SETOLOC = %%var i abl e = %%$UNDEF
%%$WDAY

Current system day of the week. Format is d, where d is

1 through 6 or 0 (for example, 1=Sunday, 2=Monday, ...
6=Friday, 0=Saturday).
Note: Start of the week depends on an IOA installation
parameter specifying whether 1=Sunday or 1=Monday.
For your site standard, see your INCONTROL
administrator.
%%$Wn varname

The nth word (a comma or a blank can serve as a

delimiter) of variable varname. n can be a value from 1
through 99. For example, %%$W3 %%MESSAGE
represents the third word in the original user-defined
message text.
%%$WORDS varname

Number of words in variable varname. Delimiters are

commas and/ or blanks within the variable.
%%$X2D string Numeric decimal string resulting from the conversion
of the hexadecimal number string. The maximum
number that can be converted is 7FFFFFFF. Example:
%%$X2D FFF converts to 4095.
%%$YEAR

Current system year (format yy).

Table 312 AutoEdit System Variables (Part 3 of 3)
Variable Description
System Variables
Appendix E AutoEdit Facility in KSL 959
Rules of Variable Substitution
A KSL command can contain expressions including both KSL and AutoEdit variables.
Variable substitution is performed in the following order:
1. All KSL variables (variables preceded by a single % character) are substituted
sequentially from left to right.
Example
TYPE ' %A %%$PLUS 1'
Assuming that the value of %A is 1, variable substitution begins with the KSL
variable substituted as follows:
TYPE ' 1 %%$PLUS 1'
2. If the resulting expression contains AutoEdit symbols (in this example,
%%$PLUS), variables are substituted sequentially from right to left until the
symbol is assigned a value.
In the above example, TYPE 1 %%$PLUS 1 resolves to TYPE 2.
The largest number that can be handled by mathematical AutoEdit operations is
2
31
- 1, that is, 2147483647.
Examples
The following are additional examples of AutoEdit variable substitution.
Example 1
resolves on the third of the month to:
The AutoEdit facility then tries to resolve the symbol %%SMF_TAPE_03. Assuming
the value of the symbol in the Global environment is EE1022, the result is:
EE1022
To concatenate two symbols, separate them with a period. Before AutoEdit variables
are concatenated, trailing blanks are eliminated.
%%SMF_TAPE_%%DAY,
%%SMF_TAPE_03,
System Variables
960 CONTROL-M for OS/390 and z/OS User Guide
Example 2
resolves on the 4th of December to:
0412
In order to put a period between two symbols, use two consecutive periods.
Example 3
resolves on the 4th of December to:
04.12
To concatenate a symbol and a constant, use %%. (concatenation symbol).
Example 4
resolves on the 4th of December to:
A9104UP
%%DAY. %%MONTH
NOTE
Specification of %%DAY%%MONTH would result in an attempt to resolve
%%DAY12 (a user-defined variable).
%%DAY. . %%MONTH
A91%%DAY%%. UP
NOTE
Specification of A91%%DAYUP would result in an attempt to resolve %%DAYUP (a
user-defined variable).
System Variables
Appendix E AutoEdit Facility in KSL 961
AutoEdit Operators
AutoEdit operators can be used in conjunction with AutoEdit symbols. Valid
AutoEdit operators are:
The format for use of AutoEdit symbols and operators is:
Only one operator can be used in an expression.
Operands must resolve into positive numeric constants. The final result is translated
into a character string. For example:
User-defined variable %%x is incremented by one.
%%$CALCDATE Function
The %%$CALCDATE function performs date calculations based on a specified date.
Format:
where:
s date is the date in yymmdd format.
s quantity is the number (or numeric AutoEdit expression) of days to add to or
subtract from the date (from 1 to 366).
Table 313 AutoEdit Operators
Operator Description
%%$PLUS Add two operands.
%%$MINUS Subtract the second operand from the first operand.
%%$TIMES Multiply one operand by another operand.
%%$DIV Divide the first operand by the second operand.
oper and oper at or oper and
SETOLOC %%x = %%x %%$PLUS 1
%%$CALCDATE dat e quant i t y
System Variables
962 CONTROL-M for OS/390 and z/OS User Guide
Example
On February 1, 2000:
%%$SUBSTR Function
The %%$SUBSTR function extracts a substring from the input string, and returns the
attached substring. Format:
where:
s strng is the input string from which the substring is extracted.
s startpos is the first character of the input string to extract.
s len is the number of characters to extract.
startpos and len must be numbers (or numeric AutoEdit expressions) and greater than
zero.
If (startpos + len 1) is greater than the strng length, the function is not executed and
the value returned is null.
Example
NOTE
%%$CALCDATE operates on Gregorian dates only; Julian dates, such as
%%JULDAY, cannot be specified.
SETOLOC %%A = %%$CALCDATE %%$RDATE - 1
SETOLOC %%A = 000131
%%$SUBSTR st r ng st ar t pos l en
SETOLOC %%A = %%$CALCDATE %%$RDATE - 1
SETOLOC %%AMON = %%$SUBSTR %%A 3 2
System Variables
Appendix E AutoEdit Facility in KSL 963
On December 1, 2000:
%%$TIMEINT Function
The %%$TIMEINT function calculates the time interval between two given times,
specified in any order.
Format:
time1 and time2 are constants or variables in yydddhhmmss format.
where:
s yy is a 2-digit year
s ddd is a Julian day
s hh is the number of hours
s mm is the number of minutes
s ss is the number of seconds
The resulting time interval is in format:
s ddddd is the number of days
s hh is the number of hours
s mm is the number of minutes
s ss is the number of seconds
Example
The result is: 00001010000.
SETOLOC %%A = 001130
SETOLOC %%AMON = 11
%%$TI MEI NT t i me1 t i me2
SETOLOC %%A = %%$TI MEI NT 01120070000 01119060000
System Variables
964 CONTROL-M for OS/390 and z/OS User Guide
%%$PARSE Function
The %%$PARSE function is a powerful tool that offers extensive string manipulation
capabilities in the AutoEdit environment. This function, which is similar to the REXX
PARSE command in the TSO/ E environment, can be used to analyze and extract
information from various AutoEdit strings.
The %%$PARSE function parses a specified string, that is, the %%$PARSE function
splits the specified string into substrings, according to a specified template. A
template consists of variables and patterns that determine the parsing process.
Format:
where:
s strng is the AutoEdit variable that contains the string to be parsed.
s template is the AutoEdit variable or constant that contains the template.
Example
The %%$PARSE function assigns substrings of the specified string to the specified
variables according to the specified template.
The SETOLOC statements in the above example provide the same result as the
following statements:
The parsing process involves the following stages:
1. The string is broken into substrings, from left to right, using the patterns in the
template.
2. Each substring is parsed into words, from left to right, using the variable names in
the template.
SETOLOC %%$PARSE st r ng t empl at e
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 A3 A4 A5
SETOLOC %%$PARSE %%S %%T
SETOLOC %%A1 = THI S
SETOLOC %%A2 = I S
SETOLOC %%A3 = A
SETOLOC %%A4 = SAMPLE
SETOLOC %%A5 = STRI NG
System Variables
Appendix E AutoEdit Facility in KSL 965
Template elements are:
s string patterns
s position patterns
s variables
s place holders (dummy variables)
The rules of parsing are detailed below.
Parsing Words
Scanning is performed from left to right and words in the string, leading and trailing
blanks excluded, are matched one by one with the variables named in the template.
The last variable named in the template contains the remaining part of the string,
including leading and trailing blanks.
Up to 30 variable names can be specified in a parsing template.
The following situations may be encountered:
s The number of words in the string matches the number of variables in the
template: Each of those variables contains one word of the string. The last variable
contains the last word in the string including leading and/ or trailing blanks.
s The number of words in the string is smaller than the number of variables named
in the template: The first variables each contain one word of the string and the
extra variables receive a value of NULL (a string of 0 character length).
s The number of words in the string is greater than the number of variables in the
template. With the exception of the last, all variables contain one word of the
string. The last variable named in the template contains the remaining part of the
string, including leading and trailing blanks.
Example
The statements below, which include a %%$PARSE function:
have the same result as the following statements:
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 A3
SETOLOC %%$PARSE %%S %%T
SETOLOC %%A1 = THI S
SETOLOC %%A2 = I S
SETOLOC %%A3 = A SAMPLE STRI NG
System Variables
966 CONTROL-M for OS/390 and z/OS User Guide
Using Dummy Variables (Place Holders)
A single period can be used as a dummy variable in the template. This is useful when
the corresponding word in the string does not need to be stored in a named variable.
Example
The following statements, which include a %%$PARSE function:
have the same result as the following statement:
Using Patterns in Parsing
Patterns can be included in the template. Their purpose is to divide the string into
substrings prior to the process of parsing into words. Parsing is then performed, as
previously described, on the substrings and not on the original string.
The following types of patterns are available:
s string pattern, a character string delimited by quotes, to distinguish it from a
variable name
s number, signed or unsigned
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = . . . A4.
SETOLOC %%$PARSE %%S %%T
SETOLOC %%A4 = SAMPLE
System Variables
Appendix E AutoEdit Facility in KSL 967
Using String Patterns
The string is scanned from left to right for a substring that matches the string pattern.
The following situations may occur:
1. A match is found, that is, a substring within the string is identical to the given
string pattern:
The original string is divided into two substrings. The first substring, up to, but not
including, the string pattern, is parsed into words using the variables named
before the string pattern on the template. Parsing continues from the character
following the matched string.
Example
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 ' SAMPLE' A3 A4 A5
SETOLOC %%$PARSE %%S %%T
A match is found since the string SAMPLE is part of the original string.
System variable %%$PARSRC can be used to check if all strings specified in the
template were matched during the parsing process, which was described in
Parsing Words on page 965.
The original string is divided into two substrings while the matched part of the
string is excluded. Parsing of the first substring uses the variables listed before the
match on the template while parsing of the second substring uses the variables
listed after the match:
First substring: THIS IS A
As a result of parsing:
A1=THI S
A2=I S A
Second substring: STRING
As a result of parsing:
A3=STRI NG
A4=NULL
A5=NULL
System Variables
968 CONTROL-M for OS/390 and z/OS User Guide
2. A match is not found, there is no substring identical to the given string pattern
within the string:
It is assumed that a match is found at the end of the string. The first substring
consists of the entire string and it is parsed using only the variables named before
the string pattern on the template. Parsing continues from the character following
the matched string, the end of the string, in this case.
Example
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 A3 ' EASY' A4 A5
SETOLOC %%$PARSE %%S %%T
A match is not found since the string EASY does not exist in the original string.
First substring: THIS IS A SAMPLE STRING
As a result of parsing:
A1=THI S
A2=I S
A3=A SAMPLE STRI NG
Second substring: NULL
As a result of parsing:
A4=NULL
A5=NULL
Using Numeric Patterns Within the Template
Numeric patterns are numbers that mark positions within the string. They are used to
break the original string into substrings at the position indicated by the number.
The position specified can be absolute or relative:
s An absolute position is specified by an unsigned number.
s A relative position is specified by a signed number (positive or negative). It
determines a new position within the string, relative to the last position.
Last position refers to one of the following:
s The start of the string (position 1) if last position was not specified previously.
s The starting position of a string pattern if a match was found.
System Variables
Appendix E AutoEdit Facility in KSL 969
s The end of the string if the string pattern was not matched.
s The last position specified by a numeric pattern.
If the specified position exceeds the length of the string, the numeric pattern is
adjusted to the end of the string. Similarly, if the specified position precedes the
beginning of the string (negative or zero numeric pattern), the beginning of the string
is used as the last position.
Example 1
A parsing template with an absolute numeric pattern:
First substring: THIS IS A (up to, not including, position 11)
As a result of parsing:
A1=THI S
A2=I S A
Second substring: SAMPLE STRING (from position 11, to the end of the string).
As a result of parsing:
A3=SAMPLE
A4=STRI NG
A5=NULL (0 length string)
Example 2
A parsing template with a relative numeric pattern:
Last position is the beginning of the string (position 1).
Position marked within the string is 1 + 10 = 11.
First substring: THIS IS A (up to, not including, position 11)
SETOLOC %%S =THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 11 A3 A4 A5
SETOLOC %%$PARSE %%S %%T
SETOLOC %%S =THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 +10 A3 A4 A5
SETOLOC %%$PARSE %%S %%T
System Variables
970 CONTROL-M for OS/390 and z/OS User Guide
As a result of parsing:
A1=THI S
A2=I S A
Second substring: SAMPLE STRING (from position 11, to the end of the string).
As a result of parsing:
A3=SAMPLE
A4=STRI NG
A5=NULL (0 length string)
Using More Than One Pattern and Combining Pattern Types
in the Template
Both types of patterns (string and numeric) can be intermixed in the same template.
Up to 30 patterns and up to 30 variable names can be specified.
Scanning of the string proceeds from the beginning of the string until the first pattern
(if any).
1. String pattern a match was found:
The substring that precedes the match with the pattern is parsed using the
variables named in the template before the pattern, with the last variable receiving
the end of the substring, including leading or trailing blanks.
2. String pattern a match was not found:
Since no match was found within the string, it is assumed that a match is found at
the end of the string. The whole string is parsed using only the variables named in
the template before the pattern.
3. Numeric pattern (absolute).
The absolute numeric pattern points to a position within the string. The beginning
of the string is position 1.
The string is divided into two substrings.
The first substring extends from the beginning of the string and up to, but not
including, the position that corresponds to the numeric pattern. This substring is
parsed using the variables named in the template before the pattern.
System Variables
Appendix E AutoEdit Facility in KSL 971
If the absolute numeric pattern specifies a position beyond the length of the string,
it is readjusted to the first position beyond the length of the string and the entire
string is parsed using the variables named in the template before the pattern.
4. Relative numeric pattern:
The relative numeric pattern (a signed number) specifies a position within the
string, relative to the last position.
5. Last position:
If the relative numeric pattern is the first pattern within the template, the last
position is the beginning of the string.
If the relative numeric pattern is not the first pattern within the template and the
previous pattern was numeric, the last position is that specified by the previous
numeric pattern.
If the relative numeric pattern is not the first pattern within the template and the
previous pattern was a string, the last position is that of the starting character of
the match (if there was a match) or the position following the end of the string (if
there was no match).
As a result of what was just explained
s If a pattern was not matched until the end of the string and the following pattern is
a string pattern, this new string pattern is ignored since the starting point for the
new scan is the end of the string.
s If a pattern was not matched until the end of the string and the following pattern is
a numeric pattern, then the scan and subsequent parsing resume from the new
position indicated by that numeric pattern.
Example 1
A parsing template with two absolute numeric patterns, with the second position
preceding the first:
The following statements:
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 A2 11 A3 6 A4
SETOLOC %%$PARSE %%S %%T
System Variables
972 CONTROL-M for OS/390 and z/OS User Guide
have the same result as the following DO SET statements:
First substring: THIS IS A (up to, not including, position 11)
As a result of parsing:
A1=THI S
A2=I S A
Second substring: SAMPLE STRING from position 11 and up to the end of the string.
Because the next pattern, position 6, precedes the previous position, it cannot limit
this second substring.
As a result of parsing:
A3=SAMPLE STRI NG
Third substring: IS A SAMPLE STRING (from position 6 to the end of the string)
As a result of parsing:
A4=I S A SAMPLE STRI NG
Example 2
A parsing template with one absolute and one relative numeric pattern:
First substring: THIS (beginning of the string up to, not including, position 6).
As a result of parsing:
A1=THI S
Second substring: IS (from position 6 up to, not including, position 6+3=9)
As a result of parsing:
A2=I S
SETOLOC %%A1 = THI S
SETOLOC %%A2 = I S A
SETOLOC %%A3 = SAMPLE STRI NG
SETOLOC %%A4 = I S A SAMPLE STRI NG
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 6 A2 +3 A3
SETOLOC %%$PARSE %%S %%T
System Variables
Appendix E AutoEdit Facility in KSL 973
Third substring: A SAMPLE STRING (from position 9 to the end of the string)
As a result of parsing:
A3=A SAMPLE STRI NG
Example 3
A parsing template with two relative numeric patterns:
The following statements:
have the same result as the following statements:
The first numeric pattern specifies a position at column 40. This is beyond the end of
the string so position is reset to column 24 (end of string + 1). As a result, the entire
string is parsed to words using variables A1 and A2.
The second numeric pattern specifies a position at column 11 (end of the string + 1
minus 13) that precedes the position (40 readjusted to 24) previously specified.
Therefore, the data from the last position, to the end of the string is parsed to words
using variable A3 (A3 is set to NULL).
The data (from column 12 to the end of the string) is parsed to words using variables
A4 and A5.
Example 4
Combining string pattern and numeric pattern:
The following statements:
SETOLOC %%T = A1 A2 +40 A3 - 13 A4 A5
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%$PARSE %%S %%T
SETOLOC %%A1 = THI S
SETOLOC %%A2 = I S A SAMPLE STRI NG
SETOLOC %%A3 = %%NULL
SETOLOC %%A4 = SAMPLE
SETOLOC %%A5 = STRI NG
SETOLOC %%S = THI S I S A SAMPLE STRI NG
SETOLOC %%T = A1 ` A' A2 +3 A3
SETOLOC %%$PARSE %%S %%T
System Variables
974 CONTROL-M for OS/390 and z/OS User Guide
have the same result as the following statements:
The pattern specifies a string (A) that is matched at column 9. The data before column
9 is parsed to words using variable A1. The numeric pattern (+3) specifies a position
at column 12 by using relative position. The data from column 9 to column 12 is
parsed to words using variable A2. The remaining data (from column 12 to the end of
the string) is parsed to words using variable A3.
SETOLOC %%A1 = THI S I S
SETOLOC %%A2 = A S
SETOLOC %%A3 = AMPLE STRI NG
Appendix F MVS Job Restart Without CONTROL-M/Restart 975
Appendi x
F
F MVS Job Restart Without
CONTROL-M/Restart
For sites in which CONTROL-M/ Restart is not installed, CONTROL-M provides a
mechanism for automatic implementation of MVS restarts in certain situations. The
mechanism, however, requires definition before the original submission of the job.
Therefore, it is only useful for jobs in which automatic restart is always desirable
(when necessary).
The mechanism for automatic implementation of MVS restart is the definition of a
special OUT condition in the job scheduling definition. The value of the condition is:
where:
s @# =condition
s ODAT =date
s =option
NOTE
MVS restart is not recommended and must be used with caution. MVS restart does
not perform automatic File catalog adjustment, GDG (Generation Dataset Group)
adjustment, condition code recapture, abend code recapture, or data set scratching.
Unless these functions are manually handled without error, the results of an MVS
restart may be unpredictable or damaging.
@#- ODAT -
NOTE
Restart Do not define this type of restart (that is, this OUT condition) if a
CONTROL-M/ Restart restart is used for the job, or the results may be unpredictable.
Restart
976 CONTROL-M for OS/390 and z/OS User Guide
This restart is implemented in the following situations if the CONTROL-M monitor
ended the job NOT OK (that is, a DO OK did not impact the final status):
s The job abended.
s The job failed due to JCL error.
s One of the steps ended with a condition code of C2000 (abend of a PL/ 1 program).
When the special OUT condition is defined in the job scheduling definition and the
job ends as described above, the CONTROL-M monitor automatically appends the
name of the failing step to the OUT condition of the job order. The OUT condition in
the job order, that is, as seen in the Zoom screen, therefore appears as follows:
Before a job is submitted, the CONTROL-M monitor checks the job order for an OUT
condition beginning @#. When the monitor detects condition @#-procstep.pgmstep, it
automatically inserts an MVS step in the JCL of the job, so that the job begins from the
indicated procstep.pgmstep.
For the job to be restarted from procstep.pgmstep, the job must be rerun. This can be the
result of a rerun, manual or automatic, or the result of a cyclic job run.
The @# procstep.pgmstep value appearing in the Zoom screen can be deleted, in
which case restart is not performed, or changed to a different procstep.pgmstep, so that
restart begins from a different step.
Even if a special OUT condition (name or prefix @# ) is not defined in the job
scheduling definition, an MVS restart can be implemented by specifying OUT
condition @# procstep.pgmstep (for the desired restart step) in the Zoom screen.
When using MVS job restart, every step in the job must have a unique
procstep.pgmstep name. CONTROL-M does not check for duplicate stepnames.
Example
The following is an example of a job set for Automatic Restart, using CONTROL-M
only, in case of abend.
@#- pr ocst ep. pgmst ep
NOTE
It is also possible to specify OUT condition @# procstep.pgmstep in the job scheduling
definition, but this is not recommended. If @# procstep.pgmstep is specified in the job
scheduling definition, the job always begins at the specified step, never at the first
step, even on the initial run.
Appendix F MVS Job Restart Without CONTROL-M/Restart 977
Figure 374 Example - Automatic Restart - CONTROL-M Only
NOTE
Restart Do not use this type of restart when CONTROL-M/ Restart restart is used
for the job, or results may be unpredictable.
JOB: EBDUPDT2 LI B CTM. PROD. SCHEDULE TABLE: EBDPROD
COMMAND ===> SCROLL===> CRSR
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
MEMNAME EBDUPDT2 MEMLI B GENERAL
OWNER SYS1 TASKTYPE JOB PREVENT- NCT2 DFLT N
APPL EBD GROUP EBD- PRODUCTI ON
DESC EBD PRODUCTI ON UPDATE OF DEPOSI TS
OVERLI B
SCHENV SYSTEM I D NJE NODE
SET VAR
CTB STEP AT NAME TYPE
DOCMEM EBDUPDT2 DOCLI B CTM. PROD. DOC
===========================================================================
DAYS DCAL
AND/ OR
WDAYS 2, 3, 4, 5, 6 WCAL
MONTHS 1- Y 2- Y 3- Y 4- Y 5- Y 6- Y 7- Y 8- Y 9- Y 10- Y 11- Y 12- Y
DATES
CONFCAL SHI FT RETRO Y MAXWAI T 08 D- CAT
MI NI MUM PDS
DEFI NI TI ON ACTI VE FROM UNTI L
===========================================================================
I N DEPOSI TS PREV
CONTROL
RESOURCE
PI PE
TI ME: FROM UNTI L PRI ORI TY DUE OUT SAC CONFI RM
TI ME ZONE:
===========================================================================
OUT DEPOSI TS ODAT + @#- ODAT -
COMMANDS: EDI T, DOC, PLAN, JOBSTAT 11. 17. 00
978 CONTROL-M for OS/390 and z/OS User Guide
Index 979
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Index
- (Group Previous)
SAC Parameter 601
Character
ON Statement 537
Sign
DO COND Statement 438
- Sign
SHOUT Parameter 619
Sign
Change Resource Window 283
Job Dependency Network 236
OUT Parameter, OPT Subparameter 555
Quick Schedule Definition 368
Symbols
546, 619
! Character
CTMQSB Command 806
Hex Value 82
Character
Prerequisite Condition 554
# Character
Maybe Job Prefix 811
UserDefined Variable 743, 958
# OF DAYS TO KEEP
RETENTION Parameter 594, 596
# OF GENERATIONS TO KEEP
RETENTION Parameter 594, 596
#JNFRT Parameter, CTMPARM 217
#WSC Field, Global View Screen 200
$ Character
AutoEdit Operators 961
Hex Value 82
Job Graph 204
RESOURCE Parameter 590
UserDefined Variable 743, 958
$$$$ Date Reference
IN Parameter 498
OUT Parameter 555
$$ACTDOC Member
Customization 81
Customizing Active Environment Screen 167
$ABEND
DO IFRERUN Statement 447, 449
Restart Confirmation Window 227
$CLEANUP Value
Rerun/ Restart Window 227
$DEFAULT
Step Adjustment 226
$DEFAULT Member
Restart Window 226
$EXERR
DO IFRERUN Statement 447, 449
Restart Confirmation Window 227
$FIRST
DO IFRERUN Statement 447, 449
Restart Confirmation Window 227
$FIRST Value
Rerun/ Restart Window 227
$FIRST.$ABEND
DOIFRERUN 447
$FIRST.$CLEANUP
DO IFREFUN Statement 447
$LSYS Command
JES2 520
Machine ID Under JES2 470, 624, 700
% (Simulation) Option
Active Environment Screen 182
% Symbol
AutoEdit Variable 876
Job Graph 204
SHOUT Parameter 619
%%
Concatenation Symbol 758
%% Prefix
User Defined Variable 743
%% Symbol
AutoEdit Term 46, 733
AutoEdit Variable 876
Calendar Date 740
Concatenation 737, 758
%%$ARGS
CONTROL-O System Variable 695
%%$CALCDATE Function
KSL 961
%%$CALCDTE Function
Comparison with %%CALCDATE 771
Description 771
Example 791
%%$CENT
First Two Digits of the Year 740
%%$COMMSYS Reserved Variable
980 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DO SHOUT Statement 699
%%$DIV
AutoEdit Operator 961
%%$Dn
CMEM AutoEdit Variable 668, 687
%%$DSN
CMEM AutoEdit Variable 668
%%$DSNDISP
CMEM AutoEdit Variable 669
%%$GREG Function
Julian to Gregorian Conversion 772
%%$GRID
Non-Date AutoEdit System Variable 738
Resolution 738
%%$JNAME
CMEM AutoEdit Variable 669, 687
%%$JULIAN Function
Gregorian to Julian Conversion 772
%%$LEAP Function
Leap Year Analysis 773
%%$LENGTH Function
Length Extraction 779
%%$MEMNAME
System Variable 739
%%$MINUS
AutoEdit Operator 961
%%$OCENT
System Variable 740
%%$ORDERID
AutoEdit Simulation 326
%%$PARSE Function
Example 965, 969, 971
KSL 964
%%$PARSRC
System Variable 967
%%$PLUS
AutoEdit Operator 961
%%$QNAME
Monitor Identifier 739
%%$RCENT
System Variable 740
%%$RJULDAY
Julian Working Day 741
%%$SABEND
CMEM AutoEdit Variable 669
%%$SCHDLIB
System Variable 739
%%$SCHDTAB
System Variable 739
%%$SIGN
Quantitative Resource 739
%%$STEPCC
CMEM AutoEdit Variable 669
%%$SUBSTR Function
KSL 962
%%$TAG
AutoEdit Simulation 326
Schedule Tag Name 739
%%$TIMEINT Function
KSL 963
%%$TIMES
AutoEdit Operator 961
%%$UABEND
CMEM AutoEdit Variable 669
%%$var
System Variable 956
%%$WCALC Function
Working Date Shift 773
%%$WEEK# Function
Week of Year 774
%%$WEEKDAY Function
Day of Week Analysis 775
%%$YEARWK# Function
Week of Year 776
%%A.%%B 755
%%APPL
Application 737
%%BLANK
Blank 737
Compared with %%BLANKn 738
%%BLANKn
Compared with %%BLANK 738
DO SET Statement 462
n Blanks 738
SET VAR Parameter 612
%%CALCDATE
Comparison with %%$CALCDTE 777
%%CALCDATE Function
AutoEdit Function 735
Description 777
%%DATE
Example 787
System Date 740, 741
%%DAY
System Day 740
%%ELSE Control Statement
Example 800
JCL Setup 761
%%ENDIF Control Statement
Example 800
JCL Setup 761
%%GLOBAL
AutoEdit Statement 328, 735
JCL Setup 754, 760
Member Format 747
%%GLOBAL Control Statement
Local Variable 746
%%GLOBAL Members
Cache 746
%%GOTO Control Statement
Example 800
JCL Setup 761
%%GROUP
Job Group 738
Index 981
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
%%IF Control Statement
Example 800
JCL Setup 761
Nesting 763
%%INCLIB Control Statement
Example 799
JCL Setup 764
%%INCMEM Control Statement
Example 799
JCL Setup 764
%%JOBCC
Final Job Status 742
Force OK 742
%%JOBID
JES Job Number 743
%%JOBNAM Variable
SHOUT Statement 362, 370
%%JOBNAME
AutoEdit Symbol 483
%%JOBNAME Variable
SHOUT Statement 362
Submitted Job Name 738
%%JULDAY
Julian Day 741
%%LABEL Control Statement
Example 800
JCL Setup 761
%%LIBSYM Control Statement 819
AutoEdit Statement 735
JCL Setup 754, 765
Local Variable 746
PROMPT Library 821
%%MAXRC
Force OK 742
Highest Return Code 742
%%MEMNAME
AutoEdit Symbol 483
%%MEMSYM
Member Format 747
%%MEMSYM Control Statement 819
AutoEdit Statement 735
JCL Setup 754, 765
Local Variable 746
Table Name Prefix 821
%%MINUS Operator
AutoEdit 770
%%MM.%%DD.%%YY
Example 791
%%MONTH
Month of the Job 740
System Month 740
%%O
ODATE 740
%%ODATE
Date of the Job 740, 741
Example 787
%%ODAY
Day of the Job 740
Example 788
%%ODAY.%%A.%%OYEAR
Example 790
%%OJULDAY
Julian Day of the Job 741
%%OMONTH
Example 788
%%ORDERID
Job Order ID 738
%%OWDAY
Day of the Week of the Job 740
Example 793
%%OWDAY.%%TIME
Example 796
%%OWEEK
Week of the Job 740
%%OWNER
Job Owner 738
%%OYEAR
Example 788
Year of the Job 740, 741
%%PLANID
Interplan Dependency 828
%%PLUS Operator
AutoEdit 735, 770
%%R
Installation Working Date 740
%%RANGE Control Statement
Example 796
JCL Setup 766
KSL Script 865
Minimum Length 766
%%RDATE
Example 787
Working Date 740, 741
%%RDAY
Working Day 741
%%RESOLVE
ALLCACHE 747
%%RESOLVE Control Statement
Example 798
JCL Setup 754, 767
%%RESOLVE NO Control Statement
AutoEdit Logic 767
JCL Setup 769
%%RESOLVE YES Control Statement
Example 798
%%RJULDAY
Julian Working Day 741
%%RMONTH
Working Month 741
%%RN
Run Number 738
%%RWDAY
Working Day of the Week 741
%%RWEEK
982 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Working Week 741
%%RYEAR
Working Year 741
%%SET %%variable
AutoEdit Control Statement 735
%%SET Control Statement
Global Variable 748
JCL Setup 753, 754, 769
Local Variable 745
OCCUR NO 830
UserDefined Variable 743
Variable Members 754
%%SIGN
System Variable 590
%%STEP
Latest Program Step 742
%%SUBSTR Function
Example 791
KSL 962
String Extraction 778
%%TIME
Example 796, 800
Time of Day 738
%%WDAY
Day of the Week 740
%%WEEK
Week of the Year 740
%%YEAR
System Year 740, 741
%A1%A9
KSL Variable 865, 877
%CALLRC
KSL Variable 877
%CRLINE
KSL Variable 878
%FINDRC
KSL Variable 877
%MSG
KSL Variable 877
%RC
KSL Variable 865, 877
%SCRCOL
KSL Variable 878
' Character
FIND Command 98
( Character
Hex Value 82
() Characters
DO COND 437
IN Parameter 502
Prerequisite Condition 554
* Character
CONFCAL Calendar 421, 655
D-CAT Parameter 416
DO SYSOUT Statement 478
JCL 755
Job Graph 204
Masking 83
MEMNAME Value 692
ON PGMST Statement 631
ON Statement 539
ON Statement Codes 543
PRIORITY Parameter 580
Quick Schedule Definition 368
SHOUT Parameter 619
SYSOUT Parameter 633, 635
* in DCAL Parameter
CONFCAL Calendar 421
* in WCAL Parameter
CONFCAL Calendar 655
* Symbol
SCHEDULE TAG Parameter 498
*$EJ Code
ON Statement Codes 542
**** Date Reference
IN Parameter 498
OUT Parameter 555
Schedule Date 437
***** Code
+EVERY Step 541
ON Statement Codes 542
*.taskid
MEMLIB Parameter 520
*FLUSH Code
ON Statement Codes 543
*in-condition
Quick Schedule Definition 368
*NCT2 Code
ON Statement Codes 542
*P Field
Conditions/ Resources 277
*rangename
ON Statement 534
PGMST Parameter 534
*REC0 Code
ON Statement Codes 542
*SNRUN Code
ON Statement Codes 544
*T Command
JES Name 468, 621
JES3 520
*TERM Code
ON Statement Codes 542
*UKNW Code
ON Statement Codes 542
*UKNW Status
ON Statement 539
*xxxx Code
+EVERY Step 541
+ (Group Next)
SAC Parameter 601
+ Sign
Change Resource Window 283
DO COND Statement 438
Index 983
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Job Dependency Network 236
Job Graph 204
OUT Parameter, OPT Subparameter 555
SHOUT Parameter 619
+EVERY
ON Statement 535, 536
PGMST Parameter 535
PROCST Parameter 536
+EVERY Step Value
ON Statement 540
. Character
AutoEdit Variable 755
.. Character
AutoEdit Variable 756
/ * Symbol
DO Statement Command 256
/ / *CONTROL-M
Quick Submit Command 806
/ / OUTPUT Statement
SYSDATA Output Class 68
=6 Command
PF06/ PF18 94, 111
=X Command
Fast Exit 92
Online Facility Exit 92
> Character
DO Statement 435
ON Statement CODES 546
SHOUT Parameter 619
TIME Parameter 648
? Character
Masking 83
? Option
Active Environment Screen 180, 205
? Symbol
Confirm Rerun Window 225
Restart Window 228
@Character
Hex Value 82
Maybe Job Prefix 811
OS/ 390 Restarts 811, 975
UserDefined Variable 743, 958
@Symbol
Maybe Jobs 811
@#
OS/ 390 Restart 975
@#-procstep.pgmstep
OS/ 390 Restart 976
OUT Condition 976
| Character
DO COND Statement 437
Hex Value 82
Prerequisite Condition 554
Character
Prerequisite Condition 554
Numerics
1 Command
IOA Primary Option Menu 87, 88
35-Day Default
Periodic Calendar 315
4 Option
Primary Option Menu 87
5 Option
Primary Option Menu 87
6 Option
Primary Option Menu 87
8 Option
Primary Option Menu 87
A
A Option
Active Environment Screen 180
Manual Conditions 288, 810
Parameter Prompting 342
A/ O Parameter
ON Statement 536
ABEND
FLUSH 545
SNRUN 545
Abend Capturing Option
DUMP Command 178
Abend Code
ON Statement 541
S*37 615
Abend Code Recapture
Rerun Confirmation 226
Abend Report
REP5ABND Utility 878
ABENDED Status
Show Screen Filter 195
ABORT
Screen Command 96
ACF2 569
Action Keyword
DO Statement 434
ACTIVATE Option
Active Environment Screen 180
Active Environment Screen
Commands 172
Display Type 167
Fields 169, 170, 171
Filtering 189
Format 169
Functions 164
Job Deleting 180
Job Statuses 185
Options 180
RBA 174
Active Environment screen 175, 215, 459
984 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
ACTIVE FROM Parameter
Scheduling Logic 384
ACTIVE IN ERROR Status
Active Environment Screen 189
Active Jobs File
Daily Subsystem 381
Description 44
Display 59
DO FORCEJOB Statement 690
Dynamic Insert Facility 69
MAXWAIT Parameter 495, 515
New Day Processing 45
PRIORITY Parameter 580
Restoration 49
SYSDATA Deletion 399
TASKTYPE Parameter 645
Active Missions File
D-CAT Parameter 416
ACTIVE Status
Active Environment Screen 185, 189
Group Entity 558
ACTIVE UNTIL Parameter
Scheduling Logic 384
ADD Command
Conditions and/ or Resources 279
ADD COND Command
Conditions and/ or Resources 280
ADD COND Parameter
Simulation 839
Add Condition Option
Why Screen 206
ADD CONTROL Command
Conditions and/ or Resources 280
ADD Option
Manual Conditions 288, 810
Parameter Prompting 342, 355
ADD RESOURCE Command
Conditions and/ or Resources 280
ADDED Field
Manual Conditions 285
Adding
Conditions and/ or Resources 279
Manual Condition 286
Adding Variables
Variable Database Facility 271
Addition Operator
%%PLUS Operator 770
ADDMNCND Utility
KSL Script 879
Maybe Jobs 812
ADJUST CONDITIONS
Parameter 392
ADJUST CONDITIONS Parameter
Description 392
Group Entity 113, 142, 379, 812
AECACHL Parameter
CTMPARM 746
AELIBNM Parameter
CTMEXEC CLIST 827
AJF
Functions Performed by CTMAPI 886
AJF Action BAPIAACT Field Values 918
AJF Action Input Parameters 917
AJF Action Return Codes
CTMAPI 918
AJF Actions
CTMAPI Calling 892
ALCMAJF Member 912
Use with CTMAPI 894
ALL Argument
REFRESH Command 175, 239
All Info Display Type
Active Environment Screen 171
All Runs
ON Statement 538
STEP RANGE Parameter 631
ALLCACHE Value
%%RESOLVE Control Statement 768
ALLOC KSL Command 873
ALLRUNS Parameter
CTRPARM Member 538, 631
ALLRUNS=YES
FLUSH Code 545
SNRUN Code 545
AND/ OR Parameter
DAYS/ WDAYS Parameter 383, 421, 655
And/ Or/ Not Logic
CMEM ON Statement 709
And/ Or/ Not Parameter
CMEM ON Statement 708
ON DSNEVENT Statement 713
ON JOBARRIV Statement 716
ON JOBEND Statement 718
ON STEP Statement 721
And/ Or/ Not Subparameter
CMEM Rule Definition 253
ANYSTEP
FORCE OK 241
ON Statement 535
PGMST Parameter 535
ANYSTEP Value
PGMST Parameter 539
APPL 396
APPL Parameter
Description 396
Example 397
Application Name
APPL Parameter 396
APPLICATION NAME Parameter
AutoEdit Simulation 327
Application Program Interface, CONTROL-M 884
Archiving
SYSDATA 398
Sysout 482
Index 985
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
ARG Parameter
DO CTBRULE Statement 442
ARGUMENTS Parameter
CTB STEP Parameter 413
ARROW Command
Change Color 160
ASK FOR EACH ONE Field
CMEM Rule Order Window 263
Conditions/ Resources Confirmation 282
Manual Conditions Confirmation 289
Scheduling Confirmation 155
Why Screen Confirmation 209
Assignment of Variable
Definition 751
AT Parameter
CTB STEP Parameter 413
ATTN Key
AutoRefresh Mode 102
ATTR KSL Screen Attribute
IFSCREEN Command 868
AUTO Command
AutoRefresh Mode 101, 175
AUTO-ARCHIVE parameter 400
AUTO-ARCHIVE parameter and 400
AutoEdit Expression
DO RULE Statement 694
AutoEdit Facility
Boolean Logic 761
Control Statement 760, 828
JCL Modification 733
JCL Setup 46
Job Scheduling 735, 784
KSL 955
Setting Variable Values 769
Syntax Checking 325, 782
AutoEdit Function
%%$CALCDTE 771
%%$GREG 772
%%$JULIAN 772
%%$LEAP 773
%%$LENGTH 779
%%$WCALC 773
%%$WEEK 774
%%$WEEKDAY 775
%%$YEARWK# 776
%%CALCDATE 777
%%SUBSTR 778
AutoEdit Variables 735
JCL Setup 778, 779
AutoEdit Operator
%%MINUS 770
%%PLUS 735, 770
Boolean Logic 762
KSL 961
AutoEdit Parameter
OCCUR NO Suffix 828
Parameter Prompting 335, 342, 346, 352, 359, 816, 821
AutoEdit Resolution
Rerun/ Restart Window 227
AutoEdit SET Statement
JCL SET 759
AUTOEDIT SIMUL Option
Online Utilities Menu 321
AutoEdit Simulation
CTMAESIM Utility 325
AutoEdit Statement
CTMEXEC CLIST 828
Syntax Checking 845
AutoEdit Symbol
%%JOBNAME 483
%%MEMNAME 483
DO SYSOUT Statement 483
AutoEdit Syntax
Checking 325, 782
CTMAESIM Utility 782
CTMSCIM Utility 331
Testing 325, 782
AutoEdit Variable
%%SIGN 590
CMEM 687
Concatenation 755
Description 733
DO MAIL Statement 452
DO SET Statement 462, 463, 784
DO SHOUT Statement 469, 622
DO Statement 434
Global 874
KSL Script 861, 864
Linking 755
MEMLIB Parameter 520, 785
Multiple 755
OVERLIB Parameter 564, 785
Precedence 758
Resolution 755, 958
SET VAR Parameter 612
SETOLOC Statement 861
Setting a Value 462, 612, 758
System Variable 737
Value Assignment 758
Automatic Restart
Restart ... 447
Automatic Tape Adjustment
Description 54
RESOURCE Parameter 588
WM2744 Wish 54
Automatic Tape Adjustment Facility
Statistics Screen 235
Automation Log
MODE Parameter 707
Automation Log Screen
SHOW Command 292
AUTOMATION OPTIONS
IOA Menu 89
AutoRefresh
986 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
PA1 Key 96
AutoRefresh Mode
Active Environment Screen 166
Screen Updating 101
View Graph Screen 201
AutoSave Documentation 148
AUTOTAPE Parameter
CTMPARM 235, 589
AUTOARCHIVE Parameter
Description 398
Example 401
Average Statistics Line
Statistics Screen 234
B
B Option
Table List Screen 122
Backslash Character
Global Variable 743
Balancing Specifications
DO CTBRULE Statement 442
BALANCING STATUS Option
Primary Option Menu 89
BAPIACON Value
CTMBAPI AJF Action 918
BAPIACRT Value
CTMBAPI AJF Action 918
BAPIADEL Value
CTMBAPI AJF Action 918
BAPIAFOK Value
CTMBAPI AJF Action 918
BAPIAFRE Value
CTMBAPI AJF Action 918
BAPIAHLD Value
CTMBAPI AJF Action 918
BAPIAJID Field
CTMBAPI 917
BAPIAMEM Field
CTMBAPI 917
BAPIAOID Field
CTMBAPI 917
BAPIARER Value
CTMBAPI AJF Action 918
BAPIAUND Value
CTMBAPI AJF Action 918
BAPICMD Field 920
CTMAPI 922
CTMBAPI 906
BAPICMDA Field
CTMAPI 906
BAPICMDL Field
CTMAPI 923
CTMBAPI 906
BAPIFLG1 Field
CTMBAPI 907
BAPIMCT Field
CTMBAPI 907
BAPIOWN Field
CTMBAPI 917
BAPIRBAC Field
CTMBAPI 917
BAPIRBAN Field
CTMBAPI 917
BAPIRC Field
CTMAPI 907
CTMAPI Return Codes 902
BAPIRESP Quantitative Resource Input Field,CTMAPI 921
BAPIRESQ Quantitative Resource Input Field, CTMAPI
921
BAPIRESX Quantitative Resource Input Field CTMAPI
921
BAPIRESX Quantitative Resource Input Field, CTMAPI
921
BAPIRPL# Field
CTMAPI 907
BAPIRPLC Field
CTMBAPI 907
Initial Setting 925
BAPIRPLE Field
CTMAPI 907
BAPIRPLS Field
CTMAPI 907
BAPIRSN Field
CTMAPI Return Codes 902
CTMBAPI 908
BAPISGRN Field
CTMBAPI 909
BAPISHLD
CTMBAPI Field 909
BAPISIGN Field
CTMAPI 908
BAPISJID Field
CTMBAPI 909
BAPISJNM Field
CTMBAPI 909
BAPISLIB Field
CTMBAPI 909
BAPISMEM Field
CTMBAPI 909
BAPISODT Field
CTMBAPI 909
BAPISOID Field
CTMBAPI 910
BAPISOWN Field
CTMBAPI 910
BAPISRBA Field
910
BAPISRBB Field
CTMBAPI 910
BAPISSTT Field
CTMBAPI 910
BAPISTAB Field
Index 987
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CTMBAPI 910
BAPISTYP Field
CTMBAPI 910
BAPIURC Field
CTMAPI Return Codes 902
CTMBAPI 908
BAPIVERS Field
CTMAPI 908
BAPIWORK Field
CTMBAPI 908
Basic Scheduling Parameters
Group Entity 142
Scheduling Definition 132
Summary 381
Batch Job
TASKTYPE Parameter 643
Batch Procedure
CTMAESIM 325
BEEP KSL Screen Attribute 868
BLANK Value
Parameter Prompting 353
BLT Function
CTMAPI, Setting Reply Fields 923
Reply Codes 923
BLT Function Replies
CTMAPI 923
BLT Function, CTMAPI
Procedure 922
BMC Software, contacting 2
Boolean Logic
Example 800
JCL Setup 761
BOTTOM Command
Scrolling 97
Bottom Line
Primary/ Alternate 168
BOTTOMLINE KSL Command 871
BOTTOMSIZE KSL Command 871
Branching
%%GOTO Control Statement 761, 800
Browse Mode
CMEM Rules 245
DOCU/ TEXT 147
DOCU/ TEXT Library 486, 488
Job List Screen 124
Zoom Screen 214
BROWSE Option
Calendar List Screen 306
CMEM Table List 248
Table List Screen 116, 122
BUT NOT FOUND n TIMES
Active Environment Screen 185
BYPASS Option
Active Environment Screen 183
Default Settings 183
Fields 183
Bypassing
Table List Screen 258
C
C Option
Active Environment Screen 182
Job List Screen 128, 250
Year List Screen 309
Cache
%%GLOBAL Members 746
Calendar
DATES Parameter 418
DAYS Parameter 422
Example 425, 659
Job Scheduling Plan 163
Periodic 53
Regular 52
WDAYS Parameter 656
Calendar Date
System Variable 740
CALENDAR DEF Option
Primary Option Menu 87
Calendar Definition Screen 306, 312
Exiting 317, 318
Calendar Facility
Accessing 303
Deleting a Calendar 316
Entry Panel 304
Exiting 317
General 301
Inserting a New Year 309
Overview 60
Periodic Calendar 313
Scheduling Jobs 52
CALENDAR Field
Calendar Facility Entry Panel 305
CALENDAR LIBRARY Parameter 325
Calendar List Screen 305
Exiting 320
Calendar Name
DCAL Parameter 421
Calendar Periodic
Description 313
CALL KSL Command 867
CALLMEM Command
KSL 865
CALLMEM KSL Command 868
CANCEL Command
Calendar Definition Screen 318
CMEM Rule Definition 258
Description 99, 100
Scheduling Definition 150
Scheduling Definition Entry Panel 119
Zoom Screen 221
CAPS Command
CMEM Rule Definition 255
988 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CAPS OFF
Command 255
CAPS ON
Command 255
CATEGORY Command
Log Screen 292
CATEGORY Field
Job Scheduling Table 807
CATEGORY Parameter 382
CCTMJOB
Replacement by CTMAPI 886
CHANGE Command
Scheduling Definition 144
CHANGE Option
Conditions/ Resources 281, 283
CHANGE RESOURCE Parameter Simulation 839
Character
Global Variable 743
Gregorian Date Format 65
Hex Value 82
Character Masking 83
CHECK IN EXT VOL Option
Primary Option Menu 90
CICS 81
CMEM On Spool Job 669
Environment 569
OWNER Parameter 569
PF06/ PF18 94
CICS Environment 81
Class
Allocation 794, 795
DO SYSOUT Statement 475
Sysout 477, 635
SYSOUT Parameter 633
CLEANUP Option
Online Utilities Menu 321
CLEANUP Status
Active Environment Screen 185
CLEAR KSL Command 866
CLIST
Activation 110
TSO Environment 805
CLIST CTMCAES
AutoEdit Syntax Testing 325
CLIST CTMCAMNU
Parameter Prompting 349
CLIST CTMCDOCU
DOCU/ TEXT Product 374
CLIST CTMCFMNU
Parameter Prompting 338
CLIST CTMCSIM
Simulation/ Tape Pull 330
CLIST CTMEXEC
Parameter Prompting 825, 827
CLIST CTMFETCH
Parameter Prompting 825
CLIST CTMJBINT
End User Job Order 371
Job Ordering 805
CLIST CTMJOBRQ
Job Ordering 324, 805
CLIST CTMPROMPT
Quick Schedule Definition 361
CLIST CTMQUICK
Quick Schedule Definition 362
CLIST IOAUTIL
Online Utilities 320
CLOSEFILE KSL Command 873
CMEM
FTP products 677
Generation Data Sets 677
IBM FTP 678
SMS Support 676
CMEM DEFINITION Option
IOA Primary Option Menu 88
CMEM Entry Panel
Exiting 260
CMEM Facility
Actions 667
AutoEdit Variables 687
CICS Job 669
CONTROL-O 52
Description 666
DO FORCEJOB Statement 691
Event Types 51, 666
External Events 51
Forced Job 672, 691
On Spool Job 52, 669
Overview 59
Rule Management 668
CMEM Message Type
IOA Log Show Screen Window 298
CMEM Monitor
Variable Database Facility 265
CMEM On Spool Job
On Spool Job 691
CMEM Option
Primary Option Menu 243, 246
CMEM Rule
And/ Or/ Not Logic 709
Browsing 245
Comments 256
Components 670
CONTROL-O Rule 681
Creation 244
Dataset Event 666, 711
Definition 679
DESCRIPTION Parameter 683
DO COND Statement 667, 686
DO FORCEJOB Statement 667, 690
DO RULE Statement 694
DO SHOUT Statement 697
DO Statement 667, 681, 685
DO STOPJOB Statement 667, 702
Index 989
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Editing 245
GROUP Parameter 704
Job Arrival 716
Job Scheduling Definition 671
Management 667
MODE Parameter 706
ON DSNEVENT Statement 666, 668, 708, 711
ON JOBARRIV Statement 666, 670, 708, 716
ON JOBEND Statement 666, 708, 718
On Spool Job 669
ON Statement 708
ON STEP Statement 666, 708, 720
OWNER Parameter 724
Parameters 679
Prerequisite Condition 667, 686
Screen 679, 684, 701, 703, 707, 715, 717, 719, 727
Simulation 706
CMEM Rule Definition
Commands 255
Description 251
Editing 257
Entry Panel 246
Exiting 258
CMEM Rule Facility
Description 242
Exiting 258
ISPF PACK Option 243
Screens 243
TEST Mode 706
CMEM Rule List
Browse Mode 249
Exiting 259
Options 250
Screen 247, 683
CMEM Rule Table
Creation 243
Deletion 260
List 248
Ordering 261, 668
CMEM Security
RUNTSEC Parameter 727
CMEM support
ON STEP Statement 674
CMEM Table
Ordering 245
CMEM Table List
Exiting 260
Options 247
Statistics 247
Cnnnn Code
+EVERY Step 541
Code *****
FLUSH Code 545
SNRUN Code 546
CODE Criteria
IOA Log Show Screen Window 298
Screen Filter 298
CODE Field
Log Screen 291
CODES Parameter
ON Statement 536, 541
Collection
MAINVIEW Batch Optimizer (MVBO)
Implementation 814
COLOR
KSL Screen Attribute 869
Color Support
Active Environment Screen 166
Box Color 160
Graphic Jobflow 159
Job Graph 202
Online Facility 82
View Graph Screen 201
Column Range
%%RANGE Control Statement 766
Combinatorial Logic
CMEM ON Statement 709
Command 1
IOA Primary Option Menu 87, 88
Command Line
Online Facility 92
Command line commands
IOA Editor 105
Commands
=6 94, 110
Active Environment Screen 172
ADD COND 280
ADD CONTROL 280
ADD RESOURCE 280
ADD Resources 279
AUTO 101, 175
BOTTOM 97
CANCEL 100, 119, 150, 221, 258
Change Color 160
CMEM Rule Definition 255
Conditions/ Resources Screen 280
Copy 937, 950
CPUID 177
CTMQSB 805
CTMTTRA 110
DATA 126
Delete 937, 950
DESC 126, 177, 250, 308
DISPLAY 167, 173
DOC 147
DOWN 94
DUMP 178
EDIT 145, 255, 257, 935
END 94, 150, 199, 258, 301
Exit Online Facility 92
FIND 94, 98, 159
GROUP 178, 292
HELP 94, 100
HISTORY 174
990 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Insert 938, 951
IOA Primary Option Menu 87
ISPF 102
JCL 116
JES HOLD 186
Job Dependency 239
Job Dependency Network 239
JOBSTART 234
JOBSTAT 144, 175
KEYS 102, 233
KSL 859, 866
L Parameter Prefix 102, 341, 345, 354, 359
Line Editing 937, 950
LOCATE 97, 228
Location 938, 952
Log Screen 292
MAXCOMMAND 870
Move 938, 951
NEW COND 286
NEW LCOND 286
NOTE 176
OIDL 179
Online Facility 93
OPT 172
ORDERID 179
PRINT 103
Quick Submit 805
RBAL 174
REFRESH 101, 175, 199, 236, 239
Repeat 938, 951
RESET 94, 99, 100, 151, 198, 260, 301, 370, 935
RETRIEVE 94
Rule Editing 949
SAVE 219, 221
Scheduling Definition 143
Scrolling 96
SELECT 114, 123
SET 107
SHOW 94, 174, 190, 294
SHPF 94
SORT 126
SPLIT 102
STAT 126, 250, 308
SWAP 102
Sysout Viewing 232
TABLE 176
Table List Screen 123
TOP 97
TSO 109
TSO CTMTTRA 111
UP 94, 96
Utilities Transfer 94
VG 179, 200
VIEW 179, 198
VIEW GRAPH 179, 200
VIEWALL 231
Comment
CMEM Rule Definition 256
Comparison Operators
AutoEdit Logic 762
COM-PLETE 81
Components
CONTROL-M 43
Compression Job
CONTROL Parameter 410
Computer Allocation
Example 795
Computer ID
Started Task 522
COMPLETE 81
PF06/ PF18 94
Concatenation
%% Symbol 737, 758
AutoEdit Variable 755
Logic 755
COND Field
Conditions/ Resources 278
COND/ RES Option
Primary Option Menu 87
Condition Code
ON Statement 541
Condition Code Recapture
Restart Confirmation 226
CONDITION DATE Field
Prerequisite Condition Utility 323
CONDITION Field
Parameter Prompting 342
CONDITION Name
Manual Conditions 285
CONDITION NAME Field
Prerequisite Condition Utility 323
Condition Names
Long 436, 499, 557
Condition Parameter
DO COND Statement 686
CONDITION/ RESOURCE Field
Conditions/ Resources 276
Conditional Processing
DO Statement 388
IF, THEN, ELSE 761, 800
ON Statement 388
Conditions
Forecasting 834
Simulation 835
Conditions File 61
Conditions/ Resources
Add/ Check/ Delete Utility 322
Delete Option 281
Fields 276
Handling 47, 73
IOALDNRS Utility 809
Manual Conditions 287
Options 281
Restoration 49
Index 991
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
COND-NAME Subparameter
DO COND Parameter 437
IN Parameter 497
OUT Parameter 554
condopt Parameter
DO COND Statement 687
CONFCAL Calendar
Schedule Validation 383
Scheduling Logic 384
CONFCAL Parameter
Description 402
MINIMUM Parameter 527
PDS Parameter 571
Periodic Calendar 404
Configuration Table
AutoEdit Statement 830
CONFIRM Field
CMEM Rule Table Order 262
Conditions/ Resources 282
Manual Conditions 289
Rerun Confirmation Window 223
Restart Confirmation Window 224
Scheduling Confirmation 153
Zoom Screen 215
CONFIRM Option
Active Environment Screen 182
CONFIRM Parameter
Description 407
DO IFRERUN Statement 448
Example 408
Confirm Rerun Window
Active Environment Screen 222
Confirm Restart Window
Active Environment Screen 223
Confirm Scheduling Window
Active Environment Screen 221
Confirmation Window
CMEM Rule Table 262
DO IFRERUN Statement 449
Force OK 241
Manual Conditions 288
Manual Scheduling 152
Why Screen 207
Zoom Screen 220
CONNECT DIRECT
File Transfer 689
CONTROL Field
Conditions/ Resources 278
CONTROL Parameter
Description 409
Example 410
Logic 410
CONTROL Resource
Adding 279
Critical Path Priority 581
Definition 73
Manual Addition 280
Runtime Criteria 47
Show Screen Filter 197
CONTROL Resources
CONTROL-M Resources File 275
IOA Conditions/ Resources Screen 275
CONTROL Statements
AutoEdit 760
CONTROL-M
Application Program Interface 884
Implementation 804
Parameter Prompting 338
SIMPARM DD Statement 837
CONTROL-M Monitor
Multiple Monitors 55
New functions 564
Simulation Facility 330
CONTROL-M Resources
File 275
CONTROL-M Resources File 61, 275
CONTROL-M/ Analyzer
CTB STEP Parameter 413
DO CTBRULE Statement 442
Product Description 41
CONTROL-M/ Enterprise Manager
APPL Parameter 396
DO SHOUT Destination 468, 698
GROUP Parameter 493
SHOUT Parameter 620
CONTROL-M/ Restart SIMUL Option
Online Utilities Menu 321
CONTROL-M/ Restart
FLUSH Code on Restart 545
History Jobs File 48
Rerun Confirmation 224
Restart under 67
Restart under, Job Status 188
CONTROL-O
Product Description 42
SHOUT Facility 52
CONTROL-O Monitor
Variable Database Facility 265
CONTROL-O/ COSMOS
Product Description 42
CONTROL-D
D-CAT Parameter 416
Product Description 41
CONTROL-D/ Image
Product Description 42
CONTROL-D/ Page On Demand
Product Description 41
CONTROL-M
Concepts 61
Overview 43
Product Description 41
CONTROL-M Monitor
Description 45
Postprocessing 49
992 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CONTROL-M Repository 61
CONTROL-M Status Field
Active Environment Screen 169
CONTROL-M/ Tape
Product Description 41
CONTROL-M/ Restart
DO IFRERUN Statement 446
Product Description 41
Restart under 188, 446
Restart Window 223
SNRUN Code on Restart 545
CONTROL-O
%%$ARGS System Variable 695
Automation Log 706
CMEM Facility 52
CMEM Rule 667
KSL 874
MODE Parameter 706
Shout Facility 681
CONTROL-O
CMEM Rule 681
DO SHOUT Statement 697
Rule Invocation 667
Shout Facility 681
CONTROL-O Rule
DO RULE Statement 694
CONTROL-V
Product Description 41
Conventions Used in This Guide 33
Conversational Mode
CTMAPI 904
COPMEM2O Parameter 564
Copy Commands
Edit Environment 937, 950
COPY Option
Job List Screen 116
Year List 309
Copy Option
Job List Screen 128, 250
Copying
Jobs 158
Sysout 476, 480, 634, 638
Copying Jobs 157
Copying Rules 264
COSMOS Status Option
Primary Option Menu 90
COUNT Parameter
Change Resource Window 283
CPU Field
Active Environment Screen 170
CPU ID
Version Information Window 90
CPU Time Field
Statistics Screen 234
CPU Time, Average
Statistics Screen 234
CPU Time, Group
Statistics Screen 235
cpuid
MEMLIB Parameter 520
CPUID Command
Active Environment Screen 177
CPUID Field
Zoom Screen 216
CREATE Field
Exit Option Window 151
Criteria 47
Critical Path
Deleting a Job 210
Job Dependency 74
PRIORITY Parameter 580
Resource Allocation 74
Cross Memory Interface
Online Monitor 81
CRSR
Scrolling Amount 97
CST Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
CTB STEP Parameter
Description 413
Example 414
CTGFORC Parameter
CTMPARM 417
CTMAESIM Utility
AutoEdit Syntax 325, 782
CTMAJO
Replaced by CTMBLT Utility 807
Use of CTMAPI to replace 807
CTMAJO Program
Job Ordering 807
Work Flow 808
CTMAPI
AJF Action Return Codes 918
AJF Action, BAPIACON Value 918
AJF Action, BAPIADEL Value 918
AJF Action, BAPIAFOK Value 918
AJF Action, BAPIAFRE Value 918
AJF Action, BAPIAHLD Value 918
AJF Action, BAPIARCT Value 918
AJF Action, BAPIARER Value 918
AJF Action, BAPIAUND Value 918
Allocations 885
Available Functions 886
BAPICMD Field 906, 922
BAPICMT Field 907
BAPIGOPT Global Variable Input Field 920
BAPIRC Field 907
BAPIRESN Quantitative Resource Input Field 921
BAPIRESP Quantitative Resource Input Field 921
BAPIRESQ Quantitative Resource Input Field 921
BAPIRESX Quantitative Resource Input Field 921
BAPIRPL Field 907
BAPIRPL# Field 925
Index 993
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
BAPIRPLC Field 925
BAPIRPLC Field, Initial Setting 925
BAPIRPLE Field 907, 925
BAPIRSN Field 908
BAPISIGN Field 908
BAPIURC Field 908
BAPIVERS Field 908
BLT Function 922
BLT Function Reply Codes 923
BLT Function, procedure 922
BLT Function, Setting Reply Fields 923
Calling 884
Calling AJF Actions 892
Causes of failure 902
CLIST and 884
Coding CCTMJOB 887
Conditional Requests 900
Conditional Selection Criteria 900
Contents of Input and Output Registers 904
Conversational Mode 884, 904
Create New Tables 890
CTMBAPI Mode 924
CTMBLT Replacement 890
DAAPI DD Statement 884
Date Field Format 925
Environment 885
Environments 884
Fields in the Fixed (Header) Part 905
Fixed Part Values 906
Force Jobs Using 887
Force New Tables 890
Force Return Codes 889
Forcing Allocations 889
Forcing under CLIST 887
Forcing under REXX 887
Forcing Using a Program 888
Generally 884
Global Variable Return Codes 921
Invoking Search from a Program 897
IOA Variables Database and 886
Masking in Character Fields 900
Multiple IF Statements 901
Odering Allocations 889
Order Extension 914
Order Jobs Using 887
Order New Tables 890
Order Return Codes 889
Ordering under CLIST 887
Ordering under REXX 887
Ordering using a Program 888
Pre-allocating SYSPRINT 888
Quantitative Resource Extension Function 921
Quantitative Resource Input Fields 921
Quantitative Resource Return Codes 922
Reply Mechanism Trigger Pointers 925
Requirements before Calling 885
REXX and 884
Scanning and Filtering Reply Lines 925
Search Call Syntax 896
Search Function 896
Security Exit IOASE07 922
Selection Criteria and Performance 901
Selection Criteria Parameter Attributes 901
Status Function 909
Syntax for Calling in Assembler 888
Syntax Forcing Jobs 887
Syntax of AJF Action under 892
Syntax of Search Call 896
Syntax Ordering Jobs 887
Tailoring 885
Under IOA Environment 886
Use to checkpoint variables 886
Use to replace CTMAJO 807
Use to resolve variables 886
Use to Search and Query Job Details 886
Use to Search and Query Job Status 886
Use to set variables 886
CTMAPI DSECT 905
CTMAPI Replies
Reply Mechanism Trigger Pointers 925
CTMAPI Return Codes
BAPIRC Field 902
BAPIRSN Field 902
BAPIURC Field 902
Generally 902
CTMBAPI
BAPIAGRN Field 917
BAPIAMEM Field 917
BAPICMDA Field 906
BAPICMDL Field 906
BAPIFLG1 Field 907
BAPIJID Field 917
BAPIJNM Field 917
BAPIOWN Field 917
BAPIRBAC Field 917
BAPIRBAN Field 917
BAPIRPLC Field 907
BAPIRPLS Field 907
BAPISGRN Field 909
BAPISHLD Field 909
BAPISJID Field 909
BAPISJNM Field 909
BAPISLIB Field 909
BAPISMEM Field 909
BAPISODT Field 909
BAPISOID Field 910
BAPISOWN Field 910
BAPISRBA Field 910
BAPISRBB Field 910
BAPISSTT Field 910
BAPISTAB Field 910
BAPISTYP Field 910
BAPIWORK Field 908
Components 905
994 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DSECT 905
Replies 924
Status Extension Fields 909
Status Reply DSECT 910
Statuses Returned 911
CTMBAPI DESCT 884
CTMBJSE
DESCT 911
CTMBLT
Parameters 891
Replacement by CTMAPI 886, 890
CTMBLT Utility
Assembler Macro 379
CTMAPI BLT Function and 922
Job Ordering 805
Replacing CTMAJO 807
CTMCAES CLIST
CTMAESIM Utility 783
TSO Command 325
CTMCAES Option
CTMAESIM Utility 783
CTMCAES Utility
AutoEdit Simulation 321
CTMCAJF Utility
AUTOARCHIVE Parameter 399
CTMCAMNU Option
Parameter Prompting Entry Panel 335
CTMCFMNU Option
Parameter Prompting Entry Panel 335
CTMCSIM CLIST
TSO Command 330
CTMEXEC CLIST
Example 828
Parameter Prompting 825
CTMEXEC Option
Parameter Planning 357
Parameter Printing 349
CTMFETCH CLIST
Parameter Prompting 825
CTMFETCH Option
Parameter Prompting 349, 356
CTMJBINT CLIST
TSO Command 371
CTMJBINT Utility
End User Job Order 371
Job Order Interface 321
Job Ordering 805
CTMJOB
Coding under CTMAPI 887
CTMJOB Utility
Job Ordering 804, 805
TSO environment 805
CTMJOBRQ CLIST
TSO Command 324
CTMJOBRQ Utility 321
Job Order Request 324
Job Ordering 805
CTMJSA Utility
Statistics File Update 233
CTMPARM 400
#JNFRT Parameter 217
AECACHL Parameter 746
AUTOTAPE Parameter 235, 589
CTGFORC Parameter 417
DUEINCHK Parameter 215, 490
FRCOKOPT Parameter 241, 544
GRPRECHK Parameter 114
MAXCCOK Parameter 544
OVERJCLM Parameter 533, 641
OVERJCLM parameter 610
TAGMAXWT Parameter 516
CTMPLEX
Minus-One Support 55
CTMPROMP Utility 321
CTMQSB Command
CTMX010 Exit 807
Job Ordering 806
CTMQSC Application
CTMAJO Program 808
CTMQUICK CLIST
TSO Command 361
CTMQUICK Option
Online Utilities Menu 362
CTMQUICK Utility
Example 370
Quick Schedule Definition 361
Schedule Definition 321
Tables 114
CTMRSTR Utility
Restoration 49
CTMSIM Procedure
Simulation Procedure 835
CTMTAPUL Procedure
Tape Pull List 834, 845, 847
CTMWORK Value
SYSOPT Variable 443
CTMX001 Exit
CTMQSB Command 806
CTMX002 Exit
CTMAESIM Utility 782
MEMLIB Parameter 521
Parameter Prompting 830
RESOURCE Parameter 590
Simulation 841
CTMX003 Exit
Simulation 841
CTMX004 Exit
RESOURCE Parameter 590
Scheduling Algorithm 592
CTMX010 User Exit
CTMQSB Command 807
CTMX013 Exit
Statistics Screen 234
CTMX015C Exit
Index 995
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Functions 564
CTMX015O Exit
Functions 564
CTMX2PPF Member
IOA SAMPEXIT Library 830
CTO147I message 678
CTO282I Subparameter
DO SHOUT Statement 699
CTO403I pseudo-message 678
CTO782I message 678
CTO783I message 678
customer support 3
Customization
IOA 80
Customizing
Options 57
CYC Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
Cyclic Job
AUTOARCHIVE Parameter 399
CONFIRM Parameter 407
INTERVAL Parameter 509
TASKTYPE Parameter 643
Cyclic Jobs
Force OK 241
Cyclic Jobs Stopping 473
Cyclic Started Task
TASKTYPE Parameter 643
D
D JOB Message Type
IOA Log Show Screen Window 298
D Option
Active Environment Screen 181
Job List Screen 126
Parameter Prompting 342
Table List Screen 123
DAACTLOG DD Statement
MODE Parameter 706
DACALL DD Statement
IOARKSL Procedure 858
DACKPTIN DD Statement
Simulation Active Jobs File 836
Tape Pull List 848
DACKPTOU DD Statement
Simulation Active Jobs File 840
DACNDF DD Statement
CONTROL-M Resources Simulation 837
Simulation 844
DAGLBLST DD
Variable Database Facility 268
DAGLOBAL Statement 746
%%GLOBAL Control Statement 760
PARAMETER LIBRARY Parameter 783
Daily AutoEdit Member
Parameter Prompting 824
Daily JCL Library
Allocation 832
Deletion 831
Parameter Prompting 824
Daily Plan
Parameter Prompting 357, 824
Daily Prompting Table
Daily Table 344
Daily Scheduling Table
Parameter Prompting 823
Daily Subsystem
DCAL Calendar 421
D-CAT Parameter 416
Daily Table
Table Selection Screen 344, 820
DAJCLOUT DD Statement 848
JOB/ SCAN DOCU/ TEXT 850
Tape Pull List 848, 849
DAKSLOUT DD Statement
IOARKSL Procedure 858
DAKSLPRM DD Statement
IOARKSL Procedure 858
DAKSLREP DD Statement
KSL Script 858
DALIB DD Statement
MEMLIB Parameter 519
DALOGIN DD Statement
Tape Pull List 848
DALOGOUT DD Statement
Simulation Log File 840
DANRES DD Statement
Simulation 844, 845
DANSINC DD Statement
Simulation 844, 845
DAREPOUT DD Statement
Tape Pull List 849
DASIMOUT DD Statement
Simulation Messages 840
DASIMPRM DD Statement
Simulation Parameter 837
DASTAT DD Statement
Simulation Statistics 839
DASUBMIT DD Statement
AutoEdit Simulation 329
CTMAESIM Utility 783
Emergency Execution 784
Data Area of Screen
Online Facility 93
DATA Command
Job List Screen 126
DATA Format
Job List Screen 125
Database Facility 265
Database List Screen
Variable Database Facility 268
996 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Database Update
IN Parameter 506
DATAPNAM DD Statement
Tape Pull List 849
dataset cleanup 577
Dataset Disposition
ON DSNEVENT Statement 711
DATASET Event
CMEM 666
DO FORCEJOB Statement 691
Dataset Event
ON DSNEVENT 666, 668, 708
ON DSNEVENT Statement 712
Dataset Name
CMEM 668
Date Calculation
%%$CALCDATE Function 961
%%$CALCDTE Function 791
Date Definition
Overview 62
DATE Field
Conditions/ Resources 277
Job Order Execution History 231
Log Screen 290
Simulation/ Tape Pull 332
Date Field
Why Screen Confirmation 208
Date Field Format
CTMAPI 925
DATE Parameter
CTMEXEC CLIST 827
CTMFETCH CLIST 826
DO FORCEJOB Statement 690
DATE Range
Job Scheduling Plan Screen 163
Log Screen 291
Manual Conditions 286
Date Range
Log Screen 291
DATE Reference
Manual Conditions 285
Date Reference
DO COND Statement 437, 686
Generic 505
IN Parameter 498, 508
January 1st 72, 686
OUT Parameter 555, 562
Prerequisite Condition 71, 439
STAT 72, 437, 686
Zoom Screen 218
Date Updated Field
Parameter Prompting 346
Date Variable
Example 787
JCL Setup 739
DATEMEM Calendar
WCAL Parameter 655
dateref Parameter
DO COND Statement 686
DATEREF Subparameter
DO COND Parameter 437
IN Parameter 498
OUT Parameter 555
DATES Parameter
DAYS Parameter 424
Description 418
Example 419
MINIMUM Parameter 527
MONTHS Parameter 418, 529
PDS Parameter 571
DATES Range Field
Conditions/ Resources 279
DATETYP Parameter 430, 607
Day of the Week
First 655
WDAYS Parameter 654
DAYJCLB Parameter
CTMFETCH CLIST 826
DAYS Parameter
DATES Parameter 418
DCAL Field 383
Description 420
Example 424
Format 420, 421
Logic 424
MINIMUM Parameter 527
Negative Value 424
PDS Parameter 571
Scheduling Logic 384
DAYTBLB Parameter
CTMEXEC CLIST 827
CTMFETCH CLIST 826
DAYTIMEM Parameter
ODATE 64
DB VARIABLE DEF Option
Primary Option Menu 89
DB/ 2 database
use with SAP/ R3 930
DCAL Parameter
Calendar Name 421
Calendar Type 424
DATES Parameter 418
DAYS Parameter 383
MAXWAIT Example 518
Nonperiodic Calendar 422
DCAL parameter
Periodic Calendar 423
D-CAT Field
Ignored by CTMQSB Command 807
D-CAT Parameter
Category E 382
Description 416
Example 417
DD Statement
Index 997
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DAACTLOG 706
DACALL 858
DACKPTIN 836, 849
DACKPTOU 840
DACNDF 837
DAGLBLST 268
DAGLOBAL 746
DAJCLOUT 849
DAKSLOUT 858
DAKSLPRM 858
DAKSLREP 858
DALIB 519
DALOGIN 849
DALOGOUT 840
DAREPOUT 849
DASIMOUT 840
DASIMPRM 837
DASTAT 839
DASUBMIT 329, 783
DATAPNAM 849
TAPULIN 847, 849
TAPULOUT 849
Deadline Adjustment
Job Flow 75
DEADLINE Argument
REFRESH Command 239
Debugging
TRACE ON Parameter 858
Decollating Mission
D-CAT Parameter 416
Default Display Type
Active Environment Screen 169
Job Dependency Network 237
Job Order Execution History 230
DEFAULT Field
Parameter Prompting 353
DEFAULT Filter
Active Environment Screen 174
Default Filter
Active Environment Screen 190
Log Screen 294
DEFAULT STATUS Field
Parameter Prompting 360
Define Parameters and Conditions
Exiting 342
Fields 341
Options 342
Screen 341
Type 1 Option 1 339
Define Parameters in Master Plan
Fields 352
Options 354
Screen 352
DEFINITION ACTIVE Parameter
Description 430
Forced Jobs 430
Format 430
FROM 134, 430
UNTIL 134, 430
DEL Option
Active Environment Screen 181
DEL Status
CTMAPI 911
Delete Commands
Edit Environment 937, 950
DELETE COND Parameter
Simulation Parameter 839
Delete Confirmation Window
Active Environment Screen 210
Table List Screen 158
Delete NOT-COND Option
Why Screen 207
DELETE Option
Calendar List Screen 306
CMEM Rule List 250
CMEM Table List 248, 260
Conditions/ Resources 281
Job List Screen 116, 127
Parameter Prompting 342, 355
Table List Screen 116, 123
Year List Screen 308
Delete Option
Table List Screen 158
DELETED Status
Active Environment Screen 185
Deleting
Calendars 316
CMEM Table 260
DO Statement 435
Manual Conditions 288
MSGCLASS Sysout 482
ON Statements 538
Prerequisite Condition 72, 438
Sysout 477, 480, 635, 638
Table in Table List 260
Deleting a Job
Group Entity 210
WAIT SCHEDULE jobs 209
DELOVRER Parameter 564
DELOVRUN Parameter 564
Dependency
Maybe Job 811
DEPENDS ON Field
Quick Schedule Definition 368
DESC Command
Active Environment Screen 177
Job List Screen 126
Rule List Screen 250
Year List Screen 308
DESC Field
Active Environment Screen 170
IOA Log Show Screen Window 297
Parameter Prompting 342
Show Screen Filter Window 193
998 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DESC Format
Job List Screen 125
DESC Parameter
Description 432
Example 433
Description
THRESHOLD Parameter 728
DESCRIPTION Field
Quick Schedule Definition 368
Rule List Screen 249
Description Field
Parameter Prompting 346
DESCRIPTION Parameter
CMEM Rule 683
Example 684
Scheduling Definition 127
Destination
DO MAIL Statement 451
DO SHOUT Statement 470, 471, 624, 697, 700
DO SYSOUT Statement 475
SYSOUT Parameter 633
Devices
Tape Usage 235
DEVICES USED Field
Statistics Screen 236
D-INT Message Type
IOA Log Show Screen Window 298
DISAPPEARED Status
Activate Option 180
Active Environment Screen 185
Show Screen Filter 195
Zoom Screen 216
DISP Parameter
ON DSNEVENT Statement 712
DISPLAY Command
IOA Log Screen 293
Job Order Execution History Screen 230
Status Command 173
Variable Zoom screen 273
Display Command
Active Environment Screen 167
Display Filters Window
Fields 295
Options 191, 295
Display Filters window
Fields 191
Display Type
Active Environment Screen 167
Display Type A
Active Environment Screen 171
Display Type D
Active Environment Screen 169
Display Type Field
Active Environment Screen 169
Display Type Indicator
Job Dependency Network 238
Displaying
Job Statistics 116
Jobflow 116
Statistics 144
DO Action
DO Statement 137
DO COND Parameter
COND-NAME Subparameter 437
DATEREF Subparameter 437
Long Condition Names 436, 440
OPT Subparameter 438
DO COND Statement
CMEM Rule 667, 686
Conflicts 439
Definition 436
DO Statement Action 434
Example 441, 688
Logic 438
OUT Parameter 441, 558
Prerequisite Condition 70, 498, 687
DO CTBRULE Statement
Description 442
DO Statement Action 434
Example 443
DO FORCEJOB Statement
Active Jobs File 690
CICS Job 693
CMEM On Spool Job 672
CMEM Rule 667, 690
Dataset Event 691
Description 444, 690
DO Statement Action 434
Example 445, 692
Logic 691
RERUNMEM Parameter 585
DO IFRERUN Statement
Description 446
DO Statement Action 434
Example 450
Job Rerun 225
RERUNMEM Parameter 585
Scheduling Definition 218
DO MAIL Statement
Description 451
DO Statement Action 434
DO NOTOK Statement
DO Statement Action 434
DO OK Statement
Description 456
DO Statement Action 434
DO RERUN
Description 459
DO RERUN Statement
CMEM On Spool Job 673
DO Statement Action 434
RERUNMEM Parameter 585
DO RULE Calls
Nesting 695
Index 999
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DO RULE Statement
AutoEdit 694
CONTROL-O Rule 667, 694
Example 696
DO SET
Global Variables 266
DO SET Statement
AutoEdit Statement 784
Description 462
DO Statement Action 434
Example 465
Global Variable 748
JCL Setup 753
Local Variable 745
SET VAR Parameter 464, 614
UserDefined Variables 735
DO SHOUT Statement
CMEM CONTROL-O 667
CMEM Rule 697
CONTROL-O 697
CTO282I Subparameter 699
DO Statement Action 434
Example 472, 628, 701
JES 698
Route Codes 699
Shout Facility 466
DO Statement
CMEM Rule 667, 681, 685
CMEM Rule Definition 254
Description 434
Logic 435
PostProcessing Parameters 137
Summary 389
DO STOPCYCL
Description 473
DO STOPCYCL Statement
DO Statement Action 435
DO STOPJOB Statement
CMEM Rule 667, 702
Description 702
Example 703
DO SYSOUT Statement
Archiving Facility 482
Description 475
Diagram 479
DO Statement Action 435
Example 482
Logic 478
Merging 479
SYSOUT Parameter 481, 634, 638
DOC Command
Scheduling Definition 144, 147, 219
DOC Lines
Scheduling Definition 147, 488
Status Zoom Screen 488
DOCLIB Field
Scheduling Definition 148
DOCLIB Parameter
Description 486
Example 487
DOCMEM Field
Scheduling Definition 148
DOCMEM Member
DOCLIB Library 486
DOCMEM Parameter
Description 488
Example 489
DOCU/ TEXT 486, 488
Browse Mode 147
Interface 321, 374, 849
JCL Documentation 374
Online Utilities Menu 321
Option 321
Option U1 321
Utility 321
Documentation
AUTO-SAVE Field 121
AUTOSAVE Field 148
DESC Parameter 432
Editing 147
Saving 148
Scheduling Definitions 146
Double Confirmation Window 155
DOWN Command
PF08/ PF20 94, 96
DSN Parameter
ON DSNEVENT Statement 712
DSNEVENT criteria
STEPRC field 675
DSNEVENT Statement 253
DUE IN Field
Zoom Screen 215
DUE IN Time
DUE OUT Parameter 490
DUE OUT Field
Zoom Screen 215
DUE OUT Parameter
Description 490
Example 491
Job Flow 75
DUE OUT Time
REFRESH Command 239
SHOUT Parameter 619
DUEIN Field
Job Dependency Network 238
DUEINCHK Parameter
CTMPARM 215, 490
DUEOUT Field
Job Dependency Network 238
Dummy Class
DO SYSOUT Statement 478
SYSOUT Parameter 635
DUMMY Job
Status 392, 394
1000 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DUMMY Jobs
JES 394
MEMBLIB Parameter 394
DUMMY Library
MEMLIB Parameter 519
OVERLIB Parameter 563
DUMP Command
Active Environment Screen 178
duplicate dataset prevention 577
Dynamic Destination Table
DO SHOUT Statement 470, 624, 700
Dynamic Group Insert Facility 69
E
E Option
Active Environment Screen 182
Display Filters Window 295
Job List Screen 124
Manual Conditions 288
ECJ Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
ECS Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
EDIT Command
CMEM Rule Definition 255
Job Scheduling Definition 935
Scheduling Definition 143
Edit Entry Panel
IOA Editor 104
Edit Environment 935
CMEM Rules 257
Description 935
Example 940
Line Editing Commands 145
EDIT Option 182
Active Environment Screen 182
Display Filters Window 295
Display Filters window 191
Editing
CMEM Rule Definition 257
CMEM Rules 245
Documentation 147
Example 940
Job JCL 126, 182
Rule Definitions 949
Scheduling Definition 145, 935
EDMEM command
IOA Editor 104
ELAPS Field
Job Dependency Network 238
ELAPSE Field
Zoom Screen 215
ELAPSE TIME
Job Flow 75
Elapse Time
DUE OUT Parameter 490
ELAPSED Field
Job Order Execution History 231
ELAPSED Run Time Field
Statistics Screen 234
ELAPSED Time, Average
Statistics Screen 234
ELAPSED Time, Group
Statistics Screen 235
Emergency Execution
DASUBMIT DD Statement 784
Emergency Job
MAXWAIT Parameter 516
TASKTYPE Parameter 643
EMR Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
End Code
ON Statement 541
END Command
Calendar Definition Screen 318
CMEM Rule Definition 258
IOA Log Show Screen Window 301
KSL 868
PF03/ PF15 94
Scheduling Definition 150
Show Screen Filter 198
END KSL Command 868
END NOT OK Status
END NOTOK Status 164
END NOTOK Field
Global View Screen 199, 202, 204
END NOTOK Status
Job Graph 203, 204
END OK Field
Global View Screen 199, 202, 204
Job Graph 203
END OK Status
ENDED OK Status 142
END TIME Field
Statistics Screen 234, 235
End TRACE level
SET Command Panel 108
End User Job Order Interface
Job Ordering 805
Utility CTMJBINT 371
END_NOK_ABND Status
CTMAPI 911
END_NOK_CC Status
CTMAPI 911
END_NOK_DISA Status
CTMAPI 911
END_NOK_JCLE Status
CTMAPI 911
END_NOK_NSUB Status 911
Index 1001
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
END_NOK_UNKW Status
CTMAPI 911
END_OK Status
CTMAPI 911
END_OK_FOK Status
CTMAPI 911
ENDED NOT OK ABENDED Status
Active Environment Screen 185
ENDED NOT OK DUE TO CC Status
Active Environment Screen 185
ENDED NOT OK JCL ERROR Status
Active Environment Screen 185
ENDED NOT OK RERUN WAS NEEDED Status
Active Environment Screen 185
ENDED NOT OK TERM ON NCT2 Status
Active Environment Screen 185
ENDED NOT OK Status
Active Environment Screen 185
TERMINATE Option 241
ENDED NOTOK Status
DO STOPJOB Statement 702
ENDED NOTOOK Status
Active Environment Screen 189
ENDED OK FORCED OK Status
Active Environment Screen 185
ENDED OK Status
Active Environment Screen 185, 189
Job Graph 204
Show Screen Filter 195
TERMINATE Option 241
ENDED Status
Show Screen Filter 195
ENTER Key
AutoRefresh Mode 102
ENTER KSL Command 866
Enter YES Field
Simulation/ Tape Pull 335
ENTER YES TO CONTINUE Parameter
Description 325
Prerequisite Condition Utility 323
Entry Panel
AutoSave Documentation 148
Calendar Facility 304
CMEM Rule Definition 246
CMEM Rule Facility 246
Exiting 151
IOA 84
Parameter Prompting 335
Scheduling Facility 115, 118, 151
Table Creation 114
Environment
Online Facility 81
Environment Specification
SET VAR Parameter 615
EQ Operator
AutoEdit Facility 762
ERASE Option
Manual Conditions 288
Errors Only Field
Simulation/ Tape Pull 335
EST Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
Event Selection Parameter
CMEM Rule 252, 679
Exclusive Control
CONTROL Parameter 409
Exclusive Resource
WAIT SCHEDULE Status 280
EXEC A PLAN Option
Parameter Prompting 824
EXEC KSL Command 868
EXEC Phase
Parameter Prompting 353
EXEC Status
CTMAPI 911
Exec/ Order a Plan
Parameter Prompting 357, 360
EXEC_ERR Status
CTMAPI 911
EXEC_INQ Status
CTMAPI 911
EXEC_WSUB Status
CTMAPI 911
EXECTIME Limit
SHOUT Parameter 619
Execute a Plan
CTMEXEC CLIST 825
EXECUTING (SYSOUT IN HOLD STATUS)
Active Environment Screen 186
EXECUTING Field
Global View Screen 199, 202, 204
EXECUTING Status
Job Graph 202, 204
Show Screen Filter 195
Execution Delay
MAXWAIT Parameter 515
Execution Error
ON Statement 541
Execution Information
Job Order Execution History 229
Statistics Facility 53
Execution Statistics
Statistics Screen 233
Execution Time
DUE OUT Parameter 490
EXERR Code
ON Statement Codes 543
EXERR Status
Description 388
ON Statement 539
Exit
CTMX001 806
CTMX002 521, 590, 782, 830, 841
1002 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CTMX003 841
CTMX004 591
CTMX013 234
CTMX014 521
Exit Command
Online Facility 92
EXIT Option
Online Utilities Menu 321
Parameter Prompting Entry Panel 335
Primary Option Menu 87
Exit Window
Job List Screen 150
Rule List Screen 259
Exiting
CMEM Entry Panel 260
CMEM Rule Facility 258
CMEM Rule List 259
CMEM Table List 260
Define Parameters in Master Plan 355
IOA Log Show Screen Window 301
Job List 151
Job Scheduling 149
Quick Schedule Definition 369
Scheduling Definition 149
Show Screen Filter 197
Exits
CTMX015C 564
CTMX015O 564
External Tape
Example 792
F
F Option
Active Environment Screen 181
Job List Screen 127
Table List Screen 117, 123, 152
FAILED REASON UNKNOWN Status
Activate Option 180
Fast Exit
Online Facility 92
Fetch a Plan
CTMFETCH CLIST 825
Parameter Prompting 356
FETCH A PLAN Option
Parameter Prompting 823
FieldSensitive Help
Online Facility 100
File Name
DO SYSOUT Statement 475
SYSOUT Parameter 633
File Prefix
Parameter Prompting 338
File Transfer
Example 689
File Transfer to PC
PC PACKET STATUS Option 689
Filter
Job Dependency Network 236, 238
FILTER Field
Active Environment Screen 169
IOA Log Show Screen Window 296
Show Screen Filter 193, 297
Filtering
Active Environment Screen 189
Log Screen 293
FIND Command
Description 98
Graphic Jobflow Screen 159
KSL 866
PF05/ PF17 94, 160
Flow Commands
KSL 859, 867
FLUSH Code
+EVERY Step 541
ON Parameter 544
FLUSH Value
PREVENT-NCT2 Parameter 576
FORCE Code
ON Statement 539
Force Job
CMEM 667
FORCE OK
ANYSTEP 241
Force OK
%%JOBCC 742
%%MAXRC 742
Cyclic Jobs 241
Group Entity 242
FORCE OK Confirmation Window
Active Environment Screen 242
Description 241
FORCE OK Option
Active Environment Screen 242
FORCE Option
CMEM Table List 248, 262, 668
DO FORCEJOB Statement 444
Job List Screen 117, 127
Manual Scheduling 152
Table List Screen 117, 123, 152
FORCE#RT Installation Parameter 445, 692
FORCE#WI Installation Parameter 445, 692
FORCECode
ONStatementCodes 543
FORCED FROM TIME Field
Parameter Prompting 357
FORCED SCHEDULING Parameter 325
Forcing Jobs
Overview 66
Forecasting
Overview 53, 54
Simulation 53
FR Parameter
Index 1003
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
STEP RANGE Parameter 630
FRCOKOPT Parameter
CTMPARM 241, 544
FREE KSL Command 873
FREE Option
Active Environment Screen 181
Free Tracks
MINIMUM Parameter 527
PDS Parameter 571
FRM Parameter
DO SYSOUT Parameter 476
FROM Class
DO SYSOUT Statement 476, 478
SYSOUT Parameter 633, 636
FROM DATE Field
Date Range Window 162
FROM Field
Zoom Screen 215
FROM STEP Field
Restart Confirmation Window 225
Restart Step List Window 229
From Step/ Proc $FIRST/ $CLEANUP
Rerun/ Restart Window 227
FROM subparameter
INTERVAL Parameter 510
FROM Time
TIME Parameter 648, 650
fromcol Parameter
FIND Command 98
FROMJOB Field
Quick Schedule Definition 365
FTP products
CMEM 677
FUNCTION Field
Prerequisite Condition Utility 323
FUNCTION Parameter
AutoEdit Simulation 329
Functions
IOA Primary Option Menu 87
G
G Option
Table List Screen 123
GDG Adjustment 577
GE Operator
AutoEdit Facility 762
General Job Parameter
Scheduling Definition 131
GENERAL Library
DALIB DD Statement 521
MEMLIB Parameter 519
OVERLIB Parameter 564
GENERAL Message Type
IOA Log Show Screen Window 298
General Parameters
CMEM Rule 680
CMEM Rule Definition 253
Summary 380
General Profile
Active Environment Screen Filter 189, 293
Generation Data Sets
CMEM 677
Generation Dataset (GDG) Adjustment 577
Generic Resource
Example 794
GETFILE KSL Command 873
GLOBAL Control Statement
%%GLOBAL 760
Global Profile
Customizing 81
Global Variable
AutoEdit 734
Backslash Character 743
Distinguishing 749
JCL Setup 748
Resolution 753
Syntax 749
Global Variable Database
Structure 748
Global Variable Extension 920
Global Variable Return Codes
CTMAPI 921
Global Variables
Variable Database Facility 266
Global View Screen
#END Field 200
#EXC Field 200
Active Environment Screen 179
Fields 199
Group Statistics 198
GOING TO START Status
Active Environment Screen 186
GOTO KSL Command 868
Graphic Display
Job Status 179
GRAPHIC FLOW Option
Table List Screen 123, 159
Graphic Jobflow
Display Width 160
Screen 159
Gregorian Date Format
Definition 64
Number of Characters 65
Gregorian Date Standards
Overview 64
GROUP Command
Active Environment Screen 178
Log Screen 292
GROUP Criteria
IOA Log Show Screen Window 299
Group Entity
Deleting a Job 210
1004 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Display 181
Group Scheduling Table 378
Group-Handled Jobs 113
GroupHandled Jobs 68
ON GROUP-END Parameter 551
OUT Conditions 558
Parameters 141
Prerequisite Condition 71
Scheduling Definition 140
Scheduling Definition Screen 141
Statistics Screen 235
Task Type 196
Undeleting 181
Zoom Screen 218
GROUP Field
Active Environment Screen 170
Global View Screen 200
Group Entity 142
Quick Schedule Definition 365
Show Screen Filter 194
Group Handled Jobs 113
Group Name
GROUP Parameter 492
JOBSTART Command 144
GROUP NAME Field
View Graph Screen 202
GROUP NAME Parameter
AutoEdit Simulation 327
GROUP Option
Active Environment Screen 181
GROUP Parameter
CMEM Rule 704
Description 492
Emergency Jobs 645
Example 494
Group Entity 142
MAXWAIT Parameter 516
Group Scheduling
Group Entity 68, 140
Job List Screen 124
Logic 384
MAXWAIT Parameter 516
Option O 152
Parameters 141
Group Scheduling Table
Group Entity 378
Maybe Jobs 812
REMOVE UNSCHED CONDITIONS Field 812
Group Statistics
Global View Screen 198
View Graph Screen 200
Group Status
Global View Screen 200
Group-Handled Jobs 113
Groupname Argument
JOBSTART Command 175
GroupHandled Jobs
Description 68
GRP Entry
Active Environment Screen 181
GRP HELD Status
Active Environment Screen 186
GRP MAXWAIT Parameter
Description 495
Group Entity 142
GRP MAXWAIT parameter 496
GRP Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
GRPRECHK Parameter
CTMPARM 114
GT Operator
AutoEdit Facility 762
H
H Option
Active Environment Screen 180
HALF Page
Scrolling Amount 97
HEADERLINE KSL Command 871
HEADERSIZE KSL Command 871
HELD Class
DO SYSOUT Statement 476
Held Class
SYSOUT Parameter 634
HELD Status
Active Environment Screen 186
CMEM On Spool Job 672
Job Deletion 210, 242
Help
Line Sensitive 100
Online Help 101
HELP Command
PF01/ PF13 94, 100
Hexadecimal Value
Special Characters 82
HILITE KSL Screen Attribute 868, 869
HIST Installation Parameter
CONTROL-M/ Restart 48
HIST parameter 400
HISTORY Command
Active Environment Screen 174
History Environment Screen 239
Options 240
RESTORE Option 241
History Jobs File
# OF DAYS TO KEEP 594
# OF GENERATIONS TO KEEP 596
Description 48
History Jobs file 400
History Jobs file and 400
HLDCLAS Installation Parameter
Index 1005
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DO SYSOUT Statement 476
SYSOUT Parameter 634
HOLD Option
Active Environment Screen 180
HOLDFRUP
KSL Script 879
Host Node
NJE Network 51
I
I Option
Job List Screen 127
Parameter Prompting 342
I1 ISPF Utility
Add Prerequisite Condition 321
Check Prerequisite Condition 321
Delete Prerequisite Condition 321
I1 Option
Online Utilities Menu 322
IBM
3720 Terminals 82
IBM FTP
CMEM 678
IDMS/ DC 81
PF06/ PF18 94
IEF125I Message
ON DSNEVENT Statement 714
IEF403I Message
ON DSNEVENT Statement 714
IEFPROC Stepname
ON DSNEVENT Statement 713
ON STEP Statement 721
IF Logic
Example 800
IFSCREEN KSL Command 868
IFVAR KSL Command 870
IGD101I message 676
IGD104I message 676
IGD105I message 677
IGD107I message 677
IGD108I message 677
IGD17101 message 677
IGNORE DSN Parameter
Tape Pull List 848
IGNORE IN Parameter
IOALDNRS Utility 821
IGNORE JOB Parameter
Tape Pull List 848
Implementation
Job Scheduling 804
Manual Conditions 809
Parameter Prompting 816
IMS/ DC 81
PF06/ PF18 94
IMSACTIVE
Prerequisite Condition 560
IN Condition
Erased Automatically 393
IOALDNRS Utility 809
Job Dependency 236
IN Parameter
COND-NAME Subparameter 497
DATEREF Subparameter 498
Description 497
Example 503
Logic 500, 507
Long Condition Names 497, 499
Quick Schedule Definition 362
IN PROCESS Status
Show Screen Filter 195
IN Statement
Manual Conditions 284
Prerequisite Condition 69
INCLIB Control Statement
%%INCLIB 764
INCONTROL
Core Description 61
INFO Command
Primary Option Menu 87
Information about Job
DESC Parameter 432
Input Files
Simulation 835
Input Registers
CTMAPI 904
INQ/ UPD MEDIA DB Option
Primary Option Menu 90
INSERT BY WEEK DAYS Option
Year List Screen 309
Insert Command
Edit Environment 938, 951
INSERT Option
CMEM Rule List 250
Job List Screen 115, 127
Parameter Prompting 342, 355
Year List Screen 308
Inserting
Relevant Screen or specific item to insert 309
Inserting Additional Job 69
Installation Working Date
Working Date 739
Interval
Periodic Calendar 314
INTERVAL Parameter
Description 509
Example 511
FROM Subparameter 510
INTERVAL Subparameter 509, 510
RERUNMEM Parameter 586
Simulation 837
Simulation/ Tape Pull 333
TASKTYPE Parameter 644
1006 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
INTERVAL Subparameter
INTERVAL Parameter 509, 510
INTRDR Internal Reader
Submit Authority 331
Tape Pull List 846
INVOKE JOB/ SCAN
Simulation/ Tape Pull 334
Tape Pull List 850
IOA
Conditions File 61
Customization 80
Display Format Members 81
Log File 61
Manual Conditions File 61
Primary Option Menu 85
Under ISPF 102
IOA Calendar Facility
Calendar Facility 301
IOA Conditions
File 275
IOA Conditions File 275
IOA Conditions/ Resources
Screen 275
IOA Conditions/ Resources File 275
IOA Conditions/ Resources Screen
Description 275
Manually Releasing Jobs 393
IOA Core
Description 61
IOA Editor 104
Command line commands 105
Edit Entry Panel 104
EDMEM command 104
PFKey functions 105
Row commands 106
IOA Editor screen 104
IOA Entry Panel 84
IOA Global Variable Database
AutoEdit 734
Structure 748
IOA KSL Library
KSL Scripts 878
IOA KSL library 857
IOA Log Facility 289
Description 49
Post-processing 49
IOA Log Screen
DISPLAY Command 293
Messages 300
IOA Log Show Screen Window
Activating 294, 296
Activating Filters 294
Active Environment Screen 296
DESC 297
Exiting 301
Fields 296
Message Types 300
IOA Manual Conditions 60
IOA Manual Conditions Screen
Manually Releasing Jobs 393
IOA Primary Option Menu 85
Option 6 320
Option 7 284
Option F 89
Option S 289
PC PACKET STATUS 89
IOA SAMPEXIT Library
SAMPEXIT Library 521
IOA SAMPLE Library
KSL Scripts 878
IOA SAMPLE library 857
IOA SET 107
IOA Variable Database 920
IOA Variable Database Facility 265
Entry Panel 267
IOA Variables Database
CTMAPI and 886
IOA Variables Facility
Entry Panel 267
IOA_SAMPLE Library
KSL Scripts 878
IOA125I message 675, 676
IOA283I message 676
IOA285I message 676
IOA287I message 676
IOA403I message 675, 676
IOAAPI Functions 887
IOADFLT Parameter
IOAENV Library 423
IOADLD Utility
Variable Database Facility 272
IOADUL Utility
Variable Database Facility 272
IOAID Field
Conditions/ Resources 276
IOALDNRS Utility 284
Manual Conditions 809, 817
Parameter Prompting 821
IOALog Screen 59
IOANOTE Utility
Tasktype WRN 645
IOARKSL Procedure
KSL 858
IOASE07 Security Exit 922
IOAUTIL CLIST
Online Utilities 320
IOAVAR
Variable Database Facility 266
IOAVARLD Job
Variable Database Facility 272
IOAVARUL Job
Variable Database Facility 272
ISPF 96
AutoRefresh Mode 102
Index 1007
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
PACK Option 302
ISPF Commands
Priority 103
ISPF PACK Option 524
Scheduling Definition 112
ISPF SPLIT Command
PF02/ PF14 94
ISPF/ PDF Facilities
Online Facility 109
ISPF/ PDF Primary Option Menu
ISPF KEYS Command 103
ISPSTART Command
ISPF Keys 103
IV Option
IOA Primary Option Menu 266
J
J Option
Active Environment Screen 182
Job List Screen 128
JCL
Editing 182
JCL Check Field
Simulation/ Tape Pull 335
JCL Command
Job List Screen 116
JCL Documentation
DOCU/ TEXT Product 374
JCL Edit
Active Environment Screen 182
Job List Screen 128
JCL Error
Intentional 754
ON Statement 541
JCL ERROR Status
Show Screen Filter 195
JCL Expanded
SYSDATA 67
JCL Library
CTMQSB Command 806
OVERLIB Parameter 563
PPF2DAY Job 832
PPF2DEL Job 831
JCL Library Mode
AutoEdit Syntax Testing 326, 782
Parameters 327, 716
JCL LIBRARY Parameter
AutoEdit Simulation 327
JCL Management
CMEM On Spool Job 673
JCL Member
OVERLIB Library 563
OVERLIB Parameter 328
RERUNMEM Parameter 585
JCL Modification
OVERLIB Parameter 563
JCL Option
Active Environment Screen 182
Job List Screen 128
JCL SET
AutoEdit SET Statement 759
JCL Setup
%%ELSE Control Statement 761
%%ENDIF Control Statement 761
%%GLOBAL Control Statement 760
%%GOTO Control Statement 761
%%IF Control Statement 761
%%INCLIB Control Statement 764
%%INCMEM Control Statement 764
%%LABEL Control Statement 761
%%LIBSYM Control Statement 765
%%MEMSYM Control Statement 765
%%RANGE Control Statement 766
%%RESOLVE Control Statement 767
%%SET Control Statement 769
AutoEdit 46, 770
Control Statement 760
CTMAESIM Utility 782
Date Variable 739, 787
DO SET Statement 754
Global Variable 748
Local Variable 745
Modification 563, 733
Nested Expressions 763
Operators 762
Syntax Checking 782, 845
Sysout Archiving 785
System Variable 737
UserDefined Variable 743
Variable Resolution 755
Work Flow 753
JCL Statement
MEMNAME Parameter 524
Syntax Checking 782, 845
JCL Syntax
Checking 782, 845
CTMSCIM Utility 331
JCLFILE Parameter
DAJCLOUT DD Statement 849
Tape Pull List 848
JES HOLD Command
Job Status 186
JES Initialization
SYSDATA Output Class 68
JES Instruction
DO SYSOUT Statement 478
SYSOUT Parameter 636
JES Spool
ON JOBARRIV Statement 716
JES2
cpuid 520
DO SHOUT Statement 468, 698
1008 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DO SYSOUT Statement 476
SHOUT Parameter 621
SYSOUT Parameter 634
JES3
cpuid 520
DO SHOUT Statement 468, 698
DO SYSOUT Statement 476
SHOUT Parameter 621
SYSOUT Parameter 634
JESDS Subparameter
SYSDATA Output Class 68
JESYSMSG 674, 676
JFAIL Code
ON Statement Codes 543
JFAIL Status
Description 388
JLOST Code
ON Statement Codes 543
JLOST Status
ON Statement 539
JNRUN Status
Description 388
ON Statement 539
JNSUB Code
ON Statement Codes 543
JNSUB Reason
NOT SUBMITTED Status 754
JNSUBStatus
ONStatement 539
Job
Displaying Jobflow 116
Displaying Statistics 116
Job Activation Option
Active Environment Screen 180
Job Arrival Event
CMEM 666, 716
DO FORCEJOB Statement 691
Job Arrival Rules
CMEM On Spool Job 673
Job Chain
DO COND Statement 441
IN Parameter 505
Job Copying 157
Job Deletion
Active Environment Screen 210, 242
Undeleting 181
Job Dependency
%%PLANID 827
Critical Path 74
Job Flow 75
Maybe Job 811
Predecessor/ Successor Job 75
Prerequisite Condition 71, 498
REFRESH Command 175
Job Dependency Network
Commands 239
Description 236
NET Option 181
Quick Schedule Definition 366
Job Documentation
DESC Parameter 432
Documentation 146, 147
Job End Event
CMEM 666, 708
Job Execution Time
DUE OUT Parameter 490
Job Filter
Log Screen 212
Job Flow
Adjustment 58, 74
DUMMY Jobs 394
ELAPSE Time 75
Manual Modification 76
Job Flow Report
Prerequisite Condition 75
Job Forcing
CMEM On Spool Job 673
Definition 66
Logic 673
Job Graph
ENDED OK Status 241
JOB GRAPH Line
View Graph Screen 202, 204
Job Interdependency
Job Dependency 366
Job List Exit Window
Table Creation 114
Job List Screen
Commands 126
COPY Option 116
Copying Jobs 157
Delete Job 124
Description 124
Edit JCL 128
Exiting 150
Fields 367
Format 125
Job Ordering 805
Manual Job Scheduling 151
Options 116, 126, 368
Quick Schedule Definition 366
Scheduling Definition 114
Job Log
SYSDATA 67
Job Name
Example 794
Job Scheduling Plan Screen 164
MEMNAME Matching 673
JOB NAME Parameter
AutoEdit Simulation 328
Description 324
ON JOBARRIV Statement 716
ON JOBEND Statement 718
Parameter Prompting 353
Index 1009
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Job On Spool
On Spool Job 670
Job Order Execution History Screen
Active Environment Screen View Option 181
Description 229
Fields 230
JOB ORDER ISSUE Option
Online Utilities Menu 321
Job Ordering 151
Definition 66
End User Job Order 371
Example 791
Job Order Panel 805
Order ID 67
Quick Submit Command 805
Special Purpose Job 807
Utility 323
JOB Parameter
DO FORCEJOB Statement 444, 690
ON STEP Statement 720
Job Parameters
Scheduling Definition 131
Job Priority
Priority... 74
Job Production
Scheduling ... 379
Job Reactivate Option
Active Environment Screen 180
Job Request Utility Screen Parameters 324
Job Rerun 66
MAXRERUN Parameter 512
Job Restart 66
Job Run Statistics
Statistics Screen 233
JOB SCAN
AutoEdit Simulation 329
JOB SCHEDULE DEF Option
IOA Primary Option Menu 87
Job Scheduling 151
Alternative Methods 804
AutoEdit Facility 735, 784
CTMAJO Program 807
CTMJOB 804
CTMQSB Command 805
Implementation 805
Screen 128
Special Purpose Job 804
Table List Screen 805
Job Scheduling Definition
Calendar Facility 52
CMEM Rule 671
Commands 143
Group-Handled Jobs 113
New Day Processing 45
Parameters 43
Storing 44
job scheduling definition
DOC Lines 488
Job Scheduling Plan
Calendar Format 162
Screen 163
Job Status
Active Environment Screen 185
Description 387
JOB STATUS Field
Global View Screen 200
JOB STATUS Option
IOA Primary Option Menu 88
Job Submission
Manual Confirmation 407, 448
Scheduling Criteria 47
Job Sysout
Sysout... 67
JOB Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
Job Task Type
TASKTYPE Parameter 643
Job Termination
DO STOPJOB Statement 702
ON JOBEND Statement 718
JOB TYPE Parameter
ON JOBARRIV Statement 716
Job Type Parameter
ON JOBEND Statement 718
Job Undeleting 181
JOB WAIT FOR PIPES COLLECTION
Why Screen 206
JOB/ SCAN Product
AutoEdit Simulation 329
JOB/ SCAN-DOCU/ TEXT
Simulation/ Tape Pull 330
JOB/ SCANDOCU/ TEXT
INVOKE JOBSCAN Parameters 849
Tape Pull List 849
JOBARRIV Statement 253
JOBEND Statement 253
Jobflow
Graphic Display 159
JOBID Field
Active Environment Screen 170
Statistics Screen 234, 235
Zoom Screen 214
JOBNAME Criteria
IOA Log Show Screen Window 299
JOBNAME Field
Active Environment Screen 170
Job Order Execution History 231
Zoom Screen 214
JOBNAME Parameter
ON DSNEVENT Statement 711
Jobs Left Field
Simulation/ Tape Pull 334
JOBSTAT Command
1010 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Active Environment Screen 175
Job Scheduling Definition Screen 144
JODID Field
Job Order Execution History 231
Joining
Concatenation 756
Journal File
Overview 62
Journaling
Description 49
JRNL Installation Parameter
Journalling 49
JSECU
ON Statement Codes 543
JSECU Status
ON Statement 539
JTYPE Parameter
ON DSNEVENT Statement 711
ON JOBARRIV Statement 716
ON JOBEND Statement 718
ON STEP Statement 720
Julian Date
%%$CALCDATE 961
JCL Setup 740
Julian Date Format
Definition 65
Julian Date Standards
Overview 65
K
Keyboard Character
Hexadecimal Value 82
KEYS Command
ISPF/ PDF Primary Option Menu 103
KOA Recorder Option
Primary Option Menu 90
KSL
AutoEdit Facility 955
AutoEdit Variables 861
Commands 859, 866
Description 857
Flow Commands 859, 867
Overview 55
Principles of Operation 861
Print Commands 859, 871
Processing Commands 860, 873
Reports 878
Sample Script 861, 862
Screen Commands 866
Scripts 858
Special Variables 860
Started Task 858
Syntax 864
Utilities 864
Variable Resolution 959
Variables 859, 866, 876
KSL ADDMNCND Utility
Maybe Jobs 812
KSL Library
KSL Scripts 878
KSL mixed case support 857
KSL Sample Report
Example 880
KSL Sample Script
Example 880
KSL Script
Library Member 862
KSL scripts
libraries 857
KSL Variables
KSL Script 860, 876
Special 877
L
L Command
Parameter Prompting 341, 345, 354
L Option
Active Environment Screen 180, 212
LABEL Control Statement
%%LABEL 800
LABEL KSL Command 870
Last Working Date
Example 790, 796
LATE EXECUTION Status
Active Environment Screen 186
LATE Field
Job Dependency Network 238
Show Screen Filter 192
LATE Status
Active Environment Screen 186
LATE SUBMISSION Status
Active Environment Screen 186
LATE TIME Value
SHOUT Parameter 619
LATESUB Value
SHOUT Parameter 619
LE Operator
AutoEdit Facility 762
Leap Year
Definition 773
LEFT Command
PF10/ PF22 94
LEVEL Field
Job Dependency Network 238
LIBRARIAN 520, 564
Job Documentation 148
Library
IOA_SAMPLE 878
KSL 878
Maintenance 527, 571
Index 1011
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
LIBRARY Field
Calendar Facility Entry Panel 304
CMEM Entry Panel 246
CMEM Rule Exit Option 259
Exit Option Window 151
Parameter Prompting 339, 350
Quick Schedule Definition 363
LIBRARY Parameter
DO FORCEJOB Statement 444, 690
DO RULE Statement 694
Save Documentation Window 149
Line Editing
Edit Environment 935, 937, 949, 950
Example 940
Job List Screen 368
Line Editing Commands 937, 950
Line Number Field
Quick Schedule Definition 367
Linking
Concatenation 755
LIST Function
AutoEdit Simulation 329
LIST Value
PREVENT-NCT2 Parameter 576
LOADGLOBAL Operator Command
Variable Database Facility 274
Loading toCache
%%GLOBAL Members 746
Local Variable
AutoEdit 734
Distinguishing 749
JCL Setup 745
LOCATE Command
Description 97
Location Commands
Edit Environment 938, 952
LOCKED KSL Screen Attribute 868
Log File 61
CONTROL-M Log Screen 212
IOA Log Screen 290
LOG Mode
CMEM Rule Simulation 706
LOG Option
Active Environment Screen 180, 212
Primary Option Menu 87
Log Screen
CATEGORY Command 292
Commands 292
CONTROL-M Log Screen 212
Description 289
Example 93
Fields 290
Filtering 293
GROUP Command 292
IOA Log Screen 290
Job Messages 290
MESSAGE TYPE Codes 298
Overview 59
Stacking Multiple Jobs 212
Long Condition Names
DO COND Parameter 436, 440
IN Parameter 497, 499
OUT Parameter 554, 557
Long Prerequisite Condition
Adding 279
LT Operator
AutoEdit Facility 762
M
M JOB Message Type
IOA Log Show Screen Window 298
M1 Option
Online Utilities Menu 323
M2 Option
Online Utilities Menu 325
M3 Option
Online Utilities Menu 330, 848
M4 Option
Online Utilities Menu 335
M5 Option
Online Utilities Menu 361
M6 Option
Online Utilities Menu 371
Mail Prefix Value
DO SHOUT Destination 468, 698
MAILDEST 470, 624
MAILDEST table 470, 624
Main Menu
IOA Primary Option Menu 85
Maintenance
Libraries 527, 571
MAINVIEW Batch Optimizer (MVBO)
CONTROL-M Support 55
Implementation 813
PIPE Parameter 573
System-Related Considerations 815
MAINVIEW Batch Optimizer (MVBO) Option
Active Environment Screen 184
Manual Conditions
Add Condition 286
Description 284
Fields 285
Loading 809
Maybe Job 809
Options 287
Overview 60
Unscheduled Condition 809
Manual Conditions File 61
Manual Intervention 809
Unscheduled Conditions 810
Manual Confirmation
CONFIRM Parameter 407
1012 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DO IFRERUN Statement 448
Rerun Confirmation 222
Restart Confirmation 223
Manual Intervention
IN Parameter 499
OUT Parameter 555
Prerequisite Condition 60, 72
Manual Job Ordering 151
Manual Job Release 393
Manual Job Scheduling 151
Manual Rerun
MAXRERUN Parameter 513
Manual Reruns
Rerun Confirmation 222
Restart Confirmation 223
Masking
Description 83
ON Statement 710
ON Statement CODES 546
Master Console
SHOUT Parameter 620
Master Plan
Parameter Prompting 349, 822
Master Plan PREFIX
Parameter Prompting 356
Master Scheduling Table
Parameter Prompting 822
Master Table Creation
Parameter Prompting 338
MAX
Scrolling Amount 97
MAX Field
Conditions/ Resources 277
MAX RC Field
Job Order Execution History 231
MAXCCOK Parameter
CTMPARM 544
MAXCOMMAND Command 870
MAXDAYS Parameter
AUTOARCHIVE Parameter 399
MAXRERUN Limit
Manual Job Rerun 222
MAXRERUN Parameter
Description 512
RERUNMEM Parameter 586
MAXRUNS Parameter
AUTOARCHIVE Parameter 399
MAXWAIT Parameter 517
Basic Scheduling Criteria 385
Description 515
Example 517
Maybe Dependency
Maybe Job 73
Unscheduled Condition 811
Maybe Job
@OUT Conditions 811
ADDMNCND Utility 812
Group Scheduling Table 812
Job Dependency 73
Manual Conditions 809
Prerequisite Condition Prefix 811
MAYBEJOB
KSL Script 879
MCT
Simulation 841
MCTSMIND
Simulation 841
MEM/ MIS Criteria
IOA Log Show Screen Window 299
MEMBER NAME Parameter
AutoEdit Simulation 327
MEMBER Parameter
Save Documentation Window 149
Member Specification
%%GLOBAL Control Statement 760
MEMBLIB Parameter
PSEUDO Jobs 394
MEMLIB Library
COPMEM2O Parameter 564
JCL Member 182
MEMLIB Parameter
AutoEdit Variable 785
Daily JCL Library 830
Description 519
DUMMY Jobs 394
Example 522
Job 519
OVERLIB Parameter 563
Started Task 520, 522
System Variables 735
MEMNAME Criteria
Active Environment Screen Filter 193
IOA Log Show Screen Window 299
MEMNAME Field
CMEM Rule 671
Global View Active Environment Screen 200
Group Entity 142
Job Name Matching 673
Job Order Execution History 230
Quick Schedule Definition 367
Show Screen Filter 193
MEMNAME Parameter
D-CAT Parameter 416
Description 524
Example 525
Group Entity 142
MAXRERUN Parameter 513
OVERLIB Library 563
Scheduling Definition 127
MEMNAME Value
CMEM On Spool Job 671
DOCMEM Default 488
Job Scheduling 808
Simulation 838
Index 1013
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
MEMSYM Control Statement
%%MEMSYM 765
Message Content
Group Name 493
MESSAGE Field
Log Screen 291
Parameter Prompting 354, 360
Message File
Simulation 840
Message Generation
DO SHOUT Statement 466
DO Statement 434
SHOUT Parameter 618
Message Handling
Log File 59, 289
Shout Facility 48
Message Line
Online Facility 92
MESSAGE Parameter
DO SHOUT Statement 699
Message Type
IOA Log Show Screen Window 300
Message Type Criteria
IOA Log Show Screen Window 298
MESSAGE TYPE Field
Screen Filter 298
Messages
Log File 300
MINIMUM Parameter
CONFCAL Parameter 404
DATES Parameter 418
DAYS Parameter 424
Description 527
Example 528
MONTHS Parameter 529
PDS Parameter 571
WDAYS Parameter 658
M-INT Message Type
IOA Log Show Screen Window 298
MINUS Operator
%%MINUS 770
Minus-One
Multiple CONTROL-M Monitors 55
Minus-One Support
CTMPLEX 55
Sysplex 55
MISSION DEF Option
Primary Option Menu 89
MISSION STATUS Option
Primary Option Menu 89
Mission, CONTROLM/ Analyzer
CTB STEP Parameter 413
MODE Parameter
CMEM Rule 706
Example 707
Monochrome Terminal
Color Support 82
Graphic Jobflow Screen 160
Month Field
Job Scheduling Plan Screen 164
MONTHS Parameter
DATES Parameter 418, 529
Description 529
Example 529
MINIMUM Parameter 527
PDS Parameter 571
Periodic Value 424, 658
Move Commands
Edit Environment 938, 951
MPP
Master Prompting Plan 822
MS Parameter
SHOUT Parameter 622
MSG Library
Help Member 101
MSG STATISTICS Option
IOA Menu 89
MSGCLASS Parameter
SYSDATA Output Class 68
MSGCLASS Sysout
CMEM On Spool Job 670
DO SYSOUT Statement 478
SYSOUT Parameter 633, 635
MSGLEVEL=1,1
ON DSNEVENT Statement 714
MSTJCLB Parameter
CTMFETCH CLIST 826
Multi-Screen Control
Transfer Command 91
MVS MODIFY Command
protecting 263
MVS MODIFY command
Order or Force request 263
N
N Option
Active Environment Screen 181
N Qualifier
DO Statement 546
NAME Field
Active Environment Screen 170
Change Resource Window 283
Job Dependency Network 238
Manual Conditions Window 287
NAME Parameter
CTB STEP Parameter 413
NE Operator
AutoEdit Facility 762
Nested Expressions
JCL Setup 763
NET Argument
REFRESH Command 175, 239
1014 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
NET Option
Active Environment Screen 181, 236
NEW COND Command
Manual Conditions 286
New Day Procedure
"Shifted" for SHOUT purposes 623
ODATE 63
SHOUT jobs 623
SHOUT WHEN LATE Message 623
SHOUT WHEN LATESUB Message 623
New Day Processing
Description 45
NEW LCOND Command
Manual Conditions 286
NEW PASSWORD Field
IOA Entry Panel 85
NEWJOB Parameter
Simulation 838
Next
SAC Parameter 601
NEXT Command
Job Scheduling Plan 163
PF11/ PF23 94
Scheduling Definition 145, 150
NEXT TIME Field
Zoom Screen 217
NEXT Value
Schedule Date 437, 555
NEXTYEAR (PF11/ PF23) Command
Calendar Definition Screen 318
Night Schedule Field
Simulation/ Tape Pull 334
NJE Enhanced Tracking Support 674
NJE Field
Zoom Screen 216
NJE Job
CMEM On Spool Job 669
NJE JOB Status
Active Environment Screen 186
NJE Network
CONTROL-M Monitor 51
NJE NODE Parameter
Format 532
Under JES2 532
Under JES3 532
node ID
JES2 520
NODE NAME Field
Zoom Screen 216
NonColor Display
Monochrome Terminal 82
Nonperiodic Calendar
DCAL Parameter 422
WCAL Parameter 656
Nonperiodic Scheduling
Format 656
NOT CATLGD 2
CMEM 666
DO STOPJOB Statement 703
Job Status 185
NOT CATLGD2 error prevention 577
NOT FOUND Status
Active Environment Screen 187
NOT OK Status
Show Screen Filter 195
NOT STARTED Status
Active Environment Screen 187
NOT SUBMITTED Status
Active Environment Screen 187
JNSUB Reason 754
NOTE
Zoom Screen 215
NOTE Command
Active Environment Screen 176
Zoom Screen 219
NOTE Field
Active Environment Screen 170
NOTE Status
Active Environment Screen 187
NOTOK
Description 454
NOTOK Status
Description 388
Group Entity 140, 143
ON Statement 539
NOTOK Value
ON Statement Codes 544
SHOUT Parameter 619
NR Field
Quick Schedule Definition 367
NULL Value
%%$PARSE Function 965
Numeric Pattern
%%$PARSE Function 968
O
O Option
Active Environment Screen 241
Job List Screen 127
Table List Screen 152
OBJECTS Option
IOA Primary Option Menu 89
OCCUR NO Suffix
AutoEdit Parameter 830
OCCUR NO. Field
Parameter Prompting 352, 360
ODAT
IN Parameter 498
Prerequisite Condition 71
Schedule Date 437, 555
ODATE
Assignment 63
Index 1015
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DAYTIMEM Parameter 64
Definition 62
DO FORCEJOB Statement 444
Example 787
GRP MAXWAIT Parameter 495
Job Eligibility 64
MAXWAIT Parameter 515
Meaning 63
New Day Procedure 63
RUN Attribute 64
System Variable 740
VALUE Attribute 64
ODATE Field
Active Environment Screen 170
Global View Screen 200
Job Order Execution History 230
Log Screen 291
Parameter Prompting 357
Scheduling Confirmation 154
Show Screen Filter 197
Zoom Screen 214
ODATE Parameter
AutoEdit Simulation 328
OF Field
Parameter Prompting 346
OIDL Command
Active Environment Screen 179
OK Status
Description 388
Group Entity 140, 143
ON Statement 539
PostProcessing Parameters 388
OK Value
ON Statement Codes 543, 544
SHOUT Parameter 619
OLDJOB Parameter
Simulation 838
ON Block
ON Statement 537
ON CODE Parameter
ON Statement 534
ON DSNEVENT Statement
And/ Or/ Not Parameter 713
CMEM Parameters 680
CMEM Rule 666, 668, 708, 711
CMEM Rule Definition 253
CMEM support 674
Dataset Event 711
Example 715
MSGLEVEL=1,1 714
RUNTSEC=TRIGGER 726
ON GROUP-END Parameter
Group Entity 379
ON GROUPEND Parameter
Definition 551
Group Entity 143
ON JOBARRIV Rule
CMEM Rule 669
DO FORCEJOB Statement 692
ON JOBARRIV Statement
CMEM Parameters 680
CMEM Rule 666, 670, 708, 716
CMEM Rule Definition 253
Example 717
Job Arrival 666
ON JOBEND Statement
CMEM Parameters 680
CMEM Rule 666, 708, 718
CMEM Rule Definition 253
Example 719
Job End 666
RUNTSEC=TRIGGER 726
ON OUTPUT Q Status
Show Screen Filter 195
ON OUTPUT QUEUE Status
Active Environment Screen 187
ON PGMST ANYSTEP
DO CTBRULE Statement 442
ON Statement 534
ON PGMST Indicator
Zoom Screen 217
ON PGMST Parameter
ON Statement 534
ON PGMST Statement
Combinatorial Logic 218
Step Range 630
On Spool Job
CMEM Facility 52
CMEM Rule 667
Components 670
DO FORCEJOB Statement 691
Forcing Logic 672
Job Flow 671
NJE Job 669
ON JOBARRIV Statement 717
Status 188
TYPERUN=HOLD 670, 674
ON Statement
* Character 539
+EVERY 536
CMEM Parameters 680
CMEM Rule 708
CMEM Rule Definition 253
Codes 541
CODES Parameter 536
Combinatorial Logic 709
Conditional Processing 388
Description 534
Example 539, 548
Logic 536, 546
Masking 710
Multiple 537
PGMST Parameter 534
PROCST Parameter 535
1016 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Specified Step 538
ON Statement Codes
***** Code 542
FORCE Code 543
ON STEP Statement
CMEM Parameters 680
CMEM Rule 666, 720
CMEM Rule Definition 253
CMEM support 674
Online Facility
Active Environment Screen 164
Documentation 146
Exiting 92
Help Screen 100
Overview 56, 80
Tracking and Control 58
TSO Application 110
Under ISPF 102
Online Utilities Menu
Utility Screen 60, 321
OP Parameter
SYSOUT Parameter 633
OPENFILE KSL Command 873
OPER Value
DO SHOUT Destination 467, 875
SHOUT Parameter 620
OPER2 Value
DO SHOUT Destination 467, 875
OPT Command
Active Environment Screen 172
OPT Field
Conditions/ Resources 276
Manual Conditions 285
Rule List Screen 248
OPT Parameter
DO SYSOUT Statement 475
opt Parameter
DO COND Statement 438
OPT Subparameter
DO COND Parameter 438
OUT Parameter 555
Option ?
Active Environment Screen 180, 205
Option 1
Parameter Prompting Entry Panel 335
Parameter Prompting Type 1 Menu 338
Parameter Prompting Type 2 Menu 349
Option 2
IOA Primary Option Menu 87
Parameter Prompting Entry Panel 335, 349
Parameter Prompting Type 1 Menu 338, 344
Parameter Prompting Type 2 Menu 349, 356
Primary Option Menu 57, 112, 118
Option 3
IOA Primary Option Menu 88
Parameter Prompting Type 2 Menu 349, 357
Primary Option Menu 58, 164
Option 4
Primary Option Menu 87
Option 5
Primary Option Menu 59, 87, 290
Option 6
Online Utilities 103
Primary Option Menu 60, 87, 320
Option 7
Primary Option Menu 60, 87, 284
Option 8
Primary Option Menu 60, 87
Option A
Active Environment Screen 180
Job List Screen 369
Manual Conditions 288, 810
Parameter Prompting 342, 355
Primary Option Menu 89
Why Screen 206
Option B
CMEM Table List 248
Job List Screen 369
Table List Screen 122
Option BA
Primary Option Menu 89
Option BB
Primary Option Menu 89
Option BM
Primary Option Menu 89
Option BR
Primary Option Menu 89
Option BV
Primary Option Menu 89
Option C
Active Environment Screen 182
IOA Primary Option Menu 88
Job List Screen 128, 250, 369
Primary Option Menu 59, 243, 246
Option Code
DO SYSOUT Statement 475
SYSOUT Parameter 633
Option D
Active Environment Screen 181, 241
CMEM Rule List 250
CMEM Table List 248, 260
Conditions/ Resources 281
Job List Screen 127, 369
Parameter Prompting 342, 355
Table List Screen 123, 158
Why Screen 207
Option E
Active Environment Screen 182
Display Filters window 191
Manual Conditions 288
Option F
Active Environment Screen 181
AutoEdit Variable 785
CMEM Table List 248, 262
Index 1017
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
IOA Primary Option Menu 89
Job List Screen 127
Manual Scheduling 152
Primary Option Menu 89
Restart Step List Window 229
Table List Screen 116, 123
Option Field
Active Environment Screen 170
Job Dependency Network 238
Quick Schedule Definition 367
Option G
Active Environment Screen 181
Table List Screen 123, 159
Option H
Active Environment Screen 180
Option I
CMEM Rule List 250
Job List Screen 127, 369
Parameter Prompting 342, 355
Option I1
Online Utilities Menu 321, 322
Option IV
IOA Primary Option Menu 87
Option J
Active Environment Screen 182
Job List Screen 128
Option L
Active Environment Screen 180, 212
Option M
Job List Screen 369
Primary Option Menu 89
Option M1
Online Utilities Menu 321, 323
Option M2
Online Utilities Menu 321, 325
Option M3
Online Utilities Menu 321, 330, 848
Option M4
Online Utilities Menu 321, 335
Option M5
Online Utilities Menu 321, 361
Option M6
Online Utilities Menu 321, 371
Option N
Active Environment Screen 181, 236
Option O
Active Environment Screen 180
Group Scheduling 152
Job List Screen 127
Manual Scheduling 152
Restart Step List Window 229
Option OA
IOA Menu 89
Option OC
Primary Option Menu 90
Option OK
Primary Option Menu 90
Option OL
IOA Menu 89
Option OM
IOA Menu 89
Option OR
IOA Menu 89
Option OS
IOA Menu 89
Option P
Job List Screen 128, 162, 369
Option R
Active Environment Screen 180, 222, 224
Job List Screen 369
Parameter Prompting 342, 355
Primary Option Menu 89
Option R1
Online Utilities Menu 321
Option R2
Online Utilities Menu 321
Option S
Active Environment Screen 181
CMEM Rule List 250
CMEM Table List 248
Display Filters window 191
End User Job Order 372
Job List Screen 127
Job Order Execution History 231
Table List Screen 122
Option T
Job List Screen 128
Primary Option Menu 89
Restart Step List Window 229
Option TC
Primary Option Menu 90
Option TI
Primary Option Menu 90
Option TP
Primary Option Menu 90
Option TR
Primary Option Menu 90
Option TV
Primary Option Menu 90
Option U
Active Environment Screen 181
Primary Option Menu 89
Option U1
Online Utilities Menu 321, 374
Option V
Active Environment Screen 181, 229
Option W
Active Environment Screen 184
Option X
Online Utilities Menu 321
Primary Option Menu 87
Option Z
Active Environment Screen 180
Options
1018 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Activate 180
Active Environment Screen 180
AUTOMATION LOG 89
AUTOMATION OPTION 89
BALANCING DEF 89
BALANCING STATUS 89
CHANGE 281, 283
CLEANUP 321
CMEM 243, 246
CMEM DEFINITION 88
CMEM Rule List 250
CMEM Table List 248
CONFIRM 182
COSMOS Status 90
Cross Memory 94
CTMEXEC 349, 357
CTMFETCH 349, 356
CTMQUICK 362
DB VARIABLE DEF 89
Define Parameters and Conditions 339, 342
Define Parameters in Master Plan 355
DEL 181
DELETE 116, 123, 127, 158, 248, 250, 260, 281, 342, 355
Delete Condition/ Resource 281
Display Filters window 191
DOCU/ TEXT 321
EDIT 128, 182, 191
EXIT 321
FORCE 117, 123, 127, 152, 262
FORCE OK 242
FREE 181
GRAPHIC FLOW 123, 159
GROUP 181
HOLD 180
INSERT 115, 127, 250, 342, 355
IOA Primary Option 87
ISPF PACK 112
ISPF Primary Option Menu 103
JCL 128, 182
Job Activation 180
Job List 116, 126, 368
JOB ORDER ISSUE 321
Job Reactivate 180
JOB SCHED DEF 87
JOB STATUS 88
JOB/ PIPE ACTIVITY 89
KOA Recorder 90
LOG 180, 212
M4 on Online Utilities Menu 335
M6 on Online Utilities Menu 371
MAINVIEW Batch Optimizer (MVBO) 184
MANUAL COND 87
Manual Conditions 287
Master Plan 349
Master Table Creation 338
MSG STATISTICS 89
NET 181
ORDER 117, 127, 152, 248
PACK 112
Parameter Definition 338
Parameter Prompting 321, 338, 342
Parameter Updating 338
PLAN 128, 162
Prerequisite Condition 321, 338
QUICK SCHEDULE 320
Reactivate 180
RERUN 180, 222
RULE ACTIVITY 89
RULE DEFINITION 89
RULE STATUS 89
Table List Screen 122
TERMINATE 180
UNDELETE 181
UPDATE 342, 355
USER INTERFACE 321
VARIABLE DATABASE 87
VIEW 181, 229
WHY 180
Year List Screen 308
ZOOM 180
Order a Job
DO FORCEJOB Statement 444
DO Statement Action 434
Next Day 791
Order Daily Jobs Field
Simulation/ Tape Pull 333
Order Extension
CTMAPI 914
Order ID
Multiple Orders 67
ORDER Option
CMEM Table List 248
Job List Screen 117, 127
Manual Scheduling 152
Table List Screen 117
ORDERID Command
Active Environment Screen 179
ORDERID Field
Active Environment Screen 170
Job Order Execution History 230
Zoom Screen 214
Ordering Jobs 151
End User Job Order 371
Job List Screen 127
Job Ordering Utility 323
Next Day 791
Overview 66
Ordering Rules
CMEM Rule Table 261
ORDERING Status
Active Environment Screen 189
Original Scheduling Date
ODATE 62, 740
OS/ 390 Restart
Index 1019
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
@Character 811
OUT Parameter 975
procstep.pgmstep 976
OUT Condition
@#-procstep.pgmstep 976
Group Entity 558
IOALDNRS Utility 809
Job Dependency 236
OUT Parameter
DATEREF Subparameter 555
Description 554
DO COND Statement 441, 558
Example 559
Job Chain 561
Logic 557
Long Condition Names 554, 557
OPT Subparameter 555
OS/ 390 Restart 975
Prerequisite Condition 498
Quick Schedule Definition 362
OUT Statement
Prerequisite Condition 70
Output Class
SYSDATA 68
Sysout 635
Output Files
Simulation 835
Output Registers
CTMAPI 904
OVERJCLM Parameter 533
OVERLIB Library
COPMEM2O Parameter 564
Deleting JCL Member 564
JCL Member 182, 563
MEMNAME Parameter 564
OVERLIB Parameter
AutoEdit Variable 785
Description 563
Example 568
JCL Member Name 328
OVERRIDE DAILY PLAN Field
Parameter Prompting 356
OVERRIDE DAILY PLAN Options
FETCH A PLAN Screen 828
Overwrite Confirmation
Quick Schedule Definition 365
OWNER Field
Active Environment Screen 170
Job Order Execution History 230
Quick Schedule Definition 363
Show Screen Filter 197
OWNER Parameter
AutoEdit Simulation 327
CMEM Rule 724
Description 569
DO RULE Statement 694
Example 570
P
P Option
Job List Screen 128
PA01PA03 KSL Keys 867
PA1 Key 96
AutoRefresh Mode 102
AutoRefresh Mode 102
PA2 Key 96
PAGE
Scrolling Amount 97
PAGES Field
Job Order Execution History 231
PAGESIZE KSL Command 871
PANVALET
Job Documentation 148
PANVALET Product
CONTROL-M 520, 564
PARAM PROMPTING Option
Online Utilities Menu 321
Parameter
#JNFRT 217
AECACHL 746
AUTOTAPE 235, 589
CTGFORC 417
DUEINCHK 215, 490
FRCOKOPT 241, 544
GRPRECHK 114
IOADFLT 423
MAXCCOK 544
TAGMAXWT 516
Parameter Definition
Parameter Prompting 338, 341, 352
PARAMETER LIBRARY Parameter
AutoEdit Simulation 328
Parameter Passing
MEMLIB Parameter 522
Parameter Prompting
AutoEdit Parameter 342, 346
Daily Prompting Tables 344
Daily Scheduling Table 823
Daily Table 344, 820
Define Parameters Option 339
Definition Phase 822
EXEC Phase 824
FETCH Phase 823
File Prefix 338
IRS Tape Example 816
Master Plan 350
Master Table 338
New Method 818
Old Method 816
Scheduling Table 821
Type 1 338, 816
Type 2 349, 821
Parameter Update
Parameter Prompting 338
1020 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Parameters
Basic Scheduling 132
CMEM Rule Facility 252
Description 391, 682
General Job 131
Group Scheduling 141
Job Scheduling 43
Multiple Occurrences 130
Postprocessing 136
Runtime Scheduling 135
Scheduling Definition 130
Summary 379
Tape Pull List 847
PARM Field
Parameter Prompting 342
PARM NAME Field
Parameter Prompting 352, 360
PARM PREFIX Field
Parameter Prompting 341, 346, 354, 359
Update Parameter Values 360
Parsing Logic
%%$PARSE Function 970
Parsing Template
%%$PARSE Function 966, 969, 971
Parsing Text
%%$PARSE Function 964
Passing Arguments
ARGUMENTS Parameter 413
DO CTBRULE Statement 442
Password
Online Facility 85
PAUSE KSL Command 870
PC PACKET STATUS Option
Primary Option Menu 89
PDS Parameter
CONFCAL Parameter 404
DATES Parameter 418
DAYS Parameter 424
Description 571
MINIMUM Parameter 527
MONTHS Parameter 529
WDAYS Parameter 658
PDSE Library 571
PDSE-type Library
MINIMUM Parameter 527
PDSMAN
$$$SPACE Member 159, 261, 317
PENDING Conditions
Manual Conditions 285
Periodic Calendar 313, 316
DCAL Parameter 423
Example 425, 659
Overlapping 316
WCAL Parameter 657
WDAYS Parameter 424, 658
Periodic Scheduling
Format 423, 657
Periodic Value
MONTHS Parameter 529
PF01/ PF13
HELP Command 94, 100
PF01PF24 KSL Keys 867
PF02/ PF14
ISPF SPLIT Command 94
SHOW Command 94
SPLIT Command 102
PF03/ PF15
CMEM Rule Definition 258
END Command 94
IOA Log Show Screen Window 301
Scheduling Definition 150
Show Screen Filter 198
PF04/ PF16
Active Environment Screen 179, 198
Box Color 160
CMEM Rule Exit Option 260
Global View Screen 199
Job List Exit Window 151
REFRESH Command 199
RESET Command 94
PF05/ PF17
FIND Command 94, 98, 159
PF06/ PF18
=6 Command 94, 111
PF07/ PF19
Filtering 301
Show Screen Filter 198
UP Command 94
PF08/ PF20
DOWN Command 94
Filtering 301
Show Screen Filter 198
PF09/ PF21
SWAP Command 102
PF10/ PF22
IOA Log Show Screen Window 301
LEFT Command 94
PREV Command 94
Scheduling Definition 150
Show Screen Filter 198
PF11/ PF23
Active Environment Screen 178
NEXT Command 94
RIGHT Command 94
Scheduling Definition 150
PF12
RETRIEVE Command 94
PF24
SHPF Command 94
PFKey Definition
Online Facility 94
PRINT Command 103
TSO CTMTTRA 111
PFKey Display
Index 1021
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
SHPF Command 94
PFKey functions
IOA Editor 105
PFKeys
DOWN 96
UP 96
PGMST Parameter
ON Statement 534
Step Range 539
PGMSTEP Parameter
ON DSNEVENT Statement 713
ON STEP Statement 721
pgmstep.procstep
DO IFRERUN Statement 447
Pipe
Job Scheduling Definition 56
Job-Related Considerations 813
MAINVIEW Batch Optimizer (MVBO) 55
PIPE Field
Show Screen Filter 197
PIPE Parameter
Description 573
MAINVIEW Batch Optimizer (MVBO) 377, 387
MAINVIEW Batch Optimizer (MVBO)
Implementation 813
Summary 135
Pipe Participant
Definition 56
PIPE Statement
Deleted Through Zoom Screen 813
PLAN Command
Scheduling Definition 144
Plan Description
Parameter Prompting 350
PLAN NAME
Master Prompting Plan PREFIX 357
Parameter Prompting 356, 360
PLAN NAME Prefix
Parameter Prompting 350
PLAN Option
Job List Screen 128, 162
PLAN ORDERED ALREADY Field
Parameter Prompting 357, 358
Plan Selection Screen
Parameter Prompting 357, 360
PLANID Parameter
CTMEXEC CLIST 827
CTMFETCH CLIST 825
Daily Scheduling Table 823
PLANID Suffix
CTMFETCH CLIST 825
POOL DEFINITION Option
Primary Option Menu 90
Post-processing Statement
Error 388
PostProcessing
System Variable 742
PostProcessing Parameter
System Variable 742
PostProcessing Parameters
CONTROL-M Monitor 49
DO SET Statement 464, 614
Group Entity 143
Scheduling Definition 136
Summary 387
PPF2DAY Job
JCL Library 832
PPF2DEL Job
JCL Library 831
Precedence
AutoEdit Variable Assignment 758
Predecessor Job
Job Dependency 75, 236
REFRESH Command 239
Prefix
Maybe Job Prerequisite Condition 811
PREFIX Field
Manual Conditions 278, 285
Prefixing
Description 83
PREREQ CONDITION Option
Online Utilities Menu 321
Prerequisite Condition
% Sign 876
Add/ Check/ Delete Utility 322
Adding 279, 286, 555
CMEM Rule 667
CONTROL-M Files Prefix 338
Cross Reference 879
Date Reference 71, 439
Deleting 72, 281, 288, 556
Description 69
DO COND Statement 436, 687
DO Statement 434
Erasing 281, 288
Example 70, 503, 560
Format 362
Group Entity 71, 558
IMSACTIVE 560
IN Parameter 497
IOALDNRS Utility 809
IRSTAPEARRIVED 816
Job Dependency 71, 75
Manual Conditions 60, 284
Manual Intervention 72, 499, 555
Maybe Job 811
OUT Parameter 554
Parameter Prompting 338, 341
Quick Schedule Definition 364, 366
Runtime Criteria 47
RUN%%PLANID 824, 828
Show Screen Filter 197
STAT 72
Unscheduled Condition 811
1022 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Why Screen 206
Prerequisite Conditions
IOA Conditions/ Resources Screen 275
IOA ConditionsFile 275
PREV Command
Job Scheduling Plan 163
PF10/ PF22 94
Scheduling Definition 145, 150
PREV Value
FIND Command 98
IN Parameter 498
Schedule Date 437, 555
prevent NOT CATLGD2 errors 577
PREVENT-NCT2 Parameter
Description 576
PREVENTNCT2 Parameter
Example 579
Previous
SAC Parameter 601
PREVYEAR Command
Calendar Definition Screen 318
Print a Copy of the Screen 96
PRINT Command
PFKey Definition 103
Print Commands
KSL 859, 871
Print Screen 96
Printing
Sysout 477, 635, 638
PRINTLINE KSL Command 871
PRINTNEWPAGE KSL Command 871
PRINTSCREEN KSL Command 872
PRIOR RUN Status
Active Environment Screen 187
Priority
Conditions/ Resources 277
Overview 74
Runtime Criteria 47
SYSOUT Operations 479
Sysout Operations 638
UserDefined Variable 753
PRIORITY Field
Show Screen Filter 197
PRIORITY Parameter
Description 580
Example 581
Job Flow 75
Logic 581
PRM Parameter
DO SYSOUT Statement 475
PRMTBLB Parameter
CTMFETCH CLIST 826
PROBLEMS READING SYSOUT Status
Active Environment Screen 187
Processing Commands
KSL 860, 873
PROCST Parameter
+EVERY 536
ON Statement 535
PROCSTEP Parameter
ON DSNEVENT Statement 712
ON STEP Statement 720
PROD Mode
CMEM Rule Simulation 706
Product Description
CONTROL-M/ Restart 41
CONTROL-M/ Tape 41
CONTROL-O 42
CONTROL-O/ COSMOS 42
CONTROL-D 41
CONTROL-D/ Image 42
CONTROL-D/ Page On Demand 41
CONTROL-M 41
CONTROLM/ Analyzer 41
CONTROL-V 41
product support 3
Production Delay
MAXWAIT Parameter 515
Productivity Tools
Option OA 89
Profile Variable
SACTMOD 166
Programmer Information
SHOUT Parameter 620
PROMPT IND Field
Parameter Prompting 353
PROMPT Library
%%LIBSYM Statement 821
Prompting Plan
AutoEdit Variables 816, 822
PROPAGATE Argument
REFRESH Command 239
PRTDBG
DD Statement 96
PRTY Field
Job Dependency Network 238
PSEUDO Job
Status 392
PSEUDO Jobs
MEMBLIB Parameter 394
PUTFILE KSL Command 874
Q
Quantitative Resource
Adding 279
Changing 283
Critical Path Priority 581
Definition 73
Deleting 281
MAINVIEW Batch Optimizer (MVBO)
Implementation 814
RESOURCE Parameter 588
Index 1023
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Runtime Criteria 47
Show Screen Filter 197
Quantitative Resources
IOA Conditions/ Resources Screen 275
Quantitive Resource Return Codes, CTMAPI 922
QUANTITY Field
Conditions/ Resources 277
Quick Schedule Definition
CTMQUICK Utility 361
Example 370
Exiting 369
Overwrite Confirmation Window 365
Screen 362
QUICK SCHEDULE Option
Online Utilities Menu 321
Quick Submit Command
Job Ordering 805
QUICKDEF Utility
ISPF Online Utility 379
R
R Option
Active Environment Screen 180, 222
Parameter Prompting 342
RACF
Security Product 569
RANGE Control Statement
%%RANGE 765
RBA 174
RBA Field
Active Environment Screen 174
Conditions/ Resources 174, 277
RBAL Command
Active Environment Screen 174, 277
Job Dependency Network 237
RDR=INTRDR Parameter
CTMAESIM Utility 783
Reactivate Option
Active Environment Screen 180
RECAPTURE ABEND CODE
ON Statement 538
STEP RANGE Parameter 631
RECAPTURE CONDITION CODE
ON Statement 538
STEP RANGE Parameter 631
RECAPTURE CONDITION CODES Field
Restart Confirmation Window 226
RECIPIENT TREE Option
Primary Option Menu 89
Record Selection Criteria
Active Environment Screen 189
REFRESH Command
Active Environment Screen 175
Global View Screen 199
Job Dependency Network 236, 239
RELATIONSHIP Field
Group Scheduling Table 377
RELATIONSHIP Parameter
Description 128, 583
Group Scheduling 129
Group Scheduling Logic 385
Group Scheduling Table 381
RELEASED Status
Active Environment Screen 187
REMAIN Parameter
CTMEXEC CLIST 827
REMAINING PARAMETERS Field
Parameter Prompting 357
Update Parameter Values 360
Remote Node
NJE Network 51
REMOVE UNSCHED CONDITIONS
Group Entity 812
REP3ABND
KSL Script 878
REP3GRUP
KSL Script 878
REP3LEFT
KSL Script 878
REP3LEFT Report
Simulation/ Tape Pull 334
REP3STAT
KSL Script 878
REP3TAPE
KSL Script 878
REP3WHY
KSL Script 878
REP5ABND Utility
Abend Report 878
REP5ALL
KSL Script 878
REP5MSGD
KSL Script 878
REPBYDSN Parameter
Tape Pull List 847
REPBYJOB Parameter
Tape Pull List 847
REPBYTIME Parameter
Tape Pull List 847
REPBYVOL Parameter
Tape Pull List 847
Repeat Commands
Edit Environment 938, 951
REPEAT Option
Parameter Prompting 342, 355
REPLACE Parameter
CTMFETCH CLIST 826
REPLACE YES Option
CTMFETCH CLIST 828
Replies
CTMBAPI 924
REPORT BY DSN Field
1024 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Simulation/ Tape Pull 334
REPORT BY JOB Field
Simulation/ Tape Pull 334
REPORT BY TIME Field
Simulation/ Tape Pull 334
REPORT BY VOLSER Field
Simulation/ Tape Pull 334
Report Decollating
D-CAT Parameter 416
REPORT DEF Option
Primary Option Menu 89
Reporting Facility
KSL 857
Overview 54
REPORTS Field
Simulation/ Tape Pull 333
Repository
Description 61
REQUESTED CHANGE HELD Status
Zoom Screen 221
REQUESTED CHANGE Status
Active Environment Screen 187
REQUESTED DELETE
Active Environment Screen 189
REQUESTED FORCE OK Status
Active Environment Screen 187
REQUESTED FREE Status
Active Environment Screen 187
FREE Option 181
REQUESTED HELD Status
Active Environment Screen 187
HOLD Option 180
REQUESTED REACT Status
Active Environment Screen 188
REQUESTED RERUN Status
Active Environment Screen 188
Rerun
Definition 66
DO STOPCYCL 473
Rerun Confirmation Window
CONTROL-M/ Restart 224
Manual Job Rerun 222
Rerun Interval
INTERVAL Parameter 509
Rerun Job
Example 784
RERUN NEEDED Status
MAXRERUN Parameter 512
RERUNMEM Parameter 585
RERUN Option
Active Environment Screen 180, 222
TASKTYPE Parameter 644
RERUN Parameter
Example 513
Rerun Request
DO Statement 434
RERUN Status
Show Screen Filter 195
RERUN Value
SHOUT Parameter 619
Rerun/ Restart Window
$FIRST/ $CLEANUP Values 227
Active Environment Screen 223
RERUNJOB
KSL Script 879
RERUNMEM Parameter
Description 585
MAXRERUN Parameter 513
RES Field
Conditions/ Resources 278
Job Dependency Network 238
RES NAME Field
Show Screen Filter 196
RESET Command
CMEM Rule Exit Option 260
Description 99
Edit Environment 936
Exit Option 151
IOA Log Show Screen Window 301
PF04/ PF16 94, 100
Quick Schedule Definition 370
Scheduling Facility Exit Option 151
Show Screen Filter 198
RESOLVE Control Statement
%%RESOLVE 767
Resource
Conditions/ Resources 174
Resource Allocation
Critical Path 74
Resource Contention
Critical Path Priority 581
Resource Control
CONTROL Parameter 409
RESOURCE Parameter
Automatic Tape Adjustment Facility 235
Description 588
Example 591
Logic 589
RESOURCE TYPE Field
Show Screen Filter 197
Resource Utilization
Critical Path 74, 580
Priority 580
Tape Devices 235
Resource Window
Conditions/ Resources 283
Resources
Forecasting 834
Simulation 835
Resources File 61
RESTART
ON Statement 538
STEP RANGE Parameter 631
Restart
Index 1025
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CONTROL-M/ Restart 67
Definition 66
DO IFRERUN Statement 446
DO STOPCYCL 473
RESTART DECISION Field
Zoom Screen 215, 218
Restart Job
DO IFRERUN Statement 446
OUT Parameter 976
Restart OS/ 390
OUT Parameter 975, 976
RESTART Parameter
DO Statement 434
Restart Step
List Window 228
OUT Parameter 976
RESTARTED Status
Active Environment Screen 188
Restoration
Active Jobs File 49
Conditions/ Resources 49
RESTORE Option
History Environment Screen 241
RESTORED Status
Active Environment Screen 188
RETENTION Parameter 594
# OF DAYS TO KEEP 594, 596
# OF GENERATIONS TO KEEP 594, 596
History Jobs File 129, 377
Retention Period
SYSDATA 399
Retrieval Criteria
Selection Criteria 278
RETRIEVE Command
PF12 94
RETRO Parameter
Description 598
MAXWAIT Parameter 516
MINIMUM Parameter 527
PDS Parameter 571
Return Codes
CTMAPI Forcing Jobs 889
CTMAPI Ordering Jobs 889
RETURN Command
KSL 870
RIGHT Command
PF11/ PF23 94
ROSCOE
DO SHOUT Statement 699
ROSCOE/ ETSO
Address Space 81
PF06/ PF18 94
Row commands
IOA Editor 106
Row Numbering
Variable Database Facility 272
RULE ACTIVITY Option
Primary Option Menu 89
Rule Copying 264
Rule Definition
Editing 949
Maintaining Validity 953
RULE DEFINITION Option
Primary Option Menu 89, 90
RULE Field
CMEM Entry Panel 247
Rule List Screen
Commands 250
Copying Rules 264
RULE STATUS Option
IOA Menu 89
Rule Table
Automatic Creation 362
CMEM 243
Rule, CONTROL-M/ Analyzer
CTB STEP Parameter 413
RULENAME Parameter
DO RULE Statement 694
RUN Attribute
ODATE 64
RUN n Status
Active Environment Screen 188
RUN SIMULATION Field
Simulation/ Tape Pull 331
Run Statistics
Statistics Screen 233
Runtime Criteria
Job Submission 47
Runtime Scheduling
MAINVIEW Batch Optimizer (MVBO) 814
Pipe Algorithm 56
Runtime Scheduling Parameter
THRESHOLD 728
Runtime Scheduling Parameters
Scheduling Definition 135
Summary 387
RUNTSEC Parameter
Example 727
Security Check 727
RUN%%PLANID
Prerequisite Condition 824, 828
S
S Option
Active Environment Screen 181
Display Filters Window 295
End User Job Order 372
Job List Screen 127
Table List Screen 122
S*37 Abend Code
SET VAR Parameter 615
SAC Parameter
1026 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- (Group Previous) 601
+ (Group Next) 601
Next 601
Previous 601
SAMPEXIT Library
CTMX002 Exit 521
SAP/ R3
architecture 930
BAPI 931
running on USS 930
Unix and the SAP/ R3 Application Layer 931
with DB/ 2 database 930
SAVE (Y/ N) Field
IOA Log Show Screen 297
Show Screen Filter 193
SAVE Command
Zoom Screen 219, 221
SAVE DOCUMENTATION Parameter
Save Documentation Window 149
Save Documentation Window
Scheduling Definition 148
SAVE Field
Exit Option Window 151
IOA Log Show Screen Window 297
Scale Line
View Graph Screen 202, 204
SCATMOD Profile Variable 166
Schedule Date
Job Scheduling Plan Screen 164
OUT Parameter 555
SCHEDULE PREVIOUS DAY Parameter
Description 601
SCHEDULE TAG ACTIVE Parameter
Description 607
Format 607
FROM 134, 607
SCHEDULE TAGS, Conflicting 609
UNTIL 135, 607
SCHEDULE TAG Field
Group Scheduling Table 377
SCHEDULE TAG Parameter
Description 603
Group Entity 113, 142
Group Scheduled Job 498
Group Scheduling 129, 132, 381
SCHEDULED RUN DATE Parameter 324
SCHEDULE-PREV-DAY Value
DESC Parameter 432
SCHEDULE-PREV-ONLY Value
DESC Parameter 432
Scheduling
Basic Parameters 381
Calendar Facility 301, 312
Description 377
DO FORCEJOB Statement 444, 445
DO MAIL Statement 451
Example 377
General Parameters 379
Logic 384, 421
Nonperiodic 656
Periodic 423, 657
Runtime Parameters 387
TASKTYPE Parameter 643
Scheduling Criteria
Group Entity 113
Job Submission 47
Scheduling Definition
Commands 143
Creation 115
Deletion 116, 158
Description 111
Documentation 146
Editing 145, 935
Entry Panel 118
Exiting 149
Graphic Jobflow 159
Group Entity 140
Group-Handled Jobs 113
Job List 124
Job Plan 162
Job Scheduling 377
Ordering Jobs 152
Overview 57
Parameters 130
Screen 112, 128
Search Window 120
Table List 121
Scheduling Definition Screen
Group Entity 141
Scheduling Information
Job Scheduling Plan Screen 163
Scheduling Jobs 151
Scheduling Library
DO FORCEJOB Statement 444
Job Scheduling 44
Scheduling Library Mode
AutoEdit Syntax Testing 326, 782
Parameter 328
SCHEDULING LIBRARY Parameter
AutoEdit Simulation 328
Description 324
Scheduling Logic
DAYS Parameter 421
Description 384
Scheduling Parameters
Display 118
Scheduling Table
DO FORCEJOB Statement 444
Job Scheduling 44
Parameter Prompting 822
SCHENV parameter
format 610
SCHTBLB Parameter
CTMFETCH CLIST 826
Index 1027
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Screen
Printing 96
Screen Commands
KSL 866
Screen Control
Online Facility 111
Screen Description Line
Online Facility 92
Screen Exit
CANCEL Command 100
Screen Help
Line Sensitive 100
Online Facility 100
Screen Layout
Online Facility 92
Screen Printing
ISPF LIST File 103
Screen Transfer
TSO CTMTTRA Command 111
Screens
Active Environment 166
AutoEdit Simulation 326
Calendar Definition 312
Calendar Facility 303
Calendar Facility Entry Panel 304
Calendar List 305
CMEM Online Entry Panel 246
CMEM RULE Definition 696
CMEM Rule Definition 251, 256, 679, 684, 701, 703,
707, 715, 717, 719, 727, 949
CMEM Rule Facility 243
CMEM Rule List 249
CMEM Table List 247
Conditions/ Resources 280, 281
CONTROL-M Simulation 330
Database List Screen 268
Define or Update a Master Plan 350
Define Parameters and Conditions 339, 341
Define Parameters in Master Plan 352
Edit Environment 145, 257, 935, 949
Entry Panel 118
Exec/ Order a Plan 357
Fetch a Plan 356
Forecasting Facility 330
Global View 198
Graphic Jobflow 160
Group Scheduling 140
History Environment 239
IOA Entry Panel 84
IOA Help 100
IOA Log 94, 290
IOA Log Show Screen Window 296, 299
IOA Primary Option Menu 85, 88
IOA TSO Command Processor 109
IOA Variables Facility 267
Issue a Job Request 324
Job Dependency Network 237
Job List 124, 152, 162, 366, 371
Job Log 212
Job Order Execution History 229
Job Scheduling Definition 128, 147, 163, 370, 935
job scheduling definition 377, 397, 401, 408, 411, 417,
419, 433, 443, 445, 450, 465, 472, 482, 487, 489, 491,
494, 496, 503, 511, 514, 517, 523, 526, 528, 548, 559,
568, 570, 572, 579, 591, 616, 627, 628, 632, 640, 646
Jobflow 159
Manual Conditions 284, 286, 288
Master Plan Definition 350
Master Table Definition 340
Online Utilities 321
Online Utilities Menu 321
Parameter Prompting Facility 339
Parameter Prompting Type 1 Menu 338
Parameter Prompting Type 2 Menu 349
PFKey Window 95
Plan Selection 357
Prerequisite Condition Utility 322
Quick Schedule Definition 362
Rule Definition Entry Panel 118
Scheduling Analysis 205
Scheduling Definition 112
Scheduling Group 140
Set Conditions 346
Simulation, AutoEdit 325
Simulation, CONTROL-M 330
Statistics 233
Sysout Viewing 231
Table List 121, 158
Table Selection 344
Tape Pull List 330, 850
TSO Command Processor 109
Update Parameters 346, 359
Variable List Screen 269
Variable Zoom Screen 272
View Graph 201
Why 205
Year List 306
Zoom 214
SCREENSIZE KSL Command 867
SCROLL Field
Screen Header 96
Scrolling
Commands 96
SEARCH COUNTER Field
DISAPPEARED Status 217
Zoom Screen 217
Search Function
CTMAPI 896
Searching
FIND Command 98
LOCATE Command 97
Security
CMEM Rule 724
OWNER Parameter 569
1028 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
RUNTSEC Parameter 726
Security Exit IOASE07 922
SELECT Command
Table Creation 114
Table List Screen 123
SELECT Option
Calendar List Screen 306
CMEM Rule List 250
CMEM Table List 248
Display Filters Window 295
Display Filters window 191
Job List 127
Table List 116, 122
Year List Screen 308
Select Option
Job Order Execution History 231
Selection Criteria
Active Environment Screen 189
CMEM Actions 252
Conditions/ Resources 278
Display Filters window 191
Parameter Prompting 341
Show Screen Filter 193
SELECTION FIELD
Parameter Prompting 360
SET
Global Variables 266
SET command 107
SET Command Panel
End TRACE level 108
Set TRACE level 108
Set Conditions
Screen 341
SET Control Statement
%%SET 769
SET Statement
JCL SET 759
Set TRACE level
SET Command Panel 108
SET VAR
Global Variables 266
SET VAR Parameter
AutoEdit Variable 463, 613
Description 612
DO SET Statement 464, 614
Example 614
SET VAR Statement
AutoEdit Statement 784
Global Variable 748
JCL Setup 753
Local Variable 745
UserDefined Variables 735
SETLINE KSL Command 872
SETOGLB
Global Variables 266
SETOGLB KSL Command 874
SETOLOC Command
%%$PARSE Function 964
UserDefined Variable 958
SETOLOC KSL Command 874
SETOLOC Statement
AutoEdit Variables 861
Setting Variable Values
AutoEdit 769
SETVAR Command
KSL 865
SETVAR KSL Command 874
Shared Control
CONTROL Parameter 409
Shared Resource
WAIT SCHEDULE Status 280
SHIFT Parameter
CONFCAL Calendar 383
CONFCAL Parameter 403
SHOUT
KSL Command 875
SHOUT Facility
CONTROL -O 52
Shout Facility
DO SHOUT Statement 466
Problem Notification 48
SHOUT Message
AutoEdit Variable 785
IOA Log Show Screen Window 298
SHOUT Parameter
Description 618
DO SHOUT Statement 471, 625
Job Statistics File 622
System Variables 735
WHEN LATE 619
SHOUT Statement
%%JOBNAM/ %%JOBNAME Variables 362
PostProcessing Parameters 137
SHOUT WHEN EXECTIME Message
Job Dependency Network 238
SHOUT WHEN LATE Message
Job Dependency Network 238
New Day Procedure 623
SHOUT WHEN LATESUB Message
Job Dependency Network 238
New Day Procedure 623
SHOW Command
Active Environment Screen 174, 190, 294
IOA Log Screen 292
Log Screen 212, 293
PF02/ PF14 94
SHOW JOB DOCUMENTATION Field
Entry Panel 146
SHOW LIMIT ON Field
Log Screen 290
Show Option Window 189
Show Screen Filter
Activating 190, 192
Active Environment Screen 190, 192
Index 1029
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Displaying available filters 190
Exiting 197
Fields 193
Show Screen Filter Window Field
DESC 193
SHPF
Command 255
SHPF Command
CMEM Rule Definition 255
PF24 94
Show PFKey 94
SIMEND Parameter
Simulation 837
SIMLOG Output File
Simulation 840
SIMOAJF Output File
Simulation 840
SIMOCND Output File
Simulation 840
SIMORES Output File
Simulation 841
SIMPARM DD statement
CONTROL-M 837
SIMSTART Parameter
Simulation 837
SIMUL/ TAPE PULL Option
Online Utilities Menu 321
Simulation
Active Jobs File 834, 839
Analyzing the Run 842
AutoEdit Statement 782
CMEM Rules 706
CTMAESIM Utility 783
CTMCSIM CLIST 330
CTMX002 841
Description 834
Input Files 835, 839
INVOKE JOBSCAN 330
Manual Conditions 844
Message File 840
MODE Parameter 706
Output Files 840
Overview 54
Parameters 837
Screens 330
Tape Pull List 845
Simulation Facility
CTMCSIM Utility 330
Simulation Option
Active Environment Screen 182
SIMULATION Parameter
Simulation/ Tape Pull 333
Simulation/ Tape Pull Utility
CLIST CTMCSIM 330
SKELETON Field
Quick Schedule Definition 363
Skeleton Job
Quick Schedule Definition 361
SMF ID Field
Statistics Screen 234
SMFID Parameter
ON DSNEVENT Statement 711
ON JOBARRIV Statement 716
ON JOBEND Statement 718
ON STEP Statement 720
SMS Support
CMEM 676
SNRUN
ANYSTEP 546
SNRUN Code
+EVERY Step 541
ON Parameter 545
SORT Command
Job List Screen 126
Space Allocation
SET VAR Parameter 614
Space Report Field
Simulation/ Tape Pull 335
SPD Statement 601
Special Catalog
Tape Pull List 846
Special Purpose Job
Job Ordering 807
Job Scheduling 804
Special Variables
KSL 860, 863, 877
SPLIT Command
PF02/ PF14 94, 102
Split Screen Mode
Online Facility 102
SRB Time Field
Statistics Screen 234
SRB Time, Average
Statistics Screen 234
SRB Time, Group
Statistics Screen 235
SSCHTBO Parameter 155
START Command
TASKTYPE Parameter 644
START Field
Job Order Execution History 231
START TIME Field
Statistics Screen 234, 235
STARTED Status
Active Environment Screen 188
Started Task
AUTOARCHIVE Parameter 399
KSL 858
MEMLIB Parameter 520, 522
MEMNAME Parameter 524
OVERLIB Parameter 564
Show Screen Filter 196
TASKTYPE Parameter 643
STAT Command
1030 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Job List Screen 126, 308
Rule List Screen 250
STAT Date Reference
DO COND Parameter, DATEREF Subparameter 437
DO COND Statement 686
IN Parameter 498
OUT Parameter, DATEREF Subparameter 555
Prerequisite Condition 72
STAT Field
Conditions/ Resources 279
Global view Screen 200
Manual Conditions 286
STAT Message Type
IOA Log Show Screen Window 298
STAT Option
Active Environment Screen 181
Job List Screen 128
State (Mode of Control)
CONTROL Parameter 409
STATE Status
Show Screen Filter 196
Statement
DO SET Statement 753
Error
Post-processing 388
Statistical Information
Global View Screen 198
Job Status 175
View Graph Screen 200
Statistics
Execution Information 53
Group Entity 235
JOBSTAT Command 144
Tape Device 235
Statistics File
SHOUT Parameter 622
Statistics Screen 233
Active Environment Screen 175
Fields 234
JOBSTAT Command 175
STATUS Field
Active Environment Screen 170
Job Dependency Network 238
Job Order Execution History 231
Show Screen Filter 194
Status Reply DSECT
CTMBAPI 910
Status Return Codes 912
Status Returned
CTMBAPI 911
Status Screen 164
Functions 58
Manual Confirmation 448
WAIT CONFIRMATION Status 407
Status screen 459
Status Zoom Screen
DOC Lines 488
Status, CONTROL-M
Job Dependency Network 238
STC
Started Task 519
STC Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
STEP ADJUSTMENT Field
Restart Confirmation Window 226
Step Event
CMEM 666
DO FORCEJOB Statement 691
Step List Window
Restart Window 228
Step Range
Example 550
ON Statement 534
PGMST Parameter 534, 539
STEP RANGE Parameter
Description 630
Example 632
pgmstep.procstep 630
STEP Statement 253
STEPRC field
DSNEVENT criteria 675
STEPRC Parameter
ON DSNEVENT Statement 713, 714
ON STEP Statement 721
String Extraction
%%$SUBSTR Function 962
String Manipulation
%%$PARSE Function 964
String Pattern
%%$PARSE Function 967
String Search
LOCATE Command 97
SUBMIT Command
From ISPF 805
ISPF 805
Quick Submit 805
SUBMIT Function
AutoEdit Simulation 329
SUBMITTED Status
Active Environment Screen 188
Show Screen Filter 195
SUBSCAN Function
AutoEdit Simulation 329
Substring
String 962
Subtraction Operation
%%MINUS 770
Successor Job
Job Dependency 75, 236
SUFFIX Field
Quick Schedule Definition 365
SUFFIX Parameter
CTMEXEC CLIST 827
Index 1031
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CTMFETCH CLIST 825
SUM Field
View Graph Screen 202
support, customer 3
SWAP Command
PF09/ PF21 102
Sxxx Code
+EVERY Step 541
Syntax Checking
AutoEdit Statement 782, 845
CTMSCIM Utility 331
Edit Environment 936
JCL Statements 845
SYSDATA
Definition 68
SYSDATA Archiving
AUTOARCHIVE Parameter 398
SYSDATA Deletion
Active Jobs File 399
SYSDATA Viewing
AUTOARCHIVE Parameter 398
SYSDB Parameter
AUTOARCHIVE Parameter 398
SYSID Field
Statistics Screen 234
SYSIN DD Statement
%% Parameter 798
SYSOPT = CTMWORK
CONTROL-M/ Analyzer System Variable 443
SYSOUT Archiving
Option F 785
SYSOUT Dataset
SYSDATA 67
Sysout Destination
DO SYSOUT Statement 478
Sysout destination
SYSOUT Parameter 636
SYSOUT Operations
Copying 634
SYSOUT Parameter 634
SYSOUT operations
Priority 479
Sysout Operations
Archiving Facility 482
Class Change 477, 636
Copying 476, 480, 638
Displaying 231
DO SYSOUT Statement 476
Merging 479, 636
Moving 478, 636
Multiple 478, 636
Printing 477, 636, 638
Priority 638
Releasing 477, 635
SYSDATA Definition 67
Viewing Screen 231
Sysout Option Code
DO SYSOUT Statement 475
SYSOUT Parameter 633
SYSOUT Option F
AutoEdit Variable 785
SYSOUT Parameter
Description 633
DO SYSOUT Statement 481, 638
Example 639
Logic 636
System Variables 735
SYSPLEX
Variable Database Facility 266
Sysplex
Minus-One Support 55
System Abend Code
ON Statement 541
System Date
%%$CALCDATE 961
Definition 62
DO FORCEJOB Statement 444
JCL Setup 740
SYSTEM ID Parameter
Format 641
Under JES2 641
Under JES3 642
System Messages
SYSDATA 67
SYSTEM Parameter
ON DSNEVENT Statement 711
ON JOBARRIV Statement 716
ON JOBEND Statement 718
ON STEP Statement 720
SYSTEM Subparameter
DO SHOUT Statement 699
System Variable
AutoEdit 734, 737, 956
Date Variable 739
JCL Setup 737
MEMLIB Parameter 785
PostProcessing 742
Resolution 753
SET VAR Parameter 463, 613
SHOUT Parameter 735
SYSOPT = CTMWORK 443
SYSOUT Parameter 735
T
T Option
Active Environment Screen 180
Job List Screen 128
Table
Browse Mode 116
Creation 114, 123, 243
Deletion 116, 158
TABLE Command
1032 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Active Environement Screen 176
Table Description
Parameter Prompting 340
TABLE Field
Active Environment Screen 170
CMEM Entry Panel 246
Quick Schedule Definition 363
Scheduling Facility Exit Option 151
Table Information
Quick Schedule Definition 362
Table Library
Parameter Prompting 339
Table List
CMEM Table List 121
Options 122
Statistical Information 121
Table List Screen
CMEM Rule Facility 247
Commands 123
Delete Confirmation 158
Description 121
Exiting 151
Job Ordering 805
Manual Job Scheduling 151
New Table 151
Options 115
TABLE NAME Parameter
AutoEdit Simulation 328
Description 324
Entry Panel 116
Table Name Prefix
Parameter Prompting 339, 820
TABLE Parameter
DO FORCEJOB Statement 444, 690
DO RULE Statement 694
TABLE PREFIX Field
Table Selection Screen 345
Table Selection Screen
Parameter Prompting 344
TAGMAXWT Parameter
CTMPARM 516
Tape Adjustment 54
Tape Devices
Statistics 235
Tape Drive
RESOURCE Parameter 591
Tape Pull List
Catalogs 846
CTMCSIM Utility 330
DD Statements 849
JOB/ SCANDOCU/ TEXT 849
Parameters 847
Problem Determination 850
Recommendations 845
Sample Report 851
Simulation 845
Work Flow 845
TAPE PULL LIST Field
Simulation/ Tape Pull 334
TAPE PULL LIST Parameter
Simulation 848
Tape Pull List Parameters 847
TAPULIN DD Statement
Simulation Parameter 847
Tape Pull List 849
TAPULOUT DD Statement
Tape Pull List 849
TAPULPRM Member
CONTROL-M 847
Target Computer
Example 794, 795
TASK TYPE Criteria
IOA Log Show Screen Window 299
TASK TYPE Field
Show Screen Filter 196
taskid Format
MEMLIB Parameter 520
TASKTYPE Parameter
Description 643
Example 646
MEMLIB Parameter 520
MEMNAME Parameter 525
Tasktype WRN
Warning Message 645
technical support 3
Terminal Support
Online Facility 82
TERMINATE Option
Active Environment Screen 180
TEST Mode
CMEM Rule Simulation 706
Testing
AutoEdit Syntax 782
Text Parsing
%%$PARSE Function 964
THRESHOLD Parameter
Description 728
THRESHOLD Runtime Scheduling Parameter 728
Time
Runtime Criteria 47
TIME Field
Log Screen 290
Time Interval
%%$TIMEINT Function 963
TIME Parameter
CTMEXEC CLIST 827
Description 648
TO DATE Field
Date Range Window 162
TO Destination
DO SHOUT Statement 467, 469
SHOUT Parameter 620
TO Field
Zoom Screen 215
Index 1033
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
TO Parameter
DO SHOUT Statement 697
STEP RANGE Parameter 630
TO Step
DO IFRERUN Statement 448
Restart Step List Window 229
TO STEP Field
Restart Confirmation Window 225
TO=OPER Value
DO SHOUT Destination 469, 623
TO=TSO-ID Value
DO SHOUT Destination 470, 624, 700
TO=USERID Value
DO SHOUT Destination 469, 623
Tocol Parameter
FIND Command 98
TOP Command
Scrolling 97
TOP SECRET 569
Totals Line
Global View Screen 199, 202, 204
TRACE
KSL Command 872
TRACE ON Parameter
Debugging 858
Tracking and Control
Description 58
Tracking and Control Facility
Online Facility 164
Transfer Command
Multi-Screen Control 91
Transfer of Control
TSO/ Online Facility 94, 110
Transfer to TSO/ Utilities
PF06/ PF18 94
TSO
AutoRefresh Mode 101, 175
Command Processor Screen 109
Commands 109
Control 94, 111
Screen 109
TSO Application
Online Facility 110
TSO CLIST facility 805
TSO Cross Memory Option
PF06/ PF18 94
TSO CTMTTRA Command
Transfer to IOA 111
TSO Environment
OWNER Parameter 569
TSO Job
CMEM On Spool Job 669
DO STOPJOB Statement 702
TSO Option
Primary Option Menu 87
TSO SEND Command
DO SHOUT Statement 468, 698
SHOUT Parameter 621
TSO Transfer Command
PF06/ PF18 94
TSO User ID
Quick Schedule Definition 363
TSO/ ISPF
Environment 81, 128, 180
TSO-id Value
DO SHOUT Destination 468
TYP Field
Active Environment Screen 170
TYPE 1
Parameter Prompting 336
TYPE 2
Parameter Prompting 336
TYPE Command
KSL Command 867
TYPE Field
Conditions/ Resources 276
Manual Conditions 285
Parameter Prompting 354
Rule List Screen 248
Type of Task
TASKTYPE Parameter 643
TYPE Parameter
CTB STEP Parameter 413
TYPRUN Parameter
Tape Pull List 848
TYPRUN=HOLD
CMEM On Spool Job 670, 674
TYPRUN=SCAN Parameter
AutoEdit Simulation 329
Tape Pull List 846
U
U1 Option
Online Utilities Menu 374
U-M 470, 624
UNDELETE Option
Active Environment Screen 181
UNEXPECTED CC Status
Show Screen Filter 195
UNITDEF Member
IOA PARM Library 236
Unix system services 927
Unnnn Code
+EVERY Step 541
Unscheduled Condition
Manual Conditions 810
UNTIL Time
TIME Parameter 648
Unused Tracks
MINIMUM Parameter 527
PDS Parameter 571
UP Command
1034 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
PF07/ PF19 94, 96
UPDATE Option
Parameter Prompting 342, 355
Update Parameters
Fields 346, 359
Screen 346, 359
Type 1 Option 1 344
Updating Variables
Variable Zoom Screen 272
UPP
User Prompting Plan 824
UPPTBLB Parameter
CTMEXEC CLIST 827
CTMFETCH CLIST 826
URGENCY Field
IOA Log Show Screen Window 299
URGENCY Parameter
DO SHOUT Statement 469, 471
URGENCY Subparameter
DO SHOUT Statement 698
URGN Parameter
SHOUT Parameter 622
SHOUT Statement 625
Usage Line
Screen Layout 93
USE Field
Conditions/ Resources 277
User Abend Code
ON Statement 541
USER DATA Field
Statistics Screen 234
USER DATA, Group
Statistics Screen 235
User ID
IOA Log Show Screen Window 299
Online Facility 85
USER ID Parameter 132
USER INTERFACE Option
Online Utilities Menu 321
USER Message Type
IOA Log Show Screen Window 298
User Plan
User Prompting Plan 356
User Profile
Active Environment Screen Filter 190
Customizing 81
User Prompting Plan
Parameter Prompting 356, 824
USER REPORTS Option
Primary Option Menu 89
USER=Library
MEMLIB Parameter 519
OVERLIB Parameter 564
USERID Field
Log Screen 291
USERID Value
DO SHOUT Destination 467
SHOUT Parameter 620
UserDefined Variable 743
AutoEdit 734
DO SET Statement 462, 735
SET VAR Parameter 463, 613
Source Priority 753
Userdefined Variable
AutoEdit 958
USS
CONTROL-M implementation 927
USS services 927
USS, CONTROL-M and
architecture for Unix-oriented implementation 929
CONTROL-M Option for SAP/ R3 931
in the USS environment 931
JCL for OS/ 390 orientation 928
OS/ 390 oriented 928
SAP R/ 3 on USS 930
SAP/ R3 Application Layer 931
Unix oriented implementation 928
Utilities
CLIST IOAUTIL 320
Conditions/ Resources File 322
CTMAESIM 325, 782
CTMJBINT 371
CTMJOBRQ 324, 805
CTMJSA 233
CTMQUICK 361
CTMSIM 834
CTMTAPUL 834
Fast Transfer 321
IOALDNRS 284, 805, 809, 817, 821
Job Order 323
Prerequisite Condition 322
Under ISPF 320
Utilities Transfer Command
PF06/ PF18 94
V
V Option
Active Environment Screen 181, 229
VALUE Attribute
ODATE 64
VALUE Field
Parameter Prompting 342, 346, 360
Variable Assignment
Definition 751
Variable Database
Updating 274
Variable Database Facility 265
Adding Variables 271
Database List Screen 268
Row Numbering 272
Variable List Screen 269
Variable Zoom Screen 272
Index 1035
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
VARIABLE DATABASE Option
IOA Primary Option Menu 87
Variable Database Option
Primary Option Menu 87
Variable Database, IOA 920
Variable List Screen
Variable Database Facility 269
Variable Member
Format 747
Variable Resolution
Concatenation 755
Example 959
Logic 755
Rules 959
Variable Substitution
Variable Resolution 959
Variable Zoom Screen
Variable Database Facility 272
Variables
AutoEdit, Date, Global, KSL, Local, System,
UserDefined ... 737
VAULT DEFINITION Option
Primary Option Menu 90
Version Information
Primary Option Menu 90
VG Command
Active Environment Screen 179, 200
VIEW Command
Active Environment Screen 179, 198
VIEW GRAPH Command
Active Environment Screen 179, 200
View Graph Screen
Color Terminals 201
Fields 202, 204
Format 201
Group Statistics 200
Non-color Terminals 203
TOTAL Field 202, 204
VIEW Option
Active Environment Screen 181, 229
VIEWALL Command
Job Order Execution History 231
VOL=SER=%%VOLSER
Example 792, 793
VTAM 81
Environment 96
PF06/ PF18 94
W
WAIT CONFIRM Status
Show Screen Filter 195
WAIT CONFIRMATION (FOR SCHEDULE) Status
Active Environment Screen 188
WAIT CONFIRMATION (WITH RESTART) Status
Active Environment Screen 188
WAIT CONFIRMATION Status
CONFIRM Parameter 407
WAIT EXEC Status
Show Screen Filter 195
WAIT EXECUTION Status
Active Environment Screen 188
WAIT FOR ODATE Field
Scheduling Confirmation 154
WAIT RELEASE Status
Active Environment Screen 188
WAIT SCHEDULE (PIPE) Status
Active Environment Screen 188
WAIT SCHEDULE (WITH RESTART) Status
Job Rerun 225
WAIT SCHEDULE Field
Global View Screen 199, 202, 204
WAIT SCHEDULE ON SPOOL Status
Active Environment Screen 188
CMEM Forced Job 672
WAIT SCHEDULE Status
Cause or Reason 205
CONTROL Resources 280
Group Entity 558
Job Deletion 210, 242
Job Graph 202, 204
Job Rerun 223, 225
REP3WHY Utility 878
Screen Status 188
Show Screen Filter 195
TERMINATE Option 241
WAIT SUB Status
Show Screen Filter 195
WAIT SUBMISSION Status
Active Environment Screen 188
WAIT_CONF Status
CTMAPI 911
WAIT_ORD Status
CTMAPI 911
WAIT_PIPE Status
CTMAPI 911
WAIT_SCH Status
CTMAPI 912
Warning Message
MEMNAME Parameter 524
TASKTYPE Parameter 643
WCAL Field
WDAYS Parameter 383
WCAL Parameter
Calendar Name 655
Calendar Type 658
Nonperiodic Calendar 656
Periodic Calendar 657
WDATE Parameter
AutoEdit Simulation 328
WDAYS Parameter
Description 654
Example 658
1036 CONTROL-M for OS/390 and z/OS User Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Format 656
Logic 655, 658
MINIMUM Parameter 527
Negative Value 658
PDS Parameter 571
Scheduling Logic 384
WCAL Field 383
WHEN Parameter
SHOUT Parameter 619, 622
WHY Option
Active Environment Screen 180, 205
Why Screen
Adding Conditions 206
Deleting Negative Conditions 207
Deleting NOT-CONDs 207
Example 205
Reasons 205
WAIT SCHEDULE Status 205
Window Exit
RESET Command 100
Windows
Active Environment Screen Delete 210
ADD Conditions 280
CMEM Rule Exit Option 259
CMEM Rule Table Order 262
CMEM Table Deletion 260
Conditions/ Resources Delete 281
CONTROL-M/ Restart
Rerun Confirmation 224
Delete Conditions/ Resources 281
IOA Log Show Screen Window 296, 299
Manual Condition Add 286
Manual Condition Delete 288
Overwrite Confirmation 365
Quick Schedule Definition Exit 369
Rerun Confirmation 222
Resource Quantity 283
Save Documentation 148
Scheduling Facility Exit Option 150
Show Screen Filter 192
Why Screen Confirmation 208
Zoom Screen Confirmation 220
Wish WO0945 263
WITH RESTART Field
Restart Confirmation Window 225
WITH RESTART Status
Active Environment Screen 188
WO0943
APPLY=YES 263
Working Date
Definition 62
System Variable 739
Working Days
WDAYS Parameter 654
WRN Task Type
IOA Log Show Screen Window 299
Show Screen Filter 196
X
X Command
Online Facility Exit 92
X Option
Primary Option Menu 87
Y
YEAR Field
Calendar Definition 312
Calendar Facility Entry Panel 305
Job Scheduling Plan Screen 163
Year List Screen 306
Commands 307
Exiting 319
Inserting New Year 309
Year List Screen, IOA Calendar Facility
Format 307
Z
Z Option
Active Environment Screen 180, 214
ZOOM Option
Active Environment Screen 180
Zoom Screen
Deleting PIPE Statements 813
Exiting 220
Fields 214
Job Order Information 214
MAXRERUN Parameter 512
SHOUT Parameter 623
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. IF MORE THAN ONE LICENSE AGREEMENT
COULD APPLY TO THE PRODUCT, THE FOLLOWING ORDER OF LICENSE AGREEMENT PRECEDENCE APPLIES: (1) WEB BASED LICENSE
AGREEMENT WITH BMC, (2) WRITTEN LICENSE AGREEMENT WITH BMC, (3) SHRINK-WRAP LICENSE AGREEMENT WITH BMC PROVIDED WITH
THE PRODUCT, AND (4) THIS ELECTRONIC LICENSE AGREEMENT WITH BMC. 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 BMC's 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 BMC's 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. 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 Products are and contain valuable confidential information of BMC (Confidential
Information). Confidential Information means non-public technical and non-technical information relating to the 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. BMC's 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, perform an audit, at your
facilities, of 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 Click EULA 071102
Notes
*49874*
*49874*
*49874*
*49874*
*49874*