This documentation is for WSO2 Enterprise Mobility Manager 2.2.0. View documentation for the latest release.
Setting up PostgreSQL - Enterprise Mobility Manager 2.2.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

Setting up the database and login role

Follow the steps below to set up a PostgreSQL database:

  1. Install PostgreSQL on your computer as follows:
  2. Start the PostgreSQL service using the following command:
  3. Create a database and the login role from a GUI using the PGAdminIII tool.
  4. 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:
  5. To create a database, click Databases in the tree (inside the object browser), and click New Database.

  6. In the New Database dialog box, give a name to the database (for example: gregdb) and click OK.
  7. 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.

  8. Optionally enter other policies, such as the expiration time for the login and the connection limit.
  9. Click OK to finish creating the login role.

Setting up the drivers

  1. Download the PostgreSQL JDBC4 driver.
  2. 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_DBandWSO2AM_DB datasources in the master-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values.

     WSO2_Carbon_DB datasource
    <datasource>
       <name>WSO2_CARBON_DB</name>
       <description>The datasource used for registry and user manager</description>
       <jndiConfig>
          <name>jdbc/WSO2CarbonDB</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     WSO2AM_DB datasource
    <datasource>
       <name>WSO2AM_DB</name>
       <description>The datasource used for API Manager database</description>
       <jndiConfig>
          <name>jdbc/WSO2AM_DB</name>
       </jndiConfig>
       <definition type="RDBMS">
    	<configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     WSO2_Social_DB
    <?xml version="1.0" encoding="UTF-8"?>
    <datasource>
       <name>WSO2_SOCIAL_DB</name>
       <description>The datasource used for Store social database. You are able to like/dislike/comment and rate apps in the store. All the required 	details are stored in this database</description>
       <jndiConfig>
          <name>jdbc/WSO2_SOCIAL_DB</name>
       </jndiConfig>
       <definition type="RDBMS">
    	<configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     JAGH2
    <datasource>
       <name>JAGH2</name>
       <description>The datasource used for by the Jaggery Storage Manager</description>
       <jndiConfig>
          <name>jdbc/ES_Storage</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:h2:repository/database/ES_STORAGE;DB_CLOSE_ON_EXIT=FALSE;LOCK_TIMEOUT=60000</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.h2.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
          </configuration>
       </definition>
    </datasource>
  • emm-datasources.xml

    Edit the DM_DS, MobileIOSDM_DS, MobileAndroidDM_DS and MobileWindowsDM_DS datasources in the emm-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values.

     DM_DS datasource
     <datasource>
       <name>DM_DS</name>
       <description>The datasource used for EMM</description>
       <jndiConfig>
          <name>jdbc/DM_DS</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     MobileIOSDM_DS datasource

    This datasource is specifically used to manage mobile devices on the iOS platform.

    <datasource>
       <name>MobileIOSDM_DS</name>
       <description>The datasource used for EMM Mobile iOS Device Management</description>
       <jndiConfig>
          <name>jdbc/MobileIOSDM_DS</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     MobileAndroidDM_DS datasource

    This datasource is specifically used to manage mobile devices on the Android platform.

    <datasource>
       <name>MobileAndroidDM_DS</name>
       <description>The datasource used for EMM Mobile Android Device Management</description>
       <jndiConfig>
          <name>jdbc/MobileAndroidDM_DS</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     MobileWindowsDM_DS datasource

    This datasource is specifically used to manage mobile devices on the Windows platform.

    <datasource>
       <name>MobileWindowsDM_DS</name>
       <description>The datasource used for EMM Mobile Windows Device Management</description>
       <jndiConfig>
          <name>jdbc/MobileWindowsDM_DS</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource> 
  • analytics-datasoruces.xml

    Point to WSO2_ANALYTICS_EVENT_STORE_DB and WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB in the <EMM_HOME>/repository/conf/datasources/analytics-datasources.xml file as shown below.

     WSO2_Analytics_Processed_Data_Store_DB
    <datasource>
       <name>WSO2_ANALYTICS_EVENT_STORE_DB</name>
       <description>The datasource used for analytics record store</description>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
     WSO2_Analytics_Processed_Data_Store_DB
    <?xml version="1.0" encoding="UTF-8"?>
    <datasource>
       <name>WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB</name>
       <description>The datasource used for analytics record store</description>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:5432/gregdb</url>
             <username>regadmin</username>
             <password>regadmin</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>80</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <defaultAutoCommit>true</defaultAutoCommit>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
ElementDescription
urlThe URL of the database. The default port for a PostgreSQL instance is 5432.
username and passwordThe name and password of the database user.
driverClassNameThe class name of the database driver.
maxActiveThe 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.
maxWaitThe 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.
minIdleThe 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.
validationIntervalThe 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.

  1. 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.

  2. If you are setting up a separate database to store registry-related data, update the following configurations in the <EMM_HOME>/repository/conf/registry.xmlfile.

    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>
  3. 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.

  1. To create tables in the registry and user manager database (WSO2CARBON_DB), use the below script:
    Create the following database tables 

    DatabaseDB 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
  2. 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

  • No labels