Loading
Salesforce now sends email only from verified domains. Read More
Automate Your Business Processes
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Debug an Orchestration and Keep Data Changes

            You are here:

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

            Debug an Orchestration and Keep Data Changes

            Test and troubleshoot your orchestration with database updates. Set a start point to skip earlier stages, an end point to stop before later stages, or both to isolate a middle segment. You can also set mock outputs for steps. A step that uses mock output doesn't run its referenced flow or make changes to the Salesforce database. You’re the assigned user for all interactive steps that meet their entry conditions.

            Required Editions

            View supported editions for Flow Orchestration.
            User Permissions Needed
            To debug an orchestration Manage Flow

            Add the Orchestration Work Guide component to the record page layouts that are used by the records referenced by the orchestration’s interactive steps. See Add the Work Guide to a Record Page Layout or Add the Work Guide to an Experience Cloud Site.

            Open the Orchestration from the Automation App

            Open an orchestration from the Orchestration page in the Automation Lightning app.

            1. On the navigation bar, click App Launcher icon.
            2. In the search box, enter automation, and then select Automation.
              The Automation app opens.
            3. In the Automation app, select the Orchestrations tab.
              The Orchestrations list view opens.
            4. Click the label of the orchestration, and then click View in Flow Builder.
              The orchestration opens in Flow Builder.

            Open the Orchestration from Setup

            In Setup, open an orchestration from the Flows list view.

            1. Click Gear icon, and then select Setup.
            2. From Setup, in the Quick Find box, enter Flows, and then select Flows.
            3. Click the label of the orchestration.
              The orchestration opens in Flow Builder.

            Manage Start Points and End Points

            Set a start point to skip earlier stages, an end point to stop before later stages, or both to isolate a middle segment. Set start points and end points only on Stage elements. To test a single stage, set it as both the start point and the end point. Steps in skipped stages don’t produce output values, even when they have configured test output, so configure test input for steps that rely on their output. Use multiple end points when testing decision paths. These settings don't persist when you save the orchestration.

            Saving an orchestration also saves mock input. Clicking Reset Debug Settings doesn't affect mock input.

            1. (Optional) Set a start point and configure test input for the steps that rely on output from stages that didn’t run.
              1. Hover over a stage.
              2. Click The actions icon.
              3. Select Select as Start Point.
                A
                start point icon
                appears on the stage element.
              4. Select a step that relies on output from a stage that didn’t run.
              5. In the Step panel’s Configure Test Input tab, enter the necessary values for the step.
                When you enter a test value, its toggle is set to Included.
              6. To configure test input for more steps that rely on output from stages that didn't run, repeat steps 1d and 1e.
            2. (Optional) Remove a start point and ignore test input for steps.
              1. Hover over a stage.
              2. Click The actions icon.
              3. Select Selected as Start Point.
              4. Select a step with configured test input.
              5. In the Step panel's Configure Test Input tab, set the toggle to Not Included for the input values you want to ignore.
              6. To ignore configured test input values for more steps, repeat steps 2d and 2e.
            3. (Optional) Set an end point.
              1. Hover over a stage.
              2. Click The actions icon.
              3. Select Select as End Point.
              The
              end point icon
              appears on the stage element.
            4. (Optional) Remove an end point.
              1. Hover over a stage.
              2. Click The actions icon.
              3. Select Selected as End Point.

            Configure the Triggering Record for a Record-Triggered Orchestration

            To debug a record-triggered orchestration, set the triggering record. This setting persists for the current Flow Builder session. Trigger a record-triggered orchestration in one of three ways: only when a record is created, only when a record is changed, or when a record is either created or updated.

            Flow Builder preserves the selected triggering record value and setup option when you switch between Edit mode and Debug mode. Refreshing your browser or closing Flow Builder clears these selections.

            1. On the Button Bar, click Debug.
              The Debug panel opens with the Setup tab selected.
            2. For an orchestration that’s triggered when a record is either created or updated, select the type of trigger to debug for.
              • To debug a trigger on a new record, for Run the automation As If The Record Is, select Created.
              • To debug a trigger on a record change, for Run the automation As If The Record Is, select Updated.
            3. In the text box, select the record to use for the debug run’s triggering record.
            4. Deselect Run automation in rollback mode.
            5. To manually clear debug settings, click Reset Debug Settings.

            Set Input Variables for an Autolaunched Orchestration

            To debug an autolaunched orchestration, set values for all of its input variables. The debug run fails if any input variable is missing or invalid. The values you specify persist for the current Flow Builder session.

            Flow Builder preserves the input variable values and setup option when you switch between Edit mode and Debug mode. Refreshing your browser or closing Flow Builder clears these debug settings.

            1. On the Button Bar, click Debug.
              The Debug panel opens with the Setup tab selected.
            2. On the Setup tab, enter values for each relevant input variable.
            3. Deselect Run automation in rollback mode.
            4. To manually clear debug settings, click Reset Debug Settings.

            Manage Mock Output for Steps

            Control the steps that the orchestration run executes in debug mode. Set Define Test Output Values to Off to run a step’s referenced flow. Set mock output for any step that you don’t want to run while debugging. A step with Define Test Output Values set to On uses the defined mock output instead of running its referenced flow. Steps with defined mock output don’t make changes to the Salesforce database.

            Saving an orchestration also saves mock output. Clicking Reset Debug Settings doesn't affect mock output.

            1. In the Debug panel, click the Stages tab.
            2. Turn off mock output for each step in the orchestration that you want to run.
              1. On the Stages tab of the Debug panel, for a step, click Edit.
                The Step properties panel opens to the Configure Test Output tab.
              2. On the Configure Test Output tab of the Step properties panel, set Define Test Output Values to Off.
            3. Define mock output for each step in the orchestration that you don’t want to run.
              1. On the Stages tab of the Debug panel, for a step, click Edit.
                The Step properties panel opens to the Configure Test Output tab.
              2. On the Configure Test Output tab of the Step properties panel, set Define Test Output Values to On.
              3. Enter values for the step’s output values.
            4. Save the orchestration.
              Note
              Note If you’re debugging an activated orchestration you can save the automation only as a new orchestration.

            Start the Orchestration Run

            Debug the orchestration run and view its results in the Details tab of the Debug pane. The orchestration run pauses for each asynchronous step with Manually Set Output Values set to Off. For background asynchronous steps, the orchestration run resumes after the background step is completed. For interactive steps, the orchestration run resumes after you complete the associated orchestration work item.

            1. On the Debug panel, click the Setup tab, and then click Run.
              The Details tab of the Debug panel shows cards for the orchestration run details.
            2. Review the debug details. To see more information about a card, in the card, click Details.
            3. For each interactive step that pauses the orchestration run, complete the associated orchestration work item.
              1. Open the relevant record page.
              2. In the Orchestration Work Guide, complete the work item.
              The information in the Details tab of the Debug panel automatically updates.
            4. To make and save changes to the orchestration, click Edit Flow.
              The Debug pane closes.

            Complete Orchestration Work Items in Flow Builder

            Complete orchestration work items during a debug run without leaving Flow Builder. Open the work item from the interactive step card in the Debug pane and complete it in the Work Guide tab. After you complete a work item, the debug run resumes. You can still complete orchestration work items from the Orchestration Work Guide on record pages.

            1. In the Debug pane, select the Details tab.
            2. On the interactive step card, click Continue in Work Guide.
              The orchestration work item opens in the Work Guide tab on the canvas in Flow Builder.
            3. To complete orchestration work items for more interactive steps, repeat step 2.
             
            Loading
            Salesforce Help | Article