Appendix B: Application Properties
This section lists the application properties that are relevant to the full-text search add-on.
Additive property defining an FTS configuration file of the project.
The file is loaded using the
Resourcesinterface, so it can be located in classpath or in the configuration directory.
Used in the Middleware block.
cuba.ftsConfig = +com/company/sample/fts.xml
The flag enables the tooltip generation in Table and DataGrid components. The tooltip contains an information in which entity attribute the search term was found. Tooltip generation may take quite a lot of time, so it is disabled by default.
Stored in the database
The flag enables the "Full-Text Search Details" context action in a table or data grid when a full-text search is done using the generic filter component.
Stored in the database
All properties that are described below are runtime parameters stored in the database and available in the application code via the
FtsConfig configuration interface.
The flag enabling the FTS functionality in the project.
Can be changed via the Enabled attribute of the
An 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
A pipe-separated list of hosts that should maintain search index in the cluster. Each host is represented by its Server ID.
cuba.fts.indexingHosts = host1:8080/app-core|host2:8080/app-core
Default value: unspecified, which means that queueing and indexing is performed by the current server alone.
A number of records extracted from the indexing queue per one invocation of
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 the
app-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.
A number of records put to the indexing queue per one invocation of
The maximum number of times the search term will be added to the hit info for each field. For example, there is a FileDescriptor entity field. If the
fts.maxNumberOfSearchTermsInHitInfoproperty value is 2, then only two first occurrences of the search term in the file will be added to the hit info. The same is for all other indexed entity fields.
The maximum number of entries in the search result.