ServiceNow 連接器 V2.0 - Amazon Kendra

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

ServiceNow 連接器 V2.0

ServiceNow 提供雲端型服務管理系統,可建立和管理組織層級工作流程,例如 IT 服務、票務系統及支援。您可以使用 Amazon Kendra為 ServiceNow 目錄、知識文章、事件及其附件編製索引。

如需疑難排解您的Amazon KendraServiceNow 資料來源連接器,請參閱 對資料來源進行故障診斷

支援的功能

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

  • 欄位對應

  • 使用者存取控制

  • 包含/排除篩選條件

  • 完整和增量內容同步

  • ServiceNow 執行個體版本:羅馬、桑迪哥、東京、其他

  • 虛擬私有雲端 (VPC)

先決條件

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

在 ServiceNow 中,請確定您已:

  • 建立個人或企業開發人員執行個體,並具有具有管理角色的 ServiceNow 執行個體。

  • 已複製 ServiceNow 執行個體 URL 的主機。輸入的主機 URL 格式須為 your-domain.service-now.com。您需要 ServiceNow 執行個體 URL 才能連線Amazon Kendra。

  • 記下使用者名稱和密碼的基本身分驗證憑證,Amazon Kendra以允許 連線至您的 ServiceNow 執行個體。

    注意

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

  • 選用:已設定的 OAuth 2.0 用戶端登入資料,可使用Amazon Kendra使用者名稱、密碼和產生的用戶端 ID,以及用戶端秘密來識別 。如需詳細資訊,請參閱 OAuth 2.0 身分驗證的 ServiceNow 文件。

  • 新增下列許可:

    • kb_category

    • kb_ 知識

    • kb_knowledge_base

    • kb_uc_cannot_read_mtom

    • kb_uc_can_read_mtom

    • sc_catalog

    • sc_category

    • sc_cat_item

    • sys_attachment

    • sys_attachment_doc

    • sys_user_role

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

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

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

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

    注意

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

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

    注意

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

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

連線指示

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

Console

Amazon Kendra連線至 ServiceNow

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

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

    注意

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

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

  4. 新增資料來源頁面上,選擇 ServiceNow 連接器,然後選擇新增連接器。如果使用版本 2 (如適用),請選擇具有 "V2.0" 標籤的 ServiceNow 連接器

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

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

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

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

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

    5. 選擇下一步

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

    1. ServiceNow 主機 — 輸入 ServiceNow 主機 URL。輸入的主機 URL 格式須為 your-domain.service-now.com

    2. ServiceNow 版本 - 選取您的 ServiceNow 執行個體版本。您可以從羅馬、桑迪哥、東京或其他 中進行選擇。

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

    4. Authentication - 在基本身分驗證Oauth 2.0 身分驗證之間進行選擇。

    5. AWS Secrets Managersecret - 選擇現有的秘密或建立新的Secrets Manager秘密,以存放您的 ServiceNow 身分驗證憑證。如果您選擇建立新的秘密,則會AWS開啟Secrets Manager秘密視窗。在視窗中輸入以下資訊:

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

      2. 如果使用基本身分驗證 - 輸入 ServiceNow 帳戶的秘密名稱使用者名稱和密碼

        如果使用 OAuth2.0 身分驗證 - 輸入您在 ServiceNow 帳戶中建立的秘密名稱使用者名稱密碼用戶端 ID用戶端秘密

      3. 儲存並新增您的秘密。

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

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

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

      注意

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

    9. 選擇下一步

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

    1. 知識文章中,從下列選項擇一使用:

      • 知識文章 - 選擇為知識文章編製索引。

      • 知識文章附件 — 選擇為知識文章附件編製索引。

      • 知識文章的類型 - 根據您的使用案例,在僅限公有文章根據 ServiceNow 篩選查詢的知識文章之間進行選擇。如果您根據 ServiceNow 篩選條件查詢選取包含文章,則必須輸入從 ServiceNow 帳戶複製的篩選條件查詢。範例篩選條件查詢包括:工作流程_state=draft^EQkb_knowledge_base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQarticle_type=text^active=true^EQ

        重要

        如果您選擇僅編目公有文章,則只會Amazon Kendra編目在 ServiceNow 中指派公有存取角色的知識文章。

      • 包含以簡短描述篩選條件為基礎的文章 - 指定要包含或排除特定文章的規則表達式模式。

    2. 對於服務目錄項目

      • 服務目錄項目 - 選擇為服務目錄項目編製索引。

      • 服務目錄項目附件 - 選擇為服務目錄項目附件編製索引。

      • 作用中服務目錄項目 - 選擇為作用中服務目錄項目編製索引。

      • 非作用中服務目錄項目 - 選擇為非作用中服務目錄項目編製索引。

      • 篩選條件查詢 - 根據 ServiceNow 執行個體中定義的篩選條件,選擇包含服務目錄項目。範例篩選條件查詢包括:short_descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQnameSTARTSWITHService^active=true^EQ

      • 根據簡短描述篩選條件包含服務目錄項目 - 指定 regex 模式以包含特定目錄項目。

    3. 對於事件

      • Incidents - 選擇為服務事件編製索引。

      • 事件附件 — 選擇為事件附件編製索引。

      • 作用中事件 - 選擇為作用中事件編製索引。

      • 非作用中事件 - 選擇為非作用中事件編製索引。

      • 作用中事件類型 - 根據您的使用案例,在所有事件開啟事件開啟 - 未指派的事件已解決的事件之間進行選擇。

      • 篩選條件查詢 - 根據 ServiceNow 執行個體中定義的篩選條件,選擇包含事件。範例篩選條件查詢包括:short_descriptionLIKETest^urgency=3^state=1^EQpriority=2^category=software^EQ。

      • 根據簡短描述篩選條件包含事件 - 指定 regex 模式以包含特定事件。

    4. 對於其他組態

      • ACL 資訊 — 預設會包含您所選實體的存取控制清單。取消選取存取控制清單會將該類別中的所有檔案設為公有。未選取的實體會自動停用 ACL 選項。對於公有文章,不會套用 ACL。

      • 針對檔案大小上限 – 指定 Amazon Kendra 將爬取的檔案大小限制,以 MBs 為單位。Amazon Kendra 只會在您定義的大小限制內抓取檔案。預設檔案大小為 50MB。檔案大小上限應大於 0MB,且小於或等於 50MB。

      • 連接規則運算式模式 — 新增規則表達式模式,以包含或排除目錄、知識文章和事件的特定連接檔案。最多可新增 100 個模式。

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

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

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

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

    7. 選擇下一步

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

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

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

    3. 選擇下一步

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

