Skip to content
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

Document user task listeners for user task modeling #4814

Merged
merged 3 commits into from
Jan 9, 2025
Merged

Document user task listeners for user task modeling #4814

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a37f870
docs: Document user task listeners for user task modeling
ce-dmelnych Jan 2, 2025
5c93e6b
style(formatting): minor grammatical tweak
christinaausley Jan 7, 2025
d251804
docs: re-wording and clarification
ana-vinogradova-camunda Jan 9, 2025
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
38 changes: 38 additions & 0 deletions docs/components/modeler/bpmn/user-tasks/user-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,27 @@ A user task can define an arbitrary number of `taskHeaders`; they are static
metadata stored with the user task in Zeebe. The headers can be used as
configuration parameters for tasklist applications.

### User task listeners

User tasks support **user task listeners**, which allow you to react to user task lifecycle events.

#### Supported events

Currently, user task listeners can react to the following events:

- **Assigning**: Triggered while assigning a user task.
- **Completing**: Triggered while completing a user task.

#### Configuration

To define a user task listener, include the `zeebe:taskListeners` extension element within the user task in your BPMN model. This element can contain one or more `zeebe:taskListener` elements, each specifying the following attributes:

- The `eventType` that triggers the listener (`"assigning"` or `"completing"`).
- The `type` of the listener (job type used by the external worker).
- The number of `retries` for the user task listener job (defaults to 3 if omitted).

For more details, see [user task listeners](components/concepts/user-task-listeners.md).

## Job worker implementation

A user task does not have to be managed by Zeebe. Instead, you can also use
Expand Down Expand Up @@ -285,9 +306,26 @@ A job-based user task with an embedded Camunda Form:
</bpmn:process>
```

#### User task listeners

A user task with user task listeners configured:

```xml
<bpmn:userTask id="configure" name="Configure">
<bpmn:extensionElements>
<zeebe:taskListeners>
<zeebe:taskListener eventType="assigning" type="assigning-user-task-listener" retries="5" />
<zeebe:taskListener eventType="completing" type="completing-user-task-listener" />
</zeebe:taskListeners>
<zeebe:userTask/>
</bpmn:extensionElements>
</bpmn:userTask>
```

### References

- [Tasklist](/components/tasklist/introduction-to-tasklist.md)
- [Form linking in Modeler](/components/modeler/web-modeler/advanced-modeling/form-linking.md)
- [Job handling](/components/concepts/job-workers.md)
- [Variable mappings](/components/concepts/variables.md#inputoutput-variable-mappings)
- [User task listeners](/components/concepts/user-task-listeners.md)
Loading