Skip to main content

Windows Task Properties

Task Properties: Windows Task​

Property

UI Field Name

Description

Specifications

Required

Patchable (Instance Only)

command

Command

If commandOrScript = Command (1); Command being executed on the remote machine.

Variables supported.

N

Y

commandOrScript

Command or Script

Specification for whether a single command or a script is being executed.

Valid values:

  • As String = Command, As Value = 1
  • As String = Script, As Value = 2

Default is Command (1).

N

Y

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

N

desktopInteract

Interact with Desktop

Specification for whether or not a task that runs an application with a GUI requires some manual actions from a user (for example, clicking buttons or entering values).

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

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

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

Y

environment

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

Y

exitCodeOutput

Output File

If outputType = FILE (3); Path and file name of the output file that should be scanned for the text in exitCodeText.

N

Y

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 Range (1).

N

Y

exitCodes

Exit Codes

If exitCodeProcessing = Success Exitcode Range (1) or Failure Exitcode Range (2); 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

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

Y

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

Y

outputReturnFile

Output File

If outputReturnType is FILE (4); Path and file name containing the output that you want automatically retrieved and attached to the task instance.

Y

Y

outputReturnNline

Number of Lines

If outputReturnType is STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Allows you to limit the retrieved data to the number of lines specified.

Integer; Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

N

Y

outputReturnSline

Starting Line

If outputReturnType is STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Allows you to instruct the Controller to retrieve data beginning at this line.

Integer; Default is 1.

N

Y

outputReturnText

Scan Text

If outputReturnType is STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); 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

Y

outputReturnType

Automatic Output Retrieval

Specification 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 NONE (1).

info

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

N

Y

outputType

Output Type

If exitCodeProcessing = Success Output Contains (3) or Failure Output Contains (4); 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).

Y

Y

parameters

Parameters

Any arguments needed by the program to execute properly.

Variables are supported.

N

Y

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

Y

retryIndefinitely

Retry Indefinitely

Specification for whether or not the Controller should continue trying indefinitely to run this task. If retryIndefinitely = yes, it overrides any value placed in retryMaximum.

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

N

N

retryInterval

Retry Interval

Number of seconds between each retry.

Integer; Default is 60.

N

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

N

retrySuppressFailure

Suppress Intermediate Failures

Specification for whether or not the following will be suppressed until all scheduled retry attempts 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

N

runtimeDir

Runtime Directory

Directory from which the application should be executed. Variables are supported.

N

Y

script

Script

If commandOrScript is Script (2); Name of a script in the Controller database that will be executed by this task.

Y

Y

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

Y