The reagent module may require significant customization and assistance, so it is not included in standard LabKey distributions. Developers can build this module from source code in the LabKey repository. Please contact LabKey to inquire about support options.


The Reagent database helps you organize your lab's reagents. It can help you track:

  • Reagent suppliers
  • Current reagent catalog and expiration dates
  • Current reagent locations (such as a particular freezer, box, etc.)
  • Reagent lot numbers and manufacturers
This topic explains how to install and use the Reagent database, which is based on LabKey Server's reagent module.



  • Acquire the reagent module (see note above)
  • Stop LabKey server
  • Copy the reagent.module file into your /modules directory.
  • Restart the server.


  • Create a new folder or navigate to a folder where you'd like to install the reagent database.
  • Select (Admin) > Folder > Management and click the Folder Type tab.
  • Check the box for reagent and click Update Folder.
  • On the main folder page, enter > Page Admin Mode.
  • Choose Query from the Select Web Part dropdown menu and click Add.
  • On the Customize Query page, enter the following values:
    • Web Part Title: <leave blank>
    • Schema: "reagent"
    • Query and View: Select the radio button Show the contents of a specific table and view and, from the dropdown menu, select "Reagents".
    • Allow user to choose query?: "Yes"
    • Allow user to choose view?: "Yes"
    • Button bar position: "Top"
    • Click Submit.
  • Populate the database with data:
    • Select (Admin) > Go To Module > Reagent.
    • Click initialize within the setup text to open the "reagent-initialize.view"
    • Click the Initialize button.
    • Return to the main folder by clicking the Folder Name link near the top of the page. You'll see the populated Reagent database in the Query web part you created.

Use the Reagent Database


The reagent database contains the following tables:

  • Antigens
  • Labels
  • Lots
  • Manufacturers
  • Reagents
  • Species (holds species reactivity data)
  • Titrations
  • Vials
Click Query to navigate between the tables.

Customize Tables

You can add custom fields (for example, "Expires" or "Price") to the Lots, Reagents, Titrations, and Vials tables. Learn more about the field editor in this topic: Field Editor.

Add New Reagents and Lots

To add new reagents and lots to the database, first you need to add information to these tables:

  • Antigens
  • Labels
  • Manufacturers
  • Species (optional)
Navigate to each table above, select (Insert Data) > Insert New Row for each, and enter the appropriate information in the insert forms.

Next navigate to the Reagent table, select (Insert Data) > Insert New Row and use the Antigen, Label, and Species dropdowns to select the data you just entered above. (Note that you can select multiple species values.)

Next navigate to the Lots table, select (Insert Data) > Insert New Row and use the Reagent and Manufacturer dropdowns to select the data.

Add New Vials and Titrations

To add new vials and titrations, first you need to add lot data, then navigate to the vials table and select (Insert Data) > Insert New Row.

Bulk Edits

To edit multiple rows simultaneously, place checkmarks next to the rows you wish to edit, and click Bulk Edit. Only changed values will be saved to the selected rows.

Was this content helpful?

Log in or register an account to provide feedback

expand allcollapse all