Skip to content

Commit bf5ed22

Browse files
Revert "fix: temporary configuration changes for 8.9.0-alpha1 release, removing references to Unified Configuration"
This reverts commit 52661f5.
1 parent efc0b9f commit bf5ed22

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

docs/components/concepts/global-user-task-listeners.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,18 @@ They are particularly useful for:
2222

2323
## Configure global user task listeners
2424

25-
Set global user task listeners at the cluster level using the `zeebe.broker.experimental.listeners.task` path in the broker configuration.
25+
You configure global user task listeners at the cluster level in the [Unified Configuration](/self-managed/components/orchestration-cluster/core-settings/configuration/properties.md#camundaclusterglobal-listeners).
26+
27+
Configuration path: `camunda.cluster.global-listeners.user-task`
2628

2729
Each listener entry can be configured with the following properties:
2830

29-
| Property | Required | Description |
30-
| :------------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
31-
| `event-types` | Yes | <p>List of user task event types that trigger the listener.</p><p>Supported values: `creating`, `assigning`, `updating`, `completing`, `canceling`.</p><p>The shorthand `all` value is also available if the listener should react to all lifecycle events.</p> |
32-
| `type` | Yes | <p>The name of the job type.</p><p>Used as a reference to specify which job workers request the respective task listener job. For example, `order-items`.</p> |
33-
| `retries` | No | Number of retries for the user task listener job. Defaults to `3` if not set. |
34-
| `after-local` | No | Boolean indicating whether the listener should run after model-level listeners. Defaults to `false` (runs before model-level listeners). |
31+
| Property | Required | Description |
32+
|:-------------------| :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
33+
| `event-types` | Yes | <p>List of user task event types that trigger the listener.</p><p>Supported values: `creating`, `assigning`, `updating`, `completing`, `canceling`.</p><p>The shorthand `all` value is also available if the listener should react to all lifecycle events.</p> |
34+
| `type` | Yes | <p>The name of the job type.</p><p>Used as a reference to specify which job workers request the respective task listener job. For example, `order-items`.</p> |
35+
| `retries` | No | Number of retries for the user task listener job. Defaults to `3` if not set. |
36+
| `after-non-global` | No | Boolean indicating whether the listener should run after model-level listeners. Defaults to `false` (runs before model-level listeners). |
3537

3638
### How the configuration is validated
3739

@@ -50,37 +52,35 @@ In all cases, a suitable warning is reported in the orchestration cluster startu
5052
The following is an example YAML configuration and environment variables:
5153

5254
```yaml
53-
zeebe:
54-
broker:
55-
experimental:
56-
engine:
57-
listeners:
58-
task:
59-
- type: "validate-task"
60-
event-types:
61-
- creating
62-
- type: "audit-generic"
63-
event-types: all
64-
retries: 5
65-
- type: "notify-assignee"
66-
event-types:
67-
- assigning
68-
- updating
69-
- canceling
70-
after-local: true
55+
camunda:
56+
cluster:
57+
global-listeners:
58+
user-task:
59+
- type: "validate-task"
60+
event-types:
61+
- creating
62+
- type: "audit-generic"
63+
event-types: all
64+
retries: 5
65+
- type: "notify-assignee"
66+
event-types:
67+
- assigning
68+
- updating
69+
- canceling
70+
after-non-global: true
7171
```
7272
7373
```
74-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_0_TYPE=validate-task
75-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_0_EVENT_TYPES_0=creating
76-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_1_TYPE=audit-generic
77-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_1_EVENT_TYPES_0=all
78-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_1_RETRIES=5
79-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_2_TYPE=notify-assignee
80-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_2_EVENT_TYPES_0=assigning
81-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_2_EVENT_TYPES_1=updating
82-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_2_EVENT_TYPES_2=canceling
83-
ZEEBE_BROKER_EXPERIMENTAL_ENGINE_LISTENERS_TASK_2_AFTER_LOCAL=true
74+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_0_TYPE=validate-task
75+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_0_EVENT_TYPES_0=creating
76+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_1_TYPE=audit-generic
77+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_1_EVENT_TYPES_0=all
78+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_1_RETRIES=5
79+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_2_TYPE=notify-assignee
80+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_2_EVENT_TYPES_0=assigning
81+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_2_EVENT_TYPES_1=updating
82+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_2_EVENT_TYPES_2=canceling
83+
CAMUNDA_CLUSTER_GLOBAL_LISTENERS_USER_TASK_2_AFTER_NON_GLOBAL=true
8484
```
8585

8686
### Apply changes
@@ -95,7 +95,7 @@ For a given event on a task instance:
9595

9696
- Global listeners run in the order defined in the configuration.
9797
- Model-level listeners run next, in the order defined in the BPMN model.
98-
- Global listeners marked with `after-local: true` run after model-level listeners.
98+
- Global listeners marked with `after-non-global: true` run after model-level listeners.
9999

100100
## Supported features
101101

0 commit comments

Comments
 (0)