@bpmnkit/camunda-docspack 0.0.0

package/.llms/chunks/components.modeler.feel.builtin-functions.feel-built-in-functions-string.substring-before-string-match.md

@@ -0,0 +1,55 @@
+# String functions — substring before(string, match)
+
+Returns a substring of the given value that contains all characters before `match`.
+
+**Function signature**
+
+```feel
+substring before(string: string, match: string): string
+```
+
+**Examples**
+
+```feel
+substring before("foobar", "bar")
+// "foo"
+```
+
+
+## substring after(string, match)
+
+Returns a substring of the given value that contains all characters after `match`.
+
+**Function signature**
+
+```feel
+substring after(string: string, match: string): string
+```
+
+**Examples**
+
+```feel
+substring after("foobar", "ob")
+// "ar"
+```
+
+
+## contains(string, match)
+
+Returns `true` if the given value contains the substring `match`. Otherwise, returns `false`.
+
+**Function signature**
+
+```feel
+contains(string: string, match: string): boolean
+```
+
+**Examples**
+
+```feel
+contains("foobar", "of")
+// false
+```
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/builtin-functions/feel-built-in-functions-string

package/.llms/chunks/components.modeler.feel.builtin-functions.feel-built-in-functions-string.trim-string.md

@@ -0,0 +1,64 @@
+# String functions — trim(string)
+
+(Camunda extension)(Camunda extension)
+
+Returns the given string without leading and trailing spaces.
+
+**Function signature**
+
+```feel
+trim(string: string): string
+```
+
+**Examples**
+
+```feel
+trim("  hello world  ")
+// "hello world"
+
+trim("hello   world ")
+// "hello   world"
+```
+
+
+## uuid()
+
+(Camunda extension)(Camunda extension)
+
+Returns a UUID (Universally Unique Identifier) with 36 characters.
+
+**Function signature**
+
+```feel
+uuid(): string
+```
+
+**Examples**
+
+```feel
+uuid()
+// "7793aab1-d761-4d38-916b-b7270e309894"
+```
+
+
+## to base64(value)
+
+(Camunda extension)(Camunda extension)
+
+Returns the given string encoded in Base64 format.
+
+**Function signature**
+
+```feel
+to base64(value: string): string
+```
+
+**Examples**
+
+```feel
+to base64("FEEL")
+// "RkVFTA=="
+```
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/builtin-functions/feel-built-in-functions-string

package/.llms/chunks/components.modeler.feel.builtin-functions.feel-built-in-functions-temporal.day-of-year-date.md

@@ -0,0 +1,51 @@
+# Temporal functions — day of year(date)
+
+Returns the Gregorian number of the day within the year.
+
+**Function signature**
+
+```feel
+day of year(date: date): number
+```
+
+```feel
+day of year(date: date and time): number
+```
+
+**Examples**
+
+```feel
+day of year(date("2019-09-17"))
+// 260
+
+day of year(date and time("2019-09-17T12:00:00"))
+// 260
+```
+
+
+## week of year(date)
+
+Returns the Gregorian number of the week within the year, according to ISO 8601.
+
+**Function signature**
+
+```feel
+week of year(date: date): number
+```
+
+```feel
+week of year(date: date and time): number
+```
+
+**Examples**
+
+```feel
+week of year(date("2019-09-17"))
+// 38
+
+week of year(date and time("2019-09-17T12:00:00"))
+// 38
+```
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/builtin-functions/feel-built-in-functions-temporal

package/.llms/chunks/components.modeler.feel.builtin-functions.feel-built-in-functions-temporal.last-day-of-month-date.md

@@ -0,0 +1,28 @@
+# Temporal functions — last day of month(date)
+
+(Camunda extension)(Camunda extension)
+
+Takes the month of the given date or date-time value and returns the last day of this month.
+
+**Function signature**
+
+```feel
+last day of month(date: date): date
+```
+
+```feel
+last day of month(date: date and time): date
+```
+
+**Examples**
+
+```feel
+last day of month(date("2022-10-01"))
+// date("2022-10-31"))
+
+last day of month(date and time("2022-10-16T12:00:00"))
+// date("2022-10-31"))
+```
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/builtin-functions/feel-built-in-functions-temporal

package/.llms/chunks/components.modeler.feel.builtin-functions.feel-built-in-functions-temporal.md

