This documentation is for WSO2 IoT Server 3.1.0. View the documentation for the latest release.
Changing to Oracle - IoT Server 3.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

By default, WSO2 IoTS uses the embedded H2 database as the database for storing user management and registry data. Given below are the steps you need to follow in order to use an Oracle database for this purpose:

Before you begin

You need to set up Oracle before following the steps to configure WSO2 IoTS with Oracle. For more information, see Setting up Oracle.

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.

Changing the default WSO2_CARBON_DB datasource

Follow the instructions given below to change the type of the default WSO2_CARBON_DB datasource. The default datasource configurations are defined in the files listed below. 

  • master-datasources.xml

    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 <IoTS_HOME>/conf/datasources/master-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

     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</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>
     WSO2_MB_Store_DB datasource
    <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>
     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>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

    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 <IoTS_HOME>/analytics/repository/conf/datasources/analytics-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

     WSO2_Analytics_Event_Store_DB datasource
    <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>
     WSO2_Analytics_Processed_Data_Store_DB datasource
    <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

    This file contains the datasource required to enable the JVM metrics.

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

     WSO2_Metrics_DB datasource
    <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

    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 <IoTS_HOME>/conf/datasources/cdm-datasources.xml  file by replacing the url, usernamepassword  and driverClassName settings with your custom values and also the other values accordingly.

     DM_DS datasource
    <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

    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 Android plugin.

     Example: Android_DB datasource
    <datasource>
        <name>Android_DB</name>
        <description>The datasource used as the Android Device Management database</description>
        <jndiConfig>
            <name>jdbc/MobileAndroidDM_DS</name>
        </jndiConfig>
        <definition type="RDBMS">
            <configuration>
                <url>jdbc:h2:repository/database/WSO2MobileAndroid_DB;DB_CLOSE_ON_EXIT=FALSE
                </url>
                <username>wso2carbon</username>
                <password>wso2carbon</password>
                <driverClassName>org.h2.Driver</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.
  • The default port for Oracle is 1521.
  • For more information on other parameters that can be defined in the < IoTS_HOME>/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:

  1. Add a new datasource with similar configurations as the WSO2_CARBON_DB datasource above to the <IoTS_HOME>/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 <IoTS_HOME>/conf/registry.xml file.

    <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 <IoTS_HOME>/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:

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

    SQL> @$<IoTS_HOME>/dbscripts//oracle.sql
  2. Restart the server.

    You can create database tables automatically when starting WSO2 IoTS for the first time by using the -Dsetup parameter as follows:

    • For Windows: <IoTS_HOME>/core/bin/wso2server.bat -Dsetup

    • For Linux: <IoTS_HOME>/core/bin/wso2server.sh -Dsetup

  • No labels