Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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:

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.
 
Below the list, Universal Command Task Details for a new Universal Command task displays.
 

Step 2

Enter/select Details for a new Universal Command task, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the New button above the list to display a pop-up version of the Details.

Step 3

Click a Save 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

Unable to render {include} The included page could not be found.

Version

Unable to render {include} The included page could not be found.

Description

Unable to render {include} The included page could not be found.

Member of Business Services

Unable to render {include} The included page could not be found.

Resolve Name Immediately

Unable to render {include} The included page could not be found.

Time Zone Preference

Unable to render {include} The included page could not be found.

Hold on Start

Unable to render {include} The included page could not be found.

Hold Reason

Unable to render {include} The included page could not be found.

Virtual Resource Priority

Unable to render {include} The included page could not be found.

Hold Resources on Failure

Unable to render {include} The included page could not be found.

Agent Details

This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.

Cluster

Unable to render {include} The included page could not be found.

Utility Agent

Unable to render {include} The included page could not be found.

Utility Agent Variable

Unable to render {include} The included page could not be found.

Utility Agent Cluster

Unable to render {include} The included page could not be found.

Utility Agent Cluster Variable

Unable to render {include} The included page could not be found.

Utility Credentials

Unable to render {include} The included page could not be found.

Utility Credentials Variable

Unable to render {include} The included page could not be found.

Universal Command Details

This section contains assorted detailed information about the task.

UCMD Agent

Unable to render {include} The included page could not be found.

UCMD Agent Option

Unable to render {include} The included page could not be found.

UCMD Credentials

Unable to render {include} The included page could not be found.

UCMD Credentials Variable

Unable to render {include} The included page could not be found.

Command or Script

Unable to render {include} The included page could not be found.

Command

Unable to render {include} The included page could not be found.

Script File

Unable to render {include} The included page could not be found.

Script Options

Unable to render {include} The included page could not be found.

UCMD Options

Unable to render {include} The included page could not be found.

Runtime Directory

Unable to render {include} The included page could not be found.

Result Processing DetailsThis section contains assorted detailed information about result processing for this task.

Exit Code Processing

Unable to render {include} The included page could not be found.

Output Type

Unable to render {include} The included page could not be found.

Scan Output For

Unable to render {include} The included page could not be found.

Output File (for Exit Code Processing)

Unable to render {include} The included page could not be found.

Exit Codes

Unable to render {include} The included page could not be found.

Automatic Output Retrieval

Unable to render {include} The included page could not be found.

Wait For Output

Unable to render {include} The included page could not be found.

Failure Only

Unable to render {include} The included page could not be found.

Start Line

Unable to render {include} The included page could not be found.

Number of Lines

Unable to render {include} The included page could not be found.

Scan Text

Unable to render {include} The included page could not be found.

Output File (for Automatic Output Retrieval)

Unable to render {include} The included page could not be found.

Retry Options

This section contains specifications for retrying the task.

Retry Exit Codes

Unable to render {include} The included page could not be found.

Maximum Retries

Unable to render {include} The included page could not be found.

Retry Indefinitely

Unable to render {include} The included page could not be found.

Retry Interval (Seconds)

Unable to render {include} The included page could not be found.

Suppress Intermediate Failures

Unable to render {include} The included page could not be found.

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Unable to render {include} The included page could not be found.

Wait Time

Unable to render {include} The included page could not be found.

Wait Day Constraint

Unable to render {include} The included page could not be found.

Wait Duration

Unable to render {include} The included page could not be found.

Wait Duration In Seconds

Unable to render {include} The included page could not be found.

Delay On Start

Unable to render {include} The included page could not be found.

Delay Duration

Unable to render {include} The included page could not be found.

Delay Duration In Seconds

Unable to render {include} The included page could not be found.

Workflow Only

Unable to render {include} The included page could not be found.

Time Options

This section contains time-related specifications for the task.

Late Start

Unable to render {include} The included page could not be found.

Late Start Type

Unable to render {include} The included page could not be found.

Late Start Time

Unable to render {include} The included page could not be found.

Late Start Day Constraint

Unable to render {include} The included page could not be found.

Late Start Nth Amount

Unable to render {include} The included page could not be found.

Late Start Duration

Unable to render {include} The included page could not be found.

Late Finish

Unable to render {include} The included page could not be found.

Late Finish Type

Unable to render {include} The included page could not be found.

Late Finish Offset Type

Unable to render {include} The included page could not be found.

Late Finish Percentage Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Late Finish Time

Unable to render {include} The included page could not be found.

Late Finish Day Constraint

Unable to render {include} The included page could not be found.

Late Finish Nth Amount

Unable to render {include} The included page could not be found.

Late Finish Duration

Unable to render {include} The included page could not be found.

Early Finish

Unable to render {include} The included page could not be found.

Early Finish Type

Unable to render {include} The included page could not be found.

Early Finish Offset Type

Unable to render {include} The included page could not be found.

Early Finish Percentage Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Early Finish Time

Unable to render {include} The included page could not be found.

Early Finish Day Constraint

Unable to render {include} The included page could not be found.

Early Finish Nth Amount

Unable to render {include} The included page could not be found.

Early Finish Duration

Unable to render {include} The included page could not be found.

User Estimated Duration

Unable to render {include} The included page could not be found.

Critical Path Options

This section contains Critical Path-related specifications for the task.

CP Duration

Unable to render {include} The included page could not be found.

CP Duration (Resolved)

Unable to render {include} The included page could not be found.

CP Duration Unit

Unable to render {include} The included page could not be found.

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Unable to render {include} The included page could not be found.

Restriction Period

Unable to render {include} The included page could not be found.

Before Date

Unable to render {include} The included page could not be found.

Before Time

Unable to render {include} The included page could not be found.

After Date

Unable to render {include} The included page could not be found.

After Time

Unable to render {include} The included page could not be found.

Date List

Unable to render {include} The included page could not be found.

Statistics

This section contains time-related statistics for task instances of the task.

First Execution

Unable to render {include} The included page could not be found.

Last Execution

Unable to render {include} The included page could not be found.

Last Instance Duration

Unable to render {include} The included page could not be found.

Lowest Instance Time

Unable to render {include} The included page could not be found.

Average Instance Time

Unable to render {include} The included page could not be found.

Highest Instance Time

Unable to render {include} The included page could not be found.

Number of Instances

Unable to render {include} The included page could not be found.

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.

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

Update

Unable to render {include} The included page could not be found.

Launch Task

Unable to render {include} The included page could not be found.

View Parents

Unable to render {include} The included page could not be found.

Copy

Creates a copy of this task, which you are prompted to rename.

Delete

Unable to render {include} The included page could not be found.

Note

You cannot delete a task if it is either:

  • Specified in an enabled Trigger.
  • The only task specified in a disabled Trigger.

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task.

Tabs

This section identifies the tabs across the top of the Task Details that provide access to additional information about the task.

Variables

Unable to render {include} The included page could not be found.

Actions

Unable to render {include} The included page could not be found.

Virtual Resources

Unable to render {include} The included page could not be found.

Mutually Exclusive

Unable to render {include} The included page could not be found.

Instances

Lists all instances of the task.

Triggers

Unable to render {include} The included page could not be found.

Notes

Unable to render {include} The included page could not be found.

Versions

Unable to render {include} The included page could not be found.

Viewing a Universal Command Task Instance

When a Universal Command task is launched, the Controller creates a task instance record of that task.

A task instance contains detailed information about a single execution of that task.

You can access a task instance from:

Universal Command Task Instance Details

The following Universal Command Task Instance Details contains information on the execution of the task shown in the Universal Command Task Details.
 

Universal Command Task Instance Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in Universal Command Task Instance Details.
 

Field Name

Description

General

This section contains general information about the task instance.

Instance Name

Name of this task instance.

Instance Number

Unable to render {include} The included page could not be found.

Description

Unable to render {include} The included page could not be found.

Member of Business Services

Unable to render {include} The included page could not be found.

Task

Unable to render {include} The included page could not be found.

Source Version

Unable to render {include} The included page could not be found.

Launch Source

Unable to render {include} The included page could not be found.

Source Instance

Unable to render {include} The included page could not be found.

Invoked by

Unable to render {include} The included page could not be found.

Execution User

Unable to render {include} The included page could not be found.

Calendar

Unable to render {include} The included page could not be found.

Time Zone Preference

Unable to render {include} The included page could not be found.

Virtual Resource Priority

Unable to render {include} The included page could not be found.

Hold Resources on Failure

Unable to render {include} The included page could not be found.

