Unique ID's across Benchling Registry
The Registry standardizes the way that you will name each item of a schema
- Descriptive Name: long name to describe what the entity is. Can be user-input or system-generated, see below for more information.
- Registry ID: short name to describe what the entity is. Components of the Registry ID are a (1) Prefix + (2) Number. The ID Number can be user-generated or system-generated
- Alias: old name to describe the entity
You will need to designate a prefix for each schema that will be used to generate the Registry ID.
All ID's must be unique across the Registry and either can be used to reference and link to the entity.
Entities in the Registry can also have multiple aliases. This is often useful if different people have different names for the same entity. Aliases are searchable and can be used to refer to the entity. They also must be unique.
Example: Plasmid Entity with Descriptive name [pBR322 - A.635.G] and Registry ID [TP11696].
Entity Naming Options
You will need to designate a prefix for each schema that will be used to generate the Registry ID. This is often times something like p for plasmid, c for cell line, or something that matches your current naming structure. Every entity will generate a sequential ID based on the prefix (i.e. the first plasmid would be p001, then p002, then p003).
Naming Template Options
Benchling can generate a systematic name based on a combination of field values.
For example, if a cell line has fields vendor, organism, and lot number we can generate a name for a specific cell line that is equal to the values of vendor - organism - lot number. This option is useful if you wish to standardize nomenclature and you don’t want to provide your own name.
- Generate new registry IDs, and replace name according to Naming Template: Benchling generates Registry ID; Benchling replaces Descriptive Name with Naming Template
- Generate new registry IDs, and replace name according to Naming Template and keep old name as alias: Benchling generates Registry ID; Benchling replaces Descriptive Name with Naming Template and stores the old name as Alias (must also be unique)
Example: Naming Template design for an Antibody Entity
- Generate new registry IDs: User provides Descriptive Name; Benchling generates Registry ID.
- Generate new registry IDs based on entity names: Benchling generates Registry ID based on trailing numerical digits in user-provided Descriptive Name.
- Generate new registry IDs, replace name with registry ID: Benchling generates Registry ID; Benchling replaces Descriptive Name with Registry ID.
- Keep existing entity names as registry IDs: Benchling replaces Registry ID with user-provided Descriptive Name.
Note: For historical data, if you are using a numbering system, Benchling can generate an ID based on that number to reduce confusion (i.e. if you already have something up to p945, we will use the existing number as the ID and then new plasmids will pick up at p946).
See the table below for entity naming examples.
Batch Naming Options
Note: Batches are legacy feature. While visible in the UI, the creation of new batch schemas will no longer be available. As child entities offer more functionality than their batch counterparts, Benchling recommends using child entities instead of batches. If you are still using Batches, you can archive them by the process below.
Every batch name is based on the descriptive name or Registry ID of the parent entity.
- Registry ID + number: this creates a name based on the entity’s Registry ID and appends -001, -002, etc.
- Registry ID + date + number: this creates a name based on the entity’s Registry ID and the date the batch was created (i.e. today’s date).
- Descriptive Name + number: this creates a name based on the entity’s descriptive name and appends -001, -002, etc.
Note: Benchling doesn’t support giving a custom, descriptive name to batches. If a custom name is very important, we may consider thinking about this batch as a different entity schema.