SharePoint Online source JSON modification

This is for:

In this article

Configuring listed and unlisted parameters
Reference

Many source configuration parameters can be set through the user interface. Others, such as rarely used parameters or new parameters that aren’t yet editable through the user interface, can only be configured in the source JSON configuration.

This article explains how to configure SharePoint Online source parameters, whether they’re already listed in the JSON or not.

Configuring listed and unlisted parameters

Changing a parameter value in the source JSON configuration | Coveo

If the parameter you want to change is already listed in the parameters section of the source JSON configuration, just modify its value in the JSON configuration.

If the parameter isn’t listed in the parameters section, copy the entire parameter example object from the Reference section below and paste it into the parameters section of the source JSON configuration. Then, modify the value in the JSON configuration, if necessary.

If a parameter has a value attribute that contains sensitive information, set the sensitive attribute to true. Otherwise, the value will appear in clear text in the JSON configuration.

Document the changes you make to the source JSON configuration in the Change notes area below the JSON configuration. This ensures that you can easily revert to a previous configuration if needed.

Reference

This section provides information on the SharePoint Online source parameters that you can only modify through the JSON configuration.

If a JSON configuration parameter isn’t documented in this article, configure it through the user interface instead.

`BatchSize` (Integer)

Specifies the number of items to retrieve with each request to SharePoint Online. The default value is 100 and the maximum value is 1000.

Example

"BatchSize": {
  "sensitive": false,
  "value": "200"
}

Note

Batching parameter default values are based on testing by the Coveo development team. We recommend you contact Coveo Support before changing the value of this parameter.

`GroupMembersBatchSize` (Integer)

Specifies the number of group members to retrieve with each request to SharePoint Online. The default value is 100 and the maximum value is 1000.

Example

"GroupMembersBatchSize": {
  "sensitive": false,
  "value": "200"
}

Note

Batching parameter default values are based on testing by the Coveo development team. We recommend you contact Coveo Support before changing the value of this parameter.

`NumberOfRetries` (Integer)

Specifies the maximum number of times a failing API request will be retried. The default value is 5 and the maximum value is 25.

Example

"NumberOfRetries": {
  "sensitive": false,
  "value": "5"
}

`OnlyIndexSitesWithCoveoProperty` (String | Null)

Specifies the value that the CoveoSiteFilter managed property must be set to for the site to be indexed. The default value is null, which means that the site CoveoSiteFilter managed property value isn’t considered to determine if the site should be indexed.

Example

The following configuration would only index sites whose CoveoSiteFilter managed property value is set to Canada.

"OnlyIndexSitesWithCoveoProperty": {
  "sensitive": false,
  "value": "Canada"
}

See Tag sites with the CoveoSiteFilter managed property for more information.

`RecrawlListFolderContentOnChange` (Boolean)

Specifies whether to recrawl all items in a list folder that has changed. The default value is false.

This setting was created to handle cases where a list folder is marked as modified (not the items in the folder) and the items in the folder should be recrawled to reflect the changes. This can happen, for example, when items inherit permissions from the folder and the folder permissions have been changed.

Example

"RecrawlListFolderContentOnChange": {
  "sensitive": false,
  "value": "false"
}

Setting this parameter to true can have a significant impact on the number of items that are recrawled and indexing performance. See Postpone reindexing changes to list folder content for more information.

`RequestTimeout` (Integer)

Specifies the maximum amount of time, in seconds, that a request can execute before being canceled. The default value is 60 and the maximum value is 900.

Example

"RequestTimeout": {
  "sensitive": false,
  "value": "60"
}

`UserProfileBatchSize` (Integer)

Specifies the number of user profiles to retrieve with each request to SharePoint Online. The default value is 100 and the maximum value is 999.

Example

"UserProfileBatchSize": {
  "sensitive": false,
  "value": "100"
}

Note

Batching parameter default values are based on testing by the Coveo development team. We recommend you contact Coveo Support before changing the value of this parameter.