Task Action Properties

Abort Action

Property	UI Field Name	Description	Specifications	Required
`cancelProcess`	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	Description of this Abort action.		N
`exitCodes`	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
`haltOnFinish`	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
`inheritance`	Action Inheritance	For Workflow tasks only; Records that this action applies to.	Valid values: As String = Self, As Value = 1 As String = Self/Children, As Value = 2 As String = Children, As Value = 3 Default is Self (1).	N
`notifyOnEarlyFinish`	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
`notifyOnLateFinish`	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
`notifyOnLateStart`	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
`notifyOnProjectedLate`	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
`overrideExitCode`	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	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
`sysId`	n/a	sys_id used within the Controller to identify this Abort action.		N

Email Notification Action

Property	UI Field Name	Description	Specifications	Required
`attachFile`	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
`attachJobLog`	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
`attachLocalFile`	Attach Local File	Specification for whether or not a local file is attached.	Boolean; Valid values: true/false. Default is false.	N
`attachStdError`	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
`attachStdOut`	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`	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`	Body	Text of the email message.	Variables and functions are supported.	N
`cc`	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	Description of this Email Notification action.		N
`emailConnection`	Email Connection	Name of an Email Connection.	If you specify both an `emailConnection` and an `emailTemplate`, the Controller uses the `emailConnection`.	Y (unless `emailTemplate` is specified)
`emailTemplate`	Email Template	Name of an Email Template.	If you specify both an `emailConnection` and an `emailTemplate`, the Controller uses the `emailConnection`.	Y (unless `emailConnection` is specified)
`emailTemplateVar`	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
`exitCodes`	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 `status`. Use commas to separate multiple exit codes; use a hyphen to specify a range. Example: 1, 5, 22-30.	N
`fileName`	File Name	If `attachFile` is enabled; Name of an attached file.	Full path name is required. Wildcards are NOT supported.	Y (if `attachFile` is specified)
`fileNumLines`	Number of Lines	Number of lines to limit the retrieved data to. If `fileNumLines` is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.	Integer.	N
`fileScanText`	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 `fileNumLines` above and below the first line matched.		N
`fileStartLine`	Start Line	Integer; Starting line of the attached data.	Integer.	N
`inheritance`	Action Inheritance	For Workflow tasks only; Records that this action applies to.	Valid values: As String = Self, As Value = 1 As String = Self/Children, As Value = 2 As String = Children, As Value = 3 Default is Self (1).	N
`joblogNumLines`	Number of Lines	For z/OS tasks only; Number of lines to limit the retrieved data in the job log to.	Integer.	N
`joblogScanText`	Scan Text	For z/OS tasks only; Regex pattern that the Controller will search for a match for in the job log.	Integer.	N
`joblogStartLine`	Start Line	For z/OS tasks only; Starting line of the attached job log.	Integer.	N
`localAttachmentsPath`	Local Attachments Path	Location of Local Attachments for the connected Node.		N
`localAttachment`	Local Attachment	Name of the file(s) to attach.		N
`notifyOnEarlyFinish`	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
`notifyOnLateFinish`	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
`notifyOnLateStart`	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
`notifyOnProjectedLate`	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
`replyTo`	Reply-To	Email address of the sender of the email.	Use commas to separate multiple recipients. Variables and Functions are supported.	N
`report`	Report	Report attached to this notification.	If `reportVar` is specified, `report` is ignored. Reports do not have to be unique by Title. However, reports with the same Title must be unique per Visibility: per User, per Group, and per Everyone. Therefore, when specifying a report reference, both the Title and Visibility must be specified. To define a report reference for a report with Title XYZ that is visible to user john.doe, you would specify: XML <report> <title>XYZ</title> <userName>john.doe</userName> <groupName /> </report> JSON "report": { "title": "XYZ", "userName": "john.doe", "groupName": null } To define a report reference for a report with Title XYZ that is visible to group Operators, you would specify: XML <report> <title>XYZ</title> <userName /> <groupName>Operators</groupName> </report> JSON "report": { "title": "XYZ", "userName": null, "groupName": "Operators", } To define a report reference for a report with title XYZ that is visible to Everyone, you would specify: XML <report> <title>XYZ</title> <groupName /> <userName /> </report> JSON "report": { "title": "XYZ", "userName": null, "groupName": null }	N
`reportVar`	Report Variable	Name of a variable that will be resolved at run time to the name of the Report to attach.	If `reportVar` is specified, `report` is ignored.	N
`status`	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
`stderrNumLines`	Number of Lines	Number of lines to limit the retrieved stderr data to. If `stderrNumLines` is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.	Integer.	N
`stderrScanText`	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
`stderrStartLine`	Start Line	Starting line of the attached stderr data.	Integer.	N
`stdoutNumLines`	Number of Lines	Number of lines to limit the retrieved stderr data to. If `stdoutNumLines` is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.	Integer.	N
`stdoutScanText`	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
`stdoutStartLine`	Start Line	Starting line of the attached stdout data.	Integer.	N
`subject`	Subject	Subject line of the email.	Variables and functions supported.	N
`sysId`	n/a	sys_id used within the Controller to identify this Email Notification action.		N
`to`	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	Description of this Set Variable action.		N
`exitCodes`	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 `status`. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30	N
`inheritance`	Action Inheritance	For Workflow tasks only; Records that this action applies to.	Valid values: As String = Self, As Value = 1 As String = Self/Children, As Value = 2 As String = Children, As Value = 3 Default is Self (1).	N
`notificationOption`	System Notification	If `variableScope` is Global (4); Status of the Set Variable action that will trigger a system notification.	Valid values: As String = -- None --, As Value = 0 As String = Operation Failure, As Value = 1 As String = Operation Success/Failure, As Value = 2 As String = Operation Success, As Value = 3 Default is Operation Failure (1).	N
`notifyOnEarlyFinish`	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
`notifyOnLateFinish`	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
`notifyOnLateStart`	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
`notifyOnProjectedLate`	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	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
`sysId`	n/a	sys_id used within the Controller to identify this Email Notification action.		N
`variableName`	Name	Name of the variable.	Maximum 40 characters; must begin with an alphabetic character and can consist of: alphabetics (a-z, A-Z), numerics 0-9, _ (underscore). White spaces are not permitted; names are not case-sensitive. Do not begin the name with ops_; this prefix is reserved for built-in variables.	N
`variableScope`	Variable Scope	Applies to variables associated with a task in a Workflow.	Valid values: As String = Self, As Value = 1 As String = Parent, As Value = 2 As String = Top Level Parent, As Value = 3 As String = Global, As Value = 4 Default is Self (1).	N
`variableValue`	Value	Value of this variable.		N

