Skip To Content

Automate notebook execution

Administrators can automate a notebook to run without user control. ArcGIS Notebook Server performs automated execution by opening a new container and running the notebook in its entirety.

By combining automated notebook execution with a third-party scheduling tool, you can schedule notebooks for automated execution at a fixed time in the future, either once or on a recurring basis. Scheduling notebooks allows you to automate routine tasks, run data-intensive processes off peak usage hours, and regularly update datasets. For example, you can schedule a notebook to do the following:

  • Import data from an online source that updates monthly, automatically clean the data and apply necessary transformations, and move the data to your workspace.
  • Execute a big data analysis workflow that requires heavy processing power overnight, when your machine resources are otherwise unused.
  • Manage users who have created accounts in your portal during the past week and email the list to you.

Automated execution is done by the Execute Notebook operation in the ArcGIS Notebook Server Administrator Directory; only administrators can schedule notebooks at 10.8. This operation executes the notebook immediately, but by scripting the operation, you can schedule automated execution to occur at a future time or on a regular schedule. You can use a cron job to schedule the execute operation for a future time or recurring time interval.

The Execute Notebook operation launches a new container and runs the notebook in the container. If you so choose, the executed notebook can be saved as the notebook's portal item after completion. You can also specify parameters to be added into the notebook in a new cell and to optionally save that new cell in the notebook.

Note:

To use automated execution, the notebook must be using a 10.8 runtime.

To begin, see the Execute Notebook topic in the Administrator Directory reference guide.