Home > Nuxeo Platform User Documentation > Working in Workspaces > Working with Documents > Exporting Documents
Nuxeo Platform User Documentation

Exporting Documents

Updated: October 16, 2020

Users can export documents on their computer. It is possible to export:

  • One document at a time,
  • A selection of documents,
  • An entire workspace, folder, section.

Available Export Options

Export options are available from:

  • The Export button of documents and folders, available by clicking the icon in the More menu
  • The worklist

PDF Export

PDF export is available for documents and folders, from the Export options (icon in the More menu). It consists in a PDF file that lists:

  • For documents:
    • The document files for documents (main content and attachments)
    • The document metadata
    • The links to the document (path URL and permalink)
    • The History log of the document
    • The comments of the document
  • For folders:
    • The folder metadata
    • The links to the folder (path URL and permalink)
    • The History log of the folder
    • The list of documents and folders inside the folder

XML Exports

The XML export is a low level export available from the Export options of the document (icon in the More menu). It consists in the XML definition of the document.

The ZIP XML Export is available from the document. It consists in a zipped folder called export.zip that contains:

  • A document.xml file holding the document's metadata and various information such as the applied access rights.
  • .blob files that holds the binary content of the document (main file and attachments). Blobs are referenced in the document.xml file.

From a folder, this export option is called ZIP Tree XML Export. The export.zip file contains a series of folders that reproduce the children hierarchy of the exported folder, and for each document inside it the same document.xml and associate blob structure as the ZIP XML Export described above.

From the worklist, the Export to XML option provides you with an export.zip folder that contains as many folders as documents in your worklist, with he same document.xml and associate blob structure as the ZIP XML Export described above.

Zip Exports of Binaries

Zip export of binaries is available from the document and from the worklist.

From a document (icon in the More menu), the ZIP Binary Export option consists in a clipboard.zip that holds:

  • The main file of the document
  • The attachments of the document
  • An INDEX.txt file

From the export options of a folder, the clipboard.zip file provided by the ZIP Binary Export options holds:

  • All the main files and attachments of the documents in a folder of the same name as the Nuxeo folder
  • An INDEX.txt file at the root of the ZIP

The Export as ZIP option of the worklist provides a clipboard.zip folder that holds:

  • All the main files and attachments from the documents in the worklis
  • An INDEX.txt file

Excel Export

From the folder export options (icon in the More menu), the Excel Export provides a document_content.xls file that reproduces the table of the folder Content tab.

Exporting Attachments

Users can easily export the attachments of a document or of a selection of documents, i.e. their main file and the additional attachments added from the Files tab of the documents.

Exporting the Attachments of a Document Selection

You can export the attachments of several documents at the same time, using the worklist.

To export a selection of documents:

  1. Check the box that corresponds to the documents to export.
  2. Click on the Add to worklist button. The documents are added to your worklist, in the left part of the screen.
  3. Optionally go in other folders and add other documents to your worklist.
  4. In the worklist, click on the Export as ZIP link.
  5. Save the "Clipboard.zip" folder. When you unzip it, you get the documents' attachments and an INDEX.txt file that summarizes the content of the export.

Exporting the List of Documents in a Folder

Just like it is possible to export search results, it is possible to export the list of documents in a workspace, section or folder. You can use the Excel export which enables you to get the list of documents inside the folder in an Excel table.

To export the list of documents of a space in an Excel file: Click on the icon displayed in the top right corner of the Content tab of the workspace, folder or section. You are proposed to save a "document_content.xls" file, that displays the same information on the folder's documents as in the Content tab.

Low-Level Exports

XML export is a low level export that enables users to get a set of information on documents in an XML file. This export type is useful for debugging, and as such, is mainly intended to administrators. You can export:

  • a single document,
  • a selection of documents,
  • the structure of a folder.

XML Export of a Single Document

The XML export of a document enables users to get a folder for the exported document that contains:

  • a document.xml file holding the document's various information (the applied access rights, the document's metadata, its path),
  • a .blob file that holds the binary content of the document. This blob is referenced in the document.xml file.

To get the XML export of a document:

  1. From the document, click on the icon or, if the icon is not available on the action bar, on the Export button of the More menu in the action bar.

  2. Click on ZIP XML Export on the pop-up window. You are proposed to save a "export.zip" file on your computer.

    If you're only interested in the XML file of the document, click on XML Export. The XML file should open in a new tab or window (depending on your browser's preferences).

  3. Save the "export.zip" file. When you unzip it, you get a folder named from the document, that contains a document.xml file and .blob for each attachment of the document.

XML Export of a Document Selection

It is possible to do an XML export of several documents in a single export, using the Worklist.

To export a selection of documents:

  1. Check the box that corresponds to the documents to export to select it.
  2. Click on the Add to worklist button. The documents are added to your worklist, in the left part of the screen.
  3. Optionally go in other folders and add other documents to your worklist.
  4. In the worklist, click on the Export to XML link.
  5. Save the "export.zip" folder. When you unzip it, you get a folder structure that reproduces the Nuxeo Platform tree to the document.

XML Export of a Folder

It is possible to export a whole workspace, section or folder in a zipped XML folder. This specific export enables users to import the folder back, with the same access rights definition.

To get the XML export of a folder:

  1. From the folder (or workspace or section), click on the icon or, if the icon is not available on the action bar, on the Export button of the More menu in the action bar.

  2. Click on ZIP Tree XML Export on the pop-up window. You are proposed to save a "export.zip" file on your computer.

    If you're only interested in the XML definition of the folder, click on XML Export. The XML file should open in a new tab or window (depending on your browser's preferences).

  3. Save the "export.zip" file. When you unzip it, you get a folder named from the document, that contains a document.xml file and .blob for each attachment of the document.