SNMP Notification Action

Property	UI Field Name	Description	Specifications	Required
`description`	Description	Description of this action.		N
`exitCodes`	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 `status`. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30	N
`inheritance`	Action Inheritance	For Workflow tasks only; Records that this action applies to.	Valid values: As String = Self, As Value = 1 As String = Self/Children, As Value = 2 As String = Children, As Value = 3 Default is Self (1).	N
`notifyOnEarlyFinish`	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
`notifyOnLateFinish`	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
`notifyOnLateStart`	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
`notifyOnProjectedLate`	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
`severity`	Notification Severity	Severity level of this notification.	Valid values: As String = Normal, As Value = 1 As String = Warning, As Value = 2 As String = Minor, As Value = 3 As String = Major, As Value = 4 As String = Critical, As Value = 5 Default is Normal (1).	Y
`status`	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
`sysId`	n/a	sys_id used within the Controller to identify this SNMP Notification action.		N
`snmpManager`	SNMP Manager	SNMP Manager that will receive this notification.		Y

System Operation Action

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`agent`	Agent	If `operation` is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Agent for which the System Operation is to be performed.		Y (unless `agentVar`, `agentCluster`, or `agentClusterVar` is specified)	`agentVar`
`agentCluster`	Agent Cluster	If `operation` is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Agent Cluster for which the system operation is to be performed.		Y (unless `agent`, `agentVar`, or `agentClusterVar` is specified)	`agentClusterVar`
`agentClusterVar`	Agent Cluster Variable	If `operation` is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent Cluster to use.		Y (unless `agentCluster`, `agent`, or `agentVar` is specified)	`agentCluster`
`agentVar`	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 (unless `agent`, `agentCluster`, or `agentClusterVar` is specified)	`agent`
`description`	Description	Description of this System Operation action.		N
`execCommand`	Command	If `operation` is Run Task Instance Command; Type of task instance command to run.	Valid values: As String = Cancel, As Value = 1 As String = Force Finish, As Value = 2 As String = Force Finish (Halt), As Value = 3 As String = Force Finish/Cancel, As Value = 4 As String = Force Finish/Cancel (Halt), As Value = 5 As String = Skip, As Value = 6 As String = Hold, As Value = 7 As String = Release, As Value = 8 As String = Release Recursive, As Value = 9 As String = Clear All Dependencies, As Value = 10 As String = Clear Exclusive, As Value = 11 As String = Clear Predecessors, As Value = 12 As String = Clear Resources, As Value = 13 As String = Unskip, As Value = 14 As String = Clear Timewait, As Value = 15 As String = Re-run, As Value = 16 Default is Cancel (1).	N
`execCriteria`	Instance Criteria	If `execLookupOption` is Instance Name, Instance Name/Task, or Task; Additional criteria for selecting a specific task instance if multiple task instances have matching names.	Valid values: As String = Oldest Active Instance, As Value = 1 As String = Newest Active Instance, As Value = 2 As String = Oldest Instance, As Value = 3 (Unskip command only) As String = Newest Instance, As Value = 4 (Unskip command only) Default is Oldest Active Instance (1).	N
`execId`	Instance Id	If `execLookupOption` is Instance Id; ID of task instance to run the command against.	The instance Id (sysid) is a 32-character universally unique identifier. You can use the `${ops_task_id`} variable or `${_siblingid('mytask')`} function to get the instance Id.	N
`execLookupOption`	Instance Lookup Option	If `operation` is Run Task Instance Command; Specification for how to search for the task instance to run a command against.	Valid values: As String = Instance Name, As Value = 1 As String = Instance Name/Task, As Value = 2 As String = Instance Id, As Value = 3 As String = Task, As Value = 4 Default is Instance Name (1).	N
`execName`	Instance Name	If `execLookupOption` is Instance Name or Instance Name/Task; Name of the task instance to run the command against.	Variables are supported.	Y
`execWorkflowNameCond`	Workflow Instance Name Condition	If `operation` is Run Task Instance Command; Type of condition for the name of the parent workflow task instance that contains the task on which to perform the specified action. The action will be performed only on a task instance in a parent workflow task instance meeting the specified condition value.	Valid values: As String = Equals, As Value = 1 As String = Start With, As Value = 2 As String = Contains, As Value = 3 As String = Ends With, As Value = 4 Default is Equals (1).	N
`execWorkflowName`	Workflow Instance Name <Condition Value>	Value for `execWorkflowNameCond`.		Y
`exitCodes`	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 `status`. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30	N
`limit`	Limit	If `operation` is Set Agent Task Execution Limit or Set Cluster Task Execution Limit, and `taskLimitType` is Limited; Number of tasks that can be run concurrently by the specified Agent / Agent Cluster.	Integer	N
`inheritance`	Action Inheritance	For Workflow tasks only; Records that this action applies to.	Valid values: As String = Self, As Value = 1 As String = Self/Children, As Value = 2 As String = Children, As Value = 3 Default is Self (1).	N
`name`	Name	Name of a variable to override.		N
`notificationOption`	System Notification	Status of the specified `operation` that will trigger a system notification.	Valid values: As String = -- None --, As Value = 0 As String = Operation Failure, As Value = 1 As String = Operation Success/Failure, As Value = 2 As String = Operation Success, As Value = 3 Default is Operation Failure (1).	N
`notifyOnEarlyFinish`	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
`notifyOnLateFinish`	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
`notifyOnLateStart`	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
`notifyOnProjectedLate`	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
`operation`	System Operation	System operation to perform.	Valid values: As String = Suspend Agent, As Value = 1 As String = Resume Agent, As Value = 2 As String = Suspend Agent Cluster, As Value = 3 As String = Resume Agent Cluster, As Value = 4 As String = Suspend Cluster Membership, As Value = 5 As String = Resume Cluster Membership, As Value = 6 As String = Set Agent Task Execution Limit, As Value = 7 As String = Set Cluster Task Execution Limit, As Value = 8 As String = Set Virtual Resource Limit, As Value = 9 As String = Run Task Instance Command, As Value = 10 As String = Launch Task, As Value = 11 As String = Trigger Now, As Value = 12 As String = Enable Trigger, As Value = 13 As String = Disable Trigger, As Value = 14 Default is Suspend Agent (1).	N
`overrideTriggerDateOffset`	Override Date Offset	Override date offset.	Date Offset value of trigger to fire.	N (unless `overrideTriggerDateTime` is true)
`overrideTriggerDateTime`	Override Trigger Date/Time	Request parameter to enable/disable override functionality.	Boolean value (true / false). Default is false.	N
`overrideTriggerTime`	Override Time	Override time.	Time of the trigger to fire.	Y (if `overrideTriggerDateTime` is true)
`status`	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
`sysId`	n/a	sys_id used within the Controller to identify this System Operation action.		N
`task`	Task Reference	If `execLookupOption` is Instance Name/Task or Task; Name of the task for which the task instance was run. If `operation` is Launch Task; Name of the task to launch.		N	`taskVar`
`taskLimitType`	Task Execution Limit	If `operation` is Set Agent Task Execution Limit or Set Cluster Task Execution Limit; Specification for whether a limited or unlimited number of task instances can be run concurrently on the specified Agent / Agent Cluster.	Valid values: As String = Unlimited, As Value = 1 As String = Limited, As Value = 2 Default is Unlimited.	N
`taskVar`	Task Reference Variable	If `execLookupOption` is Instance Name/Task or Task; Name of a variable that will be resolved at run time to the name of the task for which the task instance was run. If `operation` is Launch Task; Name of a variable that will be resolved at run time to the name of the task to launch.		N	`task`
`trigger`	Trigger Reference	If `operation` is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger.		N	`triggerVar`
`triggerVar`	Trigger Reference Variable	If `operation` is Trigger Now, Enable Trigger, or Disable Trigger; Name of a variable that will be resolved at run time to the name of the trigger.		N	`trigger`
`value`	Value	Value of a variable to override.		N
`variables`	Override Variables	List of variables to override.		N
`variablesUnresolved`	Override Variables Resolution Disabled	Specification for whether or not `variables` resolution should be disabled to allow for passing unresolved variable values. If `variables` resolution is disabled, any unresolved variables will be resolved in the context of the launched or triggered task instance. If `variables` resolution is not disabled, `variables` will be resolved prior to the execution of the Launch Task or Trigger Now `operation`.	Boolean; Valid values: true/false. Default is false.	N
`virtualResource`	Virtual Resource	If `operation` is Set Virtual Resource Limit; Virtual resource for which a virtual resource limit is to be set.		N	`virtualResourceVar`
`virtualResourceVar`	Virtual Resource Variable	If `operation` is Set Virtual Resource Limit; Name of a variable that will be resolved at run time to the name of the Agent to use.		N	`virtualResource`

Universal Controller 7.2.x

Task Action Properties

Analytics

Abort Action

Email Notification Action

Set Variable Action

SNMP Notification Action

System Operation Action

Related content