Plugin: Faceted navigation - default category selection
Usage
Enable the plugin
-
Select Plugins from the side navigation pane and click on the Faceted navigation - default category selection tile.
-
From the Location section, select the results page to which you would like to enable this plugin from the Select a results page select list.
| The plugin will take effect as soon as you finish running through the plugin setup steps. |
Configuration settings
The configuration settings section is where you do most of the configuration for your plugin. The settings enable you to control how the plugin behaves.
| The configuration key names below are only used if you are configuring this plugin manually. The configuration keys are set in the results page configuration to configure the plugin. When setting the keys manually you need to type in (or copy and paste) the key name and value. |
Triggered facets value
Configuration key |
|
Data type |
string |
Required |
This setting is optional |
Defines the selected tab for the default category selection. This setting also controls whether the facets have a selected value. Parameter 1 defines the facets.
Default selected value
Configuration key |
|
Data type |
string |
Required |
This setting is optional |
Specifies the default selected value for the target facet. Parameter 1 defines the facets, and Parameter 2 defines the target facet name.
Is target facet metadata field?
Configuration key |
|
Data type |
boolean |
Default value |
|
Required |
This setting is optional |
Specifies if the target facet is a meta facet. Parameter 1 defines the facets, and Parameter 2 defines the target facet name.
Meta class name
Configuration key |
|
Data type |
string |
Required |
This setting is optional |
Defines the meta class for the target facet, only required if Is target facet metadata field? is true. Parameter 1 defines the facets, and Parameter 2 defines the target facet name.
When setting keys manually, you need to supply the key name and value.
Examples
Change the default facet category selection based on Tab selection
This example demonstrates that the site facet will be automatically selected if no other tabs have been previously selected.
Given:
-
A search package with 2 data sources;
example~matrixandexample~funnelback. -
A tabbed facet (
Tabs) has been configured with these categories:-
All results, which returns documents from all data sources. -
Matrix, which returns documents from theexample~matrixdata source. -
Funnelback, which returns documents from theexample~funnelbackdata source.
-
-
A facet called
Formathas been configured on the meta classtype, which contains these categories:-
Website -
Image -
Document -
Video.
-
Configure the plugin as follows to select the Format facet as Website when the tab shows All results:
| Configuration key name | Parameter 1 | Parameter 2 | Value |
|---|---|---|---|
Triggered facets value |
Tabs |
|
|
Default selected value |
Tabs |
Format |
|
Is target facet metadata field? |
Tabs |
Format |
|
Meta class name |
Tabs |
Format |
|