This documentation is for WSO2 IoT Server 3.1.0. View the documentation for the latest release.
Page Comparison - Setting up Oracle (v.1 vs v.2) - IoT Server 3.1.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
locationtop
styleborder:1locationtop
separatorpipe

Setting up the database and users

...

  1. Copy the Oracle JDBC libraries (for example, <ORACLE_HOME/jdbc/lib/ojdbc14.jar) to the <PRODUCTIoTS_HOME>/core/repository/components/lib directory.
  2. Remove the old database driver from the <PRODUCT<IoTS_HOME>/core/repository/components/dropins directory.
Info

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.

...

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 files listed below, which are located in the <PRODUCT_HOME>/repository/conf/datasources directory.

...

master-datasources.xml

Panel

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

Edit the WSO2_CARBON_DB, WSO2_MB_STORE_DB and WSO2AM_DB datasources in the xml files listed below by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

Expand
titleWSO2_Carbon_DB datasource
Code Block
<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</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <minIdle>5</minIdle>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>
Expand
titleWSO2_MB_Store_DB datasource
Code Block
<datasource>
   <name>WSO2_MB_STORE_DB</name>
   <description>The datasource used for message broker database</description>
   <jndiConfig>
      <name>jdbc/WSO2MBStoreDB</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
         <defaultAutoCommit>false</defaultAutoCommit>
      </configuration>
   </definition>
</datasource>
Expand
titleWSO2AM_DB datasource
Code Block
<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>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>

...

analytics-datasources.xml

Panel

This file contains the following default datasources used for summarization and to persist stream data. The database tables are created dynamically when running the spark script along with the required tables.
Example: Arduino publishes the temperature data that gets stored in this database.

Edit the WSO2_ANALYTICS_EVENT_STORE_DB and WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB datasources in the analytics-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

Expand
titleWSO2_Analytics_Event_Store_DB datasource
Code Block
<datasource>
   <name>WSO2_ANALYTICS_EVENT_STORE_DB</name>
   <description>The datasource used for analytics record store</description>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <validationQuery>SELECT 1</validationQuery>
         <defaultAutoCommit>false</defaultAutoCommit>
         <initialSize>0</initialSize>
         <testWhileIdle>true</testWhileIdle>
         <minEvictableIdleTimeMillis>4000</minEvictableIdleTimeMillis>
      </configuration>
   </definition>
</datasource>
Expand
titleWSO2_Analytics_Processed_Data_Store_DB datasource
Code Block
<datasource>
   <name>WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB</name>
   <description>The datasource used for analytics record store</description>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <validationQuery>SELECT 1</validationQuery>
         <defaultAutoCommit>false</defaultAutoCommit>
         <initialSize>0</initialSize>
         <testWhileIdle>true</testWhileIdle>
         <minEvictableIdleTimeMillis>4000</minEvictableIdleTimeMillis>
      </configuration>
   </definition>
</datasource> 

metrics-datasources.xml

...

Edit the WSO2_METRICS_DB datasource in the metrics-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

Expand
titleWSO2_Metrics_DB datasource
Code Block
<datasource>
   <name>WSO2_METRICS_DB</name>
   <description>The default datasource used for WSO2 Carbon Metrics</description>
   <jndiConfig>
      <name>jdbc/WSO2MetricsDB</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
         <defaultAutoCommit>true</defaultAutoCommit>
      </configuration>
   </definition>
</datasource> 

...

cdm-datasources.xml

Panel

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

Edit the datasources in the cdm-datasources.xml  file by replacing the url, usernamepassword  and driverClassName settings with your custom values and also the other values accordingly.

Expand
titleDM_DS datasource
Code Block
<datasource>
   <name>DM_DS</name>
   <description>The datasource used for CDM</description>
   <jndiConfig>
      <name>jdbc/DM_DS</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>

...

<PLUGIN_NAME>-datasource.xml

Panel

Each device type will have its own datasource so that all the data required for the device type can be stored in it. Therefore, when writing a new device plugin make sure to create your own datasource too.

For example, let’s take Arduino plugin.

Expand
titleExample: Arduino_DB datasource
Code Block
<datasource>
   <name>Arduino_DB</name>
   <description>The datasource used for the Arduino database</description>
   <jndiConfig>
      <name>jdbc/ArduinoDM_DB</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>

The elements in the above configuration are described below:

ElementDescription
urlThe URL of the database. The default port for a DB2 instance is 50000.
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

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.
validationQueryThe SQL query that will be used to validate connections from this pool before returning them to the caller.
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.
Info
  • 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 .

...

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:

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

    Code Block
    languagexml
    <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 <PRODUCT_HOME>/repository/conf/ user-mgt.xml file.

    Code Block
    languagexml
    <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:

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

    Code Block
    languagepowershell
    SQL> @$<PRODUCT_HOME>/dbscripts/oracle.sql
  2. Restart the server.

    Info

    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

...

hiddentrue

Note to writers: Add this content at the end of the page if any of the additional databases is relevant to your product.

Changing the identity/storage/product-specific databases

The topics above show how to change the WSO2_CARBON_DB, which is used to store registry and user manager information. If you changed the product-specific database that comes by default or set up a separate database for identity or storage related data, the instructions are the same. In summary:

...

Add a new datasource configuration to the following files for each of the separate databases that you need to create.

For the identity databaseAdd it to the <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)>
For the storage databaseAdd it to the <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)
For the product-specific databaseAdd it to the <PRODUCT_HOME>/repository/conf/<check the correct path and add file name (something like api-manager.xml)

...

Create the database tables using the following scripts:

For the identity databaseUse <PRODUCT_HOME>/dbscripts/identity/<check the correct path and add file name (something like mysql.sql)>
For the storage databaseUse <PRODUCT_HOME>/dbscripts/storage/<check the correct path and add file name (something like /mysql/resoucre.sql)>
For the product-specific databaseUse <PRODUCT_HOME>/dbscripts/<check the correct path and add file name (something like /apimgt/mysql.sql)> 

Update the following configurations, with the defined datasource name of the corresponding database configuration you added to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.

If you are setting up a separate database to store identity-related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/identity.xml file.

Code Block
languagexml
<JDBCPersistenceManager>
	<DataSource>
		<!-- Include a data source name (jndiConfigName) from the set of datasources defined in master-datasources.xml -->
		<Name>jdbc/WSO2CarbonDB</Name>
	</DataSource>
</JDBCPersistenceManager>

...

What's next

By default, all WSO2 products are configured to use the embedded H2 database. To configure WSO2 IoTS with Oracle, see Changing to Oracle.