ServiceNow 连接器 V2.0 - Amazon Kendra

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

ServiceNow 连接器 V2.0

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

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

支持的特征

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

  • 字段映射

  • 用户访问控制

  • 包含/排除筛选条件

  • 完整内容和增量内容同步

  • 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 客户端凭证,这些凭据可以使用用户名、密码和生成的客户端 ID 以及客户端密钥进行识别 Amazon Kendra 。有关更多信息,请参阅有关 OAuth 2.0 身份验证的ServiceNow 文档

  • 已选中每个文档在您计划用于同一索引的其他数据源中 ServiceNow 以及其他数据源中都是唯一的。您要用于编制索引的每个数据来源在所有数据来源中都不能包含相同的文档。文档对索引来说IDs是全局的,并且每个索引必须是唯一的。

在你的 AWS 账户,请确保你有:

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

  • 为您的数据源@@ 创建了一个 IAM 角色,如果使用,请API记下该角色ARN的 IAM 角色。

    注意

    如果您更改了身份验证类型和证书,则必须更新您的 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 密钥以及索引 ID。ARN

连接说明

要 Amazon Kendra 连接到您的 ServiceNow 数据源,您必须提供 ServiceNow 数据源的必要详细信息,以便 Amazon Kendra 能够访问您的数据。如果您尚未进行配置, ServiceNow 请参 Amazon Kendra 阅先决条件

Console

要连接 Amazon Kendra 到 ServiceNow

  1. 登录 AWS Management Console 并打开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. 身份验证-在基本身份验证和 Oauth 2.0 身份验证之间进行选择。

    5. AWS Secrets Manager s@@ ecret —选择现有密钥或创建新 Secrets Manager 密钥来存储您的 ServiceNow 身份验证凭证。如果您选择创建新密钥,则会打开 AWS Secrets Manager 密钥窗口。在窗口中输入以下信息:

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

      2. 如果使用基本身份验证,请输入您帐户的密码名称用户名密码。 ServiceNow

        如果使用 OAuth2 .0 Authentication,请输入您在账户中创建的密钥名称用户名密码、客户端 ID客户端密钥。 ServiceNow

      3. 保存并添加您的密钥。

    6. 虚拟私有云 (VPC)-您可以选择使用. VPC 如果是,则必须添加子网VPC安全组

    7. I Amazon Kendra dent@@ ity Crawler-指定是否开启身份搜寻器。Identity Crawler 使用文档的访问控制列表 (ACL) 信息,根据用户或其群组对文档的访问权限筛选搜索结果。如果你的文档有ACL并选择使用你的ACL,那么你也可以选择开启身份搜寻器来配置搜索结果 Amazon Kendra的用户上下文筛选。否则,如果身份搜寻器已关闭,则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭,则也可以使用上传用户和群组访问信息PutPrincipalMappingAPI以进行用户上下文筛选。

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

      注意

      IAM 用于索引的角色不能用于数据源。如果您不确定是将现有角色用于索引还是FAQ,请选择创建新角色以避免出错。

    9. 选择下一步

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

    1. 对于知识文章,请选择以下选项:

      • 知识文章 - 选择为知识文章编制索引。

      • 知识文章附件 - 选择为知识文章附件编制索引。

      • 知识文章的类型-根据您的用例,根据 ServiceNow 筛选查询,在 “仅限公开文章” 和 “知识文章” 之间进行选择。如果您选择 “包含基于 ServiceNow 筛选查询的文章”,则必须输入从您的 ServiceNow账户中复制的筛选查询。过滤器查询示例包括:workflow_state=draft^EQ, kb_knowledge_base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQ, article_type=text^active=true^EQ.

        重要

        如果您选择 “仅抓取公开文章”,则仅 Amazon Kendra 抓取中分配了公共访问角色的知识文章。 ServiceNow

      • 基于简短描述筛选条件包含文章 - 指定正则表达式模式以包含或排除特定文章。

    2. 对于服务目录项

      • 服务目录项 - 选择为目录项编制索引。

      • 服务目录项附件 - 选择为服务目录项附件编制索引。

      • 活动服务目录项 - 选择为活动目录项编制索引。

      • 非活动服务目录项 - 选择为非活动目录项编制索引。

      • 筛选查询-根据您的 ServiceNow 实例中定义的筛选器选择包含服务目录项目。过滤器查询示例包括:short_descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQ, nameSTARTSWITHService^active=true^EQ.

      • 根据简短描述筛选条件包含服务目录项 - 指定正则表达式模式以包括特定的目录项。

    3. 对于事件

      • 事件 - 选择为服务事件编制索引。

      • 事件附件 - 选择为事件附件编制索引。

      • 活动事件 - 选择为活动事件编制索引。

      • 非活动事件 - 选择为非活动事件编制索引。

      • 活动事件类型 -根据您的使用案例,选择所有事件未解决的事件未解决 - 未分配的事件已解决的事件

      • 筛选查询-根据您的 ServiceNow 实例中定义的筛选器选择包含事件。过滤器查询示例包括:short_descriptionLIKETest^urgency=3^state=1^EQ, priority=2^category=software^EQ .

      • 根据简短描述筛选条件包含事件 - 指定包含特定事件的正则表达式模式。

    4. 对于其他配置

      • ACL信息 —默认情况下,包含所选实体的访问控制列表。取消选择访问控制列表将公开该类别中的所有文件。ACL对于未选择的实体,选项会自动停用。对于公开文章ACL不适用。

      • 对于最大文件大小 — 指定 Amazon Kendra 将抓取的文件大小限制。MBsAmazon Kendra 只会抓取您定义的大小限制范围内的文件。默认文件大小为 50MB。最大文件大小应大于 0MB 且小于或等于 50MB。

      • 附件正则表达式模式 - 添加正则表达式模式以包含或排除目录、知识文章和事件的某些附加文件。最多可以添加 100 个模式。

    5. 同步模式 - 选择在数据来源内容发生变化时更新索引的方式。首次与同步数据源时, Amazon Kendra 默认情况下会对所有内容进行抓取和索引。如果初始同步失败,即使您没有选择完全同步作为同步模式选项,也必须对数据进行完全同步。

      • 完全同步:对所有内容进行新索引,每次数据源与索引同步时都会替换现有内容。

      • 新增、已修改、已删除的同步:每次数据源与索引同步时,仅索引新内容、修改内容和已删除内容。 Amazon Kendra 可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。

    6. 在 “同步” 运行计划中,“频率”-选择同步数据源内容和更新索引的频率。

    7. 选择下一步

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

    1. 默认字段映射-从 Amazon Kendra 生成的默认数据源字段中选择要映射到索引的字段。

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

    3. 选择下一步

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

