Configuring A Search Profile

TABLE OF CONTENTS

Navigate to: Marketing > Site Search > Search Profiles > Add/Edit Search Profile - Search Profile tab

Search Profiles allow administrators to efficiently manage the creation of search configurations using

  1. Searchable fields

  2. N-Gram Settings

  3. Character Filters

  4. Relevance rankings

  5. Search query properties and operators

  6. Facets

that can be used to configure the rules using which the search functionality will find and display results on the webstore.

Search Profile Default Configurations

When the administrators try to create a new search profile from the admin application the following will be the default configurations selected:

Setting

Value

Searchable Fields

  • Product Name

  • SKU

N-Gram

Applicable on the following searchable fields:

  • Product Name

  • SKU

Min Gram - Max Gram: 1 - 40

Character Filter

"- => ", "_ => "

Relevance Ranking

NA

Query Properties - Query Type

Multi-Match - Cross

Query Properties - Operator

AND

Autocorrect

No

Search Profile Configurations

  1. Searchable Fields 

From this section, administrators can add and manage the product attributes/fields where the entered keywords will be searched on the web store. Administrators can also define the following along with the searchable fields:

  1. Boost Score: A boost score between 1 and 999 can be added to this input.
    Boost Score is used during search time (also known as query time) to promote the position of the products in search results therefore when the searched keyword is found in the respective searchable field whose boosting score is the greater, that product will be promoted on the top of search results.

  2. N-Gram: N-Grams for the specific fields can be enabled/disabled.
    N Grams are used during index time to generate tokens for the respective searchable field values for every product in a catalog. This index is then used by the web store when a keyword is searched. The tokens generated during search time are matched with the existing tokens available in the index to bring the search results.

  1. N-Gram Settings 

From this section, administrators can add and manage the Min Gram and Max Gram values that can be used to define the min and max length of the tokens that will be generated during index time.

  1. Character Filters 

From this section, administrators can define the character filters in the following format: “<character> => <character>”.  Character Filters allow administrators to define the replacement character for the mentioned character so that while searching it can be replaced with the defined character for providing better search results. For example, Let's suppose there is a product with the name T-Shirt, customers may search for this product with the term T-Shirt or with the term T Shirt. In order to display both the results a character mapping can be defined where - (dash) can be replaced with empty space. 

Some characters cannot be directly defined in search profiles and therefore unicodes are required instead. The character which cannot be directly defined and their Unicode can be referred to and used from the below table: 

Character

Unicode

Space

\\u0020

\\u0022

\

\\u005C

,

\\u002C  

Note -

  1. Empty string to any character mapping will not work but mapping of any character to an empty string can be possible.

  2. Character Filter is case-sensitive. 

  1. Relevance Ranking 

From this section, administrators can configure the way in which the search results will be sorted:

  1. Price - This can be used when the results need to be sorted using price in ascending or descending order. 

  2. Rating - This can be used when the results need to be sorted using average ratings in ascending or descending order.

  3. Total Reviews - This can be used when the results need to be sorted using the number of reviews in ascending or descending order. 

  1. Query Properties 

Query Properties defines the way in which the searched terms are searched on the webstore. 

  1. Query Types 

Multi-Match: When the Multi-Match query type is configured, the application searches keywords in more than one searchable field to display the results on the webstore. It has two types:

  1. Best: When Multi-Match - Best is selected, all the searched text/keywords must be available in any one of the searchable fields.
    For example, if the Searchable fields are Product Name and SKU, and Search Keyword entered is Dewalt Kit and this query type is selected then both the keywords “Dewalt” and/or “Kit” will be searched in every searchable field. If both the terms are found in either Product Name or SKU then only it will be displayed in the search results.

  2. Cross: When Multi-Match - Cross is selected, all the searched text/keywords  must be spread across multiple searchable fields..
    For example, if the Searchable fields are Product Name and SKU, and Search Keyword entered is Dewalt Kit and this query type is selected then both the keywords “Dewalt” and/or “Kit” will be searched in every searchable field and if anyone is available in one field and/or another one in same or different fields then the product will be displayed in the search results.

  1. Operators  

When two or more keywords are searched on the webstore, the Operator helps to decide whether the searchable fields should have all the entered keywords or at least one of the keywords to find search results on the webstore. There are two types of operators

  1. OR Operator: This operator gives results when at least one of the searched keywords is present in the search fields.

  2. AND Operator: This operator gives results when all the searched keywords are present in the searchable fields.

  1. Autocorrect 

When an entered keyword has a spelling mistake, autocorrect helps in identifying the correct spelling of the keyword and displays the relevant products in search results. Autocorrect provides a maximum of 2 characters of correction when searching results on the web store. Here are some criteria that this feature considers when Autocorrect is enabled:

 

Keyword Length

Details

0-2

No corrections are considered.

3-5

1 correction is considered.

>5

2 corrections are considered.

Note - Autocorrect is not supported with query type Multi-Match - Cross 

  1. Expected Behavior/Output Of Query Properties With All Possible Combinations

Suppose

Product P1 has Product Name = Belkin 12-Outlet Surge Protector and SKU = 578-0000

Product P2 has Product Name = DeWalt 3-Tool Combo Kit and SKU = Z-12345

The following chart shows the results with all query property combinations when certain keywords are searched:

Searched Keywords

Multi Match = Cross

Operator = AND

Multi Match = Cross

Operator = OR

Multi Match = Best

Operator = AND

Multi Match = Best

Operator = OR

578000

P1

P1

P1

P1

Belkin

P1

P1

P1

P1

Belkin 578

P1

P1

No results

P1

Belkin 79

No results

P1

No results

P1

Be

No results

No results

No results

No results

Bel Z-12

No results

P1, P2

P1

P1, P2

12345

P2

P2

P2

P2

Belkin Surge

P1

P1

P1

P1

Dewalt 345

P2

P2

No results

P2

Dewalt Kit

P2

P2

P2

P2

Belkin Dewalt

No results

P1, P2

No results

P1, P2

Viewing Search Results

Administrators can publish the latest search profile configurations and can check the search results from this section.

System Defined Search Profile

A Search Profile configuration is available in the database which is used when 

  1. User Profile or Account-based catalog is used on the web store

  2. Store-based catalog is used on the web store and no search profile is created for the same catalog from the admin application.

The following are the default configurations for the system-defined search profile:

Setting

Value

Searchable Fields

  • Product Name

  • SKU

N-Gram

Applicable on the following searchable fields:

  • Product Name

  • SKU

  • Brand

Min Gram - Max Gram: 1 - 40

Character Filter

“- => ", "_ => "

Relevance Ranking

NA

Query Properties - Query Type

Multi-Match - Cross

Query Properties - Operator

AND

Autocorrect

No

Changes on the Admin screen (from version Znode 9.7.1 and onwards)

  1. Changes from Znode 9.7.1

    1. On the admin screen following tabs will not be available under Marketing > Site Search > Search Profile - Add/Edit Search Profile - Query Properties

      1. Query Type

        1. Match Phrase Prefix

        2. Match

        3. Match Phrase

      2. Minimum Should Match

      3. Enable Accurate Scoring

  2. Changes from Znode 9.7.3

    1. On the admin screen the following new configuration settings are introduced under Marketing > Site Search > Search Profile - Add/Edit Search Profile

      1. N-Gram Settings is added

      2. Character Filter Setting is added

    2. Only one search profile can be created for one catalog, therefore the search profile will work for all the stores where the search profile’s catalog is associated.
      Note: The provision to mark the default search profile is removed because of this reason.

    3. It is mandatory to publish the changes to test the search from the admin application and to view the changes on the web-store.

    4. When no search profile is created for a catalog the system-defined search profile will work for that catalog on the web-store.

    5. Search Profiles defined in the admin application will only work for store-based catalogs. 

    6. After taking an upgrade all the existing search profiles will be deleted therefore administrators will have to manually create and configure the required search profiles.

  3. Limitation: There is no way to configure search profiles for Account and User Profile-based catalogs from the admin application therefore only system-defined search profiles work for Account and User Profile-based catalogs.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.