Update a Tomcat Installation from 7.4 to 7.5

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

The upgrade procedure takes the following steps:

  1. Upgrade the Camunda BPM Core Libraries
  2. Upgrade Optional Camunda BPM Libraries
  3. Maintain Process Applications
  4. Upgrade Web Applications

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

1. Upgrade the Camunda BPM 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-dmn-model-$PLATFORM_VERSION.jar
  • camunda-xml-model-$PLATFORM_VERSION.jar
  • camunda-engine-dmn-$PLATFORM_VERSION.jar
  • camunda-engine-feel-api-$PLATFORM_VERSION.jar
  • camunda-engine-feel-juel-$PLATFORM_VERSION.jar
  • camunda-commons-logging-$COMMONS_VERSION.jar
  • camunda-commons-typed-values-$COMMONS_VERSION.jar
  • camunda-commons-utils-$COMMONS_VERSION.jar

2. Upgrade Optional Camunda BPM 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 upgrade steps apply:

LDAP Integration

Copy the following library 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-connect-connectors-all-$CONNECT_VERSION.jar
  • camunda-connect-core-$CONNECT_VERSION.jar
  • 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 library from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:

  • groovy-all-$GROOVY_VERSION.jar

3. Maintain Process Applications

This section describes changes in the internal API of the engine. If you have implemented one of the APIs and replaced the default implementation then you have to adjust your custom implementation. Otherwise, you can skip this section.

Incident Handler

The interface of an Incident Handler has changed. Instead of a long parameter list, the methods pass a context object which bundles all required information, like process definition id, execution id and tenant id. Since the existing methods have been overridden, custom implementations of an incident handler have to be adjusted.

Correlation Handler

A new method has been added to the interface of a Correlation Handler . The new method correlateStartMessage() allows to explicitly trigger a message start event of a process definition. If the default implementation is replaced by a custom one then it has to be adjusted.

Job Handler

The interface of a Job Handler has changed to support multi-tenancy and separate the parsing of the configuration.

4. Upgrade Web Applications

Upgrade REST API

The following steps are required to upgrade 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.

Upgrade Cockpit, Tasklist, and Admin

The following steps are required to upgrade 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.

On this Page: