Forecast view
- Synopsis
- Full Details
In briefForecast redraws the workflow editor's canvas as the build of that workflow for one date. Only the jobs that would build are drawn, each with the frequency it built under, its build status and an estimated start window. It uses the workflow as it stands in the editor, unsaved edits included.
WhereDesign › Workflows › open a workflow › the Forecast switch on the right of the editor's toolbar, with the Date field beside it. In a narrow toolbar, Date appears once Forecast is on.
When
- You want to know whether a workflow builds on a given date, and which of its jobs would be in that build.
- You have changed a frequency, a start offset or a job, and want to see the effect before committing.
- You want an estimated start and end for each job on a date.
To see the list of dates a single frequency produces, use the forecast on Frequencies instead. To see what actually built and ran, look at the run on the Processes page.
How
- Open the workflow from Design › Workflows.
- Turn Forecast on. The canvas is redrawn as the build for today.
- Change Date to forecast another day; the forecast re-runs on its own.
- Turn Forecast off to go back to editing. The full workflow-building steps are in Add jobs to a workflow.
- The editor is read-only while Forecast is on, and draft auto-save pauses. Nothing you did before turning it on is lost.
- Each card shows only the winning frequency, not every frequency the job carries.
- The start window is an estimate from the frequency's settings, always labelled (Estimated),
with dates as
mm/dd/yyyyand 24-hour times. A card with no time row could not be estimated. - The forecast applies the workflow's holiday and exclusion calendars. If one cannot be read, the forecast fails rather than leaving it out.
- A forecast that fails does not open the view; the canvas is left as it was, never partly drawn.
- An edit made after the forecast was requested is not in it. Change the date and back, or leave and re-enter, to forecast the current state.
- Opening a different workflow while a forecast is running discards it and leaves Forecast off.
Forecast answers one question before anything is committed: if this workflow built for a given date, which jobs would be in the build, and when would each one start?
Turning it on sends the workflow to be built for the date you choose and redraws the canvas as that build — the same jobs, with the frequency each one built under, its build status, and an estimated start window on every card.
This is a view of one workflow on one date. The forecast on a frequency — the list of dates a pattern produces — is a separate feature, on Frequencies. The two do not share a screen, and closing one has no effect on the other.
- Turning It On
- Unsaved Edits
- What the Canvas Shows
- When a Forecast Cannot Run
- Troubleshooting
Turning It On
The Forecast switch is on the right of the workflow editor's toolbar, with a Date field beside it. Date starts on today.
| Action | What to do |
|---|---|
| Start a forecast | Turn Forecast on. The build runs for the date in Date — today, to begin with — and the canvas is replaced by its result. |
| Change the date | Date can be changed only while Forecast is on. It opens a calendar: moving to another month only changes the month shown, and picking a day sets the date, closes the calendar and re-runs the forecast on its own. There is nothing to select again. |
| Leave | Turn Forecast off. The canvas returns to the workflow as you were editing it. |
Date always holds a date — clearing the field is ignored — and neither control accepts input while a forecast is running — a spinner beside the label shows that it is. The label itself changes colour and weight while the view is active, so a forecast canvas cannot be mistaken for the real one.
When the toolbar is narrower than 1,280 pixels it collapses: the commit and discard icons stay, the other icon actions move into a More actions menu, Manage Deployment shows as its icon only, and the Date field is hidden, except while Forecast is on — so the date you are looking at is always on screen when it matters. At the narrowest widths the toolbar wraps onto a second line rather than letting one control slide under another.
Unsaved Edits
It forecasts what you have not saved
The build is made from the workflow as it currently stands in the editor, not from the last committed version. Unsaved edits are included, which is the point: you can add a frequency, change a start offset, and see what the build would do with it before committing anything.
Two consequences:
- The editor is read-only while Forecast is on. Nothing on the canvas or in the job editor can be changed until you leave the view.
- Auto-saving of drafts is paused. The version label shows the bare version number rather than
(auto saved draft)— see Versions and deployments. Edits made before you turned Forecast on are not lost; nothing new is written while you are in it.
Switching to a different workflow while a forecast is still running abandons it: the result is discarded rather than being drawn onto the workflow you have just opened, and Forecast is left off.
What the Canvas Shows
Only the jobs that would build
Jobs that do not qualify for the date are not drawn at all — no greyed-out card, no placeholder. The canvas shows the build, so what is on screen is what would run. A job whose own Disabled switch is on is left out too, exactly as a real build leaves it out.
If nothing qualifies, the canvas is replaced by the message Workflow does not qualify for this date, with No jobs are scheduled to run. Try a different date. beneath it.
That is a complete answer, not an error. It is what you want to see for a workflow that is not meant to run on a Sunday.
One frequency per card, not the whole list
Outside Forecast a card lists every frequency the job is attached to. In Forecast each card shows only the frequency it actually built under — the winning one, the first in the job's list that matches the day (see When more than one of a job's frequencies matches). The Frequencies switches in the tool panel do not change this; the built frequency is a fact about the build, not a display choice.
A build status on every card
The card footer carries the job's build status from the build:
| Card shows | Build Status option | Shown as |
|---|---|---|
released | Released | success |
onHold | On Hold | warning |
toBeSkipped | To Be Skipped | neutral |
The card shows the value exactly as the build reports it, which is the stored form of the Build Status option set on the job's Frequencies tab. The other two build statuses never reach a card: a Do Not Schedule frequency that wins the day keeps the job out of the build, so it is not drawn, and a Disabled frequency is passed over, so the next matching frequency in the job's list wins, or the job is not drawn. What each one means, and the difference between a Disabled build status and a job-level Disabled switch, is in Per-frequency runtime settings.
A job that both names a sub-workflow and has a build status shows both — the status is the whole reason the footer is there, so it keeps its place beside the sub-workflow name.
An estimated start window
Each card gains a time row, in the form:
mm/dd/yyyy hh:mm-hh:mm (Estimated)
The (Estimated) label is always present in this view. It is there because the window is derived from the estimates on the frequency, not measured from a run that has happened.
How the window is worked out:
| Value | How it is worked out |
|---|---|
| Start — user estimate | When the frequency's estimate is user-defined: its predicted start days, plus its predicted start time. |
| Start — otherwise | The schedule's start time plus the frequency's start-time offset. A schedule with no start time is treated as 00:00. |
| End | The start plus the frequency's estimated run time. |
| The date | The forecast date rolled forward by any whole days in the start. A start that reaches into the following day therefore reports the day it actually starts on, not the date you asked for. |
| Times past midnight | Shown as clock times, so a window that crosses midnight reads as the clock would show it. |
The row is left out entirely rather than shown with placeholders when the start cannot be determined or the estimated run time is missing. An absent time row means "not estimable", never "starts at zero".
The date is always mm/dd/yyyy and the times are always 24-hour. This view does no time-zone or
locale conversion, so two people looking at the same forecast see the same numbers.
When a Forecast Cannot Run
If the build request fails, the message from the service is shown as an error, or Forecast request failed followed by the response status if it sent none. The view does not open, and the canvas is left as it was — a failed forecast never produces a partly-drawn build.
The forecast applies the workflow's holiday calendars — its Additional Holiday Calendar and, when Use Master Holiday Calendar is on, the Master Holiday Calendar — and the exclusion calendars on its frequencies. If one of those cannot be read, the forecast fails rather than drawing a build with the calendar left out, exactly as the real build does — see Holiday calendars now reach the build. An Annual Plan's Plan calendar that was deleted, or can no longer be found, gives that frequency no dates, as it does in the build. One that still exists but cannot be read, for example because you may not view it, fails the forecast too; earlier builds drew the forecast without that plan's dates.
Troubleshooting
| Symptom | Likely cause | Resolution |
|---|---|---|
| The Forecast switch will not turn on | A forecast is already running | If a spinner is showing, wait for it to finish. |
| Workflow does not qualify for this date | No job's frequency produces that date | Expected, not a failure. Try another date, or check the frequencies attached to the jobs. |
| A job I expected is missing | It did not qualify for the date, the frequency that won the day has the build status Do Not Schedule, or its Disabled switch is on | All are correct behaviour — the canvas only draws what would build. |
| A card shows one frequency when the job has several | Forecast shows the winning frequency only | Expected. Leave the view to see the full list. |
| No time row on a card | The start could not be determined, or the frequency has no estimated run time | Add the estimate on the frequency. The row is omitted deliberately rather than guessed. |
| The date on a card is not the date I asked for | The start offset reaches into a later day | Expected — the card reports the day the job actually starts on. |
| Nothing can be edited | Forecast view is read-only | Turn Forecast off to go back to editing. |
| The forecast ignored an edit I just made | The edit landed after the build was requested | Change the date and back, or leave and re-enter, to rebuild from the current state. |
Related topics
- Scheduling and the run — what the build does, and what each build status means
- Frequencies — the patterns that decide whether a job qualifies for a date
- The workflow editor tool panel — the filters and canvas controls beside this view
- Versions and deployments — committing what you have forecast