Kentico CMS 7.0 Context Help

General tab

General tab

Previous topic Next topic Mail us feedback on this topic!  

General tab

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

On this tab, you can modify the general properties of the currently edited search index. They are the same properties that you define when creating a new search index:


Display name - name of the index displayed in the administration interface.

Code name - name of the index used as a unique identifier, typically in web part properties or in the API. You can leave the default (automatic) option to have the system generate an appropriate code name. This name is also used for the index file. The fully qualified name of the file must be less than 260 characters long, including the directory path.

Index type - sets the type of content to be indexed:

Custom index - indexes any kind of data depending on its implementation.

Custom tables - indexes records in custom tables.

Documents - indexes content of documents in the content tree.

Documents crawler - indexes the content of the HTML output generated by documents in the content tree.

Forums - indexes content of discussion forums.

General - indexes objects of a specified type. Any objects within the CMS can be searched this way.

Users - indexes details about system users (fields of the CMS_User system table).

Analyzer type - type of analyzer that will be used when indexing the specified content, the following types are available:

Custom - allows a custom‑written analyzer to be specified. This gives you the option of performing tokenization according to your particular requirements. If selected, the names of the assembly and class that implement the custom analyzer must be entered into the Assembly name and Class name fields. An example can be found in the Developer's Guide -> Modules -> Smart search -> Managing indexes -> Using a custom analyzer topic.

Keyword - tokenizes the entire stream as a single token. This is useful for data like zip codes, ids, and some product names.

Simple - divides text at non-letter characters.

Standard - grammar-based analyzer (stop-words, shortcuts, ...). This option is very efficient for English, but may not produce satisfactory results with other languages.

Starts with - tokenizes all prefixes contained in words, which allows searching for words that start with the entered string. Text is divided at whitespace characters. For example, searching for test returns words such as test, tests, tester, etc.

Stop - contains a collection of stop-words at which text is divided.

Subset - tokenizes all substrings in words, which allows searching for words that contain the entered string. Text is divided at whitespace characters. For example, searching for net returns words such as net, Internet, network, etc.

White space - divides text at whitespace characters.

Stop words - dictionary containing words which will be omitted from indexing (e.g. 'and', 'or', ...) when a Stop or Standard analyzer is used. The dictionaries are stored in ~\App_Data\CMSModules\SmartSearch\_StopWords

Batch size - limits the amount of records retrieved by a single query when rebuilding (or creating) the index. The purpose of this property is to help optimize indexing performance. Increasing the value of this property reduces the amount of required queries, which may improve performance, but doing this also increases memory consumption. The ideal value depends on the type of the indexed objects and on available resources. It is recommended to set a reasonable value when indexing large objects (e.g. documents).


Besides modifying these properties, you can RebuildIndex Rebuild the index, which deletes the original one and the specified content gets indexed again. Clicking this action button does not always guarantee that the index will be rebuilt immediately. The process may be delayed if e.g. another index is already being rebuilt or if the rebuilding tasks are configured to be handled by the scheduler. The index is automatically optimized after a successful rebuild.


You can also OptimizeIndex Optimize the index, which results in better search performance, particularly in case of large indexes.


In the Index info box, you can find current information about the status and properties of the index.

More resources can be found in Developer's Guide -> Modules -> Smart search.