Product DocsMenu

Coveo Platform 6.5 >
Administrator Help > Connectors > Salesforce Connector > Configuring and Indexing a Source

Configuring and Indexing a Salesforce Source

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 wish to index.

To configure and index a Salesforce source

  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 wish to add the new source.


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

  4. In the Sources section, click Add.

  5. In the Add Source page:

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

      A descriptive name of your choice for the connector source.
      Example: Salesforce site
      Source Type
      The connector used by this source. In this case, select SalesForce.
      Note: If you do not see SalesForce in the Source Type list, ensure that your current environment meets the requirements (see Salesforce Connector Requirements).
      Enter the Salesforce Website URI:
      Mapping File
      Leave this field empty to use the default mapping file that instructs the connector to index basic Salesforce elements (see About the Default Salesforce Mapping File) and use the Salesforce Users CES custom security group to manage securities (see Choosing How to set Permissions for a Salesforce Source).
      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).
      Example: C:\CES6\Config\SalesforceMappingFile.xml
      Mapping Types
      Leave this field 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).
      Example: Enter: Event;Task;Case. The content for the other types will not be indexed.
      Select the Salesforce user identity that you created previously (see Configuring a Salesforce User Identity).
    2. The following parameters generally do not need to be changed:

      Change this value only when you want to globally change the rating associated with all items in this source relative to the rating of 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?).
      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.
      Click Add Parameter when you want to show advanced source parameters (see Modifying Hidden Salesforce Source Parameters).
    3. The Option check boxes generally do 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. This option is cleared by default.
      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.
    4. Click Save and Start to save the source configuration and start the indexing of the new source.

  6. 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?

Depending on the method that you chose to set permissions on the source (see Choosing How to set Permissions for a Salesforce Source):