...
This page tells you how to create a Universal Template, Universal Template Fields, Universal Template Field Choices, and Universal Template Event Templates.
You must create Universal Templates in order to create Integrations. For each Universal Template that you create, Universal Controller creates a Universal Task type for which you can create one or more Universal Tasks.
...
If the Universal Template 63734427 Template Type is Extension, you can create Event Templates for the Universal Template .
...
Step 1 | From the Administration navigation pane, select Configuration > Universal Templates. The Universal Templates list displays.
| |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Step 2 | Enter / select Details for a new Universal Template, 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 template is added to the database, and all buttons and tabs in the Universal Template Details are enabled. |
...
Note | ||
---|---|---|
| ||
To open an existing record on the list, either:
|
...
The following Universal Template Details is for a new Universal Template, which does not yet contain any user-defined Fields. (See 63734427 Creating Universal Template Fields for an existing Universal Template Details containing user-defined fields.)
Depending on the values that you enter / select for these fields, more (or less) other fields may display. See the field descriptions, below, for a description of all fields that may display in the Universal Template Details.
...
Field Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the template. | ||||||||||||
Name | Name of this Universal Template. | ||||||||||||
Extension | If 63734427 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 63734427 Universal Template Details, above).
| ||||||||||||
Log Level | If 63734427 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 63734427 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 63734427 Template Type is Script and 63734427 Agent Type is Any; Indication that the specified 63734427 Script can be executed by both Linux/Unix and Windows Agents. | ||||||||||||
| If 63734427 Use Common Script is enabled; Script to be executed by the specified Agent. | ||||||||||||
| If 63734427 Template Type is Script and 63734427 Agent Type is Linux/Unix or Any (and 63734427 Use Common Script is not enabled); Script to be executed by the Linux/Unix Agent. | ||||||||||||
| If 63734427 Template Type is Script and 63734427 Agent Type is Windows or Any (and 63734427 Use Common Script is not enabled); Script to be executed by the Windows Agent. | ||||||||||||
| If 63734427 Template Type is Script and 63734427 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 63734427 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 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 63734427 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 63734427 Content Type is XML, or the JsonPath Expression if 63734427 Content Type is JSON, to be used when evaluating the Extension output. | ||||||||||||
| If 63734427 Output Type is Extension; Condition Operator to evaluate in combination with the specified condition Value. | ||||||||||||
| If 63734427 Output Type is Extension; Condition Value to evaluate in combination with the specified condition Operator. | ||||||||||||
| If 63734427 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 63734427 Exit Code Processing) |
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Start Line |
| ||||||||||||
Number of Lines |
| ||||||||||||
Scan Text |
| ||||||||||||
|
| ||||||||||||
| This section lets you specify how fields in the 63734427 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 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 63734427 Template Type is Extension; additional commands (operations) supported against a task instance (see 63734427 Creating Commands, |
Anchor | ||||
---|---|---|---|---|
|
...
Step 1 | From the Administration navigation pane, select Configuration > Universal Templates. The 63734427 Universal Templates list displays. | ||||||
---|---|---|---|---|---|---|---|
Step 2 | Open an existing Universal Template for which you want to create Fields. | ||||||
Step 3 | Click the Fields tab to display the Fields list.
| ||||||
Step 4 | Click the New button to display Field Details for a new Field. | ||||||
Step 5 | Enter / select Details for a new Field, using the field descriptions below as a guide.
| ||||||
Step 6 | Click a Save button. The Field is added to the list of Universal Template Fields. |
...
Field Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the Field. | ||||||||||||
| Name of this Field in the Controller database. (Name is used as the suffix for the Universal Template Variable based on this Field.)
| ||||||||||||
| Name of this Field to be displayed in the Controller user interface. | ||||||||||||
Hint | Field hint for this Field in the Controller user interface. | ||||||||||||
Add To Default List View | If enabled; Specification that the 63734427 Label of this Field will display, by default, in the list of Universal Tasks based on this template. | ||||||||||||
Field Details | This section contains detailed information about the Field. | ||||||||||||
| Field type for this Field.
| ||||||||||||
Text Type | For Extension-based Universal Templates only; Content type of Text field:
| ||||||||||||
| If Type is Text, Integer, or Boolean: Options:
| ||||||||||||
| Field, from a pool of available fields provided for use in a Universal Template, that this Field is mapped to.
| ||||||||||||
Default Value | If 63734427 Type is Text, Integer, Choice, or Float; Default value for this Field. (Text and Choice: Maximum length = 255; Large Text: Maximum Length = 25000, Integer: Maximum length = 11; Float: maximum length = 17.)
| ||||||||||||
| If 63734427 Type is Boolean: Type of Boolean value for this Field.
| ||||||||||||
Yes Value: | If 63734427 Boolean Value Type is Custom; Boolean Yes value for this Field. (Maximum length = 255 characters). | ||||||||||||
No Value: | If 63734427 Boolean Value Type is Custom; Boolean No value for this Field. (Maximum length = 255 characters). | ||||||||||||
| If 63734427 Type is Choice; Specification for how Choices will be listed in the Choice field drop-down list in the Universal Task Details.
Default is Sequence. | ||||||||||||
| If 63734427 Type is Choice; Specification for whether or not an empty (blank) option is available for this Choice field in any Universal Task based on this template, allowing the user to clear the value of this field. | ||||||||||||
| If 63734427 Type is Choice; Specification for whether or not more than one choice can be selected at a time. When multiple choices are selected, the built-in field variable will resolve to a comma-delimited String of choice values. | ||||||||||||
| If 63734427 Type is Array; Option to change the default Name column for the Array field on any Universal Task based on this template to any other column title (for example, Customer Name). | ||||||||||||
| If 63734427 Type is Array; Option to change the default Value column for the Array field on any Universal Task based on this template to any other column title (for example, Customer ID). | ||||||||||||
| If 63734427 Type is Text, Integer, Boolean, or Float; Specification for whether or not to place an Output Only restriction on the field, which will render it as read-only on a Universal Task Instance Details but not shown on the Universal Task Details. | ||||||||||||
Preserve Output On Re-run | If 63734427 Restriction specifies Output Only; Specification for whether or not an Output Only field should preserve its value on a Re-run instead of being cleared. | ||||||||||||
| If 63734427 Type is Choice; Specification that the field will request its choices dynamically from the Extension. | ||||||||||||
Dependent Fields | If 63734427 Dynamic Choice is specified; Fields that should be included when requesting the dynamic choices. | ||||||||||||
Validation | This section contains validation information about the Field. | ||||||||||||
| If 63734427 Type is Text, Integer, Credential, or Script; Specification for whether this Field in the template is required (checked) or optional (not checked). If it is required, it will display in boldface in any Universal Tasks based on this template.
| ||||||||||||
| If 63734427 Required is not checked and a 63734427 Show If Field is not specified; Specification that this Field in the template will be required in any Universal Tasks based on this template if the Choice Field (Choice Field 1-15) or the Boolean Field (Boolean Field 1-10) selected as the Require If Field has a value corresponding to the value(s) defined in the Require If Field Value(s) field.
| ||||||||||||
Require If Field Value(s) | If Require If 63734427 Field is a Choice field, Require If Field Value(s) is a comma-separated list of Choice values.
| ||||||||||||
| If 63734427 Required is not checked and a 63734427 Require If Field is not specified; Specification that this Field in the template will be visible in any Universal Tasks based on this template if the Choice Field (Choice Field 1-15) or the Boolean Field (Boolean Field 1-10) selected as the Show If Field has a value corresponding to the value(s) defined in the Show If Field Value(s) field.
| ||||||||||||
| |||||||||||||
| If 63734427 Show If Field is not - - None - -; If selected, specification that the Field is required if it is visible (see 63734427 Show If Field).
| ||||||||||||
| If Show If 63734427 Field is not - - None - -; If selected, specification that a space should not be reserved in place of the hidden field. | ||||||||||||
| If Show If 63734427 Field is not - - None - -; If selected, specification that the value of this field should be preserved if the field is hidden.
| ||||||||||||
Length | If 63734427 Type is Text or Integer; Length of this Field.
| ||||||||||||
Minimum | |||||||||||||
Maximum | |||||||||||||
Form Layout | This section contains information about the location of this Field in the Details of Universal Tasks based on this template.
| ||||||||||||
Start Row | If enabled; Specification that this Field will start a new row. | ||||||||||||
End Row | If enabled; Specification that this Field will end the current row. | ||||||||||||
Column Span | Number of columns (width) in the Universal Task Details for this Field.
Default is 1. | ||||||||||||
Sequence | For existing Fields only; System-defined; Sequence of this Field among all user-defined Universal Template Fields to be displayed in the Universal Task Details. Starting sequence is 0 for the first defined Field.
| ||||||||||||
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 Field Details that let you perform various actions. | ||||||||||||
Save | Saves a new Field record in the Controller database. | ||||||||||||
Save & New | Saves a new Field record in the Controller database and redisplays empty Details so that you can create another Field. | ||||||||||||
Save & View | Saves a new Field record in the Controller database and continues to display that record. | ||||||||||||
New | Displays empty (except for default values) Details for creating a new Field. | ||||||||||||
Update | Updates the Field record in the Controller database. | ||||||||||||
Delete | Delete the currently open Field.
| ||||||||||||
Refresh | Refreshes any dynamic data displayed in the Field Details. | ||||||||||||
Close | Closes the Field Details. | ||||||||||||
Tabs | This section identifies the tabs across the top of the Field Details that provide access to additional information about the Field. | ||||||||||||
Choices | If 63734427 Type is Choice; Allows you to define the Choices for this Field in the template. |
...
If you created a Choice Field (63734427 Type = Choice) for a Universal Template, you must create Choices for that Choice Field that will display in a drop-down list in all Universal Tasks based on this Universal Template.
- If you click the Save button after creating the Choice Field, the Choices tab (under which is an empty Choices list) is enabled, and an empty Choice Details automatically displays, which lets you create your first Choice.
- If you click the Save & New button after creating a Choice Field, so that you can immediately create one or more other Fields, you will have to manually open that Choice Field, click the enabled Choices tab, and then click the New button to create your first Choice.
The following procedure assumes that you have created a Choice Field but not yet created any Choices for it.
Step 1 | On the Fields list for the Universal Template, open the Choice Field (Type = Choice) whose Choices you want to create. | ||||||
---|---|---|---|---|---|---|---|
Step 2 | Click the Choices tab to display an empty Choices list.
| ||||||
Step 3 | Click New to display Choice Details for a new Choice. | ||||||
Step 4 | Enter Details for a new Choice Field, using the field descriptions below as a guide. | ||||||
Step 5 | Click a Save button. Each Choice that you define is added to the Choices list. |
...
Field Name | Description | ||||||
---|---|---|---|---|---|---|---|
General | This section contains general information about the Field. | ||||||
| Value of this Choice. (Maximum length = 255 characters.) | ||||||
| If the 63734427 Value field value is 50 characters or less; Use the 63734427 Value field value as the 63734427 Label field value (which is a maximum 50 characters). | ||||||
| If 63734427 Use Value For Label is not checked; Name that will display for this Choice in the drop-down list on a Universal Task. (Maximum = 50 characters.) | ||||||
Sequence | For existing Choices only; System-defined sequence of this Choice among all Choices defined for this Field. Starting sequence is 0 for the first defined Choice.
| ||||||
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 the Choice Details that let you perform various actions. | ||||||
Save | Saves a new Choice record in the Controller database. | ||||||
Save & New | Saves a new Choice record in the Controller database and redisplays empty Details so that you can create another Choice. | ||||||
Save & View | Saves a new Choice record in the Controller database and continues to display that record. | ||||||
New | Displays empty (except for default values) Details for creating a new Choice. | ||||||
Update | Updates the Choice record in the Controller database. | ||||||
Delete | Deletes the currently open Choice.
| ||||||
Refresh | Refreshes any dynamic data displayed in the Choice Details. | ||||||
Close | Closes the Choice Details. |
...
Field Name | Description | ||||||
---|---|---|---|---|---|---|---|
| Unique name of this command, adhering to the same naming convention as a Universal Template field name. | ||||||
| User-friendly display name for the command, to be displayed within the client. | ||||||
| Task instance status(es) that the dynamic command should be enabled for. | ||||||
| Universal Template fields (if any) that are required by the command. The values of those fields are included in the command request. | ||||||
| Optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds. If the Controller (server) does not receive a command response from the Extension prior to the timeout being reached, a timeout message will be sent to the client (user interface), and displayed in the console. However, the server-side handling of the command response, like the persistence of command output, will still be handled by the server after the timeout occurs. | ||||||
| Specification for whether the command runs out-of-process execution or in-process execution. Options:
Default is Out Of Process. | ||||||
| If 63734427 Execution Option is In Process; Specification for whether the command runs synchronously or asynchronously. | ||||||
Buttons | This section identifies the buttons displayed above and below the Field Details that let you perform various actions. | ||||||
Save | Saves a new Field record in the Controller database. | ||||||
Save & New | Saves a new Field record in the Controller database and redisplays empty Details so that you can create another Field. | ||||||
Save & View | Saves a new Field record in the Controller database and continues to display that record. | ||||||
Close | Close the Command Details. |
...