Panel

Table of Contents

maxlevel	2

...

Note

title	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

title	Note

Enabling these audit properties can generate a large quantity of audit.

Anchor
Create a Universal Template
Create a Universal Template
Create a Universal Template

...

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.

XML

JSON

Expand

title	XML

<universalTemplate exportReleaseLevel="7.2.0.0" retainSysIds="true">
    <agent />
    <agentCluster />
    <agentClusterVar />
    <agentFieldsRestriction>No Restriction</agentFieldsRestriction>
    <agentType>Windows</agentType>
    <agentVar />
    <alwaysCancelOnFinish />
    <automaticOutputRetrievalFieldsRestriction>Hidden</automaticOutputRetrievalFieldsRestriction>
    <broadcastCluster />
    <broadcastClusterVar />
    <commands>
        <command>
            <asynchronous>true</asynchronous>
            <executionOption>In Process</executionOption>
            <fields />
            <label>1</label>
            <name>command</name>
            <statuses>
                <status>Queued</status>
            </statuses>
            <sysId>db947be2c7f046dea54e3e49d3c1d349</sysId>
            <timeout />
        </command>
        <command>
            <asynchronous>false</asynchronous>
            <executionOption>Out Of Process</executionOption>
            <fields/>
            <label>2</label>
            <name>command2</name>
            <statuses>
                <status>Queued</status>
            </statuses>
            <sysId>e9ddbdbba21d451c8baf3cf11db48c3b</sysId>
            <timeout />
        </command>
    </commands>
    <createConsole>false</createConsole>
    <credentialFieldsRestriction>Hidden</credentialFieldsRestriction>
    <credentials />
    <credentialsVar />
    <description /> 
    <desktopInteract>false</desktopInteract> 
    <elevateUser>false</elevateUser> 
    <environment /> 
    <environmentVariablesFieldsRestriction>Read Only</environmentVariablesFieldsRestriction> 
     <exitCodeOutput /> 
    <exitCodeProcessing>Success Exitcode Range</exitCodeProcessing<events>
        <event>
    <exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction> 
    <exitCodeText /> 
    <exitCodes>0</exitCodes> 
    <fields> 
        <field>
            <arrayNameTitle />
            <arrayValueTitle /> 
            <booleanNoValue /> 
            <booleanValueType>true/false</booleanValueType> 
            <booleanYesValue />
            <choiceAllowEmpty>false</choiceAllowEmpty>
            <choiceAllowMultiple>false</choiceAllowEmpty> 
            <choiceSortOption>Sequence</choiceSortOption> 
            <choices /> 
            <defaultListView>false</defaultListView> 
            <fieldLength /> 
            <fieldMapping>Text Field 1</fieldMapping> 
            <fieldType>Text</fieldType> 
            <fieldValue /> 
            <formColumnSpan>1</formColumnSpan> 
            <formEndRow>false</formEndRow> 
            <formStartRow>false</formStartRow> 
            <hint             <attributes>
                 <attribute>
                     <label>attribute_label1</label>
                     <name>attribute_name1</name>
                     <type>Text</type>
                 </attribute>
                 <attribute>
                     <label>attribute_label2</label>
                     <name>attribute_name2</name>
                     <type>Integer</type>
                 </attribute>
                 <attribute>
                     <label>attribute_label3</label>
                     <name>attribute_name3</name>
                     <type>Boolean</type>
                 </attribute>
                 <attribute>
                     <label>attribute_label4</label>
                     <name>attribute_name4</name>
                     <type>Float</type>
                 </attribute>
             </attributes>
             <attributesPolicy>Include Attributes</attributesPolicy>
             <description>Global universal event template description.</description>
             <label>Global Universal Event - Label</label>
             <name>global_universal_event_template</name>
             <sysId>66c6e90f5a334378809884a11cb12ac0</sysId>
             <ttl>11</ttl>
        </event>
    <events>
    <exitCodeOutput /> 
    <exitCodeProcessing>Success        <intFieldMax /Exitcode Range</exitCodeProcessing> 
        <exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction> 
    <intFieldMinexitCodeText /> 
        <exitCodes>0</exitCodes> 
    <label>Service</label> fields> 
        <field>
            <name>service<arrayNameTitle /name> 
            <noSpaceIfHidden>true<arrayValueTitle /noSpaceIfHidden> 
            <preserveValueIfHidden>false<booleanNoValue /preserveValueIfHidden> 
              <required>false</required    <booleanValueType>true/false</booleanValueType> 
            <requireIfFieldbooleanYesValue /> 
            <requireIfFieldValue choiceAllowEmpty>false</choiceAllowEmpty> 
            <requireIfVisible>true<choiceAllowMultiple>false</requireIfVisiblechoiceAllowEmpty> 
            <sequence>0<choiceSortOption>Sequence</sequencechoiceSortOption> 
            <showIfField>Booleanchoices Field 1</showIfField> 
            <showIfFieldValue>true<defaultListView>false</showIfFieldValuedefaultListView> 
            <sysId>f30ae218f2c64e0a96c5c64a7523e215<fieldLength /sysId> 
            </field>fieldMapping>Text Field 1</fieldMapping> 
            <field><fieldType>Text</fieldType> 
            <arrayNameTitlefieldValue /> 
            <arrayValueTitle formColumnSpan>1</formColumnSpan> 
            <booleanNoValue formEndRow>false</formEndRow> 
            <booleanValueType>true/false</booleanValueTypeformStartRow>false</formStartRow> 
            <booleanYesValuehint /> 
            <choiceAllowEmpty>false</choiceAllowEmpty>intFieldMax /> 
            <choiceAllowMultiple>false<intFieldMin /choiceAllowEmpty> 
            <choiceSortOption>Sequence<label>Service</choiceSortOptionlabel> 
            <choicesname>service</name> 
                <choice> 
    <noSpaceIfHidden>true</noSpaceIfHidden>
            <fieldValue>1<preserveValueIfHidden>false</fieldValuepreserveValueIfHidden> 
                <fieldValueLabel>Start<required>false</fieldValueLabelrequired> 
            <requireIfField    <sequence>0</sequence> 
            <requireIfFieldValue    <sysId>95b7d388a2ec407cb5f36768482449b0</sysId> 
                <useFieldValueForLabel>false<requireIfVisible>true</useFieldValueForLabelrequireIfVisible> 
                <sequence>0</choice>sequence> 
                <choice><showIfField>Boolean Field 1</showIfField> 
                    <fieldValue>2</fieldValue<showIfFieldValue>true</showIfFieldValue> 
            <sysId>f30ae218f2c64e0a96c5c64a7523e215</sysId> 
        <fieldValueLabel>Stop</fieldValueLabel>field> 
        <field> 
            <sequence>1<arrayNameTitle /sequence>
 
           <arrayValueTitle /> 
            <sysId>07802a9cae3945769cfecbaeb2d1de70<booleanNoValue /sysId> 
                    <useFieldValueForLabel>false</useFieldValueForLabel<booleanValueType>true/false</booleanValueType> 
            <booleanYesValue    </choice> >
            <choiceAllowEmpty>false</choiceschoiceAllowEmpty>
            <defaultListViewchoiceAllowMultiple>false</defaultListViewchoiceAllowEmpty> 
            <fieldLength choiceSortOption>Sequence</choiceSortOption> 
            <fieldMapping>Choice Field 1</fieldMapping> 
