From 7aee766e0ed8684a375a0c3e196ccc04f46e382f Mon Sep 17 00:00:00 2001 From: Jan Friedenstab <8794084+jfriedenstab@users.noreply.github.com> Date: Thu, 22 Aug 2024 14:59:53 +0200 Subject: [PATCH] docs: improve description of binding type 'latest' + fix XML examples (#4177) --- .../choosing-the-resource-binding-type.md | 50 ++++++++++++++++--- .../business-rule-tasks.md | 3 +- .../bpmn/call-activities/call-activities.md | 3 +- 3 files changed, 48 insertions(+), 8 deletions(-) diff --git a/docs/components/best-practices/modeling/choosing-the-resource-binding-type.md b/docs/components/best-practices/modeling/choosing-the-resource-binding-type.md index cce41816b8b..b3f31bb5f6b 100644 --- a/docs/components/best-practices/modeling/choosing-the-resource-binding-type.md +++ b/docs/components/best-practices/modeling/choosing-the-resource-binding-type.md @@ -21,13 +21,51 @@ For example, for a call activity this would be the version of the called process Camunda 8 supports the following binding types: -| Type | Description | -| :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `latest` |

Resolves to the **latest deployed version** of the target resource at the moment the process element is activated.

| -| `deployment` |

Resolves to the specific version of the target resource that was **deployed together** with the currently running version of the process in the **same deployment**.

| + + + + + + + + + + + + + + + + + +
TypeDescription
latest +

Resolves to the latest deployed version of the target resource at the moment the process element is activated.

+
    +
  • +

    + You can use this option to easily change the target resource at runtime by deploying a new version of the resource. + This allows for fast, iterative development, and easy hot fixes in production: +

    +
      +

    • Process instances that have not yet reached the process element use the newly deployed version of the target resource once the element is activated.

      • +

    • If the process element has already been reached, you can use process instance modification to reactivate and relink it to the newly deployed target resource version.

      • +
    +
    • +

  • Be aware that using latest can lead to unexpected behavior if you deploy a new version of the target resource without ensuring backwards compatibility with every deployed process that depends on it.

    This might not be suited for production environments that require stability and a predictable behavior.

    • +
+
deployment +

Resolves to the specific version of the target resource that was deployed together with the currently running version of the process in the same deployment.

+
    +

  • This option ensures predictable behavior by tying the two versions together, and allows you to deploy future versions of the target resource without disrupting ongoing process instances.

    • +

  • It is ideal for self-contained projects without external or shared dependencies.

    • +
  • +

    To use the deployment binding option, create and deploy a process application in Web Modeler, + or deploy multiple resources together via the Zeebe API. +

    +
    • +
+
:::note - If the binding type is not explicitly specified in your BPMN diagram, `latest` is used as the default. - ::: diff --git a/docs/components/modeler/bpmn/business-rule-tasks/business-rule-tasks.md b/docs/components/modeler/bpmn/business-rule-tasks/business-rule-tasks.md index ae2dd3409e1..9228ae7028a 100644 --- a/docs/components/modeler/bpmn/business-rule-tasks/business-rule-tasks.md +++ b/docs/components/modeler/bpmn/business-rule-tasks/business-rule-tasks.md @@ -110,7 +110,8 @@ A business rule task with a called decision that uses `deployment` binding: ```xml - + ``` diff --git a/docs/components/modeler/bpmn/call-activities/call-activities.md b/docs/components/modeler/bpmn/call-activities/call-activities.md index d592b3086f1..7304637fdef 100644 --- a/docs/components/modeler/bpmn/call-activities/call-activities.md +++ b/docs/components/modeler/bpmn/call-activities/call-activities.md @@ -66,7 +66,8 @@ A call activity with static process id, propagation of all child variables turne ```xml - + ```