Integration Builder: Graceful Troubleshooting During Development

Troubleshooting Flows in Integration Builder in Development Mode

The default behavior of flow execution logic in the Integration Builder is to log only the trigger unless encountering an error condition during the flow.  While this behavior does optimize logging and is ideal under normal conditions, it limits the visibility you have during development time.  If you want to be able to see what your flow is doing and have visibility into request and response objects then you need another solution.

Quite often, the easiest approach is to use Debugging mode in the flow editor, but that mode is limited to scenarios where you want to replay an existing trigger and aren’t running a flow where multiple executions with the same data would result in duplicate entries in a downstream service.  Sometimes you just need to be able to debug live executions.

How to trigger step execution logging

To accomplish this, we will take advantage of the execution logger’s default behavior.  It only creates a full execution log when an error condition occurs, so let’s intentionally throw an error.  The flow will still execute successfully but, as its last step, throw an error forcing the full execution trace.  For anyone who has ever used console or trace file logging in their code for debugging purposes, this should be a familiar concept.

Add a JS Script step in the On Success path of the last step in your flow.  In this example, the CreatePayment Connector Instance step is the final step in the business logic of my flow.  I’ve added a JS Script step which will execute after CreatePayment and named it ForceLogging.

The content of the step is a single line of code.

When your flow hits this step, it will throw an empty error, but that is enough to accomplish the goal of triggering the trace logger.

You are now ready to debug your flow using live flow executions. Just remember to remove this step before you put your flow into production.

How to enable step execution logging

If you’re developing integrations and need more methods to troubleshoot during this phase, this article helps you develop flows by enabling step logging. By default, Integration Builder only shows the trigger step to facilitate flow execution performance. However, when steps are not visibly logged, it is tougher to develop flows. If you use the debug view in Flows to replay a trigger, it shows you the execution steps. For example, this blog post will help you as you complete a simple integration builder flow.

Trigger Only Integration Builder Flow Execution Step
Trigger Only shown in the Integration Builder Flow Execution Step

How do I develop a flow when I can’t see the step execution?

  1. Create a flow
  2. Get the flow ID
  3. Go to the API Docs for the platform via Quick Start (top left corner) > View our API Docs > Flows.

Once in API Docs,

  1. Find GET /formulas/{id} method and click Try it out.
  2. Open another browser tab to get the flow ID from the specific flow you want to troubleshoot.
  3. Enter the flow ID into the required field for the GET /formulas/{id} method and click Execute.
  4. Then, copy the response body.

 

GET Formulas by ID in the Integration Builder API Docs

Still in the API Docs, go to the PUT /formulas/{id} method.

  1. Complete the ID field with the same flow ID as above.
  2. Paste the copied response body from the previous API call in the formula model for this new API call.
  3. In the Formula template, go to the pasted response body, edit debugLoggingEnabled to true and click Execute.

Sample response for step 3:

Result

Now you should see the flow steps in the execution screen such as in this example.

Be sure to turn this feature off when you go into production. Debugging Enabled in Integration Builder.

Make sure you turn off this feature when you complete development and start deploying integrations to production.

Happy Integrating!

Read more about Integration Builder Flow as a Resource (FaaR): Part 1.