Control-M Web 9.0.19.100 User Guide · To get started, see the Getting Started help. Setting user preferences This procedure describes how to set user preferences, which enables you

Control-M Web 9.0.19.100 User Guide

July 2019

2

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

2103 CITYWEST BLVD

HOUSTON TX

77042-2827

USA

Telephone ▪ 713 918 8800

▪ 800 841 2031

Fax 713 918 8000

Outside United States and Canada

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

© Copyright 1999-2018 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”), Microsoft Azure (“Azure”), or Google Cloud Platform ("GCP") cloud environment, a license is required for the total number of CPUs in each AWS, Azure, or GCP

instance upon which the Product is installed or which the Product manages, either remotely or locally. For

AWS and GCP, 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.

IBM® Tivoli® Business Service Manager, IBM Tivoli Workload Scheduler, IBM Cognos, IBM InfoSphere DataStage, IBM i (AS/400), 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

http://www.bmc.com/

3

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:

▪ 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

http://www.bmc.com/support

mailto:[email protected]

4

• 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

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

ation and click Third-party software (TPS).



https://docs.bmc.com/docs/display/workloadautomation/Control-M+Workload+Automation+Documentation

https://docs.bmc.com/docs/display/workloadautomation/Control-M+Workload+Automation+Documentation

5

Contents

Introduction to Control-M Web ........................................................................................ 7

Logging in to Control-M Web ........................................................................................................... 8

Setting user preferences ................................................................................................................. 8

User preferences ............................................................................................................................ 9

Planning domain navigation .......................................................................................................... 10

Monitoring domain navigation ....................................................................................................... 12

Managed File Transfer domain navigation ...................................................................................... 18

Changing your password ............................................................................................................... 19

Control-M Web deep linking .......................................................................................................... 20

Logging out of Control-M Web ...................................................................................................... 21

Control-M Web Planning Domain ................................................................................... 22

Planning domain administrative regulations .................................................................................... 22

Job Definition ............................................................................................................................... 23

Ordering jobs and folders ........................................................................................................... 238

Ordering a job now with a different order date example ............................................................... 239

Control-M Web Workspaces ......................................................................................... 244

Workspace lifecycle .................................................................................................................... 244

Workspace statuses .................................................................................................................... 247

Setting up a Control-M Web Workspace ....................................................................................... 247

Validating job definitions in a Workspace ..................................................................................... 256

Submitting a Workspace as a request .......................................................................................... 257

Checking in a Workspace ............................................................................................................ 259

Changes Report ......................................................................................................................... 260

Exporting a Workspace ............................................................................................................... 261

Deleting a Workspace ................................................................................................................. 261

Control-M Web Monitoring Domain .............................................................................. 262

Viewpoints ................................................................................................................................. 262

Service management .................................................................................................................. 267

Job management........................................................................................................................ 272

Control-M Web Tools domain ...................................................................................... 291

User Views management ............................................................................................................ 291

6

Site Standard Management ......................................................................................................... 293

7

1 1

Introduction to Control-M Web

Control-M Web is a web-based application that provides access to different domains within a single login to the Self Service domain (Monitoring) for tracking the active environment and the Workload Change

Manager domain (Planning) for jobs, folders and workspaces definitions and modifications.

The new consolidated web also includes Managed File Transfer and Archiving search (Monitoring-Archive

search) and BIM services.

Control-M Web enables you to do the following:

▪ View and manage Control-M jobs and folders in a Control-M Workspace.

▪ Load existing jobs and folders to the Planning Workspace editor.

▪ Create, edit and submit job definitions to a Control-M Scheduler.

▪ Create, edit and check-in job definitions to the Control-M database.

▪ Order individual jobs/folders and Workspaces.

▪ Monitor, filter active jobs and analyze problematic jobs.

▪ View and order your services from anywhere, and analyze problematic services and/or jobs.

▪ Search for a file that was transferred with Control-M MFT and view its job properties and transfer

status from Control-M Web Monitoring domain.

▪ Monitor BIM Services.

▪ Integrate the Control-M Planning domain with a change management system.

Control-M Web contains three domains:

▪ Planning: In this domain, you can define and edit your jobs and various job properties. For more

information, see Control-M Web Planning Domain (on page 22)

▪ Monitoring: In this domain, you can monitor active jobs and regular services, check for problems,

and perform various job actions. For more information, see Control-M Web Monitoring domain (on

page 262).

▪ Managed File Transfer: In this domain, you can search for a file that was transferred with Control-M Managed File Transfer and view its job properties. For more information, see Managed File

Transfer domain navigation (on page 18).

▪ Tools: In this domain, you can create Site Standards and User Views. For more information, see

Control-M Web Tools domain (on page 291).

NOTE: Some domains are not accessible if you do not have the relevant product activated.

Control-M Web User Guide

8

Logging in to Control-M Web

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

➢ To log in to Control-M Web:

1. Open an internet browser.

2. Type the following URL:

http://server name :port/ControlM/

Contact your Control-M Administrator for the server name and port number.

3. In the User field, type your username.

4. In the Password field, type your password.

5. Click Log in.

You are now logged in to Control-M web. The Planning Home page appears.

To get started, see the Getting Started help.

Setting user preferences

This procedure describes how to set user preferences, which enables you to customize your preferred

view and user details.

➢ To set user preferences:

1. From the username drop-down list, select Preferences.

The Preferences window appears.

NOTE: From the drop-down lost you can view or customize additional settings such as changing your

password, viewing the getting started guide.

2. Set your preferences as desired. You can refer to User preferences (on page 9), for more information

on the preferences window fields.

3. Click Save.

The user preferences are saved as your default settings. To change your password, see Changing

your password (on page 19).

You can also access the My Home Page, from the user drop-down menu. My Home Page, is a

customized HTML page that enabled you to add your own content, such as procedures, favorite link,

and more. Please contact your Control-M Administrator to enable this feature.


9

User preferences

The following table describes the user preferences:

Preference Description

Language Determines the user interface language.

Warning Dialogs Resets all dialogs to display again, if you have previously checked

the Do not notify me again checkbox.

User Views Determines which user views are used. For more details, see User

Views management (on page 291).

Planning

Auto save Saves your Job Flow Workspace automatically.

Workspace default view Defines the default workspace view as Tile or List.

E-mail notification address Defines the email address where notifications are sent. You can

define more than one email address separated by comas.

Monitoring

Hide empty SMART Folders Enables you to hide empty SMART folders in the job view.

Services default view Defines the default service view as Tile or List after logging in.

Viewpoints default view Defines the default Viewpoint view as Tile or List after logging in.

Archive search maximum results Determines the maximum number of search results.

Map job node title Enables you to select the information displayed in the title of the

node body in your viewpoint. Default: Job/Member Name.


10

Preference Description

Neighborhood default direction Defines the default relationship of the neighboring jobs to the

selected jobs.

▪ Successor: Defines the jobs that are dependent on the

selected job (below the job).

▪ Predecessor and Successor: 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).

▪ All Connections: Defines the jobs branching in all directions

from the selected job.

Neighborhood default radius Defines the maximum distance of jobs that branch out from the

selected job.

Planning domain navigation

The following image displays the Planning domain Home page navigation, and each area in the interface.


11

The following table describes the areas in the Planning domain Home page:

Callout Area Description

1 Workspace Displays options for creating a new Workspace. For more

information, see Workspace navigation (on page 11).

2 Main pane Displays the following three areas:

▪ My work: Enables you to view and open Job Flow

Workspaces owned by you.

▪ Others work: Enables you to view or work on a colleague's

job flow.

▪ Folders and Jobs: Displays information on the job flow,

such as name, status, and timestamp.

Workspace navigation The following image displays the Workspace domain interface, and each area in the interface. You can

view the table below for explanations of each area and the different actions that can be performed.


12

The following table describes the areas in a Workspace:


1 Ribbon Displays Workspace actions and job/folder specific actions such

as Validation, and adding jobs/folders to a Workspace.

2 Main pane Displays the jobs and folders flow diagram.

3 Results pane Displays results such as results of Validation report, Show

Changes results, and displays the Notes.

4 Properties pane Displays the properties of the selected entity, such as General

properties, and Scheduling properties.

Monitoring domain navigation

The Monitoring domain is split according to the following tabs:

▪ Viewpoints: Enables you to monitor active jobs and perform job actions. For information about

navigating in a Viewpoint, see Viewpoint navigation (on page 12)

▪ Services: Enables you to do monitor services, (such as BIM and those services that you have created) and perform job actions. For information about navigating in a Service, see Services

navigation (on page 15).

Viewpoint navigation

The following image displays a created Viewpoint in the Monitoring domain. You can view the table below

for explanations of each area and the different actions that can be performed.


13


14

The following table describes the various actions you can perform in the Jobs view:


1 Tab You can view the following:

▪ Viewpoints tab

▪ Services tab

▪ Any opened viewpoints or services

By clicking you can do the following:

▪ View a list of saved viewpoints

▪ Add a New viewpoint

▪ Search for a job

▪ Archive Search

2 Ribbon Enables you to do the following:

▪ Refresh the jobs manually by clicking .

▪ Perform job actions by selecting one of the

options from the Actions dropdown list, such

as Rerun, restart, delete, as described in Job

management (on page 272).

▪ Edit and Save the viewpoint

▪ Search for a job.

3 Navigation pane Enables you to view the viewpoint in a hierarchy.

4 Main pane Enables you to view the viewpoint according to the

following options:

▪ List or tile view by clicking .

▪ Adjust the zoom level of the viewpoint

▪ View the viewpoint in a hierarchy by clicking

When selecting a job, click to view the

predecessor and successor jobs.

5 Properties pane Displays the properties of the selected entry, such

as general properties, job settings, logs, output, etc. For more information, see Job details (on page

285).


15

Services navigation

Services enable you to do monitor regular services and perform job actions. For Job view navigation, see

Jobs view navigation (on page 17).

The following figure shows the services in the left pane and the related details of the selected service in

the right pane:


16

The following table describes the various actions you can perform in the Service view:

Calllout Area Description

1 Tab You can view the following:

▪ Services tab

▪ Viewpoints tab

▪ Any opened services

By clicking you can do the following:


▪ Archive search

▪ For viewpoints options, see Viewpoint

navigation (on page 12).

2 Ribbon You can do the following:

▪ From the Today dropdown list, view the details

of a service from specific date, as described in

Viewing the history of services (on page 268).

▪ From the Actions dropdown list, hold and

release the selected service, as described in

Service management (on page 267).

▪ Refresh the Service view manually by clicking

.

NOTE: The services are automatically refreshed

at defined intervals.

▪ Order a service, as described Ordering a service

(on page 268).

3 Main area You can do the following:

▪ Manage your favorite services by clicking

.

In the Favorites - Rules window, you can type

in the names of services to display. You can

also use wildcards for service names.

Click next to each Service to add or remove

the selected service to your list of favorites.

▪ View ordered services by clicking

▪ Filter your services by clicking Filter.

▪ View the Services in tile or list view by clicking


17

Calllout Area Description

For more information about the list view see Service details (on page 270). You can also

choose which fields you want to appear in List view, by right-clicking any column and selecting

the items you want.

4 Properties pane The properties pane on the right hand side of the

window enables you to view the following:

▪ Summary

▪ Errors

▪ Parameters

▪ Log

▪ Tickets

For more information see Service details (on page

270).

Jobs view navigation

The following figure shows jobs in a specific service or viewpoint and the related details of the selected

job in the right pane:


18

The following table describes the various actions you can perform in the Jobs view:


1 Ribbon Enables you to do the following:

▪ Refresh the jobs manually by clicking

NOTE: The jobs are automatically refreshed at

defined intervals.

▪ Perform job actions by selecting one of the

options from the Actions dropdown list, as

described in Job management (on page 272).


2 Navigation pane Lists the entities according to the defined hierarchy

in a tree view.

3 Main pane Enables you to view jobs according to the following

options:

▪ View the jobs in a list or tile view by clicking

▪ View the jobs in a hierarchy by clicking

▪ Adjust the zoom level of the jobs

When selecting a job, click to view the

predecessor and successor jobs.

4 Properties pane Displays the properties of the selected entry, such as general properties, job settings, logs, output,

etc. For more information, see Job details (on page

285).

Managed File Transfer domain navigation

The following image displays the Managed File Transfer domain page navigation, and each area in the

interface.


19

The following table describes the areas in the Managed File Transfer domain


1 Search Enables you to search for filename, application, or job name.

2 Main pane Displays the search results.

3 Transfer details Displays the transfer details in the General or Job Output tabs.

For more information, see Searching for a file transfer (on page 283).

Changing your password

This procedure describes how to change your password.

Before you begin

▪ Ensure that you have permissions to change your password. If you do not have permissions, contact

your Control-M administrator.

➢ To change your password:

1. From the Home page, in the upper right-hand corner, from the username drop-down list, select

Change Your Password.

The Change Your Password window appears.


20

2. Do the following:

a. In the Current Password field, type your current password.

b. In the New Password field, type your new password (6-32 characters).

c. In the Confirm Password field, type your new password again to verify it.

3. Click Save.

The new password is saved.

Control-M Web deep linking

The Control-M Web URL contains all the information needed to point to a particular item. You can use

deep linking to bookmark a certain URL, share specific workspaces, searches, and services. You can also

use the URL in shout messages, e-mail, and remedy tickets.

After the host, port and application name (http://vw-tlv-ctm-qag2:18080/ControlM) there is a

hashtag then the domain name, as follows:

▪ http://vw-tlv-ctm-qag2:18080/ControlM/#Planning

▪ http://vw-tlv-ctm-qag2:18080/ControlM/#Monitoring

▪ http://vw-tlv-ctm-qag2:18080/ControlM/#MFT

The parameters section in the URL is marked with a colon (:) and parameters are separated by an

ampersand (&). Each parameter is displayed in this format: Name=Value.

Here are a few examples for each domain:

▪ MFT: File transfer search example

http://vw-tlv-ctm-qag2:18080/ControlM/#MFT:id=mft_2&search=dd

Id is the tab index (optional), and search is the search term (can be omitted to open an empty

search).

▪ Monitoring:

• Services view in history: http://vw-tlv-ctm-qag2:18080/ControlM/#Monitoring:date=20170702

Date format is YYYYMMDD

• Service View:

http://vw-tlv-ctm-qag2:18080/ControlM/#Service:id=S%252FD%252F1%252F%252F%252F1706

15&name=a&ctm=vw-tlv-ctm-qag2&date=20170615

Id is the service id, name is the service name, ctm is the Control-M/Server name, and date

(YYYYMMDD) is optional for historical view

• Job search: http://vw-tlv-ctm-qag2:18080/ControlM/#Search:id=Search_1&search=ff

Id is the tab index, search is the search term (can be omitted to open an empty search).

• Job neighborhood:

http://vw-tlv-ctm-qag2:18080/ControlM/#Neighborhood:id=05wff&ctm=vw-tlv-ctm-qag2&name=

Dummy_Job%2523349&date=170704


21

Id is the order ID, and ctm is the Control-M/Server name, name is the job name, and date= order

date

▪ Planning:

• Workspace directly: http://vw-tlv-ctm-qag2:18080/ControlM/#JobFlow:name=Workspace_321

Name is the workspace name

Logging out of Control-M Web

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

➢ To log out of Control-M Web:

▪ From the Home page, in the upper right-hand corner, from the username drop-down list, select Log

Out.

You are now logged out of Control-M Web. To log-in, see Logging in to Control-M Web (on page 8).

22

2 2

Control-M Web Planning Domain

Control-M Web Planning domain enables you to do the following:

▪ Create, edit and submit job definitions as requests through a web application.

▪ Create, edit and check-in job definitions to the Control-M database through a web application.

▪ Order individual jobs/folders and Workspaces.

You can create and edit job definitions with the aid of administrative regulations as described in Planning

domain administrative regulations (on page 22).

You can do the following in the Planning domain:

▪ Setting up a Control-M Web Workspace (on page 247): Set up a new Workspace or edit an existing

one. For more information, see Control-M Web Workspaces (on page 244).

▪ Creating a new Workspace (on page 248): Define or edit jobs/folders as a new Workspace, which

includes all your job definitions, such as, scheduling and job prerequisites.

▪ Submitting a Workspace as a request (on page 257): Submit your Workspace as a request to a

Control-M Scheduler to be part of the Control-M definitions.

▪ Checking in a Workspace (on page 259): Check-in your Workspace to the Control-M database. This

option appears only if it is enabled by your Control-M Administrator.

Planning domain administrative regulations

To help you create new job definitions that comply with your organization's standards, the Control-M

Administrator assists in the process of job/folder definitions through administrative regulations.

These regulations aid you in knowing what parameters to define and what formats to use to define them.

The regulations also aid you in defining specific parameters that are specific to your business.

When Setting user preferences (on page 8), you can set a User View. The name of the User View that is applicable to you is provided to you by your Control-M Administrator. The User View customizes your job

properties pane that includes the various parameters for the specific job. Once you set the User View, the job properties pane displays only the parameters that are relevant to you. That is why, if referring to the

documentation of parameters, you might notice that some of the parameters are not applicable to you.

When Creating a new Workspace (on page 248) and Creating a Sub Folder (on page 25), you are asked

to select the following:


23

▪ Site Standard: Enables you to define parameters according to regulations set by your Control-M

Administrator. These standards function as rules to your specific parameter definitions. They include

parameter length, specific patterns that must be used when defining parameters, and more. For example, your Control-M Administrator can specify that for your Workspace, every Job Name must

start with JOB.

The name of the Site Standard that is applicable to you is provided to you by your Control-M

Administrator. The Site Standard you select applies to all entities in the Workspace.

▪ Business Parameter: Enables you to define pre-defined values for specific parameters in your

Workspace that comply with your organization's standards.

The name of the Business Parameter that is applicable to you is provided to you by your Control-M

Administrator.

Note: If Control-M Web is integrated 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 Workspace does not meet the requirement set in the change management

system for submitting a Workspace, you cannot submit the Workspace unless the issue is resolved. For

more information, please contact the relevant individual in your organization.

Job Definition

After Setting up a Control-M Web Workspace (on page 247) and Creating a new Workspace (on page

248), you can start defining your jobs/folders.

Job definition includes the following:

▪ Creating a job (on page 26): Enables you to define a job that includes the following types of

parameters:

• Job types (on page 29): Enables you to set parameters that define what, how, and where the

specific job type runs.

• Job Scheduling (on page 186): Enables you to set options that define when the job and folder

runs.

• Job prerequisites (on page 203): Enables you to set parameters that define job submission criteria

that must be met for a job to run.

• Job actions (on page 209): Enables you to set parameters that define actions for Control-M to perform based on various job run events, such as specific output patterns and the job completion

status.


24

▪ Creating a Sub Folder (on page 25):

• Regular folder: Enables you to define containers of one or more jobs, which allows you to

organize your jobs according to schedules or resources. You can create only one regular folder in a job flow, and assign the folder to a specific Control-M/Server. You can also assign the folder to

a specific Site Standard and Business Parameter, which enforces the Site Standard regulations on the folder entities. The Business Parameter applies the rules defined by your Control-M

Administrator that apply to your business needs.

• SMART folder: Enables you to define containers of one or more jobs, which allows you to organize your jobs according to schedules or resources. The jobs in a SMART folder (for non-z/OS

jobs) can inherit definitions from parent SMART folder. You can also assign the folder to a specific Site Standard and Business Parameter, which enforces the Site Standard regulations on the folder

entities. The Business Parameter applies the rules defined by your Control-M Administrator that

apply to your business needs.

Creating a Folder/SMART Folder

This procedure describes how to create a Folder/SMART folder, which enables you to create job

definitions that are contained in these folders.

Before you Begin

▪ Ensure you have successfully completed Creating a new Workspace (on page 248).

▪ Take into consideration that some parameters/options might not appear in your properties pane, if

they were not specified in the User View you applied.

➢ To create Folder/SMART Folder:

1. In the Workspace, click , and from the list drag and drop the Folder template into the

Workspace.

The Folder parameters appear in the right pane.

2. Define the following:

a. Select the relevant Site Standard from the drop-down list

b. If the Site Standard you selected contains Business Parameters, select the relevant Business

Parameters.

c. Select the relevant Control-M. If you created the Folder under a Control-M container, the value is

defined by default and you cannot select a different Control-M.

d. Select the Folder type, regular or SMART. If you have a Site Standard applied, with Folder type

restrictions, the Folder type is dependant on the Site Standard rules.

3. Click Create.

The folder properties are enabled for definition.

4. To define Folder parameters, see Sub folder parameters (on page 180).

If you are defining a SMART folder, jobs can inherit scheduling, dependency, and action settings. To

define these settings, see:

▪ Job Scheduling (on page 186)


25

▪ Job prerequisites (on page 203)

▪ Job actions (on page 209)

Follow the instructions according to what you select. Your folder has been created. To start creating

jobs in the folder, see Creating a job (on page 26).

You can delete a Folder and its entities, however, take note if you do not have authorizations to the

deleted Folder or one of the jobs in the Folder, the check-in fails.

Copying and pasting Folders

This procedure describes how to copy and paste Folder, which enables you to

➢ To copy and paste Folders:

1. In the Workspace, select the Folder you want to copy.

2. To copy a Folder, do one of the following:

• Right click the selected Folder, and select Copy.

• Select the Folder you want to copy, and from the toolbar, select .

3. To paste a Folder, do one of the following:

• Right click in the area you want to paste the Folder, and select Paste.

• Click on the area you want to paste the Folder, and from the toolbar, select .

If you paste a SMART Folder into another SMART Folder, that copied folder is a sub-folder. You

cannot paste a Folder in a regular Folder.

The copied Folder's name contains a suffix "copy". You can change the Folder name if needed.

If you copy a Folder that contains conditions, the conditions are copied with a number suffix at

the end of the condition name.

Creating a Sub Folder

This procedure describes how to create a Sub Folder within a SMART folder, which enables you to create

job definitions that are contained in these folders.


26

Before you Begin




➢ To create a Sub Folder:

1. In the Workspace, click , and from the list drag and drop the Folder template into the

Workspace.

A Sub Folder is created. The folder properties appear in synopsis view in the right pane.

If you have a Site Standard applied, the relevant parameters' pattern parts are automatically

populated.

2. Click to edit the folder properties.

The folder properties are enabled for definition.

3. To define sub folder parameters, see Sub folder parameters (on page 180).

If you are defining a SMART folder, jobs can inherit scheduling, dependency, and action settings. To

define these settings, see:

▪ Job Scheduling (on page 186)

▪ Job prerequisites (on page 203)

▪ Job actions (on page 209)

Follow the instructions according to what you select. Your folder has been created. To start creating

jobs in the folder, see Creating a job (on page 26).

Creating a job

This procedure describes how to create a job, which enables you to define what, where, and when a job

runs.

Before you Begin




➢ To create a job:

1. In the Workspace, click drag and drop the job template into the Workspace.

A job is created. The job properties appear in synopsis view in the right pane.

If you have a Site Standard applied, the relevant parameters' pattern parts are automatically

populated.

2. Click to edit the job properties.


27

The job properties are enabled for definition.

3. Do one or more of the following:

• Define General parameters, according to the selected Job types (on page 29).

• Define scheduling criteria, as described in Scheduling a job/Folder (on page 186).

• Define job dependencies, as described in Job prerequisites (on page 203)

• Define job actions to be performed after job processing, as described in Job actions (on page

209).

To define Application plug-in jobs, click F1 in the job properties pane to view information on the

relevant job.

4. Click , to validate the definitions according to the selected Site Standard. For more

information, see Validating job definitions in a Workspace (on page 256).

If the Site Standard is set to none, the definitions are validated according to Control-M rules.

5. To save the Workspace, click .

The Workspace remains in User Works status. You can either submit the Workspace as request, as described in Submitting a Workspace as a request (on page 257), or check it in as described in,

Checking in a Workspace (on page 259).

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. In the Workspace, select the job.

The job properties pane appears on the right.

2. Click .


3. In the General tab, in the Variables area, click .

4. From the 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>


28

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

5. In the field, type a variable name.

6. If Named Pool is selected, the Pool Name field appears. In the Pool Name field, type the name

of the pool.

7. In the Value field, type the value of the variable.

In the String field, you can view the full variable string.

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.


29

Job types

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

Job type Description

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

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

File Transfer job parameters (on

page 41)

Defines the File Transfer job parameters for Control-M for

Advanced File Transfer Application Plug-in.

Databases job parameters (on

page 49)

Defines the Databases job parameters for Control-M for

Databases Application Plug-in.

File Watcher job parameters (on

page 51)

The File Watcher job type defines the ctmfw (Control-M File

Watcher) utility job to monitor file status and detect file

processes.

Informatica job parameters (on

page 53)

Defines the Informatica job parameters for Control-M for

Informatica Application Plug-in.

NetBackup job parameters (on

page 55)

Defines the NetBackup job parameters for Control-M for

Backup Application Plug-in.

OS/400 job Full parameters (on

page 57)

Enables 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

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.

SAP Business Objects job

parameters (on page 85)

Defines the SAP Business Objects job parameters for Control-M

for SAP Business Objects Application Plug-in.

SAP Business Warehouse job


Defines the SAP Business Warehouse job parameters for

Control-M for SAP Application Plug-in.

Batch Impact Manager job


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.

Amazon EC2 job parameters (on

page 96)

Defines the Amazon EC2 job parameters for Control-M for

Cloud Application Plug-in.


30


BladeLogic job parameters (on

page 98)

Defines the BladeLogic job parameters for Control-M for Cloud

Application Plug-in.

VMware job parameters (on

page 98)

Defines the VMware job parameters for Control-M for Cloud


IBM Cognos job parameters (on

page 100)

Defines the IBM Cognos job parameters for Control-M for IBM

Cognos Application Plug-in.

Control-M Report job parameters

(on page 104)

Enables you to define templates that you can use to generate

reports that provide important information about your

Control-M job flow.

Java job parameters (on page

109)

Defines the Java job parameters for Control-M for WJM


Mapper job parameters (on page

111)

Defines the Mapper job parameters for Control-M/Agent for

Mapper System 2200

Messaging job parameters (on

page 112)

Defines the Messaging job parameters for Control-M for WJM


OEBS job parameters (on page

116)

Defines the OEBS job parameters for Control-M for Oracle

E-Business Suite Application Plug-in.

Oracle Business Intelligence job


Defines the Oracle Business Intelligence job parameters for

Control-M for Oracle Business Intelligence Application Plug-in.

OS2200 (on page 123) 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.

PeopleSoft job parameters (on

page 127)

Defines the PeopleSoft job parameters for Control-M for

PeopleSoft Application Plug-in.

SAP Data Archiving job


Defines SAP Data Archiving job parameters for Control-M for

SAP Application Plug-in.

SAP R3 job parameters (on page

136)

Defines SAP R3 job parameters for Control-M for SAP

application Plug-in.

Tandem job parameters (on

page 147)

Supports running jobs on other platforms, and enables you to define jobs, retrieve job parameters, and control jobs running

on the Guardian operating system.


31


Web Services parameters (on

page 153)

Defines the Web Services job parameters for Control-M for

WJM Application Plug-in.

Hadoop job parameters (on page

157)

Defines Hadoop job parameters for Control-M for Hadoop


Tivoli Storage Manager job


Defines IBM Tivoli Storage Manager job parameters for

Control-M for Backup Application Plug-in.

Azure job parameters (on page

184)

Defines Azure job parameters for Control-M for Azure


AWS job parameters (on page

185)

Defines AWS job parameters for Control-M for AWS Application

Plug-in.

For information on the relevant Application Plug-in, click F1 in the job properties pane of the relevant job.

OS job parameters

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


32

NOTE: Take into consideration that some parameters might not appear in your properties pane, if they

were not specified in the User View you applied. Use Control-M rules if the parameter rules were not

specified by the Site Standard.

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.

Control-M rules:

▪ 1-64 characters

▪ Case Sensitive

▪ Invalid Characters:

Single quotation marks

"$", "/", "*", "?", " "

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 job flow.

Control-M rules:

▪ 1-4000 characters

▪ Case Sensitive

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.

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


33


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

computer and is part of the job definition.

Control-M rules:

▪ 64000 B

▪ Case sensitive

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.

Control-M rules:

▪ 1- 512 characters

▪ Case sensitive: Microsoft Windows: No, UNIX: Yes

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


Control-M rules:

▪ 64000 B

▪ Case sensitive

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

Control-M rules:

▪ Microsoft Windows, UNIX, OpenVMS: 1-255 characters

▪ iSeries (AS/400): 1-10 characters

▪ Case sensitive

▪ Invalid characters: Blanks, If the job runs on any version of Microsoft

Windows 2000, prohibited filename characters (such as \, /, or *)


34


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

Control-M rules:

▪ Microsoft Windows, UNIX, OpenVMS: 1-64 characters


▪ Case sensitive

▪ Invalid characters: Blanks, \, /, or * (Blanks and / can be used when

defining an OS/400 job) Character masks are not supported (for example,

a job with a FR*.EXE File Name value is not executed).

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

host group where the job is submitted.

Control-M rules:

▪ 1-50 characters

▪ Invalid characters: Blanks, Single quotation marks

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.

Control-M rules:

▪ 1-30 characters

▪ Case sensitive



35


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.

Control-M rules:

▪ Microsoft Windows, UNIX, OpenVMS: 1 through 255 characters

▪ iSeries (AS/400): 1 through 10 characters

▪ Case sensitive

▪ Invalid characters: Blanks.

If the job runs on any version of Microsoft Windows 2000, prohibited

filename characters (such as \, /, or *)

Pre-execution Specifies a command to run immediately before running the job defined by the What parameter. The return code is ignored. Control-M rule: 1-4000

characters

Post-execution Specifies a command to run immediately after running the job defined by the What parameter. The return code is ignored. Control-M rule: 1-4000

characters

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.

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.

End folder on job

completion

Indicates that when the job run completes, all scheduled job runs contained in

the SMART folder will not run until the next cycle.

If there are jobs still running, the SMART folder waits for the jobs to complete

their run.

If there are sub-folders that are running that do not contain running jobs, the

sub-folder will end.

NOTE: To enable this option, you must have full User Views set in User

preferences (on page 9).


36


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.

Control-M rules:

▪ Name: 1-40

▪ Value: 1-4000

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.

Control-M rules:

▪ Case sensitive

▪ Invalid characters: Blanks, single quotation marks

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.

Control-M rules:

▪ 1-64 characters

▪ Case sensitive


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

Control-M rules:

▪ 1-64 characters

▪ Case sensitive


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.


37


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.

Control-M rules:

▪ Combines the length of Doc Member/ Doc File 64 characters and Doc

Library/ Doc Path 255 characters.

▪ File Length: 1-64 characters

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

Control-M rules:

▪ Microsoft Windows and UNIX: 1-255 characters


▪ OpenVMS: 1-60 characters

▪ Case sensitive

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

Control-M rules:

▪ 1-64 characters

▪ Case sensitive

▪ No blanks

Priority Determines the order of job processing.

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

resources allocation order.

z/OS job parameters

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


38







job ru7.51n. Jobs defined as Dummy provide instructions for Control-M such

as post-processing actions. Value: z/OS


Control-M rules:

▪ 1-8 characters

▪ Case sensitive

▪ Invalid characters: Single quotation marks, "$", "/", "*", "?", " "

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 job flow.

Control-M rules:


▪ Case sensitive



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.

Member Library Indicates the location of the Member that contains the JCL, started task

procedure, or Warning message.

Control-M rules:

▪ 1-44 characters

▪ Invalid characters: Non-English characters


39


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

Control-M rules:

▪ 1-8 characters


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. Control-M rule: 64000 B

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


parameter is used by the Control-M security mechanism. Control-M rule: 1-8

characters

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.

Control-M rules:

▪ 1-44 characters

▪ Invalid characters: Non-English characters. The contents of this field must

not begin with the following strings:

▪ GENERAL

▪ USER=

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. Control-M rule: Invalid

characters: Single quotation marks, Blanks


40


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.

Control-M rules:

▪ 1-64 characters

▪ Case Sensitive

▪ Invalid Characters: Single quotation marks, Blanks

Scheduling

Environment

Indicates the JES2 workload management scheduling environment that is to

be associated with the job.

Control-M rules:

▪ 1-16 characters

▪ Case Sensitive

▪ Invalid Characters: Non-English characters, Blanks

System Affinity Indicates the identity of the system in which the job must be initiated and

executed (in JES2). Control-M rules:

▪ 1-5 alpha-numeric characters

▪ The alpha-numeric characters can be proceeded by a "/". "/" as a first

character indicates NOT in JES3.


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

Control-M rules:

▪ 1-8 characters

▪ Invalid Characters: Single quotation marks,"$", "/", "*", "?", " "

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.

Control-M rules:

▪ 1-20 characters

▪ Invalid characters: Blanks


41


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


Control-M rules:

▪ Name: 1-66 characters

▪ Value: 1-66 characters

NOTE: Name and Value length together should not exceed 66 characters.

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. Control-M rules:

▪ 1-44 characters


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

is saved.

Control-M rules:

▪ 1-8 characters



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

File Transfer job parameters

The following table describes the parameters for a File Transfer job:


42





Connection profile Defines a file transfer connection.

Control-M rules:

▪ Up to 30 characters

▪ Case sensitive

▪ Must begin with a letter and contain alphanumeric characters and

underscores. Must not contain blanks, @, or . characters.

File Transfer

Direction

Determines watch and transfer source and destination.

Binary/ASCII/Ebcdic Defines the file transfer mode as Binary, ASCII or Ebcdic.

End job NOTOK

when "Continue on failure" option is

selected

Sets the job status to NOTOK when the Continue on failure checkbox is

selected in the General tab in the Advanced dialog box, and the transfer

failed.

Rerun from point of

failure

Resumes the file transfer from the point that it failed.

Transfer Location Defines the source and destination locations on the host computers.

Control-M rules:


▪ Case sensitive

Use default number

of retries

Uses the default number of retries to re-establish a failed connection.

If you are using an MVS platform, this checkbox is disabled.

Number of retries Determines the number of connection attempts between 0-99 after a

connection failure to an FTP server.

Host(/Group) Defines the name of the host computer.

OS Type Defines the operating system of the host computer.

User Defines the user of the selected host.

Type Defines the type of the transfer protocol; LOCAL, FTP, FTP-SSL, and SFTP.


43

File Transfer Advanced General parameters

The table below lists the parameters in the General tab in the Advanced dialog box.


44





After the completion of a successful file

transfer the source

file will be

Determines how a source file is handled after a successful transfer.

File Name Determines the path and name of the file.

Control-M rules:


▪ Case sensitive

If a file of the same name as the

destination file

already exists

Determines what to do to a file that has the same name as the destination file.

After the completion

of a successful file

transfer the destination file will

be

Determines how a destination file is handled after a successful transfer.

Create empty file in

destination

Creates an empty file after a transfer on the destination host. This feature

does not work in Recursive mode.

Temporary File

Prefix

Prevents overwriting files by attaching a temporary file prefix, such as FTP_ to

the destination file until the transfer completes successfully. Control-M rules:

Up to 99 characters

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

DO post AFT

command on failure

Activates the defined post commands when the job fails

Delete Destination

file on failure Deletes the destination file if the transfer failed

Fail transfer when action on source file

failed

Determines whether to fail the transfer when a post action on the source file

fails after a successful transfer


45

File Transfer OS400 parameters

The table below lists the parameters in the OS400 tab in the Advanced dialog box.


Trailing blanks Define how trailing blanks are handled during OS/400 transfers.

Allow Transfer of Files

with NULL Fields

Transfers files to an OS400 platform with NULL fields.

Allow OS400 IFS Case

Sensitive Mode Supports the transfer of case sensitive file systems.

File Transfer MVS parameters

The following table lists the parameters in the MVS tab in the Advanced dialog box.


46





Template Name Defines the name of the MVS template that is defined in MVS File Template

Management.

Control-M rules:


▪ Case sensitive

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

DBCS Encoding Determines which DBCS data sets is used for the transfer

Additional Options Defines MVS FTP Server SITE command sub-parameters and values (214

characters maximum)

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

Transfer Mode Determines the mode used to transfer files

SMS Management

Class

Determines which SMS Management Class is assigned to a new data set.

Control-M rule: Any character up to 8 characters.

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

Control-M rule: Any characters up to 8 characters


47


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 File Transfer client

File Transfer SFTP parameters

The following table lists the parameters in the SFTP tab in the Advanced dialog box.


Compression Compresses the file before the transfer

Preserve the File

Attributes and

Timestamps

Preserves the source’s file permissions and timestamps on the

destination host


48

File Transfer commands parameters

The table below lists the parameters in the Commands tab in the Advanced dialog box.


FTP pre command Defines the pre-command for each host.

FTP first pre command Defines the first pre-command parameter for each host.

FTP second pre

command

Defines the second pre-command parameter for each host.

FTP post command Defines the post command for each host.

FTP first post

command

Defines the first post command parameter for each host.

FTP second post

command Defines the second post command parameter for each host.

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.

Keep encrypted files Saves the PGP encrypted file after encryption.

File Transfer File Watcher parameters

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


49

NOTE: In the job log file, if the Compstat parameter is 7 it indicates that file watch failed.


Minimum detected size Defines the minimum number of bytes transferred before

Control-M File Transfer checks if the file is static.

File size information for remote file systems is not supported. On zSeries, iSeries, Tandem, and OS2200 platforms, only file existence

is checked.

Time limit Determines the number of minutes to wait, in the Time Limit field, for a file to reach its minimum detected size and remains static,

before the watch fails or determines the specific time, in the Time

Limit field, that a file has to reach its minimum detected size and

remains static, before the watch fails.

Time limit type Determines whether the values defined in the Time Limit field are

number of minutes to wait or an absolute time.

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.

Variable containing

detected file name Defines the variable name that contains the detected file name.

Databases job parameters

The following table describes the parameters for a Databases job:


50





Connection Profile Defines the name of the Control-M for Databases connection profile.

Control-M rules:


▪ Case sensitive

Execution Type Defines the database job as a stored procedure, SQL Script, SSIS package, or

Open Query.

Auto Commit Commits statements that complete successfully to the database. It is available

for all execution types except for SSIS.

Query Defines the database job as an Embedded Query job. Control-M rule:

1-4096 characters

Schema Filters stored procedures results according to schema names. Control-M

rule: 1-4096 characters

Package Filters stored procedures results according to package names. Control-M

rule: 1-4096 characters

Name Defines the name of the stored procedure. Control-M rule: 1-4096

characters

Parameter Name Defines the names of the stored procedure parameters. Control-M rule:

1-4096 characters

Value Defines the parameter values of the store procedure and SQL script.

Control-M rule: 1-4096 characters

Auto-Edit Variable

Defines the variable name that stores the OUT and Return parameters result

in stored procedure submission. Control-M rule: 1-4096 characters


51


Variable Defines the variables of the SQL Script. Control-M rule: 1-4096 characters

Query text Defines the content of the SQL Script. Control-M rule: 1-4096 characters

Data Type Defines the data type of the stored procedure, such as string or integer.


Parameter Type

Defines the stored procedure column type as IN or OUT. Control-M rule:

1-4096 characters

Append log to

sysout Shows the execution log in the job output.

Append output to

sysout

Shows the output in the job output.

Select output format Defines the output format as either text, XML, CSV, or HTML.

Package Source Defines the location of the SSIS Package in SQL Server, File System, or SSIS

Package Store.

Package Name Defines the name of the SSIS Package. Control-M rule: 1-4096 characters

Environment Defines the environment that an SSIS catalog runs on.

SSIS Configuration

File Names

Defines the names of the configuration files that are added to the SSIS

package. Control-M rule: 1-4096 characters

SSIS Parameter

Names

Defines the name of each SSIS property path. Control-M rule: 1-4096

characters

SSIS Parameter

Values

Defines the values of each SSIS property path. Control-M rule: 1-4096

characters

Job Name Defines the name of MSSQL Agent job, which was defined in MSSQL Server.


Category Determines the category of the MSSQL job. Control-M rule: 1-4096

characters

File Watcher job parameters

The following table describes the General parameters for a File Watcher job:


52





Run As Identifies the user name with the authorization to execute the job. This


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 FILE parameter contains wildcards (unless the monitor file size when wildcard

is used parameter is set to Y) or if the mode parameter is set to DELETE.

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 (unless the

monitor file size when wildcard is used parameter is set to Y) 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 detected size (indicating successful creation of the file). This parameter is ignored when using wildcards in FILE

unless the monitor file size when wildcard is used parameter is set to Y) or

when using DELETE mode.

Search interval Interval between successive attempts to detect the existence/deletion of a

file (in seconds).

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.

Wildcard support Indicates whether file size should be monitored if the filename contains

wildcards. This parameter is ignored if the filename does not contain a

wildcard.


53


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

from the dropdown list, select start immediately.

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

dropdown list, select No stop time.

Maximal age Indicates the maximum amount of time that can pass since the file you want to watch was last modified or from the dropdown list, select No Maximal

age.

Minimal age Indicates the minimum amount of time that must have passed since the file you want to watch was last modified or from the dropdown list, select No

Minimal age.

Informatica job parameters

The following table describes the parameters for an Informatica job:


54





Connection Profile Defines the name of the Control-M for Informatica connection profile.

Control-M rule: Up to 30 characters (capital letters only)

Repository Folder Defines the Repository folder that contains the workflow that you want to run.

Workflow Defines the workflow that you want to run in Control-M for Informatica

Instance Name Defines the specific instance of the workflow that you want to run

OS profile Enables you to specify an OS profile when running or rerunning an Informatica

job.

Depth Determines the number of levels within the workflow task hierarchy that is

used to select workflow tasks

Run Determines whether to run the whole workflow, start from a specific task, or

run a single task

▪ Run the whole workflow: Runs the whole workflow

▪ Start from task: Starts the workflow from a specific task

▪ Run single task: Runs a specific task

Start workflow from

task

Determines which task starts the workflow

Run single task Determines which task from the workflow to run

Include workflow

events log in job

output

Determines whether to include the workflow event log in the job output

Include detailed

error log for failed

sessions

Determines whether to include a detailed error log for a workflow that failed


55


Action on rerun Determines which operation is executed when the workflow is in a suspended

status.

▪ Recover: Restarts suspended workflow from point of failure

▪ Force restart: Restarts a suspended workflow from the beginning.

▪ Force restart from a specific task: Restarts the suspended workflow that

you define

Workflow

parameters file Determines the path and name of the workflow parameters file

NetBackup job parameters

The following table describes the parameters for a NetBackup:


56





Connection Profile Defines the name of the Control-M for Backup connection profile.

Control-M rule: 1-30 characters (capital letters only)

Policy Name Defines the backup policy name

Schedule Determines what type of backup is performed (full, incremental).

If the field remains empty, the first scheduled backup of the policy

is used.

Client Defines the name of the client where the backup is performed.

If the field remains empty, the backup runs on all clients that are

defined in the policy.

Output Management Determines one of the following output options:

▪ Display log for all jobs in the output

▪ Display log for failed jobs in the output

▪ None

Create jobs per client Determines whether to create an active Control-M for Backup job

for every client that performs a backup.

The job name for each client appears as follows:

<definition_job_name>@<client_name>

NOTE: BMC recommends that you define the Control-M for

Backup job inside a SMART Folder if you have defined IN/OUT

Conditions or Resources.

Restart only failed streams on

rerun

Determines whether to restart the backup for failed jobs when you

rerun the backup job


57

OS/400 job Full parameters

The following table describes the OS/400 job Full What to run options.


Program (on page 63) Enables the job to execute the program specified Program that

resides in Library or Path on the Special environment.

Script File (on page 58) 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

62)

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 other

job schedulers.

Commands (on page 62) Specifies the command line 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 61) 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 61) 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 78) 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.


58


External Job (on page 82) 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.

External Subsystem (on page

82)

Enables you to monitor OS/400 Subsystem that was started

outside of Control-M.

Restricted state action Enables you to execute a job while setting the system into

restricted state.

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.


59

The following table describes the Script File parameters for an OS/400 job.


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. When the

Script file location is Native (QSYS file system), the value of this

field must be specified in one of the following formats:

▪ <File>/<Member>

▪ <File>/

▪ /<Member>

Where File and Member are valid OS/400 object names.

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.


60


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 IBM i (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 66).

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

For more information, see Advanced parameters for OS/400 job

(on page 67).


61

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.

The following table describes the Subsystem parameters for an OS/400 job.


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

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.


62

The following table describes the Job Description parameters for an OS/400 job.


Library Defines the library name. Up to 10 characters, valid OS/400


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

OS/400 multiple commands enable 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 job schedulers.

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 job Full parameters (on page 57)


63

The following table describes the OS/400 Commands and Multiple Commands parameters.


Commands (Multiple Commands only) Specifies the command line to be

executed.

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


page 66).



(on page 67).

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


Log informational messages (Script File, Multiple commands, and VT only) Enables additional

informational messages logged in the job log when the job is

executing.

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 job Full parameters (on page 57).


64

The following table describes the OS/400 program parameters.


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.


65


Program's parameters Defines a Program, Script file or VT script file, which may expect



display options.



▪ Decimal: Defines a decimal number with or without decimal point. The value is passed to the program as packed decimal



▪ Hex: Defines any even number of hexadecimal characters


X'<value>'.

NOTE:





single quotes ('').

▪ A value of *BLANKn will be resolved to n blanks

Resolve special values Indicates whether special values, such as *PGM, *DTAARA, and *FILE, defined in the program's parameters value will be resolved




Submission attributes Enables you to define submission attribute parameters for an


page 66).



(on page 67).


66

Submission Attributes

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


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


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

executing.


67


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

Advanced parameters for OS/400 job

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


Library list Enables you to view and modify OS/400 job libraries. For more

information, see Library list (on page 67).

Environment Enables you to view and modify the environment on which OS/400

jobs run. For more information, see Environment (on page 69).

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 72).

International Enables you to view and modify international parameters. For

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

Messaging Enables you to view and modify messaging parameters. For more

information, see Messaging parameters (on page 76).

Output Enables you to view and modify output parameters for your OS/

400 job. For more information, see Output parameters (on page

77).

Bypass job Enables the job not to run. The following message is generated in

the job's output:

Job was bypassed


Library list

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


68

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

list.

Library List Type one or more of the following library names to be included in

the job's library list. If a special value is specified, it must be the

only entry in the list.

Special values:

▪ *CURRENT

▪ *JOBD

▪ *SYSVAL

▪ *NONE


69

Environment

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


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.


70


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.


71


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.

%%LDA accepts Hex or Binary values and enables special values

(*PGM, *DTAARA, *FILE, ...).

Usage notes:

▪ To set the hex value to *LDA, use the following format in the

Value: *HEX(<hex value>). Example: *HEX(a1b2C3D4)

▪ The <hex value> must have an even number of characters. If

not, the value is not set.

▪ If the Length is specified, only the "Length" number of bytes

is written to the *LDA. For example, if Length=3 and <hex

value>=a1b2c3d4, only a1b2c3 will be written to *LDA.

▪ <hex value> must have a valid hex value (only 0-9,a-f,A-F). If

not, the value is not set.

▪ When applying a special value to *LDA (*PGM, *FILE,

*DTAARA, *HEX, ...) the "Resolve special values" checkbox

must be checked.

▪ If the Length was specified and the resolved length of the value is longer than the specified Length, only <Length>

characters are written to the *LDA.

▪ If the Length was not specified, the resolved length of the

value, and all resolved value's characters are written to the

*LDA.


72

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.


73

NOTE: Pre-submit, Pre commands, post commands and pre statistics are only available for Program,

Script File and Command.

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.


74


Pre Commands

Post Commands

Determines the command line instruction to be executed before or after the specified command line. The following rules apply to Pre

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


75


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.


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.


76

Messaging parameters

The following table describes the messaging parameters for OS/400 jobs.


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


Job message queue maximum

size

Defines the maximum size of the job message queue (02-64) or


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


77

Output parameters

The following table describes the output parameters for OS/400 jobs.


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


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


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


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.

When no value is set for this parameter, the default Spooled files

handling profile value from the Agent configuration is used.

The following special values can be used:

▪ *ALLTOOUTPUT: All spooled files of the job are appended to

the job's output.

▪ *NONE: No spooled file action is taken.


78

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 job Full parameters (on page 57).


79

The following table describes the OS/400 Virtual Terminal (VT) parameters.


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


80


Virtual Terminal's parameters Defines a Program, Script file or VT script file, which may expect



display options.



▪ Decimal - Defines a decimal number with or without decimal point. The value is passed to the program as packed decimal



▪ Hex - Specifies any even number of hexadecimal characters


X'<value>'.

NOTE:





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




Submission Attributes Enables you to define submission attribute parameters for an


page 66).

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.

Terminal attributes Defines the Virtual terminal parameters.


81


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 i

(AS/400) 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 i (AS/400) globalization documentation

Values: IBM

▪ 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 i (AS/400) 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


Password Specify the log in password, use the owner's authentication

repository or set to use the password program.

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.


82


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


Display Program Messages

defaults

Defines the default behavior when the VT job encounters Display

Program Messages screen. For more information, see Display

Program Messages handling.

Bypass job Enables the job not to run. The following message is generated:

Job was bypassed


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 job Full parameters (on page 57).


83

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.


What to run Run one of the following jobs:

▪ External job

▪ External subsystem

External job or External

Subsystem

Defines the name of the external job name or subsystem name.

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.


84


Move to Job Queue Defines the name of a job queue to move the job when the job is


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


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


Set Accounting code Specifies the accounting code to set the job, when the job is


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

(MSGWPRF)

Must be the name of an existing MSGW auto reply profile file that

is located in the Agent Data directory

Spooled files handling profile

(RPTDSTPRF)

Must be the name of an existing Spooled files handling profile file

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.


85

SAP Business Objects job parameters

The following table describes the parameters for an SAP Business Objects job:


86





Connection Profile Defines the name of the Control-M for SAP Business Objects connection profile.


System Defines the name of the SAP Business Objects system that is defined in the

connection profile. Control-M rule: 1-4096 characters.

User Defines the name of the SAP Business Objects user that used to connect to SAP

Business Objects and is defined in the connection profile.

Control-M rules:


▪ Case sensitive

Report name Defines the path and name of the report that you want to run.

Control-M rules:

▪ 1-4096 Characters

▪ Case sensitive: Yes

Report CUID Determines the ID of the report.

Control-M rules:


▪ Case sensitive

Report type Determines whether the report type is Desktop Intelligence, Web Intelligence,

Crystal or a Publication report. Control-M rule: Case sensitive.

Instance title Defines the instance title of the scheduled report.

Control-M rules:


▪ Case sensitive

Report owner Defines the name of the owner of the scheduled report.

Control-M rules:


▪ Case sensitive


87


Prompt name Defines the name of a specific prompt.

Control-M rules:


▪ Case sensitive

Prompt value Defines the value of a specific prompt.

Control-M rules:


▪ Case sensitive

Output formats Defines the report output format. You have the option to override the current

output format. Values must end with a semicolon.

Control-M rule: Case sensitive

Output destinations Defines the report output destination. You have the option to override the

current output destination. Values must end with a semicolon. For Publication reports, multiple values must be separated by semicolons. Control-M rule:

Case sensitive

Email from Defines the source email address of the report. Control-M rule: 1-4096

characters

Email to Defines the destination email address of the report. Control-M rule: 1-4096

characters

Email CC Defines an additional destination email address of the report. Control-M rule:

1-4096 characters

Email subject Defines the subject of the email for the report. This field can contain variables,

which must contain a space or a period at the end. Control-M rule: 1-4096

characters

Email message Describes the message of the email. This field can contain variables, which

must contain a space or a period at the end. Control-M rule: 1-4096

characters.

Email specify name Defines the output filename that is attached to the email.

Control-M rules:


▪ Case sensitive


88


Selected inboxes Determines which SAP Business Objects inbox will receive the report. Multiple values should be separated by semicolons. Value must end with a semicolon.

Control-M rule: 1-4096 characters.

Inbox send as

shortcut

Determines whether the recipient will receive a shortcut to the report. Either

this parameter or %%BO-DEST-INBOX-COPY_RADIO must be set to Y

Inbox send as copy Determines whether the recipient will receive a copy of the report. Either this

parameter or %%BO-DEST-INBOX-SHORTCUT_RADIO must be set to Y

Inbox specify name Defines the output filename that is sent to the recipient’s inbox.

Control-M rules:


▪ Case sensitive

File directory Determines the destination directory of the report output file.

Control-M rules:


▪ Case sensitive

File user name Determines the username used to access the file system location of the report

file.

Control-M rules:


▪ Case sensitive

File use

automatically

generated name

Determines whether the report file is automatically generated. Either this

parameter or %%BO-DEST-FILE-SPECIFIC_RADIO must be set to Y

File use specific

name

Defines the name of the report file. Either this parameter or

%%BO-DEST-FILE-AUTO_RADIO must be set to Y

File specify name Defines the output filename that must be created in the destination directory. If %%BO-DESTFILE-SPECIFIC_RADIO is set to Y, this value must be provided.

Control-M rules:


▪ Case sensitive


89

SAP Business Warehouse job parameters

The following table describes the parameters for an SAP Business Warehouse job parameters:


90





Connection Profile Defines the name of the Control-M for SAP connection profile.


Process Type Determines the task that the job performs.

Process Chain Description Describes a Process Chain. Control-M rule: 1-60 characters

Process Chain ID Defines a unique BW-generated ID of a Process Chain. Control-M

rule: Up to 30 characters

Info Package Description Defines a description of the Info Package. Control-M rule: 1-60

characters

Tech. Name Defines a unique BW-generated InfoPackage ID. Control-M rule:

Up to 30 characters

Background Job Name Name of the InfoPackage background job name. Control-M rule:

1-25 characters

Rerun Options Indicates how the Process Chain should be rerun, if an SAP-BW

job fails.

Detect Spawned Jobs Indicates whether to detect and monitor jobs that were spawned

by the current SAP job.

Detect and Create by Determines the properties of the detected job.

Job name Detected spawned jobs of the current job are extracted to

Control-M with identical properties to the specified job.

Start Spawned job If you select Start Spawned job, Control-M for SAP checks the

status of each spawned job and starts any spawned job with

Scheduled status.

Job ends in Control-M only after

all child jobs complete on SAP

Enables a job to end only after all child jobs complete. If you

deselect the checkbox, a parent job ends in Control-M after all child jobs are detected and monitored by Control-M regardless of

their status.

Job completion status depends

on child job status

Enables Control-M to wait for all child jobs to complete. The

parent job does not end OK if any child job fails.


91

Batch Impact Manager job parameters

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


92





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



Value: Batch Impact Manager


Control-M rules:

▪ 1-64 characters

▪ Case sensitive


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 job

flow. Control-M rules:


▪ Case sensitive


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


93


Service Name Logical name, from a user or business perspective, for the critical service.

BMC recommends that the service name be unique.

Control-M rules:

▪ 1-64 characters

▪ Case sensitive

▪ Invalid characters: Single quotation marks, Blanks

If the job runs on any version of Microsoft Windows 2000, prohibited

filename characters (such as \, /, or *)

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.

Control-M rules:

By:

▪ Specific hour, in the format HH:MM, according to a 24-hour clock.

▪ Valid values range include 00:01 through 99:59

Number of days:

▪ Determine on which day the critical service must complete, relative to ODATE. The value is specified in terms of the number of days after the

order date of the service.

▪ 0 represents the order date, 1 represents one day after the order date,

and so on. Default: 0

In number of hours:

A specified number of hours.

Number of min after:

A specified number of minutes.

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


94


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.

▪ Do: Defines the action.

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.

Control-M rules:

Percentile range: Drop-down list

Average run time +/-:

Percentage: 999

Minutes:999

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

processes the job.



Control-M rules:

▪ 1-30 characters

▪ Case sensitive



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.


95


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


Control-M rules:

▪ Name: 1-40

▪ Value: 1-4000

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.

Control-M rules:

▪ Case sensitive

▪ Invalid Characters: Blanks, Single quotation marks

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.

Control-M rules:

▪ 1-64 characters

▪ Case sensitive



Control-M rules:

▪ 1-64 characters

▪ Case sensitive

▪ Invalid characters:


Blanks

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.


96



following:


format starts with "http://", "ftp://", or "file://".


Control-M rules:

▪ URL Length: Combines the length of Doc Member/ Doc File 64

characters and Doc Library/ Doc Path 255 characters


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.

Control-M rules:




▪ Case sensitive

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.

Control-M rules:

▪ 1-64 characters

▪ Case sensitive





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

Amazon EC2 job parameters

The following table describes the parameters for an Amazon EC2:


97





Connection Profile Defines the Amazon EC2 Connection Profile. Control-M rule: 1-30 characters

(capital letters only)

Operation Determines whether the job definition will create, start, stop, reboot, or

terminate a VM instance

AMI ID Defines the ID of the Amazon Machine Image from Amazon EC2

Number of Copies Determines the number of VM instances that are created. Supports only

numbers greater or equal to 1.

Host Group Defines the name of the host group that you want this VM instance to join

Availability Zone Determines the geographical location of the VM instance

Instance Type Determines the hardware specifications for the VM instance

Launch Instances

into your Virtual Private Cloud

checkbox

Determines whether to extend your existing security and management policies

to your VPC so that the EC2 objects run as if they were in your own

infrastructure

Subnet ID Determines a subset of IP addresses within your VPC

Key Pair Determines the name of the key that authenticates the VM instance

Security Group Determines the security encryption format for the VM instance

Kernal ID Defines the operating system kernal Id

RAM Disk ID Defines the ID of the RAM Disk

Placement Group Defines the placement group

Monitoring Determines whether to enable monitoring of CPU, Disk, and Network usage in

Amazon EC2

User Data Defines free text data about the VM instance

IP Address Defines the IP address for your VPC


98


Tags Defines the names and values to the VM instances that help you organize, browse, and search your resources. For example, Key = Name, Value = Web

server

Instance ID Determines the name of the instance ID that is used to start, stop, reboot, or

terminate the VM instance

BladeLogic job parameters

The following table describes the parameters for a BladeLogic job:

NOTE: Take into consideration that some parameters might not appear in your properties pane, if they were not specified in the User View you applied. Use Control-M rules if the parameter rules were not



Connection Profile

(BladeLogic)

Defines the BladeLogic connection profile. Control-M rule: 1-30 characters


Job Folder Name Defines the name of the folder and location of the BladeLogic job

Job Name Defines the name of the BladeLogic job

Job Type Determines the BladeLogic job type. There can be two or more BladeLogic jobs with the same name, but they must belong to different job types.

Control-M Rule: Case sensitive

Enable Output Determines whether the BladeLogic job log is generated in the job output

VMware job parameters

The following table describes the parameters for a WMware job.


99





Connection Profile

(VMware)

Defines the VMware connection profile. Control-M rule: 1-30 characters


Category Determines the task type to perform

Virtual machine name

full path

Defines the name and location of the VM where a task is performed

Task Determines which task is performed on the VM

