Performance leading practices

This is for:

Developer System Administrator

SharePoint Online is a complex system and tenants typically hold large volumes of content. Capturing only relevant items, limiting indexing times, and maintaining source content freshness can be challenging.

The goal of this article is to present SharePoint Online connector scoping features and other indexing strategies which, when combined, can significantly improve indexing performance.

Scope the content to index

You should only index items that you deem necessary for your search interface users. Excluding unimportant content from being indexed improves search relevance and reduces indexing time.

There are several ways you can configure the SharePoint Online connector to exclude irrelevant content.

Use the "Content to index" subtab options

On the Add/Edit a SharePoint Online Source page, in the Content to index subtab, the All sites option may be selected. This configuration crawls every site available in your SharePoint Online tenant. You should instead be selective as to the content you want to index.

For example, select the Specific URLs option and specify starting URLs you want to crawl. Only SharePoint Online items whose URLs begin with the specified starting URLs will be indexed.

Excluding subsite content
Note

If you need to exclude specific subsites under a given starting URL, you can do so using URL exclusions and inclusions.

Avoid indexing folders and unapproved items

On the Add/Edit a SharePoint Online Source page, in the Advanced settings subtab, the additional content Folders and Unapproved items options aren’t selected by default. This is the recommended configuration.

SharePoint Online sources created before February 18, 2020 had a different default configuration. If you have old SharePoint Online sources, we recommend you deselect the Folders and Unapproved items options, if applicable.

Important

In SharePoint Online, a folder is strictly a container with some metadata. The following are considered folders:

  • A discussion (that is, a thread) in a discussions list.

  • A notebook containing a OneNote note.

The SharePoint Online connector crawls items inside a folder even if the Folders option isn’t selected. For example, a discussion will not be indexed but all its replies will.

Only index items modified within a rolling period

On the Add/Edit a SharePoint Online Source page, in the Content to index subtab, you can configure a rolling period. Only items created or modified within the specified rolling period are indexed.

More precisely, the feature has the following effects during source updates:

Update type Effects

rebuild

Your source is emptied, then only items modified within the rolling window are added to your source.

rescan

The connector crawls the entire content your source targets, and:

  • New items are added to your source.

  • Items that have been modified since the last source update are updated in your source.

  • Items that haven’t been modified within the rolling window or that have been deleted in SharePoint are removed from your source.

refresh

The connector crawls items that have been modified/added since the last source update and items whose last modified date is outside the rolling window, and:

  • Items that have been modified/added since the last source update are updated/added in your source.

  • Items that haven’t been modified within the rolling window are removed from your source.

See Exclude older content for configuration details.

Exclude items on a metadata value basis

On the Add/Edit a SharePoint Online Source page, in the Content to index subtab, you can define a condition based on metadata values to prevent items from being crawled.

The condition may be a single expression or a combination of expressions. The following operators are supported: AND, OR, Exists, NOT, ==, >, and <. Parentheses are also supported to specify operation order.

See Exclude items on a metadata value basis for configuration details and examples.

Use exclusion and inclusion rules

On the Add/Edit a SharePoint Online Source page, in the Content to index subtab, add exclusion and/or inclusion rules to specify the URLs you want to crawl. Exclusion and inclusion rules can be useful, for example, to prevent indexing irrelevant pages you’re redirected to.

Exclusion and inclusion rules support regex and wildcard expressions.

Example

In the Content to index subtab, you selected the Specific URLs option and specified the following URL: https://sometenant.sharepoint.com/SiteA/. SiteA contains subsites as follows:

  • https://sometenant.sharepoint.com/SiteA/SubSiteAA/

  • https://sometenant.sharepoint.com/SiteA/SubSiteAA/SubSubSiteAAA/

You want to index the contents of SiteA and SubSubSiteAAA, but not those of SubSiteAA.

To achieve this, you could use the following rules:

Excluding subsite content

See Exclusions and inclusions for details on how these rules are applied.

Exclude template types

On the Add/Edit a SharePoint Online Source page, in the Content to index subtab, the Exclude template types option contains many SharePoint Online list template types by default. Exclude as many template types as possible if they’re not relevant to the search experience.

Index only tagged sites

The SharePoint Online source features an option to index only sites that are "tagged" the same way. This option is useful when you want to index only a subset of your tenant sites.

  1. If you haven’t already done so, tag your sites with the CoveoSiteFilter managed property.

  2. In the source configuration Content to index subtab, select SharePoint Online content, and then select the All sites option.

  3. In the Sources (platform-ca | platform-eu | platform-au) page, click your SharePoint Online source, and then click More > Edit configuration with JSON.

  4. In the Edit configuration with JSON panel, locate the OnlyIndexSitesWithCoveoProperty parameter.

  5. Set the value to what you tagged your sites as using the CoveoSiteFilter property.

    Example

    You tagged all your Canadian sites with the CoveoSiteFilter managed property value Canada. Therefore, you would set value to Canada.

    Only index sites with the `CoveoSiteFilter` managed property value `Canada`

  6. Click Save to apply your change for subsequent update operations.

Ignore specific file types or index them by reference

A SharePoint Online tenant typically contains many file types. If there’s no value in indexing files of a given type, you should ignore items of this type. If you’re not interested in the body of items of a given type, but you would like to index some metadata on these items, then you should index by reference.

Here are only a few examples of file types that you should consider ignoring:

  • Operating system files (for example, .HSancillary)

  • Configuration, log, and other various text files (for example, .ini, .config, .xml, .json, .log, .bak, .txt)

  • Code files (for example, .py, .css, .sql, .ts, .cs, .java)

You configure file type-specific indexing actions in the Edit configuration with JSON panel.

Example

By default, .txt and .log file action and actionOnError settings are set to Retrieve and Reference respectively. To ignore .txt, .log, and .bak files, you could edit the related section of the JSON configuration as follows:

image::index-content/SPOExcludingExtensions.png[Excluding .txt .log and .bak files,500,role="bordered zoom"]

For more details on ignoring file formats and indexing by reference, see Customize the indexing process.

Postpone reindexing changes to list folder content

When performing a refresh, the SharePoint Online connector bases itself on the RecrawlListFolderContentOnChange JSON configuration parameter value to determine whether to recrawl list folder content when changes were made at the folder level. Recrawling list folder content when folder changes occur frequently can lead to long indexing times and increased API call usage. At worst, the source may reindex list folders continually.

SharePoint Online sources created since September 13, 2021, don’t recrawl list folder content upon detected changes. SharePoint Online sources created before September 13, 2021 were set by default to recrawl changed list folders.

To make sure your scheduled refreshes don’t recrawl changed list folders, validate that the RecrawlListFolderContentOnChange parameter in your source JSON configuration is set to false. When set to false, your source indexes changes in list folders during the following rescan or rebuild.

To set the RecrawlListFolderContentOnChange parameter value to false:

  1. On the Sources (platform-ca | platform-eu | platform-au) page, click your SharePoint Online source, and then click More > Edit configuration with JSON.

  2. In the Edit configuration with JSON panel, locate the RecrawlListFolderContentOnChange parameter, and set its value to false.

  3. Click Save to apply your change for later refresh operations.

A word on indexing pipeline extensions

indexing pipeline extensions (IPEs) are a powerful way to customize the indexing process. However, whereas your SharePoint Online connector configurations are applied in the crawling stage of the Coveo indexing pipeline, indexing pipeline extensions are applied in the document processing manager (DPM). Using an IPE to reject items doesn’t reduce the number of items crawled and, therefore, only adds to the total time required before source items are indexed.

Only use IPEs as a last resort, when filtering isn’t possible natively in the SharePoint Online connector.

Additional indexing strategies

The SharePoint Online connector uses SharePoint Online APIs to retrieve your tenant content. SharePoint Online throttles applications to control usage of its APIs.

The following leading practices are meant to minimize the impacts of throttling on connector update times.

Use certificates

Using a certificate to access SharePoint Online APIs rather than a user account increases the call rate limits before throttling is applied. That’s why we recommend using certificate authentication over delegated authentication when adding or editing a SharePoint Online source.

Additionally, using a certificate enables automatic refresh operations during a rescan.

Note

To avoid user account throttling occurrences, Coveo prevents refreshes from being executed during a rescan when using User delegated access using OAuth 2.0. Permitting this wouldn’t yield any advantages for users.

Split your sources and optimize update schedules

SharePoint Online limits API calls per minute and per day. Minimizing connector update times involves taking into account these time window limits. Splitting big SharePoint Online sources into several smaller ones allows you to spread scheduled source updates over time, reducing the risk of throttling and the duration of throttling episodes.

You can split sources into smaller ones by:

  • Alphabetical order of site names.

  • A given maximum number of specific sites per source.

  • Content type (for example, user profiles, documentation, teams).

Important

Make sure you consider content that will be added over time in your SharePoint Online tenant (for example, new sites). For example, you can achieve this by setting up "catch remaining" sources.

If you need to create a new source to capture newly added content in your tenant, consider duplicating an existing source that indexes analogous content. This will make configuring the new source simpler and faster.

The SharePoint Online connector supports refresh and rescan source updates. You should understand the differences between both source update types and set scheduled update frequencies that make sense in your context. You should also have a global scheduling strategy to prevent overlapping source updates or having multiple lengthy updates running on the same day of the week.