The AQ_SoapServiceClient service service calls a SOAP webservice. It is similar to the AQ_WebServiceClient, but it handles only SOAP requests.
AQ_SoapServiceClient leverages on spring-ws WebServiceTemplate which has the possibility to add additional security interceptors (http://docs.spring.io/spring-ws/site/reference/html/security.html).
| Expand |
|---|
|
The features of the AQ_SoapServiceclient are listed below: - Basic authentication
- Timeout setting
- UsernameToken Profile V1.0
- X.509 Token Profile V1.0
- Signing
- Timestamp
- Encryption
- Logging request / response
- Exception handling for socket timeout
- Exception handling for SoapFault
- Map SoapFault to profile
- Sending and receiving attachments
- Dynamic urls
|
| Excerpt |
|---|
ParametersThe following parameters can be set for the service from Blueriq Encore: | Name | Description | Type | Required | Direction | Select module |
|---|
| soapService | Name of SOAP service, with the module where it was defined. | Module Element |
|
...
...
| Yes | | operation | The name of the operation that needs to be called. | String |
|
...
...
| No | | url | The URL of the SOAP webservice. | String Expression |
|
...
...
| No | | connectionOverride | Override the name of the used connection configuration from application.properties. This parameter may be used to share a configuration among multiple AQ_SoapServiceClient calls. | String Expression |
|
...
...
| No | | mapping | Name of the data mapping to use, if a separate module is used for the WSDL. | Data mapping |
|
...
...
| No | | username | Username to access the service. | String |
|
...
...
| No | | password | Password to access the service. | String |
|
...
...
| No | | soapFault | The type of the instance that should be updated when a soap fault occurs. | Entity |
|
...
...
| No | | soapFaultCode | The attribute of the instance which should be updated with the soap fault code when a soap fault occurs. | Attribute |
|
...
...
| No | | soapFaultMessage | The attribute of the instance which should be updated with the soap fault message when a soap fault occurs. | Attribute |
|
...
...
| No | | SoapFaultRole | The attribute of the instance which should be updated with the soap fault roles object (SOAP 1.2), or the actor object (SOAP 1.1). | Attribute |
|
...
...
| No | | SoapFaultDetails | The attribute of the instance which should be updated with the soap fault roles details object, this could either contain a text value or an xml message, which will be stored as text in the given attribute | Attribute |
|
...
...
| No | | connection | Connection to retrieve/store documents from/on. | String |
|
...
...
| No | | fileList | The file(s) which will be attached and send. | Multivalued Entity Expression |
|
...
...
| No | | fileRelation | The relation to hold returned files. | Relation |
|
...
...
| No | | persistence | The persistence parameter indicates whether the system should clean up files at the end of the request (MemoryConnection)/session (FileSystemConnection). | Temporary / Permanent |
|
...
...
| No | | caseId | The CaseId of the case the received documents belong to. | String Expression |
|
...
...
| No | | file | The type of the instance that should be updated when a file is received. | Entity |
|
...
...
| No | | fileId | The attribute of the instance which should be updated with the file id when a file is received. | Attribute |
|
...
...
| No | | fileContentId | The attribute of the instance which should be updated with the file content id when a file is received. | Attribute |
|
...
...
| No | | fileName | The attribute of the instance which should be updated with the file name when a file is received. | Attribute |
|
...
...
| No | | fileType | The attribute of the instance which should be updated with the file type when a file is received. | Attribute |
|
...
...
| No | | fileSize | The attribute of the instance which should be updated with the file size when a file is received. | Attribute |
|
...
...
| No | | fileCreatedBy | The attribute of the instance which should be updated with the file created by attribute when a file is received. | Attribute |
|
...
...
| No | | fileCreationDate | The attribute of the instance which should be updated with the file creation date when a file is received. | Attribute |
|
...
...
| Info |
|---|
| title | Behaviour default exit nodeExit events| Name | Description | Type |
|---|
| Ok | When the SOAP request is executed successfully. | Continue | | Timeout | When the SOAP request returns a timeout exception. | Continue | | SoapFault | When the SOAP request returns a SOAP fault exception. | Continue | | Error | When the SOAP request returns other errors. | Cancel |
|
|---|
| Info |
|---|
|
Make sure to map these events and connect them in your flowing when migrating from AQ_Webserviceclient. Otherwise a timeout will trigger the default exit, not the exception exit. |
The exit events can be found at the top right corner of the service call:
Image Removed
| default exit event | All unmapped events will be redirected to |
exit node of the service call, even errors. Therefore it is recommended to always map all possible expected exit events. When all expected events are mapped, the default exit node will be removed from the service call as exit event. |
|
Note on persistence
...
...
Configuration in application.properties
The default SOAP security properties can be defined using the following properties:
| Name | Description | Type |
|---|
| blueriq.security.keystore.location | The path to the keystore file. The keys in the keystore will be used for signing and/or encrypting soap messages. | String |
| blueriq.security.keystore.password | The password for the keystore file. | String |
| blueriq.security.truststore.location | The path to the trust store containing the public keys/certificates of external hosts that should be trusted |
|
| blueriq.security.truststore.password | The password for the truststore file. |
|
Soap connection properties:
| Name | Description | Type |
|---|
| blueriq.connection.[serviceName].soap.url | The URL of the SOAP web service. | String |
| blueriq.connection.[serviceName].soap.username | The username for basic authentication. | String |
| blueriq.connection.[serviceName].soap.password | The password for basic authentication. | String |
| blueriq.connection.[serviceName].soap.interceptors | A comma separated list of security interceptors (defined using the blueriq.soap.interceptors.security.* properties, please see the WS-Security documentation) | String[] |
| blueriq.connection.[serviceName].soap.timeout | The timeout in milliseconds. | Integer |
| blueriq.connection.[serviceName].soap.client-certificate-alias-name | Uses the certificate that is defined by the alias name from the configured keystore(check security properties on how to specify the keystore). | String |
| Info |
|---|
|
When migrating from the AQ_webserviceClient to the AQ_SoapserviceClient, you might run into an error. "IllegalStateException: Security type for service name is null. Did you forgot to add this to the properties file? " In your application.properties there's still a line that refers to the old webservice client. Search for: webservice.soap.security.implementations= This line should be removed from your properties file. That should solve the problem. |
How the URL is determined
- if the
connectionOverride parameter is defined, the settings of that connection are used - if a connection with the same name as the service call is defined, the settings of that connection are used
- if the
url parameter is defined, the value resulting from evaluating the url expression is used - otherwise, the URL in the WSDL is used
Related articles
| Content by Label |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| spaces | DOC |
|---|
| showSpace | false |
|---|
| sort | modified |
|---|
| reverse | true |
|---|
| type | page |
|---|
| cql | label = "soapserviceclient" and type = "page" and space = "DOC" |
|---|
| labels | DCM handleiding installatie foundation |
|---|
|
...
...