Documentation for Event Sub-processes #10591

DmytroKost · 2026-01-13T13:40:16Z

No description provided.

DmytroKost · 2026-01-13T14:17:21Z

Update images after we have new icons:

static/attachments/refguide/modeling/application-logic/workflows/event-sub-processes/drag-and-drop.png
static/attachments/refguide/modeling/application-logic/workflows/event-sub-processes/notify-workflow.png

hugomendix · 2026-01-14T13:56:53Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+## Introduction
+
+An Event Sub-process is a specialized type of sub-process that is not part of the normal sequence flow of its workflow. Instead, it lives inside the workflow and "listens" for a specific trigger.


"specialized type of sub-process" does not really add any information. Consider rephrasing to "separate execution flow" or something similar.

Instead of writing "instead, ..." it is clearer to say:

"It resides inside the workflow and starts executing upon receiving a specific trigger."

hugomendix · 2026-01-14T14:00:41Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+### When to Use Event Sub-Processes
+
+Choosing between a Boundary Event and an Event Sub-process is a common architectural crossroads.


Maybe you could add a bit of introduction here:

"An Event Sub-Process is like a Boundary Event, with the exception that an Event Sub-Process can start at any time, whereas a Boundary Event can start only while the activity it is attached to is active."

hugomendix · 2026-01-14T14:02:42Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+#### When NOT to Use
+
+- **Sequential Logic** – If the logic must happen after a specific task, use a standard sequence flow.
+- **Direct Interaction** – If you need to "pause" a specific task and resume it, a Boundary Event (Interrupting) is often more appropriate.


How does an Interrupting Boundary Event "resume" a specific task? It does the opposite in my eyes. Also, the use of the word "pause" might be confusing (because in our implementation you can only pause the workflow itself, not individual activities).

Re-phrased and added one more point regarding "Conditional Logic"

hugomendix · 2026-01-14T14:03:16Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+#### Lifecycle
+
+The Event Sub-process is initialized as soon as the main process starts and remains in a waiting state until a notification is received.


Consider adding "(but not started)" after initialized.

hugomendix · 2026-01-14T14:04:33Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+{{% alert color="info" %}}
+**What keeps a workflow In Progress?** A workflow instance remains in the **In Progress** state as long as **at least one** of the following is true:
+  - The Main Process path has not yet reached its End Event.
+  - Any Event Sub-process that was triggered is still executing.


Consider using similar wording here as in the previous bullet point:

"Any Event Sub-Process that was started has not yet reached its End Event."

hugomendix · 2026-01-14T14:18:13Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+| Attribute    | Type    | Description                                                                   |
+|--------------|---------|-------------------------------------------------------------------------------|
+| `Caption`    | String  | The display name of the sub-process.                                          |


Yesterday I learned that a User Task has both a caption and a display name (which is confusing in itself). I don't think the SubProcess does, but maybe it's better to refrain from using "display name" nevertheless.

Changed to "caption" so that there is no ambiguity

hugomendix · 2026-01-14T14:19:59Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+### WorkflowSubProcess
+
+The `WorkflowSubProcess` entity represents a specific runtime instance of an Event Sub-process.


Maybe add here that we only create such an instance when the sub-process is started.

hugomendix · 2026-01-14T14:20:14Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+| Attribute   | Type               | Description                                                                                                                    |
+|-------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------|
+| `Caption`   | String             | The display name of the sub-process instance.                                                                                  |


Same comments as for the definition.

hugomendix · 2026-01-14T14:22:49Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+| `WorkflowUserTask_WorkflowSubProcess`             | `WorkflowUserTask`        | The association to active user tasks within this sub-process instance.                                           |
+| `WorkflowEndedUserTask_WorkflowSubProcess`        | `WorkflowEndedUserTask`   | The association to completed or ended user tasks within this instance.                                           |
+| `WorkflowActivityRecord_WorkflowSubProcess`       | `WorkflowActivityRecord`  | The association to the historical execution records for this instance.                                           |
+| `WorkflowCurrentActivity_WorkflowSubProcess`      | `WorkflowCurrentActivity` | The association to the activity currently being executed in this sub-process (see [Jump to](/refguide/jump-to/). |


Consider changing "activity" to "activities", because there can be multiple.

hugomendix · 2026-01-14T14:23:24Z

content/en/docs/refguide/modeling/application-logic/workflows/event-sub-processes.md

+
+| Caption     | Name         | Description                                                                                               |
+|-------------|--------------|-----------------------------------------------------------------------------------------------------------|
+| In progress | `InProgress` | The sub-process has been triggered and is currently executing logic.                                      |


I think it is better to drop the word "logic".

Documentation for Event Sub-processes

7ae456b

DmytroKost added 2 commits January 13, 2026 16:04

Document new conflict Current Event Sub-Process Removed

7d1fadd

Update description for CurrentActivityMovedOutOfPath conflict

18e602c

Yiyun333 self-assigned this Jan 14, 2026

hugomendix suggested changes Jan 14, 2026

View reviewed changes

DmytroKost added 3 commits January 14, 2026 16:41

Review comments

a94b5aa

Review comments

b16e490

Update Notify workflow action

a5b0e96


		## Introduction

		An Event Sub-process is a specialized type of sub-process that is not part of the normal sequence flow of its workflow. Instead, it lives inside the workflow and "listens" for a specific trigger.


		### When to Use Event Sub-Processes

		Choosing between a Boundary Event and an Event Sub-process is a common architectural crossroads.


		#### Lifecycle

		The Event Sub-process is initialized as soon as the main process starts and remains in a waiting state until a notification is received.


		### WorkflowSubProcess

		The `WorkflowSubProcess` entity represents a specific runtime instance of an Event Sub-process.

Documentation for Event Sub-processes #10591

Are you sure you want to change the base?

Documentation for Event Sub-processes #10591

Uh oh!

Conversation

DmytroKost commented Jan 13, 2026

Uh oh!

DmytroKost commented Jan 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants