Skip to content

Installation

Configure OKMFlow

Section titled “Configure OKMFlow”

Steps to install and configure the workflow engine in OpenKM v8.2:

CREATE DATABASE okmflow DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_bin;
CREATE USER 'okmflow'@'%' IDENTIFIED BY 'choose-any-pass';
GRANT ALL ON okmflow.* TO 'okmflow'@'%' WITH GRANT OPTION;
  • Create the configuration file $TOMCAT_HOME/okmflow.properties
# Database
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:3306/okmflow?autoReconnect=true&useUnicode=true&characterEncoding=UTF8
spring.datasource.username=okmflow
spring.datasource.password=choose-any-pass


# JPA Stuff
spring.jpa.hibernate.ddl-auto=validate
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MariaDBDialect


# Flyway
spring.flyway.enabled=true


# Auth
openkm.rest.user=admin
openkm.rest.password=*s3cr3t0*
  • Create the OKMFlow service in /etc/systemd/system/okmflow.service
[Unit]
Description=OKMFlow
After=network.target


[Service]
Type=forking
User=openkm
WorkingDirectory=/opt/okmflow
ExecStart=/bin/bash /opt/okmflow/bin/startup.sh
ExecStop=/bin/bash /opt/okmflow/bin/shutdown.sh


[Install]
WantedBy=multi-user.target
  • Reload the daemon and enable the service
sudo systemctl daemon-reload


sudo systemctl enable okmflow
  • Start the OKMFlow service

OpenKM Configuration steps:

  • Log in to OpenKM and go to Administration > Config
  • Set the workflow.adapter configuration property to com.openkm.workflow.adapter.FlowWorkflowAdapter
  • Set the workflow.adapter.url to the OKMFlow URL (for example, http://localhost:8180/okmflow)
  • Set the workflow.adapter.login to the OKMFlow admin user (by default it’s “admin”)
  • Set the workflow.adapter.password to the OKMFlow “admin” password (by default it’s “admin”)

OKMFlow usage:

  • By default, the OKMFlow application will be available at http://localhost:8180/okmflow. The Admin section is restricted.
  • By default, the user and password are set to “admin” and “admin”. To change them, please go to http://localhost:8180/okmflow and edit the corresponding user.
  • Remember to change the OpenKM configuration property workflow.adapter.password to match the new password.
  • To deploy a workflow, go to http://localhost:8180/okmflow
  • On this page, you can also access previously deployed workflows, process instances and so on.

Configure the database

Section titled “Configure the database”

Configuring MariaDB

Section titled “Configuring MariaDB”
  • Create the database:
CREATE DATABASE okmflow DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_bin;
CREATE USER 'okmflow'@'%' IDENTIFIED BY 'choose-any-pass';
GRANT ALL ON okmflow.* TO 'okmflow'@'%' WITH GRANT OPTION;
  • Create the configuration file $TOMCAT_HOME/okmflow.properties
# Database
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:3306/okmflow?autoReconnect=true&useUnicode=true&characterEncoding=UTF8
spring.datasource.username=okmflow
spring.datasource.password=choose-any-pass


# JPA Stuff
spring.jpa.hibernate.ddl-auto=validate
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MariaDBDialect


# Flyway
spring.flyway.enabled=true


# Auth
openkm.rest.url=http://localhost:8080/openkm
openkm.rest.user=okmAdmin
openkm.rest.password=*s3cr3t0*

Configuring PostgreSQL

Section titled “Configuring PostgreSQL”
  • Create a database
DROP DATABASE IF EXISTS okmflow;
CREATE USER okmflow WITH PASSWORD 'choose-any-pass';
CREATE DATABASE okmflow WITH OWNER okmflow ENCODING 'UTF8';

Or use the command line.

Terminal window
$ createuser --pwprompt okmflow
$ createdb --owner=okmflow --encoding=UTF8 okmflow
  • Create the configuration file $TOMCAT_HOME/okmflow.properties
Terminal window
# Database
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/okmflow
spring.datasource.username=okmflow
spring.datasource.password=choose-any-pass


# JPA Stuff
spring.jpa.hibernate.ddl-auto=validate
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect


# Flyway
spring.flyway.enabled=true


# Auth
openkm.rest.url=http://localhost:8080/openkm
openkm.rest.user=okmAdmin
openkm.rest.password=*s3cr3t0*

Configuring Oracle

Section titled “Configuring Oracle”
  • Create the database
  • Create a tablespace
create tablespace OKMFLOW_DATA datafile '/u01/app/oracle/oradata/XE/okmflow_data.dbf' size 100M;
  • Create a database and user
create user OKMFLOW identified by choose-any-pass default tablespace OKMFLOW_DATA quota unlimited on OKMFLOW_DATA;
grant all privileges to OKMFLOW;
grant create any context, create cluster, create dimension, create indextype, create job, create materialized view, create operator,
   create procedure, create sequence, create session, create synonym, create table, create trigger, create type, create view to OKMFLOW;
  • Create the configuration file $TOMCAT_HOME/okmflow.properties
# Database
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
spring.datasource.url=jdbc:oracle:thin:@localhost:1521:OKMFLOW
spring.datasource.username=OKMFLOW
spring.datasource.password=choose-any-pass


# JPA Stuff
spring.jpa.hibernate.ddl-auto=validate
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.OracleDialect


# Flyway
spring.flyway.enabled=true


# Auth
openkm.rest.url=http://localhost:8080/openkm
openkm.rest.user=okmAdmin
openkm.rest.password=*s3cr3t0*