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 | ||||
---|---|---|---|---|
|
...
The excludeRelated and retainSysIds properties are specified as attributes in the <universalTemplate> element of XML web services.
...
XML
The exportReleaseLevel
property is specified as an attribute in XML.
...
Description | |
---|---|
URI | http://host_name/uc/resources/universaltemplate/list |
HTTP Method | GET |
Description | Retrieves information on all Universal Templates using specific query parameters. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | |
Universal Template Properties |
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. | Restriction to apply to the List of environment variables:
| N | ||||||||||||||||||
Anchor | environmentVariableFieldsRestriction - UTEMP | environmentVariableFieldsRestriction - UTEMP | Environment Variable Fields |
| 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: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 | |||||||||||||||||||
Valid values:
scriptTypeWindows | Windows Script File Type | If |
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 |
...
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:
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: | 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 |
...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
asynchronous | Asynchronous | If If | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||
| Execution Option | Specification for whether the command runs out-of-process execution or in-process execution. | Valid values:
Default is Out Of Process. | 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. |
Valid values for field:
| N | ||||||||||||||||||||
| Label | User-friendly display name for the command, to be displayed within the client. | Y |
The excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate
> element of XML web services.
Property | UI Field Name | Description | Specifications | Required | name | Name | Unique event name, adhering to the same naming convention as a Universal Template field name. | Y | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
label | Label | User-friendly display name for the event, 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. | N |
...
Unique name of this command, adhering to the same naming convention as a Universal Template field name. | Y | |||||||||||||||||||||||
| Supported Status(es) | Task instance status(es) that the dynamic command should be enabled for. |
Valid values for status:
| Y | ||||||||||||||||||||
sysId | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if retainSysIds is set to true. | 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 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Unmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled. | Valid values:
Default is Prohibit Universal Event (1). | N | |||||||||||||||||||||||||||
| Attributes | Zero or more attributes, specifying their Name, Label, and Type. |
| N | |||||||||||||||||||||||||||
| Description | Description of the Universal Event. | N | ||||||||||||||||||||||||||||
TTL | Time To Live | Default value for Time to live; how long, in minutes, the Universal Event data is valid. | non-negative Integer | N | |||||||||||||||||||||||||||
attributePolicy | Unmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled. | Valid values:
Default is Prohibit Universal Event (1). | N | |||||||||||||||||||||||||||
attributes | Attributes | Zero or more attributes, specifying their Name, Label, and Type. |
Expand |
Code Block |
| Label | User-friendly display name for the event, to be displayed within the client. | The Label must be unique. | Y | ||||||||||||||||||||||
| Name | Unique event 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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
| Name | Unique attribute name, adhering to the same naming convention as a Universal Template field name. | Y |
| Label | User-friendly display name for the attribute, to be displayed within the client. | The 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 |
...
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Mutually Exclusive With | |||||
| n/a | Name ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Example
Code Block | ||
---|---|---|
| ||
curl --data-binary @extension.zip "http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1" --header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************" |
...
Description | |||||
---|---|---|---|---|---|
URI | http://host_name/uc/resources/universaltemplate/exporttemplate | ||||
HTTP Method | GET | ||||
Description | Download the zip file of a Universal Template specified by a URI parameter. The file will contain the following entries:
| ||||
URI Parameters | See Universal Template Export: URI Parameters, below. | ||||
Example URI |
|
| |||
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Example
Code Block | ||
---|---|---|
| ||
curl --data-binary @extension.zip "http://localhost:8080/uc/resources/universaltemplate/ |
...
extension?templatename |
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/octet-stream
...
Example Response
...
Status 200
[Binary data sent in response]
...
Status 403
Operation prohibited for built-in universal templates.
Operation prohibited due to security constraints.
...
Status 404
A universal template with name “{templatename}” does not exist.
A universal template with id "{templateid}" does not exist.
Status 500
...
Read universal template failed. {errors}
...
=Template1" --header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************" |
Anchor | ||
---|---|---|
|
...
|
...
...
The following URI parameters will be needed for exporting the Universal Template.
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |
---|---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
| |
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
| excludeExtension | n/a | Indication of whether the extension archive zip file should be excluded in the export operation. | Boolean (True/False, true/false); URI parameter | N (false by default) |
Example
...
language | text |
---|---|
firstline | 1 |
linenumbers | true |
...
URI | http://host_name/uc/resources/universaltemplate/exporttemplate |
HTTP Method | GET |
Description | Download the zip file of a Universal Template specified by a URI parameter. The file will contain the following entries:
|
URI Parameters | See Universal Template Export: URI Parameters, below. |
Example URI |
...
...
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/octet-stream |
...
Export File Entries
The downloaded Universal Template zip file will include the following required/optional entries:
File Name | Description | Present If… |
---|---|---|
template.json | The Universal Template definition in JSON format. | Always |
template_icon.png | The Universal Template Icon in PNG format. Icon metadata will be set as attributes in the Universal Template JSON. | The template has an icon. |
extension_archive.zip | The Universal Template Extension Archive in ZIP format. | The template has an extension and the optional query parameter excludeExtension is not set to true |
Example Response |
|
Anchor | ||
---|---|---|
|
...
|
...
|
...
Export: URI Parameters
The following URI parameters will be needed for exporting the Universal Template.
Name | UI Field Name | Description |
---|---|---|
URI | http://host_name/uc/resources/universaltemplate/importtemplate | |
HTTP Method | POST | |
Description | Upload the zip file of a Universal Template to be created/updated. | |
URI Parameters | See Universal Template Import: URI Parameters, below. | |
Example URI | http://localhost:8080/uc/resources/universaltemplate/importtemplate | |
Authentication | HTTP Basic | |
Consumes Content-Type | application/octet-stream, application/zip, application/x-zip-compressed | |
Produces Content-Type | plain/text | |
Example Response |
|
Binary Data
...
Specifications | Required | Mutually Exclusive With | |||
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
excludeExtension | n/a | Indication of whether the extension archive zip file should be excluded in the export operation. | Boolean (True/False, true/false); URI parameter | N (false by default) |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --location --request GET "http://localhost:8008/uc/resources/universaltemplate/exporttemplate?templatename=Template1"
--header "Content-Type: application/octet-stream" --header "Authorization: Basic xxxxxxxxxxxxxxxxxxx" -O -J |
Export File Entries
The downloaded Universal Template zip file will include the following required/optional entries:
File Name | DescriptionOptional | Present If… |
---|---|---|
template.json | The Universal Template definition in JSON format. | NoAlways |
template_icon.png | The Universal Template Icon in PNG format. Icon metadata will be set as attributes in the Universal Template JSON. | YesThe template has an icon. |
extension_archive.zip | The Universal Template Extension Archive in ZIP format. | Yes |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data-binary @unv-tmplt-Template1.zip "http://localhost:8080/uc/resources/universaltemplate/importtemplate"
--header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************" |
...
format. | The template has an extension and the optional query parameter excludeExtension is not set to true. |
Anchor | ||||
---|---|---|---|---|
|
The excludeRelated and retainSysIds properties are specified as attributes in the <universalTemplate> element of XML web services.
...
Description
URI
HTTP Method
DELETE
Description
Deletes a Universal Event Template.
URI Parameters
See Delete a Universal Template URI Parameters, below.
Example URI
Description | |||
---|---|---|---|
URI | http://host_name/uc/resources/universaltemplate/ universaleventtemplate | ||
HTTP Method | POST | Description | Creates a new Universal Event Template |
Description | Upload the zip file of a Universal Template to be created/updated. | ||
URI Parameters | See Universal Template Import: URI Parameters, below. | ||
Example URI | http://localhost:8080/uc/resources /universaleventtemplate | ||
Authentication | HTTP Basic | ||
Consumes Content-Type | application/xmloctet-stream, application/zip, application/jsonx-zip-compressed | ||
Produces Content-Type | nplain/a | ||
Example | See Create, Modify, and Read a Universal Template: XML and JSON Examples, below. | ||
Universal Event Template Properties | |||
Example Response |
|
...
text | |
Example Response |
|
Binary Data
The uploaded Universal Template zip file will include the following required/optional entries:
File Name | Description | Optional |
---|---|---|
template.json | The Universal Template definition in JSON format. | No |
template_icon.png | The Universal Template Icon in PNG format. Icon metadata will be set as attributes in the Universal Template JSON. | Yes |
extension_archive.zip | The Universal Template Extension Archive in ZIP format. | Yes |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data-binary @unv-tmplt-Template1.zip "http://localhost:8080/uc/resources/universaltemplate |
...
Example Response
...
- Status 200 /OK
Universal template deleted successfully. - Status 400 /Bad Request
Mutual exclusion violation. Cannot specify templatename and templateid at the same time. - Status 404 /Not Found
A universal template with {name/id} does not exist.
...
/importtemplate"
--header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************" |