Skip to content

Commit

Permalink
remove backport
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley committed Dec 11, 2024
1 parent a0918f8 commit 11b31cd
Show file tree
Hide file tree
Showing 41 changed files with 148 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ type:"link", href:"/docs/8.3/apis-tools/java-client/", label: "Java client", doc
}
]}/>

:::note
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 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs.
Expand All @@ -59,6 +63,9 @@ type:"link", href:"/docs/8.3/apis-tools/operate-api/overview/", label: "Operate
type:"link", href:"/optimize/3.11.0/apis-tools/optimize-api/optimize-api-authorization/", label: "Optimize API (REST)", description: "Get, delete, and export reports and dashboards, enable and disable sharing, and more."
},
{
type:"link", href:"/docs/8.3/apis-tools/tasklist-api/tasklist-api-overview/", label: "Tasklist API (GraphQL)", docId:"apis-tools/tasklist-api/tasklist-api-overview"
},
{
type:"link", href:"/docs/8.3/apis-tools/tasklist-api-rest/tasklist-api-rest-overview/", label: "Tasklist API (REST)", docId:"apis-tools/tasklist-api-rest/tasklist-api-rest-overview"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ As a general rule, you should assign human tasks in your business process to _gr
</bpmn:extensionElements>
```

Then, require individual members of that group to explicitly _claim tasks_ before working on them. This way, you avoid different people working on the same task at the same time. Refer to `claimTask`.

<!--- To rework --->
Then, require individual members of that group to explicitly _claim tasks_ before working on them. This way, you avoid different people working on the same task at the same time. Refer to [`claimTask`](../../../apis-tools/tasklist-api/mutations/claim-task.mdx).

```graphql
claimTask(
Expand Down Expand Up @@ -56,9 +54,7 @@ If you have human tasks in your process, you must make up your mind on how exact

- [Camunda Tasklist](/docs/components/tasklist/introduction-to-tasklist/): The Tasklist application shipped with Camunda. This works out-of-the-box and has a low development effort. However, it is limited in terms of customizability and how much you can influence the user experience.

- Custom task list application: You can develop a custom task list and adapt this to your needs without compromises. Human tasks are shown inside your custom application, following your style guide and usability concept. You will use the Camunda Tasklist API in the background. This is very flexible, but requires additional development work.

<!--- To rework. --->
- Custom task list application: You can develop a custom task list and adapt this to your needs without compromises. Human tasks are shown inside your custom application, following your style guide and usability concept. You will use the [Camunda Tasklist API](../../../apis-tools/tasklist-api/generated.md) in the background. This is very flexible, but requires additional development work.

- Third party tasklist: If our organization already has a task list application rolled out to the field, you might want to use this for tasks created by Camunda. You will need to develop some synchronization mechanism. The upside of this approach is that your end users might not even notice that you introduce a new workflow engine.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@ In Camunda 8, [values are stored as JSON](/docs/components/concepts/variables/#v
This best practice describes variable handling within Camunda 8. Process variables are handled slightly differently with Camunda 7. Consult the [Camunda 7 documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/) for details. In essence, variable values are not handled as JSON and thus there are [different values](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/#supported-variable-values) supported.
:::

You can dynamically create such variables by assigning an object of choice to a (string typed) variable name; for example, by passing a `Map<String, Object>` when completing the "Review tweet" task via the API:

<!--- To rework. --->
You can dynamically create such variables by assigning an object of choice to a (string typed) variable name; for example, by passing a `Map<String, Object>` when [completing](../../../apis-tools/tasklist-api/mutations/complete-task.mdx) the "Review tweet" task via the API:

```
// TODO: Double check!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The officially offered [client libraries](../../../apis-tools/working-with-apis-
Currently, Camunda 8 SaaS supports the following scopes:

- Zeebe - Access to the [Zeebe gRPC](/apis-tools/grpc.md) API.
- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API.
- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md).
- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/optimize-api-authorization).
- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ With Tasklist, orchestrate human workflows critical to your business and reduce

As you model a business process using BPMN and deploy it to the workflow engine, users are notified in Tasklist when they're assigned a task.

Tasklist also provides a [REST API](/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md).
Tasklist provides two APIs: a [GraphQL API](/docs/apis-tools/tasklist-api/tasklist-api-overview.md)
and a [REST API](/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md). Both APIs provide equal capabilities,
allowing you to build your own applications or use the general [UI](/docs/components/tasklist/userguide/using-tasklist.md) that we have prepared for you.

:::note
The GraphQL and REST APIs are currently available, but the GraphQL API will be deprecated in future releases, although it will still receive updates for a limited period. If you are building new applications,
we recommend using the REST API to ensure long-term compatibility.
:::

Tasklist is also available for production use (with support) in the Camunda 8 offering. To try out Tasklist in Camunda 8, sign up [here](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral).
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Here, we'll set up client connection credentials to create, name, and connect yo
Currently, Camunda 8 SaaS supports the following scopes:

- Zeebe - Access to the [Zeebe gRPC](/apis-tools/grpc.md) API.
- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API.
- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md).
- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/optimize-api-authorization).
- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ The user or user group can be assigned the following permission:

For more information, visit the [Identity documentation](/self-managed/concepts/access-control/resource-authorizations.md).

### Use Identity JWT token to access Tasklist API

Tasklist provides a [GraphQL API](/apis-tools/tasklist-api/tasklist-api-overview.md) under the endpoint `/graphql`. Clients can access this API using a JWT access token in an authorization header `Authorization: Bearer <JWT>`.

:::note
Be aware a JWT token is intended to be used for M2M communication and is therefore issued for the relevant application, not for the user.
:::

**Example:**

1. [Add an application in Identity](/self-managed/identity/user-guide/additional-features/incorporate-applications.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,12 @@ TaskSearchRequest - query object to search tasks by provided params.
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchRequest.<b>processDefinitionKey</b></code>](#)<Bullet />`string`

> Reference to process definition
> (renamed equivalent of [`TaskQuery.processDefinitionId`](../../../tasklist-api/inputs/task-query.mdx#code-style-fontweight-normal-taskquerybprocessdefinitionidbcodestring-) field).
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchRequest.<b>processInstanceKey</b></code>](#)<Bullet />`string`

> Reference to process instance
> (renamed equivalent of [`TaskQuery.processInstanceId`](../../../tasklist-api/inputs/task-query.mdx#code-style-fontweight-normal-taskquerybprocessinstanceidbcodestring-) field).
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchRequest.<b>followUpDateDate</b></code>](#)<Bullet />[`DateFilter`](../models/date-filter-input.mdx)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ FormResponse - represents task embedded form.
#### [<code style={{ fontWeight: 'normal' }}>FormResponse.<b>processDefinitionKey</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

> Reference to process definition
> (renamed equivalent of [`Form.processDefinitionId`](../../../tasklist-api/objects/form.mdx#code-style-fontweight-normal-formbprocessdefinitionidbcodestring--) field)
#### [<code style={{ fontWeight: 'normal' }}>FormResponse.<b>schema</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,12 @@ TaskResponse - represents a user task.
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>creationDate</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

> When was the task created
> (renamed equivalent of [`Task.creationTime`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbcreationtimebcodestring--) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>completionDate</b></code>](#)<Bullet />`string`

> When was the task completed
> (renamed equivalent of [`Task.completionTime`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbcompletiontimebcodestring-) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>assignee</b></code>](#)<Bullet />`string`

Expand Down Expand Up @@ -160,10 +162,12 @@ TaskResponse - represents a user task.
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>processDefinitionKey</b></code>](#)<Bullet />`string`

> Reference to process definition
> (renamed equivalent of [`Task.processDefinitionId`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbprocessdefinitionidbcodestring-) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>processInstanceKey</b></code>](#)<Bullet />`string`

> Reference to process instance id
> (renamed equivalent of [`Task.processInstanceId`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbprocessinstanceidbcodestring-) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>tenantId</b></code>](#)<Bullet />`string`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,12 @@ TaskSearchResponse - representing the searched task.
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>creationDate</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

> When was the task created
> (renamed equivalent of [`Task.creationTime`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbcreationtimebcodestring--) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>completionDate</b></code>](#)<Bullet />`string`

> When was the task completed
> (renamed equivalent of [`Task.completionTime`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbcompletiontimebcodestring-) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>assignee</b></code>](#)<Bullet />`string`

Expand All @@ -164,10 +166,12 @@ TaskSearchResponse - representing the searched task.
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>processDefinitionKey</b></code>](#)<Bullet />`string`

> Reference to process definition
> (renamed equivalent of [`Task.processDefinitionId`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbprocessdefinitionidbcodestring-) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>processInstanceKey</b></code>](#)<Bullet />`string`

> Reference to process instance id
> (renamed equivalent of [`Task.processInstanceId`](../../../tasklist-api/objects/task.mdx#code-style-fontweight-normal-taskbprocessinstanceidbcodestring-) field)
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>tenantId</b></code>](#)<Bullet />`string`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ type:"link", href:"/docs/8.4/apis-tools/java-client/", label: "Java client", doc
}
]}/>

:::note
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 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs.
Expand All @@ -60,6 +64,9 @@ type:"link", href:"/docs/8.4/apis-tools/operate-api/overview/", label: "Operate
type:"link", href:"/optimize/3.12.0/apis-tools/optimize-api/optimize-api-authentication/", label: "Optimize API (REST)", description: "Get, delete, and export reports and dashboards, enable and disable sharing, and more."
},
{
type:"link", href:"/docs/8.4/apis-tools/tasklist-api/tasklist-api-overview/", label: "Tasklist API (GraphQL)", docId:"apis-tools/tasklist-api/tasklist-api-overview"
},
{
type:"link", href:"/docs/8.4/apis-tools/tasklist-api-rest/tasklist-api-rest-overview/", label: "Tasklist API (REST)", docId:"apis-tools/tasklist-api-rest/tasklist-api-rest-overview"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ As a general rule, you should assign human tasks in your business process to _gr
</bpmn:extensionElements>
```

Then, require individual members of that group to explicitly _claim tasks_ before working on them. This way, you avoid different people working on the same task at the same time. Refer to `claimTask`.

<!--- To rework. --->
Then, require individual members of that group to explicitly _claim tasks_ before working on them. This way, you avoid different people working on the same task at the same time. Refer to [`claimTask`](../../../apis-tools/tasklist-api/mutations/claim-task.mdx).

```graphql
claimTask(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@ In Camunda 8, [values are stored as JSON](/docs/components/concepts/variables/#v
This best practice describes variable handling within Camunda 8. Process variables are handled slightly differently with Camunda 7. Consult the [Camunda 7 documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/) for details. In essence, variable values are not handled as JSON and thus there are [different values](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/#supported-variable-values) supported.
:::

You can dynamically create such variables by assigning an object of choice to a (string typed) variable name; for example, by passing a `Map<String, Object>` when completing the "Review tweet" task via the API:

<!--- To rework. --->
You can dynamically create such variables by assigning an object of choice to a (string typed) variable name; for example, by passing a `Map<String, Object>` when [completing](../../../apis-tools/tasklist-api/mutations/complete-task.mdx) the "Review tweet" task via the API:

```
// TODO: Double check!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ When the rate limit is triggered, the client will receive an HTTP 429 response.
Currently, Camunda 8 SaaS supports the following scopes:

- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) API.
- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API.
- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md).
- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview).
- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ With Tasklist, orchestrate human workflows critical to your business and reduce

As you model a business process using BPMN and deploy it to the workflow engine, users are notified in Tasklist when they're assigned a task.

Tasklist also provides a [REST API](/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md).
Tasklist provides two APIs: a [GraphQL API](/docs/apis-tools/tasklist-api/tasklist-api-overview.md)
and a [REST API](/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md). Both APIs provide equal capabilities,
allowing you to build your own applications or use the general [UI](/docs/components/tasklist/userguide/using-tasklist.md) that we have prepared for you.

:::note
The GraphQL and REST APIs are currently available, but the GraphQL API will be deprecated in future releases, although it will still receive updates for a limited period. If you are building new applications,
we recommend using the REST API to ensure long-term compatibility.
:::

Tasklist is also available for production use (with support) in the Camunda 8 offering. To try out Tasklist in Camunda 8, sign up [here](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral).
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Here, we'll set up client connection credentials to create, name, and connect yo
Currently, Camunda 8 SaaS supports the following scopes:

- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) API.
- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API.
- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md).
- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview).
- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ The user or user group can be assigned the following permission:

