CMS 10.6 InSite Search Custom Setting Examples
Review the name/value pair examples in the following table to apply custom settings in your InSite Search implementation that suit your needs.
See CMS 10.6 Managing Custom Settings for details about applying custom settings.
For this reason, we recommend you test your configuration in a staging environment prior to implementing changes in production environments. Also, be careful not to create conflicts when using the documentLocations option, which includes paths to binary documents such as PDFs and MS Word.
| Name | Value Type | Default Value | Example Value(s) | Description |
|---|---|---|---|---|
| IndexingControlField | String | -empty- | NoIndex | Value equals the element name to look for on a page in order to determine if to keep the page in the search index. Expected value: NoIndex Checkbox element, which is a common element found in the SEO group for most Page Schemas. The CMS checks for the value equal to true; otherwise, it will fall back to false. If the state is changed for NoIndex and the page is published, then the Indexer log shows page either being added or deleted from the index. Note Be aware that the CMS will only look for the first instance of the defined element value on the page. If there are multiple elements with the same name, which is unlikely, it will ignore all other instances and only look at the first returned value. |
| documentComponents | String | -empty- | BinaryDocument, Block | Value equals Schema Root Name, which is to be included in content indexing. Multiple components should be comma-separated. |
| documentLocations | String | -empty- | documents,code/documentation,qa/instructions/processes | Path to documents such as PDFs and MS Word. Note If this documentLocations custom setting is not configured or if its value field is empty, then the indexer falls back to legacy document indexing where all files in documents folder are indexed. |
| OnlyIndexSearchables | String | false | true|false | Boolean value, which tells the indexer to only index fields (elements) marked with the Searchable attribute. |
| IFilterTimeOut | Integer | 30 | 40 | Number in seconds for the indexer to wait for response when indexing Documents (iFilter). |
| IncludeComponentContentInPage | String | false | true|false | When component content has been included in page(s), this setting re-indexes pages when the component has changed. Query matches return the xID of the parent page (not the component). By default, schema names, "Site Control", and "Section Control" are omitted from search. Note To exclude other component types from search, see Configuring Search Schemas. |
| ExcludeDocumentExtensions* | String | -empty- | xml,css,js | If there are file types residing within Assets that you do not want to include in your search results, you can configure this setting to define file type extensions that will not be indexed. |
| ExcludeDocumentPaths* | String | -empty- | IntranetDocs,MyDocs\Private,Do\Not\Index | If there are specific folders within your Assets path that you do not wish to be returned as search results, you can set the ExcludeDocumentPaths Custom Setting to prevent these sub-folders from being indexed. |
| EnabledDepthBoostFactor | String | true | true|false | The setting for Depth Indexing Boost Factor. True means pages closer to site root receives a higher score. This setting only applies to pages, not document assets. |
| DocumentIndexingBoost | Integer | 0.25 | 1.0 | The setting for Document Indexing Boost value should be 0 to 2. (Higher values are not recommended because this would push all documents to top in returned results.) This setting controls the positions of documents in search results. Default value (0.25) allows pages to show up before documents in general.
Note If you enabled IgnoreLengthNorm, which is set in Search.config, then you may find that document assets score much higher than pages depending on your asset tree structure. Setting DocumentIndexBoost will help to ensure that documents are not among the first returned results. |