Modifying Hidden Salesforce Source Parameters

The Add Source and Source: ... General pages of the Administration Tool present the parameters with which you can configure the connector for most Salesforce setups. More advanced and more rarely used parameters are hidden. You can choose to make one or more of these parameters appear in the Add Source and Source: ... General pages of the Administration Tool so that you can change their default value. Consider changing values of hidden parameters only when you encounter time out error messages or performance issues.

The following list describes the available advanced hidden parameters for Salesforce sources. The parameter type (integer, string…) appears between parentheses following the parameter name.

ExtractPrivateObjectsSharingPermissions (Boolean) CES 7.0.6684+ (May 2014)

Whether to retrieve and index sharing permissions of private objects. The default is true, in which case when the UseNewPermissionModel parameter is also set to true, for a document with sharing permissions, you can see from the Index Browser a permission model with two levels for share permissions where the second level is READ ACCESS & SHARING for sharing permissions (see Permission Levels and Sets and Reviewing Document Details from the Index Browser).

IndexArchivedActivities (Boolean)

Whether the connector should index archived activities (tasks and events). The default value is False.

IndexSharingSettings (Boolean)

Whether to retrieve and index content documents sharing settings. The default value is True.

Indexing sharing settings require one API call per Salesforce record. When indexing sharing permissions is not important for your Salesforce organization, you can turn this option off to save API calls.

FetchContentVersionOnFeedComments (Boolean) CES 7.0.8225+ (March 2016)

When indexing Chatter comments, whether to retrieve and index ContentVersion objects on FeedComments. The default value is false. Set to true, when you want to link attachments to the Feed comments in which they appear. In such case, the attachment metadata is added to the related comment field(s).

LoadFiscalYearMetadata (Boolean)

Whether the connector should query the Salesforce API to add metadata about fiscal year information. The default value is True.

The fiscal period metadata is available when the Fiscal Year feature is enabled in Salesforce (see How do I set Fiscal Year and start month?).

The following table describes additional fiscal period metadata that will be added for every DateTime metadata that is already available on the item (ex.: if the item contains 2 metadata of type DateTime, then 8 new metadata will be added on the item).

Name	Description	Sample Name	Sample Value
id	The unique identifier for a given item. Every item in Salesforce has a unique ID.	id	70130000000rz4C
{ORIGINAL_METADATA_NAME}_fiscal_year OBSOLETE _fiscalyear	Contains the fiscal year of the period that includes the date of the {ORIGINAL_METADATA_NAME} metadata.	MyDateField_fiscal_year	2012
{ORIGINAL_METADATA_NAME}_fiscal_quarter OBSOLETE_fiscalquarter	Contains the fiscal quarter number of the period that includes the date of the {ORIGINAL_METADATA_NAME metadata.	MyDateField_fiscal_quarter	2
{ORIGINAL_METADATA_NAME}_fiscal_month OBSOLETE_fiscalmonth	Contains the fiscal month number of the period that includes the date of the {ORIGINAL_METADATA_NAME} metadata.	MyDateField_fiscal_month	20
{ORIGINAL_METADATA_NAME}_fiscal_week OBSOLETE_fiscalweek	Contains the fiscal week number of the period that includes the date of the {ORIGINAL_METADATA_NAME} metadata.	MyDateField_fiscal_week	42
{ORIGINAL_METADATA_NAME}_fiscalquarter	Contains the fiscal quarter in the format {YEAR}-Q{QUARTER} of the {ORIGINAL_METADATA_NAME metadata.	MyDateField_fiscal_pretty_quarter	2014-Q1

LoginServer (String) CES 7.0.6684+ (May 2014)

The URL of the server you use to log in to your Salesforce organization. The default value is login.salesforce.com. Change the default value when you configure a custom domain and thus disable the ability for your users to log in from login.salesforce.com.

Note: You get the following error when the connector cannot log in from the Salesforce login page:

Error with ID 'SALESFORCE_UNABLE_TO_AUTHENTICATE': Failed to connect to the login service.

PrefetchObjectDescriptions (Boolean)

Whether to prefetch object descriptions or not. The default value is true. Prefetching object descriptions often minimizes the number of API calls made to your Salesforce organization, but may sometimes increase the number of calls (see Minimizing API Calls and Object Description Prefetching).

The formula to determine the optimal value for the PrefetchObjectDescriptions parameter is: 

PrefetchObjectDescriptions = ObjectsToGet.Objects.Count > Organization.Objects.Count / 200

Timeout​InSeconds (String)

The timeout value for requests made to Salesforce, in seconds. The default value is 600 seconds.

UseConnectorHelpers (Boolean) CES 7.0.6607+ (April 2014)

The Coveo Salesforce connector needs to access some information from the Salesforce Metadata API to properly index Salesforce item permissions. Currently, Salesforce requires a very high level of privileges for a user to be able to access this API, even in a read-only manner. The optional Coveo Connector Helpers Package provides an additional API that the connector can use to retrieve the needed information without a high-privilege user (see Using the Coveo Connector Helpers Package).

With the Coveo Connector Helpers package installed in Salesforce, set the UseConnectorHelpers to true to take advantage of the package. When set to true while the Coveo Connector Helpers Package is not installed, the connector falls back to index Salesforce item permissions by directly accessing the Metadata API. The default value is false.

Use the following procedure only when you want to modify one or more of the above hidden source parameters.

To modify hidden Salesforce source parameters

1. Refer to Adding an Explicit Connector Parameter to add one or more Salesforce hidden source parameters.

2. For a new Salesforce source, access the Add Source page of the Administration Tool to modify the value of the newly added advanced parameter:

   1. Select Index > Sources and Collections.

   2. Under Collections, select the collection in which you want to add the source.

   3. Under Sources, click Add.

   4. In the Add Source page, edit the newly added advanced parameter value.

3. For an existing Salesforce source, access the Source: ... General page of the Administration Tool to modify the value of the newly added advanced parameter:

   1. Select Index > Sources and Collections.

   2. Under Collections, select the collection containing the source you want to modify.

   3. Under Sources, click the existing Salesforce source in which you want to modify the newly added advanced parameter.

   4. In the Source: ... General page, edit the newly added advanced parameter value.