Page Comparison

1. 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:

     Code Block
     export JAVA_HOME="<JDK_LOCATION>" export PATH=$PATH:$JAVA_HOME/bin

2. Download and unzip the following files:

   • wso2-obam-1.3.0.zip (WSO2 Open Banking API Manager) 

   • wso2-obkm-1.3.0.zip (WSO2 Open Banking Key Manager)

     Expand
     title Click here to find how to download the packs using WUM...
     Multiexcerpt include SpaceWithExcerpt OB130 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.3.0 and wso2-obam-1.3.0 products.

3. Setup a database server using MySQL 5.7+, Microsoft SQL Server 2016+ or, Oracle 12c.

In order to start the server, configure the databases in both the API Manager (APIM) and the Key Manager (KM) according to the open banking specification, as follows:

step1

1. 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: - 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

     MSSQL or Oracle, create the following databases before executing the configure-km.sh file.

   • openbank_am_configdb   

   • openbank_apimgt_statsdb

   • openbank_apimgtdb

   • openbank_consentdb

   • openbank_govdb

   • openbank_iskm_configdb       

   • openbank_mbstoredb

   openbank_userdb

   an MS SQL or an Oracle database, see  and configure the databases.

   If you're setting up Open Banking for Berlin and using an Oracle database, update the data type of the given field:  

   Click here to see the field to be updated...

   Database	openbank_apimgtdb
   Table	AM_APPLICATION_REGISTRATION
   Field	INPUTS
   Data type	CLOB

2. Set execution permissions to the configure-km.sh file in the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts and run it using the following command:

   If you're setting up Open Banking for Berlin:

   Update the data type of the given field to CLOB: 

   Database	openbank_apimgtdb
   Table	AM_APPLICATION_REGISTRATION
   Field	INPUTS
   Data type	CLOB

3. Go to the <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts directory and configure the database properties in the startup.properties file, similar to .

4. Set execution permissions to the configure-am.sh file and run it.

   You have configured databases in . By running configure.sh files, you set the database credentials with reference to the configuration files.

5. Configure the deployed open-banking specification accordingly. 

   By default, values are set for the UK specification. Other supported specifications include:

   • UK specification - https://www.openbanking.org.uk/
   • Berlin specification - https://www.berlin-group.org/
   • STET specification - https://www.stet.eu/en/psd2/

   
   

   • The following configurations are used to define the deployed specification at runtime:

     Product	File	Config	Allowed Values
     APIM	<WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml	<DeployedSpecification>	UK or BERLIN or STET
     APIM	<WSO2_OB_APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/conf/site.json	<DeployedSpecification>	UK or BERLIN or STET
     KM	<WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml	<DeployedSpecification>	UK or BERLIN or STET
     KM	<WSO2_OB_KM_HOME>/repository/deployment/server/jaggeryapps/ccportal/configs/conf.json	<DeployedSpecification>	UK or BERLIN or STET
     KM	<WSO2_OB_KM_HOME>/repository/deployment/server/jaggeryapps/consentmgt/configs/conf.json	<DeployedSpecification>	UK or BERLIN or STET

6. You are now ready to start the API Manager and Key Manager servers. In the command line, navigate to the <WSO2_OB_KM_HOME> /bin folder, and run the following command:

7. Run the same command from the <WSO2_OB_APIM_HOME>/bin directory to start the API Manager server.