CIB seven License Keys

Some CIB seven features require a license key. The license will be provided as a string by the CIB seven support team. The following section explains the various methods by which a CIB seven license can be added to the Process Engine.

Deployment Scenarios and the License Key

In a clustered scenario, CIB seven license key should be applied to all nodes. When activated, a license is valid until the expiration date. The license key is valid for an unlimited amount of engines.

License Key Pickup Methods

Through the Admin Webapp UI

Any environment setup that uses the enterprise CIB seven Admin webapp, can use the provided License key page to enter a valid license key. Please see the dedicated Admin webapp docs section for more details.

Through the Home Directory

Another possibility is to put a file with the license key on the path ${user.home}/.cibseven/cibseven-license.txt. This is another method that can be applied in any environment setup. The license key will be automatically loaded in the database table unless a valid license key is already present.

Through the configuration file

License keys could be stored in a file specified by an optional application property cibseven.webclient.license.file.path in your cibseven-webclient.yaml

With the CIB seven Spring Boot Starter & CIB seven Run

CIB seven Run, and other Spring Boot applications that use the CIB seven Spring Boot Starter, can be provided with license keys in two additional ways:

  • provide a URL to a license file via a custom application property cibseven.webclient.license.file.path in your application.yaml.
  • provide the license key in a file called cibseven-license.txt and put it into ${user.home}/.cibseven/ directory.

Note: For these two ways to be available, the CIB seven Run EE edition must be used, or the Spring Boot application must use the EE version of the starter, with -ee suffix.

<dependency>
  <groupId>org.cibseven.bpm.springboot</groupId>
  <artifactId>cibseven-bpm-spring-boot-starter-webapp</artifactId>
  <version>${project-version}-ee</version>
</dependency>

License content

This section defines what is a valid license key that will be accepted by the CIB seven webclient. This description is valid for all License pickup methods.

A valid license key content is stored in a JSON format with the following items:

{
    "customer":"Test Solutions GmbH",
    "signature":"XXXXXX...",
    "expires":"2025-12-31"}
}

Note that omitting any part of the content will result in an error, and you will have to re-enter your license key in the correct format.

On this Page: