diff --git a/docs/apis-tools/spring-zeebe-sdk/configuration.md b/docs/apis-tools/spring-zeebe-sdk/configuration.md index 3d662650da5..9ad8c808d33 100644 --- a/docs/apis-tools/spring-zeebe-sdk/configuration.md +++ b/docs/apis-tools/spring-zeebe-sdk/configuration.md @@ -534,14 +534,24 @@ camunda: ##### Control tenant usage -When using multi-tenancy, the Camunda client will connect to the `` tenant. To control this, you can configure: +When using multi-tenancy, the Zeebe client will connect to the `` tenant. To control this, you can configure: ```yaml camunda: client: - tenant-ids: - - - - foo + tenant-id: foo +``` + +To control which tenants your job workers should use, you can configure: + +```yaml +camunda: + client: + worker: + defaults: + tenant-ids: + - + - foo ``` Additionally, you can set tenant ids on job worker level by using the annotation: diff --git a/docs/apis-tools/spring-zeebe-sdk/getting-started.md b/docs/apis-tools/spring-zeebe-sdk/getting-started.md index 1e2282f06c0..87ecbc92e7d 100644 --- a/docs/apis-tools/spring-zeebe-sdk/getting-started.md +++ b/docs/apis-tools/spring-zeebe-sdk/getting-started.md @@ -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: - - + tenant-id: auth: client-id: client-secret: diff --git a/docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md b/docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md index a6c919bc957..b9869b6e7e3 100644 --- a/docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md +++ b/docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md @@ -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. diff --git a/docs/components/modeler/bpmn/manual-tasks/manual-tasks.md b/docs/components/modeler/bpmn/manual-tasks/manual-tasks.md index d444261ac2f..600fa980f34 100644 --- a/docs/components/modeler/bpmn/manual-tasks/manual-tasks.md +++ b/docs/components/modeler/bpmn/manual-tasks/manual-tasks.md @@ -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. diff --git a/docs/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx b/docs/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx index aa65e12f972..28a32c487b3 100644 --- a/docs/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx +++ b/docs/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx @@ -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"; diff --git a/docs/components/modeler/bpmn/user-tasks/user-tasks.md b/docs/components/modeler/bpmn/user-tasks/user-tasks.md index caef24995a8..5bba754dab2 100644 --- a/docs/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/docs/components/modeler/bpmn/user-tasks/user-tasks.md @@ -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. diff --git a/docs/components/zeebe/zeebe-overview.md b/docs/components/zeebe/zeebe-overview.md index 0e80316cde3..66698b48592 100644 --- a/docs/components/zeebe/zeebe-overview.md +++ b/docs/components/zeebe/zeebe-overview.md @@ -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: diff --git a/docs/reference/announcements/870.md b/docs/reference/announcements/870.md index 4c745056fd3..c44f848031d 100644 --- a/docs/reference/announcements/870.md +++ b/docs/reference/announcements/870.md @@ -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 SaaS @@ -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 SaaSSelf-Managed + +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. diff --git a/docs/reference/data-collection/data-collection.md b/docs/reference/data-collection/data-collection.md new file mode 100644 index 00000000000..9113b93cca6 --- /dev/null +++ b/docs/reference/data-collection/data-collection.md @@ -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. + + Cookie preferences in user settings + Analytics opt-in menu + + - 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" + } +} +``` diff --git a/docs/reference/usage-metrics.md b/docs/reference/data-collection/usage-metrics.md similarity index 100% rename from docs/reference/usage-metrics.md rename to docs/reference/data-collection/usage-metrics.md diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 994528cdc66..bef03907fe3 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -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) @@ -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. @@ -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). diff --git a/docs/reference/img/analytics.png b/docs/reference/img/analytics.png new file mode 100644 index 00000000000..c122693975f Binary files /dev/null and b/docs/reference/img/analytics.png differ diff --git a/docs/reference/img/cookie-preferences.png b/docs/reference/img/cookie-preferences.png new file mode 100644 index 00000000000..d16015512cc Binary files /dev/null and b/docs/reference/img/cookie-preferences.png differ diff --git a/docs/reference/overview.md b/docs/reference/overview.md index 301e4cc5409..753f75c9c22 100644 --- a/docs/reference/overview.md +++ b/docs/reference/overview.md @@ -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. diff --git a/docs/reference/supported-environments.md b/docs/reference/supported-environments.md index cffe50ee9a1..20a70a81126 100644 --- a/docs/reference/supported-environments.md +++ b/docs/reference/supported-environments.md @@ -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 diff --git a/optimize_versioned_docs/version-3.11.0/self-managed/optimize-deployment/configuration/authorization-management.md b/optimize_versioned_docs/version-3.11.0/self-managed/optimize-deployment/configuration/authorization-management.md index 00d8786097f..cb4134d4fbe 100644 --- a/optimize_versioned_docs/version-3.11.0/self-managed/optimize-deployment/configuration/authorization-management.md +++ b/optimize_versioned_docs/version-3.11.0/self-managed/optimize-deployment/configuration/authorization-management.md @@ -6,7 +6,7 @@ description: "Define which data users are authorized to see." Camunda 7 only -User authorization management differs depending on whether the entities to manage the authorizations for are originating from adjacent systems like imported data from connected Camunda-BPM engines such as process instances, or whether the entities are fully managed by Camunda Optimize, such as [event-based processes and instances](#) or [collections](components/userguide/collections-dashboards-reports.md). For entities originating from adjacent systems authorizations are managed in the Camunda 7 via Camunda Admin, for the latter the authorizations are managed in Camunda Optimize. +User authorization management differs depending on whether the entities to manage the authorizations for are originating from adjacent systems like imported data from the connected Camunda workflow engine such as process instances, or whether the entities are fully managed by Camunda Optimize, such as [event-based processes and instances](#) or [collections](components/userguide/collections-dashboards-reports.md). For entities originating from adjacent systems authorizations are managed in the Camunda 7 via Camunda Admin, for the latter the authorizations are managed in Camunda Optimize. ## Camunda 7 data authorizations diff --git a/optimize_versioned_docs/version-3.12.0/self-managed/optimize-deployment/configuration/authorization-management.md b/optimize_versioned_docs/version-3.12.0/self-managed/optimize-deployment/configuration/authorization-management.md index b3cc86dc2e9..af84ebe88f0 100644 --- a/optimize_versioned_docs/version-3.12.0/self-managed/optimize-deployment/configuration/authorization-management.md +++ b/optimize_versioned_docs/version-3.12.0/self-managed/optimize-deployment/configuration/authorization-management.md @@ -6,7 +6,7 @@ description: "Define which data users are authorized to see." Camunda 7 only -User authorization management differs depending on whether the entities to manage the authorizations for are originating from adjacent systems like imported data from connected Camunda-BPM engines such as process instances, or whether the entities are fully managed by Camunda Optimize, such as [event-based processes and instances](#) or [collections](components/userguide/collections-dashboards-reports.md). For entities originating from adjacent systems authorizations are managed in the Camunda 7 via Camunda Admin, for the latter the authorizations are managed in Camunda Optimize. +User authorization management differs depending on whether the entities to manage the authorizations for are originating from adjacent systems like imported data from the connected Camunda workflow engine such as process instances, or whether the entities are fully managed by Camunda Optimize, such as [event-based processes and instances](#) or [collections](components/userguide/collections-dashboards-reports.md). For entities originating from adjacent systems authorizations are managed in the Camunda 7 via Camunda Admin, for the latter the authorizations are managed in Camunda Optimize. ## Camunda 7 data authorizations diff --git a/optimize_versioned_docs/version-3.13.0/self-managed/optimize-deployment/configuration/authorization-management.md b/optimize_versioned_docs/version-3.13.0/self-managed/optimize-deployment/configuration/authorization-management.md index b3cc86dc2e9..af84ebe88f0 100644 --- a/optimize_versioned_docs/version-3.13.0/self-managed/optimize-deployment/configuration/authorization-management.md +++ b/optimize_versioned_docs/version-3.13.0/self-managed/optimize-deployment/configuration/authorization-management.md @@ -6,7 +6,7 @@ description: "Define which data users are authorized to see." Camunda 7 only -User authorization management differs depending on whether the entities to manage the authorizations for are originating from adjacent systems like imported data from connected Camunda-BPM engines such as process instances, or whether the entities are fully managed by Camunda Optimize, such as [event-based processes and instances](#) or [collections](components/userguide/collections-dashboards-reports.md). For entities originating from adjacent systems authorizations are managed in the Camunda 7 via Camunda Admin, for the latter the authorizations are managed in Camunda Optimize. +User authorization management differs depending on whether the entities to manage the authorizations for are originating from adjacent systems like imported data from the connected Camunda workflow engine such as process instances, or whether the entities are fully managed by Camunda Optimize, such as [event-based processes and instances](#) or [collections](components/userguide/collections-dashboards-reports.md). For entities originating from adjacent systems authorizations are managed in the Camunda 7 via Camunda Admin, for the latter the authorizations are managed in Camunda Optimize. ## Camunda 7 data authorizations diff --git a/sidebars.js b/sidebars.js index 3db3c5822ff..be1af5d8ace 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1032,7 +1032,15 @@ module.exports = { "reference/notices", "reference/release-policy", "reference/regions", - "reference/usage-metrics", + { + type: "category", + label: "Data collection", + link: { + type: "doc", + id: "reference/data-collection/data-collection", + }, + items: ["reference/data-collection/usage-metrics"], + }, "reference/glossary", ], "Self-Managed": [ diff --git a/static/.htaccess b/static/.htaccess index 679ee77da75..dde26c4c9f6 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -516,6 +516,9 @@ RewriteRule ^docs/components/modeler/web-modeler/save-and-deploy/?$ /docs/compon RewriteRule ^docs/next/components/modeler/web-modeler/start-instance/?$ /docs/next/components/modeler/web-modeler/run-or-publish-your-process/ [R=301,L] RewriteRule ^docs/next/components/modeler/web-modeler/save-and-deploy/?$ /docs/next/components/modeler/web-modeler/run-or-publish-your-process/#deploy-a-process [R=301,L,NE] +# Move user metrics page to a new folder +RewriteRule ^docs/reference/usage-metrics.md/?$ ^docs/reference/data-collection/usage-metrics.md/? [R=301,L,NE] + # Remove Migration to Camunda 8 pages RewriteRule ^docs/next/guides/migrating-from-camunda-7/adjusting-dmn-models/(.*)$ /docs/next/guides/migrating-from-camunda-7/index/ [R=301,L] RewriteRule ^docs/8.7/guides/migrating-from-camunda-7/adjusting-dmn-models/(.*)$ /docs/8.7/guides/migrating-from-camunda-7/index/ [R=301,L] diff --git a/versioned_docs/version-8.3/components/components-overview.md b/versioned_docs/version-8.3/components/components-overview.md index e62f4ca085f..1bd46d2222b 100644 --- a/versioned_docs/version-8.3/components/components-overview.md +++ b/versioned_docs/version-8.3/components/components-overview.md @@ -13,7 +13,7 @@ This section contains product manual content for each component in Camunda 8, in - [Console](console/introduction-to-console.md) - With this management application for the included products, create and delete clusters, manage API clients and alerts, and more. - [Modeler](modeler/about-modeler.md) - Design and implement diagrams using Camunda's modeling tools, including Web Modeler and Desktop Modeler. - [Connectors](connectors/introduction.md) - Integrate with external systems using these reusable building blocks. -- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this process automation engine powering Camunda 8. +- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this workflow engine powering Camunda 8. - [Operate](operate/operate-introduction.md) - Monitor and troubleshoot process instances running in Zeebe, and carry out key operations such as resolving incidents and updating process instance variables with Operate. - [Tasklist](tasklist/introduction-to-tasklist.md) - Implement business processes alongside user tasks in Zeebe, and orchestrate human workflows critical to your business to reduce time-to-value for your process orchestration projects with this interface for manual work. - [Optimize]($optimize$/components/what-is-optimize) - Geared toward business stakeholders, Optimize offers business intelligence tooling for Camunda enterprise customers. By leveraging data collected during process execution, users can collaboratively examine areas in business processes for improvement. diff --git a/versioned_docs/version-8.3/components/modeler/bpmn/manual-tasks/manual-tasks.md b/versioned_docs/version-8.3/components/modeler/bpmn/manual-tasks/manual-tasks.md index 5d2ac406614..31f1817ba4a 100644 --- a/versioned_docs/version-8.3/components/modeler/bpmn/manual-tasks/manual-tasks.md +++ b/versioned_docs/version-8.3/components/modeler/bpmn/manual-tasks/manual-tasks.md @@ -1,10 +1,10 @@ --- 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 is external to the BPM engine. This is used to model work that is done +A manual task defines a task that is external to the workflow engine. This is used to model work that is done by somebody who the engine does not need to know of and there is no known system or UI interface. For the engine, a manual task is handled as a pass-through activity, automatically continuing the diff --git a/versioned_docs/version-8.3/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx b/versioned_docs/version-8.3/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx index aa65e12f972..28a32c487b3 100644 --- a/versioned_docs/version-8.3/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx +++ b/versioned_docs/version-8.3/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx @@ -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"; diff --git a/versioned_docs/version-8.3/components/zeebe/zeebe-overview.md b/versioned_docs/version-8.3/components/zeebe/zeebe-overview.md index d6a2492fed5..8e29a668e30 100644 --- a/versioned_docs/version-8.3/components/zeebe/zeebe-overview.md +++ b/versioned_docs/version-8.3/components/zeebe/zeebe-overview.md @@ -2,10 +2,10 @@ id: zeebe-overview title: "Zeebe" sidebar_label: "Introduction" -description: "Zeebe is the process automation engine powering Camunda 8." +description: "Zeebe is the workflow engine powering Camunda 8." --- -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: diff --git a/versioned_docs/version-8.4/components/components-overview.md b/versioned_docs/version-8.4/components/components-overview.md index d63921e3fd2..f755814f2d8 100644 --- a/versioned_docs/version-8.4/components/components-overview.md +++ b/versioned_docs/version-8.4/components/components-overview.md @@ -13,7 +13,7 @@ This section contains product manual content for each component in Camunda 8, in - [Console](console/introduction-to-console.md) - With this management application for the included products, create and delete clusters, manage API clients and alerts, and more. As of version 8.4, Console is only available for Camunda 8 SaaS. For Self-Managed content, visit our [Self-Managed documentation](/docs/self-managed/about-self-managed.md). - [Modeler](modeler/about-modeler.md) - Design and implement diagrams using Camunda's modeling tools, including Web Modeler and Desktop Modeler. - [Connectors](connectors/introduction.md) - Integrate with external systems using these reusable building blocks. -- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this process automation engine powering Camunda 8. +- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this workflow engine powering Camunda 8. - [Operate](operate/operate-introduction.md) - Monitor and troubleshoot process instances running in Zeebe, and carry out key operations such as resolving incidents and updating process instance variables with Operate. - [Tasklist](tasklist/introduction-to-tasklist.md) - Implement business processes alongside user tasks in Zeebe, and orchestrate human workflows critical to your business to reduce time-to-value for your process orchestration projects with this interface for manual work. - [Optimize]($optimize$/components/what-is-optimize) - Geared toward business stakeholders, Optimize offers business intelligence tooling for Camunda enterprise customers. By leveraging data collected during process execution, users can collaboratively examine areas in business processes for improvement. diff --git a/versioned_docs/version-8.4/components/modeler/bpmn/manual-tasks/manual-tasks.md b/versioned_docs/version-8.4/components/modeler/bpmn/manual-tasks/manual-tasks.md index 5d2ac406614..31f1817ba4a 100644 --- a/versioned_docs/version-8.4/components/modeler/bpmn/manual-tasks/manual-tasks.md +++ b/versioned_docs/version-8.4/components/modeler/bpmn/manual-tasks/manual-tasks.md @@ -1,10 +1,10 @@ --- 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 is external to the BPM engine. This is used to model work that is done +A manual task defines a task that is external to the workflow engine. This is used to model work that is done by somebody who the engine does not need to know of and there is no known system or UI interface. For the engine, a manual task is handled as a pass-through activity, automatically continuing the diff --git a/versioned_docs/version-8.4/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx b/versioned_docs/version-8.4/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx index aa65e12f972..28a32c487b3 100644 --- a/versioned_docs/version-8.4/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx +++ b/versioned_docs/version-8.4/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx @@ -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"; diff --git a/versioned_docs/version-8.4/components/zeebe/zeebe-overview.md b/versioned_docs/version-8.4/components/zeebe/zeebe-overview.md index 7ab27b959b8..801bdc0bcfc 100644 --- a/versioned_docs/version-8.4/components/zeebe/zeebe-overview.md +++ b/versioned_docs/version-8.4/components/zeebe/zeebe-overview.md @@ -2,10 +2,10 @@ id: zeebe-overview title: "Zeebe" sidebar_label: "Introduction" -description: "Zeebe is the process automation engine powering Camunda 8." +description: "Zeebe is the workflow engine powering Camunda 8." --- -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: diff --git a/versioned_docs/version-8.4/reference/glossary.md b/versioned_docs/version-8.4/reference/glossary.md index ff252b08ce5..013bec95ef1 100644 --- a/versioned_docs/version-8.4/reference/glossary.md +++ b/versioned_docs/version-8.4/reference/glossary.md @@ -252,6 +252,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). diff --git a/versioned_docs/version-8.5/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md b/versioned_docs/version-8.5/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md index 8b727c2bcf0..c7d901bb022 100644 --- a/versioned_docs/version-8.5/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md +++ b/versioned_docs/version-8.5/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md @@ -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. diff --git a/versioned_docs/version-8.5/components/modeler/bpmn/manual-tasks/manual-tasks.md b/versioned_docs/version-8.5/components/modeler/bpmn/manual-tasks/manual-tasks.md index 5d2ac406614..31f1817ba4a 100644 --- a/versioned_docs/version-8.5/components/modeler/bpmn/manual-tasks/manual-tasks.md +++ b/versioned_docs/version-8.5/components/modeler/bpmn/manual-tasks/manual-tasks.md @@ -1,10 +1,10 @@ --- 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 is external to the BPM engine. This is used to model work that is done +A manual task defines a task that is external to the workflow engine. This is used to model work that is done by somebody who the engine does not need to know of and there is no known system or UI interface. For the engine, a manual task is handled as a pass-through activity, automatically continuing the diff --git a/versioned_docs/version-8.5/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx b/versioned_docs/version-8.5/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx index aa65e12f972..28a32c487b3 100644 --- a/versioned_docs/version-8.5/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx +++ b/versioned_docs/version-8.5/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx @@ -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"; diff --git a/versioned_docs/version-8.5/components/zeebe/zeebe-overview.md b/versioned_docs/version-8.5/components/zeebe/zeebe-overview.md index 0e80316cde3..66698b48592 100644 --- a/versioned_docs/version-8.5/components/zeebe/zeebe-overview.md +++ b/versioned_docs/version-8.5/components/zeebe/zeebe-overview.md @@ -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: diff --git a/versioned_docs/version-8.5/reference/glossary.md b/versioned_docs/version-8.5/reference/glossary.md index 20d7a4f0641..6293bbc8f6f 100644 --- a/versioned_docs/version-8.5/reference/glossary.md +++ b/versioned_docs/version-8.5/reference/glossary.md @@ -252,6 +252,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). diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md index a6c919bc957..b9869b6e7e3 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md @@ -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. diff --git a/versioned_docs/version-8.6/components/modeler/bpmn/manual-tasks/manual-tasks.md b/versioned_docs/version-8.6/components/modeler/bpmn/manual-tasks/manual-tasks.md index d444261ac2f..600fa980f34 100644 --- a/versioned_docs/version-8.6/components/modeler/bpmn/manual-tasks/manual-tasks.md +++ b/versioned_docs/version-8.6/components/modeler/bpmn/manual-tasks/manual-tasks.md @@ -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. diff --git a/versioned_docs/version-8.6/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx b/versioned_docs/version-8.6/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx index aa65e12f972..28a32c487b3 100644 --- a/versioned_docs/version-8.6/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx +++ b/versioned_docs/version-8.6/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx @@ -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"; diff --git a/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md b/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md index f4629756f86..ec98bd3c71b 100644 --- a/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md @@ -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. diff --git a/versioned_docs/version-8.6/components/zeebe/zeebe-overview.md b/versioned_docs/version-8.6/components/zeebe/zeebe-overview.md index 0e80316cde3..66698b48592 100644 --- a/versioned_docs/version-8.6/components/zeebe/zeebe-overview.md +++ b/versioned_docs/version-8.6/components/zeebe/zeebe-overview.md @@ -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: diff --git a/versioned_docs/version-8.6/reference/data-collection/data-collection.md b/versioned_docs/version-8.6/reference/data-collection/data-collection.md new file mode 100644 index 00000000000..bb438c70910 --- /dev/null +++ b/versioned_docs/version-8.6/reference/data-collection/data-collection.md @@ -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. + + Cookie preferences in user settings + Analytics opt-in menu + + - 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](/docs/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" + } +} +``` diff --git a/versioned_docs/version-8.7/reference/usage-metrics.md b/versioned_docs/version-8.6/reference/data-collection/usage-metrics.md similarity index 100% rename from versioned_docs/version-8.7/reference/usage-metrics.md rename to versioned_docs/version-8.6/reference/data-collection/usage-metrics.md diff --git a/versioned_docs/version-8.6/reference/glossary.md b/versioned_docs/version-8.6/reference/glossary.md index 486cd1eb278..c867001feb6 100644 --- a/versioned_docs/version-8.6/reference/glossary.md +++ b/versioned_docs/version-8.6/reference/glossary.md @@ -153,7 +153,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) @@ -260,7 +260,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. - [User tasks](/components/modeler/bpmn/user-tasks/user-tasks.md) @@ -280,6 +280,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). diff --git a/versioned_docs/version-8.6/reference/img/analytics.png b/versioned_docs/version-8.6/reference/img/analytics.png new file mode 100644 index 00000000000..c122693975f Binary files /dev/null and b/versioned_docs/version-8.6/reference/img/analytics.png differ diff --git a/versioned_docs/version-8.6/reference/img/cookie-preferences.png b/versioned_docs/version-8.6/reference/img/cookie-preferences.png new file mode 100644 index 00000000000..d16015512cc Binary files /dev/null and b/versioned_docs/version-8.6/reference/img/cookie-preferences.png differ diff --git a/versioned_docs/version-8.6/reference/overview.md b/versioned_docs/version-8.6/reference/overview.md index 1911f5150c1..832e4f8f17c 100644 --- a/versioned_docs/version-8.6/reference/overview.md +++ b/versioned_docs/version-8.6/reference/overview.md @@ -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. diff --git a/versioned_docs/version-8.7/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md b/versioned_docs/version-8.7/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md index a6c919bc957..b9869b6e7e3 100644 --- a/versioned_docs/version-8.7/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md +++ b/versioned_docs/version-8.7/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md @@ -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. diff --git a/versioned_docs/version-8.7/components/modeler/bpmn/manual-tasks/manual-tasks.md b/versioned_docs/version-8.7/components/modeler/bpmn/manual-tasks/manual-tasks.md index d444261ac2f..600fa980f34 100644 --- a/versioned_docs/version-8.7/components/modeler/bpmn/manual-tasks/manual-tasks.md +++ b/versioned_docs/version-8.7/components/modeler/bpmn/manual-tasks/manual-tasks.md @@ -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. diff --git a/versioned_docs/version-8.7/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx b/versioned_docs/version-8.7/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx index aa65e12f972..28a32c487b3 100644 --- a/versioned_docs/version-8.7/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx +++ b/versioned_docs/version-8.7/components/modeler/bpmn/undefined-tasks/undefined-tasks.mdx @@ -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"; diff --git a/versioned_docs/version-8.7/components/modeler/bpmn/user-tasks/user-tasks.md b/versioned_docs/version-8.7/components/modeler/bpmn/user-tasks/user-tasks.md index 91699571a93..5e0aaf7fcfa 100644 --- a/versioned_docs/version-8.7/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/versioned_docs/version-8.7/components/modeler/bpmn/user-tasks/user-tasks.md @@ -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. diff --git a/versioned_docs/version-8.7/components/zeebe/zeebe-overview.md b/versioned_docs/version-8.7/components/zeebe/zeebe-overview.md index 0e80316cde3..66698b48592 100644 --- a/versioned_docs/version-8.7/components/zeebe/zeebe-overview.md +++ b/versioned_docs/version-8.7/components/zeebe/zeebe-overview.md @@ -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: diff --git a/versioned_docs/version-8.7/reference/announcements/870.md b/versioned_docs/version-8.7/reference/announcements/870.md index 23e06fdcf62..6b9d3b6d2d0 100644 --- a/versioned_docs/version-8.7/reference/announcements/870.md +++ b/versioned_docs/version-8.7/reference/announcements/870.md @@ -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 SaaS @@ -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 SaaSSelf-Managed + +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. diff --git a/versioned_docs/version-8.7/reference/data-collection/data-collection.md b/versioned_docs/version-8.7/reference/data-collection/data-collection.md new file mode 100644 index 00000000000..9113b93cca6 --- /dev/null +++ b/versioned_docs/version-8.7/reference/data-collection/data-collection.md @@ -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. + + Cookie preferences in user settings + Analytics opt-in menu + + - 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" + } +} +``` diff --git a/versioned_docs/version-8.7/reference/data-collection/usage-metrics.md b/versioned_docs/version-8.7/reference/data-collection/usage-metrics.md new file mode 100644 index 00000000000..9d2fbeecd58 --- /dev/null +++ b/versioned_docs/version-8.7/reference/data-collection/usage-metrics.md @@ -0,0 +1,48 @@ +--- +id: usage-metrics +title: "Usage metrics" +description: "Learn about the three main usage metrics that impact Camunda 8 pricing." +--- + +There are three main usage metrics that have an impact on Camunda 8 pricing. It is important to understand these definitions, their impact on billing, and how to retrieve them. + +## Definition of metrics + +### Root process instance + +The number of **root process instance** executions started. This is also known as process instances (PI). A **root process instance** has no parent process instance, i.e. it is a top-level execution. + +### Decision instance + +The number of evaluated **decision instances** (DI). A **decision instance** is a [DMN decision table](/components/modeler/dmn/decision-table.md) or a [DMN literal expression](/components/modeler/dmn/decision-literal-expression.md). In a Decision Requirements Diagram (DRD) each evaluated decision table or expression is counted separately. + +### Task user + +The number of **task users** (TU) that have served as assignees. + +## Retrieve metrics in SaaS + +On Camunda 8 SaaS an **Owner** or **Admin** of an organization can retrieve the information from the **Billing** page. + +You can access the **Billing** page by selecting **Organization Management** in the Camunda Console navigation bar. + + + +## Retrieve metrics on Self-Managed + +:::caution Important note for Enterprise users + +Some Enterprise agreements require the following indices from Elasticsearch for at least 18 months: + +For Operate and Tasklist, the metrics are stored in the `operate-metric-1.0.0_` and `tasklist-metric-1.0.0_` indices respectively. +::: + +On Camunda 8 Self-Managed, you can get the usage metrics in Operate and Tasklist. + +For **root process instances** and **decision instances**, follow the steps provided in the [Operate guide](/self-managed/operate-deployment/usage-metrics.md). + +For **task users**, follow the steps provided in the [Tasklist guide](/self-managed/tasklist-deployment/usage-metrics.md). + +:::note +If you are not running Tasklist or Operate, there is currently no way to retrieve usage metrics until future releases. Regardless, the metrics still need to be factored into any enterprise agreement and count towards any task user pricing. +::: diff --git a/versioned_docs/version-8.7/reference/glossary.md b/versioned_docs/version-8.7/reference/glossary.md index 29220d9dfea..0f623577ea9 100644 --- a/versioned_docs/version-8.7/reference/glossary.md +++ b/versioned_docs/version-8.7/reference/glossary.md @@ -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) @@ -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. @@ -297,6 +297,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). diff --git a/versioned_docs/version-8.7/reference/img/analytics.png b/versioned_docs/version-8.7/reference/img/analytics.png new file mode 100644 index 00000000000..c122693975f Binary files /dev/null and b/versioned_docs/version-8.7/reference/img/analytics.png differ diff --git a/versioned_docs/version-8.7/reference/img/cookie-preferences.png b/versioned_docs/version-8.7/reference/img/cookie-preferences.png new file mode 100644 index 00000000000..d16015512cc Binary files /dev/null and b/versioned_docs/version-8.7/reference/img/cookie-preferences.png differ diff --git a/versioned_docs/version-8.7/reference/overview.md b/versioned_docs/version-8.7/reference/overview.md index 301e4cc5409..753f75c9c22 100644 --- a/versioned_docs/version-8.7/reference/overview.md +++ b/versioned_docs/version-8.7/reference/overview.md @@ -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. diff --git a/versioned_docs/version-8.7/reference/supported-environments.md b/versioned_docs/version-8.7/reference/supported-environments.md index 56a3ae6d594..0b5b54c251f 100644 --- a/versioned_docs/version-8.7/reference/supported-environments.md +++ b/versioned_docs/version-8.7/reference/supported-environments.md @@ -38,7 +38,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 diff --git a/versioned_sidebars/version-8.6-sidebars.json b/versioned_sidebars/version-8.6-sidebars.json index ef92da31de8..3a0cb2c63bf 100644 --- a/versioned_sidebars/version-8.6-sidebars.json +++ b/versioned_sidebars/version-8.6-sidebars.json @@ -1762,7 +1762,15 @@ "reference/notices", "reference/release-policy", "reference/regions", - "reference/usage-metrics", + { + "type": "category", + "label": "Data collection", + "link": { + "type": "doc", + "id": "reference/data-collection/data-collection" + }, + "items": ["reference/data-collection/usage-metrics"] + }, "reference/glossary" ], "Self-Managed": [ diff --git a/versioned_sidebars/version-8.7-sidebars.json b/versioned_sidebars/version-8.7-sidebars.json index b97c1250816..dd655d1901e 100644 --- a/versioned_sidebars/version-8.7-sidebars.json +++ b/versioned_sidebars/version-8.7-sidebars.json @@ -1882,7 +1882,15 @@ "reference/notices", "reference/release-policy", "reference/regions", - "reference/usage-metrics", + { + "type": "category", + "label": "Data collection", + "link": { + "type": "doc", + "id": "reference/data-collection/data-collection" + }, + "items": ["reference/data-collection/usage-metrics"] + }, "reference/glossary" ], "Self-Managed": [