Edit on Github

Update from 7.6 to 7.7

This document guides you through the update from Camunda 7.6.x to 7.7.0. It covers these use cases:

  1. For administrators and developers: Database Updates
  2. For administrators and developers: Rolling Update
  3. For administrators and developers: Full Distribution Update
  4. For administrators: Standalone Web Application
  5. For administrators: Updating a Tasklist Translation File
  6. For administrators and developers: Application with Embedded Process Engine Update

This guide covers mandatory migration steps as well as optional considerations for initial configuration of new functionality included in Camunda 7.7.

Noteworthy new Features and Changes in 7.7:

Database Updates

Every Camunda installation requires a database schema update.

Procedure

  1. Check for available database patch scripts for your database that are within the bounds of your update path. Locate the scripts at $DISTRIBUTION_PATH/sql/upgrade in the pre-packaged distribution (where $DISTRIBUTION_PATH is the path of an unpacked distribution) or in the Camunda Artifact Repository. We highly recommend to execute these patches before updating. Execute them in ascending order by version number. The naming pattern is $DATABASENAME_engine_7.6_patch_?.sql.

  2. Execute the corresponding update scripts named

    • $DATABASENAME_engine_7.6_to_7.7.sql

    The scripts update the database from one minor version to the next, and change the underlying database structure. So make sure to backup your database in case there are any failures during the update process.

  3. We highly recommend to also check for any existing patch scripts for your database that are within the bounds of the new minor version you are updating to. Execute them in ascending order by version number. Attention: This step is only relevant when you are using an enterprise version of Camunda 7, e.g., 7.7.X where X > 0. The procedure is the same as in step 1, only for the new minor version.

Rolling Update

If you do not know what a rolling update in the context of Camunda means, please refer to the Rolling Update documentation.

In the context of a rolling update, a user created with an engine A of Camunda version >= 7.7 cannot be authenticated with an engine B of Camunda version <= 7.6. The reason is that the Camunda version 7.7 adds salt to password hashing, thus, the older engine B is not aware of salt and unable to create the same hashed password as engine A.

To circumvent that problem you can either update all engines to the version >= 7.7 or create all users exclusively in the engine with version <= 7.6.

Full Distribution

This section is applicable if you installed the Full Distribution with a shared process engine.

The following steps are required:

  1. Update the Camunda libraries and applications inside the application server
  2. Migrate custom process applications

Before starting, make sure that you have downloaded the Camunda 7.7 distribution for the application server you use. It contains the SQL scripts and libraries required for update. This guide assumes you have unpacked the distribution to a path named $DISTRIBUTION_PATH.

Camunda Libraries and Applications

Please choose the application server you are working with from the following list:

Custom Process Applications

For every process application, the Camunda dependencies should be updated to the new version. Which dependencies you have is application- and server-specific. Typically, the dependencies consist of any of the following:

  • camunda-engine-spring
  • camunda-engine-cdi
  • camunda-ejb-client
  • …

There are no new mandatory dependencies for process applications.

Standalone Web Application

If the standalone web application is in use, the current war artifact must be replaced by its new version.

If a database other than the default H2 database is used, the following steps must be taken:

  1. Undeploy the current version of the standalone web application
  2. Update the database to the new schema as described in the database update section
  3. Reconfigure the database as described in the installation section
  4. Deploy the new and configured standalone web application to the server

Tasklist Translation File

The following labels must be added to the Tasklist locale file:

  • LOGOUT_SUCCESSFUL
  • LOGOUT_THANKS
  • MORNING
  • DAY
  • AFTERNOON
  • EVENING
  • NIGHT
  • FAILED_TO_DISPLAY_RESOURCE
  • AUTHENTICATION_FAILED
  • LOGIN_ERROR_MSG
  • Username
  • Password
  • LOGIN_FAILED
  • CLOSE_TASK
  • TASK_HAS_BEEN_REMOVED
  • SHOW_LESS
  • SHOW_MORE

Have a look at what changed in the english translation file for a basis to translate.

Application with Embedded Process Engine

This section is applicable if you have a custom application with an embedded process engine.

Update the dependencies declared in your application’s pom.xml file to the new version. Which dependencies you have is application-specific. Typically, the dependencies consist of any of the following:

  • camunda-engine
  • camunda-bpmn-model
  • camunda-engine-spring
  • camunda-engine-cdi
  • …

There are no new mandatory dependencies. That means, updating the version should suffice to migrate a process application in terms of dependencies.

On this Page: