Track Progress Through a Flow with Stages (Beta)

Indicate a user’s point in the flow using the new stage resource and two new system variables: {!$Flow.ActiveStages} and {!$Flow.CurrentStage}. For example, indicate where in a purchasing flow the user is with breadcrumbs or a progress indicator. This feature is new in both Lightning Experience and Salesforce Classic.
Note

Note

This release contains a beta version of flow stages that is production quality but has known limitations. To provide feedback and suggestions, go to IdeaExchange.

Under the Resources tab, define the stages for every permutation of your flow. Then, throughout the flow, identify which stages are relevant to the user by assigning values to the stage system variables.
  • $Flow.ActiveStages identifies the stages that are relevant to the flow’s current path.
  • $Flow.CurrentStage identifies at which stage the flow is. Make sure that the selected stage is included in $Flow.ActiveStages.
Tip

Tip

The standard flow runtime doesn’t represent a flow’s stages by default. However, you can build your own component that does and add it to your flow by using Lightning component screen fields. We recommend using a lightning:progressindicator component.

Example

The Online Purchase flow includes stages for users to review their cart, enter shipping details, enter payment details, and confirm their order. The stages display at runtime using a custom Lightning component.

At this point, $Flow.ActiveStages contains the Review Cart, Shipping Details, Payment Details, and Order Confirmation stages, and $Flow.CurrentStage is set to Review Cart.

A progress indicator component represents the flow's stages.