Nuxeo Platform User Documentation

Faceted Search

Updated: October 16, 2020

This addon is deprecated since Nuxeo Platform 6.0 and has been replaced by the Search tab.

The Faceted search add-on provides a way to browse the whole document repository using visual filters on metadata.

You can filter content using:

  • Keywords (full text search based on stemming, see the General principles section for more details on full text search),
  • Dates (creation and last modification dates),
  • Author,
  • Documents categorization (nature, coverage, subjects of documents),
  • Location of the documents in the folders.

Faceted search is available as a Marketplace add-on. It add a tab of the left hand side of the page in the Workspace tab.

The faceted search tab offers several criteria to filter the content of the application.

KeywordsThe keywords field behaves like the simple search field. It makes a full-text search. You can use full-text operators in this field to refine your search.
Dates The creation date and modification date criteria have the same behavior. The system will just respectively query the "Created at" and "Last modified at" fields. These fields enable you to select a time period (from Apr. 19th 2013 to Apr. 23rd 2013 for instance) or just a limit date (from Apr. 19th 2013 or until Apr. 19th 2013 for instance).
Date-based search includes the time of the selected day(s). By default, 12:00 pm is selected. This may impact search results, since documents created before or after that time will not be included in the search results. You need to manually change the time to cover a full day.
AuthorYou can select one or several users of the application using the user suggestion field: type at least three characters to make the user search start. If you select several users, the system will search for documents created by any of the selected users.
NatureYou can search for documents that have a specific value in the Nature metadata. You can select one or several values in this search field.
CoverageYou can search documents on their coverage value. You can search on several coverage values. You can also select a 1st level value to search the document that cover Europe, for instance.
SubjectsThe Subjects field behaves like the Coverage field.
Path You can limit the search to a specific workspaces / section / folder by selecting it in the Folder popup window.
Multi-domain Nuxeo instance
If you have several domains (for instance if you use the Social Collaboration or Digital Asset Management modules), note that the Folder popup window will display the tree structure of the domain you are currently browsing. To select folders in several domains, go on the application's root (using the icon ) before filling in the faceted search form.

To browse the content of the application using faceted search:

  1. In the Faceted Search tab, fill in the form with the properties of the documents you want to browse. For instance, we only want the documents created by user John Doe.
  2. Click on the Go button. The documents that were created by John Doe are displayed in the content part of the page.
  3. If needed, edit your filter criteria in the faceted search form that is still available. For instance, let's say we only want the documents created by John Doe that are "booklets".
  4. Click on the Go button again. The list of documents that answer to the two criteria filled in is refreshed.

Saving Your Faceted Searches

With faceted search comes the possibility to save your searches, so you can reuse them at anytime. You can also share these saved searched to make them available for other users.

Saving searches limitations

Only faceted searches can be saved.

When you save a search, you save the criteria of the search. This means that the results displayed when you reuse the search may be different from the results at the time you saved the search, as the content of the application may (and probably will) have changed.

You can save as many searches you need. Saved searches are available in the drop down list below the "Save this search" box. To load a search, just click on it in the list. It is automatically executed.

To save a search:

  1. Start a search using the faceted search form.
  2. When you are satisfied with the filter you have done, click on the Save this search title on top of the filters.
  3. Give the search a title.
  4. Click on the Save button. The search is saved. It is now available in the drop down list so you can run it in one click.
    It is also available in the Saved searches tab of your Home, in the Faceted searches tab. You can edit it from there.

Saved searches are stored in the Saved searches tab of your Home. This enables you see them as documents and to edit and share them.

Depending on the modules you use and possible customizations, there can be several tabs in the Saved searches. For instance, if you use the Document Management and Digital Asset Management modules, you will have two tabs: Faceted searches, for DM saved faceted searches, and DAM searches, for DAM saved searches.

To share a search:

  1. Go on the relevant Saved searches tab in your Home.
  2. Click on the search you want to share.
  3. Click on the search Manage tab and give Read access right to the users you want to be able to use the search.

Related pages in this documentation
Related pages in other documentations