This documentation is for WSO2 Message Broker 3.0.0. View documentation for the latest release.
Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.

Versions Compared


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


Assign newly created users the required grants/permissions to log in, create tables, and insert, index, select, update, and delete data in tables in the newly created database, as the minimum set of SQL server permissions. 

Step 2: Connecting the server to the MSSQL database

Once you have setup the physical database as explained in the previous step, the next step is to enable the connectivity between your MB server and the database. This can be done by simply copying the relevant database drivers to your server, and then configuring the datasources in the datasources in MB to link to the new database. See the instructions given below.

Copying the JDBC driver

Download and copy one of the following drivers to the WSO2 product's <MB_HOME>/repository/components/lib/ directory. 

  • Download the Microsoft SQL JDBC driver file jtds-1.3.1.jar and copy it to the lib directory .
  • Or download the Microsoft JDBC Driver 6.0, 4.2, 4.1, or 4.0 and copy . Be sure to use the JAR file that is compatible with your JRE version to the lib directory:

    • If you are using JRE 7, install use the Sqljdbc41.jar file. This supports the JDBC 4.1 API.
    • If you are using JRE 8, install use the Sqljdbc42.jar file. This supports the JDBC 4.2. API

Once this is done, the driver class relevant to the driver you use should be updated in the master-datasources.xml file when you set up the datasource configurations. By default the master-datasources.xml file is configured with the driver class for the jtds-1.3.1.jar driver, which is net.sourceforge.jtds.jdbc.Driver. If you use the JDBC driver 6.0, 4.2, 4.1 or 4.0, you need to change driver class configuration to

Setting up datasource configurations

The connection between physical databases and the server is established through datasources. The master-datasources.xml file (stored in the <MB_HOME>/repository/conf/datasources directory) is the default datasource configuration file that is shipped with WSO2 products. In the case of WSO2 MB, since we use two databases (Carbon database for registry/user management data and the MB-specific database for storing MB data), the the master-datasources.xml file  file should contain two separate datasource configurations corresponding to the two databases.


  1. Open the <MB_HOME>/repository/conf/datasources/master-datasources.xml file. This is where datasources are configured to point to the databases used by WSO2 MB. This file consists of commented out configurations for datasources. The datasource configuration for MSSQL is among these. The changes made to this file must be done in both broker nodes.
  2. Uncomment or add the following configuration into the master-datasources.xml file. Update the JDBC URL to correctly point to your database and enter the username and password for the MSSQL database user with the proper permissions.


    Given below is the default configuration in the master-datasources.xml file. You need to update the <username> and <password> elements according to the database you created. The <driverClassName> element should be updated according to the driver you used.

    Code Block
       <definition type="RDBMS">
                        <validationQuery>SELECT 1</validationQuery>

    The elements in the above configuration are described below:

    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.


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


    Specifies whether each SQL statement should be automatically committed when it is completed. By default, this element is set to false.


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

  3. Open the <MB_HOME>/repository/conf/broker.xml file. This is the root configuration file of WSO2 MB. The changes made to this file must be done in all the MB nodes.
  4. In the broker.xml file we need to use the MSSQL message store and Andes context store. To do this, uncomment or add the following configuration.

    Code Block
      <messageStore class="">
            <property name="dataSource">jdbc/MSSQLWSO2MBStoreDB</property>
      <andesContextStore    class="">
            <property name="dataSource">jdbc/MSSQLWSO2MBStoreDB</property>

    The elements in the above configuration are described below.

    • The fully qualified name of the respective implementation class should be defined under the class attributes of messageStore and andesContextStore elements. This implementation class will be used by MB to persist relevant information.

    • The <property> elements are used to define different properties for each store. The minimal property for starting each store is the dataSource property. Depending on the implementation, the required properties may differ.