WSO2 Open Banking now supports the Consumer Data Standard (CDS). This document guides you through the configurations and troubleshooting that you need to set up the solution in your local environment.
...
Tip
Download Oracle JDK 1.8 in all the nodes of the setup.
In the environment variables, update the JAVA_HOME and PATH variables. For instance, you can do this on a Mac/Linux server by adding the following to the ~/.bashrc file:
wso2-obam-1.4.0.zip (WSO2 Open Banking API Manager)
wso2-obkm-1.4.0.zip(WSO2 Open Banking Key Manager)
Expand
title
Click here to see how to download the packs from WUM
Multiexcerpt include
MultiExcerptName
WUM_Instructions
PageWithExcerpt
Setting Up Servers
Warning
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.
Expand
title
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 all the products using the relevant script.
Go to <PRODUCT_HOME>/bin and run the WSO2 Update tool:
Localtabgroup
Localtab
title
On Linux
Code Block
./wso2update_linux
Localtab
title
On Mac
Code Block
./wso2update_darwin
Localtab
title
On Windows
Code Block
./wso2update_windows.exe
Repeat this step for both the wso2-obkm-1.4.0 and wso2-obam-1.4.0 products.
Setup a database server using MySQL 5.7+, Microsoft SQL Server 2016 + or, Oracle 12c.
Setting up the databases
Multiexcerpt
MultiExcerptName
settingupDatabase
To start the servers, configure the databases in both the API Manager (WSO2 OB APIM) and the Key Manager (WSO2 OB KM) according to the open banking specification, as follows:
step1
Open the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts/startup.properties file and configure the following:
Specify the hostnames for the APIM and KM servers.
xml
Configure the databases related properties.
Database Property
Description
DB_TYPE
Type of the database you installed
DB_USER
Database user
DB_PASS
Password set for the database connection
DB_HOST
Name of the database server
DB_DRIVER
Configure DB_DRIVER according to the database installed:
If you are using MSSQL or Oracle, create the following databases before executing the configure-km.sh file.
openbank_am_configdb
openbank_apimgt_statsdb
openbank_apimgtdb
openbank_openbankingdb
openbank_govdb
openbank_iskm_configdb
openbank_mbstoredb
openbank_userdb
Go to the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts directory and execute the following command:
Go to the <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts directory and configure the database properties in the startup.properties file, similar to .
Go to the <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts directory and execute the following command:
You have configured the databases in . By running the configure.sh files, you set the database credentials with reference to the configuration files.
Setting up the servers
Configure the open-banking specification to deploy the solution according to the AU specification.
The <DeployedSpecification> configuration is used to define the deployed specification at runtime. In the following files, update the <DeployedSpecification> value as AU.
<WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml xml
Configure the authentication web app.
Update the <WSO2_OB_KM_HOME>/repository/conf/identity/application-authentication.xml file with the following configurations:
xmlxml
Update the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file with the following configurations:
xmlxmlxmlxml
Configure the IDTokenBuilder in the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file as follows:
xml
According to CDS, an Access Token must expire between 2 minutes to 10 minutes after the Data Holder issues it. To configure the validity period of the Access Token in seconds, update the following configurations in the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file.
xml
To enable Request-URI validation, open the <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml file and add the following configurations under the <UK> tag:
xml
By default, Enforcement caching is enabled in the solution. To customize them, open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file and add the following under the <Server> tag:
xml
Add the following ConsentEnforcement handler configurations to the <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml file, below the
You are now ready to start the Key Manager and API Manager servers. To start the WSO2 OB KM server, go to the <WSO2_OB_KM_HOME>/bin directory and execute the following command:
Run the following command from the <WSO2_OB_APIM_HOME>/bin directory to start the WSO2 OB APIM server:
Execute the following command against the openbank_openbankingdb database: