Debugging Pipelines

The Pipeline Debugger enables you to track the execution of a pipeline step-by-step within UX Studio to help you identify errors. Using the Pipeline Debugger, you can easily check the storefront behavior of pipelines, track specific pipeline sections, and monitor the status of the Pipeline Dictionary at each step using a special watch window. The Pipeline Debugger, unlike standard programming language debuggers, operates on the graphical representation of the pipeline rather than at the source code level.

When you run the Pipeline Debugger and interrogate variables or expressions, the variables and expressions are evaluated in the context of the current storefront session. Most often, the pipeline under scrutiny is triggered by an action in the storefront. It's also possible to trigger a pipeline directly, using the browser URL input box. However, such an isolated action might leave out certain session dictionary keys that the pipeline expects.

Note: Pipeline debugging is disabled on Production instances to prevent interceptions of credit card data.
  1. Select a site, and click Storefront. The storefront opens in a new tab in your browser.
  2. Open UX Studio.
  3. Click the down arrow beside the button and select Debug configurations from the popup menu.

    If you click the button instead of the down arrow, the debugger produces the following message:

    The selection can't be launched and there are no recent launches.

    Be sure to click the down arrow to get the popup menu.

    The Debug Configurations dialog box opens.

  4. In the Configurations window, double-click Salesforce B2C Commerce: Pipeline Debugger.
  5. Enter the debug session name.
  6. Enter the Site to Debug.

    For example, Sites-SiteGenesis-Site.

  7. Click Debug.
  8. Navigate to the pipeline you want to debug.

    For example: Cart.xml

  9. Right-click the node in the pipeline where you want to start debugging.

    For example: Cart-PrepareView.

  10. Select Add/Remove Pipeline Node Breakpoint (or click the icon in the toolbar).
  11. Return to your storefront application.
  12. Navigate to the location you want to investigate. Process until the debugger returns to Studio, indicating that the breakpoint has been reached.

    For example, add an item to the cart, and click View Cart in the cart quick view.

  13. Studio prompts you with the following message:

  14. Click Yes.
  15. The debugging perspective opens.

  16. Use the Step (Into, Over and Return) buttons to step through the pipeline to identify problem causes.
Note: Because you can define multiple server connections, you can also define multiple remote server configurations. Therefore, when defining a debug session, you can select the remote server configuration for that debug session.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.