Embed Bonita Engine in your application

bonita lab

This is a Lab feature and is subject to change without warning in any version. It is not recommended for production.

Starting from version 7.9.0, new artifacts allow to start an embedded engine in your application.

Using Spring Boot

Quick start

Add a dependency on the artifact

Gradle

dependencies {
    implementation("org.bonitasoft.engine:bonita-engine-spring-boot-starter:$engineVersion")
}

Maven

<dependency>
    <groupId>org.bonitasoft.engine</groupId>
    <artifactId>bonita-engine-spring-boot-starter</artifactId>
    <version>${bonita.engine.version}</version>
</dependency>

If you are using Bonita subscription edition, change group id for com.bonitasoft.engine and artifact id for bonita-engine-spring-boot-starter-sp

This will embed and start Bonita Engine when your application starts. Also a spring bean org.bonitasoft.engine.api.APIClient will be available and injected in your Spring beans. (com.bonitasoft.engine.api.APIClient if you are using subscription edition).

Configuration

Configuration uses the standard Spring Boot mechanism. The easiest way is to put them in your application.properties file.

All existing configuration can be found by your IDE using the completion in the application.properties file. These configuration properties have as prefix org.bonitasoft.engine and com.bonitasoft.engine

For now, only the following configuration is supported:

the database connection settings for Bonita Engine
the database connection settings for business data
the size of the connection pools for the above databases

In subscription edition, the url of the license can be configured using com.bonitasoft.engine.license-file-url

All other configuration can be customized using the standard bonita configuration tool Platform setup tool

Example

An example can be found in the bonita-examples github repository.

Programmatically

If you do not wish to use Spring Boot, the integration can be done manually.

Quick start

Add a dependency on the following artifact

Gradle

dependencies {
    implementation("org.bonitasoft.engine:bonita-engine-standalone:$engineVersion")
}

Maven

<dependency>
    <groupId>org.bonitasoft.engine</groupId>
    <artifactId>bonita-engine-standalone</artifactId>
    <version>${bonita.engine.version}</version>
</dependency>

If you are using Bonita subscription edition, change group id for com.bonitasoft.engine and artifact id for bonita-engine-standalone-sp

You can create a new instance of the engine like bellow

import org.bonitasoft.engine.BonitaEngine;
import org.bonitasoft.engine.api.APIClient;

//create the engine
BonnitaEngine engine = new BonitaEngine();

//start the engine
engine.start();

//create a client to use it
APIClient client = new APIClient()

If you are using subscription edition, use com.bonitasoft.engine.BonitaEngineSP and com.bonitasoft.engine.api.APIClient objects instead.

Configuration

Configuration can be done programmatically on the BonitaEngine instance:

engine.setBonitaDatabaseConfiguration(BonitaDatabaseConfiguration.builder()
                .dbVendor("postgres")
                .url("jdbc url of the database")
                .user("user to use")
                .password("password to use")
                .build());
engine.setBusinessDataDatabaseConfiguration(BonitaDatabaseConfiguration.builder()
                .dbVendor("mysql")
                .url("jdbc url of the database")
                .user("user to use")
                .password("password to use")
                .build());
//Subscription only
engine.setLicenseFileURL(/* url to the license file*/)

See Javadoc for more details.

Example

An example can be found in the bonita-examples github repository.

Known limitations

The portal cannot be used with the embedded engine due to missing web resources when initializing the engine. This will be fix in future versions.