Run and Debug Broadway Flow
Setting Run and Debug Arguments
Prior to running or debugging a flow, set the types and values of input arguments that have an External population type. Once they are set, the types and values are saved to the flow's cache.
Click Actions > Debug / Run Arguments in the Main menu toolbar to open a window displaying a list of external input arguments.
Select the Type of each input argument.
Set the value of each input argument. The value's format is defined by the selected argument type.
Click OK to save the types and their values.
Running and Debugging a Broadway Flow
A Broadway flow can be executed from the Main menu of the flow's window by either:
- Running the entire flow and displaying the results.
- Debugging the flow by adding breakpoints. The debug can only be performed when Debug is set to ON or Live. To add a breakpoint, click
in the Stage context menu > Breakpoint or click on the left of the Stage title.
Running the flow or debugging it saves a local copy of the flow in the Fabric project. If the changes have been made in the flow, they are automatically saved even if they have not been explicitly saved. For example, when a Tutorial flow is run or debugged, a local copy of the flow is saved in the Fabric project.
To run the flow, click 
Run Flow to run the entire flow and display the results.
If Debug mode is
ON or 
Live Debug, the flow can be debugged.If Debug mode is
OFF, the flow cannot be debugged.
During the flow execution, the debug icon becomes purple 
. Once the flow is completed, it goes back to either or .
If the breakpoints have been added to the flow, the flow stops at the first breakpoint.
If a flow has an inner flow with breakpoints, the execution of the flow stops at the inner flow’s breakpoints. The inner flow is then brought to the front and displayed at the top of the current flow in the Fabric Studio.
Click
Resume Debug to continue the flow from where it stopped.Click
Debug Step to debug the current step and move to the next step.Click
Stop Run to stop the flow.
When Debug is ON or Live Debug, the flow can be debugged when invoked by any Fabric entity and not necessarily by another Broadway flow. For example, when invoked by a Job.
Note that when Debug mode is Live Debug, the flow runs automatically on every change in the flow except for changing the Debug / Run arguments. For example, when adding a new Actor, adding or removing a link or modifying a value.
Displaying Input and Output Data During a Debug
When Debug is ON, the values of the input and output arguments of each executed step are displayed in blue balloons known as Data Viewers. A Data Viewer displays Java objects using a JSON-like visualization of a Broadway map, list and Java primitive data types.
To view a step's data, click the blue balloon to open the Data Viewer and its displayed format. To set another data display format, click the format dropdown and make your selection.
Updating a Schema
The Broadway Debug process learns the Schema of an Actor's arguments and can suggest how to update it based on a parameter's value.
When debugging an Actor, the parameter port turns red indicating that the Schema needs to be updated:
Click the parameter's port (red) to open the Compare Schema window.
Click Update to update the output parameter's Schema.
Note that the Update Schema option can also be applied on complex structures.
Run and Debug Broadway Flow
Setting Run and Debug Arguments
Prior to running or debugging a flow, set the types and values of input arguments that have an External population type. Once they are set, the types and values are saved to the flow's cache.
Click Actions > Debug / Run Arguments in the Main menu toolbar to open a window displaying a list of external input arguments.
Select the Type of each input argument.
Set the value of each input argument. The value's format is defined by the selected argument type.
Click OK to save the types and their values.
Running and Debugging a Broadway Flow
A Broadway flow can be executed from the Main menu of the flow's window by either:
- Running the entire flow and displaying the results.
- Debugging the flow by adding breakpoints. The debug can only be performed when Debug is set to ON or Live. To add a breakpoint, click in the Stage context menu > Breakpoint or click on the left of the Stage title.
Running the flow or debugging it saves a local copy of the flow in the Fabric project. If the changes have been made in the flow, they are automatically saved even if they have not been explicitly saved. For example, when a Tutorial flow is run or debugged, a local copy of the flow is saved in the Fabric project.
To run the flow, click Run Flow to run the entire flow and display the results.
If Debug mode is
ON or Live Debug, the flow can be debugged.If Debug mode is
OFF, the flow cannot be debugged.
During the flow execution, the debug icon becomes purple . Once the flow is completed, it goes back to either or .
If the breakpoints have been added to the flow, the flow stops at the first breakpoint.
If a flow has an inner flow with breakpoints, the execution of the flow stops at the inner flow’s breakpoints. The inner flow is then brought to the front and displayed at the top of the current flow in the Fabric Studio.
Click
Resume Debug to continue the flow from where it stopped.Click
Debug Step to debug the current step and move to the next step.Click
Stop Run to stop the flow.
When Debug is ON or Live Debug, the flow can be debugged when invoked by any Fabric entity and not necessarily by another Broadway flow. For example, when invoked by a Job.
Note that when Debug mode is Live Debug, the flow runs automatically on every change in the flow except for changing the Debug / Run arguments. For example, when adding a new Actor, adding or removing a link or modifying a value.
Displaying Input and Output Data During a Debug
When Debug is ON, the values of the input and output arguments of each executed step are displayed in blue balloons known as Data Viewers. A Data Viewer displays Java objects using a JSON-like visualization of a Broadway map, list and Java primitive data types.
To view a step's data, click the blue balloon to open the Data Viewer and its displayed format. To set another data display format, click the format dropdown and make your selection.
Updating a Schema
The Broadway Debug process learns the Schema of an Actor's arguments and can suggest how to update it based on a parameter's value.
When debugging an Actor, the parameter port turns red indicating that the Schema needs to be updated:
Click the parameter's port (red) to open the Compare Schema window.
Click Update to update the output parameter's Schema.
Note that the Update Schema option can also be applied on complex structures.
