Webservice (SOAP) Connector

Note

The Webservice (SOAP) Connector will be deprecated with release 8.0 of the X4 BPMS and will no longer be supported in future releases.

This adapter sends a SOAP Request via HTTP(S) to the URL of a webservice and issues the returned SOAP Response. The adapter communicates with servers via HTTP (Hyper Text Transfer Protocol) or HTTPS (HTTP Secure).

If an authentication is required, the authentication needs to happen SOAP-based via the SOAP Header. The structure of the header (certificate-, token-based, etc.) needs to be clarified with the remote station beforehand. HTTP and NTLM authentication as well as proxy servers are also supported. The HTTP(S) Connector must be used for HTTP authentication.

Note:

The adapter supports SOAP MTOM (Message Transmission Optimization Mechanism), which enables high-performance transfer of large documents or binary data in MTOM-based WebServices via XOP (XML-binary Optimized Packaging).

MTOM processing for requests is only enabled if the adapter input document is of the text/xml or application/xml MIME type.

The MTOM function is controlled by processing instructions, which are added to the SOAP request document to enable MTOM on the input page:

<?useMTOM?>: Enables the MTOM feature for this SOAP request
<?MTOM-xpath 0–n XPath Expressions ?>: Any number of XPath expressions to define the elements that contain binary data
<?MTOM-size in KB ?>: The data size in kilobytes as of which compression is enabled (default: 1 KB)

In addition, the adapter automatically converts MTOM-based SOAP responses that a webservice provides into standard SOAP responses.

Properties

Operation

Describes which operation the adapter performs.

Possible values: Call: Runs the adapter

Parameters

Adapter	Main class of the adapter (do not change!) Possible values: `de.softproject.integration.adapter.httpws.HttpWSAdapter`: Main Class (Standard)
wsURL	URL to which the SOAP request is sent, with the default port `80` Possible values: Any web service URL Different ports must be specified in the URL.
soapAction	HTTP header of the SOAP request. The value of this parameter is a URL that identifies the requested operation.
login	User name for simple HTTP authentication Possible values: Any string
pwd	Password for simple HTTP authentication Possible values: Any string
preemptiveAuth	Enable preemptive authentication (using credentials from the `login` and `pwd` parameters) for all HTTP(S) calls Possible values: `Yes`: Send access data directly (preemptively) with every HTTP(S) call `No`: No preemptive authentication (default)
pxHost	IP address or host name of the IMAP server Possible values: Any valid string (e.g. 192.168.1.1)
pxPort	Port number of the proxy server Possible values: Any integer
pxLogin	User name for the proxy server Possible values: Any string
pxPwd	Password for the proxy server Possible values: Any string
pxNTLMDomain	Windows domain for NTLM authentication via NTLM proxy Possible values: Any domain name
pxNTLMhost	Host (computer name) from which the authentication request originates (for NTLM authentication via NTLM proxy) Possible values: Any hostname
pxUseNTLM	Use the proprietary NTLM authentication by Microsoft for the proxy Possible values: `yes`: Authenticate using NTLM `no`: Do not authenticate using NTLM (default)
nTLMDomain	Windows domain for NTLM server authentication Possible values: Any domain name
nTLMhost	Host (computer name) from which the NTLM server authentication request originates Possible values: Any hostname
useNTLM	Use proprietary NTLM server authentication by Microsoft Possible values: `yes`: Authenticate using NTLM `no`: Do not authenticate using NTLM (default)
timeout	Time limit for establishing a connection in milliseconds Possible values: Any integer `0`) No time limit
keystorePath	Full path to the keystore file; if a keystore is specified, only certificates from that keystore are accepted Possible values: Any path to the keystore file (use certificates from this keystore only) `(No path)`: Accept all certificates
keystorePassword	Password for the keystore file Possible values: Any string

Status values

`1`	The adapter operation was executed successfully
`-1`	The operation failed due to a technical error.

Input

To call a webservice with MTOM, the SOAP request must contain the above-mentioned processing instructions, for example:

HTML/XML

<?useMTOM?>
<?MTOM-xpath soapenv:Envelope/soapenv:Body/ws:signVerifyRequest/ws:Service
  RequestData/ws:Document?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:ws="http://authentidate.de/ws">
  <soapenv:Header />
  <soapenv:Body>
    <ws:signVerifyRequest>
      <ws:ServiceRequestData>
        <ws:Document>JVBiRi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgM
          SAwIFIKL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNC
          AwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggMjEzNT4+CnN0cmV
        </ws:Document>
        <ws:DocumentName>R_1639_37480.pdf</ws:DocumentName>
        <ws:ServiceRequest>SIGN</ws:ServiceRequest>
      </ws:ServiceRequestData>
    </ws:signVerifyRequest>
  </soapenv:Body>
</soapenv:Envelope>

Note:

Multiple processing instructions are always listed as individual ilements in sequence.