New Virtual Machine

Name Defines the clone hostname of the new VM

Host Determines which host the VM is connected

Resource Pool Determines which resource pool the VM is connected

Datastore Determines which data source the VM is connected

Customization

Specification

Determines a specific customization that is applied to this VM after it is

created

Post Action Determines to power on or mark as template after you clone a VM

Priority Determines which priority level the VM server applies to the migrate task

Power State Determines the power state that the VM needs be set at to perform the

configuration task.

Snapshot Name Defines the name of the snapshot that you want to perform a snapshot task

Snapshot Description Describes details about the snapshot

Snapshot the virtual

machine's memory Determines whether to take a snapshot of the VM’s memory

Ignore task if already in desired power

state

Determines whether to ignore the task if already in the required power state

Quiesce guest file

system

Pauses the running processes on the VM so that file system contents are in a known consistent state when the snapshot is taken. This applies only to VMs

that are powered on.


100


Edit Device Settings Determines configuration settings for CPUs, memory and disk size.

Reconfigure VM only.

Virtual Device Name Defines the name of the virtual hard disk

Memory Size Determines the number of MB or GB in memory that are allotted to the VM.

Control-M rule: Supports number that are greater or equal to 1.

Provisioned Size Determines the number of MB, GB, or TB that are provisioned for the VM

disk. Control-M rule: Supports number that are greater or equal to 1.

Disk Unit Determines whether the disk size is in MB, GB, or TB

Mem Unit Determines whether the memory size is in MB or GB

IBM Cognos job parameters

The following table describes the parameters for an IBM Cognos job.


101





Connection Profile Defines the Control-M for IBM Cognos Connection Profile.


Search path Defines the path and name of the job or report that you want to

run. Control-M rules:


▪ Case sensitive

Location Defines the path and name of the job or report that you want to run

in a readable format.

Control-M rules:


▪ Case sensitive

Type Determines whether the type is job, report, or reportView.

Control-M rule: Case sensitive.

Prompt name Defines the name of a specific prompt when the type is report or

reportView.

Control-M rules:


▪ Case sensitive

Prompt value Defines the value of a specific prompt when the type is report or

reportView.

Control-M rules:


▪ Case sensitive

Burst the report Determines if the report is run as a burst report. Control-M rule:

Case sensitive


102


Output formats Defines all the report output format. You have the option to override the current output format. Values must end with a semicolon. Case

sensitive. Following formats:

▪ CSV

▪ HTML, HTML Fragment

▪ MHT

▪ PDF

▪ SingleXLS

▪ spreadsheetML, XHTML

▪ XLS

▪ XLWA

▪ XML

Save report to Cognos server Determines the default location on the Cognos server to save a report or specify a report view and select a different location.

Control-M rule: Case sensitive.

Save report as a report view Determines if you save report as a report view. Control-M rule:

Case sensitive.

Report view name Determines the Report view name when Save as Report view is

selected. Control-M rule: Case sensitive.

Report view location Determines the Report view location when Save as Report view is

selected. Control-M rule: Case sensitive.

File system parameters (on

page 102)

Describes the File System parameters.

Email Recipients parameters

(on page 103) Describes the Email Recipient parameters.

File system parameters

File System parameters determine how you will assign the name and location of files in the system file

system.

The following table describes the File System parameters for Control-M for IBM Cognos.


103





Location Determines the report archive system file location.

Control-M rule: Length: 1

Specify a file name Determines the file name that you specify. If the file

name is empty, the default report name will be used.


Keep existing files Determines that the existing file is not overwritten by a

file with the same name. Control-M rule: Length: 1

Replace existing files Determines that the existing file is overwritten by a file

with the same name. Control-M rule: Length: 1

Make the file names unique and

append a timestamp

Defines a unique output filename that must be created in

the destination directory with a time stamp appended to

the filename. Control-M rule: Length: 1

Make the file names unique and

append a sequence number

Defines a unique output filename that must be created in

the destination directory with a sequence number

appended to the filename. Control-M rule: Length: 1

Email Recipients parameters

Email Recipients parameters define the destination email address of the report and whether to attach the

link and/or the actual report to the email.

The following table describes the Email recipient parameters for an IBM Cognos job.


104





Email to Defines the destination email address of the report.


Email CC Defines an additional destination email address of the

report. Control-M rule: 1-4096 characters.

Email BCC Defines an additional destination email address of the report that are not viewable to other recipients.


Email subject Defines the subject of the email for the report. This field can contain variables, which must contain a space or a

period at the end. Control-M rule: 1-4096 characters.

Email message Describes the message of the email. This field can contain variables, which must contain a space or a period

at the end. Control-M rule: 1-4096 characters.

Include a link to the report Determines if a link to the report is included in the email.


Attach the report Determines if the report is attached to the report.


Control-M Report job parameters

The following table describes the General parameters for a Control-M Report job:


105





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



Value: Control-M Report


Control-M rules:

▪ 1-64 characters

▪ Case sensitive



"$", "/", "*", "?", " "




▪ Case sensitive



106


Control-M Report

Attributes (Details)

Defines the following parameters:

▪ 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



Control-M rules:

▪ 1-30 characters

▪ Case sensitive


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.

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.


107


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

▪ 1-30 characters

▪ Case sensitive


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

processes the job.


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.


108


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


Control-M rules:

Length:

▪ Name: 1-40

▪ Value: 1-4000

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.

Control-M rules:

▪ Case sensitive


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.

Control-M rules:

▪ 1-64 characters

▪ Case sensitive



Control-M rules:

▪ 1-64 characters

▪ Case sensitive


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.


109



following:


format starts with "http://", "ftp://", or "file://".


Control-M rules:

▪ URL Length: Combines the length of Doc Member/ Doc File 64

characters and Doc Library/ Doc Path 255 characters


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.

Control-M rules:




▪ Case sensitive

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.

Control-M rules:

▪ 1-64 characters

▪ Case Sensitive





Java job parameters

The following table describes the parameters for a Java job:


110





Connection Profile Defines the Control-M for Java connection profile.

Control-M rules:

▪ 1-50 characters (capital letters only)

▪ Valid characters: Integers between 0-9, _

(underscore), - (dash/hyphen), A-Z characters

▪ No special characters can be included with the

name definition

Object Defines Enterprise Java Bean or Java Class according to

which the Method parameter value is specified.

Control-M rules:


▪ Alphanumeric string. Cannot begin with a number.

Blank spaces are not allowed.

▪ Case sensitive

Method (Java) Defines the method to be invoked to the specified Java

Application class.

Control-M rules:




▪ Any method specified with the object.

▪ Case sensitive

Type Specifies the type of the parameter for the chosen

method.

Control-M rules:




▪ Automatically predefined upon selection of the Method value. Values are primitive type names,

such as int, boolean, and char.

▪ Case sensitive


111

Value Specifies the parameter value for the chosen method.

Control-M rules:


▪ Case sensitive

Name Specifies the name of the parameter for the chosen

method.

Control-M rules:


▪ Case sensitive

Exclude Job Output Excludes information about job output from the Output

at the end of a job execution

No Output Banner Specifies whether an output banner is written to the

Output at the end of a job execution

Mapper job parameters

The following table describes the Control-M/Agent for Mapper System for 2200 job parameters:


112





Job type Select one of the following values:

▪ Command

▪ MAPPER run

User ID Defines the MAPPER user ID under which the MAPPER run will

execute. The run already has a corresponding password entered

in the DATA.PASSWRDS file, as a result of running the CTMPWD

utility before running the MAPPER job.

Department Defines the MAPPER department to which the User Id belongs.

The DATA.PASSWRDS file stores the user ID and department as a pair, together with the associated password, in the following

format:

<userid>,<department> <password>

Command Defines the command that will be executed in MAPPER.

Run Name Defines the name of a pre-existing MAPPER run to be executed.

Run Data Defines the data that will be passed to the run.

If Run Link is also used, the total number of characters from both

Run Data and Run Link combined, including the commas

separating them, must be 70 characters or fewer.

Run Link Runs that are linked to the main run, and are called by the main

run during execution.

If Run Link is also used, the total number of characters from both

Run Data and Run Link combined, including the commas

separating them, must be 70 characters or fewer.

Messaging job parameters

The following table describes the parameters for a Messaging job:


113





Connection Profile Defines the Control-M for Messaging connection profile.

Control-M rules:


▪ Valid characters: Integers between 0 and 9, _ (underscore), -

(dash, hyphen), A-Z characters

NOTE: No special characters can be included with the name

definition.

Use predefined message Enables you to use a previously defined text or binary file as the

content of the message.

Control-M rules:


▪ Any alphanumeric character, underscore, hyphen

Use free text message Defines the content of the free text message.

Control-M rules: Any alphanumeric and special characters.

NOTE: The period character (.) is not permitted. Certain special

characters are internally represented by more than one character. For example, ampersand (&) is represented internally by three

characters.

Wait for Reply only Enables you to wait and consume a message from the reply

queue/topic, as defined in the connection profile.

Advanced Messaging settings

(on page 114)

Enables you to change message settings that have been

predefined.

Assign job output to the

following variable

Enables you to save reply message into a chosen variable.

Control-M rules:


▪ Any alphanumeric character, underscore, hyphen. Spaces and

special characters are not permitted.


114


Assign job output to the

following file

Enables you to save the reply message into a chosen file, located on the computer where Control-M for Messaging is installed upon

job completion.

Control-M rules:


▪ Any character string representing the file name including its

full path

Exclude Job Output Excludes information about job output from the output at the end

of a job execution.

No Output Banner Specifies whether an output banner is written to the output.

Advanced Messaging settings

The following table describes the Advanced Messaging settings, which override the values defined in the

existing connection profile.


115





Destination queue/Topic Defines the name of the message queue to which the outgoing

messages are sent.

Control-M rules:


▪ Use Default

▪ A string including any alphanumeric character, and underscore

and hyphen. Blank spaces are not permitted.

NOTE: You can define two message queues by using the comma

",". If the primary queue cannot be reached, the job attempts to

use the secondary queue automatically.

Priority Defines the level for prioritizing the messages that are to be

routed to the Destination queue/Topic.

Control-M rules:

▪ Use Default

▪ Any digit between 0 and 9

Expiration Time (sec) Defines the amount of time (in seconds) until the outgoing

message expires.

Control-M rules:

▪ Use Default

▪ Any digit representing unit of seconds (blank spaces are not

permitted)

Wait for Reply Enables waiting for messages in the reply message queue.

Control-M rules:

▪ Use Default



NOTE: You can define two message queues by using the comma

",". If the primary queue cannot be reached, the job attempts to



116


Reply Queue Defines the message queue where replies are sent.

Control-M rules:

▪ Use Default



NOTE: You can define two message queues by using the comma ",". If the primary queue cannot be reached, the job attempts to


Time to Wait (sec) Defines the amount of time (in seconds) to wait for incoming

messages in the reply message queue.

Control-M rules:

▪ Use Default

▪ Any numerical value representing unit of seconds

Message Properties For JMS Accounts only. Defines the outgoing message string

properties. Specify a new key and corresponding value.

Property Name Defines the property key name to be added to an outgoing

message.

Control-M rules:

▪ Any digit between 1 and 212 characters

▪ Any alphanumeric character, underscore, hyphen

▪ Case sensitive

Property Value Defines the property value corresponding to the Property Name

parameters.

Control-M rules:

▪ Any digit up to 212 characters

▪ Case sensitive

OEBS job parameters

The following table describes the parameters for an Oracle E-Business Suite job:


117





Connection Profile Defines the Control-M for Oracle E-Business Suite Connection

Profile. Control-M rule: 1-30 characters (capital letters only)

User Name Defines an authorized Oracle E-Business Suite user who has at

least one responsibility. Control-M rule: 1-100 characters

Responsibility Enables authorization for accessing data and running programs

or requests, or both.

Control-M rules:

▪ 1-100 characters (no blanks)

▪ Case sensitive

Application Defines the Application short name associated with the

Responsibility name.

Control-M rules:


▪ Uppercase only

Security Group Defines the Security group associated with the Responsibility

name.

Control-M rules:

▪ 1-80 characters

▪ Case sensitive

Use Menu function Enables you to restrict application functionality to authorized

users.

Submit Indicates whether the request is a Request Set or Single

Request.

Request Set Enables you to select concurrent programs in the request set.


118

Program Name Defines the concurrent program name which causes the Oracle

E-Business Suite server to generate a list in real time that

satisfies relevant criteria.

Control-M rules:


▪ Uppercase only

Program Display Name Defines the Program display long name.

Control-M rules:


▪ Uppercase only

Program Name (Program Name

dialog box)

Defines the Program short name.

Control-M rules:


▪ Uppercase only

Application Name Defines the application short name associated with the

concurrent program.

Control-M rules:


▪ Uppercase only

Application Display Name Defines the application long name associated with the

concurrent program.

Control-M rules:


▪ Uppercase only

Operating Unit Enables you to set the Operating Unit field.

Control-M rules:


▪ Case sensitive

Parameters Enables you to specify parameter values for the specified

concurrent program.

Parameter Validation Enables you to validate parameter values.


119

Language Defines the job output language.

Description Defines the text description of a request.

Control-M rules:


▪ Case sensitive

Upon Completion parameters (on

page 119)

Enables various tasks to be performed upon completion of a

job.

Post Process Actions Enables you to set post completion actions.

Profile Name Defines the Profile internal name.

Control-M rules:


▪ Case sensitive

Profile Value Defines the Profile value.

Control-M rules:


▪ Case sensitive

Increment date parameters each

run

Enables the date of the job's parameters to increase on each

run.

First run date Defines the first run date for the Increment Date Parameter.

Upon Completion parameters

Upon Completion parameters enable various tasks to be performed upon completion of a job. The

following table describes the Upon Completion parameters.


120

NOTE: To add Upon Completion parameters, click Options.


Layout Enables you to set the template options for your job.

Notify/Notify the following

people

Enables you to add a text string for the workflow role names. You

can add predefined names by clicking .

Print the output to Enables you to select print output options.

Post Process Actions

The following table describes the Post Process Actions for OEBS.


Output Handling

Append Request Log to Job

Output

Enables Control-M for Oracle E-Business Suite request log is

copied to the Control-M job output. Default: Selected.

Append Request Output to Job

Output

Enables Control-M for Oracle E Business Suite request output is

copied to Control-M job output. Default: Not Selected.

Completion Status

Allow job to complete successfully even if OEBS

warning occurred

Enables a job to complete even if Control-M for Oracle E-Business

Suite request ended with a Warning status. Default Not selected.

Monitor all child request (Wait

Child)

Tracks the status of child jobs. If not selected, only the status of

the parent job is tracked. Default: Selected.

Job completion status will

depend on child requests status

Enables Control-M jobs ending status to be set according to the

worst completion status of all the child requests. If not selected,

the job status is determined by the parent job's ending status.

Default: Not selected.

Oracle Business Intelligence job parameters

The following table describes the parameters for an Oracle Business Intelligence job:


121





Connection Profile Defines the name of the Control-M for Oracle Business Intelligence

connection profile. Control-M rule: 1-30 characters (capital

letters only)

Type Defines the type of Oracle Business Intelligence to run.

Control-M rules:

▪ Report

▪ Agent/iBot

▪ Case sensitive

Report Path Defines the path and name of the report or Agent/iBot that you

want to run. Control-M rule: Case sensitive

Report Job Name Defines the report job name (for reports only). Control-M rule:

Case sensitive

Output parameters (on page

121)

Defines the output parameters for reports.

Notification parameters (on page

123) Defines the Notification parameters for reports.

Parameters Defines the name, value, format, type and description of the

parameters. Control-M rule: Case sensitive

Output parameters

The following table describes the Oracle Business Intelligence output parameters.


122





Layout Determines the layout that is applied to the report. Control-M

rule: Case sensitive.

Format Determines which format is applied to the report. Control-M

rule: Case sensitive.

Calendar Determines which calendar is applied to the report.

Burst Report Determines if the report runs a burst report.

Save Data for Republish Saves the XML data that is generated for the job.

Make Output Public Determines whether to allow all users with permissions to access

the report.

Save Output (10g) Saves the report output.

Use Unicode (10g) Determines whether to use Unicode to the report (10g) only

Email Output Destination

To Defines the destination email address of the report (comma

separated values). Control-M rule: Case sensitive

Cc Defines an additional email address destination of the report

(comma separated values). Control-M rule: Case sensitive

Bcc (10g) Defines an additional email address destination of the report

(comma separated values, 10g only). Control-M rule: Case

sensitive

Reply To Defines the email address that the recipient can reply to.


Subject Defines the subject of the email of the report. Control-M rule:

Case sensitive

Message Defines the email message for the report. Control-M rule: Case

sensitive.

FTP Output Destination


123


FTP Server Defines the FTP server name, as defined in the Account FTP

destinations. Control-M rule: Case sensitive

Remote Directory Defines the remote directory on the FTP server and must end with

a "\" or a "/". Control-M rule: Case sensitive

Remote File Defines the destination file name for the FTP destination.


Notification parameters

The following table describes the Oracle Business Intelligence Notification parameters.





Email Address Defines an email address for notifications when the type is Report

(separated by commas). Control-M rule: Case sensitive

Report completed Sends an email notification on a completed status. Control-M

rule: Case sensitive

Report completed with warnings Sends an email notification on a warning status. Control-M rule:

Case sensitive

Report failed Sends an email notification on a failed status

OS2200 job parameters

The following table describes OS2200 parameters:


124










Control-M rules:

▪ 1-64 characters

▪ Case sensitive





▪ Case sensitive

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


Control-M rules:

▪ 64000 B

▪ Case sensitive


125




Control-M rules:

▪ 1-30 characters

▪ Case sensitive


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.

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.


126


Do not use @SYM and @BRKPT in job

wrapper

Indicates that an additional @SYM and @BRKPT will not be added to the

job’s wrapper.

▪ Checked: There is no additional @SYM or @BKRPT redirection

statements besides the ones contained by the job’s JCL. The Output will be written only if MULTIPLE_SYM is set to Y or Y-ALL (Equivalent to

Printout data to include in Output 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 job

runstream

Uses the runcard as specified in the job runstream in the job wrapper.

Default: unchecked

Use Run id from

autoedit variable or

job's runstream

Uses the run Id on the job runcard on submission, based on the 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 different

owner

Runs the job under the specified user Id via the @START,/U option.

Analyze and translate variables in

job runstream

Parses user runstream content and resolve any specified variables. Default:

unchecked.

Equivalent: RUNSARG

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

▪ Default: The default value as set by the MULTIPLE_SYM configuration

parameter

▪ Yes and delete all output

▪ No and retain job output

▪ Yes, and retain all output

▪ No, and retain all output

Do not set job

owner to job wrapper on

submission

Does not set the job wrapper’s owner to the specified user. Default:

unchecked

Equivalent: SKIPCHGOWN


127


Perform account

validation

before submission

An option to validate the specified account before allowing submission.

Default: unchecked

Bypass checking of

the

status file indicator

Bases the job completion and exit code solely on the job’s completion

statistics.

Do not run user job via @ADD in job

wrapper

Executes user job content as is. Default: unchecked

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.

PeopleSoft job parameters

The following table describes the parameters for a PeopleSoft job:


128





Connection profile Defines a set of connection attributes between Control-M for

PeopleSoft and a PeopleSoft application server.

Control-M rules:

▪ 1-50 characters

▪ Case sensitive

▪ Valid characters: Blanks . -_0-9 a-z A-Z

Email subject Refers to an email message subject line that is sent by the job.


Email text Refers to message text displayed in the body of an email

message. Control-M rule: Must not exceed 250 characters.

Email web report Specifies whether to attach the web report to the email sent at

the completion of this job. This parameter is set only when the

Type parameter for the request is Web.

Email with log Specifies whether to attach the log file to the email sent at the

completion of this job

Format Defines the output format for all job processes

Process name (I) Defines the name of the scheduled process.

Control-M rules:

▪ 1-12 characters

▪ Uppercase only

▪ Invalid characters - blanks

Process name (II) Defines the name of the scheduled job.

Control-M rules:

▪ 1-12 characters

▪ Uppercase only


Process type Defines the type of process for the process or job definition.

Control-M rules:

▪ 1-30 characters


129


▪ Case sensitive

Rerun from step Refers to when a job reruns from a specific process number,

which has previously failed

Run control ID Defines run control attributes, which are associated with a

process or job.

Control-M rules:

▪ 1-30 characters

▪ Case sensitive

Server name Defines the name of the PeopleSoft server used for running the

process or job.

Control-M rules:

▪ 1-8 characters

▪ Case sensitive

▪ Invalid characters: blanks

Type Defines the output destination type of a process or a job

User ID Defines the PeopleSoft user ID name used for the process or job.

Control-M rules:

▪ 1-30 characters

▪ Case sensitive

▪ Invalid characters: blanks

Userdef1-20 Refers to user defined parameters that are available for the

PeopleSoft process or jobs. Control-M rule: 1-214 characters.

Append to output If selected, the PeopleSoft process output will be included in the

Control-M job output.

SAP Data Archiving job parameters

The following table describes the parameters for a SAP Data Archiving job:


130






Control-M rules:



▪ Case sensitive

Action Determines the task that the job performs.

SAP Job Name Defines the name of the job to be monitored or submitted.


Archiving Object The name of the archiving object in SAP Data Archiving jobs.

Control-M rules:

▪ 1-10 characters

▪ Uppercase only


Variant Name Indicates the variant for the specified ABAP program or Archiving

Object.

Control-M rules:

▪ 1-14 characters

▪ Uppercase only

Variant Values Specifies a variant value for the specified ABAP program of

Archiving Object.

Check Sessions Defines whether to check for an incomplete archiving session for a

specific archiving object. An incomplete archiving session is one

for which not all Delete jobs ended successfully.

Check Variants Defines whether to check for a Write job that exists with the

specific variant for the archiving object defined for this job.


131


Target Server Defines the application server on which the external command

runs.

Control-M rules:

▪ 1-20 characters

The (full) format must be used:

hostname_SYSID_sysnumber

▪ Case sensitive


Session Number Indicates the archiving session number in SAP. Control-M rule: 6

digit number.

Job Class Defines the job submission priority (in SAP). Control-M rule:

1-32 characters.

Print parameters (on page 132) Defines printer parameters for an SAP Data Archiving job.

Start Condition Specifies whether the job should run with the ASAP option,

immediately, or after event.



Job Name Defines the template for new created detected SAP type jobs. The

selected job must exist in the same folder as the current job.


Detect and Create By Determines the properties of the detected job

Copy Spool to Defines the name and path of the file to which the spool should be

copied.

Control-M rules:


▪ Case sensitive


Job Status Defines the job completion status.

Job Type Indicate the nature of the SAP job in Active job mode (Read-only

fields)

Step Type Defines the type of step to be performed. Uppercase only.


132

Print parameters

The following table describes the Print parameters for an SAP Data Archiving job.


133





SAP Job Name Defines the name of the job to be monitored or submitted. Control-M

rule: 1-32 characters.

User Defines the authorized step owner.

Control-M rules:

▪ 1-12 characters

▪ Uppercase only


Variant Name Indicates the variant for the specified ABAP program or Archiving Object.

Control-M rules:

▪ 1-14 characters

▪ Uppercase only

Language Defines the language of the ABAP step.

Control-M rules:

▪ 1 alphanumeric character, for example, D for German, d for

Serbo-Croatian

▪ Case sensitive

▪ Invalid characters: Blanks, special characters

Output Device Defines the logical name of the designated printer.

Control-M rules:

▪ 1-4 characters

▪ Uppercase only


Number of

Copies

Defines the number of copies to be printed. Control-M rule: 3-digit

integer between 001-255

Print Archive

Mode

Determines whether the spool of the step is printed to an output device,

to the archive, or both.

Time of Print Indicates when to print the job output.

Print Expiration Defines the number of days until a print job expires.


134


Control-M rules:

▪ 1-8: Specific number of days

▪ 9: A special value that signifies Do Not Delete.

New Spool

Request

Indicates whether to request a new spool.

Delete After

Print Indicates whether the report is deleted after printing.

Archive ID SAP ArchiveLink Storage system ID.

Control-M rules:

▪ 2 characters

▪ Case sensitive

▪ Invalid characters: Only trailing blank spaces are permitted

Archive Text A free text description of the archive location.

Control-M rules:

▪ 1-40 characters

▪ Case sensitive


Object Type Defines the archive object type.

Control-M rules:

▪ 1-10 characters

▪ Case sensitive

Document Type Defines an archive object document type. Control-M rules:

▪ 1-10 characters

▪ Case sensitive

Information

Field

Defines archive information.

Control-M rules:

▪ 1-3 characters

▪ Case sensitive

Name Defines the spool list name.

Control-M rules:


135


▪ 1-12 characters

▪ Uppercase only

Titles Defines the spool list titles.

Control-M rules:

▪ 1-68 characters

▪ Case sensitive

Authorization User with print authorization.

Control-M rules

▪ 1-12 characters

▪ Case sensitive

Rows Defines the maximum number of rows per page.

Control-M rules:

▪ Integer between 1-90

▪ -1 (ABAP Program Default check box is selected)

▪ Special value indicating that the number of rows is obtained from the

ABAP program code.

Columns Defines the maximum number of characters in an output line.

Control-M rules:


▪ -1 (ABAP Program Default check box is selected) Special value indicating that the number of rows is obtained from the ABAP

program code.

Use ABAP

Program Default

Indicates whether the ABAP program default is used, rather than a

number entered in the Rows or Columns Box.

Layout Defines the print Layout format.

Control-M rules:

▪ 1-16 characters

▪ Uppercase only


Recipient Defines the name of the recipient of the job output.

Control-M rules:


136


▪ 1-12 characters

▪ Case sensitive

Department Defines the spool department.

Control-M rules:

▪ 1-12 characters

▪ Case sensitive

SAP Cover Page Determines the type of cover page for output.

OS Cover Sheet Defines the type of cover page for output.

Selection Cover

Page

Indicates whether a cover page should be used.

SAP R3 job parameters

The following table describes the parameters for an SAP R3 job:


137






Control-M rules:

▪ 1-30 characters

▪ Case sensitive


Action Determines the task that the job performs

SAP Job Name Defines the name of the job to be monitored or submitted.


Exec. Target Defines the application server on which the job runs.

Control-M rules:

▪ 1-20 characters

▪ Case sensitive


Job Class Defines the job submission priority (in SAP).

Start Condition Specifies whether the job should run with the ASAP option,

immediately, or after event.

Job Count Defines a unique SAP job ID number.

New Job Name Defines the name of the newly created job (in copy mode).

Steps Defines a read-only field that displays the job steps (actions) to be

performed as part of a SAP job. Options:

▪ ABAP (on page 139)

▪ External Program (on page 144)

▪ External Command (on page 145)

View SAP Job Documentation Retrieves SAP job Documentation from the Solution Manager.

Rerun from point of failure Enables you to rerun an SAP R/3 job from its point of failure.

Rerun from step/copy from step Enables the rerun a SAP R/3 job from the specified step.


138


QID Defines the Batch Input Session Queue ID number. Control-M

rule: 20 digit number.

Session Name Defines the Batch Input Session Name. Control-M rule: 1-12

characters

Pattern Name Specifies a filter for one or more sessions that you can execute, for Batch Input mode when Use Batch Input Pattern is selected.

Control-M rules: The following wildcards are used:

▪ "?": Any single character

▪ "*": Any character

Post job Actions (on page 139) Defines the Control-M for SAP R/3 post job actions.



Detect and Create by Determines the properties of the detected job.

Job name Detected spawned jobs of the current job are extracted to

Control-M with identical properties to the specified job.

Start Spawned job If you select Start Spawned job, Control-M for SAP checks the status of each spawned job and starts any spawned job with

Scheduled status.

Job ends in Control-M only after

all child jobs complete on SAP

Enables a job to end only after all child jobs complete. If you deselect the checkbox, a parent job ends in Control-M after all

child jobs are detected and monitored by Control-M regardless of

their status.

Job completion status depends

on child job status

Enables Control-M to wait for all child jobs to complete. The

parent job does not end OK if any child job fails.

Recipient Type Defines the type of the recipient of the print job.

Recipient Name Defines the recipient of the print job. Any string value, up to 214

characters.

Spool List Recipient Indicates whether to create a new SAP spool.


139

Post job Actions

The following table describes the post job actions for a Control-M for SAP R/3 job.


Output Management Defines output management for spool and job log

Job completion status will

depend on application status

Enables the job completion status to depend on the SAP

application status.

Save spool in PDF format Enables you to save Control-M for SAP R3 job's spool in PDF

format.

ABAP job parameters

The following table describes the ABAP job parameters.


140





ABAP Program The name of the ABAP program, where ABAP is a language used

within the SAP system.

Control-M rules:

▪ 1-40 characters

▪ Uppercase only

▪ Invalid characters: Special characters not permitted


Control-M rules:

▪ 1-12 characters

▪ Uppercase only


Language Defines the language of the ABAP step.

Control-M rules:

▪ 1 alphanumeric character. For example, D for German, d for

Serbo-Croatian

▪ Case sensitive

▪ Invalid characters: Blanks, special characters

Variant Name Indicates the variant for the specified ABAP program or Archiving

Object.

Control-M rules:

▪ 1-14 characters

▪ Uppercase only

Temporary Variant Specifies temporary variant values for the specified ABAP

program.

Variant Values Specifies a variant value for the specified ABAP program of

Archiving Object.


141


Output Device Defines the logical name of the designated printer.

Control-M rules:

▪ 1-4 characters

▪ Uppercase only


Number of Copies Defines the number of copies to be printed. Control-M rule: A

3-digit integer between 001-255

Print Archive Mode Determines whether the spool of the step is printed to an output

device, to the archive, or both.

Time of Print Indicates when to print the job output.

Print Expiration Defines the number of days until a print job expires.

Control-M rules:

▪ 1-8: Specific number of days

▪ 9: A special value that signifies Do Not Delete

New Spool Request Indicates whether to request a new spool.

Delete After Print Indicates whether the report is deleted after printing.

Recipient Defines the recipient name of the job output.

Control-M rules:

▪ 1-12 characters

▪ Case sensitive

Department Defines the Spool department.

Control-M rules:

▪ 1-12 characters

▪ Case sensitive

SAP Cover Page Defines the type of cover page for output.

OS Cover Sheet Defines the type of cover page for output.


142


Selection Cover Page Indicates whether a cover page should be used.

Name Defines the spool list name.

Control-M rules:

▪ 1-12 characters

▪ Uppercase only

Titles Defines the spool list titles.

Control-M rules:

▪ 1-68 characters

▪ Case sensitive

Authorization User with print authorization.

Control-M rules:

▪ 1-12 characters

▪ Case sensitive

Rows Defines the maximum number of rows per page.

Control-M rules:


▪ -1 (default)

▪ Special value indicating that the number of rows is obtained

from the ABAP program code.

Use ABAP Program Default Indicates whether the ABAP program default is used, rather than a

number entered in the Rows or Columns box.

Layout Defines the print layout format.

Control-M rules:

▪ 1-16 characters

▪ Uppercase only



143


Columns Defines the maximum number of characters in an output line.

Control-M rules:


▪ -1 (default)

Archive ID SAP ArchiveLink Storage system ID.

Control-M rules:

▪ 2 characters

▪ Case sensitive

▪ Invalid characters: Only trailing blank spaces are permitted

Archive Text A free text description of the archive location.

Control-M rules:

▪ 1-40 characters

▪ Case sensitive


Object Type Defines the archive object type.

Control-M rules:

▪ 1-10 characters

▪ Case sensitive

Document Type Defines an archive object document type.

Control-M rules:

▪ 1-10 characters

▪ Case sensitive

Information Field Defines archive information.

Control-M rules:

▪ 1-3 characters

▪ Case sensitive


144

External Program parameters

The following table describes the External Program job parameters for SAP R/3.





Name Defines the name of the external program.

Control-M rules:


▪ Case sensitive


Control-M rules:

▪ 1-12 characters

▪ Uppercase only


Parameters Defines the parameters for an external program or an external

command.

Control-M rules:


▪ Case sensitive

Target Host Defines the host computer on which the external program runs.

Control-M rules:

▪ 1-32 characters

▪ Case sensitive


Job Waiting for External

Termination

Indicates whether SAP waits for the external program to end

before starting the next step or before exiting.

Log External Output to Joblog Indicates whether SAP logs external output in the job log.

Log External Errors in Joblog Indicates whether SAP logs external errors in the job log.

Activate Trace Indicates whether SAP activates traces.


145

External Command job parameters

The following table describes the External Command job parameters for SAP R/3.


146





Name Defines the name of the external program.

Control-M rules:


▪ Case sensitive


Control-M rules:

▪ 1-12 characters

▪ Uppercase only


Parameters Defines the parameters for an external program or an external

command.

Control-M rules:


▪ Case sensitive

Target Server Defines the application server on which the job runs.

Control-M rules:

▪ 1-20 characters

▪ Case sensitive


Operating System Indicates the operating system.

Control-M rules:

▪ 1-10 characters

▪ Case sensitive

Job Waiting for External

Termination

Indicates whether SAP waits for the external program to end

before starting the next step or before exiting.

Log External Output to Joblog Indicates whether SAP logs external output in the job log.

Log External Errors in Joblog Indicates whether SAP logs external errors in the job log.


147


Activate Trace Indicates whether SAP activates traces.

Tandem job parameters

The following table describes the general parameters for a Tandem job:


148









Value: Tandem


Control-M rules:

▪ 1-64 characters

▪ Case sensitive


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 job flow.

Control-M rules:


▪ Case sensitive




Control-M rules:

▪ 1-30 characters

▪ Case sensitive



Blanks

Name Defines the name of the process. It must begin with $ followed by an alphabetic character. Each remaining character must be alphanumeric.

Control-M rule: Maximum 6 characters (including the $ sign).


149


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.

▪ Embedded TACL Script: Defines a script exactly as it is specified in a

terminal for the specific computer, which is part of the job definition.

▪ External Process: Attaches an external process (not submitted by

Control-M) to a Control-M Active job.

TACL Script Defines the name of the TACL file.

Program Defines the name of the program to execute.

Volume Subvolume Defines the Volume and sub volume where the TACL script or Program

resides.

Overriding 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 Enables you to assign job environmental attributes, such as name and other

attributes (for example access mode and exclusion mode).

Define Enables you to set environmental variables for your applications.

Params Enables you to set the name and value of your program to use these

parameters 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

for this job

Determines whether validity checks are performed against any of the Tandem

related job attributes.


150


Bypass job (skip

execution)

Determines whether the job submits to the Tandem operating system.

Instead, the job completes OK and for the job a dummy OUTPUT is created.

This process should

be created in a no

wait manner

Determines whether the job creates in a nowait manner. This means the

parent process does not wait for acknowledgment that the process was

created.

Produce CTMRJOB

diagnostics

Determines whether the CTMRJOB diagnostics are turned on for this specific

job, overriding the value specified by the GUARDIAN configuration parameter

CTMRJOB_DIAG.

Creation option Defines information about the environment of the new process. Control-M

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

When a non-empty value is specified, the "Detect spawned jobs" window is

enabled. For more information, see Detect spawned jobs (on page 153).

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

data

Enables you to allocate swap space for the default extended segment of the process. 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. Control-M

rules: 0-15. See PROCESS_CREATE_API in the HP NonStop Guardian

Procedure Calls.


151

Tandem job assign parameters

The following table describes the Tandem job Assign parameters:


Assigns Logical

Name

(Mandatory) Defines the logical name as it is known to

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.


152

Tandem define format parameters

The following table describes the define format for Tandem job parameters.


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 parameter

The following table describes the Tandem job Params parameters:


Name (Mandatory) Defines the name of the parameter.

Value Defines the value of the parameter.


153

Tandem External process job

The following table describes the parameters for a Tandem External process job:


External Process ID Defines the ID of the external process running on the operating

system.

External Process CPU, PIN Defines the CPU and PIN of the external process running on the

operating system.

Detect spawned jobs

The following table describes the Tandem parameters for Detect Spawned jobs:


Detect spawned jobs Determines whether to detect child jobs spawned by this job. When a child job is detected, you can choose whether to create a

new Control-M Tandem external job or order an existing Tandem

external job from a pre-defined folder. Values:

▪ Do not detect spawned job

▪ Detect and create new job

▪ Detect and order existing job

Bypass when job not found (Detect spawned jobs mode CREATE only) When attempting to

attach the detected child job as an external job and the job was

not found, the job is bypassed. The job ends OK with the

message, Job was Bypass, in the job’s output.

From folder Detect spawned jobs mode ORDER only) Specifies the folder name

