Panel | ||||
---|---|---|---|---|
|
...
- Create a Universal Template
- Delete a Universal Template
- List Universal Templates
- Modify a Universal Template
- Read a Universal Template
- Restore Default Universal Template Icon
- Set Universal Template Icon
- Universal Template - Delete Extension Archive
- Universal Template - Download Extension Archive
- Universal Template - Upload Extension Archive
- Universal Template Export
- Universal Template Import
(Also see Universal Event Template Web Services.)
Formatting specifications for each web service, including details about parameter requirements, are provided.
Note | ||
---|---|---|
| ||
You cannot create, read, modify, or list Built-In Universal Templates. You can delete Built-In Universal Templates. |
...
Description
...
URI
...
Auditing Universal Events
The Universal Event Web Service Publish Audit lets you specify whether or not an audit record is generated for each Universal Event published through the Universal Event Web Services.
(The Universal Event Extension Publish Audit lets you specify whether or not an audit record is generated for each Universal Event published through an Extension-based Universal Task Instance.)
Note | ||
---|---|---|
| ||
Enabling these audit properties can generate a large quantity of audit. |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/universaltemplate |
HTTP Method | POST |
Description | Creates a new Universal Template. |
Example URI | http://localhost:8080/uc/resources/universaltemplate |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | See Create, Modify, and Read a Universal Template: XML and JSON Examples, below. |
Universal Template Properties | |
Field Properties | See Field Properties. |
Choice Properties | See Choice Properties. |
Example Response |
|
...
The excludeRelated and retainSysIds properties are specified as attributes in the <universalTemplate> element of XML web servicesXML.
The exportReleaseLevel
property is specified as an attribute in XML.
...
Anchor | ||||
---|---|---|---|---|
|
Parameter | Description | Specifications | Required |
---|---|---|---|
| Name used within the Controller to identify this Universal Template. | String; URI parameter. Wildcards are supported. | N |
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agent | Agent | Name of the Agent to use. | N |
| ||||||||||||||||||||||||||||||||||||||||||||
agentCluster | Agent Cluster | Group of Agents, one of which the Controller will choose to run this task (compare with | N |
| ||||||||||||||||||||||||||||||||||||||||||||
agentClusterVar | Agent Cluster Variable | Name of a variable that will be resolved at run time to the name of the Agent Cluster to use. | Format: ${variable name}. | N |
| |||||||||||||||||||||||||||||||||||||||||||
agentFieldsRestriction | Agent Fields | Restriction to apply to the group of Agent Fields. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||
agentType | Agent Type | Type of Agent on which Universal Tasks based on this template can be run. | Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||
agentVar | Agent Variable | Name of a variable that will be resolved at run time to the name of the Agent to use. | Format: ${variable name}. | N |
| |||||||||||||||||||||||||||||||||||||||||||
alwaysCancelOnFinish | Always Cancel On Finish | Specification for whether or not to always perform a Cancel when Force Finishing a Universal Task for this template. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
automaticOutputRetrievalFieldsRestriction | Automatic Output Retrieval Fields | Restriction to apply to the group of Automatic Output Retrieval Fields. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||
broadcastCluster | Cluster Broadcast | Group of Agents, all of which will run this task (compare with | N |
| ||||||||||||||||||||||||||||||||||||||||||||
broadcastClusterVar | Cluster Broadcast Variable | Name of a variable that will be resolved at run time to the name of the Cluster Broadcast to use. | Format: ${variable name} | N |
| |||||||||||||||||||||||||||||||||||||||||||
createConsole | Create Console | If | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
credentialFieldsRestriction | Credential Fields | Restriction to apply to the group of Credential Fields. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||
credentials | Credentials | Credentials under which an Agent runs this task. These credentials override any credentials provided in the Agent Details for any Agent running this task. | N |
| ||||||||||||||||||||||||||||||||||||||||||||
credentialsVar | Credentials Variable | Name of a variable that will be resolved at run time to the name of the {Credentials] to use. | N |
| ||||||||||||||||||||||||||||||||||||||||||||
description | Description | Description of this Universal Template. | N | |||||||||||||||||||||||||||||||||||||||||||||
desktopInteract | Interact with Desktop | 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). | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
elevateUser | Run with Highest Privileges | Specification for whether or not to 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. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
environment | Environment Variables | Environment variables needed by the program to run. | ||||||||||||||||||||||||||||||||||||||||||||||
Anchor | exitCodeOutput - UTEMP | exitCodeOutput - UTEMP | Output File | Path and file name of the output file that should be scanned for the text in | N | |||||||||||||||||||||||||||||||||||||||||||
Anchor | exitCodeProcessing - UTEMP | exitCodeProcessing - UTEMP | Exit Code Processing | Specification for how the Controller should determine whether the executed command failed or completed successfully. | N | |||||||||||||||||||||||||||||||||||||||||||
Anchor | exitCodeProcessingFieldsRestriction - UTEMP | exitCodeProcessingFieldsRestriction - UTEMP | Exit Code Processing Fields | Restriction to apply to the group of Exit Code Processing Fields List of environment variables:
| N | |||||||||||||||||||||||||||||||||||||||||||
Anchor | environmentVariableFieldsRestriction - UTEMP | environmentVariableFieldsRestriction - UTEMP | Environment Variable Fields | Restriction to apply to the group of Environment Variables Fields. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||
Anchor | excludeRelated - UTEMP | excludeRelated - UTEMP | n/a | Specification for whether or not to exclude related records. | Boolean; Valid values: true/false. Default is false. | N |
| N | ||||||||||||||||||||||||||||||||||||||||
environmentVariableFieldsRestriction | Environment Variable Fields | Restriction to apply to the group of Environment Variables Fields. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||
excludeRelated | n/a | Specification for whether or not to exclude related records. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
exitCodeOutput | Output File | Path and file name of the output file that should be scanned for the text in | N | |||||||||||||||||||||||||||||||||||||||||||||
exitCodeProcessing | Exit Code Processing | Specification for how the Controller should determine whether the executed command failed or completed successfully. | Valid values:
Default is Success Exitcode (1). | N | ||||||||||||||||||||||||||||||||||||||||||||
exitCodeProcessingFieldsRestriction | Exit Code Processing Fields | Restriction to apply to the group of Exit Code Processing Fields. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||
exitCodes | Exit Codes | If | Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. | Y | ||||||||||||||||||||||||||||||||||||||||||||
exitCodeText | Scan Output For | If | The Controller will process this field as a regular expression. | Y | ||||||||||||||||||||||||||||||||||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | ||||||||||||||||||||||||||||||||||||||||||||
name | Name | Name of this Universal Template. | Y | |||||||||||||||||||||||||||||||||||||||||||||
outputFailureOnly | Failure Only | If | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
outputReturnFile | Output File | If | N | |||||||||||||||||||||||||||||||||||||||||||||
outputReturnNline | Number of Lines | If | Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property. | N | ||||||||||||||||||||||||||||||||||||||||||||
outputReturnSline | Start Line | If | Default is 1. | N | ||||||||||||||||||||||||||||||||||||||||||||
outputReturnText | Scan Text | If | The Controller will process this field as a regular expression. | N | ||||||||||||||||||||||||||||||||||||||||||||
outputReturnType | Automatic Output Retrieval | Specificaton for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record. | Valid values:
Default is OUTERR (6).
| N | ||||||||||||||||||||||||||||||||||||||||||||
outputType | Output Type | If | Valid values:
Default is STDOUT (1). | N | ||||||||||||||||||||||||||||||||||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Universal Template web service will persist the | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||
runtimeDir | Runtime Directory | Directory from which the application should be executed. | Variables are supported. | N | ||||||||||||||||||||||||||||||||||||||||||||
script | Script | If | N | |||||||||||||||||||||||||||||||||||||||||||||
scriptUnix | Linux/Unix Script | If | N | |||||||||||||||||||||||||||||||||||||||||||||
scriptWindows | Windows Script | If | N | |||||||||||||||||||||||||||||||||||||||||||||
scriptTypeWindows | Windows Script File Type | If | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||
sendVariables | Send Extension Variables | If Options:
| Valid values:
Default is None (0). | N | ||||||||||||||||||||||||||||||||||||||||||||
sysId | UUID | System ID field in the database for this record. | Persisted only if | N | ||||||||||||||||||||||||||||||||||||||||||||
templateType | Template Type | Specification for whether the Universal Template will be executed as a Script or will be executed through the Universal Extension framework. | Valid values:
| No Restriction
| 0As String = Read Only, As Value =
| Hidden
Default is Script (1). | N | |||||||||||||||||||||||||||||||||||||||||
Anchor | name - UTEMP | name - UTEMP | Name | Name of
exitCodes | Exit Codes | If | Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. | Y | ||||||||||||||||||||||||||||||||||||||||
Anchor | exitCodeText - UTEMP | exitCodeText - UTEMP | Scan Output For | If | The Controller will process this field as a regular expression. | Y |
| Use Common Script | Indication that the specified | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||
variablePrefix | 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. | Y | |||||||||||||||||||||||||||||||||||||||||||||
outputFailureOnly
| Wait For Output | If | Boolean; Valid values: true/false. Default is false. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| outputReturnFile
| UTEMP
| outputReturnFile
| UTEMP
|
| Output FileName Title | If | fieldType is | FILE; Path and file name containing the output that you want automatically retrieved and attached to the task instanceArray; Title to be displayed for the Name column. | N | ||||||||||||||||||||||||||||||||||||||||||||
| outputReturnNline
| UTEMP
| outputReturnNline
| UTEMP
|
| Value Title | outputReturnSline - UTEMP | Start Line | If | Default is 1If | Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property. | N | ||||||||||||||||||||||||||||||||||||||||||
Anchor | outputReturnSline - UTEMP | fieldType is Array; Title to be displayed for the Value column. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||
booleanNoValue | No Value | If | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||
booleanValueType | Boolean Value Type | Type of Boolean value for this Field. | Valid values:
Default is true/false (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||
outputReturnText booleanYesValue | Scan TextYes Value | outputReturnType - UTEMP | Automatic Output Retrieval | Specificaton for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record. | Valid values: Default is OUTERR (6). Note | | ||||||||||||||||||||||||||||||||||||||||||||||||
| The Controller will process this field as a regular expression. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | outputReturnType - UTEMP |
| Y | |||||||||||||||||||||||||||||||||||||||||||||||||||
choiceAllowEmpty | Allow Empty Choice | If fieldType 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. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||
choiceAllowMultiple | Allow Multiple Choices | If fieldType 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. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||
outputType
| Choice Sort Option | Default is STDOUT If Valid values:
| Valid values:
Default is Sequence (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||
Boolean; Valid values: true/false. Default is false. For XML, retainSysIds is specified as an attribute on the universalTemplate element.Used for both the Create and Update web services; for Update, it is used only for the related lists (Fields and Choices). It is recommended that retainSysIds be enabled when updating Choice values so that the command can determine which Choice values have been updated and propagate the new value to Universal Tasks using the previous Choice value. If retainSysIds is not enabled when updating Choice values, the command can determine only which Choice values have been added or removed; Universal Tasks using the previous Choice values will not be updated
retainSysIds | n/a | Specification for whether or not the Create a Universal Template web service will persist the |
| Add To Default List View | Specification that the | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||
runtimeDir fieldLength | Runtime Directory | Directory from which the application should be executed. | Variables are supported.Length | If | Integer | N | ||||||||||||||||||||||||||||||||||||||||||||||||
script fieldMapping | Script | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | scriptUnix - UTEMP | scriptUnix - UTEMP | Linux/Unix Script | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | scriptWindows - UTEMP | scriptWindows - UTEMP | Windows Script | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | scriptTypeWindows- UTEMP | scriptTypeWindows- UTEMP | Windows Script File Type | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | sysId - UTEMP | sysId - UTEMP | UUID | System ID field in the database for this record. | Persisted only if | N | ||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | useCommonScript - UTEMP | useCommonScript - UTEMP | Use Common Script | Indication that the specified | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | variablePrefix - UTEMP | variablePrefix - UTEMP | 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. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | waitForOutput - UTEMP | waitForOutput - UTEMP | Wait For Output | If | Boolean; Valid values: true/false. Default is false. | N |
...
Property | UI Field Name | Description | Specifications | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anchor | arrayNameTitle - FIELD | arrayNameTitle - FIELD | Name Title | If fieldType is Array; Title to be displayed for the Name column. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | arrayValueTitle - FIELD | arrayValueTitle - FIELD | Value Title | If fieldType is Array; Title to be displayed for the Value column. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | booleanNoValue - FIELD | booleanNoValue - FIELD | No Value | If | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | booleanValueType - FIELD | booleanValueType - FIELD | Boolean Value Type | Type of Boolean value for this Field. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | booleanYesValue - FIELD | booleanYesValue - FIELD | Yes Value | If | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | choiceAllowEmpty - FIELD | choiceAllowEmpty - FIELD | Allow Empty Choice | If fieldType 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. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | choiceAllowMultiple - FIELD | choiceAllowMultiple - FIELD | Allow Multiple Choices | If fieldType 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. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | choiceSortOption - FIELD | choiceSortOption - FIELD | Choice Sort Option | If | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | defaultListView - FIELD | defaultListView - FIELD | Add To Default List View | Specification that the | Field, from a pool of available fields provided for use in a Universal Template, that this Field is mapped to. | Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldType | Type | Field type for this Field. | Valid values:
Default is Text (1). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldValue | Default Value | Default value for this Field. | Value values by
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
formColumnSpan | Column Span | Number of columns (width) in the Universal Task (based on this Universal Template) Details for this Field. | Valid values:
Default is 1. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
formEndRow | End Row | Specification that this Field will end the current row. | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
formStartRow | Start Row | Specification that this Field will start a new row. | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hint | Hint | Field hint for this Field in the Controller user interface. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
intFieldMax | Maximum | If | Integer | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
intFieldMin | Minimum | If | Integer | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
label | Label | Name of this Field to be displayed in the Controller user interface. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | Name | Name of this Field in the Controller database. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
noSpaceIfHidden | No Space If Hidden | Specification that a space should not be reserved in place of the hidden field. | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
preserveValueIfHidden | Preserve Value If Hidden | Specification that the value of this field should be preserved if the field is hidden.
| Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | fieldLength - FIELD | fieldLength - FIELD | Length | If | Integer | is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldMapping required | Mapping | Field, from a pool of available fields provided for use in a Universal Template, that Required | Specification for whether this Field is | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | formColumnSpan - FIELD | formColumnSpan - FIELD | Column Span | Number of columns (width) in the Universal Task (based on this Universal Template) Details for this Field. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | formEndRow - FIELD | formEndRow - FIELD | End Row | Specification that this Field will end the current row required or optional. | Valid values:
| Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | fieldType - FIELD | fieldType - FIELD | Type | Field type for this Field. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | fieldValue - FIELD | fieldValue - FIELD | Default Value | Default value for this Field. | Value values by
| N |
| Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requireIfField | Require If Field | If
| Valid values:
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requireIfFieldValue | Require If Field Value(s) | If | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requireIfVisible | Require If Visible | Specification that the Field is required if it is visible.
| Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
formStartRow sequence | Start Row | Specification that this Field will start a new row. | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | hint - FIELD | hint - FIELD | Hint | Field hint for this Field in the Controller user interfaceSequence | For existing Fields only; System-defined; Sequence of this Field among all user-defined Universal Template Fields to be included in the Universal Task Details. Starting sequence is 0 for the first defined Field. | Integer; Read-only.
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
intFieldMax showIfField | MaximumShow If Field | If | Integer | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | intFieldMin - FIELD | intFieldMin - FIELD | Minimum | If | Integer | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name of this Field to be displayed in the Controller user interface
label | Label |
| Show If Field Value | If | Y Anchor | | name - FIELD | name - FIELD | Name | Name of this Field in the Controller database. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | noSpaceIfHidden - FIELD | noSpaceIfHidden - FIELD | No Space If Hidden | Specification that a space should not be reserved in place of the hidden field. | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | preserveValueIfHidden - FIELD | preserveValueIfHidden - FIELD | Preserve Value If Hidden | Specification that the value of this field should be preserved if the field is hidden.
| Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | required - FIELD | required - FIELD | Required | Specification for whether this Field is required or optional.
| Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | requireIfField - FIELD | requireIfField - FIELD | Require If Field | If
| Valid values:
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | requireIfFieldValue - FIELD | requireIfFieldValue - FIELD | Require If Field Value(s) | If | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | requireIfVisible - FIELD | requireIfVisible - FIELD | Require If Visible | Specification that the Field is required if it is visible. Note | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sysId | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fieldValue | Value | Value of this Choice. | Maximum length = 255 characters. | Y | |||||||||||
fieldValueLabel | Label | If | Y | ||||||||||||
sequence | 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. | Read-only
| N | |||||||||||
sysId | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if retainSysIds is set to true. | N | |||||||||||
useFieldValueForLabel | Use Value For Label | If the | Boolean; Valid values: true/false. Default is false. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
asynchronous | Asynchronous | If If | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||
| Sequence | For existing Fields only; System-defined; Sequence of this Field among all user-defined Universal Template Fields to be included in the Universal Task Details. Starting sequence is 0 for the first defined Field. |
Note | ||
---|---|---|
| ||
|
N
showIfField
Show If Field
If required
is false and requireIfField
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.
Valid values:
- As String = Choice Field [1-15]
- As String = Boolean Field [1-10]
N
showIfFieldValue
Show If Field Value
If showIfField
is not null/empty; Value(s) for the specified showIfField.
Y
If showIfField
is specified.
sysId
n/a
sys_id used within the Controller to identify this Universal Template Field.
Persisted only if retainSysIds
is set to true.
N
...
Property | UI Field Name | Description | Specifications | Required | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anchor | fieldValue - CHOICE | fieldValue - CHOICE | Value | Value of this Choice. | Maximum length = 255 characters. | Y | |||||||||||||||||||||||
Anchor | fieldValueLabel - CHOICE | fieldValueLabel - CHOICE | Label | If | Y | ||||||||||||||||||||||||
Anchor | sequence - CHOICE | sequence - CHOICE | 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 | ||
---|---|---|
| ||
|
N
Execution Option
Specification for whether the command runs out-of-process execution or in-process execution.
Valid values:
- As String = Out Of Process, As Value = 0
- As String = In Process, As Value = 1
Default is Out Of Process.
N
fields Anchor fields - COMMAND fields - COMMAND
Dependent Fields
Universal Template fields (if any) that are required by the command.
The values of those fields are included in the command request.
Code Block | ||||
---|---|---|---|---|
| ||||
<fields>
<field>Integer Field 1</field>
<field>Boolean Field 1</field>
<field>Text Field 1</field>
<field>Large Text Field 1</field>
<field>Choice Field 1</field>
<field>Credential Field 6</field>
<field>Script Field 1</field>
<field>Array Field 1</field>
<field>Float Field 2</field>
</fields> |
Code Block | ||||
---|---|---|---|---|
| ||||
"fields": [
"Integer Field 1",
"Boolean Field 1",
"Text Field 1",
"Large Text Field 1",
"Choice Field 1",
"Credential Field 6",
"Script Field 1",
"Array Field 1",
"Float Field 2"
] |
Valid values for field:
As String =
Integer Field [1-10]
Boolean Field [1-10]
Text Field [1-20]
Large Text Field [1-2]
Choice Field [1-15]
Credential Field [1-6]
Script Field [1-2]
Array Field [1-4]
Float Field [1-4]
N
label Anchor label - COMMAND label - COMMAND
Label
User-friendly display name for the command, to be displayed within the client.
Y
name Anchor name - COMMAND name - COMMAND
Name
Unique name of this command, adhering to the same naming convention as a Universal Template field name.
Y
statuses Anchor statuses - COMMAND statuses - COMMAND
Supported Status(es)
Task instance status(es) that the dynamic command should be enabled for.
Code Block | ||||
---|---|---|---|---|
| ||||
<statuses>
<status>Defined</status>
<status>Waiting</status>
</statuses> |
Code Block | ||||
---|---|---|---|---|
| ||||
"statuses": [
"Defined",
"Waiting"
] |
Valid values for status:
As String = Defined, As Value = 0
As String = Waiting, As Value = 10
As String = Time Wait, As Value = 15
As String = Held, As Value = 20
As String = Exclusive Requested, As Value = 22
As String = Exclusive Wait, As Value = 23
As String = Resource Requested, As Value = 25
As String = Resource Wait, As Value = 30
As String = Execution Wait, As Value = 33
As String = Undeliverable, As Value = 35
As String = Queued, As Value = 40
As String = Submitted, As Value = 43
As String = Action Required, As Value = 60
As String = Started, As Value = 70
As String = Running, As Value = 80
As String = Running/Problems, As Value = 81
As String = Cancel Pending, As Value = 99
As String = In Doubt, As Value = 110
As String = Start Failure, As Value = 120
As String = Confirmation Required, As Value = 125
As String = Cancelled, As Value = 130
As String = Failed, As Value = 140
As String = Skipped, As Value = 180
As String = Finished, As Value = 190
As String = Success, As Value = 200
Y
Anchor | ||||
---|---|---|---|---|
|
sysId
n/a
sys_id used within the Controller to identify this Universal Template Field.
Persisted only if retainSysIds is set to true.
N
useFieldValueForLabel Anchor
CHOICEtimeout -
useFieldValueForLabel COMMAND
CHOICEtimeout - COMMAND useFieldValueForLabel
Use Value For Label
If the fieldValue
value is 50 characters or less; Use the fieldValue
value as the fieldValueLabel
value (which is a maximum 50 characters).
Boolean; Valid values: true/false. Default is false.
N
...
| Timeout (Seconds) | Optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds. | N |
Anchor | ||||
---|---|---|---|---|
|
The excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate
> element of XML web services.
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Asynchronous | N | ||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | executionOption - COMMAND | executionOption - COMMAND | executionOptionExecution Option | Specification for whether the command runs out-of-process execution or in-process execution. | Valid values:
Default is Out Of ProcessUnmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled. | Valid values:
Default is Prohibit Universal Event (1). | N | ||||||||||||||||||||||||||||||||||||||||||
| Dependent Fields | Universal Template fields (if any) that are required by the command. The values of those fields are included in the command request.Attributes | Zero or more attributes, specifying their Name, Label, and Type. |
Valid values for field:
| N | Anchor | label - COMMAND | label - COMMAND
| N | |||||||||||||||||||||||||||||||||||||||||
| Description | Description of the Universal Event. | N | |||||||||||||||||||||||||||||||||||||||||||||||
| Label | User-friendly display name for the commandevent, to be displayed within the client. | The Label must be unique. | Y | ||||||||||||||||||||||||||||||||||||||||||||||
| Name | Unique name of this command, adhering to the same naming convention as a Universal Template field name. | Y | |||||||||||||||||||||||||||||||||||||||||||||||
Anchor | statuses - COMMAND | statuses - COMMAND | statusesSupported Status(es) | Task instance status(es) that the dynamic command should be enabled for. |
Valid values for status:
| Y | ||||||||||||||||||||||||||||||||||||||||||||
Anchor | sysId - COMMAND | sysId - COMMAND | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if retainSysIds is set to true. | N | ||||||||||||||||||||||||||||||||||||||||||||
Anchor | timeout - COMMAND | timeout - COMMAND | timeoutTimeout (Seconds) | Optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds. | Nevent name, adhering to the same naming convention as a Universal Template field name. | Y | ||||||||||||||||||||||||||||||||||||||||||||
| Time To Live | Default value for Time to live; how long, in minutes, the Universal Event data is valid. | non-negative Integer | N | ||||||||||||||||||||||||||||||||||||||||||||||
| n/a | sys_id used within the Controller to identify this record. | Persisted only if retainSysIds is set to true. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| Label | User-friendly display name for the attribute, to be displayed within the client. | Attribute Label must be unique. | Y | ||||||
| Name | Unique attribute name, adhering to the same naming convention as a Universal Template field name. | Y | |||||||
| Type | Attribute type. | Valid values:
| Y |
Anchor | ||||
---|---|---|---|---|
|
...