...
...
Panel | ||||
---|---|---|---|---|
|
...
Note | ||
---|---|---|
| ||
You cannot create, read, modify, or list Built-In Universal Templates. You can delete Built-In Universal Templates. |
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 | ||||
---|---|---|---|---|
|
...
...
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 | | environmentVariableFieldsRestriction - UTEMP | environmentVariableFieldsRestriction - UTEMP |
Panel |
---|
N
|
N
Anchor | ||||
---|---|---|---|---|
|
environmentVariableFieldsRestriction
Environment Variable Fields
Restriction to apply to the group of Environment Variables Fields.
Valid values:
- As String = No Restriction, As Value = 0
- As String = Read Only, As Value = 1
- As String = Hidden, As Value = 2
N
Anchor | ||||
---|---|---|---|---|
|
excludeRelated
n/a
Specification for whether or not to exclude related records.
Boolean; Valid values: true/false. Default is false.
For XML, excludeRelated
is specified as an attribute on the universalTemplate
element.
N
Anchor | ||||
---|---|---|---|---|
|
exitCodeOutput
Output File
Path and file name of the output file that should be scanned for the text in exitCodeText
.
N
Anchor | ||||
---|---|---|---|---|
|
exitCodeProcessing
Exit Code Processing
Specification for how the Controller should determine whether the executed command failed or completed successfully.
Valid values:
- As String = Success Exitcode Range, As Value = 1
- As String = Failure Exitcode Range, As Value = 2
- As String = Success Output Contains, As Value = 3
- As String = Failure Output Contains, As Value = 4
Default is Success Exitcode (1).
N
Anchor | ||||
---|---|---|---|---|
|
exitCodeProcessingFieldsRestriction
Exit Code Processing Fields
Restriction to apply to the group of Exit Code Processing Fields.
Valid values:
- As String = No Restriction, As Value = 0
- As String = Read Only, As Value = 1
- As String = Hidden, As Value = 2
N
Anchor | ||||
---|---|---|---|---|
|
exitCodes
Exit Codes
If exitCodeProcessing
is Success Exitcode Range or Failure Exitcode Range; Range of exit codes.
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
Scan Output For
If exitCodeProcessing
is Success Output Contains (3) or Failure Output Contains (4); text for which the Controller should scan the output file.
The Controller will process this field as a regular expression.
Y
Anchor | ||||
---|---|---|---|---|
|
exportReleaseLevel
Universal Controller release that the record was exported from.
Anchor | ||||
---|---|---|---|---|
|
name
Name
Name of this Universal Template.
Y
Anchor | ||||
---|---|---|---|---|
|
outputFailureOnly
Failure Only
If outputReturnType
= STDOUT (2), STDERR (3), FILE (4), or OUTERR (6), and waitForOutput
is false; Indication for whether output should be retrieved on task failure only.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
outputReturnFile
Output File
If outputReturnType
is FILE; Path and file name containing the output that you want automatically retrieved and attached to the task instance.
N
Anchor | ||||
---|---|---|---|---|
|
outputReturnNline
Number of Lines
If outputReturnType
is STDOUT, STDERR, FILE, or OUTERR; Limit the retrieved data to this number of lines.
Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.
N
Anchor | ||||
---|---|---|---|---|
|
outputReturnSline
Start Line
If outputReturnType
is STDOUT, STDERR, FILE, or OUTERR; Instructs the Controller to retrieve data beginning at the line indicated.
Default is 1.
N
Anchor | ||||
---|---|---|---|---|
|
outputReturnText
Scan Text
If outputReturnType
is STDOUT, STDERR, FILE, or OUTERR; Instructs the Controller to scan the data for the text specified and retrieve only that.
The Controller will process this field as a regular expression.
N
Anchor | ||||
---|---|---|---|---|
|
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:attach it to the task instance record.
Valid values:
- As String = NONE, As Value = 1
- As String = STDOUT, As Value = 2
- As String = STDERR, As Value = 3
- As String = FILE, As Value = 4
- As String = OUTERR, As Value = 6
Default is OUTERR (6).
Note | ||
---|---|---|
| ||
If |
N
Anchor | ||||
---|---|---|---|---|
|
outputType
Output Type
If exitCodeProcessing
is Success Output or Failure Output; Type of output.
Valid values:
- As String = STDOUT, As Value = 1
- As String = STDERR, As Value = 2
- As String = FILE, As Value = 3
Default is STDOUT (1).
N
Anchor | ||||
---|---|---|---|---|
|
retainSysIds
n/a
Specification for whether or not the Create a Universal Template web service will persist the sysId
property.
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.
N
Anchor | ||||
---|---|---|---|---|
|
runtimeDir
Runtime Directory
Directory from which the application should be executed.
Variables are supported.
N
Anchor | ||||
---|---|---|---|---|
|
script
Script
If useCommonScript
is true; Script to be executed by the specified Agent.
N
Anchor | ||||
---|---|---|---|---|
|
scriptUnix
Linux/Unix Script
If agentType
is Any or Linux/Unix; Script to be executed by the Linux/Unix Agent.
N
Anchor | ||||
---|---|---|---|---|
|
scriptWindows
Windows Script
If agentType
is Any or Windows; Script to be executed by the Windows Agent.
N
Anchor | ||||
---|---|---|---|---|
|
scriptTypeWindows
Windows Script File Type
If agentType
is Windows; Type of Windows Script to be executed by the Windows Agent.
Valid values:
- As String = bat
- As String = cmd
- As String = js
- As String = ps1
- As String = py
- As String = uapy
- As String = vbs
- As String = wsf
- As String = Other
N
Anchor | ||||
---|---|---|---|---|
|
sendVariables
If templateType
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.
Valid values:
As String = None, As Value = 0
As String = Local, As Value = 1
Default is None (0).
Anchor | ||||
---|---|---|---|---|
|
sysId
UUID
System ID field in the database for this record.
Persisted only if retainSysIds
is set to true.
N
Anchor | ||||
---|---|---|---|---|
|
templateType
Valid values:
As String = Script, As Value = 1
As String = Extension, As Value = 2
Default is Script (1).
Anchor | ||||
---|---|---|---|---|
|
useCommonScript
Use Common Script
Indication that the specified script
can be executed by both Linux/Unix and Windows Agents.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
waitForOutput
Wait For Output
If outputReturnType
= STDOUT (2), STDERR (3), FILE (4), or OUTERR (6), and outputFailureOnly
is false; Specification for whether or not the task should wait for the requested output before completing.
Boolean; Valid values: true/false. Default is false.
N
...
Property | UI Field Name | Description | Specifications | Required | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
arrayNameTitle | Name Title | If fieldType is Array; Title to be displayed for the Name column. | N | ||||||||||||
arrayValueTitle | Value Title | If 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:Boolean value for this Field. | Valid values:
Default is true/false (1). | N | |||||||||||
booleanYesValue | Yes Value | If | 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 | ||||||||||||
choiceSortOption | Choice Sort Option | If | Valid values:
Default is Sequence (1). | N | |||||||||||
defaultListView | Add To Default List View | Specification that the | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
fieldLength | Length | If | Integer | N | |||||||||||
fieldMapping | Mapping | 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 | |||||||||||
required | Required | Specification for whether this Field is required or optional.
| 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 | |||||||||||
sequence | 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. | Integer; Read-only.
| N | |||||||||||
showIfField | Show If Field | If | Valid values:
| N | |||||||||||
showIfFieldValue | Show If Field Value | If | Y | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if | N |
...