Product DocsMenu

Modifying Hidden Sitecore Source Parameters for the Legacy Connector

Deprecated

The Add Source and Source: ... General pages of the Administration Tool present the parameters with which you can configure the Sitecore connector. More advanced and more rarely used parameters are 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.

The following list describes the available hidden parameters that can be added on a Sitecore source as custom parameters:

WebServiceTimeout (Integer)

Modifies the time the connector waits for a content web service request to complete. Any value in seconds. The default is 100 seconds.

IncrementalRefreshDelay (Integer)

Modifies the delay between incremental refresh runs. Any value in seconds. The default is 300 seconds.

AdminThreshold (Integer)

Specifies the maximum number of users a security group/role can contain. To handle larger groups, increase this number and consider increasing the WebServiceTimeout parameter. The default is 250 users.

ADDomains (String)

Specifies to the connector what Sitecore security domains come from the Active Directory module. A list of domain names separated by semicolons (;).

ErrorDetails (String)

Changes the error messages verbosity level. Possible values are Normal and Detailed. The default is Normal.

UseCache (Boolean)

Specifies to the connector to use its caching capability to improve crawling performances. The default is True.

Note: It is not recommended to set this parameter to False. However, caching can be disabled if you are experiencing serious memory problems on your Sitecore installation while crawling.

LoopDelayRefresh, LoopDelayLive, LoopDelayItemsBatch (Integer)

Modifies the time a refresh, incremental refresh, or batched item thread waits between calls to retrieve Sitecore items. These parameters are useful to slow down the crawling when such an operation puts too much load on the Sitecore server. Any value in milliseconds. The default is 0 mS.

UseItemsBatch (Boolean)

Specifies to the connector to make multiple calls to get the list of all Sitecore items to index. The default is True.

ItemsBatchSize (Integer)

Specifies the maximum number of items to get at once when the UseItemsBatch parameter is set. The default is 300.

IncrementalRefreshIncludeSecurity (Boolean)

Specifies to the connector to handle the security changes during incremental refresh. Enabling this option slows down the incremental refresh process because of the hierarchical Sitecore security model. The default is False.

SkipUnhandledErrors (Boolean)

When enabled and the connector encounters an unhandled error because of a communication error, invalid XML, or other fatal errors, it will skip over them rather than stop. The default is False.

IndexStandardFields (Boolean)

Specifies to the connector to index item fields inherited from the Standard template. These fields will be available in the metadata of an indexed document in CES. The default is False.

UseNewUriFormat (Boolean)

Whether a unique indexed URI is guaranteed for a document. This parameter must be set to True when the ItemPath property is not unique. In such case, two items with the same name created under the same Sitecore path will have the same indexed URI. When this parameter is enabled, the ItemID is appended at the end of the indexed URI to make sure it is unique for all Sitecore documents. The default value is False.

SystemMetaPrefix (String)

The prefix for the indexed metadata. The default value is _CESSC.

Example: With the default value, when a Sitecore metadata is named MyField, then its indexed field counterpart is named _CESSCMyField.s

Use the following procedure to modify the above hidden source parameters.

To modify hidden Sitecore source parameters

  1. Refer to Adding an Explicit Connector Parameter to add one or more Sitecore hidden source parameters.

  2. For a new Sitecore 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 Sitecore 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 Sitecore 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.

People who viewed this topic also viewed