From 269a22c32f46b0c55f6733310e530d402c3c88b3 Mon Sep 17 00:00:00 2001 From: Nico Korthout Date: Fri, 20 Dec 2024 16:28:55 +0100 Subject: [PATCH 1/2] docs: describe changed user task events This is relevant to users updating from 8.6 to 8.7 that rely on the `ASSIGNING` record from the exporters specifically. Either because they build their own exporter, or because they use the data in ES/OS or some other external data storage that has received this information. Co-authored-by: Dmitriy Melnychuk <123628255+ce-dmelnych@users.noreply.github.com> Co-authored-by: Ana <148554252+ana-vinogradova-camunda@users.noreply.github.com> --- .../update-guide/860-to-870.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/self-managed/operational-guides/update-guide/860-to-870.md b/docs/self-managed/operational-guides/update-guide/860-to-870.md index 205beda3075..6d04a176953 100644 --- a/docs/self-managed/operational-guides/update-guide/860-to-870.md +++ b/docs/self-managed/operational-guides/update-guide/860-to-870.md @@ -12,3 +12,31 @@ The following sections explain which adjustments must be made to migrate from Ca Configuring a non-existing bucket for backups will not prevent Zeebe to start up anymore and will only result in logs (at WARN) in the startup phase. + +## Exported records + +### `USER_TASK` records + +To support User Task Listeners, some backward incompatible changes were necessary to the exported `USER_TASK` records. + +#### `ASSIGNING` has become `CLAIMING` for `CLAIM` operation + +When claiming a user task, we previously appended the following records of the `USER_TASK` value type: + +- `CLAIM` +- `ASSIGNING` +- `ASSIGNED` + +A new `CLAIMING` intent was introduced to distinquish between claiming and regular assigning. +We now append the following records when claiming a user task: + +- `CLAIM` +- `CLAIMING` +- `ASSIGNED` + +The `ASSIGNING` event is still appended for assigning a user task. +In that case, we append the following records: + +- `ASSIGN` +- `ASSIGNING` +- `ASSIGNED` From c808b614d4ba4233bf7735202dc31190788681bc Mon Sep 17 00:00:00 2001 From: Nico Korthout Date: Fri, 20 Dec 2024 16:47:49 +0100 Subject: [PATCH 2/2] docs: describe assignee not in created events This is relevant to anyone depending on the `assignee` in the exported `USER_TASK` records `CREATING/CREATED`. Co-authored-by: Ana <148554252+ana-vinogradova-camunda@users.noreply.github.com> Co-authored-by: Dmitriy Melnychuk <123628255+ce-dmelnych@users.noreply.github.com> --- .../update-guide/860-to-870.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/self-managed/operational-guides/update-guide/860-to-870.md b/docs/self-managed/operational-guides/update-guide/860-to-870.md index 6d04a176953..d8604906a77 100644 --- a/docs/self-managed/operational-guides/update-guide/860-to-870.md +++ b/docs/self-managed/operational-guides/update-guide/860-to-870.md @@ -19,6 +19,25 @@ in logs (at WARN) in the startup phase. To support User Task Listeners, some backward incompatible changes were necessary to the exported `USER_TASK` records. +#### `assignee` no longer provided in `CREATING/CREATED` events + +Previously, when a user task was activating with a specified `assignee`, +we appended the following events of the `USER_TASK` value type: + +- `CREATING` with `assignee` property as provided +- `CREATED` with `assignee` property as provided + +The `ASSIGNING` and `ASSIGNED` events were not appended in this case. + +To support the new User Task Listeners feature, the `assignee` value will not be filled in the `CREATING` and `CREATED` events anymore. + +With 8.7, the following events are now appended: + +- `CREATING` with `assignee` always `""` (empty string) +- `CREATED` with `assignee` always `""` (empty string) +- `ASSIGNING` with `assignee` property as provided +- `ASSIGNED` with `assignee` property as provided + #### `ASSIGNING` has become `CLAIMING` for `CLAIM` operation When claiming a user task, we previously appended the following records of the `USER_TASK` value type: