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 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

Parameters

The following parameters can be set for the service from Blueriq Encore:

NameDescriptionTypeRequiredDirectionSelect module
soapServiceName of SOAP service, with the module where it was defined.Module ElementYesInputYes
operationThe name of the operation that needs to be called.StringYesInputNo
urlThe URL of the SOAP webservice.String ExpressionNoInputNo
connectionOverrideOverride 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 ExpressionNoInputNo
mappingName of the data mapping to use, if a separate module is used for the WSDL.Data mappingNoBiDirectionalNo
usernameUsername to access the service.StringNoInputNo
passwordPassword to access the service.StringNoInputNo
soapFaultThe type of the instance that should be updated when a soap fault occurs.EntityYesOutputNo
soapFaultCodeThe attribute of the instance which should be updated with the soap fault code when a soap fault occurs.AttributeYesOutputNo
soapFaultMessageThe attribute of the instance which should be updated with the soap fault message when a soap fault occurs.AttributeYesOutputNo
SoapFaultRoleThe attribute of the instance which should be updated with the soap fault roles object (SOAP 1.2), or the actor object (SOAP 1.1).AttributeNoOutputNo
SoapFaultDetailsThe 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 attributeAttributeNoOutputNo
connectionConnection to retrieve/store documents from/on.StringNoBiDirectionalNo
fileListThe file(s) which will be attached and send.Multivalued Entity ExpressionNoInputNo
fileRelationThe relation to hold returned files.RelationNoOutputNo
persistence

The persistence parameter indicates whether the system should clean up files at the end of the request (MemoryConnection)/session (FileSystemConnection).

Temporary / PermanentNoInputNo
caseIdThe CaseId of the case the received documents belong to.String ExpressionNoOutputNo
fileThe type of the instance that should be updated when a file is received.EntityNoOutputNo
fileIdThe attribute of the instance which should be updated with the file id when a file is received.AttributeNoOutputNo
fileContentIdThe attribute of the instance which should be updated with the file content id when a file is received.AttributeNoOutputNo
fileNameThe attribute of the instance which should be updated with the file name when a file is received.AttributeNoOutputNo
fileTypeThe attribute of the instance which should be updated with the file type when a file is received.AttributeNoOutputNo
fileSizeThe attribute of the instance which should be updated with the file size when a file is received.AttributeNoOutputNo
fileCreatedByThe attribute of the instance which should be updated with the file created by attribute when a file is received.AttributeNoOutputNo
fileCreationDateThe attribute of the instance which should be updated with the file creation date when a file is received.AttributeNoOutputNo

Exit events

NameDescriptionType
OkWhen 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
ErrorWhen the SOAP request returns other errors.Cancel
default exit event

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.

Continue

Configuration in application.properties

The default SOAP security properties can be defined using the following properties:

NameDescriptionType
blueriq.security.keystore.locationThe path to the keystore file. The keys in the keystore will be used for signing and/or encrypting soap messages.String
blueriq.security.keystore.passwordThe password for the keystore file.String
blueriq.security.truststore.locationThe path to the trust store containing the public keys/certificates of external hosts that should be trusted
blueriq.security.truststore.passwordThe password for the truststore file.

Soap connection properties:

NameDescriptionType
blueriq.connection.[serviceName].soap.urlThe URL of the SOAP web service.String
blueriq.connection.[serviceName].soap.usernameThe username for basic authentication.String
blueriq.connection.[serviceName].soap.passwordThe password for basic authentication.String
blueriq.connection.[serviceName].soap.interceptorsA 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.timeoutThe timeout in milliseconds.Integer
blueriq.connection.[serviceName].soap.client-certificate-alias-nameUses 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

  1. if the connectionOverride parameter is defined, the settings of that connection are used
  2. if a connection with the same name as the service call is defined, the settings of that connection are used
  3. if the url parameter is defined, the value resulting from evaluating the url expression is used
  4. otherwise, the URL in the WSDL is used

Related articles