Configuring Task schemas

  • Updated

A Task schema determines the identity and behavior of a task group. To create workflow Task schemas, you must configure a Tasks table and an Outputs table to standardize its task requests and fulfillment. This article explains how to create a Task schema, add task and output fields, and how to configure the task lookup. 

Getting started

You must have Admin access for your organization to create Task schemas.

Create a Task schema

To create a Task schema:

  1. Click your initials in the bottom-left corner to access your settings.

  2. In the menu, hover over Feature Settings and select Workflow Schemas.

  3. On the Task Schemas page, click Create.

  4. Complete the Task and Output sections, then click Create.

The table below describes the fields in the Tasks section.

Field Description
Default responsible team (optional) Automatically assigns a team responsible for the work
Execution template Configure the entry template used to execute tasks. This can only be selected if the task is assigned the Entry execution type.
Execution type Choose how tasks are executed:
  • Direct - A task marked as complete either directly or via the API
  • Entry - A scientist executes a task by creating, submitting, and reviewing a notebook entry
  • Flowchart - A scientist executes a series of ordered tasks, encompassing a complete process
Name Descriptive name that displays in creation menus and search, and is used to generate names for task groups
Owner Controls which organization owns the schema and has permissions to edit
Status lifecycle Determine when tasks are defined as complete. Status lifecycles for tasks are: 
  • Direct Completion
  • Entry
  • Entry review
  • Flowchart
Task group prefix Short prefix used to generate sequential, unique IDs for task groups
Propagate watchers On flowchart tasks, watchers are notified when all tasks in a workflow are completed

To configure an execution template, visit Configuring workflow execution templates.

To learn more about execution types and task status lifecycles, visit Creating task groups.

Add task and output fields

After creating a Task schema, complete the task and output fields.

Task fields specify the information a task requester completes when creating a task group. Output fields standardize the information the task fulfiller shares with the requester. To remove the output schema, click Remove output schema at the bottom of the page.

To add a task or output field:

  1. Click the + icon next to Task fields or Output fields.

  2. Complete the task field information:

    • Enter a field name.

    • Mark the field as Required or multi-select, if applicable.

    • Select the field type from the Definition drop-down menu.

  3. Click to save. Add additional fields as needed.

Flowchart tasks require the user to configure additional information such as which tasks will make up the flowchart and how data will be mapped between them. To continue configuring a flowchart after creating the Task schema, visit Configuring flowchart Task schemas.

Configure the task lookup 

If the task lookup is configured in the schema, the task fulfiller can automatically link an output to its associated task.

To configure the lookup:

  1. Under Output → task lookup, click Configure.

  2. In the Start from drop-down menu, select the output field that the lookup will start with.

  3. To add more lookup steps, click Add lookup step, and use the search and filter to find Registry and Inventory relationships, then click Continue.

  4. Select the object property, then select the task field the property matches to.

  5. Click Done.

Was this article helpful?

Have more questions? Submit a request