Task Properties: Universal Task
Property | UI Field Name | Description | Specifications | Required | |
---|---|---|---|---|---|
| <array field> | Array field for this Universal task. | 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 | |
| <boolean field> | Boolean field for this Universal task. | 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 | |
| <choice field> | Choice field for this Universal task. | 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 | |
| Create Console | If | Boolean; Valid values: true/false. Default is false. | N | |
| <credential field> | Credential field for this Universal task. | 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 | |
| Interact with Desktop | Specification for whether or not a task that runs an application with a GUI requires some manual actions from a user (for example, clicking buttons or entering values). | Boolean; Valid values: true/false. Default is false. | N | |
| Run with Highest Privileges | Specification for whether or not to execute the task using an elevated privileges token, rather than one subject to User Account Control (UAC) restrictions. An elevated token allows a process to execute with all the privileges available to its specified credentials. For example, a task executed with an administrative account will behave as though it received permission via a UAC dialog to perform a privileged operation. | Boolean; Valid values: true/false. Default is false. | N | |
| Environment Variables | Environment variables needed by the program to run. | List of environment variables: <environment> <variable> <name>env1</name> <value>test1</value> </variable> <variable> <name>env2</name> <value>test2</value> </variable> </environment> | N | |
| Output File | Path and file name of the output file that should be scanned for the text in | N | ||
| Exit Code Processing | Specification for how the Controller should determine whether the executed command failed or completed successfully. | Valid values:
Default is Success Exitcode (1). | N | |
| Exit Codes | If | Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. | Y | |
| 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 | |
| <float field> | Float field for this Universal task. | 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 | |
| <integer field> | Integer field for this Universal task. | 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 | |
| <text field> | Large text field for this Universal task. | 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 | |
| Failure Only | If | Boolean; Valid values: true/false. Default is false. | N | |
| Output File | If | N | ||
| Number of Lines | If | Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property. | N | |
| Start Line | If | Default is 1. | N | |
| Scan Text | If | 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. | Valid values:
Default is OUTERR (6). Note If | N | |
| Output Type | If | Valid values:
Default is STDOUT (1). | N | |
| 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 | Format = 1,5,22-30 | N | |
| Retry Interval (Seconds) | Number of seconds between each retry. | Integer; Default is 60. | N | |
| 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 | |
| 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:
| Boolean; Valid values: true/false. Default is false. | N | |
| Runtime Directory | Directory from which the application should be executed. | Variables are supported. | N | |
| <script field> | Script field for this Universal task. | 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. Credentials Functions, Script Functions and SAP Connection Functions are fully supported within the content of a Script field for Extension-based Universal Tasks, without the need to add the referenced credentials as a Credential field on the Universal Template. | N | |
| n/a | Universal Template on which the Universal Task is based. | Y | ||
| <text field> | Text field for this Universal task. | 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 |