Versions Compared

Key

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

...

Field Name

Description

General

This section contains general information about the template.

Name

Name of this Universal Template.

ExtensionIf Template Type is Extension; Python Extension name.

Description

Include Page
IL:Summary
IL:Summary

Anchor
Variable Prefix
Variable Prefix
Variable Prefix

Variable prefix to append to the default prefix (ops_) for the system-assigned variables that are provided for the user-defined Fields in this Universal Template. The format of a system-assigned variable is: ops_, followed by the specified Variable Prefix, followed by the underscore character _, followed by the Name (not the Label) of the user-defined Field. For example: ops_oebs_username.
 
System-assigned variables are meant to be incorporated into the Script specified for the Universal Template. All system-assigned variables embedded in a Universal Template Script will be resolved when the Universal Task created from the template executes the Script.

Anchor
Icon
Icon
Icon

Icon used for all Universal Tasks based on this Universal Template. The icon displays in the following locations:

A default icon displays in the Icon field for every Universal Template (see Universal Template Details, above).
 
If you want to select a custom icon, click the Browse button and then search and select that icon. Any custom icon must be a PNG image, 48 x 48 pixels.
 

Note
titleNote

The button that lets you search for an icon file, and the text message alongside it, is browser-dependent. In this example, which shows a Browse... button and No file selected. text, the browser was Firefox.

 
After you select a custom icon, the file name for that icon displays next to the Browse button. When you save / update the Universal Template, the icon displays in the Icon field, but the file name no longer displays.
 
If you selected a custom icon but want to restore the default icon, right-click anywhere in the Universal Template Details and, in the Action menu, click Restore Default Icon.

Log LevelIf Template Type is Extension; Log Level for Universal Extension logging. Specify Inherited to inherit the Agent Log Level setting

Universal Template Details

This section contains assorted detailed information about the template.

Anchor
Template Type
Template Type
Template Type

Type of Universal Template.

Options:

  • Script
    Universal Template will be executed as a Script.
  • Extension
    Universal Template will be executed through the Universal Extension framework.

Anchor
Send Extension Variables
Send Extension Variables
Send Extension Variables

If Template Type is Extension; Specification for whether the Extension should be provided with task instance variable data when launched.

Options:

  • None
    Do not provide the Extension with task instance variable data.
  • Local
    Provide the Extension with task instance variable data.

Anchor
Agent Type
Agent Type
Agent Type

Type of Agent on which Universal Tasks based on this template can be run.
 
Options:

  • Any
  • Linux/Unix
  • Windows

Anchor
Always Cancel On Force Finish
Always Cancel On Force Finish
Always Cancel On Force Finish

Specification for whether or not to always perform a Cancel when Force Finishing a Universal Task for this template.

Anchor
Use Common Script
Use Common Script
Use Common Script

If Template Type is Script and  Agent Type is Any; Indication that the specified Script can be executed by both Linux/Unix and Windows Agents.

Anchor
Script
Script
Script

If Use Common Script is enabled; Script to be executed by the specified Agent.

Anchor
Linux/Unix Script
Linux/Unix Script
Linux/Unix Script

If Template Type is Script and Agent Type is Linux/Unix or Any (and Use Common Script is not enabled); Script to be executed by the Linux/Unix Agent.

Anchor
Windows Script
Windows Script
Windows Script

If Template Type is Script and Agent Type is Windows or Any (and Use Common Script is not enabled); Script to be executed by the Windows Agent.

Anchor
Windows Script File Type
Windows Script File Type
Windows Script File Type

If Template Type is Script and Agent Type is Windows or Any; Type of Windows script to be executed by the Windows Agent.
 
Options:

  • bat
  • cmd
  • js
  • ps1
  • py
  • uapy
  • vbs
  • wsf
  • Other... (any user-specified script file type)

Anchor
Agent Defaults
Agent Defaults
Agent Defaults

This section contains Agent default fields that will display for every Universal Task based on this template.

Anchor
Cluster
Cluster
Cluster

