Skip to content

Refactor/self contained examples #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kthoms wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Refactor/self contained examples #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9dcab1e
feat: Create script to make examples self-contained and apply transfo…
kthoms Jul 6, 2026
7fa7cdc
fix: Correct XML logic in self-contained transformation script
kthoms Jul 6, 2026
6d095d4
feat: Add colima profile to all 47 examples
kthoms Jul 6, 2026
8e635b4
fix: Correct contract-signing pom.xml
kthoms Jul 6, 2026
0cdcfae
feat: Add colima profile to root aggregator pom.xml
kthoms Jul 6, 2026
99f71f3
fix: Fixed contract-signing use case
kthoms Jul 7, 2026
99b3fe2
chore: Update table
kthoms Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 27 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,6 @@ example means testing its processes against real integrations.
|---|---|
| JDK | 21 |
| Docker | any recent version (required for tests and local run) |
| Distribution images (`operaton/tomcat`, `operaton/wildfly`, `operaton/operaton`) | `2.1.1` |
| `operaton-keycloak-run` (plugin) | `2.1.0` |
| AWS SDK v2 | 2.29.0 |
| Apache PDFBox | 3.0.7 |

Pinned stack (all examples): Spring Boot **4.1.0**, Operaton **2.1.1**,
Maven Wrapper **3.9.12**, Gradle Wrapper **9.2.0**, PostgreSQL **16**.

## Using an example

Expand Down Expand Up @@ -131,33 +124,33 @@ Quick lookup: which example demonstrates each BPMN construct.

### BPMN Concepts

