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 客户端凭证，这些凭据可以使用用户名、密码和生成的客户端 ID 以及客户端密钥进行识别Amazon Kendra。有关更多信息，请参阅有关 OAuth 2.0 身份验证的ServiceNow 文档。
添加了以下权限：
- 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 以及其他数据源中都是唯一的。您要用于编制索引的每个数据来源在所有数据来源中都不能包含相同的文档。文档对索引来说 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密钥的 ARN 以及索引 ID。

连接说明

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

Console

要连接Amazon Kendra到 ServiceNow

登录AWS 管理控制台并打开Amazon Kendra控制台。
在左侧导航窗格中，选择索引，然后从索引列表中选择要使用的索引。

注意
您可以选择在索引设置下配置或编辑您的用户访问控制设置。
在开始使用页面上，选择添加数据来源。
在添加数据来源页面上，选择 ServiceNow 连接器，然后选择添加连接器。如果使用版本 2（如果适用），请选择带有“V2.0”标签的 ServiceNow 连接器。
在指定数据来源详细信息页面上，输入以下信息：
1. 在名称和描述中，在数据来源名称中输入您的数据来源的名称。可以包含连字符，但不能包含空格。
2. （可选）描述：输入数据来源的描述信息。
3. 在默认语言中，选择用于筛选文档以编制索引的语言。除非另行指定，否则语言默认为英语。在文档元数据中指定的语言会覆盖所选语言。
4. 在标签中，用于添加新标签-包括可选标签以搜索和筛选您的资源或跟踪您的AWS成本。
5. 选择下一步。
在定义访问权限和安全性页面上，请输入以下信息：
1. ServiceNow 主机 —输入 ServiceNow主机 URL。您输入的主机 URL 的格式为your-domain.service-now.com。
2. ServiceNow 版本-选择您的 ServiceNow 实例版本。您可以选择“罗马”、“圣地亚哥”、“东京”或“其他”。
3. 授权 - 如果您有访问控制列表（ACL）并想将其用于访问控制，请选择是开启还是关闭文档的 ACL 信息。ACL 用于指定用户和组可以访问哪些文档。ACL 信息用于根据用户或其所在组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。
4. 身份验证 – 选择基本身份验证或 OAuth 2.0 身份验证。
5. AWSSecrets Managers@@ ecret —选择现有密钥或创建新Secrets Manager密钥来存储您的 ServiceNow 身份验证凭证。如果您选择创建新密钥，则会打开 AWS Secrets Manager 密钥窗口。在窗口中输入以下信息：
  1. 密钥名称 - 密钥的名称。前缀 “AmazonKendra-ServiceNow-” 会自动添加到您的密钥名称中。
  2. 如果使用基本身份验证，请输入您帐户的密码名称、用户名和密码。 ServiceNow
    
    如果使用 OAuth2 .0 Authentication，请输入您在账户中创建的密钥名称、用户名、密码、客户端 ID 和客户端密钥。 ServiceNow
  3. 保存并添加您的密钥。
6. 虚拟私有云（VPC）- 您可以选择使用 VPC。如果是这样，则必须添加子网和 VPC 安全组。
7. 身份爬网程序 – 指定是否激活 Amazon Kendra 的身份爬网程序。身份爬网程序使用文档的访问控制列表（ACL）信息，来根据用户或用户组对文档的访问权限筛选搜索结果。如果您的文档有 ACL 并选择使用您的 ACL，则也可以选择开启身份爬网程序来配置搜索结果Amazon Kendra的用户上下文筛选。否则，如果关闭身份爬网程序，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMappingAPI 上传用户和群组访问信息以进行用户上下文筛选。
8. IAMro le —选择现有IAM角色或创建新IAM角色来访问您的存储库凭据和索引内容。
  
  注意
  IAM用于索引的角色不能用于数据源。如果您不确定是否将现有角色用于编制索引或常见问题解答，为了避免出错，请选择创建新角色。
9. 选择下一步。
在配置同步设置页面上，请输入以下信息：
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 将抓取的文件大小限制。 MBs Amazon Kendra 将仅爬取您定义的大小限制范围内的文件。默认文件大小为 50 MB。最大文件大小应大于 0 MB 且小于或等于 50 MB。
  - 附件正则表达式模式 - 添加正则表达式模式以包含或排除目录、知识文章和事件的某些附加文件。最多可以添加 100 个模式。
5. 同步模式 – 选择在数据来源内容发生变化时更新索引的方式。首次将数据来源与 Amazon Kendra 同步时，默认情况下会爬取所有内容并编制索引。如果首次同步失败，即使您没有选择“完整同步”作为同步模式，也必须执行一次完整的数据同步。
  - 完整同步：每次数据来源与索引同步时，重新为所有内容编制索引，并替换已有内容。
  - 新增、已修改、已删除的同步：每次数据源与索引同步时，仅索引新内容、修改内容和已删除内容。 Amazon Kendra可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。
6. 在同步运行计划的频率中 – 选择同步数据来源内容并更新索引的频率。
7. 选择下一步。
在设置字段映射页面上，请输入以下信息：
1. 默认字段映射-从Amazon Kendra生成的默认数据源字段中选择要映射到索引的字段。
2. 添加字段 - 添加自定义数据来源字段以创建要映射到的索引字段名称和字段数据类型。
3. 选择下一步。
在查看和创建页面上，请检查输入的信息是否正确，然后选择添加数据来源。您也可以选择在此页面上编辑信息。成功添加数据来源后，您的数据来源将显示在数据来源页面上。

API

要连接Amazon Kendra到 ServiceNow

您必须使用 TemplateConfiguration API 指定数据来源架构的 JSON。您必须提供以下信息：

数据来源 – 当使用 TemplateConfiguration JSON 架构时，将数据来源类型指定为 SERVICENOWV2。当调用 CreateDataSource API 时，还要将数据来源指定为 TEMPLATE。
主机 URL-指定 ServiceNow 主机实例版本。例如 your-domain.service-now.com。
身份验证类型-指定您使用的身份验证类型，无论是OAuth2针对您的 ServiceNow 实例basicAuth还是针对您的实例。
ServiceNow 实例版本-指定您使用的 ServiceNow 实例，是Tokyo、SandiegoRome、或Others。
同步模式 – 指定当数据来源内容发生变化时 Amazon Kendra 更新索引的方式。首次与同步数据源时，Amazon Kendra默认情况下会对所有内容进行抓取和索引。如果首次同步失败，即使您没有选择“完整同步”作为同步模式，也必须执行一次完整的数据同步。您可以选择：
- FORCED_FULL_CRAWL，每次数据来源与索引同步时，重新为所有内容编制索引，并替换已有内容。
- FULL_CRAWL每次数据源与索引同步时，仅对新的、修改过的和已删除的内容编制索引。 Amazon Kendra可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。
亚马逊秘密资源名称 (ARN)-提供包含您在账户中创建的身份验证凭证的Secrets Manager密钥的亚马逊资源名称 (ARN)。 ServiceNow

如果您使用基本身份验证，密钥将存储在 JSON 结构中，其中包含以下键：
```
{
    "username": "user name",
    "password": "password"
}
```

如果您使用 OAuth2 客户端证书，则密钥将存储在 JSON 结构中，其中包含以下密钥：


{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}

IAMro le —指定RoleArn何时调用CreateDataSource以向IAM角色提供访问您的Secrets Manager密钥的权限以及调用 ServiceNow 连接器 APIs 所需的公众的权限，以及Amazon Kendra。有关更多信息，请参阅 ServiceNow S3 数据来源的 IAM 角色。

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

虚拟私有云（VPC）- 指定 VpcConfiguration，以便调用 CreateDataSource。有关更多信息，请参阅配置Amazon Kendra为使用 Amazon VPC。
包含和排除筛选条件 - 您可以使用知识文章、服务目录和事件的文件名和文件类型来指定是包含还是排除某些附件。

注意
大多数数据来源使用正则表达式模式，即称为筛选条件的包含或排除模式。如果您指定包含筛选条件，则只会为与包含筛选条件匹配的内容编制索引。不会为任何与包含筛选条件不匹配的文档编制索引。如果您指定包含和排除筛选条件，则不会为与排除筛选条件匹配的文档编制索引，即使它们与包含筛选条件相匹配。
要索引的特定文档-您可以使用 ServiceNow 查询从一个或多个知识库（包括私有知识库）中指定所需的文档。对知识库的访问权限由您用来连接 ServiceNow 实例的用户决定。有关更多信息，请参阅使用查询指定要编制索引的文档。
索引参数 - 您也可以选择指定是否：
- 为知识文章、服务目录或事件编制索引，或者为所有这些内容编制索引。如果您选择为知识文章、服务目录项目和事件编制索引，则必须提供映射到索引中索引文档内容字段的Amazon Kendra字段名称。 ServiceNow
- 为知识文章、服务目录项和事件的附件编制索引。
- 根据 short description 筛选模式包含知识文章、服务目录项目和事件。
- 选择筛选活动和非活动服务目录项目和事件。
- 选择根据事件类型筛选事件。
- 选择爬取对哪些实体的 ACL。
- 您可以使用 ServiceNow 查询从一个或多个知识库（包括私有知识库）中指定所需的文档。对知识库的访问权限由您用来连接 ServiceNow实例的用户决定。有关更多信息，请参阅使用查询指定要编制索引的文档。
身份爬网程序 – 指定是否激活 Amazon Kendra 的身份爬网程序。身份爬网程序使用文档的访问控制列表（ACL）信息，来根据用户或用户组对文档的访问权限筛选搜索结果。如果您的文档有 ACL 并选择使用您的 ACL，则也可以选择开启身份爬网程序来配置搜索结果Amazon Kendra的用户上下文筛选。否则，如果关闭身份爬网程序，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMappingAPI 上传用户和群组访问信息以进行用户上下文筛选。
字段映射 - 选择将 ServiceNow 数据来源字段映射到 Amazon Kendra 索引字段。有关更多信息，请参阅映射数据来源字段。

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

有关要配置的其他重要 JSON 键的列表，请参阅 ServiceNow 模板架构。

了解详情

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

开始Amazon Kendra发布更新的 ServiceNow 连接器 (V2) Amazon Kendra

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

ServiceNow 连接器 V1.0

使用查询指定文档

ServiceNow 连接器 V2.0

主题

支持的功能

先决条件

注意

注意

注意

连接说明

注意

注意

重要

注意

注意

了解详情