Include Page
IL:Cluster
IL:Cluster

Anchor
Broadcast
Broadcast
Broadcast

Include Page
IL:Broadcast
IL:Broadcast

Anchor
Agent
Agent
Agent

Name of the Agent resource that identifies the machine where the operation will run.

Anchor
Agent Cluster
Agent Cluster
Agent Cluster

Include Page
IL:Agent Cluster
IL:Agent Cluster

Agent Variable

Include Page
IL:Agent Variable
IL:Agent Variable

Agent Cluster Variable

Include Page
IL:Agent Cluster Variable
IL:Agent Cluster Variable

Anchor
Credentials
Credentials
Credentials

Include Page
IL:Credentials field - 6.4.3.0
IL:Credentials field - 6.4.3.0

Credentials Variable

Include Page
IL:Credentials Variable
IL:Credentials Variable

Cluster Broadcast

Include Page
IL:Cluster Broadcast
IL:Cluster Broadcast

Cluster Broadcast Variable

Include Page
IL:Cluster Broadcast Variable - UTEMP
IL:Cluster Broadcast Variable - UTEMP

Anchor
Run with Highest Privileges
Run with Highest Privileges
Run with Highest Privileges

If Agent Type is Windows or Any; 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.
 
This option will not give a user account privileges that have are not already granted to it. For example, taking ownership of a file is a privileged operation by default. A task will still fail even with this option selected if it is run with a regular user account that has not been granted the ability to change file ownership.
 

Note
titleNote

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


Anchor
Interact with Desktop
Interact with Desktop
Interact with Desktop

If Universal Task Interact with Desktop Permitted system property = true; Specification for whether or not a task that runs an application with a GUI requires some manual actions from a user (for example, clicking buttons or entering values).

Note

When using this option to display GUI applications on any version of Windows that enforces session 0 desktop isolation (that is, Windows Vista and later), the GUI will only be accessible from the interactive console session. Further, the task will execute using the credentials of the user logged into that session.

