匯流連接器 V2.0

Confluence 是一種協作工作管理工具，專為共享，存儲和工作項目規劃，軟件開發和產品管理而設計。您可以使用... Amazon Kendra 索引您的匯流空間，頁面（包括嵌套頁面），博客，以及索引頁面和博客的評論和附件。

對於故障排除 Amazon Kendra 匯流資料來源連接器，請參閱。疑難排解資料來

主題

支援的功能
必要條件
連接說明

支援的功能

Amazon Kendra 匯流資料來源連接器支援以下功能：

欄位對映
使用者存取控制
包含/排除模式
完整和增量內容同步
虛擬私有雲 (VPC)

必要條件

在您可以使用 Amazon Kendra 為您的匯流資料來源建立索引，請在您的匯流中進行這些變更 AWS 帳戶。

在匯流中，確保您具有：

複製您的匯流實例。URL例如：https://example.confluence.com，或 https://www.example.confluence.com/，或 https:// atlassian.net/。您需要您的匯流實例才能連URL接到 Amazon Kendra.

如果您使用的是匯流雲，您的主機URL必須以 atlassian.net/.
注意
不支援下列URL格式：
- https://example.confluence.com/xyz
- https://www.example.confluence.com//wiki/spacekey/xxx
- https://atlassian.net/xyz
注意
(預備版/伺服器) Amazon Kendra 檢查端點資訊是否包含在 AWS Secrets Manager 與資料來源組態詳細資料中指定的端點資訊相同。這有助於防止混淆的副問題，這是一個安全問題，即用戶沒有執行操作的權限，但使用 Amazon Kendra 作為代理訪問配置的密碼並執行操作。如果您稍後變更端點資訊，則必須建立新密碼才能同步此資訊。
配置了包含用戶名（用於登錄匯流的電子郵件 ID）和密碼（匯流API令牌作為密碼）的基本身份驗證憑據。請參閱管理您的 Atlassian 帳戶的API權杖。

注意
我們建議您定期重新整理或輪換您的認證和密碼。僅為您自己的安全提供必要的訪問級別。我們不建議您跨資料來源以及連接器 1.0 和 2.0 版 (如果適用) 重複使用認證和密碼。
可選：配置 OAuth 2.0 憑據包含匯流應用程序密鑰，匯流應用程序秘密，匯流訪問令牌和匯流刷新令牌以允許 Amazon Kendra 連接到您的匯流實例。如果您的訪問令牌過期，則可以使用刷新令牌重新生成訪問令牌並刷新令牌對。或者，您可以重複授權過程。有關訪問令牌的詳細信息，請參閱管理OAuth訪問令牌。
（僅適用於匯流服務器/數據中心）可選：在匯流中配置了個人訪問令牌（PAT）。請參閱使用個人存取權杖。

在您的 AWS 帳戶，請確定您有：

創建了一個 Amazon Kendra 索引，如果使用API，則註明索引 ID。
創建了一個 IAM 您的資料來源的角色，如果使用API，請註明 ARN IAM 角色。

注意
如果您變更驗證類型和認證，則必須更新您的 IAM 角色訪問正確 AWS Secrets Manager 秘密識別碼。
將您的匯流身份驗證憑據存儲在 AWS Secrets Manager 秘密和, 如果使用API, 注意到ARN的秘密.

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

如果您沒有現有 IAM 角色或秘密，您可以使用控制台創建一個新的 IAM 角色和 Secrets Manager 秘密，當你連接你的匯流數據源 Amazon Kendra。如果您使用的是API，您必須提供現有ARN的 IAM 角色和 Secrets Manager 秘密和索引識別碼。

連接說明

若要連線 Amazon Kendra 到您的匯流數據源，您必須提供您的匯流數據源的必要詳細信息，以便 Amazon Kendra 可以訪問您的數據。如果您尚未設定「匯流」 Amazon Kendra 請參閱必要條件。

Console

若要連線 Amazon Kendra 至匯合

登入 AWS Management Console 並打開 Amazon Kendra 控制台。
在左側導覽窗格中，選擇 [索引]，然後從索引清單中選擇要使用的索引。