Status

This section contains information about the current status of the task instance.

Status

Unable to render {include} The included page could not be found.

Exit Code

Unable to render {include} The included page could not be found.

Status Description

Unable to render {include} The included page could not be found.

Operational Memo

Unable to render {include} The included page could not be found.

Evaluation Time

Unable to render {include} The included page could not be found.

Critical

Unable to render {include} The included page could not be found.

Wait Until Time

Unable to render {include} The included page could not be found.

Queued Time

Unable to render {include} The included page could not be found.

Trigger Time

Unable to render {include} The included page could not be found.

Launch Time

Unable to render {include} The included page could not be found.

Start Time

Unable to render {include} The included page could not be found.

End Time

Unable to render {include} The included page could not be found.

Duration

Unable to render {include} The included page could not be found.

Agent Details

This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.

Cluster

Unable to render {include} The included page could not be found.

Utility Agent

Unable to render {include} The included page could not be found.

Utility Agent Variable

Unable to render {include} The included page could not be found.

Utility Agent Cluster

Unable to render {include} The included page could not be found.

Utility Agent Cluster Variable

Unable to render {include} The included page could not be found.

Utility Credentials

Unable to render {include} The included page could not be found.

Utility Credentials Variable

Unable to render {include} The included page could not be found.

Universal Command Details

This section contains assorted detailed information about the task instance.

UCMD Agent

Unable to render {include} The included page could not be found.

UCMD Agent Option

Unable to render {include} The included page could not be found.

UCMD Credentials

Unable to render {include} The included page could not be found.

UCMD Credentials Variable

Unable to render {include} The included page could not be found.

Command or Script

Unable to render {include} The included page could not be found.

Command

Unable to render {include} The included page could not be found.

Script File

Unable to render {include} The included page could not be found.

Script Options

Unable to render {include} The included page could not be found.

UCMD Options

Unable to render {include} The included page could not be found.

Runtime Directory

Unable to render {include} The included page could not be found.

Result Processing DetailsThis section contains assorted detailed information about result processing for this task.

Exit Code Processing

Unable to render {include} The included page could not be found.

Output Type

Unable to render {include} The included page could not be found.

Scan Output For

Unable to render {include} The included page could not be found.

Output File (for Exit Code Processing)

Unable to render {include} The included page could not be found.

Exit Codes

Unable to render {include} The included page could not be found.

Automatic Output Retrieval

Unable to render {include} The included page could not be found.

Wait For Output

Unable to render {include} The included page could not be found.

Failure Only

Unable to render {include} The included page could not be found.

Start Line

Unable to render {include} The included page could not be found.

Number of Lines

Unable to render {include} The included page could not be found.

Scan Text

Unable to render {include} The included page could not be found.

Output File (for Automatic Output Retrieval)

Unable to render {include} The included page could not be found.

Retry Options

This section contains specifications for retrying the task.

Retry Exit Codes

Unable to render {include} The included page could not be found.
.

Maximum Retries

Unable to render {include} The included page could not be found.

Retry Indefinitely

Unable to render {include} The included page could not be found.

Retry Interval (Seconds)

Unable to render {include} The included page could not be found.

Current Retry Count

Unable to render {include} The included page could not be found.

Suppress Intermediate Failures

Unable to render {include} The included page could not be found.

Next Retry Time

Unable to render {include} The included page could not be found.

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Unable to render {include} The included page could not be found.

Wait Time

Unable to render {include} The included page could not be found.

Wait Day Constraint

Unable to render {include} The included page could not be found.

Wait Duration

Unable to render {include} The included page could not be found.

Wait Duration In Seconds

Unable to render {include} The included page could not be found.

Delay On Start

Unable to render {include} The included page could not be found.

Delay Duration

Unable to render {include} The included page could not be found.

Delay Duration In Seconds

Unable to render {include} The included page could not be found.

Time Options

This section contains time-related specifications for the task instance.

Late Start

Unable to render {include} The included page could not be found.

Started Late

Unable to render {include} The included page could not be found.

Late Start Type

Unable to render {include} The included page could not be found.

Late Start Time

Unable to render {include} The included page could not be found.

Late Start Day Constraint

Unable to render {include} The included page could not be found.

Late Start Nth Amount

Unable to render {include} The included page could not be found.

Late Start Duration

Unable to render {include} The included page could not be found.

