Modifying Hidden File Connector Source Parameters

The Add Source and Source: ... General pages of the Administration Tool present the parameters with which you can configure the connector for most file share setups. More advanced and more rarely used parameters are available but hidden. You can choose to make one or more of these parameters appear in the Add Source and Source: ... General pages of the Administration Tool so that you can change their default value. Consider changing values of hidden parameters only when you encounter time out error messages or performance issues.

The following list describes the available advanced hidden parameters for File connector sources. The parameter type (integer, string,…) appears between parentheses following the parameter name.

EnableCrawlDFSReferralLink (Boolean)

Set to True to enable crawling of Distributed File System (DFS) referral links. This option is useful when Windows perceives the crawling by the connector as a Denial-of-Service attack (see Access denied when crawling through a Distributed File System (DFS)).The default value is False.

IgnoreUnresolvedDeniedSecurities (Boolean)

Set to True to ignore unresolved denied permissions. This option is useful to voluntarily ignore unresolved denied security errors. The default value is False.

Example: When a user or group no longer exists, accessing their documents is denied and causes unresolved security exceptions with a message like: Unexpected error occurred while retrieving content from directory. - Access to the path [path] is denied.

Important: Enable this parameter with caution as it can create a security hole.

LiveMonitoringEventsQueueMaxSize (Integer)

Maximum number of modification events to store for each monitored starting address before discarding them. Discarded modification events will be indexed the next time the source is refreshed. This parameter is useful to prevent queuing a large number of modification events that would take a large amount of memory on the server when many files under the starting address are modified in a very short period of time. The default value is 100,000.

RetryDelay (Integer)

Delay (in seconds) before retrying to process a document that failed to be indexed. The default value is 30. Consider increasing the value when you think that this can increase chances for the file to be available for crawling.

RetryQueueMaxSize (Integer)

Maximum number of items to store in the retry queue before discarding them. The default value is 100. Consider increasing the value when you experience frequent sharing violation when crawling and want to ensure no document is discarded (see Some items are not added to the retry queue when they failed to be indexed).

TempFileRegex (String)

Regular expression (regex) used to exclude unwanted temporary files from indexation. By default this parameter is empty. This option is useful when exclusion filters are not precise enough to exclude specific files such as temporary files. The option can also be used to filter other types of files using a custom regular expression.

FileSystemWatcherBufferSize (Integer)

Buffer size of the File System Watcher instance used by the File Crawler to monitor file system events. For best performance, use a multiple of 4 KB (4096). Increasing this buffer size is expensive because it comes from non-paged memory that cannot be swapped out to disk. Keep the buffer as small as possible. The default value is 8192.

Use the following procedure only when you want to modify one or more of the above hidden source parameters.

To modify hidden File connector source parameters

1. Add one or more hidden source parameters (see Adding an Explicit Connector Parameter).

2. For a new File source, access the Add Source page of the Administration Tool to modify the value of the newly added advanced parameter:

   1. Select Index > Sources and Collections.

   2. Under Collections, select the collection in which you want to add the source.

   3. Under Sources, click Add.

   4. In the Add Source page, edit the newly added advanced parameter value.

3. For an existing File source, access the Source: ... General page of the Administration Tool to modify the value of the newly added advanced parameter:

   1. Select Index > Sources and Collections.

   2. Under Collections, select the collection containing the source you want to modify.

   3. Under Sources, click the existing File connector source in which you want to modify the newly added advanced parameter.

   4. In the Source: ... General page, edit the newly added advanced parameter value.