This document will guide you through the installation of camunda BPM and its components on a Oracle WebLogic Application Server.
Enterprise Feature
Please note that this feature is only included in the enterprise edition of the camunda BPM platform, it is not available in the community edition.Check the camunda enterprise homepage for more information or get your free trial version.
Reading the Guide
Throughout this guide we will use a number of variables to denote common path names and constants.$WLS_DOMAIN_HOME
points to the WebLogic application server domain directory (typically something like /opt/oracle/WebLogic/domains/mydomain
). $PLATFORM_VERSION
denotes the version of the camunda BPM platform you want to or have installed, e.g. 7.0.0
. $WLS_DISTRIBUTION
represents the downloaded camunda BPM distribution for the WLS, e.g. camunda-ee-oracle-wls-$PLATFORM_VERSION.zip
.
The distribution is available at the camunda enterprise release page. You will be asked to enter the credentials you received during the trial or subscription process.
The camunda BPM platform requires a set of resources that need to be configured at the application server level:
The camunda BPM platform uses one or multiple process engines. Use the WebLogic Server Administration Console for the configuration of the datasources. The JNDI name of the datasource must be equal to the name used in the datasource-Element of the process engine(s) configured in the bpm-platform.xml.
The default JNDI name is jdbc/ProcessEngine
The following screenshot shows the mandatory configuration of a datasource for camunda bpm:
In this section we explain how to add a datasource using the WebLogic Server Administration Console:
Note that you can configure multiple datasources used by different process engine instances. See the User Guide for details.
The camunda BPM platform includes two modules in the modules folder of the distribution:
camunda-ee-oracle-wls-$PLATFORM_VERSION.zip
|-- modules/
|-- camunda-oracle-weblogic-ear-$PLATFORM_VERSION.ear
|-- camunda-oracle-weblogic-rar-$PLATFORM_VERSION.rar
The camunda-oracle-weblogic-rar module is a JCA Resource Adapter providing the jobexecutor service to the camunda BPM platform. The camunda-oracle-weblogic-ear is a Java EE application providing the camunda BPM platform services.
Both modules must be installed to your Oracle Weblogic Application Server in the correct order. You must first install the camunda-oracle-weblogic-rar module and then install the camunda-oracle-weblogic-ear module. The startup order is also important. It is necessary that the Resource Adapter starts before the EAR module.
In this section, we explain how the camunda-oracle-weblogic-rar module can be installed using the WebLogic Server Administration Console.
The installation process is composed of three steps:
camunda-oracle-weblogic-rar-$PLATFORM_VERSION.rar
RAR file.First, the camunda-oracle-weblogic-rar-$PLATFORM_VERSION.rar
RAR file must be installed:
camunda-oracle-weblogic-rar-$PLATFORM_VERSION.rar
from the modules folder of the camunda BPM platform for Oracle Weblogic Application Server distribution and continue to the "Next" page.camunda-oracle-weblogic-rar
.Example: Deployment order set to "80".
Workload tab of camunda-oracle-weblogic-rar deployment:
Finished configuration of the JCA Work Manager used by the resource adapter.
This completes the installation of the resource adapter.
In this section, we explain how the camunda-oracle-weblogic-ear module can be installed using the WebLogic Server Administration Console.
The installation process is composed of two steps:
camunda-oracle-weblogic-ear-$PLATFORM_VERSION.ear
EAR file.camunda-oracle-weblogic-ear-$PLATFORM_VERSION.ear
EAR file.First the camunda-oracle-weblogic-ear-$PLATFORM_VERSION.ear
RAR file must be installed:
camunda-oracle-weblogic-ear-$PLATFORM_VERSION.ear
from the modules folder of the camunda BPM platform for Oracle Weblogic Application Server distribution and continue to the "Next" page.Fill in camunda-bpm-platform
as name for the enterprise application deployment. This setting is mandatory and MUST NOT be changed.
Continue to the "Next" page.
Example: Deployment order set to "90".
Completed installation of camunda bpm platform EAR and RAR in WebLogic Server
The camunda REST API WAR file resides under webapps/camunda-engine-rest-$PLATFORM_VERSION-wls.war
in the WLS distribution archive.
In this section we explain how to install the WAR file using the WebLogic Server Administration Console:
camunda-engine-rest-$PLATFORM_VERSION-wls.war
file from the distribution and upload it.After completing the wizard, the REST API should be successfully installed on the application server. The context root for the REST API is /engine-rest by default. In some situations, you also have to start the web application manually from the Domain Structure / YOUR_DOMAIN / Deployments page.
The web application archive that contains camunda Cockpit and Tasklist resides under webapps/camunda-webapp-ee-wls-$PLATFORM_VERSION.war
in the WLS distribution archive.
In this section we explain how to install the WAR file using the WebLogic Server Administration Console:
camunda-webapp-ee-wls-$PLATFORM_VERSION.war
file from the distribution and upload it.After completing the wizard, the Cockpit and Tasklist should be accessible on the default context path /camunda. In some situations, you also have to start the web application manually from the Domain Structure / YOUR_DOMAIN / Deployments page.
You can check if everything went well by accessing Cockpit, Tasklist and Admin via /camunda/app/cockpit
, /camunda/app/tasklist
and /camunda/app/admin
or under the context path you configured.
Note
We do not support camunda Cycle for Weblogic. Check out the user guide for a list of supported environments.
In order to setup LDAP for the WebLogic distribution, you have to perform the following steps:
1. Add LDAP Library
Make sure the camunda-identity-ldap-$PLATFORM_VERSION.jar
is present in the
$WLS_DOMAIN_HOME/lib
folder.
2. Adjust Process Engine Configuration
Edit the file bpm-platform.xml
located inside the folder camunda-oracle-weblogic-ear-$PLATFORM_VERSION/camunda-oracle-weblogic-service-$PLATFORM_VERSION/META-INF/
and add the LDAP Identity Provider Plugin and the Administrator Authorization Plugin.
<?xml version="1.0" encoding="UTF-8"?>
<bpm-platform xmlns="http://www.camunda.org/schema/1.0/BpmPlatform"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.camunda.org/schema/1.0/BpmPlatform http://www.camunda.org/schema/1.0/BpmPlatform ">
...
<process-engine name="default"> ...
<properties>...</properties>
<plugins>
<plugin>
<class>org.camunda.bpm.identity.impl.ldap.plugin.LdapIdentityProviderPlugin</class>
<properties>
<property name="serverUrl">ldap://localhost:4334/</property>
<property name="managerDn">uid=jonny,ou=office-berlin,o=camunda,c=org</property>
<property name="managerPassword">s3cr3t</property>
<property name="baseDn">o=camunda,c=org</property>
<property name="userSearchBase"></property>
<property name="userSearchFilter">(objectclass=person)</property>
<property name="userIdAttribute">uid</property>
<property name="userFirstnameAttribute">cn</property>
<property name="userLastnameAttribute">sn</property>
<property name="userEmailAttribute">mail</property>
<property name="userPasswordAttribute">userpassword</property>
<property name="groupSearchBase"></property>
<property name="groupSearchFilter">(objectclass=groupOfNames)</property>
<property name="groupIdAttribute">ou</property>
<property name="groupNameAttribute">cn</property>
<property name="groupMemberAttribute">member</property>
</properties>
</plugin>
<plugin>
<class>org.camunda.bpm.engine.impl.plugin.AdministratorAuthorizationPlugin</class>
<properties>
<property name="administratorUserName">admin</property>
</properties>
</plugin>
</plugins>
</process-engine>
</bpm-platform>
The administratorUserName
property should contain the user id of the LDAP user you want to grant administrator authorizations to. You can then use this user to log into the web application and grant authorizations to additional users.
See our user guide for complete documentation on the LDAP Identity Provider Plugin and the Administrator Authorization Plugin.