On actions options

The following table lists the On actions:

Take into consideration that some options 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.

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 accompanying DO statements are 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.

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 considered satisfied by an 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 accompanying DO statements are 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 considered satisfied by an even return code
  • ODD (the field is considered satisfied by an odd return code

Number of reruns:

The number of reruns for the action to take place.

Output cannot be found

Determines whether the accompanying DO statements are performed if the Output cannot be found.

 

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 action to take place.

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

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.

  • Invalid Characters:

    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.

  • Invalid Characters:

    Non-English characters not 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:

    1 through 8 characters in length, and must not contain blanks.

  • Invalid Characters:

    Non-English characters not allowed.

Program:

  • Length:

    1 through 8 characters in length, and must not contain blanks.

  • Invalid Characters:

    Non-English characters not allowed.

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.

  • Invalid Characters:

    Non-English characters not 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

Parent Topic

Job actions