Integration of the Lucene search engine in OpenCms

This part of the documentation describes the integration of the Lucene search engine in OpenCms. The search examples module accompanies this part as example of integrating the search facility in JSP.

Features of the Lucene integration in OpenCms:

Supports indexing/searching in

  • Plain text
  • Rich Text Format
  • XML
  • HTML
  • Microsoft Word / Excel / Powerpoint
  • Adobe PDF
  • OpenCms XmlPages and XmlContents
  • Other OpenCms VFS resources

Additional features

  • Specific indexing for XmlContents, i.e. own fields can be defined/filled with contents in an index
  • Integrated snowball stemmer package with stemmers for various languages
  • Excerpt generation with hit highlighting
  • Permission check of search result items and suppression of unaccessible result items

How to continue from here

file How to create a new search index

Explains how to create a new search index based on the default configuration

file Search configuration: Overview

Shows the general structure of the search configuration in the cms registry

file Search configuration: Documenttypes

Explains the configuration of a single documenttype

file Search configuration: Analyzers

Explains the configuration of an analyzer

file Search configuration: Indexes

Explains the configuration of a search index

file Search configuration: Index Sources

Explains the configuration of index sources

file Search configuration: Index fields

Explains the configuration of fields