使用 Vault Java SDK,您可以构建自定义的 Vault 至 Vault 集成,以便在不同的 Vault 之间自动执行业务流程。在 Vault UI 中,您可以设置一个集成对象记录,以便向业务管理员显示集成要实现的业务目标,并使他们能够轻松管理集成。例如,这样将使业务管理员能够打开或关闭集成。

此页面包含有关两个 Vault 之间的集成的独特信息。本地外部连接类型不支持集成对象。

访问集成管理

管理 > 连接中查看和管理集成。进入此区域之后,您可以查看具有 Vault 到 Vault 连接类型的每个连接记录的集成您必须拥有一个能够授予应用程序:管理连接权限的安全配置文件,才能访问此标签页中的连接。

要访问除连接以外的与集成相关的项(例如用户异常消息、集成规则)以及查看当前部署到您 Vault 中的 Spark 消息处理器,您需要拥有应用程序:管理集成权限。

SDK 集成概述

两个 Vault 之间的集成可以自动执行以前的手动业务流程。例如,Vault QMS 中的一个新更改事件记录会向 Vault 注册发送一条 Spark 消息。此消息会在 Vault 注册中启动一组监管活动,Vault 注册还可能回调 Vault QMS,以了解有关更改事件的任何必要信息。

您必须在两个 Vault 之间设置连接记录,才能在它们之间创建集成。此记录包含允许两个 Vault 进行通信的协议。了解有关设置连接的更多信息。

在两个 Vault 之间创建连接之后,您可以在此连接上设置集成集成点记录。这篇文章将重点介绍这些对象和它们提供的功能。

使用 Vault Java SDK,开发人员可以为两个 Vault 之间的集成构建业务逻辑。这些集成代码将引用连接集成集成点对象。了解有关在开发人员门户中编写 SDK 集成代码的更多信息。

关于集成和集成点

集成 (integration__sys) 对象本质上是一组自包含、独立的集成点 (integration_point__sys) 记录。集成点表示一个单一目标,或者集成流中的“点”。一个集成可以有很多集成点,但一个集成点只能属于一个集成。

集成集成点并不是集成所必需的,但使用它们可以获得很多好处。例如,管理员可以查看与集成关联的集成点,以了解它的目标和流,而无需检查自己的 Vault 的配置或 SDK 代码。例如用于创建新的更改控制记录的流程。

借助集成点,您还可以使用用户异常消息。这些自定义的异常由 Vault Java SDK 开发人员编写代码,并使 Vault 管理员能够解决常见的集成错误。例如,如果您的集成由于缺少必填字段而未能创建新的更改控制记录,您可以向业务管理员显示此信息,以使其纠正错误。

如何创建集成对象

要为一个连接创建集成记录:

  1. 管理 > 连接中,选择要为其创建集成记录的连接。
  2. 单击集成以展开这一节段,然后单击创建
  3. 为此集成输入一个名称。此名称将出现在管理 UI 中。
  4. 输入一个集成 API 名称。这样,开发人员将通过 Java SDK 或 API 引用此集成。只允许使用小写字母、字母数字字符和下划线 (_),但名称不能以下划线开头或结尾。
  5. 为集成设置一个活动非活动状态。当构建自定义集成时,开发人员应当使用此状态执行业务逻辑。例如,为此状态添加逻辑,以控制集成的打开和关闭。默认情况下,此设置不会产生任何影响。
  6. 可选:如果希望在集成详细信息中包含指向远程 Vault 集成记录的链接,请输入远程 Vault 集成名称。这是此链接的标签。接下来,输入远程 Vault 集成 ID。这是远程 Vault 的集成记录的 ID 值。
  7. 单击保存

创建集成记录之后,您可能希望创建集成点

如何创建集成点

要为一个集成创建集成点:

  1. 管理 > 连接中,选择包含您要为其创建集成点的集成的连接。
  2. 单击集成以展开这一节段,然后选择要为其创建集成点的集成。
  3. 展开集成点 - 出站集成点 - 入站节段。
  4. 为此集成点输入一个名称。此名称将出现在管理 UI 中。
  5. 输入一个集成 API 名称。这样,开发人员将通过 Java SDK 或 API 引用此集成点。只允许使用小写字母、字母数字字符和下划线 (_),但名称不能以下划线开头或结尾。
  6. 为此集成点输入一个描述。此描述应当说明与集成中的这个点关联的业务流程或集成目标。
  7. 为集成设置一个活动非活动状态。当构建自定义集成时,开发人员应当使用此状态执行业务逻辑。默认情况下,此设置不会产生任何影响。
  8. 单击保存

关于用户异常消息

管理 > 连接 > 用户异常消息中,您可以查看通过您的集成生成的用户异常消息。

Vault 包含用户异常消息对象及其子级对象用户异常项,以帮助业务管理员跟踪和解决您的集成出现的任何错误。在 Spark 消息处理器内,您的 Vault Java SDK 开发人员可以使用这些对象来创建这些自定义的异常消息。

例如,如果您的集成的任一端未能处理一条入站消息,您的自定义 SDK 逻辑会创建一个用户异常消息记录,以捕获失败并向业务管理员显示信息。此记录可能包含一些信息,以说明如何排除故障、需要执行哪种操作、当故障持续存在时应当联系哪些人员等事宜。

如果希望在每次生成新的用户异常消息时向特定的用户或组发送通知,您必须为用户异常消息对象创建一个自定义生命周期,并配置一个通知入口操作。

用户异常消息绑定到个别集成点。因此,如果不设置集成和集成点,您将无法使用用户异常消息。

关于集成规则

使用 Spark 集成规则,开发人员可以将用于在两个 Vault 之间映射对象和文档字段的可配置规则合并到 Spark 消息处理器中。了解有关如何创建和管理集成规则的更多信息。

Spark 消息处理器

管理 > 连接 > Spark 消息处理器,您可以使用它查看当前部署到 Vault 中的所有 Spark 消息处理器。

Spark 消息处理器提供了用于处理 Spark 消息的逻辑。例如,所有入站队列都必须包含一个 Spark 消息处理器,以提供要对所收到的消息执行的操作。

  • 名称:Spark 消息处理器的名称。
  • 来源:此 Spark 消息处理器的来源。自定义意味着此处理器是使用 Vault Java SDK 开发的。
  • 运行状态:此 Spark 消息处理器处于活动还是非活动状态。尽管您仍然可以为入站队列分配一个非活动处理器,但只有处于活动状态的处理器能够处理消息。

Spark 消息传递事件处理程序

管理 > 连接 > Spark 消息传递事件处理程序,您可以使用它查看当前部署到 Vault 中的所有 Spark 消息传递事件处理程序。

这些处理程序提供了一种机制,使管理员和 Spark 集成开发人员能够处理未送达的 Spark 消息。为出站队列配置之后,Vault 将执行处理程序逻辑。例如,如果目标 Vault 不可用,处理程序可能在 24 小时内将消息放回到队列中,并通知特定的用户,或者采取其他的行动。

名称
处理程序的名称。
来源
处理程序的来源。自定义意味着此处理程序是使用 Vault Java SDK 开发的。
操作状态
处理程序的状态,活动非活动