This topic is under construction for the 21.10 (October 2021) release of LabKey Biologics. For the previous version of this documentation, click here.

This topic covers how an administrator can create new Data Classes in the Bioregistry and edit the fields in the existing data classes, including all built in Registry entity types and Media designs.

Definitions

The term Data Class applies to all of the following entities in the Biologics application. These are two of the categories of data class available in LabKey Server. Within the Biologics application you cannot see or change the category of a Data Class, though if you access these structures outside the application you will be able to see them.

  • Registry Types: (Category=registry)
    • CellLine
    • Construct
    • ExpressionSystem
    • MolecularSpecies
    • Molecule
    • MoleculeSet
    • NucSequence
    • ProtSequence
    • Vector
  • Media Types: (Category=media)
    • Batches
    • Ingredients
    • Mixtures
    • Raw Materials

Edit Existing Data Classes

The default set of data classes in Biologics are designed to meet a common set of needs for properties and fields for the Bioregistry and Media sections.

If you want to customize these designs, you can edit them within the Biologics application as follows.

Open the desired data class from the main menu. All entries under Registry and Media are editable. From the menu, select Edit [Data Class] Design. In this example, we'll edit the Molecules design:

You cannot edit the Name of a data class, but can update the Description and Naming Pattern if desired.

Click the Fields section to open it. You'll be able to adjust the fields and their properties here.

When finished click Finish Editing [Data Class] in the lower right.

Create New Registry Type

From the main menu, click the Registry heading. Select Create > Registry Type.

Define the Data Class Properties:

  • Name: (Required) Must be unique and cannot be changed after data class creation.
  • Description
  • Naming Pattern: Naming patterns are used to generate unique IDs for every member of this type.
    • Learn more in this topic: Naming Patterns.
    • It is best practice to use a naming pattern that will help identify the registry type. Our built in types use the initials of the type (like CL for Cell Lines, etc).
    • For example, to use "DC-" followed by the date portion of the time the entity is added, plus an incrementing number you could use:
      DC-${now:date}-${genId}
Click the Fields section to open it, then import, infer or manually define the fields you need using the field editor.

When finished, click Finish Creating Data Class.

Delete Custom Registry Type

You cannot delete the built in Registry (or Media) types, but if you add a new custom one, you will have the ability to delete it.

Click Registry on the main menu, then click the tile for the custom registry type to delete. Select > Delete [Registry Type]**.

Deleting a data class cannot be undone and will delete all members of the class as well. You will be asked to confirm the action before it completes.

Related Topics

Discussion

Was this content helpful?

Log in or register an account to provide feedback


previousnext
 
expand all collapse all