Nuxeo Platform User Documentation

Document Types in Web UI

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!


Sections, workspaces and templates are grouped in domains. A domain can be considered as a mini-application in Nuxeo or a root in the application. Typically, you can use domains to open the application to two or more very different populations of users. For instance, you can have an "intranet" domain and an "extranet" domain. Domains can be totally independent or not, depending on the permissions you set on each domain.


When documents are finished and ready, they are published in sections. Traditionally opened to a wider audience than workspaces, sections are dedicated to content distribution and communication and are designed for content consultation. That is why users cannot change documents (edit or move them) in sections: documents published in sections are frozen versions of workspace documents.


There are two types of workspaces:

  • shared workspaces are workspaces meant for collaborative work, that is to say that the workspace's content is meant to be shared and modified by several users. Collaborative workspaces are workspaces created in the root space called Workspaces and shared between users. Once documents are ready for distribution, they must be published in a section.

  • personal workspaces can only be accessed by their owner, by default. You can of course share the access to your personal workspace with other users. Personal workspaces are accessible in the header of the application.

Personal workspaces behaviour

Content creation and edition, as well as management, works the same way in personal workspaces as in collaborative workspaces.

By default, no workspace is available at workspaces root. Thus, you can create the structure you need for your project, edit it if needed. You can also set the appropriate permission for users to be able to collaborate in the workspaces.

Workspaces management also includes setting alerts for users to be informed when content is created or edited in workspaces and handling content deletion.


In workspaces, you can create and manage your documents in folders. A folder works like a workspace, but the documents available for creation are limited. In a folder, you can create: notes, files, collections and sub-folders.

There are two types of folders: regular folders and ordered folders. The difference between the two folder types is the way content is sorted.

Regular Folders

Regular folders, called "Folders", have the same behavior as workspaces. In a regular folder, documents are sorted on the title by default. You can change the sort criterion by clicking on the content table columns title. You can thus sort them on their state, author, etc.

In a folder, you can:

Like in a workspace, you can use drag and drop to create content in a folder.

Ordered Folders

In an ordered folder, documents are manually sorted. So, the orders in which documents are listed in the folder doesn't depend on one of its properties (version, author, etc); you decide where it should be displayed in the list. When a document is created, it is added at the end of the list. It is not possible to sort documents automatically by clicking on the columns titles in an ordered folder.

An ordered folder has the same presentation as a regular folder, but it has some additional buttons below the content table:

  • Move up
  • Move down
  • Move to top
  • Move to bottom

To change the content's order, select a document using the checkbox on the left and click on the move button you need. The document is moved in the list of documents available in the folder.

Moving documents restrictions

You can move one document at a time. If you select more than one document, the move buttons will deactivate.


A file document is a basic binary container and is composed of an attached file that you upload on the application. You can upload files of any format.

A file is composed of:

  • A title (mandatory),
  • A description (optional),
  • An attached file.

To create a file, in a workspace, click on . On the Create popup, click on the desired document. Fill in the document's creation form and click on Create.

When the file is created, users can enhance it by filling its properties, adding attached files on it.


The note is a basic rich text container that consists in a text displayed in the View tab of the document. The note is usually created using the integrated rich editor, displayed in the note creation form. This editor enables layout modifications on the text.

The default format of the note is HTML. The other formats available are .txt, .xml and Markdown.

A note is composed of the fields below:

Fields Description
Title The note's title
Description The text that explains what the note is about.
Content The text of the note created using the rich text editor.
Format The format of the automatically created file used to export notes from the Nuxeo Platform.

To create a note, in a workspace, click on . On the Create popup, click on the desired document. Fill in the document's creation form and click on Create.

You can also create a note by importing a .txt, a .html or a .xml file using drag and drop. When the note is created, users can enhance it by attaching files on it or just editing it.


It is possible to add attachments to Files and Notes using the Files tab. This tab is available to users with at least Edit permission. There is no limit to the number of attachments.

To add attachments to your document:

In the View tab of the document concerned, drag and drop the attachment in the field or click on Add a file and a popup lets you select the attachment from your computer.

To remove attachment: In the View tab of the document concerned, click on next to the attachment concerned. The attachment is immediately deleted.


  • Attached files are not synchronized with Nuxeo Drive.


Pictures are specific files. To take into account the specificities of pictures, their View shows additional pieces of information, such as:

  • Rotate actions
  • The picture's EXIF metadata
  • Additional picture views

For more information about picture document, take a look to the Digital Asset Management page.


Video is a document types dedicated to the management of videos files. It provides the following specific features: A player to view the video from the application, a storyboard to navigate in the video and alternative video formats.

For more information about video document, take a look to the Digital Asset Management page.


Audio is a document types dedicated to audio files management. It provides a player from the document View to listen to it from the application.

Audio documents can be created and edited like any other document type. They don't have any specific tab or action available.

For more information about audio document, take a look to the Digital Asset Management page.


Templates are the easiest way to automate the creation of workspace tree structures. This is useful in many cases, for example when:

  • You have many workspaces to create and want them to follow a certain structure of Folders, Files, or any type of documents.
  • You want to keep a consistency among different workspaces that users will create. For example, you may want each team's workspace to have a mail folder, a "projects" workspace, etc.

To create a template:

  1. Click on Templates in the navigation tree,
  2. From there, you can create a new Template containing any type of document, and even files, with the tree structure you want.
  3. Once a new Template has been created, you can create many workspaces from this template.

Templates and User Rights Management

  • When you set permissions on the 1st-level workspace of a template - here IT project workspace structure-, it will be inherited in the new workspaces. For example, a user who is not allowed to read "IT project workspace structure" will not be able to see it when creating a workspace.

  • When you set permissions on the content of a workspace in a template, it won't be inherited in the new workspaces. For example, a user who can't read a folder like "Meeting reports" in a workspace but have reading access on the 1st-level workspace, will be allowed to see "Meeting reports" In a few words, don't try to manage workspaces' permissions with Templates (this can be done other ways, like using Studio configuration tool).

We'd love to hear your thoughts!

All fields required