Universal Task Properties

Owned by Stonebranch (Deactivated)
Last updated: Apr 02, 2024
6 min read

Task Properties: Universal Task

Property

UI Field Name

Description

Specifications

Required

arrayField{1-4}

Label user-defined in the Universal Template Field.

Array field for this Universal task.
 
 
Create / Update
XML:
<arrayField1 nameTitle="Custom Name" valueTitle="Custom Id">
    <field>
        <name>John Doe Jr.</name>
        <value>1234567</value>
    </field>
    <field>
        <name>Max</name>
        <value>888888</value>
    </field>
</arrayField1>
<arrayField2>
    <field>
        <name>A1</name>
        <value>test1</value>
    </field>
    <field>
        <name>A2</name>
        <value>test2</value>
    </field>
</arrayField2>
 
JSON:
"arrayField1": {
    "fields": [
        {
            "name": "John Doe Jr.",
            "value": "1234567"
        },
        {
            "name": "Max",
            "value": "888888"
        }
    ],
    "nameTitle": "Custom Name",
    "valueTitle": "Custom Id"
},
"arrayField2": {
    "fields": [
        {
            "name": "A1",
            "value": "test1"
        },
        {
            "name": "A2",
            "value": "test2"
        }
    ]
},
 
Read
XML:
<arrayField1 name="array1" label="Customers" nameTitle="Custom Name" valueTitle="Custom Id">
    <field>
        <name>John Doe Jr.</name>
        <value>1234567</value>
    </field>
    <field>
        <name>Max</name>
        <value>888888</value>
    </field>
</arrayField1>
 
