Skip to Content

Design and Deploy Your First Integration Flow

Design an integration flow to integrate an online webshop that exposes data via OData service and fetch the product details.
You will learn
  • How to design and deploy an integration flow using the web-based integration flow designer
  • How to design an integration flow to fetch data from an online web shop that is available as an OData service
KarunaharanKarunaharan VOctober 6, 2022


  • Step 1
    1. Choose Design > Integrations > Create to create an integration package.

      An integration flow should be associated with an integration package.

      Create integration package

      In the Header tab, provide a Name and Short Description for your integration package.

      The Technical Name gets populated automatically based on the name that you provide.

      Choose Save and then choose Artifacts to navigate to the artifacts tab. In this tab, you will create your first integration flow.

      Provide package details and navigate to artifacts
    2. Choose Add > Integration Flow.

      Add integration flow artifact

      Enter a Name for the integration flow and choose OK.

      Enter integration flow details and confirm
    3. Choose Save and open the integration flow by selecting it.

      Save integration package and open integration flow
    4. Choose Edit to start editing the integration flow.

      Choose Restore at the bottom right corner to bring up the Property Sheet. Property sheet is the place where you define the parameters for each step in the integration flow.

      Start editing the integration flow
  • Step 2

    In this step, you define your sender channel and sender adapter. In this case, we use a HTTPS sender adapter.

    1. Choose the Sender step. Create the sender channel by clicking the arrow icon on Sender and dragging it to the Start step.

      Create the sender channel
    2. In the Adapter Type prompt, select the HTTPS adapter.

      Select HTTPS adapter
    3. In the property sheet, select the Connection tab. In the Address field, enter /products/details.

      Optionally, you can enter any value of your choice, but ensure that you use “/” symbol before specifying the endpoint name. Deselect the CSRF Protected checkbox (this will be selected by default).

      Configure HTTPS connection
  • Step 3

    Input to the integration flow is sent in JSON format. At a later point, you communicate to a web shop which is a OData service. You use the converter for this JSON to XML conversion. After the input is converted into XML, the message is sent as header information to the OData service to fetch the required product details.

    1. From the palette (the grey bar on the top containing integration flow steps), choose Message Transformers > Converter > JSON to XML Converter.

      JSON to XML Converter
    2. Connect the converter to the message path by clicking on the message path.

      Connect JSON to XML Converter to message path
  • Step 4
    1. Choose Message Transformers > Content Modifier and add it to the message path, as you did for the JSON to XML Converter.

      Add Content Modifier
    2. In the property sheet, choose Message Header > Add to configure the Content Modifier. Enter the following parameters:

      Field Name Description
      Action Create
      Name productIdentifier
      Source Type Select XPath from the dropdown list
      Source Value //productIdentifier
      Data Type java.lang.String
      Configure Content Modifier
  • Step 5

    From the palette, choose Call > External Call > Request Reply. Connect it to the message path, similar to the previous steps.

    Connect request reply step
    Connect request reply step
  • Step 6
    1. Move the Receiver step below the Request Reply step by selecting it and dragging it to the desired position on the editor. You do this to ensure that your integration flow is elegantly designed.

      TIP: Use the pan and zoom controls (highlighted in yellow) for resizing the canvas. Use the guidelines to ensure that Receiver is aligned with the Request Reply step.

      Move Receiver below Request Reply
    2. Connect the Request Reply to Receiver by dragging the arrow icon on Request Reply to the Receiver.

      Connect Request Reply to Receiver
    3. In the Adapter Type prompt, select OData. In the Message Protocol prompt, select OData V2.

      Select adapter
      Select message protocol
    4. Select the Connection tab. In the Address field, enter This is the URL of the online web shop from which you will fetch the product details.

      Enter connection details for OData adapter
    5. Select the Processing tab and choose Select in the Resource Path field.

      OData processing resource path selection - 1
    6. Ensure the connection details are the same and choose Step 2.

      OData processing resource path selection - 2
    7. Choose the Select Entity field and choose Products from the dropdown list.

      OData processing resource path selection - 3
    8. Enable the Select All Fields checkbox and choose Step 3.

      OData processing resource path selection - 4
    9. Choose the Select Field icon.

      OData processing resource path selection - 5
    10. Choose Product ID and then OK.

      OData processing resource path selection - 6
    11. In the dropdown list, select Equal. In the value field, enter ${header.productIdentifier}. Choose Finish.

      OData processing resource path selection - 7
    12. Choose Save.

    Now you have configured the OData adapter to fetch the details of the product based on the product ID that you send as input while making the HTTP call.

    What is the protocol that the web shop uses to expose data?

  • Step 7
    1. Choose Deploy to deploy the integration flow. Choose Yes in the confirmation dialog for deployment. Upon deployment confirmation, choose the Deployment Status tab in the property sheet.

      Deploy integration flow and access deployment status
    2. In the Deployment Status tab, you can see details about the deployment for the integration flow. The expected deployment status is Deployed and runtime status is Started.

      View deployment status

    Later in the mission, you will use the endpoint of the deployed integration flow in a subsequent step. You will define the integration flow endpoint as application programming interface (API). And finally, call the integration flow API using API Management.

Back to top