ActiveVOS Server and Resource Configuration
This section leads you through configuration of the resources required for ActiveVOS Server. You must configure your database, application server and ActiveVOS Server before deploying and running ActiveVOS. The sections below provide information for completing the configuration.
Configuring a JDBC Data Source
To configure a JDBC Datasource within WebSphere, perform the following steps:
- Navigate to JDBC Providers under Resources.
- Select Create a New Database Provider.
- Select either a known database provider type (e.g., DB2 Universal JDBC Driver Provider) or create a new user defined provider
(i.e., User-defined JDBC Provider).
The table below provides information on the parameters that must be filled in. - ${DB2_JDBC_DRIVER_PATH}/db2jcc.jar
- ${DB2_JDBC_DRIVER_PATH}/db2jcc_license_cu.jar
- DB2= com.ibm.db2.jcc.DB2ConnectionPoolDataSource
- mySQL = com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource
- Apply changes.
- Select the Data Sources link under Additional Properties.
- Create a new data source. The table below describes the properties and associated values:
- Apply changes.
- Select Additional Properties then Connection Pool.
- Set the Min Connections and the Max Connections. The suggested values are min = 10 and max = 50.
- Select the link J2EE Connector Architecture (J2C) authentication data entries from the DataSource definition page.
- Create a database authorization alias to be used during EAR deployment. You should use ActiveVOSDBAlias as the name of the alias.
- Provide the user name and password to access the database.
- Press OK to return to the Data Source configuration page.
- Select Additional Properties then Connection Pool.
- Select Custom Properties and add/modify the property values as required. The table below provides examples of the properties and associated values for DB2 and MySQL:
- Save the changes.
- Test the newly created connection.
- Provide the user name and password to access the database.
| Parameter | Value |
|---|---|
|
Name |
User defined or the value from the drop-down list |
|
Description |
User defined |
|
Classpath |
The classpath for the jar(s) that contain the JDBC Driver for example: |
|
Implementation Classname |
The implementation name for the data source, for example |
| Property | Value |
|---|---|
|
Name |
ActiveVOS DataSource |
|
JNDI Name |
jdbc/ActiveVOS |
|
Data store helper classname |
com.ibm.websphere.rsadapter.GenericDataStoreHelperClasspath |
| Property | DB2 Value | MySQL Value |
|---|---|---|
|
databaseName |
ABPEL |
ActiveVOS |
|
serverName |
host name where DB2 installed |
host name where DB2 installed |
|
portNumber |
50000 |
3306 |
|
user |
db user name |
db user name |
|
password |
db password |
db password |
|
useUnicode |
N/A |
true |
|
characterEncoding |
N/A |
UTF-8 |
|
characterSetResults |
N/A |
utf8 |
Configuration Instructions
Before running the Configuration utility, perform the following pre-configuration steps:
- Create a database (or tablespace) where ActiveVOS persistence information will be stored
- Create a default user with administrative rights to the computer and database for use by ActiveVOS Server
- Configure a JDBC Data Source as described above.
First Time or New Install
If you are performing a clean installation, that is, a first-time install or a new database, you can use the Configuration utility to automatically install the database schema.
Manual Install or Update of Database Schema
It is strongly recommended that you automatically install the database schema; however, you can manually install it. Customers migrating from an earlier version should follow the instructions below.
Migrating from an earlier release of ActiveVOS
If you are migrating from an earlier release of ActiveVOS Server, perform the following steps:
- Manually update the ActiveVOS database schema using the DDL patches provided in
{install_dir}/server/websphere_config/ddls/updates - Run the Configuration utility
ActiveVOS Server can be configured to use an RDBMS database
- Use the Relational Database Schemas section for information on relational databases
Relational Database Schemas
These instructions are generalized to make sure they can be followed for each database. When creating the database schema for ActiveVOS, you can either create a new database definition or upgrade an existing definition.
- Refer to the install a new database schema section for a new installation.
- Refer to upgrade a database schema when performing a version upgrade.
Install a new database schema
- Identify your DDL. Use the information provided in the table below to locate the correct DDL file.
- Copy the DDL file from above, and rename it.
- (Optional) Modify the database name.Be sure to see the notes above.
- Execute the DDL script.
| Database Server | DDL File Name and Location | Notes |
|---|---|---|
|
MYSQL |
{install_dir}/server/websphere_config/ddls/ActiveBPEL-Enterprise-MYSQL.SQL |
The default database name, ActiveVOS is defined within the DDL file. If you edit this name, ensure that you do not replace ActiveVOS Enterprise, a name that is inserted into the AeMetaInfo table. |
|
MS SQL SERVER |
{install_dir}/server/websphere_config/ddls/ActiveBPEL-Enterprise-SQLSERVER.SQL |
The default database name, ActiveVOS is defined within the DDL file. If you edit this name, ensure that you do not replace ActiveVOS Server, a name that is inserted into the AeMetaInfo table. |
|
ORACLE |
{install_dir}/server/websphere_config/ddls/ActiveBPEL-Enterprise-ORACLE.SQL |
Create a tablespace prior to running the DDL. |
|
DB2 |
{install_dir}/server/websphere_config/ddls/ActiveBPEL-Enterprise-DB2.SQL |
Note: The original files must remain unchanged for the Configuration utility to work properly
Each database server provides its own mechanism or utility for executing a DDL script file. Execute the DDL script file using the appropriate utility. For example, if you are using Oracle, the utility to execute the DDL script file would be SQL Plus.
Upgrade an existing database schema
To upgrade your existing ActiveVOS database to be compatible with the new version of software, follow the instructions below:
- Shutdown ActiveVOS before executing a database upgrade.
- Identify your current running version of ActiveVOS. Database upgrades are provided to upgrade from one version back at a time. This means that more than one upgrade script may need to be applied to your database.
- For each upgrade that needs to be applied perform the following:
- Identify your DDL. Use the information provided in the table below to locate the correct DDL file. Note: The updates must be applied in ascending order.
- Modify the database name.
- Open the appropriate DDL for your database server in a text editor.
- Replace the first three instances of the text ActiveVOS with the preferred database name. Note: Be sure not to replace the ActiveVOS Enterprise that is inserted into the AeMetaInfo table or the ActiveVOS Server will not start.
- Execute the DDL script.
| Database Server | DDL File Name and Location |
|---|---|
|
MYSQL |
{install_dir}/server/websphere_config/ddls/updates/ActiveBPEL-Enterprise-MYSQL-PATCH-{patch number}.SQL |
|
MS SQL SERVER |
{install_dir}/server/websphere_config/ddls/updates/ActiveBPEL-Enterprise-SQLSERVER-PATCH-{patch number}.SQL |
|
ORACLE |
{install_dir}/server/websphere_config/ddls/updates/ActiveBPEL-Enterprise-ORACLE-PATCH-{patch number}.SQL |
|
DB2 |
{install_dir}/server/websphere_config/ddls/updates/ActiveBPEL-Enterprise-DB2-PATCH-{patch number}.SQL |
Make sure that the database name in the patch matches the database as you originally created it. To modify the name to match the installed database use the following steps.
Each database server provides its own mechanism or utility for executing a DDL script file. Execute the DDL upgrade script file using the appropriate utility. For example, if you are using Oracle, the utility to execute the DDL script file would be SQL Plus.
Using the Configuration Utility
The Configuration utility walks through the steps required to provide the property values for ActiveVOS and selected resources.
Note: Before running the utility, ensure that your server container is stopped.
Starting the Configuration Utility
Execute one of the following utilities based on your operating system:
| Platform | Executable |
|---|---|
|
Windows |
{install_dir}/server/websphere_config/bin/config_deploy.bat |
|
Linux |
{install_dir}/server/websphere_config/bin/config_deploy.sh |
If You Have Manually Installed or Updated the Database Schema
If you have manually installed or updated the database schema, when prompted, you must not select the "Install Database Schema" checkbox.
Running the Configuration Utility in Different Modes
The Configuration utility can be run with a graphical interface (default), in console mode or silently. When you run the utility your configuration options are automatically written to the install.properties file and they will be used as the defaults the next time the application is configured. One of the following parameters is accepted by the Configuration utility:
- Help:
help. This option displays the usage for console and silent modes. - Console mode:
console. Runs the Configuration utility in text mode within a command window. - Silent mode:
silent. Runs in the background requiring no user interaction. This option requires that you have already run the Configuration utility in default mode, which sets configuration options in the install.properties file.
An example of running the Configuration utility from the command line is: config_deploy help
Configuration Help
The Configuration utility contains online help for each panel of the utility. Access Help by clicking the Help button on each panel. Additionally
you can access the help from {install_dir}/server-enterprise/websphere_config/doc/html/config.
Configuring a JMS Messaging Service
You can configure a JMS Messaging Service in ActiveVOS in order to communicate with external clients and services over JMS. To set up a listener on a JMS queue or topic, you must deploy a message-driven bean.
For details, refer to the JMS Messaging Service help topic from the Help link in the ActiveVOS Server Console.
Copyright © 2004 - 2009 Active Endpoints, Inc.