Using advanced configuration files for more FTS functionality
Advanced configuration files for FTS functionality is available only for on-premises deployments.
If the default FTS functionality is not producing the results you expect, you can reference third-party index analyzers, search analyzers, and stemmers.
You might want to process the data differently when indexing versus searching.
- An index analyzer expands all words in the database. For example, if a user is searching for a word like computer, other words like system and machine are included in the search.
- A search analyzer does not expand the words being searched, which improves the performance. If a user is searching for computer, only that word is searched for.
The FTSLocaleConfig.xml file references the following advanced files to help you analyze your indexes and searches.
File | Description |
|---|---|
indexAnalyzer | Enables you to define external Lucene analyzers for the indexing process. For more information, see http://lucene.apache.org/java/docs/index.html. |
searchAnalyzer | Enables you to define external Lucene analyzers for the searching process. For more information, see http://lucene.apache.org/java/docs/index.html. |
stemmer | The FTSAnalyzer uses the Snowball stemmers from the Snowball project for performing stemming functionality. This configuration enables you to define which stemmer to use for a particular language, or it enables you to define a custom stemmer with the Snowball project tools. For information about the Snowball project, see http://snowballstem.org/. (The http://snowball.tartarus.org/ link is deprecated and is listed here for reference.) |
To use third-party configuration files
- Configure a third-party configuration jar file (for example, customAnalyzer.jar ).
This jar file can contain one or more analyzers (such as indexAnalyzer, searchAnalyzer, and stemmer). Each analyzer should have a specific name (for example, org.myorg.lucene.analysis.EsparantoAnalyzer). Insert the analyzer names in the FTSLocaleConfig.xml file, for example:
<indexAnalyzer>org.myorg.lucene.analysis.EsparantoAnalyzer</indexAnalyzer>
<searchAnalyzer>org.myorg.lucene.analysis.EsparantoAnalyzer</searchAnalyzer>
<stemmer>Esparanto</stemmer>- Make sure that the Java can find the jar file that you created in step 1:
- Place the jar file in the fts plug-in directory (by default, C:\Program Files\BMC Software\ARSystem\pluginsvr\fts).
To add the jar to the class path, edit the pathelement option of the pluginsvr_config.xml file in the fts directory, for example:
<pluginsvr_config>
<port>9998</port>
.
.
.
<plugins>
plugin>
<name>ARSYS.ARF.FTS</name>
<pathelement type="location">C:/Program Files/BMC Software/ARSystem/pluginsvr/fts/ftsplugin _VerNum_.jar</pathelement>
<pathelement type="location">C:/Program Files/BMC Software/ARSystem/pluginsvr/fts/tika\-0.3\-standalone.jar</pathelement>
<pathelement type="location">C:/Program Files/BMC Software/ARSystem/pluginsvr/fts/ *customAnalyzer.jar*
</pathelement>
.
.
.
</plugin>
</plugins>
</pluginsvr_config>
does not support if you have read-only database. For more information on using read-only database, see Using read-only database.