Update an IBM Websphere Installation from 7.17 to 7.18
The following steps describe how to update the Camunda artifacts on an IBM WebSphere application server 9 or IBM WebSphere application server Liberty in a shared process engine setting. Throughout the procedure, refer to the update guide. If not already done, download the Camunda Platform 7.18 IBM WebSphere distribution.
The update procedure takes the following steps:
- Uninstall the Camunda libraries and archives.
- Replace Camunda core libraries.
- Replace optional Camunda dependencies.
- Maintain the Camunda Platform configuration.
- Install the Camunda Archive.
- Install the web applications.
In each of the following steps, the identifier $*_VERSION
refers to the current versions and the new versions of
the artifacts.
1. Uninstall the Camunda libraries and archives
First, uninstall the Camunda web applications, namely the Camunda REST API (artifact name like camunda-engine-rest
)
and the Camunda applications Cockpit, Tasklist, and Admin (artifact name like camunda-webapp
).
Uninstall the Camunda EAR; its name should be camunda-ibm-websphere-ear-7.17.0-ee.ear
.
WebSphere Liberty steps
If you are using WebSphere Liberty, you just need to remove the Camunda EAR, REST API, and web applications from the
Liberty $YOUR_SERVER/apps/
directory.
2. Replace Camunda core libraries
With your first Camunda installation or update to 7.2, you have created a shared library named Camunda
. We identify
the folder to this shared library as $SHARED_LIBRARY_PATH
.
After shutting down the server, replace the following libraries in $SHARED_LIBRARY_PATH
with the equivalents
from $WAS_DISTRIBUTION/modules/lib
:
camunda-engine-7.17.0-ee.jar
camunda-bpmn-model-7.17.0-ee.jar
camunda-cmmn-model-7.17.0-ee.jar
camunda-dmn-model-7.17.0-ee.jar
camunda-xml-model-7.17.0-ee.jar
camunda-engine-dmn-7.17.0-ee.jar
camunda-engine-feel-api-7.17.0-ee.jar
camunda-engine-feel-juel-7.17.0-ee.jar
camunda-engine-feel-scala-7.17.0-ee.jar
camunda-commons-logging-$COMMONS_VERSION.jar
camunda-commons-typed-values-7.17.0-ee.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
3. Replace optional Camunda dependencies
In addition to the core libraries, there may be optional artifacts in $SHARED_LIBRARY_PATH
for LDAP integration,
Camunda Spin, Camunda Connect, and scripting. If you use any of these extensions, the following update steps apply:
LDAP integration
Copy the following library from $WAS_DISTRIBUTION/modules/lib
to the folder $SHARED_LIBRARY_PATH
, if present:
camunda-identity-ldap-$PLATFORM_VERSION.jar
Camunda Connect plugin
camunda-connect-connectors-all
and camunda-engine-plugin-connect
are part of the .ear
.
Camunda Spin
Copy the following library from $WAS_DISTRIBUTION/modules/lib
to the folder $SHARED_LIBRARY_PATH
, if present:
camunda-spin-core-$SPIN_VERSION.jar
GraalVM JavaScript
Copy the following libraries from $WAS_DISTRIBUTION/modules/lib
to the folder $SHARED_LIBRARY_PATH
, if present:
graal-sdk-$GRAALJS_VERSION.jar
icu4j-$ICU4J_VERSION.jar
js-$GRAALJS_VERSION.jar
js-scriptengine-$GRAALJS_VERSION.jar
regex-$GRAALJS_VERSION.jar
truffle-api-$GRAALJS_VERSION.jar
Groovy
The following libraries replace the single groovy-all-$GROOVY_VERSION.jar
library. Copy these libraries from
$WAS_DISTRIBUTION/modules/lib
to the folder $SHARED_LIBRARY_PATH
, 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
4. Maintain the Camunda Platform configuration
If you have previously replaced the default Camunda Platform configuration with a custom configuration following any of the methods outlined in the deployment descriptor reference, it may be necessary to restore this configuration. This can be done by repeating the configuration replacement steps for the updated platform.
5. Install the Camunda Archive
Install the Camunda EAR, or the file $WAS_DISTRIBUTION/modules/camunda-ibm-websphere-ear-7.18.0-ee.ear
.
- During the installation on WebSphere 9, the EAR will try to reference the
Camunda
shared library. - On WebSphere Liberty, please follow the EAR installation guide to deploy the Camunda EAR correctly.
6. Install the web applications
REST API
The following steps are required to update the Camunda REST API on an IBM WebSphere instance:
- On WebSphere 9:
- Deploy the web application
$WAS_DISTRIBUTION/webapps/camunda-engine-rest-7.18.0-ee-was.war
to your IBM WebSphere instance. - Associate the web application with the
Camunda
shared library.
- Deploy the web application
- On WebSphere Liberty:
- Place the web application
$WAS_DISTRIBUTION/webapps/camunda-engine-rest-7.18.0-ee-was.war
in the Liberty$YOUR_SERVER/apps/
directory. - Configure the
server.xml
as described in the Liberty installation guide.
- Place the web application
Cockpit, Tasklist, and Admin
The following steps are required to update the Camunda web applications Cockpit, Tasklist, and Admin on an IBM WebSphere instance:
- On WebSphere 9:
- Deploy the web application
$WAS_DISTRIBUTION/webapps/camunda-webapp-ee-was-7.18.0-ee.war
to your IBM WebSphere instance. - Associate the web application with the
Camunda
shared library.
- Deploy the web application
- On WebSphere Liberty:
- Place the web application
$WAS_DISTRIBUTION/webapps/camunda-webapp-ee-was-7.18.0-ee.war
in the Liberty$YOUR_SERVER/apps/
directory. - Configure the
server.xml
as described in the Liberty installation guide.
- Place the web application