Custom Location for bpm-platform.xml Configuration File

Starting with camunda BPM 7.1.0-alpha4 it is now possible to put the bpm-platform.xml file in a different location. This solves the problem that you have to open the camunda bpm platform EAR module and change the configuration file inside the EAR file if you want to customize your settings.

Note: This post does not apply to the JBoss Application Server distribution since there the process engine configuration is put directly into the JBoss Application Server configuration file (standalone.xml / domain.xml).

You can now put the bpm-platform.xml file in any location and provide the location as an URL. Examples:

  • /home/camunda/.camunda/bpm-platform.xml
  • C:pathtobpm-platform.xml
  • https://mydomain.com/path/to/bpm-platform.xml

The location can be set using

  1. A JNDI entry namedjava:/comp/env/bpm-platform-xml. This is particularly useful on websphere application server.
  2. A System Property namedbpm.platform.xml. Can be set when starting the JVM:
    -Dbpm.platform.xml=/home/camunda/.camunda/bpm-platform.xml
  3. An environment variable namedBPM_PLATFORM_XML.

If none of the above is set, we will attempt to load the bpm-platform.xml from the default location which is the classpath in the Glassfish, IBM Websphere, Oracle Weblogic distributions and{CATALINA_BASE} || ${CATALINA_HOME} + /conf/in the apache tomcat distribution.

Read more about it in the docs.