Step-by-step guide
To schedule a task to run at a particular time. Tasks always use the current instance of a pipeline.
- In Manager:
- navigate to the Project containing the pipeline you would like to run from a task.
- Click the + button and select Task from the pop-up menu. The task name is, by default, the name of the pipeline selected + 'task.
- Open the pipeline you wish to schedule and click the Create task button. The Pipeline field will be pre-populated in the dialog and cannot be changed.
Unless otherwise noted, the names of any asset or project is limited to UTF-8 alphanumeric characters and these punctuation characters !"#$%&'()*+,-.:;<=>?@[\]^_`{|}~.
- Complete the dialog as needed and click Create.
Select Schedule as the Run With option.
(Optional) If you want the pipeline to run repeatedly, you can check the Repeat Execute the pipeline on a regular schedule box to show the options for specifying how often the pipeline should be run. Runtimes are based on the Time zone set for the task.
The option Do not start a new execution if one is already active let's you prevent a pipeline from running again if a previous execution of that pipeline is already running.
- If a pipeline run is skipped because another instance is already running, the job history shows only the first skip. Subsequent job skips do not appear in the job history.
- A three month limit is placed on Do not start a new execution if one is already active. A second instance of that pipeline will be able to be executed at that time.
For repeat, scheduled tasks, you can set Blackout dates for times when you don't want the task to run. Click + to add one or more blackout dates. Blackout dates are based on the Time zone set for the task.
(Optional) To configure the maximum duration that a pipeline is allowed to run, set Timeout (in minutes). The execution stops executing after the specified timeout duration is reached. The minimum duration the pipeline is allowed timeout is 1 minute. The field takes only integer input. A timeout of 0, or leaving the field empty, is equivalent to NO timeout on the pipeline execution, hence running the pipeline until it reaches its final state.
(Optional) If you want to record the next five triggers of the task, select the Debug option.
(Optional) Supply additional information on this task in the Notes field of the Info tab.
After creating a task, it will show up in the project listing with the given name. To edit the task settings, click the task name to bring up the task configuration dialog. If you would like to view details of the task execution, you can click the down arrow next to the task name and select View. The task details page will show you the current configuration of the task, how many times it has been run and a history of the task executions.
A scheduled task can take up to 10 minutes past the scheduled time to execute. If it misses that window, the task will not execute.
CRON Schedule
If a task is schedule to repeat by Cron, you can configure it to run on a regular time-based schedule.
For example:
Example | Month | Day | Day of Week | Hour | Minute |
---|---|---|---|---|---|
Every day at 12:01 AM | Every | Any | Any | 12AM | :01 |
Every 30 minutes | Every | Any | Any | Any | :30 |
Every weekday at 9 PM | Every | Any | Monday, Tuesday, Wednesday, Thursday, Friday | 9PM | :00 |
Every 5 minutes but only in the morning of Friday & Saturday | Every | Any | Friday & Saturday | 12AM, 1AM [...] 10AM, 11AM | :05, :10 [...] :50, 55 |
- Selecting Any or Every in a column will override the specific periods selected.
If you select values for both 'Day and Day of Week, then the day must meet both criteria. For example, 1st and Monday means on the month where its 1st day is a Monday.
If you need different run schedules based on the day of the week, create multiple Scheduled tasks (Regular or Cron)