Versions Compared

Old Version 59

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add updates 2 note

...

Note

The scripts for the below local setup in the Quick Start Guide are configured for a Linux and MySQL/MSSQL environment. Notice that WSO2 Open Banking solution is applicable to Windows/Linux and MySQL/MSSQL and Oracle environments.

Prerequisites

Tip
Multiexcerpt
MultiExcerptNamesettingupDatabase
In order to start the servers, configure the databases in both the API Manager (APIM) and
  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
      titleClick here to see how to download the packs from WUM

      Multiexcerpt include
      MultiExcerptNameWUM_Instructions
      PageWithExcerptSetting Up Servers

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

Setting up the databases and starting the 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
      titleClick 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
        titleOn Linux
        Code Block
        ./wso2update_linux
        Localtab
        titleOn Mac
        Code Block
        ./wso2update_darwin
        Localtab
        titleOn Windows
        Code Block
        ./wso2update_windows.exe
      • Repeat this step for both the wso2-obkm-1.4.0 and wso2-obam-1.4.0 products.

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

Setting up the databases and starting the servers

Multiexcerpt
MultiExcerptNamesettingupDatabase

In order to start the servers, 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 PropertyDescription
      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

      an MS SQL 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

      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...
      Databaseopenbank_apimgtdb
      TableAM_APPLICATION_REGISTRATION
      FieldINPUTS
      Data typeCLOB

  2. Run the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts/configure-km.sh file using the following command:

    If you're setting up Open Banking for Berlin:

    Update the data type of the given field to CLOB: 

    Databaseopenbank_apimgtdb
    TableAM_APPLICATION_REGISTRATION
    FieldINPUTS
    Data typeCLOB

  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. Run the <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts/configure-am.sh file.

    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:


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

      ProductFileConfigAllowed 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. WSO2 Open Banking contains a mock back end. To configure the mock back end according to your specification:

    1. Open the open-banking.xml files. 
      1. <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml 
      2. <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml 

    2. Update the above files as follows:

      By default, the solution contains the UK configurations.

      UKxmlBerlinxml

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

  8. Run the same command from the <WSO2_OB_APIM_HOME>/bin directory to start the WSO2 OB APIM server.

...