Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Running an Overlay

Running an overlay computes the impact of your adjustments on the baseline forecast. Like forecast versions, this is done with the Play button and is a separate step from configuring the overlay.

Prerequisites:
  • The overlay must have at least one block configured (target, operation, value, dates)
  • The version's baseline must be run and locked. Every overlay belongs to a forecast version (shown in the breadcrumb at the top of the overlay page), and it computes against that version's official baseline — so the version needs a completed forecast run that has been locked. If the baseline isn't locked yet, the run is rejected with "Forecast version must have a locked baseline before overlays can run."
How to run:
  • Open the overlay document (from its version, or via the sidebar)
  • Click the Play button (triangle icon) in the upper-right toolbar
  • The status badge changes to "Running" while the computation executes (typically 2-5 minutes)
  • When complete, the status changes to "Ready"
Reviewing results:
  • Once ready, charts and tables update to show the overlay-adjusted forecast alongside the baseline
  • You can see exactly how your adjustments change the numbers
  • If the results aren't what you expected, edit the overlay configuration and run again

You can re-run as many times as needed while the overlay is unlocked. Each run replaces the previous results. To pin a run as the overlay's official result for this version, lock it.

Run or cancel through the assistant

In Agent mode, name the overlay and its forecast version, ask to run it, and review Allow/Deny. The same prerequisites apply: valid saved configuration, an unlocked overlay and a locked baseline. The accepted run is observed in mounted chat; it is not reported as completed merely because it started.

To cancel, ask for the specific running overlay job. The assistant resolves its exact run identity before confirmation. The current overlay lifecycle records a cancelled run as failed; that status does not mean another run was cancelled. No new background continuation is promised after all observing pages close.