Import / Export
Introduction
When users add information into systems like eLabFTW, that information can get trapped in this system. We do not want that. We want information to flow freely.
As such, eLabFTW allows users to freely export and import data, in different file formats, as well as accessing it through a public API, for automation tools.
This page describes the Import and Export features available in eLabFTW.
Importing data
Data import can be used to facilitate ingestion of multiple records into the current system. It can also be a convenient way to transfer data between systems. For instance, a research group leaving an institution can export all their team’s data and import it into the new institution.
Import can be done from the web interface, accessible to all users, but also from the Command Line Interface (CLI), which is only accessible to Sysadmins with console access to the container. CLI import is the recommended way to import big files (such as a full team export), as it prevents issues such as timeouts, if the import takes too long.
Two filetypes are currently supported for import: .eln (vnd.eln+zip) and .csv (text/csv).
Importing a .eln archive
You can import data from a .eln archive generated by any ELN software conforming to the specification.
Importing a .eln file created by an eLabFTW instance will produce the best results. This documentation focuses on these.
A .eln can contain any type of data:
Experiments
Experiments templates
Resources
Resources categories
eLabFTW will pick up the type of each entry through its genre attribute. Alternatively, you can force the type of entry by selecting one from the dropdown menu (web UI) or using the –type option (CLI). The same logic applies to selecting the appropriate category.
Importing through web interface
Head to the “Import” tab of your Profile page by selecting “Import” from the top right menu.
Select a .eln file to display import options. Then click Import.
Importing through CLI
Note
This approach is only available to Sysadmins wish shell access.
If you wish to import a rather large .eln archive (such as a full team export), the CLI is the better approach. Display the help with:
docker exec -it elabftw bin/console import:eln -h
As you can see, there are two mandatory arguments, the path to the file, and the Team ID where the import will be performed. The first thing to do is to copy the file in the right place in the container. It must be in /elabftw/cache/elab folder. Copy it with a command similar to this:
docker cp your.eln elabftw:/elabftw/cache/elab/
Figure out the Team ID by looking at the Team from the Sysconfig panel, where the ID will be displayed next to the Team. Next, import your file with:
# import in team 12 and be verbose
docker exec -it elabftw bin/console import:eln -vv your.eln 12
# import in team 25, force everything to be owned by user 5 and be extra verbose
docker exec -it elabftw bin/console import:eln -vvv your.eln 12 --userid 5
# import in team 42, force everything to be of type "Resources" with category "6"
docker exec -it elabftw bin/console import:eln --type items --category 6 your.eln 42
Importing a .csv file
If you already have some Resources catalogued in an Excel file or File Maker database, you can import them in eLabFTW with a .csv file. A .csv file is a very simple file format. You can save a .xlsx or .ods file into this format. If using Microsoft Office, make sure to select “CSV UTF-8” in the dropdown menu. It needs to be “flat”, meaning the first row is the column names, and all subsequent rows correspond to one entry.
To achieve a successful import, make sure to follow these instructions:
1. Preparing the file
It is important to make sure that the file you are going to import is “clean”. Open your file (.xls/.xlsx/.ods/.csv) in an editor like LibreOffice Calc or Microsoft Excel.
Make sure that there are no empty rows or extra information outside the main data. And that you don’t have columns with the same name, or columns with no useful information.
You should have a number of columns and rows, looking something like that:
Name |
Host |
Target |
Reference |
Seller |
Storage |
|---|---|---|---|---|---|
Anti α-actin |
Mouse |
Human |
AB3148 |
Abcam |
-20°C |
Anti γ-tubulin |
Rabbit |
Human |
AB1337 |
Abcam |
+4°C |
Now you need to have a column named title. This is the column that will be picked up as the title of the eLabFTW entry once imported. This column doesn’t necessarily needs to be the first one, but it needs to be there. Here we’re going to change the “Name” column. So now it looks like this:
title |
Host |
Target |
Reference |
Seller |
Storage |
|---|---|---|---|---|---|
Anti α-actin |
Mouse |
Human |
AB3148 |
Abcam |
-20°C |
Anti γ-tubulin |
Rabbit |
Human |
AB1337 |
Abcam |
+4°C |
If you wish to include tags during the import, specify a column “tags” that will contain the tags separated by a “|” character. You can also have a “metadata” column containing JSON. The same logic applies to “metadata” column which can contain JSON that will be included in the metadata of the created entry.
Once you are satisfied with the file, export it as a .csv (in File > Save as…). Make a copy of only the first 3 rows and export that too as csv, this will be our test file.
2. Importing the file
Select “Import” from the main top right user menu. If you haven’t done it already, create first a Resource Category that corresponds to your data type (or ask your Admin to do it). Here we will use an “Antibody” category as that’s what we are importing.
Start by selecting your .csv file. Options to select the type (Resource) and category (Antibody in our case) appear. Select the appropriate options and click “Import”.
In the import window, select the correct category (Antibody in this example). Then select the visibility. Now select your test CSV file (with a few rows only) and click the “Import” button.
Every row will correspond to an entry in the correct category of Resources. All the columns (except title, tags, metadata, date, custom_id, and other picked up special columns) will be imported in the body of each entry.
If the import looks good, you can now delete these newly imported items and import your complete file.
Using the API to control how things are imported
If you want to have complete control over the import process, you can use a few lines of python to do the import.
Warning
Important: the scripts linked below will import automatically all the rows present in your CSV file. Try first with a few rows before importing everything, so you have a chance to correct errors easily!
We will use the elabapi-python library to make things easy. See installation instructions.
You can then have a look at this example to import CSV using the API and metadata/extra fields.
Exporting data
Exporting through web interface
The Export tab from your Profile allows full export of all your data, in several formats. Click “Create new export” to configure how you want the data to be exported. A “File is not ready” entry will be displayed. Wait a few seconds and click “Refresh”. Once you see a link to the file, you can click it and download the exported file.
Very long exports will still be processed if you close your browser or navigate away.
Note to Sysadmins: on a given instance, export jobs are processed only one at a time. Users can each keep only 6 exported files. They are stored in cache and will disappear if the container is destroyed.
Exporting through CLI
As a Sysadmin with shell access, you can export an entire team, which can be useful if that team migrates out of your instance for instance. Use bin/console export:eln -h. The only argument is the team ID that you wish to export.
It will export everything into a .eln file, that you need to copy out of the container. This file can later be re-imported on another instance.
Important note: Import/Export is only supported between instances of the same version, preferably the latest version!