Skip to content

Development

This section provides technical documentation for developers working with OKMFlow. Here you will find the necessary information to design, implement, and customize workflows that integrate with OpenKM.

Section content Description
Process modelling Describes the fundamental elements of a workflow: the different node types (Start, End, Task, Action, Decision, Mail, Scheduled, Library) and the transitions that connect them to define the execution flow.
Working with UI Working with UI documents the OKMFlow web interface: the Home panel for monitoring processes, the Designer for visual workflow design, user and role management, and available administrative tools.
API Description The API description documents the utility classes available for scripting: FileLogger, FileUtils, PathUtils, StackTraceUtils, and WorkflowUtils. These classes are available in Action, Decision, and Library nodes.
Database description The database description details the OKMFlow data schema: definition tables (workflow structure) and execution tables (runtime state). It includes ER diagrams and SQL query examples.
Workflow Beans Workflow Beans are objects that represent system entities: Actor, ProcessDefinition, ProcessInstance, TaskInstance, and their DTO versions available through the WorkflowUtils API.
Workflow forms definition The workflow forms definition explains how to create user interfaces using XML for tasks: DTD structure, available field types (input, textarea, select, button, etc.), and their configuration.
Samples The samples provide reference workflows demonstrating different functionalities: from basic cases (Quick start, process variables) to advanced examples (parallel workflows, REST integration, scheduled tasks).