where the job that is to be ordered is defined.

Job name to order (Detect spawned jobs mode ORDER only) Specifies the job name

to order upon spawned job detection.

Web Services parameters

The following table describes the parameters for a Web Services job.


154





Connection Profile Defines the Control-M for Web Services connection

profile.

Control-M rules:

▪ 1-50 characters (only capital letters)

▪ Integers between 0 and 9

▪ _ (underscore)

▪ - (dash, hyphen)

▪ A-Z characters

NOTE: No special characters can be included with the

name definition.

URL/WSDL Defines a URL or fully qualified filename pointing to the

WSDL of the web service.

Control-M rules:


▪ Alphanumeric string. Cannot begin with a number

and blank spaces are not permitted.

Service Defines a service provided by the company or business.

Control-M rules:


▪ Case sensitive


155

Method (REST) Defines the HTTP method used when executing the

REST job.

Control-M rules:


▪ Case sensitive

▪ GET

▪ POST

▪ PUT

▪ DELETE

▪ HEAD

▪ OPTIONS

Path Defines a path available for the method specified in the

Method field.

Control-M rules:


▪ Case sensitive

Operation Defines an operation available for the service specified

in the service field.

Control-M rules:


▪ Case sensitive

Use parameters from input file Enables you to invoke the target web service with

predefined SOAP message from the specified input file.

Control-M rules:


▪ Any character string representing the file name

including the file path.

Edit SOAP Request/Edit Body

Request

Enables you to generate your own SOAP request for

REST web services.


156

Add SOAP Header from file Adds a predefined SOAP Header to the invocation of the

target web service SOAP message, taken from a file

specified in the Header File field. Control-M rules:


▪ Any character string representing the file name

including the file path.

Input parameters Specifies values for each selected parameter.

Control-M rules:


▪ Case sensitive

HTTP Code Enables you to enter the different job output data based

on the HTTP return status code.

Array Size Specifies a number of items in an input parameter array

applicable to the Input parameters of the web services

invocation when necessary.

Control-M rules:

▪ Up to 2 digits

▪ Any integer up to 99

Output parameters Specifies the outcome of selected output parameters.

Control-M rules:


▪ Case sensitive

Exclude Job Output Excludes information about job output from the Output

at the end of a job execution.

No Output Banner Specifies whether an Output banner is written to the

Output at the end of a job execution

Override URL Endpoint Specifies the URL endpoint at the job definition level.

Upon job submission Control-M for Web Services uses job definition's Endpoint URL rather than the URL. Case

sensitive.

Preemptive authentication Enables you to enter the HTTP Basic Authentication information in the format of <user>@<realm> that

matches the information in HTTP Basic Authentication

field in the Control-M for Web Services Connection

Profile Management (CCM).


157

Override CONTENT-TYPE Defines a preferred HTTP header Content-Type to be

used to execute the job. Case sensitive

Override connection timeout (sec) Limits the connection time when waiting for the web

service to respond before disconnecting.

Hadoop job parameters

The following table describes the job parameters for a Hadoop job.


158





Connection Profile Defines the name of the Control-M for Hadoop connection profile.


Execution Type Defines the execution type for Hadoop job execution

Java-Map-Reduce Defines the parameters to execute MapReduce jobs. Parameters:

▪ Full path to jar: Defines the full path to the jar containing the

Map Reduce Java program on the Hadoop host

▪ Main Class (optional): Defines the class that is included in the

jar containing a main function and the map reduce

implementation

▪ Arguments: Defines the argument which is used by the

command

▪ Append Yarn aggregated logs to output: Determines whether

to add yarn aggregated logs to the jobs output

Streaming (on page 161) Defines the parameters that enables you to create and run Map/Reduce jobs with any executable or script as the mapper and

or the reducer

Spark (on page 163) Defines the parameters to execute Spark jobs

DistCp Defines the parameters to execute DistCP jobs. Parameters:

▪ Target Path: Defines the absolute destination path

▪ Source path: Defines the source path (minimum of one source

is required)

▪ Command Line options: Defines the sets of parameters and

values that are added to the command line. Name and Value:

Defines a name and the value associated with each property



Oozie Defines the parameters to execute Oozie jobs. Parameters:

▪ Job Properties File: Defines the job properties file path

▪ Job Properties: Defines the Oozie job properties. Key and

Value: Defines a key name and value associated with each

property.


159


Oozie Extractor The Oozie extractor is a service that fetches Oozie workflows from the Oozie server at each interval time based on defined rules and

pushes the actions of each workflow as submitted jobs.

Pig Defines the list of parameters for the Pig program. Parameters:

▪ Full Path to Pig Program: Defines the full path to the Pig

program on the Hadoop host

▪ Name: Defines a name for each property

▪ Value: Defines the value associated with each property



Hive Defines the script used to execute Hive jobs. Parameters:

▪ Full path to Hive script: Defines the full path to the Hive script

on the Hadoop host

▪ Script Parameters: Defines the list of parameters for the script


to add yarn aggregated logs to the jobs output. Name and Value: Defines the name and value associated with the

property

Sqoop Defines the parameters required to execute Sqoop jobs.

Parameters:

▪ Sqoop command: Defines any valid Squoop command

necessary for job execution. Sqoop can only be used for job

execution if defined in Sqoop connection parameters




160


HDFS File Watcher Defines the parameters required to execute HDFS File Watcher

jobs. Parameters:

▪ File name full path: Specifies the full path of the file being

watched

▪ Max time to wait: Determines the maximum number of

minutes to wait for the file to meet the watching criteria. If criteria are not met (file did not arrive, or minimum size was

not reached) the job fails after this maximum number of

minutes

▪ Min detected size: Determines the minimum file size in bytes

to meet the criteria and finish the job as OK. If the file arrives,

but the size is not met, the job continues to watch the file

▪ File Name Variable: Defines the global variable name that is used in succeeding jobs. For more information, see Control-M

Parameters guide.

Tajo Defines all the parameters required to execute Tajo jobs.

Parameters:

▪ Input File: Defines the input file used as the Tajo command

source

▪ Parameters: Determines the script parameters. Name and

Value: Defines a name and the value associated with each

property,

▪ Open Query: Determines the source type to run the

query/queries.

Distributed Shell (on page 163) Defines all the parameters required to execute Distributed Shell

jobs

HDFS Commands Determines the HDFS commands to run. Parameters:

▪ Command: Indicates the command for the argument to be

performed with job execution

▪ Arguments: Defines the argument which is used by the

command


161


Impala Defines all the parameters required to execute Impala jobs.

Parameters:

▪ Source: Determines the source type to run the query/queries.

The two options to select from are Query File or Open Query

▪ Query File Full Path: Defines the location of the file used to

run the query/queries

▪ Query: Defines the query command used to run the

query/queries

▪ Command Line Options: Defines the sets of parameters and

values that are added to the command line

Set Properties Parameters Defines a list of properties to be executed with the job. These

properties override the Hadoop defaults. Parameters:

▪ Name: Defines a name for each property

▪ Value: Defines the value associated with each property

▪ Archives: Indicates the location of the Hadoop archives

▪ Files: Indicates the location of the Hadoop files.

Pre/Post Commands (on page

165)

Defines commands that run before or after the job is executed

Streaming

Defines the parameters that enables you to create and run Map/Reduce jobs with any executable or script

as the mapper and or the reducer


162

The following table describes the Streaming parameters.


Input path Defines the input file for the Map step

Output path Defines the HDFS output path for the reduce step

Mapper Command Defines the command that runs as a mapper

Reducer Command Defines the command that runs as a reducer

Streaming options (on page 162) Defines the sets of parameters and values that are added to the

end of the Streaming command line

Generic Options (on page 162) Defines the sets of parameters and values that are added to the

Streaming command line

Streaming options

Defines the sets of parameters and values that are added to the end of the Streaming command line.

The following table describes the parameters.


Name Defines a name for each property

Value Defines the value associated with each property

Generic Options

Defines the sets of parameters and values that are added to the Streaming command line



Name Defines a name for each property

Value Defines the value associated with each property


163

Spark

Defines the parameters to execute Spark jobs

The following table describes the Spark parameters.


Program Type Defines the Spark program type

Application Jar Defines the path to the jar including your application and all the

dependencies

Main Class to Run Defines application's main class

Full Path to Script Defines the full path to the python script to execute

Application Arguments Defines the parameters that are added at the end of the Spark

command line either after the main class for Java / Scala

Applications or after the script of the Python Script

Command Line Options Defines the sets of parameters and values that are added to the

command line

Distributed Shell

Defines all the parameters required to execute Distributed Shell jobs.


164

The following table describes the Distributed Shell parameters.


Shell Type Determines whether the execution type is from a command or

from a script file.

Command Defines the shell command entry to run for the job execution.

Script Full Path Defines the full path to the script file which is executed. The script

file is located in the HDFS.

Shell Script Arguments Defines the shell script arguments.

Files/Archives (on page 164) Defines the full path to the file/archive to upload as a dependency

to the HDFS working directory.

Options (on page 164) Defines the additional option to set when executing the job.

Environment Variables Defines the environment variables for the shell script/command.

Append Yarn aggregated logs to

output

Determines whether to add yarn aggregated logs to the jobs

output.

Files/Archives

Defines the full path to the file/archive to upload as a dependency to the HDFS working directory.



Type Defines the file type.

Path Defines the path of the file/archive.

Options

Defines the additional option to set when executing the job.


165



Name Defines the parameter name of the additional option when

executing a job.

Value Defines the parameter value.

Pre/Post Commands

Defines commands that run before or after the job is executed These properties override the Hadoop

defaults. Pre-commands are performed prior to job execution and post-commands are performed

following job execution.


Fail the job if command fails -

Pre-Command

Determines whether the entire job should fail if any of the

commands fail.

Command - Pre-Command Indicates the command for the argument to be performed with

the job execution.

Arguments - Pre-Command Defines the argument which is used by the command

Fail the job if command fails -

Post-Command

Determines whether the entire job should fail if any of the

commands fail.

Command - Post-Command Indicates the command for the argument to be performed with

the job execution.

Arguments - Post-Command Defines the argument which is used by the command

Tivoli Storage Manager job parameters

The following table describes the job parameters for a Tivoli Storage Manager (TSM) job.


166





Connection Profile Defines the name of the Control-M for Backup connection profile. Control-M

rule: 1-30 characters (capital letters only)

Backup Type Determines which TSM backup method is used.

File System - Selective, Incremental

and Archive

parameters (on page

166)

Defines the Selective, Incremental, and Archive parameters for File System.

Group parameters (on

page 167)

Defines the Group parameters for TSM.

SQL Server

parameters (on page

168)

Defines the SQL Server parameters for TSM.

Exchange parameters

(on page 170) Defines the Exchange parameters for TSM.

Lotus Domino parameters (on page

170)

Defines the Lotus Domino parameters for TSM.

Image parameters (on

page 171)

Defines the Image parameters for TSM.

Virtual Machine

parameters (on page

172)

Defines the Virtual Machines parameters for TSM.

File System - Selective, Incremental and Archive parameters

The following table describes Selective, Incremental, and Archive parameters for File System that are

used in Defining a Control-M for Backup job for TSM.


167

NOTE: (Windows only) You must use a UNC or local path for all fields that require a file path (mapped

drives cannot be used).


Backup Files ▪ Determines whether to back up one of the following:

▪ Entire File System (Incremental File System only)

▪ Specific Files/Folders/Drives

▪ Files list File: Defines a file that processes the list of files

within according to the specific command

Backup also sub-directories Determines whether you want to include subdirectories of named

directories for processing

Delete archived files after

storage Determines whether to delete local files after archive

Management Class Defines the Management Class that contains attributes controlling

whether a file is eligible for backup or archive services

Description Assigns a description for files when you perform an archive, delete

archive, retrieve, query archive, or query backupset command.

Domain Defines the drives that you want to include for incremental backup

in your client domain

Option Files Defines the client options file you want to use when you start a

Tivoli Storage Manager session

Output Management ▪ Determines one of the following log types to display:

▪ Display none

▪ Display only errors and warnings

▪ Display full log

Group parameters

The following table describes Group parameters that are used in Defining a Control-M for Backup job for

TSM.


168

(Windows only) You must use a UNC or local path for all fields that require a file path (mapped drives

cannot be used).


Group Name Defines the file group for a Group backup

Files list File (Group) Defines a file that processes the list of files within according to the

specific command

Virtual File Space Defines the name of the virtual file space for the group where you

want to perform the operation

Mode (Group) Determines whether to perform a Differential or Full backup

Output Management Determines one of the following log types to display:

▪ Display none



SQL Server parameters

The following table describes SQL Server parameters that are used in Defining a Control-M for Backup job

for TSM.


169


cannot be used).


DB Name (SQL) Defines the names of the SQL server databases to back up,

restore, inactivate, or query

Mode (SQL) Determines one of the following backup types:

▪ File: Backs up a specific file

▪ Full: Backs up the full database

▪ Diff Full: Backs up the changes since the latest full backup

▪ Log: Backs up the transaction log for an active database since

the latest successful log backup

▪ Group: Backs up the contents of the file group you specify

▪ Set: Backs up the contents of the file groups and files you

specify with the /files and /groups parameters

File Name Defines the name of the file for a File backup

Group Name (SQL) Defines the file group for a Group backup

Groups Defines the groups for a Set backup

Files Defines the files for a Set backup

Config File Defines the name of the Data Protection for SQL or Mail

configuration file

Log File Defines the name of the backup log file

Option Files Overrides the default TSM option file (dsm.opt)

Wait for storage to be mounted Determines whether to wait for the media mount or stop the

current operation

Truncate Determines whether to truncates the log file


▪ Display none




170

Exchange parameters

The following table describes Exchange parameters that are used in Defining a Control-M for Backup job

for TSM.


cannot be used).


Storage Group Defines the name of the Exchange Storage Group that you want

to back up

Backup Mode (Exchange) Determines one of the following backup methods

▪ Full

▪ Copy

▪ Incremental

▪ Differential

▪ DB Copy

DB Name (Exchange) Defines the database name of the Microsoft Exchange server


configuration file





▪ Display none



Lotus Domino parameters

The following table describes Lotus Domino parameters that are used in Defining a Control-M for Backup

job for TSM.


171


cannot be used).


Database Type Determines whether to back up a DB2 or NSF database

Database Name Defines the name of the DB2 or NSF database

DB2 Groups Defines the DB2 groups to back up


configuration file




Full Determines whether to back up the full database

Backup Mode (Lotus) Determines whether to back up selective files or only data that

changed since the last backup.

Backup also sub-directories

(Lotus)

Determines whether you want to include subdirectories of named

directories for processing


▪ Display none



Image parameters

The following table describes Image parameters that used in Control-M for Backup job for TSM.


172


cannot be used).


Drive/Directory Defines the drive or directory to create a backup image

Mode (Image)) Determines whether to back up selective files or only data that

changed since the last backup

Snapshot provider name Enables snapshot-based online image backup, and defines a

snapshot provider




▪ Display none



Virtual Machine parameters

The following table describes Virtual Machine parameters that are used in Control-M for Backup job for

TSM.


173


cannot be used).


Virtual Machines List Determines which Virtual Machines to back up

Backup Type (Virtual Machine) Determines one of the following backup options:

▪ File

▪ Full VM

▪ Hyper Full




▪ Display none




174

Regular folder parameters

The following table describes parameters for a regular folder that is used to contain jobs:

Parameter Description Control-M rules

Folder Type Indicates whether the folder type is a regular

folder, or a SMART folder.

Value: Regular

Folder Name Defines the name of the folder. In the

Properties pane, this parameter indicates the

folder where the job belongs.

Length:

▪ 1-64 characters

▪ z/OS: 1-8 characters

Case sensitive: Yes

Invalid characters:

▪ Blanks

▪ Single quotation marks

▪ z/OS: Non-English

characters

▪ "$", "/", "*", "?", " "

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.


175


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

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

Site Standard Applies the defined Site Standard to the folder

and all jobs contained in the folder. For more

information on Site Standards, see Planning domain administrative regulations (on page

22).

If only one Site Standard exits, it is selected

by default. If there are no Site Standards

defined, it is set to None.

Contact your Control-M

Administrator

Business Parameter Defines one or more Business parameters,

according to the Site Standard you have

selected. For more information on Business parameters, see Planning domain

administrative regulations (on page 22).

If the Site Standard field is set to None, there

are no Business parameters displayed.


Administrator


176

SMART folder parameters

The following table describes parameters for a SMART folder that is used to define scheduling,

prerequisites, and actions of the jobs contained in the SMART folder:


Folder Type Indicates whether the folder type is a regular

folder, or a SMART folder.

Value: SMART




Length:

▪ 1-64 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks



characters

▪ "$", "/", "*", "?", " " .

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 job flow.

Length:1-4000 characters

Case Sensitive: Yes


177


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.




parameter is used by the Control-M security

mechanism.

Length:

▪ 1-30 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks


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.

Length: None

Case Sensitive: Yes

Invalid Characters:

▪ Blanks



178


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.

Length: 1-64 characters

Case Sensitive: Yes

Invalid Characters:

▪ Blanks


Site Standard Applies the defined Site Standard to the folder

and all jobs contained in the folder. For more information on Site Standards, see Planning

domain administrative regulations (on page

22).

If only one Site Standard exits, it is selected

by default. If there are no Site Standards

defined, it is set to None.


Administrator

Business Parameter Defines one or more Business parameters,

according to the Site Standard you have selected. For more information on Business

parameters, see Planning domain

administrative regulations (on page 22).

If the Site Standard field is set to None, there

are no Business parameters displayed.


Administrator

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.

Length:

▪ Name: 1-40

▪ Value: 1-4000

z/OS:

▪ Name: 1-66

▪ Value: 1-66

Created By Indicates the Control-M/EM user who defined

the job.

(not z/OS folders)


Case Sensitive: Yes

Invalid Characters:

▪ Blanks



179


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

URL Length:

Combines the length of Doc Member/Doc File/Doc

Library/Doc Path

File length: 1-64

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.

Length:

▪ Microsoft Windows and

UNIX: 1-255 characters

▪ iSeries (AS/400): 1-21

characters

▪ OpenVMS: 1-60

characters


Case Sensitive: Yes

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.

Length:

▪ 1-64 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks


characters


180


Priority Determines the order of job processing by

Control-M.

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:


181

NOTE: You can only create a Sub folder from a SMART folder.


Folder Type Indicates that the folder type is a Sub Folder.




Length:

▪ 1-64 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks



characters

▪ "$", "/", "*", "?", " " .

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 job flow.

Length:1-4000 characters

Case Sensitive: Yes




parameter is used by the Control-M security

mechanism.

Length:

▪ 1-30 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks


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.

Length: None

Case Sensitive: Yes

Invalid Characters:

▪ Blanks



182


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



Case Sensitive: Yes

Invalid Characters:

▪ Blanks


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.

Length:

▪ Name: 1-40

▪ Value: 1-4000

z/OS:

▪ Name: 1-66

▪ Value: 1-66

Created By Indicates the Control-M user who defined the

job.

(not z/OS folders)


Case Sensitive: Yes

Invalid Characters:

▪ Blanks


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

URL Length:

Combines the length of Doc

Member/Doc File/Doc

Library/Doc Path

File length: 1-64


183


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.

Length:

▪ Microsoft Windows and

UNIX: 1-255 characters

▪ iSeries (AS/400): 1-21

characters

▪ OpenVMS: 1-60

characters


Case Sensitive: Yes

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.

Length:

▪ 1-64 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks


characters

Priority Determines the order of job processing by

Control-M.


184

Azure job parameters

The following table describes the Azure job parameters.


Connection profile Defines the name of the Azure connection profile

Control-M rule: 1-30 characters (only capital letters)

Service Determines whether the job is a Function, Logic app or Batch

account job

Function Defines the name of the function

Function app Determines which Function app is used (filled automatically when

using the Function load button)

Parameters Defines the function parameters

Logic app name Defines the name of the Logic App

Request body Determines the JSON for the expected payload

Job ID Defines the Batch Job’s ID

Task command line Defines the command line that is performed by the Batch

Max wall-clock time Determines whether the job’s maximum run time is unlimited or

set to a custom duration

Max task retry count Determines whether the number of times a failed task is retried is

none, unlimited, or set to a custom number

Retention time Determines whether the file retention period is unlimited or set to

a custom duration


185

AWS job parameters

The following table describes the parameters for AWS:


Function Name Determines the Lambda function to execute

Version Determines the Lambda function version

Payload Defines the Lambda function payload in JSON format

Client Context JSON Defines client-specific information

State Machine Defines the State Machine to be used

Execution Name Defines a name for the execution

Input Defines the Step Function input in JSON format

Job Name Defines the name of the Batch job

Job Definition Determines the job definition to be used

Job Definition Revision Defines the job definition revision

Job Queue Determines the queue to which the job is submitted

Parameters List Defines the parameters for the job

Job Type Determines whether the Batch job is a single or an array job

Array Size Defines the size of an Array job (minimum 2)

Depends on Type Determines an AWS Batch job dependency

Type Determines whether the Batch job depends on a Standard,

Sequential or N-to-N job type

Job Depends on Defines the JobID upon which the Batch job depends

Command Defines a command to send to the container that overrides the

default command from the Docker image or the job definition

Environment Defines the environment variables to send to the container

Memory Defines the number of MB of memory reserved for the job

(minimum 4)


186


vCPUs Defines the number of vCPUs to reserve for the container

Job Attempts Defines the number of retry attempts

Execution Timeout Defines the timeout duration in seconds

Job Scheduling You can schedule a job, which enables you to order the job when it is part of Control-M definitions, as

long as the other prerequisites are met. You can use any number of approaches and parameters to define

the jobs schedule, as described in:

▪ Scheduling a job/Folder (on page 186): Enables you to define scheduling criteria for the individual

job/folder. Your definitions are the criteria for when the job is run.

▪ Scheduling options (on page 191): Enables you to select the type of scheduling to apply to the

job/folder.

▪ Scheduling parameters (on page 187): Describes the scheduling parameters that you can define as

criteria for when the job is run.

▪ Scheduling examples (on page 200): Provides a number of examples of scheduling scenarios, which

can assist you in identifying which scheduling options suit your scheduling needs.

Scheduling a job/Folder

This procedure describes how to schedule a job/folder, which enables you to set job scheduling criteria

for submission

Before you begin

Ensure that you have created the job/folder you want to schedule, as described in Job Definition (on page

23).

➢ To schedule a job/Folder:

1. Select the job/folder you want to schedule in the Workspace.


2. Click .


187


