Update a JBoss Installation from 7.2 to 7.3
The following steps describe how to update the Camunda artifacts on a JBoss AS
7 and Wildfly 8 server in a shared process engine setting. For the entire
migration procedure, refer to the migration guide. If not
already done, make sure to download the Camunda BPM 7.3 JBoss distribution
or Camunda BPM 7.3 Wildfly distribution. In the following instructions
$APP_SERVER
should be replaced with either jboss
or wildfly
depending on
the used application server.
The update procedure takes the following steps:
- Update the Camunda BPM modules
- Update optional Camunda BPM modules
- Update Camunda web applications
- Configure Process Engines
Whenever the instructions are to replace a module, make sure to delete the previous version of the module first to avoid orphan jars.
Updated Wildfly Version
The pre-built Camunda 7.3 distribution ships with Wildfly 8.2.0.Final, whereas 7.2 comes with Wildfly 8.1.0.Final. Camunda 7.3 is supported on Wildfly 8.1 and 8.2 such that an update is not required when migrating from 7.2 to 7.3.
Should you want to update Wildfly along with Camunda, perform the following steps either before or after updating Camunda:
- Copy all your Camunda-related modules from
$WILDFLY_HOME/modules
to the new Wildfly server’smodule
-directory. - Apply all modifications to Wildfly configuration files such as
standalone.xml
to the files located in the new Wildfly server’s directory. - Undeploy all process applications and copy them to the new Wildfly server’s directory for redeployment.
See the Wildfly 8.2.0.Final release notes for any relevant changes compared to 8.1.0.Final.
1. Update the Camunda BPM Modules
Replace the following modules from the folder $APP_SERVER_HOME/modules/
with their new versions from the folder $APP_SERVER_DISTRIBUTION/modules/
:
org/camunda/bpm/camunda-engine
org/camunda/bpm/$APP_SERVER/camunda-$APP_SERVER-subsystem
org/camunda/bpm/model/camunda-bpmn-model
org/camunda/bpm/model/camunda-cmmn-model
org/camunda/bpm/model/camunda-xml-model
2. Update Optional Camunda BPM Modules
In addition to the core modules, there may be optional artifacts in $APP_SERVER_HOME/modules/
for LDAP integration, Camunda Connect, and Camunda Spin.
If you use any of these extensions, the following update steps apply:
LDAP Integration
Replace the following modules from the folder $APP_SERVER_HOME/modules/
with their new versions from the folder $APP_SERVER_DISTRIBUTION/modules/
if present:
org/camunda/bpm/identity/camunda-identity-ldap
Camunda Connect
Replace the following modules from the folder $APP_SERVER_HOME/modules/
with their new versions from the folder $APP_SERVER_DISTRIBUTION/modules/
if present:
org/camunda/connect/camunda-connect-core
org/camunda/connect/camunda-connect-http-client
org/camunda/connect/camunda-connect-soap-http-client
org/camunda/bpm/camunda-engine-plugin-connect
Camunda Spin
Replace the following modules from the folder $APP_SERVER_HOME/modules/
with their new versions from the folder $APP_SERVER_DISTRIBUTION/modules/
if present:
org/camunda/spin/camunda-spin-core
org/camunda/spin/camunda-spin-dataformat-json-jackson
org/camunda/spin/camunda-spin-dataformat-xml-dom
org/camunda/bpm/camunda-engine-plugin-spin
com/fasterxml/jackson/core/jackson-core
com/fasterxml/jackson/core/jackson-databind
com/fasterxml/jackson/core/jackson-annotations
3. Update Camunda Web Applications
Update REST API
The following steps are required to update the camunda REST API on a JBoss/Wildfly 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. Or 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.war
. - Deploy the web application archive to your JBoss/Wildfly instance.
Update Cockpit, Tasklist, and Admin
The following steps are required to update the Camunda web applications Cockpit, Tasklist, and Admin on a JBoss/Wildfly instance:
- Undeploy an existing web application with a name like
camunda-webapp
- Download the Camunda web application archive from our Maven Nexus Server.
Or switch to the private repository for the enterprise version (User and password from license required).
Choose the correct version named
$PLATFORM_VERSION/camunda-webapp-jboss.war
. - Deploy the web application archive to your JBoss/Wildfly instance.
LDAP Entity Caching
It is possible to enable entity caching for Hypertext Application Language (HAL) requests that the camunda web applications make. This can be especially useful when you use camunda in combination with LDAP. To activate caching, the camunda webapp artifact has to be modified and the pre-built application cannot be used as is. See the REST Api Documentation for details.
4. Configure Process Engines
Task Query Expressions
As of 7.3.3, the default handling of expressions submitted as parameters of task queries has changed. Passing EL expressions in a task query enables execution of arbitrary code when the query is evaluated. The process engine no longer evaluates these expressions by default and throws an exception instead. This behavior can be toggled in the process engine configuration using the properties enableExpressionsInAdhocQueries
(default false
) and enableExpressionsInStoredQueries
(default true
). To restore the engine’s previous behavior, set both flags to true
. See the user guide on security considerations for custom code for details.
This is already the default for Camunda BPM versions after and including 7.2.8.