Page Comparison

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

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

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

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 of this System Operation action.

N

Command

If operation is Run Task Instance Command; Type of task instance command to run.

N

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.

N

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

Instance Lookup Option

If operation is Run Task Instance Command; Specification for how to search for the task instance to run a command against.

N

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

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.

N

Workflow Instance Name <Condition Value>

Value for execWorkflowNameCond.

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 status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

N

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

Action Inheritance

For Workflow tasks only; Records that this action applies to.

N

Name

Name of a variable to override.

N

System Notification

Status of the specified operation that will trigger a system notification.

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

System Operation

System operation to perform.

N

Override date offset.

Date Offset value of trigger to fire.

Request parameter to enable/disable override functionality.

Boolean value (true / false).  Default is false.

Time of the trigger to fire.

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

• 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

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.

N

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 Reference

If operation is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger.

N

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 of a variable to override.

N

Override Variables

List of variables to override.

N

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

vertexSelection

Vertex Selection

If operation is Trigger Now or Launch Task; Specifies if the vertex selection can be enabled.

Boolean; Valid Values: true/false

N

vertices

Vertices

If operation is Trigger Now or Launch Task; Specifies Root Vertices and/or Specific Vertices to be included in the launched workflow.

A vertex can be specified by taskName and vertexId.

If you specify a vertexId, then only a single vertex will match, whereas, if vertexId is “Any”, any vertex matching by taskName will be selected.

To indicate a vertex selection is a Root Vertex, set root to true. If root is unspecified or false, it indicates a vertex selection is a Specific Vertex.

XML

<vertices>
  <vertex root="true">
    <taskName>JOB_A</taskName>
  </vertex>
  <vertex>
    <vertexName>JOB_B</vertexName>
  </vertex>
  <vertex root="false">
    <vertexId>10</vertexId>
  </vertex>
</vertices>

JSON

"vertices": [
  {
    "taskName": "JOB_A",
    "root": true
  },
  {
    "vertexName": "JOB_B"
  },
  {
    "vertexId": "10",
    "root": false
  }
]

N

Virtual Resource

If operation is Set Virtual Resource Limit; Virtual resource for which a virtual resource limit is to be set.

N

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