Apply Reagent Labels by Adding Reagents to Samples

If your samples are already in Clarity LIMS, you can assign reagent labels by running the Add Multiple Reagents process/protocol step from the Clarity LIMS user interface. Adding a reagent implicitly assigns a reagent label to every sample artifact. The reagent label applied is derived from the reagent type used.

Prerequisites

Before you follow the example, make sure that you have the following items:

• Reagent types that are configured in Clarity LIMS and are named index 1 through index 6.

• Reagents of type index 1 through index 6 that have been added to Clarity LIMS.

• A compatible version of API (v2 r14 to v2 r24).

For more information on indexes with reagent labels, see Find the Index Sequence for a Reagent Label.

Code Example

The following illustrations show the Add Multiple Reagents process, as run from the Operations Interface.

Run the Add Multiple Reagents process

In the Add Multiple Reagents wizard panel, reagents (Indexes 1 to 3) are selected and then assigned to the samples (SAM-1 to 3) in the Sample Workspace, using a click and drag process.

The cells of the Sample Workspace represent the wells of the container used for this process.

When the wizard completes, the Add Multiple Reagents process replaces the input sample artifacts with output analyte artifacts.

In the following illustration, the Name column shows the reagent labels applied to the outputs. These are generated by the default output naming pattern for the Add Multiple Reagents process: {InputItemName}-{AppliedReagentLabels}.

Verify with the REST API

When running the Add Multiple Reagents process, the output analyte artifact names show the reagent label applied, as the output naming pattern in the process configuration uses the {AppliedReagentLabels} variable.

By examining the REST API representation of the Add Multiple Reagents process, you can verify the following information:

• The output analyte artifacts show a reagent-label element matching the name of the reagent type used.

• The input analyte artifacts are not modified and do not have reagent labels added.

• The input analyte artifacts do not have a location element, as they were displaced by the outputs.

• You can only determine that reagent labels were applied. You cannot determine which reagent was applied.

The following shows an example of an output from an Add Multiple Reagents process when viewed with the REST API:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<art:artifact xmlns:udf="http://genologics.com/ri/userdefined"
    xmlns:file="http://genologics.com/ri/file" xmlns:art="http://genologics.com/ri/artifact"
    uri="http://yourIPaddress/api/v2/artifacts/RCY1A97PA1?state=301" limsid="RCY1A97PA1">
    <name>SAM-1-Index 1</name>
    <type>Analyte</type>
    <output-type>Analyte</output-type>
    <parent-process
        uri="http://yourIPaddress/api/v2/processes/AMR-RCX-110819-151-25"
        limsid="AMR-RCX-110819-151-25"/>
    <qc-flag>UNKNOWN</qc-flag>
    <location>
        <container uri="http://yourIPaddress/api/v2/containers/27-12" limsid="27-12" />
        <value>A:1</value>
    </location>
    <working-flag>true</working-flag>
    <sample uri="http://yourIPaddress/api/v2/samples/RCY1A97" limsid="RCY1A97" />
    <reagent-label name="Index 1" />
</art:artifact> 

Although adding a reagent to a sample automatically assigns a reagent label, reagents and reagent labels are independent concepts in Clarity LIMS. There are ways to add reagent labels that do not involve reagents, and that even when using reagents, it is not possible to accurately determine the reagent used based on the reagent label attached to an artifact.