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 the user-entered fields on the run. Run schema fields can be configured either by the point and click interface or through the raw JSON, similarly to how fields on a Request or columns in a Result table are configured. They are configured similarly to how fields on a Request or columns in a Result table are configured. They exist as a part the Lab Automation run and contain an array of fields separated by {}. The fields answer the question: what information is needed to generate an input file that can instruct the instrument.

The run schema fields must be saved first before configuring the automationInputFile.

Configure the run schema fields

Begin by clicking the “+” next to Run fields. You will then be able to:

  • Provide the display name of the field.

  • (Optionally) Indicate the warehouse name.

  • Required fields: this checkbox will make a field value required at the time a run is created (i.e. if the field value is blank, then a run cannot be created).

  • Multi-select fields: this checkbox will enable inputting more than one dropdown option or entity link in a field value.

  • Select the field type.

For more information on schema fields please read this help article on the Registry.

Alternatively, run fields can also be constructed similar to how the fields on a Request or Result schema are constructed. You can create these fields by selecting the Edit as JSON option and using a format as shown below:

"fields": [
{
"displayName": "",
"name": "",
"isMulti": ,
"schemaId": "",
"isRequired": ,
"type": ""
}
]

If you are interested in the types of fields that can be configured for run schemas, please see here for more information.

Take a look at the JSON that we used to configure the Plates and the Volume Change (uL) schema fields. Notice how:

  • The object encoding the Plates field includes a value for the API ID of the 96-well plate schema we used

  • The "Plates" field is configured as a "storage_link"

  • Both fields are required

"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
}
]


This same configuration can also be captured as shown below:

Screen Shot 2021-04-15 at 4.09.54 PM.png


Did this answer your question?