Setting up the database and login role
Follow the steps below to set up a PostgreSQL database:
- Install PostgreSQL on your computer as follows:
- Start the PostgreSQL service using the following command:
- Create a database and the login role from a GUI using the PGAdminIII tool.
- To connect PGAdminIII to a PostgreSQL database server, locate the server from the object browser, right-click the client, and click Connect. This will show you the databases, tablespaces, and login roles as follows:
To create a database, click Databases in the tree (inside the object browser), and click New Database.
- In the New Database dialog box, give a name to the database (for example: gregdb) and click OK.
To create a login role, click Login Roles in the tree (inside the object browser), and click New Login Role. Enter the role name and a password.
These values will be used in the product configurations as described in the following sections. In the sample configuration,
gregadmin
will be used as both the role name and the password.- Optionally enter other policies, such as the expiration time for the login and the connection limit.
Click OK to finish creating the login role.
Setting up the drivers
- Download the PostgreSQL JDBC4 driver.
Copy the driver to your WSO2 product's <
EMM_HOME>/repository/components/lib
directory.
Setting up configuration files
The default datasource configuration are defined in the 3 files listed below, which are located in the <EMM_HOME>/repository/conf/datasources
directory.
The database configurations in registry.xml
and user-mgt.xml
located in the <EMM_HOME>/repository/conf
directory refer to the WSO2_CARBON_DB
datasource.
master-datasources.xml
Edit the
WSO2_CARBON_DB
and
WSO2AM_DB
datasources in themaster-datasources.xml
file by replacing theurl
,username
,password
anddriverClassName
settings with your custom values.emm-datasources.xml
Edit the
DM_DS
,MobileIOSDM_DS
,MobileAndroidDM_DS
andMobileWindowsDM_DS
datasources in theemm-datasources.xml
file by replacing theurl
,username
,password
anddriverClassName
settings with your custom values.analytics-datasoruces.xml
Point to
WSO2_ANALYTICS_EVENT_STORE_DB
andWSO2_ANALYTICS_PROCESSED_DATA_STORE_DB
in the<EMM_HOME>/repository/conf/datasources/analytics-datasources.xml
file as shown below.
Element | Description |
---|---|
url | The URL of the database. The default port for a PostgreSQL instance is 5432. |
username and password | The name and password of the database user. |
driverClassName | The class name of the database driver. |
maxActive | The maximum number of active connections that can be allocated at the same time from this pool. Enter any negative value to denote an unlimited number of active connections. |
maxWait | The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. You can enter zero or a negative value to wait indefinitely. |
minIdle | The minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none. |
testOnBorrow | Whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and another attempt will be made to borrow another. |
defaultAutoCommit | Whether to commit database changes automatically or not. |
validationInterval | The indication to avoid excess validation, and only run validation at the most, at this frequency (time in milliseconds). If a connection is due for validation, but has been validated previously within this interval, it will not be validated again. |
For more information on other parameters that can be defined in the <EMM_HOME>/repository/conf/datasources/m
aster-datasources.xml
file, see Tomcat JDBC Connection Pool.
Configuring new datasources to manage registry or user management data
Follow the steps below to configure new datasources to point to the new databases you create to manage registry and/or user management data separately.
Add a new datasource with similar configurations as the
WSO2_CARBON_DB
datasource above to the <EMM_HOME>/repository/conf/datasources/
master-datasources.xml
file. Change its elements with your custom values. For instructions, see Setting up datasource configurations.If you are setting up a separate database to store registry-related data, update the following configurations in the <
EMM_HOME>/repository/conf/
registry.xml
file.If you are configuring WSO2 EMM in a production environment, follow the steps given in our clustering guide for more information on Mounting the registry on manager and worker nodes
<dbConfig name="wso2registry"> <dataSource>jdbc/MY_DATASOURCE_NAME</dataSource> </dbConfig>
If you are setting up a separate database to store user management data, update the following configurations in the <
EMM_HOME>/repository/conf/
user-mgt.xml
file.<Configuration> <Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property> </Configuration>
Creating database tables
To create the database tables, connect to the database that you created earlier and run the following scripts.
To create tables in the registry and user manager database (
WSO2CARBON_DB
), use the below script:
Create the following database tablesDatabase DB Script name and Location WSO2_CARBON_DB
<EMM_HOME>/dbscripts/postgresql.sql
WSO2AM_DB
<EMM_HOME>/dbscripts/apimgt/postgresql.sql
WSO2DM_DB
<EMM_HOME>/dbscripts/cdm/postgresql.sql
WSO2MobileIOS_DB
<EMM_HOME>/dbscripts/cdm/plugins/ios/postgresql.sql
WSO2MobileAndroid_DB
<EMM_HOME>/dbscripts/cdm/plugins/android/postgresql.sql
WSO2MobileWindows_DB
<EMM_HOME>/dbscripts/cdm/plugins/windows/postgresql.sql
Restart the server.
You can create database tables automatically when starting the product for the first time by using the
-Dsetup
parameter as follows:For Windows:
<EMM_HOME>/bin/wso2server.bat -Dsetup
For Linux:
<EMM_HOME>/bin/wso2server.sh -Dsetup