Set Up Accelerators
This section guides you to set up and prepare your server to run WSO2 Open Banking Accelerator.
Set up WSO2 Identity Server¶
Step 1: Install WSO2 Open Banking IAM Accelerator¶
Copy the extracted accelerator directory into the root directory of the WSO2 Identity Server.
| File | Directory location to place the Accelerator |
|---|---|
wso2-fsiam-accelerator-4.0.0 |
<IS_HOME> |
Tip
This documentation will refer to the above-extracted directory of the accelerator as <OB_IS_ACCELERATOR_HOME>.
Step 2: Configure database scripts¶
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.
This section explains how to set up the solution with a MySQL 8.0 database server. For other DBMS, see Setting up databases.
- Place the compatible JDBC drivers in the
<IS_HOME>/repository/components/libfolder. Supported JDBC driver for MySQL 8.0 : mysql-connector-java-5.1.44.jar - Open the
<IS_HOME>/<OB_IS_ACCELERATOR_HOME>/repository/conf/configure.propertiesfile. - Configure database-related properties and database names.
Step 3: Set up the IS server¶
-
Open and configure the configure.properties file resides in
<IS_HOME>/<OB_IS_ACCELERATOR_HOME>/repository/conffolder. a. Configure the hostnames of the API Manager and Identity Server.b. Configure the admin credentials of the Identity Server.
c. Update the “IS_PRODUCT” to
wso2is-<IS_VERSION>.d. Update the “PRODUCT_CONF_PATH” to
repository/resources/wso2is-<IS_VERSION>-deployment.toml.Note
Use the Identity Server version deploying as the IS_VERSION.
-
Run the merge script in
<IS_HOME>/<OB_IS_ACCELERATOR_HOME>/bin:./merge.sh./merge.sh./merge.ps1 -
Run the configure file in
<IS_HOME>/<OB_IS_ACCELERATOR_HOME>/bin:./configure.sh./configure.sh./configure.ps1If you are using windows platform...
If you are using windows platform, since the merge.ps1 and configure.ps1 files are not digitally signed yet, your powershell might prevent you from running them normally. In that case you may need to run these scripts in a powershell instance where its execution policy is set to bypass mode.
Use the following command to run these scripts in execution policy bypassed powershell environment.
powershell -executionpolicy bypass .\merge.ps1powershell -executionpolicy bypass .\configure.ps1IMPORTANT : Do not run any other unverified scripts using this way. This is a temporary solution.
-
Run the db script resides in
<IS_HOME>/dbscripts/financial-services/event-notificationsdirectory to create database tables for event notification feature infs_consentdbdatabase.
Setting Up WSO2 API Manager¶
Step 1: Install WSO2 Open Banking AM Accelerator¶
Copy the extracted accelerator directory into the root directory of the WSO2 API Manager.
| File | Directory location to place the Accelerator |
|---|---|
wso2-fsam-accelerator-4.0.0 |
<APIM_HOME> |
Tip
This documentation will refer to the above-extracted directory of the accelerator as <OB_APIM_ACCELERATOR_HOME>.
Step 2: Configure database scripts¶
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.
This section explains how to set up the solution with a MySQL 8.0 database server. For other DBMS, see Setting up databases.
- Place the compatible JDBC drivers in the
<APIM_HOME>/repository/components/libfolder. Supported JDBC driver for MySQL 8.0 : mysql-connector-java-5.1.44.jar - Open the
<APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/repository/conf/configure.propertiesfile. - Configure database-related properties and database names.
Step 3: Set up the APIM server¶
-
Open and configure the configure.properties file resides in
<APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/repository/conffolder. a. Configure the hostnames of the API Manager and Identity Server.b. Configure the admin credentials of the API Manager and Identity Server.
c. Configure the admin name.
d. Update the “PRODUCT_CONF_PATH” to
repository/resources/wso2am-<APIM_VERSION>-deployment.toml.Note
Use the API Manager version deploying as the APIM_VERSION.
-
Run the merge script in
<APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/bin:./merge.sh./merge.sh./merge.ps1 -
Run the configure file in
<APIM_HOME>/<OB_APIM_ACCELERATOR_HOME>/bin:./configure.sh./configure.sh./configure.ps1If you are using windows platform...
If you are using windows platform, since the merge.ps1 and configure.ps1 files are not digitally signed yet, your powershell might prevent you from running them normally. In that case you may need to run these scripts in a powershell instance where its execution policy is set to bypass mode.
Use the following command to run these scripts in execution policy bypassed powershell environment.
powershell -executionpolicy bypass .\merge.ps1powershell -executionpolicy bypass .\configure.ps1IMPORTANT : Do not run any other unverified scripts using this way. This is a temporary solution.
Exchanging the certificates¶
In order to enable secure communication, we need to install the certificates of each component in others. This will facilitate a Secure Socket Layer (SSL). Follow the steps below to implement this:
Note
Here Server A can be either IS, APIM or any other product.
-
Generate a key against the keystore of a particular server. For example, server A with an alias and common name that is equal to the hostname.
keytool -genkey -alias <keystore_alias> -keyalg RSA -keysize 2048 -validity 3650 -keystore <keystore_path> -storepass <keystore_password> -keypass <key password> -noprompt -
Export the public certificate of the newly generated key pair.
keytool -export -alias <cert_alias> -file <certificate_path> -keystore <keystore path>> -
Import the public cert of Server A to the client truststores of all the servers including Server A.
keytool -import -trustcacerts -alias <cert_alias> -file <certificate_path> -keystore <trustore_path> -storepass <keystore_password> -noprompt -
Repeat above steps for all the servers.
Uploading Root and Issuer certificates¶
Upload the root and issuer certificates of OBIE (Sandbox Certificates | Production Certificates) to the client trust stores in <IS_HOME>/repository/resources/security/client-truststore.p12 and <APIM_HOME>/repository/resources/security/client-truststore.jks using the following command:
```
keytool -import -alias <alias> -file <certificate_location> -keystore <truststore_location> -storepass wso2carbon
```
Start servers¶
-
Run the following command in
/bin: ./wso2server.sh -
Run the following command in
/bin: ./api-manager.sh