Versions, drafts and simulate
How drafts and published versions relate, how to view and restore an earlier version, and how to dry-run a journey with Simulate.
Every journey has one draft that you edit and any number of published versions that patients run on. This page explains how they relate, how to look at or go back to an earlier version, and how to walk through a journey with Simulate before you publish it. It is for administrators and implementation staff who build journeys.
Drafts and versions
- The draft is your working copy. There is one per journey. It saves itself as you work and never affects patients.
- A version is a frozen copy of the draft, made when you publish. The first is v1, and each publish with changes adds one. Versions can be viewed but never edited or deleted.
- Patients stay on their version. A patient runs on the version that was latest when they entered. Publishing v4 does not move patients already on v3; only patients who enter afterwards start on v4.
A version holds the steps, connections, recurring schedules, initiation fields and journey settings as they were at publish time.
The History drawer
Select History in the builder header. The drawer shows:
- Current draft at the top, with Last edited and Open in editor. If the draft was restored from a version, it shows the badge restored from vN until you next publish.
- Each published version, newest first, with its vN chip, when it was Published, its number of nodes, a restored from vN badge if it was published from a restored draft, and the buttons View and Restore.
Before the first publish the drawer says: "Publish the journey to create its first version. Published versions appear here with options to view or restore."
Viewing a published version
Select View published in the header to see the latest version, or View on any version in History.
The canvas shows that version read-only, with the banner Viewing published vN. The palette is hidden, and Settings, Schedulers, Save and Publish are disabled. You can still use Simulate to walk through the version you are viewing.
The banner has two buttons:
- Back to draft returns to your draft.
- Revert to published version starts a restore of the version you are viewing (see below).
Restoring an earlier version
Restoring copies a published version into your draft. It is how you roll back a change.
Choose the version
Staff with Journeys PublishOpen History and select Restore on the version, or view it and select Revert to published version.
Confirm
The dialog Revert to published version explains: "Reverting copies vN into your draft and overwrites the current draft graph. Published history is never changed. Continue?" Select Revert.
Expected result: You see Draft replaced with vN, and the canvas shows the restored steps.
Publish to make it live
Review the findings and select Publish.
Expected result: A new version is created from the restored draft, for example v5 with the badge restored from v3.
Restoring overwrites your draft
Any unpublished work in the draft is replaced and cannot be recovered. If you might need it, publish it first, so it is kept as a version.
Restoring on its own changes nothing for patients: the restored draft only reaches patients when you publish it. Published versions are never changed or removed.
Restore does not bring back old settings
Restore copies the version's steps, connections and recurring schedules into the draft. It does not change the journey's current Settings. The next publish uses the settings as they are now. If you need the old settings, set them again in Settings before publishing.
Simulating a journey
Simulate walks through the journey on screen so you can check its paths before patients use it. "Simulating — nothing is sent or saved": no message is sent, no task is raised and no booking is made.
Open Simulate
Select Simulate in the builder header.
Expected result: The Simulate drawer opens and an amber banner says Simulating — nothing is sent or saved.
Set the starting point
Set As of (the date and time to simulate from). Under Patient, fill in the journey's initiation fields. Optionally set Package payment pending and Package balance due (paise) for journeys that check package payments.
Make choices when asked
The walk starts at Start and follows the connections. When it cannot decide on its own it stops and asks you.
Read the result
The Path section lists the steps in order, with what each would do and the outcome chosen. Show on canvas highlights the path. The Trace section gives the detail.
Try another path
Select Restart to clear your choices and walk again. Select Exit in the banner to close Simulate.
The choices Simulate asks for
Prompt | When it appears |
|---|---|
Which outcome? | An action step has connections that route on its outcome. Pick the outcome to follow, or No matching outcome to follow the default or plain connection. |
Which arrives first? | A Pause has more than one way to wake (an event branch and a time branch, or several events). Pick which one happens first. |
Can't evaluate here — pick a path | More than one connection fires, or a condition cannot be worked out with the values you entered. Pick the path to follow. |
Simulate follows one path at a time. Where the real journey would run several tracks in parallel, it asks you to pick one, so walk the other paths in turn.
For a Pause time branch, Simulate compares the wait with As of: a wait that is already due at the as-of time fires straight away, and one that is still in the future at the as-of time stops the walk there.
What Simulate tells you
Each step in the path has a short narrative, such as would send (Reach), would ask (Engage), would place the form (Capture), would send for signing (Sign), would book (Appointment), would hand over (Connect) or would produce (Produce). A Gather says it waits for the incoming paths, and a Routine that it repeats from here.
The walk ends with The walk ended, or Stopped after many steps — check the graph for loops if it goes round a loop too many times. Without a Start step you see Add a Start step to simulate.
What Simulate does not cover
- "Global events, schedules and repeats are not simulated": interrupt handlers, recurring schedules and repeated Routine runs are left out.
- Involve and Tell steps are shown as not available in this version — would fail here. Both steps do run for real patients; you cannot walk through them in Simulate.
- Simulate does not look up records, check availability, or run AI flows.
Dry-running an AI Aide
On an AI Aide step's menu, or next to a simulated step that has an AI Aide, select Dry run to preview how the aide would fill the step's fields. It is a preview with sample values: no AI is run and the outputs are examples, not real results. See AI Aide node.
A safe way to change a live journey
- Edit the draft. Patients are not affected.
- Run Simulate over the paths you changed, and fix every blocking review finding.
- Publish. New patients start on the new version.
- Watch the Health and insights tabs for patients who get stuck.
- If something is wrong, restore the previous version from History and publish it. Patients who entered on the faulty version stay on it; staff can help them from the Patients tab.
Related pages
- Publishing and validation rules
- Creating and managing journeys
- Running journeys: the Patients tab and actions
Last updated on
Publishing and validation rules
How a journey is checked and published, what each finding level means, and the full list of review messages with how to fix each one.
Who can do what in Journeys
The Journeys permissions, what each one lets a person do, and how to give staff access to build, publish and run journeys.