Update from 7.13 to 7.14
This document guides you through the update from Camunda BPM
7.14.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: Update to JQuery 3.5
- For developers: Changes to Task Query and Historic Task Query behavior
- For developers: New Engine Dependency - Connect
This guide covers mandatory migration steps as well as optional considerations for the initial configuration of new functionality included in Camunda BPM 7.14.
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.14 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
Update to JQuery 3.5
The Update to JQuery 3.5 changes the parsing of HTML. In some cases, this can lead to Tasklist forms or webapp plugins breaking.
Code which uses a self-closing HTML Tag as a parent for generated DOM-nodes will no longer work as expected.
<div> <span ng-bind-html="myHtml" /> My Other Content <!-- is not displayed --> </div>
You can enable the old behavior by overriding the JQuery
htmlPrefilter function using a custom script. We provide an example for Tasklist here. Please keep in mind that this will reintroduce a security vulnerability that was fixed by this update.
You can read more about the update in the JQuery release blog
Changes to Task Query and Historic Task Query behavior
As of version
7.14.0, when using the
TaskService, or the
HistoryService to execute a Task query or
a Historic Task Instance query (or use the appropriate Rest API endpoints), the following methods now
perform a case-insensitive comparison:
This was done to make the remaining methods consistent with the behavior in:
where the behavior was already present.
Users that expect a case-sensitive result, will need to adjust their logic, or Task names and descriptions, for this change of behavior.
New Engine Dependency - Connect
Camunda Connect dependency has been added to the process engine (
camunda-engine) artifact, allowing usage of simple connectors in the context of the new telemetry feature. And changes the status of the dependency from optional to required. See below the details:
– In a case of Embedded engine scenario (includes Spring Boot Starter setups), there are two new dependencies added to the
camunda-connect-coredependency is required from 7.14.0 version and on.
camunda-connect-connectors-alldependency also comes by default. It can be replaced by the
camunda-connect-http-client. The difference is that
camunda-connect-connectors-alldoesn’t have dependencies and contains the HTTP and SOAP connectors, as long as
http-clientdependency. You can see an example below how to exchange the dependencies.
<dependency> <groupId>org.camunda.bpm</groupId> <artifactId>camunda-engine</artifactId> <exclusions> <exclusion> <groupId>org.camunda.connect</groupId> <artifactId>camunda-connect-connectors-all</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.camunda.connect</groupId> <artifactId>camunda-connect-http-client</artifactId> <scope>runtime</scope> </dependency>
– In a case of Shared engine scenario, you will need to add the connect modules if they are not present yet to the setup. The respective update guides for the application servers contain the necessary steps to do this.
In case you already have a Connect dependencies to some of your projects, please consider consolidating the version of them with one that comes as dependency with the engine. That will prevent inconsistencies on the system. Please note that the Connect process engine plugin is still an optional dependency.
End of Spring 3 Support
Spring Framework version 3 has been end of life as of December 31st, 2016. The official guide recommends to upgrade to versions 4 or 5 of the framework respectively. With version
7.14.0, official support for Spring 3 ends as well. Applications using this version of Spring might still work as expected but are recommended to be upgraded to versions 4 or 5, which the engine is tested against and can be safely used with.