Skip to content

Commit

Permalink
fix: linked form known issue - recovery tutorial (#3331)
Browse files Browse the repository at this point in the history
* Release issue

* Revert "package issue"

This reverts commit 8a6e18a.

* Update versioned_docs/version-8.4/components/modeler/web-modeler/advanced-modeling/form-linking.md

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update versioned_docs/version-8.4/components/modeler/web-modeler/advanced-modeling/form-linking.md

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update versioned_docs/version-8.4/components/modeler/web-modeler/advanced-modeling/form-linking.md

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update versioned_docs/version-8.4/components/modeler/web-modeler/advanced-modeling/form-linking.md

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update versioned_docs/version-8.4/components/modeler/web-modeler/advanced-modeling/form-linking.md

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>

* Update versioned_docs/version-8.4/components/modeler/web-modeler/advanced-modeling/form-linking.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fix release announcement

* Add under current version of docs

* fix: add missing imports for form link issue

* style(formatting): technical review

* docs: clarify UI navigations

* backport ui adjustments

---------

Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
Co-authored-by: berkaycanbc <berkay.can@camunda.com>
  • Loading branch information
5 people authored Feb 15, 2024
1 parent 042c05a commit 99d0851
Show file tree
Hide file tree
Showing 12 changed files with 68 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: Use one of the following approaches to link a form to a user task o

import FormLinkOverlayImg from './img/utl_overlay.png';
import FormLinkOverlayLinkedImg from './img/utl_linked.png';
import IssueLinkedFormSolution01 from './img/linked_issue01.png';
import IssueLinkedFormSolution02 from './img/linked_issue02.png';
import IssueLinkedFormSolution03 from './img/linked_issue03.png';
import IssueLinkedFormSolution04 from './img/linked_issue04.png';

You can use one of the following approaches to link a form to a [user task](/components/modeler/bpmn/user-tasks/user-tasks.md) or a [none start event](/components/modeler/bpmn/none-events/none-events.md#none-start-events).

Expand Down Expand Up @@ -48,6 +52,35 @@ To deploy to a Camunda 8 cluster with a version lower than 8.4, linked forms wil
This conversion will only be applied to the XML deployed to the cluster; the diagram in Web Modeler will not be changed.
:::

#### Known issues with linked forms

##### Wrong form used for user task - [zeebe/#16311](https://github.com/camunda/zeebe/issues/16311)

Some users have encountered an issue that was present in Camunda `8.4.0`, `8.4.1`, and `8.4.2` where linked forms did not correspond correctly to their tasks, leading to discrepancies in workflow execution. We have identified and rectified this issue in the Camunda `8.4.3` release, ensuring that tasks are now generated with the correct forms, as intended in your workflow design.

###### How to fix the issue - Regenerate tasks with correct forms

To correct any instances affected by this issue, we recommend the following steps after updating to Camunda `8.4.3`:

1. Navigate to [Operate](/components/operate/operate-introduction.md) to access your workflow instances impacted by the linked form issue.
2. Select the instances where tasks were generated with the incorrect forms by clicking on their process instance key, and you will be navigated to the process instance view.
3. Move the instance to the same task, effectively restarting the task. To do this, click the wrench icon in the top right corner:

<img src={IssueLinkedFormSolution01} style={{width: 400}} alt="Modify Process Instance on Operate" />

4. After this, a popup explaining how process modification works will appear. Click **Continue**, select the active task, and click **Cancel instance**.

<img src={IssueLinkedFormSolution02} style={{width: 400}} alt="process instance modification mode" />

<img src={IssueLinkedFormSolution03} style={{width: 400}} alt="cancel instance" />

5. Click **Add** to add a flow node.

<img src={IssueLinkedFormSolution04} style={{width: 400}} alt="add flow node" />

6. Click **Apply notification** to check if the process is correct.
7. Click **Apply**; a new task should be generated with the correct form.

### Camunda Form (embedded)

When choosing **Camunda Form (embedded)** as type you have the option to directly paste the form's JSON schema into the **Form JSON configuration** field of the properties panel.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ End of maintenance: 9th of July 2025
:::caution
The [form linking](/components/modeler/web-modeler/advanced-modeling/form-linking.md#using-the-link-button) feature is impacted by an [issue](https://github.com/camunda/zeebe/issues/16311) where the wrong forms can get linked with new user task instances, effectively corrupting the user task instance. If you make use of this feature and run either `8.4.0`, `8.4.1` or `8.4.2`, we urge you to update to the newest `8.4.3` patch that includes the required fix.

We are also working on preparing instructions to repair affected user task instances and will inform you shortly about those.
Follow the instructions in the [form linking](/components/modeler/web-modeler/advanced-modeling/form-linking.md#known-issues-with-linked-forms) documentation to resolve this issue.
:::

### Versioning changes in Helm chart
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: Use one of the following approaches to link a form to a user task o

import FormLinkOverlayImg from './img/utl_overlay.png';
import FormLinkOverlayLinkedImg from './img/utl_linked.png';
import IssueLinkedFormSolution01 from './img/linked_issue01.png';
import IssueLinkedFormSolution02 from './img/linked_issue02.png';
import IssueLinkedFormSolution03 from './img/linked_issue03.png';
import IssueLinkedFormSolution04 from './img/linked_issue04.png';

You can use one of the following approaches to link a form to a [user task](/components/modeler/bpmn/user-tasks/user-tasks.md) or a [none start event](/components/modeler/bpmn/none-events/none-events.md#none-start-events).

Expand Down Expand Up @@ -48,6 +52,35 @@ To deploy to a Camunda 8 cluster with a version lower than 8.4, linked forms wil
This conversion will only be applied to the XML deployed to the cluster; the diagram in Web Modeler will not be changed.
:::

#### Known issues with linked forms

##### Wrong form used for user task - [zeebe/#16311](https://github.com/camunda/zeebe/issues/16311)

Some users have encountered an issue that was present in Camunda `8.4.0`, `8.4.1`, and `8.4.2` where linked forms did not correspond correctly to their tasks, leading to discrepancies in workflow execution. We have identified and rectified this issue in the Camunda `8.4.3` release, ensuring that tasks are now generated with the correct forms, as intended in your workflow design.

###### How to fix the issue - Regenerate tasks with correct forms

To correct any instances affected by this issue, we recommend the following steps after updating to Camunda `8.4.3`:

1. Navigate to [Operate](/components/operate/operate-introduction.md) to access your workflow instances impacted by the linked form issue.
2. Select the instances where tasks were generated with the incorrect forms by clicking on their process instance key, and you will be navigated to the process instance view.
3. Move the instance to the same task, effectively restarting the task. To do this, click the wrench icon in the top right corner:

<img src={IssueLinkedFormSolution01} style={{width: 400}} alt="Modify Process Instance on Operate" />

4. After this, a popup explaining how process modification works will appear. Click **Continue**, select the active task, and click **Cancel instance**.

<img src={IssueLinkedFormSolution02} style={{width: 400}} alt="process instance modification mode" />

<img src={IssueLinkedFormSolution03} style={{width: 400}} alt="cancel instance" />

5. Click **Add** to add a flow node.

<img src={IssueLinkedFormSolution04} style={{width: 400}} alt="add flow node" />

6. Click **Apply notification** to check if the process is correct.
7. Click **Apply**; a new task should be generated with the correct form.

### Camunda Form (embedded)

When choosing **Camunda Form (embedded)** as type you have the option to directly paste the form's JSON schema into the **Form JSON configuration** field of the properties panel.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion versioned_docs/version-8.4/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ End of maintenance: 9th of July 2025
:::caution
The [form linking](/components/modeler/web-modeler/advanced-modeling/form-linking.md#using-the-link-button) feature is impacted by an [issue](https://github.com/camunda/zeebe/issues/16311) where the wrong forms can get linked with new user task instances, effectively corrupting the user task instance. If you make use of this feature and run either `8.4.0`, `8.4.1` or `8.4.2`, we urge you to update to the newest `8.4.3` patch that includes the required fix.

We are also working on preparing instructions to repair affected user task instances and will inform you shortly about those.
Follow the instructions in the [form linking](/components/modeler/web-modeler/advanced-modeling/form-linking.md#known-issues-with-linked-forms) documentation to resolve this issue.
:::

### Versioning changes in Helm chart
Expand Down

0 comments on commit 99d0851

Please sign in to comment.