Skip to main content

License File Renewal

This document provides step-by-step instructions for renewing the license file of the Flowable products: Flowable Work, Flowable Design, and Flowable Control.

Flowable offers two methods to use the license, and we will cover both approaches in this guide.

Determine Storage Approach​

To determine which approach is used, use the following properties:

  • Flowable Work: flowable.license.db-store-enabled
  • Flowable Design: flowable.design.db-store-enabled (or flowable.modeler.app.db-store-enabled for Flowable Design 3.13 and the 3.14 Angular-based Flowable Design)
  • Flowable Control: flowable.control.app.db-store-enabled

If this property set to true, the database-based licenses are used. If it is false, the file-based licenses are used.

In case the property is not set, the default for the Flowable Docker images is true. For all other packages the default is false.

Renewing the License when using file-based licenses​

If you have been using the license as a file stored on the file system, you need to follow different steps depending on the Flowable product you are using.

Flowable Work​

To renew the license for Flowable Work, you need to follow these steps:

  1. Check the current license location: Review the property flowable.license.location to determine the location of the existing license file. This property specifies the file path of the license for Flowable Work.

  2. Obtain the new license file: Contact your Flowable CSM (or sales representative) to acquire the renewed license file for Flowable Work. Ensure you have the new license file in the appropriate format and that it has not been altered.

  3. Replace the old license file: Once you have obtained the new license file, replace the existing license file at the location specified in flowable.license.location. Make sure the new file is correctly named as specified by the property.

  4. Restart the application server: To activate the renewed license, restart the application server that hosts Flowable Work and the new license becomes active.

Flowable Design and Flowable Control​

To renew the license for Flowable Design, you need to follow the same steps as described above for Flowable Work.

The only difference are the respective properties:

  • For verifying that the Flowable database license storage is disabled, please use flowable.design.db-store-enabled (or flowable.modeler.app.db-store-enabled for Flowable Design 3.13 and the 3.14 Angular-based Flowable Design)

  • For verifying the license location, please use flowable.design.license-location (or flowable.modeler.app.license-location for Flowable Design 3.13 and the 3.14 Angular-based Flowable Design)

The same applies for Flowable Control and the only difference are the respective properties:

  • For verifying that the Flowable database license storage is disabled, please use flowable.control.app.db-store-enabled

  • For verifying the license location, please use flowable.control.app.license-location

Renewing the License using database-based licenses​

If you have been using the license as a database-stored license, the renewal process is streamlined.

The steps vary based on whether all applications point to the same database schema or different database schemas.

If all applications (Flowable Work, Flowable Design and Flowable Control) point to the same database schema, renew the license for any one application, and it will be automatically available to all applications without any further action or server restart.

As an example, the license renewal process for Flowable Control can be completed as follows:

  1. Open Flowable Control
  2. Click on the user avatar on the bottom left corner
  3. Click on Settings; you will see your "old license" information here
  4. Click on the Upload button
  5. Upload the new license file (ensure you have the new license file in the appropriate format and it has not been altered)
  6. Verify the new license information is shown

If the applications point to different databases, you need to follow the renewal procedure for each application (Flowable Work, Flowable Design and Flowable Control) separately.