Configuring the Salesforce Source

Pro and Enterprise editions only

When creating a Salesforce source, you should follow certain practices to index all of your required content without overloading the Salesforce API or creating unwanted items in your index. Optimally choosing what to index improves the search experience and prevents performance issues.

Salesforce Source Configuration Guidelines

  • Use the Coveo Cloud administration console source page to see and modify which Salesforce objects and fields are being indexed (see Add or Edit a Salesforce Source and Customizing the Salesforce Source Configuration in Coveo Cloud V2).

  • Do not index all or almost all objects and fields. Not all Salesforce data is useful to index and indexing large amounts of data can have an impact on the performances in your Coveo Cloud organization. Try indexing only the objects and fields you need in your search interface.

  • Start indexing the key standard objects with pre-selected fields and test search results to identify essential information that is missing. - Only add other standard or custom objects and fields that you want to see in search results or use with the following Coveo features:

  • Later, add more standard and custom objects and fields in which you know meaningful data to index is stored.

  • A Coveo Cloud organization source typically performs the following number of API calls to your Salesforce organization after you create or modify the source configuration, and for source incremental refreshes starting every 15 minutes for changed or new content:

    • One API call per about 1000 objects

When an object contains many fields, use the pre-defined and custom filter above the table to find fields more easily.

When you have the required privileges, you can include many types of Salesforce content to your Coveo Cloud organization. Each type covers different Salesforce objects and fields. You can decide who can access the source content1.

1: For further information on source content security, see Content Security.

By default, your Salesforce source starts a refresh every 15 minutes to retrieve Salesforce file changes (addition, modification, or deletion).

Add a Salesforce Source

  1. Log in to your Salesforce organization using an administrator account.

  2. Create a dedicated indexing account for Coveo (see Creating a Dedicated Salesforce Linking Account).

    Create a separate dedicated Salesforce indexing account for each Salesforce source, because, when the source accesses Salesforce with the same user credentials too many times, Salesforce returns an error. Therefore, the source is unable to update the Salesforce source content.

  3. In the main menu, under Content, select Sources.

  4. On the Sources page, at the top right of the page, select Add Source.

  5. Select the Salesforce source in the list.

  6. In the new Add a Salesforce Source dialog that appears, choose Salesforce Production or Salesforce Sandbox depending on where you created your organization.


  7. Fill in your Salesforce credentials and log in.

  8. In the Add Source a Salesforce Source panel:


    1. In the Configuration tab, enter or select appropriate values for available parameters:

      • Source name: A descriptive name for your source under 255 characters (not already in use for another source in this organization).

      • Optical character recognition (OCR): Select this option if you want to make the text found in images and PDF files searchable.

      • Schema Version: A menu where you can select the Schema Service version you want to use.

        • The Legacy (default) version uses field naming compatible with older Salesforce Integration package versions.

        • The Current version works with the most recent Salesforce Integration packages and provides a more powerful source configuration user interface.

        • The Cloud V1 version uses field naming compatible with Coveo Cloud V1 (see Coveo Cloud V1).

      • Objects:

        • You can select the Objects types you want to index in your source.


        • You can also click Select Specific Objects Manually, where you can find and select fields and their relationships.

    2. Optionally, in the Content Security tab, consider changing who can access the source content.

      • Before changing the security of your Salesforce source, ensure that it does not violate any third-party contracts.

      • Changing this setting may expose sensitive content publicly.

      Under Select who will access the source content, select one of the following options:

      • Everyone: Allows everyone to have access to the content of this source, whether they are authenticated or not.

        The Everyone option is the equivalent of the Public in other source configuration panels.

      • Specific identities: Only the specified identities are allowed to see the source content.

        • By default, your current identity (account name) is added.

        • The Specific identities option is the equivalent of the Private option in other source configuration panels.

        You need to enter the following information:

        1. Click the Add identity drop-down menu, and then add an identity.

        2. In the Security identity provider drop-down menu, select the existing provider used to secure the desired identity.

        3. In the Identity type drop-down menu, select the identity type (User or Group) of the identity you want to be allowed to see the source content.

        4. In the Identity input, enter the account name of the user or group.

        5. Optionally, in the Additional info input, add identity information, written in JSON, about the user or group outside the account name.

        6. Click Add.

        7. Repeat this procedure to add more identities.

      • Users following system permissions: This is the default and most secure option. It only allows anonymous and authenticated users to see search results for items to which they have access within Salesforce.

        • The Users following system permissions option is the equivalent of the Secured option in other source configuration panels.

        • To prevent INVALID_QUERY_LOCATOR errors, which occurs when Coveo Cloud accesses your Salesforce organization with the same user credentials too many times, only select the Users following system permissions option when you have secured content.

        1. Select an identity provider: Allows you to select the identity provider from an existing source.

        2. Create a new one: Creates a new identity provider based on your selected Salesforce organization. If this is the first Salesforce source in your organization, it is recommended to select this option.

    3. In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):

      1. In the Access Level column, select View or Edit for each available group.

      2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

      If you remove the Edit access level from all the groups of which you are a member, you will not be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.

    4. Optionally, consider editing or adding mappings (see Manage Source Mappings).

      You can only manage mapping rules once you build the source (see Add or Edit a Source).

    5. In the Salesforce Organization tab, you can review data from the Salesforce organization you index:

      • Name: Salesforce organization name

      • Type: Salesforce organization type

      • Accessed using: email address with which you logged in to connect your Salesforce organization with Coveo Cloud V2.

    6. Complete your source addition or edition:

      • Click Add and Build Source/Save and Rebuild Source when you are done editing the source and want to make changes effective.

        Back in the Coveo Cloud administration console Sources page, you can review the progress of your Salesforce source addition or modification (see Manage Sources).


      • Click Add Source/Save when you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon.

        In the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.

      Once the source is built or rebuilt, you can review its content in the content browser (see Inspect Items With the Content Browser).

What’s Next?

If you want to customize your configuration, see Customizing the Salesforce Source Configuration.

Recommended Articles