This is the latest release in the 6.x.x family. For EI 7.0.0, click here.

All docs This doc

Versions Compared

Key

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

When you use the Business Process profile in WSO2 EI, two separate databases are required for storing data specific to BPMN and BPEL. This is in addition to the default Carbon database. By default, the Business Process profile is shipped with embedded H2 databases for this purpose:

  • activiti.h2.db: For BPMN-specific data.
  • jpadb.h2.db: For BPEL-specific data.

These databases are stored in the <EI_HOME>/wso2/business-process/repository/database directory.

Info

For instructions on changing the default Carbon database, see Changing the Carbon Database in the WSO2 Product Administration Guide.

Given below are the steps you need to follow in order to change the default BPMN and BPEL databases.

Table of Contents


Setting up the database

You can set up two databases of the following types:

Creating the datasource connection

A datasource is used to establish the connection to a database. By default, datasource connections for the BPEL and BPMN databases are configured in the activiti-datasources.xml and bps-datasources.xml files respectively. These datasource configurations point to the default  H2 databases, which are shipped with the product. After setting up new databases to replace the default H2 databases, you can either change the default configurations in the above-mentioned files or configure new datasources.

Creating the datasource connection for the BPEL database

Follow the steps below.

  1. Open the <EI_HOME>/wso2/business-process/conf/datasources/bps-datasources.xml file and locate the <datasource> configuration element.

  2. You simply have to update the url pointing to your database, the username and password required to access the database. See the following examples:

    Localtab Group
    Localtab
    titleMySQL
    Code Block
    languagehtml/xml
    <datasource>
           <name>BPS_DS</name>
           <description></description>
           <jndiConfig>
               <name>jdbc/bpsds</name>
           </jndiConfig>
           <definition type="RDBMS">
               <configuration>
                   <url>jdbc:mysql://localhost:3306/jpadb</url>
                   <username>wso2carbon</username>
                   <password>wso2carbon</password>
                   <driverClassName>com.mysql.jdbc.Driver</driverClassName>
                   <maxActive>80</maxActive>
                   <maxWait>60000</maxWait>
                   <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                   <validationQuery>SELECT 1</validationQuery>
                   <validationInterval>30000</validationInterval>
     			   <defaultAutoCommit>true</defaultAutoCommit>
               </configuration>
           </definition>
    </datasource>
    Localtab
    titleMS SQL
    Code Block
    languagexml
    <datasource>
        <name>BPS_DS</name>
        <description></description>
        <jndiConfig>
               <name>jdbc/bpsds</name>
        </jndiConfig>
        <definition type="RDBMS">
               <configuration>
                  <url>jdbc:sqlserver://<IP>:1433;databaseName=jpadb</url>
                  <username>wso2carbon</username>
                  <password>wso2carbon</password>
                  <driverClassName>com.microsoft.sqlserver.jdbc.SQLServerDriver</driverClassName>
                  <maxActive>50</maxActive>
                  <maxWait>60000</maxWait>
    			  <minIdle>5</minIdle>
                  <testOnBorrow>true</testOnBorrow>
                  <validationQuery>SELECT 1</validationQuery>
                  <validationInterval>30000</validationInterval>
    			  <defaultAutoCommit>true</defaultAutoCommit>
               </configuration>
        </definition>
    </datasource>       
    Localtab
    titleOracle
    Code Block
    languagexml
    <datasource>
         <name>BPS_DS</name>
    	 <description></description>
         <jndiConfig>
             <name>bpsds</name>
         </jndiConfig>
         <definition type="RDBMS">
             <configuration>
                <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
                <url>jdbc:oracle:thin:@localhost:1521/jpadb</url>
                <maxActive>100</maxActive>
                <maxWait>60000</maxWait>
                <minIdle>5</minIdle>
                <testOnBorrow>true</testOnBorrow>
                <validationQuery>SELECT 1 FROM DUAL</validationQuery>
                <validationInterval>30000</validationInterval>
                <username>scott</username>
                <password>tiger</password>
                <defaultAutoCommit>true</defaultAutoCommit>
             </configuration>
         </definition>
    </datasource>
    Localtab
    titleIBM
    Code Block
    languagexml
    <datasource>
          <name>BPS_DS</name>
          <description></description>
          <jndiConfig>
                <name>jdbc/bpsds</name>
          </jndiConfig>
          <definition type="RDBMS">
                <configuration>
                    <url>jdbc:db2://SERVER_NAME:PORT/jpadb</url>
                    <username>regadmin</username>
                    <password>regadmin</password>
                    <driverClassName>com.ibm.db2.jcc.DB2Driver</driverClassName>
                    <maxActive>80</maxActive>
                    <maxWait>360000</maxWait>
                    <minIdle>5</minIdle>
                    <testOnBorrow>true</testOnBorrow>
                    <validationQuery>SELECT 1</validationQuery>
                    <validationInterval>30000</validationInterval>
    				<defaultAutoCommit>true</defaultAutoCommit>
                </configuration>
          </definition>
    </datasource>
    Localtab
    titleDerby
    Code Block
    languagexml
    <datasource>
         <name>BPS_DS</name>
         <description></description>
         <jndiConfig>
             <name>jdbc/bpsds</name>
         </jndiConfig>
         <definition type="RDBMS">
             <configuration>
                   <url>jdbc:derby://localhost:1527/jpadb;create=true</url>
                   <username>wso2carbon</username>
                   <password>wso2carbon</password>
                   <driverClassName>org.apache.derby.jdbc.EmbeddedDriver</driverClassName>
                   <maxActive>80</maxActive>
                   <maxWait>60000</maxWait>
                   <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                   <validationQuery>SELECT 1</validationQuery>
                   <validationInterval>30000</validationInterval>
    			   <defaultAutoCommit>true</defaultAutoCommit>
             </configuration>
         </definition>
    </datasource>
    Localtab
    titlePostgreSQL
    Code Block
    languagexml
    <datasource>
          <name>BPS_DS</name>
          <description></description>
          <jndiConfig>
                <name>jdbc/bpsds</name>
          </jndiConfig>
          <definition type="RDBMS">
                <configuration>
                    <url>jdbc:postgresql://localhost:5432/jpadb</url>
                    <username>wso2carbon</username>
                    <password>wso2carbon</password>
                    <driverClassName>org.postgresql.Driver</driverClassName>
                    <maxActive>80</maxActive>
                    <maxWait>60000</maxWait>
                    <minIdle>5</minIdle>
                    <testOnBorrow>true</testOnBorrow>
                    <defaultAutoCommit>false</defaultAutoCommit>
                    <validationInterval>30000</validationInterval>
    				<defaultAutoCommit>true</defaultAutoCommit>
               </configuration>
           </definition>
    </datasource>
     
     
  3. Optionally, you can update the configuration elements given below for your database connection.

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

    Specifies whether each SQL statement should be automatically committed when it is completed. It is recommended to disable auto committing by setting this property to true.

    Info

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

Creating the datasource connection for the BPMN database

Follow the steps below.

  1. Open the <EI_HOME>/wso2/business-process/conf/datasources/activiti-datasources.xml file and locate the <datasource> configuration element.

  2. You simply have to update the url pointing to your database, the user name and password required to access the database. See the following examples:

    Localtab Group
    Localtab
    titleMySQL
    Code Block
    languagehtml/xml
    <datasource>
           <name>ACTIVITI_DB</name>
           <description></description>
           <jndiConfig>
               <name>jdbc/ActivitiDB</name>
           </jndiConfig>
           <definition type="RDBMS">
               <configuration>
                   <url>jdbc:mysql://localhost:3306/activiti</url>
                   <username>wso2carbon</username>
                   <password>wso2carbon</password>
                   <driverClassName>com.mysql.jdbc.Driver</driverClassName>
                   <maxActive>80</maxActive>
                   <maxWait>60000</maxWait>
                   <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                   <validationQuery>SELECT 1</validationQuery>
                   <validationInterval>30000</validationInterval>
    			   <defaultAutoCommit>true</defaultAutoCommit>
               </configuration>
           </definition>
    </datasource>
    Localtab
    titleMS SQL
    Code Block
    languagexml
    <datasource>
        <name>ACTIVITI_DB</name>
        <description></description>
        <jndiConfig>
               <name>jdbc/ActivitiDB</name>
        </jndiConfig>
        <definition type="RDBMS">
               <configuration>
                  <url>jdbc:sqlserver://<IP>:1433;databaseName=activiti</url>
                  <username>wso2carbon</username>
                  <password>wso2carbon</password>
                  <driverClassName>com.microsoft.sqlserver.jdbc.SQLServerDriver</driverClassName>
                  <maxActive>50</maxActive>
                  <maxWait>60000</maxWait>
    			  <minIdle>5</minIdle>
                  <testOnBorrow>true</testOnBorrow>
                  <validationQuery>SELECT 1</validationQuery>
                  <validationInterval>30000</validationInterval>
    			  <defaultAutoCommit>true</defaultAutoCommit>
               </configuration>
        </definition>
    </datasource>       
    Localtab
    titleOracle
    Code Block
    languagexml
    <datasource>
         <name>ACTIVITI_DB</name>
    	 <description></description>
         <jndiConfig>
             <name>ActivitiDB</name>
         </jndiConfig>
         <definition type="RDBMS">
             <configuration>
                <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
                <url>jdbc:oracle:thin:@localhost:1521/activiti</url>
                <maxActive>100</maxActive>
                <maxWait>60000</maxWait>
                <minIdle>5</minIdle>
                <testOnBorrow>true</testOnBorrow>
                <validationQuery>SELECT 1 FROM DUAL</validationQuery>
                <validationInterval>30000</validationInterval>
                <username>scott</username>
                <password>tiger</password>
                <defaultAutoCommit>true</defaultAutoCommit>
             </configuration>
         </definition>
    </datasource>
    Localtab
    titleIBM
    Code Block
    languagexml
    <datasource>
          <name>ACTIVITI_DB</name>
          <description></description>
          <jndiConfig>
                <name>jdbc/ActivitiDB</name>
          </jndiConfig>
          <definition type="RDBMS">
                <configuration>
                    <url>jdbc:db2://SERVER_NAME:PORT/activiti</url>
                    <username>regadmin</username>
                    <password>regadmin</password>
                    <driverClassName>com.ibm.db2.jcc.DB2Driver</driverClassName>
                    <maxActive>80</maxActive>
                    <maxWait>360000</maxWait>
                    <minIdle>5</minIdle>
                    <testOnBorrow>true</testOnBorrow>
                    <validationQuery>SELECT 1</validationQuery>
                    <validationInterval>30000</validationInterval>
    				<defaultAutoCommit>true</defaultAutoCommit>
                </configuration>
          </definition>
    </datasource>
    Localtab
    titleDerby
    Code Block
    languagexml
    <datasource>
         <name>ACTIVITI_DB</name>
         <description></description>
         <jndiConfig>
             <name>jdbc/ActivitiDB</name>
         </jndiConfig>
         <definition type="RDBMS">
             <configuration>
                   <url>jdbc:derby://localhost:1527/activiti;create=true</url>
                   <username>wso2carbon</username>
                   <password>wso2carbon</password>
                   <driverClassName>org.apache.derby.jdbc.EmbeddedDriver</driverClassName>
                   <maxActive>80</maxActive>
                   <maxWait>60000</maxWait>
                   <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                   <validationQuery>SELECT 1</validationQuery>
                   <validationInterval>30000</validationInterval>
    			   <defaultAutoCommit>true</defaultAutoCommit>
             </configuration>
         </definition>
    </datasource>
    Localtab
    titlePostgreSQL
    Code Block
    languagexml
    <datasource>
          <name>ACTIVITI_DB</name>
          <description></description>
          <jndiConfig>
                <name>jdbc/ActivitiDB</name>
          </jndiConfig>
          <definition type="RDBMS">
                <configuration>
                    <url>jdbc:postgresql://localhost:5432/activiti</url>
                    <username>wso2carbon</username>
                    <password>wso2carbon</password>
                    <driverClassName>org.postgresql.Driver</driverClassName>
                    <maxActive>80</maxActive>
                    <maxWait>60000</maxWait>
                    <minIdle>5</minIdle>
                    <testOnBorrow>true</testOnBorrow>
                    <defaultAutoCommit>false</defaultAutoCommit>
                    <validationInterval>30000</validationInterval>
    				<defaultAutoCommit>true</defaultAutoCommit>
               </configuration>
           </definition>
    </datasource>
  3. Optionally, you can update the configuration elements given below for your database connection.

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

    Specifies whether each SQL statement should be automatically committed when it is completed. It is recommended to disable auto committing by setting this property to true.

    Info

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

