Skip to content

Commit

Permalink
Update documentation snapshots and description (#3930)
Browse files Browse the repository at this point in the history
* Update documentation snapshots and description

* Remove not needed snapshot

* Update the snapshot for processes in 8.5 release
  • Loading branch information
volodymyr-melnykc authored Jun 12, 2024
1 parent 2a07b77 commit 411d90d
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Task applications are the interface between humans and Camunda pro
---

import TasklistProcessesImg from './img/tasklist-processes.png';
import TasklistDetailsImg from './img/tasklist-details.png';
import TasklistDetailsImg from './img/tasklist-page-specifications-detailed.png';
import TaskAssignmentImg from './img/task-assignment.png';
import styles from "./styles.module.css";

Expand Down Expand Up @@ -39,19 +39,22 @@ The Tasklist UI is split into two main pages: the [tasks page](#task-page) and t

The task page lists all tasks pending for a user or user group, and allows users to pick and claim a task from that queue to work on. On the same page, the details of a selected task are displayed including the form that the user must submit in order to execute and complete the task. The task page is optimized for efficient workflows, where the most important tasks should be worked on first.

The task page is divided into two panels, similar to the layout of messaging clients:
The task page is divided into two main areas:

- Left side showing the tasks queue.
- Right side showing the details of the selected task.

<img src={TasklistDetailsImg} className={styles.noShadow} alt="Task details page in Tasklist" />

#### Task queue side panel
#### Tasks queue

The **task queue side panel** lists all tasks pending for a user or user group. It comes with filter and sort options that allow users to identify the right task to work on next. The tasks can be sorted by the creation date, due date, or follow-up date.
The **tasks queue side panel** lists all tasks pending for a user or user group. It comes with filter and sort options that allow users to identify the right task to work on next. The tasks can be sorted by the creation date, due date, or follow-up date.

Learn more how to work with the task queue in the [Tasklist user guide](/components/tasklist/userguide/using-tasklist.md).

#### Task details panel
#### Task details

The **task details panel** shows the details of the selected task. A [form](/guides/utilizing-forms.md) is displayed in the center of the details panel, which must be filled out to complete a task.
Task details are shown when a task is selected from the queue. A [form](/guides/utilizing-forms.md) is displayed as the task content, which must be filled out to complete the task.

:::tip
Typically, a task application utilizes forms to capture information from the user, to make a decision, to collect the results from a real-world task, or to provide task instructions to the user.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,6 @@ Our best practices, as implemented in Tasklist, are as follows:
- Task agents can return tasks, but must provide a comment as to why they are doing so.
- Task agents can mark tasks with a follow-up date. These then disappear from their individual task list until the follow-up date is reached. The `open` status is preserved, or the task is moved to the `paused` status if it has already been processed. The task remains assigned to the user.

The following image demonstrates how this is similarly implemented in the Tasklist user interface:

<img src={TaskLifecycleUI} style={{width: 600}} alt="Task life cycle and assignment in the Camunda Tasklist UI" />

Make sure that you create your own validation logic that matches your use case.

## Implement the life cycle with the task API
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,6 @@ Our best practices, as implemented in Tasklist, are as follows:
- Task agents can return tasks, but must provide a comment as to why they are doing so.
- Task agents can mark tasks with a follow-up date. These then disappear from their individual task list until the follow-up date is reached. The `open` status is preserved, or the task is moved to the `paused` status if it has already been processed. The task remains assigned to the user.

The following image demonstrates how this is similarly implemented in the Tasklist user interface:

<img src={TaskLifecycleUI} style={{width: 600}} alt="Task life cycle and assignment in the Camunda Tasklist UI" />

Make sure that you create your own validation logic that matches your use case.

## Implement the life cycle with the task API
Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 411d90d

Please sign in to comment.