Set up Toolkits

This section guides you to set up and prepare your servers to run WSO2 Open Banking UK Toolkit.

Set up accelerators

Copy the extracted accelerator directories into the root directories of the respective base products. Use the table to locate the respective root directory of the base products:

File Directory location to place the Accelerator
wso2-obiam-accelerator-3.0.0 <IS_HOME>
wso2-obam-accelerator-3.0.0 <APIM_HOME>

Configure database scripts for accelerators

Note

WSO2 Open Banking Accelerator is compatible with the following DBMSs:

  • MySQL 8.0
  • Oracle 19c
  • Microsoft SQL Server 2017
  • PostgreSQL 13

This section explains how to set up the solution with a MySQL 8.0 database server. For other DBMS, see Setting up databases.

  1. Open the <APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/repository/conf/configure.properties file.

  2. Configure the hostnames of the API Manager and Identity Server.

  3. Configure databases related properties and database names.

  4. Open the <IS_HOME>/<OB_IS_ACCELERATOR_HOME>/repository/conf/configure.properties file and repeat step 2 and 3.

Set up servers

  1. Run the merge.sh script in <APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/bin and <IS_HOME>/<OB_IS_ACCELERATOR_HOME>/bin respectively: 

    ./merge.sh

  2. Run the configure.sh files in <APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/bin and <IS_HOME>/<OB_IS_ACCELERATOR_HOME>/bin respectively: 

    ./configure.sh

  3. Extract the wso2is-extensions zip file of the relevant API Manager version.

  4. Follow the given instructions and copy the relevant files to the given directory paths.

    1. Open the <IS_EXTENSION>/dropins folder.
    2. Copy the following JAR files to the <IS_HOME>/repository/components/dropins folder.
      • wso2is.key.manager.core
      • wso2is.notification.event.handlers
    3. Open the <IS_EXTENSION>/webapps folder.
    4. Copy the keymanager-operations.war file to the <IS_HOME>/repository/deployment/server/webapps folder.

Note

Even if you're only updating the Accelerator, you'll still need to run the Toolkit merge process since the Toolkit includes additional changes on top of the Accelerator. After completing the toolkit setup, remember to re-apply any custom modifications you may have made previously.

Set up toolkits

Copy the extracted toolkit directories into the root directories of the respective base products. Use the table to locate the respective root directory of the base products:

File Directory location to place the Toolkit
wso2ob-is-toolkit-uk-1.0.0 <IS_HOME>
wso2ob-apim-toolkit-uk-1.0.0 <APIM_HOME>

Configure database scripts for toolkits

Note

WSO2 Open Banking UK Toolkit is compatible with the following DBMSs:

  • MySQL 8.0
  • Oracle 19c
  • Microsoft SQL Server 2017
  • PostgreSQL 13

This section explains how to set up the solution with a MySQL 8.0 database server. For other DBMS, see Setting up databases.

  1. Open the <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/conf/configure.properties file.
  2. Configure the hostnames of the API Manager and Identity Server.
  3. Configure databases related properties and database names.
  4. Open the <IS_HOME>/<OB_IS_TOOLKIT_HOME>/repository/conf/configure.properties file and repeat step 2 and 3.

Set up servers

  1. Run the merge.sh script in <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/bin and <IS_HOME>/<OB_IS_TOOLKIT_HOME>/bin respectively: 

    ./merge.sh

  2. Run the configure.sh files in <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/bin and <IS_HOME>/<OB_IS_TOOLKIT_HOME>/bin respectively: 

    ./configure.sh

  3. If you are using WSO2 Identity Server 6.0.0,

    1. Open the <IS_HOME>/repository/conf/deployment.toml file.

    2. Add below configuration to enable application role validation:

      [application_mgt]
enable_role_validation = true

Start servers

If you are using JDK 17 with WSO2 Identity Server 6.0.0 or above, you need to enable adaptive authentication. Click here to see how it is done...

For JDK 17 runtime, adaptive authentication is disabled by default and it is required to enable adaptive authentication. To enable adaptive authentication:

  1. Go to <IS_HOME>/bin.

  2. Run the following command:

    ./adaptive.sh
    ./adaptive.bat

See Adaptive Authentication - Prerequisites for more information.

  1. Run the following command in <IS_HOME>/bin: 
    ./wso2server.sh
  2. Run the following command in <APIM_HOME>/bin: 
    ./api-manager.sh
Top