Loading
Prepare for Email to Become the Default Login ExperienceRead More
Automate Your Business Processes with Salesforce Flow
Control Which Stages Show in Your Progress Indicator

You are here:

  1. Salesforce Help
  2. Docs
  3. Automate Your Business Processes

Control Which Stages Show in Your Progress Indicator

After you set up your flow's progress indicator, configure how stages appear as users move through the flow. Show the same stages throughout, add or remove stages based on the path the flow takes, or update the highlighted current stage between screens.

Required Editions

View supported editions.
User Permissions Needed
To open, edit, create, activate or deactivate a flow using all flow types, elements, and features available in Flow Builder, including Einstein and Agentforce for Flow: Manage Flow
Note
Note You don't need to be an admin to have the Manage Flow permission. Ask your admin to add it to your profile or permission set.
Note
Note Progress indicators require Lightning runtime.

Use Standard Functionality with Your Stages and Progress Indicator

If you want to show the same stages throughout your screen flow and assign a highlighted current stage to each screen element, you can do so directly from the screen element.

  1. Make all of the stages that you want to show in the progress indicator active by default.
    1. In a screen flow in Flow Builder, open Toolbox.
    2. Open a stage resource.
    3. Click Active by default.
    4. Click Done.
  2. Assign a stage resource for each screen element in your flow.
    1. In a screen flow in Flow Builder, open a screen element.
    2. Click the screen element’s header to show the screen properties.
    3. For Stage, select the stage resource that you want highlighted in the progress indicator when the user gets to that screen.
    4. Click Done.
Screen properties showing the Stage field highlighted

Add and Remove Stages from the Standard Progress Indicator

If you want to show different stages in the progress indicator at different times, add and remove stages from the progress indicator.

The $Flow.ActiveStages global variable identifies the stages that are relevant to the flow’s current path and represents all the stages that appear in the progress indicator. You can manually update the $Flow.ActiveStages global variable with an Assignment or Subflow element to add or remove stages.

Note
Note If you want to add a stage to the progress indicator after the flow starts, when you create the stage resource, don’t select Active by default.

Add a Stage to the End Automatically

To automatically add a stage to the end of the progress indicator, assign the stage to the screen element where you want it to show in the progress indicator. When the screen element loads, if a stage is associated with it, the flow checks the $Flow.ActiveStages global variable to see if the associated stage is in there. If it isn’t, the flow automatically adds the associated stage to the end of the $Flow.ActiveStages global variable.

  1. In a screen flow in Flow Builder, open a screen element.
  2. For Stage, select the stage you want to add to the end of the progress indicator.
    The selected stage starts showing in the progress indicator when the running user reaches that screen element.
  3. Click Done.

Add a Stage in Between Two Stages

