Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<ul> <li>
  • Suspend
  • Agent
<li>
  • Resume
  • Agent
<li>
  • Suspend
  • Agent
  • Cluster
<li>
  • Resume
  • Agent
  • Cluster
<li>
  • Suspend
  • Cluster
  • Membership
<li>
  • Resume
  • Cluster
  • Membership
<li>
  • Set
  • Agent
  • Task
  • Execution
  • Limit
<li>
  • Set
  • Cluster
  • Task
  • Execution
  • Limit
<li>
  • Set
  • Virtual
  • Resource
  • Limit
<li>
  • Run
  • Task
  • Instance
  • Command
<li>
  • Launch
  • Task
<li>
  • Trigger
  • Now
<li>
  • Enable
  • Trigger
<li>
  • Disable
  • Trigger
</ul>

Field Name

Description

Action Criteria

This section contains criteria for performing the action.

Anchor
Action Inheritance
Action Inheritance
Action Inheritance

Include Page
IL:Action Inheritance - 6.4.1
IL:Action Inheritance - 6.4.1

Anchor
Status
Status
Status

The 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.

Anchor
Exit Codes
Exit Codes
Exit Codes

Include Page
IL:Exit Codes Trigger Actions
IL:Exit Codes Trigger Actions

Anchor
On Late Start
On Late Start
On Late Start

Include Page
IL:On Late Start
IL:On Late Start

Anchor
On Late Finish
On Late Finish
On Late Finish

Include Page
IL:On Late Finish
IL:On Late Finish

Anchor
On Early Finish
On Early Finish
On Early Finish

Include Page
IL:On Early Finish
IL:On Early Finish

Anchor
On Projected Late
On Projected Late
On Projected Late

Include Page
IL:On Projected Late
IL:On Projected Late

Anchor
Description
Description
Description

Description of this action.

Action Details

This section contains additional details about the action.

Anchor
System Operation
System Operation
System Operation

Specific system operation to perform.
 
Options:

Html bobswift
Note
titleNote

For the Suspend Agent and Resume Agent operations, the user must have the following Agent permissions:

For the Suspend Agent Cluster, Resume Agent Cluster, Suspend Agent Cluster Membership, and Resume Agent Cluster Membership operations, the user must have the following Agent Cluster permissions:


Anchor
System Notification
System Notification
System Notification

Status of the specified system operation (see above) that will trigger a system notification.
 
Options:

Html bobswift<ul> <li> None <li> Operation Failure
  • None
  • Operation Failure (default)
<li>
  • Operation
  • Success/Failure
<li>
  • Operation
  • Success
</ul>
Note
titleNote

The Controller must be configured for system notifications in order for system notifications to be triggered.


Anchor
Agent
Agent
Agent

If System 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.

Anchor
Agent Variable
Agent Variable
Agent Variable

If System Operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit:
 
If enabled, the Agent field converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions.

Anchor
Agent Cluster
Agent Cluster
Agent Cluster

If System 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.

Anchor
Agent Cluster Variable
Agent Cluster Variable
Agent Cluster Variable

If System Operation is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit;
 
If enabled, the Agent Cluster field converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. Use the format:

Html bobswift

 ${variable

name}.

The variable must be a supported type as described in Variables and Functions.

Anchor
Task Execution Limit
Task Execution Limit
Task Execution Limit

If System 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. (Default is Unlimited.)

Anchor
Virtual Resource
Virtual Resource
Virtual Resource

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

Note
titleNote

If the Strict Business Service Membership Read Constraints Universal Controller system property is true, the drop-down list displays only Virtual Resources for which the user has explicit Read permission.


Anchor
Virtual Resource Variable
Virtual Resource Variable
Virtual Resource Variable

If System Operation is Set Virtual Resource Limit; the Virtual Resource field (if enabled) converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. Use the format:

Html bobswift

${variable

name}.

 

The variable must be a supported type as described in Variables and Functions.

Anchor
Limit
Limit
Limit

If System Operation is Set Agent Task Execution Limit or Set Cluster Task Execution Limit, and Task Execution Limit is Limited; Number of tasks that can be run concurrently by the specified Agent / Agent Cluster.
 
If System Operation is Set Virtual Resource Limit; Virtual resource limit to be set for the specified virtual resource.

Anchor
Command
Command
Command

If System Operation is Run Task Instance Command; Type of task instance command to run.
 
