Note |
---|
Restricted access to nilmini@wso2.com |
When you use the Message Broker Business Process profile in WSO2 EI, a two separate database is databases are required for storing data specific to the brokerBPMN and BPEL. This is in addition to the default /wiki/spaces/ADMIN5xx/pages/22151545 default Carbon database. By default, the EI Message Broker Business Process profile is shipped with an embedded H2 database (WSO2MB_DB.ht.db
) for this purpose. databases for this purpose:
- activiti.h2.db: For BPMN-specific data.
- jpadb.h2.db: For BPEL-specific data.
These databases are stored in the in the <EI_HOME>/wso2/brokerbusiness-process/repository/database
directory.
Info |
---|
For instructions on changing the default Carbon database, see /wiki/spaces/ADMIN5xx/pages/22151545 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 broker-specific databaseBPMN and BPEL databases.
Table of Contents |
---|
...
Setting up the database
You can set up one of the following databases for storing broker-specific data:
- Setting up a MySQL database
- Setting up an MS SQL database
- Setting up an Oracle database
- Setting up an IBM DB2 database
- Setting up a Derby database
- Setting up an PostgreSQL database
Creating the datasource connection
A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB
datasource is configured in the master-
datasources.
xml file for the purpose of connecting to the default H2 database, which stores registry and user management data. After setting up the MySQL database 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 databasedatabases, you can 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.in the above-mentioned files or configure new datasources.
Creating the datasource connection for the BPEL database
Follow the steps below to change the type of the default WSO2_CARBON_DB
datasource.
Open the <EI
_HOME>/wso2/brokerbusiness-process/conf/datasources/m
aster
file and locate thebps-
datasources.xml
<datasource>
configuration element<datasource>
configuration element.You simply have to update the url pointing the url pointing to your MySQL database, the username and the username and password required to access the database and the MySQL driver details as shown below.
Localtabgroup Localtab title MySQL Code Block language html/xml <datasource> <name>WSO2<name>BPS_CARBON_DB<DS</name> <description>The datasource used for registry and user manager<<description></description> <jndiConfig> <name>jdbc/WSO2CarbonDB<bpsds</name> </jndiConfig> <definition type="RDBMS"> <configuration> <url>jdbc:mysql://localhost:3306/regdb<jpadb</url> <username>regadmin<<username>wso2carbon</username> <password>regadmin<<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 title MS SQL Code Block language xml <datasource> <name>WSO2_MB_STORE_DB<<name>BPS_DS</name> <jndiConfig> <description></description> <jndiConfig> <name>WSO2MBStoreDB</name> </jndiConfig> <definition type <name>jdbc/bpsds</name> </jndiConfig> <definition type="RDBMS"> <configuration> <configuration> <url>jdbc:jtds:sqlserver://localhost<IP>:1433/wso2_mb</;databaseName=jpadb</url> <username>sa<<username>wso2carbon</username> <password>sa<<password>wso2carbon</password> <driverClassName>com.microsoft.sqlserver.jdbc.SQLServerDriver</driverClassName> <maxActive>200<<maxActive>50</maxActive> <maxWait>60000</maxWait> <minIdle>5</minIdle> <testOnBorrow>true</testOnBorrow> <validationQuery>SELECT 1</validationQuery> <validationInterval>30000</validationInterval> <defaultAutoCommit>true</defaultAutoCommit> </configuration> </definition> <defaultAutoCommit>false<</defaultAutoCommit>datasource> </configuration> </definition> </datasource>
Localtab title Localtab title Oracle Code Block language xml <datasource> <name>WSO2_MB_STORE_DB<<name>BPS_DS</name> <description></description> <jndiConfig> <name>WSO2MBStoreDB<<name>bpsds</name> </jndiConfig> <definition type="RDBMS"> <configuration> <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName> <url>jdbc:oracle:thin:@localhost:1521/orcl<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>false<<defaultAutoCommit>true</defaultAutoCommit> </configuration> </definition> </datasource>
Optionally, you can update the configuration elements given below for your database connection.
Element Description url The URL of the database. The default port for MySQL is 3306 username and password The name and password of the database user driverClassName The class name of the database driver maxActive The 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. 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. You can enter zero or a negative value to wait indefinitely. minIdle The 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. validationQuery The SQL query that will be used to validate connections from this pool before returning them to the caller. validationInterval 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. Info For more information on other parameters that can be defined in the
<EI_HOME>/wso2/broker/conf/
datasources/master-datasources.xml
file, see Tomcat JDBC Connection Pool.
Updating other configuration files
- Open the
<EI_HOME>/wso2/broker/conf/broker.xml
file. This is the root configuration file of the EI Message Broker profile. The changes made to this file must be done in all the broker nodes. In the
broker.xml
file we need to use the Oracle message store and Andes context store. To do this, uncomment or add the following configuration.Code Block language xml ... <messageStore class="org.wso2.andes.store.rdbms.RDBMSMessageStoreImpl"> <property name="dataSource">WSO2MBStoreDB</property> </messageStore> <andescontextStore class="org.wso2.andes.store.rdbms.RDBMSAndesContextStoreImpl"> <property name="dataSource">WSO2MBStoreDB</property> </andescontextStore>
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
andandesContextStore
elements. This implementation class will be used by the broker to persist relevant information.The
<property>
elements are used to define different properties for each store. The minimal property for starting each store is thedataSource
property. Depending on the implementation, the required properties may differ.
Creating database tables
To create the database tables, connect to the database that you created earlier and run the following scripts:
...
title | MySQL |
---|
To create the database tables, connect to the database that you created earlier and run the following scripts.
To create tables in the broker-specific database (WSO2_MB
), use the below script:
...
Localtab title IBM Code Block language xml <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 title Derby Code Block language xml <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 title PostgreSQL Code Block language xml <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>
Optionally, you can update the configuration elements given below for your database connection.
Element Description maxActive The 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. 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. You can enter zero or a negative value to wait indefinitely. minIdle The 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. validationQuery The SQL query that will be used to validate connections from this pool before returning them to the caller. validationInterval 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. defaultAutoCommit Specifies whether each SQL statement should be automatically committed when it is completed. It is recommended to disable auto committingby 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.
Open the <EI
_HOME>/wso2/business-process/conf/datasources/
file and locate theactiviti-
datasources.xml
<datasource>
configuration element.You simply have to update theurlpointing to your database, theusernameand password required to access the database and the driver details as shown below.
Localtabgroup Localtab title MySQL Code Block language html/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 title MS SQL Code Block language xml <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 title Oracle Code Block language xml <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 title IBM Code Block language xml <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 title Derby Code Block language xml <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 title PostgreSQL Code Block language xml <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>
Optionally, you can update the configuration elements given below for your database connection.
Element Description maxActive The 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. 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. You can enter zero or a negative value to wait indefinitely. minIdle The 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. validationQuery The SQL query that will be used to validate connections from this pool before returning them to the caller. validationInterval 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. defaultAutoCommit Specifies whether each SQL statement should be automatically committed when it is completed. It is recommended to disable auto committingby 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:
Connect to the database and run the above scripts. For example, shown below is how to create data in a MySQL database.
Code Block language powershell mysql -u root -p -
...
Restart the server.
...
You can create database tables automatically when starting the product for the first time by using the -Dsetup
parameter as follows:
...
DBPS_DS < '<EI_HOME>/wso2/
...
business-process/
...
For Linux: <EI_HOME>/wso2/broker/bin/wso2server.sh -Dsetup
Localtab | ||||
---|---|---|---|---|
| ||||
To create the database tables, connect to the database that you created earlier and run the following scripts.
|
...
title | Oracle |
---|
To create the database tables, connect to the database that you created earlier and run the following scripts in SQL*Plus:
...
dbscripts/bps/bpel/create/mysql.sql';
- Restart the server.
Creating database tables in the BPMN 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. - Metadata: These scripts are stored in the
<EI_HOME>/wso2/business-process/dbscripts/bps/bpel/metadata
directory. - Upgrade: These scripts are stored in the
<EI_HOME>/wso2/business-process/dbscripts/bps/bpel/upgrade
directory.
To create the necessary database tables:
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 language powershell
...
mysql -u root -p -DBPS_DS < '<EI_HOME>/wso2/
...
business-process/dbscripts
...
/bps/bpmn/create/activiti.mysql.create.identity.sql';
- 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 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
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 The topics above show how to change the
|