配置作业定义 | Vault 帮助

作业调度程序为管理员提供了一种简单、简化的方式来创建批量操作并安排作业的重复执行。组织可以使用 Vault 的作业安排功能让文档和对象进入新的生命周期状态或发送通知。

访问作业安排

您可以从管理 > 操作安排作业并查看作业状态。对此区域的访问权限由管理：操作和管理：作业权限控制。

作业术语表

定义作业时，有以下几个关键元素：

作业: 针对查询结果执行的一系列活动（始终是主要操作，有时是基于日期的附加通知）。
作业定义: 定义作业的具体内容以及何时执行的一组规则和配置。
作业实例: 已定义作业的一次运行。在实例开始时，该实例执行作业定义中概述的操作。每次作业运行时，它都是唯一的实例。审计日志中提供有关作业实例的详细信息，从而使操作可追溯。管理员还可以从作业状态页面监控作业实例。
作业状态: 作业状态页面中显示单个作业实例的当前状态（已安排、成功、已取消等）。
操作: 完成的主要操作，例如，文档状态更改。
条件: 定义为文档操作作业查找和选择符合条件的文档的查询。例如，文档必须符合以下条件：类型 = 机构管理，状态 = 已批准使用。
触发日期: 作为参考的特殊日期（基于文档字段），基于日期的文档操作作业会根据该日期评估是否运行。触发日期可以是文档更改状态的日期或相关文档的日期。
可选通知: 与文档操作作业捆绑在一起的通知。这些通知使用与该作业的主要操作相同的条件和触发日期，但可以基于触发日期有不同的日期偏移。例如，可以在触发日期前 7 天发出通知，以通知文档所有者安排的作业将更新其文档。
运行方式: 定义 Vault 用于完成外部 URL 调用作业的用户帐户。对于大多数安全配置文件，您只能选择自己，但具有标准 Vault 所有者配置文件的用户可以设置使用任何用户的帐户运行的作业。这一选择很重要，因为它确定了哪些用户和会话 ID 将替换 URL 中的令牌。
主文档: 受该作业影响的文档。例如，状态更改作业会将主文档从一个状态移到另一个状态，并且通知作业会通知主文档的所有者。
相关文档: 通过某种文档关系（如关联文档和支持文档）与主文档关联的文档。安排的作业不会影响相关文档，但您可以使用相关文档中的日期字段来触发主文档上的作业。

如何定义文档操作作业

要为基于日期的文档操作作业创建新的作业定义：

导航到管理 > 操作 > 作业定义，然后单击创建。
为该作业输入标题。此值显示在作业定义页面、审计日志以及向作业所有者发出的自动通知中。
可选：如果需要，请更改该作业的名称。该字段根据标题自动填充，但它是可编辑的。这是 API 用于引用该作业的值。
在类型字段中，选择基于日期的文档操作。
选择一个用户或组（推荐）作为作业所有者。作业所有者会收到有关作业实例期间遇到的异常情况的自动通知。成功的作业不会生成这些通知。将某用户设置为作业所有者时，不会授予任何其他应用程序访问权限，因此请验证选定的作业所有者是否具有包含必要访问权限的权限集。
选择每小时、每天、每周或每月计划。请参阅作业安排，以了解更多信息。
选择一项操作。根据您选择的操作，部分字段将会有所更改。请参阅下文，了解状态更改、发送通知和无操作操作的详细信息。
选择生命周期。所有作业都是特定于生命周期的，并且文档必须使用选定的生命周期才能满足作业的查询条件。
在触发日期基于下方，指明触发该作业的条件。请参阅下文，了解源文档日期和相关文档日期的详细信息。
可选：在附加条件下方，选择文档字段、运算符和字段值，以向文档查询添加另一个条件。如果您需要多个附加条件，可以单击加号 (+) 图标添加它们。
可选：在可选通知或通知下方，单击添加以创建其他通知。要添加多个通知，请继续单击添加。在发送日期中，指定操作的触发日期之前的天数。为该通知选择消息模板。选择一个或多个文档角色作为接收人。请参阅通知和消息模板的详细信息。
可选：要使该作业在下一个计划时间运行，请将状态设置为活动。如果作业定义处于非活动状态，将不会安排作业实例。
单击保存。

如何定义对象操作作业

