Update a Tomcat Installation from 2.2 to 3.0
The following steps describe how to update the CIB seven 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 CIB seven 3.0 Tomcat distribution.
The update procedure takes the following steps:
- Update the CIB seven core libraries.
- Update optional CIB seven 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 CIB seven core libraries
Replace the following libraries in the folder $TOMCAT_HOME/lib/ with the new versions from the folder $TOMCAT_DISTRIBUTION/lib/:
cibseven-engine-$PLATFORM_VERSION.jarcibseven-bpmn-model-$PLATFORM_VERSION.jarcibseven-cmmn-model-$PLATFORM_VERSION.jarcibseven-dmn-model-$PLATFORM_VERSION.jarcibseven-xml-model-$PLATFORM_VERSION.jarcibseven-engine-dmn-$PLATFORM_VERSION.jarcibseven-engine-feel-api-$PLATFORM_VERSION.jarcibseven-engine-feel-juel-$PLATFORM_VERSION.jarcibseven-engine-feel-scala-$PLATFORM_VERSION.jarcibseven-juel-$PLATFORM_VERSION.jarcibseven-commons-logging-$PLATFORM_VERSION.jarcibseven-commons-typed-values-$PLATFORM_VERSION.jarcibseven-commons-utils-$PLATFORM_VERSION.jarcibseven-connect-connectors-all-$PLATFORM_VERSION.jarcibseven-connect-core-$PLATFORM_VERSION.jarcibseven-template-engines-freemarker-$PLATFORM_VERSION.jarfeel-engine-$FEEL_ENGINE_VERSION-scala-shaded.jarfreemarker-$FREEMARKER_VERSION.jarmybatis-$MYBATIS_VERSION.jar
In addition, copy these two libraries from $TOMCAT_DISTRIBUTION/lib/ to $TOMCAT_HOME/lib/. They are new in CIB seven 3.0, so there is nothing to replace:
jakarta.activation-api-$JAKARTA_ACTIVATION_VERSION.jarangus-activation-$ANGUS_ACTIVATION_VERSION.jar
They provide the MIME type detection of file variables. Without them, every file variable gets the MIME type application/octet-stream, see Jakarta Activation and MIME types of file variables.
2. Update optional CIB seven libraries
In addition to the core libraries, there may be optional artifacts in $TOMCAT_HOME/lib/ for LDAP integration, CIB seven Connect, CIB seven 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:
cibseven-identity-ldap-$PLATFORM_VERSION.jar
CIB seven Connect plugin
Copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:
cibseven-engine-plugin-connect-$PLATFORM_VERSION.jar
CIB seven Spin
Copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:
cibseven-spin-dataformat-all-$PLATFORM_VERSION.jarcibseven-spin-core-$PLATFORM_VERSION.jarcibseven-engine-plugin-spin-$PLATFORM_VERSION.jar
GraalVM JavaScript
The set of libraries has changed
CIB seven 3.0 ships GraalVM JavaScript 25.0.1 instead of the 21.3 line, see Java 25 and GraalJS 25. The runtime is split into more artifacts than before, so it is not enough to replace the jars that are already in $TOMCAT_HOME/lib/. Delete the old ones first and copy the complete new set; otherwise the first script execution fails with a NoClassDefFoundError.
First delete the GraalVM JavaScript libraries of the previous version from $TOMCAT_HOME/lib/:
graal-sdk-$OLD_GRAAL_VERSION.jar- no longer exists as a jar in GraalVM 25js-$OLD_GRAAL_VERSION.jar- no longer exists as a jar in GraalVM 25, its content moved tojs-languagejs-scriptengine-$OLD_GRAAL_VERSION.jarregex-$OLD_GRAAL_VERSION.jartruffle-api-$OLD_GRAAL_VERSION.jar
Then copy the following libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/:
js-language-$GRAAL_VERSION.jarjs-scriptengine-$GRAAL_VERSION.jarregex-$GRAAL_VERSION.jarpolyglot-$GRAAL_VERSION.jarcollections-$GRAAL_VERSION.jarjniutils-$GRAAL_VERSION.jarnativeimage-$GRAAL_VERSION.jarword-$GRAAL_VERSION.jartruffle-api-$GRAAL_VERSION.jartruffle-compiler-$GRAAL_VERSION.jartruffle-runtime-$GRAAL_VERSION.jaricu4j-$GRAAL_VERSION.jarxz-$GRAAL_VERSION.jar
Finally, keep the ICU4J library that scripts use through Java interop. It is unchanged, so replace it only if the version differs:
icu4j-$ICU4J_VERSION.jar
Two files named icu4j
icu4j-$GRAAL_VERSION.jar is GraalVM’s own shaded copy (org.graalvm.shadowed:icu4j), icu4j-$ICU4J_VERSION.jar is the public ICU4J library (com.ibm.icu:icu4j, version 71.1). Both belong in lib/, and neither replaces the other. See Java 25 and GraalJS 25.
Groovy
Copy these libraries from $TOMCAT_DISTRIBUTION/lib to the folder $TOMCAT_HOME/lib/, if present:
groovy-$GROOVY_VERSION.jargroovy-jsr223-$GROOVY_VERSION.jargroovy-json-$GROOVY_VERSION.jargroovy-xml-$GROOVY_VERSION.jargroovy-templates-$GROOVY_VERSION.jargroovy-datetime-$GROOVY_VERSION.jargroovy-dateutil-$GROOVY_VERSION.jar
3. Update CIB seven webclient
Update REST API
The following steps are required to update the CIB seven REST API on a Tomcat instance:
- Undeploy an existing web application with a name like
engine-restorcibseven-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).
- Deploy the REST API web application archive to your Tomcat instance.
CIB seven webclient
The following steps are required to update the CIB seven webclient on a Tomcat instance:
- Undeploy an existing web application with a name like
webappor ‘cibseven-webclient-web’. - Download the CIB seven webclient archive from our Artifact Repository. Alternatively, switch to the private repository for the enterprise version (credentials from license required).
- Deploy the webclient archive to your Tomcat instance.