Skip to content

Commit

Permalink
Merge branch 'main' into idp-feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
mesellings authored Mar 10, 2025
2 parents 0a26816 + d4ff4e2 commit 614e3e3
Show file tree
Hide file tree
Showing 60 changed files with 533 additions and 62 deletions.
18 changes: 14 additions & 4 deletions docs/apis-tools/spring-zeebe-sdk/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -534,14 +534,24 @@ camunda:

##### Control tenant usage

When using multi-tenancy, the Camunda client will connect to the `<default>` tenant. To control this, you can configure:
When using multi-tenancy, the Zeebe client will connect to the `<default>` tenant. To control this, you can configure:

```yaml
camunda:
client:
tenant-ids:
- <default>
- foo
tenant-id: foo
```

To control which tenants your job workers should use, you can configure:

```yaml
camunda:
client:
worker:
defaults:
tenant-ids:
- <default>
- foo
```

Additionally, you can set tenant ids on job worker level by using the annotation:
Expand Down
3 changes: 1 addition & 2 deletions docs/apis-tools/spring-zeebe-sdk/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,7 @@ If you have different endpoints for your applications or want to disable a clien
camunda:
client:
mode: self-managed
tenant-ids:
- <default>
tenant-id: <default>
auth:
client-id: <your client id>
client-secret: <your client secret>
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Interact with Zeebe clusters. Run user task state operations for Z

## Introduction

The Zeebe REST API is a REST API designed to interact with the Zeebe process automation engine.
The Zeebe REST API is a REST API designed to interact with the Zeebe workflow engine.

:::note
Ensure you [authenticate](./zeebe-api-rest-authentication.md) before accessing the Zeebe REST API.
Expand Down
4 changes: 2 additions & 2 deletions docs/components/modeler/bpmn/manual-tasks/manual-tasks.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: manual-tasks
title: "Manual tasks"
description: "A manual task defines a task that is external to the BPM engine."
description: "A manual task defines a task that is external to the workflow engine."
---

A manual task defines a task that requires human interaction but no external tooling or UI interface. For example, a user reviewing a document or completing a physical task.

![task](assets/manual-task.png)

Manual tasks are part of [human task orchestration](/guides/getting-started-orchestrate-human-tasks.md), but differ from [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md) which define an actionable task assisted by a business process execution engine or software application.
Manual tasks are part of [human task orchestration](/guides/getting-started-orchestrate-human-tasks.md), but differ from [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md) which define an actionable task assisted by a workflow engine or software application.

Within the engine and BPMN model, a manual task is handled as a pass-through activity, automatically continuing the process at the moment the process instance arrives.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: undefined-tasks
title: "Undefined tasks"
description: "An undefined task defines a task that is external to the BPM engine."
description: "An undefined task defines a task that is external to the workflow engine."
---

import myImageUrl from "./assets/undefined-task.png";
Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/bpmn/user-tasks/user-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "User tasks"
description: "A user task is used to model work that needs to be done by a human actor."
---

A user task is used to model work that needs to be done by a human and is assisted by a business process execution engine or software application. This differs from [manual tasks](/components/modeler/bpmn/manual-tasks/manual-tasks.md), which are not assisted by external tooling.
A user task is used to model work that needs to be done by a human and is assisted by a workflow engine or software application. This differs from [manual tasks](/components/modeler/bpmn/manual-tasks/manual-tasks.md), which are not assisted by external tooling.

When the process instance arrives at a user task, a new user task instance is created at Zeebe.
The process instance stops at this point and waits until the user task instance is completed.
Expand Down
4 changes: 2 additions & 2 deletions docs/components/zeebe/zeebe-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: zeebe-overview
title: "Zeebe"
sidebar_label: "Introduction"
description: "Zeebe is the process automation engine powering Camunda 8. While written in Java, you do not need to be a Java developer to use Zeebe."
description: "Zeebe is the workflow engine powering Camunda 8. While written in Java, you do not need to be a Java developer to use Zeebe."
---

Zeebe is the process automation engine powering Camunda 8. While written in Java, you do not need to be a Java developer to use Zeebe.
Zeebe is the workflow engine powering Camunda 8. While written in Java, you do not need to be a Java developer to use Zeebe.

With Zeebe you can:

Expand Down
5 changes: 5 additions & 0 deletions docs/reference/announcements/870.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Important changes and updates for the Camunda 8.7 release are summarized below.
- [Breaking changes in Camunda Process Test](#breaking-changes-in-camunda-process-test)
- [API updates](#api-updates-saasself-managed)
- [Identity Keycloak now requires v25 or v26](#identity-keycloak-now-requires-v25-or-v26-self-managed)
- [Camunda Spring SDK now requires Spring Boot 3.4.x](#camunda-spring-sdk-now-requires-spring-boot-34x-saas-self-managed)

## Amazon Web Services (AWS) region support <span class="badge badge--long" title="This feature affects SaaS">SaaS</span>

Expand Down Expand Up @@ -95,6 +96,10 @@ See the [overview about API Key Attributes][camunda8-api-overview] for more deta

Identity 8.7 now requires Keycloak v25 or v26, and Keycloak versions must be updated to match. This update also includes changes to the Camunda Helm chart. For more information on configuration changes, see the Self-Managed [update guide](/self-managed/operational-guides/update-guide/860-to-870.md#identity).

## Camunda Spring SDK now requires Spring Boot 3.4.x <span class="badge badge--long" title="This feature affects SaaS">SaaS</span><span class="badge badge--long" title="This feature affects Self-Managed">Self-Managed</span>

Camunda Spring SDK 8.7 now requires Spring Boot 3.4.x. For more information on compatibility, see the Camunda Spring SDK [version compatibility matrix](/apis-tools/spring-zeebe-sdk/getting-started.md#version-compatibility).

## Zeebe Java client

Starting with 8.8, the Zeebe Java client will become the new Camunda Java client. This transition brings a new Java client structure designed to enhance the user experience and introduce new features while maintaining compatibility with existing codebases.
Expand Down
119 changes: 119 additions & 0 deletions docs/reference/data-collection/data-collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
id: data-collection
title: "Data collection"
description: "Learn which telemetry data is collected, how Camunda ensures privacy, and what options you have to modify which telemetry data is sent to Camunda."
---

import AnalyticsImg from './../img/analytics.png';
import CookiePrefsImg from './../img/cookie-preferences.png';

Camunda collects a variety of telemetry data to evaluate contractual usage, provide a better user experience, and improve its products. This section describes which telemetry data is collected, how Camunda ensures privacy, and what options you have to modify which telemetry data is sent to Camunda. This document is designed to help you understand what telemetry data includes and excludes, applies only to interactions with Camunda's products, and will be updated periodically.

## Purposes

Camunda collects certain types of data we call “telemetry data” for the purposes described below:

- Billing
- Improving the user experience by tracking and analyzing usage of the software
- Ensuring the security, stability, and functionality of the foftware
- Providing support and guidance to customers to help optimize product usage and new functionalities.

## Principles

Camunda follows certain principles in its collection and use of telemetry data to ensure the privacy of its customers and the success of its product development efforts:

- Camunda will use telemetry data subject to applicable law (including opt-in and opt-out functionalities for personal data where necessary).
Telemetry data is generally aggregated unless users opt-in for personalized use of their telemetry data (for example, to provide additional support or optimize product usage to customers).
- Telemetry data does not include any data shared in process instances or uploaded in customer clusters. Therefore, **no end-user or end-customer personal data**, personal information (PII), or protected health information (PHI) uploaded to a customer cluster is part of telemetry data.
- Telemetry data does **not include payment information**.
- Camunda does **not sell any personal (user) information.**
- **For Self-Managed customers, telemetry data is always fully anonymous and only sent upon admin/owner enablement from the customer.**
- Data collected from end-users such as form fills or process variables are not part of telemetry data. For example, if part of your process involves a user filling in a shipping address, that address is not telemetry data.
- Assets like the BPMN diagram describing how a process is defined and executed are not telemetry data. Telemetry data does not include information about how customers develop their processes, like keystrokes or BPMN diagrams. Instead, it includes user-provided identifiers like a process ID to track which Camunda software features are used when developing a process.
- Customers are responsible for avoiding sharing intellectual property, personal data or sensitive data through interaction with AI features. The data collected by different AI features is shared [below](#usage-telemetry-data-saas-and-desktop-modeler-only).
- Camunda will not use telemetry data in any way that identifies the source of the telemetry data to third parties except as necessary for Camunda to enforce its rights and contractual obligations, such as charging fees for overage of usage metrics or complying with a lawful subpoena.

## Telemetry data collection

Telemetry data includes contractual metrics, environment, and usage data. Telemetry data is collected automatically in SaaS (except for personalized telemetry data which is only used via user discretionary opt-in) and collected via admin discretionary opt-in for Self-Managed platforms. Each category of telemetry data is described below.

### Contractual metrics telemetry data

Contractual metrics telemetry data includes a limited set of contractually agreed [usage metrics](/reference/data-collection/usage-metrics.md) to evaluate usage metric use and bill for overages. One example is how many process instance usage metrics are used compared to the number of process instance usage metrics purchased by customers. These are summary usage metrics that contain no sensitive information and that are collected automatically for SaaS customers and sent in a report generated by Self-Managed customers.

### Environment telemetry data (Self-Managed only)

Environment telemetry data includes information about your Self-Managed installations to enable better support and product improvement decisions. Self-Managed customers may choose to send a very limited set of environment information through the Console component's telemetry mechanism. View the [telemetry](/self-managed/console-deployment/telemetry.md) page for a description of this data. Environment telemetry data is not relevant to SaaS installations.

### Usage telemetry data (SaaS and Desktop Modeler only)

Usage telemetry data includes limited product usage data to help make better product improvement decisions and enable outreach to support users. This section describes the types of data and how they are collected.

- Feature Usage:

- SaaS System Actions: All SaaS organizations submit basic information about which features are being used as part of telemetry data collection. When certain features are used, Camunda logs which feature is used and basic information about how it has been used. This information is tied to a pseudonymized organization.
- SaaS User Actions: Users that opt-in to personalization cookies gain access to in-app tutorials, whereas analytics cookies cause data to be automatically submitted about which features they interact with in Camunda’s UI as part of telemetry data. In addition to the data collected from system actions described above, Camunda collects cursor activity, geographical area, browser information, and basic biographical information limited to email, name, and city/region/country for user actions. If a user interacts through API, then personal information is not collected.

<img src={CookiePrefsImg} alt="Cookie preferences in user settings" width="300px" style={{border: 'none', padding: '0', marginTop: '0', backgroundColor: 'transparent'}}/>
<img src={AnalyticsImg} alt="Analytics opt-in menu" width="500px" style={{border: 'none', padding: '0', marginTop: '0', backgroundColor: 'transparent'}}/>

- Desktop Modeler User Actions: Users opting into collection of telemetry data in [Desktop Modeler](/components/modeler/desktop-modeler/telemetry/telemetry.md) send data to Camunda to track how certain features are used, as described in the linked document.

- AI Usage: Camunda's AI features, currently available in SaaS only, are clearly labeled as AI features. For Enterprise organizations, these features must be enabled by the customer via opt-in in the [Console](/components/console/manage-organization/enable-alpha-features.md#enable-ai-powered-features). Depending on the feature, they may collect different information.
- Camunda [Docs AI](/components/modeler/web-modeler/advanced-modeling/camunda-docs-ai.md) records the entire conversation to provide ongoing support.
- Camunda [Copilots](/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md) only gather usage telemetry data. Camunda automatically logs all information sent to and from our AI models for system monitoring by a limited set of operators. Camunda will only use the data from free users for product and model improvement.

### Example

Below is an example of user action data collected by the platform:

```json
{
"event": "modeler:deploy:confirm",
"properties": {
"time": 1721228056.002,
"distinct_id": "auth0|669533a8339ceebe5e8f7fed",
"$browser": "Microsoft Edge",
"$browser_version": 126,
"$city": "Gotham City",
"$current_url": "https://modeler.camunda.io/diagrams/a8c077ae-22d6-4be3-bebb-a847f40376fe--batsymbol-activate?v=736,217,1",
"$device_id": "190b6d254651ec-0a7e1ef548a163-4c657b58-e1000-190b6d2518f1ec",
"$initial_referrer": "https://console.camunda.io/",
"$initial_referring_domain": "console.camunda.io",
"$insert_id": "xjsmufevamu6v5y7",
"$lib_version": "2.53.0",
"$mp_api_endpoint": "api-js.mixpanel.com",
"$mp_api_timestamp_ms": 1721228056805,
"$os": "Windows",
"$referrer": "https://dsm-1.operate.camunda.io/",
"$referring_domain": "dsm-1.operate.camunda.io",
"$region": "New Jersey",
"$screen_height": 1080,
"$screen_width": 1920,
"$user_id": "auth0|669533a8339ceebe5e8f7fed",
"clusterId": "ea9ddef9-f1e3-4241-a37c-655334c45de8",
"clusterTag": "dev",
"clusterVersion": "8.5",
"connectors": ["io.camunda.connectors.HttpJson.v2"],
"containsUserTasks": true,
"deployType": "single-file",
"deployedForms": {
"Form_0ec4ghh": "764a75e7-85a8-448f-8a1f-4952cc8a189d"
},
"fileId": "a8c077ae-22d6-4be3-bebb-af97040123fe",
"fileType": "bpmn",
"license": "Free",
"mp_country_code": "US",
"mp_lib": "web",
"mp_processing_time_ms": 1721228056937,
"mp_sent_by_lib_version": "2.53.0",
"orgId": "30ba73a-4b2f-433f-80e5-d41176874bb5",
"org_id": "30ba73a-4b2f-433f-80e5-d41176874bb5",
"organizationId": "30ba73a-4b2f-433f-80e5-d41176874bb5",
"stage": "prod",
"success": true,
"userId": "auth0|669533a8339ceebe5e8f7fed",
"version": "8.5.4"
}
}
```
File renamed without changes.
8 changes: 6 additions & 2 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ The log is comprised of an ordered sequence of records written to persistent sto

A manual task defines a task that requires human interaction but no external tooling or UI interface. For example, a user reviewing a document or completing a physical task.

Manual tasks are part of [human task orchestration](/guides/getting-started-orchestrate-human-tasks.md), but differ from [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md) which define an actionable task assisted by a business process execution engine or software application.
Manual tasks are part of [human task orchestration](/guides/getting-started-orchestrate-human-tasks.md), but differ from [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md) which define an actionable task assisted by a workflow engine or software application.

- [Manual tasks](/components/modeler/bpmn/manual-tasks/manual-tasks.md)

Expand Down Expand Up @@ -272,7 +272,7 @@ This way, a Camunda workflow can receive messages from an external system or ser

### User task

A user task is used to model work that needs to be done by a human and is assisted by a business process execution engine or software application. This differs from [manual tasks](/components/modeler/bpmn/manual-tasks/manual-tasks.md), which are not assisted by external tooling.
A user task is used to model work that needs to be done by a human and is assisted by a workflow engine or software application. This differs from [manual tasks](/components/modeler/bpmn/manual-tasks/manual-tasks.md), which are not assisted by external tooling.

With 8.7, Camunda offers job worker-based user tasks managed by Camunda, also known as Camunda user tasks (and formerly known as Zeebe user tasks). Note that you may still see references of **Zeebe user tasks** in your XML, but this is the same thing as Camunda user tasks.

Expand Down Expand Up @@ -303,6 +303,10 @@ A worker executes a job. In the Zeebe nomenclature, these are also referred to a

See [process](#process).

### Workflow engine

A workflow engine is an essential part of any process automation tool. We call it an “engine” because it drives business processes from start to finish, no matter how complex the process and decision logic need to be. [Zeebe](/components/zeebe/zeebe-overview.md) is the workflow engine powering Camunda 8.

### Workflow instance

See [process instance](#process-instance).
Expand Down
Binary file added docs/reference/img/analytics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/reference/img/cookie-preferences.png
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/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ Learn about the [Camunda release policy](release-policy.md) with some specific c
## Additional resources

- [Regions](regions.md) - When you create a cluster in Camunda 8 SaaS, specify a region for that cluster.
- [Usage metrics](usage-metrics.md) - Understand the three main usage metrics that have an impact on Camunda 8 pricing.
- [Usage metrics](/reference/data-collection/usage-metrics.md) - Understand the three main usage metrics that have an impact on Camunda 8 pricing.
- [Glossary](glossary.md) - Have a closer look at common terminology used across Camunda 8 documentation.
2 changes: 1 addition & 1 deletion docs/reference/supported-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ For example, 1.2+ means support for the minor version 2, and any higher minors (
- **Zeebe Java Client**: OpenJDK 8+
- **Spring Zeebe SDK**: OpenJDK 17+
- **Connector SDK**: OpenJDK 17+
- **Spring SDK**: Spring Boot 3.3.x (for the exact version, check the [version matrix](/apis-tools/spring-zeebe-sdk/getting-started.md#version-compatibility).)
- **Spring SDK**: Spring Boot 3.4.x (for the exact version, check the [version matrix](/apis-tools/spring-zeebe-sdk/getting-started.md#version-compatibility).)
- **Helm CLI**: 3.14.x (for the exact version, check the [version matrix](https://helm.camunda.io/camunda-platform/version-matrix/).)

## Camunda 8 Self-Managed
Expand Down
Loading

0 comments on commit 614e3e3

Please sign in to comment.