Appendix B: Application Properties
This section lists the application properties that are relevant to the full text search subsystem.
- cuba.ftsConfig
-
Configuration parameter, specifies a set of FTS configuration files in the project.
The value of the property should include a list of files separated with spaces. Files are loaded according to the rules of the
Resourcesinterface.Used in the
Middlewareblock.Example:
cuba.ftsConfig = cuba-fts.xml fts.xml
All properties that are described below are runtime parameters stored in the database and available in the application code via the FtsConfig configuration interface.
- fts.enabled
-
The flag enabling the FTS functionality in the project.
Can be changed via the Enabled attribute of the
app-core.fts:type=FtsManagerJMX bean.Default value:
false
- fts.indexDir
-
Absolute path to the directory storing indexed files. If not specified, the
ftsindexsubdirectory of the application work directory (defined by the cuba.dataDir property) is used; in the default deployment configuration, it is tomcat/work/app-core/ftsindex.Default value: unspecified
- fts.indexingBatchSize
-
Number of records extracted from the indexing queue per one invocation of
processQueue().This limitation is relevant to the situation when the indexing queue contains a very large number of records, for example, after executing the
reindexAll()method of theapp-core.fts:type=FtsManagerJMX bean. In this case, indexing is done in batches, which takes more time, but creates a limited and predictable server load.Default value:
300
- fts.reindexBatchSize
-
Number of records put to the indexing queue per one invocation of
reindexNextBatch().Default value:
5000
- fts.maxSearchResults
-
The maximum number of entries in the search result.
Default value:
100
- fts.searchResultsBatchSize
-
Number of elements in a single batch of search results. A user will need to click More on the results screen to view the next batch.
Default value:
5