Salesforce 連接器 V2.0 - Amazon Kendra
支援的功能先決條件連線指示進一步了解備註

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

Salesforce 連接器 V2.0

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

Amazon KendraSalesforce 資料來源連接器支援下列 Salesforce 版本：開發人員版本和企業版本。

注意

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

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

支援的功能

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

  • 欄位對應

  • 使用者存取控制

  • 包含/排除篩選條件

  • 完整和增量內容同步

  • 虛擬私有雲端 (VPC)

先決條件

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

在 Salesforce 中，請確定您有：

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

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

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

    注意

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

  • 已複製您要編製索引之 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 連接器，然後選擇新增連接器。如果使用第 2 版 （如適用），請選擇具有「V2.0」標籤的 Salesforce 連接器。

  5. 在指定資料來源詳細資訊頁面上，輸入下列資訊：

    1. 在名稱和描述中，針對資料來源名稱 - 輸入資料來源的名稱。您可以包含連字號，但不能包含空格。

    2. （選用） 描述 — 輸入資料來源的選用描述。

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

    4. 在標籤中，針對新增標籤 - 包含選用標籤，以搜尋和篩選您的資源或追蹤您的AWS成本。

    5. 選擇下一步。

  6. 在定義存取和安全性頁面上，輸入下列資訊：

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

    2. 授權：如果您有 ACL 並想要將其用於存取控制，請開啟或關閉文件的存取控制清單 (ACL) 資訊。ACL 指定使用者可以和群組存取哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。

    3. 輸入現有的秘密，或者如果您建立新的秘密，則會AWS開啟Secrets Manager秘密視窗。

      1. Authentication - 在建立AWSSecrets Manager秘密視窗中輸入下列資訊：

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

        2. 針對使用者名稱、密碼、安全字符、消費者金鑰、消費者秘密和身分驗證 URL—輸入您從 Salesforce 帳戶產生和下載的身分驗證憑證值。

          注意

          如果您使用 Salesforce Developer Edition，請使用 https://login.salesforce.com/services/oauth2/token或 My Domain 登入 URL （例如 https://MyCompany.my.salesforce.com) 做為身分驗證 URL。如果您使用 Salesforce Sandbox Edition，請使用 https://test.salesforce.com/services/oauth2/token 或 My Domain 登入 URL （例如 MyDomainName--SandboxName.sandbox.my.salesforce.com) 做為身分驗證 URL。

        3. 選擇儲存身分驗證。

    4. Virtual Private Cloud (VPC) — 您可以選擇使用 VPC。若是如此，您必須新增子網路和 VPC 安全群組。

    5. 身分爬蟲程式 - 指定是否開啟 Amazon Kendra的身分爬蟲程式。身分爬蟲程式會使用文件的存取控制清單 (ACL) 資訊，根據使用者或其群組對文件的存取來篩選搜尋結果。如果您有文件的 ACL 並選擇使用 ACL，您也可以選擇開啟Amazon Kendra身分爬蟲程式，以設定搜尋結果的使用者內容篩選。否則，如果關閉身分識別編目程式，則所有文件都可公開搜尋。如果您想要使用文件的存取控制，而身分識別編目程式為關閉狀態，您可以改用 PutPrincipalMapping API 來上傳使用者和群組存取資訊，以供使用者內容篩選使用。

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

      注意

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

    7. 選擇下一步。

  7. 在設定同步設定頁面上，輸入下列資訊：

    1. 對於網路爬取連接 - 選取 以網路爬取所有連接的 Salesforce 物件。

    2. 對於標準物件、含附件的標準物件，以及不含附件和知識文章的標準物件 - 選取您要抓取的 Salesforce 實體或內容類型。

    3. 您至少需提供一項：標準物件、知識文章或 Chatter 摘要的組態資訊，才能執行編索編製。如果您選擇編目知識文章，則必須指定要編製索引的知識文章類型。您可以選擇已發佈、已封存、草稿和附件。

      Regex 篩選條件 - 指定要包含特定目錄項目的 regex 模式。

  8. 對於其他組態：

    • ACL 資訊 預設會包含所有存取控制清單。取消選取存取控制清單會將該類別中的所有檔案設為公有。

    • Regex 模式 - 新增規則表達式模式，以包含或排除特定檔案。最多可新增 100 個模式。

    同步模式 - 選擇您希望在資料來源內容變更時更新索引的方式。當您第一次使用 Amazon Kendra同步資料來源時，預設會爬取所有內容並編製索引。如果初始同步失敗，即使您未選擇完全同步做為同步模式選項，仍必須執行資料的完整同步。

    • 完全同步：新編製所有內容的索引，每次資料來源與索引同步時取代現有的內容。

    • 新的、修改過的同步：每次資料來源與索引同步時，僅索引新的和修改的內容。 Amazon Kendra可以使用資料來源的機制來追蹤內容變更，以及自上次同步以來變更的索引內容。

    • 新的、已修改、已刪除的同步：每次資料來源與您的索引同步時，僅索引新的、已修改和已刪除的內容。 Amazon Kendra可以使用資料來源的機制來追蹤自上次同步以來變更的內容和索引內容。

  9. 選擇下一步。

  10. 在設定欄位映射頁面上，輸入下列資訊：

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

      注意

      _document_body 需要索引映射至 。您無法變更 Salesforce ID 欄位與Amazon Kendra _document_id 欄位之間的映射。您可以將任何 Salesforce 欄位對應至文件標題或文件內文 Amazon Kendra 預留/預設索引欄位。

      如果您將任何 Salesforce 欄位映射至 Amazon Kendra 文件標題和文件內文欄位，Amazon Kendra 會在搜尋回應中使用來自文件標題和內文欄位的資料。

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

    3. 選擇下一步。

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

API

Amazon Kendra連線至 Salesforce

您必須使用 TemplateConfiguration API 指定資料來源結構描述的 JSON。您必須提供下列資訊：

  • 資料來源 - 當您使用 TemplateConfiguration JSON 結構描述SALESFORCEV2時，指定資料來源類型。另請在呼叫 CreateDataSource API TEMPLATE時將資料來源指定為 。

  • 主機 URL - 指定 Salesforce 執行個體主機 URL。

  • 同步模式 - 指定 如何在Amazon Kendra資料來源內容變更時更新索引。當您Amazon Kendra第一次使用 同步資料來源時，預設會爬取所有內容並編製索引。如果初始同步失敗，即使您未選擇完全同步做為同步模式選項，仍必須執行資料的完整同步。您可以選擇：

    • FORCED_FULL_CRAWL 以新編製所有內容的索引，每次資料來源與索引同步時都會取代現有的內容。

    • FULL_CRAWL 每次資料來源與索引同步時， 只會編製新內容、修改內容和已刪除內容的索引。 Amazon Kendra可以使用資料來源的機制來追蹤自上次同步以來變更的內容變更和索引內容。

    • CHANGE_LOG 每次資料來源與索引同步時， 只會編製新內容和已修改內容的索引。 Amazon Kendra可以使用資料來源的機制來追蹤自上次同步以來變更的內容變更和索引內容。

  • 機密 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 資料來源的角色。

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

  • Virtual Private Cloud (VPC)—指定您呼叫 VpcConfiguration的時間CreateDataSource。如需詳細資訊，請參閱設定 Amazon Kendra 以使用 Amazon VPC。

  • 包含和排除篩選條件 - 您可以指定是否包含或排除特定文件、帳戶、行銷活動、案例、聯絡人、潛在客戶、機會、解決方案、任務、群組、聊天器和自訂實體檔案。

    注意

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

  • 身分爬蟲程式 - 指定是否開啟 Amazon Kendra的身分爬蟲程式。身分爬蟲程式會使用文件的存取控制清單 (ACL) 資訊，根據使用者或其群組對文件的存取來篩選搜尋結果。如果您有文件的 ACL 並選擇使用您的 ACL，您也可以選擇開啟Amazon Kendra身分爬蟲程式，以設定搜尋結果的使用者內容篩選。否則，如果關閉身分識別編目程式，則所有文件都可公開搜尋。如果您想要使用文件的存取控制，而身分識別編目程式為關閉狀態，您可以改用 PutPrincipalMapping API 來上傳使用者和群組存取資訊，以供使用者內容篩選使用。

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

    注意

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

    注意

    _document_body 需要索引映射至 。您無法變更 Salesforce ID 欄位與Amazon Kendra _document_id 欄位之間的映射。您可以將任何 Salesforce 欄位對應至文件標題或文件內文 Amazon Kendra 預留/預設索引欄位。

    如果您將任何 Salesforce 欄位映射至 Amazon Kendra 文件標題和文件內文欄位，Amazon Kendra 會在搜尋回應中使用來自文件標題和內文欄位的資料。

如需要設定的其他重要 JSON 金鑰清單，請參閱 Salesforce 範本結構描述。

進一步了解

若要進一步了解Amazon Kendra如何與您的 Salesforce 資料來源整合，請參閱：

備註

  • 啟用存取控制清單 (ACLs) 時，由於 Salesforce API 限制，無法使用「僅同步新的或修改的內容」選項。建議改用「完整同步」或「新增/修改/刪除內容同步」模式；若需使用此模式，請停用 ACL。