Nuxeo Platform User Documentation

Nuxeo Platform Concepts

Updated: February 28, 2017 Page Information Edit on GitHub

Nuxeo Platform JSF UI is the Back office view on the content repository. There are three main spaces in Nuxeo Platform:

  • The Home tab provides a set of dashboards
  • The Workspace tab enables to navigate in the repository
  • The Search tab enables to query the repository

The Nuxeo Platform gives you all the necessary tools to let you customize what is displayed on your platform.

Workspace

This is where the majority of user's activity within the Nuxeo Platform will occur since it's where users can work on documents and browse the application domains, workspace, sections, etc.

Content Hierarchy

You can create different types of documents to be able to display the content hierarchy that you need in your application. By default you can create workspaces, folders, collections, templates, etc., but you can also create your own document types.

The default navigation tree displayed on the left hand side of the pages is the folders navigation tree. It displays all the domain structure from the root. It enables you to easily access any space in the application structure. The navigation tree displays folderish documents, i.e. documents in which you can create other documents (workspaces, folders, etc.).

It is possible to add another type of navigation tree based on metadata instead of folder structure by installing the Nuxeo Virtual Navigation addon.

Breadcrumb enables you to navigate in the platform. For example, you can go up one level in the platform structure, by clicking on the  icon in the breadcrumbs. Users can also click on the workspace's title in the breadcrumbs directly or in the navigation tree. They can go up several levels in the document's path in a single click that way.

Due to technical reasons, it is recommended to NOT use the browser's Back and Next buttons to navigate in the Platform.

Tabs

A tab in the Nuxeo Platform is a view displayed on a document, controlled by a filter. Different tabs are displayed on each document type created in the content hierarchy, the basic ones are:

  • Summary: this view lets you see the metadata of your document, start a workflow or more specific metadata like for pictures document.
  • Edit: from this tab you can edit the metadata and the content of your document.
  • Files: you can add additional files from this tab.
  • Publish: this view lets you publish your document in another section of your platform.
  • Relations: this tab lets you manage the relations around the document.
  • History: this tab lets you see the event log of the document concerned.

On a same document users with different profiles will have access to different tabs. And so they will be presented different forms and buttons that correspond to their profile. Typically users with Read permission are not displayed the Edit tab.

Dashboards

Each user has a set of personal dashboards from the Home tab that display the information they find relevant and help them have a global view of the application's activity.

The Home default tab is the Dashboard tab.

The dashboard is composed of a set of boxes that display either a list of documents matching a criteria (all the workspaces the user can access, the last documents he modified, the last documents that have been published...), or possibly a piece of information either from the Platform or from external websites.

If you want to customize your dashboard, follow this HOWTO.

Other main user-centric information available from the Home is:

  • Profile: Enables the user to edit their personal information and their password
  • Workflow: Displays the tasks assigned to the user
  • Preferences : Enables to select the language of the platform interface
  • Alerts: Shows the list of email notifications the user subscribed to
  • Users & Groups: Enables the user to browse the users and groups directory
  • Searches: Provides access to the user's saved searches
  • Authorized Applications: Lists the external applications that can access Nuxeo data. See Nuxeo Media Publishing for instance.
  • Collections: Lists the collections the user can access

Available Filters

The Nuxeo Platform provides a Search tab that enables you to browse and search the content of the Nuxeo Platform. This tab gives access to different searches to query the content of the application.

  • Default search enables you to search on keywords, metadata and additional criteria such as the location in the application.
  • Quick search is a full-text search. Quick search is available from the Search tab and from the top right corner of the screen. It provides suggestions of search results as you type your keywords. Note that this type of search can generate a lot of noise if you search for very generic keywords.
  • NXQL search enables you to query the content of the platform using Nuxeo query language, giving you access to as many criteria as you need.

You can configure as many search forms as you need to provide users with search capabilities adapted to your business document types and rules.

Documents are indexed using their title, description, content (note field, attached files), and metadata. But these different search forms don't have the same behaviors and may not give you the same results. They can provide text fields in which you can type keywords, date fields in which you can select a date to define a period, lists from which you can select values. Text fields can be full-text search fields or exact match fields.

Facets

The default search filter provides a faceted search, leveraging the Elasticsearch aggregates. You can search for documents from their metadata and other properties and search results are filtered as you add or remove criteria. Aggregate fields values are also filtered so as to display only relevant values and show the count of matching documents for each value.

Result Layout

