Skip to main content

Faceted search

System » Client » Settings » Services » Faceted search

Old: CMS & online store

This manual page describes functions that pertain to the old plentymarkets online shop Callisto. For information regarding the online store template Ceres, please refer to the Setting up Ceres page.

Facets are the various filter possibilities that are used to narrow down search results in the online store by specific criteria (facets). The faceted search has the advantage that search results are not necessarily limited by the selected criteria. Rather, the criteria are always searched for in the entire database. In other words, users are led through the search process intuitively and search results do not have to be faked if customers select criteria that are not helpful. Offer customers the faceted search to improve usability in your online store. The search only has a one hour delay in data synchronisation, so it is always up-to-date.

1. Faceted search with plentymarkets

Availability

Customers who have a plentymarkets Cloud contract can use the configurator to book the faceted search. This module is not available for own server systems.

You can customise the filter navigation and design it individually in your CMS. The faceted search gives customers many more options than are included in other searches, e.g. the property search. Facets are not only used to find which items in a category have a specific property. Rather, they are also used to narrow down the item search by the following criteria:

  • by a desired price range

  • by attributes and properties

  • by the item availability

  • by the producer

In plentymarkets, these four facet types are combined with other values to determine the filter results. The more facets and values that you use, the more comprehensive the filters will be. The next chapters teach you how that works exactly.

EN Client Global Services Facets 01
Figure 1. example of the faceted search in the online store
Linking items to facets

You do not have to directly link items to the individual facets. Rather, items are automatically assigned to facets. This is done by giving facets values that are then saved in the item data record.

2. Configuration

This function is configured in several different steps. First, facets are created. Then their settings are customised further. Finally, they are linked to the desired values. Furthermore, you need to go to System » Client » Select client » Online store » Item search and select the option Faceted search.

2.1. Creating facets

First, you need to create different facets for the search, e.g. the facet "Color" with the type Attribute/property.

Creating a new facet:

  1. Go to System » Client » Settings » Services » Faceted search.

  2. Click on New to add a new facet.

  3. Enter a name for the facet in the system’s language.

  4. Select a type from the drop-down list. Pay attention to the explanations given in Table 1.

  5. Enter the *position*a where the faacet should appear in the online store.

  6. Save the settings.

Table 1. available facet types
Facet type Explanation

Price

Facets of the type Price do not have to be linked to values. Rather, customers can filter from the smallest to the largest price within a category.

Attribute/property

Facets of the type Attribute/property are linked to the attributes and properties in your system. They are used to create diverse filters, e.g. colors, sizes etc.

Availability

Facets of the type Availability, e.g. "ships within 24 hours", are linked to the availabilities found under System » Item » Availability.

Manufacturer

Facets of the type Manufacturer, e.g. "Adidas", are linked to the manufacturers found under System » Item » Manufacturers.

2.2. Configuring facets

The facet opens when it is created. There are four tabs for carrying out additional settings and linking values. This chapter explains the settings in the tabs Settings and Name. Explanations of the tabs Values and Images are found in chapter 2.3.

2.2.1. Tab: Settings

Carry out the settings as described below.

Editing facets:

  1. Go to System » Client » Settings » Services » Faceted search.

  2. Open the facet.

  3. Pay attention to the explanations given in Table 2 and configure the Settings tab as desired.

  4. Save the settings.

Table 2. editing facets; tab Settings
Setting Explanation

Type

Indicates which type was selected when the facet was created. The type cannot be changed.

Sorting

Determines how the search results should be sorted. Depending on which option is selected, items will either be sorted by relevance, position number or alphabetically from A-Z.

Position

Indicates which position was selected when the facet was created. The position can be changed here.

CSS class

Enter a CSS name. This name will be made available as a template variable in the CMS menu so that every facet can be saved as an individual class.

Selection type

Choose the selection type.
Restricting = Further limits the filter with the selected value. All items will be displayed that have this value and that fulfill the criteria of any previously selected filters.
Multiple = Makes it possible for multiple search results to be displayed together. For example, this option makes it possible for customers to select multiple manufacturers. The manufacturers' items will all be displayed together.

Minimum number of hits

Specifies the minimum number of results that a facet value needs to have in order to be displayed in the online store.

Maximum number of facet values shown

Specifies the maximum number of facet values that will be displayed per facet. A maximum of 250 facet values can be displayed.

2.2.2. Tab: Name

Use the Name tab to enter facet names in all of the languages that are offered in your online store. The translations that are entered here will be used for the specified languages.

2.3. Linking facets to values and images

Carry out the settings in the tabs Values and Images as described below.

2.3.1. Tab: Values

Use the Values tab to link facets to different values. For example, if you have a color facet of the type Attribute/property, then create the values e.g. white, black, red, blue, etc and link these values with the existing item attributes and properties in your system. To do so, proceed as follows.

Creating a new value:

  1. Go to System » Client » Settings » Services » Faceted search.

  2. Open the facet that you want to add values to.

  3. Click on the Values tab.

  4. Click on the green plus icon in the bottom left corner to add a new value.

  5. Enter a name for the value in the system’s language.

  6. Enter a position.

  7. Save the settings.
    → The new value will be created.

