Actions

Performs the defined Action if the job ended not OK.

Performs the defined Action if the job ended.

Performs the defined Action if the job ended OK.

Performs the defined Action in response to the OS completion code returned by the OS.

Performs the defined Action when the number of job executions is met.

Performs the defined Action when the number of job reruns is met.

Performs the defined Action if the output cannot be found.

Performs the defined Action if the job returns as not submitted.

Performs the defined Action in relation to the number of times the job failed.

Performs the defined Action if one of the following is fulfilled:

• The job script file contains the character string that you define in Statement.

• The OS response to the character string that you define contains the code characters that you define in Code.

Rules:

• Statement: 1–132 characters in length, from the job script file, containing at least one asterisk.

• Code: 1–255 characters in length, from the exit code of DOS BAT scripts and REXX CMD scripts that are returned to the Control-M/Server.

Statement and code character strings can contain the following mask characters:

• *: Represents any number of characters (including no characters).
• $: Represents any single character.
• ?: Represents any single character.

Performs the defined Actions if the logical condition defined on the variable value returns True.

This feature is supported in Control-M/Server 9.0.21 and higher.

Rules:

• Variable Name: Local, Folder, or Global, as described in Variables.

  Characters: 1–128, (z/OS: 1–64)). This includes the Pool name if the variable is in a Pool.

  (z/OS Only) If you are using a Global variable you must include a \, such as \MYVAR.

• Operator: The Operator determines the relationship between the variable and the value. There are two kinds of operator types, integer operator (numeric values) or string operator (string values). Depending on the operator type selected, you might need to provide one value, either number or string, or two values, such as a Min and Max range.

• Rules Value:

  • String:

    • 1–255 characters. The resolving string values can contain string lengths of up to 4,000 characters.

    • (z/OS Only) 1–64 characters. The resolving string values can contain string lengths of up to 80 characters.

    • Special characters: '*' (asterisk) ,(z/OS Only) '?' (question mark).

    • String values can contain other variables.

  • Integer:

    • 1–255 characters for both the Min and Max value field combined if one of the fields contains a variable.

    • 1–10 characters for each Min and Max value field (11 characters if you are using number signs '+' or '-'), if a variable is not used.

    • (z/OS Only) 1–64 characters for each Min and Max value field if one of the fields contains a variable.

    • (z/OS Only) 1–10 characters for each Min and Max value field (11 characters if you are using number signs '+' or '-') if a variable is not used.

Performs the defined Action if the specified codes are found in any program step.

Rules:

• Characters: 1–8

• Invalid Characters: Non-English, blank spaces.

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.

Rules:

• Characters: 1–8

• Invalid Characters: Non-English, blank spaces.

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

Rules:

• Characters: 1–8

• Invalid Characters: Non-English, blank spaces.

(z/OS Only) Specifies a range of steps in the steps of an Any program step statement.

Rules:

• Characters: 1–8

• Invalid Characters: Non-English, blank spaces.

(z/OS Only) Assign a completion code for the entire job based on the completion codes of its steps.

Sends a notification to a specific destination, as described in Notify Attributes.

Sets the status of a job to OK, even if the job completed not OK.

Sets the status of a job to not OK, even if the job completed OK.

Re-executes the job.

Stops subsequent iterations of the current cyclic job.

Resolves the value of a user-defined variableA type of variable whose name and value you manually set in a job, which you can reference in subsequent jobs or in the same job for use in subsequent jobs, with attributes, as described in Variables

Forces the execution of a job, even if the scheduling criteria is not met. You can force the job in the local Control-M/Server or remote Control-M/Server.

You can also select to Run as independent flow, which determines whether the job flow in the folder executes independently from other instances of the same flow using the same events. This is achieved by adding a unique suffix to the events used in each flow instance. Run as independent flow is supported in SMART folders, sub-folders, and jobs.

Determines how the job handles the output:

• Copy
• Delete
• Move
• Print
• None

z/OS:

• None

• Change jobs class

• Delete output

• Copy output

• Move output

Determines whether to add or delete a prerequisiteThe part of the job definition that controls the flow of your jobs, such as an event that controls sequence or a resource that controls load event, as described in Events.

