Test a Flow
Work out issues with your flow by performing and evaluating test runs. A flow must meet the following criteria before it can run:
The flow must have a trigger.
The flow must have at least one flow step.
The flow must be published.
When testing a flow, make sure that it is inactive to avoid accidental triggers on a flow that’s not yet ready to handle data.
You can determine if a flow is inactive based on the tag next to its name in the flow editor.
Set a Flow to Inactive
To set a flow to inactive, open the flow, open Settings and make sure the Is Active option is toggled off.
Note: A flow with an On Demand trigger that does not have a schedule defined cannot be set to inactive.
The reason for setting the flow to inactive is that this will prevent the flow from being triggered when an event on the platform occurs and the flow isn’t ready to handle traffic yet.
Trigger the Flow
A flow runs when its Trigger conditions are met. You can test your flow to see its behavior when triggered. You can also filter for record sets to use to trigger your flow.
Trigger Types and Testing
There are three types of triggers:
On Demand: The easiest option to trigger your flow during testing; it just requires selecting the Run button.
Cache Event: Requires an event to trigger your flow.
Action Close Out: Requires an event to trigger your flow.
Search for Record Sets to Test Your Flow
From the main flow builder, go to the Data tab.
In the Quick Searches dropdown, select the option beneath Trigger.
Either select Add Filter to further refine records, or use the records listed in the Results table.
Manually Run a Flow
A flow must be published in order to run, and it will run depending on its trigger. Flows with Cache Event or Action Close Out triggers run automatically, whereas flows with an On Demand trigger must be run manually.
To manually run a flow, do the following:
Make sure the flow is active: Open the flow, go to Settings, make sure Is Active is toggled on.
Make sure the flow is published: Open the flow and select Publish.
Make sure the flow has an On Demand trigger type.
From the Flow builder, select Run and confirm that you want to run the flow.
Test the Flow’s Posting Actions
When testing your flow, before you make requests to the target system, it is a best practice to first test with a sandbox instance of the target system. This is to avoid interacting with live data and to help you learn more about how the system’s API works.
Log into the target system and view the data you are acting on.
Back in the flow builder, select the Runs tab.
Select one of the run results to view the run details, and select Output.
Verify that your flow is posting data and that actions complete as intended.
Test for Other Flow Outputs
Some flows will not result in performing an action or posting data. A flow result may consist of creating a task, sending an email, or ending with a Stop step.
View Tasks
Go to the Tasks page for your workspace. Make sure a task was created.
Alternatively, go to the flow builder page, select the Runs tab, and view the Run Details for the flow. This section indicates any artifacts created by the flow.
View Emails Sent as a Result of a Flow
Send emails to yourself during testing so you can see how they look when sent.
Go to the flow builder page, select the Runs tab, and view the Run Details for the flow. See the recipient(s) of the emails and other details.
View Stop Flow Step Results
As a best practice, you should include a Stop Flow step at the end of each flow you write. Stop steps allow flow authors to provide information about results and custom messages indicating the status of a flow run.
To view Stop step flow output, go to the Runs tab.
2. Select a flow run status for details.
3. If applicable, select Outcome to view more result details.
