Enabling Analytics

According to the CDS Specification, it is mandated for the Data Holders to enable Analytics. By enabling Analytics, CDR Register invokes the metrics endpoint to get information about the performance and availability metrics.

This document describes how you can enable analytics using WSO2 Open Banking Business Intelligence.

The WSO2 Open Banking Business Intelligence(WSO2 OB BI) component enables monitoring and recording of API-level usage activity to ensure that the API owners have full awareness of the APIs, applications, and subscriptions. It generates alerts by analyzing the risk involved in transactions and fraudulent activities. It also generates statistics using the data collected from WSO2 Open Banking Key Manager and API Manager. WSO2 Open Banking Business Intelligence contains the following features: 

API Analytics

Provides reports, statistics and graphs on the APIs deployed in WSO2 Open Banking API Manager. Helps the CDR Register to monitor how the banking APIs perform.

Data Reporting

The WSO2 Open Banking Business Intelligence captures data published in WSO2 Open Banking API Manager and WSO2 Open Banking Key Manager. Data Reporting is the process of processing and summarizing these data. 

The placement of the WSO2 OB BI component is as follows:

Configuring databases

1. If you are using MSSQL or Oracle, create the following databases:

   If you are using a mysql database environment, the databases are created automatically when you execute the following commands:

   • ./configure-km.sh in <WSO2_OB_KM_HOME>/repository/resources/finance/scripts
   • ./configure-am.sh in <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts

   • openbank_apimgt_statsdb 

   • openbank_openbankingdb 

   • openbank_geolocationdb

   • openbank_ob_reporting_statsdb


   • openbank_ob_reporting_summarizeddb


2. Update the  <WSO2_OB_BI_HOME>/conf/worker/deployment.yaml  file. Modify the datasources below by pointing them to the databases you created in the above step. 

   • APIM_ANALYTICS_DB

   • OPEN_BANKING_DB


   • GEO_LOCATION_DATA

   • OB_REPORTING_DB  

   • OB_REPORTING_SUMMARIZED_DB

   Update the datasource entry in the deployment.yaml with your database configurations.

   Property	Description
   jdbcUrl	This is the port to connect to on database server The jdbcUrl property expects the JDBC driver connection string. A sample jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_ob_reporting_summarizeddb?autoReconnect=true&useSSL=false'
   username	The database user
   password	Password set for the database connection
   driverClassName	The JDBC driver name Mysql JDBC Driver : com.mysql.jdbc.Driver MSSQL JDBC Driver : com.microsoft.sqlserver.jdbc.SQLServerDriver Oracle JDBC Driver : oracle.jdbc.driver.OracleDriver

   If you are using Oracle, update the connectionTestQuery in each datasource with the following value.

   connectionTestQuery: SELECT 1 FROM DUAL

       - name: GEO_LOCATION_DATA
         description: "The data source used for geo location database"
         jndiConfig:
           name: jdbc/GEO_LOCATION_DATA
         definition:
           type: RDBMS
           configuration:
             jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_geolocationdb?autoReconnect=true&useSSL=false'
             username: root
             password: root
             driverClassName: com.mysql.jdbc.Driver
             maxPoolSize: 50
             idleTimeout: 60000
             connectionTestQuery: SELECT 1
             # Use below for oracle database
             # connectionTestQuery: SELECT 1 FROM DUAL
             validationTimeout: 30000
             isAutoCommit: false
   
       - name: APIM_ANALYTICS_DB
         description: "The datasource used for APIM statistics aggregated data."
         jndiConfig:
           name: jdbc/APIM_ANALYTICS_DB
         definition:
           type: RDBMS
           configuration:
             jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_apimgt_statsdb?autoReconnect=true&useSSL=false'
             username: root
             password: root
             driverClassName: com.mysql.jdbc.Driver
             maxPoolSize: 50
             idleTimeout: 60000
             connectionTestQuery: SELECT 1
             validationTimeout: 30000
             isAutoCommit: false
   
       - name: OPEN_BANKING_DB
         description: "The datasource used to store payment consents"
         jndiConfig:
           name: jdbc/OPEN_BANKING_DB
         definition:
           type: RDBMS
           configuration:
             jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_openbankingdb?autoReconnect=true&useSSL=false'
             username: root
             password: root
             driverClassName: com.mysql.jdbc.Driver 
             maxPoolSize: 50
             idleTimeout: 60000
             connectionTestQuery: SELECT 1
             validationTimeout: 30000
             isAutoCommit: false
   
       - 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
             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
             validationTimeout: 30000
             isAutoCommit: false       

3. Modify the datasources of OB_REPORTING_DB  in the <WSO2_OB_BI_HOME>/conf/dashboard/deployment.yaml file.                                                          

   Use your database configurations and update the datasource properties as follows: 

       - 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

   You need to follow the steps below when you are using Oracle or MS SQL database servers.

   You need to include the database driver corresponding to the database for the WSO2 Open Banking Business Intelligence server to communicate with the database. The WSO2 Open Banking Business Intelligence is an OSGi-based product. Therefore, when you integrate third party products such as Oracle and MS SQL with WSO2 OB BI, you need to check whether the libraries you need to add are OSGi based. If they are not, you need to convert them to OSGi bundles before adding them to the <WSO2_OB_BI_HOME>/lib directory.

   To convert the jar files to OSGi bundles, follow the steps below.

   1. Download the non-OSGi jar for the required third party product, and save it in a preferred directory in your machine.

   2. Go to the <WSO2_OB_BI_HOME>/bin directory. Run the command given below to generate the converted file in the <WSO2_OB_BI_HOME>/lib directory.

   ./jartobundle.sh <PATH_TO_NON-OSGi_JAR> ../lib

Configuring WSO2 OB BI worker 

Update listenerConfigurations in the <WSO2_OB_BI_HOME>/wso2/worker/conf/transports/netty-transports.yml as follows:

listenerConfigurations:
 -
  id: "default"
  host: "0.0.0.0"
  port: 9090
  messageProcessorId: "MSF4J-CM-PROCESSOR"

 -
  id: "https"
  host: "0.0.0.0"
  port: 9443
  scheme: https
  keyStoreFile: ${carbon.home}/resources/security/wso2carbon.jks
  keyStorePassword: wso2carbon
  certPass: wso2carbon
  messageProcessorId: "MSF4J-CM-PROCESSOR"

Configuring keystores

In the SSL handshake between the Open Banking API Manager and Open Banking Business Intelligence servers, the client (i.e. Open Banking API Manager) needs to verify the certificate presented by the server (i.e. Open Banking Business Intelligence). For this purpose, the client stores the trusted certificate of the server in the client-truststore.jks keystore.

If you use a custom keystore in Open Banking API Manager and/or Open Banking Business Intelligence, import the public key certificate of Open Banking Business Intelligence into the client-truststore.jks file of the Open Banking API Manager. To export the public key from the server and import it into the client's trust store, follow the steps given in Adding CA-signed certificates to keystores in the Administration Guide.

Enabling data publishing in API Manager

Follow the instructions below to configure the WSO2 Open Banking API Manager to publish statistics. 

1. Open the <WSO2_OB_APIM_HOME>/repository/conf/api-manager.xml file

2. Configure the properties under the <Analytics> sub element.

   <Analytics>
           <!-- Enable Analytics for API Manager -->
           <Enabled>true</Enabled>
    
           <!-- Server URL of the remote StreamProcessor server used to collect statistics. Must
               be specified in protocol://hostname:port/ format.
    
               An event can also be published to multiple Receiver Groups each having 1 or more receivers. Receiver
               Groups are delimited by curly braces whereas receivers are delimited by commas.
               Ex - Multiple Receivers within a single group
               tcp://localhost:7612/,tcp://localhost:7613/,tcp://localhost:7614/
    
               Ex - Multiple Receiver Groups with two receivers each
               {tcp://localhost:7612/,tcp://localhost:7613},{tcp://localhost:7712/,tcp://localhost:7713/} -->
           <StreamProcessorServerURL>{tcp://<WSO2_OB_BI_HOST>:7612}</StreamProcessorServerURL>
   </Analytics>

   Enable alerts:

   If you are using Open Banking Business Intelligence for Analytics, follow the steps below to enable alerts:

   • Open the <WSO2_OB_BI_HOME>/conf/worker/deployment.yaml file.

   • Update the file as follows: 

     analytics.solutions:
       APIM-alerts.enabled: true 
       APIM-analytics.enabled: true

   • See Managing Alerts for more information.
3. Save the changes and restart the WSO2 Open Banking API Manager server.

Enabling Open Banking Data Publishing

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>

   This step is required only if you're setting up Open Banking for AU:

   1. Go to the <WSO2_OB_BI_HOME>/resources/finance/cds-siddhi-files directory.
   2. Copy and paste the following to the <WSO2_OB_BI_HOME>/deployment/siddhi-files directory.
      1. CDSInvocationMetricsApp.siddhi
      2. CDSSessionMetricsApp.siddhi

Invoking Data Reporting API

Using the Data Reporting API, the Data Holders can retrieve statistics on API invocation data for a requested period. These statistics are required for regulatory reporting. 

1. Deploying the GetInvocationDataApp Siddhi App:
   1. Download the GetInvocationDataApp.siddhi script from here.
   2. Place the script in the <WSO2_OB_BI_HOME>/deployment/siddhi-files directory.
   3. Restart the WSO2 Open Banking Business Intelligence, Key Manager and API Manager servers in the mentioned order, for the changes to take place.
2. Invoking the API:
   
   • Set the date range by changing the values in the fromDate and toDate parameters in the request.
   • Given below is a sample request and response.