Alfresco - Amazon Kendra

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

Alfresco

Alfresco是一項內容管理服務,可協助客戶儲存和管理其內容。您可以使 Amazon Kendra 用索引您的Alfresco文件庫、Wiki 和部落格。

Amazon Kendra 支援Alfresco內部部署和Alfresco雲端 (平台即服務)。

您可以使用Amazon Kendra 主控台TemplateConfigurationAPI 連線 Amazon Kendra 到Alfresco資料來源。

有關 Amazon Kendra Alfresco 資料來源連接器的疑難排解,請參閱。疑難排解資料來

支援的功能

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

  • 欄位對映

  • 使用者存取控制

  • 包含/排除過濾器

  • 完整和增量內容同步

  • OAuth 2.0 和基本身份驗證

  • 虛擬私有雲端 (VPC)

必要條件

在您可以用 Amazon Kendra 來為 Alfresco 資料來源建立索引之前,請先在和中進行這些變更。Alfresco AWS 帳戶

在中Alfresco,請確定您有:

  • 複製您的Alfresco儲存庫 URL 和 Web 應用程式 URL。如果您只想為特定Alfresco網站建立索引,請同時複製網站 ID。

  • 記下您的Alfresco驗證認證,其中包括至少具有讀取權限的使用者名稱和密碼。如果要使用 OAuth 2.0 身份驗證,則應將用戶添加到Alfresco管理員組中。

    注意

    我們建議您定期重新整理或輪換您的認證和密碼。僅為您自己的安全提供必要的訪問級別。我們建議您跨資料來源以及連接器 1.0 和 2.0 版 (如果適用) 重複使用認證和密碼。

  • 選用性:在Alfresco中設定 OAuth 2.0 認證。憑據包括客戶端 ID,客戶端密鑰和令牌 URL。如需如何設定Alfresco內部部署用戶端的詳細資訊,請參閱 Alfresco 文件。如果您使用Alfresco雲(PaaS),則必須聯繫海蘭支持以進行 Alfresco OAuth 2.0 身份驗證。

  • 檢查每個文檔在 Alfresco 和您打算用於同一索引的其他數據源中是唯一的。您要用於索引的每個資料來源不得包含跨資料來源的相同文件。文件 ID 對索引來說是全域的,而且每個索引必須是唯一的。

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

  • 建立 Amazon Kendra 索引,如果使用 API,則會記下索引識別碼。

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

    注意

    如果您變更驗證類型和認證,則必須更新 IAM 角色才能存取正確的 AWS Secrets Manager 密碼 ID。

  • 將您的 Alfresco 身份驗證憑據存儲在 AWS Secrets Manager 秘密中,並且如果使用 API,則記錄密鑰的 ARN。

    注意

    我們建議您定期重新整理或輪換您的認證和密碼。僅為您自己的安全提供必要的訪問級別。我們建議您跨資料來源以及連接器 1.0 和 2.0 版 (如果適用) 重複使用認證和密碼。

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

連接說明

若要連線 Amazon Kendra 到 Alfresco 資料來源,您必須提供 Alfresco 資料來源的必要詳細資料, Amazon Kendra 以便能夠存取您的資料。如果尚未設定「露天」 Amazon Kendra,請參閱。必要條件

Console