3. Select the Scheduling tab.

The Scheduling parameters appear.

4. From the Schedule drop-down list, select a scheduling option, as described in Scheduling options (on

page 191).

5. Define the relevant parameters as described in Scheduling parameters (on page 187).

You have scheduled your job or folder.

6. (Optional) To verify your scheduling definition, right click on the Job/Folder and select View Schedule.

Note: This option is available only if Forecast is activated.

7. Do one of the following:

• If you have completed your definitions, do one of the following:

o Click Validate, to validate your definitions, as described in Validating job definitions in a

Workspace (on page 256).

o Click Save, to save your work.

o Click Submit, to submit your Workspace to the scheduler. For more information, see

Submitting a Workspace as a request (on page 257).

o Click , to check in your Workspace. For more information, see Checking in a

Workspace (on page 259).

• If you want to continue defining your job/folder, do one of the following:

o Define dependencies between jobs and folders, as described in Job prerequisites (on page

203).

o Define job/folder actions, as described in Job actions (on page 209).

Follow the instructions according to what you select.

Scheduling parameters

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


188

Take into consideration that some parameters might not appear in your properties pane, if they were not

specified in the User View you applied. Use Control-M rules if the parameter rules were not specified by

the Site Standard.

Field Description Control-M rules

Scheduling Defines the Scheduling options for the

Schedule field in the Scheduling tab of the

Properties pane.

Displays your scheduling criteria of a job or

SMART folder in a calendar yearly view. You can view the current year and the following

calendar year.

NOTE: Only available if Control-M Forecast is

installed.

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 for

Z/OS.

From Time Sets time limits for submitting the job. For

z/OS jobs, includes the days offset.

▪ Select Time: Enables you to set the time limits for submitting the jobs. For z/OS

jobs, includes the days offset.

▪ End of day (new day time): 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 be submitted

after its original scheduled date.

HH:MM

To Time Sets time limits for submitting the job. You

can select one of the following options:

▪ Select Time: Enables you to set the time

limits for submitting the jobs. For z/OS

jobs, includes the days offset

▪ End of day (new day time): 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 be submitted

after its original scheduled date.

HH:MM


189


Must End Sets the time and day when the job must

finish executing. Also includes the days offset.

(z/OS only)

HH:MM

Rerun Settings Defines an area in the Scheduling tab of the

Properties pane to set rerun settings including

Cyclic, Maximum reruns, and Rerun Member.

A job can run more than once after order

when one of the following parameters are

used:

▪ The job's completion status was set to

rerun in the Maximum reruns field

▪ The job is defined as cyclic

The job is resubmitted after the specified number of minutes have elapsed from the last

rerun or form the start/end of the last run of a cyclic job and all submission criteria are

satisfied.

Cyclic Indicates that the job must run at a

designated time, interval of time.

Maximum reruns Determines the maximum number of reruns

that can be performed for the job. Length:

▪ An integer from 0

through 99.

▪ z/OS: There is a

difference between cyclic

jobs and regular jobs:

▪ Cyclic jobs – an integer

from 0 through 9999

▪ Regular jobs – an integer

from 0 through 255.

Rerun Member Defines the name of the JCL member to use

when the job automatically reruns.

For z/OS jobs.

Length:

▪ 1-8 characters

▪ Invalid Characters

Case Sensitive: Yes

Invalid Characters:

▪ Blanks

▪ non-English characters


190


Time Zone Indicates the time zone according to which

the job should be scheduled.

Activity Period Defines the area in the Scheduling tab of the Properties pane that describes Active/Not

Active between dates, Start Date, and End

Date.

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.

Active/Not Active

From

Sets the following dates when the job is

ordered.

▪ From: Minimum date to order the job (job

will not be ordered before this date)

▪ To: Maximum date when to order the job

(job will not be ordered after this date)

mm-dd-yy


191


Active/Not Active To Sets the date when the job must be ordered. mm-dd-yy

Statistics Calendar (z/OS only) Defines the name of the Control-M

periodic calendar, within which statistics

relating to the job are collected.

A valid period calendar name

consisting from 1 to 8

alphanumeric characters.

Case Sensitive: Yes

Invalid Characters:

▪ Blanks

▪ Non-English characters

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.

Length: An integer from 0

through 98 (days), or 99 (no

limit)

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

scheduled date has

passed

Indicates if the job should be scheduled for

possible execution after its original scheduling

date has passed.

Scheduling options

The following table describes the various scheduling options:


192

Take into consideration that some options might not appear in your properties pane, if they were not

specified in the User View you applied.

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.

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

Free space on PDS (Control-M for z/OS only) Defines the name of a partitioned data

set (PDS) to be checked for free space. 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.

Use parent schedule Defines scheduling for a job or sub-folder in a SMART folder

according to the scheduling criteria of the parent SMART folder.

Advanced Defines a combination of scheduling options, as described in

Using advanced scheduling (on page 193).

Scheduling a cyclic job/SMART Folder

This procedure describes how to schedule a cyclic job/SMART Folder which enables you to rerun a job/SMART Folder for an additional execution. The job/SMART Folder reruns when the first run has

completed, and when the defined cyclic criteria are met.

NOTE: To enable the cyclic SMART Folders option, you must have full User Views set in User preferences

(on page 9).

➢ To schedule a cyclic job/SMART Folder:

1. Select the job/SMART Folder you want to schedule in the Workspace.

The job/SMART Folder properties pane appears on the right.

2. Click .

The job/SMART Folder properties are enabled for definition.


193



4. In the Rerun settings area, click the Cyclic button to enable it.

5. From the Rerun drop-down list select one of the following:

• Interval: Separates job runs by a specific interval. In the Every field, specify the interval time,

and From job's drop-down list, select whether the cycle should be measured from Start, End or

Target (scheduling) time of the current instance.

• Using interval sequence: Separates job runs according to the specific sequence of intervals.

You can add your interval sequences, and the count between each interval. The job runs at the time designated according to the time interval sequences specified. In the From job's drop-down

list, select whether the cycle should be measured from Start, End or Target (scheduling) time of

the current instance.

• At specific times: Runs jobs according to the specified job start times. Enter specific times for

the job runs and select a lateness tolerance. If the job being executed runs over the proceeding job’s specified time, the proceeding job’s execution time window is extended to the number of

minutes set in the Tolerance field. For example, if the Tolerance field is set to 15 minutes, the proceeding job can still be executed 0-15 minutes after the specified time. If the tolerance time

interval has passed, the proceeding job will not be performed. For z/OS, you can add the days

offset.

6. In the Maximum reruns fields, specify the maximum number of reruns that can performed for the

job. The job is rerun after the rerun interval times are met.

NOTE: When a cyclic folder runs, conditions that are set between jobs are cleared right before the folder

runs to maintain the jobs' original dependencies. If the conditions are not cleared, the next time the jobs run they won’t have any dependencies, and the jobs will run in parallel. The following list describes the

scenarios for conditions that are cleared and conditions that are not cleared:

▪ Conditions are cleared between jobs within the SMART folder right before the folder runs

▪ Conditions are cleared when a condition used by both a job within the SMART folder and a job outside

the folder

▪ Conditions are not cleared if there is a dependency to a job from outside the SMART folder

▪ Conditions are not cleared automatically when created through the On-Do Actions

▪ Conditions are not cleared between cyclic SMART folders

Using advanced scheduling

This procedure describes how to use advanced scheduling, which enables you to specify some

combination of months, days of the month, and days of the week.

➢ To use advanced scheduling:




194

2. Click .



4. From the Schedule drop-down list, select Advanced.

5. Click .

6. Define your scheduling criteria depending on your needs by defining one or a combination of the

following options:

• Scheduling jobs on week days (on page 194): Defines the days of the week on which to schedule

the job.

• Scheduling jobs on month days (on page 195): Defines the days of the month on which to

schedule the job.

• Order on months: Defines on which months the job is scheduled.

• Scheduling jobs using Rule-based Calendars (on page 199): Specifies the Ruled-Based Calendars

that are applied to this job.

• Scheduling jobs using a confirmation calendar (on page 197): Specifies the calendar used to

confirm job scheduling dates.

You can define the relationship between these options by selecting And/Or.

For more information on how to use advanced scheduling in specific scenarios, see Scheduling

examples (on page 200).

Scheduling jobs on week days

The following procedure describes how to schedule jobs on week days.

➢ To schedule jobs on week days:



2. Click .




5. Click .

6. In the Week days area, you can do one of the following:

• Order a job on a selected day, by selecting a day in the Order tab.


195

• Order a job on a specific day in a specific week, by selecting weeks and days from the Start of

week tab.

You can select more than one week, for example W1 Monday and Tuesday, W2 Monday and

Thursday, and so on.

• Order a job on week days based on calendar, for more information see Scheduling jobs on week

days based on a calendar (on page 195).

Scheduling jobs on month days

The following procedure describes how to schedule jobs on month days.

➢ To schedule jobs on month days:



2. Click .




5. Click .

6. In the Month days area, you can do one of the following:

• From the Order tab, order a job on a selected day, by selecting a day.

• From the End of month tab do one of the following:

o Select a working day or days from the end of the month on which the job will be ordered on

every month. When you select the day, choose the On day from end of month option. For example, if you select L1 the job is ordered one day before the end of the month. If the

month is 30 days, the job is ordered on the 29th.

o Select a working day or days from the end of the month on which the job will not be ordered

on every month. When you select the day, choose the On all days except on selected day

from end of month option. For example, if you select -L1 the job is not ordered one day before the end of the month. If the month is 30 days, the job is ordered on all days of the

month except the 29th.

• Order a job on month days based on calendar, for more information see Scheduling jobs on

month days based on calendar (on page 196).

Scheduling jobs on week days based on a calendar

This procedure describes how to schedule a job on week days based on a calendar.

➢ To schedule a job on week days based on calendar:



196


2. Click .




5. Click .

6. In the Week Days area, from the Calendar drop-down select a calendar.

NOTE: The calendar name must be provided to you by the Control-M Scheduler. The Control-M

Scheduler creates the calendar in the Control-M client.

7. Do one or more of the following depending on your scheduling needs:

• From the Order tab, select a day or days on which the job is ordered.

When you select a day, a list of rules appears, for more information see Advanced scheduling

rules (on page 199).

• From the Start of week tab, do one of the following:

o Click Select all, and then select a working day or days of the week on which the job will be

ordered on every week. When you select the day, choose the On day if working day

option. For example, if you select D1, the job is ordered on day 1 of every working week.

o Click Select all, and then select a day or days of the week on which the job will not be

ordered on every week. When you select the day, choose the On all working days except selected day option. For example, if you select D1, the job will be ordered on all working

days in calendar, except day 1 of every working week.

o Select a specific week, and then select specific day or days. For example. W2 D3 will schedule

the job on the second week of the month, on the 3rd day of that week.

You can select more than one week, for example W1 Monday and Tuesday, W2 Monday and

Thursday, and so on.

• From the End of week tab do one of the following:

o Select a working day or days from the end of the week on which the job will be ordered on

every week. When you select the day, choose the On day from end of week option. For

example, if you select L1 the job is ordered one day from the end of the week.

o Select a working day or days from the end of the week on which the job will not be ordered

on every week. When you select the day, choose the On all days except on selected day from end of week option. For example, if you select -L1 the job is not ordered one day

from the end of the week.

Scheduling jobs on month days based on calendar

This procedure describes how to schedule a job on month days based on a calendar.


197

➢ To schedule a job on month days based on calendar:



2. Click .




5. Click .

6. In the month days area, from the Calendar drop-down select a calendar.

The calendar name must be provided to you by the Control-M Scheduler. The Control-M Scheduler

creates the calendar in the Control-M client.

7. Do one or more of the following depending on your scheduling needs:

• From the Order tab, select a day or days on which the job is ordered.

When you select a day, a list of rules appears, for more information see Advanced scheduling

rules (on page 199).

• From the Start of month tab, do one of the following:

o Select a working day or days of the month on which the job will be ordered on every month. When you select the day, choose the On day if working day on calendar option. For

example if you select D1, the job is ordered on 1st working day 1 of every month.

o Select a day or days of the month on which the job will not be ordered on every month.

When you select the day, choose the On all working days except selected day option.

For example if you select D1, the job will be ordered on all working days in calendar, except

first working day of every month.

• From the End of month tab do one of the following:

o Select a working day or days from the end of the month on which the job will be ordered on

every month. When you select the day, choose the On day from end of month option. For

example, if you select L1 the job is ordered one day before the end of the month. If the

month is 30 days, the job is ordered on the 29th.

o Select a working day or days from the end of the month on which the job will not be ordered on every month. When you select the day, choose the On all days except on selected day

from end of month option. For example, if you select -L1 the job is not ordered one day

before the end of the month. If the month is 30 days, the job is not ordered on the 29th.

Scheduling jobs using a confirmation calendar

This procedure describe show to schedule a job on week days and/or month days with a confirmation

calendar defined, which enables you to validate your scheduling dates based on a confirmation calendar.

Jobs that are scheduled on a given day are checked against the confirmation calendar.


198

➢ To schedule a job using a confirmation calendar:



2. Click .




5. Click .

6. In the Confirmation Calendar area, click on the expand arrow.

7. Do one or all of the following depending on your scheduling needs:

a. In the Calendar field, select a calendar that is used to validate your scheduling dates.

b. From the Exception Policy drop-down, select one of the options below in the event that a job is

supposed to run on a day that is not in the confirmation calendar:

o Do not order: Do not order the job on a different date.

o Order on the next confirmed day: Shift the job schedule to the next working day in the

calendar.

o Order on the previous confirmed day: Shift the job schedule to the last previous working

day in the calendar.

o Order anyway: Schedule the job for the current day even if it is not a working day.

c. In the Shift by field, specify the number of working days that a job can be shifted, in addition to

the Exception Policy option you choose.

Depending on the shift value, the job is scheduled on an earlier day, a later day, on the original

scheduling date, or not ordered.


199

Advanced scheduling rules

The following table describes the Advanced Week/Month Days with rules options. In advanced scheduling (on page 193), 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

Selected working days Schedules the job to be ordered on the selected working day,

if day is a working day in the calendar.

Force order even if a

non-working day

Schedules the job to be ordered on the selected day even if it

is not a working day in the calendar.

All working days except

selected day Schedules the job to not be ordered on the selected day.

Day or the next working day

(>)

Defines scheduling either on the day or the next working day.

Day or the previous working

day (<)

Defines the scheduling either on the day or the last working

day.

Scheduling jobs using Rule-based Calendars

This procedure describes how to schedule jobs using a Rule-based Calendar (RBC), which enables you to

➢ To schedule a job using a Rule-based Calendar:



2. Click .




5. Click .

6. In the Rule Based Calendar area, from the Use drop-down list you can do one of the following:

• All parent calendars: Inherits all the RBCs from the direct parent folder. If an RBC is added to

the parent folder, it is automatically associated with the job.


200

• Select from parent: Only the RBCs selected from the list are associated with the job. If multiple

RBCs are selected, the RBCs are checked sequentially (according to the order in which they are defined for the folder) during job scheduling to determine if the criteria are satisfied. The first set

of RBC criteria that is satisfied is applied to the job. Subsequent RBCs specified for the job are not

checked.

You can view an RBC's scheduling information by clicking on the specific RBC name in the list,

and then click . A view of the calendar scheduling criteria is displayed in read-only mode.

To exit the RBC calendar view, click Close.

7. In the Exclude field, click and select the RBCs you want to exclude. The RBCs you select are used to

set the dates that will not be scheduled (excluded RBCs) in a job, sub-folder, and SMART 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 runs on every day that is not a weekend and not a holiday.

NOTE: Each job processing definition can have its own basic scheduling criteria defined, independent

of the RBC criteria in the folder. If the relationship between the scheduling criteria and RBCs is OR, the basic scheduling criteria of the job or a specified RBC (or both) are satisfied. If the relationship is

AND, both the basic scheduling criteria of the job and a specified RBC are satisfied.

Chapter

Scheduling examples

The following topics describe scheduling examples based on the different scheduling options in the

planning domain:

▪ First day at the end of each quarter example (on page 200)

▪ On all working days in specific months example (on page 201)

▪ On all working Mondays in July and August example (on page 201)

▪ Cyclic job example (on page 201)

▪ Schedule the job on the 5th and 10th days from the end of the month example (on page 202)

▪ Schedule the job on the 5th and 10th days from the end of the month example (on page 202)

▪ Schedule jobs based on calendar example (on page 203)

First day at the end of each quarter example

The following example describes how to schedule a job on the first day following the end of April, July,

October and January:

1. In the Scheduling tab, from the Scheduling drop-down, select Advanced.

2. Click .


201

3. In the Month Days area, select 1 from the calendar.

4. In the Order on Months area, select Apr, Jul, Oct, and Jan.

On all working days in specific months example

The following example describes how to schedule a job on all working days in July and August. For all

working days, you can use a calendar. The Control-M Scheduler creates a calendar defined with the

working days.


2. Click .

3. In the Month Days area, from the drop-down list, select the Workdays calendar.

4. In the Order on Months area, select Jul and Aug.

On all working Mondays in July and August example

The following example describes how to schedule a job on all working Mondays in July and August. For all working days, you can use a calendar. The Control-M Scheduler creates a calendar defined with the

working days.


2. Click .

3. In the Week Days area, from the Calendar drop-down, select the Workdays calendar.

4. In the Order tab, select Mo.

5. A list appears, from the first drop-down, select Selected working day, and check the checkbox.

6. In the Order on Months area, select Jul and Aug.

Cyclic job example

The following example describes how to schedule a cyclic job. Let's assume a job that updates flight times

for an airline should cycle through every 3 minutes from the end of the previous run. If for some reason it fails, it should trigger an alternative flight update program, shout a message to the administrator, and

stop running. Select the job/folder you want to schedule in the Workspace.



2. Click .




4. In the Rerun settings area, click the Cyclic button to enable it.


202

5. From the Rerun drop-down list, select Interval, and set it to every 3 minutes from job's end.

6. In the Maximum Rerun field, set the value to 99.

7. Select the Actions tab, add an On-do Actions statement and do the following:

a. From the On drop-down list, select Job ended Not OK.

b. From the Do drop-down list, select Order job. In the Folder field, type Flight, in the Job name

field, type AltUpdate, from the Date drop-down list select Order Date.

c. Click Add Do.

d. From the Do drop-down list, select Notify. In the Destination field, select Alerts Window, in

the Urgency field select Very Urgent, and in the message field type failure in flight update job.

e. Click Add Do.

f. From the Do drop-down list, select Stop Cyclic run.

Schedule the job on the last day of the month example

The following example describes how to schedule a job on the last day of the month:


2. Click .

3. In the Month Days area, in the End of month tab, select L1, and then select the On day from the

end of the month option.

4. In the Order on Months area, select Apr, Jul, Oct, and Jan.

In a month with 31 days, the job will be ordered on the 31st day of the month.

In a month with 30 days, the job will be ordered on the 30th day of the month.

In a month with 28 days, the job will be ordered on the 28th day of the month.

Schedule the job on the 5th and 10th days from the end of the month example

The following example describes how to schedule a job on the 5th and 10th days from the end of the

month.


2. Click .

3. In the Month Days area, in the End of month tab, select L5 and L10.

In a month with 31 days, the job will be ordered on the 22nd and 27th day of the months.

In a month with 30 days, the job will be ordered on the 21st and the 26th day of the month.

In a month with 28 days, the job will be ordered on the 19th and 24th day of the month.


203

Schedule jobs based on calendar example

The following example describes how to schedule the job on the 1st and 15th day of the month even

when they do not appear in the calendar, and to ensure that the job will not be scheduled on the 10th

and 25th day of the month even when they appear in the calendar:


2. Click .

3. In the Month Days area, from the Calendar drop-down list select a calendar.

4. In the Order tab, do the following:

• Select 1, from the list, and then from the first drop-down list, select the Force order even if a

non-working day option. Select 15 and do the same.

• Select 10, from the list, then from the first drop-down list, select the All working days except

selected day option. Select 25 and do the same.

The job will be ordered on every day marked as a working day in the calendar, except on the 10th and 25th; it will also be ordered on the 1st and 15th of the month even if they are not working days

in the calendar.

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:

▪ Requires user confirmation: Enables you to specify that a user must confirm the prerequisite for the

job.

▪ Creating an In Condition (on page 203): Enables you to specify one or more In Conditions which

correspond to the successful completion of another job.

▪ Allocating control resources (on page 207): Enables you to specify whether the job requires exclusive

or shared access to a physical resource, such as tape drive.

▪ Allocating Quantitative Resources (on page 208): Enables you to specify the resource in the Control-M

and, for each job, the quantity required/used by that job. This does not apply to folder definitions.

Take into consideration that some of these options might not appear in your properties pane, if they were

not specified in the User View you applied.

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 before the job can run.


204

Before you begin

Successful completion of the following:

▪ Open the Workspace that holds the jobs with the intended In Condition. For more information, see

Setting up a Control-M Web Workspace (on page 247).

▪ You must have a Workspace with at least two jobs to create an In Condition.

➢ To create an In Condition:



2. Click .


3. Select the Prerequisites tab.

4. In the In Conditions section, click .

5. In the Name field, type a name for the In Condition. For more information, see In Condition

parameters (on page 204).

6. From the Order Date drop-down list, select the order date for the job to run. For more information,

see In Condition parameters (on page 204).

7. Click , select the relationship between conditions. For more information, see In Condition


8. If you select Set Manually, define the following:

• If you want to add brackets, from the Opening Bracket and Closing Bracket drop-down lists,

select the brackets. For more information, see In Condition parameters (on page 204).

• From the Relationship drop-down list, select the relationship between the In Conditions. For

more information, see In Condition parameters (on page 204).

Note: If you define your In Conditions relationship manually, and then select the AND/OR between

all, your manual definitions are deleted.

The In Condition is created.

In Condition parameters

The following table lists the In Condition parameters:


205



the Site Standard.


Condition Name Name of the In Condition. Length:

▪ 1 through 255 characters.

▪ z/OS: Not more than 39

characters

Case Sensitive: Yes

Invalid Characters:

▪ Blanks, parentheses; "|"

(pipe)

▪ Computers other than z/OS:



206


Order Date The date definitions of the

condition.

▪ Any Date: Any scheduling

date. The Condition

parameter is satisfied if any prerequisite condition with

the same name exists, regardless of its associated

date.

▪ No Date: Condition is not

date-dependent.

This value is valid only for

Control-M/Server version 6.0.01 and later or for

Control-M for z/OS.

▪ Order Date: Variable that

is automatically replaced by the job’s original scheduling

date (that is, the date on

which the job was ordered).

▪ Previous Order Date:

Variable that is automatically

replaced by the job’s

previous scheduling date.

▪ Next Order Date: Variable

that is automatically replaced by the job’s next

scheduling date.

▪ Specific Date: A 4-digit

date reference in the mmdd or ddmm format, depending

on the site standard.

▪ Offset: + or - followed by a

number from 0 through 999, indicating the number of

days in the future (+), or in the past (-), relative to the

actual order date.


207


Relationships Specifies the logical relationship

between In Conditions.

▪ AND Between All:

Specifies that all In

Conditions have an AND

relationship

▪ OR Between All: Specifies

that all In Conditions have

an OR relationship

▪ Set Manually: Enables you

to set the Condition

Relationship criteria

manually

Brackets Parentheses are used to isolate

groups of In Conditions in a longer list of conditions to

indicate logical relationships that are resolved before the entire

condition statement is resolved.

Pairs of parentheses cannot be

nested.

blank: Indicates no special

relationship between the current

and following condition:

▪ "(" Beginning of a

comparison between

successive conditions.

▪ ")" End of a comparison between successive

conditions

Allocating control resources

This procedure describes how to allocate a control resource for a job, which enables you to specify the

type of control the job needs.

Before you Begin

Open the Job Flow Workspace that holds the jobs with the intended control resource. For more

information, see Setting up a Control-M Web Workspace (on page 247).

➢ To allocate control resources:



2. Click .



4. In the Control Resources section, click .

A new row is added to the Control Resources list.


208

5. In Control Resources, do one or more of the following:

• In the Resource Name field, type a name for the control resource. For more information, see

Control resources parameters (on page 208).

• From the Type drop-down list, select either Shared or Exclusive. For more information, see

Control resources parameters (on page 208).

• (z/OS) From the On Fail drop-down list, select either Release or Keep.

The control resource is allocated.

Control resources parameters

The following table lists the control resources parameters:


Resource Name Name of the resource. Length:

▪ 1-64 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks



Type Type of control resource. ▪ Exclusively owned by a job

▪ Shared by any number of

jobs

Allocating Quantitative Resources

This procedure describes how to allocate a quantitative resource for a job which enables you to specify

the quantified resources for a job.

Before you begin

Open the Workspace that holds the jobs with the intended quantitative resource. For more information,

see Setting up a Control-M Web Workspace (on page 247).

➢ To allocate Quantitative Resources:




209

2. Click .



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. For more information,

see Quantitative Resources parameters (on page 209).

• From the Required Quantity field, select the quantity of the quantitative resource. For more

information, see Quantitative Resources parameters (on page 209).