This means that any GUI-based application executed via a Windows task will not be visible from a remote desktop session. It will be visible only from console of the interactive session that exists on the system itself (that is, the session you would see from a monitor attached directly to the Windows machine or by logging in via a VM's host UI).


Create ConsoleIf Interact with Desktop is enabled; Specification for whether or not to allocate a new console for the process, rather than having it inherit one.

Anchor
Template Defaults
Template Defaults
Template Defaults

This section contains template-specific default fields that will display for every Universal Task based on this template.

Anchor
Runtime Directory
Runtime Directory
Runtime Directory

Include Page
IL:Runtime Directory
IL:Runtime Directory

Environment Variables

Include Page
IL:Environment Variables-Name and Value
IL:Environment Variables-Name and Value

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

Anchor
Exit Code Processing
Exit Code Processing
Exit Code Processing

Include Page
IL:Exit Code Processing
IL:Exit Code Processing

Anchor
Output Type
Output Type
Output Type

Include Page
IL:Output Type-Exit Code
IL:Output Type-Exit Code

Anchor
Content Type
Content 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.

Anchor
Path Expression
Path Expression
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.

Anchor
Operator
Operator
Operator

If  Output Type is Extension; Condition Operator to evaluate in combination with the specified condition Value.

Anchor
Value
Value
Value

If  Output Type is Extension; Condition Value to evaluate in combination with the specified condition Operator.

Anchor
Strategy
Strategy
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.

Anchor
Auto Cleanup
Auto Cleanup
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.

Anchor
Scan Output For
Scan Output For
Scan Output For

Include Page
IL:Scan Output For
IL:Scan Output For

Output File (for Exit Code Processing)

Include Page
IL:Output File-Exit Code
IL:Output File-Exit Code

Anchor
Exit Codes
Exit Codes
Exit Codes

Include Page
IL:Exit Codes
IL:Exit Codes

Anchor
Automatic Output Retrieval
Automatic Output Retrieval
Automatic Output Retrieval

Include Page
IL:Automatic Output Retrieval U & W - 7.0
IL:Automatic Output Retrieval U & W - 7.0

Anchor
Wait For Output
Wait For Output
Wait For Output

Include Page
IL:Wait For Output
IL:Wait For Output

Anchor
Failure Only
Failure Only
Failure Only

Include Page
IL:Failure Only
IL:Failure Only

Start Line

Include Page
IL:Starting Line
IL:Starting Line

Number of Lines

Include Page
IL:Number of Lines
IL:Number of Lines

Scan Text

Include Page
IL:Scan Text-Automatic Output Retrieval
IL:Scan Text-Automatic Output Retrieval

Anchor
Output File - Automatic
Output File - Automatic
Output File (for Automatic Output Retrieval)

Include Page
IL:Output File-Auto Retrieve
IL:Output File-Auto Retrieve

Anchor
Field Restrictions
Field Restrictions
Field Restrictions

This section lets you specify how fields in the Defaults section of the Universal Template are displayed in Universal Tasks based on the template.
 
The Field Restrictions section places the fields in the Default section into five groups, as shown below: Agent, Credential, Environment Variables, Exit Code Processing, Automatic Output Retrieval. All fields in a field group share the same restriction.
 
The Restriction options are the same for each field group:

  • No Restriction
    No restrictions apply to any fields in this group. {This is the default selection for all field groups.)
  • Read Only
    All fields in the field group display as Read Only in the Universal Task.
  • Hidden
    All fields in the field group are hidden in the Universal Task.

    Note
    titleNote

    If the Preserve Value If Hidden field is enabled for a hidden field:

    • The value of that field will not be reset upon an update.
    • Any variable related to that field will resolve to the field value.



Anchor
Agent Fields
Agent Fields
Agent Fields

Restriction for the following Agent fields: Agent, Agent Variable, Agent Cluster, Agent Cluster Variable, and Cluster Broadcast.

Anchor
Credential Fields
Credential Fields
Credential Fields

Restriction for the following Credential fields: Credentials, Credentials Variable, Run with Highest Privileges, and Runtime Directory.

Anchor
Environment Variables Fields
Environment Variables Fields
Environment Variables Fields

Restriction for the following Environment Variable field: Environment Variables.

Anchor
Exit Code Processing Fields
Exit Code Processing Fields
Exit Code Processing Fields

Restriction for the following Exit Code Processing fields: Exit Code Processing, Exit Codes, Output Type, Scan Output for, and Output File.

Anchor
Automatic Output Retrieval Fields
Automatic Output Retrieval Fields
Automatic Output Retrieval Fields

Restriction for the following Automatic Output Retrieval Fields: Automatic Output Retrieval, Wait For Output, Failure Only, Start Line, Number of Lines, Scan Text, and Automatic Output File.

Anchor
Metadata
Metadata
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.

Extension ChecksumSHA-256 checksum for the Python Extension Archive.
Extension VersionVersion of the Extension.
Extension API LevelAPI level that the Extension is compatible with.
Extension Requires PythonPython version(s) that the Python Extension Archive is guaranteed to be compatible with.
Extension Python Extra PathsList of paths to add to the search path for Python modules.
Extension Zip Safe 

When true, specifies the extension should run as a zip file. (default)

When false, specifies the extension should run from a folder with the extracted extension and platform dependency wheel.

Extension OwnerAuthor of the Extension.
Extension OrganizationOrganization of the Author.
Extension Comments(Any comments about the Extension.)

Buttons

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

Save

Saves a new Universal Template record in the Controller database.

Save & New

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

Save & View

Saves a new Universal Template 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

Updates the Universal Template record in the Controller database.

Delete

Delete the currently open Universal Template.

Refresh

Refreshes any dynamic data displayed in the Universal Template Details.

Close

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

Tabs

This section identifies the tabs across the top of the Universal Template Details that provide access to additional information about the template.

Fields

Allows you to create the user-defined fields that will display in the Universal Tasks based on this template.

CommandsIf Template Type is Extension; additional commands (operations) supported against a task instance (see Creating Commands,

...