EM Utility Guide 630 PDF

www.bmc.
com
CONTROL-M/Enterprise Manager
Utility Guide
Supporting
CONTROL-M/Enterprise Manager version 6.3.01 Fix Pack 3
CONTROL-M/Desktop version 6.3.01 Fix Pack 3
July 2007
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 2006 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.
All other trademarks belong to their respective companies.
BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this
information is subject to the terms and conditions of the applicable End User License Agreement for the product and the
proprietary and restricted rights notices included in this documentation.
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE
COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the
U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS
252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is
BMC SOFTWARE INC, 2101 CITYWEST BLVD, HOUSTON TX 77042-2827, USA. Any contract notices should be sent to
this address.
3
Customer support
You can obtain technical support by using the 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_home.
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
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 customer_support@bmc.com. (In the subject line, enter SupID:<yourSupportContractI D>,
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 f i l e syst emf ul l
messages from related software
4 CONTROL-M/Enterprise Manager Utility Guide
Contents 5
Contents
About this book 11
How this book is organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Online and printed books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Access online books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Request additional printed books . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 1 Introduction 15
Utilities described in this book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Types of utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Utilities not described in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Abbreviations and conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Command line conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 2 Command Line Interface utility (cli) 19
Invoking the cli utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
General notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Uploading and downloading schedule tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Forcing schedule tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Ordering schedule tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Uploading and downloading calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Forcing jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Ordering jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Deleting job definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 3 Job utilities 29
Job definition utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
defjob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Parameters of the defjob utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
defjob input file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
copydefjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Parameters of the copydefjob utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
deldefjob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Parameters of the deldefjob utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
duplicatedefjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Parameters of the duplicatedefjob utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
erase_audit_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Parameters of the erase_audit_data utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
exportdefjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Parameters of the exportdefjob utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
loopdetecttool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Parameters of the loopdetecttool utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Arguments file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Output file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
sweep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Parameters of the sweep utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
updatedef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Parameters of the updatedef utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Chapter 4 Calendar utilities 121
defcal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Parameters of the defcal utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
copydefcal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Parameters of the copydefcal utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
exportdefcal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Parameters of the exportdefcal utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Chapter 5 Scheduling table utilities 135
deftable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Parameters of the deftable utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
exportdeftable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Parameters of the exportdeftable utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Chapter 6 Administration utilities 155
Monitoring and maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
check_gtw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Parameters of the check_gtw utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
cryptocli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Parameters of the cryptocli utilitytrial mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Parameters of the cryptocli utilityoperation mode . . . . . . . . . . . . . . . . . . . . . . . . 160
ccmcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
ccmcli usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
ccmcli parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
ctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Performing commands and requests using the Control Shell. . . . . . . . . . . . . . . . 162
ctl command syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Parameters common to all ctl commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Health Check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Running the Health Check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Parameters of the Health Check utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
purge_runinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Cleaning out run information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
purge_xalerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Contents 7
Chapter 7 Database maintenance utilities 183
Performing database maintenance utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
db_check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Syntax of the db_check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Parameters of the db_check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
db_check_space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Sybase Adaptive server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Oracle server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Parameters of the db_check_space utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
util. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
DB_ARGS database arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Functions and syntax of the util utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Parameters of the util utility functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
em_SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Syntax of the em_SQL utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Parameters of the SQL utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Chapter 8 Build database utility 199
build_db (build database) utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Existing server creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Verification of existing components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Existing database cleanup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Creating a Sybase database on an existing database server . . . . . . . . . . . . . . . . . 202
Configuring a Sybase client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
build_db parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Parameters of the build_db utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
build_db log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Parameters of the build_db log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Appendix A XML file preparation 205
CONTROL-M/EM utility commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Preparing an input file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
File structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Reserved characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Index 213
Tables 9
Tables
Types of utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Utilities not included in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
cli utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Notes applicable to cli commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
cli utility Job Delete parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Job Definition utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
defjob parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
defjob switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
defjob input file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
copydefjob parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
copydefjob switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
copydefjob arguments file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
deldefjob parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
deldefjob arguments file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
duplicatedefjob parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
duplicatedefjob switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
duplicatedefjob arguments file tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
erase_audit_data parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
exportdefjob parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
exportdefjob arguments file Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
loopdetecttool parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
loopdetecttool arguments file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
loopdetecttool output file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
sweep parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
sweep utility reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
sweep utility return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
updatedef parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
updatedef switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Arguments file parameters for scheduling tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Arguments file parameters for group scheduling tables . . . . . . . . . . . . . . . . . . . . . . 100
Arguments file parameters for jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Calendar utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
defcal parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
defcal input file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
copydefcal parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
copydefcal arguments file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
exportdefcal parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
exportdefcal arguments file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Table utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
deftable parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
deftable switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
deftable input file parameters for scheduling tables . . . . . . . . . . . . . . . . . . . . . . . . . . 138
deftable input file parameters for group scheduling tables . . . . . . . . . . . . . . . . . . . . 139
exportdeftable parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
exportdeftable arguments file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Administration utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
check_gtw utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
check_gtw_ue user exit parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
cryptocli parameters trial mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
cryptocli parameters operation mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
ccmcli parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Parameters common to all variations of the ctl command . . . . . . . . . . . . . . . . . . . . . 164
ctl parameters for the Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
ctl parameters for the Global Conditions Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
ctl parameters for the GUI server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
ctl parameters for the Global Alerts Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
ctl parameters for the Configuration Management Server . . . . . . . . . . . . . . . . . . . . . 170
ctl parameters for the Configuration Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
ctl parameters for BMC Batch Impact Manager server . . . . . . . . . . . . . . . . . . . . . . . . 171
ctl parameters for Forecast server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Specifying specific server components and computers . . . . . . . . . . . . . . . . . . . . . . . . 173
ctm_data_collector utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Category definitions for the ctm_data_collector utility . . . . . . . . . . . . . . . . . . . . . . . . 177
Profile definitions for the ctm_data_collector utility . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Database maintenance utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
db_check utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
db_check_space utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
loader utility fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
DB_ARGS database arguments fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
util utility functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
util utility function parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Records and fields delimiter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
SQL utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Build database modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Sybase database server parameters minimum values . . . . . . . . . . . . . . . . . . . . . . . 201
Utility operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
CONTROL-M/EM utility .dtd files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Reserved character codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
About this book 11
About this book
This book contains information about batch utilities supplied with
CONTROL-M/Enterprise Manager (CONTROL-M/EM). Use this book with the
following guides:
CONTROL-M/EM User Guide (version 6.3.01 Fix Pack 1)
CONTROL-M/EM Administrator Guide (version 6.3.01 Fix Pack 1)
CONTROL-M Job Parameter and AutoEdit Variable Reference Guide (version 6.3.01 Fix
Pack 1)
How this book is organized
This book is organized as follows. In addition, an index appears at the end of the
book.
Chapter Description
Chapter 1 Introduction
Provides an overview of CONTROL-M/EM batch utilities.
Chapter 2 Command Line Interface utility (cli)
Describes the cli utility and the means for invoking it.
Chapter 3 Job utilities
Describes utilities for creation and manipulation of job processing definitions.
Chapter 4 Calendar utilities
Describes the utilities for creation and manipulation of Calendar definitions.
Chapter 5 Scheduling table utilities
Describes the utilities for creation and manipulation of Scheduling table and
group scheduling table definitions.
Chapter 6 Administration utilities
Describes various CONTROL-M/EM component administration utilities.
Chapter 7 Database maintenance utilities
Describes the database management utilities and the means for invoking them.
Related documentation
Related documentation
The following BMC publications are relevant to CONTROL-M/EM.
CONTROL-M/Enterprise Manager User Guidedescribes CONTROL-M/EM
concepts, features, facilities, and operating instructions.
CONTROL-M/Desktop User Manual describes how to define and manage
CONTROL-M job processing definitions, Scheduling tables, and Calendars.
CONTROL-M/Enterprise Manager Administrator Guidedescribes how to define,
monitor, and maintain the CONTROL-M/EM environment.
CONTROL-M/Enterprise Manager I nstallation Guide describes the installation
processes for implementing an CONTROL-M/EM environment on Microsoft
Windows and UNIX computers.
CONTROL-M/Enterprise Manager API Developers Guide describes how to enable
your applications to submit requests to CONTROL-M/EM.
CONTROL-M J ob Parameter and Variable Reference Guidedescribes the
parameters used for creating and manipulating job processing definitions.
CONTROL-M/Server Administrator Guidedescribes installation, setup, security,
and utilities on various CONTROL-M platforms (for example, UNIX and Microsoft
Windows).
CONTROL-M for z/OS User Guide is a guide to the CONTROL-M Production
Control System in a mainframe environment.
Chapter 8 Build database utility
Describes how to build a dedicated Sybase database server, define a
CONTROL-M/EM Sybase database, and configure a Sybase database client.
Appendix A XML file preparation
Procedures for creating input and argument files for XML-based utilities.
Chapter Description
About this book 13
Online and printed books
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.
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.
Request additional printed books
Chapt er
1
1 Introduction
Utilities can be used to perform common CONTROL-M/Enterprise Manager
(CONTROL-M/EM) tasks from the command prompt of any computer where
CONTROL-M/EM client components are installed.
Although almost every task performed by these utilities can be performed using the
CONTROL-M/EM GUI or the CONTROL-M Configuration Manager, the utilities
enable you to work at computers that do not have the GUI or the CONTROL-M
Configuration Manager installed on them. By including a utility command in the
command line of a job processing definition, you can automatically run the utility at a
predetermined time or under a predetermined set of conditions.
This chapter presents the following topics:
Utilities described in this book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Types of utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Utilities not described in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Abbreviations and conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Command line conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
NOTE
You can also create and run jobs for specified applications (for example SAP or Oracle
Applications), although you cannot do this using the utilities. For more information, see the
Administrator Guide for the appropriate CONTROL-M/CM.
Utilities described in this book
Utilities described in this book
The types of utilities described in this book are listed in Table 1.
Many CONTROL-M/EM utilities are implemented by using input and argument
files written in Extensible Markup Language (XML). Instructions for preparing these
XML files are presented in Appendix A, XML file preparation.
Types of utilities
NOTE
A valid CONTROL-M/EM user name and password are required to run CONTROL-M/EM
utilities. Additionally, you must have the appropriate authorization to either copy from or
modify entities in CONTROL-M/EM. For more information, see the Security chapter in the
CONTROL-M/Enterprise Manager Administrator Guide.
Table 1 Types of utilities
Types of utilities Description
Command line
interface
The Command Line Interface (cli) is a batch utility that enables you to
perform the following operations (services) from the command line:
Upload or Download Scheduling tables
Order or Force Scheduling tables
Order or Force jobs
Force jobs in a group scheduling table
Upload or Download Calendars
Delete job processing definitions from Scheduling tables
For information about cli, see Chapter 2, Command Line Interface
utility (cli).
Job You can create, modify, and delete job processing definitions with the
utilities described in Chapter 3, Job utilities.
Calendar You can create and modify Calendar definitions with the utilities
described in Chapter 4, Calendar utilities.
Scheduling table You can create and modify scheduling table and group scheduling table
definitions with the utilities in Chapter 5, Scheduling table utilities.
Administration You can monitor and manage selected elements of CONTROL-M/EM
using the utilities described in Chapter 6, Administration utilities.
Database
maintenance
You can maintain the CONTROL-M/EM database using the utilities
described in Chapter 7, Database maintenance utilities.
Build database
utility
You can build a dedicated Sybase server, define a CONTROL-M/EM
database, and configure a Sybase database client using the build_db
utility described in Chapter 8, Build database utility.
Utilities not described in this book
Utilities not described in this book
CONTROL-M/EM includes a number of utilities that are used infrequently, often
only under very specific conditions. These utilities are described below:
Abbreviations and conventions
The following abbreviations are used in this guide:
The following conventions are used in this guide:
Table 2 Utilities not included in this book
Utility name Description
emenablepriv Opens the Windows Task Manager window with the privileges required to
stop CONTROL-M/EM processes. This utility runs on Microsoft Windows
only. For more information, see the CONTROL-M/Enterprise Manager
Administrator Guide.
migrate_dc This utility is used for upgrading CONTROL-M/Enterprise Manager
installations to version 6.2.01. For more information, see the
CONTROL-M/Enterprise Manager Migration Guide.
Abbreviation Description
CONTROL-M/EM CONTROL-M/Enterprise Manager
CONTROL-M/CM CONTROL-M Control Module
Net CONTROL-M/EM Network
$HOME, homeDirectory Directory in which CONTROL-M/EM is installed
key When describing keystrokes, the name of a key (for example, F1) is in
boldface type. When two keys are joined with + as in Shift+F1,
hold down Shift while pressing F1.
Menu => Option 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.
{Option A|Option B} The vertical bar is used to separate choices. For example:
{AND|OR}
means that you specify either AND or OR.
Command line conventions
Command line conventions
Parameters for running utilities from the command line can be specified in
short format, for example, -u user -p pass -s guiServerName
long format, for example,
-USERNAME user, -PASSWORD pass, -HOST guiServerName
uppercase or lowercase letters
The following table lists the parameters that can be specified in both short and long
formats.
Most of the examples in this book use parameters in lowercase, and are specified in
the short format.
[Option] Square brackets are used to enclose parameters that are optional.
Code Samples Format syntax, operating system terms, examples, and JCL scripts
are presented in this typeface.
Boldface In instructions, boldface type highlights information that you enter.
File names, directory names and paths, and Web addresses also
appear in boldface type.
Italics Italic type is used to emphasize important terms. The titles of BMC
Software product documentation are also displayed in italic type.
Ellipsis An ellipsis ( . . . ) indicates that you can repeat the preceding item or
items as many times as necessary.
Option Symbol 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
NOTE
Unless specifically stated, utilities that can run on UNIX can also be run on Linux and on
Microsoft Windows.
Parameter Short Format Long Format
User name -u (or -U) -username (or -USERNAME)
User password -p (or -P) -password (or -PASSWORD)
Host computer -s (or -S) -host (or -HOST)
Source file -src (or -SRC) -src_file (or -SRC_FILE)
Argument file -arg (or -ARG) -arg_file (or -ARG_FILE)
Output file -out (or -OUT) -out_file (or -OUT_FILE)
Chapt er
2
2 Command Line Interface utility (cli)
The Command Line Interface (cli) utility is a batch utility that enables you to perform
the following operations (services) from the command line:
Upload or Download scheduling tables
Order or Force scheduling tables
Order or Force jobs
Force jobs in a group scheduling table
Upload or Download calendars
Delete job processing definitions from scheduling tables
This chapter includes the following topics:
Invoking the cli utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
General notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Uploading and downloading schedule tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Forcing schedule tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Ordering schedule tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Uploading and downloading calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Forcing jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Ordering jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Deleting job definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Invoking the cli utility
The cli utility can be used on UNIX and Microsoft Windows computers. The cli utility
is installed automatically on Microsoft Windows computers during installation of the
CONTROL-M/EM Gateway, GUI server, and CONTROL-M Configuration Manager
components.
Many of the tasks performed by the cli utility can also be performed using
CONTROL-M/EM and CONTROL-M/Desktop. However, by including a utility
command in the command line of a job processing definition, you can run the utility
at a predetermined time or under a predetermined set of conditions without being
present.
To invoke the cli utility
1. Change the working directory to the CONTROL-M/EM home directory.
2. Specify the following command, depending on your operating system:
On Microsoft Windows
cl i [ {( - U emUser - P emPass) | - pf passwordFile}] - h hostName
[ - t timeout] [ - DDMM] [ - BY_FORCE] - servi ce serviceParameters
[ - servi ce serviceParameters . . . ] <cmd> <cmd> . . .
On UNIX
ecs cl i [ {( - U <emUser> - P <emPass>) | - pf <passwordFile>}]
- h <hostName> [ - t <timeout>] [ - DDMM] [ - BY_FORCE]
- servi ce <serviceParameters> [ - servi ce <serviceParameters> . . . ] <cmd>
<cmd> . . .
Table 3 describes the parameters in the above commands.
Table 3 cli utility parameters (part 1 of 3)
Parameter Description
-U emUser CONTROL-M/EM user name.
-P emPass CONTROL-M/EM user password.
-pf
passwordFile
Flat file containing an unencrypted user name and password on separate
lines in the format:
user=username
password=password
Note: If both -U and -pf are specified, an error message is generated. If only
-U is specified, an online prompt is issued for the password. If neither is
specified, a prompt is issued for both the user name and password.
-h hostName Host name of the workstation running CONTROL-M/EM Server.
Note: If you need to address a GUI server and multiple GUI servers exist, set
this parameter to the logical name of the relevant GUI server.
-t timeout Time, in seconds, that the utility waits for a response. Timeout is used to
override the default waiting period (120 seconds).
Note: Do not use timeout with commands that do not return a response
(-JOB_DELETE and -MEM_DELETE).
-DDMM If specified, reverses the Odate format, as described below.
-BY_FORCE Forces the specified table or calendar. Use this option during upload only.
-service Name of the service. See serviceParameters below.
servicePara-
meters
Service parameters used in the cli utility:
control-m Name of the CONTROL-M installation.
table Name of the scheduling table.
calendar Name of the Calendar.
jobName Name of the job.
Odate Order date. Default format is MMDD or
YYYYMMDD. If the -DDMM flag is used, the format
is DDMM or DDMMYYYY.
Default when using CONTROL-M/Server version
6.0.0x or later: ODAT. Default when using a
CONTROL-M/Server prior to version 6.0.0x: the
current date.
Note: You can also specify ODAT in place of a
specific date. This feature is supported for jobs when
using CONTROL-M/Server version 6.0.0x and later.
library [z/OS only] Library containing the table.
You can make multiple requests in a single operation. Each service requires its own
service name and includes all the relevant service parameters that follow it.
cmd The syntax for additional commands that are available for specifying with
the cli utility are shown below.
-JOB_ORDER <CTM_name> <table_name> <job_name> <Odate>
<Wait_Odate>[<With_Hold>] [<library>]
-JOB_FORCE <CTM_name> <table_name> <job_name>
<Odate><Wait_Odate> [<With_Hold>] [<library>]
-JOB_ORDER_INTO <CTM_name> <table_name> <job_name>
<sched_group> [<Duplication>]
<Odate><Wait_Odate> [<With_Hold>] [<library>]
-JOB_FORCE_INTO <CTM_name> <table_name> <job_name>
<sched_group> [<Duplication>] <Odate>
<Wait_Odate> [<With_Hold>] [<library>]
-TABLE_ORDER <CTM_name> <table_name> <Odate>
<Wait_Odate> [<With_Hold>] [<library>]
-TABLE_FORCE <CTM_name> <table_name> <Odate>
<Wait_Odate>[<With_Hold>] [<library>]
-TABLE_UPLOAD <CTM_name> <table_name> [<library>]
-TABLE_
DOWNLOAD
<CTM_name> <table_name> [<library>]
-CAL_UPLOAD <CTM_name> <calendar_name>
-CAL_DOWNLOAD <CTM_name> <calendar_name>
-JOB_DELETE <CTM_name> <table_name> <job_name>
ALL|NONE|NUMBER
-MEM_DELETE <CTM_name> <table_name> <mem_name>
ALL|NONE|NUMBER [<library>]
General notes
General notes
The following notes are applicable to the cmd commands in Table 3.
Table 4 Notes applicable to cli commands
Command Description
<Odate> Specify either as: MMDD or YYYYMMDD.
<Odate> may also be ODAT for CONTROL-M version 6.0.00 or later
(Order or Force Table in the Original Scheduling Date)
If the -DDMM is specified, <Odate> can be specified as DDMM or
DDMMYYYY
<sched_group> Valid values are:
RECENT - Force Job into the recent scheduling group that was
previously ordered
NEW Force Job into a new scheduling group
STANDALONE Force Job as a standalone job
<GroupOrderID> Force the specified job into the specified scheduling group
<Duplication> Specify if <sched_group> is RECENT or <GroupOrderID>, otherwise
do not specify.
Specify one of the following values:
N - Don't allow duplication of the job.
Y - Allow duplication of the job.
<Wait_Odate> Relevant only for CONTROL-M for z/OS version 6.2.00 or later and for
CONTROL-M for Distributed Systems version 6.3.00 or later.
Determines whether you should wait for the Odate to run the job. Valid
values are:
N - Run the job immediately.
Y - Wait for Odate to run job.
Wait_Odate - Wait for Odate to run job. (For CONTROL-M for
Distributed Systems version 6.3.00 or later)
<With_Hold> Relevant only for CONTROL-M for z/OS version 6.2.00 or later and for
CONTROL-M for Distributed Systems version 6.3.00 or later.
Specify one of the following values:
N - Order/Force the job in a free state.
Y or With_Hold - Order/Force the job in a Hold state.
<library> Mandatory when ordering MVS Jobs.
NOTE
You must have proper security authorization for any of the actions you perform using cli.
Uploading and downloading schedule tables
Uploading and downloading schedule tables
This section presents a series of commands that enable you to perform various tasks.
To upload a scheduling table
cli [{(-U dbUser -P dbPass) | -pf passwordFile}] -h hostName [-t timeout]
-TABLE_UPLOAD control-mTable [Odat] [library]
On UNIX
ecs cli [{(-U <dbUser> -P <dbPass>) | -pf <passwordFile>}] -h <hostName> [-t <timeout>]
-TABLE_UPLOAD <control-mTable> [Odat] [library]
To download a scheduling table
cli [{(-U dbUser -P dbPass) | -pf passwordFile}]
-h hostName [-t timeout] -TABLE_DOWNLOAD control-mTable [library]
On UNIX
ecs cli [{(-U <dbUser> -P <dbPass>) | -pf <passwordFile>}]
-h <hostName> [-t <timeout>] -TABLE_DOWNLOAD <control-mTable> [library]
Forcing schedule tables
To force a scheduling table
cli [{(-U dbUser -P dbPass) | -pf passwordFile}] -h hostName [-t timeout] [-DDMM]
-TABLE_FORCE control-mTable [Odate] [library]
On UNIX
ecs cli [{(-U <dbUser> -P <dbPass>) | -pf <passwordFile>}] -h <hostName> [-t timeout] [-
DDMM] -TABLE_FORCE <control-mTable> [Odate] [library]
Ordering schedule tables
Ordering schedule tables
To order a scheduling table
-TABLE_ORDER control-mTable [Odate] [library]
On UNIX
[-DDMM] -TABLE_ORDER <control-mTable> [Odate] [library]
Uploading and downloading calendars
To upload a calendar
cli [{(-U dbUser -P dbPass) | -pf passwordFile}] -h hostName [-t timeout] -CAL_UPLOAD
control-mCalendar
On UNIX
-CAL_UPLOAD <control-mCalendar>
To download a calendar
cli [{-U dbUser -P dbPass | -pf passwordFile}] -h hostName [-t timeout]
-CAL_DOWNLOAD control-mCalendar
On UNIX
-CAL_DOWNLOAD <control-mCalendar>
Forcing jobs
Forcing jobs
To force a job
-JOB_FORCE control-mTable jobName [Odate] [library]
On UNIX
ecs cli [{(-U <dbUser> -P <dbPass>) | -pf <passwordFile>}] -h <hostName>
[-t <timeout>] [-DDMM] -JOB_FORCE <control-mTable> <jobName> [Odate] [library]
To force a job into a group scheduling table
-JOB_FORCE_INTO control-mTable jobName sched_group [duplication] [Odate]
[library]
On UNIX
[-DDMM] -JOB_FORCE_INTO <control-mTable> <jobName> sched_group
[duplication] [Odate] [library]
sched_group Group scheduling table into which the job is forced. Valid values:
RECENT Forces the job into the group scheduling table that was
run most recently.
NEW Creates a new group scheduling table.
STAND
ALONE
Forces the job without adding it to a group scheduling
table.
GROUPI D Group scheduling table into which the job is forced.
[duplication] Adds a job to a table, even if there is a job with that name in the table.
Valid values:
Y Adds the job, if required.
N Does not create a duplicate job if a job of the same name
already exists
Note: This setting can be used only when RECENT or GROUPID are
selected for sched_group.
Ordering jobs
Ordering jobs
To order a job
-JOB_ORDER control-mTable jobName [Odate] [library]
On UNIX
[-DDMM] -JOB_ORDER <control-mTable> <jobName> [Odate] [library]
Deleting job definitions
To delete a job definition by Job Name
cli [{(-U dbUser -P dbPass) | -pf passwordFile}] -h hostName -JOB_DELETE
control-mTable jobName delete_type [library]
On UNIX
-JOB_DELETE <control-mTable> <jobName> delete_type [library]
To delete a job definition by Mem Name
cli [{(-U dbUser -P dbPass) | -pf passwordFile}] -h hostName -MEM_DELETE
control-mTable memName delete_type [library]
NOTE
When forcing or ordering a job, the CONTROL-M/EM does not check if multiple jobs with
the same name exist in the table.
Deleting job definitions
On UNIX
-MEM_DELETE <control-mTable> <memName> delete_type [library]
Table 5 describes the parameters of the above delete commands.
Table 5 cli utility Job Delete parameters
delete_type Indicates the type of operation to be performed. Valid values:
ALL All occurrences of the job are deleted, if there is more than
one job with the same name.
NONE No jobs are deleted if there is more than one job with the
same name.
sequence_number Deletes the job with the specified sequence number of the duplicate
job (for example, if 5 is entered, the fifth occurrence of the Job Name
is deleted).
library Required for z/OS job definitions.
Chapt er
3
3 Job utilities
The utilities described in this chapter are used to create, modify, and delete job
processing definitions.
Many of the tasks performed by the job utilities can also be performed in real-time
using the Job Editing and Group Editing forms in CONTROL-M/EM and
CONTROL-M/Desktop. However, by including a utility command in the command
line of a job processing definition, you can run the utility at a predetermined time or
under a predetermined set of conditions without being present.
Job definition utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
defjob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Parameters of the defjob utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
defjob input file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
copydefjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
deldefjob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Parameters of the deldefjob utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
duplicatedefjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Parameters of the duplicatedefjob utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
erase_audit_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Parameters of the erase_audit_data utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
exportdefjob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Parameters of the exportdefjob utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
loopdetecttool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Parameters of the loopdetecttool utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Arguments file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Output file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
sweep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Parameters of the sweep utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
updatedef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Parameters of the updatedef utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Job definition utilities
Job definition utilities
Table 6 describes the utilities in this chapter.
defjob
The defjob utility imports job processing definitions directly into a scheduling table in
the CONTROL-M/EM database.
defjob reads job processing definitions from a plain text input file written in XML
format.
Each job processing definition in the CONTROL-M/EM database has a JOBISN field
that contains a job ID number. Many jobs can have the same JOBISN number.
However, the JOBISN number is unique only inside specific scheduling tables. Use
the CONTROL-M/Desktop table manager to determine the job ID. Double-click the
required table to get the job list, including the jobs IDs.
Table 6 Job Definition utilities
Utility Description
defjob Imports a job processing definition directly into a scheduling table. (See
page 30.)
copydefjob Copies a specified job processing definition to a different data center or
scheduling table. (See page 45.)
deldefjob Deletes a specified job definition. (See page 60.)
duplicatedefjob Creates a copy of a job in the same datacenter and scheduling table. (See
page 63.)
exportdefjob Imports a job processing definition directly from a scheduling table to a
text file. (See page 81.)
loopdetecttool The loopdetecttool utility checks job processing definitions to determine if
conditions are defined in a way that would cause loops. (See page 84.)
updatedef Modifies existing job processing definitions, scheduling table definitions,
and group scheduling table definitions. (See page 97.)
NOTE
The cli utility uploads, downloads, orders, and forces jobs. It is described in Chapter 2,
Command Line Interface utility (cli).
defjob
If a job that is being imported contains a JOBISN number that already exists in the
CONTROL-M/EM database, defjob overwrites the existing job processing definition
with the new job processing definition. If a JOBISN value is not specified, defjob
imports the job processing definition into the database as a new job.
To invoke the defjob utility
1 Log on to a CONTROL-M/EM account (UNIX)
- or -
open a command prompt window (Microsoft Windows) where CONTROL-M/EM
is installed.
2 Enter either of the following commands:
defjob [-u user [-p password] | -pf passwordFile]
-s guiServerName -src srcFileName [/a]
- or -
defjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE passwordFile]
-HOST guiServerName -SRC_FILE srcFileName [/a]
Table 7 describes the parameters of the defjob utility.
3 Press Enter.
The defjob input file is checked and processed. If there are any errors in the file, a
message is displayed specifying the lines with the errors.
NOTE
JOBISN is the JOB_ID field in the def_job table. Many jobs can have the same JOBISN value.
The JOBISN field is a unique number
It is unique value but only inside a specific table.
Use the CONTROL-M/Desktop tables manager to determine the job ID. Double click the table
to get the job list including the jobs IDs.
Parameters of the defjob utility
Parameters of the defjob utility
Parameters of the defjob utility are described in Table 7.
Table 8 describes an optional switch for the defjob utility.
defjob input file
The job definitions that you create for use with the defjob utility are written in XML
format and saved in a text file.
When this file is invoked, its contents are passed to the CONTROL-M/EM database
and imported into the scheduling table specified in the job definition in the file.
Instructions for creating input files are in Appendix A, XML file preparation.
Table 7 defjob parameters
user CONTROL-M/EM user name.
password CONTROL-M/EM user password.
password_file Flat file containing an unencrypted user name and password on separate
user=username
password=password
Note: If both -u and -pf are specified, an error message is generated. If
only -u is specified, an online prompt is issued for the password. If neither
is specified, a prompt is issued for the database user name and password.
gui_server_name CONTROL-M/EM GUI server logical name, host name, or IP address.
Note: If multiple GUI servers exist, set this parameter to the logical name
of the relevant GUI server.
src_file_name The path and name of the XML file containing the defjob specifications.
For more information, see Appendix A, XML file preparation.
Table 8 defjob switch
Switch Description
/a Accept all. The /a switch directs the utility to automatically reset the Author
parameter to the current CONTROL-M/EM user when these two values do not
match. If not specified, the utility skips (that is, does not process) job definitions
whose Author does not match the currently logged in user.
Note: The /a switch has no effect on Administrator users and is relevant only when
the AuthorSecurity system parameter is set to 2 or 3.
defjob input file
The following rules apply to the input file of the defjob utility:
More than one job can be specified in a defjob file.
The input file is case-sensitive.
Although many parameters in Table 9 are optional, certain parameters are
required depending on the option specified for the TASKTYPE parameter. For
more information, see the Task Type description in the CONTROL-M Job Parameter
and Variable Reference Guide.
All parameter values (such as strings or digits) must be enclosed in quotation
marks (for example, JOBNAME="Job1").
Condition dates must be specified in mmdd format. Time must be specified in
hhmm format.
A parameter requiring more than one entry can be repeated as many times as
necessary. For example, if a job must wait for several prerequisite conditions,
specify a separate INCOND parameter for each prerequisite condition.
Each ON_STMT or ON_STEP parameter must be followed by at least one DO
parameter. DO parameters are dependent upon the last ON_STMT or ON_STEP
parameter preceding them.
TAG_NAME and TAG_RELATIONSHIP parameters are optional for jobs in a
group scheduling table and invalid for jobs that are not in a group scheduling
table. Values specified for TAG_NAME and TAG_RELATIONSHIP are ignored if
the job definition being created is not included in a group scheduling table.
Table 9 describes the input file parameters for the defjob utility.
Table 9 defjob input file parameters (part 1 of 11)
The first two lines of the arguments file specify the XML version, the text encoding format being used, and
the location of the .dtd file.
DEFJOB Indicates to CONTROL-M/EM the beginning and end of the defjob utility. Job
processing definitions are placed between the opening and closing DEFJOB tags. One
or more jobs can be specified. Each individual job is enclosed by JOB /JOB tags.
JOB Indicates the opening and closing tags of a single job definition. Parameters of the job
are listed between the tags.
DATACENTER Name of the CONTROL-M installation to which the job belongs. String. Mandatory.
Note: At least one of the following scheduling table parameters must be included in the
input file:
DATACENTER
TABLE_NAME
TABLE_DSN
TABLE_NAME Name of the scheduling table to which the job belongs. String. Mandatory.
Note: At least one of the following scheduling table parameters must be included in the
input file:
DATACENTER
TABLE_NAME
TABLE_DSN
defjob input file
TABLE_DSN [z/OS only] Name of the library that contains the scheduling table. String. Mandatory.
Note: At least one of these scheduling table parameters must be included in the input
file:
DATACENTER
TABLE_NAME
TABLE_DSN
JOBNAME Name of the job processing definition. String. Mandatory.
Note: On a Microsoft Windows platform, JOBNAME must comply with Microsoft
naming conventions (for example, it cannot contain / and \ characters).
MEMNAME Name of the file that contains the job script. String. Optional.
GROUP Name of the group to which the job belongs. Used as a descriptive name for related
groups of jobs. String. Mandatory.
APPLICATION Name of the application to which the jobs group belongs. Used as a descriptive name
for related groups of jobs. String. Mandatory.
TASKTYPE Type of job (task) to be performed by CONTROL-M. Mandatory.
Valid values:
Job
Detached
Command
Dummy
External
[z/OS only] Valid values:
Job
Started_Task
Note:
In CONTROL-M/EM versions earlier than 6.1.00, the TASKTYPE format contained:
for z/OS, emergency and cyclic information
for other operating systems, critical and cyclic information
CONTROL-M/EM version 6.2.01 and higher can run jobs with the old TASKTYPE
format. However, BMC Software recommends that, to specify this type of information
when creating new job processing definitions, you use CRITICAL and CYCLIC
parameters.
[for z/OS]
BMC Software recommends that, to specify this type of information when creating new
job processing definitions, you use CRITICAL (a value of 1 indicates that the job is an
Emergency job) and CYCLIC parameters.
Note: Critical path jobs are indicated by coding an * as the first character in the Priority
parameter. There is no connection between critical path jobs and the Critical parameter.
TABLE
_USERDAILY
String. Optional.
AUTHOR CONTROL-M/EM user who defined the job. String. Mandatory.
Note: This argument is used by the CONTROL-M/Server security mechanism and,
under certain circumstances, cannot be modified. For more information, see the
Security chapter and the description of the AuthorSecurity system parameter in the
defjob input file
MEMLIB Name of the library/directory in which the job script resides. String. Optional.
CMDLINE Command string supplied when the job Task Type is Command. String. Optional.
NODEID Host name of an agent computer or name of a node group to which the job is submitted.
String. Optional.
OWNER Owner (user ID) associated with the job. This parameter is used by the
CONTROL-M/Server security mechanism. String. Optional.
MAXRERUN Specifies the maximum number of reruns that can be performed for the job. Optional.
Valid values: 0-99. Default: 0
TIMEFROM Indicates the earliest time for submitting the job. String. Optional.
TIMETO Indicates the latest time for submitting the job. String. Optional.
DUE_OUT Time that the job is expected to finish. String. Optional.
PRIORITY Indicates CONTROL-M job priority. String. Optional.
CRITICAL Indicates that the job is a critical-path job in CONTROL-M. Optional. Valid values:
0 (No. Default)
1 (Yes)
CYCLIC Indicates whether the job is cyclic (to be run at regular intervals). Optional. Valid
values:
0 (No. Default)
1 (Yes)
CONFIRM Indicates whether the job must be manually confirmed by the CONTROL-M/EM user
before it runs. Optional. Valid values:
0 (Default)
1
AUTOARCH Determines whether SYSDATA is to be archived. Optional. Valid values:
0 (No. Default)
1 (Yes)
INTERVAL Specifies the length of time (in minutes) to wait between reruns of a job or between
cyclic runs of a job. Integer. Optional.
Default: 0.
OVERLIB Name of an alternate job script library/directory. String. Optional.
MAXWAIT Number of extra days (beyond the original scheduling date) that the job is allowed to
remain in the Active Jobs file awaiting execution. Integer. Optional.
DESCRIPTION Free text description of the job. String. Optional.
DOCMEM Name of the file containing job documentation. String. Optional.
DOCLIB Name of a library or directory containing the job documentation file. String. Optional.
DAYS Days of the month on which to order the job. String. Optional.
DAYS_AND_OR Indicates the relationship between specified Days values and Weekdays values.
Optional. Valid values:
AND
OR
WEEKDAYS Days of the week on which to order the job. String. Optional.
DATE Specific dates on which to order the job. String. mmdd format. Optional.
For example, January 10 is written as: DATE="0110"
defjob input file
DAYSCAL Name of a user-defined calendar used to specify a set of days. String. Optional.
WEEKSCAL Name of a calendar to be used to validate specified weekdays on which to order the job.
String. Optional.
CONFCAL Specifies a calendar that is used to validate all specified days and dates on which to
schedule the job. String. Optional.
RETRO Indicates whether the job is scheduled for possible execution after its original
scheduling date (odate) has passed. Optional. Valid values:
0 (No. Default)
1 (Yes)
SHIFT Describes how to shift the scheduling date of the job. Optional. Valid values:
IGNOREJOB
PREVDAY
NEXTDAY
NOCONFCAL
SHIFTNUM Number of days to shift the scheduling date of the job. Optional. Valid values: -62 to 62.
MAXDAYS Maximum number of days to retain the SYSDATA archive dataset for jobs that ended
NOTOK. Subparameter of AUTOARCH. Optional. Valid values: 00 98, or 99 to
indicate that SYSDATA is retained for an unlimited number of days.
MAXRUNS Maximum number of job runs to retain the SYSDATA archive dataset for jobs that
ended NOTOK. Subparameter of AUTOARCH. Optional. Valid values: 000 998, or
999 to retain SYSDATA data for all runs.
RERUNMEM Name of the JCL member to use when the job is automatically rerun. String. 1 - 8
characters. Optional.
RETEN_DAYS [z/OS only] Number of days to retain the job in the History Jobs file. String. Optional.
RETEN_GEN [z/OS only] Maximum number of generations of a job to keep in the History Jobs file
String. Optional.
PREV_DAY Flag to indicate whether job scheduling is shifted to a previous working day in the
CONFCAL calendar. Optional. Valid values:
Y
N
IND_CYCLIC Indicates whether the interval between further runs of a cyclic job is counted from the
start or the end of the previous job run. Optional. Valid values:
START
END
TAG
_RELATIONSHIP
Relationship (AND|OR) between the specified Schedule Tag criteria and the jobs own
basic scheduling criteria. This parameter is relevant only for jobs in a group scheduling
table. Optional. Valid values:
AND
OR
SYSDB Determines whether one or multiple data sets are used to catalogue sysdata. Optional.
Valid values:
0 (Multiple-Default)
1 (Single)
PDSNAME Name of a partitioned dataset (PDS) to be checked for free space. String. Optional.
defjob input file
MINIMUM Minimum number of free partitioned dataset tracks required by the library specified for
the PDSNAME parameter. Integer. Optional.
CATEGORY Name of a CONTROL-D report decollating mission category that must be scheduled
under CONTROL-D when the job is scheduled under CONTROL-M. String. Optional.
PREVENTNCT2 [z/OS only] Prevents dataset cleanup before the original job run Optional. Valid values:
Blank Does not perform data set cleanup before the original job run. Default.
N Does not prevent cleanup.
Y - Prevents data set cleanup. This value is not valid for started tasks.
L (List) Do not perform data set cleanup before the original job run. Do generate
messages that would be required for CDG 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).
JAN, FEB, MAR,
APR, MAY, JUN,
JUL, AUG, SEP,
OCT, NOV, DEC
Months when the job can run. Valid values:
0 (Not run. Default)
1 (Run)
OPTION Job output (sysout) handling options. Optional. Valid values:
Release
Delete
Copy
Move
File
NewDest
ChangeClass
PAR Certain OPTION values (such as Release, NewDest) require additional information.
String. Optional.
FROM Limits the sysout handling operation to only sysouts from the specified class. String.
Optional.
ADJUST_COND 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 group scheduling table. Optional. Valid values:
0 (Do not ignore. Default.)
1 (Ignore relevant prerequisite conditions)
JOBS_IN_GROUP Number of jobs in the group scheduling table. String. Optional.
CREATION_USER Name of the user who created the job. String. Optional.
CREATION_DATE Date on which the job was created. String. Optional.
CREATION_TIME Time at which the job was created. String. Optional.
CHANGE_USERID Name of the user who last modified the job. String. Optional.
CHANGE_DATE Date on which the job was last modified. String. Optional.
CHANGE_TIME Time at which the job was last modified. String. Optional.
JOB_RELEASE For internal use. Do not include this parameter in your defjob input file.
JOB_VERSION For internal use. Do not include this parameter in your deftable input file.
APPL_TYPE Indicates the type of external application (for example, SAP or Oracle Applications) on
which the external application job runs. String. Up to 10 characters. Mandatory for
external application jobs.
defjob input file
APPL_VER Version of the external application (for example, SAP or Oracle) on which the external
application job runs. String. Up to 10 characters. Mandatory for external application
jobs.
APPL_FORM Predefined set of external application parameters that are displayed in the Job Editing
form. String. Up to 30 characters. Mandatory for external application jobs.
CM_VER Indicates the version of external application (for example, SAP or Oracle Applications)
Control Module that is installed in the CONTROL-M installation. String. Up to 10
characters. Mandatory for external application jobs.
MULTY_AGENT When selected, broadcasts job submission details to all agents in a specified Node
Group. Optional. Valid values:
Y run as multi-agent job
N not run as multi-agent job. Default.
ACTIVE_FROM [z/OS only] Indicates the start of a period of time during which the job or group
scheduling table can be ordered. Optional.
Date Format: YYYYMMDD
ACTIVE_TILL [z/OS only] Indicates the end of the time interval during which the job or group
scheduling table can be ordered. Optional. Date Format: YYYYMMDD
TIMEZONE Indicates the global time zone used to calculate the interval for time-related conditions.
String. Optional.
SCHEDULING
_ENVIRONMENT
[z/OS only] Indicates the JES2 workload management scheduling environment
associated with the job. String. Optional.
SYSTEM
_AFFINITY
Identity of the system in which the job must be initiated and executed (in JES2).
Identity of the processor on which the job must execute (in JES3). String. Optional.
REQUEST_NJE
_NODE
Specifies the node in the JES network on which the job is to execute. String. Optional.
JOBISN For internal use. String. Optional.
TAG_NAMES Wrapper for the tags listed with the TAG_NAME parameter. Optional.
Example:
TAG_NAMES TAG_NAME="tag1" TAG_NAME="tag2"
TAG_NAME Name of the schedule tags that apply to the group scheduling
table. Mandatory.
INCOND In condition. Optional.
Example:
INCOND NAME="Cond1" ODATE="ODAT" AND_OR="AND" OP="("
NAME Name of the In condition. String. Mandatory. 1 - 255 characters,
case-sensitive.
ODATE Order date of the In condition. String. Mandatory. Valid values:
Default: ODAT
AND_OR Relationship between conditions. Optional. Valid values:
AND (default)
OR
OP Parentheses indicating parts of the condition that are interpreted
first. String. Optional.
defjob input file
OUTCOND Out condition. Optional.
Example:
OUTCOND NAME="Job1" ODATE="ODAT" SIGN="ADD"
NAME Name of the Out condition. String. Mandatory.
1 - 255 characters, case-sensitive.
ODATE Order date of the Out condition. String. Mandatory. Valid values:
Default: ODAT
SIGN Indicates whether to add or delete the condition. Mandatory.
Valid values:
ADD (default)
DEL
AUTOEDIT Wrapper for the AutoEdit expression. Optional.
Example:
AUTOEDIT EXP="%%PARM1=%%TIME"
EXP The AutoEdit expression. String. Mandatory.
Example: %%PARM1=%%TIME.
QUANTITATIVE Wrapper for the Quantitative resource. Optional.
Example:
QUANTITATIVE NAME="TAPEDRIVE" QUANT="1"
NAME Name of the quantitative resource. String. Mandatory.
QUANT Quantity of the resource. String. Mandatory. Valid values:
0 9999. Default: 1
CONTROL Wrapper for the Control resource. Optional.
Example:
CONTROL NAME="Resc1" TYPE="E"
NAME Name of the Control resource. String. Mandatory.
Valid values: 1-20 characters, case-sensitive, trailing blanks only.
TYPE Type of resource. Valid values:
E (exclusive-default)
S (shared)
defjob input file
SHOUT Wrapper for the Shout message. Optional. Example:
SHOUT WHEN="EXECTIME" DEST="workstation1" URGENCY="R" MESSAGE=
"Jobcompleted OK." TIME="1015
WHEN Condition under which the Shout message is sent. Mandatory.
Valid values:
OK (default)
NOTOK
RERUN
LATESUB
LATETIME
EXECTIME
DEST Recipient of the shout message. String. Mandatory.
Valid values: 1-16 characters, case-sensitive. Mandatory.
URGENCY Indicates the urgency of the Shout message. Mandatory.
Valid values:
R (regular-default)
U (urgent)
V (very urgent)
MESSAGE Text of the message. String. Mandatory. Valid values: 1 - 255
characters, spaces allowed.
TIME Time that the message is sent. String. Mandatory.
STEP_RANGE Step range in the job that can be used in an ON PGMST statement. Optional.
Example:
STEP_RANGE NAME="cleanup" FPGMS="Defrag" TPGMS=""
NAME Name for the range. 1-7 character string. Mandatory.
Valid values: 1 - 7 characters. Only trailing blanks are allowed.
FPGMS Name of the program to be run. as the first program step in the
range. 1 - 8 character string. Mandatory.
FPROCS Name of the procedure to be run. as the first procedure step in the
range. 1-8 character string. Mandatory.
TPGMS Last program step in the range. 1-8 character string. Mandatory.
Note: Subparameter TO is optional. If blank, its value defaults to
the last step in the job.
TPROCS Last procedure step in the range. 1-8 character string. Mandatory.
Note: Subparameter TO is optional. If blank, its value defaults to
the last step in the job.
defjob input file
ON Optional.
Example:
ON STMT="CODE" CODE="rt5" AND_OR="AND"><ON
STMT A character string containing a statement from the job script file.
String. 1-132 characters. Mandatory for the On Statement/Code
parameter..
CODE Return codes or statuses that can satisfy the step or code event
criteria if returned upon termination of the specified job steps.
String. Optional. Valid values: 1-132 characters.
PGMS Step in the program. String. Optional. Valid value: 1-8 characters.
PROCS Step in the process. String. Optional. Valid values:1-8 characters.
AND_OR Relationship between On statements. Optional. Valid values:
AND
OR
DO Specifies a status for the job based on conditions specified in an On statement. Optional.
Example:
DO ACTION="OK"
ACTION Mandatory. Valid values:
OK (Changes the status of the job to OK)
NOTOK (Changes the status of the job to NOTOK)
RERUN (Reruns the job)
SPCYC (Prevents further runs of a cyclic job)
DOSHOUT Shout message wrapper. Optional.
Example:
DOSHOUT DEST="Wkstn2" URGENCY="R" MESSAGE="Job5 completed OK"
DEST Recipient of the Shout message. String. Mandatory.
Valid values: 1 - 16 characters, case-sensitive.
URGENCY Urgency of the Shout message. Valid values:
R (regular-default)
U (urgent)
V (very urgent)
MESSAGE Text of Shout message. String, 1 - 255 characters, spaces allowed.
Mandatory.
DOCOND Specifies prerequisite conditions to be added or deleted. Optional.
Example:
DOCOND NAME="Cond1" ODATE="ODAT" SIGN="ADD"
NAME Condition name. String, 1 - 20 characters, case-sensitive.
Mandatory.
ODATE Condition date. String. Mandatory. Default: ODAT
SIGN Specifies whether to add or delete the condition. Valid values:
ADD (default)
DEL
defjob input file
DOAUTOEDIT Wrapper for the AutoEdit expression. Optional.
Example:
DOAUTOEDIT EXP="%%PARM1=%%TIME"
EXP The AutoEdit expression. String. Required.
Example: %%PARM1=%%TIME
DOFORCEJOB Forces a specified job when the current job is performed. Optional.
Example:
DOFORCEJOB DSN="45446" TABLE_NAME="Table2" NAME="Job4" ODATE=
"ODAT"
DSN [z/OS only] Library for scheduling table. String. Mandatory.
TABLE_NAME Name of the scheduling table to which the job belongs. String,
1-10 characters. Mandatory.
NAME Name of the job. String. Mandatory.
ODATE Original scheduling date for the job. String. Default: ODAT
DOSYSOUT Handle job output (sysout) when the job is done. Optional.
Example:
DOSYSOUT OPTION="Release" PAR="F" FROM=""
OPTION Sysout handling options. Mandatory. Valid values:
[All platforms]
Release
Delete
[not used with z/OS]
Copy
Move
[z/OS only]
File
NewDest
ChangeClass
PAR Certain OPTION values require that you supply additional
information (such as Release, NewDest). String. Optional.
FROM Limits the job output (sysout) handling operation to only sysouts
from the specified class. String. Optional.
defjob input file
DOIFRERUN Job steps to be executed during restart of a job. Available only at sites using
CONTROL-M/Restart. Optional.
Example:
DOIFRERUN CONFIRM="0" FPGMS="step1" FPROCS="proc1" TPGMS="step5"
TPROCS="proc3"
CONFIRM Indicates if job must be confirmed by user to be rerun.Valid
values:
0 (No confirmation. Default)
1 (Confirmation)
FPGMS Step at which the job must be restarted. String. 1 - 8 characters.
Mandatory.
FPROCS Program step within the called procedure. String. 1 - 8 characters.
Mandatory.
TPGMS Step at which restarted job must terminate. String. 1 - 8 characters.
Mandatory.
TPROCS Program step within the called procedure. String. 1 - 8 characters.
Mandatory.
DOMAIL Sends mail when the job run is complete. Optional.
Example:
DOMAIL URGENCY="R" DEST="emuser@emuser.com" CC_DEST=
"barry@emuser.com" SUBJECT="OK" MESSAGE="Task completed OK."
URGENCY Urgency of the message. Valid values:
R (regular - Default)
U (Urgent)
DEST Recipient of the message. String. Mandatory.
CC_DEST Additional recipient of the message. String. Optional.
SUBJECT Brief text description of the message contents. String. Optional.
MESSAGE Text of the message. String. Mandatory.
DOCTBRULE [z/OS only] Invokes a CONTROL-M/Analyzer rule to be executed during the
processing of a specific program step. Optional.
Example:
DOCTBRULE NAME="GOVTBAL" PAR="DOREPORT,10,%%ODATE"
NAME Name of the CONTROL-M/Analyzer rule. String. Mandatory.
PAR Arguments that are passed to the CONTROL-M/Analyzer rule.
String. Optional. Maximum: 45 characters.
defjob input file
The following sample input file is used with the defjob utility.
Example: Command job that requires confirmation before running
<DEFJ OB>
<J OB
TABLE_NAME=" Tbl 1"
TABLE_DSN=" 2232"
J OBNAME=" J ob1"
MEMNAME=" J ob1"
GROUP=" ACCT"
APPLI CATI ON=" App3"
DATACENTER=" CTMNYC"
TASKTYPE=" Command"
TABLE_USERDAI LY=" "
MEMLI B=" J obLi b1"
OWNER=" Br ad"
AUTHOR=CTMEMUSER
TI MEFROM=" 1210"
TI METO=" 1310"
MAXRERUN=" 1"
I NTERVAL=" 1"
PRI ORI TY=" 1"
CRI TI CAL=" 1"
CYCLI C=" 1"
CONFI RM=" 1"
DAYS=" 1, 2, 3"
DAYSCAL=" Thur s">

