The following steps describe how to update the Camunda artifacts on a Tomcat server in a shared process engine setting. For the entire procedure, refer to the update guide. If not already done, make sure to download the Camunda Platform 7.4 Tomcat distribution.

The update procedure takes the following steps:

1. Update the Camunda Platform Core Libraries
2. Update Optional Camunda Platform Libraries
3. Maintain Process Engine Configuration
4. Maintain Process Applications
5. Update Web Applications

In each of the following steps, the identifiers $*_VERSION refer to the current version and the new versions of the artifacts.

1. Update the Camunda Platform Core Libraries

Replace the following libraries in the folder $TOMCAT_HOME/lib/ with their new versions from the folder $TOMCAT_DISTRIBUTION/lib/:

• camunda-engine-$PLATFORM_VERSION.jar
• camunda-bpmn-model-$PLATFORM_VERSION.jar
• camunda-cmmn-model-$PLATFORM_VERSION.jar
• camunda-xml-model-$PLATFORM_VERSION.jar

Add or replace (if already present) the following libraries:

• camunda-engine-dmn-$PLATFORM_VERSION.jar
• camunda-engine-feel-api-$PLATFORM_VERSION.jar
• camunda-engine-feel-juel-$PLATFORM_VERSION.jar
• camunda-dmn-model-$PLATFORM_VERSION.jar
• camunda-commons-logging-$COMMONS_VERSION.jar
• camunda-commons-typed-values-$COMMONS_VERSION.jar
• camunda-commons-utils-$COMMONS_VERSION.jar

Starting with 7.4, SLF4J is a mandatory dependency. Add the SLF4J libraries (if not already present):

• slf4j-api-$SLF4J_VERSION.jar
• slf4j-jdk14-$SLF4J_VERSION.jar

Camunda needs version slf4j-api-1.7.7 or higher. See the User Guide for Information on Logging in Camunda.

2. Update Optional Camunda Platform Libraries

In addition to the core libraries, there may be optional artifacts in $TOMCAT_HOME/lib/ for LDAP integration, Camunda Connect, Camunda Spin, and Groovy scripting. If you use any of these extensions, the following update steps apply:

LDAP Integration

Copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:

• camunda-identity-ldap-$PLATFORM_VERSION.jar

Camunda Connect

Copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:

• camunda-engine-plugin-connect-$PLATFORM_VERSION.jar

Camunda Spin

Copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:

• camunda-spin-dataformat-all-$SPIN_VERSION.jar
• camunda-spin-core-$SPIN_VERSION.jar
• camunda-engine-plugin-spin-$PLATFORM_VERSION.jar

Groovy Scripting

Copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:

• groovy-all-$GROOVY_VERSION.jar

3. Maintain Process Engine Configuration

This section describes changes in the engine’s default behavior. While the change is reasonable, your implementation may rely on the previous default behavior. Thus, the previous behavior can be restored for shared process engines by explicitly setting a configuration option.

Task Query Expressions

As of 7.4, the default handling of expressions submitted as parameters of task queries has changed. Passing EL expressions in a task query enables execution of arbitrary code when the query is evaluated. The process engine no longer evaluates these expressions by default and throws an exception instead. This behavior can be toggled in the process engine configuration using the properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true). To restore the engine’s previous behavior, set both flags to true. See the user guide on security considerations for custom code for details. This is already the default for Camunda Platform versions after and including 7.3.3 and 7.2.8.

User Operation Log

The behavior of the user operation log has changed, so that operations are only logged if they are performed in the context of a logged in user. This behavior can be toggled in the process engine configuration using the property restrictUserOperationLogToAuthenticatedUsers (default true). To restore the engine’s prior behavior, i.e., to write log entries regardless of user context, set the flag to false.

Furthermore, with 7.4 task events are only logged when they occur in the context of a logged in user. Task events are accessible via the deprecated API TaskService#getTaskEvents. If you rely on this API method, the previous behavior can be restored by setting the flag restrictUserOperationLogToAuthenticatedUsers to false.

4. Maintain Process Applications

This section describes changes in behavior of API methods that your process applications may rely on.

CMMN Model API

As a consequence of supporting CMMN 1.1, the CMMN model API is now based on the schema of CMMN 1.1. This leads to limitations when editing CMMN 1.0 models. We therefore recommend to migrate your CMMN 1.0 models to CMMN 1.1.

5. Update Web Applications

Update REST API

The following steps are required to update the Camunda REST API on a Tomcat instance:

1. Undeploy an existing web application with a name like camunda-engine-rest
2. Download the REST API web application archive from our Maven Nexus Server Alternatively, switch to the private repository for the enterprise version (User and password from license required). Choose the correct version named $PLATFORM_VERSION/camunda-engine-rest-$PLATFORM_VERSION-tomcat.war.
3. Deploy the web application archive to your Tomcat instance.

Update Cockpit, Tasklist, and Admin

The following steps are required to update the Camunda web applications Cockpit, Tasklist, and Admin on a Tomcat instance:

1. Undeploy an existing web application with a name like camunda-webapp
2. Download the Camunda web application archive from our Maven Nexus Server). Alternatively, switch to the private repository for the enterprise version (User and password from license required). Choose the correct version named $PLATFORM_VERSION/camunda-webapp-tomcat-$PLATFORM_VERSION.war.
3. Deploy the web application archive to your Tomcat instance.