Skip to main content

Calendars

In briefA calendar is a named list of dates, shared across workspaces. A frequency uses one to exclude dates, an Annual Plan frequency uses one as the dates it runs on, and a workflow uses one as its Additional Holiday Calendar. The Master Holiday Calendar is the one holiday list your whole organization shares, applied to every workflow that has Use Master Holiday Calendar on.

WhereDesign › Toolkit › the Calendars tab. New Calendar opens the editor; a row's menu has Edit (or View), Cross Reference and Delete. The Master Holiday Calendar button is at the right of the same toolbar. A workflow picks its calendars in the workflow editor's Workflow Settings panel, as Additional Holidays and Use Master Holiday Calendar.

When

  • You need a set of holidays or blackout days that one or more workflows or frequencies should skip.
  • You want a job to run on a fixed, hand-picked list of dates, through an Annual Plan frequency.
  • You keep the organization's bank holidays once, for every workflow, in the Master Holiday Calendar — and, through an Annual Plan, run a job on those holidays.

To change which days of the week count as working days, use the workflow's Working Days instead; see Scheduling and the run.

How

  1. Open the Calendars tab of the Toolkit and select New Calendar.
  2. Give it a name, pick dates from the grid or Upload JSON, and save.
  3. Name it on a frequency or a workflow, then check the dates it removes in the workflow editor's Forecast view.

The full steps are on Manage properties, calendars, and tags.

Notes
  • A calendar needs a name of 3–255 characters and at least one date. The Master Holiday Calendar may be empty and holds up to 3,660 dates.
  • Upload JSON takes a bare array of YYYY-MM-DD strings or an object with a dates array. iCal files are not accepted.
  • A change to a calendar applies to the next forecast or build. A run already built keeps the dates it was built with.
Watch out
  • A calendar in use cannot be deleted. Delete lists the workflows and frequencies that refer to it; change those first.
  • If a holiday or exclusion calendar cannot be resolved, the build fails rather than running with it left out.
  • The preview in the Frequencies dialog applies a frequency's exclusion calendar, an Annual Plan's calendar and, when its Use Master Holiday Calendar switch is on, the Master Holiday Calendar, but never a workflow's Additional Holiday Calendar. Check a workflow's holiday effects in the workflow editor's Forecast view.