Test a workflow

Workflow testing allows you to run an instance of your workflow without publishing and exiting the workflow designer. Once you initiate a workflow test, you can close the workflow testing dialog and continue to work in the workflow designer. The test will run in the background and you can launch the workflow testing dialog to view the results or complete a task.

When the workflow is running within the Workflow testing dialog, you can dynamically:

  • View the instance details, configuration errors, tasks, and test status.
  • Manually refresh the instance and task details.
  • Terminate a running instance.
  • Perform any user action required in the task.

If your workflow is not completely configured and you want to test a specific section, you can choose to disable the unconfigured actions and test the desired section(s). For information about how to disable actions, see Disable or enable an action.

Note: 
  • If you make any changes to the workflow that is currently running within the Workflow testing dialog, the changes will not be reflected in the workflow test unless you start a new test.
  • Only one workflow test can be run at a time.

  • Workflow testing currently does not support:

    • Start events with object variables (connector-based start events, such as Salesforce)

      Important: Workflow testing is supported for SharePoint Online start events.

    • File start event variables, which are not from Nintex Forms

  • Workflow instances and tasks that are tested using Workflow testing will not be displayed in the Instances and Tasks pages. You can view the tested instances and tasks only within the Workflow testing dialog box.

Jump to: 

Test a workflow with a component, form, scheduled start, or connector start event

  1. If you are creating a new workflow, save your workflow first, at least once, before you test it.

  2. On the toolbar at the top of the workflow designer, click Workflow testing.

  3. When prompted, enter the necessary information. For more information about the fields and buttons, see Workflow testing tabs, fields, and buttons.

    • For Component workflow - All the fields corresponding to the start event variables will be displayed and you will be prompted for values to simulate the start event.
    • For Form - The form will be displayed and you will need to enter the required values and submit the form.
    • For Scheduled start - The schedule details or values will be bypassed, and the workflow will be executed.
    • For connector-based start events (without object or file variables) - When the workflow testing is initiated, all the fields corresponding to the start event variables will be displayed.

    Note: The start event variables are rendered and submitted as a simulation only. No record or object related to the start event is edited or created; however, once the workflow starts, all workflow actions execute as designed.

    4. The Workflow testing dialog displays the running test instances, tasks, and status of the active workflow execution.

  4. When workflow testing is finished, click Close.

Test a workflow with a SharePoint Online start event

The Item ID of an existing list item can be used to test workflows with a SharePoint Online start event.

  1. If you are creating a new workflow, save your workflow first, at least once, before you test it.

  2. Open an existing workflow or design a new workflow with a SharePoint Online start event.

  3. On the toolbar at the top of the workflow designer, click Workflow testing.

    The SharePoint site URL and List name fields are populated based on the details you defined in the start event configuration.

  4. Enter the Item ID of the SharePoint Online list item you want to use to test the workflow.

  5. Click Retrieve item to retrieve details of the list item. Some item details are displayed in the Item preview.

  6. Check the item details displayed in the Item preview and make sure that you want to test the workflow with this item.

  7. Click Start to test your workflow with the Item you entered.

    The details of the item are passed and used as a real event to test the workflow and execute workflow actions as designed.

For more information about the fields and buttons, see Workflow testing tabs, fields, and buttons.

Tab, field, and button Description
Instance

Lists the instance details of the active workflow executed through the Workflow testing dialog.

Instance tab fields:

  • Action name - Lists the action(s) involved in the workflow.
  • Status - Displays the status of the action:
    • Started - The workflow action is not yet completed and currently running.
    • Disabled - The workflow action is disabled in the workflow configuration.
    • Completed - The workflow action is completed.
    • Failed - The workflow action failed. An error message with the cause of failure will be displayed.
  • Start time - Date and time the action is initiated.
  • End time - Date and time the action is completed.
  • Duration - Duration of the action execution.
Tasks

Lists the task details of the current workflow executed through the Workflow testing dialog.

Tasks tab fields:

  • Task name - The name of the task specified during workflow configuration.
  • Status - Current status of the task:
    • Active - Task outcome not yet completed and currently running.
    • Overridden - Task outcome was selected via the Workflow testing dialog, and not the normal channels (email for Express approval task, and form submission for Form based). Task is complete and no longer active.
    • Completed - Task assignee responded to the task. Task is completed and requires no further action.
    • Terminated - Task terminated without an outcome due to termination of workflow instance.
  • Time initiated - Date and time when the task is initiated.
  • Assignee email - Email address of the task assignee as specified during workflow configuration.
  • Outcome - If the task is still currently active and waiting for response, the following options are available:

    • If the task type is Form based, the Complete form option appears.

    • If the task type is Express approval, the Complete task drop-down appears, showing the following options:

      • Approve

      • Reject

      Note: Aside from the default Approve and Reject response types, any other response type can be created and customized during workflow configuration. For more information, see Tasks.

Initiated Date and time the test is initiated.
Finished Date and time the test is completed.
Status

Status of the test:

  • Running - Workflow test is not completed and currently running.
  • Completed - Workflow test is completed and test outcome is available.
  • Failed - Workflow test failed due to configuration error(s).
Terminate Aborts an active workflow test.
Start new test

Starts executing the workflow test by triggering the execution of all the configured instances and tasks in the workflow.

When you click Start new test, if there is a test currently running, you will be prompted to abort the active test and start a new test.

Refresh now Refreshes information in the Workflow testing dialog. An auto-refresh will be triggered every 10 seconds for the first 30 minutes. Subsequently, the details will be refreshed every 10 minutes.
Instance ID Active or previous test's instance ID.
(Close)

Closes the Workflow testing dialog.

If you close the Workflow testing dialog when a test is active/running, only the dialog will close. The test will still be running in the background as you continue in the workflow designer. An active test can only be terminated by clicking on the Terminate or Start new test option in the workflow testing dialog.