Versions Compared

Key

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

...

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 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 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 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 15.
  • 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 4.
  • 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.
  • If Type 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 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 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 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 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.

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

Allow Variable

If Type is Credential, Script, SAP Connection, or Database Connection; 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 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.
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, 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 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-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 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-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 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 enabled, 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 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 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 Type is Text or Integer; Length of this Field.
 
Maximum Lengths:

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

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

...