• (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.

Quantitative Resources parameters

The following table lists the quantitative resources parameters:


Resource Name Name of the quantitative

resource. Length:

▪ 1-64 characters


Case Sensitive: Yes

Invalid Characters:

▪ Blanks



Required quantity Amount of the resource that is

required. 1-9999

Job actions

The following are the different actions that you can define for Control-M to perform, based on various job

run events, such as conditions and job status:


210

▪ Creating an Out Condition (on page 210): Enables you to create an Out Condition that is added or

deleted to the Conditions table when job ends OK for a predecessor job.

▪ Creating notifications (on page 232): Enables you to create notifications that are sent to Alerts

Window, Control-M/Server log file, User Console, or any defined location the Shout destination management in response to problems or integrating with other external monitoring applications. You

can write the message, and set the urgency to Regular, Urgent, or Very Urgent. There are two types

of notifications:

• Notifications before job's completion options (on page 234): Notifications are based on various

time. For example, jobs not being submitted by a certain time, or a job's average execution time

is, or the job is not finished by a certain time.

• Notifications after job's completion options (on page 235): Notifications are based on a job

completing OK or Not OK.

▪ Creating On-Do Actions (on page 214): Enables you to create automatic interventions, such as

rerunning a job or ordering a remedial job, if a job ends with a particular error code.


specified in the User View you applied.

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 (or removed) when the job ends.

Before you begin


▪ Open the Workspace that holds the jobs with the intended Out Condition. For more information, see


▪ You must have a job flow with at least two jobs to create an Out Condition.

➢ To create an Out Condition:



2. Click .


3. Select the Actions tab.

4. In the Out Conditions section, click .

5. In the Name field, type a name for the Out Condition. For more information, see Out Condition


6. From the Order Date drop-down list, select the order date for the job to run. For more information,

see Out Condition parameters (on page 211).

7. From the Add/Remove The Condition drop-down list, select Add or Remove. For more

information, see Out Condition parameters (on page 211).


211

The Out Condition is created.

8. To set Output Handling, set the Action field.

An Out Condition is displayed in the job flow as a solid line.

Out Condition parameters

The following table lists the Out Condition parameters:


212



the Site Standard.


Condition Name Name of the Out Condition. Length:

▪ 1 through 255 characters.

▪ z/OS: Not more than 39

characters

Case Sensitive: Yes

Invalid Characters:

▪ Blanks; single quotation marks; parentheses; "|"

(pipe)




213


Order Date The date definitions of the

condition.

▪ Any Date: Any scheduling

date. The Condition

parameter is satisfied if any prerequisite condition with

the same name exists, regardless of its associated

date.

▪ No Date: Condition is not

date-dependent. A no date condition must be specified,

as it is not date dependent.

▪ Order Date: Variable that is automatically replaced by

the job’s original scheduling

date (that is, the date on

which the job was ordered).

▪ Previous Order Date:

Variable that is automatically replaced by the job’s

previous scheduling date.

▪ Next Order Date: Variable

that is automatically replaced by the job’s next

scheduling date.

▪ Specific Date: A 4-digit

date reference in the mmdd or ddmm format, depending

on the site standard.

▪ Offset: "+" or "-" followed by a number from 0 through

999, indicating the number

of days in the future (+), or in the past (-), relative to

the actual order date.

Add/Remove the condition

Indicates whether the specified condition is to be added

(created) or deleted.

▪ Add: Adds (creates) the

prerequisite condition.

Default.

▪ Remove: Deletes the

prerequisite condition


214

Creating On-Do Actions

This procedure describes how to create On-Do Actions, which enables you to automatically intervene,

such as rerunning a job or ordering a remedial job, if a job ends with a particular error code

Before you begin


▪ Open the Job Flow Workspace that holds the jobs with the intended action. For more information, see


▪ You must have a job flow with at least two jobs to create an action.

➢ To create On-Do Actions:



2. Click .



4. In the On-Do Actions section, click .

The On-Do Actions window appears.

5. From the On drop-down list, select the On action. For more information, see On actions options (on

page 214).

6. (z/OS only) To add another On Action click .

NOTE: To choose the relationship between On Actions, from the dropdown list select AND or OR.

7. From the Do drop-down list, select the Do action. For more information, see Do actions options (on

page 220).

8. To add another On action, click .

9. Click OK.

The action is created.

On actions options

The following table lists the On actions:


215



the Site Standard.

On action Description Control-M rules

Job ended not OK Determines whether the accompanying DO statements are

performed if the job ended not

OK.

Job ended Determines whether the

accompanying DO statements are

performed if the job ended

Job ended Ok Determines whether the


performed if the job ended OK.

OS completion status Determines whether the

accompanying DO statements are performed if the OS completion

status is met.

Options

▪ Equal to

▪ Less than

▪ Greater than

▪ Not equal to

▪ Even: The field is considered satisfied by an

even return code

▪ Odd: The field is

considered satisfied by an

odd return code

Completion Code:

The number of the code

returned by the operating

system.


216


Job's number of executions Determines whether the accompanying DO statements are

performed if the job's number of

executions is met.

Options:

▪ Equal to

▪ Less than

▪ Greater than

▪ Not equal to

▪ Even: The field is


even return code

▪ Odd: The field is considered satisfied by an

odd return code

Number of executions: The

number of executions for the

action to take place.

Job's number of reruns Determines whether the


performed if the job's number of

reruns due to DO RERUN, is met.

Operator:

▪ = (equal)

▪ < (less than)

▪ > (greater than)

▪ ! (not equal)

▪ EVEN (the field is


even return code

▪ ODD (the field is


odd return code

Number of reruns:

The number of reruns for the


Output cannot be found Determines whether the

accompanying DO statements are performed if the Output cannot be

found.


217


Job has not been submitted Determines whether the accompanying DO statements are

performed if the job is submitted

to the Control-M/Agent to run, but

returns as not submitted.

Job's number of failures Determines whether the

accompanying DO statements are performed if the job's number of

failures is satisfied.

Operator:

= (equal)

Number of failures:

The number of failures for the



218


Specific statement output The On parameters for a specific statement output requires the

following:

▪ Statement: An asterisk must

be specified in this field. The statement set is compared to

the On statements defined for

the job.

If the Code parameter is

specified as the * mask character, it can match even a

null error message record

successfully.

If there is a match between

the On statements and a statement set from the job’s

log, the corresponding Do action statements are

executed. Otherwise, Control-M proceeds to the

next statement set.

▪ Code: Defines the exit code of

DOS .bat scripts and REXX .cmd scripts that are returned

to Control-M/Server.

On Statement/Code combinations related to

completion codes, for

example:

ON "*" "COMPSTAT>0"

On Statement/Code

combinations related to

Output, for example:

ON "*cp aaa bbb*" "*not

found*"

On Statement/Code

combinations based on the

OK/NOTOK state of the job,

for example:

ON "*" "NOTOK"

Statement:

A character string, from 1

through 132 characters in

length, containing a statement from the job script file. The

specified string can be a

portion of the statement.

Statement character strings

can each contain mask characters. Valid mask

characters are:

▪ * – represents any number of characters (including no

characters)

▪ $ – represents any single

character

▪ ? – represents any single

character

Code:

A character string, from 1 through 255 characters in

length, to be compared to the operating system’s response to

the specified statement.

Code character strings can

each contain mask characters.

Valid mask characters are:

▪ * – represents any number of characters (including no

characters)

▪ $ – represents any single

character

▪ ? – represents any single

character


219


Any programs step Indicates that the DO statements must be performed if the specified

codes are found in any program

step.

Procedure:

▪ Length:

1 through 8 characters in length, and must not

contain blanks.


Non-English characters not

allowed.

Every program step Indicates that the value is used without being accompanied by

limiting step values when the code criteria are satisfied for

every step. The code criteria are

satisfied for every step in the job

without exception.

Procedure:

▪ Length:

1 through 8 characters in

length, and must not

contain blanks.



allowed.

Specific step name Name of a specific procedure/program step. If a

specific procedure/program step is specified, only

program/procedure steps from the invoked procedure/program

are checked to see if they satisfy

the code criteria. Program/procedure steps directly

from the job are not checked.

Procedure:

▪ Length:



contain blanks.



allowed.

Program:

▪ Length:



contain blanks.



allowed.


220


Specific range name (z/OS only) Specifies a range of steps in the steps of an Any

program step statement.

Program:

▪ Length:

1 through 8 characters in length, and must not

contain blanks.



allowed.

JOBRC (z/OS only) Assign a completion code for the entire job based on

the completion codes of its steps.

Output Pattern (z/OS only) Indicates that the DO statements must be performed if

the specified pattern is found in

the output.

Pattern length:

▪ 1-40 characters

From Col length:

▪ 3 digit number

To Col length:

▪ 3 digit number

Do actions options

The following table lists the Do actions:


221



the Site Standard.

Do action Description Control-M rules

Notify The Notify parameter specifies a notification to be sent a specific destination when the specified On

Statement/Code criteria are satisfied.

For Destination parameters, see Destination


Set to OK The Set to Ok parameter assigns the completion

status of OK to a job, regardless of its actual

completion status.

Set to not OK The Set to not OK parameter assigns a completion

status of NOTOK to a job when the On

Statement/Code criteria are satisfied, regardless of

the job’s actual completion status.

Rerun job Indicates if an automatic rerun should be performed

when the On Statement/Code criteria are satisfied.

Stop cyclic run When specified, this parameter prevents subsequent

iterations of the current cyclic job.


222


Set Variable The Set Variable assigns a value to a variable for use in a rerun of the job when the On Statement/Code

criteria are satisfied.

Type:

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

▪ Global: Enables you to access the variables by its

name which can be used by any job.

▪ Named Pool: Defines variables in a pool. The

variable is referenced by the pool name -

%%\\<named_pool>\<variable_name>.

If Named Pool is selected, the Pool Name field

appears. In the Pool Name field, type the name of

the pool.

You can use a local variable as a pool name which

enables you to pass a pre-defined pool name to

jobs at order time.

Length:

▪ Name: 1- 38 characters

▪ Value:1-214 characters

▪ z/OS only: The total length of Set Variable,

including the %% prefix, variable-name, value,

and the = sign, must not exceed 55 characters


223


Order job (ignore

scheduling criteria)

The Order Job parameter forces an individual job or all jobs in a folder to be placed in Active Jobs

(regardless of each job’s Scheduling criteria) when

the On Statement/Code criteria are satisfied. For information about sub parameters, see Order job

(ignore Scheduling Criteria) (on page 232).

Folder:

▪ Length:

1 through 20 characters


Blanks; single quotation marks

OS/900: Non-English characters

Job Name:

▪ Length:

Computers other than z/OS: 1 through 20

characters.

z/OS: 1 through 8 characters.


Blanks (embedded); single quotation marks

Date:

▪ ODAT:

Resolves to the original scheduling date of the

job resulting in the execution of this parameter

(default).

▪ specific date: dd-mm-yy


224


Handle Output Indicates how the job’s output should be handled when the On Statement and Code criteria are

satisfied.

Options:

▪ Copy

▪ Delete

▪ Move

▪ Print

z/OS:

▪ None

▪ Change jobs class

▪ Delete output

▪ Copy output

▪ Move output

File name: Defines the name of the file.


225


Add/Remove

condition

The Add/Remove Condition parameter specifies a prerequisite condition to be added or deleted when

the On Statement/Code criteria are satisfied.

Name:

▪ Length:

1 to 255 characters

z/OS: 1 through 39 characters

▪ Case Sensitive:

Yes.


Blanks; parentheses; "|" (pipe)

Computers other than z/OS: Single quotation

marks

▪ Date: (four characters long) for the prerequisite

condition.

▪ Specific date (mmdd or ddmm format).

▪ Order date: Automatically replaced by the job’s

original scheduling date when the job is ordered.

▪ Prev order date: Automatically replaced by the

job’s previous scheduling date when the job is

ordered (or for a forced job, ODAT-1).

▪ Next order date: Automatically replaced by the

job’s next scheduling date when the job is

ordered (or for a forced job, ODAT+1).

▪ Any date: Any condition date. For deleting a prerequisite condition, only. When specified, all

prerequisite conditions with the specified

condition name are deleted, regardless of their

dates.

▪ No date: Condition is not date-dependent.

NOTE: Prev order date and Next order date cannot be specified when modifying details of a

job in the Active Jobs database. A date reference

is required for each condition. However, order date can be specified when modifying details of a

job in the Active Jobs database.

Add/Remove: Indicates whether the conditions

should be added (created) or removed.


226


Control-M Analyzer

Rule

(z/OS only) Invokes a Control-M/Analyzer rule to be

executed.

Name:

▪ Length:


▪ Case Sensitive:

Yes


Blanks; non-English characters

Argument:

▪ Length:


▪ Case Sensitive:

Yes


Blanks; non-English characters

Set Restart Options (Z/OS only) Job steps to be executed during restart

of a job Parameters:

▪ From program: First program step within the job

stream.

▪ From procedure: First procedure step in the

range. characters

▪ To program: Last program step within the job

stream

▪ To procedure: Last procedure step in the range.

▪ Request automatically: Enables you to specify whether manual confirmation is required before

the job is restarted.


227

Destination parameters

The following table describes the destination of Do Actions (when selecting Notify) and Notifications.

Destination Description

Alerts Window Sends a shout message to the Alerts Window.

Mail (Do Action - Notify destination) A mail message that is sent to the indicated email addresses when the condition specified by the On

Statement/Code parameter is satisfied. For more information, see

Mail (on page 228).

Remedy (Do Action - Notify destination) Opens a ticket in the Remedy Help

Desk. For more information, see Remedy (on page 231).

For computers other than z/OS:

Control-M Server Log File Sends a shout message to the Control-M/Server log file.

User Console Sends a shout message to the user console.

For computers running z/OS:

System Console Sends a shout message to the operator console.

▪ Route Code: Optional 3 digit code.

▪ Highlight: If selected, the message is a highlighted

unrollable message.

TSO User Sends a message to the specified ID.

User ID: Writes the message under the specified ID (1 to 7

characters)

Comp: (Optional) Indicates the computer and/or host of the

TSO logonid

IOA Log Writes the message to the IOA log file under the specified User

ID.

User ID: Writes the message under the specified ID.

SNMP Destination Defines the recipient address for an SNMP trap (message).

Mail Group Defines a group name in the SNMPDEST destination table.


228

Mail

A mail message that is sent to the indicated e-mail addresses when the condition specified by the On

Statement/Code parameter is satisfied.

Additional

information

Description

To E-mail addresses for recipients of the mail message. Multiple

addresses can be specified, separated by semicolons ";".

Mandatory.

NOTE: Only physical addresses or variables can be specified.

Logical addresses (as specified for the Notify parameter) are not

supported for Mail.

Length Computers other than z/OS: 1 through 255

characters


BIM job: 1 through 180 characters

Case

Sensitive

Yes

Invalid

Character

s

Computers other than z/OS: Blanks; single quotation

marks

z/OS: Blanks; non-English characters

Variable

Support

Yes. A variable or expression can be specified as all

or part of the value for this parameter.

CC E-mail addresses that should be CCed for the mail message. Multiple addresses can be specified, separated by semicolons ( ";"

). Optional.

NOTE: On some UNIX computers, all recipients are shown in the

To field because the CC field is not supported.


characters


Case

Sensitive

Yes

Invalid

Character

s

Computers other than z/OS: Blanks; single quotation

marks

z/OS: Blanks; non-English characters


229

Additional

information Description

Variable

Support

No. A variable or expression cannot be specified as

all or part of the value for this parameter.

Subject Subject line for the message.

Length Computers other than z/OS: 1 through 99 characters


Case

Sensitive Yes

Invalid Character

s

Computers other than z/OS: Single quotation marks;

do not use "-" as the first character.

z/OS: Non-English characters

Variable

Support



message Text of the mail message.


characters

z/OS: 1 through 255 lines, each containing 1 through

70 characters

However, do not exceed 4000 characters.

Case

Sensitive Yes

Invalid Character

s

Computers other than z/OS: Single quotation marks

z/OS: None

Variable

Support




230

Additional

information Description

Urgency Select from the following buttons, which indicate a level of

urgency for the message:

▪ Regular Indicates that the message should have a regular

level of urgency.

▪ Urgent Indicates messages with a high priority. Urgent

messages are sent with a special indication so that the

recipient of the message is aware of the urgency.

▪ Very Urgent Indicates that the message should have the

highest level of urgency. For Control-M/Server utilities, only.

Attach Output Specifies at the job level whether the output should be sent as an

email attachment.

Format List

Values ▪ Yes: Send the job’s output as an attachment

▪ No: Do not send the job’s output as an

attachment

▪ Default: Refers to the ADD OUTPUT TO EMAIL

value in the config.file to determine whether to

send the job’s output as an attachment.


231

Remedy

Opens a ticket in the Remedy Help Desk.

Additional information Description

Usage Optional

Format Consists of sub-parameters, described below.

Invalid Characters The following special characters are not permitted in the Remedy

parameter or its sub-parameters.

▪ Single quotation mark (‘)

▪ Double quotation marks (")

▪ Equals (=)

▪ Less than (<)

▪ Greater than (>)

▪ Ampersand (&)

▪ Backslash (\)

▪ Non-English characters

Variable Support Yes

Sub-parameters

Urgency The urgency level of the ticket that will be opened in Remedy.

Mandatory. Valid values are:

▪ L = Low (Default)

▪ M = Medium

▪ H = High

▪ U= Urgent

▪ C = Clear

Summary A brief summary is displayed in Remedy. By default, a summary of

the problem appears using variables. For more information on the

field’s characteristics, refer to Remedy documentation.

Description A detailed description is displayed in Remedy. By default, a

description of the problem appears using variables. For more information on the field’s characteristics, refer to Remedy

documentation.

The action parameter Remedy is applicable on Control-M/Server and on jobs within the batch service.


232

Order job (ignore Scheduling Criteria)

The following table describes the parameters for Order job (ignore Scheduling Criteria):


Control-M Server Defines a list of remote machines

Folder Name of the job folder

▪ Length: 1 through 20 characters


Blanks; single quotation marks

OS/400: Non-English characters

Job name Job name. If this field is blank, all jobs in the specified folder are

forced.

Length:

▪ 1 to 64 characters.

▪ z/OS: 1 through 8 characters.

Invalid Characters: Blanks (embedded); single quotation marks

Date Value to be used as the original scheduling date for the job. Valid

values are:

▪ Order date: Resolves to the original scheduling date of the job

resulting in the execution of this parameter (default).

▪ Specific date: A date reference, 4 or 6 characters long (either mmdd, ddmm, yymmdd, or yyddmm format, depending on

the site standard).

z/OS: Only the yymmdd or yyddmm format can be used.

Variables Determines the ad-hoc variable assignments that you can add, in

addition to the ones in the job definition.

Creating notifications

This procedure describes how to create notifications, which enables you to send notifications to the

specified location before/after a job is completed.

Before you begin



233

▪ Open the Job Flow Workspace that holds the jobs with the intended notification. For more

information, see Setting up a Control-M Web Workspace (on page 247).

▪ You must have a job flow with at least two jobs to create a notification.

➢ To create notifications:



2. Click .




5. If you want to create notifications before a job's completion, click next to Notifications before a

job's completion section.

6. If you want to create notifications after a job's completion, click next to Notifications after a

job's completion section.

The Notifications window appears.

7. Select the options, as described in Notifications before job's completion options (on page 234), and

Notifications after job's completion options (on page 235).

The notification is created.


234

Notifications before job's completion options

The following table lists the Notifications before job's completion options:

When Description Control-M rules

Job not submitted by <time> Send the message if the job is

still not submitted and cannot be submitted at the time specified

in the accompanying time field.

Specific time: hh:mm

Job's execution time Send the message if the job’s elapsed runtime is outside a

specified limit. The limit is

specified in the time field. A limit can be expressed as the actual

elapsed minutes of the job run, or as a deviation from the job’s

(statistical) average runtime.

Minutes:

▪ 1-999

▪ z/OS: 0-999

Job not finished by <time> Send the message if the job does not finish executing by the

time specified in the

accompanying time field.

Specific time: hh:mm

Job set to rerun Send the message if the job’s

completion status was set to

Rerun (not valid for SMART

folders).

Destination Logical destination of the

notification message

For destination parameters, see

Destination parameters (on page

227).

Message Text of the notification message. Length:

▪ 1 through 255 characters

▪ z/OS: 1 through 70

characters

Case Sensitive: Yes

Invalid Characters: None

Urgency Urgency of the notification message directed to the Alerts

window. Urgency assigned to

the notification message affects the appearance of the message

in the Alerts window.


235

Notifications after job's completion options

The following table lists the notifications after job's completion options:

When Description Control-M rules

Job ended Not OK Job did not end OK. The job

finished executing with an

unsuccessful operating system completion status or due to a

submission failure (for example,

queue does not exist).

Job ended OK The job finished executing with

a successful operating system

completion status.

Destination Logical destination of the

notification message

For destination parameters, see

Destination parameters (on page

227).

Message Text of the notification message. Length:

▪ 1 through 255 characters

▪ z/OS: 1 through 70

characters

Case Sensitive: Yes

Invalid Characters: None

Urgency Urgency of the notification

message directed to the Alerts window. Urgency assigned to

the notification message affects the appearance of the message

in the Alerts window.

Capturing data from output

This procedure describes how capture data from a job. This enables you to capture data from a job's output, by searching the output of a job for a specific text; words or characters, depending on the capture

criteria you define. The captured data is contained in a Variable that you define before you set the

capture criteria. This allows you to use captured data from one job in another job as a Variable.


236

➢ To capture data from output:

1. From the Control-M Web Workspace, select the job that you want to capture data from its output.

2. In the right pane, click Edit.


4. In the Capture from job output area, click

The Capture from job output into a Variable dialog appears.

5. In the Variable area, define the Variable data by doing the following:

a. In the Variable Name field, type a variable name.

This is the name of the Variable that will contain your captured data, and you can use in another

job.

b. From the Variable Type drop-down list, select a variable type:

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

o Global: Enables you to access the variables by name at the Control-M/Server level, which

can be used by any job.

o Named pool: Organizes variables into groups in a hierarchy. The variable is referenced by

the pool name.

The full Variable name is displayed in the string field.

6. In the Cursor Position area, define where in the output file to begin the capture process by doing

the following:

a. In the Move to the end of the below string field, type the string from where to begin the

capture process in the output file.

b. In the Forward by field select the number of lines to skip from the search string.

c. In the Words/Characters field, select the number of words/characters to skip from the search

string in the output file.

d. From the Delimiter drop-down list, select a delimiter type that is used as a split separator

between words in the job output file.

7. In the Data to Capture area, from the Capture drop-down select the specific data to capture by

selecting one of the following:

• Up to the end of the line: Enables you to capture the whole string

• Number of words/characters: Enables you to capture a specific number of words/characters

in a string. Select the number of words/characters to capture.

The job capture criteria is defined.


237

Capture from output example

This is an example use case of how to use the capture from output feature. If you want to capture data from one job and use it in another job, in this case, you want to capture an item ID from Job 1, and use it

to order the item in Job 2. The captured data from Job 1 is inserted in the Variable,in this case ItemID,

which is then used in Job 2 to order the item.

Here is an example of how to define the Variable and capture criteria:

Now you can use the Variable in Job to order the item by its ID:


238

Ordering jobs and folders

This procedure describes how to order jobs and folders, which enables you to manually order or force

jobs.

➢ Ordering jobs and folders:


• If you want to order the entire Workspace, click Order, and Order Workspace.

• If you want to order selected entities, select the folders/jobs you want to order, click Order, and

Order Selected.

NOTE: You cannot order selected jobs contained in different Sub Folders into a new SMART

Folder. You can order the jobs individually.


239

The order pane appears.

2. Select one or more of the following options:

• Ignore scheduling criteria: Run the jobs and folders regardless of their scheduling criteria.

• Order as independent flow: Orders the flow as a unique flow, in which a unique suffix is added to every condition name. If a flow is ordered more than once, this ensures that the jobs

have the correct dependencies.

• Hold: Hold a job or folder before it starts running. This enables you to customize the jobs/folder

before they actually run.

3. In the Order Date area, from the drop-down select one of the following:

• Current working date: The job is ordered on its current scheduled working date.

• Order now with a different order date: The job runs now, and runs again on the selected order date. To see how to use this option, see Ordering a job now with a different order date

example (on page 239).

• Wait for selected order date to run: The job must wait for the selected ordered date.

4. Add any variables as needed.

5. Click Order.

If the order fails, you can check the errors in the Order Reports panel.

The jobs/folders are ordered. You can check the status and perform additional actions in the

Control-M Web Monitoring Domain (on page 262).

Ordering a job now with a different order date example

This example shows you how to order a job now with a different order date. The scenario in this case is that you have a job that you want to run a year from the current date. However, you would like to run

the job now to ensure that when it does run next year, it will run properly.

1. In the Workspace, select the job you want to order.


240

2. From the ribbon at the top, click Order, and then select Order Selected:


241

3. In the Order Date area, from the Date selection drop-down, select Order now with a different order

date:


242

4. In the Date field, (current year 2018), select 12/24/2019:

5. Click Order.

A confirmation message is displayed that the order completed successfully.


243

6. In the Monitoring domain, you can view the job's status and ensure it ended ok:

7. In the job details you can see that the job's order date is set for 12/24/2019:

244

3 3

Control-M Web Workspaces

A Control-M Web Workspace is a working area that contains your job flows. These job flows are your job processing definitions that include job-specific parameters with information on what to run, where and

how to run it.

After you have completed Setting up a Control-M Web Workspace (on page 247), you can start creating

your job definitions, as described in Creating a new Workspace (on page 248). After you create a new Workspace, you can start creating new folders and jobs , as described in Creating a Sub Folder (on page

25), and Creating a job (on page 26).

You can edit existing folders/jobs, as described in Loading and modifying existing folders/jobs (on page

250). When you select existing folder/jobs, they open in a new Workspace.

Each entity of the Workspace you create is enforced by the Site Standard and User View you apply. For

more information, see Planning domain administrative regulations (on page 22).

You can do the following:

▪ Setting up a Control-M Web Workspace (on page 247): Enables you to create and modify a

Workspace by doing one of the following:

• Add a new Workspace: Create a new Workspace.

• Continue working on a Workspace: Continue working on a Workspace by selecting a

Workspace that you or a colleague previously set up.

• Load folders and jobs: Open existing jobs and folders in a Workspace to modify their content.

• Load from File: Load an XML file of your job definitions.

▪ Submitting a Workspace as a request (on page 257): Enables you to submit a Workspace as a request which contains your job definitions to be reviewed by a scheduler. After the Workspace is submitted,

the scheduler might return the Workspace for more information. You can resubmit the Workspace, until all requirements are met. After the requirements are met, the scheduler adds your job definitions

to the rest of Control-M definitions.

▪ Checking in a Workspace (on page 259): Enables you to check-in a Workspace which allows you to

save your changes directly to the Control-M database.

▪ Deleting a Workspace (on page 261): Enables you to remove a Workspace along with its' job

definitions.

Workspace lifecycle

The following diagram shows the stages of a Workspace lifecycle:


245


246

▪ You can create a new Workspace or open an existing one. For more information, see Setting up a

Control-M Web Workspace (on page 247).

▪ Colleagues can take ownership of the Workspaces you create. For more information, see Taking

ownership of a colleague's Workspace (on page 255).

▪ After creating the Workspace, you can add new jobs/folder, or modify existing ones. For more

information, see Job Definition (on page 23).

▪ You can validate the job definitions within the Workspace to make sure there are no warnings or

errors. For more information, see Validating job definitions in a Workspace (on page 256).

▪ After you complete your definitions and validations, you can either submit the Workspace to the

scheduler, as described in Submitting a Workspace as a request (on page 257), or check-in the

Workspace, as described in Checking in a Workspace (on page 259).

▪ If you submit the Workspace, a scheduler takes ownership of the Workspace you submitted, and

handles it.

▪ If additional modifications are required, the scheduler returns the Workspace to you. You can view

the required modifications in the Notes section of the job properties pane. You can also view changes made to the Workspace, as described in Changes Report (on page 260). You can make the

modifications and resubmit until the Workspace is approved, or check it in yourself.

▪ If there are no additional modifications needed from your end, the scheduler approves the Workspace

and the job definitions are checked in to the Control-M Database.

Note: If Control-M Web is integrated 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 Workspace does not meet the requirement set in the change management

system for submitting a Workspace, you cannot submit the Workspace unless the issue is resolved. For



247

Workspace statuses

The following table lists the Workspace statuses that appear in the Home page:

Status Definition

User Works Indicates that the user is editing the Workspace.

Submitted Indicates that the request is submitted to the scheduler to handle.

The request is in read-only mode, and cannot be modified.

Scheduler Works Indicates that the scheduler is editing the job definitions in the

Workspace.

If the scheduler is working on the Workspace, the Workspace is in

read-only mode. The user cannot modify the Workspace.

Returned Indicates that the Workspace is returned to you by the scheduler.

This usually happens if the scheduler is requesting more

information or modifications to the Workspace.

Approved Indicates that the Workspace does not require any further

modifications and is approved by the scheduler. The Workspace is

now part of Control-M definitions.

The Workspace is in read-only mode, and cannot be modified.

Checked In Indicates that the Workspace is checked-in successfully.

Note: If Control-M Web is integrated 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 Workspace, you cannot submit the Workspace unless the issue is resolved. For


Setting up a Control-M Web Workspace

This procedure describes how to set up a Control-M Web Workspace, which enables you to create a new

Workspace that contains your new/existing job definitions.

➢ To set up a Workspace:

1. From the Home page, click Workspace and do one of the following:

• Select Add new workspace from drop-down to create a new Workspace, and follow the

instructions in Creating a new Workspace (on page 248).

• Click Load from file to load a file that contains existing job definitions, and follow the

instructions in Loading job definitions from file (on page 255).


248

2. Select Folders and Jobs to create a Workspace from existing jobs, and do the following:

a. To filter the existing folders and jobs, follow the instructions in Filtering existing job flows.

b. To select a hierarchy to view the existing folders and jobs, follow the instructions in Changing the

hierarchy for loaded job definitions (on page 250).

c. Select the jobs and folders that appear in the tree view, and click Open. For more information,

see Loading and modifying existing folders/jobs (on page 250).

3. Click My Work, and select a Workspace to continue working on.

4. Click Other Work, and select a colleague's Workspace to view or edit.

If you have the proper authorization, you can take ownership, by clicking Take Ownership, as

described in Taking ownership of a colleague's Workspace (on page 255).

Your Workspace is set up. Follow the instructions according to what you select.

Creating a new Workspace

This procedure describes how to create a new Workspace, which enables you to define new folders and jobs that you can either submit as a request to a Control-M Scheduler or check-in to be part of the

Control-M database.

➢ To create a new Workspace:

1. From the Home page, click Workspace, and then select Add new workspace

The Create New Workspace pane appears on the right.

2. Fill in the required parameters. For more information, see New Workspace parameters (on page 249).

3. Click Create.

The Workspace opens.

A regular or SMART folder is created, depending on what you select in the previous step. Only one

folder can be created.

4. Do one or both of the following:

• To create a new sub-folder, see Creating a Sub Folder (on page 25). Only one folder can be

created.

• To create a new job, see Creating a job (on page 26)



249

New Workspace parameters

The following table lists the parameters when you create a new Workspace:

Parameter Definition

Name Indicates the name of the Workspace.

Description Enables you to add free text details of the Workspace.

Change ID Indicates the change ID that can be associated to the Workspace.

Note: This field might appear as non-editable. If you use an integrated change management system, the Change ID is

automatically created upon submission of the request.

E-mail Notification Address Defines the e-mail address notifications are sent.

If you have set your E-mail address in User preferences (on page

8), it appears by default.

Site Standard Applies the defined Site Standard to the folder and all jobs contained in the folder. For more information, see Planning


Note: If only one Site Standard exits, it is selected by default. If there are no Site Standards defined, it is set to None. If site

standard enforcement is enabled, you must have a Site Standard

assigned.

Business Parameter Defines one or more Business parameters, according to the Site

Standard you have selected. For more information, see Planning


Note: If the Site Standard field is set to None, there are no

Business parameters displayed.

Control-M Defines the name of the Control-M/Server.

Folder Type Defines whether the folder type is a regular folder, or a SMART

folder.

Note: This parameter might not appear, if it was pre-defined in

the Site Standard you select.


250

Loading and modifying existing folders/jobs

This procedure describes how to load and modify existing folders/jobs, which enables you to edit existing

jobs/folder in a new Workspace and/or add jobs/folders to an existing Workspace.

➢ To load and modify existing definitions:

1. From the Home page, click Folders and Jobs.


• Click to filter folders and jobs. Only folders and jobs that match your filtering criteria appear in the

list. For more information, see Filter parameters (on page 252).

• Change the hierarchy of the display of the folders/jobs, as described in Changing the hierarchy for

loaded job definitions (on page 250).

3. Select the Workspace you want to modify, and click Open.

The Workspace opens in read-only mode.


• To modify the Workspace, click Modify, in the message that appears at the top. This enables you

to edit properties of the folders and jobs and overwrite the existing properties. Fill in the required

parameters, for more information, see New Workspace parameters (on page 249).

• To duplicate the Workspace, click Duplicate, in the message that appears at the top. This enables you to create a copy of the folders and jobs. Fill in the required parameters, for more

information, see New Workspace parameters (on page 249).


• Create a new sub-folder, as described in Creating a Sub Folder (on page 25).

You can only create one sub-folder.

• Edit the existing job/folder definitions, as described in Job types (on page 29).

NOTE: You can undo changes to jobs/folder by clicking .

• Add new jobs, as described in Creating a job (on page 26).


Changing the hierarchy for loaded job definitions

This procedure describes how to set the hierarchy for loaded job definitions, which enables you to view

the jobs according to different combinations of Control-M/Server, Application, and Sub Application.

➢ To change the hierarchy for loaded job definitions:

1. From the Home page, click Folders and Jobs.

2. Do the following:

a. In the Show jobs by area, select any combination of Application, Sub Application, and

Control-M/Server as follows:

o Select only Application: The hierarchy is Application>Folder>Control-M/Server


251

o Select only Sub Application: The hierarchy is Sub Application>Folder>Control-M/Server

o Select only Control-M/Server: The hierarchy is Control-M/server> Folder

o Select both Application and Sub Application: The hierarchy is Application>Sub

Application>Folder>Control-M/Server

o Select both Application and Control-M/Server: The hierarchy is Application>

Control-M/Server

o Select both Sub Application and Control-M/Server: The hierarchy is Sub Application>

Control-M/Server

o Clear all: The hierarchy is Folder>Control-M/Server>Job

The jobs and folders in the Workspace are categorized according to the hierarchy combination of

selected and cleared entities. To open and modify the selected entity, see Loading and modifying

existing folders/jobs (on page 250).


252

Filter parameters

The following table describes the filter parameters for opening an existing job flow:


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.

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.

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:




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


Folder Defines the name of the folder that contains the job definitions.

Folder Library (z/OS) Defines the name of the library that contains the job’s

folder.

Member Library (z/OS) Indicates the location of the Member that contains the

JCL, started task procedure, or Warning message.


253


Job Type Defines the type of job that determines which fields are

exposed in a job definition.

User Daily Indicates the name of the User Daily job that is used to order

jobs and folders.

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

computer, or host group where the job is submitted.

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

Run As/Owner Identifies the user name with the authorization to execute the

job.

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.

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.

Shout Destination Defines the destination where the shouts are sent.

Command Line Indicates an operating system command line entry to be

submitted as a job.

Cyclic Indicates that the job must run at a designated time, interval

of time.


254


Calendar Defines the name of a Control-M calendar that was defined in

the Calendar Manager.

Resource Defines the following types of resources:

▪ Control Resource - 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 - Indicates the name and

quantity of Quantitative resources required by the job.

Condition Defines the following types of conditions:

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

Editing a Workspace

This procedure describes how to edit a Workspace, which enables you to modify job/folder definitions or add more definitions to the Workspace. You can edit a Workspace, if it is saved and has not been

submitted to the scheduler, if the Workspace is in a Returned status, or if the Workspace has not been

checked-in.

➢ To edit a Workspace:

1. From the Home page, in the My Work area, select the Workspace you want to edit.

The Workspace opens.

2. Select the job/folder that you want to edit.

The job properties appear in the right pane.

3. Click .

A detailed view of the job properties appears in the right pane.


255


• Edit the existing job/folder definitions. For more information, see Job types (on page 29).




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 a Workspace.

➢ To take ownership of a colleague's Workspace:

1. From the Home page, click Other Work.

2. Click on the Workspace to view it.

The Workspace opens in a read-only mode.

3. Click Take Ownership in the message that appears at the top.

The Workspace is now owned by you, and appears in the My Work area in the Home page. To edit the

Workspace, see Editing a Workspace (on page 254).

Loading job definitions from file This procedure describes how to load existing job definitions from an XML file. The imported job

definitions appear in a Workspace. You can create the following Workspace types:

▪ A new Workspace, by duplicating the imported Workspace. This will create a new Workspace with

suffixes added to the folder names and conditions.

▪ A new Workspace, which is based on the imported job definitions. This will add your job definitions to

a new Workspace without changes to folder names and conditions.

➢ To load job definitions from file:

1. From the Home page, click Workspace, and then select Load from file.

2. Select the XML file you want to load, and click Open.

A message appears displaying the number of folders and jobs that were imported successfully.

3. Click OK.

The job definitions are loaded into a Workspace in read-only mode.


• To duplicate the Workspace, click Duplicate.

Duplicating a Workspace creates the Workspace with revised folder names and condition names.

• To modify the Workspace, click Modify.


256

Modifying a Workspace creates a copy of the existing Workspace. The changes you make

overwrite the existing properties.

Conflicts upon import appear in the right pane. You must resolve all conflicts to be able to continue.

There are cases where conflicts cannot be resolved by you, in this case, you should contact your

Control-M Administrator.

5. Fill in the required parameters. For more information, see New Workspace parameters (on page 249).


• Create new sub-folders and jobs, as described in Creating a Sub Folder (on page 25) and Creating

a job (on page 26).

NOTE: You can only create a sub-folder in a SMART folder.

• Edit the existing job/folder definitions. For more information, see Job types (on page 29).




Validating job definitions in a Workspace

This procedure describes how to validate job definitions in a Workspace, which enables you to validate

your definitions according to the Site Standard you select, or if none, the Control-M rules.

Before you Begin

Ensure that you have completed Setting up a Control-M Web Workspace (on page 247).

➢ To validate a Workspace:

1. In the Workspace, click .

2. The warnings/errors are displayed in the Validation Report in the Results pane, and the problematic

parameters are highlighted in orange/red with a warning/error sign in the job properties pane.

NOTE: Some warnings are indicated with an icon. These types of warnings must be fixed for you

to be able to check-in the Workspace. For more information, see Checking in a Workspace (on page

259).


• Ignore warnings and errors.

• Click on the individual warning, view it in the job properties pane, and fix the problem that

appears in the Description column of the Validation report.

You can now submit the Workspace, as described in Submitting a Workspace as a request (on page

257) or check in the Workspace as described in Checking in a Workspace (on page 259).


257

Submitting a Workspace as a request

This procedure describes how to submit a Workspace as a request to the Control-M Scheduler, which

enables you to submit your definitions to be part of Control-M definitions.

Before you Begin

Ensure that you have completed Job Definition (on page 23).

➢ To submit a Workspace as a request:

1. Open the Workspace you want to submit.

2. (Optional) Click to add a note to the scheduler. For more information, see Notes (on page

258).

3. In the ribbon, click .

If warnings or errors are found, a confirmation message appears.


• If you want to ignore the warning message, click Yes, and the Workspace is submitted.

• If you want to view and fix the warnings, Click No, and view the warnings in the Validation

Report. For more information, see Validating job definitions in a Workspace (on page 256). After

you have completed the validation, you can submit your Workspace.

The Workspace is submitted to the scheduler. After the Workspace is submitted, and is in scheduler

Works status, you cannot modify the Workspace. For more information on the Workspace lifecycle

and statuses, see Control-M Web Workspaces (on page 244).

Note: If Control-M is integrated with a change management system and the Workspace was not approved, you will not be able to submit the Workspace to the Control-M Scheduler. To be able to submit

the Workspace, the issue preventing the approval from the change management system must be

resolved. For more information on resolving the issue, please contact the relevant individual in your

organization.

Handling a returned Workspace The Control-M scheduler can return a Workspace, if more information or modifications are required on

your end. To help you communicate with a scheduler, you can use the following tools:

• Notes (on page 258): Enables you to view notes written to you by the scheduler. In the notes, a

scheduler can indicate why the Workspace is returned, and what is needed from your end.

• Changes Report (on page 260): Enables you to view changes made by the scheduler to the

Workspace.

By using these methods, you can handle the returned Workspace, and understand what actions were

done by the scheduler, and what actions you need to do.


258

Notes

Notes enable you to easily communicate with the Control-M scheduler. You can write any information you

want the scheduler to know, and the scheduler can write any information they want you to know.

You can add notes at two levels:

• Workspace Note: Enables you to add a note to the Workspace, as described in Adding a note to

a Workspace (on page 259).

• 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 259).

You can also view all notes from, as described in Handling notes (on page 258). The notes tab includes

the following:

• Notes by you and the scheduler

• Notes' statuses

• Notes' timestamp

• Notes filter

Handling notes

This procedure describes how to view and handle notes.

Before you begin


➢ To handle notes:

1. In the Workspace, in the bottom pane, click the Notes tab.

The Notes information appears in the bottom pane. The latest note from the scheduler is in bold.

2. From the Show drop-down, you can filter to see the following:

• All: Enables you to view all notes written by you and the scheduler

• Needs attention: Enables you to view notes written by the Control-M Scheduler and need to be

handled by you. A folder/job with a note from the scheduler that needs to be handled by you are

indicated with .

• Draft: Enables you to view notes written by you only.

3. Click on note you want to view.

• If it is a folder/job note, the relevant entity is highlighted in the flow diagram. The note pane on

the right opens, and you can view the note. If it is a note written by you, you can edit the note

details.

• If it is a Workspace note, click . The notes appear on the right pane,

and you view the note. If it is a note written by you can edit the note details.

You can answer the scheduler, as described in Adding a note to a Workspace (on page 259) and Adding a

note to a folder/job (on page 259).


259

Adding a note to a Workspace

This procedure describes how to add a note to a Workspace, which enables you to add any information

you want to the scheduler.

Before you begin


➢ To add a note to a Workspace:

1. In the Workspace, click .

The Workspace notes appear in the right pane.

2. In the text box, type the note you want to add to the Workspace.

3. Click Add.

4. If you want to edit the note text, click .

5. If you want to delete the note, click .

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

Before you begin

Ensure that you have completed Setting up a Control-M Web Workspace (on page 247)

➢ To add a note to a folder/job:

1. In the Workspace, select the folder/job.

The properties pane appears on the right.

2. Click .

3. In the text box, type the note to the scheduler.

4. Click Add.

5. If you want to make changes to the note text, click .

6. If you want to delete the note, click .

Checking in a Workspace

This procedure describes how to check-in a Workspace, which enables you to save your definitions to the

Control-M database.


260

NOTE: This option must be enabled by your Control-M Administrator.

➢ To check in a Workspace:

1. From the Workspace, in the ribbon, click .

A confirmation message appears.

2. Click Yes.

Check-in is in progress. There are three stages of check-in; verifying check-in requirements, check-in

folders, synchronizing folders with the Control-M/Server database. If check-in succeeded for all three

stages, a confirmation message appears indicating that check-in succeeded.

3. Do the following if check-in fails:

• Check-in failed due to validation errors found upon check-in. You must fix those errors and try to

check-in again. Take note that some warnings are mandatory and also must be fixed for check-in.

These types of warnings are indicated by in the Validation panel.

• There is a check-in error due to updating jobs/folders that you are not authorized to change, and

they require a Control-M scheduler's approval. You can view these items in the Authorizations

panel. You can rollback changes and continue check-in or submit the Workspace as a request.

• There is a check-in error due to conflicts found upon check-in. Some of the jobs/folders that you

have modified were modified by another user. you can do one of the following:

o Overwrite all: Overwrite all changes that were made by other users. Take note, this option

is disabled when there are a number of different conflicts that cannot be overwritten at once.

o Cancel and see conflicts: View the conflicts in the conflicts tab in the bottom pane, and

resolve each conflict individually.

• Check-in succeeded with synchronization exceptions due to connection issues, in this case you

can check later if the folders are synchronized or contact your Control-M administrator.

4. Click Close.

Changes Report

Changes made to a Workspace is displayed in the changes report. The changes report helps you to

quickly view all changes made in the Workspace, including the changes made by the scheduler.

You can view the changes report at the bottom pane of the Workspace. The change report is generated each time the Workspace is opened, by clicking on the folder/job entity in the Workspace, or by clicking in

a folder/job parameter. The changes report includes changes made on scheduler's notes and user's notes.

You can rollback changes made to jobs/folders and rollback deleted jobs and sub-folders by clicking

in the changes report.


261

Exporting a Workspace

This procedure describes how to export a Workspace. You can export the file for back up purposes, as

well as to import the file (on page 255) back into the system, to create a duplicate or modified

Workspace.

The export procedure creates an XML file.

Before you begin


➢ To export a Workspace:

1. In the Workspace, in the ribbon, click .

The file is exported in XML format.

Deleting a Workspace

This procedure describes how to delete a Workspace. You can delete a Workspace that is in User Works,

Returned, and Checked-in status, you cannot delete a Workspace that is in Submitted or Scheduler Works

status.

➢ To delete a Workspace:

1. From the Home page, click My Work.

2. Select the Workspace you want to delete.

3. Click .

The Workspace is deleted.

262

4 4

Control-M Web Monitoring Domain

Control-M Web Monitoring domain enables you to monitor the processing of jobs, perform critical user

tasks, handle problems, and solve various issues.

By using Control-M Web Monitoring domain, you can see the progress of your batch flows, and identify problems and potential problems. Batch flows usually exist in a distributed system spanning many

computers of different types. 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.

The Monitoring domain is split according to the following tabs:

▪ Viewpoints: Enables you to view Active Jobs and perform job actions. You can limit the jobs you want to view, which simplifies and significantly reduces processing overhead. For more information

about viewpoints, see Viewpoints (on page 262).

▪ Services: Enables you to do monitor regular services (a group of one or more jobs that are

aggregated based on job filtering criteria, Order date, SMART folder, or a job) and perform job actions. If you have Control-M Batch Impact Manager, you can view and monitor in-depth analysis,

including projections. For more information, see Service management (on page 267).

For a description of the Monitoring domain user interface, see Monitoring domain navigation (on page

12).

Viewpoints

A viewpoint is a customizable, dynamic tool, which enables you to display your jobs and job flows. For

example, you can view and monitor jobs on a particular Control-M/Server, jobs that are for specific user, or those that have a particular status, such as jobs that have a failure status. By limiting those jobs that

you want to view, you can simplify job monitoring and significantly reduce processing overhead. Usually

you want to monitor the exceptions.

Viewpoints are constantly updated and show in real-time, the execution status of the batch production.

NOTE: Viewpoints are can only be viewed by the user that created them and cannot be shared.

You can do the following:


263

▪ Create a viewpoint, as described in Creating a Viewpoint (on page 263).

▪ Create a viewpoint from a particular date, which enables you to review processing data that has been

accumulated over a specific period of time, as described in Creating a historical viewpoint (on page

266).

▪ Edit or Delete the viewpoint, by highlighting the relevant viewpoint and selecting Edit or Delete from

the ribbon. For more information, see Viewpoint navigation (on page 12).

▪ In the ribbon, when clicking on you quickly access saved viewpoints, add a new viewpoint,

search for a job and undertake an archive search.

After you have created a viewpoint, you can do the following:

▪ Analyze active jobs and manage job flows. You can customize viewpoints by selecting Edit

Viewpoint from the ribbon.

▪ View the viewpoint entities in a list or tile view by clicking .

▪ Adjust the zoom level of the viewpoint

▪ View the viewpoint in a hierarchy by clicking .

▪ View the processing details of jobs

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. For information about job details, see Job

details (on page 285). 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.

▪ Perform actions by intervening manually when special critical processes, and potentially problematic

situations arise, as described in Job management (on page 272). If you want to search for a job

without creating a viewpoint, you can search for a job as described in Finding a job (on page 274).

▪ Export jobs in list view to a csv file.

NOTE: You can view the viewpoint in tile or list view, but if you want to export the viewpoint to a csv file,

select the list view and click Export.

In the CCM, the Administrator can set the number of viewpoints that can be created by changing the Maximum viewpoints a user can define parameter. If you exceed the limit, the oldest saved

viewpoint is deleted. For more information about Control-M Web system parameters, see Control-M Web

parameters.

Creating a Viewpoint

This procedure describes how to create a Viewpoint in the Monitoring domain, which enables you filter the

jobs and the hierarchy that is used to display those jobs.

➢ To create a Viewpoint:

1. From the Monitoring domain, in the Viewpoints tab, click Add Viewpoint.

A Viewpoint dialog box appears.


264

NOTE: By default, some fields are already added to the Viewpoint.

2. If you want to edit the filters do the following:

a. Click Add/remove fields.

The Add Fields section appears on the right hand side of the window.

b. Select the fields as required as described in Viewpoint Fields (on page 265).

c. Click Done.

3. To edit/view the entities hierarchy do the following:

a. Click Grouped by to expand the hierarchical levels.

NOTE: By default, the hierarchy is set for Control-M/Server, Application and Sub-Application.

b. Add hierarchy levels by clicking Add Level and then selecting one of the options from the drop

down list.

NOTE: You can delete any level by hovering over the relevant field and clicking x.

4. Click Open.

The Viewpoint is created.

NOTE: You can refine the viewpoint definition at any time, by clicking Edit Viewpoint.

5. To save the viewpoint, click Save Viewpoint.

6. From the dialog box, type the name and description of the viewpoint and click Save.

7. To change the job status, check for problems, edit the job, and perform various job actions, see Job

management (on page 272).


265

Viewpoint Fields

The following table describes the viewpoint fields when creating or editing a viewpoint. For more

information about the fields, see Job Definition (on page 23).

Field Description

Folder Name Defines the name of the folder.

Application Defines the logical name for sorting groups of jobs.

Sub Application Defines the name of the Sub Application where the job belongs

logically.

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

that processes the job.

Folder library (z/OS jobs only) Defines the name of the library that contains the

job’s folder.

Job name Defines the name of the job processing definition.

Description Identifies a description of the job.

Job type Defines the type of job, such as an OS job, SAP job, etc

Run as Identifies the user name who is authorized to execute the job.

File name/Member name Indicates the name of a member that contains one of the





File path/Member library Indicates the location of the file that contains the script.

Host Defines the computer that can run jobs.

Host Group Defines a collection of host computers which enable you to define

and run jobs on any of the computers within the host group.

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

which ensures resources allocation order.

Cyclic Indicates that the job must run at a designated time, interval of

time.


266

Field Description

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

Include in a BIM Service Includes jobs that belong to a service.

Rule-Based Calendar Defines a predefined calendar based on specific rules,

independent of specific years.

Workload policy Defines the name of the Workload policy, which controls, manages, and balances the workload on Control-M resources and

hosts.

Job status Determines whether to search for jobs that Ended OK, Not OK, or

both.

Order date Shows the date that the job was ordered.

Execution time Shows the number of seconds that it takes to run the job.

Order ID Shows the Order ID number.

Folder Held Determines which folder is in a hold status.

Held Determines which job is in a hold status.

Include deleted jobs Shows deleted jobs in the viewpoint.

Quantitative resources Specifies the resource in the Control-M and, for each job, the

quantity required/used by that job.

Control resources Specifies whether the job requires exclusive or shared access to a

physical resource, such as tape drive.

In Condition name Specifies the name of the In Condition.

In Condition date Shows the date of the In Condition in mmdd format.

Out Condition name Specifies the name of the Out Condition.

Out Condition date Show the date of the Out Condition in mmdd format.

Creating a historical viewpoint This procedure describes how to view a viewpoint from an earlier date, which enables you to access job

processing data that has been accumulated up to a period of time.


267

➢ To view the history of viewpoints:

1. From the Viewpoints tab, select the viewpoint that you want to view.

2. Click History.

A dialog box appears.

3. From the dropdown list select the relevant Control-M Server.

4. In the date section, click the date you want to search.

The viewpoint appears. For more information about the viewpoint fields, see Viewpoint Fields (on

page 265).

NOTE: You can edit the viewpoint fields by clicking Edit Viewpoint.

5. If you want to view the job status and check for problems, select any job. For more information, see

Job management (on page 272).

Chapter

Service management

The Monitoring domain enables you to view the status of your services, check for problems, and perform

various service actions.

The following procedures describe how to filter, hold, release, view history, and order services:

▪ Finding services (on page 267): Describes how to filter and find services, which enables you to see

the status of specific services.

▪ Holding a service (on page 268): Describes how to hold a service, which stops the service from

Control-M processing and enables you to fix any problems that might have occurred hold a job.

▪ Releasing a service (on page 268): Describes how to release a service from a Hold state, which

enables the service to run.

▪ Viewing the history of services (on page 268): Describes how to view the history of services, which

enables you to see the status and service details of specific services from a previous date.

▪ Ordering a service (on page 268): Describes how to order a service, which enables you to run all the

jobs within the service.

Finding services

This procedure describes how to find services, which enables you to see the status of specific services.

➢ To find services:

1. From the Filter drop-down list, in the Search field, type the name or part of the name of the

service(s) that you want to find.

2. If you want to filter by status, select the relevant status.

The services that match the filtered criteria appear.


268

3. To view the service details, click one of the tabs in the right pane, as described in Service details (on

page 270).

4. To view all services, delete the filters.

Holding a service This procedure describes how to hold a service, which stops the service from Control-M processing and

enables you to fix any problems that might have occurred.

NOTE: You cannot hold a BMC Batch Impact Manager service or any service that is not based on a job or

a SMART folder. For more information, contact your Control-M Administrator.

➢ To hold a service:

1. Select a service that you want to hold.

2. From the Actions drop-down list, select Hold.

The services are automatically refreshed at defined intervals.

A Hold icon appears on the service and is no longer running.

Releasing a service

This procedure describes how to release a service from a Hold state, which enables the service to run.

NOTE: You cannot release a service that is not based on a job or a SMART folder. For more information,

contact your Control-M Administrator.

➢ To release a service:

1. Select a held service that you want to release.

2. From Actions drop-down list, select Release.

The services are automatically refreshed at defined intervals.

The Hold icon disappears from the service and the service is now available to continue running.

Viewing the history of services This procedure describes how to view the history of services, which enables you to see the status and

service details of specific services from a previous date.

➢ To view the history of services:

▪ From the Today drop-down list, select a date that you want to view.

The services that match your criteria appear.

Ordering a service

This procedure describes how to order a service, which enables you to run all the jobs within the service.


269

➢ To order a service:

1. Click Order Service.

The Order Service window appears.

2. Select the service in the left pane.

NOTE: You can search for a service by typing in its name in the search field above the list.

3. (Optional) Select the Order as independent flow check box, which determines if a flow in a folder

is ordered uniquely.

NOTE: This check box is only enabled if you are ordering a single folder (a SMART folder service)

created in version 8.0.00 and above. If the check box does not appear, you need to change the DisplayOrderAsIndependentflow field in the Control-M Configuration Manager. For more

information, see Defining Control-M Self Service parameters.

4. For each parameter, type in or select a value.

5. If you want to order another service without reopening the Service Ordering window, click Order

and Keep Open.

6. Click Order

The new service appears regardless of search or filtering criteria, and remains until replaced with the

scheduled service.

Updating a BIM service deadline

This procedure describes how to update a BIM service deadline.

➢ To update a BIM service deadline:

1. Select a BIM service that you want to update its deadline.

2. From Actions drop-down list, select Update Deadline.

The Update Deadline window appears.

3. Update the date and time and click Save.

The deadline is updated.


270

Service details

The following table describes the details of each service tab.

Tab Description

Summary Shows details such as, start and end time, progress, number of jobs in the service, number of jobs completed, order ID,

and description of the selected service, as described in

Service Summary tab (on page 271).

Errors Shows error messages of the selected service.

Parameters Shows the defined parameters and values of the selected

service.

Log Shows the activity log of the selected service, as described

in Service Log tab (on page 272)

Tickets Shows the list of Control-M/EM, SIM, or Remedy tickets that

are opened due to an issue with a BIM service.


271

Service Summary tab

The following table describes the basic parameters for the selected service.


Status Shows one of the following possible statuses:

▪ Executing

▪ Wait Condition

▪ Wait Resource

▪ Wait User

▪ Unknown

▪ Ended OK

▪ Failure

Start Shows the timestamp when the service started to run.

End Shows the timestamp when the service stopped running.

Progress Shows the execution progress of the jobs in the selected

service

Deadline Shows the time when a Batch Impact Manager service must

complete to not be considered late (Batch Impact Manager services only).

Slack Time Defines the amount of time that a job within BIM service can

be delayed without causing another job to be delayed or

impacting the completion time of the BIM service

Avg Completion Time Defines the average completion time for a job in the service.

By Shows the name of the person who ordered the service.

ID Shows the Order ID number.

Date Shows the Order date and the time the service was ordered

Priority Shows the priority level of the service (Batch Impact Manager services only).


272

Service Log tab

The following table describes the activity parameters of the service.


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

Job management

The following table describes the job options, such as viewing the job status, checking for problems, and

performing various job actions in the Service and Viewpoint tabs in the Monitoring domain.


273

NOTE: If you want to enable Audit Annotations on each job action, contact your Control-M Administrator.

Job Action Description

Finding a job (on page 274) Enables you to search for a job.

NOTE: You can also find a job by clicking and selecting

Job Search.

Finding a job within a service or

viewpoint (on page 274)

Enables you search for a job in a viewpoint or service.

Hold (on page 274) Describes how to hold a job, which stops the job from Control-M

processing and enables you to update the job.

Release (on page 275) Describes how to release a job from a Hold state, which enables

the job to run

Rerun (on page 275) Describes how to rerun a job.

Confirm (on page 275) Describes how to confirm a job, which enables the job to continue

running that is waiting for a user confirmation.

Restart (on page 276) Describes how to re-run a Control-M for z/OS job from a specific

state

Set to OK (on page 278) Describes how to set a job to end OK, which overrides any defined scheduling criteria and sends the job to the active job

environment

Kill (on page 278) Describes how to terminate a job, which cancels a job from

running in the middle of the execution.

Run Now (on page 277) Describes how to order a job, which runs the job and overrides

the submission criteria.

Update (on page 278) Describes how to update job properties.

Archive Search (on page 279) Describes how to search for job log and output archived data

stored in the Control-M Workload Archiving Server.

Finding neighborhood jobs (on

page 284)

Describes how to find jobs that are in the neighborhood of the

selected job.


274

Finding a job

This procedure describes how to search for jobs. If you know the viewpoint or service which contains the

job that you want to search, see Finding a job within a service or viewpoint (on page 274).

➢ To find jobs:

1. In the Services or Viewpoint tab, click Job Search.

(Services tab only) The Job search tab appears.

2. If you want to search by name of the Control-M/Server and/or change the date of the search, from

the Today dropdown list, select the Control-M environment and/or the relevant date.

3. In the search field, type the name of the job, file name, or the job order ID.

4. Click .

You can see a list of jobs that have been found. Additional properties are displayed in the right pane.

5. (Optional) You can edit the columns by clicking .

6. If you want to filter the results by Control-M/Server and/or date, repeat step 2.

7. If you want to perform job actions, highlight the job, and from the Actions dropdown list, select the

relevant job action, as described in Job management (on page 272).

Finding a job within a service or viewpoint

This procedure describes how to search for jobs within a service or viewpoint.

➢ To find jobs:

1. Do one of the following

• In the Services tab open the service that contains the job that you want to search.

• In the Viewpoint tab, open the viewpoint that contains the job that you want to search.

2. Click Find a job.

3. In the search field, type the name of the job, file name, or the job order ID.

You can see a list of jobs that have been found. Additional properties are displayed in the right pane.

4. If you want to perform job actions, in the Actions dropdown list and select the relevant job option, as

described in Job management (on page 272).

Holding a job

This procedure describes how to hold a job in the Viewpoint and Services tab, 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 Actions drop-down list, select Hold.


275

A confirmation message appears. The job is on hold and you can now update the job.

NOTE: Viewpoints and services are automatically refreshed at defined intervals.

3. To view the job details, click one of the tabs in the right pane, as described in Job details (on page

285).

Releasing a job

This procedure describes how to release a job from a Hold state in the Viewpoint and Services tab in the

Monitoring domain, which enables the job to run.

➢ To release a job:

1. Select the job you want to release.

2. From the Actions drop-down list, select Release.

A confirmation message appears. The job is released and can now continue processing according to

its definition.



285).

Rerunning a job This procedure describes how to run a job again in the Viewpoint and Services tab in the Monitoring

domain.

➢ To rerun a job:

1. Select a job that has finished running that you want to re-run.

2. From the Actions drop-down list, select Rerun.

A confirmation messages appears and the job executes.



285).

Confirming a job This procedure describes how to confirm a job that is waiting for user confirmation, which enables the job

to continue running.

NOTE: If the job is not defined to request user confirmation, you do not need to do this procedure.

➢ To confirm a job:

1. Select a job with a Wait User status that you want to confirm.

2. From the Actions drop-down list, select Confirm.

A confirmation message appears.


276

3. Click Yes.

The job is confirmed and continues to execute.



285).

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 Actions drop-down list, select Restart.

