Use notebook snapshots

Notebook snapshots allow ArcGIS Notebooks authors to take configurable, point-in-time, full snapshots of a notebook. A maximum of five snapshots can be taken for a given notebook. Notebook snapshots are full copies of the notebook file JSON, preserved as resource files on the notebook item.

If you have the privileges to create notebooks, you can create and manage snapshots for a notebook in the Snapshots pane in the notebook editor. When creating a snapshot, you can provide a name and a description for the snapshot. By default, a snapshot name will include the notebook title and the time the snapshot was taken.

Note:

A maximum of five snapshots is allowed for a single notebook. The option to create a new snapshot is unavailable once this limit is reached. Additional snapshots cannot be created unless one or more of the existing snapshots is deleted.

Create a snapshot of your notebook

When your notebook is ready, you can create a snapshot of its current state. In the Snapshots pane in the notebook editor, create a snapshot by completing the following steps:

1. Save your notebook with a title, if you haven't already.
2. On the top ribbon of the notebook editor, click Snapshots.
3. Click Create Snapshot to open the dialog box.
4. For Name, provide a name to describe the snapshot.

   By default, the snapshot name will include the notebook title and the time the snapshot request was initiated.

5. Optionally, provide a description for your snapshot in the Description text box.
6. Click Create.

Work with existing snapshots

Once a snapshot of your notebook has been created, you can generate a preview, preview, restore, download, or delete the snapshot. These options are available in the Snapshots pane of the notebook editor or from the Snapshots tab of the notebook's item details page.

The Generate preview option is available for snapshots that do not have an existing preview. Once a preview has been generated, you can preview the notebook associated with that snapshot.

Click the name of the notebook snapshot or use the preview option to preview the notebook associated with a snapshot.

1. Open the notebook that contains snapshots.
2. On the upper ribbon of the notebook editor, click Snapshots.
3. Click the Options button for the snapshot you want to work with and do any of the following:
   • Click Restore to revert the existing notebook to the state of the chosen snapshot.

     Note:

     Restoring a notebook from a snapshot reverts the notebook to the state of the chosen snapshot. To save a copy of the notebook's current state, you can create a new snapshot or save the notebook as a new notebook item.
   • Click Download to download the snapshot as a notebook file (.ipynb) for offline use.
   • Click Delete to delete the snapshot.

If you open a shared notebook, you cannot view or manage snapshots for that notebook. When you make a copy of a notebook you own or that is shared with you that contains snapshots, those snapshots are not copied to the new notebook.