Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Settings can be configured for Lucene in the CMS through Advanced Settings''Lucene Search Settings'.

Following is a list of the available settings with an explanation of the purpose of each:

Setting

Purpose

Enabled

Turns Lucene on or off. Tick checkbox to use Lucene for the Product Search.

Is Disabled for Product BrowseTick to disable Lucene when user is browsing products
Perform Partial Word Searches

Instructs the search engine to perform a partial word search. This can be useful if your customers often search for model numbers or product codes.

For example, searching for "100" would return any product whose product code starts with "100", such as 100023, 1001112, 100TEST, etc.

Warning

Because of the way Lucene processes partial word searches, any boost value applied to products will be removed. Therefore this feature should not be used when Product Boost or Boost Words are used, as the boost values will not be applied. Instead, rely on the Snowball Analyser to apply stemming to your searchable text.


Partial Word Search TypeFrom the drop down list, select the partial word search type to use. 

Enable Product Boost

Tick for the Product.BoostSourceValue to be used to determine the boost value for a product. Boost values are relative based on the range of BoostSourceValues, and are calculated as a value of 1 (no boost) to the maximum product boost. For a detailled explanation of product boosting, see Lucene Relevance Scoring And Boosting.

Maximum Product Boost Value

The highest boost value assigned to a product. This value will be assigned to the product with the highest Product.BoostSourceValue.  All other products will be assigned values in the range 1.0 to this value.

Info

Recommended value for this setting is between 1.5 and 3.0.


Boost Source Value Minimum Threshold

If a product has a BoostSourceValue less than this value, the product will not be boosted.

Info

Recommended value for this setting is between 5 and 20.


Assign Boost Values by Rank

When selected, boost values assigned to products are done based on the rank of the product's BoostSourceValue, rather than the actual BoostSourceValue

Checking this flag assigns boost values evenly from the lowest source value to the highest source value. If not ticked, the magnitude of the source value will impact the weighting of the boost value.

Tip

If a small percentage of your product range has extreme boost source values, tick this flag.


Product Boost Source Value Daily Calculation Time
Enable Boost Words
Negative Boost Condition Codes

Product Boost Source Calculation


Product Boost Source Time Scale
Enable Non-relevance Based Sort
Partial Index Update
Full Index Update
Lucene Full Daily Index Start Time
Regular Expression to Execute Product Code Match

By default, Lucene treats a space as a separator of words or expressions (characters that go together). If your product codes have one or more spaces between characters, e.g., 'CV - 100' and you want them to be searchablesearched as a single expression, add the pattern so that Lucene will correctly interprets interpret it as a single code.


Here are some helpful symbols: 

^ : beginning of expression

( ) : groups multiple characters together

[ ] : matches any character in the set

a-z

A-Z

0-9 : character sets. To include upper and lower case letters in a search, add both sets.

+ :  matches one or more of preceding character

\s : whitespace, e.g., space


For the example 'CV - 100' (and other codes with this pattern), we would enter the regular expression:  

^([a-zA-Z0-9])+(\s-\s)

This allows any number of alphanumeric characters to precede the first space. tells Lucene Search to treat 'one or more aphanumeric characters' followed by a 'space', then a 'dash', then a 'space' as a single search string. (NOTE - There is no need to capture the rest of the string expression after the second space.)

Spell Correct Unknown Words Only

"Did you mean" suggestions will only be suggested for words entered by users that do not appear in any product information. This can reduce unwanted "did you mean" suggestions.

It is recommended that this flag be turned on.


...