The Summarisation feature in Data Reporting is supported only for MSSQL database servers.
Configuring Open Banking Key Manager
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.
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.
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
Note
Republish all the APIs for the above changes to take effect.
Multiexcerpt
MultiExcerptName
InvocationFailure
Capturing data during invocation failure scenarios
This is available only as a WUM update and is effective from December 20, 2019 (12-20-2019). For more information on updating WSO2 Open Banking, seeUpdating WSO2 Products.
Go to the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences directory.
Create an XML file named api_invocation_fail_data_publisher.xml with the following content:
xml
Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_throttle_out_handler_.xml file and add the OBErrorDataPublisher class under the sequence tag.
Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_auth_failure_handler_.xml file and add the OBErrorDataPublisher class after the AuthFailureResponseCreationMediator class as follows:
If you can't locate the AuthFailureResponseCreationMediator class in the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/
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:
Code Block
language
xml
- 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
Download the OB_REPORT_SUMMERIZATION_MSSQl.siddhi script from here.
Place the script in the <WSO2_OB_BI_HOME>/deployment/siddhi-files directory.
Restart the WSO2 Open Banking Business Intelligence, Key Manager and API Manager servers in the mentioned order, for the changes to take place.
Noteinfo
title
Fix the issue in calculating the TPP count
This is available only as a WUM update and is effective from April 09, 2021 (04-09-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.
Expand
title
Click here to see how to apply the fix...
Follow the steps below:
Step 1 - Update database
Run the <WSO2_OB_BI_HOME>/resources/finance/dbscripts/uk/migration-publishing-org-id/ob_stats_db.sql file to add the ORG_ID column to the APP_REG_RAW_DATA table.
Migrate your existing data in the APP_REG_RAW_DATA table by adding the correct ORG_IDs of the registered applications.
Step 2 - Enable data publishing
This is to enable publishing TPP's Organization-ID to the APP_REG_RAW_DATA database table.
Open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file.
Enable data publishing by setting the following under the <BIServer> tag, to true.
Open the <WSO2_OB_APIM_HOME>/repository/conf/api-manager.xml file.
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>
Restart WSO2 Open Banking API Manger server.
Replace the existing AppRegistrationDataSubmissionApp.siddhi.
If you allow to TPP application registration using Signup workflows (using the WSO2 API Store), it is mandatory to use a QSeal certificate during the production/sandbox key generation.
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: