You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
The AQ_SoapServiceClient service calls a SOAP webservice.
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).
The following parameters can be set for the service from Blueriq Encore: The persistence parameter indicates whether the system should clean up files at the end of the request (MemoryConnection)/session (FileSystemConnection). All unmapped events will be redirected to the default 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.Parameters
Name Description Type Required Direction Select module soapService Name of SOAP service, with the module where it was defined. Module Element Yes Input Yes operation The name of the operation that needs to be called. String Yes Input No url The URL of the SOAP webservice. String Expression No Input 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 Input No mapping Name of the data mapping to use, if a separate module is used for the WSDL. Data mapping No BiDirectional No username Username to access the service. String No Input No password Password to access the service. String No Input No soapFault The type of the instance that should be updated when a soap fault occurs. Entity Yes Output No soapFaultCode The attribute of the instance which should be updated with the soap fault code when a soap fault occurs. Attribute Yes Output No soapFaultMessage The attribute of the instance which should be updated with the soap fault message when a soap fault occurs. Attribute Yes Output 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 Output 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 Output No connection Connection to retrieve/store documents from/on. String No BiDirectional No fileList The file(s) which will be attached and send. Multivalued Entity Expression No Input No fileRelation The relation to hold returned files. Relation No Output No persistence Temporary / Permanent No Input No caseId The CaseId of the case the received documents belong to. String Expression No Output No file The type of the instance that should be updated when a file is received. Entity No Output No fileId The attribute of the instance which should be updated with the file id when a file is received. Attribute No Output No fileContentId The attribute of the instance which should be updated with the file content id when a file is received. Attribute No Output No fileName The attribute of the instance which should be updated with the file name when a file is received. Attribute No Output No fileType The attribute of the instance which should be updated with the file type when a file is received. Attribute No Output No fileSize The attribute of the instance which should be updated with the file size when a file is received. Attribute No Output No fileCreatedBy The attribute of the instance which should be updated with the file created by attribute when a file is received. Attribute No Output No fileCreationDate The attribute of the instance which should be updated with the file creation date when a file is received. Attribute No Output No Exit 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 default exit event Continue
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 |
How the URL is determined
- if the
connectionOverrideparameter 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
urlparameter is defined, the value resulting from evaluating theurlexpression is used - otherwise, the URL in the WSDL is used
Related articles
Overview
Content Tools