Barcode Fields |
2024-04-16 |
This topic covers options for using barcode values with your samples. Existing barcode values in your data can be represented in a text or integer field, or you can have Sample Manager generate unique barcode identifiers by using a UniqueID field. LabKey-generated barcodes are read-only and unique across your Sample Manager application.Once a sample has either type of Barcode Field, you'll be able to search for it using these values.
By default, it will be named Barcode. If you wish, you can click the Fields section to open it and edit the field name.
Click Finish Updating Sample Type. Barcodes will be automatically generated for any existing samples of this type, as described in the next section.
Click Finish Updating Sample Type to confirm, then view the grid of samples to see the generated barcode values.In addition, when any new samples are added to this Sample Type, barcodes will be generated for them. You cannot provide values for a UniqueID field, or edit them.
UniqueID generated barcodes are 9+ digit text strings with leading zeros ending in an incrementing integer value. Ex: 000000001, 000000002, etc. Generated barcodes are unique across the Sample Manager application, i.e. if you use UniqueID barcodes for several different Sample Types, every sample in the system will have a unique barcode. When more than a billion samples are defined, the barcode will continue to increment to 10 digits without leading zeros.
Once generated by the system, barcodes in a UniqueID field cannot be edited and if data is imported into one of these fields, it will be ignored and an automatic barcode will be generated. If you need to provide your own barcode values or require the ability to edit them, do not use a UniqueID field.
This field may be named "Barcode" if you like, but will not be managed by LabKey, or shown as the Barcode property of the Sample Type. It will have the "scannable" field property set to true.Users can locate samples using the barcode values in this column, but must manage uniqueness and generate new barcode values for new samples outside of the application.
Enter values by typing or using a scanner, then click Find Samples to search for them.Learn more in this topic:
- Add UniqueID Field for LabKey-Managed Barcodes
- Generate UniqueID Barcodes
- Use Existing Barcode Values
- Search by Barcode
Add UniqueID Field for LabKey-Managed Barcodes
To support barcodes generated and managed by Sample Manager, you will need a field of type "UniqueID" in your Sample Type. When you create a new Sample Type, you will be prompted to include such a barcode field.To add a "Unique ID" field to an existing sample type, open it for editing. In the Sample Type Properties section, you will see under Barcodes, a blue banner inviting you to create the field necessary. Click Yes, Add Unique ID Field.By default, it will be named Barcode. If you wish, you can click the Fields section to open it and edit the field name.Click Finish Updating Sample Type. Barcodes will be automatically generated for any existing samples of this type, as described in the next section.
Generate UniqueID Barcodes
When you add a UniqueID field to a Sample Type that already contains samples, as you finish updating the sample type, you will be prompted to confirm that adding this field will generate barcodes for existing samples.Click Finish Updating Sample Type to confirm, then view the grid of samples to see the generated barcode values.In addition, when any new samples are added to this Sample Type, barcodes will be generated for them. You cannot provide values for a UniqueID field, or edit them.UniqueID generated barcodes are 9+ digit text strings with leading zeros ending in an incrementing integer value. Ex: 000000001, 000000002, etc. Generated barcodes are unique across the Sample Manager application, i.e. if you use UniqueID barcodes for several different Sample Types, every sample in the system will have a unique barcode. When more than a billion samples are defined, the barcode will continue to increment to 10 digits without leading zeros.Once generated by the system, barcodes in a UniqueID field cannot be edited and if data is imported into one of these fields, it will be ignored and an automatic barcode will be generated. If you need to provide your own barcode values or require the ability to edit them, do not use a UniqueID field.
Use Existing Barcode Values
If you have barcodes in your Sample data already, and do not want them generated or managed by LabKey, you can include a field of type "Text" or "Integer" in your Sample Type, and check the Barcode Field box for "Search this field when scanning samples".This field may be named "Barcode" if you like, but will not be managed by LabKey, or shown as the Barcode property of the Sample Type. It will have the "scannable" field property set to true.Users can locate samples using the barcode values in this column, but must manage uniqueness and generate new barcode values for new samples outside of the application.
Search by Barcode
Once your samples have a barcode column of either type, you can search for the value(s) to locate the sample(s). To find by a single barcode, you can search, sort, and filter the samples grid, or use the global Search option in the header throughout the application to find a single barcode value.To more easily find samples by barcode value, you can use the Find Samples option.Enter values by typing or using a scanner, then click Find Samples to search for them.Learn more in this topic: