diff --git a/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx index ca615d831e..8787494856 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx @@ -59,13 +59,9 @@ On success returned.
Schema
  • Array [
    • variables object[]
    -An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`. +An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. -
  • Array [
    • draft object
    - -The draft value of the variable. - -
  • ]
  • ]
+
  • Array [
  • ]
  • ]
    • An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request diff --git a/docs/apis-tools/web-modeler-api/authentication.md b/docs/apis-tools/web-modeler-api/authentication.md index 388f3f494b..2182aee180 100644 --- a/docs/apis-tools/web-modeler-api/authentication.md +++ b/docs/apis-tools/web-modeler-api/authentication.md @@ -70,7 +70,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/docs/apis-tools/web-modeler-api/index.md b/docs/apis-tools/web-modeler-api/index.md index 2072f90e96..43d1d5d9c1 100644 --- a/docs/apis-tools/web-modeler-api/index.md +++ b/docs/apis-tools/web-modeler-api/index.md @@ -14,7 +14,7 @@ Ensure you [authenticate](./authentication.md) before accessing the Web Modeler ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md b/docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md index c1d48ba11f..d02a79c4f9 100644 --- a/docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md +++ b/docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md @@ -17,7 +17,9 @@ Use Camunda secrets to store credentials so you don't expose sensitive informati ## Create an Amazon DynamoDB Connector task -To use the **Amazon DynamoDB Connector** in your process, either change the type of existing task by clicking on it and using the **wrench-shaped** change type context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon DynamoDB Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md b/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md index fe98427dde..5ff312afc7 100644 --- a/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md +++ b/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md @@ -30,7 +30,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an Amazon EventBridge Connector task -To use the **Amazon EventBridge Connector** in your process, you can either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Refer to our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Configure the Amazon EventBridge Connector diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-sagemaker.md b/docs/components/connectors/out-of-the-box-connectors/amazon-sagemaker.md index 5d115dabac..f371e2b7c8 100644 --- a/docs/components/connectors/out-of-the-box-connectors/amazon-sagemaker.md +++ b/docs/components/connectors/out-of-the-box-connectors/amazon-sagemaker.md @@ -28,9 +28,9 @@ Use Camunda secrets to store credentials and avoid exposing sensitive informatio ## Create an Amazon SageMaker Connector task -To use the **Amazon SageMaker Connector** in your process, either change the type of existing task by clicking on it -and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the -**Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon SageMaker Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-sns.md b/docs/components/connectors/out-of-the-box-connectors/amazon-sns.md index 03719c17ca..dacc609504 100644 --- a/docs/components/connectors/out-of-the-box-connectors/amazon-sns.md +++ b/docs/components/connectors/out-of-the-box-connectors/amazon-sns.md @@ -28,7 +28,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an Amazon SNS Connector task -To use the **Amazon SNS Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon SNS Connector for sending messages executable diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-sqs.md b/docs/components/connectors/out-of-the-box-connectors/amazon-sqs.md index 379d3c4de2..64091945d7 100644 --- a/docs/components/connectors/out-of-the-box-connectors/amazon-sqs.md +++ b/docs/components/connectors/out-of-the-box-connectors/amazon-sqs.md @@ -30,7 +30,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an Amazon SQS Connector task -To use the **Amazon SQS Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon SQS Connector for sending messages executable diff --git a/docs/components/connectors/out-of-the-box-connectors/asana.md b/docs/components/connectors/out-of-the-box-connectors/asana.md index f9917b940a..dc8eedb499 100644 --- a/docs/components/connectors/out-of-the-box-connectors/asana.md +++ b/docs/components/connectors/out-of-the-box-connectors/asana.md @@ -17,9 +17,9 @@ Use Camunda secrets to avoid exposing your Asana personal access token as plain ## Create an Asana Connector task -To use the **Asana Connector** in your process, either change the type of existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/docs/components/connectors/out-of-the-box-connectors/automation-anywhere.md b/docs/components/connectors/out-of-the-box-connectors/automation-anywhere.md index 460831c94a..d54c9eea77 100644 --- a/docs/components/connectors/out-of-the-box-connectors/automation-anywhere.md +++ b/docs/components/connectors/out-of-the-box-connectors/automation-anywhere.md @@ -12,7 +12,9 @@ You also need a user account with the `AAE_Queue Admin` role to query and manage ## Create an Automation Anywhere Connector task -To use an **Automation Anywhere Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Automation Anywhere Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/aws-lambda.md b/docs/components/connectors/out-of-the-box-connectors/aws-lambda.md index 96d7579960..cd278278c1 100644 --- a/docs/components/connectors/out-of-the-box-connectors/aws-lambda.md +++ b/docs/components/connectors/out-of-the-box-connectors/aws-lambda.md @@ -16,7 +16,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an AWS Lambda Connector task -To use an **AWS Lambda Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Invoking your AWS Lambda function diff --git a/docs/components/connectors/out-of-the-box-connectors/azure-open-ai.md b/docs/components/connectors/out-of-the-box-connectors/azure-open-ai.md index fd84f19671..2f8f47fd3c 100644 --- a/docs/components/connectors/out-of-the-box-connectors/azure-open-ai.md +++ b/docs/components/connectors/out-of-the-box-connectors/azure-open-ai.md @@ -25,7 +25,9 @@ Learn more at the [official Azure OpenAI portal entry](https://learn.microsoft.c ## Create an Azure OpenAI Connector task -To use the **Azure OpenAI Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Azure OpenAI Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/blueprism.md b/docs/components/connectors/out-of-the-box-connectors/blueprism.md index 1ed20e4fb2..3915348359 100644 --- a/docs/components/connectors/out-of-the-box-connectors/blueprism.md +++ b/docs/components/connectors/out-of-the-box-connectors/blueprism.md @@ -10,7 +10,9 @@ To start using the Connector, you must have a running Blue Prism instance config ## Create a Blue Prism Connector task -To use a **Blue Prism Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](../use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/docs/components/connectors/out-of-the-box-connectors/easy-post.md b/docs/components/connectors/out-of-the-box-connectors/easy-post.md index 8812b3ab34..63be8312ce 100644 --- a/docs/components/connectors/out-of-the-box-connectors/easy-post.md +++ b/docs/components/connectors/out-of-the-box-connectors/easy-post.md @@ -17,7 +17,9 @@ Use Camunda secrets to avoid exposing your EasyPost API key as plain text. Refer ## Create an EasyPost Connector task -To use the **EasyPost Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/docs/components/connectors/out-of-the-box-connectors/github.md b/docs/components/connectors/out-of-the-box-connectors/github.md index 9558b74416..06d2623894 100644 --- a/docs/components/connectors/out-of-the-box-connectors/github.md +++ b/docs/components/connectors/out-of-the-box-connectors/github.md @@ -29,7 +29,9 @@ Refer to our documentation on [managing secrets](/components/console/manage-clus ## Create a GitHub Connector task -To use the **GitHub Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/docs/components/connectors/out-of-the-box-connectors/gitlab.md b/docs/components/connectors/out-of-the-box-connectors/gitlab.md index ecd8f5e079..986e6fcbbc 100644 --- a/docs/components/connectors/out-of-the-box-connectors/gitlab.md +++ b/docs/components/connectors/out-of-the-box-connectors/gitlab.md @@ -18,7 +18,9 @@ Use Camunda secrets to avoid exposing your GitLab access token credentials as pl ## Create a GitLab Connector task -To use the **GitLab Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Add endpoint and authentication diff --git a/docs/components/connectors/out-of-the-box-connectors/google-maps-platform.md b/docs/components/connectors/out-of-the-box-connectors/google-maps-platform.md index eb2b789c67..e4c2c56e76 100644 --- a/docs/components/connectors/out-of-the-box-connectors/google-maps-platform.md +++ b/docs/components/connectors/out-of-the-box-connectors/google-maps-platform.md @@ -9,7 +9,9 @@ The **Google Maps Platform Connector** in an inbound Connector that allows you t ## Create a Google Maps Platform Connector task -To use a **Google Maps Platform Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Google Maps Platform Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/google-sheets.md b/docs/components/connectors/out-of-the-box-connectors/google-sheets.md index 385cd257bf..fabe161b17 100644 --- a/docs/components/connectors/out-of-the-box-connectors/google-sheets.md +++ b/docs/components/connectors/out-of-the-box-connectors/google-sheets.md @@ -30,8 +30,9 @@ Currently, the Google Sheets Connector supports next operations: - [Get spreadsheet details](#get-spreadsheet-details) - [Get worksheet data](#get-worksheet-data) -To use a **Google Sheets Connector** in your process, either change the type of existing task by clicking on it and -using the wrench-shaped **Change type** context menu icon or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Google Sheets Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/googledrive.md b/docs/components/connectors/out-of-the-box-connectors/googledrive.md index 6d987bc67c..66ac5a9ceb 100644 --- a/docs/components/connectors/out-of-the-box-connectors/googledrive.md +++ b/docs/components/connectors/out-of-the-box-connectors/googledrive.md @@ -14,7 +14,9 @@ To start working with the **Google Drive Connector**, a relevant OAuth token mus Currently, the Google Drive Connector supports two types of operations: create a folder and create a file from a template. -To use a **Google Drive Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Google Drive Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/hugging-face.md b/docs/components/connectors/out-of-the-box-connectors/hugging-face.md index 8382248bcd..3089b51f19 100644 --- a/docs/components/connectors/out-of-the-box-connectors/hugging-face.md +++ b/docs/components/connectors/out-of-the-box-connectors/hugging-face.md @@ -16,9 +16,9 @@ and a model deployed with [Inference API](https://huggingface.co/docs/api-infere ## Create a Hugging Face Connector task -To use the **Hugging Face Connector** in your process, either change the type of existing task by clicking on it -and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the -**Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Hugging Face Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/kafka.md b/docs/components/connectors/out-of-the-box-connectors/kafka.md index 8271708609..bf2cf0c5a0 100644 --- a/docs/components/connectors/out-of-the-box-connectors/kafka.md +++ b/docs/components/connectors/out-of-the-box-connectors/kafka.md @@ -25,7 +25,9 @@ Use Camunda secrets to avoid exposing your sensitive data as plain text. Follow ## Create a Kafka Producer Connector task -To use the **Kafka Producer Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Kafka Producer Connector for publishing messages executable diff --git a/docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md b/docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md index 5e63d0e264..9d6c35ae08 100644 --- a/docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md +++ b/docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md @@ -22,7 +22,9 @@ Refer to our documentation on [managing secrets](/components/console/manage-clus ## Create a Microsoft 365 Connector task -To use the **Microsoft 365 Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Access control diff --git a/docs/components/connectors/out-of-the-box-connectors/microsoft-teams.md b/docs/components/connectors/out-of-the-box-connectors/microsoft-teams.md index 02538d6c2a..3d3163203b 100644 --- a/docs/components/connectors/out-of-the-box-connectors/microsoft-teams.md +++ b/docs/components/connectors/out-of-the-box-connectors/microsoft-teams.md @@ -22,8 +22,9 @@ Use Camunda secrets to store credentials so you don't expose sensitive informati ## Create a Microsoft Teams Connector task -To use the **Microsoft Teams Connector** in your process, either change the type of existing task by clicking on it and -using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Microsoft Teams Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/openai.md b/docs/components/connectors/out-of-the-box-connectors/openai.md index 4aec79dfb3..9854697172 100644 --- a/docs/components/connectors/out-of-the-box-connectors/openai.md +++ b/docs/components/connectors/out-of-the-box-connectors/openai.md @@ -20,7 +20,9 @@ Use Camunda secrets to avoid exposing your sensitive data, such as your OpenAI A ## Create an OpenAI Connector task -To use the **OpenAI Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your OpenAI Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/operate.md b/docs/components/connectors/out-of-the-box-connectors/operate.md index ac9fd92176..c917e9505e 100644 --- a/docs/components/connectors/out-of-the-box-connectors/operate.md +++ b/docs/components/connectors/out-of-the-box-connectors/operate.md @@ -28,8 +28,9 @@ Use Camunda secrets to store credentials so you don't expose sensitive informati ## Create an Operate Connector task -To use the **Operate Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Enter your cluster information diff --git a/docs/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md b/docs/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md index 127e76166c..426190c2ca 100644 --- a/docs/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md +++ b/docs/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md @@ -29,9 +29,9 @@ Ensure you enter the correct exchange name and routing key, as the **RabbitMQ Co ## Create a RabbitMQ Connector task -To use the **RabbitMQ Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. +import ConnectorTask from '../../../components/react-components/connector-task.md' -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. + ## Connecting to RabbitMQ and sending messages @@ -129,7 +129,7 @@ Using Camunda secrets to store credentials is recommended so you do not expose s ## Create a RabbitMQ Connector event -To use the **RabbitMQ Consumer Connector** in your process, either change the type of existing event by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector event using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +See [create a RabbitMQ Connector task](#create-a-rabbitmq-connector-task) for additional details. 1. Add a **Start Event** or an **Intermediate Event** to your BPMN diagram to get started. 2. Change its template to a RabbitMQ Connector. diff --git a/docs/components/connectors/out-of-the-box-connectors/salesforce.md b/docs/components/connectors/out-of-the-box-connectors/salesforce.md index 8280e40521..75f0f1dd4c 100644 --- a/docs/components/connectors/out-of-the-box-connectors/salesforce.md +++ b/docs/components/connectors/out-of-the-box-connectors/salesforce.md @@ -16,9 +16,9 @@ Use Camunda secrets to avoid exposing your _Salesforce Connected App_ client ID ## Create a Salesforce Connector task -To use the **Salesforce Connector** in your process, either change the type of existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Instance diff --git a/docs/components/connectors/out-of-the-box-connectors/sendgrid.md b/docs/components/connectors/out-of-the-box-connectors/sendgrid.md index 00ad071a92..28ea9c2424 100644 --- a/docs/components/connectors/out-of-the-box-connectors/sendgrid.md +++ b/docs/components/connectors/out-of-the-box-connectors/sendgrid.md @@ -21,7 +21,9 @@ The SendGrid Connector comes with two options: #### Create a SendGrid Email Connector Task -To use a **SendGrid Connector** in your process, either change the type of an existing task to **SendGrid: Send Email** using the wrench-shaped **Change type** context menu, or create a new **SendGrid: Send Email** Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + #### Make your SendGrid Email Connector executable @@ -81,7 +83,7 @@ While you are editing your template, you can test how your email would look by s #### Create a SendGrid Email template Connector task -To use this **SendGrid Connector** in your process, either change the type of an existing task to **SendGrid: Send Email via Template** using the wrench-shaped **Change type** context menu, or create a new **SendGrid: Send Email via Template** Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +See [create a SendGrid email Connector task](#create-a-sendgrid-email-connector-task) for additional details. #### Make your SendGrid Email Template Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/slack.md b/docs/components/connectors/out-of-the-box-connectors/slack.md index ad8f0597f7..28093a58d7 100644 --- a/docs/components/connectors/out-of-the-box-connectors/slack.md +++ b/docs/components/connectors/out-of-the-box-connectors/slack.md @@ -23,7 +23,9 @@ To use the Slack Connector, a Slack app must be registered with the Slack worksp ## Create a Slack Connector task -To use a **Slack Connector** in your process, either change the type of an existing task by clicking on it and using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Slack Connector executable @@ -89,7 +91,8 @@ To post a message, take the following steps: 2. Set **Channel/User Name** to either the **channel** or **user** you want to send the message to. 1. A **channel** is specified by a unique identifier starting with a `#` (for example, `#myChannel`). 2. A **user** is specified by a username starting with an `@` symbol (for example, `@myUser`). -3. Select a **Message type**. +3. (Optional) A **thread** can be specified to start a thread from a specific message. For example, `ts` in the response can be used (see [here](#post-message)). If the message has been posted by a user, we currently have no way to retrieve the `ts` value. Visit the [Slack documentation](https://api.slack.com/methods/chat.postMessage) for additional details. +4. Select a **Message type**. 1. When **Plain text** is selected, set **Message** to the message string you would like to send (for example, `Hello World!`). 2. When **Message block** is selected, set **Message block** to a formatted rich text block format. Learn more about rich text message block format in the [official Slack documentation](https://api.slack.com/reference/surfaces/formatting#stack_of_blocks). diff --git a/docs/components/connectors/out-of-the-box-connectors/sql.md b/docs/components/connectors/out-of-the-box-connectors/sql.md index a8ed810752..244866a747 100644 --- a/docs/components/connectors/out-of-the-box-connectors/sql.md +++ b/docs/components/connectors/out-of-the-box-connectors/sql.md @@ -15,7 +15,9 @@ To avoid exposing your sensitive data as plain text, use Camunda secrets. Follow ## Create an SQL Connector task -To use the **SQL Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your SQL Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/twilio.md b/docs/components/connectors/out-of-the-box-connectors/twilio.md index ca28867959..6c43eaca5b 100644 --- a/docs/components/connectors/out-of-the-box-connectors/twilio.md +++ b/docs/components/connectors/out-of-the-box-connectors/twilio.md @@ -28,7 +28,9 @@ Use Camunda secrets to store your account SID and auth token so you don't expose ## Create a Twilio Connector task -To use the Twilio Connector in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](https://docs.camunda.org/manual/latest/user-guide/process-engine/connectors/) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Twilio Connector executable diff --git a/docs/components/connectors/out-of-the-box-connectors/uipath.md b/docs/components/connectors/out-of-the-box-connectors/uipath.md index e144e17d6e..ce7f253622 100644 --- a/docs/components/connectors/out-of-the-box-connectors/uipath.md +++ b/docs/components/connectors/out-of-the-box-connectors/uipath.md @@ -12,7 +12,9 @@ To use the **UiPath Connector**, you need to have a [UiPath](https://cloud.uipat ## Create a UiPath Connector task -To use a **UiPath Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Operation types diff --git a/docs/components/connectors/out-of-the-box-connectors/whatsapp.md b/docs/components/connectors/out-of-the-box-connectors/whatsapp.md index ecab54ff85..f99c1e2c78 100644 --- a/docs/components/connectors/out-of-the-box-connectors/whatsapp.md +++ b/docs/components/connectors/out-of-the-box-connectors/whatsapp.md @@ -17,9 +17,9 @@ WhatsApp webhooks are currently not supported by Camunda. ## Create a WhatsApp Connector task -To use the **WhatsApp Connector** in your process, either change the type of existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/docs/components/connectors/protocol/graphql.md b/docs/components/connectors/protocol/graphql.md index 94ae3d77b5..82c2e2758e 100644 --- a/docs/components/connectors/protocol/graphql.md +++ b/docs/components/connectors/protocol/graphql.md @@ -13,7 +13,9 @@ The GraphQL Connector allows you to connect to a GraphQL API endpoint. To use th ## Create a GraphQL Connector task -To use a **GraphQL Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your GraphQL Connector executable diff --git a/docs/components/connectors/protocol/rest.md b/docs/components/connectors/protocol/rest.md index aba75cf00e..4a2b159f3b 100644 --- a/docs/components/connectors/protocol/rest.md +++ b/docs/components/connectors/protocol/rest.md @@ -15,7 +15,9 @@ The **REST Connector** is an outbound protocol Connector that allows you to make ## Create a REST Connector task -To use a **REST Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your REST Connector executable @@ -140,7 +142,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/docs/components/connectors/protocol/soap.md b/docs/components/connectors/protocol/soap.md index eaf4a6e08b..98cd9fe947 100644 --- a/docs/components/connectors/protocol/soap.md +++ b/docs/components/connectors/protocol/soap.md @@ -21,9 +21,9 @@ To use the **SOAP Connector**, ensure you have an active SOAP service. ## Create a SOAP Connector task -To use the **SOAP Connector** in your process, either change the type of an existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Connection diff --git a/docs/components/connectors/use-connectors/outbound.md b/docs/components/connectors/use-connectors/outbound.md index c2065b10de..8b82b17beb 100644 --- a/docs/components/connectors/use-connectors/outbound.md +++ b/docs/components/connectors/use-connectors/outbound.md @@ -8,9 +8,9 @@ description: Learn how to use outbound Connectors ## Creating the BPMN task -Use the change type context menu item (spanner/wrench icon) to integrate Connectors in a business model. Users can search for keywords like `REST` or `email` to find specific Connectors. To discover all available Connectors in Camunda, input the term `Connector` into the search bar. +import ConnectorTask from '../../../components/react-components/connector-task.md' -Alternatively, you can directly create a Connector task by using the **Append Connector** context menu item. This creates a new Connector task directly following the currently selected element. + ## Configuring the outbound Connector diff --git a/docs/components/console/manage-clusters/manage-alerts.md b/docs/components/console/manage-clusters/manage-alerts.md index 3c880bcedb..c5c9e983ce 100644 --- a/docs/components/console/manage-clusters/manage-alerts.md +++ b/docs/components/console/manage-clusters/manage-alerts.md @@ -41,11 +41,11 @@ Webhook alerts contain a JSON body with following structure: { "clusterName": "cluster-name", "clusterId": "88d32bfc-4f8e-4dd3-9ae2-adfee281e223", - "operateBaseUrl": "https://console.cloud.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate", - "clusterUrl": "https://console.cloud.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223", + "operateBaseUrl": "https://console.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate", + "clusterUrl": "https://console.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223", "alerts": [ { - "operateUrl": "https://console.cloud.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate/#/instances/2251799829404548", + "operateUrl": "https://console.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate/#/instances/2251799829404548", "processInstanceId": "1234567890123456", "errorMessage": "something went wrong", "errorType": "JOB_NO_RETRIES", diff --git a/docs/components/console/manage-organization/external-sso.md b/docs/components/console/manage-organization/external-sso.md index b0823e8c3b..5bcd128ca4 100644 --- a/docs/components/console/manage-organization/external-sso.md +++ b/docs/components/console/manage-organization/external-sso.md @@ -35,6 +35,19 @@ For Azure AD, you will need to provide: To generate the client on your end, you will need to use the Camunda **Redirect URL** `https://weblogin.cloud.camunda.io/login/callback `. Ensure you attach the user permissions `Users > User.Read`. +### Default organizations Enterprise only + +:::info +Default organizations for external identity providers are only available for organizations on an Enterprise plan. +::: + +By setting up an external identity provider, it is possible to configure up to 10 default organizations. The following information must be added in the ticket so that the support team can configure the default organizations: + +- Organization Id +- Default organization roles + +If a user logs in with the configured connection, the user is automatically assigned to these organizations with the corresponding roles. + ### Additional information In some situations, you might need to access `openid-configuration` to establish the connection from your end. See [this OpenID configuration](https://weblogin.cloud.camunda.io/.well-known/openid-configuration) as an example. diff --git a/docs/components/modeler/feel/language-guide/feel-context-expressions.md b/docs/components/modeler/feel/language-guide/feel-context-expressions.md index 9b37f3d2b0..8e6a232f1d 100644 --- a/docs/components/modeler/feel/language-guide/feel-context-expressions.md +++ b/docs/components/modeler/feel/language-guide/feel-context-expressions.md @@ -102,7 +102,7 @@ accessed by their key. b: 10 } ][b > 7] -// {a: "p2", b: 10} +// [{a: "p2", b: 10}] ``` ### Projection diff --git a/docs/components/operate/userguide/process-instance-migration.md b/docs/components/operate/userguide/process-instance-migration.md index b91bd9f226..01efa246e8 100644 --- a/docs/components/operate/userguide/process-instance-migration.md +++ b/docs/components/operate/userguide/process-instance-migration.md @@ -24,7 +24,7 @@ It is only possible to migrate running process instances, meaning instances in a The migration view features three areas: the source process diagram (top left), the target process diagram (top right) and the flow node mapping (bottom panel). -4. Select a target process and version from the dropdown at the top right. This will be the process version where all selected process instances are migrated to. +4. Enter a target process into the **Target** box, and select a version from the dropdown. This will be the process version where all selected process instances are migrated to. ![operate-select-target-process](./img/process-instance-migration/select-target-process.png) @@ -50,7 +50,7 @@ In this example, process instances will be migrated from `Check payment` flow no Now, you can see a preview of how flow nodes are mapped and how many process instances are expected to be migrated. In this example, three active instances of the `Check payment` flow node will be migrated from version 1 to version 2 of `orderProcess`. -8. Click **Confirm** to start the migration operation. +8. Click **Confirm** to review your migration. When ready, enter the word **MIGRATE** into the text box, and click **Confirm** again to start the migration operation. ![operate-view-process-filters](./img/process-instance-migration/summary.png) diff --git a/docs/components/react-components/connector-task.md b/docs/components/react-components/connector-task.md new file mode 100644 index 0000000000..7bf9fa8631 --- /dev/null +++ b/docs/components/react-components/connector-task.md @@ -0,0 +1,12 @@ +--- +--- + +A Connector can be applied to a task or an event using the append menu. Access the append menu using any of the three methods below: + +- **From the canvas**: Select an element and click the **Change element** icon to change an existing element, or use the append feature to add a new element to the diagram. +- **From the properties panel**: Navigate to the **Template** section and click **Select**. +- **From the side palette**: Click the **Create element** icon. + +![change element](./img/change-element.png) + +Once you have applied a Connector to your element, follow the configuration steps or read our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. diff --git a/docs/components/react-components/img/change-element.png b/docs/components/react-components/img/change-element.png new file mode 100644 index 0000000000..3f0207bb1b Binary files /dev/null and b/docs/components/react-components/img/change-element.png differ diff --git a/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index a91f8d177f..6ececf915e 100644 --- a/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -91,7 +91,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: ```json title="POST /api/v1/files/search" { @@ -116,7 +116,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: ```json title="POST /api/v1/milestones/search" { @@ -226,10 +226,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -237,7 +237,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/docs/guides/getting-started-java-spring.md b/docs/guides/getting-started-java-spring.md index 19a5f89b19..f4ad27e549 100644 --- a/docs/guides/getting-started-java-spring.md +++ b/docs/guides/getting-started-java-spring.md @@ -1,15 +1,22 @@ --- id: getting-started-java-spring -title: Getting started as a Java developer using Spring -sidebar_label: Getting started as a Java developer using Spring +title: Get started as a Java developer using Spring +sidebar_label: Get started with Spring description: "Use Spring Boot and the Spring Zeebe SDK to interact with your local Self-Managed Camunda 8 installation." keywords: [java, spring, spring zeebe, getting started, user guide, tutorial] --- +import SmPrereqs from './react-components/sm-prerequisites.md' +import Install from './react-components/install-plain-java.md' + Beginner -1 hour +1 hour

    -In this guide, we'll step through using Spring Boot and the [Spring Zeebe SDK](/apis-tools/spring-zeebe-sdk/getting-started.md) with Desktop Modeler to interact with your local Self-Managed Camunda 8 installation. +:::note +This tutorial is not intended for production purposes. +::: + +In this guide, we'll step through using Spring Boot and the [Spring Zeebe SDK](/apis-tools/spring-zeebe-sdk/getting-started.md) with Desktop Modeler to interact with your local Self-Managed Camunda 8 installation. While this guide focuses on Self-Managed, you can do something similar with [SaaS](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral). By the end of this tutorial, you'll be able to use Spring and Java code with Zeebe to: @@ -21,27 +28,11 @@ For example, in this guide we will outline a BPMN model to receive a payment req ![example BPMN model to receive a payment request, prepare a transaction, charge a credit card, and execute a payment](./img/prepare-transaction-example.png) -:::note -This tutorial is not intended for production purposes. -::: - -## Prerequisites - -Before getting started, ensure you: - -- Can access your preferred code editor or IDE. -- Have Java [installed locally](https://www.java.com/en/download/). Currently, the Spring Initializr supports Java versions 17, 21, and 22. -- Have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed locally. -- Install [Desktop Modeler](https://camunda.com/download/modeler/). + ## Step 1: Install Camunda 8 Self-Managed -If you haven't already, follow [this guide](/self-managed/setup/deploy/local/docker-compose.md) to install Camunda 8 Self-Managed locally via Docker Compose: - -1. Use the `docker-compose.yaml` file in [this repository](https://github.com/camunda/camunda-platform). -2. Clone this repo and run `docker compose up -d` in your terminal to start your environment. - -To confirm Camunda 8 Self-Managed is installed, click into Docker Desktop. Here, you will see the `camunda-platform` container. Alternatively, navigate to the different components and log in with the username `demo` and password `demo`. For example, Operate can be accessed at [http://localhost:8081](http://localhost:8081) (as noted under **Port(s)** in the Docker container). Find additional guidance in the repository [README](https://github.com/camunda/camunda-platform?tab=readme-ov-file#using-docker-compose). + ## Step 2: Create a new Spring Boot project diff --git a/docs/guides/getting-started-orchestrate-apis.md b/docs/guides/getting-started-orchestrate-apis.md index e2f4cc1ade..d81b24bbaf 100644 --- a/docs/guides/getting-started-orchestrate-apis.md +++ b/docs/guides/getting-started-orchestrate-apis.md @@ -1,26 +1,33 @@ --- id: orchestrate-apis -title: Getting started with API orchestration -sidebar_label: Getting started with API orchestration +title: Get started with API orchestration +sidebar_label: Get started with API orchestration description: "Use Connectors to build low code process automation solutions" keywords: [api endpoints, orchestration, getting started, user guide, connectors] --- Beginner -Time estimate: 15 minutes +Camunda 8 SaaS only +Time estimate: 15 minutes

    import clsx from "clsx"; +import SaasPrereqs from './react-components/saas-prerequisites.md' -This guide will walk you through working with a REST Connector task as a first time Camunda 8 user. The REST Connector is a [protocol Connector](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md#protocol-connectors), where you can make a request to a REST API and use the response in the next steps of your process. +This guide will walk you through working with a REST Connector task as a first time Camunda 8 SaaS user. The REST Connector is a [protocol Connector](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md#protocol-connectors), where you can make a request to a REST API and use the response in the next steps of your process. :::note New to Connectors? Review our [introduction to Connectors](/components/connectors/introduction.md) to get familiar with their capabilities, and have a closer look at all of the available [out-of-the-box Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md). ::: +
    + Have you signed up for Camunda yet? + +
    + The concept of a Connector consists of two parts: the business logic is implemented as a job worker, and the user interface during modeling is provided using an element template. In this guide, you will create a REST Connector task in your process, handle the HTTP response, and deploy your process. New to creating a process? Get started by [modeling your first diagram](/guides/model-your-first-process.md). -## Create a REST Connector task +## Step 1: Create a REST Connector task To use a **REST Connector** in your process, follow the steps below: @@ -34,18 +41,18 @@ To use a **REST Connector** in your process, follow the steps below: 6. Add a descriptive name using the **General** section in the properties panel. For this guide, we'll use `Make a request`. -## Make your REST Connector executable +## Step 2: Make your REST Connector executable ![Connector on Web Modeler canvas with properties panel open](img/connectors-rest-red-properties.png) To make the **REST Connector** executable, fill out the mandatory **URL** field in the HTTP Endpoint section (highlighted in red) in the properties panel with `https://catfact.ninja/fact` so we can get a random cat fact from the [Cat Fact API](https://catfact.ninja/) for this example. -## Handle your response +## Step 3: Handle your response The HTTP response will be available in a temporary local response variable. This variable can be mapped to the process by specifying **Result Variable**. In the **Response Mapping** section use `={"body" : body}` as the **Result Expression** so you can see the entire JSON object returned if it's successful. -## Deploy your process +## Step 4: Deploy your process To deploy your process, take the following steps: @@ -70,7 +77,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Sign up -
    +
    ## Additional resources and next steps diff --git a/docs/guides/getting-started-orchestrate-human-tasks.md b/docs/guides/getting-started-orchestrate-human-tasks.md index 86162e819b..b9d0aef66d 100644 --- a/docs/guides/getting-started-orchestrate-human-tasks.md +++ b/docs/guides/getting-started-orchestrate-human-tasks.md @@ -1,13 +1,13 @@ --- id: orchestrate-human-tasks title: Get started with human task orchestration -sidebar_label: Getting started with human task orchestration +sidebar_label: Get started with human task orchestration description: "Efficiently allocate work through user tasks." keywords: [human tasks, orchestration, getting started, user guide] --- Beginner -Time estimate: 15 minutes +Time estimate: 15 minutes

    import ExpressionInputImg from './img/expression-input-example.png'; import FormValuesImg from './img/form-values-example.png'; @@ -22,15 +22,36 @@ import FormEditorImg from './img/form-editor.png'; import NavigationHistoryImg from './img/modeler-navigation-history.png'; import clsx from "clsx"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import SmPrereqs from './react-components/sm-prerequisites.md' +import SaasPrereqs from './react-components/saas-prerequisites.md' +import Install from './react-components/install-plain-java.md' Camunda 8 allows you to orchestrate processes with human tasks of any complexity. Utilizing user tasks, you can create and assign tasks to users. Then, users can perform their work and enter the necessary data to drive the business process. -This guide introduces you to the basics of human task orchestration. You will create a simple process to decide on dinner, and drive the process flow according to that decision. This process is entirely executable in the browser. - :::note If you prefer a video-based learning experience or a more complex example, visit [this Camunda Academy course](https://bit.ly/3PJJocB). ::: +This guide introduces you to the basics of human task orchestration. You will create a simple process to decide on dinner, and drive the process flow according to that decision. This process is entirely executable in the browser. + + + +
    + Have you installed Camunda yet? + + +
    +     + +
    + Have you signed up for Camunda yet? + +
    +     +     + Take the following five steps to create and run your first process with a human in the loop: ### Step 1: Create a new process @@ -200,7 +221,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Sign up - +
    ## Additional resources and next steps diff --git a/docs/guides/getting-started-orchestrate-microservices.md b/docs/guides/getting-started-orchestrate-microservices.md index ca631dd409..677aa5bcc1 100644 --- a/docs/guides/getting-started-orchestrate-microservices.md +++ b/docs/guides/getting-started-orchestrate-microservices.md @@ -1,16 +1,21 @@ --- id: orchestrate-microservices title: Get started with microservice orchestration -sidebar_label: Getting started with microservice orchestration +sidebar_label: Get started with microservice orchestration description: "Orchestrate Microservices along a business process for visibility and resilience." keywords: [microservices, orchestration, getting-started] --- Beginner -Time estimate: 25 minutes +Time estimate: 25 minutes

    import clsx from "clsx"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import CreateCluster from '../components/react-components/create-cluster.md'; +import SmPrereqs from './react-components/sm-prerequisites.md' +import SaasPrereqs from './react-components/saas-prerequisites.md' +import Install from './react-components/install-plain-java.md' Using Camunda 8, you can orchestrate the microservices necessary to achieve your end-to-end automated business process. Whether you have existing microservices or are looking to build out your microservices, this guide will help you understand how you can start your microservice orchestration journey with Camunda 8. @@ -18,13 +23,32 @@ While this guide uses code snippets in Java, you do not need to be a Java develo ## Prerequisites -- Ensure you have a valid [Camunda 8 account](create-account.md), or sign up if you still need one. +You must have access to either a local or remote Camunda Self-Managed installation or a SaaS account. + + + +
    + Have you installed Camunda yet? + + +
    +     + +
    + Have you signed up for Camunda yet? + +
    +     +     + +Additionally, you need the following: + - Java >= 8 - Maven - IDE (IntelliJ, VSCode, or similar) - Download and unzip or clone the [repo](https://github.com/camunda/camunda-platform-tutorials), then `cd` into `camunda-platform-tutorials/orchestrate-microservices/worker-java` -### Design your process with BPMN +## Step 1: Design your process with BPMN Start by designing your automated process using BPMN. This guide introduces you to the palette and a few BPMN symbols in Web Modeler. @@ -43,11 +67,11 @@ Start by designing your automated process using BPMN. This guide introduces you 9. Start a new process instance by clicking on the blue **Run** button. 10. In the top left corner of the screen, click the square-shaped **Camunda components** button. Navigate to Operate to see your process instance with a token waiting at the service task by clicking **View process instances**. -### Create a cluster +## Step 2: Create a cluster -### Create credentials for your Zeebe client +## Step 3: Create credentials for your Zeebe client To interact with your Camunda 8 cluster, you'll use the Zeebe client. First, you'll need to create credentials. @@ -59,7 +83,7 @@ To interact with your Camunda 8 cluster, you'll use the Zeebe client. First, you 3. Provide a descriptive name for your client like `microservice-worker`. For this tutorial, the scope can be the default Zeebe scope. Click **Create**. 4. Your client credentials can be copied or downloaded at this point. You will need your client id and your client secret when creating a worker in the next section, so keep this window open. Once you close or navigate away from this screen, you will not be able to see them again. -### Create a worker for the service task +## Step 4: Create a worker for the service task Next, we’ll create a worker for the service task by associating it with the type we specified on the service task in the BPMN diagram. @@ -82,7 +106,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Sign up - +
    ## Additional resources and next steps diff --git a/docs/guides/migrating-from-cawemo.md b/docs/guides/migrating-from-cawemo.md index 11d4c4330c..a12205fe87 100644 --- a/docs/guides/migrating-from-cawemo.md +++ b/docs/guides/migrating-from-cawemo.md @@ -29,7 +29,7 @@ Data access and transition deadline: This means that you have until the 30th of We understand that change can be challenging, and our team is dedicated to ensuring a smooth transition for you and your organization. For any queries or support during this transition phase, reach out to your account team. ::: -This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.cloud.camunda.io/). +This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.camunda.io/). You should consider migrating diagrams from Cawemo to Camunda 8 Web Modeler if: diff --git a/docs/guides/model-your-first-process.md b/docs/guides/model-your-first-process.md index 5c56801cd8..ebc25bfb98 100644 --- a/docs/guides/model-your-first-process.md +++ b/docs/guides/model-your-first-process.md @@ -4,8 +4,15 @@ title: Model your first process description: "Use Modeler to design and deploy a process." --- +import SaasPrereqs from './react-components/saas-prerequisites.md' + Beginner -Time estimate: 15 minutes +Time estimate: 15 minutes

    + +
    + Have you signed up for Camunda yet? + +
    ## Design and deploy a process diff --git a/docs/guides/react-components/install-docker-compose.md b/docs/guides/react-components/install-docker-compose.md new file mode 100644 index 0000000000..fb619be310 --- /dev/null +++ b/docs/guides/react-components/install-docker-compose.md @@ -0,0 +1,11 @@ +--- +--- + +## Step 1: Install Camunda 8 Self-Managed + +If you haven't already, follow [this guide](/self-managed/setup/deploy/local/docker-compose.md) to install Camunda 8 Self-Managed locally via Docker Compose: + +1. Use the `docker-compose.yaml` file in [this repository](https://github.com/camunda/camunda-platform). +2. Clone this repo and run `docker compose up -d` in your terminal to start your environment. + +To confirm Camunda 8 Self-Managed is installed, click into Docker Desktop. Here, you will see the `camunda-platform` container. Alternatively, navigate to the different components and log in with the username `demo` and password `demo`. For example, Operate can be accessed at [http://localhost:8081](http://localhost:8081) (as noted under **Port(s)** in the Docker container). Find additional guidance in the repository [README](https://github.com/camunda/camunda-platform?tab=readme-ov-file#using-docker-compose). diff --git a/docs/guides/react-components/install-plain-java.md b/docs/guides/react-components/install-plain-java.md new file mode 100644 index 0000000000..a52ddf9a64 --- /dev/null +++ b/docs/guides/react-components/install-plain-java.md @@ -0,0 +1,15 @@ +--- +--- + +**Starting in 8.6.0-alpha2**, you can install Camunda 8 Self-Managed as an integrated plain Java application. + +For this installation, you must have: + +- OpenJDK 21+ locally installed +- Camunda `8.6.0-alpha2` or later + +1. Download the [latest release artifact](https://github.com/camunda/camunda/releases), starting with [8.6.0-alpha2](https://github.com/camunda/camunda/releases/tag/8.6.0-alpha2). +2. Download [Elasticsearch 8.9.2](https://www.elastic.co/downloads/past-releases/elasticsearch-8-9-2). +3. For non-production cases, disable Elasticsearch's security packages by setting the `xpack.security.*` configuration options to `false` in `ELASTICSEARCH_HOME/config/elasticsearch.yml`. +4. Start Elasticsearch by running `ELASTICSEARCH_HOME/bin/elasticsearch` (or `ELASTICSEARCH_HOME\bin\elasticsearch.bat` on Windows). +5. To start Camunda, run `bin/camunda` (or `bin\camunda.bat` on Windows). diff --git a/docs/guides/react-components/saas-prerequisites.md b/docs/guides/react-components/saas-prerequisites.md new file mode 100644 index 0000000000..7df714f7ad --- /dev/null +++ b/docs/guides/react-components/saas-prerequisites.md @@ -0,0 +1,22 @@ +--- +--- + +## Sign Up + +Visit [camunda.io/signup](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral) to sign up. + +### Create an account + +Fill out the form and click **Create account**. + +When you fill out the form, you'll receive a confirmation email. Click on the link to verify your email address. + +## Log in to your Camunda 8 account + +Log in with the email address and password you used in the previous form, or use the social login buttons. To access the login site directly, navigate to [camunda.io](https://weblogin.cloud.camunda.io/). + +![login](./../img/login.png) + +After login, select the square-shaped **Camunda components** icon in the upper-left corner, and select **Console** to view the Console overview page. This is the central place to manage the clusters, diagrams, and forms you want to deploy to Camunda 8. + +![overview-home](./../img/home.png) diff --git a/docs/guides/react-components/sm-prerequisites.md b/docs/guides/react-components/sm-prerequisites.md new file mode 100644 index 0000000000..aa374b7cb4 --- /dev/null +++ b/docs/guides/react-components/sm-prerequisites.md @@ -0,0 +1,9 @@ +--- +--- + +## Prerequisites + +Before getting started, ensure you: + +- Can access your preferred code editor or IDE. +- Install [Desktop Modeler](https://camunda.com/download/modeler/). diff --git a/docs/guides/setup-client-connection-credentials.md b/docs/guides/setup-client-connection-credentials.md index 73662335c6..00200bdc22 100644 --- a/docs/guides/setup-client-connection-credentials.md +++ b/docs/guides/setup-client-connection-credentials.md @@ -21,7 +21,7 @@ Currently, Camunda 8 SaaS supports the following scopes: To create a new client, take the following steps: -1. Navigate to the API tab [in Camunda Console](https://console.cloud.camunda.io/) by clicking **Clusters > Cluster name > API**. +1. Navigate to the API tab [in Camunda Console](https://console.camunda.io/) by clicking **Clusters > Cluster name > API**. ![cluster-details](../components/console/manage-clusters/img/cluster-detail-clients.png) 2. Click **Create your first client** to create a new client and name your client accordingly. 3. Determine the scoped access for client credentials. Select **Zeebe client** so the newly-created client can access your Zeebe instance. diff --git a/versioned_docs/version-8.5/guides/help-center.md b/docs/reference/help-center.md similarity index 95% rename from versioned_docs/version-8.5/guides/help-center.md rename to docs/reference/help-center.md index d89e9ab4a2..c7d7871006 100644 --- a/versioned_docs/version-8.5/guides/help-center.md +++ b/docs/reference/help-center.md @@ -3,12 +3,10 @@ id: camunda-help-center title: Access the Camunda Help Center sidebar_label: Access the Camunda Help Center description: "Get recommendations for additional learning, step through the automation project guide, have a closer look at various use cases, access Camunda Academy, share feedback, and more." -keywords: [getting-started, help-center, help, support] +keywords: [help-center, help, support] --- -Beginner Camunda 8 SaaS only -Time estimate: 10 minutes Camunda 8 SaaS offers a Help Center to all users, where you can access additional documentation, step through various use cases in Camunda, share your feedback, and more. diff --git a/docs/guides/img/automation-project-guide.png b/docs/reference/img/automation-project-guide.png similarity index 100% rename from docs/guides/img/automation-project-guide.png rename to docs/reference/img/automation-project-guide.png diff --git a/docs/guides/img/open-help-center.png b/docs/reference/img/open-help-center.png similarity index 100% rename from docs/guides/img/open-help-center.png rename to docs/reference/img/open-help-center.png diff --git a/docs/reference/release-notes/860.md b/docs/reference/release-notes/860.md index 015f604d62..5fedc77e73 100644 --- a/docs/reference/release-notes/860.md +++ b/docs/reference/release-notes/860.md @@ -17,6 +17,40 @@ keywords: | ---------------------- | ---------------------------- | ------------ | ------------ | | 8 October 2024 | 14 April 2026 | | | +## 8.6.0-alpha3 + +| Release date | Changelog(s) | | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| 02 July 2024 | - [ Camunda 8 core ](https://github.com/camunda/zeebe/releases/tag/8.6.0-alpha3)
    - [ Connectors ](https://github.com/camunda/connectors/releases/tag/8.6.0-alpha3) | [Release blog](https://camunda.com/blog/2024/07/camunda-alpha-release-july-2024/) | + +### Encrypted inter-component communication for Web Modeler + + + +You can now [enable TLS-encrypted communication](/self-managed/modeler/web-modeler/configuration/ssl.md) between Web Modeler, the REST API, and websockets. + +### API orchestration getting started journey + + + +New platform users interested in orchestrating API endpoints now have a high-level in-product explanation of Camunda's Connector functionality. + +### Remove "Cloud" as a user-facing term + + + +"Cloud" has been removed from the URLs in SaaS versions of Modeler and Console for conciseness. + +### Incident Copilot Alpha + + + +Let AI teach you how to prevent and fix the incidents you run into while playing your process. + +- Auto-generated prompt including incident information +- Advice on how to update your model to prevent issues while developing +- An open conversation to continue asking more questions + ## 8.6.0-alpha2 | Release date | Changelog(s) | | @@ -25,6 +59,8 @@ keywords: ### API orchestration getting started journey + + The Help Center now features a step-by-step guide to complete the [API orchestration tutorial](/guides/getting-started-orchestrate-apis.md). To use this guide, you must have cookies enabled. ### Message queue inbound Connectors message acknowledgement configuration diff --git a/docs/self-managed/console-deployment/configuration.md b/docs/self-managed/console-deployment/configuration.md index d686ed8a3d..c70ee053b6 100644 --- a/docs/self-managed/console-deployment/configuration.md +++ b/docs/self-managed/console-deployment/configuration.md @@ -9,7 +9,11 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console). ::: -Console Self-Managed can be configured using environment variables and configuration parameters: +Console Self-Managed can be configured using environment variables and configuration parameters. + +:::note +Underscores in environment variables correspond to configuration file key levels. +::: ## Environment variables diff --git a/docs/self-managed/identity/deployment/configuration-variables.md b/docs/self-managed/identity/deployment/configuration-variables.md index cd1bee3c61..2cb55c61c3 100644 --- a/docs/self-managed/identity/deployment/configuration-variables.md +++ b/docs/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ## Core configuration diff --git a/docs/self-managed/operate-deployment/operate-configuration.md b/docs/self-managed/operate-deployment/operate-configuration.md index 461d72ee69..031934f332 100644 --- a/docs/self-managed/operate-deployment/operate-configuration.md +++ b/docs/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/docs/self-managed/operational-guides/update-guide/840-to-850.md b/docs/self-managed/operational-guides/update-guide/840-to-850.md index 92ba082e8d..864a994ddd 100644 --- a/docs/self-managed/operational-guides/update-guide/840-to-850.md +++ b/docs/self-managed/operational-guides/update-guide/840-to-850.md @@ -21,6 +21,12 @@ Follow the [upgrade instructions](/self-managed/setup/upgrade.md#helm-chart-1002 ## Zeebe +:::caution +There is a [bug](https://github.com/camunda/camunda/issues/19984) in Zeebe 8.5.4 which incorrectly flags snapshots as corrupted even when they're not. This can cause reduced availability as nodes fail to start correctly. As such, **you should skip 8.5.4 and update directly from 8.5.3 to 8.5.5, or immediately to 8.5.5 if you're already on 8.5.4.** + +Note that there is **no** actual corruption or data loss, however. +::: + ### Deprecated broker health checks The broker health check routes have moved, and the old routes are now deprecated. Specifically, the following routes will return [a status code of 301](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) and redirect you. See the table below about the new mappings: diff --git a/docs/self-managed/tasklist-deployment/tasklist-configuration.md b/docs/self-managed/tasklist-deployment/tasklist-configuration.md index 3b5968b248..d33c9aef12 100644 --- a/docs/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/docs/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/docs/self-managed/zeebe-deployment/configuration/configuration.md b/docs/self-managed/zeebe-deployment/configuration/configuration.md index 0c75f4c652..d8a9135b11 100644 --- a/docs/self-managed/zeebe-deployment/configuration/configuration.md +++ b/docs/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/docs/self-managed/zeebe-deployment/configuration/environment-variables.md b/docs/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/docs/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/docs/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/docusaurus.config.js b/docusaurus.config.js index 9b5424c6a1..395878e206 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -247,6 +247,10 @@ module.exports = { label: "How to use our docs", to: "meta", }, + { + label: "Camunda Help Center", + to: "docs/reference/camunda-help-center", + }, { label: "Try free", href: "https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral&utm_content=footer", diff --git a/sidebars.js b/sidebars.js index 052a11e4d9..f10cf26696 100644 --- a/sidebars.js +++ b/sidebars.js @@ -8,16 +8,18 @@ function optimizeLink(label, href) { module.exports = { Guides: [ + "guides/introduction-to-camunda", { "Get started": [ - "guides/introduction-to-camunda", - "guides/create-account", - "guides/camunda-help-center", - "guides/model-your-first-process", - "guides/orchestrate-human-tasks", - "guides/orchestrate-apis", - "guides/orchestrate-microservices", "guides/getting-started-java-spring", + "guides/model-your-first-process", + { + "By use case": [ + "guides/orchestrate-human-tasks", + "guides/orchestrate-apis", + "guides/orchestrate-microservices", + ], + }, ], }, { @@ -850,10 +852,11 @@ module.exports = { }, items: ["reference/release-notes/860", "reference/release-notes/850"], }, - "reference/auto-updates", - "reference/status", "reference/supported-environments", "reference/dependencies", + "reference/camunda-help-center", + "reference/auto-updates", + "reference/status", "reference/alpha-features", "reference/licenses", "reference/notices", diff --git a/src/pages/meta.md b/src/pages/meta.md index c1eb6df61c..61aca20c81 100644 --- a/src/pages/meta.md +++ b/src/pages/meta.md @@ -3,7 +3,9 @@ title: How to use the docs description: Learn how Camunda 8 docs are structured and what you can expect when using the docs --- -# How to use the docs +::: +Our docs are changing! You will see more SaaS and Self-Managed content side-by-side, starting with our Guides section. +::: [docs.camunda.io](https://docs.camunda.io) is home to the Camunda 8 docs, including all of the components. diff --git a/static/.htaccess b/static/.htaccess index 9ddc65d942..aa85e90af0 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -6,6 +6,10 @@ RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L] # Disable directory listing and multi views Options -Indexes -MultiViews +# Move Help Center +RewriteRule ^docs/guides/camunda-help-center/(.*)$ /docs/reference/camunda-help-center/$1 [R=301,L] +RewriteRule ^docs/8.5/guides/camunda-help-center/(.*)$ /docs/8.5/reference/camunda-help-center/$1 [R=301,L] + # Removing telemetry page RewriteRule ^optimize/self-managed/optimize-deployment/configuration/telemetry/(.*)$ /optimize/self-managed/optimize-deployment/configuration/getting-started/$1 [R=301,L] diff --git a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md index c3637a7eb4..3e79dc0633 100644 --- a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.2/apis-tools/web-modeler-api/index.md b/versioned_docs/version-8.2/apis-tools/web-modeler-api/index.md index f15ee7d043..cbab5b5771 100644 --- a/versioned_docs/version-8.2/apis-tools/web-modeler-api/index.md +++ b/versioned_docs/version-8.2/apis-tools/web-modeler-api/index.md @@ -19,7 +19,7 @@ Web Modeler provides a REST API at `/api/*`. Clients can access this API by pass ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. @@ -86,7 +86,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/versioned_docs/version-8.2/components/connectors/protocol/rest.md b/versioned_docs/version-8.2/components/connectors/protocol/rest.md index aba75cf00e..5683db47a4 100644 --- a/versioned_docs/version-8.2/components/connectors/protocol/rest.md +++ b/versioned_docs/version-8.2/components/connectors/protocol/rest.md @@ -140,7 +140,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-context-expressions.md b/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-context-expressions.md index e751e83e4c..b0a010c469 100644 --- a/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-context-expressions.md +++ b/versioned_docs/version-8.2/components/modeler/feel/language-guide/feel-context-expressions.md @@ -95,7 +95,7 @@ While filtering, the entries of the current context element can be accessed by t b: 10 } ][b > 7] -// {a: "p2", b: 10} +// [{a: "p2", b: 10}] ``` ### Projection diff --git a/versioned_docs/version-8.2/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/versioned_docs/version-8.2/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index 98d6c15d39..94f6432256 100644 --- a/versioned_docs/version-8.2/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/versioned_docs/version-8.2/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -30,7 +30,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -168,7 +168,7 @@ Use milestones to indicate a state for review. Use the `POST /api/beta/milestone While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/beta/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/beta/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) available from Web Modeler 8.3, utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/beta/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/beta/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) available from Web Modeler 8.3, utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/versioned_docs/version-8.2/guides/getting-started-orchestrate-apis.md b/versioned_docs/version-8.2/guides/getting-started-orchestrate-apis.md index 21450b66e5..30a1c00ac1 100644 --- a/versioned_docs/version-8.2/guides/getting-started-orchestrate-apis.md +++ b/versioned_docs/version-8.2/guides/getting-started-orchestrate-apis.md @@ -72,7 +72,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Beginner Time estimate: 5 minutes -This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.cloud.camunda.io/). +This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.camunda.io/). You should consider migrating diagrams from Cawemo to Camunda 8 Web Modeler if: diff --git a/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md index e3805c2153..0867feda5d 100644 --- a/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ### Core configuration diff --git a/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md index 921171062e..b7c9c34673 100644 --- a/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md index 63aa3d2676..844632fdcd 100644 --- a/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: - [Webserver](#webserver) - [Elasticsearch](#elasticsearch) diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md index b0f0a60328..1975595de9 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md @@ -87,7 +87,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md b/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md index e567c9801b..10cf76e737 100644 --- a/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md +++ b/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md @@ -11,7 +11,7 @@ Web Modeler provides a REST API at `/api/*`. Clients can access this API by pass ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. @@ -78,7 +78,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/versioned_docs/version-8.3/components/connectors/protocol/rest.md b/versioned_docs/version-8.3/components/connectors/protocol/rest.md index aba75cf00e..5683db47a4 100644 --- a/versioned_docs/version-8.3/components/connectors/protocol/rest.md +++ b/versioned_docs/version-8.3/components/connectors/protocol/rest.md @@ -140,7 +140,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-context-expressions.md b/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-context-expressions.md index 9b37f3d2b0..8e6a232f1d 100644 --- a/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-context-expressions.md +++ b/versioned_docs/version-8.3/components/modeler/feel/language-guide/feel-context-expressions.md @@ -102,7 +102,7 @@ accessed by their key. b: 10 } ][b > 7] -// {a: "p2", b: 10} +// [{a: "p2", b: 10}] ``` ### Projection diff --git a/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index 2fb6b71536..0861c59074 100644 --- a/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -78,7 +78,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with this payload to identify recently updated files: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with this payload to identify recently updated files: ```json title="POST /api/v1/files/search" { @@ -91,7 +91,7 @@ To listen to changes in Web Modeler, you currently need to implement a polling a } ``` -For real-time synchronization, employ a polling approach comparing update dates with last sync dates. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to discover recently updated files, and compare the `updated` date with your last sync date: +For real-time synchronization, employ a polling approach comparing update dates with last sync dates. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to discover recently updated files, and compare the `updated` date with your last sync date: ```json title="POST /api/v1/files/search" { @@ -115,7 +115,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to find recently created milestones: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to find recently created milestones: ```json title="POST /api/v1/milestones/search" { @@ -143,7 +143,7 @@ You will receive a response similar to this, where the `fileId` indicates the fi } ``` -You have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) and compare the `created` date with your last sync date to identify recent additions: +You have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) and compare the `created` date with your last sync date to identify recent additions: ```json title="POST /api/v1/milestones/search" { @@ -237,10 +237,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -248,7 +248,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md b/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md index 0723de2149..05674c62a1 100644 --- a/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md +++ b/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md @@ -70,7 +70,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Beginner Time estimate: 5 minutes -This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.cloud.camunda.io/). +This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.camunda.io/). You should consider migrating diagrams from Cawemo to Camunda 8 Web Modeler if: diff --git a/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md index 85015e5876..104b764749 100644 --- a/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ## Core configuration diff --git a/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md index ad692ea747..34a2631711 100644 --- a/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md index 4e5a24b7cd..c6425b50fc 100644 --- a/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md index b0f0a60328..1975595de9 100644 --- a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md @@ -87,7 +87,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.4/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx b/versioned_docs/version-8.4/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx index 8ef7ab01d2..689a774a8b 100644 --- a/versioned_docs/version-8.4/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx +++ b/versioned_docs/version-8.4/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx @@ -66,13 +66,9 @@ On success returned.
    Schema
    • Array [
      • variables object[]
      -An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`. +An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. -
    • Array [
      • draft object
      - -The draft value of the variable. - -
    • ]
    • ]
    +
  • Array [
  • ]
  • ]
    • An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request diff --git a/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md b/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md index 388f3f494b..2182aee180 100644 --- a/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md +++ b/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md @@ -70,7 +70,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md b/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md index 3b54b0b387..c31d747c98 100644 --- a/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md +++ b/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md @@ -14,7 +14,7 @@ Ensure you [authenticate](./authentication.md) before accessing the Web Modeler ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. diff --git a/versioned_docs/version-8.4/components/connectors/protocol/rest.md b/versioned_docs/version-8.4/components/connectors/protocol/rest.md index aba75cf00e..5683db47a4 100644 --- a/versioned_docs/version-8.4/components/connectors/protocol/rest.md +++ b/versioned_docs/version-8.4/components/connectors/protocol/rest.md @@ -140,7 +140,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-context-expressions.md b/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-context-expressions.md index 9b37f3d2b0..8e6a232f1d 100644 --- a/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-context-expressions.md +++ b/versioned_docs/version-8.4/components/modeler/feel/language-guide/feel-context-expressions.md @@ -102,7 +102,7 @@ accessed by their key. b: 10 } ][b > 7] -// {a: "p2", b: 10} +// [{a: "p2", b: 10}] ``` ### Projection diff --git a/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index 3710d57afd..441122296f 100644 --- a/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -85,7 +85,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: ```json title="POST /api/v1/files/search" { @@ -110,7 +110,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: ```json title="POST /api/v1/milestones/search" { @@ -220,10 +220,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -231,7 +231,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md b/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md index 0723de2149..05674c62a1 100644 --- a/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md +++ b/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md @@ -70,7 +70,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8
    Schema
    • Array [
      • variables object[]
      -An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`. +An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. -
    • Array [
      • draft object
      - -The draft value of the variable. - -
    • ]
    • ]
    +
  • Array [
  • ]
  • ]
    • An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request diff --git a/versioned_docs/version-8.5/apis-tools/web-modeler-api/authentication.md b/versioned_docs/version-8.5/apis-tools/web-modeler-api/authentication.md index 388f3f494b..2182aee180 100644 --- a/versioned_docs/version-8.5/apis-tools/web-modeler-api/authentication.md +++ b/versioned_docs/version-8.5/apis-tools/web-modeler-api/authentication.md @@ -70,7 +70,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/versioned_docs/version-8.5/apis-tools/web-modeler-api/index.md b/versioned_docs/version-8.5/apis-tools/web-modeler-api/index.md index 0bad442767..7652789df9 100644 --- a/versioned_docs/version-8.5/apis-tools/web-modeler-api/index.md +++ b/versioned_docs/version-8.5/apis-tools/web-modeler-api/index.md @@ -14,7 +14,7 @@ Ensure you [authenticate](./authentication.md) before accessing the Web Modeler ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md index c1d48ba11f..d02a79c4f9 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md @@ -17,7 +17,9 @@ Use Camunda secrets to store credentials so you don't expose sensitive informati ## Create an Amazon DynamoDB Connector task -To use the **Amazon DynamoDB Connector** in your process, either change the type of existing task by clicking on it and using the **wrench-shaped** change type context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon DynamoDB Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md index 17d9e7c20a..9bc8ca591f 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md @@ -30,7 +30,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an Amazon EventBridge Connector task -To use the **Amazon EventBridge Connector** in your process, you can either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Refer to our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Configure the Amazon EventBridge Connector diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sns.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sns.md index 76cd1bce74..7966cb392f 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sns.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sns.md @@ -28,7 +28,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an Amazon SNS Connector task -To use the **Amazon SNS Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon SNS Connector for sending messages executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sqs.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sqs.md index 5236e0a314..69fac0fec3 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sqs.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/amazon-sqs.md @@ -30,7 +30,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an Amazon SQS Connector task -To use the **Amazon SQS Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Amazon SQS Connector for sending messages executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/asana.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/asana.md index f9917b940a..dc8eedb499 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/asana.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/asana.md @@ -17,9 +17,9 @@ Use Camunda secrets to avoid exposing your Asana personal access token as plain ## Create an Asana Connector task -To use the **Asana Connector** in your process, either change the type of existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/automation-anywhere.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/automation-anywhere.md index 460831c94a..d54c9eea77 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/automation-anywhere.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/automation-anywhere.md @@ -12,7 +12,9 @@ You also need a user account with the `AAE_Queue Admin` role to query and manage ## Create an Automation Anywhere Connector task -To use an **Automation Anywhere Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Automation Anywhere Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/aws-lambda.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/aws-lambda.md index 96d7579960..cd278278c1 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/aws-lambda.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/aws-lambda.md @@ -16,7 +16,9 @@ Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Re ## Create an AWS Lambda Connector task -To use an **AWS Lambda Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Invoking your AWS Lambda function diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/azure-open-ai.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/azure-open-ai.md index fd84f19671..2f8f47fd3c 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/azure-open-ai.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/azure-open-ai.md @@ -25,7 +25,9 @@ Learn more at the [official Azure OpenAI portal entry](https://learn.microsoft.c ## Create an Azure OpenAI Connector task -To use the **Azure OpenAI Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Azure OpenAI Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/blueprism.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/blueprism.md index 1ed20e4fb2..3915348359 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/blueprism.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/blueprism.md @@ -10,7 +10,9 @@ To start using the Connector, you must have a running Blue Prism instance config ## Create a Blue Prism Connector task -To use a **Blue Prism Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](../use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/easy-post.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/easy-post.md index 8812b3ab34..63be8312ce 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/easy-post.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/easy-post.md @@ -17,7 +17,9 @@ Use Camunda secrets to avoid exposing your EasyPost API key as plain text. Refer ## Create an EasyPost Connector task -To use the **EasyPost Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/github.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/github.md index e5bb5d3d88..e6734c5eca 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/github.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/github.md @@ -29,7 +29,9 @@ Refer to our documentation on [managing secrets](/components/console/manage-clus ## Create a GitHub Connector task -To use the **GitHub Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/gitlab.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/gitlab.md index ecd8f5e079..986e6fcbbc 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/gitlab.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/gitlab.md @@ -18,7 +18,9 @@ Use Camunda secrets to avoid exposing your GitLab access token credentials as pl ## Create a GitLab Connector task -To use the **GitLab Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Add endpoint and authentication diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-maps-platform.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-maps-platform.md index eb2b789c67..e4c2c56e76 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-maps-platform.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-maps-platform.md @@ -9,7 +9,9 @@ The **Google Maps Platform Connector** in an inbound Connector that allows you t ## Create a Google Maps Platform Connector task -To use a **Google Maps Platform Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Google Maps Platform Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-sheets.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-sheets.md index 385cd257bf..fabe161b17 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-sheets.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/google-sheets.md @@ -30,8 +30,9 @@ Currently, the Google Sheets Connector supports next operations: - [Get spreadsheet details](#get-spreadsheet-details) - [Get worksheet data](#get-worksheet-data) -To use a **Google Sheets Connector** in your process, either change the type of existing task by clicking on it and -using the wrench-shaped **Change type** context menu icon or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Google Sheets Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/googledrive.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/googledrive.md index 6d987bc67c..66ac5a9ceb 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/googledrive.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/googledrive.md @@ -14,7 +14,9 @@ To start working with the **Google Drive Connector**, a relevant OAuth token mus Currently, the Google Drive Connector supports two types of operations: create a folder and create a file from a template. -To use a **Google Drive Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Google Drive Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/hugging-face.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/hugging-face.md index 8382248bcd..3089b51f19 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/hugging-face.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/hugging-face.md @@ -16,9 +16,9 @@ and a model deployed with [Inference API](https://huggingface.co/docs/api-infere ## Create a Hugging Face Connector task -To use the **Hugging Face Connector** in your process, either change the type of existing task by clicking on it -and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the -**Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Hugging Face Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/kafka.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/kafka.md index 518c2647e7..78796fc4e3 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/kafka.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/kafka.md @@ -25,7 +25,9 @@ Use Camunda secrets to avoid exposing your sensitive data as plain text. Follow ## Create a Kafka Producer Connector task -To use the **Kafka Producer Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Kafka Producer Connector for publishing messages executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md index 5e63d0e264..9d6c35ae08 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md @@ -22,7 +22,9 @@ Refer to our documentation on [managing secrets](/components/console/manage-clus ## Create a Microsoft 365 Connector task -To use the **Microsoft 365 Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Access control diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-teams.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-teams.md index 02538d6c2a..3d3163203b 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-teams.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/microsoft-teams.md @@ -22,8 +22,9 @@ Use Camunda secrets to store credentials so you don't expose sensitive informati ## Create a Microsoft Teams Connector task -To use the **Microsoft Teams Connector** in your process, either change the type of existing task by clicking on it and -using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Microsoft Teams Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/openai.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/openai.md index 4aec79dfb3..9854697172 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/openai.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/openai.md @@ -20,7 +20,9 @@ Use Camunda secrets to avoid exposing your sensitive data, such as your OpenAI A ## Create an OpenAI Connector task -To use the **OpenAI Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your OpenAI Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/operate.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/operate.md index ac9fd92176..c917e9505e 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/operate.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/operate.md @@ -28,8 +28,9 @@ Use Camunda secrets to store credentials so you don't expose sensitive informati ## Create an Operate Connector task -To use the **Operate Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Enter your cluster information diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md index bbe23df77f..e7776e1f94 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md @@ -29,9 +29,9 @@ Ensure you enter the correct exchange name and routing key, as the **RabbitMQ Co ## Create a RabbitMQ Connector task -To use the **RabbitMQ Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. +import ConnectorTask from '../../../components/react-components/connector-task.md' -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. + ## Connecting to RabbitMQ and sending messages @@ -135,7 +135,13 @@ Using Camunda secrets to store credentials is recommended so you do not expose s ## Create a RabbitMQ Connector event -To use the **RabbitMQ Consumer Connector** in your process, either change the type of existing event by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector event using the **Append Connector** context menu. Follow our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +See [create a RabbitMQ Connector task](#create-a-rabbitmq-connector-task) for additional details. + +1. Add a **Start Event** or an **Intermediate Event** to your BPMN diagram to get started. +2. Change its template to a RabbitMQ Connector. +3. Fill in all required properties. +4. Complete your BPMN diagram. +5. Deploy the diagram to activate the RabbitMQ consumer. ## Create a RabbitMQ Consumer Connector task diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/salesforce.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/salesforce.md index 8280e40521..75f0f1dd4c 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/salesforce.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/salesforce.md @@ -16,9 +16,9 @@ Use Camunda secrets to avoid exposing your _Salesforce Connected App_ client ID ## Create a Salesforce Connector task -To use the **Salesforce Connector** in your process, either change the type of existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Instance diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/sendgrid.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/sendgrid.md index 00ad071a92..28ea9c2424 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/sendgrid.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/sendgrid.md @@ -21,7 +21,9 @@ The SendGrid Connector comes with two options: #### Create a SendGrid Email Connector Task -To use a **SendGrid Connector** in your process, either change the type of an existing task to **SendGrid: Send Email** using the wrench-shaped **Change type** context menu, or create a new **SendGrid: Send Email** Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + #### Make your SendGrid Email Connector executable @@ -81,7 +83,7 @@ While you are editing your template, you can test how your email would look by s #### Create a SendGrid Email template Connector task -To use this **SendGrid Connector** in your process, either change the type of an existing task to **SendGrid: Send Email via Template** using the wrench-shaped **Change type** context menu, or create a new **SendGrid: Send Email via Template** Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +See [create a SendGrid email Connector task](#create-a-sendgrid-email-connector-task) for additional details. #### Make your SendGrid Email Template Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/slack.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/slack.md index d8d35991a2..dc53e84c5d 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/slack.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/slack.md @@ -23,7 +23,9 @@ To use the Slack Connector, a Slack app must be registered with the Slack worksp ## Create a Slack Connector task -To use a **Slack Connector** in your process, either change the type of an existing task by clicking on it and using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Slack Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/twilio.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/twilio.md index aab4a0887e..902e739f9e 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/twilio.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/twilio.md @@ -28,7 +28,9 @@ Use Camunda secrets to store your account SID and auth token so you don't expose ## Create a Twilio Connector task -To use the Twilio Connector in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. Follow our [guide to using Connectors](https://docs.camunda.org/manual/latest/user-guide/process-engine/connectors/) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your Twilio Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/uipath.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/uipath.md index e144e17d6e..ce7f253622 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/uipath.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/uipath.md @@ -12,7 +12,9 @@ To use the **UiPath Connector**, you need to have a [UiPath](https://cloud.uipat ## Create a UiPath Connector task -To use a **UiPath Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Operation types diff --git a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/whatsapp.md b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/whatsapp.md index ecab54ff85..f99c1e2c78 100644 --- a/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/whatsapp.md +++ b/versioned_docs/version-8.5/components/connectors/out-of-the-box-connectors/whatsapp.md @@ -17,9 +17,9 @@ WhatsApp webhooks are currently not supported by Camunda. ## Create a WhatsApp Connector task -To use the **WhatsApp Connector** in your process, either change the type of existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Authentication diff --git a/versioned_docs/version-8.5/components/connectors/protocol/graphql.md b/versioned_docs/version-8.5/components/connectors/protocol/graphql.md index 94ae3d77b5..82c2e2758e 100644 --- a/versioned_docs/version-8.5/components/connectors/protocol/graphql.md +++ b/versioned_docs/version-8.5/components/connectors/protocol/graphql.md @@ -13,7 +13,9 @@ The GraphQL Connector allows you to connect to a GraphQL API endpoint. To use th ## Create a GraphQL Connector task -To use a **GraphQL Connector** in your process, either change the type of existing task by clicking on it and using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your GraphQL Connector executable diff --git a/versioned_docs/version-8.5/components/connectors/protocol/rest.md b/versioned_docs/version-8.5/components/connectors/protocol/rest.md index aba75cf00e..4a2b159f3b 100644 --- a/versioned_docs/version-8.5/components/connectors/protocol/rest.md +++ b/versioned_docs/version-8.5/components/connectors/protocol/rest.md @@ -15,7 +15,9 @@ The **REST Connector** is an outbound protocol Connector that allows you to make ## Create a REST Connector task -To use a **REST Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task by using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Make your REST Connector executable @@ -140,7 +142,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/versioned_docs/version-8.5/components/connectors/protocol/soap.md b/versioned_docs/version-8.5/components/connectors/protocol/soap.md index ca309ee9d9..9d3239bd95 100644 --- a/versioned_docs/version-8.5/components/connectors/protocol/soap.md +++ b/versioned_docs/version-8.5/components/connectors/protocol/soap.md @@ -21,9 +21,9 @@ To use the **SOAP Connector**, ensure you have an active SOAP service. ## Create a SOAP Connector task -To use the **SOAP Connector** in your process, either change the type of an existing task by clicking on it and using -the wrench-shaped **Change type** context menu icon, or create a new Connector task by using the **Append Connector** context menu. -Follow our [guide to using Connectors](/components/connectors/use-connectors/index.md) to learn more. +import ConnectorTask from '../../../components/react-components/connector-task.md' + + ## Connection diff --git a/versioned_docs/version-8.5/components/console/manage-clusters/manage-alerts.md b/versioned_docs/version-8.5/components/console/manage-clusters/manage-alerts.md index 3c880bcedb..c5c9e983ce 100644 --- a/versioned_docs/version-8.5/components/console/manage-clusters/manage-alerts.md +++ b/versioned_docs/version-8.5/components/console/manage-clusters/manage-alerts.md @@ -41,11 +41,11 @@ Webhook alerts contain a JSON body with following structure: { "clusterName": "cluster-name", "clusterId": "88d32bfc-4f8e-4dd3-9ae2-adfee281e223", - "operateBaseUrl": "https://console.cloud.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate", - "clusterUrl": "https://console.cloud.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223", + "operateBaseUrl": "https://console.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate", + "clusterUrl": "https://console.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223", "alerts": [ { - "operateUrl": "https://console.cloud.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate/#/instances/2251799829404548", + "operateUrl": "https://console.camunda.io/org/2b3bc239-ad5b-4eef-80e0-6ef5139ed66a/cluster/88d32bfc-4f8e-4dd3-9ae2-adfee281e223/operate/#/instances/2251799829404548", "processInstanceId": "1234567890123456", "errorMessage": "something went wrong", "errorType": "JOB_NO_RETRIES", diff --git a/versioned_docs/version-8.5/components/console/manage-organization/external-sso.md b/versioned_docs/version-8.5/components/console/manage-organization/external-sso.md index b0823e8c3b..60b62055ff 100644 --- a/versioned_docs/version-8.5/components/console/manage-organization/external-sso.md +++ b/versioned_docs/version-8.5/components/console/manage-organization/external-sso.md @@ -35,6 +35,19 @@ For Azure AD, you will need to provide: To generate the client on your end, you will need to use the Camunda **Redirect URL** `https://weblogin.cloud.camunda.io/login/callback `. Ensure you attach the user permissions `Users > User.Read`. +### Default organizations Enterprise only + +:::info +Default organizations for external identity provider are only available for organizations on an Enterprise plan. +::: + +By setting up an external identity provider, it is possible to configure up to 10 default organizations. The following information must be added in the ticket so the support team can configure the default organizations: + +- Organization Id +- Default organization roles + +If a user logs in with the configured connection, the user is automatically assigned to these organizations with the corresponding roles. + ### Additional information In some situations, you might need to access `openid-configuration` to establish the connection from your end. See [this OpenID configuration](https://weblogin.cloud.camunda.io/.well-known/openid-configuration) as an example. diff --git a/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-context-expressions.md b/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-context-expressions.md index 9b37f3d2b0..8e6a232f1d 100644 --- a/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-context-expressions.md +++ b/versioned_docs/version-8.5/components/modeler/feel/language-guide/feel-context-expressions.md @@ -102,7 +102,7 @@ accessed by their key. b: 10 } ][b > 7] -// {a: "p2", b: 10} +// [{a: "p2", b: 10}] ``` ### Projection diff --git a/versioned_docs/version-8.5/components/react-components/connector-task.md b/versioned_docs/version-8.5/components/react-components/connector-task.md new file mode 100644 index 0000000000..7bf9fa8631 --- /dev/null +++ b/versioned_docs/version-8.5/components/react-components/connector-task.md @@ -0,0 +1,12 @@ +--- +--- + +A Connector can be applied to a task or an event using the append menu. Access the append menu using any of the three methods below: + +- **From the canvas**: Select an element and click the **Change element** icon to change an existing element, or use the append feature to add a new element to the diagram. +- **From the properties panel**: Navigate to the **Template** section and click **Select**. +- **From the side palette**: Click the **Create element** icon. + +![change element](./img/change-element.png) + +Once you have applied a Connector to your element, follow the configuration steps or read our [guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. diff --git a/versioned_docs/version-8.5/components/react-components/img/change-element.png b/versioned_docs/version-8.5/components/react-components/img/change-element.png new file mode 100644 index 0000000000..3f0207bb1b Binary files /dev/null and b/versioned_docs/version-8.5/components/react-components/img/change-element.png differ diff --git a/versioned_docs/version-8.5/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/versioned_docs/version-8.5/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index a91f8d177f..6ececf915e 100644 --- a/versioned_docs/version-8.5/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/versioned_docs/version-8.5/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -91,7 +91,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: ```json title="POST /api/v1/files/search" { @@ -116,7 +116,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: ```json title="POST /api/v1/milestones/search" { @@ -226,10 +226,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -237,7 +237,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/versioned_docs/version-8.5/guides/getting-started-orchestrate-apis.md b/versioned_docs/version-8.5/guides/getting-started-orchestrate-apis.md index fd2fc19402..2f025bf8ae 100644 --- a/versioned_docs/version-8.5/guides/getting-started-orchestrate-apis.md +++ b/versioned_docs/version-8.5/guides/getting-started-orchestrate-apis.md @@ -70,7 +70,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Cluster name > API**. +1. Navigate to the API tab [in Camunda Console](https://console.camunda.io/) by clicking **Clusters > Cluster name > API**. ![cluster-details](../components/console/manage-clusters/img/cluster-detail-clients.png) 2. Click **Create your first client** to create a new client and name your client accordingly. 3. Determine the scoped access for client credentials. Select **Zeebe client** so the newly-created client can access your Zeebe instance. diff --git a/docs/guides/help-center.md b/versioned_docs/version-8.5/reference/help-center.md similarity index 96% rename from docs/guides/help-center.md rename to versioned_docs/version-8.5/reference/help-center.md index d89e9ab4a2..825144b886 100644 --- a/docs/guides/help-center.md +++ b/versioned_docs/version-8.5/reference/help-center.md @@ -6,9 +6,7 @@ description: "Get recommendations for additional learning, step through the auto keywords: [getting-started, help-center, help, support] --- -Beginner Camunda 8 SaaS only -Time estimate: 10 minutes Camunda 8 SaaS offers a Help Center to all users, where you can access additional documentation, step through various use cases in Camunda, share your feedback, and more. diff --git a/versioned_docs/version-8.5/guides/img/automation-project-guide.png b/versioned_docs/version-8.5/reference/img/automation-project-guide.png similarity index 100% rename from versioned_docs/version-8.5/guides/img/automation-project-guide.png rename to versioned_docs/version-8.5/reference/img/automation-project-guide.png diff --git a/versioned_docs/version-8.5/guides/img/open-help-center.png b/versioned_docs/version-8.5/reference/img/open-help-center.png similarity index 100% rename from versioned_docs/version-8.5/guides/img/open-help-center.png rename to versioned_docs/version-8.5/reference/img/open-help-center.png diff --git a/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md b/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md index d686ed8a3d..c70ee053b6 100644 --- a/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md +++ b/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md @@ -9,7 +9,11 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console). ::: -Console Self-Managed can be configured using environment variables and configuration parameters: +Console Self-Managed can be configured using environment variables and configuration parameters. + +:::note +Underscores in environment variables correspond to configuration file key levels. +::: ## Environment variables diff --git a/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md index cd1bee3c61..2cb55c61c3 100644 --- a/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ## Core configuration diff --git a/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md index b7d8394da0..c616d31d1d 100644 --- a/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md @@ -3,17 +3,16 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: - The following parts are configurable: ## Webserver diff --git a/versioned_docs/version-8.5/self-managed/operational-guides/update-guide/840-to-850.md b/versioned_docs/version-8.5/self-managed/operational-guides/update-guide/840-to-850.md index 92ba082e8d..864a994ddd 100644 --- a/versioned_docs/version-8.5/self-managed/operational-guides/update-guide/840-to-850.md +++ b/versioned_docs/version-8.5/self-managed/operational-guides/update-guide/840-to-850.md @@ -21,6 +21,12 @@ Follow the [upgrade instructions](/self-managed/setup/upgrade.md#helm-chart-1002 ## Zeebe +:::caution +There is a [bug](https://github.com/camunda/camunda/issues/19984) in Zeebe 8.5.4 which incorrectly flags snapshots as corrupted even when they're not. This can cause reduced availability as nodes fail to start correctly. As such, **you should skip 8.5.4 and update directly from 8.5.3 to 8.5.5, or immediately to 8.5.5 if you're already on 8.5.4.** + +Note that there is **no** actual corruption or data loss, however. +::: + ### Deprecated broker health checks The broker health check routes have moved, and the old routes are now deprecated. Specifically, the following routes will return [a status code of 301](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) and redirect you. See the table below about the new mappings: diff --git a/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md index 3b5968b248..d33c9aef12 100644 --- a/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md index 0c75f4c652..d8a9135b11 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_sidebars/version-8.5-sidebars.json b/versioned_sidebars/version-8.5-sidebars.json index 50e87eb12b..4c0b919476 100644 --- a/versioned_sidebars/version-8.5-sidebars.json +++ b/versioned_sidebars/version-8.5-sidebars.json @@ -4,7 +4,6 @@ "Get started": [ "guides/introduction-to-camunda", "guides/create-account", - "guides/camunda-help-center", "guides/model-your-first-process", "guides/orchestrate-human-tasks", "guides/orchestrate-apis", @@ -1363,6 +1362,7 @@ "reference/status", "reference/supported-environments", "reference/dependencies", + "reference/camunda-help-center", "reference/alpha-features", "reference/licenses", "reference/notices",