Snapshots

The Snapshots tab allows users to manage the snapshots created. A snapshot is created from a Group (a collection of pages) and is stored in the Binary Store. It ia available for preview and publish. Its content cannot be changed.

Only owner of the snapshot can access them.

Module Interface

Interface Description Required Privilege
CMS Site Allow to publish Snapshot to CMS Site. mod-cms-site-publish
CMS Snapshot Allows preview of CMS Snapshots. mod-cms-snapshot
CMS Snapshot Allows to approve CMS Snapshots. mod-cms-snapshot-approve
CMS Snapshot Allow to edit CMS Snapshot metadata. mod-cms-snapshot-edit

Add Snapshot

This function allows you to add a new snapshot. A snapshot will take the pages and resources, and store them in a binary store.

To do so, click on the “Add” button at the upper right corner of the page.

The “New Snapshot” dialog box will appear.

Field Description Input Type Default Value
Name Unique name of snapshot. Text field Empty
Group Selects the group of the snapshot. Drop-down list First group in the list

Key in a unique name for the new snapshot in the “Name” field. Select the desired group of the snapshot from the drop-down list of the “Group” field. Click on the “OK” button to create the new snapshot.

If the name already exist, an error message will appear.

Edit Template

This function allows you to edit the properties and roles of a snapshot.

Click on the “Edit” icon under the “Actions” column corresponding the desired snapshot.

The “Edit” panel will appear.

Field Description Input Type Default Value
Properties
Name Unique name of the snapshot. Text field As per defined
Description Brief description of the snapshot. Text field Empty
Roles
Roles List of roles that are granted access to the snapshot. Checkboxes Not selected

In the “Properties” section, you can edit the properties of the snapshot. Make sure the name of the snapshot is unique.

In the “Roles” panel, you can select or deselect the roles that are allowed to access the snapshot. Alternatively, you can search for the role by using the search function at the top of the section. There are options to select all, select none and invert selection by clicking on their respective icons next to the search function.

Preview Snapshot

This function allows you to preview the snapshot.

To do so, click on the “Preview” icon under the “Actions” column corresponding the desired snapshot.

The snapshot will be displayed in another windows tab.

Delete Snapshot

This function allows you to delete a snapshot.

To delete a snapshot, click on the “Delete” icon under the “Actions” column corresponding the desired snapshot.

There is an option to undo the deletion. A notification with an “Undo” button appears right after clicking on the “Delete” icon.

Upon clicking on the “Undo” button, the deleted snapshot is restored and is added back to the list of snapshots.

Refresh

After performing actions on the browser/tab, the list is reloaded to display the list of snapshots. The manual “Refresh” button is available and is particularly useful if you have opened multiple pages and are making changes.

The “Refresh” button is found on the upper right corner of the page. Clicking on it reloads the list of snapshots.

Search

There is a cross-field search function for the list of snapshots. It is located at the upper left corner of the page.

This provides an easy way to search through the list of snapshots. It is case-insensitive and display snapshots that have the entered search value in any of the values of the fields below:

  • Name
  • Group
  • Snapshot Name
  • Owner
  • Roles
  • Last Modified