Page Comparison

...

Create a Data Connector applet. For information about creating an applet, see Creating an applet. A new Data Connector applet appears.
In Interface in the Interface section, click Web Service. The Action and Web Service Interaction sections appear.

Optionally select the applet that the call is routed to if the interface fails in the Interface Failure list.

Info
An interface failure occurs when the request does not receive a response from the web service. A timeout or a DNS lookup failure, for example, might cause an interface failure. Do not confuse an interface failure with a response with a HTTP error status code. For more information about status codes, see Successful action.

In the Action list in the Action section select the template you wish to use. If the template requires request parameter values or returns response values, the Request/Response Definition section appears. If no Request/Response Definition section appears go to step 6.

The Request/Response Definition section contains the folllowing areas:

Request. If present, the request area contains one or more request parameters. Specify a value for each of the available parameters.

Note
You can include placeholders to insert Data Source or custom configuration values into the request parameters. For more information, see Using a Data Source value in a Web Service Interface request or Using a custom configuration value in a Web Service Interface request.

Response. If present, the response area contains one or more response values that the web service returns. Specify the locator for each of the response values. The value or values are stored in Data Sources for later use, if required, in your interaction plan. The names of the Data Sources are defined in the template. You will need to know the names of the Data Sources to use them.

In the following example, the selected template calls a web service that returns the opening times of a shop in the relevant time zone. The web service requires values for the Time and Time Zone request parameters. Data Sources available in the interaction plan, $(OpeningHours) and $(Office|TimeZone), contain the opening hours and time zone respectively. The web service formats the specified opening hours in the specified time zone and returns a JSON response. The required response value is located using JSON dot notation—in this example, result.FormattedTime. This value is stored in a Data Source for use later in the interaction plan.Image Removed

Info

The example template corresponds to the example Request/Response Definition section in the applet. The template shows the request, which requires values for the Time and Time Zone parameters, and the response, which stores the specified response value (result.FormattedTime) in a Data Source called formattedTime.

Code Block

language	xml
theme	Eclipse
title	Example template
linenumbers	true
collapse	true

<ApiInteraction>
    <Request>
        <Url>http://example.com/</Url>
        <Method>POST</Method>
        <Headers>
            <Header>
                <Key>timeKey</Key>
                <Value>%(Time)</Value>
            </Header>
            <Header>
                <Key>timeZoneKey</Key>
                <Value>%(Time Zone)</Value>
            </Header>
        </Headers>
        <Body></Body>
    </Request>
    <Response>
        <Type>JSON</Type>
        <ResponseCodeDestination>HttpResponseCode</ResponseCodeDestination>
        <Fields>
            <Field>
                <Locator>%(Result Locator)</Locator>
                <Destination>formattedTime</Destination>
                <DataType>String</DataType>
            </Field>
        </Fields>
    </Response>
</ApiInteraction>

Anchor

	Successful action 2
	Successful action 2

In the Successful Action list click the applet that the interaction is routed to next.

Note
A successful action indicates that the web service returned a response. The returned response might be an HTTP error status code. You can check the actual response in subsequent applets, such as a Data Router applet. Use the returned ResponseCodeDestination value in the response, which you save in a Data Source, to determine what you do with the call next.

To save your changes, click Update. When you save your changes, the content of the Request/Response Definition section is validated. Any errors appear at the top of the page and the applet is not saved until you correct the errors and click Update again.

...

Versions Compared

Old Version 2

New Version 3

Key