Universal Command Task
Before You Begin
The Universal Command task allows you to run a platform-specific application on a machine where Universal Agent is running. Universal Command is functionality provided by the Agent that serves as an agent process. Universal Command runs on any supported platform: z/OS, Linux/Unix, and Windows.
To run a Universal Command task, you must first complete the following:
Install an Agent on the target machine.
Launch the Agent. When the Agent connects with the Controller, it automatically creates an Agent resource definition in the Controller database.
Note
If you are running multiple ubroker started tasks and want to run a Universal Command task on a specific ubroker, you must specify the service port number associated with that ubroker in the Universal Command Options field on the Universal Command Task Details. The syntax is -port nnnn.
Built-In Variables
The following built-in variables can be used in a Universal Command task to pass data where appropriate:
Creating a Universal Command Task
Step 1 | From the Automation Center navigation pane, select Tasks > Universal Command Tasks. The Universal Command Tasks list displays a list of all currently defined Universal Command tasks. |
|---|---|
Step 2 | Enter/select Details for a new Universal Command 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 button. The task is added to the database, and all buttons and tabs in the 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 Command Task Details
The following Universal Command Task Details is for an existing Universal Command task.
Depending on the values that you enter / select for these fields, and whether or not the Universal Command 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 Command Task Details.
Universal Command Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Universal Command Task Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task. |
Name | User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks. |
Version | System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning. |
Description | Description of this record. Maximum length is 255 characters. |
Member of Business Services | User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
Resolve Name Immediately | If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time. |
Time Zone Preference | User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
Hold on Start |
If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it. |
Hold Reason |
Information about why the task will be put on hold when it starts. |
Virtual Resource Priority | |
Hold Resources on Failure | |
Mutually Exclusive With Self | |
Simulate | |
Override Previous Instance Wait | |
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster | |
Utility Agent | |
Utility Agent Variable | |
Utility Agent Cluster | |
Utility Agent Cluster Variable | |
Utility Credentials | |
Utility Credentials Variable | |
Universal Command Details | This section contains assorted detailed information about the task. |
UCMD Agent | |
UCMD Agent Option | |
UCMD Credentials | |
UCMD Credentials Variable | |
Command or Script | |
Command | |
Script File | |
Script Options | |
UCMD Options | |
Runtime Directory | |
Result Processing Details | This section contains assorted detailed information about result processing for this task. |
Exit Code Processing | |
Output Type | |
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 | |
Self-Service Options | This section contains Self-Service specifications for the task. |
Enforce Variables | |
Lock Variables | |
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. |
Save | Saves a new task 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. |