You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

What is it for?

AQ_Report is used for exporting a profile and storing it in a database.

The AQ_Report service can be used to export part of profile. The profile is exported as XML and is stored in a connection. The export contains all profile values, including system- and user-set values and the entities system  and user

One of the main use cases for this service is to export data using a data mapping from the main application module to a reporting module (both actually Interaction modules) and store this export in a database. An external system can pick up this export, for instance for a data warehouse. Best practices and design considerations with regard to the reporting and sharing of data with other systems can be found in this design guide.


Parameters

Name
Direction
Description
Type
Occurrences
Required
ConnectionInputSelect the connection on which to place the XML exportConnectionSingle valuedYes
DataMappingInput

Select the data mapping for which the target will be exported (when omitted, the current module will be exported)

Module element DataMappingSingle valuedNo


Exporting

In runtime, the XML profile is exported to the connection, where it is stored as an XML blob in a table called Reports. This table has the following columns:

Column
Type
Description
IdIntegerUnique Id of the export
Source_applicationStringId of the application where the service was performed (Repository-Branch-Project)
Source_serviceStringName of the service that was performed
Creation_datetimeDatetimeExact moment when the service was performed
User_nameStringUser that was logged in when the service was performed
Export_XMLXML BlobThe actual XML

 

Events

This service uses default events for a commit and for an exception. 

 

Trace and log

The trace database does not trace the exported data. However, the log file states when the services was called and which datamapping was used.

 

Configuration

The AQ_Report makes use of the Report SQL Store component. Configuration of this component can be found here, this page also describes how to set up the connection that the service requires.


Reporting


Please see also: