Versions Compared

Key

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

...

  • Go to the "Index fields" tab on the Lucene Settings Administration page.
  • Add a new field.
  • Enter the "Field name". This is the name of the field in the index, and does not need to be related to any of the product or category field. The field name can be used by searchers to limit searching to a specific field, for example "description:book" would show products that have the word "book" in the "description" index field.
  • Select if the field is the primary index - for a product database, you must setup a field called "id" as the primary index field - this field is used to select index records for a product.Select the "Analyser" to be used. "Standard" and "Snowball" are supported.
    • The Snowball analyser will apply stemming algorithms to the indexed data, allowing for plurals and other word stems to be searched.
    • The standard analyser simply breaks the search field data in to words, without applying any stemming.
    • It is recommended to use the Snowball analyser for index fields that contain descriptive text, and the standard analyser for other fields.
  • Enter the Source of the index field data. You can enter tokens for any fields in the Product or ProductCategory fields, and multiple fields can be included in a single index field.
    • For Product fields, user the token [Product.Fieldname], (e.g. [Product.Description]).
    • For ProductCategory fields, user the token [ProductCategory.Fieldname], (e.g. [ProductCategory.Notes1]).
    • To include more than one field, use the + symbol, e.g. [Product.Description]+[Product.Notes1]+[ProductCategory.Notes5]
  • Enter a field Boost Value. Entering a value of greater than 1 will make the data in the field considered more relevant in search results. A value less than 1 (e.g 0.5) makes the data less relevant.The Boost Value must be greater than zero.
  • Select if the Field Value should be included in the spell checker. This determines which data is used for Lucene's spell checking database. Generally, you would include descriptive fields in the spell check database, but you would not include fields that contain data such as product codes, as these will pollute the spell checking suggestions.

 

info

Ensure that you include an index field with: Name:"id", Primary Index: "yes", Analyser: "Standard", Source:"[Product.ProductCode]", Boost:"1", and Spell:"no"

 

2. Set default settings

For a fast start, we recommend the following setting values which can be configured on the "Index Settings" tab of the Lucene Settings Administration page:

Setting

Value

Enabled

Leave off until the index is created (see below)

Enable Product Boost

Off

Enable Boost Words

On (will not have any impact until boost words are defined)

All other flags are not relevant for a fast start (as they relate to product boost which is turned off)

...

The following steps are not essential to using Lucene, but will give your customers more accurate a better search results experience if you spend the time setting them up:

  • Product Boost
  • Boost Words
  • Query and Index Translations
  • Did You Mean search suggestions
  • Adding Lucene tokens to your product search result templates

 

Content by Label
showLabelsfalse
max5
spacesDRAFT
sortmodified
showSpacefalse
reversetrue
typepage
labelsLucene Search