Setting up Oracle

The following sections describe how to replace the default H2 databases with Oracle:

Setting up the database and users

Follow the steps below to set up an Oracle database.

Create a new database manually or by using the Oracle database configuration assistant (dbca).
Make the necessary changes in the Oracle tnsnames.ora and listner.ora files in order to define addresses of the databases for establishing connections to the newly created database.
After configuring the .ora files, start the Oracle instance using the following command:
```
$ sudo /etc/init.d/oracle-xe restart
```

Connect to Oracle using SQL*Plus as SYSDBA as follows:

$ ./$<ORACLE_HOME>/config/scripts/sqlplus.sh sysadm/password as SYSDBA

Connect to the instance with the username and password using the following command:
```
$ connect
```

As SYSDBA, create a database user and grant privileges to the user as shown below:

Create user <USER_NAME> identified by password account unlock;
grant connect to <USER_NAME>;
grant create session, create table, create sequence, create trigger to <USER_NAME>;
alter user <USER_NAME> quota <SPACE_QUOTA_SIZE_IN_MEGABYTES> on '<TABLE_SPACE_NAME>';
commit;

Exit from the SQL*Plus session by executing the quit command.

Setting up the JDBC driver

Copy the Oracle JDBC libraries (for example, <ORACLE_HOME/jdbc/lib/ojdbc14.jar) to the <PRODUCT_HOME>/repository/components/lib directory.
Remove the old database driver from the <PRODUCT_HOME>/repository/components/dropins directory.

If you get a timezone region not found error when using the ojdbc6.jar with WSO2 servers, set the Java property as follows: export JAVA_OPTS="-Duser.timezone='+05:30'"

The value of this property should be the GMT difference of the country. If it is necessary to set this property permanently, define it inside the wso2server.sh as a new JAVA_OPT property.

Setting up datasource configurations

A datasource is used to establish the connection to a database. By default datasources are used to connect to the default H2 database. After setting up the Oracle database to replace the default H2 database, either change the default configurations of the WSO2_CARBON_DB datasource or configure a new datasource to point it to the new database as explained below.

The default datasource configuration are defined in the 2 files listed below, which are located in the <PRODUCT_HOME>/repository/conf/datasources directory. The database configurations in registry.xml and user-mgt.xml refer to the WSO2_CARBON_DB datasource.

Edit the WSO2_CARBON_DB, WSO2_EMM_DB and WSO2AM_DB datasources in the master-datasources.xml and cdm-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

master-datasources.xml

This file contains the following default datasource configurations to configure EMM with the Carbon database and the WSO2 API Manager database.

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:oracle:thin:@localhost:1521/orcl</url>
         <username>WSO2CARBON_DB</username>
         <password>password</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1 FROM DUAL</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:oracle:thin:@localhost:1521/orcl</url>
         <username>WSO2AM_DB</username>
         <password>password</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1 FROM DUAL</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>

cdm-datasources.xml

This file contains the following default datasource configurations to configure EMM with the Connected Device Management Framework and for mobile device management.

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:oracle:thin:@localhost:1521/orcl</url>
         <username>WSO2DM_DB</username>
         <password>password</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1 FROM DUAL</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 Device Management</description>
   <jndiConfig>
      <name>jdbc/MobileIOSDM_DS</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>WSO2MobileIOS_DB</username>
         <password>password</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1 FROM DUAL</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 Device Management</description>
    <jndiConfig>
        <name>jdbc/MobileAndroidDM_DS</name>
    </jndiConfig>
    <definition type="RDBMS">
        <configuration>
            <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
            <username>WSO2MobileAndroid_DB</username>
            <password>password</password>
            <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
            <maxActive>50</maxActive>
            <maxWait>60000</maxWait>
            <testOnBorrow>true</testOnBorrow>
            <validationQuery>SELECT 1 FROM DUAL</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 Device Management</description>
    <jndiConfig>
        <name>jdbc/MobileWindowsDM_DS</name>
    </jndiConfig>
    <definition type="RDBMS">
        <configuration>
            <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
            <username>WSO2MobileWindows_DB</username>
            <password>root</password>
            <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
            <maxActive>50</maxActive>
            <maxWait>60000</maxWait>
            <testOnBorrow>true</testOnBorrow>
            <validationQuery>SELECT 1 FROM DUAL</validationQuery>
            <validationInterval>30000</validationInterval>
        </configuration>
    </definition>
</datasource>

The elements in the above configuration are described below:

Element	Description
url	The URL of the database. The default port for a DB2 instance is 50000.
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	The indication of 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.
validationQuery	The SQL query that will be used to validate connections from this pool before returning them to the caller.
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.

The default port for Oracle is 1521.

For more information on other parameters that can be defined in the <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file, see Tomcat JDBC Connection Pool.

Configuring new datasources to manage registry or user management data

Follow the steps given below to configure the 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 <PRODUCT_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 <PRODUCT_HOME>/repository/conf/ registry.xml file.
```
<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 <PRODUCT_HOME>/repository/conf/ user-mgt.xml file.
```
<Configuration>
	<Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property>
</Configuration>
```

Creating the database tables

To create the database tables, connect to the database that you created earlier and run the following scripts in SQL*Plus:

To create tables in the registry and user manager database (WSO2CARBON_DB), use the below script:
```
SQL> @$<PRODUCT_HOME>/dbscripts/oracle.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: <PRODUCT_HOME>/bin/wso2server.bat -Dsetup
- For Linux: <PRODUCT_HOME>/bin/wso2server.sh -Dsetup