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:
Provides reports, statistics and graphs on the APIs deployed in WSO2 Open Banking API Manager. Helps Third-party providers (TPP) to monitor how their applications perform while banks can analyze how the bank APIs perform.
Transaction Risk Analysis
Enables analyzing the risk level based on predefined rules and exempt the user from having to provide the second factor.
For transaction monitoring mechanisms to detect unauthorized or fraudulent transactions and generate alerts. It also exempts the security requirements of strong customer authentication based on the identified level of risk and recurrence of the payment transaction.
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.
It also supports business key performance indicator (KPI) dashboards with business intelligence and insights on usage trends as well as custom business insights on the account and payment flows. The decision makers of banks can use these statistics to align the business to better suit the customer needs and ultimately increase profits. The configurable alerting module enables informing the necessary parties of abnormal behavior, e.g., API failures, a sudden increase in the response time of APIs, and a change in the API resource access pattern.
The placement of the WSO2 OB BI component is as follows:
Before you begin
Download Open Banking Business Intelligence and unzip the file, or add it through WUM using the following commands:
Add the wso2-obbi WUM pack.
Update the wso2-obbi product pack using WUM.
WSO2 Updates Manager (WUM) is deprecated and will be unavailable from July 2021 onwards. WSO2 Updates is the new tool to include the solution and security improvements that are released by WSO2 Open Banking, on top of a released version. For more information, see WSO2 Updates.Click here to see how to update the solution via WSO2 Update tool...
The WSO2 Update tool delivers hotfixes and updates seamlessly on top of products as WSO2 Updates. They include improvements that are released by WSO2. You need to update the product using the relevant script.
<WSO2_OB_BI_HOME>/binand run the WSO2 Update tool:
<WSO2_OB_BI_HOME>/conf/workerdirectory and replace the existing
The WSO2 Open Banking Business Intelligence server uses the
dashboard profiles for the above mentioned features. In a production deployment, the
dashboard profiles should run in two different JVMs. You need to enable the below ports, in order to publish data to these two nodes.
The worker node has a port offset of 1 and it opens the following ports.
| 9444, 8006, 8007 |
|Thrift transport||7612, 7712|
The dashboard node has a port offset of 6 and it opens the following port.
The following is a list of database versions that are compatible with the WSO2 API Manager Analytics.
- MySQL 5.7
- MS SQL Server 2016
- Oracle 12c
To configure the databases, follow the steps below:
The WSO2 Open Banking Business Intelligence will be using the following databases. Make sure you have created them in your database server.
<WSO2_OB_BI_HOME>/conf/worker/deployment.yamlfile. Modify the datasources below by pointing them to the databases you created in the above step.
Update the datasource entry in the
deployment.yamlwith 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:
The database user
Password set for the database connection
The JDBC driver name
Mysql JDBC Driver :
MSSQL JDBC Driver :
Oracle JDBC Driver :
If you are using Oracle, update the
connectionTestQueryin each datasource with the following value.
OB_REPORTING_SUMMARIZED_DBdatasources in the
Use your database configurations and update the datasource properties as follows:
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
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>/bindirectory. Run the command given below to generate the converted file in the
Update Note that keyStorePass: wso2carbon needs to be changed as keyStorePassword: wso2carbon.
Configuring WSO2 OB BI worker
listenerConfigurations in the
<WSO2_OB_BI_HOME>/wso2/worker/conf/transports/netty-transports.yml as follows:
Note that keyStorePass: wso2carbon needs to be changed as keyStorePassword: wso2carbon.
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
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.
Configure the properties under the
If you are using Open Banking Business Intelligence for Analytics, follow the steps below to enable alerts:
- Open the
Update the file as follows:
- See Managing Alerts for more information.
- Open the
- 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.
- Under the
<DataPublishing>sub-element set the <
Enabled>parameter to true to enable the feature.
- Replace the
<WSO2_OB_BI_HOST>placeholder with the hostname of your WSO2 OB BI server and configure the other parameters accordingly.
The Key Manager Extension is upgraded for Data Reporting.
If you have customized the default WSO2 Open Banking Key Manager extension:
- Extend it from the WSO2 Open Banking Keymanger extension.
- Set the authentication steps according to the WSO2 Open Banking Keymanger extension.
For more information see, Customising Key Manager extension.
Enabling Transaction Risk Analysis (TRA)
- Open the
<WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xmlfiles to enable Transaction Risk Analysis (TRA):
- Set the
<TRA>to true to enable the TRA feature.
- Replace the
<WSO2_OB_BI_HOST>place holder with the hostname of Business Intelligence server.
- To enable TRA for:
- payments set the
<PaymentValidationEnabled>property to true
- accounts set the
<AccountValidationEnabled>property to true
- payments set the
The configurations related to TRA Receivers are under the
<Receivers>property. You may use the default WSO2 Open Banking Business Intelligence server username and password. Replace the placeholders in
<TRAPaymentValidationURL>properties to set the Account and Payment validation URLs respectively.
- Set the
Make the following changes to the files given below.
<WSO2_OB_BI_HOST>placeholder in the receiver URL, with the hostname of your WSO2 OB BI server.
Open the <WSO2_OB_BI_HOME>/deployment/siddhi-files/
<WSO2_OB_BI_HOSTNAME>placeholder in the receiver URL, with the hostname of your WSO2 OB BI server.
Enabling Fraud Detection
Open the Set the Replace the Open the Open the Open the username: password: Once you configure the TRA and FD modules, start the servers in the order of: 1. Dashboard profile in WSO2 OB BI 2. Worker profile in WSO2 OB BI 3. WSO2 OB KM 4. WSO2 OB APIM
<WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml files to enable Fraud Detection:
<IsEnabled> property under
<FraudDetection> to true to enable the feature.
<WSO2_OB_BI_HOST> place holder with the hostname of Business Intelligence server.
<WSO2_OB_BI_HOME>/deployment/siddhi-files/FraudStatusUpdaterApp.siddhi file and update
<localhost> in the receiver URL with the hostname of your
WSO2 OB BI server.
<WSO2_OB_BI_HOME>/conf/dashboard/deployment.yaml. Add the
wso2-is-analytics configurations under
analytics.solutions and set as
false. Once you add the configurations, the
deployment.yaml file should be as follows:
<WSO2_OB_BI_HOME>/conf/worker/deployment.yaml file and configure auth.configs:
d3NvMjEyMw== ( Password is
wso2123. Make sure you encode the password with Base64).
Once you configure the TRA and FD modules, start the servers in the order of:
1. Dashboard profile in WSO2 OB BI
2. Worker profile in WSO2 OB BI
3. WSO2 OB KM
4. WSO2 OB APIM
Enabling performance tuning and starting the servers
- You can enable performance tuning by adding configurations, as described in Performance Tuning in the WSO2 Stream Processor documentation.
- Navigate to the
<WSO2_OB_BI_HOME>/bindirectory, and give execution permissions to the dashboard.sh file.
Run the API-M Analytics dashboard.sh as follows:
Navigate to the
<WSO2_OB_BI_HOME>/bindirectory and give execute permissions to the worker.sh file.
Run the following command and start the WSO2 Open Banking Business Intelligence in
Restart the Key Manager and API Manager servers in the mentioned order.
The Fraud Detection dashboards are accessible on
- You can view API analytics data as described below:
To observe data analysis based on geographical locations, see Configuring Geolocation Based Statistics.
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. Click here for more details on Data Reporting.