Test a workflow with Debug

Updated

Who can do this: Super Admins, Creators, Collaborators and Integrators. Only Super Admins, Creators and Integrators can use Run and Create Records.

Debug runs your workflow against a real CRM record you pick. You can preview the result without creating anything, or run the workflow for real.

Before you begin

  • Debug tests the workflow version open in the builder. That's the draft while you're editing, or the version you're viewing when you aren't editing.

  • When you select Debug, any unsaved edits are saved first, so the test uses what's on screen. If the save fails, the Debug Workflow dialog doesn't open. While a save is in progress, Debug is turned off. If you select it while the workflow is still saving, you'll see Still saving the workflow β€” try Debug again in a moment.

  • Debug has two modes:

    • Preview is the default. It works out everything the workflow would do, shows you the result, then rolls it all back. No project, run or record is created or changed.

    • Run and Create Records runs the workflow for real when the record meets the trigger's conditions or you select Ignore triggering criteria. It creates a real project unless the run stops at an approval step or fails. The run is tagged as a debug run and left out of the automation numbers in dashboards. It still runs when the workflow is paused.

Test a workflow

  1. Optional: To test a draft, open the workflow's builder and select Edit from v<N>, where N is the version you're editing from. If the workflow has no draft, this creates one from that version. If a draft already exists, a dialog about it opens instead.

  2. Select Debug. While you're editing, it sits between Publish and Save. If the workflow has no draft, Debug also appears next to Edit from v<N> when you aren't editing, and it tests the version you're viewing. The Debug Workflow dialog opens.

  3. Under Search by Field, choose the field to search on. If the trigger has no fields to search on, this list is turned off.

  4. In Search Text, enter a value of at least 3 characters. For number fields, the box is Search Value.

  5. Select Search. If nothing matches, you'll see No results for the search parameters. If the search fails, you'll see Failed to search for records. Please try again.

  6. Under Record, pick the record you want to test against.

  7. Optional: To see what the workflow would do even if the record doesn't meet the trigger's conditions, select Ignore triggering criteria.

  8. Choose a mode: leave Preview selected, or select Run and Create Records. In Run and Create Records, outbound events and the new project's own automations are turned off.

  9. Optional: If you chose Run and Create Records and the workflow has never been published, a second warning appears. To turn on the run button, select I understand this ramp has never been published β€” create the record anyway.

  10. Select Run Preview, or Run and Create Records in that mode. While the run is in progress, the dialog can't be closed.

If the record meets the trigger's conditions, or you selected Ignore triggering criteria, each step's results appear in the dialog. They come with a status message and, when a project was created, a link to it. Otherwise, the dialog shows only the reason the workflow stopped. Changing the record or the mode clears the previous result.

Read the result

Message

What it means

Preview β€” no data was created.

The preview finished and everything was rolled back.

Debug run complete β€” a real project was created.

A project was created. A link to it appears in the dialog.

Debug run stopped at the approval step β€” debug runs cannot be approved, so no project was created.

The workflow waits for approval, and debug runs can't be approved.

Debug run failed β€” no project was created. See the step details below for why.

Check the step details in the dialog to see why.

Record does not meet triggering criteria. Execution stopped.

The record doesn't match the trigger's conditions. Run it again with Ignore triggering criteria to see the rest.

If something stops the test before it starts, Debug shows the reason. For example, it tells you when the workflow's trigger isn't fully set up yet, or when the selected record couldn't be found.

How a debug run differs from a live run

  • Run and Create Records doesn't advance round-robin owner assignment.

  • It runs even when the workflow is paused. Pausing only stops live runs.

  • If the workflow has an approval step, the run stops there and no project is created.

  • Debug runs can't be approved or re-run afterward. To retry a failed live run, see Re-running a workflow execution.

  • A debug run that fails doesn't send the workflow failure email. One that reaches an approval step doesn't send the approval email.

  • A project created by Run and Create Records is a real project. To clean it up when you're done testing, see Complete, archive or re-open a project.

More in Workflows & Automation