Debugging the workflow scheme

Workflow debugging is a step in workflow scheme development that must be performed on different sets of acceptable values of workflow input parameters or screens.

Managing debugging progress

Debugging is controlled using the buttons:

In addition to these buttons, there is an additional possibility to stop the workflow on a pre-selected task or even several tasks using breakpoints.

To set a breakpoint for a task, you need to:

1. Select a task (1) on the diagram - as a result, new buttons will appear on the toolbar (2):
   
   1. Switching off the block.
2. Breakpoint:
   
3. Click on the Breakpoint button - as a result, the selected task will have the Breakpoint icon displayed:
   
4. Now you can start the workflow. The workflow reaches the breakpoint and stops. New buttons will appear on the toolbar:
   
   • Continue
   • Stop
   • Restart
   • Step forward
   • 
5. To continue, click one of the buttons:
   • Step forward - the workflow will continue to execute either to the next breakpoint
   • or Continue - the workflow will continue either until the end
6. To remove the breakpoint from the task, you should click on the Breakpoint button again.

In addition to breakpoints, the ability to temporarily disconnect one or more blocks from the scheme is available during debugging.

1. To temporarily turn off a step from the workflow, you should click on the Disable block button - the background color of the button and the color of the task itself will turn gray:
   
2. To re-enable a disabled block in debugging, you must click the Disable block button again.

Debugging stages

1. Starting the workflow.
2. Monitor the progress of the workflow.
3. View intermediate results and get the final result.

Starting a workflow in debug mode

The workflow in debugging mode is started by clicking on the Start button located in the toolbar:

When you click on the Start button, a modal window will appear where you can specify the host on which the robots used in the workflow will execute:

It should be noted that the Data for special run panel appears only if there are robots in the process and the designer wants to run them only on the machine he has selected. If the designer leaves the host and account fields empty, the Orchestrator will select the host based on the principle of the lowest load of hosts. That is, the one that is either free or least loaded, but still has enough computational resources to run the new robot, will be selected.

The Fill in input data for workflow run panel is used to change the values of the workflow parameters if they are not set or the designer wants to change them.

After selecting the start parameters and setting the initial values of the workflow input parameters, the designer clicks the Start button. The workflow is started.

Observation of the progress of the workflow

There are two ways to monitor the progress of the workflow:

• By workflow scheme - executed blocks will be highlighted by a frame that rotates around them;
• By logs - the Logs panel will appear at the bottom under the workflow scheme as soon as the workflow is started.

The logs show the events of the tasks:

• Start of the task;
• Changing the task status;
• Finish of the task.

The log table has columns:

• Date and time of the event;
• Name of the task being performed;
• Type of task;
• Event.

Viewing intermediate results and getting the final result

1. You can view the initial values of workflow parameters for tasks with the Start type.
2. You can view the values of the input parameters of tasks in the Events column for tasks with the status Task started.
3. You can view the values of the output parameters of tasks in the Events column for tasks with the status Task completed.
4. You can view the final results of the workflow for tasks with the Finish type.

Debugging a workflow with a screen form

When debugging a workflow with a screen form, when a screen form is reached, the designer should perform the following steps to execute it:

1. Select the executing SF with the left mouse button - the Block Screen form panel should appear 
   
2. Click on the Fill form button - a modal window with SF should appear, in which you should fill in the missing fields (in this case it is the Second summand field):
   
3. Enter the number 5 in the second field and click on the Send button - the data will be sent to the server, and the workflow will continue according to the scheme.

Reviewing the logs showed the following task results:

1. The Adding 2 numbers robot has completed its work with the result c = 15.
2. The Incrementing a number to a degree robot has completed its work with the result y = 100000.
3. The Adding two numbers subprocess completed with the result y = 100015
4. The Finish block finished with the result Answer = 100015

If no errors were detected during debugging and testing on different sets of acceptable values of workflow input parameters and screen forms was successful, the workflow can be published and allowed for operation.