System Management

The System Settings menu gives you some general information about the process engine and allows you to access the Execution Metrics and, provided that you are using the Enterprise Edition of the Camunda Platform, you can insert your License Key

Accessing the System Settings menu

The System Settings menu is only usable by users which are granted with All permission for authorizations.

Execution Metrics

The Execution Metrics menu in Admin displays an approximate number of Flow Nodes Instances (FNI), Executed Decision Elements (EDE), Root Process Instances (RPI) and Executed Decision Instances (EDI) processed by the engine and Unique Task Workers (UTW) that were assigned to a user task in the selected time range.

Camunda License Key

Enterprise Feature

Please note that this feature is only included in the enterprise edition of the Camunda Platform, it is not available in the community edition.

Check the Camunda enterprise homepage for more information or get your free trial version.

Some features (enterprise plugins) require a license key. The license will be provided as a string by the Camunda support team. The license mechanism has no impact on the engine or other runtime components. The following section explains how to activate a license.

Whenever you see one of the following messages, a valid license key must be entered.

If you have administrator authorizations, insert your company’s license key for the Camunda Platform and view some License Key details such as the Company Id and the validity of the license key. The Admin system setting menu offers the possibility to enter additional licenses, for instance when your existing license is expiring and you want to enter a new license key.

If you do not have administrator authorizations, please contact your administrator so that they can enter the license.

In case you are running Camunda Platform locally, you can use this URL to enter the license key: http://localhost:8080/camunda/app/admin/default/#/system?section=system-settings-license

The license key can be set via the Java API by calling:

managementService.setLicenseKey(String licenseKey);

The managementService also offers methods to get and delete the license key from the database. The license key is stored in the ACT_GE_BYTEARRAY table. A reference to the license entry can be found in the ACT_GE_PROPERTY table (camunda-license-key-id).

Another possibility is to put the file with the license key in path: ${user.home}/.camunda/license.txt. It will be automatically loaded to the database table unless it already contains some license key.

In a clustered scenario, where multiple engines on multiple nodes access a single database, the license only needs to be activated once. When activated, a license is valid until the expiration date or until you have deleted your database. The license key is valid for an unlimited amount of engines.

In a multi tenancy scenario, the license check will be performed for each engine with an own database. Thus, you will be prompted to enter the license key separately for each engine.

License keys in camunda-spring-boot-starter

Spring Boot applications can provide license keys in two additional ways:

  • provide a URL to a license file via spring property
  • provide the license key in a file called camunda-license.txt which is on the classpath of the application

Note: The application must use the camunda-bpm-spring-boot-starter-webapp-ee module for these two properties to be available.


License compatibility

There are two different types of licenses for Camunda Platform. While the original format is only valid for Camunda Platform, the second format can be valid for multiple Camunda products (like Camunda Platform, Cawemo or Optimize). Such unified licenses are supported from the versions listed below onwards. Since 7.12.0 all versions (including major/minor releases) support unified license keys.

Camunda Engine version Spring Boot Starter version
7.9.19+ 3.0.8+
7.10.13+ 3.1.8+
7.11.7+ 3.3.6+
7.12.x 3.4.x
7.13.0+ 7.13.0+

On this Page: