From the Administration navigation pane, select Universal Templates. The Universal Templates list displays.

 
To the right of the list, Universal Template Details for a new Universal Template displays.
 

Open

Enter / select Details for a new Universal Template, 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.

Click a Save button. The template is added to the database, and all buttons and tabs in the Universal Template Details are enabled.

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

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

• Workflow Editor

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.
 

 
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 Level

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

This section contains assorted detailed information about the template.

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.

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.

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

• Linux/Unix

• Windows

• IBM i

IBM i can only be selected if Template Type is Extension.

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 both Linux/Unix Agent Type and Windows Agent Type are selected; 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 Linux/Unix Agent Type is selected (and Use Common Script is not enabled); Script to be executed by the Linux/Unix Agent.

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

If Template Type is Script and Windows Agent Type is selected; 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)

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

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

Send Environment Variables

Specifies which type of operations should send the extension the Environment Variables.

Environment Variables will always be sent for the Launch operation, however, sending them for the Dynamic Choice and Dynamic Command operations is optional.

If your Dynamic Choice or Dynamic Command operations do not require the Environment Variables, you should leave these options unselected.

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

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

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