OS Job parameters

The following table describes the General parameters for an OS 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 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.

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 computer and is part of the Job definition.

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

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
  • iSeries (AS/400): 1-21 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
  • Invalid characters: Blanks, Single quotation marks

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.

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
  • Invalid characters: Blanks, single quotation marks

Created by

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

Control-M rules:

  • 1-64 characters
  • Case sensitive
  • Invalid characters: Blanks, single quotation marks

Documentation

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

Type

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

  • URL: Defines the URL address where the documentation is located. The format starts with "http://",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
  • iSeries (AS/400): 1-21 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.

Parent Topic

Job types