The Restart job dialog box appears.

3. For each field, type or select the required value, as described in Restart job parameters (on page

277).

4. Click Restart.

The Control-M/for z/OS job restarts. The viewpoints and services are automatically refreshed at

defined intervals.


285).


277

Restart job parameters

The following table describes Restart job parameters for Control-M for z/OS jobs. To define Restart job

parameters, see Restarting a job (on page 276).

Field Description

From Step/Proc Determines the job restart point of the pgmstep and

procstep steps.

To Step/Proc Determines the job restart end point of the pgmstep and

procstep steps.

If a from step/proc value is defined, and the To step/proc field is blank, the job reruns up to and including

the last step.

Recapture Abend Codes Determines whether to save the Abend codes from the

original job execution

Recapture Cond Codes Determines whether to save the condition codes from the

original job execution

Step Adjustment Determines whether to enable automatic Step Adjustment. For more details about Step Adjustment, see the Control-M/Restart User Guide.

Restart Parm Member Name Defines the name of the member that contains control parameters for the job to restart (1-8 characters only). The

default value is the member that contains the JCL of the job.

Running a job now

This procedure describes how to run a job immediately in the Viewpoints and Services tab, which enables

you to override all prerequisites of the job and overrides the submission criteria.

➢ To run a job now:

1. Select the job you want to run.

2. From the Actions drop-down list, select Run Now.

A confirmation messages appears. The job runs overriding any submission criteria.



285).


278

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 to OK.

2. From the Actions drop-down list, select Set to OK.

A confirmation appears and the job ends OK.

NOTE: Viewpoints and Services are automatically refreshed the jobs at defined intervals.


285).

Terminating a job

This procedure describes how to terminate a job, which cancels a job from running in the middle of the

execution.

➢ To terminate a job:

1. Select the job you want to terminate.

