Salesforce 連接器 V1.0 - Amazon Kendra

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Salesforce 連接器 V1.0

Salesforce 是一款用於管理支援、銷售和行銷團隊的客戶關係管理 (CRM) 工具。您可以使用 Amazon Kendra為 Salesforce 標準物件,甚至是自訂物件編製索引。

重要

Amazon Kendra使用 Salesforce API 第 48 版。Salesforce API 會限制您每天可以提出的請求數量。如果 Salesforce 超過這些請求,它會重試,直到能夠繼續為止。

注意

Salesforce 連接器 V1.0/SalesforceConfiguration API 已於 2023 年結束。我們建議您遷移至或使用 Salesforce 連接器 V2.0 / TemplateConfiguration API。

如需對 Amazon KendraSalesforce 資料來源連接器進行故障診斷,請參閱 對資料來源進行故障診斷

支援的功能

Amazon KendraSalesforce 資料來源連接器支援下列功能:

  • 欄位對應

  • 使用者存取控制

  • 包含/排除篩選條件

先決條件

在您可以使用 Amazon Kendra為 Salesforce 資料來源編製索引之前,請在 Salesforce 和AWS帳戶中進行這些變更。

在 Salesforce 中,請確定您有:

  • 已建立 Salesforce 帳戶,並記下您用來連線至 Salesforce 的使用者名稱和密碼。

  • 建立已啟用 OAuth 的 Salesforce Connected App 帳戶,並複製指派給 Salesforce Connected App 的取用者金鑰 (用戶端 ID) 和取用者秘密 (用戶端秘密)。用戶端 ID 和用戶端秘密會用作存放在AWS Secrets Manager秘密中的身分驗證憑證。如需詳細資訊,請參閱連線應用程式的 Salesforce 文件

    注意

    建議定期更新或輪換憑證與機密。僅授予作業所需的最低存取層級,以確保自身安全。我們不建議您在資料來源以及連接器 1.0 和 2.0 版 (如適用) 之間重複使用登入資料和秘密。

  • 已複製與用於連線至 Salesforce 之帳戶相關聯的 Salesforce 安全性字符。

  • 已複製您要編製索引之 Salesforce 執行個體的 URL。通常為 https://<company>.salesforce.com/。伺服器必須執行已連線 Salesforce 的應用程式。

  • 為具有 Salesforce 唯讀存取權的使用者新增登入資料,方法是複製 ReadOnly 設定檔,然後新增檢視所有資料和管理文章許可。這些登入資料會識別進行連線的使用者,以及Amazon Kendra連線的 Salesforce 連線應用程式。

  • 已檢查每個文件在 Salesforce 中以及您計劃用於相同索引的其他資料來源中都是唯一的。您要用於索引的每個資料來源不得包含跨資料來源的相同文件。文件 IDs是索引的全域 ID,且每個索引必須是唯一的。

在您的 中AWS 帳戶,請確定您有:

  • 已建立Amazon Kendra索引,如果使用 API, 會記下索引 ID。

  • 為您的資料來源建立 IAM角色,如果使用 API, 會記下IAM角色的 ARN。

    注意

    如果您變更身分驗證類型和登入資料,則必須更新您的IAM角色以存取正確的AWS Secrets Manager秘密 ID。

  • 將您的 Salesforce 身分驗證登入資料存放在AWS Secrets Manager秘密中,如果使用 API, 會記下秘密的 ARN。

    注意

    建議定期更新或輪換憑證與機密。僅授予作業所需的最低存取層級,以確保自身安全。我們不建議您在資料來源以及連接器 1.0 和 2.0 版 (如適用) 之間重複使用登入資料和秘密。

如果您沒有現有的IAM角色或秘密,您可以在連線至 Salesforce 資料來源時使用 主控台建立新的IAM角色和Secrets Manager秘密Amazon Kendra。如果您使用 API,則必須提供現有IAM角色和Secrets Manager秘密的 ARN,以及索引 ID。

連線指示

若要Amazon Kendra連線至 Salesforce 資料來源,您必須提供 Salesforce 資料來源的必要詳細資訊,以便 Amazon Kendra可以存取您的資料。如果您尚未為 設定 Salesforce,Amazon Kendra請參閱 先決條件

Console

