| Title | Added | Status | Last reviewed |
|---|---|---|---|
Search Filter component |
v2.3.0 |
Active |
2019-03-20 |
Represents a main container component for custom search and faceted search settings.
<adf-search-filter #settings [showContextFacets]=true></adf-search-filter>| Name | Type | Default value | Description |
|---|---|---|---|
| showContextFacets | boolean |
true | Toggles whether to show or not the context facet filters |
The component UI uses dynamically created widgets to specify the search query and its options. It then uses the Search Query Builder service to build and execute the query.
You may find it useful to check out the following resources for background information before customizing the search UI:
You can configure the component using the search entry in the app.config.json file.
A typical configuration is shown below:
{
"search": {
"sorting": {
"options": [
{ "key": "name", "label": "Name", "type": "FIELD", "field": "cm:name", "ascending": true },
{ "key": "content.sizeInBytes", "label": "Size", "type": "FIELD", "field": "content.size", "ascending": true },
{ "key": "description", "label": "Description", "type": "FIELD", "field": "cm:description", "ascending": true }
],
"defaults": [
{ "key": "name", "type": "FIELD", "field": "cm:name", "ascending": true }
]
},
"filterQueries": [
{ "query": "TYPE:'cm:folder' OR TYPE:'cm:content'" },
{ "query": "NOT cm:creator:System" }
],
"facetFields": {
"expanded": true,
"fields": [
{ "field": "content.mimetype", "mincount": 1, "label": "Type" },
{ "field": "content.size", "mincount": 1, "label": "File Size" },
{ "field": "creator", "mincount": 1, "label": "Creator" },
{ "field": "modifier", "mincount": 1, "label": "Modifier" }
]
},
"facetQueries": {
"label": "My facet queries",
"pageSize": 4,
"queries": [
{ "query": "created:2018", "label": "Created This Year" },
{ "query": "content.mimetype:text/html", "label": "Type: HTML" },
{ "query": "content.size:[0 TO 10240]", "label": "Size: xtra small"},
{ "query": "content.size:[10240 TO 102400]", "label": "Size: small"},
{ "query": "content.size:[102400 TO 1048576]", "label": "Size: medium" },
{ "query": "content.size:[1048576 TO 16777216]", "label": "Size: large" },
{ "query": "content.size:[16777216 TO 134217728]", "label": "Size: xtra large" },
{ "query": "content.size:[134217728 TO MAX]", "label": "Size: XX large" }
]
},
"categories": [
{
"id": "queryName",
"name": "Name",
"enabled": true,
"expanded": true,
"component": {
"selector": "adf-search-text",
"settings": {
"pattern": "cm:name:'(.*?)'",
"field": "cm:name",
"placeholder": "Enter the name"
}
}
}
]
}
}The schema.json file for the app config has further details about available settings, values and formats for the configuration options.
You can explicitly define the include section for the query from within the application configuration file. This array is a list of extra data fields to be added to the search
results:
{
"search": {
"include": ["path", "allowableOperations"]
}
}You can choose to filter facet field results using 'contains' instead of 'starts with', by using the filterWithContains boolean (default is false):
{
"search": {
"filterWithContains": true
}
}You can choose to display a reset button by setting the 'resetButton' value to true. This 'clean up' button would make it easier for the final user to remove all bucket selections and all search filtering.
{
"search": {
"resetButton": true
}
}You can also provide a set of queries that are always executed alongside the user-defined settings:
{
"search": {
"filterQueries": [
{ "query": "TYPE:'cm:folder' OR TYPE:'cm:content'" },
{ "query": "NOT cm:creator:System" }
]
}
}Note that the entries of the filterQueries array are joined using the AND operator.
The Sorting configuration section consists of two blocks:
options: a list of items that users can select fromdefaults: predefined sorting to use by default
{
"search": {
"sorting": {
"options": [
{ "key": "name", "label": "Name", "type": "FIELD", "field": "cm:name", "ascending": true },
{ "key": "content.sizeInBytes", "label": "Size", "type": "FIELD", "field": "content.size", "ascending": true },
{ "key": "description", "label": "Description", "type": "FIELD", "field": "cm:description", "ascending": true }
],
"defaults": [
{ "key": "name", "type": "FIELD", "field": "cm:name", "ascending": true }
]
}
}
}The properties of the options objects are as follows:
| Name | Type | Description |
|---|---|---|
| key | string | Unique key to identify the entry. This can also be used to map DataColumn instances. |
| label | string | Display text, which can also be an i18n resource key. |
| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. |
| field | string | The name of the field. |
| ascending | boolean | The sorting order defined as true for ascending order and false for descending order |
See the Sort element in the ACS Search API for further details.
The Search Settings component and Query Builder require a categories section in the
configuration.
Categories are used to configure the UI widgets that let the user edit the search query at runtime. Every category is represented by a single Angular component, which can be either a simple one or a composite one.
export interface SearchCategory {
id: string;
name: string;
enabled: boolean;
expanded: boolean;
component: {
selector: string;
settings: SearchWidgetSettings;
};
}The interface above also describes entries in the search.query.categories section for the app.config.json file.
Note: you must provide at least one category field in order to execute the query, so that filters and selected facets are applied.
The Search Filter supports a number of widgets out of the box, each implemented
by an ADF component. The selector property specifies which widget is used for
a category:
Widget name |
Selector | Description |
|---|---|---|
| Check List | check-list |
Toggles individual query fragments for the search |
| Date Range | date-range |
Specifies a range f dates that a field may contain |
| Number Range | number-range |
Specifies a range of numeric values that a field may contain |
| Radio List | radio |
Selects one query fragment from a list of options |
| Slider | slider |
Selects a single numeric value in a given range that a field may contain |
| Text | text |
Specifies a text value that a field may contain |
See the individual Search Widget pages for full details of their usage and settings.
You can also implement your own custom search widgets. See the Search Widget Interface interface page for full details of how to do this.
Each type of widget has its own settings. For example Number editors may parse minimum and maximum values, while Text editors can support value formats or length constraints.
You can use component.settings to pass any information to a widget using the
SearchWidgetSettings interface:
export interface SearchWidgetSettings {
field: string;
[indexer: string]: any;
}{
"search": {
"facetFields": {
"expanded": true,
"fields": [
{ "field": "content.mimetype", "mincount": 1, "label": "Type" },
{ "field": "content.size", "mincount": 1, "label": "File Size" },
{ "field": "creator", "mincount": 1, "label": "Creator" },
{ "field": "modifier", "mincount": 1, "label": "Modifier" },
{ "field": "created", "mincount": 1, "label": "Created" }
]
}
}
}Every field declared within the facetFields group is presented by a separate collapsible category at runtime.
By default, users see only the top 5 entries. If there are more than 5 entries, a button to show more items is displayed to let the user move to the next block of results.
| Name | Type | Default | Description |
|---|---|---|---|
| field | string | Specifies the facet field. | |
| mincount | number | 1 | Specifies the minimum count required for a facet field to be included in the response. The default value is 1. |
| label | string | Specifies the label to include in place of the facet field. | |
| prefix | string | Restricts the possible constraints to only indexed values with a specified prefix. | |
| limit | number | Maximum number of results | |
| pageSize | number | 5 | Display page size |
| offset | number | Offset position |
These provide custom categories based on admin-defined facet queries.
{
"search": {
"facetQueries": {
"label": "Facet queries",
"pageSize": 5,
"expanded": true,
"queries": [
{ "query": "created:2018", "label": "Created This Year" },
{ "query": "content.mimetype:text/html", "label": "Type: HTML" },
{ "query": "content.size:[0 TO 10240]", "label": "Size: xtra small"},
{ "query": "content.size:[10240 TO 102400]", "label": "Size: small"},
{ "query": "content.size:[102400 TO 1048576]", "label": "Size: medium" },
{ "query": "content.size:[1048576 TO 16777216]", "label": "Size: large" },
{ "query": "content.size:[16777216 TO 134217728]", "label": "Size: xtra large" },
{ "query": "content.size:[134217728 TO MAX]", "label": "Size: XX large" }
]
}
}
}By default, the queries declared in the facetQueries are collected into a single collapsible category.
The mincount property allows setting the minimum count required for a facet field to be displayed. By default, only the queries that have 1 or more response entries are displayed at runtime.
The component provides a Show more button to display more items if the number of items
exceeds the pageSize value.
You can also provide a custom label (or i18n resource key) for the default resulting collapsible category.
If you need to display more resulting collapsible categories, you can group different facet queries under custom labels by using the group property on those facet queries:
{
"search": {
"facetQueries": {
"label": "Facet queries",
"pageSize": 5,
"expanded": true,
"mincount": 0,
"queries": [
{ "query": "created:2018", "label": "Created This Year" },
{ "query": "modifier:admin", "label": "Admin modifier" },
{ "query": "content.mimetype:text/html", "label": "Type: HTML", "group":"Type facet queries" },
{ "query": "content.mimetype:image/png", "label": "Type: PNG", "group":"Type facet queries" },
{ "query": "content.size:[0 TO 10240]", "label": "Size: xtra small", "group":"Size facet queries"},
{ "query": "content.size:[10240 TO 102400]", "label": "Size: small", "group":"Size facet queries"},
{ "query": "content.size:[102400 TO 1048576]", "label": "Size: medium", "group":"Size facet queries" },
{ "query": "content.size:[1048576 TO 16777216]", "label": "Size: large", "group":"Size facet queries" },
{ "query": "content.size:[16777216 TO 134217728]", "label": "Size: xtra large", "group":"Size facet queries" },
{ "query": "content.size:[134217728 TO MAX]", "label": "Size: XX large", "group":"Size facet queries" }
]
}
}
}This will result in the following display of the grouped facet queries:
The pageSize property allows you to define the number of results to display.
Users will see Show more or Show less buttons as appropriate for the result set.
The default page size of 5 will be used if you set the value to 0 or omit it entirely.
These provide custom categories based on admin defined ranges inside intervals.
You can specify exactly what you want for each interval in the config file and you can
use overlapping ranges if necessary.
| Name | Type | Description |
|---|---|---|
| intervals | array | Specifies the fields to facet by interval. |
| expanded | boolean | Toggles expanded state of the facet intervals. |
Note: the sets parameter from the Search API (which sets the intervals for all fields)
is not yet supported.
{
"search": {
"facetIntervals":{
"expanded": true,
"intervals":[
{
"label":"TheCreated",
"field":"cm:created",
"sets":[
{ "label":"lastYear", "start":"2017", "end":"2018", "endInclusive":false },
{ "label":"currentYear", "start":"NOW/YEAR", "end":"NOW/YEAR+1YEAR" },
{ "label":"earlier", "start":"*", "end":"2017", "endInclusive":false }
]
},
{
"label":"TheModified",
"field":"cm:modified",
"sets":[
{ "label":"2016", "start":"2017", "end":"2018", "endInclusive":false },
{ "label":"currentYear", "start":"NOW/YEAR", "end":"NOW/YEAR+1YEAR" },
{ "label":"earlierThan2017", "start":"*", "end":"2017", "endInclusive":false }
]
}
]
}
}
}You can specify a value for the mincount property inside each intervals item to set the minimum count required for a facet interval to be displayed. By default, only the intervals that have 1 or more response entries are displayed at runtime.
Check the schema.json file
for further details about the structure and properties of intervals that you can set inside the configuration file.
Each defined intervals item is collected into its own collapsible category identified uniquely
by its label. The code snippet just above will result in the following display of facet intervals:
You can configure highlighting using the search entry in the app.config.json file.
An example query for search highlighting could look like this:
{
"search": {
"highlight": {
"prefix": "¿",
"postfix": "?",
"mergeContiguous": true,
"fields": [
{
"field": "cm:title"
},
{
"field": "description",
"prefix": "(",
"postfix": ")"
}
]
}
}
}The example above changes the highlighting prefix and postfix from the default to '¿?' for all fields except the "description" field, which uses '()' instead. The highlight information will then be added in each node entry response. An example partial response is shown below:
"entry": {
"createdAt": "2016-10-12T15:24:31.202+0000",
"isFolder": true,
"search": {
"score": 1,
"highlight": [
{
"field": "cm:title",
"snippets": [
"Customized ¿Workflow? Process Definitions"
]
},
{
"field": "description",
"snippets": [
"Customized (Workflow) Process Definitions"
]
}
]
},