Update a Tomcat Installation from 7.19 to 7.20
The following steps describe how to update the Camunda artifacts on a Tomcat server in a shared process engine setting.
Throughout the procedure, refer to the update guide. If not already done, download the Camunda 7.20 Tomcat distribution.
The update procedure takes the following steps:
- Update the Camunda 7 core libraries.
- Update optional Camunda 7 libraries.
- Update web applications.
In each of the following steps, the identifier $*_VERSION
refers to the current versions and the new versions of the artifacts.
1. Update the Camunda 7 core libraries
Replace the following libraries in the folder $TOMCAT_HOME/lib/
with the 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-engine-feel-scala-$PLATFORM_VERSION.jar
camunda-juel-$PLATFORM_VERSION.jar
camunda-commons-logging-$COMMONS_VERSION.jar
camunda-commons-typed-values-$PLATFORM_VERSION.jar
camunda-commons-utils-$COMMONS_VERSION.jar
camunda-connect-connectors-all-$CONNECT_VERSION.jar
camunda-connect-core-$CONNECT_VERSION.jar
camunda-template-engines-freemarker-$TEMPLATE_ENGINES_VERSION.jar
feel-engine-$FEEL_ENGINE_VERSION-scala-shaded.jar
freemarker-$FREEMARKER_VERSION.jar
mybatis-$MYBATIS_VERSION.jar
2. Update optional Camunda 7 libraries
In addition to the core libraries, there may be optional artifacts in $TOMCAT_HOME/lib/
for LDAP integration, Camunda Connect, Camunda Spin, and 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 plugin
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
GraalVM JavaScript
Copy the following libraries from $TOMCAT_DISTRIBUTION/lib
to the folder $TOMCAT_HOME/lib/
, if present:
graal-sdk-21.1.0.jar
icu4j-68.2.jar
js-21.1.0.jar
js-scriptengine-21.1.0.jar
regex-21.1.0.jar
truffle-api-21.1.0.jar
Groovy
The following libraries replace the single groovy-all-$GROOVY_VERSION.jar
library. Copy these libraries from
$TOMCAT_DISTRIBUTION/lib
to the folder $TOMCAT_HOME/lib/
, if present:
groovy-$GROOVY_VERSION.jar
groovy-jsr223-$GROOVY_VERSION.jar
groovy-json-$GROOVY_VERSION.jar
groovy-xml-$GROOVY_VERSION.jar
groovy-templates-$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 Artifact Repository 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 Artifact Repository. 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.