Salesforce source JSON modification

This is for:

In this article

Hidden parameters

This article presents the Salesforce source hidden parameters that can be updated by modifying the source JSON configuration from the Coveo Administration Console.

These parameters are listed in the parameters section of the source JSON configuration.

Hidden parameters

`AllowedDeletionPercentage` (Integer)

This parameter specifies the maximum allowed percentage of source items that can be deleted from the index at the end of a rescan. If the actual percentage of source items to delete exceeds this value, no items are deleted from the index. By default, this parameter is set to 100, which means that all source items can be deleted.

The purpose of this parameter is to prevent accidental mass item deletions. This can occur, for example, because of an improper source configuration or if the content to index was moved.

For more information about this parameter and its usage, see Forbid item deletion based on a percentage condition.

Example

You can set AllowedDeletionPercentage to 10 in the JSON configuration of your source, as shown in the snippet below. With this configuration, if Coveo detects that more than 10% of the items are flagged for deletion during a rescan, deletion will be blocked. The status on the Sources (platform-ca | platform-eu | platform-au) page will show your source in error, and the error details will indicate the actual percentage of items that were flagged for deletion versus the allowed percentage (in this case, 10%).

"AllowedDeletionPercentage": {
  "sensitive": false,
  "value": "10"
}

`ApplyVisibilityChannelPermissionsOnKnowledgeArticles`

The ApplyVisibilityChannelPermissionsOnKnowledgeArticles parameter determines whether to apply visibility channel permissions on Knowledge Base (KB) articles that rely on data categories to secure record access (see Known limitations).

The default value is true, meaning that visibility channel permissions are applied on all new sources that contain indexed KB articles.

When set to false, visibility channel permissions aren’t applied on KB articles and custom manipulations are required to secure record access.

Note

Any modification to this parameter value will require a source rescan to apply the change.

`DisableMetadataApiSecurities`

The DisableMetadataApiSecurities parameter determines whether to retrieve permissions that are only available using the Salesforce Metadata API such as Sharing Sets and User Visibility.

The default value is false, meaning that permissions that are only available using the Salesforce Metadata API are retrieved by default.

When set to true, this parameter lets you bypass the crawling user’s Modify Metadata Through Metadata API Functions and Manage Sharing permission requirements in order to create a secured source. However, bypassing these permissions may result in some users not finding all the documents in their Coveo-powered search interface that they can access in Salesforce (see Known Impacts ).

Known impacts

Setting the DisableMetadataApiSecurities parameter to true will negatively impact all use cases that require the crawling user’s Modify Metadata Through Metadata API Functions and Manage Sharing permissions. These include:

Customers using Sharing Sets.
Customers using User Visibility settings.
Customers requiring secured indexing of the EmailMessage Salesforce object.
Customers using Standard Sharing for the secured indexing of Lightning Knowledge, which includes related items such as Chatter and files related to Knowledge records.

Make sure to contact Coveo Support before enabling this parameter.

`FetchChatterItemBodyFromConnectApi`

The FetchChatterItemBodyFromConnectApi parameter determines if Chatter feed items and comments containing user references should be indexed using full user names or Experience Cloud site nicknames.

The default value is false, meaning that Chatter feed items and comments containing user references are indexed using full user names.

When set to true, this parameter lets you index Chatter feed items and comments containing user references with site nicknames instead, provided nicknames have been enabled in the Experience Cloud site.

Enabling this parameter can impact the performance of your source as it requires additional API calls to the Salesforce Connect REST API.

`UseMigrateToFromArticleIdForPermanentIdGeneration`

The UseMigrateToFromArticleIdForPermanentIdGeneration parameter determines if the values of the Classic Knowledge MigratedToFromArticleVersion and MigratedToFromArticle fields should be reused during indexing to generate the permanent IDs for articles that have been migrated to Lightning Knowledge. The default value is false, meaning that new permanent IDs are generated by default for your migrated content.

Generating new permanent IDs for migrated content affects both featured results and Coveo Machine Learning (Coveo ML) Automatic Relevance Tuning (ART) boosted search results. Specifically, it breaks your existing featured result rules and requires weeks of additional Coveo ML model training to boost the results of your migrated content.

To avoid generating new permanent IDs for your migrated content, you can override the default value as follows:

"UseMigrateToFromArticleIdForPermanentIdGeneration": {
    "sensitive": false,
    "value": "true"
}

When set to true, the values of the Classic Knowledge MigratedToFromArticleVersion and MigratedToFromArticle fields are reused to generate the permanent IDs for articles that have been migrated to Lightning Knowledge, preserving both your featured results and Coveo ML ART boosted search results.