Users can change the way content is presented in the result layout. They can also change the displayed information. At the top right and corner of the results pages, you have different options to display your content list.

  • Thumbnail view : this view displays a thumbnail of documents. For folders, the thumbnail of the first item in the folder is displayed.
  • Edit Result Columns: this button lets you change the information displayed in content lists. The right column shows selected information and the left column shows information that are currently not displayed. You can move information from one column to another using the horizontal arrows and reorder columns using the vertical arrows.

    Editing results column is possible from search results and the Content tab of folderish documents. It is not possible from the tag cloud.

When you create new search forms, you can adapt the result layout to your own document types so as to display information relevant to your users. See How to Define a New Content View for instance.

4 months ago Manon Lumeau add pages about personal space and administration
4 months ago Manon Lumeau Update User doc with Web UI
2 years ago Solen Guitter 85 | ink updat
2 years ago Solen Guitter 84
2 years ago Solen Guitter 83
2 years ago Solen Guitter 82
2 years ago Solen Guitter 81
2 years ago Solen Guitter 80 | Add missing Home tabs, update Facets sections
2 years ago Manon Lumeau 79
2 years ago Manon Lumeau 78
3 years ago Thierry Martins 77
3 years ago Solen Guitter 76
3 years ago Solen Guitter 75 | Can ask for publishing is not included in Read any more since 6.0
3 years ago Solen Guitter 74
3 years ago Solen Guitter 73 | update link
3 years ago Solen Guitter 72 | Update screenshots, tabs names, related pages
3 years ago Solen Guitter 71
3 years ago Thierry Martins 70
3 years ago Solen Guitter 69 | Add note about minimum rights to be able to use Document Management tab.
3 years ago Thierry Martins 68 | write permission allow to publish docs
3 years ago Manon Lumeau 67
3 years ago Solen Guitter 64
3 years ago Solen Guitter 65 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 66 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 63
3 years ago Solen Guitter 62 | Formatting
4 years ago Solen Guitter 60
4 years ago Solen Guitter 61 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 59
4 years ago Solen Guitter 58
4 years ago Solen Guitter 57
4 years ago Solen Guitter 54
4 years ago Solen Guitter 55 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 56 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 53
5 years ago Solen Guitter 52
5 years ago Solen Guitter 51
5 years ago Solen Guitter 49
5 years ago Solen Guitter 50 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 46
5 years ago Solen Guitter 47 | Migrated to Confluence 4.0
5 years ago Solen Guitter 48 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 45 | Added new 5.6 default group: powerusers
5 years ago Solen Guitter 44 | Added screenshots
5 years ago Solen Guitter 43
5 years ago Solen Guitter 42
5 years ago Solen Guitter 41 | Added "version" permission
5 years ago Solen Guitter 40 | Added "version" permission
5 years ago Solen Guitter 39 | Added tips on Remove and Can ask for publishing permissions
5 years ago Solen Guitter 38
5 years ago Solen Guitter 37 | fixed broken link
5 years ago Solen Guitter 36 | Added missing details on section rights
6 years ago Solen Guitter 35 | Added Studio tab
6 years ago Solen Guitter 34
6 years ago Solen Guitter 33 | Removed 5.4 references
6 years ago Solen Guitter 32 | Removed 5.4 references
6 years ago Solen Guitter 31 | Removed 5.4 references
6 years ago Solen Guitter 30
6 years ago Solen Guitter 29
6 years ago Solen Guitter 28 | Added related content
6 years ago Solen Guitter 27
6 years ago Solen Guitter 26
6 years ago Solen Guitter 25
6 years ago Solen Guitter 24
6 years ago Solen Guitter 23 | added 5.4.2 main tabs
6 years ago Solen Guitter 22
6 years ago Solen Guitter 21 | keyword
6 years ago Solen Guitter 20
6 years ago Stéfane Fermigier 19
6 years ago Solen Guitter 18
6 years ago Solen Guitter 17 | added excerpt
6 years ago Solen Guitter 16 | added Write includes Remove
7 years ago Solen Guitter 15
7 years ago Solen Guitter 14
7 years ago Solen Guitter 13
7 years ago Solen Guitter 11
7 years ago Solen Guitter 12
7 years ago Solen Guitter 10
7 years ago Solen Guitter 9
7 years ago Solen Guitter 8
7 years ago Solen Guitter 7
7 years ago Solen Guitter 6
7 years ago Solen Guitter 5 | updated links to websites and blogs
7 years ago Solen Guitter 4
7 years ago Eric Barroca 3
7 years ago Eric Barroca 2
7 years ago Solen Guitter 1
History: Created by Solen Guitter