SOAP Integration Points are built using live web services. Using a live URL of the WSDL enables you to test request and response parameters against runtime as you are designing the mapping. This helps ensure that the Integration Point will perform as expected when it is later used in Interactions.

A SOAP Integration Point is created using the New Integration Point wizard. The wizard facilitates intuitive and accurate request parameter mapping, and provides full coverage for response mapping by using XPath node specification. Testing options are provided at several points during the creation process, allowing you to verify that parameters and mapping being used are accurate.

The workflow of building a SOAP Integration Point (using the wizard) is shown in the following diagram. An overview of each step is provided in the sections below the figure.


Step 1: Load WSDL

In this initial step, a live URL of WSDL is loaded into the wizard, and the relevant method is selected. You may define specific SOAP endpoints by adding one or more system variables as URL parameters. 

Step 2: Specify Headers and Map Request Parameters

If headers are required, they are entered in a Request Headers frame. Then, the parameters in the request body are reviewed and, if necessary, edited. (The request body is automatically displayed in an editable format.) Finally, each request parameter is mapped into a variable that can later be selected when using the Integration Point in the Interaction Designer.

Step 3: Map Response Values to Variables

In this step, values from the response are mapped into variables that can be used later in the Interaction Designer. Each variable is mapped to an XPath pointing to the exact location of the value in the response XML. (The XPath enables direct access to any element in the response XML, including attributes and nodes within complex collections.) Supported variable types incude simple types, collections (of simple types or objects), and objects (custom variable types).

Step 4: Complete and Test the Integration Point

In this final step, a name and an optional description are assigned to the Integration Point, and parameters are reviewed. After creating the Integration Point, an end-to-end functionality test can be done. 

Building a SOAP Integration Point: Introductory Example

The following procedure presents a simple example to explain how to use the wizard to create a SOAP Integration Point. For a more complex example that shows mapping using objects and collections, click here. For more information about constructing the XPath for response parameters, refer to Configuring the XPath for SOAP IP Responses.

To add a SOAP Integration Point:

  1. At the top of the Web Service Integration Points page, click Add, and then select SOAP.


    The New Integration Point wizard opens.
  2. In the WSDL URL field, enter the relevant full URL of WSDL. This must be an active service.
    The Load button is enabled.
  3. If required, define specific endpoints by adding one or more system variables as URL parameters. The syntax of the parameters must be ${<name of variable>}
    For example: https://gointeract.io/test.wsdl.service/TestServices${mySystemVariable}?wsdl
  4. Click Load.
    The WSDL is loaded to the server, and the WSDL Methods list is populated.
  5. If required, from the URL Access Restriction dropdown list, select Private Virtual Network. (The default selection is Public Internet.)
  6. If the selected WSDL contains more than one method, from the WSDL Methods dropdown list, select the required method.

  7. At the upper right corner of the page, click Next.
    The Request page is displayed. A placeholder for headers is displayed in the Request Headers frame, and the request body of the selected method appears in the Request Body frame. The table at the bottom of  the page is automatically populated with the parameters in the request body.

  8. If relevant, enter required request headers. The syntax is header-var:${my-var}.
    (This example requires no request headers.)
  9. In the request body, review the relevant request parameters and edit them as required.
    It is recommended to delete any unnecessary request arguments.
  10. After changing and/or removing request parameters, click Generate Parameters.
    The table below the button is updated.

  11. For each parameter, in the Variable Type column, select the appropriate parameter type. Then, if desired, in the Variable Name column, change the default name (from the request body) to a more meaningful name. The name assigned in this column is the one displayed to users in the Interaction Designer.
    Note: Only simple variable types are supported as input parameters. Objects or collections are not supported as input.
  12. At the upper right corner of the page, click Next.
    The Response page is displayed.

  13. In the Test Parameters frame, enter two parameters (in this case, two strings), and then click Run.
    The response XML is displayed in the Response frame. For example:

  14. In the XPath field, enter the XPath corresponding to the exact location of the required value in the response XML. Then, from the Variable Type dropdown list, select the appropriate type for the variable.

  15. To verify the validity of your mapping, click Evaluate.
    The relevant value is displayed in the XPath Evaluation Result popup.

  16. In the Variable Name column, enter a meaningful name for the variable. The name assigned in this column is the one displayed to users in the Interaction Designer.
  17. Click Next.
    The Details page is displayed, listing the request and response parameters.

  18. At the top of the page, enter a relevant name and description in the appropriate fields. Then, click Create.
    A confirmation message appears, and the Finished page is displayed.

  19. To exit the wizard, click Done.

Note: If desired, you may test the integration point by clicking Test. This navigates you to the Test Integration Point page. For details, refer to Testing Integration Points.

Revision:

Comments