SOAP (WSDL) Connection

image_pdfimage_print

The SOAP connection allows Jedox Integrator to connect to web services which apply to the SOAP protocol (Simple Object Access Protocol).

Main Settings

WSDL:

The URL or file path to the web service definition (the WSDL file). This file defines all the operations of the web service. The URL for the WSDL file can be determined by adding ?WSDL to the web service URL.
For example, if the web service URL is
http://webservice.example:1234/bla
Then the URL for the web service definition is
http://webservice.example:1234/bla?WSDL

If the web service definition can be found in a local or network file, you can enter the file path, i.e. file:\C:\myService.wsdl

Operation:

The name of the operation that will be executed.

Operation Parameters:

The parameters of the web service as parameter-value pairs, as defined in the WSDL file.

User Name:

User for HTTP Basic Authentication. If required by the web service.

Password:

Password for HTTP Basic Authentication. If required by the web service.

Advanced Settings

Service URL:

The SOAP endpoint address where the SOAP message is posted. Normally, it is consistent with the endpoint of the WSDL; in this case this option is not necessary. However, in some cases the WSDL may reference an incorrect endpoint URL, in which case you have to override the generated URL. This is also necessary when the WSDL file is on the local file system and you want to have HTTPS transport trusted.

Service Name:

The name of the service. In most cases this option is not required. See note below.

Service Port:

The name of the port. In most cases this option is not required. See note below.

Action URI:

The URI of the SOAP action.
If not set, the action URI is defined like this: Namespace + local part of operationName.
In most cases it is not necessary to change this default behavior.

SSL Mode:

Off: SSL is not used.
Trust: The certificate is imported to the keystore if not yet available.
Verify: The certificate is verified.

SOAP Header XML:

The optional complete header element of the SOAP message request.

The Header XML must not contain the tag <soapenv:Header>, it is included automatically.

SOAP Body XML:

The complete body element of the SOAP message request. It can be defined instead of the operation parameters if the SOAP operation contains complex/nested parameters that cannot be described in the parameters list as simple key-value pairs. Otherwise, the body element is generated automatically.
Example: (possible also with Operation parameters)
<ns1:getLocators xmlns:ns1=“http://ns.jedox.com/ETL-Server”><ns1:locator>sampleBiker.connections</ns1:locator></ns1:getLocators>
The body XML must not contain the tag <soapenv:Body>, it is included automatically.

Wrap SOAP body
with operation

Option is only relevant if a SOAP body is defined.
If set (default): The operation is translated into a wrapping element including the SOAP operation name.
If not set: The body carries the full information.

Namespaces:

Manual definition of namespaces. To declare a namespace, a prefix has to be defined for the URI of the namespace. 
This is only required if there are several namespaces in use within the SOAP body and not only the one defined in the service port.

Timeout (in s):

The server selection timeout in seconds. Default value 5.

Notes:

  • Common WSDL files specify a single service, but it is also allowed to specify multiple services per WSDL (implemented by different service classes in the backend). Each service has to specify one or more ports defining endpoint addresses and transport protocols used for communication with the service. Each port has a port type (which is explicitly specified or implicitly assumed if there is only one) that defines the set of operations possible for this service/port combination.
  • If the given operation name has a unique match in a port type in the sense that port and service can be non-ambiguously identified by the operation name, Jedox Integrator is able to dynamically resolve port and service if those parameters are not set.
  • SOAP connections use the Apache CXF service framework.
Limitations

Not all SOAP-based web services can be accessed with a Jedox SOAP Connection. The following content types are not supported:

  • .NET-based Webservices in combination with SSL
  • WSDL files with authenticated access are not supported. Public access to the WSDL files is required for a connection.
  •  Application/wsdl+xml

Text/xml content types are supported.

image_pdfimage_print