<OUTCOND NAME="Cond5" / >
<AUTOEDI T EXP="3" / >
<QUANTI TATI VE NAME=" " / >
<SHOUT WHEN=" OK" DEST=" COMP554" MESSAGE=" J ob
done. " TI ME=" 14: 30" / >
<STEP_RANGE NAME=" " FPGMS=" 1" FPROCS=" 1"
TPGMS=" 1" TPROCS=" 1" / >
<ON PGMS=" " PROCS=" " CODE=" " >
<DO ACTI ON=" OK"/ >
<DOAUTOEDI T EXP=" 2" / >
<DOSHOUT DEST="" MESSAGE=" " / >
<DOFORCEJ OB DSN=" " TABLE_NAME=" Tbl 1"
NAME=" J ob4" / >
<DOCTBRULE NAME=" DOCT" / >
<DOSYSOUT OPTI ON=" Rel ease" / >
<DOI FRERUN FPGMS=" 1" FPROCS=" 1" TPGMS=" 1"
TPROCS=" 1" / >
<DOCOND NAME=" COND4" / >
<DOMAI L DEST=" COMP667" MESSAGE=" J ob done. " / >
</ ON>
</ J OB>
</ DEFJ OB>
copydefjob
copydefjob
The copydefjob utility creates a new job definition in the CONTROL-M/EM database
that is similar to a specified existing definition. The original job and the copy must be
in different data centers or scheduling tables.
When copydefjob is invoked, it processes a file of arguments that specifies criteria for
selecting one or more existing job processing definitions. The selected jobs are copied
to the existing scheduling table and/or data center specified in the arguments file.
To invoke the copydefjob utility
- or -
is installed.
copydefjob [-u user [-p password] | -pf passwordFile] -s guiServerName
-arg argFileName [/a]
- or -
copydefjob [-USERNAME user [-PASSWORD password] |
-PASSWORD_FILE passwordFile] -HOST guiServerName -ARG_FILE argFileName [/a]
3 Press Enter. The copydefjob arguments file is checked and processed. If there are
any errors in the file, a message is displayed specifying the lines with the errors.
NOTE
Multiple jobs can be selected and copied using the * wildcard character. For an explanation of
how wildcards function in the XML-based utilities, see Wildcards on page 210.
Parameters of the copydefjob utility
Parameters of the copydefjob utility are described in Table 10.
An optional switch for the copydefjob utility is described in Table 11.
copydefjob arguments file
Arguments are used as selection criteria to determine which jobs to copy. Arguments
are written to the copydefjob argument file. The arguments files that you create with
the copydefjob utility are written in XML format and saved in a text file. The format
in which this file must be written is described on the following pages.
When this file is invoked, job processing definitions are exported from the
CONTROL-M/EM database.
Table 10 copydefjob parameters
password The CONTROL-M/EM user password.
passwordFile Flat file containing an unencrypted username and password on separate
user=username
password=password
is specified, a prompt is issued for both the database user name and
password.
guiServerName CONTROL-M/EM GUI server logical name, host name, or IP address.
argFileName Full path name of the arguments file containing copydefjob
specifications. Instructions for making this file are in Appendix A, XML
file preparation.
Table 11 copydefjob switch
Switch Description
/a The /a switch directs the utility to automatically reset the Author parameter to the
current CONTROL-M/EM user when these two values do not match. If not
specified, the utility skips (that is, does not process) job definitions whose Author
does not match the currently logged in user.
Each parameter that you specify must have a FROM value. This value is used as a
search criteria for selecting jobs to copy.
The following rules apply to the copydefjob utility arguments file:
More than one job can be specified in the arguments file.
The arguments file is case-sensitive.
Only one COPYJOB parameter can be used in an arguments file.
The COPYJOB parameter must contain only one of each job parameter. Many job
parameters are optional.
Multiple values can be specified for TO and FROM by using the * wildcard
character. For an explanation of how wildcards function in the XML-based utilities,
see Wildcards on page 210.
If any FROM value contains a * and the corresponding TO value contains a *, the *
in the TO value represents the same information the * in the FROM value.
Changing the data center name or the scheduling table name imports the copy of
the job into a data center or scheduling table different from the one in which the
original job was located.
Most job definition parameters are optional. However,
if you specify any parameters, the FROM subparameter is mandatory and the TO
subparameter is optional.
if a FROM value is specified without a TO value, it is used as a filter criterion.
if a TO value is specified, it indicates the new value of the parameter.
Input file parameters for the copydefjob utility are described in Table 12.
NOTE
The copydefjob utility can use only simple job parameters as search and replace criteria.
Complex parameters, such as the name of an In Condition or the degree of urgency of a Do
Shout parameter, cannot be used as search criteria or modified with the copydefjob utility.
Table 12 copydefjob arguments file parameters (part 1 of 11)
COPYJOB These tags indicate the start and end of the COPYJOB argument. Only criteria that are
located between the tags are considered to be part of the argument.
TABLE_NAME Name of the scheduling table to which the job belongs.
Note: At least one of the following scheduling table parameters must be included in
the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_NAME FROM=Tbl5NYC TO=Tbl7NYC
FROM Name of the scheduling table specified in the job processing definition that
is being copied. String. Mandatory.
TO The scheduling table name in the job processing definition copy. String.
Optional.
TABLE_DSN [z/OS only] Name of the library that contains the scheduling table. Mandatory.
the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_DSN FROM=Lib1 TO=Lib1_COPY
FROM Name of the library containing the scheduling table in the job processing
definition that is being copied. String. Mandatory.
TO Name of the library in the job processing definition copy. String. Optional.
DATACENTER Name of the CONTROL-M installation to which the job belongs.
the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
DATACENTER FROM="EM_Montreal" TO="EM_Paris"
FROM Name of the CONTROL-M installation to which the job being copied
belongs. Mandatory.
TO Name of the CONTROL-M installation to which the job copy belongs.
Optional.
JOBNAME Name of the job processing definition.
Example:
JOBNAME FROM="Job3"
FROM String. Mandatory.
MEMNAME Name of the file that contains the job script.
Example:
MEMNAME FROM="Mem3"
groups of jobs.
Example:
GROUP FROM="Grp_HR"
for related groups of jobs.
Example:
APPLICATION FROM="App3""
TASKTYPE Type of the job (task) to be performed by CONTROL-M.
Example:
TASKTYPE FROM="Detached"
FROM Mandatory. Valid values:
Job
Detached
Command
Dummy
Started_Task
Cyclic_Job
Cyclic_Task
Emergency_Job
Emergency_Cyclic_Job
Emergency_Task
Emergency_Cyclic_Task
TABLE
_USERDAILY
Optional.
Example:
TABLE_USERDAILY FROM="Job3"
AUTHOR CONTROL-M/EM user who defined the job. String. Optional.
Example:
AUTHOR FROM="emuser"
Note: This argument is used by the CONTROL-M/Server security mechanism and,
under certain circumstances, cannot be modified. For more information, see the
Security chapter and the description of the AuthorSecurity system parameter in the
Example:
MEMLIB FROM="Mem1"
CMDLINE Command string supplied when the job Task Type is Command. Optional.
Example:
CMDLINE FROM="C:\Format"
NODEID Host name of an agent computer or name of a node group to which the job is
submitted. Optional.
Example:
NODEID FROM="Com3"
CONTROL-M/Server security mechanism. Optional.
Example:
OWNER FROM=" emuser "
MAXRERUN Specifies the maximum number of reruns that can be performed for the job.
Example:
MAXRERUN FROM="1"
Valid values: 0-99. Default: 0
TIMEFROM Indicates the earliest time for submitting the job.
Example:
TIMEFROM FROM="1430"
TIMETO Indicates the latest time for submitting the job.
Example:
TIMETO FROM="1600"
DUE_OUT Time that the job is expected to finish.
Example:
DUE_OUT FROM="1500"
PRIORITY Indicates CONTROL-M job priority.
Example:
PRIORITY FROM="AA"
CRITICAL Indicates that the job is a critical-path job in CONTROL-M.
Example:
CRITICAL FROM="0"
0 (Default)
1
CYCLIC Indicates if the job is cyclic (to be rerun at regular intervals). Optional.
Example:
CYCLIC FROM="0"
0 (Default)
1
CONFIRM Indicates that the job must be manually confirmed by the CONTROL-M/EM user
before it runs.
Example:
CONFIRM FROM="0"
0 (Default)
1
AUTOARCH Determines whether SYSDATA is to be archived.
Example:
AUTOARCH FROM=0"
0 (Default)
1
INTERVAL Specifies the length of time (in minutes) to wait between reruns of a job or between
cyclic runs of a job. Integer. Optional.
Example:
INTERVAL FROM="3"
OVERLIB Name of an alternate job script library/directory. String.
Example:
OVERLIB FROM="lib3"
MAXWAIT Number of extra days (beyond the original scheduling date) that the job is allowed to
remain in the Active Jobs file awaiting execution. Integer.
Example:
MAXWAIT FROM="4"
DESCRIPTION Free text description of the job. String.
Example:
DESCRIPTION FROM="data backup from 120399"
DOCMEM Name of the file containing job documentation. String.
Example:
DOCMEM FROM="mem4"
DOCLIB Name of a library or directory containing the job documentation file. String.
Mandatory.
Example:
DOCLIB FROM="AcctFiles"
Example:
DAYS FROM="ALL"
Optional.
Example:
DAYS_AND_OR FROM="AND"
Example:
WEEKDAYS FROM="1,2,4"
DATE Specific dates on which to order the job. String. MMDD format. Optional.
Example:
DATE FROM="0312"
FROM String. Mandatory. Dates can be written in mmdd format. There is no
delimiter between dates. For example, January 10 is written in this manner:
DATE="0110"
Example:
DAYSCAL FROM="shipping"
WEEKSCAL Name of a calendar to be used to validate specified weekdays on which to order the
job. String. Optional.
Example:
WEEKSCAL FROM="2"
schedule the job. String.
Example:
CONFCAL FROM="cal99" TO="cal00"
scheduling date (odate) has passed.
Example:
RETRO FROM="0"
0 (No. Default)
1 (Yes.)
SHIFT Describes how to shift the scheduling date of the job.
Example:
SHIFT FROM="PREVDAY"
IGNOREJOB
PREVDAY
NEXTDAY
NOCONFCAL
SHIFTNUM Number of days to shift the scheduling date of the job.
Example:
SHIFTNUM FROM="-10"
MAXDAYS Maximum number of days to retains the SYSDATA archive dataset for jobs that ended
NOTOK. Subparameter of AUTOARCH. String. Optional.
Example:
MAXDAYS FROM="07"
FROM Integer. Mandatory.
MAXRUNS Maximum number of job runs to retains the SYSDATA archive dataset for jobs that
ended NOTOK. Subparameter of AUTOARCH. String. Optional.
Example:
MAXRUNS FROM="100"
RERUNMEM Name of the JCL member to use when the job is automatically rerun. String. 1-8
Example:
RERUNMEM FROM="Mem45"
RETEN_DAYS [z/OS only] Number of days to retain the job in the History Jobs file. String. Optional.
Example:
RETEN_DAYS FROM="5"
RETEN_GEN [z/OS only] Maximum number of generations of the job to keep in the History Jobs
file. String.
Example:
RETEN_GEN FROM="3"
TASK_CLASS Job class for the task.
Example:
TASK_CLASS FROM="Distribution"
Distribution
Decollation
PREV_DAY Flag to indicate whether job scheduling is shifted to a previous working day in the
CONFCAL calendar. Optional.
Example:
PREV_DAY FROM="N"
Y
N
IND_CYCLIC Indicates whether the interval between further runs of a cyclic job is counted from the
start or the end of the previous job run. Optional.
Example:
IND_CYCLIC FROM="START"
START
END
TAG
_RELATIONSHIP
Relationship (AND|OR) between the specified Schedule Tag criteria and the jobs
own basic scheduling criteria. This parameter is relevant only for jobs in a group
scheduling table. Optional.
Example:
TAG_RELATIONSHIP FROM="AND"
AND
OR
SYSDB Determines whether one or multiple data sets are used to catalogue sysdata.
Example:
SYSDB FROM="1" TO="0"
0 (Multiple -Default)
1 (Single)
PDSNAME Name of a partitioned dataset (PDS) to be checked for free space. String. Optional.
Example:
PDSNAME FROM="Lib_3"
MINIMUM Minimum number of free partitioned dataset tracks required by the library specified
for the PDSNAME parameter. Integer. Optional.
Example:
MINIMUM FROM="5"
Example:
CATEGORY FROM="DAILY"
PREVENTNCT2 [z/OS only] Prevents dataset cleanup before the original job run. Optional.
Valid values:
Example:
PREVENTNCT2 FROM="1"
0
1
JAN, FEB, MAR,
APR, MAY, JUN, JUL,
AUG, SEP,
OCT, NOV, DEC
Months when the job can run. Optional.
Example:
JAN FROM="0"
FROM Mandatory. Not including a month is the same as including a month
having the value 0. Valid values:
0 (Default)
1
OPTION Job output (sysout) handling options.
Example:
OPTION FROM="Copy"
Release
Delete
Copy
Move
File
NewDest
ChangeClass
PAR Certain OPTION FROM values (such as Release, NewDest) require additional
information. The PAR parameter holds this information as a string.
Example:
PAR FROM="mem3.log"
FROM Limits the sysout handling operation to sysouts from the specified class. Optional.
Example:
FROM FROM="5"
the relevant predecessor jobs are not scheduled. This parameter is relevant only for
jobs in a group scheduling table. Optional. Valid values:
JOBS_IN_GROUP Number of jobs in the group scheduling table. Optional.
Example:
JOBS_IN_GROUP FROM="4"
APPL_TYPE Indicates the type of external application (for example, SAP or Oracle) on which the
external application job runs. Mandatory for external application jobs.
Example:
APPL_TYPE FROM=SAP
FROM Mandatory. String. Up to 10 characters.
application job runs. Mandatory for external application jobs.
Example:
APPL_VER FROM=4.6
form. Mandatory for external application jobs.
Example:
APPL_FORM FROM=Default SAP 4.6
CM_VER Indicates the version of external application (for example, SAP or Oracle) Control
Module that is installed in the CONTROL-M installation. Mandatory for external
application jobs.
Example:
CM_VER FROM=6.1.00
Group. Optional.
Example:
MULTY_AGENT FROM=N
Y run as multi-agent job
N not run as multi-agent job. Default.
ACTIVE_FROM [z/OS only] Indicates the start of a period of time during which the job or group
Example:
ACTIVE_FROM FROM=20040315
FROM Mandatory. Date Format: YYYYMMDD
ACTIVE_TILL [z/OS only] Indicates the end of a period of time during which the job or group
Example:
ACTIVE_TILL FROM=20040315
TIMEZONE Indicates global time zone used to calculate the interval for time-related conditions.
Optional.
Example:
TIMEZONE FROM=EST
FROM Mandatory. String. Default: GMT
SYSTEM_AFFINITY Identity of the system in which the job must be initiated and executed (in JES2).
Identity of the processor on which the job must execute (in JES3). Optional. String.
Example:
SYSTEM_AFFINITY FROM=SYS3
REQUEST_NJE
_NODE
Specifies the node in the JES network on which the job is to execute.
Example:
REQUEST_NJE_NODE FROM=OS5
SCHEDULING
_ENVIRONMENT
[z/OS only] Indicates the JES2 workload management scheduling environment that is
to be associated with the job.
Example:
SCHEDULING_ENVIRONMENT FROM=SCHD2
CREATION
_USER
Name of the user who created the job. String.
Example:
CREATION_USER FROM="emuser"
CREATION
_DATE
Date on which the job was created. String.
Example:
CREATION_DATE FROM="1212"
CREATION
_TIME
Time at which the job was created. String.
Example:
CREATION_TIME FROM="1230"
CHANGE
_USERID
Name of the user that last modified the job. String.
Example:
CHANGE_USERID FROM="emuser"
CHANGE
_DATE
Date that the job was last modified. String.
Example:
CHANGE_DATE FROM="1204"
CHANGE_TIME Time that the job was last modified. String.
Example:
CHANGE_TIME FROM="1650"
Following are sample input files used with the copydefjob utility:
Example 1: Copy selected jobs and change parameter values in the copies
This copydefjob arguments file copies job processing definitions in the Tbl5NYC
scheduling table if TABLE_DSN is Lib1 and JOBNAME is Job3. In the copy, the
TABLE_DSN value is changed to Lib1_COPY.
Example 2: Copy all jobs in one scheduling table to another scheduling table
Copies of all jobs in the Tbl5NYC scheduling table to the Tbl7LA scheduling table.
Example 3: Copy all cyclic jobs with a similar jobname
Copies of all cyclic jobs in the GrpAcct group that have a jobname beginning with the
string Acct from TABLE_DSN 23Y to TABLE_DSN 14G.
Copy jobs in a scheduling table to a group scheduling table
You can copy the jobs in a scheduling table to a group scheduling table using the
copydefjob utility.
1 Using CONTROL-M/Desktop, define a group scheduling table containing no jobs.
2 Write the group scheduling table to the CONTROL-M/EM database.
3 Create a copydefjob arguments file in which jobs in a scheduling table are copied
to the group scheduling table that you created:
<COPYJ OB>
<TABLE_NAME FROM=" Tbl 5NYC" / >
<TABLE_DSN FROM=" Li b1" TO=" Li b1_COPY" / >
<J OBNAME FROM=" J ob3" / >
</ COPYJ OB>
<COPYJ OB>
<TABLE_NAME FROM=" Tbl 5NYC" TO=" Tbl 7LA" / >
</ COPYJ OB>
<COPYJ OB>
<TABLE_DSN FROM=" 23Y" TO=" 14G" >
<GROUP FROM=" Gr pAcct " / >
<CYCLI C FROM=" 1" / >
<J OBNAME=" Acct *" / >
</ COPYJ OB>
A Open a text editor. Format the file using the specifications in copydefjob
arguments file on page 46.
B Specify the CONTROL-M installation in which the jobs to be copied reside using
the DATACENTER parameter:
DATACENTER FROM=CTM_Name
C Specify that the Table Name value of the jobs changes from the name of the
scheduling table to the name of the group scheduling table with the following
tag:
TABLE_NAME FROM=Sched_Tbl_Name TO=Grp_Sched_Tbl_Name>
D Save and close the file.
4 At the command line, enter the copydefjob utility command that uses the file that
you created in the previous step:
copydefjob -u emuser -p empass -s gui_server_name
-arg arg_file_name
5 Use the Scheduling Table Manager in CONTROL-M/Desktop to upload the group
scheduling table to the CONTROL-M/Server.
6 In the CONTROL-M/EM GUI, order the group scheduling table.
7 In the CONTROL-M/EM GUI, verify that the group scheduling table now contains
the jobs that were copied to it.
8 If you do not need the original Scheduling table, you can delete it.
Example
This arguments file copies all jobs in the RegTable scheduling table in the ctm600
data center to the GrpSTable group scheduling table.
<COPYJ OB>
<DATACENTER FROM=" ct m600" / >
<TABLE_NAME FROM=" RegTabl e" TO=" Gr pSTabl e" / >
</ COPYJ OB>
deldefjob
deldefjob
The deldefjob utility deletes specified job processing definitions from a scheduling
table in the CONTROL-M/EM database.
When deldefjob is invoked, it processes a specified file of arguments in XML format.
This file contains statements that identify existing job processing definitions. The
identified definitions are deleted from the CONTROL-M/EM database.
To invoke the deldefjob utility
- or -
is installed.
deldefjob [-u user [-p password] | -pf passwordFile] -s guiServerName
- or -
deldefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
passwordFile] -HOST guiServerName -ARG_FILE argFileName [/a]
Parameters of the deldefjob utility are described in Table 13.
3 Press Enter. The deldefjob arguments file is checked and processed. If there are any
errors in the file, a message is displayed specifying the lines with the errors.
Parameters of the deldefjob utility
Table 13 deldefjob parameters (part 1 of 2)
password CONTROL-M/EM password of the user.
deldefjob arguments file
The following rules apply to the deldefjob arguments file:
More than one job can be specified in a deldefjob file.
All parameter values must be enclosed in quotation marks (for example,
JOBNAME="Job1").
More than one PARAM parameter can be used in a TERM statement.
The relationship between PARAM parameters in a TERM statement is AND.
The default relationship between TERM statements is OR.
password_file Flat file containing an unencrypted username and password on separate
user=username
password=password
Note: If both -u and -pf are specified, an error message is generated. If only
-u is specified, an online prompt is issued for the password. If neither is
specified, a prompt is issued for the database user name and password.
Note: If multiple GUI servers exist, set this parameter to the logical name of
the relevant GUI server.
argFileName Path and name of the arguments file containing deldefjob specifications.
The format for this file is described in Table 14 on page 61. For
information about how to prepare this file, see Appendix A, XML file
preparation.
Table 14 deldefjob arguments file parameters (part 1 of 2)
TERMS These tags indicate the start and end of the TERM tags. Only criteria that are
located between these tags are considered to be part of the argument.
TERM The TERM tags indicate the start and end of a group of selection criteria for a job or
jobs that are to be deleted. Only PARAM tags that are located between the TERM
tags are considered to be part of the TERM argument.
REL Optional. Relationship between terms.
Valid values:
AND
OR (default)
Table 13 deldefjob parameters (part 2 of 2)
Sample arguments files used with the deldefjob utility
Example 1 Delete definitions with the same job name
Delete job processing definitions with the name Job5 from the EM5NY data center.
Example 2 Delete definitions that satisfy one or both of two criteria
Delete job processing definitions that satisfy either of the following criteria:
The data center name is Data1 and the jobname begins with the letter J.
- or -
The jobname is Job5 and the job is not cyclic.
PARAM The selection criteria parameter used to determine job definitions to be deleted.
More than one PARAM can be specified. Mandatory.
Example:
PARAM NAME=" DATACENTER" OP=" EQ" VALUE=" Cent er 1"
NAME String. Mandatory.
Name of any job processing parameter, using the format shown in
Table 7 on page 32.Table 9 on page 33
Note: At least one of the following scheduling table parameters must
be included in the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
OP Mandatory. Valid values:
EQ Equal
NEQ Not equal
NOTIN Does not contain
LIKE Mask or pattern using wildcards
VALUE String. Mandatory.
Valid value for the specified job processing parameter, using the
format in Table 7 on page 32.
<TERMS>
<TERM>
<PARAM NAME=" DATACENTER" OP=" EQ"
VALUE=" EM5NY" / >
<PARAM NAME=" J OBNAME" OP=" EQ" VALUE=" J ob5" / >
</ TERM>
</ TERMS>
<TERMS>
<TERM>
Table 14 deldefjob arguments file parameters (part 2 of 2)
duplicatedefjob
Example 3 Delete definitions that meet multiple criteria
Delete definitions for cyclic jobs in the EM5NY data center that are scheduled to run in
January, February, and March.
duplicatedefjob
The duplicatedefjob utility makes a copy of an existing job definition in the same data
center and scheduling table. Elements of the copy can be changed.
When duplicatedefjob is invoked, it processes a specified file of arguments in XML
format. This file contains statements that identify existing job processing definitions.
The identified definitions are copied, changes to the copy (if requested) are made, and
the copy is stored in the CONTROL-M/EM database.
VALUE=" Dat a1" / >
<PARAM NAME=" J OBNAME" OP=" LI KE" VALUE=" J *" / >
</ TERM>
<TERM>
<PARAM NAME=" CYCLI C" OP=" EQ" VALUE=" 0" / >
</ TERM>
</ TERMS>
<TERMS>
<TERM>
VALUE=" EM5NY" / >
<PARAM NAME=" CYCLI C" OP=" EQ"
VALUE=" 1" / >
<PARAM NAME=" J AN" OP=" EQ" VALUE=" 1" / >
<PARAM NAME=" FEB" OP=" EQ" VALUE=" 1" / >
<PARAM NAME=" MAR" OP=" EQ" VALUE=" 1" / >
</ TERM>
</ TERMS>
NOTE
Multiple jobs can be selected and copied using the * wildcard character. For an explanation of
how wildcards function in XML-based utilities, see Wildcards on page 210.
Parameters of the duplicatedefjob utility
To invoke the duplicatedefjob utility
- or -
is installed.
duplicatedefjob [-u user [-p password] | -pf passwordFile]
-s guiServerName -arg argFileName [/a]
- or -
duplicatedefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
Table 15 describes the parameters of the duplicatedefjob utility.
3 Press Enter. The duplicatedefjob arguments file is checked and processed. If the
file contains errors, a message is displayed specifying the lines with the errors.
Table 16 describes an optional switch for the duplicatedefjob utility.
Table 15 duplicatedefjob parameters
passwordFile Flat file containing an unencrypted username and password on separate
user=username
password=password
gui_server_
name
CONTROL-M/EM GUI server logical name, host name, or IP address.
arg_file_name Path and name of the arguments file containing duplicatedefdefjob
specifications. The format for this file is described in Table 17 on
page 66. For information about how to prepare this file, see Appendix A,
XML file preparation.
duplicatedefjob Arguments file
Each arguments file parameter that you specify must have a FROM subparameter.
The FROM value is used as a search criteria for selecting jobs to copy. For example,
JOBNAME FROM="Job2" copies all jobs with the JobName Job2.
The TO subparameter, which is optional, is used to change the value of the
parameter. For example, JOBNAME FROM="Job2" TO="Job2B" modifies all jobs with
JobName Job2 so that they now have JobName Job2B.
The following rules apply to the arguments file for the duplicatedefjob utility:
More than one job can be specified in a duplicatedefjob file.
JOBNAME="Job1").
Only one DUPLICATEJOB parameter can be used in the arguments file. This
parameter must not contain more than one instance of each job parameter.
If any FROM value contains *, and the corresponding TO value contains *, the * in
the TO value expresses the same information as the * in the FROM value.
Table 16 duplicatedefjob switch
Switch Description
NOTE
Currently, the duplicatedefjob utility can use only simple job parameters as search and replace
criteria. Complex parameters, such as the name of an In Condition parameter or the degree of
urgency of a Do Shout parameter, cannot be used as search criteria or modified with the
duplicatedefjob utility.
Changing the data center name or scheduling table name causes the copy of the job
scheduling definition to be imported into the specified data center or scheduling
table.
FROM and TO subparameters
Most job definition parameters in the arguments file are optional. However
For each parameter that is specified, the FROM subparameter is mandatory and
the TO subparameter is optional.
When FROM is specified without a TO, the FROM value is used as a filter criterion.
When TO is included, it specifies the value to which the parameter is set.
Table 17 duplicatedefjob arguments file tags (part 1 of 13)
Tag Description
DUPLICATEJOB The DUPLICATEJOB tags indicate the start and end of a group of selection criteria for
a job or jobs that are to be copied. Only criteria that are located between the
DUPLICATEJOB tags are considered to be part of the duplicatedefjob parameters.
TABLE_NAME Name of the scheduling table to which the job belongs. Mandatory.
the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_NAME FROM=Tbl5NYC
TO String. Optional. Include only if the scheduling definition is to be
copied to a scheduling table with a different name.
TABLE_DSN [z/OS only] Name of the library that contains the scheduling table.
Mandatory.
Notes:
A TO subparameter cannot be specified for this parameter.
At least one of the following scheduling table parameters must be included in the
arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_DSN FROM=Lib1
DATACENTER Name of the CONTROL-M installation to which the job belongs. Mandatory.
Notes: A TO parameter cannot be specified for this parameter.
At least one of the following scheduling table parameters must be included in the
arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
DATACENTER FROM="CTMNYC"
TABLE_
USERDAILY
String. Mandatory.
Note: A TO parameter cannot be specified for this parameter.
Example:
JOBNAME Name of the job processing definition. Optional.
Example:
JOBNAME FROM="Job3" TO="Job3_COPY"
FROM Mandatory.
TO Optional.
MEMNAME Name of the file that contains the job script. Optional.
Example:
MEMNAME FROM="Mem3" TO="Mem7"
FROM Mandatory.
TO Optional.
jobs. Optional.
Example:
GROUP FROM="Grp_HR" TO="Grp_ACCT"
FROM Mandatory.
TO Optional.
for related jobs. Optional.
Example:
APPLICATION FROM="App3" TO="App1"
TO String Optional.
Tag Description
TASKTYPE Type of the job (task) to be performed by CONTROL-M. Optional.
Example:
TASKTYPE FROM="Detached" TO="Job"
FROM Mandatory.
Valid values:
Job
Detached
Command
Dummy
Started_Task
Cyclic_Job
Cyclic_Task
Emergency_Job
Emergency_Cyclic_Job
Emergency_Task
Emergency_Cyclic_Task
TO Optional. Valid values: Same as mandatory FROM values.
[z/OS only] Valid values: Same as z/OS FROM values.
AUTHOR CONTROL-M/EM user who defined the job. String. Optional.
Example:
AUTHOR FROM="emuser" TO="em5"
Note: This argument is used by the CONTROL-M/Server security mechanism. Under
certain circumstances, it cannot be modified. For more information, see the Security
chapter and the description of the AuthorSecurity system parameter in the
TO String. Optional.
Example:
MEMLIB FROM="Mem1" TO="Mem4"
Example:
CMDLINE FROM="C:\Format" TO="C\:CD Emnt"
NODEID Host name of an agent computer or a node group to which the job is submitted.
Optional.
Example:
NODEID FROM="Com3" TO="Acct4"
TO Host name of the agent computer on which the job copy is
running Optional.
Tag Description
Example:
OWNER FROM="emuser" TO="emhr"
MAXRERUN Maximum number of reruns that can be performed for the job. Optional.
Example:
MAXRERUN FROM="1" TO="3"
TIMEFROM Earliest time for submitting the job. Optional.
Example:
TIMEFROM FROM="1430" TO="1450"
TIMETO Latest time for submitting the job. Optional.
Example:
TIMETO FROM="1600" TO="1620"
DUE_OUT Time that the job is expected to finish. Optional.
Example:
DUE_OUT FROM="1500" TO="1530"
PRIORITY CONTROL-M job priority. Optional.
Example:
PRIORITY FROM="AA" TO="1A"
CRITICAL Indicates whether the job is a critical-path job in CONTROL-M. Optional.
Example:
CRITICAL FROM="0" TO="1"
0 (No. Default)
1 (Yes)
TO Optional. Valid values:
0 (No. Default)
1 (Yes)
Tag Description
CYCLIC Indicates whether the job is cyclic (to be run at regular intervals). Optional.
Example:
CYCLIC FROM="0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
CONFIRM Indicates whether the job must be manually confirmed by the CONTROL-M/EM user
before it runs. Optional.
Example:
CONFIRM FROM="0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
AUTOARCH Determines whether SYSDATA is to be archived. Optional.
Example:
AUTOARCH FROM=0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
INTERVAL Length of time (in minutes) to wait between reruns or cyclic runs of a job. Integer.
Optional.
Example:
INTERVAL FROM="3" TO="4"
Example:
OVERLIB FROM="lib3" TO="lib4"
MAXWAIT Number of extra days (after the original scheduling date) that the job is allowed to
remain in the Active Jobs file awaiting execution. Integer. Optional.
Example:
MAXWAIT FROM="4" TO="3"
TO Integer. Optional.
Tag Description
Example:
DESCRIPTION FROM="data backup from 120399" TO="data backup from 021400"
Example:
DOCMEM FROM="mem4" TO="Mem67"
DOCLIB Name of library or directory containing the job documentation file. String.
Optional.
Example:
DOCLIB FROM="AcctFiles" TO="HRFiles"
Example:
DAYS FROM="ALL" TO="159"
DAYS_AND_OR Relationship between specified Days values and Weekdays values. Optional.
Example:
DAYS_AND_OR FROM="AND" TO="OR"
Example:
WEEKDAYS FROM="1,2,4" TO="ALL"
DATE Specific dates on which to order the job. String. MMDD format. Optional.
Example:
DATE FROM="0312" TO="0319"
FROM String. Dates are written in mmdd format. Mandatory. There is
no delimiter between dates. For example, January 10 is written:
DATE="0110."
TO String. Dates are written in mmdd format. Optional. There is no
delimiter between dates. For example, January 10 is written:
DATE="0110."
Tag Description
DAYSCAL User-defined calendar used to specify a set of days. String. Optional.
Example:
DAYSCAL FROM="shipping" TO="receiving"
WEEKSCAL Calendar to be used to validate specified weekdays on which to order the job. String.
Optional.
Example:
WEEKSCAL FROM="w5" TO="w6"
schedule the job. String. Optional.
Example:
scheduling date (odate) has passed. Optional.
Example:
RETRO FROM="0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
SHIFT Describes how to shift the scheduling date of the job. Optional.
Example:
SHIFT FROM="PREVDAY" TO="NEXTDAY"
IGNOREJOB
PREVDAY
NEXTDAY
NOCONFCAL
SHIFTNUM Number of days to shift the scheduling date of the job. Optional.
Example:
SHIFTNUM FROM="-10" TO="5"
Tag Description
MAXDAYS Maximum number of days to retain the SYSDATA archive dataset for jobs that ended
NOTOK. Subparameter of AUTOARCH. String. Optional.
Example:
MAXDAYS FROM="07" TO="14"
MAXRUNS Maximum number of job runs to retain the SYSDATA archive dataset for jobs that
Example:
MAXRUNS FROM="100" TO="250"
RERUNMEM [z/OS only] JCL member to use when the job is automatically rerun. String. 1 - 8
Example:
RERUNMEM FROM="Mem45" TO="Mem7"
RETEN_DAYS [z/OS only] Number of days to retain the job in the History Jobs file. String.
Optional.
Example:
RETEN_DAYS FROM="5" TO="7"
RETEN_GEN [z/OS only] Maximum number of generations to keep in the History Jobs file. String.
Optional.
Example:
RETEN_GEN FROM="3" TO="4"
TASK_CLASS Task class. Optional.
Example:
TASK_CLASS FROM="Distribution" TO="Decollation"
PREV_DAY Optional.
Example:
PREV_DAY FROM="N" TO="Y"
Y
N
Y
N
Tag Description
IND_CYCLIC Indicates whether the time interval between runs of a cyclic job is counted from the
start or the end of the previous job run. Optional.
Example:
IND_CYCLIC FROM="Y" TO="N"
START
END
START
END
TAG_
RELATIONSHIP
Relationship (AND|OR) between the specified Schedule Tag criteria and the jobs
own basic scheduling criteria. This parameter is relevant only for jobs in a group
scheduling table. Optional.
Example:
TAG_RELATIONSHIP FROM="AND" TO="OR"
AND
OR
AND
OR
SYSDB Determines whether single or multiple data sets are used to catalogue sysdata.
Optional.
Example:
0 (Multiple. Default)
1 (Single)
0 (Multiple. Default)
1 (Single)
PDSNAME Name of partitioned dataset (PDS) to be checked for free space. String. Optional.
Example:
PDSNAME FROM="Lib_3" TO="Lib_5"
MINIMUM Minimum number of free partitioned dataset tracks required by the library specified
for the PDSNAME parameter. Integer. Optional.
Example:
MINIMUM FROM="5" TO="6"
Tag Description
Example:
CATEGORY FROM="*" TO="DAILY"
PREVENTNCT2 [z/OS only] Prevents dataset cleanup before the original job run Optional. Valid
values:
Example:
PREVENTNC2 FROM="1" TO="0"
0 (Do not prevent)
1 (Prevent)
0 (Do not prevent. Default.)
1 (Prevent)
JAN, FEB, MAR,
APR, MAY, JUN, JUL,
AUG, SEP,
OCT, NOV, DEC
Months when the job can run. Optional. Not including a month is the same as
including that month with the value 0.
Example:
JAN FROM="0" TO="1"
JUL FROM="0" TO="1"
0 (Do not run the job. Default)
1 (Run the job.)
0 (Do not run the job. Default)
1 (Run the job.)
OPTION Job output (Sysout) handling options. Optional.
Example:
OPTI ON FROM=" Copy" TO="Rel ease"
Release
Delete
Copy
Move
File
NewDest
ChangeClass
TO Optional. Valid values: same as mandatory FROM values.
Tag Description
PAR Certain OPTION values require that you supply additional information (such as
Release, NewDest). The PAR parameter holds that information as a string. Optional.
Example:
PAR FROM="mem3log" TO="mem5log"
FROM Limits the sysout handling operation to sysouts from the specified class. Optional.
Example:
FROM FROM="1" TO="2"
the relevant predecessor jobs are not scheduled. This parameter is relevant only for
jobs in a group scheduling table. Optional. Valid values:
1 (Ignore relevant prerequisite conditions.)
Example:
ADJUST_COND FROM="1" TO="0"
APPL_TYPE Type of external application (for example, SAP or Oracle) on which the external
Example:
APPL_TYPE FROM=SAP TO=OracleApps
TO Optional. String.
Example:
APPL_VER FROM=4.5 TO=4.6
form. Mandatory for external application jobs.
Example:
APPL_FORM FROM=Default SAP 4.6 TO=Default SAP 4.5
CM_VER Version of external application (for example, SAP or Oracle) Control Module that is
installed in the CONTROL-M installation. Mandatory for external application jobs.
Example:
CM_VER FROM=6.1.00 TO=6.1.01
Tag Description
Group. Optional.
Example:
MULTY_AGENT FROM=N TO=Y
Y Run as multi-agent job
N Do not run as multi-agent job. Default.
ACTIVE_FROM [z/OS only] Start of a period of time during which the job or group scheduling table
can be ordered. Optional.
Example:
ACTIVE_FROM FROM=20040315 TO=20040601
ACTIVE_TILL [z/OS only] End of a period of time during which the job or group scheduling table
can be ordered. Optional.
Example:
ACTI VE_TI LL FROM=20040315 TO=20040601
TIMEZONE Global time zone used to calculate the interval for time-related conditions. Optional.
Example:
TIMEZONE FROM=EST TO=GMT
FROM Mandatory. String. Default: GMT
SYSTEM_AFFINITY Identity of the system in which the job must be initiated and executed (in JES2).
Identity of the processor on which the job must execute (in JES3). Optional. String.
Example:
SYSTEM_AFFINITY FROM=SYS3
Example:
SYSTEM_AFFINITY FROM=SYS3 TO=SYS6
REQUEST_NJE_
NODE
Node in the JES network on which the job is to execute.
Example:
REQUEST_NJE_NODE=OS5
Example:
REQUEST_NJE_NODE FROM=OS5 TO=OS6
Tag Description
SCHEDULING_
ENVIRONMENT
[z/OS only] Indicates the JES2 workload management scheduling environment
associated with the job.
FROM String. Mandatory. Example:
SCHEDULING_ENVIRONMENT FROM=SCHD2
TO String. Optional. Example:
SCHEDULING_ENVIRONMENT FROM=SCHD2 TO=
SCHD3
Example:
JOBS_IN_GROUP FROM="4" TO="10"
CREATION_USER Name of the user that created the job. String. Optional.
Example:
CREATION_USER FROM="emuser" TO="em1"
CREATION_DATE Date that the job was created. String. Optional.
Example:
CREATION_DATE FROM="1212" TO="2012"
CREATION_TIME Time that the job was created. String. Optional.
Example:
CREATION_TIME FROM="1230" TO="1430"
CHANGE_USERID Name of the user that last modified the job. String. Optional.
Example:
CHANGE_USERID FROM="emuser" TO="emacct"
CHANGE_DATE Date that the job was last modified. String. Optional.
Example:
CHANGE_DATE FROM="1204" TO="1304"
CHANGE_TIME Time that the job was last modified. String. Optional.
Example:
CHANGE_TIME FROM="1650" TO="1700"
Tag Description
erase_audit_data
Sample input files used with the duplicatedefjob utility
Example 1: Copy and modify definitions
Copy job processing definitions from the Tbl5NYC scheduling table that have
TABLE_DSN Lib1 and JOBNAME Job3. Change TABLE_DSN to Lib1_COPY and
change JOBNAME to Job3_COPY. Store the changed definitions in the same
scheduling table.
Example 2: Copy definitions from one scheduling table to another
Copy all the jobs in the Tbl5NYC scheduling table to the Tbl7LA scheduling table.
Example 3: Duplicate jobs based on several criteria
Copy all cyclic jobs in the GrpAcct group whose jobname begins with Acct.
Append _COPY to the job name of each copied job.
erase_audit_data
The erase_audit_data utility deletes records written prior to the specified date.
When erase_audit_data is invoked, it uses a script to delete records written before a
specified date. If the -U and -P parameters are not specified, the DBO user name and
password are prompted for. The erase_audit_data utility can delete large numbers of
audit records.
<DUPLI CATEJ OB>
<TABLE_NAME FROM=" Tbl 5NYC" / >
<TABLE_DSN FROM=" Li b1" TO=" Li b1_COPY" / >
<J OBNAME FROM=" J ob3" TO=" J ob3_COPY" / >
</ DUPLI CATEJ OB>
<DUPLI CATEJ OB>
<TABLE_NAME FROM=" Tbl 5NYC" TO=" Tbl 7LA" / >
</ DUPLI CATEJ OB>
<DUPLI CATEJ OB>
<GROUP FROM=" Gr pAcct " / >
<CYCLI C FROM=" 1" / >
<J OBNAME FROM=" Acct *" TO=" Acct *_COPY" / >
</ DUPLI CATEJ OB>
Parameters of the erase_audit_data utility
To invoke the exportdefjob utility
- or -
is installed.
2 Enter the following command:
erase_audit_data [-date YYYYMMDD] [-U emDboName]
[-P emDboPassword]
Records written prior to the specified date are deleted.
Parameters of the erase_audit_data utility
When cleanup of audit information from the CONTROL-M/EM database is
automatic, the MaxAuditsToDelete parameter specifies the maximum number of
audit records to delete during each automatic cleanup operation. If the number of
audit records to clean is higher than this number, no records are deleted. The default
is 400000 records. If the number of audit records to clean is higher than the
MaxAuditsToDelete parameter, a message is issued to the GUI Server diagnostic log
asking you to clean audit records manually using the erase_audit_data utility. For
more information about the MaxAuditsToDelete parameter, see CONTROL-M Job
Parameter and Variable Reference Guide. You can use the CONTROL-M/EM
Administration facility to change the automatic cleanup of audit information settings.
Table 18 erase_audit_data parameters
-date A date in YYYYMMDD format (for example, 20050915), which sets the
selection criteria for obsolete jobs. Default: two days before the current date
-U Name of the CONTROL-M/EM database.
-P Password of the CONTROL-M/EM database.
exportdefjob
exportdefjob
The exportdefjob utility exports job processing definitions from a scheduling table in
the CONTROL-M/EM database to an output file.
When exportdefjob is invoked, it processes a specified file of arguments in XML
format. This file contains statements that identify existing job processing definitions.
The identified definitions are exported from the CONTROL-M/EM database to an
output file. You can modify the exported job processing definitions in the output file
and can import the modified definitions into the CONTROL-M/EM database using
either the defjob or updatedef utility.
To invoke the exportdefjob utility
- or -
is installed.
exportdefjob [-u user [-p password] | -pf passwordFile] -s guiServerNameArg
argFileName -out outFileName
- or -
exportdefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
passwordFile] -HOST guiServerNameArg -ARG_FILE argFileName -OUT_FILE
outFileName
Parameters of the exportdefjob utility are described in Table 19.
3 Press Enter. The exportdefjob arguments file is checked and processed. If there are
any errors, a message is displayed specifying the lines with the errors. The
exported job processing definitions are saved to the output file whose name and
location is specified in the - out out Fi l eName parameter.
Parameters of the exportdefjob utility
Table 19 exportdefjob parameters (part 1 of 2)
exportdefjob arguments file
The following rules apply to the exportdefjob argument file:
More than one job can be specified in an exportdefjob file.
JOBNAME="Job1").
password_file Flat file containing an unencrypted username and password on separate
user=username
password=password
gui_server_
name
arg_file_name Path and name of the arguments file containing exportdefjob specifications.
For information about this file, see Appendix A, XML file preparation.
out_file_name Path and name of the file containing the exported job specifications.
Table 20 exportdefjob arguments file Parameters (part 1 of 2)
TERMS These tags indicate the start and end of the TERMS file. Only criteria that are
TERM The TERM tags indicate the start and the end of a group of selection criteria used
to specify a job or jobs that are to be exported. Only PARAM tags that are located
between the TERM tags are considered to be part of the TERM argument.
REL Relationship between terms. Optional. Valid values:
AND
OR
Table 19 exportdefjob parameters (part 2 of 2)
Example 1: Export job definitions based on one or more criteria
Export job processing definitions that either:
have data center name Data1 and a jobname that begins with the letter J.
- or -
have jobname Job5 and are not cyclic jobs.
Example 2: Export based on multiple criteria
Export all job processing definitions from either the Data1 or Data2 data center that
have a JobName that does not begin with the letter R.
PARAM Selection criteria parameter used to determine the job definitions that are to be
exported. More than one PARAM can be specified. Mandatory.
Example:
PARAM NAME="DATACENTER" OP="EQ" VALUE="Center1"
NAME String. Mandatory. The parameter name of any job
processing definition parameter. Job processing parameters
are described in Table 9 on page 33.
Note: At least one of the following scheduling table
parameters must be included in the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
OP Relationship between the NAME and VALUE parameters of
the TERM. Mandatory. Valid values:
EQ equal
NEQ not equal
NOTIN does not contain
LIKE mask or pattern
VALUE String. Mandatory. Value of the parameter specified in the
NAME field. Job processing parameters are described in
Table 9 on page 33.
<TERMS>
<TERM>
VALUE=" Dat a1" / >
</ TERM>
<TERM>
</ TERM>
</ TERMS>
Table 20 exportdefjob arguments file Parameters (part 2 of 2)
loopdetecttool
loopdetecttool
The loopdetecttool utility checks job processing definitions to determine if conditions
are defined in a way that would cause loops. A loop in this context means
a chain of jobs that will never run because the IN condition needed to start the first
job in the chain will be created only by the last job in the chain
any combination of jobs, groups, and conditions between them, because it is not
clear which job in the group will run first or last, creating or deleting the relevant
conditions
The loopdetecttool utility reads an argument file (in XML format) that contains
criteria that determine which job processing definitions and group scheduling tables
the utility should analyze. For more information, see Arguments file on page 86.
The utility checks for definitions whose conditions could potentially cause a loop.
After the utility runs, it summarizes the problematic jobs and conditions in an XML
format file.
To invoke the loop detection tool utility
1 Perform one of the following actions:
For UNIX:
Log on to a CONTROL-M/Enterprise Manager account.
For Microsoft Windows:
Open a command prompt window on a computer on which CONTROL-M/EM
is installed.
<TERMS>
<TERM>
VALUE=" Dat a1" / >
<PARAM NAME=" J OBNAME" OP=" NEQ" VALUE=" R*" / >
</ TERM>
<TERM>
VALUE=" Dat a2" / >
</ TERM>
</ TERM>
</ TERMS>
Parameters of the loopdetecttool utility
2 Enter the appropriate command:
For UNIX:
ecs loopdetecttool [-U <username> [-P <password>] | -pf <passwordFile>] -s
<guiServerName> -arg <argFileName> -out <outFileName>
For Microsoft Windows:
loopdetecttool [-U <username> [-P <password>] | -pf <passwordFile>] -s
<guiServerName> -arg <argFileName> -out <outFileName>
The parameters used in these commands are described in Table 21.
3 Press Enter to process the arguments file.
The arguments file is processed. Corresponding definitions in the
CONTROL-M/EM database are checked. A summary that lists problematic
definitions and conditions (loops) is produced in the output file whose name and
location is specified in the outFileName parameter. For a description of this report,
see Output file on page 88.
Parameters of the loopdetecttool utility
Table 21 loopdetecttool parameters (part 1 of 2)
user CONTROL-M/EM user name
password CONTROL-M/EM user password
passwordFile Flat file that contains an unencrypted user name and password on separate
lines in the following format:
user=username
password=password
specified, a prompt is issued for the CONTROL-M/EM user name and
password.
guiServerName CONTROL-M/EM GUI server logical name
Arguments file
Arguments file
The following rules apply to the loopdetecttool argument file:
The default relationship between TERM statements is OR.
JOBNAME=Job1).
argFileName Path and name of the arguments file that contains criteria for job and
scheduling table specifications. For information about this file, see
Arguments fileand the appendix about XML file preparation in the
CONTROL-M/Enterprise Manager Utility Guide for version 6.2.01.
outFileName Path and name of the output file that contains the summary of problematic
jobs and conditions (loops). For more information, see Output file on
page 88.
Table 22 loopdetecttool arguments file parameters (part 1 of 2)
the location of the .dtd file. These lines must appear exactly as follows:
?xml ver si on= 1. 0 encodi ng= UTF- 8 ?
! DOCTYPE TERMS SYSTEM " t er ms. dt d"
TERMS These tags indicate the start and end of the TERMS file. Only criteria that are located between
the tags are considered part of the argument.
TERM The TERM tags indicate the start and the end of a group of selection criteria used to specify a
job or jobs that are to be analyzed. Only PARAM tags that are located between the TERM tags
are considered part of the TERM argument.
REL The relationship between the terms (optional). Valid values are:
AND
OR
Table 21 loopdetecttool parameters (part 2 of 2)
Arguments file
Example 1: Analyze job definitions for loops based on one or more criteria
The following example file specifies to analyze job processing definitions that have
either of the following conditions:
The data center name is Data1, and a job name begins with the letter J.
The job name is Job5, and the job is not cyclic.
PARAM Selection criteria parameter used to determine the job definitions that are to be analyzed. You
can specify more than one PARAM. This parameter is required.
Example:
NAME The parameter name of any job processing definition parameter. This parameter is
required.
Note: At least one of the following scheduling table parameters must be included
in the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
OP The relationship between the NAME and VALUE parameters of the TERM. This
relationship is required. Valid values are
EQ equal
NEQ not equal
NOTIN does not contain
LIKE mask or pattern
VALUE The value of the parameter specified in the NAME field. This value is required.
<?xml ver si on= 1. 0 encodi ng= UTF- 8 ?>
<! DOCTYPE TERMS SYSTEM " t er ms. dt d" >
<TERMS>
<TERM>
<PARAM NAME=" DATACENTER" OP=" EQ" VALUE=" Dat a1" / >
</ TERM>
<TERM>
</ TERM>
</ TERMS>
Table 22 loopdetecttool arguments file parameters (part 2 of 2)
Output file
Example 2: Analyze job definitions for loops based on multiple criteria
The following example file specifies to analyze all job processing definitions from
either the Data1 or Data2 data center that have a job name that does not begin with
the letter R.
Output file
The output file is in XML format and is structured as follows:
All loops are listed between ctmem:loops tags.
For each loop found, problematic jobs and conditions are listed.
<TERMS>
<TERM>
</ TERM>
<TERM>
</ TERM>
</ TERMS>
Table 23 loopdetecttool output file parameters
The beginning of the arguments file specifies the location of the .dtd file as follows:
! DOCTYPE ct mem: l oop_cond_det ect SYSTEM " pat h\ f i l ename. dt d"
ctmem:message Between these tags, relevant messages are listed, such as the number of loops detected,
how many jobs were found in each loop, and other remarks.
ctmem:loops Between these tags, details about all found loops are listed.
ctmem:loop Between these tags, details about each found loop is listed. Each ctmem:loop tag contains
pairs of the following tags: ctmem:job and ctmem:condition.
ctmem:job Between these tags, information about the job that is part of a potential loop is displayed.
This information includes the jobs data center, scheduling table, group, application, and
job name. Pairs of jobs and conditions are grouped by In and Out conditions.
ctmem:condition Between these tags, information about the conditions that were found to cause a potential
loop is displayed. This information includes the conditions name, date, and type. Pairs of
jobs and conditions are grouped by In and Out conditions.
sweep
Following is a sample output file:
sweep
The sweep utility deletes jobs that are no longer active from the CONTROL-M/EM
and CONTROL-M/Server databases. These jobs are referred to as obsolete jobs and
are defined in Obsolete criteria on page 94. The sweep utility is available in
CONTROL-M/EM installations only.
To invoke the sweep utility
1 Perform one of the following actions:
(Microsoft Windows) Open a command prompt window on a computer on which
CONTROL-M/Enterprise Manager is installed.
<! DOCTYPE ct mem: l oop_cond_det ect SYSTEM " C: \ Pr ogr amFi l es\ Al t ova\ XML
Spy Sui t e\ Exampl es\ LoopDet ect Out . dt d" >
<ct mem: l oop_cond_det ect >
<ct mem: message>1 Loop was det ect ed. </ ct mem: message>
<ct mem: l oops>
<ct mem: message>2 J obs wer e f ound i n t he l oop</ ct mem: message>
<ct mem: l oop>
<ct mem: j ob>
<ct mem: cont r ol _m>PROD_DC1</ ct mem: cont r ol _m>
<ct mem: or der _t abl e>Dai l y_Pr od1</ ct mem: or der _t abl e>
<ct mem: appl i cat i on>Wi nDcPr od1</ ct mem: appl i cat i on>
<ct mem: gr oup>BackupDai l y</ ct mem: gr oup>
<ct mem: j ob_name>J ob1</ ct mem: j ob_name>
</ ct mem: j ob>
<ct mem: condi t i on>
<ct mem: cond_name>J ob1- Ended- OK</ ct mem: cond_name>
<ct mem: cond_dat e>ODAT</ ct mem: cond_dat e>
<ct mem: message>r egul ar condi t i on</ ct mem: message>
</ ct mem: condi t i on>
<ct mem: j ob>
<ct mem: cont r ol _m>PROD_DC1</ ct mem: cont r ol _m>
<ct mem: or der _t abl e>Dai l y_Pr od1</ ct mem: or der _t abl e>
<ct mem: appl i cat i on>Wi nDcPr od1</ ct mem: appl i cat i on>
<ct mem: gr oup>BackupDai l y</ ct mem: gr oup>
<ct mem: j ob_name>J ob2</ ct mem: j ob_name>
</ ct mem: j ob>
<ct mem: condi t i on>
<ct mem: cond_name>J ob2- Ended- OK</ ct mem: cond_name>
<ct mem: cond_dat e>ODAT</ ct mem: cond_dat e>
<ct mem: message>r egul ar condi t i on</ ct mem: message>
</ ct mem: condi t i on>
</ ct mem: l oop>
</ ct mem: l oops>
</ ct mem: l oop_cond_det ect >
Parameters of the sweep utility
(UNIX) Log on to a CONTROL-M/Enterprise Manager account.
2 Enter a command based on one of the following usages:
(Microsoft Windows)
sweep [-U <userName> -P <password> | -PF <passwordFile>] -S <serverName>
[-Local] [-Date <YYYYMMDD date>] [-Test | -Sync] [-Timeout <maxSeconds>]
[-Cyclic <maxFiles>] [-H | -Help] [-Force] [-Interval <milliseconds>]
(UNIX)
ecs sweep [-U <userName> -P <password> | -PF <passwordFile>] -S <serverName>
[-Local] [-Date <YYYYMMDD date>] [-Test | -Sync] [-Timeout <maxSeconds>] [-Cyclic
<maxFiles>] [-H | -Help] [-Force] [-Interval <milliseconds>]
The parameters are described in Table 24. The flags are not case sensitive.
3 Press Enter.
The parameters are processed and several reports, as described in Table 25, are
generated.
NOTE
Avoid updating of the job or table definitions when the sweep utility is running.
Table 24 sweep parameters (part 1 of 3)
-U userName CONTROL-M/EM user name
Note:
Log on is achieved by providing either a user name and password
combination or a password file name.
-P password CONTROL-M/EM user password
-PF passwordFile Flat file that contains an unencrypted user name and password on separate
lines in the following format:
user=user_name
password=password
Note: If both -U and -PF are specified, an error message is generated. If
only -U is specified, an online prompt is issued for the password. If neither
is specified, a prompt is issued for the CONTROL-M/EM user name and
password.
-S serverName CONTROL-M/EM GUI server logical name
-Local Deletes all obsolete jobs and tables from the CONTROL-M/EM database
only.
Notes:
You cannot use the -Sync and -Test flags when using -Local.
You can use -Local and -Force to delete obsolete jobs and tables from
modified or locked tables in the CONTROL-M/EM database.
Log sweep_sync.txt is not updated when the utility is activated with
-Local.
If -Local is not used, the sweep utility behaves as it did before version
6.3.01, deleting jobs from both the CONTROL-M/EM and
CONTROL-M/Server databases.
-Date
YYYYMMDD
date
A date in YYYYMMDD format (20050915), which sets the selection criteria
for obsolete jobs. Default: two days before the current date
-Timeout
maxSeconds
Maximum time in seconds to wait for pending callbacks to return with
responses to UPLOAD and remote DELETE requests. Default: 900 seconds
(15 minutes).
-Test This flag causes the sweep utility to scan all job definitions and generate
the sweep_obsolete.txt file, which consists of a report of the current
obsolete jobs and tables, without actually deleting the jobs.
-Sync A flag for synchronizing all non-synchronized tables, listed in the
sweep_sync.txt file, by rerunning the commands that previously failed, in
order to synchronize the CONTROL-M and EM databases.
-Cyclic maxFiles The maximum number of cyclic files for sweep execution log (up to 500
messages each). Default: The execution log is written to one sequential log
file without a timestamp.
-H | -Help Displays the usage
Utility reports
The reports that are generated by the sweep utility are described in Table 25.
Report formats
In the sweep_obsolete.txt file, the report for obsolete jobs has the following format:
In the sweep_obsolete.txt file, the report for obsolete tables has the following format:
-Force This flag causes the sweep utility to scan all tables, including those that are
modified or locked, for obsolete jobs. Use -Force only when you are certain
there are no definitions in CONTROL-M Server database that were not
previously downloaded into the CONTROL-M/EM database.
-Interval
milliseconds
This flag sets the time to wait between executing the DELETE and
UPLOAD commands (in milliseconds).
It may be required to avoid time-out problems in Gateway or
CONTROL-M. By default, there is no interval.
Table 25 sweep utility reports
File Name Location Description
sweep_obsolete.txt $HOME/sweep Report of all jobs and tables that are
candidates for deletion according to the date
criteria.
sweep_sync.txt $HOME/sweep Report of all tables that could not be
uploaded to or deleted from the
CONTROL-M/Server (either because of a
failure or a time-out) and therefore are not
currently synchronized.
sweep_log.txt $HOME/log Execution log (which is cyclic and
configurable).
del et e j ob t abl e_i d j ob_i d ct m_name t abl e_name j ob_name mem_name
del et e t abl e t abl e_i d ct m_name t abl e_name t abl e_l i b
NOTE
The MaxObsoleteJobs system parameter controls the size of the GUI Server memory by
limiting the number of obsolete jobs stored in the GUI Server. The default value is 100000.This
parameter should only be changed after consulting with BMC Software Customer Support.
In the sweep_sync.txt file, the report for non-synchronized tables has the following
format:
Typical work flow
In a typical production situation you use the sweep utility as follows:
1. Activate the sweep utility with the Test parameter to generate the
sweep_obsolete.txt file, which is essentially a report listing the obsolete jobs and
tables.
2. Check the sweep_obsolete.txt file and decide if you want to delete the jobs and
tables displayed in the report.
3. Activate the sweep utility without the Test parameter to delete the obsolete jobs
and tables from the CONTROL-M/EM and CONTROL-M Server databases.
4. Check the sweep_sync.txt file to find failures that occurred while the sweep utility
was attempting to upload or delete tables.
5. Check the sweep_log.txt file to understand the reason for the failures and perform
the necessary corrections.
6. Activate the sweep utility with the Sync parameter to upload or delete the tables
that were not successfully uploaded or deleted in the previous run.
7. Check the sweep_sync.txt file to check that there are no more failures.
Examples of using the sweep utility
Example 1: Prepare a report of obsolete jobs
The following command specifies that the sweep_obsolete.txt file, containing a list of
obsolete jobs, is generated according to the obsolete date of September 15, 2005:
upl oad t abl e t abl e_i d ct m_name t abl e_name t abl e_l i b
NOTE
Only the last versions of the sweep_obsolete.txt and sweep_sync.txt reports are saved.
sweep. exe - U emuser - P empass - S TLVW2K366 - Test - Dat e 20050915
Example 2: Delete obsolete jobs from the database
The following command specifies that any job from two days ago is considered
obsolete and is being deleted from the database:
Return codes
Obsolete criteria
This section describes the criteria used by the sweep utility to determine whether a
job or table is obsolete.
If the ACTIVE_TILL parameter is specified the following elements are considered as
obsolete:
A regular job, which is not part of a group, is considered as obsolete if the
following is true:
ACTIVE_FROM < ACTIVE_TILL and ACTIVE_TILL < obsolete date.
A tag is considered as obsolete if:
ACTIVE_FROM < ACTIVE_TILL and ACTIVE_TILL < obsolete date.
A group is considered as obsolete if:
All of its tags are obsolete (the relationship between the tags is always OR).
A regular table is considered obsolete if:
All the jobs in the table are obsolete.
sweep. exe - U emuser - P empass - S TLVW2K366
Table 26 sweep utility return codes
Return code Description
0 Success (all of the obsolete jobs were deleted, however there may be
commands in the sync file that must be run later). If necessary, run the sweep
utility again.
1 Failure. Run the sweep utility again.
2 Partial success (some obsolete jobs were not deleted). Run the sweep utility
again to delete the remaining jobs or tables.
A job that is part of a group is defined as obsolete if one of the following conditions
is true:
the group is obsolete
it satisfies the obsolete criteria according to it own
ACTIVE_TILL/ACTIVE_FROM and has no tags
it has tags and is considered as obsolete according to the following table:
Examples of obsolete jobs
This following section provides examples of how the sweep utility applies the
obsolete criteria to determine whether various jobs are obsolete.
The following values apply to all examples in this section:
Group G has the following two tags:
Tag A: ACTIVE_FROM Not defined; ACTIVE_TILL September 12, 2005
Tag B: ACTIVE_FROM September 11, 2005; ACTIVE_TILL October 28, 2005
The obsolete day of the user is September 20, 2005.
For the obsolete day of the user, tag A is obsolete and tag B is active, according to the
above table.
Relationship
Job (ACTIVE_TILL/
ACTIVE_FROM)
Tag (ACTIVE_TILL/
ACTIVE_FROM) Result
AND Obsolete Obsolete Delete job
AND Obsolete Active Delete job
AND Active Obsolete Delete job
AND Active Active Job is active
OR Obsolete Obsolete Delete job
OR Obsolete Active Job is active
OR Active Obsolete Job is active
OR Active Active Job is active
AND Not defined Obsolete Delete job
AND Not defined Active Job is active
OR Not defined Obsolete Job is active
OR Not defined Active Job is active
Example 1
Job 1 belongs to group G and has tag A.
ACTIVE_FROM is not defined for Job 1.
ACTIVE_TILL is defined for Job 1 for October 1, 2005.
The relationship between Job 1 and its tags is AND.
Result: Job 1 is obsolete.
Example 2
Job 2 belongs to group G and has tag B.
ACTIVE_FROM and ACTIVE_TILL are not defined.
The relationship between Job 2 and its tags is OR.
Result: Job 2 is active.
Example 3
Job 3 belongs to group G and has tags A, B, and C.
Tag C was deleted from group G, but Job 4 still has it.
ACTIVE_FROM and ACTIVE_TILL are not defined.
The relationship between Job 3 and its tags is AND.
Result: Job 3 is active, while tag C is ignored.
General notes
The following notes may be applicable to the features described in this section:
The sweep utility searches for obsolete jobs and tables on the CONTROL-M/EM
side only. It does this by scanning the CONTROL-M/EM database. Any obsolete
jobs or tables that are found are deleted from both the CONTROL-M/EM and the
CONTROL-M/Server databases. It is therefore recommended that the scheduling
tables are synchronized in the CONTROL-M/EM and CONTROL-M server
databases before activating the sweep utility.
The sweep utility supports only CONTROL-M for z/OS versions 6.1.00 and 6.2.00.
updatedef
To delete obsolete tables or jobs a user requires FULL permissions for the specific
table.
If you want to override any CORBA default parameters for the sweep utility, make
the changes under Sweep in the CORBA configuration file
($HOME/etc/domains/config.xml).
updatedef
The updatedef utility updates (modifies) specified parameter values in the following
definitions in the CONTROL-M/EM database:
Job processing definitions
Scheduling table definitions
Group scheduling table definitions
The selected jobs, scheduling tables, and group scheduling tables are modified
according to specifications in the updatedef arguments file. The updatedef utility
does not create new jobs or scheduling tables.
To invoke the updatedef utility
- or -
is installed.
updatedef [-u user [-p password] | -pf passwordFile] -s guiServerName
- or -
updatedef [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
Parameters of the updatedef utility are described in Table 27.
NOTE
updatedef modifies the characteristics of existing job processing definitions.
duplicatedefjob creates new job processing definitions based on existing job processing
definitions in the from data center and scheduling tables.
Parameters of the updatedef utility
3 Press Enter. The updatedef arguments file is checked and processed. If there are
An optional switch for the updatedef utility is described in Table 28.
Table 27 updatedef parameters
password_
file
Flat file containing an unencrypted username and password on separate lines
in the format:
user=username
password=password
Note: If both -u and -pf are specified, an error message is generated. If only -u
is specified, an online prompt is issued for the password. If neither is specified,
a prompt is issued for the database user name and password.
gui_server_
name
Note: If multiple GUI servers exist, set this parameter to the logical name of the
relevant GUI server.
arg_file_
name
Path and name of the arguments file containing updatedef specifications. For
information about preparing this file, see Appendix A, XML file preparation.
Table 28 updatedef switch
Switch Description
updatedef arguments file
The following rules apply to the updatedef arguments file:
Only one block of criteria can be specified for updating in each arguments file. This
criteria block can update many jobs, scheduling groups, or tables.
Text in the arguments file is case-sensitive.
JOBNAME="Job1").
Multiple values can be specified by using the * wildcard character. For an
explanation of how wildcards function in the XML-based utilities, see Wildcards
on page 210.
Most parameters of the job, scheduling table, or group scheduling table definitions
are optional. However:
If you specify a parameter, its FROM subparameter is mandatory and its TO
subparameter is optional.
When a FROM value is specified without a TO value, the FROM value is used as a
filter criterion.
When a TO value is included, it indicates the new value to which the parameter is
set.
Three sets of parameters can be supplied in an arguments file one each for
scheduling tables, group scheduling tables, and jobs. Each set of parameters is
described in a table below:
Table 29Arguments file parameters for scheduling tables.
Table 30Arguments file parameters for group scheduling tables on page 100
Table 31Arguments file parameters for jobs on page 105
NOTE
Group scheduling table parameters are usually modified using the group scheduling table
criteria described in Table 30. However, you cannot use these criteria to change the name of a
group scheduling table.
The scheduling table name parameter of a job processing definition cannot be modified using
the job definition criteria described in Table 31. However, you can use the updatedef utility to
change the name of a group scheduling table or scheduling table by using the criteria for
scheduling tables (described in Table 29) and specifying a new value for the TABLE_NAME
parameter.
Table 29 Arguments file parameters for scheduling tables (part 1 of 2)
UPDATE These tags indicate the start and end of the UPDATE argument. Only criteria located
between the tags are considered to be part of the argument. Mandatory.
SCHED_TABLE These tags indicate the start and end of the scheduling table specification. Criteria
identifying the scheduling tables to be modified and indicating the types of
modifications to be made are located between these tags. Optional.
TABLE_NAME Name of the scheduling table to which the job belongs. Optional.
Example:
TABLE_NAME FROM=Tbl5NYC TO=Tbl_new
TABLE_DSN [z/OS only] Name of the library that contains the scheduling table. Optional.
ABLE_DSN FROM=Lib1 TO=Lib2
DATACENTER Name of the CONTROL-M installation to which the job belongs. Optional.
Note: A TO parameter cannot be specified for this parameter.
Example:
TABLE_USERDAILY Optional.
Note: This parameter cannot be modified.
Example:
TABLE_USERDAILY FROM="Job3A"
Table 30 Arguments file parameters for group scheduling tables (part 1 of 6)
UPDATE These tags indicate the start and end of the UPDATE argument. Only criteria
located between the tags are considered to be part of the argument. Mandatory.
GROUP_SCHED These tags indicate the start and end of the group scheduling table specification.
Criteria identifying the group scheduling tables to be modified and indicating
the types of modifications to be made are located between these tags. Optional.
TABLE_NAME Name of the group scheduling table.
Notes:
This parameter cannot be modified.
At least one of the following scheduling table parameters must be included in
the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_NAME FROM="Tbl42"
FROM String. Mandatory
Table 29 Arguments file parameters for scheduling tables (part 2 of 2)
DATACENTER Name of the CONTROL-M installation to which the job belongs. Optional.
Notes:
the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_DSN [z/OS only] Name of the library that contains the group scheduling table.
Optional.
Notes:
the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
Example:
TABLE_DSN FROM="CTMNYC"
TABLE_
USERDAILY
Optional.
Note: A TO subparameter cannot be specified for this parameter.
Example:
TABLE_USERDAILY FROM="CTMNYC"
GROUP Name of the group to which the group scheduling table belongs. Used as a
descriptive name for related tables. Optional.
Example:
GROUP FROM="Grp_HR" TO="Grp_ACCT"
USED_BY Optional.
Example:
USED_BY FROM="fff" TO="ffg"
USED_BY_CODE Optional.
Example:
USED_BY_CODE FROM="C***" TO="D***"
MODIFIED Optional.
Example:
MODIFIED FROM="1101" TO="1102"
LAST_UPLOAD Date of the last table upload. String. Optional.
Example:
LAST_UPLOAD FROM="1101" TO="1102"
CHECKSUM Optional.
Example:
CHECKSUM FROM="Y" TO="N"
TABLE_ID Name of the scheduling table to which the job belongs. Optional.
Example:
TABLE_ID FROM="Tbl001" TO="Tbl002"
REAL_TABLEID Optional.
Example:
REAL_TABLEID FROM="43556" TO="43557"
Example:
JOBNAME FROM="Job3"
Example:
APPLICATION Name of the application to which the jobs group belongs. Used as a descriptive
name for related jobs. Optional.
Example:
APPLICATION FROM="App3""
Example:
ADJUST_COND Indicates whether to ignore prerequisite conditions normally set by predecessor
jobs if the relevant predecessor jobs are not scheduled. Optional. Valid values:
1 (Ignore relevant prerequisite conditions.)
Example:
CONFIRM Indicates whether the job must be manually confirmed by the
CONTROL-M/EM user before it runs. Optional.
Example:
0 (Default)
1
0 (Default)
1
PRIORITY Indicates CONTROL-M job priority. Optional. Two-character alphanumeric
from 00 to ZZ.
Example:
PRIORITY FROM="AA" TO="BB"
TIMEFROM Indicates the earliest time for submitting the group scheduling table. Format:
hhmm. Optional.
Example:
TIMETO Indicates the latest time for submitting the group scheduling table. Format:
hhmm. Optional.
Example:
Example:
Example:
Optional.
Example:
Example:
DESCRIPTION FROM="backup jobs from 120399" TO="backup jobs from 021400"
AUTHOR CONTROL-M/EM user who defined the job. String. Optional. Example:
AUTHOR FROM="emuser" TO="emadmin"
Note: The New Day Procedure compares the Author and Owner for each job to
check if the job's user has authorization to submit the job. CONTROL-M/EM
security levels determine who can edit the Author value (any user or
administrators only). For more information, see the Security chapter and the
description of the AuthorSecurity system parameter in the
CREATION_USER Name of the user that created the job. String. Optional.
Example:
CREATION_DATE Date that the group scheduling table was created. String. Format: ddmm.
Optional.
Example:
CREATION_TIME Time the group scheduling table was created. String. Format: hhmm. Optional.
Example:
CHANGE_USERID Name of the user that last modified the group scheduling table. String. Optional.
Example:
CHANGE_USERID FROM="emuser" TO="emadmin"
CHANGE_DATE Date that the group scheduling table was last modified. String. Format: ddmm.
Optional.
Example:
CHANGE_TIME Time that the group scheduling table was last modified. String. Format: hhmm.
Optional.
Example:
Table 31 Arguments file parameters for jobs (part 1 of 14)
UPDATE These tags indicate the start and end of the UPDATE argument. Only criteria
that are located between the tags are considered to be part of the argument.
Mandatory.
JOB These tags indicate the start and end of each job specification. Criteria
identifying the jobs to be modified and indicating the types of modifications to
be made are located between these tags. Optional.
TABLE_NAME Name of the scheduling table to which the job belongs. Mandatory.
Notes:
Example:
TABLE_NAME FROM=Tbl5NYC
TABLE_DSN [z/OS only] Name of the library that contains the scheduling table. Mandatory.
Notes:
Example:
TABLE_DSN FROM=Lib1
DATACENTER Name of the CONTROL-M installation to which the job belongs. Mandatory.
Notes:
Example:
TABLE_
USERDAILY
Optional.
Note: This parameter cannot be modified.
Example:
Example:
JOBNAME FROM="Job3" TO="Job3_COPY"
FROM Mandatory.
TO Optional.
Example:
FROM Mandatory.
TO Optional.
GROUP Name of the group to which the job belongs. Optional.
Example:
GROUP FROM="Grp_HR"
FROM Mandatory.
APPLICATION Name of the application to which the jobs group belongs. Optional.
Example:
APPLICATION FROM="App3" TO="App1"
TO String Optional.
TASKTYPE Type of the job (task) to be performed by CONTROL-M. Optional.
Example:
TASKTYPE FROM="Detached" TO="Dummy"
FROM Mandatory.
Valid values:
Job
Detached
Command
Dummy
External
Job
Started_Task
Note:
In CONTROL-M/EM versions earlier than 6.1.00, the TASKTYPE
format contained:
for z/OS, emergency and cyclic information
for other operating systems, critical and cyclic information
CONTROL-M/EM version 6.2.01 and higher can run jobs with the
old TASKTYPE format. However, BMC Software recommends that,
to specify this type of information when creating new job processing
definitions, you use CRITICAL and CYCLIC parameters.
[for z/OS]
BMC Software recommends that, to specify this type of information
when creating new job processing definitions, you use CRITICAL (a
value of 1 indicates that the job is an Emergency job) and CYCLIC
parameters.
Note: Critical path jobs are indicated by coding an * as the first
character in the Priority parameter. There is no connection between
critical path jobs and the Critical parameter.
[z/OS only] Valid values: Same as z/OS FROM values.
AUTHOR CONTROL-M/EM user who defined the job. This parameter is used by the
CONTROL-M/Server security mechanism. String. Optional.
Note: This argument is used by the CONTROL-M/Server security mechanism
and, under certain circumstances, cannot be modified. For more information, see
the Security chapter and the description of the AuthorSecurity system
parameter in the CONTROL-M/Enterprise Manager Administrator Guide.
Example:
AUTHOR FROM="emuser" TO="em5"
Example:
MEMLIB FROM="Mem1" TO="Mem4"
Example:
CMDLINE FROM="C:\Format" TO="C\:CD Emnt"
NODEID Host name of an agent computer or node group to which the job is submitted.
Optional.
Example:
NODEID FROM="Com3" TO="Acct4"
TO Host name of the agent computer on which the job copy is running
Optional.
Example:
MAXRERUN Maximum number of reruns that can be performed for the job. Optional.
Example:
MAXRERUN FROM="1" TO="3"
TIMEFROM Earliest time for submitting the job. Optional.
Example:
TIMETO Latest time for submitting the job. Optional.
Example:
Example:
PRIORITY Indicates CONTROL-M job priority. Optional.
Example:
PRIORITY FROM="AA" TO="1A"
CRITICAL Indicates whether the job is a critical-path job in CONTROL-M. Optional.
Example:
CRITICAL FROM="0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
CYCLIC Indicates whether the job is cyclic (to be run at regular intervals). Optional.
Example:
CYCLIC FROM="0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
CONFIRM Indicates that the job must be manually confirmed by the CONTROL-M/EM
user before it runs. Optional.
Example:
0 (Default)
1
0 (Default)
1
AUTOARCH Determines whether SYSDATA is to be archived. Optional.
Example:
AUTOARCH FROM=0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
INTERVAL Length of time (in minutes) to wait between reruns of a job or between cyclic
runs of a job. Integer. Optional.
Example:
INTERVAL FROM="3" TO="4"
Example:
OVERLIB FROM="lib3" TO="lib4"
MAXWAIT Number of extra days (after the original scheduling date) that the job is allowed
to remain in the Active Jobs file awaiting execution. Integer. Optional.
Example:
MAXWAIT FROM="4" TO="3"
Example:
DESCRIPTION FROM="data backup from 120399" TO="data backup from 021400"
Example:
Optional.
Example:
Example:
DAYS FROM="ALL" TO="159"
Optional.
Example:
DAYS_AND_OR FROM="AND" TO="OR"
Example:
WEEKDAYS FROM="1,2,4" TO="ALL"
DATE Specific dates on which to order the job. String. mmdd format. Optional.
Example:
DATE FROM="0312" TO="0319"
FROM String. Mandatory. Dates are written in mmdd format. There is no
delimiter between dates. For example, January 10 is written in this
manner: DATE="0110"
TO String. Optional. Dates are written in mmdd format. There is no
delimiter between dates. For example, January 10 is written in this
manner: DATE="0110"
Example:
DAYSCAL FROM="shipping" TO="receiving"
WEEKSCAL Name of a calendar to be used to validate specified weekdays on which to order
the job. String. Optional.
Example:
WEEKSCAL FROM="w5" TO="w6"
CONFCAL Specifies a calendar that is used to validate all specified days and dates on which
to schedule the job. String. Optional.
Example:
scheduling date (odate) has passed. Optional.
Example:
RETRO FROM="0" TO="1"
0 (No. Default)
1 (Yes)
0 (No. Default)
1 (Yes)
SHIFT Describes how to shift the scheduling date of the job. Optional.
Example:
SHIFT FROM="PREVDAY" TO="NEXTDAY"
IGNOREJOB
PREVDAY
NEXTDAY
NOCONFCAL
TO Optional. Valid values: Same values as mandatory FROM.
SHIFTNUM Number of days to shift the scheduling date of the job. Optional.
Example:
SHIFTNUM FROM="-10" TO="5"
MAXDAYS Maximum number of days to retains the SYSDATA archive dataset for jobs that
Example:
MAXDAYS FROM="07" TO="14"
MAXRUNS Maximum number of job runs to retains the SYSDATA archive dataset for jobs
that ended NOTOK. Subparameter of AUTOARCH. String. Optional.
Example:
MAXRUNS FROM="100" TO="250"
RERUNMEM Name of the JCL member to use when the job is automatically rerun. String. 1 - 8
Example:
RERUNMEM FROM="Mem45" TO="Mem7"
RETEN_DAYS [z/OS only] Number of days to retain the job in the History Jobs file. String.
Optional.
Example:
RETEN_DAYS FROM="5" TO="7"
RETEN_GEN [z/OS only] Maximum number of generations of the job to keep in the History
Jobs file. String. Optional.
Example:
RETEN_GEN FROM="3" TO="4"
TASK_CLASS Optional.
Example:
TASK_CLASS FROM="Distribution" TO="Decollation"
PREV_DAY Optional.
Example:
PREV_DAY FROM="N" TO="Y"
Y
N
Y
N
IND_CYCLIC Indicates whether the interval between further runs of a cyclic job is counted
from the start or the end of the previous job run. Optional.
Example:
IND_CYCLIC FROM="Y" TO="N"
START
END
START
END
TAG_
RELATIONSHIP
Relationship (AND|OR) between the specified Schedule Tag criteria and the
jobs own basic scheduling criteria. This parameter is relevant only for jobs in a
group scheduling table. Optional.
Example:
TAG_RELATIONSHIP FROM="AND" TO="OR"
AND
OR
AND
OR
SYSDB Determines whether one or multiple data sets are used to catalogue sysdata.
Optional.
Example:
1 (Single)
1 (Single)
PDSNAME Name of a partitioned dataset (PDS) to be checked for free space. String.
Optional.
Example:
PDSNAME FROM="Lib_3" TO="Lib_5"
MINIMUM Minimum number of free partitioned dataset tracks required by the library
specified for the PDSNAME parameter. Integer. Optional.
Example:
MINIMUM FROM="5" TO="6"
CATEGORY Name of a CONTROL-D report decollating mission category that must be
scheduled under CONTROL-D when the job is scheduled under CONTROL-M.
String. Optional.
Example:
CATEGORY FROM="*" TO="DAILY"
PREVENTNC2 [z/OS only] Performs dataset cleanup before the original job run. Optional.
Example:
PREVENTNC2 FROM="1" TO="0"
0 (Default)
1
0 (Default)
1
JAN, FEB, MAR,
APR, MAY, JUN,
JUL, AUG, SEP,
OCT, NOV, DEC
Months when the job can run. Optional. Not including a month is the same as
including a month with value 0.
Example:
JAN FROM="0" TO="1"
0 (Default)
1
0 (Default)
1
OPTION Job output (sysout) handling options. Optional.
Example:
OPTION FROM="Copy" TO="Release"
Release
Delete
Copy
Move
File
NewDest
ChangeClass
TO Optional. Valid values: Same as mandatory FROM.
PAR Certain OPTION values require that you supply additional information (such
as Release, NewDest). The PAR parameter holds that information as a string.
Optional.
Example:
PAR FROM="mem3log" TO="mem5log"
FROM Limits the sysout handling operation to sysouts from the specified class.
Optional.
Example:
FROM FROM="1" TO="2"
ADJUST_COND 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 group scheduling table. Optional.
Valid values:
Example:
APPL_TYPE Type of external application (for example, SAP or Oracle) on which the external
Example:
APPL_TYPE FROM=SAP TO=OracleApps
APPL_VER Version of the external application (for example, SAP or Oracle) on which the
external application job runs. Mandatory for external application jobs.
Example:
APPL_VER FROM=4.5 TO=4.6
APPL_FORM Predefined set of external application parameters that are displayed in the Job
Editing form. Mandatory for external application jobs.
Example:
APPL_FORM FROM=Default SAP 4.6 TO=Default SAP 4.5
CM_VER Version of external application (for example, SAP or Oracle) Control Module
(CM) that is installed in the CONTROL-M installation. Mandatory for external
application jobs.
Example:
CM_VER FROM=6.1.00 TO=6.1.01
MULTY_AGENT When selected, broadcasts job submission details to all agents in a specified
Node Group. Optional.
Example:
MULTY_AGENT FROM=N TO=Y
Y run as multi-agent job.
N do not run as multi-agent job. Default.
ACTIVE_FROM [OS only] Start of a period of time during which the job or group scheduling
table can be ordered. Optional.
Example:
ACTIVE_FROM FROM=20040315 TO=20040601
ACTIVE_TILL [z/OS only] End of a period of time during which the job or group scheduling
table can be ordered. Optional.
Example:
ACTIVE_TILL FROM=20040315 TO=20040601
TIMEZONE Global time zone used to calculate the interval for time-related conditions.
Optional.
Example:
TIMEZONE FROM=EST TO=GMT
FROM Mandatory. String.
Default: GMT
Example:
JOBS_IN_GROUP FROM="4" TO="10"
CREATION_USER Name of the user that created the job. Optional.
Example:
CREATION_DATE Date that the job was created. Optional.
Example:
CREATION_TIME Time that the job was created. Optional.
Example:
Example 1: Modify GROUP parameter
In the TEST data center, the group name of jobs with GROUP UNIXJobs is changed
to GROUP TandemJobs.
Example 2: Modify Scheduling Table Name parameter
In the TEST data center, for jobs with TABLE_ID 12202, the scheduling table name is
changed from Tbl_1 to Tbl_2.
CHANGE_USERID Name of the user that last modified the job. Optional.
Example:
CHANGE_USERID FROM="emuser" TO="emacct"
CHANGE_DATE Date that the job was last modified. Optional.
Example:
CHANGE_TIME Time that the job was last modified. Optional.
Example:
<UPDATE>
<GROUP_SCHED>
<DATACENTER FROM=" TEST" / >
<GROUP FROM=" UNI XJ obs" TO=" TandemJ obs" / >
</ GROUP_SCHED>
</ UPDATE>
<UPDATE>
<SCHED_TABLE>
<DATACENTER FROM=" TEST" / >
<TABLE_I D FROM=" 12202" / >
<TABLE_NAME FROM=" Tbl _1" TO=" Tbl _2" / >
</ SCHED_TABLE>
</ UPDATE>
Example 3: Modify the Job name of a job
<UPDATE>
<J OB>
<TABLE_NAME FROM=" SGMPM1" / >
<! - - <TABLE_DSN FROM=" " / > - - >
<DATACENTER FROM=" snow" / >
<J OBNAME FROM="cnn*" TO=" bbc*" / >
<! - - <MEMNAME FROM=" J ob2" / >- - >
<! - - <GROUP FROM=" " / > - - >
<! - - <APPLI CATI ON FROM=" " / > - - >
<! - - <TASKTYPE FROM=" " / > - - >
<! - - <AUTHOR FROM=" " / > - - >
<! - - <MEMLI B FROM=" " / > - - >
<! - - <CMDLI NE FROM=" *end" TO=" THE END *" / >- - >
<! - - <NODEI D FROM=" " / > - - >
<! - - <OWNER FROM=" " / > - - >
<! - - <MAXRERUN FROM=" " / > - - >
<! - - <TI MEFROM FROM=" " / > - - >
<! - - <TI METO FROM=" " / > - - >
<! - - <DUE_OUT FROM=" " / > - - >
<! - - <PRI ORI TY FROM=" " / > - - >
<! - - <CRI TI CAL FROM=" " / > - - >
<! - - <CYCLI C FROM=" " / > - - >
<! - - <CONFI RM FROM=" " / > - - >
<! - - <AUTOARCH FROM=" " / > - - >
<! - - - - >
<! - - <OVERLI B FROM=" " / > - - >
<! - - <MAXWAI T FROM=" " / > - - >
<! - - <DESCRI PTI ON FROM=" " / > - - >
<! - - <DOCMEM FROM=" docmem" / > - - >
<! - - <DOCLI B FROM=" docl i b" / >- - >
<! - - <DAYS FROM=" " / > - - >
<! - - <DAYS_AND_OR FROM=" " / > - - >
<! - - <WEEKDAYS FROM=" " / > - - >
<! - - <DATE FROM=" " / > - - >
<! - - <DAYSCAL FROM=" " / > - - >
<! - - <WEEKSCAL FROM=" " / > - - >
<! - - <CONFCAL FROM=" " / > - - >
<! - - <RETRO FROM=" " / > - - >
<! - - <SHI FT FROM=" " / > - - >
<! - - <SHI FTNUM FROM=" " / > - - >
<! - - <MAXDAYS FROM=" " / > - - >
<! - - <MAXRUNS FROM=" " / > - - >
<! - - <RERUNMEM FROM=" " / > - - >
<! - - <RETEN_DAYS FROM=" " / > - - >
<! - - <RETEN_GEN FROM=" " / > - - >
<! - - <TASK_CLASS FROM=" " / > - - >
<! - - <PREV_DAY FROM=" " / > - - >
<! - - - - >
<! - - <TAG_RELATI ONSHI P FROM=" " / > - - >
<! - - <SYSDB FROM=" " / > - - >
<! - - <PDSNAME FROM=" " / > - - >
<! - - <MI NI MUM FROM=" " / > - - >
<! - - <CATEGORY FROM=" " / > - - >
<! - - <PREVENTNCT2 FROM=" " / > - - >
<! - - <J AN FROM=" " / > - - >
<! - - <FEB FROM=" " / > - - >
<! - - <MAR FROM=" " / > - - >
<! - - <APR FROM=" " / > - - >
<! - - <MAY FROM=" " / > - - >
<! - - <J UN FROM=" " / > - - >
<! - - <J UL FROM=" " / > - - >
<! - - <AUG FROM=" " / > - - >
<! - - <SEP FROM=" " / > - - >
<! - - <OCT FROM=" " / > - - >
<! - - <NOV FROM=" " / > - - >
<! - - <DEC FROM=" " / > - - >
<! - - <OPTI ON FROM=" " / > - - >
<! - - <PAR FROM=" " / > - - >
<! - - <FROM FROM=" " / > - - >
<! - - <ADJ UST_COND FROM=" " / > - - >
<! - - <J OBS_I N_GROUP FROM=" " / > - - >
<! - - <LARGE_SI ZE FROM=" " / > - - >
<! - - <CREATI ON_USER FROM=" " / > - - >
<! - - <CREATI ON_DATE FROM=" " / > - - >
<! - - <CREATI ON_TI ME FROM=" " / > - - >
<! - - <CHANGE_USERI D FROM=" " / > - - >
<! - - <CHANGE_DATE FROM=" " / > - - >
<! - - <CHANGE_TI ME FROM=" " / > - - >
<! - - <J OB_RELEASE FROM=" " / > - - >
<! - - <J OB_VERSI ON FROM=" " / > - - >
<! - - <TABLE_USERDAI LY FROM=" " / > - - >
<! - - <SCHEDULI NG_ENVI RONMENT FROM=" " / > - - >
<! - - <SYSTEM_AFFI NI TY FROM=" " / > - - >
<! - - <REQUEST_NJ E_NODE FROM=" " / > - - >
<! - - <APPL_TYPE FROM=" " / > - - >
<! - - <APPL_VER FROM=" " / > - - >
<! - - <APPL_FORM FROM=" " / > - - >
<! - - <CM_VER FROM=" " / > - - >
<! - - <MULTY_AGENT FROM=" " / > - - >
<! - - <ACTI VE_FROM FROM=" " / > - - >
<! - - <ACTI VE_TI LL FROM=" " / > - - >
<! - - <TI MEZONE FROM=" " / > - - >
</ J OB>
</ UPDATE>
Chapt er
4
4 Calendar utilities
The utilities described in this chapter are used to create and modify calendar
definitions.
Many of the tasks performed by the calendar utilities can also be performed using the
Job and Group Editing forms in CONTROL-M/EM and CONTROL-M/Desktop and
the Calendar Manager in CONTROL-M/Desktop. However, by including a utility
command in the command line of a job processing definition, you can run the utility
at a predetermined time or under a predetermined set of conditions without being
present.
defcal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Parameters of the defcal utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
copydefcal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Parameters of the copydefcal utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
exportdefcal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Parameters of the exportdefcal utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
The utilities described in this chapter are listed in Table 32.
Table 32 Calendar utilities
Utility Description
defcal Imports a calendar directly into the CONTROL-M/EM database from a
text file. (See page 122.)
copydefcal Copies calendar definitions within the database. (See page 127.)
exportdefcal Exports calendar definitions to a text file. (See page 130.)
NOTE
The cli utility can upload and download calendars. It is described in Chapter 2, Command
Line Interface utility (cli).
defcal
defcal
The defcal utility imports a calendar definition into the CONTROL-M/EM database.
defcal reads calendar definitions directly from a plain text input file (in XML format)
instead of reading them from the command line.
To invoke the defcal utility
1 Log on as a CONTROL-M/EM user.
2 Open a command prompt window (Microsoft Windows).
defcal [-u user [-p password] | -pf passwordFile] s guiServerName -src srcFileName
- or -
defcal [-u user [-p password] | -pf passwordFile] -s guiServerName -src srcFileName
4 Press Enter.
The defcal input file is checked and processed. If there are any errors in the file, a
message is displayed specifying the lines with the errors.
Parameters of the defcal utility
The parameters of the defcal utility are described in Table 33.
Table 33 defcal parameters (part 1 of 2)
-u user CONTROL-M/EM user name.
-p password The CONTROL-M/EM user password.
-pf passwordFile Flat file containing an unencrypted user name and password on separate
user=username
password=password
is specified, a prompt is issued for the database user name and password.
defcal input file
The calendars that you create for use with the defcal utility are written in XML format
and saved in a text file. When this file is invoked, its contents are passed to the
Instructions for creating an XML format input file are in Appendix A, XML file
preparation. The parameters of the defcal input file (srcFileName) are in Table 34 on
page 123.
The following rules apply to the defcal utility input file:
More than one calendar can be specified in a defcal file.
The XML file is case-sensitive.
The definition for a single calendar can cover a period of one or more years.
-s
guiServerNname
-src srcFileName The path and name of the XML file containing the defcal specifications.
Table 34 defcal input file parameters (part 1 of 2)
The first two lines of the XML request file for this API request contain information that specifies the version
of XML, the text encoding format being used, and the location of the .dtd file.
DEFCAL Indicates to CONTROL-M/EM that the defcal utility is being initiated. Calendar definitions
are placed between the opening and closing DEFCAL tags. One or more calendars can be
specified.
CALENDAR Indicates the opening and closing tags of a single calendar definition. The parameters of the
job are listed between the tags. Example:
CALENDAR DATACENTER="ECS5A" NAME="AcctJob1" TYPE=
"Relative"></CALENDAR
DATACENTER Name of the CONTROL-M installation to which the calendar definition
belongs. String. Mandatory.
NAME Name of the calendar. String Mandatory.
TYPE Calendar type. Mandatory. Valid values:
Regular
Periodic
Relative
Table 33 defcal parameters (part 2 of 2)
YEAR Year-specific definitions in the calendar. Mandatory.
Example:
YEAR NAME="2004" DAYS=
"YYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNYYYYYYYYYYYYYYYYYYYYY"
DESCRIPTION="This is the Accounting Jobs calendar for 2004."
NAME Year for which the calendar definition applies. String. Mandatory.
The year during which the calendar is active. Only one year can be entered
for this attribute, but more than one YEAR parameters can be included in a
calendar definition.
The value of this attribute is expressed as YYYY (for example, 2004).
DAYS Days on which the job is ordered. String. Mandatory.Valid values:
For a Relative calendar:
Y
N
+
-
For a Regular calendar:
Y
N
For a Periodic calendar:
any character other than Y, N, +, or -.
Note: Each Y and N represents a single day of the year. The value of the
DAYS parameter is 365 characters long (366 for a leap year). The first letter of
the DAYS value is January first. The last letter is December 31.
DESCRIPTION Text description of the calendar. String. Optional. For Regular and periodic
calendars, only.
Table 34 defcal input file parameters (part 2 of 2)
Example 1: Import a regular calendar
Regular calendar, named AcctCal3, is imported into the ECS5NY data center.
<DEFCAL>
<CALENDAR
DATACENTER=" ECS5NY"
NAME=" Acct Cal 3"
TYPE=" Regul ar " >
<YEAR
NAME=" 2004"
DAYS=" YYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNYYYYYYYY
YYYYNNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNY
YYYYYYYYYYYYYYYYYYYY"
DESCRI PTI ON=" Cal endar f or 2004. " / >
</ CALENDAR>
</ DEFCAL>
Example 2: Import two calendars into different data centers
Two calendars are imported, each into a different data center, with a single defcal
input file.
<DEFCAL>
<CALENDAR
DATACENTER=" ECS5NY"
NAME=" Acct Cal 3"
TYPE=" Regul ar " >
<YEAR
NAME=" 2004"
DAYS=" YYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNYYYYYYYY
YYYYYYYYYYYYYYYYYYYY"
<CALENDAR
DATACENTER=" ECS2LA"
NAME=" HRCal 3"
TYPE=" Regul ar " >
<YEAR
NAME=" 2004"
DAYS=" YYYYYYYYYYYYYYYYNNNYYYYYYYYYYYYYYYYYYY
YYYYYYYYYYYYNNNNNYYYYYYYYYYYYYYYYNNNYYYYYYYY
YYYYYYYYYYYYYYYYYNNN"
</ CALENDAR>
</ DEFCAL>
copydefcal
copydefcal
The copydefcal utility creates a new calendar definition in the CONTROL-M/EM
database identical to an existing calendar definition. Calendars can be copied and
saved under different names in the same data center. Calendars in one data center can
be copied to a different data center and saved under the same or different names.
Multiple calendars can be selected and copied using the * wildcard character. For an
explanation of how wildcards function in XML-based utilities, see Wildcards on
page 210.
When copydefcal is invoked, a file of arguments that you created is processed. This
arguments file contains statements that specify an existing calendar or group of
calendars. The specified calendars are exported to an output file. copydefcal reads
arguments directly from a plain text arguments file (in XML format) instead of
reading them from the command line.
To invoke the copydefcal utility
2 Open a command prompt window (Windows users, only). You do not need to be
in the CONTROL-M/EM directory.
copydefcal [-u user [-p password] | -pf passwordFile]
-s guiServerName -arg argFileName
- or -
copydefcal [-USERNAME user [-PASSWORD password] |
-PASSWORD_FILE passwordFile] -HOST guiServerName -ARG_FILE argFileName
4 Press Enter. The copydefcal arguments file is checked and processed. If there are
Parameters of the copydefcal utility
Table 35 copydefcal parameters (part 1 of 2)
copydefcal arguments file
Arguments are used as selection criteria to determine which calendars are exported.
Arguments are written to the copydefcal argument file. The arguments files created
for use with the copydefcal utility are written in XML format and saved in a text file.
The format in which this file must be written is described on the following pages.
When this file is invoked, calendar definitions are exported from the
The following rules apply to the copydefcal arguments file:
More than one calendar can be specified in an arguments file.
Only one COPYCAL parameter can be used in an arguments file.
-pf
password
File
Flat file containing an unencrypted username and password on separate lines in
the format:
user=username
password=password
Note: If both -u and -pf are specified, an error message is generated. If only -u is
specified, an online prompt is issued for the password. If neither is specified, a
prompt is issued for the database user name and password.
-s guiServer
Name
Note: If multiple GUI servers exist, set this parameter to the logical name of the
relevant GUI server.
-arg argFile
Name
Path and name of the arguments file containing the copydefcal specifications.
Instructions for preparing this file are in Appendix A, XML file preparation.
Table 35 copydefcal parameters (part 2 of 2)
Using FROM and TO in the copydefcal input file:
If you choose to specify a parameter, the FROM subparameter is mandatory, and
the TO subparameter is optional.
When a FROM value is specified without a TO value, it is used as a filter criterion.
When a TO value is included, it indicates the new value with which the parameter
is updated.
If any FROM value contains *, and the corresponding TO value contains *, the * in
the TO value expresses the same information as the * in the FROM value.
The TO attribute of the DATACENTER parameter must be used to import the
copied calendar into a different data center if the copy has the same name as the
original calendar (the TO attribute is not used with the CALENDAR parameter).
Otherwise, the calendar copy overwrites the original in the same data center.
Following are sample input files used with the copydefcal utility:
Example 1: Create and import a calendar
Creates a copy of the calendar named CAL_3 in the ECS10LA data center.
Table 36 copydefcal arguments file parameters
COPYCAL These tags indicate the start and end of the COPYCAL argument. Only criteria that
are located between the tags are considered to be part of the argument.
DATACENTER CONTROL-M installation to which the calendar definition belongs.
Note: The COPYCAL element must contain only one DATACENTER parameter.
String.
Example:
DATACENTER FROM=ECS5NYC TO=ECS7NYC
FROM.Data center in which the source calendar is located. String. Mandatory.
TO. Data center in which a calendar can be created. String. Optional.
CALENDAR Name of the calendar.
Note: The COPYCAL element must contain only one CALENDAR parameter.
Example:
CALENDAR FROM=Cal1 TO=Cal1_COPY
FROM. Name of the calendar from which a copy is made. String. Mandatory.
TO. Name of the calendar copy. The copy retains the name of the original calendar
if this attribute is not used. String. Optional.
<COPYCAL>
<DATACENTER FROM=" ECS5NYC" TO=" ECS10LA" / >
exportdefcal
Example 2: Copy multiple calendars from the same data center
All calendars in the ECS5NYC data center with names beginning with the letter A are
copied to the ECS7NYC data center. The new calendar names are calendarname_COPY
(for example, the copy of the Alljobs calendar is named Alljobs_COPY).
Example 3: Copy a calendar and rename the copy
The calendar named CAL_NOV in the ECS5NYC data center is copied. The name of
the copy is CAL_NOV_REVISED.
exportdefcal
The exportdefcal utility exports calendar definitions in the CONTROL-M/EM database
to an output file for use as input to other utilities.
When the exportdefcal utility is invoked, an arguments file that you prepare is
processed. This arguments file contains statements that specify an existing calendar
or group of calendars. The calendars that you specified in the arguments file are
exported to an output file. You can modify the exported calendars in the output file
and re-import them into the CONTROL-M/EM database using the defcal utility.
exportdefcal reads arguments directly from a plain text arguments file (in XML
format) instead of reading them from the command line.
<CALENDAR FROM=" CAL_3" / >
</ COPYCAL>
<COPYCAL>
<DATACENTER FROM=" ECS5NYC" TO=" ECS7NYC" / >
<CALENDAR FROM=" A*" TO=" A*_COPY" / >
</ COPYCAL>
<COPYCAL>
<DATACENTER FROM=" ECS5NYC" / >
<CALENDAR FROM=" CAL_NOV" TO=" CAL_NOV_REVI SED" / >
</ COPYCAL>
NOTE
Output files from export utilities (such as exportdefcal) can be used as input files with the
import utilities (such as defcal).
Parameters of the exportdefcal utility
To invoke the exportdefcal utility
1 Log on as an CONTROL-M/EM user.
2 Open a command prompt window (Windows users, only). You do not need to be
in the CONTROL-M/EM directory.
exportdefcal [-u user [-p password] | -pf passwordFile] -s guiServerName
-arg argFileName
- or -
exportdefcal [-USERNAME user [-PASSWORD password] |
-PASSWORD_FILE passwordFile] -HOST guiServerName -ARG_FILE argFileName
Parameters of the exportdefcal utility are described in Table 37 on page 131.
4 Press Enter.
The exportdefcal arguments file is checked and processed. If there are any errors in
the file, a message is displayed specifying the lines with the errors.
The exported calendar definitions are saved to an output file, the name and
location of which you specified in the out_file_name parameter.
The parameters of the exportdefcal utility are described in Table 37 on page 131.
Table 37 exportdefcal parameters
-pf
passwordFile
Flat file containing an unencrypted username and password on separate
user=username
password=password
-s guiServer
Name
exportdefcal arguments file
Arguments are used as a selection criteria to determine which calendars to export.
Arguments are written to the exportdefcal argument file. The arguments files that
you create with the exportdefcal utility are written in XML format and saved in a text
file. The format in which this file must be written is described on the following pages.
When this file is invoked, calendar definitions are exported from the
CONTROL-M/EM database. For instructions for creating arguments files, see
Appendix A, XML file preparation.
The following rules apply to the exportdefcal arguments file:
More than one calendar can be specified in an exportdefcal file.
The relationship between PARAM parameters in a TERM statement is AND. The
relationship between TERM statements is OR.
-arg
argFileName
Path and name of the arguments file containing exportdefcal specifications.
Instructions for making this file are in Appendix A, XML file preparation.
out_file_name Path and name of the file containing the specification of the exported job.
Table 38 exportdefcal arguments file parameters (part 1 of 2)
The first two lines of the XML request file for this API request contain information that specifies the version of
XML, the text encoding format being used, and the location of the .dtd file.
TERM The TERM tags indicate the start and the end of a group of selection criteria used to
specify a calendar or calendars that are to be exported. Only PARAM tags that are
located between the TERM tags are considered to be part of the TERM argument.
REL Optional. Relationship between terms. Valid values:
AND
OR
Table 37 exportdefcal parameters
Following are sample arguments files used with the exportdefcal utility:
Example: Export all calendars in the data center named Cal1
The output file contains all calendars in data center Data1 that are named Cal1.
PARAM The selection criteria parameter used to determine those calendars that are to be
exported. More than one PARAM can be specified. Mandatory.
Example:
NAME String. Mandatory. The parameter name of any calendar parameter.
Valid values:
DATACENTER
CALENDAR
OP String. Mandatory. Describes the relationship between the NAME and
the VALUE parameters of the TERM. Valid values:
EQ
NEQ
NOTIN
LIKE
VALUE String. Mandatory. Value of the parameter specified in the NAME
field.
If the value of NAME is DATACENTER, enter the name of the
CONTROL-M installation for VALUE.
If the value of NAME is CALENDAR, enter a calendar name.
<TERMS>
<TERM>
VALUE=" Dat a1" / >
<PARAM NAME=" CALENDAR" OP=" EQ" VALUE=" CAL1" / >
</ TERM>
</ TERMS>
Table 38 exportdefcal arguments file parameters (part 2 of 2)
Chapt er
5
5 Scheduling table utilities
The utilities described in this chapter are used to create and modify scheduling table
and group scheduling table definitions.
You can use the Scheduling Table Manager and Group Editing form in
CONTROL-M/Desktop and CONTROL-M/Enterprise Manager (CONTROL-M/EM)
and the CONTROL-M ctmdefine and ctmcreate utilities for the same tasks. However,
if you perform these tasks by including a utility command in the command line of a
job processing definition, you can run the utility at a predetermined time or under a
predetermined set of conditions without being present. The utilities described in this
chapter are listed in Table 39.
deftable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Parameters of the deftable utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
exportdeftable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Parameters of the exportdeftable utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Two other utilities, described in other chapters in this book, are used with scheduling
tables and group scheduling tables:
The updatedef utility enables you to update (modify) specific parameter values in
the following definitions:
scheduling table definitions
group scheduling tables
one or more job processing definitions in the CONTROL-M/EM database.
updatedef is described in updatedef on page 97.
Table 39 Table utilities
Utility Description
deftable Imports scheduling table and group scheduling table definitions from a
user-defined file. (See page 136.)
exportdeftable Exports scheduling table and group scheduling table definitions to a text
file. (See page 149.)
deftable
The cli utility uploads, downloads, orders, and forces scheduling tables and group
scheduling tables. It is described in Chapter 2, Command Line Interface utility
(cli).
deftable
The deftable utility imports scheduling tables and group scheduling tables into the
When deftable is invoked, a file of arguments that you have created is processed. This
input file contains statements that specify:
an existing scheduling table or set of scheduling tables
an existing group scheduling table or set of group scheduling tables.
The specified tables are imported into the CONTROL-M/EM database.
If the tables do not exist in the CONTROL-M/EM database, the utility creates them. If
the tables do exist, a message is issued indicating that the tables already exist (unless
the /o switch is specified, in which case the tables are overwritten the /o switch is
described below).
deftable reads scheduling table and group scheduling table definitions directly from a
plain text arguments file (in XML format) instead of reading them from the command
line.
A single deftable input file can contain specifications for both scheduling tables and
group scheduling tables.
To invoke the deftable utility
2 Open a command prompt window (Windows users). You do not need to be in the
CONTROL-M/EM directory.
- or -
def t abl e [ - u us e r [ - p p a s s wo r d ] | - pf p a s s wo r d Fi l e ]
- s g ui S e r v e r Na me - sr c s r c Fi l e Na me [/a] [/o]
def t abl e [ - USERNAME us e r [ - PASSWORD p a s s wo r d ] | - PASSWORD_FI LE
p a s s wo r d Fi l e ] - HOST g ui S e r v e r Na me - SRC_FI LE s r c Fi l e Na me [/a] [/o]
Parameters of the deftable utility
Parameters of the deftable command are described in Table 40 on page 137.
4 Press Enter. The deftable input file is checked and processed. If there are any errors
in the file, a message is displayed specifying the lines with the errors.
Optional switches for the deftable utility are described in Table 41.
Table 40 deftable parameters
passwordFile Flat file containing an unencrypted user name and password on separate
user=username
password=password
srcFileName Path and name of the file containing the specifications for the table that you
are importing. Instructions for preparing this file are in Appendix A, XML
file preparation.
Table 41 deftable switches
Switch Description
/a Accept all. The /a switch directs the utility to automatically reset the Author
parameter to the current CONTROL-M/EM user when these two values do not
match. If not specified, the utility skips (that is, does not process) job definitions
whose Author does not match the currently logged in user.
/o Overwrite. The /o switch directs the utility to overwrite any existing tables.
deftable input file
The srcFileName input file contains the definition of a scheduling table. The file is
written in XML format and saved in a text file. The format in which this file must be
written is described on the following pages.
When this file is invoked, either scheduling table definitions are imported to the
CONTROL-M/EM database, or group scheduling table definitions are imported, or
both scheduling table definitions and group scheduling table definitions are
imported the CONTROL-M/EM database. For instructions for creating input files,
see Appendix A, XML file preparation.
The following rules apply to the deftable input file:
Only one group scheduling table can be included in a scheduling table. However,
multiple scheduling tables can be included in a single input file. Each of these
scheduling tables can contain one group scheduling table.
Multiple group scheduling tables can be included in a file that does not contain
any scheduling tables.
More than one job can be specified in either type of table.
Table 42 deftable input file parameters for scheduling tables (part 1 of 2)
DEFTABLE Indicates to CONTROL-M/EM the beginning and end of the deftable utility.
Scheduling table definitions are placed between the opening and closing
DEFTABLE tags. One or more jobs can be specified. Each individual job is
enclosed by the TABLE</TABLE tags
SCHED_TABLE Indicate the opening and closing tags of a single scheduling table definition. The
parameters of the table are listed between the tags. In the case of the scheduling
table, the table parameters consist of parameters that describe the table directly
and a list of the jobs that are included in the table. In turn, each of the jobs that is
listed includes all of its own descriptive parameters.
TABLE_NAME Name of the scheduling table to which the job belongs. String. Mandatory.
Note: At least one of the following scheduling table parameters must be
included in the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
TABLE_DSN Name of the library that contains the scheduling table. [For z/OS jobs, only.]
String. Optional.
DATACENTER
TABLE_NAME
TABLE_DSN
s
DATACENTER Name of the CONTROL-M installation to which the scheduling table belongs.
String. Mandatory.
DATACENTER
TABLE_NAME
TABLE_DSN
TABLE_USERDAILY For internal use. Do not include this parameter in your deftable input file.
USED_BY For internal use. Do not include this parameter in your deftable input file.
USED_BY_CODE For internal use. Do not include this parameter in your deftable input file.
MODIFIED For internal use. Do not include this parameter in your deftable input file.
CHECKSUM For internal use. Do not include this parameter in your deftable input file.
TABLE_ID For internal use. Do not include this parameter in your deftable input file.
REAL_TABLEID For internal use. Do not include this parameter in your deftable input file.
JOB Opening and closing tags of a single job definition. Parameters of the job are
listed between the tags. For a complete listing of defjob parameters, see defjob
on page 30.
Table 43 deftable input file parameters for group scheduling tables (part 1 of 8)
The first two lines of the XML request file for this API request contain information that specifies the version of
XML, the text encoding format being used, and the location of the .dtd file.
DEFTABLE Indicates the beginning and end of the deftable utility. Scheduling table definitions
are placed between the opening and closing DEFTABLE tags. One or more jobs can
be specified. Each individual job is enclosed by the TABLE</TABLE tags
SCHED_GROUP Opening and closing tags of a group scheduling table definition.
TABLE_NAME Name of the group scheduling table to which the job belongs. String. Mandatory.
the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
GROUP Name of the group to which the jobs in the group scheduling table are assigned.
String. Mandatory.
DATACENTER Name of the CONTROL-M installation to which the group scheduling table belongs.
String. Mandatory.
the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
Table 42 deftable input file parameters for scheduling tables (part 2 of 2)
TABLE_DSN Library for the table. String. Optional.
the input file:
DATACENTER
TABLE_NAME
TABLE_DSN
TABLE_USERDAILY String. Optional.
USED_BY For internal use. Do not include this parameter in your deftable input file.
USED_BY_CODE For internal use. Do not include this parameter in your deftable input file.
MODIFIED For internal use. Do not include this parameter in your deftable input file.
CHECKSUM For internal use. Do not include this parameter in your deftable input file.
TABLE_ID For internal use. Do not include this parameter in your deftable input file.
REAL_TABLEID For internal use. Do not include this parameter in your deftable input file.
JOBNAME Name of the job processing definition.String. Optional.
MEMNAME Name of the file that contains the job script. String. Optional.
APPLICATION Name of the application to which the group scheduling table belongs. Used as a
descriptive name for related groups of group scheduling tables. String. Mandatory.
OWNER Owner (user ID) associated with the group scheduling table. This parameter is used
by the CONTROL-M/Server security mechanism. String. Optional.
ADJUST_COND 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 group scheduling table. String. Optional.
CONFIRM Indicates that the group scheduling table must be manually confirmed by the
CONTROL-M/EM user before it runs. Valid values:
0 (No confirmation. Default.)
1 (Requires confirmation.)
PRIORITY Indicates CONTROL-M group scheduling table priority. String. Optional.
TIMEFROM Indicates the earliest time for submitting the group scheduling table. String.
Optional.
TIMETO Indicates the latest time for submitting the group scheduling table. String. Optional.
DUE_OUT Time that the jobs in the group scheduling table are expected to finish. String.
Optional.
DOCMEM Name of the file containing group scheduling table documentation. String. Optional.
DOCLIB Name of the DOCMEM library. String. Optional.
DESCRIPTION Brief text description of the group scheduling table. String. Optional.
AUTHOR CONTROL-M/EM user who defined the group scheduling table. String. Mandatory.
Note: This argument is used by the CONTROL-M security mechanism and, under
certain circumstances, cannot be modified. For more information, see the Security
chapter and the description of the AuthorSecurity system parameter in the
CREATION_USER Name of the user who created the group scheduling table. String. Optional.
CREATION_DATE Date on which the group scheduling table was created. String. Optional.
CREATION_TIME Time at which the group scheduling table was created. String. Optional.
CHANGE_USERID Name of the user who last modified the group scheduling table. String. Optional.
CHANGE_DATE Date on which the group scheduling table was last modified. String. Optional.
CHANGE_TIME Time at which the group scheduling table was last modified. String. Optional.
MULTY_AGENT If set to Y, job submission details are broadcasted to all agents within an Application
Group. The agent with available resources runs the jobs in the group scheduling
table. Optional. Valid values:
Y - run as a multi-agent job
N - do not run as a multi-agent job. Default.
ACTIVE_FROM Indicates the start of a period of time during which the job or group scheduling table
can be ordered. [For z/OS jobs and group scheduling tables, only.] Optional. Date
Format: YYYYMMDD
ACTIVE_TILL Indicates the end of a period of time during which the job or group scheduling table
can be ordered. [For z/OS jobs and group scheduling tables, only.] Optional. Date
Format: YYYYMMDD
TAGs Collection of scheduling criteria organized unit with a unique name. Mandatory.
Example:
TAG TAG_NAME="tag1" DAYS="1,8,15,23" DAYS_AND_OR="AND"
WEEKDAYS="wcal_3" DATE="18" DAYSCAL="" CONFCAL="cal_4" RETRO="1"
SHIFT="PREVDAY" SHIFTNUM="5" MAXWAIT="5" MAXRUNS="2" JAN="1"
TAG_NAME Unique name of the tag. String. Mandatory.
DAYS Days of the month on which to order the jobs in the group
scheduling table. String. Optional.
DAYS_AND_OR Indicates the relationship between specified Days values and
Weekdays values. Optional. Valid values:
AND
OR
WEEKDAYS Days of the week on which to order the jobs in the group
scheduling table. String. Optional.
DATE Specific dates on which to order the jobs in the group scheduling
table. String. mmdd format. String. Optional.
DAYSCAL Name of a user-defined calendar used to specify a set of days.
String. Optional.
CONFCAL Specifies a calendar that is used to validate all specified days
and dates on which to schedule the jobs in the group scheduling
table. String. Optional.
RETRO Indicates whether the jobs in the group scheduling table is
scheduled for possible execution after their original scheduling
date (odate) has passed. Optional. Valid values:
0 (No. Default)
1 (Yes)
SHIFT Describes how to shift the scheduling date of the jobs in the
group scheduling table. Optional. Valid values:
IGNOREJOB
PREVDAY
NEXTDAY
NOCONFCAL
SHIFTNUM Number of days to shift the scheduling date of the jobs in the
group scheduling table. String. Optional.
TAG continued MAXWAIT Number of extra days (beyond the original scheduling date) that
the jobs in the group scheduling table are allowed to remain in
the Active Jobs file awaiting execution. Integer. Optional.
MAXRUNS Maximum number of job runs to retain the SYSDATA archive
data set for jobs that ended NOTOK. Subparameter of
AUTOARCH. String. Valid values: 000 998, or 999 to retain the
archived data for all runs. Optional.
JAN, FEB, MAR,
APR, MAY, JUN,
JUL, AUG, SEP,
OCT, NOV, DEC
Months when the jobs in the group scheduling table can run.
Optional. Valid values:
0 (Default)
1
TAG_NAMES Wrapper for specifying one or more scheduling tags for the group scheduling table.
Example:
TAG_NAMES TAG_NAME="TAG_1"
TAG_NAME String. Optional.
INCOND In condition. Optional.
Example:
INCOND NAME="Cond1" ODATE="ODAT" AND_OR="AND" OP="("
NAME Name of the In condition. String. Mandatory. 1 - 255 characters,
case-sensitive.
ODATE Order date of the In condition. String. Mandatory.
Default: ODAT
AND_OR Relationship between conditions. Valid values:
AND (default)
OR
OP Parentheses indicating parts of the condition that are interpreted
first. String. Optional.
OUTCOND Out condition. Optional.
Example:
OUTCOND NAME="Job1" ODATE="ODAT" SIGN="ADD"
NAME Name of the Out condition. String. Mandatory.
ODATE Order date of the Out condition. String. Mandatory.
Default: ODAT
SIGN Indicates whether to add or delete the condition. Valid values:
ADD (default)
DEL
AUTOEDIT Wrapper for the AutoEdit expression. Optional.
Example:
AUTOEDIT EXP="%%PARM1=%%TIME"
EXP AutoEdit expression. String. Mandatory.
Example:
%%PARM1=%%TIME
SHOUT Wrapper for the Shout message. Optional.
Example:
SHOUT WHEN="EXECTIME" DEST="workstation1" URGENCY="R"
MESSAGE="Job completed OK." TIME=">10"
WHEN Condition under which the Shout message is sent. Mandatory.
Valid values:
OK (default)
NOTOK
RERUN
LATESUB
LATETIME
EXECTIME
DEST Recipient of the shout message. String. Mandatory.
URGENCY Indicates the urgency of the Shout message. Mandatory.
Valid values:
R (regular-default)
U (urgent)
V (very urgent)
Valid values: 1 - 70 characters, spaces allowed.
TIME Time of the message. String. Mandatory.
ON_GROUP Table-processing termination status, for a group scheduling table, that determines
whether the accompanying DO statements are performed.
Example:
ON_GROUP CODE="OK"
CODE Indicates whether the DO statements are performed when the
group scheduling table ends OK or NOTOK. Mandatory.
Valid values:
OK
NOTOK
DO_GROUP Actions to perform when the ON_GROUP condition is fulfilled.
Example:
DO_GROUP ACTION="OK"
ACTION Mandatory. Valid values:
OK
NOTOK
DOAUTOEDIT Wrapper for the AutoEdit expression. Optional.
Example:
DOAUTOEDIT EXP="%%PARM1=%%TIME"
EXP The AutoEdit expression. String. Mandatory.
For example, %%PARM1=%%TIME
DOSHOUT Shout message wrapper. Optional.
Example:
DOSHOUT DEST="Wkstn2" URGENCY="R" MESSAGE="Job5 completed OK"
DEST Recipient of the Shout message.
String. Mandatory.
Valid values: 1-16 characters, case-sensitive.
URGENCY Urgency of the Shout message. Valid values:
R (regular-default)
U (urgent)
V (very urgent)
MESSAGE Text of the Shout message. String. Mandatory.
Valid values: 1 - 70 characters, spaces allowed.
DOFORCEJOB Forces a specified job when the current group scheduling table is complete.
Optional.
Example:
DOFORCEJOB DSN="45446" TABLE_NAME="Table2" NAME="Job4" ODATE=
"ODAT"
DSN Library for the scheduling table [z/OS only]. String. Mandatory.
TABLE_NAME Name of the scheduling table to which the job belongs. String.
Mandatory. Valid values: 1 - 10 characters.
NAME Name of the job. String. Mandatory.
ODATE Original scheduling date for the job. String. Default: ODAT
DOCOND Specifies prerequisite conditions to be added or deleted. Optional.
Example:
DOCOND NAME="Cond1" ODATE="ODAT" SIGN="ADD"
NAME Condition name. String. Mandatory.
ODATE Condition date. String. Mandatory. Default: ODAT
SIGN Specifies whether to add or delete the condition. Valid values:
ADD (default)
DEL
DOMAIL Sends mail when the group scheduling table run is complete. Optional.
Example:
DOMAIL URGENCY="R" DEST="ecsuser@ecsuser.com" CC_DEST=
"david@emuser.com" SUBJECT="OK" MESSAGE="Task completed OK."
URGENCY Urgency of the message. Valid values:
R (regular - Default)
U (Urgent)
DEST Recipient of the message. String. Mandatory.
CC_DEST Additional recipient of the message. String. Optional.
SUBJECT Brief text description of the message contents. String. Optional.
JOB Indicate the opening and closing tags of a single job definition. The parameters of the
job are listed between the tags. For a complete listing of defjob parameters, see
defjob on page 30.
Sample input files used with the deftable utility.
Example 1: Scheduling table with two jobs
<DEFTABLE>
<SCHED_TABLE
TABLE_NAME=" 2: 35"
TABLE_DSN=" KDSN"
DATACENTER=" phant om" >
<J OB
J OBNAME=" KURT999"
MEMNAME=" kur t _m"
GROUP=" KGROUP"
APPLI CATI ON=" KAPP"
AUTHOR=CTMEMUSER
TASKTYPE=" Command"
MAXRERUN=" 1"
I NTERVAL=" 1"
PRI ORI TY=" 1"
CRI TI CAL=" 1"
CYCLI C=" 1"
CONFI RM=" 1"
DAYS=" 1, 2, 3"
DAYSCAL=" " >
<SHOUT WHEN=" OK" DEST=" NOWHERE" MESSAGE=" J ob i s
OK" TI ME=" 1045"/ >
</ J OB>
<J OB
J OBNAME=" KURT901"
MEMNAME=" kur t m"
GROUP=" KGROUP"
APPLI CATI ON=" KAPP"
TASKTYPE=" Command"
MAXRERUN=" 1"
I NTERVAL=" 1"
PRI ORI TY=" 1"
CRI TI CAL=" 1"
CYCLI C=" 1"
CONFI RM=" 1"
DAYS=" 1, 2, 3"
DAYSCAL=" 123" >
<SHOUT WHEN=" OK" DEST=" NOWHERE" MESSAGE=" J ob i s
OK"
TI ME=" 1045" / >
</ J OB>
</ SCHED_TABLE>
</ DEFTABLE>
Example 2: Group scheduling table with one job
<SCHED_GROUP
DATACENTER=" MI G4"
TABLE_NAME=" TABLE1"
TABLE_DSN=" TABLELI B"
GROUP=" GRP"
J OBNAME=" TABLE1"
APPLI CATI ON=" APPL"
MEMNAME=" MEMNAME"
OWNER=" J ACKH"
AUTHOR=CTMEMUSER
ADJ UST_COND=" 1"
CONFI RM=" 1"
PRI ORI TY=" AB"
TI MEFROM=" 0900"
TI METO=" 1100"
DUE_OUT=" 0500"
DOCMEM=" DOC"
DOCLI B=" A. B. C"
DESCRI PTI ON=" desc" >
<TAG
TAG_NAME=" TEST"
DAYS=" ALL"
DAYS_AND_OR=" OR"
WEEKDAYS=" 1, 2"
RETRO=" 1"
SHI FT=" NEXTDAY"
SHI FTNUM=" +24"
DAYSCAL=" EYALDCAL"
WEEKSCAL=" EYALWCAL"
CONFCAL=" EYALCCAL"
MAXWAI T=" 10"
J AN=" 1" / >
<TAG
TAG_NAME=" TEST2"
DAYS=" 1, 2, 3, 4"
DAYS_AND_OR=" AND"
WEEKDAYS=" 1, 2"
RETRO=" 0"
SHI FT=" PREVDAY"
SHI FTNUM=" +24"
MAXWAI T=" 10"
FEB=" 1" / >




