Coveo for Sitecore v5 is now available!

Coveo for Sitecore Legacy Search UI Framework - Search Component Properties

Coveo for Sitecore 4.1 - November 2018

This topic describes the properties that are available on the search component.

Property Description Default value Additional details
Results Scope
Filter expression rules
Enterprise only
Allows the use of the Rule Set Editor to define a filtering expression for the search component. See Adding Boosting or Filtering Expressions.
Boost expression rules
Enterprise only
Allows the use of the Rule Set Editor to define boosting rules and assign different weight to them. It influences the results ranking. See Adding Boosting or Filtering Expressions.
Enable automatic boosting
Enterprise only
Allows the user to enable automatic boosting according to its current pattern . Disabled

This parameter is only available when the DMS is enabled.

See Coveo for Sitecore 4.0.704- - Using Automatic Boosting.

Filter results on the current context language Whether or not to return the version of an item in the results list that matches the current language. For example, if the current language is English, then only the English version of items will be in the results list. Enabled
Searchbox Suggestions
Query suggestions (not available on mobile layouts) Specifies whether or not omnibox query suggestions are displayed when a user types new text inside the query box. Selected

Coveo Machine Learning (Coveo ML) Advanced Query Suggestions
Pro and Enterprise Cloud Only

Specifies whether or not Coveo ML suggests queries to the user.

Enabled See Getting Started with Coveo Machine Learning.
Omnibox timeout (ms) Specifies the delay (in milliseconds) before the Omnibox cancels any deferred request that was pushed when providing suggestions for the omnibox. 2000 See Providing Suggestions for the Omnibox.
Search-as-you-type Specifies whether or not a new query is automatically triggered when a user types new text inside the query box. Not selected
Search-as-you-type delay (ms) When search-as-you-type is activated, specifies the delay in milliseconds before a new query is triggered when the user types new text inside the query box. 500
No search box suggestions Turns off all query suggestions. Not selected
Query Behavior Coveo for Sitecore - July 2016
Enable partial match Coveo for Sitecore - September 2016 Specifies whether or not a query containing a large number of keywords is automatically converted to a partial match expression in order to match items containing only a subset of the keywords. Disabled
Partial match number of keywords When partial match is enabled, specifies the minimum number of keywords that must be present in the query to activate the partial match. 5
Partial match threshold When partial match is enabled, specifies either an absolute or percentage value indicating the minimum number of keywords an item must contain in order to match the query. 50%.
Enable wildcards Specifies whether or not Coveo expands keywords containing wildcard characters (*) to the possible matching keywords to broaden the query. See Using Wildcards in Queries
Enable question marks Specifies whether or not Coveo expands keywords containing question mark characters (?) to the possible matching keywords to broaden the query. See Using Wildcards in Queries
Enable lowercase operators Specifies whether or not operators such as or, and, and true are treated as operators for the query when they are typed in lowercase.
Paging
Pager location The location where the pager component is displayed in the search interface.

Bottom

  • Bottom: Bottom of the page.
  • Top: Top of the page.
  • Both: Top and bottom of the page.
  • None: No pager component is displayed.

The pager component is hidden when the Enable Infinite Scrolling option is enabled.

Number of results per page The number of search results displayed per page.

10

This value is ignored when the Enable Infinite Scrolling option is enabled.

This value is ignored when the Display Results Per Page option is enabled.

Enable navigation button Whether to display buttons to be able to browse between consecutive search result pages. Enabled
Number of pages displayed in the pager The maximum number of page links that are displayed in the pager component. 10
Maximum number of pages displayed in the pager The maximum number of pages that are included in the pager. 100
Query Helpers
Enable search tips Whether to display search tips when no results are returned.
Only display search tips

Specifies to hide the information about the currently displayed range of results and only display the search tips instead.

Enable query auto-correction Whether or not to correct automatically typos in a query.
Infinite Scrolling
Enable infinite scrolling Whether or not to progressively load search results as you scroll through them.

Disabled

Infinite scroll page size The number of additional search results to display when they are progressively loaded. 10
Layout
Display facets Whether or not to display facet components for search results. Enabled
Display the number of results per page picker Whether or not to display the results per page picker. Enabled
Display logo Whether or not to display the logo next to the search box.

Enabled

There is no logo in the mobile version.
Display the main search box Whether or not to display the Search Box component. Enabled
Display sorting components Whether or not to display Sort components for search results. Enabled
Display a loading animation before the first query is executed Whether or not to display a loading animation while waiting for the first query to be executed successfully. Enabled
Display query duration Whether or not to display the duration of a query. Enabled
Display query summary Whether or not to display the summary for the number of results found. Enabled
Display breadcrumbs Whether or not to display breadcrumbs for search results. Enabled
Display Did You Mean Whether or not to apply query corrections when applicable.

Enabled

When disabled, a query with a typo will not be automatically corrected.

Display the error report Whether or not to display errors that occur during a query. Enabled
Display the recommendations section Whether or not to displaythe recommendations section. Enabled
Display the results list Whether or not to display search results. Enabled
Display the tabs section Whether or not to display the tabs section. Enabled
Searchbox Layout Coveo for Sitecore - July 2016
Searchbox placeholder text Specifies the text used as a placeholder in your search bar.
Focus on searchbox after initialization Specifies whether the searchbox gets the focus and is selected on initialization. Enabled
Default Sort Options
Default sort type Specifies a criterion on which the component can sort the results.
Default sort direction Specifies the direction in which to sort. Can either be ascending or descending.
Default sort field
Coveo for Sitecore - September 2016
Specifies a field and template on which the component can sort the results. Click on Edit Field to access the search bar, allowing you to select a specific field.
External Content
Names of External Content Sources List of external content source names. You must add one source name per line.
Analytics
Enable Coveo Usage Analytics Whether the JavaScript Search events are tracked in Coveo Cloud Usage analytics. Enabled
Coveo Usage Analytics custom metadata List of additional custom metadata you want to log in the Usage Analytics. See Adding Custom Usage Analytics Metadata in Coveo for Sitecore.
Enable Sitecore Analytics Whether the JavaScript Search events are tracked in Sitecore analytics. Disabled
Analytics REST endpoint The relative URL of the REST endpoint that tracks analytics events. /coveo/rest/v6/analytics.
Advanced
Auto Trigger Query Whether or not to automatically trigger a query when the search interface is loaded for the first time. Enabled
Throw exception on validation error
Excerpt length The number of characters to display for the excerpt of each search result. 200
Enable history Whether or not to keep an internal search state.

Enabled

This feature allows:

  • the use the Back and Forward buttons of the web browser as a way to go through the different search states (e.g., the Back button can be used to go back to a previous query)
  • the use the URL in the browser as a unique identifier of a query (e.g., the URL contains the query as well as facet and sort component selections)
Enable detailed client-side logging Whether or not to enable detailed debugging traces in the user browser. Disabled

Include bucket folders in search results Whether or not to include bucket folders in the search results.
Include media folders in search results Whether or not to include media folders in the search results.
Query pipeline name Specifies which query pipeline to use for queries.
Rest uri endpoint The relative URL of the REST endpoint used to perform search queries. /coveo/rest.
Advanced Omnibox Options
Enable field suggestions after typing @ in a search box Specifies whether or not fields are suggested in the searchbox after entering "@". Disabled
Enable field suggestions in searchbox Specifies whether or not fields are suggested in the searchbox. Disabled
Enable suggestions of query extensions Specifies whether or not the Omnibox suggests Query Extensions. Disabled See Standard Query Extensions.
Id Coveo for Sitecore - July 2016
Unique identifier Sets a unique identifier to your search component. Random The default value is randomly computed using the $GenerateUniqueId token .
Parameters
Addtional parameters This field allows you to add custom parameters to the Coveo component. See Adding Custom Parameters with the Additional Parameters Field.
People also viewed