View a markdown version of this page

ServiceNow 连接器 V1.0 - Amazon Kendra

Amazon Kendra 不再向新客户开放。要了解与类似的功能 Amazon Kendra,请浏览亚马逊基岩知识库。了解更多。

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ServiceNow 连接器 V1.0

ServiceNow 提供基于云的服务管理系统,用于创建和管理组织级工作流程,例如 IT 服务、票务系统和支持。您可以使用索 Amazon Kendra 引您的 ServiceNow 目录、知识文章及其附件。

注意

ServiceNow 连接器 V1.0 / ServiceNowConfiguration API 于 2023 年结束。我们建议迁移到或使用 ServiceNow 连接器 V2.0 / TemplateConfiguration API。

要对 Amazon Kendra ServiceNow 数据源连接器进行故障排除,请参阅数据来源故障排除。

支持的功能

Amazon Kendra ServiceNow 数据源连接器支持以下功能:

  • ServiceNow 实例版本:伦敦、其他

  • Inclusion/exclusion 模式:服务目录、知识文章及其附件

先决条件

在使用 Amazon Kendra 为 ServiceNow 数据源编制索引之前,请在您的 ServiceNow 和 AWS 账户中进行这些更改。

在 ServiceNow,请确保你有:

  • 创建了 ServiceNow 管理员账户并创建了一个 ServiceNow实例。

  • 复制了您的 ServiceNow 实例 URL 的主机。例如,如果实例的 URL 为https://your-domain.service-now.com,则您输入的主机 URL 的格式为your-domain.service-now.com。

  • 注意到您的基本身份验证凭证包含允许 Amazon Kendra 连接到您的 ServiceNow 实例的用户名和密码。

    注意

    我们建议您定期刷新或轮换您的凭证和密码。为了安全起见,请仅提供必要的访问权限级别。我们建议不要跨数据来源以及连接器版本 1.0 和 2.0(如果适用)重复使用凭证和密钥。

  • 可选:配置了 OAuth 2.0 凭据令牌,该令牌可以识别 Amazon Kendra 和生成用户名、密码、客户端 ID 和客户端密钥。用户名和密码必须提供对 ServiceNow 知识库和服务目录的访问权限。有关更多信息,请参阅ServiceNow 有关 OAuth 2.0 身份验证的文档。

  • 添加了以下权限:

    • kb_category

    • kb_knowledge

    • 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 以及在其他数据源中都是唯一的。您要用于编制索引的每个数据来源在所有数据来源中都不能包含相同的文档。文档 ID 对索引来说是全局性的,并且每个索引都必须是唯一的。

在您的中 AWS 账户,请确保您有:

  • 创建了 Amazon Kendra 索引,如果使用 API,则记下索引 ID。

  • https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds为您的数据源创建了一个 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 连接器 V1.0,然后选择添加数据来源。

  5. 在指定数据来源详细信息页面上输入以下信息:

    1. 在名称和描述中,在数据来源名称中输入您的数据来源的名称。可以包含连字符,但不能包含空格。

    2. (可选)描述:输入数据来源的描述信息。

    3. 在默认语言中,选择用于筛选文档以编制索引的语言。除非另行指定,否则语言默认为英语。在文档元数据中指定的语言会覆盖所选语言。

    4. 在标签中,添加新标签 —包括可选标签以搜索和筛选您的资源或跟踪 AWS 成本。

    5. 选择下一步。

  6. 在定义访问权限和安全性页面上,请输入以下信息:

    1. ServiceNow 主机 —输入 ServiceNow主机 URL。

    2. ServiceNow 版本 —选择您的 ServiceNow 版本。

    3. 根据您的使用案例,选择基本身份验证或 Oauth 2.0 身份验证。

    4. AWS Secrets Manager 密钥 —选择现有密钥或创建新 Secrets Manager 密钥来存储您的 ServiceNow 身份验证凭证。如果您选择创建新密钥,则会打开 AWS Secrets Manager 密钥窗口。

      1. 密钥名称 - 密钥的名称。前缀 “AmazonKendra-ServiceNow-” 会自动添加到您的密钥名称中。

      2. 如果使用基本身份验证-输入您账户的密钥名称、用户名和密码。 ServiceNow

        如果使用 OAuth2 身份验证-输入您在账户中创建的密钥名称、用户名、密码、客户端 ID 和客户端密钥。 ServiceNow

      3. 选择保存和添加密钥。

    5. IAM 角色 —选择现有 IAM 角色或创建新 IAM 角色来访问您的存储库凭据和索引内容。

      注意

      IAM 用于索引的角色不能用于数据源。如果您不确定是否将现有角色用于编制索引或常见问题解答,为了避免出错,请选择创建新角色。

    6. 选择下一步。

  7. 在配置同步设置页面上,请输入以下信息:

    1. 包含知识文章 - 选择为知识文章编制索引。

    2. 知识文章的类型 —在 “仅包括公开文章” 和 “根据您的用例 ServiceNow 筛选查询包含文章” 之间进行选择。如果您选择 “包括基于 ServiceNow 筛选器查询的文章”,则必须输入从您的 ServiceNow账户复制的筛选查询。

    3. 包含知识文章附件 - 选择为知识文章附件编制索引。您也可以选择要编制索引的特定文件类型。

    4. 包含目录项 - 选择为目录项编制索引。

    5. 包含目录项附件 - 选择为目录项附件编制索引。您也可以选择要编制索引的特定文件类型。

    6. 频率 —与数据源同步的频率。 Amazon Kendra

    7. 选择下一步。

  8. 在设置字段映射页面上,请输入以下信息:

    1. 知识文章和服务目录 -从 Amazon Kendra 生成的默认数据源字段以及要映射到索引的其他建议字段映射中进行选择。

    2. 添加字段 - 添加自定义数据来源字段以创建要映射到的索引字段名称和字段数据类型。

    3. 选择下一步。

  9. 在查看和创建页面上,请检查输入的信息是否正确,然后选择添加数据来源。您也可以选择在此页面上编辑信息。成功添加数据来源后,您的数据来源将显示在数据来源页面上。