choices>
                <choice> 
                <fieldType>Choice<fieldValue>1</fieldTypefieldValue> 
                <fieldValue fieldValueLabel>Start</fieldValueLabel> 
                <formColumnSpan>1<sequence>0</formColumnSpansequence> 
                <formEndRow>false<sysId>95b7d388a2ec407cb5f36768482449b0</formEndRowsysId> 
                <formStartRowuseFieldValueForLabel>false</formStartRowuseFieldValueForLabel> 
            <hint />    <intFieldMax />choice> 
            <intFieldMin />   <choice> 
            <label>Command</label        <fieldValue>2</fieldValue> 
                    <name>command<fieldValueLabel>Stop</namefieldValueLabel> 
                    <noSpaceIfHidden>false<sequence>1</noSpaceIfHiddensequence> 
            <preserveValueIfHidden>false</preserveValueIfHidden        <sysId>07802a9cae3945769cfecbaeb2d1de70</sysId> 
                    <requireduseFieldValueForLabel>false</requireduseFieldValueForLabel> 
                <requireIfField />choice> 
            <requireIfFieldValue /choices>
            <requireIfVisibledefaultListView>false</requireIfVisibledefaultListView> 
            <sequence>1<fieldLength /sequence> 
            <showIfField>BooleanfieldMapping>Choice Field 2<1</showIfFieldfieldMapping> 
            <showIfFieldValue>false<fieldType>Choice</showIfFieldValuefieldType> 
            <sysId>88ba718e6b8b4ee984266faf362c3fde<fieldValue /sysId> 
        </field> 
    <formColumnSpan>1</fieldsformColumnSpan> 
    <name>UT1</name> 
        <outputFailureOnly>true<formEndRow>false</outputFailureOnlyformEndRow> 
    <outputReturnFile /> 
        <outputReturnNline>100<formStartRow>false</outputReturnNlineformStartRow> 
    <outputReturnSline>1</outputReturnSline> 
        <outputReturnTexthint /> 
    <outputReturnType>NONE</outputReturnType<intFieldMax /> 
    <outputType>STDOUT</outputType> 
        <runtimeDirintFieldMin /> 
    <script /        <label>Command</label> 
    <scriptTypeWindows /> 
        <scriptUnix name>command</name> 
    <scriptWindows>exit 0</scriptWindows        <noSpaceIfHidden>false</noSpaceIfHidden>
            <preserveValueIfHidden>false</preserveValueIfHidden> 
            <sysId>32e34b8d138f40a2afbdda79cb1b1d56<required>false</sysIdrequired> 
    <useCommonScript>false</useCommonScript        <requireIfField /> 
            <variablePrefix>ut1<requireIfFieldValue /variablePrefix>
     
       <waitForOutputrequireIfVisible>false</waitForOutputrequireIfVisible> 
            </universalTemplate>

Expand

title	JSON

{
    "agent": null,
    "agentCluster": null,
    "agentClusterVar": null,
    "agentFieldsRestriction": "No Restriction",
    "agentType": "Windows",
    "agentVar": null,
    "alwaysCancelOnFinish": false,
    "automaticOutputRetrievalFieldsRestriction": "Hidden",
    "broadcastClustersequence>1</sequence> 
            <showIfField>Boolean Field 2</showIfField> 
            <showIfFieldValue>false</showIfFieldValue> 
            <sysId>88ba718e6b8b4ee984266faf362c3fde</sysId> 
        </field> 
    </fields> 
    <name>UT1</name> 
    <outputFailureOnly>true</outputFailureOnly> 
    <outputReturnFile /> 
    <outputReturnNline>100</outputReturnNline> 
    <outputReturnSline>1</outputReturnSline> 
    <outputReturnText /> 
    <outputReturnType>NONE</outputReturnType> 
    <outputType>STDOUT</outputType> 
    <runtimeDir /> 
    <script /> 
    <scriptTypeWindows /> 
    <scriptUnix /> 
    <scriptWindows>exit 0</scriptWindows> 
    <sendVariables>None</sendVariables>
    <sysId>32e34b8d138f40a2afbdda79cb1b1d56</sysId>
    <templateType>Extension</templateType> 
    <useCommonScript>false</useCommonScript> 
    <variablePrefix>ut1</variablePrefix> 
    <waitForOutput>false</waitForOutput> 
</universalTemplate>

Expand

title	JSON

{
    "agent": null,
    "broadcastClusterVaragentCluster": null,

    "commandsagentClusterVar": [
        {
            "asynchronous": true,
            "executionOption": "In Process",
            "fields": [],
 null,
    "agentFieldsRestriction": "No Restriction",
    "agentType": "Windows",
    "agentVar": null,
    "alwaysCancelOnFinish": false,
    "automaticOutputRetrievalFieldsRestriction": "Hidden",
    "broadcastCluster": null,
    "broadcastClusterVar": null,
    "commands": [
        {
            "asynchronous": true,
            "executionOption": "In Process",
            "fields": [],
            "label": "1",
            "name": "command",
            "statuses": [
                "Queued"
            ],
            "sysId": "db947be2c7f046dea54e3e49d3c1d349",
            "timeout": null
        },
        {
            "asynchronous": false,
            "executionOption": "Out Of Process",
            "fields": [],
            "label": "2",
            "name": "command2",
            "statuses": [
                "Queued"
            ],
            "sysId": "e9ddbdbba21d451c8baf3cf11db48c3b",
            "timeout": null
        }
      ],
      "createConsole": false, 
      "credentialFieldsRestriction": "Hidden", 
      "credentials": null, 
      "credentialsVar": null, 
      "description": null, 
      "desktopInteract": false, 
      "elevateUser": false, 
      "environment": [], 
      "environmentVariablesFieldsRestriction": "Read Only", 
      "exitCodeOutput": null, 
      "exitCodeProcessing": "Success Exitcode Range", 
      "exitCodeProcessingFieldsRestriction": "Hidden", 
      "exitCodeText": null, 
      "exitCodes": "0",
      "exportReleaseLevel": "7.2.0.0",
      "fields": [ 
            {
                  "arrayNameTitle": null,
                  "arrayValueTitle": null, 
                  "booleanNoValue": null, 
                  "booleanValueType": "true/false", 
                  "booleanYesValue": null,
                  "choiceAllowEmpty": false,
                  "choiceAllowMultiple": false, 
                  "choiceSortOption": "Sequence", 
                  "choices": [], 
                  "defaultListView": false, 
                  "fieldLength": null, 
                  "fieldMapping": "Text Field 1", 
                  "fieldType": "Text", 
                  "fieldValue": null, 
                  "formColumnSpan": 1, 
                  "formEndRow": false, 
                  "formStartRow": false, 
                  "hint": null, 
                  "intFieldMax": null, 
                  "intFieldMin": null, 
                  "label": "Service", 
                  "name": "service", 
                  "noSpaceIfHidden": true,
                  "preserveValueIfHidden": false, 
                  "required": false, 
                  "requireIfField": null, 
                  "requireIfFieldValue": null, 
                  "requireIfVisible": true, 
                  "sequence": 0, 
                  "showIfField": "Boolean Field 1", 
                  "showIfFieldValue": true, 
                  "sysId": "f30ae218f2c64e0a96c5c64a7523e215" 
            }, 
            { 
                  "arrayNameTitle": null,
                  "arrayValueTitle": null, 
                  "booleanNoValue": null, 
                  "booleanValueType": "true/false", 
                  "booleanYesValue": null,
                  "choiceAllowEmpty": false,
                  "choiceAllowMultiple": false, 
                  "choiceSortOption": "Sequence", 
                  "choices": [ 
                        { 
                              "fieldValue": "1", 
                              "fieldValueLabel": "Start", 
                              "sequence": 0, 
                              "sysId": "95b7d388a2ec407cb5f36768482449b0", 
                              "useFieldValueForLabel": false 
                        }, 
                        { 
                              "fieldValue": "2", 
                              "fieldValueLabel": "Stop", 
                              "sequence": 1, 
                              "sysI": "07802a9cae3945769cfecbaeb2d1de70", 
                              "useFieldValueForLabel": false 
                        } 
                  ], 
                  "defaultListView": false, 
                  "fieldLength": null, 
                  "fieldMapping": "Choice Field 1", 
                  "fieldType": "Choice", 
                  "fieldValue": null, 
                  "formColumnSpan": 1, 
                  "formEndRow": false, 
                  "formStartRow": false, 
                  "hint": null, 
                  "intFieldMax": null, 
                  "intFieldMin": null, 
                  "label": "Command", 
                  "name": "command", 
                  "noSpaceIfHidden": false,
                  "preserveValueIfHidden": false, 
                  "required": false, 
                  "requireIfField": null, 
                  "requireIfFieldValue": null, 
                  "requireIfVisible": false, 
                  "sequence": 1, 
                  "showIfField": "Boolean Field 2", 
                  "showIfFieldValue": false, 
                  "sysId": "88ba718e6b8b4ee984266faf362c3fde" 
            } 
      ], 
      "name": "UT1", 
      "outputFailureOnly": true, 
      "outputReturnFile": null, 
      "outputReturnNline": "100", 
      "outputReturnSline": "1", 
      "outputReturnText": null, 
      "outputReturnType": "NONE", 
      "outputType": "STDOUT", 
      "retainSysIds": true, 
      "runtimeDir": null, 
      "script": null, 
      "scriptTypeWindows": null, 
      "scriptUnix": null, 
      "scriptWindows": "exit 0",
 
          "sysIdsendVariables": "32e34b8d138f40a2afbdda79cb1b1d56None", 
      "useCommonScriptsysId": false"32e34b8d138f40a2afbdda79cb1b1d56", 
           "variablePrefixtemplateType": "ut1Extension",
      "useCommonScript": false, 
      "variablePrefix": "ut1", 
      "waitForOutput": false
}

...

	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	http://localhost:8080/uc/resources/universaltemplate/list http://localhost:8080/uc/resources/universaltemplate/list?templatename=UT
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example	See List Universal Templates: XML and JSON Examples.
Universal Template Properties	See Universal Template Properties.

Anchor
List Universal Templates URI Parameters
List Universal Templates URI Parameters
List Universal Templates: URI Parameters

Parameter

Description

Specifications

Required

templatename

Name used within the Controller to identify this Universal Template.

String; URI parameter.

Wildcards are supported.

N

Anchor
List Universal Templates XML and JSON Examples
List Universal Templates XML and JSON Examples
List Universal Templates: XML and JSON Examples

XML

JSON

Expand

title	XML

<universalTemplates>
  <universalTemplate> exportReleaseLevel="7.2.0.0"
    <agent /> 
    <agentCluster /> 
    <agentClusterVar /> 
    <agentFieldsRestriction>No Restriction</agentFieldsRestriction> 
    <agentType>Windows</agentType> 
    <agentVar />
    <alwaysCancelOnFinish />
    <automaticOutputRetrievalFieldsRestriction>Hidden</automaticOutputRetrievalFieldsRestriction> 
    <broadcastCluster /> <broadcastClusterVar />
    <commands>
        <command>
            <asynchronous>true</asynchronous>
            <executionOption>In Process</executionOption>
            <fields />
            <label>1</label>
            <name>command</name>
            <statuses>
                <status>Queued</status>
            </statuses>
            <sysId>db947be2c7f046dea54e3e49d3c1d349</sysId>
            <timeout />
        </command>
        <command>
            <asynchronous>false</asynchronous>
            <executionOption>Out Of Process</executionOption>
            <fields/>
            <label>2</label>
            <name>command2</name>
            <statuses>
                <status>Queued</status>
            </statuses>
            <sysId>e9ddbdbba21d451c8baf3cf11db48c3b</sysId>
            <timeout />
        </command>
    </commands>
<createConsole>false</createConsole> 
<credentialFieldsRestriction>Hidden</credentialFieldsRestriction> 
<credentials /> 
<credentialsVar /> 
<description /> 
<desktopInteract>false</desktopInteract> 
<elevateUser>false</elevateUser> 
<environment /> 
<environmentVariablesFieldsRestriction>Read Only</environmentVariablesFieldsRestriction> 
<exitCodeOutput /> 
<exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
<exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction> 
<exitCodeText /> 
<exitCodes>0</exitCodes> 
<fields /> 
<name>UT1</name>
<noSpaceIfHidden>true</noSpaceIfHidden>
<preserveValueIfHidden>false</preserveValueIfHidden>
<outputFailureOnly>true</outputFailureOnly> 
<outputReturnFile /> 
<outputReturnNline>100</outputReturnNline> 
<outputReturnSline>1</outputReturnSline> 
<outputReturnText /> 
<outputReturnType>NONE</outputReturnType> 
<outputType>STDOUT</outputType> 
<runtimeDir /> 
<script /> 
<scriptTypeWindows /> 
<scriptUnix /> 
<scriptWindows>exit 0</scriptWindows> 
<sendVariables>None</sendVariables>
<sysId>32e34b8d138f40a2afbdda79cb1b1d56</sysId> 
<templateType>Extension</templateType>
<useCommonScript>false</useCommonScript> 
<variablePrefix>ut1</variablePrefix> 
<waitForOutput>false</waitForOutput> 
</universalTemplate>
<universalTemplate> 
exportReleaseLevel="7.2.0.0"
<agent />
<agentCluster /> 
<agentClusterVar /> 
<agentFieldsRestriction>No Restriction</agentFieldsRestriction> 
<agentType>Windows</agentType> 
<agentVar />
<alwaysCancelOnFinish /> 
<automaticOutputRetrievalFieldsRestriction>Hidden</automaticOutputRetrievalFieldsRestriction> 
<broadcastCluster /> 
<broadcastClusterVar /> 
<commands>
        <command>
            <asynchronous>true</asynchronous>
            <executionOption>In Process</executionOption>
            <fields />
            <label>1</label>
            <name>command</name>
            <statuses>
                <status>Queued</status>
            </statuses>
            <sysId>db947be2c7f046dea54e3e49d3c1d349</sysId>
            <timeout />
        </command>
        <command>
            <asynchronous>false</asynchronous>
            <executionOption>Out Of Process</executionOption>
            <fields/>
            <label>2</label>
            <name>command2</name>
            <statuses>
                <status>Queued</status>
            </statuses>
            <sysId>e9ddbdbba21d451c8baf3cf11db48c3b</sysId>
            <timeout />
        </command>
    </commands>
<createConsole>false</createConsole> 
<credentialFieldsRestriction>Hidden</credentialFieldsRestriction> 
<credentials /> 
<credentialsVar /> 
<description /> 
<desktopInteract>false</desktopInteract> 
<elevateUser>false</elevateUser> 
<environment /> 
<environmentVariablesFieldsRestriction>Read Only</environmentVariablesFieldsRestriction> 
<exitCodeOutput /> 
<exitCodeProcessing>Success Exitcode Range</exitCodeProcessing> 
<exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction> 
<exitCodeText /> 
<exitCodes>0</exitCodes> 
<fields /> 
<name>UT1</name>
<outputFailureOnly>true</outputFailureOnly> 
<outputReturnFile /> 
<outputReturnNline>100</outputReturnNline> 
<outputReturnSline>1</outputReturnSline> 
<outputReturnText /> 
<outputReturnType>NONE</outputReturnType> 
<outputType>STDOUT</outputType> 
<runtimeDir /> 
<script /> 
<scriptTypeWindows /> 
<scriptUnix /> 
<scriptWindows>exit 0</scriptWindows> 
<sendVariables>None</sendVariables>
<sysId>32e34b8d138f40a2afbdda79cb1b1d56</sysId> 
<templateType>Extension</templateType>
<useCommonScript>false</useCommonScript> 
<variablePrefix>ut1</variablePrefix> 
<waitForOutput>false</waitForOutput> 
</universalTemplate>
</universalTemplates>

Expand

title	JSON

[

"agent": null,
    "agentCluster": null,
    "agentClusterVar": null,
    "agentFieldsRestriction": "No Restriction",
    "agentType": "Windows",
    "agentVar": null,
    "alwaysCancelOnFinish": false,
    "automaticOutputRetrievalFieldsRestriction": "Hidden",
    "broadcastCluster": null,
    "broadcastClusterVar": null,
    "commands": [
        {
            "asynchronous": true,
            "executionOption": "In Process",
            "fields": [],
            "label": "1",
            "name": "command",
            "statuses": [
                "Queued"
            ],
            "sysId": "db947be2c7f046dea54e3e49d3c1d349",
            "timeout": null
        },
        {
            "asynchronous": false,
            "executionOption": "Out Of Process",
            "fields": [],
            "label": "2",
            "name": "command2",
            "statuses": [
                "Queued"
            ],
            "sysId": "e9ddbdbba21d451c8baf3cf11db48c3b",
            "timeout": null
        }
    ], 
    "createConsole": false, 
    "credentialFieldsRestriction": "Hidden", 
    "credentials": null, 
    "credentialsVar": null, 
    "description": null, 
    "desktopInteract": false, 
    "elevateUser": false, 
    "environment": [], 
    "environmentVariablesFieldsRestriction": "Read Only", 
    "exitCodeOutput": null, 
    "exitCodeProcessing": "Success Exitcode Range", 
    "exitCodeProcessingFieldsRestriction": "Hidden", 
    "exitCodeText": null, 
    "exitCodes": "0",
    "exportReleaseLevel": "0",
    "fields": [], 
    "name": "UT1", 
    "outputFailureOnly": true, 
    "outputReturnFile": null, 
    "outputReturnNline": "100", 
    "outputReturnSline": "1", 
    "outputReturnText": null, 
    "outputReturnType": "NONE", 
    "outputType": "STDOUT", 
    "retainSysIds": true, 
    "runtimeDir": null, "script": null, 
    "scriptTypeWindows": null, 
    "scriptUnix": null, 
    "scriptWindows": "exit 0", 
    "sendVariables": "None",
    "sysId": "32e34b8d138f40a2afbdda79cb1b1d56", 
    "templateType": "Extension",
    "useCommonScript": false, 
    "variablePrefix": "ut1", 
    "waitForOutput": false },
{
    "agent": null, 
    "agentCluster": null, 
    "agentClusterVar": null, 
    "agentFieldsRestriction": "No Restriction", 
    "agentType": "Windows", 
    "agentVar": null,
    "alwaysCancelOnFinish": false,
    "automaticOutputRetrievalFieldsRestriction": "Hidden",
    "broadcastCluster": null, 
    "broadcastClusterVar": null, 
    "commands": [
        {
            "asynchronous": true,
            "executionOption": "In Process",
            "fields": [],
            "label": "1",
            "name": "command",
            "statuses": [
                "Queued"
            ],
            "sysId": "db947be2c7f046dea54e3e49d3c1d349",
            "timeout": null
        },
        {
            "asynchronous": false,
            "executionOption": "Out Of Process",
            "fields": [],
            "label": "2",
            "name": "command2",
            "statuses": [
                "Queued"
            ],
            "sysId": "e9ddbdbba21d451c8baf3cf11db48c3b",
            "timeout": null
        }
      ],
    "createConsole": false, 
    "credentialFieldsRestriction": "Hidden", 
    "credentials": null, 
    "credentialsVar": null, 
    "description": null, 
    "desktopInteract": false, 
    "elevateUser": false, 
    "environment": [], 
    "environmentVariablesFieldsRestriction": "Read Only",
    "exitCodeOutput": null, 
    "exitCodeProcessing": "Success Exitcode Range", 
    "exitCodeProcessingFieldsRestriction": "Hidden", 
    "exitCodeText": null, 
    "exitCodes": "0",
    "exportReleaseLevel": "0",
    "fields": [], 
    "name": "UT1", 
    "outputFailureOnly": true, 
    "outputReturnFile": null, 
    "outputReturnNline": "100", 
    "outputReturnSline": "1", 
    "outputReturnText": null, 
    "outputReturnType": "NONE", 
    "outputType": "STDOUT", 
    "retainSysIds": true, 
    "runtimeDir": null, 
    "script": null, 
    "scriptTypeWindows": null, 
    "scriptUnix": null, 
    "scriptWindows": "exit 0", 
    "sendVariables": "None",
    "sysId": "32e34b8d138f40a2afbdda79cb1b1d56", 
    "templateType": "Extension",
    "useCommonScript": false, 
    "variablePrefix": "ut1", 
    "waitForOutput": false
}
]

...

environmentVariableFieldsRestriction

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	agent - UTEMP
	agent - UTEMP

agent

Agent

Name of the Agent to use.

N

agentVar,
broadcastCluster, and
broadcastClusterVar

Anchor

	agentCluster - UTEMP
	agentCluster - UTEMP

agentCluster

Agent Cluster

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

N

agentClusterVar,
broadcastCluster, and
broadcastClusterVar

Anchor

	agentClusterVar - UTEMP
	agentClusterVar - UTEMP

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

agentCluster,
broadcastCluster, and
broadcastClusterVar

Anchor

	agentFieldsRestriction - UTEMP
	agentFieldsRestriction - UTEMP

agentFieldsRestriction

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

Anchor

	agentType - UTEMP
	agentType - UTEMP

agentType

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

Anchor

	agentVar - UTEMP
	agentVar - UTEMP

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

agent,
broadcastCluster, and
broadcastClusterVar

Anchor

	alwaysCancelOnFinish - UTEMP
	alwaysCancelOnFinish - UTEMP

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

Anchor

	automaticOutputRetrievalFieldsRestriction - UTEMP
	automaticOutputRetrievalFieldsRestriction - UTEMP

automaticOutputRetrievalFieldsRestriction

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

Anchor

	broadcastCluster - UTEMP
	broadcastCluster - UTEMP

broadcastCluster

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

Anchor

	broadcastClusterVar - UTEMP
	broadcastClusterVar - UTEMP

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

broadcastCluster,
agent,
agentVar,
agentCluster, and
agentClusterVar

Anchor

	createConsole - UTEMP
	createConsole - UTEMP

createConsole

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

Anchor

	credentialFieldsRestriction - UTEMP
	credentialFieldsRestriction - UTEMP

credentialFieldsRestriction

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

Anchor

	credentials - UTEMP
	credentials - UTEMP

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

Anchor

	credentialsVar - UTEMP
	credentialsVar - UTEMP

credentialsVar

Credentials Variable

Name of a variable that will be resolved at run time to the name of the {Credentials] to use.

N

credentials

Anchor

	description - UTEMP
	description - UTEMP

description

Description

Description of this Universal Template.

N

Anchor

	desktopInteract - UTEMP
	desktopInteract - UTEMP

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.

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

Anchor

	elevateUser - UTEMP
	elevateUser - UTEMP

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.

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

Anchor

	environment - UTEMP
	environment - UTEMP

environment

Environment Variables

Environment variables needed by the program to run.

Restriction to apply to the

List of environment variables:

Panel

N

Anchor

environmentVariableFieldsRestriction - UTEMP

Environment Variable Fields

Html bobswift
<pre> <environment> <variable> <name>env1</name> <value>test1</value> </variable> <variable> <name>env2</name> <value>test2</value> </variable> </environment> </pre>

N

Anchor

	environmentVariableFieldsRestriction - UTEMP
	environmentVariableFieldsRestriction - UTEMP

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 - UTEMP
	excludeRelated - UTEMP

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 - UTEMP
	exitCodeOutput - UTEMP

exitCodeOutput

Output File

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

N

Anchor

	exitCodeProcessing - UTEMP
	exitCodeProcessing - UTEMP

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:

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 - UTEMP
	exitCodeProcessingFieldsRestriction - UTEMP

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 - UTEMP
	exitCodes - UTEMP

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 - UTEMP
	exitCodeText - UTEMP

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 - UTEMP
	exportReleaseLevel - UTEMP

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	name - UTEMP
	name - UTEMP

name

Name

Name of this Universal Template.

Y

Anchor

	outputFailureOnly - UTEMP
	outputFailureOnly - UTEMP

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 - UTEMP
	outputReturnFile - UTEMP

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 - UTEMP
	outputReturnNline - UTEMP

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 - UTEMP
	outputReturnSline - UTEMP

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 - UTEMP
	outputReturnText - UTEMP

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 - UTEMP
	outputReturnType - UTEMP

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:

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

title	Note

If outputReturnType is not NONE (1), the web service will fail with Start Failure if outputProhibited is true for the specified agent.

N

Anchor

	outputType - UTEMP
	outputType - UTEMP

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 - UTEMP
	retainSysIds - UTEMP

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 - UTEMP
	runtimeDir - UTEMP

runtimeDir

Runtime Directory

Directory from which the application should be executed.

Variables are supported.

N

Anchor

	script - UTEMP
	script - UTEMP

script

Script

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

N

Anchor

	scriptUnix - UTEMP
	scriptUnix - UTEMP

scriptUnix

Linux/Unix Script

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

N

Anchor

	scriptWindows - UTEMP
	scriptWindows - UTEMP

scriptWindows

Windows Script

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

N

Valid values:

Anchor

	scriptTypeWindows- UTEMP	scriptTypeWindows- UTEMP

scriptTypeWindows

Windows Script File Type

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

- UTEMP
	scriptTypeWindows- UTEMP

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 - UTEMP
	sendVariables - UTEMP

sendVariables

Send Extension Variables

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

N

Anchor

	sysId - UTEMP
	sysId - UTEMP

sysId

UUID

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

Anchor

	templateType - UTEMP
	templateType - UTEMP

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:

As String = Script, As Value = 1
As String = Extension, As Value = 2

Default is Script (1).

N

Anchor

	useCommonScript - UTEMP
	useCommonScript - UTEMP

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 - UTEMP
	variablePrefix - UTEMP

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 - UTEMP
	waitForOutput - UTEMP

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

Anchor

	arrayNameTitle - FIELD
	arrayNameTitle - FIELD

arrayNameTitle

Name Title

If fieldType is Array; Title to be displayed for the Name column.

N

Anchor

	arrayValueTitle - FIELD
	arrayValueTitle - FIELD

arrayValueTitle

Value Title

If fieldType is Array; Title to be displayed for the Value column.

N

Anchor

	booleanNoValue - FIELD
	booleanNoValue - FIELD

booleanNoValue

No Value

If booleanValueType is Custom; Boolean No value for this Field.

Y
(if booleanValueType
is Custom)

Anchor

	booleanValueType - FIELD
	booleanValueType - FIELD

booleanValueType

Boolean Value Type

Type of Boolean value for this Field.

Valid values:

As String = true/false, As Value = 1
As String = 1/0, As Value = 2
As String = Custom, As Value = 3

Default is true/false (1).

N

Anchor

	booleanYesValue - FIELD
	booleanYesValue - FIELD

booleanYesValue

Yes Value

If booleanValueType is Custom; Boolean Yes value for this Field.

Y
(if booleanValueType
is Custom)

Anchor

	choiceAllowEmpty - FIELD
	choiceAllowEmpty - FIELD

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

Anchor

	choiceAllowMultiple - FIELD
	choiceAllowMultiple - FIELD

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

Anchor

	choiceSortOption - FIELD
	choiceSortOption - FIELD

choiceSortOption

Choice Sort Option

If fieldType is Choice; Specification for how Choices will be listed in the Choice field in Universal Task.

Valid values:

As String = Sequence, As Value = 1
As String = Label, As Value = 2

Default is Sequence (1).

N

Anchor

	defaultListView - FIELD
	defaultListView - FIELD

defaultListView

Add To Default List View

Specification that the label of this Field will display, by default, in the list of Universal Tasks based on this template.

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

N

Anchor

	fieldLength - FIELD
	fieldLength - FIELD

fieldLength

Length

If fieldType is Text or Integer; Length of this Field.

Integer

N

Anchor

	fieldMapping - FIELD
	fieldMapping - FIELD

fieldMapping

Mapping

Field, from a pool of available fields provided for use in a Universal Template, that this Field is mapped to.

Valid values:

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)

Y

Anchor

	fieldType - FIELD
	fieldType - FIELD

fieldType

Type

Field type for this Field.

Valid values:

As String = Text, As Value = 1
As String = Integer, As Value = 2
As String = Boolean, As Value = 3
As String = Choice, As Value = 4
As String = Credential, As Value = 5
As String = Script, As Value = 6
As String = Array, As Value = 7
As String = Float, As Value = 8

Default is Text (1).

N

Anchor

	fieldValue - FIELD
	fieldValue - FIELD

fieldValue

Default Value

Default value for this Field.

Value values by fieldType:

fieldType = Text, fieldValue = string
fieldType = Integer, fieldValue = integer
fieldType = Boolean, fieldValue = true/false
fieldType = Choice, fieldValue = Choice Value
fieldType = Credential, fieldValue = Credential Name
fieldType = Script, fieldValue = Script Name
fieldType = Array, fieldValue = (not supported)
fieldType = Float, fieldValue = float

N

Anchor

	formColumnSpan - FIELD
	formColumnSpan - FIELD

formColumnSpan

Column Span

Number of columns (width) in the Universal Task (based on this Universal Template) Details for this Field.

Valid values:

As Value = 1:
As Value = 2
As Value = 3

Default is 1.

N

Anchor

	formEndRow - FIELD
	formEndRow - FIELD

formEndRow

End Row

Specification that this Field will end the current row.

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

N

Anchor

	formStartRow - FIELD
	formStartRow - FIELD

formStartRow

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

Hint

Field hint for this Field in the Controller user interface.

N

Anchor

	intFieldMax - FIELD
	intFieldMax - FIELD

intFieldMax

Maximum

If fieldType is Integer; Maximum value for this Field.

Integer

N

Anchor

	intFieldMin - FIELD
	intFieldMin - FIELD

intFieldMin

Minimum

If fieldType is Integer; Minimum value for this Field.

Integer

N

Anchor

	label - FIELD
	label - FIELD

label

Label

Name of this Field to be displayed in the Controller user interface.

Y

Anchor

	name - FIELD
	name - FIELD

name

Name

Name of this Field in the Controller database.

Y

Anchor

	noSpaceIfHidden - FIELD
	noSpaceIfHidden - FIELD

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

Anchor

	preserveValueIfHidden - FIELD
	preserveValueIfHidden - FIELD

preserveValueIfHidden

Preserve Value If Hidden

Specification that the value of this field should be preserved if the field is hidden.

Note

title	Note

A Field with preserveValueIfHidden = true will be validated even if the Field is hidden.

Also, if a Field's showIfField or requireIfField specifies a field (for example, Boolean Field 1) that has preserveValueIfHidden = true, when validating whether the Field is visible or required, Boolean Field 1’s value is considered visible.

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

N

Anchor

	required - FIELD
	required - FIELD

required

Required

Specification for whether this Field is required or optional.

Note

title	Note

If you modify a Universal Template Field to add a Required condition, review and assign an appropriate field value to any Universal Tasks that are no longer in compliance to avoid a Start Failure.

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

N

Anchor

	requireIfField - FIELD
	requireIfField - FIELD

requireIfField

Require If Field

If required is false and showIfField is not specified; Specification that this Field in the template will be required in any Universal Tasks based on this template the Choice Field (Choice Field 1-15) or Boolean Field (Boolean Filed 1-10) selected as the Require If Field has a value corresponding to the value(s) defined in the Require If Filed Value(s) field.

Note

title	Note

If you modify a Universal Template Field to add or augment a Require If Field condition, review and assign an appropriate field value to any Universal Tasks that are no longer in compliance to avoid a Start Failure.

Valid values:

As String = Choice Field [1-15]
As String = Boolean Field [1-10]

N

Anchor

	requireIfFieldValue - FIELD
	requireIfFieldValue - FIELD

requireIfFieldValue

Require If Field Value(s)

If requireIfField is not null/empty; Value(s) for the specified requireIfField.

Y
(if requireIfField
is specified)

Anchor

	requireIfVisible - FIELD
	requireIfVisible - FIELD

requireIfVisible

Require If Visible

Specification that the Field is required if it is visible.

Note

title	Note

If you modify a Universal Template Field to add a Require If Visible condition, review and assign an appropriate field value to any Universal Tasks that are no longer in compliance to avoid a Start Failure.

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

N

Anchor

	sequence - FIELD
	sequence - FIELD

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.

Note

title	Note

sequence is included in the XML/JSON by the Read and List web services; however, it is not used by the Create and Update web services. For Create and Update, the sequence is set based on the Field order specified in the XML/JSON.

N

Anchor

	showIfField - FIELD
	showIfField - FIELD

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

Anchor

	showIfFieldValue - FIELD
	showIfFieldValue - FIELD

showIfFieldValue

Show If Field Value

If showIfField is not null/empty; Value(s) for the specified showIfField.

Y
If showIfField
is specified.

Anchor

	sysId - FIELD
	sysId - FIELD

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

	asynchronous - COMMAND
	asynchronous - COMMAND

asynchronous

Asynchronous

If executionOption is In Process; Specification for whether the command runs synchronously or asynchronously.

If executionOption is Out Of Process, asynchronous will be ignored.

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

N

Anchor

	executionOption - COMMAND
	executionOption - COMMAND

executionOption

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

Anchor

	fields - COMMAND
	fields - COMMAND

fields

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

language	xml
linenumbers	true

            <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

language	xml
linenumbers	true

            "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

Anchor

	label - COMMAND
	label - COMMAND

label

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.

statusessysIdtimeout

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

Anchor

	name - COMMAND
	name - COMMAND

name

Name

Unique name of this command, adhering to the same naming convention as a Universal Template field name.

Y

Anchor

statuses - COMMAND

Supported Status(es)

Task instance status(es) that the dynamic command should be enabled for.

Code Block

language	xml
linenumbers	true

            <statuses>
                <status>Defined</status>
                <status>Waiting</status>              
            </statuses>

Code Block

language	xml
linenumbers	true

"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 - 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 (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

Anchor

	statuses - COMMAND
	statuses - COMMAND

statuses

Supported Status(es)

Task instance status(es) that the dynamic command should be enabled for.

Code Block

language	xml
linenumbers	true

            <statuses>
                <status>Defined</status>
                <status>Waiting</status>              
            </statuses>

Code Block

language	xml
linenumbers	true

"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 - COMMAND
	sysId - COMMAND

sysId

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

timeout

Timeout (Seconds)

Optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds.

N

Anchor
Universal Event Template Properties
Universal Event Template Properties
Universal Event Template Properties

The excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate> element of XML web services.

"attributes": [ { "label": "attribute_label1", "name": "attribute_name1", "type": "Text" }, { "label": "attribute_label2", "name": "attribute_name2", "type": "Integer" } ]

Property

UI Field Name

Description

Specifications

Required

Anchor

	UET - attributesPolicy
	UET - attributesPolicy

attributesPolicy

Unmapped Attributes Policy

Defines how unmapped/unknown attributes that are in the published event are handled.

Valid values:

As String = Prohibit Universal Event, As Value = 1
As String = Include Attributes, As Value = 2
As String = Exclude Attributes, As Value = 3

Default is Prohibit Universal Event (1).

N

Anchor

	UET - attributes
	UET - attributes

attributes

Attributes

Zero or more attributes, specifying their Name, Label, and Type.

Expand

title	XML

Code Block

language	text

    <attributes>
        <attribute>
            <label>attribute_label1</label>
            <name>attribute_name1</name>
            <type>Text</type>
        </attribute>
        <attribute>
            <label>attribute_label2</label>
            <name>attribute_name2</name>
            <type>Integer</type>
        </attribute>
    </attributes>

Expand

title	JSON

Code Block

language	text

    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        }
    ]

N

Anchor

	UET - description
	UET - description

description

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:

As String = Prohibit Universal Event, As Value = 1
As String = Include Attributes, As Value = 2
As String = Exclude Attributes, As Value = 3

Default is Prohibit Universal Event (1).

N

attributes

Attributes

Zero or more attributes, specifying their Name, Label, and Type.

Expand

title	XML

Code Block

language	text

    <attributes>
        <attribute>
            <label>attribute_label1</label>
            <name>attribute_name1</name>
            <type>Text</type>
        </attribute>
        <attribute>
            <label>attribute_label2</label>
            <name>attribute_name2</name>
            <type>Integer</type>
        </attribute>
    </attributes>

Expand

title	JSON

Code Block

language	text

Anchor

	UET - label
	UET - label

label

Label

User-friendly display name for the event, to be displayed within the client.

The Label must be unique.

Y

Anchor

	UET - name
	UET - name

name

Name

Unique event name, adhering to the same naming convention as a Universal Template field name.

Y

Anchor

	UET - ttl
	UET - ttl

ttl

Time To Live

Default value for Time to live; how long, in minutes, the Universal Event data is valid.

non-negative Integer

N

Anchor

	UET - sysId
	UET - sysId

sysId

n/asys_id used within the Controller to identify this record.Persisted only if retainSysIds is set to true.N

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	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} Unexpected request failure. See log(s) for more details.

	Description
URI	http://host_name/uc/resources/universaltemplate/ universaleventtemplate importtemplate
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 /universaltemplate/importtemplate
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	See Universal Event Template Properties.
Example Response	Status 200 /OK Successfully created the universal template with sysId {sysId}. Status 400 /Bad Request Create universal template failed. (message).

Versions Compared

Old Version 7

New Version Current

Key

Auditing Universal Events

Anchor
Create a Universal Template
Create a Universal Template
Create a Universal Template

Anchor
List Universal Templates URI Parameters
List Universal Templates URI Parameters
List Universal Templates: URI Parameters

Anchor
List Universal Templates XML and JSON Examples
List Universal Templates XML and JSON Examples
List Universal Templates: XML and JSON Examples

Anchor
Universal Event Template Properties
Universal Event Template Properties
Universal Event Template Properties

Anchor
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties

Example

Example

Anchor
Universal Template Export

Universal Template Export

Universal Template - Export

Example

Export File Entries

Anchor
Universal Template

Export URI Parameters
Universal Template

Export URI Parameters
Universal Template

Export: URI Parameters

Binary Data

Example

Export File Entries

Example

Anchor
Universal Template Import
Universal Template Import
Universal Template - Import

Binary Data

Example

Name	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`templateid`	n/a	ID used within the Controller to identify the Universal Template.	String; URI parameter	Y (unless `templatename` is specified)	`templatename`
	Mutually Exclusive With
