Professional Documents
Culture Documents
Utility Guide
Supporting
CONTROL-M/Enterprise Manager version 6.2.01
May 1, 2005
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 Telephone 713 918 8800 or Fax 713 918 8000
2101 CITYWEST BLVD 800 841 2031
HOUSTON TX 77042-2827
USA
Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
Copyright 2005 BMC Software, Inc., as an unpublished work. All rights reserved.
BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks
or trademarks of BMC Software, Inc.
Oracle is a registered trademark, and the Oracle product names are registered trademarks or trademarks of Oracle
Corporation.
All other trademarks belong to their respective companies.
BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this
information is subject to the terms and conditions of the applicable End User License Agreement for the product and the
proprietary and restricted rights notices included in this documentation.
Support website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at
http://www.bmc.com/support_home. From this website, you can
■ read overviews about support services and programs that BMC Software offers
■ find the most current information about BMC Software products
■ search a database for problems similar to yours and possible solutions
■ order or download product documentation
■ report a problem or ask a question
■ subscribe to receive e-mail notices when new product versions are released
■ find worldwide BMC Software support center locations and contact information, including e-mail addresses, fax
numbers, and telephone numbers
3
4 CONTROL-M/Enterprise Manager Utility Guide
Contents
About this book 9
How this book is organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Online and printed books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Access online books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Request additional printed books . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Command line conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 1 Introduction 13
Utilities described in this book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Utilities not described in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Contents 5
Chapter 6 Administration utilities 139
check_gtw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
cryptocli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
ctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Index 181
Tables 7
check_gtw_ue user exit parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
ctl parameters for the Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
ctl parameters for the Global Conditions Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
ctl parameters for the GUI Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
ctl parameters for the Global Alerts Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
ctl parameters for the Administration Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
ctl parameters for the BMC Batch Impact Manager Server . . . . . . . . . . . . . . . . . . . . . 153
Database maintenance utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
db_check utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
db_check_space utility parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
DB_ARGS database arguments fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
util utility – functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
util utility – function parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Build database modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Sybase database server parameters – minimum values . . . . . . . . . . . . . . . . . . . . . . . 169
build_db parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Utility Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
CONTROL-M/EM utility .dtd files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Reserved character codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Related documentation
The following BMC publications are relevant to CONTROL-M/EM.
■ CONTROL-M for OS/390 and z/OS User Guide is a guide to the CONTROL-M
Production Control System in a mainframe environment.
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.)
Conventions
The following abbreviations are used in this guide:
Abbreviation Description
Net CONTROL-M/EM Network
$HOME, home-directory 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.
{Option A|Option B} The vertical bar is used to separate choices. For example:
{AND|OR}
means that you specify either AND or OR.
[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
The following table lists the parameters that can be specified in both short and long
formats.
Most of the examples in this book use the lowercase, short format.
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 Administration facility, the utilities enable you to work
at computers that do not have the GUI or the Administration facility 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.
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/Control Module.
Chapter 1 Introduction 13
Utilities described in this book
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.
Types of utilities
Chapter 1 Introduction 15
Utilities not described in this book
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:
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 Administration Facility 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.
Microsoft Windows
NOTE
You must have proper security authorization for any of the actions you perform using cli.
Following are a series of commands that enable you to perform various tasks.
On Microsoft Windows
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
-TABLE_UPLOAD control-m_table [Odat] [library]
On Microsoft Windows
On Unix
On Microsoft Windows
cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout] [-DDMM]
-TABLE_FORCE control-m table [Odate] [library]
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
[-DDMM] -TABLE_FORCE control-m_table [Odate] [library]
On Microsoft Windows
cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout] [-DDMM]
-TABLE_ORDER control-m_table [Odate] [library]
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
[-DDMM] -TABLE_ORDER control-m_table [Odate] [library]
To upload a calendar:
On Microsoft Windows
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
-CAL_UPLOAD control-m_calendar
To download a calendar:
On Microsoft Windows
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
-CAL_DOWNLOAD control-m_calendar
To force a job:
On Microsoft Windows
cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout] [-DDMM]
-JOB_FORCE control-m_table job_name [Odate] [library]
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
[-DDMM] -JOB_FORCE control-m_table job_name [Odate] [library]
On Microsoft Windows
cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout] [-DDMM]
-JOB_FORCE_INTO control-m_table job_name sched_group [duplication]
[Odate] [library]
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
[-DDMM] -JOB_FORCE_INTO control-m_table job_name 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 Forces the job without adding it to a group scheduling
ALONE table.
GROUPID 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.
To order a job:
On Microsoft Windows
cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout] [-DDMM]
-JOB_ORDER control-m_table job_name [Odate] [library]
On Unix
ecs cli [{(-U db_user -P db_pass) | -pf password_file}] -h host_name [-t timeout]
[-DDMM] -JOB_ORDER control-m_table job_name [Odate] [library]
On Microsoft Windows
On Unix
On Microsoft Windows
On Unix
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.
NOTE
The cli utility uploads, downloads, orders, and forces jobs. It is described in Chapter 2,
“Command Line Interface utility (cli).”
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 unique number. 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.
- or -
defjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -SRC_FILE src_file_name [/a]
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.
Parameters
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.”
The following rules apply to the input file of the defjob utility:
Input file parameters for the defjob utility are described in Table 8.
TABLE_DSN [MVS 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
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
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"
DAYSCAL Name of a user-defined calendar used to specify a set of days. String. Optional.
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 [MVS only] Number of days to retain the job in the History Jobs file. String. Optional.
RETEN_GEN [MVS 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 (AND|OR) between the specified Schedule Tag criteria and the job’s own
_RELATIONSHIP 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.
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)
ACTIVE_FROM [MVS 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 [MVS 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 [MVS only] Indicates the JES2 workload management scheduling environment
_ENVIRONMENT associated with the job. String. Optional.
SYSTEM Identity of the system in which the job must be initiated and executed (in JES2).
_AFFINITY Identity of the processor on which the job must execute (in JES3). String. Optional.
REQUEST_NJE Specifies the node in the JES network on which the job is to execute. String. Optional.
_NODE
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.
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)
The following sample input file is used with the defjob utility.
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.
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 178.
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.
- or -
copydefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name [/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.
Parameters
Parameters of the copydefjob utility are described in Table 9.
When this file is invoked, job processing definitions are exported from the
CONTROL-M/EM database.
Each parameter that you specify must have a FROM value. This value is used as a
search criteria for selecting jobs to copy.
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.
■ 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 178.
■ 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.
Input file parameters for the copydefjob utility are described in Table 11.
TABLE Optional.
_USERDAILY Example:
TABLE_USERDAILY FROM="Job3"
FROM String. Mandatory.
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
CONTROL-M/Enterprise Manager Administrator Guide.
FROM String. Mandatory.
MEMLIB Name of the library/directory in which the job script resides. String. Optional.
Example:
MEMLIB FROM="Mem1"
FROM String. Mandatory.
CONFIRM Indicates that the job must be manually confirmed by the CONTROL-M/EM user
before it runs.
Example:
CONFIRM FROM="0"
FROM Mandatory. Valid values:
■ 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"
FROM String. Mandatory.
OVERLIB Name of an alternate job script library/directory. String.
Example:
OVERLIB FROM="lib3"
FROM String. Mandatory.
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"
FROM String. Mandatory.
DESCRIPTION Free text description of the job. String.
Example:
DESCRIPTION FROM="data backup from 120399"
FROM String. Mandatory.
DOCMEM Name of the file containing job documentation. String.
Example:
DOCMEM FROM="mem4"
FROM String. Mandatory.
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"
FROM Mandatory. 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.
Example:
IND_CYCLIC FROM="START"
FROM Mandatory. Valid values:
■ START
■ END
TAG Relationship (AND|OR) between the specified Schedule Tag criteria and the job’s
_RELATIONSHIP own basic scheduling criteria. This parameter is relevant only for jobs in a group
scheduling table. Optional.
Example:
TAG_RELATIONSHIP FROM="AND"
FROM Mandatory. Valid values:
■ AND
■ OR
SYSDB Determines whether one or multiple data sets are used to catalogue sysdata.
Example:
SYSDB FROM="1" TO="0"
FROM Mandatory. Valid values:
■ 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"
FROM String. Mandatory.
MINIMUM Minimum number of free partitioned dataset tracks required by the library specified
for the PDSNAME parameter. Integer. Optional.
Example:
MINIMUM FROM="5"
FROM Integer. Mandatory.
JAN, FEB, MAR, Months when the job can run. Optional.
APR, MAY, JUN, Example:
JUL, AUG, SEP, JAN FROM="0"
OCT, NOV, DEC FROM Mandatory. Not including a month is the same as including a month
having the value 0. Valid values:
■ 0 (Default)
■ 1
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 String. Mandatory.
FROM Limits the sysout handling operation to sysouts from the specified class. Optional.
Example:
FROM FROM="5"
FROM String. Mandatory.
ACTIVE_FROM [MVS only] Indicates the start of a period of time during which the job or group
scheduling table can be ordered. Optional.
Example:
ACTIVE_FROM FROM=”20040315”
FROM Mandatory. Date Format: YYYYMMDD
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.
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.
3 Create a copydefjob arguments file in which jobs in a scheduling table are copied
to the group scheduling table that you created:
A Open a text editor. Format the file using the specifications in “copydefjob
arguments file” on page 39.
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:
4 At the command line, enter the copydefjob utility command that uses the file that
you created in the previous step:
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.
defjobconvert
This utility converts defjob utility input files for versions before 6.0.01 to files that are
compatible with the defjob utility in CONTROL-M/EM version 6.2.01.
TIP
The defjobconvert utility does not check if the job definitions are valid. To verify that the data
is valid, import it to the ENTERPRISE/CS version 5.0.0x database and then select the
Validation option in the migration menu. This option generates the Readiness report. If there
are no errors or warnings in the report, you can run the defjobconvert utility on the input file.
NOTE
Verify that the defjob input file contains valid commands before running the defjobconvert
utility.
Parameters
Parameters of the defjobconvert utility are described in Table 12.
3 Press Enter.
NOTE
Each run of the defjobconvert utility converts only one input file. The utility must be run once
for each file that you want to convert.
Information display
The defjobconvert utility displays a counter and a number of messages to inform you
of the progress of the conversion process and to warn you of any potential errors.
Progress counter
After the defjobconvert utility is started, a counter on the command line indicates the
percentage of the file that has been converted.
Messages
Messages include:
■ Processing src_file_name.
Extra characters that were added to the source file to facilitate proper spacing or to
import notations are ignored. When such characters are encountered, defjobconvert
displays the Error: ignoring attributes message.
If a defjob input file has tabs and backslashes that indicate spacing and line breaks,
-USERNAME<CONTROL-M/EM log on name>\
then the Error: ignoring attributes message is displayed for each group of
characters that is not parsed by the utility. The presence of these characters in the
source file does not harm the output file.
Example 2: Convert file and save the output to the same directory
The defjob input file, jobs500.txt in the C:\utilfiles directory, is processed by the
defjobconvert utility. The resulting new defjob input file, jobs600.xml, is saved in
the same directory.
deldefjob
The deldefjob utility deletes specified job processing definitions from a scheduling
table in the CONTROL-M/EM database.
- or -
deldefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name [/a]
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
Delete job processing definitions with the name Job5 from the EM5NY data center.
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.
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.
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 178.
- or -
duplicatedefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name [/a]
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.
Parameters
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.
The following rules apply to the arguments file for the duplicatedefjob utility:
■ Only one DUPLICATEJOB parameter can be used in the arguments file. This
parameter must not contain more than one instance of each job parameter.
■ 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 178.
■ 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.
■ 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.
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.
CYCLIC Indicates whether the job is cyclic (to be run at regular intervals). Optional.
Example:
CYCLIC FROM="0" TO="1"
FROM Mandatory. 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.
Example:
CONFIRM FROM="0" TO="1"
FROM Mandatory. Valid values:
■ 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"
FROM String. Mandatory.
TO String. Optional.
OVERLIB Name of an alternate job script library/directory. String. Optional.
Example:
OVERLIB FROM="lib3" TO="lib4"
FROM String. Mandatory.
TO String. Optional.
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"
FROM Integer. Mandatory.
TO Integer. Optional.
DESCRIPTION Free text description of the job. String. Optional.
Example:
DESCRIPTION FROM="data backup from 120399" TO="data backup from 021400"
FROM String. Mandatory.
TO String. Optional.
DOCMEM Name of the file containing job documentation. String. Optional.
Example:
DOCMEM FROM="mem4" TO="Mem67"
FROM String. Mandatory.
TO String. Optional.
DOCLIB Name of library or directory containing the job documentation file. String.
Optional.
Example:
DOCLIB FROM="AcctFiles" TO="HRFiles"
FROM String. Mandatory.
TO String. Optional.
SHIFT Describes how to shift the scheduling date of the job. Optional.
Example:
SHIFT FROM="PREVDAY" TO="NEXTDAY"
FROM Mandatory. Valid values:
■ IGNOREJOB
■ PREVDAY
■ NEXTDAY
■ NOCONFCAL
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"
FROM Mandatory. Valid values:
■ START
■ END
SYSDB Determines whether single or multiple data sets are used to catalogue sysdata.
Optional.
Example:
SYSDB FROM="1" TO="0"
FROM Mandatory. Valid values:
■ 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"
FROM String. Mandatory.
TO String. Optional.
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"
FROM Integer. Mandatory.
TO 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.
Example:
CATEGORY FROM="*" TO="DAILY"
FROM String. Mandatory.
TO String. Optional.
JAN, FEB, MAR, Months when the job can run. Optional. Not including a month is the same as
APR, MAY, JUN, including that month with the value 0.
JUL, AUG, SEP, Example:
OCT, NOV, DEC JAN FROM="0" TO="1"
JUL FROM="0" TO="1"
FROM Mandatory. Valid values:
■ 0 (Do not run the job. Default)
■ 1 (Run the job.)
TO Optional. String.
ACTIVE_FROM [MVS 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”
FROM Mandatory. Date Format: YYYYMMDD
TO Optional. String.
ACTIVE_TILL [MVS 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”
FROM Mandatory. Date Format: YYYYMMDD
TO Optional. String.
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
TO Optional. String.
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.
FROM String. Mandatory.
Example:
SYSTEM_AFFINITY FROM=”SYS3”
TO String. Optional.
Example:
SYSTEM_AFFINITY FROM=”SYS3” TO=”SYS6”
REQUEST_NJE_ Node in the JES network on which the job is to execute.
NODE FROM String. Mandatory.
Example:
REQUEST_NJE_NODE=”OS5”
TO String. Optional.
Example:
REQUEST_NJE_NODE FROM=”OS5” TO=”OS6”
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.
Copy all the jobs in the Tbl5NYC scheduling table to the Tbl7LA scheduling table.
Copy all cyclic jobs in the GrpAcct group whose jobname begins with “Acct”.
Append “_COPY” to the job name of each copied job.
exportdefjob
The exportdefjob utility exports job processing definitions from a scheduling table in
the CONTROL-M/EM database to an output file.
- or -
exportdefjob [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name
-OUT_FILE out_file_name
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_file_name parameter.
Parameters
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 8 on page 26.
Note: At least one of the following scheduling table
parameters must be included in the arguments file:
■ DATACENTER
■ TABLE_NAME
■ TABLE_DSN
■ have data center name Data1 and a jobname that begins with the letter J.
- or -
■ have jobname Job5 and are not cyclic jobs.
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.
updatedef
The updatedef utility updates (modifies) specified parameter values in the following
definitions in the CONTROL-M/EM database:
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.
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.
- or -
updatedef [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name [/a]
3 Press Enter. The updatedef 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
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.
NOTE
Group scheduling table parameters are usually modified using the group scheduling table
criteria described in Table 23. 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 24. 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 22) and specifying a new value for the TABLE_NAME
parameter.
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:
CYCLIC Indicates whether the job is cyclic (to be run at regular intervals). Optional.
Example:
CYCLIC FROM="0" TO="1"
FROM Mandatory. Valid values:
■ 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:
CONFIRM FROM="0" TO="1"
FROM Mandatory. Valid values:
■ 0 (Default)
■ 1
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"
FROM String. Mandatory.
TO String. Optional.
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"
FROM Mandatory. Valid values:
■ START
■ END
TAG_ Relationship (AND|OR) between the specified Schedule Tag criteria and the
RELATIONSHIP job’s own basic scheduling criteria. This parameter is relevant only for jobs in a
group scheduling table. Optional.
Example:
TAG_RELATIONSHIP FROM="AND" TO="OR"
FROM Mandatory. Valid values:
■ AND
■ OR
PDSNAME Name of a partitioned dataset (PDS) to be checked for free space. String.
Optional.
Example:
PDSNAME FROM="Lib_3" TO="Lib_5"
FROM String. Mandatory.
TO String. Optional.
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"
FROM Integer. Mandatory.
TO 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.
Example:
CATEGORY FROM="*" TO="DAILY"
FROM String. Mandatory.
TO String. Optional.
PREVENTNC2 [MVS only] Performs dataset cleanup before the original job run. Optional.
Example:
PREVENTNC2 FROM="1" TO="0"
FROM Mandatory. Valid values:
■ 0 (Default)
■ 1
TO Optional. String.
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”
FROM Mandatory. Date Format: YYYYMMDD
TO Optional. String.
In the TEST data center, the group name of jobs with GROUP UnixJobs is changed to
GROUP TandemJobs.
In the TEST data center, for jobs with TABLE_ID 12202, the scheduling table name is
changed from Tbl_1 to Tbl_2.
<UPDATE>
<JOB>
<TABLE_NAME FROM="SGMPM1"/>
<!-- <TABLE_DSN FROM=""/> -->
<DATACENTER FROM="snow"/>
<JOBNAME FROM="cnn*" TO="bbc*"/>
<!-- <MEMNAME FROM="Job2"/>-->
<!-- <GROUP FROM=""/> -->
<!-- <APPLICATION FROM=""/> -->
<!-- <TASKTYPE FROM=""/> -->
<!-- <AUTHOR FROM=""/> -->
<!-- <MEMLIB FROM=""/> -->
<!-- <CMDLINE FROM="*end" TO="THE END *"/>-->
<!-- <NODEID FROM=""/> -->
<!-- <OWNER FROM=""/> -->
<!-- <MAXRERUN FROM=""/> -->
<!-- <TIMEFROM FROM=""/> -->
<!-- <TIMETO FROM=""/> -->
<!-- <DUE_OUT FROM=""/> -->
<!-- <PRIORITY FROM=""/> -->
<!-- <CRITICAL FROM=""/> -->
<!-- <CYCLIC FROM=""/> -->
<!-- <CONFIRM FROM=""/> -->
<!-- <AUTOARCH FROM=""/> -->
<!-- <INTERVAL FROM=""/> -->
<!-- <OVERLIB FROM=""/> -->
<!-- <MAXWAIT FROM=""/> -->
<!-- <DESCRIPTION FROM=""/> -->
<!-- <DOCMEM FROM="docmem"/> -->
<!-- <DOCLIB FROM="doclib"/>-->
<!-- <DAYS FROM=""/> -->
<!-- <DAYS_AND_OR FROM=""/> -->
<!-- <WEEKDAYS FROM=""/> -->
<!-- <DATE FROM=""/> -->
<!-- <DAYSCAL FROM=""/> -->
<!-- <WEEKSCAL FROM=""/> -->
<!-- <CONFCAL FROM=""/> -->
<!-- <RETRO FROM=""/> -->
<!-- <SHIFT FROM=""/> -->
<!-- <SHIFTNUM FROM=""/> -->
<!-- <MAXDAYS FROM=""/> -->
<!-- <MAXRUNS FROM=""/> -->
<!-- <RERUNMEM FROM=""/> -->
<!-- <RETEN_DAYS FROM=""/> -->
<!-- <RETEN_GEN FROM=""/> -->
<!-- <TASK_CLASS FROM=""/> -->
<!-- <PREV_DAY FROM=""/> -->
<!-- <IND_CYCLIC FROM=""/> -->
<!-- <TAG_RELATIONSHIP FROM=""/> -->
<!-- <SYSDB FROM=""/> -->
<!-- <PDSNAME FROM=""/> -->
<!-- <MINIMUM FROM=""/> -->
<!-- <CATEGORY FROM=""/> -->
<!-- <PREVENTNCT2 FROM=""/> -->
<!-- <JAN FROM=""/> -->
<!-- <FEB FROM=""/> -->
<!-- <MAR FROM=""/> -->
<!-- <APR FROM=""/> -->
<!-- <MAY FROM=""/> -->
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.
NOTE
The cli utility can upload and download calendars. It is described in Chapter 2, “Command
Line Interface utility (cli).”
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.
- or -
defcal [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -SRC_FILE src_file_name
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
The parameters of the defcal utility are described in Table 26.
Instructions for creating an XML format input file are in Appendix A, “XML File
Preparation.” The parameters of the defcal input file (SRC_file_name) are in Table 27
on page 109.
Two calendars are imported, each into a different data center, with a single defcal
input file.
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 178.
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.
2 Open a command prompt window (Windows users, only). You do not need to be
in the CONTROL-M/EM directory.
- or -
copydefcal [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name
4 Press Enter. The copydefcal 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
When this file is invoked, calendar definitions are exported from the
CONTROL-M/EM database.
Following are sample input files used with the copydefcal utility:
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).
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.
NOTE
Output files from export utilities (such as exportdefcal) can be used as input files with the
import utilities (such as defcal).
exportdefcal reads arguments directly from a plain text arguments file (in XML
format) instead of reading them from the command line.
2 Open a command prompt window (Windows users, only). You do not need to be
in the CONTROL-M/EM directory.
- or -
exportdefcal [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name
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 parameter out_file_name.
Parameters
The parameters of the exportdefcal utility are described in Table 30 on page 119.
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.”
PARAM The selection criteria parameter used to determine those calendars 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 calendar parameter.
Valid values:
■ DATACENTER
■ CALENDAR
Following are sample arguments files used with the exportdefcal utility:
The output file contains all calendars in data center Data1 that are named Cal1.
<?xml version=’1.0’ encoding=’UTF-8’?>
<!DOCTYPE TERMS SYSTEM "terms.dtd">
<TERMS>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"
VALUE="Data1"/>
<PARAM NAME="CALENDAR" OP="EQ" VALUE="CAL1"/>
</TERM>
</TERMS>
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 utilities ctmdefine and ctmcreate 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 32.
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 82.
■ 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
CONTROL-M/EM database.
When deftable is invoked, a file of arguments that you have created is processed. This
input file contains statements that specify:
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.
2 Open a command prompt window (Windows users). You do not need to be in the
CONTROL-M/EM directory.
- or -
deftable [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -SRC_FILE src_file_name [/a] [/o]
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.
Parameters
Optional switches for the deftable utility are described in Table 34.
When this file is invoked, scheduling table and/or group scheduling table definitions
are imported to the CONTROL-M/EM database. For instructions for creating input
files, see Appendix A, “XML File Preparation.”
TABLE_DSN Name of the library that contains the scheduling table. [For MVS jobs, only.]
String. Optional.
Note: At least one of the following scheduling table parameters must be
included in the input file:
■ DATACENTER
■ TABLE_NAME
■ TABLE_DSN
DATACENTER Name of the CONTROL-M installation to which the scheduling table 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_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.
Table 36 deftable input file parameters for group scheduling tables (Part 1 of 7)
Parameter Description
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.
These lines must appear exactly as follows:
?xml version=’1.0’ encoding=’UTF-8’?
!DOCTYPE DEFTABLE SYSTEM "deftable.dtd"
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.
Note: At least one of the following scheduling table parameters must be included in
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.
Note: At least one of the following scheduling table parameters must be included in
the input file:
■ DATACENTER
■ TABLE_NAME
■ TABLE_DSN
Table 36 deftable input file parameters for group scheduling tables (Part 2 of 7)
Parameter Description
MODIFIED For internal use. Do not include this parameter in your deftable input file.
LAST_UPLOAD Date of the last table upload. String. Optional.
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.)
Table 36 deftable input file parameters for group scheduling tables (Part 3 of 7)
Parameter Description
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 MVS 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 MVS 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.
Table 36 deftable input file parameters for group scheduling tables (Part 4 of 7)
Parameter Description
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, Months when the jobs in the group scheduling table can run.
APR, MAY, JUN, Optional. Valid values:
JUL, AUG, SEP, ■ 0 (Default)
OCT, NOV, DEC ■ 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
Table 36 deftable input file parameters for group scheduling tables (Part 5 of 7)
Parameter Description
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
Table 36 deftable input file parameters for group scheduling tables (Part 6 of 7)
Parameter Description
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
Table 36 deftable input file parameters for group scheduling tables (Part 7 of 7)
Parameter Description
DOCOND Specifies prerequisite conditions to be added or deleted. Optional.
Example:
DOCOND NAME="Cond1" ODATE="ODAT" SIGN="ADD"
NAME Condition name. String. Mandatory.
Valid values: 1 - 20 characters, case-sensitive.
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="barry@emuser.com" SUBJECT="OK" MESSAGE="Task completed OK."
URGENCY Urgency of the message. Valid values:
■ R (regular - Default)
■ U (Urgent)
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.
- or -
exportdeftable [-USERNAME user [-PASSWORD password] | -PASSWORD_FILE
password_file] -HOST gui_server_name -ARG_FILE arg_file_name
-OUT out_file_name
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 parameter out_file_name.
Parameters
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.”
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:
PARAM NAME="DATACENTER" OP="EQ" VALUE="Center1"
NAME String. Mandatory. The parameter name of any scheduling table or
group scheduling table parameter. These parameters are described in
Table 33 on page 123.
Note: At least one of the following scheduling table parameters must be
included in the arguments file:
■ DATACENTER
■ TABLE_NAME
■ TABLE_DSN
Following are sample arguments files used with the exportdeftable utility:
- or -
■ are located in data center Data1 and belong to the GRP_04 group scheduling table
6
6 Administration utilities
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.
NOTE
Many of the tasks performed by the check_gtw and ctl utilities can also be performed using
the Administration facility 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.
check_gtw
The Gateway Verification utility (check_gtw) 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.
NOTE
Alerts are sent only once, when a change in gateway status occurs.
check_gtw
-u|-U <DB_user>
-p|-P <DB_password>
[-m|-M <test_mode>]
[-t|-T <time_interval>]
[-w|-W <waiting_time>]
[-s ALL | <max_number_of_parallel_dc>]
-e <address> [-e <address> ... ]
|-f|-F <file>
|-e <address> [-e <address> ... ]-f|-F <file>
NOTE
An -e parameter, or an -f parameter, or both, must be specified.
-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.
cryptocli
The cryptocli utility creates an encrypted version of the password you submit.
■ 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.
2 Change the working directory to Ini under the CONTROL-M/EM home directory.
where:
Item Description
new_password New CONTROL-M/EM administrator password.
output_filename Full path name of the output file created by cryptocli. The file contains
the encrypted version of the password that was submitted.
2 Change the working directory to Ini under the CONTROL-M/EM home directory.
where:
Item Description
user_name CONTROL-M/EM administrator user name.
new_password New CONTROL-M/EM administrator password.
mcs.ini_path_name Full path name of the mcs.ini file (for example,
windir\system32\mcs.ini).
ctl
The ctl command line utility enables you to send simple requests to networked
CONTROL-M/EM components. The ctl utility can:
The ctl utility is automatically installed with the Gateway or Administration Facility
components. You can modify many attributes of the ctl command.
NOTE
ctl utility commands are case-sensitive.
3 Specify the ctl command line. For ctl syntax, see “ctl command syntax” on
page 144.
3 Specify the ecs ctl command line. For syntax, see “ctl command syntax” on
page 144.
NOTE
To run this utility on Unix platforms, issue the command ecs ctl. To run this utility on
Microsoft Windows, issue the command ctl.
Gateway
[ecs] ctl
[{-U em_user -P em_pass} |-pf password_file]
-C Gateway {-dc <Data_Center> |-all}
{-reg |
-cmd stop |
-cmd life_check |
{[-cmd dwl]
[-cmd change_log]
[-cmno_dbg]
[-cmd db{0-9}]
[-cmd gui{+|-}]
[-cmd host{+|-}]
[-cmd trunc{+|-}]
[-cmalive{+|-}]
[-cmd job{+|-}]
[-cmd dwl_debug{+|-}]
[-cmd hostlink{+|-}]
[-cmdguilink{+|-}]
[-cmd show_jcl]}}
[-timeout <Response_Timeout (seconds)>]
[-diagon]
[ecs] ctl
[{-U em_user -P em_pass} |-pf password_file]
-C GCS {-M <Computer_Name> | -all}
{ -reg |
-cmd stop |
-cmd life_check |
-cmd change_log |
-cmdstr "<Command_String>"}]
[-timeout <Response_Timeout (seconds)>]
[-diagon]
GUI Server
[ecs] ctl
[{-U em_user -P em_pass} |-pf password_file]
-C GUI_Server
{-M <Computer_Name> | -name <Logical_Name> | -all}
{-reg |
-cmd stop |
-cmd life_check |
-cmd do_measure |
-cmd get_measure |
-cmdstr "<Command_String>"}
[-timeout <Response_Timeout (seconds)>]
[-diagon]
[ecs] ctl
[{-U em_user -P em_pass} |-pf password_file]
-C GAS
{-M <Computer_Name> |-name <Logical_Name> | -all}
{-reg |
-cmd stop |
-cmd life_check |
-cmdstr "<Command_String>"}
[-timeout <Response_Timeout (seconds)>]
[-diagon]
Administration Agent
[ecs] ctl
[{-U em_user -P em_pass} |-pf password_file]
-C Maint_Agent {-M <Computer_Name> | -all}
{-reg |
-cmd stop |
-cmd life_check |
-cmd shutdown} [-timeout <Response_Timeout (seconds)>]
[-diagon]
[ecs] ctl
[{-U em_user -P em_pass} |-pf password_file]
-C BIM
-M <Computer_Name>
{-reg |
-cmd stop |
-cmd life_check |
-cmdstr "<Command_String>"
[-timeout <Response_Timeout (seconds)>]
[-diagon]
Table 47 ctl parameters for the BMC Batch Impact Manager Server (Part 1 of 2)
Parameter Description
ecs Specify this prefix when running this utility on Unix operating systems.
-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.
-C BIM Indicates the command is directed to a Batch Impact Manager Server (if this
product is installed at your site).
-M Specifies a computer name. This name is used to identify the computer to which
the Batch Impact Manager Server belongs.
-reg Checks if the Batch Impact Manager Server is registered in the CommReg table.
-reg cannot be used with -cmd or -cmdstr.
-cmd Indicates a command to be performed by the Batch Impact Manager Server.
-cmd cannot be used with -reg.
stop Stops the Batch Impact Manager Server.
This command cannot be specified with other commands in
the same run of the ctl utility.
life_check Checks if the Batch Impact Manager Server is active.
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 Batch Impact Manager Server. If the text
string contains spaces or tabs, it must be enclosed with double quotes (“ ”).
-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
CONTROL-M/Enterprise Manager Administrator Guide.
Table 47 ctl parameters for the BMC Batch Impact Manager Server (Part 2 of 2)
Parameter Description
-timeout Period of time (in seconds) that ctl waits for a response from the Batch Impact
Manager Server before declaring that communication has failed. Default: 30.
Optional.
-diagon Activates tracing of ctl work flow (diagnostics). Results are written to the
ctl_diag.machine.txt file located in the working directory. Optional.
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.
Many of the tasks performed by the database maintenance utilities can also be
performed using the Administration facility 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
NOTE
The db_check utility works only with databases on a Sybase Adaptive Server. This utility is
not available for Oracle Server.
Syntax
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
NOTE
This utility cannot be used for Oracle database client installations.
+------------------------------------------+
+ Space Information ( /tmp of the machine) +
+------------------------------------------+
Total Size: 524288 KB. Space Available: 401548 KB 23% Free
+------------------------------------+
| SYBASE Size Information: |
+------------------------------------+
Type Total Size Free Space % Free Space
----------------------------------------------------------
Data : 80 MB 72944 KB 89.043 %
Log : 23 MB 23458 KB 99 %
Oracle Server
+------------------------------------------+
+ Space Information ( /tmp of the machine) +
+------------------------------------------+
Total Size: 2048000 KB. Space Available: 366430 KB 17 % Free
+------------------------------------+
| ORACLE Size Information: |
+------------------------------------+
db total = 276480.0 KB
data used = 25296 KB (9%).
Syntax
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
CONTROL-M/Enterprise Manager Administrator Guide.
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
NOTE
When using the util utility to import a table, transferring definition tables between database
systems might fail. For information about resolving this problem, see “Transferring
CONTROL-M/EM data from CONTROL-M/EM installations with MSSQL to installations
with Oracle” on page 166.
The util utility is automatically installed on Microsoft Windows computers with the
CONTROL-M/EM Gateway component.
On Microsoft Windows
On Unix
NOTE
For Unix, add ecs and a space before specifying util. For example:
ecs util DB_ARGS -build_schema [-cdbg {1 - 5}]
-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}]
Note: Stop all CONTROL-M/EM components before doing this operation.
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:
The following steps are used to import calendar data from the ASCII data file
month_cal to the default CONTROL-M/EM database:
The following command deletes the contents of the table A0301190CT_BJOB from
database CITIES:
The following command exports the INVENTORY definition table for data center
WIP from the default CONTROL-M/EM database to the file wip_stores:
1 Copy the Defaults.rsc file to Defaults.old. This file is located in the following path:
2 To control the way date values are converted, modify, or add, the date format line
in the Defaults.rsc file so that it appears as follows:
4 When the import has completed successfully, restore the Defaults.rsc file by
copying Defaults.old to Defaults.rsc or by removing the date format line added in
step 2.
8
8 Build database utility
2 From the command line of the account on which you want to build the Sybase
database server, enter the command: build_db/build_db.sh
3 When asked to select the "CONTROL-M component for which you want to build
the Sybase component", select CONTROL-M/Enterprise Manager.
5 Follow the instructions on the screen, filling in the prompts as necessary. Upon
completion, the following message is displayed:
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.
3 Verify that the device file you want to define does not exist by running the
command: ls filename on the remote server.
4 Use the following command on the remote server to check the values of the
parameters in Table 55: sp_configure ’parameter_name’. If you change any of these
parameters, the change is not implemented until you restart the database.
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.
5 Follow the instructions on the screen, filling in the prompts as necessary. Upon
completion, the following message is displayed:
3 If the database exists, use the following command to drop (remove) it:
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_dropdevice device_name
go
6 Delete the files, if any, that are associated with the dropped elements.
1 Prepare the information you will need before running the build_db utility.
Parameters for this utility are listed in Table 56 on page 172.
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:
build_db parameters
build_db parameters are described in Table 56. The most recently used value for each
parameter is its default. Determine the required values before running this utility.
Table 56 build_db parameters
Sybase Server Host Name Host name of the computer on which the Sybase Database server is created.
Database Server Password of the CONTROL-M Sybase database server administrator
Administrator Password
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 The port that the computer on which the CONTROL-M Sybase database
Number server is created uses for external communication.
Sybase Server Backup Port The port that the CONTROL-M Sybase database backup server
Number component uses for external communication
Master Device Full Path File Full path name of the CONTROL-M Sybase database server.
Name
Sybsystemprocs Device Full Full path name of the CONTROL-M Sybase database server system
Path File Name processes database.
Temporary Device Full Path Full path name of the CONTROL-M Sybase database server temporary
File Name database.
Data Device Full Path File Full path name, including the logical device name, of the CONTROL-M/EM
Name 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 Full path name, including the logical device name, of the database log. You
Name 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. The recommended amount is 30% of the
space allocated for the CONTROL-M/EM database.
Temporary Device File Size Size of the temporary database in megabytes.
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:
home_dir BMCINSTALL/log/DRXX.version_number_user.log
where home_dir is the path of the CONTROL-M/EM user and
version_number is the CONTROL-M/EM version number.
A
A XML File Preparation
Some CONTROL-M/EM utilities require input files written in XML.
In the XML files used by the CONTROL-M/EM utilities, tags are used to classify job
processing definition, Calendar, and Scheduling table, and Group Scheduling table
parameters, and their values.
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.
■ 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.
For example, the defcal input file specifies new Calendar definitions to enter into the
database.
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
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.
Example
This file contains one TERMS statement. The statement specifies that non-cyclic jobs
with Job Name Job5 are to be selected.
<TERMS>
<TERM>
<PARAM NAME="JOBNAME" OP="EQ" VALUE="Job5"/>
<PARAM NAME="CYCLIC" OP="EQ" VALUE="0"/>
</TERM>
</TERMS>
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.
EXAMPLE
NAME="JOBNAME" OP="EQ" VALUE="Job5" searches for job processing definitions
that have the Job Name, Job5.
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.
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.
■ Whether the valid values for an element or attribute are mandatory or optional.
■ Hierarchical relationship between the various elements and attributes in the file.
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/EM_home\ecscli\Resource
directory (on Microsoft Windows).
To create a file:
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:
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.
NOTE
The file must be saved as a text file. It can have any file extension you want, but .xml is
recommended.
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 59.
Incorrect:
Correct:
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
Only one asterisk can be used in an expression.
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:
<JOB_NAME FROM="AAABBB"/>
<JOB_NAME FROM="*BBB"/>
<JOB_NAME FROM="AAA*"/>
Example 2
There are three job processing definitions. Their Job Names are:
The following argument selects jobs AAACCC and BBBCCC, and selects any other
jobs with a Job Name that ends with the letters CCC.
<JOB_NAME FROM="*CCC"/>
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
Example 1
There are three job processing definitions. Their Job Names are:
Modify the job names of some of these jobs using the following argument:
Example 2
There are three job processing definitions. Their Job Names are:
Index
util utility parameters 160
- type net build_db utility 167
util utility function parameters 163 -build_schema
util utility functions 161
building
Symbols CONTROL-M/EM database 165
building a CONTROL-M/EM database
* 178 util utility 159
.dtd file
CONTROL-M/EM Utility .dtd Files 176
description 176
validating XML files 176
C
calendars
cli utility 20
A copying 113
downloading 20
administration agents exporting 118
shutdown using ctl 152 handling using the cli utility 20
stopping using ctl 146, 148, 149, 151, 152, 153 importing 108
alert processing uploading 20
gateway check errors 140 -cdbg
-append util utility function parameters 162
util utility function parameters 164 check_gtw utility
application support description 140
Oracle Applications 13 invoking 140
SAP 13 parameters 140, 141
AS/400. See iSeries (AS/400) test mode 140
asterisk check_gtw_ue user exit 141
as a wildcard in Find/Replace operations 179 -clean_database
as a wildcard in search criteria 178 util utility functions 161
using as a wildcard 178 cleaning
AUTHOR parameter ENTERPRISE/CS database 164
copydefjob utility 42 cleanup
defjob utility 27 corrupted database 168
deftable utility 126 clearing a database
duplicatedefjob utility 65 util utility 159
authorization 14 cli utility 17
invoking 17
job deletion parameters 22
B parameters 18
Client mode
Batch Impact Manager server build_db utility 167, 171
ctl utility 153 command line interface
BMC Software, contacting 2 batch utility 17
build database utility 167 parameter formats 12
build_db log 172 configuration
build_db parameters 172 Sybase client 171
Index 181
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CONTROL-M/EM administrator
password encryption 142 D
CONTROL-M/EM components Data Device Full Path File Name parameter
shutdown using ctl 152 build_db utility 172
stopping using ctl 146, 148, 149, 151, 152, 153 Data Device Size parameter
CONTROL-M/EM database build_db utility 172
building 165 Database Name parameter
check size with db_check 156, 157 build_db utility 172
transaction log monitoring with db_check 156 Database Owner Login parameter
verify integrity with db_check 156 build_db utility 172
conventions 11 Database Owner Password parameter
converting build_db utility 172
Scheduling table to Group Scheduling table 52 Database Server Administrator Password parameter
copydefcal utility 113 build_db utility 172
arguments file 114 Database Size parameter
copycal.dtd 176 build_db utility 172
copyjob.dtd 176 databases
examples 116 arguments parameter (db_args) 160
invoking 113 db threshhold % parameter 156
parameters 116 db_args parameter
rules 114 util utility 160
copydefjob utility 38 db_check utility 156, 157
arguments file 39 db threshhold % parameter 156
AUTHOR parameter 42 log threshold % parameter 156
examples 51 db_check utility functions
invoking 38 check available database space 156
rules 40 report database size 156
copying transaction log monitoring 156
calendar definitions 113 verify database integrity 156
job definitions 38, 61 db_check_space utility 157
jobs to a Group Scheduling table 52 db_check_space utility functions
corrupted database check available database space 157
cleanup 168 check available database space as a percentage of total
creating database size 157
calendar definitions 108, 113 report database size 157
job definitions 24, 38, 61 -dcname
creation util utility function parameters 164
dedicated Sybase server 168 debugging
existing Sybase server 169 Keep Alive messages 146
Sybase database 170 util utility 162
cryptocli dedicated Sybase server
operational mode 142 creation 168
trial mode 142 Default mode
ctl build_db utility 167
-cmd command switch 146, 148, 149, 151, 152, 153 build_db utillity 168
command syntax 144 Defaults.rsc file
description 144 updating 166
Global Alerts Server 151 defcal utility 108
Global Conditions Server 147 defcal.dtd 176
GUI server 149, 153 examples 111
parameter descriptions 144 input file 109
shutdown command 152 invoking 108
stop command description 146, 148, 149, 151, 152, 153 -defexport
Custom mode util utility functions 162
build_db utility 167 -defimport
build_db utillity 168 util utility functions 162
customer support 3 defining
seealso creating
defjob utility 24 E
AUTHOR parameter 27 emenablepriv utility 15
defjob.dtd 176 EnableAuthorEdit 25, 39, 62, 83, 123
example 37 EQ
switches 25 utility operator 175
defjobconvert examples
examples 56 copydefcal utility 116
defjobconvert utility copydefjob 51
invoking 55 defcal utility 111
messages 55 defjob 37
deftable utility 122 defjobconvert 56
AUTHOR parameter 126 deftable utility 132
deftable.dtd 176 deldefjob 59
examples 132 duplicatedefjob utility 77
input file 123 exportdefcal utility 120
invoking 122 exportdeftable utility 138
parameters 123, 124, 125 util utility 164
rules 124 existing components
switches 123 verification 169
deldefjob utility 57 Existing mode
arguments file 58, 62 build_db utility 167, 169, 170
examples 59 existing Sybase server
invoking 57 creation 169
parameters 58 -export
rules 58 util utility functions 161
-delete exportdefcal utility 118
util utility functions 161 arguments file 119
deleting examples 120
from CONTROL-M/EM database 164 invoking 118
job definitions 22 parameters 120
jobs definitions (in batch) 57 rules 119
parameters of the cli utility 22 terms.dtd 176
deleting a database exportdefjob utility 78
util utility 159 invoking 78
documentation parameters 80
accessing online 11 rules 79
conventions 11 terms.dtd 176
online 10 exportdeftable utility 135
printed 10 arguments file 136
related publications 10 examples 138
downloading invoking 135
calendars 20 parameters 137
Scheduling tables 19 exporting
drop database command 170 a definition table 165
duplicatedefjob utility 61 calendars 118
arguments file 62 from CONTROL-M/EM database 164
AUTHOR parameter 65 job processing definitions 78
duplicatejob.dtd 176 Scheduling tables 135
examples 77 exporting database data
invoking 61 util utility 159
rules 63 exporting database definition table
switches 62 util utility 159
Index 183
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
G job definition
deleting by Mem Name 22
Gateway job definitions
unavailable 141 deleting 22
gateways modifying with updatedef 82
checking (check_gtw) 140 job processing definitions
Global Alerts Server deleting 57
ctl utility 151 exporting 78
Global Conditions Server updating 82
ctl utility 147 JOBISN value 24
Group Scheduling table jobs
copying jobs from a Scheduling table 52 copying 38, 61
forcing a job into 21 creating 24
Group Scheduling tables
modifying with updatedef 82
updating 82
group scheduling tables
L
importing 122 -library
updating 82 util utility function parameters 164
GUI server life check
ctl utility 149 ctl 146, 148, 149, 151, 152, 153
LIKE
utility operator 175
N
-name
S
util utility function parameters 163 SAP
NEQ application support 13
utility operator 175 Scheduling table
NOTIN copying jobs to a Group Scheduling table 52
utility operator 175 Scheduling tables
Number of locks parameter downloading 19
minimum values 169 exporting 135
Number of User Connections parameter forcing 19
minimum values 169 importing 122
modifying with updatedef 82
ordering 20
O updating 82
uploading 19
Oracle Applications security
application support 13 cryptocli utility 142, 143
ordering -silent
Scheduling tables 20 util utility function parameters 162
using the cli utility 21 sp_configure ’parameter_name’ command 169
sp_dropdevice device_name command 170
sp_helpdb command 169, 170
P sp_helpdevice command 170
starting
parameter formats gateway debug message truncation 146
command line interface 12 gateway host debug messages 146
long format 12 stopping
short format 12 administration agent using ctl 146, 148, 149, 151, 152,
parameters 153
buiold_db utility 172 component using ctl 146, 148, 149, 151, 152, 153
copydefcal utility 116 ctl shutdown command 152
deftable utility 124, 125 ctl stop command 146, 148, 149, 151, 152, 153
deldefjob 58 gateway debug message truncation 146
exportdefcal utility 120 support, customer 3
exportdefjob 80 Sybase client
exportdeftable utility 137 configuration 171
updatedef 84, 85, 90 Sybase database
util utility 160 creation 170
passwords Sybase database server
encryption 142 creation 168
product support 3 parameters 169
Sybase Server Backup Port Number parameter
build_db utility 172
R Sybase Server Host Name parameter
build_db utility 172
R/3. See SAP
Sybase Server Query Port Number parameter
raw partitions
Index 185
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
W
Western European language, special characters 41, 64, 85,
124, 125
wildcard
asterisk 178
in Find/Replace operations 179
in search criteria 178
X
XML
creating a file 177
examples 175
file structure 174
use in utilities 14, 177
utility format 173
Index 187
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