Update a Tomcat Installation from 7.7 to 7.8
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 BPM 7.8 Tomcat distribution.
The update procedure takes the following steps:
- Update the Camunda BPM Core Libraries
- Update Optional Camunda BPM Libraries
- Maintain Process Applications
- Update Web Applications
In each of the following steps, the identifier $*_VERSION
refers to the current versions and the new versions of the artifacts.
Updated Tomcat Version
The pre-built Camunda 7.8 distribution ships with Tomcat 8.0.47, whereas 7.7 comes with Tomcat 8.0.24. Camunda 7.8 is supported on all Tomcat 6/7/8 versions such that a Tomcat update is not required when migrating from 7.7 to 7.8.
Should you want to update Tomcat along with Camunda, perform the following steps either before or after updating Camunda:
- Copy all your Camunda-related libraries from
$TOMCAT_HOME/lib
to the new Tomcat server’slib
-directory. - Apply all modifications to Tomcat configuration files such as
server.xml
/bpm-platform.xml
to the files located in the new Tomcat server’s directory. - Undeploy all process applications and copy them to the new Tomcat server’s directory for redeployment.
1. Update 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. Update 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 update 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. Update Web Applications
Update REST API
The following steps are required to update the Camunda REST API on a Tomcat instance:
- Undeploy an existing web application with a name like
camunda-engine-rest
- Download the REST API web application archive from our Maven Nexus Server Alternatively, switch to the private repository for the enterprise version (credentials from license required). Choose the correct version named
$PLATFORM_VERSION/camunda-engine-rest-$PLATFORM_VERSION-tomcat.war
. - 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:
- Undeploy an existing web application with a name like
camunda-webapp
- Download the Camunda web application archive from our Maven Nexus Server. Alternatively, switch to the private repository for the enterprise version (credentials from license required). Choose the correct version named
$PLATFORM_VERSION/camunda-webapp-tomcat-$PLATFORM_VERSION.war
. - Deploy the web application archive to your Tomcat instance.