An example of a filter is cm:modified. It specifies the name of the filter field. It is the field on which you want to do a filtered search.
filterID - Specifies a unique name to identify the filter. Before adding a new filter, check the existing filters via the Search Manager to ensure that the filterID does not already exist.
displayName - Specifies the display name of the filter.
displayControl - Enables the user to decide the user interface control or how the filter is displayed on the Search page. The default option is Check box. displayControl is the full module name for an Aikau widget which is used for rendering the facet filters. By default, Alfresco Content Services provides alfresco/search/FacetFilters which is a basic rendering of the filters available for the facet.
maxFilters - Enables the user to select the maximum number of filters shown for search results. You can select to show more than one filter.
hitThreshold - Enables the user to select the minimum number of matches a filter result must have to be shown on the Search page.
minFilterValueLength - Specifies the minimum length of characters that a filter value must have to be displayed. This can be useful in hiding common short words.
sortBy - Enables the user to select the order in which the filter results must be shown on the Search page. The sortBy option is passed to the FacetFilters widget and defines how the filters should be sorted. This property has the following options:
| Option | Description |
|---|---|
| ALPHABETICALLY | Specifies the filter value A-Z. |
| REVERSE_ALPHABETICALLY | Specifies the filter value Z-A. |
| ASCENDING | Specifies the number of filter results (low to high). |
| DESCENDING | Specifies the number of filter results (high to low). |
| INDEX | This is a special value reserved for results rendered by filter queries. |
scope - Enables the user to select the sites where the filter will be available.
scopedSites - Displays a list of sites where the filter will be available.
isEnabled - Specifies if the filter is enabled for inclusion on the search results page. Disabled filters are not displayed. Only the filters you create via the Share console can be deleted; default filters must be disabled to hide them.