计划 notebook 任务

您可以创建任务以计划自动运行 notebook。 每次根据您所设置的计划运行 notebook 时,站点都会打开一个新容器并在无需您打开 notebook 的情况下运行 notebook。 您在所有 notebook 上最多可以拥有五个活动任务。

您可以从 notebook 编辑器的任务窗格中创建一个或多个已计划任务以运行 notebook。 您可以将其计划为在将来运行一次或定期运行(可在每 15 分钟一次到每 6 个月一次之间随意选择)。

如果要准备自动运行的 notebook(例如定期操作),则需要注意一些事项。

  • 计划任务可运行的最高频率为 15 分钟。
  • 只能为专用 notebook 项目创建任务。 这适用于所有用户类型,包括管理员。
  • 管理员可以查看和编辑组织中所有 notebook 项目的任务。
  • 如果具有计划任务的 notebook 遭到删除或发送到回收站,则将永久删除该任务,无法恢复。

准备 notebook

您可以为 Notebook 配置输入和输出参数。 输入参数对应于 Notebook 中的输入变量,您希望具体化计划任务。 运行计划任务时,输入参数会插入到 notebook 顶部的 notebook 中,类似于全局变量。 这允许您创作通用 Notebook 并在运行时修改输入变量的值。

默认情况下,任务参数被加入到 Notebook 开头的单元格中。 或者,可以使用工具栏中的标签单元格选项,以便创建并管理 notebook 工作空间中每个单元格的标签,来创建名为 injected-parameters 的单元格的标签。 默认情况下,任务参数被加入到 injected-parameters 标签之后的单元格中。 要启用标签,您可以单击查看、单击单元格工具栏,然后单击标签来更改单元格工具栏选项。

内容注意事项

除了可以插入的参数单元格外,计划 notebook 操作不支持用户与 notebook 之间进行交互。 避免在 notebook 运行时添加需要用户交互的内容,例如单击地图上的某个点。

如上所述,必须将要在自动运行时添加的所有凭据或新变量插入参数单元格中。 确保 notebook 中不包含会阻止 notebook 完成的内容。

注:

创作 Notebook 时,使用工作空间目录中目录和文件的完整路径。

例如,使用 /arcgis/home/test.gdb 而非 home/test.gdb

创建任务

准备好 Notebook 后,您可以创建任务以计划其运行情况。 您可以使用 Notebook 编辑器中的任务窗格创建一个或多个任务以自动运行 Notebook,并指定任务的计划。

  1. 验证您是否已登录并具备创建和计划 notebook 的权限
  2. 如果还没有保存 notebook,则请创建一个标题并保存 notebook。

    任务按钮在 notebook 编辑器的顶部功能区中变为可用状态。

  3. 在 notebook 编辑器的顶部功能区上,单击任务
  4. 请单击创建任务以打开对话框。

    注:
    您也可以通过 notebook 项目详细信息页面上的任务选项卡来创建任务。

  5. 标题文本框中提供一个标题以描述您的任务计划,例如 Weekly data cleaning run
  6. 如果之前尚未配置 notebook 的参数,并且在 notebook 任务运行过程中您希望将参数添加到 notebook 中,则请在参数部分中提供这些参数。 在密钥设置中提供一个密钥,在设置中为每个参数提供配对值,然后单击添加参以保存参数。
  7. 单击下一步
  8. 设置任务计划详细信息页面,指定任务的计划。

    提示:
    当您更改重复类型的值时,以下选项将发生更改以适应该值。 例如,如果您选择,则一周的每一天都会出现这些复选框。

  9. 如果您希望计划的 notebook 将在工作空间目录 (/arcgis/home) 中读取或创建文件,请打开使用工作空间切换按钮以为每次运行任务挂载目录。 如果 notebook 无需访问工作空间目录,请关闭该切换按钮。

    注:
    关闭 notebook 任务的使用工作空间切换按钮后,您仍然能够在任务运行过程中写入文件。 但是,已写入文件仅在任务运行过程中保留在临时位置,任务运行完成后,将移除该文件。

  10. 可以选择展开高级部分以输入任务可以运行的最大分钟数。
  11. 高级部分中,如果您添加了参数,将显示将参数保存到 notebook 开关按钮。 (可选)可打开此按钮以将包含新参数的已插入单元格保存到运行的 notebook。
  12. 高级部分中,如果您想要使用每次运行的结果更新 notebook,打开在完成时更新 notebook 开关按钮。
  13. 当您对标题、可选参数和任务计划感到满意时,请单击创建任务

    该任务随即激活,并根据您设置的计划运行 Notebook。

如果您希望设置多个计划,则可以使用相同的工作流为 notebook 创建更多任务。 您在所有 notebook 上最多可以拥有五个活动任务。 如果您已拥有五个活动任务并且希望计划更多任务,请暂停或删除活动任务。

使用现有任务

为 notebook 创建任务后,您可以随时查看任务的详细信息并进行编辑或删除。 可以在 notebook 编辑器的任务窗格或 notebook 项目页面的任务选项卡中对任务进行更改。 在这两个位置中,您可以查看 notebook 的所有任务及各个任务的创建时间、上次修改时间和当前状态。

  1. 验证您是否已登录并具备创建 notebook 的权限
  2. 在 notebook 编辑器的顶部功能区上,单击任务
  3. 计划任务部分,查找您想要使用的任务。
  4. 单击任务旁边的操作 操作,然后执行以下任意操作:
    • 单击详细信息以查看详细信息和每个任务的运行状态。 要查看运行结果,单击结果按钮。 任务的状态可以是以下任一情况:
      • 已成功 - 任务已成功完成。
      • 执行中 - 任务当前正在运行。
      • 已失败 - 任务无法成功运行。 如果任务失败五次,则会完全停止。
      • 已跳过 - 任务已跳过,因为之前的运行还在进行。
    • 单击编辑以更改标题、参数或任务计划。
    • 单击暂停以暂停活动的任务。 暂停时,单击恢复以恢复任务。
    • 单击删除以移除任务。
      注:

      删除任务的同时也会删除该任务的运行历史记录。 要保留活动任务的历史记录,请考虑暂停任务以停止进一步运行。

更改 notebook 的所有权将同时更改该 notebook 任务的所有权。 任务将以非活动状态转移到新用户。 新所有者可以在 notebook 编辑器的任务窗格或者 notebook 项目页面的任务选项卡中启用这些任务。