注意
您可以選擇在索引設置下配置或編輯您的用戶訪問控制設置。
在 [開始使用] 頁面上，選擇 [新增資料來源]。
在 [新增資料來源] 頁面上，選擇 [匯流連接器]，然後選擇 [新增連接器]。如果使用版本 2（如果適用），請選擇帶有「V2.0」標籤的匯流連接器。
在 [指定資料來源詳細資訊] 頁面上，輸入下列資訊：
1. 在名稱和說明中，對於資料來源名稱 — 輸入資料來源的名稱。您可以包含連字號，但不能包含空格。
2. (選擇性) 說明 — 輸入資料來源的選用說明。
3. 在預設語言中 — 選擇一種語言來篩選索引的文件。除非另有指定，否則語言預設為英文。文件中繼資料中指定的語言會覆寫選取的語言。
4. 在「標籤」中，針對「新增標籤」— 包含可選標籤以搜尋和篩選您的資源或追蹤您的資源 AWS 成本。
5. 選擇 Next (下一步)。
在 [定義存取權和安全性] 頁面上，輸入下列資訊：
1. 在「來源」中，選擇「匯流雲」或「匯流伺服器/資料中心」。
2. 匯合 URL — 輸入匯合主體。URL例如 https://example.confluence.com.
3. (僅適用於匯流伺服器/資料中心) SSL憑證位置-選用 — 輸入 Amazon S3 匯流伺服器SSL憑證檔案的路徑。
4. (僅適用於匯流伺服器/資料中心) Web Proxy-選用 — 輸入 Web Proxy 主機名稱 (不含http://或https://通訊協定) 和連接埠號碼 (主機傳輸通訊協定使用的連接埠)。URL連接埠號碼應該是介於 0 到 65535 之間的數值。
5. 授權 — 開啟或關閉文件的存取控制清單 (ACL) 資訊 (如果您有ACL並且想要將其用於存取控制)。ACL指定使用者和群組可存取的文件。此資ACL訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。
6. 驗證 — 選擇基本驗證、Oauth 2.0 驗證或 (僅適用於匯流伺服器/資料中心) 個人存取權杖驗證。
7. AWS Secrets Manager 秘密 — 選擇現有密碼或建立新密碼 Secrets Manager 秘密存儲您的匯流身份驗證憑據。如果您選擇建立新密碼 AWS Secrets Manager 秘密窗口打開。在視窗中輸入下列資訊：
  1. 秘密名稱 — 您秘密的名稱。前綴 'AmazonKendra-匯流-' 會自動添加到您的密碼名稱中。
  2. 如果使用基本驗證 — 輸入您在 Confluence 中配置的密碼名稱、使用者名稱和密碼 (匯流API權杖作為密碼)。
    
    如果使用 OAuth2.0 身份驗證 — 輸入您在 Confluence 中配置的密鑰名稱，應用程序密鑰，訪問令牌和刷新令牌。
    
    （僅限匯流服務器/數據中心）如果使用個人訪問令牌身份驗證 — 輸入您在匯流中配置的秘密名稱和匯流令牌。
  3. 保存並添加您的秘密。
8. 虛擬私人雲端 (VPC) — 您可以選擇使用VPC. 如果是這樣，您必須新增子網路和VPC安全性群組。
9. 識別爬行者程式 — 指定是否開啟 Amazon Kendra的身分識別搜尋器。身分識別爬行者程式會使用文件的存取控制清單 (ACL) 資訊，根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如果您有ACL適用於您的文檔並選擇使用您的ACL，那麼您也可以選擇打開 Amazon Kendra的識別爬行者程式，用來設定搜尋結果的使用者內容篩選。否則，如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別爬行者程式已關閉，您也可以使用PutPrincipalMappingAPI來上傳使用者和群組存取資訊以進行使用者前後關聯篩選。
10. IAM 角色 — 選擇現有的 IAM 角色或新建 IAM 角色來存取您的儲存庫認證和索引內容。
  
  注意
  IAM 用於索引的角色不能用於資料來源。如果您不確定索引是否使用現有角色FAQ，或選擇建立新角色以避免發生錯誤。
11. 選擇 Next (下一步)。
在 [設定同步設定] 頁面上，輸入下列資訊：
1. 在 [同步範圍] 中，針對 [同步內容] — 選擇從下列內容類型同步：頁面、頁面註解、頁面附件、部落格、部落格留言、部落格附件、個人空間和封存空間。
  
  注意
  只有在您選擇同步頁面時，才能選擇頁面注釋和頁面附件。只有在您選擇同步部落格時，才能選取部落格留言和部落格附件。
  
  重要
  如果您沒有在其他配置中指定空格鍵正則表達式模式，默認情況下將檢索所有頁面和博客。
2. 在其他配置中，對於最大文件大小-指定文件大小限制 MBs Amazon Kendra 會爬行。 Amazon Kendra 只會編目您定義的大小限制內的檔案。預設檔案大小為 50 MB。檔案大小上限應該大於 0 MB 且小於或等於 50 MB。
  
  對於空格正則表達式模式-指定是否使用以下命令在索引中包含或排除特定空格：
  - 空格鍵 (例如，my-space-123)
    
    注意
    如果您沒有指定空格鍵正則表達式模式，默認情況下將檢索所有頁面和博客。
  - URL（例如，.*/MySite/MyDocuments/)
  - 檔案類型 (例如，.*\.pdf, .*\.txt)
  對於實體標題正則表達式模式-指定規則運算式模式，以按標題包含或排除某些部落格、頁面、註解和附件。
  
  注意
  如果要包含或排除抓取特定頁面或子頁面，則可以使用頁面標題正則表達式模式。
