Debugging

The debugging function allows you to locate and isolate an error in your workflow in order to fix it before the workflow is used in a production environment.

In the Workflow Editor, you can review and assess a workflow to ensure it is ready for use. This is done by attaching the debugger to a workflow and testing it. You use the commands on the Debugger Control Bar to perform these operations.

A debugging session occurs when you attach a debugger to a running workflow, which can be done in both a test or a production environment. If you attach the debugger before the workflow instance runs, the debugger pauses at the load step. At this point, you can set any required breakpoints and then move through the workflow step by step, pausing the workflow at each step or activity before it starts to run. If the workflow configuration at any of these steps requires outside interaction, such as the Form activity and the Manual start function, you must perform these actions before continuing the debugging session.

Also, at each step, you can see the properties in the Variable Viewer. Each step in a workflow is made up of a variety of configurations. When you are in a debugging session, you can view the parameters, properties, and variables that are associated with both the selected step and the workflow as a whole.

A debugging session finishes when the debugger toolbar is detached or the workflow instance is completed or ended. You can detach the debugger from a workflow instance so that it can continue running normally, or be paused or ended.

When you are in a debugging session, the workflow is in a read-only state. Only one user can attach the debugger to a particular workflow instance at a time; however, it is possible to have multiple users attach the debugger to different workflow instances at the same time. Only five debugging sessions for any given workflow are allowed at one time.