...
Field Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the template. | ||||||||||||
Name | Name of this Universal Template. | ||||||||||||
Extension | If Template Type is Extension; Python Extension name. | ||||||||||||
Description |
| ||||||||||||
| 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: | ||||||||||||
| 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).
| ||||||||||||
Log Level | If 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. | ||||||||||||
| Type of Universal Template. Options:
| ||||||||||||
| If Template Type is Extension; Specification for whether the Extension should be provided with task instance variable data when launched. Options:
| ||||||||||||
| Type of Agent on which Universal Tasks based on this template can be run.
| ||||||||||||
| Specification for whether or not to always perform a Cancel when Force Finishing a Universal Task for this template. | ||||||||||||
| 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. | ||||||||||||
| If Use Common Script is enabled; Script to be executed by the specified Agent. | ||||||||||||
| 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. | ||||||||||||
| 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. | ||||||||||||
| If Template Type is Script and Agent Type is Windows or Any; Type of Windows script to be executed by the Windows Agent.
| ||||||||||||
| This section contains Agent default fields that will display for every Universal Task based on this template. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
| Name of the Agent resource that identifies the machine where the operation will run. | ||||||||||||
|
| ||||||||||||
Agent Variable |
| ||||||||||||
Agent Cluster Variable |
| ||||||||||||
|
| ||||||||||||
Credentials Variable |
| ||||||||||||
Cluster Broadcast |
| ||||||||||||
Cluster Broadcast Variable |
| ||||||||||||
| 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.
| ||||||||||||
| 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).
| ||||||||||||
Create Console | If Interact with Desktop is enabled; Specification for whether or not to allocate a new console for the process, rather than having it inherit one. | ||||||||||||
| This section contains template-specific default fields that will display for every Universal Task based on this template. | ||||||||||||
|
| ||||||||||||
Environment Variables |
| ||||||||||||
Result Processing Defaults | This section contains assorted detailed information about result processing defaults for this task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
| 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. | ||||||||||||
| XPath Expression if Content Type is XML, or the JsonPath Expression if Content Type is JSON, to be used when evaluating the Extension output. | ||||||||||||
| If Output Type is Extension; Condition Operator to evaluate in combination with the specified condition Value. | ||||||||||||
| If Output Type is Extension; Condition Value to evaluate in combination with the specified condition Operator. | ||||||||||||
| 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. | ||||||||||||
| 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. | ||||||||||||
|
| ||||||||||||
Output File (for Exit Code Processing) |
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Start Line |
| ||||||||||||
Number of Lines |
| ||||||||||||
Scan Text |
| ||||||||||||
|
| ||||||||||||
| This section lets you specify how fields in the Defaults section of the Universal Template are displayed in Universal Tasks based on the template.
| ||||||||||||
| Restriction for the following Agent fields: Agent, Agent Variable, Agent Cluster, Agent Cluster Variable, and Cluster Broadcast. | ||||||||||||
| Restriction for the following Credential fields: Credentials, Credentials Variable, Run with Highest Privileges, and Runtime Directory. | ||||||||||||
| Restriction for the following Environment Variable field: Environment Variables. | ||||||||||||
| Restriction for the following Exit Code Processing fields: Exit Code Processing, Exit Codes, Output Type, Scan Output for, and Output File. | ||||||||||||
| 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. | ||||||||||||
| 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 Checksum | SHA-256 checksum for the Python Extension Archive. | ||||||||||||
Extension Version | Version of the Extension. | ||||||||||||
Extension API Level | API level that the Extension is compatible with. | ||||||||||||
Extension Requires Python | Python version(s) that the Python Extension Archive is guaranteed to be compatible with. | ||||||||||||
Extension Python Extra Paths | List 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 Owner | Author of the Extension. | ||||||||||||
Extension Organization | Organization 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. | ||||||||||||
Commands | If Template Type is Extension; additional commands (operations) supported against a task instance (see Creating Commands, |
...