Salesforce Source JSON Modification

Salesforce Ecommerce Service Workplace Developer System Administrator Product Documentation

In this article

Hidden Parameter Reference

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 Parameter Reference

`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.

As a result, we recommend that you contact us before enabling this parameter.

`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.