> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflows Test Run

export const InlineImage = ({src, alt = '', height = '1.6em'}) => {
  return <img noZoom src={src} alt={alt} style={{
    display: 'inline',
    verticalAlign: 'start',
    height: height,
    margin: '0'
  }} />;
};

### Intro

The Workflows Test Run feature enables you to run your workflows before deploying them so that you can review execution details and other data. Workflow test runs help you identify necessary adjustments and fine-tune the design, ensuring everything is optimized before deployment.

***

### Required Grants

The following grants give you rights to the Workflows feature:

* **Create Workflows —** This grant allows you to [create a new workflow](https://domo-support.domo.com/s/article/000005331?language=en_US#create_a_workflow_blank_canvas), including from the [template library](https://domo-support.domo.com/s/article/000005331?language=en_US#create_workflow_from_template). Anyone in the instance who needs to create new workflows should have this grant.
* **Manage Workflows —** This grant allows you to perform any action on any workflow in your Domo instance. Superusers, admins, and anyone who helps manage Workflows for the instance should have this grant. People with this grant who need to access *executed* workflow instances must specifically grant themselves the View Execution List and Edit Execution Details permissions to that workflow in the permissions modal.

See [Manage Permissions](https://domo-support.domo.com/s/article/000005179?language=en_US#manage_permissions) to see how to give non-admin users in your instance access to a specific workflow. There are several available permissions.

### Access Test Runs

To access the test run feature in a workflow, you can either [create a new workflow](https://domo-support.domo.com/s/article/000005331?language=en_US#access_workflows) from scratch or go to an existing workflow *that has not been deployed*. The **Test Run** option only appears on non-deployed workflow versions in the canvas.

In the image below, the **Test Run** option displays at the top of the Workflows canvas. Note that the workflow has not been deployed.

<Frame>
  <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000070HjB.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=713c25c425142bc7c0846d899213bc3a" style={{width: 900, height: 448}} width="3332" height="1658" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000070HjB.jpg" />
</Frame>

### Perform a Test Run

<Warning>
  **Important:** You can only perform a test run for a properly configured workflow that has not been deployed and has no validation *errors*. Validation warnings and informational messages do not prevent the test run from executing, though they will still be present when the workflow is deployed if not resolved. Learn about [workflow validation](https://domo-support.domo.com/s/article/000005331?language=en_US#validate_a_workflow) and how to resolve errors.
</Warning>

To start a test run, open your workflow and select **Test Run**.

<Frame>
  <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000070Roz.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=17841f957d36ff572f94896bc9b7b18a" style={{width: 896, height: 446}} width="3332" height="1658" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000070Roz.jpg" />
</Frame>

Your workflow begins to run in the workflow testing view. During the test run, you can see the progress of each workflow step.

<Frame>
  <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq00000757Cv.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=c8ce0da0f66d5579ac426d990472a13f" style={{width: 897, height: 388}} width="2406" height="1041" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq00000757Cv.jpg" />
</Frame>

<Note>
  **Playback controls —** The following controls are available in the workflow testing view:

  * **<InlineImage src="/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000079vSr.jpg" />
    Restart playback —** Restarts the test run playback.
  * <InlineImage src="/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000079qcu.jpg" /> / <InlineImage src="/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000079vj0.jpg" /> **Start/Pause playback —** Start the test run playback or pause the playback while it runs.
  * **<InlineImage src="/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000079rdm.jpg" />
    Skip to end of playback —** If the playback is currently running, this skips to the end.
</Note>

Completed steps are highlighted in green and marked with a check, steps in progress are highlighted in blue with a loading icon, and failed steps are highlighted in red with an x.

<Frame>
  <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000075SkP.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=f8de89d94a0a06a488d6835376c75b56" style={{width: 227, height: 442}} width="346" height="674" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000075SkP.jpg" />
</Frame>

If there are any validation errors while running the workflow test run, the **Review Validation Issues** modal displays. Learn more about test run validation errors below.

# Review Validation Issues

If your test run has validation errors, the **Review Validation Issues** modal displays. Select **Review Issues** to view more information. Learn more about [validating your workflow](https://domo-support.domo.com/s/article/000005331?language=en_US#validate_a_workflow).

<Frame>
  <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000070RnO.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=2643d08d9832778bf4abe81095aaeba2" style={{width: 550, height: 276}} width="1462" height="734" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000070RnO.jpg" />
</Frame>

### Review Test Runs

After testing your workflow, you can review test details in the Workflows executions interface.

Follow these steps to find prior test run executions:

1. Navigate to the
   [executions list](https://domo-support.domo.com/s/article/000005179?language=en_US#view_executions) (**Executions** tab) for the workflow with the test run you want to review.

   <Frame>
     <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000076dNe.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=6b38b0a1fef4498c37a7d0e8e0a4db4e" style={{width: 874, height: 395}} width="2407" height="1088" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000076dNe.jpg" />
   </Frame>
2. Select the **Test Run** tag.

   <Frame>
     <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000076dnR.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=b7ceccb665670180acbb03ad61288c4a" style={{width: 887, height: 412}} width="2342" height="1088" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000076dnR.jpg" />
   </Frame>

   Any test run results matching the test run filter criteria are displayed under **Executions**.
3. Select a row from the list to view that execution's details page.

   <Frame>
     <img alt="" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/8E3HpyZujsEhQGNi/images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000076e1x.jpg?fit=max&auto=format&n=8E3HpyZujsEhQGNi&q=85&s=04f81f36b1c7e295eaefa4df0716714e" style={{width: 892, height: 425}} width="2395" height="1141" data-path="images/kb/ka0Vq000000CPVh-00N5w00000Ri7BU-0EMVq0000076e1x.jpg" />
   </Frame>

### FAQ

Select a question to expand and view its answer.

<Accordion title="Can I initiate a test run with a workflow trigger?">
  No, a test run can only be started manually in the workflow tool.
</Accordion>

<Accordion title="Does a test run actually execute the steps in the workflow model?">
  Yes, a test run invokes any task, integration, or decision included in the workflow.
</Accordion>

<Accordion title="Do test runs consume credits?">
  Yes, you accrue credit usage on test run executions.
</Accordion>

<Accordion title="Can I add breakpoints or only run to a certain step?">
  Not yet, but these are under consideration for a feature release.
</Accordion>
