Page Comparison

URI

HTTP Method

POST

Description

Creates a new Universal Template.

Example URI

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

See Web Services#Universal Template Universal Template Properties.

Field Properties

See 63553327 Field Properties.

Choice Properties

See 63553327 Choice Properties.

Example Response

• Status 200 /OK
  Successfully created the universal template with sysId {sysId}.
• Status 400 /Bad Request
  Create universal template failed. (message)

Agent

Name of the Agent to use.

N

agentVar,
broadcastCluster, and
broadcastClusterVar

Agent Cluster

Group of Agents, one of which the Controller will choose to run this task (compare with broadcastCluster).

N

agentClusterVar,
broadcastCluster, and
broadcastClusterVar

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

agentCluster,
broadcastCluster, and
broadcastClusterVar

Agent Fields

Restriction to apply to the group of Agent Fields.

Valid values:

• As String = No Restriction, As Value = 0
• As String = Read Only, As Value = 1
• As String = Hidden, As Value = 2

N

Agent Type

Type of Agent on which Universal Tasks based on this template can be run.

Valid values:

• As String = Any, As Value = 1
• As String = Linux/Unix, As Value = 2
• As String = Windows, As Value = 3

Y

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

agent,
broadcastCluster, and
broadcastClusterVar

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

Automatic Output Retrieval Fields

Restriction to apply to the group of Automatic Output Retrieval Fields.

Valid values:

• As String = No Restriction, As Value = 0
• As String = Read Only, As Value = 1
• As String = Hidden, As Value = 2

N

Cluster Broadcast

Group of Agents, all of which will run this task (compare with agentCluster). Each instance of the task running on its own Agent becomes a separate task instance record in the database and displays separately on the Activity Monitor.

N

broadcastClusterVar,
agent,
agentVar,
agentCluster, and
agentClusterVar

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

broadcastCluster,
agent,
agentVar,
agentCluster, and
agentClusterVar

Create Console

If desktopInteract is true; Specification for whether or not to allocate a new console for the process, rather than having it inherit one.

Boolean; Valid values: true/false. Default is false.

N

Credential Fields

Restriction to apply to the group of Credential Fields.

Valid values:

• As String = No Restriction, As Value = 0
• As String = Read Only, As Value = 1
• As String = Hidden, As Value = 2

N

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

credentials

Description

Description of this Universal Template.

N

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.
 
This property is effective only for tasks executed on Windows XP or Server 2003. Windows Vista introduced the desktop isolation feature, which prevents tasks from accessing the interactive desktop session on Vista, Windows 7, Server 2008, Windows 8, and Server 2012. The Windows agent will execute the task, but the Interact with Desktop option has no effect. Therefore, an interactive application's GUI will not be visible on those platforms.

N

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.
 
This property will not give a user account privileges that have are not already granted to it. For example, taking ownership of a file is a privileged operation by default. A task will still fail even with this option selected if it is run with a regular user account that has not been granted the ability to change file ownership.

N

Environment Variables

Environment variables needed by the program to run.

N

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

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

Output File

Path and file name of the output file that should be scanned for the text in exitCodeText.

N

Exit Code Processing

Specification for how the Controller should determine whether the executed command failed or completed successfully.

N

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

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

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

Universal Controller release that the record was exported from.

Name

Name of this Universal Template.

Y

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

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

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

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

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

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.

N

Output Type

If exitCodeProcessing is Success Output or Failure Output; Type of output.

N

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

Runtime Directory

Directory from which the application should be executed.

Variables are supported.

N

Script

If useCommonScript is true; Script to be executed by the specified Agent.

N

Linux/Unix Script

If agentType is Any or Linux/Unix; Script to be executed by the Linux/Unix Agent.

N

Windows Script

If agentType is Any or Windows; Script to be executed by the Windows Agent.

N

Windows Script File Type

If agentType is Windows; Type of Windows Script to be executed by the Windows Agent.

N

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

UUID

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

Valid values:

• As String = Script, As Value = 1

• As String = Extension, As Value = 2

Default is Script (1).

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

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

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