Running a Route in Debug mode - Cloud

Talend Cloud API Services Platform Studio User Guide

Version
Cloud
Language
English (United States)
EnrichDitaval
API Services Platform
Product
Talend Cloud
Module
Talend Studio
Content
Design and Development
Note: This feature is available only if you have installed the R2020-10 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

To follow step by step the execution of a Route to identify possible bugs, you can run it in Debug mode.

Before running your Route in Debug mode, you need to add breakpoints to the components in your Route. This will allow you to automatically stop the Route at each breakpoint. This way, components and their respective variables can be verified individually and debugged if required.

To add breakpoint to a component, right-click it on the design workspace, and select Add breakpoint on the contextual menu.

A pause icon displays next to the component where the break is added. You can remove the breakpoint by right-clicking the component on the design workspace, and select Remove breakpoint on the contextual menu.
Note that not all mediation components support breakpoint. You cannot add breakpoint on the following components in a Route:
  • starting endpoints
  • isolate components like cConfig, cAWSConnection, cMQConnectionFactory, cBeanRegister, and so on
  • Routelet
The cTalendJob component supports breakpoint, but the Route debugger cannot trace the embedded Job. Therefore variables will only show the Route side.

When a breakpoint is added to a component, you can define a condition to it. To do so:

  1. Right-click the component on the design workspace, and select Conditional Breakpoint on the popup menu. The Breakpoint view appears on the component tab.
  2. On the Breakpoint view, select the Activate conditional breakpoint check box. Select a language from the Languages list and type in the expression in the Expression field to define the breakpoint. If the condition is matched, the Route will stop at the breakpoint. Otherwise the routing process will continued to the next breakpoint.

Once the breakpoints are defined, you can run your Route in Debug mode. To do so:

  1. Click the Run view, and the Debug Run tab.
  2. Click the Debug button.

    The component that the Route stops at is surrounded by a green border on the design workspace. The message exchange at this component is shown in the Variables view at the upper right corner of the Studio.
  3. Click the Breakpoint button to continue the routing process until the next breakpoint.

    If, for any reason, you want to stop the Route in progress, simply click the Kill button; if you want to execute the Route to the end, click the Basic Run button.

    To remove the displayed monitoring information from the design workspace, click the Clear button in the Debug Run tab.