Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 6.71 KB

_index.md

File metadata and controls

100 lines (69 loc) · 6.71 KB
title weight layout menu
Update from 7.21 to 7.22
2
single
main
name identifier parent pre
7.21 to 7.22
migration-guide-722
migration-guide-minor
Update from `7.21.x` to `7.22.0`.

This document guides you through the update from Camunda 7.21.x to 7.22.0 and covers the following use cases:

  1. For administrators and developers: Database updates
  2. For administrators and developers: Full distribution update
  3. For administrators and developers: Camunda Spin
  4. For developers: Camunda Commons
  5. For developers: Camunda Template Engines FreeMarker
  6. For developers: Camunda Connect
  7. For developers: Update to Tomcat 10 Server

This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda 7.22.

Database updates

Every Camunda installation requires a database schema update. Check our [database schema update guide]({{< ref "/installation/database-schema.md#update" >}}) for further instructions.

Full distribution

This section is applicable if you installed the [Full Distribution]({{< ref "/introduction/downloading-camunda.md#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, ensure you have downloaded the Camunda 7.22 distribution for the application server you use. This contains the SQL scripts and libraries required for the update. This guide assumes you have unpacked the distribution to a path named $DISTRIBUTION_PATH.

Camunda Spin

We’ve moved the camunda-spin project from its previous location into the mono repository. We’re no longer versioning it independently. Instead, we’ve integrated it into the 7.X.Y versioning scheme, so you can conveniently declare Camunda 7.22.0-alpha1 to use the latest release of Camunda Spin.

Camunda Commons

We’ve moved the camunda-commons project from its previous location into the mono repository. We’re no longer versioning it independently. Instead, we’ve integrated it into the 7.X.Y versioning scheme, so you can conveniently declare Camunda 7.22.0-alpha1 to use the latest release of Camunda Commons. We've also updated the camunda-commons-bom to include camunda-commons-typed-values. Now, you can manage all Camunda commons dependency versions directly through the camunda-commons-bom.

Camunda Template Engines FreeMarker

We’ve moved the camunda-template-engines-freemarker project from its previous location into the mono repository. We’re no longer versioning it independently. Instead, we’ve integrated it into the 7.X.Y versioning scheme, so you can conveniently declare Camunda 7.22.0-alpha2 to use the latest release of Camunda Template Engines FreeMarker.

Camunda Connect

We’ve moved the camunda-connect project from its previous location into the mono repository. We’re no longer versioning it independently. Instead, we’ve integrated it into the 7.X.Y versioning scheme, so you can conveniently declare Camunda 7.22.0-alpha2 to use the latest release of Camunda Connect.

Update to Tomcat 10 Server

With this release, we support Tomcat 10, the new default pre-packaged Tomcat distro. It replaces Java EE with Jakarta EE APIs. If you prefer to stay on Tomcat 9, you can still download the Java EE compliant web application, and REST API.

To work with Tomcat 10, consider the following when migrating your process applications and replacing artifacts on the application server:

Migrate process applications

  • Replace Java EE class references (javax.*) with Jakarta class references (jakarta.*)
  • You might have a look at org.eclipse.transformer:transformer-maven-plugin
  • Replace Camunda class references:
  • org.camunda.bpm.application.impl.EjbProcessApplication → org.camunda.bpm.application.impl.JakartaEjbProcessApplication
  • org.camunda.bpm.application.impl.ServletProcessApplicationDeployer → org.camunda.bpm.application.impl.JakartaServletProcessApplicationDeployer
  • org.camunda.bpm.application.impl.ServletProcessApplication → org.camunda.bpm.application.impl.JakartaServletProcessApplication
  • org.camunda.bpm.engine.impl.cfg.jta.JtaTransactionContext → org.camunda.bpm.engine.impl.cfg.jta.JakartaTransactionContext
  • org.camunda.bpm.engine.impl.cfg.jta.JtaTransactionContextFactory → org.camunda.bpm.engine.impl.cfg.jta.JakartaTransactionContextFactory
  • org.camunda.bpm.engine.impl.cfg.JtaProcessEngineConfiguration → org.camunda.bpm.engine.impl.cfg.JakartaTransactionProcessEngineConfiguration
  • org.camunda.bpm.engine.impl.interceptor.JtaTransactionInterceptor → org.camunda.bpm.engine.impl.interceptor.JakartaTransactionInterceptor
  • Replace Camunda Maven dependencies:
  • org.camunda.bpm.javaee:camunda-ejb-client → org.camunda.bpm.javaee:camunda-ejb-client-jakarta
  • org.camunda.bpm:camunda-engine-cdi → org.camunda.bpm:camunda-engine-cdi-jakarta

Migrate Java webapp plugins

Replace Java EE class references (javax.*) with Jakarta class references (jakarta.*)

Replace web application (Cockpit, Admin, Tasklist, Welcome) deployment

Replace the artifact camunda-webapp-tomcat-$PLATFORM_VERSION.war with camunda-webapp-tomcat-jakarta-$PLATFORM_VERSION.war under $CATALINA_HOME/webapps.

Replace REST API deployment

Replace the artifact camunda-engine-rest-$PLATFORM_VERSION-tomcat.war with camunda-engine-rest-jakarta-$PLATFORM_VERSION-tomcat.war under $CATALINA_HOME/webapps.

Migrating to the Tomcat 10 Docker Image

If your application uses a Docker image based on Tomcat 9 (or prior) and wish to use the Tomcat 10 based Docker image, you need perform the the above migration steps yourself before your application is compatible with the jakarta namespace changes the new Tomcat version introduces.