API

Amazon Kendra連線至 ServiceNow

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

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

  • 主機 URL - 指定 ServiceNow 主機執行個體版本。例如:your-domain.service-now.com

  • 身分驗證類型 - 指定您使用的身分驗證類型,無論是 ServiceNow 執行個體OAuth2basicAuth還是 。

  • ServiceNow 執行個體版本 - 指定您使用的 ServiceNow 執行個體,無論是 TokyoRomeSandiegoOthers

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

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

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

  • Secret Amazon Resource Name (ARN)—提供Secrets Manager秘密的 Amazon Resource Name (ARN),其中包含您在 ServiceNow 帳戶中建立的身分驗證憑證。

    如果您使用基本身分驗證,秘密會存放在具有下列金鑰的 JSON 結構中:

    { "username": "user name", "password": "password" }
  • 如果您使用 OAuth2 用戶端登入資料,秘密會存放在具有下列金鑰的 JSON 結構中:

    { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
  • IAMrole—指定RoleArn您何時呼叫 CreateDataSource 以提供IAM角色存取Secrets Manager秘密的許可,以及呼叫 ServiceNow 連接器所需的公有 APIs 和 Amazon Kendra。如需詳細資訊,請參閱 IAM ServiceNow 資料來源的角色

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

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

  • 包含和排除篩選條件 - 您可以使用檔案名稱和知識文章、服務目錄和事件的檔案類型來指定是否包含或排除特定附加檔案。

    注意

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

  • 要編製索引的特定文件 - 您可以使用 ServiceNow 查詢,從一或多個知識庫指定您想要的文件,包括私有知識庫。知識庫的存取由您用來連線至 ServiceNow 執行個體的使用者決定。如需詳細資訊,請參閱使用查詢指定要索引的文件

  • 索引參數 - 您也可以選擇指定是否:

    • 為知識文章、服務目錄和事件或所有這些項目編製索引。如果您選擇為知識文章、服務目錄項目和事件編製索引,則必須提供映射至Amazon Kendra索引中索引文件內容欄位的 ServiceNow 欄位名稱。

    • 將附件索引至知識文章、服務目錄項目和事件。

    • 根據short description篩選條件模式包含知識文章、服務目錄項目和事件。

    • 選擇 以篩選作用中和非作用中的服務目錄項目和事件。

    • 選擇根據事件類型篩選事件。

    • 選擇哪些實體應該編目其 ACL。

    • 您可以使用 ServiceNow 查詢,從一或多個知識庫指定您想要的文件,包括私有知識庫。知識庫的存取由您用來連線至 ServiceNow 執行個體的使用者決定。如需詳細資訊,請參閱使用查詢指定要索引的文件

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

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

    注意

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

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

進一步了解

若要進一步了解Amazon Kendra如何與您的 ServiceNow 資料來源整合,請參閱: