Skip to main content
Getting started with Flow Navigator
Tom Smith avatar
Written by Tom Smith
Updated over 2 months ago

What license do I need to use this feature?
You'll need a Deployment Starter, Teams or Enterprise license to use Flow Navigator.

When you’re comparing a Flow, it's difficult to work out what’s changed from the XML. Location changes add lots of noise and the XML can seem out of order, making it hard to spot unwanted changes.

Gearset's Flow Navigator makes it easy to see what's new, changed, and deleted. This helps you spot any unexpected differences before deployment. Click the Flow button in your comparison results to get started.

An overview of the changes

Flow Navigator starts with a high-level overview of the changes to the Flow.

The sidebar shows which elements and resources have changed

When the comparison source is a Salesforce org, the sidebar shows the version number and status of the Flow in the source org. This helps you verify that you're comparing the Flow version where you made your changes.

Gearset compares Flow version 11 in the source against the latest version in the target. The Flow is draft in the source.

Gearset compares the latest version of the Flow in the source org by default. To compare and deploy an earlier version:

  • click the Change link

  • select the earlier version of the Flow

  • click the Change button

Gearset will fetch the selected version of the Flow from the source org, then you can deploy as normal.

Gearset shows a list of Flow versions available in the source org.

Below the version info, the sidebar breaks the Flow into the individual elements and resources. Next to each element and resource is an icon that shows whether it's new, changed, or deleted. This makes it easy to find unexpected changes, such as an element you didn't plan to delete.

The Flow Navigator sidebar shows a collection of new, changed and deleted elements.

You can turn off the Hide no differences toggle to see unchanged elements and resources. Elements appear as unchanged when they are identical aside from location changes.

The interactive diagram shows where the changes are in the Flow

The main panel in Flow Navigator shows an interactive diagram of your Flow. This makes it easy to explore where new and changed elements fit into your Flow.

The diagram shows new elements highlighted in green and changed elements highlighted in orange.

The diagram shows the Flow as it exists in the source, with highlighting to show changes:

  • green highlighting shows a new element

  • orange highlighting shows a changed or reordered element

  • deleted elements do not appear on the Flow diagram

  • unchanged elements are not highlighted

The diagram behaves in a similar way to Salesforce Flow Builder. You can zoom in and out, and drag to pan around. You can open your Flow in a larger window using the full screen button.

Use the button in the upper right corner to open Flow Navigator in full screen.

To drill down into the changes for an element, click the element in the diagram or in the sidebar.

A detailed view of the changes

The element view shows how elements and resources have changed

When you drill down into an element, the main panel shows the changes to that element. Flow Navigator shows a visual representation of the changes to most elements. This means you don't need to read through XML to work out what's changed.

In this example, we've added a new email action.

Flow Navigator shows a new action element and its input values.

Here, we've changed an input value on an email action.

Flow Navigator shows a Action element with a change to one of its input values.

This decision element has a new outcome and a change to a condition on an existing outcome.

Flow Navigator shows a Decision element with a new outcome and a change to an existing outcome.

We've removed this update records element.

Flow Navigator shows a deleted Update Records element.

Try it out

The Flow Navigator is available for all the flows mentioned below as of the time of this writing.

  1. Screen Flow

  2. Schedule-Triggered Flow

  3. Record-Triggered Flow

  4. Platform Event-Triggered Flow

  5. Autolaunched Flow.

Is there something missing or would you like to get access to Flow Navigator?
Let us know via the in-app chat.

Did this answer your question?