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

How about downloading a newer, supported version?


This page explains how to manage your license for the Bonita Platform: generate a request key, get the license file and install it.

For Subscription editions only.

Bonita 7.7 supports the Enterprise licensing model in addition to the Case-based and CPU-based licensing.

The License menu in Bonita Applications displays information about the current license. This information is available to the platform administrator only.

The license for Bonita Studio is managed through a wizard when you start the studio for the first time after installation (or after the previous license expires).

Case-counter licensing

A case-counter license defines the maximum number of cases (process instances) that the platform is permitted to start in the counter period.
The counter period is typically one year and starts when your Subscription starts or on the anniversary.
Each time a case starts, the case counter is increased by one.
Case-counter licenses are available for development and for production. A development license must not be used for production, and typically has a lower case limit than a production license.
The maximum number of cases is defined in your commercial contract, in discussion with your sales person.

For Case-based licensing, you can monitor the case counter using Bonita Portal License page in the Administrator profile, or using the REST API to create a custom monitoring / alerting tool.
Those two means also allow you to check the expiration date of the license.

When the case counter reaches the limit set in the license, no more cases can be started. Active cases continue until completion. If a user tries to submit an instantiation form after the case counter maximum limit is reached, the form is not submitted and an error message is displayed.

Get a new license

Your contract with Bonitasoft specifies the details of the subscription you have purchased, including the edition, and case limit for case-counter licensing. A license matching the subscription details is generated on request.

If this is a license renewal, you can find your request key in the Bonita Portal License menu of the Administrator profile or using the platform REST API.
A request key looks like this: (CIVpYDRB8bhouXdWadLY1M9TVctwYUYuv7ou7sqeIrSUSuCqUIkjQAs0ZGgzbtqv3gguFOHlyMZkyvwdr4HLgg==).

If this is the first time you generate a license, you need to generate a request key.

Generate the request key

On the server where you installed Bonita Platform:

  1. Go to the tools/request_key_utils folder

  2. Run the generateRequestKey.bat script (for Windows) or the script (for other operating systems)

Generate the new license

Copy your request key and go to the Customer Service Center license request page.
Then fill in the details in the form, copy the request key in the Request Key field, and submit.
Note: keep the brackets () in the key; if the key is separated by a line break, remove it and put the key on a single line.

The license file will be sent to you by email.

Install the license for the very first time

If the application server has never been started before (i.e. this is the first time you start the bundle), when you receive the license file (.lic file extension), store the file into the <TOMCAT_HOME>/setup/platform_conf/licenses folder before starting the bundle.

Renew or replace a license

If the application server has already been started successfully at least once and you need to install a new license because the one already installed has expired or is no longer valid:

  • Download the configuration on the disk

      cd setup
      ./ pull
      ls -l ./platform_conf/licenses/
  • If the new license is already valid (i.e. its Start Date has already come): delete all license files that may be located in the <TOMCAT_HOME>/setup/platform_conf/licenses directory.

  • Store the new license file in the <TOMCAT_HOME>/setup/platform_conf/licenses directory.

  • Save the configuration into the database

      ./ push
  • Restart the application server

License renewal scheduling

If you are still within the Subscription period when you approach the license expiration date, request a new license that starts on the last day of your current license.
Use the Platform setup tool to pull the existing configuration from the database. Put the license you receive in the license folder alongside the existing license. Use the Platform setup tool to push your license file to database. Don’t forget to restart your application server after pushing the license to the database.

When you reach the "changeover" date for the licenses, Bonita Engine switches automatically from the expired license to the valid one. Note: We recommend to regularly remove license files of expired licenses from the server.

If you approach both the license expiration date and the end of the Subscription period, contact your sales person.

For Case-based licensing, the case counter will be reset at the end of the counter period.
If your license expiration date comes before the end of the counter period, get and install a new license as usual. The case counter will continue from its current value under the new license. If you approach or reach the case counter limit before the end of the license period, contact your sales person to get a new license with additional cases.