diff --git a/docs/apis-tools/cli-client/cli-get-started.md b/docs/apis-tools/cli-client/cli-get-started.md index 303073a67c..74d532f6bf 100644 --- a/docs/apis-tools/cli-client/cli-get-started.md +++ b/docs/apis-tools/cli-client/cli-get-started.md @@ -4,11 +4,11 @@ title: Getting started with the CLI client sidebar_label: "Getting started with the CLI client" --- -In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda Platform 8. +In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda 8. ## Prerequisites -- [Camunda Platform 8 account](/guides/create-account.md) +- [Camunda 8 account](/guides/create-account.md) - [Cluster](/guides/create-cluster.md) - [Client credentials](/guides/setup-client-connection-credentials.md) - [Modeler](/guides/model-your-first-process.md) @@ -37,7 +37,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When creating client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When creating client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands. diff --git a/docs/apis-tools/cli-client/index.md b/docs/apis-tools/cli-client/index.md index b44f2210a3..6842d22a25 100644 --- a/docs/apis-tools/cli-client/index.md +++ b/docs/apis-tools/cli-client/index.md @@ -2,10 +2,10 @@ id: index title: CLI client sidebar_label: "Quick reference" -description: "Learn how to use the CLI client and command line interface `zbctl` to interact with Camunda Platform 8 and test a connection." +description: "Learn how to use the CLI client and command line interface `zbctl` to interact with Camunda 8 and test a connection." --- -`zbctl` is the command line interface to interact with Camunda Platform 8. After installation, a connection can be tested immediately. +`zbctl` is the command line interface to interact with Camunda 8. After installation, a connection can be tested immediately. ## Installation @@ -28,7 +28,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands. diff --git a/docs/apis-tools/console-api-reference.md b/docs/apis-tools/console-api-reference.md index 8331819541..4e18d1d3bf 100644 --- a/docs/apis-tools/console-api-reference.md +++ b/docs/apis-tools/console-api-reference.md @@ -1,7 +1,7 @@ --- id: console-api-reference title: Console API clients (REST) -description: "Create and manage clusters, and interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console." +description: "Create and manage clusters, and interact with Camunda 8 programmatically without using the Camunda 8 Console." --- ## Console API (REST) @@ -9,14 +9,14 @@ description: "Create and manage clusters, and interact with Camunda Platform 8 p For all requests, include the access token in the Authorization header: `authorization:Bearer ${TOKEN}`. :::note -A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda Platform 8 cluster. +A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda 8 cluster. ::: ### Client credentials and scopes -To interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console, create client credentials in the organization settings under the **Console API** tab. +To interact with Camunda 8 programmatically without using the Camunda 8 Console, create client credentials in the organization settings under the **Console API** tab. -Client credentials are created for an organization, and therefore can access all Camunda Platform 8 clusters of this organization. +Client credentials are created for an organization, and therefore can access all Camunda 8 clusters of this organization. Scopes define the access for client credentials. A client can have one or multiple of the following permissions: @@ -30,7 +30,7 @@ A client can have one or multiple permissions from the following groups: - **IP Whitelist**: Configure [IP-Whitelist](../components/console/manage-clusters/manage-ip-whitelists.md) rules. - **Connector Secrets**: [Manage secrets](../components/console/manage-clusters/manage-secrets.md) of your clusters. - **Members**: [Manage members](../components/console/manage-organization/manage-users.md) of your organization. -- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda Platform 8 clusters (only available to Enterprise customers). +- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda 8 clusters (only available to Enterprise customers). The full API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/). diff --git a/docs/apis-tools/go-client/go-get-started.md b/docs/apis-tools/go-client/go-get-started.md index e51ee5d429..8b92a91bb7 100644 --- a/docs/apis-tools/go-client/go-get-started.md +++ b/docs/apis-tools/go-client/go-get-started.md @@ -7,13 +7,13 @@ sidebar_label: "Getting started with the Go client" import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda Platform 8. +In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8. You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go). ## Prerequisites -- [Camunda Platform 8 account](/guides/create-account.md) +- [Camunda 8 account](/guides/create-account.md) - [Cluster](/guides/create-cluster.md) - [Client credentials](/guides/setup-client-connection-credentials.md) - [Go v1.13+ environment installed](https://go.dev/) @@ -50,7 +50,7 @@ export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` :::note -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. ::: 4. Create a `main.go` file inside the module and add the following lines to bootstrap the Zeebe client: @@ -141,7 +141,7 @@ Now, we need a simple process we can deploy. Later, we will extend the process w -1. Open Desktop Modeler and create a new Camunda Platform 8 BPMN diagram named `order-process.bpmn`. +1. Open Desktop Modeler and create a new Camunda 8 BPMN diagram named `order-process.bpmn`. 2. Add a start event named `Order Placed` and an end event named `Order Delivered` to the diagram. Then, connect the events. @@ -236,9 +236,9 @@ processKey:2251799813686742 bpmnProcessId:"order-process" version:3 processInsta Want to note how the process instance is executed? Follow the steps below: -1. Go to the cluster in Camunda Platform 8 and select it. -1. Click on the link to [Operate](/components/operate/userguide/basic-operate-navigation.md). -1. Select the process **order process**. +1. Go to the cluster in Camunda 8 and select it. +2. Click on the link to [Operate](/components/operate/userguide/basic-operate-navigation.md). +3. Select the process **order process**. A process instance has now been started and finished. diff --git a/docs/apis-tools/go-client/index.md b/docs/apis-tools/go-client/index.md index 662e5da683..969c2a95b2 100644 --- a/docs/apis-tools/go-client/index.md +++ b/docs/apis-tools/go-client/index.md @@ -2,7 +2,7 @@ id: index title: "Go client" sidebar_label: "Quick reference" -description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda Platform 8." +description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda 8." --- ## Dependencies @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Given these environment variables, you can instantiate the client as follows: diff --git a/docs/apis-tools/java-client/index.md b/docs/apis-tools/java-client/index.md index b9c833b2e0..f333089133 100644 --- a/docs/apis-tools/java-client/index.md +++ b/docs/apis-tools/java-client/index.md @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Given these environment variables, you can instantiate the client as follows: diff --git a/docs/apis-tools/java-client/zeebe-process-test.md b/docs/apis-tools/java-client/zeebe-process-test.md index a8a04c5e10..16c20d5816 100644 --- a/docs/apis-tools/java-client/zeebe-process-test.md +++ b/docs/apis-tools/java-client/zeebe-process-test.md @@ -3,7 +3,7 @@ id: zeebe-process-test title: "Zeebe Process Test" --- -[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda Platform 8 BPMN +[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda 8 BPMN processes. It will start a Zeebe test engine and provide you with a set of assertions you can use to verify your process behaves as expected. diff --git a/docs/apis-tools/operate-api/overview.md b/docs/apis-tools/operate-api/overview.md index 2e6300398a..9830933428 100644 --- a/docs/apis-tools/operate-api/overview.md +++ b/docs/apis-tools/operate-api/overview.md @@ -42,7 +42,7 @@ The following settings are needed to request a token: | authorization server url | Token issuer server | - | :::note -For more information on how to get these values for Camunda Platform 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/). +For more information on how to get these values for Camunda 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/). ::: Send a token issue _POST_ request to the authorization server with the required settings: diff --git a/docs/apis-tools/public-api.md b/docs/apis-tools/public-api.md index 151f798e90..f879d26e7f 100644 --- a/docs/apis-tools/public-api.md +++ b/docs/apis-tools/public-api.md @@ -1,14 +1,14 @@ --- id: public-api title: "Public API" -description: "Camunda Platform 8 provides a public API. Obtain more information on backwards compatibility for version updates." +description: "Camunda 8 provides a public API. Obtain more information on backwards compatibility for version updates." --- -Camunda Platform 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates. +Camunda 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates. ## Backwards compatibility for public API -Camunda Platform 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda Platform 8 will +Camunda 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda 8 will maintain public API backwards compatibility for `MINOR` version updates. Example: Update from version `1.0.x` to `1.1.y` will not break the public API. diff --git a/docs/apis-tools/tasklist-api/tasklist-api-overview.md b/docs/apis-tools/tasklist-api/tasklist-api-overview.md index 9e4e6ef4c6..63767cb1e2 100644 --- a/docs/apis-tools/tasklist-api/tasklist-api-overview.md +++ b/docs/apis-tools/tasklist-api/tasklist-api-overview.md @@ -18,7 +18,7 @@ The GraphQL API will be deprecated in the near future. To ensure a smooth transi Tasklist provides a GraphQL API at endpoint `/graphql`. -From Camunda Platform 8 the endpoint is `${base-url}/graphql`. +From Camunda 8 the endpoint is `${base-url}/graphql`. For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql`, and for Self-Managed installations: `http://localhost:8080/graphql`. diff --git a/docs/apis-tools/tasklist-api/tasklist-api-tutorial.md b/docs/apis-tools/tasklist-api/tasklist-api-tutorial.md index b595e6c563..21c5449ffc 100644 --- a/docs/apis-tools/tasklist-api/tasklist-api-tutorial.md +++ b/docs/apis-tools/tasklist-api/tasklist-api-tutorial.md @@ -18,7 +18,7 @@ For this tutorial we'll need: - Node v14+ - The [NestJS CLI](https://docs.nestjs.com/cli/overview) tool. Install it by running `npm install -g @nestjs/cli`. -- [A cluster on Camunda Platform 8](../../components/console/manage-clusters/create-cluster.md) +- [A cluster on Camunda 8](../../components/console/manage-clusters/create-cluster.md) - [A set of API credentials; remember to check the Tasklist option when creating them](../../components/console/manage-clusters/manage-api-clients.md). Don't forget to save these, we'll need them later. - [A clone of this repo](https://github.com/camunda-community-hub/camunda-cloud-tasklist-api-nestjs) diff --git a/docs/apis-tools/working-with-apis-tools.md b/docs/apis-tools/working-with-apis-tools.md index 6c75949c06..731372f4cb 100644 --- a/docs/apis-tools/working-with-apis-tools.md +++ b/docs/apis-tools/working-with-apis-tools.md @@ -2,18 +2,18 @@ id: working-with-apis-tools title: "Working with APIs & tools" sidebar_label: "Working with APIs & tools" -description: "Interact programmatically with Camunda Platform 8 using official Zeebe client libraries and APIs." +description: "Interact programmatically with Camunda 8 using official Zeebe client libraries and APIs." --- import DocCardList from '@theme/DocCardList'; This section steps through two concepts for integration: -- **Control your Camunda Platform 8 process automation** by [deploying processes](/components/modeler/web-modeler/run-or-publish-your-process.md#deploy-a-process), [starting process instances](/components/modeler/web-modeler/run-or-publish-your-process.md), [activating jobs](/components/concepts/job-workers.md), and more using supplemental and community-maintained **Zeebe client libraries**. -- **Interact with the Camunda Platform 8 ecosystem** by learning about [Camunda Components](/components/components-overview.md) and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more. +- **Control your Camunda 8 process automation** by [deploying processes](/components/modeler/web-modeler/run-or-publish-your-process.md#deploy-a-process), [starting process instances](/components/modeler/web-modeler/run-or-publish-your-process.md), [activating jobs](/components/concepts/job-workers.md), and more using supplemental and community-maintained **Zeebe client libraries**. +- **Interact with the Camunda 8 ecosystem** by learning about [Camunda Components](/components/components-overview.md) and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more. :::note -You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Platform Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation. +You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation. ::: ## Deploy processes, start process instances, and more using Zeebe client libraries @@ -26,9 +26,9 @@ Clients allow applications to do the following: - Publish messages. - Update process instance variables and resolve incidents. -The official clients mentioned below interact with [Zeebe](/components/zeebe/zeebe-overview.md), the workflow engine integrated into Camunda Platform 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. Clients connect to Camunda Platform 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol. +The official clients mentioned below interact with [Zeebe](/components/zeebe/zeebe-overview.md), the workflow engine integrated into Camunda 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. Clients connect to Camunda 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol. -Camunda Platform 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API. +Camunda 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API. ### Official Zeebe clients @@ -44,14 +44,14 @@ type:"link", href:"/docs/next/apis-tools/java-client/", label: "Java client", do ]}/> :::note -Other components in Camunda Platform 8, such as [Tasklist API (GraphQL)](../apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks. +Other components in Camunda 8, such as [Tasklist API (GraphQL)](../apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks. ::: ## Learn about Camunda Components and their APIs -Camunda Platform 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs. +Camunda 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs. -![Architecture diagram for Camunda Platform including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png) +![Architecture diagram for Camunda including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png) ### API Reference diff --git a/optimize/apis-tools/optimize-api/event-ingestion.md b/optimize/apis-tools/optimize-api/event-ingestion.md index 94c8c864c7..996539c003 100644 --- a/optimize/apis-tools/optimize-api/event-ingestion.md +++ b/optimize/apis-tools/optimize-api/event-ingestion.md @@ -4,9 +4,9 @@ title: "Event ingestion" description: "The REST API to ingest external events into Optimize." --- -Camunda Platform 7 only +Camunda 7 only -The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda Platform 7. +The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda 7. ## Functionality diff --git a/optimize/apis-tools/optimize-api/optimize-api-authorization.md b/optimize/apis-tools/optimize-api/optimize-api-authorization.md index 1a9124d785..bffbb6da98 100644 --- a/optimize/apis-tools/optimize-api/optimize-api-authorization.md +++ b/optimize/apis-tools/optimize-api/optimize-api-authorization.md @@ -13,7 +13,7 @@ Given a valid token `mySecret`, the header would need to be set as follows: Authorization: Bearer mySecret ``` -The token used to access the Optimize API can be a configurable shared secret (except in Camunda Platform 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes). +The token used to access the Optimize API can be a configurable shared secret (except in Camunda 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes). Refer to [Public API Configuration](../../self-managed/optimize-deployment/configuration/system-configuration.md#public-api) for the particular configuration to access the public API using a token. diff --git a/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/event-ingestion.md b/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/event-ingestion.md index 94c8c864c7..996539c003 100644 --- a/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/event-ingestion.md +++ b/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/event-ingestion.md @@ -4,9 +4,9 @@ title: "Event ingestion" description: "The REST API to ingest external events into Optimize." --- -Camunda Platform 7 only +Camunda 7 only -The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda Platform 7. +The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda 7. ## Functionality diff --git a/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/optimize-api-authorization.md b/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/optimize-api-authorization.md index 1a9124d785..bffbb6da98 100644 --- a/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/optimize-api-authorization.md +++ b/optimize_versioned_docs/version-3.10.0/apis-tools/optimize-api/optimize-api-authorization.md @@ -13,7 +13,7 @@ Given a valid token `mySecret`, the header would need to be set as follows: Authorization: Bearer mySecret ``` -The token used to access the Optimize API can be a configurable shared secret (except in Camunda Platform 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes). +The token used to access the Optimize API can be a configurable shared secret (except in Camunda 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes). Refer to [Public API Configuration](../../self-managed/optimize-deployment/configuration/system-configuration.md#public-api) for the particular configuration to access the public API using a token. diff --git a/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/dashboard/delete-dashboard.md b/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/dashboard/delete-dashboard.md index a37bb7c7f1..8655ba5325 100644 --- a/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/dashboard/delete-dashboard.md +++ b/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/dashboard/delete-dashboard.md @@ -4,7 +4,7 @@ title: "Delete dashboards" description: "The REST API to delete dashboards from Optimize." --- -Camunda Platform 7 only +Camunda 7 only The dashboards deletion API allows you to delete dashboards by ID from Optimize. diff --git a/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/event-ingestion.md b/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/event-ingestion.md index 94c8c864c7..996539c003 100644 --- a/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/event-ingestion.md +++ b/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/event-ingestion.md @@ -4,9 +4,9 @@ title: "Event ingestion" description: "The REST API to ingest external events into Optimize." --- -Camunda Platform 7 only +Camunda 7 only -The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda Platform 7. +The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda 7. ## Functionality diff --git a/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/optimize-api-authorization.md b/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/optimize-api-authorization.md index f85c8900b6..13dabf129b 100644 --- a/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/optimize-api-authorization.md +++ b/optimize_versioned_docs/version-3.9.0/apis-tools/optimize-api/optimize-api-authorization.md @@ -12,7 +12,7 @@ Given a valid token `mySecret`, the header would need to be set as follows: Authorization: Bearer mySecret ``` -The token used to access the Optimize API can be a configurable shared secret (except in Camunda Platform 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes). +The token used to access the Optimize API can be a configurable shared secret (except in Camunda 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes). Refer to [Public API Configuration](../../self-managed/optimize-deployment/configuration/system-configuration.md#public-api) for the particular configuration to access the public API using a token. diff --git a/versioned_docs/version-8.1/apis-tools/cli-client/cli-get-started.md b/versioned_docs/version-8.1/apis-tools/cli-client/cli-get-started.md index e42a6e0a4c..4902522629 100644 --- a/versioned_docs/version-8.1/apis-tools/cli-client/cli-get-started.md +++ b/versioned_docs/version-8.1/apis-tools/cli-client/cli-get-started.md @@ -4,11 +4,11 @@ title: Getting started with the CLI client sidebar_label: "Getting started with the CLI client" --- -In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda Platform 8. +In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda 8. ## Prerequisites -- [Camunda Platform 8 account](/guides/create-account.md) +- [Camunda 8 account](/guides/create-account.md) - [Cluster](/guides/create-cluster.md) - [Client credentials](/guides/setup-client-connection-credentials.md) - [Modeler](/guides/model-your-first-process.md) @@ -37,7 +37,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When creating client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When creating client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands. diff --git a/versioned_docs/version-8.1/apis-tools/cli-client/index.md b/versioned_docs/version-8.1/apis-tools/cli-client/index.md index 8df01b41b1..290da76ec2 100644 --- a/versioned_docs/version-8.1/apis-tools/cli-client/index.md +++ b/versioned_docs/version-8.1/apis-tools/cli-client/index.md @@ -4,7 +4,7 @@ title: CLI client sidebar_label: "Quick reference" --- -`zbctl` is the command line interface to interact with Camunda Platform 8. After installation, a connection can be tested immediately. +`zbctl` is the command line interface to interact with Camunda 8. After installation, a connection can be tested immediately. ## Installation @@ -27,7 +27,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands. diff --git a/versioned_docs/version-8.1/apis-tools/console-api-reference.md b/versioned_docs/version-8.1/apis-tools/console-api-reference.md index 236a07dea1..4c138e6159 100644 --- a/versioned_docs/version-8.1/apis-tools/console-api-reference.md +++ b/versioned_docs/version-8.1/apis-tools/console-api-reference.md @@ -1,7 +1,7 @@ --- id: console-api-reference title: Console API clients (REST) -description: "Create and manage clusters, and interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console." +description: "Create and manage clusters, and interact with Camunda 8 programmatically without using the Camunda 8 Console." --- ## Console API (REST) @@ -9,14 +9,14 @@ description: "Create and manage clusters, and interact with Camunda Platform 8 p For all requests, include the access token in the Authorization header: `authorization:Bearer ${TOKEN}`. :::note -A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda Platform 8 cluster. +A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda 8 cluster. ::: ### Client credentials and scopes -To interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console, create client credentials in the organization settings under the **Console API** tab. +To interact with Camunda 8 programmatically without using the Camunda 8 Console, create client credentials in the organization settings under the **Console API** tab. -Client credentials are created for an organization, and therefore can access all Camunda Platform 8 clusters of this organization. +Client credentials are created for an organization, and therefore can access all Camunda 8 clusters of this organization. Scopes define the access for client credentials. A client can have one or multiple of the following permissions: diff --git a/versioned_docs/version-8.1/apis-tools/go-client/go-get-started.md b/versioned_docs/version-8.1/apis-tools/go-client/go-get-started.md index bca978269c..3728f82473 100644 --- a/versioned_docs/version-8.1/apis-tools/go-client/go-get-started.md +++ b/versioned_docs/version-8.1/apis-tools/go-client/go-get-started.md @@ -4,13 +4,13 @@ title: Getting started with the Go client sidebar_label: "Getting started with the Go client" --- -In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda Platform 8. +In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8. You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go). ## Prerequisites -- [Camunda Platform 8 account](/guides/create-account.md) +- [Camunda 8 account](/guides/create-account.md) - [Cluster](/guides/create-cluster.md) - [Client credentials](/guides/setup-client-connection-credentials.md) - Go v1.13+ environment installed @@ -47,7 +47,7 @@ export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` :::note -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. ::: 4. Create a `main.go` file inside the module and add the following lines to bootstrap the Zeebe client: @@ -185,7 +185,7 @@ processKey:2251799813686742 bpmnProcessId:"order-process" version:3 processInsta Want to see how the process instance is executed? Follow the steps below: -1. Go to the cluster in Camunda Platform 8 and select it. +1. Go to the cluster in Camunda 8 and select it. 1. Click on the link to [Operate](/components/operate/userguide/basic-operate-navigation.md). 1. Select the process **order process**. diff --git a/versioned_docs/version-8.1/apis-tools/go-client/index.md b/versioned_docs/version-8.1/apis-tools/go-client/index.md index 91a1cb20a0..77307235f4 100644 --- a/versioned_docs/version-8.1/apis-tools/go-client/index.md +++ b/versioned_docs/version-8.1/apis-tools/go-client/index.md @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Given these environment variables, you can instantiate the client as follows: diff --git a/versioned_docs/version-8.1/apis-tools/java-client/index.md b/versioned_docs/version-8.1/apis-tools/java-client/index.md index e638aa9bbb..3d4a5b78c7 100644 --- a/versioned_docs/version-8.1/apis-tools/java-client/index.md +++ b/versioned_docs/version-8.1/apis-tools/java-client/index.md @@ -75,7 +75,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Given these environment variables, you can instantiate the client as follows: diff --git a/versioned_docs/version-8.1/apis-tools/java-client/zeebe-process-test.md b/versioned_docs/version-8.1/apis-tools/java-client/zeebe-process-test.md index a8a04c5e10..16c20d5816 100644 --- a/versioned_docs/version-8.1/apis-tools/java-client/zeebe-process-test.md +++ b/versioned_docs/version-8.1/apis-tools/java-client/zeebe-process-test.md @@ -3,7 +3,7 @@ id: zeebe-process-test title: "Zeebe Process Test" --- -[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda Platform 8 BPMN +[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda 8 BPMN processes. It will start a Zeebe test engine and provide you with a set of assertions you can use to verify your process behaves as expected. diff --git a/versioned_docs/version-8.1/apis-tools/operate-api/index.md b/versioned_docs/version-8.1/apis-tools/operate-api/index.md index c6bcbaf59e..3d30f5b791 100644 --- a/versioned_docs/version-8.1/apis-tools/operate-api/index.md +++ b/versioned_docs/version-8.1/apis-tools/operate-api/index.md @@ -38,7 +38,7 @@ The following settings are needed to request a token: | authorization server url | Token issuer server | - | :::note -For more information on how to get these values for Camunda Platform 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/). +For more information on how to get these values for Camunda 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/). ::: Send a token issue _POST_ request to the authorization server with the required settings: diff --git a/versioned_docs/version-8.1/apis-tools/public-api.md b/versioned_docs/version-8.1/apis-tools/public-api.md index 537b148185..f06027911a 100644 --- a/versioned_docs/version-8.1/apis-tools/public-api.md +++ b/versioned_docs/version-8.1/apis-tools/public-api.md @@ -3,11 +3,11 @@ id: public-api title: "Public API" --- -Camunda Platform 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates. +Camunda 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates. ## Backwards compatibility for public API -Camunda Platform 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda Platform 8 will +Camunda 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda 8 will maintain public API backwards compatibility for `MINOR` version updates. Example: Update from version `1.0.x` to `1.1.y` will not break the public API. diff --git a/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-overview.md b/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-overview.md index 73d474ba5b..418b077916 100644 --- a/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-overview.md +++ b/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-overview.md @@ -12,7 +12,7 @@ In this document, we'll go over the basics on how to consume the Tasklist GraphQ Tasklist provides a GraphQL API at endpoint `/graphql`. -From Camunda Platform 8 onwards the endpoint is `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql` +From Camunda 8 onwards the endpoint is `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql` ## Authentication in the cloud diff --git a/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-tutorial.md b/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-tutorial.md index 888826b1dd..fbb19dcc50 100644 --- a/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-tutorial.md +++ b/versioned_docs/version-8.1/apis-tools/tasklist-api/tasklist-api-tutorial.md @@ -18,7 +18,7 @@ For this tutorial we'll need: - Node v14+ - The [NestJS CLI](https://docs.nestjs.com/cli/overview) tool. Install it by running `npm install -g @nestjs/cli`. -- [A cluster on Camunda Platform 8](../../components/console/manage-clusters/create-cluster.md) +- [A cluster on Camunda 8](../../components/console/manage-clusters/create-cluster.md) - [A set of API credentials; remember to check the Tasklist option when creating them](../../components/console/manage-clusters/manage-api-clients.md). Don't forget to save these, we'll need them later. - [A clone of this repo](https://github.com/camunda-community-hub/camunda-cloud-tasklist-api-nestjs) diff --git a/versioned_docs/version-8.1/apis-tools/working-with-apis-tools.md b/versioned_docs/version-8.1/apis-tools/working-with-apis-tools.md index 848f0d28c2..d614dec982 100644 --- a/versioned_docs/version-8.1/apis-tools/working-with-apis-tools.md +++ b/versioned_docs/version-8.1/apis-tools/working-with-apis-tools.md @@ -2,25 +2,25 @@ id: working-with-apis-tools title: "Working with APIs & tools" sidebar_label: "Working with APIs & tools" -description: "Programmatically work with Camunda Platform 8 through APIs & tools" +description: "Programmatically work with Camunda 8 through APIs & tools" --- This section steps through a variety of offered APIs and tools for integration. :::note -You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Platform Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation. +You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation. ::: ## APIs and interacting with other components -The clients mentioned below interact with Zeebe, the workflow engine integrated into Camunda Platform 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. +The clients mentioned below interact with Zeebe, the workflow engine integrated into Camunda 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. -Other components in Camunda Platform 8, such as [Tasklist API (GraphQL)](/apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks. +Other components in Camunda 8, such as [Tasklist API (GraphQL)](/apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks. ### Additional APIs -- [Public API](../apis-tools/public-api.md) - Camunda Platform 8's provided public API. -- [Cloud Console API clients (REST)](../apis-tools/console-api-reference.md) - Enables you to programmatically create and manage clusters, and interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 UI. +- [Public API](../apis-tools/public-api.md) - Camunda 8's provided public API. +- [Cloud Console API clients (REST)](../apis-tools/console-api-reference.md) - Enables you to programmatically create and manage clusters, and interact with Camunda 8 programmatically without using the Camunda 8 UI. - [Zeebe API](../apis-tools/grpc.md) - Zeebe clients use gRPC to communicate with the cluster. :::note @@ -37,9 +37,9 @@ Clients allow applications to do the following: - Publish messages. - Update process instance variables and resolve incidents. -Clients connect to Camunda Platform 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol. +Clients connect to Camunda 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol. -Camunda Platform 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (e.g. thread handling for job workers) on top of the core API. +Camunda 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (e.g. thread handling for job workers) on top of the core API. ### Official clients diff --git a/versioned_docs/version-8.2/apis-tools/cli-client/cli-get-started.md b/versioned_docs/version-8.2/apis-tools/cli-client/cli-get-started.md index e42a6e0a4c..4902522629 100644 --- a/versioned_docs/version-8.2/apis-tools/cli-client/cli-get-started.md +++ b/versioned_docs/version-8.2/apis-tools/cli-client/cli-get-started.md @@ -4,11 +4,11 @@ title: Getting started with the CLI client sidebar_label: "Getting started with the CLI client" --- -In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda Platform 8. +In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda 8. ## Prerequisites -- [Camunda Platform 8 account](/guides/create-account.md) +- [Camunda 8 account](/guides/create-account.md) - [Cluster](/guides/create-cluster.md) - [Client credentials](/guides/setup-client-connection-credentials.md) - [Modeler](/guides/model-your-first-process.md) @@ -37,7 +37,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When creating client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When creating client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands. diff --git a/versioned_docs/version-8.2/apis-tools/cli-client/index.md b/versioned_docs/version-8.2/apis-tools/cli-client/index.md index b44f2210a3..6842d22a25 100644 --- a/versioned_docs/version-8.2/apis-tools/cli-client/index.md +++ b/versioned_docs/version-8.2/apis-tools/cli-client/index.md @@ -2,10 +2,10 @@ id: index title: CLI client sidebar_label: "Quick reference" -description: "Learn how to use the CLI client and command line interface `zbctl` to interact with Camunda Platform 8 and test a connection." +description: "Learn how to use the CLI client and command line interface `zbctl` to interact with Camunda 8 and test a connection." --- -`zbctl` is the command line interface to interact with Camunda Platform 8. After installation, a connection can be tested immediately. +`zbctl` is the command line interface to interact with Camunda 8. After installation, a connection can be tested immediately. ## Installation @@ -28,7 +28,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands. diff --git a/versioned_docs/version-8.2/apis-tools/console-api-reference.md b/versioned_docs/version-8.2/apis-tools/console-api-reference.md index 8331819541..4e18d1d3bf 100644 --- a/versioned_docs/version-8.2/apis-tools/console-api-reference.md +++ b/versioned_docs/version-8.2/apis-tools/console-api-reference.md @@ -1,7 +1,7 @@ --- id: console-api-reference title: Console API clients (REST) -description: "Create and manage clusters, and interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console." +description: "Create and manage clusters, and interact with Camunda 8 programmatically without using the Camunda 8 Console." --- ## Console API (REST) @@ -9,14 +9,14 @@ description: "Create and manage clusters, and interact with Camunda Platform 8 p For all requests, include the access token in the Authorization header: `authorization:Bearer ${TOKEN}`. :::note -A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda Platform 8 cluster. +A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda 8 cluster. ::: ### Client credentials and scopes -To interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console, create client credentials in the organization settings under the **Console API** tab. +To interact with Camunda 8 programmatically without using the Camunda 8 Console, create client credentials in the organization settings under the **Console API** tab. -Client credentials are created for an organization, and therefore can access all Camunda Platform 8 clusters of this organization. +Client credentials are created for an organization, and therefore can access all Camunda 8 clusters of this organization. Scopes define the access for client credentials. A client can have one or multiple of the following permissions: @@ -30,7 +30,7 @@ A client can have one or multiple permissions from the following groups: - **IP Whitelist**: Configure [IP-Whitelist](../components/console/manage-clusters/manage-ip-whitelists.md) rules. - **Connector Secrets**: [Manage secrets](../components/console/manage-clusters/manage-secrets.md) of your clusters. - **Members**: [Manage members](../components/console/manage-organization/manage-users.md) of your organization. -- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda Platform 8 clusters (only available to Enterprise customers). +- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda 8 clusters (only available to Enterprise customers). The full API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/). diff --git a/versioned_docs/version-8.2/apis-tools/go-client/go-get-started.md b/versioned_docs/version-8.2/apis-tools/go-client/go-get-started.md index 1cd6aab515..f1d988bce5 100644 --- a/versioned_docs/version-8.2/apis-tools/go-client/go-get-started.md +++ b/versioned_docs/version-8.2/apis-tools/go-client/go-get-started.md @@ -7,13 +7,13 @@ sidebar_label: "Getting started with the Go client" import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda Platform 8. +In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8. You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go). ## Prerequisites -- [Camunda Platform 8 account](/guides/create-account.md) +- [Camunda 8 account](/guides/create-account.md) - [Cluster](/guides/create-cluster.md) - [Client credentials](/guides/setup-client-connection-credentials.md) - [Go v1.13+ environment installed](https://go.dev/) @@ -50,7 +50,7 @@ export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` :::note -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. ::: 4. Create a `main.go` file inside the module and add the following lines to bootstrap the Zeebe client: @@ -141,7 +141,7 @@ Now, we need a simple process we can deploy. Later, we will extend the process w -1. Open Desktop Modeler and create a new Camunda Platform 8 BPMN diagram named `order-process.bpmn`. +1. Open Desktop Modeler and create a new Camunda 8 BPMN diagram named `order-process.bpmn`. 2. Add a start event named `Order Placed` and an end event named `Order Delivered` to the diagram. Then, connect the events. @@ -236,7 +236,7 @@ processKey:2251799813686742 bpmnProcessId:"order-process" version:3 processInsta Want to see how the process instance is executed? Follow the steps below: -1. Go to the cluster in Camunda Platform 8 and select it. +1. Go to the cluster in Camunda 8 and select it. 1. Click on the link to [Operate](/components/operate/userguide/basic-operate-navigation.md). 1. Select the process **order process**. diff --git a/versioned_docs/version-8.2/apis-tools/go-client/index.md b/versioned_docs/version-8.2/apis-tools/go-client/index.md index 662e5da683..969c2a95b2 100644 --- a/versioned_docs/version-8.2/apis-tools/go-client/index.md +++ b/versioned_docs/version-8.2/apis-tools/go-client/index.md @@ -2,7 +2,7 @@ id: index title: "Go client" sidebar_label: "Quick reference" -description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda Platform 8." +description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda 8." --- ## Dependencies @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Given these environment variables, you can instantiate the client as follows: diff --git a/versioned_docs/version-8.2/apis-tools/java-client/index.md b/versioned_docs/version-8.2/apis-tools/java-client/index.md index a20127d2e6..7616cfe415 100644 --- a/versioned_docs/version-8.2/apis-tools/java-client/index.md +++ b/versioned_docs/version-8.2/apis-tools/java-client/index.md @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]' export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]' ``` -When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you. +When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you. Given these environment variables, you can instantiate the client as follows: diff --git a/versioned_docs/version-8.2/apis-tools/java-client/zeebe-process-test.md b/versioned_docs/version-8.2/apis-tools/java-client/zeebe-process-test.md index a8a04c5e10..16c20d5816 100644 --- a/versioned_docs/version-8.2/apis-tools/java-client/zeebe-process-test.md +++ b/versioned_docs/version-8.2/apis-tools/java-client/zeebe-process-test.md @@ -3,7 +3,7 @@ id: zeebe-process-test title: "Zeebe Process Test" --- -[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda Platform 8 BPMN +[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda 8 BPMN processes. It will start a Zeebe test engine and provide you with a set of assertions you can use to verify your process behaves as expected. diff --git a/versioned_docs/version-8.2/apis-tools/operate-api/overview.md b/versioned_docs/version-8.2/apis-tools/operate-api/overview.md index 8d1b0f0a7c..b7b3916e19 100644 --- a/versioned_docs/version-8.2/apis-tools/operate-api/overview.md +++ b/versioned_docs/version-8.2/apis-tools/operate-api/overview.md @@ -42,7 +42,7 @@ The following settings are needed to request a token: | authorization server url | Token issuer server | - | :::note -For more information on how to get these values for Camunda Platform 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/). +For more information on how to get these values for Camunda 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/). ::: Send a token issue _POST_ request to the authorization server with the required settings: diff --git a/versioned_docs/version-8.2/apis-tools/public-api.md b/versioned_docs/version-8.2/apis-tools/public-api.md index 151f798e90..f879d26e7f 100644 --- a/versioned_docs/version-8.2/apis-tools/public-api.md +++ b/versioned_docs/version-8.2/apis-tools/public-api.md @@ -1,14 +1,14 @@ --- id: public-api title: "Public API" -description: "Camunda Platform 8 provides a public API. Obtain more information on backwards compatibility for version updates." +description: "Camunda 8 provides a public API. Obtain more information on backwards compatibility for version updates." --- -Camunda Platform 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates. +Camunda 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates. ## Backwards compatibility for public API -Camunda Platform 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda Platform 8 will +Camunda 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda 8 will maintain public API backwards compatibility for `MINOR` version updates. Example: Update from version `1.0.x` to `1.1.y` will not break the public API. diff --git a/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-overview.md b/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-overview.md index 22463ffc1f..dd64288181 100644 --- a/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-overview.md +++ b/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-overview.md @@ -18,7 +18,7 @@ The GraphQL API will be deprecated in the near future. To ensure a smooth transi Tasklist provides a GraphQL API at endpoint `/graphql`. -From Camunda Platform 8 onwards the endpoint is `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql` +From Camunda 8 onwards the endpoint is `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql` ## Authentication in the cloud diff --git a/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-tutorial.md b/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-tutorial.md index 888826b1dd..fbb19dcc50 100644 --- a/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-tutorial.md +++ b/versioned_docs/version-8.2/apis-tools/tasklist-api/tasklist-api-tutorial.md @@ -18,7 +18,7 @@ For this tutorial we'll need: - Node v14+ - The [NestJS CLI](https://docs.nestjs.com/cli/overview) tool. Install it by running `npm install -g @nestjs/cli`. -- [A cluster on Camunda Platform 8](../../components/console/manage-clusters/create-cluster.md) +- [A cluster on Camunda 8](../../components/console/manage-clusters/create-cluster.md) - [A set of API credentials; remember to check the Tasklist option when creating them](../../components/console/manage-clusters/manage-api-clients.md). Don't forget to save these, we'll need them later. - [A clone of this repo](https://github.com/camunda-community-hub/camunda-cloud-tasklist-api-nestjs) diff --git a/versioned_docs/version-8.2/apis-tools/working-with-apis-tools.md b/versioned_docs/version-8.2/apis-tools/working-with-apis-tools.md index d71644874e..845c8b23b6 100644 --- a/versioned_docs/version-8.2/apis-tools/working-with-apis-tools.md +++ b/versioned_docs/version-8.2/apis-tools/working-with-apis-tools.md @@ -2,18 +2,18 @@ id: working-with-apis-tools title: "Working with APIs & tools" sidebar_label: "Working with APIs & tools" -description: "Interact programmatically with Camunda Platform 8 using official Zeebe client libraries and APIs." +description: "Interact programmatically with Camunda 8 using official Zeebe client libraries and APIs." --- import DocCardList from '@theme/DocCardList'; This section steps through two concepts for integration: -- **Control your Camunda Platform 8 process automation** by [deploying processes](/components/modeler/web-modeler/run-or-publish-your-process.md#deploy-a-process), [starting process instances](/components/modeler/web-modeler/run-or-publish-your-process.md), [activating jobs](/components/concepts/job-workers.md), and more using supplemental and community-maintained **Zeebe client libraries**. -- **Interact with the Camunda Platform 8 ecosystem** by learning about [Camunda Components](/components/components-overview.md) and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more. +- **Control your Camunda 8 process automation** by [deploying processes](/components/modeler/web-modeler/run-or-publish-your-process.md#deploy-a-process), [starting process instances](/components/modeler/web-modeler/run-or-publish-your-process.md), [activating jobs](/components/concepts/job-workers.md), and more using supplemental and community-maintained **Zeebe client libraries**. +- **Interact with the Camunda 8 ecosystem** by learning about [Camunda Components](/components/components-overview.md) and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more. :::note -You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Platform Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation. +You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation. ::: ## Deploy processes, start process instances, and more using Zeebe client libraries @@ -26,9 +26,9 @@ Clients allow applications to do the following: - Publish messages. - Update process instance variables and resolve incidents. -The official clients mentioned below interact with [Zeebe](/components/zeebe/zeebe-overview.md), the workflow engine integrated into Camunda Platform 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. Clients connect to Camunda Platform 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol. +The official clients mentioned below interact with [Zeebe](/components/zeebe/zeebe-overview.md), the workflow engine integrated into Camunda 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. Clients connect to Camunda 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol. -Camunda Platform 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API. +Camunda 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API. ### Official Zeebe clients @@ -44,7 +44,7 @@ type:"link", href:"/docs/next/apis-tools/java-client/", label: "Java client", do ]}/> :::note -Other components in Camunda Platform 8, such as [Tasklist API (GraphQL)](../apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks. +Other components in Camunda 8, such as [Tasklist API (GraphQL)](../apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks. ::: ### Community clients @@ -64,9 +64,9 @@ It is also possible to [build your own client](../apis-tools/build-your-own-clie ## Learn about Camunda Components and their APIs -Camunda Platform 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs. +Camunda 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs. -![Architecture diagram for Camunda Platform including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png) +![Architecture diagram for Camunda including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png) ### API Reference