Update from 7.17 to 7.18
This document guides you through the update from Camunda Platform 7.17.x
to 7.18.0
and covers the following use cases:
- For administrators and developers: Database updates
- For administrators and developers: Full distribution update
- For administrators: Standalone web application
- For administrators and developers: Groovy version update
This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda Platform 7.18.
Database updates
Every Camunda installation requires a database schema update. Check our database schema update guide for further instructions.
Full distribution
This section is applicable if you installed the Full Distribution with a shared process engine.
The following steps are required:
- Update the Camunda libraries and applications inside the application server.
- Migrate custom process applications.
Before starting, ensure you have downloaded the Camunda Platform 7.18 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 libraries and applications
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 the following:
camunda-engine-spring
camunda-engine-cdi
camunda-ejb-client
There are no new mandatory dependencies for process applications.
Standalone web application
If you use a standalone web application, replace the current .war
artifact with its new version.
Take the following steps to complete the update:
- Undeploy the current version of the standalone web application.
- Update the database to the new schema as described in the database update section.
- Configure the database as described in the installation section.
- Deploy the new and configured standalone web application to the server.
Groovy version update
Camunda Platform 7 provides the Groovy script engine by default with the pre-packaged distributions. With Camunda Platform
7.18, we bumped Groovy to version 2.4.21
. With this Groovy version bump, we decided to move away from the groovy-all-$GROOVY_VERSION.jar
since newer Groovy versions don’t provide a groovy-all-$GROOVY_VERSION.jar
anymore.
Therefore, you will find the following Groovy-related libraries in the Camunda Platform 7.18 pre-packed distributions:
groovy-$GROOVY_VERSION.jar
groovy-jsr223-$GROOVY_VERSION.jar
groovy-json-$GROOVY_VERSION.jar
groovy-xml-$GROOVY_VERSION.jar
groovy-templates-$GROOVY_VERSION.jar
The groovy
and groovy-jsr-223
Groovy modules are required for correct operation of the Groovy script engine.
Since the groovy-all.jar
included a lot more than groovy
and groovy-jsr-223
modules, we decided to provide additional useful Groovy modules.
Camunda users relying on Groovy for their scripts need to replace the libraries as described in the
Camunda libraries and applications guide for their application server. Camunda Platform Run users need to replace the groovy-all-$GROOVY_VERSION.jar
in the {RUN_HOME}/configuration/userlib/
directory with the .jar
libraries from the list above.
Camunda users who don’t rely on Groovy can ignore this section.