API

要连接 Amazon Kendra 到 ServiceNow

必须使用指定JSON数据源架构TemplateConfigurationAPI。您必须提供以下信息:

  • 数据源-将数据源类型指定为使用SERVICENOWV2时的类型 TemplateConfigurationJSON架构。还要指定数据源,就像调用TEMPLATE时一样 CreateDataSource API.

  • 主机 URL-指定 ServiceNow 主机实例版本。例如,your-domain.service-now.com.

  • 身份验证类型-指定您使用的身份验证类型,无论是OAuth2针对您的 ServiceNow实例basicAuth还是针对您的实例。

  • ServiceNow 实例版本-指定您使用的 ServiceNow 实例,是TokyoSandiegoRome、或Others

  • 同步模式-指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。首次与同步数据源时, Amazon Kendra 默认情况下会对所有内容进行抓取和索引。如果初始同步失败,即使您没有选择完全同步作为同步模式选项,也必须对数据进行完全同步。您可以选择:

    • FORCED_FULL_CRAWL对所有内容进行全新索引,每次数据源与索引同步时都要替换现有内容。

    • FULL_CRAWL每次数据源与索引同步时,仅对新的、修改过的和已删除的内容编制索引。 Amazon Kendra 可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。

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

    如果您使用基本身份验证,则密钥存储在具有以下密钥的JSON结构中:

    { "username": "user name", "password": "password" }
  • 如果您使用OAuth2客户端凭证,则密钥存储在包含以下密钥的JSON结构中:

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

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

  • 虚拟私有云 (VPC)-指定VpcConfiguration何时致电CreateDataSource。有关更多信息,请参阅 配置 Amazon Kendra 为使用 Amazon VPC

  • 包含和排除筛选条件 - 您可以使用知识文章、服务目录和事件的文件名和文件类型来指定是包含还是排除某些附件。

    注意

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

  • 要索引的特定文档-您可以使用 ServiceNow查询从一个或多个知识库(包括私有知识库)中指定所需的文档。对知识库的访问权限由您用来连接 ServiceNow 实例的用户决定。有关更多信息,请参阅使用查询指定要编制索引的文档

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

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

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

    • 根据 short description 筛选模式包含知识文章、服务目录项目和事件。

    • 选择筛选活动和非活动服务目录项目和事件。

    • 选择根据事件类型筛选事件。

    • 选择应该ACL抓取哪些实体。

    • 您可以使用 ServiceNow 查询从一个或多个知识库(包括私有知识库)中指定所需的文档。对知识库的访问权限由您用来连接 ServiceNow实例的用户决定。有关更多信息,请参阅使用查询指定要编制索引的文档

  • I Amazon Kendra dent@@ ity Crawler-指定是否开启身份搜寻器。Identity Crawler 使用文档的访问控制列表 (ACL) 信息,根据用户或其群组对文档的访问权限筛选搜索结果。如果你的文档有ACL并选择使用你的ACL,那么你也可以选择开启身份搜寻器来配置搜索结果 Amazon Kendra的用户上下文筛选。否则,如果身份搜寻器已关闭,则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭,则也可以使用上传用户和群组访问信息PutPrincipalMappingAPI以进行用户上下文筛选。

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

    注意

    要搜索您的文档,必须输入文档正文字段或文档正文等效字段。 Amazon Kendra 您必须将数据源中的文档正文字段名称映射到索引字段名称_document_body。其他所有字段均为可选字段。

有关要配置的其他重要JSON密钥的列表,请参阅ServiceNow 模板架构

了解更多

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