Skip to main content

Scheduling and the run

In briefA build turns a deployed workflow into one day's run. The job's frequencies decide which days it qualifies on, working days and holiday calendars take days out, and each frequency carries the runtime settings the built job runs with: when it may start, when it is late, when it must not start, how long it may run, and whether it retries after a failure or reruns after a success.

WhereA workflow's build settings are in the workflow editor's Workflow Settings panel, on the Overview tab: Start Time, Working Days, Additional Holidays and Use Master Holiday Calendar under Workflow Schedule, Allow Multi-Instance under Multi-Instance, and Auto Build, Days in Advance, Days to Build, Overwrite on Build and Build on Hold under AutoBuild Settings. A job's per-frequency runtime settings — offsets, run time, Failure Retries and Success Reruns — are on the Frequencies tab of the job editor. The same tab on a job of a running instance, opened from Processes, edits that instance only. A build you start yourself is Processes › Schedule Workflow.

When

  • A job is missing from a run, starts at an unexpected time, is reported late, ends as Missed Start Time, or keeps retrying or rerunning.
  • You are deciding when a job is eligible to start, when it is reported late, and when it must not start at all.
  • You are setting up failure retries or success reruns, or changing a rerun on a run already under way.
  • You want to know what the automatic daily build does, and what it will not replace.

The frequency pattern itself — which days a job qualifies on — is on Frequencies, and the dates a workflow will build are easiest to check in the Forecast view.

How

  1. Set the workflow's build settings in Workflow Settings › Overview.
  2. On each job's Frequencies tab, add its frequencies, put them in the order they should be checked — the first that matches a date decides it — and set their offsets, run time, retries and reruns. Every timing offset is a duration from the schedule's start time; Absolute counts from the planned start, Relative from the actual start.
  3. Check the dates in the workflow editor's Forecast view, then commit and deploy.
  4. Build a date from Processes › Schedule Workflow, or let the automatic daily build do it where it is enabled.

The full steps are on Workflow Settings for the workflow, and in Set when a job runs for each job.

Notes
  • 00:00 on the four offset fields means not configured, not the schedule's start. On Latest Runtime Offset it means no latest runtime: the job reruns until Maximum Runs.
  • Setting an offset back to 00:00 on a job instance removes the deadline it set from that run.
  • Maximum Attempts counts retries, not runs: 3 allows four runs.
  • Latest Runtime Offset counts from the schedule's planned start; a run built before that change keeps the time it was built with.
  • The automatic daily build is off until it is enabled for your environment.
  • Job times, and the times the interface shows, are in the scheduler's time zone; the job editor names it under Offset Information.
Watch out
  • A Latest Start deadline is checked at every waiting gate, so a job still waiting on a dependency can end as Missed Start Time.
  • Turning success reruns off on a job already waiting for its next restart still lets that restart run; the cycle ends after it.
  • New instance times, or a new latest start time, that would put a waiting rerun past the job's latest start time are refused.
  • On a running instance, a Restart Offset change that leaves neither a Maximum Runs nor a latest runtime is refused.
  • Renaming a frequency after deployment drops the jobs attached only to it from the build until you redeploy.