Remove Camunda

Overview

Starting with version 14.4, the Camunda BPM engine is no longer used to manage the review state of projects in Bloomreach Content. When you deploy the CMS for the first time after upgrading, all externally managed review states are automatically migrated into the repository. After migration, the Camunda web application is no longer required and should not be deployed.

When to Remove Camunda

Remove Camunda after upgrading to version 14.4 or later, once the migration of review states has completed.

Prerequisites

• Ensure all projects that are in review have an external state before starting the migration.
• Verify that all projects in review are in the correct state.
• To reduce risk, cancel or complete any pending reviews if possible.

Implementation Steps

1. Pre-Deployment Verification

• Confirm that all projects in review have external state.
• Address any projects that do not meet this condition by either updating their state or completing/cancelling their reviews.

After completing this verification, deploy the upgraded project.

2. Remove Camunda Components After Deployment

Remove the BPM Web Application

• Delete bpm.war from the distribution.
• Edit src/main/assembly/webapps-component.xml and remove the dependencySets element that includes bpm.war. Refer to Remove bpm.war for the required changes.
• Remove the wpm datasource by editing conf/context.xml and deleting the jdbc/wpmDS resource. See Remove wpmDS for the necessary changes.

After making these changes, generate a new distribution. The new distribution will not contain bpm.war and will not connect to the Camunda database.

Redeploy the Updated Distribution

• Deploy the new distribution to your environment.

Post-Deployment Cleanup (On-Premise Customers Only)

• If you are running on-premise, you can remove the Camunda database tables.
• Back up the Camunda database if you need to retain historical data for audit or compliance.
• Delete the Camunda tables as needed. For a list of tables, refer to the Camunda Database tables documentation.

Verification

• Confirm that the CMS operates as expected and that review state management functions correctly without Camunda.
• Ensure that bpm.war is no longer present in the deployed distribution.
• Verify that the application does not connect to the Camunda database.

Troubleshooting

Error: Missing External State

If you see the following error message:

Cannot continue with migration due to missing external state.

Cause

One or more projects reference non-existing external processes. This indicates that the pre-deployment verification was not completed.

Resolution

Restore your environment to the previous state. Ensure that all projects in review have external process state before attempting the migration again.

Error: bpm.war Still Deployed

If you see the following error message:

After migration the bpm.war should no longer be deployed. Please undeploy it.

Cause

The bpm.war web application was not removed after migration.

Resolution

Remove the bpm.war web application as described in the post-deployment steps above.

Appendix: Diffs

Remove bpm.war

--- a/src/main/assembly/webapps-component.xml
+++ b/src/main/assembly/webapps-component.xml
@@ -12,15 +12,4 @@
       <destName>site.war</destName>
     </file>
   </files>
-  <dependencySets>
-    <dependencySet>
-      <useProjectArtifact>false</useProjectArtifact>
-      <outputDirectory>webapps</outputDirectory>
-      <outputFileNameMapping>bpm.war</outputFileNameMapping>
-      <scope>provided</scope>
-      <includes>
-        <include>com.onehippo.cms7:hippo-addon-wpm-camunda:war</include>
-      </includes>
-    </dependencySet>
-  </dependencySets>
-</component>
copy

Remove wpmDS

--- a/conf/context.xml
+++ b/conf/context.xml
@@ -2,7 +2,6 @@
 <Context>
     <!-- Disable session persistence across Tomcat restarts -->
     <Manager pathname=""/>
-    <Resource name="jdbc/wpmDS" auth="Container" type="javax.sql.DataSource" maxTotal="100" maxIdle="10" initialSize="10" maxWaitMillis="10000" testWhileIdle="true" testOnBorrow="false" validationQuery="SELECT 1" timeBetweenEvictionRunsMillis="10000" minEvictableIdleTimeMillis="60000" username="sa" password="" driverClassName="org.h2.Driver" url="jdbc:h2:${repo.path}/wpm/wpm;AUTO_SERVER=TRUE"/>
 
     <!-- Change the default repository storage location -->
     <!--
@@ -20,4 +19,4 @@
     <!--
     <Parameter name="output-wicketpaths" value="true"/>
     -->
-</Context>
copy

Remove Camunda WAR Dependency and Deployable

--- a/pom.xml
+++ b/pom.xml
@@ -128,12 +128,6 @@
       <artifactId>hippo-enterprise-services</artifactId>
       <scope>provided</scope>
     </dependency>
-    <dependency>
-      <groupId>com.onehippo.cms7</groupId>
-      <artifactId>hippo-addon-wpm-camunda</artifactId>
-      <type>war</type>
-      <scope>provided</scope>
-    </dependency>
   </dependencies>
 
   <build>
@@ -343,14 +337,6 @@
                     <context>/essentials</context>
                   </properties>
                 </deployable>
-                <deployable>
-                  <properties>
-                    <context>/bpm</context>
-                  </properties>
-                  <groupId>com.onehippo.cms7</groupId>
-                  <artifactId>hippo-addon-wpm-camunda</artifactId>
-                  <type>war</type>
-                </deployable>
               </deployables>
               <container>
                 <systemProperties>
copy