|
1 | | -# Process Engine API |
| 1 | +# Process Engine API Documentation |
2 | 2 |
|
3 | 3 |
|
4 | 4 | [](https://github.com/holisticon#open-source-lifecycle) |
5 | 5 | [](https://github.com/bpm-crafters/process-engine-api/actions/workflows/development.yml) |
6 | | -[](https://maven-badges.herokuapp.com/maven-central/dev.bpm-crafters.process-engine-api/process-engine-api) |
7 | | - |
8 | | -## Purpose of the library |
9 | | - |
10 | | -This library provides a modern engine-agnostic API which can be used to implement process applications. By providing a set |
11 | | -of adapters to relevant process engines (Camunda Platform 7, Camunda Platform 8, etc...) the library enforces separation of |
12 | | -the integration of process engine from the selection of the used engine. This approach fosters an easy migration between engines |
13 | | -and tries to achieve to support migrations with minimal (or even no) code modifications. |
14 | | - |
15 | | -## Anatomy |
16 | | - |
17 | | -The library contains of the following Maven modules: |
18 | | - |
19 | | -- `process-engine-api`: pure API written in Kotlin (100% Java-compatible) |
20 | | -- `process-engine-api-impl`: commons implementation, which are independent of the selected engine |
21 | | - |
22 | | -## API |
23 | | - |
24 | | -The API consists of different parts independent of each other. |
25 | | - |
26 | | -- Deployment API |
27 | | -- Process API |
28 | | -- Correlation API |
29 | | -- Signal API |
30 | | -- Task Subscription API |
31 | | -- User Task Completion API |
32 | | -- Service Task Completion API |
33 | | - |
34 | | -The Task API provides functionality to deal with service tasks. The task handlers can be registered and get invoked when tasks |
35 | | -appear in the process engine. Since the Task API allows asynchronous processing, we provide a special API to complete tasks. |
36 | | - |
37 | | -If you want to try the API, please refer to one of the adapter implementations matching your infrastructure. For example: |
38 | | - |
39 | | -- https://github.com/bpm-crafters/process-engine-adapters-camunda-7 |
40 | | -- https://github.com/bpm-crafters/process-engine-adapters-camunda-8 |
41 | 6 |
|
| 7 | +Documentation for Process Engine API and all components created by BPM Crafters. |
42 | 8 |
|
0 commit comments