Control-M Parameter Guide

Supporting
Version 7.0.00 of Control-M/Enterprise Manager Version 7.0.00 of Control-M/Server for UNIX and Microsoft Windows Version 7.0.00 of Control-M/Agent for UNIX and Microsoft Windows

December 2010

www.bmc.com

Contacting BMC Software

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

United States and Canada

Address BMC SOFTWARE INC 2101 CITYWEST BLVD HOUSTON TX 77042-2827 USA Telephone 713 918 8800 or 800 841 2031 Fax 713 918 8000

Outside United States and Canada

Telephone (01) 713 918 8800 Fax (01) 713 918 8000

Copyright 2010 BMC Software, Inc. BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners. DB2 is a registered trademark of International Business Machines Corporation. ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office, and is used here by BMC Software, Inc., under license from and with the permission of OGC. Linux is the registered trademark of Linus Torvalds. SAP, SAP R/3, and SAP NetWeaver are trademarks or registered trademarks of SAP AG in Germany and in several other countries. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. UNIX is a registered trademark of The Open Group. The information included in this documentation is the proprietary and confidential information of BMC Software, Inc., its affiliates, or licensors. Your use of this information is subject to the terms and conditions of the applicable End User License agreement for the product and to the proprietary and restricted rights notices included in the product 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.

Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, see Before contacting BMC.

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

read overviews about support services and programs that BMC offers find the most current information about BMC products search a database for issues similar to yours and possible solutions order or download product documentation download products and maintenance report an issue or ask a question subscribe to receive proactive e-mail alerts when new product notices are released find worldwide BMC 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 or send an e-mail message to [email protected]. (In the subject line, enter SupID:<yourSupportContractID>, such as SupID:12345). Outside the United States and Canada, contact your local support center for assistance.

Before contacting BMC

Have the following information available so that Customer Support can begin working on your issue immediately:

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

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

sequence of events leading to the issue commands and options that you used messages received (and the time and date that you received them) product error messages messages from the operating system, such as file system full messages from related software

Control-M Parameter Guide

Contents
About this book 15 How this book is organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Related Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Online and printed books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Chapter 1 Introduction 19 20 21 23 23 24 25 27 29 31 33 35 39 41 42 43 45 47 49 52 55 57 59 61 63 65 66 70 73 74 76

Defining job processing parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job parameter and variable access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Language support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Abbreviations and conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Conventions for parameter descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2 General parameters

Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AutoEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Control Module (CM) Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Control-M . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Doc Lib. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Doc Mem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Embedded Scripts/JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . File Name/Mem Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Form Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Over Lib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Path/Mem Lib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PIPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table Lib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Contents

Chapter 3

Scheduling parameters

81

Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Adjust Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 And/Or . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Confcal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Days . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Days Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Months . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 PDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Relationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Retro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 SAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Rule-Based Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Statistics Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Statistics Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Week Days . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Weeks Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Chapter 4 Execution parameters 143

Confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Critical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Cyclic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Due Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Max Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Maximum Reruns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Multi Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Node ID/Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Prevent NCT2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Request NJE Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Rerun From . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Rerun Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Scheduling Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 System Affinity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Time From, Time Until . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Chapter 5 Condition parameters 197

In Condition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Out Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Chapter 6 Resource parameters 211

Control Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

6 Control-M Parameter Guide

Quantitative Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Chapter 7 Post-processing parameters 219 221 224 227 230 233 236 240 243 245 247 248 250 252 253 256 256 256 268 280 282 284 289

CTB Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do AutoEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Cond. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do CTBRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Forcejob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do If Rerun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do NOTOK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do OK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Remedy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Rerun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Shout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Stop Cyclic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Do Sysout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . On statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . z/OS and non-z/OS jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Jobs running on computers other than z/OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Jobs running in z/OS environments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reten Days . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reten Gen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Range. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 8 Job Output parameters

Auto-Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 Shout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293 SYSOUT Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302 Chapter 9 Status parameters 311

Status parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 Chapter 10 SAP parameters 313 318 319 320 321 322 323 324 325 326 327 328 329 330
7

ABAP Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Activate Traces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Archive ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Archive Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Archiving Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Background Job Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check Variant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copy From Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copy Spool To . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents

Delete After Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331 Department . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332 Detect Spawned Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333 Document Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335 Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336 Event Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337 External Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338 External Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 InfoPackage Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340 InfoPackage RNR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 InfoPackage Tech. Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 Information Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 Job Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344 Job Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 Job Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346 Job Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 Job Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Job Waiting for External Termination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350 Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351 Log External Errors in Joblog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352 Log External Output to Joblog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 New Job Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 New Spool Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 Number of Copies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357 Object Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 Operating sys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 OS Cover Sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360 Output Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361 Output Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362 Owner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364 Print Archive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365 Print Expiration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366 Process Chain Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367 Process Chain ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368 Process Chain Log ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369 QID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 Recipient. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371 Rerun Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373 SAP-BW Business Process Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 SAP Cover Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 SAP Job Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376 SAP Spool Recipient Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 Selection Cover Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 Session Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 Spool List Recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

Control-M Parameter Guide

Spool List Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Target Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Target Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Target Server (1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Target Server (2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Time of Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Use ABAP Program Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Variant Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 11 Oracle E-Business Suite parameters

381 382 383 384 385 386 387 388 389 390 391 392 393 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 416 417 418 419 420 421 423 427 428 429 430 431 432 433
9

Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Short Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Include Child Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Include Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Include Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameter Validation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Request ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Request Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Responsibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upon completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Wait Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 12 Advanced File Transfer parameters

Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . After the completion of a successful file transfer the source file is. . . . . . . . . . . . . . . Allocation Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Binary/ASCII . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Block Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents

Continue on Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434 DBCS Encoding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435 Encryption Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436 File Transfer Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 Host Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438 Host1 pre command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 Host1 first pre command parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440 Host1 second pre command parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441 Host1 post command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442 Host1 first post command parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443 Host1 second post command parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444 Host2 pre command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445 Host2 first pre command parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446 Host2 second pre command parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447 Host2 post command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Host2 first post command parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449 Host2 second post command parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450 If a file of the same name as the destination file already exists . . . . . . . . . . . . . . . . . . 451 Logical Record Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452 Number of File Transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453 Number of Retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 OS Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 Primary Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 Record Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 Recursive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458 Rename Destination file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459 Rerun from Point of Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460 Secondary Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461 Template Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 Temporary File Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 Trailing blanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 Transfer Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465 Translate Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 Use Configuration Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468 User Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469 Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470 Chapter 13 PeopleSoft parameters 471

Connection Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472 Email Subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473 Email Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474 Email With Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 Process Name (I) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 Process Name (II) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 Process Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 Rerun From Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 Run Control ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
10 Control-M Parameter Guide

Server Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Userdef1/2/3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 14 Microsoft Windows parameters

482 483 484 485 487 488 489 490 491 492 493 494 495 497 499 499 505 509 512 515 515 516 518 520 522 523 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543

Job Execution Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job Memory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Max Work Set Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Min Work Set Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Priority Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Execution Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduling Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 15 Control-M AutoEdit facility

AutoEdit variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job submission variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Control-M system variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User-defined variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Variable lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AutoEdit Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Elementary expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Numeric expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . String Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AutoEdit functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expressions for %%LDA [iSeries (AS/400) only] . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 16 Control-M Business Process Integration Suite parameters

Account (CONTROL-M/CM for BPI Java Applications) . . . . . . . . . . . . . . . . . . . . . . Account (CONTROL-M/CM for BPI Web Services) . . . . . . . . . . . . . . . . . . . . . . . . . . Account (CONTROL-M/CM for BPI Messaging). . . . . . . . . . . . . . . . . . . . . . . . . . . . . Add SOAP Header From File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Array Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assign Job Output to the following AutoEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assign Job Output to the following file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Destination queue/Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exclude Job Output (CONTROL-M/CM for BPI Java Applications) . . . . . . . . . . . . Exclude Job Output (CONTROL-M/CM for BPI Web Services) . . . . . . . . . . . . . . . . Exclude Job Output (CONTROL-M/CM for BPI Messaging). . . . . . . . . . . . . . . . . . . Expiration Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . No Sysout Banner (CONTROL-M/CM for BPI Java Applications) . . . . . . . . . . . . . . No Sysout Banner (CONTROL-M/CM for BPI Web Services) . . . . . . . . . . . . . . . . . . No Sysout Banner (CONTROL-M/CM for BPI Messaging) . . . . . . . . . . . . . . . . . . . .

Contents

11

Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544 Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 Output parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546 Parameter Alias. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547 Parameter Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 Parameter Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550 Property Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551 Property Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552 Reply Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553 Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554 Time to Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 Use Parameters from Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556 Use Free Text Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557 Use Predefined Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558 Wait for Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559 WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560 Index 561

12

Control-M Parameter Guide

Tables
Access to job parameters and variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 General parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Scheduling parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Execution parameters - summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Max Wait parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Node ID and Node Group parameter descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Format - Rerun From Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Conditions parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 Resource parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Job statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Post-processing parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Format - Do NOTOK Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Operating system completion code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Describing formatting of statements from SYSOUT . . . . . . . . . . . . . . . . . . . . . . . . . . 263 PGMST step values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 PROCST step values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 Code values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275 Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 Job Output parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 Shout subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294 SYSOUT Handling formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303 Status parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 SAP panel parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 Add ABAP window parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 Add external program window parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315 Add external command window parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 SAP panel for data archiving parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 SAP-BW General panel parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317 SAP-BW panel, Process Chain parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317 SAP-BW panel, InfoPackage parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317 OAP parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393 Request Set subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413 Single Request subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414 FILE_TRANS panel parameterssummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423 FILE_TRANS panel parametersnotification purposes only . . . . . . . . . . . . . . . . . . . 424 FILE_TRANS panel - Advanced window parametersgeneral . . . . . . . . . . . . . . . . . 424 FILE_TRANS panel - Advanced window parametersOpenSystems/OS400 . . . . 424 FILE_TRANS panel - Advanced window parametersMVS . . . . . . . . . . . . . . . . . . . 425 FILE_TRANS panel - Advanced window parameterssecurity . . . . . . . . . . . . . . . . 425 FILE_TRANS panel - Advanced window parametersFTP Commands . . . . . . . . . 425
Tables 13

PeopleSoft panel parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471 Microsoft Windows parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487 Parameters that accept AutoEdit variables and expressions . . . . . . . . . . . . . . . . . . . 498 General job submission variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500 OpenVMS job submission parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500 iSeries (AS/400) job submission parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501 UNISYS job submission parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 Tandem job submission parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 Control-M system variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 Post-processing system variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508 Variable Prefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510 AutoEdit Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520 JAVA panel parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523 WS panel parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524 MSG panel parameters summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

14

Control-M Parameter Guide

About this book

This book contains detailed information about parameters and variables that can be used in Control-M job processing definitions. Use this book to determine usage and syntax of job parameters and variables for the latest version of all Control-M products.

How this book is organized

This book is organized as follows. In addition, an index appears at the end of the book.
Chapter Chapter 1 Description Introduction Introduces the various types of job parameters and AutoEdit variables described in the rest of the book. General parameters Parameters that identify the job and describe its function. Scheduling parameters Parameters that enable you to specify when and how often a job should be scheduled for submission to Control-M/Server. Execution parameters Parameters that enable you to specify runtime characteristics of the job, pertaining to reruns of the job, in particular. Condition parameters Parameters that enable you to specify interdependent relationships between jobs, using prerequisite conditions. Resource parameters Parameters that enable you to make the availability of system resources a prerequisite for job submission to Control-M/Server. Post-processing parameters Specify how the jobs results should be analyzed and what subsequent actions should be taken. Job Output parameters Describes actions that Control-M and Control-M/EM perform when the job has finished running.

Chapter 2 Chapter 3

Chapter 4

Chapter 5

Chapter 6

Chapter 7

Chapter 8

About this book

15

Related Documentation

Chapter Chapter 9 Chapter 10 Chapter 11

Description Status parameters Describes runtime information about the job. SAP parameters Describes the parameters used to create and run a SAP job. Oracle E-Business Suite parameters Describes the parameters used to create and run an Oracle Business Suite job. Advanced File Transfer parameters Describes the parameters used to create and run an FTP job. PeopleSoft parameters Describes the parameters used to create and run a PeopleSoft job. Microsoft Windows parameters Describes the parameters used to create and run a Microsoft Windows 2000 job. Control-M AutoEdit facility Describes special variables and functions that can be used to make job processing definitions more dynamic. Control-M Business Process Integration Suite parameters Describes the parameters used to create and run a Control-M BPI Suite job (Java Applications, Web Services or Messaging).

Chapter 12 Chapter 13 Chapter 14

Chapter 15

Chapter 16

Related Documentation
The following list describes other BMC publications that are relevant to the parameters and variables described in this book.

Control-M User Guide describes Control-M concepts, features, facilities, and operating instructions. In addition, it describes how Control-M/Desktop is used to define and manage Control-M job processing definitions, tables, and calendars. It can be used as a learning guide as well as a reference guide. Control-M Administrator Guides describes the tasks that the Control-M administrator must perform to define, monitor and maintain the Control-M environment. Control-M Utility Guide describes the utilities used for creating and managing objects in the job production environment and maintaining various aspects of Control-M. Control-M Installation Guide describes the installation processes for implementing Control-M/EM, Control-M/Server and Control-M/Agent environments on Microsoft Windows and UNIX computers.

16

Control-M Parameter Guide

Online and printed books

Control-M for z/OS User Guide is a complete guide to the Control-M Production Control System in a mainframe environment. Control-M/Enterprise Manager API Developers Guide describes how to enable your applications to submit requests to Control-M/EM. Control-M Business Service Management Solution User Guide describes BMC Batch Impact Manager, Control-M/Forecast, and BMC Batch Discovery concepts, features, facilities, installation, and operating instructions. It can be used as a learning guide, as well as a reference guide. Control-M/Control Module for ORACLE E-Business Suite Administrator Guide explains how to define and monitor jobs using the Oracle E-Business Suite Panel of the Job Editing form. Control-M/Control Module for PeopleSoft Administrator Guide explains how to define and monitor jobs using the PS8 Panel of the Job Editing form. Control-M/Control Module for SAP Administrator Guide describes BMC Softwares batch management solution for SAP. Control-M Messages Manual describes messages that are displayed on the server computer as well as those recorded in the Control-M log.

Online and printed books

The books that accompany BMC Software products are available online and in printed format. You can view online books with Acrobat Reader from Adobe Systems. The reader is provided at no cost, as explained in Access online books. You can also obtain additional printed books from BMC Software, as explained in Request additional printed books.

Access online books

Online books are provided as Portable Document Format (PDF) files. You can view them, print them, or copy them to your computer by using Acrobat Reader 4.0 or later. You can access online books from the documentation compact disc (CD) that accompanies your product or from the World Wide Web. In some cases, installation of Acrobat Reader and downloading the online books is an optional part of the product-installation process. For information about downloading the free reader from the Web, go to the Adobe Systems site at http://www.adobe.com.

About this book

17

Online and printed books

To view any online book that BMC Software offers, visit the support page of the BMC Software Web site at http://www.bmc.com/support.html. Log on and select a product to access the related documentation. (To log on, first-time users can request a user name and password by registering at the support page or by contacting a BMC Software sales representative.)

Request additional printed books

BMC Software provides a core set of printed books with your product order. To request additional books, go to http://www.bmc.com/support.html.

18

Control-M Parameter Guide

Chapter

Introduction
In the Control-M job scheduling environment, jobs are tasks that can be performed by a computer. These tasks are handled according to parameters. The parameters specified for a particular job are collectively referred to as a job processing definition.

NOTE
The term job as used in this manual refers to any task that can be performed by a script or command that is handled by Control-M/Server.

Job processing parameters only need to be defined once for each job. Control-M uses the job processing definition each time a job is ordered. Definitions can be modified at any time using various Control-M/EM facilities. These definitions are created using Control-M/Desktop and are stored in tables (job directories) according to various criteria that you determine. The tables are uploaded to Control-M/EM. When the scheduling criteria of the table are met, the jobs are passed to the Control-M/Server database. Job parameters are composed primarily of static information. However, a job processing definition may need to include information that is subject to change or was not available when the definition was created (such as the time at which a job was submitted, or the name of the batch queue to which the job was submitted.). Control-M/EM enables you to replace that data with AutoEdit variables. You can use both pre-defined AutoEdit variables and those that you create. See also: Defining job processing parameters Job parameter and variable access Language support Abbreviations and conventions Conventions for parameter descriptions

Chapter 1 Introduction

595

Defining job processing parameters

Defining job processing parameters

This help assumes that your primary point of access for creating job processing definitions is the Job Editing form. Nonetheless, information is also provided for creating definitions using other Control-M components. Job processing definitions can be created using any of the following methods:

Control-M/Desktop. Use the Job Editing form or the Mass Creation facility to create definitions offline. You can then upload the jobs to the Control-M/EM database. Control-M/EM. Use the Job Editing form to modify parameters for jobs that have already been scheduled for submission on the current day. For more information about the Job Editing form, see the Control-M User Guide. Control-M/EM. Use various Control-M/EM utilities to define or modify job processing definitions. For more information, see the Control-M Utility Guide. Control-M/Server, Control-M for z/OS, and Control-M/Agent. Use Control-M batch utilities or the online facility [z/OS or iSeries (AS/400)] to define or modify job processing definitions. If you are using Control-M batch utilities and want to use a special character, such as >, <, or |, when setting the value of a job parameter, you must enclose the entire expression in double quotation marks, for example ">9".

NOTE
All job processing definitions are stored in the Control-M/EM database and are uploaded to the CONTROL-M/Server database.

The parameters of job processing definitions can also be used as selection criteria

To determine the content of the ViewPoints that indicate which nodes are displayed in the Control-M/Desktop window and the Control-M/EM flow diagram To determine which jobs are included in a report created using the Reporting facility

596

Control-M Parameter Guide

Job parameter and variable access

Job parameter and variable access

The Job Editing form is divided into tabs, as shown in Table 155. Each tab contains parameters that have similar functions. The division of the sections in this help reflects the division of the job processing parameters in the Control-M/EM Job Editing form. For example, to learn about a parameter that is displayed on the General panel of the Job Editing form, see Chapter 2, General parameters. Table 155 Access to job parameters and variables
Panel General Tab Contents Contains General parameters. These parameters provide information about the job and explain what the job does. In addition, they include miscellaneous parameters that relate to how the job is executed and preparations that are performed before the job is executed. For more information, see Chapter 2, General parameters. Scheduling Tab Contains Scheduling parameters. These parameters determine the time period (days, months, and hours) during which the job can be submitted for execution. If a job is a candidate for execution, it is placed in the Active Jobs file. For more information, see Chapter 3, Scheduling parameters. Note: For more information about original scheduling dates, see the description of using system parameters in the Control-M Administrator Guide. Application Tab Contains parameters for the specified application on which the job runs (for example, SAP or Oracle E-Business Suite). The title and content of the Application panel change depending on which application is specified. For more information, see Chapter 10, SAP parameters, Chapter 11, Oracle E-Business Suite parameters, and Chapter 14, Microsoft Windows parameters. Execution Tab Contains Execution parameters. These parameters determine where, how often, and with what priority the job is executed, after it has been submitted for processing. For more information, see Chapter 4, Execution parameters.

Chapter 1 Introduction

597

Job parameter and variable access

Table 155 Access to job parameters and variables

Panel Conditions Tab Contents Contains Condition parameters. These parameters specify information about the time period (days, months, and hours) which must be satisfied before determining when the job can be submitted for execution. These parameters also determine whether conditions are to be added or deleted after the job run is successfully completed. For more information, see Chapter 5, Condition parameters. Resources Tab Contains Resource parameters. These parameters specify information about physical and logical requirements that must be met before the job can be submitted for execution. For more information, see Chapter 6, Resource parameters. Set Tab Contains facilities for defining and specifying AutoEdit variables. AutoEdit variables are used to insert dynamic information into the values of job processing parameters. For more information, see Chapter 15, Control-M AutoEdit facility. Steps Tab Contains Post Processing parameters. These parameters specify actions that should be performed by Control-M when the job is finished executing or has failed to run. For more information, see Chapter 7, Post-processing parameters. PostProc Tab Contains Job Output parameters. These parameters specify actions that Control-M and Control-M/EM perform that are a direct result of the output of the job. For more information, see Chapter 7, Post-processing parameters. Active Tab Contains Status parameters. These parameters describe scheduling, status, and statistical information that was collected during job runtime. The values for these parameters are supplied by Control-M. The Active panel is displayed only in the Control-M/EM Job Editing form, because the data displayed in it is based on previous runs of the job. For more information, see Chapter 9, Status parameters.

AutoEdit variables are also described in this help.

598

Control-M Parameter Guide

Language support

Language support
Western European language special characters can be specified for most parameters in which free text can be entered. A list of all parameters that can contain these characters is provided in the Control-M Language Customization Guide. In this help, the term non-English characters in the Invalid Characters section of each parameter description indicates that the parameter only supports Western characters. The following characters are not supported for any parameter under any circumstances:

Abbreviations and conventions

The following abbreviations are used in this help:
Abbreviation Control-M/EM Control-M/CM Description CONTROL-M/Enterprise Manager Control-M Control Module

The following conventions are used in this help:

key When describing keystrokes, boldface type is used for the name of a key (for example, F1). When two keys are joined with + as in Shift+F1, hold down Shift while pressing F1. This represents an option selection sequence. For example, Users and Groups => Groups => Add means that you first select Users and Groups from the menu bar. Select the Groups option from the submenu. Finally, select the Add option from the Groups submenu. { } (braces) Braces indicate that at least one of the enclosed elements is required. For example: {fileName | deviceName| mediaType} means that you must specify one of the variables.

Menu => Option

Chapter 1 Introduction

599

Conventions for parameter descriptions

{Option A|Option B} [Option] Code Samples Messages Boldface

The vertical bar is used to separate choices. For example: {AND|OR} means that you specify either AND or OR. Square brackets are used to enclose parameters that are optional. Format syntax, operating system terms, examples, and JCL scripts are presented in this typeface. Messages are presented in this typeface. In instructions, boldface type highlights information that you enter. File names, directory names and paths, parameter names, and options are also in boldface. 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

Option Symbol

Conventions for parameter descriptions

The following terms are used to describe the format of parameters in this help:

Usage Indicates whether a parameter is mandatory or optional. Some parameters are mandatory only when Control-M is installed on a certain computer. Some parameters are mandatory only when a related parameter is specified (for example, PDS and Minimum must be specified together).

Case sensitive Indicates that Control-M differentiates between values specified using various combinations of uppercase and lowercase letters. For example, the prerequisite condition JOB_ENDED_OK is different from the prerequisite condition Job_Ended_OK. A job waiting for JOB_ENDED_OK is not submitted if only Job_Ended_OK is found.

Invalid Characters Indicates, when specifying the parameter, whether there are any special characters that cannot be used embedded blanks (spaces) can be used Trailing blanks (after the specified value) are ignored. AutoEdit Support Indicates whether AutoEdit variables can be included in the value of the specified parameter.

600

Control-M Parameter Guide

Chapter

General parameters
The parameters described in this section contain basic information that identifies the job, describes what it does, and gives the location of the job script. Table 156 General parameters summary
Parameter Application Application Type Application Version Author AutoEdit Command Description Name of the application to which the jobs group belongs. Used as a descriptive name for related groups of jobs. Indicates the type of external application (for example, SAP or Oracle E-Business Suite) on which the job runs. Indicates the version of the external application (for example, SAP or Oracle E-Business Suite) on which the job runs. Control-M/EM user who defined the job. This parameter is used by the Control-M security mechanism. Used to assign values to user variables to be referenced in the job script or in other parameters of the job. It is also called Set Var. Operating system command line to be issued. This parameter can be specified only when Command is specified for the Task Type parameter. Indicates the version of the external application (for example, SAP or Oracle E-Business Suite) Control Module (CM) that is installed in the Control-M installation (that is, that runs the job). Name of the Control-M/Server to which the job belongs. Free text description of the job. Name of a library or directory containing the job documentation file. Name of the file containing job documentation. A scheduled script that is part of the job definition. Name of the file that contains the job script, or (for z/OS jobs only) name of a member that contains one of the following in relation to the job to be executed: the JCL of the job the started task procedure warning messages

Control Module (CM) Version Control-M Description Doc Lib Doc Mem Embedded Scripts/JCL File Name/Mem Name

Chapter 2

General parameters

601

Table 156 General parameters summary

Parameter Form Name Group Job Name Job Type Description Type of form used for entering external application data. Name of the group to which the job belongs. Name of the job. Generally, an identifier name indicating the type of external application (for example, SAP...). In this case, the parameter represents a combination of the following parameters: Application Type, Application Version, CM Version, and Form Name. Jobs not belonging to an external application have a job type of either Control-M BIM (for Batch Impact Manager jobs), or OS (for all other jobs). Over Lib Name of an alternate library/directory. Control-M searches for the file specified in the File Name parameter in the Over Lib library before searching for it in the Path library. Owner (user ID) associated with the job. This parameter is used by the Control-M security mechanism. Name of the directory in which the job script resides, or (for z/OS jobs only) name of the library in which the member described in the Mem Name parameter is located. Indicates a data set to be replaced by a pipe with the same name. Displayed only if MAINVIEW Batch Optimizer is installed. [For z/OS jobs only.] Name of the library that contains the table. (For z/OS jobs only) Name of the table or SMART Table. In the job editing form this field indicates the table to which the job belongs. Type of the job (task) to be performed by Control-M.

Owner Path/Mem Lib

PIPE

Table Lib Table Task Type

602

Control-M Parameter Guide

Application

Application
Provides a logical name for sorting groups of jobs. This parameter is used to supply a common descriptive name to a set of related groups of jobs.

Format
Usage Mandatory z/OS: Optional Default Length Case Sensitive Invalid Characters AutoEdit Support None 1-64 characters Yes

Blanks Single quotation marks.

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter. However, the value of Application can be specified using the %%APPL and %%APPLIC AutoEdit variables.

Related parameters
Parameter Group Description Group is also a logical name. Both the Application and Group parameters can be used to create logical groupings of jobs. Neither parameter has a direct effect on job execution.

General information
The Application parameter facilitates more convenient and orderly management of groups of production jobs. The value assigned to the Application parameter can be used to determine the placement of jobs in the Control-M flow diagram. It can also be used as a criterion for building a ViewPoint.

Aliases in other Control-M components

Alternate names for the Application parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Parameter Name APPLICATION APPLICATION

Chapter 2

General parameters

603

Application

Component Control-M/Server Utilities Control-M for z/OS Control-M/EM API

Parameter Name -application APPL application

Example: Identifying jobs by business department

To identify all jobs created by the accounting department: Application: ACCT

604

Control-M Parameter Guide

Application Type

Application Type
Indicates the application (for example, SAP or Oracle Applications) that runs the job.

NOTE
In the job editing form prior to Control-M/EM version 6.3.01, the Application Node Group parameter was tightly linked to the Application Type parameter. Beginning with ControlM/EM version 6.3.01, you select the application node group in the Node ID/Group field (in the Execution tab of the job editing form).

Format
Usage Default Length Case Sensitive Invalid Characters AutoEdit Support Optional OS (Indicates that the job is run by the operating system.) 1-10 characters No Blanks; single quotation marks No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Application Version Control Module (CM) Version Form Name Job Type Description Indicates the version of the application that is specified with the Application Type parameter. Indicates the version of the Control Module (CM) that is used to run the job. Type of form used for entering external application data. Identifier name indicating the type of external application (for example, SAP...). This parameter represents a combination of the following parameters: Application Type, Application Version, CM Version, and Form Name. Name of a Control-M/Agent computer, remote host computer, or node group to which the job should be submitted.

Node ID/Group

General information
The control module of the application specified in this parameter must be installed in the Node Group where the job will run.

Chapter 2

General parameters

605

Application Type

Availability
This parameter is supported by Control-M/Server versions 6.1.xx and later, and Control-M for z/OS versions 6.2.xx and later.

Aliases in other Control-M components

Alternate names for the Application Type parameter are listed below.
Component Control-M/EM Utilities e-Trigger Control-M/Server Utilities Control-M/EM API Parameter Name APPL_TYPE Application Type -appltype application_type

Example: Submit a job to an Oracle application

Specify the following information in the Control-M/Server ctmcreate utility to schedule Control-M/Agent everest to submit a job to Oracle E-Business Suite (OEBS).
ctmcreate -tasktype external -application ORACLE -nodegrp everest -appltype OAP

606

Control-M Parameter Guide

Application Version

Application Version
Indicates the version of the application (for example, SAP or Oracle E-Business Suite) on which the job runs.

Format
Usage Length Default Case Sensitive Invalid Characters AutoEdit Support Optional 1-10 characters None Yes Blanks; single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Availability
This parameter is supported by Control-M/Server versions 6.1.xx and later, and Control-M for z/OS versions 6.2.xx and later.

Related parameters
Parameter Application Type Description The type of application whose version is specified by the Application Version parameter.

Control Module Control Module for the application that runs the job. (CM) Version Form Name Job Type Type of form used for entering external application data. Identifier name indicating the type of external application (for example, SAP ...). This parameter represents a combination of the following parameters: Application Type, Application Version, CM Version, and Form Name.

Node ID/Group Name of a Control-M/Agent computer, remote host computer, or node group to which the job should be submitted.

General information
For a list of supported versions, see the Administrator Guide for the appropriate Control-M/Control Module.

Chapter 2

General parameters

607

Application Version

Aliases in other Control-M components

Alternate names for the Application Version parameter are listed below.
Component Control-M/EM Utilities e-Trigger Control-M/Server Utilities Control-M/EM API Parameter Name APPL_VER Application Version -applver application_version

608

Control-M Parameter Guide

Author

Author
Indicates the Control-M/EM user who defined the job.

NOTE
This parameter is not relevant in z/OS environments.

Format
Usage Default Length Case Sensitive Invalid Characters AutoEdit Support Mandatory. Name of the Control-M/EM user that created the job. 1-64 characters Yes Blanks; single quotation marks No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

NOTE
Depending on the value of the AuthorSecurity system variable, this parameter may be disabled.

General information
The Control-M/EM user specified by this parameter must possess a valid user ID registered in the Control-M installation. Authority to perform actions is verified by Control-M/Server security exits. This parameter is used by the Control-M/Server for verifying if the owner of the job has authorization to submit the job processing definition during the submission of jobs by the New Day Procedure. If the AuthorSecurity system parameter is set to author security mode 2 or 3 (restricted), you cannot edit the Author field unless you are a Control-M/EM administrator and are online (that is, connected to a GUI server). For more information, see the Security chapter and the description of the AuthorSecurity system parameter in the Control-M Administrator Guide.

Computer-specific information
For more information, see the Security chapter of the Control-M Administrator Guide for the appropriate computer.

Chapter 2

General parameters

609

Author

Aliases in other Control-M components

Alternate names for the Author parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Parameter Name AUTHOR AUTHOR -author

610

Control-M Parameter Guide

AutoEdit

AutoEdit
Assigns a value to an AutoEdit variable. AutoEdit variables can be used to pass values to job submission parameters or to control other aspects of job submission. It is also called Set Var.

Format
Usage Format Optional The format for each AutoEdit is: %%variable-name=value variable-name has the following characteristics: Length Invalid Characters AutoEdit Support Length Up to 40 characters (including the %% prefix). Blanks and the following characters: < > [ ] { } ( ) = ; ~ | : ? . + - */ & ^# @ ! , " ' Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter. Up to 4,000 characters. Note: Due to limitations of the size of environment variables in operating systems of the computers where jobs run, values of AutoEdit variables that are converted to environment variables by the agent might be limited to less than 4,000 characters. Case Sensitive Yes Invalid Characters AutoEdit Support Embedded blanks (leading blanks are valid) Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter. Case Sensitive Yes

value has the following characteristics:

z/OS: AutoEdit (and both variable-name, and value) have the following characteristics: Length The total length of AutoEdit must not exceed 55 characters, including the %% prefix, variable-name, value, and the = sign. Blanks Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Case Sensitive Yes Invalid Characters AutoEdit Support

Chapter 2

General parameters

611

AutoEdit

Related parameters
Do AutoEdit Indicates an AutoEdit expression that depends on how the job ended (OK or NOTOK) and can be used to influence other jobs, or subsequent runs of the current job.

General information
AutoEdit variables are special variables that have a prefix of %%. They can be used to

pass parameters to, or influence the environment of a job when it is submitted define variables to be used in Shout messages or in Do AutoEdit parameters when the job terminates

Parameters that accept AutoEdit variables

AutoEdit variables can be specified as values for any of the following job processing parameters. These variables are resolved to actual values at time of job submission.

Command Do Mail (the To and Message fields) Do Shout (the Destination and Message fields) Do Sysout (Prm field) File Name In Condition (system variables can be specified as the entire value) Mem Lib Mem Name Out Condition (system variables can be specified as the entire value) Over Lib Path Quantitative Resource (system variables can be specified as the entire value) Shout (the Destination and Message fields) Step Range Sysout (Prm parameter)

NOTE
Control-M/CM fields can also contain AutoEdit variables.

For more information about AutoEdit variables and how they can be used, see Chapter 15, Control-M AutoEdit facility.

612

Control-M Parameter Guide

AutoEdit

Aliases in other Control-M components

Alternate names for the AutoEdit parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name AUTOEDIT Setvar -autoedit SET VAR autoedit_assignment

Alternate formats in other Control-M components

Alternate formats for the AutoEdit parameter are listed below.
Component Control-M/EM Utilities Format The value of the AUTOEDIT parameter is contained in the EXP subparameter. Example: <AUTOEDIT EXP="%%PARM1=%%TIME"/>

Example 1: OpenVMS
An OpenVMS job has the following job processing parameters and values:
Parameter File Name (Mem Name) Path (Mem Lib) AutoEdit Value MTJOB.COM DUA0:[SALARY.JAN] %%PARM1=%%CALCDATE %%ODATE -2 %%PARM2=TRacct124

If %%ODATE is 051203 (for December 3, 2005), the parameters described above would cause Control-M to invoke the command file using the following OpenVMS command:
SUBMIT DUA0:[SALARY.JAN]MTJOB.COM/ PARAM = (051201, TRacct124)

NOTE
To submit a DCL file that uses logical names that should be translated before submission, define a job (with Task Type parameter Command) that performs the required ASSIGN or DEFINE command (OpenVMS command).

Chapter 2

General parameters

613

Command

Example 2: UNIX
A UNIX job has the following job processing parameters:
Parameter File Name (Mem Name) Path (Mem Lib) AutoEdit Assignment Value mtjob.sh $HOME/jobs %%PARM1=%%CALCDATE %%ODATE -2 %%PARM2=TRacct124

If %%ODATE is 051203 (for December 3, 2005), the parameters described above would cause Control-M to invoke the script using the following UNIX command:
$HOME/jobs/mtjob.sh 051201 "TRacct124"

Example 3: iSeries (AS/400)

An iSeries (AS/400) job has the following job processing parameters:
Parameter Job Name File Name (Mem Name) Path (Mem Lib) AutoEdit Value EODJOB EODJOB ACCOUNTING %%PARM1=%%ODATE %%PARM2=%%TIME %%LDA_1_6=%%ODATE %%LDA_7_2=%%ODAY %%SWS=00000001 %%LIBL=QTEMP ACCLIB

If %%ODATE is 060127 (for Jan. 27, 2006), the parameters described above would cause Control-M to submit the job using the following iSeries (AS/400) commands:
CHGDTAARA *LDA(1 6) VALUE(060127) CHGDTAARA *LDA(7 2) VALUE (27) SBMJOB JOB (EODJOB) RQSDATA (CALL PGM (ACCOUNTING/EODJOB) PARM (060127 110312)) SWS (00000001) INLLIBL (QTEMP ACCLIB))

Command
Indicates an operating system command line entry to be submitted as a job.
614 Control-M Parameter Guide

Command

NOTE
This parameter is not relevant in z/OS environments.

Format
Usage Length Case Sensitive This parameter can be used only if the Task Type parameter is Command. In this case, the Command parameter is required. 1 through 512 characters

Microsoft Windows: No UNIX: Yes

Invalid Characters None AutoEdit Support Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

General information
Use this parameter to specify an operating system command to be executed by Control-M. The command should be specified exactly as it would be specified in a terminal for the specific computer. Control-M creates a temporary file that contains the command. This file is submitted for execution, and is monitored and analyzed in the same manner as a regular job. The command can include any combination of text and AutoEdit variables. However, the length of the command after resolution of AutoEdit variables must not exceed 999 characters. For more information about AutoEdit variables, see Chapter 15, ControlM AutoEdit facility.

Computer-specific information

Commands submitted to a UNIX computer are executed using the Bourne shell. For Control-M/Agent for iSeries (AS/400) version 2.1.3, commands must not include single quotation marks ( ). If quotation marks are necessary, use double quotation marks ( ) only.

Aliases in other Control-M components

Alternate names for the Command parameter are listed below.

Chapter 2

General parameters

615

Control Module (CM) Version

Component Control-M/EM Utilities Reporting Facility Control-M/EM API

Parameter Name CMDLINE CMD LINE command

Control-M/Server Utilities -cmdline

Example 1: OpenVMS
BACKUP DUA0:[000000...] MUA0:MONBKP/SAVE

Example 2: UNIX
tar cvf /dev/rmt0 -c /home

Example 3: iSeries (AS/400)

SAVLIB LIB(LIB_1 LIB_2) DEV(TAP02)

Example 3: iSeries (AS/400)

The command in this job uses the Control-M ctmcontb utility to delete all prerequisite conditions that are more than five days old.
AutoEdit Assignment Command %%A=%%CALCDATE %%DATE -365 %%B=%%CALCDATE %%DATE -5 ctmcontb deletefrom %%A %%B

NOTE
For Windows agents: When specifying AutoEdit variables in the CMDLINE or COMMAND parameters on Control-M/Agent for Windows, the AutoEdit prefix must be specified as %%%% instead of %%.

Control Module (CM) Version

Indicates the version number of the Control Module (CM) that is used to run the job.

616

Control-M Parameter Guide

Control Module (CM) Version

Format
Usage Length Default Case Sensitive Invalid Characters AutoEdit Support Optional 1-10 characters None No Blanks; single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Availability

This parameter is not supported by Control-M versions earlier than 6.1.00. This parameter is not supported by Control-M for z/OS.

Aliases in other Control-M components

Alternate names for the Control Module Version parameter are listed in the table below.
Component Control-M/EM Utilities Control-M/Server Utilities Reporting Facility e-Trigger Control-M/EM API Parameter Name CM_VER -cmver CM VER CM Version application_cm_version

Chapter 2

General parameters

617

Control-M

Control-M
Name of the Control-M installation that processes the job.

Format
Usage Length Default Case Sensitive Invalid Characters AutoEdit Support Mandatory 1 through 20 characters None Yes Blanks; single quotation marks No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
Control-M names are specified for each data center when creating the Control-M definition in Control-M/EM and Control-M/Desktop. The name should describe the specified Control-M installation and be easily recognized by users. In the Job Editing form, select the Control-M installation instance from the list.

Aliases in other Control-M components

Alternate names for the Control-M parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Parameter Name DATACENTER DATA CENTER

Control-M/Server Utilities Not supported. Jobs created with a Control-M/Server utility are submitted to the local Control-M/Server installation. Control-M for z/OS Control-M/EM API When a job is created, it is submitted to the local Control-M for z/OS installation. control-m

618

Control-M Parameter Guide

Description

Description
Provides a description of the job in free text.

Format
Usage Length Case sensitive Invalid Characters AutoEdit Support Optional 1-4,000 characters Yes None No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Description parameter is used to describe the job. A well written description can help you determine why the job was defined and how it fits into your business environment.

NOTE
Special characters, such as single quotation marks, double quotation marks, left or right brackets ([ ]), left or right parentheses(( )), and asterisks(*), should not be used in the description text string.

Computer-specific information
Control-M for z/OS 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 SCHEDULE-PREV-DAY or SCHEDULE-PREV-ONLY string 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. (For version 6.0.00 and later, the SAC parameter is used instead.)

Aliases in other Control-M components

Alternate names for the Description parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Parameter Name DESCRIPTION DESCRIPTION

Chapter 2

General parameters

619

Description

Component Control-M for z/OS Control-M/EM API

Parameter Name DESC description

Control-M/Server Utilities -description

Example: Description of a job for producing a yearly report

The description of a report detailing the years revenues and expenditures. Yearly Financial Report for 2005

620

Control-M Parameter Guide

Doc Lib

Doc Lib
Name of the library/directory containing the job documentation file (specified in the Doc Mem parameter).

Format
Usage Length Optional

Microsoft Windows and UNIX: 1-255 characters iSeries (AS/400): 1-21 characters OpenVMS: 1-60 characters z/OS: 1-44 characters

Case Sensitive Invalid Characters AutoEdit Support

Yes z/OS: Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Doc Mem Description Name of the file containing job documentation. This file is located in the library specified in the Doc Lib parameter.

General information
The library or directory specified by this parameter, and the file specified in the Doc Mem parameter, do not have to exist when the job processing parameters are defined. If you specify this parameter, you must also specify a value for the Doc Mem parameter.

NOTE
To access the documentation, the user must be defined and have authorization on the ControlM where the documentation resides.

Chapter 2

General parameters

621

Doc Lib

Computer-specific information
Computer UNIX Format Specify the name of the directory and subdirectories (if any). One of the following symbols can be used in place of or as part of the directory or subdirectory name (these symbols are resolved at the time the job is ordered or forced):

$HOME resolves to the home directory of the job owner. ~<username> resolves to the home directory of the specified UNIX user.

iSeries (AS/400) You must specify one of the following: Name of an iSeries (AS/400) library Library / File *LIBL (library list) *CURLIB (current library) OpenVMS The directory can be specified as the physical path or as an OpenVMS logical name.

Aliases in other Control-M components

Alternate names for the Doc Lib parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name DOCLIB DOC LIB -doclib DOCLIB doc_lib

Example 1: OpenVMS
DUA0:[ACCOUNT.DOC], ACCDOC$DIR

Example 2: UNIX
$HOME/ctm/account/doc

622

Control-M Parameter Guide

Doc Mem

Doc Mem
Name of the file in which the job documentation is stored.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Optional 1-64 characters z/OS: 1-8 characters Yes

Blanks z/OS: Non-English characters

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter

Related parameters
Parameter Doc Lib Description Provides the name of the library or directory in which a member described in the Doc Mem parameter is located.

General information
The Doc Mem parameter is normally specified together with the Doc Lib parameter.

NOTE
To access the documentation, the user must be defined and have authorization on the ControlM where the documentation resides.

Computer-specific information

iSeries (AS/400) Doc Mem indicates the name of the member in the Libl file. On this computer, the Doc Mem parameter is optional even if a value is supplied for Doc Lib. If a library and file name are specified in Doc Lib but no value is specified for Doc Mem, the *FILE default member name is used (for example, the member name is the same as the file name).

Chapter 2

General parameters

623

Doc Mem

Aliases in other Control-M components

Alternate names for the Doc Mem parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name DOCMEM DOCMEM -docmem DOCMEM doc_member

624

Control-M Parameter Guide

Embedded Scripts/JCL

Embedded Scripts/JCL
A scheduled script that is part of the job definition.

Format
Usage Default Length Case Sensitive Auto Edit Support Optional None Script size: 64000 B Yes No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter. Instead %%PARM can be used to pass parameters to the embedded script. See Job submission variables on page 1073.

Subparameters
Use Embedded Script/JCL Check box: Selected - The job will be submitted from the embedded script./JCL Clear - The job will be submitted from the file name/member specified in the Path/Mem Lib parameter.

Related parameters
Parameter Description

File Name/Mem File name extension determines how the script will run. Name Path/Mem Lib The Path field is ignored when attaching an embedded script. z/OS: Indicates the name of the library where the member containing JCL required for the job is located. Over Lib This field is ignored when attaching an embedded script.

General information
The Use Embedded JCL, previously called In-Stream JCL, is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later and for jobs running in Control-M/Server for UNIX. It enables you to create and edit a JCL stream. This stream is saved as part of the job scheduling definition. When the job runs, the stream is submitted from the job scheduling definition, without having to retrieve the JCL from the member identified in the MEMLIB parameter.

Chapter 2

General parameters

625

Embedded Scripts/JCL

The Use Embedded Script is relevant only for jobs running on non Control-M for z/OS platforms. It enables the script to be manually entered or copied from the local file system and saved in the job definition. After loading the script, if a file name has not already been selected, the selected scripts file name appears in the File Name field. If an embedded script has been selected, the Path and Over Lib fields are ignored. When using Use Embedded Script and loading it from a file, rebuild the Active Jobs file and reload the schedules for the day. In Windows, the files extension determines how the embedded script runs. In UNIX, the script runs according to the interpreter entered in the first line of the embedded script. Examples of an interpreter shell are Bourne Shell (/bin/sh), Korn Shell (/bin/ksh), and C-Shell (/bin/csh).

Aliases in other Control-M components

Alternate names for the Use Embedded Script/JCL (flag) parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name USE_INSTREAM_JCL Use In-stream Jcl (none) INSTREAM JCL use_instream_jcl

Aliases in other Control-M components

Alternate names for the Embedded Script/JCL parameters are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name INSTREAM_JCL In-stream Jcl embedded_script INSTREAM JCL instream_jcl

626

Control-M Parameter Guide

File Name/Mem Name

File Name/Mem Name

Indicates the name of a file containing the control language statements for the job (or detached process) to be executed.

Format
Usage Length Mandatory if Task Type is Job or Detached or External

Microsoft Windows, UNIX, OpenVMS: 1-64 characters iSeries (AS/400): 1-21 characters z/OS: 1-8 characters Blanks, \, /, or * z/OS: Non-English characters

Case Sensitive Invalid Characters AutoEdit Support

Yes

Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Related parameters
Parameter Path/Mem Lib Over Lib Description Indicates the name of the library or directory in which the file described in the File Name parameter is located. Provides the name of an alternate library or directory. Control-M searches for the file specified in the File Name parameter in the Over Lib directory before searching for it in the Path library. Specifies the type of task of the job performs. Determines the value of the Mem Name (MEMNAME) parameter for z/OS jobs.

Task Type

General information
The File Name parameter should contain only the name of the file, not the full path. The Path parameter is used to specify the remainder of the path. The File Name can be the same as or different from the job name. Each member contains only one job. The File Name may appear in the job node displayed in the Control-M/EM window (depending on options specified in the Control-M/EM Options dialog box). The File Name extension determines how an Embedded Script/JCL runs. For more information, see Embedded Scripts/JCL on page 625.

Chapter 2

General parameters

627

File Name/Mem Name

NOTE
Character masks are not supported (for example, a job with a FR*.EXE File Name value is not executed).

Computer-specific information
The command must conform to the following conventions:
Computer Microsoft Windows UNIX OpenVMS Information Name of a command file or an executable file. Name of a UNIX shell script file. Name of the command file. It can be specified using one of the following formats:

Without file extension (for example, JOBFILE): Control-M adds the appropriate extension according to the Task Type parameter: .COM for job (batch job), .EXE for Detached (detached process). When the file name is specified without a version specification, the last version of the file is executed. With full file extension, including the version specification (for example, JOBFILE.COM;2 or JOBFILE.EXE;5).

Note: Using the full file extension format, it is possible to select a specific file extension and version of the command file or detached process to be executed. iSeries (AS/400) z/OS An executable program object. Name of a member whose contents are determined by the Task Type parameter.

JCL of the job Started task procedure Warning messages

628

Control-M Parameter Guide

File Name/Mem Name

Aliases in other Control-M components

Alternate names for the File Name parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name MEMNAME MEMNAME -memname MEMNAME mem_name

Example 1: Microsoft Windows

myjob.bat, myjob.cmd, myjob.exe

Example 2: UNIX
myjob

Example 3: OpenVMS
MYJOB, MYJOB.COM, MYJOB.COM;2, MYJOB.EXE, MYJOB.EXE;4.

Example 4: iSeries (AS/400)

MYJOB

Chapter 2

General parameters

629

Form Name

Form Name
Type of form used for entering external application data.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Mandatory for External Application jobs 1-30 characters Yes Blanks; single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Application Type Application Version Control Module (CM) Version Job Type Description Indicates external application server types communicating with Control-M/Agent. Indicates the version of the external application server communicating with Control-M/Agent. Indicates the version of Control Module (CM) supported by ControlM/Agent. Identifier name indicating the type of external application (for example, SAP ...). This parameter represents a combination of the following parameters: Application Type, Application Version, CM Version, and Form Name. Name of a Control-M/Agent computer, remote host computer, or node group to which the job should be submitted.

Node ID/Group

General information
Beginning with Control-M/EM versions 6.3.01, this parameter is no longer used in the job editing form, but is used in other locations such as utilities. (In the job editing form, the Job Type field determines which application type, version and CM Version are used, and which form is displayed as a job editing form tab.)

Availability
This parameter is supported by Control-M/Server versions 6.1.xx and later, and Control-M for z/OS versions 6.2.xx and later.

630

Control-M Parameter Guide

Form Name

Aliases in other Control-M components

Alternate names for the Form Name parameter are listed below.
Component Control-M/EM Utilities Control-M/EM API Parameter Name APPL_FORM application_form

Control-M/Server Utilities -applform

Example 1: Default form for SAP job

Default SAP 4.6

Example 2: Alternate form for SAP job

SAP 4.7

Chapter 2

General parameters

631

Group

Group
Indicates the name of the group to which the job belongs.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Mandatory 1-64 characters Yes Blanks; single quotation marks No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Application Description Application is also a logical name. Both the Application and Group parameters can be used to create logical groupings of jobs. Neither parameter has a direct effect on job execution.

General information
The Group parameter facilitates more convenient and orderly management of groups of production jobs. The value assigned to the Group parameter determines the jobs placement in the structure of the Control-M/EM network ViewPoint displayed in the Control-M/EM flow diagram. This window is described in the Control-M User Guide.

632

Control-M Parameter Guide

Group

Aliases in other Control-M components

Alternate names for the Group parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name GROUP GROUP NAME GROUP group

Control-M/Server Utilities -group

Example 1: Accounting department groups

ACCOUNTING

Example 2: Group of jobs run at the end of the day

END_OF_DAY

Example 3: Group name for associated jobs that create sales reports
SALES_REPORT

Chapter 2

General parameters

633

Job Name

Job Name
Name of the job.

Format
Usage Length Case Sensitive Invalid Characters

Mandatory

1-64 characters z/OS: 1-8 characters Yes

Blanks Single quotation marks If the job runs on any version of Microsoft Windows 2000, prohibited filename characters (such as \, /, or *)

AutoEdit Support

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Job Name parameter appears along with the File Name parameter in various job definition and job tracking windows. The Job Name can also be displayed in the job node displayed in the Control-M/EM window (depending upon options specified in the Display Net window). This parameter is used when ordering or forcing a job, either using the Do Forcejob parameter or when using the Order/Force windows. You can define a job without a job name in ctmcreate and ctmdefine. The Job Name parameter does not have to be unique in the table.

Accessing/modifying the Job Name in AutoEdit expressions

The value of the Job Name parameter can be accessed using the %%JOBNAME AutoEdit variable. For example, this name can be included in a messages that is sent using the Do Shout or Do Mail parameters. The job name parameter can also be overridden when the job is ordered, for example, by using the following statement in the command line of the ctmorder utility for Control-M/Server.
-autoedit %%JOBNAME newjobname

634

Control-M Parameter Guide

Job Name

Computer-specific information
Parameter z/OS Information The Job Name parameter must be unique in the table.

iSeries (AS/400) The value specified for this parameter is the actual job name to be used by iSeries (AS/400). It is part of the job submission command. Note: For jobs on an iSeries (AS/400) computer, the value specified for the Job Name parameter must conform to iSeries (AS/400) conventions for job names.

Aliases in other Control-M components

Alternate names for the Job Name parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name JOBNAME JOB NAME -jobname JOB NAME job_name

Chapter 2

General parameters

635

Job Type

Job Type
Generally, an identifier name indicating the type of external application (for example, SAP ...). In this case, the parameter represents a combination of the following parameters: Application Type, Application Version, CM Version, and Form Name. Jobs not belonging to an external application have a job type of either Control-M BIM (for Batch Impact Manager jobs), or OS (for all other jobs).

Format
Usage Mandatory for jobs that run on external applications such as SAP or Oracle. Note: The relevant Control Module must be installed and the relevant form must be imported. Select the required value from the list.

Format

Related parameters
Parameter Application Type Application Version Control Module (CM) Version Form Name Node ID/Group Description The type of application whose version is specified by the Application Version parameter. Indicates the version of the application that is specified with the Application Type parameter. Indicates the version of the Control Module (CM) that is used to run the job. Type of form used for entering external application data. Name of a Control-M/Agent computer, remote host computer, or node group to which the job should be submitted.

General information
For jobs running under external applications, the appropriate job type must be selected in the job editing form. Job type identifies the relevant form for the particular application type, application version and Control Module (CM) version. The Control Module must be installed and the relevant form must be imported:

For a list of application types, application versions, and Control Module versions, available in the Control-M/Server, click Load next to the Node Id/Group field, in the job (or template) editing form. (Click Load to also include the Node Group in the list.) To import Application forms, choose Tools => Import Application Form and browse to and select the form.

636

Control-M Parameter Guide

Job Type

When you select an external job type, a tab with relevant parameters is automatically added as the second tab in the job editing form. For more information on importing application forms or filling in the application form parameters in the job editing form, see the relevant Control Module documentation.

Availability
This parameter is supported in the job editing form only, beginning with ControlM/EM version 6.3.01.

Chapter 2

General parameters

637

Over Lib

Over Lib
Name of an alternate library or directory for the file specified with the File Name parameter. Control-M searches for the file specified in the File Name parameter in the Over Lib directory before searching for it in the Path library.

Format
Usage Length Optional

Microsoft Windows, UNIX, OpenVMS: 1 through 255 characters iSeries (AS/400): 1 through 10 characters z/OS: 1 through 44 characters

Case Sensitive Invalid Characters

Yes

Blanks. If the job runs on any version of Microsoft Windows 2000, prohibited filename characters (such as \, /, or *) z/OS: Non-English characters.The contents of this field must not begin with the following strings: GENERAL USER=

AutoEdit Support

Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Related parameters
Parameter Path/Mem Lib File Name/Mem Name Description Indicates the name of the library or directory in which the file described in the Path parameter is located. Indicates the name of a file containing the control language statements for the job (or detached process) to be executed.

General information
The Over Lib parameter enables the user to submit a temporarily-modified job script file without changing the original script file in the Path library and without changing the scheduling order of a table.

638

Control-M Parameter Guide

Over Lib

When to use
The library containing the jobs regular script file is specified in the Path parameter. When temporary modifications are required, the modified script file is placed in the location indicated by the Over Lib parameter. If the file specified by the File Name parameter is found in the Over Lib location, this file is submitted instead of the job script file with the same name that resides in the Path location.

Cancelling override
The override can be canceled by one of the following methods:

Delete the file specified in the File Name parameter from the Over Lib location. If the job script file is not found in Over Lib, it is automatically taken from the Path location. -orDelete the Over Lib specification from the job definition.

NOTE
For a description of the values allowed with this parameter, see Computer-specific information on page 642.

AutoEdit support
As of this version, the Over Lib value can be extracted and passed to another part of the job processing definition using the %%OVERLIB parameter.

Aliases in other Control-M components

Alternate names for the Over Lib parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name OVERLIB OVER LIB -overlib OVERLIB over_lib

Chapter 2

General parameters

639

Owner

Owner
Identifies the owner (user name) for whom the job is executed. This parameter is used by the Control-M security mechanism.

Format
Usage Default Length Mandatory User name of the current Control-M/EM user 1-30 characters z/OS: 1-8 characters

Case Sensitive Yes Invalid Characters AutoEdit Support Blanks Computers other than z/OS: Single quotation marks

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Owner parameter is used by the Control-M internal security mechanism to determine operations that each user is authorized to perform. For more information, refer to the Security chapter in the Control-M Administrator Guide for the appropriate computer.

Aliases in other Control-M components

Alternate names for the Owner parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name OWNER OWNER -owner OWNER owner

640

Control-M Parameter Guide

Path/Mem Lib

Path/Mem Lib
Indicates the name of the directory or library in which the file described in the Path parameter is located.

Format
Usage This parameter is mandatory if the specified Task Type is Job or Detached or External. Note: The format for this parameter depends on the job computer. For more information, see Computer-specific information on page 642. Length

Microsoft Windows, UNIX, OpenVMS: 1-255 characters iSeries (AS/400): 1-10 characters z/OS: 1-44 characters Blanks z/OS: Non-English characters If the job runs on any version of Microsoft Windows 2000, prohibited filename characters (such as \, /, or *)

Case Sensitive Yes Invalid Characters

AutoEdit Support

Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Related parameters
Parameter Description

File Name/Mem Name of the job script file kept in the directory or library specified in Name Path/Mem Lib. Over Lib Name of an alternate library for the file specified in the File Name parameter. The original copy of the file is kept in the directory specified in Path.

General information
The library or directory specified in the Path parameter and the accompanying File Name file do not have to exist when the job processing parameters are defined. Control-M searches for them only before actual submission of the job.

Chapter 2

General parameters

641

Path/Mem Lib

Computer-specific information
Computer Microsoft Windows UNIX Information The Path parameter indicates the drive ID, and the names of the directory and subdirectories (if any). The Path parameter indicates the names of the directory and subdirectories (if any). One of the following symbols can be used in place of or as part of the directory and sub-directory names (these symbols are resolved at the time the job is ordered or forced):

$HOME resolves to the home directory of the job owner. ~<username> resolves to the home directory of the specified UNIX user.

OpenVMS

The Path parameter contains the (device:[directory]) that can be specified as the physical path or as an OpenVMS logical name.

iSeries (AS/400) Specify one of the following: Name of an iSeries (AS/400) library *LIBL (library list) *CURLIB (current library) z/OS Format of the parameter depends on whether the job processing definition applies to a job (or warning messages) or a started task: Job Valid values: a valid data set name of 1-44 characters or one of the following reserved values: DUMMY - for dummy jobs USER= name - for user-defined libraries GENERAL - specifies the library referenced by DD statement DALIB in the Control-M procedure. Any of the following formats can be used for the value of Mem Lib:

Started Task

*. taskid, where taskid is the ID of the task The started task 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 started task is to be activated stcparms is started task parameters cpuid, where cpuid is the ID of the computer in which the started task is to be activated.

Valid values for cpuid are:

* The computer where the Control-M monitor is active.

642

Control-M Parameter Guide

Path/Mem Lib

Computer

Information Under JES2

Nn where n is the JES/NJE node ID. Mm where m is the computer ID. NnMm where n is the JES/NJE node ID, and m is the computer ID.

Under JES3 Lname where name is the logical JES name of the computer, that is, the name as used in the JES3 command *T, not the SMF system ID.

AutoEdit support
As of version 6.1.03, the Path value can be extracted and passed to another part of the job processing definition using the %%MEMLIB parameter.

Aliases in other Control-M components

Alternate names for the Path parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name MEMLIB MEM LIB -memlib MEMLIB mem_lib

Alternate formats in other Control-M components

Alternate formats for the Path parameter are listed in Computer-specific information on page 642.

Example 1: Microsoft Windows

D:\ACCOUNT\SALARY

Example 2: UNIX
$HOME/ctm/salary

Chapter 2

General parameters

643

Path/Mem Lib

Example 3: OpenVMS
DUA0:[SALARY.JAN.ARCH], SALARY$DIR

Example 4: iSeries (AS/400)

MYLIB

Example 5: z/OS
GENERAL

644

Control-M Parameter Guide

PIPE

PIPE
Indicates a data set to be replaced by a pipe with the same name. Displayed only if MAINVIEW Batch Optimizer is installed.

NOTE
The PIPE parameter is used only with jobs run in Control-M for z/OS installations in which MAINVIEW Batch Optimizer (MVBO) is installed.

Format
Usage Format Optional Each time a data set or pipe name is specified and Enter is pressed, a new empty line is displayed to enable specification of an additional data set or pipe name. 1 - 44 characters No

Length Case Sensitive Invalid Characters AutoEdit Support

Blanks Non-English characters

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information NOTE

PIPE can be modified only by using Control-M for z/OS directly. This parameter is not available from the Control-M/EM GUI or utilities.

Pipes are storage buffers that are used to replace data sets. Pipes are defined in, and used by, MAINVIEW Batch Optimizer to replace sequential processing with parallel processing. For example, normally (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 MAINVIEW Batch Optimizer rule. Each pipe must be defined with the same name as the data set it is replacing.

Chapter 2

General parameters

645

PIPE

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 processing definition for the job. For more information about Pipe processing, see the Control-M for z/OS User Guide.

Example: Two job processing definitions

This example consists of two job scheduling definitions. In job CTLIVPWR and job CTLIVPRD, the CTL.IVP.FILE data set is replaced by a pipe of the same name. Jobs of this type are called a Collection because they are participants in the same pipe. Figure 11 PIPE parameter example job CTLIVPWR

JOB: CTLIVPWR LIB CTMT.PROD.SCHEDULE TABLE: CTLIVP COMMAND ===> SCROLL===> CRSR ----------------------------------------------------------------------------MEMNAME CTLIVPWR MEMLIB CTM.IVP.JCL OWNER E02A TASKTYPE JOB PREVENT-NCT2 DFLT N APPL GROUP DESC Control-M/WORKLOAD VERIFICATION - WRITER JOB OVERLIB SET VAR CTB STEP AT NAME TYPE DOCMEM CTLIVPWR DOCLIB 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 SHIFT RETRO N MAXWAIT 00 D-CAT. MINIMUM PDS =========================================================================== IN CTLIVPWR-IN ODAT CONTROL RESOURCE PIPE CTL.IVP.FILE ESOURCE PIPE TIME: FROM UNTIL PRIORITY DUE OUT SAC CONFIRM COMMANDS: EDIT, DOC, PLAN, JOBSTAT 13.18.25

646

Control-M Parameter Guide

PIPE

Figure 12

PIPE parameter example job CTLIVPRD

JOB: CTLIVPRD LIB CTMT.PROD.SCHEDULE TABLE: CTLIVP COMMAND ===> SCROLL===> CRSR ----------------------------------------------------------------------------MEMNAME CTLIVPRD MEMLIB CTM.IVP.JCL OWNER E02A TASKTYPE JOB PREVENT-NCT2 DFLT N APPL GROUP DESC CONTROL-M/WORKLOAD VERIFICATION - READER JOB OVERLIB SET VAR CTB STEP AT NAME TYPE DOCMEM CTLIVPRD DOCLIB 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 SHIFT RETRO N MAXWAIT 00 D-CAT MINIMUM PDS =========================================================================== IN CTLIVPWR-OUT ODAT CONTROL RESOURCE PIPE CTL.IVP.FILE PIPE TIME: FROM UNTIL PRIORITY DUE OUT SAC CONFIRM COMMANDS: EDIT, DOC, PLAN, JOBSTAT 13.22.07

Chapter 2

General parameters

647

Table Lib

Table Lib
Name of the library that contains the jobs table.

NOTE
This field is displayed only for z/OS jobs.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Mandatory 1-44 characters No Blanks z/OS: Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Aliases in other Control-M components

Alternate names for the Table Lib parameter are listed below.
Component Control-M/EM Utilities Control-M for z/OS Control-M/EM API Parameter Name TABLE_DSN Scheduling Library (Scheduling Table Lib) table_library

648

Control-M Parameter Guide

Table

Table
Name of the table. In the job editing form this parameter indicates the table to which the job belongs.

NOTE
For Control-M for z/OS jobs, this parameter is displayed as Table Name in the Control-M/EM GUI.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Mandatory, if values are specified for the Job Name and Date parameters. 1-770 characters z/OS: 1-64 characters Yes

Blanks Single quotation marks z/OS: Non-English characters

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
When creating a SMART table or Sub-table in the table editing form this parameter defines the tables name. In the job editing form, together with the Control-M JOBNAME parameter, the Table parameter determines the position of the job in the Control-M Table hierarchy. The Table parameter may include table name or table path.

Aliases in other Control-M components

Alternate names for the Table parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name TABLE_NAME TABLE_ID -TABLE TABLE NAME table_name

Chapter 2

General parameters

649

Table

Example 1: Table name including a user-assigned serial number.

SchTbl03

Example 2: Table name including a time period.

SeptOctTbl2

650

Control-M Parameter Guide

Task Type

Task Type
Specifies the type of task of the job performs.

Format
Usage Format Invalid Characters AutoEdit Support Usage is computer-dependent. For more information, see Computer-specific information on page 651. Specific terms are valid for each Control-M computer. For more information, see Computer-specific information on page 651. Blanks; Single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
Each Task Type can be defined as cyclic or non-cyclic (regular). For more information, see Cyclic on page 724. For z/OS jobs, the specified task type is combined with the values of the Cyclic and Emergency parameters.

Computer-specific information
Computer

Task Types Job A regular job submitted to Control-M for execution as a background process. The results of the job (the output) are analyzed by the post-processing subsystem. This type is similar to Job but also includes .EXE type files. Operating system command (defined in the Command parameter) sent to the operating system to be executed as a job. For more information, see Command on page 614. Control-M internal job. This is a dummy job which is not executed, but that can be used to execute the Out Conditions and Shout post-processing actions. Its completion status is always OK. Enables Control-M to track jobs whose status changes are determined outside Control-M (that is, jobs run on external applications).

Microsoft Windows UNIX

Detached Command

Dummy

External

Chapter 2

General parameters

651

Task Type

Computer OpenVMS

Task Types Job A regular job submitted to the operating system batch queue. The job results in the job log are analyzed by the Control-M/Server post-processing subsystem. Note: For the purposes of the following discussion, node refers to an individual computer in an OpenVMS cluster. In a OpenVMS cluster environment, a job with the Job Task Type parameter can be executed on a node other than the node on which Control-M is running. To do this, assign the %%QUEUE variable of the job a queue name that is a regular queue on another node of the cluster. To let OpenVMS select the node on which to run the job, use the Generic queue mechanism: 1. Define a generic batch queue on the node running Control-M. 2. On each of the other nodes, initialize (create) regular batch queues, and associate each queue with the generic batch queue referred to above. 3. Assign the generic queue name to the %%QUEUE variable for that job.

652

Control-M Parameter Guide

Task Type

Computer OpenVMS, continued

Task Types Job, continued Tracking is exactly the same as if the job were executing on a local queue. The jobs log file can be found in the same location as if the job executed on the local node. A detached process that is executed directly by the operating system (without passing through the operating system batch queue). The results of the Detached task are not analyzed by the post-processing subsystem. The detached task has the following properties:

Detached

Although the process is not executed by the operating system batch queue, the process is executed asynchronously as a OpenVMS detached process. It can only be executed on the LOCAL node, where it is also tracked.

A detached process is always assumed to have terminated successfully. If a program to be executed as a detached process requires input (or parameters supplied through the Control-M/Server SYS$INPUT default). You can supply these as regular parameters. If the program requires parameters as part of the execution command statement (such as the RUN interactive command), it cannot be run as a detached process. Instead, use Task Type: Command. Command Operating system command (defined in the Command parameter) sent to the operating system to be executed as a job. For more information, see Command on page 614. Control-M internal job. This is a dummy job that is not executed, but that can be used to execute the post-processing actions Out Conditions and Shout. Its completion status is always OK.

Dummy

Chapter 2

General parameters

653

Task Type

Computer iSeries (AS/400)

Task Types Job A job submitted to an operating system job queue. After submission, the job may start executing immediately or wait in the queue. The log is analyzed by the post-processing subsystem. A detached job is submitted to a no-wait job queue and is executed immediately by the operating system. The results of a detached job are analyzed by the post-processing subsystem. Although the job is not executed by the operating system batch queue, the job is executed asynchronously. Operating system command (defined in the Command parameter) sent to the operating system to be executed as a job. For more information, see Command on page 614. Control-M internal job. This is a dummy job that is not executed, but that can be used to execute the post-processing actions Out Conditions and Shout. Its completion status is always OK. Batch job. Default. Started task.

Detached

Command

Dummy

z/OS

JOB STC

Aliases in other Control-M components

Alternate names for the Task Type parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter name TASKTYPE TASK_TYPE -tasktype TASKTYPE task_type

Alternate formats in other Control-M components

Alternate formats for the Task Type parameter are listed below.

654

Control-M Parameter Guide

Task Type

Component

Format

Control-M/EM Utilities Example TASKTYPE=Detached/> Valid values are: For non-z/OS computers: Job Detached Command Dummy External For z/OS (version 6.1.03 and later): Job Started_Task These values are used in conjunction with the values specified in the Cyclic and Critical parameters. Reporting Facility Control-M/Server Utilities String. Valid values:

JOB DETACHED COMMAND DUMMY EXTERNAL TABLE (for SMART Tables, only) SUBTABLE

The TABLE and SUBTABLE tasktypes are relevant for the ctmcreate utility only and can be used to create a specific purpose (non-permanent) table that is not defined in the Control-M/Server database by specifying the following command: -tasktype TABLE|SUBTABLE -table <tableName|tablePath>

Example: Creating a SAP job with the Control-M/Server ctmcreate utility

ctmcreate -tasktype job -application SAP -nodegrp chef1 -appltype SAP -memlib ddd -memname fff -autoedit %%SAPR3-ACCOUNT DV1 -autoedit %%SAPR3-JOBNAME SAPCM -autoedit %%SAPR3-JOBCOUNT 09495501 -autoedit %%SAPR3-JOB_MODE EXTERNAL -applver 46C/46D -applform "SAP R3" -cmver 610 -jobname xxxx.

Chapter 2

General parameters

655

Task Type

656

Control-M Parameter Guide

Chapter

Scheduling parameters
The parameters in this section determine when and/or how often a job should be scheduled for submission. Table 157 Scheduling parameters summary
Parameter Active Adjust Condition Description Date range during which the job or SMART Table can be ordered or the Rules Based Calendar can be used. Indicates whether to ignore prerequisite conditions normally set by predecessor jobs if the relevant predecessor jobs are not scheduled. This parameter is relevant only for jobs in a SMART Table. And/Or Confcal Dates Days Days Calendar Minimum Months PDS Relationship Indicates the relationship between specified Days values and Weekdays values. Use to specify a that is used to validate all specified days and dates on which to schedule the job. Specific dates on which to order the job. Days of the month on which to order the job. Name of a user-defined calendar used to specify a set of days (for example, working days). Minimum number of free partitioned data set tracks required by the library specified for the PDS parameter. Months in which to order the job. Name of a partitioned data set (PDS) to be checked for free space. The relationship (And/Or) between the specified Rules Based Calendar criteria and the jobs own basic scheduling criteria. This parameter is relevant only for jobs in a SMART Table or sub-table. Retro Whether the job should be scheduled for possible execution after its original scheduling date (odate) has passed.

Chapter 3

Scheduling parameters

657

Table 157 Scheduling parameters summary

Parameter SAC Description Whether to adjust the logical date for a job converted from a scheduling product other than Control-M. This parameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later. Rule-Based Calendar Identifier for a set of scheduling criteria in a SMART Table. One or more Rules Based Calendars can be specified in each job processing definition in a SMART Table.[z/OS] This parameter is relevant only for jobs in a SMART Table or sub-table. Statistics Calendar Name of the Control-M periodic calendar in which statistics relating to the job are collected. This parameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later. Statistics Period Identifier of the actual days within the Control-M periodic calendar in relation to which statistics relating to the job are calculated. This parameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later. Time Zone Week Days Weeks Calendar Indicates the global time zone used to calculate the interval for timerelated conditions. Days of the week on which to order the job. Indicates the name of a calendar to be used to validate specified weekdays on which to order the job.

658

Control-M Parameter Guide

Active

Active
Date range during which the job or SMART Table can be ordered or the Rule-based Calendar (RBC) can be used. During the period that the job or SMART Table is outside the active range (that is, inactive), it is not eligible to be ordered.

Format
Usage Format AutoEdit Support Optional Dates, in yyyymmdd format. No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Dates Days Calendar Description Other scheduling criterion. Indicates specific dates (month and day) on which the job should be scheduled. Indicates the name of a Control-M calendar that is used to validate specified days. This parameter may be mandatory for certain Days value formats. Also known as: DCAL and dayscal And/Or Week Days Weeks Calendar Confcal Indicates the relationship between specified Days values and Weekdays values. Indicates days of the week on which the job should be scheduled. Indicates the name of a Control-M calendar that is used to validate specified weekdays. Indicates the name of a Control-M calendar that is used to validate scheduling dates. A specified shift value can be used to indicate how to handle jobs that are scheduled for a non-working day in the calendar. Indicates the months in which the job should be scheduled. Only days in the specified months are considered valid for scheduling the job. Indicates specific dates on which the job can be scheduled. Note: This parameter cannot be specified if a value has been specified for the Days parameter. Rule-Based Calendar Identifies a set of scheduling criteria defined for a SMART Table. This parameter is only relevant to jobs in a SMART Table.

Months Dates

General information
The Active parameter allows you to define a date range during which a job or SMART Table can be ordered or a RBC can be used.
Chapter 3 Scheduling parameters 659

Active

You can use the Active parameters to define either of the following:

An active period. The dates before this period and the dates after this period each constitute an inactive period: (inactive-period1 > defined-active-period > inactive-period2) An inactive period. Technically you define two active periods, an earlier active period, and a later active period, and everything in-between is the inactive period: (active-period1 > defined-inactive-period > active-period2)

You can use this parameter with multiple copies of a job or SMART Table definition to create date ranges during which the job or SMART Table definition is run with alternate values, to eliminate the necessity of making last-minute changes to a job processing definition for a fixed period of time.

NOTE
The Active parameter appears as a single parameter with several subparameters in the job editing form and the table editing form in Control-M/Desktop. In all other Control-M components, the Active parameter appears as two separate parameters that function together the Active From Date parameter, and the Active To Date parameter. Despite this difference in appearance, which is only a user interface issue, the processing functionality remains the same in all Control-M components.

Defining an Active period

For a defined period to be an Active period, the From date must be less than or equal to the To date.

In the job editing form or table editing form in Control-M/Desktop: 1. In the first Active field, select From. 2. In the accompanying define the From and To fields, select the date range. Ensure that the From date is less than or equal to the To date.

In all other Control-M components, ensure that the Active From Date is less than or equal to the Active To Date.

No matter which component you use to define the Active period, you can leave either the From date or the To date blank:

If only a From date is specified, the job can be scheduled on or after that date. If only a To date is specified, the job can be scheduled on or before that date.

660

Control-M Parameter Guide

Active

Defining an Inactive period

As noted earlier, when you define an inactive period, it is preceded by an active period and followed by an active period (active-period1 > defined-inactive-period > active-period2). When you define an Inactive period:

the To date identifies the last date of the earlier active period (active-period1) the From date identifies the first date of the later active period (active-period2)

Therefore, the To date must be less than the From date. When using the job editing form or table editing form, the Active subparameters are
Until (instead of Active To Date) and And From (instead of Active From Date).

In the job editing form or table editing form in Control-M/Desktop: 1. In the first Active field, select Until. 2. In the accompanying define the Until and And From fields, select the date range. Ensure that the Until date is less than or equal to the And From date.

In all other Control-M components, ensure that the Active To Date is less than the Active From Date.

When defining an inactive period, you must specify both parameters in the date range; you cannot either of them blank.

Aliases in other Control-M components

Alternate names for the Active From Date parameters are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Parameter Name ACTIVE_FROM_DATE -DATEFROM <YYYYMMDD> Example: -DATEFROM 20060315 DEFINITION ACTIVE FROM or SCHEDULE RBC ACTIVE FROM active_from

Control-M for z/OS

Control-M/EM API

Chapter 3

Scheduling parameters

661

Active

Alternate names for the Active To Date parameters are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Parameter Name ACTIVE_To_DATE -DATEUNTIL <YYYYMMDD> Example: -DATEUNTIL 20050315 DEFINITION ACTIVE UNTIL or SCHEDULE RBC ACTIVE UNTIL active_till or active_until

Control-M for z/OS

Control-M/EM API

Alternate formats in other Control-M components

Alternate formats for the Active From Date parameters are listed below.
Component Control-M/EM Utilities Format String for date. According to site standard (ddmmyyyy, mmddyyyy, yyyymmdd). Example: <ACTIVE_FROM=15032006/> Control-M for z/OS 6-integer string for date. According to site standard (ddmmyy, mmddyy, yymmdd).

Alternate formats for the Active To Date parameters are listed below.
Component Control-M/EM Utilities Format String for date. According to site standard (ddmmyyyy, mmddyyyy, yyyymmdd). Example <ACTIVE_TILL=15032006/> 6-integer string for date. According to site standard (ddmmyy, mmddyy, yymmdd). Default: blank.

Control-M for z/OS

662

Control-M Parameter Guide

Active

Example: Seasonal changes

JOB_A is a job processing definition for scheduling food shipments.

In the summer, the company ships on Mondays and Wednesdays. In the fall, the company ships only on Mondays. In winter, the company ships on Mondays, Wednesdays, and Fridays. In the spring, the company ships on Mondays and Wednesdays.

Four copies of the JOB_A job processing definition are created. The Days parameter must be changed seasonally to allow for variations in shipping frequency. Different Active From Date and Active To Date parameters are used in each definition to specify the season in which the job is active. Other job processing criteria remain unchanged. Job_A, Copy_1: Summer
Days: 1, 3 Active From Date: June 1, 2005 Active To Date: August 31, 2005

Job_A, Copy_2: Fall

Days: 1 Active From Date: September 1, 2005 Active To Date: November 30, 2005

Job_A, Copy_3: Winter

Days: 1, 3, 6 Active From Date: December 1, 2005 Active To Date: March 1, 2006

Job_A, Copy_4: Spring

Days: 1, 3 Active From Date: March 2, 2006 Active To Date: May 30, 2006

Chapter 3

Scheduling parameters

663

Adjust Condition

Adjust Condition
Indicates whether to ignore prerequisite conditions normally set by predecessor jobs if the relevant predecessor jobs are not scheduled.

NOTE
This parameter is relevant only for SMART Tables.

Format
Usage Format Optional Valid values are: Yes Ignore relevant prerequisite conditions. No Do not ignore relevant prerequisite conditions. Dummy [Control-M for z/OS as of version 6.2.xx only]. Order 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. For more information, see ADJUST CONDITIONS in the job production parameters chapter in the Control-M for z/OS User Guide. [Control-M/Server] The CTM_GROUP_ADJUST_DUMMY configuration parameter controls the creation of dummy jobs that run in place of unscheduled prerequisite jobs. This parameter is relevant only when Adjust Condition is set to Y. Note: The Control-M/Server CTM_ADJUST_COND_SCOPE configuration parameter controls whether jobs in the SMART Table must ignore conditions set by jobs in the active jobs file that are not scheduled, or to ignore conditions set by jobs in the SMART Table that are not scheduled. In the latter case, the missing conditions are removed from the job at order time. This parameter is relevant only when Adjust Condition is set to Y. Invalid Characters AutoEdit Support Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Adjust Condition parameter is applied to all jobs in a SMART Table. It defines job dependencies in the SMART Table as being either conditional or absolute.

664

Control-M Parameter Guide

Adjust Condition

Conditional and absolute dependencies

Absolute job dependency Each job in a SMART Table runs only after all the predecessor jobs in the SMART Table have run. All prerequisites In conditions for a job must exist in the Conditions/Resources table before the job can run. Select No in the Adjust Condition list in the Control-M/EM Job Editing form.

Conditional job dependency Each job in the SMART Table waits for its predecessor jobs to run only if the predecessor jobs in the SMART Table are scheduled. Prerequisite condition requirements are ignored and the successor job runs if a predecessor job is not scheduled. The other runtime scheduling criteria for the job must be satisfied. Select Yes in the Adjust Condition list in the Control-M/EM Job Editing form.

Aliases in other Control-M components

Alternate names for the Adjust Condition parameter are listed below.

Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Utilities Control-M/EM API

Parameter Name ADJUST_COND ADJUST CONDITION -adjust_cond Adjust Conditions adjust_condition

Alternate formats in other Control-M components

Alternate formats in other Control-M components are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Format String. Example: <ADJUST_COND=Y/>

Y ignore the relevant prerequisite conditions N utilize prerequisite conditions normally set by predecessor jobs. Default. Y ignore the relevant prerequisite conditions N utilize prerequisite conditions normally set by predecessor jobs. Default.

Control-M for z/OS

Chapter 3

Scheduling parameters

665

And/Or

And/Or
Indicates the relationship between specified Days parameter values and Weekdays parameter values.

Format
Usage Format Optional Valid values are: and or (default) Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Invalid Characters AutoEdit Support

Related parameters
Parameter Confcal Description Indicates the name of a Control-M calendar that is used to validate scheduling dates. A specified shift value can be used to indicate how to handle jobs that are scheduled for a non-working day in the calendar. Indicates specific dates (month and day) on which the job should be scheduled. Indicates the start of a period of time during which the job or SMART Table can be ordered or the RBC can be used. Indicates the end of a period of time during which the job or SMART Table can be ordered or the RBC can be used. Days of the month on which to order the job. Indicates the name of a calendar containing a list of working days on which the job can be scheduled for execution. Indicates the days of the week on which the job should be scheduled for processing. Indicates the name of a calendar to be used to validate specified weekdays on which to order the job.

Dates Date From Date Until Days Days Calendar Week Days Weeks Calendar

General information
If And is specified, both the Days/Days Calendar criteria and Week Days/Weeks Calendar criteria must be satisfied for a job to be scheduled. If Or is specified, either the Days/Days Calendar criteria or Week Days/Weeks Calendar criteria must be satisfied for a job to be scheduled.

666

Control-M Parameter Guide

And/Or

Aliases in other Control-M components

Alternate names for the And/Or parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name DAYS_AND_OR DAYS_AND_OR -cal_andor And/Or and_or

Chapter 3

Scheduling parameters

667

Confcal

Confcal
Indicates the name of a Control-M calendar that is used to validate scheduling dates. A shift value can be used to indicate how to handle jobs that are scheduled for a nonworking day in the calendar.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Optional Valid calendar name, up to 30 characters in length. z/OS: 1-8 characters Yes

Blanks z/OS: Non-English characters Computers other than z/OS: Single quotation marks

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Active And/Or Days Days Calendar Minimum Months Description Indicates the start of a period of time during which the job or SMART Table can be ordered or the RBC can be used. The relationship between specified Days parameter values and Weekdays parameter values. Days of the month on which to order the job. The name of a calendar containing a list of working days on which the job can be scheduled for execution. Minimum number of free partitioned data set tracks required by the library specified for the PDS parameter. Name of a partitioned data set (PDS) to be checked for free space. If the PDS has fewer than the minimum number of required free tracks (as specified for the Minimum parameter), the job is executed. The days of the week on which the job should be scheduled for processing. The name of a calendar to be used to validate specified weekdays on which to order the job.

Week Days Weeks Calendar

NOTE
The Confcal parameter cannot be specified together with the DATES parameter.

668

Control-M Parameter Guide

Confcal

Subparameter
Subparameter Shift Shift Num Description Determines when to schedule the job if the current day is not a valid working in the specified calendar. Optional. Determines how many days to shift the job if the current day is not a valid working day.

NOTE
For z/OS jobs: The Confcal parameter cannot be specified together with the PDS and Minimum parameters.

General information
The Calendar specified for Confcal must be a regular Calendar (not a periodic calendar). This calendar is used for:

Validating scheduling dates Determining the scheduled work day.

Jobs to be scheduled on a given day are checked against the Confcal calendar:

If the day is a working day in the Confcal calendar, the job is scheduled on that day. (This day is referred to as the original scheduling date.) If the day is not a working day in the Confcal calendar, the Shift and Shiftnum parameters are checked. Depending on the Shift value, the job may be scheduled on an earlier day, a later day, on the original scheduling date, or it may be cancelled. If the jobs scheduling criteria also include the day to which it is shifted, it runs only once on that date (not once for regular scheduling, and once to make up for the shifted day).

NOTE
If no Confcal calendar is specified, no value can be specified for the Shift subparameter, and this field has no effect on job scheduling.

Chapter 3

Scheduling parameters

669

Confcal

Aliases in other Control-M components

Alternate names for the Confcal parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name CONFCAL CONF_CAL -confcal CONFCAL conf_cal

Alternate formats in other Control-M components

Alternate formats for the Confcal parameter are listed below.
Component Control-M/EM Utilities Format String. SHIFT and SHIFTNUM are included as related parameters (not as subparameters of CONFCAL). Example <CONFCAL=Cal1/> SHIFT Valid values: Control-M/Server equivalent:

IGNOREJOB NEXTDAY PREVDAY NOCONFCAL

No value > < @

For more information, seeSHIFT on page 671. SHIFTN Number from -62 to 62. UM Reporting Facility String. SHIFT and SHIFTNUM are included as related parameters (not as subparameters of CONF_CAL). SHIFT Valid values:

Ignore Job Next Day Prev Day No Confcal

SHIFTN String. Number from -62 to 62. UM

670

Control-M Parameter Guide

Confcal

Component Control-M/Server Utilities

Format SHIFT is specified as a separate parameter (not a subparameter of CONFCAL). Do not specify this parameter unless you want to shift the scheduling of a job. SHIFT has up to four characters (xyyy). If you specify SHIFT, you must specify a value for x, or a value for yyy, or values for both x and yyy. SHIFT The first character (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:

No value (for x) No shifting occurs, unless a value is inserted for yyy. 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 in the CONFCAL calendar. Additional shifting may or may not be performed, depending on the yyy value, described below.

The remaining three characters (yyy) shift scheduling of the job forward or backward the specified number of working days, as defined in the CONFCAL calendar. Valid values are:

No value (for yyy) Only the shifting specified by the x value occurs. -nn or +nn shifts the job forward or backward nn working days in the CONFCAL calendar. nn can be any value from 0 to 62.

Note the following points:

If the result of shifting by yyy days is a day that is not allowed (-n was entered for that day in the DAYS parameter), the job is shifted to the next working day (for a forward shift), or to the previous working day (for a backward shift).

Chapter 3

Scheduling parameters

671

Confcal

Component Control-M/Server Utilities continued

Format

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. 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 of the job is not a working day in the CONFCAL calendar, and no value (blank) is specified for the x value, the job is not scheduled, and the yyy value (if specified) is ignored. Confcal and Shift parameters are applied to a scheduling date only if that date already satisfies the Basic Scheduling criteria as specified in the Days, Months, Dates, and Weekdays parameters.

Control-M for z/OS

1-8 character string. SHIFT is specified as a separate parameter (not a subparameter of CONFCAL). SHIFT 4-character value including the Shift Num value. For more information, see the Control-M for z/OS User Manual.

672

Control-M Parameter Guide

Dates

Dates
Indicates specific dates (month and day) on which the job should be scheduled.

Format
Usage Optional Note: The Dates parameter cannot be used together with the Days parameter. Format

The Dates parameter is specified in either mmdd or ddmm format, depending on the site standard. Multiple values can be expressed, separated by commas, in any order (for example, 1211,1212).

Invalid Characters AutoEdit Support

Blanks; single quotation marks No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The job is scheduled for execution only on the dates specified in the dates list. In z/OS environments, only 12 days can be specified for the Dates parameter. To specify more than twelve dates for one job, the dates should be defined in a calendar, and the calendar specified in the Days Calendar parameter. The Dates parameter should be used with: -MONTH ALL N You can use the CTMRPLN utility to generate a report describing when the job runs based on its currently specified scheduling dates. For more information, see the description of this utility in the Control-M Administrator Guide for your computer. The Dates parameter cannot be specified together with the Weeks Calendar parameter.

Chapter 3

Scheduling parameters

673

Dates

Aliases in other Control-M components

Alternate names for the Dates parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name DATE DATES_STR -date DATES dates

Example: Schedule a job to run on a specific date

The following examples presume that the site standard for specifying dates is mmdd:

Schedule a job for the 4th of April: Dates 0404

Schedule a job for the 21st of December and the 21st of June: Dates 1221,0621

674

Control-M Parameter Guide

Days

Days
Days of the month on which to order the job.

Format
Usage Optional Note: The Days parameter cannot be used together with the Dates parameter. Length Invalid Characters AutoEdit Support 1-160 characters Blanks; single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Valid formats for the Days parameter vary depending on whether a periodic calendar is specified as the Days Calendar. Formats for non-periodic and periodic calendars are specified separately below. (For more information about Calendar types, see the Control-M User Guide.)

NOTE
The term working days in the following format descriptions refers to days marked in the calendar specified for the Days Calendar parameter.

Non-periodic (regular) calendar format

Format Rules Values Description

n is any integer from 1 to 31. Multiple values can be expressed (separated by commas) in any order. ALL, All days of the month. n, Specific days of the month. +n, Specific days of the month in addition to working days in the Days Calendar.

Chapter 3

Scheduling parameters

675

Days

Format Values cont.

Description

-n, Days of the month on which the job should not run, even if they are working days in the Days Calendar. >n, Order the job on the indicated day if it is a working day; otherwise, order the job on the next working day. This format is frequently used for holiday handling. <n, Order the job on the indicated day if it is a working day; otherwise, order the job on the closest preceding working day. This format is frequently used for holiday handling. Dn, Order the job on the nth working day from the beginning of the month. -Dn, Order the job on all working days except the nth working day from the beginning of the month. Ln, Order the job on the nth calendar day (or nth working day, if the Days Calendar parameter is specified) from the end of the month. L1 represents the last day of the month (or last working day of the month if a Days Calendar is specified). -Ln, Order the job on all days except the nth calendar day from the end of the month. If the Days Calendar parameter is specified, order the job on all working days except the nth working day from the end of the month.

Note: A calendar must be specified for the Days Calendar parameter if the +n, -n, >n, <n, Dn or -Dn format is used for the Days parameter.

Periodic calendar format

Format Rules Description In the following periodic scheduling formats: n is any integer from 1 through 255. i is any valid period identifier. Valid values are: any integer from 1 through 9 any uppercase letter except N and Y * (asterisk) all periods If the number of days between periods with the same identifier is more than 33 (this value can be changed by the administrator), it is considered a new period. The name of a periodic calendar must be specified in the Days Calendar. A maximum of eight periodic values (separated by commas) can be designated in any order.

676

Control-M Parameter Guide

Days

Format Values

Description

DnPi, Order the job on the nth day of period i from the beginning of the period. An * can be specified as the value of n to represent all days I to represent all periods -DnPi, Order the job on all days of period i except the nth day of period i from the beginning of the period. An * can be specified as the i value to represent all periods. LnPi, Order the job on the nth day of period i counting backward from the last day of the period. An * can be specified as the i value to represent all periods. -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. An * can be specified as the i value to represent all periods.

Related parameters
Control-M combines the value of the Days parameter with certain other parameters in order to determine the scheduling days for the job.
Days Calendar And/Or Week Days Weeks Calendar Confcal Indicates the name of a Control-M calendar that is used to validate specified days. This parameter may be mandatory for certain Days value formats. Indicates the relationship between specified Days values and Weekdays values. Indicates days of the week on which the job should be scheduled. Indicates the name of a Control-M calendar that is used to validate specified weekdays. Indicates the name of a Control-M calendar that is used to validate scheduling dates. A specified shift value can be used to indicate how to handle jobs that are scheduled for a non-working day in the calendar. Indicates the months in which the job should be scheduled. Only days in the specified months are considered valid for scheduling the job.

Months

General information
The job is ordered only on the days marked in the Days list and in the months specified in the Months parameter.

Rules

When ALL is specified, no other values should be specified for the Days parameter.

Chapter 3

Scheduling parameters

677

Days

Negative values take precedence over positive values when determining whether a job should be scheduled on a certain date. If a negative value (-n, -Dn, -Ln, DnPi, or -LnPi) in either the Days or Week Days parameter prevents a job from being scheduled on a date, the job is not scheduled on that date. Identical negative and positive values (for example, -Dn, Dn) cannot be specified together. If periodic and non-periodic values are mixed when specifying Days, processing depends on the calendar type specified in parameter Days Calendar. If a non-periodic calendar is specified in Days Calendar, only non-periodic values are processed; periodic values are ignored. If a periodic calendar is specified in Days Calendar, all periodic values and all negative non-periodic values (for example, -n) are processed; non-negative nonperiodic values are ignored. If the periodic values are specified for the Days parameter, the Months parameter is ignored.

NOTE
If the And option is selected (Month Days and Weekdays), and no criteria are specified for either the Month Days or the Week Days parameter, Control-M/EM assumes that ALL has been specified for the empty parameter. For example, if Monday is selected, and no days of the month are selected, the job is scheduled on all Mondays of the month.

Use with the Control-M/Server CTMRPLN Utility

You can use the CTMRPLN utility to generate a report describing when the job runs based on its currently-specified scheduling dates. For more information, see the description of this utility in the Control-M Administrator Guide for your computer.

Computer-specific information for z/OS

The Months parameter is ignored when periodic values are specified for the Days parameter.

678

Control-M Parameter Guide

Days

Aliases in other Control-M components

Alternate names for the Days parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name DAYS DAY_STR -days DAYS month_days

Example 1: Schedule a job on the 1st of March and the 1st of September

Example 2: Schedule a job on both the 1st and 15th day of each month

Example 3: Schedule a job on every day in December

Example 4: Complex scheduling using a periodic calendar

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.
Days -5,D1PA,-D2PB Days Calendar PERIDAYS

Periodic calendar PERIDAYS contains the following definitions:

Chapter 3

Scheduling parameters

679

Days

The job is scheduled on the following days: 3rd, 10th, 14th, 17th, 21st, 24th, 27th, 31st.

680

Control-M Parameter Guide

Days Calendar

Days Calendar
Indicates the name of a calendar containing a list of working days on which the job can be scheduled for execution.

Format
Usage Optional Note: The Days Calendar parameter cannot be used together with the Dates parameter. Length Case Sensitive Invalid Characters AutoEdit Support 1-30 characters z/OS: 1-8 characters, or the asterisk (*) character Yes

Computers other than z/OS: Blanks; single quotation marks z/OS: Blanks

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
And/Or Confcal Indicates the relationship between specified Days values and Weekdays values. Indicates the name of a Control-M calendar that is used to validate scheduling dates. A specified shift value can be used to indicate how to handle jobs that are scheduled for a non-working day in the calendar. Indicates the Days of the month on which to order the job. Indicates the months in which the job should be scheduled. Months must be indicated when the Days Calendar parameter is used. Indicates days of the week on which the job should be scheduled. Indicates the name of a Control-M calendar that is used to validate specified weekdays. Also known as: WCAL and weekscal

Days Months Week Days Weeks Calendar

General information
A calendar contains a list of user-defined days that can be used as a basis for scheduling jobs. For example, the days included in the calendar can be working days, accounting days, or holidays.

Any number of calendars can be defined, where each one corresponds to a different set of dates.

Chapter 3

Scheduling parameters

681

Days Calendar

Calendars are usually defined for the entire installation, though each user can define calendars according to personal preference. One calendar can be shared by many job processing definitions. The calendar does not have to exist when the job processing parameters are defined. Its existence is checked during New Day Processing.

How this parameter works

If no values are specified for the Days parameter, all working days in the specified Days Calendar are considered valid for job scheduling. If no Days Calendar is specified, all specified Days values are considered valid working days. When the Days Calendar parameter is specified with the Days parameter, the job is scheduled for execution only if all the indicated Days are also marked in the calendar. If the Days Calendar parameter is specified with a Days parameter that includes the + symbol, the job is scheduled for execution on those dates marked with a + (in the Days parameter), in addition to the dates marked in the calendar. If the Days Calendar parameter is specified with a Days parameter that includes the symbol, the job is not scheduled for execution on those dates even if the date is marked in the calendar. The appropriate Months parameters must be checked. The and/or relationship between Days and Weekdays is analyzed. For more information about And/Or, see the description on page 666.

You can use the CTMRPLN utility to generate a report describing when the job runs based on its currently specified scheduling dates. For more information, see the description of this utility in the Control-M Administrator Guide for your computer.

NOTE
The following examples presume that the first day of the week at your site is defined as Sunday.

682

Control-M Parameter Guide

Days Calendar

Aliases in other Control-M components

Alternate names for the Days Calendar parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name DAYSCAL DAYS_CAL -dayscal DCAL days_cal

Example 1: Schedule the job on all workdays throughout the year

Example 2: Schedule the job on all workdays in July

Example 3: Schedule the job on every Monday in July and August that is a workday

Example 4: Schedule a job on a regular basis

Schedule the job on every Monday in July, regardless of whether it is a workday, and each Tuesday in July that is a workday.

Chapter 3

Scheduling parameters

683

Days Calendar

Example 5: Complex scheduling

Schedule the job on the 1st of June, July and August, regardless of whether it is a banking day, and on every banking day in June, July and August:

Example 6: Schedule the job on every Friday in June, July and August that is a half day

684

Control-M Parameter Guide

Minimum

Minimum
Minimum number of free partitioned data set tracks required by the library specified for the PDS parameter.

NOTE
This parameter is available for z/OS jobs only.

Format
Usage Format AutoEdit Support Mandatory, if a value is specified for the PDS parameter. A positive 3-digit number (leading zeros are required) No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Confcal Dates Days Months PDS Confcal and Minimum cannot be specified together. Dates and Minimum cannot be specified together. Days and Minimum cannot be specified together. Months and Minimum cannot be specified together. Name of a partitioned data set (PDS) to be checked for free space. If the PDS has fewer than the minimum number of required free tracks (as specified for the Minimum parameter), the job is executed. When PDS is specified, Minimum is mandatory. Retro and Minimum cannot be specified together. Week Days and Minimum cannot be specified together. Weeks Calendar and Minimum cannot be specified together.

Retro Week Days Weeks Calendar

General information
The PDS parameter specifies a library, and the Minimum parameter specifies the minimum number of free tracks required by that library. The Minimum and PDS parameters are always used together and are never used with other Basic Scheduling parameters. See also: Related parameters

Chapter 3

Scheduling parameters

685

Minimum

When to use
The Minimum and PDS parameters are intended for use in jobs and started tasks that compress, clean, and/or enlarge libraries. They are also specified for tasks that issue a warning message to the IOA Log file if the minimum number of free tracks is not available. If Minimum and PDS parameters are defined for a job, the scheduling of the job is not related to or depends on 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).

NOTE
Minimum does not work with PDSE-type libraries because they always appear to be 100 percent full. Minimum only checks current extents.

Aliases in other Control-M components

Alternate names for the Minimum parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name MIN MIN PDS TRAC MINIMUM min_pds_tracks

686

Control-M Parameter Guide

Months

Months
Indicates the months during which the job can be scheduled for processing.

Format
Usage Format Optional A check box is displayed corresponding to each month of the year. When selected, the job is scheduled for that month. Default: The job is scheduled for all months. Invalid Characters AutoEdit Support Blanks; single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Dates You cannot specify a value for Months when a value is specified for the Dates parameter.

General information
The Months parameter cannot be used together with the Dates parameter.

On Control-M/Server
To see a jobs schedule plan, run the CTMRPLN report. This report indicates when selected jobs in a selected table are scheduled to run. For more information regarding CTMRPLN, see the utility section of the Control-M Administrator Guide for your computer.

Chapter 3

Scheduling parameters

687

Months

Aliases in other Control-M components

Alternate names for the Months parameter are listed below.
Component Control-M/EM Utilities Parameter Name Indicate the specific month: JAN FEB MAR APR MAY JUN JUL AUG SEP OCT NOV DEC Specify the specific month: MONTH_1 (January) MONTH_2 (February) and so on... MONTH_12 (December) -month MONTHS Indicate the specific month: JAN FEB MAR APR MAY JUN JUL AUG SEP OCT NOV DEC

Reporting Facility

Control-M/Server Utilities Control-M for z/OS Control-M/EM API

688

Control-M Parameter Guide

Months

Alternate formats in other Control-M components

Alternate formats for the Months parameter are listed below.
Component Control-M/EM Utilities Format Indicate for each month.

0 (Do not schedule for this month. Default) 1 (Schedule for this month.)

Example <JAN=1/>

Examples
For examples that use the Months parameter, see the Days Calendar (page 681) and Days parameters (page 675).

Chapter 3

Scheduling parameters

689

PDS

PDS
Name of a partitioned data set (PDS) to be checked for free space. If the PDS has fewer than the minimum number of required free tracks (as specified for the Minimum parameter), the job is executed.

NOTE
This parameter is available for z/OS jobs only.

The PDS and Minimum parameters must be specified together.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Mandatory, when a value is specified for the Minimum parameter 1-44 characters No Blanks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Confcal Dates Days Minimum Months Retro Week Days Confcal and PDS cannot be specified together. Dates and PDS cannot be specified together. Days and PDS cannot be specified together. Number of available tracks. When PDS is specified, Minimum is mandatory. Months and PDS cannot be specified together. Retro and PDS cannot be specified together. Week Days and PDS cannot be specified together.

690

Control-M Parameter Guide

PDS

General information
The data set must be cataloged, and it must be a partitioned data set. Parameters Minimum and PDS are always used together and are never used with other 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. If the Minimum and PDS parameters are defined for a job, the scheduling of the job is not related to or depends on 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).

NOTE
This parameter is not supported for PDSE-type libraries because they always appear to be 100 percent full.

Aliases in other Control-M components

Alternate names for the PDS parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name PDSNAME PDS Name PDS pds

Chapter 3

Scheduling parameters

691

Relationship

Relationship
Indicates the relationship (AND/OR) between RBCs criteria and basic scheduling criteria in the job processing definition (that is, whether either set of criteria, or both sets of criteria, must be satisfied).

NOTE
This parameter is relevant only to the job processing definitions of jobs that are in SMART Tables.

Format
Usage Format For jobs that are in SMART Tables. Option buttons.

When or is selected, if either set of criteria (a specified RBC or the jobs basic scheduling criteria) is satisfied, the job is scheduled. Default. When and is selected, both a specified RBC and the jobs basic scheduling criteria must be satisfied for the job to be scheduled.

Invalid Characters AutoEdit Support

Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameter
Rule-Based Calendar Identifies a set of scheduling criteria defined for a SMART Table. If the Relationship parameter value is AND and no RBC is defined, the job is not scheduled.

General information
For jobs in SMART Tables, two types of basic scheduling criteria can be specified:

Rules Based Calendars. Pointers to sets of scheduling criteria defined in the SMART Table. Basic Scheduling Criteria. Defined in each job processing definition.

692

Control-M Parameter Guide

Relationship

In some cases, both sets of criteria must be satisfied for the job to be scheduled. In other cases, it is sufficient if either set of criteria is satisfied. The AND-OR option enables you to specify the required combination:

When either set of criteria is sufficient choose OR. When both sets of criteria are required, choose AND.

NOTE
If an AND relationship is specified and no Rules Based Calendars are defined in the job, the job is not scheduled.

Aliases in other Control-M components

Alternate names for the Relationship parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M for z/OS Utilities Control-M/EM API Parameter Name RBC_RELATIONSHIP RBC_RELATIONSHIP -relationship RELATIONSHIP RELATION rbc_relationship

Chapter 3

Scheduling parameters

693

Retro

Retro
Indicates if the job should be scheduled for possible execution after its original scheduling date has passed (retroactively).

Format
Usage Format Optional Check box Select the Retro check box to indicate that the job should be scheduled retroactively. Clear the check box to indicate that the job should not be scheduled retroactively. Default: Clear Invalid Characters AutoEdit Support Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Minimum PDS Minimum cannot be specified together with Retro. PDS cannot be specified together with Retro.

General information
The Retro parameter is used to control situations where the computer has not been working for a day or more (for example, due to a weekend, a holiday or a hardware failure). The Retro parameter indicates to the New Day procedure or User Daily if the job should be retroactively scheduled for days the computer (or Control-M) was inactive.

If Retro is specified, Control-M/Server places job orders in the Active Jobs file for all days that the job should have been scheduled. The scheduling dates for which job orders are issued range from the day following the last running date of the New Day procedure or User Daily to the current working date, provided that those dates satisfy criteria specified in one of the scheduling parameters (Days, Days Calendar, and so on). Each job order placed in the Active Jobs file uses a date in the range as its original scheduling date. If Retro is not specified, the job is scheduled only for the current working date (provided that this date satisfies the jobs scheduling criteria).

694

Control-M Parameter Guide

Retro

For more information, see the description of the Date Control Record (UDLAST) in the overview chapter of the Control-M Administrator Guide. If Retro is specified for a User Daily Job, only the last (most recent) order of the User Daily Job actually orders jobs. It also performs Retro ordering for all included jobs. As a general rule, there is no need to specify Retro in the job processing definition of a User Daily job. You can use the ctmrplan Control-M/Server utility to determine when selected jobs in a table are scheduled to run. For more information, see the Utilities chapter in the Control-M Administrator Guide.

NOTE
Retro cannot be used with the Minimum and PDS parameters.

No SMART Tables support

The Retro parameter is not supported for SMART Tables. If this parameter is selected for a SMART Table (in the Table Editing form), it is ignored. The Retro parameter can be selected for individual jobs in a SMART Table.

Aliases in other Control-M components

Alternate names for the Retro parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name RETRO RETRO -retro RETRO retro

Alternate formats in other Control-M components

Alternate formats for the Retro parameter are listed below.

Chapter 3

Scheduling parameters

695

Retro

Component Control-M/EM Utilities

Format RETRO has two possible values: 0 (No) Do not allow scheduling of the job after its original scheduling date has passed. Default. 1 (Yes) Allow scheduling of the job after its original scheduling date has passed. Example <RETRO=1/>

Control-M/Server Utilities RETRO has two possible values: N (No) Do not allow scheduling of the job after its original scheduling date has passed. Default. Y (Yes) Allow scheduling of the job after its original scheduling date has passed.

Example 1: Schedule a job on a specific day of the month

Schedule the job on specific days in the month. If the day has passed, do not schedule the job.
Days 15, 16, 18, 19, 20 Retro No

Assume the computer was down from the 16th to (and including) the 18th. The 15th is the last date on which the job was scheduled for execution. Today is the 19th. Therefore, the job is only scheduled for execution on the 19th.

Example 2: Schedule a job for every workday

Schedule the job for every workday, whether the computer is active:
Days Calendar WORKDAYS Retro Yes

Given the following circumstances

the Work Days calendar contains the dates 15, 16, 18, and 19 the computer was down from the 16th up to (and including) the 18th the 15th was the last date that the job was scheduled for execution today is the 19th

The job is scheduled three times with the original scheduling dates: 16, 18, and 19 (that is, three job orders are added to the Active Jobs file).

696

Control-M Parameter Guide

SAC

SAC
Whether to adjust the logical date for a job converted from a scheduling product other than Control-M.

NOTE
This parameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later.

Format
Usage Format Optional The following options are available:

Blank No adjustment is made. The SMART Table and all the jobs in it are scheduled according to the regular criteria. This is the default. P (Previous) The operation of this value depends on whether it is in a table or a job scheduling definition. If this value is set for a SMART Table, the SMART Table is scheduled both on the day indicated by the regular scheduling criteria and on the day preceding that day. If this value is set for a job, the job is scheduled on the day preceding that indicated by the regular scheduling criteria.

N (Next) The operation of this value depends on whether it is in a table or a job scheduling definition. If this value is set for a SMART Table, the SMART Table is scheduled both on the day indicated by the regular scheduling criteria and on the day following that day. If this value is set for a job, the job is scheduled on the day following that indicated by the regular scheduling criteria.

+ (Plus) [For table scheduling definitions only] The scheduling of the SMART Table is adjusted to the next logical date. - (Minus) [For table scheduling definitions only] The scheduling of the SMART Table is adjusted to the previous logical date.

AutoEdit Support

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Chapter 3

Scheduling parameters

697

SAC

General information
Use this parameter if one of the following is true:

You have migrated to Control-M/EM from another job scheduling product that did not enable you to select the New Day time. You have selected a New Day time that is different from the time at which the logical date changed under your old product.

In such circumstances, jobs may be scheduled at a time that falls between the time at which the logical date changed under your former product and the Control-M New Day time. This may cause jobs to be scheduled on the wrong date. The SAC parameter enables the logical date to be automatically adjusted in the case of such jobs, so that they run on the required date.

Aliases in other Control-M components

Alternate names for the SAC parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name PREV_DAY Prev Day (none) SAC sac

Example 1
In the MIXEDTBL table, the JOBA, JOBB, and JOBC jobs in the table have the SAC parameter set to P and the JOBX, JOBY, and JOBZ jobs have the SAC parameter left blank. In such a case, the table must be scheduled on both the regular scheduling day for the table and on the previous day, so that both types of jobs can run. Set the SAC parameter of the MIXEDTBL table to P.

Example 2
In the ONEVAL table, all the jobs have the SAC parameter set to P. In such a case, the table must be scheduled on the day preceding the regular scheduling day only. Set the SAC parameter of the ONVAL table to -.

698

Control-M Parameter Guide

Rule-Based Calendar

Rule-Based Calendar
Identifies a set of scheduling criteria defined for a SMART Table. This parameter only appears for jobs in a SMART Table. The scheduling criteria referenced by each RulesBased Calendar are defined in the outermost SMART Table.

Format
Usage Optional Note: Only relevant to jobs in a SMART Table. Length Format 1 through 20 alphanumeric characters This parameter must contain either the name of a Rules Based Calendar that is defined for the SMART Table, or an asterisk (*), indicating all Rules Based Calendar. Yes

Case Sensitive Invalid Characters

Blanks Computers other than z/OS: Single quotation marks. z/OS: The following characters must not be used in RBC definitions in SMART Tables: * (asterisk) ? (question mark) Non-English characters

AutoEdit Support

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameter
Active Indicates the start of a period of time during which the job or SMART Table can be ordered or the RBC can be used.

Related parameters
Parameter Relationship Description Indicates the relationship (AND/OR) between RBC criteria and basic scheduling criteria in the job processing definition (that is, whether either set of criteria, or both sets of criteria, must be satisfied).

General information
Each SMART Table contains one or more sets of basic scheduling criteria that can be applied to job processing definitions of jobs in the table. Each set of basic scheduling criteria is assigned a unique name, specified in the RBC field, which is used for referencing that set of criteria.
Chapter 3 Scheduling parameters 699

Rule-Based Calendar

To apply a set of scheduling criteria in a SMART Table to a job processing definition, specify the RBC name of the desired criteria in the RBC field of the Job Processing form. If multiple RBC names are specified in the job processing definition, the RBCs are checked sequentially (according to the order in which they are defined for the SMART Table) during job scheduling to determine if the criteria are satisfied. The first set of RBC criteria that is satisfied is applied to the job. Subsequent Rules Based Calendars specified for the job are not checked. If an asterisk (*) is specified as a RBC name, all Rules Based Calendars in the SMART Table are applied to the job. Each job processing definition can have its own basic scheduling criteria defined, independent of the RBC criteria in the SMART Table.

Scheduling jobs in a SMART Table

Jobs in a SMART Table are eligible for scheduling on a particular day only if at least one RBC in the SMART Table is satisfied. If a SMART Table is eligible for scheduling on a particular day, a job in the table is scheduled in either of the following cases:

The value of the Relationship parameter is OR. The basic scheduling criteria of the job or a specified RBC (or both) are satisfied. The value of the Relationship parameter is AND. Both the basic scheduling criteria of the job and a specified RBC are satisfied.

Aliases in other Control-M components

Alternate names for the RBC parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name RBC_NAME -rbc SCHEDULE RBC sched_rbc

Alternate formats in other Control-M components

Alternate formats for the RBC (Rules-Based Calendar) parameter are listed below.

700

Control-M Parameter Guide

Statistics Calendar

Component Control-M/EM Utilities

Format RBC_NAME parameters are contained in the RBC_NAMES parameter. The RBC_NAME value is a string. RBC_NAMES cannot have a value. Example <RBC_NAMES RBC_NAME=T1 RBC_NAME=T2/>

Example: Two sets of Rules-Based Calendars

SMART Table ACCOUNTS for group ACCOUNTS_GROUP contains two sets of scheduling criteria Rules-Based Calendars. One set is identified by the ALL_DAYS RBC, and the other set is identified by the SUNDAYS RBC. The following information is specified for ALL_DAYS RBC:
Week DaysALL

The following information is specified for SUNDAYS RBC:

Week Days1

For jobs that should run on any day, specify:

Schedule RBCALL-DAYS

For jobs that should only run on Sundays, specify:

Schedule RBCSUNDAYS

Statistics Calendar
Name of the Control-M periodic calendar within which statistics relating to the job are collected.

NOTE
This parameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later.

Chapter 3

Scheduling parameters

701

Statistics Calendar

Format
Usage Format Case Sensitive Invalid Characters AutoEdit Support Optional A valid period calendar name consisting of from 1 through 8 alphanumeric characters. Yes

Blanks Non-English characters

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Statistics Period Description The 1-character identifier of the actual days within the Control-M periodic calendar in relation to which statistics relating to the job are calculated.

General information
As part of the post-processing for each job, Control-M for z/OS 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. If the Statistics Calendar parameter is not used to specify a periodic calendar, the statistics relating to a job are based on all run times of the job. The Statistics Calendar parameter identifies the periodic calendar that is used to gather average runtime statistics for the job. The information displayed in the Statistics Period field identifies the specific days within that calendar that are used as the basis of the runtime statistics. By using the Statistics Calendar parameter together with the information displayed in the Statistics Period field, you can obtain more precise statistical information about the running of the job, as shown in the following example.

702

Control-M Parameter Guide

Statistics Calendar

Example
Assume that a job runs daily, weekly, and monthly, and that the Statistics Calendar parameter identifies a periodic calendar that contains a number of months each specified in a manner similar to the following:
-----S--------------S-------------S-------------S-------------S-------------S--1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 1 2 3 4 5 6 7 8 9 + 09 D D W D D D D D W D D D D D W D D D D D W D D D D M

In this example, the job runs daily in Period D, weekly in Period W, and monthly in Period M. If the job runs on the 3rd of the month, its statistics are collected for Period W. If it runs on the 6th of the month, its statistics are collected for Period D, and so on.

Aliases in other Control-M components

Alternate names for the Statistics Calendar parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name STAT_CAL Stat Calendar (none) STAT CAL statistic_cal

Chapter 3

Scheduling parameters

703

Statistics Period

Statistics Period
Identifier of the actual days within the Control-M periodic calendar in relation to which statistics relating to the job are calculated.

NOTE
This parameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later.

Format
Format 1 alphabetic character, display only

Related parameters
Parameter Description

Statistics Calendar Name of the Control-M periodic calendar within which statistics relating to the job are collected.

General information
This parameter provides more precise statistical information relating to z/OS jobs. For full information, see Statistics Calendar on page 701.

704

Control-M Parameter Guide

Time Zone

Time Zone
Indicates the time zone according to which the job should be scheduled.

Format
Usage Format Optional Threecharacter value The following values are supplied with Control-M: HNL HAW Honolulu Hawaii GMT-10.00 GMT-10:00

Note: HAW is maintained for backward compatibility purposes ANC PST MST CST EST ATL RIO GMT WET CET EET DXB KHI DAC BKK HKG Anchorage Standard Time Pacific Standard Time Mountain Standard Time Central Standard Time Eastern Standard Time Atlantic Standard Time Rio de Janeiro Greenwich Mean Time Western European Time Central European Time Eastern European Time Abu Dhabi Karachi Dacca Bangkok Hong Kong GMT-09:00 GMT-08:00 GMT-07:00 GMT-06:00 GMT-05:00 GMT-04.00 GMT-03.00 GMT+00:00 GMT+01:00 GMT+02:00 GMT+03:00 GMT+04.00 GMT+05.00 GMT+06.00 GMT+07.00 GMT+08:00

Chapter 3

Scheduling parameters

705

Time Zone

TYO TOK SYD MEL NOU AKL

Tokyo Tokyo Sydney Melbourne Noumea Auckland

GMT+09.00 GMT+09:00 GMT+10.00 GMT+10:00 GMT+11.00 GMT+12.00

Note: TOK is maintained for backward compatibility purposes

If necessary, these default values can be modified, and new values can be defined. For more information, see the description of time zone support in the maintenance chapter of the Control-M Administrator Guide. Default Invalid Characters AutoEdit Support If no value is specified for this parameter, the job runs with the time zone of the Control-M/Server that ordered the job. Non-English characters No. AutoEdit variables or expressions cannot be specified as values for this parameter.

General information

Newly defined jobs with specified time zones must be saved at least 48 hours before their intended execution dates (in order to ensure that they are ordered automatically by the appropriate New Day Procedure or User Daily). If they must run today they should be ordered manually (for example, using the ctmorder utility).

Specified Odates are calculated according to the working date (not the actual date). This means that if a job is defined as working on the 5th of the month at 3:00 A.M., and the working day begins at 5:00 A.M., then the job is actually run at 3:00 A.M. on the morning of the 6th (which is still part of the working day of the 5th). In addition to time zones, you can also order a job that is intended for execution on a future date. For more information, see the odate and odate_option parameters in any of the following Control-M/Server utilities: ctmudly ctmudchk ctmorder ctmcreate For more information about these utilities, see the Control-M Administrator Guide.

BMC Software recommends that you do not combine jobs that have time zone specifications with jobs that do not specify a time zone in the same table.

706

Control-M Parameter Guide

Time Zone

When a job is considered for ordering by the New Day procedure, it is ordered if its scheduling date occurs within the next 48 hours. When a job is ordered by a User Daily job, it is ordered only if its scheduling criteria are satisfied for the current working date. For this reason, BMC Software recommends that you arrange the jobs for each time zone in a separate table. For more information, see the description of time zone support in the maintenance chapter of the Control-M Administrator Guide.

Aliases in other Control-M components

Alternate names for the Time Zone parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name TIMEZONE -timezone TIMEZONE time_zone

Example
Use the following parameters to schedule a job that runs at 5 P.M. Tokyo time:
Tasktype job time from 17:00 Time Zone TOK

Chapter 3

Scheduling parameters

707

Week Days

Week Days
Indicates the days of the week on which the job should be scheduled for processing.

Format
Usage Format Optional In the Job Editing form, this parameter can be specified using either a series of check boxes or a text box immediately below these check boxes. The information below is relevant for entry of Week Days information in the text box. The number used to represent each weekday depends upon a Control-M system parameter that specifies whether 1= Sunday, or 1= Monday. Consult your Control-M administrator to determine which standard is used at your site. Note: All examples shown below assume that 1=Sunday, 2=Monday, and so on, at your site. Note: The term working days in the following format descriptions refers to days marked in the calendar specified for the Weeks Calendar parameter. Valid formats for the Week Days parameter vary depending on whether a periodic calendar is specified as the Weeks Calendar. Formats for each type of calendar are specified separately, as described in Periodic calendar format on page 709 and Non-periodic (regular) calendar Format on page 710. Length Case sensitive Invalid Characters AutoEdit Support 1-50 characters Yes Blanks; single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

708

Control-M Parameter Guide

Week Days

Periodic calendar format

Format Rules Description In the following periodic scheduling formats:

n is any integer from 0 through 6. i is any valid period identifier. Valid values are: any integer from 1 through 9 any uppercase letter except N and Y * (asterisk) all periods Week Days periodic identifiers are counted on a week-by-week basis. Calculations do not cross week boundaries (unlike Days periodic boundaries, which can cross month boundaries). The name of a periodic calendar must be specified in the Weeks Calendar. A maximum of eight periodic values can be designated, in any desired order: DnPi,... Order the job on the nth day of period i in each week from the beginning of the week. An * can be specified as: the n value to represent all days the i value to represent all periods -DnPi,... Order the job on all days of period i except the nth day of period i in each week from the beginning of the week. An * can be specified 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 specified as the i value to represent all periods. -LnPi,... Order the job on all days of period i except the nth day of period i in each week counting backward from the last periodic day of the week. An * can be specified as the i value to represent all periods.

Values

Chapter 3

Scheduling parameters

709

Week Days

Non-periodic (regular) calendar Format

Format Rules Description

n Any integer from 0 through 6, representing the days of the week. Multiple values can be expressed in any order (separated by commas). ALL All days of the week. Do not specify any other value with ALL. n,... Specific days of the week. +n,... Specific day of the week in addition to working days. -n,... Days of the week on which a job cannot be ordered, even if they are working days. >n, Order the job on the indicated day if it is a working day; otherwise, order the job on the next working day. This format is frequently used for holiday handling. <n, Order the job on the indicated day if it is a working day; otherwise, order the job on the previous working day. This format is frequently used for holiday handling.

Values

In the following Week Days formats, n represents a number of working days. n can be any integer from 0 through 6.

Dn, Order the job on the nth working day from the beginning of the week. -Dn, Order the job on all working days except the nth working day from the beginning of the week. Ln, Order the job on the nth working day from the end of the week (L1 represents the last working day of the week). -Ln, Order the job on all working days except the nth working day from the end of the week (L1 represents the last working day of the week). DnWm, (Where m is any integer from 1 through 6) If Weeks Calendar is defined, order the job on the nth working day of the mth week (partial or full) of the month. If Weeks Calendar is not defined, order the job on the mth occurrence of weekday n during the month. A maximum of 11DnWm specifications can be designated.

Note: A calendar must be specified for the Weeks Calendar parameter if the +n, -n, >n, <n, Dn, -Dn, Ln, or -Ln format is used for the Week Days parameter.

710

Control-M Parameter Guide

Week Days

Related parameters
Parameter Active Days Days Calendar Description Indicates the start of a period of time during which the job or SMART Table can be ordered or the RBC can be used. Days of the month on which to order the job. Indicates the name of a Control-M calendar that is used to validate specified days. This parameter may be mandatory for certain Days value formats. Indicates the relationship between specified Days values and Weekdays values. Indicates the name of a Control-M calendar that is used to validate specified weekdays. Indicates the name of a Control-M calendar that is used to validate scheduling dates. A specified shift value can be used to indicate how to handle jobs that are scheduled for a non-working day in the calendar. Indicates the months in which the job should be scheduled. Only days in the specified months are considered valid for scheduling the job.

And/Or Weeks Calendar Confcal

Months

General information
The job is ordered only on the days of the week marked in the list, and in the months specified in the Months parameter. Negative values take precedence over positive values when determining whether a job should be scheduled on a certain date. If a negative value (-n, -Dn, -L, DnPi, or LnPi) in either the Days or Week Days parameter prevents a job from being scheduled on a date, the job is not scheduled on that date even if a positive value (for example, Ln) would otherwise result in the job being scheduled on that date. Identical negative and positive values (for example, -Dn, Dn) cannot be specified together.

NOTE
If the And option is selected (Month Days and Week Days), and no criteria are specified for either the Month Days or the Week Days parameter, Control-M/EM assumes that ALL has been specified for the empty parameter. For example, if Monday is selected, and no days of the month are selected, the job is scheduled on all Mondays of the month.

If periodic and non-periodic values are mixed when specifying Week Days, processing depends upon the type of calendar specified in the Weeks Calendar parameter.

If a non-periodic calendar is specified in the Weeks Calendar parameter, only nonperiodic values are processed; periodic values are ignored.

Chapter 3

Scheduling parameters

711

Week Days

If a periodic calendar is specified in Weeks Calendar parameter, all periodic values and all negative non-periodic values (for example, -n) are processed; non-negative non-periodic values are ignored.

NOTE
You can use the CTMRPLN utility to generate a report describing when the job runs based on its currently specified scheduling dates. For more information, see the description of this utility in the Control-M Administrator Guide for your computer.

Computer-specific information for z/OS

The Months parameter is ignored when periodic values (values containing a P character) are specified in parameter Week Days.

Alternate names for the Week Days parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name WEEKDAYS W_DAY_STR -weekdays WDAYS week_days

NOTE
The following examples assume that the first day of the week in the installation is Sunday.

Example 1: Job scheduled on each Monday in March and September

712

Control-M Parameter Guide

Week Days

Example 2: Job scheduled on every Saturday and Sunday of each month

Example 3: Schedule a job on each day in December

Example 4: Alter scheduling for different user-defined periods (z/OS format)

Each week, schedule the job on the first day of period A, and on all days, except the 2nd day, of period B, in that week.

Week Days D1PA, -D2PB Weeks Calendar PERIDAYS

Periodic calendar PERIDAYS contains the following definitions:

---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

The job is scheduled on the days of the month indicated by an asterisk:

---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 * * * * * * * * *

Chapter 3

Scheduling parameters

713

Weeks Calendar

Weeks Calendar
Indicates the name of a calendar to be used to validate specified weekdays on which to order the job.

Format
Usage Length Optional 1-30 characters z/OS: 1-8 characters

Case sensitive Yes Invalid Characters AutoEdit Support Computers other than z/OS: Blanks; single quotation marks z/OS: Blanks

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Active Days Calendar Description Indicates the start of a period of time during which the job or SMART Table can be ordered or the RBC can be used. Indicates the name of a Control-M calendar that is used to validate specified days. This parameter may be mandatory for certain Days value formats. Indicates the relationship between specified Days values and Weekdays values. Indicates the months in which the job should be scheduled. Only days in the specified months are considered valid for scheduling the job.

And/Or Months

General information
A calendar contains a list of days that can be used as a basis for scheduling jobs. For example, the days in the calendar can be working days, accounting days, or holidays.

Any number of calendars can be defined, where each one corresponds to a different set of dates. Calendars are usually defined for the entire installation, though each user can define calendars for his/her own use. One calendar can be shared by many job processing definitions. The calendar does not have to exist when the job processing parameters are defined. Its actual existence is checked during New Day Processing.

714

Control-M Parameter Guide

Weeks Calendar

NOTE
The Weeks Calendar parameter cannot be used together with the Dates parameter.

How this parameter works

If no values are specified for the Week Days parameter, all working days in the specified Weeks Calendar are considered valid for job scheduling. If no Weeks Calendar is specified, all specified Week Days values are considered valid working days. When the Weeks Calendar parameter is specified with the Week Days parameter, the job is scheduled for execution only if all the indicated Week Days are also marked in the calendar. If the Weeks Calendar parameter is specified with a Week Days parameter that includes the + symbol, the job is scheduled for execution on those dates marked with a + (in the Week Days parameter), in addition to the dates marked in the calendar. If the Weeks Calendar parameter is specified with a Week Days parameter that includes the symbol, the job is not scheduled for execution on those dates even if the date is marked in the calendar. The appropriate Months parameters must be checked. The And/Or relationship between Days and Weekdays is analyzed.

You can use the Control-M CTMRPLN utility to generate a report describing when the job runs based on its currently specified scheduling dates. For more information, see the description of this utility in the Control-M Administrator Guide for your computer.

Aliases in other Control-M components

Alternate names for the Weeks Calendar parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name WEEKSCAL WEEKS_CAL -weekcal WCAL weeks_cal

Chapter 3

Scheduling parameters

715

Weeks Calendar

Example 1: Schedule the job on every Monday in July and August that is a workday NOTE
The following examples presume that the first day of the week is defined as Sunday at your site.

Example 2: Schedule the job on every Monday in July, whether it is workday, and each Tuesday in July that is a workday

Example 3: Schedule the job on every Friday in June, July and August that is a half day

716

Control-M Parameter Guide

Chapter

Execution parameters
The parameters in this section are related to the execution of the job and the processes that accompany execution. Table 158 Execution parameters - summary
Parameter Confirm Critical Cyclic Due Out Description A job in which the Confirm parameter is checked is not considered for submission until manually confirmed by the Control-M/EM user. When selected, indicates that the job is a critical-path job in Control-M. Indicates that the job will run at a designated time or interval of time. Time by which the job must finish executing. + num Days The day by which the job must finish executing. The + num Days subparameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later. Max Wait Specifies the number of extra days (beyond the original scheduling date) that the job is allowed to remain in the Active Jobs file awaiting execution.

Maximum Reruns Specifies the maximum number of reruns that can be performed for the job. Multi Agent Node Group Node ID Node ID/Group Specifies that job submission details be broadcast to all agents within a defined Node Group. Host name of a node group to which the job should be submitted. For more information, see Node ID/Group below. Name of a Control-M/Agent or remote host computer to which a job was submitted. For more information, see Node ID/Group below. Name of a Control-M/Agent computer, remote host computer, or node group to which the job should be submitted. This parameter is used only for installations in which Control-M/Agent technology is implemented. Note: Node groups can be specified only for certain Control-M computers with Control-M version 2.2.0 and later. Prevent NCT2 Performs data set cleanup before the original job run.

Chapter 4

Execution parameters

717

Table 158 Execution parameters - summary

Parameter Priority Rerun From Rerun Member Scheduling Environment System Affinity Description Indicates Control-M job priority. Indicates whether the interval between further runs of a cyclic job is counted from the start or the end of the previous job run. Name of the JCL member to use when the job is automatically rerun. Indicates the JES2 workload management scheduling environment that is to be associated with the job. Indicates the identity of the system in which the job must be initiated and executed (in JES2). Indicates the identity of the processor on which the job must execute (in JES3). Time From, Time Until Units From sets the earliest date and time for submitting the job. Until sets the latest date and time for submitting the job. Specifies a unit of time for the numerical value indicated by the Interval parameter.

Request NJE Node Identifies the node in the JES network on which the job is to execute.

718

Control-M Parameter Guide

Confirm

Confirm
Specifies whether user confirmation is required before the job is submitted for execution.

Format
Usage Format Optional Select the Confirm check box to indicate that confirmation is required. The jobs submission criteria are not evaluated until Control-M receives manual confirmation from the user (using the Confirm/Restart option in the Control-M/EM window). Clear the check box to indicate that confirmation is not required. The jobs submission criteria are evaluated when the job is placed in the Active Jobs file, without the need for user confirmation. Invalid Characters AutoEdit Support Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
If Confirm is selected, a status of WAIT USER is assigned to the job when it is placed in the Active Jobs file. When you confirm the job, it is submitted after the remaining submission criteria are satisfied.

Aliases in other Control-M components

Alternate names for the Confirm parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name CONFIRM -confirm CONFIRM confirm_flag

Chapter 4

Execution parameters

719

Confirm

Alternate formats in other Control-M components

Alternate formats for the Confirm parameter are listed below.
Component Control-M/EM Utilities Format Valid values: 0 - No confirmation required. Default 1 - Confirmation required. Example <CONFIRM=1/> Valid values: N - No confirmation required. Default Y - Confirmation required. Valid values: N - No confirmation required. Default Y - Confirmation required.

Control-M/Server Utilities

Control-M for z/OS

720

Control-M Parameter Guide

Critical

Critical
When selected, indicates that the job is a critical-path job in Control-M.

Format
Usage Format Optional Check box Selected job is critical Cleared job is not critical Non-English characters

Invalid Characters

Related parameters
Priority The Critical parameter takes precedence over the Priority parameter, when both are specified.

Availability
For non-z/OS computers Defining a job as critical ensures that a job that requires resources is submitted as soon as possible after all its In Conditions parameters are satisfied. As a result of a job being defined as critical, any Quantitative resources or Control resources that the job requires exclusively are reserved for the job as they become available. The preferential treatment given to a critical job is applied only after all the jobs In Conditions parameters are satisfied. The Critical parameter takes precedence over the Priority parameter (a low-priority job defined as critical is given preferential treatment over a non-critical high-priority job). However, if two critical jobs are awaiting execution at the same time, the higher-priority job receives resources before the lower-priority job. Critical path priority applies to contention between Quantitative resources and between Control resources with Exclusive status. The critical path priority does not apply to contention with Control resources with Shared status. For more information about the Priority parameter, see Priority on page 748. For z/OS computers The Critical parameter check box is replaced with a check box labeled Emergency. When selected, this marks the z/OS job as an Emergency job task type.

Chapter 4

Execution parameters

721

Critical

NOTE
[For z/OS jobs] The Emergency check box is marked if the job definition is created as a result of a Control-M/EM utility and the Critical parameter was set to 1 (see below).

Availability
For non-z/OS computers, critical is available for jobs whose statuses are not Executing when editing details in the active environment.

Aliases in other Control-M components

Alternate names for the Critical parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M/EM API Parameter Name CRITICAL CRITICAL -critical critical

Alternate formats for other Control-M components

Alternate formats for the Critical parameter are listed below.
Component Control-M/EM Utilities Format Valid values: 1 - Job is critical. 0 - Job is not critical. Default. Example <CRITICAL=1/> Valid values: Y - Job is critical. N - Job is not critical. Default.

Control-M/Server Utilities

Example 1: Resource availability overrides critical status

If one tape drive is available, neither job is submitted. When two tape drives become available, job EBDUPDT is submitted. Job EBDUPDTs priority level is 50, Critical is selected, and it requires two tape drives.

722

Control-M Parameter Guide

Critical

Item Mem Name Quantitative Resources Priority Critical

Value EBDUPDT TAPE 0002 50 Y

Job EBDEXECs priority level is 04, and it requires one tape drive. It is not a Critical job.
Item Mem Name Quantitative Resources Priority Critical Value EBDEXEC TAPE 0001 04 N

Example 2: Resource availability determines job submission

If one or two tape drives are available, neither job is submitted. When three tape drives become available, job EBDBKP is submitted. Job EBDBKPs priority level is 8A, Critical is selected, and it requires three tape drives.
Item Mem Name Quantitative Resources Priority Critical Value EBDBKP TAPE 0003 8A Y

Job EBDMAINTs priority level is 70, Critical is selected, and it requires one tape drive.
Item Mem Name Quantitative Resources Priority Critical Contents EBDMAINT TAPE 0001 70 Y

Chapter 4

Execution parameters

723

Cyclic

Cyclic
Indicates that the job will run at a designated time or interval of time.

Format
Usage Format Optional Check box Selected job is cyclic Clear job is not cyclic

Subparameters
Parameter Run Interval Description Fixed interval values to rerun a job: Minutes: 0-64,800 Hours: 0-1080 Days: 0-45

Interval Sequence List of time intervals (e.g. +30M,+2h,+1D) up to 4000 characters including commas. Value range: Minutes: 0-64,800 Hours: 0-1080 Days: 0-45 Specific Times A list of specific times, separated by commas, for the job to run (e.g. 0700,0945,1005,2300). 4000 characters including commas Note: This parameter supports time synonym. Tolerance Maximum delay in minutes permitted for a late submission when selecting a specific time (e.g. 5 minutes). Valid range: 0-999

Related parameters
Parameter Cyclic Type Description Determines the type of cyclic job: Rerun Interval Interval Sequence Specific Times Determines from where the interval is counted when rerunning a cyclic job. Do Stop Cyclic overrides the Cyclic specification.

Rerun From Do Stop Cyclic

724

Control-M Parameter Guide

Cyclic

Parameter

Description

Maximum Reruns Determines the maximum number of runs that are performed. This value overrides the number of runs specified in the Interval Sequence and Specific Times fields. For example, if the specific times are 07:00, 11:30, and 21:30, and the maximum rerun is 2, the job runs only twice. Max Wait Task Type Determines the maximum number of days a cyclic job can wait for submission. In z/OS environments, Cyclic is a value of the Task Type parameter, not a unique parameter.

General information
A non-cyclic job is a job that, if its scheduling criteria are satisfied, is ordered once by Control-M on a given day (discounting reruns caused by a Do Rerun parameter or manual reruns). A cyclic job is rescheduled after execution for an additional possible execution. The job executes again only when the following circumstances occur:

The first run has completed. The runtime schedule and execution parameters are still satisfied. A specified number of minutes has elapsed since the last completion of the job or the next specified runtime has been reached.

The cyclic job runs at the time designated according to the time or time intervals selected. The Specific Time and the Tolerance parameters can be set to enable a job to run after the specified time. If the job being executed runs over the proceeding jobs specified time, the proceeding jobs execution time window is extended to the number of minutes set in the Tolerance field. For example, if the Tolerance field is set to 15 minutes, the proceeding job can still be executed 0-15 minutes after the specified time. If the tolerance time interval has passed, the proceeding job will not be performed.

NOTE
The Specific Time option is relevant for one odate only. Specific times are sorted from each new day time to the next.

Ordering a cyclic job as non-cyclic

The %%CYCLIC AutoEdit variable can be used to override the Cyclic parameter for a job, or for all jobs in a table. This variable is normally used when ordering a cyclic job for a single run.

Chapter 4

Execution parameters

725

Cyclic

EXAMPLE
To indicate that all jobs ordered by the ctmorder utility (in Control-M/Server) should run as non-cyclic jobs, include the following statement in the command line of the ctmorder utility. -autoedit %%CYCLIC N

Maximum number of days to wait for submission

The CYCLIC_MAXWAIT parameter for Control-M/Server determines when cyclic jobs, which have executed at least once, should be removed from the Active Jobs file by the New Day procedure. Valid values are:

KEEP Jobs are removed from the Active Jobs file when MAXWAIT days have passed regardless of whether the job ended OK. Default. NOT_KEEP Jobs (non-cyclic and cyclic) are removed from the Active Jobs file at the next run of the New Day procedure. Cyclic jobs are not removed if they are executing when the New Day procedure begins. Instead, they are removed at the run of the following New Day procedure.

For more information about Control-M/Server parameters, see the Control-M Administrator Guide. Special care should be taken when specifying a cyclic job. If not defined appropriately it may cause an endless loop in which the job is continually resubmitted for execution. If a cyclic job is executing when the New Day procedure is run, the job is changed to non-cyclic and an appropriate message is written to the Control-M log. It is the users responsibility to review these messages and handle them accordingly.

Terminating a cyclic job

You can prevent subsequent iterations of a cyclic job by using the Do Stop Cyclic parameter. For more information, see Do Stop Cyclic on page 825. If a cyclic job is terminated by a Do Stop Cyclic parameter, the View Details screen displayed by option Z in the ctmpsm utility contains Cyclic:T where T indicates Terminated.

726

Control-M Parameter Guide

Cyclic

Availability For z/OS jobs

Cyclic jobs cannot contain Do Rerun parameters or Shout When Rerun parameters.

Aliases in other Control-M components

Alternate names for the Cyclic parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name CYCLIC CYCLIC Cyclic is a Task Type parameter value, not a unique parameter. For more information, see Task Type on page 651. cyclic

Control-M/Server Utilities -cyclic

Chapter 4

Execution parameters

727

Due Out

Due Out
Sets the time by which, and the day by which, the job must finish executing.

Format
Usage Format Optional A 4-digit number in the format hhmm, where hh is the hour the job is due out, based on the 24-hour clock mm is the minute the job is due out No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

AutoEdit Support

Subparameter
+ num Days sets the number of days that job execution can be extended after the ODAT. In this subparameter, num is a 3-digit number from 0 through 120, or is blank.

NOTE
The + num Days subparameter is relevant only for jobs running in Control-M for z/OS version 6.2.00 or later.

General information
If two jobs with the same priority are available for submission, Control-M submits the job with the earlier Due Out date and time first. If the Due Out field is left blank, and + num Days is not used to set an offset date, the default Due Out time is the last minute of the working day. If + num Days is used to set an offset date and the Due Out field is left blank, the default Due Out time is the last minute of the working day of the offset date.

Examples
1. Assume the following:

The original scheduling date (Odate) is January 20. The Due Out field is blank. The + num Days field is blank.

The job must finish executing by the last minute before the New Day procedure runs at the end of the January 20 working day.
728 Control-M Parameter Guide

Due Out

2. Assume the following:

The Odate is January 20. Due Out is set to 1700. + num Days is blank.

The job must finish executing by 5 P.M. on January 20. 3. Assume the following:

The Odate is January 20 Due Out is set to 1700 + num Days is set to + 3 days.

The job must finish executing by 5 P.M. on January 23.

Chapter 4

Execution parameters

729

Interval

Interval
Specifies the length of time to wait between reruns of a job or between cyclic runs of a job.

Format
Usage Optional Note: When defining a cyclic job with an Interval parameter with the default value of 0, if the default is not changed, the job runs continuously when submitted for execution. Format Valid values: 0 to 64800 (for minutes) 0 to 1080 (for hours) 0 to 45 (for days) Default: 0 Note: The unit of measurement is determined by the Units parameter, described on page 768. If no Units parameter value is specified, the default is Minutes. Case sensitive Invalid Characters AutoEdit Support No Blanks; single quotation marks No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Cyclic Units Indicates if the job is cyclic (to be rerun at regular intervals). Indicates units of measurement (minutes, hours, and days) the amount of which is determined by the Interval parameter.

General information
A From field can be included in the Interval specification. This field indicates if the time for the next run of the job should be calculated from the beginning or from the end of the previous run of the job. A job can be run more than once from a given job order when the jobs completion status was set to Rerun using a Do Rerun parameter -or the job is defined as Cyclic
730 Control-M Parameter Guide

Interval

Control-M waits at least the number of minutes specified by the Interval parameter before it attempts the next rerun of the job or before the next run of a cyclic job. The Interval period can be calculated from either the start or the end of the previous job run, as determined by the Rerun From parameter. For more information, see Rerun From on page 753. The job is re-submitted after

the specified number of minutes have elapsed from the last rerun, or from the start or end of the last run of a cyclic job -andall submission criteria are satisfied

Availability For Control-M/Server version 2.2.4 and 2.2.5 Jobs

Interval is relevant only when Cyclic is selected. However a value can be specified in Control-M/EM and Control-M/Desktop for the Interval parameter even for non-cyclic jobs. In this case, the interval is ignored. The From subparameter not displayed in Control-M/EM or Control-M/Desktop.

For z/OS version 6.0.0x, and 6.1.03 jobs

The From subparameter is relevant for cyclic jobs for non-cyclic jobs with a MAXRERUN parameter specified

For z/OS version 5.1.4x jobs

The From subparameter is not displayed in Control-M/EM or Control-M/Desktop.

Aliases in other Control-M components

Alternate names for the Interval parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Parameter Name INTERVAL INTERVAL -interval

Chapter 4

Execution parameters

731

Interval

Component Control-M for z/OS Control-M/EM API

Parameter Name INTERVAL rerun_interval

Alternate formats for other Control-M components

Alternate formats for the Interval parameter are listed below.
Component Control-M for z/OS Format INTERVAL combines the functionality of the Interval, Rerun From, and Units parameters. <interval-number> Valid values: 0 to 64800 (for minutes) 0 to 1080 (for hours) 0 to 45 (for days) <interval-type> A single character describing the type of data specified in the INTERVAL field. Valid values are: D - (Days) Maximum INTERVAL value is 45. H - (Hours) Maximum INTERVAL value is 1080. M - (Minutes) Maximum INTERVAL value is 64800. Default. FROM Similar to the Rerun From parameter. Valid values. STRT Measures the interval from the start of the current job run. Default. END Measures the interval from the end of the current job run. TRGT Measures the interval before the next cycle of the job from when the current job run is scheduled.

732

Control-M Parameter Guide

Max Wait

Max Wait
Specifies the number of extra days (beyond the original scheduling date) that the job is allowed to remain in the Active Jobs file awaiting execution. If the job still has not run after the specified number of days, the job is removed from the Active Jobs file. The Max Wait parameter of a job which belongs to a SMART Table or sub-table will be overwritten by the first positive Rules Based Calendar Max Wait (the Rules Based Calendar which is used by the job) if the relationship parameter of the job is defined as or. The Max Wait parameter for a SMART Table or sub-table is taken from the first positive Rules Based Calendar.

Format
Usage Format Default AutoEdit Support Optional An integer from 0 through 98 (days), or 99 (no limit) For more information, see Table 159 on page 734. 0 No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Max Wait parameter is used to handle the following types of occurrences:

For non-cyclic jobs

A job that is scheduled for execution on a specific day is not always submitted that same day. This may be due to any number of reasons, such as a heavy production workload, a problem in one of the jobs predecessors causing a process to stop, or a hardware failure. When Max Wait is assigned a value greater than zero, the job is retained in the Active Jobs file up to the specified number of days, allowing the job additional opportunities to be submitted. A job that ends NOTOK during the night can be deleted from the Active Jobs file during the execution of the New Day procedure the next morning. Using the Max Wait parameter, the user can retain an overnight job that ends NOTOK in the Active Jobs file for a number of days, allowing the operator an opportunity to correct the problem and rerun the job without the need to re-order the job.

Chapter 4

Execution parameters

733

Max Wait

For cyclic jobs

If CYCLIC_MAXWAIT (Control-M parameter) is set to KEEP (default), the Max Wait parameter does not depend on whether the job ended OK or NOTOK. Cyclic jobs are only deleted from the Active Jobs file after the expiration of the Max Wait parameter. If CYCLIC_MAXWAIT is NOT_KEEP, Cyclic jobs are removed from the Active Jobs file at the next run of the New Day procedure, unless they are executing when the New Day procedure begins. In this case, they are removed at the run of the following New Day procedure.

Max Wait parameter effects

The effect of the value specified for the Max Wait parameter is described in Table 159: Table 159 Max Wait parameter values
Max Wait 0 Max Wait n (n = 1-98) Max Wait 99 The job is deleted from the Active Jobs file if it did not execute on its scheduling date. The job is retained in the Active Jobs file for the stated number of additional days beyond its original scheduling date (Odate) or until submitted for execution (and execution ends OK). The job remains in the Active Jobs file indefinitely (or until it is manually deleted), even if it finishes executing.

Computer-specific information for z/OS

If a non-cyclic job that was run on a Control-M installation on an z/OS computer was rerun by the operator and ended NOTOK, it is deleted from the Active Jobs file when the New Day procedure runs, regardless of the value specified in the Max Wait parameter.

Aliases in other Control-M components

Alternate names for the Max Wait parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name MAXWAIT MAX WAIT -maxwait MAXWAIT max_wait

734

Control-M Parameter Guide

Max Wait

Example 1: Retain job until resources available

Retain a scheduled job indefinitely, until the runtime resources required for the job are available:
Max Wait 99

Example 2: Retain job beyond original scheduling date

Retain a job for an extra three days beyond its original scheduling date:
Days 02,04,06 Max Wait 03

Assume that the job does not run due to the absence of the required runtime resources. The job that is scheduled for day 2 of the month waits from the second through the fifth to be executed. On the sixth of the month, Control-M gives up, and the job that was originally scheduled for day 2 is deleted. The jobs scheduled for days 4 and 6 wait until as late as days 7 and 9 respectively to be executed.

Example 3: Schedule a job for periods when the computer is inactive

Schedule the job for every working day, whether the computer is active. Allow each scheduled job three extra days to execute:
Days Calendar WORKDAYS Retro Y Max Wait 03

Given the following circumstances:

The WORKDAYS calendar, specified in the Days Calendar parameter, contains the values 15, 16, 17, and 19. The computer was off-line from day 15 up to and including day 18.

When the computer is brought back online on day 19, the job is scheduled four times, with original scheduling dates (Odate) of the 15, 16, 17 and 19, respectively. Each scheduled job that does not execute successfully (, either not submitted or did not end OK) is handled as follows by Control-M:

The job with Odate 15 is retained on day 19 and deleted from the Active Jobs file on day 20 even though the Max Wait period of three days has already passed since each job with Retro Y is given at least one day to run.
Chapter 4 Execution parameters 735

Max Wait

The job with Odate 16 is deleted on day 20 since day 19 is the last day of the Max Wait period of three days. The job with Odate 17 is deleted on day 21 since day 20 is the last day of the Max Wait period of three days.

The job with Odate 19 is deleted on day 23 since day 22 is the last day of the Max Wait period of three days.

736

Control-M Parameter Guide

Maximum Reruns

Maximum Reruns
Specifies the maximum number of reruns that can be performed for the job.

Format
Usage Length Optional An integer from 0 through 99. z/OS: There is a difference between cyclic jobs and regular jobs: Cyclic jobs an integer from 0 through 9999 Regular jobs an integer from 0 through 255. 0 No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Default AutoEdit Support

Related parameters
Do Remedy Cyclic Specifies when a job is to be rerun. Indicates that the job is rerun on a regular basis.

General information
When the jobs completion status is set to Rerun using the Do Rerun parameter, Control-M checks the number of reruns specified in the Maximum parameter. If the number in the Maximum parameter is greater than the number of reruns that have already been performed for the job, a rerun (automatic rerun) process is performed for the job.

NOTE
This parameter cannot be specified for a cyclic job running on a version of Control-M earlier than 6.1.00. This parameter can be specified for a cyclic job running on Control-M version 6.1.00 or later.

When a job is assigned Rerun status, the job is not rerun if either

maximum = 0 -orthe number of reruns specified in this parameter has already been performed

Control-M waits at least the number of minutes specified by the Interval parameter before it attempts the next rerun of the job.

Chapter 4

Execution parameters

737

Maximum Reruns

The job is re-submitted after

The specified number of minutes has elapsed from the last rerun -andall submission criteria are satisfied

A rerun counter is displayed on the Active panel of the Job Editing form, indicating how many times the job has been rerun from the current job order.

Computer-specific information for z/OS

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. Control-M 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. 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 Control-M for z/OS Active Environment screen. If a job is defined as cyclic, the MAXRERUN parameter can be used to specify the number of iterations. This number excludes the initial run of the job.

Availability For Control-M/Server version 2.2.4, 2.2.5, 6.0.05 and z/OS version 5.1.4x jobs

The Maximum (MAXRERUN) parameter is available for non-cyclic jobs only in both Control-M/EM and Control-M/Desktop.

738

Control-M Parameter Guide

Maximum Reruns

Aliases in other Control-M components

Alternate names for the Maximum parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name MAXRERUN MAX RERUN -maxrerun MAXRERUN rerun_max

Chapter 4

Execution parameters

739

Multi Agent

Multi Agent
Specifies that job submission details be broadcast to all agents within a defined Node Group. All available agents in the Node Group run an identical job, and each such job has a unique Order ID.

NOTE
Multi Agent cannot be specified for z/OS jobs.

Format
Usage Default Format Optional No Check box Selected Multi Agent job Cleared Not a Multi Agent job Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Invalid Characters AutoEdit Support

Related parameters
Parameter Node Group Description Specifies the Control-M/Agent node group to which the job is submitted. The job is submitted to only one agent in the specified node group, instead of submitting it to all agents in the node group (as when Multi Agent is selected). Specifies the Control-M/Agent node ID or node group to which the job is submitted. The job is submitted to only the specified node ID or one agent in the specified node group, instead of submitting it to all agents in the node group (as when Multi Agent is selected).

Node ID/Group

General information
The job is processed by all the agents specified for the Node ID/Group parameter or the Node group parameter (in the Active environment, only). A node group must be specified for the Node ID/Group parameter or the Node Group parameter. For more details, see Node ID/Group on page 742.

740

Control-M Parameter Guide

Multi Agent

For example, you can run a job that detects the amount of disk space available on the computer on which the job was run. By specifying Yes Multi Agent, the job checks the available disk space on every agent computer in the specified Node Group.

Computer-specific issues
This parameter does not work with z/OS jobs.

Aliases in other Control-M components

Alternate names for the Multi Agent parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/EM API Parameter Name MULTY_AGENT MULTY AGENT multiagent

Control-M/Server Utilities -multiagent

Example: Submit a job to all agents in a node group

Specify the following parameter in Control-M/Server ctmcreate utility to submit a job for processing by all agents in the Group PRODUCTION.
ctmcreate -tasktype job -multiagent y -nodegrp PRODUCTION

Chapter 4

Execution parameters

741

Node ID/Group

Node ID/Group
Name of a Control-M/Agent computer, remote host computer, or node group to which the

job should be submitted. This parameter is used only for installations in which Control-M Agent technology is implemented, for certain computers with Control-M version 2.2.0 or later. It is not relevant in z/OS environments.

NOTE
In the job editing form prior to Control-M/EM version 6.3.01, the Application Node Group parameter was tightly linked to the Application parameter. Beginning with Control-M/EM version 6.3.01, you select the application node group in the Node ID/Group field (in the Execution tab of the job editing form).

Format
Usage Optional Note: If this parameter is left blank, the job is submitted for execution on the Control-M/Server computer. Length Case Sensitive Invalid Characters AutoEdit Support 1 through 50 characters No Blanks; single quotation marks. No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information

To submit the job to Control-M/Agent or remote host on a specific computer, specify the host name of the computer. To submit the job on the server computer, leave this parameter blank. To submit the job using the load balancing mechanism, specify the group name representing the collection of computers that are capable of executing the job. The group name must be defined in the installation.

NOTE
Node groups can be specified only for certain Control-M computers with Control-M version 2.2.0 and later.

742

Control-M Parameter Guide

Node ID/Group

NOTE
When moving from primary to secondary server or from secondary to primary server, jobs that are in executing state on the default local agent are not recognized by the other server. If there are jobs without an owner, both the primary and the secondary server must have the same account name. To avoid this situation from occurring, define a specific nodeid for a job. For more information about failover, see the Control-M Administrator Guide.

Node ID/Group in the active environment

The Node/ID/Group parameter is divided into two separate parameters in the Job Editing form in the Control-M/EM GUI. These parameters are Node ID and Node Group. Table 160 Node ID and Node Group parameter descriptions
Parameter Node ID Node Group Description Displays the name of the node on which the job was most recently run. This field is not user-configurable. Name of the node or node group on which following iterations of a job is run. Note: This feature is available only in the active environment.

NOTE
The Node ID and Node Group parameters are not available for jobs on Control-M for z/OS.

Aliases in other Control-M components

Alternate names for the Node ID/Group parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M/EM API Parameter Name NODEID

NODE_ID NODEGROUP

-nodegrp node_group

Chapter 4

Execution parameters

743

Prevent NCT2

Example: Enable Control-M/Server to determine the most suitable agent

Assuming that a node group called UNIX_group contains agent computers bill and diana. The following parameter causes Control-M/Server to determine which of the two agent computers in the group is best suited to execute the job when it is submitted for execution: Node ID/Group UNIX_group

Prevent NCT2
Performs data set cleanup before the original job run.

NOTE
For z/OS jobs only.

Format
Usage Format Optional Select one of the following from the Prevent NCT2 list box:

Blank Do not perform data set cleanup before the original job run. Default. N (No) Do not perform data set cleanup before the original job run. Y (Yes) Perform data set cleanup before the original job run. This value is not valid for started tasks. 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. F (Flush) Halt processing of the job if any data set cleanup error is detected (even if z/OS would not have stopped processing the job).

AutoEdit Support

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

744

Control-M Parameter Guide

Prevent NCT2

General information
If a job tries to create a data set that already exists, the job may fail with a DUPLICATE DATA SET 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:

Deletes and uncatalogs the old data sets. This prevents DUPLICATE DATSET ON VOLUME and NOT CATLGD 2 errors. Performs Generation Dataset (GDG) Adjustment, which is described in the Control-M/Restart User Manual.

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 parameter NCT2 in member CTRPARM determines whether data set cleanup is to be performed before the original job run. 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:

When N is specified, No special action is taken by Control-M/Restart. Data set cleanup is not performed. When 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. When 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.

Chapter 4

Execution parameters

745

Prevent NCT2

When F is specified, If a file catalog error is detected, processing is halted (even if normal z/OS processing would not handle the problems as a fatal error) and an appropriate error message is generated.

NOTE
If you would normally specify N (that is, Control-M/Restart processing is not desired for the original run), but the JCL requires GDG processing, BMC Software recommends that you specify value L instead of value N.

If a value of Y, L, or F 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.

Aliases in other Control-M components

Alternate names for the Prevent NCT2 parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name PREVENTNCT2 PREVENT NCT2 PREVENT-NCT2 prevent_nct2

Alternate formats for other Control-M components

Alternate formats for the Prevent NCT2 parameter are listed below.
Component Control-M/EM Utilities Format Valid values: 0 - No. Does not prevent data set cleanup. 1 - Yes. Prevents data set cleanup. Example <PREVENTNCT2=1/>

746

Control-M Parameter Guide

Prevent NCT2

Component Control-M for z/OS

Format PREVENT-NCT2 is composed of two parameters: PREVENT-NCT2 Valid values: N - No Y - Yes L - List F - Flush These values are described in Format on page 744. Protected field indicating the PREVENT-NCT2 default value for the Control-M for z/OS 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.

DFLT

Example: Prevent NOT CATLGD 2 errors for job PRDKPL01

JOB: PRDKPL01 LIB CTM.PROD.SCHEDULE TABLE: PRODKPL COMMAND ===> SCROLL===> CRSR +----------------------------------------------------------------------------+ MEMNAME PRDKPL01 MEMLIB CTM.PROD.JCL OWNER SYS1 TASKTYPE JOB PREVENT-NCT2 Y DFLT N APPL KPL GROUP PROD-KPL DESC DAILY PRODUCTION - START OF APPL-PROD-KPL OVERLIB SET VAR CTB STEP AT NAME TYPE DOCMEM PRDKPL01 DOCLIB 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 SHIFT RETRO Y MAXWAIT 00 D-CAT MINIMUM PDS ==================================================================== ======= IN START-DAILY-PROD-KPL ODAT CONTROL DB2-MAIN-FILE E RESOURCE INIT 0001 CARTRIDGE 0001 COMMANDS: EDIT, DOC, PLAN, JOBSTAT 11.17.00

Chapter 4

Execution parameters

747

Priority

Priority
Indicates Control-M job priority.
Usage Format Default Case Sensitive Invalid Characters AutoEdit Support Optional 2 alphanumeric characters Blank, which is the lowest priority No. Single quotation marks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
Priority determines the order of job processing by Control-M in the Active Jobs file.

Priority order is such that 9 > 0 > Z > A. The characters are not case sensitive. The value for the priority parameter is a 2-character string. AA is the lowest priority. 99 is the highest. If a single character is specified, the uppercase letter A is automatically inserted as the first character. For example, priority 1 is treated as priority A1. The next line shows priority values from the lowest (on the left) to the highest (on the right): AA-A9 ... ZA-Z9, 0A-0Z, 01-09, 1A-19 ... 9A-99

If a job that is waiting to be submitted because Quantitative resources are not available, has a higher priority than a job that has all the Quantitative resources available, the lower priority job is submitted. However, by defining a job as critical, the user can force Control-M to reserve resources for the job, thus assuring that it is submitted as soon as possible (for additional details, see Critical on page 721.). Consult authorities at your installation for information about your priority usage standards. For z/OS computers 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. If the first character of Priority in z/OS jobs is set to * (Asterisk), the job is marked as a critical path job. There is no relationship between the Critical parameter and the Priority parameter.

748

Control-M Parameter Guide

Priority

Aliases in other Control-M components

Alternate names for the Priority parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Utilities Control-M/EM API Parameter Name PRIORITY PRIORITY -priority PRIORITY priority

Example
The priority level of the job named RNDIN001 is 08; the priority level of the job named RNDIN002 is 04. Each job requires 60% of the CPU.
Mem Name Quantitative Resources Priority Mem Name Quantitative Resources Priority RNDIN001 CPU 60 08 RNDIN002 CPU 04 60

The two jobs cannot run simultaneously. Therefore, the job named RNDIN001 is submitted first because it has a higher priority.

Chapter 4

Execution parameters

749

Request NJE Node

Request NJE Node

Specifies the node in the JES network on which the job is to execute.

NOTE
This field is relevant only for z/OS jobs.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Optional 1-8 characters No Blanks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Request NJE Node parameter is used to specify the node in the JES network on which the job is to execute. If a value is specified for the Request 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.

NOTE
If a value is specified for the Request NJE Node parameter, it does not override any node name 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 Request NJE parameter generates the following JCL statement:
/*ROUTE XEQ node_name

750

Control-M Parameter Guide

Request NJE Node

Under JES3
If Control-M is running under JES3, the JCL statement generated by the Request NJE parameter differs slightly, taking the following form:
//*ROUTE XEQ node_name

Aliases in other Control-M components

Alternate names for the Request NJE Node parameter are listed below.
Component Control-M for z/OS Control-M/EM API Parameter Name NJE NODE request_nje

Example1: Under JES2

The following values are entered to the job processing definition:
DESC OVERLIB SCHENV SYSTEM ID NJE NODE OS35

The following statement is added to the JCL of the job:

/*ROUTE XEQ OS35

The job is executed at node OS35.

Chapter 4

Execution parameters

751

Request NJE Node

Example 2: Under JES3

The following values are entered to the job processing definition:
DESC OVERLIB SCHENV SYSTEM ID NJE NODE OS35

The following statement is added to the JCL of the job:

//*ROUTE XEQ OS35

The job is executed at node OS35.

752

Control-M Parameter Guide

Rerun From

Rerun From
Indicates whether the interval between runs of a cyclic job or until the start of a rerun job is measured from the start or the end of the previous job run. Table 161 Format - Rerun From Parameter
Usage Format Optional List box Valid values: Start (Default) End Target No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Invalid Characters Non-English characters AutoEdit Support

General information
The interval between job runs is specified in the Interval parameter.

When the value of Rerun From is Start, the time until the next job run is counted from the moment that the current job run begins. When the value of Rerun From is End, the time until the next job run is counted from the moment that the current job run is complete. When the value of Rerun From is Target, the interval is measured from the scheduling time of the current job run.

Aliases in other Control-M components

Alternate names for the Rerun From parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M/EM API count_cyclic_from Parameter Name IND_CYCLIC IND CYCLIC -intervalfrom (Default value: START)

Chapter 4

Execution parameters

753

Rerun From

Example 1: Calculate the interval between cyclic jobs when Rerun From is Start
Job_A is a cyclic job. The value specified for Interval is 60 seconds. The Rerun From value is Start. If Job_A job run takes 15 seconds, the next run of Job_A begins 45 seconds after the first run is complete.

Example 2: Calculate the interval between cyclic jobs when Rerun From is End
Job_B is a cyclic job. The value specified for Interval is 60 seconds. The Rerun From value is End. When the Job_B job run is complete, the next run of Job_B begins 60 seconds after the first run is complete. The length of time that it takes to run Job_B does not affect the period of time between job runs.

754

Control-M Parameter Guide

Rerun Member

Rerun Member
Name of the JCL member to use when the job is automatically rerun.

NOTE
This field is relevant only for z/OS jobs.

Format

Usage Length Case Sensitive Invalid Characters AutoEdit Support

Optional. 1-8 characters Yes Blanks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Do Forcejob Do If Rerun The Do Forcejob parameter is a more flexible alternative to the Rerun Member parameter. Control-M/Restart users can restart a failed job using the Do If Rerun parameter instead of Rerun Member. Do If Rerun and Rerun Member cannot be specified together. When specified, the Rerun Member value overrides the Mem Name value.

File Name/Mem Name

General information
Although the Rerun Member parameter can be used to specify the name of a JCL member to use for automatic rerun, note the following points:

The Do Forcejob parameter provides a more flexible alternative to the Rerun Member parameter. Control-M/Restart users can use the Do If Rerun parameter to restart the failed job instead of using the Rerun Member parameter to rerun the job.

Chapter 4

Execution parameters

755

Rerun Member

The automatic rerun process works as follows:

Control-M determines that automatic rerun is possible only if the job ends NOTOK and a specified Do Rerun statement is activated during post-processing. If Control-M determines that automatic rerun is possible, it sets the jobs status to ended NOTOK RERUN NEEDED. Control-M 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. The JCL for the rerun job is taken from the member specified in the Rerun Member parameter. If no Rerun Member value is specified, the JCL for the rerun is taken from the jobs regular JCL member specified in the Mem Name parameter.

Rerun Member has additional characteristics:

The member name can be the same as, or different from, the job name. The member specified in the Rerun Member parameter must be in the library specified in the Mem Lib parameter. The Rerun Member parameter overrides the Mem Name parameter value in the JCL, and the Mem Name parameter value becomes irrelevant for reruns.

Availability

This parameter is relevant only for z/OS jobs. The Do If Rerun and Rerun Member parameters cannot be specified together. The Rerun Member parameter cannot be specified for cyclic jobs and cyclic started tasks.

756

Control-M Parameter Guide

Rerun Member

Aliases in other Control-M components

Alternate names for the Rerun Member parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Utilities Control-M/EM API Parameter Name RERUNMEM RERUN MEM RERUNMEM rerun_member

Chapter 4

Execution parameters

757

Scheduling Environment

Scheduling Environment
Indicates the JES2 workload management scheduling environment that is to be associated with the job.

NOTE
This field is relevant only for z/OS jobs.

Format
Usage Length Case Sensitive Invalid Characters AutoEdit Support Optional 1 through 16 characters Yes Blanks; non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The Scheduling Environment parameter can only be used when Control-M is running under JES2. If Control-M is running under JES3, any value specified for the Scheduling Environment parameter is ignored. If a value is specified for the Scheduling Environment parameter, the JCL job statement is modified by the addition of a statement in the following form:
// SCHENV=schedule_environment

NOTE
If a value is specified for the Scheduling Environment parameter, it does not override any scheduling environment specified in the job statement unless the OVERJCLM parameter in the CTMPARM library is set to Y.

758

Control-M Parameter Guide

Scheduling Environment

Aliases in other Control-M components

Alternate names for the Scheduling Environment parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name SCHEDULING_ENVIRONMENT SCHEDULE ENV SCHENV schedule_environment

Example: Specifying a scheduling environment

If the scheduling environment of job ACCT01 is to be SCHD2, specify the following:
DESC OVERLIB SCHENV SCHD2 SYSTEM ID NJE NODE

The job statement is modified as follows:

//ACCT01 JOB ,PROD1,CLASS=A,MSGCLASS=X, // MSGLEVEL=(1,1), // SCHENV=SCHD2

Chapter 4

Execution parameters

759

System Affinity

System Affinity
Indicates the identity of the system in which the job must be initiated and executed (in JES2). Indicates the identity of the processor on which the job must execute (in JES3).

NOTE
This field is relevant only for z/OS jobs.

Format
Usage Length Optional 1-5 alpha-numeric characters The alpha-numeric characters can be proceeded by a /. / as a first character indicates NOT in JES3. Case Sensitive No Invalid Characters AutoEdit Support Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

General information
The System Affinity parameter has different effects, depending on which release of JES is in use.

NOTE
If a value is specified for the System Affinity parameter, it does 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 Affinity parameter is used to specify the JES2 system on which the job is to be initiated and executed.

760

Control-M Parameter Guide

System Affinity

If a value is specified for the System Affinity parameter, the following JCL statement is generated:
/*JOBPARM SYSAFF=sys_id

Under JES3
If Control-M is running under JES3, the System Affinity parameter is used to specify the JES3 processor that is to execute the job. If a value is specified for the System Affinity parameter, the following JCL statement is generated:
//*MAIN SYSTEM=processor_id

Aliases in other Control-M components

Alternate names for the System Affinity parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name SYSTEM_AFFINITY SYS AFFINITY SYSTEM ID system_affinity

Example1: Under JES2

The following values are entered to the job processing definition:
DESC OVERLIB SCHENV SYSTEM ID SYS3 NJE NODE

The following statement is added to the JCL of the job:

/*JOBPARM SYSAFF=SYS3

The job is executed on the JES2 system SYS3.

Example2: Under JES3

The following values are entered to the job processing definition:

Chapter 4

Execution parameters

761

System Affinity

DESC OVERLIB SCHENV SYSTEM ID PRC3 NJE NODE

The following statement is added to the JCL of the job:

//*MAIN SYSTEM=PRC3

The job is executed on processor PRC3.

762

Control-M Parameter Guide

Time From, Time Until

Time From, Time Until

Sets time limits (From and Until) for submitting the job.

Format
Usage Format Optional If not left blank, the From and Until subparameters must contain valid times expressed in 24-hour format (hh:mm). By default, valid times are from 00:00 through 23:59. However, if Time Synonym (in Tools/Options) is checked, valid times are from New Day time until New Day Time plus 23:59. For example, if New Day time is 8:00 A.M., the range of valid times is from 08:00 until 31:59. Alternatively, if From contains a valid time value, Until can contain the > character. For more information, see below. The From value can be specified without an Until value. The opposite is also true. AutoEdit Support No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameter
+ num days is an optional subparameter, valid only for Control-M for z/OS version 6.2.xx, that enables you to set a range of days after the original scheduling date of the job during which the job can be submitted. From + num days defines the beginning of the range and Until + num days defines the end of the range, where the variable num is a number of days after the Odate (original scheduling date) of the job. Valid values for num are any number from 1 through 120.

Defining a From + num days value makes the job eligible for submission anytime after num days following the Odate. Defining an Until + num days value makes num days after the Odate the last date on which the job is eligible for submission.

If values are set for the From + num days subparameter, or the Until + num days subparameter, or both, but no value is set for the related Time From or Time Until parameters, Control-M uses the New Day time on the relevant day as the default. For more information on the use of this subparameter, see the information and examples below.

Chapter 4

Execution parameters

763

Time From, Time Until

General information
Control-M submits the job only during the time range defined in the Time parameter. The job is only submitted from (but not before) the time specified by the From parameter time and before the Until time. Control-M ignores seconds when determining the time range. For example, a job with a time range of 20:00 to 21:00 could be submitted at 21:00:58. If you do not set a value for either the From parameter or Until parameter, the default is the New Day time (the start time of the new work day) as specified in Control-M system parameters.

NOTE
Operation of Control-M is suspended while the New Day procedure in running. If a job is limited by the From and Until parameters to the time that the New Day procedure is running, the job is never ordered.

If the From field contains a valid time value, you can enter a > character in the Until field. This character is used to indicate that once the From time has passed, if Control-M has not yet submitted the job by New Day time, it should try to submit the job as soon as possible after the New Day procedure is run (without waiting for the From time to arrive again). Control-M continues to ignore the From time either until the job is submitted or until the Max Wait period expires. If identical values are specified for the From and Until parameters, the job is scheduled immediately (regardless of the specified time value). For example, if the value of From is 0900 and that of Until is 0900, and the job is ordered at 0700, the job is submitted for execution at 0700. Batch jobs are frequently scheduled for submission overnight. Therefore, if the times set for the From and Until parameters in a job are such that the New Day procedure processing time intervenes between these times, Control-M treats the job as eligible for submission during both the following periods:

between the From time and the New Day procedure processing time between the New Day procedure processing time and the Until time

You can set a value for num in From + num days without setting a value for num in Until + num days. The effect is that the job cannot be executed before the date and time specified in the From fields, but can be executed at any time on any day thereafter. Do not set a value for num in Until + num days that is smaller than the value set for num in From + num days. If you do, the job is never executed.

764

Control-M Parameter Guide

Time From, Time Until

Aliases in other Control-M components

Alternate names for the Time From and Time Until parameters are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Utilities Control-M/EM API Parameter Name TIMEFROM, TIMETO FROM TIME, TO TIME -timefrom, -timeuntil TIME FROM, TIME UNTIL time_from time_until

Examples Example 1
Submit the job between 9 A.M. and 6 P.M. Time From 09:00 + days Until 18:00 + days

Example 2
Submit the job at any time after 6 P.M. Time From 18:00 + days Until > + days

In this example, the job can be submitted at any time after 6 P.M. on the day of submission. If the job has not yet been submitted when the New Day time at the site arrives, it is submitted as soon as possible, even at a later date, until the period set by the MAXWAIT parameter expires.

Example 3
The New Day time at the site is 6:00 A.M. Submit the job after the New Day time, but no later than 7:30 A.M. Time From + days Until 07:30 + days

In this example, the job can only be submitted between 6:00 A.M. and 7:30 A.M. If the job is still on the Active Jobs file on the following day, it will again be submitted between 6:00 A.M. and 7:30 A.M. on that day.

Chapter 4

Execution parameters

765

Time From, Time Until

Example 4
The New Day time at the site is 6:00 A.M. Submit the job at any time between midnight and the New Day time. Time From 00:00 + days Until + days

In this example, the job can only be submitted between midnight and 6:00 A.M.

Example 5
The New Day time at the site is 1:00 A.M. Submit the job at any time between 11:00 P.M. and 6:00 A.M. Time From 23:00 + days Until 06:00 + days

In this example, the job is eligible for submission between 11:00 P.M. and 1:00 A.M., and between 1:00 A.M. and 6:00 A.M.

Example 6
The New Day time at the site is 1:00 A.M. and the Odate is September 6. Submit the job at any time between 11:00 P.M. on September 9, and 6:00 A.M. on the sixth day after the Odate of the job Time From 23:00 + 003 days Until 06:00 + 006 days

Example 7
The New Day time at the site is 1:00 A.M. Submit the job at any time between 11:00 P.M. on the third day after the Odate of the job, and the New Day time on the sixth day after the Odate of the job Time From 23:00 + 003 days Until + 006 days

In this example, the job is eligible for submission between 11:00 P.M. on the third day after the Odate of the job and 1:00 A.M. on the sixth day after the Odate of the job.

766

Control-M Parameter Guide

Time From, Time Until

Example 8
The New Day time at the site is 1:00 A.M. Submit the job at any time between 11:00 P.M. on the third day after the Odate of the job, and 1:00 A.M. on the sixth day after the Odate of the job Time From + 003 days Until 06:00 + 006 days

In this example, the job is eligible for submission between 1:00 A.M. on the third day after the Odate of the job and 6:00 A.M. on the sixth day after the Odate of the job.

Example 9
The New Day time at the site is 1:00 A.M. Submit the job at any time between 1:00 A.M. on the third day after the Odate of the job, and 1:00 A.M. on the sixth day after the Odate of the job Time From + 003 days Until + 006 days

In this example, the job is eligible for submission at any time between 1:00 A.M. on the third day after the Odate of the job and 1 A.M. at the end of the sixth working day after the Odate of the job.

Example 10
The New Day time at the site is 8:00 A.M., and the Time synonym option in Tools/Options is checked. Submit the job at any time from one hour after the start of the New Day until one hour before the next New Day. Time From 09:00 + days Until 31:00 + days

In this example, the job is eligible for submission between 9:00 A.M. until 7:00 A.M. the next morning. Because the Time Synonym option is checked, 7:00 A.M. the next morning is indicated as the sum of (24:00 + 7:00) = 31:00.

Chapter 4

Execution parameters

767

Units

Units
Specifies a unit of time for the numerical value indicated by the Interval parameter.

Format
Usage Format Mandatory when a value is specified for the Interval parameter List box Valid values: Minutes (Default) Hours Days Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Invalid Characters AutoEdit Support

Related parameters
Cyclic Interval Values must be specified for the Interval and Units parameters when a job is cyclic. A value must be specified for Units when Interval is specified.

General information
The Units parameter indicates the unit of measure in which the numerical value of the Interval parameter is expressed. This parameter is used together with the Interval parameter.

Aliases in other Control-M components

Alternate names for the Units parameter are listed below.
Component Parameter Name

Control-M/Server Utilities The Units value is contained in the -interval parameter.

Alternate formats for other Control-M components

Alternate formats for the Units parameter are listed below.

768

Control-M Parameter Guide

Units

Component Control-M/Server Utilities

Parameter Name Valid values: d - Days h - Hours m - Minutes (Default) Format: <interval_amount><unit> Example for 24 hours: 24h

Chapter 4

Execution parameters

769

Units

770

Control-M Parameter Guide

Chapter

Condition parameters
The parameters in this section enable you to create dependencies between jobs in your network. Table 162 Conditions parameters
Parameter In Condition Out Condition Description Prerequisite conditions required for a job to execute. Prerequisite conditions to be added or deleted after the job completes with a completion status of OK.

Chapter 5 Condition parameters

771

In Condition

In Condition
Specifies prerequisite conditions that must be satisfied before the job is submitted for execution.

Format
Usage Format AutoEdit Support Optional The In Condition parameter is composed of the Name, Date, and And/Or subparameters. These subparameters are described below. Yes. AutoEdit system variables (but not other types of AutoEdit variables) can be specified as the entire value for this parameter.

Subparameters
Parameter Name Description Name of the In Condition. Note: Beginning with version 6.1.03, the square bracket characters [ and ] can be used in Condition names. Length Condition names for Control-M versions prior to 6.0.01 can be from 1 through 20 characters. Condition names for Control-M version 6.0.0x can be from 1 through 39 characters. Condition names for Control-M version 6.1.0.x can be from 1 through 255 characters. (z/OS: Not more than 39 characters) Note: Conditions with long names are not passed to earlier versions of Control-M.

Case sensitive

Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters. Computers other than z/OS: Blanks; single quotation marks; ) and ( (parentheses); | (pipe) z/OS: Blanks; ) and ( (parentheses); | (pipe)

Invalid Characters

772

Control-M Parameter Guide

In Condition

Parameter Date

Description A 4-character date reference associated with the condition. date offset A 4-digit date reference in the format mmdd or ddmm, depends on the site standard. For Control-M for z/OS as from version 6.2.00 only: + or - followed by a number from 0 through 999, indicating the number of days in the future (+), or in the past (-), relative to the actual order date. Variable that is automatically replaced by the jobs original scheduling date (that is, the date on which the job was ordered). Note: Beginning with version 6.1.03 of ControlM/EM and Control-M/Server, ODAT can also be specified when modifying details of a job in the Active Jobs file. PREV Variable that is automatically replaced by the jobs previous scheduling date. Note: PREV cannot be specified when modifying details of a job in the Active Jobs file. **** (or $$$$) Any scheduling date. The Condition parameter is satisfied if any prerequisite condition with the same name exists, regardless of its associated date. Condition is not date-dependent. Note: This value is valid only for Control-M/Server version 6.0.01 and later or for Control-M for z/OS.

ODAT

STAT

And/Or

List box, used to specify the logical relationship between In Conditions. If more than one Condition parameter is specified, an And/Or parameter must be specified for each Condition parameter. Parentheses are used to isolate groups of In Conditions in a longer list of conditions to indicate logical relationships that are resolved before the entire condition statement is resolved. For more information, see Logical relationships between conditions on page 774. Notes: Pairs of parentheses cannot be nested. blank ( ) A( O( Indicates no special relationship between the current and following condition. Beginning of a comparison between successive conditions. End of a comparison between successive conditions. Indicates a logical AND between two IN conditions. Indicates a logical OR between two IN conditions.

Parentheses

General information
The In Conditions parameter makes the submission of the job dependent on the existence of one or more prerequisite conditions.

Chapter 5 Condition parameters

773

In Condition

NOTE
A maximum of 99 prerequisite conditions can be specified for the In Condition parameter.

Logical relationships between conditions

The logical relationship (And/Or) used when two or more prerequisite conditions are specified determines whether all or only some of the prerequisite conditions must exist in order for the job to be submitted.

Expressions in parentheses are resolved first. Pairs of parentheses cannot be nested. AND operations are resolved prior to the resolution of OR operations. AND conditions do not need to be grouped together before OR conditions.

For a detailed explanation of prerequisite conditions, see Out Condition on page 780.

Time stamp
Inserting the @HHMMSS code into an In condition name includes a time stamp (in hours, minutes, and seconds) that is resolved to the time that the job is entered in the Active Jobs file.

Future and past dates

You can use the Days Offset field to set a future or past date for an In condition. Valid values for this field are a + (plus) or - (minus) sign, followed by a number from 0 through 999. The value in the field represents the number of days in the future, or in the past, relative to the actual order date.

Aliases in other Control-M components

Alternate names for the In Condition parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M/EM API Control-M for z/OS Parameter name INCOND CONDITION -incond in_condition IN

774

Control-M Parameter Guide

In Condition

Alternate formats in other Control-M components

Alternate formats for the In Condition parameter are listed below.
Component Control-M/EM Utilities Format INCOND is composed of the NAME. ODATE, AND_OR, and OP subparameters. The OP value is a right or left parenthesis. Used to isolate portions of the In condition expression. Example <INCOND NAME=Cond1 ODATE=ODAT AND_OR=AND OP=)> Condition name. Each specified prerequisite condition consists of the mandatory cond_name and dateref subparameters.

Control-M/EM Utilities continued Reporting Facility Control-M for z/OS

Example 1: Schedule a job that depends on the successful completion of another job
Schedule JOB_B to execute after the successful completion of JOB_A (regardless on what day JOB_A was run):
Job Name Out Conditions Job Name In Conditions JOB_A JOB_A_OK JOB_B JOB_A_OK

Date Date

ODAT ****

If JOB_A completes with a termination status of OK, prerequisite condition JOB_A_OK is created (with JOB_As original scheduling date). JOB_B, that is waiting for prerequisite condition JOB_A_OK, is submitted for execution as soon as the prerequisite condition is created.

Example 2: Daily jobs

JOB_A and JOB_B are daily jobs. JOB_B should be submitted only after the successful completion of JOB_A. JOB_B must not be mistakenly submitted based on the successful completion of JOB_A from a previous day.
Job Name Out Conditions Job Name In Conditions JOB_A JOB_A_OK Date ODAT JOB_B JOB_A_OK Date ODAT

Assuming that the scheduling date is May 5:

Chapter 5 Condition parameters

775

In Condition

If JOB_A completes with a termination status of OK, prerequisite condition JOB_A_OK is created (with the date 0505). JOB_B, that is waiting for prerequisite condition JOB_A_OK with date 0505, is submitted for execution as soon as the prerequisite condition is created. The In Conditions parameter of JOB_B is not satisfied by the JOB_A_OK condition with a date of 0504 (created the previous day).

Example 3: Schedule a job that depends on the completion of multiple jobs

Schedule the job that produces the salary statistics report for top management after the set of jobs that calculates the salaries ends OK:
Mem Name EBDRPT1A Days 01,15 In Conditions SALARY-OK

When the set of jobs that calculates the salaries ends OK, it creates 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 its prerequisite condition SALARY-OK exists (signifying that the 15ths salary job ended OK). The existence of the prerequisite condition for the 1st SALARY-OK does not enable the submission of the report for the 15th. The report for the 1st does not necessarily run on the 1st of the month. Suppose the salary jobs only finish executing on the 3rd; only then is the prerequisite condition SALARY-OK for the 1st created. This is because the prerequisite condition is always associated with a scheduling date, and not with the actual running date. Therefore, a date reference should be added to the condition:
Mem Name EBDRPT1A Days 01,15 In Conditions SALARY-OK

Date ODAT

Example 4: Job scheduling that depends on previous job runs and a generic date reference
Consider a similar example: a monthly total report must be produced based on data from the last two runs. Also, the job must run when communication channels to a remote site are active:
Days 01,15 Retro Y Max Wait 06 In Conditions SALARY-OK Date: ODAT And/Or: A

776

Control-M Parameter Guide

In Condition

SALARY-OK Date: PREV And/Or: A COMM-ACTIVE Date: **** And/Or: A

The job is submitted only if the jobs for the 1st and the 15th have finished. Prerequisite condition COMM-ACTIVE is based on a generic date reference that exists only when communication is active. The communication process itself can be monitored by Control-M. When communication is not active, Control-M deletes prerequisite condition COMMACTIVE, preventing abends of jobs that depend on active communication.

Example 5: Maintain order of job runs

Assume a group of jobs runs every day of the week, except Saturday and Sunday. It is very important that some of the jobs scheduled for the various days of the week do not run in parallel. The order of these jobs must be maintained even in cases of delays:
Week Days 2,3,4,5,6 Retro Y Max Wait 8 In Conditions DEPOSITS Date: PREV

The job is submitted only if the prerequisite condition DEPOSITS of the previous scheduling date exists. The prerequisite condition DEPOSITS is created only after the group of jobs called DEPOSITS finishes.

Example 6: Job scheduling that depends on site conditions

Suppose a Database master data set exists, and that it is accessed by many programs. Unfortunately, the contents of the Database are often destroyed or damaged because of bugs in old programs. When, and if, it is discovered that the contents of the Database are corrupted, submission of all the jobs that access the file must be prevented:
Dates 0201, 0403, 1101 Retro Y Max Wait 06 In Conditions MASTER-FILE-OK Date: ****

It has been discovered that the Database contents are indeed bad. At this point, prerequisite condition MASTER-FILE-OK must be deleted, either manually from Control-M/EM, or automatically by the job or process that made the discovery. When the Database is restored to its normal state, the prerequisite condition is added again and execution proceeds as planned.

Chapter 5 Condition parameters

777

In Condition

Example 7: Job scheduling when a failure has occurred

A detached process, LOGCLOSE, is to begin whenever a certain communication process crashes because of a boot operation, or as a result of an operators cancellation:
Retro Y Max Wait 0 In Conditions COMM-CANCELED Date: ****

The detached process LOGCLOSE starts executing whenever prerequisite condition COMM-CANCELED is active. The prerequisite condition is added by Control-M when the communication process is canceled by an operator or after a computer crash.

Example 8: Date reference

The following example provides a further explanation of the concept of the scheduling date reference:
Mem Name EBDRPT6D 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 In Conditions EBD-REPORTS-READY Date: ****

Today is the 15th of September. The date reference values resolved in this job are written in mmdd date format:
ODAT 0915 PREV 0901 **** Any date reference

Example 9: Condition including terms isolated with parentheses

ctmcreate -tasktype command -cmdline ls -jobname cond_600 -incond cond_21 ODAT AND -incond '('cond_22 ODAT OR -incond cond_23')' ODAT AND -incond cond_24 ODAT OR

Example 10: Out condition name including a time stamp

ctmdefine -tasktype command -cmdline date -application app -group grp -table time_cond -days ALL -month ALL Y -outcond a@HHMMSS ODAT ADD jobname counter -memname counter

The resulting Out condition statement:

778

Control-M Parameter Guide

In Condition

*CONDITION a101028

0113 ADDED

Chapter 5 Condition parameters

779

Out Condition

Out Condition
Specifies prerequisite conditions to be added or deleted after the job completes with a completion status of OK.

Format
Usage Format AutoEdit Support Optional The Out Condition parameter is composed of the Name, Date, and Sign subparameters. These subparameters are described below. Yes. AutoEdit system variables (but not other types of AutoEdit variables) can be specified as the entire value for this parameter.

Subparameters
Parameter Name Description Name of the Out Condition. Note: Beginning with version 6.1.03, the square bracket characters [ and ] can be used in Condition names. Length

Condition names for Control-M versions prior to 6.0.01 can be from 1 through 20 characters. Condition names for Control-M version 6.0.0x can be from 1through 39 characters. Condition names for Control-M version 6.1.0.x can be from 1 through 255 characters. (z/OS: Not more than 39 characters)

Note: Conditions with long names are not passed to earlier versions of Control-M. Case sensitive Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters. Invalid Characters Computers other than z/OS: Blanks; single quotation marks; ) and ( (parentheses); | (pipe) z/OS: Blanks; ) and ( (parentheses); | (pipe)

780

Control-M Parameter Guide

Out Condition

Parameter Date

Description A four-character date reference associated with the condition. date offset A 4-digit date reference in the mmdd or ddmm format, depending on the site standard. For Control-M for z/OS from version 6.2.00: + or - followed by a number from 0 through 999, indicating the number of days in the future (+), or in the past (-), relative to the actual order date. Variable that is automatically replaced by the jobs original scheduling date (that is, the date on which the job was ordered). Note: Beginning with version 6.1.03 of Control-M/EM and Control-M/Server, ODAT can also be specified when modifying details of a job in the Active Jobs file. PREV Variable that is automatically replaced by the jobs previous scheduling date. Note: PREV cannot be specified when modifying details of a job in the Active Jobs file. NEXT Variable that is automatically replaced by the jobs next scheduling date. Note: NEXT cannot be specified when modifying details of a job in the Active Jobs file. **** (or $$$$) Any scheduling date. The Condition parameter is satisfied if any prerequisite condition with the same name exists, regardless of its associated date. Condition is not date-dependent. Note: This value is valid only for Control-M/Server version 6.0.01 and later or for Control-M for z/OS.

ODAT.

STAT

Sign

Indicates whether the specified condition is to be added (created) or deleted. + Adds (creates) the prerequisite condition. Default. Deletes the prerequisite condition. If the value of ODAT is $$$$ or ****, + cannot be selected.

General information
The In Conditions parameter makes the submission of the job dependent on the existence of one or more prerequisite conditions.

NOTE
A maximum of 99 prerequisite conditions can be specified for the Out Conditions parameter.

Chapter 5 Condition parameters

781

Out Condition

If the job completion status is OK, then, according to the option specified, the prerequisite conditions are added to or deleted from the Conditions/Resources table.The Out Conditions parameter is performed before the Do Cond parameter. Therefore, the Out Conditions parameter can be overridden by those of the Do Cond parameter. For examples, see Do Cond on page 801.

Prerequisite conditions
A prerequisite condition is a user-defined entity whose existence can be tested to determine whether a job should be submitted for execution. You can specify that a prerequisite condition be added (that is, created) or deleted as part of the post-processing treatment of a job (using the Out Condition parameter and the Do Cond parameter). A prerequisite condition can also be added or deleted manually by the operator using the Prerequisite Conditions window. Prerequisite conditions are used to define and implement job execution dependencies. A job containing an In Condition definition is not submitted for execution unless the specified In conditions exist. This permits job-to-job dependencies or job dependencies based on successful completion of a manual task (such as a file creation or a restore operation). When created, each prerequisite condition is associated with a specific date. A date is also specified when testing for the existence of a prerequisite condition. Thus, the submission of a job can be made contingent upon the existence of a prerequisite condition created on a specific date. This enables you to specify jobs, for example, that depend on conditions created on the same day and that ignore conditions created on previous days. A prerequisite condition can represent any user-specified situation. The following represent the kind of self-explanatory conditions for which a job may need to test:
JOB-EJGH12-FINISHED SALARY-INPUT-READY CHECKS-PUNCHED WEEKEND COMM-ACTIVE

Time stamp
Inserting the @HHMMSS code into an Out condition name includes a time stamp (in hours, minutes, and seconds) that is resolved to the time that the job is entered in the Active Jobs file.

782

Control-M Parameter Guide

Out Condition

Future and past dates

You can use the Days Offset field to set a future or past date for an Out condition. Valid values for this field are a + (plus) or - (minus) sign, followed by a number from 0 through 999. The value in the field represents the number of days in the future, or in the past, relative to the actual order date.

Aliases in other Control-M components

Alternate names for the Out Condition parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Utilities Control-M for z/OS Utilities Control-M/EM API Parameter Name OUTCOND CONDITION -outcond OUT out_condition

Examples
For examples of prerequisite conditions, see In Condition on page 772.

Chapter 5 Condition parameters

783

Out Condition

784

Control-M Parameter Guide

Chapter

Resource parameters
The parameters in this section specify the resources that must be available before a job can be run. Table 163 Resource parameters
Parameter Control Resources Quantitative Resources Description List of resources and type of usage (exclusive or shared) required. List of Quantitative resources required by the job, and the quantity of each resource.

Chapter 6 Resource parameters

785

Control Resources

Control Resources
Indicates the resources required by the job during execution and the type of control (shared or exclusive) the job requires over each resource.

Format
Usage Optional Note: A maximum of 99 Control Resources can be specified for a job. Length Case Sensitive 1-64 characters Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters. Invalid Characters AutoEdit Support

Blanks Computers other than z/OS: Single quotation marks

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameters
Name Name of the Control resource. The following special suffixes can be appended to the specified resource name:

$ represents any single character. For example, TAPE$ can represent TAPE1 or TAPE2. However, if the job requires two TAPE$ units, it can only use two TAPE1 units or two TAPE2 units, not one of each. (The $ can only assume value 1 or 2 for the job; it cannot represent both.) @ identifies a Quantitative resource used for load balancing. From 1 through 64 characters Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters.

Length Case Sensitive

Invalid Characters

Blanks; single quotation marks.

786

Control-M Parameter Guide

Control Resources

Control

Valid values are:

Shared Exclusive

On Fail

Whether to keep a Control resource tied to a job if the job does not end OK. Valid values are:

Keep The resource is kept tied to the job until one of the following occurs: the job ends OK the job is deleted the job is forced OK Release The resource is not kept tied to the job. This is the default.

General information
The Control resource parameter is used to control parallel execution of jobs. Control resources are defined using the Control-M/EM Control Resources window. If a job requires exclusive use of a Control resource, only that job can use the Control resource. If another job requests the same resource in exclusive or shared state, this second job is not submitted by Control-M until the resource is released by the first job. If a job requires a Control resource in shared state, that job can run in parallel with other jobs that request the same resource in shared state.

Aliases for other Control-M components

Alternate names for the Control Resource parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name CONTROL RESOURCE -control CONTROL control_resource

Chapter 6 Resource parameters

787

Control Resources

Alternate formats for other Control-M components

Alternate format Approved.s for the Control Resource parameter are listed below.
Component Format

Reporting Facility The Control Resource parameter is composed of the subparameters below. RESOURCE TYPE Name of the resource. String. Type of Control resource: E - Exclusively owned by a job S - Shared by any number of jobs

Example 1: Scheduling a job using an exclusive resource

Job R1 (which reorganizes a disk) cannot run in parallel with job B1 (which backs up the same disk) or job B2 (which reads data from the disk). Jobs B1 and B2 do not interfere with each other and can be executed in parallel. Job R1 is defined as follows:
Mem Name = R1 Control Resources: VS01 = E

Job B1 is defined as follows:

Mem Name: B1 Control Resources: VS01 = S

Job B2 is defined as follows:

Mem Name: B2 Control Resources = VS01 = S

Jobs B1 and B2 can run simultaneously since they both use resource VS01 in shared mode. Job R1 requests VS01 for exclusive use and therefore cannot run in parallel with either job B1 or B2.

If either job B1 or B2 is running, Control-M does not submit job R1. If job R1 is running Control-M does not submit job B1 or B2.

Control-M submits job B1 if job B2 is running, and vice-versa.

788

Control-M Parameter Guide

Quantitative Resources

Quantitative Resources
Indicates the name and quantity of Quantitative resources required by the job.

Format
Usage Format Case Sensitive Optional. Each Quantitative resource is specified using the mandatory subparameters described below. Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters. Invalid Characters AutoEdit Support

Blanks Computers other than z/OS: Single quotation marks

Yes. AutoEdit system variables (but not other types of AutoEdit variables) can be specified as the entire value for this parameter.

Subparameters
Name Name of the Quantitative resource. The following special suffixes can be appended to the specified resource name:

$ represents any single character. For example, TAPE$ can represent TAPE1 or TAPE2. However, if the job requires two TAPE$ units, it can only use two TAPE1 units or two TAPE2 units, not one of each. (The $ can only assume value 1 or 2 for the job; it cannot represent both.)

@ identifies a Quantitative resource used for load balancing. From 1 through 64 characters Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters.

Length Case Sensitive

Invalid Characters Quantity

Blanks; single quotation marks.

Amount of the resource that is required. Valid values for this field are from 1 through 9999.

Chapter 6 Resource parameters

789

Quantitative Resources

On Fail

Whether to keep a Quantitative resource tied to a job if the job does not end OK. Valid values are:

Keep the resource is kept tied to the job until one of the following occurs: the job ends OK the job is deleted the job is forced OK Release the resource is not kept tied to the job. This is the default.

On OK

Whether to keep a Quantitative resource tied to a job if the job ends OK. Valid values are:

Release The resource is not kept, and is returned to the total quantity available for other jobs. This is the default. Discard The resource is not reusable, meaning that the quantity of the resource is permanently removed from the total quantity available for other jobs.

General information
When a Quantitative resource is specified for a job, Control-M determines whether a sufficient quantity of the specified resource is available before submitting the job. When the job is submitted, the specified quantity of resource is assigned to that job and is not available to other jobs. When the job finishes executing, the resource is made available to other jobs.

NOTE
A maximum of 99 Quantitative resources can be specified for a job.

The Quantitative Resources parameter is used to control the use of Quantitative resources in the installation (for example, tape drives, CPU utilization). For load balancing, Quantitative resources are used to specify the resources that must be available on the agent computer selected by Control-M to execute the job.

NOTE
Load balancing is available for certain computers with Control-M version 2.2x or later.

790

Control-M Parameter Guide

Quantitative Resources

Aliases for other Control-M components

Alternate names for the Quantitative Resource parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name QUANTITATIVE RESOURCE -quantitative RESOURCE quantitative_resource

Example 1: Specifying two tape drives

A Control-M installation has 10 tape drives available for production. A job that requires the use of two tape drives is defined with a Quantitative Resources parameter specifying the number of tape drives required:
Quantitative Resources TAPE 2

Control-M determines whether two tape drives are available. If the drives are available, and all other submission criteria for the job have been satisfied, the tape drives are allocated to the job, and the job is submitted for execution. The total number of free tape drives is now eight. When the job finishes executing, the two tape drives are returned to the pool of available resources.

Example 2: Quantitative resource requirement that cannot be fulfilled

Given the following situation:

Several jobs that require tape drives are currently executing. Only one tape drive is currently available. Job A requires two tape drives and contains the following parameter (all other submission criteria for the job have been satisfied):
2

Quantitative Resources TAPE

As long as two tape drives are not available, Job A is not submitted for execution. If another tape drive is released by a different job, or if an authorized user increases the number of existing tape drives so that two are available, Control-M submits the job for execution.

Chapter 6 Resource parameters

791

Quantitative Resources

Example 3: Defining a quantitative resource with a mask character

A Control-M installation is defined as having the following Quantitative resources: three units of TAPE1 and three units of TAPE2. A job requiring three tape drives contains the following parameter:
Quantitative Resources TAPE$ 3

The job is submitted for execution when three units of the same type are available (that is, either three units of TAPE1 or three units of TAPE2) since the mask character $ can only represent a single value for a given job.

Example 4: Defining multiple quantitative resources with mask characters

A job requires two tape drives and a printer:
Quantitative Resources TAPE$ 2 PRINT$ 1

Two units of TAPE1 and one unit of PRINT2 are available. However, the job is not submitted until a unit of PRINT1 becomes available since the mask character $ can only represent a single value for a given job. In this instance, $ represents the number 1.

Example 5: Load balancing

A job to be submitted by the load-balancing mechanism requires 10 units of the Quantitative resource CPU:
Quantitative Resources CPU@ 10

The job is submitted to an agent computer possessing at least 10 available units of the specified resource.

792

Control-M Parameter Guide

Chapter

Post-processing parameters
Post-Processing parameters are used to describe:

Actions to be performed if the job is not submitted. Actions to be performed after the job has finished executing. Handling of the jobs log (SYSOUT). Notification messages to various users. Rerun conditions.

Based on the jobs execution status codes, Control-M automatically assigns a completion status: Table 164 Job statuses
Status OK Description Job ended OK. The job finished executing with a successful operating system completion status. This status can be overridden with the Do NOTOK parameter (as a result of an On Statement/Code evaluation). Job did not end OK. The job finished executing with an unsuccessful operating system completion status or due to a submission failure (for example, queue does not exist). This status can be overridden with the Do OK parameter (as a result of an On Statement/Code evaluation).

NOTOK

For SMART Tables:

Steps parameters can also be defined for SMART Tables.

Actions to be performed if a SMART Table finished OK are performed only if all the jobs in the SMART Table finished OK. Actions to be performed if a SMART Table finished NOTOK are performed only if one or more jobs in the SMART Table finished NOTOK.

Chapter 7 Post-processing parameters

793

Post-processing of a SMART Table occurs when the last job in the SMART Table ends. A SMART Table may become active again after the post-processing has been completed, if one or more jobs are rerun, or if a new job is added to the SMART Table and submitted. In this case, when the last job in the SMART Table ends again, the completion status of the SMART Table is rechecked and the appropriate post-processing actions are performed. For more information about SMART Table, see the Control-M User Guide. Table 165 Post-processing parameters
Parameter CTB Step Do AutoEdit Do Cond Do CTBRule Do Forcejob Do If Rerun Do Mail Do NOTOK Do OK Do Remedy Do Rerun Do Shout Do Stop Cyclic Do Sysout On statement Reten Days Reten Gen Step Range Description Adds Control-M/Analyzer steps as the first and/or last step of the jobs execution. Assigns a value to an AutoEdit variable. Specifies prerequisite conditions to be added or deleted. Invokes a Control-M/Analyzer rule to be executed during the processing of a specific program step. Forces a job or all jobs in a table to be ordered under Control-M regardless of the scheduling criteria. Job steps to be executed during restart of a job. Available only at sites utilizing Control-M/Restart. Specifies a message to be sent to one or more email addresses. Sets the jobs completion status to NOTOK regardless of how the job actually ended. Sets the jobs completion status to OK regardless of how the job actually ended. Opens a ticket in the Remedy Help Desk regarding the critical service. Causes the job to be rerun according to the parameters specified in the Rerun parameter. Specifies messages to be sent (shouted) to specified destinations on various occasions. Prevents future iterations of a cyclic job. Specifies how the jobs log/output should be handled. Job processing step and code event criteria that determine whether the accompanying DO statements are performed. Number of days to retain the job in the History Jobs file. [z/OS only] Maximum number of generations of the job to keep in the History Jobs file. [z/OS only] Specifies a range of steps in the steps of an On PGMST statement.

794

Control-M Parameter Guide

CTB Step

CTB Step
Adds Control-M/Analyzer steps as the first and/or last step of the jobs execution.

NOTE
For Control-M for z/OS installations in which Control-M/Analyzer is installed.

Format
Usage Availability Format Invalid Characters AutoEdit Support Optional This parameter is accessed from the Control-M for z/OS interface, only. CTB Step is composed of the AT, NAME, TYPE, and ARGUMENTS subparameters, described below. Non-English characters No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameters
Parameter AT Description Indicates where to place the Control-M/Analyzer step in the job. Mandatory. Valid values:

S (Start) The indicated Control-M/Analyzer step must become the first step of the job. E (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. Length Case Sensitive Invalid Characters 1 through 8 characters Yes Blanks; non-English characters

TYPE

Type of Control-M/Analyzer entity. Mandatory. Valid values: R (Rule) Entity is a Control-M/Analyzer rule. M (Mission) Entity is a Control-M/Analyzer mission.

Chapter 7 Post-processing parameters

795

CTB Step

Parameter ARGUMENTS

Description Arguments to be passed to the Control-M/Analyzer step. Optional. Length Case Sensitive Invalid Characters 0 through 60 characters Yes Non-English characters

General information
A maximum of two CTB STEP statements (that is, one START statement and one END statement) can be specified. 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 steps JCL. Control-M uses the status returned by Control-M/Analyzer as it would use the return status of any job step.

If Control-M/Analyzer returns a status of OK or TOLER (within accepted tolerances), Control-M considers the step as having ended OK. If Control-M/Analyzer returns a status of NOTOK or ABEND, Control-M considers the job step as having ended NOTOK.

Aliases for other Control-M components

Alternate names for the CTB Step parameter are listed below.
Component Control-M/EM API Parameter Name ctb_step

796

Control-M Parameter Guide

CTB Step

Example: Check results and set a condition

After successfully performing salary calculations, job SACALC01 invokes rule CHKCALC to ensure that the results are reasonable, and then sets OUT condition SALARY-OK.
JOB: SACALC01 LIB CTM.PROD.SCHEDULE TABLE: SALARY COMMAND ===> SCROLL===> CRSR +--------------------------------------------------------------------------+ MEMNAME SACALC01 MEMLIB GENERAL OWNER SYS1 TASKTYPE JOB PREVENT-NCT2 DFLT N APPL SAL GROUP SALARY DESC SALARY CALCULATIONS OVERLIB SCHENV SYSTEM ID NJE NODE SET VAR CTB STEP AT END NAME CHKCALC TYPE RULE ARGUMENTS %%ODATE CTB STEP AT NAME TYPE DOCMEM SACALC01 DOCLIB 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 SHIFT RETRO Y MAXWAIT 00 D-CAT MINIMUM PDS DEFINITION ACTIVE FROM UNTIL =========================================================================== IN CONTROL RESOURCE PIPE TIME: FROM UNTIL PRIORITY DUE OUT SAC CONFIRM TIME ZONE: =========================================================================== OUT SALARY-OK ODAT + COMMANDS: EDIT, DOC, PLAN, JOBSTAT 11.17.00

Chapter 7 Post-processing parameters

797

Do AutoEdit

Do AutoEdit
The Do AutoEdit variable assigns a value to an AutoEdit variable for use in a rerun of the job when the On Statement/Code criteria are satisfied.

Format
Usage Format Optional Name and Value text boxes in the Control-M/EM Job Editing form. Enter the AutoEdit variable name in the Name text box, and the expression in the Value text box. Application-specific job parameters may not be specified in AutoEdit variable values. The names of application-specific job parameters are prefixed by two percent signs, the applications abbreviation and a hyphen (%%SAPR3- for SAP, %%OAP- for Oracle, and so on). Length Computers other than z/OS:

The AutoEdit variable name Name can be up to 40 characters long (including the %% prefix). The AutoEdit expression Value can be up to 214 characters long.

z/OS: The total length of Do AutoEdit, including the %% prefix, variable-name, value, and the = sign, must not exceed 55 characters. Case Sensitive Invalid Characters Yes Computers other than z/OS: The following characters cannot be included as part of variable-name in a User-defined AutoEdit variable: < > [ ] { } ( ) = ; ~ | : ? . + - * / & ^ # @ ! , " '. In value the only invalid characters are embedded blanks. Leading blanks are valid. z/OS: Blanks AutoEdit Support Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

798

Control-M Parameter Guide

Do AutoEdit

Subparameters
Parameter Name Value Description Name of the AutoEdit variable. The %% prefix is entered automatically. 1-38 character string (following the %% prefix). AutoEdit expression. 1-214 character string. Application-specific job parameters may not be specified in AutoEdit variable values. The names of application-specific job parameters are prefixed by two percent signs, the applications abbreviation and a hyphen (%%SAPR3- for SAP, %%OAP- for Oracle, and so on).

Related parameters
AutoEdit AutoEdit Assignment assigns values to a variable for use in the current job run. Whereas, Do AutoEdit assigns a value to be used in the subsequent run of the job.

General information
AutoEdit variables are resolved (replaced) at the time a job is submitted. The Do AutoEdit parameter can be used to assign a value to an AutoEdit variable for use in a rerun of the job. When a job is rerun, statements specified in Do AutoEdit are evaluated after statements specified in AutoEdit Assignment. Unless it is assigned a value in the AutoEdit Assignment parameter, an AutoEdit variable that is assigned a value in a Do AutoEdit parameter does not have any value during the first submission of the job.

Aliases for other Control-M components

Alternate names for the Do AutoEdit parameter are listed below.
Component Control-M/EM Utilities Control-M/Desktop Control-M/Server Utilities Control-M/EM API Parameter Name DOAUTOEDIT Do Set var -doautoedit do_autoedit

Alternate formats for other Control-M components

Alternate formats for the Do AutoEdit parameter are listed below.

Chapter 7 Post-processing parameters

799

Do AutoEdit

Component Control-M/EM Utilities

Format The value for the DOAUTOEDIT parameter is contained in the EXP subparameter. Example <DOAUTOEDIT EXP=%%PARM1=%%TIME/> EXP String containing both the variable and the expression, presented as an equation.

800

Control-M Parameter Guide

Do Cond

Do Cond
The Do Cond parameter specifies a prerequisite condition to be added or deleted when the On Statement/Code criteria are satisfied.

Format
Usage Format AutoEdit Support Optional Each Do Cond parameter consists of three subparameters, described below. No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameters
Parameter Condition Description Descriptive name of a prerequisite condition. Length

1 through 255 characters z/OS: 1 through 39 characters Control-M for z/OS versions prior to 6.0.00: 1 through 20 characters

Case Sensitive

Yes. However, if the Uppercase Only check box was selected in the Add Control-M Definition window, you cannot use lowercase characters. Computers other than z/OS: Blanks; single quotation marks; ) and ( (parentheses); | (pipe) z/OS: Blanks; ) and ( (parentheses); | (pipe)

Invalid Characters

Chapter 7 Post-processing parameters

801

Do Cond

Parameter Date

Description Date (four characters long) for the prerequisite condition.

date. Specific date (mmdd or ddmm format). ODAT. Automatically replaced by the jobs original scheduling date when the job is ordered. PREV Automatically replaced by the jobs previous scheduling date when the job is ordered (or for a forced job, ODAT-1). NEXT Automatically replaced by the jobs next scheduling date when the job is ordered (or for a forced job, ODAT+1). **** (or $$$$) Any condition date. For deleting a prerequisite condition, only. When specified, all prerequisite conditions with the specified condition name are deleted, regardless of their dates. STAT Condition is not date-dependent. Note that this value is valid only for Control-M/Server version 6.0.01 and later.

Note: PREV and NEXT cannot be specified when modifying details of a job in the Active Jobs file. A date reference is required for each condition. However, beginning with version 6.1.03 of Control-M/Server, ODAT can be specified when modifying details of a job in the Active Jobs file. Sign A pair of option buttons that indicate if the condition should be added (created) or deleted.

+ Adds (creates) the condition Deletes the condition

If the value of ODAT is $$$$ or ****, + cannot be selected.

General information
The Do Cond parameter is optional. However, each Condition parameter specified must have a Date reference and a Sign specification. When the criteria specified in the On Statement/Condition parameter are satisfied, the designated prerequisite condition(s) are added or deleted from the Control-M Conditions List. If parameters Do Cond and Out Conditions perform opposing actions on the same prerequisite condition and date, the Do Cond parameter overrides the Out Conditions parameter. For more information on the Out Conditions parameter, see Out Condition on page 780.

802

Control-M Parameter Guide

Do Cond

NOTE
A maximum of 99 prerequisite conditions can be specified for the Do Cond parameter.

Aliases for other Control-M components

Alternate names for the Do Cond parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name DOCOND -docond Parameter not included. DO COND do_cond

Alternate formats for other Control-M components

Alternate formats for the Do Condition parameter are listed below.
Component Control-M/EM Utilities Format DOCOND contains the following subparameters: NAME ODATE SIGN Name of the condition. String. Date (four characters long) for the prerequisite condition. String. Default: ODAT. Valid values: ADD (Default) DEL

Chapter 7 Post-processing parameters

803

Do CTBRule

Do CTBRule
Invokes a Control-M/Analyzer rule to be executed during the processing of a specific program step.

NOTE
This parameter is available only for Control-M for z/OS jobs at sites using Control-M/Analyzer.

Format
Usage Format Optional

Control-M/EM Job Editing form: Select CTBRule from the Do list box. Specify values in the Name and Arg fields. Control-M: Type CTBRULE in the DO field and press Enter.

AutoEdit Support

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameters
Parameter name Description Text box. Name of the Control-M/Analyzer rule that is to be executed. The Control-M/Analyzer rule contains all balancing specifications to be performed. Mandatory. Length Invalid Characters ARG Text box. Arguments that are passed to the Control-M/Analyzer rule. Separate multiple arguments by commas. Optional. Length Invalid Characters 1 through 45 characters Blanks; non-English characters Case Sensitive Yes 1 through 8 characters Blanks; non-English characters Case Sensitive Yes

804

Control-M Parameter Guide

Do CTBRule

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.

NOTE
If DO CTBRULE is specified under ON PGMST ANYSTEP, the Control-M/Analyzer Runtime environment is invoked only once.

When Control-M calls a Control-M/Analyzer rule, 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, 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 User Guide.

Aliases for other Control-M components

Alternate names for the Do CTBRule parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name DOCTBRULE Parameter not included. DO CTBRULE do_ctbrule

Chapter 7 Post-processing parameters

805

Do CTBRule

Alternate formats for other Control-M components

Alternate formats for the Do CTBRule parameter are listed below.
Component Control-M/EM Utilities Format DOCTBRULE contains the following subparameters. NAME PAR Name of the Control-M/Analyzer rule that is to be executed. Arguments.

Example: Execute a Control-M/Analyzer rule when a job ends OK

If the job ends OK, execute Control-M/Analyzer balancing rule GOVTBAL.
JOB: GOVTREPT LIB CTM.PROD.SCHEDULE TABLE: BACKUP COMMAND ===> SCROLL===> CRSR +--------------------------------------------------------------------------+ TIME: FROM UNTIL PRIORITY DUE OUT SAC CONFIRM TIME ZONE: =========================================================================== OUT FINANCE-GOVTREPT-OK ODAT + AUTO-ARCHIVE Y SYSDB Y MAXDAYS MAXRUNS RETENTION: # OF DAYS TO KEEP 030 # OF GENERATIONS TO KEEP SYSOUT OP (C,D,F,N,R) FROM MAXRERUN RERUNMEM INTERVAL 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 SCHEDULING PARAMETERS <<<<<<<<<<<<<<< ====== COMMANDS: EDIT, DOC, PLAN, JOBSTAT 11.17.00

806

Control-M Parameter Guide

Do Forcejob

Do Forcejob
The Do Forcejob parameter forces an individual job or all jobs in a table to be placed in the Active Jobs file (regardless of each jobs Scheduling criteria) when the On Statement/Code criteria are satisfied.

Format
Usage Format Optional In the Control-M/EM Job Editing form: Select Force-job from the Do list box. The SCD Table, Job Name, and Date text boxes are displayed. Enter the subparameter values in these text boxes. These subparameters are described below. AutoEdit Support No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Subparameters
Parameter SCD Table Description Name of the job table Length Invalid Characters Job Name Length 1 through 20 characters Blanks; single quotation marks OS/900: Non-English characters

Job name. If this field is blank, all jobs in the specified table are forced. Computers other than z/OS: 1 through 20 characters. z/OS: 1 through 8 characters.

Invalid Characters Date

Blanks (embedded); single quotation marks

Value to be used as the original scheduling date for the job. Valid values are: ODAT Resolves to the original scheduling date of the job resulting in the execution of this parameter (default). Note: As of Control-M/Server version 6.1.03, ODAT can also be specified when modifying details of a job in the Active Jobs file. A date reference, 4 or 6 characters long (either mmdd, ddmm, yymmdd, or yyddmm format, depending on the site standard). z/OS: Only the yymmdd or yyddmm format can be used

date

Chapter 7 Post-processing parameters

807

Do Forcejob

General information
Do Forcejob causes the specified job to be placed immediately in the Active Jobs file. The job is submitted for execution as soon as all its submission criteria are satisfied.

NOTE
When Do Forcejob forces a job that belongs to a SMART Table, it treats it as a regular job and forces it alone (that is, without a SMART Table).

Aliases for other Control-M components

Alternate names for the Do Forcejob parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name DOFORCEJOB -doforcejob DO FORCEJOB do_forcejob

Alternate formats for other Control-M components

Alternate formats for the Do Forcejob parameter are listed below.
Component Control-M/EM Utilities Format DOFORCEJOB consists of the DSN, TABLE_NAME, NAME, and ODATE subparameters. The value of DSN is the Table Library name, which must be specified for z/OS jobs. Example <DOFORCEJOB DSN=z/OS.TBL TABLE_NAME=Tbl1 JOB=Job3 ODATE=DATE/> Control-M for z/OS DO FORCEJOB consists of the TABLE, NAME, and LIBRARY subparameters. The value of DSN is the Table Library name, which must be specified for z/OS jobs.

808

Control-M Parameter Guide

Do If Rerun

Do If Rerun
Job steps to be executed during restart of a job.

NOTE
This parameter is available only if Control-M/Restart is installed on a Control-M for z/OS site.

Format

Usage Format

Optional Select IFRerun from the Do list box in the Job editing form. From and To text boxes and a Confirm check box are displayed. Enter the required information. Select the check box, if required. These subparameters are described below.

AutoEdit Support

No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Parameter Maximum Reruns Do Remedy Description Determines the maximum number of times the restart or rerun specified by the Do If Rerun parameter is performed. Used to perform the job rerun when Confirm is not selected and a job rerun is required.

Chapter 7 Post-processing parameters

809

Do If Rerun

Subparameters
Parameter From Description Step at which the job must be restarted. Mandatory. Valid values: pgmstep Program step within the job stream. pgmstep.procstep Program step within the called procedure. $FIRST First step of the job. $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). $FIRST.$ABEND First step of the abended procedure. $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. $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: 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 from 1 through 8 characters, and must not contain blanks. When specifying a procstep when the procedures are nested, the innermost procstep in which the program is included must be specified. Step at which the restarted job must terminate. Optional. Valid values are: Note: Non-English characters are invalid for this subparameter. pgmstep Program step within the job stream pgmstep. procstep Program step within the called procedure. 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 from 1 through 8 characters, and must not contain blanks. When specifying a procstep when the procedures are nested, the innermost procstep in which the program is included must be specified.

To

810

Control-M Parameter Guide

Do If Rerun

Parameter Confirm

Description Specifies whether a manual confirmation is required before the job is restarted. When the check box in the Job Editing form is clear, no confirmation is required. The job restart can be automatically submitted (by the Do Rerun parameter) without a manual confirmation. Default. When the check box in the Job Editing form is selected, confirmation is required. The job restart is not submitted unless the job is confirmed manually from the Control-M/EM flow diagram. Non-English characters are invalid for this subparameter.

General information
When a Do If Rerun statement is specified, the rerun is performed by the Control-M/Restart facility using the specified restart subparameters.

When Do If Rerun is specified with a Confirm parameter value of No (Confirm check box is clear): If a Do If Rerun statement follows, the job is automatically submitted for rerun. If a Do If Rerun statement does not follow, the job is not automatically rerun. Instead, the job remains displayed with its error status in the Control-M/EM GUI. In this case, to submit the job for rerun or restart, rerun the job from the Control-M/EM GUI. The Rerun (with Restart) Confirmation window is displayed. Request the restart or rerun from the window.

When Do If Rerun is specified with a Confirm parameter value of Yes (the Confirm check box is selected), the job appears in the Control-M/EM GUI with a WAIT CONFIRMATION (WITH RESTART) status and is not restarted unless confirmed. Confirm the job to restart it.

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 Control-M/Restart 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 Control-M/Restart 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 Control-M/Restart step, refer to the Control-M/Restart User Manual. The Max Rerun parameter determines the maximum number of times the restart or rerun can be performed. For more information, see Maximum Reruns on page 737.

Chapter 7 Post-processing parameters

811

Do If Rerun

Availability

This parameter is available only if Control-M/Restart is installed on a Control-M for z/OS site. The Do If Rerun and Rerun Member parameters cannot be specified together.

Aliases for other Control-M components

Alternate names for the Do If Rerun parameter are listed below.
Component Control-M/EM Utilities Control-M for z/OS Control-M/EM API Parameter Name DOIFRERUN DO IFRERUN do_ifrerun

Alternate formats for other Control-M components

Alternate formats for the Do If Rerun parameter are listed below.
Component Format CONFIRM Valid values:

Control-M/EM Utilities DOIFRERUN is composed of the following subparameters:

0 (No confirmation. Default) 1 (Confirm)

FPGMS FPROCS TPGMS TPROCS Control-M for z/OS

First program step in the range. 1-8 character string. First process step in the range. 1-8 character string. Last program step in the range. 1-8 character string. Last process step in the range. 1-8 character string. First program or process step in the range. 1-8 character string. Last program or process step in the range. 1-8 character string. Valid values: N (No confirmation. Default) Y (Confirm)

Do IFRERUN is composed of the following subparameters: FROM TO CONFIRM

812

Control-M Parameter Guide

Do Mail

Do Mail
The Do Mail parameter specifies a message to be sent (mailed) to an e-mail address when the specified On Statement/Code criteria are satisfied.

Format
Usage Format Optional Select Mail from the Do list box in the Job editing form. To, Subject, and Message text boxes are displayed. To send a brief message, enter the required information. To send a more detailed message and/or a message that is sent to more than one recipient, Click Details=.... The Mail dialog box is displayed. These subparameters are described below.

Invalid Characters z/OS, except for Message subparameter: Non-English characters AutoEdit Support Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Subparameters
Parameter To Description E-mail addresses for recipients of the mail message. Multiple addresses can be specified, separated by semicolons ;. Mandatory. Note: Only physical addresses or AutoEdit variables can be specified. Logical addresses (as specified for the Do Shout parameter) are not supported for Do Mail. Length Computers other than z/OS: 1 through 255 characters z/OS: 1 through 255 characters Case Sensitive Invalid Characters Yes Computers other than z/OS: Blanks; single quotation marks z/OS: Blanks; non-English characters AutoEdit Support Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Chapter 7 Post-processing parameters

813

Do Mail

Parameter CC

Description E-mail addresses that should be CCed for the mail message. Multiple addresses can be specified, separated by semicolons ( ; ). Optional. Note: On some UNIX computers, all recipients are shown in the To field because the CC field is not supported. Length Computers other than z/OS: 1 through 255 characters z/OS: 1 through 255 characters Case Sensitive Invalid Characters Yes Computers other than z/OS: Blanks; single quotation marks z/OS: Blanks; non-English characters AutoEdit Support No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter. Computers other than z/OS: 1 through 99 characters z/OS: 1 through 70 characters Case Sensitive Invalid Characters Yes Computers other than z/OS: Single quotation marks; do not use - as the first character. z/OS: Non-English characters AutoEdit Support No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter. Computers other than z/OS: 1 through 4000 characters z/OS: 1 through 255 lines, each containing 1 through 70 characters However, do not exceed 4000 characters in the Job Editing Form. Yes Computers other than z/OS: Single quotation marks z/OS: None Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Subject

Subject line for the message. Length

message

Text of the mail message. Length

Case Sensitive Invalid Characters AutoEdit Support Urgency

Select from the following buttons, which indicate a level of urgency for the message: Regular Indicates that the message should have a regular level of urgency. Urgent Indicates messages with a high priority. Urgent message are sent with a special indication so that the recipient of the message is aware of the urgency. Very Urgent Indicates that the message should have the highest level of urgency. For Control-M/Server utilities, only.

814

Control-M Parameter Guide

Do Mail

Parameter Attach Sysout

Description Specifies at the job level whether the sysout should be sent as an email attachment. Format Values List

Yes: Send the jobs sysout as an attachment No: Do not send the jobs sysout as an attachment Default: Refers to the ADD SYSOUT TO EMAIL value in the config.file to determine whether to send the jobs sysout as an attachment.

General information
The mail message specified by this parameter is sent to the indicated e-mail addresses when the condition specified by the On Statement/Code parameter is satisfied. Mail messages can also be sent using a Do Shout parameter. However:

When using the Do Shout parameter, email addresses must be defined in the dynamic destination table. Do Mail can specify two fields of e-mail addresses: TO contains up to 96 characters (in z/OS environments, up to 9999); CC contains up to 99 characters (in z/OS environments, up to 9999. Do Shout allows only 16 characters. Do Mail can specify up to 4096 characters in the message (in z/OS environments, up to 255 lines each containing up to 70 characters). Do Shout allows only 255 characters. The specified message is sent to the addresses specified in the CC field in the same way that it is sent to the addresses in the To field.

Aliases for other Control-M components

Alternate names for the Do Mail parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name DOMAIL -domail DO MAIL do_mail

Example: Send a message when a job completes OK

The following example illustrates how a message is sent to an e-mail address when a specified job completes successfully. When FIRST_JOB completes successfully, condition FIRST_OK is created, as specified in FIRST_JOBs Out Conditions parameter. Do Mail then sends the message to the specified e-mail address.

Chapter 7 Post-processing parameters

815

Do NOTOK

Job Name Mem Name Mem Lib Owner Application Out Conditions Do Mail

FIRST_JOB Job_1 W$DISK: Thomas Payroll FIRST_OK To: [email protected] "The FIRST_JOB finished OK."

Do NOTOK
The Do NOTOK parameter assigns a completion status of NOTOK to a job when the On Statement/Code criteria are satisfied, regardless of the jobs actual completion status.

Format
Table 166 Format - Do NOTOK Parameter
Usage Format AutoEdit Support Optional Select NOTOK from the Do list box. No additional information is required. No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Do OK Do OK overrides or can be overridden by the Do NOTOK parameter. When both are specified, the one specified last takes effect.

General information For most jobs:

If DO OK and DO NOTOK are both specified, and are implemented, the last statement to be implemented determines the status assigned to the job. For information about the Do OK parameter, see Do OK on page 818.

For z/OS jobs:

Do NOTOK overrides the completion status of a job and changes it to NOTOK.

816

Control-M Parameter Guide

Do NOTOK

Do NOTOK cannot be specified together with Do Rerun or Do OK for the same codes-event. When: Do OK, Do NOTOK, and/or Do Rerun are specified for different codes-events in a job processing definition. -andMore than one of the codes-events is executed, including the codes-event specifying Do OK. Then: Do OK is overridden by Do NOTOK and/or Do Rerun, regardless of the order in which the codes-events are executed.

Aliases for other Control-M components

Alternate names for the Do NOTOK parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name NOTOK Parameter not included. -donotok DO NOTOK do

Alternate formats for other Control-M components

Alternate formats for the Do NOTOK parameter are listed below.
Component Control-M/EM Utilities Control-M for z/OS Parameter Name NOTOK is a valid value for the DO parameter. It is not a parameter itself. NOTOK is a valid value of the DO parameter. It is not itself a parameter.

Chapter 7 Post-processing parameters

817

Do OK

Do OK
The Do OK parameter assigns the completion status of OK to a job, regardless of its actual completion status.

Format
Usage Format AutoEdit Support Optional Select OK from the Do list box. No additional information is required. No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Do NOTOK Do NOTOK overrides or can be overridden by the Do OK parameter. When both are specified, the one specified last takes effect.

General information For most jobs:

If DO OK and DO NOTOK are both specified, and are implemented, the last statement to be implemented determines the status assigned to the job.

For z/OS jobs:

Do NOTOK overrides the completion status of a job and changes it to NOTOK. Do NOTOK cannot be specified together with Do Rerun or Do OK for the same codes-event. When: Do OK, Do NOTOK, and/or Do Rerun are specified for different codes-events in a job processing definition. -andMore than one of the codes-events is executed, including the codes-event specifying Do OK.

818

Control-M Parameter Guide

Do OK

Then: Do OK is overridden by Do NOTOK and/or Do Rerun, regardless of the order in which the codes-events are executed.

Aliases for other Control-M components

Alternate names for the Do OK parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name OK -dook DO OK do

Chapter 7 Post-processing parameters

819

Do Remedy

Do Remedy
Opens a ticket in the Remedy Help Desk.

Format
Usage Format Invalid Characters Optional Consists of subparameters, described below. The following special characters are not permitted in the Do Remedy parameter or its subparameters. Single quotation mark () Double quotation marks () Equals (=) Less than (<) Greater than (>) Ampersand (&) Backslash (\) Non-English characters Yes

AutoEdit Support

Subparameters
Subparameter Urgency Description The urgency level of the ticket that will be opened in Remedy. Mandatory. Valid values are: L = Low (Default) M = Medium H = High U= Urgent C = Clear A brief summary is displayed in Remedy. By default, a summary of the problem appears using AutoEdit variables. For more information on the fields characteristics, refer to Remedy documentation. A detailed description is displayed in Remedy. By default, a description of the problem appears using AutoEdit variables. For more information on the fields characteristics, refer to Remedy documentation.

Summary

Description

General information
The action parameter DO Remedy is applicable on Control-M/Server and on jobs within the batch service.

820

Control-M Parameter Guide

Do Rerun

Do Rerun
Indicates if an automatic rerun should be performed when the On Statement/Code criteria are satisfied. No values or subparameters are specified for this parameter.

Related parameters
Do OK Do NOTOK Interval Maximum Reruns Rerun From Shout RERUN OK status can act as a trigger for job reruns specified with Do Rerun. NOTOK status can act as a trigger for job reruns specified with Do Rerun. Time between job runs specified with the Do Rerun parameter. Number of job runs that can be specified with the Do Rerun parameter. Indicates whether the interval between job runs begins with the start or the end of the previous job run. Default: start Sends a message if the jobs completion status was set to Rerun.

General information
Do Rerun specifies that the job should be rerun according to the criteria specified in the Max Rerun and Interval parameters. These parameters must be specified before a Do Rerun action can be defined.

NOTE
Do Rerun cannot be used to rerun SMART Tables.

For most jobs:

If Do Rerun is specified, and DO OK or DO NOTOK is specified, and implemented, the last statement to be implemented determines the status assigned to the job.

For z/OS jobs:

When a Do Rerun action is specified for a job, the jobs completion status is set to NOTOK, even if it was previously specified as OK.

Chapter 7 Post-processing parameters

821

Do Rerun

Availability For z/OS jobs:

Cyclic jobs cannot contain a Do Rerun parameter. Do Rerun cannot be specified together with Do OK or Do NOTOK for the same codes-event. When: Do OK, Do NOTOK, and/or Do Rerun are specified for different codes-events in a job processing definition. -andMore than one of the codes-events is executed, including the codes-event specifying Do OK. Then: Do OK is overridden by Do NOTOK and/or Do Rerun, regardless of the order in which the codes-events are executed.

Aliases for other Control-M components

Alternate names for the Do Rerun parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name RERUN -dorerun DO RERUN do

822

Control-M Parameter Guide

Do Shout

Do Shout
Specifies a message to be sent (shouted) to a destination when the On Statement/Code criteria are satisfied.

Format
Usage Format AutoEdit Support Optional. Select Shout from the Do list box. The controls described below in Subparameters are displayed. Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Subparameters
Parameter Destination Description Destination of the Shout message (1-16 characters, case sensitive). This parameter is required. For a detailed explanation, see Shout on page 867. Text of the Shout message, up to 255 characters (spaces allowed). This parameter is required. Use of AutoEdit variables is supported. For more information about this field, see Shout on page 867. Level or urgency for the Shout Message. Choose the option button for the appropriate urgency level:

MSG

Urgency

Regular (Default) Urgent Very urgent

Chapter 7 Post-processing parameters

823

Do Shout

Aliases for other Control-M components

Alternate names for the Do Shout parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name DOSHOUT -doshout DO SHOUT do_shout

Alternate formats for other Control-M components

Alternate formats for the Do Shout parameter are listed below.
Component Format

Control-M/EM Utilities DOSHOUT is composed of the DEST (destination) URGENCY, and MESSAGE subparameters. Example: <DOSHOUT DEST="Wkstn2" URGENCY="R" MESSAGE="Job5 completed OK"/>

824

Control-M Parameter Guide

Do Stop Cyclic

Do Stop Cyclic
When specified, this parameter prevents subsequent iterations of the current cyclic job. No values or subparameters are specified for this parameter.

Related parameters
Cyclic Cyclic is overridden by the Do Stop Cyclic parameter.

General information
Cyclic jobs normally run a regular intervals for as long as specified scheduling criteria are satisfied. If the related On Statement/Code criteria are satisfied, Do Stop Cyclic prevents future iterations of the current cyclic job. If the current job is not a cyclic job, this parameter has no effect on job processing. If a cyclic job is terminated by a Do Stop Cyclic parameter, the View Details screen displayed by option Z in the ctmpsm utility contains Cyclic:T where T indicates Terminated.

Aliases for other Control-M components

Alternate names for the Do Stop Cyclic parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name SPCYC -dostopcyclic DO STOPCYCL do

Chapter 7 Post-processing parameters

825

Do Sysout

Do Sysout
Indicates how the jobs output should be handled when the On Statement and Code criteria are satisfied.

Format
Usage Format Optional Select Sysout from the Do list box and specify the relevant subparameters. The following subparameters are available for this parameter: Option Indicates what to do with the SYSOUT data. The options that can be selected in this list box are: Computers other than z/OS: None Copy Delete Move Release z/OS: None Change jobs class Delete output Copy output Move output Each value is described in detail in Table 175. Prm Contains additional information, depending on which value is specified for the Option parameter.

The format for this parameter is the same as specified for Sysout Handling. For more information about this parameter, see SYSOUT Handling on page 876. AutoEdit Support AutoEdit variables and expressions cannot be specified as all or part of the values for this parameter.

Related parameters
SYSOUT Handling Sysout Handling specifies how to handle a SYSOUT when the job ended OK.

826

Control-M Parameter Guide

Do Sysout

General information
If no Sysout Handling is specified (or the job does not end OK), and no Do Sysout statement is activated, the jobs log is placed in the default location specified by Control-M until the New Day procedure performs its cleanup.

NOTE
The default destination of the Job log is determined by a Control-M system parameter on each computer. For more information, see your Control-M administrator.

The Automatic Log Copy Control-M system parameter is not affected in any way by the function of Do Sysout.

Aliases for other Control-M components

Alternate names for the Do Sysout parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Control-M for z/OS Control-M/EM API Parameter Name DOSYSOUT -dosysout DO SYSOUT do_sysout

Alternate formats for other Control-M components

Alternate formats for the Do Sysout parameter are listed below.
Component Control-M/EM Utilities Format DOSYSOUT is composed of the parameters below. Example <DOSYSOUT OPTION=ChangeClass PAR=F FROM=C/> OPTION Indicates what to do with the SYSOUT data. Mandatory. Valid values: Release Delete Copy Move Note: Copy and Move are not used with z/OS.

Chapter 7 Post-processing parameters

827

Do Sysout

Component Control-M/EM Utilities continued

Format PAR Certain OPTION values require that you supply additional information (such as Release, NewDest). The PAR parameter holds that information as a string. Limits the SYSOUT handling operation to only SYSOUTs from the specified class. SYSOUT option code. Mandatory. Valid values: C Change the class of the job output. D Delete (purge) the job output. F Copy the job output to file. N Change destination of job output. R Release the job output. data Relevant SYSOUT data. Mandatory and valid only if the specified OPT value is C, F, or N. Valid values depend on the OPT value, as follows: F File name. String comprised of from 1 through 44 characters. All characters are valid except blanks. C New class (1 character). Any character is valid except blank, but an asterisk (*) indicates the original MSGCLASS of the job. N New destination (1 through 8 characters). All characters are valid except blanks. FRM FROM class. Optional. Limits the SYSOUT handling operation to only SYSOUTs from the specified class.

FROM Control-M for z/OS

DO Sysout is composed of the parameters below. OPT

828

Control-M Parameter Guide

On statement

On statement
Job processing step and code event, and job SYSOUT criteria that determine whether the accompanying DO statements are performed.

NOTE
On Sysout statements are only available for jobs that run under Control-M for z/OS version 6.2.00 or later.

z/OS and non-z/OS jobs

There are important differences in the way the On statement functions between jobs running in z/OS environments and jobs running on other computers. In this section, the two types of jobs will be described separately. See also: Jobs running on computers other than z/OS Jobs running in z/OS environments

Jobs running on computers other than z/OS

In the case of jobs running on computers other than z/OS, the On statement specifies a codes event as the criteria for specified Do statements to be performed. A codes event can be one of the following types:

operating system completion code a combination of statements and error codes

Each of these types is described in detail below.

Chapter 7 Post-processing parameters

829

Jobs running on computers other than z/OS

Format
Usage Type Optional. Operating system completion code: Statement An asterisk must be specified in this field. Code This field must contain one of the following: OK NOTOK JLOST, indicating a completion status for the job a string in one of the following formats: {COMPSTAT|RUNCOUNT|RERUNNO} operator completionCode In this string operator is one of the following: = or EQ (equal) < or LT (less than) > or GT (greater than) ! or NE (not equal) completionCode must be one of the following: the number of the code returned by the operating system EVEN (the field is considered satisfied by an even return code ODD (the field is considered satisfied by an odd return code Note: If one of the following 2-letter abbreviations, EQ, LT, GT, or NE, is used as the value of operator, the abbreviation must be preceded and followed by blanks. Combination of statements and error codes: Statement a character string, from 1 through 132 characters in length, containing a statement from the job script file The specified string can be a portion of the statement. Code a character string, from 1 through 255 characters in length, to be compared to the operating systems response to the specified statement The Statement subparameter is optional. However when it is specified, the Code subparameter is also required. Statement and Code character strings can each contain mask characters. Valid mask characters are: * represents any number of characters (including no characters) $ represents any single character ? represents any single character Note for Chinese, Japanese and Korean character sets: The ? and $ wildcards are not supported. The * wildcard is supported only as a standalone value or as a suffix to another value; it cannot be embedded in, or act as a prefix to, another value.) AutoEdit Support No. AutoEdit variables or expressions cannot be specified as all or part of the value for this parameter.

830

Control-M Parameter Guide

Jobs running on computers other than z/OS

General information
Each On statement is combined with subsequent Do statements. Their implied relationship is:

IF: Codes-event criteria (specified in an On statement) are satisfied, THEN: Perform the actions (specified in the Do statements).

Any number of sets consisting of an On statement and Do statements can be specified for a job. Each On statement can be combined with an unlimited number of Do statements. The following topics are discussed in this section: Operating system completion code Combination of statements and error codes Considerations when defining conditional postprocessing actions Defining conditional criteria Understanding how On statements are processed Order of processing of On Statement/Code combinations Formatting of On statements from SYSOUT Utilization of exit codes

Operating system completion code

Table 167 describes how the On statement is used to test for an operating system completion code or Control-M completion status. Table 167 Operating system completion code
Completion code or status Completion code Description Upon termination of a job, the reserved word COMPSTAT contains the completion code of the job. The user can compare the completion code to a fixed value or test for an even or odd completion code using one of the listed logical operators. For example, COMPSTAT>4 indicates that dependent Do statements are executed if the job terminates with a completion code of 5 or above. Upon termination of a job, RUNCOUNT indicates the number of times the job has been submitted for execution.

Number of runs

Chapter 7 Post-processing parameters

831

Jobs running on computers other than z/OS

Table 167 Operating system completion code

Completion code or status Description

Number of reruns Upon termination of a job, RERUNNO indicates the number of times the job has been submitted for execution due to DO RERUN. Completion status Specifying OK or NOTOK in the Status parameter indicates that dependent Do statements are executed based on the OK or NOTOK termination status of the job. JLOST Specifying JLOST in the Status parameter indicates that dependent Do statements are executed if the SYSOUT of the job cannot be found.

Combination of statements and error codes

The On statement functions as follows:

The SYSOUT of the job is divided into sets, each consisting of a job script statement and operating system responses to the statement (if any). If no response exists for a specific script statement (that is, the statement executed successfully), a null message is paired with the script statement. The statement set is compared to the On statements defined for the job. If the Code parameter is specified as the * mask character, it can match even a null error message record successfully. If there is a match between the On statements and a statement set from the jobs log, the corresponding Do action statements are executed. Otherwise, Control-M proceeds to the next statement set.

Considerations when defining conditional postprocessing actions

Conditional postprocessing actions are performed following job processing. To define postprocessing actions that are conditional on the job processing results, use the Set tab to define On statements and accompanying Do statements. These statements are described as follows:

On statementsidentify the job processing results that determine if the accompanying conditional (Do) actions are going to be performed. Do statementsidentify the actions to perform when the On statement criteria are satisfied.

832

Control-M Parameter Guide

Jobs running on computers other than z/OS

Defining conditional criteria

When filling in On criteria, supply two values:

statement code

On criteria can be defined to depend on values returned from any of the following

job SYSOUT job completion code job completion status

To be able to fill in the On statement and codes values appropriately, you must understand how the job results are processed.

Understanding how On statements are processed

Whenever Control-M/Server submits a job under Control-M/Agent, the agent determines the completion code and completion status of the job based on the processing results and the instructions and definitions in the job script. The agent always passes this information to the server (even if an On statement does not depend on that information). So that it can determine if On criteria that depend on the SYSOUT of a job have been satisfied, Control-M/Server passes such On criteria to the Control-M/Agent at the time of job submission. After job execution (that is, after the job has ended or timed out), the agent must determine which On statements that depend on the jobs SYSOUT have been satisfied, and which have not. Job SYSOUT is divided into sets of data. Each set consists of the following:

a job script statement operating system responses to the job script statement. There can be multiple responses (lines). For example, for a job script statement requesting a list of the files in a directory, each listed file would constitute an operating system response line. (If no response exists for a specific script statement, a null message is paired with the job script statement.)

Control-M/Agent does not directly access the SYSOUT. Instead, it calls the Control Module which accesses the SYSOUT. The processing logic is as follows:

Chapter 7 Post-processing parameters

833

Jobs running on computers other than z/OS

1. Control-M/Agent calls the Control Module requesting SYSOUT data. 2. The Control Module reads one set of the SYSOUT data (beginning with the first set), and formats it as follows

job script statement operating system response 1 operating system response 2 operating system response 3, and so on

3. The Control Module sends job script statements to the agent and one operating system response (beginning with the first response). 4. Control-M/Agent checks the data sent by the Control Module against the On statement.

If the job script statement does not match one of the On statements, there is no match to that set of On criteria. It the job script statement and operating system response match the On statement and code criteria, Control-M/Agent considers the On statement criteria to be satisfied. If the job script statement matches the On statement, but the operating system response does not match the code criteria, Control-M/Agent asks to see the next operating system response in the set, and repeats this process until there is a match or until there are no more operating system responses in the set, in which case there is no match.

5. As long as there are remaining On Statements and sets of data in the SYSOUT, Control-M/Agent repeats the process from step 1. The agent requests that the control module check the next set of data, beginning with its job script statement and first operating system response. When the process is complete, Control-M/Agent sends Control-M/Server the following information about the job:

list of On statements (relating the SYSOUT) that have been satisfied list of On statements (relating to the SYSOUT) that have not been satisfied completion status of the jobdetermined by the script of the job and processing results completion code of the jobdefined in, and determined by, the script of the job

Control-M/Server examines this information, then determines and performs appropriate post processing.

834

Control-M Parameter Guide

Jobs running on computers other than z/OS

EXAMPLE
How On statements relating to the SYSOUT are processed A job script requests (among other functions) that the operating system run the following commands (the operating system does run the commands): pwd ls (this is a request to run a Dir command on the specified directory) (this is a request to list the files found in the Dir request)

The SYSOUT of the job contains the following results from these requests. +pwd /data/wrkfle +ls file1 file2 dir1 dir2 The job processing definition contains the following On (and Do) statement: On statement stmt= ls code=dir* Do ... Following job processing, Control-M/Agent issues calls to the Control Module to see if the On criteria have been satisfied. The list below indicates the call# , data formatted and returned by the Control Module, the SYSOUT set, and analysis of the results by Control-M/Agent: Call data returned by the Control Module Set Call1: statement= pwd code=/data/wrkfle 1st set Call2: statement=ls code= file1 2nd set Call3: statement=ls code=file2 2nd set Call4: statement=ls code=dir1 2nd set results according to the agent No match on the statement Match on statement. No match on code Match on statement. No match on code Match on statement. Match on code.

Control-M/Agent has determined that there is a match on the On criteria. It issues no more calls, and notifies Control-M/Server that the On criteria are satisfied. (It also sends Control-M/Server the completion code and completion status.)

Because On statement SYSOUT criteria are matched against SYSOUT data as formatted and returned by the Control Module, you must specify SYSOUT-related On criteria using the formatting that the Control Module uses, to respond to calls from Control-M/Agent.

Chapter 7 Post-processing parameters

835

Jobs running on computers other than z/OS

Order of processing of On Statement/Code combinations

Control-M processes On Statement/Code combinations in the following order: 1. On Statement/Code combinations related to completion codes, for example: ON "*" "COMPSTAT>0" 2. On Statement/Code combinations related to SYSOUT, for example: ON "*cp aaa bbb*" "*not found*" 3. On Statement/Code combinations based on the OK/NOTOK state of the job, for example: ON "*" "NOTOK"

Formatting of On statements from SYSOUT

Scripts that are analyzed by Control-M/Server as part of the post-processing of a job should comply with the following requirements:

Begin the script with the echo on command. This ensures that job script statements will be written to the SYSOUT file. End each prompt with a > or ] character. These characters and embedded spaces should not be used inside the prompt text string.

Table 168 describes how the On Statement/Code job processing parameter interprets script lines from SYSOUT. Table 168 Describing formatting of statements from SYSOUT
Item Description Analysis of the Sysout Text in a SYSOUT file that follows a > prompt or ] prompt is for On Statement/Code treated by Control-M/Server as part of the job script. All other text is treated as part of the operating system response. When specifying an On Statement/Code statement in a job processing definition, place text that follows either of these prompts in the Stmt parameter. Place other text in the Code parameter. Continuation Lines Control-M/Server does not process continuation lines for comparison with text in a Stmt subparameter. Therefore, do not specify script continuation line text in the Stmt subparameter. Control-M/Server compares the first 512 characters of a script statement with the text in subparameter Stmt. Text after the first 512 characters of a script statement should not be in subparameter Stmt. The maximum length of the On Code parameter is 255 characters.

Length of Script Statement

836

Control-M Parameter Guide

Jobs running on computers other than z/OS

Utilization of exit codes

Both DOS .bat scripts and REXX .cmd scripts can return an exit code to Control-M/Server upon completion. The _exit script utility is used by .bat scripts. For more information about script utilities, see the Control-M Administrator Guide. Control-M/Server can distinguish between exit codes by using the following expression in the Code subparameter of the On Statement/Code job processing parameter:
COMPSTAT=<value>

Example 1: Using exit codes

In this example, a REXX script exits with an exit code of 5, as displayed below:
exit 5

This condition can be detected by defining the following On Statement/Code parameter:

Stmt: * Code: COMPSTAT=5

Example 2: Job ends with a status of NOTOK

Using the following commands, any completion code other than 2 causes the job to end with a status of NOTOK.
On Statement * Code COMPSTAT!2 Do NOTOK

Example 3: Job ends with a status of OK

Using the following commands, any even completion code causes the job to end with a status of OK.
On Statement * Code COMPSTAT EQ EVEN Do OK

Chapter 7 Post-processing parameters

837

Jobs running on computers other than z/OS

Example 4: Create a condition on NOTOK

Using the following commands, a completion status of NOTOK causes Control-M to create a condition.
On Statement * Code NOTOK Do Cond PRKZ_NOTOK ODAT

Example 5: Output from an OpenVMS job

Assume that the following messages are issued from an OpenVMS job:
$ SET NOON $ MOU/SYS/OVER=ID MUA0: $ COPY JWINFO_2507.DAT mua0:ACCOUNT.DAT %COPY-E-OPENIN, error opening J$DSK:[USR1]JWINFO2507.DAT; as input -RMS-E-FNF, file not found $SH %DCL-W-INSFPRM, missing command parameters supply all required parameters USER1 Job terminated at 10-AUG.-1997 09:01:42.07 Accounting information: Buffered I/O count:43Peak working set size:375 Direct I/O count:24Peak page file size:2485 Page faults:495Mounted volumes:0 Charged CPU time:0 00:00:00.61Elapsed time:0 00:00:02.63

The following On statement would be triggered by the preceding messages:

On Statement COPY JWINFO_$$$$.* Code %COPY-E-OPENIN, error opening J$DSK:[USR1]* Do NOTOK

Example 6: Output from a UNIX Job

Assume that the following messages are issued from a UNIX job:
+ date Mon Mar 20 10:30:58 IST 2006 + pwd /export/users/ctmagent + ls BMCINSTALL ctm

838

Control-M Parameter Guide

Jobs running on computers other than z/OS

installed-versions.txt lsagent.sh

The following On statement would be triggered by the preceding messages:

ON Statement ls Code lsagent* Do NOTOK

Example 7: Rerunning a job (for Microsoft Windows)

Assume that the following is the SYSOUT from a batch job:
copy job411.dat tempt.dat File not found - JOB411.DAT 0 file(s) copied

The following On statement would be triggered by the preceding job output:

On Statement copy job411.dat Code File not found Do Rerun

Example 8: Assign NOTOK status for an iSeries (AS/400) job

Assume that the following is the SYSOUT from an iSeries (AS/400) job:
*NOnE Request 21/11/05 16:41:07 QWTSCSBJ QSYS 02FF TEST CMTST 0009 Message . . . . : -CALL PGM(CMTST) CPD0170 Diagnostic 30 21/11/05 16:41:07 QCLCLCPR QSYS 02FF TEST CMTST 009 Message . . . . : Program CMTST in library *LIBL not found. Cause . . . . . : The Program specified on the CALL command cannot be found.

The following On statement would be triggered by the preceding job output:

On Statement *CALL PGM (CMTST)* Code *Program CMTST in library *LIBL not found.* Do NOTOK

Chapter 7 Post-processing parameters

839

Jobs running on computers other than z/OS

Example 9: Issue a shout

In this example a shout is issued to the administrator if the word error is displayed anywhere in the SYSOUT.
On Statement stmt= * code= *error* Do Shout To= Adman Urgn= High Msg= Potential error in Job %%jobid

Example 10: Using completion codes other than 2

A completion code other than 2 causes the job to end NOTOK.
On Statement stmt= * code= COMPSTAT !2 Do NOTOK

Example 11: Using even completion codes causes the job to end OK
Any even completion code causes the job to end OK.
On Statement stmt= * code= COMPSTAT EQ Even Do OK

Example 12: Trigger a second job after the first job ends NOTOK
If a job ends NOTOK, add a condition that triggers a job that now becomes necessary.
On Statement stmt= * code= NOTOK Do Condition Name=JobX_NotOK Date= odat sign= +

Example 13: Set the status of a job to NOTOK under certain conditions
Set the status of a job to NOTOK if the SYSOUT indicates that the password directory is not found, In such a case, the SYSOUT of the UNIX job contains text similar to the following:
cp /etc/passwd /tmp cp /etc/passwdx /tmp cp: /etc/passwdx: No such file or directory cp /etc/passwd /usr/kvm/xyzzy cp: /usr/kvm/xyzzy: Permission denied exit 12 On

840

Control-M Parameter Guide

Jobs running in z/OS environments

Statement stmt= cp/etc/passwdx/tmp code= cp*no*file Do NOTOK

Example 14: Rerun a job under certain conditions

Rerun the job if the SYSOUT indicates that a particular file to be copied was not found:
On Statement stmt= copy job411.dat code= File not found Do Rerun

Jobs running in z/OS environments

Format
Usage Length AutoEdit Support Optional For more information, see Subparameters below. No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Do CTBRule Step Range Can be specified as a Do PGMST step. Specifies a range of steps in the larger step range specified by the On parameter. An action can be specified for the range that is selected.

Chapter 7 Post-processing parameters

841

Jobs running in z/OS environments

Subparameters
Stmt On statement that causes Control-M to check the execution results of a job step or procedure against the specified codes criteria. PGMST Job step. The execution results of the job step are checked against the specified codes criteria. Mandatory if the On Stmt option is selected. Valid values are: pgmstep *rangename ANYSTEP +EVERY These values are described in Table 169 on page 846. Length Invalid Characters 1 through 8 characters Blanks.

Note: If the first character of PGMST is * (asterisk), it must be followed by the range name of a defined Step Range consisting of up to 7 characters. Stmt PROCST Procedure step (EXEC statement) that invokes a procedure from continued which the specified PGMST program is executed. Optional. Valid values are:

blank procstep +EVERY

These values are described in Table 170 on page 847. Length Invalid characters Codes 1 through 8 characters Blanks

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 described in Code values on page 847. Optional. Specifying either And or Or opens a new On statement in the On block (described later) and links the new statement to the statement containing the And/Or specification, as follows:

And/Or

And indicates AND logic between the two On statements. On block criteria are satisfied only if both On statements are satisfied. Or indicates OR logic between the two On statements. On block criteria are satisfied if either (or both) On statements are satisfied.

842

Control-M Parameter Guide

Jobs running in z/OS environments

Sysout

On statement that defines a string and the location to be checked. When the job runs, if this string is found in the specified location within the SYSOUT of the job, the action defined in the accompanying Do statement is performed. Note: This option is available only for jobs running under Control-M for z/OS version 6.2.00 or later. Sysout Pattern Length Invalid characters 1 through 40 characters Blanks

Sysout From continued Column

A number from 001 through 132, indicating the column at which the search should start. If this field is blank, the value 001 is assumed. The value in this field must be lower than that in the To Column field.

To Column

A number from 001 through 132, indicating the column at which the search should end. If this field is blank, the value 132 is assumed. The value in this field must be higher than that in the From Column field.

And/Or

Optional. Specifying either And or Or opens a new On statement in the On block (described later) and links the new statement to the statement containing the And/Or specification, as follows:

And indicates AND logic between the two On statements. On block criteria are satisfied only if both On statements are satisfied. Or indicates OR logic between the two On statements. On block criteria are satisfied if either (or both) On statements are satisfied.

General information
On statements define event criteria that identify either specific Control-M job steps and possible codes that result from the execution of those job steps, or specific strings in the SYSOUT of a job. On statements are usually, but not necessarily, followed by user-specified Do actions. The implied relationship between On statements and associated Do statements is:

IF: Codes-event criteria (specified in an On Stmt statement) are satisfied, or the string specified in an On Sysout statement is found in the SYSOUT, THEN: Perform the actions (specified in the Do statements).

Chapter 7 Post-processing parameters

843

Jobs running in z/OS environments

The combination of On Stmt statements and Do statements enables you to specify post-processing actions the performance of which depends on the execution results of job steps executed under Control-M. The combination of On Sysout statements and Do statements enables you to specify post-processing actions that are to be performed if the SYSOUT of jobs contain specific strings.

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:

Each On and DO statement is independent. Multiple On and DO statements are not logically connected to the preceding On and DO statements. 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 1: Multiple On Stmt Do Blocks

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.

When you fill in the 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 2: Related On 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.

844

Control-M Parameter Guide

Jobs running in z/OS environments

Inserting additional On statements from Control-M for z/OS

When using the z/OS interface, 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.

Example 3: Insert an On Statement

If the program step name is STEP1 ON PGMST >TEP1 adds an empty On line after the current On statement. The STEP1 step name 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. For more information about Line Editing commands, see the Control-M for z/OS User Guide.

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 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 in Control-M/Restart 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 the step value +EVERY.

Chapter 7 Post-processing parameters

845

Jobs running in z/OS environments

Step values
Table 169 describes the PGMST Step Range values. Table 169 PGMST step values
Step Value pgmst Description In an On statement, the specified step is generally a program step, specified in the PGMST field. 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. 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). *rangename To check codes in a range of steps, first define the step range and assign it a name in the Step Range statement. 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 CONTROLR step to a job (for example, a job is restarted by Control-M/Restart or PREVENT NCT2 is specified in the job scheduling definition), the CONTROLR step is processed like all other job steps. Example In the Step Range statement, the 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. ANYSTEP The ANYSTEP value can be specified in the PGMST field. 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 the 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 the FORCE code, no other codes can be specified in the same On block, and the PROCST field must be left blank. +EVERY The +EVERY value 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.

846

Control-M Parameter Guide

Jobs running in z/OS environments

The PROCST Step Range values are described in Table 170. Table 170 PROCST step values
Step Value blank Description 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. 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. +EVERY The +EVERY value 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.

Code 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 codes can be specified for any On step statement, as follows:

Each line of an On statement contains fields for specification of up to four codes. Whenever a fourth code on a line is specified, and Enter is pressed, a new line within the same On statement is opened, allowing specification of up to another four codes.

NOTE
If a DO OK statement is specified in the job scheduling definition, it is ignored for steps for which any of the following codes apply: JNRUN, JNSUB, *REC0, *UKNW.

Code values are described in Table 171.

Chapter 7 Post-processing parameters

847

Jobs running in z/OS environments

Table 171
Value Cnnnn Sxxx Unnnn *****

Code values
Description Step condition code, where nnnn is a 4-digit value. Step system abend code, where xxx is a 3-character hex value. Step user abend code, where nnnn is a 4-digit value. Any step that executes, including steps with JCL errors and steps returned with an ABEND code. For reasons of backward compatibility, the ***** code does not include steps with the FLUSH code or SNRUN (described below). The ***** code does, however, include jobs not submitted and jobs whose SYSOUT was lost if On PGMST ANYSTEP is specified. This code applies when a Job is Forced OK from the Control-M Active Environment screen (Screen 3). To specify a code of FORCE, all of the following must apply: No other code can be specified in the same statement. The PGMST value must be ANYSTEP. No PROCST value can be specified. No other On statements can appear in the On block. Valid DO statements for the FORCE code are: DO SHOUT DO COND DO FORCEJOB DO SETVAR DO MAIL

FORCE

JLOST JNRUN JFAIL JSECU JNSUB

Job SYSOUT was lost. This value can be specified only with the ANYSTEP step value. Job was canceled during execution or re-execution. This value can be specified only with the ANYSTEP step value. Job failed due to JCL error. Job failed due to security requirements (only under ACF2). This value can be specified only with the ANYSTEP step value. Job not submitted. Submission of a job or initiation of a started task failed for any reason. This value can be specified only with the ANYSTEP step value. A PGM step finished executing OK (by default with a condition code of C0004 or less). This value can be specified only with the ANYSTEP step value. Note: Through parameter MAXCCOK in member CTMPARM in the IOA PARM library, the default condition code can be set to C0000. If a job is FORCED OK, the DO statements following an On PGMST ANYSTEP... CODES OK statement are processed only if the FRCOKOPT parameter in the CTMPARM member in the IOA PARM library is set to Y.

OK

848

Control-M Parameter Guide

Jobs running in z/OS environments

Table 171
Value NOTOK

Code values
Description A PGM step (or the job) finished executing NOTOK. This code covers all types of failures, including non-execution errors (for example, job not run, JCL error, job not submitted), and (by default) any condition code greater than C0004. This value can only be specified with the ANYSTEP step value. Note: You can use the MAXCCOK parameter in the CTMPARM member in the IOA PARM library to set the default condition code to C0000.

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 as the ANYSTEP step value. 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.

*NCT2

*TERM REC0 *UNKW

Job terminated by CMEM due to an NCT2 event. Rerun (recovery) is needed, but no more reruns are available. Note: REC is followed by a zero (0), not a letter O. An unknown error occurred, usually as a result of a computer crash during job execution. This value can only be specified with the ANYSTEP step value. Job was queued for re-execution. A JCL COND or JCL IF/THEN/ELSE statement caused a step to not run. This code is described in more detail in FLUSH, below. A step did not run. This code is described in more detail in SNRUN on page 850.

$EJ FLUSH SNRUN

FLUSH
The FLUSH code generally applies when a step does not run but no error is indicated. This code is assigned when:

A JCL COND or JCL IF/THEN/ELSE statement caused the step not to run. Control-M detects code FLUSH steps by the IEF272I message (Step was not executed).

Chapter 7 Post-processing parameters

849

Jobs running in z/OS environments

If a job was restarted by Control-M/Restart, and Control-M is to consider all job runs during post-processing (ALLRUNS is set to YES in the CTRPARM member), a step is defined as FLUSH if both the following statements are true: Either the step did not previously run, or Control-M/Restart did not recapture a completion or abend code from a previous run Either of the following statements is also true:

It was not executed during the RESTART run because of a JCL COND or JCL IF/THEN/ELSE statement. It was not executed due to a RESTART decision (the CTR103I message).

Because a code 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 the ***** code remains unchanged), the ***** code does not include FLUSH steps.

SNRUN
A step is defined as code SNRUN if it did not run. This code includes:

Any step with a code of FLUSH. Any step that does not appear in the job. 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) 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 both the following statements are true: Either the step did not previously run, or Control-M/Restart did not recapture a completion or abend code from a previous run. The step was not executed during the RESTART run.

850

Control-M Parameter Guide

Jobs running in z/OS environments

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 would cause a condition that SNRUN could not 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 only indicates that it did not run. For backward compatibility (that is, to ensure that the application of the ***** code remains unchanged), the ***** code 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 additional qualifiers in Table 172 can be used in specific circumstances. Table 172 Qualifiers
Qualifier > < N 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. 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.

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 (for example, >10 <40). 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.

Chapter 7 Post-processing parameters

851

Jobs running in z/OS environments

EXAMPLE
If Step1 ends with a condition code of C0004 and Step 5 ends with system abend code S0C4, perform the indicated Shout. On Statement PGMST= Step1 PROCST= Codes=C0004 AND On Statement PGMST= Step5 PROCST= Codes=S0C4 Do Shout To=emuser Urgn=Regular Msg= Backup operations ...

Aliases for other Control-M components

Alternate names for the On statement are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities e-Trigger Control-M/EM API Parameter Name ON -on on_do_statement on_statement

Alternate formats for other Control-M components

Alternate formats for the On parameter are listed below.
Component Control-M/EM Utilities Parameter name ON is composed of the STMT, CODE, PGMS, PROCS, and AND_OR subparameters. STMT is a 1-132 character string, used only when you are specifying an On statement value. Control-M/EM API on_statement is composed of the following subparameters:

and_or code procedure_step program_step statement

852

Control-M Parameter Guide

Reten Days

Reten Days
Number of days to retain the job in the History Jobs file. For z/OS jobs only.

NOTE
At sites that do not use the History Jobs file, this parameter is not relevant and is not displayed.

Format
Usage Format Optional 001 - 999 days. Note: When the Reten Days field is left blank, History Jobs file information is kept as specified by the Reten Gen parameter. For more information, see Reten Gen on page 855. AutoEdit Support No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Reten Gen Reten Days cannot be specified when Reten Gen is specified. Note: When specifying a value for RETENTION: # OF DAYS TO KEEP (Reten Days) from the Control-M for z/OS interface, leave RETENTION: # OF GENERATIONS TO KEEP blank.

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. Using Reten Days you can specify a fixed number of days to keep the job in the History Jobs file. Once the specified number of days is reached, the job is automatically deleted from the History Jobs file during the next New Day processing. Reten Days and Reten Gen are mutually exclusive. A value can be specified for either, but not both.

Chapter 7 Post-processing parameters

853

Reten Days

NOTE
When changing job criteria from Reten Days to Reten Gen (or the reverse), 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 table, 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.)

Aliases for other Control-M components

Alternate names for the Reten Days parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name RETEN_DAYS RETEN DAYS RETENTION: # OF DAYS TO KEEP reten_days

854

Control-M Parameter Guide

Reten Gen

Reten Gen
Maximum number of generations of the job to keep in the History Jobs file. For z/OS jobs, only.

NOTE
At sites that do not use the History Jobs file, this parameter is not relevant and is not displayed.

Format
Usage Format Optional. 00 - 99 generations. Note: When the Reten Gen field is left blank, History Jobs file information is kept as specified by the Reten Days parameter. For more information, see Reten Days on page 853. AutoEdit Support No. An AutoEdit variable or expression cannot be specified as all or part of the value for this parameter.

Related parameters
Reten Days Reten Gen cannot be specified when Reten Days is specified. Note: When specifying a value for RETENTION: # OF GENERATIONS TO KEEP (Reten Gen) from the Control-M for z/OS interface, leave RETENTION: # OF DAYS TO KEEP blank.

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. Reten Gen 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. Reten Days and Reten Gen are mutually exclusive. A value can be specified for either, but not both.

Chapter 7 Post-processing parameters

855

Reten Gen

NOTE
When changing job criteria from Reten Days to Reten Gen (or the reverse), 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 table, 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.)

Aliases for other Control-M components

Alternate names for the Reten Gen parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name RETEN_GEN RETEN GEN RETENTION: # OF GENERATIONS TO KEEP reten_gen

856

Control-M Parameter Guide

Step Range

Step Range
Specifies a range of steps in the steps of an On PGMST statement.

NOTE
For z/OS jobs only.

Format
Usage Format Optional Consists of the Name, From, and To subparameters described below.

Related parameters
On statement Specifies a range of steps within an On parameter statement. Specific actions can be associated with the specified range of steps, instead of the full range specified in the On parameter statement.

Chapter 7 Post-processing parameters

857

Step Range

Subparameters
Name From Name for the range. 1through 7 characters. Only trailing blanks are allowed in this field. 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: //pgmstep EXEC PGM= pgmname procstep is the step name in the EXEC statement that invokes the procedure: // procstep EXEC procname pgmstep values and procstep values can each be from 1 through 8 characters in length, and must not contain blanks. Non-English characters not allowed. To Last pgmstep or pgmstep,procstep in the range. Note: The To subparameter is optional. If blank, its value defaults to the last step in the job. Non-English characters not allowed. For more information, see the note for the From subparameter.

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. Any number of step ranges can be specified. After entering a Step Range parameter, another Step Range parameter line is automatically displayed.

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 Control-M for z/OS RESTART, RECAPTURE CONDITION or ABEND CODES parameters. Control-M/Restart searches previous runs to determine which steps must be considered part of the restarted job.

858

Control-M Parameter Guide

Step Range

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 Control-M for z/OS ALLRUNS parameter in the CTRPARM member be set to YES. When activated, this facility may apply to any specified step, step range, or to the +EVERY step value.

Aliases for other Control-M components

Alternate names for the Step Range parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name STEP_RANGE Composed of the FROM PGMST, FROM PROCS TO PGMSTEP, and TO PROCSTEP parameters. STEP RANGE step_range

Alternate formats for other Control-M components

Alternate formats for the Step Range parameter are listed below.
Component Control-M/EM Utilities Parameter Name STEP_RANGE is composed of the following parameters: NAME FPGMS FPROCS TPGMS TPROCS Control-M for z/OS 1-7 character string. First program step in the range. 1-8 character string. First process step in the range. 1-8 character string. Last program step in the range. 1-8 character string. Last process step in the range. 1-8 character string. Equivalent to Name. First program or process step in the range. 1-8 character string. Last program or process step in the range. 1-8 character string.

STEP RANGE consists of the following subparameters STEP RANGE FR (PGM,PROC) TO

Chapter 7 Post-processing parameters

859

Step Range

Example 1: Control-M/EM Job Editing Form

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.

Example 2: Control-M for z/OS interface

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.
JOB: PRDKPL01 LIB CTM.PROD.SCHEDULE TABLE: PRODKPL COMMAND ===> SCROLL===> CRSR +-------------------------------------------------------------------------+ =========================================================================== OUT AUTO-ARCHIVE Y SYSDB Y MAXDAYS MAXRUNS RETENTION: # OF DAYS TO KEEP 030 # OF GENERATIONS TO KEEP SYSOUT OP (C,D,F,N,R) FROM MAXRERUN RERUNMEM INTERVAL 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 IS RERUN DO ON PGMST PROCST CODES A/O DO SHOUT WHEN TO URGN MS ======= >>>>>>>>>>>>>>>>>>> END OF SCHEDULING PARAMETERS <<<<<<<<<<<<<<<< ===== COMMANDS: EDIT, DOC, PLAN, JOBSTAT 11.17.00

860

Control-M Parameter Guide

Step Range

Chapter 7 Post-processing parameters

861

Step Range

862

Control-M Parameter Guide

Chapter

Job Output parameters

The parameters in this section determine what to do with the data resulting from a job run. Table 173 Job Output parameters summary
Parameter Auto-Archive Shout SYSOUT Handling Description Determines whether SYSDATA (job output) is to be archived. Specifies messages to be sent (shouted) to various destinations on various occasions. Specifies how the jobs log should be handled after the job completes with a completion status of OK.

Chapter 8 Job Output parameters

863

Auto-Archive

Auto-Archive
The Auto-Archive parameter determines whether SYSDATA (job output) should be archived.

NOTE
The Auto-Archive parameter is relevant only for jobs to be run in z/OS environments or OpenVMS computers. The parameter is displayed only if Control-R is selected in the Control-M Definition window in Control-M/Desktop.

Format
Usage Format Optional Check box in the Control-M/EM Job Editing form.

When this check box is selected, job output is archived. When this check box is cleared, job output is not archived. In this case, Control-R cannot restart the job, and SYSDATA viewing under Control-M for z/OS is not possible.

When the Auto-Archive check box is selected, the subparameters described below can also be specified. AutoEdit No. An AutoEdit variable or expression cannot be specified as all or part of the Support value for this parameter.

Subparameters
Parameter SYS DB Description A check box in the Control-M/EM Job editing form:

If this check box is selected, a single data set is used for archiving the SYSDATA of all jobs until it is full. When the first archive data set is full, another SYSDATA data set is allocated and used. BMC Software recommends this method. If this check box is cleared, a separate data set is created for the SYSDATA of each job run.

Max Days...

A number from 00 through 99. Indicates the maximum number of days to retain the SYSDATA archive data set for jobs that ended NOTOK. Indicates the maximum number of job runs to retains the SYSDATA archive data set for jobs that ended NOTOK. Valid values: a number from 00 through 99 blank (there is no maximum number of job runs)

Max Runs...

864

Control-M Parameter Guide

Auto-Archive

General information
The Auto-Archive parameter enables you to decide whether to archive job output (SYSDATA). SYSDATA refers to all information in the job log, the expanded JCL (job script), and to the output messages of the job. 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. BMC Software recommends that you select the SYSDB check box. BMC Software does not recommend creating a separate data set for each run because:

Creating many data sets consumes a large amount of space in the disk VTOC. 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.

When archiving SYSDATA, BMC Software recommends that value 99 not be specified for the Max Wait parameter for cyclic jobs or started tasks. Otherwise, these jobs, which are never automatically deleted from the Active Jobs file, can cause the disk to fill up with unnecessary archived SYSDATA. For more information, see Max Wait on page 733.

NOTE
Specified parameters take effect only during execution of the New Day procedure (CONTDAY) or the Control-M CTMCAJF utility. Therefore, it is possible to find more generations of the same job than the current value of Max Runs.

Whenever a job is deleted from the Active Jobs file and does not reside in the History file, its SYSDATA is deleted regardless of Max Days or Max Runs. The Max Days and Max Runs parameters define retention criteria for the archived SYSDATA of jobs that ended NOTOK. Defaults for these parameters are defined using Control-M/Restart installation parameters. Max Days and Max Runs values in a job definition are used to override the Control-M/Restart defaults. If both parameters are specified, retention is limited by the parameter that is satisfied first.

Computer-specific information
The Auto-Archive parameter is relevant only for jobs to be run in z/OS environments or OpenVMS computers.

Chapter 8 Job Output parameters

865

Auto-Archive

Aliases in other Control-M components

Alternate names for the Auto-Archive parameter are listed below.
Component Control-M/EM Utilities Reporting Facility Control-M for z/OS Control-M/EM API Parameter Name AUTOARCH AUTO ARCHIVE AUTO-ARCHIVE auto_archive sys_db arch_max_days arch_max_runs

Control-M for z/OS Utilities AUTOARC

866

Control-M Parameter Guide

Shout

Shout
The Shout parameter gives you the ability to create a message that may be sent (shouted) to one or more specified destinations when certain conditions are encountered.

Format
Usage Format AutoEdit Support Optional The Shout parameter consists of the subparameters described in Table 174 on page 868. Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

Related parameters
Parameter Do Shout Description The Do Shout parameter specifies a message to be sent (shouted) to a destination when the On Statement/Code criteria are satisfied. For more information, see Do Shout on page 823.

Chapter 8 Job Output parameters

867

Shout

Subparameters
Table 174
Parameter When

Shout subparameters
Format States what should cause the Shout message to be sent. Choose one of the following values:

Exectime Send the message if the jobs elapsed runtime is outside a specified limit. The limit is specified in the Time field. A limit can be expressed as the actual elapsed minutes of the job run, or as a deviation from the jobs (statistical) average runtime. The limit for Exectime can be expressed in any of the following formats: >n The message is sent if the elapsed runtime of the job is greater than n minutes. in z/OS environments, n is a number from 0 through 999. On other computers, n is a number from 1 through 999. <n The message is sent if the elapsed runtime of the job is less than n minutes. n is a number from 1 through 999. +n The message is sent if the elapsed runtime of the job exceeds its average execution time by at least n minutes. n is a number from 1 through 999. +n% The message is sent if the elapsed runtime of the job exceeds its average execution time by at least n%. n is a number from 1 through 900. -n The message is sent if the elapsed runtime of the job is at least n minutes less than its average execution time. n is a number from 1 through 999. -n% The message is sent if the elapsed runtime of the job is at least n% less than its average execution time. n is a number from 1 through 99. Note: A job processing definition can contain more than one Shout parameter with a When of Exectime. For more information, see examples of the use of Exectime below.

Late Sub Send the message if the job is still not submitted and cannot be submitted at the time specified in the accompanying Parm (time) field. Specify the time in hhmm format. (In Control-M for z/OS, you can alternatively specify an * for the time; this results in use of the jobs calculated DUE IN time to determine if the job was not submitted on time.) By default, a valid time must be in the range of 00:00 through 23:59. However, if Time Synonym (in Tools/Options) is checked, a valid time must be in the range from NewDay time until NewDay Time-plus-23:59. For example, if New Day time is 8:00 A.M., the range of valid times is from 08:00 until 31:59. The message is sent only if the job is actually not submittable. That is, if a runtime criterion (in condition, quantitative resource, and so on) is not met at the given time. However, if a job is ordered after the specified time but starts running immediately because it meets all runtime criteria, the Late Sub parameter doesn't apply.

868

Control-M Parameter Guide

Shout

Table 174
Parameter When continued

Shout subparameters
Format

Late Time Send the message if the job does not finish executing by the time specified in the accompanying Parm (time) field. In Control-M for z/OS, this parameter appears as LATE. Specify the time in hhmm format. (In Control-M for z/OS, you can alternatively specify an * for the time; this results in use of the jobs calculated DUE OUT time to determine if the job is late.) By default, a valid time must be in the range of 00:00 through 23:59. However, if Time Synonym (in Tools/Options) is checked, a valid time must be in the range from New Day time until New Day Time-plus-23:59. For example, if New Day time is 8:00 A.M., the range of valid times is from 08:00 until 31:59. Note: No message is sent if the job is being rerun.

NOTOK Send the message if the job terminates with a completion status of NOTOK. OK Send the message if the job terminates with a completion status of OK. RERUN Send the message if the jobs completion status was set to Rerun (not valid for SMART Tables).

Parm

Used to specify additional parameters required for the When options Exectime, Late Sub, and Late Time.

Chapter 8 Job Output parameters

869

Shout

Table 174
Parameter

Shout subparameters
Format

Days Offset Sets the number of days relative to the ODAT by which the sending of the Shout message is offset. The value of this parameter is relevant only for the LateTime and LateSub parameters (see Late Sub). [Only for jobs running under Control-M for z/OS version 6.2.00 or later.] Valid values: a number from 0 through 120 blank no offset. If the Parm (time) value is *, leave this field blank. To Logical destination of the Shout message. Mandatory. Destination is the name of an entry in the Shout Destination table. Computers other than z/OS: Valid values a user logged onto the Control-M installation a users mail in the Control-M installation a specific terminal system console alerts window in all Control-M/EM workstations connected to the specified Control-M installation Note: The Control-M/EM workstations to which an alert is issued may be limited by user authorizations. For more information, see the security chapter in the Control-M Administrator Guide. Control-M log All Shout messages are recorded in the Control-M log. Select the log as a destination only when you do not wish to send the message to an additional destination. Length Case Sensitive 1 through 16 characters Yes

870

Control-M Parameter Guide

Shout

Table 174
Parameter To continued

Shout subparameters
Format Invalid Characters AutoEdit Support Blanks; single quotation marks Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

z/OS: The following are valid values for Destination: U-userid Writes the message to the IOA Log file userid is a user ID consisting of 1 through 8 characters but containing no blanks OPER [-n] Sends a scrollable 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). For more information regarding route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102. OPER2[-n] Sends an unscrollable 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). For more information regarding route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.

Chapter 8 Job Output parameters

871

Shout

Table 174
Parameter

Shout subparameters
Format Where logonid is one of the following: a valid logon identity consisting of 1 through 7 characters a valid group identity found within the IOA Dynamic Destination Table An optional second value, indicating the computer or node of the TSO logonid, can be specified, as follows: Under JES2: ;Nn, ;Mm or ;NnMm, where m is the ID of the computer in JES2 (not the 4-character SMF system ID) n is the 1- to 2-character JES/NJE node ID Under JES3: Lname, where Lname is the logical JES name of the computer (that is, the name as used in the JES3 command *T, not the SMF system ID) Note: A Shout to a TSO user preforms a TSO SEND command, which may require authorization at the receiving end. U-M: mail_ name_ prefix U-EM Sends a message to the recipient identified by mail_name_prefix, a mail name prefix consisting of 1 through 12 characters (z/OS platform: 1 through 8 characters) Sends a message that is displayed in the Control-M/EM Alerts window

Destination TSO - logonid or continued T - logonid

Urgency

Urgency of the Shout message directed to the Alerts window. Urgency assigned to the Shout message affects the appearance of the message in the Alerts window. Urgency levels are: R - Regular (Default) U - Urgent V - Very Urgent

Message

Text of the Shout message. Length Case Sensitive Invalid Characters AutoEdit Support 1 through 255 characters z/OS: 1 through 70 characters Yes None Yes. The message can include AutoEdit variables, including any combination of text, Control-M system variables, job submission variables and User variables (created using the AutoEdit Assignment parameter). However, the length of the message after decoding cannot exceed the length specified above. For more information, see Chapter 15, Control-M AutoEdit facility.

General information
A Shout message is a message sent to one or more destinations when the condition specified by the When parameter is satisfied.

872

Control-M Parameter Guide

Shout

The Do Shout parameter (described in Do Shout on page 823) can be used to issue Shout messages conditioned by an On Statement/Code parameter. Shout messages can also be issued from the data center using the CTMSHOUT utility. For more information, see the Utilities chapter in your Control-M Administrator Guide. When Exectime values are specified with a + or sign (that is, when elapsed runtime is compared to average runtime), the Shout applies only if there are current statistics data for the job (containing statistics for at least one of the last 20 runs of the job). If current job statistics data 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 no job statistics data exist, or if the data is not current (there are no elapsed-time statistics for any of the last 20 job runs), the Shout parameter is not applied.

More about Exectime

The following additional considerations apply to the use of Exectime:

When Exectime values are negative (for example, -n; -n%), the check can be performed only after the job has finished running. When Exectime values are positive (for example, +n; +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. Relative Exectime limits should not exceed 24 hours. When relative Exectime limits exceed 24 hours (that is, 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 (for example, the job is Held, the parameters changed, and the job then Freed), the Exectime value is ignored.

More about destinations

When the destination is a user, the message is also sent to the users mail. If not found in the Shout Destination table, the destination is assumed to be a user name. In this instance, the Shout message is sent to the users terminal and the users mail. The Shout Destination table is maintained by the Control-M administrator. Several such tables may exist. Each table contains the same logical destinations, but the physical (actual) destinations can vary from table to table.

Chapter 8 Job Output parameters

873

Shout

Only one table is in use (active) at any time, as determined by the administrator. A Shout message sent to a logical destination is directed by Control-M to the corresponding physical destination listed in the active Shout Destination table.

Availability For z/OS jobs

Cyclic jobs cannot contain the Shout When Rerun parameter.

Aliases in other Control-M components

Alternate names for the Shout parameter are listed below.
Component Control-M/EM Utilities Control-M/Server Utilities Control-M for z/OS Control-M/EM API Parameter Name SHOUT -shout SHOUT shout

Example 1: Sends Shout message to a specified user when job ends OK

Shout Statements:
When OK Destination SHIFTMNGR Urgency R Message NIGHTSHIFT RUN COMPLETED

The message is sent to Control-M logical destination SHIFTMNGR.

Example 2: Sends Shout message to Control-M/EM when job terminates NOTOK

If the job terminates with a status of NOTOK, send a message to Control-M/EM, indicating the completion code: Shout Statements:
When NOTOK Destination EM Urgency U Message Job NOTOK Completion code=%%COMPSTAT

The message is sent to the Control-M/EM Alerts window.

874 Control-M Parameter Guide

Shout

Example 3: Sends Shout message when job runtime is less than expected
Given that a job whose average run time is 50 minutes completes in 40 minutes. The job processing definition contains a Shout statement with When Exectime. The following table indicates which Time parameter values would and which would not cause a Shout message to be issued:
Shout Message Issued >39 <41 -10 -20% Shout Message Not Issue >40 <40 -11 -21%

Example 4: No Shout message although job runtime is more than expected

Given that a job whose average run time is 50 minutes completes in 90 minutes. The job processing definition contains a Shout statement with When Exectime. The following table indicates which Time parameter values would and which would not cause a Shout message to be issued:
Shout Message Issued >89 <91 +41 +79% Shout Message Not Issue >90 <90 +40 +80%

Chapter 8 Job Output parameters

875

SYSOUT Handling

SYSOUT Handling
The SYSOUT Handling parameter indicates how the jobs log file (SYSOUT) should be handled after the job ends with a status of OK.

Format
Usage Optional Note: This parameter is sometimes referred to as the Option and Prm parameters. Format List box in the Job Editing form. Valid values:

None Change job class (z/OS only) Delete output Copy output Move output Release for printer

Each value is described in detail in Table 175. For most of these options, a second field is displayed. This second field is sometimes referred to as the Prm parameter. The format of the Prm parameter is as follows: Length Computers other than z/OS: Up to 255 characters. z/OS: Up to 44 characters, as follows:

File Name (Copy): up to 44 characters New Class Name (Change job class): 1 character New Destination (Move): up to 8 characters

Case sensitive Yes Invalid Characters AutoEdit Support Blanks Yes. An AutoEdit variable or expression can be specified as all or part of the value for this parameter.

NOTE
Some SYSOUT Handling options (those that are selected from the SYSOUT Handling list) require you to supply additional input. When such an option is selected from the PostProc panel, an additional text box is be displayed. The label for this text box is different for each SYSOUT Handling option that is selected. When an additional text box is displayed, enter the appropriate information in it.

876

Control-M Parameter Guide

SYSOUT Handling

Table 175 SYSOUT Handling formatting

Value Delete Copy Description Deletes the log file. Copies the log file. Note: SYSOUTs should not be copied to a Control-M internal directory or subdirectory (for example, a subdirectory underneath the SYSOUT directory). Specify the log file name and full path to which the log file must be copied in the File Name text box. The following can occur: Log file name Specified Specified Full path Specified Remark The log file is copied as specified in the File Name text box.

Not specified The log file is copied to the job owners home directory using the file name specified. For jobs executed on remote hosts, the log file is copied to the agent home directory through which the job was submitted. However, the file is not copied if WMI protocol is used. Specified The log file is copied to a default file name determined according to the considerations below, to the full path specified.

Not specified

Not specified

Not specified The log file is copied to the job owners home directory using the default file name determined according to the considerations below. For jobs executed on remote hosts, the log file is copied to the agent home directory through which the job was submitted

File name considerations For Microsoft Windows: <Mem_Name>|<Job_Name>_<order_num>_<rerun_num>.DAT For OpenVMS: <Mem Name>.TXT For UNIX: <Mem_Name>|<Job_Name>.LOG<order_num>.<rerun_num> For OS/2, the full path name must be specified.

Chapter 8 Job Output parameters

877

SYSOUT Handling

Table 175 SYSOUT Handling formatting

Value Copy (continued) Description File name considerations (continued) Special notes for iSeries (AS/400) computers: This second field is mandatory. It indicates the database file to which the job log is copied. The file must be specified in one of the following formats: library/file *LIBL/file file

If the specified file does not exist, it is created. The job log is placed in the file as member CM<AS/400_Job Number> (the first line of the member contains details that identify the job). If the specified file already exists, and its record length is 132 or more, the job log is placed in the file as a new member identified as above. If the specified file already exists, and its record length is less than 132, the job log is truncated and placed in the file as a new member identified as above.

Release

Releases the log file for printing on the specified printer/output queue. A second field is displayed for the printer queue to which the log file should be released. Note: The default printer/output queue and the SYSOUT directory are determined by Control-M system parameters on each computer. For more information, see your Control-M administrator. Special notes for iSeries (AS/400) computers:

If an output queue is not specified, the output of the job is sent to the queue specified by the Control-M Default Output Queue system parameter. The name of the output queue must be specified in one of the following formats: library/outq *LIBL/outq outq

If outq (without library) or *LIBL/outq is specified, the specified outq is taken from the *LIBL (Library list) of Control-M. If the specified outq is not found in the Library list, the Release option is not executed. If library/outq is specified, the output queue is taken from the specified library. If the specified outq is not found in the specified library, the Release option is not executed.

878

Control-M Parameter Guide

SYSOUT Handling

Table 175 SYSOUT Handling formatting

Value Move Description Moves the log file and deletes it from the Control-M SYSOUT directory. The New Destination text box is displayed for the location to which the log file should be moved. Note: SYSOUTs should not be moved to a Control-M internal directory or subdirectory (for example, a subdirectory underneath the SYSOUT directory). Specify the log file name and full path to which the log file must be moved in the File Name text box. The following can occur: Log file name Specified Specified Full path Specified Remark The log file is moved as specified in the File Name text box.

Not specified The log file is moved to the job owners home directory using the file name specified. For jobs executed on remote hosts, the log file is moved to the agent home directory through which the job was submitted. Specified The log file is moved to a default file name determined according to the considerations below, to the full path specified.

Not specified

Not specified

Not specified The log file is moved to the job owners home directory using the default file name determined according to the considerations below. For jobs executed on remote hosts, the log file is moved to the agent home directory through which the job was submitted

File name considerations For Microsoft Windows: <Mem_Name>|<Job_Name>_<order_num>_<rerun_num>.DAT For OpenVMS: <Mem Name>.TXT For UNIX: <Mem_Name>|<Job_Name>.LOG<order_num>.<rerun_num> For OS/2, the full path name must be specified.

Chapter 8 Job Output parameters

879

SYSOUT Handling

Table 175 SYSOUT Handling formatting

Value Move (continued) Description File name considerations (continued) For iSeries (AS/400) and UNISYS computers: The second field indicates the outq (output queue) to which the job log spool file should be moved.

If an output queue is not specified, the job log spool file is moved to the queue specified by the Control-M Default Output Queue system parameter. The name of the output queue must be specified in one of the following formats: library/outq *LIBL/outq outq If outq (without library) or *LIBL/outq is specified, the specified outq is taken from the *LIBL (Library list) of Control-M. If the specified outq is not found in the Library list, the Move option is not executed. If library/outq is specified, the output queue is taken from the specified library. If the specified outq is not found in the specified library, the Move option is not executed.

Change Jobs Class

Changes the class of job output. [z/OS only] The New Class Name text box and From Class text box are displayed. Enter the new class name (1 character) in the text box (Mandatory). An asterisk (*) indicates the jobs original MSGCLASS. Optionally, you can specify a class in the From Class text box. If a class is specified, SYSOUT Handling is limited to only SYSOUTs from the specified class.

Related parameters
Parameter Do Sysout Description The Do SYSOUT parameter specifies how the jobs output should be handled when the On Statement/Code criteria are satisfied. For more information, see Do Sysout on page 826.

880

Control-M Parameter Guide

SYSOUT Handling

Parameter RJX_COPY_ SYSOUT_ REMOTE

Description Determines where the SYSOUT handling operations of Copy, Move, and Delete are performed, either on the Agent or the remote host. Valid values: Y, N Default: N

RJX_KEEP_SYS Determines if the SYSOUT file is to be deleted from remote host OUT computers. Valid values: Y, N Default: N

General information
SYSOUT Handling is specified in the Postproc panel of the Job Editing form. If no SYSOUT handling is specified (or the job does not end OK), and no Do Sysout statement (in the On Statement/Code parameters) is activated, the jobs log file is placed in the location determined by Control-M until it removed by the New Day procedure.

NOTE
Note: The CONTROL-M Automatic Log Copy system parameter is not affected in any way by specified SYSOUT Handling.

Aliases in other Control-M components

Alternate names for the SYSOUT Handling parameter are listed below.
Component Reporting Facility Parameter Name SYSOUT Handling is composed of two sub parameters: SYSOPT PARM Equivalent to the SYSOUT handling text box. Equivalent to the variously-named text boxes that are displayed when specific SYSOUT Handling options are chosen.

Control-M/Server Utilities Control-M for z/OS

-SYSOUT SYSOUT

Chapter 8 Job Output parameters

881

SYSOUT Handling

Component Control-M/EM API

Parameter Name SYSOUT handling is composed of three subparameters: sysout_from_ class sysout_option sysout_ parameter Equivalent to From Class Equivalent to Option. Equivalent to Parameter.

Formats in other Control-M components

Alternate formats for the Auto-Archive parameter are listed below.
Component Reporting Facility Format The values for SYSOPT and PARM are strings. <option>

Control-M/Server Utilities Two values are supplied for -SYSOUT: RELEASE DELETE COPY MOVE

<parameter>

The appropriate value, depending on the <option> value specified. String.

882

Control-M Parameter Guide

SYSOUT Handling

Component Control-M for z/OS

Format SYSOUT is composed of the following subparameters: OP Type of SYSOUT handling to perform. Mandatory. Valid values are:

C Change the class of the job output. [z/OS, only.] D Delete the job output. F Copy the job output to file. N Change the destination of the job output. R Release the job output.

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:

F File name. String comprised of from 1 through 44 characters. All characters are valid except blanks. C New class (1 character). Any character is valid except blank, but an asterisk (*) indicates the original MSGCLASS of the job. N New destination (1 through 8 characters). All characters are valid except blanks.

FRM

1-character value that identifies the class of job output to process. Selected when C is the value of OPT. [z/OS, only.] Optional. Note: If a FRM class is not specified, all SYSOUT classes are treated as a single, whole unit.

Examples
All of the following examples presume a job completion status of OK.

Example 1: Release the Log file to the default printer

Sysout Handling Option: Release

Example 2: [iSeries (AS/400)] Release the Log file to the specified output queue
Sysout Handling Option: Release

Parm: MYLIB/MYOUTQ

Chapter 8 Job Output parameters

883

SYSOUT Handling

Example 3: OpenVMS and UNIX: Move the Log file

Move the log file to a file called test.log in the job owners home directory.
Sysout Handling Option: Move

Parm: test.log

Example 4: UNIX: Copy the Log file to a directory

Copy the log file to a directory called prg2/test/. Use the default file name.
Sysout Handling Option: Copy

Parm: prg2/test/

Example 5: UNIX: Copy the Log file to a file

Copy the log file to a file. The name of the log file is determined by the Job Name.
Sysout Handling Option: Copy

Parm: prg2/%%JOBNAME

884

Control-M Parameter Guide

Chapter

Status parameters
The parameters in this section describe information that is collected as the result of a job run. They have the following common characteristics:

These parameters are accessible only from the active environment. Most of the values for these parameters are supplied by Control-M, and many cannot be modified by the user. Most parameters are displayed in CONTROL-M/EM in the Active panel of the Job Editing form. These parameters can be used as filter criteria for selecting job definitions using the CONTROL-M/EM utilities and the Reporting facility. Their values can be displayed in reports generated by the Reporting facility.

See also: Status parameters summary

Status parameters summary

The status parameters are summarized in Table 176. Table 176
Parameter Average Run Time Current Status Deleted

Status parameters summary

Description Average time taken, in minutes, for the job to run. This statistic is compiled from the last successful runs of the job. Indicates the completion status of the job (for example, Ended Not OK). Indicates if the job was deleted.

Chapter 9 Status parameters

885

Status parameters summary

Table 176
Parameter Due In

Status parameters summary

Description Time and day at which the next run of the job should start executing. + num days The number of days that the start of job execution is extended after the ODAT. This subparameter is relevant only for jobs running under Control-M for z/OS version 6.2.00 or later. HHMM, where HH is a 2-digit number from 00 through 24. The number of days that the end of job execution is extended after the ODAT. This subparameter is relevant only for jobs running under Control-M for z/OS version 6.2.00 or later.

Due Out

Time and day by which the next run of the job should stop executing. Format + num days

Elapse End Time From Proc From Step Hold Job ID Next Time NJE

Length of time (in minutes) that the job is expected to run. Indicates the time that the last run of the job ended. For z/OS jobs only with Control-M/Restart: Procedure step from which the job should be rerun. For z/OS jobs only with Control-M/Restart: Step from which the job should be rerun. Indicates if the job is currently being held. Unique serial number assigned to the job by the Control-M server. Indicates the next time that the job runs. For reruns or cyclic jobs that use the Interval option. Indicates that the job was sent for execution to a computer that is connected to Control-M through NJE (the node does not have a shared spool with Control-M). Node ID of the NJE terminal. Indicates how many times the job was run. Indicates if the job was restarted. Number of times Control-M has looked for the job. Standard deviation from the average runtime. This statistic is compiled from the last successful runs of the job. Indicates the time that the last run of the job started. For z/OS jobs only with Control-M/Restart: Procedure step until which the job should be rerun. For z/OS jobs only with Control-M/Restart: Step until which the job should be rerun.

NJE Node Rerun Counter Restart Search Count Standard Deviation Start Time To Proc To Step

886

Control-M Parameter Guide

Chapter

10

10

SAP parameters
The parameters described in this section are for the Control-M/Control Module for SAP panels and windows available in the Job Editing form when the Control-M/CM for SAP panel is imported into Control-M/EM and Control-M/Desktop. These are as follows:

SAP panel, listed in Table 177 Add ABAP window, listed in Table 178 Add External Program window, listed in Table 179 Add External Command window listed in Table 180 SAP Data Archiving panel, listed in Table 181 SAP-BW (Business Warehouse) panel, listed in Table 182, Table 183, and Table 184.

NOTE
The SAP parameter format is as follows: SAPR3-<parameter_name> SAP parameters that describe an action that can occur more than once in a session are enumerated, as follows. The <nn> below represents a numerical value: SAPR3-<parameter_name><nn>

Certain parameters that are described in this section as Mandatory are mandatory only when using the SAP panel in Control-M/Desktop. When submitting jobs differently, the default value may be used by Control-M/CM for SAP.

NOTE
Certain parameters are displayed in the SAP panels after a job has been submitted. These parameters are for notification purposes only, and have a read-only status.

The parameter descriptions are in alphabetical order.

Chapter 10 SAP parameters

887

Table 177 SAP panel parameters summary

Parameter Account Copy From Step Description The name of the Account. Indicates from which ABAP or External Program step in the original job to begin the copying procedure.

Detect Spawned Jobs A spawned job is a job created by another (parent) job, and which is monitored by Control-M. This parameter indicates whether to detect and monitor jobs that were spawned by the current SAP job. Job Class Job Count Job Mode Job Name Job Type The job submission priority (in SAP). A unique SAP job ID number. Determines the task that the job performs. The name of the job to be monitored or submitted. Read-only fields that indicate the nature of the SAP job in Active job mode. The type is indicated by the check boxes that are selected. Only relevant for jobs extracted by the Extractor process. The name of the newly created job (in copy mode). The Batch Input Session Queue ID number. Relevant only in Batch Input mode. The status of the job in SAP. Relevant only after job submission, while in Active Job Mode. Recipient of the print job. Type of the recipient of the print job. Specifies whether the job should run with the ASAP option immediately after an event The steps (actions) to be performed as part of the SAP job. Specify that a job should only run when there are resources available. The Application Server on which the job runs. The host computer on which the external program runs.

New Job Name QID SAP Job Status Spool List Recipient Spool List Type Start Condition

Output Management The location to which the spool and joblog should be copied.

Steps Step Type Target Group Target Server (1)

Table 178 Add ABAP window parameters

Parameter ABAP Program Archive ID Archive Text Authorization Columns Delete After Print Department Document Type Description The name of the program The SAP ArchiveLink Storage system ID A free text description of the archive location A user with print authorization The maximum number of characters on an output line Indicates whether the report is deleted after printing The spool department The archive object document type

888

Control-M Parameter Guide

Table 178 Add ABAP window parameters

Parameter Event Event Parameter Information Field Job Name Language Layout Name New Spool Request Number of Copies Object Type OS Cover Sheet Output Device Owner Print Archive Mode Print Expiration Recipient Rows SAP Cover Page Time of Print Titles Use ABAP Program Default Variant Name Description The event ID that indicates the event name of the After Event start condition The event parameter for a specific event ID Archive information A read-only field that displays the job name The language of the ABAP step The print layout format The spool list name Indicates whether to request a new spool The number of copies to print The archive object type Type of cover page for output The designated printer logical name The step owner Determines whether the spool of the step is printed to an output device, to the archive, or both The number of days after which the print job expires. The name of the recipient of the job output The maximum number of rows per page The type of cover page for output Indicates whether to print the job output immediately, print the job later, or send the job to the spooler The spool list titles A check box that exists for both the Rows and Columns parameters. Indicates whether the ABAP program default should be used, rather than a number in the Rows or Columns box The Variant name

Selection Cover Page Indicates whether a cover page should be used

Table 179 Add external program window parameters

Parameter Activate Traces External Program Job Waiting for External Termination Log External Errors in Joblog Description Indicates whether SAP activates traces The external program name Indicates whether SAP waits for the external program to end

Indicates whether SAP writes the error in a joblog

Chapter 10 SAP parameters

889

Table 179 Add external program window parameters

Parameter Log External Output to Joblog Parameters Owner Target Host Description Indicates whether SAP writes the output in a joblog The parameters for an external program The step owner The host computer on which the external program runs

Table 180 Add external command window parameters

Parameter Activate Traces External Program Job Waiting for External Termination Log External Errors in Joblog Log External Output to Joblog Operating sys Owner Parameters Target Server (1) Description Indicates whether SAP activates traces The external program name Indicates whether SAP waits for the external program to end

Indicates whether SAP writes the error in a joblog Indicates whether SAP writes the output in a joblog List of operating systems The step owner The parameters for an external program The server on which the external command runs

Table 181 SAP panel for data archiving parameters

Parameter Account Archiving Object Check Sessions Check Variant Description The name of the Account The name of the archiving object in SAP Enables the user to check if an incomplete archiving session exists for a specific archiving object Enables the user to check if a Write job already exists with the specific variant for the archiving object defined for this job The name and path of the file to which the spool should be copied Monitors the spawned jobs of an original SAP job The job submission priority (in SAP) Determines the task that the job performs The name of the job to be monitored or reported For more information, see Table 178 on page 888 Indicates the archiving session number in SAP

Copy Spool To Detect Spawned Jobs Job Class Job Mode Job Name Print Parameters Session Number

890

Control-M Parameter Guide

Table 181 SAP panel for data archiving parameters

Parameter Start Condition Target Server (1) Variant Name Description Specifies that a job should run only when there are SAP resources available The Application Server on which the job runs The name of the Variant

Table 182 SAP-BW General panel parameters

Parameter Account Control-M Job Name SAP-BW Business Process Type Description The name of the Account For more information, see Job Name Determines the task that the job performs. The option selected (Process Chain or InfoPackage) determines which subparameters are available

Table 183 SAP-BW panel, Process Chain parameters

Parameter Process Chain Description Process Chain ID Process Chain Log ID Description Describes a Process Chain A unique BW-generated ID of a Process Chain A unique BW-generated ID for the Process Chain running session. Relevant only after job submission, in Active Job Mode Indicates how the Process Chain should be rerun

Rerun Options

Table 184 SAP-BW panel, InfoPackage parameters

Parameter Background Job Name InfoPackage Description InfoPackage RNR Description The name of the InfoPackage's background job name A description of the InfoPackage. A unique BW-generated ID for the InfoPackage's running session. Relevant only after job submission, in Active Job Mode A unique BW-generated InfoPackage ID The InfoPackages background job count. Relevant only after job submission, in Active Job Mode

InfoPackage Tech. Name Job Count

Chapter 10 SAP parameters

891

ABAP Program

ABAP Program
The name of the ABAP program.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Mandatory Add ABAP window in Create job mode Text box 1-40 characters Uppercase only Special characters not permitted Blanks permitted Variable Name %%SAPR3-STEP-S<nn>-PROGRAM

892

Control-M Parameter Guide

Account

Account
The name of the Account.

Format
Usage Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory Text box 1-30 characters Uppercase only Blanks %%SAPR3-ACCOUNT

General information
This parameter is mapped to the CONTROL-M/EM Owner parameter. The Account is a profile. The remaining parameters are predefined according to the Account, when the Account is created. The Account parameter must be specified for every SAP job.

Chapter 10 SAP parameters

893

Activate Traces

Activate Traces
Indicates whether SAP activates traces.

Format
Usage Availability Format Valid Values Optional Add External Program window or Add External Command window in Create job mode Check box

X: (Selected) - active N: (Cleared) - not active

Default Variable Name

X (Selected) %%SAPR3-STEP-S<nn>-ACTIVATE_TRACE

894

Control-M Parameter Guide

Archive ID

Archive ID
SAP ArchiveLink Storage system ID.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Only enabled if Print Archive Mode is set to Archive or Print & Archive

Format Valid Values Default Case Sensitive Invalid Characters Variable Name XBP Interface

Text box 2 characters ZZ Yes Only trailing blank spaces permitted %%SAPR3-STEP-S<nn>-ARCH_ID This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

Chapter 10 SAP parameters

895

Archive Text

Archive Text
A free text description of the archive location.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Only enabled if Print Archive Mode is set to Archive or Print & Archive

Format Valid Values Case Sensitive Invalid Characters Variable Name XBP Interface

Text box 1-40 characters Yes Blanks %%SAPR3-STEP-S<nn>-ARCH_TEXT This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

896

Control-M Parameter Guide

Archiving Object

Archiving Object
The name of the archiving object in SAP Data Archiving jobs.

Format
Usage Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory Text box 1-10 characters Uppercase only Blanks %%SAPR3-DA_ARC_OBJ

General information
The Archiving Object parameter is only relevant for SAP Data Archiving jobs.

Chapter 10 SAP parameters

897

Authorization

Authorization
User with print authorization.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-12 characters Yes None %%SAPR3-STEP-S<nn>-PRINT_AUTH

898

Control-M Parameter Guide

Background Job Name

Background Job Name

Name of the InfoPackage background job name.

Format
Usage Availability Format Valid Values Optional InfoPackage SAP-BW Business Process Type Text box 1-25 characters Note: The BI_BTCH prefix is automatically added to the beginning of the job name in SAP-BW. If no value is entered, SAP-BW generates a name for the background job Case Sensitive Variable Name No %%SAPR3-BACKJOBNAME Invalid Characters None

Chapter 10 SAP parameters

899

Check Sessions

Check Sessions
Enables the user to check if an incomplete archiving session exists for a specific archiving object. An incomplete archiving session is one for which not all Delete jobs ended successfully.

Format
Usage Availability Format Valid Values Optional Write job mode in the SAP Data Archiving panel Check box

X: (Selected) - perform a check N: (Cleared) - do not perform a check

Default Variable Name

N (Cleared) %%SAPR3-DA_CHECK_SESSIONS

General information
If an incomplete archiving session is found, a message is displayed, and a Data Archiving write job is not created. The Check Sessions parameter is only relevant for SAP Data Archiving jobs.

900

Control-M Parameter Guide

Check Variant

Check Variant
Enables the user to check if a Write job already exists with the specific variant for the archiving object defined for this job.

Format
Usage Availability Format Valid Values Optional Write job mode in the SAP Data Archiving panel Check box

X: (Selected) - perform a check N: (Cleared) - do not perform a check

Default Variable Name

N (Cleared) %%SAPR3-DA_CHECK_VARIANT

General information
If such a Write job is found, a message is displayed, and a new Write job is not created. The Check Variant parameter is only relevant for SAP Data Archiving jobs.

Chapter 10 SAP parameters

901

Columns

Columns
The maximum number of characters in an output line.

Format
Usage Availability Mandatory

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Integer. Any value from 1 through 255. -1 (Use ABAP Program Default check box is selected) Special value indicating that the number of columns is obtained from the ABAP program code.

Format Valid Values

Text box and check box

Default Variable Name

80 %%SAPR3-STEP-S<nn>-PRINT_NUMCOLUMNS

Related parameters
Use ABAP Program Default Indicates whether the ABAP program default should be used, rather than the number in the Columns box. If selected, the variable %%SAPR3-STEP-S<nn>-PRINT_NUMCOLUMNS is set to -1.

902

Control-M Parameter Guide

Copy From Step

Copy From Step

Indicates from which ABAP or External Program step in the original job to begin the copying procedure.

Format
Usage Availability Format Valid Values Default Variable Name Mandatory Copy job mode Text box Integer between 1-99 1 %%SAPR3-START_STEP

Chapter 10 SAP parameters

903

Copy Spool To

Copy Spool To
The name and path of the file to which the spool should be copied.

Format
Usage Format Valid Values Case Sensitive Invalid Characters Variable Name Optional Text box 1-214 characters Yes Blanks %%SAPR3-SPOOL

General information
The Copy Spool To parameter can be specified only for SAP Data Archiving jobs.

NOTE
If *SYSOUT is specified, the spool is copied into the job SYSOUT.

904

Control-M Parameter Guide

Delete After Print

Delete After Print

Indicates whether the report is deleted after printing.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) X: (Selected) - delete after printing N: (Cleared) - do not delete after printing

Format Valid Values

Check box

Default Variable Name

N (Cleared) %%SAPR3-STEP-S<nn>-PRINT_RELEASE

Chapter 10 SAP parameters

905

Department

Department
Spool department.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name XBP Interface

Text box 1-12 characters Yes None %%SAPR3-STEP-S<nn>-DEPT This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

906

Control-M Parameter Guide

Detect Spawned Jobs

Detect Spawned Jobs

A spawned job is a job created by another (parent) job, and monitored by Control-M. This parameter indicates whether to detect and monitor jobs that were spawned by the current SAP job.

Format
Usage Format Valid Values Optional Option buttons and text box, and a read-only check box For %%SAPR3-DETECT_OPTION 1: (No Detection Needed) 2: (Parent (current) Job definition) 3: (A specific Job definition) For %%SAPR3-DETECT_CHILD_JOBNAME

Name of the parent job (for option 2) Name of the specific job (for option 3)

For %%SAPR3-DETECT_CHILD_TABLE

Name of the table in which the parent exists For option 2 or 3 always set the value %%SCHEDTAB

For %%SAPR3-GROUP_ORDID

The Order ID of the SMART Table For option 2 or 3 always set the value %%GROUP_ORDID

For %%SAPR3-DETECT_CHILD_RELEASE

Specify whether to start spawned jobs that have a status of Scheduled. For option 2 or 3, set the following values: Y - Start Spawned Jobs N - Do not start Spawned Jobs

Variable Names

%%SAPR3-DETECT_OPTION %%SAPR3-DETECT_CHILD_JOBNAME %%SAPR3-DETECT_CHILD_RELEASE %%SAPR3-DETECT_CHILD_TABLE

Related Variable

%%SAPR3-GROUP_ORDID

Chapter 10 SAP parameters

907

Detect Spawned Jobs

General information
The following options are available:

No Detection needed: Do not detect spawned jobs of the current job. Detect and Create According to: Parent (current) job definition: Detect spawned jobs of the current job and extract these jobs to Control-M, with identical properties to the parent job. A specific job definition: A field is displayed, in which you can enter a specific SAP-type job name. Detected spawned jobs of the current job are extracted to Control-M with identical properties to the specified (not the current) job.

Important: The specified job must exist in the same table as the current job.

908

Control-M Parameter Guide

Document Type

Document Type
Archive object document type.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Only enabled if Print Archive Mode is set to Archive or Print & Archive

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-10 characters Yes None %%SAPR3-STEP-S<nn>-ARCHIVE_OBJECT

Chapter 10 SAP parameters

909

Event

Event
The event ID that indicates the event name of the After Event start condition.

Format
Usage Availability Format Valid Values Variable Name Related Parameter Mandatory for the After Event start condition Create job mode when the "start after event" start condition is selected. Text box 1-32 characters %%SAPR3-EVENT_ID %%SAPR3-EVENT_PARAM

910

Control-M Parameter Guide

Event Parameter

Event Parameter
The event parameter for a specific event ID.

Format
Usage Availability Format Valid Values Related Parameter Variable Name Optional Create job mode when the "start after event" start condition is selected. Text box 1-64 characters %%SAPR3-EVENT_ID %%SAPR3-EVENT_PARAM

Chapter 10 SAP parameters

911

External Command

External Command
The name of the external command.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Optional Add External Command window in Create job mode Text box 1-128 characters Yes None %%SAPR3-STEP-S<nn>-PROGRAM

912

Control-M Parameter Guide

External Program

External Program
The name of the external program.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Optional Add External Program window in Create job mode Text box 1-128 characters Yes None %%SAPR3-STEP-S<nn>-PROGRAM

Chapter 10 SAP parameters

913

InfoPackage Description

InfoPackage Description
A description of the InfoPackage.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory InfoPackage SAP-BW Business Process Type Text box 1-60 characters Yes None %%SAPR3-InfoPackage_Desc

914

Control-M Parameter Guide

InfoPackage RNR

InfoPackage RNR
A unique BW-generated ID for the InfoPackage's running session. Relevant only in Active Job Mode, after job submission.

Format
Usage Availability Format Variable Name Read-only InfoPackage SAP-BW Business Process Type Read-only text box %%SAPR3-InfoPackage_RNR

Chapter 10 SAP parameters

915

InfoPackage Tech. Name

InfoPackage Tech. Name

A unique BW-generated InfoPackage ID.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory InfoPackage SAP-BW Business Process Type Text box 30 characters Yes None %%SAPR3-InfoPackage_TechName

916

Control-M Parameter Guide

Information Field

Information Field
Archive information.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Only enabled if Print Archive Mode is set to Archive or Print & Archive

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-3 characters Yes None %%SAPR3-STEP-S<nn>-ARCHIVE_INFO

Chapter 10 SAP parameters

917

Job Class

Job Class
The job submission priority (in SAP). The Job Class parameter can be specified for both SAP R/3 jobs and SAP Data Archiving jobs.

Format
Usage Availability Mandatory

Create job mode Write job mode in the SAP Data Archiving panel A - most urgent B - urgent C - least urgent For SAP R/3 jobs: C For SAP Data Archiving jobs: A

Format Valid Values

List

Default

Variable Name XBP Interface

%%SAPR3-JOBCLASS The A and B values of this parameter are only functional in one of the following

XBP 2.0 XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

918

Control-M Parameter Guide

Job Count

Job Count
A unique SAP job ID number. In the SAP-BW panel, the Info Package Job Count parameter is relevant only in Active Job Mode, after job submission.

Format
Usage Availability Format Mandatory Copy, Original, or External job mode List for special values Text box for digits Valid Values For %%SAPR3-JOB_COUNT: Job count of a specific job - Specific_Job If this value is set, the value for %%SAPR3-JOBCOUNT must be an 8-digit number.

Special values: - FIRST - FIRST_SCHEDULED - LAST - LAST_SCHEDULED

For %%SAPR3-JOBCOUNT: Job count of a specific job - An 8-digit number Only if Specific_Job is set for the value of or %%SAPR3JOB_COUNT

Special values: The same special value set for or %%SAPR3-JOB_COUNT

Note: In Copy job mode, these parameters can be set for either a specific job, or as one of the special values.

In Original job mode, these parameters can be set for either a specific job, or as either the FIRST_SCHEDULED or LAST_SCHEDULED special values. In External job mode, only a specific job can be set. %%SAPR3-JOB_COUNT %%SAPR3-JOBCOUNT

Variable Names

Chapter 10 SAP parameters

919

Job Mode

Job Mode
Determines the task that the job performs.

Format
Usage Format Valid Values Mandatory Option buttons Valid values for SAP R/3 jobs:

Create - Create and run a new job in SAP - CREATE Original - Run an existing job in SAP - RUN_ORG Copy - Copy an existing job in SAP and run the new job - RUN_COPY External - Monitor the status of a job that runs in SAP - EXTERNAL Batch Input - Run a Batch Input session - BATCHINPUT

Valid values for SAP Data Archiving jobs:

Write - Create and run a Data Archiving Write job - DA_WRITE Detect Delete - Detect a Data Archiving Delete job created in SAP - DA_DETECTOR The %%SAPR3-DA_JOB_TYPE parameter should be set to DELETE. Detect Store - Detect a Data Archiving Store job created in SAP - DA_DETECTOR The %%SAPR3-DA_JOB_TYPE parameter should be set to STORE.

Variable Name Related Variable

%%SAPR3-JOB_MODE %%SAPR3-DA_JOB_TYPE

The Job Mode parameter must be specified for both SAP R/3 jobs and SAP Data Archiving jobs. For SAP-BW jobs, see SAP-BW Business Process Type on page 948.

920

Control-M Parameter Guide

Job Name

Job Name
The name of the job to be monitored or submitted (in Batch Input job mode also called Map Name).

Format
Usage Format Valid Values Case Sensitive Invalid Characters Variable Name Related Variable Mandatory Text box 1-32 characters No None %%SAPR3-JOBNAME %%SAPR3-JOB_COPY_TARGET_VAL

General information
This parameter is mapped to the CONTROL-M/EM Job Name parameter.

Chapter 10 SAP parameters

921

Job Type

Job Type
Read-only fields that indicate the nature of the SAP job in Active job mode. The type is indicated by the check boxes that are selected. Only relevant for jobs extracted by the Extractor process.

Format
Usage Availability Format Valid Values Mandatory Active job mode Check boxes and text boxes

Extracted - An SAP job extracted from SAP to Control-M by the Extractor process for monitoring and managing purposes Intercepted - A job that was intercepted by SAP, extracted to Control-M by the Extractor process, activated by CONTROL-M/Enterprise Manager, and is now being monitored in Control-M Spawned - A job that was created in SAP by a job created or monitored in Control-M, extracted from SAP by the Extractor process and is now being monitored in Control-M - Parent Name - If the job type is Spawned, the name of the parent job is displayed in this field. - Parent ID - If the job type is Spawned, the SAP job count of the parent job is displayed in this field.

XBP Interface

These parameters are functional only in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

922

Control-M Parameter Guide

Job Waiting for External Termination

Job Waiting for External Termination

Indicates whether SAP waits for the external program to end before starting the next step, or before exiting.

Format
Usage Availability Format Valid Values Optional Add External Program window or Add External Command window in Create job mode Check box

X: (Selected) - wait N: (Cleared) - do not wait

Default Variable Name

X (Selected) %%SAPR3-STEP-S<nn>-WAIT_FOR_TERM

Chapter 10 SAP parameters

923

Language

Language
The language of the ABAP step.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values

Text box 1 alphanumeric character Example: D for German; d for Serbo-Croatian.

Case Sensitive Invalid Characters

Yes Blanks Special characters

Variable Name

%%SAPR3-STEP-S<nn>-LANGU

924

Control-M Parameter Guide

Layout

Layout
The print layout format.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name XBP Interface

Text box 1-16 characters Uppercase only Blanks %%SAPR3-STEP-S<nn>-PRINT_LAYOUT This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

Chapter 10 SAP parameters

925

Log External Errors in Joblog

Log External Errors in Joblog

Indicates whether SAP logs external errors in the joblog.

Format
Usage Availability Format Valid Values Optional Add External Program window or Add External Command window in Create job mode Check box

X: (Selected) - external errors written in the log N: (Cleared) - external errors not written in the log

Default Variable Name

X (Selected) %%SAPR3-STEP-S<nn>-LOG_STDERR

926

Control-M Parameter Guide

Log External Output to Joblog

Log External Output to Joblog

Indicates whether SAP logs external output in the joblog.

Format
Usage Availability Format Valid Values Optional Add External Program window or Add External Command window in Create job mode Check box

X: (Selected) - output written in the log N: (Cleared) - output not written in the log

Default Variable Name

X (Selected) %%SAPR3-STEP-S<nn>-LOG_STDOUT

Chapter 10 SAP parameters

927

Name

Name
The spool list name.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name XBP Interface

Text box 1-12 characters Uppercase only None %%SAPR3-STEP-S<nn>-LIST_NAME This parameter is functional in one of the following

XBP 2.0 XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

928

Control-M Parameter Guide

New Job Name

New Job Name

The name of the newly created job (in copy mode).

Format
Usage Format Valid Values Variable Name Optional Text box 1-32 characters %%SAPR3-JOB_COPY_TARGET_VAL

Chapter 10 SAP parameters

929

New Spool Request

New Spool Request

Indicates whether to request a new spool.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) X: (Selected) - request a new spool N: (Cleared) - do not request a new spool

Format Valid Values

Check box

Default Variable Name XBP Interface

X (Selected) %%SAPR3-STEP-S<nn>-NEW_LIST_ID This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

930

Control-M Parameter Guide

Number of Copies

Number of Copies
The number of copies to be printed.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Default Variable Name

Text box A three-digit integer between 001-255 001 %%SAPR3-STEP-S<nn>-PRINT_COPIES

Chapter 10 SAP parameters

931

Object Type

Object Type
The archive object type.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Only enabled if Print Archive Mode is set to Archive or Print & Archive

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-10 characters Yes None %%SAPR3-STEP-S<nn>-ARCHIVE_SAPOBJECT

932

Control-M Parameter Guide

Operating sys

Operating sys
Available for external commands. This indicates the operating system.

Format
Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Add External command window in Create job mode List or free text 1-10 characters Yes None %%SAPR3-STEP-S<nn>-OPERSYS

Chapter 10 SAP parameters

933

OS Cover Sheet

OS Cover Sheet
Type of cover page for output.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) D: (Default Setting) - use the default setting from SAP X: (Print) - print the cover page N: (Do Not Print) - do not print the cover page

Format Valid Values

List

Default Variable Name

D %%SAPR3-STEP-S<nn>-PRINT_HOST_BANNER

NOTE
In SAP 4.6D, this parameter can return different values, depending on specific SAP userdefinitions. This is a known SAP problem.

934

Control-M Parameter Guide

Output Device

Output Device
The logical name of the designated printer.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-4 characters Uppercase only Blanks %%SAPR3-STEP-S<nn>-PRINT_DEST

General information
If the device does not exist, SAP adds a $ sign before the device name.

Chapter 10 SAP parameters

935

Output Management

Output Management
For job log and spool.

Format
Usage Format Valid Values Optional Option button 1-214 characters To copy to a file, enter the full-path file name To copy to SYSOUT, enter *SYSOUT. If you do not wish to copy the job log or the spool, do not set this variable.

Default Variable Name

SYSOUT - for joblog Dont copy - for spool

%%SAPR3-JOBLOG - for joblog %%SAPR3-SPOOL - for spool

936

Control-M Parameter Guide

Owner

Owner
The authorized step owner.

Format
Usage Availability Optional

Add ABAP window in Create job mode Add External Program window in Create job mode Add External Command window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-12 characters Uppercase only Blanks %%SAPR3-STEP-S<nn>-OWNER

General information
If left unspecified, the value is taken from the Account owner field.

Chapter 10 SAP parameters

937

Parameters

Parameters
The parameters for an external program or an external command.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Optional Add External Program and Add External Command windows in Create job mode Text box 1-214 characters Yes None %%SAPR3-STEP-S<nn>-VAR-NAME

938

Control-M Parameter Guide

Print Archive Mode

Print Archive Mode

Determines whether the spool of the step is printed to an output device, to the archive, or both.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) PRINT: (Print) ARCHIVE: (Archive) PRINT_ARCHIVE: (Print & Archive)

Format Valid Values

List

Default Variable Name

Print %%SAPR3-STEP-S<nn>-PRINT_ARCHMODE

Chapter 10 SAP parameters

939

Print Expiration

Print Expiration
The number of days after which a print job expires.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values

List Single-digit number:

1-8 - a specific number of days 9 - a special value that signifies Do Not Delete

Default Variable Name

8 %%SAPR3-STEP-S<nn>-PRINT_EXPIRATION

940

Control-M Parameter Guide

Process Chain Description

Format

Process Chain Description

Describes a Process Chain.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Optional Process Chain SAP-BW Business Process Type Text box 1-60 characters Yes None %%SAPR3-ProcessChain_Desc

Chapter 10 SAP parameters

941

Process Chain ID

Process Chain ID
A unique BW-generated ID of a Process Chain.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory Process Chain SAP-BW Business Process Type Text box 30 characters Uppercase only Blanks %%SAPR3-ProcessChain_ID

942

Control-M Parameter Guide

Process Chain Log ID

Process Chain Log ID

A unique BW-generated ID for the Process Chain running session. Relevant only in Active Job Mode, after job submission.

Format
Usage Availability Format Variable Name Read-only. Process Chain SAP-BW Business Process Type Read-only text box %%SAPR3-ProcessChain_LogID

Chapter 10 SAP parameters

943

QID

QID
The Batch Input Session Queue ID number.

Format
Usage Availability Format Valid Values Variable Name Optional Batch Input job mode Text box 20-digit number %%SAPR3-QID

General information
Batch Input jobs that are deleted after they run are not monitored. The status of jobs marked for deletion is not displayed. If left unspecified, the oldest defined session is scheduled.

944

Control-M Parameter Guide

Recipient

Recipient
The name of the recipient of the job output.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-12 characters Yes None %%SAPR3-STEP-S<nn>-PRINT_RECIPIENT

Chapter 10 SAP parameters

945

Rerun Options

Rerun Options
If an SAP-BW job fails, indicates how the Process Chain should be rerun.

Format
Usage Availability Format Valid Values Mandatory When SAP-BW Business Process Type is set to Process Chain, in Active mode, and the job is in Hold status (Zoom and Save action) Option buttons

Restart from point of failure Rerun from start

Default

Restart from point of failure

946

Control-M Parameter Guide

Rows

Rows
Maximum number of rows per page.

Format
Usage Availability Mandatory

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) Integer between 1-90 -1 Use ABAP Program Default check box is selected) Special value indicating that the number of rows is obtained from the ABAP program code.

Format Valid Values

Text box and check box

Default Variable Name

65 %%SAPR3-STEP-S<nn>-PRINT_NUMLINES

Related parameter
Use ABAP Program Default Indicates whether the ABAP program default should be used, rather than the number in the Rows box. If selected, the variable %%SAPR3-STEP-S<nn>-PRINT_NUMLINES is set to -1.

Chapter 10 SAP parameters

947

SAP-BW Business Process Type

SAP-BW Business Process Type

Determines the task that the job performs.

Format
Usage Format Valid Values Mandatory Option buttons

PC_RUN_ORG (Process Chain) IP_RUN_ORG (InfoPackage)

Default Variable Name

IP_RUN_ORG (InfoPackage) %%SAPR3-JOB_MODE

948

Control-M Parameter Guide

SAP Cover Page

SAP Cover Page

Type of cover page for output.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) D: (Default Setting) - use the default setting from SAP X: (Print) - print the cover page Blank space: (Do Not Print) - do not print the cover page

Format Valid Values

List

Default Variable Name

D %%SAPR3-STEP-S<nn>-PRINT_BANNER

NOTE
In SAP 4.6D, this parameter can return different values, depending on specific SAP userdefinitions. This is a known SAP problem.

Chapter 10 SAP parameters

949

SAP Job Status

SAP Job Status

A read-only field that indicates the status of the SAP CCMS job, in SAP. Relevant only in Active Job Mode, after job submission.

Format
Usage Read-only Displayed only in Active Job Mode Availability Format Valid Values Active job mode Text box

SCHEDULED RELEASED READY ACTIVE CANCELED FINISHED

Variable Name XBP Interface

None This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

General information
This parameter is updated when the Job Editing form is opened. However, the status is not refreshed automatically.

950

Control-M Parameter Guide

SAP Spool Recipient Attribute

SAP Spool Recipient Attribute

Indicates whether to create a new SAP spool.

Format
Usage Availability Format Valid Values Optional Create Job mode Check box

X (Selected): Request a new spool N (Not selected): Do not request a new spool

Default Variable Name

N (Not selected) %%SAPR3_RECIP_COPY %%SAPR3_RECIP_BLIND_COPY %%SAPR3_RECIP_EXPRESS %%SAPR3_RECIP_NO_FORWARDING Note: You can use either %%SAPR3_RECIP_COPY or %%SAPR3_RECIP_BLIND_COPY at any one time.

Chapter 10 SAP parameters

951

Selection Cover Page

Selection Cover Page

Indicates whether a cover page should be used.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) X: (Selected) - use cover page N: (Cleared) - do not use cover page

Format Valid Values

Check box

Default Variable Name

N (Cleared) %%SAPR3-STEP-S<nn>-PRINT_BANNER_PAGE

952

Control-M Parameter Guide

Session Number

Session Number
Indicates the archiving session number in SAP.

Format
Usage Optional This parameter should be specified when either of the following occur: The Write job was not created by Control-M The Write job and the Detect job are not part of the same SMART Table. This parameter should not be specified if the Write job and the Detect job are part of the same SMART Table. Availability Format Valid Values Variable Name Delete or Store job mode in the SAP Data Archiving panel Text box 6-digit number %%SAPR3-DA_SESSION_NUMBER

Chapter 10 SAP parameters

953

Spool List Recipient

Spool List Recipient

Recipient of the print job.

Format
Usage Availability Format Valid Values Variable Name Related Parameters Optional Create job mode Name - 214 characters Any string value, up to 214 characters %%SAPR3_RECIPIENT %%SAPR3_RECIP_TYPE %%SAPR3_RECIP_COPY %%SAPR3_RECIP_BLIND_COPY %%SAPR3_RECIP_EXPRESS %%SAPR3_RECIP_NO_FORWARDING

954

Control-M Parameter Guide

Spool List Type

Spool List Type

Type of the recipient of the print job.

Format
Usage Availability Format Valid Values Optional Create job mode Type - List of single characters

A - External B - Username C - Shared distribution P - Private distribution

Variable Name Related Parameters

%%SAPR3_RECIP_TYPE %%SAPR3_RECIPIENT %%SAPR3_RECIP_COPY %%SAPR3_RECIP_BLIND_COPY %%SAPR3_RECIP_EXPRESS %%SAPR3_RECIP_NO_FORWARDING

Chapter 10 SAP parameters

955

Start Condition

Start Condition
Specifies whether the job should run with the ASAP option, immediately, or after event.

Format
Usage Availability Optional

Create, Original, or Copy job mode All job modes in the SAP Data Archiving panel X - ASAP N - Immediate E - After Event

Format Valid Values

Option buttons

Default Variable Name Related Variables

N (Immediate) %%SAPR3-SUBMIT_ASAP %%SAPR3_EVENT_ID, %%SAPR3_EVENT_PARAM

General information
If the ASAP option is selected, the job runs as soon as a background work process is available for it in SAP. If the job cannot start immediately, it is transformed in SAP into a time-based job. If the Immediate option is selected, the job either runs immediately, or fails in case there are no work processes available to run it. If the After Event option is selected, the job waits for the event to be triggered.

956

Control-M Parameter Guide

Step Type

Step Type
Type of step to be performed.

Format
Usage Length Optional. 1 character. Valid values:

A: ABAP program step C: External Command step E: External Program step F: Fax Number L: Telex Number U: Internet Address X: X.400 Address R: Remote Mail Address

Case-Sensitive Variable Name

Uppercase only. %%SAPR3_STEP-S<nn>-STEP_TYPE

General information
The variable described above must be specified for every single step in a job.

Chapter 10 SAP parameters

957

Steps

Steps
A read-only field that displays the job steps (actions) to be performed as part of the SAP job.

Format
Usage Availability Format Valid Values Read-only Create job mode Read-only text list You can specify any number of steps from 1 through 99 steps

ABAP Program - Add an ABAP program External command - Add an external command External Program - Add an external program

Case Sensitive Invalid Characters Related Variables

No Blanks All step parameters must use the following prefix: %%SAPR3-STEP-S<nn>-

General information
When the specified Job Mode is Create, at least one step must be specified in an SAP job definition. This job definition can consist of one or more ABAP program steps, or External program steps, or both. In the AutoEdit variables given for each of the Add ABAP Window parameter descriptions in this section, S<nn> represents a logical number between S01 and S99.

958

Control-M Parameter Guide

Target Group

Target Group
The application server on which the job runs. The Target Group parameter can be specified for SAP R/3 jobs only.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Related Parameter Optional Create, Original, or Copy job mode Text box 1-20 characters Yes Blanks %%SAPR3-TARGET_SERVER %%SAPR3-SERVER_OR_GROUP_TYPE Valid values are:

G - Group S - Server

General information
If left unspecified, SAP determines a value for this parameter during runtime. Not supported in ctmr3req in job define mode (-SAPR3-ACTION job_define).

Chapter 10 SAP parameters

959

Target Host

Target Host
The host computer on which the external program runs.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory Add External Program window in Create job mode Text box 1-32 characters Yes Blanks %%SAPR3-STEP-S<nn>-TARGET_HOST

960

Control-M Parameter Guide

Target Server (1)

Target Server (1)

The application server on which the job runs. The Target Server parameter can be specified for both SAP R/3 jobs and SAP Data Archiving jobs.

Format
Usage Availability Optional

Create, Original, Copy, or Batch Input job mode All job modes in the SAP Data Archiving panel

Format Valid Values

Text box 1-20 characters The following (full) format must be used: hostname_SYSID_sysnumber

Case Sensitive Invalid Characters Variable Name Related Parameter

Yes Blanks %%SAPR3-TARGET_SERVER %%SAPR3-SERVER_OR_GROUP_TYPE Valid values are:

G - Group S - Server

General information
If left unspecified, SAP determines a value for this parameter during runtime. Not supported in ctmr3req in job define mode (-SAPR3-ACTION job_define).

Chapter 10 SAP parameters

961

Target Server (2)

Target Server (2)

The application server on which the external command runs.

Format
Usage Availability Format Valid Values Case Sensitive Invalid Characters Variable Name Mandatory Add External Command window in Create job mode Text box 1-32 characters Yes Blanks %%SAPR3-STEP-S<nn>-TARGET_HOST

962

Control-M Parameter Guide

Time of Print

Time of Print
Indicates when to print the job output.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel) N: Send to SAP spooler X: Print out immediately A: Print later

Format Valid Values

List

Default Variable Name

Send to SAP spooler %%SAPR3-STEP-S<nn>-PRINT_IMMED

Chapter 10 SAP parameters

963

Titles

Titles
The spool list titles.

Format
Usage Availability Optional

Add ABAP window in Create job mode Print Parameters window in Write job mode (SAP Data Archiving panel)

Format Valid Values Case Sensitive Invalid Characters Variable Name XBP Interface

Text box 1-68 characters Yes None %%SAPR3-STEP-S<nn>-LIST_TEXT This parameter is functional in:

XBP 2.0, or XBP 1.0 with Control-M Function Modules installed (when Use Extended is selected)

964

Control-M Parameter Guide

Use ABAP Program Default

Use ABAP Program Default

Indicates whether the ABAP program default should be used, rather than a number entered in the Rows or Columns box. For details, see the related parameters.

Related parameters
Rows Columns If selected, the Rows box is not available. If not selected, enter a number in the Rows box. If selected, the Columns box is not available. If not selected, enter a number in the Columns box.

Chapter 10 SAP parameters

965

Variant Name

Variant Name
Available for SAP R/3 and SAP Data Archiving jobs. Specify a variant for the specified ABAP program or Archiving Object.

Format
Usage Optional for SAP R/3 jobs. Mandatory for SAP Data Archiving Write jobs. Availability

Add ABAP window in Create job mode Write job mode in the SAP Data Archiving panel

Format Valid Values Case Sensitive Invalid Characters Variable Name

Text box 1-14 characters Uppercase only None %%SAPR3-STEP-S<nn>-VAR-NAME

966

Control-M Parameter Guide

Chapter

11

11

Oracle E-Business Suite parameters

The parameters described in this section are for the OAP panel of the Job Editing form. These parameters are only relevant if Control-M/CM for Oracle E-Business Suite is installed and Oracle E-Business Suite forms are loaded in Control-M/EM. Table 185 OAP parameters summary
Parameter Advanced Options Application Application Name Application Short Name Description Include Output Include Log Notifications Output Language Description Enables various advanced options to be modified. The application short name associated with the responsibility name. The application long name associated with the concurrent program. The application short name associated with the concurrent program. Description of a request. If specified, the output of the Oracle job is appended to SYSOUT.

Application Instance Oracle E-Business Suite instance connection information.

Include Child Status When specified, child jobs are monitored.

When specified, the request log is copied to the Control-M sysout.

Generates a selection list containing all Oracle workflow roles. The job output language.

Parameter Validation All specified parameter values are validated. If no value is specified, the default value is retrieved. Parent Phase Print Priority Profiles Request ID Request Type Parent of the job or process. Phase of the job or process. Determines print settings. Priority of the job or process. Specify or modify the print profile name and value. Oracle E-Business Suite request ID number. Indicates whether the request is a Request Set or Single Request.

Chapter 11

Oracle E-Business Suite parameters

967

Table 185 OAP parameters summary

Parameter Responsibility Security Group Status Upon completion User Name Wait Child Description Authorization for accessing data and running programs or requests, or both. The security group assigned to the username. Status of the job or process. Enables various tasks to be performed upon completion of a job. Authorized Oracle E-Business Suite user who has at least one responsibility. If an Oracle job spawned multiple child jobs, the Control-M job tracks status of all child jobs. If not, Control-M only checks original job status, stopping as soon as it finishes.

968

Control-M Parameter Guide

Advanced Options

Advanced Options
Enables various advanced options to be modified.

Format
Usage Format Optional. Button. When clicked, the Advanced Options window is displayed.

The following parameter settings can be modified in the Advanced Options window:

Profiles on page 985 Include Log on page 976 Include Output on page 977 Parameter Validation on page 980 Wait Child on page 995 Include Child Status on page 975

Chapter 11

Oracle E-Business Suite parameters

969

Application

Application
The application short name associated with the responsibility name.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1 - 50 characters Uppercase only Blanks %%OAP-RESPAPP

970

Control-M Parameter Guide

Application Instance

Application Instance
Oracle E-Business Suite instance connection information.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1 - 214 characters Yes Blanks %%OAP-INSTANCE

Chapter 11

Oracle E-Business Suite parameters

971

Application Name

Application Name
The application long name associated with the concurrent program.

Format
Usage Default Length Case Sensitive Invalid Characters Variable Name Optional. None 1 - 214 characters Yes Blanks %%OAP-APPDESP

972

Control-M Parameter Guide

Application Short Name

Application Short Name

The application short name associated with the concurrent program.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory. 1 - 50characters Yes (uppercase only) Blanks %%OAP-APPNAME

Chapter 11

Oracle E-Business Suite parameters

973

Description

Description
Text description of a request.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Optional. 1 - 214 characters Yes None %%OAP-DESCRIPTION

Displayed only when the Request Type is Single Request.

974

Control-M Parameter Guide

Include Child Status

Include Child Status

If selected, child jobs are monitored. If one ends in error, the Control-M job status is also error. If unspecified, Control-M job status is determined only by parent job ending status.

Format
Usage Format Optional. Check box. Default: Selected (Child jobs monitored) Located on the Advanced Options window accessed from the OAP panel. Variable Name %%OAP-SUBSTATUS

Chapter 11

Oracle E-Business Suite parameters

975

Include Log

Include Log
When specified, the request log is copied to the Control-M sysout.

Format
Usage Format Optional Check box Located on the Advanced Options window accessed from the OAP panel. Default Variable Name Selected %%OAP-DISPLAY_LOGFILE

976

Control-M Parameter Guide

Include Output

Include Output
When specified, the output of the Oracle job is appended to SYSOUT.

Format
Usage Format Optional. Check box. Located on the Advanced Options window accessed from the OAP panel. Default Variable Name Not selected %%OAP-DISPLAY_OUTPUT

Chapter 11

Oracle E-Business Suite parameters

977

Notifications

Notifications
Generates a selection list containing all Oracle workflow roles.

NOTE
For Oracle E-Business Suite 11 and 11i only.

Format
Usage Format Optional. List generated by CONTROL-M/EM. Located on the Upon Completion window accessed from the OAP panel. Length Case Sensitive Variable Name 1-214 characters Yes %%OAP-NOTIFICATIONS-Nn-NAME

978

Control-M Parameter Guide

Output Language

Output Language
The job output language.

Format
Usage Format Optional. <LANGUAGE>_<TERRITORY> Located on the Upon Completion window accessed from the OAP panel. Default Length Variable Name If no value is set, default is AMERICAN_AMERICA 1-60 characters %%OAP-LANGUAGE

Chapter 11

Oracle E-Business Suite parameters

979

Parameter Validation

Parameter Validation
All specified parameter values are validated. If no value is specified, the default value is retrieved.

Format
Usage Format Optional. Check box. Default: Selected (parameter values are validated). Located on the Advanced Options window accessed from the OAP panel. Variable Name %%OAP-PARAM_VALIDATION

980

Control-M Parameter Guide

Parent

Parent
Parent of the job or process.

Format
Usage Format Optional Number, 1-15 digits in length. Displayed only in the Job Editing form active environment (in the CONTROL-M/EM GUI). Variable Name %%OAP-ACTIVE_ATTRn-PARENT

General information
The value of this parameter is supplied by the Oracle E-Business Suite and cannot be modified.

Chapter 11

Oracle E-Business Suite parameters

981

Phase

Phase
Phase of the job or process.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Optional 1 - 50 characters Uppercase only Blanks %%OAP-ACTIVE_ATTRn-PHASE

The value of this parameter is supplied by the Oracle E-Business Suite and cannot be modified. This parameter is displayed only in the Job Editing form active environment (in the CONTROL-M/EM GUI).

982

Control-M Parameter Guide

Print

Print
Determines print settings.

Format
Usage Format Optional Composed of the Printer (Load), No. of Copies, and Style subparameters, described below. Located on the Upon Completion window accessed from the OAP panel.

Subparameters
Printer (Load) Causes the Oracle E-Business Suite server to generate a list in real time of all available printers. Select required printer for job output. Usage Length Case sensitive Invalid Characters Variable Name Optional 1-100 characters Yes None In Single Request: %%OAP-PRINTERS-P<n>NAME In Request Set: %%OAP-SETPROG-P<n>PRINTERNAME Optional Integer. 1-4 digits. In Single Request: %%OAP-PRINTERS-P<n>VALUE In Request Set: %%OAP-SETPROG-P<n>PRINTCOPIES Optional. Mandatory if a value is supplied for the Printer (Load) parameter. 1-20 characters Yes None %%OAP-PRINTSTYLE

No. of copies

Required number of copies. Usage Format Variable Name

Style

Format in which job output is printed. Usage Length Case sensitive Invalid Characters Variable Name

Chapter 11

Oracle E-Business Suite parameters

983

Priority

Priority
Priority of the job or process.

Format
Usage Format Optional. Number, 0-100. Displayed only in the Job Editing form active environment (in the CONTROL-M/EM GUI). Variable Name %%OAP-ACTIVE_ATTR<n>-PRIORITY

Related parameters
Priority Control-M priority (described on Priority on page 748) determines submission the priority of the job in Control-M, whereas Priority under Oracle E-Business Suite determines the priority of the job in Oracle EBusiness Suite.

General information
There are two Priority settings for an Oracle E-Business Suite job that is scheduled in the Control-M data center. The priority of a job in Control-M is first used to determine when Control-M/EM schedules the job for execution. After the job is submitted for execution in the Oracle E-Business Suite, the Oracle EBusiness Suite Priority of the job determines when it is run in the Oracle E-Business Suite.

984

Control-M Parameter Guide

Profiles

Profiles
Specify or modify the print profile name and value.

Format
Usage Format Optional. Profile Name and Value text boxes, described below. Located on the Advanced Options window accessed from the OAP panel.

Subparameters
Profile Name Profile internal name. Usage Length Case sensitive Invalid Characters Variable Name Value Usage Length Case sensitive Invalid Characters Variable Name Optional 1-214 characters Yes None %%OAP-PROFILES-P<n>-VALUE Optional 1-214 characters Yes None %%OAP-PROFILES-P<n>-NAME

Chapter 11

Oracle E-Business Suite parameters

985

Request ID

Request ID
Oracle E-Business Suite request ID number.

Format
Usage Format Optional Number, 1-15 digits in length. Displayed only in the Job Editing form active environment (in the CONTROL-M/EM GUI). Variable Name %%OAP-ACTIVE_ATTR<n>-REQUEST_ID

General information
The value of this parameter is supplied by the Oracle E-Business Suite and cannot be modified.

986

Control-M Parameter Guide

Request Type

Request Type
Indicates whether the request is a Request Set or Single Request.

Format
Usage Format Mandatory Option buttons. Valid values:

Request Set Single Request

Note: Each option has subparameters. Default Variable Name Request Set %%OAP-TASKTYPE

General information
Each Request Type option is composed of subparameters.

Request Set
Specifies a number of requests. Table 186 Request Set subparameters
Application Name Application Short Name Request Set For more information, see Application Name on page 972. For more information, see Application Short Name on page 973. Request Set long name. Usage Length Case sensitive Invalid Characters Variable Name Optional 1-214 characters Yes None %%OAP-SETDESP

Chapter 11

Oracle E-Business Suite parameters

987

Request Type

Table 186 Request Set subparameters

Request Set Parameters Click the Request Set button to cause the Oracle E-Business Suite server to generate a list, in real time, of all concurrent programs in the request set. Each program is listed in a table displaying Program and Stage. Select an item from the generated list to enter in the form. Usage Variable Name Optional OAP-SETPROG-P<n>-PARMS-PARM <m>-NAME OAP-SETPROG-P<n>-PARMS-PARM <m>-VALUE Request Set Code (Load) Request Set short name. Causes the Oracle E-Business Suite server to generate a list, in real time, that satisfies relevant criteria. Select an item from the generated list to enter in the form. Usage Length Case sensitive Invalid Characters Variable Name Mandatory 1-30 characters Yes (uppercase) Blanks %%OAP-SETNAME

Single Request
Specifies a single request. Table 187 Single Request subparameters
Application Name Application Short Name Description Program Short Name (Load) For more information, see Application Name on page 972. For more information, see Application Short Name on page 973. For more information, see Description on page 974. The concurrent program short name. Causes the Oracle E-Business Suite server to generate a list in real time that satisfies relevant criteria. Select an item from the generated list to enter in the form. Usage Length Case sensitive Invalid Characters Variable Name Mandatory 1-30 characters Yes (uppercase) Blanks %%OAP-PROGNAME

988

Control-M Parameter Guide

Request Type

Table 187 Single Request subparameters

Program long Name Descriptive program name. Usage Length Case sensitive Invalid Characters Variable Name Request Parameters Optional 1-214 characters Yes None %%OAP-PROGDESP

Opens Single Request Parameter form. You can specify parameter values for the specified concurrent program. Note: All fields must be specified, or the default value is used. If no default value is specified in Control-M, default is automatically NULL. Usage Format Optional Parameters:

Organization ID BOM or ENG Item Selection Specific Item Revision Date Items From Items To Category Set Category Structure Categories From Categories To

For more information on these parameters, see the Control-M/CM for Oracle E-Business Suite Administrator Guide. Variable Name OAP-PARMS-P<n>-NAME OAP-PARMS-P<n>-VALUE

Chapter 11

Oracle E-Business Suite parameters

989

Responsibility

Responsibility
Authorization for accessing data and running programs or requests, or both.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1-100 characters Yes Blanks %%OAP-RESPNAME

990

Control-M Parameter Guide

Security Group

Security Group
The security group assigned to the username.

NOTE
For Oracle E-Business Suite 11i only.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Optional 1-80 characters Yes None %%OAP-SECURITY_GROUPNAME

Chapter 11

Oracle E-Business Suite parameters

991

Status

Status
Oracle E-Business Suite status of the job or process.

Format
Usage Format Variable Name Optional Displayed only in the Job Editing form active environment (in the CONTROL-M/EM GUI). %%OAP-ACTIVE_ATTR<n>-STATUS

There are two statuses (whether it is Held or Free, and so on) for an Oracle E-Business Suite job that is scheduled in the Control-M data center. The status of a job in Control-M (whether it is Held or Free, and so on) can be modified from the CONTROL-M/EM GUI. After the job is submitted for execution in the Oracle E-Business Suite, its Oracle EBusiness Suite Status determines how the job is handled (whether it is Held or Free, and so on) in the Oracle E-Business Suite.

NOTE
The value of this parameter is supplied by the Oracle E-Business Suite and cannot be modified.

992

Control-M Parameter Guide

Upon completion

Upon completion
Enables various tasks to be performed upon completion of a job.

Format
Usage Format Optional. Button. When clicked, the Upon Completion window is displayed.

The following parameter settings can be modified in the Upon Completion window:

Notifications on page 978 Print on page 983 Output Language on page 979

Chapter 11

Oracle E-Business Suite parameters

993

User Name

User Name
Authorized Oracle E-Business Suite user who has at least one responsibility.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1-100 characters No Blanks %%OAP-USERNAME

994

Control-M Parameter Guide

Wait Child

Wait Child
If an Oracle job spawned multiple child jobs, the Control-M job tracks the status of all child jobs. If not, Control-M only checks the original job status, stopping as soon as it finishes.

Format
Usage Format Optional. Check box. Default: Selected (Tracks child job status) Located on the Advanced Options window accessed from the OAP panel. Variable Name %%OAP_WAITCHILD

Chapter 11

Oracle E-Business Suite parameters

995

Wait Child

996

Control-M Parameter Guide

Chapter

12

12

Advanced File Transfer parameters

This section describes the parameters in the FILE_TRANS panel that are used to run Advanced File Transfer (AFT) jobs. This panel is displayed in the Job Editing form when Control-M/CM for Advanced File Transfer is installed at your data center. The basic Control-M parameters for AFT jobs are summarized in the following tables, and each parameter is described in detail in the remainder of this section. Parameter descriptions are in alphabetical order.

NOTE
Other Control-M job parameters are available for additional processing of AFT jobs. They are described in the other sections in this help.

Table 188 FILE_TRANS panel parameterssummary

Parameter Account Binary/ASCII Number of Retries Rerun from Point of Failure Transfer Location Use Configuration Default Description Set of parameters that define both sides of a file transfer connection. Select either Binary or ASCII mode for file transfer. Number of times CONTROL-M/CM for Advanced File Transfer tries to re-establish a failed connection. Indicates whether file transfer jobs should be rerun from the point of failure (from the specific point in the file transfer where the job failed). Source and destination locations on the host computers. Use the number of retries defined in the configuration file.

File Transfer Direction Source and destination computers.

NOTE
Parameters displayed in the FILE_TRANS panel after a job has been submitted are informational only.

Chapter 12

Advanced File Transfer parameters

997

Table 189 FILE_TRANS panel parametersnotification purposes only

Parameter Host Name OS Type User Name Description The name of the host computer. The operating system of the host computer. The user name of the host computer.

NOTE
The following parameters are displayed in the General, OpenSystems/OS400, MVS, Security, and FTP Commands panels of the Advanced window.

Table 190 FILE_TRANS panel - Advanced window parametersgeneral

Parameter Description Indicates whether the source file is to be left as is, deleted, or After the completion renamed upon completion of a successful file transfer. of a successful file transfer the source file is Continue on Failure If a file of the same name as the destination file already exists Specifies whether a multi-file transfer should continue if a specific file transfer fails or if an entire multi-file transfer job fails. When a file is specified to be transferred to a location already containing a file of the same name, the value for this parameter determines: whether the file transfer is aborted or skipped or the destination file is appended or overwritten

Rename Destination file Temporary File Prefix

Specifies the new file name pattern for the destination file.
A temporary prefix that is prepended to the file name during the transfer. If a directory is being transferred, this prefix is prepended to the names of all the files in that directory. Upon completion of a successful file transfer, the prefix is removed. The original name of the file (or all the files in the directory) is restored.

Table 191 FILE_TRANS panel - Advanced window parametersOpenSystems/OS400

Parameter Recursive Rename Destination file Trailing blanks Description Specifies whether a directory transfer includes all its subdirectories.

Specifies the new file name pattern for the destination file. Specify how trailing blanks are handled during OS/400 transfers.

998

Control-M Parameter Guide

Table 192 FILE_TRANS panel - Advanced window parametersMVS

Parameter Additional Options Allocation Units Block Size DBCS Encoding Primary Allocation Record Format Secondary Allocation Template Name Translate Table Unit Volume Description Additional z/OS FTP server parameters to be defined prior to performing the file transfer. Value of the allocation units for the z/OS data set. Block size of the z/OS data set to be allocated. Specifies the DBCS encoding for the MVS dataset. Primary allocation amount for the z/OS data set to be allocated. Record format of the z/OS data set to be allocated. Secondary allocation amount for the z/OS data set to be allocated. Name of the template with which you intend to work. File containing the translation tables for the data connection. Value of the allocation units for the z/OS data set. Volume on which the z/OS data set is allocated.

Logical Record Length Logical record length of the z/OS data set to be allocated.

Table 193 FILE_TRANS panel - Advanced window parameterssecurity

Parameter Compression Description Defined separately for host 1 and host 2. Indicates whether compression is to be used for file transfers using Secure File Transfer (SFTP). For the specific file transfer, overrides the setting for the account. (Security)

Encryption Algorithm Defined separately for host 1 and host 2. The encryption algorithm to be used for file transfers using SFTP. For a specific file transfer, this parameter overrides the Encryption Algorithm setting for the account.

Table 194 FILE_TRANS panel - Advanced window parametersFTP Commands

Parameter Host1 pre command Host1 first pre command parameter Host1 second pre command parameter Host1 post command Host1 first post command parameter Host1 second post command parameter Host2 pre command Host2 first pre command parameter Description Specifies the pre command for host 1. Specifies the first parameter for pre command for host 1. Specifies the second parameter for pre command for host 1. Specifies the post command for host 1. Specifies the first parameter for post command for host 1. Specifies the second parameter for post command for host 1. Specifies the first parameter for pre command for host 2. Specifies the second parameter for pre command for host 2.

Chapter 12

Advanced File Transfer parameters

999

Table 194 FILE_TRANS panel - Advanced window parametersFTP Commands

Parameter Host2 second pre command parameter Host2 post command Host2 second post command parameter Description Specifies the post command for host 2. Specifies the first parameter for post command for host 2. Specifies the second parameter for post command for host 2.

1000

Control-M Parameter Guide

Account

Account
Name of a set of parameters that define both sides of a file transfer connection.

Format
Usage Format Length Case Sensitive Special Requirement Default Variable Name Mandatory Text box Up to 64 characters Yes Must begin with a letter and can contain alphanumeric characters and underscores. Must not contain blanks. None %%FTP-ACCOUNT

Chapter 12

Advanced File Transfer parameters

1001

Additional Options

Additional Options
Specifies additional z/OS FTP server parameters that can be defined prior to performing the file transfer. Additional options that are specified are used by the SITE command.

Format
Usage Format Variable Name Optional Text box. Free text according to FTP server SITE commands. Up to 214 characters %%FTP-ADDOPTxy Note: x is either 1 or 2 and indicates the z/OS host (1 refers to the host defined on the left side of the Account Details dialog box, and 2 refers to the host defined on the right side of the Account Details dialog box). y indicates a value from 1 through 5, according to the sequential transfer number For example, when performing a file transfer from one z/OS host to another z/OS host, the variable: %%FTP-ADDOPT21 contains additional options to set for the connection to the z/OS host defined on the right side of the Account Details dialog box, in the first file transfer.

1002

Control-M Parameter Guide

After the completion of a successful file transfer the source file is

After the completion of a successful file transfer the source file is

Indicates whether the source file is to be left as is, deleted, or renamed upon completion of a successful file transfer.

Format
Usage Format Valid Values Optional Option button and File Name text box for the Renamed option

Left as is Deleted Renamed (enter new name in the File Name text box))

Default Variable Name

Left as is %%FTP-SRCOPTx Note: x indicates a value between 1-5, according to the sequential transfer number

Subparameter
File Name If the Renamed option is selected, a text box for entering the new file name is available. The file name must be a valid name for the operating system of the host computer. Usage Format Valid Values Case sensitive Invalid Characters Variable Name Optional Text box 1-256 characters Yes Operating system dependent %%FTP-NEWNAMEx Note: x indicates a value between 1-5, according to the sequential transfer number.

Chapter 12

Advanced File Transfer parameters

1003

Allocation Units

Allocation Units
Specifies the value of the allocation units for the z/OS data set.

Format
Usage Format Valid Values Optional List

Blocks Cylinders Tracks

Default Variable Name

N/A %%FTP-ALLOCUNITSx Note: x indicates a value between 1-5, according to the sequential transfer number

1004

Control-M Parameter Guide

Binary/ASCII

Binary/ASCII
Determines the mode in which files are transferred.

Format
Usage Format Valid Values Mandatory Option button

Binary ASCII

Default Variable Name

Binary %%FTP-TYPEx Note: x indicates a value between 1-5, according to the sequential transfer number.

Chapter 12

Advanced File Transfer parameters

1005

Block Size

Block Size
The block size of the z/OS data set to be allocated.

Format
Usage Format Valid Values Default Variable Name Optional Text box Integer between 0-32760 N/A %%FTP-BLKSIZEx Note: x indicates a value between 1-5, according to the sequential transfer number.

1006

Control-M Parameter Guide

Compression

Compression
Determines whether the current SFTP file transfer uses compression. This parameter is defined for each host in the account.

Format
Usage Optional If this value is unspecified, the Compression parameter defined for the account is used. For host computers that are not defined to use SFTP, this field is disabled. List

Format Valid Values Default Variable Name

No (0) - Compression off Yes (1) - Compression on

Yes %%FTP-COMPRESSIONxy Note: x is either 1 or 2 and indicates the z/OS host (1 refers to the host defined on the left side of the Account Details dialog box, and 2 refers to the host defined on the right side of the Account Details dialog box). y indicates a value between 1-5, according to the sequential transfer number For example, when performing a file transfer from one z/OS host to another z/OS host, the variable: %%FTP-COMPRESSION21 contains the compression value to set for the connection to the z/OS host defined on the right side of the Account Details dialog box, in the first file transfer.

General information
The value of this parameter is defined separately for each host computer. The setting for this parameter on the Security panel of the Advanced window of the FILE_TRANS panel affects only the current file transfer. For more information about how to change the security settings for the account, see the Control-M/Control Module for Advanced File Transfer Administrator Guide. For host computers that are not defined to use SFTP, this field is disabled. For more information, see the Control-M/Control Module for Advanced File Transfer Administrator Guide.

Chapter 12

Advanced File Transfer parameters

1007

Continue on Failure

Continue on Failure
Specify whether a multi-file transfer continues if a specific file transfer fails or if an entire multi-file transfer fails.

Format
Usage Format Valid Values Default Variable Name Optional Check box

0 Stop on failure 1 Continue on failure

Unchecked %%FTP-CONT_EXEx Note: x indicates a value between 1-5, according to the sequential transfer number

1008

Control-M Parameter Guide

DBCS Encoding

DBCS Encoding
Specifies the DBCS encoding for the MVS dataset.

Format
Format
Usage Format Valid Values Optional List

EUCKANJI (Extended UNIX Code Kanji) HANGEUL BIG5 (IBM Big-5) SJISKANJI (JIS Kanji) JIS83KJ (JIS 1983 Kanji) JIS78KJ (JIS 1978 Kanji) KSC5601 (Korean Standard Code KSC-5601) SCHINESE (Simplified Chinese) TCHINESE (Traditional Chinese (5550))

Default Variable Name

N/A %%FTP-DBCSx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1009

Encryption Algorithm

Encryption Algorithm
The encryption algorithm that the current SFTP file transfer uses. This parameter is defined for each host in the account.

Format
Usage Optional. If this value is left unspecified, the encryption parameter defined for the account is used. For host computers that are not defined to use SFTP, this field is disabled. List

Format Valid Values

Blowfish DES 3DES AES

Default Variable Name

Blowfish %%FTP-ENCRYPTIONxy Note: x is either 1 or 2 and indicates the z/OS host (1 refers to the host defined on the left side of the Account Details dialog box, and 2 refers to the host defined on the right side of the Account Details dialog box). y indicates a value between 1-5, according to the sequential transfer number For example, when performing a file transfer from one z/OS host to another z/OS host, the variable: %%FTP-ENCRYPTION21 contains the encryption value to set for the connection to the z/OS host defined on the right side of the Account Details dialog box, in the first file transfer.

General information
The value of this parameter is defined separately for each host computer. The setting for this parameter on the Security panel of the Advanced window of the FILE_TRANS panel affects only the current file transfer. If you want to change the security settings for the account, see the Control-M/Control Module for Advanced File Transfer Administrator Guide. For host computers that are not defined to use SFTP, this field is disabled. For more information, see the Control-M/Control Module for Advanced File Transfer Administrator Guide.

1010

Control-M Parameter Guide

File Transfer Direction

File Transfer Direction

Indicates the source and destination computers for the file transfer.

Format
Format Valid Values Variable Name Arrow button

0 = Right to left 1 = Left to right

%%FTP-UPLOADx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1011

Host Name

Host Name
The name of the host computer.

Format
Usage Format Variable Name Read-only Text %%FTP-LHOST %%FTP-RHOST

1012

Control-M Parameter Guide

Host1 pre command

Host1 pre command

Specifies the pre command for host 1.

Format
Usage Format Valid Values Optional List

chmod Mkdir rename rm rmdir

Default Variable Name

N/A %%FTP-PRECOMM1x Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1013

Host1 first pre command parameter

Host1 first pre command parameter

Specifies the first parameter for pre command for host 1.

Format
Usage Format Valid Values Optional Text

file mode for chmod command Full directory to create for Mkdir command Old file name for rename command File name to delete for rm command Directory name to delete for rmdir command

Default Variable Name

N/A %%FTP-PREPARAM11x Note: x indicates a value between 1-5, according to the sequential transfer number

1014

Control-M Parameter Guide

Host1 second pre command parameter

Host1 second pre command parameter

Specifies the second parameter for pre command for host 1.

Format
Usage Format Valid Values Optional Text

File name to change mode New file name for rename command N/A for Mkdir, rm and rmdir commands.

Default Variable Name

N/A %%FTP-PREPARAM11x Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1015

Host1 post command

Host1 post command

Specifies the post command for host 1.

Format
Usage Format Valid Values Optional List

chmod Mkdir rename rm rmdir

Default Variable Name

N/A %%FTP-POSTCOMM1x Note: x indicates a value between 1-5, according to the sequential transfer number

1016

Control-M Parameter Guide

Host1 first post command parameter

Host1 first post command parameter

Specifies the first parameter for post command for host 1.

Format
Usage Format Valid Values Optional Text

file mode for chmod command Full directory to create for Mkdir command Old file name for rename command File name to delete for rm command Directory name to delete for rmdir command

Default Variable Name

N/A %%FTP-POSTPARAM11x Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1017

Host1 second post command parameter

Host1 second post command parameter

Specifies the second parameter for post command for host 1.

Format
Usage Format Valid Values Optional Text

file name to change mode New file name for rename command N/A for Mkdir, rm and rmdir commands

Default Variable Name

N/A %%FTP-POSTPARAM12x Note: x indicates a value between 1-5, according to the sequential transfer number

1018

Control-M Parameter Guide

Host2 pre command

Host2 pre command

Specifies the pre command for host 2.

Format
Usage Format Valid Values Optional List

chmod Mkdir rename rm rmdir

Default Variable Name

N/A %%FTP-PRECOMM2x Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1019

Host2 first pre command parameter

Host2 first pre command parameter

Specifies the first parameter for pre command for host 2.

Format
Usage Format Valid Values Optional Text

file mode for chmod command Full directory to create for Mkdir command Old file name for rename command File name to delete for rm command Directory name to delete for rmdir command

Default Variable Name

N/A %%FTP-PREPARAM21x Note: x indicates a value between 1-5, according to the sequential transfer number

1020

Control-M Parameter Guide

Host2 second pre command parameter

Host2 second pre command parameter

Specifies the second parameter for pre command for host 2.

Format
Usage Format Valid Values Optional Text

file name to change mode New file name for rename command N/A for Mkdir, rm and rmdir commands.

Default Variable Name

N/A %%FTP-PREPARAM22x Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1021

Host2 post command

Host2 post command

Specifies the post command for host 2.

Format
Usage Format Valid Values Optional List

chmod Mkdir rename rm rmdir

Default Variable Name

N/A %%FTP-POSTCOMM2x Note: x indicates a value between 1-5, according to the sequential transfer number

1022

Control-M Parameter Guide

Host2 first post command parameter

Host2 first post command parameter

Specifies the first parameter for post command for host 2.

Format
Usage Format Valid Values Optional Text

file mode for chmod command Full directory to create for Mkdir command Old file name for rename command File name to delete for rm command Directory name to delete for rmdir command

Default Variable Name

N/A %%FTP-POSTPARAM21x Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1023

Host2 second post command parameter

Host2 second post command parameter

Specifies the second parameter for post command for host 2.

Format
Usage Format Valid Values Optional Text

file name to change mode New file name for rename command N/A for Mkdir, rm and rmdir commands.

Default Variable Name

N/A %%FTP-POSTPARAM22x Note: x indicates a value between 1-5, according to the sequential transfer number

1024

Control-M Parameter Guide

If a file of the same name as the destination file already exists

If a file of the same name as the destination file already exists

This parameter determines whether the file transfer is aborted or skipped, or whether the destination file is appended or overwritten if a file with the same name already exists at the specified destination

Format
Usage Format Valid Values Mandatory Option button

Abort - 0 Overwrite - 1 Append - 2 Skip - 4

Default Variable Name

Overwrite %%FTP-IF-EXISTx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1025

Logical Record Length

Logical Record Length

The logical record length of the z/OS data set to be allocated.

Format
Usage Format Valid Values Default Variable Name Optional Text box Integer between 0-32760 N/A %%FTP-LRECLx Note: x indicates a value between 1-5, according to the sequential transfer number

1026

Control-M Parameter Guide

Number of File Transfers

Number of File Transfers

Represents the number of file transfers in a Control-M/CM for Advanced File Transfer job. This is an internal variable that is set by the form, not by the user. It determines how many rows appear in the form for file transfers.

Format
Usage Format Valid Values Default Variable Name N/A N/A Integer between 1-5 N/A %%FTP-TRANSFER_NUM

Chapter 12

Advanced File Transfer parameters

1027

Number of Retries

Number of Retries
The number of times CONTROL-M/CM for Advanced File Transfer tries to re-establish a failed connection.

Format
Usage Format Valid Values Default Variable Name Mandatory Text field, with incremental arrows Integer between 0-99 5 %%FTP-NUM_RETRIES

General information
When the FTP server is running on an z/OS operating system, this field is disabled. If you are working online, the Retrieve button is available and you can click it to automatically set this parameter to the default value defined in configuration.

1028

Control-M Parameter Guide

OS Type

OS Type
The operating system associated with the Host Name.

Format
Usage Format Valid Values Read-only Text

Windows UNIX MVS Tandem OpenVMS OS2200 OS400

Variable Name

%%FTP-LOSTYPE %%FTP-ROSTYPE

Chapter 12

Advanced File Transfer parameters

1029

Primary Allocation

Primary Allocation
The primary allocation amount for the z/OS data set to be allocated.

Format
Usage Format Valid Values Default Variable Name Optional Text box Integer between 1 - 16777215 N/A %%FTP-PRIMARYx Note: x indicates a value between 1-5, according to the sequential transfer number

1030

Control-M Parameter Guide

Record Format

Record Format
The record format of the z/OS data set to be allocated.

Format
Usage Format Valid Values Optional List

F FB V VB U

Default Variable Name

N/A %%FTP-RECFMx Note: x indicates a value 1-5, according to the sequential transfer number.

Chapter 12

Advanced File Transfer parameters

1031

Recursive

Recursive
Specifies whether a directory transfer includes all its subdirectories.

Format
Usage Format Valid Values Default Variable Name Optional Check box

0 - non-recursive 1 - recursive

Unchecked %%FTP-RECURSIVEx Note: x indicates a value between 1-5, according to the sequential transfer number

1032

Control-M Parameter Guide

Rename Destination file

Rename Destination file

Specifies the new file name pattern for the destination file. The renaming happens after a successful transfer. The pattern can contain strings, AutoEdit variables and the variable $$AFTFILE$$.

Format
Usage Length Valid Values Case sensitive Blanks permitted Default Variable Name Optional 1-256 characters Dependent on operating system Yes No N/A %%FTP-DEST-NEWNAMEx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1033

Rerun from Point of Failure

Rerun from Point of Failure

Indicates whether failed file transfer jobs should be restarted from the point of failure (from the specific file transfer that failed within the job).

Format
Usage Format Valid Values Optional Check box

Checked - a failed file transfer restarts from the point of failure Cleared - a failed file transfer restarts from the beginning of the first file in the file transfer

Default Variable Name

Checked %%FTP-RPF

1034

Control-M Parameter Guide

Secondary Allocation

Secondary Allocation
The secondary allocation amount for the z/OS data set to be allocated.

Format
Usage Format Valid Values Default Variable Name Optional Text box Integer between 0 -16777215 N/A %%FTP-SECONDARYx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1035

Template Name

Template Name
The name of the template to be used for the job.

Format
Usage Format Length Case Sensitive Blanks Default Variable Name Optional Text box Up to 64 characters Yes No None %%FTP-TEMPLATEx Note: x indicates a value between 1-5, according to the sequential transfer number

1036

Control-M Parameter Guide

Temporary File Prefix

Temporary File Prefix

A temporary prefix that is prepended to the file name during the file transfer. If a directory is being transferred, this prefix is prepended to the names of all the files in the directory. Upon completion of a successful file transfer, the prefix is removed. The original name of the file (or all file names in the directory) is restored.

Format
Usage Format Length Valid Values Case Sensitive Blanks Default Variable Name Optional Text box Up to 99 characters Operating system dependent Yes No None %%FTP-FILE-PFXx Note: x indicates a value between 1-5, according to the sequential transfer number

General information
The temporary file name that is created by prepending the prefix must be a valid file name for the operating system of the destination host computer.

Chapter 12

Advanced File Transfer parameters

1037

Trailing blanks

Trailing blanks
Specify how trailing blanks are handled during OS/400 transfers. This option is relevant only for files that are transferred in ASCII mode.

Format
Format
Usage Format Valid Values Optional Option button

0 Send trailing blanks. 1 Do not send Trailing blanks for Database file with file structure 2 - Do not send Trailing blanks for all Database files

Default Variable Name

1 - Do not send Trailing blanks for Database file with file structure %%FTP-TRIMx Note: x indicates a value between 1-5, according to the sequential transfer number

1038

Control-M Parameter Guide

Transfer Location

Transfer Location
The source or destination location for files being transferred to or from a host computer.

Format
Usage Format Length Case Sensitive Blanks Default Variable Name Mandatory Text box Up to 255 characters Yes Yes None %%FTP-RPATHx %%FTP-LPATHx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1039

Translate Table

Translate Table
Specifies a file on an z/OS system containing translate tables for the data connection.

Format
Usage Format Valid Values Default Variable Name Optional Text box 1-8 characters None %%FTP-TRANSTABx Note: x indicates a value between 1-5, according to the sequential transfer number

1040

Control-M Parameter Guide

Unit

Unit
The Unit on which the z/OS data set is allocated.

Format
Usage Format Length Default Variable Name Optional Text box 1-8 characters None %%FTP-UNITx Note: x indicates a value between 1-5, according to the sequential transfer number

Chapter 12

Advanced File Transfer parameters

1041

Use Configuration Default

Use Configuration Default

This parameter can be selected if you are working offline and want to use the default number of retries defined in the configuration file.

Format
Usage Format Valid Values Optional Check box

Checked - use the value defined in configuration Unchecked - use the value defined in the Number of Retries parameter

Default Variable Name

Unchecked %%FTP-USE_DEF_NUMRETRIES

1042

Control-M Parameter Guide

User Name

User Name
The user name of the host computer.

Format
Usage Format Variable Name Read-only Text %%FTP-LUSER %%FTP-RUSER

General information
User name of the host computer. The User Name must include the domain when

the host has an operating system type of Microsoft Windows, and Control-M/Agent is running on it. the host has an operating system type of Microsoft Windows. Control-M/Agent is not running on it, but the server installed on it requires the domain for login.

Chapter 12

Advanced File Transfer parameters

1043

Volume

Volume
The Volume on which the z/OS data set is allocated.

Format
Usage Format Length Default Variable Name Optional Text box 1-6 characters None %%FTP-VOLUMEx Note: x indicates a value between 1-5, according to the sequential transfer number

1044

Control-M Parameter Guide

Chapter

13

13

PeopleSoft parameters
This section describes the parameters in the PS8 panel for PeopleSoft jobs. This panel is displayed in the Job Editing form when Control-M/CM for PeopleSoft is installed on your data center. The basic Control-M parameters for PeopleSoft jobs are summarized in Table 195. Each parameter is described in this section. For more information, see your PeopleSoft Process Scheduler manual.

NOTE
Other Control-M job parameters are available for additional processing of PeopleSoft jobs. For more information, see the other sections in this help.

Table 195 PeopleSoft panel parameters summary

Parameter Description Connection Profile Name for a set of attributes that define a connection between Control-M/CM for PeopleSoft and a PeopleSoft application server. Email Subject Email Text Email With Log Format Process Name (I) Process Name (II) Process Type Rerun From Step Run Control ID Server Name Type User ID Userdef1/2/3 Indicates the subject line for an email message that is sent by the job. Message text to be displayed in the body of an email message. Indicates that Structured Query Report (SQR) program log files are attached to an email message. Output type for the process or job. Name of a PeopleSoft process. Name of a job (collection of PeopleSoft processes). Type of process for the process or job definition. Process number from which a job that failed previously should be rerun (generally the process where the job previously failed). Set of run control attributes to be associated with a job or process. Name of the PeopleSoft Server. Output destination type of a process or job. PeopleSoft user ID name to be used for the job. User-defined parameters that are made available to the PeopleSoft process or job by Control-M/CM for PeopleSoft.

Chapter 13 PeopleSoft parameters

1045

Connection Profile

Connection Profile
Name for a set of attributes that define a connection between Control-M/CM for PeopleSoft and a PeopleSoft application server.

Format
Usage Length Case Sensitive Invalid Characters Default Variable Name Mandatory 1 - 30 characters Yes Blanks None %%PS8-CON_PROFILE

General information
A connection profile defines the connection attributes between Control-M/CM for PeopleSoft and a PeopleSoft environment. The connection profile must exist before it is specified in a job. Click Select next to the Connection Profile text box to display a list of profiles that have been defined. The connection profile contains the following parameters:

Connection profile name PeopleSoft user name PeopleSoft password PeopleSoft server name PeopleSoft server port PeopleTools version

The PeopleSoft user name specified in the profile must have authorization to handle all PeopleSoft jobs and processes in the PeopleSoft environment. To manage connection profiles, specify the psftcm profcfg Control-M/CM for PeopleSoft command. For more information about this command, see the Control-M/Control Module for PeopleSoft Administrator Guide.

TIP
During the Control-M/CM for PeopleSoft installation, an existing Control-M Option for PeopleSoft environment file can be converted to a connection profile.

1046

Control-M Parameter Guide

Email Subject

Email Subject
Indicates the subject line for an email message that is sent by the job.

Format
Usage Length Case Sensitive Variable Name Optional. Available if the Type parameter is set to Email. 1- 50 characters No %%PS8-EMAIL_SUBJECT

Related parameters
Parameter Email Text Email With Log Type Description Specifies the message text for the body of the email. Indicates that SQR program log files should be included as an attachment to the email message. Specifies the output destination type of a process or job.

General information
When the Type parameter in the Distribution window is set to Email, use the Email Subject parameter to enter the subject line for the email message produced by the job. The text must not exceed 50 characters. For more information, see Type on page 1057.

Chapter 13 PeopleSoft parameters

1047

Email Text

Email Text
Use this parameter to enter the body of an email message that is sent by the job.

Format
Usage Case Sensitive Variable Name Optional. Available if the Type parameter is set to Email. No %%PS8-EMAIL_TEXT

Related parameters
Parameter Email Subject Email With Log Type Description Contains the subject line of the email message. Indicates that SQR program log files should be included as an attachment to the email message. Specifies the output destination type of a process or job.

General information
When the Type parameter in the Distribution window is set to Email, use the Email Text parameter to enter the message text for the email message produced by the job. The text must not exceed 250 characters. For more information, see Type on page 1057.

1048

Control-M Parameter Guide

Email With Log

Email With Log

Use this parameter to attach log files generated by the SQR program to an email message that is sent by the job.

Format
Usage Optional. Available if the Type parameter is set to Email.

When this option is selected, the email message is sent with an SQR log file attachment. When this option is not selected, the email message is sent without an SQR log file attachment. Default.

Variable Name

%%PS8-EMAIL_ATTACH_LOG

Related parameters
Parameter Email Subject Email Text Process Type Type Description Contains the subject line of the email message. Specifies the message text for the body of the email. The process type selected determines what output destination types are available for the Type parameter. Specifies the output destination type of a process or job.

General information
When the Type parameter in the Distribution window is set to Email, use the Email With Log parameter to include log files as an attachment to the email message produced by the job. These log files result from the Structured Query Report (SQR) program when SQR is selected as the Process Type for the job.

Chapter 13 PeopleSoft parameters

1049

Format

Format
Indicates the output format for all processes in a job.

Format
Usage Variable Name Optional %%PS8-OUTDESTFORMAT

Related parameters
Parameter Process Type Type Description The process type selected determines what output destination types are available for the Type parameter. Specifies the output destination type of a process or job.

General information
Lists the format types that are available for the specified Process Type and Type parameters.

NOTE
Valid values for this parameter correspond to values for a PeopleSoft job. For more information about the Format parameter, see your PeopleSoft Process Scheduler manual.

EXAMPLE
If SQR is specified for the Process Type parameter and PRINTER is specified for the Type parameter, valid values for the Format parameter are: HP LP PS WP

1050

Control-M Parameter Guide

Process Name (I)

Process Name (I)

Name of the process to be scheduled.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1 - 8 characters Uppercase only Blanks %%PS8-PRCSNAME

Related parameters
Parameter Process Name (II) Description Identifies the name of the job to be scheduled.

General information
Enter a name in the text box field or click Select and Edit to display a list of process names that have been defined.

EXAMPLE
If SQR is specified for the Process Type parameter and the process produces a report named RESULTSQR.SQR, the value of Process Name (I) is RESULTSQR.

Chapter 13 PeopleSoft parameters

1051

Process Name (II)

Process Name (II)

Name of the job to be scheduled.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1 - 12 characters Uppercase only Blanks %%PS8-JOBNAME

Related parameters
Parameter Process Name (I) Description Identifies the name of the process to be scheduled.

General information
Enter a name in the text box field or click Select and Edit to display a list of job names that have been defined.

EXAMPLE
If SQR is specified for the Process Type parameter and the job produces a report named REPORTSQR.SQR, the value of Process Name (II) is REPORTSQR.

1052

Control-M Parameter Guide

Process Type

Process Type
Indicates the type of process for the process or job definition.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1 - 30 characters Yes None %%PS8-PRCSTYPE

Related parameters
Parameter Type Description The selected Process Type determines what output destination types are available. Use the Type parameter to specify the output destination type of a process or job.

General information
A global definition under which related processes or jobs definitions are grouped. Enter a name in the text box field or click Search to display a list of process types. Examples of process types are COBOL, Crystal, SQR, and Application Engine.

Chapter 13 PeopleSoft parameters

1053

Rerun From Step

Rerun From Step

Rerun a job from a specific process number.

Format
Usage Value Variable Name Optional Integer %%PS8-FAILEDSTEP

General information
The process or job must have run and ended. Jobs that ended successfully can be started to run again. Jobs that contain more than one process, and did not end successfully, can be rerun from a specified process number. For more information about rerunning a job from a failed process, see the Control-M/Control Module for PeopleSoft Administrator Guide.

1054

Control-M Parameter Guide

Run Control ID

Run Control ID
Run control attributes that are associated with a process or job.

Format
Usage Length Case Sensitive Variable Name Mandatory 1 - 30 characters Yes %%PS8-RUNCONTROLID

Related parameters
Parameter Server Name User ID Description Identifies the name of the server that the application is scheduled to run on. Identifies the PeopleSoft user ID of the user authorized to submit the process or job.

General information
The Run Control ID parameter, together with the User ID parameter, uniquely identifies the process that is running. It enables required parameters to be available for a process when it runs. Enter an ID in the text box field or click Search to display a list of IDs.

Chapter 13 PeopleSoft parameters

1055

Server Name

Server Name
Identifies the name of the server to be used for running the process or job.

Format
Usage Length Case Sensitive Invalid Characters Default Variable Name Optional 1 - 8 characters Yes Blanks None %%PS8-SERVERNAME

Related parameters
Parameter Run Control ID Connection Profile User ID Description Set of run control attributes associated with a process or job. Set of attributes that define a connection between Control-M/CM for PeopleSoft and a PeopleSoft application server. Identifies the PeopleSoft user ID of the user authorized to submit the process or job.

General information
The name of the server depends on the Connection Profile parameter. The Server Name parameter identifies the name of the application server on which the process or job is scheduled to run. To specify the Server Name parameter, enter a name in the text box field or click Select to display a list of existing server names.

1056

Control-M Parameter Guide

Type

Type
Output destination type, specifying the file path, printer destination, URL, or email address.

Format
Usage Default Variable Name Optional File %%PS8-OUTDESTTYPE

Related parameters
Parameter Email Subject Email Text Email With Log Format Process Type Description Contains the subject line of the email message. Specifies the message text for the body of the email. Indicates that SQR program log files should be included as an attachment to the email message. Selects the output format for all processes in a job. The process type selected determines what output destination types are available for the Type parameter.

General information
The output destination types available for the Type parameter depend on the process specified with the Process Type parameter. For example, if SQR is specified for the Process Type parameter, you can select one of the following output destination types:

Email File Printer Web

Additional distribution information must be specified when the output type is either Email or Web. When the output type is Web, select a folder name to which the output should be distributed. Use the Format parameter to select the output format for the specified Type parameter. For more information, see Format on page 1050.

Chapter 13 PeopleSoft parameters

1057

User ID

User ID
PeopleSoft user ID of the user authorized to submit the process or job.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Mandatory 1 - 30 characters Yes Blanks %%PS8-USERID

Related parameters
Parameter Run Control ID Server Name Description Identifies a set of run control attributes to be associated with a process or job. Identifies the name of the server where the application is scheduled to run.

General information
The PeopleSoft user with the specified User ID must be authorized to run the specified process or job. Control-M has a security mechanism that insures that requestors cannot submit a job that they are not authorized to submit. In addition, when building a job processing definition, the selection list of possible jobs and processes is limited by the users privileges in PeopleSoft. This parameter is mapped to the Control-M/EM Owner parameter. For more information, see Owner on page 640.

1058

Control-M Parameter Guide

Userdef1/2/3

Userdef1/2/3
Specify Control-M data to be shared with PeopleSoft processes or jobs.

Format
Usage Length Case Sensitive Invalid Characters Variable Name Optional 1 - 30 characters No None %%PS8-USERDEF1/2/3

General information
This parameter enables you to specify and share data from Control-M with PeopleSoft processes or jobs. You can enter AutoEdit variables or constants, according to your requirements (for example, filename). User-defined values are made available to your application by accessing userdef(x) in the CONTROLM record.

EXAMPLE
You can create a number of Control-M/CM for PeopleSoft jobs that correspond to the same process, but with different parameters.

Chapter 13 PeopleSoft parameters

1059

Userdef1/2/3

1060

Control-M Parameter Guide

Chapter

14

14

Microsoft Windows parameters

The parameters described in this section are for the WIN panel of the Job Editing form. These parameters are only relevant if Control-M/Agent Microsoft Windows version 6.0.0x or later is installed in your data center. Table 196 Microsoft Windows parameters
Parameter Job Execution Time Job Memory Max Work Set Size Min Work Set Size Priority Class Process Execution Time Process Memory Scheduling Class Description Maximum amount of elapsed execution time, in seconds, for the job. Maximum amount of memory, in megabytes, allowed for the job. Maximum RAM, in megabytes, for all processes of the job. Minimum RAM, in megabytes, for all processes of the job. Highest priority class the job and its children can receive. Maximum amount of elapsed execution time, in seconds, for each process in a job. Maximum amount of memory, in megabytes, allowed for each process in a job. Scheduling class for all processes of a job.

NOTE
The job fails if the maximum value set for a parameter is exceeded. The OSCOMPSTAT will equal -3.

Chapter 14 Microsoft Windows parameters

1061

Job Execution Time

Job Execution Time

Maximum amount of elapsed execution time, in seconds, for the job.

Format
Usage Format Variable Name Optional CPU time, in seconds. Min: 0.1 Max: 1.8 x 1012 %%WIN2K-PER_JOB_USER_TIME_LIMIT

NOTE
BMC Software recommends entering application data using the required panel in the ControlM/EM Job Editing form.

1062

Control-M Parameter Guide

Job Memory

Job Memory
Maximum amount of memory, in megabytes, allowed for the job.

Format
Usage Format Variable Name Optional Memory, in megabytes. Min: 0.1 Max: 4200.0 %%WIN2K-JOB_MEMORY_LIMIT

Chapter 14 Microsoft Windows parameters

1063

Max Work Set Size

Max Work Set Size

Maximum RAM, in megabytes, for all processes of the job.

Format
Usage Format Variable Name Optional. RAM, in megabytes. Min.: 0.1 Max.: 4200.0 %%WIN2K-MAXIMUM_WORKING_SET_SIZE

1064

Control-M Parameter Guide

Min Work Set Size

Min Work Set Size

Minimum RAM, in megabytes, for all processes of the job.

Format
Usage Format Variable Name Optional RAM, in megabytes. Min.: 0.1 Max.: 4200.0 %%WIN2K-MINIMUM_WORKING_SET_SIZE

Chapter 14 Microsoft Windows parameters

1065

Priority Class

Priority Class
Highest priority class the job and its children can receive.

Format
Usage Format Optional List box. Valid values:

IDLE_PRIORITY_CLASS BELOW_NORMAL_PRIORITY_CLASS NORMAL_PRIORITY_CLASS ABOVE_NORMAL_PRIORITY_CLASS HIGH_PRIORITY_CLASS REALTIME_PRIORITY_CLASS

Variable Name

%%WIN2K-PRIORITY_CLASS

General information
The calling process must enable the SE_INC_BASE_PRIORITY_NAME privilege so that the calling process is allowed to boost the scheduling priority of a process.

1066

Control-M Parameter Guide

Process Execution Time

Process Execution Time

Maximum amount of elapsed execution time, in seconds, for each process in a job.

Format
Usage Format Variable Name Optional CPU time, in seconds. Minimum: 0.1 Maximum: 1.8 x 1012 %%WIN2K-PER_PROCESS_USER_TIME_LIMIT

General information
If the user-mode time for any process exceeds the specified amount, that process is terminated.

Chapter 14 Microsoft Windows parameters

1067

Process Memory

Process Memory
Maximum amount of memory, in megabytes, allowed for each process in a job.

Format
Usage Format Variable Name Optional Memory, in megabytes. Minimum: 0.1 Maximum: 4200.0 %%WIN2K-PROCESS_MEMORY_LIMIT

1068

Control-M Parameter Guide

Scheduling Class

Scheduling Class
Scheduling class for all processes of a job.

Format
Usage Format Valid values: 0 9.

0 - provides the minimum resources 9 - provides the maximum resources

Default Variable Name

5 %%WIN2K-SCHEDULING_CLASS

General information
To use a scheduling class greater than 5, the calling process must enable the SE_INC_BASE_PRIORITY_NAME privilege. If the Logon as user option is turned off, no special change is needed. If the Logon as user option is turned on, Increase Scheduling Priority must be granted to the owner of the job.

Chapter 14 Microsoft Windows parameters

1069

Scheduling Class

1070

Control-M Parameter Guide

Chapter

15

15

Control-M AutoEdit facility

The AutoEdit facility consists of a group of special variables and functions that can be used to make your job processing definitions more dynamic. This facility also enables you to define your own variables.

NOTE
Certain AutoEdit functions and variables work differently for z/OS jobs. Although some of these differences are described in this section,BMC recommends that you consult the Control-M for z/OS User Guide for a more complete description of AutoEdit functionality for z/OS jobs.

Using AutoEdit variables and functions, you can

access information about the system under which a job is running pass information to a job or modify working parameters of the job pass information in a Shout message or a Do Mail message to a user when the job ends

You cannot include application-specific job parameters in the values of AutoEdit variables. The names of application-specific job parameters are prefixed by two percent signs, the applications abbreviation and a hyphen (%%SAPR3- for SAP, %%OAP- for Oracle, and so on). AutoEdit variables in a job processing definition are resolved immediately before the job is submitted, in the order in which they appear in the job processing definition. If an AutoEdit variable is included in the shout, doshout, domail, SYSOUT handling, and dosysout of the job, the AutoEdit variables are re-evaluated and resolved when these actions are performed.

NOTE
If a job is rerun, the AutoEdit statements specified in the Auto Edit Assignment parameter are resolved before those specified using the Do AutoEdit parameter.

Chapter 15 Control-M AutoEdit facility

1071

Table 197 describes job parameters that can accept AutoEdit variables or expressions as values. For more information about variable types, see AutoEdit variables on page 1073. For more information about AutoEdit functions, see AutoEdit Expressions on page 1088. Table 197 Parameters that accept AutoEdit variables and expressions
AutoEdit Assignment

Modifies working parameters for a job and/or passes parameters to a job when the job is submitted. Defines variables that can be displayed in a Shout message or Do Mail message when a job completes.

Note: This parameter is called Setvar in certain Control-M/Server utilities and in Control-M/Desktop. Command Do AutoEdit AutoEdit variables can be used as part of the command string. Enables the user to specify AutoEdit statements to be resolved (in addition to those specified for AutoEdit Assignment) depending on how a job ended. These can be local variables to be used if the job is rerun, or they can be global variables to be used by other jobs. AutoEdit variables can be used in this parameter to indicate the name of the library or directory in which the file described in the Path parameter is located. AutoEdit variables can be used in this parameter to indicate the name of the file containing the job commands or job script. AutoEdit variables can be used in this parameter to provide the name of an alternate library or directory in which to search for the file that was specified using the MEMNAME parameter. AutoEdit variables can be used in a Shout or Do Shout message to pass job parameters or other data to a user. AutoEdit variables can be used in the field which provides supplementary information about the handling of the jobs SYSOUT (for example, a filename) when the job ends OK.

Path (Mem Lib) File Name (Mem Name) Over Lib

Shout or Do Shout Sysout Handling or Do Sysout

The AutoEdit Assignment and Do AutoEdit parameters can also use the %%LIBMEMSYM variable to reference a list of AutoEdit expressions in a separate text file. For more information, see Variable lists on page 1085.

1072

Control-M Parameter Guide

AutoEdit variables

AutoEdit variables
All AutoEdit variables are identified by the %% prefix. If %% is included in the value for a job processing parameter, Control-M assumes that it is referring to an AutoEdit variable or function.

NOTE
A special %%# prefix can be used to indicate that an AutoEdit variable or function should not be resolved. In these cases, the actual name of the AutoEdit variable or function (minus the # sign) is output. For example, Do Shout Variable %%#PARM1 is greater than 100 issues the following message: Variable %%PARM1 is greater than 100. For more information about AutoEdit variable prefixes, see Table 205 on page 1083.

AutoEdit variables are divided into the following types:

Job Submission variables pass parameters to a job or set the jobs working parameters. For more information, see Job submission variables on page 1073. System variables are automatically assigned values using system information available at the time of job submission (for example, %%DATE contains the current system date). For more information, see Control-M system variables on page 1078. User-defined variables can be defined in a number of different ways for inclusion in various job processing parameters. For more information, see User-defined variables on page 1082. Variable lists. The %%LIBMEMSYM special variable can be used to point to a file containing a list of AutoEdit assignments statements to be applied to a job. This variable enables you to create one or more lists of AutoEdit assignment statements that can be applied to many job processing definitions. For more information, see Variable lists on page 1085.

Job submission variables

Job submission variables pass parameters to a job or set the jobs working parameters. Certain job submission variables are available only for certain computers. Table 199 through Table 202 describe variables that are computer-specific.

Chapter 15 Control-M AutoEdit facility

1073

Job submission variables

NOTE
All job submission variable names must be specified using uppercase letters.

Table 198 General job submission variables

Name %%DBGLVL Description numeric The agent process uses the First Failure Data Capture mechanism to write all the information collected and then sets the debug level to the value specified in the AutoEdit when processing the job. BMC recommends that when setting the %%DBGLVL AutoEdit, that you also set the First Failure Data Capture Reset interval (sec) parameter in the Control-M Configuration Manager to the value of 5. This causes the tracker process to stop writing debug information 5 seconds after having been invoked by the %%DBGLVL AutoEdit instead of the default of 600 seconds. %%OVERLIB %%PARMn string Over Lib (name of an alternate library/directory in which job script is stored) of the job.

Job submission parameter, where n represents the parameter number. This variable can be used to pass parameters to all types of jobs.

On OpenVMS computers %%PARMn is used to represent the P1 through P8 parameters. For other computers, n can be a number between 1 and 32.

Note that for Control-M version 2.1x on an iSeries (AS/400) computer, the value for variable %%PARMn must not include single quotation marks. If quotation marks are necessary, use double quotation marks only.

Table 199 OpenVMS job submission parameters

Name %%QUEUE Description Name of the batch queue to which the job is submitted. For VMS cluster configurations: Specify only those queues that are defined in the systems queue manager where Control-M runs.

The variables described in Table 200 correspond to parameters of the iSeries (AS/400) Submit Job command. For more information about the valid values for these parameters, see your iSeries (AS/400) SBMJOB command documentation.

1074

Control-M Parameter Guide

Job submission variables

Table 200 iSeries (AS/400) job submission parameters

Name %%ACGCDE Description Accounting code for the job. Valid values are in the <accountingCode> format or one of the following special values: *USRPRF, *USER, *JOBD, *NOCHG, or *NONE Note: This variable is relevant only for Control-M/Agent for iSeries (AS/400) version 2.25 or later. %%CURLIB %%DATE %%HOLD %%INQMSGRPY %%JOBD Name of the current library associated with the job being run. Date that is assigned to the job when it is started. Whether the job is held at the time that it is put on the job queue. Manner in which pre-defined messages issued as a result of running this job are answered. Job description. Valid values are in the <library>/<jobDescription> format or the value: *USRPRF %%JOBPTY %%QUEUE Job queue scheduling priority. Name of the batch queue to which the job is submitted. Valid values are in the <library>/<jobQueue> format or the value: *JOBD %%JOBQ %%LDA %%LIBL or %%INLLIBL %%LOG %%LOGCLPGM Message logging values used to determine the amount and type of information sent to the job log by the job. Whether the commands that are run in a control language program are logged to the job log through the message queue of the CL program. Same as %%QUEUE. Local data areas (see Expressions for %%LDA [iSeries (AS/400) only] on page 1095). Library list. Note: The %%INLLIBL variable is relevant only for Control-M/ Agent for iSeries (AS/400) version 2.25 or later.

Chapter 15 Control-M AutoEdit facility

1075

Job submission variables

Table 200 iSeries (AS/400) job submission parameters

Name %%MSGQ Description Name of the message queue to which a completion message is sent when the submitted job has completed execution. Valid values are in the <library>/<messageQueue> format or one of the following special values: *USRPRF, *WRKSTN, or *NONE Note: Control-M/Agent for iSeries (AS/400) version 2.25 or later uses a specific message queue as an event mechanism for job completion. If the message queue for a job is changed using the %%MSGQ variable, the event driven mechanism for this job is disabled. %%OUTPTY %%OUTQ Output priority for spooled output files produced by the job. Qualified name of the output queue used for spooled files that specify OUTQ(*JOB). Valid values are in the <library>/<outputQueue> format or one of the following special values: *CURRENT, *USRPRF, *DEV, or *JOBD %%PRTDEV %%PRTTXT %%RTGDTA %%SWS %%SYSLIBL %%HEX Qualified name of the default printer device for this job. Up to 30 characters of text that is printed at the bottom of each page of printed output and on separator pages. Routing data used to start the first routing step in the job. Job switches. System portion of the initial library list that is used by the submitted job. Indicates that the value that immediately follows is a hexadecimal value, such as %%PARMn=%%HEX2AF4. This function ensures that the value is transferred to iSeries (AS/400) in the appropriate format. %%DEC Indicates that the value that immediately follows is a packed decimal value, such as, %%PARMn=%%DEC1289. This function ensures that the value is transferred to iSeries (AS/400) in the appropriate format.

1076

Control-M Parameter Guide

Job submission variables

Table 201 UNISYS job submission parameters

Name %%ACCOUNT %%ADDRUN Description Account ID for the job run. Execution statement to be inserted before the execution of the user's job. Examples: %%ADDRUN="@prt,i" or %%ADDRUN="@add myqual*myfile.myelt" Control-M/Agent inserts the specified command before the user job's runstream prior to job submission. Deadline assignment for the job. Flag that indicates if a job contains programs that print or direct standard output to the PR print queue. Node ID of the UNISYS computer to which the job is submitted. If specified, the value for %%NODEID overrides the contents of the job processing parameter Node ID. If this variable is assigned the value CTMLOCAL, the job is submitted on the Control-M/Server computer. Note: Do not use this variable in a SMART Table definition. %%OPTION %%PROJECT %%RUNTIME Options to be appended to the @START command. Project ID for the job run. Estimated run time for the job.

%%DEADLINE %%INJOBPR %%NODEID

Table 202 Tandem job submission parameters

Name %%TANDEM_ASSIGN_xxx Description Enables the user to specify a TANDEM ASSIGN as an AutoEdit variable to be used in a Control-M job environment. Where xxx is the name of the Tandem ASSIGN variable. %%TANDEM_BYPASS_JOB %%TANDEM_CPU %%TANDEM_DEFINE_xxx Enables the user to simulate running a dummy job. Specifies a CPU on which a job should run. Enables the user to specify a TANDEM DEFINE variable as an AutoEdit variable to be used in a Control-M job environment. Where xxx is the name of the Tandem DEFINE variable. %%TANDEM_INPUT_FILE %%TANDEM_PARAM_xxx Name of a file containing a script to run in a detached job. Enables the user to specify a TANDEM PARAM variable as an AutoEdit variable to be used in a Control-M job environment. Where xxx is the name of the Tandem PARAM variable.

Chapter 15 Control-M AutoEdit facility

1077

Control-M system variables

Control-M system variables

Table 203 describes the available AutoEdit system variables. These reserved variables can be used to include system information in job processing parameter values. Please note the following:

Start of the week depends upon user preferences specifying whether 1 = Sunday or 1 = Monday. Descriptions in Table 203 that refer to day of the week presume that 1= Sun. Consult your Control-M administrator to determine which standard is used at your site. All System variable names must be specified using uppercase letters. Certain system variables can be referenced only after job completion (in postprocessing parameters). These variables are listed separately in Table 204 on page 1081.

Table 203 Control-M system variables

Name %%$DATE %%$NEXT %%$ODATE %%$OYEAR %%$PREV %%$RDATE %%$RYEAR %%$YEAR %%APPLGROUP %%APPLIC Format yyyymmdd yyyymmdd yyyymmdd yyyy yyyymmdd yyyymmdd yyyy yyyy string string Description Current system date (4-digit year). Next scheduling date for the job (4-digit year). Original scheduling date of the job (4-digit year). Original scheduling year of the job (4-digit year). Previous scheduling date for the job (4-digit year). Installation current working date (4-digit year). Installation current working year (4-digit year). Current system year (4-digit year). Name of the group to which the job belongs. Name of the Application to which the jobs group belongs. Note: For z/OS jobs the %%APPL variable is used to reference the Application name. %%BLANKn %%CENT n spaces yy Resolves to n blanks, where n is a number between 1 - 214. First two digits in the current year (for example, 20 in year 2006).

1078

Control-M Parameter Guide

Control-M system variables

Table 203 Control-M system variables

Name %%CYCLIC Format Y|N Description This variable is used in the command line of the ctmorder utility to override the Cyclic parameter in cases where the user wishes to order a single run of a job that is defined as cyclic. Y job is cyclic N job should be run only once. %%DATACENTER string Name of the data center for the current Control-M installation. Note: This variable is available on certain Control-M computers as of Control-M version 2.20. However, prior to CONTROL-M/EM version 6.1.02, %%DATACENTER returned the host name for the current Control-M/Server. %%DATE %%DAY %%GROUP_ORDID yymmdd dd nnnnnn Current system date. Current system day. Order ID of the Active table to which the job belongs. Note:

This variable is valid only for jobs in an Active table and it is evaluated in base 10. This variable has been retained for versions of Control-M earlier than version 7.0.00.

%%JOBNAME

string

Name of the submitted job. This variable can be used to override the value specified for the JOBNAME parameter (for example, in the ctmorder utility). Note: On a Microsoft Windows computer, JOBNAME must comply with Microsoft naming conventions (for example, it cannot contain / and \ characters).

%%JULDAY %%MEMLIB %%MONTH %%NEXT %%ODATE %%ODAY

nnn string mm yymmdd yymmdd dd

Current system day of the year (Julian format). Mem Lib (name of the library or directory in which job script is stored) of the job. Current system month. Next scheduling date for the job. Original scheduling date of the job. Original scheduling day of the job.

Chapter 15 Control-M AutoEdit facility

1079

Control-M system variables

Table 203 Control-M system variables

Name %%OJULDAY Format nnn Description Original scheduling day of the year (Julian format). For example, 36 for February 5th. %%OMONTH %%ORDERID %%OWDAY %%OWNER %%OYEAR %%POSTCMD mm nnnnnn d string yy command Original scheduling month of the job. Unique job order ID under Control-M. Original scheduling day of the week of the job (1= Sun., 2= Mon., and 0=Sat.). Owner (user ID) associated with the job. Original scheduling year of the job. Specifies a command to run immediately after running the job defined by MEMNAME. The return code is ignored. Note: Not relevant for z/OS jobs. Relevant only for Control-M/Server version 6.0.01 or later, or (without SYSOUT) for any job submitted by Control-M/Agent for Microsoft Windows 2000 version 6.0.01 or later. This variable is not used with SMART Tables. Specifies a command to run immediately before running the job defined by MEMNAME. The return code is ignored. Note: Not relevant for z/OS jobs. Relevant only for Control-M/Server version 6.0.01 or later, or (without SYSOUT) for any job submitted by Control-M/Agent for Microsoft Windows 2000 version 6.0.01 or later. This variable is not used with SMART Tables. Previous scheduling date for the job. Installation current working date. Installation current working day. Installation current working day of the year (Julian format). For example, 36 for February 5th. %%RMONTH %%RUNCOUNT mm nnnn Installation current working month. Number of times the job order has been submitted for execution (that is, the first time the job is being submitted, this variable returns a value of 1). Installation current working day of the week (1=Sun., 2=Mon., and 0=Sat.). Installation current working year.

%%PRECMD

command

%%PREV %%RDATE %%RDAY %%RJULDAY

yymmdd yymmdd dd nnn

%%RWDAY %%RYEAR

n yy

1080

Control-M Parameter Guide

Control-M system variables

Table 203 Control-M system variables

Name %%SCHEDTAB Format string Description Name of the jobs table. Note: This variable is available on certain Control-M computers as of Control-M version 2.2x. %%TABLE_ID nnnnnn Order ID of the table to which the job belongs. Note: This variable is valid only for jobs in an active table and it is evaluated in base 10. %%TIME %%WDAY %%YEAR hhmmss n yy Time of day. Current system day of the week (1=Sun., 2=Mon., and 0=Sat.). Current system year.

The following variables are not assigned values until after the job is submitted or completes execution. These variables can be used only for the Shout, Do Shout, Do Mail, and Do AutoEdit parameters.

NOTE
AutoEdit variables that return runtime statistics for a job must be resolved before the variables can return any values. AutoEdit variables for job statistics: %%AVG_CPU, %%AVG_TIME, %%SD_CPU, and %%SD_TIME. Run the ctmjsa utility to compile data in the Statistical Details table before specifying the required AutoEdit statistics variable. For more information, see Runtime Statistics and ctmjsa in the Control-M Administrator Guide.

Table 204 Post-processing system variables

Name %%AVG_CPU Format numeric Description Average CPU time (in seconds) for previous runs of the current job. Note: Do not use this variable in a SMART Table definition. Average run time (in seconds) for previous runs of the current job or SMART Table. Completion code assigned to the job by the operating system of the computer that executes the job. Initial value: 0. Identification assigned to the job by the operating system of the computer that executes the job. Note: Do not use this variable in a SMART Table definition. Node ID of agent computer that submitted the job. Note: This variable is available for certain computers as of Control-M version 2.2x.

%%AVG_TIME %%COMPSTAT

numeric numeric

%%JOBID

string

%%NODEID

string

Chapter 15 Control-M AutoEdit facility

1081

User-defined variables

Table 204 Post-processing system variables

Name %%SD_CPU Format numeric Description Standard deviation of the CPU time (in seconds) from the average CPU time for previous runs of the current job. Note: Do not use this variable in a SMART Table definition. Standard deviation of the elapsed run time (in seconds) from the average elapsed run time for previous runs of the current job or SMART Table.

%%SD_TIME

numeric

User-defined variables
A user-defined variable is created when it is assigned a value using the AutoEdit Assignment parameter or the Do AutoEdit parameter. User variables can also be defined for all jobs in a SMART Table using the Set panel of the Table Editing form. For more information about assigning a value to a variable, see AutoEdit Expressions on page 1088. User-defined variables can be used to

store intermediate values in a series of AutoEdit parameters store values to be included in a command string in the Command parameter store information to be included in a Shout message store information to be included in an e-mail message created with a Do Mail parameter

NOTE
Global variables can be used to pass information between jobs in a data center. For example, job A can set global variable %%A to Yes, and job B on another agent in the same data center can reset %%A to No in response. Global variables can also be created and modified using the CTMVAR utility. For more information about this utility, see the Control-M Administrator Guide. For more information about global variables, see Scope on page 1084.

Resolution of each user variable depends on the specified prefix, and the scope of the specified variable. Each of these concepts is described below.

Syntax
Valid names for user variables are any alphanumeric string (up to 38 characters in length) preceded by a prefix of %%. Blanks are not allowed in a user variable name. The following characters cannot be included as part of the name of a User-defined AutoEdit variable: < > [ ] { } ( ) = ; ` ~ | : ? . + - * / & ^ # @ ! , " '.

1082

Control-M Parameter Guide

User-defined variables

NOTE
Application-specific job parameters may not be specified in AutoEdit variable values. The names of application-specific job parameters are prefixed by two percent signs, the applications abbreviation and a hyphen (%%SAPR3- for SAP, %%OAP- for Oracle, and so on).

Names and values for User variables are case sensitive. For example, %%TEST and %%Test are regarded as two separate variables.

NOTE
Names of AutoEdit variables in Control-M for z/OS must always be in uppercase.

All AutoEdit variables are prefixed by %%. In addition to the %% prefix, certain characters can be added to determine special characteristics. These special prefixes are described in Table 205. Table 205 Variable Prefixes
%%\ Indicates that a variable is global for the data center (Control-M/Server and all its connected agents). This prefix is used only when creating or modifying the variable. When the variable is referenced (for example, in a Do Shout message) it is referenced without the \. For more information about global variables, see Scope on page 1084. %%# Indicates that the variable should not be resolved. This prefix enables inclusion of a variable name as text in job output. The # symbol is stripped from the output, and the remaining AutoEdit variable name is included as text in the appropriate location. For example, a Do Shout message of Job Daily returned a value for variable %%#PARM1 is output as: Job Daily returned a value for variable %%PARM1

Chapter 15 Control-M AutoEdit facility

1083

User-defined variables

Table 205 Variable Prefixes

%%@ Indicates that the variable should contain a value to be resolved by each job that uses it. For example: %%\PARM1 = %%@TIME Indicates that whenever a job uses Global variable %%PARM1, it should be resolved to the execution time of the job (that is, the time at which the variable is referenced). If the above parameter is specified without the @ sign (%%\PARM1 = %%TIME), it always resolves to the execution time of the job that set the variable (that is, the time at which the variable was created). Note: This prefix is relevant only for Global variables whose values contain AutoEdit variables. %% For Windows agents: When specifying AutoEdit variables in the CMDLINE or COMMAND parameters on Control-M/Agent for Windows, the AutoEdit prefix must be specified as %%. Note: If you use an agent utility (such as ctmcreate) in a batch file to specify an AutoEdit variable, ensure that the prefix is %%%%.

Examples
%%A=%%ODATE %%\A=%%ODATE The %%A variable is resolved to the original scheduling date of the job. %%A is local to the job. Global variable %%\A is assigned to the original scheduling date of the job. %%A can be referenced by Control-M/Server or any agent in the data center. All references to variable %%A resolve to the %%ODATE value for the job in which %%A was set. Global variable %%\A is resolved to the original scheduling date of the job. If %%A is referenced by Control-M/Server or a job in any agent in the data center, it resolves to the current value of variable %%ODATE. Note: @ indicates that %%\A should contain a value to be resolved by each job that uses it (in this case, ODATE). %%# A %%# A is not resolved. The text string %%A is returned.

%%\A=%%@ODATE

Scope
The scope of a variable is the extent to which it is available to other jobs. As mentioned above, each variable can be

local for a specific job common to all jobs in a SMART Table global for an entire data center (a Control-M/Server and all its agents) system AutoEdits which are predefined and available for any job in the data center

1084

Control-M Parameter Guide

Variable lists

Multiple variables (each with a different scope) can have the same name. If more than one variable with the same name has been defined, the variable with the narrowest scope is used.

NOTE
The exception to this rule occurs when the AutoEdit variable is distributed from the Control-M/Server to the Control-M/Agent. The variable from the narrowest scope may not be the one that is used by the Control-M/Agent. Depending on the value of the AUTOEDIT_INC_SEC variable of the Control-M/Server, duplicate variables from different scopes can be distributed to the agents. For more information, see the Control-M Administrator Guide.

To determine which AutoEdit variable value to use:

Control-M uses the following logic to determine which value to use when a variable is specified in a job processing definition. 1. Control-M checks if a local variable (for the job) has been defined with the specified name. If a local variable exists, the value specified for that variable is used. 2. If no local variable exists with the specified name, and the job is in a SMART Table, Control-M checks for a variable with the specified name in the SMART Table definition. If the variable is defined in the SMART Table definition, that value is used. 3. If the job is not in a SMART Table, or the variable is not defined in the SMART Table definition, Control-M searches for a Global variable with the specified name. 4. If no definition is found for a specified variable, the variable is resolved to the reserved word CTMERR.

Variable lists
The %%LIBMEMSYM AutoEdit variable can be used in the AutoEdit Assignment or Do AutoEdit parameters to indicate a text file containing a list of AutoEdit assignments. This variable enables you to create a central file containing AutoEdit assignment statements that can be read by many job processing definitions.

Chapter 15 Control-M AutoEdit facility

1085

Variable lists

NOTE
Multiple LIBMEMSYM statements can be included in a single job processing definition. In this way you can maintain groups of local or global variables that are relevant to certain jobs, and allow more than one such group to be applied to a job. However, if a variable is defined in more than one list, the last list defined overrides previous lists.

The format for the %%LIBMEMSYM variable:

%%LIBMEMSYM=path_name

path_name is the full (case sensitive) path name of a text file containing AutoEdit assignment statements. This file must be accessible to Control-M. The file must contain a single assignment on each line.

For the AutoEdit Assignment parameter, the specified file is accessed at the time the job is submitted for execution by Control-M. If a %%LIBMEMSYM statement is specified using the Do AutoEdit parameter, local variables defined in the specified file are relevant only during a rerun of the job if and when the On Statement/Code conditions are satisfied.

NOTE
For z/OS jobs, a variable list can be specified using the %%LIBSYM and %%MEMSYM variables. If a %%LIBMEMSYM variable is specified for an z/OS job, it is treated as a userdefined variable, and does not reference a variable list.

Example
If a job processing definition contains the following specifications for the AutoEdit Assignment parameter:
%%a=5 %%LIBMEMSYM=/controlm/ctm/autoedit.common1 %%PARM1=%%c

And the file /controlm/ctm/autoedit.common1 contains the following entries:

%%b=%%CALCDATE %%DATE -%%a %%yy=%%SUBSTR %%b 1 2 %%mm=%%SUBSTR %%b 3 2 %%dd=%%SUBSTR %%b 5 2 %%c=%%dd/%%mm/%%yy

1086

Control-M Parameter Guide

Variable lists

When the job is submitted for execution by Control-M, AutoEdit variables are resolved as if the AutoEdit Assignment parameter contained the following entries:
%%a=5 %%b=%%CALCDATE %%DATE -%%a %%yy=%%SUBSTR %%b 1 2 %%mm=%%SUBSTR %%b 3 2 %%dd=%%SUBSTR %%b 5 2 %%c=%%dd/%%mm/%%yy %%PARM1=%%c

Chapter 15 Control-M AutoEdit facility

1087

AutoEdit Expressions

AutoEdit Expressions
An AutoEdit expression consists of any of the following:

An elementary expression. Elementary expressions on page 1088 A numeric expression consisting of AutoEdit variables and/or numeric constants using AutoEdit operators. Numeric expressions on page 1089 A string expression formed by concatenating AutoEdit variables and/or alphanumeric strings. String Expressions on page 1091 An AutoEdit function. AutoEdit functions on page 1093 A special expression that can be used to specify Local Data Areas for iSeries (AS/400) jobs. Expressions for %%LDA [iSeries (AS/400) only] on page 1095

NOTE
AutoEdit variables can also be used to represent part of the name of an existing AutoEdit variable in an expression. When this method is used the name of the variable is resolved and then the contents of that variable are used for further resolution of the expression. (For more information, see the examples later in this chapter.)

A Shout message can include an AutoEdit expression as part of its text; however, it cannot assign a value to an AutoEdit variable. The following syntax rules apply to AutoEdit expressions:

Only one expression can be placed on a line. No spaces are allowed before the =. Spaces that immediately follow the = are ignored. Variable names and values are case sensitive. Strings of alphanumeric characters do not require quotation marks. If quotation marks are used, they are considered part of the string.

Elementary expressions

An elementary expression has the following format: variable=value variable is any user variable or job submission variable. value is any numeric or alphanumeric string up to 214 characters in length.

The following expression assigns a value of 100 to the %%Result variable: %%Result=100

1088

Control-M Parameter Guide

Numeric expressions

The following expression assigns the string Job PRDKCZ finished OK to the %%Completion variable: %%Completion=Job PRDKCZ finished OK

Numeric expressions
A numeric expression has the following format:
result=operand operator operand

The components of this expression are described in the following table:

result operand operator Any user variable or job submission variable. Any AutoEdit variable, or a numeric constant. One of the following AutoEdit operators: %%PLUS represents the + operator %%MINUS represents the - operator

Syntax rules
The following syntax rules apply to a numeric expression:

Only one operator can be used in each expression. There should be no spaces immediately before or after the =. There must be spaces before and after the operator.

NOTE
When specifying AutoEdit functions that return dates, such as %%$CALCDATE or %%$DATE, there should be no spaces between the + (plus) or - (minus) sign and the number of days to add or subtract. In this case, the + and - signs are not considered numeric expression operators and are not related to the rules specified here. For more information, see %%CALCDATE and %%$CALCDATE on page 1093.

EXAMPLE
In the following example, %%YESTERDAY resolves to 0 on July 1: %%YESTERDAY=%%DAY %%MINUS 1

Chapter 15 Control-M AutoEdit facility

1089

Numeric expressions

EXAMPLE
In the following example, %%PARM1 resolves to 46 on February 5th: %%X=%%RJULDAY %%MINUS %%DAY %%PARM1=%%X %%PLUS 15

1090

Control-M Parameter Guide

String Expressions

String Expressions
A string expression has the following basic format:
<variable>=<value>[.]<value>...

The components of this expression are described in the following table:

<variable> <value> . (period) Any user variable or job submission variable. Any AutoEdit variable, or alphanumeric string. If specified, indicates that the values before and after the period should be concatenated.

Syntax rules
The following syntax rules apply to a string expression:

Any spaces in the expression (including those immediately following the =) are regarded as part of the string and are included in the result. A period is used to concatenate two variables. No concatenation character is required to link two strings. To include a period as part of the string between two concatenated variables, use two consecutive periods (see example below). Any number of variables or strings can be concatenated in an expression. If one variable follows another with no period in between, the two variables are combined to form the name of a third variable (see example below). Concatenation progresses from right to left until the entire expression is resolved.

Chapter 15 Control-M AutoEdit facility

1091

String Expressions

Examples
%%X resolves to 0312:
%%X=%%DAY.%%MONTH

%%Y resolves to 03.12:

%%Y=%%DAY..%%MONTH

%%Z resolves to Today is 03/12/05:

%%Z= Today is %%DAY/%%MONTH/%%YEAR

The following sequence passes a value to %%PARM1 based on the day of the month. This example illustrates building the name of a variable in the expression:
%%BackupTape_01=301 %%BackupTape_02=302 %%BackupTape_03=303 %%PARM1=%%BackupTape_%%DAY

The %%BackupTape_%%DAY expression is resolved in two steps (from right to left): 1. Given that the system date is Dec. 3, %%DAY resolves to 03. The resulting expression is: %%PARM1=%%BackupTape_03 2. Next, Control-M resolves the %%BackupTape_03 variable. Since the value of this variable is 303, the resulting expression is: %%PARM1=303

1092

Control-M Parameter Guide

AutoEdit functions

AutoEdit functions
An AutoEdit function performs an action or process on the specified user variable or job submission variable. AutoEdit functions are used instead of another expression. The following functions are available: Table 206 AutoEdit Functions
Function %%CALCDATE and %%$CALCDATE %%GETENV <environment variable> %%SUBSTR Description Adds or subtracts a specified number of days from a specified date. Same as %%CALCDATE, but handles 4-digit years. Retrieves the value of an environment variable. Extracts a substring from a specified string.

%%CALCDATE and %%$CALCDATE

%%CALCDATE is a numeric function that adds or subtracts a quantity of days from a given date. This function has the following format:
result=%%CALCDATE date +|-quantity

The components of this expression are described in the following table:

result date quantity Any user variable or job submission variable. Date or variable in yymmdd (yyyymmdd for %%$CALCDATE) format. This value must be preceded and followed by a space. Number (or variable that resolves to a number) of days to add or subtract from the date.

EXAMPLE
On July 2, 2005, %%A resolves to 050630 in any of the following expressions: %%A=%%CALCDATE %%DATE -2 %%A=%%CALCDATE 050702 -%%DAY %%A=%%CALCDATE 050628 +2

EXAMPLE
On July 2, 2005, %%A resolves to 20050630 in any of the following expressions %%A=%%$CALCDATE %%$DATE -2 %%A=%%$CALCDATE 20050702 -%%DAY %%A=%%$CALCDATE 20050628 +2

Chapter 15 Control-M AutoEdit facility

1093

AutoEdit functions

%%SUBSTR
%%SUBSTR is a string function that is used to extract a substring from within a larger string. This function has the following format:
result=%%SUBSTR variable startpos length

The components of this expression are described in the following table:

result variable startpos length Any user variable or job submission variable. Any AutoEdit variable. Numeric literal or variable that indicates the first position in the original string from which to extract the substring. The first character is position 1. A number or variable, indicating the length of the substring to extract.

NOTE
The values specified for both <startpos> and <length> must be (or resolve to) a number greater than zero.

EXAMPLE
In the following series of expressions, %%Number resolves to TWO: %%Nstring=ONETWOTHREE %%Start=4 %%Number=%%SUBSTR %%Nstring %%Start 3

%%GETENV <environment variable>

This function retrieves the value of an environment variable. It has the following format: result=%%GETENV <environment variable>.

EXAMPLE
%%A=%%GETENV HOME %%A resolves to the Control-M/Server user home directory.

1094

Control-M Parameter Guide

Expressions for %%LDA [iSeries (AS/400) only]

Expressions for %%LDA [iSeries (AS/400) only]

%%LDA is a special variable that can be used to specify Local Data Areas for iSeries (AS/400) jobs. The following format can be used when specifying an expression to assign a value to job submission variable %%LDA for a job:
%%LDA[_startpos[_length] [_dec]]=AutoEdit_exp

The components of this expression are described in the following table:

startpos length dec AutoEdit_exp A number indicating the starting position in the LDA at which to place the results of the specified expression. A number, indicating how many positions in LDA to reserve for the results of the expression. A number indicating how many decimal places to include in the packed decimal value passed to the LDA. The AutoEdit expression whose resolved value should be placed in the indicated location in the LDA.

EXAMPLE
Assuming that the system date is December 15, the following expression: %%LDA_2_3=%%DAY is submitted to iSeries (AS/400) as: CHGDTAARA *LDA(2 3) VALUE(15) The following expression inserts the packed value of 00123.40 into the LDA starting in position 11 for a decimal length of 7 (Actual Packed length of 4): %%LDA_11_7_2=123.4

Chapter 15 Control-M AutoEdit facility

1095

Expressions for %%LDA [iSeries (AS/400) only]

1096

Control-M Parameter Guide

Chapter

16

16

Control-M Business Process Integration Suite parameters

This section describes the parameters in the various Control-M/Control Module for BPI panels, in the Job Editing form. This panel is displayed in the Job Editing form when Control-M/CM for BPI is installed on your data center. Basic Control-M parameters for Control-M/CM for BPI jobs are summarized in the following tables. Each of these parameters is described in detail in the remainder of this section. The parameter descriptions are in alphabetical order.

NOTE
Other Control-M job parameters and variables can be used to apply additional processing to Control-M/CM for BPI jobs. For more information about these parameters, see the other sections in this help.

Table 207 JAVA panel parameters summary

Parameter Account (CONTROL-M/CM for BPI Java Applications) Object Method Description A profile that is used to create and execute an EJB or Java Class job. Mandatory.

Name of the EJB or Java Class according to which the Method parameter value is specified. Mandatory. A method applicable to the specified Java Application class. Mandatory.

Exclude Job Output An option to exclude information about job output from the Sysout at (CONTROL-M/CM the end of a job execution. Optional. for BPI Java Applications) No Sysout Banner (CONTROL-M/CM for BPI Java Applications) Specifies whether a Sysout banner is written to the Sysout at the end of a job execution. Optional.

Chapter 16 Control-M Business Process Integration Suite parameters

1097

Table 207 JAVA panel parameters summary

Parameter Parameter Name Parameter Value Parameter Alias Description Specify the name of the parameter for the chosen method. Mandatory if the method requires parameters. Specify the value of the parameter for the chosen method. Mandatory if the method requires parameters. Specify the alias of the parameter for the chosen method. Optional.

Table 208 WS panel parameters summary

Parameter Account (CONTROLM/CM for BPI Web Services) Business WSDL Service Operation Use Parameters from Input File Add SOAP Header From File Input parameters Output parameters Array Size Description The Account is a profile that is used in order to create and execute a Web Services job. A company or business that provides web services. A URL or fully qualified filename pointing to the WSDL of the web service A service provided by the company or business specified in the Business field. An operation available for the service specified in the Service field. An option to invoke the target web service with predefined SOAP message from the specified input file, in place of input parameters An option to add the predefined SOAP Header to the final web service invocation SOAP request, when applicable. Specify values for each selected parameter. Specify the outcome of selected output parameters. Specifies a number of items in an input parameter array when applicable

An option to exclude information about job output from the Exclude Job Output SYSOUT at the end of a job execution. Optional. (CONTROL-M/CM for BPI Web Services) No Sysout Banner Specifies whether a Sysout banner is written to the Sysout at the end of a job execution. Optional. (CONTROL-M/CM for BPI Web Services)

Table 209 MSG panel parameters summary

Parameter Description Account (CONTROLA profile that is used to create and execute a Messaging job. M/CM for BPI Messaging) Assign Job Output to the following AutoEdit Assign Job Output to the following file Upon job completion, saves the reply message into a chosen AutoEdit variable. Upon job completion, saves the reply message into a chosen file, located on the computer on which Control-M/CM for Messaging is installed.

1098

Control-M Parameter Guide

Table 209 MSG panel parameters summary

Parameter Destination queue/Topic No Sysout Banner (CONTROL-M/CM for BPI Messaging) Exclude Job Output (CONTROL-M/CM for BPI Messaging) Expiration Time Use Free Text Message Priority No Sysout Banner (CONTROL-M/CM for BPI Messaging) Parameter Value Property Value Reply Queue Time to Wait Use Predefined Message Wait for Reply Description Destination queue/topic name of the message queue to which the outgoing messages are sent. Specifies whether a Sysout banner is written to the Sysout.

An option to exclude information about job output from the Sysout. The amount of time until the outgoing message expires (in seconds). The content of the free text message. The Outgoing message priority within the queue. Property key name to be added to an outgoing message.

Property value corresponding to the Property Name parameter. Optional. The property value corresponding to the Property Name parameter. Message queue to which message replies will be sent. The amount of time to wait for incoming messages in the reply message queue. Select to use a previously defined text or binary file as the content of the message, rather than entering free text. An option to enable waiting for messages in the reply message queue.

Chapter 16 Control-M Business Process Integration Suite parameters

1099

Account (CONTROL-M/CM for BPI Java Applications)

Account (CONTROL-M/CM for BPI Java Applications)

A profile that is used to create and execute an EJB or Java Class job.

Format
Usage Length Case Sensitive Valid Characters Mandatory Up to 30 characters Yes (Uppercase only)

Integers between 0 and 9 _ (underscore) - (dash, hyphen) A-Z characters

Blank spaces Default Variable Name

Not permitted None %%JAVA-PROFILE

General information
No special characters should be included within the name definition.

1100

Control-M Parameter Guide

Account (CONTROL-M/CM for BPI Web Services)

Account (CONTROL-M/CM for BPI Web Services)

A profile that is used in order to create and execute a Web Services job.

Format
Usage Length Case Sensitive Valid Characters Mandatory Up to 50 characters Yes (Uppercase only)

Integers between 0 and 9 _ (underscore) - (dash, hyphen) Alphabetical characters between A - Z (inclusive)

Blank spaces Default Variable Name

Not permitted None %%WS-ACCOUNT

General information
No special characters should be included within the name definition.

Chapter 16 Control-M Business Process Integration Suite parameters

1101

Account (CONTROL-M/CM for BPI Messaging)

Account (CONTROL-M/CM for BPI Messaging)

Mandatory. A profile that is used to create and execute a CONTROL-M/CM for BPI Messaging job.

Format
Length Case Sensitive Valid Characters Blank spaces Default Variable Name Up to 30 characters Yes (Uppercase only) A string including any alphanumeric character, and underscore and hyphen. Not permitted None %%MSG-ACCOUNT

General information
No special characters should be included within the name definition.

1102

Control-M Parameter Guide

Add SOAP Header From File

Add SOAP Header From File

Select this option to add predefined SOAP Header to the invocation of the target web service SOAP message as taken from a file specified in the Header File field.

Format
Format Valid characters Valid Values Variable name Valid Values Variable name Length Check box

X: (Selected) Add predefined SOAP header from file N: (Cleared) Do not add any predefined SOAP header (default)

Any integer up to 99 %%WS-ADDSOAPHEADERFROMFILE Any character string representing the file name including its full path. %%WS-SOAPHEADERFILE Up to 212 characters

Header Entry File Requirements

General Information
An example of a SOAP header:
<SOAP-ENV:Header> <user>J2EE_ADMIN</user> <language>English</language> </SOAP-ENV:Header>

Chapter 16 Control-M Business Process Integration Suite parameters

1103

Array Size

Array Size
Specifies a number of items in an input parameter array applicable to the Input parameters of the web services invocation when necessary.

Format
Usage Valid Values Variable name Default Length Optional Any integer up to 99 %%WS-ARRAYSIZE 1 Up to two digits

1104

Control-M Parameter Guide

Assign Job Output to the following AutoEdit

Assign Job Output to the following AutoEdit

Optional. Upon job completion, saves the reply message into a chosen AutoEdit variable.

Format
Format Valid Characters Check Box

X: (Selected) Save reply message to AutoEdit variable N: (Cleared) Do not save reply message to AutoEdit variable (default)

Variable Name Valid Values Variable name Length

%%MSG-ASGOUTPUTTOAUTOEDIT Any alphanumeric character, and underscore and hyphen. Spaces and special characters are not permitted. %%MSG-JOBOUTPUTAUTOEDIT Up to 38 characters

AutoEdit Entry Requirements

The AutoEdit variable into which the job output is saved can be configured in the following formats:
AutoEdit Type AutoEdit Global AutoEdit Global AutoEdit Format %%<autoedit_name> %%\<autoedit_name> <autoedit_name>

General information
Cannot be selected if Assign job output to the following file is specified.

Chapter 16 Control-M Business Process Integration Suite parameters

1105

Assign Job Output to the following file

Assign Job Output to the following file

Optional. Upon job completion, saves the reply message into a chosen file, located on the computer on which CONTROL-M/EM Web Services API is installed.

Format
Format Valid Characters Check Box

X: (Selected) Save reply message to file N: (Cleared) Do not save reply message to file (default)

Variable Name Valid Values Variable name Length

%%MSG-ASGOUTPUTTOFILE Any character string representing the file name including its full path. %%MSG-JOBOUTPUTFILE Up to 212 characters

File Entry Requirements

General information
Cannot be selected if Assign job output to the following AutoEdit is specified.

1106

Control-M Parameter Guide

Business

Business
A company or business that provides web services.

For UDDI, this means any business registered in the specific UDDI server. For WS_FS, this means the path to the specific WSDL file in the directory. For WS_URL, this means the URL to the specific WSDL file.

Format
Usage Format Length Case Sensitive Default Variable Name Mandatory Text field Up to 214 characters Yes None %%WS-BUSINESS

Chapter 16 Control-M Business Process Integration Suite parameters

1107

Destination queue/Topic

Destination queue/Topic
Optional. Name of the message queue to which the outgoing messages are sent.

Format
Length Valid characters Blank spaces Default Variable Name Up to 212 characters Use default or a string including any alphanumeric character, and underscore and hyphen. Not permitted Use Default %%MSG-DESTINATIONQUEUE

1108

Control-M Parameter Guide

Exclude Job Output (CONTROL-M/CM for BPI Java Applications)

Exclude Job Output (CONTROL-M/CM for BPI Java Applications)

Optional. An option to exclude information about job output from the SYSOUT at the end of a job execution.

Format
Format Valid Values Check box

X: (Selected) - exclude job output N: (Cleared) - include job output

Default Variable Name

N (Cleared) %%JAVA-SYSOUTSKIP

Chapter 16 Control-M Business Process Integration Suite parameters

1109

Exclude Job Output (CONTROL-M/CM for BPI Web Services)

Exclude Job Output (CONTROL-M/CM for BPI Web Services)

Selecting this option means that an output message is not created at the end of the job execution.

Format
Format Valid Values Default Variable Name Check box

X: (Selected) - exclude job output message (SYSOUT file) N: (Cleared) - include job output message (SYSOUT file)

N (Cleared) %%WS-SYSOUTSKIP

1110

Control-M Parameter Guide

Exclude Job Output (CONTROL-M/CM for BPI Messaging)

Exclude Job Output (CONTROL-M/CM for BPI Messaging)

Optional. An option to exclude all information from the SYSOUT.

Format
Format Valid characters Variable Name Check box

X: (Selected) - exclude job output N: (Cleared) - do not exclude job output (default)

%%MSG-SYSOUTSKIP

Chapter 16 Control-M Business Process Integration Suite parameters

1111

Expiration Time

Expiration Time
Optional. The amount of time (in seconds) until the outgoing message expires.
Length Valid characters Blank spaces Default Variable name Up to 10 digits Use default or any digit representing unit of seconds Not permitted Use default %%MSG-OUTGOINGMSGEXPTIME

1112

Control-M Parameter Guide

Input parameters

Input parameters
Specify values for each selected parameter.

NOTE
Certain parameters are mandatory, and an indication is displayed to this effect. Failure to select mandatory parameters may cause your job to fail.

Format
Length Case Sensitive Variable Name Up to 212 characters Yes %%WS-PARMS-P00n-NAME NOTE: Where n refers to the nth parameter of the corresponding method. For example, if there were two parameters for a particular method, the first parameter would use P001(%%WS-PARMS-P001NAME), and the second parameter would use P002 (%%WS-PARMSP002-NAME).

Chapter 16 Control-M Business Process Integration Suite parameters

1113

Method

Method
A method applicable to the specified Java Application class.

Format
Usage Length Case Sensitive Valid Characters Default Valid Values Variable Name Mandatory Up to 214 characters Yes Alphanumeric string. Cannot begin with a number. Blank spaces not permitted. None Any method specified within the Object. For more information see Object on page 1118 %%JAVA-METHOD

1114

Control-M Parameter Guide

No Sysout Banner (CONTROL-M/CM for BPI Java Applications)

No Sysout Banner (CONTROL-M/CM for BPI Java Applications)

Optional. Specifies whether a Sysout banner is written to the Sysout at the end of a job execution.

Format
Format Valid Values Check box

X: (Selected) - exclude Sysout banner N: (Cleared) - include Sysout banner

Default Variable Name

N (Cleared) %%JAVA-NOSYSOUTBANNER

Chapter 16 Control-M Business Process Integration Suite parameters

1115

No Sysout Banner (CONTROL-M/CM for BPI Web Services)

No Sysout Banner (CONTROL-M/CM for BPI Web Services)

Optional. Specifies whether a Sysout banner is written to the Sysout at the end of a job execution.

Format
Format Valid Values Default Variable Name Check box

X: (Selected) - exclude Sysout banner N: (Cleared) - include Sysout banner

N (Cleared) %%WS-NOSYSOUTBANNER

1116

Control-M Parameter Guide

No Sysout Banner (CONTROL-M/CM for BPI Messaging)

No Sysout Banner (CONTROL-M/CM for BPI Messaging)

Optional. Specifies whether a Sysout banner is written to the Sysout.

Format
Format Valid Values Variable Name Check box

X: (Selected) - exclude SYSOUT banner N: (Cleared) - include SYSOUT banner (default)

%%MSG-NOSYSOUTBANNER

Chapter 16 Control-M Business Process Integration Suite parameters

1117

Object

Object
Name of the EJB or Java Class according to which the Method parameter value is specified.

Format
Usage Length Case Sensitive Valid Characters Default Variable Name Mandatory Up to 214 characters Yes Alphanumeric string. Cannot begin with a number. Blank spaces not permitted. None %%JAVA-JAVA

1118

Control-M Parameter Guide

Operation

Operation
An operation available for the service specified in the Service field.

Format
Usage Format Length Case Sensitive Default Variable Name Mandatory Text field Up to 214 characters Yes None %%WS-OPERATION

Chapter 16 Control-M Business Process Integration Suite parameters

1119

Output parameters

Output parameters
Specify the outcome of selected output parameters.

NOTE
When selecting the global AutoEdit variable option, the maximum length criteria applies. However, if you select that the output parameter value should be saved to a file, there is no maximum length limitation. You can specify the outcome of certain output parameters that exist as a result of the job once it has been run. The output parameters can be specified as one of the following syntaxes: Global AutoEdit variable name, for example, COMPANY A path to a file in which the value is to be saved. For example, FILE://D:\company.txt These values can also be used to define an input parameter of another job.

Format
Length Case Sensitive Parameter Value Variable Name Up to 212 characters Yes %%WS-PARMS-P001-VALUE NOTE: P001 represents the number of the parameter for the chosen method. For example, if there were two parameters for a particular method, the second parameter would use P002 instead of P001 (%%WS-PARMS-P002-VALUE).

1120

Control-M Parameter Guide

Parameter Alias

Parameter Alias
Optional. Specify the alias of the parameter for the chosen method. For more information see Method on page 1114.

Format
Length Case Sensitive Parameter Alias Variable Name Up to 214 characters Yes %%JAVA-PARMS-P001-ALIAS NOTE: P001 represents the number of the parameter for the chosen method. For example, if there were two parameters for a particular method, the second parameter would use P002 instead of P001 (%%JAVA-PARMS-P002-ALIAS).

Chapter 16 Control-M Business Process Integration Suite parameters

1121

Parameter Name

Parameter Name
Mandatory for those methods that require parameters. Specify the name of the parameter for the chosen method. For more information see Method on page 1114.

Format
Length Case Sensitive Variable Name Up to 214 characters Yes %%JAVA-PARMS-P00n-NAME NOTE: Where n refers to the nth parameter of the corresponding method. For example, if there were two parameters for a particular method, the first parameter would use P001(%%JAVA-PARMS-P001NAME), and the second parameter would use P002 (%%JAVAPARMS-P002-NAME).

1122

Control-M Parameter Guide

Parameter Value

Parameter Value
Mandatory for those methods that require parameters. Specify the value of the parameter for the chosen method. For more information see Method on page 1114.

Format
Length Case Sensitive Parameter Value Variable Name Up to 212 characters Yes %%JAVA-PARMS-P001-VALUE NOTE: P001 represents the number of the parameter for the chosen method. For example, if there were two parameters for a particular method, the second parameter would use P002 instead of P001 (%%JAVA-PARMS-P002-VALUE).

Chapter 16 Control-M Business Process Integration Suite parameters

1123

Priority

Priority
Optional. The level for prioritizing the messages that are to be routed to the Destination queue/Topic.

Format
Valid values Default Variable Name

Use Default Any digit between 0 and 9

Use Default %%MSG-PRIORITY

1124

Control-M Parameter Guide

Property Name

Property Name
Optional. Property key name to be added to an outgoing message.

Format
Valid values Length Case Sensitive Variable Name Any alphanumeric character, underscore, hyphen. Between 1 - 212 characters Yes %%MSG-PARMS-P00n-NAME Note: Where n refers to the nth property. For example, if you want to define two properties, the first property would be %%MSG-PARMSP001-NAME, and the second property would be %%MSG-PARMSP002-NAME.

Related parameters
Parameter Value

Chapter 16 Control-M Business Process Integration Suite parameters

1125

Property Value

Property Value
Optional. The property value corresponding to the Property Name parameter.

Format
Length Case Sensitive Variable Name Up to 212 characters Yes %%MSG-PARMS-P00n-VALUE Note: Where n refers to the nth property value. For example, if you want to specify two property values, the first value would be %%MSG-PARMS-P001-VALUE, and the second value would be %%MSG-PARMS-P002-VALUE.

1126

Control-M Parameter Guide

Reply Queue

Reply Queue
Optional. Enabled if Wait For Reply is selected. The message queue to which message replies will be sent.

Format
Length Case sensitive Valid characters Blank spaces Default Variable name Up to 212 characters Yes Use default or a string including any alphanumeric character, and underscore and hyphen. Not permitted Use default %%MSG-REPLYQUEUE

Related parameters

Wait for Reply Time to Wait

Chapter 16 Control-M Business Process Integration Suite parameters

1127

Service

Service
A service provided by the company or business specified in the Business field.

For UDDI, this means any service registered for the business in the specific UDDI server. For WS_FS, this means any service specified in the WSDL file. For WS_URL, this means any service specified in the WSDL URL.

Format
Usage Format Length Case Sensitive Default Variable Name Mandatory Text field Up to 214 characters Yes None %%WS-SERVICE

1128

Control-M Parameter Guide

Time to Wait

Time to Wait
Optional. Enabled if Wait For Reply is selected. The amount of time in seconds to wait for incoming messages in the reply message queue.

Format
Length Valid characters Default Variable name Up to 10 digits Use default or any numeral value representing unit of seconds Use default %%MSG-TIMETOWAIT

Related parameters

Wait for Reply Reply Queue

Chapter 16 Control-M Business Process Integration Suite parameters

1129

Use Parameters from Input File

Use Parameters from Input File

An option to invoke the target web service with predefined SOAP message from the specified input file, in place of input parameters.

Format
Format Valid Values Check box

X: (Selected) Use predefined SOAP message request from file N: (Cleared) Do not use predefined SOAP message (default)

Variable Name Valid values Length Variable Name

%%WS-USEINPARMFILE Any character string representing the file name including its full path.. Up to 212 characters %%WS-INPUTPUTFILE

Input File Entry Requirements

An example of an web service invoking a SOAP request:

<SOAP-ENV:Envelope xmlns:SOAPENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <ctmem:request_change_alert_status xmlns:ctmem="http://www.bmc.com/ctmem/schema620"> <ctmem:alert_id>12345</ctmem:alert_id> <ctmem:status>Handled</ctmem:status> </ctmem:request_change_alert_status> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

1130

Control-M Parameter Guide

Use Free Text Message

Use Free Text Message

Mandatory if Use Predefined Message is not selected. The content of the free text message.

Format
Valid Values Variable Name Format Valid Values Variable Name X: (Selected) - Use free text message %%MSG-USEFREETEXT Logical name specific to the predefined message. Any alphanumeric and special characters %%MSGMSGTEXTPARMS-Pxxx-SUBMSG, where xxx is a 3-digit starting from 001 (through N if the message is longer than 212 characters and/or N multiple of 212 characters) Example: %%MSG-MSGTEXTPARMS-P001-SUBMSG, %%MSGMSGTEXTPARMS-P002-SUBMSG, etc

Free Message Text Requirements

Related parameters

Use Predefined Message

Chapter 16 Control-M Business Process Integration Suite parameters

1131

Use Predefined Message

Use Predefined Message

Optional. Select to use a previously defined text or binary file as the content of the message, rather than entering free text.

Format
Valid Values

X: (Selected) - Use predefined message N: (Cleared) - Use free text message (default)

Variable Name Format Valid values Maximum length Variable Name

%%MSG-USEPREDEFINEDMSG Logical name specific to the predefined message Any alphanumeric character, underscore, hyphen 30 characters %%MSGMESSAGENAME

Message Name Requirements

1132

Control-M Parameter Guide

Wait for Reply

Wait for Reply

Optional. An option to enable waiting for messages in the reply message queue.

Format
Valid Values

Use default Yes No

Default Variable Name

Use default %%MSG-WAITREPLY

Related parameters

Time to Wait Reply Queue

NOTE
A reply message must be a text message.

Chapter 16 Control-M Business Process Integration Suite parameters

1133

WSDL

WSDL
A URL or fully qualified filename pointing to the WSDL of the web service.

Format
Usage Length Case Sensitive Valid Characters Valid Values Mandatory Up to 214 characters Yes Alphanumeric string. Cannot begin with a number. Blank spaces not permitted. A string that starts with http:// pointing to a url of a valid WSDL or starting with file:// pointing to a fully qualified pathname of a valid WSDL file None %%%%WS-WSDL

Default Variable Name

1134

Control-M Parameter 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

Index
publications, related 11

Symbols
backslash 247 # symbol 510 $ symbol 212, 215 $EJ code value 276 $HOME keyword 46 %% prefix AutoEdit Assignment parameter 35 global variables 510 variable syntax 509 %%# prefix AutoEdit variables 499 variable resolution 510 %%%% AutoEdit on Windows 40, 511 %%@ prefix AutoEdit variables 511 %%variablename. See specific parameter or variable (without %%) & ampersand 247 **** date reference Do Cond parameter 228 In conditions 199 ***** code value 275 *CURLIB iSeries (AS/400) job documentation 46 job script file (iSeries AS/400) 67 Path parameter 67 *FILE keyword job documentation (AS/400) 47 *LIBL iSeries (AS/400) job documentation 46 job script file (iSeries AS/400) 67 Path parameter 67 *NCT2 code value 276 *rangename PGMST value of the On parameter 273 *TERM code value 276 *UNKW code value 276 + num Days subparameter of Due Out parameter 154 + num days subparameter of Time From, Time Until parameter 189 +EVERY PGMST value On parameter 273

< less than 247 = equals 247 > greater than 247 @ symbol in a variable prefix 511 Quantitative resources 212, 215 @START command for UNISYS jobs 503 double quotes 247 single quote 247

A
ABAP Program parameter (SAP) 318 abbreviations used in this document 23 ABOVE_NORMAL_PRIORITY_CLASS Priority Class parameter 492 absolute job dependency 90 Abu Dhabi time zone 130 Account parameter (FTP) 427 parameter (Java Applications) 526 parameter (messaging) 528 parameter (SAP) 319 parameter (Web Services) 527 accounting codes for iSeries (AS/400) jobs 501 ACCOUNTvariable for UNISYS jobs 503 ACGCDE variable for iSeries (AS/400) jobs 501 Activate Traces parameter (SAP) 320 Active From - To date parameter 83 Active From Date ACTIVE_FROM_DATE parameter alias 86 -DATEFROM parameter alias 86 DEFINITION ACTIVE FROM parameter alias 86 subparameter of Schedule Tag parameter 124 Active From Date, component aliases CONTROL-M for z/OS 86 CONTROL-M/EM Utilities 86 CONTROL-M/Server Utilities 86 Active Jobs file prioritizing job processing 174 removing jobs 159 retroactive job scheduling 119 Active Panel parameters 311 Active To Date

Index

561

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_To_DATE parameter alias 86 -DATEUNTIL parameter alias 86 DEFINITION ACTIVE UNTIL parameter alias 86 Active To Date, component aliases CONTROL-M for z/OS 86 CONTROL-M/EM Utilities 86 CONTROL-M/Server Utilities 86 Add ABAP window parameters 314 Add External Program parameters (SAP) 315, 316 adding prerequisite conditions 227 addition AutoEdit expressions 516 dates 520 Additional Options parameter (FTP) 428 ADDRUN variable for UNISYS jobs 503 Adjust Condition parameter 89 ADJUST CONDITION parameter alias 90 Adjust Conditions parameter alias 90 ADJUST_COND parameter alias 90 -adjust_cond parameter alias 90 adjust_condition parameter alias 90 Adjust Condition, component aliases CONTROL-M for z/OS Utilities 90 CONTROL-M/EM API 90 CONTROL-M/EM Utilities 90 CONTROL-M/Server Utilities 90 Reporting Facility 90 Advanced Options parameter (OAP) 395, 419 After the completion of a successful file transfer parameter (FTP) 429 AKL time zone 131 alerts defining urgency 298 Allocation Units parameter (FTP) 430 analyzing job output 221 analyzing ob output 231 ANC time zone 130 Anchorage Standard Time 130 And/Or -cal_andor parameter alias 92 DAYS_AND_OR parameter alias 92 in On parameter 269 parameter 91, 92 subparameter of In Condition parameter 199 And/Or, component aliases CONTROL-M for z/OS 92 CONTROL-M/EM Utilities 92 CONTROL-M/Server Utilities 92 Reporting Facility 92 and_or subparameter 279 ANYSTEP PGMST value, On parameter 273 APPL parameter 27, 28 variable (CONTROL-M for z/OS jobs) 505 APPLGROUP variable 505 APPLIC parameter 27 variable 505 Application parameter 27 parameter (OAP) 396 Application Instance parameter (OAP) 397 Application Name parameter (OAP) 398 application node group, selecting 29 Application Short Name parameter (OAP) 399 Application Type parameter 29 APPL_TYPE parameter alias 30 application_type parameter alias 30 appltype parameter alias 30 availability 30 Application Type, component aliases CONTROL-M/EM API 30 CONTROL-M/EM Utilities 30 CONTROL-M/Server Utilities 30 e-Trigger 30 Application Version parameter 31 APPL_VER parameter alias 32 application_version parameter alias 32 -applver parameter alias 32 Application Version, component aliases CONTROL-M/EM API 32 CONTROL-M/EM Utilities 32 CONTROL-M/Server Utilities 32 e-Trigger 32 Application, component aliases CONTROL-M for z/OS 28 CONTROL-M/EM API 28 CONTROL-M/EM Utilities 28 CONTROL-M/Server Utilities 28 Reporting Facility 28 Archive ID parameter (SAP) 321 Archive Text parameter (SAP) 322 archiving job output 290 SYSDATA 290 Archiving Object parameter (SAP) 323 ARG subparameter of Do CTBRule parameter 230 ARGUMENTS subparameter of the CTB Step parameter 222 AS/400. See iSeries (AS/400) ASCII parameter (FTP) 431 ASSIGN command for OpenVMS 37 variable for Tandem jobs 503 Assign Job Output to the following AutoEdit parameter (messaging) 531 Assign Job Output to the following file parameter (messaging) 532 AT subparameter of the CTB Step parameter 221 ATL time zone 130 Atlantic Standard Time 130 Auckland time zone 131 Author parameter 33

562

Control-M Parameter 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
Author, component aliases CONTROL-M/EM Utilities 34 CONTROL-M/Server Utilities 34 Reporting Facility 34 Authorization parameter (SAP) 324 authorization. See security authorizations job owner 65 Security Group parameter 417 AuthorSecurity parameter 33 Auto-Archive parameter 290 arch_max_days parameter alias 292 arch_max_runs parameter alias 292 AUTO ARCHIVE parameter alias 292 auto_archive parameter alias 292 AUTOARC parameter alias 292 AUTOARCH parameter alias 292 AUTO-ARCHIVE parameter alias 292 sys_db parameter alias 292 Auto-Archive, component aliases CONTROL-M for z/OS 292 CONTROL-M for z/OS Utilities 292 CONTROL-M/EM API 292 CONTROL-M/EM Utilities 292 Reporting Facility 292 AutoEdit AUTOEDIT parameter alias 37 -autoedit parameter alias 37 parameter alternate formats 37 SET VAR parameter alias 37 Setvar parameter alias 37 AutoEdit Assignment AutoEdit support 498 parameter 35 versus Do AutoEdit 497 AutoEdit facility description 497 expressions 515 functions 520 strings 518 variable lists 512 AutoEdit variables %%# prefix 499 assigning a value 515 defining when rerunning jobs 224 description 497 in a command line 40 in CMDLINE parameter 40, 511 in Do Shout messages 508 in job parameters 498 in Shout messages 298, 508 iSeries (AS/400) 501 job submission variables list 500 OpenVMS variables list 500 post-processing variables list 508 prefixes 510 resolving 224 scope 511 specifying 35, 224 support in job parameters 36 system variables list 505 Tandem variables list 503 UNISYS variables list 503 user-defined variables 509 variable types 499 AutoEdit, component aliases CONTROL-M for z/OS 37 CONTROL-M/EM API 37 CONTROL-M/EM Utilities 37 CONTROL-M/Server Utilities 37 Reporting Facility 37 automatic job rerun 182 Automatic Log Copy parameter SYSOUT handling 307 with Do Sysout 254 Average Run Time parameter 311 AVG_CPU variable 508 AVG_TIME variable 508

B
Background Job Name parameter (SAP) 325 Bangkok time zone 130 basic scheduling criteria and the Relationship parameter 117 BELOW_NORMAL_PRIORITY_CLASS Priority Class parameter 492 Binary parameter (FTP) 431 BKK time zone 130 BLANKn variable 505 Block Size parameter (FTP) 432 BMC Software, contacting 2 Bourne shell commands 39 broadcasting to CONTROL-M/Agents 166 using the Multi Agent parameter 166 Business parameter (Web Services) 533 Business Process Type parameter (SAP) 374 Business Warehouse parameters 317 BW General parameters 317 bypassing Tandem jobs 503

C
CALCDATE function 520 calendars, defining 106, 139 calling process Priority Class 492 Scheduling Class 495 case-sensitivity in job processing parameters 24 CC subparameter of Do Mail parameter 241 CENT variable (century) 505

Index

563

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
Central European Time 130 Central Standard Time 130 CET time zone 130 character mask support in the File Name parameter 53 Check Sessions parameter (SAP) 326 Check Variant parameter (SAP) 327 cleanup of data sets 170 cmdline parameter for AutoEdit variables 40, 511 code qualifiers 278 relationships 278 subparameter 279 code values $EJ 276 ***** 275 *NCT2 276 *TERM 276 *UNKW 276 Cnnnn 275 EXERR 276 FLUSH 276 FORCE 275 JFAIL 275 JLOST 275 JNRUN 275 JNSUB 275 JSECU 275 NOTOK 276 OK 275 On parameter 274 REC0 276 SNRUN 276 Sxxxx 275 Unnnn 275 Codes option in On parameter 269 Columns parameter (SAP) 328 Command CMD LINE parameter alias 40 CMDLINE parameter alias 40 -cmdline parameter alias 40 command parameter alias 40 option for AutoEdit support 498 parameter 39 Command, component aliases CONTROL-M/EM API 40 CONTROL-M/EM Utilities 40 CONTROL-M/Server Utilities 40 Reporting Facility 40 commands iSeries (AS/400) command syntax 39 POSTCMD variable 507 PRECMD variable 507 syntax for iSeries (AS/400) 39 task type 76, 78, 79 completion codes 508 modifying status 243, 245, 248, 252 statuses for post processing 219 component aliases 42 Active From -To date 86 Adjust Condition 90 And/Or 92 Application 28 Application Type 30 Application Version 32 Author 34 Auto-Archive 292 AutoEdit 37 Command 40 Confcal 95 Confirm 145 CONTROL Module Version 41 Control Resource 213 Critical 148 CTB Step 222 Cyclic 153 Dates 99 Days 104 Days Calendar 108 Description 44 Do AutoEdit 225 Do Cond 229 Do CTBRule 231 Do Forcejob 234 Do If Rerun 239 Do Mail 242 Do NOTOK 244 Do OK 246 Do Rerun 249 Do Shout 251 Do Stop Cyclic 252 Do Sysout 254 Doc Lib 46 Doc Mem 48 File Name 54 Form Name 56 Group 58 In Condition 200 Interval 157 Job Name 60 Max Wait 160 Maximum 165 Minimum 111 Months 113 Multi Agent 167 Node ID/Group 169 On 279 Out Condition 209 Over Lib 64 Owner 65 Path 68 PDS 116 Prevent NCT2 172 Priority 175

564

Control-M Parameter 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
Quantitative Resource 217 RBC 125 Relationship 118 Request NJE Node 177 Rerun From 179 Rerun Member 183 Reten Days 281 Reten Gen 283 Retro 120 Scheduling Environment 185 Shout 300 Step Range 286 SYSOUT Handling 307 System Affinity 187 Table 74 Table Lib 73 Task Type 79 Time From and Time Until 191 Time Zone 132 Units 194 Week Days 137 Weeks Calendar 140 Compression parameter (FTP) 433 COMPSTAT variable 508 AutoEdit facility 508 On statements 259 concatenation of AutoEdit expressions 518 Condition subparameter of Do Cond parameter 227 conditional job dependency 90 conditions adding and deleting 227 In 198 Out 206 Conditions Panel parameters 197 Confcal parameter 93 CONF_CAL parameter alias 95 CONFCAL parameter alias 95 -confcal parameter alias 95 Confcal, component aliases CONTROL-M for z/OS 95 CONTROL-M/EM Utilities 95 CONTROL-M/Server Utilities 95 Reporting Facility 95 Confirm CONFIRM parameter alias 145 -confirm parameter alias 145 confirm_flag parameter alias 145 parameter 145 subparameter of Do If Rerun parameter 238 Confirm, component aliases CONTROL-M for z/OS 145 CONTROL-M/EM API 145 CONTROL-M/EM Utilities 145 CONTROL-M/Server Utilities 145 Connection Profile parameter (PS8) 472 constructing On-Do statements 271 control language statements, file name 52 CONTROL Module Version parameter 41 application_cm_version parameter alias 41 CM VER parameter alias 41 CM Version parameter alias 41 CM_VER parameter alias 41 -cmver parameter alias 41 CONTROL Module version, component aliases CONTROL-M/EM API 41 CONTROL-M/EM Utilities 41 CONTROL-M/Server Utilities 41 e-Trigger 41 Reporting Facility 41 Control Resource parameter CONTROL parameter alias 213 -control parameter alias 213 control_resource parameter alias 213 RESOURCE parameter alias 213 Control Resource, component aliases CONTROL-M for z/OS 213 CONTROL-M/EM API 213 CONTROL-M/EM Utilities 213 Reporting Facility 213 Control Resources parameter 212 Control subparameter of Control Resources parameter 213 CONTROL-M 42 AutoEdit system variables 505 executing operating system commands 39 parameter 42 CONTROL-M for z/OS data sets 70 CONTROL-M, component aliases CONTROL-M for z/OS 42 CONTROL-M/EM API 42 CONTROL-M/EM Utilities 42 CONTROL-M/Server Utilities 42 Reporting Facility 42 CONTROL-M/Analyzer CTB Step parameter 221 rules 230 runtime environment 231 specifying steps 222 CONTROL-M/EM 209 CONTROL-M/Restart archiving job output 290 archiving SYSDATA 290 Do If Rerun parameter 236, 239 Rerun Member parameter 181 converting from another job scheduling product 43 Copy From Step parameter (SAP) 329 Copy Spool To parameter (SAP) 330 Critical parameter 147 critical path jobs 147 Critical, component aliases CONTROL-M/EM API 148 CONTROL-M/EM Utilities 148 CONTROL-M/Server Utilities 148 Reporting Facility 148

Index

565

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
CST time zone 130 CTB Step parameter arguments 221 CONTROL-M/Analyzer 221 ctb_step parameter alias 222 CTB Step, component alias CONTROL-M/EM API 222 CTM_ADJUST_COND_SCOPE configuration parameter 89 CTM_GROUP_ADJUST_DUMMY configuration parameter 89 CTMERR variable resolution 512 CTMPARM library 184 CTMRPLN utility 98, 103, 107, 112 CTMWORK 231 CURLIB variable (iSeries (AS/400) jobs) 501 Current Status parameter 311 customer support 3 Cyclic Interval parameter 194 parameter 150 Task Type value in CONTROL-M for z/OS 153 Units parameter 194 variable 151 cyclic job archiving SYSDATA 291 CYCLIC_MAXWAIT 160 Interval parameter 156 making non-cyclic 151 specified with Task Type parameter 76 stopping 252 terminating 152 CYCLIC variable 506 Cyclic, component aliases CONTROL-M for z/OS 153 CONTROL-M/EM API 153 CONTROL-M/EM Utilities 153 CONTROL-M/Server Utilities 153 Reporting Facility 153 CYCLIC_MAXWAIT parameter 152, 160 variable 506 Date subparameter of Do Cond parameter 228 subparameter of Do Forcejob parameter 234 subparameter of In Condition parameter 199 subparameter of Out Condition parameter 207 DATE variable 506 dates adding 520 DATE variable 506 DATE variable for iSeries (AS/400) jobs 501 Julian date variables 507 RDATE variable 507 subtracting 520 Dates parameter 98 DATE parameter alias 99 -date parameter alias 99 DATES parameter alias 99 DATES_STR parameter alias 99 Dates, component aliases CONTROL-M for z/OS 99 CONTROL-M/EM Utilities 99 CONTROL-M/Server Utilities 99 Reporting Facility 99 DATEvariable 505 DAY variable 506 Days CONTROL-M for z/OS format 103 parameter 100 parameter rules 102 RDAY variable 507 related parameters 102 relationship with Days Calendar parameter 107 Days Calendar DAYS_CAL parameter alias 108 DAYSCAL parameter alias 108 -dayscal parameter alias 108 DCAL parameter alias 108 parameter 106 parameter rules 107 Days Calendar, component aliases CONTROL-M for z/OS 108 CONTROL-M/EM Utilities 108 CONTROL-M/Server Utilities 108 Reporting Facility 108 days offset in Shout parameter 296 Days parameter DAY_STR parameter alias 104 DAYS parameter variable 104 -days parameter variable 104 Days, component aliases CONTROL-M for z/OS 104 CONTROL-M/EM Utilities 104 CONTROL-M/Server Utilities 104 Reporting Facility 104 DBGLVL variable 500 Ddays

D
DAC time zone 130 Dacca time zone 130 Data Archiving parameters (SAP) 316 DATA CENTER parameter 42 data centers variable (%%DATACENTER) 506 data set management Auto-Archive parameter 290 cleanup 170 number of free tracks for partitioning 110 partitioning 110, 116 PDS parameter 116 Prevent NCT2 parameter 170 DATACENTER parameter 42

566

Control-M Parameter 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
DAY variable 506 ODAY variable 506 DEADLINE variable for UNISYS jobs 503 DEC function for (iSeries (AS/400) 502 decimal values for iSeries (AS/400) jobs 502 DEFINE command (OpenVMS) 37 variable (Tandem) 503 defining AutoEdit variables 224 calendars 106, 139 job dependencies in SMART Tables 89 jobs for time zones 131 On Codes statements 285 process steps 285 program steps 285 Delete After Print parameter (SAP) 331 Deleted parameter 311 deleting Over Lib parameter specification 63 prerequisite conditions 227 SAP Batch input jobs 370 SAP Reports 331 Department parameter (SAP) 332 DESC parameter 44 Description parameter 43 parameter (OAP) 400 subparameter for Do Remedy parameter 247 Description, component aliases CONTROL-M for z/OS 44 CONTROL-M/EM Utilities 44 CONTROL-M/Server Utilities 44 Reporting Facility 44 Destination subparameter of Do Shout parameter 250 subparameter of the Shout parameter 296 Destination queue/Topic parameter (messaging) 534 detached jobs in the Tandem input script 503 Detached task type iSeries (AS/400) 79 Microsoft Windows 76 OpenVMS 78 Detect Spawned Jobs parameter (SAP) 333 Disable SYSOUT Banner parameter (messaging) 543 DO 229 Do AutoEdit AutoEdit support 498 Do Set var parameter alias 225 do_autoedit parameter alias 225 DOAUTOEDIT parameter alias 225 -doautoedit parameter alias 225 parameter 224 subparameters and related parameters 225 versus AutoEdit Assignment 497 Do AutoEdit, component aliases CONTROL-M/Desktop 225 CONTROL-M/EM API 225 CONTROL-M/EM Utilities 225 CONTROL-M/Server Utilities 225 Do Cond parameter 227 DO COND parameter alias 229 do_cond parameter alias 229 DOCOND parameter alias 229 -docond parameter alias 229 Do Cond, component aliases CONTROL-M for z/OS 229 CONTROL-M/EM API 229 CONTROL-M/EM Utilities 229 CONTROL-M/Server Utilities 229 Reporting Facility 229 Do CTBRule parameter 230 DO CTBRULE parameter alias 231 do_ctbrule parameter alias 231 DOCTBRULE parameter alias 231 Do CTBRule, component aliases CONTROL-M for z/OS 231 CONTROL-M/EM API 231 CONTROL-M/EM Utilities 231 Reporting Facility 231 Do Forcejob parameter 233 DO FORCEJOB parameter alias 234 do_forcejob parameter alias 234 DOFORCEJOB parameter alias 234 -doforcejob parameter alias 234 Do Forcejob, component aliases CONTROL-M for z/OS 234 CONTROL-M/EM API 234 CONTROL-M/EM Utilities 234 CONTROL-M/Server 234 Do If Rerun parameter 236 DO IFRERUN parameter alias 239 do_ifrerun parameter alias 239 DOIFRERUN parameter alias 239 general information 238 Do If Rerun, component aliases CONTROL-M for z/OS 239 CONTROL-M/EM API 239 CONTROL-M/EM Utilities 239 Do Mail comparison with Do Shout parameter 242 DO MAIL parameter alias 242 do_mail parameter alias 242 DOMAIL parameter alias 242 -domail parameter alias 242 parameter 240 Do Mail, component aliases CONTROL-M for z/OS 242 CONTROL-M/EM API 242 CONTROL-M/EM Utilities 242 CONTROL-M/Server 242 Do NOTOK DO NOTOK parameter alias 244 do parameter alias 244

Index

567

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
-donotok parameter alias 244 parameter 243 Do NOTOK, component aliases CONTROL-M for z/OS 244 CONTROL-M/EM API 244 CONTROL-M/EM Utilities 244 CONTROL-M/Server 244 Reporting Facility 244 Do OK parameter 245 DO OK parameter 246 Do OK, component aliases CONTROL-M for z/OS 246 CONTROL-M/EM API 246 CONTROL-M/EM Utilities 246 CONTROL-M/Server 246 do parameter 246 Do Remedy parameter (BIM) 220, 247 Do Rerun do parameter alias 249 DO RERUN parameter alias 249 -dorerun parameter alias 249 parameter 151, 248 RERUN parameter alias 249 Do Rerun, component aliases CONTROL-M for z/OS 249 CONTROL-M/EM API 249 CONTROL-M/EM Utilities 249 CONTROL-M/Server Utilities 249 Do Shout AutoEdit support 498 comparison with Do Mail parameter 242 DO SHOUT parameter alias 251 do_shout parameter alias 251 DOSHOUT parameter alias 251 -doshout parameter alias 251 On parameter 299 parameter 250 Do Shout, component aliases CONTROL-M for z/OS 251 CONTROL-M/EM API 251 CONTROL-M/EM Utilities 251 CONTROL-M/Server 251 Do Stop Cyclic parameter 252 do parameter alias 252 DO STOPCYCL parameter alias 252 -dostopcyclic parameter alias 252 SPCYC parameter alias 252 Do Stop Cyclic, component aliases CONTROL-M for z/OS 252 CONTROL-M/EM API 252 CONTROL-M/EM Utilities 252 CONTROL-M/Server 252 Do Sysout parameter 253 DO SYSOUT parameter alias 254 do_sysout parameter alias 254 DOSYSOUT parameter alias 254 -dosysout parameter alias 254 Do Sysout, component aliases CONTROL-M for z/OS 254 CONTROL-M/EM API 254 CONTROL-M/EM Utilities 254 CONTROL-M/Server 254 Doc Lib parameter 45 DOC LIB parameter alias 46 doc_lib parameter alias 46 DOCLIB parameter alias 46 -doclib parameter alias 46 formats 46 Doc Lib, component aliases CONTROL-M for z/OS 46 CONTROL-M/EM API 46 CONTROL-M/EM Utilities 46 CONTROL-M/Server Utilities 46 Reporting Facility 46 Doc Mem parameter 47 doc_member parameter alias 48 DOCMEM parameter alias 48 -docmem parameter alias 48 Doc Mem, component aliases CONTROL-M for z/OS 48 CONTROL-M/EM API 48 CONTROL-M/EM Utilites 48 CONTROL-M/Server Utilities 48 Reporting Facility 48 Document Type parameter (SAP) 335 documentation accessing online 17 accessing the job documentation file (specified in Doc Mem) 45, 47 conventions 23 online 17 printed 17 related publications 16 Due In parameter 312 Due Out parameter 154, 312 Dummy task type (Microsoft Windows) 76, 78, 79 DXB time zone 130

E
Eastern European Time 130 Eastern Standard Time 130 EET time zone 130 EJB/Class parameter (Java Applications) 544 Elapse parameter 312 email attachment 475 in Do Shout parameter 250 subject line 473 Email Subject parameter (PS8) 473 Email Text parameter (PS8) 474 Email With Log parameter (PS8) 475

568

Control-M Parameter 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
Encryption Algorithm parameter (FTP) 436 End Time parameter 312 environment file for PeopleSoft 472 equations in AutoEdit expressions 516 EST time zone 130 Event parameter (SAP) 336 Event Parameter parameter (SAP) 337 examples AutoEdit string expressions 519 AutoEdit variable lists 513 AutoEdit variable prefixes 511 Shout statements 300 Exclude Job Output parameter (Java Applications) 535 Messaging 537 Web Services 536 EXECTIME Shout parameter value 294 values 299 Execution Panel parameters 143 EXERR code value 276 Expiration time parameter (Messaging) 538 expressions (AutoEdit) 515 External Command parameter (SAP) 338 External Program parameter (SAP) 339 external program parameters (SAP) 315, 316 External task type (Microsoft Windows) 76 extracting substrings 521 Extractor process 348 Form Name, component aliases CONTROL-M/EM API 56 CONTROL-M/EM Utilities 56 CONTROL-M/Server Utilities 56 Format parameter (PS8) 476 format. See specific parameter or variable formatting printing in SAP 351 From subparameter of Do If rerun parameter 237 subparameter of Step Range parameter 285 From Proc field, updating 312 From Step field, updating 312 FTP (File Transfer Protocol) 423 FTP-ACCOUNT variable 427 FTP-ADDOPTxy variable 428 FTP-ALLOCUNITSx variable 430 FTP-BLKSIZEx variable 432 FTP-COMPRESSIONxy variable 433 FTP-CONT_EXEx variable 434 FTP-DBCSx variable 435 FTP-DEST-NEWNAMEx variable 459 FTP-ENCRYPTIONxy variable 436 FTP-FILE-PFXx variable 463 FTP-IF-EXISTx variable 451 FTP-LHOST variable 438 FTP-LOSTYPE variable 455 FTP-LPATHx variable 465 FTP-LRECLx variable 452 FTP-LUSER variable 469 FTP-NEWNAMEx variable 429 FTP-NUM_RETRIES variable 454 FTP-POSTCOM2x variable 448 FTP-POSTCOMM1x variable 442 FTP-POSTPARAM11x variable 443 FTP-POSTPARAM12x variable 444, 445 FTP-POSTPARAM21x variable 449 FTP-POSTPARAM22x variable 450 FTP-PRECOMM1x variable 439 FTP-PREPARAM11x variable 440, 441 FTP-PREPARAM21x variable 446 FTP-PREPARAM22x variable 447 FTP-PRIMARYx variable 456 FTP-RECFMx variable 457 FTP-RECURSIVEx variable 458 FTP-RHOST variable 438 FTP-ROSTYPE variable 455 FTP-RPATHx variable 465 FTP-RPF variable 460 FTP-RUSER variable 469 FTP-SECONDARYx variable 461 FTP-SRCOPTx variable 429 FTP-TEMPLATEx variable 462 FTP-TRANSFER_NUM variable 453 FTP-TRANSTABx variable 466 FTP-TRIMx variable 464 FTP-TYPEx variable 431 FTP-UNITx variable 467

F
File Name character mask support 53 mem_name parameter alias 54 MEMNAME parameter alias 54 -memname parameter alias 54 parameter 52 subparameter of After the completion of a successful file transfer parameter 429 Task Types Job and Detached 52 File Name, component aliases CONTROL-M for z/OS 54 CONTROL-M/EM API 54 CONTROL-M/EM Utilities 54 CONTROL-M/Server Utilities 54 Reporting Facility 54 File Transfer Direction parameter (FTP) 437 File Transfer Protocol, FTP 423 filenames in job script 66 FLUSH code value 276 FORCE code value 275 forcing a job using Job Name parameter 59 Form Name parameter 55 APPL_FORM parameter alias 56 -applform parameter alias 56

Index

569

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
FTP-UPLOADx variable 437 FTP-USE_DEF_NUMRETRIES variable 468 FTP-VOLUMEx variable 470 IN parameter alias 200 in_condition parameter alias 200 -incon parameter alias 200 INCOND parameter alias 200 In Condition, component aliases CONTROL-M for z/OS 200 CONTROL-M/EM API 200 CONTROL-M/EM Utilities 200 CONTROL-M/Server Utilities 200 Reporting Facility 200 Include Child Status parameter (OAP) 401 Include Output parameter (OAP) 403 InfoPackage Description parameter (SAP) 340 InfoPackage parameters (SAP) 317 InfoPackage RNR parameter (SAP) 341 InfoPackage Tech.Name parameter (SAP) 342 Information Field parameter (SAP) 343 INJOBPR variable for UNISYS jobs 503 INLLIBL variable for iSeries (AS/400) library list 501 Input parameters (Web Services) 539 INPUT script for Tandem jobs 503 INQMSGRPY variable for iSeries (AS/400) jobs 501 Interval Cyclic parameter 194 days value 156 hours value 156 INTERVAL parameter alias 158 -interval parameter alias 158 minutes value 156 parameter 156 rerun_interval parameter alias 158 Interval, component aliases CONTROL-M for z/OS 158 CONTROL-M/EM API 158 CONTROL-M/EM Utilities 158 CONTROL-M/Server Utilities 158 Reporting Facility 158 iSeries AutoEdit example 38 File Name format 53 iSeries (AS/400) %%PARMn variable syntax 500 *CURLIB library 67 *LIBL library 67 command syntax 39 job documentation 46 job documentation member/file 47 Job Name parameter format 59 job submission parameters 501 message queue 502 parameters list 501

G
General Panel parameters 25 generating Oracle workflow roles selection list 404 global variables description 511 prefixes 510 GMT time zone 130 Greenwich Mean Time 130 Group parameter 57 GROUP NAME parameter alias 58 GROUP parameter alias 58 -group parameter alias 58 used in ViewPoint hierarchy 57 GROUP variable 505 Group, component aliases CONTROL-M for z/OS 58 CONTROL-M/EM Utilities 58 CONTROL-M/Server Utilities 58 Reporting Facility 58 GROUP_ORDID variable 506, 508

H
handling job output 253 HAW time zone 130 Hawaii time zone 130 HEX function for iSeries (AS/400) jobs 502 HIGH_PRIORITY_CLASS Priority Class parameter 492 History Jobs file Reten Days parameter 280 Reten Gen parameter 282 HKG time zone 130 HNL time zone 130 HOLD variable for iSeries (AS/400) jobs 501 Hong Kong time zone 130 Honolulu time zone 130 Host Name parameter (FTP) 438

I
identifying jobs 43 SAP jobs 345 IDLE_PRIORITY_CLASS Priority Class parameter 492 If a file of the same name parameter (FTP) 451 If-Then relationships in On-Do statements 258 In Condition parameter 198 CONDITION parameter alias 200

J
JAVA panel Account parameter 526

570

Control-M Parameter 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
EJB/Class parameter 544 Exclude Job Output parameter 535 Method parameter 540 No Sysout Banner option parameter 541, 542 Parameter Alias 547 Parameter Name 548 Parameter Value 549 JAVA-JAVA variable 544 JAVA-METHOD variable 540 JAVA-NOSYSOUTBANNER variable 541 JAVA-PARMS-P001-ALIAS variable 547 JAVA-PARMS-P001-VALUE variable 549 JAVA-PARMS-P00n-NAME variable 548 JAVA-PROFILE variable 526 JAVA-SYSOUTSKIP variable 535 JCL command to follow a job 507 command to precede a job 507 for a rerun job 182 JES network specifying 176 specifying JES2 and JES3 scheduling environments 184 specifying JES2 system 186 specifying JES3 processor identity 186, 187 JFAIL code value 275 JLOST code value 275 status On statements 259 JNRUN code value 275 JNSUB code value 275 Job Class parameter (SAP) 344 Job Count parameter (SAP) 345 job documentation Doc Mem parameter 47 file 47 iSeries (AS/400) 46 storing 45 Job Execution Time parameter (WIN2K) 487, 488 Job ID parameter 312 Job Memory parameter (WIN2K) 487, 489 Job Mode parameter (SAP) 346 Job Name subparameter of Do Forcejob parameter 233 Job Name parameter 59 CONTROL-M for z/OS format 60 iSeries (AS/400) format 59 JOB NAME parameter alias 60 job_name parameter alias 60 -jobname parameter alias 60 JOBNAMEparameter alias 60 prohibited characters 59 SAP format 347 job name, AutoEdit variable (%%JOBNAME) 506 Job Name, component aliases CONTROL-M for z/OS 60 CONTROL-M/EM API 60 CONTROL-M/EM Utilities 60 CONTROL-M/Server Utilities 60 Reporting Facility 60 job output analyzing 221, 231 archiving 290 handling 253 include Oracle Applications output 403 parameters 289 print immediately (SAP) 389 job parameters AutoEdit variable support 498 case-sensitivity 24 job scheduling, prioritizing 147, 174 job script cancelling override 63 location 66 pathname 66 using Over Lib parameter to supply temporary file 63 Job Status parameter (SAP) 341, 345, 369, 376 job statuses deleted 311 for Oracle Applications jobs 418 Hold 312 Rerun 163 rerunning a job 248 Restart 312 WAIT USER 145 job submission iSeries (AS/400) parameters 501 variables 499 variables for Tandem jobs 503 variables for UNISYS jobs 503 variables list 500 Job task type iSeries (AS/400) 79 Microsoft Windows 76 OpenVMS 77 z/OS 79 Job Type parameter 61 parameter SAP format 348 Job Waiting for External Termination parameter (SAP) 349 JOBD variable for iSeries (AS/400) jobs 501 JOBID variable 508 JOBNAME variable 59, 506 JOBPTY variable for iSeries (AS/400) jobs 501 JOBQ variable for iSeries (AS/400) jobs 501 jobs dependency on Control resources 213 dependency on Quantitative resources 217 forcing with Job Name parameter 59 ordering retroactively with User Daily 119 owner 65 rerunning 179 restarting with the Do If rerun parameter 236 JSECU code value 275

Index

571

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
JULDAY variable 506 Julian dates JULDAY variable 506 OJULDAY variable 507 RJULDAY variable 507 MAXWAIT parameter alias 160 -maxwait parameter alias 160 Max Wait, component aliases CONTROL-M for z/OS 160 CONTROL-M/EM API 160 CONTROL-M/EM Utilities 160 CONTROL-M/Server Utilities 160 Reporting Facility 160 Max Work Set Size parameter (WIN2K) 487, 490 Maximum parameter 163 CONTROL-M for z/OS behavior 164 MAX RERUN parameter alias 165 MAXRERUN parameter alias 165 -maxrerun parameter alias 165 Rerun completion status 163 rerun_max parameter alias 165 Maximum, component aliases CONTROL-M for z/OS 165 CONTROL-M/EM API 165 CONTROL-M/EM Utilities 165 CONTROL-M/Server Utilities 165 Reporting Facility 165 MAXRERUN parameter 164, 182 MEL time zone 131 Melbourne time zone 131 Mem Lib parameter 66 Mem Name parameter 52 member, job script location 66 MEMLIB variable 506 Memlib, AutoEdit support 498 MemName, AutoEdit support 498 MEMSYM variable (CONTROL-M for z/OS) 513 Message subparameter of Shout parameter 298 Message Content parameter (messaging) 540 messages destinations 299 Do Shout parameter 250 iSeries (AS/400) message queue 502 sending 240 subparameter of Do Mail parameter 241 Method parameter (Java Applications) 540 Microsoft Windows parameters list 487 Min Work Set Size parameter (WIN2K) 487, 491 Minimum parameter 110 Minimum, component aliases CONTROL-M for z/OS 111 CONTROL-M/EM Utilities 111 Reporting Facility 111 MINUS operator, AutoEdit Expressions 516 modifying job completion status 243, 245, 248, 252 job script file 63 MONTH variable 506 Months

K
Karachi time zone 130 KEEP value for the CYCLIC_MAXWAIT parameter 152 KHI time zone 130

L
Language parameter (SAP) 350 LATESUB Shout parameter value 294 LATETIME Shout parameter value 295 Layout parameter (SAP) 351 LDA variable 522 LDA variable for iSeries (AS/400) jobs 501 LIBL variable for iSeries (AS/400) jobs 501 LIBMEMSYM variable 512 libraries iSeries (AS/400) jobs 501 iSeries (AS/400) library list 501 LIBSYM variable (CONTROL-M for z/OS) 513 load balancing resources for a job 216 specifying node groups 168 local AutoEdit variables 511 Log External Errors in Joblog parameter (SAP) 352 Log External Output to Joblog parameter (SAP) 353 LOG variable for iSeries (AS/400) 501 LOGCLPGM variable for iSeries (AS/400) 501 logical naming in the DCL file (OpenVMS) 37 Logical Record Length parameter (FTP) 452

M
MAINVIEW Batch Organizer 70 managing SYSDATA 290 Max Days subparameter of Auto-Archive parameter 290 Max Runs subparameter of Auto-Archive parameter 290 Max Wait archiving SYSDATA 291 behavior with cyclic jobs 160 behavior with non-cyclic jobs 159 effects 160 parameter 159 Max Wait parameter MAX WAIT parameter alias 160 max_wait parameter alias 160

572

Control-M Parameter 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
MONTH variable 506 OMONTH variable 507 parameter 112 relationship to Dates parameter 112 relationship with Days Calendar parameter 107 RMONTH variable 507 z/OS format 137 Months, component aliases CONTROL-M for z/OS 113 CONTROL-M/EM Utilities 113 CONTROL-M/Server Utilities 113 Reporting Facility 113 Mountain Standard Time 130 MSG Panel Account parameter 528 Destination queue/Topic parameter 534 Disable SYSOUT Banner parameter 543 Exclude Job Output parameter 537 Expiration time parameter 538 Priority parameter 550 Reply Queue parameter 553 Time to Wait parameter 555 Use Predefined Messages parameter 558 Wait for Reply parameter 559 MSG subparameter of Do Shout parameter 250 MSG-ACCOUNT variable 528 MSG-ASGOUTPUTTOAUTOEDIT variable 531 MSG-ASGOUTPUTTOFILE variable 532 MSG-DESTINATIONQUEUE variable 534 MSG-JOBOUTPUTAUTOEDIT variable 531 MSG-JOBOUTPUTFILE variable 532 MSG-MESSAGENAME variable 558 MSG--MSGTEXTPARMS-Pxxx-SUBMSG variable 557 MSG-NOSYSOUTBANNER variable 543 MSG-OUTGOINGMSGEXPTIME variable 538 MSG-PRIORITY variable 550 MSGQ variable for iSeries (AS/400) 502 MSG-REPLYQUEUE variable 553 MSG-SYSOUTSKIP variable 537 MSG-TIMETOWAIT variable 555 MSG-USEFREETEXT variable 557 MSG-USEPREDEFINEDMSG variable 558 MSG-WAITREPLY variable 559 MST time zone 130 Multi Agent parameter 166 Multi Agent, component aliases CONTROL-M/EM API 167 CONTROL-M/EM Utilities 167 CONTROL-M/Server Utilities 167 Reporting Facility 167 multiagent parameter 167 multiple On statements 271 MULTY_AGENT parameter 167

N
Name parameter (SAP) 354 subparameter of Control Resources parameter 212 subparameter of Do AutoEdit parameter 225 subparameter of Do CTBRule parameter 230 subparameter of In Condition parameter 198 subparameter of Out Condition parameter 206 subparameter of Quantitative Resources parameter 215 subparameter of Step Range parameter 285 subparameter of the CTB Step parameter 221 New Day procedure 119 cyclic jobs 152 retroactive job scheduling 119 time zone support 132 New Job Name parameter (SAP) 355 New Spool Request parameter (SAP) 356 NEXT date reference in the Do Cond parameter 228 Next Time parameter 312 NEXT variable 505, 506 NJE Node parameter 312 NJE parameter 312 No Sysout Banner option parameter (Java Applications) 541, 542 No. of Copies subparameter of the Print parameter 409 Node ID AutoEdit variable 508 parameter 169 variable for UNISYS jobs 503 Node ID/Group broadcasting 166 in the active environment 169 node_group parameter alias 169 NODE_ID parameter alias 169 NODEGROUP parameter alias 169 -nodegrp parameter alias 169 NODEID parameter alias 169 parameter 168 Node ID/Group, component aliases CONTROL-M/EM API 169 CONTROL-M/EM Utilities 169 CONTROL-M/Server Utilities 169 Reporting Facility 169 NODEID variable 508 variable for UNISYS jobs 503 NODEID variable 508 non-periodic (regular) calendar Days parameter 100 Week Days parameter 135 NORMAL_PRIORITY_CLASS Priority Class parameter 492 NOT KEEP value for CYCLIC_MAXWAIT parameter 152 NOT_KEEP value 160 Notifications parameter (OAP) 404

Index

573

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
NOTOK code value 276 parameter 244 status for Max Wait parameter 159 status for On statements 259 status for Shout parameter 295 status for SMART Tables 219 NOU time zone 131 Noumea time zone 131 Number of Copies parameter (SAP) 357 Number of File Transfers parameter (FTP) 453 Number of Retries parameter (FTP) 454 numbers AutoEdit expressions 516 ODAT date reference Do Cond parameter 228 In conditions 199, 207 ODATE variable 505, 506 time zone support 131 Odate Do Forcejob statement 234 in Max Wait parameter 160 ODAY variable 506 OJULDAY variable 507 OK code value 275 parameter 246 status for On statements 259 status for Shout parameter 295 status for SMART Tables 219 OMONTH variable 507 On blocks 271 code qualifiers 278 code relationships 278 Do Shout message use 299 parameter 256 statements and processing in blocks 285 statements testing for completion codes 259 On Codes statements, no need to define 285 On Fail subparameter of Control Resources parameter 213 subparameter of Quantitative Resources parameter 216 On OK subparameter of Quantitative Resources parameter 216 ON PGMST ANYSTEP, runtime environment and DO CTBRULE 231 On statement ON parameter alias 279 -on parameter alias 279 on_do_statement parameter alias 279 on_statement parameter alias 279 On Statement/Code processing order 263 On Statement/Code, criteria 224 On, component aliases CONTROL-M/EM API 279 CONTROL-M/EM Utilities 279 CONTROL-M/Server Utilities 279 e-Trigger 279 On-Do statements 270 OpenVMS archiving job output 290 AutoEdit example 37 File Name format 53 job documentation 46 logical names in a DCL file 37 P1-P8 parameters 500 QUEUE parameter 500 variables list 500

O
OAP Panel parameters 393 workflow roles selection list 404 OAP_WAITCHILD variable 421 OAP-ACTIVE_ATTR-PARENT variable 407 OAP-ACTIVE_ATTR-PHASE variable 408 OAP-ACTIVE_ATTR-PRIORITY variable 410 OAP-ACTIVE_ATTR-REQUEST_ID variable 412 OAP-ACTIVE_ATTR-STATUS variable 418 OAP-APPDESP variable 398 OAP-APPNAME variable 399 OAP-DESCRIPTION variable 400 OAP-DISPLAY_LOGFILE variable 402 OAP-DISPLAY_OUTPUT variable 403 OAP-INSTANCE variable 397 OAP-LANGUAGE variable 405 OAP-NOTIFICATIONS-N-NAME variable 404 OAP-PARAM_VALIDATION variable 406 OAP-PARMS-P-NAME variable 415 OAP-PARMS-P-VALUE variable 415 OAP-PRINTERS-P-NAME 409 OAP-PRINTERS-P-VALUE 409 OAP-PRINTSTYLE variable 409 OAP-PROFILES-P-NAME variable 411 OAP-PROFILES-P-VALUE variable 411 OAP-PROGDESP variable 415 OAP-PROGNAME variable 414 OAP-RESPAPP variable 396 OAP-RESPNAME variable 416 OAP-SECURITY_GROUPNAME variable 417 OAP-SETDESP variable 413 OAP-SETNAME variable 414 OAP-SETPROG-P-PARMS-PARM -NAME variable 414 OAP-SETPROG-P-PARMS-PARM-VALUE variable 414 OAP-SETPROG-P-PRINTCOPIES 409 OAP-SETPROG-P-PRINTERNAME 409 OAP-SUBSTATUS variable 401 OAP-TASKTYPE variable 413 OAP-USERNAME variable 420 Object Type parameter (SAP) 358

574

Control-M Parameter 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
Operating sys parameter (SAP} 359 operating system commands 39 completion codes 258 Operation parameter (Web Services) 545 operators in AutoEdit Expressions 516 OPTION variable for UNISYS jobs 503 Order ID Active table 508 Order ID groups 506 ORDERID variable 507 ordering job using Job Name parameter 59 jobs 119 OS application type 29 panel parameters 487 OS Cover Sheet parameter (SAP) 360 OS Type parameter (FTP) 455 Out Condition parameter 206 CONDITION parameter alias 209 OUT parameter alias 209 out_condition parameter alias 209 -outcon parameter alias 209 OUTCOND parameter alias 209 Out Condition, component aliases CONTROL-M for z/OS Utilities 209 CONTROL-M/EM API 209 CONTROL-M/EM Utilities 209 CONTROL-M/Server Utilities 209 Reporting Facility 209 OUTPTY variable for iSeries (AS/400) jobs 502 Output Device parameter (SAP) 361 Output Management parameter (SAP) 362 Output parameters (Web Services) 546 OUTQ variable for iSeries (AS/400) jobs 502 Over Lib alternative to Path parameter 63 AutoEdit support 498 deleting specification 63 OVER LIB parameter alias 64 over_lib parameter alias 64 OVERLIB parameter alias 64 -overlib parameter alias 64 OVERLIB variable 64 parameter 63 prohibited characters 63 prohibited strings 63 used to supply temporary job script file 63 Over Lib, component aliases CONTROL-M for z/OS 64 CONTROL-M/EM API 64 CONTROL-M/EM Utilities 64 CONTROL-M/Server Utilities 64 Reporting Facility 64 overriding cyclic job specification 151 OWDAY variable 507 Owner parameter 65 parameter (SAP) 363 OWNER variable 507 Owner, component aliases CONTROL-M for z/OS 65 CONTROL-M/EM Utilities 65 CONTROL-M/Server Utilities 65 Reporting Facility 65 OYEAR variable 505, 507

P
Pacific Standard Time 130 PARAM variables for Tandem jobs 503 Parameter Alias parameter (Java Applications) 547 parameter aliases Active From - To date 86 Adjust Condition 90 And/Or 92 Application 28 Application Type 30 Application Version 32 Author 34 Auto-Archive 292 AutoEdit 37 Command 40 Confcal 95 Confirm 145 CONTROL Module Version 41 Control Resource 213 CONTROL-M 42 Critical 148 CTB Step 222 Cyclic 153 Dates 99 Days 104 Days Calendar 108 Description 44 Do AutoEdit 225 Do Cond 229 Do CTBRule 231 Do Forcejob 234 Do If Rerun 239 Do Mail 242 Do NOTOK 244 Do OK 246 Do Rerun 249 Do Shout 251 Do Stop Cyclic 252 Do Sysout 254 Doc Lib 46 Doc Mem 48 File Name 54 Form Name 56 Group 58 In Condition 200

Index

575

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 157 Job Name 60 Max Wait 160 Maximum 165 Minimum 111 Months 113 Multi Agent 167 Node ID/Group 169 On 279 Out Condition 209 Over Lib 64 Owner 65 Path 68 PDS 116 Prevent NCT2 172 Priority 175 Quantitative Resource 217 RBC 125 Relationship 118 Request NJE Node 177 Rerun From 179 Rerun Member 183 Reten Days 281 Retro 120 Scheduling Environment 185 Shout 300 Step Range 286 SYSOUT Handlilng 307 System Affinity 187 Table 74 Table Lib 73 Task Type 79 Time From and Time Until 191 Time Zone 132 Units 194 Week Days 137 Weeks Calendar 140 Parameter format (SAP) 313 Parameter Name (Java Applications) 548 Parameter Validation parameter (OAP) 406 Parameter Value (Java Applications) 549 parameters Active Panel 311 Conditions Panel 197 Execution panel 143 FTP Panel 423 General panel 25 JAVA Panel 523 OAP Panel 393 OS Panel 487 PeopleSoft Panel 471 PostProc Panel 289 post-processing 220 PS8 Panel 471 Resources Panel 211 Reten Gen 283 SAP Panel 313 Scheduling Panel 81 Steps Panel 219 Parameters parameter (SAP) 364 Parent parameter (OAP) 407 Parentheses subparameter of In Condition parameter 199 parm subparameter in Shout parameter 295 PARMn variable 500 partitioning data sets 110 Path iSeries (AS/400) format 67 MEM LIB parameter alias 68 mem_lib parameter alias 68 MEMLIB parameter alias 68 -memlib parameter alias 68 Microsoft Windows format 67 OpenVMS format 67 Over Lib as alternative directory 63 parameter 66 parameter, prohibited characters 66 UNIX format 67 Path, component aliases CONTROL-M for z/OS 68 CONTROL-M/EM API 68 CONTROL-M/EM Utilities 68 CONTROL-M/Server Utilities 68 Reporting Facility 68 PDS parameter 115 parameter relationship to Minimum parameter 115 relationship to Minimum parameter 110 PDS Name parameter 116 PDS, component aliases CONTROL-M for z/OS 116 CONTROL-M/EM Utilities 116 Reporting Facility 116 PDSE libraries 116 PDSNAME parameter 116 PeopleSoft connection profile 472 environment file 472 Panel parameters 471 periodic calendars Days parameter 101 Days values 101 Statistics Period parameter 129 Week Days parameter 134 permission. See security PGMST, in On parameter 269 Phase parameter (OAP) 408 Pipe parameter 70 PLUS operator, AutoEdit Expressions 516 POSTCMD variable 507 post-processing of AutoEdit variables 508 parameters 219, 220 PostProc Panel parameters 289 variables list 508

576

Control-M Parameter 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
PRECMD variable 507 prefixes in AutoEdit variables 35, 510 prerequisite conditions 227 PREV date reference Do Cond parameter 228 In conditions 199, 207 PREV variable 505, 507 Prevent NCT2 parameter 170 data set management 170 PREVENT NCT2 parameter alias 172 prevent_nct2 parameter alias 172 PREVENT-NCT2 parameter alias 172 PREVENTNCT2 parameter alias 172 Prevent NCT2, component aliases CONTROL-M for z/OS 172 CONTROL-M/EM API 172 CONTROL-M/EM Utilities 172 Reporting Facility 172 Primary Allocation parameter (FTP) 456 Print Archive Mode parameter (SAP) 365 Print Expiration parameter (SAP) 366 Print parameter No. of Copies subparameter 409 OAP format 409 Printer subparameter of the Print parameter 409 Priority parameter 174 parameter (Messaging) 550 parameter (messaging) 550 parameter (OAP) 410 PRIORITY parameter alias 175 -priority parameter alias 175 priority Critical parameter 174 iSeries (AS/400) job output 502 iSeries (AS/400) job queue 501 job scheduling 147, 174 of Microsoft Windows jobs 492 of SAP jobs 344 Priority Class calling process 492 Priority Class parameter (WIN2K) 487, 492 Priority, component aliases CONTROL-M for z/OS Utilities 175 CONTROL-M/EM Utilities 175 CONTROL-M/Server Utilities 175 Reporting Facility 175 procedure_step subparameter 279 Process Chain Description parameter (SAP) 367 Process Chain ID parameter (SAP) 368 Process Chain Log ID parameter (SAP) 369 Process chain parameters (SAP) 317 Process Execution Time parameter (WIN2K) 487, 493 Process Memory parameter (WIN2K) 487, 494 Process Name (I) parameter (PS8) 477 Process Name (II) parameter (PS8) 478 process step 285 Process Type parameter (PS8) 479 processing On statements in blocks 285 processing order On Statement/Code 263 PROCST in On parameter 269 product support 3 profcfg utility 472 Profile Name, subparameter of the Profiles parameter 411 Profiles parameter OAP format 411 Profile Name subparameter 411 Value Name subparameter 411 program step 285 program_step subparameter 279 PROJECT variable for UNISYS jobs 503 PRTDEV variable for iSeries (AS/400) jobs 502 PRTTXT variable for iSeries (AS/400) jobs 502 PS8-CON_PROFILE variable 472 PS8-EMAIL_ATTACH_LOG variable 475 PS8-EMAIL_SUBJECT variable 473 PS8-EMAIL_TEXT variable 474 PS8-FAILEDSTEP variable 480 PS8-JOBNAME variable 478 PS8-OUTDESTFORMAT variable 476 PS8-OUTDESTTYPE variable 483 PS8-PRCSNAME variable 477 PS8-PRCSTYPE variable 479 PS8-RUNCONTROLID variable 481 PS8-SERVERNAME variable 482 PS8-USERDEF1/2/3 variable 485 PS8-USERID variable 484 psftcm utility 472 PST time zone 130

Q
QID parameter (SAP) 370 Quantitative Resources parameter 215 QUANTITATIVE parameter alias 217 -quantitative parameter alias 217 quantitative_resource parameter alias 217 RESOURCE parameter alias 217 Quantitative Resources, component aliases CONTROL-M for z/OS 217 CONTROL-M/EM API 217 CONTROL-M/EM Utilities 217 CONTROL-M/Server 217 Reporting Facility 217 Quantity subparameter of Quantitative Resouces parameter 215 QUEUE parameter for OpenVMS batch queue 500 variable for Series (AS/400) jobs 501

Index

577

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

R
RBC component aliases CONTROL-M/EM Utilities 126 RBC parameter 124 criteria 117 RBC parameter alias 126 -tag parameter alias 126 TAG_NAME parameter alias 126 RBC, component aliases CONTROL-M for z/OS 126 CONTROL-M/Server Utilities 126 RDATE variable 505, 507 RDAY variable 507 REALTIME_PRIORITY_CLASS Priority Class parameter 492 REC0 code value 276 Recipient parameter (SAP) 371 Record Format parameter (FTP) 457 Recursive parameter (FTP) 458 regular calendars Days values 100 Relationship parameter 117 RELATION parameter alias 118 RELATIONSHIP parameter alias 118 -relationship parameter alias 118 TAG_RELATIONSHIP parameter alias 118 Relationship, component aliases CONTROL-M for z/OS 118 CONTROL-M for z/OS Utilities 118 CONTROL-M/EM Utilities 118 CONTROL-M/Server Utilities 118 Reporting Facility 118 removing from Active Jobs file 159 replacing data sets 70 Reply Queue parameter (messaging) 553 Request ID parameter (OAP) 412 Request NJE Node parameter 176, 177 NJE NODE parameter alias 177 request_nje parameter alias 177 Request NJE Node, component aliases CONTROL-M for z/OS 177 CONTROL-M/EM API 177 Request Set subparameters of Request Type parameter 413 Request Type parameter (OAP) 413 request types request set 413 single request 414 rerun interval 179 RUNCOUNT variable 507 Shout parameter value 295 Rerun Counter parameter 312 Rerun From parameter 179 count_cyclic_from parameter alias 179 IND CYCLIC parameter alias 179

IND_CYCLIC parameter alias 179 -intervalfrom parameter alias 179 Rerun from Point of Failure parameter (FTP) 460 Rerun From Step parameter (PS8) 480 Rerun From, component aliases CONTROL-M/EM API 179 CONTROL-M/EM Utilities 179 CONTROL-M/Server Utilities 179 Reporting Facility 179 Rerun Member parameter 181 RERUN MEM parameter alias 183 rerun_member parameter alias 183 RERUNMEM parameter alias 183 Rerun Member, component aliases CONTROL-M for z/OS Utilities 183 CONTROL-M/EM API 183 CONTROL-M/EM Utilities 183 Reporting Facility 183 Rerun Options parameter (SAP) 372 rerunning automatically 182 jobs 150, 179 Maximum parameter 163 RERUNNO variable for On statements 259 resolving AutoEdit variables 224 Resources Panel parameters 211 Responsibility parameter (OAP) 416 Restart parameter 312 restarting job with CONTROL-M/Restart 236 jobs with Do If Rerun parameter 236 Reten Days parameter 280 RETEN DAYS parameter alias 281 RETEN_DAYS parameter alias 281 reten_days parameter alias 281 RETENTION # OF DAYS TO KEEP parameter alias 281 Reten Days, component aliases CONTROL-M for z/OS 281 CONTROL-M/EM API 281 CONTROL-M/EM Utilities 281 Reporting Facility 281 Reten Gen parameter 282 RETEN GEN parameter alias 283 RETEN_GEN parameter alias 283 reten_gen parameter alias 283 RETENTION # OF GENERATIONS TO KEEP parameter alias 283 Reten Gen, component aliases CONTROL-M for z/OS 283 CONTROL-M/EM API 283 CONTROL-M/EM Utilities 283 Reporting Facility 283 Retro parameter 119 New Day procedure 119 User Daily jobs 119 Retro, component aliases

578

Control-M Parameter 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 for z/OS 120 CONTROL-M/EM Utilities 120 CONTROL-M/Server Utilities 120 Reporting Facility 120 Rio de Janiero time zone 130 RIO time zone 130 RJULDAY variable 507 RJX_COPY_SYSOUT_ REMOTE 307 RJX_KEEP_SYSOUT 307 RMONTH variable 507 Rows parameter (SAP) 373 RTGDTA variable for iSeries (AS/400) 502 rules CONTROL-M/Analyzer 230 Days parameter 102 Run Control ID parameter (PS8) 481 run time (jobs) Due In parameter 312 Due Out parameter 312 Elapse parameter 312 Start Time parameter 312 RUNCOUNT variable 507 variable for On statements 259 RUNTIME variable for UNISYS jobs 503 RWDAY variable 507 RYEAR variable 505, 507 SAPR3-DETECT_CHILD_JOBNAME variable 333 SAPR3-DETECT_CHILD_TABLE variable 333 SAPR3-DETECT_OPTION variable 333 SAPR3-EVENT_ID variable 336, 337 SAPR3-EVENT_PARAM variable 336, 337 SAPR3-GROUP_ORDID variable 333 SAPR3-InfoPackage_Desc variable 340 SAPR3-InfoPackage_RNR variable 341 SAPR3-InfoPackage_TechName variable 342 SAPR3-JOB_COPY_TARGET_VAL variable 347, 355 SAPR3-JOB_COUNT variable 345 SAPR3-JOB_MODE variable 346, 374 SAPR3-JOBCLASS variable 344 SAPR3-JOBCOUNT variable 345 SAPR3-JOBLOG variable 362 SAPR3-JOBNAME variable 347 SAPR3-ProcessChain_Desc variable 367 SAPR3-ProcessChain_ID variable 368 SAPR3-ProcessChain_LogID 369 SAPR3-QID variable 370 SAPR3-SERVER_OR_GROUP_TYPE variable 385, 387 SAPR3-SPOOL variable 330, 362 SAPR3-START_STEP variable 329 SAPR3-STEP-S- variable 384 SAPR3-STEP-S-ACTIVATE_TRACE variable 320 SAPR3-STEP-S-LOG_STDERR variable 352 SAPR3-STEP-S-LOG_STDOUT variable 353 SAPR3-STEP-Snn-ARCH_ID variable 321 SAPR3-STEP-Snn-ARCH_TEXT variable 322 SAPR3-STEP-Snn-ARCHIVE_INFO variable 343 SAPR3-STEP-Snn-ARCHIVE_OBJECT variable 335 SAPR3-STEP-Snn-ARCHIVE_SAPOBJECT variable 358 SAPR3-STEP-Snn-DEPT variable 332 SAPR3-STEP-Snn-LANGU variable 350 SAPR3-STEP-Snn-LIST_NAME variable 354 SAPR3-STEP-Snn-LIST_TEXT variable 390 SAPR3-STEP-Snn-NEW_LIST_ID variable 356 SAPR3-STEP-Snn-OWNER variable 363 SAPR3-STEP-Snn-PRINT_ARCHMODE variable 365 SAPR3-STEP-Snn-PRINT_AUTH variable 324 SAPR3-STEP-Snn-PRINT_BANNER variable 375 SAPR3-STEP-Snn-PRINT_BANNER_PAGE variable 378 SAPR3-STEP-Snn-PRINT_COPIES variable 357 SAPR3-STEP-Snn-PRINT_DEST variable 361 SAPR3-STEP-Snn-PRINT_EXPIRATION variable 366 SAPR3-STEP-Snn-PRINT_IMMED variable 389 SAPR3-STEP-Snn-PRINT_LAYOUT variable 351 SAPR3-STEP-Snn-PRINT_NUMCOLUMNS variable 328 SAPR3-STEP-Snn-PRINT_NUMLINES variable 373 SAPR3-STEP-Snn-PRINT_RECIPIENT variable 371 SAPR3-STEP-Snn-PRINT_RELEASE variable 331 SAPR3-STEP-Snn-PROGRAM variable 318, 339 SAPR3-STEP-Snn-TARGET_HOST variable 386 SAPR3-STEP-Snn-VAR-NAME variable 364, 392 SAPR3-STEP-snn-WAIT_FOR_TERM variable 349 SAPR3-STEP-S-OPERSYS variable 359 SAPR3-STEP-S-PRINT_HOST_BANNER variable 360

S
SAC parameter 122 aliases 123 SAP BW General parameters 317 BW InfoPackage parameters 317 BW Process Chain parameters 317 Data Archiving parameters 316 deleting reports 331 External program 315, 316 External program parameters 315, 316 panel parameters 313 parameter format 313 parameters list 314 SAP Cover Page parameter (SAP) 360, 375 SAP Job Status parameter (SAP) 376 SAP-BW Business Process Type parameter (SAP) 374 SAPR3_EVENT_ID variable 382 SAPR3_EVENT_PARAM variable 382 SAPR3_STEP-S-STEP_TYPE variable 383 SAPR3-ACCOUNT variable 319 SAPR3-BACKJOBNAME variable 325 SAPR3-DA_ARC_OBJ variable 323 SAPR3-DA_CHECK_SESSIONS variable 326 SAPR3-DA_CHECK_VARIANT variable 327 SAPR3-DA_JOB_TYPE variable 346 SAPR3-DA_SESSION_NUMBER variable 379

Index

579

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
SAPR3-STEP-S-PRINT_NUMCOLUMNS variable 328 SAPR3-STEP-S-PRINT_NUMLINES 373 SAPR3-STEP-S-PROGRAM variable 338 SAPR3-STEP-S-TARGET_HOST variable 388 SAPR3-SUBMIT_ASAP variable 382 SAPR3-TARGET_SERVER variable 385, 387 SCD Table, subparameter of Do Forcejob parameter 233 SCHEDTAB variable 508 scheduling dates, PREV variable 507 overriding environment 184 panel parameters 81 specifying work days 94 table, Job Name parameter 59 table, Job Name requirements for z/OS 59 tag parameters 220 Time Zone parameter 131 validating dates 94 Scheduling Class calling process 495 Scheduling Class parameter (WIN2K) 487, 495 Scheduling Environment parameter 184 SCHEDULE ENV parameter alias 185 schedule_environment parameter alias 185 SCHEDULING_ENVIRONMENT parameter alias 185 SCHENV parameter alias 185 Scheduling Environment, component aliases CONTROL-M for z/OS 185 CONTROL-M/EM API 185 CONTROL-M/EM Utilities 185 Reporting Facility 185 Scheduling Table Lib parameter 73 Scheduling Table Lib, component aliases CONTROL-M for z/OS 73 CONTROL-M/EM Utilities 73 scope of AutoEdit variables 511 SD_CPU variable 509 SD_TIME variable 509 SE_INC_BASE_PRIORITY_NAME Scheduling Class parameter 492, 495 Search Count parameter 312 Secondary Allocation parameter (FTP) 461 security Author parameter 33 Owner parameter identification mechanism 65 Security Group parameter (OAP) 417 Selection Cover Page parameter (SAP) 378 sending messages 240 Server Name parameter (PS8) 482 Service parameter (Web Services) 554 Session Number parameter (SAP) 379 Set Var parameter 35 Shift Num subparameter of Confcal parameter 94 Shift subparameter of Confcal parameter 94 Shout parameter 293 AutoEdit support 498 SHOUT parameter alias 300 -shout parameter alias 300 Shout, component aliases CONTROL-M for z/OS 300 CONTROL-M/EM Utilities 300 CONTROL-M/Server Utilities 300 Sign subparameter of Do Cond parameter 228 subparameter of Out Condition parameter 207 Single Request subparameters of the Request Type parameter 414 SMART Tables post-processing 219 RBC 124 Schedule Tag parameters 220 scheduling 117 SNRUN code value 276 special characters Over Lib prohibited characters 63 Over Lib prohibited strings 63 prohibited in Job Name parameter 59 prohibited in Path parameter 66 specifying AutoEdit variable values 224 AutoEdit variables 35 AutoEdit variables and expressions 59 blanks with the BLANKn variable 505 Calendars 93 CONTROL-M/Analyzer rules 230 CONTROL-M/Analyzer steps 222 CPU in Tandem jobs 503 cyclic job 150 cyclic jobs 76 data center 42 JES network 176 JES2 scheduling environment 184 JES2 system 186 JES3 processor identity 186 job description 43 job execution priority 147 multiple CONTROL-M/Agent nodes 166 multiple RBCs 125 new Job Name using ctmorder 59 operating system commands 39 Over Lib parameter as variable 64 scheduled work days 94 Standard Deviation parameter 312 Start Condition parameter (SAP) 382 Start Time parameter 312 Started Task Path parameter 67 task type (z/OS) 79 started tasks archiving SYSDATA 291 Minimum parameter 111 STAT date reference Do Cond parameter 228

580

Control-M Parameter 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
In conditions 199, 207 statement subparameter 279 Statistics Calendar parameter 127 aliases 128 Statistics Period parameter 129 Status parameter (OAP) 418 status parameters 311 STC task type for z/OS 79 Step Range parameter 284 From subparameter 285 Name subparameter 285 STEP RANGE parameter alias 286 STEP_RANGE parameter alias 286 step_range parameter alias 286 To subparameter 285 Step Range, component aliases CONTROL-M for z/OS 286 CONTROL-M/EM API 286 CONTROL-M/EM Utilities 286 Reporting Facility 286 Step Type parameter (SAP) 383 Step values for the On parameter 273 Steps Panel parameters 219 Steps parameter (SAP) 384 Stmt subparameter of On parameter 269 stopping cyclic job runs 252 storage buffers, pipes to replace data sets 70 storing job documentation 45 strings AutoEdit expressions 518 substring function 521 Style subparameter of the Print parameter 409 Subject subparameter of Do Mail parameter 241 Submit Job with ASAP Option parameter (SAP) 382 submitting job to CONTROL-M/Agent nodes 168 job to multiple CONTROL-M/Agent nodes 166 jobs during a fixed time frame 190 Substr function 521 subtraction AutoEdit Expressions 516 dates 520 Summary subparameter for Do Remedy parameter 247 support, customer 3 SWS variable for iSeries (AS/400) 502 Sxxx code value 275 SYD time zone 131 Sydney time zone 131 syntax AutoEdit expressions 515 AutoEdit string expressions 518 user-defined variables 509 syntax. See specific parameter or variable SYS DB subparameter of Auto-Archive parameter 290 SYSDATA archiving 290 SYSLIBL variable for iSeries (AS/400) jobs 502 SYSOUT Handling parameter 302, 498 PARM parameter alias 307 SYSOPT parameter alias 307 -sysout parameter alias 307 sysout_from_class alias subparameter 308 sysout_option alias subparameter 308 sysout_parameter alias subparameter 308 SYSOUT Handling, component aliases CONTROL-M for z/OS 307 CONTROL-M/EM API 308 CONTROL-M/Server Utilities 307 Reporting Facility 307 SYSOUT parameter 307 System Affinity parameter 186 JES2 186 specifying JES3 processor identity 186 SYS AFFINITY parameter alias 187 SYSTEM ID parameter alias 187 SYSTEM_AFFINITY parameter alias 187 system_affinity parameter alias 187 System Affinity, component aliases CONTROL-M for z/OS 187 CONTROL-M/EM API 187 CONTROL-M/EM Utilities 187 Reporting Facility 187 system variables AutoEdit facility 505 list 505 specifying 35

T
Table name parameter 74 TABLE NAME parameter 74 Table parameter 74 Table, component aliases CONTROL-M for z/OS 74 CONTROL-M/EM Utilities 74 CONTROL-M/Server Utilities 74 Reporting Facility 74 TABLE_DSN parameter 73 TABLE_NAME parameter 74 Tandem ob submission variables list 503 TANDEM_ASSIGN_ xxx variable 503 TANDEM_BYPASS_JOB variable 503 TANDEM_CPU variable 503 TANDEM_DEFINE_ xxx variable 503 TANDEM_INPUT_FILE variable 503 TANDEM_PARAM_xxx variable 503 Target Group parameter (SAP) 385 Target Host parameter (SAP) 386 Target Server (1) parameter (SAP) 387 Target Server (2) parameter (SAP) 388 Task Type parameter 76 CONTROL-M for z/OS format 79

Index

581

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
cyclic jobs 76 iSeries (AS/400) format 79 Microsoft Windows format 76 OpenVMS format 77 TASK_TYPE parameter alias 79 task_type parameter alias 79 TASKTYPE parameter alias 79 -tasktype parameter alias 79 UNIX format 76 Task Type, component aliases CONTROL-M for z/OS 79 CONTROL-M/EM API 79 CONTROL-M/EM Utilities 79 CONTROL-M/Server Utilities 79 Reporting Facility 79 technical support 3 Template Name parameter (FTP) 425, 462 terminating cyclic job 152 Time From and Time Until, component aliases CONTROL-M for z/OS Utilities 191 CONTROL-M/EM API 191 CONTROL-M/EM Utilities 191 CONTROL-M/Server Utilities 191 Reporting Facility 191 Time From parameter 189 FROM TIME parameter alias 191 TIME FROM parameter alias 191 time_from parameter alias 191 TIMEFROM parameter alias 191 -timefrom parameter alias 191 Time of Print parameter (SAP) 389 Time to Wait parameter (messaging) 555 Time Until parameter 189 TIME UNTIL parameter alias 191 time_until parameter alias 191 TIMETO parameter alias 191 -timeuntil parameter alias 191 TO TIME parameter alias 191 TIME variable 508 Time Zone parameter 130 time zone support in utilities 131 Time Zone, component aliases CONTROL-M for z/OS 132 CONTROL-M/EM Utilities 132 CONTROL-M/Server Utilities 132 TIMEZONE parameter 132 Titles parameter (SAP) 390 To subparameter of Do If rerun parameter 237 subparameter of Do Mail parameter 240 subparameter of Step Range parameter 285 To Proc field, updating 312 To Step field, updating 312 TOK time zone 131 Tokyo time zone 131 Transfer Location parameter (FTP) 465 Translate Table parameter (FTP) 425, 466 TYO time zone 131 Type parameter (PS8) 483 TYPE subparameter of the CTB Step parameter 221

U
UNISYS job submission variables list 503 Unit parameter (FTP) 425, 467 Units parameter 194 Units, component aliases CONTROL-M/Server Utilities 194 UNIX AutoEdit Assignment example 38 Bourne shell commands 39 File Name format 53 job documentation 46 Unnnn code value 275 Urgency subparameter for Do Remedy parameter 247 subparameter of Do Mail parameter 241 subparameter of Do Shout parameter 250 subparameter of Shout parameter 298 Use ABAP Program Default parameter (SAP) 391 Use Configuration Default parameter (FTP) 468 Use In-Stream JCL parameter aliases 51 Use Predefined Message parameter (messaging) 558 User Daily jobs 119 User ID parameter (PS8) 484 user ID, Author parameter 33 User Name parameter (FTP) 469 parameter (OAP) 420 userdef(x) 485 Userdef1/2/3 parameter (PS8) 485 user-defined variables 35, 509

V
validating scheduling dates 94 Value Name subparameter of the Profiles parameter 411 Value subparameter of Do AutoEdit parameter 225 values. See specific parameter or variable variables in job parameters 498 specifying 224 Variant Name parameter (SAP) 392 Volume parameter (FTP) 425, 470

W
W_DAY_STR parameter 137 Wait Child parameter (OAP) 421 Wait for Reply parameter (messaging) 559 Wait For Termination parameter (SAP) 320, 349, 352, 353

582

Control-M Parameter 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
WAIT USER status 145 WCAL parameter 140 WDAY variable 508 WDAYS parameter 137 Web Services panel Account parameter 527 Business parameter 533 Exclude Job output parameter 536 Input parameters 539 Operation parameter 545 Output parameters 546 Service parameter 554 Week Calendar, component aliases CONTROL-M for z/OS 140 CONTROL-M/EM Utilities 140 CONTROL-M/Server 140 Reporting Facility 140 Week Days parameter 133 non-periodic (regular) calendar formats 135 periodic calendar formats 134 Week Days, component aliases CONTROL-M for z/OS 137 CONTROL-M/EM Utilities 137 CONTROL-M/Server Utilities 137 Reporting Facility 137 weekdays OWDAY variable 507 RWDAY variable 507 WDAY variable 508 Weeks Calendar parameter 139 rules 140 WCAL parameter alias 140 -weekcal parameter alias 140 WEEKS_CAL parameter alias 140 WEEKSCAL parameter alias 140 Western European Time 130 WET time zone 130 When subparameter of Shout Parameter 294 WIN2K-JOB_MEMORY_LIMIT variable 489 WIN2K-MAXIMUM_WORKING_SET_SIZE variable 490 WIN2K-MINIMUM_WORKING_SET_SIZE variable 491 WIN2K-PER_JOB_USER_TIME_LIMIT variable 488 WIN2K-PER_PROCESS_USER_TIME_LIMIT variable 493 WIN2K-PRIORITY_CLASS variable 492 WIN2K-PROCESS_MEMORY_LIMIT variable 494 WIN2K-SCHEDULING_CLASS variable 495 Windows AutoEdit variables 40, 511 working days 100, 133 WS-ACCOUNT variable 527 WS-ADDSOAPHEADERFILE variable 529 WS-ADDSOAPHEADERFROMFILE variable 529 WS-ARRAYSIZE variable 530 WS-BUSINESS variable 533 WS-NOSYSOUTBANNER variable 542 WS-OPERATION variable 545 WS-PARMS-P001-VALUE variable 546 WS-PARMS-P00n-NAME variable 539 WS-SERVICE variable 554 WS-SYSOUTSKIP variable 536 WS-WSDL variable 560

Y
YEAR variable 505, 508 years four-digit Odate 505 four-digit working year 505 RYEAR variable 507 YEAR variable 508

Z
z/OS DO NOTOK parameter 244 Do OK parameter 245 File Name format 53 note on Command parameter 39

Index

583

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

584

Control-M Parameter Guide

Notes

*172558* *172558* *172558* *172558*

*172558*