@@ -0,0 +1,67 @@
+# Temporal functions
+
+This document outlines built-in temporal functions and examples.
+
+
+## now()
+
+Returns the current date and time including the timezone.
+
+**Function signature**
+
+```feel
+now(): date and time
+```
+
+**Examples**
+
+```feel
+now()
+// date and time("2020-07-31T14:27:30@Europe/Berlin")
+```
+
+
+## today()
+
+Returns the current date.
+
+**Function signature**
+
+```feel
+today(): date
+```
+
+**Examples**
+
+```feel
+today()
+// date("2020-07-31")
+```
+
+
+## day of week(date)
+
+Returns the day of the week according to the Gregorian calendar. Note that it always returns the English name of the day.
+
+**Function signature**
+
+```feel
+day of week(date: date): string
+```
+
+```feel
+day of week(date: date and time): string
+```
+
+**Examples**
+
+```feel
+day of week(date("2019-09-17"))
+// "Tuesday"
+
+day of week(date and time("2019-09-17T12:00:00"))
+// "Tuesday"
+```
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/builtin-functions/feel-built-in-functions-temporal

package/.llms/chunks/components.modeler.feel.builtin-functions.feel-built-in-functions-temporal.month-of-year-date.md

@@ -0,0 +1,54 @@
+# Temporal functions — month of year(date)
+
+Returns the month of the year according to the Gregorian calendar. Note that it always returns the English name of the month.
+
+**Function signature**
+
+```feel
+month of year(date: date): string
+```
+
+```feel
+month of year(date: date and time): string
+```
+
+**Examples**
+
+```feel
+month of year(date("2019-09-17"))
+// "September"
+
+month of year(date and time("2019-09-17T12:00:00"))
+// "September"
+```
+
+
+## abs(n)
+
+Returns the absolute value of a given duration.
+
+**Function signature**
+
+```feel
+abs(n: days and time duration): days and time duration
+```
+
+```feel
+abs(n: years and months duration): years and months duration
+```
+
+**Examples**
+
+```feel
+abs(duration("-PT5H"))
+// "duration("PT5H")"
+
+abs(duration("PT5H"))
+// "duration("PT5H")"
+
+abs(duration("-P2M"))
+// duration("P2M")
+```
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/builtin-functions/feel-built-in-functions-temporal

package/.llms/chunks/components.modeler.feel.cluster-variable.data-types.create-a-variable-of-kind-secret_reference.md

@@ -0,0 +1,22 @@
+# Supported data types — Create a variable of kind `SECRET_REFERENCE`
+
+Set `kind` when you create the variable. If you omit `kind`, the variable is created as `JSON`.
+
+```bash
+POST /v2/cluster-variables/global
+Content-Type: application/json
+
+{
+  "name": "PAYMENT_API_CONFIG",
+  "kind": "SECRET_REFERENCE",
+  "value": {
+    "endpoint": "https://api.payment.prod.example.com",
+    "apiKey": "camunda.secrets.PAYMENT_API_KEY"
+  }
+}
+```
+
+A variable's kind is fixed at creation. Update requests carry no `kind` field, so updating a `SECRET_REFERENCE`-kind variable keeps its kind and scans the new value for references. To change a variable's kind, delete it and create it again with the kind you want.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/data-types

package/.llms/chunks/components.modeler.feel.cluster-variable.data-types.md

