Labels

This section describes how to add and configure label groups (reagent categories) and labels (reagent types or molecular barcodes), and enable them for use on specific master steps.

Labels Configuration Screen

Add a label group for each reagent category used in your lab, and then add labels to the groups. Each label represents a reagent type (or molecular barcode) within the group/category.

Select the label groups to be used in the step when configuring the properties of steps generated from an Add Labels master step type.

To access the Labels configuration screen, the Configuration:update permission is required. Users who do not have this permission do not see the Labels option displayed under the Consumables tab.

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.

Configuration: Update Permission Access

• View existing label groups and labels and their details.

• Add new label groups and labels.

• Edit and delete label groups.

• Edit and delete labels.

Access the Labels configuration screen and View Label Groups

1. On the main menu, select Configuration.

2. On the LIMS configuration screen, select the Consumables tab, and then select Labels.

3. All label groups configured in the system are listed alphabetically in the Label Groups area on the left.

   • Each label group corresponds to a reagent category that exists in the system.

   • Each label group displays a count of the labels (reagent types) present in that particular group.

   • Select a label group to view its details on the right.

Add and Configure Labels and Label Groups

When adding label groups and labels to the LIMS, there are several main steps involved:

1. Add a new label group.

2. Then, to add labels to the group:

   • Download a template label list (Microsoft® Excel® file) from the Labels configuration screen.

   • Add reagent type details to the downloaded template.

   • Upload the completed label list.

Add a New Label Groups

1. On the main menu, select Configuration.

2. On the configuration screen, select the Consumables tab and then select Labels.

3. On the Labels configuration screen, select New Label Group.

4. In the Label Group Details area, enter the name of the label group you are adding.

   • Numeric names are not permitted.

   • Duplicate names are not permitted.

   • You may use the name of a previously deleted label group.

5. Select Save.

   • The new label group is listed in the Label Groups list. Because there are no labels in the group, no count displays.

   • The Upload Label List and Download Label List buttons display in the Label Group Details area.

Add Label to Label Groups

1. On the Labels configuration screen, in the Label Groups list, select the label group to which you want to add labels.

2. In the Label Group Details area, select Download Label List to download the template.

3. Open the template in Excel. It has two example label entries containing the following information:

   • Group Name (column A): Prepopulated with the name of the label group you selected in the LIMS.

   • Label ID (column B): No information is provided in this column as it is populated by the LIMS.

   • Label Name (column C): Provides examples of label name (reagent type) formats.

   • Sequence (column D): Provides examples of sequence properties of theIndex special type of the reagent type. Dual-indexes may be used, separated by a hyphen.

4. To complete your label list, add new rows between the opening and </LABEL ENTRIES> closing tags and enter reagent label information into these rows:

   • Group Name: (Required on upload) Enter the name of the label group (reagent category) into which you are adding labels.

   • Label ID: Leave this column empty. It is populated by the LIMS when you upload your completed label list.

   • Label Name: (Required on upload) Enter the names of the reagent labels (reagent types) you would like to add to the LIMS, using one of the example formats.

   • Sequence: (Optional on upload) Enter the index sequence of the Index special type of the reagent type, for example, "ATCACG." You may enter dual-indexes, separated by a hyphen.

5. Save your label list file.

   • Return to the Labels configuration screen, select Upload Label List and upload your completed labels list. If there are errors in the list, the upload does not complete. Refer to #label-list-upload-error.

   • In the Label Groups list, the label count shows the number of labels in the group.

Edit and Delete Label Groups

When editing/deleting label groups, keep the following in mind:

• The only item you can change directly in the LIMS is the label group name.

• To make changes to the labels within the group, you must upload a modified label list. See Edit and Delete Label.

• Deleting a label group does not affect historical run data. This information is preserved in the LIMS.

Edit Label Groups

1. On the Labels configuration screen, in the Label Groups list, select the label group you would like to edit.

2. Select inside the Name field and enter the new name.

3. Select Save.

Delete Label Groups

1. On the Labels configuration screen, in the Label Groups list, select the label group you would like to delete.

2. In the Label Group Details area, select Delete.

3. Confirm the deletion.

Edit and Delete Label

When editing and deleting labels (reagent types), keep the following in mind:

• Changes you make to a label are reflected on all future steps on which the label is applied.

• Steps that have already been run are not affected by changes you make to labels. The labels are mapped to samples in the run and historical run data are preserved.

Edit Label

1. On the Labels configuration screen, in the Label Groups list, select the label group containing the labels you would like to edit.

2. Download the existing label list from the Labels configuration screen.

3. Edit the downloaded label list. Note the following:

   • If adding new labels to the label group, the modified label list must also include the rows for the existing labels.

   • If modifying existing labels, the modified label list must also include the rows for labels that you are not modifying.

   • If you omit rows from the label list, these labels are deleted.

   • Upload the modified label list. See Label List Upload Error Conditions.

Delete Label

1. On the Labels configuration screen, in the Label Groups list, select the label group containing the labels you would like to delete.

2. Download the existing label list from the Labels configuration screen.

3. Edit the downloaded label list, removing the rows containing the labels you would like to delete.

4. Upload the modified label list. See Label List Upload Error Conditions.

Label List Upload Error Conditions

When uploading a label list, the following conditions result in an error:

• One or more of the four headers (Group Name, Label ID, Label Name, Sequence) is missing or misspelled.

• Attempting to rename a label to the same name as an existing label within any label group.

• Attempting to rename a label to the same name as an existing label—even if you are also renaming the other label at the same time.

• Adding a label with the same name as another label within any label group.

• Attempting to edit a label without providing the Label ID.

• Providing labels for the wrong group. That is, the Group Name column does not match the name of the label group into which you are uploading labels.

• Providing a sequence for a reagent that does not have the 'Index' special type.