Create Schedule Job
Schedules a task.
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.
| Yes | n/a |
task run | Specifies the program or command that the task runs.
| Yes | n/a |
runas user | Runs the task with permissions of the specified user account. | Yes | n/a |
runas password | Provides the password for the user account that is specified in the /ru Domain/User parameter. | Yes | n/a |
idle time | Specifies how many minutes the computer is idle before the task starts.
Valid value: Whole number from 1 to 999 | Yes | n/a
|
schedule type | Specifies the schedule type.
Valid values:
| Yes | n/a |
modifier | Specifies how often the task runs within its schedule type. | No | 1 |
day | Specifies a day (or days) of the week or a day (or days) of a month. | No | 1 |
month | Specifies a month or months of the year to run scheduled task.
Valid values: JAN – DEC, * – every month)/
| Conditional | There is no default value. |
idle time | Specifies how many minutes the computer is idle before the task starts.
Valid value: Whole number from 1 to 999
| No | There is no default value. |
start time | Specifies the time of day that the task starts (each time it starts) in HH:MM 24–hour format.
| 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)
| 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
| No |
|
end date | Specifies the date on which the schedule ends. This parameter is optional.
| No | In the absence of a value for this input the job runs infinitely. |
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 |