Control-M Workload Automation User Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 395

Control-M

9.0.00.500
User Guide

June 2017
Contacting BMC Software
You can access the BMC Software website athttp://www.bmc.com. From this website, you can obtain
information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada

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

Outside United States and Canada

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

© Copyright 1999-2017 BMC Software, Inc.


Your use of this information is subject to the terms and conditions of the applicable End User License
Agreement for the product and the proprietary and restricted rights notices included in this
documentation. No part of this publication may be reproduced, stored in a retrieval system, or transmitted
in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the
prior written permission of BMC Software, Inc.
BMC, BMC Software, the BMC logo, the BMC Software logo, and other BMC marks, and the tagline “Bring
IT to Life” are the exclusive properties of BMC Software, Inc., or its affiliates or subsidiaries and are
registered or may be registered with the U.S. Patent and Trademark Office and in other countries. All
other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or
in other countries. All other trademarks or registered trademarks are the property of their respective
owners.
For BMC Control-M Products that are licensed on the “per CPU – Full Capacity” unit of measurement and
installed in an Amazon Web Services (“AWS”) or Microsoft Azure (“Azure”) cloud environment, a license is
required for the total number of CPUs in each AWS or Azure instance upon which the Product is installed
or which the Product manages, either remotely or locally. For AWS, one CPU is equivalent to one vCPU, as
defined by AWS. For Azure, one CPU is equivalent to up to four Virtual Cores (as defined by Azure),
rounded up to the closest multiple of four.
Server Endpoint Licensing
All machines upon which any Control-M component is installed or upon which Control-M managed
workload runs must be licensed. This includes Control-M Agent platforms onto which one or more
application plug-ins are installed but also includes Control-M Agent platforms where no application plug-
ins are installed.
The licensing guidelines for application plug-ins are as follows:

2
 ERP and BI/DI: The application server(s) upon which Control-M managed processes are executed
should be licensed in addition to the Control-M Agent machine(s) (in some cases, this may be the
same machine).
 Databases: Each database server upon which Control-M managed database related processes are
being executed should be counted in addition to the Control-M Agent machine(s).
 AFT and MFT: Only the machine(s) upon which the AFT or MFT plug-in is installed should be licensed.
 Web Services, Java & Messaging: Only the Control-M Agent machine(s) upon which the plug-in is
installed should be licensed.
 Backup: The Control-M Agent machine(s) where the Backup plug-in is installed and also the hosts
which are running the backup server software should be licensed (note that this excludes the client
machines for which the Backup Server software is managing actual backup processes except where a
backup takes place of the backup server machine itself).
 Cloud: Only the Control-M Agent machine(s) upon which the plug-in is installed should be licensed.
 Hadoop: All machines in each managed Hadoop Cluster should be licensed.
IBM® Tivoli® Business Service Manager, IBM Tivoli Workload Scheduler, IBM Cognos, IBM InfoSphere
DataStage, IBM iSeries, IBM Websphere, and AIX® are the trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries, or both.
UNIX® is the registered trademark of The Open Group in the US and other countries.
Linux is the registered trademark of Linus Torvalds.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks
of their respective owners.
SAP® R/2 and SAP R/3, SAP Business Objects, and SAP NetWeaver are trademarks or registered
trademarks of SAP AG in Germany and in several other countries.
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER
THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and
computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Field
52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025,
as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD,
HOUSTON TX 77042-2827, USA. Any contract notices should be sent to this address.
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting
Customer Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at
(http://www.bmc.com/support). From this website, you can:

3
 Read overviews about support services and programs that BMC offers
 Find the most current information about BMC products
 Search a database for issues similar to yours and possible solutions
 Order or download product documentation
 Download products and maintenance
 Report an issue or ask a question
 Subscribe to receive proactive e-mail alerts when new product notices are released
 Find worldwide BMC support center locations and contact information, including e-mail addresses, fax
numbers, and telephone numbers
Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call
800 537 1813 or send an e-mail message to [email protected]. (In the subject line, enter
SupID:<yourSupportContractID>, such as SupID:12345). Outside the United States and Canada,
contact your local support center for assistance.
Before contacting BMC
Have the following information available so that Customer Support can begin working on your issue
immediately:
 Product information
• Product name
• Product version (release number)
• License number and password (trial or permanent)
 Operating system and environment information
• Machine type
• Operating system type, version, and service pack or other maintenance level such as PUT or PTF
• System hardware configuration
• Serial numbers
• Related software (database, application, and communication) including type, version, and service
pack or maintenance level
 Sequence of events leading to the issue
 Commands and options that you used
 Messages received (and the time and date that you received them)
• Product error messages
• Messages from the operating system, such as file system full
• Messages from related software
License key and password information

4
If you have questions about your license key or password, contact BMC as follows:
 (USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail
message to [email protected].
 (Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20
354 8702, or send an e-mail message to [email protected].
 (Asia-Pacific) Contact your BMC sales representative or your local BMC office.
Third party Software
For the provisions described in the BMC License Agreement and Order related to third party products or
technologies included in the BMC Product,
seehttps://docs.bmc.com/docs/display/workloadautomation/Control-
M+Workload+Automation+Documentation and click Third-party software (TPS).

5
Contents
Introduction to Control-M ................................................................................................ 9
Control-M login profiles ...................................................................................................................9
Control-M navigation .................................................................................................................... 12
Customized settings...................................................................................................................... 25

Planning ...................................................................................................................... 47
Creating a job .............................................................................................................................. 47
Connecting jobs ........................................................................................................................... 81
Connecting jobs from different Control-M/Servers .......................................................................... 82
Saving a Workspace ..................................................................................................................... 82
Restoring jobs/folders ................................................................................................................... 83
Comparing jobs ............................................................................................................................ 83
Removing jobs from a Workspace ................................................................................................. 84
Verifying JCL code in a job definition ............................................................................................. 84
Adding jobs to an existing Workspace ............................................................................................ 84
Checking in a Workspace .............................................................................................................. 85
Conflict Resolution ........................................................................................................................ 86
Resolving conflicts ........................................................................................................................ 86
Conversion validation.................................................................................................................... 87
Ordering jobs ............................................................................................................................... 87
Order parameters ......................................................................................................................... 89
Creating multiple jobs ................................................................................................................... 91
Editing a job ................................................................................................................................ 92
Folders ........................................................................................................................................ 93
Adding a variable ......................................................................................................................... 96
Job types ..................................................................................................................................... 97
Workspaces ............................................................................................................................... 197
Control-M Workload Change Manager .......................................................................................... 224
Version management .................................................................................................................. 232

Monitoring ................................................................................................................. 235


Viewpoints ................................................................................................................................. 235
Alerts Monitor ............................................................................................................................ 267
Service Monitor .......................................................................................................................... 268
Control-M MFT Dashboard .......................................................................................................... 278

6
History ...................................................................................................................... 282
Loading an archived Viewpoint .................................................................................................... 282
Playing back an archived event ................................................................................................... 283
Control-M Workload Archiving ..................................................................................................... 283

Forecast .................................................................................................................... 290


Setting up a Forecast Workspace................................................................................................. 290
Filtering the Forecast Workspace ................................................................................................. 291
Saving a filter criteria as a preset ................................................................................................ 291
Defining a Specific User Daily job ................................................................................................ 292
Editing a User Daily .................................................................................................................... 292
Deleting a Specific User Daily job ................................................................................................ 292
Why analysis .............................................................................................................................. 293
Setting up a Why analysis ........................................................................................................... 293
Forecast/BIM rules ..................................................................................................................... 294
Adding a What-If event from a Forecast Workspace ..................................................................... 304

Tools ......................................................................................................................... 305


Workspace management............................................................................................................. 308
Viewpoint management .............................................................................................................. 309
Site customizations management ................................................................................................ 312
Site standards management ........................................................................................................ 314
Folder management ................................................................................................................... 324
Templates .................................................................................................................................. 327
Promotion rules .......................................................................................................................... 330
Calendar management ................................................................................................................ 335
Control Resource management ................................................................................................... 342
Quantitative Resource management ............................................................................................ 343
Conditions management ............................................................................................................. 344
Global Conditions Prefixes ........................................................................................................... 346
Control-M Event Manager ........................................................................................................... 351
Service definition ........................................................................................................................ 368
Workload Policy Definition........................................................................................................... 377
Workload Policy Monitor ............................................................................................................. 382
Viewing jobs in a workload.......................................................................................................... 383
Periodic Statistics definition ......................................................................................................... 383
Communication management ...................................................................................................... 388
Pattern matching strings ............................................................................................................. 391

7
Newsfeed .................................................................................................................. 394

8
1
1
Introduction to Control-M
Control-M is a GUI application that enables you to define and schedule your production, which Control-M
uses to control job processing and handling. You can monitor your production, and intervene when
necessary. Control-M enables you to do the following:
 Define job flows (on page 47): In the Planning domain, you can create job processing definitions and
other needed entities. After job processing definitions have been defined for your jobs, you can
perform several tasks to transition your definitions to production in the Planning domain. As part of
this transition, you can automate the ordering of jobs each day.
 Monitor active jobs (on page 235): In the Monitoring domain, you can monitor and intervene in the
processing of your production jobs in the Monitoring domain.
 View and analyze active jobs from the past (on page 282): In the History domain, you can review,
track, and analyze problems of previous days in the History domain.
 Simulate your plan on a future day (on page 290): In the Forecast domain, you can determine the
likely impact of potential changes to the system in the Forecast domain.
 Use Control-M Tools (on page 305): In the Tools domain, you can analyze areas that can be
improved, such as resource allocation and workload balancing in the Tools domain or you can use the
tools available from the ribbon.
The following topics describe login profiles, navigation, and customized default settings:
 Control-M login profiles (on page 9)
 Control-M navigation (on page 12)
 Customized settings (on page 25)

Control-M login profiles


The Control-M login profiles represent the specific Control-M EM GUI servers (GSR) that you use to
connect to different environments. This enables you to switch between environments without
reconfiguring the hosts, ports, and server names.
Each GSR connects to the associated Control-M/EM servers. For example, you can set the GSR to connect
to your testing, development, or production environment.
The following procedures describe how to log in to Control-M, and to create or change your login profile:
 Logging in to Control-M (on page 10)
 Creating a login profile (on page 10)
 Editing a login profile (on page 10)
For more information about Changing the password (on page 388) , and other communication issues such
as Connectivity problems (on page 389) and Control-M Servers Communication status (on page 389), see
Communication management (on page 388), or contact your Administrator.

9
Control-M User Guide

Logging in to Control-M
This procedure describes how to log in to Control-M.

 To log in:
1. From your desktop, select the Control-M icon.
2. Type your user name and password.
NOTE:
 If the Local User checkbox appears and is selected, you can log in without typing a username
and password. If you want to log in as a different user, uncheck the checkbox and type a
different username and password.
 If your are logging in with an RSA token, type your RSA username, token ID, and password.
3. Set the Server and Environment fields, as described in Login Profile selection parameters (on page
12) .
4. If the Change Password field appears, your password is about to expire. Type your new password,
and then confirm it.
5. Click Log In.
You are now logged in to Workload Automation Planning domain. You can define jobs as described
in Job definition.

Creating a login profile


This procedure enables you to switch between environments without having to reconfigure the hosts,
ports, and server names, and to configure the application to automatically detect the first available server.
 To create a login profile:
1. In the Control-M login screen, select Environment.
2. Click .
3. In the Choose Server dialog box set the parameters, as described in Login Profile selection
parameters (on page 12).
4. Click OK.
The login profile is created and is selected in the login screen. To log in, see Logging in to Control-M
(on page 10).

Editing a login profile


This procedure enables you to configure your environment to the correct hosts, ports, and servers, and to
configure the application to automatically detect the first available server.

 To edit a login profile:


1. In the Control-M login screen, select Environment.
2. Click .

10
Control-M User Guide

3. In the Choose Server dialog box, type the parameters as described in Creating a login profile (on
page 10).
4. Click OK.
The login profile is edited and is selected in the login screen. To log in, see Logging in to Control-M
(on page 10).

Deleting a login profile


This procedure describes how to delete the login profile.
 To edit a login profile:
1. In the Control-M login screen, select Environment.
2. Select any of the rows, except the default environment.
3. Click .
4. In the confirmation dialog box, click Yes.
The selected login profile is deleted, and a different environment is selected in the login screen.

Logging out of Control-M


This procedure describes how to log out of Control-M.

 To log out:
1. From any domain, click the File tab.
2. Select Exit.

11
Control-M User Guide

Login Profile selection parameters


Login Profile Selection parameters enable you to connect to Control-M/EM GUI server for your
environment from the Control-M client:

Parameters Description

Environment Defines the name of the environment, such as Test or


Production.

Naming Server Defines the name of the following Naming Server fields:
 Host: Defines the name of the server where the Naming
Service lists the Control-M/EM GUI servers for the
environment.
 Port: Defines the port of the server where the Naming
Service lists the Control-M/EM GUI servers for the
environment.

Automatically Detect Defines whether the Server field (Control-M/EM GUI server)
is connected automatically based on availability.

Server Defines which Control-M/EM GUI server in the Naming Service


list, to connect to.

Domain Optional. Defines which LDAP domain associated with Control-


M/EM GUI server in Server list, to connect to.

Control-M navigation
From the Control-M client, you can learn about the following domains by viewing the following figures:

12
Control-M User Guide

 Planning: Enables you to create job processing definitions. After job processing definitions have
been defined for your production jobs, you can perform several tasks to transition your definitions to
production, as described in Planning domain (on page 14).
 Monitoring: Enables you to monitor and intervene in the processing of your production jobs, as
described in Monitoring domain (on page 17).
 History: Enables you to review, track, and analyze problems of previous days, as described in History
domain (on page 19).
 Forecast: Enables you to determine the likely impact of potential changes to the system, as
described in Forecast domain (on page 21).
 Tools: Enables you to analyze areas that can be improved, such as resource allocation and workload
balancing, as described in Tools domain (on page 23).
 Newsfeed: Enables you to view a collection of Control-M discussions from social networks, blogs,
and forums, such as Facebook, Twitter, and BMC Communities, as described in Newsfeed domain (on
page 24).

13
Control-M User Guide

Planning domain
The following figure shows a Workspace in the Planning domain:

The following table describes the areas in the Planning domain in Control-M :

14
Control-M User Guide

Callout Area Description

1 Ribbon Displays menus that enable you work in the domain, find the
tools related to the domain, customize the view, and analyze
your flow

2 Find pane Displays a simple and advanced search for finding entities in your
flow. The results of the search, appear in the Overview area,
along with results, such as validation reports.

3 Main pane Displays the jobs and folders in the domain. You can display the
area as a Map or List

4 Status banner Displays whether the job is new or updated

5 Tree pane Lists the entities according to the defined hierarchy in the View
tab

6 Domain selector Lists the various functional areas in the application where you
can plan, monitor, view history, forecast, use tools, and view
Newsfeed

7 Results pane Displays results such as results of Find and Validation report,
Show Changes results, and displays the Network Overview. The
thumbnail version of the flow diagram currently displayed in the
Main pane with the following color indications when the Main
pane is set to Map:
 Green (new)
 Blue (modified)
 Grey (unchanged)
 Yellow (Control-M/Server, Application, and Sub Application)

8 Status bar Displays information about the flow diagram

9 Notification bar Displays a window that reports the latest Workload Automation
action, and if it was a success. You can also view the Action
Report.

10 Help bar Displays a description of the selected job or folder field, and
enables you to select a link for more information related to the
specific field

11 New Alerts Displays a window that notifies you about events in your
notification production environment, and enables you to click on a link to
window open the Alerts Monitor

12 Properties pane Displays the properties of the selected entity

15
Control-M User Guide

Callout Area Description

13 Reconnection Displays the status of the application to connect to the server


window

16
Control-M User Guide

Monitoring domain
The following figure shows a Viewpoint in the Monitoring domain:

The following table describes the areas in the Monitoring domain in Control-M:

17
Control-M User Guide

Callout Area Description

1 Ribbon Displays menus that enable you work in the domain, find the
tools related to the domain, customize the view, and analyze
your flow

2 Main pane Displays the jobs and folders in the domain. You can display the
area as a Map or List

3 Tree pane Lists the entities according to the defined hierarchy in the View
tab

4 Domain selector Lists the various functional areas in the application where you
can plan, monitor, view history, forecast, use tools, and view
Newsfeed

5 Results pane Displays results such as results of Find and Validation report,
Show Changes results, and displays the Network Overview. The
thumbnail version of the flow diagram currently displayed in the
Main pane with the following color indications when the Main
pane is set to Map:
 Green (new)
 Blue (modified)
 Grey (unchanged)
 Yellow (Control-M/Server, Application, and Sub Application)

6 Status bar Displays information about the flow diagram. In the Service
Monitor, it displays information about the status of services.

7 Notification bar Displays a window that reports the latest Workload Automation
action, and if it was a success. You can also view the Action
Report.

8 Properties pane Displays the properties of the selected entity. You can also view
analysis information can from this pane.

18
Control-M User Guide

History domain
The following figure shows an Archived Viewpoint in the History domain:

The following table describes the areas in the History domain in Control-M :

19
Control-M User Guide

Callout Area Description

1 Ribbon Displays menus that enable you work in the domain, find the
tools related to the domain, customize the view, and analyze
your flow

2 Main pane Displays the jobs and folders in the domain. You can display the
area as a Map or List

3 Tree pane Lists the entities according to the defined hierarchy in the View
tab

4 Domain selector Lists the various functional areas in the application where you
can plan, monitor, view history, forecast, use tools, and view
Newsfeed

5 Results pane Displays results such as results of Find and Validation report,
Show Changes results, and displays the Network Overview. The
thumbnail version of the flow diagram currently displayed in the
Main pane with the following color indications when the Main
pane is set to Map:
 Green (new)
 Blue (modified)
 Grey (unchanged)
 Yellow (Control-M/Server, Application, and Sub Application)

6 Status bar Displays information about the flow diagram

7 Properties pane Displays the properties of the selected entity

20
Control-M User Guide

Forecast domain
The following figure shows a Forecast Workspace in the Forecast domain:

The following table describes the areas in the Forecast domain in Control-M :

21
Control-M User Guide

Callout Area Description

1 Ribbon Displays menus that enable you work in the domain, find the
tools related to the domain, customize the view, and analyze
your flow

2 Main pane Displays the jobs and folders in the domain. You can display the
area as a Map or List or Gantt chart

3 Tree pane Lists the entities according to the defined hierarchy in the View
tab

4 Domain selector Lists the various functional areas in the application where you
can plan, monitor, view history, forecast, use tools, and view
Newsfeed

5 Results pane Displays results such as results of Find and Validation report,
Show Changes results, and displays the Network Overview. The
thumbnail version of the flow diagram currently displayed in the
Main pane with the following color indications when the Main
pane is set to Map:
 Green (new)
 Blue (modified)
 Grey (unchanged)
 Yellow (Control-M/Server, Application, and Sub Application)

6 Status bar Displays information about the flow diagram

7 Properties pane Displays the properties of the selected entity

22
Control-M User Guide

Tools domain
The following figure shows all the main tools in the Tools domain, which includes the Options where you
can customize your application settings for all the domains:

The following table describes the areas in the Tools domain in Control-M :

Callout Area Description

1 Ribbon Displays menus that enable you work in the domain, find the
tools related to the domain, customize the view, and analyze
your flow

2 Domain selector Lists the various functional areas in the application where you
can plan, monitor, view history, forecast, use tools, and view
Newsfeed

23
Control-M User Guide

Newsfeed domain
The following figure shows the layout of the Newsfeed domain, which highlights the different Newsfeed
channels:

The following table describes the areas in the Newsfeed domain in Control-M .

Callout Area Description

1 Ribbon Displays the available Newsfeed actions: Refresh, Delete, Read,


and Unread

2 Newsfeed Items Displays the Newsfeed items from the selected Newsfeed
channel

3 Newsfeed Channels Displays the available Newsfeed channels, such as Twitter,


Facebook, and BMC forums

4 Domain Selector Lists the various functional areas in the application where you
can plan, monitor, view history, forecast, use tools, and view
Newsfeed items

5 Reading pane Displays the content of the selected Newsfeed item

24
Control-M User Guide

Job View
Control-M enables you to view the status of active and planned jobs in the following views:
 List view: Enables you to view running and planned jobs in a list view.
 Map view: Enables you to view running and planned jobs in a map view. This view shows job status
defined by the color as described in Active Job statuses (on page 240), start/end time or estimated
start/end time as described in Run time estimation information (on page 240).
 Gantt view: Enables you to view running and planned jobs in gantt view.
The Gantt view shows running jobs over a time span from the start of a New Day to its end (which is
the start of the next New Day). Previous day runs are not shown on the time span. Each job,
represented by a bar, shows the start, duration, and the end of the running job. The horizontal line
that constantly moves, helps distinguish jobs that are still running or have already ran.
For Application, Sub-application, and Smart folder, the timeframe of the bar begins from the job with
the earliest start time to the job with the latest end time.
The Gantt view shows future jobs based on BIM estimations, dependencies, and cyclic jobs, as
follows:
• BIM: The bar shows estimated start/end times based on run time estimations of jobs from
previous days.
• Dependencies: Dependencies on a gantt chart show dependencies between jobs across a time
span. Map view only shows dependencies between jobs in a flat hierarchy frame. If BIM is
installed, the Gantt view shows future job runs based on run time estimation as described in
Active Job analysis (on page 237).
• Cyclical jobs: The bar shows several bars, each bar representing the job in the cycle. You can
view a set of cyclical jobs where there are dependencies.

Customized settings
You can customize various defaults for the Control-M client, as described in Customizing your default
settings in the Workload Automation client (on page 29).

25
Control-M User Guide

The following table describes the main categories for settings that you can customize:

26
Control-M User Guide

Option type Description

Planning (on page 30) Enables you to set the following options for the Planning domain:
 Security
 Workspace Automatic Save
 Validity checks
 Dependency setting
 Condition Inheritance
 Job Definition counters

Monitoring (on page 33) Enables you to set the following options for the Monitoring domain:
 Startup
 Open into local view
 Automatic refresh

Forecast (on page 36) Enables you to set the following options for the Forecast domain:
 Color Settings
 Forecast Calendar
 Display
 What-If Scenario

Job Properties (on page Enables you to select to show Help Bar for the Definitions window.
37)

Maps (on page 38) Enables you to set the following options for the Map for all the domains:
 Background colors
 General settings
 Host Settings

Alerts (on page 41) Enables you to set new alert notification options.

Confirmation settings Enables you to set confirmation settings for domains and tools.

27
Control-M User Guide

Option type Description

Notification Settings Enables you to determine whether to receive notifications for actions from
the following tools:
 Actions
 BSM
 Calendars
 Control Resources
 Folder Manager
 Forecast
 Show History
 Workload Policies
 Workspace
 Workspace Manager

External Programs (on Enables you to add application settings for external programs.
page 41)

Advanced (on page 42) Enables you to set the following Advanced options:
 Preset path
 Action Report
 Reconnections

Diagnostics (on page 44) Enables you to set the following diagnostics options:
 Log levels
 Log files

Newsfeed (on page 45) Enables you to configure appearance, refresh rate, and proxy server settings
for Newsfeed.

28
Control-M User Guide

Customizing your default settings in the Workload Automation


client
This procedure describes how to customize your default settings in the Workload Automation client.

 To customize your default settings in the Workload Automation client:

1. From the Tools domain, click or from File select Options.


The Options window opens.
2. Select the option type on the left panel, as described in Customized settings (on page 25).
3. Click OK.
The settings take effect.

29
Control-M User Guide

Planning settings
This table describes the Planning domain options for customizing your settings in the Control-M client:

30
Control-M User Guide

Option type Description

Security Resolve job’s 'Created By' field conflict: Defines how to handle situations
where the name of the user, who saves to Control-M Workload Automation,
does not match the Created By name. Select one of the following:
 Change Automatically: Name of the user automatically resets without
prompting the user for confirmation.
 Prompt Before Changing: Control-M prompt the user for confirmation
before changing the name of the Run As user.
For more information, see Control-M security.

Workspace Workspace Automatic Save Interval (minutes): Defines the time in


Automatic Save minutes when to automatically save your Workspace.

Validity Checks Allow Check in and Export with Validation Errors: Enables you to check
in and export your workspace with validation errors.

Links Setting Add Out Condition with minus sign when creating job dependency:
Enables you to add an Out Conditions with a minus sign when creating Job
dependencies. Out Conditions, which have been deleted, appear with dotted
lines.
Create unique names for conditions: Enables you to add a postfix of a
random number to a condition when another condition with the same name
already exists.
If this option is disabled, and a condition with the same name is created, a
single condition is linked to multiple destinations.
NOTE: If enabled, Update condition name when property changes option is
disabled.
Update condition name when property changes: Enables you to
automatically update the condition name when the source and/or target
property is changed. If not selected, the condition name is not updated
automatically.
Condition Format: Defines the default condition format used when you
create job dependencies by dragging between job hosts in Control-M flow
diagram. Select one of the following conditions:
 [Job/Folder Name]-TO-[TargetJob:Job/Folder Name]
 [Job/Folder Name]-ENDED-OK
 [File/Member Name]-ENDED-OK
 [File/Member Name]-TO-[TargetJob:File/Member Name]

31
Control-M User Guide

Option type Description

Condition Automatically inherit Deleted Job's conditions: Enables you to


Inheritance automatically inherit a deleted job's conditions. By selecting the check box, a
connection continues between a deleted job’s predecessor and successor jobs.
It removes the dependency between the deleted job and its successor (by
removing the Out condition of the deleted job and the In condition of the
successor job that created the dependency).
This option only works if you delete one job at a time and in a checked out
workspace. If you delete multiple jobs in a single delete action, the connection
is lost regardless of the setting.

Job Definition Counter: Defines the number of jobs. You can set the counter to start from a
minimum number of jobs.

Check Out Enables you to view the check out notification bar when you check out a
notification Workspace.

Conversion Use Conversion Validation: Enables you to view and handle conversion
messages, which have been generated by the Conversion Tool. You can also
view jobs that were converted from another scheduler or application to
Control-M.
Messaging Mapping File: Enables you to import the
ConversionMessagesMapping.csv file, which is automatically generated when
running a conversion in the Conversion Tool. The file contains the conversion
messages and details of jobs that were converted to Control-M. The
ConversionMessagesMapping.csv file is located in <conversion
home>\workarea\datasources.
For more information about Conversion validation, see Conversion validation
(on page 87).

32
Control-M User Guide

Monitoring settings
This table describes the Monitoring options for customizing your settings in the Control-M client:

33
Control-M User Guide

Option type Description

Startup Auto open viewpoint: Defines how to automatically open a viewpoint by


selecting one on the following:
 Select
 Last Viewpoint
 Display "Open viewpoint" dialog
Leave the field unchecked to display an empty Viewpoint when you start a
session.

Select Enables you to automatically open a viewpoint by filtering your criteria by


selecting one of the following from the drop-down list:
 All Active Jobs
 By Application
 By Description
 By Owner
 By Status
 By Folder
 By <name of your saved viewpoint>

Last Viewpoint Enables you to open the last-opened viewpoint from the previous session.

Display "Open Enables you to open the viewpoint dialog box, allowing you to view a viewpoint
ViewPoint" dialog dialog box for the current session.

34
Control-M User Guide

Option type Description

Open into Local Enables the job that prompts an alert and the jobs having a dependency
View relationship with that job, to display in a Viewpoint.
Use Radius of: Defines the level of dependencies where jobs are selected and
displayed in a Viewpoint.
Viewpoint Name: Defines the Viewpoint into which the jobs should be
displayed. You can chose one of the following:
 All Active Jobs
 All Jobs
 By Application
 By Description
 By Owner
 By Status
 By Folder
 By <name of your saved viewpoint>
BMC Software recommends that you choose a viewpoint containing All jobs. If
you choose a viewpoint that does not have a collection of all jobs, hosts not
included in the collection do not display. Non-pin collections may have a poor
response time.

Automatic refresh Reload active net: Enables information from Control-M to be updated
automatically in Control-M Workload Automation. If not selected, you must click
Refresh in Control-M, in order to display the latest changes in Production.

35
Control-M User Guide

Forecast settings
This table describes the Forecast options for customizing your settings in the Control-M client:

Option type Description

Color Settings Enables you to choose the color settings for the job hosts in the forecast flow
diagram for executed and not executed jobs.

Forecast Calendar Start day of the week: Enables you to select the day of the week on which a
business week starts in the Forecast multiple hosts calendar display.
Maximum Jobs per Forecast Action: Enables you to set the maximum
number of jobs included in the Forecast multiple hosts calendar display.

Display Display Execution Time: Enables you to choose a time reference when
displaying the execution time in the job host or Gantt chart by selecting local
time or the time according to the Control-M/Server.
Display Seconds in Execution time: Enables you to view the execution time
in seconds.
Business Service Critical Path: Defines the job path that has the most impact
on the completion time of the service by displaying according to the following
options:
 Show complete path: Enables you to see the entire critical path
 Show until first gap: Enables you to see part of the critical path that has
the most direct impact on the completion time.
The critical path is indicated in the flow diagram by special markings on the job
hosts. If Forecast predicts that the Business Service is delayed, the user can
examine the jobs in the critical path to determine what factors are delaying the
jobs.
Show Control-M New Day indicators in Gantt view: Enables you to see
red vertical lines in the Gantt chart that indicate the beginning of the New Day
for each Control-M.
Changes only take effect after forecast refresh or it is restarted.

What if Scenario Automatic ‘Run Forecast' on scenario update: Enables you to automatically
run a forecast when the What-If scenario is changed.

36
Control-M User Guide

Job Properties settings


This table describes the Job properties view options for customizing your settings in the Control-M client:

Option type Description

Show Help Bar on Enables you to view the Help Bar in the Properties pane.
Definitions
Window

Job's Output External Viewer: Enables you to select an external program to view the job's
output.

Time Synonym Enables you to change the time fields from the default time to NewDay time plus
23.59

37
Control-M User Guide

Map settings
This table describes the Map options for customizing your settings in the Control-M client:

Option type Description

Background colors Enables you to set the background color for the following:
 Planning Workspace
 Monitoring ViewPoint
 History ViewPoint
 Forecast Workspace

General Settings Display jobs in columns of: Enables you to limit the number of columns with
no links in a column. Jobs with no links are placed in columns.
The following options are divided into Workspace and Viewpoint, which enables
you to set different values. Viewpoint usually contains a higher amount of jobs
than Workspace.
Display minus links: Enables you to see deleted Out Conditions (dotted lines).
Display Dependencies raised by On-Do action: Enables you to see Job
dependencies raised by On/Do Actions (dotted lines).
Display Optional Dependencies (In Condition Expression) as Dotted
lines: Enables you to display optional Job dependencies, which waits for In
Conditions (on page 73) (dotted lines). If there is more than one In Condition
you may want to see the relationship of the dependencies.
At Start display all nodes expanded: When starting, job nodes are
automatically expanded to include levels lower than the current selected host.

Node Settings These settings are divided into Workspace and Viewpoint, which enables you to
change the node fields.
First Display Field: Enables you to select the information displayed in the first
field of the node body of your workspace and/or viewpoint. The default for
workspace and viewpoint is File/Member Name.
Second Display Field: Enables you to select the information displayed in the
second field of your host body of your workspace and/or viewpoint.
NOTE: A third display field appears in 130% view size only.
Width: Enables you to select the width of the field.

38
Control-M User Guide

Confirmation settings
The Confirmations panel determines which confirmation requests and warnings should be displayed for
various options. You can set alerts, warnings and confirmation requests. Confirmation settings are divided
into sections:

39
Control-M User Guide

Option type Description

Alerts Enables you to apply confirmation settings to update alert details, as described
in Alerts Monitor (on page 267).

BSM Enables you to apply confirmation settings for BSM assumption changes, as
described in BSM configuration procedures.

Calendars Enables you to apply confirmation settings for calendar options, as described in
Calendar management (on page 335).

Conditions Enables you to apply confirmation settings for deleting conditions, as described
in Deleting a condition.

Forecast Enables you to apply confirmation settings for loading large forecasts and/or
delete Preset definition, as described in Control-M/Forecast.

Global Prefixes Enables you to apply confirmation settings for deleting global prefixes, as
described in Deleting a Global Conditions Prefix (on page 347).

Log out Enables you to apply confirmation settings when you log out of Control-M .

Monitoring Enables you to apply confirmation settings for monitoring options, as described
in Monitoring (on page 235).

Periodic Statistics Enables you to apply confirmation settings to periodic statistics definition
changes, as described in Periodic Statistics definition (on page 383).

Presets Enables you to apply confirmation settings to delete preset definitions, as


described in Saving and loading a preset search (on page 206).

Quantitative Enables you to apply confirmation settings to delete resource, as described in


Resources Deleting a quantitative resource.

Service Definitions Enables you to apply confirmation settings to delete a service or a rule, as
described in Service definitions (on page 369).

Templates Enables you to apply confirmation settings to delete a template definition, as


described in Deleting a template (on page 330).

Workload Policies Enables you to apply confirmation settings to apply workload changes or delete
Definitions workload definitions, as described in Workload Policy Definition (on page 377).

Workspace Enables you to apply confirmation settings for various workspace options, as
described in Workspaces.

Workspace Enables you to apply confirmation settings for various workspace manager
Manager options, as described in Workspace management (on page 308).

40
Control-M User Guide

Alerts settings
This table describes the Alerts options for customizing your settings in the Control-M client:

Option type Description

New Alert Defines how Control-M handles notifications when it receives new alerts. Click
Notifications one of the following:
 Display tray notification toast: Enables a notification bar to appear when
you receive an alert.
 Open Alerts Monitor tab: Enables a new alert monitor tab to appear
when you receive an alert.
 Play sound: Enables a sound to play whenever there is an alert.

External Programs settings


This table describes the application settings for customizing your settings in the Control-M client:

Option type Description

Application Application: Defines the name of the application you want to integrate with
Settings Control-M client.
Program: Defines the name of the program where to run from.
Initial Dir: Defines the directory where the program runs from. For more
information about the directory, see Parameters.
Parameters: Enables you to use job parameters from the monitoring
environment. For more information about the parameters, see Parameters.

41
Control-M User Guide

Advanced settings
This table describes the general options for customizing your settings in the Control-M client:

42
Control-M User Guide

Option type Description

Presets path Defines the default location for filter presets. You can click to select a different
location.
 Refresh quantitative resource list interval (seconds): Enables
automatic update of the status of resources in Active Jobs Database in
Quantitative Resources windows. You can set the automatic update
according to the number of seconds.
 Refresh control resource list interval (seconds): Enables automatic
update of the status of resources in Active Jobs Database in control
Resources windows. You can set the automatic update according to the
number of seconds.
 Refresh condition list interval (seconds): Enables automatic update of
the status of resources in Active Jobs Database in condition Resources
windows. You can set the automatic update according to the number of
seconds.

Action Report Keep last <n> lines: Defines the maximum number of job and folder actions
displayed in the Action Report window. If more than the specified number of
messages are issued, the oldest messages are removed from the window. You
can select any number from 10 to 999. The default is 200.

Reconnection If the connection to Control-M client is lost, Control-M/EM attempts to reconnect


Attempts to the first server in a user-defined list of alternative servers and continues to
reconnect to the next available server. You can set a number of defaults as
follows:
 Automatically reconnect for GUI server: Enables Control-M/EM to
reconnect to Control-M client automatically without user intervention
(automatic mode).
You can monitor and intervene where necessary while the connection is
being reestablished.
 Max reconnection retries: Defines the number of reconnection attempts
Control-M/EM should make. The default is 5 reconnection attempts.
 Wait <sec> seconds between reconnection attempts: Defines the
number of seconds Control-M/EM must wait between reconnection attempts.
The default is 5 seconds.

Localization Determines the language locale of the Control-M client.


THe following languages are supported:
 Deutsch
 English
 French

43
Control-M User Guide

Option type Description

Archive  Maximum Archived Jobs in Search Results: Determines the maximum


number of search results that you can receive for each search request.
 Compress Data on Save: Compresses the size of the text file when you
save a job log or output.

Diagnostics settings
This table describes the diagnostic options for Control-M client:

Option type Description

Log Levels Enables you to set the log levels as follows:


 Trace: Defines the highest level of tracing information which may affect
application performance
 Debug: Defines detailed information including the steps of an event,
parameters, and for developer diagnostic information.
 Information: Defines information about the basic functionality of the
application. Useful information that helps you and support find reasons for
an error. Performance should not be affected.
 Error and Warnings: Error messages: Defines errors that can cause the
application to malfunction or crash at a later time (CORBA exceptions).
Warning messages: Defines unexpected events that do not stop the
application but may limit functionality.
Click the default button to return to your default settings.

Keep log level for Enables you to keep the log level for your next session.
next application
runs

Log Files Enables you to view your log files where data is generated:
 General: Enables you to view time level and a message summary.
 Details: Enables you to view information including the time, level message
and detailed information.
 Dump: Enables you to view debug and information including, time level,
message and thread. You can view in this only where there is a major
problem.

44
Control-M User Guide

Newsfeed settings
The following table describes the configuration settings for Newsfeed in the Control-M client.

Option type Description

Show Newsfeed Determines whether to show the Newsfeed in the Control-M


client

Automatically refresh news every Determines the number in minutes when to automatically refresh
<number_of_minutes> minutes the newsfeed

News Channels: Determines which sites and forums appear in the Newsfeed, such
as Facebook, Twitter, and other blog and forum sites

Deleting a filtering rule


This procedure describes how to delete a filtering rule:

 To delete a filtering rule:


1. In a Control-M Workload Automation Workspace, select .
The Find fields appear at the top of the Map view.

2. Click .
The Advanced Find dialog box appears.
3. Do one of the following:
• To delete all the rules, click Clear.
All the Advanced Filtering rules are deleted.
• To delete one rule, select the row to delete, and click .
The Advanced Filtering rule is deleted.

Bookmarking a job
This procedure describes how to bookmark a job in the planning, monitoring, history and forecast
domains. You can bookmark a job to easily navigate between jobs in a long or complicated job flow.
 To bookmark a job:
1. In the main pane of the selected domain, select the job to bookmark.
2. From the View group, click Toggle Bookmark to add/remove a bookmark from a job. You can also
use the keyboard shortcut CTRL + F2.

is added to the job that is bookmarked.

45
Control-M User Guide

3. Do one or more of the following:


a. To view a list of the jobs that are bookmarked in the Results pane, click Bookmarks List or use
the keyboard shortcut CTRL + B.

b. To navigate between bookmarks in the job flow, click / .

Saving a job flow diagram to an EMF file format


This procedure describes how to save a job flow diagram to an EMF file format. This EMF file format is a
picture image file format. This file format provides you with a full view of the job flow.
You can save a job flow diagram from the Planning, Monitoring, History or Forecast domain.

 To save a job flow:


 While in Map view of a job flow, click File > Save As and select the EMF file format.
You can open the file for editing in any supported program such as MS Visio.
NOTES:
 In MS Visio, from the Open dialog box, select the Enhanced Metafile type to open the EMF file
you saved in Control-M
 You can edit the job flow diagram by selecting the Ungroup option

Detaching a Workspace or Viewpoint


This procedure describes how to detach your Workspace or Viewpoint to a separate window.

Before you begin


Ensure you are in an open Workspace or Viewpoint.

 To detach a Workspace or Viewpoint:


 From the File menu, select Detach to Separate Window.
The Workspace or Viewpoint appears as a standalone window.

Attaching a Workspace or Viewpoint window


This procedure describes how to attach your Workspace or Viewpoint window to the Main window.
Before you begin
Ensure you are in a Workspace or Viewpoint that is open in a separate window.

 To attach a Workspace or Viewpoint window:


 From the File menu, select Attach to Main Window.
The Workspace or Viewpoint appears in the Main window.

46
2
2
Planning
You can define your job flows in the Planning domain of Control-M according to your site flows, priorities,
and other criteria. You can set up a Workspace, and define job processing definitions which Control-M
uses to control job processing and handling, as described in the following topics:
• Setting up a Workspace (on page 198): Define and review your job flow by working in a
Workspace by doing one of the following:
o Create a new job flow: You can create a new job flow, by selecting blank Workspace.
o Continue working on a job flow: You can continue working on a job flow by selecting a
Workspace that you or a colleague previously set up.
o Load existing jobs: You can load existing jobs and folders or load a copy of existing jobs
and folders.
• Design your flows in the Workspaces: After you set up your Workspace, you can implement the
job design in the Workspace. You can check out and edit the Workspace, and save the Workspace
to a Central repository. You can continue working on a saved copy of the checked out Workspace,
even if you close it. To commit the changes, you can check in the Workspace, so that the jobs are
eligible for ordering. For information on Workspace management, see Workspace management
(on page 308).
• Job definition: You can design the job flows or make modifications to the existing jobs using
Control-M. This includes defining resources, global conditions, and setting up automated job
scheduling.
• Handle a Request Workspace (on page 224): For Control-M Workload Change Manager users, you
can receive, own, and handle requests.
• Navigate in the Planning domain (on page 14): You can find what you need in the Planning
domain to enable you to create job processing definitions, change the view of the jobs, and use
Planning tools. You can also perform several tasks to transition your definitions to production.
After job processing definitions have been defined for your production jobs, you can perform
several tasks to transition your definitions to production.
For more information about Control-M, see Getting Started.

Creating a job
This procedure describes how to create a job, which defines what, where, and how a job runs.

Before you begin


Successful completion of the following:

47
Control-M User Guide

 Creating a Workspace (on page 198)


 Checking out a Workspace (on page 202) if you loaded folders. A blank Workspace or an existing
Workspace are already checked out.
 Uploading agent utilities to remote hosts if you use an OVMS agentless solution or for converting an
agent to a remote host without changing your scripts.

 To create a job:
1. From the Workspace tab, New area, drag and drop one of the job templates from the New group
(Job Palette) into the Workspace or an existing folder.
2. If the Control-M Server Selection dialog box appears, select the Control-M Server for the job you
are defining, and click OK.
A job is created in a new folder or in an existing folder. The job properties appears in the right pane.
3. If the Synopsis (summary) view appears, select .
A detailed view of the job properties appears in the right pane. Each parameter is saved when you
exit the parameter field.
If you have a Site Standard applied, the relevant parameters' pattern parts are automatically
populated.
4. Do one of the following:
• To define a job, in the General tab, set the fields according to the job type, as described in Job
types (on page 97).
• To define Application plug-in jobs, see: Application Plug-ins.
5. Do any of the following:
• Browse in an OS job for a file that contains a job script in a remote host or host group.
• Browse in a z/OS job for the member that contains the JCL in a library.
• Adding a script parameters.
• Add a variable (on page 96).
• Define job scheduling (on page 49).
• Define job prerequisites (on page 73).
• Define job actions (on page 78) to be implemented after the job is Production.

6. To save the Workspace, click .


The Workspace remains as a work in progress in Definitions database.
7. Commit the changes to the jobs and folders, check in the Workspace, as described in Checking in a
Workspace (on page 85).

48
Control-M User Guide

Job scheduling
After you have completed Creating a job (on page 47) , you can schedule and run the jobs under the
Control-M/Server to which they have been defined. You can use any number of Scheduling parameters
(on page 50) and Scheduling options (on page 55) to define the jobs schedule according to your
requirements:
 Scheduling a job on specific days, week days, and months (on page 71): You can specify a
combination of months, days of the month, and days of the week to schedule a job/folder.
 Defining scheduling criteria using calendars (on page 72): You can define the schedule in a calendar,
when the same schedule is used by multiple jobs. You must create the calendars first, as described in
. After you have created the calendar, you can start using the specific calendar to schedule a
job/folder.
 Defining complex scheduling criteria using Rule-based calendars: You can create specific rules in a
calendar, and use the rule-based calendar to schedule a job/folder. In some cases, required values
cannot be specified as absolute values, therefore you can use a specific Rule-based calendar to
schedule a job/folder. To use a Rule-based calendar, you must create the calendar as described in
Creating a Control-M Rule-based Calendar (on page 66).

49
Control-M User Guide

Scheduling parameters
The following table describes the fields used to create scheduling for a job

50
Control-M User Guide

Field Description

Schedule (on page 55) Defines the Scheduling options for the Schedule field in the
Scheduling tab of the Properties pane.

View Schedule Defines the button to click to view the schedule graphically.

Time Settings Defines an area in the Scheduling tab of the Properties pane
where the time frame of the job's start running time is defined.
This includes From Time/To Time and Must End.

From Time Sets time limits for submitting the job. For z/OS jobs, includes
the days

To Time Sets time limits for submitting the job. You can select one of
the following options:
 Time: Enables you to sets the time limits for submitting
the jobs. For z/OS jobs, includes the days.
 End of day: Enables you to set the job to be submitted by
the end of the day.
 Allow submission past next New Day: Enables you to
set the job to b submitted after its original scheduled date.

Must End Sets the time and day when the job must finish executing.
(z/OS only)

Rerun Settings Defines an area in the Scheduling tab of the Properties pane to
set rerun settings including Cyclic, Maximum reruns, and Rerun
Member.

Cyclic Indicates that the job must run at a designated time, interval
of time. For an example of how to automatically rerun a job
that ends Not OK, see Defining automatic rerun for a job that
ends Not OK example (on page 53).

Maximum reruns Determines the maximum number of reruns that can be


performed for the job.

Rerun Member Defines the name of the JCL member to use when the job
automatically reruns.
For z/OS jobs.

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

Confirmation Calendar Area of the Scheduling tab of the Properties pane that
describes the calendar and Exception policy parameters.

51
Control-M User Guide

Field Description

Calendar Indicates the name of a Control-M calendar that is used to


validate scheduling dates. A shift value can be used to indicate
how to handle jobs that are scheduled for a non-working day in
the calendar.

Exception policy Specifies what to do if a job is supposed to run on a day that is


not in the confirmation calendar.

Activity Period Defines the area in the Scheduling tab of the Properties pane
that describes Active/Not Active between dates, Start Date, End
Date, and Statistics Calendar.

Active/Not Active between dates Determines a date range (Start Date - End Date) when the job
or folder can be ordered or the Rule-based Calendar (RBC) can
be used. During the period that the job or folder is outside the
active range (that is, inactive), it is not eligible to be ordered.
EXAMPLE: Limit the dates that the job can be schedules to:
August 6th, 7th, 8th, 9th, 10th, and 11th.
1. Start date: August 6th
2. End date: August 11th

Start Date Sets the date when the job must be ordered.

End Date Sets the date when the job must be ordered.

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

View Defines a View button that enables you to view the Statistics
related to the Statistics Calendar.

Active Environment Retention Defines an area in the Scheduling tab in the Properties pane
that describes the Keep Active for parameter.

Keep Active for Determines the number of extra days (beyond the original
scheduling date) that the job is allowed to remain in the Active
Jobs database while awaiting execution. If the job still has not
run after the specified number of days, the job is removed
from the Active Jobs database.

52
Control-M User Guide

Field Description

Keep all jobs in folder until folder Indicates that all jobs in the folder are not removed
is removed automatically from the Active Jobs database. Instead jobs wait
for the folder to complete and are removed at the same time
as the folder.

Keep the folder for a minimum Enables you to specify a minimum period to keep the SMART
number of days after ended not folder (and jobs) in the Active Jobs database after the folder is
ok set to NOT OK.
NOTE: You can only use this option if you select Keep all jobs
in folder until folder is removed.

SAC Determines whether to adjust the logical date for a job


converted from a scheduling product other than Control-M.
z/OS parameter

Retroactively order job that its Indicates if the job did not get ordered on its original
scheduled date has passed scheduling date, it is ordered after its original scheduling date
has passed.
EXAMPLE: The WorkDays calendar contains the dates 15,16,18,
and 19. The computer was down from the 16th to
the 18th. the 15th was the last date that the job
was scheduled for execution, and today is the
19th. the job is scheduled three times with the
original scheduling dates 16, 18. and 19.

Defining automatic rerun for a job that ends Not OK example


This example describes how to define an automatic rerun for a job that ends not OK, which triggers an
alternative job and sends an alert.
 To automatically rerun a job that ends Not OK:
1. In the Scheduling tab, Rerun Settings area, select the Cylic checkbox and then click Set.
2. The Cyclic Job Run Times window appears.
3. In the Rerun Interval section, select Rerun Every 1 minute and then in the All Intervals are
from Job's field, from the dropdown list select End.
4. Click OK.
5. In the Maximum Reruns field, select 1 for the number of reruns.

6. From the Actions tab, click to add an On-Do Action.


The On Do Actions window appears.

53
Control-M User Guide

7. In the On field, from the dropdown list select Job ended Not OK.
8. In the Do field, select Do Rerun.
9. Click Add Do and then in the Do field from the dropdown list, select Order Job (ignore
Scheduling Criteria) and then type the following:
• Folder: folder1
• Job Name: AltJob
• Date: Order Date
10. Click Add Do and then in in Do field, from the dropdown list, select Notify and then add the
following:
• Destination: Alerts Window
• Message: Rerun JobX failed. Alternate job forced.
• Urgency: Urgent

Defining a time frame when jobs can be submitted examples


This example describes how to limit the time frame during which Control-M can submit a job and to
define the time frame in the Time Settings area of the Scheduling tab.

 To define a time frame when jobs can be submitted:


1. In the Time settings area, do the following:
• To define the earliest time that a job can be submitted, in the From Time field specify the time.
EXAMPLE: The job should be submitted after 6pm. In the From Time field, specify 18:00.
• To define the latest time that a job can be submitted, in the To Time field specify the time.
2. To link the time frame to a time zone other than the Control-M/Server’s time zone (for example, to
the Control-M/Agent’s time zone), select the time zone in the Time Zone field. The time zone
selection list provides both geographic name abbreviations and Greenwich Mean Time (GMT) offsets.
NOTE: To ensure that if Control-M did not submit the job before New Day processing for the next
day began, it submits the job as soon as possible afterward, select the Allow submission past New
Day checkbox.
3. in the (time) to field
EXAMPLE 1: The job should be submitted before 10pm in Sydney Australia. In the To Time field
specify 22:00 and select SYD (GMT+10:00) in the Time Zone field.
EXAMPLE 2: The job should be submitted after 6:00pm. If it is not submitted before New Day
processing the next day, it should be submitted as soon as possible after that New Day
processing. In the To Time field, specify 18:00 and then select Allow submission past
next New Day checkbox.

54
Control-M User Guide

Scheduling options
The following table describes the various scheduling options:

55
Control-M User Guide

Option Description

Every Day Defines the scheduling to be every day, and only runs if all the
prerequisite running criteria are met.

None (Manual Order) Defines no scheduling. For the job to run, it is ordered manually,
as described in Ordering jobs (on page 87).

Month Days Defines scheduling according to selected Month Days, such as 1-


31, as described in Month Days options (on page 58).

Week Days Defines scheduling according to selected Week Days, as


described in Week Days options (on page 58)

Use Parent Scheduling Defines scheduling for a job or sub-folder in a SMART folder
according to the scheduling criteria of the parent SMART folder.
For more information about defining a Rule-based Calendar, see
Defining a Folder Rule-based Calendar (on page 95).

Using Specific Rule-Based Defines scheduling according to the scheduling criteria of the
Calendar selected RBCs in the RBCs list and in the Excluded RBCs list.
This option is available for the following entities, as described
Rule-based Calendar and Excluded Rule-based Calendar lists (on
page 339):
 SMART Folder: You can define RBCs to be included in the
RBCs list or Excluded RBCs list. This can included selecting
from a pre-defined Control-M Rule-based Calendar, or
creating a Folder RBC.
 Sub Folder: You can select from a list of Folder RBCs or
Control-M RBCs that are defined in the parent SMART folder
to add to the RBC list and select Control-M RBCs to be
added to Excluded RBC list.
 Job in a SMART Folder: You can select from a list of
Folder RBCs or Control-M RBCs that are defined in the
parent SMART folder to add to the RBC list and select
Control-M RBCs to be added to Excluded RBC list.
 Job in a regular folder: You can select Control-M RBCs to
be added to the RBC list and the Excluded RBC list.
For more information on Control-M Rule-Based Calendars, see
Calendar management (on page 335).
For more information on defining a Folder Rule-based Calendar,
see Defining a Folder Rule-based Calendar (on page 95).
For more information on defining a Control-M Rule-based
Calendar, see Creating a Control-M Rule-based Calendar (on
page 66).

56
Control-M User Guide

Option Description

Based on Calendar Defines scheduling options that are based on specific calendars.
For more information, see Based on Calendar (on page 60).

Specific Dates Defines specific dates for the schedule up to 12 dates.

Based on Free Space on PDS (Control-M for z/OS only) The following fields are defined:
 Partition Data set: Defines the name of a partitioned data
set to check for free space. If the Partition Data Set has
fewer than the minimum number of required free tracks (as
specified for the Minimum number of tracks parameter), the
job is executed.
 Minimum number of tracks: Minimum number of free
partitioned data set tracks required by the library specified
for the Partition Data Set parameter.

Advanced Scheduling Defines a combination of scheduling options, as described in


Advanced Scheduling options (on page 64).
If the selected scheduling is equivalent to one of the above
scheduling, the scheduling is displayed as the simple scheduling.

More scheduling options For the full scheduling options, see Scheduling parameters (on
page 50).

Sub Folder: You can select from a list of Folder RBCs that are defined in the parent SMART folder .
Job in a SMART Folder: You can select from a list of Folder RBCs that are defined in the parent SMART
folder to add to the RBC list and select Control-M RBCs to be added to Excluded RBC list.

57
Control-M User Guide

Month Days options


The following table shows the Month Days options for scheduling:

Option Description

Days of Month Defines the Month Days to order.


To limit the schedule or to specify specific months, set the
limitations or order on months, as described in the following:
 Limitations (on page 63)
 Order on Months (on page 63)

Days from End of Month Defines the schedule according to the selected days from the
end of the month.
EXAMPLE: If -3 is selected in January, the job is ordered on
the 29th and the symbol that appears is L3.

Days from Start/End of Month Defines the schedule according to a combination of Days from
the Start and Days from the End of Month.

All days except days from end of Defines the schedule to include all days except days from the
month end of the month (-Ln).

Week Days options


The following table shows the Week Days options for scheduling:

Option Description

Week Days The schedule is according to selected days.

Order on Months Defines the Month to order.

58
Control-M User Guide

Week/Month Days with rules options


The following table describes the Advanced Week/Month Days with rules options. In Advanced Scheduling
options (on page 64), all of the following rules can be selected for any of the days in the Advanced Month
Days or in the Advanced Week Days calendars:

Option Description

Order on Day Defines scheduling on the day

Order on Day or the next working Defines scheduling either on the day or the next working day
day (>)

Order on Day or the previous Defines the scheduling either on the day or the last working
closest working day (<) day

Excepted day: Order job anyway Defines scheduling by either ordering or not ordering the job
(+), Don't order the job anyway on the selected day.
(-)

Order/Don't Order on day from Defines scheduling by either ordering or not ordering a job
the beginning of week/month from the beginning of the week/month
(D/-D)

Order/Don't Order on day from Defines scheduling by either ordering or not ordering a job
the end of the week/month (L/-L) from the end of the week/month

59
Control-M User Guide

Based on Calendar
The following table describes the Based on Calendar options for scheduling:

60
Control-M User Guide

Option Description

Calendar Days Defines the calendar days for scheduling


 Calendar: The job is scheduled according to the
scheduling criteria of the selected Calendar, as described
in Calendar management (on page 335).
 Exceptions (on page 63): Schedules or excludes a job on
a specific Month Day. Limitations (on page 63): Limits the
scheduling criteria to specific Days of the Week that are
selected.
 Order on Months (on page 63): Determines the months
that can be scheduled for processing.

Month Days (Dependant on Defines the days of the Month for scheduling
Calendar)
 Calendar: The job is scheduled according to the
scheduling criteria of the selected Calendar, as described
in Calendar management (on page 335).
 Intersect with Month Days: The working days in the
month are selected when a job should run
 Exceptions (on page 63): Schedules or excludes a job on
a specific Month Day.
 Order on Months (on page 63): Determines the months
that can be scheduled for processing.

Relative Calendar days from Defines the relative calendar days from start/end of month for
start/end of Month scheduling
 Calendar: The job is scheduled according to the
scheduling criteria of the selected Calendar, as described
in Calendar management (on page 335).
 Order only on calendar days: Defines the days from
beginning of the month or from the end of month (Dn or
Ln).
 Order on Calendar days except: Defines the calendar
days from beginning of month or from end of month (-Dn
or -Ln).
 Periods: Enables you to select different periods in a
Periodic Calendar, and the calendar days from the
beginning or end of each period.
 Order on Months (on page 63): Determines the months
that can be scheduled for processing.

61
Control-M User Guide

Option Description

Week Days (Dependant on Defines the days of the week for scheduling
Calendar)
 Calendar: The job is scheduled according to the
scheduling criteria of the selected Calendar, as described
in Calendar management (on page 335).
 Intersect with Week Days: The working days of the
week are selected when the job should run.
 Exceptions (on page 63): Schedules or excludes a job on
a specific Month Day.
 Order on Months (on page 63): Determines the months
that can be scheduled for processing.

Relative Calendar days from Defines the relative calendar days from start/end of week
start/end of week
 Calendar: The entity is scheduled according to the
scheduling criteria of the selected Calendar, as described
in Calendar management (on page 335).
 Order only on calendar days: Defines the relative
calendar days relative to the start or end of the week.
 Order on calendar days except: Defines the relative
calendar days not included in the scheduling.
 Week days: Calendar days to order from the beginning
of the week.
 Periods: Enables you to select different periods in a
Periodic Calendar, and the calendar days from the
beginning or end of each period.
 Order on Months (on page 63): Determines the months
that can be scheduled for processing.

62
Control-M User Guide

Exceptions
The following table shows the Exceptions for scheduling:

Option Description

Select a day in the month to Schedules a job on a specific month day even it is not in the
enforce a job to be ordered/not calendar or excludes a specific month day even if it is in the
ordered on that day calendar. Select one of the following:
 Order the job according to the calendar
 Order the job anyway (+n)
 Don't order job anyway (-n)

Limitations
The following table describes the limitations for scheduling:

Option Description

Only if Week Days are Limits the scheduling criteria to specific Days of the week that
are ordered.

Order on Months
The following table describes the Order on Months:

Option Description

Order on Months Limits or determines the months that can be scheduled for
processing.

63
Control-M User Guide

Advanced Scheduling options


The following table describes the Advanced scheduling options:

64
Control-M User Guide

Options Description

Days of Month Defines the following options with (Advanced) Days of Month
scheduling rules:
 Using a Calendar: Enables you to select the calendar, and
view its calendar days.
 Periods: Enables you to select to order only on calendar
days, or to order on calendar days except. For each period,
you can select calendar days from the beginning or end of
each period.
 Rules: Enables you to right-click, and select any combination
of the rules, as described in Week/Month Days with rules
options (on page 59).

OR/AND Defines AND or OR relationship between the (Advanced) Days of


Month and (Advanced) Days of Week.

Days of Week The following options are used for (Advanced) Days of Week
scheduling:
 Using a Calendar: Enables you to select the calendar, and
view its calendar days.
 Period: Enables you to select to order only on calendar days,
or to order on calendar days except. For each period, you can
select calendar days from the beginning or end of each
period.
 Rules: Enables you to right-click, and select any combination
of the rules, as described in Week/Month Days with rules
options (on page 59).

Specific Dates Defines specific dates (month and day) to schedule the job.

Order on Months Determines which months the job can be scheduled for
processing.

Rule-based Calendars Enables you to define an AND/OR relationship between the Job
scheduling definitions and all the Rule-based Calendars, and to
select Rule-based Calendars.

Rule-based Calendars list You can also add RBCs to the RBCs list and Excluded RBCs list, as
described in Rule-based Calendar and Excluded Rule-based
Calendar lists (on page 339).

Excluded Rule-based Calendars You can also add RBCs to the RBCs list and Excluded RBCs list, as
list described in Rule-based Calendar and Excluded Rule-based
Calendar lists (on page 339).

65
Control-M User Guide

Rule-based Calendar options


The following table shows the Using Rule-based Calendar options for scheduling:

Option Description

Define Folder Rule-based Calendar The schedule is according to selected days.


(Folder RBC)

Select Rule-based Calendar (RBC) You can select any of the following Rule-based Calendar
types:
 Folder Rule-based Calendar
 Control-M Rule-based Calendar

Select Rule-based Calendar You can schedule a combination of Month Days and Days from
End of Month.

Add RBC to RBC List Set the dates that will be scheduled (included RBCs) in a job,
sub-folder, and SMART folder.

Add RBC to Exclude RBC List Set the dates that will be not be scheduled (excluded RBCs) in
a job, sub-folder, and SMART folder.

Creating a Control-M Rule-based Calendar


This procedure describes how to create a Control-M Rule-based calendar, which is a pre-defined calendar
that is based on specific scheduling rules.
 To create a Control-M Rule-based Calendar:
1. From the Tools domain, in the Planning area, select Calendars.
2. From the Calendar menu, select New > Rule-Based.
3. Do the following:
• In the Calendar Name field, type the name of the calendar.
• From the Control-M Server drop-down list, select the Control-M/Server or All. All refers to all
Control-M Servers, both distributed and mainframe systems. The calendar name must adhere to
the validation criteria of calendar name for both systems.
NOTES:
o Distributed System - must not exceed 20 characters.
o Mainframe - no lower case, must not exceed 8 characters and no white spaces.
• (Mainframe only) In the Alias field, add a valid calendar name.

66
Control-M User Guide

4. From the Schedule drop-down list, select one of the scheduling options, as described in Scheduling
options (on page 55).
5. Click More.
6. For each field, type or select the required value, as described in Scheduling parameters (on page 50).
7. Click OK.
The Rule-Based calendar is created and appears in the calendar table.
8. If you want to make the calendar available for scheduling, select the calendar and click Check in.
You can now use the calendar when scheduling a job. For more information, see Job scheduling (on
page 49). For examples, see Rule Based Calendar examples (on page 67).

9. If the Control-M Server is set to All, under Synchronization State click the button.
The Synchronization Status table appears which includes the list of Control-M Servers and their
synchronization state, as described in Synchronization status parameters (on page 341).
The calendar synchronizes in the Definitions database. If your synchronization setting is set to No
Synchronization, (see Configuring Control-M/Server synchronization), you can upload the calendar
to Control-M/Server by clicking Upload drop-down list, and selecting Upload (to upload calendar to
Control-M/Server) or Force Upload (same as Upload, but override changes).

Rule Based Calendar examples


The following examples describe how to schedule a job on specific days/months using a Rule Based
Calendar:
 Scheduling a job on the last day of the month (on page 67)
 Scheduling a job on the last day of the month (workday) (on page 68)
 Scheduling a job 5th and 10th days from the end of the month (on page 69)
 Scheduling a job every day except Sunday (on page 70)

Scheduling a job on the last day of the month


This procedure describes how to schedule a job on the last day of the month using a Rule Based
Calendar.

 To schedule a job on the last day of the month:


1. From the Tools domain, in the Planning area, click Calendars.
2. Click New and then select Rule-Based.
3. Typing the Calendar Name and select the Control-M Server.
4. In the Schedule field, from the dropdown list, select Month days and then select Days from end
of month.

67
Control-M User Guide

5. Click 1-.

6. To view the calendar, click View Schedule.


7. Click OK and then click Check-in.
8. From the Planning domain, Scheduling tab, in the Schedule field, select using Specific Rule-
Based Calendars.

9. In the Rule-based calendars list field, click and then add the Rule Based Calendar.

Scheduling a job on the last day of the month (workday)


This procedure describes how to schedule a job on the last day of the month (if that day falls on a
workday) using a Rule Based Calendar.

 To schedule a job on the last day of the month:


1. From the Tools domain, in the Planning area, click Calendars.
2. Click New and then select Rule-Based.
3. Typing the Calendar Name and select the Control-M Server.
4. In the Schedule field, from the dropdown list, select Month days and then select Days from end
of month.
5. Click 1-.

68
Control-M User Guide

6. Click Limitations and select Monday to Friday.

7. To view the calendar, click View Schedule.


8. Click OK and then click Check-in.
9. From the Planning domain, Scheduling tab, in the Schedule field, select using Specific Rule-
Based Calendars.

10. In the Rule-based calendars list field, click and then add the Rule Based Calendar.

Scheduling a job 5th and 10th days from the end of the month
This procedure describes how to schedule a job on the 5th and 10th days from the end of the month
using a Rule Based Calendar.
 To schedule a job on the 5th and 10th days from the end of the month:
1. From the Tools domain, in the Planning area, click Calendars.
2. Click New and then select Rule-Based.
3. Typing the Calendar Name and select the Control-M Server.
4. In the Schedule field, from the dropdown list, select Month days and then select Days from end
of month.

69
Control-M User Guide

5. Click the arrow and select 5- and 10-

NOTE: In a month with 31 days, the job is ordered on 22nd and 27th of the month. In a month with
30 days the job is ordered on 21st and 26th of the month.
6. To view the calendar, click View Schedule.
7. Click OK and then click Check-in.
8. From the Planning domain, Scheduling tab, in the Schedule field, select using Specific Rule-
Based Calendars.

9. In the Rule-based calendars list field, click and then add the Rule Based Calendar.

Scheduling a job every day except Sunday


This procedure describes how how to schedule a job every day except on a Sunday using a Rule Based
Calendar.
 To schedule a job every day except sunday:
1. From the Tools domain, in the Planning area, click Calendars.
2. Click New and then select Rule-Based.
3. Typing the Calendar Name and select the Control-M Server.

70
Control-M User Guide

4. In the Schedule field, from the dropdown list, select Week days and then select every day apart
from Sunday.

5. To view the calendar, click View Schedule.


6. Click OK and then click Check-in.
7. From the Planning domain, Scheduling tab, in the Schedule field, select using Specific Rule-
Based Calendars.

8. In the Rule-based calendars list field, click and then add the Rule Based Calendar.

Scheduling a job on specific days, week days, and months


This procedure describes how to use the Advanced Scheduling option, which enables you to schedule a
job using a combination of months, days of month and days of the week.

 To schedule a job using advanced scheduling:


1. In the Scheduling tab, from the Schedule drop-down list, select Advanced Scheduling.
2. In the Days of month area, select the days of month you want the job to run. If you have specified
month days that are relative to a calendar, select the calendar from the Using Calendar drop-down
list.
3. In the Days of week area, select the days of week you want the job to run. If you have specified
week days that are relative to a calendar, select the calendar from the Using Calendar drop-down
list.
4. Set the relationship between the selected month days and week days, by click And or Or.
5. In the Order on months area, select the months you want the job to run.
EXAMPLE 1: The job should be scheduled every day.
1. Click All in the Days of month area.
2. Click All in the Order on months area.
EXAMPLE 2: The job should be scheduled on the first day following the end of each quarter:
1. Click 1 in the Days of month area.
2. Click Apr, Jul, Oct, Jan in the Order on months area.
EXAMPLE 3: The job should be scheduled every Monday through Friday.
1. Click All in the Order on months area.

71
Control-M User Guide

2. Click Mon, Tue, Wed, Thu, Fri in the Days of week area.

Defining scheduling criteria using calendars


This procedure describes how to define the schedule in a calendar when the same schedule is used by
multiple jobs. For more information about defining calendars, see Calendar management (on page 335).

 To define scheduling criteria using calendars:


1. In the Scheduling tab, from the Schedule drop-down list, select Based on Calendar.
2. Select one of the options that best suits your scheduling criteria, as described in Based on Calendar
(on page 60).
3. From the Calendar drop-down list select the calendar that you want to base your scheduling criteria
on.
4. define the rest of your scheduling criteria, as described in Scheduling parameters (on page 50).
EXAMPLE 1: Schedule a job on all working days in July and August.
1. Create a Workdays calendar, as described in Calendar management (on page 335).
2. In the Workspace, select Based on Schedule, as described in the steps above.
3. From the drop-down list, select the Month Days option.
4. From the Regular Calendar drop-down list, select Workdays.
5. In the Order on Months area, select July and August.
EXAMPLE 2: Schedule the job on all working Mondays in July and August.
1. Create a Workdays calendar, as described in Calendar management (on page 335).
2. In the Workspace, select Based on Schedule, as described in the steps above.
3. From the drop-down list, select the Week Days option.
4. From the Regular Calendar drop-down list, select Workdays.
5. Select Mon.
6. In the Order on Months area, select July and August.

Limiting scheduling to a particular date range


This procedure describes how to limit scheduling in a calendar to a particular date range. For more
information about defining calendars, see Calendar management (on page 335).
 To limit scheduling to a particular date range:
1. In the Scheduling tab, from the Schedule drop-down list, select Based on Calendar.
2. Select one of the options that best suits your scheduling criteria, as described in Based on Calendar
(on page 60).

72
Control-M User Guide

3. From the Calendar drop-down list select the calendar that you want to base your scheduling criteria
on.
4. Define the rest of your scheduling criteria, as described in Scheduling parameters (on page 50).
5. Do one of the following:
• To define an active date range when the job can be scheduled in the Activity Period area, from
the dropdown list select Active.
• To define an inactive date range when the job cannot be scheduled in the Activity Period area,
from the dropdown list select Not Active.
6. In the Start Date field, select the date that you want the job to start.
7. In the End Date field, select the date you want the job to end.
EXAMPLE: Limit the dates the job can be scheduled to: August 6 to 11 inclusive. In the Activity
Period area, select Active and then in the Start Date field, select August 6 and in the
End Date field select 11 August. If you do not want the job to be ordered on August 6 to
11 August, select Not Active and the fill in the Start and End dates.

Job prerequisites
Job prerequisites are job submission criteria that must be met for a job to run. You can define the
following types of job prerequisites:
 Set user confirmation: Enables you to specify that a the user must confirm as a prerequisite for the
job, as described in Setting user confirmation.
 In Condition: Enables you to specify one or more In Conditions which correspond to the successful
completion of another job, as described in In Conditions (on page 73).
 Control Resource: Enables you to specify whether the job requires exclusive or shared access to a
physical resource, such as tape drive, as described in Control resources (on page 75).
 Quantitative Resource: Enables you to specify the resource in the Control-M and, for each job, the
quantity required/used by that job, as described in Quantitative resources (on page 76). This does not
apply to folder definitions.
When the scheduling criteria and all the job prerequisites are met, the job can be submitted.
For information on ignoring prerequisite conditions set by a predecessor jobs that is not scheduled, see
Adjust Condition.
For information on job dependencies, see Job dependencies.

In Conditions
You define dependencies between jobs through the following:

73
Control-M User Guide

 In Condition: Specifies prerequisite conditions that must be satisfied before the job is submitted for
execution. The In Conditions parameter makes the submission of the job dependent on the
existence of one or more prerequisite conditions.. To create an In Condition, see Create an In
Condition (on page 74). For more information about In Conditions, see In Condition in Parameters.
 Out Condition: Specifies prerequisite conditions to be added or deleted after the job completes. For
more information, see Out Condition in Parameters.
An In Condition is usually associated with an Out Condition of a successful completion of predecessor
job.
You can automatically create job dependencies by selecting a successor job, clicking and then
connecting the successor job to the predecessor job. Both In and Out Conditions are automatically
created. By default, the condition is deleted after the job ends, which eliminates clutter from active jobs
even before the New Day process is run the following day. It is also useful if the job runs more than once
(such as cyclic jobs or rerun jobs).
You can set job dependencies for jobs in the same Control-M/Servers or for jobs in different Control-
M/servers.
 Connecting jobs from different Control-M/Servers (on page 82): You can also define global
prerequisites to establish job dependencies across different Control-M/Servers by defining condition
name prefixes that indicate that a condition is global.
 Connecting jobs (on page 81): You can define job dependencies between jobs of the same Control-
M/Server.
EXAMPLE: A Job X has 3 In Conditions defined on an Order Date (A, B, and C).
Job X starts running only if In Conditions A, B, and C on the Order Date are in the Active
Conditions list. After Job X Ends OK.

Creating an In Condition
This procedure describes how to create an In Condition for a job, which enables you to establish the
requirement that the condition must exist in the active environment before the job can run.

 To create an In Condition:
1. In the Workspace, select the job.
2. Click .
3. Select the Prerequisites tab.

4. In the In Conditions section, click .


The Condition Details window appears.
5. In the Name field, type a name for the In Condition.
6. From the Order Date drop-down list, select the order date for the job to run. For more information
about order dates, see Date.
7. To delete the condition after the job ends, select the checkbox.
NOTE: When creating automatically In and Out Conditions, by default the Delete Condition After
Job Ends checkbox is automatically selected. Clear the checkbox if you do not want to delete the
condition after the job ends.

74
Control-M User Guide

8. Click OK.
9. In the Properties pane, from the Conditions Relationship drop-down list, select the relationship
between conditions.
10. If you select Set Manually, double click the condition and in the Condition Details window, define
the following:
a. If you want to add brackets, from the Opening Bracket and Closing Bracket drop-down lists, select
the brackets.
b. From the Relationship drop-down list, select the relationship between the In Conditions.
The In Condition is created.

Copying an In Condition
This procedure describes how to copy an In Condition, which enables you to copy In Conditions from one
job to another.

 To copy an In Condition:
1. In the Workspace, select the job.
2. Click .
3. In the Properties pane, select the Prerequisites tab.
4. From the In Conditions list, select the In Condition to copy.
You can select multiple In Conditions by either using Shift and keyboard arrow or Control and mouse
click.

5. Click .
6. Open the In Conditions list of the other job.

7. Click .
The In Condition is copied and appears in the In Conditions list.

Control resources
Control Resources are user defined variables representing a physical or logical device in a Control-M
installation. Control Resources that are characterized by the control that a job needs over them. For each
job you can specify exclusive or shared access to the resource. The job is not ordered unless the Control
Resource is available in the required state (exclusive or shared). If the resource is shared, other jobs can
use the resource concurrently, while jobs with exclusive resources cannot. Control-M 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. Examples of Control Resources can include files, disk drives, tables, and databases.

75
Control-M User Guide

The purpose of a Control Resource is to provide exclusive access to resources for a job. This does not
limit the number of jobs that can share a resource, which can be done through Quantitative Resources.
Control Resources ensure that jobs, which cannot share the resource, do not run when any other job
requires access to the same resource. Control-M 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 more information about Control Resources,
see Control Resources in Parameters.
EXAMPLE: A job called DeductCharges requires exclusive control of a file called AcctBalance. Control-
M only submits DeductCharges if AcctBalance is not being used by another job. If another
job also requires AcctBalance, it is not submitted as long as DeductCharges is running.
To create a control resource in the Planning domain, see Allocating a control resource (on page 76).
If you want to view the defined Control resources when a job is executing, from the Tools domain, click
Control Resources. You can also prevent jobs with exclusive or shared Control Resources from
running. For more information, see Control Resource management (on page 342)

Allocating a control resource


This procedure describes how to allocate a control resource for a job.

 To allocate a control resource:


1. In the Workspace, select the job.
2. Click .

3. From the Prerequisites tab, in the Control Resources section, click .


A new row is added to the Control Resources list.
4. In Control Resources, do the following:
• In the Resource Name field, type a name of the control resource.
• From the Type drop-down list, select either Shared or Exclusive.
• (z/OS) From the On Fail drop-down list, select either Release or keep.
The control resource is allocated. For more information, see Control Resources.

Quantitative resources
A quantitative resource represents a measure that can be quantified such as percentage of CPU,
megabytes of storage, or number of tape drives. It provides the ability to avoid overwhelming the physical
and logical resources in an environment by limiting the number of jobs that use the same resource at the
same time.
There are 2 parts to the process:

76
Control-M User Guide

 From the Tools domain, in the Quantitative Resource window, you define the total quantity of
Quantitative Resources for relevant Control-M/Servers. To define a Quantitative Resource for Control-
M/Servers see Creating a control resource (on page 342)
 In the Job Properties, you define how much of that resource should be used in the jobs running on
that Control-M/Server. To define a Quantitative Resource for a job, see Allocating a quantitative
resource (on page 77).
EXAMPLE: Control-M has three tape drives available. A job called BKP_Tallies requires one tape drive.
To enable Control-M to handle this correctly, do the following:
• Using the Quantitative Resources window in the Tools domain, define the
quantitative resource TapeDr having a quantity of 3.
• In Job Properties, when defining the job BKP_Tallies, specify 1 of TapeDr.
Whenever a job using TapeDr is submitted, Control-M drops the currently available quantity of the
resource by the quantity the job uses, until the job ends. Control-M only submits
BKP_Tallies if there is at least one TapeDr available.
When a Quantitative Resource is specified for a job, Control-M determines whether a sufficient quantity of
the specified resource is available is before submitting the job. When the job is submitted, the specified
quantity of resource is assigned to that job and is not available to other jobs. When the job finishes
executing, the resource is made available to other jobs. For more information, see Quantitative Resources
in Parameters.

Allocating a quantitative resource


This procedure describes how to allocate a quantitative resource for a job which enables you specify the
quantified resources for a job.
Before you begin
Open the Workspace that holds the jobs you want to create quantitative resources for. For more
information, see Workspace management (on page 308).
 To allocate a quantitative resource:
1. In the Workspace, select the job.
2. Click .
3. Select the Prerequisites tab.

4. In the Quantitative Resources section, click .


A new row is added to the quantitative resources list.
5. In Quantitative Resources, do one or more of the following:
• In the Resource Name field, type a name for the quantitative resource.
• From the Required Quantity field, select the quantity of the quantitative resource. For more
information, see Quantitative resources (on page 76).
• (z/OS) From the On Fail drop-down list, select Release or Keep.
• (z/OS) From the On Ok drop-down list, select Discard or Release.
The quantitative resource is allocated.

77
Control-M User Guide

Job actions
Before or after a job completes, you can define one or more of the following different actions for a job to
perform.
 Out Conditions: . Post-processing parameters that Control-M adds to the active environment only
when the job ends.When a predecessor job ends, the addition of its Out conditions to the active
environment enables successor jobs with the corresponding In conditions to run.
EXAMPLE: Job X has 3 In Conditions defined on an Order Date (A, B, and C) and 2 Out Conditions (D+,
A-, B-, C-)
Job X starts running only if In Conditions A, B, and C on the Order Date are in the Conditions
table. After Job X Ends OK, the Out Condition D is added to the Conditions table. Other jobs
that are waiting for the condition as their In Condition, can start running, and A, B, and C
conditions are removed from the Conditions table.
 Notifications: Notifications that are sent to the Alerts Window, Control-M/Server log file, User
Console, or any defined location in the Shout destination management in response to problems or
integrating with other external monitoring applications. There are two types of notifications:
• Notifications before job completion: Notifications based on the time of the job's submission
and execution.
• Notifications after job completion: Notifications based on a job completing OK or Not OK.
 On-Do Actions: Automatic interventions, such as rerunning a job or ordering a remedial job, if a job
ends with a particular error code. For more information, see Creating Notifications and On-Do Actions
(on page 79).
 Capture from job output: Enables you to search the output of a job for specified text, and based
on the capture parameters, extract words or characters from the output. For more information, see
Defining the job capture criteria (on page 80).
 Output handling: Indicates how the job’s log file should be handled after the job ends with a status
of OK. For more information, see Action.

Creating an Out Condition


This procedure describes how to create an Out Condition for a job, which enables you to establish that
the condition is added to (or removed from) the active jobs database when the job ends.
 To create an Out Condition:
1. In the Workspace, select the job.
2. Click .
3. Select the Actions tab.

4. In the Out Conditions section, click .


The Condition Details window appears.
5. In the Name field, type a name for the Out Condition.
6. From the Order Date drop-down list, select the order date for the job to run.

78
Control-M User Guide

7. From the Add/Remove The Condition drop-down list, select Add or Remove.
8. Click OK.
The Out Condition is created.
9. To set Output Handling, set the Action field, as described in Action.
An Out Condition is displayed in the job flow as a broken line.

Copying an Out Condition


This procedure describes how to copy an Out Condition, which enables you to copy Out Conditions from
one job to another.

 To copy an Out Condition:


1. In the Workspace, select the job.
2. Click .
3. In the Properties pane, select the Prerequisites tab.
4. From the Out Conditions list, select the In Condition to copy.
You can select multiple Out Conditions by either using Shift and keyboard arrow or Control and mouse
click.

5. Click .
6. Open the Out Conditions list of the other job.

7. Click .
The Out Condition is copied and appears in the Out Conditions list.

Creating Notifications and On-Do Actions


This procedure describes how to create Notifications and On-Do Actions.

 To create Notifications and On-Do Actions:


1. In the Workspace, select a job.
2. Click .
3. In the properties pane, select the Actions tab.

4. Select the action you want, and click .


A window appears according to the action you selected.
5. Define the On/Do parameters, as necessary. For more information, see On/Do Actions.
The action is created.
6. To set Output Handling, set the Action field.

79
Control-M User Guide

Defining the job capture criteria


This procedure describes how to define the job capture criteria. You can use the capture from job output
to search the output of a job for specified text, and based on the capture parameters, extract words or
characters from the output.
The destination of the capture is a variable that can be set to any of the following types: local, global,
named pool or smart folder as described in Adding a variable (on page 96).

 To define the job capture criteria:


1. In the Workspace, select the job that you want to define the job capture criteria.
2. Select the Actions tab.

3. In the Capture from job output area, click .


The Capture from job output dialog appears.
4. In the Variable Name field, type a variable name.
5. From the Variable Type drop-down list, select a variable type as described in Adding a variable (on
page 96).
6. In the Search String field, type the string from where to begin the capture process in the output file.
7. In the Forward by: _ Lines field, type the number of lines to skip from the search string.
8. Do one of the following:
• To capture words in the output file, do the following:
a. In the _Words field, type the number of words to skip from the search string in the output
file.
b. From the Delimiter drop-down list, select a delimiter type:
o White space
o Space
o Tab
c. From the Capture drop-down list, select one of the following:
o No. of words
o Up to end of line
d. In step (c), if you selected No. of words, type the number of words to capture.
• To capture characters in the output file, do the following:
e. In the _Characters field, type the number of characters to skip from the search string in the
output file.
f. From the Capture drop-down list, select one of the following:
o No. of characters
o Up to end of line
g. In step (b), if you selected No. of characters, type the number of characters to capture.
The job capture criteria is defined.

80
Control-M User Guide

Connecting jobs
This procedure describes how to connect jobs in the flow diagram.

Before you begin


Ensure you have met the following requirements:

 The drop-down is set to Show Dependencies behind Hosts or Show Dependencies


above Hosts.

 To connect jobs:
1. Select a job.
The Condition triangle appears at the bottom of the job.

2. Drag and drop the point of the triangle to the dependent job until the job outline is also dotted.

There is a dotted line drawn during the drag and drop. After the drop, the line is solid, depending on
your Map settings (on page 38).

3. To rearrange the jobs so that the predecessor is above the dependent job, click .
The dependent job (second) is dependent on the predecessor job (first).

81
Control-M User Guide

Connecting jobs from different Control-M/Servers


This procedure describes how to connect jobs from different Control-M Servers. For example, you can
specify that jobs in Control-M/Servers in Rome and Paris begin executing only after successful completion
of a job in a different Control-M/Server in Sydney.
For more information about defining Global Conditions Prefixes, see Creating a Global Conditions Prefix
(on page 346).
Before you begin
Ensure that you have met the following requirements:

 The drop-down is set to Show Dependencies behind Hosts or Show Dependencies


above Hosts
 To connect jobs from different Control-M/Servers:
1. In the View tab, Display group, select Map.
2. Select a job.
The Condition triangle appears at the bottom of the job.
3. Drag and drop the point of the triangle to the dependent job from another Control-M/Server until the
job outline is also dotted.
If the Global Conditions Prefix has not been defined for a condition between the two Control-
M/Servers, then the following window appears:

4. In the Define a new Global Condition prefix field, type a prefix. To create a condition above the
prefix without defining a Global Condition Prefix, select the check box.
5. Click OK.
The line connecting the jobs is solid.

6. To rearrange the jobs so that the predecessor is above the dependent job, click .
The dependent job (second) is dependent on the predecessor job (first).

Saving a Workspace
This example describes how to save your changes in the Workspace. It enables you to continue working
on the job definitions, even if you close the Workspace.

Before You Begin


Ensure that you have met the following requirements:

82
Control-M User Guide

 Verify that you have completed Creating a Workspace (on page 198).
 Verify that you have completed Checking out a Workspace (on page 202).
 Verify that you have made changes to the Workspace, which can include Editing a job (on page 92).
 To save a Workspace:

 In the Workspace, click .


The Workspace is saved, and you can continue working in it, even if you close it.

Restoring jobs/folders
This procedure describes how to restore individual jobs/folders, which enables you to restore deleted
definitions to the last saved version of that definition.

 To restore jobs/folders:

1. In the Workspace, from the View tab, click .


The list of changes appears in the Results Pane.

2. Select thejob/folder you want to restore, and click .


The job/folder is restored to its' last saved version.

Comparing jobs
This procedure describes how to display a list of a difference between two jobs in a Workspace, two
different versions of the same job from the Job History window, and/or compare a job with it's
predecessor job. This enables you to view the value of the fields that differ and to generate comparison
reports in HTML, text, or XML format.

 To compare jobs:
1. Do one of the following:

a. In a Workspace, select two jobs to compare, and from the Analysis group, select .
b. In the tree pane, right-click a job and select Compare with predecessor.
The Job Comparison window appears.
2. To show rows with differences, select Only show changes.

3. To search for a string in the field values, in field next to , type in the string, and click .
4. To generate a comparison report, do the following:

a. Click .

83
Control-M User Guide

b. Select the destination folder and the type of document for the report.
The comparison report is generated and can be viewed.

Removing jobs from a Workspace


This procedure describes how to remove jobs and folder from a Workspace. If you remove a job that has
dependencies, all dependent jobs are removed from the Workspace as well.
 To remove jobs from a Workspace:
1. In the Planning domain, from a Workspace, select jobs that you want to remove from the
Workspace.

2. Click .
The selected jobs are removed from the Workspace. You can also remove folders including SMART
Folders and Sub Folders from the Workspace.

Verifying JCL code in a job definition


This procedure describes how to verify JCL code in a z/OS job definition, which enables you to view and
correct JCL code such as missing field values or other errors before running the job.
Before You Begin
 Ensure that you have completed Creating a Workspace (on page 198).
 To verify JCL code in a job definition:

 In the Workspace, Analysis tab, select a z/OS job, and click .


The JCL Verification Report appears in the Results pane.
For more information about JCL Verify, see Control-M/JCL Verify User Guide.
For more information about enabling the JCL Verify feature, contact the Control-M Administrator.

Adding jobs to an existing Workspace


This procedure describes how to add jobs or folders to an existing Workspace.

 To add jobs to an existing Workshop:


1. From the Planning domain, Workspace tab, click .
A New tab appears. The tab is the Planning - Home page.
2. Click My Work, and select a Workspace.
The Workspace loads to a new tab.

3. From the Planning domain, Workspace group, click .

84
Control-M User Guide

The Load folders and jobs to Workspace dialog box appears with the Control-M>Folder
hierarchy view. The Application and Sub Application check boxes are cleared.
4. To view your jobs according to application or Control-M/Server, in the Hierarchy field, do one of the
following:
• To view your jobs and folders according to your application, select Application and/or Sub
Application.
• To view your jobs and folders according to the Control-M/Server definitions, clear Application
and Sub Application.
Folders are displayed according to the hierarchy you selected.
5. To filter your jobs and folders based on specific fields, do the following:

a. To view the specific fields to filter, click .


b. Set the filter fields, as described in Filter parameters (on page 199).
c. Click OK where relevant.
d. Click Filter.
The filtered entities appear in the Tree view.

6. Select the jobs and folders that you want to add to the Workspace, and click .
The jobs and folders appear in the Workspace, if they are not already checked out.

Checking in a Workspace
This procedure describes how to check in a Workspace. This enables you to save changes to the Job
Definition database.
Before you begin
Ensure that you have met the following requirements:
 Verify that you have have authorization to update the jobs and folders in the Workspace, as described
in Control-M/EM Authorizations.
 Verify that you have made changes to the Workspace, which can include Editing a job (on page 92).
 To check in a Workspace:

1. In the Workspace, click .


The Check in window appears.
2. Follow the check-in instructions until the check-in is complete.
For more information about the check-in process, see Workspaces.
3. Click Done.
The folders are checked in to the Job Definition database.

85
Control-M User Guide

Conflict Resolution
Conflicts can occur when multiple users are working on the same Workspaces, folders, or jobs. You might
change properties of an entity or delete it from the Workspace. To bring these conflicts to your attention,
the conflicts are displayed in the following ways:
 Check-in conflicts: Conflicts are displayed as errors and/or warnings. If an error is found, the
process is canceled, and the conflict must be resolved. Warnings are just displayed for your
awareness, but will not cancel the process. You can do the following to resolve the conflicts:
• None: Indicates that no action is taken on the conflict, and the process is canceled.
• Overwrite: Indicates that the folder/job with the conflict is overwritten by the new change in the
Workspace.
• Discard: Indicates that the change to the folder/job with the conflict is discarded.
 Show Conflicts: In the workspace, you can use the Show Conflicts feature to view conflicts found in
a Conflict report, as described in Resolving conflicts (on page 86). To view versions of the entity, see
Version management (on page 232).

Resolving conflicts
This procedure describes how to view and resolve conflicts found in a Workspace.
Before you begin
Ensure that you have completed Creating a Workspace (on page 198).

 To view and resolve conflicts:

1. In the Workspace, from the View tab, click .


The conflicts are displayed at the bottom in the results pane.
2. Select the conflict you want to view/resolve in the list.
The folder/job is highlighted in the flow diagram.
3. Do one or all of the following:
• Click the Tools tab in the ribbon to view versions of the job , as described in Managing versions
of a job (on page 233).
• Right-click the folder/job in the flow diagram, and select Compare with Predecessor and/or
Compare with the Latest Database Version, to compare versions of the folder/job.
• Resolve the conflict by modifying the folder/job.
The conflict is resolved.

86
Control-M User Guide

Conversion validation
The Control-M Conversion Tool converts data from schedulers and applications to Control-M. After running
a conversion, the Conversion Tool produces a report, which may contain various error, warning and
information messages, which you can fix manually when loading converted data into Control-M. For more
information about the Conversion Tool, see The Control-M Conversion User Guide.
The Conversion validation feature enables you to view and handle these Conversion Tool messages in the
Planning domain by selecting Use Conversion validation in the Planning Options window and upload
the ConversionMessages Mapping.csv file, which is automatically generated by the Conversion Tool in
the following directory:
<conversion home>\workarea\datasources
For more information about the Planning Options window, see Planning settings (on page 30).
After loading converted data into Control-M, you can view Conversion Tool messages by clicking
Conversion Messages in the Conversion Validation ribbon.
The messages are filtered according to the following groups:
 Error Messages
 Warning messages
 Information messages
When clicking on each message, you can view the Control-M job that relates to that message. You can
also see the original job data that was converted to the relevant Control-M job by clicking Original Job at
the end of each message row.
If you want to mark messages of a specific type that were handled, click Resolve Messages and select
the type of messages you want to handled. For example, if you want to review all Information messages,
click Resolve Messages and then select Resolve All Informations. After clicking Refresh, all
information messages are removed.
You can also mark as handled all specific messages by selecting Resolve Specific and then add the
following information:
 All jobs with Message ID
 Specific job with Unique Message (Message Code)

Ordering jobs
This procedure describes how to manually order jobs and folders from the Planning and Monitoring
domain.

Before you begin


Ensure you have opened a Workspace Creating a Workspace (on page 198) or a Viewpoint Setting up a
Viewpoint (on page 236).
 To order jobs:
1. Do one of the following:

87
Control-M User Guide

• From the Planning domain, do the following:


a. Select the jobs and folders to run.
b. From the Workspace tab, select the drop-down arrow in .
c. Select one of the following:
To order specific jobs and folders, select Order Selected Entities and click Yes.
To order all the jobs and folders in the checked out Workspace, select Order Workspace,
and click Yes.

• From the Monitoring domain, in the Viewpoint tab, select .


2. In the Order dialog box, select one or more parameters, as described in Order parameters (on page
89).
3. Click Order.
The progress of the order appears in the Action Report. The status of ordered folders, jobs and Sub
Folders is set to WAIT_SCHEDULING.
After you order the jobs and folders, the entire checked out Workspace is automatically checked in, as
described in Checking in a Workspace (on page 85). The jobs that are included in the selected folders
that are not in the checked out Workspace are included in the ordered entities.

88
Control-M User Guide

Order parameters
The following table describes the Order parameters that include ordering from Planning and Monitoring
domains:

89
Control-M User Guide

Field Description

Control-M (Monitoring domain only) Defines the name of the Control-


M/Server (or Control-M for z/OS) that processes the job.

Folder (Monitoring domain only) Defines the name of the folder.


The opens the parameter settings of the folder.
For more information on Folder properties, see Folder
parameters (on page 186).

Library (Monitoring for z/OS only) Defines the name of the library that
contains the job’s folder.

Jobs (Monitoring domain only) Defines how to select the jobs to


order., as described in the following options:
 All Jobs: Enables you to select all jobs.
 Selected jobs: Enables you to select jobs and folders
from a tree view or grid view.
NOTE: When selecting the grid view you can delete, edit,
move and filter the columns as you want. For more
information, see Managing columns in the Order Window.
 Mask: Enables you to filter jobs.

Ignore scheduling criteria Determines if the job or folder is placed in the active jobs
database regardless of the scheduling criteria.

Hold Determines if the job or folder is put on Hold as it enters the


Monitoring domain. This enables you to make changes to a
job before it starts running.

Order as independent flow Determines if a flow in a folder is ordered uniquely. This is


only if you are ordering a single folder created in version
8.0.00 and later. A unique suffix is added to every condition
name.
See Conditions management (on page 344).

Current working date Determines if the job or folder is scheduled on the current
working date. The date includes the year.
If you want to select another date, clear this option.

Select a date Determines if the job or folder is ordered on a selected date


(including year).
If you want select the current working date, clear this option.

90
Control-M User Guide

Field Description

Wait for Order Date to run Determines if the jobs must wait for the defined Order date to
run. For example, time zone jobs are ordered before their
order date.

Order Into Folder Determines how to order jobs or Sub Folders that belong to a
SMART Folder. Jobs and Sub Folders are added to a SMART
Folder according to the following Order Into Folder options:
 New: insert jobs into a new folder
 Recent: insert jobs into a recent folder
 Selected: insert jobs into a selected folder. Use the
Folder Order ID field to select.
 Standalone: insert the jobs into a regular folder. If this
option is selected, the Create Duplicate field is disabled.
If the job or Sub Folder is inserted into an existing folder or
Sub Folder that has already completed, the status of all parent
folders is set to Executing. If it is not possible due to
scheduling criteria, the job remains in WAIT_SCHEDULING
status. This parameter is ignored if the folder that is ordered
is not a SMART Folder.

Create Duplicate Defines if Jobs and/or Sub Folders with the same name that
already exist in the Folder, are added to the SMART folder
when you select Recent or Selected.

Set Variables Determines the ad-hoc variable assignments that you can add,
in addition to the ones in the job definition. For more
information see Variables.

Creating multiple jobs


This procedure describes how to create multiple jobs based on a pre-defined template.

Before you begin


Ensure you are in a checked out Workspace and select folder.

 To create multiple jobs:


1. In the Planning domain, in the Edit group, click .
The Mass Create dialog box appears.

91
Control-M User Guide

2. In the Number of jobs to create field, enter the number of jobs to create.
3. In the Template area, select one of the existing templates.
4. To edit the template, do the following:
a. If the Edit Template button is enabled, click Edit Template.
The Job Properties dialog box appears.
b. To change the Job Type, select the drop-down menu from Job Type.
c. In the General tab, set the fields according to the job type, as described in Job types (on page
97).
For information on the relevant Application Add-on, see Application Plug-ins.
d. To add input parameters to a script, see Adding input parameters to a script.
e. To add a variable, see Adding a variable (on page 96).
f. Define the scheduling of the job, as described in Job scheduling (on page 49).
g. Define the dependencies of the job, as described in Job prerequisites (on page 73).
h. Define the actions of the job, as described in Job actions (on page 78).
i. Click OK.
5. In the Mass Create dialog box, click OK.
The jobs are created in the selected folder.

Editing a job
This procedure describes how to edit a job in a Workspace.

Before you begin


Ensure you have successfully completed Creating a Workspace (on page 198).

 To edit a job:
1. From a Workspace, select the job that you want to edit.
The job properties appear in the right pane.
2. If the Synopsis (summary) view appears, select .
A detailed view of the job properties appears in the right pane. Each parameter is saved when you
exit the parameter field.
3. Edit the required parameters, as described in Creating a job (on page 47).

92
Control-M User Guide

Folders
Folders are containers that help you organize your job processing definitions. Some jobs are scheduled
daily, others monthly or quarterly. Folders help you organize and store jobs with similar schedules. When
you define a job, you associate it with a particular scheduling folder.You can define as many scheduling
folders as you need, and you assign each scheduling folder to a specific Control-M/Server.
You can define the following types of folders:
 Regular folder: A folder that contains jobs with similar scheduling criteria. Jobs in a regular folder
are processed independently of each other. Each job is handled according to the parameters in its
own job definition. For more information, see Creating a folder (on page 93).
 SMART folder: A folder that contains an extended set of definition parameters that are applied to
the jobs as a whole. For more information, see Creating a folder (on page 93).
 Sub folder: A folder nested inside a SMART folder. For more information, see Creating a Sub Folder
(on page 94).
EXAMPLE: You can define post-processing tasks that Control-M should perform when all the jobs in a
SMART folder successfully end.The submission criteria of the jobs are now dependent on the
scheduling parameters of the folder.
For more information on how to create a folder, see Creating a folder (on page 93).

Creating a folder
This procedure describes how to create a folder, which can be a regular folder, a SMART folder, which
enables you to create a container that will hold your job definitions.
 To create a folder:
1. From the Workspace tab, New area, drag and drop the folder template into the Workspace.
2. If the Control-M Server Selection window appears, select the Control-M/Server for the folder you
are defining and click OK.
A folder is created, the folder type is set to regular, and the folder properties appear in the right
pane.
3. Click .
The folder properties are enabled for definition.
4. Set the regular folder parameters, as described in Regular folder parameters (on page 188).
5. If you want to create a SMART folder, check the SMART check-box in the top right corner of the
properties pane, and do the following:
a. Set the SMART folder parameters, as described in SMART Folder parameters (on page 191).
b. Define scheduling criteria, as described in Job scheduling (on page 49) .
c. Jobs and Sub Folders can inherit scheduling settings.
d. Define the dependencies of the SMART Folder or Sub Folder, as described in Job prerequisites.
Define the actions of the SMART Folder or Sub Folder, as described in Job actions.

93
Control-M User Guide

Creating a Sub Folder


This procedure describes how to create a Sub Folder in a Workspace.

Before you begin


Ensure you have successfully completed Creating a Workspace (on page 198).
Ensure that you have created a SMART Folder, as described in Creating a SMART Folder.

 To create a sub folder:


1. From the Workspace tab, New area, drag and drop the folder template into the SMART Folder, or
an existing Sub Folder.
A Sub Folder is created and the Folder Type is set to Sub Folder, for Control-M/Server for Distributed
Systems only.
2. Click .
The properties are enabled for definition.
3. Set Sub Folder parameters, as described in Sub Folder parameters (on page 195).
4. Do the following:
a. In the Scheduling tab, select one or more of the Rule-based Calendars, and set the relevant
scheduling parameters, as described in Scheduling parameters (on page 50).
The Sub Folder inherits the selected Rule-based Calendar scheduling, and assigns the Time
Settings.
b. Define the prerequisites of the SMART Folder or Sub Folder, as described in Job prerequisites (on
page 73).
c. Define the actions of the SMART Folder or Sub Folder, as described in Job actions (on page 78).
The folder is now updated.

Editing a folder
This procedure describes how to edit a SMART, Sub Folder, or regular folder in a Workspace.

Before you begin


Ensure you have successfully completed Creating a Workspace (on page 198).
 To edit a folder:
1. From the Workspace, select a folder to edit.
2. In the Properties pane, click .
The folder properties are now enabled for definition.
3. Do one of the following:
• To set regular folder parameters, clear the SMART check box, and see Regular folder parameters
(on page 188).
If there is a Sub Folder, you cannot clear the SMART check box.

94
Control-M User Guide

• To set SMART folder parameters, select the SMART check box, and see SMART Folder
parameters (on page 191)
• To set Sub Folder parameters, see Sub Folder parameters (on page 195).
4. If you created a SMART Folder or a Sub Folder do the following:
a. Define scheduling criteria, as described in Job scheduling (on page 49).
Jobs and Sub Folders can inherit scheduling settings.
b. Define the dependencies of the SMART Folder or Sub Folder, as described in Job prerequisites (on
page 73).
c. Define the actions of the SMART Folder or Sub Folder, as described in Job actions (on page 78).
The folder is now updated.

Defining a Folder Rule-based Calendar


This procedure describes how to define a Folder RBC, which enables you to schedule a Folder RBC in a
SMART Folder.
Before you begin
Ensure that you open the Workspace folder that holds the job you want to schedule and that you select
SMART folder, as described in Workspace management (on page 308).
 To define a Folder Rule-based Calendar:
1. In the Workspace, select the folder.
2. Click or click the folder.
3. Select the Scheduling tab.

4. From the Rule-based Calendar List, click .


5. Select Folder Rule-based Calendar.
To create a pre-defined Control-M Rule-based Calendar, see Creating a Control-M Rule-based
Calendar (on page 66).
6. In the Rule-based Calendar dialog box, type the Rule-based Calendar name.
7. From the Schedule drop-down list, select a scheduling type, as described in Scheduling options (on
page 55).
8. To graphically view your scheduling, click View Schedule.
9. Click More, and set the Scheduling parameters (on page 50).
A Folder RBC is created and you can select it for scheduling. Jobs and sub-folders can be selected in
the folder for scheduling.

95
Control-M User Guide

Adding a variable
This procedure describes how to add a variable parameter to jobs. You can define variables in a job
definition to enable sharing data between multiple jobs.

 To add a variable:
1. From the Properties pane, in the General tab, click More.

2. In the Variables area, click .


3. In the Variable Name field, type a variable name.
4. From the Variable Type drop-down list, select one of the following:
• Local: Defines variables that can be used by other post-processing actions of the job, such as
messages, do-action arguments, or the script itself in the next run.
EXAMPLE: %%<variable_name>
• Global: Enables you to access the variables by its name which can be used by any job.
EXAMPLE: %%\<variable_name>
• Named Pool: Defines variables in a pool. The variable is referenced by the pool name.
EXAMPLE: %%\\<named_pool>\<variable_name>
• Smart Folder: Enables other jobs in the folder to access the specified variable either in the script
during the job run, or in post-processing.
EXAMPLE: %%\\<variable_name>
NOTE: The SMART folder option in the Variable Type drop-down list appears when the job is
included in the SMART folder.
For more information on variables, see User-defined variables Name .
If Named Pool is selected, the Pool Name field appears. In the Pool Name field, type the name
of the pool.
5. In the Variable Value field, type the value of the variable.
A variable is added to the job definition.
EXAMPLE: A user-defined variable for the day before yesterday is needed in the job script. Do the
following:
In the Variable Name field type, TwoDaysAgo.
In the Variable Type field, select Local.
In the variable value field, type %%Day %%Minus 2.
NOTE: %%Day is a system variable. %%Minus is an operator.

96
Control-M User Guide

Job types
The following table describes the General job parameters of the various job types:

97
Control-M User Guide

Job type Description

OS (on page 100) Defines the UNIX and Windows job parameters.

z/OS (on page 104) Defines the Control-M for z/OS job parameters.

BIM (on page 108) Defines job fields for defining a batch service. You can define
and order a BIM job to represent batch tasks that can seriously
impact critical business services if delayed, so BMC Batch
Impact Manager can provide early warning.
If the BMC Batch Impact Manager product is installed, select
BIM.

OS Dummy (on page 113) Defines Dummy job parameters which provide instructions to
Control-M, but do not run any script or command.
OS Dummy job

z/OS Dummy (on page 116) Defines Dummy job parameters which provide instructions to
Control-M, but do not run any script or command.
z/OS Dummy job

Control-M Report (on page 119) Enables you to define templates that you can use to generate
reports that provide important information about your
Control-M job flow.

File Watcher (on page 123) The File Watcher job type defines the ctmfw (Control-M File
Watcher) utility job to monitor file status and detect file
processes, as described in ctmfw File Watcher utility.

OS2200 (on page 142) Supports running jobs on a Unisys platform that runs on an
OS2200 operating system. You can submit OS2200 jobs for
execution using command lines or a run stream. Alternatively,
you can save your run stream as an embedded script in the
Control-M job definition.
For more information on Other Control-M/Agents, see Control-
M/Agent and remote hosts.

MAPPER (2200) Supports running jobs on other platforms, and enable you to
submit jobs for execution on the agent platform, monitor the
jobs, and perform post-processing analysis of output files. The
completion status of jobs and the results of post-processing
analysis are transmitted to the Control-M/Server.
For more information on Other Control-M/Agents, see Control-
M/Agent and remote hosts.

98
Control-M User Guide

Job type Description

OS/400 Full parameters (on Supports running jobs on other platforms, and enable you to
page 147) submit jobs for execution on the agent platform, monitor the
jobs, and perform post-processing analysis of output files. The
completion status of jobs and the result of post-processing
analysis are transmitted back to the Control-M/Server. You can
view and modify the following OS/400 type of jobs: External,
Full, Multiple Commands, Program, VT.
For more information on Other Control-M/Agents, see Control-
M/Agent and remote hosts.

Tandem job parameters (on Supports running jobs on other platforms, and enables you to
page 181) define jobs, retrieve job parameters, and control jobs running
on the Guardian operating system.
For more information on Other Control-M/Agents, see Control-
M/Agent and remote hosts.

Application Plug-ins Defines job fields for Application Plug-ins such as SAP, Oracle
E-Business Suite, or IBM Cognos.

99
Control-M User Guide

OS job parameters
The following table describes the General parameters for an OS job:

100
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed in a job definition.
The value of the job type is usually based on the platform for the job run. Jobs
defined as Dummy provide instructions for Control-M such as post-processing actions.
Value: OS

Job Name Defines the name of the job processing definition and appears in the job definition
and tracking displays, and enables you to identify the job, and order the job.
You can use variables with the Job Name.
EXAMPLE: The job script must access a file called BranchTrans with the current
date as a suffix (for example, BranchTrans_161025). Specify the file
name BranchTrans_%%Odate.

Description (From Forecast only) Provides a description of the job in free text. A well written
description can help you determine why the job was defined and how it fits into your
business workflow.

Run as dummy Enables you to run jobs of job types other than Dummy, as dummy jobs.

What Defines one or more parameters which determines what the job runs. Determines
whether the job runs as one of the following:
 Script: Defines that the jobs runs a script saved in File name located in File Path.
You can add a script parameter, as described in Adding input parameters to a
script.
 Command: Defines that the job runs a command and includes the Command.
 Embedded Script: Defines that the job runs an embedded script, and includes
the lines of the Script and the File name. You can add a script parameter, as
described in Adding input parameters to a script.
For more information about remote browsing to select a file containing the script
(from the file path), see Browse in an OS job for a file that contains a job script in a
remote host or host group.

Script Defines a script exactly as it would be specified in a terminal for the specific computer
and is part of the job definition. You can add a script parameter, as described in
Adding input parameters to a script.

Command Indicates an operating system command line entry to be submitted as a job. Use this
parameter to specify an operating system command to execute by Control-M. The
command must be specified exactly as it would be specified in a terminal for the
specific computer.

Embedded Script Defines a script exactly as it would be specified in a terminal for the specific computer
and is part of the job definition. You can add a script parameter, as described in
Adding input parameters to a script.

101
Control-M User Guide

Parameter Description

File Path File Path indicates the location of the file that contains the script.

File name Indicates the name of a member that contains one of the following in relation to the
job to be executed:
 The JCL of the job
 The started task procedure
 Warning messages

Host (/Group) Defines the name of a Control-M/Agent computer, remote host computer, or host
group where the job is submitted.

Control-M/Server Defines the name of the Control-M/Server that processes the job.

Run as Identifies the user name with the authorization to execute the job. This parameter is
used by the Control-M security mechanism.

Parent Folder Defines the name of the folder that contains the job or Sub Folder.
Names of folders and Sub Folders may be up to 64 characters, with the exception of
Control-M for z/OS folders which may be up to 8 characters. Folder names cannot
contain the character “/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders). Read only

More Defines an area of the Properties pane to click to define more parameters.

Override Path Specifies a temporarily-modified job script file without changing the original script file
in the File Path/Member library and without changing the scheduling order of a folder.

Pre-execution Specifies a command to run immediately before running the job defined by the What
parameter. The return code is ignored.

Post-execution Specifies a command to run immediately after running the job defined by the What
parameter. The return code is ignored.

Run job on all hosts Specifies that job submission details be broadcast to all agents within a defined Host
in group Group. All available agents in the Host Group run an identical job, and each such job
has a unique Order ID.

Run as Detached A regular job submitted to Control-M for execution as a background process. The
results of the job (the output) are analyzed by the post-processing subsystem.

Variables All variables are identified by the %% prefix. If %% is included in the value for a
job processing parameter, Control-M assumes that it is referring to a variable or
function. You can add a variable, as described in Adding a variable (on page 96).

102
Control-M User Guide

Parameter Description

Application Provides a logical name for sorting groups of jobs. This parameter is used to supply a
common descriptive name to a set of related job groups. The jobs do not necessarily
have to run at the same time.

Sub Application Indicates the name of the Sub Application where the job belongs logically. It is a sub-
category of the Application parameter. For example, the Application is Finances, and
the Sub Application is Payroll.

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

Documentation Defines a description related to the job, and is saved in a defined location. The
Documentation area in the Properties pane includes information about where to find
the Documentation. In a z/OS job, the Documentation is in a Doc Member located in
a Doc Library. In a non-z/OS job, the Documentation depends on whether the type is
File or URL. For a file, the description is located in a file located in a file path. For a
URL, the Documentation is located in a URL address.
NOTE: A Documentation type file is only allowed for OS jobs.

Type Defines whether the documentation for an OS job is in a file or URL. See the
following:
 URL: Defines the URL address where the documentation is located. The format
starts with "http://",https:// "ftp://", or "file://".
 File: Specifies the file that contains the job script.

Doc Path Doc Path defines the name of the file path where the Documentation is saved.

Doc File Doc File is the name of the file where the job Documentation is saved.

Priority Determines the order of job processing by Control-M in the Active Jobs database.

Critical Determines whether the job is a critical-path job in Control-M, which ensures
resources allocation order.

103
Control-M User Guide

z/OS job parameters


The following table describes the General parameters for a z/OS job.

104
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed in a job definition.
The value of the job type is usually based on the platform for the job run. Jobs
defined as Dummy provide instructions for Control-M such as post-processing
actions.
Value: z/OS

Job Name Defines the name of the job processing definition and appears in the job definition
and tracking displays, and enables you to identify the job, and order the job.

Description (From Forecast only) Provides a description of the job in free text. A well written
description can help you determine why the job was defined and how it fits into your
business workflow.

Run as dummy Enables you to run jobs of job types other than Dummy, as dummy jobs.

What Defines one or more parameters which determines what the job runs. Determines
whether the job runs as one of the following:
 Member: Defines that the job runs a JCL saved in the Member located in the
Member Library.
 Embedded JCL: Defines that the job runs an embedded JCL and includes the
lines of the JCL.
For information about verification of JCL code in a job definition, see Verifying JCL
code in a job definition (on page 84).
For more information about remote browsing to select a Member containing the JCL
(from the Member Library), see Browse in a z/OS job for the member that contains
the JCL in a library.

Member Library Indicates the location of the Member that contains the JCL, started task procedure,
or Warning message.

Member Indicates the name of a member that contains one of the following in relation to the
job to be executed:
 JCL of the job
 Started task procedure
 Warning message

Embedded JCL Defines a script exactly as it would be specified in a terminal for the specific
computer and is part of the job definition.
For information about verification of JCL code in a job definition, see Verifying JCL
code in a job definition (on page 84).

Control-M/Server Defines the name of the Control-M for z/OS that processes the job.

105
Control-M User Guide

Parameter Description

Run as Identifies the user name with the authorization to execute the job. This parameter is
used by the Control-M security mechanism.

Parent Folder Defines the name of the folder that contains the job or Sub Folder.
Names of folders and Sub Folders may be up to 64 characters, with the exception of
Control-M for z/OS folders which may be up to 8 characters. Folder names cannot
contain the character “/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders). Read-only field

More Defines an area of the Properties pane to click to define more parameters.

Override Path Specifies a temporarily-modified job script file without changing the original script
file in the File Path/Member library and without changing the scheduling order of a
folder.

Run as started task Specifies that the job is invoked with the operator START command.

Application Provides a logical name for sorting groups of jobs. This parameter is used to supply
a common descriptive name to a set of related job groups. The jobs do not
necessarily have to run at the same time.

Sub Application Indicates the name of the Sub Application where the job belongs logically. It is a
sub-category of the Application parameter. For example, the Application is Finances,
and the Sub Application is Payroll.

Scheduling Indicates the JES2 workload management scheduling environment that is to be


Environment associated with the job.

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

Request NJE Node Defines the node in the JES network where the job executes.

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

Control-D Category Defines the name of the Control-D Report Decollating Mission Category. If specified,
the report decollating mission is scheduled whenever the job is scheduled under
Control-M.

Variables All variables are identified by the %% prefix. If %% is included in the value for a
job processing parameter, Control-M assumes that it is referring to a variable or
function. You can add a variable, as described in Adding a variable (on page 96).

106
Control-M User Guide

Parameter Description

Documentation Defines a description related to the job, and is saved in a defined location. The
Documentation area in the Properties pane includes information about where to find
the Documentation. In a z/OS job, the Documentation is in a Doc Member located in
a Doc Library. In a non-z/OS job, the Documentation depends on whether the type
is File or URL. For a file, the description is located in a file located in a file path. For
a URL, the Documentation is located in a URL address.

Doc Library Defines the name of the library where the Documentation (description) is saved.

Doc Member Defines the name of the member where the job Documentation (description) is
saved.

Priority Determines the order of job processing by Control-M in the Active Jobs database.

Emergency Job Determines whether the z/OS job is an Emergency job.

107
Control-M User Guide

Batch Impact Manager job parameters


The following table describes the General parameters for a Batch Impact Manager job.

108
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed in
a job definition. The value of the job type is usually based on the
platform for the job run. Jobs defined as Dummy provide
instructions for Control-M such as post-processing actions.
Value: Batch Impact Manager

Job Name Defines the name of the job processing definition and appears in
the job definition and tracking displays, and enables you to identify
the job, and order the job.

Description (From Forecast only) Provides a description of the job in free text.
A well written description can help you determine why the job was
defined and how it fits into your business workflow.

What Defines one or more parameters which determines what the job
runs.
Determines the service name the following service parameters that
are relevant for creating a service:
 Service Name
 Service must complete
 Service Priority
 Actions
 Job Run-Time Tolerance

Service Name Logical name, from a user or business perspective, for the critical
service. BMC recommends that the service name be unique.

Service must complete Defines the time the critical service must be completed to be
considered on time. The time can be specified either by a specific
hour and/or day or on a specific hour and minute after the order
time. This parameter consists of the following sub-parameters:
 By (Number of days): Defines by what time (in HH:MM),
and in how many days, relative to the Order date, the service
must complete.
 In (Number of hours, and number of minutes after):
Defines in how many hours and minutes, the service must
complete.

Service Priority Defines the priority level of this service, from a user or business
perspective.

109
Control-M User Guide

Parameter Description

Actions Defines the automatic interventions, such as rerunning a job,


displaying the critical service in BMC Service Impact Manager, or
extending the service due time. The action is performed if the job
finished too quickly, there is a job failure on service path, or the
service finished late or too quickly.
 When: Defines the BIM event that triggers the action, as
described in BIM Events (on page 112)
 Do: Defines the action, as described in Batch Impact Manager
Service Actions

Job Run-Time Tolerance Defines the type of deviation from the average completion time for
a job in the service. If the run time falls within the tolerance set, it
is considered on time, otherwise it has run too long or ended too
early. The values are Percentile range or Average Run Time (in
percentage or by minutes).
 Percentile range: Defines the number of standard deviations of
job run in this service. Percentile Range is the default method
for specifying Job Run-Time Tolerance.
 Average run time +/-: The percentage of the time (based on
the average run time for the job) or the number of minutes
that the job can be early or late, and still be considered on
time.
For information on setting the service completion time, see Service
must complete.

Where Defines an area of the Properties pane for defining the Control-
M/Server of the job.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for z/OS)
that processes the job.

How Defines an area of the Properties pane for defining how the job
runs. For example, it includes the Run as user.

Run as Identifies the user name with the authorization to execute the job.
This parameter is used by the Control-M security mechanism.

Parent Folder Defines the name of the folder that contains the job or Sub Folder.
Names of folders and Sub Folders may be up to 64 characters,
with the exception of Control-M for z/OS folders which may be up
to 8 characters. Folder names cannot contain the character “/”.
SMART Folders in Control-M for z/OS can only contain jobs (not
Sub Folders).

110
Control-M User Guide

Parameter Description

More Defines an area of the Properties pane to click to define more


parameters.

Run job on all hosts in group Specifies that job submission details be broadcast to all agents
within a defined Host Group. All available agents in the Host Group
run an identical job, and each such job has a unique Order ID.

Variables All variables are identified by the %% prefix. If %% is included


in the value for a job processing parameter, Control-M assumes
that it is referring to a variable or function. You can add a variable,
as described in Adding a variable (on page 96).

Application Provides a logical name for sorting groups of jobs. This parameter
is used to supply a common descriptive name to a set of related
job groups. The jobs do not necessarily have to run at the same
time.

Sub Application Indicates the name of the Sub Application where the job belongs
logically. It is a sub-category of the Application parameter. For
example, the Application is Finances, and the Sub Application is
Payroll.

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

Documentation Defines a description related to the job, and is saved in a defined


location. The Documentation area in the Properties pane includes
information about where to find the Documentation. In a z/OS job,
the Documentation is in a Doc Member located in a Doc Library. In
a non-z/OS job, the Documentation depends on whether the type
is File or URL. For a file, the description is located in a file located
in a file path. For a URL, the Documentation is located in a URL
address.

Type Defines whether the documentation for an OS job is in a file or


URL. See the following:
 URL: Defines the URL address where the documentation is
located. The format starts with "http://", "ftp://", or "file://".
 File: Specifies the file that contains the job script.

Doc Path For a z/OS job, Doc Library defines the name of the library where
the Documentation (description) is saved. For a non-z/OS job, Doc
Path defines the name of the file path where the Documentation is
saved.

111
Control-M User Guide

Parameter Description

Doc File For a z/OS job, defines the name of the member where the job
Documentation (description) is saved. For a non-z/OS job, the Doc
File is the name of the file where the job Documentation is saved.

Priority Determines the order of job processing by Control-M in the Active


Jobs database.

Critical Determines whether the job is a critical-path job in Control-M,


which ensures resources allocation order.

Not all parameters are relevant if a BIM service is defined for z/OS services.

BIM Events
The following tables describes When parameters for Action Details.

On Event Description

Job failure on One or more of the jobs in the critical service failed and caused a
service path delay in the service.
A service is considered OK even if one of its jobs fails, provided
that another job, with an Or relationship to the failed job, runs
successfully.

Service is late The entire service is late according to BMC Batch Impact Manager
calculations.

Job ran too long One of the jobs in the critical service is late. Lateness is
calculated according to the average run time and the value of the
Job Runtime Tolerance parameters.
A service is considered on time even if one of its jobs is late,
provided that the service itself is not late.

Job ended too One of the jobs in the critical service is early. Earliness is
quickly calculated according to the average run time and the value of the
Job Runtime Tolerance parameters.
A service is considered on time even if one of its jobs is early.

112
Control-M User Guide

OS Dummy job parameters


The following table describes the General parameters for an OS Dummy job.

113
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are
exposed in a job definition. The value of the job type is usually
based on the platform for the job run. Jobs defined as Dummy
provide instructions for Control-M such as post-processing
actions.
Value: Dummy (OS)

Job Name Defines the name of the job processing definition and appears
in the job definition and tracking displays, and enables you to
identify the job, and order the job.

Description (From Forecast only) Provides a description of the job in free


text. A well written description can help you determine why the
job was defined and how it fits into your business workflow.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for


z/OS) that processes the job.

Run as Identifies the user name with the authorization to execute the
job. This parameter is used by the Control-M security
mechanism.

Parent Folder Defines the name of the folder that contains the job or Sub
Folder.
Names of folders and Sub Folders may be up to 64 characters,
with the exception of Control-M for z/OS folders which may be
up to 8 characters. Folder names cannot contain the character
“/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders).

Variables All variables are identified by the %% prefix. If %% is


included in the value for a job processing parameter, Control-M
assumes that it is referring to a variable or function.

Application Provides a logical name for sorting groups of jobs. This


parameter is used to supply a common descriptive name to a
set of related job groups. The jobs do not necessarily have to
run at the same time.

Sub Application Indicates the name of the Sub Application where the job
belongs logically. It is a sub-category of the Application
parameter. For example, the Application is Finances, and the
Sub Application is Payroll.

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

114
Control-M User Guide

Parameter Description

Documentation Defines a description related to the job, and is saved in a


defined location. The Documentation area in the Properties
pane includes information about where to find the
Documentation. In a z/OS job, the Documentation is in a Doc
Member located in a Doc Library. In a non-z/OS job, the
Documentation depends on whether the type is File or URL. For
a file, the description is located in a file located in a file path.
For a URL, the Documentation is located in a URL address.

Type Defines whether the documentation for an OS job is in a file or


URL. See the following:
 URL: Defines the URL address where the documentation is
located. The format starts with "http://", "ftp://", or
"file://".
 File: Specifies the file that contains the job script.

Doc Path For a z/OS job, Doc Library defines the name of the library
where the Documentation (description) is saved. For a non-
z/OS job, Doc Path defines the name of the file path where the
Documentation is saved.

Doc File For a z/OS job, defines the name of the member where the job
Documentation (description) is saved. For a non-z/OS job, the
Doc File is the name of the file where the job Documentation is
saved.

Priority Determines the order of job processing by Control-M in the


Active Jobs database.

Critical Determines whether the job is a critical-path job in Control-M,


which ensures resources allocation order.

115
Control-M User Guide

z/OS Dummy job parameters


The following table describes the General parameters for a z/OS job.

116
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed in a job definition.
The value of the job type is usually based on the platform for the job run. Jobs
defined as Dummy provide instructions for Control-M such as post-processing
actions.
Value: Dummy (z/OS)

Job Name Defines the name of the job processing definition and appears in the job definition
and tracking displays, and enables you to identify the job, and order the job.

Description (From Forecast only) Provides a description of the job in free text. A well written
description can help you determine why the job was defined and how it fits into your
business workflow.

Control-M/Server Defines the name of the Control-M for z/OS that processes the job.

Run as Identifies the user name with the authorization to execute the job. This parameter is
used by the Control-M security mechanism.

Parent Folder Defines the name of the folder that contains the job or Sub Folder.
Names of folders and Sub Folders may be up to 64 characters, with the exception of
Control-M for z/OS folders which may be up to 8 characters. Folder names cannot
contain the character “/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders). Read-only field

More Defines an area of the Properties pane to click to define more parameters.

Application Provides a logical name for sorting groups of jobs. This parameter is used to supply
a common descriptive name to a set of related job groups. The jobs do not
necessarily have to run at the same time.

Sub Application Indicates the name of the Sub Application where the job belongs logically. It is a
sub-category of the Application parameter. For example, the Application is Finances,
and the Sub Application is Payroll.

Scheduling Indicates the JES2 workload management scheduling environment that is to be


Environment associated with the job.

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

Request NJE Node Defines the node in the JES network where the job executes.

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

117
Control-M User Guide

Parameter Description

Control-D Category Defines the name of the Control-D Report Decollating Mission Category. If specified,
the report decollating mission is scheduled whenever the job is scheduled under
Control-M.

Variables All variables are identified by the %% prefix. If %% is included in the value for a
job processing parameter, Control-M assumes that it is referring to a variable or
function. You can add a variable, as described in Adding a variable (on page 96).

Documentation Defines a description related to the job, and is saved in a defined location. The
Documentation area in the Properties pane includes information about where to find
the Documentation. In a z/OS job, the Documentation is in a Doc Member located in
a Doc Library. In a non-z/OS job, the Documentation depends on whether the type
is File or URL. For a file, the description is located in a file located in a file path. For
a URL, the Documentation is located in a URL address.

Doc Library Defines the name of the library where the Documentation (description) is saved.

Doc Member Defines the name of the member where the job Documentation (description) is
saved.

Priority Determines the order of job processing by Control-M in the Active Jobs database.

Emergency Job Determines whether the z/OS job is an Emergency job.

118
Control-M User Guide

Control-M Report job parameters


The following table describes the General parameters for an Control-M Report job.

119
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed in a job definition.
The value of the job type is usually based on the platform for the job run. Jobs
defined as Dummy provide instructions for Control-M such as post-processing actions.
Value: Control-M Report

Job Name Defines the name of the job processing definition and appears in the job definition
and tracking displays, and enables you to identify the job, and order the job.

Description (From Forecast only) Provides a description of the job in free text. A well written
description can help you determine why the job was defined and how it fits into your
business workflow.

Run as dummy Enables you to run jobs of job types other than Dummy, as dummy jobs.

Control-M Report Defines the following parameters:


Attributes (Details)
 Run as
 User
 Password
 Password file
 Sever Host
 emreportcli Path
 Template
 Template path
 Output to:
Output to file (Output file type and Output file)
Output to Sysout
 Report Parameters (Parameter Name and Parameter Value)
 Save
For more information about the emreportcli utility, see Control-M Reporting Facility.

Run as Identifies the user name with the authorization to execute the job. This parameter is
used by the Control-M security mechanism.

User Control-M/EM user that runs the report.

Password Control-M/EM user password.

Password file Flat file containing an unencrypted username and password in the following format:
user=username password=password.

120
Control-M User Guide

Parameter Description

Server Host Host name of the Control-M/EM Server.

emreportcli path Specifies the path where Reporting Facility is installed on Control-M/EM.

Template Specifies the name of the template.

Template path Specifies the folder in which the template file is located.

Output to file Sends the output to a specified file to:


 Output file type
 Output file

Output file type Specifies the type of the output file, such as EXCEL, EXCEL_DO (for data only), PDF,
DOC, HTML, TXT, or XML.

Output file Specifies the full filename of the output file (which is overwritten if it exists already).

Output to Sysout Defines where to send the job report.

Report Parameters Defines an individual parameter, whose name and value is specified.

Parameter Name Name of the parameter as defined in the report template filter panel.

Parameter Value Value of the report parameter (wildcard characters can be used for text fields when
the field operator in the filter panel is set to "LIKE" for the fields)

Save Defines the Save button to save the Job specific settings.

Host (/Group) Defines the name of a Control-M/Agent computer, remote host computer, or host
group where the job is submitted.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for z/OS) that processes the
job.

Parent Folder Defines the name of the folder that contains the job or Sub Folder.
Names of folders and Sub Folders may be up to 64 characters, with the exception of
Control-M for z/OS folders which may be up to 8 characters. Folder names cannot
contain the character “/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders). Read only

More Defines an area of the Properties pane to click to define more parameters.

Run job on all hosts Specifies that job submission details be broadcast to all agents within a defined Host
in group Group. All available agents in the Host Group run an identical job, and each such job
has a unique Order ID.

121
Control-M User Guide

Parameter Description

Variables All variables are identified by the %% prefix. If %% is included in the value for a
job processing parameter, Control-M assumes that it is referring to a variable or
function.

Application Provides a logical name for sorting groups of jobs. This parameter is used to supply a
common descriptive name to a set of related job groups. The jobs do not necessarily
have to run at the same time.

Sub Application Indicates the name of the Sub Application where the job belongs logically. It is a sub-
category of the Application parameter. For example, the Application is Finances, and
the Sub Application is Payroll.

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

Documentation Defines a description related to the job, and is saved in a defined location. The
Documentation area in the Properties pane includes information about where to find
the Documentation. In a z/OS job, the Documentation is in a Doc Member located in
a Doc Library. In a non-z/OS job, the Documentation depends on whether the type is
File or URL. For a file, the description is located in a file located in a file path. For a
URL, the Documentation is located in a URL address.

Type Defines whether the documentation for an OS job is in a file or URL.. See the
following:
 URL: Defines the URL address where the documentation is located. The format
starts with "http://", "ftp://", or "file://".
 File: Specifies the file that contains the job script.

Doc Path For a z/OS job, Doc Library defines the name of the library where the Documentation
(description) is saved. For a non-z/OS job, Doc Path defines the name of the file path
where the Documentation is saved.

Doc File For a z/OS job, defines the name of the member where the job Documentation
(description) is saved. For a non-z/OS job, the Doc File is the name of the file where
the job Documentation is saved.

Priority Determines the order of job processing by Control-M in the Active Jobs database.

Critical Determines whether the job is a critical-path job in Control-M, which ensures
resources allocation order.

122
Control-M User Guide

File Watcher job parameters


The following table describes the General parameters for a File Watcher job.
For more information about the Control-M File Watcher, see ctmfw File Watcher utility.

123
Control-M User Guide

Parameter Description

Path Defines the path of the file to be detected. The file name can include wildcard
character * to represent any number of characters (including no characters) or ? to
represent any one character.

Mode Determines whether to detect creation or deletion of a file as follows:


 Create: Detects creation of a file. File size is ignored if the filename parameter
contains wildcards (unless the monitor file size when wildcard is used
parameter is set to Y).
 Delete: Detects deletion of a file. When the ctmfw utility is run in this mode, it
first checks for files that match the specified name. After a specified file is
detected, the ctmfw utility checks at the specified interval for deletion of that file.

Minimum size Minimum file size in bytes, KB, MB or GB . This parameter is ignored if the Path
parameter contains wildcards (unless the Wildcard support parameter is set to Yes)
or if the mode parameter is set to DELETE.

Search interval Interval between successive attempts to detect the existence/deletion of a file (in
seconds).

File size interval Interval between attempts to monitor the size of a file after it is detected (in
seconds). This parameter is ignored when using wildcards in FILE or when using
DELETE mode.

Iterations Number of attempts to monitor file size where the size remains static and greater
than or equal to Minimum Size (indicating successful creation of the file). This
parameter is ignored when using wildcards in FILE or when using DELETE mode.

Wildcard support Indicates whether the file size should be monitored if the filename contains wildcards.
This parameter is ignored if the Path does not contain a wildcard.

Time limit 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/deleted in this specified time frame, the process terminates with an error
return code.

Start Indicates an absolute time at which the utility starts monitoring the file.

Stop Indicates an absolute time at which the file is no longer watched.

Maximal age Indicates the maximum amount of time that can pass since the file you want to watch
was last modified.

Minimal age Indicates the minimum amount of time that must have passed since the file you want
to watch was last modified.

124
Control-M User Guide

125
3

File Transfer job definition


3
Control-M for MFT is an FTP/SFTP client and server that enables you to watch and transfer files from a
local host to a remote host, a remote host to a local host, or a remote host to another remote host, as
described in Defining a File Transfer job (on page 127).
A Control-M for MFT job can contain up to five different file transfer definitions, which are executed
sequentially. Each definition can transfer one or more files, or an entire directory, with the option of
including all of its subdirectories.
Control-M for MFT contains the following additional functionality:
 Rerun file transfers from the exact point where the transfer failed, which saves time and resources
(see Optional parameters (on page 129)).
 Determine how to handle files after a transfer (see Advanced general parameters (on page 130)).
 Encrypt the transferred files with different encryption methods (see SFTP parameters (on page 137)).
 Configure pre and post transfer and PGP commands (see Commands parameters (on page 138)).
 Watch specific files until a maximum size is reached or a defined time has passed, and then transfer
the files (see File Watcher parameters (on page 138)).
 Monitor a Control-M for MFT job in real-time (see Monitoring a Control-M for MFT job (on page 140)).
Control-M for MFT jobs are integrated with other Control-M jobs into a single scheduling environment.
Control-M capabilities are available for Control-M for MFT, including advanced scheduling criteria, complex
dependencies, quantitative and control resources, and variables.
To access the MFT form, see Accessing the File Transfer job properties pane (on page 126).
Job definition parameters in Control-M for MFT enable you to apply values for the variables. For a list of
Control-M for MFT parameters, see Control-M for MFT parameters.

Accessing the File Transfer job properties pane


This procedure describes how to access the File Transfer job properties pane, which enables you to define
a File Transfer job.

 To access the File Transfer job properties pane:


1. Log in to the Control-M, as described in Logging in to Control-M (on page 10).
2. From the Planning domain, select Blank workspace or open an existing workspace.
A workspace appears and is automatically checked out.
3. From the Home tab, drag and drop the File Transfer job template from the job palette into the
workspace or an existing folder.
4. If the Control-M Server Selection dialog box appears, select the Control-M/Server for the job you
are defining, and click OK.
A File Transfer job is created in a new folder or in an existing folder. A Synopsis view of the job
properties appears in the right pane.

126
Control-M User Guide

5. Select .
A detailed view of the job properties appears in the right pane. Each parameter is saved when you
exit the parameter field.

Defining a File Transfer job


This procedure describes how to define an MFT job, which enables you to watch and transfer files from a
local host to a remote host, a remote to a local host, or a remote host to another remote host.

Before You Begin


Ensure that you have met the following requirements:
 A configured Control-M for IBM Cognos connection profile, as described for the Control-M for MFT
Connection profile management.
 Successful completion of Accessing the Accessing the File Transfer job properties pane (on page 126).

 To define a File Transfer job:


1. In the General tab, from the Connection Profile field, click .
The Select Connection Profile dialog box appears.
2. In the Connection Profile Type area, select one of the following:
• Endpoint1 <-> Endpoint2: Shows connection profiles that are defined with two hosts. Select
this option if the source and destination locations are defined in the same connection profile.
• Two Single Endpoints: Shows connection profiles that are defined with one host. Select this
option if the source and destination locations are defined in separate connection profiles.
3. Select the connection profile(s) that you want to use to transfer files, and click OK.
4. In the Transfers area, do the following:
a. In the Transfers area, in the first field browse for the file, directory, or library to transfer.You can
also type the path manually.
b. In the second field, browse for the file, directory, or library to transfer. You can also type the path
manually.
c. Select the transfer option, as described in Transfer options (on page 128).
NOTE: You can transfer up to five files at a time, but file transfers within a job are sequential, which
means that if a file transfer fails, subsequent file transfer definitions are not performed, unless you
select the Continue on failure checkbox, as described in Advanced general parameters (on page
130).
5. From the Type drop-down list, select the transfer format.
EBCDIC format is supported only when transferring files between two MVS FTP hosts.
6. Click Advanced.
The Advanced dialog box appears.
7. Select the required options, as described in Advanced options (on page 130), and click OK.
8. Select the optional parameters if required, as described in Optional parameters (on page 129).

127
Control-M User Guide

9. Click More.
The Pre-execution Command and Post-execution Command fields are used to define specific
commands to execute at the beginning or at the end of a job. These commands can only be executed
on a computer where Control-M/Agent is installed, and the output of the commands (pre or post)
appears in the job output.

Transfer options
The following table lists the transfer options.

Parameter Description

Transfers the file from Host1 to Host2

Transfers the file from Host2 to Host1

Watches the file until it reaches a certain size or passes a


time limit, and then transfers the file from Host2 to Host1.
For more information on file watching, see File Watcher
parameters (on page 138).

Watches the file until it reaches a certain size or passes a


time limit, and then transfers the file from Host1 to Host2.

Watches the file until it reaches a certain size or passes a


time limit.
For more information on file watching, see File Watcher
parameters (on page 138).

If you have successfully watched a file using a variable, you can share that variable to an additional
transfer in the Source path within the same job using the following variables:
 $$WATCH_ALLn$$: Determines the full file name including the extension of the successfully
watched file
 $$WATCH_NAMEn$$: Determines the file name only without the extension of the successfully
watched file
 $$WATCH_EXTn$$: Determines the extension of the successfully watched file
NOTE: n represents the number of the watch/transfer of the possible 5 in the job.
If you selected the Rerun from point of failure checkbox, you can not use the above variables.

128
Control-M User Guide

Optional parameters
The following table lists the optional parameters.

Parameter Description

End job NOTOK when Sets the job status to NOTOK when the Continue on failure
“Continue on failure” checkbox is selected in the General tab in the Advanced
option is selected dialog box, and the transfer failed.

Rerun from point of Resumes the file transfer from the point that it failed.
failure
If you are connecting to an FTP server, you must select this
checkbox and the Restart from failure checkbox, as
described in Creating a connection profile.
The transfer can only be resumed from the exact position
where the failure occurred if the FTP server supports REST
commands.
If you HOLD a job, and then rerun it, the job automatically
reruns from the beginning.
If the Append option is selected in the General tab, the
Rerun from point of failure option is ignored.

Use default number of Uses the default number of retries to re-establish a failed
retries connection.
NOTE: If you are using an MVS platform, this checkbox is
disabled.

Retrieve Retrieves the default number of times Control-M for MFT


tries to re-establish a failed connection.

129
Control-M User Guide

Advanced options
The following table lists the advanced dialog box options.

Parameter Description

Advanced general parameters Determines how to handle general parameters for MFT jobs
(on page 130)

OS400 parameters (on page Describes the parameters for OS400 hosts
134)

MVS parameters (on page Describes the parameters for MVS hosts
135)

SFTP parameters (on page Determines the SFTP encryption algorithms and
137) compressions for each hos

Commands parameters (on Describes pre, post, and PGP commands for the transfer
page 138)

File Watcher parameters (on Describes File Watcher parameters


page 138)

Advanced general parameters


The File name field in the After the completion of a successful file transfer the source file will
be, After the completion of a successful file transfer the destination file will be and Create
Empty File fields parameters can contain variables, constants, and the following variables:

130
Control-M User Guide

 AFTFILE$$: Contains the name of the original file without file extension. (If there was an extension,
it is always added to the name of the file.)
 $$AFTFILE_ALL$$: Contains the full file name including the extension
 $$AFTFILE_NAME$$: Contains only the name of the file until the last dot (without the extension).
 $$AFTFILE_EXT$$: Contains only the extension of the file name
EXAMPLE: If you want to rename a transferred file old_cmd_060101.exe,when it was originally named
cmd.exe, the pattern you must specify is old_$$AFTFILE$$_%%DATE.
The following table lists the advanced general parameters.

131
Control-M User Guide

Parameter Description

After the completion of a Determines how a source file is handled after a successful
successful file transfer transfer:
the source file will be
Left as is: Retains the source file with the original name
Deleted: Deletes the source file
Renamed: Renames the source file with a valid name for
the operating system of the host computer (256 characters).
Moved: Moves the file to a specified location (full path only)
(Not available for MVS)
NOTE:If the action fails, Control-M for MFT attempts a retry
according to the number of retries, as described in Control-M
configuration parameters.

Fail transfer when action Determines whether to fail the transfer when a post action
on source file failed on the source file fails after a successful transfer.

If the file of the same Determines what to do to a file that has the same name as
name as the destination the destination file:
file already exists:
Overwrite: Replaces the existing file with the transferred
file
Append: Attach the transferred file to the existing file, as
well as, transfer multiple files into one combined file, using a
wildcard character
Abort: Cancels the file transfer
Skip: Skips the file

After the completion of a Determines how a destination file is handled after a


successful file transfer successful transfer:
the destination file will be
Left as is: Retains the source file with the original name
Renamed: Renames the source file with a valid name for
the operating system of the host computer (256 characters).
Moved: Moves the file to a specified location (full path only)
(Not available for MVS)
NOTE:If the action fails, Control-M for MFT attempts a retry
according to the number of retries, as described in Control-M
configuration parameters.

132
Control-M User Guide

Parameter Description

Create empty file in Creates an empty file after a transfer on the destination
destination host.
If you are transferring a file or multiple files, the empty file
is created in the directory where the file(s) are transfered.
If you are transferring a directory, the empty file is created
in the directory where the transfer directory is created.

Use temporary file prefix Prevents overwriting files by attaching a temporary file
prefix, such as FTP_ to the destination file until the transfer
completes successfully.
On OS/400 systems, the file name is limited to 10
characters. The temporary prefix can be up to 99 characters
long on all other systems.
NOTE: On z/OS systems, the file name is limited to 8
characters.
The temporary file name that is created by applying the
prefix must be a valid file name for the operating system of
the destination host computer.

Continue on failure Allows successive transfers to run when this specific transfer
fails

Delete destination file on Deletes the failed transferred file from the destination host.
failure
If you transferred multiple files, the last file that failed is
deleted.

Do post AFT command on Activates the defined post commands when the job fails.
failure

Recursive Transfers a file directory with all its subdirectories and all
files that match the wildcard pattern in the source file path
field under all sub-directories.
Files are transferred in the destination with the same
directory structure as the source directory structure.

Exclude Files Determines whether to exclude all the files that match the
transfer pattern when you define a transfer with a wildcard.

Strip the version number Removes the version number from the file name when it is
on a file name when it is transferred from OpenVMS.
transferred from
OpenVMS

133
Control-M User Guide

OS400 parameters
The following table lists the OS400 parameters.

Parameter Description

Trailing blanks options for Determines how Trailing Blanks are managed:
OS/400 database record
 Send Trailing Blanks: The server sends trailing blanks
for all database records. This option is relevant only for
files that are transferred in ASCII mode.
 Do not send Trailing blanks for Database files
with file structure: The server does not send trailing
blanks of database records when transferring files that
use a file structure and stream mode.
 Do not send Trailing blanks for all Database files:
The server does not send trailing blanks for any
database records.

Allow Transfer of Files Transfers files to an OS400 platform with NULL fields.
with NULL Fields

Allow OS400 IFS Case Supports the transfer of case sensitive file systems.
Sensitive Mode

134
Control-M User Guide

MVS parameters
The following table lists the MVS parameters. The parameters that are defined here for this specific
transfer override the parameters defined in MVS File Template Management.

135
Control-M User Guide

Parameter Description

Template Name Defines the name of the MVS template that is defined in
MVS File Template Management, as described in MVS file
template management.

Load Loads the name of the MVS template that is defined in MVS
File Template Management.

Record Format Determines the value for the record format.

Logical Record Length Determines the logical record length values between 0-
32760.

Block Size Determines the block size values between 0-32760.

Translate Table Determines what table is used by the FTP server during
transfer for translation (8 characters maximum or select
from list).
If you want to add or delete values to and from the list, you
need to add them as comma separated values, to the
XLT.dat file in the following location:
<Control-M/Agent_Directory>/cm/AFT/data

DBCS Encoding Determines which DBCS data sets are used for the transfer.

Allocation Units Determines which allocation unit type is used for the
transfer.

Volume Defines the volume value (6 characters maximum).

Unit Defines unit value (8 characters maximum).

Primary Defines the primary allocation amount between 1-16777215.

Secondary Defines the secondary allocation amount between 0-


16777215.

136
Control-M User Guide

Parameter Description

Transfer Mode Determines the mode used to transfer files:


 Block: Transfers the file as a series of data blocks
preceded by one or more header bytes.
 Stream: Transfers the file as a stream of bytes.

SMS Management Class Determines which SMS Management Class is assigned to a


new data set.

SMS Data Class Defines the SMS Data Class provided by your organization
for the FTP server.

Additional Options Defines MVS FTP Server SITE command sub-parameters and
(Host1, Host2) values (214 characters maximum).
To work with GDG data sets, type:
DCbdsn=model_dataset_name.

Transfer to unique file Creates a file with a unique name on the remote system
instead of overwriting an existing file. The FTP server on the
remote system sends the name of the created file back to
the MFT client.
When you select this option, you cannot do any of the
following:
 Use a temporary prefix for the destination file
 Rename the destination file
 Rerun from point of failure

SFTP parameters
The following table lists the SFTP parameters. The parameters that are defined here for this specific
transfer override the parameters defined in Control-M Configuration Manager . Do not change the current
settings unless you need to change the pre-defined encryption and compression values.

Parameter Description

Compression Compresses the file before the transfer

Preserve the File Preserves the source’s file permissions and timestamps on
Attributes and the destination host
Timestamps

137
Control-M User Guide

Commands parameters
The following table lists the commands parameters:

Parameter Description

chmod Changes the file permissions.


You can use a wildcard to define this parameter.

mkdir Creates a directory

rename Renames a file or a directory

rm Deletes a file.
You can use a wildcard to define this parameter.

rmdir Deletes a directory

Enable PGP encryption Enables PGP encryption commands for this transfer

Template Name Determines the name of the PGP template defined in the
Control-M Configuration Manager Creating a PGP template.
Click Load to access a list of templates.

Keep encrypted files Saves the PGP encrypted file after encryption with the
following name format:
<filename>.pgp_aft

Except for the local host, where the default path is the Control-M/Agent's home directory, you must define
the full path when you run the chmod, mkdir, rename, rm, and rmdir commands.
For MVS hosts you do not need to define the full path. The home directory path specified in the
connection profile definition for this host can be used.

File Watcher parameters


Control-M for MFT enables you to watch a file until it reaches a certain size or has reached a maximum
time limit. After the criteria is met, the file watch is complete, the file is transferred or continues to the
next file transfer definition in the job.
To watch or watch and transfer files, see Defining a File Transfer job (on page 127). To configure
additional File Watcher parameter, see Configuring Control-M for MFT parameters.

138
Control-M User Guide

The following table lists the File Watcher parameters in the Advanced dialog box.

Parameter Description

Minimum detected size Defines the minimum number of bytes transferred before
Control-M for MFT checks if the file is static.
File size information for remote file systems is not
supported.
This feature is not supported on OS400, Tandem, MVS,
OpenVMS, and OS2200 when the connection type is FTP.

Maximum time to wait Determines the number of minutes to wait, in the Time Limit
field, for a file to reach its minimum detected size and
remains static, according to the values defined in the
Configuration Management window, as described in
Configuring Control-M for MFT parameters.
If the value is 0, the file waits indefinitely.

Wait until Determines the specific time, in the Time Limit field, that a
file has to reach its minimum detected size and remains
static, according to the values defined in the Configuration
Management window, as described in Configuring Control-M
for MFT parameters, before the watch fails

Variable containing Defines the variable name that contains the detected file
detected file name name

Maximum file age Defines the maximum number of years, hours, and/or days
that can pass since the watched file was last modified.
For example, 2y3d means that after 2 years and 3 days have
passed the file will no longer be watched.

Minimum file age Defines the minimum number of years, hours, and/or days
that must pass since the watched file was last modified.
For example, 2y3d means that after 2 years and 3 days
must pass before the file can be watched.

Transfer all matching files Watches the first matching file with a wildcard and waits
until the watching criteria is met, and then transfers all
matching files
The file watch criteria is checked for the first file. The
remaining files are transferred without checking.

NOTE: The Maximum file age and Minimum file age features are supported if the user defined for the
watch host has write permissions on the destination path.
NOTE: In the job log, if the OSCOMPSTAT parameter is 7 it indicates that file watch failed.

139
Control-M User Guide

Transfer formats
The following table describes the different formats you can use to transfer files, directories or libraries.

Transfer format Description

File to File Transfers a single file from a defined source to a defined


destination.
EXAMPLE: To transfer Readme.txt from its source location to a
defined destination, renaming the file to Writeme.txt,
define D:\Temp\Readme.txt in the source transfer
field, and C:\Directory1\Writeme.txt in the
destination transfer field.
NOTE: If no file name is specified in the destination transfer field,
the file retains its original name. However, a destination file name
must be specified when MVS is the transfer destination.

Directory and Contents Transfers a directory from a defined source to a defined


destination.
(OS/400, Microsoft Windows
and UNIX only) EXAMPLE: To transfer the /h/userb/ directory to /p/home2/,
define /h/userb/ in the source transfer field, and
/p/home2/ in the destination transfer field. The userb
directory is created under /p/home2/.
NOTE: The Recursive transfer option is available. If this is
selected, all subdirectories are also transferred.

NOTE:
 MVS, OS/400, and OS2200 systems support the * wildcard character but only when defined as the
latter part of a file name.
 MVS supports the % wildcard character.
 If you use a wildcard, and no files match the defined pattern, the job ends successfully.
 Transfer of file names with spaces are supported only for platforms that support a convention of file
names that include blanks.

Monitoring a Control-M for MFT job


This procedure describes how to monitor a Control-M for MFT job in the Control-M which provides the
transfer status in real-time.

 To monitor a Control-M for MFT job:


 Navigate to the required Control-M for MFT job in the Monitoring domain.
The status of the Control-M for MFT job is displayed in the left pane next to the job name, as
described in Control-M for MFT job statuses (on page 141).

140
Control-M User Guide

Control-M for MFT job statuses


The following table describes the different statuses in a Control-M for MFT job.

Status Description

Waiting Waiting for execution

In progress The file is transferring.

Ended OK The transfer completed successfully.

Failed The file failed to transfer.

Killed The transfer is canceled by request.

Abandoned The file did not transfer due to a previous transfer that failed.

Skipped The file transferred successfully in a previous attempt, but it is


part of a job that failed, and therefore, this file transfer is skipped
when the job returns.

File Watching A is watched until it reaches a certain size or has reached a


maximum time limit.

NOTE: When transferring a file from MVS, OS/400, or OpenVMS, or transferring more than a single file in
a recursive transfer, the size of the transferred files is not known. Therefore, the progress bar and Time
Remaining fields are set at zero and updated to 100% at the end of a successful file transfer. Similarly,
the Transferred Out of Total and Rate fields are updated every 30 seconds.
NOTE: Indicators appear next to each job that show the statuses of the watch or transfer. This is only
valid for Control-M/EM 7.0.00.200 and above, Control-M/Server 7.0.00.102 and above, and Control-
M/Agent 7.0.00.100 and above.

141
Control-M User Guide

OS2200 parameters
The following table describes OS2200 parameters:

142
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed
in a job definition. The value of the job type is usually based on
the platform for the job run. Jobs defined as Dummy provide
instructions for Control-M such as post-processing actions.

Job Name Defines the name of the job processing definition and appears in
the job definition and tracking displays, and enables you to
identify the job, and order the job.

Description Provides a description of the job in free text. A well written


description can help you determine why the job was defined and
how it fits into your business workflow.

What What to run:


 Runstream: Indicates that the job executes an existing
operating system runstream.
 Embedded Script: Indicates that the job executes the run
stream embedded within the Control-M job definition.
 Command: Indicates that the job executes an operating
system command line.

Embedded Script Defines a script exactly as it would be specified in a terminal for


the specific computer and is part of the job definition.

Run as Identifies the user name with the authorization to execute the job.
This parameter is used by the Control-M security mechanism.

Account ID Optional. Specifies the desired account ID to be set on the runcard


of the job.

Qualifier Mandatory. Indicates the qualifier name of the job runstream


location.

File Mandatory. Specifies the file name of the job runstream location.

Cycle Optional. Defines the cycle number of the file.


Default: 1

Element Optional. Specifies the element name within the file which
contains the job runstream location.

Version Optional. Indicates the version of the element.

Overriding Qualifier Optional. Specifies a temporarily-modified qualifier name of the


job runstream location without changing the original.

143
Control-M User Guide

Parameter Description

Command line Mandatory. Indicates the command line entry, if this is a


Command type of job.

Pre-command Optional. Determines the command line instruction to be executed


before the specified command line.

Post-command Optional. Determines the command line instruction to be executed


after the specified command line.

Priority Optional. Determines the job's OS2200 processing priority.

Options Optional. Specifies the options to be set with the @START


command.

Run ID Optional. Indicates the desired run ID to be set on the runcard of


the job.
Default: order_ID run_Number

Project ID Optional. Defines the desired project ID to be set on the runcard


of the job.

Do not use @SYM and Indicates that an additional @SYM and @BRKPT will not be added
to the job’s wrapper.
@BRKPT in job wrapper
Checked: There is no additional @SYM or @BKRPT redirection
statements besides the ones contained by the job’s JCL. The
SYSOUT will be written only if MULTIPLE_SYM is set to Y or Y-ALL
(Equivalent to Printout data to include in SYSOUT is set to All job
printouts. The printouts can be retained or not retained). See
Multiple SYM options.
Cleared: (Default) The job’s wrapper will include @BRKPT and
@SYM redirection to the queue of the user id under which the job
is executing.

Use original runcard from user Uses the runcard as specified in the job runstream
job runstream
in the job wrapper. Default: unchecked

Use Run id from autoedit Uses the run Id on the job runcard on submission, based on the
variable or job's runstream value of the Run Id field, or based on the run Id as specified on
the original job's runstream runcard.
Equivalent: USER-RUNIDS

Allow job submission under Runs the job under the specified user Id via the @START,/U
different owner option.

144
Control-M User Guide

Parameter Description

Analyze and translate Parses user runstream content and resolve any
variables in job specified variables. Default: unchecked
runstream Equivalent: RUNSARG

Inc.job bkp.output Includes user runstream’s @SYM or @BRKPT parts


in output. Default: unchecked

Do not set job owner to job Does not set the job wrapper’s owner to the specified user.
wrapper on submission Default: unchecked
Equivalent: SKIPCHGOWN

Perform account validation An option to validate the specified account before allowing
before submission submission. Default: unchecked

Bypass checking of the status Bases the job completion and exit code solely on the job’s
file indicator completion statistics.

Do not run user job via Executes user job content as is. Default: unchecked
@ADD in job wrapper

Set Condition Specifies a positive octal number to be placed in T2 of the


condition word of the run being scheduled.

Pages Indicates the estimated number of printed pages expected as


output from the run.

Run time Indicates the estimated run time in standard units of processing
(SUP). This is roughly equivalent to minutes, or use a leading 'S'
to set seconds.

Deadline Indicates the elapsed time since run submission or the time of day
(Dhhmm) when a run must complete, based on a 24-hour clock.

Cards Indicates the estimated number of cards expected as output from


the run.

Start time Indicates the earliest time when a run can be processed. The
format of this value is the same as for DEADLINE.

Host (/Group) Defines the name of a Control-M/Agent computer, remote host


computer, or host group where the job is submitted.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for z/OS)
that processes the job.

145
Control-M User Guide

Parameter Description

Application Provides a logical name for sorting groups of jobs. This parameter
is used to supply a common descriptive name to a set of related
job groups. The jobs do not necessarily have to run at the same
time.

Sub Application Indicates the name of the Sub Application where the job belongs
logically. It is a sub-category of the Application parameter. For
example, the Application is Finances, and the Sub Application is
Payroll.

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

Type Defines whether the documentation for an OS job is in a file or


URL.

Doc Path For a z/OS job, Doc Library defines the name of the library where
the Documentation (description) is saved. For a non-z/OS job, Doc
Path defines the name of the file path where the Documentation is
saved.

File Path For non-z/OS jobs, File Path indicates the location of the file that
contains the script. For z/OS jobs, Member Library indicates the
location of the Member that contains the JCL, started task
procedure, or Warning message.

146
Control-M User Guide

OS/400 Full parameters


The following table describes the OS/400 Full parameters.

147
Control-M User Guide

Parameter Description

Program (on page 149) Enables the job to execute the program specified Program that
resides in Library or Path on the Special environment.

Script File (on page 166) Enables the job to execute the Script file specified in Script file
that resides in Library or Path in the Special Environment.
CTMCL (the Control-M Script interpreter) processes the commands
in the script).

Multiple Commands (on page Enables you to execute multiple commands in a single job using
170) the Control-M Command line interpreter. It enables you to create
jobs with multiple commands, eliminating the need to use pre and
post commands. It also enables an easier conversion from the
ROBOT scheduler.

Commands (on page 170) Specifies the command lines to be executed. You can move
commands up or down in the list, or delete, copy or modify the
command. The associated Ignore error is moved up or down, or
deleted or modified with the command.

Subsystem (on page 170) Enables a job to start a subsystem specified in Subsystem that
resides in Library and monitors the active subsystem until the
subsystem ends. Subsystem ending code is always OK, regardless
of the method used to end it.

Job Description (on page 174) Enables a job to start a job description specified in Job
Description that resides in Library and monitors the job until
the job ends. This action is similar to Autostart Job Entry (AJE) in
a subsystem description.

Virtual Terminal (on page 175) Enables the execution of 5250 Interactive session operator actions
from interactive menus and screen dialogs as a Control-M batch
job. The interactive job then becomes part of your batch stream
and can be executed by using all the Control-M scheduling criteria.
You can access OS/400 VT from the job palette in the Planning
domain or from the What to Run in OS/400 Full in the Job
Properties Pane in Control-M.

External Job (on page 171) Enables you to monitor OS/400 jobs created in external
applications. When attached to Control-M, external jobs can be
released and/or moved to another JOBQ, changed to set specific
attributes (for example, RUNPTY) or changed to a new accounting
code.
You can access OS/400 External job from the job palette in the
Planning domain or from the What to run field in OS/400 Full
in the Job Properties Pane in Control-M.

148
Control-M User Guide

Parameter Description

External Subsystem (on page Defines the name of the external job name or subsystem name.
171)

OS/400 Program
OS/400 Program enables the job to execute the program specified Program that resides in Library or
Path on the Special environment.
You can access the OS/400 Program either from the job palette in the Planning domain or select
Program from the What to run field in OS/400 Full Properties Pane in Control-M. For more details
about OS/400 parameters, see OS/400 Full parameters (on page 147).

149
Control-M User Guide

The following table describes the OS/400 program parameters.

150
Control-M User Guide

Parameter Description

Special Environment Defines the following environment where the job runs:
 Native: Enables the job to run on the native OS/400
environment.
 QShell: Enables the job to run on the QShell environment.
 S/38: Enables the job to run on the System/38 environment.

Library Defines the library name where the program resides. Up to 10


characters.
S/38 Environment: Up to 8 characters.

Path (Qshell only) Defines the path where the QShell program resides.
The path name must start with ~, /, \ or period (.).

Program Defines the program name to be executed in the specified special


environment.

Overriding path (Qshell only) Defines the name of an alternate path or directory
for the program specified in the Program parameter.

Overriding library Defines the name of an alternate library or directory for the
program specified in the program parameter.

151
Control-M User Guide

Parameter Description

Program's parameters Defines a Program, Script file or VT script file, which may expect
to receive parameters as input for the execution.
Each parameter must match its type as expected by the Program,
Script file or VT script. To modify the parameters, see Parameter
display options.
The following types are available:
 String: Defines any string up to 4000 characters.
 Decimal: Defines a decimal number with or without decimal
point. The value is passed to the program as packed decimal
with a length of (15 5), where the value is 15 digits long, of
which 5 digits are decimal positions.
 Hex: Defines any even number of hexadecimal characters (0-
9, a-f, A-F). The value is passed to the program as
X'<value>'.
NOTE:
 The String is the only valid type to be passed to Script file or
VT script file and also to a QShell program
 A maximum of 99 parameters can be set per job.
 If you need to include single quote character ('), it must be 2
single quotes ('').

Resolve special values Indicates whether special values, such as *PGM, *DTAARA, and
*FILE, defined in the program's parameters value will be resolved
by the script interpreter or prior to submitting a program.
The default value is Yes (checked).
For more details about OS/400 special values see Resolving
parameters with special values in the Control-M/Agent for iSeries
(AS/400) Administrator guide.

Submission attributes Enables you to define submission attribute parameters for an


OS/400 job. For more information, see Submission Attributes (on
page 153).

Advanced Enables you to define advanced parameters for an OS/400 job.


For more information, see Advanced parameters for OS/400 job
(on page 156).

152
Control-M User Guide

Submission Attributes
The following tables describes the submission attribute parameters for an O/S 400 job.

153
Control-M User Guide

Parameter Description

Job Description Defines the name of the OS/400 Job description (*JOBD) used to
submit the job. You can select a job description name from the
generated list.

Library Defines the name of the library where the job description resides.
You can select a library name from the generated list.

Job Queue Defines the name of the Job queue to submit the job to. You can
select a job queue name from the generated list.

Library Defines the name of the library where the job queue resides. You
can select a library name from the generated list.

Job queue priority Specifies the job queue scheduling priority.


NOTE: 1 is the highest and 9 is the lowest.
When System default is set, the job will be submitted with the
system default JOBPTY value.

Hold on job queue Specifies whether this job is held at the time that it is put on the
job queue. When System default is set, the job will be submitted
with the system default HOLD value.

Run priority Specifies the run priority for the job.


NOTE: 1 is the highest priority and 99 is the lowest.
The Agent only attempts to set job Run Priority after the job is
submitted. If a job is not available or ends before the priority is
set, the job is not updated and no error message is sent. If the
OS/400 configuration parameter CHGRUNPTY is set to N, the
RUNPTY of the job is not set.

Submit with ASAP option Enables you to submit the job to a NOMAX job queue. If selected,
Job Queue, Library, Job queue priority and Hold on job
queue are disabled.

Ignore all errors (Script File, Multiple commands, and VT only) Enables you to
ignore errors encountered in any of the commands specified by
the job. The error message is logged in the job log and the
processing is resumed from the next command.

154
Control-M User Guide

Parameter Description

Log informational messages (Script File, Multiple commands, and VT only) Enables additional
informational messages logged in the job log when the job is
executing.

Delete file (Script File, and VT only) Deletes the script file or VT script file
when the job execution ends.
NOTE: This attribute is not valid when “Script file location” is set
to “Embedded script”.

155
Control-M User Guide

Advanced parameters for OS/400 job


The following table describes the advanced parameters for an O/S 400 job.

Parameter Description

Library list Enables you to view and modify OS/400 job libraries. For more
information, see Library list (on page 156).

Environment Enables you to view and modify the environment on which OS/400
jobs run. For more information, see Environment (on page 158).

Pre/Post commands Enables you to apply pre or post commands to your OS/400 jobs.
For more information, see Pre/Post Commands (on page 160).

International Enables you to view and modify international parameters. For


more information, see International parameters (on page 164).

Messaging Enables you to view and modify messaging parameters. For more
information, see Messaging parameters (on page 165).

Output Enables you to view and modify output parameters for your OS/
400 job. For more information, see Output parameters (on page
166).

Bypass job Enables the job not to run. The following message is generated in
the job's output:
Job was bypassed

Skip validity check for this job Enables you to skip validity checks for all fields.

Library list
You can view and modify OS/400 job libraries that are provided for Control-M OS/400 jobs.

156
Control-M User Guide

The following table describes the library list parameters.

Parameters Description

Name space Defines the Name Space or ASP group. Type or select the name
space or a special value from the drop down list.

System library list Enables you to select the system portion of the library list to use.
System default or a special value from the drop down list.

Current library Enables you to select the current library for the job. Type or select
the library name or one of the special values from the drop down
list.

Library List You can select a special value, or type the required name space in
the text field. If a special value is specified, it must be the only
entry in the list.
Special values:
 *CURRENT
 *JOBD
 *SYSVAL
 *NONE

157
Control-M User Guide

Environment
You can view and modify the environment on which OS/400 jobs run.

158
Control-M User Guide

Parameter Description

Accounting code Defines the accounting code used by the submitted job when
logging the system resources usage. 15-character string (use any
characters) or one of the Special Values from the drop down list.
NOTE: If a value contains spaces or non-alphanumeric characters,
enclose the value with single quotation marks (‘).

Routing data Defines the routing data used to start the next routing step in the
job. 80-character string (any characters) or one of the special
values from the drop down list.
NOTE: If a value contains spaces or non-alphanumeric characters,
enclose the value with single quotation marks (‘).

Request data Defines the request data that is placed as the last entry in the
job's message queue. 3000-character string (any characters) or
one of the special values from the drop down list.

Submitted for Defines the parent job name for the job.
A qualified job name in <number>/<user>/<name> format, or
the special value from the drop down list.

Scheduling date Defines the date when the job is submitted to the job queue and
is eligible to run. Specify a date in the job's date format, with or
without the date separator, or one of the special values from the
drop down list.

Scheduling time Defines the time on the scheduled date when the job becomes
eligible to run. Time in hhmmss format, or special value from the
drop down list.

Job date Defines the date that is assigned to the job when it starts. (Job
date format). Type the date or a special value from the drop down
list.

Job switches Defines the first settings for a group of 8 job switches used with
the job. Any combination of 0s and 1s to form an 8-digit string, or
the special value from the drop down list.

Allow display by WRKSBMJOB Specifies whether the job being submitted is allowed to be shown
on the Work with Submitted Jobs panel.
Default: selected - Yes.

159
Control-M User Guide

Parameter Description

Allow multiple threads Defines whether or not the job is allowed to run with multiple user
threads. One of the special values from the drop down list:
 System default
 Job Description
 Yes
 No

Copy environment variables Specifies whether the environment variables from the submitting
job are copied to the new job.
NOTE: When this property is not set (unchecked or set to No),
LDA is not set for the job and environment variables are not
passed Default: selected = yes.

LDA Defines the local data area. You can add, delete, modify, copy or
move up or down by selecting the icon in the LDA field. The LDA
field contains the following:
 Start: Defines the starting location of the LDA (1 to 1024
inclusive with a default of 1).
 Length: Defines the length of the string in the LDA (default =
actual length).
 [Decimal]: Defines the precision (number of digits after the
decimal point).
 Value: Defines the value of the LDA. When [Decimal] is
specified, the value must be a numeric value with or without
decimal point (examples: 167, 1997.15).
NOTE: For all formats, <start> + <length> -1 must not
exceed 1024.

Pre/Post Commands
The following table describes the pre submit commands and pre/post commands parameters. You can
add, delete, move up or down, copy or edit pre submit and pre and post commands.

160
Control-M User Guide

NOTE: Pre-submit, Pre commands, post commands and pre statistics are only available for Program,
Script File and Command.

161
Control-M User Guide

Pre submit commands Description

Pre submit commands Enables you to define a command before you submit the job. A
job can have any number of pre submit commands but the total
number of variables for a job is limited. All Pre-submit commands
are executed before the job is submitted to the OS/400.
NOTE: Pre-submit commands are processed in the order they are
displayed in the OS/400. Pre/Post Commands dialog box. Pre-
submit commands are executed "as is." There is no need for
special ‘single quote’ handling.
If a Pre-submit command fails, the failure is ignored, logged in the
Agent log file, and the next Pre-submit command is processed.
When there are no more Pre-submit commands to process, the
job is submitted. You can add, delete, edit copy, or move up or
down any pre-submit command.

162
Control-M User Guide

Pre submit commands Description

Pre Commands Determines the command line instruction to be executed before or


after the specified command line. The following rules apply to Pre
Post Commands
and Post commands:
 A maximum of 19 Pre and Post commands can be defined for
a single job. If a Pre or Post command is defined for a job, the
job is processed as a Script file object type, regardless of its
defined object type.
 If the defined Object type is CMDLINE, the Command line (in
the OS400 tab) cannot exceed 256 characters.
 The job processes all the Pre commands in the order they are
displayed in the OS/400 Pre/Post Commands dialog box, then
the command line or the program (depending on "What to
run"), and then all the Post commands in the order they are
displayed in the OS/400 Pre/Post Commands dialog box.
 If a Pre command, or the command line or program, or a Post
command fails, the job will fail, unless the next command to
be processed is MONMSG.
 As the job is treated as a “Script file”, a Pre or Post command
can be any valid “Script file” extended feature.
EXAMPLE: PGM PARM(&name), RETURN, GOTO, MONMSG,
continuation line, or remarks.
 Default values for "Ignore Errors" (IGNERR keyword) and "Log
informational messages" (LOGINFMSG keyword) of the "Script
file" interpreter are used.
 Single quote marks (') must be doubled ('') in Pre or Post
commands.
EXAMPLE: SNDMSG MSG('I am using Control-M')
TOUSR(*SYSOPR) should be entered as
SNDMSG MSG(''I am using Control-M'') TOUSR(*SYSOPR).

163
Control-M User Guide

Pre submit commands Description

Pre statistics The following rules apply to pre statistics programs:


 A job can only have one pre statistics program
 The parameter pre statistics program must refer to a qualified
OS/400 program name in one of the following formats:
-<Program>
-<Library>/<Program>
The Pre-statistics field contains the following:
 Pre statistics program: Specifies the name of a program to
the process the jobs statistic information.
 Library: Defines the name of the library. 10 characters valid
OS/400 object name.

International parameters
The following table describes the international fields for OS/400 jobs.

Parameter Description

Sort Sequence Defines the sort sequence that is used for the job. Up 10
characters. Type or select a valid OS/400 object name, or one of
the special values from the drop down list.

Library Defines the library name. Up 10 characters. Type or select a valid


OS/400 object name, or one of the special values from the drop
down list.

Language id Defines the language identifier to be associated with the job. 3


characters ID. Type or select a valid OS/400 language ID or one
of the special values from the drop down list.

Country id Defines the country or region identifier (ID) used by the job. 2
characters country or region ID or one of the special values from
the drop down list.

Coded character set id Defines the coded character set identifier (CCSID) used for the
submitted job. Up to 5 digits coded character set ID in the range
of 1-65535 or one of the following special values from the drop
down list.

164
Control-M User Guide

Messaging parameters
The following table describes the messaging parameters for OS/400 jobs.

Parameters Description

Level Defines the messaging logging level used for the job's messages.
0-4 characters or a special value from the drop down list,

Severity Defines the message severity used to determine which error


messages are logged in the job log. 00-99 characters or a special
value from the drop down list.

Text Defines the messaging logging text. System default or one of the
special values from the drop down list.

Log CL program commands Defines whether the commands, which run in a CL program, are
logged into the job log through the CL program's message queue.
System Default or one of the special values from the drop down
list.

Inquiry message reply Defines how predefined messages are answered, which are sent
when running the job. System Default or one of the special values
from the drop down list.

Job message queue maximum Defines the maximum size of the job message queue (02-64) or
size one of the special values from the drop down list.

Job message queue full action Specifies the action that needs to be taken when the job message
queue is full. System Default or one of the special values from the
drop down list.

MSGW Auto Reply Profile Defines the name of the MSGW auto reply profile file that is
processed when the job's status is set to MSGW.

Message queue Defines where the completion message is sent when the
submitted job has completed running. Up to 10 characters. Valid
OS/400 object name or one of the special values from the drop
down list.
NOTE: BMC recommends that you do not change this value.
Otherwise, when the job ends, it is not detected until the next
Tracker loop. If the OS400 configuration parameter OVRMSGQ is
not set to Y, this value is ignored.

Library Defines the name of the library. Up to 10 characters.


Valid OS/400 object name or one of the special values from the
drop down list

165
Control-M User Guide

Output parameters
The following table describes the output parameters for OS/400 jobs.

Parameter Description

Output queue Defines the default queue for the job's spooled files. Up to 10
characters. OS/400 name or one of the special values from the
drop down list.

Library Defines the library name. Up to 10 characters. OS/400 name or


one of the special values from the drop down list.

Print Device Defines the default printer name for the job. Up to 10 characters.
OS/400 name or one of the special values from the drop down list.

Output priority Defines the output priority for spooled output files that are
produced by the job. System default or one of the special values
from the drop down list.
NOTE: Highest priority: 1, lowest priority 9.

Spooled file action Decides whether the spooled files are accessed through the job
interfaces after the job ends. System default or one of the special
values from the drop down list.

Print text Defines the printed text at the end of each page or on separate
pages. String or special value. Maximum length: 30 characters.
NOTE: If the string contains spaces or non-alphanumeric
characters, enclose it with single quote marks (‘).

Spooled files handling profile Defines the spooled file handling profile name supplied when the
job ends. Must be the name of an existing spooled files handling
profile that is located in the Agent Data directory.

Script File
The Script File enables the job to execute the Script file specified in Script file that resides in Library or
Path in the Special Environment. CTMCL (the Control-M Script interpreter) processes the commands in
the script.

166
Control-M User Guide

The following table describes the Script File parameters for an OS/400 job.

167
Control-M User Guide

Parameter Description

Special Environment Defines the following environment where the job runs:
 Native: Enables the job to run on the native OS/400
environment.
 QShell: Enables the job to run on the QShell environment.
 S/38: Enables the job to run on the System/38 environment.

Script file location Indicates where the following script file is located:
 Native (QSYS file system): The script file belongs to a
physical file that resides in a QSYS library.
 IFS (Integrated file system): The file resides in the
integrated file system. The file path must start with one of the
following characters: /, \, ~ or .
 Embedded script: The script content is embedded in the
Control-M job definition, which is in the "Script" text box. The
"Script file name" becomes informational only and does not
have to exist on the target system.

Library (Script file location Native only) Defines the library name. Up to 10
characters, valid OS/400 Object name, or one of the special values
from the drop down list.

Script (Embedded script only) Enables you to type the embedded script.

Script File Specifies the name of the script file which is executed.

Path (Script file location IFS only) Defines the path in which the script
file resides in. The path name must start with ~, /, \ or period (.).

Overriding path (Script file location IFS only) Defines the name of an alternate
path or directory for the file specified with the Script file
parameter.

Overriding library (Native only) Defines the name of an alternate library or directory
for the file specified with the Script file parameter.

168
Control-M User Guide

Parameter Description

Script File's Parameters Defines a Program, Script file or VT script file, which may expect
to receive parameters as input for the execution.
Each parameter must match its type as expected by the Program,
Script file or VT script. To modify the parameters, see Parameter
display options.
The following types are available:
 String: Defines any string up to 4000 characters.
 Decimal - Defines a decimal number with or without decimal
point. The value is passed to the program as packed decimal
with a length of (15 5), where the value is 15 digits long, of
which 5 digits are decimal positions.
 Hex - Specifies any even number of hexadecimal characters
(0-9, a-f, A-F). The value is passed to the program as
X'<value>'.
NOTE:
 The String is the only valid type to be passed to Script file or
VT script file and also to a QShell program
 A maximum of 99 parameters can be set per job.
 If you need to include single quote character ('), it must be 2
single quotes ('').

Resolve special values Indicates whether special values, such as *PGM, *DTAARA, and
*FILE, defined in the program's parameters value will be resolved
by the script interpreter or prior to submitting a program.
The default value is Yes (checked).
For more details about OS/400 special values see Resolving
parameters with special values in the Control-M/Agent for iSeries
(AS/400) Administrator guide.

Submission attributes Enables you to define submission attribute parameters for an


OS/400 job. For more information, see Submission Attributes (on
page 153).

Advanced Enables you to define advanced parameters for an OS/400 job.


For more information, see Advanced parameters for OS/400 job
(on page 156).

169
Control-M User Guide

OS/400 Multiple Commands


OS/400 multiple commands enables you to execute multiple commands in a single job using the Control-
M Command line interpreter. It enables you to create jobs with multiple commands, eliminating the need
to use pre and post commands. It also enables an easier conversion from the ROBOT scheduler.
You can access the OS/400 Multiple Commands from the job palette in the Planning domain or from
What to run field in OS/400 Full in the Job Properties Pane in Control-M. For more details about O/S
400 parameters, see OS/400 Full parameters (on page 147)
The following table describes the OS/400 Commands and Multiple Commands parameters.

Parameter Description

Commands (Multiple Commands only) Specifies the command lines to be


executed. You can move commands up or down in the list, or
delete, copy or modify the command. The associated Ignore error
is moved up or down, or deleted or modified with the command.

Ignore errors Enables you to ignore errors when running jobs. If set to Yes,
errors encountered in this command at run time are ignored. The
error message is logged in the job log of the job and the
processing is resumed from the next command.
If set to No (default), the job ends in NOTOK if errors are
encountered in this command at run time.

Submission Attributes Enables you to define submission attribute parameters for an


OS/400 job. For more information, see Submission Attributes (on
page 153).

Advanced Enables you to define advanced parameters for an OS/400 job.


For more information, see Advanced parameters for OS/400 job
(on page 156).

Ignore all errors (Script File, Multiple commands, and VT only) Enables you to
ignore errors encountered in any of the commands specified by
the job. The error message is logged in the job log and the
processing is resumed from the next command.

Log informational messages (Script File, Multiple commands, and VT only) Enables additional
informational messages logged in the job log when the job is
executing.

Subsystem
Subsystem enables a job to start a subsystem specified in Subsystem that resides in Library and
monitors the active subsystem until the subsystem ends. Subsystem ending code is always OK, regardless
of the method used to end it.

170
Control-M User Guide

The following table describes the Subsystem parameters for an OS/400 job.

Parameter Description

Library Defines the library name. Up to 10 characters, valid OS/400


Object name, or one of the special values from the drop down list.

Subsystem Specifies the name of a subsystem description that defines the


operational environment (subsystem) being started.

Overriding library Defines the name of an alternate library or directory for the
specified subsystem.

Bypass job Enables the job not to run. The following message is generated in
the job's output:
Job was bypassed

Skip validity check for this job Enables you to skip validity checks for all fields.

OS/400 External
The OS/400 External job enables you to monitor OS/400 jobs created in external applications. When
attached to Control-M, external jobs can be released and/or moved to another JOBQ, changed to set
specific attributes (for example, RUNPTY) or changed to a new accounting code.
You can access OS/400 External job from the job palette in the Planning domain or from the What to
run field in OS/400 Full in the Job Properties Pane in Control-M. For more details about O/S 400
parameters, see OS/400 Full parameters (on page 147).

171
Control-M User Guide

The following table describes the OS/400 External job and external subsystem parameters. Apart from the
What to run and External Subsystem/External job field, the following fields only apply to External job.

172
Control-M User Guide

Parameter Description

What to run Run one of the following jobs:


 External job
 External subsystem

External job or External Defines the name of the external job name or subsystem name.
Subsystem
NOTE:
 When choosing External subsystem, the Run as field is set to
QSYS and becomes disables for input
 All parameters listed below applies to External job only

Job status Enables you to select the job status, which is attached as an
external job.
Values:
 Any job's status
 Active
 Job queue
 Output queue

Duplicate job option Enables you to select an option if more than one external job
matches the external job attributes (job name, owner, and job
status):
 Error: Default. Do not attach the external job. The Control-M
job ends NOTOK with an appropriate error message.
 First job: Take the first job (time based) that matches the
external job attributes
 Last job: Take the last job (time based) that matches the
external job attributes

Release job Enables you to release the job form JOBQ when the job is
attached to Control-M.
If the job could not be released, a message is logged in the
Control-M/Agent log. However the job is attached to Control-M.

Move to Job Queue Defines the name of a job queue to move the job when the job is
attached to Control-M.
Click Load and select a job queue name from the generated list.
If the job could not be moved, a message is logged in the Control-
M/Agent log. However, the job is attached to Control-M.

173
Control-M User Guide

Parameter Description

Library Defines the name of the library where the job queue resides.
Click Load and select a library name from the generated list.

Change job command Specifies any OS/400 CHGJOB command keyword and value that
to set the job when the job is attached to Control-M.
The following format is used:
Keyword1(value1) ... Keywordn(Valuen)
EXAMPLE:
RUNPTY(77) LOG(4 00 *SECLVL)
LOGCLPGM(*NO)
If the job could not be changed, a message is logged in the
Control-M/Agent log. However, the job is attached to Control-M.

Set Accounting code Specifies the accounting code to set the job, when the job is
attached to Control-M.
A maximum of 15 characters accounting code can be specified.
If the accounting code could not be set for the job, a message is
logged in the Control-M/Agent log. However, the job is attached to
Control-M.

MSGW Auto Reply Profile Must be the name of an existing MSGW auto reply profile file that
(MSGWPRF) is located in the Agent Data directory

Spooled files handling profile Must be the name of an existing Spooled files handling profile file
(RPTDSTPRF) that is located in the Agent Data directory.

Bypass job Enables the job not to run and the following message is
generated:
Job was bypassed

Skip validity checks for this job Enables you to skip validity checks for all fields.

Job Description
Job Description enables a job to start a job description specified in Job Description that resides in
Library and monitors the job until the job ends. This action is similar to Autostart Job Entry (AJE) in a
subsystem description.

174
Control-M User Guide

The following table describes the Job Description parameters for an OS/400 job.

Parameter Description

Library Defines the library name. Up to 10 characters, valid OS/400


Object name, or one of the special values from the drop down list.

Job Description Defines the name of the OS/400 Job description used to submit
the job. You can select a job description name from the generated
list.

Overriding library Defines the name of an alternate library or directory for the file
specified with the file name parameter.

Bypass job Enables the job not to run. The following message is generated:
Job was bypassed

Skip validity checks for this job Enables you to skip validity checks for all fields.

OS/400 VT
Control-M Virtual Terminal (also known as Screen Scraper) enables the execution of 5250 Interactive
session operator actions from interactive menus and screen dialogs as a Control-M batch job. The
interactive job then becomes part of your batch stream and can be executed by using all the Control-M
scheduling criteria. You can access OS/400 VT from the job palette in the Planning domain or from the
What to Run in OS/400 Full in the Job Properties Pane in Control-M. For more details about OS/400
parameters, see OS/400 Full parameters (on page 147).

175
Control-M User Guide

The following table describes the OS/400 Virtual Terminal (VT) parameters.

176
Control-M User Guide

Parameter Description

Script file location Indicates where the following script file is located:
 Native (QSYS file system): The script file belongs to a
physical file that resides in a QSYS library.
 IFS (Integrated file system): The file resides in the
integrated file system. The file path must start with one of the
following characters: /, \, ~ or .
 Embedded script: The script content is embedded in the
Control-M job definition, which is in the "Script" text box. The
"Script file name" becomes informational only and does not
have to exist on the target system.

Library (Native only) Defines the library name. Up to 10 characters, valid


OS/400 Object name, or one of the special values from the drop
down list.

Script (Embedded script only) Enables you to type the embedded type
script.

VT Script file Specifies the name of a script file containing the virtual terminal
instructions to be executed.

Member (Native) Specifies the member name that contains the script file
inside the script file, when the script location is "Native". Up to 10
characters, valid OS/400 Object name, or one of the special
values: *FIRST

177
Control-M User Guide

Parameter Description

Virtual Terminal's parameters Defines a Program, Script file or VT script file, which may expect
to receive parameters as input for the execution.
Each parameter must match its type as expected by the Program,
Script file or VT script. To modify the parameters, see Parameter
display options.
The following types are available:
 String: Defines any string up to 4000 characters.
 Decimal - Defines a decimal number with or without decimal
point. The value is passed to the program as packed decimal
with a length of (15 5), where the value is 15 digits long, of
which 5 digits are decimal positions.
 Hex - Specifies any even number of hexadecimal characters
(0-9, a-f, A-F). The value is passed to the program as
X'<value>'.
NOTE:
 The String is the only valid type to be passed to Script file or
VT script file and also to a QShell program
 A maximum of 99 parameters can be set per job.
 If you need to include single quote character ('), it must be 2
single quotes ('').

Resolve Special values Indicates whether special values, such as *PGM, *DTAARA, and
*FILE, defined in the program's parameters value will be resolved
by the script interpreter or prior to submitting a program.
The default value is Yes (checked).
For more details about OS/400 special values see Resolving
parameters with special values in the Control-M/Agent for iSeries
(AS/400) Administrator guide.

Submission Attributes Enables you to define submission attribute parameters for an


OS/400 job. For more information, see Submission Attributes (on
page 153).

Print Screen images Choose which screen images are printed into the job's output.
System default, No Yes, Input only, output only, Job PRTKEYFMT.

Spooled files handling Specifies the name of the spooled file handling profile to be
processed when the job ends.

178
Control-M User Guide

Parameter Description

Terminal attributes Defines the Virtual terminal parameters.

Work station type Defines the type of workstation to use. Select the Work Station
type from a list of work station types. Default: *BASE

Keyboard language Defines the keyboard language type for the virtual terminal.
Specify 3 characters valid keyboard language type or *SYSVAL to
use the default system value.
For more information about supported languages, see IBM iSeries
globalization documentation.

Character set Defines the graphic character set for the virtual terminal. Specify a
valid character set number.
For more information about supported graphic character set, see
the IBM iSeries globalization documentation
Values:
 Any number between 1 and 32767
 *SYSVAL: Use the graphic character set obtained from the
QCHRID system value.
 *KBDTYPE: Enables you to use the keyboard language type.

Code page Defines the code page for the virtual terminal. Specifies a valid
code page number.
For more information about code page, see the IBM iSeries
globalization documentation
Values:
 Any number between 1 and 32767
 Default: *DFT - Use the Code page obtained from the QCHRID
system value

Initiation information Defines the initiation information for the VT terminal.

User profile Defines the user profile that is used to log in to the terminal. Up to
10 characters, valid OS/400 Object name, or one of the special
values from the drop down list.

Password Specify the log in password, use the owner's authentication


repository or set to use the password program.

179
Control-M User Guide

Parameter Description

Device name Name of display device. Up to 10 characters, valid OS/400 Object


name, or one of the special values from the drop down list.

Current library The current library of the sign on process. Up to 10 characters,


valid OS/400 Object name, or one of the special values from the
drop down list.

Program Defines the sign in program name. Up to 10 characters, valid


OS/400 Object name, or one of the special values from the drop
down list.

Menu Defines the sign on menu. Up to 10 characters, valid OS/400


Object name, or one of the special values from the drop down list.

Bypass job Enables the job not to run. The following message is generated:
Job was bypassed

Skip validity check for this job Enables you to skip validity checks for all fields.

180
Control-M User Guide

Tandem job parameters


The following table describes the general parameters for a Tandem job:

181
Control-M User Guide

Parameter Description

Job Type Defines the type of job that determines which fields are exposed in a job definition.
The value of the job type is usually based on the platform for the job run. Jobs
defined as Dummy provide instructions for Control-M such as post-processing actions.
Value: Tandem

Job Name Defines the name of the job processing definition and appears in the job definition
and tracking displays, and enables you to identify the job, and order the job.

Description (From Forecast only) Provides a description of the job in free text. A well written
description can help you determine why the job was defined and how it fits into your
business workflow.

Run as dummy Enables you to run jobs of job types other than Dummy, as dummy jobs.

Run as Identifies the user name with the authorization to execute the job. This parameter is
used by the Control-M security mechanism.

Name Defines the name of the process. It must begin with $ followed by an alphabetic
character. Each remaining character must be alphanumeric. Maximum 6 characters
(including the $ sign).

What Defines one or more parameters which determines what the job runs.

What to run Determines whether the job runs as one of the following:
 TACL Script: Defines the job that runs the TACL script
 Program: Defines the job that executes the program
 Command: Defines that the job runs a command and includes the Command
line.

TACL Script Defines the name of the TACL file.

Volume Subvolume Defines the Volume and sub volume where the TACL script or Program resides.

Overrriding volume Defines the Volume and sub volume where the overriding TACL script or Program
resides

Home terminal Specifies a valid device name.

CPU Specifies the CPU number (0-15) in which the process runs on.

Priority Specifies the priority in which the process runs under.

Assign (on page Enables you to assign job environmental attributes, such as name and other
185) attributes (for example access mode and exclusion mode).

182
Control-M User Guide

Parameter Description

Define (on page Enables you to set environmental variables for your applications.
186)

Params (on page Enables you to set the name and value of your program to use these parameters
186) when creating a job

Input File Specifies the full name of the input file.

Output file Specifies the full filename of the output file (which is overwritten if it exists already).

Skip Validity Checks Determines whether validity checks are performed against any of the Tandem related
for this job job attributes.

Bypass job (skip Determines whether the job submits to the Tandem operating system. Instead, the
execution) job completes OK and for the job a dummy OUTPUT is created.

This process should Determines whether the job creates in a nowait manner. This means the parent
be created in a no process does not wait for acknowledgment that the process was created.
wait manner

Produce CTMRJOB Determines whether the CTMRJOB diagnostics are turned on for this specific job,
dianostics overriding the value specified by the GUARDIAN configuration parameter
CTMRJOB_DIAG.

Creation option Defines information about the environment of the new process. Valid values 0-127.
See PROCESS_CREATE_API in the HP NonStop Guardian Procedure Calls. Field Name:
CREATE_OPTION.

Set mode option Defines the SETMODE command to be issued for the created process. See SETMODE
API in the HP NonStop Guardian Procedure Calls. Field Name: SETMODE
<function><Param1><Param2>

Job id Defines an integer (job ID) that specifies the job to be created. See Run Command in
the HP NonStop TACL Commands and Functions. Set to GEN to instruct Control-M to
generate a unique Job ID.

Swap file for data Enables you to use the parameter for informational purposes only. See Run Command
in the HP NonStop TACL Commands and Functions. Field Name: SWAP

Swap for extended Enables you to allocate swap space for the default extended segment of the process.
data See Run Command in the HP NonStop TACL Commands and Functions. Field Name:
EXT_SWAP

Memory pages Specifies the initial number of memory pages in which the process is created.

Debug attribute Enables you to set the debugging attributes for the new process. Valid values: 0-15.
See PROCESS_CREATE_API in the HP NonStop Guardian Procedure Calls.

183
Control-M User Guide

Parameter Description

Host (/Group) Defines the name of a Control-M/Agent computer, remote host computer, or host
group where the job is submitted.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for z/OS) that processes the
job.

Parent Folder Defines the name of the folder that contains the job or Sub Folder.
Names of folders and Sub Folders may be up to 64 characters, with the exception of
Control-M for z/OS folders which may be up to 8 characters. Folder names cannot
contain the character “/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders).

Application Provides a logical name for sorting groups of jobs. This parameter is used to supply a
common descriptive name to a set of related job groups. The jobs do not necessarily
have to run at the same time.

Sub Application Indicates the name of the Sub Application where the job belongs logically. It is a sub-
category of the Application parameter. For example, the Application is Finances, and
the Sub Application is Payroll.

Override Path Specifies a temporarily-modified job script file without changing the original script file
in the File Path/Member library and without changing the scheduling order of a folder.

Run job on all hosts Specifies that job submission details be broadcast to all agents within a defined Host
in group Group. All available agents in the Host Group run an identical job, and each such job
has a unique Order ID.

Variables All variables are identified by the %% prefix. If %% is included in the value for a
job processing parameter, Control-M assumes that it is referring to a variable or
function.

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

Type Defines whether the documentation for an OS job is in a file or URL.

Doc Path For a z/OS job, Doc Library defines the name of the library where the Documentation
(description) is saved. For a non-z/OS job, Doc Path defines the name of the file path
where the Documentation is saved.

Doc File For a z/OS job, defines the name of the member where the job Documentation
(description) is saved. For a non-z/OS job, the Doc File is the name of the file where
the job Documentation is saved.

Priority Determines the order of job processing by Control-M in the Active Jobs database.

Critical Determines whether the job is a critical-path job in Control-M, which ensures
resources allocation order.

184
Control-M User Guide

Tandem job assign parameters


The following table describes the Tandem job Assign parameters.

Parameter Description

Assigns Logical (Mandatory) Defines the logical name as it is known to


Name the application’s program.

Physical Name Defines the name of the file to be accessed by the user
program during runtime.

Program Name Defines which programs use the Assign.

Exclusion Mode Determines the circumstances under which other


processes can access the file. Special Values:
 EXCLUSIVE
 SHARED
 PROTECTION

File Access Mode Specifies the file operations that can be performed.
Special Values:
 I-O
 INPUT
 OUTPUT

Record Size Defines the length of the record in the program (range 1
to 65535).

Block Length Defines the size of the data block to be used by the
program (range 1 to 65535).

File Code Assigns a code to the file (range 0 to 65535).

Extent Size Defines the primary extent size and secondary extent
size.

185
Control-M User Guide

Define format Job parameters


The following table describes the define format for Tandem job parameters.

Parameter Description

Name (Mandatory) Defines the logical name as it is known to


the application’s program.

Class Defines the class of the parameter. Special Values:


 CATALOG
 DEFAULTS
 MAP
 SEARCH
 SORT
 SUBSORT
 SPOOL
 TAPE
 TAPECATALOG

Value Defines the value of the parameter. The remainder of the


attributes must be input as comma-separated values.

Tandem job params parameters


The following table describes the Tandem job Params parameters.

Parameter Description

Name (Mandatory) Defines the name of the parameter.

Class Defines the value of the parameter.

Folder parameters
Jobs are sorted into the following types of folders:

186
Control-M User Guide

 Regular folder parameters (on page 188): Enables you to define a container for jobs. Jobs in a regular
folder are normally processed independently of each other - each job is handled only according to the
parameters in its own job processing definition.
 SMART Folder parameters (on page 191): Enables you to define extended processing parameters.
The jobs and sub-folders that are contained in the SMART folder inherit the scheduling definitions
according to the specific AND/OR relationships that are defined in the job and in the SMART folder.
When you order a SMART Folder and runs, you can monitor the status of the SMART folder in the
Monitoring domain, and perform actions which affect its jobs and sub-folders. Just as you can define
post-processing tasks that Control-M/Server must perform when a job successfully finishes, you can
define post-processing tasks that Control-M/Server must perform when all the jobs in a SMART folder
successfully finish.
 Sub Folder parameters (on page 195): Enables you to apply the extended processing parameters to
folders that are contained in a SMART folder. When you add a folder to a SMART folder, the Sub
Folder can inherit the extended processing parameters of the SMART folder. When you order a
SMART folder with Sub Folders, you can monitor the status of the SMART solder, the sub-folders, and
the jobs in the Monitoring domain, and perform actions which affect the sub-folder and its jobs.
SMART folders can only contain jobs, not sub-folders, in Control-M for z/OS.
For more information about organizing the jobs into one of the folder types for scheduling, see, Specific
Rule-based calendar scheduling (on page 339).

187
Control-M User Guide

Regular folder parameters


The following table describes parameters for a regular folder that is used to contain jobs.

188
Control-M User Guide

Parameter Description

SMART Defines whether a folder is SMART. When the option is


selected, the folder has an extended set of folder definition
parameters and can include Sub Folders.
To define a SMART Folder, select the check box and see
SMART Folder parameters (on page 191).

Folder Type Indicates whether the folder type is a regular folder, a SMART
folder, or a Sub Folder.
Value: Regular

Folder Library Defines the name of the library that contains the job’s folder.
Only z/OS folders.

Folder Name Defines the name of the folder. In the Properties pane this
parameter indicates the folder where the job belongs.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for


z/OS) that processes the job.

Order Method Defines the method for ordering the entity as one of the
following:
 Automatic (Daily): When set to Automatic, at the same
time each day (known as New Day time), each Control-
M/Server runs a procedure called New Day. This procedure
performs a number of tasks, including scheduling the day’s
jobs, and running maintenance and cleanup utilities. The
New Day procedures orders the folder or folder jobs.
 None (Manual Order): The folder is not automatically
ordered.
 Specific User Daily: Identifier used to assign the folder
to a specific User Daily job. The User Daily name is ordered
at a specific time of the day. For load balancing purposes,
the User Daily jobs are scheduled for different times,
throughout the day, other than the New Day time.

User Daily name Defines User Daily jobs whose sole purpose is to order jobs.
Instead of directly scheduling production jobs, the New Day
procedure can schedule User Daily jobs, and those User Daily
jobs can schedule the production jobs. Set User Daily Name
when Order Method is set to Specific User Daily.

Enforce Validations Read-only. Indicates whether the folder's enforcement policy


requires resolving of all validation errors or not.

189
Control-M User Guide

Parameter Description

Site Standard Applies the defined Site Standard to the folder and all jobs
contained in the folder. For more information, contact your
Control-M Administrator.
If only one Site Standard exits, it is selected by default. If there
are no Site Standards defined, it will be set to None.

Business Parameters Defines one or more Business parameters, according to the Site
Standard you have selected. For more information, contact
your Control-M Administrator.
If the Site Standard field is set to None, there are no Business
parameters displayed.

190
Control-M User Guide

SMART Folder parameters


The following table describes parameters for a SMART folder that is used to define scheduling,
prerequisites, and actions of the jobs and Sub Folders contained in the SMART folder. Only Control-
M/Server for Distributed Systems supports Sub Folders in SMART Folders.

191
Control-M User Guide

Parameter Description

SMART Defines whether a folder is SMART. When the option is


selected, the folder has an extended set of folder definition
parameters and can include Sub Folders. The jobs and Sub
Folders in the SMART Folder can inherit scheduling definitions
from the SMART Folder that contains them.
To define a regular folder, clear the check box and see Regular
folder parameters (on page 188).

Folder Type Indicates whether the folder type is a regular folder, a SMART
folder, or a Sub Folder.
Value: SMART

Folder Name Defines the name of the folder. In the Properties pane this
parameter indicates the folder where the job belongs.

Description (From Forecast only) Provides a description of the job in free


text. A well written description can help you determine why the
job was defined and how it fits into your business workflow.

Folder Library Defines the name of the library that contains the job’s folder.
Only z/OS folders.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for


z/OS) that processes the job.

Order Method Defines the method for ordering the entity as one of the
following:
 Automatic (Daily): When set to Automatic, at the same
time each day (known as New Day time), each Control-
M/Server runs a procedure called New Day. This procedure
performs a number of tasks, including scheduling the day’s
jobs, and running maintenance and cleanup utilities. The
New Day procedures orders the folder or folder jobs.
 None (Manual Order): The folder is not automatically
ordered.
 Specific User Daily: Identifier used to assign the folder
to a specific User Daily job. The User Daily name is ordered
at a specific time of the day. For load balancing purposes,
the User Daily jobs are scheduled for different times,
throughout the day, other than the New Day time.

192
Control-M User Guide

Parameter Description

User Daily name Defines User Daily jobs whose sole purpose is to order jobs.
Instead of directly scheduling production jobs, the New Day
procedure can schedule User Daily jobs, and those User Daily
jobs can schedule the production jobs. Set User Daily Name
when Order Method is set to Specific User Daily.

Run as Identifies the user name with the authorization to execute the
job. This parameter is used by the Control-M security
mechanism.

More Defines an area of the Properties pane to click to define more


parameters.

Variables All variables are identified by the %% prefix. If %% is


included in the value for a job processing parameter, Control-M
assumes that it is referring to a variable or function.
You can add a variable, as described in Adding a variable (on
page 96).

Additional Information An area in the Properties pane with information about:


 Application
 Sub Application
 Created by (not z/OS folders)

Application Provides a logical name for sorting groups of jobs. This


parameter is used to supply a common descriptive name to a
set of related job groups. The jobs do not necessarily have to
run at the same time.

Sub Application Indicates the name of the Sub Application where the job
belongs logically. It is a sub-category of the Application
parameter. For example, the Application is Finances, and the
Sub Application is Payroll.

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


(not z/OS folders)

Documentation Defines a description related to the job, and is saved in a


defined location. The Documentation area in the Properties
pane includes information about where to find the
Documentation. In a z/OS job, the Documentation is in a Doc
Member located in a Doc Library. In a non-z/OS job, the
Documentation depends on whether the type is File or URL. For
a file, the description is located in a file located in a file path.
For a URL, the Documentation is located in a URL address.

193
Control-M User Guide

Parameter Description

Type Defines whether the documentation for an OS job is in a file or


URL. See the following:
 URL: Defines whether the documentation for an OS job is
in a file or URL. The format starts with "http://", "ftp://", or
"file://".
 File: Specifies the file that contains the job script.

Doc Path For a z/OS job, Doc Library defines the name of the library
where the Documentation (description) is saved. For a non-
z/OS job, Doc Path defines the name of the file path where the
Documentation is saved.

Doc File For a z/OS job, defines the name of the member where the job
Documentation (description) is saved. For a non-z/OS job, the
Doc File is the name of the file where the job Documentation is
saved.

Priority Determines the order of job processing by Control-M in the


Active Jobs database.

Enforce Validations Read-only. Indicates whether the folder's enforcement policy


requires resolving of all validation errors or not.

Site Standard Applies the defined Site Standard to the folder and all jobs
contained in the folder. For more information, contact your
Control-M Administrator.
If only one Site Standard exits, it is selected by default. If there
are no Site Standards defined, it will be set to None.

Business Parameters Defines one or more Business parameters, according to the Site
Standard you have selected. For more information, contact
your Control-M Administrator.
If the Site Standard field is set to None, there are no Business
parameters displayed.

194
Control-M User Guide

Sub Folder parameters


The following table describes parameters for a Sub Folder that is used to define scheduling, prerequisites,
and actions of the jobs contained in the Sub Folder. Only Control-M/Server for Distributed Systems
supports Sub Folders in SMART Folders.

195
Control-M User Guide

Parameter Description

Folder Type Indicates whether the folder type is a regular folder, a SMART
folder, or a Sub Folder.
Sub Folder

Folder Name Defines the name of the folder. In the Properties pane this
parameter indicates the folder where the job belongs.

Description (From Forecast only) Provides a description of the job in free


text. A well written description can help you determine why the
job was defined and how it fits into your business workflow.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for


z/OS) that processes the job.

Run as Identifies the user name with the authorization to execute the
job. This parameter is used by the Control-M security
mechanism.

Parent Folder Defines the name of the folder that contains the job or Sub
Folder.
Names of folders and Sub Folders may be up to 64 characters,
with the exception of Control-M for z/OS folders which may be
up to 8 characters. Folder names cannot contain the character
“/”. SMART Folders in Control-M for z/OS can only contain jobs
(not Sub Folders).

More Defines an area of the Properties pane to click to define more


parameters.

Variables All variables are identified by the %% prefix. If %% is


included in the value for a job processing parameter, Control-M
assumes that it is referring to a variable or function. You can
add a variable, as described in Adding a variable (on page 96).

Application Provides a logical name for sorting groups of jobs. This


parameter is used to supply a common descriptive name to a
set of related job groups. The jobs do not necessarily have to
run at the same time.

Sub Application Indicates the name of the Sub Application where the job
belongs logically. It is a sub-category of the Application
parameter. For example, the Application is Finances, and the
Sub Application is Payroll.

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

196
Control-M User Guide

Parameter Description

Documentation Defines a description related to the job, and is saved in a


defined location. The Documentation area in the Properties
pane includes information about where to find the
Documentation. In a z/OS job, the Documentation is in a Doc
Member located in a Doc Library. In a non-z/OS job, the
Documentation depends on whether the type is File or URL. For
a file, the description is located in a file located in a file path.
For a URL, the Documentation is located in a URL address.

Type Defines whether the documentation for an OS job is in a file or


URL. See the following:
 URL: Defines the URL address where the documentation is
located. The format starts with "http://", "ftp://", or
"file://".
 File: Defines the file that contains the job script.

Doc Path For a z/OS job, Doc Library defines the name of the library
where the Documentation (description) is saved. For a non-
z/OS job, Doc Path defines the name of the file path where the
Documentation is saved.

Doc File For a z/OS job, defines the name of the member where the job
Documentation (description) is saved. For a non-z/OS job, the
Doc File is the name of the file where the job Documentation is
saved.

Priority Determines the order of job processing by Control-M in the


Active Jobs database.

Workspaces
A workspace is your working area, where you create job definitions, define job relationships and
dependencies, schedule jobs, and push the job definitions to the Active environment.
The following procedures describe the life cycle of a workspace:

197
Control-M User Guide

 Creating a Workspace (on page 198): Creates a workspace to define or edit job definitions.
 Checking out a Workspace (on page 202): Creates a working copy of the workspace, while you edit
the loaded jobs and folders in a workspace.
 Saving a Workspace (on page 82): Saves the workspace to the Job Definition database as a
workspace. You can continue defining jobs and repeatedly save the workspace.
 Checking in a Workspace (on page 85): Checks in new and edited jobs and folders in the workspace
to the Job Definition database. During check-in, there might be a conflict (or mismatch) between the
checked out data and the data in the Job Definition database, or a synchronization conflict between
the definitions in the Control-M/EM and Control-M/Server databases. You can resolve the conflict of
Control-M clients with Control-M/EM database during Check-in. Other synchronization errors are
resolved by using the Folder tool, as described in Folder management (on page 324). After the
workspace is checked in, the folders that were created and updated from the workspace, are
synchronized with the Job Definition database.

Creating a Workspace
This procedure describes how to create a workspace, which enables you to define or review job flows.
 To create a workspace:
 From the Planning domain, do one of the following:
• To create a job flow, click Blank Workspace.
• To create a job flow from existing jobs, click Load Folders and Jobs, and do the following:
a. Filter the loaded folders and jobs, as described in Filter parameters (on page 199).
b. Select the jobs and folders that appear in the Tree View, and click the Open drop-down list,
and select Open or Open Copy.
• To continue working on a job flow, click My Work, and select a workspace.
• To take ownership of a request, click Unassigned Work, select a request, and click Take
Ownership in the request, as described in Taking ownership of a request (on page 225).
To view or work on a colleague's job flow, click Other Work, as described in Taking Ownership
of a colleague's Workspace (on page 201).
The workspace opens.

198
Control-M User Guide

Filter parameters
The following table describes the filter parameters for opening a Workspace from the Planning domain or
a Viewpoint from the Monitoring or Forecast domains:

199
Control-M User Guide

Parameter Description

Folder Defines the name of the folder. In the Properties pane this
parameter indicates the folder where the job belongs.

Job Name Defines the name of the job processing definition and appears
in the job definition and tracking displays, and enables you to
identify the job, and order the job.

Control-M/Server Defines the name of the Control-M/Server (or Control-M for


z/OS) that processes the job.

Member Name Indicates the name of the file that contains the job script, or
for z/OS jobs, the name of a member that contains one of the
following in relation to the job to be executed:
 The JCL of the job
 The started task procedure
 Warning messages

Application Provides a logical name for sorting groups of jobs. This


parameter is used to supply a common descriptive name to a
set of related job groups. The jobs do not necessarily have to
run at the same time.

Sub Application Indicates the name of the Sub Application where the job
belongs logically. It is a sub-category of the Application
parameter. For example, the Application is Finances, and the
Sub Application is Payroll.

Folder Library Defines the name of the library that contains the job’s folder.

Member library For non-z/OS jobs, File Path indicates the location of the file
that contains the script. For z/OS jobs, Member Library
indicates the location of the Member that contains the JCL,
started task procedure, or Warning message.

Job Type Defines the job type.

User Daily Defines the name of the user daily. The user daily is the order
method.

Host/Host Group Defines the host/host group where the job is submitted.

Created by Defines the Control-M/EM user who defined the job.

200
Control-M User Guide

Parameter Description

Run as Identifies the user name with the authorization to execute the
job. This parameter is used by the Control-M security
mechanism.

Override Path Defines the temporarily-modified job script file without


changing the original script file in the File Path/Member library
and without changing the scheduling order of a folder.

Resource Defines the following types of resources:


 Control Resource - (From Forecast only) Indicates the
resources required by the job during execution and the
type of control (shared or exclusive) the job requires over
each resource. The Control Resources parameter is used
to control parallel execution of jobs.
 Quantitative Resource - (From Forecast only) Indicates the
name and quantity of Quantitative resources required by
the job.

Condition Defines the following types of condtions:


 In condition - Specifies prerequisite conditions that must be
satisfied before the job is submitted for execution. The In
Conditions parameter makes the submission of the job
dependent on the existence of one or more prerequisite
conditions.
 Out Condition - Specifies prerequisite conditions to be
added or deleted after the job completes.
 On/Do Actions - Automatic interventions, such as rerunning
a job or ordering a remedial job, if a job ends with a
particular error code.

Calendar Defines the name of a Control-M calendar that was defined in


the Calendar Manager.

Do Mail Defines the mail message that is sent to the indicated e-mail
addresses when the condition specified by the On
Statement/Code parameter is satisfied.

Taking Ownership of a colleague's Workspace


This procedure describes how to take ownership of a colleague's workspace, which enables you to review
and edit job flows.

201
Control-M User Guide

Before you begin


Ensure that you have authorization for browsing and updating jobs and folders in the workspace. For
more information, contact your Control-M Administrator.
 To take ownership of a colleague's Workspace:
1. From the Planning domain, click the tab.
2. Click Other Work.
3. Select a Workspace, and click Yes to the confirmation message.
The colleague's workspace opens.
4. In the Workspace tab, Workspace group, click Own.
You can now edit jobs and folders in the Workspace.

Validating a Workspace
This procedure describes how to validate the jobs and folders in a workspace.

 To validate a Workspace:
 In the Workspace, click Validate.
The Validation Report appears in the Results pane, and the first job in the report is selected and
appears in the Properties pane. If no row appears, then the jobs and folders are valid.

Checking out a Workspace


This procedure describes how to check out a Workspace, which enables you to edit job and folder
definitions.
NOTE: If you have set up a new blank Workspace or if you opened a copy, it is automatically checked
out.
 To check out a Workspace:
 In the Workspace, click Check Out.
The Check out icon is disabled. For more information about working in workspaces, see Workspaces
and Job definition.

Tracking changes in a Workspace


This procedure describes how to track changes in a Workspace, which enables you to track the
jobs/folders that are added, modified, and deleted.

 To track changes in a Workspace:


1. From the View tab, click Show Changes.
The list of changes appears in the Results pane.
2. Select the job/folder.

202
Control-M User Guide

The job/folder properties pane appears on the right. You can modify the job/folder as described in
Editing a job (on page 92) and Editing a folder (on page 94).
You can click on the column headings to filter the changes according to that column, such as Change
Type.

Import/Export
You can export job and folder definitions, which enables you to save your definitions as an XML file, and
later import them to another environment. You can also use the Job and Folder File Editor tool to transfer
job and folder definitions in a Workspace between environments, as described in Editing jobs and folders
in the Job and Folder File Editor Tool (on page 203).
The following procedures describe how to export and import job and folder definitions between
environments:
 Exporting jobs (on page 203): Saves your jobs and folder definitions or the whole workspace as an
XML file.
 Editing jobs and folders in the Job and Folder File Editor Tool (on page 203): Transfers job and folder
definitions by loading the jobs and folders from a workspace to an XML file editor. After you are done
editing the workspace and saving the XML file, you can import the XML file to any environment.
 Importing jobs to a Workspace (on page 204): Retrieves job and folder definitions from an XML file to
the workspace.

Exporting jobs
This procedure describes how to export job and folder definitions to an XML file.

 To export jobs:
1. From the Workspace tab, do one of the following:
• To export selected jobs and folders, do the following:
a. Select the entities to export.
b. Select , and select Export Selected Entities.
• To export the workspace, click .
2. In the Save As dialog box, set the file name, and click Save.
The file is saved as an XML file.

Editing jobs and folders in the Job and Folder File Editor Tool
This procedure describes how to edit jobs in an exported XML file using the Job and Folder File Editor.
The workspace is saved to the XML file, not the central repository. This enables you to move job and
folder definitions between configuration environments.

203
Control-M User Guide

Before you begin


 Ensure that you have exported a workspace to XML, as described in Exporting jobs (on page 203).

 To edit jobs and folders in the Job and Folder File Editor Tool:
1. From the Tools tab in the workspace, click Job and Folder File Editor.
The Open dialog box appears.
2. Browse to the exported XML file, and click Open.
The XML file is opens with the data from the workspace, and is valid and no conflicts exist. The jobs
appear as a workspace window, and the XML filename appears as the name of the workspace.
3. Edit jobs and folders.
NOTE: The functionality in the workspace differs from the regular workspace.
4. Click Save.
5. Import the saved XML file to a workspace, as described in Importing jobs to a Workspace (on page
204).

Importing jobs to a Workspace


This procedure describes how to import jobs and folders from an XML or a crontab file.

 To import jobs to a workspace:


1. From the Workspace tab, click .
The Open dialog box appears.
2. Select the file to import, and click Open.
The file is imported if it is valid and no conflicts exist. If the Import Error and Conflicts dialog box
appears, then there are errors and/or conflicts.
NOTE:If an error appears, fix the error in the XML file, and re-import the file.
3. If there are one or more conflicts such as an unknown Control-M/Server in the Resolution column,
resolve each conflict by selecting one of the following from the drop-down list, and following the on-
screen instructions:
• Unresolved Conflict
• Don't import
• Use temporary Control-M Server
• Assign existing Control-M Server
If you selected Use temporary Control-M Server or Assign existing Control-M Server, in the
Version column, select the Control-M Server from the drop-down list.
4. After you resolve all conflicts, click Continue.
The jobs defined in the import file are imported into the Workspace.

204
Control-M User Guide

Jobs search
The following table describes how to search for jobs and services in a Workspace or Viewpoint.

Search type Icon Description

Find (on page 205) Enables you to find jobs.

Find and Update (on (Planning domain only) Enables you to find and update jobs
page 207) and folders in a workspace.

Neighborhood (on Enables you to search for predecessor and dependent jobs.
page 222)

Find
Find enables you to do the following in the Planning and Monitoring domains:
 Search for job processing definition and folders with various values in any field, including external
application fields and list fields, such as Actions.
 Update, add, or remove any of the job processing definition and folders fields.
For more information about finding jobs, see Finding jobs (on page 205).
After you have created a search, you can save and then load for future use, as described in Saving and
loading a preset search (on page 206).
If you want to update many jobs and/or folders at one time, use Find and Update, as described in Find
and Update (on page 207).

Finding jobs
This procedure enables you to find jobs based on fields and values in jobs and folders in the Workspace in
the Planning Domain and/or in the Viewpoint in the Monitoring domain.

 To find jobs:
1. Do one of the following:

• From the Planning domain, in the Workspace tab, click .

• From the Monitoring domain, in the Viewpoint tab, select .


A find field appears at the top of the Map view.
2. In the find field, type the text you want to find.

3. Click , from the dropdown list select the fields to search, and then click OK.
4. (Monitoring domain only) To select which entities to search, in the Search In field, select All
Entities or select a status from the drop-down list.

205
Control-M User Guide

5. For additional fields, click .


The Advanced Find window appears.
6. Type or add any filters as required, as described in Filtering search fields (on page 206).

7. Click .
The results of the search appear in the Search results tab at the bottom of the Map view area. You
can then view it highlighted in the Flow diagram, Gantt view, or List view.

Filtering search fields


This procedure describes how to customize a filter in the Customizable Filter and Advanced Find window.
This enables you to display specific jobs and folders in the Workspace or Viewpoint.
NOTE: You can load, save or delete a search by clicking Presets.

 To filter search fields:


1. In the Advanced Find window, do any of the following:
• In the Job Name and Description, type the value of the field.
• Add any parameters as required. For more information about parameters, see Introduction to
parameters.
• (Monitoring domain only) Add any Run Time Attributes as required.
2. (Monitoring domain only) To include or exclude a term, click Advanced Criteria and do one of the
following:
a. Do one of the following:

o Add a field, operator, and value, click


o Add an OR relationship to other fields click .
A row appears in the appropriate section.
b. Select the Field from the drop-down list. For more information on these fields, see Control-M
Parameters.
c. In the Operator field, select an operator, as described in Filter operators (on page 211).
d. In the Value field, select a value from the dropdown list or type the value.
NOTE: If you want to review the filter fields, click Simple criteria to return to the Advanced
Find window.
3. To match the case, click Match Case.
4. If you have finished filtering the search fields, click Find.

Saving and loading a preset search


This procedure describes how to save and load a preset search.

206
Control-M User Guide

 To save and load a preset search:


1. After you have completed Finding jobs (on page 205), in the Advanced Find dialog box, select
Preset>Save.
This option is also available from the Customizable Filter dialog box.
2. In the Enter Preset Name field, type of the name of your search.
3. Click OK.
4. To load the search, click Preset>Load, and select the Preset load that you saved in step 2.
You can search using the filter that you saved and loaded.

Find and Update


You can update fields and values for multiple jobs and/or folders in a current workspace by using the
Find and Update feature in the Planning domain. Multiple fields can be modified simultaneously.
After finding matching jobs and/or folders, update jobs and/or folders with the updated criteria by
assigning values, functions, replacing substrings and expressions. Jobs and/or folders are updated in the
order that the criteria is defined in the Update matching jobs according to the following criteria
area. If you want to change the priority, select the criteria and click or . For more information about
updating jobs and folders, see Updating jobs and/or folders (on page 207).
When updating a job and/or folder, if one criterion is not met, it is skipped and the next criterion is
evaluated. However, if an update criterion is invalid (for example, if the specified change is not
supported) the job is not updated for any of the other criteria and the update process skips to the next
job. In the list of results, the job's status is failed.
NOTE: When updating from a regular folder to a SMART folder, the Rule Based Calendar and Excluded
Rule Based Calendar is defined as All Days. For more information about scheduling jobs and folders, see
Scheduling a job/folder.
After the job and/or folder is updated you can do the following:
 View the updated folder or job in the Workspace by selecting Select in View in the Results area.
 Correct any validation errors, by double clicking the updated folder or job in the Results area. You can
then make any changes to the job or folder.
 Rollback any updates by selecting the folder or job and click Rollback Updates.
NOTE: Only those jobs and folders can that be updated are those currently loaded into the Workspace.

Updating jobs and/or folders


This procedure describes how to update fields in a current workspace from the Planning domain.
Before you begin
Ensure that your Workspace is checked out.

 To update jobs and/or folders:

1. From the Planning domain, in the Workspace tab, select .

207
Control-M User Guide

The Find and Update window appears.


2. To search for job and/or folder definitions that you want to update, in the Find jobs that match All
the criteria area, define the following criteria:
• The job and/or folder definition to be updated.
• A filter operator, as described in Filter operators (on page 211).
• A search value
NOTE: Some job definitions and actions, such as variables and notifications, enable you to refine your
search by clicking .
If the job and/or folder definition is case sensitive, click the Case Sensitive checkbox.

3. To add additional job criteria, click and repeat step 2.


4. (Optional) To search for any matching jobs, click Find.
Matching jobs and/or folders from the Workspace are listed in the Results area.
5. To add the criteria that you want to update, in the Update matching jobs according to the
following criteria area, click , and then define the following criteria:
• Select one of the following:
o Update
o Update where
NOTE: You can also select Add or Remove for some Actions and job definitions. For more
information, see Find and update job and folder actions (on page 209).
• The job and/or folder definition that you want to update.
• An action operator, as described in Action operators (on page 213).
• A filter operator
• A search value
NOTE: Some job definitions and actions, such as variables and notifications, enable you to refine
the update by clicking . For more information, see Example removing mail notifications from
jobs at once (on page 219).

6. To add additional search criteria expressions, click , and repeat step 5.


NOTE: There is a sequential relationship between the criteria. To change the order of the expressions
click on the up and down arrow icons. You can delete any criteria expressions, by select the criteria
and clicking .
7. Click Update.
8. (optional) To save the specified Find and Update criteria for future use, click Presets and then click
save.

208
Control-M User Guide

Find and update job and folder actions


The following table describes the find and update job and folder actions:

209
Control-M User Guide

Expression
Type Description

Find Evaluates simple fields such as Job Name and Application, according to the find
operator and find value selected.
EXAMPLE: Find Control-M like ABC*

Find any Searches for fields such as In Conditions and Notifications. You can to refine your
search according to the sub-expressions of the expression by clicking .
EXAMPLE 1:
Find any Control Resource matches any job that has at least one control
resource defined.
EXAMPLE 2:
Find any Control Resource

Click .
Where Name like C*, D*
Matches any job that contains at least one control resource that starts with the
letter C or D.

Update Enables you to update the field value regardless of the previous value
(unconditional).

Update where Enables you to update the field value depending on the previous value
(conditional)
EXAMPLE: If you select Update where the Application starts with A replace
substring xyz, Application fields that start with the letter A are
updated and replaced with the substring xyz.

Add Adds a new complex field into a list field according to the criteria and defined sub-
fields.
EXAMPLE:
Add In Condition:

Click .
Set Name assign incondition1

Click .
Set Date assign ODAT

Remove Removes a complex field from a list field according to the criteria and defined sub-
fields. For an example, see Example removing mail notifications from jobs at once
(on page 219).

210
Control-M User Guide

Filter operators
The following table describes the Filter operators:

Operator Description

Like Searches field values using regular expressions, such as *.


EXAMPLE: Find Folder Name Like F*, finds all folder names starting with F.

Not like Searches fields that exclude values using regular expressions such as *.
EXAMPLE: Find Folder Name Not Like F*, excludes all folder names starting
with F.

Is Exactly Searches field values which are equal to the value provided (exact match, no
wildcards or regular expressions).

Is Not Exactly Searches field values that are not equal to the value provided (no wildcards or
regular expressions).

Starts with Searches field values that start with the value provided. Pattern-matching rules
apply. Special characters such as ‘*’ are not processed as literals unless there is
a backslash.
 DESCRIPTION Starts with "abc*"
 Matches DESCRIPTION values "abcd", "abc888", and "abc*"
 The DESCRIPTION that starts with "abc\*", matches only DESCRIPTION
values "abc*999", "abc*ddd" etc.

Ends with Searches field values that end with the value provided. Pattern-matching rules
apply.

Contains Searches field values that contain the substring (exact or pattern) provided.
Pattern-matching rules apply.

Does Not Contain Searches field values that do not contain the substring (exact or pattern)
provided. Pattern-matching rules apply.

Is empty Searches for fields that have no value (NULL or empty string).

Is Not empty Searches for fields that have any value.

< or < = or > or Searches for fields that are less than, less than and equal to, more than and
>= more than and equal to the value.
EXAMPLE: Search for Keep Active jobs > 5 days

211
Control-M User Guide

212
Control-M User Guide

Action operators
The following table described the Action Operators for finding and updating jobs:

213
Control-M User Guide

Action Description

assign Assigns the value as is (no functions, place holders or regular expressions).
If the field contains several values (a list field, such as scheduling Dates field),
you can add or modify values in the list, by providing comma-separated values.
If only one value is specified, only the first value in the list field is updated.
EXAMPLE: To add three scheduling dates to the list use:
Update "Dates" assign "0909,0807,0221"

assign function Assigns function values.


The '*' character is a special place holder of the previous field value (or a part
of it).
EXAMPLES:
Set the job File Name from /home/user1/* TO /home2/user3/*
Update where Out Condition Name like "*" assign function *@HHMMSS.
The condition name is evaluated and set by Control-M at runtime,
enabling users to create unique condition names in cyclic jobs. The
character ‘*’ has a special meaning and can save the previous field
value.
For more information about Assign Function Operators, see Function operators
(on page 216).

clear Clears the field value. Fields that are assigned with a predefined set of values
reset to the default value.

replace substring Replaces all occurrences of the substring specified in the first field with the one
specified in the second field (which may be empty).
EXAMPLE:
If the field contains several values (a list field, such as the "SAP R3:Variant
Name" field), you can replace a substring like "VAR1" with another
string "VAR2" in all cell values using the following statement:
Update "SAP R3:Variant Name" replace substring "VAR1" "VAR2"

214
Control-M User Guide

Action Description

replace expression Regular expressions search and replace support (can use references to
numbered groups).
EXAMPLE:
Update Application replaces expression (.*)account(.*) with \2account\1
In this example, if the Application's original value was GLOBALaccount45, the
update is set to 45accountGLOBAL.
If the field contains several values (a list field, such as the "AFT::File Path on
Host 1" field), the assign operator allows you to modify the whole
list at once, using comma-separated values. However, you can set
all cell values with the same "test" value like this:
Update "AFT::File Path on Host 1" replace expression ".*" "test"

215
Control-M User Guide

Function operators
The following table describes the Assign Function operators.

Function Description

Field Name Defines the field in a job or folder. Use the name of the field
exactly as it appears in the From Source field by clicking .
Where you specify both a predecessor job field name and a
successor job field name the format is the following:
{File/Member Name}-TO-{TargetJob:File/Member Name}

From Source Defines the field you want to parse from the drop down list.

Counter Increases sequentially the inserted value. For example, this job is
Job # {Counter}
NOTE: If you want to change the counter value, from File, select
Options, click the Planning and in the Job Definition section
select the Counter value.

Substring Defines a substring from a specified field or function. You can


select the number of characters in the string and the number of
characters in the beginning of the string to search for. When
finished click to add the Function Properties to the Function
field.

+-* Indicates an amount to add, decrease or multiply in a condition


name format. You can select the amount to add, decrease or
multiply. Limited to rerun fields, such as Keep Active. When
finished click to add the Function Properties to the Function
field.

Example updating Application field


This example describes how to update the Application field using the Find & Update feature.
In Appjob, you need to update the Application field by adding the word new to the Application field
AppApplication:
1. Click Find & Update.

216
Control-M User Guide

In the Find jobs that match All the following criteria area, type AppJob and then click Find.

2. In the Update matching jobs according to the following criteria area, select assign function
and click .
The Insert Function window appears.
3. Click Insert Function and select {Field Name} from the drop-down list.
4. In the From Source field select Application from the drop-down list.

5. Click .

217
Control-M User Guide

6. Type New before {Application}.

7. Click OK and then Click Update.

218
Control-M User Guide

8. The Application field has now been updated:

Example removing mail notifications from jobs at once


The following example describes how to remove mail notifications from jobs at once using the Find &
Update feature.
After you have found the jobs that you want to update, in the Update matching jobs according to
the following criteria area do the following:
1. Select Actions, then select On-Do Actions and then click On-Do Action.

2. Click to add criteria.


Update On Statement criteria line appears (second line).
3. In the second line, change Update to Remove and Change On Statement to a Do Statement by
selecting Do Statements and then clicking Do Statement.

4. In the second line, click to add criteria.

219
Control-M User Guide

5. In the third line change Do Action to Do Notify Mail under by selecting Do Notify Mail and then
clicking Do Notify Mail.

6. Click Update.

Example mass update notifications when execution time exceeds 3 hours


The following example describes how to mass update notifications when execution time exceeds 3 hours.
Currently you have a number of jobs that send notifications when execution exceeds 5 hours and you
want to update all jobs to send a notification after 3 hours.
1. In the Update matching jobs according to the following criteria area, select Actions, then
select, Notifications and click Notification.

2. To add child criteria rules, click .


3. In the next line, from the drop-down list select the message urgency.

4. Click select Destination and type EM.

5. Click and click Exectime.

220
Control-M User Guide

6. Click , click Time and then type <180.

7. Click Update.

Example adding text to an In Condition name


This example describes how to add text to an In condition name using the Find & Update feature.
You have a number of In Conditions such as abcd###### and you want to add xyz_1 at the end of the
In Condition, so it appears abcd######xyz.
1. In the Find jobs that match All the following criteria area, define the criteria and click Find.
2. In the Update matching jobs according to the following criteria area, select Prerequisites, In
Conditions, and then click In Conditions.

3. Click .
4. Change Assign to replace expression.
5. In the first field type $.
6. In the second field, type $xyz.

221
Control-M User Guide

7. Click Update.

Finding neighborhood jobs


This procedure describes how to find the jobs that are in the neighborhood of the selected job, which
enables you to analyze your job flow based on specific relationships to the selected job. For example, you
can search for prerequisite jobs, which are the predecessors of the selected job. In the Monitoring
domain, you can open a Viewpoint with the search results.
 To find neighborhood jobs:
1. In a Control-M Workload Automation, do one of the following:

• In a Workspace, the Analysis tab, select .

• In a Viewpoint, in the Analysis group, select .


The Neighborhood fields appear at the top of the Map view.
2. Set the Direction and Radius fields, as described in Neighborhood search fields (on page 223).

3. Click .
The results of the search appear in the Neighborhood results tab at the bottom of the Map view
area. You can then view it highlighted in the Flow diagram, Gantt view, or List view.

222
Control-M User Guide

Neighborhood search fields


The following table describes the Neighborhood Search fields:

Neighborhood Description

Direction Defines the relationship of the search jobs to the selected jobs.
 Dependent: Defines the jobs that are dependent on the
selected job (below the job).
 Direct Relationship: Defines the prerequisite jobs of the
selected job, and the jobs that are dependent on the selected
job (above and below the job).
 Predecessor: Defines the prerequisite jobs of the selected
job (above the job).
 Radial: Defines the jobs branching in all directions from the
selected job.

Radius Defines the number of jobs that branch out from the selected job.
Valid values: 1-99999

Job Definition and Active Jobs databases


Job, folder, and calendar definitions are saved in the Job Definition database. When a job, SMART
Folders, and Sub Folders are ordered, an instance of the definition is placed in the Active Jobs database,
so it can be monitored. The following terms represent repositories that are part both the Control-M/EM
and Control-M/Server databases:
 Job Definition Database: A definition repository in Control-M/EM and Control-M/Server databases.
The default synchronization setting is to always synchronize the definition changes between Control-
M/EM and Control-M/Server. The Job Definition Database holds the current definitions of the jobs,
folders, and calendars.
 Active Jobs Database: An active repository of all Active entities in the Control-M/Server, including
Active jobs, SMART folders, conditions, and other Production Control entities, such as active
quantitative resources, active qualitative resources, and active workload policies.
 Central Repository: A central repository in the Control-M/EM database that stores Workspaces,
which contain the job and folder definitions that have not yet been committed to the Job Definition
Database. It enables you to continue working on your saved Workspace, even if you close the
Workspace.

223
Control-M User Guide

Control-M Workload Change Manager


Control-M Workload Change Manager is a Control-M add-on, which enables you to do the following:
 Enables application developers/analysts or the web users to request changes to business workflows
by creating and submitting requests. These change requests are related to your Control-M definitions
in Control-M. The requests appear in the Planning-Home page along with other Workspaces. For more
information on the request workspace, see Request Workspace (on page 224).
 Enables a Control-M Administrator to create standards to assist schedulers and web users to define
folders/jobs according to your organization's standards. For more information, see Site standards
management (on page 314) and Site customizations management (on page 312).
 Enables a Control-M Scheduler to automatically transfer folders and jobs between environments, as
described in Promotion (on page 229).

Request Workspace
A request Workspace has the same functionalities as a regular Workspace, except it is initiated by the
Control-M Workload Change Manager web user, who in this case, is the requester. For Control-M
Workload Change Manager users, a request workspace enables them to carry out the same actions that
you normally carry out in a regular workspace, with additional request actions.
The request Workspace can be modified by you, and the web user. However, this cannot be done
simultaneously, it depends on the request Workspace status. For more information, see Request statuses.
After you take ownership of a request, as described in Taking ownership of a request (on page 225), it is
opened in a request Workspace. You can carry out the same actions that are described in Workspaces,
with the following additions:
• Return: If a request requires more modifications on the web-user end, you can return the
request, as described in Returning a request (on page 226).
• Notes: Other than the synopsis view and the details view in the properties pane, you can view
notes. For more information, see Notes (on page 227).
• Change Management Status: If Workload Change Manager is integrated with a change
management system, you can click in the ribbon to check the status of the request in the
change management system.
Note: If Workload Change Manager is integrated with a change management system as described in
Workload Change Manager integration with a change management system, some of these actions might
be subjected to approval from the change management system, depending on the rules defined. If an
action is not approved by the change management system, you will not be able to carry on with some of
these actions. For example, if the request does not meet the requirement set in the change management
system for returning a request, you cannot return the request unless the issue is resolved. For more
information, please contact the relevant individual in your organization.

224
Control-M User Guide

Request Workspace lifecycle


The following are stages of a request Workspace lifecycle:

Stage

1. A Control-M Workload Change Manager web user creates a request for defining a new
job flow or open an existing job flow.

2. After creating the request, the web user submits the request to be handled by a
scheduler.

3. The submitted request appears in the Unassigned Work area of the Planning-
Home page.

4. You can take ownership of the request, as described in Taking ownership of a request
(on page 225). Once you take ownership of the request, it appears in the My Work
area of the Planning-Home page.

5. Open the request, and review the definitions, and notes. If additional modifications
are required, return the request to the web user, as described in Returning a request
(on page 226).

6. If there are no additional modifications required, check in the request, and the
business flow is added to the Control-M definitions. For more information, see
Checking in a Workspace (on page 85).

Note: If Workload Change Manager is integrated with a change management system as described in
Workload Change Manager integration with a change management system, some of these actions might
be subjected to approval from the change management system, depending on the rules defined. If an
action is not approved by the change management system, you will not be able to carry on with some of
these actions. For example, if the request does not meet the requirement set in the change management
system for checking in a request, you cannot check in the request unless the issue is resolved. For more
information, please contact the relevant individual in your organization.

Taking ownership of a request


This procedure describes how to take ownership of unassigned requests.

Before you begin


 You must have Control-M Workload Change Manager activated.
 Ensure you have the right authorizations. Contact your Control-M Administrator.
 To take ownership of a request:
1. In the Planning - Home page, click Unassigned Work.
2. Select a request.
3. Click Open.

225
Control-M User Guide

The request appears with a message at the top.


4. In the message that appears, click Take Ownership.
You can now edit jobs and folders in the request.
Note: If Workload Change Manager is integrated with a change management system and the request
was not approved, you will not be able to modify the request after taking ownership. To be able to
modify the request, the issue preventing the approval from the change management system must be
resolved. For more information, please contact the relevant individual in your organization.

Returning a request
This procedure describes how to return a request, which enables you to return the request to the Control-
M Workload Change Manager web user if more modifications are required.

Before you begin


 You must have Control-M Workload Change Manager activated.
 Ensure you have the right authorizations. Contact your Control-M Administrator.
 To return a request:
1. In the Planning-Home page, select the request.
The request Workspace appears.

2. From the Workspace group in the Workspace tab, click .


A confirmation message appears.
3. Click Yes
The request is returned to the web user. The request is now in Requester Works status, and is in
read-only mode. You cannot modify the request. For more information, see Request statuses.
Note: If Workload Change Manager is integrated with a change management system and the request
was not approved, you will not be able to return the request to the web user. To be able to return the
request, the issue preventing the approval from the change management system must be resolved.
For more information, please contact the relevant individual in your organization.

226
Control-M User Guide

Request statuses
The following table lists the request statuses:

Status Definition

Requester Works Indicates that the requester is editing the job flow in the request.
If the requester is working on the request, the request is in read-
only mode. The scheduler cannot modify the request.

Submitted Indicates that the request is submitted to the scheduler to handle.


In Control-M Workload Change Manager, the request is in read-
only mode, and cannot be modified by the requester.

Scheduler Works Indicates that the scheduler is editing the job flow in the request.
If the scheduler is working on the request, the request is in read-
only mode. The requester cannot modify the request.

Returned Indicates that the request is returned by the scheduler to the


requester (appears in the Workspace Manager). This usually
happens if the scheduler is requesting more information or
modifications to the request.

Approved Indicates that the request does not require any further
modifications and is approved by the scheduler (appears in the
Workspace Manager). The job flow is now part of Control-M
definitions.
In Control-M Workload Change Manager, the request is in read-
only mode, and cannot be modified by the requester.

Note: If Workload Change Manager is integrated with a change management system as described in
Workload Change Manager integration with a change management system, some of these actions might
be subjected to approval from the change management system, depending on the rules defined. If an
action is not approved by the change management system, you will not be able to carry on with some of
these actions. For example, if the request does not meet the requirement set in the change management
system for submitting a request, you cannot submit the request unless the issue is resolved. For more
information, please contact the relevant individual in your organization.

Notes
Notes enable you to easily communicate with the web user. It is a method of communicating information
regarding the request and its entities. For example, if a request requires modifications, you can return the
request and add a note to the web user stating the necessary modifications.
You can add notes at two levels:

227
Control-M User Guide

 Request Note: Enables you to add a note to the request, as described in Adding a note to a request
(on page 229).
 Folder/job Note:Enables you to add a note to a specific folder/job, as described in Adding a note to
a folder/job (on page 229).
You can also view all notes from the requester, as described in Handling requester notes (on page 228) .
The notes tab includes the following:
 Notes by requester and scheduler
 Notes' statuses
 Notes' timestamps
You can also perform the following actions on notes:
 Resolve: Enables you to mark a note as approved, if the note was handled by you or the web user,
as described in Resolving notes (on page 228).
 Reopen: Enables you to reopen an approved note.
If any notes remain in open status, and were not approved, when you check in the request, the check-in
fails. You must approve any open notes before checking in a request to the database.

Handling requester notes


This procedure describes how to view and handle notes from the requester.

 To handle requester notes:


1. In the request, in the bottom pane, click the Notes tab.
The Notes information appears in the bottom pane.
2. Click on the selected note.
If it is a folder/job note, the relevant entity is highlighted in the flow diagram.
The note text appears in the right pane. You can reply to the web user, as described in Adding a note
to a request (on page 229) and Adding a note to a folder/job (on page 229).
3. If you handled the notes, you can mark it as resolved, as described in Resolving notes (on page 228).

Resolving notes
This procedure describes how to resolve notes, which enables you to mark and close open notes that
were handled.
 To resolve notes:
1. In the request, in the bottom pane, click the Notes tab.
The Notes information appears in the bottom pane.
2. Click on the selected note.
If it is a folder/job note, the relevant entity is highlighted in the flow diagram.
The note text appears in the right pane.

228
Control-M User Guide

3. Click Resolve.

Adding a note to a request


This procedure describes how to add a note to a request, which enables you to communicate with the
web user and write necessary instructions or other information.
 To add a note to a request:
1. In the request, in the bottom pane, click the Notes tab.
The Notes information appears in the bottom pane.
2. Click on the request note.
The note text appears in the right pane.
3. In the Add new note text box, add your note.
The note is added, and is attached to the request after the request is returned to the web user.

Adding a note to a folder/job


This procedure describes how to add a note to a folder/job, which enables you to write information about
the folder/job to the web user.
 To add a note to a folder/job:
1. In the request, select the folder/job.
The properties pane appears on the right.

2. Click .
3. In the Add new note text box, add your note.
The note is added to the folder/job, and is attached to the folder job after the request is returned to
the web user.

Promotion
Control-M Workload Change Manager's Promotion feature enables you to automatically transfer folders
and jobs between environments. Once you have finished working on job definitions in a source
environment, you can move folders and jobs to the target environment, while the data is automatically
transferred according to your predefined promotion rules. For more information about setting up
promotion rules, see Promotion rules (on page 330).
When promoting job definitions, all folders that you want to promote must be checked-in. Promotion
transfers are validated in the target environment with site standards, which enable you to define settings
that ensure that schedulers follow your organization's standards. If the target environment is a different
Control-M/EM than the source environment, the site standard validation is applied according to the target
environment. For more information about Site Standards, see Site standards management (on page 314).
When promoting job definitions, you can select the following promotion types:

229
Control-M User Guide

 Promotion request: Enables you to send a promotion request from the source environment to the
target environment. The scheduler who is responsible for the target environment opens your request,
reviews it and checks it in. The request is sent to the Unassigned Work section in the Planning
home page. For more information about taking ownership of a workspace, see Taking ownership of a
request (on page 225).
 Promote and check-in: Enables you to send the request to the target environment and
automatically checks in folders after transformation, without any intervention from the scheduler.
Validation errors or warnings can occur after modification rules are applied to the folder, if for example, a
mandatory job field is missing. If there are validation errors, you can either fix the errors before sending
the request or send the request with errors by using the Promotion request option.
To promote a workspace, see Promoting a workspace (on page 230).
You can promote as a batch process by using the emwacli utility, which enables you to initiate promotion
as a batch process by performing automatically transformations and validations. For more information,
see emwacli.
EXAMPLE:
Todd, a Control-M Administrator defines two environments:
• Testing Environment
• Production Environment
Todd grants Dan, a scheduler, promotion request privileges.
Dan defines a job in the testing environment and passes the job to Rob, the business user,
for testing. After Rob approves the job, Dan promotes the job to David, a Production
Controller, to the production environment. David completes the review, takes ownership and
checks in the workspace.
To view the promotion feature overview video, see
(https://www.youtube.com/watch?v=Xz5ORcFTR68&feature=youtu.be).

Promoting a workspace
The following procedure describes how to promote a workspace from one environment to another.

Before you begin


Ensure the following:
 Control-M Workload Change Manager is activated. For more information, see Introduction to Control-
M Workload Change Manager.
 A Promotion rule has been created for your environment, as described in Promotion rules (on page
330).
 You have checked in your folders or workspace that you want to promote.
 To promote a workspace:
1. In the Workspace tab, click .
2. If more than one promotion rule appears, from the Promotion Rule Selection window, select the
promotion rule from the drop-down list and click OK.

230
Control-M User Guide

The Promote request window appears.


3. In the Promote request window, define the following parameters:
• In the Request Details area type the values as described in Request Details parameters (on
page 231).
• In the Choose Promotion Type area, select one of the following:
o Promotion request: Enables you to send a promotion request from the source environment
to the target environment.
NOTE: If the target environment is a different Control-M/EM the submitted request appears in
the target Control-M/EM environment in the Unassigned Work in the Planning Home tab.
o Promote and check-in: Enables you to send the request to the target environment and
automatically checks in folders after transformation, without any intervention from the
scheduler.
NOTE: If Promote and Check-in option or both options are disabled, your administrator has
not granted you the rights for this operation.
4. Click OK.
NOTE: A warning message may appear if the folder does not conform to the source environment
promotion rules.
5. A confirmation window appears, click Yes.
If you select, Promotion request, the folder appears in the Unassigned Work in the Planning -
Home tab of the target environment. If you select Promote and check-in, the folder is
automatically checked in. For more information about workspaces, see Creating a Workspace (on
page 198).

Request Details parameters


The following table describes the Request Details parameters.

Parameter Description

Name Defines the request name.

Change ID Indicates the change ID that can be associated with the request.
Optional.

E-Mail Notification Defines the e-mail address where the Promotion request is
submitted and checked in.
NOTE: To receive email notification, you need to define the email
server parameters, as described in E-mail configuration
parameters.

Description Defines the request description that appears in the request details.
Optional.

231
Control-M User Guide

Version management
The Version manager is a tool that enables you to view job and folder definitions for a specified date and
time that corresponds to your specified filter criteria. A list of the matched definitions appears, indicating
the changes made to the item since the specified date and time.
Each definition entity can be reviewed from the Properties pane and then selected for a restore operation.
Multiple entities can be selected when performing the restore operation.
The following procedures describe how to filter definitions entities, view the version list of a definition
entity, compare definition entity versions, and edit and restore a definition entity version.
 Filtering definition entities (on page 232)
 Managing versions of a job (on page 233)
 Comparing different versions of a job (on page 233)
 Editing and Restoring a definition entity version (on page 234)

Filtering definition entities


This procedure describes how to filter definition entities, which displays definitions on a specific date and
time, with a change type indicator since the specified date and time.
 To filter definition entities:
1. From the Planning domain, in the Tools menu, select Versions.
The Versions window appears.
2. Do the following:
a. From the Control-M drop-down list, select a Control-M/Server where the definition entities are
located.
b. From the Folder drop-down list, select a folder that you want to display.
c. If you want to filter for more specific criteria, click Advanced Filter, in the Additional Filter
Criteria window, define your specific criteria, and click OK.
d. In the Date field, select a date.
e. If you want to select the specific time, in the Time field, select the check box and enter a specific
time.
f. If you want to filter specific entities based on the changes, use the Change Type buttons to
select one or more of the following:

o Unchanged Items: Entities that have not been changed since the specified date

o Modified Items: Entities that have been modified since the specified date, including
modifications which affect the inclusion or removal from the filtered list

o New Items: Entities that were created after the specified date, including items modified
or deleted since the specified date

232
Control-M User Guide

o Deleted Items: Entities that were deleted after the specified date
3. Click Apply.
The filtered definition entities appear in the list.

Managing versions of a job


This procedure describes how to manage versions of a definition entity, which enables you to view the
properties, compare parameters of definition entities, and edit and restore a definition entity version.

 To manage versions of jobs:


1. From the Planning domain, in the Tools menu, select Versions.
The Version window appears.
2. Filter the definition entities that you want to view, as described in Filtering definition entities (on page
232).
3. Select the definition entity that you want to view and click .
The Show History window appears.
4. Do one or more of the following:
• If you want to view the properties of a definition entity, click Properties.
• If you want to compare currently monitored version with its current active version, click
Compare.
• If you want to use a specific version, click Use.
• If you want to edit the definition entity version and then restore it, click Edit and Use, as
described in Editing and Restoring a definition entity version (on page 234).
5. Click Close.

Comparing different versions of a job


This procedure describes how to compare parameters of different versions of job definitions.

 To compare different versions of a job:


1. From the Planning domain, in the Tools menu, select Versions.
The Version window appears.

2. Select the two different versions of the job definition that you want to compare and click .
The Compare window appears.
3. Compare the parameters of both jobs, and then click Close.
For more information on comparing jobs, see Comparing jobs (on page 83).

233
Control-M User Guide

Editing and Restoring a definition entity version


This procedure describes how to edit and restore a definition entity version to the current version in the
Version manager.
 To edit and restore a definition entity version:
1. From the Planning domain, in the Tools menu, select Versions.
The Version window appears.
2. Filter the definition entities that you want to view, as described in Filtering definition entities (on page
232).
3. Select the definition entity that you want to edit and restore and click .
The definition entity appears. For more information on defining jobs, see Creating a job (on page 47).
4. Edit the required fields and click Use.
The definition entity is restored.

234
4
4
Monitoring
The Monitoring domain enables you to monitor the processing of the jobs, perform critical user tasks,
handle problems, and solve various issues. Batch flows usually exist in a distributed system spanning
many computers of different types.
By using Control-M, you can see the progress of your batch flows, and identify problems and potential
problems. You can view and monitor, jobs on a particular Control-M/Server, jobs belonging to a specific
batch service or specific application, and jobs having a particular status, such as failed jobs.
At any time you can view active jobs, perform actions, view alerts, or analyze business services, as
described in the following topics:
 Viewpoints (on page 235): Enables you to view the Active Jobs in the Monitoring domain. To display
only those jobs and job flows of interest, you can dynamically customize Viewpoints, as described in
Setting up a Viewpoint (on page 236).
 Alerts Monitor (on page 267): Enables you to monitor your production environment by using Alert
Monitor. An alert is a message that indicates that a problem or exception has occurred for a job.
 Service Monitor (on page 268): Enables you analyze business services, and locate and resolve
problematic jobs.
 Business Service Analysis Viewpoint: Enables you to focus on one particular service. All the jobs of the
service are displayed in the Viewpoint, together with additional information related to the BMC Batch
Impact analysis.
 Control-M MFT Dashboard (on page 278): Enables you to monitor and track the traffic load, file
status, and active connections of all file transfers in Control-M .
For more information about navigating in the Monitoring domain, see Monitoring domain (on page 17).
To view a detailed Monitoring domain video, see (https://www.youtube.com/watch?v=sawnqUF9bwE).

Viewpoints
A Viewpoint is a customizable, dynamic tool, which enables you to display the jobs and job flows of
interest. For example, you can view and monitor jobs:
 On a particular Control-M/Server
 Belonging to a specific user
 Having a particular status, such as failed jobs
Viewpoints are constantly updated and show in real-time the execution status of the batch production.
Control-M provides a set of predefined Viewpoints. You can define other Viewpoints according to need, as
described in Viewpoint management (on page 309),
After you have set up you Viewpoint (on page 236), you can do the following:

235
Control-M User Guide

 Analyze active jobs (on page 237): Enables you to analyze jobs and manage job flows. You can
display and modify the processing details of jobs.
 Perform actions (on page 243): Enables you to intervene manually when special critical processes,
and potentially problematic situations arise.
For more information about viewing alerts, services, or further analyze business services, see Alerts
Monitor (on page 267), Service Monitor (on page 268), Business Service Analysis Viewpoint.

Setting up a Viewpoint
This procedure describes how to open an existing Viewpoint and customize the view, which enables you
to monitor your active jobs.

 To set up a Viewpoint:
1. From the Monitoring domain, select one of the following:
• Recent Viewpoints
• All Viewpoints
2. Do one of the following:
• Select one of the Viewpoints to display.
• To customize a viewpoint filter, hover over one of the Viewpoints, and do the following:
a. Select Custom Filter next to the Viewpoint you want to customize.
b. Customize the Viewpoint, as described in Filtering search fields (on page 206).
c. Click Open.
3. If you want to change the filter in an open viewpoint, from the ViewPoint tab in the filter field, do
one of the following:
• Do the following:
a. Click Customizable Filter.
b. Customize the Viewpoint, as described in Filtering search fields (on page 206).
c. Click Open.
• Click one of the following filters:
o All Active Jobs
o All Jobs
o Ended Not OK
o Ended OK
o Waiting Jobs
The Viewpoint is filtered according to your selections.

236
Control-M User Guide

Active Job analysis


To help you analyze jobs and manage job flows, you can display and modify the processing details of jobs
in the Monitoring domain. You can also modify certain details for that job.
If Batch Impact Manager (BIM) is installed, you can monitor Control-M actual and estimated job
executions from a glance and obtain an understanding of the jobs runtime information that enables you to
control your active environment more efficiently.
The monitoring viewpoint can show you the jobs in a flow that will start/end running and which jobs are
planned to execute in a specific timeframe.
BIM provides average start/end time for jobs that are estimated not to run based on runtime statistics. If
the average start time already passed and the job did not run, an estimation warning appears in
addition to the average start and end time sent by BIM. If both the start and end times are based on an
estimation, is displayed before the estimated start time. If only the end time is based on an
estimation, is displayed before the estimated end time.
EXAMPLE:
BIM estimates Job A will not run
Job A Average start to end time = 08:00-08:05
Job A actual start time = 08:04

BIM shows end time as . When Job A starts, BIM begins to process the calculation and when the end
time has been calculated, BIM updates the new estimated end time showing .
When job's run is complete the start and end times are updated.
For details on the BIM icons, see Run time estimation information (on page 240).

237
Control-M User Guide

You can view a job's details in the following tabs:

Tab Description

Synopsis Shows fields such as, start time and end time, order ID, order
date, status, attributes of the selected job, as described in Job
definition.

Waiting Info Displays the reasons why the job has not yet been executed and
enables you to intervene as needed. For more information, see
Analyzing active jobs (on page 238).

Script Displays the job script statements or a z/OS job’s JCL code, as
described in Analyzing a script (on page 241). For more
information on verifying the JCL code, see Verifying JCL code in an
active job (on page 241).

Log Displays the activity log of the selected job.

Belongs To Displays what service and Workload Policy the job belongs. For
more information, see Analyzing what service the job belongs to
(on page 243).

Output Displays the job’s Output, as described in Analyzing Output of an


active job (on page 242).

Statistics Displays statistics of the job’s latest runs.

Documentation Displays a description related to the job, and is saved in a defined


location. The Documentation area in the Properties pane includes
information about where to find the Documentation.
In a z/OS job, the Documentation is in a Doc Member located in a
Doc Library.
In a non-z/OS job, the Documentation depends on whether the
type is File or URL:
 For a file, the description is located in a file located in a file
path.
 For a URL, the Documentation is located in a URL address.

Analyzing active jobs


This procedure describes how to analyze active jobs, which enables you to view the job’s details, waiting
info, script, log, output, statistics, documentation, and services the job belongs to.

238
Control-M User Guide

 To analyze active jobs:


1. From the Viewpoint, click the job you want to view.
The job properties appear in the Job Analysis pane.
2. Do one or more of the following:
• To view the summary view of the Job, select Synopsis .
o If Batch Impact Manager is installed and the job average start/end times have passed, real
time job runtime information appears as described in Run time estimation information (on
page 240).
o For cyclic jobs, the estimated run time is shown for each of the time intervals in the cycle. If
Batch Impact Manager is not installed, actual start/end times are shown in the job node.
o From the View tab, in the Map group, select the Show/Hide Time checkbox to show
actual or estimated job runtimes in the job node.
• To view the job's missing conditions, resources, hosts, users, and workloads, select the Waiting
Info , and do any of the following:
a. To apply conditions, see Applying/adding conditions to waiting jobs (on page 241).
b. To view the predecessor jobs that are on the job Critical path and have not yet completed OK,
click Enhanced Path.
• Select Script to view the job's script as described in Analyzing a script (on page 241).
• Select Log to view the job's event time, code and message.
• Select Belongs to, to view what service and Workload Policy the job belongs. For more
information on services, see Analyzing what service the job belongs to (on page 243).
• Select Output to view the job's output, as described in Analyzing Output of an active job (on
page 242).
• Select Statistics to view the latest statistics of the job's run times.
• Select Documentation to view a job description that is saved in a defined location. The
Documentation area in the Properties pane includes information about where to find the
description..

Viewing status summary


This procedure describes how to view the status summary of jobs, which enables you to view the
summary of all jobs and folders.

 To view status summary:


 From the Viewpoint, select a level in the hierarchy, such as a specific Control-Application or status,
where the jobs and folders reside.
The Status Summary pie chart appears in the right pane. For more information on job statuses, see
Active Job statuses (on page 240).

239
Control-M User Guide

Active Job statuses


The following table lists the job statuses and their descriptions.

Status Description

Job ended OK

Job ended not OK

Job waiting user

Job waiting resource

Job waiting host

Job waiting workload

Job waiting condition

Job is executing

Job's status is unknown

Run time estimation information


The following table lists the job run time estimation information:

Icon Description

No previous time statistics exist for the job. The job is waiting
for BIM's calculations.

Estimation based on BIM's calculation or statistics.

Job start time based on BIM statistics has passed and the job
did not run.

Estimation based on statistics of the average run time that is


displayed on the job.

240
Control-M User Guide

Analyzing a script
This procedure describes how to view a script or command, which enables you to view the job’s JCL or
job script statements.
 To view script:
1. In the Viewpoint, click on the job you want to view.
The properties of the job are displayed in the Job Analysis pane on the right.
2. Click the Script tab.
The script appears in the text box.
3. To verify the JCL code of a z/OS job, see Verifying JCL code in an active job (on page 241).
4. In the Find field, type a specific word to search from in the script.
5. From the Font size list, select a font size to view the script.

Verifying JCL code in an active job


This procedure describes how to verify JCL code in an active z/OS job, which enables you to view and
correct JCL code such as missing field values or other errors before re-running the job.

 To verify JCL code in an active job:


1. In the Viewpoint, click on the job you want to view.
The properties of the job are displayed in the Job Analysis pane on the right.
2. Click the Script tab.
The JCL code appears in the text box.

3. Click
The JCL Verification Report appears in the Results pane.
For more information about JCL Verify, see Control-M/JCL Verify User Guide.
For more information about enabling the JCL Verify feature, contact your Control-M Administrator.

Applying/adding conditions to waiting jobs


This procedure describes how to apply and add conditions to waiting jobs, which enables you to
apply/add conditions that the job is waiting for to execute.

Before you begin


Before you apply/add the missing conditions, analyze the information as described in Projection (on page
265).

 To apply/add conditions to waiting jobs:


1. In the Viewpoint, click the job you want to view.
The properties of the job appear in the Job Analysis pane on the right.

241
Control-M User Guide

2. Click Waiting Info.


The Waiting Info data appears.
3. Do one of the following:
• Click Apply All to apply all the missing conditions.
• Click Add to apply individual conditions.
The conditions are added to the Active Conditions list.

Finding the Enhanced Path


This procedure describes how to find the enhanced path showing the predecessor jobs that are on the job
Critical path and have not yet completed OK. This enables you to analyze the job that is waiting to
execute.

Before you begin


Ensure that the job that you select, has the Waiting Info tab in the Properties pane enabled.

 To find the Enhanced Path:


1. In the Viewpoint, click on the job you want to view.
The Analysis of the job are displayed in the Job Properties pane on the right.
2. Click Waiting Info.
The Waiting Info data appears.
3. Click Enhanced Path.
The oldest Predecessor job that did not complete or did not complete OK appears as links.
4. Click Select all jobs.
All the predecessor jobs that did not complete or did not complete OK appear, and are selected in the
Tree View and the Main pane.
5. To view each job, click the link.
The job is selected, and the Analysis pane appears.

Analyzing Output of an active job


This procedure describes how to view Output of a job.

 To analyze Output of an active job:


1. In the Viewpoint, click on the job you want to view.
The properties of the job are displayed in the Job Analysis pane on the right.
2. Click Output.
The Output information appear.
3. Select a date to view Output from the list, or click Show Latest to view the latest Output.
4. In the Find field, type a word or phrase to search for in the Output.

242
Control-M User Guide

5. From the Font size list, select a font size for the Output text.

Analyzing what service the job belongs to


This procedure describes how to view what service and Workload Policy the job belongs to.

 To analyze what service the job belongs to:


1. In the Viewpoint, click the job you want to view.
The properties of the job are displayed in the Job Analysis pane on the right.
2. Click Belongs To.
The relevant service and workload policy information appears.
3. Do one or more of the following:

• To locate the job in the Viewpoint, click .

• To view the service's definitions, click . You can also click Modify Job to update the service
definitions. For more information, see Batch Impact Manager job parameters (on page 108).

• To open the Service Viewpoint, click . For more information, see Business Service Analysis
Viewpoint.

• To open the Service Monitor, click . For more information, see Service Monitor (on page 268).
• To view the Workload policy, in the Workload Policy Name field, type the name of the
Workload Policy definition. For more information on Workload Policies, see Workload Policy
Definition (on page 377).

Modifying a job in Monitoring


This procedure describes how to modify a job in the Monitoring domain. When a job processing definition
is ordered (through New Day processing or manually), a modified copy of the original definition is placed
in the active jobs database. To analyze jobs and manage job flows, you can display and modify the
processing details of the job.

 To modify a job in Monitoring:


1. Double-click the job you want to modify.
The job properties window appears.
2. Click Modify Job to update the job's parameters. For more information, see Job definition.
3. Click Save.
The job is updated.

Job actions
Job actions enable you to intervene manually when special critical processes, and potentially problematic
situations arise.

243
Control-M User Guide

You can perform the following actions on jobs displayed in the Viewpoint:

244
Control-M User Guide

Action Description

Rerunning a job (on page 246) Reruns the job.

Holding a job (on page 246) Holds (stop processing) the job.
If the job has not started to execute, Hold prevents it from
executing even after all submission criteria are satisfied.
If the job is executing, Hold does not stop its execution but the
job maintains its Executing status until the job is freed.
If the job has completed executing, while Held, it must be freed
before you can rerun it again.
The job remains in the Held state until you release it using the
Free option.

Releasing a job (on page 246) Frees (resume the processing of) the job. If you held a job, you
must free it before processing can resume.

Running a job now (on page Enables the job to ignore its prerequisites and run immediately.
247)

Restarting a job (on page 250) Restarts the job using Control-M/Restart from a specific state.
(z/OS only).

Killing a job (on page 250) Terminates the job and its associated processes. Killing a specific
instance of a cyclic job does not affect subsequent runs of that
job.

Setting a job to OK (on page Changes the job’s status to Ended OK. Available for jobs with a
250) status of Ended Not OK or for jobs in a Wait status (such as Wait
Time or Wait Cond) or changes the job status to Ended OK
without performing the post-processing actions of the job.
For jobs running under Control-M for z/OS, set Job to OK always
performs post- processing,regardless of the default setting in the
CTMPARM member.

Confirming a job (on page 250) Confirms that Control-M should process a job that requires manual
confirmation (that is, the job has a Wait User (pink) status).

Reactivating a job (on page 251) Reactivates post processing for the selected job. [z/OS only].

Deleting a job (on page 251) Deletes the job. This action does not physically delete the job; it
only changes the job status to Deleted. The job remains visible in
the active jobs database until the next cleanup of the active jobs
database by the New Day procedure or manual request. Until
then, you can restore the job.

245
Control-M User Guide

Action Description

Recovering a job (on page 251) Recovers a job that still appears in the Active Jobs database by
changing the status of the job.

Activating external programs (on Starts external programs with selected job information. External
page 252) programs are configured in the File>Options>External Programs
dialog box.

Ordering jobs (on page 87) Enables you to manually order jobs and folders from the Viewpoint
tab.

To perform job actions, you must have appropriate authorizations in Control-M/EM and the relevant
Control-M/Server.

Rerunning a job
This procedure describes how to re-run a job.

 To rerun a job:
1. Select the job you want to re-run.
2. From the Viewpoint tab, in the Job group, click Rerun.
A confirmation message appears.
3. Click Yes.
The job is rerun.

Holding a job
This procedure describes how to hold a job, which stops the job from Control-M processing and enables
you to update the job.
 To hold a job:
1. Select the job you want to hold.
2. From the Viewpoint tab, in the Job group, click Hold.
A confirmation message appears.
3. Click Yes.
The job is held.

Releasing a job
This procedure describes how to free a job from a Hold state, which enables the job to run.

 To release a job:
1. Select the job you want to release.

246
Control-M User Guide

2. From the Viewpoint tab, in the Job group, click Free.


A confirmation message appears.
3. Click Yes.
The job is released.

Running a job now


This procedure describes how to run a job now, which enables you to override all prerequisites of the job
for the current run, skip the job, or select specific submission criteria.
 To run a job now:
1. Select the job you want to run now.
2. From the Viewpoint tab, in the Job group, click Run Now.
3. Do one of the following:
• To run the job and override all prerequisites of the job, do the following:
a. Select Run Now.
b. In the Confirmation message, click Yes.
The job is submitted.
• To skip the job, and continue the flow that is running, do the following:
c. Select Skip Job.
d. In the Confirmation message, click Yes.
The running flow runs without the submitting the job.
• To set specific bypass submission criteria, do the following:
e. Select Select Bypass Options.
f. In the Run Now Job dialog box, select the specific submission criteria to bypass, as
described Run Now Bypass options (on page 248).
The Run as Dummy Job field, defines how to run the job. It is actually bypassing the
defined command or script that is defined in the What area.
g. In the Run Now Job dialog box, click Ok.
h. In the Confirmation message, click Yes.
The job is submitted.

247
Control-M User Guide

Run Now Bypass options


This table lists the Run Now Bypass options that appear when you select the Select option.

248
Control-M User Guide

Option Description

Time Limits Runs the job regardless of the Time From, Time Until and Next
Time parameter values.
NOTE: The Time Limits bypass does not include the Time zone
parameter. That means that jobs that are waiting for a specific
date will still wait for that date, even if the Time Limit bypass is
checked.

In Conditions Runs the job even if In conditions are not satisfied.

Quantitative Resources Runs the job regardless of whether Quantitative Resources


specified in the job are available in the active list.
NOTE: The Quantitative resource bypass also ignores the
quantitative resource restrictions in the workload entities that the
job belongs to.

Control Resources Runs the job regardless of whether the Control Resources
specified in the job are available in the active list.

Workload Policy and Host Runs the job regardless of the restrictions set by the workload
Restrictions entities.
NOTE: Workload Hosts Mapping rules enforced on jobs with the
Active policy, are not bypassed.

Scheduling Environment (z/OS Runs the job regardless of the job’s SCHENV statement.
only)

Pipes (z/OS only) Runs the job regardless of whether other jobs using the same Pipe
as that specified in the definition of this job, are ready to run.

Quiesce (z/OS only) Runs the job even if Control-M is in Quiesce mode, either as a
result of QUIESTIME or QUIESQRES commands.

Run as Dummy Job Runs the job as a Dummy job when the pre-submission criteria of
the job are satisfied, and the job status should change to ENDED
OK, and only the job post-processing actions in the job should be
performed.

Post processing Runs the job without performing any of the job post-processing
actions, including On/Do actions, Out conditions, Notifications
OK/NOTOK and Output handling.
NOTE: When ordering (ignoring scheduling criteria), a job that is
set with Post Processing bypass, the job will End OK and will not
perform the post processing actions.

249
Control-M User Guide

Restarting a job
This procedure describes how to restart a Control-M for z/OS job from a specific state.

 To restart a job:
1. Select the Control-M for z/OS job you want to restart.
2. From the Viewpoint tab, in the Job group, click Restart.
The Restart job dialog box appears.
3. For each field, type the required value, as described in Restart job parameters.
4. Click Yes.
The Control-M for z/OS job restarts.

Killing a job
This procedure describes how to terminate a job, which cancels a job from running in the middle of the
execution.

 To kill a job:
1. Select the job you want to kill.
2. From the Viewpoint tab, in the Job group, click Kill.
A confirmation message appears.
3. Click Yes.
The job is killed.

Setting a job to OK
This procedure describes how to set a job to end OK, which overrides any defined scheduling criteria and
sends the job to the active job environment.

 To set a job to OK:


1. Select the job you want to set as OK.
2. From the Viewpoint tab, in the Job group, click Set to OK.
A confirmation message appears.
3. Click Yes.
The job is set to OK.

Confirming a job
This procedure describes how to confirm a job that is waiting for confirmation, which enables the job to
continue running. If the job is not defined to request user confirmation, you do not need to do this
procedure.

250
Control-M User Guide

 To confirm a job:
1. Select the job you want to confirm
2. From the Viewpoint tab, in the Job group, click Confirm.
A confirmation message appears.
3. Click Yes.
The job is confirmed

Reactivating a job
Thia procedure describes how to reactivate a job, which enables you to reactivate post processing for the
selected job.

 To reactivate a job:
1. Select the job you want to reactivate.
2. From the Viewpoint tab, in the Job group, click React.
A confirmation message appears.
3. Click Yes.
The job is reactivated.

Deleting a job
This procedure describes how to delete a job, which enables you to change the job status to deleted.
 To delete a job:
1. Select the job you want to delete.
2. From the Viewpoint tab, in the Job group, click Delete.
A confirmation message appears.
3. Click Yes.
The job is deleted.

Recovering a job
This procedure describes how to recover a job that still appears in the Active Jobs database.

 To recover a job:
1. Select the job you want to recover.
From the Viewpoint tab, in the Job group, click Undelete.
A confirmation message appears.
2. Click Yes.
The job's status is changed and is no longer a deleted job.

251
Control-M User Guide

Activating external programs


This procedure describes how to activate external programs, which enables you to you to insert job
processing parameters from a Control-M job or folder into a command line used to activate a third-party
program.

Before you begin


Ensure that you have defined an external program, as described in External Programs settings (on page
41).

 To activate external programs:


1. Select the job you want to activate an external program.
2. From the Viewpoint tab, in the Job group, select an external program from the External Program
drop-down list.

Searching for archived data of a job


This procedure describes how to search for archived log and output versions of the selected job.
For more information about Control-M Workload Archiving, see Control-M Workload Archiving (on page
283).

 To search for archived data of a job:


1. Select the job that you want to perform an archive search.
2. Right-click the job and select More Analysis Windows > Workload Archiving.
A confirmation message appears.
3. Click Yes.
The archive search results appear in the History domain in an Archive Search tab.

Analysis Viewpoint
The Analysis Viewpoint enables you to focus on different entities of all job types. There are two Viewpoint
modes:

252
Control-M User Guide

 Business Service Analysis Viewpoint: The Business Service Analysis Viewpoint enables you to
focus on one particular service. All the jobs of the service are displayed in the Viewpoint, together
with additional information related to the BMC Batch Impact Manager (BIM) analysis. This information
helps you understand how BMC Batch Impact Manager determines which services are running late or
failing. With this information you can further, analyze the results and better deal with the problem.
For more information see Accessing the Business Service Analysis Viewpoint for a specific service (on
page 254).
 General Analysis Viewpoint: The General Analysis Viewpoint enables you to focus in on one
particular job and all other jobs related to that selected job, by creating a dummy BIM service, or to
focus in on a specific application, sub-application, folder, or SMART folder and all related jobs. All the
relevant jobs are displayed in the Analysis Viewpoint together with additional information related to
the BMC Batch Impact Manager (BIM) analysis. This information helps you see the job estimated run
times, understand the critical path (most important jobs), and understand when the latest job in the
selection will end. With this information you can further analyze the results and better understand the
running process. For more information see Accessing the General Analysis Viewpoint (on page 262).
The enhanced Viewpoint enables you to do the following:
 Active Job analysis (on page 237): Enables you to analyze jobs and manage job flows, you can
display and modify the processing details of jobs in the Monitoring domain. You can also modify
certain details for a job run.
 Job actions (on page 243): Enables you to intervene manually when special critical processes, and
potentially problematic situations arise.
 Service analysis (on page 269): (BIM only) Enables you to analyze services and manage service flows,
by viewing problematic jobs, view service logs, properties, and Remedy tickets.
 Apply a projection (on page 266): Enables you to simulate the job status, so you can get specific
information about missing prerequisites or unavailable resources. You can ensure that you add more
resources or satisfy the prerequisite, or manually add in the Waiting Info tab, as described in
Applying/adding conditions to waiting jobs (on page 241).
 Jobs search (on page 205): Enables you to find jobs and services with specific filters.
 Edit Forecast/BIM rule (on page 295): (BIM only) Enables you to edit exceptions that affect the
expected job run times.
 Editing a Service Assumption (on page 277): (BIM only) Enables you to edit exceptions that affect
the expected job run times of a specific service.
In addition, the Viewpoint contains the following views:

253
Control-M User Guide

 Service Monitor - Live: (BIM only) Displays current information about the analyzed service and a
summary of the services in the enterprise. When What-Ifs are added, the Business Services - Live
area shows the impact of the What-Ifs on the simulation. For more information, see Service Monitor -
live parameters (on page 263).
 Analysis Viewpoint Information: Displays current information about the selected entity and a
summary of the related entities in the enterprise. For more information, see Analysis Viewpoint
Information (on page 263).
 Dashboard: Displays a mini-dashboard with job information and buttons for frequently used service
actions. For more information, see Analysis Viewpoint Dashboard parameters (on page 264).
 Business Services What-If Scenario: (BIM only) Enables you to simulate actions that can resolve
service problems and analyze their impact on the active environment, before actually executing them.
For more information, see Create a What-if scenario (on page 255).
To access the Analysis Viewpoint, see Accessing the General Analysis Viewpoint (on page 262).
For more information on viewing services from the Control-M Self Service web interface, see Control-M
Self Service.

Accessing the Business Service Analysis Viewpoint for a specific service


This procedure describes how to access the Business Service Analysis Viewpoint, which enables you to
monitor and analyze a specific service.

 To access the Business Service Analysis Viewpoint for a specific service:


1. From the Tools domain, select Service Monitor.
The Service Monitor appears.

2. From the Service Monitor tab, select .


The Business Service Analysis Viewpoint appears.
3. Do one or more of the following:
• Click Business Services to view Service Monitor - Live, Business Service Dashboard, and What-If
Scenario. For more information, see Business Service Analysis Viewpoint.
• Click Details to display the jobs with additional analysis information. For more information, see
Service Monitor (on page 268).

What-If scenario simulation


A What-If scenario is a set of events that you can add to the scenario to simulate actions that can resolve
service problems and analyze their impact on the active jobs, before execution begins. Each individual
potential change is called a What-If. For example, you can use individual What-Ifs to simulate the effects
of skipping a job or changing the time frame of a job.
You can add What-If, as described in Adding a What-if event (on page 255). When you add a What-If,
the Business Service Analysis Viewpoint displays the effect automatically.

254
Control-M User Guide

To emphasize that you are working with simulated jobs and not active jobs, the background color of the
flow diagram in the Business Service Analysis Viewpoint differs from the color in the Monitoring domain
Viewpoint. By default, the color is light blue. You can configure it to a different background color, as
described in Customizing your default settings in the Workload Automation client (on page 29). The
simulated color background is displayed only if the Business Services What-If Scenario window contains
What-Ifs. If all What-Ifs are deleted or disabled, the background color reverts back to the active
background color.

Adding a What-if event


This procedure describes how to add a What-If event to a scenario, which enables you to simulate actions
that can resolve service problems, and analyze their impact on the active jobs, before actually executing
them.
 To add a What-if event:
1. From the Monitoring domain, access the Business Services Viewpoint, as described in Accessing the
Business Service Analysis Viewpoint (on page 254).
2. In the Business Services tab in the right pane, click What-If Scenario.
The What-If Scenarios icons appear.

3. Click , and select the type of What-If.


The specific What-If <type> dialog box appears, as described in What-If scenario options (on page
256).
4. Set the What-If fields, as described in What-If scenario options (on page 256).
The What-If appears, and is enabled, and the Business Service Analysis Viewpoint background color
changes to blue to indicate that this is in simulation mode.
5. Do one or more of the following:
• To analyze the service, see Service analysis (on page 269).
• To perform actions on the jobs in the Viewpoint, click the Viewpoint tab, and preform the action,
as described in Job actions (on page 243).
• To disable, the What-If, clear the check box next to the What-If.

• To disable or enable all the What-Ifs, click .


The Viewpoint appears without the background color.

255
Control-M User Guide

What-If scenario options


The following table describes the What-if event options:

What-If options Description

Quantitative Resource rule (on Enables you to update the maximum value of quantitative
page 297) resources for a What-If event.

Job Run Time rule (on page 298) Enables you to update the run time by changing the percentage or
the run time, or by setting the time for a What-If event.

Time Frame rule (on page 258) Enables you to change the time frame for a What-If event.

Condition rule (on page 301) Enables you to define a specific time for adding a condition or a
group of conditions to the Condition table in a What-If event.
A Manual Condition Event occurs when a job depends on a
condition that does not apply to other jobs and has not been
added to the Condition table previously.

Force OK rule (on page 259) Enables you to set a job to OK in a What-If event.

Confirmation rule (on page 302) Enables you to define a time for the job's confirmation, increasing
the accuracy of the calculation of a What-If event.
Confirmation rules affect the entire calculation. If a job waiting for
a confirmation is connected to more than one service, any defined
exception affects all services depending on it.

Job Priority rule (on page 260) Enables you to update the Job Priority for a What-If event.

Skip Job rule (on page 261) Enables you to Skip a Job for a What-If event.

Host rule (on page 262) Enables you to define the planned downtime of a Control-M Server
or specified host/host group in a What-If event.

Deleting a What-If from a scenario


This procedure describes how to delete a What-If from a scenario, which enables you to modify the
simulate actions that can resolve service problems.
 To delete a What-If from a scenario:
1. From the Monitoring domain, access the Business Services Viewpoint, as described in Accessing the
Business Service Analysis Viewpoint (on page 254).
2. In the Business Services tab in the right pane, click What-If Scenario.
The What-If Scenarios icons appear.

256
Control-M User Guide

3. Select the What-If to delete.

4. Click .
5. In the Delete confirmation message, click Yes.
The selected What-If is deleted.

257
Control-M User Guide

Time Frame rule


The following table describes the Time Frame rules, which affect the calculation of the all services
depending on it, by adjusting the job submission time frame:

Field Description

Update Time Frame

Submit between Defines the time frame for submitting the job.

Shift time frame Defines how to shift the time frame for submitting the time.

Ignore time frame Defines if time frame is ignored.

For all jobs meeting the following criteria

Control-M Name of the Control-M whose jobs will be included in this exception
definition.

Application Name of the application whose jobs are included in this exception
definition.

Sub Application Name of the Sub Application whose jobs are included in this exception
definition.

Job Name Name of the job that is included in this exception definition.*

Mem Name Name of the member name (for z/OS) that is included in this
exception definition.

Mem Lib Name of the member library (for z/OS) whose jobs is included in this
exception definition.

Folder Name of the container into which job processing definitions are
organized.

Folder Lib Name of the library that contains the job’s folder.

Host ID Name of a host computer to which a job was submitted.

Run as Identifies the user name for whom the job is executed.

Created by Indicates the Control-M user who defined the job.

258
Control-M User Guide

Force OK rule
The following table describes the Force OK rule, which adjust the status, and affects the calculation of the
all services depending on it:

Field Description

For all jobs meeting the following criteria:

Control-M Name of the Control-M whose jobs will be included in this exception
definition.

Application Name of the application whose jobs are included in this exception
definition.

Sub Application Name of the Sub Application whose jobs are included in this exception
definition.

Job Name Name of the job that is included in this exception definition.*

Mem Name Name of the member name (for z/OS) that is included in this
exception definition.

Mem Lib Name of the member library (for z/OS) whose jobs is included in this
exception definition.

Folder Name of the container into which job processing definitions are
organized.

Folder Lib Name of the library that contains the job’s folder.

Host ID Name of a host computer to which a job was submitted.

Run as Identifies the user name for whom the job is executed.

Created by Indicates the Control-M user who defined the job.

Calendar details (click Advanced) Applies to Service Assumption

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more periods for this exception definition, which can
be selected from a list. Special month rules are not supported.

259
Control-M User Guide

Job Priority rule


The following table describes the Job Priority rules, by specifying the priority of a job, and its critical flag.
This can change the priority of a job, which affects the calculation of the all services depending on it:

Field Description

Update Job Priority

Update Priority Defines the priority of a job.

Update Critical Defines the critical flag of a job

For all jobs meeting the following criteria:

Control-M Name of the Control-M whose jobs will be included in this exception
definition.

Application Name of the application whose jobs are included in this exception
definition.

Sub Application Name of the Sub Application whose jobs are included in this exception
definition.

Job Name Name of the job that is included in this exception definition.*

Mem Name Name of the member name (for z/OS) that is included in this
exception definition.

Mem Lib Name of the member library (for z/OS) whose jobs is included in this
exception definition.

Folder Name of the container into which job processing definitions are
organized.

Folder Lib Name of the library that contains the job’s folder.

Host ID Name of a host computer to which a job was submitted.

Run as Identifies the user name for whom the job is executed.

Created by Indicates the Control-M user who defined the job.

Calendar details (click Advanced) Applies to Service Assumption

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more periods for this exception definition, which can
be selected from a list. Special month rules are not supported.

260
Control-M User Guide

Skip Job rule


The following table describes the Skip Job rules, and the job waits for its prerequisite conditions only, and
then finish immediately. This affects the calculation of the all services depending on it:

Field Description

For all jobs meeting the following criteria:

Control-M Name of the Control-M whose jobs will be included in this exception
definition.

Application Name of the application whose jobs are included in this exception
definition.

Sub Application Name of the Sub Application whose jobs are included in this exception
definition.

Job Name Name of the job that is included in this exception definition.*

Mem Name Name of the member name (for z/OS) that is included in this
exception definition.

Mem Lib Name of the member library (for z/OS) whose jobs is included in this
exception definition.

Folder Name of the container into which job processing definitions are
organized.

Folder Lib Name of the library that contains the job’s folder.

Host ID Name of a host computer to which a job was submitted.

Run as Identifies the user name for whom the job is executed.

Created by Indicates the Control-M user who defined the job.

Calendar details (click Advanced) Applies to Service Assumption

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more periods for this exception definition, which can
be selected from a list. Special month rules are not supported.

261
Control-M User Guide

Host rule
The following table describes the Host rule. The parameters can be defined to simulate a job that runs
during a planned downtime of a Control-M Server or specified host/host group. This enables you to better
plan for possible downtime of servers when defining your job flows.

Parameter Description

Control-M Server Defines the name of the Control-M Server that participates in the
simulation of the What-If Host scenario.
NOTE: If the none option is selected, the simulation takes into
account all Control-M Servers defined.

Host/Host Group Defines the name of the host/host group to shut down.
NOTE: If none or the Select All option is selected, the simulation
takes into account all host/host groups defined.

From: Defines the start of the downtime.


New Day Time/Time

Until: Defines the end of the downtime.


End of Simulation Time/Time

Calendar details (click Advanced) Applies to Service Assumption

Calendar Details of the Control-M and calendar to be used to schedule the


job.

Period Name of one or more periods for this exception definition, which
can be selected from a list. Special month rules are not supported.

Accessing the General Analysis Viewpoint


This procedure describes how to access the Analysis Viewpoint.
 To access the General Analysis Viewpoint:
1. In the Viewpoint, click on the entity you want to view, such as a single job, sub-application, folder or
SMART folder.
The properties of the selected entity are displayed in the Job Analysis pane on the right.
2. From the Analysis tab, click Open Analysis Viewpoint.
The Analysis Viewpoint is displayed according to the entity you selected.

262
Control-M User Guide

Analysis Viewpoint Information


This table lists the Service Monitor-Live parameters that appear in the Business Service Analysis
Viewpoint.

Parameter Description

Analysis Entity The name of the entity

Entity Type The type of entity


Job or Folder

Estimate To Completion Estimated end time. HH:MM:SS MM:DD GMT+/-HH:MM

Service Monitor - live parameters


This table lists the Service Monitor-Live parameters that appear in the Business Service Analysis
Viewpoint.

Parameter Description

Service Name The name of the service.

Service Status The status of the service, for more information, see Active Job
statuses (on page 240)

Estimate To Completion Estimated end time. HH:MM:SS MM:DD GMT+/-HH:MM

Deadline Time by which the service must complete to be considered not


late

Late Job/Fail Number of late services or services with job failures

On Time Number of services on time

Completed Late Number of services completed late

263
Control-M User Guide

Analysis Viewpoint Dashboard parameters


This table lists the Business Service Dashboard parameters that appear in the Business Service Analysis
Viewpoint.

Parameters Description

Total jobs in Service The number of jobs in the service.

Jobs in Critical Path The number of jobs in Critical Path.

Without Statistics The number of jobs without statistic information.

Jobs with Time-Gap The number of jobs that have a time difference between an
estimated job start time and the time when all of its predecessors
are finished.
Since a job with a time-gap is not predicted to start immediately
after its predecessor jobs have completed, it is possible to re-
schedule the job to start earlier than its original scheduled time.
The best practice is to begin by adjusting the start time of the first
job with a time-gap in the critical path, thereby allowing the
service to end earlier.

Jobs with Assumption The number of jobs with service assumptions. For more
information, see Editing a Service Assumption (on page 277).

Error The number of jobs with an error/Problematic Job.

Warning The number of jobs with a warning/Problematic Job.

Total Time Gap in Critical Path The total gap in time in Critical Path.

264
Control-M User Guide

Analysis Viewpoint BIM options


The following table describes the options when selecting Open Analysis Viewpoint (BIM) from the
Analysis tab in the Monitoring domain.

Name Icon Description

Filter Critical Path Enables you to switch between filtering according to Critical Path
between two jobs, and All Jobs filter.

Find Latest Time Gap Enables you to find the latest time difference between an estimated job
start time and the time when all of the predecessor jobs are finished.

Highlight Time Gaps (BIM Monitoring domain only) Enables you to find the jobs with a time
difference between the estimated job start time and the time when all
of the predecessor jobs are finished.

Projection
A Projection provides detailed information that is gathered by the BMC Batch Impact Manager (BIM)
about why jobs are estimated to run as displayed on the job hosts. The details can be obtained for a
specific job or a number of jobs based on the Active jobs. The Projection window shows the last
constraint that prevents the selected job from running, in addition to the start and end times of the job.
This enables you to determine how to start jobs earlier so that services can complete on time. The
Projection window is available for any job (even jobs that do not belong to services) and from any
Viewpoint (not just the Business Analysis viewpoint).
A projection can provide some of the following additional information:
 Job is waiting for a quantitative resource
 Job is waiting for a condition
 Job waiting for confirmation
If the projection is of a job related to a service, you can do a projection from a Business Service Analysis
Viewpoint to view the following information:
 Job status information- if the job is in warning state - if the job already ran, and the job status is
either Job ended too quickly or Job ran too late, as described in Service Status Details (on page
276).
 Job is problematic - if the job failed or the job causes the service to be late, as described in Analyzing
problematic jobs (on page 274).
 You can apply a projection, as described in Applying a projection (on page 266).
In the Projection window and Service Monitor, the word Simulation Mode is added to indicate that
the impact of the What-Ifs is in effect.

265
Control-M User Guide

Applying a projection
This procedure describes how to apply a projections, which enables you to view what has affected the
running time of a job.
 To apply a projection:
1. In the Monitoring domain, select a job.

2. In the Viewpoint tab, click .


The Projection <job name> window appears, and the status appears in the right side.

3. To view available status information that does not appear, click in one or more of the following:
• Missing conditions
• Missing quantitative resources
The information is provided by Control-M Batch Impact Manager, and you can analyze further, as
described in Analyzing active jobs (on page 238), or intervene, as described in Job actions (on page
243).
4. To simulate a potential change, click Add What-if, and select an option, as described in What-If
scenario options (on page 256).
The effect of the What-if scenario appears automatically in the Business Service Analysis Viewpoint,
as described in Adding a What-if event (on page 255).
5. In the Projections <job name> window, click Close.
The Projection is complete, and you can apply the changes to the active jobs, if the changes enabled
the simulated jobs to end OK and the services to complete on time.

Critical Path
The critical path consists of the jobs in a Business Service that have the most impact on the completion
time of the service. The critical path is indicated in the flow diagram by special markings on the job hosts.
You can search for the jobs in the critical path, as described in Finding jobs in the critical path (on page
266).

Finding jobs in the critical path


This procedure describes how to find the dependent jobs in the longest path for a series of jobs.
 To find jobs in the critical path:
1. In a Control-M Workload Automation Viewpoint, Analysis tab, select .
The Critical Path fields appear at the top of the Map view.
2. In the flow diagram, expand all jobs between the first and last jobs in the dependent group of jobs.
The last is a descendant of the first job, but not immediately below it.
3. Select the first job and then select the last jobs while clicking the CTRL key.
The first and last jobs are both selected.

266
Control-M User Guide

4. Set the Use and Overlapping Tolerance fields, as described in Critical Path fields (on page 267).

5. Click .
The results of the search appear in the Results area at the bottom of the Map view area. The tab
has the name based on the path, the first and last node names, the number of nodes and the
average or last run time. You can then view it highlighted in the flow diagram, Gantt view, or List
view.

Critical Path fields


The following table describes the Use fields of the Critical Path search:

Use Description

Use The following options can be selected:


 Average Run Time: Defines the Average time (in hhmmss
format) for the job to run, based on the last successful runs of
the job.
 Last Run Time: Defines the time (in hhmmss format) for the
job to run, based on the last successful run of the job.

Overlapping Tolerance The following options can be set when Use is set to Last Run
Time:
 Overlapping Tolerance check box: Defines whether to
take into account the maximum time of the end of one job
can overlap with the start of the next job. For jobs with no
statistics, the expected run time is 0 and does not affect the
critical path calculation.
If the check box is not selected, then the overlapping
tolerance is not taken into account in the critical path
calculation.
 Overlapping Tolerance: Defines the maximum time of the
end of one job can overlap with the start of the next job. For
jobs with no statistics, the expected run time is 0 and does
not affect the critical path calculation.

Alerts Monitor
An alert is a message that indicates that a problem or exception has occurred for a job or SMART Folder.
The Alerts Monitor enables you to manage and monitor alerts and indicate each alert's status, severity,
and add notes to alerts.
Alerts can originate from the following:

267
Control-M User Guide

 Notification facility: A job or SMART Folder processing definition can include instructions in the
Notify parameter to send a message to the Alerts window.
 Jobs ending not OK: The AlertOnAbend and DownCreAlerts system parameters, can
automatically generate alerts when a job terminates with an Ended Not OK status.
 A communication breakdown (for example, between Control-M/Server and Control-M/EM) generates
an alert.
 Batch Impact Manager, which can be used to relay messages of special importance.
You can only view alerts for the jobs and SMART Folders that you are authorized to view.

Managing alerts
This procedure describes how to view information about each alert, change the alerts' statuses, remove
old alerts, add notes to alerts, and set additional options to alerts.

 To manage alerts:
1. From Monitoring domain, select Alerts.
The Alerts window appears.
2. From the alerts list, select an alert.
3. From the Alerts ribbon, in the Actions group you can select one of the following:
• Read: Mark an alert as read.
• Unread: Mark an alert as unread.
• Handle: Mark an alert as viewed and handled.
• Unhandle: Mark an alert as unhandled.
4. Select Always Monitor Alerts to constantly update the alerts list.
5. In the properties pane, from the Severity field, select the alert's severity.
6. In the properties pane, in the Reported Information section, add a note in the Notes field.

Service Monitor
The Service Monitor is a tool that enables you to analyze services, and locate and resolve problematic
jobs. The Service Monitor window lists all the business services in the current forecast. This feature, which
is only available if you have Control-M Batch Impact Manager installed, enables you to identify critical
batch services that are expected to miss their deadline. For more information on the data for a service,
see Service analysis (on page 269).
For all services, you can do the following:

268
Control-M User Guide

 Accessing the Business Service Analysis Viewpoint for a specific service (on page 254): Analyze your
service from a Viewpoint in simulation mode to validate actions before committing them in
production.
 View and edit a Service Assumption (on page 277): Edit and enable exceptions that affect the
expected job run times of a specific service.
 Add a service note (on page 277): Add information about a service.
For critical batch services, the service is defined as BIM. If you have Control-M Batch Impact Manager,
you can do the following:
 Update a BIM service deadline (on page 276): Updated the deadline of a job that is going to be late.
 Locate a BIM job (on page 277): Opens in a Viewpoint and you can analyze and perform actions on
the jobs, as described in Active Job analysis (on page 237).

Service analysis
To help you analyze services and manage service flows, you can open services in a Viewpoint, view
problematic jobs, view service logs, properties, and tickets.
You can view a service's details in the following tabs:

Tab Description

General Displays the service definitions. For more information, see General
service parameters (on page 271).

Properties Displays the job's name, description, and type.

Service Log Shows information about changes in the service's status and the
reasons for the respective changes. You can select an entry and view
details for the entry, as described in Analyzing a service log (on page
273).

Problematic Jobs Shows problematic jobs in a service that have failed or ended late. For
more information, see Analyzing problematic jobs (on page 274).

Tickets Displays incidents that can be monitored by BMC Remedy IT Service


Management indicating that a critical service is problematic.

Analyzing a service
This procedure describes how to analyze a service definitions, status, problematic jobs, and service
tickets.

 To analyze a service:
1. From Monitoring domain select Service Monitor.

269
Control-M User Guide

The Service Monitor appears.


2. Do one or more of the following:
• To view the service definitions, select General . For more information, see General service
parameters (on page 271).
• To view the job's name, description, and type, select Properties.
• To view information about changes in the service's status and the reasons for the respective
changes, select Service Log. For more information, see Analyzing a service log (on page 273).
• To view problematic jobs in a service that have failed or ended late, select Problematic Jobs.
For more information, see Analyzing problematic jobs (on page 274).
• To view incidents that can be monitored by BMC Remedy IT Service Management indicating that
a critical service is problematic, select Tickets.

270
Control-M User Guide

General service parameters


The following table describes general information about the selected service.

271
Control-M User Guide

Service Information Description

Name Name of service.

BIM
Defines whether the service is a BIM service. If the icon
appears, the service is a BIM.

Description Provides a description of the service in free text. A well written


description can help you determine how the service fits into your
workflow.

Status Code Shows the graphic and code that represents the status details.

Status Details Shows the status of the service, as described in Service Status
Details (on page 276).

Deadline Determines the time when the service must complete to be


considered not late.

Note Provides specific service information. For more information, see


Adding a service note (on page 277).

Start Time Shows the timestamp when the service started to run.

Estimated End Time Shows the time when the service is estimated to stop running.

Progress Shows the progress bar the percentage of the jobs that have
completed in the service.

Total Jobs Number Total number of jobs in the service.

Jobs Completed The number of jobs completed.

Jobs Without Statistics The number of jobs without statistic information.

Priority Shows the priority level of the service.

Ordered By Shows the name of the person who ordered the service.

Order Time Shows the time the service was ordered.

272
Control-M User Guide

Service Information Description

Slack Time Shows the difference in time, in the format HH:MM, between the
due time of the service and its estimated end time.
EXAMPLE: If the service must end by 10:15 (due time), and its
estimated end time is 10:05, its slack time is 10
minutes.
This information, together with the service priority level, can help
you decide which problems are most urgent.

Last Status Update Shows the last time the status was updated.

Avg Completion Time Shows the time Batch Impact Manager estimates that the service
will complete. This calculation is based on existing Control-M
average run time statistics or exceptions.

Problematic Jobs Shows the ID number and the Job name of the problematic jobs.

NOTE: If a job is associated with a Workload and the Workload has limitations defined for quantitative
resources, then a line is displayed in the Status pane indicating this submission criteria and its status.

Analyzing a service log


This procedure describes how to analyze a service log.

 To analyze a service log:


1. From Monitoring domain select Service Monitor.
The Service Monitor appears.
2. Select a service.
The service analysis information appears on the right pane.
3. To find the service log, select the Service Log tab.
The log entries appear, as described in Service Log parameters (on page 274).
4. To view problematic jobs related to the service, do the following:

a. Select a row, and click .


The Problematic Jobs window appears.
b. Click the Problematic Jobs tab. For more information on problematic jobs, see Problematic Jobs
parameters (on page 275).
5. To view the Remedy tickets related to the service, do the following:

a. Select a row, and click .


The Problematic Jobs window appears.
b. Click the Tickets tab.

273
Control-M User Guide

Service Log parameters


The following table describes the activity parameters of the service:

Parameter Description

Date and Time Shows the timestamp of the service activity.

From Status Shows the previous status of the service.

To Status Shows the current status of the service.

Information Status Determines if jobs appear depending on the check box


selection. If you select the check mark, then it show jobs
with information status.

Problematic Jobs Shows the ID number and the Job name of the problematic
jobs.

Analyzing problematic jobs


This procedure describes how to analyze a problematic job. This enables you to identify the jobs in a
service that are not running on time, and therefore, impact the service. You can locate the jobs, and view
them in a Business Service Analysis Viewpoint.
 To analyze problematic jobs:
1. From Monitoring domain select Service Monitor.
The Service Monitor appears.
2. Select a service.
The service analysis information appears on the right pane.
3. Select the Problematic Jobs tab.
The problematic jobs appear, as described in Problematic Jobs parameters (on page 275).
4. Select the Information Status check box to identify problematic jobs with information status.

274
Control-M User Guide

Problematic Jobs parameters


The following table describes the Problematic Jobs of the service.

Parameter Description

Information Status Determines if jobs appear depending on the check box


selection. If you select the check mark, then it show jobs
with information status.

Problematic Jobs Shows the ID number and the Job name of the problematic
jobs.

275
Control-M User Guide

Service Status Details


The following table describes the possible statuses of a service.

Status Description

OK The batch service job is not yet problematic, but not yet
running.

Completed OK The batch service job completed on time.

No jobs are Jobs related to this service were either not defined or not
available submitted.

Service is Late Either a service did not complete before the time defined in
the Must complete by field in the Batch Impact Manager
job, or the service completed OK, but the end time of the
service exceeded its Due time.

Deadline is out of Forecast cannot identify the status since the service continues
forecast scope after forecast end time.

Job ran too long The job ran longer than expected based on the expected
time.

Job finished too The job finished running earlier than the expected time.
quickly

Job Failure The job will not complete.

NOTE: If a job is associated with a Workload Policy and the Workload Policy has limitations defined for
quantitative resources, then a line appears in the Status pane indicating this submission criteria and its
status.

Updating a BIM service deadline


This procedure describes how to update a BIM service deadline from the Service Monitor.
 To update a BIM service deadline:
1. From Monitoring domain select Service Monitor.
The Service Monitor appears.
2. Select a BIM service.

The service that you select has a icon in the BIM column.
3. Click Update Deadline.

276
Control-M User Guide

The Update Service Deadline dialog box appears.

4. In the New Deadline field, type a time and click .


5. Click OK.
The BIM service deadline is updated.

Locating a BIM job


This procedure describes how to locate the BIM job in a Viewpoint.

 To locate a :BIM job:


1. From Monitoring domain select Service Monitor.
The Service Monitor appears.
2. Select a BIM service.

The service that you select has a icon in the BIM column.
3. Click Locate Job.
The BIM job is selected in the Viewpoint.

Adding a service note


This procedure describes how to add a service note.

 To add a service note:


1. From Monitoring domain select Service Monitor.
The Service Monitor appears.
2. Select any service.
3. Click Service Note.
The Update Service Note dialog box appears.
4. In the Note field, type a note.
5. Click OK.
The note is created.

Editing a Service Assumption


This procedure describes how to edit a service assumption. This enables you to update exceptions that
affect the expected job run times of a specific service.

 To edit a Service Assumption:


1. From Monitoring domain select Service Monitor.
The Service Monitor appears.

277
Control-M User Guide

2. Select a service with the Update Service Assumption icon enabled.


3. Click Service Assumptions.
The Assumptions dialog box appears.
4. Click Edit.
5. Edit the assumption for the specific service, as described in Condition rule (on page 301) and
Confirmation rule (on page 302).
You have updated the service assumption for the specific service.

Deleting a Service Assumption


This procedure describes how to delete a service assumption.

 To delete a Service Assumption:


1. From Monitoring domain select Service Monitor.
The Service Monitor appears.
2. Select a service with the Update Service Assumption icon enabled.
3. Click Service Assumptions.
The Assumptions dialog box appears.

4. Click .
The assumption for the specific service is deleted.

Control-M MFT Dashboard


The Control-M MFT Dashboard is a central viewing portal of all file transfers that were executed by File
Transfer jobs. This enables you to see the progress and details of many file transfers across multiple
platforms without having to navigate to individual jobs.
The Dashboard shows the following:
 Traffic Load: Shows the volume in GB of file transfers on each host and the number of files that
were transfered on each host.
 File Transfer Status: Shows the status of all the file transfers: Completed, In Progress, Failed,
Completed with Errors, In queue, and Canceled.
 Active Connections: Shows the transfer rate and duration of the file transfers on the source and
destination hosts.
You can filter down the Dashboard to show only transfers based on timeframe, Application, or Sub
application
The following procedures describe how to search, locate jobs, and export transfer details in the Control-M
MFT Dashboard:

278
Control-M User Guide

 Searching for a file transfer (on page 279)


 Locating a File Transfer job (on page 280)
 Exporting file transfer search results (on page 281)

Searching for a file transfer


This procedure describes how to search for a file that was transfered with Control-M MFT and view its job
properties and transfer status.
 To search for a file transfer:
1. From the Monitoring domain, click Managed File Transfer.
The Managed File Transfer tab opens.
2. Do one of the following:

3. Click the tab.


A New Search tab appears.
• To perform a quick search do the following:
a. In the Search field type the filename, application, or job name.

b. Click .
The search results appear. You can view the transfer details and the job Output in the right pane.
• To perform an Advanced search, do the following:
c. Click Advanced.
d. For each field, type or select the required value, as described in MFT Advanced search
parameters (on page 280) and then click Search.
You can use the * wildcard character for advanced searches.
EXAMPLE: ab*. You can only place the wildcard after the string.
The search results appear. You can view the transfer details and the job Output in the right pane.

279
Control-M User Guide

MFT Advanced search parameters


The following table describes MFT Advanced search parameters.

Parameter Description

File Name Defines the filename of the transfer

Status Determines the status of the transfer:


 All
 In Progress
 Completed
 Failed
 Completed with Errors

Job Name Defines the File Transfer job name that is executing the transfer

Application Defines the Application of the File Transfer job

Sub Application Defines the Sub Application of the File Transfer job

Folder Defines the Folder of the File Transfer job

Source Determines the source host of the file transfer

Destination Determines the destination host of the file transfer

Source Path Defines the location of the file transfer on the source host

Destination Path Defines the location of the file transfer on the destination host

Time Frame Determines when the files were transfered.


NOTE: You can customize this parameter.

Locating a File Transfer job


This procedure describes how to locate the job of each file transfer in the Control-M MFT Dashboard. This
enables you to perform actions on the job, such as rerunning the job or viewing the output or log. You
can also see the context of the job in the business flow.

 To locate a File Transfer job:


1. Search for a file transfer,as described in Searching for a file transfer (on page 279).
2. Select the required file, and click Locate Job.

280
Control-M User Guide

A Neighborhood Viewpoint appears that shows the File Transfer job and its job properties.

Exporting file transfer search results


This procedure describes how to export file transfer search results from the Control-M MFT Dashboard to
an Excel, HTML, csv, or text file. This provides the information you need to create an audit report or to
prove that the files were transfered to external sources.
 To export the file transfer search results:
1. Perform a search,as described in Searching for a file transfer (on page 279).
2. Click Export.
3. Browse to a location to save the file and select one of the following file types:
• Excel
• HTML
• CSV
• Text
4. Click Save.

281
5
5
History
In the History domain you can access job processing data that has been accumulated over a specific
period of time. With the ability of Control-M to archive daily job processing data, you have the capability
to reply and review job events to identify problems and potential issues as they unfold, or capture a
snapshot of your batch production job flow status from any given moment. Using this available data, you
can determine how best to eliminate these problems in the future and how to optimize your batch
processing environment.
In the History domain you can do the following:
 Set up an Archived Viewpoint to enable you to play back events in the from the History domain, as
described in Load an archived Viewpoint (on page 282).
 Filter the archived Viewpoint by filtering according to a customized view, as described in Filter the
loaded folders and jobs.
 Play back events from the archived Viewpoint, which enables you to review events from a specific
time, second by second, or from event to event, at the speed you require. For more information, see
Play back an archived event (on page 283).
 Search for archived data, as described in Control-M Workload Archiving (on page 283).
For more information about navigating in the History domain, see History domain (on page 19).
For more information about Control-M, see Getting Started.

Loading an archived Viewpoint


This procedure describes how to load an archived Viewpoint. It enables you to review events from in a
Viewpoint from a specific time, second by second, or from event to event, at the speed you require.

 To load an archived Viewpoint:


1. In the Viewpoint field, from the dropdown list, select one viewpoints you want to load.
2. Do one of the following:
• Select Yesterday to view archived viewpoints of the previous day.
• Select All Days to view all available archived viewpoints.
3. In the Sort By field, from the dropdown list, select how you wish to sort the viewpoints.
4. Do one of the following:
• If you want to filter the viewpoint do the following:
a. Select the Viewpoint and click Customizable Filter.
The Customizable Filter window appears.
b. Type any parameters as required.
For more information, see Filter parameters (on page 199).

282
Control-M User Guide

c. Click Open to load the viewpoint.


• If you do not want to filter the viewpoint click the Viewpoint to load it.
The Viewpoint appears.
5. To play back an archived viewpoint, see Playing back an archived event (on page 283).

Playing back an archived event


This procedure describes how to play back events in from the archived Viewpoint. It enables you to
review events from a specific time, second by second, or from event to event, at the speed you require.
Before you begin
Load an Archived Viewpoint, as described in Loading an archived Viewpoint (on page 282).

 To play back an archived event:


1. Select the PlayBack tab.
2. In the Play Properties group, select the play back speed by selecting the number of units and the
unit type (number of events/step).
3. From the Location group, use the slider to choose the date and time from which you want to view
events.
4. From the Controls group, do the following:
• Click Play Reverse to view the archived Viewpoint in a slide show in reverse order.
• Click Play to view the archived Viewpoint in a slide show in date or event order.
NOTE: Use any of the controls to go back, forward, view the first, previous, next or last events.

Control-M Workload Archiving


Control-M Workload Archiving is a Control-M add-on that enables you to automatically archive job log and
output data, from both Mainframe and Distributed systems, in a secure and central repository that is
separate from the production environment.
When Control-M/Server submits a job to run on an Agent, the Workload Archiving Server archives the job
log and output in a separate PostgreSQL or Oracle database for a defined period based on Workload
Archiving Policies, as described in Workload Archiving configuration. This enables you to meet
organizational audit and compliance requirements, troubleshoot your environment using historical data,
and enable/disable users from accessing the archived data based on Control-M/EM authorizations.
Control-M Workload Archiving is installed with a PostgreSQL or Oracle database. For more information,
see Control-M Workload Archiving installation.
BMC recommends that you install Control-M Workload Archiving on a dedicated server.
The following procedures describe how to search, duplicate, compare, export, and save archive data:

283
Control-M User Guide

 Searching for archive data (on page 284)


 Duplicating archive search results (on page 288)
 Comparing archived jobs (on page 288)
 Exporting archived data (on page 288)
 Saving archive data (on page 289)
Click the following image to view a short overview video about Workload Archiving.

Searching for archive data


This procedure describes how to search for job log and output archived data stored in the Control-M
Workload Archiving Server.
 To search for archive data:
1. From the History domain, in the Tools menu, select Archive Search.
The Archive Search window appears.
2. Do one of the following:
• To perform a quick search, do the following:
a. In the Search field, type the name or part of the name of the Control-M entities that contain
the jobs in your search.
b. From the drop-down list, select the Control-M entities that contain the jobs in your search.
c. From the Job Status drop-down list, search for jobs that ended OK, Not OK, or both.

d. Click .
The archived jobs appear.
EXAMPLE: You want to search for all jobs where Job Name and Application contain the number 5.
In the Search field, type 5 and from the drop-down list, select Application and Job
Name.
• To perform an advanced search, do the following:
e. Click Advanced.
The Advanced Search window opens.
f. For each field, type the required value, as described in Advanced Search parameters (on page
285).
You can use * and ? wild characters, as described in Pattern matching strings (on page 391).
g. Click Search.
The archived jobs appear.

284
Control-M User Guide

Advanced Search parameters


The following table describes Advanced Search parameters that are used in Searching for archive data (on
page 284) in Control-M and Searching for archive data in Control-M Self Service.

285
Control-M User Guide

Parameter Description

Job Name Defines the name of the job processing definition and appears in
the job definition and tracking displays, and enables you to
identify the job, and order the job.

Timeframe Searches for jobs during one of the following periods:


 All
 Last Week
 Last Month
 Last Year
 No time limit
 Custom

Output Contains Defines a string to search for in job outputs.


You must define the Job Name or Application fields to search
this field.

Log Contains Defines a string to search for in the job logs.


You must define the Job Name or Application fields to search
this field.

Job Type Determines which job types are used to search for archived data,
such as OS, or specific Application Plug-ins

Field Name Determines which fields of a specific job type are used to search
for archived data

Value Defines the value of the Field of the specific job type

Control-M Server Defines the name of the Control-M/Server (or Control-M for z/OS)
that processes the job.

Application Provides a logical name for sorting groups of jobs. This parameter
is used to supply a common descriptive name to a set of related
job groups. The jobs do not necessarily have to run at the same
time.

Sub Application Indicates the name of the Sub Application where the job belongs
logically. It is a sub-category of the Application parameter. For
example, the Application is Finances, and the Sub Application is
Payroll.

286
Control-M User Guide

Parameter Description

Folder Defines the name of the folder. In the Properties pane this
parameter indicates the folder where the job belongs.

Library Defines the name of the library. In z/OS, this parameter indicates
where the job belongs.

Member Name/File Name Indicates the name of the file that contains the job script, or for
z/OS jobs, the name of a member that contains one of the
following in relation to the job to be executed:
 The JCL of the job
 The started task procedure
 Warning messages

Member Library/File Path For non-z/OS jobs, File Path indicates the location of the file that
contains the script. For z/OS jobs, Member Library indicates the
location of the Member that contains the JCL, started task
procedure, or Warning message.

Run Where/LPAR Defines the name of a Control-M/Agent computer, remote host


computer, or host group where the job is submitted.

Belongs to Defines the name of a Control-M/Agent computer, remote host


computer, or host group where the job is submitted.

Run as Identifies the user name with the authorization to execute the job.
This parameter is used by the Control-M security mechanism.

Order ID Searches for jobs with a specific Order ID.

Job Status Determines whether to search for jobs that Ended OK, Not OK, or
both.

Order Date From-To Searches for jobs that were ordered between a defined period.

287
Control-M User Guide

Duplicating archive search results


This procedure describes how to duplicate archive search results from the current tab to another tab. This
enables you to perform another search with very similar search criteria without losing your original search
results.

 To duplicate archive search results:


1. From the History domain, in the Tools menu, select Archive Search.
The Archive Search window appears.
2. Perform a search, as described in Searching for archive data (on page 284).
3. From the Workload Archiving menu, click Duplicate.
The duplicated archive search results appear in another tab.

Comparing archived jobs


This procedure describes how to compare what was modified, added, or removed between two archived
jobs (job log and output).
 To compare archived jobs:
1. From the History domain, in the Tools menu, select Archive Search.
The Archive Search window appears.
2. Perform a search, as described in Searching for archive data (on page 284).
3. Select two jobs that you want to compare.
4. From the Workload Archiving menu, click Compare and select one of the following:
• Log
• Output
The Compare window appears highlighting the differences between the two jobs.

Exporting archived data


This procedure describes how to export archive search results that appear in Control-M to a csv file.
The exported data shows what appears in the table in the Archive window. It does not contain the
contents of the job log and output.

 To export archived data:


1. From the History domain, in the Tools menu, select Archive Search.
The Archive Search window appears.
2. Perform a search, as described in Searching for archive data (on page 284).
3. From the Workload Archiving menu, click Export.
4. Browse to a location where you want to save the csv file.
5. Click Save.

288
Control-M User Guide

The archived data is exported to the csv file.

Saving archive data


This procedure describes how to save job log and output archived data to a text file.
By default, the data is compressed when saved. To change this setting, see Advanced settings (on page
42).

 To save archive data:


1. From the History domain, in the Tools menu, select Archive Search.
The Archive Search window appears.
2. Perform a search, as described in Searching for archive data (on page 284).
3. Select the jobs that you want to save.
4. From the Workload Archiving menu, click Save and select one of the following:
• Log
• Output
• Log and Output
5. Browse to a location where you want to save the archived data, and then click Save.
The archived data is saved in the specified location.

289
6
6
Forecast
Control-M/Forecast adds forecasting capabilities to Control-M, that enable you estimate your scheduling
environment behavior with respect to specific dates in the future. Both graphic and tabular
representations of the forecast provide the future dates where a job or a folder is predicted to be
submitted. In addition, Control-M/Forecast generates an estimate of the full production flow for a future
date, as an enterprise-wide view.
Control-M/Forecast bases its projections on Control-M/Server's new day procedures and user dailies.
Control-M/Forecast analyzes folder, user daily jobs, calendars, job dependencies (in and out conditions),
time execution windows, Control-M time zone settings, resources and priorities in the Control-M/EM
database and, based on existing statistics, estimates how jobs will run on specific days.
You can use the util utility to import and export history and forecast information.
The following procedures describe how to use the Forecast domain:
 Define a Specific User Daily job (on page 292): Describes how to define specific user daily to a folder,
which enables large sites to balance their daily jobs throughout the day
 Revise job run time (on page 294): Describes how to use Forecast/BIM rules as exceptions to revise
the job run time, that is used for job calculation
 Simulate your job flow (on page 290): Describes how to simulate your job flow for a specific day by
setting up a Forecast Workspace, create What-If scenarios, and analyze the jobs and services
 Create a What-if scenario (on page 255): Describes how to examine the effects of potential changes
to the scheduling environment

Setting up a Forecast Workspace


This procedure describes how to set up a Forecast Workspace. This enables you to simulate your job flow
to verify how your flow runs on a future date. You can apply changes based on your analysis.

 To set up a Forecast Workspace:


1. From the Forecast domain, in the Date field, select and select a date.
2. In the What If Scenario field, in the drop-down list, select a scenario.
3. Filter folder and jobs, as described in Filter parameters (on page 199).
4. If you want to add services to your Forecast Workspace, do the following:
a. Click Services.
b. In the Services field, select the services, and click OK.

c. To filter jobs, click .


d. Set the filter fields, as described in Filter parameters (on page 199).
5. To set advanced filters, do the following:

290
Control-M User Guide

a. In the Use field, select one of the following versions of calendars.


o My checked out
o All checked out
o Only checked in
b. In the Job Run Time field, select one of the following:
o Minimum
o Average
o Maximum
c. To include only conditions defined in a specific Control-M/Server, select the Ignore global
Conditions field.
6. Click Open.
The Forecast Workspace opens.

Filtering the Forecast Workspace


This procedure describes how to change the jobs and folders that are displayed without removing the
data, this enables you to control what you view in the Forecast Workspace.
 To filter a Forecast Workspace:

1. From the Forecast domain, click .


The Filter dialog box appears.
2. Enter the values of the parameters, as described in Filter parameters (on page 199).
3. Click Done.
The Forecast Workspace displays the jobs that you would like to view, without removing them from
the Workspace.

Saving a filter criteria as a preset


This procedure describes how to save a filter criteria as a preset, which enables you to set specific filter
criteria in the Forecast domain and be able to load it as a predefined preset.

 To save a filter criteria as a preset:


1. From the Forecast home page, set the filter criteria as described in Filtering the Forecast Workspace
(on page 291).
2. Click Presets > Save.
The Save Preset dialog box appears.
3. In the Enter a name of preset field, type a name for the saved filter criteria, and then click OK.
4. Once the preset is saved you can do the following:

291
Control-M User Guide

• To load a saved filter criteria, select Presets > Load and select a preset.
• To delete a saved filter criteria, select Presets > Delete and select a preset.
If the Delete Preset definitions option is selected as described in Confirmation settings (on
page 39), a confirmation message appears.

Defining a Specific User Daily job


This procedure describes how to define a Specific User Daily job, which enables you to add a specific user
daily defined in folder, and specify the Order time.
Before You Begin
Ensure that you have checked in a folder where you set the order method to Specific User Daily, and
set the User Daily Name.
 To define a Specific User Daily job:
1. From the Tools tab in the Forecast domain, click User Daily Definition.
The User Daily Definition dialog box appears.

2. Select the Control-M/Server to define the user daily, and click .


The User Daily Definition dialog box appears.
3. From the User Daily drop-down list, select a User Daily name.
4. In the Time field, set the time you want the User Daily to run.

Editing a User Daily


This procedure describes how to edit the Order time of a Specific User Daily job.

 To edit a User Daily:


1. From the Tools tab in the Forecast domain, click User Daily Definition.
The User Daily Definition dialog box appears.
2. Select the user daily you want to edit, and click .
The User Daily Definition dialog box appears.
3. In the Time field, set the time you want the User Daily to run.
The Specific User Daily job time is updated.

Deleting a Specific User Daily job


This procedure describes how to delete a Specific User Daily job.

 To delete a Specific User Daily job:


1. From the Tools tab in the Forecast domain, click User Daily Definition.

292
Control-M User Guide

The User Daily Definition dialog box appears.

2. Select the user daily you want to delete, and click .


The Specific User Daily job definition deleted.

Why analysis
A Why analysis provides detailed information that is gathered about why jobs are estimated to run as
displayed on the job hosts. The details can be obtained for a specific job or a number of jobs based on
the job definitions for a specified day. The Why window shows the constraints in the past, and the most
recent constrain that prevents the selected job from running. In addition, you can see the start and end
of the simulation times of the job. This enables you to determine how to define an earlier start time so
that jobs and services can complete on time. The Why analysis window is available for any job in the
Forecast domain, as described in Setting up a Why analysis (on page 293).
A Why analysis can provide some of the following additional information:
 Job is waiting for a quantitative resource
 Job is waiting for a condition
 Job waiting for confirmation

Setting up a Why analysis


This procedure describes how to apply a Why analysis, which enables you to view a simulation of jobs on
a specified date, based on job definitions.
 To set up a Why analysis:
1. From the Forecast domain, set up a Forecast Workspace, as described in Setting up a Forecast
Workspace (on page 290).

2. In the Flow diagram, select a job or folder, and click .


The Why <job name> window appears, and the status appears in the right side.
3. Do one or more of the following:

• To view available status information that does not appear, click in one or more of the
following:
o Missing conditions
o Missing quantitative resources
The information is provided by Control-M Control-M/Forecast.
• To add a listed condition, click Add.
• To simulate a potential change, click Add What-if, and select an option, as described by What-If
scenario options (on page 256).
• To view the effects of the enabled What-If Scenarios section, do the following:

293
Control-M User Guide

a. In the Forecast tab, click the Forecast section.


b. Click the Business Services section.
The effects of the What-If event, appear in the flow diagram, and in the number of jobs in a
particular status.
c. Click the Jobs section.
The effects of the What-If event, appear in the flow diagram, and in the number of jobs in a
particular status.
• To disable, the What-If, clear the check box next to the What-If.

• To disable or enable all the What-Ifs, click .


4. In the Why <job name> window, click Close.
The Why analysis is complete, and you can apply the changes to your definitions, if the changes
enabled the simulated jobs to end OK and the services to complete on time.

Forecast/BIM rules
Forecast/BIM rules are exceptions that affect the expected job run times. You can manually revise the
expected run time for a job by creating exceptions using the Forecast/BIM Rules in the Forecast domain.
This method enables you to compensate for new or seasonal conditions that can affect the run time of a
job, making its expected run time irrelevant. It also enables you to enter statistics for jobs that have not
yet run and therefore do not have existing statistics. You can modify these statistics at any time.
You can do the following:
 Create a Forecast/BIM rule (on page 294): You can create and enable/disable the following types of
Forecast/BIM rules:
• Quantitative Resource: Enables you to update the maximum value of quantitative resources.
• Job Run Time: Enables you to update the run time by changing the percentage or the run time,
or by setting the time.
• Condition: Enables you to define a specific time for adding a condition or a group of conditions
to the Condition table. A Manual Condition Event occurs when a job depends on a condition that
does not apply to other jobs and has not been added to the Condition table previously.
• Confirmation: Enables you to define a time for the job's confirmation, increasing the accuracy of
the calculation. Confirmation rules affect the entire calculation. If a job awaiting confirmation is
connected to more than one service, any defined exception affects all services depending on it.
 Edit Forecast/BIM Rule (on page 295): You can edit the Forecast/BIM rules to manually revise the
expected run time for a job. A Service Assumption is a Forecast/BIM rule for a specific service.
 Delete a Forecast/BIM rule (on page 296): You can delete Forecast/BIM rules.

Creating a Forecast/BIM rule


This procedure describes how to create a Forecast/BIM rule, which enables you to revise expected run
times.

294
Control-M User Guide

 To create a Forecast/BIM rule:


1. From the Forecast domain, click Forecast/BIM Rules.
The Forecast/BIM Rules window appears.

2. Click , and select one of the following:


• Quantitative Resource rule (on page 297)
• Job Run Time rule (on page 298)
• Condition rule (on page 301)
• Confirmation rule (on page 302)
3. Set the fields, as described in the relevant field descriptions, and click Advanced to set the calendar
details:
4. Click OK.
The rule appears in the left pane.
5. To disable the rule, clear the check mark next to the rule.
6. Click Save.
The Forecast/BIM rules you defined are saved, and the checked ones are enabled.

Editing Forecast/BIM rule


This procedure describes how to edit a Forecast/BIM rule, which enables you to revise expected run
times.

 To edit Forecast/BIM rule:


1. From the Forecast domain, click Forecast/BIM Rules.
The Forecast/BIM Rules window appears.
2. In the left pane, select one of the rules.
The fields appear in the right pane.
3. Update the fields, as described in the following field descriptions, and click Advanced to set the
calendar details:
• Quantitative Resource rule (on page 297)
• Job Run Time rule (on page 298)
• Condition rule (on page 301)
• Confirmation rule (on page 302)
4. Click OK.
The rule appears in the left pane.
5. Do one of the following:
• To enable the rule, select the check box next to the rule.

295
Control-M User Guide

• To disable the rule, clear the check mark next to the rule.
6. Add rules, as described in Creating a Forecast/BIM rule (on page 294).
7. Click Save.
The Forecast/BIM rules you edited are saved, and the checked ones are enabled.

Deleting a Forecast/BIM rule


This procedure describes how to delete a Forecast/BIM rule.

 To delete a Forecast/BIM rule:


1. From the Forecast domain, click Forecast/BIM Rules.
The Forecast/BIM Rules window appears.
2. In the left pane, select one of the rules.
The fields appear in the right pane.

3. Click .
4. Update the fields, as described in the following field descriptions, and click Advanced to set the
calendar details:

296
Control-M User Guide

Quantitative Resource rule


The following table describes the fields to adjust the quantitative resource at a specified time.

Field Description

Update quantitative resource maximum quantity

Control-M Name of the Control-M whose jobs are included in this exception
definition.

Resource Modifies the quantitative resource (on page 76), which represents a
measure that can be quantified.

Maximum Modifies the maximum quantity of this quantitative resource that can
be used by jobs concurrently according to one of the following
settings:
 Set to
 Increase by
 Decreased by

At (Sets when the event is triggered)

New Day time The time that the New day procedure is scheduled to run.

Time Time of day at which the job starts, specified in hours and minutes
using the 24-hour clock format (HH:MM). This is based on the time
of the Control-M on which the job is run.

Calendar details (click Advanced) Applies to Service Assumption and Forecast/BIM rules

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more period for this exception definition, which can
be selected from a list. Special month rules are not supported.

297
Control-M User Guide

Job Run Time rule


The following table describes the Run Time rule, which adjusts the estimated job run time by changing
the percentage of the run time or the actual time:

298
Control-M User Guide

Field Description

Update Run Time

Percent Modifies the estimated job runtime by the specified percentage, and
defines whether to increase or decrease the time.

Time Modifies the estimated job runtime by the specified fixed time value.
The time used is time of day at which the job starts, specified in
hours and minutes using the 24-hour clock format (HH:MM). This is
based on the time of the Control-M on which the job is run. Defines
whether to set to =, <, or >.

For all jobs meeting the following criteria

Control-M Name of the Control-M whose jobs will be included in this exception
definition.*

Application Name of the application whose jobs are included in this exception
definition.

Sub Application Name of the Sub Application whose jobs are included in this exception
definition.

Job Name Name of the job that will be included in this exception definition.*

Mem Name Name of the member name (for z/OS) that is included in this
exception definition.*

MemLib Name of the member library (for z/OS) whose jobs are included in
this exception definition.*

Folder Name of the container into which job processing definitions are
organized.

Folder Lib Name of the library that contains the job’s table.

Host ID Name of a host computer to which a job was submitted.

Run as Identifies the user name for whom the job is executed.

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

Calendar details (click Advanced) Applies to Service Assumption and Forecast/BIM rules

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more period for this exception definition, which can
be selected from a list. Special month rules are not supported.

299
Control-M User Guide

300
Control-M User Guide

Condition rule
This table describes a Condition rule, in which a condition is added or removed at a specified time, and
does not depend on other jobs:

Field Description

Update condition state

Control-M Name of the Control-M whose jobs will be included in this exception
definition. The (asterisk) wildcard character can be used in the field to
represent multiple values.

Condition Requirements to be met before a job can be submitted.

Order Date Time and day at which the job is ordered.


The valid values are (in MM/DD):
 Any Date
 Order Date
 No Date

Action The steps that Control-M takes when the specified condition is met.
The valid values are:
 Add (default)
 Delete

At (Sets when the event is triggered)

Average job start Start time based on existing Job Runtime Statistics.
time

New Day Time The time that the New day procedure is scheduled to run.

Time Time of day at which the job starts, specified in hours and minutes
using the 24-hour clock format (HH:MM). This is based on the time
of the Control-M on which the job is run.

Calendar details (click Advanced) Applies to Service Assumption and Forecast/BIM Rules

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more period for this exception definition, which can
be selected from a list. Special month rules are not supported.

301
Control-M User Guide

Confirmation rule
The following table describes the Confirmation rules, which can be confirmed at a specified time, and
affect the calculation of the all services depending on it:

302
Control-M User Guide

Field Description

Average job start Start time based on existing Job Runtime Statistics.
time

Order Time The time that the job is ordered to run.

Time Time of day at which the job starts, specified in hours and minutes
using the 24-hour clock format (HH:MM). This is based on the time
of the Control-M on which the job is run.

Don’t Confirm If a business service depends on this confirmation job to run, the
Estimated End Time for this service is displayed as:
Will not Complete

For all jobs meeting the following criteria:

Control-M Name of the Control-M whose jobs will be included in this exception
definition.

Application Name of the application whose jobs are included in this exception
definition.

Sub Application Name of the Sub Application whose jobs are included in this exception
definition.

Job Name Name of the job that is included in this exception definition.*

Mem Name Name of the member name (for z/OS) that is included in this
exception definition.

Mem Lib Name of the member library (for z/OS) whose jobs is included in this
exception definition.

Folder Name of the container into which job processing definitions are
organized.

Folder Lib Name of the library that contains the job’s folder.

Host ID Name of a host computer to which a job was submitted.

Run as Identifies the user name for whom the job is executed.

Created by Indicates the Control-M user who defined the job.

Calendar details (click Advanced) - Applies to Service Assumptions and Forecast/BIM


Rules

303
Control-M User Guide

Field Description

Calendar Details of the Control-M and calendar to be used to schedule the job.

Period Name of one or more periods for this exception definition, which can
be selected from a list. Special month rules are not supported.

Adding a What-If event from a Forecast Workspace


This procedure describes how to add a What-If to a scenario, which enables you to simulate actions that
can resolve service problems, and analyze their impact on the active jobs, before actually executing them.

 To add a What-If event from a Forecast Workspace:


1. From the Forecast domain, access a Forecast Workspace, as described in Setting up a Forecast
Workspace (on page 290).
2. In the Forecast tab in the right pane, click What-If Scenario.
The What-If Scenarios icons appear.

3. Click , and select the type of What-If, as described in What-If scenario options (on page 256).
The specific What-If <type> dialog box appears.
4. Set the What-If fields, as described in What-If scenario options (on page 256).
The What-If appears in the What-If Scenario section.
5. Do one or more of the following:
• To view the effects of the enabled What-If Scenarios section, do the following:
a. In the Forecast tab, click the Forecast section.
b. Click the Business Services section.
The effects of the What-If event, appear in the flow diagram, and in the number of jobs in a
particular status.
c. Click the Jobs section.
The effects of the What-If event, appear in the flow diagram, and in the number of jobs in a
particular status.
• To disable, the What-If, clear the check box next to the What-If.

• To disable or enable all the What-Ifs, click .

304
7
7
Tools
Control-M contains tools that provide enhanced functionality and gives you unlimited control over every
aspect of job definition and execution in your environment.
The following table describes the available tools that you can access from Tools domain or from the Tools
menu in the Planning, Monitoring, History, and Forecast domains:

305
Control-M User Guide

Tool Description

Options (on page 25) Enables you to customize settings for the Control-M client.

Planning Tools

Calendars (on page 335) Enables you to create a regular, periodic, relative, and Control-M
Rule-Based Calendar.

Folders (on page 324) Enables you to view all folders defined in all environments, upload
Control-M/EM data to Control-M/Server, download Control-
M/Server data to Control-M/EM, and order and delete folders.

Periodic Statistics (on page 383) Enables you to collect separate statistics on a specific job or set of
jobs, based on a calendar period, or a dynamic period that is
effective only while the dynamic condition is active.

Service definition (on page 368) Enables you to create service definitions and service rules that are
used to model the Production for your end users.

Templates (on page 327) Enables you create templates for job and folder definitions.

Promotion rules (on page 330) Enables you to define environments and promotion rules to move
folders between environments.

Workspaces (on page 308) Enables you to take ownership, rename, and delete a workspace.

Production Control Tools

Conditions (on page 344) Enables you to view all active Conditions that are available to
Active Jobs, and create conditions manually.

Control Resources (on page 342) Enables you to view shared or exclusive resources that are
available to active jobs and prevent jobs with Control Resources
from running.

Global Conditions Prefixes (on Enables you to define global prefixes that are used for prerequisite
page 346) conditions to establish job dependencies across different Control-
M/Servers by defining condition name prefixes that indicate that a
condition is global.

Quantitative Resources (on page Enables you to create active quantitative resources that are
343) available to active jobs.

Workload Policy Definitions (on Enables you to control, manage, and balance the workload on
page 382) Control-M resources and hosts.

306
Control-M User Guide

Tool Description

Control-M Event Manager (on (z/Os only) Enables Control-M to perform specified actions in
page 351) response to external events outside the direct control of Control-
M.

Monitoring Tools

Alerts Monitor (on page 267) Enables you to monitor your production.

Service Monitor (on page 268) Enables you analyze services, and locate and resolve problematic
jobs.

Viewpoints (on page 309) Enables you to define Viewpoints. You can then view and monitor
jobs on a particular Control-M/Server, jobs belonging to a specific
user, and jobs having a particular status, such as failed jobs.

Workload Policy Monitor (on Enables you to see the current status of associated jobs with a
page 382) Workload Policy.

Communication Tools

Communication (on page 388) Enables you to monitor the communication status between
Control-M/EM and Control-M/Server, troubleshoot connectivity
problems, and change the Control-M password, as described in
the following topics:
 Control-M Servers Communication status (on page 389)
 Troubleshooting connectivity (on page 390) (also see
Connectivity problems (on page 389))
 Changing the password (on page 388)

Batch Impact Manager/Forecast Tools

Forecast/BIM rules (on page Enables you to manually revise the expected run time for a job by
294) creating exceptions.

User Daily Definition (on page Enables you to add a specific user daily defined in folder, and
292) specify the Order time.

Other Tools

Control-M Configuration Manager Enables you to administer, manage, monitor, configure, and
maintain all Control-M components, as well as defining security
settings and user authorizations.

307
Control-M User Guide

Tool Description

Reports (Control-M Reporting Enables you to define templates that you can use to generate
Facility) reports that provide important information about your Control-M
job flow.

Workspace management
The Workspace manager is a tool that enables you to do the following:
 Taking Ownership of a workspace (on page 308)
 Renaming a workspace (on page 308)
 Deleting a workspace (on page 309)
The same actions can be preformed on request Workspaces in the Workspace tool for Control-M Workload
Change Manager users.

Taking Ownership of a workspace


This procedure describes how to take ownership of workspace from another Control-M/EM user, which
allows you to perform all workspace actions, such as adding and removing jobs, and checking in and out
a workspace.

 To take Ownership of a workspace:


1. From the Tools domain, in the Planning area, select Workspaces.
2. From the Workspace menu, select the workspace that you want to take ownership over.
A confirmation message appears.
3. Click Yes.
You are now the owner of the workspace.

Renaming a workspace
This procedure describes how to rename a workspace in the Workspace manager.
 To rename a Workspace:
1. From the Tools domain, in the Planning area, select Workspaces.
2. From the Workspace menu, select the workspace that you want to rename.

3. Click .
4. In the Name field, type the new name of the workspace.

308
Control-M User Guide

5. Click OK.
The workspace with the new name appears in the Workspace table.

Deleting a workspace
This procedure describes how to delete a workspace in the Workspace manager.

 To delete a Workspace:
1. From the Tools domain, in the Planning area, select Workspaces.
2. From the Workspace menu, select the workspace that you want to delete.
A confirmation message appears.
3. Click Yes.
The workspace is deleted.

Filtering workspaces
This procedure describes how to filter workspaces in the Workspace manager.

 To filter workspaces:
1. From the Tools domain, in the Planning area, select Workspaces.
2. From the Workspace menu, select Filter Workspaces.
The Filter Workspaces dialog box appears.
3. Do the following:
a. From the Control-M Server drop-down list, select the Control-M/Server where the required
workspace is located.
b. From the Folder drop-down list, type or select the folder where the required workspace is
located.
c. From the Folder Library drop-down list, type or select the folder library where the required
workspace is located.
d. Click OK.
The workspaces that match the filter criteria appear.

Viewpoint management
A Viewpoint is a customizable, dynamic tool, which enables you to display the jobs and job flows of
interest. For example, you can view and monitor jobs:

309
Control-M User Guide

 On a particular Control-M/Server
 Belonging to a specific user
 Having a particular status, such as failed jobs
Viewpoints are constantly updated and show in real-time the execution status of the batch production.
ViewPoints consist of the following components:
 Hierarchy: Defines the hierarchical structure used to display jobs. For example, jobs are displayed
logically according to their application settings, or physically according to a Control-M/Server.
 Collection: Selects a collection of jobs from the active jobs database based on parameter values in
the job processing definition. For example, ALL JOBS loads all jobs in the active jobs database. You
can filter your collection in the Filter section.
 Filter: Determines which jobs are displayed in the Viewpoint. You can use Filtering for managing by
exception. For example, you can display those jobs that Ended Not OK and jobs in a Wait status.
Although they do reduce system overhead, filters reduce screen clutter, enabling you to focus on jobs
that really require monitoring. Each Viewpoint has an associated Global filter, but when a Viewpoint is
displayed, you can select a different Global filter to alter which jobs are displayed in the current
Viewpoint's session. After Global filters are defined they are available site-wide.
Control-M Workload Automation includes a set of predefined Viewpoints, but you can define your own
Viewpoints.
The following procedures describe how to create, delete, and copy a viewpoint:
 Creating a Viewpoint (on page 310)
 Deleting a Viewpoint (on page 311)
 Copying a Viewpoint (on page 312)

Creating a Viewpoint
This procedure describes how to create a Viewpoint, which enables you to determine which jobs are
selected and loaded into memory, how the jobs are filtered, and the hierarchy that is used to display
those jobs.
 To create a Viewpoint:
1. From the Tools Domain, select Viewpoint Manager.
The Viewpoint Manager appears.

2. Click .
A new Viewpoint is added and appears in the Properties pane.
3. Type a Name for the Viewpoint.
4. Type a description for the Viewpoint (optional).
5. In the Hierarchy section, do the following:
a. Select a Hierarchy definition for the Viewpoint.
b. To edit the selected Hierarchy, click .

310
Control-M User Guide

The Hierarchy dialog box appears.


c. Type a name for the Hierarchy.
d. Type a description for the Hierarchy (optional).
e. Select criteria for each level of the hierarchy. You can define up to six hierarchy levels.
f. Click Save Update.
The Hierarchy is defined.
6. In the Filter section, do the following:
a. Select a Filter for the ViewPoint.
b. To edit the selected filter, click .
The Filter dialog box appears.
c. Type a name for the Filter.
d. Type a description for the Filter (optional).
e. Define the filtering criteria:
o To Include or Exclude a set of criteria, select or specify a field name, relational operator,
and a value (for example, CTM Name = ctmp1).
o To delete a set of criteria, select it in the Include or Exclude area and click Delete.
f. Click Save Update.
The Filter is defined.
7. In the Collection section, do the following:
a. Select a Collection for the Viewpoint.
b. To create a new collection, click .
The Collection dialog box appears.
c. Type a name for the Collection.
d. Type a description for the Collection (optional).
e. Define the Collection criteria:
o To Include or Exclude a set of criteria, select or specify a field name, relational operator,
and a value (for example, CTM Name = ctmp1).
o To delete a set of criteria, select it in the Include or Exclude area and click Delete.
f. Click Save New.
The Collection is created.
8. Click Save.
The Viewpoint is created.

Deleting a Viewpoint
This procedure describes how to delete a Viewpoint.

311
Control-M User Guide

 To delete a Viewpoint:
1. From the Tools domain, select Viewpoint Manager.
The Viewpoint Manager appears.
2. From the list of Viewpoints, select the Viewpoint to delete.

3. From the Viewpoints ribbon, in the Edit section, select .


A confirmation message appears.
4. Click Yes.
The Viewpoint is deleted.

Copying a Viewpoint
This procedure describes how to duplicate a Viewpoint, which enables you to copy a Viewpoint with all its
defined criteria.
 To copy a Viewpoint:
1. From the Tools domain, select Viewpoint Manager.
The Viewpoint Manager appears.
2. From the list of Viewpoints, select the Viewpoint to copy.

3. Click .
The Viewpoint is copied.

Site customizations management


The Site customizations tool enables you to do the following:
 Simplify job properties: Define which fields, a Control-M Workload Change Manager web user, can
access when creating or editing jobs. You can hide or show entire tabs of the job properties pane
such as Scheduling, Prerequisites, and Actions. You can also select specific options in these tabs to
hide or show.
 Restrict creation of job types: Restrict which job types a web user can create in a job flow. For
example, if you do not want web users to modify job definitions for job type File Transfer, you can
disable it in Site customizations. The web user cannot create this form of job.
You can create several Site customizations, however only one can be set as a default Site customization
that is used by all web users. If you choose to have several Site Customizations, for different web users,
you will need to provide the web user with the Site customization that is relevant to them.
The following procedures describe how to create, edit, duplicate, and delete a Site customization:

312
Control-M User Guide

 Creating a Site customization (on page 313)


 Editing a Site customization (on page 313)
 Duplicating a Site customization (on page 314)
 Deleting a Site customization (on page 314)
For more information on job properties and job types, see Job definition.
You must have full privileges to create Site customizations, as described in Privileges .

Creating a Site customization


This procedure describes how to create a Site customization, which enables you to simplify job properties,
and restrict creation of job types for a Control-M Workload Change Manager web user.

 To create a Site customization:


1. From the Tools domain, in the Planning area, select Site customizations.
The Site customizations tab appears.

2. From the Site customizations group in the ribbon, click .


The Site customization pane appears on the right.
3. In the Name field, type a name for the new Site customization.

4. If you want to set the Site customization as the default, click .


5. Do one or both of the following:
• To display the list of options and tabs, click Job properties, and uncheck the options you want
to hide.
• To display the list of job types, click Job types, and uncheck the job types you want to prevent
web users from creating.

6. Click .
The Site customization is created.

Editing a Site customization


This procedure describes how to edit a Site customization, which enables you to modify the details of the
Site customization. There might be active job flows using the site customization you want to edit. The
changes take effect after a web user logs into Control-M Workload Change Manager.
 To edit a Site customization:
1. From the Tools domain, in the Planning area, select Site customizations.
The Site customizations tab appears.
2. Select the Site customization you want to edit.

313
Control-M User Guide

The Site customization pane appears on the right.


3. Edit the details of the site customization according to your needs. For more information, see Creating
a Site customization (on page 313).

4. Click .
The Site customization is modified with the new changes.

Duplicating a Site customization


This procedure describes how to duplicate a Site customization, which enables you to make a copy of an
existing Site customization and edit its contents and save it as a new Site customization.

 To duplicate a Site customization:


1. From the Tools domain, in the Planning area, select Site customizations.
The Site customizations tab appears.
2. Select the Site customization you want to duplicate.

3. From the Site customizations group, click .


The duplicated Site customization is created, and appears on the right pane. You can change the
name and definitions of the Site customization, as described in Creating a Site customization (on page
313).

Deleting a Site customization


This procedure describes how to delete a Site customization. There might be active job flows using the
Site customization you want to delete.
 To delete a Site customization:
1. From the Tools domain, in the Planning area, select Site customizations.
The Site customizations tab appears.
2. Select the Site customization you want to delete.

3. From the Site customizations group, click .


The Site customization is deleted.

Site standards management


The Site standard tool enables you to define settings that ensure Control-M Workload Change Manager
web users and Control-M schedulers follow your organization's standards.
These standards are applied at the folder level, to new and existing folders, as described in Folder
management (on page 324). All jobs, new or old, have to comply with the Site standard rules. You can
create multiple Site standards, and assign different Site standards to different folders.

314
Control-M User Guide

You can set rules such as character length for a specific field, as described in Site standards rules editor
parameters (on page 320).
The Site standard tool consists of the following parts:
 Folder/job parameters (on page 315): Defines rules and restrictions for specific Control-M folder/job
parameters.
 Business parameters (on page 316): Defines parameters specific to your business, that carry a special
business meaning.
 Internal rules (on page 317): Defines rules that can be reused as rules in Control-M folder/job
parameters and business parameters.
 Condition format: Defines a default condition name format that is used by the Workload Change
Manager web user, and the Control-M scheduler.
The Site standard rules are validated, and errors and warnings appear to the web user upon submission
of the job flow as request/checking in the job flow , and to the scheduler upon check-in. The handling of
these warnings/errors depends on the enforcement policy set at the folder level. For more information,
see Enforcing validations (on page 327).
The following procedures describe how to create, edit, duplicate, and delete a Site standard:
 Creating a Site standard (on page 318)
 Editing a Site standard (on page 323)
 Duplicating a Site standard (on page 324)
 Deleting a Site standard (on page 324)
You must have full privileges to create Site standards, as described in Privileges .

Folder/job parameters
In the Site standard tool, you can specify restrictions and rules for Control-M folder/job parameters. The
rules you define override the Control-M rules. However, you can only choose to alter the rules supported
by Control-M, but not add new ones. For example, if a parameter can have from 1- 64 characters, you
can choose to set the length between 1- 64, but not more than 64. This means, you can set the length to
be only 50 characters, but not 65.
You can set a default value, or possible values, or allow certain characters, as described in Site standards
rules editor parameters (on page 320).
You can also use Business parameters (on page 316) and Internal rules (on page 317) as pattern parts of
the Control-M folder/job parameter.

315
Control-M User Guide

Folder Name in your organization can only be from 1- 10 characters, cannot contain /*!, and only applies
to OS job type.

After this rule is defined in the Site standard, and the Site standard is assigned to the folder, the Folder
Name parameter rule is applied. The Control-M Workload Change Manager web user and the Control-M
scheduler modifying the folder with that Site standard will have to comply with the Folder Name rule you
defined. If they do not comply with the rule, a warning/error appears. They can ignore or fix the
warning/error depending on the enforcement policy you set, as described in Enforcing validations (on
page 327).
For more information on how to define Control-M folder/job parameters, see Creating a Site standard (on
page 318).

Business parameters
In addition to the Control-M folder/job parameters rules and restrictions, you can define additional
parameters that carry a specific meaning to your organization.

316
Control-M User Guide

In your organization, you define your Job Name with a prefix of department ID. Your Job Name consists
of business parameter [DepID] followed by free text.

You can create a Business parameter named Department ID and apply the desired rules and restrictions,
like possible values, pattern parts, length, etc, as described in Site standards rules editor parameters (on
page 320) . After creating the business parameter, you can use it in a Control-M folder/job parameter, in
this case in Job Name. You can also reuse other business parameters you defined, or Internal rules (on
page 317).
After this rule is defined in the Site standard, and the Site standard is assigned to the folder, the Job
Name parameter rule is applied. The Control-M Workload Change Manager web user and the Control-M
scheduler modifying the folder with that Site standard will have to comply with the Job Name rule you
defined. If they do not comply with the rule, a warning/error appears. They can ignore or fix the
warning/error depending on the enforcement policy you set, as described in Enforcing validations (on
page 327). For more information on how to define Business parameters, see Creating a Site standard (on
page 318).

Internal rules
In the Site standard tool, you can create internal rules that can be used in Folder/job parameters (on
page 315) and Business parameters (on page 316). Internal rules, are recurrent rules that you use in
Control-M folder/job parameters and Business parameters.
Instead of creating this rule every time you create a folder/job parameter rule, you can create an internal
rule and specify the invalid characters, as described in Site standards rules editor parameters (on page
320). Now, you can reuse the internal rule in each folder/job parameter rule you create.
All folder/job parameters cannot contain the characters !*/.
Job name cannot contain characters !*/.
Application cannot contain !*/.
File name cannot contain 1*/.

317
Control-M User Guide

After this rule is defined in the Site standard, and the Site standard is assigned to the folder, the rule is
applied. The Control-M Workload Change Manager web user and the Control-M scheduler modifying the
folder with that Site standard will have to comply with the rule you defined. If they do not comply with
the rule, a warning/error appears. They can ignore or fix the warning/error depending on the
enforcement policy you set, as described in Enforcing validations (on page 327).
For more information on how to define internal rules, see Creating a Site standard (on page 318).

Creating a Site standard


This procedure describes how to create a Site standard, which enables you to set rules and regulations to
Control-M folder/job parameters, Business parameters, and internal rules.

 To create a Site standard:


1. From the Tools domain, in the Planning area, select Site standards.
The Site standards tab appears

2. From the Edit group in the ribbon, click .


The Site standard appears.
3. In the Name field, type a name for the new Site standard.
4. Do one or all of the following:
• Create Folder/job parameters (on page 315) rules, as described in Creating folder/job parameter
rules (on page 319).
• Create Business parameters (on page 316), as described in Creating business parameters (on
page 319).
• Create Internal rules (on page 317), as described in Creating internal rules (on page 319).

5. Click .

318
Control-M User Guide

The Site standard is created.

Creating folder/job parameter rules


This procedure describes how to create a folder/job parameter rule, which enables you set rules and
restrictions to specific Control-M folder/job parameters.

Before you begin


Ensure that you have completed Creating a Site standard (on page 318).

 To create folder/job parameter rules:


1. In the Site standard, in the Folder/job parameters section, click .
The rules editor pane appears on the right.
2. From the Name drop-down list, select the Control-M parameter.
3. Define the rules, as described in Site standards rules editor parameters (on page 320).

4. Click .
The folder/job parameter rules are created.

Creating business parameters


This procedure describes how to create a Business parameter rule.
For more information on Business parameters functionality, see Business parameters (on page 316).

Before you begin


Ensure that you have completed Creating a Site standard (on page 318).

 To create business parameters:


1. In the Site standard, click Advanced.

2. In the Business parameters section, click .


The rules editor pane appears on the right.
3. In the Name field, type a name for the Business parameter. Select a name that has a business value
to your organization.
4. Define the rules, as described in Site standards rules editor parameters (on page 320).

5. Click .
The business parameter rules are created.

Creating internal rules


This procedure describes how to create internal rules.
For more information on internal rules functionality, see Internal rules (on page 317).

319
Control-M User Guide

Before you begin


Ensure that you have completed Creating a Site standard (on page 318).

 To create internal rules:


1. In the Site standard, click Advanced.

2. In the Internal rules section, click .


The rules editor pane appears on the right.
3. In the Name field, type a name for the internal rule.
4. Define the rules, as described in Site standards rules editor parameters (on page 320).

5. Click .
The internal rule is created.

Site standards rules editor parameters


The following table lists the Site standards rules editor parameters:

Parameter Description

Applied to Applies job parameter rules to specific job types in the same Site
Standard.
Job Name applied to OS job type

Default Value Defines a default value for a folder/job parameter.

Required Indicates that the parameter is mandatory.

Possible values Defines more than one value that a Control-M Workload Change
Manager web user and Control-M scheduler can use. Any one of these
options is valid. You cannot define pattern parts if you define possible
values. If you define other rules like length, or character restrictions, the
possible values have to comply with these rules.

Pattern Parts Indicates that a parameter is composed of a pattern.

Business parameters (on page 316) Indicates that a business


parameter can be used as a
pattern part of a Control-M
folder/job parameter.
Job Name: [Business
Parameter][*]

320
Control-M User Guide

Parameter Description

Folder/job parameters (on page 315) Indicates that a folder/job


parameter rule can be used as
a pattern part of another
folder/job parameter rule.
Job Name:[Application]

Internal rules (on page 317) Indicates that an internal rule


can be used as a pattern part
of folder/job parameter and a
business parameter.
Job Name:[Internal Rule][1-9
characters][*]

Fixed text Indicates that a fixed value is


used in the parameter as a
constant string.

Free text Indicates that any value can be


used in the parameter.

321
Control-M User Guide

Parameter Description

Length Determines the minimum and maximum length of characters in a


parameter.

Characters Determines character restrictions, such as which characters are allowed,


which characters are excluded, the use of uppercase and lowercase
letters, and digits in a parameter.
Job Name: [1-9 characters][#%4&]

Patterns Determines patterns/values to be excluded in the site standard rule,


which prohibits users from using them in a job definition.
Example: If you do not want a root user to be defined in the Run As
parameter, you can do the following:
Folder/Job attribute: Run as
Pattern Parts: Free text
Patterns: Root
You can use more than one pattern/value to exclude, which you
separate by ",".
You can also use "*" as a wildcard to exclude a string.
Example: If you do not want users to define an AIX host in the
Host/Host group parameter and your organization uses
strings such as aix1-d1d2, aix2-d2d3, etc. as a naming
convention for all AIX hosts, you can do the following:
Folder/Job attribute: Host/Host Group
Pattern Parts: Free text
Patterns: aix*

Validate according Verifies that the defined Host/Host Group exists as an agent, remote
to topology host, or host group in the Control-M Configuration manager. This
prevents the user from defining hosts that do not exist on the Control-M
on which the job runs.
This checkbox appears when you select the Host/Host group Control-
M parameter from the Folder/Job Attribute drop-down list.

322
Control-M User Guide

Parameter Description

Destination Enables you to define specific rules for Notifications before and after
jobs completion/On-Do Notify messages for a specific destination. The
two options in the Folder/Job Attribute drop-down list appear as
Notification Message and Do Notify Message.
The rule is applied when a user defines a notification message on the
destination you set in the Site Standard rule.
Example: For a Do Notify Message, destination Alerts Window, users
can only use fixed text Smart followed by free text; Smart*.
Folder/Job attribute: Do Notify Message
Pattern Parts: Fixed Text (SMART)
Pattern Parts: Free text

Rerun Limitation Enables you to limit the minimum and maximum rerun interval in
minutes, hours, and days. The rule is applied when a user defines a
cyclic job in the Scheduling tab of the Planning domain in Workload
Change Manager and Workload Automation. You can also set a default
value. Take note, the default value has to comply with the limitation rule
you set.
The new option appears in the Folder/Job Attribute drop-down list as
Rerun Interval.

Editing a Site standard


This procedure describes how to edit a Site standard, which enables you to modify the details of the Site
standard. There might be folders assigned to the Site standard you want to edit.
 To edit a Site standard:
1. From the Tools domain, in the Planning area, select Site standards.
The Site standards tab appears.
2. Select the Site standard you want to edit.
The Site standard opens
3. Edit the details of the Site standard according to your needs. For more information, see Creating a
Site standard (on page 318).

4. Click .
The Site standard is modified with the new changes.

323
Control-M User Guide

Duplicating a Site standard


This procedure describes how to duplicate a Site standard, which enables you to make a copy of an
existing Site standard and edit its contents and save it as a new Site standard.
 To duplicate a Site standard:
1. From the Tools domain, in the Planning area, select Site standards.
The Site standards tab appears.
2. Select the Site standard you want to duplicate.

3. From the Edit group in the ribbon, click .


The duplicated Site standard is created, and appears. You can change the name and definitions of the
Site standard, as described in Creating a Site standard (on page 318).

Deleting a Site standard


This procedure describes how to delete a Site standard. There might be active job flows using the Site
standard you want to delete.
 To delete a Site standard:
1. From the Tools domain, in the Planning area, select Site standards.
The Site standards tab appears.
2. Select the Site standard you want to delete.

3. From the Edit group, click .


The Site standard is deleted.

Folder management
The Folder manager is a tool that enables you to view all folders defined in all environments. The folders
are automatically synchronized with Control-M/Server unless it is configured differently (see Configuring
Control-M/Server synchronization), or might not succeed in case of conflicts. If this occurs, you have to
manually upload/download the required folders.
The following procedures describe the available actions that you can perform in the Folder manager:
 Uploading the Control-M/EM data to Control-M/Servers (on page 325)
 Downloading the Control-M/Server data to Control-M/EM (on page 325)
 Ordering a folder (on page 325)
 Deleting a folder (on page 326)
 Assigning a Site standard to a folder/folders (on page 326)
 Enforcing validations (on page 327)

324
Control-M User Guide

Uploading the Control-M/EM data to Control-M/Servers


This procedure describes how to upload the Control-M/EM data to all Control-M/Servers, which
synchronizes all jobs in the system by overwriting the job definitions in Control-M/Server with the data
from Control-M/EM.

 To upload the Control-M/EM data to Control-M/Servers:


1. From the Tools domain, select Folder Manager.
The Folder Manager appears.
2. Select all folders and click Upload.
A confirmation message appears.
3. Click OK.
You can also set synchronization levels, as described in Configuring Control-M/Server synchronization.

Downloading the Control-M/Server data to Control-M/EM


This procedure describes how to download the Control-M/Server data to Control-M/EM, which
synchronizes all jobs in the system by overwriting the job definitions in Control-M/EM with the data from
Control-M/Server.
Downloading the data populates Control-M/EM version 8.0.00 with the corrections that you performed
manually in Control-M/Server as outlined in the Readiness report messages, enables you to control jobs in
the Control-M/EM Active Jobs (for example, a request for job order or rerun). However, if the folders in
Control-M/Server are not fully synchronized with those in Control-M/EM (that is, there are jobs that reside
only on one side, or corresponding jobs on both sides that are not identical), the download operation
overwrites the definitions in Control-M/EM with those from Control-M/Server.

 To download the Control-M/Server data to Control-M/EM:


1. From the Tools domain, select Folder Manager.
The Folder Manager appears.
2. Select all folders and click Download.
A confirmation message appears.
3. Click OK.
You can also set synchronization levels, as described in Configuring Control-M/Server synchronization.

Ordering a folder
This procedure describes how to order a folder, which executes all the jobs in the folder. You need to
manually order a folder if the Order Method is set to None.

 To order a folder:
1. From the Tools domain, in the Planning area, select Folders.
The Folder manager appears.
2. Select the folder that you want to order and click Order.

325
Control-M User Guide

The Order dialog box appears.


3. Select one or more parameters, as described in Order parameters (on page 89).
4. Click Order.
The progress of the order appears in the Action Report. The status of ordered folders is set to
WAIT_SCHEDULING (SMART folders only).

Deleting a folder
This procedure describes how to delete a folder in the Folder manager.
 To delete a folder:
1. From the Tools domain, in the Planning area, select Folders.
The Folder manager appears.
2. Select the folder that you want to delete and click Delete.
A confirmation message appears.
3. Click Yes.
The folder is deleted.

Assigning a Site standard to a folder/folders


This procedure describes how to assign a Site standard to a folder/folders from the Folder tool.
For more information on Site standards, see Site standards management (on page 314).

 To assign a Site standard to a folder/folders:


1. From the Tools domain, select Folders.
The Folders tab appears.
2. Do one of the following:

• If you want to assign a Site standard to one folder, select the folder, and click .

• If you want to assign a Site standard to multiple folders, select all folders, and click .
The Set Site standard window appears.
3. Do one of the following:
• If you selected one folder, do the following:
a. From the Site standard drop-down list, select the Site standard.
b. Select the Business parameters, if any, and assign the value.
• If you selected more than one folder, do the following:

326
Control-M User Guide

c. Select the Site standards and Business Fields area check-box, and then select the Site
standard from the drop-down list, and set the value for the Business parameter.
The Site standard is set.

Enforcing validations
This procedure describes how to enforce validations on a folder/folders from the Folder tool, which
enables you to make sure all validation errors are fixed.

 To enforce validations:
1. From the Tools domain, select Folders.
The Folders tab appears.
2. Do one of the following:

• If you want to enforce validation to one folder, select the folder, and click .

• If you want to enforce validation to multiple folders, select all folders, and click .
The Set Site standard window appears.
3. Do one of the following:
• If you selected one folder, do the following:
a. Select Enforce Validations, if you want to enforce resolving validation errors that might
occur while defining the folder. Warnings appear as errors that cannot be ignored.
• If you selected more than one folder, do the following:
b. Select the Enforce Validations area check-box, and then select Enforce Validations,if you
want to enforce resolving validation errors that might occur while defining the folder.
Warnings appear as errors that cannot be ignored.
The enforce validation was assigned to the folder/folders.

Templates
Control-M comes with sample job and SMART Folder templates for supported platforms, which you can
use as a basis for developing your own templates.
Different jobs can have the same values for many parameters. To make the process of defining jobs
easier, you can define the common values in a template, and use the template to place those values into
the job processing definitions. Templates can be useful whether you are creating job processing
definitions one at a time or creating large numbers of job processing definitions, all at the same time.
You can also define SMART Folder templates, which can be used for creating SMART Folders, and for
defining jobs within the SMART Folder, and you can also apply the SMART Folder template to a specific
job or folder.
The following procedures describe how to create,copy, and delete templates from the Template manager:

327
Control-M User Guide

 Creating a job template (on page 328)


 Inserting functions into a template (on page 328)
 Copying a template (on page 330)
 Deleting a template (on page 330)

Creating a job template


This procedure describes how to create a job template, which enables you to define the common values
in a template, and use the template to place those values into the job processing definitions. Templates
can be useful whether you are creating job processing definitions one at a time or creating large numbers
of job processing definitions, all at the same time.

 To create a job template:


1. From the Planning domain, select a job that you want to use as a template.

2. In the Workspace group, select .


3. In the Template Name field, type a name for the template and click OK.
The template appears in the Template Manager.

Inserting functions into a template


This procedure describes how to insert functions into a job template that get resolved when the template
is used to create job processing definitions.
When using a template to create many jobs beginning with the same name, you can add a counter
function after the name prefix in the template’s Job Name field, to ensure that each job is
created with a unique name.
 To insert functions into a template:
1. Create a job template, as described in Creating a job template (on page 328).
2. For each field that you want insert a function, type the name of the function, as described in
Template functions (on page 329):
a. To use the value from another field, type {Field Name}.
b. To insert a counter, type {Counter}.
c. To insert a substring, type {Substr}.
d. To add or subtract a value to a numeric function, type {+} or {-}, the source of the value, and
the quantity to add or subtract.
The template requires the following values to jobs (along with other values not included in the
example):
• A job name of APXYn, where n is incremented by 1
• A file name of jobname.bat
In the following template fields, define the following indicated values and functions:

328
Control-M User Guide

• In the Job Name field: APXY{Counter}


• In the File Name field: {Job Name}.bat

Template functions
The following table lists valid functions for use in a template.

Function Description

{Field Name} Defines the name of a field in the job or group processing
definition.
To indicate the Mem Name of the FromJob and ToJob, specify
{Mem Name}-{ToJob[Mem Name}

{Counter} Incremental number to be inserted in the value


This job is Job # {Counter}

{+ | -|*{numerical field| Indicates an amount to increment, decrement, or multiply a


function},quantity to add or number in the condition name format. This function can be used
subtract} to reference a previous or subsequent job.
Job#{-{Counter},1}-ENDED)

{Substr Indicates a substring from a specified field or function, as follows:


position.length,{fieldname |
function}}
 position: Offset of the substring within the field/function
(zero-based)
 length: Determines the number of characters
 fieldname: Defines the name of the field
 function: Defines the name of the function
To indicate the first two characters of Mem Name, specify {Substr
0.2,{Mem Name}}.

Editing a job template


This procedure describes how to edit a job template, which enables you to define the common values in a
template, and use the template to place those values into the job processing definitions. Templates can
be useful whether you are creating job processing definitions one at a time or creating large numbers of
job processing definitions, all at the same time.

 To edit a job template:


1. From the Tools domain, in the Planning area, select Templates.
The Template Manager appears.

329
Control-M User Guide

2. Select the template that want to edit ad click .


3. Edit the fields that you want to change and click Save Template.

Copying a template
This procedure describes how to copy a template from the Template manager, which enables you to
create another template without having to type and select the required criteria multiple times.
This option is only available after you have created at least one template. You cannot duplicate pre-
defined templates.
 To copy a template:
1. From the Tools domain, in the Planning area, select Templates.
The Template Manager appears.
2. Select the template that want to copy.
3. From the Templates menu, select Duplicate.
4. In the Name field, type a different name for the template, and click Save Template.
The Templates properties pane appears on the right.
5. Edit the template as needed.
6. Click Save Template.

Deleting a template
This procedure describes how to delete a template from the Template manager. After the template is
deleted, it will not appear in the Template Manager or the Jobs Palette.

 To delete a template:
1. From the Tools domain, in the Planning area, select Templates.
The Template Manager appears.
2. Select the template that you want to delete and click Delete.
A confirmation message appears.
3. Click Yes.
The template is deleted.

Promotion rules
Control-M Workload Change Manager promotion feature enables you to automatically transfer folders and
jobs between environments. When promoting data from one environment to another, values are changed
and checked according to promotion rules.
Creating promotion rules enables you to define the following promotion environments:

330
Control-M User Guide

 Source environment: Defines the Control-M environment where you want to move the folder and
jobs from.
 Target environment: Defines the Control-M environment where you want to move the folder and
jobs to.
Once you have finished working on a job definition in the source environment, you can move the folders
and jobs to the target environment, while the data is automatically transformed according to your
predefined promotion rules. For more information about promoting a folder, see Promotion (on page
229).
NOTE: Promotion rules need to comply with site standards of the target environment, as promoted
folders and jobs are validated according to the assigned site standard before they are sent to the target
environment. For more information, see Site standards management (on page 314).
The following procedures describe how to create and delete Promotion rules:
 Creating a promotion rule (on page 331)
 Deleting a Promotion rule (on page 334)
You can also add, edit or delete a promotion environment using the Edit Environments button in the
Promotion Rules ribbon. The following procedures describe how to create, edit and delete a promotion
environment:
 Creating a promotion environment (on page 334)
 Editing a promotion environment (on page 335)
 Deleting a Promotion environment (on page 335)

Creating a promotion rule


The following procedure describes how to create Promotion rules which enable you to define the
promotion environments (the source and the target Control-M environments) and the transfers that are
applied to job definitions when promoting jobs from one environment to another.

Before you begin


Ensure that Workload Change Manager is activated.

 To create a Promotion rule:


1. From the Tools domain, in the Planning area, click Promotion Rules.
The Promotion Rules tab appears.

2. To add a promotion rule, click .


The New Promotion Rule appears in the left pane and details are populated in the right pane.
3. (optional) From the right pane, in the Description field, add a description for your promotion rule.

4. In the Source field, click to add the environment where want to move the folder from.
The Add Environment window appears.
NOTE: The source environment definition is used to automatically identify which environment a folder
belongs when performing promotion.

331
Control-M User Guide

If you have already defined a source environment, from the drop-down list, select the environment
where you want to move the folder from and continue with step 6.
5. From the Add Environment window do the following:
a. In the Environment Name field, type the logical name of the source environment that you want
to move the folder from.
b. In the Control-M Server field, from the drop-down list, select the Control-M Server of your
environment.
NOTE: If you do not want to select a particular Control-M Server select All.
c. To filter the folders that you want to promote, in the Folder name field, from the drop-down list,
select either the Starts with or Ends with and type the characters you want to start/end with.
NOTE: Leave blank if you do not want to filter your folders.
d. Click Add.

6. In the Target field, click to add the environment you want to move the folder to.
The Add environment window appears.
NOTE: If you have already defined a target environment, from the drop-down list, select the
environment where you want to move the folder to.
7. From the Add environment window do the following:
a. In the Environment Name field, type the logical name of the target environment that you want
to move the folder to.
b. In the Enterprise Manager field from the drop-down list, select one of the following:
o Local: Defines an environment in the same Control-M/EM.
o Remote: Defines an environment as a different Control-M/EM.
c. (Remote Only) Complete the Remote environment parameters (on page 333) and click Test
Connection.
NOTE: When you click Test Connection, Control-M attempts to connect to the naming server with
the supplied host and port.
d. In the Control-M Server field, from the drop-down list, select the Control-M server of your
target environment.
NOTE: If you do not want to select a particular Control-M Server select All.
e. In the Folder name field, from the drop-down list, select either Starts with or Ends with and
type the character you want to start/end with.
NOTE: Leave blank if you do not want to change the Folder Name.
f. Click Add.
NOTE: The promotion rule name is automatically generated.
8. To add modification settings, see Adding modification settings (on page 333).
NOTE: You must set up one transformation rule.
The Promotion Rule is now set up. You can now promote folders, as described in Promotion (on page
229).

332
Control-M User Guide

NOTE: Once you have created and saved the Promotion Rule you can edit the rule. If you want to
change a promotion environment, see Editing a promotion environment (on page 335).

Remote environment parameters


The following table describes the Remote environment parameters.

Parameter Description

Naming Server Host Defines the host name of the remote Control-M/EM target
environment naming server.

Naming Server Port Defines the naming port of the remote Control-M/EM target
environment naming server.

User Name Defines the user name in the target environment. Mandatory for
defining a remote environment.

Password (optional) Defines the password associated with the user name in
the target environment which is used only for promotion requests.

Adding modification settings


The following procedure describes how to add modification settings for promotion so that the transfer
rules can be applied for every job or folder.
NOTE: When using site standards, the promoted Jobs are validated according to the assigned site
standard before the folder is checked in to the target environment. For more information, see Site
standards management (on page 314).

 To add Modification settings:


1. From the Modification Settings field, click .
The field below is populated.
2. Click Suggest Settings to suggest settings for transformation.
3. Add the rules that you want. For more information about the rules, see Step 3 in Updating jobs and/or
folders (on page 207).
NOTE: When you define a new environment, some settings are based on environment definitions,
such as folder name and Control-M/Server properties.
EXAMPLE: Suggested settings for folder name
If the source environment, Testing, the folder name starts with "Test" and in the target
environment, the folder starts with "Prod", the modification setting suggests that the
folder name that starts with Test is replaced by Prod.
EXAMPLE: Suggested settings for Control-M/Server

333
Control-M User Guide

If the source environment Testing is defined in Control-M/Server as DC1 and the target
environment, Production, is defined as DC2, Control-M/Server DC1 is assigned the value
DC2.

NOTE: You can delete the rule by highlighting the rule and clicking . You can also change the rule
priority by clicking the up and down arrows.

Deleting a Promotion rule


This procedure describes how to delete a promotion rule, which has been added in the Promotion Rules
tab.
 To delete a Promotion rule:
1. From the Tools domain, in the Planning area, click Promotion Rules.
The Promotion Rules tab appears.
2. Select the Promotion Rule that you want to delete.

3. From the Promotion Rules ribbon, click .


A confirmation window appears.
4. Click Yes to delete the rule.
The Promotion Rule is deleted.

Creating a promotion environment


This procedure describes how to create a new promotion environment. You can add a Source and Target
environment.
 To create a new environment:

1. From the Promotion Rules tab, click .


The Edit Environments window appears.

2. From the Environments window, click .


a. In the Name field, type the name of the environment that you want to move the folder to or
from.
b. (Target environment only) In the Enterprise Manager field from the drop-own list, select one of
the following:
o Local: Defines an environment in the same Control-M/EM.
o Remote: Defines an environment as a different Control-M/EM.
c. (Remote Only) Complete the Remote environment parameters (on page 333) and click Test
Connection.
d. In the Control-M Server field, from the drop-down list, select the Control-M Server of your
environment.

334
Control-M User Guide

NOTE: If you do not want to select a particular Control-M Server, select All.
e. In the Folder name field, from the drop down list select either Starts with or Ends with and
type the character you want to start/end with.
3. Click Save and then Close.
The Environment is now added to your list of environments.

Editing a promotion environment


This procedure describes how to edit a promotion environment.
 To edit an environment:

1. From the Promotion Rules tab, click .


The Environments window appears.
2. Select the rule you want to edit.
3. Change the parameters as required. For more information, see Creating a promotion environment (on
page 334).
4. Click Save and then Close.

Deleting a Promotion environment


This procedure describes how to delete an environment.
 To delete an environment:

1. From the Promotion Rules tab, click .


2. Select the environment you want to delete.

3. Click .
A confirmation window appears
4. Click Yes.
The Environment is now deleted.

Calendar management
Calendars enable you to define a set of scheduling criteria and then apply those criteria to job schedules
by specifying the calendar name in the job definition, which saves having to define those sets of criteria
individually in each job.
You define, view, edit, delete, or calendars based on specific scheduling criteria that are used to define
scheduling in a job definition from the Tools domain. If you want to use a predefined calendar when
defining a job, it must be checked into Control-M.

335
Control-M User Guide

You can create one of more of the following calendar:


 Regular calendars: Enables you to create a predefined calendar based on certain dates (the days of
the month and/or the days of the week) in a selected year. Other scheduling parameters can be used
with a regular calendar to further control the dates on which the job is ordered. To create a regular
calendar, see Creating a regular or relative calendar (on page 336).
 Relative calendars (Control-M for z/OS only): Enables you to create alternative scheduling dates,
even if they are not scheduled in a calendar, as described in Creating a regular or relative calendar
(on page 336). In a Relative calendar, the specified date has + or - to indicate how to handle when
the marked date is scheduled or not, as one follows:
• Scheduled: Schedule the date in the relative calendar.
• Not scheduled: Schedule the closest next date (+) or the closest previous date (-).
You can use Relative calendars to combine calendars through the Control-M IOABLCAL utility, as
described in Control-M for z/OS User Guide.
 Periodic calendars: Enables you to create a predefined calendar based on different calendar
periods that you define. Periodic calendars are used to divide the year into working periods (for
example 13 periods, 20 periods and so on) instead of 12 months. Periods can be nonconsecutive, of
varying length, and overlapping, but no single period can exceed 255 days. To create a periodic
calendar, see Creating a periodic calendar (on page 338).
 Rule-based Calendars: Enables you to create a predefined calendar based on specific rules,
independent of specific years. These calendars can apply over several years, as they do not need to
be redefined each year. Rule Based Calendars give you flexibility to address different scenarios. For
example, if you want to run a job at the end of each month, you need to create a Rule Based
Calendar, otherwise if you select 31 at the end of each month, it is not correct as there are months
with less than 31 days. To create a Rule based calendar, see Creating a Control-M Rule-based
Calendar (on page 66).
When defining a calendar, you can create global calendars for all Control-M Servers by selecting ALL in
the Control-M Server field. For example, if have a number of Control-M/Servers and you do not want a
job to run on public holidays, create a global rule based calendar for all of your Control-M/Servers.
After you have checked in the calendar, the calendar is synchronized with Control-M Server. If you have
selected a global calendar, you can check the synchronization status of each Control-M/Server. For more
details about synchronization status, see Synchronization status parameters (on page 341).
If Control-M/Forecast is installed, you can display when and how often jobs are scheduled by clicking
View Schedule. For more information on validating your job definition, see Forecast (on page 290).
If Control-M/Forecast is not licensed at your site, you can use the CTMRPLN utility to produce a report
that indicates when jobs in a selected calendar are scheduled to run. For more information, see ctmrpln
and the Control-M for z/OS User Manual.

Creating a regular or relative calendar


This procedure describes how to create a calendar based on the days of the month and/or the days of the
week. You can also create a relative calendar (only for z/OS), which enables you to schedule closest
scheduled dates in the calendar to the marked dates on the relative calendar.

336
Control-M User Guide

 To create a regular or relative calendar:


1. From the Tools domain, in the Planning area, click Calendars.
2. Click New and then click Regular Calendar.
The Calendar window appears.
3. In the Calendar Name field, type the name of the calendar.
NOTE: For distributed systems this must not exceed 30 characters. For Mainframe, no lower case,
but must not exceed 8 characters and no white spaces.
4. From the Control-M Server drop-down list, select the Control-M/Server or All.
All refers to all Control-M Servers, both distributed and mainframe systems. The calendar name must
adhere to the validation criteria of calendar name for both systems.
5. (Mainframe only) In the Alias field, add a valid calendar name.
6. In the Description field, describe details about the calendar.
7. (Control-M for z/OS only) In the Relative area, select alternate scheduling dates for the specified
dates that are not scheduled in a calendar, as follows:
• If you want the job to run after the scheduled date, click +.
• If you want the job run before the scheduled date, click -.

• If you want to clear relative dates, click


NOTE: For specified dates that are scheduled in the calendar, the scheduled dates remains. You can
use Relative calendars to combine calendars through the Control-M IOABLCAL utility. For more
information, see the Control-M for z/OS User Guide.
8. Do one of the following:
• In the calendar, select the days that you want the job to run.
• Click Recurrence and from the Recurrence View Mode dialog box do the following:
a. Select the Month days and/or Week days that you want the job to run.
b. From the Apply on drop-down list, select the years that you want the Month Days and/or
Week Days applied for the selected period.
c. Click OK.
9. Click OK.
The calendar is created and appears in the calendar table.
10. If you want to make the calendar available for scheduling, select the calendar and click Check in.

11. If the Control-M Server is set to All, under Synchronization State click the button.
The Synchronization Status table appears which includes the list of Control-M Servers and their
synchronization state, as described in Synchronization status parameters (on page 341).

337
Control-M User Guide

The calendar synchronizes in the Definitions database. If your synchronization setting is set to No
Synchronization, (see Configuring Control-M/Server synchronization), you can upload the calendar
to Control-M/Server by clicking Upload drop-down list, and selecting Upload (to upload calendar to
Control-M/Server) or Force Upload (same as Upload, but override changes).

Creating a periodic calendar


This procedure describes how to create a periodic calendar, which is a pre-defined calendar based on
different calendar periods that you define. The periods can be nonconsecutive, of varying length, and
overlapping. No single period can exceed 255 days.

 To create a periodic calendar:


1. From the Tools domain, in the Planning area, select Calendars.
2. Click New and then click Periodic Calendar.
3. In the Calendar Name field, type the name of the calendar.
NOTE: For distributed systems, it must not exceed 30 characters. For Mainframe, no lower case, but
it must not exceed 8 characters and no white spaces.
4. From the Control-M Server drop-down list, select the Control-M/Server or All. All refers to all
Control-M Servers, both distributed and mainframe systems. The calendar name must adhere to the
validation criteria of calendar name for both systems.
5. (Mainframe only) In the Alias field, add a valid calendar name.
6. In the Description field, describe details about the calendar.
7. Select a period (A-Z, 1-9) to assign the calendar definition.
8. Do one of the following:
• In the calendar, select the days that you want the job to run for the selected period.
• Click Recurrence and from the Recurrence View Mode dialog box, do the following:
a. Select the Month Days and/or the Week Days that you want the job to run for the selected
period.
b. From the Apply on drop-down list, select the years that you want the Month Days and/or
Week Days applied for the selected period.
c. Click OK.
9. If you want to add additional periods, repeat steps 7 and 8.
10. Click OK.
The periodic calendar is created and appears in the calendar table.
11. If you want to make the calendar available for scheduling, select the calendar and click Check in.

If the Control-M Server is set to All, under Synchronization State click the button.
The Synchronization Status table appears which includes the list of Control-M Servers and their
synchronization state, as described in Synchronization status parameters (on page 341).

338
Control-M User Guide

The calendar synchronizes in the Definitions database. If your synchronization setting is set to No
Synchronization, (see Configuring Control-M/Server synchronization), you can upload the calendar
to Control-M/Server by clicking Upload drop-down list, and selecting Upload (to upload calendar to
Control-M/Server) or Force Upload (same as Upload, but override changes).

Rule-based Calendar and Excluded Rule-based Calendar lists


Jobs, sub-folders, and SMART folders can use specific Rule-based Calendars by using the Using Specific
Rule-based Calendar scheduling option, which enables you to add pre-defined Control-M Rule-based
Calendars to lists, add pre-defined Folder Rule-based Calendar, or add and define a Folder Rule-based
Calendar. However, for jobs that are in regular folders, the specific combination is different than for jobs
in SMART folders. Also, the sub-folders have different scheduling options than SMART folders, as
described in Specific Rule-based calendar scheduling (on page 339).
You can define Rule-based Calendars (RBCs) to set the dates that will be scheduled (included RBCs) in a
job, sub-folder, and SMART folder, by adding and selecting the RBCs for the Rule-based Calendar list.
The defined RBCs can also be used to set the dates that will not be scheduled (excluded RBCs) in a job,
sub-folder, and SMART folder, by adding and selecting RBCs for the Excluded Rule-based Calendar list, as
described in Scheduling a job/folder.
The scheduling of a job with included RBCs and excluded RBCs is determined by combining the specified
days of the included RBCs, combining the specified days of the excluded RBCs, and then removing the set
of the excluded RBCs from the set of the included RBCs.
EXAMPLE: If a job’s RBC list is {Everyday} and the job’s excluded RBC list is {Weekends, Holidays},
the resulting schedule is that the job will run on every day that is not a weekend and not a
holiday.
For more examples, see Rule Based Calendar examples (on page 67).
In some screens in the application, excluded RBCs are indicated with the ! character preceding the RBC
name, as in !Mondays. A job can have 0 or more excluded RBCs. If no included RBC are specified, then
the set of scheduled days is empty.
You can select from an excluded RBC list for jobs, sub-folders, or SMART folders in a Control-M/Server
where the feature is enabled. The RBC name must not start with the ! character, for Control-M version
8.0.00 fix pack 1 and later.
The Excluded RBC feature is enabled in Control-M version 8.0.00 fix pack 1 for each specific Control-
M/Server or Control-M for z/OS version 8.0.00 fix pack 1 or later, where the Excluded RBC feature is
enabled. For more information about enabling the feature, contact your Control-M Administrator.

Specific Rule-based calendar scheduling


The following combinations affect how the scheduling works:
 Job in a regular folder: Scheduled according to their individual scheduling criteria. Jobs can also
inherit scheduling rules from Control-M RBCs.
The jobs can be scheduled by adding to the following lists:
• Rule-based Calendars List: Scheduled according to selected Control-M RBCs that you can add
to the RBC list.

339
Control-M User Guide

• Excluded Rule-based Calendars List: Scheduled according to selected Control-M RBCs that
you can add to the list of excluded RBCs.
 Job in a SMART Folder: Scheduled according to AND or OR relationship with the parent SMART
folder. The job can be scheduled according to the parent RBC. You can also schedule by adding RBCs
to the following lists:
• Rule-based Calendars List: Schedules according to selected Folder RBCs that are in the RBC
list.
• Excluded Rule-based Calendars List: Schedules according to Control-M RBCs that you add to
the list to exclude the order dates.
 Sub-folders in a SMART Folder: Scheduled according to the parent RBC or by adding to the
following lists:
• Rule-based Calendars List: Scheduled according to selected Folder RBCs that are in the RBC
list.
• Excluded Rule-based Calendars List: Scheduled according to Control-M RBCs that you add to
the list of excluded RBCs, which exclude the order dates from the schedule.
 SMART Folder: Scheduled according to Folder RBCs or Control-M RBCs that you add to the following
lists:
• Rule-based Calendar List: Scheduled according to the Folder RBCs that you define for the
SMART folder or Control-M RBCs that you select.
• Excluded Rule-based Calendar List: Scheduled according to the Folder RBCs that you define
for the SMART folder or Control-M RBCs that you add to the list of excluded RBCs, which exclude
the order dates from the schedule.
For more information on creating Control-M Rule-based Calendars, see Creating a Control-M Rule-based
Calendar (on page 66). For examples, see Rule Based Calendar examples (on page 67).
For more information on creating Folder Rule-based Calendars, see Defining a Folder Rule-based Calendar
(on page 95).

340
Control-M User Guide

Synchronization status parameters


The following table lists the Synchronization status parameters. These parameters show if the calendar
successfully uploaded to the Control-M Server.

Parameter Description

Control-M Server Defines the name of the Control-M Server which is


synchronized/not synchronized with the calendar.

Type Defines the calendar type.

Synchronized State Indicates if the calendar successfully uploaded to the Control-M


Server. If uploaded, the state shows Synchronized, if not the state
shows Not Synchronized.

Last Synchronized Defines the date and time of the last time the calendar was
uploaded to the Control-M Server.

Synchronization Message Indicates issues related to the Control-M Server not synchronized.

Duplicating a calendar
This procedure describes how to duplicate a calendar, which saves you time from creating another
calendar with the same definitions.

 To duplicate a calendar:
1. From the Tools domain, in the Planning area, select Calendars.
2. Select a calendar that you want to duplicate.
3. Click Duplicate.
A confirmation message appears.
4. Click Yes.
A new calendar appears in the table with the same definitions.

Deleting a calendar
This procedure describes how to delete a calendar.

 To delete a calendar:
1. From the Tools domain, in the Planning area, select Calendars.
2. Select a calendar that you want to delete.
3. Click Delete.

341
Control-M User Guide

A confirmation message appears.


4. Click Yes.
The calendar is deleted.

Control Resource management


Control Resources are user defined variables representing a physical or logical device in a Control-M
installation. Control Resources that are characterized by the control that a job needs over them. For each
job you can specify exclusive or shared access to the resource. The job is not ordered unless the Control
Resource is available in the required state (exclusive or shared). If the resource is shared, other jobs can
use the resource concurrently, while jobs with exclusive resources cannot. Control-M 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. Examples of Control Resources can include files, disk drives, tables, and databases.
The purpose of a Control Resource is provide exclusive access to resources for a job. This ensures jobs
that cannot share the resource do not run at the same time.
Control Resources are normally defined when creating a job in the Planning domain, as described in
Control resources (on page 75).
From the Tools domain, in the Control Resources window, you can do the following:
 Monitor the active Control Resources that are in use.
You can see the defined Control Resources when a job is executing, which are automatically deleted
from the window after jobs have completed. To view which jobs or folders are using the Control
Resources, click View Jobs/Folders.
 View and create Control Resources, which prevent jobs with exclusive or shared Control Resources
from running, as described in Creating a control resource (on page 342).
EXAMPLE: If you have jobs scheduled that use an Exclusive resource that corresponds to tape
drive A and that tape drive is temporarily out of service, you can manually define this
resource to prevent all such jobs from running. All jobs running the Control Resource tape
drive A do not run.
 Filter the display criteria.
 In the Priority field, view whether the job is critical.
 In the Counter field, view the number of jobs using the resource.
 In the Workload Policies field, view any Workload Policies in use. For more information about
Workload Policies, see Workload Policy Definition (on page 377).
NOTE: If you select Auto Refresh, the Control Resource window is automatically refreshed.

Creating a control resource


This procedure describes how to create a Control Resource in the Tools domain, which prevents jobs
with the same defined Control Resource from running. To prevent the Control Resource from running, it
must match the defined Control Resource for the job. For more information about defining a Control
Resource for a job see Control resources (on page 75).

342
Control-M User Guide

 To create a control resource:


1. From the Tools domain, in the Production Control area, click Control Resources.
2. From the Control Resources ribbon, click Add Resource.
3. Do the following:
a. In the Resource Name field, type a name for the resource.
b. From the Type drop-down list, select one of the following:
o Shared: Enables the resources to be shared by a number of jobs
o Exclusive: Enables the resources to be owned exclusively by one job
c. From the Control-M Server drop-down list, select the Control-M/Server that hosts the resource.
4. Click Save.
The resource appears in the Control Resources list, which prevents the job that contains the Control
Resource from running. You can delete the Control Resource by clicking Delete Resource in the
Control Resources tab.

Quantitative Resource management


A quantitative resource represents a measure that can be quantified such as percentage of CPU,
megabytes of storage, or number of tape drives. It provides the ability to avoid overwhelming the physical
and logical resources in an environment by limiting the number of jobs that use the same resource at the
same time.
There are 2 parts to the process:
 From the Tools domain, in the Quantitative Resource window, you define the total quantity of
Quantitative Resources for relevant Control-M/Servers.
 In the Job Properties, you define how much of that resource should be used in the jobs running on
that Control-M/Server. To define a quantitative resource for a job, see Allocating a control resource
(on page 76).
EXAMPLE: Control-M has three tape drives available. A job called BKP_Tallies requires one tape drive.
To enable Control-M to handle this correctly, do the following:
• Using the Quantitative Resources window in the Tools domain, define the
quantitative resource TapeDr having a quantity of 3.
• In Job Properties, when defining the job BKP_Tallies, specify 1 of TapeDr.
Whenever a job using TapeDr is submitted, Control-M drops the currently available quantity of the
resource by the quantity the job uses, until the job ends. Control-M only submits
BKP_Tallies if there is at least one TapeDr available.
When a Quantitative Resource is specified for a job, Control-M determines whether a sufficient quantity of
the specified resource is available is before submitting the job. When the job is submitted, the specified
quantity of resource is assigned to that job and is not available to other jobs. When the job finishes
executing, the resource is made available to other jobs. For more information, see Quantitative Resources
in Parameters.
In the Quantitative Resources window you can view the following:

343
Control-M User Guide

 All the quantitative resources that currently exist or are in use in the production environment.
 Create a quantitative resource for a Control-M/Server as described in Creating a quantitative resource
(on page 344).
 Filter the display criteria
 The total number of quantitative resources that are being used
 View the following Types that you create:
• Defined: Indicates information about the resource. Only a single definition entity exists per
resource. This entity is added when you define a new Quantitative Resource.
• In Use: Indicates that the resource is being used by a job. An In Use entry exists for each job
that is currently using the resource.
• Requested: Indicates that the resource has been requested by a critical job.

Creating a quantitative resource


This procedure describes how to create a quantitative resource for a Control-M/Server, which is then used
to allocate resources according to the job definition.

 To create a quantitative resource:


1. From the Tools domain, in the Production Control area, select Quantitative Resources.
2. From the Quantitative Resources ribbon, click Add Resource.
3. Do the following:
a. In the Resource Name field, type a name for the resource.
b. From the Control-M Server drop-down list, select the Control-M/Server that hosts the resource.
c. In the Max field, select the maximum quantity of this resource that can be used by jobs
concurrently.
EXAMPLE: If the Max field = 12 and Job1 requires 4, Job2 requires 5, and Job3 requires 10, then
Job1 and Job2 can run together. Job3 cannot run concurrently with one of the other jobs.
4. Click Save.
The resource appears in the Quantitative Resource list.

Conditions management
Usually conditions are defined when creating a job in the Planning domain. A predecessor job creates a
prerequisite condition upon completion that is required for a successor job to be submitted. For more
information about conditions, see In Conditions (on page 73) and Job dependencies.
From the Tools domain, in the Conditions window, you can do the following:

344
Control-M User Guide

 Monitor the active conditions that are in use.


 View the defined conditions when a job is executing, which are automatically deleted from the
window after jobs have completed.
 Create conditions.
You can add a condition in the Conditions window when a job depends on a condition that does not
apply to other jobs. Not all prerequisite conditions are added by jobs. When Control-M must know the
status of something outside its control, you can add a manual condition to notify Control-M of the
status. To add a Condition, see Creating a condition (on page 345)
EXAMPLE: A backup job might require that a tape be physically loaded on a tape drive before the job
can be submitted. To handle this, you can define in the job processing definition an In
prerequisite condition (such as Tape Loaded) that is not added by another job, but rather,
manually, by the operator, after physically loading the tape drive.
 Filter the display criteria.
Each condition includes information such as the name, order date of the conditions and Control-M
Server.
NOTE: If you select Auto Refresh, the Conditions window is automatically refreshed.

Creating a condition
This procedure describes how to create a condition in the Conditions window when a job depends on a
condition that does not apply to other jobs.

 To create a condition:
1. From the Tools domain, in the Production Control area, select Conditions.
2. From the Conditions ribbon, click Add Condition.
3. Do the following:
a. In the Condition Name field, type a name for the condition.
b. From the Control-M Server drop-down list, select the Control-M/Server that hosts the condition.
c. In the Order Date area, select one of the following order options:
o Date Selector: The condition is created in the Active Conditions with the date selected.
o Order Date: The condition is created in the Active Conditions with the current order date of
the Control-M/Server.
o No Date: The condition is created with no specific date.
4. Click Save.
The condition appears in the Conditions list.

345
Control-M User Guide

Global Conditions Prefixes


Usually prerequisite conditions are used to establish job dependencies locally, so that they apply on the
Control-M where they are defined. However, you can also define global prerequisites to establish job
dependencies across different Control-M/Servers by defining condition name prefixes that indicate that a
condition is global. For example, you can specify that jobs in Control-M servers in Rome and Paris begin
executing only after successful completion of a job in Sydney.
Global conditions are similar to prerequisite conditions except that their name begins with a prefix that
identifies the conditions as a global condition.
You define the following:
 Prefixes (up to 255 characters) that indicate a condition is a global condition
 From and To Control-M servers for which the global condition prefix is relevant.
Control-M/Server searches for the creation of designated global conditions in From Control-Ms and
identified global conditions are then copied To Control-Ms. When global conditions are deleted in From
Control-Ms, they are automatically deleted in To Control-Ms. By designating the same Control-M
installations as both From and To Control-Ms, you can create bi-directional flows (as opposed to From/To
flows), so any addition or deletion of a global condition in any such installation always results in the
automatic addition or deletion of the global condition in the opposite direction.
The following procedures describe how to create and delete global condition prefixes in the Global
Conditions Prefixes manager:
 Creating a Global Conditions Prefix (on page 346)
 Deleting a Global Conditions Prefix (on page 347)
For a Global Condition example, see Global condition example (on page 348). For best practices, see
Control-M Global Condition Prefixes - best practice.
For more information on setting up dependencies between jobs from different Control-M/Servers, see
Connecting jobs from different Control-M/Servers (on page 82).

Creating a Global Conditions Prefix


This procedure describes how to create a Global Conditions prefix, which is then used to create
dependencies between jobs in different Control-M/Servers.
 To create a Global Conditions Prefix:
1. From the Tools domain, in the Production Control area, select Global Conditions Prefixes.
The Global Conditions Prefixes manager appears.
2. From the Conditions tab, select Add Condition.
A new condition properties pane appears on the Properties pane.
3. Set the fields, as described in Global Condition prefixes (on page 348).
4. Click Save.
The condition prefix appears in the table.

346
Control-M User Guide

Deleting a Global Conditions Prefix


This procedure describes how to delete a global condition prefix in the Global Conditions Prefixes
manager. After the global conditions prefix is deleted, all jobs that require the global conditions cannot
run.

 To delete a Global Conditions Prefix:


1. From the Tools domain, in the Production Control area, select Global Conditions Prefixes.
The Global Conditions Prefixes manager appears.
2. From the Conditions menu, select Delete Condition.
A confirmation message appears.
3. Click Yes.
The global condition prefix is deleted.

347
Control-M User Guide

Global Condition prefixes


The following table describes the prefixes used for defining different global conditions:

Parameter Description

Condition prefix Determines the prefix of the global condition


Length is up to 255 characters long.
Special characters, such as asterisks in this field are treated as text
characters, not wildcards, and unless you intend them as literals,
they might cause undesired results. For example, if you specify
glo* instead of glo as a global prefix, glo*-job1_started will be a
global condition, but not glo-job1_started.
Even truncated strings of the global condition prefixes must be
unique or unpredictable results might occur. For example, do not
define both a DA prefix and a DAY prefix because DA is a substring
of DAY and therefore not unique.

From Control-M Server Determines the Control-M/Server for which the global prefix
apply.
Select one of the following:
 Select Select and specific Control-M/Servers.
 Select All.

To Control-M Server Determines the Control-M/Server to automatically add or delete


the same global condition as set in the From Control-M/Server
field.
Select one of the following:
 Select Select and specific Control-M/Servers.
 Select All.

Global condition example


When sending a global condition with an order date reference to Control-Ms in different time zones, a
problem can arise when target Control-M installations have an earlier current working date than the
source Control-M (as a result of the time zone changes). Such a situation can be problematic due to the
following:

348
Control-M User Guide

 A global condition with Order as its date reference is assigned a date according to the Control-M that
triggers its creation.
 During New Day processing cleanup, when Control-M detects an already existing condition having the
new working date (month and day), it logically assumes that the condition is a holdover from the
previous year because the production jobs that might create this condition during the new working
date have not yet been run, and it deletes the condition. In the event of a temporary communication
failure between Control-M/EM and a Control-M installation, global conditions are accumulated and
transmitted when communication is resumed.
EXAMPLE
Assume the following:
 New day processing in both Rome and San Francisco runs at 6:00 AM local time.
 At 8:00 AM in Rome, a job creates Global Condition: Glo1-RecReady with an order date and sends it
to San Francisco.
 At 9:00 AM in San Francisco, a job requiring that condition awaits submission.
The following occurs at new day in Rome on August 4th.

349
Control-M User Guide

 August 4th at 6:00 AM in Rome: New day processing runs.


 August 4th at 8:00 AM in Rome: Global condition Glo1-RecReady is added with the date 0804. This
global condition is then sent to San Francisco with a date of 0804 (the date the condition was
created). However, the current working date and time in San Francisco when it receives the global
condition is August 3rd, 23:00.
 August 4th 6:00 AM in San Francisco — New Day processing runs. During maintenance, it assumes
that the Glo1-RecReady condition dated 0804 was added last year (because jobs that might have
added the condition today did not run yet), and it deletes the condition.
 August 4th at 9:00 AM in San Francisco— a job in San Francisco waiting for the condition Glo1-
RecReady dated 0804 is not submitted because the condition is already deleted.
The following examples illustrate how global conditions behave in a complex Control-M network. They are
based on information the following table.

Prefix From Control-Ms To Control-Ms

GL1 ROME NY,LA,SF

GLALL * PARIS, SYDNEY

GLNY NY *

GL2WAY HQ,CENTER1 HQ,CENTER1

 If the GL1_JOB_END prerequisite condition is added in Control-M ROME, the same condition is
automatically added in Control-M installations NY, LA, and SF. The Prerequisite Conditions window
displays four different conditions called GL1_JOB_END, each belonging to a different Control-M
(ROME, NY, LA, and SF).
 However, if this condition is added in any Control-M other than ROME, it is not automatically
duplicated in other Control-M installations. If Control-M NY adds the condition GL1_JOB_END, it will
not be automatically added in ROME (or anywhere else). If the GL1_JOB_END prerequisite condition
is deleted in Control-M ROME, Control-M/EM deletes the GL1_JOB_END prerequisite condition in
Control-M installations NY, LA, and SF (if the condition exists there).
 If the GL1_JOB_END prerequisite condition is created in Control-M ROME but Control-M SF is
disconnected or downloading, Control-M/EM creates this condition in NY and LA only, and sends the
change to SF when SF is able to receive updates.
 If the GLALL_OK prerequisite condition is added or deleted in any Control-M, the condition is
automatically added or deleted in Control-M installations PARIS and SYDNEY. The asterisk (*) in the
From Control-M field indicates all Control-M installations.
 If the GLNY_OK prerequisite condition is added or deleted in Control-M NY, the condition is
automatically added or deleted in all other Control-M installations.
 If a prerequisite condition beginning with the GL2WAY prefix is added or deleted in either Control-M
HQ or CENTER1, the same operation is performed on the corresponding condition in the other
Control-M.

350
Control-M User Guide

Control-M Event Manager


Control-M Event Manager (CMEM) enables Control-M to perform specified actions in response to external
events. External events are events that occur outside Control-M, such as a submission of a job not under
the control of Control-M monitor. CMEM is an optional facility based on a monitor and a subsystem. These
rules are defined in the Tools home page in the Production Control section in Control-M. For more
information about CMEM, see Control-M Event Manager in Control-M for z/OS User Guide.
NOTE: CMEM is only available for z/OS.
CMEM utilizes sets of user-defined rules within a table, which enables you to do the following:
 Specify the conditions under which the rule is to be performed. For more details, see On Statements
(on page 353).
 Enable actions to be performed when the rule is triggered. For more information, see Do Actions (on
page 362).
You can define multiple rules and usually related rules are defined within the same table. A rule may
contain one or more events which may be related to one or more jobs. Once you have created the table,
you can then activate the Table. The Table is loaded to memory and the occurrence of the event specified
in the On Statements trigger the rule. All Do Actions in the rule are then performed.
The following procedures describe how to create, copy, delete and activate a Control-M Event Manager
table or rule.
 Creating a Control-M Event Manager table (on page 351)
 Editing a CMEM table (on page 367)
 Copying a table (on page 368)
 Deleting a table (on page 370)
 Activating a CMEM rule (on page 368)

Creating a Control-M Event Manager table


This procedure describes how to create a new Control-M Event Manager table where you can define,
display and modify parameters of a specific Control-M Event Manager rule.

 To create a Control-M Event Manager table:


1. From the Tools domain, in the Production Control area, click Control-M Event Manager.
The Control-M Event Manager tab appears.
2. In the Control-M Server field, from the drop-down list, select the Control-M Server for z/OS.
3. In the Library field do one of the following:
• From the dropdown list, select a library from the Control-M Server.
• Type the name of the library you want to use.
If you have already defined a table, the table appears.
NOTE: If you have created a number of tables, you can filter the table by typing the details in any of
the fields.

351
Control-M User Guide

4. From the Control-M Event Manager ribbon, in the home tab, click .
The CMEM Table tab appears.
5. In the Table field, type the name of Table.
6. To add a new rule, see Adding a new rule to a table (on page 352).
NOTE: To delete a rule, see Deleting a rule within a table (on page 352).
7. Click Save.

Adding a new rule to a table


This procedure describes how to add a new rule to table.

 To add a new rule:


1. In the CMEM Table tab, click .
2. In the Properties tab, complete the CMEM Properties parameters (on page 353).
3. In the On Statements tab, complete the On statement parameters. For more information about On
Statements, see On Statements (on page 353).
4. In the Do actions tab, complete the Do action parameters. For more information about Do Actions,
see Do Actions (on page 362).
5. Click Save.

Deleting a rule within a table


The following procedure describes how to delete a rule within a table.

 To delete a rule:
 In the CMEM Table tab, highlight the rule and click .
The rule is now deleted.

352
Control-M User Guide

CMEM Properties parameters


The following table describes the CMEM parameters from the Properties tab.

Parameter Description

Owner Defines the user ID requests the CMEM service.

Group Name Defines the group name that the rule belongs to, which is used for
filtering when viewing IOALOG.

Mode Enables you to select the CMEM rule operation mode.


Valid values:
 Production
 Testing
 Logging

Run Time Security Defines the type of runtime security checks to be performed for
the rule.
Valid values:
 None
 Owner
 Trigger
 Default

Threshold Enables you to limit the number of times a rule can be triggered in
one CMEM monitor cycle.

Description Enables you to type a free text description of the rule definition.

On Statements
On statements are events under which the rule is to be performed. On statements are performed
sequentially. For more information about On Statements in Control-M Event Manager, see Types of Events
Managed by CMEM in INCONTROL User Guide.

NOTE: You can add On Statements by clicking on in the On Statements tab. You can delete an On
Statement by clicking next to the On Statement field.
You can select the following On Statements:

353
Control-M User Guide

 Job Arrive: Defines the arrival of a job on the JES spool from any source, such as jobs submitted by
a TSO user or by CICS or jobs received over an NJE network. This occurs when a job is not submitted
by Control-M monitor. For more information about Job Arrive parameters, see Job Arrive parameters
(on page 355).
 Job End: Defines the completion of a job regardless of its source. For more information about Job
End parameters, see Job End parameters (on page 356).
 Step End: Defines the termination of a job step. The step os the lowest part of the a job. For more
information about Step End parameters, see Step End parameters (on page 357).
 DSN Event: Defines the file status and state when the file is released from the job. For more
information about DSN Event parameters, see DSN Event parameters (on page 360).
 Auto Operator Request: Defines a perform request from MainView AutoOperator, when MainView
AutoOperator is installed.
On Statements are connected by selecting one of the following in each of the on statement fields:
 And: Indicates AND logic between the two ON statements
 O: Indicates OR logic between the preceding and following sets of ON statements
 N: Indicates AND NOT logic between the two ON statements
NOTE: If you select one On Statement the selection does not appear.

354
Control-M User Guide

Job Arrive parameters


The following table describes the Job Arrive parameters.

Parameter Description

Job Name Defines the job name that triggers the rule. Mask characters (* an
?) are supported. Mandatory.

Job Type Defines the job type that triggers the rule. Optional. If no value is
entered, the rule can be triggered by any type of job. Default.
Valid Values are:
 Any: If no value is entered, the rule can be triggered by the
termination of any type of job. Default.
 JOB: Regular job
 Started Task: System Task or UNIX Task
 User Task: TSO user task (the user name)
NOTE: * and % are not allowed.

SMF ID Defines the SMF ID of the CPU to monitor for job arrival events.
Optional. Mask characters (* and ?) are supported. Default:
Current CPU.

System Defines the name of the system to monitor for job arrival events.
Mask characters (* an ?) are supported. Default: Current system.

355
Control-M User Guide

Job End parameters


The following table describes the Job End parameters.

Parameter Description

Job Name Defines the job name that triggers the rule. Mandatory.

Job Type Defines the type of job whose termination can trigger the rule.
Optional. Valid Values are:
 Any: If no value is entered, the rule can be triggered by the
termination of any type of job. Default.
 JOB: Regular job
 Started Task: System Task or UNIX Task
 User Task: TSO user task (the user name)
NOTE: * and % are not allowed.

SMF ID Defines the SMF ID of the CPU to monitor for job termination
events. Mask characters (* and ?) are supported. Default: current
CPU.

System Defines the name of the system to monitor for job termination
events. Mask characters (* and ?) are supported. Default: current
system.

356
Control-M User Guide

Step End parameters


The following table describes the Step End parameters.

357
Control-M User Guide

Parameter Description

Job Name Defines the job name (or mask) of the job to be monitored for
step termination. Mandatory.

Job Type Defines the type of job to be monitored for a step termination.
Optional. Valid Values are:
 Any: if no value is entered, the rule can be triggered by the
termination of any type of job. Default.
 JOB: Regular job
 Started Task: System Task or UNIX Task
 User Task: TSO user task (the user name)
NOTE: * and % are not allowed.
NOTE: Only the termination of steps from the specified type of
job can trigger the rule.

SMF ID Defines the SMF ID of the CPU to monitor for data set events.
Mask characters (* and ?) are supported. Default: Current CPU.

System Defines the name of the system to monitor for data set events.
Mask characters (* and ?) are supported. Default: current system.

Program Name Defines the program step name (or mask) to be monitored for this
event for the selected job. Optional. If omitted, all program steps
in the selected jobs are monitored.

Procedure Name Defines a procedure step name (or mask) to be monitored for this
event for the selected job. Optional. If omitted, all procedure
steps in the selected jobs are monitored.

358
Control-M User Guide

Parameter Description

Return Status Determines at which point in the job step and under what
conditions in the job step the Do Statements are preformed.
Valid values are:
 Blank: (default) The rule is executed immediately upon
detection of the specified data set event.
 None-Blank: Execution of the Do Statements is delayed until
the end of the monitored job step and is dependent upon how
the job step ended.
 OK: Step ended with a condition code of 0
 NOTOK: Step ended with a nonzero code
 ****: Step ended with any code
 Cnnnn: Step ended with the indicated condition code
 Snnn: Step ended with the indicated system abend code
 Unnnn: Step ended with the indicated user abend code
Asterisks can be entered instead of code digits; condition codes
and abends can be preceded by code qualifiers (<, >, N).

359
Control-M User Guide

DSN Event parameters


This table describes the DSN Event parameters.

360
Control-M User Guide

Parameter Description

Job Name Defines the jobname name (or mask) of the job to be monitored
for data set events. Mandatory.

Job Type Defines the type of job to be monitored for data set events.
Valid Values are:
 Any: If no value is entered, the rule can be triggered by the
termination of any type of job. Default.
 JOB: Regular job
 Started Task: System Task or UNIX Task
 User Task: TSO user task (the user name)
NOTE: * and % are not allowed.
NOTE: Only a data set event occurring in a job of the specified
type can trigger the rule.

SMF ID Defines the SMF ID of the CPU to monitor for data set events.
Mask characters (* and ?) are supported. Default: Current
CPU.SMFID

DSN Defines the name of data set (or mask) to be monitored for this
event within the selected jobs. Mandatory.

Disposition Defines the data set disposition. Mandatory. The abbreviation


(that is, the first letter) of the desired value can be entered. Valid
values are:
 Cataloged
 Deleted
 Kept
 Retain: Cataloged or kept
 Scratch: Deleted and uncatalogued
 NCT2: Occurrence of a NOT CATLG 2 event – when a data set
was created in a previous job step, but not cataloged at
deallocation because its name already exists in the MVS
catalog
 All: Any of the above dispositions
 Any: Any of the above data set dispositions (including NCT2)

Program Name Defines the program step name (or mask) to be monitored for this
event for the selected job. Optional. If omitted, all program steps
in the selected jobs are monitored.

361
Control-M User Guide

Parameter Description

Procedure Name Defines a procedure step name (or mask) to be monitored for this
event for the selected job. Optional. If omitted, all procedure
steps in the selected jobs are monitored.

Return Status Determines at which point in the job step and under what
conditions in the job step the Do Statements are performed.
Valid values are:
 Blank: (default) The rule is executed immediately upon
detection of the specified data set event.
 None-Blank: Execution of the Do Statements is delayed until
the end of the monitored job step and is dependent upon how
the job step ended.
 OK: Step ended with a condition code of 0
 NOTOK: Step ended with a nonzero code
 ****: Step ended with any code
 Cnnnn: Step ended with the indicated condition code
 Snnn: Step ended with the indicated system abend code
 Unnnn: Step ended with the indicated user abend code
Asterisks can be entered instead of code digits; condition codes
and abends can be preceded by code qualifiers (<, >, N).

Do Actions
Do Actions enable actions to be performed when the rule is triggered, which are performed sequentially.
The following are valid Do Actions:

362
Control-M User Guide

 Do Condition: Enables you to add or delete a prerequisite condition. When a rule containing a DO
COND statement is triggered, the designated prerequisite conditions are added or deleted (as
specified) from the IOA Conditions file by the Control-M monitor. For more information about the Do
Condition parameters, see Do Condition parameters (on page 364).
 Do Resource: Enables you to change the quantity of a Control-M Quantitative Resource. For more
information about Do Resource parameters, see Do Resource (on page 364).
 Do CTD Request: Enables you to force a Control-D Mission, when Control-D is installed. For more
information about CTD Request parameters, see CTD Request parameters (on page 365)
 DO Force Job: Enables you to force a job in Control-M Active Jobs, even if the basic scheduling
criteria of the job are not satisfied. For more information about Do Force Job parameters, see Do
Force Job parameters (on page 366).
 Do Stop job: Enables you to stop executing a current job. The job terminates at the end of the
current step. No other parameters are needed.
Generally all actions from triggered rules are performed except when multiple rules are triggered by the
same job arrival event and each of the triggered rules contains Do Force Statements. Do Force
Statements of the first triggered rule are performed but the Do Force job statements of the other rules
triggered by the event are not performed. For more information, see CMEM Rule Ordering, Triggering and
Deactivation in INCONTROL User Guide.

NOTE: You can add Do Actions by clicking on in the Do Actions tab. You can delete Do Actions by
clicking next to the Do field.

363
Control-M User Guide

Do Condition parameters
The following table describes the Do Condition parameters. For more information, see DO COND: Action
Parameter in the INCONTROL User Guide.

Parameter Description

Name Defines the name of the condition.

Date  Order Date: (ODAT) Resolves to the current installation


working date. Default.
 No Date: (STAT) Indicates that the condition, such as IMS-
ACTIVE is not date-dependent.
 System Date: (DATE) Resolves to the current system date.
 Any Date: (****) All dates. For deleting conditions only. All
matching prerequisite conditions regardless of date are
deleted.
 Specific Date: Enables you to type a specific 6-digit date, in
format mmddyy, ddmmyy, oryymmdd, depending on the site
standard.

Action Indicates whether to add or remove the prerequisite condition.


Valid values:
 Add
 Remove

Do Resource
Do Resource enables you to change the quantity of a Control-M Quantitative Resource. For more
information about Do Resource, see Do Resource: Automated Console Action Parameter in the Control-O
User Guide.

364
Control-M User Guide

The following table describes the Do Resource parameters.

Parameter Description

Name Defines the name of the resource whose quantity is to be changed


(1 through 20 characters). Only trailing blanks are allowed.

Count Defines the quantity to be used to adjust the maximum quantity


of the resource.

Action Modifies the maximum quantity of this quantitative resource that


can be used by jobs concurrently according to one of the following
settings:
 Increase: Increases the quantity
 Decrease: Decreases the quantity
 Set: Sets a new quantity for the resource

CTD Request parameters


CTD Request enables you to force a Control-D Mission, when Control-D is installed. For more information,
see DO CTD REQ: Automated Console Action Parameter in Control-O User Guide.

365
Control-M User Guide

The following table describes the CTD Request parameters.

Parameter Description

Mission Defines the name of a Control-D report decollating mission table.


Mandatory.

Category Defines the Report category. If this field is blank, all reports in the
specified mission table are ordered or forced. Optional.

Date Defines the scheduling date of the job. Mandatory.


Valid values are:
 Order Date: (ODAT) Resolves to the current installation
working date. Default.
 System Date: (DATE) Resolves to the current system date.
 Specific Date: Enables you to type a specific 6-digit date, in
format mmddyy, ddmmyy, oryymmdd, depending on the site
standard.

Force Indicates whether to force the request.


Valid values:
 No: Does not force the request. Order the mission only if the
values specified in the Date field satisfy the mission
scheduling criteria. Default.
 Yes: Forces the request regardless of the Scheduling criteria.

Library Defines the name of the Control-D mission library containing the
specified table. Mandatory.

Do Force Job parameters


Do Force Job action enables you to force a job in Control-M Active Jobs, even if the basic scheduling
criteria of the job are not satisfied. For more information, see DOFORCEJOB: Action Parameter in the
INCONTROL User Guide.

366
Control-M User Guide

The following table describes the Do Force job parameters.

Parameter Description

Folder Defines the name of a folder. Mandatory

Library Defines the name of the scheduling library containing the specified
table. Mandatory.

Job Name Defines the name of the job to be triggered. Optional. If blank, all
jobs in the table are forced.

Date Defines the scheduling date of the job. Mandatory.


Valid values are:
 Order Date (ODAT): Resolves to the current installation
working date. Default.
 System Date: (DATE) Resolves to the current system date.
 Specific Date: Specific Date: Enables you to type a specific 6-
digit date, in format mmddyy, ddmmyy, oryymmdd,
depending on the site standard.

Editing a CMEM table


This procedure describes how to edit a table. Within the table you can edit the rule.

 To edit a CMEM table:


1. Do one of the following:

• From the Control-M Event Manager ribbon, in the Home tab, click .
• Double click the rule you want to edit.
The CMEM Table tab appears.
2. To change the name of the table, in the Table field, type the name of table.
3. To change a rule, highlight rule and do the following:
• In the Properties tab, update the CMEM Properties parameters (on page 353).
• In the On Statements tab, update the On statement parameters. For more information On
Statements (on page 353).
• In the Do actions tab, update the Do action parameters. For more information, see: Do Actions
(on page 362).

4. To add another rule, click and repeat step 3.

367
Control-M User Guide

5. To delete a rule, highlight the rule and click .


6. Click Save.

Copying a table
This procedure describes how to copy a table. If the Table is locked by another user you duplicate the
Table and save it under a different name.
 To copy a CMEM table:

1. In Control-M Event Manager tab, highlight the rule you want to copy, and click .
NOTE: You can also copy the table in the Table tab.
The CMEM Table tab appears.
2. In the Table field, type the name of Table.
3. If you want to change any of the rules follow the procedure in Editing a CMEM table (on page 367).
The table appears in the home tab.
4. Click Save.

Activating a CMEM rule


This procedure describes how to activate a CMEM rule to Control-M/Server. The rule is loaded to memory
and the occurrence of the event specified in the On Statements trigger the rule. All Do Actions in the rule
are then performed.

 To activate a CMEM rule:

 In Control-M Event Manager tab, highlight the table containing the rule to order, and click .
The rule is now activated.

Service definition
Control-M Self Service is a web-based application that enables you to view your services, which are
containers of jobs, and analyze those services and jobs that are problematic. After you have determined
what the problems are, you can resolve them by performing various service and job actions.

368
Control-M User Guide

 Control-M Self Service: If you have the Control-M Self Service Add-on, you can monitor regular
services and perform job actions in Control-M Self Service. If you have the Control-M Batch Impact
Manager Add-on, you can monitor BIM services.
 Service Monitor (on page 268): You can monitor regular services and perform job actions in the
Service Monitor. If you have Control-M Batch Impact Manager, you can view and monitor in-depth
analysis, including projections.
Before you can view services in Control-M Self Service, you need to create services in the Service
Definition Manager, which enables you to model the active environment for your end users.
The Service Definition Manager enables you to create, edit, and delete the following entities:
 Service definitions: A service is a group of one or more jobs that are aggregated based on job
filtering criteria, Order date, SMART folder, or a job, as described in Service definitions (on page 369).
 Service Rules: A service rule is a service generation definition that enables you to manually or
automatically generate services, as described in Service rules (on page 373).

Service definitions
A service is a group of one or more jobs that are aggregated based on job filtering criteria, Order date,
SMART folder, or a job.
You can create a service definition, which enables the service to appear in Control-M Self Service when a
job that belongs to the service appears in Active Jobs.
The following procedures describe how to create, edit, copy, and delete service definitions:
 Creating a service definition (on page 369)
 Editing a service definition (on page 371)
 Copying a service definition (on page 371)
 Deleting a service definition (on page 371)

Creating a service definition


This procedure describes how to create a service definition in the Control-M client.

 To create a service definition:


1. Open the Control-M client.
2. From the Tools domain, select Service Definitions.
The Service Definition window appears.
3. Select New Service Definition.
The Service Definition dialog box appears.
4. In the Name and Description fields, type the name and description of the service.
5. Select one of the options described in Service options (on page 372).
6. Click Next.
The Selection window appears.

369
Control-M User Guide

7. Select the jobs that you want to attach to this service by doing one of the following:
• If you selected Service based on filter or Service per ODAT based on filter, type or select
the required values, as described in Parameters, click Advanced Filtering, and go to step 8.
• If you selected Service per SMART Folder or Service per job, type or select the required
values, as described in Parameters, and go to step 9.
8. To add a filter, which includes or excludes jobs, do the following in the Including Terms or
Excluding Terms area:
a. In the Field column, select a job property.
b. In the Operator column, select the operator that you want to use.
c. In the Value column, type a value for the job property.
d. Repeat step a through step c as necessary.
e. If you want to add another group of fields which, when met, can include more fields, even if the
other group of fields do not meet the conditions, click .
Jobs that match the excluding filter are not included in the service, even if they match the including
filter. The service only includes jobs that match the including filter, but don't match the excluding
filter.
9. Click Next.
The Orderable Parameters window appears.
10. Click .
The Orderable Parameter dialog box appears.
11. Type or select the required values, as described in Orderable Parameter fields (on page 373), and
then click OK.
Orderable parameters can be used to send variable parameters to the SMART Folder or job of the
service when a service is ordered by a Control-M Self Service user.
12. Click Finish.
The service definition is created and added to the Service Definition Manager.

Deleting a table
This procedure describes how to delete a table.

 To delete a table:

1. In Control-M Event Manager tab, highlight the table you want to delete and click .
A confirmation window appears.
2. Click Yes.
The Table is deleted.

370
Control-M User Guide

Editing a service definition


This procedure describes how to edit a service definition.
Before You Begin
Successful completion of Logging in to Control-M (on page 10)

 To edit a service definition:


1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Select the service definition that you want to edit and click Properties.
The Service Definition window appears.
3. Edit the required fields in the General window, Selection window and/or the Orderable
Parameters window, as described in Creating a service definition (on page 369).
4. Click OK.

Copying a service definition


This procedure describes how to copy a service definition in the Service Definition Manager so you can
use it as a template.

Before You Begin


Successful completion of Logging in to Control-M (on page 10)

 To copy a service definition:


1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Select the service definition that you want to copy and click Duplicate.
The Service Definition dialog box appears.
3. In the Name field, type a new name for this service.
You can also update other fields, as described in Creating a service definition (on page 369).
4. Click OK.

Deleting a service definition


This procedure describes how to delete a service definition from the Service Definition Manager.

Before You Begin


Successful completion of Logging in to Control-M (on page 10)
 To delete a service definition:
1. From the Tools domain, select Service Definition Manager.

371
Control-M User Guide

The Service Definition Manager window appears.


2. Select the service definition that you want to delete.
3. Click Delete.
A confirmation message appears.
4. Click Yes.
The service definition is deleted.

Service options
The following table describes options for creating a service:
NOTE: Control-M Self Service users cannot hold or release services that are not based on a job or a
SMART folder.

Option Description

Service based on filter Determines which jobs are part of a service based on the
selected filters. For a detailed description of these filters, see
Parameters.

Service per ODAT based on Creates a separate service instance for all jobs that matches
filter the selected filters and have different ODAT values.

Service per SMART Folder Creates a separate service instance for every instance of a
SMART Folder, defined in the Filter tab, which enters Active
Jobs.
To group jobs to a SMART Folder, see Creating a job (on
page 47) and Creating a regular folder.
Ensure that each orderable service is a unique entity, and
not dependent on conditions from another service.

Service per job Creates a separate service instance for every instance of a
job, defined in the Filter tab, that enters Active Jobs.

Orderable Enables users from the Self Service web/mobile clients to


order this service to the active environment.
This feature is enabled only if you select Service per
SMART Folder or Service per job. For these service
types, a specific SMART folder or job is ordered when the
service is ordered.
If you select this option, the Orderable Parameters tab
appears.

372
Control-M User Guide

Orderable Parameter fields


The following table describes orderable parameters to set when creating a new orderable service:

Field Description

Name Defines the Variable name of the service parameter

Display Name Defines the display name of the Variable that appears for
the Control-M Self Service end user when ordering a service

Type Determines whether the Variable is a string, integer, Yes/No


or is a enumerated value

Required Determines whether a Control-M Self Service user must


enter a value for this service parameter

Validation Determines the possible values based on the selected


parameter type:
Note: For enumerated fields, possible values must be
separated by a comma. For Yes/No fields, the value
determines the Variable value that is used when the user
selected Yes or No when ordering the service.

Default Value Shows the default value of the Variable, as defined in the
job or SMART folder definition

Service rules
A service rule is a service definition that enables you to manually or automatically generate services based
on filtering and grouping criteria, rather than creating many individual services.
There are two types of service rules:
 Active rule: Inspects the jobs in Active Jobs automatically and generates service definitions that will
appear in Control-M Self Service. This reduces the maintenance of creating multiple service definitions
individually.
For example, you can define an active rule that creates a service for all jobs that belong to APP_Sales
and GRP_Eur. Every time a new job enters Active Jobs and matches the rule, a new service instance
automatically appears in Control-M Self Service. This relieves you from creating a new service
definition every time new application or groups that match the rule appear in Active Jobs, such as
APP_Sales1, APP_Sales2, or GRP_Eur_North, GRP_Eur_South.
 Manual rule: Enables you to inspect job definitions manually before you generate the service
definitions. This allows you to determine which service definitions to generate for display in Control-M
Self Service.
The following procedures describes how to create, edit, copy, and delete service rules and generate
service definitions from the Service Rule wizard:

373
Control-M User Guide

 Creating a service rule (on page 374)


 Editing a service rule (on page 376)
 Copying a service rule (on page 376)
 Deleting a service rule (on page 376)
 Generating services from a rule (on page 377)

Creating a service rule


This procedure describes how to create a service rule, which enables you to manually or automatically
generate services for jobs.
 To create a service rule:
1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Click New Service Rule.
The Service Rule wizard appears.
3. In the Name and Description fields, type the name and description of the service rule.
4. Do one of the following:
• If you want Control-M/EM server to automatically generate services by inspecting the jobs in
Active Jobs, leave the Active checkbox selected, and click Next.
• If you want to manually create services for job definitions, clear the Active checkbox, and click
Next.
The Selection window appears.
5. Apply filters on jobs that are relevant for the service rule, and then click Next.
For a detailed description of these fields, see Parameters. If you want more job filters, select More.
The Grouping window appears.
6. Select one of the following:
• Group jobs to services according to: Determines which jobs are part of a service based on
the selected fields. For a detailed description of these fields, see Parameters
For each grouping field, you can determine whether the grouping is according to the entire value
of the field, or according to the first or last letters of the field's value.
EXAMPLE: If you group by the first 3 letters of the Application field, jobs with Application BACKUP01
and BACKUP02 will be in the same service, but jobs with Application BATCH_JOBS will be
in a different service.
• Generate service per SMART Folder: Generates a separate service instance for every SMART
folder that enters Active Jobs that matches your filtering criteria.
• Generate service per job: Generates a separate service instance for every job that enters
Active Jobs that matches your filtering criteria.
7. Click Next.

374
Control-M User Guide

The Properties window appears.


8. Define a format for service name and description of the generated service definitions.
The maximum character length for the service name is 200 and 400 for the description. You can use
field placeholders which are replaced by actual job attributes in the generated services.
EXAMPLE: The format name Service for {Application} in {Sub-application} creates a service
named Service for app1 in Sub-app1 that contains jobs with Application=app1 and Sub-
application=sub-application1
If you group according to the first or last letters of the field's value, the placeholder is
replaced by the first or last letter. In the first example of this procedure, Service for
{Application} is replaced with Service for BAC and Service for BAT for the two
generated services.
9. Do one or more of the following:
• To enable Control-M Self Service users to order the generated services, select the Orderable
checkbox.
This option is only enabled if you selected Generate service per SMART Folder or Generate
service per job in the Grouping window and the Active checkbox is not selected in the
General window.
• To automatically add orderable parameters to the generated orderable services, select the Add
automatically orderable parameters to each service.
The generated parameters are taken from the Variables of a service's SMART Folder or job
definition. This option is only enabled if the Orderable checkbox is selected.
• To generate a separate service instance for each ODAT, select Service Instance Per ODAT.
This option is only enabled if you selected Group jobs to services according to in the
Grouping window.
10. Do one of the following:
• If the Active checkbox in the General window is not selected and you want to manually create
service definitions from the service rule, see Generating services from a rule (on page 377).
• If the Active checkbox in the General window is selected and you want to automatically create
service definitions from the service rule, click Finish.
The service definitions are automatically created. When a job that belongs to a service rule enters
Active Jobs, the service appears in Control-M Self Service.
Services that are automatically generated for active rules are maintained by the Control-M/EM server
and do not appear in the Service Definition Manager window. They are only visible in Control-M
Self Service.
• To review the possible services, click Next.
The Review Services window appears.
11. To view the jobs in each service:
• To view jobs of the selected service that are in the active jobs database, select Active.
• To view jobs of the selected services that are not in the active database, select Definition.
The service rule is saved and appears in the Service Definition Manager.

375
Control-M User Guide

Editing a service rule


This procedure describes how to edit a service rule.
 To edit a service rule:
1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Select the service rule that you want to edit and click Properties.
The Service Rule wizard appears.
3. Edit the required fields in the General, Selection, Grouping, and Properties windows, as
described in Creating a service rule (on page 374).
4. From the Properties window, click Finish.

Copying a service rule


This procedure describes how to copy a service rule in the Service Definition Manager so you can use it as
a template.

 To copy a service rule:


1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Select the service rule that you want to copy and click Duplicate.
The Service Rule wizard appears.
3. In the Name field, type a new name for this service rule.
4. Click Next and update the required fields in the Selection, Grouping, and Properties windows, as
described in Creating a service rule (on page 374).
5. From the Properties window, click Finish.

Deleting a service rule


This procedure describes how to delete a service rule from the Service Definition Manager.

 To delete a service rule:


1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Select the service rule that you want to delete.
3. Click Delete.
A confirmation message appears.
4. Click Yes.
The service rule is deleted.

376
Control-M User Guide

Generating services from a rule


This procedure describes how to manually generate services from a rule that was previously created.
 To generate services from a rule:
1. From the Tools domain, select Service Definition Manager.
The Service Definition Manager window appears.
2. Select a rule that contains the services you want to generate and click Generate Services From
Rule.
The Generate Services - Service Rule <serviceRule> window appears.
3. Select the service definitions that you want to generate and click Generate.
The service definitions are created and appear in the Service Definition Manager.

Workload Policy Definition


The Workload Policy Definition manager is a tool that enables you to control, manage, and balance the
workload on Control-M resources and hosts in the following areas:
 Limiting resources available to groups of jobs in production
 Routing groups of jobs to execute on specific resources
 Defining a resource’s availability in the dynamic environment according to specific times
You can divide any or all of the jobs in the Control-M production into smaller groups of jobs, which are
called Workload Policies. Jobs are grouped together according to shared general attributes in their job
definitions based on filters, which associates any job with those attributes in production with the
Workload Policy. A Workload Policy enforces its rules on all associated jobs, which can quickly affect large
numbers of jobs processing definitions without manually changing the jobs’ definitions individually.
Workload Policy rules can limit the resources that the associated jobs can consume and specific times can
be defined when these rules are enforced. This prevents a Workload Policy from taking control of all
available resources and preventing other jobs from running.
Critical jobs with quantitative resources bypass the Workload Policy resources limitation rule.
A Workload Policy can route associated jobs to a specific host. This allows you to change the execution
host defined for certain jobs in production and re-route groups of jobs without affecting the jobs’
definitions.
The following procedures describe how to create, copy, delete, activate, and deactivate Workload Policy
Definitions:

377
Control-M User Guide

 Creating a Workload Policy Definition (on page 378)


 Copying a Workload Policy Definition (on page 381)
 Deleting a Workload Policy Definition (on page 381)
 Activating a Workload Policy Definition (on page 381)
 Deactivating a Workload Policy Definition (on page 382)

Creating a Workload Policy Definition


This procedure describes how to create a Workload Policy Definition, which enables you to limit the
Workload Policy's quantitative resource use, limit the number of associated jobs that run concurrently,
and route a group of associated jobs to a new host.
 To create a Workload Policy Definition:
1. From the Tools domain, in the Production Control area, select Workload Policy Definition.
The Workload Policy Definition manager appears.
2. From the Workload Policy Management menu, select New.
The Workload Policy Definition properties pane appears on the right.
3. Do the following:
a. In the Name field, type a name for the Workload Policy.
b. In the Description, describe the purpose of the Workload Policy.
4. Click General, and from the State drop-down list, select one of the following:
• Active
• Inactive
5. Click Filter and filter for entities that are required for the Workload Policy.
For a list of available filter wildcards, see Pattern-matching strings for workloads (on page 380).
6. Click Quantitative Resources, and define the resource allotment for the jobs in the Workload
Policy, as described in Quantitative resources (on page 76).
7. Click Running Jobs and define the number of concurrent running jobs in the Workload Policy, as
follows:

a. Click .
The Number of Running Jobs - Period Definition dialog box appear.
b. From the Control-M Server drop-down list, select the Control-M/Server where the restrictions to
the number of running jobs are applied.
c. In the Running Jobs field, select the maximum number of running jobs.
d. From the Date Type drop-down list, select a date option when the maximum number of running
jobs is enforced on the Workload Policy.
e. From the Time Type, select one of the following time options:
o All Hours: Restrictions are enforced all hours on the selected dates.

378
Control-M User Guide

o Between: Restrictions are enforced between a time period on the selected dates.
f. Click OK.
8. Click Host Mapping and route a group of associated jobs to a new host, as follows:

a. Click .
b. From the Control-M Server drop-down list, select the Control-M/Server where the required Host
Groups are located.
c. From the Host/Host Groups drop-down list, select the host or host group where the jobs are
currently defined.
d. From the Map To drop-down list, select the host or host group that you want the jobs to run on.
9. Click Apply Changes.
A confirmation message appears.
10. Click Yes.
The Workload Policy definition is now saved in the Control-M/EM database.

379
Control-M User Guide

Pattern-matching strings for workloads


The following table describes symbols used to compose pattern-matching strings for workloads:

Symbol Name Usage

* Asterisk wildcard Denotes any number of characters (including no characters).


This can be inserted in place of a string or in the middle of
the pattern-matching string in the place of any number of
characters.
Note: If one or more of the filter criteria fields is not
needed, it is more efficient to leave the field blank than to
use the "*" character. However, at least 1 filter field must
contain a value.

? Question mark wildcard Denotes any single character. This can be inserted in place
of any number of characters.

, Comma Used to separate pattern-matching strings, enabling the user


to specify more than one string (the comma represents a
Boolean OR).
Example: (host01, host02, host03)
Note: “,” is evaluated literally in collection and filter
definition fields.

character Character Any character, other than one of the above, denotes the
specific character.
Note: In case-sensitive fields, Control-M/Desktop
differentiates between uppercase and lowercase characters
(for example, “a” and “A” are regarded as two different
characters).

\specialchar Escape character Denotes the literal value of the special character. The special
characters are the symbols described in this table.
Examples:
 To specify \, type \\.
 If you specify \. then "." has the meaning of period and
not the same meaning as ?.
 Use "\" to escape ! only where ! is the first character.

380
Control-M User Guide

Copying a Workload Policy Definition


This procedure describes how to copy a Workload Policy Definition, which enables you to create another
Workload Policy Definition without having to type and select the required criteria multiple times.
 To copy a Workload Policy Definition:
1. From the Tools domain, in the Production Control area, select Workload Policy Definition.
The Workload Policy Definition manager appears.
2. From the Workload Policy Management menu, select Duplicate.
The Workload Policy Definition properties pane appears on the right.
3. In the Name field, type a new for the Workload Policy Definition.
4. Edit the Workload Policy Definition as needed.
5. Click Apply Changes.
A confirmation message appears.
6. Click Yes.
The Workload Policy definition is now saved in the Control-M/EM database.

Deleting a Workload Policy Definition


This procedure describes how to delete a Workload Policy Definition. After you delete the definition, the
jobs that were associated to it run according to their individual definitions.

 To delete a Workload Policy Definition:


1. From the Tools domain, in the Production Control area, select Workload Policy Definition.
The Workload Policy Definition manager appears.
2. Select the Workload Policy Definition that you want to delete.
3. From the Workload Policy Management menu, select Delete.
A confirmation message appears.
4. Click Yes.
The Workload Policy Definition is deleted.
5. Click Apply Changes.
A confirmation message appears.
6. Click Yes.
The Workload Policy definition is now removed from the Control-M/EM database.

Activating a Workload Policy Definition


This procedure describes how to activate a Workload Policy Definition, which enforces all the rules of the
Workload Policy Definition on the associated jobs.

381
Control-M User Guide

 To activate a Workload Policy Definition:


1. From the Tools domain, in the Production Control area, select Workload Policy Definition.
The Workload Policy Definition manager appears.
2. Select the Workload Policy Definition that you want to activate.
3. From the Workload Policy Management menu, select Activate.
A confirmation message appears.
4. Click Yes.
The Workload Policy Definition is activated.
5. Click Apply Changes.
A confirmation message appears.
6. Click Yes.
The Workload Policy definition is now saved in the Control-M/EM database.

Deactivating a Workload Policy Definition


This procedure describes how to deactivate a Workload Policy Definition, which removes all the rules of
the Workload Policy Definition on the associated jobs.
 To deactivate a Workload Policy Definition:
1. From the Tools domain, in the Production Control area, select Workload Policy Definition.
The Workload Policy Definition manager appears.
2. Select the Workload Policy Definition that you want to deactivate.
3. From the Workload Policy Management menu, select Deactivate.
A confirmation message appears.
4. Click Yes.
The Workload Policy Definition is deactivated.
5. Click Apply Changes.
A confirmation message appears.
6. Click Yes.
The Workload Policy definition is now saved in the Control-M/EM database.

Workload Policy Monitor


The Workload Monitor is a tool that enables you to see the current status of associated jobs with a
Workload Policy.

382
Control-M User Guide

The following table describes the columns in the Workload Policy monitor:

Columns Description

Name Defines the workload policy name.

Wait Hosts Determines the number of jobs waiting for host resources due to
one of the following reasons:
 Agent or execution host is unavailable
 Host currently has its max number of jobs running
 Host has reached its max CPU usage restrictions

Wait Workloads Determines the number of jobs waiting due to restrictions on the
maximum number of jobs running concurrently in the workload
policy.

Running Jobs Determines the number of jobs that are currently running
simultaneously.

In addition to the columns in the above table, there are columns at the bottom of the Workload Monitor
that show the number of jobs according to the column definition for all jobs in the Active environment.
The column totals do not count jobs twice, which means that if a job appears in more than one workload,
it is only counted once in the total column. In addition to the above default columns displayed in the
Workload Monitor window, customized columns can be added.

Viewing jobs in a workload


This procedure describes how to view jobs that are associated to a specific workload.

 To view jobs in a workload:


1. From the Tools domain, in the Monitoring area, select Workload Policy Monitor.
The Workload Policy Monitor appears.
2. Select the workload that contains the associated jobs that you want to view.
3. Click Open into Viewpoint.
The workload appears in the tree view and flow diagram.

Periodic Statistics definition


The Periodic Statistics Manager is a tool that enables you to define and collect data based on the
following types of periodic statistics:

383
Control-M User Guide

 Periodic Calendar Statistics (on page 384): Enables you to collect run time statistics based on
periods defined in one specific periodic calendar. There are separate statistics on a specific job or set
of jobs for different periods during the week, month, or year. These periods are defined in a Periodic
Calendar (see Calendar management (on page 335)).
EXAMPLE: If the average run time of a job during work days is not the same as the average run
time during weekends, there is an advantage to collecting statistics for this job separately
for work days and for weekend periods. The average run times will be much more
accurate for each period.
 Dynamic Periodic Statistics (on page 385): Enables you to collect run time statistics for a group of
jobs based on a period of time that begins when the associated condition is added to the Active
Conditions list, and ends when the condition is removed from the Active Conditions list. The statistics
are gathered for the filtered jobs during the period. The period is identified by the last character of
the condition name, which has Order Date set to No Date.
EXAMPLE: If the average run time of a jobs today are not the same as usual because one computer
instead of two are running the jobs. This case is not associated with a period in the
calendar. There is an advantage to collecting statistics for the jobs by defining a Dynamic
Statistics definition related to a filtered list of jobs and adding the associated condition to
the Condition Table for a period of time.
A list of periodic statistics definitions appear in the Periodic Statistics Manager. You must arrange the
periodic statistics definitions in order of precedence, so that if a job is included in two or more periodic
statistics definitions, the definition with the greater precedence (higher up on the list) is applied to the
job. By default, new definitions are added to the bottom of the list as they are created. Since the order of
the definitions is important, the list cannot be sorted.
NOTE:
 A statistics calendar that is defined in a z/OS job takes precedence over a Periodic Calendar that is
related to the job through the Periodic Statistics Manager.
 Jobs can have one statistics definition only.
The following procedures describe how to view the latest statistics, copy, and delete a statistics definition:
 Analyzing active jobs (on page 238):
 Creating a Periodic Calendar Statistics definition (on page 384)
 Creating a Dynamic Periodic Statistics definition (on page 385)
 Generating Dynamic Periodic Statistics (on page 386)
 Copying a Periodic Statistics definition (on page 387)
 Deleting a Periodic Statistics definition (on page 388)

Creating a Periodic Calendar Statistics definition


This procedure describes how to create a Periodic Calendar Statistics definition, which enables you to
collect run time statistics based on periods defines in one specific periodic calendar.

384
Control-M User Guide

Before You Begin


 Successful completion of Creating a periodic calendar (on page 338) (Statistics collected according to
periods in the calendar only)
 To create a Periodic Calendar Statistics definition:
1. From the Tools domain, in the Planning area, select Periodic Statistics.
The Periodic Statistics manager appears.
2. From the Periodic Statistics menu, select New.
The Periodic Statistics definition appears on the right.
3. In the Name field, type the name of the Periodic Statistics definition.
4. In the Description field, describe the purpose of the Periodic Statistics definition.
5. In the Period Type area, select Statistics collected according to periods in the calendar.
6. In the Calendar field, s in the Calendar and Control-M columns, select a defined calendar and
Control-M/Server respectively.
7. In the Job Filter area, filter for the jobs that you want to collect statistics.
8. Click Save.
The Statistics definition appears in the Periodic Statistics manager.
9. Arrange the Periodic Statistics definitions in order of precedence, so that if a job is included in two or
more Periodic Statistics definitions, the definition with the greater precedence (higher up on the list) is
applied to the job.
A statistics calendar that is defined in an z/OS job takes precedence over a Periodic Calendar that is
related to the job through the Periodic Statistics Manager.
10. To load the Periodic Statistics definition before the New Day time in all Control-M/EM Gateway
servers, do the following:
a. In the CCM, in the EM components, select the Gateway component.
b. Send the LOAD_PERIODIC_STAT def command, as described in Sending commands to
Control-M/EM server components:
c. Repeat Steps 10a and 10b for each Gateway component.

Creating a Dynamic Periodic Statistics definition


This procedure describes how to create a Dynamic Periodic Statistics definition, which enables you to
collect run time statistics for a group of jobs during a period of time that begins when the associated
condition is added to Active Conditions list, and ends when the condition is removed from Active
Conditions list.

 To create a Dynamic Periodic Statistics definition:


1. From the Tools domain, in the Planning area, select Periodic Statistics.
The Periodic Statistics manager appears.
2. From the Periodic Statistics menu, select New.

385
Control-M User Guide

The Periodic Statistics definition appears on the right.


3. In the Name field, type the name of the Periodic Statistics definition.
4. In the Description field, describe the purpose of the Periodic Statistics definition.
5. In the Period Type area, select Statistics collected according to a period defined by a
condition prefix.
6. In the Condition Prefix field, type a meaningful name for the Condition Prefix.
The Condition Prefix will be used when you create the associated condition.
7. In the Job Filter area, filter for the jobs that you want to collect statistics.
8. Click Save.
The Statistics definition appears in the Periodic Statistics manager.
9. Arrange the Periodic Statistics definitions in order of precedence, so that if a job is included in two or
more Periodic Statistics definitions, the definition with the greater precedence (higher up on the list) is
applied to the job.
A statistics calendar that is defined in an z/OS job takes precedence over a Periodic Calendar that is
related to the job through the Periodic Statistics Manager.
10. To load the Periodic Statistics definition before the New Day time in all Control-M/EM Gateway
servers, do the following:
a. In the CCM, in the EM components, select the Gateway component.
b. Send the LOAD_PERIODIC_STAT def command, as described in Sending commands to
Control-M/EM server components:
c. Repeat Steps 10a and 10b for each Gateway component.
11. To generate the dynamic periodic statistics, create the associated condition, as described in
Generating Dynamic Periodic Statistics (on page 386).

Generating Dynamic Periodic Statistics


This procedure describes how to generate dynamic statistics for a Dynamic Period, which enables you to
collect run time statistics for a group of jobs during a period of time that begins when the associated
condition is added to the Active Conditions list, and ends when the condition is removed from the Active
Conditions list. The condition can also be global to ensure that dynamic statistics are collected for the
Control-M/Servers.
Before you begin
 Ensure you have successfully completed Creating a Dynamic Periodic Statistics definition (on page
385) (Statistics collected according to periods defined dynamically).

 To generate Dynamic Periodic Statistics:


1. From the Tools domain, in the Production Control area, select Conditions.
The Conditions manager appears.
2. From the Conditions menu, select Add Condition.
A new condition appears in the Properties pane.

386
Control-M User Guide

3. In the Condition Name field, set the condition name in the form <Condition Prefix><single
character> as follows:.
a. Type the Condition Prefix that you set in Creating a Dynamic Periodic Statistics definition (on
page 385).
b. Type the Dynamic Period name by including it as the last character of the Condition name, in
the form (0 – 9, A – Z, or a – z).
If no conditions are defined, the statistics are collected for a period without a condition. When more
than one condition exists, the statistics will be collected for the highest condition (first lower case
letters, then capital letters, and then numbers).
4. From the Control-M Server drop-down list, select the Control-M/Server that hosts the condition.
5. In the Order Date area, select No Date.
6. Click Save.
The condition appears in the Active Conditions list, and the dynamic statistics are gathered for all the
jobs that start running that are included in the defined filter from Creating a Dynamic Periodic
Statistics definition (on page 385).
7. To view the statistics in a job that is included in the filter, see Analyzing active jobs (on page 238).
8. To stop generating the dynamic statistics, remove the Condition from the Active Conditions list, as
described in Deleting a condition.
For more information about rules for adding and removing conditions, see Forecast/BIM rules (on page
294) and Editing a Service Assumption (on page 277).
For more information on global conditions, see Global Conditions Prefixes (on page 346) and Connecting
jobs from different Control-M/Servers (on page 82).

Copying a Periodic Statistics definition


This procedure describes how to copy a Periodic Statistics definition,which enables you to create another
Periodic Statistics definition without having to type and select the required criteria multiple times.

 To copy a Periodic Statistics definition:


1. From the Tools domain, in the Planning area, select Periodic Statistics.
The Periodic Statistics manager appears.
2. Select the Periodic Statistics definition that you want to copy.
3. From the Periodic Statistics menu, select Duplicate.
The Periodic Statistics definition appears on the right.
4. In the Name field, type a new name for the Periodic Statistics definition.
5. Edit the template as needed.
6. Click Save.
The Periodic Statistics definition appears in the Periodic Statistics manager.

387
Control-M User Guide

Deleting a Periodic Statistics definition


This procedure describes how to delete a Periodic Statistics definition.

 To delete a Periodic Statistics definition:


1. From the Tools domain, in the Planning area, select Periodic Statistics.
The Periodic Statistics manager appears.
2. Select the Periodic Statistic definition that you want to delete.
3. From the Periodic Statistics menu, select Delete.
A confirmation message appears.
4. Click Yes.
The Periodic Statistics definition is deleted.

Communication management
Control-M must be constantly connected to the GUI Server. The GUI Server handles communication
between each Control-M client and other Control-M/EM components.
The Control-M client depends on a constant flow of information from Control-M/Servers to present you
with an up-to-date status of jobs. Operator requests and global conditions are transmitted back and forth
between Control-M/EM and the Control-M/Server.
The Communication Status dialog box shows the status of communication between each Control-M/Server
and the Control-M client (see Control-M Servers Communication status (on page 389)).
The following procedures describes how to change a Control-M password and troubleshoot connectivity
issues:
 Changing the password (on page 388)
 Troubleshooting connectivity (on page 390)

Changing the password


This procedure describes how to change your Control-M/EM password that is used to log into the Control-
M client.
 To change the password:
1. From the Tools domain, in the Communication area, select Change Password.
The Change Password dialog box appears.
2. Type your old and new password.
3. Click OK.
Your password has changed.

388
Control-M User Guide

Control-M Servers Communication status


The following table describes the columns in the Communication Status window:

Column Description

Control-M Server When the gateway is restarted, Control-M/EM attempts to


communicate with the Control-M/Server.

Enable Determines whether Control-M/Server is enabled.

Gateway Control-M/EM gateway connection to the Control-M/Server.

Communication Communication route between the Gateway and the Control-


M/Server.

Synchronized Synchronizes the active environment with the Active Jobs file in
the Control-M/Server.

Network Status Determines the status of communication between Control-M/EM


and the Control-M/Server.

Folder Sync Determines whether Folders are synchronized with Control-


M/Server.

Calendar Sync Determines whether Calendars are synchronized with Control-


M/Server.

Workload Policies Determines whether Workload Policies are synchronized with


Control-M/Server.

Connectivity problems
Control-M uses a callback connection method for several actions such as Upload Folder and Open
Viewpoint.
Control-M/EM uses a single XML CORBA configuration file, called config.xml that defines CORBA
configuration data for all CORBA components (clients and servers included). During installation, the file is
configured with default values for the components. Sometimes, when the client machine has more than
one IP address, the default configuration does not provide optimum performance, resulting in a failure.
If the callback connection fails during login, the Connectivity Failure window appears, warning you
about the connectivity failure. If you ignore this warning, you might not be able to open a Viewpoint or
upload a folder from the Control-M/EM server.
The Connectivity Failure window indicates that the Control-M/EM server is not connected to the Control-M
client and enables you to resolve the problem automatically or manually.

389
Control-M User Guide

During the automatic resolution, all available IP addresses are scanned, the best IP address (with the
shortest response time) is identified, and the CORBA configuration file is modified accordingly.
To re-establish connectivity, see Troubleshooting connectivity (on page 390).

Troubleshooting connectivity
This procedure describes how to re-establish connectivity between Control-M/EM server and the Control-M
client.

 To troubleshoot connectivity:
1. From the Tools domain, in the Communication area, select Connectivity Troubleshooting.
The Connectivity Troubleshooting dialog box appears.
2. Select one of the following:
• Use Specific IP Address: Enables you to select an IP addresses from enabled network
interfaces on the computer.
• Use IP Address Matching Specific Mask - Enables you to specify an IP mask.
This option is recommended when using VPN connections, since the IP addresses might change
dynamically. This avoids the need of reconfiguring CORBA each time you reconnect. (For
example, at runtime the subnet mask 137.72.114.0 will prefer the IP address 137.72.114.142 to
192.168.241.3.) In the configuration file, the mask is set in the –PreferIPMask parameter, and the
hostname_in_ior value is $IP (which is evaluated at runtime). If this option is selected, the $IP
characters appear in the Troubleshoot Connectivity window; accidentally deleting them prevents
the mask from being evaluated at runtime.
• Use Virtual Hostname or IP Address - Enables you to set a virtual hostname (for example, on
a cluster machine), a known hostname, or a fixed IP address.
• Use Default - Sets the current default hostname or IP address in brackets. In the CORBA
configuration file, the value of the –ORBDottedDecimalAddresses parameter determines whether
the default is an IP address (value = 1) or a hostname address (value = 0).
3. Clear the Use bidirectional communication checkbox.
This forces the server to resolve the client’s address and initiate a connection back to it.
4. Click Test.
The configuration defined for the client is tested for its connectivity with the Control-M/EM server.
5. Select the Use bidirectional communication checkbox.
6. Click Save.
7. Restart all Control-M client components.
For more information about connectivity issues, see Connectivity problems (on page 389).

390
Control-M User Guide

Pattern matching strings


The following table describes the pattern matching strings that can be used to search for values in any
Control-M application.
If you use special characters, such as asterisk, as a literal part of the object name (for example, glo*-
job1_started), and when you filter you want to include only these objects (for example, you do not want
to include glo-job1_started), specify \ before the special character in the filter prefix (for example, glo\*).
Otherwise, objects without the special character (for example, glo-job1_started) will also be included.
(Wherever possible, try to avoid defining object names with special characters as literals.)

391
Control-M User Guide

Symbol Name Description

* Asterisk Denotes any number of characters


(including no characters). This can be
inserted in place of a string or in the
middle of the pattern-matching string
in the place of any number of
characters.
If one or more of the filter criteria
fields is not needed, it is more
efficient to leave the field blank than
to use the "*" character. However, at
least one filter field must contain a
value.

? or . Question Mark or Period Denotes any single character. This


can be inserted in place of any
number of characters.

! Exclamation Denotes all possibilities that do not


match the pattern that immediately
follows the ! character. This can be
specified to exclude the pattern
immediately following the ! from the
result.
Where a pattern begins with !, the
escape character backslash “\“ can be
used to escape the ! and either
include or exclude the pattern
(required only where ! is the first
character). For example, to include
occurrences of “!wip”, use the pattern
“\!wip”, whereas “!\!wip” excludes
“!wip”.
! must be the first character of the
string,
In the expression (first!,!one) the
exclamation is part of the
string “first!”, but is used
to exclude the string
“one”.
! is evaluated literally in collection
and filter definition fields.

392
Control-M User Guide

Symbol Name Description

[] Brackets Denotes different possibilities for a


single character. The brackets
enclose a string of possible values. In
addition, the following symbols can
be used within the brackets:
 - denotes a range of characters.
 ^ used as the first character in
the brackets to denote"not".

, or | Comma or Pipe Used to separate pattern-matching


strings, enabling the user to specify
more than one string (the comma
represents a Boolean OR).
(host01, host02, host03)
“,” is evaluated literally in collection
and filter definition fields.

character Character Any character, other than one of the


above, denotes the specific character.
In case-sensitive fields, Control-M
differentiates between uppercase and
lowercase characters
“a” and “A” are regarded as two
different characters.

^ Anchor (start)  Denotes "not" when used as the


first character in brackets [ ].
 Denotes the start of a word when
not specified in brackets [ ].

$ Anchor (end)  Denotes the end of a word.

\specialchar Escape character Denotes the literal value of the


special character. The special
characters are the symbols described
in this table.
 To specify \, type \\.
 If you specify \. then "." has the
meaning of period and not the
same meaning as ?.
 Use "\" to escape ! only where !
is the first character.

393
Control-M User Guide

Symbol Name Description

+ Plus Used with \ to denote the literal value


of the special character.
<CYCLIC_INTERVAL_SEQUENCE
FROM="\+60M\,\+3H"
TO="+30M,+6H" />

Newsfeed
The Newsfeed domain is a collection of Control-M discussions from social networks, blogs, and forums,
such as Facebook, Twitter, and BMC Communities. You can view the list of all aggregated content from
these sites, within the Control-M client, without having to navigate to them individually.
For a description of configuration settings, see Newsfeed settings (on page 45).

394

You might also like