docs(Modeler): Add cluster variable documentation #7462
Conversation
|
👋 🤖 🤔 Hello, @afgambin! 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. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ### Common Usage Locations in BPMN | ||
|
|
||
| #### Service Task Input Mappings |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[all.glossary] Inconsistent spelling detected. Use Service task instead of Service Task. Review the WCoE glossary - https://confluence.camunda.com/x/b5RZBw .
afgambin
added
component:docs
afgambin
changed the title
| @@ -0,0 +1,119 @@ | |||
| --- | |||
| id: cluster-variable-core-concepts | |||
There was a problem hiding this comment.
This metadata must be added to each new file. The sidebar determines how the page appears in the left‑hand nav bar, and the id is how it’s identified internally.
|
|
||
| Explore an understand the core concepts of cluster variables. | ||
|
|
||
| ## Scope Levels |
There was a problem hiding this comment.
We use sentence case spelling for headings. Also, we start headings with H2 and add granularity (H3, H4, etc) as we go deeper in subsections. Please refer to our style guide for more details: https://github.com/camunda/camunda-docs/blob/main/howtos/technical-writing-styleguide.md
| @@ -0,0 +1,20 @@ | |||
| import IconPlayImg from "../assets/icon-play.png"; | |||
There was a problem hiding this comment.
This file is for rendering wildcards in the landing page - we may want/need to add more as I review the pending guides
| @@ -0,0 +1,20 @@ | |||
| import IconPlayImg from "../assets/icon-play.png"; | |||
| import IconAoDesignImg from "../assets/icon-docs.png"; | |||
There was a problem hiding this comment.
We may want to explore other icons for the wildcards. This is our asset repo: https://docs.google.com/presentation/d/1pu7I9FjI-z-59WXDa5rES8ELkkNOrHzOJp0sWp7A95M/edit?slide=id.g28e616c6052_0_2649#slide=id.g28e616c6052_0_2649
| type: "doc", | ||
| id: "components/modeler/feel/cluster-variable/cluster-variable-overview", | ||
| }, | ||
| items: [ |
There was a problem hiding this comment.
Every page needs to be added to the sidebar file, so it gets indexed in the left-hand nav bar. Otherwise, it does not appear. We'll need to add the rest (still pending review)
| - **Simplified deployment**: Promote processes across environments without changing process definitions. | ||
| - **Dynamic updates**: Modify configuration values without redeploying processes. | ||
|
|
||
| ### When to use cluster variables |
There was a problem hiding this comment.
I like the When to and when not to, but maybe it is too long content - could you maybe reorg it using a table or any other kind of simplification? wdyt?
| - Sensitive credentials requiring encryption at rest. Use secrets management. | ||
| - Large data payloads. Use external storage with references. | ||
|
|
||
| ## Get started |
There was a problem hiding this comment.
Just FYI: I added two types of wildcards - the direct HTML and those based on cards
There was a problem hiding this comment.
I started the review. I added some metadata and infra needed for the docs to run smoothly. You also created the PR from what it seems an outdated version of the docs, so I merged main to keep it up to date. There’s still a lot pending on my side - please see my comments and update things accordingly if you can. Also, check the code snippets; Copilot is suggesting some useful tips and highlighting typos to fix. I'll continue with it next week. Thanks!
| "PAYMENT_API":{ | ||
| "endpoint":"https://api.payment.prod.example.com", | ||
| "timeout_ms":5000, | ||
| "retry_count":3 |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "PAYMENT_API":{ | |
| "endpoint":"https://api.payment.prod.example.com", | |
| "timeout_ms":5000, | |
| "retry_count":3 | |
| "PAYMENT_API": { | |
| "endpoint": "https://api.payment.prod.example.com", | |
| "timeout_ms": 5000, | |
| "retry_count": 3 |
| "PAYMENT_API":{ | ||
| "endpoint":"https://api.payment.dev.example.com", | ||
| "timeout_ms":30000, | ||
| "retry_count":1 |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "PAYMENT_API":{ | |
| "endpoint":"https://api.payment.dev.example.com", | |
| "timeout_ms":30000, | |
| "retry_count":1 | |
| "PAYMENT_API": { | |
| "endpoint": "https://api.payment.dev.example.com", | |
| "timeout_ms": 30000, | |
| "retry_count": 1 |
|
|
||
| ```json | ||
| { | ||
| "ENABLE_NEW_APPROVAL_FLOW":false |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "ENABLE_NEW_APPROVAL_FLOW":false | |
| "ENABLE_NEW_APPROVAL_FLOW": false |
|
|
||
| ```json | ||
| { | ||
| "ENABLE_NEW_APPROVAL_FLOW":true |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "ENABLE_NEW_APPROVAL_FLOW":true | |
| "ENABLE_NEW_APPROVAL_FLOW": true |
|
|
||
| ```json | ||
| { | ||
| "ENABLE_NEW_APPROVAL_FLOW":true |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "ENABLE_NEW_APPROVAL_FLOW":true | |
| "ENABLE_NEW_APPROVAL_FLOW": true |
| "INTEGRATIONS":{ | ||
| "crm":{ | ||
| "base_url":"https://crm.prod.example.com", | ||
| "api_version":"v2", | ||
| "timeout_ms":10000 |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "INTEGRATIONS":{ | |
| "crm":{ | |
| "base_url":"https://crm.prod.example.com", | |
| "api_version":"v2", | |
| "timeout_ms":10000 | |
| "INTEGRATIONS": { | |
| "crm": { | |
| "base_url": "https://crm.prod.example.com", | |
| "api_version": "v2", | |
| "timeout_ms": 10000 |
| "erp":{ | ||
| "base_url":"https://erp.prod.example.com", | ||
| "api_version":"v1", | ||
| "timeout_ms":15000 |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "erp":{ | |
| "base_url":"https://erp.prod.example.com", | |
| "api_version":"v1", | |
| "timeout_ms":15000 | |
| "erp": { | |
| "base_url": "https://erp.prod.example.com", | |
| "api_version": "v1", | |
| "timeout_ms": 15000 |
| "notification":{ | ||
| "base_url":"https://notify.prod.example.com", | ||
| "api_version":"v1", | ||
| "timeout_ms":5000 |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "notification":{ | |
| "base_url":"https://notify.prod.example.com", | |
| "api_version":"v1", | |
| "timeout_ms":5000 | |
| "notification": { | |
| "base_url": "https://notify.prod.example.com", | |
| "api_version": "v1", | |
| "timeout_ms": 5000 |
| "INTEGRATIONS":{ | ||
| "crm":{ | ||
| "base_url":"https://crm.sandbox.example.com", | ||
| "api_version":"v2", | ||
| "timeout_ms":30000 |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| "INTEGRATIONS":{ | |
| "crm":{ | |
| "base_url":"https://crm.sandbox.example.com", | |
| "api_version":"v2", | |
| "timeout_ms":30000 | |
| "INTEGRATIONS": { | |
| "crm": { | |
| "base_url": "https://crm.sandbox.example.com", | |
| "api_version": "v2", | |
| "timeout_ms": 30000 |
| ``` | ||
|
|
||
| **Benefit**: Centralize integration configuration and easily switch between environments. No newline at end of file |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| **Benefit**: Centralize integration configuration and easily switch between environments. | |
| **Benefit**: Centralize integration configuration and easily switch between environments. |
|
The preview environment relating to the commit 7fc6c83 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-7462/ |
This pull request introduces comprehensive documentation for Cluster Variables in Camunda Modeler FEEL expressions. The new docs explain the concept, benefits, scope resolution, usage patterns, collision prevention, and provide practical examples for real-world scenarios. These changes are designed to help both new and experienced users understand how to leverage cluster variables for centralized, multi-tenant, and environment-specific configuration in BPMN processes.
Cluster Variable Concepts and Usage
camunda.vars.cluster,camunda.vars.tenant,camunda.vars.env), supported variable types, and resolution priority.Scope Resolution and Collision Handling
Practical Examples and Use Cases
Cluster Variable Overview