This section describes how to add and configure the reagent kits and lots used in your lab, and enable them for use on specific master steps.
Add the reagent kits and lots used in the lab to Clarity LIMS and enable them for use on specific steps. When lab scientists run samples through a step, they can record the reagent lots used.
All users logged into Clarity LIMS can access the Reagents configuration screen. However, their user permissions determine what they are allowed to do in this screen.
By default, only the Administrator role has the Configuration:update permission. For more on user roles and permissions, see User Roles and Configured Role-Based Permissions.
Enabling kits on steps makes them available for use in the lab. When running those steps, the reagent lots used are recorded
When a new reagent kit is added, it is not a requirement to enable it on a step. It can be enabled at any time.
Reagent kit/step configuration is bidirectional. Enable a reagent kit on a step in the following situations:
When adding reagents on the Reagents configuration screen (described in this section).
When configuring a master step or step. For details, see #add-and-configure-master-steps-and-steps.
NOTE: The Configuration:update permission is required to add new reagent kits to Clarity LIMS.
On the main menu, select Configuration.
On the configuration screen, select the Consumables tab, then select Reagents.
On the Reagents configuration screen, select New Reagent Kit.
Type a name for the reagent kit. This name displays in queues of steps on which use of the reagent kit is enabled.
Enter details for the reagent kit to help with future reordering:
Supplier: Enter the commercial vendor name.
Cat. #: Enter the catalog number.
Website. Enter the website of the commercial vendor. When viewing details for the reagent kit, select the link to open the web page in a new browser window.
In the Reagent Kit Use section, the status of the new kit is set to Active. This status means that it is available to be used in the lab (after it is enabled on steps).
Select Save to add the new reagent kit.
The new kit displays in the Reagent Kits list.
On the Reagents configuration screen, in the Reagent Kits list, select the kit to enable on steps.
In the Reagent Kit Use area on the right, compete the following actions:
Select a protocol from the drop-down list. Type the first few letters of the protocol to filter the list.
In the adjacent list, select the step on which to enable the reagent kit.
Enable the control on additional steps, if necessary.
Select Save. The Reagent Kits list now indicates that the kit has been enabled on the selected steps.
On the Reagents configuration screen in the Reagent Kits list, select the kit for which you would like to add a new lot.
Below the Kit Details in the Lots area, select New Lot.
In the Lot Details area, enter the lot name.
[Optional] Enter additional details about the lot, such as the lot number and expiry date.
Specify a storage location and add notes about the reagent lot. For example, use this field to note why a lot is being archived).
Clarity LIMS automatically populates the LIMS ID and Created and Modified dates.
Select Save.
The new lot displays in the Reagent Kits list.
By default, when a new lot is added, the status is Pending. The Status of Reagent Lot slider at the bottom of the Lot Details area controls the lot status.
The status of a reagent kit may be Active or Archived. The status of a reagent lot may be Pending, Active, or Archived.
Note the following details about reagent kit status:
Active reagent kits are in use, or are available for use, in the lab workflows. By default, when a new kit is added, the status is saved as Active.
Archived reagent kits are kits that are not currently in use, or available for use, in the lab workflows. Configuration details for archived kits are saved, so reactivation is easy.
Archived kits are listed at the bottom of the main Reagent Kits list in the Archived Reagent Kits group.
Note the following details about reagent lot status:
Active reagent lots are in use, or are available for use, in the lab. Select the active reagent lots as they record work for a step.
Pending reagent lots have been ordered but not yet received in the lab. They are not available for selection by lab users running steps in Clarity LIMS. By default, when a new lot is added, the status is saved as Pending.
Archived reagent lots have typically expired or been used up. They are not available for selection by lab users. Note the following information:
When the expiry date for a lot has passed, Clarity LIMS automatically archives the lot.
Archived lots that have passed their expiry date cannot be reactivated.
Archived lots display in an Archived Reagent Lots group within the Reagent Kit details list.
In the Reagent Kits list, select the kit to be archived or reactivated.
In the Reagent Kit Use area on the right, select Archived / Active.
Select Save.
In the Reagent Kits list, select the kit containing the lot to be activated or archive
At the bottom of the Lot Details area on the Status of Reagent Lot slider, select Active / Archived.
Select Save.
In the Reagent Kits list, select the reagent kit or lot to delete.
In the Kit Details/Lot Details area on the right, select Delete.
When deleting reagent kits and lots, keep the following in mind:
Only reagent kits and lots that have not been used in a step can be deleted.
If a kit or lot has been recorded in a step, or is being used in a step, it cannot be deleted. The Delete button is not enabled.
On the Reagents configuration screen, select Upload Reagents Kit Lot.
If a reagent lot list is not readily available, select the Download a reagent lot list template link to download a reagent lot list template. Open the template file in Excel, populate it with the reagent lot details, and save the file. For details, see Reagent Kit Lot Manifest for Batch Import.
In the Upload File dialog, select Choose File and browse to and open the reagent lot list file.
Select Upload File.
As part of the upload process, Clarity LIMS validates the file to make sure the reagent kits are already in the system. If the file contains invalid data, an error message displays.
When the upload process completes, the reagent lot display in the Reagent Kits list.
This section describes how to batch create reagent kit lot to the LIMS by importing a Reagent Kit lot list - a Microsoft® Excel® *.xls or *.xlsx spreadsheet file.
The reagent kit lot list must be in *.xls or *.xlsx format.
The following column header names and its row position cannot be changed: Reagent Kit Name, Lot Name, Lot Number, Expires, Location, Notes and Lot Status.
The following columns must be populated: Reagent Kit Name, Lot Name and Lot Number fields.
The reagent kit name provided must correspond to a pre-existing and unique reagent kit in Clarity LIMS.
Updating of existing reagent kit lot information is currently not supported.
Download the reagent kit lot list template from the Configuration > Reagents page in Clarity LIMS.
Open the reagent kit lot list template.
By default, the template contains the following information:
Column headers (Row 4)
These headers must reference the names of the fields containing the information to capture for a reagent kit lot. Editing the column headers or creating additional headers will results in reagent kit lot manifest file import error.
Populate the columns with the information associated with the reagent kit lot. Enter the data starting from row 5 onwards.
Save the file and import it to reagent kits.
The import process aborts, if the reagent kit lot list contains one of the following
specifies a reagent kit name that does not exist in Clarity LIMS
specifies a reagent kit name that has more than one reagent kits with the same name in Clarity LIMS
An asterisk indicates a *mandatory field.
Regular font, without an asterisk, indicates an optional field.
The following column headers can be used in the sample list:
*Reagent Kit Name —Specify the name of the reagent kit. When specifying a value for this column, verify it exists in the system already. For instance, you can specify Illumina DNA PCR-Free Prep as a value, provided this reagent kit is configured in the system.
*Lot Name —Specify the name to use for this reagent kit lot. If there are duplicate lot names for the same lot number in the spreadsheet or already existed in the system, expect an error message. The message provides information on this error condition. No reagent kit lot is imported until duplicate names are resolved.
*Lot Number —Specify the lot number of the reagent kit to use for this lot.
Expires —Add an expiration date (Date format required) to this reagent kit lot number. Values for this column are optional. However, if Lot Status is set to Active or Archived for corresponding row that is missing value in Expires column, expect an error message. The message provides information on this error condition.
Location —Add a storage locate to this reagent kit lot. Values for this column are optional.
Notes —Add a description/note to this reagent kit lot. Values for this column are optional.
Lot Status —Add a status to this reagent kit lot by selecting Pending, Active or Archived from the drop-down list. Empty value will be defaulted to "Pending" status.