Product DocsMenu

Configuring and Indexing a Salesforce Source for the Legacy Connector


A source defines a set of configuration parameters for a specific Salesforce database.

Note: When your organization has access to more than one Salesforce environment, you must define one source for each Salesforce environment that you want to index.

To configure and index a Salesforce source for the legacy connector

  1. On the Coveo server, access the Administration Tool (see Opening the Administration Tool).

  2. Select Index > Sources and Collections.

  3. In the Collections section:

    1. Select an existing collection in which you want to add the new source.


    2. Click Add to create a new collection (see Adding a Collection).

  4. In the Sources section, click Add.

    The Add Source page that appears is organized in three sections.

  5. In the General Settings section of the Add Source page:

    1. Enter the appropriate value for the following required parameters:


      A descriptive name of your choice for this legacy connector source.

      Example: Salesforce site (Legacy connector)

      Source Type

      CES 7.0.7814+ (August 2015) The connector used by this source. In this case, select Salesforce (deprecated).


      • If you do not see Salesforce (deprecated) in the Source Type list, ensure that your current environment meets the requirements (see Salesforce Legacy Connector Requirements).

      • CES 7.0.7711– (June 2015) The Salesforce Legacy connector appears in the list as Salesforce (Legacy) (x64).

      • CES 7.0.5639– (July 2013 ) The Salesforce Legacy connector appears in the list as Salesforce (x64).

      • CES 7.0.5785+ (August 2013) The Salesforce (x64) type corresponds to the source to be used with the second generation Salesforce connector (see Configuring and Indexing a Microsoft SharePoint Source).


      Enter the Salesforce Website URL:

      Refresh Schedule

      Time interval at which the index is automatically refreshed to keep the index content up-to-date. By default, the Every day option instructs CES to refresh the source everyday at 12 AM.

      Note: You can create new or modify existing source refresh schedules (see Creating or Modifying a Source Schedule).

    2. Review the value for the following parameters that often do not need to be modified:


      Change this value only when you want to globally change the rating associated with all items in this source relative to the rating to other sources (see Understanding Search Results Ranking).

      Example: When this source replaces a legacy system, you may want to set this parameter to High, so that in the search interface, results from this source appear earlier in the list compared to those from the source for the legacy system.

      Document Types

      If you defined a custom document type set for this source, select it (see What Are Document Type Sets?).

      Active Languages

      If you defined custom active language sets, ensure to select the most appropriate for this source.


      If you defined custom field sets, ensure to select the most appropriate for this source (see What Are Field Sets?).

  6. In the Specific Connector Parameters & Options section of the Add Source page:

    1. Consider using the following optional parameters:

      Mapping File

      Leave this box empty to use the default mapping file that instructs the connector to index basic Salesforce elements and use the Salesforce Users CES custom security group to manage permissions (see About the Default Salesforce Mapping File for the Legacy Connector).

      When you choose to create a custom mapping file, enter the absolute full path pointing to your custom mapping file (see Creating and Using a Custom Salesforce Mapping File for the Legacy Connector).

      Example: C:\CES7\Config\SalesforceMappingFile.xml

      Mapping Types

      Leave this box empty to instruct the connector to index all the mapping types defined in the default or custom mapping file.  

      This parameter is useful to easily index only a subset of mapping types among the ones defined in the mapping file. Enter each type to index separated by semicolons (see About the Default Salesforce Mapping File for the Legacy Connector).

      Example: Enter: Event;Task;Case. The content for the other types will not be indexed.

    2. In the Parameters section, click Add Parameter when you want to show and configure advanced hidden source parameters (see Modifying Hidden Salesforce Source Parameters for the Legacy Connector).

    3. In the Option section, the state of check boxes generally does not need to be changed:

      Index Subfolders

      Keep this check box selected (recommended). By doing so, all subfolders from the specified starting address are indexed.

      Index the document's metadata

      When selected, CES indexes all the document metadata, even metadata that are not associated with a field. The orphan metadata are added to the body of the document so that they can be searched using free text queries.

      When cleared (default), only the values of system and custom fields that have the Free Text Queries attribute selected will be searchable without using a field query (see Adding a Field to Search On and What Are Field Queries and Free Text Queries?).

      Example: A document has two metadata:

      • #LastEditedBy containing the value Hector Smith

      • Department containing the value RH

      In CES, the custom field CorpDepartment is bound to the metadata Department and its Free Text Queries attribute is selected.

      When the Index the document's metadata option is cleared, searching for RH returns the document because a field is indexing this value. Searching for hector does not return the document because no field is indexing this value.

      When the Index the document's metadata option is selected, searching for hector also returns the document because CES indexed orphan metadata.

      Document's addresses are case-sensitive

      Leave the check box cleared. This parameter needs to be checked only in rare cases for systems in which distinct documents may have the same name but different casing.

      Generate a cached HTML version of indexed documents

      When you select this check box (recommended), at indexing time, CES creates HTML versions of indexed documents. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link rather than opening the original document with the original application. Consider clearing this check box only when you do not want to use Quick View links or to save resources when building the source.

      Open results with cached version

      Leave this check box cleared (recommended) so that in the search interfaces, the main search result link opens the original document with the original application. Consider selecting this check box only when you do not want users to be able to open the original document but only see the HTML version of the document as a Quick View. In this case, you must also select Generate a cached HTML version of indexed documents.

  7. In the Security section of the Add Source page:

    1. In the Security Provider drop-down list, select the security provider that you created for this source (see Configuring a Salesforce Security Provider for the Legacy Connector).

    2. In the Authentication drop-down list, select the Salesforce user identity that you created.

    3. Click Save and Start to save the source configuration and start indexing this source.

  8. Validate that the source building process is executed without errors:

    • In the navigation panel on the left, click Status, and then validate that the indexing proceeds without errors.


    • Open the CES Console to monitor the source building activities (see Using the CES Console).

What's Next?

Set an incremental refresh schedule for your source (see Scheduling a Source Incremental Refresh).

People who viewed this topic also viewed