Human task queues

When a Human task is created, it references a specific queue. A Human task queue is defined by a folder and a name, and it can have optional email addresses to notify users of new tasks. Email notifications are sent from a default sender, which is configured using the config.mail.from parameter of the values.yaml file. The parameter contains an email address, and it can optionally contain a display name in the following format:

config.mail.from = DisplayName <email@address.com>

For example:

config.mail.from = John <noreply@uno.com>

In this case, the recipient sees emails originating from John with the sending address noreply@uno.com.

When defining a queue, you can customize its notification behavior by overriding the global settings. The following optional parameters are available:

Group email: An optional email address designated to receive notifications whenever a new task is generated and assigned to the associated queue.
Sender name: An optional display name used for email notifications originating from this specific task queue. If specified, this name overrides the global display name defined in config.mail.from. The email address from config.mail.from, however, remains the sending address. This allows for more specific sender identities (for example, "HR Approvals") while maintaining a single, verified sending address for the system.

Each queue is assigned a mandatory and immutable prefix, which is crucial for creating unique task IDs for Human tasks generated from that queue, followed by a progressive number.

Queues have a set of permissions to control user access and actions:

Base model permissions

Note: USE permission is required for a user to reference a queue when creating a Human task.

Task-related permissions

MONITOR: With MONITOR permission, a user can retrieve human tasks in a queue that are waiting for completion.
POWER_USER: With POWER_USER permission, users can assign tasks to themselves if unassigned, or unassign tasks from themselves. Users with POWER_USER permission are also granted MONITOR permission.
ADMIN: With ADMIN permission, a user can assign, unassign, or reassign tasks to and from anyone. Users with ADMIN permission are also granted POWER_USER and MONITOR permissions.

Note: Assignment and unassignment actions are not permitted if the Human task is in an OPEN status with the pendingCompletion flag active or in a final status.

Queue management

You can create and manage queues in different ways:

From the Orchestration CLI, using Model commands. A Human task queue definition has the following format:

YAML

---
kind: HumanTaskQueue
def:
  folder: <mandatory>
  name: <mandatory>
  description: <optional>
  prefix: <mandatory>
  groupEmail: <optional>
  senderName: <optional>

SCHEDLANG

$humantaskqueue
HUMAN_TASK_QUEUE [folder/]humantaskqueue_name
  DESCRIPTION ["description"]
 PREFIX "prefix"
  GROUP_EMAIL group_email
  SENDER_NAME sender_name
END

From the UI, as described in step 1 of Managing a Human task from the UI;
Using REST APIs, at the following path: /twsd/api/v2/model/humantaskqueue