Actions

Sends a message when the job is not or cannot be not submitted by the time you define.

For cyclic folders and jobs, this attribute only controls the first execution. To define notifications for subsequent executions, see the Job's Calculated Cyclic Submission Is Late By option.

Sends a message when the elapsed execution time exceeds the number of minutes you define.

Time limits are expressed as the actual elapsed minutes of a job execution, or as a deviation from the (statistical) average execution time.

Rules: 1–999 minutes.

Sends a message when the job continues executing after the defined time.

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

Sends a message when the beginning of the second or subsequent cyclic execution is late by the number of minutes you define.

You must select and define the Job Not Submitted by <Time> attribute to send a notification when the first cyclic execution is late.

Rules: 1–999 minutes.

Determines where the notification is sent, as follows:

• <Destination Name in an Active Destination List>: Sends a notification to a predefined destination in the active destination notification list, as described in Notification Destinations. The first time you use a destination in an active notification destination list, you must type the destination name in the Destination field. It appears as an option in the drop-down list from then on.

• Alerts Window: Sends a notification to the Alerts window, as described in Alerts.

• 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) 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: (z/OS) 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) Sends the message to the IOA log file under the specified User ID.

• Mail Group: (z/OS) 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

Determines the destination of the notification, as follows:

• <Destination Name in an Active Destination List>: Sends a notification to a predefined destination in the active destination notification list, as described in Notification Destinations. The first time you use a destination in an active notification destination list, you must type the destination name in the Destination field. It appears as an option in the drop-down list from then on.

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

• Mail: Sends an email to the indicated email addresses, as described in 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, which is the Control-M/Server or Agent UNIX user terminal.

• System Console: (z/OS) 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: (z/OS) 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) Sends the message to the IOA log file under the specified User ID.

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

• Discontinued for New Tenants after 2024

  • NotifyScriptLnx: Sends a notification to a destination via script $CONTROLM/NotifyScriptLinux.sh in the Control-M/Agent home directory. This option appears in the If-Actions drop-down list after you manually define it as free text.
    You must create script NotifyScriptLinux.sh under the Control-M/Agent home directory.

  • NotifyScriptWin: Sends a notification to a destination via script NotifyScriptWindows.bat in the Control-M/Agent home directory. This option appears in the If-Actions drop-down list after you manually define it as free text.

    You must create script NotifyScriptWindows.bat under the Control-M Agent home directory.

    • You can only notify via script (Windows and UNIX) on OS jobs.

    • The NotifyScriptLnx or NotifyScriptWin option executes according to the user defined in the job.

Defines the text of the notification message.

Rules:

• Characters: 1–4,000

  z/OS: 1–255 lines, each containing 1–70 characters. The message must not exceed 4,000 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.

Performs the defined Action if the job ends with the status Ended Not OK.

Performs the defined Action if the job ends.

Performs the defined Action if the job ends with the status Ended OK.

Performs the defined Action in response to the exit code that the operating system returns.

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

Performs the defined Action when the defined number of job reruns for this job instance (Run ID) 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: A statement that is located in the job script file, is 1–132 characters in length, and includes at least one *.

• Code: The response from the job script, which appears in the output, is 1–255 characters in length, includes at least one *, and comes from the exit code of DOS BAT scripts or REXX CMD scripts that are returned to the Control-M/Server.

Statement and code character strings can contain the following wildcard 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.

Rules:

• Variable Name: Local, Global, Named Pool, or SMART folder 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 \ (backslash), such as \MYVAR.

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

• Rules Value:

  • String:

    • 1–255 characters. String values can contain up to 4,000 characters.

    • (z/OS only) 1–64 characters. String values can contain up to 80 characters.

    • Special Characters: * (asterisks); (z/OS) ? (question marks).

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

(z/OS) Performs the defined Action if the specified codes are found in any program step.

Rules:

• Characters: 1–8

• Invalid Characters: Non-English characters and blank spaces.

(z/OS) 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 characters and blank spaces.

(z/OS) Defines the name of a specific procedure or program step. If a specific procedure or program step is specified, only program or procedure steps from the invoked procedure or program are checked to see if they satisfy the code criteria. Program or procedure steps directly from the job are not checked.

Rules:

• Characters: 1–8

• Invalid Characters: Non-English characters and blank spaces.

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

Rules:

• Characters: 1–8

• Invalid Characters: Non-English characters and blank spaces.

(z/OS) 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 completes Not OK.

Sets the status of a job to Not OK, even if the job completes OK.

Re-executes the job.

Stops subsequent iterations of the current cyclic job.

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

Forces a job to execute, even if the scheduling criteria is not met. .

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

Determines how the job handles the output, as follows:

• Copy
• Delete
• Move
• Print
• None

z/OS:

• None

• Change Jobs Class

• Delete Output

• Copy Output

• Move Output

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

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

Name:

• Characters: 1–8

• Case Sensitive: Yes

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

Argument:

• Characters: 1–45

• Case Sensitive: Yes

• Invalid Characters: Blank spaces; non-English characters

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.

Sends the message if the job finished executing with a successful operating system completion status.

Determines where the notification is sent, as follows:

• <Destination Name in an Active Destination List>: Sends a notification to a predefined destination in the active destination notification list, as described in Notification Destinations. The first time you use a destination in an active notification destination list, you must type the destination name in the Destination field. It appears as an option in the drop-down list from then on.

• Alerts Window: Sends a notification to the Alerts window, as described in Alerts.

• 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) 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: (z/OS) 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) Sends the message to the IOA log file under the specified User ID.

• Mail Group: (z/OS) 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 User-Defined 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.

• None

• Copy: Copies the job output to a file that you define in the Filename field.

• Delete: Deletes the job output from the default output directory.

• Move: Moves the job output file from the default output directory to the pathname that you define in the New Destination field.

• Print: Prints the job output to the printer that you define in the Printer Name field.

Default: None

z/OS:

• None

• Change Jobs Class: Changes the class of the job output.

• Delete: Deletes the job output.

• Copy: Copies the job output to a selected filename.

• Move: Moves the job output to a selected path.

Default: None

Defines the filename and its position in the directory (pathname) of the file that contains the job ouput when the job ends OK.

Defines the pathname that the job output is sent to when the job ends OK.