Attaching the flow debugger to an integration server for debugging

Before you can debug your message flow, you must attach the flow debugger to the integration server where your flow is deployed, then start a debugging session.

To attach the debugger to an integration server:

1. Set the JVM debug port by modifying the server.conf.yaml configuration file for your integration server.
   1. Open the server.conf.yaml configuration file by using a YAML editor.

      You can edit the file by using the built-in YAML editor that is provided in the IBM App Connect Enterprise Toolkit, either by double-clicking the file in the Application Development view or by right-clicking the file and selecting Open with > YAML editor. If you choose to edit the file by using a plain text editor, ensure that you do not include any tab characters (which are not valid in YAML) and use a YAML validation tool to validate the contents of your file.

   2. In the Resource Managers section of the .yaml file, specify a value for the jvmDebugPort property, which sets the JVM debug port to be used for debugging flows in the Toolkit.
2. Restart the integration server for the changes to take effect.
3. In the IBM App Connect Enterprise Toolkit, click the down-arrow to the right of the Debug button in the action bar, and then click the Debug configurations menu item.
4. In the Debug configurations dialog, right-click IBM App Connect Enterprise debug, and then click New.
5. Enter a name for the new debug configuration in the Name field; if you do not specify a name, it will be called New_configuration [IBM App Connect Enterprise Debug] by default. In the Connect tab, set the host name and the Java debug port to match the details of your integration server, as specified in the jvmDebugPort property in the server.conf.yaml file. Click Debug.
6. Open the message flow that you want to debug in the Message Flow editor by double-clicking its name in the Application Development view.
7. Add a breakpoint to a connection that leads out of the input node to ensure that the message flow does not run to completion before you can begin to debug it.

   The breakpoint appears as . For information about adding a breakpoint, see Working with breakpoints in the flow debugger.

8. Switch to the Debug perspective.
9. Optional: If the message flow that you are going to debug references additional resources in other projects, such as ESQL in libraries or independent projects, or Java in Java projects, add those resources by completing the following steps:
   1. In the Debug view, right-click the debug configuration that you created in step 5 and then click Edit Source Lookup from the pop-up menu. If you did not specify a name when you created the debug configuration, it will have the default name New_configuration [IBM App Connect Enterprise Debug].
      You can use Edit Source Lookup Path to tell the debugger where to look for your source files for message flows and related resources such as ESQL and Java™ during debugging.
   2. Click Add, and select the type of source to add to the lookup path.
      The lookup path can be an Eclipse project name, an external folder, or a compressed (.zip) file. You can specify multiple locations, but the debugger always looks first in the message flow project that you specify in the Edit Source Lookup Path dialog.
   3. Select the resources to include in the lookup path, and click OK.
   4. Click Add to include more resources in the lookup path, click Up, or Down to modify the order of the resources.
   5. Click OK to exit the Edit Source Lookup Path dialog, and save your changes.
10. When the next message comes into your flow and arrives at a breakpoint that you added after the input node, the flow pauses, the breakpoint icon is highlighted: , and you can start debugging.
11. In the Debug view, double-click the message flow that you want to debug. The message flow opens in the Message Flow editor. You can now add more breakpoints, start stepping over the flow, and so on.