计划 API 任务

计划 API 任务 使您能够启动独立于 机器人运行程序 基础结构（用户和设备）的自动化。 由于 API 任务 在 云部署 上运行，无需单独的用户许可证，从而节省了成本并简化了自动化管理。

注： 在 Control Room 中计划 API 任务 需要 企业平台 许可证。 有关此功能支持的版本的更多信息，请参阅 企业平台。
您可以安排可用的 API 任务 在指定时间运行。 例如，每周三下午 5 点运行处理 .csv 文件中的批量发票。

先决条件

请确保您以管理员或具有以下权限的用户身份登录 Control Room：
  • 调度我的机器人运行
  • 在文件夹级别对特定 API 任务 及其任何依赖项具有管理我的文件夹中所有计划活动权限
  • 以用户的身份运行 API 任务。

    有关更多信息，请参阅 以用户身份运行 API 任务 (apitaskrunner)。

过程

  1. 登录到 Control Room。
  2. 在左侧面板中选择以下方法之一来创建计划：
    • 单击自动化。

      单击要创建计划的 API 任务 右侧的操作菜单（垂直省略号），然后单击计划 API 任务 。

    • 单击 管理 > 已计划 > 创建计划。
    此时将显示自动化和依赖项屏幕。 您还可以单击选择选项查找特定的 API 任务。
  3. 选择要计划的 API 任务 并单击选择。
    此时将显示包含多个选项卡的创建计划屏幕。
  4. 使用自动化和依赖项选项卡查看和更新以下字段：
    • 自动化文件： 显示所选 API 任务。

      如果要选择不同的 API 任务，请单击选择。

    • 使用以下选项运行自动化和依赖项： 选择要运行的 API 任务 的以下版本之一：
      • 最新版本： 使用最新版本计划所选 API 任务 及其依赖项。
      • 实际正式标签： 使用实际正式版本计划所选 API 任务 及其依赖项。

      默认情况下会选择 API 任务 的最新版本。

    • 依赖项： 所选 API 任务 的依赖项列表。
  5. 单击下一步。
  6. 为 API 任务 添加计划详细信息。
    在计划字段选择以下选项之一：
    • 运行一次： 在指定的日期和时间运行一次 API 任务。

      使用以下选项配置运行一次设置：

      • 开始日期： 默认值是当前日期。
      • 开始时间： 默认值将四舍五入至下一个半小时。
      • 时区： 您本地设备的系统时区。
        注： EST、HST 或 MST 时区已被弃用。 请参阅 即将弃用的功能。
    • 重复运行： 使用此选项在指定日期的特定时间计划 API 任务 运行。

      使用以下选项配置重复运行设置：

      • 开始日期： 输入您计划开始运行 API 任务 的日期。

        以 YYYY-MM-DD 格式手动输入日期或使用弹出日历输入日期。 开始日期字段的默认值设置为本地设备当前日期。

      • 结束日期： 输入您希望调度结束的日期。

        结束日期默认情况下不设置。

      • 开始时间： 使用下拉列表输入开始时间，以设置您希望调度开始的时间值。

        列表包含以 15 分钟为间隔的 12 小时制预设时间值。 您也可以手动设置 12 小时格式的时间值。

      • 时区： 选择开始时间和结束时间的时区。

        默认值设置为系统的当前位置。 调度会根据在创建或编辑调度时所选的时区运行。

      • 重复间隔： 选择此选项以重复计划。
    • 频率： 选择以下选项之一作为计划运行频率：
      • 每日： 选择您希望调度运行的天数。
      • 每周： 选择您希望调度运行的星期和具体的星期几。

        例如，如果计划每 2 周的周一和周四运行，请在每隔选项中将计数增加到 2，并选中周一和周四复选框。

      • 每月： 选择以下选项之一：
        • 日期： 选择您希望调度运行的月份中的日期。
        • 特定日期： 选择您希望调度运行的月份中的日期的特定出现次数。

          例如，如果计划在 1 月、5 月和 9 月的第二个星期四运行，请从给定选项中选择“第二个”、“星期四”以及“1 月、5 月、9 月”。

        注： 启用夏令时后，如果已计划开始日期，日期将显示在其所属时区（非用户当前时区）。 然而，下次发生时间将根据夏令时显示为该时区（用户系统时区）时间。

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

        如果计划任务在 2023/11/23 9:00 AM 至 2023/11/30 9:00 AM 期间以每日频率运行，则任务将从 2023/11/23 9 AM 开始每日执行，最后一次任务于 2023/11/30 9 AM 执行。

    • 在错过的计划设置部分，选中重新部署计划复选框以重新部署因 Control Room 关闭而错过的计划。

      选择重新部署计划选项后，因 Control Room 关闭而错过的计划将在 Control Room 重启后自动重新部署。 审计日志中还会添加一个条目，将事件类型显示为调度未触发。

      注： 为确保使用重新部署计划选项时部署成功，必须在重启 Control Room 服务前启动编译器服务。
  7. 单击下一步。
  8. 使用运行身份用户选项卡执行以下操作：
    • 从可用运行身份用户表中选择用户，然后单击向下箭头添加选择。

      所选用户将列于已选表中。 可使用向上箭头移除任何已选用户。

      注： 系统会生成名为 apitaskrunner 的用户，该用户与 AAE_API 任务运行器角色关联，以建立 API 任务 的运行身份用户上下文。
    • 在定义要使用的运行身份用户数量字段中，选择以下选项之一：
      • 所有运行身份用户： 选择此选项以指定已选表中所有用户作为运行 API 任务 时的运行身份用户。
      • 自定义运行身份用户的数量： 选择此选项以从已选表格中提供一定数量的用户，作为运行身份用户。

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

  9. 单击下一步。
  10. 可选： 使用常规选项卡更改以下选项的默认设置：
    • 活动名称： 编辑或重命名 API 任务。
    • 自动化优先级： 单击下拉菜单设置自动化优先级。

      默认优先级为中，但可更改此设置以使自动化按相应优先级处理部署。

  11. 单击创建计划。
    API 任务 即完成计划。 您可以在 管理 > 已计划 页面查看已计划 API 任务 的状态。