Completing Connection Properties for Web Services

You need a detailed understanding of the web service that the Business Importer will connect to, using your adapter.

The following properties can be set when importing from a web service.

URL

This is HTTP URL of the web service.

Login

Account name with which to connect to the web service.

Note: Some web services do not require authentication, in which case you do not need to specify account and password.

Password

The password (if required) for the account connecting to the web service.

Web service function or SOAP message

Set to one of:

• The function name to call in the web service
• The full SOAP request text.

Function call example: GetAllPurchaseOrders results in the following SOAP request:

<?xmlversion="1.0"encoding="utf-8"?>
<soap:Envelopexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAllPurchaseOrdersxmlns=\"http://tempuri.org/" />
</soap:Body>
</soap:Envelope>

Alternatively, if the SOAP request requires specific syntax or parameters, you can enter the full SOAP request. For example:

Query="<?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAllPurchaseOrders xmlns="http://tempuri.org/" />
</soap12:Body>
</soap12:Envelope>"

SOAP element

A string containing the name of the element to be read in the Web Service response. When the importer receives a response from the server, the full SOAP message is received, and the Business Importer may not know which of several XML elements contains the data to import. The Business Importer attempts to find elements in the following order (and reads data from the first one of these found):

• The element you name in this field.
• An element with a name made of the calling function name followed by the string “Result”. In the example shown above, this would be GetAllPurchaseOrderResult.
• The <soap12:Body> XML element.

SOAP header values

A string containing the values to be added to the Web Service request header. The values must be formatted as follows:

Name1=Value1;Name2=Value2;…

For example:

SOAPAction="http://MyServer/WebService/GetAllPurchaseOrders"

Timeout

The number of seconds to wait before giving up on a a query from the data source. A value of 0 means there is no limit and the adapter will wait indefinitely for the query to finish. A value of -1 means that the server-determined default time out should be used.