Define a frequency
- Synopsis
- Full Details
In briefA frequency is a reusable rule for which days a job is eligible to run: daily, weekly, monthly, quarterly or yearly, or On Request or Annual Plan. You build it in one dialog on the Frequencies tab of the Toolkit, with a forecast of its dates beside the pattern, and then give it to jobs.
- Working days come from each workflow's Working Days, so the same frequency can land on different dates in two workflows.
- A working-day match on a non-working day moves to the previous working day unless If date is non-working day says otherwise. On a monthly Day pattern with Day, an unset action keeps the date instead.
- A monthly Day pattern can pick several days, and a weekday position can pick several weekdays.
- Quarters are calendar quarters, and a quarterly weekday position counts across the whole quarter. A yearly weekday position counts across the whole year, so it runs once a year.
- Offsets count working days, and appear only with Working Day.
- A monthly Day pattern for the 29th, 30th or 31st produces no run in a month without that day.
- The dialog's forecast uses the working days and holiday choice you set in the dialog, not a workflow's own. Confirm a workflow's dates in its Forecast view.
- On Request is never built on its own schedule, an Annual Plan needs a calendar before it can be saved, and a Daily pattern needs a Start date.
A frequency is a reusable scheduling rule that decides which days a job is eligible to run. Define it once in the Toolkit, then jobs across your workflows can share it. As you build the pattern, a forecast beside it previews the dates it matches.
Scheduling rules copied into each job drift apart and mishandle holidays and non-working days, so jobs run on days they shouldn't or skip days they should, and it's hard to verify before it happens.
- Patterns
- Several Days and Quarters
- Working Days
- Offsets
- Create a Frequency
Patterns
Choose a pattern
Frequencies are built from a time period and, for most, a type:
| Pattern | Example |
|---|---|
| Daily | Every day, or every N days from a start date. |
| Weekly | Specific weekdays (Mon/Wed/Fri), or a position within the week. |
| Monthly | One or more days of the month (the 1st and the 15th), a weekday position for one or more weekdays ("second Tuesday"), or a period ("last working day"). |
| Quarterly | A weekday position within the quarter ("first Monday of the quarter"), or a period ("last working day of the quarter"). Quarters are calendar quarters, starting 1 January, 1 April, 1 July and 1 October. |
| Yearly | A date (Dec 31), a weekday position counted across the whole year ("first Monday of the year"), or a period within the year. |
| On Request | No rule at all — the job runs only when an operator adds it to a workflow instance. |
| Annual Plan | A calendar you pick as its Plan calendar — one of your own, or Master Holiday Calendar (system) to run on your organization's holidays; its dates are the days the job runs on. |
For the five recurrence periods you can also choose whether to count working days only, what to do when a match lands on a non-working day, and a calendar of dates to exclude. On Request takes none of those, and Annual Plan takes only an offset.
Several Days and Quarters
Picking several days
- Monthly Day. The Day list takes several days — select the 1st and the 15th for a twice-monthly run. A day a month does not have is skipped: the 31st produces no run in April. For the month end, use Last · Day or Last · Working Day instead.
- Weekday positions. On a monthly, quarterly or yearly pattern, choose the position (First to Fifth, or Last), then Weekday, and select the weekdays in the row of day buttons that appears. First · Weekday with M and F runs on the first Monday and the first Friday. On a yearly pattern the position counts across the whole year — from 1 January, or back from 31 December for Last — so it runs once a year. Earlier builds ran it in every month of the year; see Yearly weekday patterns.
Earlier builds ran a monthly Day pattern for the 29th, 30th or 31st on the last day of a shorter month. It now produces no run in that month. Check any frequency you built that way.
Quarterly
A Quarterly pattern counts across the whole calendar quarter. Second · Weekday · M is the second Monday of the quarter, counted from 1 January, 1 April, 1 July or 1 October. First, Middle or Last with Day or Working Day is the quarter's first, middle or last day (or working day). Every 2 quarters runs in January to March and July to September. There is no day-of-quarter choice and no fiscal-year setting.
Working Days
Working days, and what happens on a non-working day
Working days are the workflow's setting, not a fixed Monday-to-Friday. Each workflow decides which weekdays it works, so the same frequency can mean different dates in two workflows — and under a Tuesday-to-Saturday week, Saturday is a working day.
Choose the day type deliberately, because the two behave differently. Most patterns offer it as Day or Working Day; a weekday pattern ("second Tuesday", Mon/Wed/Fri) offers it as Any day or Working days only.
| Day type | Behavior |
|---|---|
| Day / Any day | Runs on the date the pattern produces, working day or not. The non-working-day action is not applied — except on a monthly Day pattern, below. |
| Working Day / Working days only | Counts working days only, and the date it runs on is always a working day. |
For a working-day pattern, the non-working-day action decides where a match on a non-working day goes. It defaults to Skip to previous working day, so the run is preserved. Change it to move forward instead (Skip to next working day), to run on the original day anyway (Keep the date (run anyway)), or to drop the run (Omit (do not run)).
Earlier builds silently produced no run when a working-day match fell on a non-working day and no action was set. It now shifts back to the previous working day. If you were relying on that to skip those occurrences, set Omit (do not run) explicitly.
If date is non-working day appears only where the action can change the date: on a daily pattern or a weekday pattern (Mon/Wed/Fri, "second Tuesday") set to working days, on a yearly fixed date — which requires one — and on a monthly Day pattern whose day type is Day. It is not offered on a monthly Working Day pattern or on a period pattern ("first working day", "last working day"), because those already produce a working day. If you are looking for the field on one of those, it is absent by design rather than missing.
A monthly Day pattern reads the action the other way round. With Day, the field applies to each day you picked, and when you leave it unset it shows Keep the date (run anyway), because that is what the build does. Set Skip to previous working day for "the 15th, or the working day before it". With Working Day, the pattern counts working days and no action is offered.
- Setting the action on a monthly Day N / Working Day pattern used to be offered and then rejected on save with Validation failed. It is no longer offered, and the save goes through.
- It used to be offered on the period patterns, where it was accepted and then never applied.
- The list's None choice is gone. It read as "do nothing" but behaved as "move to the previous working day", so an unset pattern now shows the action it actually takes. Nothing already saved changed behavior.
Offsets
Offsets
A period pattern anchored on First or Last ("first working day", "last working day") can take an offset of up to 30; Middle takes none. The offset counts working days, not calendar days. "First working day plus two" therefore lands on a working day in every month, rather than falling on a weekend and producing no run at all.
Because the offset walks working days, the Offset days field appears only when the day type is Working Day, and switching back to Day clears it. An Annual Plan has its own offset, which steps working days from each plan date — so an offset of 1 runs one working day after each date in the calendar, not on the next calendar entry. A plan date that is also a holiday still runs; with an offset, the steps skip holidays as well as non-working days.
A weekly period pattern now has the field too. Earlier builds applied a weekly offset if one was
already stored but gave you nowhere to enter one. Weekly is the one pattern whose offset is
forward only — 0 to 30; monthly, quarterly, yearly and Annual Plan each accept −30 to 30.
Create a Frequency
To define a frequency, complete the following steps:
- Go to Toolkit, open the Frequencies tab, and select New Frequency. Everything below happens in one dialog, with the forecast alongside the pattern.
- Enter a Name and, optionally, a Description.
- Choose the time period and type, then set its fields (interval, days, day of month, and so on).
- Optionally set working-day handling, a non-working-day action, an offset, and an exclusion calendar.
- Check the forecast beside the pattern for the dates it produces. Set the Working Days and Use Master Holiday Calendar above the grids to preview a different week; they begin as Monday to Friday with holidays on and change only the preview — see the note on the forecast below.
- Save. Save stays off until you have changed something and the pattern is complete. If something is missing, such as a day of the week on a weekly pattern, the line under the pattern says what to fix — Select at least one day of the week.
- A frequency is the which-days rule. When within the day, retries, and reruns are set on the job when you add the frequency to it. See Set when a job runs.
- Use an exclusion calendar (defined on the Calendars tab of the Toolkit) to skip holidays and blackout days.
- On Request is never picked up by a scheduled build. Choose it for work an operator injects into a run that already exists, not for work you expect to appear on its own.
- A Daily pattern needs a Start date: clear it and the field says A start date is required, and Save and the forecast stay off until you enter one.
- Annual Plan can't be saved until you pick a calendar. Renaming that calendar is safe now, and deleting it is refused while the frequency uses it — so a plan schedule no longer goes quiet because someone tidied up the Calendars list.
- The forecast beside the pattern uses the same calculation as the build, so it applies the non-working-day action, the exclusion calendar and working-day offsets. A frequency belongs to no workflow, though, so the forecast uses the Working Days and the Use Master Holiday Calendar switch set above it, not a workflow's, and applies no additional holiday calendar. For a workflow with a different working week or with additional holidays, confirm what it will actually build in the workflow editor's Forecast view.
- If the forecast shows Preview unavailable, you can still save the frequency. The message says whether a calendar the frequency uses could not be loaded.
- A by-weekday pattern names each day once. Repeating a day, or naming something that isn't a day of the week, is now reported rather than quietly making no difference to the dates.
- Dates are supported for the calendar years 1900–2999, in the forecast and in the build alike.
- Frequencies are shared across workspaces, so name them clearly, and settle on a name before jobs use it. A job holds its frequency by name, so renaming a frequency that jobs use stops their deployed workflows from building until each job is given the renamed frequency and the workflow is deployed again. A row's Cross Reference lists the jobs that use it, and a frequency that jobs use cannot be deleted.
Related topics
- Frequencies — full configuration reference and troubleshooting
- Workflow Settings (Builder)
- Use thresholds and resources (Builder)