Salesforce connector V1.0
Salesforce is a customer relationship management (CRM) tool for managing support, sales, and marketing teams. You can use Amazon Kendra to index your Salesforce standard objects and even custom objects.
Important
Amazon Kendra uses the Salesforce API version 48. The Salesforce API limits the number of requests that you can make per day. If Salesforce exceeds those requests, it retries until it is able to continue.
Note
Salesforce connector V1.0 / SalesforceConfiguration API ended in 2023. We recommend migrating to or using Salesforce connector V2.0 / TemplateConfiguration API.
For troubleshooting your Amazon Kendra Salesforce data source connector, see Troubleshooting data sources.
Supported features
Amazon Kendra Salesforce data source connector supports the following features:
-
Field mappings
-
User access control
-
Inclusion/exclusion filters
Prerequisites
Before you can use Amazon Kendra to index your Salesforce data source, make these changes in your Salesforce and AWS accounts.
In Salesforce, make sure you have:
-
Created a Salesforce account and have noted the user name and password you use to connect to Salesforce.
-
Created a Salesforce Connected App account with OAuth activated and have copied the consumer key (client ID) and consumer secret (client secret) assigned to your Salesforce Connected App. The client ID and client secret are used as your authentication credentials stored in an AWS Secrets Manager secret. See Salesforce documentation on Connected Apps
for more information. Note
We recommend that you regularly refresh or rotate your credentials and secret. Provide only the necessary access level for your own security. We do not recommend that you re-use credentials and secrets across data sources, and connector versions 1.0 and 2.0 (where applicable).
-
Copied the Salesforce security token associated with the account used to connect to Salesforce.
-
Copied the URL of the Salesforce instance that you want to index. Typically, this is
https://<company>.salesforce.com/
. The server must be running a Salesforce connected app. -
Added credentials to your Salesforce server for a user with read-only access to Salesforce by cloning the ReadOnly profile and then adding the View All Data and Manage Articles permissions. These credentials identify the user making the connection and the Salesforce connected app that Amazon Kendra connects to.
-
Checked each document is unique in Salesforce and across other data sources you plan to use for the same index. Each data source that you want to use for an index must not contain the same document across the data sources. Document IDs are global to an index and must be unique per index.
In your AWS account, make sure you have:
-
Created an Amazon Kendra index and, if using the API, noted the index ID.
-
Created an IAM role for your data source and, if using the API, noted the ARN of the IAM role.
Note
If you change your authentication type and credentials, you must update your IAM role to access the correct AWS Secrets Manager secret ID.
-
Stored your Salesforce authentication credentials in an AWS Secrets Manager secret and, if using the API, noted the ARN of the secret.
Note
We recommend that you regularly refresh or rotate your credentials and secret. Provide only the necessary access level for your own security. We do not recommend that you re-use credentials and secrets across data sources, and connector versions 1.0 and 2.0 (where applicable).
If you don’t have an existing IAM role or secret, you can use the console to create a new IAM role and Secrets Manager secret when you connect your Salesforce data source to Amazon Kendra. If you are using the API, you must provide the ARN of an existing IAM role and Secrets Manager secret, and an index ID.
Connection instructions
To connect Amazon Kendra to your Salesforce data source, you must provide the necessary details of your Salesforce data source so that Amazon Kendra can access your data. If you have not yet configured Salesforce for Amazon Kendra see Prerequisites.
To connect Amazon Kendra to Salesforce
-
Sign in to the AWS Management Console and open the Amazon Kendra console
. -
From the left navigation pane, choose Indexes and then choose the index you want to use from the list of indexes.
Note
You can choose to configure or edit your User access control settings under Index settings.
-
On the Getting started page, choose Add data source.
-
On the Add data source page, choose Salesforce connector V1.0, and then choose Add connector.
-
On the Specify data source details page, enter the following information:
-
Data source name—Enter a name for your data source. You can include hyphens but not spaces.
-
(Optional) Description—Enter an optional description for your data source.
-
Default language— A language to filter your documents for the index. Unless you specify otherwise, the language defaults to English. Language specified in metadata overrides selected language.
-
Add new tag—Tags to search and filter your resources or track your shared costs.
-
Choose Next.
-
-
On the Define access and security page, enter the following information:
-
Salesforce URL—Enter the instance URL for the Salesforce site that you want to index.
-
For Type of authentication, choose between Existing and New to store your Salesforce authentication credentials. If you choose to create a new secret an AWS Secrets Manager secret window opens.
-
Enter following information in the Create an AWS Secrets Manager secret window:
-
Secret name—A name for your secret. The prefix ‘AmazonKendra-Salesforce-’ is automatically added to your secret name.
-
For User name, Password, Security token, Consumer key, Consumer secret, and Authentication URL—Enter the authentication credential values you created in your Salesforce account.
-
Choose Save authentication.
-
-
-
IAM role—Choose an existing IAM role or create a new IAM role to access your repository credentials and index content.
Note
IAM roles used for indexes cannot be used for data sources. If you are unsure if an existing role is used for an index or FAQ, choose Create a new role to avoid errors.
-
Choose Next.
-
-
On the Configure sync settings page, enter the following information:
-
For Crawl attachments—Select to crawl all attached objects, articles, and feeds.
-
For Standard objects, Knowledge articles, and Chatter feeds—Select Salesforce entities or content types you want to crawl.
Note
You must provide configuration information for indexing at least one of standard objects, knowledge articles, or chatter feeds. If you choose to crawl Knowledge articles you must specify the types of knowledge articles to index, the name of the articles, and whether to index the standard fields of all knowledge articles or only the fields of a custom article type. If you choose to index custom articles, you must specify the internal name of the article type. You can specify upto 10 article types.
-
Frequency—How often Amazon Kendra will sync with your data source.
-
Choose Next.
-
-
On the Set field mappings page, enter the following information:
-
For Standard knowledge article, Standard object attachments, and Additional suggested field mappings —Select from the Amazon Kendra generated default data source fields you want to map to your index.
Note
An index mapping to
_document_body
is required. You can't change the mapping between theSalesforce ID
field and the Amazon Kendra_document_id
field. -
Add field—To add custom data source fields to create an index field name to map to and the field data type.
-
Choose Next.
-
-
On the Review and create page, check that the information you have entered is correct and then select Add data source. You can also choose to edit your information from this page. Your data source will appear on the Data sources page after the data source has been added successfully.