要为基于日期的文档操作作业创建新的作业定义：

导航到管理 > 操作 > 作业定义，然后单击创建。
为该作业输入标题。此值显示在作业定义页面、审计日志以及向作业所有者发出的自动通知中。
可选：如果需要，请更改该作业的名称。该字段根据标题自动填充，但它是可编辑的。这是 Vault REST API 用于引用该作业的值。
在类型字段中，选择基于日期的对象操作。
选择一个用户或组（推荐）作为作业所有者。作业所有者会收到有关作业实例期间遇到的异常情况的自动通知。成功的作业不会生成这些通知。将某用户设置为作业所有者时，不会授予任何其他应用程序访问权限，因此请验证选定的作业所有者是否具有包含必要访问权限的权限集。
选择每小时、每天、每周或每月计划。请参阅作业安排，以了解更多信息。
选择一项操作。根据您选择的操作，部分字段将会有所更改。请参阅下文，了解状态更改、发送通知和无操作操作的详细信息。
选择对象。例如，如果您的作业应将产品移到新状态，您将选择产品对象。
可选：在附加条件下方，选择对象字段、运算符和字段值，以向对象记录查询添加另一个条件。如果您需要多个附加条件，可以单击加号 (+) 图标添加它们。
在触发日期下方，选择要用作触发日期的对象字段。选择触发日期应在作业日期之前和当天生效，还是仅在作业日期之前生效。
可选：在可选通知或通知下方，单击添加以创建其他通知。要添加多个通知，请继续单击添加。在发送日期中，指定操作的触发日期之前的天数。为该通知选择消息模板。选择一个或多个对象生命周期角色作为接收人。请参阅通知和消息模板的详细信息。
可选：要使该作业在下一个计划时间运行，请将状态设置为活动。如果作业定义处于非活动状态，将不会安排作业实例。
单击保存。

如何定义外部 URL 调用作业

要为外部 URL 调用作业创建新的作业定义：

导航到管理 > 操作 > 作业定义，然后单击创建。
为该作业输入标题。此值显示在作业定义页面、审计日志以及向作业所有者发出的自动通知中。
可选：要使该作业在下一个计划时间运行，请将状态设置为活动。如果作业定义处于非活动状态，将不会安排作业实例。
可选：如果需要，请更改该作业的名称。该字段根据标题自动填充，但它是可编辑的。这是 Vault REST API 用于引用该作业的值。
在类型字段中，选择外部 URL 调用。
选择一个用户或组（推荐）作为作业所有者。作业所有者会收到有关作业实例期间遇到的异常情况的自动通知。成功的作业不会生成这些通知。将某用户设置为作业所有者时，不会授予任何其他应用程序访问权限，因此请验证选定的作业所有者是否具有包含必要访问权限的权限集。
选择每小时、每天、每周或每月计划。请参阅作业安排，以了解更多信息。
在操作配置下方的 URL 文本字段中，输入此作业执行时 Vault 将调用的 URL。URL 必须包含 https://。
可选：在字段区域中，搜索要包含在 URL 中的令牌（作业 ID、用户详细信息和 Vault 详细信息）。要添加字段的令牌，请双击该字段名称。
可选：准备就绪时，单击验证以自动检查您的 URL 是否有效。请注意，Vault 不会尝试连接到远程主机；仅验证 URL 的结构和任何令牌的有效性。
可选：选中通过包含“Session.id”密钥的表单数据发布会话凭据复选框以通过表单数据发布会话凭据。这允许您的 URL 调用 Vault API 等。您的 URL 必须准备就绪，以检索此会话 ID。在开发人员门户中了解更多信息。
在运行方式选项列表中，选择在执行外部调用时 Vault 将使用的用户帐户。如果您有除 Vault 所有者之外的任何安全配置文件，则只能选择自己。
单击保存。

如何编辑作业定义

要编辑现有作业的定义：

导航到管理 > 操作 > 作业定义，然后单击该作业的标题。
做必要的改动。
将状态设置为活动。当您编辑时，Vault 始终将状态自动设置为非活动。
单击保存。

请注意，当作业的条件引用非活动组件（例如，非活动生命周期）时，您将看到（未定义的值）而不是该条件的值。您必须删除非活动组件或将其再次设置为活动状态，才能更新作业定义。

状态更改操作的详细信息

使用状态更改操作创建或编辑作业时，除了上面详述的字段外，您还会看到以下字段：

（仅文档操作）文档版本是将在其上运行作业的文档版本。系统会忽略所有其他版本。选择绝对最新以在该文档的最新版本上运行作业，无论它是否处于稳定状态。选择最新稳定状态以在该文档最新的稳定状态版本上运行作业。
（仅文档操作）开始状态是作业文档操作查询的一部分。文档必须在触发日期处于指定状态之一，才能被选中用于作业。请注意，使用此操作类型时，您无法在附加条件下添加状态字段条件。
（仅文档操作）目标状态是作业将文档移至的状态。例如，过期作业可以将文档从开始状态已批准移到目标状态已过期。Vault 将强制执行目标状态的入口操作和条件。请注意，通过作业更改状态时，不要求存在用于开始状态的用户操作配置。
（仅对象操作）将状态更改为是作业将对象记录移至的状态。例如，过期作业可以将对象记录移到已过期状态。与文档操作不同，您无需指定起始状态。如果您需要按当前状态筛选对象记录，请使用附加条件。
如果启用取消现有工作流以执行操作设置，将取消查询找到的任何文档/对象记录上的未处理工作流（“已阅读并了解”工作流除外）以完成操作。如果禁用此设置，Vault 不会对包含未处理工作流的文档/对象记录执行该操作，并记录这些项的错误。如果 Vault 取消工作流，文档/对象记录首先进入取消状态，然后进入该作业指定的目标状态。这样会触发两种状态的入口操作，并且可能会根据 Vault 的配置产生影响。请注意，此操作不会取消多文档工作流中包含的文档的工作流。

请注意，在某些情况下，文档状态更改作业可以将作业移到用户无法再完成“已阅读并了解”工作流的文档状态。在这种情况下，管理员必须手动取消该工作流。

通知操作的详细信息

使用发送通知操作创建或编辑作业时，除了上面详述的字段外，您还会看到以下字段：

消息模板: 定义作为通知发送的文本。您可以从管理 > 配置 > 消息中定义这些消息。请参阅以下详细信息。
接收人: 定义将接收通知的用户（通过其适用于文档操作的文档角色或适用于对象操作的对象生命周期角色）。

“无操作”操作的详细信息

无操作是一种特殊的作业操作类型，它让管理员查找满足指定条件的文档或对象记录并发送通知，但不会对找到的项执行任何操作。在某些情况下，它比使用发送通知操作更有用，因为可选通知的功能是不同的：发送通知操作使用触发日期来选择无界范围的文档或对象记录：[日期字段] 在今天之前的任何项，可能有非常多的项，其中一些项可能不再相关。可选通知使用有界的触发日期：触发日期前 X 天。例如，“5 天前”仅选择 [日期字段] 为今天的日期或从今天起未来 5 天内的项。

例如，使用包含可选通知（同个作业的一部分）的无操作操作来提醒文档所有者他们的内容即将到期接受定期审查。如果负责方不采取行动，Vault 会通知用户，但不会更改内容（即使定期审查已过期）。

在使用此操作实施作业之前，请咨询 Veeva 支持人员。

使用无操作操作创建或编辑作业时，无需指定其他详细信息。

外部 URL 调用 HTTPS 发布操作的详细信息

外部 URL 调用导航到外部服务的 URL，它了解正在传递的参数，并且可以采取除此之外的其他操作。如果通过包含“Session.id”密钥的表单数据发布会话凭据复选框，该操作将传递一个会话 ID，该服务可以使用 Vault REST API 回调到 Vault，并作为在运行方式参数中指定的用户来执行任何数量的操作。这些操作可能包括查询更多数据、创建文档等。您的外部服务必须准备就绪，以检索此会话 ID。在开发人员门户中了解更多信息。

定义外部 URL 调用时，您必须使用 HTTPS URL。

文档上的触发日期

Vault 可以根据受影响/主文档中的日期或相关文档中的日期触发作业。例如，您的 Vault 可能包含将文档移至需要审查状态的两个作业：一个作业使用主文档中的日期，另一个作业使用相关文档中的日期。这两个作业都将使用包含可选通知的状态更改操作类型。