| BPMN Concept | Example(s) | Notes |
|---|---|---|
| Service task | <ul><li>[getting-started](examples/core-examples/getting-started)</li><li>[service-tasks](examples/core-examples/service-tasks)</li></ul> | Java delegate, Spring bean, expression |
| User task | [user-task-forms](examples/core-examples/user-task-forms) | Forms, candidate groups |
| Script task | [service-tasks](examples/core-examples/service-tasks) | JavaScript / Groovy inline |
| Business rule task (DMN) | <ul><li>[dmn-decision](examples/core-examples/dmn-decision)</li><li>[insurance-claim](examples/use-cases/insurance-claim)</li></ul> | FEEL expressions, hit policies |
| Exclusive gateway (XOR) | <ul><li>[getting-started](examples/core-examples/getting-started)</li><li>[dmn-decision](examples/core-examples/dmn-decision)</li></ul> | Default flow, condition expressions |
| **Parallel gateway (AND)** | **[insurance-claim](examples/use-cases/insurance-claim)** | AND-split / AND-join, concurrent branches |
| **Event-based gateway** | **[insurance-claim](examples/use-cases/insurance-claim)** | Race between message and timer |
| Inclusive gateway (OR) | [inclusive-gateway](examples/core-examples/inclusive-gateway) | OR-split / OR-join |
| Message start event | <ul><li>[message-events](examples/core-examples/message-events)</li><li>[procurement-collaboration](examples/use-cases/procurement-collaboration)</li></ul> | Start by message correlation |
| Timer start event | [timer-events](examples/core-examples/timer-events) | Cron, cycle, duration |
| Message intermediate catch | <ul><li>[message-events](examples/core-examples/message-events)</li><li>[insurance-claim](examples/use-cases/insurance-claim)</li><li>[procurement-collaboration](examples/use-cases/procurement-collaboration)</li></ul> | Correlation by business key |
| Timer intermediate catch | <ul><li>[timer-events](examples/core-examples/timer-events)</li><li>[insurance-claim](examples/use-cases/insurance-claim)</li></ul> | ISO-8601 duration variable |
| Signal intermediate catch/throw | [signal-events](examples/core-examples/signal-events) | Broadcast signal |
| Error boundary event | [error-compensation](examples/core-examples/error-compensation) | Interrupting and non-interrupting |
| Compensation | <ul><li>[error-compensation](examples/core-examples/error-compensation)</li><li>[travel-booking](examples/use-cases/travel-booking)</li></ul> | Manual throw (error-compensation) vs. transaction-driven (travel-booking) |
| **Transaction subprocess** | **[travel-booking](examples/use-cases/travel-booking)** | All-or-nothing SAGA; cancel end event triggers auto-compensation |
| **Cancel event (end + boundary)** | **[travel-booking](examples/use-cases/travel-booking)** | Cancel end event inside transaction + cancel boundary on transaction |
| Multi-instance | <ul><li>[multi-instance](examples/core-examples/multi-instance)</li><li>[employee-onboarding](examples/use-cases/employee-onboarding)</li></ul> | Sequential and parallel sub-tasks; collection-driven parallel MI call activity |
| **Call activity** | <ul><li>[call-activity](examples/core-examples/call-activity)</li><li>[employee-onboarding](examples/use-cases/employee-onboarding)</li></ul> | Sub-process reuse, in/out variable mapping, parallel multi-instance over collection |
| Event sub-process | [event-subprocess](examples/core-examples/event-subprocess) | Error- and message-triggered |
| External task | [external-task-worker](examples/core-examples/external-task-worker) | Worker API, long polling |
| Async continuation | <ul><li>[async-continuation](examples/core-examples/async-continuation)</li><li>[procurement-collaboration](examples/use-cases/procurement-collaboration)</li></ul> | `asyncBefore`, exclusive job lock |
| **Escalation events** | **[complaint-resolution](examples/use-cases/complaint-resolution)** | Non-interrupting throw + boundary (parallel), interrupting end event + boundary (cancel) |
| **Collaboration / message flow (two pools)** | **[procurement-collaboration](examples/use-cases/procurement-collaboration)** | Two process definitions communicating via message correlation within one engine |
| **Cross-instance correlation key** | **[procurement-collaboration](examples/use-cases/procurement-collaboration)** | `processInstanceVariableEquals()` routes messages to the correct instance by `requestId` |
| BPMN Concept | Example(s) | Notes |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| Service task | <ul><li>[getting-started](examples/core-examples/getting-started)</li><li>[service-tasks](examples/core-examples/service-tasks)</li></ul> | Java delegate, Spring bean, expression |
| User task | <ul><li>[user-task-forms](examples/core-examples/user-task-forms)</li></ul> | Forms, candidate groups |
| Script task | <ul><li>[service-tasks](examples/core-examples/service-tasks)</li></ul> | JavaScript / Groovy inline |
| Business rule task (DMN) | <ul><li>[dmn-decision](examples/core-examples/dmn-decision)</li><li>[insurance-claim](examples/use-cases/insurance-claim)</li></ul> | FEEL expressions, hit policies |
| Exclusive gateway (XOR) | <ul><li>[getting-started](examples/core-examples/getting-started)</li><li>[dmn-decision](examples/core-examples/dmn-decision)</li></ul> | Default flow, condition expressions |
| Parallel gateway (AND) | <ul><li>[insurance-claim](examples/use-cases/insurance-claim)</li></ul> | AND-split / AND-join, concurrent branches |
| Event-based gateway | <ul><li>[insurance-claim](examples/use-cases/insurance-claim)</li></ul> | Race between message and timer |
| Inclusive gateway (OR) | <ul><li>[inclusive-gateway](examples/core-examples/inclusive-gateway)</li></ul> | OR-split / OR-join |
| Message start event | <ul><li>[message-events](examples/core-examples/message-events)</li><li>[procurement-collaboration](examples/use-cases/procurement-collaboration)</li></ul> | Start by message correlation |
| Timer start event | [timer-events](examples/core-examples/timer-events) | Cron, cycle, duration |
| Message intermediate catch | <ul><li>[message-events](examples/core-examples/message-events)</li><li>[insurance-claim](examples/use-cases/insurance-claim)</li><li>[procurement-collaboration](examples/use-cases/procurement-collaboration)</li></ul> | Correlation by business key |
| Timer intermediate catch | <ul><li>[timer-events](examples/core-examples/timer-events)</li><li>[insurance-claim](examples/use-cases/insurance-claim)</li></ul> | ISO-8601 duration variable |
| Signal intermediate catch/throw | [signal-events](examples/core-examples/signal-events) | Broadcast signal |
| Error boundary event | [error-compensation](examples/core-examples/error-compensation) | Interrupting and non-interrupting |
| Compensation | <ul><li>[error-compensation](examples/core-examples/error-compensation)</li><li>[travel-booking](examples/use-cases/travel-booking)</li></ul> | Manual throw (error-compensation) vs. transaction-driven (travel-booking) |
| Transaction subprocess | [travel-booking](examples/use-cases/travel-booking) | All-or-nothing SAGA; cancel end event triggers auto-compensation |
| Cancel event (end + boundary | [travel-booking](examples/use-cases/travel-booking) | Cancel end event inside transaction + cancel boundary on transaction |
| Multi-instance | <ul><li>[multi-instance](examples/core-examples/multi-instance)</li><li>[employee-onboarding](examples/use-cases/employee-onboarding)</li></ul> | Sequential and parallel sub-tasks; collection-driven parallel MI call activity |
| Call activity | <ul><li>[call-activity](examples/core-examples/call-activity)</li><li>[employee-onboarding](examples/use-cases/employee-onboarding)</li></ul> | Sub-process reuse, in/out variable mapping, parallel multi-instance over collection |
| Event sub-process | [event-subprocess](examples/core-examples/event-subprocess) | Error- and message-triggered |
| External task | [external-task-worker](examples/core-examples/external-task-worker) | Worker API, long polling |
| Async continuation | <ul><li>[async-continuation](examples/core-examples/async-continuation)</li><li>[procurement-collaboration](examples/use-cases/procurement-collaboration)</li></ul> | `asyncBefore`, exclusive job lock |
| Escalation event | [complaint-resolution](examples/use-cases/complaint-resolution | Non-interrupting throw + boundary (parallel), interrupting end event + boundary (cancel) |
| Collaboration / message flow (two pools | [procurement-collaboration](examples/use-cases/procurement-collaboration) | Two process definitions communicating via message correlation within one engine |
| Cross-instance correlation key | [procurement-collaboration](examples/use-cases/procurement-collaboration) | `processInstanceVariableEquals()` routes messages to the correct instance by `requestId` |

### Integrations

Expand All @@ -179,7 +172,6 @@ Quick lookup: which example demonstrates each BPMN construct.
| Quarkus (embedded) | platform-integration/runtime-quarkus |
| Tomcat (shared engine) | platform-integration/distribution-tomcat |
| WildFly (shared engine) | platform-integration/distribution-wildfly |
| Flowset Control + SSO (Keycloak) | operaton-example-projects / operaton-flowset-sso |
| Operaton Run + Keycloak plugin (custom image) | platform-integration/integration-keycloak |

## License
Expand Down
78 changes: 62 additions & 16 deletions examples/advanced-features/bpmn-model-api-generate/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.operaton.examples</groupId>
<artifactId>operaton-examples-aggregate</artifactId>
<version>0.1.0-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

<groupId>org.operaton.examples</groupId>
<artifactId>bpmn-model-api-generate</artifactId>
<version>0.1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Operaton Example: BPMN Model API Generate</name>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.release>21</maven.compiler.release>
<spring-boot.version>4.1.0</spring-boot.version>
<operaton.version>2.1.2</operaton.version>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
Expand All @@ -42,7 +30,6 @@
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>org.operaton.bpm.springboot</groupId>
Expand All @@ -57,7 +44,6 @@
<artifactId>postgresql</artifactId>
<scope>runtime</scope>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
Expand All @@ -79,7 +65,6 @@
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
Expand All @@ -90,7 +75,68 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>3.5.6</version>
<executions>
<execution>
<goals>
<goal>integration-test</goal>
<goal>verify</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>rancher</id>
<activation>
<file>
<exists>${user.home}/.rd/docker.sock</exists>
</file>
</activation>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<environmentVariables>
<DOCKER_HOST>unix://${user.home}/.rd/docker.sock</DOCKER_HOST>
<TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE>/var/run/docker.sock</TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE>
<TESTCONTAINERS_RYUK_DISABLED>true</TESTCONTAINERS_RYUK_DISABLED>
</environmentVariables>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
</profile>
<profile>
<id>colima</id>
<activation>
<file>
<exists>${user.home}/.colima/default/docker.sock</exists>
</file>
</activation>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<environmentVariables>
<DOCKER_HOST>unix://${user.home}/.colima/default/docker.sock</DOCKER_HOST>
<TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE>${user.home}/.colima/default/docker.sock</TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE>
<TESTCONTAINERS_RYUK_DISABLED>true</TESTCONTAINERS_RYUK_DISABLED>
</environmentVariables>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
</profile>
</profiles>
</project>
Loading
Loading