You can use naming templates to standardize the nomenclature of your samples to one intuitive naming format, saving time when searching through metadata fields to determine key information about a sample.
This article explains how to configure naming templates and provides best practices for common use cases.
Configure Registry Entity schema naming templates
Naming templates for Entity schemas are set at the schema-setting level. You can navigate here via Your Avatar > Feature Settings > Registry Settings > the entity schema of your choice. For creating a new schema, see What is the Registry? article.
Once you’ve identified an existing schema, click Set name template.
Entity schema naming template options
Naming templates can be configured with various components as shown below. The components available will vary depending on the schema you are setting a Naming Template for.
|For symbols to separate the components of your name template. Example: “-”, “_”, “ “
|For any character you’d like displayed in the name template. Example: “PL”
|Parent Lot number: parent schema name
|Only an option if the schema has a parent schema. This lot # will be automatically generated by Benchling based on the number of lots (children) created from one entity (parent).
|Field: schema field name
|Present if schema has schema fields. Text displayed in the UI for any schema field. Entity link fields will render the entity name in the naming template.
|Registry ID: Parent Plasmid
|Only an option if the schema has a parent schema. Numbers at the end of a registry value string of the parent entity
|Registry ID number
|Numbers at the end of a registry value string
Common use cases
|Naming template configuration
|Example entity name
|Tracking lots of a parent entity
|Leveraging Date fields
|Delineating by Tissue Type
Enforcing naming templates
After a naming template is set, the registration naming option “Generate new registry IDs, and replace name according to name template” is selected. Other options present remain checked when the template is applied. To enforce a naming template for all entities upon registration, ensure no other options are selected, as in the image below:
For more information on registration naming options visit Choose a naming option for your Registry schema.
Configure Inventory Container schema naming templates
Naming templates for Containers are set on the Entity Schema configuration page. This means that container name templates depend on the entity type they contain.
To set a container naming template, navigate to Your Avatar > Feature Settings > Registry Settings > the entity schema of your choice
Once you’ve identified an existing schema, click Container name template at the bottom of the page.
Container name templates can only be applied to “containable” entities. To make an entity schema “containable”, click Entity in the “Containable Type” dropdown above the “Container name template” section as shown the image below.
Container schema naming template options
Below is an example of a container naming template configuration window and the definitions for each component. Components will vary depending on the schema you are setting a Container Name Template for.
|Name of the entity(s) in the container
|Any metadata field configured on the entity, excluding computed fields
|Sample aliquot number
|Aliquot # based on the number of containers created from one entity
|Registry ID of contained entity
|Registry ID Number
|Only the numbers at the end of a registry value string
|Barcode of container. Either autogenerated or defined by user upon creation of container
|Only the numbers at the end of the barcode value string
|Concentration value of the contents in the container
|Concentration units of the contents in the container
|Date the container was filled with the first contents, which should be the same date that the name template was applied
|Year the container was filled with the first contents, which should be the same date that the name template was applied
|Parent location barcode
|Barcode of parent location. Such as box, shelf, freezer, etc. Note that this will not update if the container moves locations
|Parent location name
|Name of parent location. Such as box, shelf, freezer, etc. Note that this will not update if the container moves locations
|Position of container if within Box or Plate
|Project folder of contents
|Quantity of contents
|Unit of recorded content quantity
|Restriction status of container. Example: “Unrestricted”, “Restricted”, “N/A”
Behavior in the Inventory
- Transferring contents between containers: When the destination container is empty and the source container has multiple contents, the same name template chosen for the source container will be applied to the destination container.
- Multiple contents within a container: The naming template of the entity transferred in first will be applied to the container.
- Empty name generated by the naming template: If there are no values for the configured name template, an error will appear and prevent you from creating the container.
Common use cases
|Naming template configuration
|Example container name
How do I apply container naming templates to existing containers in bulk?
Contact your Benchling Account team or firstname.lastname@example.org to update existing containers in bulk based on the new naming template. Note that this action cannot be undone, and will be traceable in the container’s audit log.