计划 API 任务 - 计划 API 任务 功能使您能够创建一个计划，以便在定义的时间表上运行特定版本的 API 任务 。 在定义 API 任务 的计划时，您可以选择以哪个用户身份运行。 计划 API 任务 可使您在无需任何手动干预的情况下运行对时间敏感的流程。

Automation 360

计划 API 任务 功能使您能够创建一个计划，以便在定义的时间表上运行特定版本的 API 任务。 在定义 API 任务 的计划时，您可以选择以哪个用户身份运行。 计划 API 任务 可使您在无需任何手动干预的情况下运行对时间敏感的流程。

关于此任务

注： 在 Control Room 中计划 API 任务 需要 企业平台 许可证。 有关此功能支持的版本的更多信息，请参阅 企业平台。

您可以安排可用的 API 任务 在指定时间运行。 例如，每周三下午 5 点运行处理 .csv 文件中的批量发票。 创建计划选项可在公共存储库的每个 API 任务 的垂直省略号菜单中找到。 或者，您可以在管理 > 已计划页面中，使用创建计划选项来创建计划。

开始之前

请确保您以管理员或具有以下权限的用户身份登录 Control Room：
  • 计划我的机器人运行时间
  • 管理我的文件夹中所有计划活动权限，适用于您签入特定API 任务及其任何依赖项的文件夹
  • 以用户身份为 API 任务 运行。 有关更多信息，请参阅 以用户身份运行 API 任务 (apitaskrunner)。

过程

  1. 登录到 Control Room。
  2. 在左侧面板中选择以下方法之一来创建计划：
    • 转到自动化 > 公共，然后单击您想要创建计划的相应 API 任务 的垂直省略号菜单，并单击计划 API 任务。
    • 转到管理 > 已计划 > 创建计划。
    将显示创建计划页面。
  3. 在创建计划页面的自动化和依赖项部分，单击选择。
    将弹出查找文件模态框。
  4. 选择要计划的 API 任务 并单击选择。
    创建计划页面会与其他计划标签页同步更新。
  5. 在自动化和依赖项选项卡中配置以下设置，并单击下一步：
    1. 请在自动化文件设置中确认所选 API 任务。
      如果您想选择不同的 API 任务，请单击选择并按照提示选择不同的 API 任务。
    2. 在使用以下方式运行自动化和依赖项设置中选择适当版本的 API 任务。
      以下选项可供选择：
      • 最新版本： 使用最新版本计划所选 API 任务 及其依赖项。
      • 实际正式标签：API 任务 不支持实际正式标签选项。
    如果所选 API 任务 包含任何依赖项，依赖项部分将自动更新依赖项列表。
  6. 根据以下选项，在计划选项卡中为所选 API 任务 设置配置频率和重复设置：
    选项描述
    运行一次 选择此设置以运行 API 任务 一次，并定义时间间隔。 以下设置适用于此设置：
    • 开始日期： 设置计划的开始日期。 当前日期被设为默认开始日期。
    • 开始时间： 设置计划的开始时间。 系统会将下一步半小时进行四舍五入，并将其设为默认开始时间。
    • 时区： 设置计划的时区。 系统将本地设备的时区设置为默认时区。
    重复运行 选择此设置以反复运行 API 任务，并为 API 任务 设置日期、重复间隔和频率。 以下设置适用于此设置：
    • 开始日期： 设置计划的开始日期。 当前日期被设为默认开始日期。
    • 结束日期： 设置计划的结束日期。
    • 开始时间： 设置计划的开始时间。 系统会将下一步半小时进行四舍五入，并将其设为默认开始时间。
    • 时区： 设置计划的时区。 系统将本地设备的时区设置为默认时区。
    • 重复间隔： 为计划设置重复间隔。 您可以以分钟或小时为单位设置重复间隔。
    • 结束时间： 为计划设置重复间隔的结束时间。
    • 时区： 为计划的重复间隔设置时区。
    • 频率： 设置计划的重复频率。 您可以按如下方式设置频率：
      • 每日： 选择天数。
      • 每周： 请选择周数和具体的星期几。
      • 每月： 选择所选月份中的特定日期或所选月份内的特定星期几。 例如，您可以通过从给定选项中选择第二个、星期四以及一月、五月和九月，将计划配置为在一月、五月和九月的第二个星期四运行。
    注：
    • EST、HST 或 MST 时区已弃用。 请参阅 即将弃用的功能。
    • 启用夏令时后，如果已计划开始日期，日期将显示在其所属时区（而非用户当前时区）。 然而，下一步将根据夏令时显示为该时区（用户系统时区）时间。

      例如，对于在 GMT 时区创建的 3 月 15 日计划，开始日期显示为 Mar-15th，属于 GMT 时区。 之后，当夏令时开启时，如果您在 BST 时区的 8 月份编辑或查看此计划表，下一步发生的时间将显示为属于 BST 时区的 8 月份。

      如果您将任务安排在 2023-11-23 9:00 AM 至 2023-11-30 9:00 AM 期间运行，并将频率设置为每日，则任务将从 2023-11-23 9:00 AM 开始每日执行，最后一次任务将在 2023-11-30 9:00 AM 执行。

  7. 选中重新部署计划复选框以设置错过的计划设置，然后单击下一步。
    重新部署计划选项会在 Control Room 重启时自动部署错过的计划。 系统会添加一个审核日志条目，其中事件类型为计划未触发。
    注： 当您选择重新部署计划选项时，请确保在重启 Control Room 服务之前先启动编译器服务，以确保部署成功。
  8. 使用以下选项配置运行身份用户设置，然后单击 下一步：
    1. 从可用的运行身份用户表中选择相应的用户，然后单击向右箭头，将其添加到计划中。
      注： 系统会生成一个名为 apitaskrunner 的用户，并将其与 AAE_API Task Runner 角色关联，以为 API 任务 建立运行身份用户上下文。
      选定的用户将出现在选定表格中。 如有需要，您可以选择任意用户并单击左箭头将其从日程中移除。
    2. 在定义需使用的运行身份数量选项中选择以下之一：
      • 所有运行身份用户： 选择此选项以在执行 API 任务 时将已选择表中的所有用户指定为运行身份用户。
      • 自定义运行身份用户数量： 选择此选项以从已选表中提供一定数量的用户，作为运行身份用户。

        例如，如果已选表中有 5 个用户，并且只想使用其中的 3 个作为运行身份用户，请输入 3。 表格顶部列出的 3 个用户在执行 API 任务 时将作为运行身份用户。

  9. 使用以下选项配置计划的常规设置，然后单击创建计划：
    1. 请确认自动生成的名称，或为活动名称中的计划活动名称重新命名。
    2. 可选： 在描述字段中添加计划活动的描述。
    3. 从自动化优先级下拉菜单中选择适当的计划优先级。
      系统将中等设置为默认自动化优先级

结果

为所选 API 任务 创建的计划显示在已计划活动页面的活动表格中。 活动表的状态列显示计划的状态。