Skip to content

Latest commit

 

History

History
85 lines (62 loc) · 8.26 KB

README.md

File metadata and controls

85 lines (62 loc) · 8.26 KB
Raw

mod-workflow

Copyright (C) 2018-2022 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

This module provides a Workflow backend FOLIO module intended to help facilite and interact with one or more Workflow Engines. A Workflow Engine is able to react to events generated in FOLIO and may also trigger events based on some schedule. Triggering Events may be data flows or user interactions.

This module is de-coupled from the Workflow Engine. A Workflow Engine, such as mod-camunda, provides the Business Process Model and Notation (BPMN) and performs the actual execution of a Workflow.

Additional information

The Workflow Documentation describes additional information on particular standards and other topics.

Docker deployment

docker build -t folio/mod-workflow .
docker run -d -p 9001:8081 folio/mod-workflow

Publish docker image

docker login [docker repo]
docker build -t [docker repo]/folio/mod-workflow:[version] .
docker push [docker repo]/folio/mod-workflow:[version]

Environment variables:

The environment variables most notable to deployment are described in the Module Descriptor.

The following is a summary of many of them.

Name Default value Description
DB_CHARSET UTF-8 Database charset.
DB_DATABASE okapi_modules Postgres database name.
DB_HOST postgres Postgres host name.
DB_MAXPOOLSIZE 5 Database max pool size.
DB_PASSWORD - Postgres user password.
DB_PORT 5432 Postgres port.
DB_QUERYTIMEOUT 60000 Database query timeout.
DB_USERNAME folio_admin Postgres user name.
JAVA_OPTIONS -XX:MaxRAMPercentage=75.0 Java options.
KAFKA_HOST kafka Kafka broker host name.
KAFKA_PORT 9092 Kafka broker port.
KAFKA_SECURITY_PROTOCOL PLAINTEXT Kafka security protocol used to communicate with brokers (SSL or PLAINTEXT).
KAFKA_SSL_KEYSTORE_LOCATION - The location of the Kafka key store file. This is optional for client and can be used for two-way authentication for client.
KAFKA_SSL_KEYSTORE_PASSWORD - The store password for the Kafka key store file. This is optional for client and only needed if ssl.keystore.location is configured.
KAFKA_SSL_TRUSTSTORE_LOCATION - The location of the Kafka trust store file.
KAFKA_SSL_TRUSTSTORE_PASSWORD - The password for the Kafka trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled.
OKAPI_URL http://okapi:9130 OKAPI URL used to login system user, required
SERVER_PORT 8081 The port to listen on that must match the PortBindings.
SERVER_SERVLET_CONTEXTPATH / The context path, or base path, to host at.
SPRING_FLYWAY_ENABLED false Database migration support via Spring Flyway.
SPRING_JPA_HIBERNATE_DDLAUTO update Auto-configure database on startup.
TENANT_DEFAULTTENANT diku The name of the default tenant to use.
TENANT_FORCETENANT false Forcibly add or overwrite the tenant name using the default tenant.
TENANT_INITIALIZEDEFAULTTENANT true Perform initial auto-creation of tenant in the database (schema, tables, etc..).
TENANT_RECREATEDEFAULTTENANT false When TENANT_INITIALIZEDEFAULTTENANT is true and the database already exists, then drop and re-create.

Permissions

The permissions provided by this module are described in the Module Descriptor under permissionSets.

The permissions defined are here are specific to the module and are usually not directly added to any user. Instead, permissions available for assignment to users or accounts are found in the ui-workflow Module Permission Sets. These ui-workflow permissions are automatically exposed via the appropriate stripe-ui administration interface.

Issue tracker

See project FOLIO at the FOLIO issue tracker.