Workflow definitions

How to define a workflow in the BUILD module.

Written by Eduardo Abeliuk
Updated over a week ago

As we saw previously, a workflow in the BUILD module is essentially a list of tasks that you chain together to achieve a goal. This concatenation of tasks could be used many times by all the members of a lab group once it is defined beforehand. Thus, a workflow definition was thought of as a useful template with pre-determined tools in direct interaction with the inventory and the machines (data tables, resources and worklists) to optimize the real workflows in your laboratory. 

Let’s take a deeper look at how to define a workflow on the BUILD module and see how it actually works. 

Setting up a workflow definition

To start defining a workflow in the BUILD module just click on your avatar at the top right-hand side of the screen and select the “App Settings” option.

Then choose “Workflow Definitions” from the left menu and select the “New Workflow Definition” option:

The image below shows the Workflow Definition view. Here you can define a workflow in three simple steps:  

1. Add a title to your workflow definition by clicking on the "Untitled Workflow Definition" area and type in a descriptive name. 

2. Just below, you can write a short description of the new workflow by clicking on the "Workflow Definition Description" area. 

These two steps are not mandatory, but they are necessary for later identification and "execution".

3. You concretely perform the definition by clicking the “Add Task” button, this will open a pop-up window like the one shown in the image below. Here you can choose among a variety of predetermined tools. Scroll down until you find the tool you need or you can search for a specific one by entering a keyword in the field with the magnifying glass icon, to add the tool just click on it.

It is important to note that all these tools can also work independently and can be accessed from the tool library by clicking the "Tools" category on the top menu bar of the BUILD module. For more information about the tools you can visit this collection of our base knowledge. 

The order in which the tasks are added determines the order in which they will be executed, but if you want to rearrange that order, simply click and drag the task you want to move up or down in the list on the right side. You can also delete a task you already added by clicking the trash icon next to it. 

In the image above, you can see a selection of tasks for a hypothetical Golden Gate Assembly (GGA) workflow. Once you have added all the necessary steps to your list, click "Submit".

Verify your workflow definition

The order of the tasks establishes the relationship between their outputs and inputs and you can also setup in advance which output from a previous tool each subsequent tool will use as input. Let’s see that in detail with the hypothetical GGA workflow. 

In this case, the input to start the workflow is a DNA assembly report for further amplification by PCR: 

As you can see in the image below, the outputs from the “PCR Planning and Inventory Check” task are actually the inputs to perform the “Run PCR” task. Generally, for each step you can choose the sources (Data Tables, DNA Assembly Reports, Reactions Maps, Plates and Worklists) from which each tool takes the data and performs the task. You can select the “User Defined” option and choose manually or upload the data when you run the workflow or you can select the “Preset” option and indicate the sources beforehand. Every change you make while setting up your workflow definition will be automatically saved, actually you'll see a “Saved” pop-up notification in the upper right-hand corner.

It's important to notice that when a workflow definition is being used by a workflow run it gets locked, which means that you can’t edit or delete it, but you can always create a duplicate and redefine this one. In order to do that click the “Duplicate” button located at the top right and edit this new template just as we have seen so far. 

Once you completed and verified all these aspects of the workflow configuration, you finally have a workflow definition available for an infinite number of runs. The only difference between workflow executions is the data that gets passed through the tasks.

Now, in order to actually perform this workflow, go to the "Workflow" option in the top menu bar and select "Runs", then click the “New Run” button and choose this new template. If you need guidance, we will address how to proceed with the "Workflow Run" in the next article.

Did this answer your question?