elog2labfolder/import_export.rst
author weiher
Wed, 07 Feb 2018 16:53:37 +0100
changeset 13 a21f3604f1db
parent 3 b71be85a294c
permissions -rw-r--r--
Added new chapter about CUPS printers

Import and export of projects and entries
=========================================

Import
------

The import of projects (from another labfolder instance or from another logbook software) is only possible via the labfolder API. An import of labfolder-own projects via webinterface is not possible to date. You can find the API documentation here:

| Version 1: http://labfolder.rz-berlin.mpg.de:9091/api/v1
| Version 2: https://labfolder.rz-berlin.mpg.de/api/v2/docs/development.html

Version 2 is still in the development phase.

Export
------
Exporting projects (or just single entries) is possible in three different formats: PDF, XHTML and JSON. The **export as PDF** can be done from within a project ...

.. image:: _static/export_of_projects.png
   :width: 70 %
   :align: center

... or from the project overview (*Manage > Projects*):

.. image:: _static/export_of_projects2.png
   :width: 70 %
   :align: center

The **XHTML export** can be done via the settings:

.. image:: _static/export_xhtml.png
   :width: 70 %
   :align: center

However, to use this type of export it has to be installed first in the *Manage > Apps* section. By means of the XHTML export all projects that one owns will be exported. A detailled selection of projects or entries to be exported is not possible. As soon as the export process is finished a download link appears in the settings in *Data exports*. The downloadable ZIP file contains all images and files along with an index.html file that contains information about all entries. You could open and view the index.html file in a browser similar to the view in labfolder.

The **JSON export** is only useable via the API endpoint ``GET /entries``. However, at the moment the response only contains useful information such as dates and tags. The author name is hidden behind the author ID and the entry text content is completely missing.