2. From the Actions drop-down list, select Kill.

The job is terminated and no longer continues to run.

NOTE: Viewpoints and Services are automatically refreshed at defined intervals.


285).

Updating a job

This procedure describes how to update job properties in the Viewpoints and Services tab.

➢ To update a job:

1. Select the command line job you want to update.

2. From the Actions drop-down list, select Update.

The Update job dialog box appears.

3. For each field, type the required value, as described in Update job parameters (on page 279).

4. Click Save.


285).


279

Update job parameters

The following table describes update job parameters. To define the update job parameters, see Updating

a job (on page 278).


Command Defines the command that the job uses to run

NOTE: This field is only enabled when the job task type is

command.

Submit period Determines the start and end time for the job to run

Time zone Determines the time zone to determine when to run the job

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 from the Services and Viewpoints tabs.

NOTE: You can also search for archive data by clicking and selecting Archive Search.

➢ To search for archive data:


• (Services tab only) To search for archive data from multiple jobs, click Archive Search.

The Archive Search tab appears.

• To search for archive data from a single job, select the job that you want to search, and

right-click Archive Search.

The Archive Search tab appears.


• 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. 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:


280

d. Click Advanced.

The Advanced Search window opens.

e. For each field, type the required value, as described in Advanced Search parameters (on page

281).

NOTE: You can use * and ? wild characters.

f. Click Search.

The archived jobs appear.


281

Advanced Search parameters

The following table describes Advanced Search parameters when Searching for archive data (on page

279).


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:

▪ Last Week

▪ Last Month

▪ Last Year

▪ No time limits

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


282


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





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


Belongs to Defines the name of a Control-M/Agent computer, remote host


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.


283

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. Perform a search, as described in Searching for archive data (on page 279).

2. Click Duplicate tab.

The duplicated archive search results appear in another tab.

Comparing archived data

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. Perform a search, as described in Searching for archive data.

2. Select two jobs that you want to compare.

3. From the Compare drop-down list, select one of the following:

• Log

• Output

The Compare window appears highlighting the differences between the two jobs.

Saving archive data

This procedure describes how to save job log and output archived data to a text file.

➢ To save archive data:

1. Perform a search, as described in Searching for archive data.

2. In the Properties pane, click the Log or Output tab and then click Save.

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

Searching for a file transfer This procedure describes how to search for a file that was transferred with Control-M MFT and view its job

properties and transfer status.

➢ To search for a file transfer:

1. Click Managed File Transfer.

2. In the Search field, type the filename, application, or job name.

NOTE: The asterisk character is not supported. If you use it, search results will not appear.


284

3. Click .

The search results appear. The yellow bar indicates the search parameters, the number of results

found, and the time the search occurred. You can view the transfer details in the General and Job

Output tabs in the right pane.

NOTE: The data does not refresh automatically. To view the latest status, perform the search again.


• To filter and sort each column, click the column header and select the required values.

• To see more search details, do the following:

a. In the top right hand corner of the search results, click Show Column Chooser.

b. Drag and drop the columns you want to see in the search results from the Available

Columns to Visible Columns.

c. Group the search results by dragging and dropping the columns into the Group by area.

• To locate the job of each file transfer, in the General tab, click the job name.

A neighborhood tab appears that shows the context of the job. This enables you to perform

actions on the job, such as rerunning the job or viewing the output or log.

Finding neighborhood jobs This procedure describes how to find the jobs that 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 and/or Service with the search results.

➢ To find neighborhood jobs:

1. Select the job where you want to search for neighboring jobs.

2. From the Actions drop-down list, select Neighborhood.

The Open neighborhood window appears.

3. Set the Direction and Radius fields as described in Neighborhood search fields (on page 285).

4. Click OK.

5. The results of the search appear in the Neighborhood results tab.


285

Neighborhood search fields

The following table describes the Neighborhood search fields:

Neighborhood Description

Directions Defines the relationship of the search jobs to the selected jobs.

▪ Successor: Defines the jobs that are dependent on the

selected job (below the job).

▪ Predecessor and Successor: 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).

▪ All connections: 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 details

The following table describes the job details of each tab.


286

For information about SMART Folder Settings, see SMART folder parameters (on page 176).

Tab Description

Summary Shows fields such as, start time and end time, order ID, order date, status, attributes of the selected job, as

described in Job Summary tab (on page 288).

Job Settings Enables you to view the job properties, as described in Job

Definition (on page 23).

Log Shows the activity log of the selected job.

Waiting Info Shows the reasons why the job did not run.

Output Shows the different outputs of the selected job. To view, see

Viewing job output (on page 290).

Statistics Shows the statistics of the selected job, as described in

Statistics tab (on page 291).

Script Shows the script of the selected job. In the Script tab, you

can search for a specific word in the Find field.

Application Plug-in Shows the fields and values of the specific Application Plug

in.

NOTE: Some Application Plug-ins (such as PeopleSoft) allow

you to refresh, pause, restart and delete a process.

Documentation Shows a description related to the job, and is saved in a defined location. The Documentation area 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.

Services Shows the following:

▪ The service these jobs belong to

▪ The service that this job is dependent upon

▪ The services that depend on this job


287

Tab Description

BIM Shows the following Batch Impact Manager parameters:

▪ Service Name: Defines the logical name from a user or

business perspective.

▪ Service Must Complete At: Defines the time the critical service must be completed to be considered on

time.

▪ Server Priority: Defines the priority level of this

service, from a user or business perspective.


288

Job Summary tab

The following table describes the basic parameters for the selected job.


Run As Shows the name of a user with authorized to run the job.

Run Where Shows the host ID and host group of the job.

Status Shows one of the following possible statuses:

▪ Failure/Error

▪ Ended OK

▪ Executing

▪ Unknown

▪ Wait Condition

▪ Wait Resource

▪ Wait User

Start Shows the timestamp when the job started to run.

If BIM is installed, and the job has not run yet, this

parameter display an estimation of when the job run starts. For more information, see Run time estimations (on page

289).

End Shows the timestamp when the job stopped running.

If BIM is installed, and the job has not run yet, this

parameter display an estimation of when the job run ends.

For more information, see Run time estimations (on page

289).

Execution Times Shows the estimated future run time for a cyclic job if BIM is

installed.

Submission Window Shows the span of time when the job is allowed to run.

Execution Time Shows the number of seconds that it takes to run the job.

Order ID Shows the Order ID number.

Order Date Shows the date that the job was ordered.

Description Shows a description of the job.


289


Job Type Shows one of the following possible job types:

▪ OS

▪ z/OS

▪ BIM

▪ Applications (SAP, Oracle E-Business Suite, AFT,

Databases, Web Services, Java and Messaging,

PeopleSoft)

Sub Application Shows the Sub Application that the job is associated with at

the third level in the node hierarchy in the Control-M

environment.

Application Shows the application that the job is associated with at the

second level in the node hierarchy in the Control-M

environment.

Parent Folder Shows the folder container that the job is associated with at

the fourth level in the node hierarchy in the Control-M

environment.

Execution Timezone Shows the time zone according to the job's schedule.

Cyclic Shows whether the job runs at defined cyclic intervals.

Rerun Every Shows the time to wait between reruns of a job or between

cyclic runs of a job.

Run time estimations

When Batch Impact Manager (BIM) is installed on your system, you can view run time estimations for all jobs, not only jobs in a BIM service. BIM uses average run time statistics to calculate the run time

estimation.

The information is displayed in the job in italics. It is important to note, the information in italics is an

estimation, and not actual run times. For example:


290

In the Planning domain, the information is also displayed in the Job Properties pane, under the General

tab, in the Start and End fields.

NOTE: In the Monitoring domain, this information appears in the Summary tab. You can view Service

details and Server Priority in the BIM tab, as described in Job details (on page 285).

If BIM is unable to calculate the run time estimations, an icon is displayed indicating that statistics are not

available.

If a job is a cyclic job, future run times are calculated by BIM and displayed in the Execution Times

field.

Viewing job output

This procedure describes how to view output of a job, which enables you to review the actions of a job to

determine if and where the job did not process correctly.

➢ To view job output:

1. Select a job and click the Output tab.

2. From the drop-down list, select the output file you want to view.


• To view the latest version of the output, from the dropdown list select the latest output.

• To view specific characters or words in the output, in the Find field, type the words or characters

that you want to view.

• To view job output in a separate window, click .

4. For z/OS jobs only, to view the output in Control-D/WebAccess Server click .

NOTE: Access to Control-D/Web Access Server needs to be enabled. For more information, see

Enabling Control-D/WebAccess Server output in Control-M Web in Control-M Administration.

Control-M/WebAccess Server Report List window appears. For more information about the Reports

List window see Reports Location in the Control-D/WebAccess Administrator guide.


291

Statistics tab

The following table describes the start time, end time, and projection parameters for the selected job.


Start Time Shows the start time of the job

End Time Shows the end time of the job

Projection Shows the estimated start and end time of the job

Control-M Web Tools domain

The tools domain includes the following:

• Site Standards: Enables you to create your own standards and rules for Control-M entities that

comply with your organizational standards and needs. For more information, see Site Standard

Management (on page 293).

• User Views: Enables you to customize the view of the Control-M Web domains and their entities.

For more information, see User Views management (on page 291).

User Views management

The User Views tool (previously known as Site Customizations) enables you to customize the Control-M Web interface. In your organization, different users use Control-M Web to perform different tasks. For

example, a business user usually reviews services and also uses the MFT domain, but does not use the remaining domains. In this case, you can customize the view for a business user, and have only the

relevant domains and their entities visible.

You can create several User Views, and each web user sets the relevant User View in their specific user

preferences options.

The User Views tool enables you to do the following:

▪ Domains: Select which domains are visible/not visible, and different options of each domain.

▪ Simplify job properties: Define which fields a Control-M 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 Control-M Web

Workspace. For example, if you do not want web users to modify job definitions for job type File

Transfer, you can disable it in the User Views tool. The web user cannot create this form of job.

There are several sample User View profiles included in Control-M Web. You can use the already created profiles as is, or you can edit them to suit your needs. A Full View profile is also included as a default, and

you cannot edit or delete this User View.


292

The following procedures describe how to create, edit, duplicate, and delete a User View:

▪ Creating a User View (on page 292)

▪ Editing a User View (on page 292)

▪ Duplicating a User View (on page 293)

▪ Deleting a User View (on page 293)

Creating a User View This procedure describes how to create a User View, which enables you to simplify job properties, and

restrict creation of job types.

➢ To create a User View:

1. From the Tools drop-down menu, select User Views.

The User Views tab appears.

2. From the ribbon, click Add User View.

The Create New User View pane appears on the right.

3. In the Name field, type a name for the new User View.

4. Click Next.

The User View is divided into domains. All domains are visible by default.

5. Do one or all of the following:

• To turn off the visibility of a domain, uncheck the check box next to the domain name.

• To display the list of options and tabs, click each domain, and uncheck the options you want to

hide.

NOTE: There are no options in the MFT domain, this option will be available in a later release.

6. Click Save.

The User View is created.

Editing a User View

This procedure describes how to edit a User View, which enables you to modify the details of the User View. There might be active job flows using the User View you want to edit. The changes take effect after

user logs into Control-M Web.

➢ To edit a User View:




293

2. Select the User View you want to edit.

The User View pane appears on the right.

3. Edit the details of the User View according to your needs. For more information, see Creating a User

View (on page 292).

4. Click Save.

The User View is modified with the new changes.

Duplicating a User View

This procedure describes how to duplicate a User View, which enables you to make a copy of an existing

User View and edit its contents and save it as a new User View.

➢ To duplicate a User View:



2. Select the User View you want to duplicate.

3. From the ribbon, click Duplicate.

4. Type a new name for the User View.

You can edit the User View. For more information, see Creating a User View (on page 292).

Deleting a User View

This procedure describes how to delete a User View. There might be active job flows using the User View you want to delete. If you delete a User View that is in use, the Full View user profile is applied in its

place.

➢ To delete a User View:



2. Select the User View you want to delete.

3. From the ribbon, click Delete.

A message appears. IF you are sure you want to delete the User View, click Delete.

The User View is deleted.

Site Standard Management

The Site standard tool enables you to create standards and rules for Control-M entities that are applicable

to your organization. These rules and standards force users to define Control-M job properties according

to the rules you set in the Site Standard.


294

These standards are applied at the folder level, to new and existing folders. All jobs, new or old, have to

comply with the Site standard rules. You can create multiple Site Standards.

The Site standard tool consists of the following parts:

▪ Site Standards rules (on page 295): Defines rules and restrictions for specific Control-M folder/job

parameters.

▪ Business Parameters (on page 300): Defines parameters specific to your business, that carry a special

business meaning.

▪ Internal Rules (on page 301): Defines rules that can be reused as rules in Control-M folder/job

parameters and business parameters.

▪ Must Have Rules: Defines rules for multi-option parameters. The rule is enforced as required.

▪ Rule conditions (on page 302): Defines specific conditions in a rule, that must be met before a rule is

applied on the Job Attribute.

▪ Condition Format: Defines the condition name format that is valid when users link between jobs in the

Planning domain. The format you set is the default format. The Site Standard rule overrides the

preferences defined in the File Options of the Planning Domain.

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.

The following procedures describe how to create, edit, duplicate, and delete a Site standard:

▪ Creating a Site Standard (on page 294)

▪ Editing a Site Standard (on page 327)

▪ Duplicating a Site Standard (on page 328)

▪ Deleting a Site Standard (on page 328)

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 drop-down menu, select Site Standards.

The Site Standards tab appears

2. From the ribbon, click .

The Create New Site Standard pane appears on the right.

3. In the Name field, type a name for the new Site Standard.

4. Click Create.

5. Do one or all of the following:


295

• Create Site Standards rules (on page 295), as described in Creating Site Standard regular rules

(on page 296).

• Create Business Parameters (on page 300), as described in Creating Business Parameters (on

page 301).

• Create Internal Rules (on page 301), as described in Creating Internal Rules (on page 302).

• Create Must Have Rules , as described in Creating a Must Have Rule (on page 296).

• Create Condition Format, as described in Creating a Condition Format.

The Site standard is created.

Site Standards rules

In the Site Standard tool, you can specify restrictions and rules for Control-M folder/job parameters.

There are two types of rules that you can create:

▪ Regular rule: Creates a rule for a specific job attribute with format restrictions. If the user chooses

to define the job attribute, he/she has to adhere to the restrictions you set. However, the definition of

the job attribute is not enforced, a user does not have to define the job attribute in the Workspace.

For more information, see Creating Site Standard regular rules (on page 296).

▪ Must have rule: Creates a rule for a job attribute that contains sub-parameters and sub-options,

and you can create format restrictions for each/all of the sub-options. The user has to define the specific job attribute and the options you created restrictions for. The definition is enforced in the Site

Standard, and the user is not able to check-in the Workspace if the job attribute and the relevant

options are not defined.

For more information, see Creating a Must Have Rule (on page 296), Must Have Rule example 1 (on

page 297), and Conditional Must Have Rule example (on page 299).

The folder/job rule consists of the following parts:

▪ Rule Prerequisites: Defines which job type the rule applies to, and rule conditions. For more

information on rule conditions, see Rule conditions (on page 302).

▪ Job Attribute: Defines which job/folder parameter the rule applies to. For some job attributes, you

can also add a job attribute condition, as described in Job Attribute Condition (on page 310).

▪ Rule Format: Defines the rule values, and what is included and excluded in the rule. You can set a default value, or possible values, or allow certain characters, as described in Site Standards rules

editor parameters (on page 314).

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.

After the rules are defined in the Site Standard, and the Site Standard is assigned to the folder, the rules

are applied. The Control-M Web user modifying the folder with that Site Standard will have to comply with the rules you defined. If they do not comply with the rules, a warning/error appears. A user is not able to

check-in the Workspace unless those errors are fixed.


296

Creating Site Standard regular rules This procedure describes how to create a Site Standard regular rule, which enables you set rules and

restrictions to specific Control-M folder/job parameters.

➢ To create Site Standard rules:

1. In the Site standard, select Add Rule.

The Create New Rule pane appears on the right.

2. From the Rule Prerequisites tab, select a job type on which to apply the rule.

You can also add a Rule Condition, for more information, see Rule conditions (on page 302).

3. From the Job Attributes tab, select which parameter this rule is applied on.

You can also add an Attribute Condition, for more information, see Job Attribute Condition (on page

310).

4. From the Rule Format, depending on the Job Attribute you chose, you can set the restrictions on

any or all of the options contained in the Job Attribute. For more information on the restrictions, see

Site Standards rules editor parameters (on page 314).

5. Select Required, if you want to enforce the definition of the parameter in the Job Properties. This

ensure that a user cannot check in a Workspace without defining the parameter.

Creating a Must Have Rule This procedure describes how to create a Must Have Rule, which enables to create rule restrictions for a

parameter with multi-options, and enforce those parameters and rules in the Site Standard.

➢ To create a Must Have Rule:

1. In the Site Standard, from the ribbon, select Rule.

The Create New Rule pane appears.

2. From the Rule Prerequisites tab, select a job type on which to apply the rule.

You can also add a Rule Condition, for more information, see Rule conditions (on page 302).

3. From the Job Attributes tab, select which parameter this rule is applied on.

If the parameter is a multi-option field, a drop-down appears.

4. From the drop-down list, select Attributes must be defined. This option defines your rule as a Must

Have Rule.

5. From the Rule Format, depending on the Job Attribute you chose, a list of the Job Attribute's multi options is displayed. You can set the restrictions on any or all of the options contained in the Job

Attribute. For more information on the restrictions, see Site Standards rules editor parameters (on

page 314).


297

Must Have Rule example 1

This example shows you how to create a Must Have Rule for a Quantitative Resource with name INIT and a value of 1. The Must Have Rule is contained in the Site Standard, and if a user applies the Site

Standard, the Must Have Rule is enforced, and the user has to include the relevant rule in his/her job definition. If the job definition does not include the defined rule, in this case, the Quantitative Resource

with name INIT and value 1, the user receives validation errors and is not able to check in the

Workspace.

1. In the Site Standard, select Rule:

2. In the Rule Prerequisites tab, select All job types:

3. In the Job Attribute tab, select Prerequisites, and then Quantitative Resources. From the

Restriction type drop-down, select Attributes must be defined:

4. In the Rule Format tab do the following:


298

a. Select Name -->Include-->Pattern-->Fixed Text with value INIT

b. In the Quantity field, type 1.


299

Conditional Must Have Rule example

This example shows you how to create a conditional Must Have Rule. In this case, we want to create a

rule that if a job is cyclic, you must have an On-Do action that is On: Any, Do: Stop cyclic.

The user has to define the On-Do action, if he/she defined a job as cyclic. If the On-Do statement is not

defined, the user receives validation errors and is not able to check-in the Workspace.



300

2. In the Rule Prerequisites tab, select All job types, and add the following Rule Condition:

3. In the Job Attribute tab, select Actions-->On-Do Actions--> On Statement: Any-->Do Action:

Stop Cyclic run

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.


301

EXAMPLE:

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 314). 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.

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 Web user 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. A user is not able to check in the Workspace unless those errors are fixed.

For more information on how to define Business parameters, see Creating Business Parameters (on page

301).

Creating Business Parameters

This procedure describes how to create a Business Parameter rule.

For more information on Business Parameters functionality, see Business parameters.

➢ To create business parameters:

1. In the Site standard, from the ribbon, select Business Parameters.

The Business Parameters pane appears on the right.

2. Click .

3. In the Name field, type a name for the Business Parameter. Select a name that has a business value

to your organization.

4. If you want this parameter as a required field, check the Make this a required field check box.

5. Define the rules, as described in Site Standards rules editor parameters (on page 314).

The Business Parameter rules are created.

Internal Rules

In the Site Standard tool, you can create internal rules that can be used in Folder/job parameters and Business parameters. 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 restrictions, as described in Site Standards rules editor parameters (on page 314).

Now, you can reuse the internal rule in each folder/job parameter rule you create.


302

After this rule is defined in the Site standard, and the Site standard is assigned to the folder, the rule is

applied. The web user 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. A user is not able to check-in the

Workspace unless those errors are fixed.

For more information on how to define internal rules, see Creating Internal Rules (on page 302).

Creating Internal Rules

This procedure describes how to create internal rules.

For more information on internal rules functionality, see Internal rules.

➢ To create internal rules:

1. In the Site standard, from the ribbon, select Internal Rules.

The Internal Rules pane appears on the right.

2. Click .

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 314).

The internal rule is created.

Rule conditions This feature enables you to add a folder/job rule with specific conditions. You can add a restriction for job

parameter "x" when parameter "y" meets a specific condition.

When you create rules with restrictions on a job/folder parameter, for example, Folder Name in your

organization can only be from 1- 10 characters, cannot contain /*!, and only applies to OS job type. In the Site Standard you can create a rule that is applied on the Folder Name parameter with the required

restrictions. However, you also want to specify that in your organization this restriction applies to a

specific Application. In this case you want to add a condition, that when defining a folder name under

application "x", the rule is as follows:

If application is "app1", Folder Name can only be from 1- 10 characters, cannot contain /*!, and only

applies to OS job type.

In this case, you can create a rule that applies to jobs of OS type, and a condition rule in the following

format:

If Control-M parameter (Application) + Operator (Is) + Value (app1)

This enables you to create Site Standards with very specific rules that help the Control-M Web user to adhere to your organizations restrictions when creating and editing jobs. The rule you create in the Site

Standard is applied when the specified conditions are met. You can create multiple conditions.

For more information on how to use this feature, and example use cases see:


303

▪ Simple rule condition example (on page 303)

▪ A rule with two conditions - and relationship (on page 305)

▪ A rule with two conditions- Or relationship (on page 306)

Simple rule condition example

This example shows you how to create a regular rule with a simple rule condition. In this case, the rule is

if we have a cyclic job, Keep Active should be greater than 0 days.


2. In the Rule Prerequisites tab select All job types, and add the following Rule Condition:


304

3. In the Job Attribute tab, search for and select Keep Active:

4. In the Rule Format tab, in the Keep Active field, type <0:


305

A rule with two conditions - and relationship

This example shows you how to create a regular rule that contains two conditions. The relationship between the conditions is AND. In this case, we want to define a rule for a cyclic job with cyclic type

Interval, and Interval should be greater than 5.

The condition here is if a job is cyclic, and you define a cyclic type Interval, the user needs to set the

interval to greater than 5.

1. 1. In the Site Standard, select Rule:

2. In the Rule Prerequisites tab select All job types, and add the following Rule Conditions:

3. In the Job Attribute tab, search for and select Rerun Interval:


306

4. In the Rule Format tab, in the Rerun Interval field, type <5:

A rule with two conditions- Or relationship

This example shows you how to create rules for a job attribute that has two conditions, and the condition

relationship is OR.

In this case, we want to create a rule for Sub Application. However, there are two conditions in which the

rule applies. One is if Sub Application equals DB, Job Name should end with -DB. The other is, if Sub

Application does not equal DB, Job Name should start with Application.

Therefore, you have to create two regular rules, each rule containing one condition.

Rule 1



307


3. In the Job Attribute tab, search for and select Sub Application:


308

4. In the Rule Format tab, select Include-->Pattern-->Part Type: Free text. Add another Pattern

-->Part Type: Fixed Text-->Value: -DB:

Rule 2:

5. Add another rule:


309


7. In the Job Attribute tab, search for and select Sub Application:

In the Rule Format tab, select Include-->Pattern-->Part Type: Folder/Job Attribute-->Value:

Application. Add another Pattern -->Part Type: Free Text:


310

Job Attribute Condition This feature enables you to add a condition to a job attribute that contains multiple options. The condition

you create is specific to one of the options of that job attribute. You can create more than one condition,

for each of the options of the job attribute.

This enables you to create Site Standards with very specific rules that help the Control-M Web user to

adhere to your organizations restrictions when creating and editing jobs. The rule you create in the Site

Standard is applied when the specified job attribute conditions are met.

For more information on how to use this feature, and example use cases see Conditional Rule with job

attribute condition for On-Do actions (on page 311).


311

Conditional Rule with job attribute condition for On-Do actions

This example shows you how to create a rule for On-DO actions that also contains a job attribute condition. In this case, we want to create a rule that when a job ends not ok, the following message is

sent to the Alerts Window only:

%%JOBNAME HAS ENDED NOTOK


2. In the Rule Prerequisites tab select All job types:

3. In the Job Attribute tab, search for and select On-Do Actions-->On Statement: Job/folder ended

Not Ok-->Do Action: Notify:


312

4. Click Add an Attribute Condition, and add the following condition:


313

5. In the Rule Format tab, select Message-->Include-->Value: %%JOBNAME HAS ENDED NOTOK:


314

Site Standards rules editor parameters

The following table lists the Site standards rules editor parameters:


Default Value Defines a default value for a folder/job parameter.

Required Indicates that the parameter is mandatory.

Values Defines more than one value that a Control-M web user 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.

Patterns Indicates that a parameter is composed of a pattern. You can add more

than one pattern.

Business parameters Indicates that a business parameter can be used as a

pattern part of a Control-M

folder/job parameter.

EXAMPLE:

Job Name: [Business

Parameter][*]


315


Folder/job parameters Indicates that a folder/job parameter rule can be used as

a pattern part of another

folder/job parameter rule.

EXAMPLE:

Job Name:[Application]

Internal rules Indicates that an internal rule can be used as a pattern part of

folder/job parameter and a

business parameter.

EXAMPLE:

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.


316


Exclude 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

Exclude contains the same elements Values, Pattern, and Multi-pattern

that are described above in the table.

Characters Determines character restrictions, such as the minimum and maximum length of characters in a parameter, which characters are allowed, which

characters are excluded, the use of uppercase and lowercase letters, and

digits in a parameter.

EXAMPLE:

Job Name: [1-9 characters][#%4&]

Host/host group restriction example

This example shows you how to create a rule for job attribute Host/host group. In this case, you want to prevent users from defining hosts that do not exist on the Control-M on which the job runs, create a rule

with the following restriction:




317

3. In the Job Attribute tab, search for and select Host/Host Group:

4. In the Rule Format tab, turn on the Validation according to topology option:


318

When a user defines a host that does not exist under the relevant Control-M a warning message is

displayed:

Time zone restriction example

This example shows you how to create a rule with Time Zone restrictions. In this case, you want to

restrict which time zones a user can use when defining job scheduling.



In the Job Attribute tab, search for and select Time Zone:


319

In the Rule Format tab, select Include-->Values, and add the valid time zone values:

NOTE: When adding Time Zone values, you only need the three characters, do not add the

information in the in the parenthesis (GMT+00:00).


320

When a user selects a time zone that is not listed as a valid time zone in the Site Standard a warning

message is displayed.

Variables restriction example This example shows you how to create a rule with Variable restrictions. In this case, you want to set a list

of valid patterns a user must adhere to when defining variable names for each variable type. When you

have a list of patterns, the relations between them is an Or relationship.




321

3. In the Job Attribute tab, search for and select Variables:


322

4. In the Rule Format tab, select Variable Name-->Include-->Patterns. Add each pattern as

follows:


323

When a user defines a Variable, they must define the Variable name with the list of patterns you set

in the Site Standard. A warning message is displayed if the user does not adhere to the rule you set.

User Daily Name restriction example

This example shows you how to create a rule with a User Daily Name restriction. In this case, you want to

prevent users from using SYSTEM as a User Daily Name.




324

3. In the Job Attribute tab, search for and select User Daily Name:

4. In the Rule Format, select Exclude-->Values, and add the value:

When a user creates a Folder with Order Method set to Specific User Daily, they cannot use the value

SYSTEM. A warning message is displayed if the user does not adhere to the rule you set.


325

Pattern Parts in a rule example

This example shows you how to create a rule that consists of pattern parts, and business parameters and internal rules as pattern parts. In this case, you want to create a rule for job attribute Job Name. You

want users to define a job name with a specific pattern ,and the pattern consists of Environment Type,

Business Unit, and free text. For Environment type, you want to use a Business Parameter, as it enables you to list possible values, and reuse the parameter in other rules, since environment type could apply as

a pattern part in other job attributes. For Business Unit, you want to use an Internal Rule as it is not a Control-M parameter, and in your organization you use Business Unit as a pattern part in other job

attributes.

1. In the Site Standard, from the ribbon, select Business Parameters.

2. Create a Business Parameter for Environment type with the list of possible values:

3. In the Site Standard, from the ribbon, select Internal Rules.

4. Create an Internal Rule for Business Unit with the list of possible values:


326



7. In the Job Attribute tab, search for and select Job Name:


327

8. In the Rule Format tab, select Include-->Patterns. Add the following pattern parts:

When a user defines Job Name, the job name has to consist of the pattern parts you set in the rule. A

warning message is displayed if the user does not adhere to the rule you set.

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 drop-down menu, select Site standards.

The Site Standards tab appears.

2. Select the Site standard you want to edit.

The Site standard opens. All the rules in the Site Standard are listed.

3. Click on the rule/s you want to edit.

The Site standard is modified with the new changes.


328

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 drop-down menu,select Site Standards.


2. Select the Site standard you want to duplicate.

From the ribbon, click Duplicate.

3. Type a new name for the Site Standard.

4. Click Duplicate.

You can edit the Site Standard. For more information, see Creating a Site standard.

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 drop-down menu, select Site standards.


2. Select the Site standard you want to delete.

3. From the ribbon, click Delete.

A message appears. If you want to delete the Site Standard, click Delete.

The Site standard is deleted.

Documents

Control-M Web 9.0.19.100 User Guide · To get started, see the Getting Started help. Setting user preferences This procedure describes how to set user preferences, which enables you