Access level: read
The SOAP connection allows Jedox Integrator to connect to web services which apply to the SOAP protocol (Simple Object Access Protocol).
Connection 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/blaThen the URL for the web service definition is http://webservice.example:1234/bla?WSDLThe WSDL file can also be stored in the Jedox cloud environment in the directory etl_data, as described in SFTP Connections to Jedox. In that case only the relative path has to be specified e.g. myService.wsdl or myFolder/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. |
| 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 |
In most cases this option is not required. See note (*) below |
| Service port | In most cases this option is not required. See note (*) below. |
| Action URI | 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 | verify: the certificate is verified.
trust: the certificate is imported to the keystore, if not yet available. off: no SSL is used. |
| 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. |
| Skip default namespace | If checked, this option can prevent errors due to default namespace. Default is NOT checked. |
| 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 timeout for connecting to the database. The timeout value is in seconds (default is 1200 seconds). |
| Ignore policies | If checked, this option can prevent errors due to non-standard policies. Default is NOT checked. |
Other features
Common WSDL files specify a single service, but multiple services can also be specified 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.
SOAP connections use the Apache CXF service framework.
As authentication method, the SOAP connection supports HTTP Basic Authentication defined by username and password fields.
(*) 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.
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.
Updated September 27, 2024