<OUTCOND NAME="OUT1" ODATE=" STAT" SI GN=" DEL" / >
exportdeftable
exportdeftable
The exportdeftable utility exports scheduling tables from the CONTROL-M/EM
database to a file.
When the exportdeftable utility is invoked, a file of arguments that you have created
is processed. This arguments file contains statements that specify an existing
scheduling table or group of scheduling tables. The specified tables are exported to an
output file.
Output files created with the exportdeftable utility can be used as import files with
the deftable utility.
For example, you can export job processing definitions to an output file using
exportdeftable, make modifications to the definitions and save the file, and use the
same file as the input file when running deftable to import the modified table
definitions into CONTROL-M/EM database.
To invoke the exportdeftable utility
2 Open a command prompt window (Microsoft Windows). You do not need to be in
the CONTROL-M/EM directory.
<OUTCOND NAME="OUT1" ODATE=" STAT" / >
<AUTOEDI T EXP="DUMMY=ggg" / >
<ON_GROUP CODE=" NOTOK" >
<DOSHOUT DEST=" Shout Dest " URGENCY=" U" MESSAGE=" msg" / >
<DO_GROUP ACTI ON=" OK" / >
<DO_GROUP ACTI ON=" NOTOK" / >
<DOFORCEJ OB TABLE_NAME=" A. B. C" NAME=" MEMNAME" ODATE=" 1011" / >
<DOCONDNAME=" condname" ODATE=" 0506" / >
<DOMAI L DEST=" eyal @bmc. com" MESSAGE=" hel l o" / >
<DOAUTOEDI T EXP=" A=B" / >
</ ON_GROUP>
<SHOUT WHEN=" OK" DEST=" Dest Test " URGENCY=" R" MESSAGE=" Message t est " TI ME=" 1000" / >
<J OB J OBNAME=" J OB_GRP" MEMNAME=" J ACK"
MEMLI B=" J ACKI B" OWNER=" J ACKH" APPLI CATI ON=" J ACKAPP" TASKTYPE=" J ob" MAXRERUN=" 0"
I NTERVAL=" 1" PRI ORI TY=" 1" CRI TI CAL=" 1" CYCLI C=" 1" CONFI RM=" 1" DAYS=" 1, 2, 3" DAYSCAL=
" 12_7" AUTHOR="J ACKH" >
<TAG_NAMES TAG_NAME=" TEST" / >
<OUTCOND NAME="COND1" ODATE=" STAT" / >
<OUTCOND NAME="COND2" ODATE=" STAT" / >
</ J OB>
</ SCHED_GROUP>
</ DEFTABLE>
Parameters of the exportdeftable utility
exportdeftable [-u user [-p password] | -pf passwordFile] -s guiServerName -arg
argFileName -out outFileName
- or -
exportdeftable [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
passwordFile] -HOST guiServerName -ARG_FILE argFileName -OUT outFileName
Parameters of the exportdeftable command are described in Table 44 on page 150.
4 Press Enter. The exportdeftable arguments file is checked and processed. If there
are any errors in the file, a message is displayed specifying the lines with errors.
The exported table definitions are saved to an output file, the name and location of
which is specified in the o ut Fi l e Na me parameter.
Table 44 exportdeftable parameters
-pf
passwordFile
Flat file containing an unencrypted username and password on separate
user=username
password=password
guiServer
Name
argFileName Path and name of the arguments file containing the exportdeftable
specifications. Instructions for preparing this file are in Appendix A, XML
file preparation.
outFileFme Path and name of the file containing the specification of the exported job.
The exportdeftable arguments file
Arguments are used as a s election criteria to determine which scheduling tables to
export. Arguments are written to the exportdeftable argument file.
The arguments files that you create with the exportdeftable utility are written in
XML format and saved in a text file. The format in which this file must be written is
described on the following pages.
When this file is invoked, scheduling table definitions are exported from the
CONTROL-M/EM database. For instructions for creating arguments files, see
Appendix A, XML file preparation.
The following rules apply to the exportdeftable arguments file:
More than one job can be specified in an exportdeftable file.
The relationship between PARAM parameters in a TERM statement is AND. The
relationship between TERM statements is OR.
Table 45 exportdeftable arguments file parameters (part 1 of 2)
TERM The TERM tags indicate the start and the end of a group of selection criteria used
to specify a table or tables that are to be exported. Only PARAM tags that are
located between the TERM tags are considered to be part of the TERM argument.
REL Optional. Relationship between terms. Valid values:
AND
OR
Following are sample arguments files used with the exportdeftable utility:
Example 1: Export all scheduling tables in the Data1 data center
Example 2: Export with multiple selection criteria
Group scheduling tables are exported that:
are located in data center Data1 and belong to the GRP_03 group scheduling table
- or -
are located in data center Data1 and belong to the GRP_04 group scheduling table
PARAM The selection criteria parameter used to determine those scheduling tables that are
to be exported. More than one PARAM can be specified. Mandatory.
Example:
NAME String. Mandatory. The parameter name of any scheduling table or
group scheduling table parameter. These parameters are described in
Table 40 on page 137.
included in the arguments file:
DATACENTER
TABLE_NAME
TABLE_DSN
OP Mandatory. Describes the relationship between the NAME and the
VALUE parameters of the TERM. Valid values:
EQ
NEQ
NOTIN
LIKE
VALUE String. Mandatory. The value of any scheduling table or group
scheduling table parameter. These parameters are described in Table 40
on page 137.
Note: Multiple values can be specified for VALUE by using the *
wildcard character in place of characters at the end of an expression.
<TERMS>
<TERM>
VALUE=" Dat a1" / >
</ TERM>
</ TERMS>
<TERMS>
<TERM>
VALUE=" Dat a1" / >
<PARAM NAME=" GROUP" OP=" EQ" VALUE=" GRP_03" / >
</ TERM>
Table 45 exportdeftable arguments file parameters (part 2 of 2)
<TERM>
VALUE=" Dat a1" / >
<PARAM NAME=" GROUP" OP=" EQ" VALUE=" GRP_04" / >
</ TERM>
</ TERMS>
Chapt er
6
6 Administration utilities
This chapter describes various CONTROL-M/EM component administration
utilities.
Monitoring and maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
check_gtw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Parameters of the check_gtw utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
cryptocli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Parameters of the cryptocli utilitytrial mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Parameters of the cryptocli utilityoperation mode. . . . . . . . . . . . . . . . . . . . . . . . 160
ccmcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
ccmcli usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
ccmcli parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
ctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Performing commands and requests using the Control Shell . . . . . . . . . . . . . . . 162
ctl command syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Parameters common to all ctl commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Health Check utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Running the Health Check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Parameters of the Health Check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
purge_runinfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Log files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Cleaning out run information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
purge_xalerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Monitoring and maintenance
Monitoring and maintenance
Monitoring and maintaining your CONTROL-M/EM network is necessary to ensure
that your scheduling environment operates as planned. The utilities described in this
chapter address selected management and security topics. The Health Check utility
scans and collects system information about the environment on which
CONTROL-M/EM, BMC Batch Impact Manager, or BMC CONTROL-M/Forecast
resides.
Table 46 lists the utilities discussed in this chapter.
NOTE
Many of the tasks performed by the check_gtw and ctl utilities can also be performed using
the CONTROL-M Configuration Manager or the root menu. However, by including a utility
command in the command line of a job processing definition, you can run the utility at a
predetermined time or under a predetermined set of conditions without being present.
Table 46 Administration utilities
Utility Description
check_gtw Checks that the specified gateway is running. (See page 157.)
cryptocli Enables the CONTROL-M/EM administrator to encrypt a password
for use as the administrator password. The utility inserts the
encrypted password in the relevant places in the mcs.ini file. (See
page 159.)
ctl Enables you to send simple requests to networked CONTROL-M/EM
components. (See page 162.)
Health Check utility Scans and collects system information about the environment on
which CONTROL-M/EM, BMC Batch Impact Manager, or BMC
Forecast resides. (See page 173.)
purge_runinfo Cleans out run information retained by CONTROL-M/Forecast for
the purposes of performing its calculations. (See page 180.)
check_gtw
check_gtw
The Gateway Verification (check_gtw) utility verifies the availability of the gateways.
The utility checks all currently enabled data centers to verify if their gateway is
running. If any check for a gateway fails, an Alert is sent to the specified e-mail
address(es). If a gateway whose check failed (not active) starts to run, another Alert is
sent by e-mail indicating that the gateway is now running.
To invoke the check_gtw utility, specify the following command
check_gtw
-u|-U <dbUser>
-p|-P <dbPassword>
[-m|-M <testMode>]
[-t|-T <timeInterval>]
[-w|-W <waitingTime>]
[-s ALL | <maxNumberOfParallelDc>]
-e <address> [-e <address> ... ]
|-f|-F <file>
|-e <address> [-e <address> ... ]-f|-F <file>
NOTE
Run this utility on UNIX only.
NOTE
Alerts are sent only once, when a change in gateway status occurs.
NOTE
An -e parameter, or an -f parameter, or both, must be specified.
Parameters of the check_gtw utility
Parameters of the check_gtw utility
Table 47 describes the check_gtw utility parameters.
If the Gateway Verification (check_gtw) utility determines that a gateway is
unavailable, a user-defined exit, check_gtw_ue, can be automatically executed.
A sample check_gtw_ue exit is supplied in the $HOME/scripts directory. Make a copy
of this sample exit and modify it. Table 48 lists the parameters passed to this user exit
by the check_gtw utility.
Table 47 check_gtw utility parameters
-u dbUser Database user name.
-p dbPassword Database user password.
-m testMode Mode of the utility. Valid values:
ps Use the ps UNIX command. This mode can only be used when
all gateways run on the local computer.
ctl Use ecs ctl utility interactively.
ctlbg Use ecs ctl utility by sending a background chk message to
all the gateways. This mode prevents the utility from hanging if a
gateway does not respond. Default.
-t timeInterval Time interval (in seconds) between tests. Default: 200
-w waitingTime Time (in seconds) to wait for all gateways to respond. Use with ctlbg only.
-s
maxNumberOfDc
| ALL
Maximum number of ecs ctl commands to be launched concurrently.
Valid values:
ALL All enabled data centers. Default.
## Number of enabled data centers.
-e address E-mail addresses to which Alerts are sent. Additional -e parameters can
be specified, separated by blanks.
For example:
-e address1@mail.com -e address2@mail.com
-f file File that contains e-mail addresses to which Alerts are sent. The addresses
must be separated by a blank space.
Table 48 check_gtw_ue user exit parameters
$DATA_CENTER Data center name.
$UserName User name.
$Passwd User password.
cryptocli
cryptocli
The cryptocli utility creates an encrypted version of the password you submit.
If the CONTROL-M/EM administrator user name or password is changed in the
CONTROL-M/EM database, it must also be updated manually in all relevant mcs.ini
files. By default, the password is encrypted in the mcs.ini file. Use the cryptocli utility
to generate the encrypted version of your new password.
You can invoke cryptocli in either of the following modes.
Trial mode You submit the new password and cryptocli creates an output text
file in the specified location containing the encrypted version of that password.
You can copy the encrypted text to appropriate places in the mcs.ini file manually.
Operational mode When you submit your username and new password,
cryptocli creates an encrypted version of the password and inserts it in the
appropriate places in the text of the mcs.ini file. mcs.ini is saved automatically.
To invoke the cryptocli utility in trial mode
1 Open a Command Prompt window.
2 Change the working directory to Ini under the CONTROL-M/EM home directory.
3 Specify the command:
cryptocli.exe newPassword outputFileName
Parameters of the cryptocli utilitytrial mode
Table 49 describes the parameters in the cryptocli utility in trial mode.
Table 49 cryptocli parameters trial mode
Item Description
newPassword New CONTROL-M/EM administrator password.
outputFileName Full path name of the output file created by cryptocli. The file contains
the encrypted version of the password that was submitted.
Parameters of the cryptocli utilityoperation mode
To invoke the cryptocli utility in operation mode
1 Open a command prompt window.
2 Change the working directory to ini under the CONTROL-M/EM home directory.
3 Specify the following command:
cryptocli.exe userName newPassword mcs.ini pathName
Parameters of the cryptocli utilityoperation mode
Table 50 describes the parameters in the cryptocli utility in operation mode.
ccmcli
The ccmcli utility enables you to perform basic administrative tasks on
CONTROL-M/EM components and the CONTROL-M/Server, including:
starting
stopping
ignoring
recycling
viewing details about the component or server
To invoke ccmcli
2 Specify the ccmcli command. For more information, see ccmcli usage.
Table 50 cryptocli parameters operation mode
Item Description
userName CONTROL-M/EM administrator user name.
newPassword New CONTROL-M/EM administrator password.
mcs.ini pathName Full path name of the mcs. i ni file (for example,
wi ndi r\ system32\ mcs. i ni ).
ccmcli usage
ccmcli usage
ccmcli parameters
ccmcl i [ - u <us e r >] [ - p ] | - pf ] [ - s
<c o nt r o l M_Co nf i g ur a t i o n_S e r v e r _Na me >] [ - t <c o mp o ne nt Ty p e >] [ - n <c o mp o ne nt Na me >]
[ - h <c o mp o ne nt Ho s t >] [ - cmd <c o mma nd >] | [ - ct l cmd <c o mma nd >] ]
Table 51 ccmcli parameters
-u CONTROL-M/EM user name
-p CONTROL-M/EM user password
-pf Flat file containing an unencrypted username and password on separate lines
in the format:
user=username
password=password
Note:
If both -u and -pf are specified, an error message is generated.
If only -u is specified, an online prompt is issued for the password.
If neither is specified, a prompt is issued for the user name and password.
-s The name of the CONTROL-M Configuration Server
-t The type of component. Valid values are:
Gateway
GUI_Server
GCS
GAS
BIM
Forecast_Server
CTM_Server
-n The logical name of the component.
-h The host on which the component is running.
-cmd The command you want to run on the agent configuration server or
component. Valid values are:
start
stop
ignore
recycle
details
For more information about these commands, refer to the section dealing
with day-to-day administration in the CONTROL-M/EM Administrator Guide.
-ctlcmd A control shell command sent to one of the CONTROL-M/EM components.
For more information, see ctl..
ctl
ctl
The ctl command line utility enables you to send simple requests to CONTROL-M/EM
server components. The ctl utility can:
Check if CONTROL-M/EM server components are operational.
Check if Batch Impact Manager and CONTROL-M/Forecast (Forecast) server
components are operational (if this product is installed at your site).
Send commands to CONTROL-M/EM components during runtime, for example,
setting Gateway debug level.
The ctl utility is automatically installed with a full CONTROL-M/EM installation.
To invoke ctl from Microsoft Windows
2 Specify the ctl command line. For ctl syntax, see ctl command syntax on
page 163.
To invoke ctl from UNIX
1 Open an Xterm window.
2 Log on as the CONTROL-M/EM administrator.
3 Specify the ecs ctl command line. For ctl syntax, see ctl command syntax on
page 163.
Performing commands and requests using the Control Shell
The Control Shell enables you to send commands to the CONTROL-M/EM server
components. These commands are the same as those that you can run under the
-cmdstr parameter, in the ctl command line utility.
NOTE
ctl utility commands are case-sensitive.
ctl command syntax
To perform commands using the Control Shell
1 Right-click the required CONTROL-M/EM server component, and select Control
Shell.
The Control Shell dialog box is displayed.
2 Click Usage to populate the Result field of the Control Shell dialog box with the
commands and requests available for the specific component.
3 Select the required command, and copy it into the Specify... field of the Control
Shell dialog box. You can also manually enter a specific command.
4 Click Apply.
ctl command syntax
The command syntax for the ctl utility is a function of the component for which the
utility runs. The parameters of the ctl utility are described after the command syntax
for each component.
Parameters common to all ctl commands
Table 52 lists the parameters that are present in the syntax of all variations of the ctl
command. The parameters specific to each server component are discussed
separately in the relevant sections, as follows:
Gateway on page 164
Global Conditions Server on page 166
GUI server on page 167
Global Alerts Server on page 168
Configuration Management Server on page 169
Configuration Agent on page 170
BMC Batch Impact Manager server on page 171
Forecast server on page 172
NOTE
To run the ctl utility on UNIX computers, issue the ecs ctl command.
To run this utility on Microsoft Windows computers, issue the ctl command.
Gateway
Table 52 Parameters common to all variations of the ctl command
ecs Prefix to be specified when running this utility on a UNIX operating system.
-U CONTROL-M/EM database user name.
-P CONTROL-M/EM database user password.
-pf Flat file containing an unencrypted username and password on separate lines in
the format:
user=username
password=password
Note:
If both -U and -pf are specified, an error message is generated.
If only -U is specified, an online prompt is issued for the password.
If neither is specified, a prompt is issued for the database user name and
password.
-reg Checks if the Global Conditions Server is registered in the CommReg table.
-reg cannot be used with -cmd or -cmdstr.
-cmd Indicates a command to be performed by the Global Conditions Server.
-cmd cannot be used with -reg.
stop Stops the Global Conditions Server.
This command cannot be specified with other commands in the
same run of the ctl utility.
life_check Checks if the Global Conditions Server is active.
This command cannot be specified with other commands in the
same run of the ctl utility.
-timeout Indicates the period of time (in seconds) that ctl waits for a response from the
Global Alerts Server before declaring that communication has failed.
Default: 30. Optional.
-diagon Activates tracing of ctl work flow (diagnostics). The results are written to the
ctl_diag.machine.txt file located in the working directory. Optional.
[ ecs] ct l
[ {- U <e mUs e r > - P <e mPa s s >} | - pf ]
- C Gat eway {- dc <d a t a Ce nt e r > | - al l }
{- r eg |
- cmd st op |
- cmd l i f e_check |
{[ - cmd dwl ]
[ - cmd change_l og]
[ - cmd no_dbg]
[ - cmd db{0- 9}]
[ - cmd gui {+| - }]
[ - cmd host {+| - }]
[ - cmd t r unc{+| - }]
[ - cmd al i ve{+| - }]
[ - cmd j ob{+| - }]
The parameters common to all ctl commands are described in Table 52. The
parameters specific to the Gateway are described in Table 53.
[ - cmd dwl _debug{+| - }]
[ - cmd host l i nk{+| - }]
[ - cmd gui l i nk{+| - }]
[ - cmd show_j cl ] }}
[ - t i meout <<r e s p o ns e Ti me o ut > ( seconds) >]
[ - di agon]
Table 53 ctl parameters for the Gateway (part 1 of 2)
-C Gateway Indicates that the command is directed to the gateway. The gateway mediates
between CONTROL-M/EM components and the CONTROL-M installation.
-dc Name of a data center. This name identifies the gateway to which ctl is
sending a command or message. This parameter is used when a query or
command is directed to a specific gateway (as specified by the -C parameter).
-dc cannot be used with -all.
-all Directs a query or command to all components of the gateway (as specified by
the -C parameter).
-all cannot be used with -dc.
Global Conditions Server
parameters specific to the Global Conditions Server are described in Table 54.
-cmd Indicates a command to be performed by the gateway. -cmd cannot be used
with -reg.
dwl Forces a new download from a CONTROL-M installation.
The following -cmd values are used for diagnostics and debugging, as
described in the Diagnostics and Troubleshooting chapter of the
Note: Diagnostic and non-diagnostic commands can be specified on the same
ctl command line.
change_log Closes the current log file and creates a new log file.
no_dbg Stops all debug printing.
db# Debug level for database operations. Range: 0 - 9
0 turns off debugging.
gui +| Starts or stops a debug trace for the GUI.
host +| Starts or stops output of host debug messages.
trunc +| Starts or stops truncating messages. Only the message
header and one row of data remain after truncation.
alive +| Starts or stops debugging of keep alive messages.
job +| Starts or stops dumping job messages. During a debug
trace, job+ displays messages on the screen about active job
downloads, active job updates, and Scheduling table
uploads. This option is active by default.
dwl_debug +| Starts or stops a debug trace for the download procedure.
hostlink +| Starts or stops a debug trace for the host link.
guilink +| Starts or stops a debug trace for the GUI link.
show_jcl Shows active JCL.
[ ecs] ct l
- C GCS {- M <c o mp ut e r Na me > | - al l }
{ - r eg |
- cmd st op |
- cmd change_l og |
- cmdst r " <c o mma nd S t r i ng >" }]
[ - di agon]
Table 53 ctl parameters for the Gateway (part 2 of 2)
GUI server
parameters specific to the GUI server are described in Table 55.
Table 54 ctl parameters for the Global Conditions Server
-C GCS Global Conditions Server to which the command is directed. The Global
Conditions Server handles the distribution of conditions that affect jobs in more
than one data center.
-M Specifies a computer name. This name is used to identify the computer to which
the Global Conditions Server belongs. -M cannot be used with -all.
-all Directs a query or command to all Global Conditions Servers. -all cannot be
used with -M.
-cmd Indicates a command to be performed by the Global Conditions Server. -cmd
cannot be used with -reg.
The following -cmd value is used for diagnostic and debugging purposes, which
are described in more depth in the Diagnostics and Troubleshooting chapter
of the CONTROL-M/Enterprise Manager Administrator Guide.
Note: Diagnostic and non-diagnostic commands can be specified on the same ctl
command line.
change_log Closes the current log file and creates a new log file.
-cmdstr Specifies a text string to be sent to the Global Alerts Server. If the text string
contains spaces or tabs, it must be enclosed with double quotation marks ( ).
-cmdstr cannot be used with -reg or -cmd. The -cmdstr parameter is used for
diagnostic purposes only. It is discussed in the diagnostics and troubleshooting
chapter of the CONTROL-M/Enterprise Manager Administrator Guide.
[ ecs] ct l
- C GUI _S e r v e r
{- M <c o mp ut e r Na me > | - name <l o g i c a l Na me > | - al l }
{- r eg |
- cmd st op |
- cmd do_measur e |
- cmd get _measur e |
- cmdst r " <c o mma nd S t r i ng >" }
[ - di agon]
Global Alerts Server
parameters specific to the Global Alerts Server are described in Table 56.
Table 55 ctl parameters for the GUI server
-C GUI_Server Indicates that the command is directed to one or more GUI servers. GUI
servers handle communications between CONTROL-M/EM GUI
workstations and other CONTROL-M/EM components.
-M Specifies a computer name. This name is used to identify the computer to
which the GUI server belongs. -M cannot be used with -all. When -M is
specified, the request is sent to the GUI server whose name is equal to the
value indicated with -M.
-name Logical name of the GUI server. If the GUI server is started without
specifying -name, the logical name of the GUI server is equal to the host
name of the computer where the GUI server is running.
-all Directs a query or command to all GUI servers. -all cannot be used with -M.
-cmd Indicates a command to be performed by the GUI server. -cmd cannot be
used with -reg.
do_measure Initiates collection of statistics about the GUI server.
This command cannot be specified with other commands
in the same run of the ctl utility.
get_measure Retrieves statistics from the GUI server and displays them.
This command cannot be specified with other commands
in the same run of the ctl utility.
-cmdstr Specifies a text string to be sent to the GUI server. If the text string contains
spaces or tabs, it must be enclosed with double quotation marks ( ).
-cmdstr cannot be used with -reg or -cmd.
The -cmdstr parameter is used for diagnostic purposes only. Its usage is
discussed in the diagnostics and troubleshooting chapter of the
[ ecs] ct l
- C GAS
{- r eg |
- cmd st op |
[ - di agon]
Configuration Management Server
parameters specific to the Configuration Management Server are described in
Table 57.
Table 56 ctl parameters for the Global Alerts Server
-C GAS Global Alerts Server to which the command is directed. The Global Alerts
Server identifies and distributes alerts between CONTROL-M installations and
CONTROL-M/EM workstations.
the Global Alerts Server belongs. -M cannot be used with -all. When -M is
specified, the request is sent to the Global Alerts Server whose name is equal to
the value indicated with -M.
-name Logical name of the Global Alerts Server. If the Global Alerts Server is started
without specifying -name, the logical name of the Global Alerts Server is equal
to the host name of the computer where the Global Alerts Server is running.
-all Directs a query or command to all networked Global Alerts Servers.
-all cannot be used with -M.
-reg Checks if the Global Alerts Server is registered in the CommReg table.
-reg cannot be used with -cmd or -cmdstr.
-cmdstr Specifies a text string to be sent to the Global Alerts Server. If the text string
contains spaces or tabs, it must be enclosed with double quotation marks ( ).
[ ecs] ct l
- C CMS
{- r eg |
- cmd st op |
[ - di agon]
Configuration Agent
parameters specific to the Configuration Agent are described in Table 58.
Table 57 ctl parameters for the Configuration Management Server
-C CMS Configuration Management Server to which the command is directed.
the Configuration Management Server belongs. -M cannot be used with -all.
When -M is specified, the request is sent to the Global Alerts Server whose name
is equal to the value indicated with -M.
-name Logical name of the Configuration Management Server. If the Configuration
Management Server is started without specifying -name, the logical name of the
Configuration Management Server is equal to the host name of the computer
where the Configuration Management Server is running.
-all Directs a query or command to all Configuration Management Servers.
-cmdstr Specifies a text string to be sent to the Configuration Management Server. If the
text string contains spaces or tabs, it must be enclosed with double quotation
marks ( ).
[ ecs] ct l
- C Conf i g_Agent {- M <Co mp ut e r _Na me > | - al l }
{- r eg |
- cmd st op |
- cmd shut down} |
- cmdst r " <c o mma nd S t r i ng >" }]
[ - di agon]
Table 58 ctl parameters for the Configuration Agent (part 1 of 2)
-C Config_Agent Configuration Agent to which the command is directed. The
Configuration Agent controls CONTROL-M/EM components on the
host computer.
-M Specifies a computer name. This name is used to identify the computer to
which the Configuration Agent belongs. -M cannot be used with -all.
-all Directs a query or command to all Configuration Agents.
BMC Batch Impact Manager server
parameters specific to the BMC Batch Impact Manager server are described in
Table 59.
-cmd Indicates a command to be performed by the Configuration Agent. -cmd
cannot be used with -reg.
shutdown Stops the Configuration Agent, and all components that the
Configuration Agent administers, without changing their
configurations. This command cannot be specified with
other commands in the same run of the ctl utility.
-cmdstr Specifies a text string to be sent to the Configuration Agent. If the text
string contains spaces or tabs, it must be enclosed with double quotation
marks ( ).
[ ecs] ct l
- C BI M
{- M <c o mp ut e r Na me >
- name <l ogi cal Name>}
{- r eg |
- cmd st op |
- cmdst r " <Co mma nd _S t r i ng >" }
[ - di agon]
Table 59 ctl parameters for BMC Batch Impact Manager server (part 1 of 2)
-C BIM Indicates that the command is directed to a Batch Impact Manager server (if this
product is installed at your site).
the Batch Impact Manager server belongs.
Table 58 ctl parameters for the Configuration Agent (part 2 of 2)
Forecast server
parameters specific to the Forecast server are described in Table 60.
-name Logical name of the Batch Impact Manager server. If the Batch Impact Manager
server is started without specifying -name, the logical name of the Batch Impact
Manager server is equal to the host name of the computer where the Batch
Impact Manager server is running.
-cmdstr Specifies a text string to be sent to the Batch Impact Manager server. If the text
string contains spaces or tabs, it must be enclosed with double quotation marks
( ).
-cmdstr cannot be used with -reg or - cmd.
[ ecs] ct l
- C <f o r e c a s t S e r v e r >
{- M <c o mp ut e r Na me >
- name <l ogi cal Name> | - al l }
{- r eg |
- cmd st op |
- cmdst r " <Co mma nd _S t r i ng >" }
[ - di agon]
Table 60 ctl parameters for Forecast server
-C forecast
Server
Indicates that the command is directed to a Forecast server (if
CONTROL-M/Forecast is installed at your site).
the Forecast server belongs.
-name Logical name of the Forecast server. If the Forecast server is started without
specifying -name, the logical name of the Forecast server is equal to the host
name of the computer where the Forecast server is running.
-all Directs a query or command to all Forecast servers. -all cannot be used with -M.
-cmdstr Specifies a text string to be sent to the Forecast server. If the text string contains
spaces or tabs, it must be enclosed with double quotation marks ( ).
Table 59 ctl parameters for BMC Batch Impact Manager server (part 2 of 2)
Health Check utility
Specifying a specific server component and computer
Table 61 lists examples showing how you can ensure that only specific server
components and computers are selected. In the examples, only the relevant section of
the code is displayed.
The Health Check utility scans and collects system information about the environment
on which CONTROL-M/EM, BMC Batch Impact Manager, or
CONTROL-M/Forecast resides. This information is used in helping to troubleshoot
and correct problems.
The information gathered is maintained in a compressed hierarchical format that
allows for analysis of the collected information. The hierarchy is important in
determining the nature of the collected data.
The Health Check information is gathered based on either Categories or Profiles.
Categories are different types of information from various parts of your system.
Profiles are used to group categories according to a common denominator. For
more information, refer to Table 62 on page 175.
When you run the utility, a log file is created showing you what processes ran and
what information was written to the compressed file. The log file is named in the
format
ctm_data_collector_<DATE>_<TIME>_<OS_TYPE>_<MACHINE_NAME>_display.log
Table 61 Specifying specific server components and computers
To do this ... Specify this ...
Direct the ctl command to the
Gateway for data center
ctm_main.
ecs ctl -U user01 -P pass01 -C Gateway -dc ctm_main
Direct the ctl command to all
Global Conditions Servers.
ecs ctl -U user01 -P pass01 -C GCS -all
Global Conditions Server of
the computer named wip78.
ecs ctl -U user01 -P pass01 -C GCS -M wip78
GUI Server on the computer
with the logical name of
gsr01.
ecs ctl -U user01 -P pass01 -C GUI_Server -name gsr01
Running the Health Check utility
It is important that you read the log file before sending the compressed file to BMC
Software Technical Support, as the compressed file may contain proprietary
information.
Running the Health Check utility
The Health Check utility is run from the command line, using the full path, or as part
of a scheduled batch job. Use the following command to run the utility from the
command line.
UNIX
<EM_HOME>/scripts/ctm_data_collector [<passwordInfo>] [-categories|-C
<categories>] [-profiles|-F <profiles>] [-products|-D <productsList>] [<runConfiguration>]
Windows
<EM_HOME>\bin\ctm_data_collector [<passwordInfo>] [-categories|-C <categories>]
[-profiles|-F <profiles>] [-products|-D <productsList>] [<runConfiguration>]
Running the Health Check utility using config.ini
You can also run the Health Check utility using the config.ini file. This enables you to
predefine a specific format for running the utility without having to specify the
various options in the command line.
This method is most useful if you plan to collect the data in a fixed format on a
regular basis.
Figure 1 Default config.ini file
#cat egor i es=" OS DB DBT SCH TBL CNF COMLOG" #make sur e t her e i s a bl ank space bet ween each
one and upper case
#pr of i l es=" DB EM BI M FOR ALL"
#pr oduct s=" EM BI M FOR" #make sur e t her e i s a bl ank space bet ween each one and uper case
bat ch_mode=" y" # l ower case " y" or " n"
max_si ze=" 100" #max f i l es si ze
days=" 10" #t i me per i os ( days) t o col l ect dat a
ct mname=" %%host name" #def aul t i s l ocal host name
gsr name=" %%host name" #def aul t i s l ocal host name
bi mname=" %%host name" #def aul t i s l ocal host name
hi dden=" dbo_pwd dba_pwd" #Hi dden pr oper t i es shoul d be def i ned onl y t hr ough command l i ne!
Parameters of the Health Check utility
To run the Health Check utility in this mode
1 Set the parameters for which you want to collect data in the config.ini file. For
information about the parameters, refer to Parameters of the Health Check
utility.
2 Set the parameters for the password file.
3 Run the following command:
ctm_data_collector -file filePath fileName
Table 62 describes the parameters in the Health Check utility.
Table 62 ctm_data_collector utility parameters (part 1 of 2)
passwordInfo The user name and password required to run the utility.
To gather information about the DB,DBT,SCH,TBL and COM
categories or the EM,FOR,BIM and ALL profiles, enter [ -U <dbo_user>
-P <dbo_pwd>].
categories The different information types you can gather. For more information
about the different categories, refer to Table 63 on page 177.
profiles Groups of categories. Valid profiles are:
ENV
EM
BIM
FOR
ALL
Note: When using a profile, there is no need to specify products. For
more information about the different profiles, refer to Table 64 on
page 179.
products The list of products installed on the computer for which you want to
gather the information. Valid values are:
EM
BIM
FOR
Note: You must list the products when collecting data according to
categories.
runConfiguration Additional options with which you can run the utility. Valid values are:
simulate - Allow the user to simulate execution of the utility to
verify what would be collected or that there is sufficient disk space
for the data collection.
days - the maximum number of days in the past for which the
utility gathers the information. This option only affects log files
relevant to BMC Software products.
max_size - the maximum size of data the utility scans to gather the
information.
trace - used to run a trace on the utility when the utility is not
working properly. The utility generates a log file that should be
sent to BMC Software Technical Support so that the problem can be
resolved. The log file is named in the format
ctm_data_collector_<DATE>_<TIME>_<OS_TYPE>_
<MACHINE_NAME>.log
verbose - outputs the utility processes to your display.
help or h - displays the utilitys usage.
file - insert the path to the file containing the DBO and DBA
passwords.
Note: The file option should only be used when running the utility
in batch mode. To run the utility in batch mode, set the value of the
batch_mode parameter in the config.ini file to y.
Table 62 ctm_data_collector utility parameters (part 2 of 2)
Table 63 describes categories, which are different types of information from various
parts of your system.
Table 63 Category definitions for the ctm_data_collector utility (part 1 of 2)
Category Definition
OS Operating-system related physical resource. This information includes:
Operating system version
software and hotfixes installed
environment variables and files
system resources limits
kernel parameters
swap space
system and application logs
scheduled tasks
ini files (MS Windows only)
resource consumption
list of running processes
network settings
DB Database environment. This information includes:
Database files - ini and configuration files, and database log files
Database information collected from SQL queries - configuration
parameters
Note: This information is only collected for Sybase and Oracle databases on
UNIX operating systems.
DBT Collects information from the following CONTROL-M/EM database tables:
global_cond
gcs_gtw_recov
gcs_msgs
gcs_dsts
gcs_admin
comm, confreg
logreg
commreg
params
name_value
exception_alerts
download
stat_ex_period BIM only
stat_ex BIM only
dictionary BIM only
time_index Forecast only
date_index Forecast only
sim_exception_conditions Forecast only
sim_sysstate_ud Forecast only
sim_sysstate_udtbl Forecast only
SCH Product scheduling entities measurement. This information includes:
number of daily jobs per CONTROL-M
number of daily executions per CONTROL-M
TBL Product infrastructure entities measurement. This information includes sizes
of the following tables:
Alarm
conditions and resources tables
definition and active job tables
global_cond
gcs_gtw_recov
gcs_msgs
gcs_dsts
gcs_admin
comm
confreg
logreg
commreg
name_value
audit_activity
exception_alerts
password_history
audit_operations
audit_atributes
bim_log BIM only
stat_ex_period BIM only
stat_ex BIM only
bim_alert BIM only
dictionary BIM only
CNF Product configuration files. This information includes the following
configuration files:
product version (collects the information from installed-version.txt file
located in the <emHome> directory.
the list of files under the <emHome> directory.
Installation_Paramaeters.txt
*.ini
*.rsc
TAO configuration files
LOG Product general data collection. This information includes:
All product logs for CONTROL-M/EM, BMC Batch Impact Manager, and
CONTROL-M/Forecast
A list of the core files created
COM Product functionality, communication, and connectivity. This information
includes information about the communication status and corba availability
status.
Table 63 Category definitions for the ctm_data_collector utility (part 2 of 2)
Category Definition
Table 64 Profile definitions for the ctm_data_collector utility
Profile Definition
ENV Environment data collection. This includes information from the following
categories:
OS
DB
EM CONTROL-M/EM related data. This includes information from the
following categories:
COM
LOG
DBT
SCH
TBL
CNF
BIM BMC Batch Impact Manager related data. This includes information from the
COM
LOG
DBT
SCH
TBL
CNF
FOR CONTROL-M/Forecast related data. This includes information from the
COM
LOG
DBT
SCH
TBL
CNF
ALL Collects data for all profiles, including:
ENV
EM
BIM
FOR
purge_runinfo
Examples
The following example is the default option for this utility, which collects information
from all categories except DBT and LOG.
The following example collects information from all profiles for the last seven days.
The following example collects information from the OS and DB categories for
CONTROL-M/EM, and runs a trace to troubleshoot the utilitys execution.
purge_runinfo
The purge_runinfo utility can be executed periodically to clean out run information
retained by CONTROL-M/Forecast for the purposes of performing its calculations.
The utility is located in one of the following directories, depending on your operating
system:
EMHome\bin on Microsoft Windows
EMHome/scripts on UNIX
Log files
The log files of the purge_runinfo utility are located in the installation log directory
both in UNIX and in Microsoft Windows. The log file that shows the run flow of the
utility is called purge_runinfo_run.log.
EXAMPLE
ct m_dat a_col l ect or <passwor d_i nf o>
EXAMPLE
ct m_dat a_col l ect or <passwor d_i nf o> - days 7 - F ALL
EXAMPLE
ct m_dat a_col l ect or <passwor d_i nf o> - t r ace - C OS DB - D EM
Cleaning out run information
Cleaning out run information
You can run purge_runinfo to clean out CONTROL-M/Forecast run information.
Decide whether to run the utility interactively or silently and then follow the
appropriate instructions for each mode.
Interactively
Run one of the following files, based on your operating system:
EMHome\bin\purge_runinfo.bat
On UNIX
EMHome/scripts/purge_runinfo shell script
Answer the prompts when they are displayed. You are prompted for the following
information:
the number of days to retain the information about the run of the jobs
the CONTROL-M/EM DBO user name and password
The utility has finished when the message Ended successf ul l y is displayed.
Silently (in batch)
Run the following command:
purge_runinfo U emUser -P emPass -keep_days numDaysRetain
Example
On UNIX, you can hide the password using the file method (in this example, X is the
name of the file that contains the password):
cat X | purge_runinfo U emUser -P emPass -keep_days numDaysRetain
numDaysRetain is the number of days to retain the statistics. If numDaysRetain is 2,
all statistics prior to two days before the current date will be deleted.
purge_runinfo U myuser -P mypassword -keep_days 2
purge_xalerts
purge_xalerts
The purge_xalerts utility deletes exception alerts from the Exception Alerts table in
the CONTROL-M/EM database.
To invoke the utility
pur ge_xal er t s [ - U <e mDBO>] [ - P <e mDBOPa s s wo r d >] [ - keep_days
<numb e r >]
The utility has finished when the message Ended successf ul l y is displayed.
For more information about exception alerts, refer to the section in the
CONTROL-M/Enterprise Manager Administrator Guide that discusses exception
handling.
NOTE
The DeleteChunkSize system parameter determines the number of records deleted in one
transaction by the purge_runinfo utility when removing run information from the
RUNINFO_HISTORY table in the CONTROL-M/EM database. If the DeleteChunkSize value
is smaller than the parameter value, no data is deleted.
Table 65 Parameters
-U CONTROL-M/EM database user name.
-P CONTROL-M/EM database user password.
keep_days The number of days for which exception alerts are kept in the
NOTE
The deleted exception alerts are no longer displayed in the XAlerts window either within an
hour or after you restart the CMS, whichever occurs first.
Chapt er
7
7 Database maintenance utilities
The utilities described in this chapter can be used to maintain the CONTROL-M/EM
database and to import and export information to and from additional
CONTROL-M/EM databases.
Performing database maintenance utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
db_check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Syntax of the db_check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Parameters of the db_check utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
db_check_space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Sybase Adaptive server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Oracle server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Parameters of the db_check_space utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
util. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
DB_ARGS database arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Functions and syntax of the util utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Parameters of the util utility functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
em_SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Syntax of the em_SQL utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Parameters of the SQL utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Performing database maintenance utilities
Performing database maintenance utilities
Many of the tasks performed by the database maintenance utilities can also be
performed using the CONTROL-M Configuration Manager or the root menu.
However, by including a utility command in the command line of a job processing
definition, you can run the utility at a predetermined time or under a predetermined
set of conditions without being present.
db_check
The db_check utility provides the following information:
Size of the database
Availability of space in the database
Verification of database integrity.
Automatic database and transaction log monitoring
When db_check is invoked, information similar to the following is displayed:
Table 66 Database maintenance utilities
Utility Description
db_check Provides general information about a database and its status, including
verification of database integrity and automatic database and
transaction log monitoring.
db_check_space Provides general information about database size and available space.
util Provides CONTROL-M/EM database management functions from a
command line.
em_SQL Enables you to connect to the database from the command line.
db t ot al = 29000. 0 KB ( dat a= 23500. 00, l og= 5500. 00)
dat a used = 1928 KB ( 8%) .
l og used = 0 KB ( 0%) .
Checki ng dat abase. . .
Dat abase i s OK.
NOTE
The db_check utility is not relevant for Microsoft Windows and works only with databases on
a Sybase Adaptive server. This utility is not available for Oracle server.
Syntax of the db_check utility
Syntax of the db_check utility
To run the db_check utility, issue the following command
db_check [-d dbThreshold%] [-l logThreshold%] [-p password] [-n] [-h]
The user name is derived from the $ECS_USER environment variable.
Parameters of the db_check utility
db_check_space
The db_check_space utility provides the following information for Sybase Adaptive
and Oracle database servers.
Total size and availability of space in the /tmp directory
Total size and availability of space in the database
Total size and availability of space in the log (Sybase only)
Percentage of total space in the database that is currently available
Table 67 db_check utility parameters
-d dbThreshold% Maximum percentage of database use. When this percentage is exceeded,
a message is displayed alerting you to extend the database.
Note: The -d must be lowercase.
-l logThreshold% Maximum percentage of transaction log use. When this percentage is
exceeded, a message is displayed alerting you to extend the transaction
log. Note: The -l must be lowercase.
-p password Password for the CONTROL-M/EM administrator. If not specified, you
are prompted to supply this information when the utility runs.
Note: The -p must be lowercase.
-n When -n is specified, db_check is executed without verifying the total
database integrity. Note: The -n must be specified in lowercase.
-h When -h is specified, db_check displays the amount of database space
that is in use. Note: The -h must be specified in lowercase.
NOTE
This utility cannot be used for Oracle database client installations and is not relevant for
Microsoft Windows.
Sybase Adaptive server
To run the db_check_space utility, specify the appropriate CONTROL-M/EM UNIX
user account and password using the -U and -P parameters in the command line of
db_check_space (see Syntaxbelow) or when prompted by the utility interactively:
When working with Sybase, specify the database owner, any database user, or the
Sybase Adaptive server administrator as the user name.
When working with Oracle, specify the Oracle administrator as the user name.
When the db_check_space utility is invoked, information similar to the following is
displayed, depending on your database.
Sybase Adaptive server
Oracle server
Syntax
db_check_space [ -U username [ -P password ] ]
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Space I nf or mat i on ( / t mp of t he machi ne) +
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Tot al Si ze: 524288 KB. Space Avai l abl e: 401548 KB 23%Fr ee
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| SYBASE Si ze I nf or mat i on: |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Type Tot al Si ze Fr ee Space %Fr ee Space
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Dat a : 80 MB 72944 KB 89. 043 %
Log : 23 MB 23458 KB 99 %
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Space I nf or mat i on ( / t mp of t he machi ne) +
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Tot al Si ze: 2048000 KB. Space Avai l abl e: 366430 KB 17 %Fr ee
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| ORACLE Si ze I nf or mat i on: |
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
db t ot al = 276480. 0 KB
dat a used = 25296 KB ( 9%) .
Parameters of the db_check_space utility
Parameters of the db_check_space utility
loader
The loader utility is used to load default data to the CONTROL-M/EM database. This
utility should only be used if you ran a clean database operation and want to restore
default data to the tables.
To invoke the loader utility from the command line
1 Open a Command Prompt window (Microsoft Windows) or go to the command
line (UNIX).
2 Change the working directory to the CONTROL-M/EM home directory.
3 Enter the following command:
UNIX
ecs loader [-d directory | -f <fileName>] [-u <username> [-p <password>] [-db
<databaseName>] [-append] [-erase] [-diagon] [-h]
Table 68 db_check_space utility parameters
-U username User name. If not specified in the command line, you are prompted to
provide this information when the utility runs.
Notes:
The -U must be specified in uppercase.
If you intend to specify the -P parameter when running the utility, you
must also specify the -U parameter.
-P password Password. If not specified in the command line, you are prompted to
provide this information when the utility runs.
Notes:
The -P must be specified in uppercase.
If you intend to specify the -P parameter when running the utility, you
must also specify the -U parameter.
NOTE
This utility is also available from the root menu by selecting the 2 - Troubleshooting Menu
option and then the 1 - Database Troubleshooting option. For more information, see the
util
Windows
loader [-d directory | -f <fileName>] [-u <username> [-p <password>] [-db
<databaseName>] [-append] [-erase] [-diagon] [-h]
util
util is a multi-purpose utility that can perform the following functions from the
command line:
Export data from the CONTROL-M/EM database
Import data to the CONTROL-M/EM database
Delete the CONTROL-M/EM database
Clear the CONTROL-M/EM database
Build the CONTROL-M/EM database
Export a specified definition table
Import a specified definition table
Import CONTROL-M/Forecast data
Export CONTROL-M/Forecast data
Remove CONTROL-M/Forecast data (to save disk space)
The util utility is automatically installed on Microsoft Windows computers with the
CONTROL-M/EM Gateway component.
Table 69 loader utility fields
Field Description
-d directory The directory in which the files with the default data is located.
-f fileName The full path of the file in which the loaded data is saved.
-u username Database user name. Optional
-p password Database user password. Optional
-db
databaseName
The name of the database to which you want to load the data. Optional
-append Append the data to the information that already exists.
-erase Erase the data that already exists.
-diagon Displays the loader utility information to your screen.
-h Displays the loader utility usage.
DB_ARGS database arguments
To invoke the util utility from the command line
1 Open a Command Prompt window (Microsoft Windows) or go to the command
line (UNIX).
2 Change the working directory to the CONTROL-M/EM home directory.
3 Enter one of the following commands:
util DB_ARGS function functionParameters
On UNIX
ecs util DB_ARGS function <functionParameters>
Table 70 describes the DB_ARGS database arguments.
Table 71 describes the functions of the util utility.
Table 72 describes the function parameters.
DB_ARGS database arguments
All the functions use DB_ARGS in the following format:
[-D database][{-U user -P password} |-pf fileName][-S server][-T level]
[-dbms system][-dbtimeout sec][-dbfile path]
Table 70 DB_ARGS database arguments fields
Field Description
-D database Name of database on which to perform the operation. Default: the
CONTROL-M/EM database defined during installation
-U user Database user name
-P password Database user password
-pf fileName Flat file containing an unencrypted username and password on separate lines
in the format:
user=userName
password=password
Note: If both -U and -pf are specified, an error message is generated. If only -U
is specified, an online prompt is issued for the password. If neither is
-S server Name of database server. Default: database server defined during installation.
-T level Database debug level (Range: 1 - 9)
Functions and syntax of the util utility
-dbms system Database management system type. Valid values: Sybase, Oracle
Note: If you are using an MSSQL database, specify Sybase.
-dbtimeout
sec
Database timeout interval, in seconds
-dbfile path Full path name for the database debug report. If the file already exists, it is
overwritten. Default path and filename: home_directory/DB_time/date.log
NOTE
For UNIX, add ecs and a space before specifying util. For example:
ecs uti l DB_ARGS <bui l dSchema> [ - cdbg {1 - 5}] [ - T 3]
Table 71 util utility functions (part 1 of 3)
Function Description
-export Exports job processing definitions, Calendars, CONTROL-M data, and so
on, from the CONTROL-M/EM database to an ASCII text file.
The data in the mentioned file is separated by field and record delimiters.
For more information, see Fields and records delimiters on page 196.
Syntax:
util <DB_ARGS> -export [-silent] [-cdbg {1 - 5}] {-type <all | def | cal
| sys |dc | user | alert | gc | maint | collect | view |filter | report
| hier | audit | history | forecast | bim | statistics>} {-type net
{-name {<name>}}} [-file <file> | -file - | -dir <dir>]
Notes:
If the database is exported to a file, you are prompted for a filename.
If you use FTP to transfer the exported file, use binary mode.
If -type all is specified history information is not returned. Specify
-type history separately, if it is required.
Table 70 DB_ARGS database arguments fields
Field Description
-import Imports job processing definitions, Calendars, CONTROL-M data, and so
on, from an ASCII text file to the CONTROL-M/EM database.
Syntax:
util <DB_ARGS> -import [-silent] [-replace] [-cdbg {1 - 5}] {-type
<all | def | cal | sys |dc | user | alert |gc | maint | collect | view
|filter | report | hier | audit |history | forecast | bim | statistics>}
{-type net {-name {<name>}}} [-file <file> | -file - | -dir <dir> | -dir
<fileList>]
Notes:
If you use FTP to transfer the imported file, use binary mode.
Stop all CONTROL-M/EM components before doing this operation.
If -type all is specified history information is not returned. Specify
-type history separately, if it is required.
Warning:
If -replace is specified, your data may be destroyed. Use -replace with
extreme caution. Any database element that is replaced is overwritten
with data that you supply in the input file. If -replace is not specified
and the database attempts to write data that already exists, the utility
terminates and a rollback is performed on data written during the
write operation.
Gateway(s) should not be running.
-delete Deletes the specified database table.
Syntax:
util<DB_ARGS> -delete [-silent] [-cdbg {1 - 5}]{-name {<name>}}
Note: Stop all CONTROL-M/EM components before doing this operation.
-clean_database Deletes all database tables.
Syntax:
util <DB_ARGS> -clean_database [-silent] [-cdbg {1 - 5}]
Notes:
This utility completely deletes database tables. Use it only with
extreme caution. BMC Software recommends that you backup the
database before issuing this command.
-build_schema Builds the CONTROL-M/EM database. It defines the structure and the
type of contents of each data element in the database.
Syntax:
util DB_ARGS -build_schema [-cdbg {1 - 5}]
Notes:
To load default data to the CONTROL-M/EM database, run the
loader utility.
-defexport Exports the specified definition table to an ASCII text file.
Syntax:
uti l <DB_ARGS> - def export [ - cdbg {1 - 5}] - tabl e
<tablename> - dcname <newDcname> [ - l i brary <newLibrary>]
- f i l e <file>
Notes:
If you use FTP to transfer the exported file, use binary mode.
-defimport Imports the specified CONTROL-M/EM definition table from an ASCII
text file to a specified database table.
Syntax:
uti l <DB_ARGS> - def i mport [ - repl ace | - append]
[ - cdbg {1 - 5}] [ - tabl e <newTablename>] [ - dcname
<newDcname>] [ - l i brary <newLibrary>] - f i l e <file>
Notes:
If you use FTP to transfer the imported file, use binary mode.
Parameters of the util utility functions
Table 72 util utility function parameters (part 1 of 2)
-silent Suppresses application messages.
-replace Overwrites existing data in the specified table.
Note:
Use -replace with extreme caution. Any database element that is replaced is
overwritten with data that you supply in the input file. If -replace is not
specified and the database attempts to write data that already exists, the
utility terminates and a rollback is performed on data written during the
write operation.
-cdbg Debug level. Range from 1 to 5 (highest level).
Use this option only when instructed to do so by BMC Software Customer
Support. Using this option can slow performance and use extra disk space.
-type Name of the CONTROL-M/EM component that is configured by one or
more of the following:
all All application data. Default.
def Job processing definition data.
cal Calendar data.
sys System data of the application.
dc Data center definition data.
user CONTROL-M/EM user data and authorizations.
alert Alert data for the CONTROL-M/EM database.
gc Global conditions prerequisite conditions that are passed
between CONTROL-M installations by CONTROL-M/EM.
maint Maintenance tables
collect Collection definitions
view ViewPoint definitions
filter Filter definitions
report Report definitions
hier Hierarchy definitions
audit Audit data
history History data
forecast Forecast tables
bim BMC Batch Impact Manager tables
statistics Exceptions data
Note: More than one -type can be used.
Example 1: Export job processing definitions
The following command exports job processing definitions from the default
CONTROL-M/EM database to the ASCII data file production for database user
dbuser1, whose password is secure01:
- type net Type of CONTROL-M/EM net.
-name Name of the CONTROL-M/EM net that is identified by the
following parameter:
name Name of the net. You can use wildcards when
specifying a name:
* represents a string of any length
? represents one character
Examples:
SSIMU simulation net SIMU
A??????23\* all active nets of netgroup 23
-file Specifies the details of the source or destination file.
file Name of the source or destination file.
-file - Exports to standard output. Default: user monitor
Imports from standard input. Default: user keyboard
-dir Exports or imports from a specified directory.
dir Directory of the source or destination file if different from
CONTROL-M/EM home directory.
file-list List of text (ASCII) files to be exported or imported,
in the format: filename... filename
-name CONTROL-M/EM net identified by the following name:
name Name of the CONTROL-M/EM net.
-table Scheduling table identified by the following tablename:
tablename Name of the scheduling table.
-dcname CONTROL-M identified by the following data center name:
dcname Name of the data center.
-library Type of CONTROL-M/EM library identified by the following library type:
library Type of CONTROL-M/EM library.
-append Append the data to the specified table.
ut i l - U dbuser 1 - P secur e01 - expor t - t ype def - f i l e pr oduct i on
Table 72 util utility function parameters (part 2 of 2)
Example 2: Import calendar data
The following steps are used to import calendar data from the ASCII data file
month_cal to the default CONTROL-M/EM database:
1. Stop all CONTROL-M/EM gateways.
2. Specify the following command:
Example 3: Delete database contents
The following command deletes the contents of the table A0301190CT_BJOB from
database CITIES:
Example 4: Clean the database
The following command cleans database WAGE_RATES:
Example 5: Build a database schema
The following command builds a new schema for database PAYROLL:
Example 6: Export a database definition table
The following command exports the INVENTORY definition table for data center
WIP from the default CONTROL-M/EM database to the file wip_stores:
ut i l - U dbuser 1 - P secur e01 - i mpor t - t ype cal - f i l e mont h_cal
ut i l - D CI TI ES - U dbuser 1 - P secur e01 - del et e - name A0301190CT_BJ OB
ut i l - D WAGE_RATES - U dbuser 1 - P secur e01 - cl ean_dat abase
ut i l - D PAYROLL - U dbuser 1 - P secur e01 - bui l d_schema
ut i l - U dbuser 1 - P secur e01 - def expor t - t abl e I NVENTORY \
- dcname WI P - f i l e wi p_st or es
Example 7: Import a database definition table
The following command imports the WORK_IN_PROGRESS definition table
(replacing any data that may have been in this database table) from file wip_stores to
the PRODUCTION database:
Fields and records delimiters
During the export process, the util utility reads the fields and records delimiters from
the Defaults.rsc configuration file or uses default values, if nothing defined in
Defaults.rsc. The delimiters are stored in the created export file.
During the import process, the util utility reads the delimiter values from the export
file and does not refer to the configuration file.
The default values for the records and fields delimiters are as follows:
\x1E\x1B\x1F - records delimiter
\x1C\x1B\x1D - fields delimiter
If you are using either of these sequences in your data, add or modify the following
lines in the Defautls.rsc file using different values:
nameval ue * ut i l _exp_r ecor ds_del i mi t er <r e c o r d s De l i mi t e r >
nameval ue * ut i l _exp_f i el ds_del i mi t er <f i e l d s De l i mi t e r >
In the following example, the definitions in Defaults.rsc are set so that the records
delimiter is a sequence of vertical tab, horizontal tab, and escape and the fields
delimiter is defined as the form feed character.
Table 73 shows the characters you can use for the records delimiter and fields
delimiter, respectively.
ut i l - D PRODUCTI ON - U dbuser 1 - P secur e01 - def i mpor t \
- r epl ace - t abl e WORK_I N_PROGRESS - f i l e wi p_st or es
EXAMPLE
namevalue * util_exp_records_delimiter \x0B\t\x1B
namevalue * util_exp_fields_delimiter \f
Table 73 Records and fields delimiter values
Character code Description
\n New line (if it is the only character in records delimiter)
\t Horizontal tab
em_SQL
The records and fields delimiters must follow these rules:
a value between 1 and 5 characters.
The records delimiter must not be a substring of the fields delimiter, and vice
versa.
\0 and blank characters are not valid values. They are not identified and may
cause unexpected delimiters to be used.
em_SQL
The em_SQL utility enables you to connect to the database from the command line.
This utility is automatically installed on Microsoft Windows computers during
installation of the GUI Server component.
Syntax of the em_SQL utility
em_SQL -U username -P password
\x0B Vertical tab
\f Form feed
\x1B Escape
\x1C File separator
\x1D Group separator
\x1E Record separator
\x1F Unit separator
NOTE
SQL, U, and P must be specified in uppercase.
Table 73 Records and fields delimiter values
Character code Description
Parameters of the SQL utility
Parameters of the SQL utility
To invoke the em_SQL utility from the command line
em_SQL -U username -P password
Communication is established with the database and the database prompt is
displayed.
Table 74 SQL utility parameters
-U username User name.
Note: The U must be specified in uppercase.
-P password Password.
Note: The P must be specified in uppercase.
Chapt er
8
8 Build database utility
build_db (build database) utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Existing server creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Verification of existing components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Creating a Sybase database on an existing database server . . . . . . . . . . . . . . . . . 202
Configuring a Sybase client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Configuring a Sybase client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Parameters of the build_db utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
build_db log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Parameters of the build_db log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
build_db (build database) utility
build_db (build database) utility
The build_db utility enables you to define a CONTROL-M/EM Sybase database, or
configure a Sybase database client if they become corrupted or if you want to move
the database to a different server.
The following "build database" modes are available:
Existing server creation
The Existing build database mode creates a new CONTROL-M Sybase database on
an existing Sybase database server. The existing Sybase database server must be
running during the creation of the CONTROL-M/EM database.
If you are recreating an existing Sybase database that was corrupted, you must first
perform a cleanup of the corrupted database components. For more information, see
Existing database cleanup on page 201.
Verification of existing components
1 Obtain the System Administrator password.
2 Obtain a database name, a System Administrator login name, and a System
Administrator password for the new CONTROL-M/EM database. Use the
sp_helpdb command on the remote server to verify that the database name is
unique for the Sybase database server.
3 Verify that the device file you want to define does not exist by running the
command: ls filename on the remote server.
Table 75 Build database modes
Existing Defines a CONTROL-M/EM database on an existing Sybase database
server.
Client Configures a Sybase client so it can communicate with a remote Sybase
server. This mode can be used only after the CONTROL-M/EM database has
been defined on the Sybase database server.
NOTE
When creating more than one database on the same Sybase database server, the database
name and the database owner name must be unique for each database.
Existing database cleanup
4 Use the following command on the remote server to check the values of the
parameters in Table 76: sp_configure parameter_name. If you change any of these
parameters, the change is not implemented until you restart the database.
Existing database cleanup
1 Log on to the Sybase database server as the sa user.
2 Use the sp_helpdb command to determine if the database exists.
3 If the database exists, use the following command to drop (remove) the database
and database owner (DBO):
drop database databaseName
sp_droplogin dboName
4 Use the following command to check which devices were dropped from the server:
sp_helpdevice
go
5 If data or log devices associated with the CONTROL-M database are still listed,
drop them using the following command:
sp_dropdevi ce deviceName
go
6 Delete the files, if any, that are associated with the dropped elements.
Table 76 Sybase database server parameters minimum values
Parameter
Small
< 80 MB
Medium
80-200 MB
Large
> 200 MB
Number of locks 30,000 30,000 40,000
Number of User Connections
Total number of connections to the Sybase database server
required for all applications including CONTROL-M/EM
60 100 200
Max Memory 32, 768 40,000 100,000
NOTE
If you are not recreating a corrupted existing Sybase database server, you should continue
with Creating a Sybase database on an existing database server.
Creating a Sybase database on an existing database server
Creating a Sybase database on an existing database server
1 Prepare the information you will need for running the build_db utility. Parameters
for this utility are listed in Table 77 on page 203.
2 From the command line of the account on which the existing Sybase database
server resides, enter the command: build_db/build_db.sh
3 When asked to select the "CONTROL-M component for which you want to install
the Sybase component", select CONTROL-M/Enterprise Manager.
4 Select the Existing build database mode to create an empty CONTROL-M/EM
database on an existing Sybase database server. The name and location of the
existing Sybase database server and the system administrators name and
password must be specified.
5 Follow the instructions on the screen, filling in the prompts as necessary. Upon
completion, the following message is displayed:
I nst al l at i on of CONTROL- MSybase dat abase component compl et ed
successf ul l y.
Configuring a Sybase client
To configure a Sybase client
1 Prepare the information you will need before running the build_db utility.
Parameters for this utility are listed in Table 77 on page 203.
2 From the command line of the account on which you want to create the Sybase
database client, enter the command: build_db/build_db.sh
3 When asked to select the "CONTROL-M component for which you want to install
the Sybase component", select CONTROL-M/Enterprise Manager.
4 Select the Client build database mode. This mode configures a CONTROL-M
Sybase database client on the local computer after verifying the existence of a
CONTROL-M/EM database on an existing database server.
5 Follow the instructions on the screen, filling in the prompts as necessary. Upon
completion, the following message is displayed:
I nst al l at i on of CONTROL- M Sybase dat abase component compl et ed
successf ul l y.
build_db parameters
build_db parameters
build_db parameters are described in Table 77. The most recently used value for each
parameter is its default. Determine the required values before running this utility.
Parameters of the build_db utility
Table 77 build_db parameters
Sybase Server Host Name Host name of the computer on which the Sybase Database server is created.
Database Server
Administrator Password
Password of the CONTROL-M Sybase database server administrator
Database Name CONTROL-M/EM database name. Maximum length: 30 characters. The
name must begin with an alphabetic character. No spaces are allowed.
Database Owner Login Login name of the CONTROL-M/EM database owner.
Database Owner Password Login password of the CONTROL-M/EM database owner.
Sybase Server Query Port
Number
The port that the computer on which the CONTROL-M Sybase database
server is created uses for external communication.
Sybase Server Backup Port
Number
The port that the CONTROL-M Sybase database backup server
component uses for external communication
Master Device Full Path File
Name
Full path name of the CONTROL-M Sybase database server.
Sybsystemprocs Device Full
Path File Name
Full path name of the CONTROL-M Sybase database server system
processes database.
Temporary Device Full Path
File Name
Full path name of the CONTROL-M Sybase database server temporary
database.
Data Device Full Path File
Name
Full path name, including the logical device name, of the CONTROL-M/EM
database. You must specify a new filename in an existing directory path on
the computer where the CONTROL-M Sybase database server is created.
Log Device Full Path File
Name
Full path name, including the logical device name, of the database log. You
must specify a new filename in an existing directory path on the computer
where the CONTROL-M Sybase database server is created.
Database Size Size of the CONTROL-M/EM database in megabytes.
Data Device Size Space in MB for the data portion of the CONTROL-M/EM database.
Log Device Size Space in MB for the transaction log. BMC Software recommends that 30% of
the space be allocated for the CONTROL-M/EM database.
Temporary Device File Size Size of the temporary database in megabytes.
build_db log
build_db log
After creating the Sybase database components, a build_db log is created in the home
directory of the CONTROL-M/EM account:
homeDir BMCINSTALL/log/DRXX.versionNumber_user.log
Parameters of the build_db log
h o me Di r is the path of the CONTROL-M/EM user and versionNumber is the
CONTROL-M/EM version number.
Appendi x
A
A XML file preparation
Some CONTROL-M/EM utilities require input files written in XML.
XML files have the following characteristics:
XML is a structured format for organizing and specifying data.
Data in an XML file is classified by type.
Words enclosed in angle brackets (< >), called tags, are used to classify and
organize the data.
In the XML files used by the CONTROL-M/EM utilities, tags are used to classify job
processing definition, Calendar, Scheduling table, and group scheduling table
parameters, and their values.
CONTROL-M/EM utility commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Preparing an input file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
File structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Reserved characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
NOTE
You do not need to know XML to use these utilities. The instructions in this chapter provide
you with the information that you need to know to produce all utility files.
CONTROL-M/EM utility commands
CONTROL-M/EM utility commands
Each utility is composed of a combination of at least two of the following parts:
an invocation command
an input file containing either data to enter into the CONTROL-M/EM database or
arguments for selecting specific data from the database
an output file containing data specified in the arguments file, if it was used
optional switches for controlling how the utility runs
For example, the defjob utility has three parts; the invocation command, a file of job
processing definitions that are imported into the CONTROL-M/EM database, and an
optional switch. You prepare the file containing the job processing definitions.
The exportdefjob utility uses an invocation command, a file containing arguments for
specifying the job processing definitions that are exported from the
CONTROL-M/EM database, an optional switch, and an output file containing the
exported job processing definitions. You prepare the arguments file. The output file is
created by the exportdefjob utility.
Preparing an input file
CONTROL-M/EM utilities read input text files that are used to enter information into
the CONTROL-M/EM database. CONTROL-M/EM export utilities export data from
the database in text files. Both the input and the output files are formatted with XML.
For example, the defcal input file specifies new Calendar definitions to enter into the
database.
File structure
The different parts of the input file are defined by tags composed of punctuation
marks. The TERMS input file displayed in the example selects all non-cyclic jobs with
job name Job5. The action performed on the selected jobs is determined by the type of
utility that is calling the TERMS file. Using this TERMS file with deldefjob deletes all
job processing definitions in the database for non-cyclic jobs with job name Job5.
NOTE
The indentations used to format the input file help you understand the hierarchical
relationships between elements in the file. These indentations are not mandatory and do not
affect how the file is processed.
File structure
Example
This file contains one TERMS statement. The statement specifies that non-cyclic jobs
with Job Name Job5 are to be selected.
The statement begins with the word TERMS enclosed in angle brackets (<TERMS>).
The end of the file is indicated by the closing TERMS tag. That this is the end of the
TERMS statement is indicated by the presence of the slash (/), so that the closing
statement looks like </TERMS>.
Between the <TERMS> tags is a search term for identifying and selecting specific job
processing definitions. It is indicated by the tags <TERM></TERM>. Between the
TERM tags are the parameters of the search, indicated by the <PARAM/> tag. All the
attributes of the tag are contained within the single set of brackets. No closing tag is
needed. As a result, the slash (/) is included in the single tag, preceding the closing
angle bracket, <PARAM/>.
As noted, the PARAM tag contains the search terms, NAME, OP, and VALUE.
NAME is the name of a job processing definition parameter.
OP is an operator. The most common operators are described in Table 78.
VALUE is the value of the parameter to which a comparison is being made.
<TERMS>
<TERM>
</ TERM>
</ TERMS>
EXAMPLE
NAME="JOBNAME" OP="EQ" VALUE="Job5" searches for job processing definitions
that have the Job Name, Job5.
Table 78 Utility operators
Operator Description
EQ Equals. Select cases that include the specified value.
NEQ Not equal. Select cases that include any value different from the one specified.
LIKE Similar. Select cases that have an attribute common to the one specified.
Note: You must use a wildcard, such as * in the value that you specify.
For example:
J OBNAME LI KE="J OB1*"
selects all jobs with a job name that begins with JOB1. JOB13 would be selected,
but not JOB25.
File structure
What to include in the file
Each utility is described in this book with a table of elements (job, calendar, and table
parameters) and attributes (subparameters). Use the valid values described in the
tables, making sure to use the same case and spelling.
If the valid value is a string, see the description of the appropriate parameter in the
CONTROL-M Job Parameter and Variable Reference Guide for information about valid
values and their formats.
Validating your file
The contents of an XML file are determined by a set of criteria that are contained in a
document definition type file. This file has a .dtd extension.
The .dtd file is used by CONTROL-M/EM to validate the input file (or arguments file)
when the utility runs.
The .dtd file includes the following information:
Names of all of the elements and attributes that can be entered in an input or
arguments file in XML format.
Valid values for an element or attribute.
Whether the valid values for an element or attribute are mandatory or optional.
Hierarchical relationship between the various elements and attributes in the file.
NOTE
When working in an I18N environment, the following header must be placed at the top of the
argument file:
For example:
<?xml ver si on=" 1. 0" encodi ng=" UTF- 8" ?>
<TERMS>
<TERM>
</ TERM>
</ TERMS>
File structure
Formatting and value information for CONTROL-M parameters is described in the
CONTROL-M Job Parameter and Variable Reference Guide.
CONTROL-M/EM utility .dtd files
Each utility input file has its own .dtd file. The TERMS arguments files share the same
.dtd file. Utility .dtd files are stored in the CONTROL-M\ emHome\ecscli\Resource
directory (on Microsoft Windows).
To create a file
1 Open any text editor or an XML editor.
2 Enter the data for the utility that you are using, the format described in the
parameter description tables, and examples that are provided with the utility.
3 Check the syntax of the file for errors. If errors remain, they are identified when the
file is submitted to the utility. Possible errors include:
Misplaced or missing tag.
Misplaced or missing part of a tag (for example, a missing slash /).
Parameter value that is not specified as a valid value for that parameter (for
example, the letter Y instead of a 1.
i
4 Save the file.
Table 79 CONTROL-M/EM utility .dtd files
File name Description
copycal.dtd Validates the copydefcal input file.
copyjob.dtd Validates the copydefjob input file.
defcal.dtd Validates the defcal input file.
defjob.dtd Validates the defjob input file.
deftable.dtd Validates the deftable input file.
duplicatejob.dtd Validates the duplicatedefjob input file.
terms.dtd Validates exportdefjob, exportdefcal, and exportdeftable argument files.
update.dtd Validates the updatedef input file.
NOTE
CONTROL-M/EM validates every file you submit, rejecting those that have errors. When a
file is rejected, the lines containing errors are specified for you.
Reserved characters
Reserved characters
Certain characters are reserved for formatting the XML file. These characters cannot
be used in job parameter values submitted with the XML-based utilities.
Instead, each reserved character must be replaced by a code. The reserved characters
and the codes they are replaced by are listed in Table 80.
Example: Using reserved character codes in an XML file.
Incorrect:
INCOND NAME="if5<6run" ODATE="ODAT" AND_OR="AND" OP="("/
Correct:
INCOND NAME="if5<6'run'" ODATE="ODAT" AND_OR="AND" OP=
"("/
Wildcards
Multiple jobs can be selected and copied using the * (asterisk) wildcard character to
represent multiple values. The asterisk is used to represent zero or more
alphanumeric characters. An asterisk can be used to replace characters in the middle
of an expression.
NOTE
The file must be saved as a text file. It can have any file extension you want. However, BMC
Software recommends that you use .xml.
Table 80 Reserved character codes
Character Replacement code
" (double-quote) "
(single-quote, apostrophe) '
< (left-angle bracket) <
> (right-angle bracket) >
& (ampersand) &
Note: The ampersand character can be used in the character
replacement codes.
Reserved characters
The asterisk in search criteria
Example 1
The job name of a specific job definition is AAABBB. If you include the any of the
following arguments in an updatedef utility argument file, you select job AAABBB:
Example 2
There are three job processing definitions. Their Job Names are:
AAABBB, AAACCC, and BBBCCC
The following argument selects jobs AAACCC and BBBCCC, and selects any other
jobs with a Job Name that ends with the letters CCC.
The asterisk in find/replace operations
The asterisk has a special function when used in "find and replace" operations in
selected utilities. The following utilities use find and replace operations:
copydefcal
copydefjob
duplicatedefjob
updatedef
In the FROM (find) statement of an argument, an asterisk replaces a text string
(as shown in the example above). The asterisk in the TO statement of the argument
represents the same string as the asterisk in the FROM statement of the argument.
The placement of the asterisk can be changed.
NOTE
Only one asterisk can be used in an expression.
<J OB_NAME FROM=" AAABBB" / >
<J OB_NAME FROM=" *BBB" / >
<J OB_NAME FROM=" AAA*" / >
<J OB_NAME FROM=" *CCC" / >
Reserved characters
Example 1
AAABBB, AAACCC, BBBCCC
Modify the job names of some of these jobs using the following argument:
Job AAACCC becomes Job AAADDD
Job BBBCCC becomes Job BBBDDD
Job AAABBB is not modified.
Example 2
AAABBB, DDDCCC, BBBCCC
Job DDDCCC becomes Job DDDDDD
Job BBBCCC becomes Job DDDBBB
Job AAABBB is not modified.
<J OB_NAME FROM=" *CCC" TO=" *DDD" / >
<J OB_NAME FROM=" *CCC" TO=" DDD*" / >
Index 213
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
Symbols
$ECS_USER
environment variable 185
* 210
.dtd file
CONTROL-M/EM Utility .dtd Files 209
description 208
validating XML files 208
A
administration agents
shutdown using ctl 171
stopping using ctl 164
alert processing
gateway check errors 157
-all
Configuration Management Server parameter 170
Gateway parameter 165
Global Alerts Server parameter 169
Global Conditions Server parameter 167
GUI Server parameter 168
-append
util utility function parameters 194
application support
Oracle Applications 15
SAP 15
argFileName
loopdetecttool parameter 86
AS/400. See iSeries (AS/400)
asterisk
as a wildcard in Find/Replace operations 211
as a wildcard in search criteria 211
using as a wildcard 210
AUTHOR parameter
copydefjob utility 49
defjob utility 34
deftable utility 140
duplicatedefjob utility 68
authorization for copying or modifying entities 16
B
Batch Impact Manager server
ctl utility 171
BMC Batch Impact Manager
using the Health Check utility 173
BMC Software, contacting 2
build database utility 200
build_db log 204
build_db parameters 203
build_db utility 200
-build_schema
util utility functions 192
building
CONTROL-M/EM database 195
building a CONTROL-M/EM database
util utility 188
C
-C CMS
-C Gateway
calendar definition
importing into the CONTROL-M/EM database 122
calendars
cli utility 25
copying 127
downloading 25
exporting 130
handling using the cli utility 25
importing 122
uploading 25
-cdbg
characters
reserved for formatting the XML file 210
check_gtw utility
description 157
invoking 157
parameters 158
test mode 158
check_gtw_ue user exit 158
-clean_database
cleaning
ENTERPRISE/CS database 195
clearing a database
util utility 188
cli utility 19
installed automatically 20
invoking 20
job deletion parameters 28
parameters 20
Client mode
build_db utility 200, 202
-cmd
ctl command parameter 164
-cmdstr
CMSConfiguration Management Server 170
command line interface
batch utility 19
parameter formats 18
components
verification of existing 200
configuration
Sybase client 202
Configuration Agent 170
Control Shell
ctl command line utility 162
CONTROL-M/EM
using the Health Check utility 173
CONTROL-M/EM administrator
password encryption 159
CONTROL-M/EM components
shutdown using ctl 171
stopping using ctl 164
CONTROL-M/EM database
building 195
check size with db_check 184, 185
importing calendar definitions 122
transaction log monitoring with db_check 184
verify integrity with db_check 184
CONTROL-M/Forecast
cleaning out run information 181
using Health Check utility for 173
conventions 17
converting
Scheduling table to Group Scheduling table 58
copydefcal utility 127
arguments file 128
copycal.dtd 209
copyjob.dtd 209
examples 129
invoking 127
parameters 129
rules 128
copydefjob utility 45, 46
arguments file 46
arguments file parameters 47
AUTHOR parameter 49
examples 58
invoking 45
rules 47
switches 46
copying
calendar definitions 127
job definitions 45, 63
jobs to a group scheduling table 58
creating
calendar definitions 122, 127
job definitions 30, 45, 63
creation
existing Sybase server 200
Sybase database 202
cryptocli utility
creating encrypted version of a password 159
operational mode 159
parameters, operational mode 160
trial mode 159
ctl
-cmd command switch 164, 166, 167, 168, 171
command syntax 163
description 162
Global Alerts Server 169
Global Conditions Server 167
GUI server 168, 171
parameter descriptions 163
shutdown command 171
stop command description 164
ctm_data_collector utility
examples 180
parameters 175
ctmem:condition
loopdetecttool output file parameter 88
ctmem:job
ctmem:loop
ctmem:loops
tags 88
ctmem:message
customer support 3
D
Data Device Full Path File Name parameter
Data Device Size parameter
database
util utility parameters 189
Index 215
Database Name parameter
Database Owner Login parameter
Database Owner Password parameter
Database Server Administrator Password parameter
Database Size parameter
databases
arguments parameter (db_args) 189
db threshhold % parameter 185
db_args parameter
util utility 189
db_check utility 184, 185
command for running 185
db threshhold % parameter 185
log threshold % parameter 185
parameters 185
working only on database on Sybase Adaptive server
184
db_check utility functions
check available database space 184
report database size 184
transaction log monitoring 184
verify database integrity 184
db_check_space utility 185
invoking 186
parameters 187
db_check_space utility functions
check available database space 185
check available database space as a percentage of total
database size 185
report database size 185
-dc
-dcname
debugging
Keep Alive messages 166
util utility 193
defcal utility 122
defcal.dtd 209
examples 125
input file 123
invoking 122
parameters 122
-defexport
-defimport
defining
see also creating
defjob utility 30
AUTHOR parameter 34
defjob.dtd 209
example 44
input file parameters 33
input file rules 32
invoking 31
job definitions written in XML 32
parameters 32
switches 32
AUTHOR parameter 140
deftable.dtd 209
examples 147
input file 138
invoking 136
parameters 137, 138, 139
rules 138
switches 137
deldefjob utility 60
arguments file 61, 64
examples 62
invoking 60
parameters 61
rules 61
-delete
deleting
from CONTROL-M/EM database 195
job definitions 27
jobs definitions (in batch) 60
parameters of the cli utility 28
deleting a database
util utility 188
-diagon
documentation
accessing online 13
conventions 17
online 13
printed 13
related publications 12
downloading
calendars 25
scheduling tables 24
drop database command 201
arguments file 65
AUTHOR parameter 68
duplicatejob.dtd 209
examples 79
invoking 64
rules 65
switches 64
dwl
ctl download command 166
E
ecs
emenablepriv utility 17
EnableAuthorEdit 32, 46, 65, 98, 137
EQ
utility operator 207
erase_audit_data
description 79
examples
copydefjob 58
defcal utility 125
defjob 44
deldefjob 62
exportdefcal utility 133
exportdeftable utility 152
util utility 194
existing components
verification 200
Existing mode
build_db utility 200, 202
existing Sybase server
creation 200
-export
arguments file 132
examples 133
invoking 131
parameters 132
rules 132
terms.dtd 209
exportdefjob utility 81
invoking 81
rules 82
terms.dtd 209
arguments file 151
examples 152
invoking 149
parameters 151
exporting
calendars 130
definition table 195
from CONTROL-M/EM database 194
job processing definitions 81
exporting CONTROL-M/Forecast data
util utility 188
exporting database data
util utility 188
exporting database definition table
util utility 188
F
-file
forcing
into a Group Scheduling table 26
job 26
using the cli utility 24, 26
format
CONTROL-M/EM utilities 205
G
Gateway
unavailable 158
Gateway Verification utility
checking availability of gateways 157
gateways
checking (check_gtw) 157
Global Alerts Server
ctl utility 169, 170
Global Conditions Server
ctl utility 166, 167
Group Scheduling table
copying jobs from a Scheduling table 58
forcing a job into 26
Group Scheduling tables
updating 97
group scheduling tables
importing 136
modifying with updatedef 97
updating 97
GUI server
ctl utility 168
guiServerName
H
parameters 175
running from the command line 174
running using the config.ini file 174
scanning and collecting information 173
I
-import
importing
calendar definitions 122
definition tables 196
Index 217
job definitions 30
to CONTROL-M/EM database 195
importing CONTROL-M/Forecast data
util utility 188
importing database data
util utility 188
importing database definition table
util utility 188
invoking
copydefjob 45
defcal 122
defjob utility 31
deldefjob 60
duplicatedefjob 64
exportdefjob 81
loader utility 187
updatedef 97
util utility 189
J
job
forcing 26
ordering with the cli utility 27
job definition
deleting by Mem Name 27
job definitions
deleting 27
job processing definitions
deleting 60
exporting 81
updating 97
JOBISN value 30
jobs
copying 45, 63
creating 30
L
level
-library
life check
ctl 164
life_check
ctl command 164
LIKE
Log Device Full Path File Name parameter
Log Device Size parameter
log file
log threshold % parameter 185
loopdetecttool
arguments file 86
loopdetecttool utility 84
rules 86
ls filename command 200
M
-M
Master Device Full Path File Name parameter
Max Memory parameter
minimum values 201
MaxAuditsToDelete
erase_audit_data 80
parameter 80
mcs.ini
cryptocli password modification 159, 160
password encryption 160
Mem Name parameter 27
migrate_dc utility 17
modes
modifying
see also creating
password 159
updatedef 97
monitoring
database log 184
transaction log 184
mySAP. See SAP
N
-name
NEQ
Number of locks parameter
minimum values 201
Number of User Connections parameter
minimum values 201
numDaysRetain
purge_runinfo parameter 181
O
Oracle Applications
application support 15
ordering
Scheduling tables 25
using the cli utility 27
outFileName
P
-P
ctl command parameter 161, 164, 182
SQL utility parameter 198
PARAM
loopdetecttool argument 87
parameter formats
command line interface 18
long format 18
short format 18
Parameters
loopdetecttool 85
parameters 46
copydefjob utility 46
db_check_space utility 187
db_check_utility 185
defcal utility 122
defjob utility 32
deftable utility 138, 139
deldefjob 61
exportdefjob 82, 86, 88
Health Check utility 175
updatedef 99, 100, 105
util utility 188, 189
password
util utility parameters 188, 189
passwordFile
passwords
encryption 159
path
-pf
ctl command parameter 161, 164
product support 3
purge_runinfo
utility 180
R
R/3. See SAP
-reg
removing CONTROL-M/Forecast data
util utility 188
-replace
reserved characters
for formatting the XML file 210
Result
Control Shell field 163
rules
exportdefjob 82
loopdetecttool 86
running Health Check utility 174
using the config.ini file 174
S
SAP
application support 15
Scheduling table
copying jobs to a Group Scheduling table 58
Scheduling tables
downloading 24
exporting 149
forcing 24
importing 136
ordering 25
updating 97
uploading 24
sec
security
cryptocli utility 159, 160
server
-silent
sp_configure parameter_name command 201
sp_dropdevice device_name command 201
sp_helpdb command 200, 201
sp_helpdevice command 201
Specify...
Index 219
SQL utility
description 197
starting
gateway debug message truncation 166
gateway host debug messages 166
stop
ctl command 164
stopping
component using ctl 164
Configuration Agent using ctl 164
ctl shutdown command 171
ctl stop command 164
gateway debug message truncation 166
support, customer 3
Sybase client
configuration 202
Sybase database
creation on existing database server 202
Sybase database server
parameters 201
Sybase Server Backup Port Number parameter
Sybase Server Host Name parameter
Sybase Server Query Port Number parameter
Sybsystemprocs Device Full Path File Name parameter
system
T
-table
tags
ctmem:loops 88
technical support 3
Temporary Device File Size parameter
Temporary Device Full Path File Name parameter
TERM
TERMS
text string
ctl -cmdstr command 167
-timeout
truncating
gateway debugging messages using ctl 166
-type
-type net
U
-U
ctl command parameter 161, 164, 182
SQL utility parameter 198
updatedef utility 97
invoking 97
switches 98
update.dtd 209
uploading
calendars 25
Usage
user
util utility parameters 188, 189
util utility
debugging with 193
description 188
examples 194
invoking 187, 189
parameters 188, 189
util utility function parameters
-append 194
-cdbg 193
-dcname 194
-file 194
-library 194
-name 194
-replace 193
-silent 193
-table 194
-type 193
-type net 194
util utility functions
build_schema 192
building a CONTROL-M/EM database 188
-clean_database 191
clearing database data 188
-defexport 192
-defimport 192
-delete 191
deleting a database 188
-export 190
exporting CONTROL-M/Forecast data 188
exporting database data 188
exporting database definition table 188
-import 191
importing CONTROL-M/Forecast data 188
importing database data 188
importing database definition table 188
removing CONTROL-M/Forecast data 188
util utility parameters
database 189
level 189
password 188, 189
path 190
sec 190
server 189
system 190
user 188, 189
utilities
authorization 16
ccmcli 160
check_gtw 157
command line interface 19
copydefcal 127
copydefjob 45
cryptocli 159
ctl 162
db_check 184
db_check_space 185
defcal 122
defjob 30
deftable 136
deldefjob 60
description 15
duplicatedefjob 63
emenablepriv 17
exportdefcal 130
exportdefjob 81
exportdeftable 149
file structure 206
format 205
Health Check 173
migrate_dc 17
operators list 207
preparing an XML input file 206
purge_runinfo 180
running automatically 15
SQL 197
types and descriptions 16
updatedef 97
using XML input files 16, 205
util 188
utility commands
composition 206
utility operators
EQ 207
LIKE 207
NEQ 207
V
validating
.dtd file 208
XML files 208
verification
existing components 200
verifying database integrity
with db_check utility 184
W
Western European language, special characters 48, 67, 100,
139
wildcard
asterisk 210
in Find/Replace operations 211
in search criteria 211
X
XML
creating a file 209
examples 207
file structure 206
use in utilities 16, 209
utility format 205
Notes
*68548*
*68548*
*68548*
*68548*
*68548*

EM Utility Guide 630 PDF

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

EM Utility Guide 630 PDF

Uploaded by

Copyright:

Available Formats

www.bmc.

You might also like