Search
Description
This page enables the ability to configure the webshop's searching parameters.
QA
Common components
Bell icon (todo link)
4 table header tools (todo link)
Add new alias CTA button
Button from the Buttons with icons UI Kit. Clicking the button redirects to the adding a new Alias page.
Tabs navigation
The page has a navigation component from the Navigation Pills UI Kit. The tabs are:
Search (active tab)
Tags
Search section
The block starts with the title Search and a numeric value of the total search entries.
5 table header tools
The top right header side displays the 4 table header tools (todo link), plus another fifth cloud-styled Import button. Clicking on this could-style icon will redirect to the Import page of the webshop.
Sorting the table
Sorting the table uses the Sorting rules functionality. The sorting headers of the table are:
Aliases
Search
Sorting the Status header has only 2 values:
Yes
No
Table filtering
Table uses standard input fields for filtering. The filtering can be made in these inputs:
Aliases
Search
After the filtering has been inputted, CTA button (Buttons with Icons UI Kit) Search can be executed for the search results.
Table content
By the default installation of the webshop, there are 2 entries already saved to the search engine:
Aliases - bloose, blues
Result - blouse
The rest of the content:
Checkbox - Forms Checkboxes UI Kit element. Marks or unmarks the desired selection of entry.
Alias name - displays the alias name.
Search query - displays the final output value of the aliased search query.
Status checkmark - checkmark, that can be Enabled (green checkmark) and Disabled (red cross) by toggle clicking separately.
Edit or Delete dropdown - Dropdowns With Button Split UI Kit component, that lets delete or edit the certain Alias.
Bulk actions
Clicking on the Bulk actions button allows users to perform bulk actions for selected features (using the checkboxes). A user can:
Enable selection - this button will enable all the checkboxes that are selected.
Disable selection - this button will disable all the checkboxes that are selected.
Delete selected - This button will delete the selected employees. After clicking on "Delete selected", a modal with the title "Delete selection" is opened, asking to confirm or cancel the action: "Are you sure you want to delete the selected item(s)?" (See issue #14462). The action can be canceled by clicking on the cross or on the cancel button. After clicking on "Delete" button, the selected employee will be deleted, a successful message is displayed "The selection has been successfully deleted."
If nothing is selected, and the execution is made, there will be an Alert Basics UI Kit message:
You must select at least one element to delete.
Indexing section
The block starts with the gear-style icon and the title Indexing.
Furthermore, there are some text paragraphs:
The "indexed" products have been analyzed by PrestaShop and will appear in the results of a front office search. Indexed products {numeric value / numeric value}.
Building the product index may take a few minutes. If your server stops before the process ends, you can resume the indexing by clicking "Add missing products to the index".
{arrow_icon} Add missing products to the index - adds the missing products to the index. Successful attempt indicated by Alerts Basics UI Kit message.
{arrow_icon} Re-build the entire index - rebuilds entire index of the search. Successful attempt indicated by Alerts Basics UI Kit message.
You can set a cron job that will rebuild your index using the following URL:
{URL_with_cronjob_parameters}
Indexing
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | Enable the automatic indexing of products. If you enable this feature, the products will be indexed in the search automatically when they are saved. If the feature is disabled, you will have to index products manually by using the links provided in the field set. | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Search section
The section starts with the magnifying-glass-styled icon and the title Search.
There are 2 links in the beginning:
{arrow_icon} Signaler un problème sur GitHub - redirects to the GitHub issues page, where to search for possible bug.
{arrow_icon} Proposer une idée d'amélioration sur GitHub - redirects to the GitHub issues page, where to report a possible bug.
Search within word
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | Disabled | - |
Help text | By default, to search for “blouse”, you have to enter “blous”, “blo”, etc (beginning of the word) – but not “lous” (within the word). With this option enabled, it also gives the good result if you search for “lous”, “ouse”, or anything contained in the word. | - |
Tool tips | Enable search within a whole word, rather than from its beginning only. It checks if the searched term is contained in the indexed word. This may be resource-consuming. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Search exact end match
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | Disabled | - |
Help text | By default, if you search "book", you will have "book", "bookcase" and "bookend". With this option enabled, it only gives one result “book”, as exact end of the indexed word is matching. | - |
Tool tips | Enable more precise search with the end of the word. It checks if the searched term is the exact end of the indexed word. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Fuzzy search
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | Enabled | - |
Help text | By default, the fuzzy search is enabled. It means spelling errors are allowed, e.g. you can search for "bird" with words like "burd", "bard" or "beerd". Disabling this option will require exact spelling for the search to match results. | - |
Tool tips | Enable approximate string matching. | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Maximum approximate words allowed by fuzzy search
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values are allowed. | - |
Default value | 4 | - |
Help text | - | - |
Tool tips | Maximum approximate words allowed by fuzzy search | - |
Lower limit | - | - |
Upper limit | 10 | The Maximum approximate words allowed by fuzzy search field is invalid. |
Behavior | - |
Maximum word length (in characters)
| Description | Value | Error message |
|---|---|---|
Mandatory | YES | field Maximum word length (in characters) is required. |
Allowed/Forbidden values | Numeric values only allowed. | The Maximum word length (in characters) field is invalid. |
Default value | 15 | - |
Help text | This parameter will only be used if the fuzzy search is activated: the lower the value, the more tolerant your search will be. | - |
Tool tips | Maximum word length (in characters) | - |
Lower limit | - | field Maximum word length (in characters) is required. |
Upper limit | 11 | The Maximum word length (in characters) field is invalid. |
Behavior | - |
Minimum word length (in characters)
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Numeric values only allowed. | The Maximum word length (in characters) field is invalid. |
Default value | English or other language set earlier | - |
Help text | - | - |
Tool tips | Only words this size or larger will be indexed. | - |
Lower limit | - | - |
Upper limit | 11 | The Minimum word length (in characters) field is invalid. |
Behavior | - |
Blacklisted words
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Any characters | - |
Default value | Values with blacklisted words, separated by | | - |
Help text | - | - |
Tool tips | Please enter the index words separated by a " | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Weight section
The section starts with the gear-style icon, and a title Weight.
The following text is:
The "weight" represents its importance and relevance for the ranking of the products when completing a new search. A word with a weight of eight will have four times more value than a word with a weight of two.
We advise you to set a greater weight for words which appear in the name or reference of a product. This will allow the search results to be as precise and relevant as possible.
Setting a weight to 0 will exclude that field from search index. Re-build of the entire index is required when changing to or from 0
Product name weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Product name weight field is invalid. |
Default value | 6 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Product name weight field is invalid. |
Behavior | - |
Reference weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Reference weight field is invalid. |
Default value | 10 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Reference weight field is invalid. |
Behavior | link to the behavior | - |
Short description weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Short description weight field is invalid. |
Default value | 1 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Short description weight field is invalid. |
Behavior | link to the behavior | - |
Description weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Description weight field is invalid. |
Default value | 1 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Description weight field is invalid. |
Behavior | - |
Category weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Category weight field is invalid. |
Default value | 3 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Category weight field is invalid. |
Behavior | link to the behavior | - |
Brand weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Brand weight field is invalid. |
Default value | 3 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Brand weight field is invalid. |
Behavior | - |
Tags weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Tags weight field is invalid. |
Default value | 4 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Tags weight field is invalid. |
Behavior | - |
Attributes weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Attributes weight field is invalid. |
Default value | 2 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | 10 | The Attributes weight field is invalid. |
Behavior | - |
Features weight
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | Only numeric values allowed. | The Features weight field is invalid. |
Default value | 2 | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | |
Upper limit | 10 | The Features weight field is invalid. |
Behavior | - |
Behavior descriptions
Indexing behavior
Forms Switch UI Kit component. Automatically adds every new product to the indexing range.
Search within word behavior
Forms Switch UI Kit component. After enabling this function, users can search the desired item within the root of the targeted word, not targeted from the beginning of the word.
Search exact end match behavior
Forms Switch UI Kit component. After enabling this function, users can find the desired item (or items) by searching only for the exact word.
Fuzzy search behavior
Forms Switch UI Kit component. Enabling this functionality, lets users to search between very familiar root words, like bird, bard, breed etc.
Maximum approximate words allowed by fuzzy search behavior
Forms Normal UI Kit component. Specific amount of words can be set, for fuzzy search.
Maximum word length (in characters) behavior
Forms Switch UI Kit component. Maximum amount of characters can be set, for fuzzy search results tolerance. The lower the value the more tolerant the search will be.
Minimum word length (in characters) behavior
Forms Switch UI Kit component. Minimum amount of characters can be set, for search results tolerance. The lower the value the more tolerant the search will be.
Blacklisted words behavior
Forms Switch UI Kit component. Blacklisted words can be stored in this field, separated by "|" pipe character.
Product name weigh behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Reference weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Short description weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Description weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Category weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Brand weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Tags weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Attributes weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Features weight behavior
Forms Switch UI Kit component. This field represents the importance for the ranking of the products, after executing a new search. Setting a weight to 0 will exclude that field from the search eindex.
Multistores functionality
This page is Multistores indpendent page.
Last updated
