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 | ||||
---|---|---|---|---|
|
...
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. | List of environment variables:
| 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:
Default is Script (1). | N | ||||||||||||
useCommonScript | 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 | |||||||||||||
waitForOutput | Wait For Output | If | Boolean; Valid values: true/false. Default is false. | N |
...