`templateid`	n/a	Name ID used within the Controller to identify the Universal Template.	String; URI parameter	Y (unless `templateid` is specified)	`templateid`

?templateid=a7de2b3601af48ab886e6a8b7ecec0da&excludeExtension=true
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/octet-stream

Description
URI	http://host_name/uc/resources/universaleventtemplate
HTTP Method	DELETE
Description	Deletes a Universal Event Template.
URI Parameters	See Delete a Universal Template URI Parameters, below.
Example URI	text
Example Response	Status 200 Successfully imported universal template. Created new template with id {sysid} Successfully imported universal template. Updated existing template with id {sysId} Status 400 The attached Template is invalid. Please re-import your Template. Template cannot be greater than {maximum_template_size} bytes. Template must contain template.json/template_icon.png/extension_archive.zip. Cluster Node release level is {current_release_level}, which does not meet the minimum release level of {min_release_level} for the Template. Status 500 Unexpected request failure. See log(s) for more details. Operation prohibited due to security constraints.

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Auditing Universal Events

AnchorCreate a Universal TemplateCreate a Universal TemplateCreate a Universal Template

AnchorList Universal Templates URI ParametersList Universal Templates URI ParametersList Universal Templates: URI Parameters

AnchorList Universal Templates XML and JSON ExamplesList Universal Templates XML and JSON ExamplesList Universal Templates: XML and JSON Examples

