Salesforce Connector Deployment Overview
The Salesforce connector can index various Salesforce content types:
-
Service Cloud standard and custom objects and fields
-
Knowledge base articles
-
Chatter
-
CRM Content
When you want to index more than one of these Salesforce content types, you must use the following procedure to create a configuration (ObjectsToGet configuration file, mapping file, and source) for each of them because they cannot share the same set of configuration parameters.
To deploy the Salesforce connector
-
Validate that your environment meets the requirements (see Salesforce Connector Requirements).
-
Configure the user identity
The Coveo connector needs an account to connect to your Salesforce organization and access the entire content that you want to index. You must create a CES user identity to hold the credentials of this Salesforce account (see Creating a Salesforce User Identity).
-
Get Salesforce Client_ID and Client_Secret values
The Coveo security provider and connector for Salesforce must know the Client_ID and Client_Secret values for your Salesforce organization to be authorized to access its content (see Getting Salesforce Client_ID and Client_Secret Values).
-
Create an ObjectsToGet configuration file
An ObjectsToGet XML configuration file tells the crawler which Salesforce items to retrieve (see Salesforce ObjectsToGet Configuration File).
You must create your custom ObjectsToGet XML configuration file before configuring your source. You can create the file based on examples that include standard objects and include your custom objects (see Creating a Salesforce ObjectsToGet Configuration File).
-
Configure a mapping file
A Salesforce source needs a mapping file to know how to map retrieved Salesforce items to CES index fields. You must create a mapping file before you configure your Salesforce source (see Creating a Salesforce Mapping File).
-
Create a custom Salesforce field set CES 7.0.6607+ (April 2014)
-
The Salesforce source needs a field set matching the CES fields that are included in the mapping file (see Adding a Field Set). It is recommended to start by importing the default Salesforce field set file ([CES_Path]\Bin\Coveo.CES.CustomCrawlers.Salesforce.FieldSet.xml) to create fields for all the metadata available by default from Salesforce content (see Exporting and Importing a Field Set).
-
When you created custom Salesforce object and fields, add corresponding fields to the field set (see Adding or Modifying Custom Fields).
-
-
Configure an Email security provider
Note: For a Salesforce Knowledge Base source, you do not need to perform this procedure. Knowledge Base permissions cannot be indexed so no Email security provider is needed.
In Salesforce, users are identified by their email addresses. Consequently, permissions returned by the Salesforce security provider for each document are email addresses. The Salesforce security provider then requires another security provider to uniquely identify users from their email addresses.
The security provider type to use depends on how users are authenticated when they access the search interface:
-
When authenticated with their email address, use an Email security provider (see Configuring an Email Security Provider).
-
When authenticated with their Active Directory account, use an Active Directory security provider (see Configuring an Active Directory Security Provider).
Note: An Active Directory security provider is appropriate only when the User Principal Name (UPN) matches the email address for all users.
Note: You may require to also use a Regex Transform Member Name security provider in between the two other security providers to map member types. Contact Coveo Support for assistance.
-
-
Configure a Salesforce security provider
Note: For a Salesforce Knowledge Base source, you do not need to perform this procedure. Knowledge Base permissions cannot be indexed so no Email security provider is needed.
A Salesforce source needs a Salesforce security provider (see Configuring a Salesforce Security Provider).
-
Configure and index the Salesforce source
The Coveo connector needs to know details about your Salesforce organization to be able to index the desired content (see Configuring and Indexing a Salesforce Source).
-
If you encounter issues:
-
Solve typical issues that return error messages (see Troubleshooting Salesforce Connector Issues).
-
Consider adding and modifying default values of hidden source parameters (see Modifying Hidden Salesforce Source Parameters).
-