This documentation is about a version that is out of support, here is the latest documentation version.

How about downloading a newer, supported version?

Bonita Deploy bundle

Description on how to install Bonita Runtime on an existing and already installed Java EE Application Server like Tomcat or WildFly.

What is the purpose of the Bonita Deploy bundle?

  • The Bonita Deploy bundle is used if you have already installed a Java EE Application Server.

  • The Bonita Deploy bundle is a way of setting up a Bonita Platform. You’ll be able to get a setup quite similar to WildFly or Tomcat bundle.

  • It’s also used to package other tools such as the LDAP synchronizer.

This installation procedure only specifically targets the Java EE application Servers that have been installed under a single root folder (typically, from a .zip file). Thus, for installations using native distribution packages (that more often than not split the binaries and the configuration files into separate folder hierarchies), it would be up to you to adapt the documented steps to your very own folder layout.

Deploy bundle content

  • `Tomcat-``version`: a folder/file structure to be merged with an existing setup of Apache Tomcat, in order to install Bonita Portal and Bonita Engine.

  • `Wildfly-``version`: a folder/file structure to be merged with an existing setup of WildFly in order to install Bonita Portal and Bonita Engine.

  • setup: a command-line tool that creates the Bonita Platform before it can be run. It creates the Bonita Platform internal database, and stores the runtime configuration. It is useful to update the configuration, locally or from a remote computer.

  • `Request_key_utils-``key_utils.version`: include script files to generate license request keys.

  • BonitaSubscription-LDAPSync.version-LDAP-Synchronizer : LDAP synchronizer to synchronize your organization in Bonita with your LDAP

  • cas-``cas.version`-module`: Module files and description to enable CAS dependency to bonita EAR.

  • License: license files that apply to Bonita components.

  • README.TXT: See this file for more details about the deploy.zip contents and structure.

Installation

  1. Download the deploy.zip file from the Bonitasoft download page for the Community edition or from the Customer Portal for Subscription editions.

  2. Unzip the deploy.zip into a temporary folder (DEPLOY_ZIP_HOME).

  3. Follow the Tomcat bundle steps or WildFly bundle steps

Tomcat installation

Install Bonita Platform in Tomcat

Copy all files and directories from DEPLOY_ZIP_HOME/Tomcat-8.5.23/server to your Tomcat root directory (TOMCAT_HOME).

Some configuration files from the deploy zip will overwrite some default tomcat configuration files. Proceed with care in a tomcat where other applications are already installed.

There is an issue on tomcat 8.0.32 preventing the portal Look & feel to be compiled. If you deploy bonita on an existing tomcat installation, make sure it is a different version of tomcat (preferably 8.5.x with x>=23).

Configure data sources

Configuration of data source for Tomcat is split in two parts: because Tomcat doesn’t support JTA natively, one data source will be configured in the Bitronix configuration file and the other data source will be configured in the standard Tomcat context configuration file.

Non-transactional data source

  1. Open the file TOMCAT_HOME/conf/Catalina/localhost/bonita.xml

  2. For Bonita Standard data source, remove or comment out the lines regarding the h2 database.

  3. Uncomment the lines matching your RDBMS.

  4. Update following attributes value:

    • username: your RDBMS user name.

    • password: your RDBMS password.

    • url: the URL, including the RDBMS server address, RDBMS server port and database (schema) name.

  5. Repeat operations 2. to 4. for Business Data data source

JTA data source (managed by Bitronix)

  1. Open the file TOMCAT_HOME/conf/bitronix-resources.properties

  2. For Bonita Standard data source, remove or comment out the lines regarding the h2 database.

  3. Uncomment the lines matching your RDBMS and edit values for each settings (resource.ds1.*) according to your database installation.

  4. Repeat operations 2. and 3. for Business Data data source (resources.ds2.*)

Configure RDBMS vendor

  1. Open the file TOMCAT_HOME/bin/setenv.(bat

    sh)

  2. Change the value of sysprop.bonita.db.vendor according to your RDBMS vendor

  3. Change the value of sysprop.bonita.bdm.db.vendor according to your RDBMS vendor

Add Jdbc driver

You need to add your jdbc driver in TOMCAT_HOME/lib. MySQL and PostgreSQL drivers can be found in deploy bundle under DEPLOY_ZIP_HOME/setup/lib directory. For other RDBMS, use the jdbc driver provided by your RDBMS vendor

Wildfly installation

Install Bonita Platform in Wildfly

Copy all files and directories from DEPLOY_ZIP_HOME/wildfly-10.1.0.Final/server to your Wildfly root directory (WILDFLY_HOME).

Configure data sources

  1. Open the file WILDFLY_HOME/standalone/configuration/standalone.xml

  2. For Bonita Standard data source, remove or comment out the default definition for h2.

  3. Uncomment the settings matching your RDBMS vendor.

  4. Modify the values of the following settings to your configuration: server address, server port, database name, user name and password.

  5. Repeat operations 2. to 4. for Business Data data source

Configure RDBMS vendor

  1. Open WILDFLY_HOME/standalone/configuration/standalone.xml and look for system-properties tag

  2. Set the value for sysprop.bonita.db.vendor (Bonita Platform database vendor)

  3. Set the value for sysprop.bonita.bdm.db.vendor (Business Data database vendor)

Add Jdbc driver

  1. Create a folder structure under WILDFLY_HOME/modules folder. Refer to the table below to identify the folders to create. The last folder is named main for all JDBC drivers.

Database vendor Module folders Module description file

PostgreSQL

modules/org/postgresql/main

module.xml

Oracle

modules/com/oracle/main

module.xml

SQL Server

modules/com/sqlserver/main

module.xml

MySQL

modules/com/mysql/main

module.xml

  1. Put the driver jar file in the relevant main folder.

  2. In the same folder as the driver, add the module description file, module.xml. This file describes the dependencies the module has and the content it exports. It must describe the driver jar and the JVM packages that Wildfly does not provide automatically. The exact details of what must be included depend on the driver jar. Caution: you might need to edit the module.xml in order to match exactly the JDBC driver jar file name.

License installation

If you are installing a Subscription edition, you need to request a license.

When you receive your license, copy the file to the DEPLOY_ZIP_HOME/setup/platform_conf/licenses folder of your application server.

Database initialization

We assume here that the database has already been created and configured for Bonita. Once created and configured you need to initialize it using the setup tool provided in the deploy bundle archive. This will create database schema and initial values.

  1. In DEPLOY_ZIP_HOME/setup folder, edit the file database.properties with properties matching your rdbms. Beware of backslash characters.

  2. In DEPLOY_ZIP_HOME/setup/lib add your jdbc driver if needed (only for Microsoft SQL Server or Oracle, see proprietary jdbc drivers)

  3. In DEPLOY_ZIP_HOME/setup folder, run setup.(sh|bat) init

Next steps

You’re done with Bonita installation. You can now start your application server as usual. When you have finished installing the deploy bundle, complete the setup of your system by validating the installation, setting passwords, and creating the Administrator user.