Task Action Properties
Abort Action
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Cancel Process if Active | Instructs the Controller to cancel the process that was launched by this task before Force Finishing the task. | Boolean; Valid values: true/false. Default is false. | N |
| Description | Description of this Abort action. | N | |
| Exit Codes | One or more exit codes that, together with a status, will trigger the Abort action. | Integer; Use commas to separate multiple exit codes; use a hyphen to specify a range. Example: 1, 5, 22-30. | N |
| Halt On Force Finish | Instructs the Controller to Force Finish (Halt) a running task instance, rather than just Force Finish | Boolean; Valid values: true/false. Default is false. | N |
| Action Inheritance | For Workflow tasks only; Records that this action applies to. | Valid values:
Default is Self (1). | N |
| On Early Finish | Generates the action if the task finishes early, based on the Early Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Late Finish | Generates the action if the task finishes late, based on the Late Finish time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Late Start | Generates the action if the task started late, based on the Late Start Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Projected Late | Generates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option. | Boolean; Valid values: true/false. Default is false. | N |
| Override Exit Code | Overrides the exit code returned by the process with this exit code. This enables you to you Force Finish a task instance with a specific exit code so that you can force the workflow to take a conditional path using Conditions. | Integer. | N |
| Status | Status of this task, by itself or together with an exit code, that will trigger this Abort action. You can specify as many statuses as needed. | Y | |
| n/a | sys_id used within the Controller to identify this Abort action. | N |
Email Notification Action
Property | UI Field Name | Description | Specifications | Required | |
---|---|---|---|---|---|
| Attach Remote File | For Agent-based tasks only; Specification for whether or not a text file that is accessible by the Agent is attached. | Boolean; Valid values: true/false. Default is false. | N | |
| Attach Job Log | For z/OS tasks; Specification for whether or not a job log is attached. | Boolean; Valid values: true/false. Default is false. | N | |
| Attach Local File | Specification for whether or not a local file is attached. | Boolean; Valid values: true/false. Default is false. | N | |
| Attach Standard Error | For Agent-based tasks only (except z/OS); Specification for whether or not standard error data generated by the associated task is attached. | Boolean; Valid values: true/false. Default is false. | N | |
| Attach Standard Output | For Agent-based tasks only (except z/OS); Specification for whether or not standard output data generated by the associated task is attached. | Boolean; Valid values: true/false. Default is false. | N | |
| BCC | Email address of the party being sent a blind (hidden) copy of the email, if any. | Use commas to separate multiple recipients. Variables and functions are supported. | N | |
| Body | Text of the email message. | Variables and functions are supported. | N | |
| CC | Email address of the party being sent a copy of the email, if any. | Use commas to separate multiple recipients. Variables and functions are supported. | N | |
| Description | Description of this Email Notification action. | N | ||
| Email Connection | Name of an Email Connection. | If you specify both an | Y | |
| Email Template | Name of an Email Template. | If you specify both an | Y | |
| Email Template Variable | Name of a variable that will be resolved at run time to the name of an Email Template to use. | Format: ${variable name}. | N | |
| Exit Codes | One or more exit codes that will trigger this action. | Integer; if you specify an exit code, you also must specify at least one | N | |
| File Name | If | Full path name is required. Wildcards are NOT supported. | Y | |
| Number of Lines | Number of lines to limit the retrieved data to. If | Integer. | N | |
| Scan Text | Regex pattern that the Controller will search for a match for in STDOUT/STDERR or a specified file. The Controller will include the | N | ||
| Start Line | Integer; Starting line of the attached data. | Integer. | N | |
| Action Inheritance | For Workflow tasks only; Records that this action applies to. | Valid values:
Default is Self (1). | N | |
| Number of Lines | For z/OS tasks only; Number of lines to limit the retrieved data in the job log to. | Integer. | N | |
| Scan Text | For z/OS tasks only; Regex pattern that the Controller will search for a match for in the job log. | Integer. | N | |
| Start Line | For z/OS tasks only; Starting line of the attached job log. | Integer. | N | |
| List Report Format | Report format. If the attached report is not a List type report, this option will be ignored. | Default is PDF (1). Valid Values:
| N | |
| Local Attachments Path | Location of Local Attachments for the connected Node. | N | ||
| Local Attachment | Name of the file(s) to attach. | N | ||
| On Early Finish | Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N | |
| On Late Finish | Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N | |
| On Late Start | Specification to generate the action if the task starts late, based on the Late Start Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N | |
| On Projected Late | Generates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option. | Boolean; Valid values: true/false. Default is false. | N | |
| Reply-To | Email address of the sender of the email. | Use commas to separate multiple recipients. Variables and Functions are supported. | N | |
| Report | Report attached to this notification. | If <report> <title>XYZ</title> <userName>john.doe</userName> <groupName /> </report> "report": { "title": "XYZ", "userName": "john.doe", "groupName": null } To specify a single visibility group, you can utilize either To define a report reference for a report with Title XYZ that is visible to group Operators, you could specify: <report> <title>XYZ</title> <userName /> <groupName>Operators</groupName> </report> "report": { "title": "XYZ", "userName": null, "groupName": "Operators", } or XML <report> JSON "report": { "title": "XYZ", "userName": null, "groupNames": { Duplicate group visibility is prohibited and thus there should be only a single report (of the same title) visible to a particular group. Therefore, to look up a report visible to multiple groups, you can specify one or more of the visibility groups, as long as the report is visible to all of the specified groups. To define a report reference for a report with Title XYZ that is visible to groups Operators, Finance, and Development; You could specify any one of the visibility groups: XML <report> JSON "report": { "title": "XYZ", "userName": null, "groupName": "Operators", Or you could specify multiple visibility groups: XML <report> JSON "report": { "title": "XYZ", "userName": null, "groupNames": {
<report> <title>XYZ</title> <groupName /> <userName /> </report> "report": { "title": "XYZ", "userName": null, "groupName": null } | N | |
| Report Variable | Name of a variable that will be resolved at run time to the name of the Report to attach. | If | N | |
| Status | Status of this task, by itself or together with an exit code, that will trigger this Email Notification action. You can specify as many statuses as needed. | Y | ||
| Number of Lines | Number of lines to limit the retrieved stderr data to. If | Integer. | N | |
| Scan Text | Regex pattern that the Controller will search for a match for in stderr. The Controller will include the Number of Lines above and below the first line matched. | N | ||
| Start Line | Starting line of the attached stderr data. | Integer. | N | |
| Number of Lines | Number of lines to limit the retrieved stderr data to. If | Integer. | N | |
| Scan Text | Regex pattern that the Controller will search for a match for in stdout. The Controller will include the Number of Lines above and below the first line matched. | N | ||
| Start Line | Starting line of the attached stdout data. | Integer. | N | |
| Subject | Subject line of the email. | Variables and functions supported. | N | |
| n/a | sys_id used within the Controller to identify this Email Notification action. | N | ||
| To | Email address of the recipient. | Use commas to separate multiple recipients Variables and functions supported. | Y |
Set Variable Action
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Description | Description of this Set Variable action. | N | |
| Exit Codes | One or more exit codes that will trigger this action. | Integer; if you specify an exit code, you also must specify at least one | N |
| Action Inheritance | For Workflow tasks only; Records that this action applies to. | Valid values:
Default is Self (1). | N |
| System Notification | If | Valid values:
Default is Operation Failure (1). | N |
| On Early Finish] | Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Late Finish | Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Late Start | Specification to generate the action if the task starts late, based on the Late Start Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Projected Late | Generates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option. | Boolean; Valid values: true/false. Default is false. | N |
| Status | Status of this task, by itself or together with an exit code, that will trigger this Set Variable action. You can specify as many statuses as needed. | Y | |
| n/a | sys_id used within the Controller to identify this Email Notification action. | N | |
| Name | Name of the variable. | Name of the variable. Up to 128 alphanumerics. The name must begin with an alphabetic character and can consist of: alphas (a-z, A-Z), numerics 0-9, _ (underscore). White spaces are not permitted; names are not case-sensitive. Do not define variables with the prefix ops_. The ops_ prefix is reserved for built-in variables. If the specified variable name contains an embedded variable or function, the above restrictions will not be validated until runtime. | N |
| Variable Scope | Applies to variables associated with a task in a Workflow. | Valid values:
Default is Self (1). | N |
| Value | Value of this variable. | N |
SNMP Notification Action
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Description | Description of this action. | N | |
| Exit Codes | One or more exit codes that will trigger this action. | Integer; if you specify an exit code, you also must specify at least one | N |
| Action Inheritance | For Workflow tasks only; Records that this action applies to. | Valid values:
Default is Self (1). | N |
| On Early Finish | Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Late Finish | Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Late Start | Specification to generate the action if the task starts late, based on the Late Start Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
| On Projected Late | Generates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option. | Boolean; Valid values: true/false. Default is false. | N |
| Notification Severity | Severity level of this notification. | Valid values:
Default is Normal (1). | Y |
| Status | Status of this task, by itself or together with an exit code, that will trigger this SNMP Notification action. You can specify as many statuses as needed. | Y | |
| n/a | sys_id used within the Controller to identify this SNMP Notification action. | N | |
| SNMP Manager | SNMP Manager that will receive this notification. | Y |
System Operation Action
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Agent | If | Y |
| |
| Agent Cluster | If | Y |
| |
| Agent Cluster Variable | If | Y |
| |
| Agent Variable | If System Operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent to use. | Y |
| |
| Description | Description of this System Operation action. | N | ||
| Command | If | Valid values:
Default is Cancel (1). | N | |
| Instance Criteria | If | Valid values:
Default is Oldest Active Instance (1). | N | |
| Instance Id | If | The instance Id (sysid) is a 32-character universally unique identifier. You can use the | N | |
| Instance Lookup Option | If | Valid values:
Default is Instance Name (1). | N | |
| Instance Name | If | Variables are supported. | Y | |
| Workflow Instance Name Condition | If | Valid values:
Default is Equals (1). | N | |
| Workflow Instance Name <Condition Value> | Value for | Y | ||
| Exit Codes | One or more exit codes that will trigger this action. | Integer; if you specify an exit code, you also must specify at least one | N | |
| Limit | If | Integer | N | |
| Action Inheritance | For Workflow tasks only; Records that this action applies to. | Valid values:
Default is Self (1). | N | |
| Name | Name of a variable to override. | N | ||
| System Notification | Status of the specified | Valid values:
Default is Operation Failure (1). | N | |
| On Early Finish | Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N | |
| On Late Finish | Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N | |
| On Late Start | Specification to generate the action if the task starts late, based on the Late Start Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N | |
| On Projected Late | Generates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option. | Boolean; Valid values: true/false. Default is false. | N | |
| System Operation | System operation to perform. | Valid values:
Default is Suspend Agent (1). | N | |
| Override Date Offset | Override date offset. | Date Offset value of trigger to fire. | N (unless overrideTriggerDateTime is true) | |
| Override Trigger Date/Time | Request parameter to enable/disable override functionality. | Boolean value (true / false). Default is false. | N | |
| Override Time | Override time. | Time of the trigger to fire. | Y (if overrideTriggerDateTime is true) | |
| Status | Status of this task, by itself or together with an exit code, that will trigger this System Operation action. You can specify as many statuses as needed. | Y | ||
| n/a | sys_id used within the Controller to identify this System Operation action. | N | ||
| Task Reference |
| N |
| |
| Task Execution Limit | If | Valid values:
Default is Unlimited. | N | |
| Task Reference Variable |
| N |
| |
| Trigger Reference | If | N |
| |
| Trigger Reference Variable | If | N |
| |
| Value | Value of a variable to override. | N | ||
| Override Variables | List of variables to override. | N | ||
| Override Variables Resolution Disabled | Specification for whether or not
| Boolean; Valid values: true/false. Default is false. | N | |
| Vertex Selection | If | Boolean; Valid Values: true/false | N | |
| Vertices | If A vertex can be specified by If you specify a To indicate a vertex selection is a Root Vertex, set | XML <vertices> <vertex root="true"> <taskName>JOB_A</taskName> <vertexId>10</vertexId> </vertex> <vertex root="false"> <taskName>JOB_B</taskName> <vertexId>Any</vertexId> </vertex> </vertices> JSON "vertices": [ { "root": true, "taskName": "JOB_A", "vertexId": "10", }, { "root": false, "taskName": "JOB_B", "vertexId": "Any", } ] | N | |
| Virtual Resource | If | N |
| |
| Virtual Resource Variable | If | N |
|