This documentation relates to an old version of the Nuxeo Platform Document Management module (5.5). You may want to check the latest version of the User Guide or of the Administration Guide.
Skip to end of metadata
Go to start of metadata

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.

There are several types of export:

  • the zip export enables users to get a zipped folder with the documents' main attachment (.pdf, .doc files);
  • the XML export is a low level export that enables users to either get the XML definition of the document or get a folder for each exported document that contains:
    • a document.xml file holding the document's metadata and various information such as the applied access rights,
    • a .blob file that holds the binary content of the document. This blob is referenced in the document.xml file;
  • the PDF export enables users to have a view of the main information on the document;
  • the Excel export enables users to save the table that displays the content of a workspace or content.

Export is available from:

  • the worklist
  • the Export options page, available by clicking the icon below the search box.

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 a document's attachments

When you are on a document and you want to get its attached files, you can export them in a zipped folder.

To export the attachments of a document:

  1. From the document, click on the icon to see the export options.
  2. Click on ZIP Binary Export.

    You are proposed to save a "clipboard.zip" file on your computer.
  3. Save it.
    When you unzip it, you get the document's attachments and an INDEX.txt file that summarizes the content of the export.

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 to select it.
  2. Click on the Add to worklist button.
    The documents is 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 content of a workspace

Just like you can export a selection of documents, you can easily export the content of a workspace, folder, section. In that case, the zipped folder you get recreates the structure of the exported space: workspaces and folders are exported as folders, in which you have the documents' attachments.

To export the content of a workspace:

  1. From the workspace, folder or section, click on the icon to see the export options.
  2. Click on ZIP Binary Export.

    You are proposed to save a "clipboard.zip" file on your computer.
  3. Save it.
    When you unzip it, you get a folder that represents the Nuxeo space structure and documents' attachments and an INDEX.txt file that summarizes the content structure of the export.

Exporting the list of documents 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 either use the Excel or the PDF export:

  • the Excel export enables you to get the list of documents inside the folder in an Excel table,
  • the PDF export enables you to get the folder metadata and history in addition to the list of documents.

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.

The Excel export is also available from the Export options page, by clicking the icon .

To export the list of documents of a space in an PDF file:

  1. From the workspace, folder or section, click on the icon to see the export options.
  2. Click on PDF Export.

    The PDF view of the page opens in a new tab. It displays:
  • the metadata of the folder,
  • its history,
  • its content list.

Low-level exports

XML export is a low level 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 to see the export options.
  2. Click on ZIP XML Export.

    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 is 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 DM 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 to see the export options.
  2. Click on ZIP Tree XML Export.

    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.
Labels