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

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

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

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_openbankingdb

     • openbank_govdb

     • openbank_iskm_configdb       

     • openbank_mbstoredb

     • openbank_userdb

2. Go to the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts directory and execute the following command:

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

1. 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_APIM_HOME>/repository/conf/finance/open-banking.xml 

• <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml   xml

2. Configure the authentication web app.

   1. Update the <WSO2_OB_KM_HOME>/repository/conf/identity/application-authentication.xml file with the following configurations:

      xmlxml

   2. Update the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file with the following configurations:

      xmlxmlxmlxml

3. Configure the IDTokenBuilder in the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file as follows:

   xml

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

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

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

7. Add the following Consent Enforcement handler configurations to the <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml file, below the

   #if($handler.className == "org.wso2.carbon.apimgt.gateway.handlers.ext.APIManagerExtensionHandler") line.
   xml

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

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

   sql