Archiving Result schemas
Archiving a Result schema prevents inserting new Result tables with the schema.
However, users may continue to create new results of the archived schema with:
- Result tables of the archived schema that already exist in Notebook entries or templates
- Lab Auto runs already configured to create Results of the archived schema
- The API
Archiving a Result schema does not:
- Remove any tables or data from the Warehouse
- Archive Results recorded against the schema
By default, results of archived schemas are hidden from the Results tabs of linked entities, studies, and containers, even if the results remain unarchived.
To show unarchived results of archived schemas on Results tabs, contact Benchling Support to enable the RESULTS_SHOW_ARCHIVED_SCHEMAS_ON_RESULTS_TAB flag.
Archiving Result schema fields
Archiving a Result schema field does not remove any data, but limits where the field is shown.
After archiving a Result schema field, the field will no longer appear in:
- The Results tabs of linked entities, studies, and containers
- Newly inserted Result tables in Entries
- The non-$raw Warehouse table for the Result schema
- Newly completed Lab Auto runs
- API responses
After archiving a Result schema field, the field will continue to appear in:
- Existing Result tables in Notebook entries
- The column header for the archived field will show a purple out-of-date indicator.
- Existing Result tables in Notebook templates, and in entries created from those templates
- The column header for the archived field will show a purple out-of-date indicator.
- Result tables in existing Notebook templates should be updated to remove the column for the archived field. When editing a Result schema, click on the "Relevant templates" tab to find templates with Result tables that need to be updated.
- Already completed Lab Auto runs
- The $raw Warehouse table for the Result schema
For how to archive a schema field, see Archive a schema field.
Archiving a computed (snapshot) field
When a computed (snapshot) field on a Result schema is archived, it becomes a regular field. Existing values are preserved, but new values will not be computed.
After archiving, the former computed (snapshot) field cannot be turned into a computed (snapshot) field; unarchiving the field will not revert it to being a computed (snapshot) field.
Archiving a required field
Required fields cannot be archived. To archive a required field, first make the field non-required.
If the Result schema has been used to create results, the field cannot later be made required, without contacting Benchling Support.
Archiving a link field
Results recorded against an entity will continue to show on the entity's Results tab, even if the link field in which the entity was recorded has been archived. The archived field will, however, be hidden on the Results tab.
Hiding columns on Result tables
Individual columns can be hidden from a Result table in a Notebook entry or template.
Hiding a column does not change the Result schema, or hide the field elsewhere in Benchling.
To hide a column, click on the column’s header and select “Delete column”.
If the Result table is a new result table (i.e. it has a “Submit” button), “Delete column” will hide the column from the table, but not remove any submitted values.
If the Result table is a legacy result table (i.e. it lacks a “Submit” button) and the field is optional, “Delete column” will clear the values from the results.