Page Comparison

Open the <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml file and add the following configurations below the </Analytics> tag. 

• Replace the <WSO2_OB_BI_HOST> placeholder with the hostname of your WSO2 Open Banking Business Intelligence (WSO2 OB BI) server and configure other parameters accordingly. 
• To publish the statistics set the value of the <Enabled> tag to true.

<BIServer>
	<MIReporting>
		<Enabled>true</Enabled>
		<ServerURL>{tcp://<WSO2_OB_BI_HOST>:7616}</ServerURL>
		<Username>admin</Username>
		<Password>admin</Password>
	</MIReporting>
</BIServer>

Configuring Open Banking API Manager

Configuring open-banking.xml

Open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file and add the following configurations below the </Analytics> tag. 

• Replace the <WSO2_OB_BI_HOST> placeholder with the hostname of your WSO2 Open Banking Business Intelligence (WSO2 OB BI) server and configure other parameters accordingly. 
• To publish the statistics set the value of the <Enabled> tag to true.

<BIServer>
	<MIReporting>
		<Enabled>true</Enabled>
		<ServerURL>{tcp://<WSO2_OB_BI_HOST>:7616}</ServerURL>
		<Username>admin</Username>
		<Password>admin</Password>
	</MIReporting>
</BIServer>

Configuring handlers

Open the <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml file and do the following:

1. Add the APIInvocationLatencyStats handler just after the <handlers xmlns="http://ws.apache.org/ns/synapse"> tag.

   Code Block
   language xml
   <handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.APIInvocationLatencyStatsHandler"/>

2. Add the APIInvocationDataPublisher handler as the last ob-specific handler, right before the ## end of ob-specific handlers before the APIManagerExtensionHandler line. 

   Code Block
   <handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.APIInvocationDataPublisher" /> ## end of ob-specific handlers before the APIManagerExtensionHandler

Configuring Open Banking Business Intelligence

Configuring databases

Create the following databases in your database server to store raw and summarized data.

• openbank_ob_reporting_statsdb
• openbank_ob_reporting_summarizeddb

Configuring datasources

Update the <WSO2_OB_BI_HOME>/conf/worker/deployment.yaml file by adding the datasource configurations for OB_REPORTING_DB and OB_REPORTING_SUMMARIZED_DB. 

• Update the jdbcUrl, username, password and driverClassName in the datasource entry with your database configurations.
• Add the configurations after the TRA_DB datasource configurations.
  A sample configuration is given below:

- name: OB_REPORTING_DB
    description: The datasource used to store statistics for OB MI module
    jndiConfig:
      name: jdbc/OB_REPORTING_DB
    definition:
      type: RDBMS
      configuration:
        jdbcUrl: 'jdbc:sqlserver://192.168.108.23:1433;databaseName=openbank_ob_reporting_statsdb'
        username: 'root'
        password: 'root'
        driverClassName: 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
        maxPoolSize: 20
        idleTimeout: 60000
        connectionTestQuery: SELECT 1
        validationTimeout: 30000
        isAutoCommit: false

  - name: OB_REPORTING_SUMMARIZED_DB
    description: The datasource used to store summarized data for OB MI module
    jndiConfig:
      name: jdbc/OB_REPORTING_SUMMARIZED_DB
    definition:
      type: RDBMS
      configuration:
        jdbcUrl: 'jdbc:sqlserver://192.168.108.23:1433;databaseName=openbank_ob_reporting_summarizeddb'
        username: 'root'
        password: 'root'
        driverClassName: 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
        maxPoolSize: 20
        idleTimeout: 60000
        connectionTestQuery: SELECT 1
        validationTimeout: 30000
        isAutoCommit: false

Adding summarization script

1. Download the OB_REPORT_SUMMERIZATION_MSSQl.siddhi script from here.

2. Place the script in the <WSO2_OB_BI_HOME>/deployment/siddhi-files directory.

   Note

   The Siddhi script linked in step 1 is updated in the latest WUM updated solution. If your setup contains WUM updates released on or after April 07, 2021 (04-07-2021), follow the steps below to use the updated Siddhi scripts. Expand title Click here to see how to use the updated Siddhi scripts... Run the relevant database script in the <WSO2_OB_BI_HOME>/resources/finance/dbscripts/uk/migration-publishing-org-id/ob_stats_db directory to add the ORG_ID column to the APP_REG_RAW_DATA table. Open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file and enable data publishing. Set the following configuration under the <BIServer> tag, to true.  Code Block language xml <DataPublishing> <PublishOrganizationID>true</PublishOrganizationID> </DataPublishing> Open the <WSO2_OB_APIM_HOME>/repository/conf/api-manager.xml file and under the <ApplicationAttributes> tag, add the following configurations:  Code Block language xml <Attribute required="false"> <Name>org_id_production</Name> <Description>Organization ID of the Production</Description> </Attribute> <Attribute required="false"> <Name>org_id_sandbox</Name> <Description>Organization ID of the Production</Description> </Attribute> Update the Siddhi scripts for raw-data tables.  Copy the scripts in the <WSO2_OB_BI_HOME>/resources/finance/siddhi-files/uk directory. Paste them in the <WSO2_OB_BI_HOME>/deployment/siddhi-files directory and replace the existing scripts. Update the Siddhi scripts for summatization-data tables. Copy <WSO2_OB_BI_HOME>/resources/finance/siddhi-files/uk/mi-reporting/3.0/OB_REPORT_SUMMERIZATION_MSSQl.siddhi. Paste it in the <WSO2_OB_BI_HOME>/deployment/siddhi-files/ directory and replace the existing OB_REPORT_SUMMERIZATION_MSSQl.siddhi script.

Restart the WSO2 Open Banking Business Intelligence, Key Manager and API Manager servers in the mentioned order, for the changes to take place.

Data Reporting API

If you're using a customised consent authentication web application, you may use the Data Reporting API to publish events from the application. Invoke the Data Reporting API in all the relevant places to publish the PSU and authorisation data to the reporting databases.

In the following scenarios, events are captured using the consent authorisation web app:

• The user visiting the consent page
• After the user authorising/denying the consent

For sample requests, see Data Reporting API.