Creating a Universal Task
Before You Begin
Universal Task allows you to run a platform-specific application on a Linux/Unix or Windows machine. To run a Universal task, you must first complete the following tasks:
Install Universal Agent for Linux/Unix on a Linux/Unix machine and/or install Universal Agent for Windows on a Windows machine.
Launch the Agent(s). When an Agent connects with the Controller, it automatically creates an Agent resource definition in the database.
Optionally, customize the Agent heartbeat and log levels, as described in:
Built-In Variables
In addition to the system-assigned variables in the Universal Template script that a Universal task executes, the following built-in variables can be used in a Universal task to pass data where appropriate:
Creating a Universal Task
Step 1 | From the Universal Tasks section of the Automation Center navigation pane, select a Universal Task type. The Universal Tasks list for that Universal Task type displays. |
|---|---|
Step 2 | Enter / select Details for a new Universal Task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click a Save button. The task is added to the database, and all buttons and tabs in the Universal Task Details are enabled. |
Note
To open an existing record on the list, either:
Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).
Universal Task Details
The following Universal Task Details is for an existing Universal task.
Depending on the values that you enter / select for these fields, and whether or not the Universal Task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Universal Task Details.
Universal Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Universal Task Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task. |
Name | |
Version | |
Description | |
Member of Business Services | |
Resolve Name Immediately | |
Time Zone Preference | |
Hold on Start | |
Hold Reason | |
Virtual Resource Priority | |
Hold Resources on Failure | |
Agent Details | This section contains assorted detailed information about the Agent. |
Agent | |
Agent Cluster | |
Agent Variable | |
Agent Cluster Variable | |
Credentials | |
Credentials Variable | |
Cluster Broadcast | |
Cluster Broadcast Variable | |
Run with Highest Privileges | For Windows Agents; Execute the task using an elevated privileges token, rather than one subject to User Account Control (UAC) restrictions. An elevated token allows a process to execute with all the privileges available to its specified credentials. For example, a task executed with an administrative account will behave as though it received permission via a UAC dialog to perform a privileged operation. Note This option only will affect tasks executed on Windows systems that support User Account Control (UAC). It will have no affect on tasks run on Windows releases prior to Vista (for example, Windows XP, Server 2003). |
Universal Task Details | This section contains assorted detailed information about the Agent. Note The fields in this section may have Read Only or Hidden restrictions applied to them, as specified in the Universal Template on which the Universal Task is based. |
(user-defined fields) | |
Runtime Directory | |
Environment Variables | |
Result Processing Details | This section contains assorted detailed information about result processing for this task. |
Exit Code Processing | |
Output Type | |
Content Type | If Output Type is Extension; Output type that the Result Processing mechanism should assume when evaluating the output. If the expected output is XML or JSON, it is valid to specify Text. However, when specifying XML or JSON, the output must be XML or JSON respectively; otherwise, the parsing will fail and the path expression evaluation will return no matches. |
Path Expression | XPath Expression if Content Type is XML, or the JsonPath Expression if Content Type is JSON, to be used when evaluating the Extension output. |
Operator | If Output Type is Extension; Condition Operator to evaluate in combination with the specified condition Value. |
Value | If Output Type is Extension; Condition Value to evaluate in combination with the specified condition Operator. |
Strategy | If Content Type is XML or JSON; Strategy to take when applying the condition Operator and Value against the Path Expression matches when Content Type is XML or JSON. |
Auto Cleanup | Enables the auto cleanup of Extension output upon task instance completion or, if the task instance is within a workflow, when the top level workflow instance completes. |
Scan Output For | |
Output File (for Exit Code Processing) | |
Exit Codes | |
Automatic Output Retrieval | |
Wait For Output | |
Failure Only | |
Start Line | |
Number of Lines | |
Scan Text | |
Output File (for Automatic Output Retrieval) | |
Retry Options | This section contains specifications for retrying the task. |
Retry Exit Codes | |
Maximum Retries | |
Retry Indefinitely | |
Retry Interval (Seconds) | |
Suppress Intermediate Failures | |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | |
Wait Time | |
Wait Day Constraint | |
Wait Duration | |
Wait Duration In Seconds | |
Delay On Start | |
Delay Duration | |
Delay Duration In Seconds | |
Workflow Only | |
Time Options | This section contains time-related specifications for the task. |
Late Start | |
Late Start Type | |
Late Start Time | |
Late Start Day Constraint | |
Late Start Nth Amount | |
Late Start Duration | |
Late Finish | |
Late Finish Type | |
Late Finish Offset Type | |
Late Finish Percentage Offset ( + ) | |
Late Finish Duration Offset ( + ) | |
Late Finish Duration Offset Unit | |
Late Finish Time | |
Late Finish Day Constraint | |
Late Finish Nth Amount | |
Late Finish Duration | |
Early Finish | |
Early Finish Type | |
Early Finish Offset Type | |
Early Finish Percentage Offset ( - ) | |
Early Finish Duration Offset ( - ) | |
Early Finish Duration Offset Unit | |
Early Finish Time | |
Early Finish Day Constraint | |
Early Finish Nth Amount | |
Early Finish Duration | |
User Estimated Duration | |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | |
CP Duration (Resolved) | |
CP Duration Unit | |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | |
Restriction Period | |
Before Date | |
Before Time | |
After Date | |
After Time | |
Date List | |
Statistics | This section contains time-related statistics for task instances of the task. |
First Execution | |
Last Execution | |
Last Instance Duration | |
Lowest Instance Time | |
Average Instance Time | |
Highest Instance Time | |
Number of Instances | |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Buttons | This section identifies the buttons displayed above and below the Task Details that let you perform various actions. |