若要連線 Amazon Kendra 到 Alfresco

  1. 登入 AWS Management Console 並開啟Amazon Kendra 主控台

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

    注意

    您可以選擇在索引設置下配置或編輯您的用戶訪問控制設置

  3. 在 [開始使用] 頁面上,選擇 [新增資料來源]。

  4. 在 [新增資料來源] 頁面上,選擇 [Alfresco 連接器],然後選擇 [新增連接器]。如果使用版本 2(如果適用),請選擇帶有「V2.0」標籤的 Alfresco 連接器

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

    1. 名稱和說明中,對於資料來源名稱 — 輸入資料來源的名稱。您可以包含連字號,但不能包含空格。

    2. (選擇性) 說明 — 輸入資料來源的選用說明。

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

    4. 在「」中,針對「新增標籤」— 包含可選標籤以搜尋和篩選資源或追蹤 AWS 成本。

    5. 選擇下一步

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

    1. Alfrescotype — 選擇您使用內部部Alfresco署/伺服器還是Alfresco雲端 (平台即服務)。

    2. 露天儲存庫 URL — 輸入您的露天儲存庫 URL。例如,如果您使用Alfresco雲端 (PaaS),則存放庫 URL 可能是https://company.alfrescocloud.com。或者,如果您使用 Alfresco 內部部署,則存放庫 URL 可能是。https://company-alfresco-instance.company-domain.suffix:port

    3. 露天用戶應用程序。URL — 輸入您的Alfresco使用者介面 URL。您可以向Alfresco管理員取得存放庫 URL。例如,使用者介面網址可以是 https://example.com

    4. SSL 憑證位置 — 輸入儲存在 Amazon S3 值區中之 SSL 憑證的路徑。您可以使用此連線到Alfresco內部部署,透過安全的 SSL 連線。

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

    6. 驗證 — 選擇「基本驗證」或「OAuth 2.0 驗證」。然後選擇現有 Secrets Manager 密碼或建立新密碼來儲存您的Alfresco認證。如果您選擇建立新密碼,則會開啟一個 AWS Secrets Manager 密碼視窗。

      如果您選擇基本驗證,請輸入密碼的名稱、使Alfresco用者名稱和密碼。

      如果您選擇 OAuth 2.0 驗證,請輸入密碼、用戶端 ID、用戶端密碼和權杖 URL 的名稱。

    7. V@@ irtual Private Cloud (VPC) (VPC) — 您可以選擇使用 VPC。如果是這樣,您必須新增子網路VPC 安全性群組。

    8. 識別爬行者程式 — 指定是否要開啟身分識別爬行 Amazon Kendra者程式。識別爬行者程式會使用文件的存取控制清單 (ACL) 資訊,根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如果您有文件的 ACL 並選擇使用 ACL,您也可以選擇開啟的身分識別爬行者程式,以設定搜尋結果的使用者環境定義篩選。 Amazon Kendra否則,如果關閉身分搜索器,則可以公開搜索所有文檔。如果您想要對文件使用存取控制,且身分識別編目程式已關閉,您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊以進行使用者內容篩選。

    9. IAM role — 選擇現有 IAM 角色或建立新 IAM 角色以存取存放庫認證和索引內容。

      注意

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

    10. 選擇下一步

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

    1. 同步範圍 — 設定編目特定內容的限制,並使用正則運算式運算式模式篩選內容。

      1. 內容 — 選擇是要編目中標有「層面」的內容Alfresco、特定Alfresco網站內的內容,還是搜索所有網站上的Alfresco內容。

      2. (選擇性) 其他組態 — 設定下列設定:

        • 包含註解 — 選擇在「Alfresco文件庫」和「部落格」中包含註解。

        • 正則表達式模式-包含或排除某些文件的正則表達式模式。

    2. 同步模式 — 選擇資料來源內容變更時要如何更新索引。當您第一次將資料來源同 Amazon Kendra 步處理時,依預設會檢索所有內容並建立索引。如果初始同步失敗,您必須執行資料的完整同步處理,即使您沒有選擇完整同步作為同步模式選項。

      • 完全同步:新鮮索引所有內容,並在每次資料來源與索引同步時取代現有內容。

      • 新增、修改、刪除的同步:每次資料來源與索引同步時,僅對新內容、已修改和刪除的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更,並為上次同步後變更的內容建立索引。

    3. 同步執行排程中,對於頻率 — 選擇同步資料來源內容和更新索引的頻率。

    4. 選擇下一步

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

    1. 從 Amazon Kendra 產生的預設資料來源欄位中選取您要對映至索引的資料來源欄位。

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

    3. 選擇下一步

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

API

若要連線 Amazon Kendra 到 Alfresco

您必須使用 TemplateConfigurationAPI 指定資料來源結構描述的 JSON。您必須提供以下信息:

  • 資料來源 — 指定使用 TemplateConfigurationJSON 結構定義ALFRESCO時的資料來源類型。同時指定呼叫 CreateDataSourceAPI TEMPLATE 時的資料來源。

  • Alfresco網站 ID — 指定露天網站 ID。

  • Alfresco存放庫 URL — 指定Alfresco存放庫 URL。您可以向Alfresco管理員取得存放庫 URL。例如,如果您使用Alfresco雲端 (PaaS),則存放庫 URL 可能是https://company.alfrescocloud.com。或者,如果您使用 Alfresco 內部部署,則存放庫 URL 可能是。https://company-alfresco-instance.company-domain.suffix:port

  • AlfrescoWeb 應用程式 URL — 指定Alfresco使用者介面 URL。您可以向Alfresco管理員取得存放庫 URL。例如,使用者介面網址可以是 https://example.com

  • 驗證類型 — 指定您要使用的驗證類型,無論是OAuth2Basic

  • Alfrescotype — 指定Alfresco您使用的類型 PAAS (雲端/平台即服務) 或 ON_PREM (內部部署)。

  • 秘密 Amazon 資源名稱 (ARN) — 如果您想要使用基本身份驗證,請提供一個密碼來儲存您的使用者名稱和密碼身份驗證登入資料。您提供一個 AWS Secrets Manager 秘密的 Amazon 資源名稱(ARN)。密碼會以下列金鑰儲存在 JSON 結構中:

    { "username": "user name", "password": "password" }

    如果要使用 OAuth 2.0 身份驗證,則密鑰將使用以下密鑰存儲在 JSON 結構中:

    { "clientId": "client ID", "clientSecret": "client secret", "tokenUrl": "token URL" }
  • IAM role — 指定RoleArn何時呼叫CreateDataSource以提供具有存取 Secrets Manager 密碼權限的 IAM 角色,以及呼叫 Alfresco 連接器和所需的公用 API 的時間。 Amazon Kendra有關詳情,請參閱 Alfresco 資料來源的IAM 角色

您還可以添加以下可選功能:

  • V@@ irtual Private Cloud (VPC) — 指定您撥打電話的VpcConfiguration時間。CreateDataSource如需詳細資訊,請參閱 設定 Amazon Kendra 若要使用 Amazon VPC

  • 內容類型 — 您要編目的內容類型,無論是在中標有「面向」的內容Alfresco、特定Alfresco網站內的內容,還是您所有網Alfresco站上的內容。您還可以列出特定的「方面」內容。

  • 包含和排除篩選器 — 指定要包含還是排除某些檔案。

    注意

    大多數資料來源使用規則運算式模式,這些模式是稱為篩選器的包含或排除模式。如果您指定包含篩選器,則只有符合包含項目篩選器的內容會編製索引。不符合包含篩選器的任何文件都不會建立索引。如果您指定包含和排除篩選器,符合排除篩選器的文件將不會建立索引,即使它們符合包含篩選器也是如此。

  • 同步模式 — 指定資料來源內容變更時 Amazon Kendra 應如何更新索引。當您第一次將資料來源同 Amazon Kendra 步處理時,依預設會檢索所有內容並建立索引。如果初始同步失敗,您必須執行資料的完整同步處理,即使您沒有選擇完整同步作為同步模式選項。您可以選擇:

    • FORCED_FULL_CRAWL新建索引所有內容,並在每次資料來源與索引同步時取代現有內容。

    • FULL_CRAWL,以在每次資料來源與索引同步時,僅對新的、修改的和刪除的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更,並為上次同步後變更的內容建立索引。

  • 識別爬行者程式 — 指定是否要開啟身分識別爬行 Amazon Kendra者程式。識別爬行者程式會使用文件的存取控制清單 (ACL) 資訊,根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如果您有文件的 ACL 並選擇使用 ACL,您也可以選擇開啟的身分識別爬行者程式,以設定搜尋結果的使用者環境定義篩選。 Amazon Kendra否則,如果關閉身分搜索器,則可以公開搜索所有文檔。如果您想要對文件使用存取控制,且身分識別編目程式已關閉,您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊以進行使用者內容篩選。

  • 欄位對映 — 選擇將 Alfresco 資料來源欄位對映至索引欄位。 Amazon Kendra 如需詳細資訊,請參閱映射資料來源欄位

    注意

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

如需要設定的其他重要 JSON 金鑰清單,請參閱Alfresco範本結構定義

進一步了解

若要深入瞭解如何 Amazon Kendra 與 Alfresco 資料來源整合,請參閱: