This documentation is for WSO2 Open Banking version 1.5.0. View documentation for the latest release.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Make sure the following databases are created in your database server, if not create them:  

    Tip

    If you are setting up WSO2 OB BI and MySQL database in a local environment, 

    • Configure your database details in the <WSO2_OB_BI_HOME>/resources/finance/scripts/startup.properties file.
    • Go to the <WSO2_OB_BI_HOME>/resources/finance/scripts directory and execute the following command: 

      Code Block
      ./configure-bi.sh
    • openbank_apimgt_statsdb 

    • openbank_openbankingdb 

    • openbank_geolocationdb

    • openbank_ob_reporting_statsdb

    • openbank_ob_reporting_summarizeddb

  2. Update the  <WSO2_OB_BI_HOME>/conf/worker/deployment.yaml  file. Modify the datasources below by pointing them to the databases you created in the above step (in the given order). 

    • APIM_ANALYTICS_DB

    • OPEN_BANKING_DB

    • GEO_LOCATION_DATA

    • OB_REPORTING_DB  

    • OB_REPORTING_SUMMARIZED_DBUpdate the datasource entry in the deployment.yaml with your database configurations.

      Anchor
      deployment.yamlPlaceholders
      deployment.yamlPlaceholders


      PropertyDescription
      jdbcUrl

      This is the port to connect to on database server

      The jdbcUrl property expects the JDBC driver connection string. A sample jdbcUrl:

      'jdbc:mysql://localhost:3306/openbank_ob_reporting_summarizeddb?autoReconnect=true&useSSL=false'

      username

      The database user

      password

      Password set for the database connection

      driverClassName

      The JDBC driver name

      Mysql JDBC Driver : com.mysql.jdbc.Driver
      MSSQL JDBC Driver : com.microsoft.sqlserver.jdbc.SQLServerDriver
      Oracle JDBC Driver : oracle.jdbc.driver.OracleDriver

      Note

      If you are using Oracle, update the connectionTestQuery in each datasource with the following value.

      Code Block
      languagexml
      connectionTestQuery: SELECT 1 FROM DUAL
      Code Block
      languagexml
          - name: GEO_LOCATION_DATA
            description: "The data source used for geo location database"
            jndiConfig:
              name: jdbc/GEO_LOCATION_DATA
            definition:
              type: RDBMS
              configuration:
                jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_geolocationdb?autoReconnect=true&useSSL=false'
                username: root
                password: root
                driverClassName: com.mysql.jdbc.Driver
                maxPoolSize: 50
                idleTimeout: 60000
                connectionTestQuery: SELECT 1
                # Use below for oracle database
                # connectionTestQuery: SELECT 1 FROM DUAL
                validationTimeout: 30000
                isAutoCommit: false
      
          - name: APIM_ANALYTICS_DB
            description: "The datasource used for APIM statistics aggregated data."
            jndiConfig:
              name: jdbc/APIM_ANALYTICS_DB
            definition:
              type: RDBMS
              configuration:
                jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_apimgt_statsdb?autoReconnect=true&useSSL=false'
                username: root
                password: root
                driverClassName: com.mysql.jdbc.Driver
                maxPoolSize: 50
                idleTimeout: 60000
                connectionTestQuery: SELECT 1
                validationTimeout: 30000
                isAutoCommit: false
      
          - name: OPEN_BANKING_DB
            description: "The datasource used to store payment consents"
            jndiConfig:
              name: jdbc/OPEN_BANKING_DB
            definition:
              type: RDBMS
              configuration:
                jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_openbankingdb?autoReconnect=true&useSSL=false'
                username: root
                password: root
                driverClassName: com.mysql.jdbc.Driver 
                maxPoolSize: 50
                idleTimeout: 60000
                connectionTestQuery: SELECT 1
                validationTimeout: 30000
                isAutoCommit: false
      
          - name: OB_REPORTING_DB
            description: The datasource used to store statistics for OB Reporting module
            jndiConfig:
              name: jdbc/OB_REPORTING_DB
            definition:
              type: RDBMS
              configuration:
                jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_ob_reporting_statsdb?autoReconnect=true&useSSL=false'
                username: root
                password: root
                driverClassName: com.mysql.jdbc.Driver 
                maxPoolSize: 20
                idleTimeout: 60000
                connectionTestQuery: SELECT 1
                validationTimeout: 30000
                isAutoCommit: false
      
          - name: OB_REPORTING_SUMMARIZED_DB
            description: The datasource used to store statistics for OB Reporting module
            jndiConfig:
              name: jdbc/OB_REPORTING_SUMMARIZED_DB
            definition:
              type: RDBMS
              configuration:
                jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_ob_reporting_summarizeddb?autoReconnect=true&useSSL=false'
                username: root
                password: root
                driverClassName: com.mysql.jdbc.Driver 
                maxPoolSize: 20
                idleTimeout: 60000
                connectionTestQuery: SELECT 1
                validationTimeout: 30000
                isAutoCommit: false       

      Modify the datasources of OB_REPORTING_DB  in the <WSO2_OB_BI_HOME>/conf/dashboard/deployment.yaml file.                                                          

      Use your database configurations and update the datasource properties as follows: 

      Code Block
      languagexml
          - name: OB_REPORTING_DB
            description: The datasource used to store statistics for OB Reporting module
            jndiConfig:
              name: jdbc/OB_REPORTING_DB
            definition:
              type: RDBMS
              configuration:
                jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_ob_reporting_statsdb?autoReconnect=true&useSSL=false'
                username: root
                password: root
                driverClassName: 'com.mysql.jdbc.Driver'
                maxPoolSize: 20
                idleTimeout: 60000
                connectionTestQuery: SELECT 1
                # Use below for oracle database
                # connectionTestQuery: SELECT 1 FROM DUAL
                validationTimeout: 30000
                isAutoCommit: false
  3. Info

    This is available only as a WUM update and is effective from January 08, 2021 (01-08-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

    Multiexcerpt
    MultiExcerptNamecopy_widgets

    Copy the following widgets for your database type in the <WSO2_OB_BI_HOME>/resources/finance/dashboard/widgets/<DATABASE_TYPE> directory and replace those widgets in the <WSO2_OB_BI_HOME>/wso2/dashboard/deployment/web-ui-apps/portal/extensions/widgets directory:

    • AverageTransactionAmount
    • AverageTransactionAmountGraph
    • FraudGraph
    • TransactionGraph
    • TotalFraudulentTransactions
    • TotalPaymentTransactions
    • TransactionHistoryAnalyser
    • DateTimeRangePicker
Multiexcerpt
MultiExcerptNameOSGIJDBC
Note

You need to follow the steps below when you are using Oracle or MS SQL database servers.

  1. 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 <WSO2_OB_BI_HOME>/lib directory. 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>/bin directory. Run the command given below to generate the converted file in the <WSO2_OB_BI_HOME>/lib directory.

      Code Block
      ./jartobundle.sh <PATH_TO_NON-OSGi_JAR> ../lib
    3. Multiexcerpt
      MultiExcerptNamematch_schema_name_to_DB_name

      In order to make sure that the schema name is based on your database structures, follow the below instructions:

      Info

      This is available only as a WUM update and is effective from January 08, 2021 (01-08-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

      1. Go to the <WSO2_OB_BI_HOME>/wso2/dashboard/deployment/web-ui-apps/portal/extensions/widgets directory and open the widgetConf.json file of each of the below dashboard widgets:
        1. AverageTransactionAmount
        2. AverageTransactionAmountGraph
        3. FraudGraph
        4. TransactionGraph
        5. TotalFraudulentTransactions
        6. TotalPaymentTransactions
        7. TransactionHistoryAnalyser
      2. Add the following configuration under "currency":"£" of  the metadata attribute:

        Make sure you map to the correct schema name of OPENBANK_OB_REPORTING_STATSDB.

        Code Block
        languagexml
        "schemaName": "<SCHEMA_NAME_FOR_OPENBANK_OB_REPORTING_STATSDB>"

        Once updated, it must look as follows:

        Code Block
        languagexml
        "metadata": {
                    "currency":"£"
        			"schemaName": "<<SCHEMA<SCHEMA_NAME_FOR_OPENBANK_OB_REPORTING_STATSDB>"
        }

...