Autocomplete for Hawksearch v2.0L-v4.0L (Lucene version)

This page is for Hawksearch v2.0L-v4.0L (older Lucene versions). If you are on Hawksearch v4.0 (Elasticsearch version), please click here for the correct Autocomplete guide.

 

Autocomplete Overview

Hawksearch provides you with complete control over the display of your users' autocomplete choices. From displaying suggested keywords,matching content and more, this guide shows you how to configure your Hawksearch Autocomplete to display what you want to suggest to your users on your site.


Best Practices & Tips

The Right Tool for the Job

Autocomplete is made up of multiple sections that can each be turned on or off. Not all of the sections will display all of the time. The sections that display depend on the configuration of Autocomplete as well as the keyword typed by the user and the matches founds in Hawksearch.

 

Matching Suggestions in Autocomplete

When the user starts typing, matching values will start to display to the user:

  1. Popular Searches
    This section will suggest keywords that other users have searched that match the user’s keyword so far. Clicking on of these terms will initiate a search for the keyword clicked on. For example, if the user types “camp” and “camp chair” is suggested popular search. When the user clicks on “camp chair” the result page will display the search results for the keyword, “camp chair.”

  2. Top Product Categories
    This section will suggest values from facets to your user. The values will match the keyword entered and can pull from multiple facets, not only categories (i.e. color, brand, department, etc). Clicking on one of these facet values will display all the records that have that facet value. For example, the user types “camp” and “Camp & Hike” is a value suggested from the Category facet. When the user clicks on “Camp & Hike,” the result page will display all records in the Camp & Hike category.

  3. Top Product Matches
    Product records are used on sites that display, and often sell, products. If your site is content-only, this section will not apply to you. This section will display products that match the keyword that has been entered so far. These products would be the first products in the search results if the search was executed without any further characters in the search bar.

  4. Top Content Matches
    Content records are used on sites that index records like pages, articles, videos, blog posts, etc. If your site is products-only, this section will not apply to you. This section will display content records that match the keyword that has been entered so far. These would be the first content records in the search results if the search was executed without any further characters in the search bar.


Autocomplete Configuration Page

  1. To navigate to the Autocomplete Configuration section, click on the "Workbench" tab in the top navigation.

  2. Next, select "Keyword Search" from the left navigation.

  3. From the list of subcategories, select "Autocomplete.”

  4. The Top Facets section indicates if it is enabled and lists the facets that are included in Autocomplete. To modify the configuration of the Top Facets (a.k.a. “Top Categories”), click on Update Top Facets button.

  5. The Popular Searches section indicates if it is enabled and the maximum number of popular searches that could be returned in Autocomplete. To modify the configuration of the Popular Searches (a.k.a. “Keywords”), click on Update Popular Searches button.

  6. The Top Product Matches section indicates if it is enabled and the maximum number of products that could be returned in Autocomplete. To modify the configuration of the Top Product Matches, click on Update Top Product button.

  7. The Top Content Matches section indicates if it is enabled and the maximum number of content records that could be returned in Autocomplete. To modify the configuration of the Top Content Matches, click on Update Top Content button.

  8. If you need to modify the Layout or Label properties, click on the Layout tab. This includes updating the labels that can be displayed to users.


Configuring Autocomplete Sections

 

Top Facets

  1. To enable Top Products, turn on Is Enabled.

  2. Set the maximum number of facet values that you would like your user to see. You can specify up to five.

  3. Review the list of facets and select the ones that you would like to have displayed. Turn on the radio button next to the ones you want displayed.

  4. Make sure to click “Save” after setting up the Top Facets configuration.


Popular Searches

Popular keywords can be used to prompt the user in Autocomplete. When enabled, these words will be returned in Autocomplete when the keyword qualifies as popular .

  1. The Top Queries section is where this section of Autocomplete is turned on or off, as well as how many (maximum) suggested Popular Searches will be displayed to the user.

  2. The Auto-Generated Popular Searches will be defined by the Date Range and the Min # of Searches that are configured here.

  3. Clicking “Show top 50 Matching Keywords” button will allow you to see some of the keywords that fall within the popular searches, as configured.

  4. Terms that you want to exclude from ever appearing as popular can be entered in the Exclude Terms section. These keywords will not display as popular, even if they are.

  5. Terms that you want to manually include in the popular keywords can be entered in the Popular Search Terms section. These keywords will display if they match the characters entered by the user, even if they are not popular.

  6. Make sure to click “Save” after setting up the Popular Searches configuration.


Top Product Matches

  1. To enable Top Products, turn on Is Enabled.

  2. Set the number of results that you would like your user to see. You can specify up to five.

  3. You have the ability to set HTML here to control the display of the results. Hawksearch strongly recommends that you only allow developers with experience in HTML to make these adjustments.

  4. Make sure to click “Save” to save your settings.


Top Content Matches

  1. To enable Top Content Matches, turn on Is Enabled.

  2. Set the maximum number of content results that you would like your user to see. You can specify up to five.

  3. You have the ability to set HTML here to control the display of the results. Hawksearch strongly recommends that you only allow developers with experience in HTML to make these adjustments.

  4. Make sure to click “Save” to save your settings.


Autocomplete Layout

Tweak the look and feel of your site's Autocomplete with the Layout enhancement page. CSS styles are exposed to provide enough control. Instantly see the look and feel before it gets applied on your site. 

  1. Use the "Items Style" section to update individual attributes for each item.

  2. Use the "Sections Style" section to update attributes for sections.

  3. "Instant Search & Preview" let's you review changes to the styling that you have made. 

  4. Use the “Labels” section to provide labels for each section of the Autocomplete.

  5. Click “Apply” to save the label changes.

  6. Once you have completed all of your updates, select "Save".