Add a stage in between two other stages in the progress indicator by using a Subflow element to define a stage with an order number in between the order number of the two stages. Then use an Assignment element to set the highlighted current stage.

  1. Create an autolaunched flow.
    1. From the Automation app, click New.
    2. Click Autolaunched.
    3. Click Autolaunched Flow (No Trigger).
    4. Click Create.
    The new autolaunched flow opens in Flow Builder.
  2. Create the stage resource you want to add to the progress indicator.
    1. In the autolaunched flow, open Toolbox.
    2. Click New Resource and select Stage for Resource Type.
    3. Enter the stage’s label and API name.
    4. For Order, specify where you want the stage to show in the progress indicator. For example, if you want the stage to be added in between stage 3 and stage 5, enter 4.
    5. Select Active by default.
    6. Click Done.
  3. Add an element to the autolaunched flow so you can save it.
    Because you can't save and activate the autolaunched flow unless it has at least one element in it, add an element that doesn't impact anything outside of the flow. For example, add an Assignment element and set a variable that isn't available for input or output.
    1. Click New Resource and select Variable for Resource Type.
    2. For API Name enter HoursInDay, and for Data Type, select Number.
    3. Click the plus icon and select Assignment.
    4. Edit the generated label if needed. Flow Builder generates it based on the element's configuration, and the API name populates based on the label.
    5. For Variable, select HoursInDay, For Operator select Equals, and for Value enter 24.
    6. Save, name, and activate the flow.
    The assignment element setting the value of the HoursInDay variable has no impact on the autolaunched flow or the screen flow.
  4. Add a Subflow element in the screen flow where you want the stage to start showing up.
    1. Click the plus icon and select Subflow.
    2. Select the autolaunched flow you created.
    3. Edit the generated label if needed. Flow Builder generates it based on the element's configuration, and the API name populates based on the label.
    The referenced autolaunched flow adds the new stage to the active stages in the parent screen flow, in the order specified on the stage resource.
  5. Add an Assignment element to the screen flow after the subflow element.
    1. Click the plus icon and select Assignment.
    2. Edit the generated label if needed. Flow Builder generates it based on the element's configuration, and the API name populates based on the label.
    3. For Variable, enter CurrentStage and then click CurrentStage. For Operator select Equals, and for Value enter AutolaunchedFlowAPIName:StageToAddAPIName. For example if you named your autolaunched flow Add_a_Stage and you named the stage to add BillingAddress, enter Add_a_Stage:BillingAddress.
      The current stage is set so the added stage is highlighted in the progress indicator in the next screen.
  6. In the screen flow, where you want the stage to start showing up, add a Screen element.
    1. Set up the screen element to fit your needs.
    2. Leave the Stage field blank.
    3. Click Done.

Add a Stage to the Beginning or End Automatically

To manually add a stage to the beginning or the end of the progress indicator after the flow starts, use an Assignment element to add the stage to the $Flow.ActiveStages global variable.

  1. In a screen flow in Flow Builder, add an Assignment element where you want to add a stage.
  2. Edit the generated label if needed. Flow Builder generates it based on the element's configuration, and the API name populates based on the label.
  3. For Variable, enter ActiveStages and then click ActiveStages
  4. Select a value for Operator.
    • To add a stage to the beginning, select Add At Start.
    • To add a stage to the end, select Add.
  5. For Value, select the stage to add.

Remove Stages

If you want to remove stages from the progress indicator after the flow starts, use an Assignment element to remove the stages from the $Flow.ActiveStages global variable.

  1. In a screen flow in Flow Builder, add an Assignment element where you want to remove a stage.
  2. Edit the generated label if needed. Flow Builder generates it based on the element's configuration, and the API name populates based on the label.
  3. For Variable, enter ActiveStages and then click ActiveStages.
  4. Select a value for Operator and Value.
    • To remove the stage specified in the Value field, select Remove First. Then, For Value, select the specified stage.
    • To remove all stages before the stage specified in the Value field, select Remove Before First. Then, For Value, select the specified stage.
    • To remove all stages after the stage specified in the Value field, select Remove After First. Then, For Value, select the specified stage.
    • To remove all the stages, select Remove All. Then, For Value, enter ActiveStages and then click ActiveStages.

Update a Flow’s Current Stage Manually

If you don’t want the highlighted current stage in the progress indicator to correspond to a specific screen element, you can set the current stage manually.

The $Flow.CurrentStage global variable identifies which stage the flow is in. This stage is the one that’s highlighted in the progress indicator. You can update the value of $Flow.CurrentStage with an Assignment element.

Note
Note Make sure that the stage you’re setting $Flow.CurrentStage to is included in $Flow.ActiveStages so that it shows up in the progress indicator.
  1. In a screen flow in Flow Builder, add an Assignment element where you want to set the current stage.
  2. Edit the generated label if needed, for example to Set Current Stage. Flow Builder generates the label based on the element's configuration, and the API name populates based on the label, for example Set_Current_Stage.
  3. For Variable, enter CurrentStage and then click CurrentStage.
  4. Set Operator to Equals.
  5. Set Value to the stage that you want highlighted in the progress indicator.

See Also

 
Loading
Salesforce Help | Article