3. 同步模式 — 選擇資料來源內容變更時要如何更新索引。當您將資料來源與 Amazon Kendra 依預設，系統會首次檢索所有內容並建立索引。如果初始同步失敗，您必須執行資料的完整同步，即使您沒有選擇完整同步作為同步模式選項。
  - 完全同步：新鮮索引所有內容，並在每次資料來源與索引同步時取代現有內容。
  - 新增、修改、刪除的同步：每次資料來源與索引同步時，僅對新內容、已修改和刪除的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更，並為上次同步後變更的內容建立索引。
4. 在同步執行排程中，對於頻率 — 選擇同步資料來源內容和更新索引的頻率。
5. 選擇 Next (下一步)。
在 [設定欄位對映] 頁面上，輸入下列資訊：
1. 從 Amazon Kendra 您想要對映至索引的產生預設資料來源欄位。若要新增自訂資料來源欄位，請建立要對映的索引欄位名稱和欄位資料類型。
2. 選擇 Next (下一步)。
在 [檢閱並建立] 頁面上，檢查您輸入的資訊是否正確，然後選取 [新增資料來源]。您也可以從此頁面選擇編輯您的資訊。成功新增資料來源後，您的資料來源將顯示在 [資料來源] 頁面上。

API

若要連線 Amazon Kendra 至匯合

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

