"search" and "indexer"
Configures searching and indexing.
Example
"search": {
"delay": 9000,
"fuzzy-similarity-factor": 0.6,
"incremental-indexing-activated": true,
"length": 2,
"lucene-cfs-ratio": 0.1,
"max-fuzzy-terms": 10,
"max-indexing-size": "standard",
"operator": "and",
"pattern-sufix": "*",
"period": 6000,
"short-word-length": 3,
"full-indexing-activated": true,
"index-refresh-period-in-seconds" : 5,
"plain-text-search-activated": true
"plain-text-search-activated-on-tracker-filters": true
},
"indexer": {
"full": {
"cronExpression": "0 0 23 ? * FRI *"
}
},
You can use the https://www.freeformatter.com/cron-expression-generator-quartz.html to build a cron expression.
0 0 23 ? * FRI * expression means 'At 23:00:00pm, on every Friday, every month'.
Properties for "search"
|
Property Name
|
Description
|
Default Value
|
||
|---|---|---|---|---|
|
"analyzer"
|
Customized search analyzer implementation class name.
|
|||
|
"max-indexing-size"
|
The maximum size of the document to index. Use "10k" pattern for kilobytes, "xM" for megabytes.
|
|||
|
"operator"
|
Search operator to use as default.
|
"and"
|
||
|
"commit-indexing-block"
|
Integer defines the maximum number of SCM commits to index at once. Negative value disables indexing of commits.
|
|||
|
"incremental-indexing-activated"
|
If the incremental indexing is enabled.
|
true
|
||
|
"length"
|
Integer Minimum length of search expression required.
|
|||
|
"matches"
|
Integer Maximum number of search results matched.
|
|||
|
"pattern-sufix"
|
This text is always added to the end of search expression.
|
"*"
|
||
|
"max-clause-count"
|
Integer, maximum number of search clauses in search expression.
|
|||
|
"symbolTypes"
|
Comma separated symbol types to search for.
|
'cl','md','mi','fd','fi','ma','ty'
|
||
|
"period"
|
Integer Indexing should run that often in seconds.
|
|||
|
"delay"
|
Integer delay before indexing starts in seconds.
|
|||
|
"fuzzy-similarity-factor"
|
The minimum similarity of the variations of a search term.
|
|||
|
"lucene-cfs-ratio"
|
If a merged segment will be more than this percentage of the total size of the index, leave the segment as non-compound file even if compound file is enabled. Set to 1.0 to always use CFS regardless of merge.
|
|||
|
"max-fuzzy-terms"
|
The total number of terms clauses that will appear once.
|
|||
|
"operator"
|
Default operator ('and' or 'or').
|
|||
|
"period"
|
The frequency the search should run in seconds.
|
|||
|
"short-word-length"
|
The minimum length for searched terms to be considered short. Terms with this length or shorter are prefix-searched, this means that the search looks for a common prefix among the variations of the search term. Longer terms are processed using fuzzy matching to find approximate matches.
|
|||
|
"index-refresh-period-in-seconds"
|
Configures the refresh period for the shared indexing files in a cluster environment. For a value 1 or higher, the sync is scheduled and runs every X seconds, which is equivalent to the given value. If the value is 0 or less, the sync is disabled.
|
5
|
||
|
"plain-text-search-activated"
|
Enables the option to search for formatted text with markup within the wiki fields such as Description or custom wikitext fields.
|
true
|
||
|
"plain-text-search-activated-on-tracker-filters"
|
Enables plain text search in filters in the following views:
• Codebeamer Document View and Table View
• Codebeamer X Document View and List View
|
true
|
Additional Information
search/mime-mapping
Configures the handler class for the indexer and the character encoding per mime-type
Example
"search": {
"mime-mapping": [
{
"class": "handler...",
"mime-type": "text/html",
"character-encoding": "UTF-8"
},
{
"more": "..."
}
]
},
Impact of the "plain-text-search-activated-on-tracker-filters" Option on Search Functionality
• When the "plain-text-search-activated-on-tracker-filters" option is set to false:
◦ Search is performed across IDs, text fields, wiki markup within wikitext fields, and the rendered values of single-select choice fields—including those with lists and references.
◦ Search is performed only on the HEAD revision of the item. Does not apply to baselines.
◦ Search is performed on partial matches only, with only matches to the starting words of the search string.
• When the "plain-text-search-activated-on-tracker-filters" option is set to true:
◦ Search is performed on IDs, with complete match, text, and rendered wikitext fields, not in the markup.
◦ Search works on baselines as well.
◦ Search works with partial match anywhere inside the field.
◦ Search supports wildcard characters such as the percent sign (%) representing zero or multiple characters, and the underscore (_) representing a single character. Percent (%) and underscore (_) characters in the search term can be escaped using double backslash (\\).