For more information, visit the [Identity documentation](/self-managed/concepts/access-control/resource-authorizations.md).

## Use Identity JWT token to access Tasklist API

Tasklist provides a [GraphQL API](/apis-tools/tasklist-api/tasklist-api-overview.md) under the endpoint `/graphql`. Clients can access this API using a JWT access token in an authorization header `Authorization: Bearer <JWT>`.

:::note
Be aware a JWT token is intended to be used for M2M communication and is therefore issued for the relevant application, not for the user.
:::

**Example:**

1. [Add an application in Identity](/self-managed/identity/user-guide/additional-features/incorporate-applications.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,12 @@ TaskSearchRequest - query object to search tasks by provided params.
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchRequest.<b>processDefinitionKey</b></code>](#)<Bullet />`string`

> Reference to process definition
> (renamed equivalent of [`TaskQuery.processDefinitionId`](../../../tasklist-api/inputs/task-query.mdx#code-style-fontweight-normal-taskquerybprocessdefinitionidbcodestring-) field).
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchRequest.<b>processInstanceKey</b></code>](#)<Bullet />`string`

> Reference to process instance
> (renamed equivalent of [`TaskQuery.processInstanceId`](../../../tasklist-api/inputs/task-query.mdx#code-style-fontweight-normal-taskquerybprocessinstanceidbcodestring-) field).
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchRequest.<b>followUpDateDate</b></code>](#)<Bullet />[`DateFilter`](../models/date-filter-input.mdx)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ FormResponse - represents task embedded form.
#### [<code style={{ fontWeight: 'normal' }}>FormResponse.<b>processDefinitionKey</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

> Reference to process definition
> (renamed equivalent of [`Form.processDefinitionId`](../../../tasklist-api/objects/form.mdx#code-style-fontweight-normal-formbprocessdefinitionidbcodestring--) field)
#### [<code style={{ fontWeight: 'normal' }}>FormResponse.<b>schema</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

Expand Down
Loading

0 comments on commit 11b31cd

Please sign in to comment.