计划笔记本任务

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

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

如果要准备自动执行的笔记本(例如定期执行),则需要牢记一些注意事项。

准备笔记本

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

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

内容注意事项

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

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

注:

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

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

创建任务

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

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

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

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

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

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

    添加至少一个参数后,将参数保存至笔记本选项随即出现。 如果选择已启用,则在运行时,随新参数插入的单元格将被保存到笔记本中。

    如果您之前使用参数选项设置了输入参数,则会自动为任务填充这些参数。 您可以添加、删除或更新任何特定于此任务的参数。 这样做不会更改使用参数选项配置的 Notebook 的默认参数。

  7. 单击下一步
  8. 设置任务计划详细信息页面,指定任务的计划。

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

  9. 使用完成时更新 Notebook 切换按钮以选择在每次运行后保存 Notebook。 如果要使用每次运行的结果来更新笔记本,请打开此切换按钮。 如果您不希望笔记本自动更新,则关闭切换按钮。
  10. 可以选择单击高级以输入任务可以运行的最大分钟数。
  11. 当您对标题、可选参数和任务计划感到满意时,请单击创建任务

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

如果您希望设置多个计划,则可以使用相同的工作流为笔记本创建更多任务。 在您所拥有的所有笔记本上,最多可以同时执行五个任务。 当已经有五个任务正在进行时,计划开始的任务会标记为失败。

使用现有任务

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

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

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

更改笔记本的所有权将同时更改该笔记本任务的所有权。 任务将以非活动状态转移到新用户。 新所有者可以在笔记本编辑器的任务窗格中启用这些任务,也可以在笔记本项目详细信息页的任务选项卡中启用。