Nuxeo Tree Snapshot

Updated: June 10, 2024

Nuxeo Tree Snapshot enables to snapshot and version a whole folder and its content in a single step. You can then recover the state of a folder for a given version.

Nuxeo Tree Snapshot with Nuxeo Web UI
The default button to perform a tree snapshot is exposed in Nuxeo JSF UI. You can perfectly use it in Nuxeo Web UI too, by creating a button in Nuxeo Studio Designer, linked to the Document.CreateTreeSnapshot operation.


This addon requires no specific installation steps. It can be installed like any other package with nuxeoctl command line or from the Marketplace.

If you are working on JSF UI (DEPRECATED), make sure to install the JSF UI version of this addon, available here.

Using Nuxeo Tree Snapshot

The addons adds a new document type, Versionable folder, which can be created in Workspaces.

Versionable folders can be published, using the regular Publish tab. When it is published a new version of the folder is automatically created and available in archived versions. The content of the versionable folder is published at the same time, and if needed versioned.

In the versionable folder History > Archived versions tab you can use the regular archived versions actions (View archived version and Restore).

Customization and Configuration

Although the addon adds by default a versionable folder, most of the time you will want to integrate the feature with your own data model, in Nuxeo Studio.

To adapt the default addon behaviour, make sure that you have selected Nuxeo Tree Snapshot as target package in Application Definition menu. This will automatically expose in Nuxeo Studio:

  • The Snapshotable and Snapshot facets.
  • The Document.CreateTreeSnapshot in your automation chain/scripting, in the Document category.
    • The versioning option parameter of the operation is expecting either MINOR or MAJOR depending on the version that should be applied on all components of the snapshot.