在作业 A 中，触发日期源自主文档。在 CholeCap Brochure 中的重新批准日期前四周，Vault 向文档所有者 Tracy 发送了通知。在重新批准日期当天，安排的作业将 CholeCap Brochure 移至需要审查状态。
在作业 B 中，触发日期源自与主文档相关的文档。这种类型的触发日期使用相关文档的生命周期状态以及日期来确定是否触发该作业。CholeCap Brochure（主文档）引用了文档 Study 2039 Report，因此这些文档之间存在关联文档关系。在 Study 2039 Report 中的过期日期前四周，Vault 向 CholeCap Brochure 的文档所有者 Tracy 发送通知，让她知道关联文档即将到期。在研究报告的过期日期当天，安排的作业将 CholeCap Brochure 移至需要审查状态。此作业很重要，因为相关引用文档即将过期意味着该手册将需要审查。

注意：仅状态更改和发送通知作业支持基于相关文档的触发。此功能仅适用于目标文档特定于版本的关系类型。

使用受影响文档日期触发作业

要根据受影响文档中的日期设置触发条件：

在触发日期基于下方，选择主文档日期。
选择要用作触发日期的文档字段。
选择触发日期应在作业日期之前和当天生效，还是仅在作业日期之前生效。

要根据与受影响文档相关的文档中的日期设置触发条件：

在触发日期基于下方，选择相关文档日期。
选择一种或多种关系类型。这决定了该作业查看的相关文档的类型。
选择相关文档生命周期。该作业仅查看此生命周期中的相关文档。
选择相关文档状态。该作业仅查看处于这些生命周期状态的相关文档。
选择要用作触发日期的（相关文档上的）文档字段。
选择触发日期应在作业日期之前和当天生效，还是仅在作业日期之前生效。

对象上的触发日期

Vault 可以根据受影响对象记录中的日期触发作业。例如，Vault 可能会在批准结束日期当天将对象记录移至需要审查状态。

触发作业

要根据受影响的对象记录中的日期设置触发条件：

选择要用作触发日期的对象字段。
选择触发日期应在作业日期之前和当天生效，还是仅在作业日期之前生效。

文档和对象通知和通知模板

Vault 在每次计划运行带有发送通知操作的作业定义时都会发送通知。与作业定义相关的所有其他通知（包括主要操作和基于日期的操作）均为“过期”通知。这意味着，对于接收人、文档版本或对象记录和通知模板的每个独特组合，Vault 将仅发送一条通知。即使在不同的作业中和同一作业内的不同通知中也是如此。为此，您必须为每个通知实例定义单独的消息。

例如，如果您要执行的作业是使文档过期，并且希望在状态更改前 28、14 和 7 天向文档所有者发送通知，则需要定义三条不同的消息。

审计日志记录

作为文档操作作业的一部分发生的操作包含在文档审计历史记录中。基于对象操作作业的操作包含在对象记录审计历史记录中。在日志中，显示这些操作以及用户名 System。

Vault 不会在审计日志中跟踪外部 URL 调用。

作业监控

如果任何操作遇到错误，Vault 会通过电子邮件通知作业所有者（用户或组）。Vault 还为实时作业跟踪和使用安排的和已完成的作业实例提供扩展选项。

作业安排

在作业定义页面中，将作业安排为每小时重复一次到每月重复一次：

每小时: 以指定的每小时间隔重复。
每日: 在给定时间每天重复一次。
每周: 给定时间在一周中指定的一天或多天重复。
每月: 在给定时间按指定日历日或工作日重复。例如，要让作业始终在每个月的第 13 天运行，请使用每月的某一天重复选项。要始终在每个月的第二个星期三运行作业，请使用“每周的某一天”选项。

注意：设置每日、每周或每月计划时，请确保在设置时间时选择正确的时区，因为这会设置触发日期的上下文。Vault 将“今天”评估为“指定时区中的今天”。

当配置了安排的作业时，Vault 会在计划的开始时间将该作业放入任务队列中。如果此时 Vault 由于维护、系统中断或同时执行的作业过多而不可用，则作业会在计划时间后继续尝试运行约 5 小时。如果作业无法在该时间范围内启动，Vault 会跳过该实例。这些作业显示错过安排完成状态。如果您的作业经常错过其安排，请联系 Veeva 支持人员。您可能需要错开作业的开始时间或通过合并相似的作业来减少作业总数。