@@ -0,0 +1,38 @@
+# Supported data types
+
+Understand data types supported by cluster variables.
+
+Understand the data types supported by cluster variables for different configuration needs.
+
+
+## Simple values
+
+- **String**: Text values for URLs, names, identifiers.
+- **Number**: Numeric values for thresholds, timeouts, counts.
+- **Boolean**: True/false values for feature flags and toggles.
+
+
+## Complex values
+
+- **Objects**: Nested structures for grouped configuration.
+- **Arrays**: Lists of values.
+
+**Note**
+Access patterns may vary depending on how the array is used.
+
+
+## Variable kinds
+
+Every cluster variable has a kind, which determines how Camunda reads its value.
+
+| Kind               | Description                                                                                                                                                                         |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `JSON`             | The default. Your value is data, and Camunda reads it exactly as you stored it.                                                                                                     |
+| `SECRET_REFERENCE` | The value can contain an [Orchestration Cluster secret reference](https://docs.camunda.io/docs/next/reference/glossary#secret-reference-orchestration-cluster), `camunda.secrets.<name>`, which Camunda resolves. |
+
+Resolving `SECRET_REFERENCE` references is part of an [alpha feature](https://docs.camunda.io/docs/next/components/early-access/alpha/alpha-features) and may be subject to change in future releases.
+
+Only a `SECRET_REFERENCE`-kind variable has its references resolved. A `JSON`-kind variable whose value contains the same text is treated as ordinary text, and that text reaches your process unchanged.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/data-types

package/.llms/chunks/components.modeler.feel.cluster-variable.data-types.read-a-variable-of-kind-secret_reference.md

@@ -0,0 +1,8 @@
+# Supported data types — Read a variable of kind `SECRET_REFERENCE`
+
+Get and search responses return the stored value, so you see the reference text rather than a resolved value. References are resolved only when a process reads the variable in an input mapping, as described in [resolve secret references in a cluster variable](https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/usage-guide#resolve-secret-references-in-a-cluster-variable). For where resolved values appear and where they do not, see [secret resolution and job activation](https://docs.camunda.io/docs/next/components/concepts/secret-resolution-and-job-activation).
+
+To find variables of a given kind, use the `kind` filter in [search cluster variables](https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-cluster-variables.api).
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/data-types

package/.llms/chunks/components.modeler.feel.cluster-variable.data-types.required-permissions.md

@@ -0,0 +1,15 @@
+# Supported data types — Required permissions
+
+A `SECRET_REFERENCE`-kind variable needs the same permissions as any other cluster variable. There is no additional permission for this kind.
+
+| Action            | Required permission                              |
+| ----------------- | ------------------------------------------------ |
+| Create a variable | `CREATE` on the `CLUSTER_VARIABLE` resource type |
+| Get or search     | `READ` on the `CLUSTER_VARIABLE` resource type   |
+| Update a variable | `UPDATE` on the `CLUSTER_VARIABLE` resource type |
+| Delete a variable | `DELETE` on the `CLUSTER_VARIABLE` resource type |
+
+The resource identifier is the variable name, or `*` for all cluster variables. See [authorizations](https://docs.camunda.io/docs/next/components/concepts/access-control/authorizations#available-resources) for how to grant these permissions.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/data-types

package/.llms/chunks/components.modeler.feel.cluster-variable.data-types.where-references-can-appear-in-a-value.md

@@ -0,0 +1,20 @@
+# Supported data types — Where references can appear in a value
+
+Camunda scans every string in a `SECRET_REFERENCE`-kind variable's value, including strings nested inside objects and arrays. Object keys are not scanned. A reference has the form `camunda.secrets.<name>`, where `<name>` can contain ASCII letters, digits, underscores, and dashes, up to 240 characters. A name that fails either limit is never resolved; see [secrets](https://docs.camunda.io/docs/next/self-managed/components/orchestration-cluster/core-settings/configuration/properties#secrets). This character set applies to references embedded in a cluster-variable value; a reference [written directly in an input mapping source](https://docs.camunda.io/docs/next/components/concepts/variables#escape-secret-names-with-special-characters) can use other characters through backtick escaping.
+
+For example, the following value carries two references, one at the top level and one nested:
+
+```json
+{
+  "apiKey": "camunda.secrets.PAYMENT_API_KEY",
+  "database": {
+    "user": "reporting",
+    "password": "camunda.secrets.REPORTING_DB_PASSWORD"
+  }
+}
+```
+
+Do not place a reference inside an array. Camunda detects such a reference when you create the variable, but it cannot be resolved when a process reads the variable: the job is not activated and raises an incident instead. See [when a job is not activated](https://docs.camunda.io/docs/next/components/concepts/secret-resolution-and-job-activation#understand-why-a-job-is-not-activated).
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/data-types

package/.llms/chunks/components.modeler.feel.cluster-variable.examples.feature-flags.md

@@ -0,0 +1,43 @@
+# Common use cases — Feature flags
+
+You want to gradually roll out a new approval workflow to specific tenants.
+
+**Setup:**
+
+Global scope, e.g., production:
+
+```json
+{
+  "ENABLE_NEW_APPROVAL_FLOW": false
+}
+```
+
+Tenant scope, e.g., `tenant-a`:
+
+```json
+{
+  "ENABLE_NEW_APPROVAL_FLOW": true
+}
+```
+
+Tenant scope, e.g., `beta-customer`:
+
+```json
+{
+  "ENABLE_NEW_APPROVAL_FLOW": true
+}
+```
+
+**Usage in BPMN:**
+
+For example, in an exclusive gateway condition:
+
+```
+Condition for new flow: camunda.vars.env.ENABLE_NEW_APPROVAL_FLOW = true
+Condition for old flow: camunda.vars.env.ENABLE_NEW_APPROVAL_FLOW = false
+```
+
+**Benefit:** Control feature rollout per tenant without deploying different process versions.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/examples

package/.llms/chunks/components.modeler.feel.cluster-variable.examples.integration-credentials-and-endpoints.md

@@ -0,0 +1,57 @@
+# Common use cases — Integration credentials and endpoints
+
+Your processes integrate with multiple external services that have different configurations per environment.
+
+**Setup:**
+
+Global scope, e.g., production:
+
+```json
+{
+  "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
+    },
+    "notification": {
+      "base_url": "https://notify.prod.example.com",
+      "api_version": "v1",
+      "timeout_ms": 5000
+    }
+  }
+}
+```
+
+Tenant scope, e.g., `sandbox`:
+
+```json
+{
+  "INTEGRATIONS": {
+    "crm": {
+      "base_url": "https://crm.sandbox.example.com",
+      "api_version": "v2",
+      "timeout_ms": 30000
+    }
+  }
+}
+```
+
+**Usage in BPMN:**
+
+For example, a service task for CRM integration:
+
+```
+URL: = camunda.vars.env.INTEGRATIONS.crm.base_url + "/" +
+camunda.vars.env.INTEGRATIONS.crm.api_version + "/customers"
+```
+
+**Benefit:** Centralize integration configuration and easily switch between environments.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/examples

package/.llms/chunks/components.modeler.feel.cluster-variable.examples.md

@@ -0,0 +1,50 @@
+# Common use cases
+
+Explore practical ways to use cluster variables with real-world examples.
+
+Explore practical ways to use cluster variables with real-world examples, including environment-specific configurations, SLA rules, and integration endpoints.
+
+
+## Environment-specific configuration
+
+You need different API endpoints and timeouts across development, staging, and production environments.
+
+**Setup:**
+
+Global scope, e.g., production:
+
+```json
+{
+  "PAYMENT_API": {
+    "endpoint": "https://api.payment.prod.example.com",
+    "timeout_ms": 5000,
+    "retry_count": 3
+  }
+}
+```
+
+Tenant scope, e.g., dev environment:
+
+```json
+{
+  "PAYMENT_API": {
+    "endpoint": "https://api.payment.dev.example.com",
+    "timeout_ms": 30000,
+    "retry_count": 1
+  }
+}
+```
+
+**Usage in BPMN:**
+
+For example, in a service task making a payment API call:
+
+```
+URL: = camunda.vars.env.PAYMENT_API.endpoint
+Timeout: = camunda.vars.env.PAYMENT_API.timeout_ms
+```
+
+**Benefit:** The same BPMN file works across all environments without modification.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/examples

package/.llms/chunks/components.modeler.feel.cluster-variable.examples.multi-tenant-sla-configuration.md

@@ -0,0 +1,63 @@
+# Common use cases — Multi-tenant SLA configuration
+
+Different tenants have different Service Level Agreements (SLAs) with varying approval thresholds and escalation timeouts.
+
+**Setup:**
+
+Tenant scope, e.g., `tenant-a`:
+
+```json
+{
+  "SLA_CONFIG": {
+    "approval_threshold": 1000,
+    "escalation_hours": 24,
+    "auto_approve_limit": 100
+  },
+  "auto_approve_limit": 100
+}
+```
+
+Tenant scope, e.g., `tenant-b`:
+
+```json
+{
+  "SLA_CONFIG": {
+    "approval_threshold": 50000,
+    "escalation_hours": 4,
+    "auto_approve_limit": 5000
+  },
+  "auto_approve_limit": 5000
+}
+```
+
+Tenant scope, e.g., `tenant-c`:
+
+```json
+{
+  "SLA_CONFIG": {
+    "approval_threshold": 5000,
+    "escalation_hours": 48,
+    "auto_approve_limit": 500
+  },
+  "auto_approve_limit": 500
+}
+```
+
+**Usage in BPMN:**
+
+For example, in a gateway condition for auto-approval:
+
+```
+amount <= camunda.vars.env.SLA_CONFIG.auto_approve_limit
+```
+
+Timer boundary event for escalation:
+
+```
+Duration: = duration("PT" + string(camunda.vars.env.SLA_CONFIG.escalation_hours) + "H")
+```
+
+**Benefit:** Customize business rules per tenant while maintaining a single process definition.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/examples

package/.llms/chunks/components.modeler.feel.cluster-variable.get-started.md

@@ -0,0 +1,33 @@
+# Get started with cluster variables
+
+Get started with cluster variables by creating your first one and using it in a BPMN process.
+
+Get started with cluster variables by creating your first one and using it in a BPMN process.
+
+Throughout this tutorial, you'll build a payment processing workflow that calls different payment API endpoints depending on the environment.
+
+
+## Step 1: Create a global cluster variable
+
+First, create a global cluster variable that serves as your production API configuration. This variable is available to all processes across your cluster.
+
+Use the Orchestration Cluster API to [create](https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/create-global-cluster-variable.api) a global variable:
+
+```bash
+POST /v2/cluster-variables/global
+Content-Type: application/json
+
+{
+  "name": "PAYMENT_API_CONFIG",
+  "value": {
+    "endpoint": "https://api.payment.prod.example.com",
+    "timeout_ms": 5000,
+    "retry_count": 3
+  }
+}
+```
+
+The API returns a confirmation response with your variable details.
+
+---
+Source: https://docs.camunda.io/docs/next/components/modeler/feel/cluster-variable/get-started