The values that were created are displayed on the left. Further define the values in the next steps and link these values with information from your system. In the example of the type Attribute/property, it is especially useful that attributes and properties are grouped together in one filter in your system and can thus be displayed together in the search result.

Name and Settings tabs within a value

Use the value’s Name tab to save names for the value in different languages.
Use the value’s Settings tab to save a Position and CSS class for the value, just as was also done for the facet (Table 2).
The following section explains how to link the values.

Linking facets to values:

  1. Go to System » Client » Settings » Services » Faceted search.

  2. Open the facet that you want to add values to.

  3. Click on the Values tab.

  4. Click on the value that you want to link.

  5. Click on the Link tab.

  6. Select the attribute or property that you want to link from the list.

  7. Click on Link in the bottom left corner.
    → The attribute or property will be linked to the facet’s value.

  8. Save the settings.

Values that were linked are displayed with a green check mark. Values that were not linked are displayed with a red x.

2.3.2. Tab: Images

Use the Images tab to link the facets and their values to images. For example, this is useful if you want to use logos rather than names to list producers in your online store.

3. Full text search - Tab: Search index

Use the Search index tab to specify various criteria that improve the full text search in your online store. This full text search is much more tolerant of errors than the standard item search in plentymarkets. For example, the faceted search can recognise search terms that include typos. Customers do not have to enter the exact item or manufacturer name in order to see results. For example, customers would still find the manufacturer "adidas" even if they incorrectly entered "addidas" or "adids". Items that are manufactured by this manufacturer would still be displayed in the search results. Configure the following 3 tabs for this:

  • Use the Boost tab to specify how the four areas Keywords 1, Keywords 2, Name or Full text should be prioritised when displaying search results.

  • The Keyword tab is used to specify which texts belong to the areas Keywords 1 and 2. The Name section refers to the item names in this online store.

  • Use the Description tab to specify which texts should be taken into consideration in the Full text area.

3.1. Tab: Boost

Enter a number into each field of the Boost tab. This specifies how each area should be prioritised when displaying search results. To do so, proceed as follows.

EN Client Global Services Facets 02
Figure 2. search index; Boost tab

Specifying the boost:

  1. Go to System » Client » Settings » Services » Faceted search.

  2. Click on the Search index tab.
    → The Boost tab opens automatically.

  3. Enter a number between 1 and 100 into each field. The higher the number, the more this area will be prioritised in the search results. Results will be displayed first for the area with the highest number.

  4. Save the settings.

3.2. Tab: Keyword

Use the Keyword tab to assign the various texts to the areas Keyword 1 or Keyword 2. These texts will be prioritised according to the number that was entered in the Boost tab.

Settings in the Keyword tab

Select which area (priority) each of the texts listed here should be assigned to. The numbers next to Category 1 - 6 specify the category level. We recommend prioritising the higher levels over the lower ones.

3.3. Tab: Description

Use the Description tab to specify which of the item’s texts should be analyzed for the Full text area.

Choosing the descriptions:

  1. Go to System » Client » Settings » Services » Faceted search.

  2. Click on the Search index tab.

  3. Click on the Description tab.

  4. Place a check mark next to the texts that should be taken into consideration for the search in the Full text area.

  5. Save the settings.

4. Linking facets in the online store

Once you have created your facets, link them in the default online store or in a client (store). This is done by making them available as filters. Decide which facets are relevant for each client (store) and which ones are not. Changes that you make here will go into effect in real time. Proceed as follows to link facets to a store.

Go to System » Client » Select client » Services » Facet links to configure the settings. Select which store you want to link to the facets.

Price facet

Only one price facet can be linked per store.

Linking facets in the online store:

  1. Go to System » Client » Select client » Services » Facet links.

  2. Select which facets you want to link to this store from the list on the left.

  3. Click on Link facet in the bottom left corner.
    → The facet will be linked in the online store.

  4. Repeat this process for all remaining facets that should be linked here.

  5. Save the settings.

Facets that were linked are displayed with a green check mark. Facets that were not linked are displayed with a red x.

Option: Make images available

Check mark = Images that are linked to the facets will be displayed in the online store.

5. Adding the faceted search to the CMS

The faceted search is defined in the template NavigationFacetsList. The template NavigationFacetsList is part of our standard design, Callisto Light. This template includes code that you can use to create a faceted search as displayed in Figure 1. Of course, this code can be modified as needed.
Use the template function Container_NavigationFacetsList to insert the template NavigationFacetsList into the desired area of your online store. To do so, proceed as follows.

Recommended templates

We recommend using the template function Container_NavigationFacetsList in ItemViewCategoriesList and ItemViewSearchResultsList. These templates are found in the menu CMS » Web design » Folder: Layout » Folder: ItemView.

Adding the faceted search to the CMS:

  1. Go to CMS » Web design.

  2. Open the desired template.

  3. Insert the template function Container_NavigationFacetsList into the template to display the faceted search.

  4. Save the settings.

  5. Repeat the steps above if you want to insert the template function into additional templates.

To top