PSD2 Data Reporting

Enabling Data Reporting

Follow the steps below to enable Data Reporting. 

1. Open  <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml and  <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml  files.
2. Under the <DataPublishing> sub-element set the <Enabled> parameter to true to enable the feature. 
3. Replace the <WSO2_OB_BI_HOST> placeholder with the hostname of your WSO2 OB BI server and configure the other parameters accordingly.  

<BIServer>
   <DataPublishing>
      <!-- Include all configurations related to Data publishing -->
      <!-- Enable data publishing in WSO2 Open Banking-->
      <Enabled>true</Enabled>
      <!-- Server URL of the remote BI server used to collect statistics. Must
            be specified in protocol://hostname:port/ format. -->
      <ServerURL>{tcp://<WSO2_OB_BI_HOST>:7612}</ServerURL>
      <!-- Administrator username to login to the BI server for data publishing. -->
      <Username>admin@wso2.com@carbon.super</Username>
      <!-- Administrator password to login to the BI server for data publishing. -->
      <Password>wso2123</Password>
   </DataPublishing>
</BIServer>

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.mtls.validator.handler.GatewayClientAuthenticationHandler"/>
      <handler class="com.wso2.finance.open.banking.common.identity.validation.SignatureAlgorithmValidatorHandler"/>
      <handler class="com.wso2.finance.open.banking.mtls.validator.handler.MTLSValidationHandler"/>
      <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 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.

Capturing data during invocation failure scenarios

1. Go to the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences directory.

2. Create an XML file named api_invocation_fail_data_publisher.xml with the following content: 

   <sequence name="_api_invocation_fail_data_publisher_"
   	xmlns="http://ws.apache.org/ns/synapse">
   	<property name="error_message_type" value="application/xml"/>
   	<class name="com.wso2.finance.open.banking.management.information.reporting.data.publisher.OBErrorDataPublisher"/>
   </sequence>

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

   <class name="com.wso2.finance.open.banking.management.information.reporting.data.publisher.OBErrorDataPublisher"/>

4. Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_auth_failure_handler_.xml file and add the OBErrorDataPublisher  class below the sequence key element as shown below: 

   <sequence key="_cors_request_handler_"/>
   <class name="com.wso2.finance.open.banking.management.information.reporting.data.publisher.OBErrorDataPublisher"/>