Amazon Kendra連線至 Salesforce

  1. 登入 AWS管理主控台並開啟Amazon Kendra主控台

  2. 從左側導覽窗格中,選擇索引,然後從索引清單中選擇您要使用的索引。

    注意

    您可以選擇在索引設定下設定或編輯使用者存取控制設定。

  3. 入門頁面上,選擇新增資料來源

  4. 新增資料來源頁面上,選擇 Salesforce 連接器 V1.0,然後選擇新增連接器

  5. 指定資料來源詳細資訊頁面上,輸入下列資訊:

    1. 資料來源名稱 - 輸入資料來源的名稱。您可以包含連字號,但不能包含空格。

    2. (選用) 描述 — 輸入資料來源的選用描述。

    3. 預設語言 — 用來篩選索引文件的語言。除非您另有指定,否則語言預設為英文。中繼資料中指定的語言會覆寫選取的語言。

    4. 新增標籤 - 用於搜尋和篩選資源或追蹤共享成本的標籤。

    5. 選擇下一步

  6. 定義存取和安全性頁面上,輸入下列資訊:

    1. Salesforce URL - 輸入您要編製索引之 Salesforce 網站的執行個體 URL。

    2. 針對身分驗證類型,選擇現有新增以存放 Salesforce 身分驗證憑證。如果您選擇建立新的秘密,則會開啟AWSSecrets Manager秘密視窗。

      1. 建立AWSSecrets Manager秘密視窗中輸入以下資訊:

        1. 機密名稱 - 輸入您的機密名稱。字首「AmazonKendra-Salesforce-」會自動新增至您的秘密名稱。

        2. 對於使用者名稱密碼安全字符消費者金鑰消費者秘密身分驗證 URL — 輸入您在 Salesforce 帳戶中建立的身分驗證憑證值。

        3. 選擇儲存身分驗證

    3. IAMrole - 選擇現有IAM角色或建立新的IAM角色,以存取您的儲存庫登入資料和索引內容。

      注意

      IAM用於索引的 角色無法用於資料來源。如果您不確定現有角色是否用於索引或常見問答集,請選擇建立新角色以避免錯誤。

    4. 選擇下一步

  7. 設定同步設定頁面上,輸入下列資訊:

    1. 對於網路爬取附件 - 選取 以網路爬取所有連接的物件、文章和摘要。

    2. 對於標準物件知識文章Chatter 摘要 - 選取您要抓取的 Salesforce 實體或內容類型。

      注意

      您至少需提供一項:標準物件、知識文章或 Chatter 摘要的組態資訊,才能執行編索編製。若您選擇爬取知識文章,需指定要索引的知識文章類型與文章名稱,並設定要索引所有知識文章的標準欄位,或僅索引特定自訂文章類型的欄位。若選擇為自訂文章編索,必須提供該文章類型的內部名稱。您最多可以指定 10 個文章類型。

    3. 頻率 - 與您的資料來源Amazon Kendra同步的頻率。

    4. 選擇下一步

  8. 設定欄位映射頁面上,輸入下列資訊:

    1. 對於標準知識文章標準物件附件和其他建議的欄位映射 - 從您要映射到索引Amazon Kendra的產生預設資料來源欄位中選取 。

      注意

      _document_body 需要索引映射至 。您無法變更 Salesforce ID 欄位與Amazon Kendra _document_id 欄位之間的映射。

    2. 新增欄位 - 新增自訂資料來源欄位,以建立要映射的索引欄位名稱和欄位資料類型。

    3. 選擇下一步

  9. 檢閱和建立頁面上,檢查您輸入的資訊是否正確,然後選取新增資料來源。您也可以選擇從此頁面編輯您的資訊。成功新增資料來源後,您的資料來源將顯示在資料來源頁面上。

API

Amazon Kendra連線至 Salesforce

您必須指定下列 SalesforceConfiguration API:

  • 伺服器 URL - 您要編製索引之 Salesforce 網站的執行個體 URL。

  • 機密 Amazon Resource Name (ARN) — 提供機密的 Amazon Resource Name (ARN)Secrets Manager,其中包含 Salesforce 帳戶的身分驗證憑證。秘密會以下列金鑰存放在 JSON 結構中:

    { "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token", "consumerKey": "Application public key generated when you created your Salesforce application", "consumerSecret": "Application private key generated when you created your Salesforce application.", "password": "Password associated with the user logging in to the Salesforce instance", "securityToken": "Token associated with the user account logging in to the Salesforce instance", "username": "User name of the user logging in to the Salesforce instance" }
  • IAMrole—指定RoleArn您何時呼叫 CreateDataSource 以提供IAM角色存取Secrets Manager秘密的許可,以及呼叫 Salesforce 連接器所需的公有 APIs 和 Amazon Kendra。如需詳細資訊,請參閱 IAMSalesforce 資料來源的角色

  • 您至少需提供一項:標準物件、知識文章或 Chatter 摘要的組態資訊,才能執行編索編製。

    • 標準物件 - 如果您選擇編目標準物件,則必須在包含文件內容的標準物件資料表中指定標準物件的名稱和 欄位的名稱。

    • 知識文章 - 如果您選擇編目知識文章,您必須指定要編製索引的知識文章類型、要編製索引的知識文章狀態,以及要為所有知識文章的標準欄位編製索引,還是只指定自訂文章類型的欄位。

    • Chatter 摘要 - 如果您選擇爬取 Chatter 摘要,您必須在 Salesforce FeedItem 資料表中指定資料欄的名稱,其中包含要編製索引的內容。

您也可以新增下列選用功能:

  • 包含和排除篩選條件 - 指定是否包含或排除特定檔案附件。

    注意

    大多數資料來源使用規則表達式模式,作為包含或排除的篩選規則,稱為篩選條件。若您設定包含篩選條件,則只有符合該條件的內容會被編列索引。任何不符合包含篩選條件的文件都不會編製索引。如果您指定包含和排除篩選條件,則符合排除篩選條件的文件不會編製索引,即使它們符合包含篩選條件。

  • 欄位映射 - 選擇將 Salesforce 資料來源欄位映射至您的Amazon Kendra索引欄位。如需詳細資訊,請參閱映射資料來源欄位

    注意

    需要文件內文欄位或文件內文對等項目, Amazon Kendra才能搜尋您的文件。您必須將資料來源中的文件內文欄位名稱映射至索引欄位名稱 _document_body。所有其他欄位是選用的。

  • 使用者內容篩選和存取控制 —Amazon Kendra 如果您有文件的 ACL, 會為您的文件編目存取控制清單 (ACL)。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊,請參閱使用者內容篩選