docs(modeler): updated the docs to reflect the variableNames changes#8061
docs(modeler): updated the docs to reflect the variableNames changes#8061giorgionaps wants to merge 3 commits intomainfrom
Conversation
|
👋 🤖 🤔 Hello, @giorgionaps! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
|
||
| ### Expression-based subscriptions | ||
|
|
||
| When a conditional event is activated, the engine analyzes its FEEL condition and derives which variables |
There was a problem hiding this comment.
I think the spacing is a little off here, no?
| #### Variable filter semantics | ||
|
|
||
| Conditional events can define variable filters to limit when the engine re-evaluates the condition. | ||
| By default, the engine derives the set of variables that can trigger an event from the FEEL expression. |
There was a problem hiding this comment.
Same here, shouldn't this be a paragraph as opposed to several separate lines?
| Define variable filters unless you intentionally want the event to be evaluated on every variable change while the condition is satisfied. | ||
|
|
||
| Without a filter, a conditional event whose condition evaluates to `true` can trigger repeatedly. | ||
| Even with expression-based dependencies and optional filters, a conditional event whose condition evaluates to `true` can trigger repeatedly while it remains `true` (for example, for non-interrupting events). |
There was a problem hiding this comment.
I didn't want to flag every instance, but the line spacing appears to be off, perhaps from copilot or copy/paste issues? I would likely also suggest turning a series of sentences on separate lines into clean, concise paragraphs where possible. Let me know if the spacing was intentional for another reason but otherwise would clear up this whitespace 👍
The build is also failing, so not sure if you just need to re-run or merge in main to resolve. I also didn't see an issue linked, not sure if this is tracked in a particular ticket or if we need to create one? Let me know if you need any help!
Consolidate multiple lines into single sentences for clarity.
@christinaausley there seemed to be an issue indeed. Not sure what happened there as it looked normal in my vs code setup haha. Thanks for pointing that out, should be fixed now. 👌 |
|
|
||
| The semantics described below apply to conditional events within running process instances. | ||
| For process-level conditional start events, see [Trigger root-level conditional start events via API](#trigger-root-level-conditional-start-events-via-api). | ||
| The semantics described below apply to conditional events within running process instances. For process-level conditional start events, see [Trigger root-level conditional start events via API](#trigger-root-level-conditional-start-events-via-api). |
There was a problem hiding this comment.
| The semantics described below apply to conditional events within running process instances. For process-level conditional start events, see [Trigger root-level conditional start events via API](#trigger-root-level-conditional-start-events-via-api). | |
| The semantics described below apply to conditional events within running process instances. For process-level conditional start events, see [trigger root-level conditional start events via API](#trigger-root-level-conditional-start-events-via-api). |
Nitpick 😄
|
|
||
| In addition to scope activation, conditional events can also be triggered when relevant variables change within the event’s visible scope. | ||
| When a variable changes (for example, it is created or updated), the engine evaluates the condition for any active conditional events in the variable's scope and all child scopes (see [Top-down evaluation](#top-down-evaluation)). | ||
| When a variable changes (for example, it is created or updated), the engine evaluates the condition for any active conditional events in the variable's scope and all child scopes whose condition depends on that variable (see [Top-down evaluation](#top-down-evaluation)). |
There was a problem hiding this comment.
| When a variable changes (for example, it is created or updated), the engine evaluates the condition for any active conditional events in the variable's scope and all child scopes whose condition depends on that variable (see [Top-down evaluation](#top-down-evaluation)). | |
| When a variable changes (for example, it is created or updated), the engine evaluates the condition for any active conditional events in the variable's scope and all child scopes whose condition depends on that variable (see [top-down evaluation](#top-down-evaluation)). |
| If the process instance updates variable `x` to `11` (for example, via the [Update element instance variables API](../../apis-tools/orchestration-cluster-api-rest/specifications/create-element-instance-variables.api.mdx)), the engine evaluates the condition for the conditional start event in the event subprocess. | ||
| Since the condition is now `true`, the conditional start event triggers and the event subprocess starts. | ||
| An event subprocess with a conditional start event is defined with condition `x > 10`. Assume the process instance starts with variable `x` initialized to `5`. The main process starts and executes the service task, while the event subprocess is not triggered because the condition is not satisfied. | ||
| If the process instance updates variable `x` to `11` (for example, via the [Update element instance variables API](../../apis-tools/orchestration-cluster-api-rest/specifications/create-element-instance-variables.api.mdx)), the engine evaluates the condition for the conditional start event in the event subprocess. Since the condition is now `true`, the conditional start event triggers and the event subprocess starts. |
There was a problem hiding this comment.
| If the process instance updates variable `x` to `11` (for example, via the [Update element instance variables API](../../apis-tools/orchestration-cluster-api-rest/specifications/create-element-instance-variables.api.mdx)), the engine evaluates the condition for the conditional start event in the event subprocess. Since the condition is now `true`, the conditional start event triggers and the event subprocess starts. | |
| If the process instance updates variable `x` to `11` (for example, via the [update element instance variables API](../../apis-tools/orchestration-cluster-api-rest/specifications/create-element-instance-variables.api.mdx)), the engine evaluates the condition for the conditional start event in the event subprocess. Since the condition is now `true`, the conditional start event triggers and the event subprocess starts. |
christinaausley
left a comment
christinaausley
left a comment
There was a problem hiding this comment.
I would just adjust links across both files so they don't capitalize the first word, [this for example]() instead of [This for example]() 👍
2 participants
Description
Doc updates that reflect the decision to remove the variableNames filter and add auto variable name filter detection for conditional events.
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.9)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.