Faceted search (ps_facetedsearch)

The module is used for filtering the catalog and helping the visitors to see the category tree and to browse the webshop store easily.

QA

Link to the tests

Common components

Indexes and caches block

There are 4 types of buttons (Buttons Outline UI Kit) for indexing and caching the category tree:

  • Index all missing prices - clicking the button executes the indexation of all missing prices. The progress status of the indexed items will be shown on the button and after successful indexation, there will be a green success message (Alerts Basics UI Kit) called: Price indexing finished.

  • Rebuild entire price index - clicking the button executes the indexation of entire prices. The progress status of the indexed items will be shown on the button and after successful indexation, there will be a green success message (Alerts Basics UI Kit) called: Price indexing finished. During the progress, it will be a yellow alert message (Alerts Basics UI Kit): Indexing is in progress. Please do not leave this page

  • Build attributes and features - clicking the button executes the indexation of entire attributes and features. The progress status of the indexed items will be shown on the button and after successful indexation, there will be a green success message (Alerts Basics UI Kit) called: Attribute indexing finished. During the progress, it will be a yellow alert message (Alerts Basics UI Kit): Indexing is in progress. Please do not leave this page

  • Clear cache - clicking the button executes the clearing the cache. The progress status of the indexed items will be shown on the button and after successful indexation, there will be a green success message (Alerts Basics UI Kit) called: Attribute indexing finished. During the progress, it will be a yellow alert message (Alerts Basics UI Kit): Indexing is in progress. Please do not leave this page

Information section has these notifications (Alerts Basics UI Kit):

You can set a cron job that will rebuild price index using the following URL: {host URL}/modules/ps_facetedsearch/ps_facetedsearch-price-indexer.php?token={token} You can set a cron job that will rebuild attribute index using the following URL: {host URL}/modules/ps_facetedsearch/ps_facetedsearch-attribute-indexer.php?token={token}

A nightly rebuild is recommended.

Filters templates block

The templates are listed in the table (Tables Basic UI Kit). The table title has a numeric value near, showing the total value of templates. There are the following headers of the table:

  • ID - the ID of the template.

  • Name - the name of the template.

  • Categories - shows how many categories are in the templates.

  • Created on - shows the creation timestamp.

  • Actions - Edit button (Buttons With Icons UI Kit) - redirects to the adding a new filter template form, and the dropdown, where Delete action is. Clicking Delete shows the browser-type pop-up UI with the question: Do you really want to delete this filter template? Cancel closes the pop-up, OK - deletes the template with the alert message (Alerts Basics UI Kit): Filter template deleted, categories updated (reverted to default Filter template).

  • Add new template CTA button - redirects to adding a new filter template form.

New filters template section

A page for editing or adding a new filter template.

Common components:

Template name - ability to name the template. Helper text: Only as a reminder

Categories used for this template - ability to mark the required categories and to use Checkmark navigation CTA buttons.

Choose shop association - ability to mark the required Shops using Shop association block and to use Checkmark navigation CTA buttons.

Filters

This block has multiple filter blocks, that can be drag-and-dropped, positioned in any way. The filter criteria have the following elements:

  • Toggle switch button (Toggle Switch Storybook UI) - for Enabling or Disabling the filter.

  • Filter name - name of the filter.

  • Filter style - selection with the dropdown - Checkbox, Radio button or Drop-down list.

  • Filter result limit - selection with the dropdown - from No limit to 20.

Cancel - call to action CTA which redirects to the Faceted Search configuration page.

Save - call to action CTA which saves the form and returns green success notification (Alerts basics UI Kit): Your filter "Template name" was updated successfully.

If the submission fails, the message will be: You must select at least one category.

Configuration block

Configuration block.

These settings contain Forms Switch UI Kit and Forms Normal UI Kit elements.

  • Enable cache system - Disabled or Enabled (By default Enabled).

  • Show the number of matching products - Disabled or Enabled (By default Enabled).

  • Show products from subcategories - Disabled or Enabled (By default Enabled).

  • Show products only from default category - Disabled or Enabled (By default Disabled). The helper text is: Works only if "Show products from subcategories" is off.

  • Category filter depth (0 for no limits, 1 by default) - input field by default the value is 1.

  • Use tax to filter price - Disabled or Enabled (By default Enabled).

  • Use rounding to filter price - Disabled or Enabled (By default Enabled).

  • Show unavailable, out of stock last - Disabled or Enabled (By default Disabled).

  • Save CTA - once the form is submitted, there will be an alert from Alerts Basics UI Kit with the message: Settings saved successfully

Configuration block

Configuration block.

Multistores functionality

Multistores dependent.

Last updated