This topic covers some tips and tricks for successfully importing data to LabKey Sample Manager. These guidelines and limitations apply to uploading files, data describing samples and sources, and assay data.
When import by file or copy/paste is large enough that it will take considerable time to complete, the import will automatically be done in the background. Files larger than 100kb (or a copy/paste of > 1000 rows) will be imported asynchronously. This allows users to continue working within the app while the import completes.
Import larger files (or paste large spreadsheets) as usual. You will see a banner message indicating the background import in progress, and a
icon alongside that sample type until it completes:
Any user in the application will see the spinner in the header bar. To see the status of all asynchronous imports in progress, choose Background Imports
from the user menu.
Click a row for a page of details about that particular import, including a continuously updating log.
When the import is complete, you will receive an in-app notification via the menu
Import Performance Considerations
Excel files containing formulas will take longer to upload than files without formulas.
The performance of importing data into any structure is related to the number of columns. If your sample type or assay design has more than 30 columns, you may encounter performance issues.
Batch Delete Limitations
You can only delete 10,000 rows at a time. To delete larger sets of sample or assay data, select batches of rows to delete.
Data column headers should not include spaces or special characters like '///' slashes. Instead of spaces or special characters, try renaming data columns to use CamelCasing or '_' underscores as word separators. Displayed column headers will parse the internal caps and underscores to show spaces in the column names.
Once you've created a sample type or assay data structure following these guidelines, you can change the Label for the field (under Name and Linking Options in the field editor)
) if desired. For example, if you want to show a column with units included, you could import the data with a column name of Platelets
and then set the label to show "Platelets (per uL)" to the user.
You can also use Import Aliases
to map a column name that contains spaces to a sample type or assay field that does not. Remember to use "double quotes" around names that include spaces.
For example, if your assay data includes a column named "Platelets (per uL)", you would define your assay with a field named "Platelets" and include "Platelets (per uL)" (including the quotes) in the Import Aliases
box of the assay design definition.
Copy and Paste for Data Import
When importing assay data, you can copy and paste a tab-separated block of data, but the data type "Multi-line Text" is not supported for this method. Either upload a file or manually enter data into a grid to include multi-line text fields.
Copy and paste import is limited to 1000 rows.
Data Preview Considerations
Previewing data stored as a TSV or CSV file may be faster than previewing data imported as an Excel file, particularly when file sizes are large.
Previewing Excel files that include formulas will take longer to preview than similar Excel files without formulas.
Note that some of the reserved names listed here are not currently in use by the application but will be reserved when Freezer Management is added. It is best to avoid using them now.
There are a number of reserved field names used within the system for every data structure
that will be populated internally when data is created or modified, or are otherwise reserved and cannot be redefined by the user
In addition Sample and Source Types
reserve these field names:
- Stored Amount
- Freeze/Thaw Count
- Storage Status
- Checked Out By