2.16. Unified Search configuration

eXo Platform exposes several parameters for effective use of Unified Search Engine. Those parameters can be found in $PLATFORM_TOMCAT_HOME/gatein/conf/configuration.properties (in Tomcat) or $PLATFORM_JBOSS_HOME/standalone/configuration/gatein/configuration.properties (in JBoss) with the unified-search.engine prefix, as follows:

############################
#
# Unified search
#

# Enables Fuzzy search engine
# Values: true/false
# Default: true
unified-search.engine.fuzzy.enable=true

# Sets the required similarity between the query term and the matching terms
# Values : Between 0 and 1
# Default minimum similarity : 0.5
unified-search.engine.fuzzy.similarity=0.5

Since 4.0.4, there are two properties that allow you to enable/disable Fuzzy search and adjust its effectiveness. You can read about Fuzzy search here. Basically, the engine searches for not only exact keyword but also similar words. It is likely a feature expected by end-users, but it is also a deal with search speed. That is why you should have ability to adjust degree of similarity and enable/disable Fuzzy search.

By default, Fuzzy search is enabled. Fuzzy search will be performed when the user adds a tilde (~) after a single keyword. So the "Home~" keyword triggers a Fuzzy search of which the result may include "Rome". Also, the user can append a similarity to narrow or extend the search result, for example "Home~0.8".

PropertyDescription

unified-search.engine.fuzzy.enable

The value can be true or false that means Fuzzy search is enabled or disabled respectively. The default is true.

unified-search.engine.fuzzy.similarity

The default similarity that varies between 0 and 1. The closer to 1 this value is set, the more found words are similar to the keyword. The value of this property is effective when the user does not add a similarity.

Use the period (.) for floating point, for example "0.1", "0.2". The default is 0.5.

See also

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus