SharePoint Online source JSON modification

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 changed or added in the JSON configuration. This article presents SharePoint Online source parameters that you can change by modifying the source JSON configuration.

If the parameter you want to change is already presented in the parameters section of the source JSON configuration, only modify their value and sensitive values, if necessary. If the parameter isn’t already presented in the parameters section of the source JSON configuration, add the entire parameter object to the parameters section, and then set its sensitive and value values. Each parameter listed in this article includes an example of how it appears or should appear in the source JSON configuration.

Important

Set the sensitive attribute of a parameter to true if its value contains sensitive information. Otherwise, the value will appear in clear text in the JSON configuration.

For instructions on accessing the JSON file and best practices to follow, see Edit a source JSON configuration.

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"
}

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"
}
Important

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.