The update procedure takes the following steps:

  • Add the new Camunda libraries
  • Install optional Camunda dependencies
  • Configure process engines
  • Install the Camunda archive
  • Install the Camunda BPM web applications
    In each of the following steps, the identifiers refer to the current version and the new versions of the artifacts.

Depending on your chosen feature set for Camunda BPM, some of the (optional) migration steps may require to change the configuration of the BPM platform. The Camunda enterprise archive (EAR) contains a default platform configuration. If you want to change this configuration, you can replace it as described in thedeployment descriptor reference.

1. Uninstall the Camunda Applications 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-glassfish-ear-$PLATFORM_VERSION.ear. Then, uninstall the Camunda job executor adapter, called camunda-jobexecutor-rar-$PLATFORM_VERSION.rar.

2. Replace the Camunda Libraries

After shutting down the server, replace the following libraries in $GLASSFISH_HOME/glassfish/lib with their equivalents from $GLASSFISH_DISTRIBUTION/modules/lib:

  • camunda-engine-$PLATFORM_VERSION.jar
  • camunda-bpmn-model-$PLATFORM_VERSION.jar
  • camunda-xml-model-$PLATFORM_VERSION.jar

  • mybatis-$MYBATIS_VERSION.jar
    If present, also replace the following optional artifact:

  • camunda-cmmn-model-$PLATFORM_VERSION.jar

    3. Install Optional Camunda Dependencies

There are artifacts for Camunda Connect, Camunda Spin, the Freemarker template language and Groovy scripting that may optionally be added to the shared library folder. Since all these artifacts add new functionality, the following steps are not required for migration.

Note: The default Camunda configuration file contained by the Camunda EAR automatically activates the newly introduced, optional Camunda dependencies, Camunda Spin and Connect. If you do not use a custom BPM platform configuration as described and do not intend to do so, you must install the Camunda Spin and Connect core libraries to the shared libraries folder.

If you do not want to use Camunda Connect or Camunda Spin, you cannot use the default BPM platform configuration that is contained in the Camunda EAR. In this case, make sure to change the configuration location as described [here][configuration-location]. As a starting point, you can copy the default configuration from $GLASSFISH_DISTRIBUTION/modules/camunda-glassfish-ear-$PLATFORM_VERSION.ear/camunda-glassfish-service-$PLATFORM_VERSION.jar/META-INF/bpm-platform.xml and remove the <plugin> entries for the classes ConnectProcessEnginePlugin and SpinProcessEnginePlugin.

If Camunda Connect is intended to be used, copy the following library from $GLASSFISH_DISTRIBUTION/modules/lib to the folder $GLASSFISH_HOME/glassfish/lib:

  • camunda-connect-core-$CONNECT_VERSION.jar
  • camunda-commons-logging-$COMMONS_VERSION.jar
  • camunda-commons-utils-$COMMONS_VERSION.jar
  • slf4j-api-$SLF4J_VERSION.jar

Camunda Spin

If camunda Spin is intended to be used, copy the following library from $GLASSFISH_DISTRIBUTION/modules/lib to the folder :

  • camunda-spin-core-$CONNECT_VERSION.jar
  • camunda-commons-logging-$COMMONS_VERSION.jar
  • camunda-commons-utils-$COMMONS_VERSION.jar
  • slf4j-api-$SLF4J_VERSION.jar
  • slf4j-jdk14-$SLF4J_VERSION.jar
    If you use a custom BPM platform configuration file, camunda Spin functionality has to be activated for a process engine by registering a process engine plugin (note that if you use the default configuration, this step is not necessary):
  • groovy-all-$GROOVY_VERSION.jar

    Freemarker Integration

If the camunda integration for Freemarker is intended to be used, add the following artifacts to the folder $GLASSFISH_HOME/glassfish/lib:

  • camunda-template-engines-freemarker-$TEMPLATE_VERSION.jar
  • freemarker-2.3.20.jar
  • camunda-commons-logging-$COMMONS_VERSION.jar
  • camunda-commons-utils-$COMMONS_VERSION.jar
  • slf4j-api-$SLF4J_VERSION.jar

    4. Configure Process Engines

As of 7.2, the default behavior of script variables has changed. Script variables are set in e.g. a BPMN Script Task that uses a language such as JavaScript or Groovy. In previous versions, the process engine automatically stored all script variables as process variables. Starting with 7.2, this behavior has changed and the process engine does not automatically store script variables any longer. You can re-enable the legacy behavior by setting the boolean property autoStoreScriptVariables to true for any process engine in the bpm-platform.xml:

As an alternative, process application developers can migrate script code by replacing all implicit declarations of process variables in their scripts with an explicit call to execution.setVariable('varName', 'value').

5. Install the Camunda Archive

First, install the camunda job executor resource adapter, namely the file $GLASSFISH_DISTRIBUTION/modules/camunda-jobexecutor-rar-$PLATFORM_VERSION.rar. Then, install the camunda EAR, i.e., the file .

6. Install the Camunda Web Applications

Camunda REST API

The following steps are required to update the camunda REST API on a Glassfish instance:

  • 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 Glassfish instance.

    Camunda Cockpit, Tasklist, and Admin

The following steps are required to update the camunda web applications Cockpit, Tasklist, and Admin on a Glassfish instance:

  • Download the camunda web application archive from our . 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-glassfish-$PLATFORM_VERSION.war.
  • Deploy the web application archive to your Glassfish instance.