> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/flow-health-check.md).

# Flow Health Check

Run an on-demand health check on any process flow version to find steps that point at something missing or not set up - before problems surface at runtime.

## Flow health check

The flow health check looks for steps in a process flow version that point at something that is **missing** or **not set up** - for example, a script shape referencing a deleted script, a map transform with nothing selected, or a route whose first step has been removed.

Previously, problems like these only came to light when a flow failed at runtime, or when a blueprint publish was attempted. With the flow health check, you can check any flow version on demand, straight from the flow canvas.

{% hint style="info" %}
The health check is **informational only**. It never changes your flow, and it doesn't block you from saving or deploying a version - even if problems are found.
{% endhint %}

### Running a health check

To run a health check:

1. Open the required process flow and make sure you're viewing the version you want to check - the health check always runs against the version currently displayed on the canvas, whether that's a **draft** or a **deployed** version. For guidance on switching versions, see [switching between process flow versions](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/process-flow-versioning/switching-between-process-flow-versions).
2. Select the **health check** icon from the canvas toolbar:

<div data-with-frame="true"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FYhp4miUzLNL7gZZ2Hw3X%2FScreenshot%202026-10-28%20at%2016.58.02.png?alt=media&amp;token=4866cf36-921b-4f8e-91f0-da020a53f445" alt="" width="272"><figcaption></figcaption></figure></div>

3. The check runs immediately and results are displayed in the **flow health check** window.

### Understanding results

#### No problems found

If nothing in the flow version points at something missing, the check simply reports that it passed:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fe4n00LSdZ0sgOq6W4p8O%2FScreenshot%202026-10-28%20at%2016.58.38.png?alt=media&amp;token=060f32b9-6d60-466d-b99b-70d9c23c99f9" alt=""><figcaption></figcaption></figure>

#### Problems found

If problems are found, they are grouped and can be filtered by severity. Each problem is reported with:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FkuMDVZovaUMk6UICCYPH%2FScreenshot%202026-10-28%20at%2016.58.10.png?alt=media&amp;token=a62b738e-b62d-4002-a1f8-23c8ddf77434" alt=""><figcaption></figcaption></figure>

| Element           | Summary                                                                                                    |
| ----------------- | ---------------------------------------------------------------------------------------------------------- |
| **Message**       | What the problem is - for example, `This map step has no saved mapping.`                                   |
| **Location**      | Where the problem was found - the flow and the affected shape.                                             |
| **Suggested fix** | What to do about it - for example, `Open the map step and save a mapping, or remove the step.`             |
| **Go to step**    | Takes you straight to the affected shape on the canvas, so you can fix the problem without hunting for it. |

{% hint style="info" %}
Warnings are for your information - they don't stop you from saving or deploying the flow. However, we'd always recommend reviewing them before deploying, as steps pointing at missing components will typically cause failures at runtime.
{% endhint %}

### What the health check looks for

The health check targets steps that reference something that no longer exists, or that was never configured. Typical examples include:

| Problem                                      | Example                                                                |
| -------------------------------------------- | ---------------------------------------------------------------------- |
| A step references a deleted component        | A script shape points at a custom script that has since been deleted.  |
| A step has no configuration saved            | A map shape has been added to the flow, but no mapping has been saved. |
| A step references a missing part of the flow | A route points at a step that has been removed.                        |

### Re-running the check

Fixed a problem? Select **run check again** from the results window to confirm the current state of the version. You can run the health check as many times as you like - remember, nothing in your flow is ever changed by the check itself.
