Using Workflow Debugger
RPA Builder provides an integrated debugger for Workflows.
To use the debugger, click Debug Workflow (
) or press F8. This starts a test run and opens Workflow Debugger instead of stopping the execution of the Workflow if an error occurs.
When you execute a Debug Workflow run, you can call Workflow Debugger by pressing Pause/Break on your keyboard. You can change the configuration of Workflow objects within the Workflow Debugger and then re-run them or continue from the current position. When the Workflow enters an error state, Workflow Debugger appears.
| 1 | The first pane in Workflow Debugger shows a condensed view of your Workflow and an arrow indicating which step was the last to execute. |
| 2 | The second pane shows the debug information for the selected action step. The Debug Information panel contains a combination of configuration settings and runtime information relating to action steps already executed. |
In this example, the Workflow entered the error state at the Window Wait action step. In the Debug Information panel, the Result section confirms that the window could not be found. Also, in the Configuration section, the WindowTitle value is set to testname, which caused the error because no window with that title existed during the execution.
Workflow Debugger Toolbar
The Workflow Debugger Toolbar contains the following buttons:
-
(
): RepeatExecutes the action step again.
-
(
): Edit & RepeatOpens the wizard for the last action step executed and enables you to modify its configuration and settings to fix the error. The action step then executes again to ensure it works correctly after the changes. The Workflow Debugger shows again on completion and you can check whether the Run State is
OKorError. -
(
): ContinueContinues the Workflow execution.
Note that the Continue with Runstate: drop-down menu reflects the current Run State. You can force the state to
ErrororOKat this point. For example, if you want to debug the OnError part of a Managed Block, set the state toErrorduring the DoAction section which subsequently leads to the execution of the OnError section. You can also force the Run State toOKwhen you want the rest of the Workflow to be executed even though an error occurred. -
(
): Single StepUse this button to execute the Workflow step-by-step.
-
(
): StopStops the current debugging run and returns to RPA Builder.
Note that you can call the wizard for an action step at any time by double-clicking it.
Using Breakpoints
Breakpoints enable you to set points in the Workflow where the Workflow Debugger always stops the execution. You can either set breakpoints before starting a debug run or you can set them within the Workflow Debugger itself. Any Workflow object can have a breakpoint.
To add a breakpoint to a Workflow object in the Workbench, right-click the object and select Set Breakpoint from the context menu. The breakpoint icon (
) shows next to that element.
To remove the breakpoint, right-click the Workflow object again and select Delete Breakpoint from the context menu.
Setting a breakpoint for an item that contains other action steps (Transaction, Managed Block, etc.) enables you to repeat that item (and all of its contents) as a complete unit. This is useful when you are not quite sure of the root cause of an error. You can repeat the surrounding Transaction until you find out where an error occurs.
You can also set and delete breakpoints directly in the Workflow Debugger by clicking on the bar that shows before an object:
RPA Builder saves breakpoints that you have defined in a Workflow along with the Workflow and you can reuse them at any time. Note that breakpoints only affect debug runs. Actual Workflow executions ignore breakpoints.