Control-M Server For WindowsNT MSSQL Administrator Guide - V2.24.01

CONTROL-M/Server for
Windows NT (MSSQL)
Administrator Guide
Version 2.24.01
Dec 31, 2000
BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered
trademarks or trademarks of BMC Software, Inc. Windows NT is a trademark of Microsoft Corporation. All other
trademarks or registered trademarks belong to their respective companies.
2000 BMC Software, Inc. All rights reserved.
The information in this document is subject to change without prior notice and does not represent a commitment
on the part of BMC Software, neither of which assumes any responsibility for any errors that may appear in this
document.
MM-224G-A0011A-WNT-MSSQL
Restricted Rights Legend

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

You can access the BMC Software Web site at http://www.bmc.com. From this Web site, you can obtain
general information about the company, its products, special events, and career opportunities. For a complete
list of all BMC Software offices and locations, go to http://www.bmc.com/corporate/offices.html.
USA and Canada
Outside USA and Canada
Address
Telephone
(01) 713 918 8800
Fax
(01) 713 918 8000
BMC Software, Inc.

2101 CityWest Blvd.
Houston TX 77042-2827
Telephone
713 918 8800 or

800 841 2031
Fax
713 918 8000
BMC Software, Inc., Confidential and Proprietary Information
iii
iv
CONTROL-M/Server for Windows NT Administrator Guide
Customer Support
You can obtain technical support by using Response Online (support from the Web) or Response On Demand.
To expedite your inquiry, please see Before Contacting BMC Software, below.
Response Online
You can obtain technical support from BMC Software 24 hours a day, seven days a week by accessing the
technical support Web site at http://www.bmc.com/support.html. From this site, you can
read overviews about support services and programs that BMC Software offers
find the most current information about BMC Software products
search a database for problems similar to yours and possible solutions
order or download product documentation
report a problem or ask a question
subscribe to receive e-mail notices when new product versions are released
find worldwide BMC Software support center locations and contact information, including e-mail addresses,
fax numbers, and telephone numbers
Response On Demand
In the USA and Canada, if you need technical support and do not have access to the Web, call 800 537 1813.
Outside the USA and Canada, please contact your local support center or your local sales office for assistance.
Before Contacting BMC Software

Before you contact BMC Software, have the following information available so that a technical support analyst
can begin working on your problem immediately:
product information
product name
product version (release number)
license number and password (trial or permanent)
operating-system and environment information
machine type
operating system type, version, and service pack or program temporary fix (PTF)
system hardware configuration
serial numbers
related software (database, application, and communication) including type, version, and service pack or
PTF
sequence of events leading to the problem
commands and options that you used
messages received (and the time and date that you received them)
product error messages

messages from the operating system, such as file system full
messages from related software
vi
Contents
Contents
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About xix
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . About xx
Chapter 1
Overview
CONTROL-M Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Server-Agent Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Identification of Agent Platforms . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Communication Status of Agent Platforms . . . . . . . . . . . . . . . . 1-6
Time-Related Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Authorized CONTROL-M Servers File . . . . . . . . . . . . . . . . . . . 1-9
Agent Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Host Identification in the Agent Platform . . . . . . . . . . . . . . . . . . . . . 1-11
New Day Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Scheduling Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
User Daily Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Date Control Record (UDLAST) . . . . . . . . . . . . . . . . . . . . . . . . 1-20
Handling of Interruptions During a User Daily Job . . . . . . . . . . 1-22
Issuing a Job Order Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
Shout Destination Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Shout Message Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-26
Runtime Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
CONTROL-M Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
Daylight Savings Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
Advancing the Clock Forward . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
Moving the Clock Backwards . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33
CONTROL-M Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
Heartbeat Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Contents
vii
Chapter 2
Utilities
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1
Utility Reference Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-4
Reports Generated From Utilities . . . . . . . . . . . . . . . . . . . . . . . .2-5
Directing Output From Utilities . . . . . . . . . . . . . . . . . . . . . . . . .2-6
Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-7
ctm_backup_bcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-7
ctm_ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-9
ctm_restore_bcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-11
ctmcontb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-13
ctmcpt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-17
ctmcreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-18
ctmdbbck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-23
ctmdbcheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-24
ctmdbrst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-28
ctmdefine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-28
ctmfw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-35
ctmjsa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-46
ctmldnrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-50
ctmloadset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-54
ctmlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-59
ctmmakedb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-62
ctmordck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-64
ctmorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-66
ctmpsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-68
ctmrpln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-76
ctmruninf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-80
ctmshout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-83
ctmshtb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-85
ctm_suspend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-86
ctmsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-87
ctmudlst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-96
ctmudly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-97
ctmwhy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-98
dbversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-99
ecacontb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-100
ecactltb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-104
ecaqrtab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-105
viii
Chapter 3
Security
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Level of Application Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
CONTROL-M Security Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Scheduling Table Authorization . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Active Jobs File Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Entities Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Agent Platform Security Checks . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Summary of Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Security Maintenance Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
User Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Scheduling Table Authorization . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Active Jobs File Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21
Entities Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25
Chapter 4
Maintenance
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
CONTROL-M Maintenance Procedures . . . . . . . . . . . . . . . . . . . . . . 4-3
Starting/Stopping CONTROL-M/Server Tasks . . . . . . . . . . . . . 4-3
Periodic Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
CONTROL-M Menu System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
CONTROL-M Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
CONTROL-M Manager Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Database Creation Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Database Maintenance Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Extend Database Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
Parameter Customization Menu . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Node Group Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
Agent Status Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Troubleshooting Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
CONTROL-M/Server Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
Show Process Flags (prf) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
Show All Processes (shctm) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Show Active Jobs File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Reset CONTROL-M Active Environment . . . . . . . . . . . . . . . . . 4-41
Sleep Time Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
Contents
ix
Chapter 5
Customization Parameters
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-1
Parameter Coordination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2
Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3
System Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3
Communication Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-9
Operational Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-12
Parameters for Communicating With Agent Platforms . . . . . . . .5-13
Database Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-14
Performance Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-16
Chapter 6
Preparing for CONTROL-M/Server Installation
Hardware/Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .6-1

Before Starting Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-1
Installation Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-2
SQL Server Configurations for CONTROL-M . . . . . . . . . . . . . .6-2
Installing CONTROL-M/Agent on the Server Platform . . . . . . .6-2
Chapter 7
Installation Procedure
Hardware/Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .7-2

Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-3
Installing CONTROL-M/Server Programs . . . . . . . . . . . . . . . . .7-3
Building the CONTROL-M Database . . . . . . . . . . . . . . . . . . . . .7-6
Silent Installation of CONTROL-M/Server Programs . . . . . . . .7-11
Installing CONTROL-M/Agent on the Server Platform . . . . . . .7-13
Parameters for Communicating With Agent Platforms . . . . . . . .7-13
Setting CONTROL-M Security Authorizations . . . . . . . . . . . . .7-16
Specifying CONTROL-M/Server Service User Account . . . . . .7-17
Setting CONTROL-M/Server User Rights . . . . . . . . . . . . . . . . .7-18
Verifying Communication With Agent Platforms . . . . . . . . . . . .7-19
Starting/Stopping CONTROL-M/Server Manually . . . . . . . . . . . . . .7-20
Uninstalling CONTROL-M/Server . . . . . . . . . . . . . . . . . . . . . . . . . .7-21
Appendix A
Messages and Codes
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Appendix B
Structure of CONTROL-M Log Entries
Glossary
Index
Figures
Figures
Figure 1-1
Figure 1-2
Figure 1-3
Figure 2-1
Figure 2-2
Figure 2-3
Figure 2-4
Figure 2-5
Figure 2-6
Figure 2-7
Figure 2-8
Figure 2-9
Figure 2-10
Figure 2-11
Figure 2-12
Figure 2-13
Figure 2-14
Figure 2-15
Figure 2-16
Figure 2-17
Figure 2-18
Figure 2-19
Figure 2-20
Figure 2-21
Figure 2-22
Figure 2-23
Figure 3-1
Figure 3-2
Production Control and Scheduling Solution . . . . . . . . . . . . . . . 1-1

New Day Procedure and User Daily Jobs . . . . . . . . . . . . . . . . . . 1-15
Directing Shouts through the Active Shout Destination Table . . 1-24
Sample Report from Utility ctmcontb . . . . . . . . . . . . . . . . . . . . . 2-16
Job Processing Definition With Utility ctmcontb . . . . . . . . . . . . 2-16
Utility ctmcreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
ON_FILEWATCH Statements . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40
Sample Trace File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-45
Sample Report from Utility ctmjsa . . . . . . . . . . . . . . . . . . . . . . . 2-49
Sample Output from Utility ecaqrtab Example 2 . . . . . . . . . . 2-57
Sample Output from Utility ecaqrtab Example 2a . . . . . . . . . . 2-57
Sample Output from Utility ecaqrtab Example 2b . . . . . . . . . 2-58
Sample Output from Utility ecaqrtab Example 2c . . . . . . . . . . 2-58
Sample Output from Utility ctmordck . . . . . . . . . . . . . . . . . . . . 2-65
Options Menu Active Jobs File Screen . . . . . . . . . . . . . . . . . . 2-70
Sample Output from the Scheduling Tables Option . . . . . . . . . . 2-73
Sample Output from the List Jobs # Option . . . . . . . . . . . . . . . . 2-74
Sample Utility ctmruninf Report . . . . . . . . . . . . . . . . . . . . . . . . 2-82
Shout Destination Tables Menu . . . . . . . . . . . . . . . . . . . . . . . . . 2-88
Sample Report Showing Available Tables . . . . . . . . . . . . . . . . . 2-89
Sample Showing Table Creation or Modification Options . . . . . 2-89
Report Showing System Parameters - Page 1 . . . . . . . . . . . . . . . 2-94
Report Showing System Parameters - Page 2 . . . . . . . . . . . . . . . 2-95
Sample of a Utility ecacontb Report . . . . . . . . . . . . . . . . . . . . . . 2-102
Sample of a Job Processing Definition Using ecacontb . . . . . . . 2-103
Sample Report from Utility ecaqrtab . . . . . . . . . . . . . . . . . . . . . 2-107
Security Maintenance Utility Main Menu . . . . . . . . . . . . . . . . . 3-12
User Maintenance Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Figures
xi
Figure 3-3
Figure 3-4
Figure 3-5
Figure 3-6
Figure 3-7
Figure 3-8
Figure 3-9
Figure 3-10
Figure 3-11
Figure 3-12
Figure 3-13
Figure 3-14
Figure 3-15
Figure 3-16
Figure 3-17
Figure 3-18
Figure 3-19
Figure 3-20
Figure 3-21
Figure 3-22
Figure 3-23
Figure 4-1
Figure 4-2
Figure 4-3
Figure 4-4
Figure 4-5
Figure 4-6
Figure 4-7
Figure 4-8
Figure 4-9
Figure 4-10
Figure 4-11
Figure 4-12
Figure 4-13
Figure 7-1
User Maintenance Menu User List . . . . . . . . . . . . . . . . . . . . . .3-15

User Maintenance Menu Modify User Information . . . . . . . . .3-16
Scheduling Table Authorization Menu . . . . . . . . . . . . . . . . . . . .3-17
Sample of a Message User Name not Defined . . . . . . . . . . . . .3-18
Message User Name not Defined in Security Database . . . . . .3-18
Scheduling Table Authorization Menu . . . . . . . . . . . . . . . . . . . .3-18
Sample of a Scheduling Table Authorizations Listing . . . . . . . .3-19
Scheduling Table Creation and Modification Menu . . . . . . . .3-20
Active Jobs File Authorization Menu . . . . . . . . . . . . . . . . . . . . .3-21
Screen Showing Message Where User Name is not Defined . . .3-22
Message User not Defined in the Security Database . . . . . . . .3-22
Active Jobs File Authorization Menu . . . . . . . . . . . . . . . . . . . . .3-22
List of Owners User has Active Jobs File Authorizations . . .3-23
Creation/Modification of Active Jobs File Authorization . . . . . .3-24
Maintain Entities Authorization Menu . . . . . . . . . . . . . . . . . . . .3-25
Message User Name not Defined on the Server Platform . . . .3-26
Message User Name not Defined in Security Database . . . . . .3-26
Entities Authorization Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-26
Categories for Which User has Authorizations . . . . . . . . . . . . . .3-27
Categories for Creation/Modification of Entity Authorizations .3-27
Menu Assigning Authorizations to an Entity in a Category . . . .3-28
CONTROL - M Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-7
CONTROLM Manager Menu . . . . . . . . . . . . . . . . . . . . . . . . . .4-8
Database Creation Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-10
Parameter Customization Menu . . . . . . . . . . . . . . . . . . . . . . . . .4-24
Communication and Operational Parameters . . . . . . . . . . . . . . .4-26
Default Parameters for Communicating with Agent Platform . .4-27
Parameters for Communication With Specific Agent Platform .4-28
Node Group Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-29
Agent Status Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-31
Troubleshooting Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-33
CONTROL-M/Server Processes Table . . . . . . . . . . . . . . . . . . . .4-38
Process Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-39
Active Jobs Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-39
Menu Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-12
xii
Tables
Tables
Table 1-1
Table 1-2
Table 1-3
Table 1-4
Table 2-1
Table 2-2
Table 2-3
Table 2-4
Table 2-5
Table 2-6
Table 2-7
Table 2-8
Table 2-9
Table 2-10
Table 2-11
Table 2-12
Table 2-13
Table 2-14
Table 2-15
Table 2-16
Table 2-17
Table 2-18
Table 2-19
Table 2-20
Table 2-21
Table 2-22
Table 2-23
Table 2-24
Communication Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

Definition of User Daily Job ACCUDAILY1 . . . . . . . . . . . . . . 1-19
Heartbeat Monitor Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Heartbeat Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
CONTROL-M Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
CONTROL-M Utility Reference . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Utility Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
ctmcontb Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Parameter Name Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . 2-19
ctmdbcheck Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
ctmdbcheck Displayed Fields . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
ctmdefine Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
ctmfw Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
ctmfw Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
ON_FILEWATCH Statements Additional Parameters . . . . . . 2-39
ctmfw Valid Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41
ctmjsa Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
Filter Mask Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
ctmldnrs Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
ctmldnrs Parameters (Prerequisite Conditions) . . . . . . . . . . . 2-53
ctmloadset Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
Example of Quantitative Resources Table . . . . . . . . . . . . . . . . . 2-56
ctmlog Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-60
ctmlog Other Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
ctmmakedb Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62
ctmordck Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
ctmordck Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-65
ctmorder Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
Tables
xiii
Table 2-25
Table 2-26
Table 2-27
Table 2-28
Table 2-29
Table 2-30
Table 2-31
Table 2-32
Table 2-33
Table 2-34
Table 2-35
Table 2-36
Table 2-37
Table 2-38
Table 2-39
Table 2-40
Table 2-41
Table 2-42
Table 2-43
Table 2-44
Table 3-1
Table 3-2
Table 3-3
Table 3-4
Table 3-5
Table 3-6
Table 3-7
Table 3-8
Table 3-9
Table 4-1
Table 4-2
Table 4-3
Table 4-4
Table 4-5
Table 4-6
Table 4-7
Table 4-8
Table 4-9
Table 4-10
Table 4-11
ctmpsm Menu Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69

ctmpsm Options for the Active Jobs File . . . . . . . . . . . . . . . . 2-70
ctmpsm Active Jobs File Actions . . . . . . . . . . . . . . . . . . . . . . 2-71
Resource Map Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-72
Scheduling Functions Options . . . . . . . . . . . . . . . . . . . . . . . . . . 2-72
Scheduling Tables Screen Options . . . . . . . . . . . . . . . . . . . . . 2-73
Scheduling Table Rescheduling Jobs Menu Options . . . . . . . 2-75
ctmrpln Report Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-76
ctmrpln Report Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-77
ctmrpln Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-78
ctmruninf Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-80
ctmshout Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-83
ctm_suspend Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-86
Shout Destination Table Fields. . . . . . . . . . . . . . . . . . . . . . . . . . 2-90
ctmudlist Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-96
ecacontp Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-100
Add/Delete Prerequisite Conditions . . . . . . . . . . . . . . . . . . . . . . 2-101
ecaqrtab Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-105
ecaqrtab List option Parameters . . . . . . . . . . . . . . . . . . . . . . . 2-106
Quantitative Resource Availability. . . . . . . . . . . . . . . . . . . . . . . 2-106
Scheduling Table Authorizations . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Active Jobs File Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Entities Authorization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Authorization Job Submission from a User Daily Job . . . . . . 3-9
Authorization Job Submission from the New Day Procedure. 3-10
Authorization Order/Force a Scheduling Table. . . . . . . . . . . . 3-10
Authorization Order/Force a Job from ENTERPRISE/CS . . . 3-10
Authorization Do Forcejob . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Authorization Actions on a Job in the Active Network . . . . . 3-11
Database Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2
CONTROL-M Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
ctm_menu CONTROL-M Manager Options . . . . . . . . . . . . . . . 4-9
Database Creation Menu Options. . . . . . . . . . . . . . . . . . . . . . . . 4-10
Required SQL Server Parameters. . . . . . . . . . . . . . . . . . . . . . . . 4-12
Required CONTROL-M Database Parameter . . . . . . . . . . . . . . 4-14
Backup Device Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Parameter Customization Menu . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
Node Group Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Agent Status Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Troubleshooting Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . .4-34
xiv
Table 4-12
Table 4-13
Table 4-14
Table 4-15
Table 4-16
Table 5-1
Table 5-2
Table 5-3
Table 5-4
Table 5-5
Table 5-6
Table 5-7
Table 5-8
Table 5-9
Table 7-1
Table 7-2
Table 7-3
Table 7-4
Table A-1
Table B-1
Two-Letter Codes for CONTROL-M Processes . . . . . . . . . . . . 4-37

Columns of the Show Process Flags Table . . . . . . . . . . . . . . . . 4-38
Status of Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
CONTROL-M/Server Process Sleep Times . . . . . . . . . . . . . . . 4-41
Sleep Time Modification Considerations . . . . . . . . . . . . . . . . . . 4-42
Parameter Coordination With ENTERPRISE/CS . . . . . . . . . . . 5-2
Parameter Coordination With Agent Platforms . . . . . . . . . . . . . 5-2
Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Prerequisite Conditions Deleted by the New Day Procedure . . 5-8
Communication Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Operational Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Parameters for Communicating With Agent Platforms . . . . . . . . 5-13
Database Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
Performance Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Required SQL Server Parameters . . . . . . . . . . . . . . . . . . . . . . . 7-6
Required CONTROL-M Database Parameter . . . . . . . . . . . . . . 7-8
Silent Installation Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Message Prefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Fields of the CONTROL-M Log . . . . . . . . . . . . . . . . . . . . . . . . .B-1
Tables
xv
xvi
About . . .
About This Book

This book describes how to install, customize and maintain the
CONTROL-M/Server on a Windows NT platform. It describes
administration concepts as well as relevant CONTROL-M/Server
parameters and utilities.
If you are an Enterprise Controlstation administrator, you should also
refer to the Enterprise Controlstation Administrator Guide. It outlines
administrator responsibilities and contains installation instructions and
advanced operating instructions.
This book is comprised of the following chapters:
Chapter 1
Overview
Introduces key features and concepts of
CONTROL-M/Server.
Chapter 2
Utilities
Provides a detailed description of CONTROL-M/Server
utilities. Operating instructions and examples are included
for each utility.
Chapter 3
Security
Discusses security concepts of CONTROL-M/Server and
ENTERPRISE/CS. Provides instructions for the security
utility included with CONTROL-M/Server.
Chapter 4
Maintenance
Describes how to perform various functions related to
startup/shutdown of CONTROL-M/Server, maintenance of
the CONTROL-M/Server database, setting
CONTROL-M/Server parameters and troubleshooting.
About This Book
xvii
Chapter 5
Describes parameters used to customize and configure the
CONTROL-M/Server installation.
Chapter 6

Describes planning and configuration considerations that
must be resolved before beginning the CONTROL-M/Server
installation.
Chapter 7
Provides detailed instructions for installing or upgrading
CONTROL-M/Server.
Appendix A
Messages and Codes
Appendix B
Installation
Provides detailed instructions for installing or upgrading
CONTROL-M/Server.
Appendix C
Structure of CONTROL-M/Server Log Entries
Glossary
Index
xviii
Related Publications
CONTROL-M/Agent Administrator Guide describes installation and

maintenance of CONTROL-M/Agent on all supported platforms.
CONTROL-M Server/Agent Migration Guide describes the process

of migrating to CONTROL-M Server/Agent Technology from
CONTROL-M 2.1.x.
Enterprise Controlstation User Guide describes ENTERPRISE/CS

concepts, features, facilities, and operating instructions.
Enterprise Controlstation Administrator Guide describes

administrator responsibilities, installation, customization,
maintenance, and security of ENTERPRISE/CS.
CONTROL-M/Desktop User Guide describes components used to

define and manage CONTROL-M job processing definitions,
Scheduling tables, and Calendars in Enterprise Controlstation.
About This Book
xix
Notational Conventions
The following abbreviations and terms are used in this guide:
ENTERPRISE/CS = Enterprise Controlstation.
The following table describes conventions used in this guide.
<key>
When describing keystrokes, angle brackets are

used to enclose the name of a key (for
example, <F1>). 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; then 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.
<variable>
In commands and parameters, angle brackets are

used to enclose variable information. For example, the
command:
cd <controlm_path>
means that you specify cd followed by the path of
CONTROL-M.
xx
Overview
CONTROL-M/Server is a component of the INCONTROL for

Production Management solution for production control and scheduling.
CONTROL-M/Server schedules, submits, and tracks jobs across a
network. The load balancing feature of CONTROL-M/Server helps you
achieve maximum production throughput by ensuring that each job is
submitted on a machine with sufficient resources for the job.
This guide describes concepts and tools for setup and management of
CONTROL-M/Server on a Windows NT platform.
Figure 1-1
Production Control and Scheduling Solution
Overview
1-1
BMC Softwares production control and scheduling solution consists of

the following components:
Enterprise Controlstation
This component is the central point of control for production
operations. It provides the graphical user interface to the production
control and scheduling system. From this workstation (referred to as
the ENTERPRISE/CS workstation), you can view the status of
jobs in any part of the system. You can issue requests, modify job
parameters, and handle exceptions to ensure smooth production job
flow.
CONTROL-M Data Center

Production component of the system. In earlier versions1 of
CONTROL-M, the data center consisted of a single platform that ran
the CONTROL-M application in addition to all production jobs. In
the current version, the functions of the data center have been
distributed between various platforms, each running one of the
following CONTROL-M components:
CONTROL-M/Server
The central software component of CONTROL-M. CONTROLM/Server runs on a Windows NT workstation (referred to as the
Server platform). From this location, CONTROL-M/Server
exchanges operations data with ENTERPRISE/CS and with
multiple production machines, and maintains the CONTROL-M
database.
CONTROL-M/Agent
This is the component of CONTROL-M that runs on each
production machine (referred to as the Agent platform) and that
executes job-handling requests received from CONTROL-M/
Server. Any number of Agent platforms with various operating
systems can be handled by a single Server platform.
1.Versions 2.1.X and earlier.

1-2
CONTROL-M/Agent is also installed on the Server platform. This

enables CONTROL-M/Server to utilize the Server platform as an
additional production machine.
In the above configuration, each instance of CONTROL-M/Server and
its associated CONTROL-M/Agents is viewed as a single data center in
Enterprise Controlstation. All schedule definitions reside in a database
managed by CONTROL-M/Server. The active scheduling environment is
also managed by CONTROL-M/Server, including all scheduling logic.
A typical job execution proceeds as follows:
1. A job waiting to be submitted waits on the Server platform.
2. Once all its prerequisite conditions, resource requirements and all
other scheduling constraints are satisfied, CONTROL-M/Server
instructs CONTROL-M/Agent to submit the job.
3. Upon receiving a request to submit the job, CONTROL-M/Agent
submits the job for execution locally according to the job definition.
4. CONTROL-M/Agent monitors the job and reports any exceptional
situation to CONTROL-M/Server.
5. Upon completion of the job, CONTROL-M/Agent performs
post-processing analysis. Job sysout is not transmitted over the
network, thus keeping network resource consumption at a minimum.
The CONTROL-M/Agent Administrator Guide provides the necessary
information for installing and managing CONTROL-M/Agent on various
Agent platforms.
An overall description of concepts relating to ENTERPRISE/CS and
CONTROL-M is provided in the first chapters of the Enterprise
Controlstation User Guide. It is highly recommended that you
familiarize yourself with the material contained there before proceeding
with this guide.
The overview in this chapter provides information about the following
topics:
Overview
1-3
Topic
Description
CONTROL-M Database
Contents and functions of the CONTROL-M

Database.
Server-Agent Interaction
CONTROL-M mechanism for distributed execution

of production jobs.
Load Balancing
CONTROL-M mechanism for maximizing

throughput by automatic selection of the platform to
execute jobs, based on workload considerations.
New Day Procedure
Daily scheduling and housekeeping procedures

that run on the Server platform.
Shout Destination
Tables
Tables used to determine the recipients of Shout

messages.
Runtime Statistics
Job statistics used for planning and forecasting.
CONTROL-M Log
Audit trail of all CONTROL-M events.
Daylight Savings Time
Considerations for moving the system clock forward

or backward.
CONTROL-M
Administrator
CONTROL-M administration tasks.
Heartbeat Monitor
Special monitor that checks the status of TCP/IP

communication with ENTERPRISE/CS.
1-4
CONTROL-M Database
The CONTROL-M database is the repository of operational data about
the CONTROL-M data center. One database exists for each
CONTROL-M data center. The database is maintained by
CONTROL-M/Server, using either a dedicated or existing SQL server.
The CONTROL-M database contains the following information:
CONTROL-M log.
Active Jobs file.
Job processing definitions.
CONTROL-M system, communication and operational parameters.
Security authorizations.
Shout Destination tables.
Node groups.
Status tables for Quantitative resources, Control resources and
prerequisite conditions.
Server-Agent Interaction
CONTROL-M/Agent handles requests from CONTROL-M/Server. A
request can consist of:
Instructions to submit a job on the Agent platform.
Requests for information about jobs on the Agent platform that are
currently executing or recently completed.
Requests to view/edit job script statements.
Requests to view job sysout or job documentation.
Overview
1-5
In addition, CONTROL-M/Agent can perform the following functions as

instructed by job processing parameters supplied with the job submission
request:
Handling job sysout.

Issuing Shout messages.
Each Agent platform requires a listener process to accept requests from

CONTROL-M/Server. Windows NT platforms can provide this service
using operating system services. On other types of platforms,
CONTROL-M/Agent, started at boot-time, includes this listener process.
Identification of Agent Platforms

Each Agent platform is known to CONTROL-M/Server by its node ID.
This is generally the Agent platforms host name. The job processing
definition for each job should include the node ID of the Agent platform
on which the job should be submitted by CONTROL-M/Server.
Note
If load balancing is used, the job processing definition includes a Node

group. For more information, see Load Balancing on page 1-10.
Communication Status of Agent Platforms

CONTROL-M/Server communicates with each Agent platform using
either the UDP/IP or TCP/IP protocol. CONTROL-M/Server maintains a
list of all Agent platforms to which it submits requests and assigns a
status to each platform indicating the success or failure of
communication with the platform. Valid statuses for Agent platforms are
described in Table 1-1.
1-6
Table 1-1
Communication Statuses
Status
Description
Available
Communication with the Agent platform is assumed to be

normal. By default, any Agent platform is assigned this
status (even a platform that is not active) until the platform
fails to respond to a request from CONTROL-M/Server.
Unavailable
The Agent platform is not responding to communication

from the Server platform. CONTROL-M/Server attempts to
reestablish communication with the Agent platform.
If communication is reestablished, the Agent platform
returns to status Available.
Disabled
You can manually assign this status to an Agent platform if

you want to temporarily prevent CONTROL-M/Server from
submitting jobs to that platform. CONTROL-M/Server will
not attempt to communicate with a disabled Agent platform
until its status is manually changed to Available. When an
Agent platforms status is changed to Disabled, jobs that
were running on the platform at that moment are assigned
the status Disappeared.
The communication status of Agent platforms can be viewed or modified

using the Agent Status menu, described in Chapter 4, Maintenance.
Depending upon the type of protocol used for communication, certain
user-defined communication parameters determine timeouts and the
number of retries attempted before the status of an Agent platform is
changed. Communication parameters are described in Chapter 5,
Customization Parameters.
Interrupted Communication
If communication is interrupted between CONTROL-M/Server and one

or more Agent platforms, CONTROL-M/Server sends a special Shout
message to ENTERPRISE/CS. All jobs that were running on the affected
Agent platform(s) are reclassified in the Active Jobs file as Unknown.
The status of the Agent platform is changed to Unavailable.
If processing on the Agent platform was not interrupted, jobs submitted
to a platform prior to the interruption continue executing.
Overview
1-7
When communication between CONTROL-M/Server and an Agent

platform is restored, CONTROL-M checks the status of jobs that were
running on the Agent platform and updates their status in the Active Jobs
file. If a job completed execution during the period of interrupted
communication, CONTROL-M/Server retrieves its completion status
from the Agent platform.
Time-Related Functions
The time value used for any CONTROL-M function is determined by the
system time on the Server platform. This applies to the following:
The time window in which a job can be submitted (according to the

job processing parameters Time From and Time Until).
Time values recorded for operations in the CONTROL-M log.
Example
The time value for SUBMITTED AT recorded for a job in the

CONTROL-M log is the time that CONTROL-M/Server issued the
job submission request to the Agent platform, not the time that the
request was received or the time that the job actually started
executing on the platform.
The time value for ENDED is the time that CONTROL-M/Server

received notification that the job completed execution.
1-8
Authorized CONTROL-M Servers File

CONTROL-M contains a security mechanism to ensure that Agent
platforms process only legitimate job-handling requests.
To ensure that an Agent platform does not receive a request from an
unintended source, each Agent platform contains a file listing host names
of Server platforms that are authorized to issue requests to that platform.
A request from any Server platform not listed in this file is rejected by
CONTROL-M/Agent on the Agent platform.
The Authorized CONTROL-M/Server file for each Agent platform
typically contains the host name of the Server platform to which the
Agent platform is assigned and the host name of a backup CONTROLM/Server platform. This information resides in the Windows NT registry
database.
Agent Configuration Parameters

Each Agent platform has a unique set of configuration parameters. These
parameters include specification of directories used by the Agent
platform when executing jobs and parameters required by
CONTROL-M/Agent for communicating with the Server platform. For
more information, see Communication Parameters on page 5-9.
Overview
1-9
Load Balancing
The CONTROL-M load- balancing feature enables you to submit a job to
a node group rather than to a specific Agent platform. This node group
represents a user-defined list of Agent platforms capable of executing a
specific job. CONTROL-M/Server uses a load-balancing algorithm to
determine which of these Agent platforms is best able to handle
execution of the job at the current time and submits the job to the
appropriate node. Using load balancing, CONTROL-M optimizes
utilization of available resources and ensures maximum production
throughput.
Note
Load balancing is not available for platforms with CONTROL-M version

2.1.x or earlier.
The following CONTROL-M facilities are used to administer load
balancing on the Server platform.
The Node Group menu (described in Chapter 4, Maintenance) is

used to define the Agent platforms in each node group.
Utility ctmloadset is used to report utilization of Quantitative

resources on an Agent platform by non-CONTROL-M jobs.
The Quantitative Resources window (in Enterprise Controlstation) is

used to view or define Quantitative resources available on the Server
platform or Agent platforms.
For an overview of the load balancing facility, refer to Load Balancing

in the CONTROL-M Concepts chapter in the Enterprise Controlstation
User Guide.
1-10
Host Identification in the Agent Platform

Each Agent platform has a unique set of configuration data. This data
includes the following items:
CONTROL-M/Server Host Name

This is the host interface name of the Server platform currently
issuing job handling requests to the platform.
Authorized CONTROL-M Servers File

This contains a list of the host names of Server platforms that are
authorized to issue job handling requests to the platform. The current
Server platform host name appears in this list.
Each job submission or job tracking request from CONTROL-M/Server

contains the host name of the Server platform.
The CONTROL-M/Server Host Name is retained by the Agent
platform. If the Agent platform detects that the host name accompanying
a request does not match the current host name in the Agent
Configuration file:
CONTROL-M/Agent verifies that the new host name (contained in

the request) is listed in the Authorized CONTROL-M Servers
Registry Settings. If the host name does not appear in the list,
CONTROL-M/Agent ignores the request.
If the new host name appears in the list, CONTROL-M/Agent

automatically modifies the current host name in the Agent
Configuration file and processes the request.
This mechanism enables a backup Server platform to take over job

submission and tracking functions if a failure occurs in the primary
Server platform. Its purpose is to prevent an Agent platform from
receiving job handling requests from two or more Server platforms
concurrently. It is the administrators responsibility to ensure that
CONTROL-M/Server is not running simultaneously in the primary and
backup Server platforms.
Overview
1-11
New Day Procedure

CONTROL-M processes execute as background processes on the Server
platform and remain active at all times. Once a day, when specified by
the CONTROL-M system parameter Day Time (starting time of working
day), CONTROL-M starts the New Day procedure.1
The New Day procedure performs automatic functions that start a new
day under CONTROL-M. This procedure is used as a master scheduler
for all CONTROL-M activities.
The New Day procedure performs the following sequence of operations:
1. A new Odate2 (CONTROL-M date) is calculated (based on the
system date and CONTROL-M system parameter Day Time).
2. The message FORMATTING AJF is displayed in the
ENTERPRISE/CS Communication Status window for the data
center.
3. A selective cleanup of the Active Jobs file is performed. Jobs that
have already executed and ended OK, and jobs whose parameter
Max Wait has been exceeded (and are not Held), are erased from the
Active Jobs file.
Note
A job for which a Max Wait value is specified that ends with a status of
NOTOK is not deleted from the Active Jobs file until the Max Wait
value is exceeded.
1. Formerly known as the General Daily procedure.

2. ODATE is the scheduling date assigned to a job when the job is ordered. Refer to the Enterprise
Controlstation User Guide for more information about this date.
1-12
4. A selective cleanup of prerequisite conditions is performed. Any

prerequisite condition whose reference date (month and day) is equal
to the new CONTROL-M date is deleted. This prevents jobs from
being triggered by prerequisite conditions remaining from the
previous year.
You can partially or completely disable cleanup of prerequisite
conditions by using CONTROL-M system parameter Ignore New
Day Conditions.
5. A partial cleanup of the Statistical Details table (in the
CONTROL-M database) is performed. For each job, CONTROL-M
retains statistical information about the last 20 successful executions.
This value can be changed by defining the
RUNINF_PURGE_LIMIT in the CONTROL-M config.dat file.
CONTROL-M must be shut down and restarted for this change to
take effect.
6. A partial cleanup of the CONTROL-M log is performed, based on
system parameter Maximum Days Retained By CONTROL-M
Log. This parameter specifies the maximum number of days that
entries are retained in the CONTROL-M log before being deleted by
the cleanup procedure.
7. A partial cleanup of job sysout directories on Agent platforms is
performed, based on system parameter Maximum Days to Retain
Sysout Files. This parameter specifies the maximum number of days
that job sysout files are retained in the sysout directory before being
deleted by the cleanup procedure.
8. Job orders are placed in the Active Jobs file in accordance with job
processing parameters contained in Scheduling tables (assigned to
User Daily SYSTEM). These job orders can include the
submission of User Daily jobs. For more information, see User
Daily Jobs on page 1-17.
9. The end of a daily run is marked by updating the parameter
UDLAST in the Date Control record1 of User Daily SYSTEM.
This parameter represents the last date on which the New Day
procedure ordered jobs.
Overview
1-13
10. The download of the new Active Jobs file to the ENTERPRISE/CS
workstation is initiated.
Scheduling Jobs
The New Day procedure is the master scheduler for production jobs.
It orders production jobs according to their job processing definitions,
and can also order User Daily jobs which, in turn, order regular
production jobs.
In a site with a relatively small number of production jobs, the simplest
and most straightforward method of scheduling jobs is to order them
directly through the New Day procedure.
If two or more of the following conditions exist:
Large number of jobs

Jobs can be clearly divided into separate categories
Different jobs are managed by different people
It is preferable to order them using User Daily jobs, allowing greater

flexibility. User Daily jobs can be defined according to function (for
example, by department, project or factory).
The New Day procedure scans the Scheduling tables assigned to User
Daily SYSTEM and places relevant job orders in the Active Jobs file.
Some of these jobs can be regular production jobs, and some can be User
Daily jobs.
Each User Daily job is then submitted and monitored by CONTROL-M
and will, in turn, place job orders in the Active Jobs file.
The following diagram demonstrates how the association of Scheduling
tables and User Daily jobs affects the scheduling of jobs under
CONTROL-M:
1. See Date Control Record later in this chapter for a description of UDLAST and the Date
Control record.
1-14
Figure 1-2
New Day Procedure and User Daily Jobs

CONTROL-M
Database
User
Daily
Scheduling
Table Name
SYSTEM
UDAILIES
SYSTEM
TABLE1
UDAILY1
UDAILY1
PAYABLES
RECEIVABLES
UDAILY2
INVENTORY
New Day
Procedure
1
Active Jobs File
CONTROL-M
Monitor
4
UDAILY1
UDAILY2
6
Scheduling
Table Name
Job
UDAILIES
UDAILY1
UDAILIES
UDAILY2
TABLE1
PROD_JOB1
TABLE1
PROD_JOB2
PAYABLES
PROD_JOB3
PAYABLES
PROD_JOB4
RECEIVABLES
PROD_JOB5
INVENTORY
PROD_JOB6
INVENTORY
PROD_JOB7
1. As part of its daily routine, CONTROL-M activates the New Day

procedure.
2. The New Day procedure scans the CONTROL-M database for all
Scheduling tables assigned to User Daily SYSTEM (in this
example, UDAILIES and TABLE1). These Scheduling tables can
consist of regular production jobs and/or User Daily jobs. In this
example, UDAILIES consists of User Daily jobs, and TABLE1
consists of production jobs.
Overview
1-15
3. The New Day procedure places the relevant job orders in the Active
Jobs file.
4. As part of its regular processing of ordered jobs, CONTROL-M
scans the Active Jobs file for jobs to submit.
5. Upon determining that all requirements for User Daily jobs
UDAILY1 and UDAILY2 have been met, CONTROL-M/Server
submits them for execution.
6. The User Daily jobs then order the corresponding tables
(PAYABLES, RECEIVABLES, INVENTORY). The jobs in these
tables are added to the Active Jobs file if their scheduling criteria are
satisfied. All ordered jobs are submitted for execution when their
submission criteria are satisfied.
Each User Daily job scans all the Scheduling tables assigned to it in the
CONTROL-M database, and orders the jobs based on the jobs
Scheduling criteria, the date in the computer, and the Date Control
record. For more information, see User Daily Jobs on page 1-17. Each
User Daily job scans a different set of Scheduling tables and uses a
different Date Control record. For more information, see Date Control
Record (UDLAST) on page 1-20.
Many variations of the method described can be used. For example,
additional User Daily jobs can be defined, each one executing at a
specific time.
1-16
User Daily Jobs

For large sites, User Daily jobs are the most suitable mechanism for
adding new job orders under CONTROL-M.
A User Daily job is actually no different from any other regular job
handled by CONTROL-M. The User Daily job is defined through the
ENTERPRISE/CS Graphical User Interface, using the same procedure
and the same job processing parameters as any other job. User Daily jobs
run on the Server platform.1
A User Daily job must include in its script file (specified by its Mem
Name job parameter) the command to run utility ctmudly (supplied as
part of the CONTROL-M package). Utility ctmudly accepts a parameter
containing the name of a specific User Daily job, and it performs the task
of ordering Scheduling tables associated with that User Daily job. (The
name of the User Daily job can be stated explicitly in the script file or it
can be specified using AutoEdit Assignment statements.)
Each User Daily job scans the Scheduling tables assigned to it to
determine which jobs are potential job orders for this specific date.
An ordered job will not necessarily be executed by CONTROL-M (for
example, a job is not executed if its prerequisite conditions are not met or
if resources required for the job are not available).
When a User Daily job determines that a specific job should be ordered,
it places the job order in the Active Jobs file.
The normal sequence of actions performed by a User Daily job is as
follows:
1. User Daily jobs requireCONTROL-M/Agent to be installed on the Server platform. For more
information, see Installing CONTROL-M/Agent on the Server Platform on page 6-2.
Overview
1-17
1. The date UDLAST of the User Daily Date Control record is

compared with Odate.
If UDLAST is earlier than Odate, the program updates the

starting date of this User Daily job and continues executing.
If UDLAST is later than or equal to Odate, the program writes a

message to the CONTROL-M log and terminates without
performing any further operations.
2. Each of the Scheduling tables assigned to the User Daily job is

scanned, and relevant job orders are placed in the Active Jobs file.
3. The successful completion of the User Daily job run is marked by
updating UDLAST on the Date Control record with the current value
of Odate.
Note
It is recommended that User Daily jobs be scheduled to run sequentially,

not concurrently. This can be accomplished using the standard scheduling
parameters in job processing definitions (for example, assign the same
Control resource in exclusive mode to all the User Daily jobs, and
sequence the jobs for execution in a specific order using the priority
mechanism).
Example
Assume that a set of jobs is defined in a Scheduling table named

ACCOUNTING assigned to User Daily UDAILY1.
The job processing definition below describes a job that could be used to
order the ACCOUNTING Scheduling table. This type of job is referred
to as a User Daily job.
1-18
Table 1-2
Definition of User Daily Job ACCUDAILY1
Job Processing Parameters
Script Files
Job Name: ACCUDAILY1

Application: USER_DAILIES
Task Type: Job
Description: Accounting User Daily
Scheduling Table: ACCTDAILY
Author: michelle
Owner: bill
Mem Name: udaily
Mem Lib: /usr/bill/bin
AutoEdit Assignments %%PARM1 = UDAILY1
Script file udaily (referred to by

the job processing parameter
Mem Name) contains the
following line:
ctmudly $1
The utility ctmudly used in this
file is described in Chapter 2,
Utilities.
You can manually order the User Daily Job ACCUDAILY1 whenever
you want to order the jobs in the ACCOUNTING Scheduling table, or
you can assign Scheduling table ACCTDAILY to User Daily name
SYSTEM, in which case ACCUDAILY1 will be ordered by the New
Day procedure.
When ACCUDAILY1 submits the script file with the parameter $1 set to
UDAILY1, the command actually executed by the script is:
ctmudly
UDAILY1
This causes all Scheduling tables assigned to UDAILY1 to be ordered

(including Scheduling table ACCOUNTING referred to above).
The script file UDAILY can also be used by other User Daily jobs. In
each job processing definition, assign the appropriate User Daily name to
the AutoEdit variable %%PARM1.
Overview
1-19
Date Control Record (UDLAST)

User Daily jobs are used to place job orders in the Active Jobs file. Each
User Daily job usually runs once a day, scanning one or more user
Scheduling tables. As with any regular job, the User Daily job is ordered
according to its defined Scheduling criteria. This means that the User
Daily job is date-dependent. As a result, certain special situations must
be taken into account.
For example:
The computer has not been working for a day or more, due to
hardware failure, weekend, holidays, and so on.
The user wants to run a job or a group of jobs with an Odate that is
prior to the current working date.
Each User Daily job has its own Date Control record, enabling the User
Daily job to maintain control over its last running date. The last running
date of the User Daily job is recorded in the Date Control record in a
field called UDLAST. The Date Control record is analyzed to determine
the current running date, the last running date, and possible error
situations.
Utility ctmudlst can be used to change the UDLAST field in the Date
Control record. Changing this date field affects the scheduling of jobs as
described below.
Use of the Date Control Record by User Daily Jobs
When a User Daily is run, UDLAST (the last running date of the User
Daily job, recorded in the Date Control record) is compared to Odate
(the current installation working date).
If UDLAST is earlier than Odate (the normal situation), UDLAST

is updated automatically to the current installation working date. This
date is then used by the User Daily job as the current scheduling
date.
1-20
If UDLAST and Odate are equal, it means that the User Daily job
has already run today. In that case, a message is issued to the
CONTROL-M log, and the User Daily job does not order any jobs.
If UDLAST is later than Odate, an exceptional situation has

occurred. The User Daily job writes a message to theCONTROL-M
log and stops executing. You can use utility ctmudlst, if required, to
modify UDLAST.
If, for any reason (for example, hardware problems), the New Day
procedure did not run for one or more days, it is not necessary to run
it for days missed. However, production jobs (including User Daily
jobs) whose job processing definition includes the parameter Retro
will be ordered automatically for all the dates on which they were
supposed to be ordered. Retroactive ordering of jobs is performed
according to each jobs scheduling criteria.
For example, if the computer did not operate from the 20th to the
23rd, then a job that was originally scheduled to run on the 20th will
not have run on that day. When it is finally run on the 24th, the New
Day procedure determines whether or not its associated jobs should
be retroactively scheduled to run using the logical date of the 20th.
For additional information, refer to the Enterprise Controlstation
User Guide.
Note
There is no need to specify the Retro parameter in the job processing

definition of a User Daily job that is scheduled to run on a daily basis. If
production days are missed (as described above), one execution of the
User Daily job will order retroactively all jobs defined using the Retro
parameter.
The Retro parameter can be used in the job processing definition of a
User Daily job that is not scheduled to run on a daily basis.
Overview
1-21
Handling of Interruptions During a User Daily Job

CONTROL-M contains provisions for dealing with interruptions during
the execution of a User Daily job (for instance, when some of the job
orders have already been placed in the Active Jobs file and some have
not).
If a User Daily job is interrupted for any reason (for example, operating
system crashes, User Daily job abends or ordering is erroneously stopped
for any other reason), the entire daily process (starting from execution of
the New Day procedure) can be rerun manually. Before each job order is
placed in the Active Jobs file, CONTROL-M verifies that the job is not
already present in the file. As a result, a job will not be ordered more
than once for a specific working date.
Note
Should you decide to rerun a User Daily job manually, you must change
UDLAST (the last running date of the User Daily job) as if the jobs did
not run today. A User Daily job is run manually using utility ctmudly.
UDLAST is modified using utility ctmudlst. For further information,
Chapter 2, Utilities.
Issuing a Job Order Manually

Most job orders are handled automatically by the New Day procedure or
by User Daily jobs. However, it is sometimes necessary to issue job
orders manually (for example, an ad hoc job) or to issue a job order for a
different working date.
The following options are available on the ENTERPRISE/CS
workstation for issuing a job order manually:
1-22
Order
Requests that the specified job or Scheduling table be ordered. Each
job is placed in the Active Jobs file if its Scheduling criteria are
satisfied.
Force
Forces the specified job or Scheduling table. Each job is placed in
the Active Jobs file regardless of its Scheduling criteria.
For more information see the Enterprise Controlstation User Guide.
Overview
1-23
Shout Destination Tables

The CONTROL-M Shout facility sends messages to specified recipients
(for example, users, System console, ENTERPRISE/CS) based on a
destination specified by the parameters Shout and/or Do Shout in a job
processing definition.
The Shout Destination table contains a list of logical destinations and
the equivalent physical destination of each logical destination.
You can create any number of Shout Destination tables, but only one of
them is designated as the active Shout Destination table at any given
time. By changing the designation of the active table, you can change the
actual recipients of messages sent to specific logical recipients.
Example
Figure 1-3
Directing Shouts through the Active Shout Destination Table
You define two Shout Destination tables, labeled DAYSHIFT and

NIGHTSHIFT. In DAYSHIFT, the logical recipient
SYS_MANAGER is equated to user Susan, who is the daytime
systems manager. In NIGHTSHIFT, the logical recipient
SYS_MANAGER is equated to user Robert, the nighttime systems
manager.
1-24
When the DAYSHIFT Shout Destination table is active, Shout

messages addressed to SYS_MANAGER are sent to Susans mail
address. At 5 p.m., a job is run that changes the active Shout
Destination table to NIGHTSHIFT. From that point forward, Shout
messages addressed to SYS_MANAGER are sent to Roberts mail
address.
Shout Destination tables are created and maintained using utility ctmsys
(described in Chapter 2, Utilities).
Designation of the active Shout Destination table can be performed using
one of the following methods:
Using the interactive utility ctmsys. In addition to creating and

maintaining Shout Destination tables, ctmsys can display the
currently-active table and allows you to change the active table by
selecting a different table from a list.
Using utility ctmshtb. This utility accepts the name of the Shout
Destination table to make active.
This second method is especially useful. By defining CONTROL-M jobs

that execute utility ctmshtb at specified times, the active Shout
Destination table designation can be changed automatically according to
the schedule that suits your requirements. ctmshtb is described in
Utility ctmshout can also be used to issue a Shout message to an
indicated destination. ctmshout is described in Chapter 2, Utilities.
Overview
1-25
Shout Message Destinations

When defining logical and physical destinations in the Shout Destination
table (using the ctmsys utility), you are requested to supply the following
information for each recipient:
Logical Name
Name used in the Shout or Do Shout parameter to

identify the recipient of the Shout message.
Destination
Type
One-letter code, indicating the type of recipient. Possible

values are:
U
Destination is a users internet address.
Destination is a users internet address.
Destination is the system console.
Destination is the CONTROL-M log.

Note: All Shout messages are recorded in the
CONTROL-M log. You would select the log as a
destination only when you do not wish to send the
message to any additional destination.
E
Address Type
Physical Name
Destination is the Alert window of ENTERPRISE/

CS.
For Destination Types U, M or O, a one letter code

indicating the location of the recipient relative to the
Server platform. Possible values are:
S
Recipient is a local user on the Server platform.
Recipient is located on the Agent platform where

the job that caused the Shout message was
executed.
For Destination Types U and M specify an internet

address.
For Destination Types O, L and E, no physical name is
specified, as each of these is a unique destination.
Shout to Email
When the Destination Type is U or M, the Shout to Email facility is

activated.
1-26
To use the Shout to Email facility the following conditions must be met:
Microsoft Exchange is installed on the Windows NT platform.
CONTROL-M/Server is running as a service that is logged on using

the This account option for a user account that has authorization to
access the network and has been registered in the CONTROL-M
product registry database. The ctmcpt utility is used to register a user
in the CONTROL-M product registry database. For more
information, see ctmcpt on page 2-17.
The Windows Messaging component is installed on the Windows NT

platform.
To add the Windows Messaging component:
1. Choose Add/Remove Programs from the Windows NT Control
Panel.
2. Select Windows NT Setup.
3. Click the Windows Messaging check box.
4. Press OK.
Overview
1-27
Runtime Statistics
CONTROL-M includes an option for accumulating and collating runtime
statistics for each defined job. These statistics are used for the following
purposes:
The job processing parameter Shout can be specified to issue a

message if the execution time required by a job varies from its
average runtime by more than a stated interval. This can help
highlight possible errors. (For more information, see the Enterprise
Controlstation User Guide.)
When a simulation is run using the ENTERPRISE/CS Simulation

facility, job statistics are used by the facility to determine how much
time to allow for the execution of each job.
When viewing information regarding a scheduled job (that is, a job

in the Active Jobs file) in ENTERPRISE/CS, you are provided with
the average runtime and the standard deviation in the Job Details
window. In addition, you can view the job statistics recorded in the
Statistical Details table by selecting the Statistics option from the job
node menu.
The ENTERPRISE/CS display for currently-running jobs includes a

real-time graphical indication of the percentage of the runtime
remaining for each job, based on the jobs runtime statistics.
CONTROL-M generates runtime statistics by compiling information

contained in the Statistical Details table of the CONTROL-M database
and storing this information in a summary table. Runtime statistics for a
given job are passed to the ENTERPRISE/CS workstation each time that
job is ordered.
The compilation and recording of statistical data depends upon the
following CONTROL-M components:
1-28
The CONTROL-M system parameter Statistics must be set to Y (the

default value). This notifies CONTROL-M that you want statistical
data from each successful job execution to be recorded in the
Statistical Details table of the CONTROL-M database. System
parameters are modified using utility ctmsys. For more information,
see ctmsys on page 2-87
The CONTROL-M operational parameter Statistics Mode indicates

the mode used by utility ctmjsa to collect summary statistics:
JOBNAME compiles statistics for each CONTROL-M Job Name
and Node ID where the job was submitted; MEMNAME (default)
compiles them for each CONTROL-M Mem Name/Mem Lib and
Node ID. Operational parameters are modified using the Parameter
Customization menu in the CONTROL-M Menu system. For more
information, see Chapter 4, Maintenance.
The CONTROL-M utility ctmjsa is used to compile the data in the

Statistical Details table and to store the results in a summary table in
the CONTROL-M database. For more information, see ctmjsa on
page 2-46.
It is recommended that you define a CONTROL-M job to run utility

ctmjsa on a daily basis. This will help ensure that the CONTROL-M
database contains current statistics on all jobs executed under
CONTROL-M. A partial cleanup of the Statistical Details table is
performed by the New Day procedure. For more information, see New
Day Procedure on page 1-12.
Utility ctmruninf displays the data from the Statistical Details table
filtered according to date and job information. For more information, see
ctmruninf on page 2-80.
Overview
1-29
CONTROL-M Log
The CONTROL-M log contains a complete audit trail of every event
occurring under the CONTROL-M production environment.
CONTROL-M logs every item of meaningful information about its
operation, and about the jobs under its supervision. Notification of both
routine procedures and error occurrences are recorded in the log.
Among the types of entries recorded in the CONTROL-M log are
messages regarding the following:
Operation of the New Day procedure and User Daily jobs.
Changes in the availability of Control resources, Quantitative

resources and prerequisite conditions.
Job submissions and terminations, reruns, job log (Sysout) handling

and Shout performance.
User actions affecting jobs, whether performed through the

ENTERPRISE/CS workstation or through utilities on the Server
platform.
Failures to adhere to security definitions on the Server platform.
All Shout messages issued byCONTROL-M.
On the ENTERPRISE/CS workstation, CONTROL-M Log entries

relating to a specific job displayed in the active network can be viewed
using the Log window.
On the Server platform, all CONTROL-M Log entries can be viewed
using the CONTROL-M utility ctmlog (described in ctmlog on page 259).
1-30
Entries are placed in the CONTROL-M log continually as long as

CONTROL-M is active. To prevent the log from becoming too large, the
CONTROL-M log is purged once a day by the New Day procedure.
The number of days that entries are retained in the CONTROL-M log
before deletion is determined by CONTROL-M system parameter
Maximum Days Retained by CONTROL-M Log. For more
information, see Chapter 5, Customization Parameters.
A description of the structure of CONTROL-M log entries can be found
in Appendix B.
Overview
1-31

Daylight savings time considerations are described in the following
paragraphs. All examples assume 02:00 a.m. as the time of change.
Advancing the Clock Forward

The following examples assume that the clock is moved ahead at 2:00
a.m. (that is, 2:00 a.m. becomes 3:00 a.m.). If the computer is capable of
changing the clock without restarting the system, do not bring down the
CONTROL-M when the clock is being advanced.
New Day Procedure
No special action should be taken once the clock is advanced.
If the New Day procedure starts before you reset the clock, the New
Day procedure will start working before the clock is advanced, and
will continue normally (even if the clock is advanced while the New
Day procedure is in process).
If the New Day procedure is scheduled to begin at exactly 2:00 a.m.,

the same considerations apply. It is possible that the New Day
procedure will start execution before the clock is manually
changed. Otherwise, changing the clock will initiate New Day
processing.
If the New Day procedure is scheduled to begin between 2:00 a.m.

and 3:00 a.m., once the computer clock is advanced, CONTROL-M/
Server will start the normal New Day processing.
If the New Day procedure is scheduled to begin after 3:00 a.m., no

action is required. CONTROL-M/Server will start the standard New
Day procedure.
1-32
Time-Dependent Shouts
Shout messages scheduled before 2:00 a.m. do not require any

action.
Shout messages scheduled between 2:00 a.m. and 3:00 a.m. will be
issued, even though there may not be a delay in production since the
time frame for production is smaller.
The above also applies to jobs that have shout messages scheduled at
a later time (for example, 6:00 a.m.). These jobs can be considered
late because of the tighter production time frame.
Time-Dependent Schedules (FROM UNTIL or Cyclic Jobs)
Jobs whose scheduled time overlaps the time gap created by the clock
shift may need manual intervention. For example, it is possible that a job
with a FROM value of 2:15 a.m. and an UNTIL value of 2:45 a.m. may
not be submitted at all. These jobs should be manually adjusted. A cyclic
job may have to be deleted and then resubmitted to continue the
processing cycle during the current day.
CONTROL-M Log File
The CONTROL-M Log file will not contain entries with timestamps
between 2:00 a.m. and 3:00 a.m. Any scripts and/or programs that rely
on log entry time should be checked for possible discrepancies as a result
of advancing the clock.
Moving the Clock Backwards

The following examples assume that the clock is moved back at 2:00
a.m. (that is, 2:00 a.m. becomes 1:00 a.m.).
Overview
1-33
New Day Procedure
If the New Day procedure starts before 1:00 am, no special action
should be taken. The New Day procedure will run only once
(between 00:00 and 00:59).
If the New Day procedure starts exactly at 1:00 a.m., computer time
should not be turned back to 1:00 a.m. to avoid another New Day
process. A second New Day procedure requires manual intervention.
It is advisable to wait until 2:01 a.m., for example, and turn the clock
back to 1:01 a.m.
If the New Day procedure is scheduled to begin between 1:00 a.m.

and 2:00 a.m., do one of the following:
Wait at least a full hour after the daily run, and then turn the
clock back as needed; the New Day procedure will have ended.
Update the clock before New Day processing begins.
For example, if the New Day time is 1:45 a.m., the clock should be
moved back one hour no later than 1:44 a.m. If this was not done by
1:44 a.m., the user should wait until 2:46 a.m. and then shift the time
back.
If the New Day procedure is scheduled to begin after 2:00 a.m., no

special action should be taken.
Time-Dependent Shouts
Shout messages scheduled between 1:00 a.m. and 2:00 a.m. may be
issued twice.
Time-Dependent Schedules (FROM-UNTIL or Cyclic Jobs)
No special action should be taken for jobs with FROM-UNTIL or cyclic

schedules. Jobs scheduled to start between 1:00 a.m. and 2:00 a.m. will
start at the first occurrence of that hour (provided that other conditions,
such as input conditions, resources, are met). However, they can be
restarted once the clock is moved back.
1-34
CONTROL-M Log File
The CONTROL-M Log file can contain entries with times earlier than
previous entries, due to the time shift. The same considerations that apply
to advancing the clock forward, should be applied to moving the clock
backwards.
Overview
1-35
CONTROL-M Administrator
The aim of the CONTROL-M administrator is to ensure the smooth and
efficient running of CONTROL-M with minimum interruptions and
optimal usage of available resources. To achieve this aim, the
responsibilities of the CONTROL-M administrator can be summarized as
follows:
Providing appropriate security authorizations to CONTROL-M users

using the CONTROL-M Security Maintenance Utility (ctmsec).
Backing up the CONTROL-M database, CONTROL-M home

directory files and CONTROL-M data directory on a periodic
basis to ensure complete recovery in case of system failure.
Planning CONTROL-M production schedules.
Performing troubleshooting functions, such as:

Performing basic CONTROL-M database maintenance functions
(for example, increasing available space, dumping logs).
Detecting common system problems by analyzing
CONTROL-M logs.
Detecting database problems by analyzing CONTROL-M
database logs.
Collecting and analyzing debug information.
Checking for enough disk space.
Monitoring the CONTROL-M production system; checking that
the database is not at full capacity; removing old prerequisite
conditions.
Cleaning up old and unnecessary log files from the proclog
directory.
Installing all CONTROL-M releases and patches, as needed.
1-36
Heartbeat Monitor
CONTROL-M contains an integral Heartbeat monitor that verifies that
TCP/IP communication with ENTERPRISE/CS is functional and that
ENTERPRISE/CS is responsive to messages from CONTROL-M.
This feature complements the ENTERPRISE/CS Heartbeat monitor that
verifies that communication with CONTROL-M/Server is functional and
that CONTROL-M is responsive to messages from ENTERPRISE/CS.
The CONTROL-M Heartbeat monitor can operate in either of two
modes:
Table 1-3
Heartbeat Monitor Modes
Mode
Description
Active Mode
The CONTROL-M Heartbeat monitor periodically sends a

heartbeat check message through one TCP/IP
connection to ENTERPRISE/CS. ENTERPRISE/CS
repeats the message through the second TCP/IP
connection back to CONTROL-M. If CONTROL-M does not
receive a response to a heartbeat check message within a
limited time period, CONTROL-M assumes that
communication with ENTERPRISE/CS is temporarily
interrupted. CONTROL-M then initiates a procedure to
restore communication with ENTERPRISE/CS. In addition,
CONTROL-M issues a response to heartbeat checks
initiated by ENTERPRISE/CS.
Passive Mode
CONTROL-M does not initiate heartbeat checks, but

CONTROL-M does respond to the heartbeat checks
initiated by ENTERPRISE/CS. In this mode, CONTROL-M
does not automatically attempt to restore communication
with ENTERPRISE/CS if communication is interrupted.
The CONTROL-M Heartbeat monitor uses the parameters that are

contained in file c:\ctmsrv\ctm\data\config.dat, see Table 1-4,
Heartbeat Parameters, on page 1-38.
Overview
1-37
Table 1-4
Heartbeat Parameters
Parameter
Description
CTM_PRM_KPA_ACTIVE
Whether or not the CONTROL-M

Heartbeat monitor operates in active (Y)
or passive (N) mode. Default: N.
CTM_PRM_KPA_BETWEEN_MSGS
Amount of time (in seconds) to wait after

receiving a response to a heartbeat
check before issuing the next heartbeat
check. Default: 300 seconds.
CTM_PRM_KPA_ROUNDTRIP_TIMEOUT
Time (in seconds) to wait for a response

after issuing a heartbeat check before
declaring a communication failure and
initiating corrective actions.
Default: 300 seconds.
Example
CTM_PRM_KPA_ACTIVE
CTM_PRM_KPA_BETWEEN_MSGS
CTM_PRM_KPA_ROUNDTRIP_TIMEOUT
y
300
300
1-38
Utilities
Introduction
CONTROL-M provides general maintenance capabilities through
utilities described in this chapter. Several utilities also generate reports
which are useful for managing the data center and for planning job
processing definitions and calendars.
Note
Many of these utilities are intended for use only by the CONTROL-M
administrator. These utilities require extensive authorization in the
CONTROL-M database and they may not work if submitted by a regular
user.
All the utilities described in this chapter are included in the
CONTROL-M product package. These utilities are run either from the
system prompt or submitted as batch jobs (except where noted).
Those utilities that can be submitted as batch jobs can also be defined as
CONTROL-M jobs. This enables you to utilize the job handling features
provided by CONTROL-M such as automatic scheduling and use of
AutoEdit variables (see examples in this chapter). For more information,
see Utilities on page 2-7 before using this feature.
Note
Unless stated otherwise, the SQL Server must be active when any of the
utilities described in this chapter are in use.
Utilities
2-1
The available CONTROL-M utilities are listed in Table 2-1. Complete

information about each utility is provided later in this chapter.
Table 2-1
CONTROL-M Utilities
Utility
Description
ctm_backup_bcp
Exports data in the CONTROL-M database to directory

bcp_backup. Each database table is backed up as a
separate ASCII file.
ctm_restore_bcp
Imports the CONTROL-M database from the bcp_backup

directory. The content of this directory was created by
utility ctm_backup_bcp.
ctm_ping
Collects configuration information about

CONTROL-M/Agents not in the CONTROL-M database
and performs a communication test.
ctmcontb
Performs operations on the Prerequisite Conditions table.

This utility is similar to ecacontb but provides enhanced
functionality with wild card and odate parameter support.
ctmcpt
Registers a user in the CONTROL-M product registry

database.
ctmcreate
Creates a job in the Active Jobs file.
ctmdbbck
Backs up the CONTROL-M database.
ctmdbcheck
Checks database integrity and displays information about

database memory utilization.
ctmdbrst
Restores the CONTROL-M database.
ctmdefine
Defines a job in the CONTROL-M database.
ctmfw
Detects the successful completion of a file transfer activity.
ctmjsa
Accumulates statistical data and records it in the Statistics

Summary table in the CONTROL-M database.
ctmldnrs
Creates and loads the Manual Conditions file.
ctmloadset
Updates a resource in the Quantitative Resources table

for usage on an Agent platform.
ctmmakedb
Creates a new CONTROL-M database.
ctmlog
Performs a selective cleanup of the CONTROL-M log or

produces a report of CONTROL-M log entries.
ctmordck
Lists a users job processing definitions that can be

ordered by a specific User Daily job.
2-2
Table 2-1
CONTROL-M Utilities
Utility
Description
ctmorder
Orders one or more jobs from a Scheduling table

contained in the CONTROL-M database.
ctmpsm
Performs functions affecting jobs or conditions in the

Active environment.
ctmrpln
Creates a report that lists all or a selection of jobs in a

specified Scheduling table, and indicates when the jobs
are scheduled to run. The report can be requested for a
specific date, month or a five year period.
ctmruninf
Lists and deletes runtime data from the Statistical Details

table of the CONTROL-M database.
ctmsec
Defines users in the CONTROL-M security database and

assigns them authorizations for working with CONTROL-M.
For more details, see Security Maintenance Utility
on page 3-12.
ctmshout
Issues a Shout message to an indicated destination.
ctmshtb
Sets the active Shout Destination table.
ctm_suspend
Suspends CONTROL-M/Server scheduling processes for

mass batch uploads/downloads from ENTERPRISE/CS.
ctmsys
Maintains CONTROL-M system parameters and Shout

Destination tables.
ctmudlst
Enables you to manually set the User Daily last run date.
ctmudly
Orders jobs for a specific User Daily name.
ctmwhy
Displays a report stating why a job waiting in the Active

Jobs file is not being submitted for execution.
dbversion
Displays a general description of the MSSQL database in

use.
ecacontb
Performs operations on the Prerequisite Conditions table.
ecactltb
Lists the status of each resource in the Control Resources

table.
ecaqrtab
Performs operations on the Quantitative Resources table.
Utilities
2-3
Utility Reference Table

Table 2-2
CONTROL-M Utility Reference
Requires
CONTROL-M
Active
Utility
ctm_backup_bcp
ctm_ping
Executable As
Batch
Job
ctm_restore_bcp
ctmcontb
Requires
SQL
Active
Executable
By User
Other Than
CONTROL-M
Admin
X
X
Supports
AutoEdit
Variables
Executable
From Agt
Platform
(Batch
Only)
X
X
ctmcpt
X
x
ctmcreate
ctmdbbck
ctmdbcheck
ctmdbrst
ctmdefine
X
X
ctmlog
ctmmakedb
ctmordck
X
X
ctmfw
ctmjsa
ctmldnrs
ctmloadset
ctmpsm
ctmrpln
ctmruninf
ctmshtb
ctm_suspend
ctmorder
ctmshout
X
2-4
Table 2-2
CONTROL-M Utility Reference (continued)
Utility
Requires
CONTROL-M
Active
Requires
SQL
Active
ctmsys
ctmudlst
ctmudly
Executable
By User
Other Than
CONTROL-M
Admin
Executable As
Batch
Job
ctmwhy
dbversion
Supports
AutoEdit
Variables
Executable
From Agt
Platform
(Batch
Only)
ecacontb
ecactltb
ecaqrtab
Reports Generated From Utilities

The utilities described in this chapter can generate the following reports:
Table 2-3
Utility Reports
Report
Description
Daily Job Order
Generates a projection of which jobs in a

Scheduling table will be ordered on a given day
using a specific calendar. See utility ctmrpln.
Monthly Job Order

Scheduling table will be ordered in a given month
using a specific calendar. See utility ctmrpln.
Yearly Job Order

Scheduling table will be ordered over a five-year
period using a specific calendar. See utility
ctmrpln.
CONTROL-M Log
Lists entries in the CONTROL-M log for specified

(or all) CONTROL-M/Server processes. See utility
ctmlog.
Utilities
2-5
Table 2-3
Utility Reports
Report
Description
User Daily:
Associated Job
Processing Definitions
Lists all jobs associated with a specific User Daily

job and displays security parameters regarding
each job. See utility ctmordck.
Prerequisite Conditions
Displays existing prerequisite conditions. See utility

ctmcontb and ecacontb.
Control Resources
Status
Lists the status of Control resources. See utility

ecactltb.
Quantitative Resources
Status
Lists the status of Quantitative resources. See

utility ecaqrtab.
Summary Statistical
Data
Lists summarized runtime statistics. See utility

ctmjsa.
Runtime Statistical Data
Lists runtime statistical data by timestamp. See

utility ctmruninf.
Directing Output From Utilities

Several utilities included in this chapter generate reports that can be
directed to a file. Each such utility is identified by the inclusion of
<Output> among the utilitys parameters. If this parameter is not
specified, the output is routed to the default output device.
When directing output to a file, do one of the following:
Specify the full path name of the file (for example,

c:\ctmsrv\ctm\user1\rprt.txt).
Specify the relative name of the file to be placed in the

c:\ctmsrv\ctm\ directory.
2-6
Utilities
ctm_backup_bcp
Utility ctm_backup_bcp exports data in the CONTROL-M database to
directory bcp_backup. Each database table is backed up as a separate
ASCII file.
The bcp_backup directory path is
<controlm home directory>/ctm/bcp_backup
To invoke the ctm_backup_bcp utility:
1. Shut down CONTROL-M/Server using command shut-ctm.

2. Specify the command ctm_backup_bcp [-n]
where:
-n
Silent mode. The confirmation prompt and backing up

contents messages are not displayed.
Differences between utility ctm_backup_bcp and utility ctmdbbck:
You can only use utility ctm_backup_bcp if CONTROL-M/Server

is down.
ctm_backup_bcp exports the data in the CONTROL-M database.
ctmdbbck backs up an image of the database for later restoration
using ctmdbrst.
When using ctm_backup_bcp, you cannot specify the backup
directory.
ctm_backup_bcp cannot be invoked from a submenu of ctm_menu.
ctm_backup_bcp backs up each database table to a separate ASCII
file. ctmdbbck backs up the entire database to a single binary file.
When using ctmdbbck and ctmdbrst, the restored database must be
the same size as the original database. When using ctm_backup_bcp
and ctm_restore_bcp, the original and restored databases do not
need to be the same size.
Utilities
2-7
Example 1
The following command is specified:

ctm_backup_bcp
Messages similar to the following are displayed:

Backing up contents of database
Please confirm [y/n] : Y
backing up contents of CMS_NODGRP
backing up contents of CMR_AGSTAT
backing up contents of CMS_AGCOMM
backing up contents of CMS_AGSRVTIM
backing up contents of CMR_AJF
backing up contents of CMS_JOBDEF
backing up contents of CMS_USERS
Database backup ended successfully.
Example 2

ctm_backup_bcp -n
In this case, CONTROL-M/Server does not display the confirmation

prompt and does not issue messages. Only dots are displayed.
2-8
ctm_ping
Utility ctm_ping detects and collects configuration information about
CONTROL-M/Agents. This utility can also connect Agents that are
already in the database, and test communication between them and the
CONTROL-M/Server.
This utility can check if an Agent is down and, if necessary, register it in
the database as unavailable. When the Agent again becomes available,
the state of the Agent is changed and information about it is gathered by
a CONTROL-M process.
To invoke utility ctm_ping, specify the following command:
ctm_ping [<node ID>]
where:
<node ID> is the Host name of the Agent platform to be pinged (tested).
Example 1
To connect and perform a communication test with the Agent jacklin,

specify the following command:
ctm_ping jacklin
The response is:
Agent: jacklin is alive
Example 2
To attempt to connect and test communication with the Agent diana

which is currently down, specify the following command:
ctm_ping diana
The response is:

Utilities
2-9
Agent: diana, Msg: Agent not available.

Example 3
To attempt to connect and test communication with an Agent, specify the

following command:
ctm_ping
The response is:

Enter Agent Name:
2-10
ctm_restore_bcp
Utility ctm_restore_bcp imports the CONTROL-M database from the
bcp_backup directory. The content of this directory was created by
utility ctm_backup_bcp.
To invoke the ctm_restore_bcp utility:
1. Shut down CONTROL-M/Server using the command shut-ctm.

2. Specify the command: ctm_restore_bcp [-n]
where:
-n
Silent mode. The confirmation prompt and restoring

contents messages are not displayed.
Differences between utility ctm_restore_bcp and utility ctmdbrst:
ctm_restore_bcp imports files created by ctm_backup_bcp.

ctmdbrst restores a backup created by ctmdbbck.
When using ctm_restore_bcp, you cannot specify the directory
containing the exported files.
You can only use utility ctm_restore_bcp if CONTROL-M/Server is
down.
ctm_restore_bcp cannot be invoked from a submenu of ctm_menu.
ctm_restore_bcp imports ASCII files. ctmdbrst restores from a
binary file.
Utilities
2-11
Example 1

ctm_restore_bcp
Messages similar to the following are displayed:

Restoring contents of database.
This procedure DELETES any information in main
database
Please confirm [y/n]: y
restoring contents of CMS_NODGRP
restoring contents of CMR_AGSTAT
restoring contents of CMS_AGCOMM
restoring contents of CMS_AGSRVTIM
restoring contents of CMR_AJF
restoring contents of CMS_JOBDEF
restoring contents of CMS_USERS
Database restore ended successfully.
Example 2

ctm_restore_bcp -n
In this case, CONTROL-M/Server does not display the confirmation

prompt and the restoring contents messages. Only dots are displayed.
2-12
ctmcontb
ctmcontb performs operations on the Prerequisite Conditions table.
These operations include:
Listing existing prerequisite conditions.

Adding/deleting a prerequisite condition.
Deleting a range of conditions (from/to specified dates).
Note
ctmcontb is similar to utility ecacontb but provides enhanced

functionality with wild card and odate parameter support.
Specify the following command to list existing prerequisite conditions:

ctmcontb -LIST <Condition Name> <Condition Date>
[<Output>]
Table 2-4
ctmcontb Parameters
Variable
Description
<Condition Name>
Name of the prerequisite condition to include in the

report. The condition name can include the mask
character to denote any number of characters
(including no characters). In this instance, the
condition name must be enclosed in quotation
marks (for example, LVL ). Specify by itself to
include all existing conditions.
<Condition Date>
Date of the prerequisite condition. Must be

specified in mmdd format. The condition date can
include the mask character to denote any number
of characters (including no characters). In this
instance, the condition date must be enclosed in
quotation marks (for example, 12). Specify by
itself to include all dates. Specify ODAT to accept
the CONTROL-M date.
<Output>
Full path name to which the report should be sent

(optional). If this parameter is not specified, the
output is routed to the default output device.
Utilities
2-13
Specify the following command to add prerequisite conditions:

ctmcontb -ADD <Condition Name> <Condition Date>
Variable
Description
<Condition Name>
Name of prerequisite condition to add.
<Condition Date>
Date of the prerequisite condition. Must be specified in

mmdd format. Specify ODAT to accept the
CONTROL-M date.
Specify the following command to delete prerequisite conditions:

ctmcontb -DELETE <Condition Name> <Condition Date>
Variable
Description
<Condition Name>
Name of prerequisite condition to delete. The

condition name can include the mask character to
denote any number of characters (including no
characters). In this instance, the condition name
must be enclosed in quotation marks (for
example, LVL ). Specify by itself to include all
existing conditions.
<Condition Date>
Date of the prerequisite condition. Must be

specified in mmdd format. The condition date can
include the mask character to denote any number
of characters (including no characters). In this
instance, the condition date must be enclosed in
quotation marks
(for example, 12 ). Specify by itself to include
all dates. Specify ODAT to accept the
CONTROL-M date.
2-14
Specify the following command to delete prerequisite conditions with

condition dates in a given range:
ctmcontb -DELETEFROM <Condition Name> <From Date>
<To Date>
Variable
Description
<Condition Name>
Name of prerequisite conditions to delete. The

condition name can include the mask character to
denote any number of characters (including no
characters). In this instance, the condition name
must be enclosed in quotation marks (for
example, LVL ). Specify by itself to include all
existing conditions.
<From Date>
<To Date>
Starting and ending dates for range of condition

dates of prerequisite conditions to delete. Each
date must be specified in mmdd format.
If the To Date is less than the From Date, the
range of condition dates will include the From Date
up to the end of the year (1231) plus the beginning
of the year (0101) up to the To Date.
Example 1
The following command specifies that the prerequisite condition

bckp_end with condition dates in December should be deleted:
ctmcontb -DELETE bckp_end "12*"
Example 2
The following command specifies that all prerequisite conditions with

prefix a, whose condition dates fall in the range Dec. 1 to Dec. 15 should
be deleted:
ctmcontb -DELETEFROM "a*" 1201 1215
Utilities
2-15
Example 3
The following command specifies that all existing prerequisite conditions

should be listed:
ctmcontb -LIST "*" "*"
When this command is specified, a report similar to the following is

generated:
Figure 2-1
Sample Report from Utility ctmcontb
Date: 30-JUN-2000.
Page 1
Conditions list
+--------------------------------------+
CONDNAME
CONDDATE
+--------------------------------------+
APR1-L20
0629
APR1-L20
0630
ARD-L3OK
0630
LVL11-LVL22 0628
LVL11-LVL22 0629
PKR11-LVL01 0630
This example demonstrates the advantage of defining a CONTROL-M

job to run a utility. The following job processing definition causes
CONTROL-M to run ctmcontb each work day, each time deleting all
prerequisite conditions that are between five and ten days old:
Figure 2-2
Job Processing Definition With Utility ctmcontb
Week Days 2,3,4,5,6

AutoEdit Assignment%%A=%%CALCDATE %%DATE -10
%%B=%%CALCDATE %%DATE -5
%%A=%%SUBSTR %%A 3 4
%%B=%%SUBSTR %%B 3 4
Command Linectmcontb -DELETEFROM * %%A %%B
2-16
ctmcpt
ctmcpt registers a user in the CONTROL-M product registry database.
The Shout to Email facility requires that CONTROL-M/Server be
running as either a service or program under the account of a user who is
registered in the CONTROL-M product registry database. For more
information, see Shout to Email on page 1-26.
Specify the following command to register a user for the first time:
ctmcpt <user name> <password>
Specify the following command to change the password for a user who is
already registered:
ctmcpt <user name> <old password> <new password>
Note
This password file is an encrypted file.

Example
The following command registers the user user1 with password default:
ctmcpt user1 default
Utilities
2-17
ctmcreate
ctmcreate is an API (Application Program Interface) utility that allows
an special job to be inserted directly into the Active Jobs file. The job
does not have to be defined in the CONTROL-M database. The function
performed by this utility is equivalent to the Force function in
ENTERPRISE/CS.
Specify the following command to invoke utility ctmcreate:

Figure 2-3
Utility ctmcreate
ctmcreate
-tasktype {JOB|DETACHED|COMMAND|DUMMY} /
-group <group name>
/
-application <application name>
/
[ -nodegrp <node ID/group> ]
/
[ -memlib <directory name> ]
/
[ -memname <file name> ]
/
[ -cmdline <command line text> ]
/
[ -jobname <name of job> ]
/
[ -schedtab <name of scheduling table> ]
/
[ -owner <user name of job owner> ]
/
[ -odate <scheduling date>|ODAT ]
/
[ -maxrerun <maximum reruns> ]
/
[ -timefrom <earliest submission time> ] /
[ -timeuntil <latest submission time> ] /
[ -priority <job priority> ]
/
[ -critical {Y|N} ]
/
[ -cyclic {Y|N} ]
/
[ -confirm {Y|N} ]
/
[ -interval <minutes> ]
/
[ -overlib <alternate directory> ]
/
[ -maxwait <days> ]
/
[ -description <job description> ]
/
[ -docmem <file name> ]
/
[ -doclib <directory name> ]
/
[ -incond <condition> <date> {AND|OR} ]
/
[ -outcond <condition> <date> {ADD|DEL} ]
/
[ -autoedit <variable name> <expression> ]
/
[ -quantitative <quantitative resource> <quantity> ] /
[ -sysout {RELEASE|DELETE}|{COPY|MOVE [<parameter>]} /
[ -control <control resource> {E|S} ]
/
[ -shout {OK|NOTOK|RERUN|LATESUB|LATETIME|
/
EXECTIME} <destination> {R|U|V} <message> [<time>] ] /
[ -on <statement> <code> /
[ -dook ] /
[ -donotok ] /
[ -dorerun ] /
[ -doshout <destination {R|U|V} <message> ]/
[ -docond <condition> <date> {ADD|DEL} ] /
[ -doautoedit <variable name> <expression> ]/
[ -doforcejob <table name> <job name> <odate> ] /
[ -dosysout
{RELEASE|DELETE|COPY|MOVE} [<parameter>] ] ] /
[ -debug <debug level 1-5> ] /
[ -quiet ]
2-18
Each ctmcreate parameter is described in the Enterprise Controlstation

User Guide. Each of these parameters and the name used for it in the
Enterprise Controlstation User Guide is listed in Table 2-5.
Table 2-5
Parameter Name Cross Reference
Utility Parameter
ENTERPRISE/CS
Parameter
Utility Parameter
ENTERPRISE/CS
Parameter
application
Application
interval
Interval
autoedit
AutoEdit Assignments
jobname
Job Name
cmdline
Command Line
maxrerun
Max Rerun
confirm
Confirm Submission
maxwait
Max Wait
control
Control Resources
memlib
Mem Lib
critical
Critical
memname
Mem Name
cyclic
Cyclic
nodegrp
Node ID/Group
debug
Debug
odate
see note below
description
Description
on
On Statement/Code
doautoedit
Do AutoEdit
outcond
Out Conditions
doclib
Doc Lib
overlib
Over Lib
docmem
Doc Mem
owner
Owner
docond
Do Cond
priority
Priority
doforcejob
Do Forcejob
quantitative
donotok
Do NOTOK
quiet
Quiet
dook
Do OK
schedtab
Scheduling Table
dorerun
Do Rerun
shout
Shout
doshout
Do Shout
sysout
Option, Parm
dosysout
Do Sysout
tasktype
Task Type
group
Group
timefrom
Time
incond
In Conditions
timeuntil
Time
Note
Parameter odate specifies the jobs scheduling date. Specify a date in

yyyymmdd format, or specify ODAT to accept the CONTROL-M date.
Utilities
2-19
The following syntax rules apply when using this utility:
The command must be written on one line.
More than one parameter can be specified on a line.
The maximum number of characters per line (512 or 1024) is

determined by the platforms command processor input restriction.
Although most parameters are optional, some parameters are

required depending on the option specified for the -tasktype
parameter.
Strings containing blanks must be enclosed in quotes

(for example, -cmdline ctmudlst list payroll).
Condition dates are specified in mmdd format. Time is specified in

hhmm format.
A parameter requiring more than one entry can be repeated as many

times as necessary. (For example, if a job must wait for several
prerequisite conditions, specify a separate -incond parameter for
each prerequisite condition).
An -on parameter must be followed by at least one -do... parameter.
-do... parameters depend on the last -on parameter preceding them.
The order of the parameters does not affect the outcome of the job,
with the exception of -on and -do... parameters.
When using -doforcejob to force an entire table, <job name> must

be specified as a blank enclosed in quotes (that is, ).
When ctmcreate is invoked within a script: To use the option

for a -incond date parameter, specify this parameter as .
If a single character is specified for the priority parameter, the first

character is assumed to be A. For example, priority r is interpreted
as priority Ar. (The priority parameter is not case-sensitive.)
2-20
Example
-incond pk_oly_ok "****"
It is possible to specify a Windows NT logon domain and user name

with the -owner parameter. The format is Logon Domain\Owner or
.\Owner for a locally defined owner. If only the owner name is
specified, the logon for the Windows NT user will be performed
from the domain specified in the Windows NT Agent Configuration
window.
Example
-owner .\controlm
When using -sysout to COPY or MOVE a Sysout file, you must

specify a path name with a file name.
Example 1
The following command, entered on one line, contains the minimum

parameters required to create a job in the Active Jobs file:
ctmcreate
-tasktype command
-group ecs
-application test -cmdline "dir"
Example 2
The following command includes examples of most of the parameters

that can be used to create a job in the Active Jobs file:
Utilities
2-21
ctmcreate -tasktype JOB

-cyclic N \
-description "Daily Summary" \
-group SUPPLY -application SUPPLIES \
-memlib c:\users\ctm\ -memname PROLYPAR -nodegrp
WNTGRP \
-jobname PROLYPAR \
-owner suppman \
-odate 19931130 \
-timeuntil 1800 \
-priority AA -critical N \
-confirm Y \
-doclib c:\users\supply\doc\ -docmem prolypardoc \
-incond pk_oly_ok ODAT AND \
-incond pk_olp_ok ODAT AND \
-outcond pk_oly_ok ODAT DEL \
-outcond pk_olp_ok ODAT DEL \
-outcond pk_olypar ODAT ADD \
-autoedit %%PARM1 "%%CALCDATE %%ODATE -2" \
-quantitative tape 2 -quantitative cpu 50
\
-sysout MOVE c:\test\logs\<file name> \
-control disk2 E \
-shout OK oper2 U "Daily summary completed" \
-on "COPY JWINFO_2507" "%COPY-E-OPENIN, error" \
-dosysout MOVE c:\oper\openerr\
2-22
ctmdbbck
ctmdbbck backs up the CONTROL-M database.
Specify the following command to invoke utility ctmdbbck:

ctmdbbck [<Backup Device>]
where <Backup Device> is the device to be used for backup of the

existing database. The device specified for this parameter must be a valid
device defined in the database. A list of devices can be obtained using
the option List Backup Devices from the Database Maintenance menu.
The default backup device is tapedump2.
Example
ctmdbbck tapedump2
Utilities
2-23
ctmdbcheck
Utility ctmdbcheck displays information about the memory capacity and
the status of the CONTROL-M database.
To invoke the ctmdbcheck utility, specify the following command:

ctmdbcheck
Utility ctmdbcheck can also be used with the following syntax to

monitor the database and the transaction log:
ctmdbcheck [-d <db_threshold_%>] [-l
<log_threshold_%>]
ctmdbcheck [general_threshold %]
These commands trigger a shout message to ENTERPRISE/CS if more

than the specified percentage of the database and/or the database
transaction log are full. This message can then be used to trigger actions
that will extend the appropriate CONTROL-M database component.
The parameters in these commands are described in Table 2-6.
2-24
Table 2-6
ctmdbcheck Parameters
Parameter
Description
db_threshold_%
Indicates a threshold for usage of the CONTROL-M

database. If more than the specified percentage of
the database is full, a Shout message is sent to
ENTERPRISE/CS warning that the database
should be extended.
This variable must be preceded by the -d switch.
For example, -d80 indicates that a shout message
should be issued if the database is more than 80%
full.
log_threshold_%
Indicates a threshold for usage of the transaction

log for the CONTROL-M database. If more than
the specified percentage of the database is full, a
Shout message is sent to ENTERPRISE/CS
warning that the transaction log should be
extended.
This variable must be preceded by the -l switch.
For example, -l80 indicates that a shout message
should be issued if the transaction log is more than
80% full.
general_threshold_%
Checks data and log partitions of the CONTROL-M

database by the same percentage (e.g., if percent
usage of either the data area or the transaction log
exceeds 80%, ctmdbcheck 80 triggers a Shout
message).
ctmdbcheck Output
Utility ctmdbcheck returns information about the status of the

CONTROL-M database. Table 2-7 describes the fields that are returned
by this utility.
Utilities
2-25
Table 2-7
ctmdbcheck Displayed Fields
Field
Description
db total
Total amount of memory (in KB) allocated for the

database.
data
Total amount of memory (in KB) allocated to the

Data partition of the database.
log
Total amount of memory (in KB) allocated to the

Log partition of the database.
Data used
Total memory currently used in the Data partition.
Log used
Total memory currently used in the Log partition.
In addition to the above fields, ctmdbcheck also returns one of the

following messages describing the current database status:
Database is OK.
WARNING: Database is more than half full.
ATTENTION: Database log segment is more than 90%
full.
ATTENTION: Database is more than 80% full.
Example 1
This example uses utility ctmdbcheck to check database status without

specifying any parameters (i.e., no shout messages will be issued for this
run on the utility, even if database is over the desired threshold).
Utility Input
ctmdbcheck
Utility Output
db total = 25000.0 KB (data= 19500.00 , log= 5500.00)
data used = 3696 KB (18%).
log used = 0 KB (0%).
Checking database...
Database is OK.
2-26
Example 2
Utility Input
ctmdbcheck -d80
Utility Output
Message Warning: DB is more than 80% full, urgency
'U' NodeID 'linda' Shout to user 'ECS' 'SUCCESS'
data used = 21250 KB (85%).
Database is OK.
This example produces the same display as ctmdbcheck except that a

warning message is generated if the percent usage of the data area is
higher than the percentage specified in the command. In this example,
the message data used = 21250 KB (85%) was generated because 85%
exceeds the specified threshold of 80%. This message is also sent to the
ENTERPRISE/CS alert window.
Example 3
Utility Input
ctmdbcheck -l80
Utility Output
data used = 21250 KB (85%).
Database is OK.
This command is similar to the example above except that here the Log
partition is being checked. No warning message is generated because 0%
is less than the specified threshold of 80%.
Utilities
2-27
ctmdbrst
ctmdbrst restores the CONTROL-M database.
Specify the following command to invoke utility ctmdbrst:

ctmdbrst [<Backup Device>]
where <Backup Device> is the device from which the database should
be restored. The device specified for this parameter must be a valid
device defined in the database. A list of devices can be obtained using
the option List Backup Devices from the Database Maintenance menu.
Note
Shut down CONTROL-M/Server before invoking this utility. Make sure

that there are no other users or processes, using the same database, that
are connected to the SQL Server.
The default backup device is tapedump2.
Example
The following command causes the CONTROL-M database to be

restored from the default backup device:
ctmdbrst
ctmdefine
ctmdefine is an API (Application Program Interface) utility that adds a
job processing definition to a Scheduling table in the CONTROL-M
database. This utility can be used when converting job scheduling
information from other job control products to CONTROL-M. The
function performed by this utility is equivalent to the manual process of
creating job processing definitions, described in the Enterprise
Controlstation User Guide.
2-28
When creating new Scheduling tables or job processing definitions, the

following considerations are applicable:
If the job name specified when using this utility already exists in a
job processing definition in the Scheduling table, the new job
processing definition does not overwrite the existing one. Both job
processing definitions will appear in the table, each with a different
internal job number.
If the Scheduling table specified when using this utility does not
exist, the utility creates it.
After using this utility to create one or more job processing

definitions, the modified Scheduling tables should be downloaded to
the ENTERPRISE/CS database (see the Enterprise Controlstation
User Guide).
A newly-created Scheduling table can be assigned a User Daily

parameter using utility ctmpsm.
Utilities
2-29
Specify the following command to invoke utility ctmdefine:

ctmdefine -table <Scheduling table name> /
-jobname <job name>
/
-group <group name> /
-application <application name> /
[-tasktype {JOB|DETACHED|COMMAND|DUMMY}] /
[ -nodegrp <node ID/group> ]
/
[ -memlib <directory name> ]
/
[ -memname <file name> ]
/
[ -cmdline <command line text> ]
/
[ -owner <user name of job owner> ]
/
[ -maxrerun <maximum reruns> ]
/
[ -timefrom <earliest submission time> ]
/
[ -timeuntil <latest submission time> ]
/
[ -priority <job priority> ]
[ -critical {Y|N} ]
/
[ -cyclic {Y|N} ]
/
[ -confirm {Y|N} ]
/
[ -interval <minutes> ]
/
[ -overlib <alternate directory> ]
/
[ -maxwait <days> ]
/
[ -description <job description> ]
/
[ -docmem <file name> ]
/
[ -doclib <directory name> ]
/
[ -incond <condition> <date> {AND|OR} ]
/
[ -outcond <condition> <date> {ADD|DEL} ]
/
[ -autoedit <variable name> <expression> ] /
[ -quantitative <quantitative resource> <quantity> ] /
[ -sysout {RELEASE|DELETE}|{COPY|MOVE [<parameter>]} /
[ -control <control resource> {E|S} ]
/
[ -shout {OK|NOTOK|RERUN|LATESUB|LATETIME| /
EXECTIME} <destination> {R|U|V} <message> [<time>] ] /
[ -on <statement> <code>
/
[ -dook ]
/
[ -donotok ] /
[ -dorerun ] /
[ -doshout <destination {R|U|V} <message> ]
/
[ -docond <condition> <date> {ADD|DEL} ]
/
[ -doautoedit <variable name> <expression> ]
/
[ -doforcejob <table name> <job name> <odate> ] /
[ -dosysout
{RELEASE|DELETE|COPY|MOVE}[<parameter>]]] /
[ -days <days string> ] /
[ -weekdays <weekdays string> ] /
[ -month {ALL|JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC} {Y|N}
[ -date <mmdd> ] /
[ -calendar <calendar name> ] /
[ -retro {Y|N} ] /
[ -debug <debug level 1-5> ] /
[ -quiet ]
]/
Each parameter employed in the command is described in the Enterprise

Controlstation User Guide. Each ctmdefine parameter and the name
used for the parameter in the Enterprise Controlstation User Guide is
listed in Table 2-8, ctmdefine Parameters, on page 2-31.
2-30
Table 2-8
ctmdefine Parameters
Utility Parameter
ENTERPRISE/CS
Parameter
Utility Parameter
ENTERPRISE/CS
Parameter
application
Application
interval
Interval
autoedit
AutoEdit Assignments
jobname
Job Name
calendar
Days Calendar
maxrerun
Max Rerun
cmdline
Command Line
maxwait
Max Wait
confirm
Confirm Submission
memlib
Mem Lib
control
Control Resources
memname
Mem Name
critical
Critical
month
See below
cyclic
Cyclic
nodegrp
Node ID/Group
date
Dates
on
On Statement/Code
days
Days
outcond
Out Conditions
debug
Debug
overlib
Over Lib
description
Description
owner
Owner
doautoedit
Do AutoEdit
priority
Priority
doclib
Doc Lib
quantitative
docmem
Doc Mem
quiet
Quiet
docond
Do Cond
retro
Retro
doforcejob
Do Forcejob
shout
Shout
donotok
Do NOTOK
sysout
Option, Parm
dook
Do OK
table
Scheduling Table
dorerun
Do Rerun
tasktype
Task Type
doshout
Do Shout
timefrom
Time
dosysout
Do Sysout
timeuntil
Time
group
Group
weekdays
Weekdays
incond
In Conditions
Utilities
2-31
Note
For the -month parameter, specify the first three letters of a month (for
example, JAN) or ALL for all months (the default is none). To specify
two or more individual months, use a separate -month parameter for
each month.
The following syntax rules apply when using this utility:
The command must be written on one line.
More than one parameter can be specified on a line.
The maximum number of characters per line (512 or 1024) is

determined by the platforms command processor input restriction.
Although most parameters are optional, certain parameters are

required depending upon the option specified for parameter
-tasktype.
Strings containing blanks must be enclosed in quotes

(for example, -cmdline ctmudlst list payroll).
Condition dates are specified in mmdd format. Time is specified in

hhmm format.
A parameter requiring more than one entry can be repeated as

needed:
If a job is dependent upon several prerequisite conditions,
specify a separate -incond parameter for each prerequisite
condition.
If a job can run only in January and July, specify a separate
-month parameter for each month (that is, -month JAN Y month JUL Y).
If a job should run every month except July, specify -month
ALL Y and -month JUL N.
2-32
An -on parameter must be followed by at least one -do... parameter.
-do... parameters are dependent upon the last -on parameter

preceding them.
The order of the parameters does not affect the outcome of the job,
with the exception of -on and -do... parameters.
When using -doforcejob to force an entire table, <job name> must

be specified as a blank enclosed in quotes (that is, ).
When ctmdefine is invoked within a script: To use the option

for an -incond date parameter, specify this parameter as \ \.
-incond pk_oly_ok \"****\"
It is possible to specify a Windows NT logon domain and user name

with the -owner parameter. The format is Logon Domain\Owner or
.\Owner for a locally defined owner. If only the owner name is
specified, the logon for the Windows NT user will be performed
from the domain specified in the Windows NT Agent Configuration
window.
-owner .\controlm
If a single character is specified for the -priority parameter, the first

character is assumed to be A. For example, priority r is interpreted as
-priority Ar. (The -priority parameter is not case-sensitive.)
When you use -sysout to COPY or MOVE a sysout file, you must
specify a path name with a file name.
Utilities
2-33
Example 1
The following command, which is entered on one line, contains the

minimum parameters required to define a job:
ctmdefine table cmmnds -jobname cmls13 -tasktype
command -group ecs -application test -date 0101
-cmdline "dir"
Example 2
The following command includes examples of most of the parameters

that can be used to define a job:
ctmdefine -tasktype JOB
-cyclic N
-table djsales -jobname dj102
-description "Daily Summary"
-group SUPPLY
-application SUPPLIES
-memlib "c:\users\ctm\" -memname PROLYPAR
-nodegrp WNTGRP
-owner suppman
-month MAR Y -month JUN Y -month SEP Y -month DEC Y
-timeuntil 1800
-priority AA -critical N
-confirm Y
-doclib "c:\users\supply\doc\" -docmem prolypardoc
-incond pk_oly_ok ODAT AND
-incond pk_olp_ok ODAT AND
-outcond pk_oly_ok ODAT DEL
-outcond pk_olp_ok ODAT DEL
-outcond pk_olypar ODAT ADD
-autoedit %%PARM1 "%%CALCDATE %%ODATE -2"
-quantitative tape 2 -quantitative cpu 50
-sysout MOVE "c:\test\logs\<file name>"
-control disk2 E
-shout OK oper2 U "Daily summary completed"
-on "COPY JWINFO_2507" "%COPY-E-OPENIN, error"
-dosysout MOVE "c:\oper\openerr\"
-on * notok
-dorerun
-doshout ecs v "Daily summary failed. Attempting
rerun"
2-34
ctmfw
The CONTROL-M File Watcher utility, ctmfw, detects the following file
processes:
Successful completion of file transfer

Creation of a file
Deletion of a file
ctmfw can be used before activating a job or before performing a task

(for example, sending a shout message or adding/deleting conditions)
that is dependent upon creation or deletion of a file.
Utility ctmfw runs as a process on a client machine. The process waits
for the creation or deletion of specified file(s).
For a file transfer activity, when the file is detected, the job continues
to monitor the size of the file. When the file reaches a specified
minimum size and does not increase in size for a specified period of
time, the File Watcher utility either completes with a status of OK or
executes a specified DO action. DO actions can consist of adding or
deleting conditions or executing a command.
For file creation or deletion, file size is ignored.
For a file deletion, ctmfw must first detect the existence of the file
before it can detect its deletion.
Utility ctmfw can also be run from the command line.

Utility ctmfw can be invoked to detect either a single file or multiple
files.
ctmfw is supplied as both a regular program (ctmfw.exe) and as a service
program (ctmfw_service.exe). For more information, see Windows NT
File Watcher Service on page 2-44.
Utilities
2-35
To watch a single file:
Specify the following command in the \ctmag\exe\ directory to invoke

ctmfw for a single file:
ctmfw <filename> [mode] [min_size] [sleep_int]
[mon_int] [min_detect] [wait_time]
The parameters are described below in Table 2-9.

The procedure for watching multiple files is described on page 2-39.
The parameters in this command are identified by their sequence.
Although all parameters are optional, you cannot skip a parameter and
assign a value to a subsequent parameter. The first value is assumed to be
the desired mode, the second value is assumed to be the min_size, and so
forth.
If only five values are specified, the default value for wait_time is used.
If four parameters are specified, default values for min_detect and
wait_time are used, and so forth. For example:
ctmfw /tmp/temp1/<file_name> CREATE 100 10
is resolved using default values for mon_int, min_detect and wait-time
as follows:
ctmfw /tmp/temp1/<file_name> CREATE 100 10 10 3 0
2-36
Table 2-9
ctmfw Parameters
Variable
Description
filename
Path of the file to be detected. The file name can include

mask character * to represent any number of characters
(including no characters). In this case, enclose the full path
name in quotation marks (for example, c:\ctm\a*.txt).
When including an * as part of a file name in a Rules file
(see the Note on page 2-40), the name should not be
enclosed in quotation marks. When a wildcard is used,
ctmfw does not monitor the size of the file.
mode
CREATE
Detects creation of a file. If filename

includes a wildcard, the size of the file is
ignored. Default.
DELETE
Detects deletion of a file. When ctmfw is run

in this mode, it first checks for files that
match the specified name or mask.
If no existing file matches the specified
name or mask, utility ctmfw ends with an
error.
If matching files are detected, the utility
waits the specified amount of time and
checks for the deletion of these files.
When no files matching the specified
name or mask exist, the utility assumes
that they have been deleted and returns a
value of OK.
Note: If additional files that match the
specified name or mask are created during
the interval between starting the utility and
the time it checks for deletion, the utility will
not return a value of OK until these files are
also deleted.
min_size
Minimum file size (in bytes). This parameter is ignored when

using wildcards in filename or when using DELETE mode.
Default: 0 (any size detected).
sleep_int
Interval between successive attempts to detect the existence

or deletion of a file (in seconds). Default: 60 seconds.
mon_int
Interval between attempts to monitor the size of a file after it

is detected (in seconds). This parameter is ignored when
using wildcards in filename or when using DELETE mode.
Default: 10 seconds.
Utilities
2-37
Table 2-9
ctmfw Parameters
Variable
Description
min_detect
Number of attempts to monitor the file size where the size

remains static and greater than or equal to min_size
(indicating successful creation of the file). This parameter is
ignored when using wildcards in filename or when using
DELETE mode. Default: 3 attempts.
wait_time
Maximum time (in minutes) to run the process without

detecting the file at its minimum size (CREATE) or detecting
its deletion (DELETE). If the file is not detected or deleted in
this specified time frame, the process terminates with an
error return code, as described in Table 2-10. Default: 0 (no
time limit).
Return Codes
The return codes listed in Table 2-10 are issued by utility ctmfw after
detecting if a file is created or deleted in the specified time frame.
Table 2-10
ctmfw Return Codes
Return Code
Description
File successfully created (file arrived in the specified time

frame and file size is above or equal to the minimum
specified size) or deleted.
File was not created or deleted in the specified time frame.
2-38
To watch multiple files:
Specify the following command in the \ctmag\exe\ directory to invoke

ctmfw for multiple files:
ctmfw -input <rules_filename>
where <rules_filename> is the fully-qualified name (path) of the file

containing the definitions for each file to be detected.
The Rules file contains two sections:
ON_FILEWATCH statements identifying which files to detect,

specific criteria for each file, and the action to take upon detection or
non-detection. Any number of ON_FILEWATCH statements can
appear in a Rules file.
Default values to use for the ON_FILEWATCH statements. The

MIN-SIZE, MIN-DETECT, and WAIT-TIME parameters are the
same as for a single file, as described in Table 2-9, ctmfw
Parameters, on page 2-37. Two additional parameters are available,
as described in Table 2-11.
Note
All keywords must be entered in uppercase.
Table 2-11
ON_FILEWATCH Statements Additional Parameters
Parameter
Description
INTERVAL
Sleep interval between succeeding scans for all the files.

This parameter replaces the individual sleep_int and
mon_int parameters for each file. Default: 10 seconds.
FROM_TIME
Starting time for detecting all the files (default FROM_TIME).

Used with WAIT_TIME to identify the time frame for detecting
and monitoring the files. This parameter is expressed in
24-hour, hhmm format. Default: 0000.
Utilities
2-39
If a mandatory parameter is omitted from a Rules file, the default value

for that parameter is used. Parameters entered for ON_FILEWATCH
statements override the default values. If entered, they must appear in the
order shown in Figure 2-4 on page 2-40.
Note
In a Rules file, if a filename in an ON_FILEWATCH statement contains

a wildcard (*), the name and path must not be embedded in quote marks.
Figure 2-4
ON_FILEWATCH Statements
#******************************************************************
# Mandatory Parameters
INTERVAL <60>
# Sleep interval (seconds)
FROM_TIME <0000>
# Starting time for all files (hhmm)
MIN_SIZE <0>
# Minimum size for all files (bytes)
MIN_DETECT <3>
# Number of iterations for all files
WAIT_TIME <0>
# Time limit for all files (minutes)
# ON_FILEWATCH statements
ON_FILEWATCH <filename> [mode] [min_size] [min_detect] [wait_time]
[from_time] [cyclic_interval]
THEN
<action>
ELSE
<action>
END_ON
#******************************************************************
Figure 2-4 displays a sample Rules file. In this sample:
Default values are shown for all mandatory parameters.
# indicates comments.
from_time is the time from which to watch for the specified file
action.
cyclic-interval is the interval (in minutes) between successive

attempts to detect a file. This interval must be greater than the value
specified for wait_time. If cyclic-interval is 0, only one attempt to
detect the file will be performed. Default: 0.
<action> refers to any of the parameters described in Table 2-12.
2-40
Note
All keywords must be entered in uppercase.
Table 2-12
ctmfw Valid Actions
Action
Description
DO_COND <condition name>

<condition date> <+|->
Add (+) or delete (-) a condition.
DO_CMD <command>
Execute a valid command under the

command interpreter. Full path names
are required for files.
DO_OK
Terminate ctmfw with status OK.
DO_NOTOK [exit code]
Terminate ctmfw with status NOTOK.

Exit code is optional and replaces the
standard return code described in
Table 2-10.
If the file is detected and the size remains static in the time frame
(CREATE) or the file has been deleted (DELETE), the DO
commands in the THEN block are executed.
If the file is not detected or deleted in the time frame, the statements
following the ELSE block are executed.
ctmfw terminates when either all the files in the Rules file have been
processed or a DO_OK/DO_NOTOK action is executed.
Note
If any ON_FILEWATCH statement contains a cyclic_interval

parameter, ctmfw will only terminate on a DO_OK/DO_NOTOK action.
Utilities
2-41
Example 1
Utility ctmfw is invoked to watch multiple conditions. The definitions

the utility uses for watching each file is contained in a Rules file.
The following instructions are defined in the Rules file:
The sleep interval between succeeding scans must be 10 seconds.
If utility ctmfw detects that the file datafile.txt in directory

c:\controlm is created in the specified time interval, then:
condition datafile dated 1 January must be added.
The command interpreter must execute the command to move the

contents of the file c:\ctm\datafile.txt to c:\ctm\workfile.txt.
If utility ctmfw detects that the file datafile.txt in directory

c:\controlm is not created in the specified time interval, then
condition datafile dated 1 January must be deleted.
When utility ctmfw detects that the file c:\ctm\tempfile.txt is

deleted, condition tempfile dated 1 January must be deleted.
#****************************************************
INTERVAL 10
ON_FILEWATCH c:\controlm\datafile.txt CREATE
THEN
DO_COND datafile 0101 +
DO_CMD move c:\ctm\datafile.txt c:\ctm\workfile.txt
ELSE
DO_COND datafile 0101 END_ON
ON_FILEWATCH c:\ctm\tempfile.txt DELETE
THEN
DO_COND tempfile 0101 END_ON
#****************************************************
2-42
Example 2
A job processing definition is created to implement a File Watcher job.

The file must arrive between 19:00 and 22:00, and be created in the \tmp
directory under the name trans.dat. The minimum file size is 100 bytes.
The detection process should be performed each minute. The file size
must be monitored every 10 seconds, and the number of intervals where
the file size remains static is 5. If the file is not detected by 22:00, an
alert should be sent to ENTERPRISE/CS.
Parameter
Value
Job Name
FileWatch
Mem Name
FileWatch
Owner
<control_m_user>
From Time
1900
Command line
ctmfw c:\tmp\trans.dat CREATE 100 60 10 5 180
On Statement/Code processing:
Stmt
Code
COMPSTAT=0
Do Cond
file_trans_dat_ok Date: ODAT Sign: +
Stmt
Code
COMPSTAT=1
Do Shout
To: ENTERPRISE/CS
Text: File trans.dat did not arrive on time
Utilities
2-43
Windows NT File Watcher Service
The File Watcher utility (ctmfw) is available to CONTROL-M/Server

when CONTROL-M/Agent is installed on the same platform . Utility
ctmfw is installed as a Windows NT service during the installation of
CONTROL-M/Agent. As a service, ctmfw takes its parameters (rules)
from the file specified in a configuration (.cfg) file during startup. The
full path name of the configuration file must be specified under the
following Windows NT registry key, which is generated automatically by
the installation script:
HKEY_LOCAL_MACHINE\SOFTWARE\New Dimension Software
Ltd.\<CTM_FileWatcher_dir>\SYSPRM\<config_file>
The default value for this key is:

<CTM_Agent_inst_directory>\DATA\ctmfw.cfg
The configuration file must contain the following two lines:

-input
<rule_file_name>
where <rule_file_name> is the full path name of the file containing the
File Watcher rules.
Any File Watcher command line option can be specified in the rules file.
The start and end of all parameters must be demarcated by the new line
character.
Example
The configuration file consists of the following lines:

-input
c:ctmag\data\ctmfw_rule.dat
The file c:ctmag\data\ctmfw_rule.dat contains File Watcher rules.

Any File Watcher command line option can be specified in the rules file.
All parameters must be delimited by the new line character.
2-44
The File Watcher service does not open an additional window during
execution. If you wish to have visual feedback while running the service,
change the setting (Default Y) of the following registry key to N.
HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software, Inc.\
CONTROL-M/FileWatcher\SYSPRM\Silent Mode
The File Watcher service running under the Local System account cannot
detect network resources (that is, files located on remote systems). If you
wish to have the File Watcher detect network resources, configure the
File Watcher Service to run under a regular user account.
File Watcher Service Trace
When running as a service, ctmfw generates an execution log file. This

file is saved in the CONTROL-M/Agent proclog directory under the
following name:
FW_<process_id_of_the_ctmfw_service>.log
Figure 2-5
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
07/22/97
Sample Trace File
13:04:24
13:04:24
13:04:24
13:04:24
13:04:24
13:04:24
13:04:24
13:04:24
13:04:24
13:04:36
13:04:36
13:05:09
13:05:27
13:05:27
13:05:27
13:05:27
13:05:30
13:05:30
13:15:01
13:15:01
182
182
182
182
182
182
182
182
182
182
182
182
182
182
182
182
182
182
182
182
FW:set INTERVAL=3
FW:set MIN_SIZE=4
FW:set FROM_TIME=0909
FW:ctmfw: command line ON_FILEWATCH test CREATE(arg#=3). id=1.
FW:ctmfw: command line ON_FILEWATCH prd1 CREATE 0 0 1 NOW 10(arg#=8). id=2.
FW:ctmfw: command line ON_FILEWATCH abc DELETE 0 0 1 NOW 10(arg#=8). id=3.
FW:File test exists, its current size is 265. id=1.
FW:File test has reached the minimum size of 4. size=265 bytes id=1.
FW:File abc does not exist. id=3.
FW:File transfer was completed. The size of file test is 265. id=1.
FW:Executing:<ecacontb add
aaa 0101>
FW:Executing:< dir >
FW:File prd1 was not CREATED within the time limit. id=2.
FW:File prd1 will be scanned at 1315. id=2.
FW:File abc was not DELETED within the time limit. id=3.
FW:File abc will be scanned at 1315. id=3.
FW:File prd1, is out of time window. next time:1315, id=2.
FW:File abc, is out of time window. next time:1315, id=3.
FW:File prd1, entered the time window from 1315 for monitoring, id=2.
FW:File abc, entered the time window from 1315 for monitoring, id=3.
Utilities
2-45
ctmjsa
ctmjsa compiles runtime data from the Statistical Details table and
records it in the Statistics Summary table of the CONTROL-M database.
Each time it is run, this utility:
Scans the statistical data for jobs that terminated with a status of OK.
The jobs scanned can be limited to a range of dates as described
below.
Computes the average run time and standard deviation for each job
for which data was found.
Records the statistical data in a summary table in the CONTROL-M

database (from which the data is made available to
ENTERPRISE/CS).
Note
Statistical data is only accumulated when the CONTROL-M system

parameter Statistics is set to Y. Operational parameter Statistics Mode
determines the mode to be used to compile summary statistics:
JOBNAME or MEMNAME. The default is MEMNAME.
For more information regarding runtime statistical data, see Runtime
Statistics on page 1-28.
ctmjsa also includes an option to display the summary data filtered
according to specified parameters.
Specify one of the following commands to invoke utility ctmjsa:

ctmjsa
ctmjsa
ctmjsa
ctmjsa
<From Date> <To Date>

-<Delta1> -<Delta2> <Date>
""
-list [<Filter>]
2-46
Table 2-13
ctmjsa Parameters
Variable
Description
<From Date>
Starting date of statistical data to be compiled. The date is

specified in yyyymmdd or yymmdd format.
<To Date>
Ending date of statistical data to be compiled. The date is

specified in yyyymmdd or yymmdd format.
<Delta1>
Number used to establish the date to be used as the

starting date of statistical data to be compiled. The starting
date is established as <Date> <Delta1> (for example, if
<Delta1> is 10 and <Date> is 991220, the starting date is
991210).
<Delta2>
Number used to establish the date to be used as the

ending date of statistical data to be compiled. The ending
date is established as <Date> + <Delta2> (for example, if
<Delta2> is 5 and <Date> is 991220, the ending date is
991225).
<Date>
Date used together with <Delta1> and <Delta2> to

determine the range of dates used for compiling statistical
data. The date is expressed in yyyymmdd or yymmdd
format.
Asterisk enclosed in quotation marks. Specifies that the

utility should accumulate all statistical data currently
available, without regard to date.
-list
Display data from the Statistical Summary table filtered

according to specified subparameters. Use this option after
you have updated the summary table. This information is
also available from ENTERPRISE/CS in the Statistics
window.
<Filter>
Specify one of the following options and its associated

subparameter or leave blank to display the statistics for all
jobs.
-JOBNAME <jobname>
Identify the job by its Job

Name parameter.
-MEMNAME <memname>
Identify the job by its Mem

Name parameter.
-MEMLIB <memlib>
Identify jobs by their Mem

Lib parameter.
-NODEID <nodeid>
Identify jobs by their node

group parameter (Agent
platform).
Utilities
2-47
Note
When the Statistics Mode parameter is JOBNAME, the Mem Name and Mem Lib
fields in the Statistical Summary table are blank. When the Statistics Mode
parameter is MEMNAME, the Job Name field is blank.
Each subparameter in the <Filter> option can include mask characters:

Table 2-14
Filter Mask Characters
Mask
Description
Represents any number of characters (including no characters).

Any parameter including should be enclosed in quotation marks
(see examples below).
Represents any single character.
Example 1
Either of the following commands compile statistical data for the period
June 21, 2000 through June 25, 2000 (assuming that this data is
available). In the second command, the hyphens indicate the beginning
of unsigned parameter values; they are not minus signs.
ctmjsa 000621 000625
ctmjsa -3 -1 000624
Example 2
The following command causes the utility to compile statistical data

using all data currently available:
ctmjsa ""
2-48
Example 3
The following command display summary data for all jobs whose Mem
Name parameter begins with pgmac.
ctmjsa -list -MEMNAME "pgmac"
A report similar to the following is displayed:

Figure 2-6
JOBNAME
Sample Report from Utility ctmjsa

MEMNAME
MEMLIB
NODEID
CPU ELAPSED
[sec] [sec]
---------- ---------- --------------- ------------ ----- -----pgmacct1
prod.acct.pgm
diana
0.19 233.15
pgmacct2
prod.acct.pgm
verdi
0.12
6.12
pgmacct3
prod.acct.pgm
diana
0.05 170.45
pgmacct4
prod.acct.pgm
diana
0.34 145.23
Utilities
2-49
ctmldnrs
ctmldnrs creates and loads the Manual Conditions file. This file contains
prerequisite conditions that are required by jobs in the Active Jobs file
but which will not be available (that is, added to the Conditions/
Resources table) unless there is some form of manual intervention. These
conditions fall into two categories:
Conditions that are never added automatically by scheduled jobs

because manual confirmation is always desired.
Conditions that are normally added automatically by scheduled jobs

but the jobs that add them are not scheduled for the day.
Prerequisite conditions contained in the Manual Conditions file can be

made available to the system through the load option of ctmldnrs (see
below), through utility ecacontb on page 2-100, through the Prerequisite
Conditions Map window (see the Enterprise Controlstation User Guide),
or through the WHY option in the ENTERPRISE/CS job menu (see the
Enterprise Controlstation User Guide).
ctmldnrs identifies conditions that should be placed in the Manual
Conditions file by first performing a search for all prerequisite conditions
required for submission of jobs on the particular day. The search for
prerequisite conditions is performed by checking the In Conditions
parameters of the Job Scheduling definitions for all jobs in the Active
Jobs file.
Once these prerequisite conditions have been identified, the utility
eliminates any non-manual conditions from the list that satisfy either
of the following criteria:
The prerequisite condition already exists in the Conditions/Resources

table.
The prerequisite condition is added to the Conditions/Resources

table by an Out Conditions or DO COND job processing parameter
in a job scheduled to run that day.
2-50
All prerequisite conditions in Conditions parameters that do not meet the

above criteria are assumed to be manual conditions and are placed in the
Manual Conditions file. These conditions can be limited further with the
use of IGNOREx parameters passed to the utility (see below).
The ADDMODE parameter determines if the Manual Conditions file
will be re-created with all previous conditions deleted from the file or
whether previous conditions will be retained in the new file.
Three options are available for using this utility:
Create the Manual Conditions file.

List prerequisite conditions from the Manual Conditions file.
Load prerequisite conditions from the Manual Conditions file to the
Conditions/Resources table.
Specify the following command to create the Manual Conditions file:

ctmldnrs -CALCCOND [ -ADDMODE{YES|NO}]/
[ -OUTPUT <Filename> ]/
[ -IGNOREIN <Condition Name> ]/
[ -IGNOREOUT <Condition Name> ]/
[ -IGNORECODES <Condition Name> ]
Utilities
2-51
Table 2-15
ctmldnrs Parameters
Variable
Description
ADDMODE
YES When the new Manual Conditions file is

created, conditions from the previous file are
retained in the new file.
NO The Manual Conditions file is re-created
and all previous conditions are deleted. Default.
OUTPUT
Output file to be created. If this parameter is not

specified, the default file is
<Product_directory>\ctmldnrs.dat
<Filename>
Full path name of the output file to be created.
IGNOREIN
All conditions that satisfy the specified condition

name are ignored when the file is created.
IGNOREOUT
Any references to conditions that satisfy the

specified condition name that appear in Out
Conditions job processing parameters are
ignored.
IGNORECODES
Any references to conditions that satisfy the

specified condition name that appear in DO
COND job processing parameters are ignored.
<Condition Name>
Name of the prerequisite condition. The condition

name can include the mask character to denote
any number of characters (including no characters).
In this instance, the condition name must be
enclosed in quotation marks (for example, LVL ).
Specify by itself to include all existing
conditions.
Note
Multiple IGNOREx parameters can be included in the command in any

order.
2-52
To list prerequisite conditions from the Manual Conditions file, specify:

ctmldnrs -LIST <Condition Name> [ -INPUT <Filename> ]
Table 2-16
ctmldnrs Parameters (Prerequisite Conditions)
Variable
Description
<Condition Name>
All conditions in the input file that satisfy the specified

characters are listed. Specify by itself to list/load all
conditions.
<Filename>
Path name of the input Manual Conditions file. If this

parameter is not specified, the default input file is
<Product_directory>\ctmldnrs.dat
To load prerequisite conditions from the Manual Conditions file to the

Conditions/Resources table, specify:
ctmldnrs -LOAD <Condition Name> [ -INPUT <Filename> ]
Example 1
The following command re-creates the default Manual Conditions file on

the users directory:
ctmldnrs -CALCCOND -ADDMODE NO
Example 2
The following command creates a Manual Conditions file

c:\h\mcond\data\output.dat that ignores all conditions with prefix a.
ctmldnrs -CALCCOND -ADDMODE NO -OUTPUT c:\h\mcond\data\output.dat
-IGNOREIN a
-IGNOREOUT cond
Example 3
The following command loads all conditions from the default input
Manual Conditions file to the Conditions/Resources table:
ctmldnrs -LOAD
Utilities
2-53
ctmloadset
ctmloadset is used to record current resource usage on an Agent
platform in the Quantitative Resources table. This utility is typically
invoked by a cyclic job that runs on the Agent platform and measures the
usage of a certain resource on the platform. This usage data is then used
to update the Quantitative Resources table on the server platform.
ctmloadset is used when load balancing is implemented. The
load-balancing algorithm uses the data recorded in the Quantitative
Resources table to determine to which Agent platform a job should be
submitted.
CONTROL-M maintains the following information regarding usage of
each Quantitative resource:
Total Used
Units of the resource currently in use. This parameter represents the sum
of:
Used by CONTROL-M
Units of the resource currently in use by jobs submitted by
CONTROL-M/Server.
Used by Others
Units of the resource currently in use by non-CONTROL-M jobs.
Update the resource usage values in the Quantitative Resources table:
Specify the value for Total Used for a resource. ctmloadset subtracts
the value for Used by CONTROL-M from the value you specify
and places the remainder in the field Used by Others.
Specify the value for Used by Others for a resource. This value is
added to the value Used by CONTROL-M to calculate the value
Total Used for the resource.
Values for the utility can be expressed as an absolute number of units or

as a percentage of the total number of units defined (Max value).
2-54
Usage of resources that are recorded using this utility appear in the
Quantitative Resources Map window in ENTERPRISE/CS as type Q
rows. However, the field Mem Name remains blank since this represents
usage by one or more non-CONTROL-M jobs.
Specify the following command to invoke utility ctmloadset:

ctmloadset {TOTAL|OTHERS} <QR name> <Load value>[%]
Table 2-17
ctmloadset Parameters
Variable
Description
TOTAL
Indicates that the load value provided specifies the total

usage of the resource by all jobs (both CONTROL-M jobs
and non-CONTROL-M jobs).
When this option is specified, the utility calculates the
usage of the resource by non-CONTROL-M jobs and
updates the table accordingly.
OTHERS
Indicates that the load value provided specifies the units of

the resource used by one or more non-CONTROL-M jobs.
<QR name>
Name of the Quantitative resource to update.
<Load value>
Number of units of the resource currently used.

-orWhen % is specified, amount of the resource currently
used, expressed as a percentage of the maximum available
units defined for this Quantitative resource.
Example 1
A node group contains three Agent platforms: diana, jacklin and ruby.
Each platform is defined in the Quantitative Resource table as having
200 units of resource CPU_load, representing the load on the platforms
CPU.
Platform jacklin is used exclusively to run jobs submitted by

CONTROL-M. The platform is currently executing a job that uses
120 units of resource CPU_load.
Platform ruby is used exclusively to run jobs submitted by

CONTROL-M. The platform is currently executing a job that uses
150 units of resource CPU_load.
Utilities
2-55
Platform diana is used both for CONTROL-M and

non-CONTROL-M jobs. The platform is currently executing a job
submitted by CONTROL-M that uses 75 units of resource
CPU_load.
A cyclic job is defined to run periodically on diana to measure the total

load on the CPU. The job updates the Quantitative Resources table using
utility ctmloadset in order to indicate to CONTROL-M exactly what the
load is on that platform. The last run of this job determined that the load
on the CPU is 80% of total capacity. The job invokes ctmloadset as
follows:
ctmloadset TOTAL CPU@diana 80%
The Total Used for diana is set to 80% of 200, or 160. Since the usage by
CONTROL-M jobs is currently 75 units, ctmloadset calculates that the
Other (non-CONTROL-M usage) is 160 75, or 85.
As a result, the Quantitative Resources table now contains the following
values:
Table 2-18
Example of Quantitative Resources Table
Resource
max
Total Used by
CONTROL-M
Total Used by
Others
CPU@jacklin
200
120
80
CPU@ruby
200
150
50
CPU@diana
200
75
85
Free
40
The CONTROL-M load-balancing algorithm uses these values when

determining where to submit the next job.
2-56
Example 2
The following examples demonstrate the effect of ctmloadset on the

Quantitative Resources table, as represented by the display generated by
utility ecaqrtab. All examples below are based on the following premise:
For agent platform diana, 30 units of resource CPU@diana are
currently used by CONTROL-M jobs.
The output from utility ecaqrtab is displayed as follows:
Figure 2-7
Sample Output from Utility ecaqrtab Example 2
+------------------------------------------------------+
Resource Name
Type Max-Avail Reserved Used Free
+------------------------------------------------------+
CPU@diana
L
50
0
30
20
Example 2a
The following command specifies that the current usage of the

Quantitative resource CPU@diana by non-CONTROL-M jobs is 12
units:
ctmloadset OTHERS CPU@diana 12
As a result, the output from utility ecaqrtab is now displayed as follows:

Figure 2-8
Sample Output from Utility ecaqrtab Example 2a
+------------------------------------------------------+
Resource Name
+------------------------------------------------------+
CPU@diana
L
50
0
42
8
Utilities
2-57
Example 2b
The following command specifies that the current usage of the

Quantitative resource CPU@diana by non-CONTROL-M jobs is 12%:
ctmloadset OTHERS CPU@diana 12%
The non-CONTROL-M usage of the resource is calculated as 12% of 50,

or 6 units. As a result, the output from utility ecaqrtab is now as follows:
Figure 2-9
Sample Output from Utility ecaqrtab Example 2b
+------------------------------------------------------+
Resource Name
+------------------------------------------------------+
CPU@diana
L
50
0
36
14
Example 2c
The following command specifies that the current total usage of the
Quantitative resource CPU@diana by all jobs is 48 units:
ctmloadset TOTAL CPU@diana 48
As a result, the output from utility ecaqrtab is now displayed as follows:

Figure 2-10 Sample Output from Utility ecaqrtab Example 2c
+------------------------------------------------------+
Resource Name
+------------------------------------------------------+
CPU@diana
L
50
0
48
2
2-58
ctmlog
ctmlog is used to create a report from entries in the CONTROL-M log or
to delete entries in the CONTROL-M log.
Specify one of the following commands to invoke utility ctmlog:

ctmlog
<Action> <Action Option> <From date> <From Time> <To Date> <To Time>
[<Output> [<Report Width>] ]
-orctmlog
<Action> <Action Option> "" [<Output> [<Report Width>] ]
where:
Valid values for <Action> and <Action Option> are listed in Table 2-19,
ctmlog Parameters, on page 2-60.
Note
All actions are limited to log entries in the range specified using the time/
date parameters.
Utilities
2-59
Table 2-19
ctmlog Parameters
<Action>
listss
<subsystem>
Prints a report for a
specific subsystem.
<subsystem>
Subsystem to include
in the report. Specify
one of the following:
SU
Supervisor
TR
Tracker
SL
Selector
CD
Download, Database
update
NS
Communication with
Agent platforms
LG
Agent utilities
UT
Utilities
list
Prints a report of all

entries.
None.
listord
Prints a report of entries

for a specific Order ID.
<Order ID>a
Order ID to include in
the report.
listjob

for a specific job number.
<Job no.>
Job number to include

in the report.
list
jobname

for a specific jobname.
<Job name>
Job name to include

in the report.
listmsg
Prints a report of
messages with a specific
message ID.
<msgid>
Message ID to
include in the report.
delete
Deletes log entries.
None.
a.The Order ID as displayed in the Job Details window of ENTERPRISE/CS is a

base 36 number. If you want to specify this Order ID as a base 10 number,
insert an asterisk before the number and enclose the result in quotation marks
(for example, 1234).
2-60
Table 2-20
ctmlog Other Parameters
<From Date>
<From Time>
<To Date>
<To Time>
Starting and ending dates and times for the range of

entries to be scanned by the specified action. Date is
specified in yyyymmdd or yymmdd format. Time is
specified in hhmm format.
<Output>

(optional). If this parameter is not specified, the output is
routed to the default output device. This parameter is not
applicable for the delete action.
<Report Width>
Width (in columns) of the report to generate. Specify a

number in the range of 80 132 (default is 80). This
parameter can only be specified if the Output parameter
is specified.
Asterisk enclosed in quotation marks. Scan all entries in

the CONTROL-M log (without regard to date or time).
Example 1
The following command produces a report of all entries in the

CONTROL-M log between 10:00 A.M. March 12th, 1999 and 8:00 AM
March 14th, 1999. The report is output to file rprt.txt in 80-column
format:
ctmlog list 990312 1000 990314 0800 c:\ctm\user1\rprt.txt
Example 2
The following command produces a report of all entries in the

CONTROL-M log relating to downloads to the ENTERPRISE/CS
database and to CONTROL-M database updates, without regard to date
or time. The report is output to file gdrprt.txt in 132-column format:
ctmlog listss CD "*" c:\ctm\user1\gdrprt.txt 132
Utilities
2-61
ctmmakedb
The ctmmakedb utility builds a new CONTROL-M database for the
current CONTROL-M installation. This utility is run automatically
during CONTROL-M installation. However, it can also be run at a later
time.
Note
The ctmmakedb utility can be run only when the CONTROL-M/Server is

down.
This utility replaces your existing CONTROL-M database. If you may
need the information in your current database at later time, be sure to
back up your existing CONTROL-M database before you run the
ctmmakedb utility.
Use the following command to invoke the ctmmakedb utility:

ctmmakedb -existing [-silent]
The variables of this command are described in Table 2-21.

Table 2-21
ctmmakedb Parameters
Variable
Description
-existing
Indicates that the new database should be created using an

existing database server.
-silent
If specified, this keyword indicates that the new database

should be created using a silent installation procedure.
Actual operation of this utility depends on whether or not the -silent

keyword is specified in the ctmmakedb command line:
If -silent is not specified, a series of dialog boxes guide you through

creation of the new CONTROL-M database. See Building the
CONTROL-M Database on page 7-6 for a detailed description of
these dialog boxes.
2-62
If -silent is specified, the ctmmakedb utility uses the silent.dat file in

the current directory as input for creation of the new CONTROL-M
database. The template for this file should be copied from the
FDxxxx\Silent_Template\ directory on your product CD (where
xxxx is the FD number for CONTROL-M server).
For information about the parameters in the silent.dat file, see Table
5-8, Database Parameters, on page 5-14.
Note
The silent.dat file with the parameters for the current run of the
ctmmakedb utility must be placed in the directory from which the utility
will be run.
Utilities
2-63
ctmordck
ctmordck lists job processing definitions associated with a specific User
Daily name and indicates the security status of each job for the owner of
the User Daily job (that is, whether or not the CONTROL-M security
mechanism will allow jobs associated with a User Daily name to run
with the authorizations currently assigned to the owner of the User Daily
job).
This utility displays the following fields:
Name of the job.

Number of the job in the CONTROL-M database.
Author of the job processing definition.
Owner of the job processing definition.
For each job processing definition listed, the indicators in Table 2-22 are
displayed.
Table 2-22
ctmordck Output
Column
Description
TB
Whether or not the owner of the User Daily job is authorized

to order the Scheduling table of the job listed.
FL

to execute the script file of the job listed.
UA

to order jobs for the owner of the job listed.
Note
This utility can be used non-interactively for non-terminal destinations

(see the description of the <Output> parameter below).
Specify the following command to invoke utility ctmordck:

ctmordck <User Name> <User Daily> [<Output>]
The variables of this command are described in Table 2-23.
2-64
Table 2-23
ctmordck Parameters
Variable
Description
<User Name>
Owner of the User Daily job.
<User Daily>
User Daily name.
<Output>
Full path name to which the report should be sent. If this

parameter is not specified, the output is routed to the default
output device.
Example
The following command generates a list for user SYSTEM and the User
Daily SYSTEM. The list is directed to the file udlist:
ctmordck SYSTEM SYSTEM c:\ctm\user1\udlist
The following is sample output from the above command:

Figure 2-11 Sample Output from Utility ctmordck
Date: 10-JUL-2000.
Page: 1
User SYSTEM , Daily SYSTEM Ordering list
+-------------------------------------------------JOBNAME
No. AUTHOR OWNER TB FL UA
+-------------------------------------------------CTMLOG HAN 2066 root
root
Y
N
Y
PURGE JOB
2067 root
root
Y
N
Y
user3-DAIL 2033 BARAK
user3 Y
N
Y
user2-DAIL 2032 VOLODIA user2 Y
N
Y
user1-DAIL 2031 VOLODIA user1 Y
N
Y
JEAN-UD
2000 jean
jean
Y
N
Y
JOB-STATUS 2068 root
root
Y
N
Y
GD-TEST1
20 jean
user1 Y
N
Y
GD-TEST2
21 jean
user2 Y
N
Y
GD-TEST3
22 jean
user3 Y
N
Y
GD-user4
2008 jean
user4 Y
N Y
GD-user5
2009 jean
user5 Y
N Y
Utilities
2-65
ctmorder
ctmorder orders or forces one or more jobs from a Scheduling table
contained in the CONTROL-M database.
Ordered jobs are placed in the Active Jobs file if their scheduling
criteria are met.
Forced jobs are placed in the Active Jobs file regardless of their
scheduling criteria.
Specify the following command to invoke utility ctmorder:

ctmorder <Scheduling Table> <Job Name> <Odate> [{ORDER|FORCE}]
Table 2-24
ctmorder Parameters
Parameter
Description
<Scheduling Table>
Name of the Scheduling table containing the jobs.
<Job Name>
Contents of the job processing parameter Job

Name of the job or jobs to order/force. The Job
Name can include mask characters as follows:
* Denotes any number of characters (including
no characters). Specify by itself to include all
existing jobs in the table. Any parameter
including should be enclosed in quotation
marks (see examples below).
? Denotes any single character.
<Odate>
Date to use as the jobs scheduling date. Specify a

date in yyyymmdd format, or specify ODAT to
accept the CONTROL-M date.
ORDER
The jobs are placed in the Active Jobs file only if

their scheduling criteria are satisfied. Default.
FORCE
The jobs are placed in the Active Jobs file

regardless of scheduling criteria.
Note
If neither ORDER nor FORCE is included in the command that activates

this utility, the specified jobs are ordered.
2-66
Example 1
The following command orders all jobs contained in Scheduling table

ACCT100. Any jobs placed in the Active Jobs file will have the current
CONTROL-M date as their original scheduling date:
ctmorder ACCT100 "" ODAT
Example 2
The following command orders all jobs contained in the Scheduling table
ACCT100 whose Job Name parameter begins with ga. Any jobs placed
in the Active Jobs file will have the date March 15, 2000 as their original
scheduling date:
ctmorder ACCT100 "ga*" 20000315 ORDER
Example 3
The following command forces all jobs contained in the Scheduling table
ACCT100 whose Job Name parameter consists of prodyjob. Any jobs
placed in the Active Jobs file will have the date December 31, 2000 as
their original scheduling date:
ctmorder ACCT100 prodyjob 20001231 FORCE
Utilities
2-67
ctmpsm
ctmpsm is an interactive utility that activates the CONTROL-M
Production Support menu. This menu is used to perform functions
affecting jobs or conditions in the Active environment of the data center.
It provides an alternative to using the ENTERPRISE/CS GUI and allows
the user to perform many of the GUI functions directly in the data center.
To invoke utility ctmpsm:
1. Log onto the Server platform as the CONTROL-M/Server owner (for

example, user controlm).
2. Specify the command: ctmpsm
The following menu is displayed:
+------------------------------+
|
Production Support Menu
|
+------------------------------+
Active Jobs File
----------------
Resource Map
------------
1) List All
2) List All (Show Started/Ended)
3) List All (Show Application)
4) List All (Show Mem Name)
5) List Jobs That Ended OK
6) List Jobs That Ended NOTOK
7) List Submitted/Executing Jobs
8) List Cyclic Jobs
9) List Jobs Waiting for Time Window
10) List Jobs Waiting for
Confirmation
40) List Application/Group Tree
41) List Scheduling Tables
61) Control Resources

62) Quantitative Resource
63) Prerequisite Conditions
64) Control Resources Usage
65) Quantitative Resources
Usage
Q) Quit
Scheduling Functions
-------------------71) Scheduling Tables
72) Order Tables/Jobs
Enter Option:
2-68
The functions available from this menu are divided into three categories:
Table 2-25
ctmpsm Menu Functions
Function
Description
Active Jobs File
Provides various views of the Active Jobs file. Each view

displays information about the jobs and provides options
to perform such actions on the jobs as Hold, Free,
Delete, Rerun, Why, Confirm, View or modify job details,
and view the CONTROL-M log.
Resource Map
Allows you to view and modify entities in the Conditions/

Resources table: Quantitative resources, Control
resources and prerequisite conditions. The first three of
these functions activate utilities ecactltb, ecaqrtab and
ecacontb respectively.
Scheduling
Functions
Allows you to order or force Scheduling tables or specific

jobs in Scheduling tables. Additionally you can generate
monthly or yearly scheduling plans using utility ctmrpln.
Active Jobs File Options
Perform various tasks using information in the Active Jobs File. These
options are described in Table 2-26.
Utilities
2-69
Table 2-26
ctmpsm Options for the Active Jobs File
Code
Option
Description
List All
Lists all jobs in the Active Jobs file.
List All
(Show Started/Ended)
Lists all jobs in the Active Jobs file. Indicates which jobs have
started or ended execution.
List All
(Show Application)
Lists all jobs in the Active Jobs file. Indicates the application to
which each job belongs.
List All
(Show Mem Name)
Lists all jobs in the Active Jobs file. Indicates the Mem Name for
each job.
List Jobs That

Ended OK
Lists jobs in the Active Jobs file that have a completion status of
Ended OK.
List Jobs That

Ended NOTOK
Lists jobs in the Active Jobs file that have a completion status of
Ended NOTOK.
List Submitted/
Executing Jobs
Lists jobs in the Active Jobs file that are currently executing.
List Cyclic Jobs
Lists jobs in the Active Jobs file that are cyclic.
List Jobs Waiting for

Time Window
Lists jobs in the Active Jobs file that are waiting to begin
executing based on the time specified in their Time From
parameter.
10
List Jobs Waiting for

Confirmation
List jobs in the Active Jobs file that are waiting for confirmation.
40
List Application/Group
Tree
Displays a summarized list of the applications and groups for all

jobs currently contained in the Active Jobs file.
41
List Scheduling Tables
Displays a list of all Scheduling tables currently contained in the

Active Jobs file.
All Active Jobs File options display the following menu at the bottom of
the screen:
Figure 2-12 Options Menu Active Jobs File Screen
H) Hold, F) Free, D) Delete, U) Undelete, R) Rerun, W) Why, Z) Details

LO) LogOrd, LJ) LogJob, C) Confirm, Sx)Sort[x: 1.ORDERNO 2.JOBNAME]
J) Sysout
A) Statistics V) View Script/JCL K) Force OK
Gx) Global action x [x: H(Hold), F(Free), D(Delete), U(Undelete), R(Rerun)]
Q)Quit
Enter Option:
2-70
Each of the Active Jobs File actions can be performed on the jobs
displayed on the screen. The actions are described in Table 2-27.
Table 2-27
ctmpsm Active Jobs File Actions
Option
Action
Description
Hold
Hold a job.
Free
Free a previously held job.
Delete
Mark a job for deletion.
Rerun
Rerun a job.
Undelete
Undelete a job marked for deletion.
Why
Display why a job has not yet been submitted.
Details
View/modify a jobs parameters.
LO
LogOrd
List CONTROL-M log entries for a specific Order ID.
LJ
LogJob
List CONTROL-M log entries for a specific Job

Name.
Confirm
Confirm submission of a job.
S1
Sort (by Order No.)
Sort jobs displayed by Order number.
S2
Sort (by Job Name)
Sort jobs displayed by Job Name.
Sysout
Display the jobs sysout.
Statistics
Display the job statistics (last 20 runs).
View script/JCL
View a jobs script or JCL.
Force OK
Force a jobs status to be OK.
GH
Global Action (Hold)
Hold all jobs in the displayed list.
GF
Global Action (Free)
Free all jobs in the displayed list.
GD
Global Action (Delete)
Mark all jobs in the displayed list for deletion.
GR
Global Action (Rerun)
Rerun all jobs in the displayed list.
GU
Global Action (Undelete)
Undelete all jobs marked for deletion.
Utilities
2-71
Resource Map Options
The Resources Map options are shown in Table 2-28.

Table 2-28
Resource Map Options
Code
Option
Description
61
Control Resources
Lists Control resources currently used

in the Active environment. This option
activates utility ecactltb.
62
Allows you to list, add, modify or

delete Quantitative resources in the
Active environment. This option
activates utility ecaqrtab.
63
Prerequisite Conditions
Allows you to view, add or delete

prerequisite conditions in the Active
environment. This option activates
utility ecacontb.
64
Control Resources Usage
Shows current usage of Control

resources by jobs in the Active Jobs
file.
65
Usage
Shows current usage of Quantitative

resources by jobs in the Active Jobs
file.
Scheduling Functions Options
The Scheduling Functions options are shown in Table 2-29.

Table 2-29
Scheduling Functions Options
Code
Option
Description
71
Scheduling Tables
Lists Scheduling tables and jobs defined in

the CONTROL-M database. Allows you to
force Scheduling tables or jobs, add or
delete Scheduling tables and generate
scheduling reports.
72
Order Tables/Jobs
Allows you to order Scheduling tables or

jobs. You are prompted to specify the
Scheduling table, Job Name (optional) and
Odate for the table or job to order.
2-72
When the Scheduling Tables option is selected, output similar to the

following is displayed:
Figure 2-13 Sample Output from the Scheduling Tables Option
Scheduling Tables
----------------1)
2)
3)
4)
5)
6)
7)
8)
9)
10)
RE_SCHED
RE_SYSOUT
RE_ONSTMT
RE_SHOUT
RE_TEST1
RE_TEST2
RE_TEST3
RE_TEST4
RE_UDAILY
RE_UTILITIES
(Daily:
)
(Daily:
)
(Daily:REGRESSION)
(Daily:REGRESSION)
(Daily:REGRESSION)
(Daily:REGRESSION)
(Daily:REGRESSION)
(Daily:REGRESSION)
(Daily:SYSTEM
)
(Daily:UTILITIES )
D#) Delete UserDaily Table #

F#) Force table
#
A) Add
R) Remove Table
Option []:
U#) Update table #

J#) List jobs
#
Q) Quit.
The following options, displayed in Table 2-30, are available from the
above screen.
Table 2-30
Scheduling Tables Screen Options
Option
Action
Description
Add Table
Adds a Scheduling table to the

CONTROL-M database. When selected,
you are prompted for the Table name and
User Daily name.
D#
Delete table #
Deletes a specific Scheduling table and all

of its associated jobs (for example, specify
D2 to delete table RE_SYSOUT).
F#
Force table #
Forces a specific Scheduling table (for

example, specify F2 to force table
RE_SYSOUT).
Remove Table
Deletes a specific Scheduling table and all

its associated jobs (for example, specify R
RE_SYSOUT deletes the RE_SYSOUT
table).
Utilities
2-73
Table 2-30
Scheduling Tables Screen Options
Option
Action
Description
J#
List jobs #
Lists jobs in a Scheduling table and

provides options to force a specific job or
generate a report (for example, specify J1
to list the jobs in table RE_SCHED).
U#
Update table #
Updates the User Daily name for a

specific Scheduling table (for example,
specify U2 to update the User Daily name
for table RE_SYSOUT).
When the List Jobs # option is selected, output similar to the following
is displayed:
Figure 2-14 Sample Output from the List Jobs # Option
Scheduling Table RE_SHED Jobs

----------------------------1)
2)
3)
4)
5)
6)
7)
8)
9)
10)
11)
12)
Jobname:DAYS_CAL_N,
Jobname:DAYS_30_FE,
Jobname:DAYS_28_29,
Jobname:NO_CALENDA,
Jobname:DATES_0101,
Jobname:DATES_2902,
Jobname:DAYS_CAL_M,
Jobname:DAYS_CAL_P,
Jobname:DAYS_CAL_W,
Jobname:CALENDAR_O,
Jobname:wdays_all ,
Jobname:wdays_1_2_,
Memname:DAYS_CAL_NONE
Memname:DAYS_30_FEB
Memname:DAYS_28_29_FEB
Memname:NO_CALENDAR
Memname:DATES_0101_0202
Memname:DATES_2902
Memname:DAYS_CAL_MINUS
Memname:DAYS_CAL_PLUS
Memname:DAYS_CAL_WITHOUT
Memname:CALENDAR_ONLY
Memname:WDAYS_ALL
Memname:WEEKDAYS_1_2_3
Q) Quit.
F#) Force job #
M) Month Schedule Plan.
Y#) Year Schedule Plan for
job #
Option []:
2-74
The options available from the screen in Figure 2-14 on page 2-74 are
listed in Table 2-31.
Table 2-31
Scheduling Table Rescheduling Jobs Menu Options
Option
Action
Description
F#
Force job #
Forces a specific job (for example, specify

F2 to force job DAYS_30_FEB).
Month Schedule Plan
Generates a monthly Job Order report for

the table. You are prompted to enter the
year and month in format YYYYMM.
Y#
Year Schedule Plan

for job #
Generates a yearly Job Order report for a

specific job. You are prompted to enter the
year in format YYYY.
Utilities
2-75
ctmrpln
ctmrpln creates a report that lists all or a selection of jobs in a specified
Scheduling table, and indicates when the jobs are scheduled to run. In
addition, it enables you to test the effect of different calendars on the
scheduling of jobs in the table.
Note
Utility ctmrpln only supports reports whose specified start and end years
are between 1972 2035.
Each report can be created in one of three formats, as described in
Table 2-32.
Table 2-32
ctmrpln Report Formats
Daily Report
Displays jobs in the specified Scheduling table that are

scheduled to run on a specific day. Each jobs Mem
Name (or Job Name), Group and Description
parameters are also displayed.
Monthly Report
Displays a table of all days in a specified month and

marks (with an asterisk ) the days of the month on
which jobs in the specified Scheduling table are
scheduled to run. Jobs can be identified either by their
Mem Name or Job Name parameters.
Yearly Report
Displays five individual year-calendar tables and marks

each day with various characters (described below)
which indicate whether or not jobs in the specified
Scheduling table are scheduled to run. The years
displayed encompass the period ranging from two years
prior to the specified year until two years following the
specified year.
Note
To print the daily, monthly, or yearly report, the <Output> parameter

(described below) must specify a printer that can print 132-column
reports.
2-76
The following characters can appear in this report. The characters

indicate that a job is scheduled to run (that is, the job is placed in the
Active Jobs file).
Table 2-33
ctmrpln Report Characters
Char
Description
Characters indicating
that a job is scheduled
to run (that is, the job is
placed in the Active
Jobs file)
WJob is scheduled; the day is a calendar day.a

YJob is scheduled; the day is not a calendar
day.
XJob is scheduled; the day is the start-of-week
dayb and a calendar day.
SJob is scheduled; the day is the start-of-week
day and is not a calendar day.
NOTE: Uppercase and lowercase letters represent
different conditions.
Characters indicating
that a job is not
scheduled to run (that
is, the job is not placed
in the Active Jobs file).
wJob is not scheduled; the day is a calendar

day.
.Job is not scheduled; the day is not a calendar
day.
xJob is not scheduled; the day is the
start-of-week day and a calendar day.
sJob is not scheduled; the day is the
start-of-week day but is not a calendar day.
NJob is not scheduled because job processing
parameter Day contains a minus sign (-).
ZJob is not scheduled because job processing
parameter Day contains a minus sign (-); the day
is the start-of-week day.
NOTE: Uppercase and lowercase letters represent
different conditions.
a. The day is marked in the calendar used to schedule the job. For more
information, see the Enterprise Controlstation User Guide.
b.The start-of-week day is determined by the CONTROL-M system parameter
Start Day of the Week, described in Chapter 5, Customization
Parameters,.
Specify the following command to invoke utility ctmrpln:

ctmrpln <Report_type> <Calendar> <Schedtab> <Jobname> <Date> [<Output>]
Utilities
2-77
Table 2-34
ctmrpln Parameters
Parameter
Description
<Report_type>
Specify one of the following values:
<Calendar>
<Schedtab>
DM (or D)
Creates a daily report, identifying each job by its Mem Name

parameter.
DJ
Creates a daily report, identifying each job by its Job Name

parameter.
MM (or M)
Creates a monthly report, identifying each job by its Mem Name

parameter.
MJ
Creates a monthly report, identifying each job by its Job Name

parameter.
Creates a year report.
Specify one of the following values:

Y
Creates the report using the calendar specified in the jobs

scheduling parameters.
Creates the report ignoring the calendar specified in the jobs

scheduling parameters.
<Name>
Creates the report using the calendar you specify (ignoring any
calendar specified in the jobs scheduling parameters). Use this
option to determine how other calendars affect the schedule.
Name of the Scheduling table on which to base the report. The Scheduling table
name can include the following mask characters:
*
Represents any number of characters (including no characters).

Specify * by itself to include all Scheduling tables. Any parameter
including * should be enclosed in quotation marks.
Represents any single character.
<Jobname>
Contents of the job processing parameter Job Name of the job or jobs to include in
the report. The Job Name can include mask characters (see <Schedtab> above).
Specify * by itself to include all jobs in the Scheduling table.
<Date>
For daily reports: A date in yyyymmdd format.

For monthly reports: A month in yyyymm format.
For yearly reports: A year in yyyy or yy format.
NOTE: Utility ctmrpln only supports reports whose specified start and end years
are between 1972 2035.
<Output>
Full path name to which the report should be sent (optional). If this parameter is not
specified, the output is routed to the default output device.
2-78
Example 1
The following command causes the utility to generate a report for

Scheduling table PROD1. The report will include all jobs whose Job
Name parameter begins with jn and that will run on Jan. 1, 2000 based
on the calendar work_days. The output is directed to the users display:
ctmrpln D work_days PROD1 "jn" 20000101
Example 2
The following command causes the utility to generate a table of days on

which job PRDJ02 in Scheduling table PROD1 will run during the month
of April, 2000, based on the calendar work_days. The output is directed
to printer lpt1:
ctmrpln M work_days PROD1 PRDJ02 200004 lpt1
Example 3
The following command causes the utility to generate a five-year report

encompassing the period Jan. 1999 through Dec. 2003, indicating on
which days each job in Scheduling table PROD1 runs, based on the
calendar work_days. The output is directed to printer lpt1:
ctmrpln Y work_days PROD1 "" 2001 lpt1
Utilities
2-79
ctmruninf
ctmruninf displays runtime data from the Statistical Details table of the
CONTROL-M database. An additional option is available to delete the
data from this table. The jobs scanned for both options can be limited to a
range of dates as described in Table 2-35.
Note
Statistical data is only accumulated when CONTROL-M system

parameter Statistics is set to Y.
For more information, seeRuntime Statistics on page 1-28.
Specify one of the following commands to invoke utility ctmruninf:

ctmruninf -list <From Date> <To Date> [<Filter>] [-total]
ctmruninf -list "" [<Filter>] [-total]
ctmruninf -delete <From Date> <To Date>
Table 2-35
ctmruninf Parameters
Variable
Description
-list
Display data from the Statistical Details table within the

dates specified by the From Date and To Date parameters.
The data listed can be limited further with use of the Filter
subparameter (see below).
-delete
Delete data from the Statistical Details Table within the

range specified by the From Date and To Date parameters.
<From Date>
Starting date of statistical data to be displayed/deleted.

The date is specified in yyyymmddhhmmss format.
<To Date>
Ending date of statistical data to be displayed/deleted.

The date is specified in yyyymmddhhmmss format.
Asterisk enclosed in quotation marks. Specifies that the

utility should list all statistical data currently available,
without regard to date.
2-80
Table 2-35
ctmruninf Parameters
Variable
Description
<Filter>
Specify one of the following options and associated

subparameter or leave blank to display the statistics for all
jobs in the range.
-JOBNAME <jobname>Identify the job by its Job Name
parameter.
-MEMNAME <memname>Identify the job by its Mem
Name parameter.
-MEMLIB <memlib>Identify jobs by their Mem Lib
parameter.
-NODEID <nodeid>Identify jobs by their node ID
parameter (Agent platform).
-ORDERID <orderid>Identify the job by its Order ID
parameter.
Each of the subparameters in the <Filter> can include mask
characters as follows:
Denotes any number of characters (including no
characters). Any parameter including should be
enclosed in quotation marks (see example below).
?Denotes any single character.
-total
Display a total line that calculates the total CPU and elapsed
times for the jobs selected.
Example 1
The following command displays runtime data for the period January 21,
2000 through January 25, 2000 (assuming that this data is available):
ctmruninf -list 2000012100000 2000012500000
Utilities
2-81
Example 2
The following command causes the utility to display and total runtime
data for all jobs on Agent platform diana.
ctmruninf -list "" -NODEID "diana" -total

Figure 2-15 Sample Utility ctmruninf Report
TIMESTAMP
------------2000012160524
2000012161205
2000012162311
2000012164512
------------Total records
JOBNAME
ORDERID
---------- -------acct12
00000007
gen786
0000000b
acct14
00000011
acct15
00000012
---------- -------printed : 2
RUN#
---1
1
1
1
---0.50
NODEID
-----------diana
diana
diana
diana
-----------555.35
MEMNAME
---------pgmacct
genx
pgmacct
pgmacct
----------
MEMLIB
CPU
ELAPSED
-------------- ----- ------prod.acct.pgm
0.19 233.15
prod.general
0.12
6.12
prod.acct.pgm
0.05 170.45
prod.acct.pgm
0.14 145.23
-------------- ----- -------
Example 3
The following command deletes the statistical data for January 31, 2000:
ctmruninf -delete 2000013100000 20000131235959
2-82
ctmshout
ctmshout issues Shout messages to an indicated destination. It can be
entered directly or from a job script. For more information, see Shout
Destination Tables on page 1-24.
Specify the following command to invoke utility ctmshout:

ctmshout [-ORDERID <Order_ID>] [-NODEID <Node_ID>]
-USER <Destination> [-USER <Destination>]
-MESSAGE <Message_text> [-MESSAGE <Message_text>]
-SEVERITY <{R|U|V}>
Table 2-36
ctmshout Parameters
Variable
Description
<Order_ID>
Order ID of a job, as displayed in the Job Details window

in ENTERPRISE/CS. The Order ID associates the
message with a specific job in the Active Network.
<Node_ID>
Node ID of the agent platform. This parameter is used for

messages whose destination is either a user in the data
center or a user defined in the Shout Destination table. If
-ORDERID is also specified, this Node_ID will overwrite
the Node ID specified for the job with that Order_ID.
<Destination>
Name of a user in the data center or a valid destination

name in the Shout Destination table. If the user name
does not appear in the Shout Destination table, it must be
a unique user name recognized by Microsoft Exchange.
Shout messages can be sent to multiple destinations in
the same command.
<Message_text>
Free text to be sent to the destination. If the text is more

than one word, it must be enclosed in quotation marks.
Multiple messages can be sent in the same command.
<{R|U|V}>
One letter character indicating the messages urgency:

R Regular (Default)
U Urgent
V Very urgent
Default: R
Each parameter name can be shortened to the minimum number of letters

required to identify the parameter. For example: -ORDERID can be
shortened to -O.
Utilities
2-83
Example 1
The following command sends the message File not found to the Alerts
window in ENTERPRISE/CS and associates it with a job whose Order
ID is 1234:
ctmshout -ORDERID 1234 -USER ECS
-MESSAGE "File not found" -SEVERITY V
Example 2
The following command sends the message The weekly paycheck job
has abended to user Johns email:
ctmshout -NODEID diana -USER John -MESSAGE "The weekly
paycheck job has abended" -SEVERITY V
Example 3
The following illustrates the use of utility ctmshout in a job script

command to send the Shout message Job started to the Alerts window
in ENTERPRISE/CS.
The job processing definition for a certain job contains the following
AutoEdit Assignment parameter:
%%PARM1 = %%ORDERID
Example 4
The script used to execute the job contains the following command:
ctmshout -O $1 -USER ECS -MESSAGE "Job started"
-SEVERITY R
2-84
ctmshtb
ctmshtb sets the active Shout Destination table. The Shout Destination
table associates physical output destinations with logical destination
names specified in Shout and Do Shout statements in job processing
definitions. For more information, see Shout Destination Tables on
page 1-24.
Activation of this utility changes the active Shout Destination table to the
table specified.
You can add, delete, and modify Shout Destination tables using the
ctmsys utility, described earlier in this chapter. The ctmsys utility can
also be used to specify the active Shout Destination table interactively.
Specify the following command to invoke utility ctmshtb:

ctmshtb <Table>
where <Table> is the new Shout Destination table name.

Note
By defining CONTROL-M jobs that execute utility ctmshtb at specified

times, the active Shout Destination table designation can be changed
automatically according to a schedule that suits your site.
Example
The following command sets the current active Shout Destination table
designation to SHIFTMAN:
ctmshtb SHIFTMAN
Utilities
2-85
ctm_suspend
ctm_suspend suspends and restores CONTROL-M/Server
non-communication processes for mass batch uploads/downloads from
ENTERPRISE/CS. During suspension mode, CONTROL-M inactivates
its job processing functions by suspending the TR, SL, NS, and LG
processes. For more information, see CONTROL-M/Server Processes
on page 4-37. Requests for job processing during this mode are
suspended until execution of ctm_suspend restoration mode.
This utility should be invoked before executing the Mass Upload or
Mass Download features on the ENTERPRISE/CS Graphical User
Interface.
Specify the following command to invoke utility ctm_suspend:

ctm_suspend {-s|-r}
Table 2-37
ctm_suspend Parameters
Option
Command
-s
Suspends CONTROL-M/Server scheduling processes but leaves

the gateway to ENTERPRISE/CS open.
-r
Restores CONTROL-M/Server processes. Resumes normal

operating mode.
Example
The following command causes CONTROL-M/Server scheduling

processes to be restored.
ctm_suspend -r
2-86
ctmsys
ctmsys is an interactive utility for maintaining:
Shout Destination tables (for directing Shout messages).

CONTROL-M system parameters.
To invoke utility ctmsys:
1. Log onto the Server platform as the CONTROL-M/Server owner (for

2. Specify the command: ctmsys.
+------------------------------------------------+
|
CONTROL-M SYSTEM MAINTENANCE UTILITY
|
|
Main Menu
|
+------------------------------------------------+
1)
2)

System Parameters
q)
Quit
Enter option:
The options in this menu and in all other menus provided by this utility
can be selected by typing the option number or command letter and
pressing <Enter>.
Each option appearing in the Main menu is described below.
Utilities
2-87
Shout Destination tables associate logical output destinations (specified

in Shout and Do Shout statements in job processing definitions) with
physical destination names. For more information, see Shout
Destination Tables on page 1-24.
To access the Shout Destination Tables menu:
Select Option 1 from the main menu. The following menu is displayed:
Figure 2-16 Shout Destination Tables Menu
Shout Destination Tables Menu

----------------------------Active Shout Destination Table: <table_name>
1)
2)
3)
4)
Create/Modify a Table
Set Active Table
List Tables
Delete Table
q)
Quit and return to main menu
Enter option:
The name of the currently active Shout Destination table is displayed in

the <table_name> field on the menu.
To create or modify a Shout Destination table:
Step 1
Select Option 1 from the Shout Destination Tables menu. A list of

available tables, similar to the following, is displayed:
2-88
Figure 2-17 Sample Report Showing Available Tables

-----------------------SYSTEM
NIGHT_SHIFT
Table to create/modify or q to quit [SYSTEM]:
Step 2
Specify the name of the table to be created or modified (or just press
<Enter> to accept the default listed in the prompt).
If the name you specify is not the name of an existing Shout Destination
table, a new table will be created with the specified name.
A display similar to the following appears. For an existing table, the
defined destinations are listed.
Figure 2-18 Sample Showing Table Creation or Modification Options
Shout Destination Table SYSTEM

-------------------------------# Destination Type Addr Logical Name
- ----------- ---- ---- -----------1
E
S
ECS
2
M
S
david
q) Quit
entry #
e#) Edit entry #
n) New entry
Physical Name
------------david@bmc.com
d#) Delete
Enter option:
Utilities
2-89
The Shout Destination Table System menu displays the fields described
in Table 2-38.
Table 2-38
Shout Destination Table Fields
Field
Description
Entry number in the table.
Destination
Type
One-letter code indicating the type of recipient:

U
Users internet address.
Users mail address.
System console.
CONTROL-M log.
Alert window of ENTERPRISE/CS.
Addr
One-letter code indicating whether the destination is on the

Server (S) or Agent (A) platform.
Logical
Name
Name used in the Shout or Do Shout parameter of a job

processing definition to identify the Shout message recipient.
Physical
Name
The Internet address of a user for destination types U and M.

(For more information, see Shout to Email on page 1-26.)
For destination type M, the physical name is restricted to 30
characters. If you enter more than 30 characters, the name is
truncated.
For destination types O, L and E, no physical name is
specified, because each of these is a unique destination.
To create a new entry in the table:
1. Specify n. The following prompt is displayed:

Dest. Type:
(U)ser,(M)ail,c(O)nsole,(L)og,(E)NTERPRISE/CS:
2. Specify the letter corresponding to the desired destination type.

Address Type (S)erver or (A)gent:
3. For destination type U, M, or O, specify whether the destination is on

the Server (S) or Agent (A). For all other types, specify S. The
following prompt is displayed:
2-90
Logical Name:
4. Specify the logical name for this destination.

Physical Name:
For destination type U, or M, specify the internet address of the user.

For other types, leave this field blank. The maximum length of the
physical name is 30 characters; excess characters will be truncated.
The new entry is added to the table.
To modify an existing entry in the table:
1. Specify e<entry_number>. For example, to modify entry number 2,

specify e2.
At the following prompt, enter only the attributes that have changed.
For attributes that have not changed, press <Enter>.
The following prompt is displayed:
Dest. Type: (U)ser,(M)ail,c(O)nsole,
(L)og,(E)NTERPRISE/CS:
Type the letter corresponding to the desired destination type and

press <Enter>.
2. The following prompt is displayed:
Address Type (S)erver or (A)gent:
For destination type U, M, or O, indicate if the destination is on the

Server (S) or the Agent (A). For all other destination types, specify
S. After specifying S or A, press <Enter>.
3. The following prompt is displayed:
Physical Name:
Utilities
2-91
For destination type U or M, specify the physical name. The

maximum length of the physical name is 30 characters; excess
characters will be truncated.
For other types, leave this field blank. Press <Enter>. The table is
redisplayed with the modified entry.
To delete an existing entry in the table:
1. Specify d<entry #>.

For example, to delete entry # 2, specify d2.
The table is modified.
2. Specify q to return to the Shout Destination Tables menu.
To change the active Shout Destination table:
1. Select Option 2 from the Shout Destination Tables menu. A list

similar to the following is displayed:
Existing Shout Destination Tables
--------------------------------SYSTEM
NIGHT_SHIFT
Enter name of table to make active or q to quit [SYSTEM]:
2. Specify the name of the table to set as the active Shout Destination
table. The following message is displayed:
Table <table name> is now active.
Press ENTER to continue.
3. Press <Enter> to return to the Shout Destination Tables menu.
2-92
The active Shout Destination table is changed immediately, affecting

Shout and Do Shout operations performed by CONTROL-M.
Note
To specify the active Shout Destination table using a batch job, run utility
ctmshtb, described earlier in this chapter.
To list existing Shout Destination tables:

-----------------------SYSTEM
NIGHT_SHIFT
Press ENTER to continue

To delete an existing Shout Destination table:

Existing Shout Destination Tables
--------------------------------SYSTEM
NIGHT_SHIFT
Enter name of table to delete or q to quit:
2. Specify the name of the table to delete. The following message is

displayed:
delete completed successfully.
Press ENTER to continue.
Utilities
2-93

System Parameters
This option is used to view or modify CONTROL-M system parameters.

Note
These parameters are described in System Parameters on page 5-3.

To view or modify CONTROL-M system parameters:
Step 1
Select Option 2 from the Main menu. The first page of parameters and
their current values are displayed.
Figure 2-19 Report Showing System Parameters - Page 1
CONTROL-M System Parameters (Page 1/2)
-------------------------------------Computer System :Intel
Operating System :Windows-NT
CONTROL-M Version :2.2.4
1) Sysout Log Directory :c:\ctmsrv\ctm\sysout
Executable Path :c:\ctmsrv\ctm\exe
2) Day Time :+0700
CONTROL-M Date :20000515
3) Statistics :Y
4) Maximum Retries :10
5) Start Day of the Week :2
Active Shout Table :SYSTEM
n)
s)
c)
Next Page
Save and Return to Main Menu
Cancel
Enter command, or item number you wish to change [n]:
The second page of parameters can be displayed, as described below.
2-94
Figure 2-20 Report Showing System Parameters - Page 2
CONTROL-M System Parameters (Page 2/2)

-------------------------------------7) Full Security :N
8) Maximum Days Retained by CONTROL-M Log :2
9) Maximum Days to Retain Sysout Files :1
10) Ignore New Day Conditions :N
p)
s)
c)
Previous page
Save and Return to Main Menu
Cancel
Enter command, or item number you wish to change [p]:
Parameters that can be modified are preceded by a number.

Step 2
Modify or view parameters as follows:
To switch between the two pages of parameters, type n (next) or p

(previous).
To modify a parameter, type the number preceding the parameter.

If the parameter can have only Y/N values, typing this number
toggles its value between Y and N and redisplays the page.
If the parameter can have any other value, you are prompted to
specify its value. After you specify a value, the page is
redisplayed.
Step 3
When you want to exit:
Type s to save your changes and exit to the Main menu.

Modifications are not saved until you perform this action.
-or
Type c to cancel all changes and exit to the Main menu.
Utilities
2-95
ctmudlst
ctmudlst is used to display or modify UDLAST (the User Daily last run
date). For more information, see Date Control Record (UDLAST) on
page 1-20.
When using utility ctmudlst, the New Day procedure must not be
running (that is, the status of the data center in the Communication Status
window of ENTERPRISE/CS must not be Formatting AJF).
Specify the following command to invoke utility ctmudlst:

ctmudlst LIST <User Daily>
ctmudlst LIST ""
ctmudlst UPDATE <User Daily> <Date>
Table 2-39
ctmudlist Parameters
Option
Description
LIST
Lists the User Daily last run date.
UPDATE
Updates the User Daily last run date.
<User Daily>
User Daily name.
Asterisk enclosed in quotation marks. Displays a list of all

User Daily names and corresponding last run dates.
<Date>
Requested value for the last running date in yyyymmdd

format.
Example 1
The following command lists the last run date for User Daily payroll:
ctmudlst LIST payroll
Example 2
The following command changes the last run date for User Daily
inventory to Aug. 10, 2000:
ctmudlst UPDATE inventory 20000810
2-96
ctmudly
ctmudly orders jobs for a specific User Daily name.
The utility orders all Scheduling tables associated with a specific User
Daily name. Each job in the ordered Scheduling tables whose Scheduling
criteria are satisfied is placed in the Active Jobs file.
For more information and examples, see User Daily Jobs on page 1-17.
Specify the following command to invoke utility ctmudly.

ctmudly <User Daily>
where <User Daily> is a User Daily name associated with one or more
Scheduling tables. This parameter is case-sensitive.
Example
The following command orders all Scheduling tables whose User Daily
parameter is prod:
ctmudly prod
Utilities
2-97
ctmwhy
ctmwhy displays a report stating why a job waiting in the Active Jobs
file is not being submitted for execution. This utility is equivalent to the
Why option available from the Job Node menu in the Enterprise
Controlstation window.
Specify the following command to invoke the utility ctmwhy:

ctmwhy <Order ID>
where <Order ID> is the Order ID of a job waiting in the Active Jobs file
(as displayed in the Job Details window of ENTERPRISE/CS).
Note
The Order ID as displayed in the Job Details window is a base 36

number. If you want to specify the Order ID here as a base 10 number,
insert an asterisk before the number and enclose the result in quotation
marks (for example, 1234).
Example 1
Specify the following command to determine why the job with Order ID
A4X is not being submitted for execution:
ctmwhy A4X
A typical response might be QR: TAPE4: needed 2. None reserved,

which indicates that the job is not being submitted because it requires
two of the Quantitative resource TAPE4, and none is available.
Example 2
Specify the following command to determine why the job with Order ID
11 is not being submitted for execution. The Order ID in this example is
expressed as a base 10 number:
ctmwhy "37"
2-98
dbversion
dbversion displays a general description of the MSSQL database in use,
including the current version number.
Specify the following command at the DOS command prompt to invoke

utility dbversion:
dbversion
Utilities
2-99
ecacontb
ecacontb performs operations on the Prerequisite Conditions table.
These operations include:
Listing existing prerequisite conditions.

Adding/deleting a prerequisite condition.
Deleting a range of conditions (from/to specified dates).
Note
Utility ctmcontb is an upgraded version of ecacontb with enhanced

functionality provided by wild card and odate parameter support. It is
recommended that you use ctmcontb instead of ecacontb in batch jobs.
Utility ecacontb has been retained for compatibility with previous
versions of CONTROL-M.
To list existing prerequisite conditions:
Specify the following command:

ecacontb LIST <Condition Name> [<Output>]
where:
Table 2-40
ecacontp Parameters
Variable
Description
<Condition Name>
Name of the prerequisite condition to include in the

report. The condition name can include the mask
character to denote any number of characters
(including no characters). In this instance, the
condition name must be enclosed in quotation
marks (for example, LVL ). Specify by itself to
include all existing conditions.
<Output>

2-100
To add or delete prerequisite conditions:
Specify one of the following commands:

ecacontb ADD <Condition Name> <Date>
ecacontb DELETE <Condition Name> <Date>
Table 2-41
Add/Delete Prerequisite Conditions
Variable
Description
<Condition Name>
Name of prerequisite condition to add or delete.
<Date>
Date of the prerequisite condition. The date

retained in the database is in mmdd format. If you
specify the date in yymmdd or yyyymmdd format,
the ys will be ignored.
To delete all prerequisite conditions with condition dates in a given

range:

ecacontb DELETEFROM <From Date> <To Date>
where:
<From Date> <To Date>
Starting and ending dates for range of condition dates of prerequisite
conditions to delete. Specify each date in mmdd format.
Example 1
The following command specifies that prerequisite condition bckp_end

with condition date Dec. 3 should be deleted:
ecacontb DELETE bckp_end 1203
Utilities
2-101
Example 2
The following command specifies that all prerequisite conditions whose

condition dates fall in the range of Dec. 1 to Dec. 31 should be deleted:
ecacontb DELETEFROM 1201 1231
Example 3
The following command specifies that all existing prerequisite conditions

should be listed:
ecacontb LIST "*"
When this command is specified, a report similar to the following is

generated:
Figure 2-21 Sample of a Utility ecacontb Report
Date: 30-JUN-2000.
Page 1
Conditions list
+--------------------------------------+
CONDNAME CONDDATE
+--------------------------------------+
APR1-L20
APR1-L20
ARD-L3OK
LVL11-LVL22
LVL11-LVL22
LVL11-LVL22
PKR11-LVL01
0629
0630
0630
0628
0629
0630
0630
This example demonstrates the advantage of defining a CONTROL-M

job to run a utility.
2-102
The following job processing definition causes CONTROL-M to run

ecacontb each work day, each time deleting all prerequisite conditions
that are between five and ten days old:
Figure 2-22 Sample of a Job Processing Definition Using ecacontb
Week Days 2,3,4,5,6

AutoEdit Assignment %%A=%%CALCDATE %%DATE -10
%%B=%%CALCDATE %%DATE -5
%%A=%%SUBSTR %%A 3 4
%%B=%%SUBSTR %%B 3 4
Command Line
ecacontb DELETEFROM %%A %%B
Utilities
2-103
ecactltb
ecactltb displays a list of Control resources and the status of each one.
Specify the following command to invoke utility ecactltb:

ecactltb [<Output>]
where <Output> is the full path name to which the report should be sent
(optional). If this parameter is not specified, the output is routed to the
default output device.
Example
The following command generates a list of Control resources in the

rprt.txt file.
ecactltb /ctm/user1/rprt.txt
2-104
ecaqrtab
ecaqrtab performs operations on the Quantitative Resources table. These
operations include:
Listing Quantitative resources.

Adding/deleting a Quantitative resource.
Manually altering availability of a Quantitative resource.
To list Quantitative resources:

ecaqrtab LIST[<QR Name>][<Output>]
Table 2-42
ecaqrtab Parameters
Variable
Description
<QR Name>
Name of the Quantitative resource. The QR Name

can include the mask character to denote any
number of characters (including no characters). In
this instance, the name must be enclosed in
quotation marks (for example, LVL ). Specify
by itself to include all existing Quantitative
resources (default).
<Output>

The LIST option displays the status of the requested Quantitative

resources. This information is also available from ENTERPRISE/CS in
the Quantitative Resources Map window.
When the LIST option is specified, the parameters in Table 2-43are
displayed:
Utilities
2-105
Table 2-43
ecaqrtab List option Parameters
Parameter
Description
QR name
Quantitative resource name (with @<Node ID> where

applicable).
Type
For future use.
Max Avail
Maximum number of units of this resource in the platform.
Reserved
Number of units of the resource reserved for critical-path

jobs.
Used
Number of units of the resource currently in use or reserved.

If utility ctmloadset is used in the data center, this number
can include usage of the resource by non-CONTROL-M jobs.
Free
Number of units of the resource currently available for use.

This represents the difference between Max Avail and Used.
To add, delete or alter the availability of a Quantitative resource:
Specify one of the following commands:

ecaqrtab ADD
ecaqrtab DELETE
ecaqrtab UPDATE
Table 2-44
<QR name> <Max>

<QR name>
<QR name> <Max>
Quantitative Resource Availability
Variable
Description
ADD
Defines a new Quantitative resource and sets the maximum

availability for the resource.
DELETE
Deletes an existing Quantitative resource.
UPDATE
Changes the maximum availability for an existing Quantitative

resource.
<QR name>
Specifies the name of a Quantitative resource. To specify a

resource for a specific agent platform, append @<Node
ID> to the resource name (for example, for resource
CPU on platform diana, specify CPU@diana).
<Max>
Specifies the maximum availability of this resource.
2-106
Example 1
The following command specifies that the new Quantitative resource

tape2 is to be added to the Quantitative Resource table, with a maximum
availability of 12 units:
ecaqrtab ADD tape2 12
Example 2
The following command specifies that the Quantitative resource tape3 is

to be deleted from the table:
ecaqrtab DELETE tape3
Example 3
The following command specifies that the new maximum availability for
the existing Quantitative resource linerje2 on platform diana is 12 units:
ecaqrtab UPDATE linerje2@diana 12
Example 4
The following command lists the current status of all Quantitative

resources contained in the Quantitative Resource table:
ecaqrtab LIST * or ecaqrtab LIST

Figure 2-23 Sample Report from Utility ecaqrtab
+------------------------------------------------------+
Resource Name
+------------------------------------------------------+
CPU@linda
L
10
0
10
0
CPU@diana
L
20
0
15
5
MEM@diana
L
10
0
0
10
Tape2
L
12
2
2
10
Utilities
2-107
2-108
Security
Overview
CONTROL-M contains an integral security system that protects the
functionality provided by CONTROL-M against unauthorized usage or
modification. This security system strengthens the standard operating
system security facility and provides an additional application-level
security layer.
Using the CONTROL-M security system, it is possible to specify which
actions each ENTERPRISE/CS user or CONTROL-M user is authorized
to perform. These authorizations are implemented as security checks and
verifications every time one of the following actions is attempted:
Accessing a Scheduling table (to add, delete or modify a job

definition).
Ordering a job.
Selecting and submitting a job.
Commands affecting jobs in the Active Jobs file (for example, Hold,
Confirm, Rerun).
Maintenance of CONTROL-M entities (for example, calendars,

prerequisite conditions).
Security
3-1
The security verifications for these actions are implemented according to

the specifications in a database of authorizations. This database can be
modified by the security officer/systems manager to meet the needs of
the enterprise. For more information, see Security Maintenance Utility
on page 3-12.
Level of Application Security

CONTROL-M provides the following levels of application security for
users not explicitly defined in the CONTROL-M security database:
Restricted
A user who is not defined in the CONTROL-M security database is
regarded as having no authorizations and is not able to perform any
function for which security authorization is required.
Unrestricted
A user not defined in the CONTROL-M security database is
regarded as having all CONTROL-M application authorizations.
Regardless of which level is implemented:
A user for whom one or more authorizations have been assigned in

the security database can only perform the actions for which he/she
is specifically authorized.
If Windows NT option Log on as user has been selected, the owner

of each job processing definition must be defined as a user on the
Agent platform. Otherwise, CONTROL-M will not order or execute
the job.
The security level is determined by the value of the CONTROL-M

system parameter Full Security. For more information, see Chapter 5,
3-2
CONTROL-M Security Concepts

Overview
Every time a user or a job attempts to perform an action that requires
access to or updates any component of the CONTROL-M database,
CONTROL-M verifies that the user or job is authorized to perform the
attempted action. Tables that list authorizations are contained in a portion
of the CONTROL-M database referred to as the Security database.
The Security database is maintained using the Security Maintenance
utility. See Security Maintenance Utility on page 3-12.
Authorizations in the CONTROL-M Security database are divided into
the following areas:
Scheduling Table Authorization

User actions performed on specific Scheduling tables.
Active Jobs File Authorization

User actions performed on individual jobs in the Active Jobs file.
Entities Authorization
User actions performed on various CONTROL-M entities (for
example, prerequisite conditions).
Each security check relates to one of the following:
Whether or not the current ENTERPRISE/CS user is authorized to

perform the action that he/she is attempting to perform.
Whether or not the owner of an executing job is authorized to order

or force additional jobs belonging to the same or different owners.
Security
3-3

Scheduling Table Authorization determines a users authorization to
perform actions on an entire Scheduling table. The actions controlled by
this authorization are detailed in Table 3-1.
Table 3-1
Scheduling Table Authorizations
Action
Authorization
Delete
Deleting an entire Scheduling table or any individual job

contained in the table.
Read
Downloading a Scheduling table from the Server platform to

the ENTERPRISE/CS workstation.
Update
Uploading a Scheduling table from the ENTERPRISE/CS

workstation to the Server platform.
OrderTable
Ordering or forcing an entire Scheduling table or any job

contained in the table.
Authorization for OrderTable for a Scheduling table is checked in the

following situations:
When a user of ENTERPRISE/CS attempts to order or force a

Scheduling table or any job in the table, CONTROL-M checks the
users authorization for the action.
When a job executing under CONTROL-M attempts to perform a Do

Forcejob action on a Scheduling table or any job in the table,
CONTROL-M checks the authorization of the jobs Owner.
When the Scheduling table is ordered by a User Daily job,

CONTROL-M checks the authorization of the User Daily jobs
Owner.
3-4
When a Scheduling table is ordered by the New Day procedure,

CONTROL-M checks the authorization of the CONTROL-M
account owner.
Note
In addition to the security checks described above, CONTROL-M checks

authorization for each job in the Scheduling table, as described in
Active Jobs File Authorization below.

Active Jobs File Authorization determine a users authorization to
perform actions that affect jobs in the Active Jobs file or that place jobs
in the Active Jobs file. Authorizations are assigned to a user for jobs
belonging to specific owners (for example, user Robert is or is not
authorized to order a job whose owner is Michelle). For each
ENTERPRISE/CS user, the security facility enables you to specify what
action the user is authorized to perform on jobs owned by other users.
Note
CONTROL-M requires that a user be authorized to perform actions even

if that user is specified in the jobs Owner parameter.
The actions controlled by the Active Jobs File Authorization are
described in Table 3-2.
Table 3-2
Active Jobs File Authorizations
Action
Authorization
Order
Order a job.
Force
Force a job.
Rerun
Select the Rerun option from the job Details menu.
Hold
Select the Hold/Free option from the job Details menu.
Confirm
Select the Confirm option from the job Details menu.
Delete
Select the Delete option from the job Details menu.
Security
3-5
Table 3-2
Active Jobs File Authorizations
Action
Authorization
Why
Select the Why option from the job Details menu.
Sysout
Select the Sysout option from the job Details menu.
Log
Select the Log option from the job Details menu.
Statistics
Select the Statistics option from the job Details menu.
Authorization for the Order action is checked in the following

situations:
When a user of ENTERPRISE/CS attempts to order a job from the

Job List window, CONTROL-M checks the authorization of the user
for the jobs owner.
When a job is ordered or forced (regardless of how), CONTROL-M

checks the authorization of the jobs author for the jobs owner.
Authorization for the Force action is checked in the following situations:
When a user of ENTERPRISE/CS attempts to force a job from the

Job List window, CONTROL-M checks the authorization of the user
for the jobs owner.
When a job executing under CONTROL-M attempts to perform a Do

Forcejob action on an entire table or on an individual job,
CONTROL-M checks the authorization of the jobs Owner for the
owner of each job contained in the Scheduling table or each
individual job.
Note
When performing Order or Force actions on an entire table,

CONTROL-M checks Scheduling table authorizations, as described in
Scheduling Table Authorizations earlier in this chapter, in addition to
the security checks described above.
3-6
Utility ctmordck can be used to generate a report that indicates whether

or not the CONTROL-M security mechanism will allow jobs associated
with a given User Daily name to run with the authorizations currently
assigned to the owner of the User Daily job. For more information, see
For the other actions listed above (Rerun, Hold, Confirm, Delete, Why,
Sysout, Log, Statistics), CONTROL-M checks that the
ENTERPRISE/CS user performing the action is authorized to perform
the specific action for the jobs owner.
Entities Authorization determines a users authorization to perform
actions on certain CONTROL-M entities. These entities are accessed
either directly from the ENTERPRISE/CS workstation or using utilities
on CONTROL-M Server or Agent platforms. Access to the entities
described in Table 3-3 is controlled by these authorizations.
Table 3-3
Entity
Authorization
Access
Calendar
Calendars used when specifying job

processing parameters
ENTERPRISE/CS
Log
CONTROL-M/Server log
ctmlog
Resource
Quantitative resources
ENTERPRISE/CS
ecaqrtab
Condition
CONTROL-M prerequisite conditions,

(including global conditions)
ENTERPRISE/CS
ctmcontb
ecacontb
Control
Control resources
ENTERPRISE/CS
Security
3-7
For each of the entities described in Table 3-3, a user can be assigned
authorization to perform Add and/or Delete actions:
To add or modify a CONTROL-M entity, a user requires both Add

and Delete authorization.
To delete a CONTROL-M entity, a user requires Delete

authorization.
No special authorization is required to view any of these entities.

Passing Global Conditions Between Data Centers
When a global condition is added or deleted in one data center,

ENTERPRISE/CS also performs that action in other data centers. In each
of these other data centers, the addition or deletion of the global
condition is attributed to a special user named GCSERV.
When the CONTROL-M security mechanism is implemented in a data
center to which actions on global conditions will be passed, user
GCSERV must be defined in the CONTROL-M security facility at that
data center. User GCSERV should be assigned authorization to add and
delete prerequisite conditions.
Agent Platform Security Checks

In addition to the security checks detailed above, CONTROL-M utilizes
checks provided by the Agent platform operating system to further
enhance data center security. These security checks are applied regardless
of the security mode (restricted or unrestricted) implemented in the data
center.
Agent platform operating system authorization is verified by
CONTROL-M in the following instances:
3-8
Before a job is selected or submitted, the operating system security

mechanism on the relevant Agent platform is called to verify that the
jobs Owner is authorized to execute the job script file. Actions not
authorized by the operating system are rejected.
Note
The owner of each job processing definition must be defined as a user on

the Agent platform. Otherwise, CONTROL-M will not order or execute
the job.
When an ENTERPRISE/CS user attempts to perform the Edit

JCL/Script action, CONTROL-M/Agent verifies that the user is
defined on the Agent platform and that the user has write permission
to update the relevant files.
Summary of Authorizations
The authorizations required to perform various actions under
CONTROL-M/Server are summarized in the following tables.
To submit jobs from a User Daily job:

Table 3-4
Authorization Job Submission from a User Daily Job
Who
Authorization
User Daily jobs owner
Scheduling Table authorization: OrderTable for

the Scheduling table containing the jobs.
Owner of each job ordered

by the User Daily job
Agent platform operating system authorization to

execute the job script file.
Author of each job ordered
Active Jobs File authorization: Order for the

owner of the job.
Security
3-9
To submit jobs from the New Day procedure:

Table 3-5
Authorization Job Submission from the New Day Procedure
Who
Authorization
CONTROL-M account
owner


by the User Daily job
Agent platform operating system authorization

to execute the job script file.

owner of the job.
To order or force a Scheduling table from ENTERPRISE/CS:

Table 3-6
Authorization Order/Force a Scheduling Table
Who
Authorization
ENTERPRISE/CS user


or forced


or forced
Active Jobs File authorization to order/force:

Order/Force for the owner of the job.
To order or force a job from ENTERPRISE/CS:

Table 3-7
Authorization Order/Force a Job from ENTERPRISE/CS
Who
Authorization
ENTERPRISE/CS user

the Scheduling table containing the job.
Active Jobs File Authorization to order/force a
job: Order/Force for the owner of the job.

or forced


or forced

owner of the job.
3-10
To force a job or scheduling table using Do Forcejob:

Table 3-8
Authorization Do Forcejob
Who
Authorization
Owner of the job performing

the Do Forcejob action

Scheduling table containing the job(s) to be
forced.
Active Jobs File Authorization: Force for the
owner of the job(s) being forced.
Owner of each job forced

Author of each job forced

owner of the job.
To perform one of the following actions for a job in the Active network:
Table 3-9
Authorization Actions on a Job in the Active Network
User
Action
Authorization
ENTERPRISE/CS user
All actions
A user on the Agent

platform.
Rerun, Hold, Confirm,

Delete, Why, Sysout,
Log, Statistics
Separate Active Jobs File

authorization for each
specified action.
Edit JCL/Script
Operating system write

permission for the script
files on the Agent platform.
Security
3-11
Security Maintenance Utility

The CONTROL-M Security Maintenance utility ctmsec is used to define
users in the CONTROL-M Security database and to assign them the
necessary authorizations for working with CONTROL-M using the
ENTERPRISE/CS workstation. This utility is run directly on the Server
platform.
Note
Modifications to authorizations using this utility only take effect after

exiting the utility.
To invoke the CONTROL-M Security Maintenance utility:
Step 1
Log on to the Server platform as an NT local administrator.
Step 2
Specify the command: ctmsec

The CONTROL-M Security Maintenance Utility main menu is
displayed.
Figure 3-1
Security Maintenance Utility Main Menu
+-----------------------------------------------+
|
CONTROL-M SECURITY MAINTENANCE UTILITY
|
|
Main Menu
|
+-----------------------------------------------+
1)
2)
3)
4)
User Maintenance
q)
Quit
Enter option:
3-12
The options in this menu and in all other menus provided by this utility
can be selected by typing the option number or command letter and
pressing <Enter>.
Each of the options appearing in the Main menu is described below.
Note
When working with CONTROL-M/Server using the ENTERPRISE/CS

workstation, full wild card support is available for User Name, Owner,
and Scheduling Table Name. Use of characters * and $ in assigning
authorizations in the CONTROL-M Security database will translate to
wild card masking characters during runtime security checking (for
example, if User1 is defined to have full Scheduling Table authorization
for table ACC*, CONTROL-M/Server will allow User1 to update and/or
order any table whose name starts with ACC). Wild card mask characters
function as follows:
Note
* represents any number of characters (including no characters).

$ represents a single character.
Note
Masking character authorizations do not override full name

authorizations (for example, if User1 from the example above is also
defined to have only Read privileges for ACC999, CONTROL-M/Server
will not allow User1 to update and/or order table ACC999).
Security
3-13
User Maintenance
The User Maintenance option of utility ctmsec is used to add, delete or
modify specific users in the CONTROL-M Security database.
Note
Each ENTERPRISE/CS user who performs actions affecting the

CONTROL-M database or jobs in the Active Jobs file must have a user
account on the Server platform and must be defined in the CONTROL-M
Security database. The user name on the Server platform must be the
same as the user name on the ENTERPRISE/CS workstation.
It is the responsibility of the system administrator for the platform to
create an account for each user.
To maintain users in the CONTROL-M Security database:
Select Option 1 from the Main menu.

Figure 3-2
User Maintenance Menu
User Maintenance Menu

--------------------1)
List
Users
2)
Add
User
3)
Delete User
4)
Modify User Information
x)
Exit to main menu
Enter option:
3-14
To list existing users in the CONTROL-M Security database:
Select Option 1 from the User Maintenance menu.

A list similar to the following is displayed:
Figure 3-3
User Maintenance Menu User List
User
Description
Group
----------------- ---------------------------- ------GCSERV
For passing Global conds.
User1
Press ENTER to continue:
Press <Enter> to return to the User Maintenance menu.

To add a new user to the CONTROL-M Security database:
Step 1

A prompt similar to the following is displayed:
Username [User1]:
Step 2
Specify the user name of the ENTERPRISE/CS user (maximum 30

characters, case-sensitive).
After confirmation, the user is added to the Security database and the
User Maintenance menu is displayed.
Note
To specify values for the fields Description and Group, use the Modify
User Information option from the User Maintenance menu.
Security
3-15
To delete an existing user from the CONTROL-M Security database:

Step 1

Username [User1]:
Step 2
Specify the user name of the ENTERPRISE/CS user to delete.

After confirmation, the user is deleted from the Security database and the
User Maintenance menu is displayed.
To modify the Description or Group fields for an existing user:

Step 1

Username [User1]:
Step 2
Specify the user name of the ENTERPRISE/CS user to modify.

A listing similar to the following is displayed:
Figure 3-4
User Maintenance Menu Modify User Information
User: User1
Modify User Information
----------------------1) Description :
2) Group
:
s)
c)
Save
and return to menu
Cancel and return to menu
Enter command, or specify item number to modify:
Step 3
To modify a field, type the number preceding the field.

3-16
You are prompted to supply a value for the field (maximum length: 50
characters for Description, 32 characters for Group).
These fields are for documentation purposes only.
Step 4
Type s to save your changes and return to the last menu.

-or
Type c to cancel all changes and return to the previous menu.

This option is used to assign authorizations to a user to perform actions
on a Scheduling table.
These authorizations are described earlier in this chapter.
To maintain Scheduling Table authorizations:
Step 1
Select Option 2 from the main menu. A prompt similar to the following
is displayed:
Figure 3-5
Scheduling Table Authorization Menu
+--------------------------------------+
|
SCHEDULING TABLE AUTHORIZATION
|
+--------------------------------------+
Username [User1]:
Step 2
Specify the user name of the ENTERPRISE/CS user for whom you are
performing this function.
If the user name is not defined on the Server platform, the following
message is displayed:
Security
3-17
Figure 3-6
Sample of a Message User Name not Defined
User name is not recognized by the operating system.

Contact your system administrator to add a new user.
Step 3
Press <Enter> to return to the main menu.

If the user is defined on the Server platform but is not yet defined in the
CONTROL-M Security database, the following message is displayed:
Figure 3-7
Message User Name not Defined in Security Database
User name is not defined in the CONTROL-M Security database.

Add this user now [Y/N]?
Step 4
Type Y to add the new user to the CONTROL-M security database.

Figure 3-8

----------------------------------1) List Tables
2) Create/Modify Table Authorization
3) Delete Table Authorization
x)
Exit to main menu
Enter option:
To list existing Scheduling Table authorizations for the specified user:

Step 1
Select Option 1 from the Scheduling Table Authorizations menu.

3-18
Figure 3-9
Sample of a Scheduling Table Authorizations Listing
List for user: User1

Table
Delete Read Update
------------------- ------ ---- -----Sched1
N
N
N
Sched2
Y
Y
Y
OrderTable
----------
Step 2
Press <Enter> to return to the Scheduling Table Authorizations menu.
To create or modify Scheduling Table authorizations for the specified user:

Step 1

Table Name:
Step 2
Specify the name of a Scheduling table (maximum 20 characters, casesensitive).

The Scheduling table does not have to exist when you specify
authorizations for it.
Security
3-19
Figure 3-10 Scheduling Table Creation and Modification Menu
Scheduling Table Name: Sched1, User: User1

Create/Modify Table Authorization
--------------------------------1) Delete
:N
2) Read
:N
3) Update
:N
4) OrderTable :N
s)
c)
Save
and return to menu
Enter command, or specify item number to toggle Y/N:
If the user was previously authorized for this scheduling table, the users
current authorizations are displayed; otherwise, all authorizations are set
to N.
Step 3
To modify an authorization, type the number preceding the authorization.

The authorization is toggled from Y to N or from N to Y.
Step 4

-or
Type c to cancel all changes and return to the last menu.
To delete Scheduling Table authorizations for the specified user:

Step 1

Table Name:
3-20
Step 2
Specify the name of the Scheduling table whose authorizations you wish
to delete for this user (or just press <Enter> to return to the menu).
The users authorizations for this table are deleted from the Security
database and the Scheduling Table Authorizations menu is displayed.

on jobs in the Active Jobs file. The authorizations assigned are for
specific job owners (the user in the job processing parameter Owner for
each job).
These authorizations are described in Active Jobs File Authorization
on page 3-5.
To maintain Active Jobs File authorizations:
Step 1

Figure 3-11 Active Jobs File Authorization Menu
+--------------------------------------+
|
ACTIVE JOBS FILE AUTHORIZATION
|
+--------------------------------------+
Username [User1]:
Step 2
Security
3-21
Figure 3-12 Screen Showing Message Where User Name is not Defined

Step 3
Press <Enter> to return to the Main menu.

CONTROL-M security database, the following message is displayed:
Figure 3-13 Message User not Defined in the Security Database
User name is not defined in the CONTROL-M Security

database.
Step 4

Figure 3-14 Active Jobs File Authorization Menu
Active Jobs File Authorization Menu

----------------------------------1) List Owner Names
2) Create/Modify AJF Authorization
3) Delete AJF Authorization
x)
Exit to main menu
Enter option:
To list owners for whom the user has Active Jobs File authorizations:
Step 1
Select Option 1 from the Active Jobs File Authorizations menu.

3-22
Figure 3-15 List of Owners User has Active Jobs File Authorizations
Owner
-------------Owner1
Owner2
Hold
---N
Y
Force
----Y
Y
Del
--Y
Y
Rerun
----Y
Y
Log
--N
Y
Why
--N
Y
Statist
------N
Y
Sysout
-----N
Y
Order
----Y
Y
Conf
---N
Y
Step 2
Press <Enter> to return to the Active Jobs File Authorizations menu.
To create or modify Active Jobs File authorizations for the specified user:
Step 1

Owner:
Step 2
Specify the name of a job owner (maximum 30 characters, casesensitive).

Security
3-23
Figure 3-16 Creation/Modification of Active Jobs File Authorization
Owner Name: Owner1, User: User1

Create/Modify Active Jobs File Authorization
-------------------------------------------1) Order
:Y
2) Force
:Y
3) Rerun
:Y
4) Hold
:N
5) Confirm
:N
6) Delete
:Y
7) Why
:N
8) Sysout
:N
9) Log
:N
10) Statistics :N
s)
c)
Save
and return to menu
If the user was previous authorized for this owner, the users current
authorizations are displayed; otherwise, all authorizations are set to N.
Step 3

Step 4
When you wish to exit:

-or
3-24
To delete Active Jobs File authorizations for the specified user:

Step 1

Owner:
Step 2
Specify the name of the owner for whom authorizations should be

deleted (or just press <Enter> to return to the menu).
The users authorizations for this owner are deleted from the Security
database and the Active Jobs File Authorizations menu is displayed.
Entities Authorizations
relating to CONTROL-M entities.
These authorizations are described earlier in this chapter.
To maintain Entities authorizations:
Step 1

Figure 3-17 Maintain Entities Authorization Menu
+----------------------------------------+
|
CONTROL-M ENTITIES AUTHORIZATION
|
+----------------------------------------+
Username [User1]:
Step 2
Security
3-25
Figure 3-18 Message User Name not Defined on the Server Platform

Step 3
Press <Enter> to return to the main menu.

CONTROL-M security database, the following message is displayed:
Figure 3-19 Message User Name not Defined in Security Database
User name is not defined in the CONTROL-M Security

database.
Step 4

Figure 3-20 Entities Authorization Menu
Entities Authorization Menu. Username: User1

-------------------------------------------1)
List Entity Categories
2)
Create/Modify Entity Authorization
3)
Delete Entity Category
x)
Exit to main menu
Enter option:
3-26
To list Entity categories for which the user has authorizations:

Step 1
Select Option 1 from the Entities Authorizations menu.
Step 2

Figure 3-21 Categories for Which User has Authorizations

Category
Add Delete
--------------------- --- -----CALENDAR
Y
N
QUANTITATIVE RESOURCE Y
N
CONTROL RESOURCE
Y
N
Step 3
Press <Enter> to return to the Entities Authorizations menu.
To create or modify Entity authorizations for the specified user:

Step 1

Figure 3-22 Categories for Creation/Modification of Entity Authorizations
Categories
---------1) CALENDAR
2) LOG
3) QUANTITATIVE RESOURCE
4) CONDITION
5) CONTROL RESOURCE
x) Exit to menu
Category number:
Security
3-27
Step 2
Specify a number corresponding to the category for which to assign

authorizations.
Figure 3-23 Menu Assigning Authorizations to an Entity in a Category
Category: CALENDAR, User: User1

Create/Change Entity Authorizations
----------------------------------1) Add
:Y
2) Delete :N
s)
c)
Save
and return to menu
If the user was previously authorized for this category, the users current
authorizations are displayed; otherwise, all authorizations are set to N.
Step 3

Step 4

-or
3-28
To delete Entity authorizations for the specified user:

Step 1

Categories
---------1) CALENDAR
2) LOG
3) RESOURCE
4) CONDITION
5) CONTROL
x) Exit to menu
Category number:
Step 2
Specify a number corresponding to the category for which to delete

authorizations.
The users authorizations for this category are deleted from the Security
database and the Entities Authorizations menu is displayed.
Security
3-29
3-30
Maintenance
Overview
This chapter discusses the following topics:
Database Configuration
CONTROL-M Maintenance Procedures
CONTROL-M Menu System.
CONTROL-M Server Processes
Database Configuration
Recommended values for configuring the database are listed in Table 41.
Maintenance
4-1
Table 4-1
Database Attributes
Attribute
MSSQL
6.5
MSSQL
7.0
Number of locks
30000
Number of user connections
60
Number of open objects
500
Recovery interval (in minutes)
10
Minimum Server memory
10,240
10,240
Max network packet size
4096
4096
Procedure cache percent
30
30
4-2
CONTROL-M Maintenance Procedures

The CONTROL-M Menu system provides access to a variety of
functions required to customize and maintain the CONTROL-M data
center. Most of the maintenance procedures described below refer to
functions that are available from one of the CONTROL-M menus.
The CONTROL-M Menu system is described later in this chapter.
Starting/Stopping CONTROL-M/Server Tasks

To start CONTROL-M/Server functions in the data center, the following
tasks must be running on the Server platform:
SQL Server1.
CONTROL-M/Server.
The SQL Server must be started before CONTROL-M/Server and must

be active as long as CONTROL-M/Server is active.
CONTROL-M/Server can be operated as a Windows NT service.
CONTROL-M/Server operates as a background process transparent to
the user.
Windows NT Service Mode
CONTROL-M/Server is usually started automatically at boot time as a

Windows NT service and remains active as long as Windows NT is
running.
Under certain circumstances, you may want to start or stop
CONTROL-M/Server manually (for example, to perform certain
diagnostics processes). You can use the following procedures to
accomplish this.
1. If CONTROL-M/Server is implemented using an existing SQL Server, starting and stopping

the server is the responsibility of the database administrator.
Maintenance
4-3
To start CONTROL-M/Server manually:

Step 1
Select Control Panel => Services => Control-M/Server.
Step 2
Click the Start button.

-orSpecify command start-ctm.
To stop CONTROL-M/Server manually:

Step 1
Select Control Panel => Services => Control-M/Server.
Step 2
Click the Stop button.

-orSpecify command shut-ctm.
Using the CONTROL-M Menu System
The CONTROL-M Menu system provides options for starting and

stopping CONTROL-M/Server and the SQL Server. For more
information, see CONTROL-M Menu System on page 4-6.
Periodic Maintenance
The following procedures should be performed on a regular basis:
Check available space in the CONTROL-M database.

Clean up the database message log.
Clean up the proclog directory.
Each of these topics is discussed below.
4-4
Check Available Space in the CONTROL-M Database
It is recommended that the amount of available space in the

CONTROL-M database be checked on a regular basis. If the available
space falls below 20%, the database should be extended. For more
information, see Extend Database Size on page 4-20.
To check the available space in the CONTROL-M database, use the
Check Database option in the Database Creation Menu on page 4-10.
You can define a CONTROL-M job that periodically checks the database
and issues a Shout message if a problem is detected. Such a job would
call the script: c:\ctmsrv\ctm\exe\ctmdbcheck
This is the same script used by the Check Database option. This script
generates messages about the amount of space in the CONTROL-M
database. For example:
WARNING: Database is more than half full
ATTENTION: Database is more than 80% full
ATTENTION: Database log segment is more than 90% full
A CONTROL-M job using the On Statement/Code parameter can

detect these messages and issue appropriate Shout messages.
Clean Up the Database Message Log
The SQL Server writes a message to a log file when the server is started
or shut down, and when a database error occurs. This log file is not
automatically truncated. If not manually truncated, the file will
eventually waste a large amount of disk space.
When CONTROL-M/Server uses the dedicated SQL Server provided

during installation, the CONTROL-M administrator must truncate
this file on a regular basis. The location of this file is:
c:\ctmsrv\sql11\data\errorlog
If CONTROL-M/Server is configured to use an existing SQL Server,

the administrator must truncate this file on a regular basis.
Maintenance
4-5
Clean Up the Proclog Directory
When CONTROL-M/Server is operated at a diagnostic level greater than

zero, diagnostics log files are written to the directory:
c:\ctmsrv\ctm\proclog\
See Set Diagnostic Level on page 4-34.

If CONTROL-M/Server is operated in this manner for an extended
period, these log files will eventually waste a large amount of disk space.
It is the responsibility of the CONTROL-M administrator to delete these
files when they are no longer needed.
CONTROL-M Menu System

The CONTROL-M Menu system enables you to access a variety of
functions and utilities used to maintain CONTROL-M.
The functions accessible from these menus are organized according to
function group, enabling you to easily locate the desired option.
These menus can only be accessed from the account of the
CONTROL-M/Server owner.
CONTROL-M Main Menu

The CONTROL-M Main menu is the entry point for accessing the
CONTROL-M Menu system.
To open the CONTROL-M Main menu:
Step 1
Log on to the Server platform as the CONTROL-M/Server owner (for

Step 2
Open a command prompt and enter: ctm_menu

4-6

Figure 4-1
CONTROL - M Main Menu
CONTROL-M Main Menu

-------------------Select one of the following menus:
1 - CONTROL-M Manager
2 - Database Creation
3 - Database Maintenance
4 - Parameter Customization
5 - Node Group
6 - Agent Status
7 - Troubleshooting
q - Quit
Step 3
Enter the corresponding number and press <Enter>.

Each menu is described in this chapter. The menus available are listed in
Table 4-2.
Table 4-2
CONTROL-M Menus
Menu
Description
CONTROL-M Manager
Start and shut down CONTROL-M and the SQL

Server.
Database Creation
Create or delete the CONTROL-M database.
Database Maintenance
Perform various CONTROL-M database

maintenance functions.
Parameter
Customization
View and update parameters for customizing

CONTROL-M/Server.
Node Group
Maintain Node Groups for load balancing.
Agent Status
View and update the communication status of

Agent platforms.
Troubleshooting
Perform various troubleshooting functions.
Quit
Exit to the shell prompt.
Maintenance
4-7
CONTROL-M Manager Menu

The CONTROL-M Manager menu is used to start and stop the SQL
Server and CONTROL-M/Server. Selecting CONTROL-M Main Menu
=> CONTROL-M Manager displays the following:
Figure 4-2
CONTROLM Manager Menu
CONTROL-M Manager Menu

---------------------Select one of the following options:
1 - Check All
2 - Start All
3 - Start Database
4 - Start CONTROL-M/Server
5 - Stop All
6 - Stop Database
7 - Stop CONTROL-M/Server
q - Quit
All references below to starting and stopping the SQL Server are
applicable only when CONTROL-M/Server uses a dedicated SQL
Server.
If CONTROL-M/Server uses a shared SQL Server to maintain the

CONTROL-M database, the database administrator is responsible for
starting and stopping the server.
The following options are available from this menu:
4-8
Table 4-3
ctm_menu CONTROL-M Manager Options
Option
Description
Check All
Determines whether or not both tasks required for

CONTROL-M (that is, the SQL Server and
CONTROL-M/Server) are currently running, and
reports the status of each task.
Start All
Starts any tasks required for CONTROL-M that are

not already running. The SQL Server is started first,
followed by CONTROL-M/Server.
Start Database
Starts the SQL Server (only if dedicated to the

CONTROL-M database).
Start CONTROL-M/
Server
Starts CONTROL-M/Server. The SQL Server must

be running in Service Mode when this option is
selected.
Stop All
Stops all CONTROL-M tasks. CONTROL-M/Server

is stopped first, followed by the SQL Server.
Stop Database
Stops the SQL Server (only if dedicated to the

CONTROL-M database). CONTROL-M/Server
should not be running when this option is selected.
Stop CONTROL-M/
Server
Stops CONTROL-M/Server.
Quit
Quits the CONTROL-M Manager menu and returns

to the CONTROL-M Main menu.
Maintenance
4-9
Database Creation Menu

The Database Creation menu is used to perform functions related to
creating, deleting, and verifying the integrity of the CONTROL-M
database. Selecting CONTROL-M Main Menu => Database Creation
displays the following:
Figure 4-3

---------------------Select one of the following options:
1 - Show Database Parameters
2 - Build Database
3 - Delete Database
4 - Erase Database Contents
5 - Check Database
q- Quit
The options of the Database Creation menu are described in Table 4-4.
Table 4-4
Database Creation Menu Options
Menu Item
Description
Show Database
Parameters
Displays the CONTROL-M database parameters.

Information similar to the following is displayed:
CONTROLM_USER=ctrlm
CONTROLM_DATABASE=ctrlm
Build Database
Builds a new CONTROL-M database. This option runs the

ctmmakedb utility (described in Building the
CONTROL-M Database on page 7-6). Shut down
CONTROL-M/Server before selecting this option.
Delete Database
Deletes CONTROL-M database files after verification.

After using this option, CONTROL-M cannot be started
until the Build Database option is used to build a new
database. Shut down the CONTROL-M/Server before
selecting this option.
4-10
Table 4-4
Database Creation Menu Options (continued)
Menu Item
Description
Erase Database
Contents
Erases the contents of the CONTROL-M database after

verification (for example, Scheduling tables, calendars,
CONTROL-M log, Active Jobs file). Database files are not
deleted. After using this option, you can still use
CONTROL-M, but no previous data exists. Shut down
CONTROL-M/Server before selecting this option.
Check Database
Displays the size of the CONTROL-M database and

availability of space, and verifies database integrity.
Information similar to the following is displayed:
db total = 29000.0 KB (data= 23500.00,

log= 5500.00)
data used = 1928 KB (8%).
Checking database...Database is OK.
This function is also available by running the script
c:\ctmsrv\ctm\exe\ctmdbcheck.
Script ctmdbcheck can also be used to provide automatic
database and transaction log monitoring. The following
options are available:
ctmdbcheck [db threshold %]

[log threshold %]
ctmdbcheck [general threshold %]
where db threshold % and log threshold % are userdefined percentages. If these percentages are exceeded,
shout messages are sent to ENTERPRISE/CS warning
that the CONTROL-M database or transaction log should
be extended (see Database Maintenance Menu on
page 4-17). The general threshold % option is used to
specify the same percentage for both (for example,
ctmdbcheck 50 will trigger a shout message if either the
database or transaction log becomes more than 50% full).
ctmdbcheck can be run as a cyclic job.
Quit
Quits the Database Creation menu and returns to the

CONTROL-M Main menu.
Maintenance
4-11
To build the CONTROL-M database:

Step 1
If option 2 is selected, the SQL Server Parameters window is displayed:
Step 2
Specify the SQL Server parameters.

These parameters are described in Chapter 5, Customization
Parameters. In most instances, a default value for each parameter is
provided.
The required parameters are described in Table 4-5.
Table 4-5
Required SQL Server Parameters
Parameter
Description
Server Host Name
Host name of the machine where the SQL Server

resides.
Query Port Number
Port number of the SQL Server.

Default: 0
This value cannot be changed.
SA Password
Password of the system administrator (SA) of the

database.
4-12
Table 4-5
Step 3
Required SQL Server Parameters (continued)
Parameter
Description
CONTROL-M DB Name
Name of the CONTROL-M database. This name

must be unique. Default: ctrlm
CONTROL-M DB
Owner
Name for the CONTROL-M database owner.

Default: ctrlm
CONTROL-M DBO
Password
Password for the CONTROL-M database owner (6

to 30 alphanumeric characters).
The first character must be a letter (A Z).
If the specified password is longer than 30
characters, only the first 30 are accepted.
Default: password
Click Next to continue. The Server Devices Parameters window is

displayed:
Maintenance
4-13
Step 4
Specify the CONTROL-M Database parameters.

These parameters are described in Chapter 5, Customization
Parameters. In most instances, a default value for each parameter is
provided.
Table 4-6
Required CONTROL-M Database Parameter
Parameter
Description
Data Device Logical

Name
Name of the device on which the CONTROL-M

database will be located. Default: ctrlm_ux
Data Device Path
Full path name where the CONTROL-M database

will be located. Default: <sql dir>\data\ctrlm_ux.
Data Device Size
Amount of space (in MB) to be allocated for the

data portion of the CONTROL-M database.
Default: 75
Log Device Logical

Name

database log will be located. Default: ctrlm_log.
Log Device Path
Full path name for the CONTROL-M database log.

Default: <sql dir>\data\ctrlm_log.
Log Device Size

CONTROL-M log database.
Default: 25
Enter the data device path and the log device path.
Change any parameter that differs from its default value.
Step 5
Click OK to build the database.

The installation procedure builds the CONTROL-M database.
4-14
The WCTMCONFIG window for configuring Communication and

Operational parameters is displayed:
Step 6
Specify the Communication and Operational parameters required by

CONTROL-M/Server. These parameters are described in Chapter 5,
The following parameters are required:
Local IP Host Interface Name

Agent-to-Server Port Number
Communication Protocol
Communication Timeout
Maximum Retries
Maximum Job State Changes
ENTERPRISE/CS TC/IP Port Number
CONTROL-M/Server TC/IP Port Number
Statistics Mode
Maintenance
4-15
Step 7
Click OK after specifying the parameters. The following window is

displayed:
Step 8
To complete the installation procedure, click Finish to reboot your

machine.
Note
Run utility dbversion in the DOS command prompt window for a

general description of the MSSQL database in use, including the current
version number.
4-16
Database Maintenance Menu

The Database Maintenance menu is used to perform functions related to
maintaining the CONTROL-M database. Selecting CONTROL-M Main
Menu => Database Maintenance displays the following:
Database Maintenance Menu
------------------------Select one of the following options:
1 - Backup Database
2 - Restore Database
3
4
5
6
List All Devices

List Backup Devices
Add Backup Device
Drop Backup Device
7 - Extend Database Size

8 - Extend Temporary Database Size
9 - Extend Database Log Size
q - Quit
The following options are available from this menu:
Backup Database
Backs up the CONTROL-M database onto a backup device. The
function performed by this option is identical to the function
performed by utility ctmdbbck. This option can be invoked while
the database is running.
Enter backup device name [tapedump2]:
The backup device must be a valid device defined in the database.

Use the option List Backup Devices (described below) to display a
list of valid devices.
Maintenance
4-17
For additional information, see the description of utility ctmdbbck

on page 2-23.
The Backup Database procedure should be performed periodically.
Daily backup is recommended.
Restore Database
Restores the CONTROL-M database from a backup device. The
function performed by this option is identical to the function
performed by utility ctmdbrst.
Enter restore device name [tapedump2]:
The backup device must be a valid device defined in the database.

Use the option List Backup Devices (described below) to display a
list of valid devices.
For more information, see utility ctmdbrst on page 2-28.
To restore the database if it is corrupted:
1. Shut down CONTROL-M. Make sure there are no other users or

processes connected to the SQL Server.
2. Use the option Database Creation => Build Database to
rebuild the database.
3. Use the Restore Database option to load the data into the new
database.
List All Devices

Displays a list of all of the database devices.
List Backup Devices

Displays a list of database backup devices. Use this option to locate a
device for backing up the CONTROL-M database (see option
Backup Database described above).
4-18
Add Backup Device

Adds a backup device to the list of devices available for backing up
the CONTROL-M database.
Enter <dev_logical_name> {disk|tape} <device_name> <[size_in_MB]>:
where:
Table 4-7
Backup Device Parameters
Parameter
Description
<dev_logical_name>
Logical name for the device
{disk|tape}
Disk or tape device
<device_name>
Path and name of the device
<size_in_MB>
Size of the device (optional)
This device can be either a disk file or a tape drive. (Backups to disk
files are faster and do not require operator intervention.)
Specify the desired parameters for the new device.
Example
cont tape cont_dev
In this instance the following messages are displayed:

Creating Tape device.
Tape device added.
(return status = 0)
Drop Backup Device

Deletes a device from the list of backup devices.
Enter <dev_logical_name>:
Maintenance
4-19
Specify the logical name of the device to delete from the list. Upon
completion of the process, the following message is displayed:
Device dropped (return status = 0)
Extend Database Size

Extends the size of the data segment of the CONTROL-M database
if the size of the database is too small. For more information, see
Extend Database Size on page 4-20.
Extend Temporary Database Size

Extends the size of the temporary area of the CONTROL-M
database. For more information, see Extend Temporary Database
Size on page 4-22.
Extend Database Log Size

Extends the size of the log segment of the CONTROL-M database.
See Extending the Size of the CONTROL-M Database below.
Quit
Quits the Database Maintenance menu and returns to the
Note
For parameter changes to take effect, you must shut down and restart
CONTROL-M/Server.
Extend Database Size

This option extends the size of the data segment only. The size of the log
segment is not extended.
To extend the size of the data segment of the CONTROL-M database:
Step 1
Select the option Extend Database Size from the Database Maintenance
menu. The following prompt is displayed:
Enter device logical name for ctrlm extension: [ctrlm_extend]:

4-20
The device logical name must not exist. The local file system where the
device will be located must have enough free space to accommodate the
size specified below.
Step 2
Specify the logical name of the device and press <Enter>, or just press
<Enter> to accept the default value. The following prompt is displayed:
Enter physical (path) device name for ctrlm extension: []:
The path is [drive:\<MSSQL Server dir>\data\ <logical_device_name>]

on the platform where MSSQL Server is installed, excluding the machine
name.
Step 3
Specify the physical path and device name and press <Enter> . The
Enter size of <logical_name_of_device> extension in MB:[10]:

Step 4
Specify the amount to extend the database, or press <Enter> to accept

the default. Upon completion of the process, the following message is
displayed:
Extending database ctrlm ended successfully
Press Enter to continue.
Maintenance
4-21
Extend Temporary Database Size
The size of the temporary storage area of the database should be

approximately 10% of the data segment size.
To extend the size of the temporary area of the CONTROL-M/Server
database:
Step 1
Select the option Extend Temporary Database Size from the Database
Maintenance menu. The following prompt is displayed:
Enter device logical name for tempdb extension: [tempdb_extend]:
Step 2
Enter physical (path) device name for tempdb extension: []:

name.
Step 3

Step 4
Specify the amount to extend the temporary database, or press <Enter>

to accept the default. Upon completion of the process, the following
Extending database tempdb ended successfully
4-22
Extend Database Log Size
The size of the log segment of the database should be approximately 1/3
of the data segment size.
To extend the size of the log segment of the CONTROL-M database:
Step 1
Select the option Extend Database Log Size from the Database
Maintenance menu. The following prompt is displayed:
Enter device logical name for ctrlm extension: [ctrlm_extend]:
Step 2
Enter physical (path) device name for ctrlm extension: []:

name.
Step 3

Step 4
Specify the amount to extend the database, or press <Enter> to accept

the default. Upon completion of the process, the following message is
displayed:
Extending database ctrlm ended successfully
Maintenance
4-23
Parameter Customization Menu

The Parameter Customization menu is used to view and maintain the
various groups of parameters used by CONTROL-M. Selecting
CONTROL-M Main Menu => Parameter Customization displays the
following:
Figure 4-4

----------------------------Select one of the following options:
1 - Communication and Operational Parameters
2 - System Parameters and Shout Destination Tables
3 - Default Parameters for Communicating with Agent
Platforms
4 - Parameters for Communicating with Specific Agent
Platforms
q - Quit
All the parameters that appear in these menus are described in Chapter 5,
The options in the Customization Menu are described in Table 4-8.
4-24
Table 4-8
Parameter
Description
Communication and
Operational Parameters
Displays/updates CONTROL-M operational and

communication parameters. Use of this option is
described below.
System Parameters and

Calls CONTROL-M utility ctmsys to view or

update system parameters and Shout Destination
tables. This utility is described in Chapter 2,
Utilities.
Default Parameters for

Communicating With
Agent Platforms
Displays/updates the default values of parameters

used for communication with Agent platforms.
When communicating with an Agent platform,
these values are used unless overridden using the
option that follows. This option is described below.
Parameters for
Communicating With
Specific Agent Platforms
Displays/updates the parameters for

communicating with a specific Agent platform. This
option is used to assign values other than the
default parameter values for a specific Agent
platform. This option is described below.
Quit
Quits the Parameter Customization menu and

returns to the CONTROL-M Main menu.
Note
For parameter changes to take effect, you must shut down and restart
CONTROL-M/Server.
Maintenance
4-25
Communication and Operational Parameters
When this option is selected, the Communication and Operational

Parameters window is displayed. The current value for each parameter
follows the parameter name.
Figure 4-5
Communication and Operational Parameters
Modify the parameters as needed. For a description of each parameter,

see Chapter 5, Customization Parameters. To ensure that changes take
effect, restart CONTROL-M. Use shut-ctm and start-ctm to restart
CONTROL-M.
If the Communication Protocol parameter defined on an Agent platform
is different from the modified one, after shutting down and restarting
CONTROL-M/Server, you must also redefine this parameter on the
Agent platform according to its requirements. See the appropriate chapter
for the platform in the CONTROL-M/Agent Administrator Guide.
4-26
Default Parameters for Communicating With Agent Platforms
When this option is selected, the following menu is displayed. The

current value for each parameter follows the parameter name:
Figure 4-6
Default Parameters for Communicating with Agent Platform
Default Parameters for Communicating With Agent

Platform:
1)
2)
3)
4)
5)
Polling Interval:
Communication Timeout:
Maximum Retries:
Retry Interval:
Server-to-Agent Port Number:
a)
s)
q)
Modify all of the above

Save
Quit
(All time parameters expressed in seconds)

Enter command or item number you wish to change [q]:
To modify parameters, specify the number appearing next to the

parameter that you want to change, or specify a to change all the
parameters in the menu. You are prompted for the parameter value(s)
as required.
For a description of each parameter, see Chapter 5, Customization
Parameters.
To save the changes, specify s.
To exit, specify q.
Maintenance
4-27
Parameters for Communicating With a Specific Agent Platform
When this option is selected, the following prompt is displayed:

To view/modify communication parameters,
Enter node ID of Agent Platform:
Step 1
Specify the node ID of the desired Agent platform.

Note
This option does not require communication with Agent platforms and
this option does not verify that the specified Agent platform exists.
The following menu is displayed. The current value for each parameter
follows the parameter name:
Figure 4-7
Parameters for Communication With Specific Agent Platform
Parameters for Communicating With Specific Agent Platform (<node ID>):

1)
2)
3)
4)
Maximum Retries:
Retry Interval:
a)
s)
q)

Save
Quit

Enter command or item number you wish to change [q]:
Step 2
To modify parameters, specify the number appearing next to the

parameter that you want to change, or specify a to change all the
parameters in the menu. You are prompted for the parameter value(s) as
required.
For a description of each parameter, see Chapter 5, Customization
Parameters.
Step 3
To save the changes, specify s.
Step 4
To exit, specify q.
4-28
Node Group Menu

The Node Group menu is used to maintain and view node groups. Node
groups are used by the CONTROL-M load-balancing function. Selecting
CONTROL-M Main Menu => Node Group displays the following:
Figure 4-8
Node Group Menu
Node Group Menu

--------------Select one of the following options:
1 - List All Node Groups
2 - Edit Node Group
3 - Delete Node Group
q - Quit
The options available in the Node Group menu are listed in Table 4-9.
Maintenance
4-29
Table 4-9
Node Group Menu Options
Option
Description
List All Node Groups
Displays a list of all existing node groups.
Edit Node Group
Used to view, create or modify a node group. The

Node Group Name:
Specify the name for a new node group or
specify the name of an existing node group
whose member list you want to view or modify.
Edit Node Group Menu
-------------------Select one of the following options:
1 - View Current Node Group
2 - Add Node ID
3 - Delete Node ID
q - Quit
Enter Option (Group: <node_group>):
Specify the number for the desired option:
View Current Node Group Displays the node
IDs included in the specified node group.
Add Node ID Prompts you for the name of a
node ID to add to the specified group.
Delete Node ID Prompts you for the name of a
node ID to delete from the specified group.
Delete Node Group
Requests the name of an existing node group,

and then deletes the group.
Quit
Quits the Node Group menu and returns to the

4-30
Agent Status Menu

The Agent Status menu is used to view and update the communication
status of Agent platforms. Selecting CONTROL-M Main Menu =>
Agent Status displays the following:
Figure 4-9
Agent Status Menu
Agent Status Menu

----------------Select one of the following options:
1 - List Last Known Status of a Specific Agent
Platform
2 - List All Agent Platforms Not Available
3 - Change Agent Platform Status to Available
4 - Change Agent Platform Status to Disabled
5 - Delete Agent Platform Status Entry
6 - Ping Agent Platform
Q - Quit
For more information about status of Agent platforms, see

Communication Status of Agent Platforms on page 1-6.
The options available in the Agent Status menu are listed in Table 4-10.
Maintenance
4-31
Table 4-10
Agent Status Menu Options
Option
Description
List Last Known Status of a

Specific Agent Platform
Prompts for the node ID of an Agent platform,

and then displays the last known status of the
platform (Available, Unavailable or
Disabled).
List All Agent Platforms Not

Available
Displays a list of all Agent platforms whose

communication status is not Available.
Change Agent Platform

Status to Available

and then changes the communication status
of the platform to Available.
Change Agent Platform

Status to Disabled

and then changes the communication status
of the platform to Disabled.
Delete Agent Platform Status

Entry
Displays a list of all Agent platforms whose

communication status is Disabled, and
prompts for the node ID of the platform you
want to delete.
Ping Agent Platform
Prompts for the node ID of an Agent platform

and then tests the communication link with the
platform. The response indicates whether the
Agent platform is available or unavailable.
This option cannot be used to test
communication with an Agent platform whose
status is Disabled.
Quit
Quits the Agent Status menu and returns to

the CONTROL-M Main menu.
Note
These options do not require communication with Agent platforms and

these options do not verify that the specified Agent platforms exist. As a
result, the following situations can occur:
Change options can be used to modify the status of a non-existent
platform.
If you request the status of a non-existent platform, the default status
of Available is displayed. If the status of the platform has been
changed to Disabled, the platform will appear in the list of platforms
that are Not Available.
4-32
Troubleshooting Menu
The Troubleshooting menu is used to perform a variety of diagnostic and
maintenance functions. Selecting CONTROL-M Main Menu =>
Troubleshooting displays the following:
Figure 4-10 Troubleshooting Menu
Troubleshooting Menu
-------------------Select one of the following options:
1 - Set Diagnostic Level
2 - Set Sleep Time
3
4
5
6
Show
Show
Show
Show
Process Flags (prf)

All Processes (shctm)
Active Jobs File
Communication Environment
7 - Truncate Database Log

8 - Restart New Day Procedure
9 - Reset CONTROL-M Active Environment
10
11
12
13
14
Erase Proclog Files

Show Scheduling Table
Interactive SQL Commands
Communication Diagnostic Report
Force Download
q - Quit
The following options are available in this menu:
Maintenance
4-33
Table 4-11
Troubleshooting Menu Options
Option
Description
Set Diagnostic Level
Determines the diagnostic level for all CONTROL-M/Server processes or for

a specific process. If modified while CONTROL-M/Server is running, the
diagnostic level specified is effective immediately. The following prompt is
displayed:
Enter <process-name> [CD,CO,CS,LG,NS,SL,SU,TR,ALL]

and <diagnostics-level> [0-4]:
For a description of the process codes appearing in the prompt, see
CONTROL-M/Server Processes on page 4-37. Specify the 2character code for a specific process or ALL for all CONTROL-M/Server
processes, followed by the desired diagnostic level.
Example 1
ALL 1
The diagnostic level ranges from 0 (no diagnostics) to 4 (highest level of
diagnostics). If you specify a non-numerical value for the diagnostic level,
the diagnostic level is set to 0.
Output from each process is written to a separate process log file named:
c:\ctmsrv\ctm\proclog\<process-name>_LOG.<processID>
where:
<process-name> Two-character code identifying the process.

<process-ID> ID of the CONTROL-M/Server process.
Example 2
Example of the name and path of a log file where the process is SU and the
process ID is 5609.
c:\ctmsrv\ctm\proclog\SU_LOG.5609
4-34
Option
Description
Set Sleep Time
Determines the sleep time for all CONTROL-M/Server processes or for

a specific process. Sleep time is the length of time that the process lies
dormant before waking up to determine if any request to perform an
action was received. If modified while CONTROL-M/Server is running,
the sleep time specified becomes effective immediately. See Sleep
Time Considerations on page 4-42. The following prompt is
displayed:
Enter <process-name> [CD,CO,LG,NS,SL,SU,TR,ALL]

and <seconds-sleep-time>:
For a description of the process codes appearing in the prompt, see
CONTROL-M/Server Processes on page 4-37. Specify the 2character code for a specific process or ALL for all CONTROL-M/
Server processes, followed by the desired sleep time (in seconds).
Example
Example showing the sleep time set to 130 seconds.
SL 130
Show Process Flags (prf)
Displays the status of CONTROL-M/Server processes (described later

in this chapter).
Show All Processes

(shctm)
Displays all CONTROL-M/Server processes currently running. For more

information, see Show All Processes (shctm) on page 4-39.
Show Active Jobs File
Displays the list of jobs currently contained in the Active Jobs file. For
more information, see Show Active Jobs File on page 4-39.
Show Communication
Environment
Displays the port numbers used by CONTROL-M/Server to

communicate with ENTERPRISE/CS. Information similar to the
following is displayed:
ENTERPRISE/CS AND CONTROL-M PORT NUMBERS

ENTERPRISE/CS <-> CONTROL-M communication-port:
---------------------------------INPUT_SPN=2371
OUTPUT_SPN=2370
[ SPN - Socket Port Number ]
Truncate Database Log
Truncates the CONTROL-M database log. This option should be used if

the database message Cant allocate space for <text>
in database <name> because the log segment is

full occurs in one of the log files located in directory
c:\ctmsrv\ctm\proclog\
Restart New Day
Procedure
Starts the New Day procedure again (after confirmation).
Maintenance
4-35
Option
Description
Reset CONTROL-M
Active Environment
Clears all components of the CONTROL-M active environment (Active

Jobs file, prerequisite conditions, etc.) and forces CONTROL-M/Server
to start a download of the entire Active Jobs file to ENTERPRISE/CS.
This option is described on page 4-41.
Erase Proclog Files
Erases the contents of the current process log file for all active
CONTROL-M/Server processes or for any specific active process.
Enter <process-name> [CD,CO,LG,NS,SL,SU,TR,ALL]

Specify the two-character code for a specific
process or ALL for all
current process log files.
See Set Diagnostic Level above for more information regarding
process log files.
Show Scheduling Table
Displays a list of all Scheduling tables defined in the CONTROL-M

database. Each Scheduling table is listed together with the User Daily to
which it is assigned (or SYSTEM if it is assigned to the New Day
procedure).
Interactive SQL
Commands
Starts an interactive SQL Server session that enables you to issue SQL
Server commands to perform actions in the CONTROL-M database.
To end this session, enter the command: quit.
This option should only be used when requested by Technical Support.
Communication Diagnostic
Report
Checks parameters and environmental conditions relevant to

communication between the Server platform and a specific Agent
platform. This option is typically used at the request of Technical
Support to determine the cause of a communication problem.
When this option is selected, you are prompted to supply the node ID of
an Agent platform. A diagnostic program is then executed and a report
listing the findings is generated.
Force Download
Forces CONTROL-M/Server to start download of the entire Active Jobs

file to ENTERPRISE/CS.
Quit
Quits the Troubleshooting menu and returns to the CONTROL-M Main

menu.
4-36
CONTROL-M/Server Processes
When implemented under the Windows NT operating system,
CONTROL-M/Server consists of several integrated processes. Most of
the processes run whenever CONTROL-M/Server is active. Each process
is identified by a two-letter code:
Table 4-12
Two-Letter Codes for CONTROL-M Processes
Code
Description
SU
Supervisor (SRV internal process).
TR
Tracker.
SL
Selector and submittor.
NS
Communication with Agent platforms.
CO
Communication gateway.
CD
New Day procedure, downloads, updates to the CONTROL-M

database.
CS
Communication (user requests from ENTERPRISE/CS).
LG
Utilities invoked from Agent platforms.
The following options are available from the Troubleshooting menu to

view the status of CONTROL-M/Server processes:

Show All Processes (shctm)
These options are described below.

When selected, the Show Process Flags option displays the status of
CONTROL-M/Server processes as recorded in the CONTROL-M
database.
A table similar to the following is displayed:
Maintenance
4-37
Figure 4-11 CONTROL-M/Server Processes Table
PROCNAME
CD
CO
LG
NS
SL
SU
TR
PROCID
21176
21199
21178
21180
21182
21167
21184
PROCSTAT
T
R
R
R
R
R
R
PSTAT_REQ
T
R
R
R
R
T
R
SLEEP_TIME
60
60
360
120
60
60
30
DIAG_LVL
0
0
0
0
0
0
0
The columns displayed in the report are described in Table 4-13.

Table 4-13
Columns of the Show Process Flags Table
Column
Description
PROCNAME
Two-letter code identifying the CONTROL-M/Server

process, see Table 4-12, Two-Letter Codes for
CONTROL-M Processes, on page 4-37.
PROCID
Process ID of the CONTROL-M/Server process. If this

entry is missing, the process is not currently running.
PROCSTAT and
PSTAT_REQ
Current statuses of the process. The codes that can

appear in these columns have the meanings listed in
Table 4-14.
SLEEP_TIME
Current sleep time of the process.
DIAG_LVL
Current diagnostic level of the process.
Table 4-14
Status of Processes
PROCSTAT
PSTAT_REQ
R-
R-
Running
Run requested
T,Z - Terminated
T,Z - Terminate requested
S-
S-
Suspended
Suspend requested
4-38
Show All Processes (shctm)

When selected, the Show All Processes option displays all
CONTROL-M/Server processes currently running on the Server
platform. A list similar to the following is displayed:
Figure 4-12 Process Listing
5703
5620
5691
5691
5705
5609
5712
5713
0:02
0:00
0:00
0:00
0:00
0:01
0:01
0:01
ctmsco
ctmsns
ctmstr
ctmslg
ctmssl
ctmsrv
ctmscd
ctmscs
The columns displayed in this list are:
Process ID (for example, 5703)

Run time (for example, 0:02)
Process name (for example, the first line in the list above represents
the CO process the Communication module).
Show Active Jobs File

When selected from the Troubleshooting menu, the Show Active Jobs
File option displays the jobs currently contained in the Active Jobs file.
A table similar to the following is displayed:
Figure 4-13 Active Jobs Listing
ORDERID.
-------00000198
00000199
00000200
00000201
00000202
JOBNAME....... ODATE.... STATE.....STATUS.. FROMTIME. UNTIL

------------- -------- --------. -------- -------- ------regres1...... 20000430 Submitted OK
regres2...... 20000430 Analyzed. OK
regres3...... 20000430 Post Pro. OK
progrm1...... 20000430 Post Pro. OK
copy_job.... 20000430 Executing.
Maintenance
4-39
The columns displayed in the table are:
ORDERID
Order number of the job (assigned by CONTROL-M).
JOBNAME
Mem Name parameter from the Job Processing definition.
ODATE
Odate of the job in yyyymmdd format.
STATE
State of the job.
STATUS
Status (OK, NOTOK, blank) of the job.
FROMTIME
Time job began execution.
UNTIL
Time job ended execution.
4-40
Reset CONTROL-M Active Environment

Note
Shut down CONTROL-M/Server before selecting this option.

When selected from the Troubleshooting menu, the Reset
CONTROL-M => Active Environment option performs the following
actions (after confirmation by the user):
1. The contents of the Active Jobs file are erased.
2. All prerequisite conditions, Quantitative resources, and Control
resources are deleted.
3. The entire Active Jobs file is downloaded to ENTERPRISE/CS.
It is also possible to reset the CONTROL-M/Server process sleep times
and diagnostic level using utility init_prflag. This utility performs the
following actions:
4. Sleep times for all CONTROL-M/Server processes are reset to their
initial (installation) values. Sleep times are listed in Table 4-15.
Table 4-15
CONTROL-M/Server Process Sleep Times
Process
Sleep Time
SU
60
TR
30
SL
60
NS
120
CO
60
CD
60
LG
360
5. The diagnostic level for all CONTROL-M/Server processes is reset

to zero.
Maintenance
4-41
Sleep Time Considerations

Sleep time is the length of time that a process lies dormant before waking
up to determine if any request to perform an action was received. For
some processes, it is important to consider the number of jobs that are
processing, the job schedule plan, and the overall load on the machine
when modifying CONTROL-M process sleep time settings. Proper sleep
time settings for CONTROL-M processes can optimize the functionality
of CONTROL-M and enhance the performance of your data center.
Table 4-16
Sleep Time Modification Considerations
Process
Task
Sleep Time
Initial Settings
Sleep Time Modification

Considerations
SU
Supervisor
60
Increase: Delay in startup, downloads, and

New Day procedure.
TR
Job Tracking
15
Increase: Delay in freeing resources after

job ends and delay in Shout messages.
Can be increased during period of minimal
job processing.
Decrease: Additional CPU resources.
SL
Job Selector
30/60
Increase: Delay in job submission and

Shout messages for late submission Can
be increased during period of minimal job
processing.
Decrease: Additional CPU resources.
NS
Communication
120
No effect.
CO
Communication
60
No effect.
CD
New Day Procedure;

Database uploads
and downloads
60
No effect.
LG
Utilities
360
No effect.
4-42
Overview
The CONTROL-M/Server installation is customized by modifying
parameters used by the various modules of CONTROL-M/Server. Most
of the parameters described in this chapter can be assigned values by the
user during the installation procedure for CONTROL-M/Server. Certain
parameters are assigned default values during installation and can be
modified later.
CONTROL-M/Server parameters are divided into the following
categories (described in this chapter):
System parameters.
Communication parameters.
Operational parameters.
Agent Communication parameters.
Database parameters.
Performance parameters.
CONTROL-M/Agent customization parameters are described in

Chapter 1, General Information, in the CONTROL-M/Agent
Administrator Guide.
5-1
Parameter Coordination
For CONTROL-M/Server to communicate with Agent platforms and
with the ENTERPRISE/CS workstation, the values assigned to certain
parameters described in this chapter must be coordinated with values
assigned to parameters on these systems. These parameters are listed in
Table 5-1 and Table 5-2.
Table 5-1
Parameter Coordination With ENTERPRISE/CS
CONTROL-M/Server
Parameter
ENTERPRISE/CS Parameter
Default
Value
ENTERPRISE/CS TCP/IP
Port Number
TCP/IP Port Number
2370
TCP/IP Host Name
Table 5-2
Parameter Coordination With Agent Platforms
CONTROL-M/Server
Parameter
ENTERPRISE/CS Parameter
Default
Value
TCP
7005
Server-to-Agent Port Number
7006
Authorized CONTROL-M/Servers
5-2
Parameter Descriptions
System Parameters
CONTROL-M system parameters are assigned default values during
installation. These parameters can be modified using utility ctmsys,
described in Chapter 2, Utilities.
Table 5-3 describes CONTROL-M system parameters. Modifiable
parameters are identified by an asterisk (). All other parameters are
display-only.
Table 5-3
Parameter Descriptions (Part 1 of 4)
Parameter
Description
Computer System
Platform type and model on which CONTROL-M/

Server is installed (for example, Intel).
Operating System
Operating system running on the Server platform

(for example, Windows NT).
CONTROL-M Version
Version number of the CONTROL-M/Server product.
Sysout Log Directory
Location where CONTROL-M places the Job log

files (Sysout files) after the jobs execution and the
Sysout has been viewed (for example,
c:\ctmsrv\ctm\sysout).
This directory is created during the installation
procedure. If you choose to change this location,
make sure that you first create the new directory
(using the mkdir command). This parameter cannot
be modified while CONTROL-M is active.
Executable Path
Location where CONTROL-M/Server expects to find

all its executable programs (for example,
c:\ctmsrv\ctm\exe).
5-3
Table 5-3
Parameter
Description
Day Time
Installation start-of-day time used by CONTROL-M.

This is the time at which the CONTROL-M date
(Odate) changes and the New Day procedure is run.
Default: +0700
The Day Time parameter is specified using one of
the following formats:
+hhmm CONTROL-M date is changed at the
specified time after midnight.
-hhmm CONTROL-M date is changed at the
specified time before midnight.
The time is expressed in 24-hour format (for
example, 2200 is equivalent to 10 p.m.). This
parameter is commonly set using the +hhmm
format.
Example
+0600 Specifies that the hours between midnight
and 6:00 a.m. are considered part of the previous
dates work day (that is, system date February 10th,
5:59 a.m. is still the CONTROL-M work day
February 9th).
-2200 Specifies that the hours between 10 p.m. and
midnight are considered part of the next dates work
day (that is, at 10:00 p.m. on system date
February 10th, the CONTROL-M date changes to
February 11th).
CONTROL-M Date
Date that CONTROL-M/Server regards as the actual

working date (Odate). This date is determined using
the operating system date and the value of the
parameter Day Time (described above). The format
is yyyymmdd (for example, 20000215). The value is
initially set to 00000000 by the installation
procedure. The value is then updated by the New
Day procedure each time it runs.
Statistics
Whether or not job statistics should be written to the

CONTROL-M database. Valid values are Y (record
job statistics) and N (do not record job statistics).
For more information, see Runtime Statistics on
page 1-28. Default: Y
5-4
Table 5-3
Parameter
Description
Maximum Retries
Number of times the CONTROL-M auto-recovery

mechanism can reactivate CONTROL-M/Server
processes in case of any failure. If this number is
exceeded, CONTROL-M/Server is shut down.
Default: 10
Start Day of the Week
Day of the week on which the work week at your site

starts. Valid values are: 0 (Saturday), 1 (Sunday),
...6 (Friday). The setting of this parameter affects the
usage of the Job Processing parameter Weekdays
(described in the Enterprise Controlstation User
Guide, Chapter 5). Default: 2 (Monday)
Active Shout Table
Currently-active Shout Destination table.

Default: SYSTEM
Full Security
Whether CONTROL-M operates in a restricted or

unrestricted level of security. Valid values are Y
(restricted) and N (unrestricted). Default: N.
For restricted security (value Y), a user not defined
in the CONTROL-M security database does not
have any application authorizations.
For unrestricted security (value N), a user not
defined in the CONTROL-M security database is
regarded as having all application authorizations.
In either level, a user for whom one or more
authorizations have been assigned in the security
database can only perform the actions for which he/
she is specifically authorized.
Maximum Days
Retained by
CONTROL-M Log
Maximum number of days that entries are retained

in the CONTROL-M log before being deleted by the
New Day cleanup procedure. Default: 2
5-5
Table 5-3
Parameter
Description
Maximum Days to
Retain Sysout Files
Number of days that job sysout files are retained for

jobs executed by Agent platforms. After this period,
all job sysout files are deleted by the New Day
procedure. Default: 2
Ignore New Day

Conditions
Specifies whether the New Day procedure should

ignore prerequisite conditions whose reference date
(day and month) matches the new CONTROL-M
date.
When this parameter is N, the New Day procedure
deletes any prerequisite condition whose reference
date matches the CONTROL-M date. Default.
When this parameter is Y, the New Day procedure
accesses a file containing prefixes of prerequisite
conditions that should be ignored (that is, not
deleted) by the daily cleanup procedure. (See the
description of this parameter below.)
Ignore New Day Conditions Parameter
After assigning the new CONTROL-M date, the New Day procedure
performs a selective cleanup of prerequisite conditions. By default, any
prerequisite condition whose reference date (month and day) is equal to
the new CONTROL-M date is deleted. This is done to prevent jobs from
being triggered by any prerequisite conditions remaining from the
previous year.
This cleanup function of the New Day procedure may conflict with user
intentions under certain circumstances. For example, if a Job Processing
definition contains the parameter Out Conditions with the Date field
containing the value Next, a prerequisite condition is created with a
reference date one or more days in the future. This prerequisite condition
would normally be deleted by the New Day procedure before it can be
used to trigger the submission of a job.
You have the option of selectively or completely disabling the cleanup of
such prerequisite conditions by using the CONTROL-M system
parameter Ignore New Day Conditions.
5-6
The Ignore New Day Conditions parameter specifies whether the New
Day procedure should delete all prerequisite conditions whose reference
date (day and month) matches the new CONTROL-M date.
When this parameter is N, the New Day procedure deletes any

prerequisite condition whose reference date matches the
CONTROL-M date. This is the default.
When this parameter is Y, the New Day procedure accesses a userdefined file that contains prefixes of prerequisite conditions that
should be ignored (that is, not deleted) by the cleanup procedure.
The Ignore New Day Conditions parameter can be modified using

utility ctmsys.
When this parameter is set to Y, CONTROL-M searches for a file called:
c:\<ctm_server_dir>\ctm\data\dbs_ignrcond.dat
where <ctm_server_dir> is the directory of the CONTROL-M/Server.

This file (called the Ignore Conditions file) should contain a list of
prefixes (with or without masks) of prerequisite conditions that should
not be deleted by the New Day procedure. Prerequisite condition names
are case-sensitive.
The mask characters that can be used in this file are:
*
Indicates any number of characters (including no characters).

Specify by itself to signify all existing conditions (see
examples below).
Indicates any single character.
You can create and maintain this file using any text editor available at
your site. PLace one prerequisite condition prefix on each line in the file.
5-7
Note
If parameter Ignore New Day Conditions is set to Y but CONTROL-M

cannot locate the Ignore Conditions file, CONTROL-M behaves as if the
parameter is set to N (that is, all prerequisite conditions whose reference
date matches the new CONTROL-M date are deleted).
Example 1
The new CONTROL-M date is 15-01-00. Parameter Ignore New Day

Conditions is set to Y. The Ignore Conditions file contains the following
prefixes:
prq_rs_*rpt
pre_prn
srt_def_?
Table 5-4 indicates which prerequisite conditions are deleted from the
Conditions/Resources table in the CONTROL-M database by the New
Day procedure.
Table 5-4
Prerequisite Conditions Deleted by the New Day Procedure
Conditions Existing Before the

New Day Procedure Is
Executed
Conditions Remaining After the

New Day Procedure Is
Executed
bra_fn_01 14/01
bra_fn_01 15/01
prq_rs_21rpts 14/01
prq_rs_21rpts 15/01
pre_prn_01 14/01
pre_prn 15/01
pre_prn_02 14/01
srt_def_a 14/01
srt_def_a1 14/01
srt_def_a 15/01
srt_def_a1 15/01
bra_fn_01 14/01
prq_rs_21rpts 14/01
prq_rs_21rpts 15/01
pre_prn_01 14/01
pre_prn 15/01
pre_prn_02 14/01
srt_def_a 14/01
srt_def_a1 14/01
srt_def_a 15/01
5-8
Example 2
Parameter Ignore New Day Conditions is set to Y. The Ignore

Conditions file contains the following entry:
*
No prerequisite conditions will be deleted from the Conditions/Resources

table by the New Day procedure.
Communication Parameters
Communication parameters are modifiable during installation. You can
also modify these parameters afterwards using the Parameter
Customization Menu on page 4-24. After modifying these parameters,
restart the CONTROL-M/Server.
The communication parameters are described in Table 5-5.
Table 5-5
Parameter
Description
Local IP Host
Interface Name
Host interface name of the TCP/IP network interface card on the Server
platform to use for communication with ENTERPRISE/CS. This is
typically the host name of the Server platform. The default value for this
parameter is the default host interface name defined in the Server
platform operating environment. This parameter can also be specified by
its IP address (for example, 192.123.186.20). This parameter should be
modified only if the Server platform contains more than one network
interface card (for example, Ethernet and Token-Ring). For more
information, see Local IP Host Interface Name Parameter below.
5-9
Table 5-5
Parameter
Description
Agent-to-Server Port
Number
This parameter specifies the port used in the Server platform for
receiving a connection request from the Agent platform. The value for
this parameter must match the value assigned to the parameter Agentto-Server Port Number on the Agent platform.
Verify that the port number specified for this parameter is not used for
any other purpose in the Server platform. The value for this parameter
must be a number between 1024 and 65533 inclusive. Default: 7005
The Server-to-Agent Port Number is described in Parameters for
Communicating With Agent Platforms on page 5-13.
Communication
Protocol
Protocol used to communicate with the Agent platforms. Specify UDP or

TCP. It is recommended that you use TCP when there are many jobs
running simultaneously reporting to the CONTROL M Server.
The protocol specified here must be the same as that specified on the
Agent platform. Default: TCP
Local IP Host Interface Name Parameter
CONTROL-M/Server only listens on one network interface card for

messages from ENTERPRISE/CS. If the Server platform contains more
than one network interface card, it is necessary to ensure that
ENTERPRISE/CS is sending messages to the same interface card
listened to by CONTROL-M/Server. This is accomplished by ensuring
that CONTROL-M/Server parameter Local IP Host Interface Name
and ENTERPRISE/CS parameter TCP/IP Host Name both refer to the
same IP address.
If one or both of these parameters contain a logical host name, you can
determine the IP address mapped to the logical host name by specifying
the following command.
ipconfig
The system responds with the IP address mapped to the host name on the
local machine.
5-10
Note
Even if the same logical host name is specified for the above two
parameters, the host name can be mapped to different IP address on the
Server platform and the ENTERPRISE/CS workstation. Use the above
command to verify that the host name on each machine is mapped to the
same IP address.
You can also ensure that both machines are using the same address by
specifying the actual IP address of the network interface card for each of
the above parameters. The IP address specified must be a local address
on the Server platform.
5-11
Operational parameters are modifiable during installation. You can also
modify these parameters afterwards using the Parameter Customization
Menu on page 4-24. After modifying these parameters, restart
CONTROL-M/Server.
The operational parameters are described in Table 5-6.
Table 5-6
Parameter
Description
CONTROL-M
TCP/IP Port Number
Message queue key (decimal value) used internally by CONTROL-M/

Server. The key value must not be used for any other process on the
Server platform. You can use the Windows NT command netstat -a to view
keys currently used on the Server platform. Default: 9000.
Maximum Job State

Changes
Number of job state changes retained by CONTROL-M/Server if

communication with ENTERPRISE/CS is interrupted. If the number of job
state changes that occur exceeds the value specified for this parameter,
CONTROL-M/Server will initiate a download when communication with
ENTERPRISE/CS is resumed. Default: 1000
ENTERPRISE/CS
TCP/IP Port Number
CONTROL-M communicates with Enterprise Controlstation using a pair of

consecutive TCP/IP ports (for example, 2370 and 2371). The lower port is
used for data flowing from CONTROL-M to ENTERPRISE/CS. The higher
port is used for data flowing in the reverse direction. Default: 2370
This parameter is used to specify the lower of the two port numbers and
must correspond to the value assigned to the TCP/IP Port Number field in
the definition of the CONTROL-M data center in the ENTERPRISE/CS
Data Centers window.
Verify that the two port numbers are not used for any other purpose on the
Server platform.
The value for this parameter must be a number between 1024 and 65533
inclusive.
Statistics Mode
Mode used by utility ctmjsa to collect summary statistics. JOBNAME

compiles statistics for each CONTROL-M Job Name and Node ID where
the job was submitted. MEMNAME compiles them for each CONTROL-M
Mem Name/Mem Lib and Node ID. Default: MEMNAME
Minimum Server
Processes
Minimum number of communication server processes that the

CONTROL-M/Server gateway process will run concurrently. Default: 1
Maximum Server
Processes
Maximum number of communication server processes that the

CONTROL-M/Server gateway process will run concurrently. Default: 1
5-12
Parameters for Communicating With Agent Platforms

Parameters for communicating with Agent platforms are modifiable
during installation. The values specified for these parameters are used as
the default values for communication with each Agent platform.
Parameter values for specific Agent platforms can be modified separately
afterwards. You can also modify these parameters using the Parameter
Customization Menu, described in Parameter Customization Menu on
page 4-24.
The parameters for communicating with agent platforms is described in
Table 5-7.
Table 5-7
Parameter
Description
Polling Interval
Time interval (in seconds) between requests from CONTROL-M/

Server for status updates from Agent platforms that are executing
jobs. Specify -1 to disable polling. Default: 900
Maximum length of time (in seconds) that CONTROL-M/Server

should spend attempting to communicate with an Agent platform
before assigning it the status Unavailable. Default: 120.
During this time, CONTROL-M/Server attempts to communicate
with the Agent platform x times, where x is the value specified by
parameter Maximum Retries.
Example
If the value of Communication Timeout is 120 and Maximum
Retries is 12. CONTROL-M/Server attempts to communicate with
the Agent platform once every 10 seconds (120/12) during the
timeout period.
Maximum Retries
Number of communication retries to attempt in the period of time

specified before assigning the status Unavailable to an Agent
platform. Default: 12
Retry Interval
Length of time to wait (in seconds) between attempts to

communicate with an Agent platform whose status is Unavailable.
Default: 90
Port number in the Agent platform through which data is received

from the Server platform. The value assigned to this parameter
must correspond to the value assigned to the field Server-toAgent Port Number in the Configuration file on the corresponding
Agent platform. Default: 7006
5-13
Database Parameters
Database configuration parameters are specified during installation
before the CONTROL-M database is created. You can also modify these
parameters and rebuild the CONTROL-M database using Database
Creation Menu on page 4-10.
The database parameters are described in Table 5-8.
Table 5-8
Database Parameters
Parameter
Description
Server Host Name
Host name of the machine where the SQL Server resides.
Query Port Number

-andBackup Port Number
The database utilizes these two TCP/IP ports for communication

between CONTROL-M and the SQL Server. The port numbers
must be different from each other. If these port numbers are
already used by an existing application, choose other values,
each in the range 1024 to 65534 inclusive. Default: 7102 and
7103
System Administrator (SA)

Password
Password (6 to 30 alphanumeric characters) for the database

administrator (user sa). The characters you enter are not echoed
for security reasons. This password is used by CONTROL-M
utilities to access restricted sections of the CONTROL-M
database.
Default password: (empty string)
CONTROL-M Database Name
Name for the CONTROL-M database. This name must be unique.

Default: ctrlm
CONTROL-M Database Owner
Database name for the CONTROL-M database owner. The

installation script creates this user in the database. This name is
used by CONTROL-M when accessing its database.
Default: ctrlm
CONTROL-M Database Owner

(DBO) Password
Password for the CONTROL-M database owner (6 to 30

alphanumeric characters). The characters you enter are not
echoed for security reasons. The first character must be a letter
(A Z). This password is used by CONTROL-M processes and
utilities to access the CONTROL-M database. Default: password
Data Device Logical Name
Name of the device on which the CONTROL-M database will be

located. Default: ctrlm_ux
Data Device Path
Full path name for the CONTROL-M database.

Default: c:\<sql dir>\data\ctrlm_ux
5-14
Table 5-8
Database Parameters
Parameter
Description
Data Device Size
Amount of space (in MB) to allocate for the data portion of the
CONTROL-M database. Default 75
Log Device Logical Name
Name of the device on which the CONTROL-M database log will

be located. Default: ctrlm_log
Log Device Location
Full path name where the CONTROL-M database log will be

located. Default: c:\<sql dir>\data\ctrlm_log
Log Device Size
Amount of space (in MB) to allocate for the CONTROL-M

database log. Default: 25
5-15
Performance Parameters
Special parameters are available for tuning the performance of
CONTROL-M. These parameters affect how jobs are selected for both
scheduling and post processing.
The performance parameters in Table 5-9 are contained in the
CONTROL-M/Server c:\ctmsrv\ctm\data\config.dat file.
Table 5-9
Performance Parameters
Parameter
Description
PRIORITY_SL_SCAN
Indicates if job priority should be used during the job selection

process (when deciding which job should run next. Valid values
are:
0 Use job priority. Default
1 Do not use job priority. This setting increases CONTROL-M
performance.
SL_BREAK_INT
Specify how many jobs to scan in the selection process before

checking for jobs in the post processing queue. The lower the
value, the faster the performance. However, jobs at the bottom of
the queue will take longer to be scheduled.
Value range: 1-99999. Default: 100
PP_THRESHOLD
Specify the maximum number of jobs that can wait in the post
processing queue before post processing is initiated. The lower
the value, the faster the jobs get post processed, but jobs at the
bottom of the queue will take longer to be processed.
Value range: 1-99999. Default: 10
CYCLIC_RERUN
Specify how a failed cyclic job should be handled

NOTOK A cyclic job is not resubmitted if it fails.
OK A cyclic job continues to be resubmitted even if it fails.
Default: OK
The sleep time setting for CONTROL-M processes can also affect the
performance and functionality of CONTROL-M/Server. For example,
setting the sleep time of the Selector (SL) and/or Tracking (TR) process
to 5 will improve performance, but CONTROL-M/Server will consume
more CPU. For more information, see Sleep Time Considerations on
page 4-42.
5-16
Preparing for CONTROL-M/Server

Installation
Hardware/Software Requirements
Requirements for installing CONTROL-M/Server appear in Chapter 7,
Installation Procedure in this guide.
Requirements for installing and operating CONTROL-M/Agent on
various platforms are described in the appropriate chapter in the
CONTROL-M/Agent Administrator Guide.
Before Starting Installation
When installing CONTROL-M/Server and CONTROL-M/Agent on

the same platform, is the order of installation important?
No. The order of installing CONTROL-M/Server and
CONTROL-M/Agent, on the same platform, is not important. For
more information, see Installing CONTROL-M/Agent on the Server
Platform on page 6-2.
6-1
Installation Considerations
SQL Server Configurations for CONTROL-M
CONTROL-M (Primary) Database
The CONTROL-M database (also referred to as the CONTROL-M

primary database) is stored in an SQL Server database. This database is
maintained by CONTROL-M/Server through an existing MSSQL Server.
The MSSQL Server must use a Case Sensitive sort order. If you use a
sort order other than Case Sensitive, CONTROL-M may behave
differently than expected. Check with your DBA Administrator.
Installing CONTROL-M/Agent on the Server Platform

You can install CONTROL-M/Agent immediately after installing
CONTROL-M/Server, or you can install CONTROL-M/Agent on the
Server platform before using CONTROL-M/Server to schedule jobs.
The presence of CONTROL-M/Agent on the Server platform lets you
submit jobs to be handled by CONTROL-M on the Server platform
itself:
It is required to handle the execution of User Daily jobs.
It allows you to utilize the resources of the Server platform for

executing production jobs.
It enables you to run CONTROL-M utilities as batch jobs scheduled

and handled by CONTROL-M/Server.
See the CONTROL-M/Agent Administrator Guide for information about

installing CONTROL-M/Agent on the Server platform.
6-2
Before installing CONTROL-M/Server, ensure that all necessary

pre-installation procedures have been performed. For more information,
see Chapter 6, Preparing for CONTROL-M/Server Installation.
This chapter includes the following sections:
Installing CONTROL-M/Server Programs
Building the CONTROL-M Database
Silent Installation of CONTROL-M/Server Programs
Setting CONTROL-M Security Authorizations
Specifying CONTROL-M/Server Service User Account
Setting CONTROL-M/Server User Rights
Verifying Communication With Agent Platforms
Starting/Stopping CONTROL-M/Server Manually
Uninstalling CONTROL-M/Server
7-1
Requirements for installing CONTROL-M/Server are listed in Table 7-1.
Table 7-1
Installation Requirements
Item
Description
Computer
Intel 586 CPU 200 MHz.
Operating System
Windows NT Version 4.0 Service Pack 5 or 6a.
Memory
64 MB RAM (required for running the operating

system and user applications).
Disk Space
CONTROL-M Database:
When using an existing SQL Server for
CONTROL-M/Server:
150 MB free disk space is required on the machine
(using default values).
Media Drive
CD-ROM drive.
Installation Media
CONTROL-M/Server Installation CD.
MSSQL Client
An MSSQL Client that communicates with an

MSSQL Server must exist prior to installing
CONTROL-M/Server. However, if both MSSQL
Server and CONTROL-M/Server are installed on
the same machine, it is not necessary to install
MSSQL Client.
Requirements for operating CONTROL-M/Agent on the various

platforms are described in the CONTROL-M/Agent Administrator Guide.
Note
To use CONTROL-M/Server for massive production, a more powerful

configuration may be necessary.
7-2
Installing CONTROL-M/Server on Windows NT consists of the following
procedures:
Installing CONTROL-M/Server programs

Building the CONTROL-M database
After installing CONTROL-M/Server, it may be necessary to:
Customize parameters for communicating with Agent platforms

Set CONTROL-M security authorizations
Specify CONTROL-M/Server Service user account
Set CONTROL-M/Server user rights
Installing CONTROL-M/Server on a Remote Machine
If you install CONTROL-M/Server on a remote machine, you must first

install an MSSQL Client on the same machine. However, there is no
need to install MSSQL Client if CONTROL-M/Server is installed on the
same machine as MSSQL Server.
Installing CONTROL-M/Server Programs

To install CONTROL-M/Server for Windows NT:
Step 1
Log into a user account belonging to the Administrators group.
Step 2
Mount the CD in the CD-ROM drive.
Step 3
Open either the Start menu or Windows NT Explorer.

From the Start menu, select Run and type the following command:
<Drive_ID>:\<FD#>\SETUP
7-3
where <Drive_ID> identifies the drive in which you placed the CD

ROM (for example, E:\) and <FD#> is the relevant FD number for
CONTROL-M/Server.
Click OK.
-orUsing Windows NT Explorer, select the CD-ROM drive and directory
containing the installation media and double-click file SETUP.EXE.
Note
If the Autorun option is enabled on your machine, installation will start

automatically after mounting the CD in the CD-ROM drive.
After a few seconds, the first page of the installation procedure is
displayed:
Step 4
Click Next to continue the installation. The following window is

displayed:
7-4
Specify the directory in which CONTROL-M/Server is to be installed.

Step 5
Click Next to continue the installation.

The CONTROL-M files are copied and installation is automatically
initiated. Reboot the machine before starting the SQL Server and
CONTROL-M.
The CONTROL-M database is stored in an MSSQL database. This database is
maintained by CONTROL-M/Server using an existing MSSQL Server.
For requirements for database implementation, see Chapter 6, Preparing
for CONTROL-M/Server Installation.
7-5
Building the CONTROL-M Database

Installation continues with building the CONTROL-M database.
To build the CONTROL-M database:
Step 1
The SQL Server Parameters window is displayed:
Step 2
Specify the SQL Server parameters. These parameters are described in

Chapter 5, Customization Parameters. In most instances, a default
value for each parameter is provided.
Table 7-2
Parameter
Description
Server Host Name
Host name of the machine where the SQL Server

resides.
Query Port Number
Port number of the SQL Server.

Default: 0
This value cannot be changed.
7-6
Table 7-2
Step 3
Parameter
Description
SA Password
Password of the system administrator (SA) of the

database.
CONTROL-M DB Name
Name of the CONTROL-M database. This name

must be unique. Default: ctrlm
CONTROL-M DB
Owner
Name for the CONTROL-M database owner.

Default: ctrlm
CONTROL-M DBO
Password
Password for the CONTROL-M database owner (6

to 30 alphanumeric characters).
The first character must be a letter (A Z).
If the specified password is longer than 30
characters, only the first 30 are accepted.
Default: password
Click Next to continue. The Server Devices Parameters window is

displayed:
7-7
Step 4
Specify the CONTROL-M Database parameters. These parameters are

described in Chapter 5, Customization Parameters. In most instances, a
default value for each parameter is provided.
Table 7-3
Required CONTROL-M Database Parameter
Parameter
Description
Data Device Logical

Name

database will be located. Default: ctrlm_ux
Data Device Path

will be located.
For example, <sql dir>\data\ctrlm_ux.
Data Device Size

data portion of the CONTROL-M database.
Default: 75
Log Device Logical

Name

database log will be located. Default: ctrlm_log
Log Device Path

log will be located.
For example, <sql dir>\data\ctrlm_log.
Log Device Size

CONTROL-M log database.
Default: 25
Enter the data device path and the log device path.
Change any parameter that differs from its default value.
Step 5
Click OK to build the database.

The installation procedure builds the CONTROL-M database.
7-8
The WCTMCONFIG window for configuring Communication and

Operational parameters is displayed:
Step 6
Specify the Communication and Operational parameters required by

CONTROL-M/Server. These parameters are described in Chapter 5,
The following parameters are required:
Step 7

Maximum Retries
Maximum Job State Changes
ENTERPRISE/CS TC/IP Port Number
CONTROL-M/Server TC/IP Port Number
Statistics Mode
Click OK after specifying the parameters.
7-9
The following window is displayed:
Step 8
To complete the installation procedure, click Finish to reboot your

machine.
Note
Run utility dbversion in the DOS command prompt window for a

general description of the MSSQL database in use, including the current
version number.
7-10
Silent Installation of CONTROL-M/Server Programs

The silent installation option allows the installation to proceed
automatically after it is initiated. The installation procedure receives
information from files that have been prepared in advance.
To use the silent installation option:
Note
Before editing these files, change the attribute of the files from
Read-only to Archive.
Step 1
Copy the Silent_Template directory under FD<server number> to a

temporary directory on your computer.
Step 2
Edit one or more files, as described in Table 7-4.

Table 7-4
Silent Installation Files
File
Description
SilentInst.bat
This file performs the silent installation. If your

CDROM device is not E you must edit the line:
E:\setup s f1.\setup.iss f2.\setup.log
Change E to the letter of your CD-ROM device.
Setup.iss
This file points to the directory where

CONTROL-M/Server is to be installed. To change
the name of the directory, edit the section
[TargetPath] of the setup.iss file. The default
location is D:\CTMSRV.
Silent.dat
This file contains parameter values needed to build

the CONTROL-M database. You can edit this file as
required. For a description of the parameters in this
file, see Table 5-8, Database Parameters, on
page 5-14.
7-11
Step 3
Double-click the file Silentinst.bat to start the silent installation.

Messages from the installation are written to the file setup.log located in
the temporary directory from where you ran the installation.
If the silent installation completed successfully, the following line is
written to the [ResponseResult] section of the setup.log file:
ResultCode=0
Open the mkdbfile.txt file which is located in the following path:

<control-m server directory>\ctm\temp\
This file must contain the following sentence:
CTMMAKEDB completed successfully
Step 4
Reboot the machine.
CONTROL-M/Server Menu
The following CONTROL-M/Server items are added to the Windows NT

Start => Programs => CONTROL-M/Server menu:
Figure 7-1
Menu Tree
7-12

Instructions for installing CONTROL-M/Agent on Windows NT are
provided in the CONTROL-M/Agent Administrator Guide. These steps
include:
Defining a user account for CONTROL-M/Agent.

Installing the CONTROL-M/Agent programs.
Customizing the installation.
Setting CONTROL-M/Agent user rights.

To customize default parameters for communicating with Agent platform:
Step 1
Type ctm_menu and press <Enter>. The CONTROL-M Main Menu is

displayed.
Step 2
Select Parameter Customization (option 4) from the CONTROL-M

Main Menu. A menu similar to the following is displayed:

----------------------------Select one of the following options:
1 - Communication and Operational Parameters
2 - System Parameters and Shout Destination Tables
3 - Default Parameters for Communicating with Agent
Platforms
4 - Parameters for Communicating with Specific Agent
Platforms
q - Quit
Enter option number --->
[q]:
7-13
Step 3
Select Default Parameters for Communicating with Agent Platforms

(option 3) from the Parameter Customization Menu. A menu similar to
the following is displayed:
Default Parameters for Communicating with Agent
Platform
1)
2)
3)
4)
5)
Polling Interval: 100

Communication Timeout: 120
Maximum Retries: 12
Retry Interval (Unavailable): 90
Server-to-Agent Port Number: 7006
a) Modify all of the above

q) Quit
s) Save
Enter command or item number you wish to change: []:
The parameters in this window are described in Parameters for

Step 4
Change the parameters as desired.
Step 5
Enter s to save the changes.
Step 6
Enter q to exit.
To customize parameters for communicating with a specific Agent platform:

Step 1
Select Parameter Customization (option 4) from the CONTROL-M

Main Menu.
Step 2
Select Parameters for Communicating with Specific Agent Platforms

(option 4) from the Parameter Customization Menu. A menu similar to
the following is displayed:
To view/modify communication parameters,
Enter node ID of Agent Platform:
7-14
Step 3
Specify the node ID of the desired Agent platform.

Note
This option does not require communication with the Agent platforms
and this option does not verify that the specified Agent platform exists.
A menu similar to the following displayed:
Parameters for Communicating with Specific Agent Platform (TN123):

1)
2)
3)
4)
Maximum Retries:
Retry Interval (Unavailable):
a)
q)
s)

Quit
Save
120
12
90
7006

Enter command or item number you wish to change: []:
The parameters in this window are described in Parameters for

Step 4
Change the parameters as desired.
Step 5
Enter s to save the changes.
Step 6
Enter q to exit.
7-15
Setting CONTROL-M Security Authorizations

CONTROL-M contains an integral security system that protects the
functionality provided by CONTROL-M against unauthorized usage or
modification. This security system strengthens the standard Windows NT
security facility and provides an additional application-level security
layer.
The CONTROL-M Security Maintenance utility is used to define users
in the CONTROL-M Security database and to assign authorizations for
working with CONTROL-M through the ENTERPRISE/CS workstation.
This utility is run directly on the Server platform.
To invoke the CONTROL-M Security Maintenance utility ctmsec:
Step 1
Open a command prompt and enter:

<Drive>:\<control-m server dir>\ctm\exe\ctmsec
A menu similar to the following displayed:
CONTROL-M SECURITY MAINTENANCE UTILITY

Main Menu
1) User Maintenance
2) Scheduling Table Authorization
3) Active Jobs File Authorization
4) Entities Authorization
q) Quit
Enter option:
Step 2
Set the authorizations as required.

For instructions on using the Security Maintenance Utility (ctmsec), see
Security Maintenance Utility on page 3-12.
7-16
Specifying CONTROL-M/Server Service User Account

If you have installed CONTROL-M/Server as a service (the default), you
can change the default Service user account.
To modify the CONTROL-M/Server Service user account:
Step 1
Log in to a user account belonging to the Administrators group.
Step 2
Select Control Panel => Services => CONTROL-M/Server.
Step 3
Click Startup.
The following dialog is displayed.
If the System Account option is checked, the CONTROL-M/Server

service will run in the native system account environment and in the
administrative group with full privileges.
If you want to expand your environment settings and be attached to a

specific user environment, check the option This Account and
specify the user and password. Be sure to specify a user account that
has full privileges and is in the administrative group.
7-17
Setting CONTROL-M/Server User Rights

In order for CONTROL-M/Server to access and update CONTROL-M
databases and communicate with Agent platforms, it must have the
following user rights on the Server Platform:
Act as part of the operating system

Increase Quotas
Replace a Process Level Token
To set CONTROL-M/Server user rights:

Step 1
Log into a user account belonging to the Administrators group.
Step 2
Select Start menu => Programs => Administrative Tools => User
Manager for Domain => Policies => User Rights => Show Advanced
User Rights.
Step 3
Select the user rights listed above.
Step 4
Reboot the machine to make the user rights effective.
7-18
Verifying Communication With Agent Platforms

It is highly recommended that you verify the ability of the Windows NT
Server platform to communicate with the Agent platforms.
To verify communication with an Agent platform:
Step 1
Open an MS-DOS window on the Server platform. Specify the

command:
ping <host_name>
where <host_name> is the name of the Agent platform.
If the ping is successful, you receive a response that begins:

Pinging <host_name> [<IP_address>] with...
If the ping is unsuccessful, you receive the response:

BAD IP address <host_name>
Step 2
If the ping is unsuccessful, verify that you specified the host name
correctly.
Step 3
If the ping is still unsuccessful and the Windows NT platform does not
use DNS (Domain Name System) for host name resolution, check that
the host name is defined in the Hosts file for the platform. The Hosts file
is located under the system directory (usually in
c:\winnt\system32\drivers\etc\).
If the host name of the Agent platform is not listed in the Hosts file, you
can add an entry for the platform in the format:
<IP_address> <host_name>
For example:
128.128.100.12 diana
7-19
Starting/Stopping CONTROL-M/Server Manually

CONTROL-M/Server operates as a background process transparent to
the user.
CONTROL-M/Server is usually started automatically at boot time as a
Windows NT service and remains active as long as Windows NT is
running.
Under certain circumstances, you can start or stop CONTROL-M/Server
manually (for example, to perform certain diagnostics processes
described in Chapter 4, Maintenance). You can use the following
procedures to accomplish this.
To start CONTROL-M/Server manually:
Step 1
Select Control Panel => Services => CONTROL-M/Server from the

Start menu.
Step 2
Click Start.
-orSpecify command start-ctm.
To stop CONTROL-M/Server manually:

Step 1
Select Control Panel => Services => CONTROL-M/Server from the

Start menu.
Step 2
Click the Stop button.

-orSpecify command shut-ctm.
7-20
Uninstalling CONTROL-M/Server
This topic describes how to uninstall CONTROL-M/Server from your
machine. You can uninstall CONTROL-M/Server using two methods:
silent
interactive
To uninstall CONTROL-M/Server in a silent mode:

Step 1
Open a Command Prompt window and navigate to the

<windows_directory>\system32\ctm_logs directory.
Step 2
At the Command Prompt, type UISRV.bat <parameter>.

Note
The parameter should be ctm or CTM. Any other value is considered

invalid and causes the uninstall procedure to continue in interactive
mode.
Step 3
Reboot the machine.
To uninstall CONTROL-M/Server in a interactive mode:

Step 1
Select Start => Programs => CONTROL-M/Server => Uninstall

CONTROL-M/Server.
Step 2
Follow the instructions in the uninstall window.
Step 3
Reboot the machine.
7-21
7-22
Messages and Codes
The messages described in this appendix are displayed on the Server

platform and/or recorded in the CONTROL-M log. Each message is
preceded by a two-character code identifying the CONTROL-M/Server
process that generated the message. Message prefixes are listed in
Table A-1.
Table A-1
Message Prefixes
Code
Description
SU
Supervisor
TR
Tracker
SL
Selector and submittor
NS
Communication with Agent platforms
CO
Communication gateway
CD
New Day procedure, downloads, updates to the CONTROL-M

database
CS
Communication (user requests from ENTERPRISE/CS)
LG
Utilities invoked from Agent platforms
Example:
TR5103 COMSTAT=OK. STATUS CHANGED TO OK
Messages and Codes
A-1
Messages
5000
CONTROL-M IS NOW INACTIVE

Explanation:
5001
All CONTROL-M processes have been terminated.
FORCING <process_ID> OUT

Explanation:
The CONTROL-M supervisor process is about to force a
CONTROL-M process to stop. The process is being stopped. An attempt to
perform an orderly termination of a CONTROL-M process failed.
System Action:
5002
The CONTROL-M process is stopped.
PROCESS <process_ID> IS RUNNING

Explanation:
CONTROL-M process <process_ID> (Tracker, Submittor,
and so on) has been successfully activated.
5003
MAXRETRY REACHED FOR <process_ID>. SUPERVISOR IS

SHUTTING DOWN
Explanation:
CONTROL-M is shutting down. The supervisor tried to
activate CONTROL-M process <process_ID> (Tracker, Submittor, and so on)
the number of times specified in CONTROL-M system parameter MAXRETRY,
and failed.
User Response: Restart CONTROL-M. If the problem persists, notify your
BMC Software Technical support representative.
5004
RUNNING NEW DAY PROCEDURE

Explanation:
The New Day procedure is executing.
System Action: While this process is executing, all other CONTROL-M

processes are suspended.
5005
NEW DAY PROCEDURE TERMINATED

Explanation:
The New Day procedure has terminated successfully.
System Action:
Operation of all other CONTROL-M processes resumes.

A-2
5006
CONTROL-M LOG CLEANUP ENDED. DAYS=<days>

Explanation:
This information message indicates that the New Day
procedure has performed a partial cleanup of the CONTROL-M log.
Data for the specified number of days is retained, as determined by the value
assigned to CONTROL-M system parameter Maximum Days Retained by
CONTROL-M Log.
System Action:
5007
New Day processing continues.
STATISTICS INFORMATION CLEANUP ENDED

Explanation:
procedure has performed a partial cleanup of CONTROL-M job statistics.
When CONTROL-M system parameter Statistics is set to Y, CONTROL-M
retains statistical data for the last 20 executions of each job. Older data is deleted
by the New Day procedure.
System Action:
5008
PREREQUISITE CONDITIONS WITH DATEREF <mmdd> CLEANUP

ENDED
Explanation:
procedure has performed a partial cleanup of prerequisite conditions. The New
Day procedure deletes prerequisite conditions whose reference date is the same
as the specified month and day (from the new CONTROL-M date).
System Action:
5009
RESET CYCLIC FLAG TO NO

Explanation:
This messages indicates that the job is being modified to a
non-cyclic job. Because CONTROL-M cannot determine what action to take
regarding a job that is executing, a cyclic job that is executing when the New
Day procedure is started is changed to a non-cyclic job.
System Action:
cyclic job.
The job completes its current cycle and is changed to a non-
User Response: If the job should continue executing as a cyclic job, modify
job processing parameter Cyclic accordingly.
Messages and Codes
A-3
5020
PROCESS STATE CHANGED FROM <old_state> TO <new_state>

Explanation:
This information messages indicates that a CONTROL-M
process that was interrupted has restarted.
5030
ACTIVE JOBS FILE DOWNLOADED TO ENTERPRISE/CS

{STARTED | ENDED}
Explanation:
procedure has completed and the Active Jobs file has started/ended downloading
to the ENTERPRISE/CS workstation.
System Action: All other CONTROL-M processes that were suspended during
the New Day procedure are resumed.
5040
NEW DAY PROCEDURE STARTED

Explanation:
The New Day procedure has been submitted.
System Action: While this procedure is executing, all other CONTROL-M

processes are suspended.
5041
ACTIVE JOBS FILE CLEANUP ENDED

Explanation:
The New Day procedure has finished cleaning up the Active
Jobs file. This message is issued by the New Day procedure just before it starts
inserting new job orders into the Active Jobs file.
5042
NEW DAY PROCEDURE TERMINATED DATES INCORRECT

Explanation:
The New Day procedure cannot run due to a date
inconsistency. The date inconsistency is due to one of the following causes:
The New Day procedure has already run today.
The last running date of the New Day procedure is later than todays date.
User Response: If the New Day procedure has already run today, no user
action is required. If the last running date of the New Day procedure is later than
todays date, run utility ctmudlst and modify the last running date.
A-4
5043
QUANTITATIVE RESOURCE INTEGRITY ERROR.

<quantitative_resource> USED = <n1>, QRTAB = <n2>
Explanation:
Due to an internal accounting problem, there is a discrepancy
between the actual usage count (<n1>) of the specified Quantitative resource,
and the calculated sum of the usage of this resource by all jobs (<n2>) in the
Quantitative Resource table.
User Response: Hold all jobs using this resource and run utility ecaqrtab to
adjust the usage count in the table so that it matches the actual usage count.
5044
CONTROL RESOURCE <resource> INTEGRITY ERROR.

USED=<n1>, CTLTAB=<n2>
Explanation:
Due to an internal accounting problem, there is a discrepancy
between actual usage count (<n1>) of the specified Control resource by all
submitted and not-ended jobs (in Shared mode), and the calculated sum of the
usage of this resource by all jobs (<n2>) in the Control Resource table.
User Response: Contact your BMC Software Technical support representative
for assistance.
5045
CONTROL RESOURCE <resource_ID> INTEGRITY ERROR. MODE

EXCLUSIVE, USED = <n>
Explanation:
Due to an internal accounting problem, Control resource
<resource_ID> appears to be used in exclusive mode by more than one job.
User Response: Allow the jobs using this resource to terminate. If the problem
persists, notify your BMC Software Technical support representative.
5046
CONTROL RESOURCE <resource_ID> INTEGRITY ERROR. MODE

EXCLUSIVE, CTLTABCOUNT=<n>
Explanation:
Due to an internal accounting problem, Control resource
<resource_ID> appears in the Conditions/Resources table as being used in
Exclusive mode by more than one job.
User Response: Allow the jobs using this resource to terminate. If the problem
persists, notify your BMC Software Technical support representative.
Messages and Codes
A-5
5047
MAXWAIT PARAMETER EXCEEDED

Explanation:
The job was deleted from the Active Jobs file because it
existed in the Active Jobs file without being submitted for more than the number
of days specified in the MAXWAIT parameter.
User Response: Check the jobs pre-processing parameters.
5060
LAST RUN DATE OF USER <daily_ID> NONEXISTENT. STATUS =

<status_text>
Explanation:
The User Daily job was run for the first time. When a new
User Daily job is run (that is, the User Daily job is run for the first time), the last
run date is nonexistent and therefore cannot be accessed. No user action is
required. At the end of this run (as at the end of all runs), a new last run date is
automatically generated.
5061
USER DAILY <daily_ID> STARTED

Explanation:
5062
USER DAILY <daily_ID> ENDED

Explanation:
5063
Normal start message of User Daily job <daily_ID>.
Normal termination message of User Daily job <daily_ID>.
CALENDAR <calendar_ID> NOT FOUND OR NOT COMPLETE

Explanation:
The calendar referred to in the job scheduling definition (of
the User Daily) could not be found, or does not contain all the relevant years.
System Action:
The User Daily job cannot be run.
User Response: Use Enterprise Controlstation to either create the calendar or

to verify that all relevant years appear in the calendar.
A-6
5064
USER DAILY <daily_ID> STOPPED DATE PROBLEM. LAST

<date1>, NEXT <date2>
Explanation:
The specified User Daily job cannot run due to a date
inconsistency. The inconsistent date may be due to one of the following:
The User Daily job has already been run today.
The last running date of the User Daily job is later than todays date.
System Action:
The User Daily job stops executing.
User Response: If the User Daily job has already run today, no user action is
required. If the last running date of the User Daily job is later than todays date,
run utility ctmudlst (refer to the chapter on utilities in the Administrator Guide)
to modify the last running date according to your requirements.
5065
ORDERED JOB: <job_ID>; DAILY <daily_ID>, ODATE <odate_spec>

Explanation:
This information message indicates that Job <job_ID> with
ODATE <odate_spec> has been inserted into the Active Jobs file by User Daily
job <daily_ID>.
5070
USER HOME DIRECTORY IS NOT DEFINED

Explanation:
The owner of the job does not have a home directory in the
data center. No home directory is defined in the data center for the user specified
in the job processing parameter Owner for this job.
System Action:
The job is not submitted.
User Response: Define a home directory for the job owner; then rerun the job.
Messages and Codes
A-7
5080
FAILED TO SUBMIT JOB <job_name>. <reason>

Explanation:
The requested job could not be submitted due to <reason>.
The reasons include:
Logon failure: the user has not been granted the requested logon type.
There are currently no logon servers available to service the logon request
A specified logon session does not exist. It may already have terminated.
Logon failure: unknown user name or bad password.
Logon failure: user account restriction.
Logon failure: account logon time restriction violation.
Logon failure: user not allowed to log on to this computer.
Logon failure: the specified account password has expired.
A specified privilege does not exist.
A required privilege is not held by the client.
The name provided is not a properly formed account name.
The specified user already exists.
The specified user does not exist.
CONTROL-M/Server <host_name> is not authorized to run jobs on this
agent the CONTROL-M/Server specified is not listed in the Authorized
CONTROL-M Servers File for the Agent platform.
System Action:
The job is not submitted.
User Response: Examine the job processing definition to determine what

caused the problem. Either make the necessary corrections, provide the
necessary security authorizations, or add the Server platform to the Authorized
CONTROL-M Servers File or Windows NT Registry. Rerun the job.
5100
ENDED AT <time.> OSCOMPSTAT <return_code.> RUNCNT

<rerun_counter>
Explanation:
This information message indicates that the job terminated at
the specified time with the given return code and given run count of the job.
5101
STARTED ON <node_ID>
Explanation:
This information message indicates that the job began
executing on the specified Agent platform.
A-8
5102
DISAPPEARED AT <time>. RUNCNT <rerun_counter>

Explanation:
A job has dissappeared and cannot be found in the system.
After the job was submitted, it could not be located. The jobs status and the
location of its log cannot be determined. A user may have stopped the job or the
Agent platform on which the job was running may have been rebooted.
System Action:
The job is assigned the completion status NOTOK.
User Response: Either rerun the job, or force the job if the job scheduling
definition has changed since the last New Day procedure or User Daily job.
5103
<message _text>. STATUS CHANGED TO {OK | NOTOK}

Explanation:
This information message indicates that after analyzing the
job, CONTROL-M has changed the jobs status to either OK or NOTOK. The
reason for the status change is indicated in <message_text>:
5104
Status Change
Description
SYSOUT LOST
The jobs sysout file cannot be located.
DISAPPEARED
The job that was executing cannot be located by

CONTROL-M.
COMSTAT=OK
The jobs completion code indicated that the job ended

OK.
COMSTAT=NOTOK
The jobs completion code indicated that the job ended

not OK.
DUMMY
The job submitted is one of dummy format.
NOT SUBMIT
Job submission failed. This might have resulted from a

Server/Agent communication problem.
PID=<procID>, CPU:<cpu_time>, EL:<elapsed_time>,

END:<end_time>
Explanation:
A job terminated with the status OK. This statistical message
is written to the sysout file when a job terminates with the status OK and the
CONTROL-M system parameter Statistics has been set to Y.
Messages and Codes
A-9
5105
SUBMITTED AT <time> TO <node_ID>

Explanation:
This information message indicates that the job was submitted
for execution at the specified time to the specified Agent platform.
5106
DISAPPEARED AT <time>. RUNCNT <rerun_counter>. AGENT IS

DISABLED
Explanation:
A job can no longer be tracked because a user changed the
status of the Agent platform on which it was running to Disabled. After the job
was submitted to an Agent platform, a user changed the communication status of
the platform to Disabled. Therefore, CONTROL-M can no longer track the job.
System Action:
The job is assigned the completion status NOTOK.
User Response: Rerun the job or force the job on a different Agent platform.
5110
LIBMEMSYM FILE <pathname> NOT FOUND

Explanation:
The <pathname> file specified in a %%LIBMEMSYM
AutoEdit variable was not found. AutoEdit variable %%LIBMEMSYM can be
used to refer to a list of AutoEdit assignments contained in a file in the data
center. The file referred to in this instance was not found.
System Action:
The job continues to execute.
User Response: Determine why the file was not found. Create the file or
correct the pathname specified for the AutoEdit variable.
5120
JOB STATE CHANGED TO <state_text>

Explanation:
This information message indicates that after analyzing the
job, CONTROL-M has changed the jobs state to <state_text>.
5121
SYSOUT FILE COPIED TO <location>

Explanation:
The sysout file of the specified job was copied to location
<location>. This message is issued following a successful SYSOUT or DO
SYSOUT copy operation.
System Action:
The sysout file is copied to the specified location.
A-10
5122
SYSOUT FILE MOVED TO <location>

Explanation:
The sysout file of the specified job was moved to location
<location>. This message is issued following a successful SYSOUT or DO
SYSOUT move operation.
System Action:
5123
The sysout file is moved to the specified location.
SYSOUT FILE RELEASED

Explanation:
The sysout file of the specified job was released to the print
queue. This message is issued following a successful SYSOUT or DO
SYSOUT release operation.
System Action:
5124
The sysout file is placed on the print queue.
SYSOUT FILE DELETED

Explanation:
The sysout file for the specified job was deleted. This message
is issued following a successful SYSOUT or DO SYSOUT delete operation.
5125
SYSOUT FILE OPEN ERROR

Explanation:
The sysout file for the specified job cannot be opened. Either
the sysout file could not be found, or it is corrupt. Since the sysout file could not
be opened, the jobs output cannot be analyzed.
System Action:
job fails.
The sysout file is not opened, the job is not analyzed, and the
User Response: Check if the file is missing. Rerun the job if applicable. If
other information in the system indicates that the job ran successfully (for
example, other output data, new files), use the maintenance utilities to adjust
condition values to the state in which they would be if the job had been
analyzed.
Messages and Codes
A-11
5126
SYSOUT FILE COPY TO <location> FAILED

Explanation:
The sysout file for the specified job could not be copied.
CONTROL-M was unable to perform the specified SYSOUT or DO SYSOUT
copy action. Possible reasons are operating system security restrictions, or lack
of disk space.
System Action:
The sysout file is not copied.
User Response: Verify user authorization of CONTROL-M, examine operating

system security information, and verify that there is enough disk space.
5127
SYSOUT FILE MOVE TO <location> FAILED

Explanation:
The sysout file for the specified job could not be moved.
CONTROL-M was unable to perform the SYSOUT or DO SYSOUT move
action. Possible reasons are operating system security restrictions or lack of disk
space.
System Action:
The sysout file is not moved.
User Response: Verify user authorization of CONTROL-M, examine operating

system security information, and verify that there is enough disk space.
5128
SYSOUT FILE RELEASE FAILED

Explanation:
The sysout file for the specified job could not be printed.
CONTROL-M was unable to perform the SYSOUT or DO SYSOUT releaseto-print action. Possible reasons are the print queue is stopped, closed or
nonexistent.
System Action:
The sysout file is not printed.
User Response: Try to correct the print queue problem. If you cannot, notify
your ENTERPRISE/CS administrator.
A-12
5129
SYSOUT FILE DELETE FAILED

Explanation:
The sysout file for the specified job could not be deleted.
CONTROL-M was unable to perform the SYSOUT or DO SYSOUT delete
action. Possible reasons are that the file does not exist, or that the user is not
authorized to delete the file.
System Action:
The sysout file is not deleted.
User Response: Check whether the file actually exists. If it does, check the job
owners authorization (both system and CONTROL-M authorization). If
necessary, contact your ENTERPRISE/CS administrator.
5132
STATUS SET TO <job_status> AS A RESULT OF DO OK/NOTOK

Explanation:
This information message indicates that the completion status
of the job was changed as a result of DO OK or DO NOTOK post-processing
actions.
5133
ENDED OK
Explanation:
This information message indicates that the job has terminated
with the status OK. Following job execution and post-processing,
CONTROL-M has analyzed the results and has assigned the completion status
OK to the job.
5134
ENDED NOTOK
Explanation:
The job has terminated with a final status of NOTOK.
Following job execution and post-processing, CONTROL-M has analyzed the
results, and assigned a final status of NOTOK to the job, indicating that a
problem occurred during job processing.
User Response: Examine the job log (SYSOUT) to determine why the job
terminated with a status of NOTOK.
Messages and Codes
A-13
5135
AUTHORIZATION PROBLEM <problem_description>

Explanation:
The job has terminated abnormally due to a security
authorization problem. CONTROL-M attempted to execute a job contained in
the Active Jobs file. The job failed to execute due to the security-related
problem stated in <problem_description>.
System Action:
The job is not executed.
User Response: Determine what authorization is lacking. Request that your

CONTROL-M system administrator define the necessary authorization; then
rerun the job.
5136
JOB STATE CHANGED TO RETRY SUBMIT

Explanation:
This information message indicates that CONTROL-M
attempted to submit the job to the Agent platform but it failed due to the Agent
not responding. The jobs state was changed to Retry and the job was
resubmitted.
5160
SYSOUT LOST. STATUS CHANGED TO NOTOK

Explanation:
The jobs sysout file cannot be located. The sysout file is
required to determine which post-processing actions, if any, are required for the
job.
System Action:
The job is assigned a completion status of NOTOK.
User Response: Determine what happened to the sysout. Once the cause of the
problem has been corrected, resubmit the job.
5161
DISAPPEARED. STATUS CHANGED TO NOTOK

Explanation:
The job was executing cannot be located by CONTROL-M.
Something occurred to the job while it was running that caused it to disappear
from CONTROL-Ms control. A possible cause is that a user canceled the job
directly and not through CONTROL-M.
System Action:
User Response: Using the operating systems process identification number,

determine what happened to the job and act accordingly.
A-14
5162
COMPSTAT=OK. STATUS CHANGED TO OK

Explanation:
This information message indicates that the job ended OK.
CONTROL-M assigns the job a status of OK based on the jobs completion
code.
5163
COMPSTAT=NOTOK. STATUS CHANGED TO NOTOK

Explanation:
This information message indicates that the job ended not OK.
CONTROL-M assigns the job a status of NOTOK based on the jobs
completion code.
5164
DUMMY. STATUS CHANGED TO OK

Explanation:
This information message indicates that the job was assigned a
status of Ended OK because it is a dummy job.
5165
NOT SUBMITTED. STATUS CHANGED TO NOTOK

Explanation:
Job submission failed. This might have resulted from a Server/
Agent communication problem.
System Action:
User Response: Using the operating systems process identification number,

determine why the job submission failed and act accordingly.
5200
ORDER STATE CHANGED TO <state_text>

Explanation:
This information message indicates that CONTROL-M has
finished job post-processing, and changed the jobs state to <state_text>.
5201
SHOUT TO <destination> PERFORMED

Explanation:
This information message indicates that a Shout message was
issued to the specified destination.
Messages and Codes
A-15
5202
SHOUT TO <destination> FAILED

Explanation:
An attempt to issue a Shout message to the specified
destination was not successful. A possible reason for the failure is that the an
invalid destination was specified.
System Action:
The Shout message is not issued.
User Response: Check the validity of the destination.

5203
CONTROL RESOURCE <resource_ID> RESERVED

Explanation:
This information message indicates that Control resource
<resource_ID> has been reserved for the specified critical job.
5204
CONTROL RESOURCE <resource_ID> ALLOCATED. MODE:

<mode>
Explanation:
This information message indicates that Control resource
<resource_ID> has been allocated for the specified non-critical job in the
indicated mode (Shared or Exclusive).
5205
RESERVED CONTROL RESOURCES ALLOCATED

Explanation:
This information message indicates that all reserved Control
resources for the specified critical job have been allocated successfully.
5206
CONTROL RESOURCES RELEASED

Explanation:
This information message indicates that all Control resources
allocated for the job order have now been released because the job has
terminated.
5207
QUANTITATIVE RESOURCE <resource_ID> QUANTITY

<resource_quantity> RESERVED
Explanation:
This information message indicates that Quantitative resource
<resource_ID> has been reserved in quantity <resource_quantity> for the
specified critical job, and is ready to be allocated.
A-16
5208

<resource_quantity> ALLOCATED
Explanation:
This information message indicates that quantity
<resource_quantity> of Quantitative resource <resource_ID> has been
allocated for a non-critical job.
5209
CONDITION <condition_ID> <date_ref> ADDED

Explanation:
This information message indicates that following job
termination, the specified condition has been added to the Conditions/Resources
table.
5210
CONDITION <condition_ID> <date_ref> DELETED

Explanation:
This information message indicates that following job
termination, the specified condition (with the matching date reference) has been
deleted from the Conditions/Resources table.
5211
FORCEJOB FAILURE. JOB <job_number>, TABLE <table_ID>

Explanation:
A FORCEJOB operation for the specified job number in the
specified table failed. Failure may have been due to problems with the job
scheduling definition (for example, job not found), security verification
problems, and so on.
User Response: Verify the existence of the script file, and check
CONTROL-M and operating system security restrictions.
5212
JOB <job_number>, TABLE <table_ID> FORCED

Explanation:
This information message indicates that the FORCEJOB
operation for the specified job/table has completed successfully.
5213
RESERVED QUANTITATIVE RESOURCES ALLOCATED

Explanation:
This information message indicates that all reserved
Quantitative resources for the specified critical job have been allocated.
5214
QUANTITATIVE RESOURCES RELEASED

Explanation:
This information message indicates that all allocated
Quantitative resources for the specified job have now been released.
Messages and Codes
A-17
5215
ALL RERUNS HAVE BEEN PERFORMED. MAXRERUN = <number>

Explanation:
This information message indicates that all the reruns
requested for the specified job have been performed.
5216
<shout_text>
Explanation:
The Shout message <shout_text> was issued to the
CONTROL-M log. The text in this message is issued by a Shout statement and
is written to the CONTROL-M log.
5217
FORCE NOT PERFORMED: JOB <job_ID>, TABLE <table_ID> DOES

NOT EXIST
Explanation:
An attempt to force job <job_ID>, located in table
<table_ID>, failed because the job/table does not exist.
System Action: An ENTERPRISE/CS user attempted to force a job through
the Scheduling menu option in the Enterprise Controlstation window.
-orA CONTROL-M job attempted to execute a Do Forcejob statement as part of
its Post-processing parameters.
Either the table specified in <table_ID> does not exist, or the job specified in
<job_ID> does not exist in the specified table.
System Action:
No action is taken.
User Response: Determine the source of the problem (missing job processing
definition, missing Scheduling table, incorrectly specified Do Forcejob
statement, and so on). Correct the problem and re-execute the Force.
A-18
5218
FORCE WAS NOT PERFORMED TABLE <table_ID> DOES NOT

EXIST
Explanation:
An attempt to force Scheduling table <table_ID> failed
because the table does not exist.
An ENTERPRISE/CS user attempted to force a Scheduling table through the
Scheduling menu option in the Enterprise Controlstation window.
-orA CONTROL-M job attempted to execute a Do Forcejob statement as part of
its Post-processing parameters.
The table specified in <table_ID> does not exist.
System Action:
No action is taken.
User Response: Determine the source of the problem (missing Scheduling

table, incorrectly specified Do Forcejob statement, and so on). Correct the
problem and re-execute the Force.
5220
STATUS OF AGENT PLATFORM <node_ID> CHANGED TO

AVAILABLE
Explanation:
This information message indicates that CONTROL-M
changed the communication status of the Agent platform identified by
<node_ID> from Unavailable to Available. The communication status of the
Agent platform had been changed from Available to Unavailable due to failed
communication. As a result of resumed communication, the status of the Agent
platform has been returned to Available.
System Action: CONTROL-M resumes sending job-handling requests to the
Agent platform.
Messages and Codes
A-19
5221

AVAILABLE BY USER
Explanation:
This information message indicates that an authorized user
changed the communication status of the Agent platform identified by
<node_ID> from Disabled to Available. The communication status of the
Agent platform had been previously changed to Disabled, either by a user or
due to a communication failure.
System Action: CONTROL-M resumes sending job-handling requests to the
Agent platform.
5222

UNAVAILABLE
Explanation:
CONTROL-M changed the communication status of the
Agent platform identified by <node_ID> from Available to Unavailable due to
repeated communication timeouts.
A communication failure has occurred between the Server platform and the
specified Agent platform.
-or<node_ID> was not specified correctly in the job processing definition or in the
node group.
System Action: CONTROL-M attempts to communicate with the Agent
platform but does not send job-handling requests to the platform. If
CONTROL-M succeeds to communicate with the Agent platform, the status of
the platform will be returned to Available; otherwise, the status of the platform
will be changed to Disabled.
User Response: Verify that the node ID specified in the job processing
definition or in the node group is valid. Determine the cause of the failed
communication and correct it.
A-20
5223

DISABLED
Explanation:
CONTROL-M changed the communication status of the
Agent platform identified by <node_ID> from Unavailable to Disabled due to
repeated communication timeouts.
A communication failure has occurred between the Server platform and the
specified Agent platform.
-orThe node ID was not specified correctly in the job processing definition or in the
node group.
System Action: CONTROL-M no longer attempts to communicate with the
Agent platform and does not send job-handling requests to the platform.
User Response: Verify that the node ID specified in the job processing
definition or in the node group is valid. Determine the cause of the failed
communication and correct it. After correcting the problem, use the Agent Status
menu to change the status of the Agent platform to Available.
5224

DISABLED BY USER
Explanation:
An authorized user changed the communication status of the
Agent platform identified by <node_ID> from Unavailable to Disabled.
System Action: CONTROL-M no longer attempts to communicate with the
Agent platform and does not send job-handling requests to the platform.
User Response: When desired, use the utility to change the status of the Agent
platform to Available.
Messages and Codes
A-21
5250
ACCESS TO TABLE <table_ID> IS NOT ALLOWED TO USER

<user_ID>
Explanation:
A User Daily job attempted to order a job from a table which
it is unauthorized to access. This is a security violation.
System Action:
Access to the scheduling table is denied to the User Daily job.
User Response: Verify/modify user authorizations pertaining to the specific

scheduling table.
5251
THIS OWNER IS NOT AUTHORIZED TO EXECUTE THE JOB SCRIPT

Explanation:
The owner of the job processing definition is not authorized to
execute the script file specified by the job processing parameters.
System Action:
The job terminates with a NOTOK status.
User Response: Either modify the script file protection accordingly, or grant
the owner execution privileges.
5252
ENTERPRISE/CS USER <user_ID> NOT AUTHORIZED FOR OWNER

<owner_ID>
Explanation:
User <user_ID> tried to perform an unauthorized action on a
job belonging to owner <owner_ID>. There are restrictions on the operations
that users can perform on jobs belonging to other owners unless the user is
authorized by the security administrator.
User Response: If you still want to perform the specified operation, contact
your security manager for the required authorization.
5260 5330
See the Messages and Codes chapter in the Enterprise Controlstation User
Guide.
A-22
5351

<resource_quantity> DEFINED
Explanation:
The user defined a new Quantitative resource, and its
maximum quantity.
System Action:
5352
The resource is added to the CONTROL-M resource pool.
QUANTITATIVE RESOURCE <resource_ID> DELETED

Explanation:
This information message indicates that by user request,
Quantitative resource <resource_ID> has been deleted from the CONTROL-M
resource pool.
5353
QUANTITATIVE RESOURCE <resource_ID> QUANTITY INCREASED

BY <resource_quantity>
Explanation:
This information message indicates that by user request, the
maximum quantity of Quantitative resource <resource_ID> has been increased
by quantity <resource_quantity>. The use of Quantitative resources is
discussed in the Enterprise Controlstation User Guide.
5354

DECREASED BY <resource_quantity>
Explanation:
This information message indicates that by user request, the
maximum quantity of Quantitative resource <resource_ID> has been decreased
by quantity <resource_quantity>. The use of Quantitative resources is
5355

<resource_quantity> RELEASED
Explanation:
This information message indicates that a number
<resource_quantity> of units of Quantitative resource <resource_ID> that
were allocated by a job have been released. These units are now available for
other jobs that may require this resource. The use of Quantitative resources is
Messages and Codes
A-23
5356
CONTROL RESOURCE <resource_ID> DEFINED

Explanation:
This information message indicates that the user requested
allocation of a Control resource that does not exist.
System Action:
the user.
5357
Control resource <resource_ID> is defined, and allocated to
CONTROL RESOURCE <resource_ID> RELEASED

Explanation:
This information message indicates that by ENTERPRISE/CS
user request, Control resource <resource_ID> has been released.
5401
HELD BY USER <user_name>

Explanation:
This information message indicates that the job associated
with the message was held by the ENTERPRISE/CS user <user_name>.
5402
FREED BY USER <user_name>

Explanation:
with the message was released from its held state by the ENTERPRISE/CS user
<user_name>.
5403
DELETED BY USER <user_name>

Explanation:
with the message was marked as deleted by the ENTERPRISE/CS user
<user_name>.
5404
RERUN BY USER <user_name>

Explanation:
with the message was rerun by the ENTERPRISE/CS user <user_name>.
5405
CONFIRMED BY USER <user_name>

Explanation:
with the message that was awaiting confirmation prior to submission, was
confirmed by the ENTERPRISE/CS user <user_name>.
A-24
5406
CHANGED BY USER <user_ID>

Explanation:
This information message indicates that the indicated
ENTERPRISE/CS user changed a parameter of an active job.
5407
CREATED BY USER <user_name>

Explanation:
with the message was placed in the Active Jobs file by utility ctmcreate.
5500 5599
See the Messages and Codes chapter in the Enterprise Controlstation

User Guide.
Messages and Codes
A-25
A-26
Structure of CONTROL-M Log EntriesB

The CONTROL-M log is part of the CONTROL-M database in the data
center.
For additional information, see CONTROL-M Log on page 1-30.
Table B-1
Fields of the CONTROL-M Log
Field
Description
Characters
Logtime
Message time
Logdate
Message date
Subsystem
CONTROL-M process that generated the message
Jobname
Job name of the job that generated the message
10
Jobno
Job number (from job processing definition)
4 (integers)
Orderno
Order number of the job
4 (integers)
Owner
User name of jobs owner
30
Odate
Original scheduling date of job
Msgid
Message ID (messages are described in Appendix A)
Message
Text of message
66
Tasktype
Task Type identifier (e.g., batch, detached, command)
Memname
Member name
30
Structure of CONTROL-M Log Entries
B-1
B-2
Glossary
Glossary
Active Jobs File (AJF)
The Active Jobs file lists all jobs scheduled for submission in the
current day. Each job in the Active Jobs file is not submitted
until all conditions contained in the Job Processing definition for
the job are satisfied. The Active Jobs file is contained in the
CONTROL-M database.
Agent Platform
Platform on which CONTROL-M/Agent runs. The Agent

platform handles requests from CONTROL-M/Server to execute
jobs or provide information.
Calendar
A collection of dates that are used by CONTROL-M/Server to

schedule the ordering of jobs.
CONTROL-M
Software product that schedules, submits, tracks and follows up

the execution of jobs in a data center. In the current release,
CONTROL-M functions are divided between two separate
components: CONTROL-M/Server and CONTROL-M/Agent.
CONTROL-M (Primary)
Database
Repository of operational data relating to the functioning of the

CONTROL-M data center. Contents of the database include the
Active Jobs file, Scheduling tables (Job Processing definitions)
and the Resources/Conditions table. The database is maintained
by CONTROL-M/Server using an SQL or MSSQL Server.
CONTROL-M Date
Date used by CONTROL-M to assign the Scheduling date

(Odate) to jobs.
Glossary 1
CONTROL-M Log
Log containing a complete audit trail of every event occurring

under the CONTROL-M production environment.
CONTROL-M Platform
Platform on which CONTROL-M/Server runs.
CONTROL-M/Agent
The component of CONTROL-M that runs on each Agent

platform. CONTROL-M/Agent submits jobs and performs other
tasks based on requests from CONTROL-M/Server, and
performs post-processing analysis of completed jobs.
CONTROL-M/Server
The component of CONTROL-M that runs on the Server

platform. CONTROL-M/Server maintains the CONTROL-M
database (including the Active Jobs file), schedules jobs,
performs load balancing, sends job-handling requests to Agent
platforms, and handles requests from ENTERPRISE/CS.
Conditions/Resources
Table
A component of the CONTROL-M database that lists the current

status of all prerequisite conditions, Control resources and
Quantitative resources in the data center.
Control Resource
User-defined variable representing a physical or logical resource

in the data center. For each job the user specified whether the job
requires exclusive or shared access to the resource.
CONTROL-M/Server verifies that a job is not submitted for
execution unless the Control resources required by the job are
available in the required state (shared/exclusive). This prevents
deadlock situations or contention between jobs for a given
resource. Control resources are recorded in the
Data Center (or

CONTROL-M Data
Center)
A Server platform and all the Agent platforms that it handles.
Download (of active

environment)
Transmission of the Active Jobs file and other elements of the

CONTROL-M database to the ENTERPRISE/CS database. This
allows ENTERPRISE/CS to provide the user with a graphical
display of the current situation in the data center. Download
occurs upon completion of the New Day procedure, after which
updates are constantly issued to maintain the accuracy of the
graphical display.
Glossary 2
Enterprise
Controlstation
or ENTERPRISE/CS
Software product that provides a central point of control for

CONTROL-M data centers. ENTERPRISE/CS passes global
conditions among data centers.
Force
To force a job is to instruct CONTROL-M/Server to place the

job in the Active Jobs file for possible submission, regardless of
the scheduling parameters contained in Job Processing definition
for the job. See also Order.
Gateway
The process that handles communication between

CONTROL-M/Server and ENTERPRISE/CS. There are gateway
processes on both the Server platform and on the
ENTERPRISE/CS workstation.
General Daily
Procedure
See New Day Procedure.
Global Condition
A prerequisite condition that is passed between data centers

through ENTERPRISE/CS. Global conditions allow jobs in one
data center to be dependent on completion of a job in a different
data center.
Heartbeat Monitor
Special monitor that verifies that TCP/IP communication with

ENTERPRISE/CS is functional.
Job Processing
Definition
Set of user-defined parameters for each job that provide

CONTROL-M with detailed instructions on processing the job.
Job Processing definitions are organized into Scheduling tables.
Load Balancing
CONTROL-M mechanism for maximizing throughput of

production jobs by automatic selection of the platform to execute
each job, based on workload considerations.
Glossary 3
Manual Conditions
File
The Manual Conditions file contains prerequisite conditions that

are required by jobs in the Active Jobs file but that will not be
available (that is, added to the Conditions/Resources table)
unless there is some form of manual intervention. These
conditions include conditions that are never added automatically
by scheduled jobs because manual confirmation is always
desired, as well as conditions that are normally added
automatically, but the jobs that add them are not scheduled for
the day.
New Day Procedure
Formerly General Daily Procedure. Daily scheduling and

housekeeping procedures that run on the Server platform. The
CONTROL-M date is advanced to the next day when this
procedure runs.
Node Group
A user-defined collection of Node IDs. A node group is specified

in a Job Processing definition to indicate a group of Agent
platforms from which CONTROL-M/Server can select a
platform to execute the job.
Node ID
Name by which an Agent platform is identified to the Server

platform. This is generally the Agent platforms host name.
Odate (Original
Scheduling Date)
Jobs managed by CONTROL-M are assigned a date when they

are ordered (placed in the Active Jobs file). This date, referred to
as the Odate, is the CONTROL-M date when the job is ordered
and represents the date on which the job should be submitted for
execution. Odate is also the default date assigned to prerequisite
conditions when they are created. The variable ODAT
(representing the Odate) is used when defining job dependencies
to insure that a job waiting for completion of another job is only
triggered by a job with the same working date.
Order
To order a job is to request that CONTROL-M/Server review

the scheduling parameters contained in Job Processing definition
for the job and, if the parameters are satisfied, place the job in
the Active Jobs file for possible submission. See also Force.
Glossary 4
Prerequisite
Conditions or
Conditions
A flag representing a user-specified situation or condition.

Submission of a job for execution can be made dependent upon
the existence of one or more prerequisite conditions. Prerequisite
conditions are recorded in the Conditions/Resources table.
Quantitative Resource
User-defined variable representing a resource in the data center.

The user defines the total quantity of this resource in the data
center and, for each job, the quantity require/used by that job.
CONTROL-M/Server verifies that a job is not submitted for
execution unless the Quantitative resources required by the job
are available. Quantitative resources are recorded in the
Scheduling Table
A collection of related Job Processing definitions. Scheduling

tables are stored in the CONTROL-M database (and duplicated
in the ENTERPRISE/CS database). Scheduling tables are
ordered by the New Day procedure or User Daily jobs.
Server Platform
Platform on which CONTROL-M/Server runs. The Server

platform communicates with the ENTERPRISE/CS workstation
and with the Agent platforms.
Sleep Time
The length of time that a CONTROL-M/Server process lies

dormant during idle time before checking if any request to
perform an action was received. The value assigned to Sleep
Time affects CONTROL-M/Server throughput and load on the
Server platforms resources.
SQL Server
Software used by CONTROL-M/Server to maintain the

CONTROL-M database. The database can be maintained using
an existing MSSQL Server (provided by the user).
User Daily Job
User-defined job that can be used to automate the ordering of

production jobs.
Glossary 5
Glossary 6
Index
Index
A
Active Jobs file
ad hoc jobs 2-18
authorizing access to 3-5
description C-1
erasing contents 4-41
listing contents of 2-69, 4-35, 4-39
listing jobs by status 2-69
New Day procedure 1-12
performing actions on jobs 2-71
ad hoc job
creating 2-18
Agent communication parameters
defaults 4-27
description 5-13
during installation 7-13
modifying 4-28
Agent platform
communication status 2-9, 4-31
ctmpinglst utility 2-9
definition 1-2, C-1
Shout messages 1-26, 2-90
verifying communication 7-19
Agent Status menu
description 4-31
Agent-to-Server Port Number parameter
description 5-10
Application security 3-1

Authorizations
Active Jobs file 3-5
CONTROL-M entities 3-7
Scheduling table 3-4
summary 3-9
Authorized CONTROL-M/Servers file
overview 1-9, 1-11
Authorized CONTROL-M/Servers Registry
Key
usage A-8
Available (status)
description 1-7
C
Calendars
description C-1
Communication Diagnostic Report 4-36
Communication parameters
description 5-9
modifying 4-26
Communication Protocol parameter
description 5-10
Communication status
Available 1-7
ctmpinglst utility 2-9
Index
Disabled 1-7
Unavailable 1-7
Communication Timeout parameter
description 5-13
Conditions/Resources table
description C-2
Control resources
current usage 2-69
deleting 4-41
description C-2
listing 2-69, 2-104
CONTROL-M
description C-1
maintenance 4-4
menu system 4-6
product registry database 2-17
security facility 3-1
TCP/IP Port Number parameter 5-12
CONTROL-M Administrator
responsibilities 1-36
CONTROL-M database
automatic checking 4-5
backing up 2-23, 4-17
checking 2-24
checking available space 4-11
database configurations 6-2
defining jobs 2-28
maintenance 4-5
overview 1-5
parameters 5-14
percent utilization 2-24
rebuilding 2-62
restoring 2-28, 4-18
statistical data 2-46, 2-80
truncating log file 4-35
CONTROL-M date
Day Time parameter 5-4
description 1-12, C-1
Odate 1-12
CONTROL-M Date parameter
description 5-4
CONTROL-M Log
messages A-1
CONTROL-M log
cleanup by New Day procedure 1-13
fields B-1
listing/deleting entries 2-59
CONTROL-M Main menu
description 4-6
CONTROL-M Security database
maintenance utility ctmsec 3-12
CONTROL-M/Agent
Agent Configuration file 1-11
preparing for installation 6-2
CONTROL-M/Server
Host name 1-11
messages and codes A-1
processes 2-86, 4-37
starting/stopping 4-3, 7-20
user rights 7-18
Windows NT service 4-3, 7-20
Windows NT service user account 7-17
ctm_backup_bcp 2-7
ctm_ping utility 2-9
ctm_restore_bcp 2-11
ctm_suspend utility 2-86
ctmcontb utility 2-13
ctmcpt utility 2-17
ctmcreate utility 2-18
ctmdbbck utility 2-23
ctmdbcheck script 4-11
ctmdbcheck utility 2-24
ctmdbrst utility 2-28
ctmdefine utility 2-28
ctmfw utility 2-35
ctmjsa utility 1-29, 2-46
ctmldnrs utility 2-50

ctmloadset utility 1-10, 2-54
ctmlog utility 2-59
ctmmakedb utility 2-62, 4-10
ctmordck utility 2-64, 3-7
ctmorder utility 2-66
ctmping 2-9
ctmpsm utility 2-68
ctmrpln utility 2-76
ctmruninf utility 1-29, 2-80
ctmsec utility 3-12, 7-16
ctmshout utility 2-83
ctmshtb utility 1-25, 2-85
ctmsys utility 2-87
ctmudlst utility 2-96
ctmudly utility 2-97
ctmwhy utility 2-98
Customization parameters
description 5-1
modifying 4-24
platform coordination 5-2
D
database
rebuilding 2-62
Database Creation menu
description 4-10
Database Maintenance menu
description 4-17
Database parameters
description 5-14
Database server 4-9
Date Control Record
description 1-20
modifying manually 2-96
Day Time parameter
description 5-4
changing the clock 1-32
Diagnostic level
resetting 4-41
Disabled (status)
description 1-7
discovery 2-9
E
ecacontb utility 2-100
ecactltb utility 2-104
ecaqrtab utility 2-105
ENTERPRISE/CS
TCP/IP Port Number parameter 5-12
F
File Watcher Utility
service trace 2-45
File Watcher utility
description 2-35
Forcing a job
authorization to perform 3-5
description C-3
Full Security parameter
description 5-5
usage 3-2
G
Gateway
description C-3
GATEWAY user
Global conditions security 3-8
General Daily procedure 1-12
Global conditions
Index
description C-3
security considerations 3-8
H
Heartbeat Monitor
active mode 1-37
description 1-37
I
Ignore Conditions file
description 5-7
Ignore New Day Conditions
parameter usage 1-13
Ignore New Day Conditions parameter
description 5-6
init_prflag 4-41
Installation
CONTROL-M/Server startup 7-20
hardware/software requirements 7-2
procedures 7-3
SQL Server 7-5
uninstalling CONTROLM/Server 7-21
Windows NT service user account 7-17
J
Job ordering
manually 1-22, 2-66, 2-69
retroactive 1-21
Job Processing definition
description C-3
Job scheduling 1-14
L
Last Run date 1-20
Load balancing
description C-3
overview 1-10
resource usage 2-54
Local IP Host Interface Name parameter
description 5-9
for multiple interface cards 5-10
Log
CONTROLM 1-30
M
Main menu
description 4-6
Manager menu
description 4-8
Manual Conditions file
listing 2-53
Maximum Days Retained by CONTROL-M
Log parameter
description 5-5
Maximum Days to Retain Sysout Files
parameter
description 5-6
Maximum Retries parameter
description 5-13
Messages and codes
descriptions A-1
N
New Day procedure
Daylight Savings Time 1-32, 1-34
restarting 4-35
scheduling 1-14
Node group
description C-4
usage 1-10
Node Group menu
description 4-29
Node ID
definition 1-6, C-4
O
Odate
CONTROL-M Date parameter 5-4
ctmcontb utility 2-13
ctmcreate utility 2-19, 2-32
ctmpsm utility 2-72
New Day procedure 1-12
Operational parameters
description 5-12
modifying 4-26
Ordering a job
authorization to perform 3-5
description C-4
Output parameter 2-6
P
Parameter Customization menu
description 4-24
Performance parameters
description 5-16
Polling Interval parameter
description 5-13
Port numbers
CONTROLM/Server 4-35
Prerequisite conditions
adding/deleting/listing 2-13, 2-69, 2-100
deleted by New Day procedure 1-13,
5-6
deleting 4-41
description C-5
unscheduled conditions 2-50
prf
Show Process Flags 4-37
Processes
CONTROLM/Server 4-37
Production Support menu 2-68
Q
Quantitative resources
Agent platform usage 2-54
current usage 2-69
deleting 4-41
description C-5
maintaining/listing 2-69, 2-105
R
Reports
ctmpsm utility 2-69
ctmrpln utility 2-76
description 2-5
Restricted security level
description 3-2
Retro parameter
job processing 1-21
Retry Interval parameter
description 5-13
RUNINF_PURGE_LIMIT 1-13
Runtime statistics 1-28
Index
S
Scheduling tables
authorizing access to 3-4
defining jobs 2-28
description C-5
listing 4-36
listing jobs in 2-76
ordering/forcing jobs 2-69
report generation 2-69
Security
Agent platform 3-8
application 3-1
job statuses 2-64
levels 3-2
maintenance utility ctmsec 3-12
overview 3-3
restricted security level 3-2, 5-5
setting level 5-5
summary of authorizations 3-9
unrestricted security level 3-2, 5-5
Security Maintenance utility
Active Jobs file authorization 3-21
CONTROL-M entities authorization
3-25
description 3-12
Scheduling table authorization 3-17
Server platform
definition 1-2, C-5
Shout messages 2-90
Server-to-Agent Port Number parameter
description 5-13
shctm
Show All Processes 4-39
Shout Destination tables
active table 2-85
description 1-24
maintenance 2-87
specifying destinations 1-26

Shout facility
ctmcpt utility 2-17
description 1-24
shout to email 1-26
Shout messages
ctmshout utility 2-83
Daylight Savings Time 1-33, 1-34
Show All Processes
shctm 4-39
Show Process Flags
prf 4-37
silent keyword
ctmmakedb utility 2-62
Sleep Time
considerations 4-42
resetting 4-41
SQL interactive session
starting 4-36
SQL Server
configurations 6-2
description C-5
installation considerations 7-5
maintenance 4-5
starting/stopping 4-9
Start Day of the Week parameter
description 5-5
Starting/stopping CONTROL-M/Server 4-3,
7-20
Windows NT service mode 7-20
Statistics
compiling 2-46
deleted by New Day procedure 1-13
deleting 2-80
listing 2-46, 2-80
overview 1-28
summary mode 5-12
Statistics Mode parameter
description 1-29, 2-46, 5-12
Statistics parameter
description 1-29
stopping
CTM communication 2-86
suspending
CONTROL-M communication 2-86
Sysout files
cleanup by New Day procedure 1-13
days retained 5-6
System parameters
description 5-3
maintenance 2-87
Output parameter 2-6

reference table 2-4
reports 2-5
T
Troubleshooting menu
description 4-33
U
UDLAST
description 1-20
Unavailable (status)
description 1-7
Unknown (status)
description 1-7
Unrestricted security level
description 3-2
User Daily jobs
example 1-18
interruptions 1-22
last run date 2-96
listing job definitions 2-64
scheduling 1-14
utility ctmudly 2-97
User security authorizations 3-2
Utilities
description of 2-1
Index
Notes

Control-M Server For WindowsNT MSSQL Administrator Guide - V2.24.01

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Control-M Server For WindowsNT MSSQL Administrator Guide - V2.24.01

Enviado por

Direitos autorais:

Formatos disponíveis

CONTROL-M/Server for

Dec 31, 2000

Restricted Rights Legend

Contacting BMC Software

USA and Canada

Outside USA and Canada

(01) 713 918 8800

(01) 713 918 8000

BMC Software, Inc.

713 918 8800 or

713 918 8000

BMC Software, Inc., Confidential and Proprietary Information

BMC Software, Inc., Confidential and Proprietary Information

CONTROL-M/Server for Windows NT Administrator Guide

Before Contacting BMC Software

operating-system and environment information

sequence of events leading to the problem

commands and options that you used

product error messages

BMC Software, Inc., Confidential and Proprietary Information

BMC Software, Inc., Confidential and Proprietary Information

CONTROL-M/Server for Windows NT Administrator Guide

CONTROL-M Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

BMC Software, Inc., Confidential and Proprietary Information

CONTROL-M/Server for Windows NT Administrator Guide

BMC Software, Inc., Confidential and Proprietary Information

Preparing for CONTROL-M/Server Installation

Hardware/Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .6-1

Hardware/Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .7-2

Messages and Codes

Structure of CONTROL-M Log Entries

CONTROL-M/Server for Windows NT Administrator Guide

Production Control and Scheduling Solution . . . . . . . . . . . . . . . 1-1

BMC Software, Inc., Confidential and Proprietary Information

User Maintenance Menu User List . . . . . . . . . . . . . . . . . . . . . .3-15

BMC Software, Inc., Confidential and Proprietary Information

CONTROL-M/Server for Windows NT Administrator Guide

Communication Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

BMC Software, Inc., Confidential and Proprietary Information

ctmpsm Menu Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69

CONTROL-M/Server for Windows NT Administrator Guide

Two-Letter Codes for CONTROL-M Processes . . . . . . . . . . . . 4-37

BMC Software, Inc., Confidential and Proprietary Information

BMC Software, Inc., Confidential and Proprietary Information

CONTROL-M/Server for Windows NT Administrator Guide

About This Book

BMC Software, Inc., Confidential and Proprietary Information

About This Book

Preparing for CONTROL-M/Server Installation

Messages and Codes

Structure of CONTROL-M/Server Log Entries

BMC Software, Inc., Confidential and Proprietary Information

CONTROL-M/Server for Windows NT Administrator Guide

CONTROL-M/Agent Administrator Guide describes installation and

CONTROL-M Server/Agent Migration Guide describes the process

Enterprise Controlstation User Guide describes ENTERPRISE/CS

Enterprise Controlstation Administrator Guide describes

CONTROL-M/Desktop User Guide describes components used to

BMC Software, Inc., Confidential and Proprietary Information

About This Book

When describing keystrokes, angle brackets are

Menu => Option

This represents an option selection sequence. For