This guide explains how to configure search and facets.
| Info |
|---|
Version 5.1This function is available in version 5.1 and later |
Overview
Search may now be configured to a much larger extent and user may filter down search results using facets. Facet search is made available when user has used quick search in toolbar and pressed enter to see all search results, or after having searched using canvas search.
...
select categories and sub categories
select facets and apply texts or select possible values for these facets
see if a catalogue in the search result has content
search result may be presented as a table or as a gallery
wizard style search can be defined to drill down sub categories and specifications
...
Usage
The categories are defined by the presentation types. Each presentation type must have a code. This code is used in profile.config to define the settings for the search result for that category.
...
Specification types which are checked as facet will appear on the left side facet pane of the search screen if any of the search results contains a value for that facet.
...
Search
...
result as table or gallery
Search result may also be presented as a gallery. Default, table or gallery, is defined in profile.config.
...
Search wizard
If sub types exist it is possible to define a drill down, wizard style search. The starting point of the wizard search can be placed on any presentation page using profile.config.
...
| Info |
|---|
Note that the category for bulletins ( |
Available facet id:s
The below facet id:s may be used. Also the persistent identity of specification types may be used as faced id.
...
Facet attribute | Description | Example |
|---|---|---|
id | Refers to the persistent identity of the specification | |
categories | List of categories which will display this facet. | <Facet id="ProductCategory" categories="Catalogue"/> |
excluded-categories | List of categories which will not display this facet. | <Facet id="PresentationDescription" excluded-categories="Part,Kit"/> |
availability | Will make facet become an option for any category | <Facet id="Region" availability="any-category"/> |
visibility | Will make facet always visible, that is as a column | <Facet id="Region" visibility="Visible"/> |
order | Is used to set sort order of facets, lowest number at top | <Facet id="Region" order="10"/> <CatalogueContentsFacet id="Content" categories="Catalogue" availability="any-category" visibility="Visible" order="1000"> |
Content icons to indicate what content is on a product
Predefined icons
The below sample icons can be referred from the configuration. Icon will appear as a symbol if content exist under a node.
...
Icon
...
Comment
...
icon="book"
...
Typically used for documentation
...
icon="cogs"
...
Typically used for spare part lists or kits
All available icons are listed here: Technical documentation - Icons.
Custom icons
It is possible to configure custom icons for the content using the css. Sample css as below.
Custom icons
| Code Block | ||
|---|---|---|
| ||
/* Change icon book */
/* Place image Manuals_small.png in site folder in AppData */
.new-advanced-search .hit-table-view .content .fa-book {
width: 20px;
height: 20px;
background-image:url('Manuals_small.png');
background-size: 20px 20px;
}
/* Change icon cogs */
/* Place image SpareParts_small.png in site folder in AppData */
.new-advanced-search .hit-table-view .content .fa-cogs {
width: 20px;
height: 20px;
background-image:url('SpareParts_small.png');
background-size: 20px 20px;
} |
Wizard search
By default Wizard search is turned on and will display on start page if sub categories of products exist.
A typical usage for Wizard search is to hide it on start page and instead create a place holder catalogue for Wizard search with label wizardsearch. Link a node on start page to the wizard search catalogue.
...
| language | xml |
|---|
...
Search hits as table or gallery
Default view is defined in the templates section of profile.config.
| Code Block | ||
|---|---|---|
| ||
<!-- To make gallery default method of presenting search results use this setting -->
<Templates>
<Presentation id="search-hit-gallery" template="preview">
<DataViewOption default-view-selector="Gallery"/>
</Presentation>
</Templates> |
Wizard search
By default Wizard search is turned on and will display on start page if sub categories of products exist.
A typical usage for Wizard search is to hide it on start page and instead create a place holder catalogue for Wizard search with label wizardsearch. Link a node on start page to the wizard search catalogue.
| Code Block | ||
|---|---|---|
| ||
<Presentation id="start" template="index" class="start view">
<Trigger label="start"/>
<!-- Hide Wizard Search on start page -->
<WizardSearch display="hidden"/>
</Presentation>
<!-- Specific settings for wizard catalogue if needed -->
<Presentation id="wizardsearch" template="index" class="wizardsearch view" remember-scroll="false">
<Trigger label-regex="wizardsearch"/>
<Layout display-id="header" class="hero content-v-bottom"/>
<SearchSettings display="hidden"/>
<CatalogueNavigator display="none"/>
</Presentation> |
Content icons to indicate what content is on a product
Predefined icons
The below sample icons can be referred from the configuration. Icon will appear as a symbol if content exist under a node.
Icon | Comment |
|---|---|
icon="book" | Typically used for documentation |
icon="cogs" | Typically used for spare part lists or kits |
All available icons are listed here: Technical documentation - Icons.
Custom icons
It is possible to configure custom icons for the content using the css. Sample css as below.
Custom icons
| Code Block | ||
|---|---|---|
| ||
/* Change icon book */
/* Place image Manuals_small.png in site folder in AppData */
.new-advanced-search .hit-table-view .content .fa-book {
width: 20px;
height: 20px;
background-image:url('Manuals_small.png');
background-size: 20px 20px;
}
/* Change icon cogs */
/* Place image SpareParts_small.png in site folder in AppData */
.new-advanced-search .hit-table-view .content .fa-cogs {
width: 20px;
height: 20px;
background-image:url('SpareParts_small.png');
background-size: 20px 20px;
} |
Search Scope
Search normally operates on the full database. But once an user has navigated to a catalogue, it is possible to search in that catalogue only. This is controlled by the scope manager.
...