Use Projects without Camunda

Info: This feature is available in brXM 14.2.1 and later.

As of brXM 14.4.0, this page is obsolete. Use Remove Camunda for current instructions.

Overview

This guide explains how to use the Projects feature without requiring Camunda. As of brXM 14.2, the Projects review process no longer depends on Camunda. Camunda support will be removed in version 15.

Removing Camunda from your deployment provides several benefits:

• Reduces distribution size by removing bpm.war
• Improves developer archetype startup time
• Eliminates the need to maintain Camunda database tables
• Simplifies upgrades to version 15

Prerequisites

Before making any changes, complete all ongoing project reviews:

1. Log in to the CMS and select Projects.
2. Filter for projects that are in review.
3. For each project, either cancel or complete the review.

Do not start new reviews before restarting your deployment.

Implementation Steps

1. Disable Camunda for Project Reviews

Set the system property brx.wpm.external-bpm-engine.disabled to true to disable Camunda for project reviews. Restart your deployment after setting this property.

Important: Ensure that no projects are in review before restarting.

2. Remove Camunda Components from the Distribution

After verifying that all reviews are complete and Camunda is disabled, you can remove Camunda-related components:

• Remove bpm.war from the distribution:
  Edit src/main/assembly/webapps-component.xml and remove the dependencySets element containing bpm.war. See the Remove bpm.war diff below.
• Remove the wpm datasource:
  Edit conf/context.xml and remove the jdbc/wpmDS resource. See the Remove wpmDS diff below.

After these changes, generate a new distribution. The new build will not include bpm.war or connect to the Camunda database.

3. Deploy the Updated Distribution

Deploy the new distribution. Ensure that brx.wpm.external-bpm-engine.disabled is permanently set to true.

4. Update Cargo Development Environment Configuration

• In the root pom.xml, add the brx.wpm.external-bpm-engine.disabled system property to the systemProperties section of the cargo.run profile. See the Add system property diff below.
• In the root pom.xml, remove the Camunda WAR dependency and deployable. See the Remove Camunda WAR dependency and deployable diff below.

5. Clean Up Camunda Database Tables (On-Premise Only)

If you are running on-premise, you can remove the Camunda database tables after deployment.

• Back up the Camunda database if you need to retain history for auditing.
• Delete the Camunda database tables. For a list of tables, refer to the Camunda Database tables documentation.

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

Add system property

--- a/pom.xml
+++ b/pom.xml
@@ -358,6 +358,7 @@
                   <!-- enables auto export and web files watch: -->
                   <project.basedir>${project.basedir}</project.basedir>
                   <send.usage.statistics.to.hippo>true</send.usage.statistics.to.hippo>
+                  <brx.wpm.external-bpm-engine.disabled>true</brx.wpm.external-bpm-engine.disabled>
                 </systemProperties>
                 <dependencies>
                   <dependency>
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