Task Assignee

The assignee id and assignee type fields represents the user or entity who the task is assigned to at a given point in the workflow. A task-assigned event is published when the assignee changes, but other than that AireFlow itself does not rely on either property for anything, but other systems such as AireFrame can use it.

assignee id and assignee type are optional properties.

How it’s set

The assignee id and assignee type can be assigned or updated through several mechanisms:

1. Workflow definition

   • assignee id and assignee type can be configured for each task in the workflow builder.
   • Supports dynamic expressions (e.g. XPath or Liquid), similar to other configurable fields like name or owner.

2. API updates

   • The assignee id and assignee type can be modified at runtime via the PATCH API or via a Mutation.

Assignee Type

When using the assignee to refer to an AireFrame user, the assignee type field should be used to keep track of the type of AireFrame user so the user can be rendered correctly. AireFrame supports the following types:

• User - Looks up the ID against AireAuth and shows the user’s display name
• Subject - Looks up the ID against AireFrame subjects and shows the primary field value
• Subject Proxy - Looks up the ID against AireAuth and shows the user’s display name
• External - Shows as [Id] (External)
• Client Credentials - Shows as [Id] (System)
• System - Shows as [Id]
• Unknown - Shows as [Id]

Example

• Task is defined with assignee = User1
• Task assignee is updated via the API assignee = User2
• Task emits a Task Assigned event