Versions Compared

Key

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

...

Step 1

From the Administration navigation pane, select Configuration > 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.

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

Anchor
Universal Templates list
Universal Templates list

Image RemovedImage Added

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.

...

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.
 
Image Removed Image Added


For information on how to access additional details - such as Metadata and complete database Details - for Universal Templates (or any type of record), see Records.

...

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:

  • Automation Center Navigation Pane task bar
  • Automation Center Navigation Tree Configuration task bar

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

    ...

    Image RemovedImage Added

    Step 1

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

    Step 2

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

    Step 3

    Anchor
    Fields list
    Fields list

    Click the Fields tab to display the Fields list.
     

    Anchor
    Fields listFields list

    Step 4

    Click the New button Image Added  button to display Field Details for a new Field.
     
    Image Removed Image Added

    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

    Save button

    Image Added  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 (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.

    Anchor
    Field Details Field Descriptions
    Field Details Field Descriptions
    Field Details Field Descriptions

    ...

    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.

    Add To Default List View

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

    Type

    Type

    Type

    Type

    Type

    Type

    Type

    Type

    Type 
    • If Type is Text: Text Field 1 - Text Field 20, Large Text Field 1 - Large Text Field 4.
    • If Type is Integer: Integer Field 1 - Integer Field 10.
    • If Type is Boolean: Boolean Field 1 - Boolean Field 10.
    • If Type is Choice: Choice Field 1 - Choice Field 15.
    • If Type is Credential: Credential Field 1 - Credential Field 6.
    • If Type is Script: Script Field 1 - Script Field 2.
    • If Type is Array: Array Field 1 - Array Field 4.
    • If Type is Float: Float Field 1 - Float Field 4.
    • If Type is SAP Connection: Sap 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 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 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 Value, not the Choice Label.
     
    If Type is Boolean; Specification (a check mark) that the Yes value for this field is the default.
     
    If 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, 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 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, 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 Type is Array; You can specify the default array variables, which can be assigned to the appropriate field while creating the task.

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

    Anchor
    Boolean Value Type
    Boolean Value Type
    Boolean Value Type

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

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

    Yes Value:

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

    No Value:

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

    Default is Sequence.

    Anchor
    Allow Empty Choice
    Allow Empty Choice
    Allow Empty Choice

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

    Anchor
    Name Title
    Name Title
    Name Title

    If 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 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 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 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.not an Output Only field should preserve its value on a Re-run instead of being cleared.
    Extension Status

    If 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 Type is Choice; Specification that the field will request its choices dynamically from the Extension.
    Dependent FieldsIf 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 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.

    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 Required is not checked and a 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.
     
    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 10.
    • 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 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 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 Required is not checked and a 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.
     
    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 10.
    • 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 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 Field is not - - None - -; If selected, specification that the Field is required if it is visible (see 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 Field is not - - None - -; If selected, 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 Field is not - - None - -; If selected, specification that the value of this field should be preserved if the field is hidden.

    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 Type is Text or Integer; Length of this Field.
     
    Maximum Lengths:

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

    Minimum

    If Type is Integer; Minimum value for this field.

    Maximum

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

    ...

    Step 1

    On the Fields list for the Universal Template, open the Choice Field (Type = Choice) whose Choices you want to create.
     
    Image Removed Image Added

    Step 2

    Click the Choices tab to display an empty Choices list.
     

    Anchor
    Choices List
    Choices List
    Image Removed

    Step 3

    Click New to display Choice Details for a new Choice.
     
    Image Removed Image Added

    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.

    ...

    Commands allow you to define additional operations against a task instance.

    Image RemovedImage Added

    Anchor
    Command Details Field Descriptions
    Command Details Field Descriptions
    Command Details Field Descriptions

    ...

    Note
    titleNote

    When publishing Universal Events through an Extension-based Universal Task Publisher, take into consideration both Universal Controller server and Database server sizings.


    Image RemovedImage Added

    Anchor
    Event Template Details Field Descriptions
    Event Template Details Field Descriptions
    Event Template Details Field Descriptions

    ...