資料來源 — 指定使用CONFLUENCEV2時的資料來源類型 TemplateConfigurationJSON結構描述。同時指定資料來源，就像您呼叫TEMPLATE時一樣 CreateDataSource API.
主體 URL — 指定合流主體例證。URL例如 https://example.confluence.com.
同步模式 — 指定方式 Amazon Kendra 應該在資料來源內容變更時更新索引。當您將資料來源與 Amazon Kendra 依預設，系統會首次檢索所有內容並建立索引。如果初始同步失敗，您必須執行資料的完整同步，即使您沒有選擇完整同步作為同步模式選項。您可以選擇：
- FORCED_FULL_CRAWL新建索引所有內容，並在每次資料來源與索引同步時取代現有內容。
- FULL_CRAWL，以在每次資料來源與索引同步時，僅對新的、修改的和刪除的內容建立索引。 Amazon Kendra 可以使用資料來源的機制來追蹤內容變更，並為上次同步後變更的內容建立索引。
驗證類型 — 指定驗證類型，是否為 BasicOAuth2, (僅限「合流伺服器」)。Personal-token
(選用性 — 僅適用於 Confluence 伺服器) SSL憑證位置 — 指定您用來儲存憑證的S3bucketName和s3certificateName。SSL
秘密 Amazon 資源名稱（ARN）-提供 Amazon 資源名稱（ARN） Secrets Manager 包含您在匯流中配置的身份驗證憑據的秘密。如果您使用基本驗證，密碼會儲存在具有下列金鑰的JSON結構中：
```
{
    "username": "email ID or user name",
    "password": "Confluence API token"
}
```
如果您使用 OAuth 2.0 驗證，密碼會儲存在具有下列金鑰的JSON結構中：
```
{
    "confluenceAppKey": "app key",
    "confluenceAppSecret": "app secret",
    "confluenceAccessToken": "access token",
    "confluenceRefreshToken": "refresh token"
}
```
(僅適用於 Confluence 伺服器) 如果您使用基本驗證，密碼會儲存在具有下列金鑰的JSON結構中：
```
{
    "hostUrl": "Confluence Server host URL",
    "username": "Confluence Server user name",
    "password": "Confluence Server password"
}
```
(僅適用於 Confluence 伺服器) 如果您使用「個人存取權杖」驗證，密碼會儲存在具有下列金鑰的JSON結構中：
```
{
    "hostUrl": "Confluence Server host URL",
    "patToken": "personal access token"
}
```
IAM role — 指定您RoleArn何時打電話CreateDataSource提供 IAM 具有存取您的權限的角色 Secrets Manager 秘密和調用所需的公眾APIs匯流連接器和 Amazon Kendra如需詳細資訊，請參閱。IAM 匯流資料來源的角色。

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

虛擬私人雲端 (VPC) — 指定您撥打電話CreateDataSource的VpcConfiguration時間。如需詳細資訊，請參閱設定 Amazon Kendra 若要使用 Amazon VPC。
檔案大小 — 指定要編目的最大檔案大小。
文件/內容類型 — 指定是否要編目頁面、頁面註解、頁面附件、部落格、部落格註解、部落格附件、空間和封存空間。
包含和排除篩選器：指定是否要包含或排除特定空間、頁面、部落格及其註解和附件。

注意
大多數資料來源使用規則運算式模式，這些模式是稱為篩選器的包含或排除模式。如果您指定包含篩選器，則只有符合包含項目篩選器的內容會編製索引。不符合包含篩選器的任何文件都不會建立索引。如果您指定包含和排除篩選器，符合排除篩選器的文件將不會建立索引，即使它們符合包含篩選器也是如此。
網頁代理伺服器 — 如果您想要透過網路代理連線至您的 Confluence URL 執行個體，請指定您的 Web 代理伺服器資訊。您可以將此選項用於匯流伺服器。
存取控制清單 (ACL) — 指定是否要編目文件的ACL資訊 (如果您有ACL並且想要將其用於存取控制)。ACL指定使用者和群組可存取的文件。此資ACL訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。
識別爬行者程式 — 指定是否開啟 Amazon Kendra的身分識別搜尋器。身分識別爬行者程式會使用文件的存取控制清單 (ACL) 資訊，根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如果您有ACL適用於您的文檔並選擇使用您的ACL，那麼您也可以選擇打開 Amazon Kendra的識別爬行者程式，用來設定搜尋結果的使用者內容篩選。否則，如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別爬行者程式已關閉，您也可以使用PutPrincipalMappingAPI來上傳使用者和群組存取資訊以進行使用者前後關聯篩選。
欄位對映 — 選擇將您的匯流資料來源欄位對映至 Amazon Kendra 索引欄位。如需詳細資訊，請參閱映射資料來源欄位。

注意
您的文檔的文檔正文字段或文檔正文等效是必需的，以便 Amazon Kendra 以搜尋您的文件。您必須將資料來源中的文件內文欄位名稱對應至索引欄位名稱_document_body。所有其他欄位是選用的。

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

備註

個人訪問令牌（PAT）不適用於匯流雲。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

匯流連接器 V1.0

自訂資料來源連接器

匯流連接器 V2.0

主題

支援的功能

必要條件

注意

注意

注意

注意

注意

連接說明

注意

注意

注意

重要

注意

注意

注意

注意

備註