@kie-tools/bpmn-editor

The Apache KIE BPMN Editor.

This package exposes the <BpmnEditor> React component. Features include:

• Support for the BPMN 2.0 specification
• Best-effort backwards compatibility with the Apache KIE BPMN Editor (classic) — no longer available (last available in Apache KIE 10.1).
• Extension points compatible with the jBPM Engine and Kogito.
  • WorkItemDefinition (.wid) files for bindings with WorkItemHandlers (WIHs).
  • Acitivity SLAs
  • onEntry/onExit scripts
• Integration with the Drools Engine and Kogito via the Business Rule Task
  • DMN-based Decisions (incl. auto-fill)
  • DRL-based Rules
• Custom Tasks with custom Properties Panel components
• Correlations panel dedicated for event-driven workflows
• Exporting the BPMN diagram to SVG
• Built in the "Controlled component" pattern
• Type-safe model representation (incl. extension points) powered by @kie-tools/bpmn-marshaller

The Apache KIE BPMN Editor is built with Reactflow and shares a lot of good qualities from the Apache KIE DMN Editor, like:

• Grid snapping
• Commands-based programmatic API (E.g., Binding to keyboard shortcuts)
• Infinite canvas
• Multi-node and edge selection

Usage

• Add the <BpmnEditor> component to your React application; or
• Use the Apache KIE BPMN Editor as a standalone JavaScript/TypeScript library. See @kie-tools/bpmn-editor-standalone.

Screenshots

A screenshot of a Hiring process created with Apache KIE BPMN Editor

For development information see:

• 👉 DEV.md
• 👉 TESTS.md
• 👉 ARCHITECTURE.md

Apache KIE (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Some of the incubating project’s releases may not be fully compliant with ASF policy. For example, releases may have incomplete or un-reviewed licensing conditions. What follows is a list of known issues the project is currently aware of (note that this list, by definition, is likely to be incomplete):

• Hibernate, an LGPL project, is being used. Hibernate is in the process of relicensing to ASL v2
• Some files, particularly test files, and those not supporting comments, may be missing the ASF Licensing Header

If you are planning to incorporate this work into your product/project, please be aware that you will need to conduct a thorough licensing review to determine the overall implications of including this work. For the current status of this project through the Apache Incubator visit: https://incubator.apache.org/projects/kie.html