PSD2 Data Reporting

Enabling Data Reporting

Follow the steps below to enable Data Reporting. 

1. Open  <WSO2_OB_APIM_HOME>/repository/conf/deployment.toml and  <WSO2_OB_IAM_HOME>/repository/conf/deployment.toml  files.
2. Under the [open_banking.bi_server.data_publishing] property set the enable parameter to true to enable the feature. 
3. Update the  server_url  parameter with the hostname of your WSO2 OB BI server .  

[open_banking.bi_server.data_publishing]
enable = true
server_url = "{tcp://ANALYTICS_HOSTNAME:7612}"

[open_banking.bi_server.data_publishing]
sandbox_enable = false

Configuring Open Banking Business Intelligence

1. Configuring databases

   The following databases store raw and summarized data. Make sure they are available in your database servers.

   • openbank_ob_reporting_statsdb

   • openbank_ob_reporting_summarizeddb

2. Configuring datasources
   • Modify the OB_REPORTING_DB and OB_REPORTING_SUMMARIZED_DB datasources in <WSO2_OB_BI_HOME>/conf/worker/deployment.yaml file.
   • Update  jdbcUrl ,  username ,  password  and  driverClassName  in the datasource entries with your database configurations. A sample is given below:

   - name: OB_REPORTING_DB
     description: The datasource used to store statistics for OB Reporting module
     jndiConfig:
       name: jdbc/OB_REPORTING_DB
     definition:
       type: RDBMS
       configuration:
         jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_ob_reporting_statsdb?autoReconnect=true&useSSL=false'
         username: 'root'
         password: 'root'
         driverClassName: 'com.mysql.jdbc.Driver'
         maxPoolSize: 20
         idleTimeout: 60000
         connectionTestQuery: SELECT 1
         # Use below for oracle database
         # connectionTestQuery: SELECT 1 FROM DUAL
         validationTimeout: 30000
         isAutoCommit: false
    
   - name: OB_REPORTING_SUMMARIZED_DB
     description: The datasource used to store statistics for OB Reporting module
     jndiConfig:
       name: jdbc/OB_REPORTING_SUMMARIZED_DB
     definition:
       type: RDBMS
       configuration:
         jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_ob_reporting_summarizeddb?autoReconnect=true&useSSL=false'
         username: 'root'
         password: 'root'
         driverClassName: 'com.mysql.jdbc.Driver'
         maxPoolSize: 20
         idleTimeout: 60000
         connectionTestQuery: SELECT 1
         # Use below for oracle database
         # connectionTestQuery: SELECT 1 FROM DUAL
         validationTimeout: 30000
         isAutoCommit: false

Data Reporting v3.1.2 

Follow the steps below to update to Data Reporting v3.1.2:

1. To capture data from the /token endpoint, configure the Synapse Token API in WSO2 API Manager.
   1. Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/api/_TokenAPI_.xml file.

   2. Add the following property under the <inSequence> tag: 

      <property name="api.ut.backendRequestTime" expression="get-property('SYSTEM_TIME')"/>

   3. Add the APIInvocationLatencyStatsHandler and ReportingDataHandler handlers and place them in the given order under the <handlers> tag: 

      <handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.APIInvocationLatencyStatsHandler"/>
      <handler class="org.wso2.carbon.apimgt.gateway.handlers.ext.APIManagerCacheExtensionHandler"/>
      <handler class="org.wso2.carbon.apimgt.gateway.handlers.common.SynapsePropertiesHandler"/>
      <handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.ReportingDataHandler"/>

2. To capture PSU’s online banking and mobile banking data, update the Adaptive Authentication script as follows:
   
   1. Open the <WSO2_OB_APIM_HOME>/repository/conf/finance/common.auth.script.js file.

   2. Add the following variable at the beginning of the file. Set its value according to the flow you want to capture data. 

      Possible values are: Online Banking, Mobile Banking

      var psuChannel = 'Online Banking';

   3. Add psuChannel as a parameter to the reportingData function as given below. Make sure to update all the reportingData function invocations in the script.

      reportingData(context, "AuthenticationAttempted", false, psuChannel);

Data Reporting v3.1.5 

Follow the steps below to update to Data Reporting v3.1.5:

1. Open the <WSO2_OB_APIM_HOME>/repository/conf/deployment.toml file.

2. Under the [open_banking.bi_server.data_publishing]  tag, add the data_reporting_version = "3.1.5" configuration to enable Data Reporting v3.1.5.

   [open_banking.bi_server.data_publishing]
   data_reporting_version = "3.1.5"
   

3. Open the <WSO2_OB_IAM_HOME>/repository/conf/deployment.toml file and repeat the above step.

4. Copy and replace the Siddhi scripts related to Data Reporting v3.1.5 as follows: 

   Copy from	Copy to
   <WSO2_OB_BI_HOME>/resources/finance/siddhi-files/uk/mi-reporting/3.1.5/	<WSO2_OB_BI_HOME>/deployment/siddhi-files/

5. When upgrading from Data Reporting v3.1.2 to v3.1.5:
   • Go to the <WSO2_OB_BI_HOME>/resources/finance/dbscripts/uk/mi-reporting/migration-mi-3.1.2_to_3.1.5/ob_stats_db directory.
   • Run the relevant database script against the OB_REPORTING_DB database.