Options:

  • Cancel
  • Force Finish
  • Force Finish (Halt)
  • Force Finish/Cancel
  • Force Finish/Cancel (Halt)
  • Skip
  • Skip Path
  • Unskip
  • Hold
  • Release
  • Release Recursive
  • Clear All Dependencies
  • Clear Exclusive
  • Clear Predecessors
  • Clear Resources
  • Clear Timewait
  • Re-run
     

    Warning
    titleCaution

    If you choose to re-run a task instance, care must be taken to not create unintended loop situations. For example, if a task contains a System Operation that specifies the re-run of that same task if the task instance ends in the Failed status, this will cause an endless loop of re-runs. If the task also contains a System Notification / Email Notification that sends an email if the task instance ends in Failed status, the emails could flood the recipient's mail server.


Anchor
Workflow Instance Name Condition
Workflow Instance Name Condition
Workflow Instance Name Condition

If System Operation is Run Task Instance Command; Optional. 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.
 
Options:

Html bobswift<ul> <li> Equals <li> Starts With <li> Contains <li> Ends With </ul>
  • Equals
  • Starts With
  • Contains
  • Ends With

For the selected condition (the default is Equals), a corresponding field displays (see below) that allows you to enter a value for that condition.

Anchor
Workflow Instance Name Equals
Workflow Instance Name Equals
Workflow Instance Name Equals

If Workflow Instance Name Condition = Equals; Exact name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Workflow Instance Name Starts With
Workflow Instance Name Starts With
Workflow Instance Name Starts With

If Workflow Instance Name Condition = Starts With; Character string at the start of the name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Workflow Instance Name Contains
Workflow Instance Name Contains
Workflow Instance Name Contains

If Workflow Instance Name Condition = Contains; Character string in the name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Workflow Instance Name Ends With
Workflow Instance Name Ends With
Workflow Instance Name Ends With

If Workflow Instance Name Condition = Ends With; Character string at the end of the name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Instance Lookup Option
Instance Lookup Option
Instance Lookup Option

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

  • Instance Name
  • Instance Name/Task
  • Instance Id
  • Task

Anchor
Instance Name
Instance Name
Instance Name

If Instance Lookup Option is Instance Name or Instance Name/Task; Required. Name of the task instance to run the command against. Variables supported.

Anchor
Instance Criteria
Instance Criteria
Instance Criteria

If Instance Lookup Option is Instance Name, Instance Name/Task, or Task; Additional criteria for selecting a specific task instance if multiple task instances have matching names.

html-bobswift

<ul> <li>

  • Oldest
  • Active
  • Instance
  • (default)
<li>
  • Newest
  • Active
  • Instance
<li>
  • Newest
  • Instance
  • (Re-run
  • and
  • Unskip
  • commands
  • only)
<li>
  • Oldest
  • Instance
  • (Re-run
  • and
  • Unskip
  • commands
  • only)
</ul>

(An Active task instance is an instance that is not in any of these statuses: Skipped, Finished, Success.)

Anchor
Task Reference
Task Reference
Task Reference

Anchor
Task Reference Variable
Task Reference Variable
Task Reference Variable

If Instance Lookup Option is Instance Name/Task or Task, or if System Operation is Launch Task; the Task field (above) converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions.

Anchor
Instance Id
Instance Id
Instance Id

If Instance Lookup Option 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.

Anchor
Trigger
Trigger
Trigger Reference

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

Trigger Reference Variable

If System Operation is Trigger Now, Enable Trigger, or Disable Trigger; Indication of whether the Trigger Reference field is a reference field for selecting a specific Trigger (unchecked) or is a text field for specifying the trigger as a variable (checked). For a variable, use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions.

Override Variables

If System Operation is Launch Task or Trigger Now; Variables to override.

Override Variables Resolution Disabled

If System Operation is Launch Task or Trigger Now; Indication of whether or not Override Variables resolution should be disabled to allow for passing unresolved variable values.

  • If enabled (checked), Override Variables will be left unresolved. Any unresolved variables will be resolved in the context of the launched or triggered task instance.
  • If disabled (unchecked), Override Variables will be resolved prior to the execution of the Launch Task or Trigger Now System Operation.

Anchor
Override Trigger Date Time
Override Trigger Date Time
Override Trigger Date/Time

If System Operation is Trigger Now, Indication of whether or not to override the date/time of the trigger.Override Date OffsetIf Override Trigger Date Time is selected; Override date offset.Override TimeIf Override Trigger Date Time is selected; Override time.

Buttons

This section identifies the buttons displayed above and below the Action Details that let you perform various actions.

Save

Saves a new Action record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new record.

Update

Include Page
IL:Update button
IL:Update button

Delete

Include Page
IL:Delete button
IL:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

Closes the Details pop-up of this action.

...