Workflow Snapshots
Workflow snapshots capture and store a state/version of a workflow (a combination of input, workflow configuration and job code) at a specific point in time when a workflow was updated or run. Snapshots are helpful with debugging, auditing, and improving overall workflow performance.
When is a snapshot made?
Snapshots are created in 2 ways:
- When a user saves changes to their workflow either through the canvas or the Inspector
- When a run is made either by creating a new work order or retrying a run
How can I view a snapshot?
To view a snapshot, go to the History page. Expand a work order to see the runs included.
From the expanded history view, there are two ways to visualize snapshots:
- By inspecting a step in the run
- From the Run view
Viewing a snapshot by inspecting a step in the run
Click on the inspect icon in front of the step you would like to view.
This will open the inspector screen for that step in the run with all associated artifacts: logs and input/output data. On the inspector, you'll notice that you're in a read-only mode, and hovering on the workflow snapshot ID chip, you’ll see a message that reads “You are viewing a snapshot of this workflow that was taken on ….”
To view the corresponding canvas for this snapshot, close this inspector view by clicking the X on the top right corner of the page. This will open the associated canvas with the step selected as shown below.
From the canvas, you can inspect any step by clicking on the step and opening the inspector for the run associated with the step and snapshot.
Viewing a snapshot from the Run view
From the expanded history view, click on the run ID to open the run view.
From this view, click on the Workflow name (Simple Flow) to open the workflow canvas for this snapshot. Similar to viewing a snapshot by inspecting a step, you can click the inspect icon in front of the steps to open the inspector for the step.
Editing a Snapshot
Snapshots are read-only and serve as a reference for the state of a workflow when saved or a run is executed. As only the latest version can be edited, in order to edit the workflow you can click on the Switch to latest version on the canvas or use the toggle at the bottom right of the inspector page to switch to the latest version of the workflow.
When you switch to the latest version, the snapshot ID tag will change to blue colour and the text will be latest.
Retrying a Snapshot
When retrying a run with a snapshot, the retry will be executed with the latest version of the workflow and job code. You cannot retry a workflow with an earlier snapshot, only with the latest version.
Snapshots and Version Control
As they save a workflow as a particular set of configuration, input data and job code, snapshots are mainly tools to help administrators with auditing and dealing with errors (such as, for example, why a case hasn't been updated correctly in a database).
OpenFn offers dedicated tools for version control that allows you and your team to manage changes in job code for faster and safer development, debugging and revision.