OS job parameters

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

Parameter

Description

Job Type

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

Value: OS

Job Name

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

You can use variables with the Job Name.

EXAMPLE: The job script must access a file called BranchTrans with the current date as a suffix (for example, BranchTrans_161025). Specify the file name BranchTrans_%%Odate.

Description

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

Run as dummy

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

What

Defines one or more parameters which determines what the job runs. Determines whether the job runs as one of the following:

  • Script: Defines that the jobs runs a script saved in File name located in File Path. You can add a script parameter, as described in Adding input parameters to a script.
  • Command: Defines that the job runs a command and includes the Command.
  • Embedded Script: Defines that the job runs an embedded script, and includes the lines of the Script and the File name. You can add a script parameter, as described in Adding input parameters to a script.

For more information about remote browsing to select a file containing the script (from the file path), see Browse in an OS job for a file that contains a job script in a remote host or host group.

Script

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

Command

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

Embedded Script

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

File Path

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

File name

Indicates the name of a member that contains one of the following in relation to the job to be executed:

  • The JCL of the job
  • The started task procedure
  • Warning messages

Host (/Group)

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

Control-M/Server

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

Run as

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

Parent Folder

Defines the name of the folder that contains the job or Sub Folder.

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

More

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

Override Path

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

Pre-execution

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

Post-execution

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

Run job on all hosts 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.

Variables

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

Application

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

Sub Application

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

Created by

Indicates the Control‑M/EM user who defined the job.

Documentation

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

NOTE: A Documentation type file is only allowed for OS jobs.

Type

Defines whether the documentation for an OS job is in a file or URL. See the following:

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

Doc Path

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

Doc File

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

Priority

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

Critical

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

Parent Topic

Job types