This documentation is for WSO2 API Manager 1.5.0 View documentation for the latest release.
Setting up with Oracle - API Manager 1.5.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

Follow the instructions below to set up the Oracle database.

For Oracle RAC, refer to Setting up with Oracle RAC.

Setup Database and User

1. Create a new database. This can be done by either using the Oracle database configuration assistant (dbca) or manually. Do necessary changes in the Oracle tnsnames.ora and listner.ora files in order to define databases addresses for establishing connections to the newly created database. After configuring them, startup the Oracle instance.

$ sudo /etc/init.d/oracle-xe restart

2. Connect to Oracle using SQL*Plus as sysdba.

$ ./${ORACLE_HOME}/config/scripts/ sysadm/password as sysdba

2.1. Connect to instance with username and password.

$ connect

3. As SYS DBA, 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, dba to USER_NAME;

For example,

4. Exit from the SQL*Plus session by typing the "quit" command.

SQL> quit

Setup Configuration File

1. Edit the default database configuration defined in the  master-datasources.xml  file located at  $CARBON_HOME/repository/conf/datasources  directory as follows. Both the database configurations in  registry.xml  and  user-mgt.xml  refer this data source.

Replace these settings with your own custom values:

     <description>The datasource used for registry and user manager</description>
     <definition type="RDBMS">
               <validationQuery>SELECT 1 FROM DUAL</validationQuery>
The database configuration options
  • url - The URL of the database.
  • username - The name of the database user.
  • password - The password of the database user.
  • driverClassName  - The class name of the database driver.
  • maxActive - The maximum number of active connections that can be allocated from this pool at the same time or negative for no limit.
  • 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 or <= 0 to wait indefinitely.
  • minIdle - The minimum number of active connections that can remain idle in the pool without extra ones being created or 0 to create none.


Default port for Oracle is 1521.

Copy JDBC Driver

Copy the Oracle JDBC libraries to $CARBON_HOME/repository/components/lib. For example, - $ORACLE_HOME/jdbc/lib/ojdbc14.jar.

Remove old database driver from $CARBON_HOME/repository/components/dropins , when you upgrade the database driver.

When using the ojdbc6.jar with WSO2 servers there is a possibility of throwing an timezone region not found error. To overcome this issue it is necessary to set the java property as 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, then it should be defined inside the as a new JAVA_OPT property.

Create Database Tables

Database tables can be created either manually by running scripts or automatically by using start-up parameters.

Using Scripts

Database tables can be created manually by logging in to the created database and running the following scripts in SQL*Plus:

SQL> @${CARBON_HOME}/dbscripts/oracle.sql

Start the Carbon instance.

$ ./${CARBON_HOME}/bin/

Using start-up Parameters

  • For Windows users:
$CARBON_HOME/bin/wso2server.bat -Dsetup

To create the database tables when starting the product for the first time.

  • For Linux Users
$ ./${CARBON_HOME}/bin/ -Dsetup
  • No labels