(z/OS Only) Defines the Control‑M/Analyzer rule that Control-M executes.

Name:

• Characters: 1–8

• Case Sensitive: Yes

• Invalid Characters: Blank spaces; non-English characters.

Argument:

• Characters: 1–45

• Case Sensitive: Yes

• Invalid Characters: Blank spaces; non-English characters

Determines the destination of the notification, as follows:

• Alerts Window: Sends a notification to the Alerts window.

• Mail: Sends an email to the indicated email addresses, see Mail Attributes.

• Remedy: Opens a ticket in the Remedy Help Desk.

• Job Log: Sends a notification to the job log.

• User Console: Sends a notification to the user console.

• System Console: (z/OS Only) Sends a notification to the operator console, as follows:

  • Route Code: Defines an optional 3-digit code.

  • Highlight: Determines whether the message is a highlighted unrollable message.

• TSO User: Sends a message to the specified ID, as follows:

  • User ID: Defines the ID (1 to 7 characters) where Control-M writes the message.
  • Comp: (Optional) Defines the computer and/or host of the TSO logonid.

• IOA Log: (z/OS Only) Sends the message to the IOA log file under the specified User ID.

• SNMP Destination: Sends an SNMP trap (message) to the recipient address that you define.

  To enable this option, you must create a Program destination in the Shout Destination List Editor in the CCM and provide the SNMP script in the Value field or use the predefined script, as described in Sending alerts and xAlerts to an event management system.

• Mail Group: (z/OS Only) Defines a group name in the SNMPDEST destination table.

Defines the text of the notification message.

Rules:

• Characters: 1–4,000

  z/OS: 1–255 lines, each containing 1–70 characters, must not exceed 4000 characters.

• Case sensitive: Yes

• Invalid characters: ' (apostrophes)

  z/OS: None

• Variable support: A variable or expression can be specified as all or part of the value for this parameter.

Sends a message if the job is not submitted and cannot be submitted by the time specified.

For cyclic folders and jobs this option controls the first execution only. For subsequent executions, see the Job's calculated cyclic submission is late by option.

Sends a message if the elapsed job run time is outside the defined limit. A limit is expressed as the actual elapsed minutes of the job run, or as a deviation from the job (statistical) average runtime.

Rules: 1–999 minutes.

Sends a message if the job does not finish executing by the time specified.

Sends a message if the job completion status is set to rerun, (not valid for folders).

Sends the message if the job finished executing with an unsuccessful operating system completion status, or due to a submission failure, such as the queue does not exist.

Determines the destination of the notification, as follows:

• Alerts Window: Sends a notification to the Alerts window.

• Mail: Sends an email to the indicated email addresses, see Mail Attributes.

• Remedy: Opens a ticket in the Remedy Help Desk.

• Job Log: Sends a notification to the job log.

• User Console: Sends a notification to the user console.

• System Console: (z/OS only) Sends a notification to the operator console, as follows:

  • Route Code: Defines an optional 3-digit code.

  • Highlight: Determines whether the message is a highlighted, unrollable message.

• TSO User: Sends a message to the specified ID, as follows:

  • User ID: Defines the ID (1 to 7 characters) where Control-M writes the message.
  • Comp: (Optional) Defines the computer and/or host of the TSO logonid.

• IOA Log: (z/OS Only) Sends the message to the IOA log file under the specified User ID.

• SNMP Destination: Sends an SNMP trap (message) to the recipient address that you define.

• Mail Group: (z/OS Only) Defines a group name in the SNMPDEST destination table.

Defines the text of the notification message as follows:

Rules:

Characters: 1–255, z/OS: 1–70

Case Sensitive: Yes

Invalid Characters: None

Defines the variable name that contains the captured data, that can be used in other jobs.

Determines the variable type as described in Variables.

Determines where in the output file to run the capture process as follows:

• Move to the end of below string: Moves the cursor position to the end of the string in the output file.

• Forward by: Selects the number of lines to skip from the search string.

• Words/Characters: Selects the number of words or characters to skip from the search string in the output file.

• Delimiter: Selects a delimiter type that is used as a split separator between words in the job output file.