Configure a Result Table with JSON

  • Updated

Note: We're continually improving the Benchling platform to ensure it keeps up with our customers' needs. As of October 29, 2021, we replaced Results tables with an updated version. If you are currently using this version of Results tables and want to learn more, contact your organization's Benchling admin or Customer Success representative. If you are new to Results tables, visit Using Results tables.

Core Considerations

Note: Only organization level admins are able to configure Result tables.

In order to ensure database clarity and also prevent the proliferation of data silos we recommend creating new Result schemas only when you want to capture data for a new assay that is not addressed by existing Result schemas.

Conversely, you should Not create new Result schemas when:

  • You want to rename a Result schema. Please contact your Customer Success Manager, who can arrange for the schema to be renamed.

  • You want to permanently remove a field from a Result schema or change the data type of a field. To do so, archive the field.

  • You want to remove a field from a Result schema but only under certain contexts. You can simply remove the field from the Notebook entry/template, workflow stage entry/template that the Result table lives in.

  • You want to add new fields to an existing Result schema. You can simply add the fields to the schema. Exception: When adding a new Required field to a Result schema with prior data recorded, a new Result schema will be needed.

Best Practices

  • When creating a new version of an existing Result schema, name the new version with a v# (i.e. Cell Proliferation Assay v2).

  • Notify members of your organization of the updates you are making immediately, so that they can update any related Notebook entry templates or Workflow templates with the updated Result tables.

Creating a new Result schema

First navigate to your Avatar in the bottom left hand corner > Feature Settings > Results Schemas. Click Create in the top right hand corner to initialize the new schema.

Now, input a name for the Result schema and select Entity under Primary Sample. Finally, set the Column Name to the entity the results are being recorded against (e.g. Plasmid). Click Create once this data has been input.

Add fields to a Result schema

Select the Configure Result Table icon. This will open up the Result table configurator.

To configure the Results table, right click on the column header named Untitled and Insert Column Left / Insert Column Right to add a new column to your Results table schema. From here you can also rename the column. Please omit special characters from the name (i.e. %&@) in the configurator but, these can be added to the display name using the JSON spec box.

For information on how to reorder the Result table’s columns, look here.

Edit a field’s data type

To edit the data type of your fields, right click the desired column header and select Edit Type. Once all the desired fields are added and the data types set, please select Publish to save the changes.

A brief description of some available non-standard data types:

  • Datetime: Allows you to select a specific time in a clock interface.

  • Entry Link: Link to a Notebook entry.

  • Blob Link: Allows you to upload an external file into the designated field.

  • Storable Link: Link to a container, box, or inventory location.

  • Result Links: Used in integrations. Please contact Benchling directly for more information.

Note: To make a field a Dropdown data type, you will have to do this in the JSON spec box, see this article for instructions.

Change display names, set required fields, toggle multiple select & use lookup fields

To customize the display name of a field, make sure to edit the value for the "displayName" line.
To designate a field as required, set the value for "isRequired" to true.
To designate a dropdown or link-type field as multiple select, change the value for "isMulti" to true.

To insert Lookup Columns follow this tutorial: Lookup Columns and Tables.

Lookup Columns were built to make it easier for you to reference existing structured data such as entities, metadata, results or inventory items in your registration and/or result tables.

Both Lookup Columns and Tables allow you to conveniently view information about your sample while you are running your experiment, without having to leave your entry.
To set minimum and maximum thresholds for your floating point data type fields, follow the instructions in this tutorial.

Float fields can now also be configured to a desired precision level by using the string "decimalPrecision" : (integer that specifies desired precision). For example, “decimalPrecision”: 3 would record results to the thousandths position, 0.000.
To configure escape values for your floating point fields (i.e. ERROR, N/A, LOQ), please follow the instructions in this tutorial.

Update and finalize your Result schema

Once all edits are made, click on Update to finalize your Result schema. It can now be used in workflows, entries, or templates!

Was this article helpful?

Have more questions? Submit a request