Configure the fields for a Lab Automation run

  • Updated

Note: Please read “Configure a lab automation run” for more general information about configuring the lab automation run.

What are run schema fields?

The run schema fields refer to user-entered fields on a run and are configured in a similar manner to Registry and Results schemas. They exist within each Lab Automation run and contain an array of fields separated by brackets. By examining the fields, users can find the information needed to generate an input file that instructs the instrument.

Note that run schema fields must be saved before configuring the automationInputFile.

Configure the run schema fields

Run fields are constructed using the following format:

"fields": [
"displayName": "",
"name": "",
"isMulti": ,
"schemaId": "",
"isRequired": ,
"type": ""

To learn more about run schema fields, visit Configure a Lab Automation run.

Configuring Fields Within the UI

Configure run fields directly in the UI. The image below is an example of a plate and volume change (uL) UI schema field configuration.

Screen Shot 2022-03-28 at 11.39.32 AM.png

To configure run fields:

  1. Click ➕ next to Run fields.

  2. Enter the field name. The warehouse name is based on this name.

  3. Check Required and/or Multi-select, depending on the field criteria.

  4. Define the field type using the dropdown menu.

Configuring Fields Using JSON

Below is an example JSON spec used to configure plate and volume change (uL) schema fields. Notice that:

  • The object encoding the plates field includes the API ID of the 96-well plate schema used

  • The Plates field is configured as a "storage_link" since we will be storing entities within our plates

  • Both fields are required to ensure that all runs are proceeding in a standardized manner across the lab

"fields": [
"displayName": "Plates",
"name": "plate",
"isMulti": true,
"schemaId": "pltsch_abc123ef",
"isRequired": true,
"type": "storage_link"
"isMulti": false,
"type": "integer",
"displayName": "Volume Change (uL)",
"name": "vol",
"isRequired": true

Was this article helpful?

Have more questions? Submit a request