JSON:
"arrayField1": {
    "fields":[
            {
            "name": "John Doe Jr.",
            "value": "1234567"
        },
        {
            "name": "Max",
            "value": "888888"
        }
    ],
    "label": "Customers",
    "name": "array1",
    "nameTitle": "Custom Name",
    "valueTitle": "Custom Id"
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

booleanField{1-10}

Label user-defined in the Universal Template Field.

Boolean field for this Universal task.
 
Examples:
 
Create / Update
XML:
<booleanField1>false</booleanField1>
JSON:
"booleanField1": false
 
Read
XML:
<booleanField1 name="run_immediately" label="Run Immediately">false</booleanField1>
JSON:
"booleanField1": {
"label": "Run Immediately",
"name": "run_immediately",
"value": false
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

choiceField{1-15}

Label user-defined in the Universal Template Field.

Choice field for this Universal task.
 
Examples:
 
Create / Update
XML:
<choiceField1>val 1</choiceField1>
JSON:
"choiceField1": "val 1"
 
Read
XML:
<choiceField1 name="progname" label="Program Name">val 1</choiceField1>
JSON:
"choiceField1": {
"label": "Program Name",
"name": "progname",
"value": "val 1",
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

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

credentialField{1-6}

Label user-defined in the Universal Template Field.

Credential field for this Universal task.
 

If credentialVarField{N} is defined, the credentialVarField{N} value takes precedence over the value of credentialField{N}.


Examples:
 
XML:

<credentialFieldN name="test_credentials" label="Test Credentials">testcred</credentialFieldN>
<credentialVarFieldN name="test_credentials" label="test Credentials"/>


JSON:
"credentialFieldN": {
"label": "Test Credentials",
"name": "test_credentials",
"value": "tesctcred"
},
"credentialVarFieldN": {
"label": "Test Credentials",
"name": "test_credentials",
"value": null
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

User-defined in the Universal Template Field.

credentialVarField{1-6}

Label user-defined in the Universal Template Field.

If the Universal Template fieldType = Credential and allowVariable = true; Variable and/or function that resolves to the name of a credential for this Universal task.

If credentialVarField{N} is defined, the credentialVarField{N} value takes precedence over the value of credentialField{N}.

Examples:
 
XML:

<credentialFieldN name="test_credentials" label="Test Credentials"/>
<credentialVarFieldN name="test_credentials" label="Test Credentials">${test_credentials}</credentialVarFieldN>

JSON:

"credentialFieldN": {
"label": "Test Credentials",
"name": "test_credentials",
"value": null
},
"credentialVarFieldN": {
"label": "Test Credentials",
"name": "test_credentials",
"value": "${test_credentials}"
}

User-defined in the Universal Template Field.

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

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

environment

Environment Variables

Environment variables needed by the program to run.

List of environment variables:

N

exitCodeOutput

Output File

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


N

exitCodeProcessing

Exit Code Processing

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

Valid values:

  • As String = Success Exitcode Range, As Value = 1
  • As String = Failure Exitcode Range, As Value = 2
  • As String = Success Output Contains, As Value = 3
  • As String = Failure Output Contains, As Value = 4

Default is Success Exitcode (1).

N

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

exitCodeText

Scan Output For

If exitCodeProcessing = 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

floatField{1-4}

Label user-defined in the Universal Template Field.

Float field for this Universal task.
 
Examples:
 
Create / Update
XML:
<floatField1>float1</floatField1>
JSON:
"floatField1": test float
 
Read
XML:
<floatField1 name="float1" label="float1">2.1474</floatField1>
JSON:
"floattField1": {
"label": "float1",
"name": "float1",
"value": 2.1474,
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

intField{1-10}

Label user-defined in the Universal Template Field.

Integer field for this Universal task.
 
Examples:
 
Create / Update
XML:
<intField1>12</intField1>
JSON:
"intField1": 12
 
Read
XML:
<intField1 name="error_level" label="Error Level">12</intField1>
JSON:
"intField1": {
"label": "Error Level",
"name": "error_level",
"value": 12,
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

largeTextField{1-4}

Label user-defined in the Universal Template Field.

Large text field for this Universal task.
 
Examples:
 
Create / Update
XML:
<largeTextField1>test text</largeTextField1>
JSON:
"largeTextField1": "test text"
 
Read
XML:
<largeTextField1 name="respapp" label="Responsibility Application">test text</largeTextField1>
JSON:
"largeTextField1": {
"label": "Responsibility Application",
"name": "respapp",
"value": "test text",
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

outputFailureOnly

Failure Only

If outputReturnType is STDOUT, STDERR, FILE, or OUTERR; Indication for whether output should be retrieved on task failure only.

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

N

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

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

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

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

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

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

N

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

retryExitCodes

Retry Exit Codes

Exit code range for which an auto-retry of the task in FAILED status will occur. Exit code ranges must be in the same format as ranges specified in exitCodes. Maximum Retries must be greater than 0. If an exit code range is not specified, any exit code potentially will cause a retry.

Format = 1,5,22-30

N

retryInterval

Retry Interval (Seconds)

Number of seconds between each retry.

Integer; Default is 60.

N


retryMaximum

Maximum Retries

Maximum number of times that the Controller should retry this task after it has started and gone to a failed state.

Integer; Default is 0.

N

retrySuppressFailure

Suppress Intermediate Failures

If the task instance is in the Failed status; Specification for whether or not the following will be suppressed until all scheduled retry attempts (a Maximum Retries value has been entered or Retry Indefinitely has been enabled) have been made:

  • All Actions (Abort, Email Notification, Set Variable, SNMP Notification, and System Operation) to be made against the task instance.
  • Workflow conditional path processing; any Successors waiting on a failure path will not be released.
  • Task Monitors will not be notified of the Failed status. Also, any Task Monitor task that has a Time Scope in the past will disqualify any matching task instance in the past with a Failed status if the task instance is scheduled for automatic retry and for which Suppress Intermediate Failures has been enabled.
  • Any Workflow containing the Failed task instance will not transition to the Running/Problems status.

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

N

runtimeDir

Runtime Directory

Directory from which the application should be executed.

Variables are supported.

N

scriptField{1-4}

Label user-defined in the Universal Template Field.

Script field for this Universal task.
 
Examples:
 
Create / Update
XML:
<scriptField1>script 1</scriptField1>
JSON:
"scriptField1": "script 1"
 
Read
XML:
<scriptField1 name="scriptname" label="Script Name">val 1</scriptField1>
JSON:
"scriptField1": {
"label": "Script Name",
"name": "scriptname",
"value": "script 1",
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N

template

n/a

Universal Template on which the Universal Task is based.


Y

textField{1-20}

Label user-defined in the Universal Template Field.

Text field for this Universal task.
 
Examples:
 
Create / Update
XML:
<textField1>test text</textField1>
JSON:
"textField1": "test text"
 
Read
XML:
<textField1 name="username" label="Application User">test text</textField1>
JSON:
"textField1": {
"label": "Application User",
"name": "username",
"value": "test text",
}

Only fields defined in the corresponding Universal Template will be set. Validation rules defined on the template apply. Attributes name and label are for informational purpose only.

N