API

连接 Amazon Kendra 到 ServiceNow

必须使用 ServiceNowConfiguration API 指定以下内容:

  • 数据源 URL -指定 ServiceNow URL。主机端点应如下所示:your-domain.service-now.com.

  • 数据源主机实例 -将 ServiceNow 主机实例版本指定为LONDON或OTHERS。

  • 亚马逊机密资源名称 (ARN) — 提供包含您在账户中创建的身份验证凭证的 Secrets Manager 密钥的亚马逊资源名称 (ARN)。 ServiceNow

    如果您使用基本身份验证,密钥将存储在 JSON 结构中,其中包含以下键:

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

    如果您使用 OAuth2 身份验证,密钥将存储在 JSON 结构中,其中包含以下键:

    { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
  • IAM 角色 —指定RoleArn何时调用CreateDataSource以向 IAM 角色提供访问您的 Secrets Manager 密钥的权限,以及调用 ServiceNow 连接器和 Amazon Kendra所需的公共 API 的权限。有关更多信息,请参阅 ServiceNow S3 数据来源的IAM 角色。

您还可以添加以下可选功能:

  • 字段映射 - 选择将 ServiceNow 数据来源字段映射到 Amazon Kendra 索引字段。有关更多信息,请参阅映射数据来源字段。

    注意

    要搜索您的文档,必须填写文档正文字段或与文档正文 Amazon Kendra 对应的字段。您必须将数据来源中的文档正文字段名映射到索引字段名称 _document_body。其他所有字段均为可选字段。

  • 包含和排除筛选条件 - 指定是包含还是排除某些类别和知识文章的附件。

    注意

    大多数数据来源使用正则表达式模式,即称为筛选条件的包含或排除模式。如果您指定包含筛选条件,则只会为与包含筛选条件匹配的内容编制索引。不会为任何与包含筛选条件不匹配的文档编制索引。如果您指定包含和排除筛选条件,则不会为与排除筛选条件匹配的文档编制索引,即使它们与包含筛选条件相匹配。

  • 索引参数 - 您也可以选择指定是否:

    • 为知识文章或服务目录编制索引,或者为两者同时编制索引。如果您选择为知识文章和服务目录项目编制索引,则必须提供映射到索引中索引文档内容字段的字段的 Amazon Kendra 名称。 ServiceNow

    • 为知识文章和目录项的附件编制索引。

    • 使用从一个或多个知识库中选择文档的 ServiceNow 查询。知识库可以是公有的,也可以是私有的。有关更多信息,请参阅使用查询指定要编制索引的文档。

了解详情

要了解有关 Amazon Kendra 与 ServiceNow 数据源集成的更多信息,请参阅: