Versions Compared

Old Version 2

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 3

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 1

...

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 794553429 Template Type is Extension, you can create Event Templates for the Universal Template .

...

Step 1

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

Note
titleNote

The System Template column. which does not display by default, identifies any Built-In Universal Templates that have been loaded from the List/Load Built-In Universal Templates server operation.

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

Anchor
Universal Templates list
Universal Templates list

Step 2

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.

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
titleNote

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

...

The following Universal Template Details is for a new Universal Template, which does not yet contain any user-defined Fields. (See 794553429 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.

ExtensionIf 794553429 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 794553429 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 794553429 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 794553429 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 794553429 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 794553429 Template Type is Script and 794553429 Agent Type is Any; Indication that the specified 794553429 Script can be executed by both Linux/Unix and Windows Agents.

Anchor
Script
Script
Script

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

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

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

Anchor
Windows Script
Windows Script
Windows Script

If 794553429 Template Type is Script and 794553429 Agent Type is Windows or Any (and 794553429 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 794553429 Template Type is Script and 794553429 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 794553429 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 794553429Interact 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

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.

Note

Variables and Functions are supported for the Environment Variables option in Dynamic Choice or Dynamic Command.


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 794553429 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 794553429 Content Type is XML, or the JsonPath Expression if 794553429 Content Type is JSON, to be used when evaluating the Extension output.

Anchor
Operator
Operator
Operator

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

Anchor
Value
Value
Value

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

Anchor
Strategy
Strategy
Strategy

If  794553429 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 794553429 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 794553429 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 794553429 Defaults section of the Universal Template are displayed in Universal Tasks based on the template.
 
The Field Restrictions section places the fields in the 794553429 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

    The Hidden option is meant to minimize what is displayed on the Universal Task form and not meant as a means to prevent a user from viewing the field information.  A user can still use the Details > Show Details to view the Hidden field information. Furthermore, Hidden fields appear as Read Only on any Dynamic Choice and Dynamic Command windows.


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 794553429 Template Type is Extension; additional commands (operations) supported against a task instance (see 794553429 Creating Commands,

Anchor
Creating Universal Template Fields
Creating Universal Template Fields
Creating Universal Template Fields

...

Step 1

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

Step 2

Open an existing Universal Template for which you want to create Fields.
 

Step 3

Anchor
Fields list
Fields list

Click the Fields tab to display the Fields list.
 

Step 4

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

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

Step 6

Click a  button. The Field is added to the list of Universal Template Fields.
 
If you click the Save or Save & View button after creating a Choice Field (794553429 Type = Choice), 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, in order to 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.

...

Field Name

Description

General

This section contains general information about the Field.

Anchor
Name
Name
Name

Name of this Field in the Controller database. (Name is used as the suffix for the Universal Template Variable based on this Field.)

  • Maximum 28 characters.
  • Name must begin with an alphabetic character and can consist of: alphabetics (a-z, A-Z), numerics 0-9, _ (underscore).
  • White spaces are not permitted.
  • Names are not case-sensitive.

Anchor
Label
Label
Label

Name of this Field to be displayed in the Controller user interface.

Hint

Field hint for this Field in the Controller user interface.

Note

If 794553429 Regex is specified for a Text field, a message describing the Regex requirement for the field will be appended to the field hint.


Add To Default List View

If enabled; Specification that the 794553429 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.

Anchor
Type
Type
Type

Field type for this Field.
 
Options:

  • Text (default)
  • Integer
  • Boolean
  • Choice
  • Credential
  • Script
  • Array
  • Float
  • SAP Connection
  • Database Connection
Text Type

For Extension-based Universal Templates only; Content type of Text field:

  • Plain
  • JSON
  • YAML

Anchor
Restriction
Restriction
Restriction

If Type is Text, Integer, or Boolean:

Options:

  • No Restriction
  • Output Only

Anchor
Mapping
Mapping
Mapping

Field, from a pool of available fields provided for use in a Universal Template, that this Field is mapped to.
 
Options:

  • If 794553429Type is Text: Text Field 1 - Text Field 20, Large Text Field 1 - Large Text Field 4.
  • If 794553429Type is Integer: Integer Field 1 - Integer Field 10.
  • If 794553429Type is Boolean: Boolean Field 1 - Boolean Field 15.
  • If 794553429Type is Choice: Choice Field 1 - Choice Field 15.
  • If 794553429Type is Credential: Credential Field 1 - Credential Field 6.
  • If 794553429Type is Script: Script Field 1 - Script Field 4.
  • If 794553429Type is Array: Array Field 1 - Array Field 4.
  • If 794553429Type is Float: Float Field 1 - Float Field 4.
  • If 794553429Type is SAP Connection: Sap Connection Field 1.
  • If 794553429Type is Database Connection: Database Connection Field 1.
Note
titleNote

A field (from the pool of fields provided for use in a Universal Template) that is mapped to a Universal Template Field is not available to be mapped to any other Universal Template Field.



Default Value

If 794553429 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.)
 
Also if 794553429 Type is Choice; In order for a Choice to display as the default for this Field in the Universal Task Details, Default Value must be the Choice 794553429 Value, not the Choice 794553429 Label.
 
If 794553429 Type is Boolean; Specification (a check mark) that the Yes value for this field is the default.
 
If 794553429 Type is Credential; Default Credential to be used for this Universal Template Field. You can select a Credential from the Default Value drop-down list or click the Details icon next to the Default Value field to create a new Credential.
 

Note
titleNote

Since only Resolvable Credentials can be embedded in a Universal Template script or used by a Universal Extension, only Resolvable Credentials display in the Default Value drop-down list for a Credential. If you click the Details icon to create a new Credential, Resolvable is pre-selected for the Type field in the Credential Details and cannot be changed.

 
If 794553429 Type is Script; Default Script to be used for this Universal Template Field. You can select a Script from the Default Value drop-down list or click the Details icon next to the Default Value field to create a new Script.

Note
titleNote

Since only Data Scripts can be embedded in a Universal Template script or used by a Universal Extension, only Data Scripts display in the Default Value drop-down list for a Script. If you click the Details icon to create a new Script, Data is pre-selected for the Type field in the Script Details and cannot be changed.

 
If 794553429 Type is Array; You can specify the default array variables, which can be assigned to the appropriate field while creating the task.

If 794553429 Type is SAP Connection; Default SAP Connection to be used for this Universal Template Field. You can select an SAP Connection from the Default Value drop-down list or click the Details icon next to the Default Value field to create a new SAP Connection.

If 794553429 Type is Database Connection; Default Database Connection to be used for this Universal Template Field. You can select a Database Connection from the Default Value drop-down list or click the Details icon next to the Default Value field to create a new Database Connection.

Anchor
Boolean Value Type
Boolean Value Type
Boolean Value Type

If 794553429 Type is Boolean: Type of Boolean value for this Field.
 
Options:

  • true/false (default)
  • 1/0
  • Custom

Yes Value:

If 794553429 Boolean Value Type is Custom; Boolean Yes value for this Field. (Maximum length = 255 characters).

No Value:

If 794553429 Boolean Value Type is Custom; Boolean No value for this Field. (Maximum length = 255 characters).

Anchor
Choice Sort Option
Choice Sort Option
Choice Sort Option

If 794553429 Type is Choice; Specification for how Choices will be listed in the Choice field drop-down list in the Universal Task Details.
 
Options:

  • Sequence: Choices will be displayed in the sequence they were created. You can change this sequence manually on the Choices list.
  • Label: Choices will be displayed alphabetically by 794553429Label.

Default is Sequence.

Anchor
Allow Empty Choice
Allow Empty Choice
Allow Empty Choice

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

Anchor
Allow Multitple Choices
Allow Multitple Choices
Allow Multiple Choices

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

Allow VariableIf 794553429 Type is Credential; Specification for whether or not the field value can be defined dynamically by a variable and/or function.

Anchor
Name Title
Name Title
Name Title

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

Anchor
Value Title
Value Title
Value Title

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

Anchor
Restriction
Restriction
Restriction

If 794553429 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-runIf 794553429 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.
Extension Status

If 794553429 Restriction specifies Output Only; Specification for whether or not an Output Only field is designated as Extension Status for a task instance.

Note

Only a single field can be designated as an Extension Status. 


Anchor
Dynamic Choice
Dynamic Choice
Dynamic Choice

If 794553429 Type is Choice; Specification that the field will request its choices dynamically from the Extension.
Dependent FieldsIf 794553429 Dynamic Choice is specified; Fields that should be included when requesting the dynamic choices.

Validation

This section contains validation information about the Field.

Anchor
Required
Required
Required

If 794553429 Type is Text, Integer, Credential, Float, SAP Connection, Database Connection 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.

Note
titleNote

If you modify a Universal Template Field to add a Required condition, review and assign an appropriate field value to any Universal Tasks that are no longer in compliance to avoid a Start Failure.


Anchor
Require If Field
Require If Field
Require If Field

If 794553429 Required is not checked and a 794553429 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-15) selected as the Require If Field has a value corresponding to the value(s) defined in the Require If Field Value(s) field.
 
The Require If Field Value(s) field is not available until you make a Require If Field selection.
 
Options:

  • -- None --
  • Boolean Field 1 - Boolean Field 15.
  • Choice Field 1 - Choice Field 15.
Note
titleNote

If you modify a Universal Template Field to add or augment a Require If Field condition, review and assign an appropriate field value to any Universal Tasks that are no longer in compliance to avoid a Start Failure.


Require If Field Value(s)

If Require If 794553429 Field is a Choice field, Require If Field Value(s) is a comma-separated list of Choice values.
 
For example:

Include Page
IL:Require If Field Values
IL:Require If Field Values

 
If Require If 794553429 Field is a Boolean field, Require If Field Value(s) is either true or false.

Anchor
Show If Field
Show If Field
Show If Field

If 794553429 Required is not checked and a 794553429 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-15) selected as the Show If Field has a value corresponding to the value(s) defined in the Show If Field Value(s) field.
 
The Show If Field Value(s) field is not available until you make a Show If Field selection.
 
Options:

  • -- None --
  • Boolean Field 1 - Boolean Field 15.
  • Choice Field 1 - Choice Field 15.

Anchor
Show If Field Value(s)
Show If Field Value(s)
Show If Field Value(s)

Include Page
IL:Show If Field Values
IL:Show If Field Values


If Show If 794553429 Field is a Boolean field, the Show If Field Value(s) is either true or false.

Anchor
Require If Visible
Require If Visible
Require If Visible

If Show If 794553429 Field is not - - None - -;

If enabled, specification that the Field is required if it is visible (see 794553429 Show If Field).

Note
titleNote

If you modify a Universal Template Field to add a Require If Visible condition, review and assign an appropriate field value to any Universal Tasks that are no longer in compliance to avoid a Start Failure.


Anchor
No Space If Hidden
No Space If Hidden
No Space If Hidden

If Show If 794553429 Field is not - - None - -;

If enabled, specification that a space should not be reserved in place of the hidden field.

Anchor
Preserve Value If Hidden
Preserve Value If Hidden
Preserve Value If Hidden

If Show If 794553429 Field is not - - None - -;

If enabled for a hidden field,

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

A Field with Preserve Value If Hidden = true will be validated even if the Field is hidden.

Also, if a Field's Show If Field or Require If Field specifies a field (for example, Boolean Field 1) that has Preserve Value If Hidden = true, when validating whether the Field is visible or required, Boolean Field 1’s value is considered visible.


Length

If 794553429 Type is Text or Integer; Length of this Field.
 
Maximum Lengths:

  • Text = 255
  • Large Text = 25000
  • Integer = 11
Anchor
Regex
Regex
Regex

If 794553429 Type is Text; Regex that the text in the field must match. 

If Regex is specified, the field hint will include "{field label} must match regex pattern "{REGEX}"". 

Minimum

If 794553429 Type is Integer; Minimum value for this field.

Maximum

If 794553429 Type is Integer; Maximum value for this field.

Form Layout

This section contains information about the location of this Field in the Details of Universal Tasks based on this template.
 

Note
titleNote

All user-defined Fields in a Universal Template will be located between the Credentials Variable and Runtime Directory fields in the Details section 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.
 
Options:

  • 1
  • 2
  • 3

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.
 

Note
titleNote

You can change the Sequence of user-defined Universal Template Fields by dragging them to new locations on the 794553429 Fields list.


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.
 

Note
titleNote

You cannot delete a field if it is the only field in the Template.


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 794553429 Type is Choice; Allows you to define the Choices for this Field in the template.

...

If you created a Choice Field (794553429 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.
 

Anchor
Choices List
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.

Anchor
Value
Value
Value

Value of this Choice. (Maximum length = 255 characters.)

Anchor
User Value For Label
User Value For Label
Use Value For Label

If the 794553429 Value field value is 50 characters or less; Use the 794553429 Value field value as the 794553429 Label field value (which is a maximum 50 characters).

Anchor
Label
Label
Label

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

Note
titleNote

If you select Sequence in the 794553429 Choice Sort Option field in the Details for this Choice Field, you can sort the Choices by clicking and dragging them to any position on the 794553429 Choices List.
 
In the Details of any Universal Task based on this Universal Template, the Labels for these Choices will display in the Choice Field drop-down list in the order you select.


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.
 

Note
titleNote

You cannot delete a Choice if it is the only Choice for the Field.


Refresh

Refreshes any dynamic data displayed in the Choice Details.

Close

Closes the Choice Details.

...

Field Name

Description

Anchor
Name
Name
Name

Unique name of this command, adhering to the same naming convention as a Universal Template field name.

Anchor
Label
Label
Label

User-friendly display name for the command, to be displayed within the client.

Anchor
Supported Status(es)
Supported Status(es)
Supported Status(es)

Task instance status(es) that the dynamic command should be enabled for.

Anchor
Dependent Fields
Dependent Fields
Dependent Fields

Universal Template fields (if any) that are required by the command. The values of those fields are included in the command request.

Anchor
Timeout (Seconds)
Timeout (Seconds)
Timeout (Seconds)

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.

Anchor
Execution Option
Execution Option
Execution Option

Specification for whether the command runs out-of-process execution or in-process execution.

Options:

  • Out Of Process
  • In Process

Default is Out Of Process.

Anchor
Asynchronous
Asynchronous
Asynchronous

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

SaveSaves a new Field record in the Controller database.
Save & NewSaves a new Field record in the Controller database and redisplays empty Details so that you can create another Field.
Save & ViewSaves a new Field record in the Controller database and continues to display that record.
CloseClose the Command Details.

...