Update Schedule Job


Changes parameters of a Scheduled task.

Note

This workflow is available only for use in Microsoft Windows environments.

 Workflow inputs – Create Schedule Job

Call Workflow Input

Description

Required

Default Value

connection details

XML document conforming to the Connection Details common object that contains the information required to execute a command via command line.

Yes

n/a

task name

Specifies a name for the task.

 

Valid value: unique name not exceeding 238 characters.

 

Note

Quotation marks must be used to enclose names that include spaces.

Yes

n/a

task run

Specifies the program or command that the task runs.

 

Note

The fully qualified path and file name of an executable file, script file, or batch file must be provided. The path name must not exceed 262 characters.

Yes

n/a

start time

Specifies the time of day that the task starts (each time it starts) in HH:MM 24–hour format.

 

Note

The /st parameter valid with MINUTE, HOURLY, DAILY, WEEKLY, MONTHLY, and ONCE schedules. It is required for a ONCE schedule.

No

The default value is current time on local computer.

interval

Specifies the repetition interval in minutes.

 

Valid range: 1 to 599940 minutes (599940 minutes = 9999 hours).

 

Note

Not applicable for schedule types: MINUTE, HOURLY, ONSTART, ONLOGON, ONIDLE. If either /ET or /DU is specified, then the repetition interval defaults to 10 minutes.

Conditional.

n/a

end time

Specifies the time of day that a minute or hourly task schedule ends.

Valid 24–hour time format: HH:MM.

No

In absence of value job runs infinitely.

duration

Specifies maximum length of time for minute or hourly schedule in HHHH:MM 24–hour format.

No

In absence of value job runs infinitely.

start date

Specifies the date on which the task schedule starts.

 

Valid date format: mm/dd/yyyy

 

Note

Format set by selected locale on local computer

No

Current date of the local computer.

end date

Specifies the date on which the schedule ends. This parameter is optional.

 

Format for <end date> varies with the selected locale on local.

No

In the absence of a value for this input the job runs infinitely.

runas user

Runs the task with permissions of the specified user account.

No

n/a

runas password

Provides the password for the user account that is specified in the /ru Domain/User parameter.

No

n/a

enable or disable

Specifies weather to enable or disable the scheduled job.

 

Valid values: enable or disable

No

enable

 

 Workflow outputs – Create Schedule Job

Call Workflow Output

Description

output

XML document consisting of one or more <line> elements that contain the command response. Each <line> element contains an index attribute indicating the order in which the information was returned by the command.

success

Did the operation succeed?

 

Valid values: true, false

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*