Creating database tables

To create the database tables, connect to the databases that you created earlier and run the scripts provided in the product pack.

Creating database tables in the BPEL database 

Several db scripts are provided to create the necessary tables in the BPEL database:

  • Create: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpel/create directory.
  • Drop: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpel/drop directory.
  • Truncate: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpel/truncate directory.
  • Upgrade: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpel/upgrade directory.

To create the necessary database tables:

  1. Connect to the database and run the above scripts. For example, shown below is how to create data in a MySQL database.

    Code Block
    languagepowershell
    mysql -u root -p -DBPS_DS < '<EI_HOME>/wso2/business-process/dbscripts/bps/bpel/create/mysql.sql';
  2. Restart the server.

Creating database tables in the BPMN database 

Several db scripts are provided to create the necessary tables in the BPMN database:

  • Create: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpmn/create directory.
  • Drop: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpmn/drop directory.
  • Metadata: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpmn/metadata directory.
  • Upgrade: These scripts are stored in the <EI_HOME>/wso2/business-process/dbscripts/bps/bpmn/upgrade directory.

To create the necessary database tables:

  1. Connect to the database and run the above scripts. For example, execute the following scripts to create data in a MySQL database.

    • activiti.mysql.create.engine.sql

    • activiti.mysql.create.history.sql

    • activiti.mysql.create.identity.sql
    • activiti.mysql.create.substitute.sql

    Shown below is how the script for creating identity data is executed:

    Code Block
    languagepowershell
    mysql -u root -p -DBPS_DS < '<EI_HOME>/wso2/business-process/dbscripts/bps/bpmn/create/activiti.mysql.create.identity.sql';
  2. Restart the server.

Create database tables when the server starts

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

  • For Windows: <EI_HOME>/wso2/business-process/bin/wso2server.bat -Dsetup

  • For Linux: <EI_HOME>/wso2/business-process/bin/wso2server.sh -Dsetup

Excerpt
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:

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

      Note to writers: For step 3, add content on the XML files which include references on any of the additional databases and require edits that are relevant to your product similar to the given example.