Nuxeo Online Services

Page Providers

Updated: September 18, 2017 Page Information Edit on GitHub

Availability
This feature is available for target platforms Nuxeo Platform LTS 2016 and above.

Page providers allow retrieving documents with pagination facilities, to build custom document listings and search forms. They can be leveraged through the REST API:

  • directly and using any Nuxeo client (JS, Java, C#, PHP...),
  • in a custom application using the Nuxeo elements,
  • in Nuxeo Web UI.

A page provider corresponds to the query part of a content view, without the form and result columns configuration. For instance, Web UI makes use of a page provider in order to create the default search form. In the screenshot below, several configuration options are used:

  1. Query filter
  2. Predicates
  3. Aggregates
  4. Quick Filters

Creating a Page Provider

Click on New to create a page provider.

A page provider can be created from an existing content view. When selecting this option:

  • The relevant configuration parameters are copied from the selected content view
  • The "Use Elasticsearch Index" disappears from the search form, as this parameter is copied from the content view. It is still possible to change the value anytime after creation.

Note that creating a page provider using the Copy from content view option keeps your content view available. After creation there is no link between the two features, changing one does not affect the other.

Main Configuration Options Overview

Use Elasticsearch Index

Activate this option to use the Elasticsearch Index. When deactivated, the database index will be used instead.

When Should I Use The Elasticsearch Index?

Elasticsearch index is faster and allows to use more features like aggregates and hints. However, it can take up to a couple of seconds before your Elasticsearch cluster is synchronized when a modification is made. Therefore, you should:

Use the Elasticsearch index for:
  • Any costly query,
  • Listings that require many or advanced filtering options,
  • Any listing in general that does not require immediate up to date information, like search forms.
Use the database index for:
  • Queries that require the information to be immediately up to date, for instance when displaying the content of a folderish document right after having modified one of its children.

Query Filter

The query filter is where you can fill in the NXQL query (without the "SELECT * FROM Document WHERE" part which is already generated). This will be used as a base, to which you can add optional filters.

As you can see from the screenshot above, this query is launched when no additional criteria has been added in the search form.

Query Parameters

In the query filter field, variables can be defined using the ? keyword. When adding variables, the corresponding parameters have to be added as query parameters in the same order. When launching a query through the REST API, it is possible to override the parameter's default value set here by sending it in the query.

Predicates

Predicates are used in search forms to provide additional search criterias on top of the initial query filter.

Default Sort

Lets you define in which order results should be returned by default.

Quick Filters

As shown in the screenshot above, quick filters appear in the interface as buttons, where clicking on the button enables or disables the search criterias associated to the quick filter. This is particularly useful to let your users filter documents quickly using commonly used or context relevant search criteria: for instance you can put quick filters to only display documents in a specific state, located in a specific space...

Elasticsearch Index Specific Options

Aggregates

Aggregates are an Elasticsearch specific feature that allow real-time filtering on search criterias.

Range aggregates allow you to display specific date or number ranges (e.g. modified in the last 6 months, renewal due in 3 weeks from now or less, amount over 10k).

Histograms will display automatically generated criterias depending on the current filter selection. e.g. allow to filter contracts between 1 and 2k, 2 and 3k... if you set up a 1k range. Criterias are generated in real time and only for existing values (i.e. no option will be shown if no document corresponds to it).

Each aggregate also displays the corresponding number of results in real time depending of the other criterias already selected.

More information can be found in the page provider aggregates documentation.

Multi Repository

When having multiple repositories, this option can be activated to search all of them at once. Can only be activated if you use the Elasticsearch index for your page provider.

Generate Usage Statistics

This option enables to include the current page provider into account in the search statistics available from the Admin > Activity > Search Analytics tab. It is available starting from Nuxeo Platform LTS 2015.

7 days ago GitHub Fix formatting
History: Created by GitHub