Skip to main content

Configuration of priint:bpm (Camunda)

1. Configuring Application Properties​

You can override any bundled properties by placing a file named application.yml next to the jar. It will be read in at startup (assuming you run it using the provided command, see installation instructions) and all properties within it will take precedence over the ones bundled with the app.

2. Port​

The default port for Camunda is 8888. Change it to for example 8889 with this setting in application.yml

server:
  port: 8889

3. Database​

Properties for different DBMS engines can be used by specifying appropriate spring profiles. MySQL is used by default and its default connection configuration is as follows:

spring:
  datasource:
    url: "jdbc:mysql://localhost:43306/priint_bpm?serverTimezone=Europe/Berlin"
    username: "priintadmin"
    password: "Comet4"

If required values are different, add the properties you wish to change to your application.yml.

Other available DB-related profiles are: oracle, sqlserver.

If you are using Microsoft SQL Server, add a profile to your application.yml:

spring:
  profiles:
    active: "sqlserver"

Default connection settings would then be:

spring:
  datasource:
    url: "jdbc:sqlserver://localhost:1433;databaseName=priint_bpm"
    username: "priintadmin"
    password: "Comet4"

 

Again: you can override these values by adding them to your application.yml.

If working with an Oracle database, set the profile to oracle:

spring:
  profiles:
    active: "oracle"

Default connection properties are then:

spring:
  datasource:
    url: "jdbc:oracle:thin:PRIINT_BPM/Comet4@localhost:1521:orcl"
    username: "PRIINT_BPM"
    password: "Comet4"

In this case "username" is the database name of the priint bpm / camunda database created by the installer. Use the password of the database user (not db admin user!) configured during the pubserver installation.

 

As previously, if your database is not on localhost, or any other setting must be changed, add them to application.yml.

4. Pubserver​

The connection to the pubserver is controlled by the following settings:

planner.engine:
  url: http://localhost:40080/PlannerEngine/api/
  # The user added here needs to be assigned to or have access to projects this priint-bpm will process. Make sure you either
  # explicitly configure this account to take part in projects or grant it a role that enables it to access any project.
  user: admin
  password: yourPlannerEnginePassword

If your installation uses different settings, please add them to application.yml.

Detailed description of the properties' mechanism used can be found here.

5. Logging​

You can configure logback to output logs as desired. When defining your own application.yml, just define a pointer to logback config file like this:

logging:
  config: your-logback-file.xml

Then create your-logback-file.xml next to your jar and application.yml. Example configuration you might use as a start:

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="30 seconds">
      <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
      <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
      <root level="INFO">
        <appender-ref ref="CONSOLE"/>
      </root>
      <logger name="com.priint" level="INFO"/>
</configuration>

6. Health checks​

Health and separate readiness and liveness endpoints can be activated by adding the following lines to application.yml:

management:
  endpoint:
    health:
      show-details: ALWAYS
      probes:
        enabled: true
  health:
    livenessstate:
      enabled: true
    readinessstate:
      enabled: true
  endpoints:
    web.exposure.include: health

Following endpoints will become accessible by HTTP GET at runtime:

  • http://your-host:your-port/actuator/health
  • http://your-host:your-port/actuator/health/readiness
  • http://your-host:your-port/actuator/health/liveness