AnchorUniversal Event Template PropertiesUniversal Event Template PropertiesUniversal Event Template Properties

AnchorUniversal Event Template - Attribute PropertiesUniversal Event Template - Attribute PropertiesUniversal Event Template - Attribute Properties

Example

Example

AnchorUniversal Template Export

Universal Template Export

Universal Template - Export

Example

Export File Entries

AnchorUniversal Template

Export URI ParametersUniversal Template

Export URI ParametersUniversal Template

Export: URI Parameters

Binary Data

Example

Export File Entries

Example

AnchorUniversal Template ImportUniversal Template ImportUniversal Template - Import

Binary Data

Example

Anchor
Create a Universal Template
Create a Universal Template
Create a Universal Template

Anchor
List Universal Templates URI Parameters
List Universal Templates URI Parameters
List Universal Templates: URI Parameters

Anchor
List Universal Templates XML and JSON Examples
List Universal Templates XML and JSON Examples
List Universal Templates: XML and JSON Examples

Anchor
Universal Event Template Properties
Universal Event Template Properties
Universal Event Template Properties

Anchor
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties

Anchor
Universal Template Export

Anchor
Universal Template

Export URI Parameters
Universal Template

Export URI Parameters
Universal Template

Anchor
Universal Template Import
Universal Template Import
Universal Template - Import