Computed Late Start Time

Unable to render {include} The included page could not be found.

Late Finish

Unable to render {include} The included page could not be found.

Finished Late

Unable to render {include} The included page could not be found.

Late Finish Type

Unable to render {include} The included page could not be found.

Late Finish Offset Type

Unable to render {include} The included page could not be found.

Late Finish Percentage Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Late Finish Time

Unable to render {include} The included page could not be found.

Late Finish Day Constraint

Unable to render {include} The included page could not be found.

Late Finish Nth Amount

Unable to render {include} The included page could not be found.

Late Finish Duration

Unable to render {include} The included page could not be found.

Computed Late Finish Time

Unable to render {include} The included page could not be found.

Early Finish

Unable to render {include} The included page could not be found.

Finished Early

Unable to render {include} The included page could not be found.

Early Finish Type

Unable to render {include} The included page could not be found.

Early Finish Offset Type

Unable to render {include} The included page could not be found.

Early Finish Percentage Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Early Finish Time

Unable to render {include} The included page could not be found.

Early Finish Day Constraint

Unable to render {include} The included page could not be found.

Early Finish Nth Amount

Unable to render {include} The included page could not be found.

Early Finish Duration

Unable to render {include} The included page could not be found.

Projected Late

Unable to render {include} The included page could not be found.

Critical Path Options

This section contains Critical Path-related specifications for the task.

CP Duration

Unable to render {include} The included page could not be found.

CP Duration (Resolved)

Unable to render {include} The included page could not be found.

CP Duration Unit

Unable to render {include} The included page could not be found.

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Unable to render {include} The included page could not be found.

Restriction Period

Unable to render {include} The included page could not be found.

Before Date

Unable to render {include} The included page could not be found.

Before Time

Unable to render {include} The included page could not be found.

After Date

Unable to render {include} The included page could not be found.

After Time

Unable to render {include} The included page could not be found.

Date List

Unable to render {include} The included page could not be found.

Statistics

This section contains time-related statistics for the task instance.

User Estimated End Time

Unable to render {include} The included page could not be found.

Lowest Estimated End Time

Unable to render {include} The included page could not be found.

Average Estimated End Time

Unable to render {include} The included page could not be found.

Highest Estimated End Time

Unable to render {include} The included page could not be found.

Projected End Time

System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration.

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.

Status History

History of all statuses that the task instance has gone through.

Buttons

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

Update

Unable to render {include} The included page could not be found.

Force Finish

Unable to render {include} The included page could not be found.

Hold

Unable to render {include} The included page could not be found.

Skip

Unable to render {include} The included page could not be found.

Re-run

Unable to render {include} The included page could not be found.

View Parent

Unable to render {include} The included page could not be found.

Retrieve Output

Unable to render {include} The included page could not be found.

Delete

Unable to render {include} The included page could not be found.

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task instance.

Tabs

This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance.

Virtual Resources

Unable to render {include} The included page could not be found.

Exclusive Requests

Unable to render {include} The included page could not be found.

Output

Unable to render {include} The included page could not be found.

Notes

Unable to render {include} The included page could not be found.

Output Redirection

An Agent processes Universal Command, File Transfer/UDM, and SAP task types differently than Windows and Linux/Unix task types. Universal Command, File Transfer/UDM, and SAP command lines are sent to the user process via standard input, so any redirection operators entered as task command input are not processed as expected.

If you want to direct output from a Universal Command task to your file system, the -uagstdio command option lets you specify the same output redirection commands that are available for Windows and Linux/Unix task types. UAG will apply the user-specified value for -uagstdio directly to the command image.

The I/O redirection commands that you can use with -uagstdio are dependent on the OS/command shell. You should be able to set up any redirection that the OS/command shell supports (just as with Windows and Unix/Linux task types).

The syntax of -uagstdio is similar to Universal Command, Universal Data Mover, and Universal Connector command line options; option followed by value.

For the Universal Command task type, you can specify uagstdio in either of the following fields:

-uagstdio Examples


If the -uagstdio value contains spaces, it must be enclose in double quotation marks ( " ):


If the quoted value itself requires double quotation marks, they must be doubled ( "" ):

Running a Universal Command Task

You can run a Universal Command task:

Monitoring Task Execution

You can monitor all system activity from the Activity Monitor and can view activity history from the History list.

  • No labels