Update from 7.12 to 7.13
This document guides you through the update from Camunda BPM
7.13.0. It covers these use cases:
- For administrators and developers: Database Updates
- For administrators and developers: Full Distribution Update
- For administrators: Standalone Web Application
- For developers: Spring Boot Starter Update
- For developers: External Task Client Update
- For developers: Identity Service Queries
- For developers: MetricsReporterIdProvider interface Deprecation
This guide covers mandatory migration steps as well as optional considerations for the initial configuration of new functionality included in Camunda BPM 7.13.
Every Camunda installation requires a database schema update.
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/upgradein the pre-packaged distribution (where
$DISTRIBUTION_PATHis the path of an unpacked distribution) or in the Camunda Nexus. We highly recommend executing these patches before updating. Execute them in ascending order by version number. The naming pattern is
Execute the corresponding update scripts named
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.
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 the Camunda BPM platform, e.g.,
X > 0. The procedure is the same as in step 1, only for the new minor version.
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, make sure that you have downloaded the Camunda BPM 7.13 distribution for the application server you use. It contains the SQL scripts and libraries required for the update. This guide assumes you have unpacked the distribution to a path named
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:
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:
- Undeploy the current version of the standalone web application
- Update the database to the new schema as described in the database update section
- Reconfigure the database as described in the installation section
- Deploy the new and configured standalone web application to the server
Spring Boot Starter Update
If you are using Camunda Spring Boot Starter within you Spring Boot application, then you need to:
- Check Version Compatibility Matrix
- Update Spring Boot Starter and, when required, Spring Boot versions in your
- Update the Camunda BPM version in your
pom.xmlin case you override it before (e.g., when using the enterprise version or a patch releases)
External Task Client Update
If you are using the Camunda External Task Client, please make sure to:
- Check out the Version Compatibility Matrix
- Update the version in your
Identity Service Queries
When you provide …
- a custom identity provider implementation by implementing the interface
- AND a dedicated implementation of Identity Service Queries (e. g.
With this release, you need to implement a new API method
so that the REST API works appropriately.
Please read more about it in the User Guide.
MetricsReporterIdProvider interface Deprecation
As of version 7.13, the
MetricsReporterIdProvider interface has been deprecated. By default, the
Metrics Reporter identifier now uses the
SimpleIpBasedProvider class, which was ported to
implement the new
HostnameProvider interface. The
HostnameProvider interface, and it’s default
SimpleIpBasedProvider implementation, are used to generate
hostname information for the Historic
Job Logs as well.
In case a custom implementation of the
MetricsReporterIdProvider interface is used, it is
recommended to port it to the new
HostnameProvider interface and set it to the appropriate Process
Engine Configuration property (read more about it here).
Otherwise, different values will be provided for the Metrics Reporter identifier and the Historic
Job Logs hostname information.