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 or no name is provided, the relevant error message will appear.

Once the new snapshot has been created, an unique ID is created with the format <group-name>-<unique-ID>.

Edit Snapshot

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 Snapshot” dialog box will appear.

Field	Description	Input Type	Default Value
Name	Unique name of the snapshot.	Text field	As per defined
Description	Brief description of the snapshot.	Text field	Empty

Edit the name and description of the snapshot. Make sure the name of the snapshot is unique. Click on the “OK” button to save the snapshot.

If the name already exist or no name is provided, the relevant error message will appear.

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.

Do note that some components may be excluded from the snapshot by unselecting the “Publish” field in their properties.

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.

A dialog box will appear to prompt user to confirm the deletion.

To confirm the deletion, click on the “OK” button. To abort, click on the “Cancel” button.

More Actions

This feature allows user to perform actions on multiple snapshots at the same time.

When the “More Actions” button located at the upper right corner of the page is clicked, a list of available actions are displayed.

If no snapshot is selected prior clicking the button, there will be fewer actions available. To select a snapshot, select the checkbox next to the name of the snapshot.

Option	Description
Select All	Selects all snapshots in the list.
Select None	Unselects all snapshots.
Invert Selection	Inverts the current selection. That is, any snapshots selected will be unselected and vice versa.
Set Roles	Selects the roles to be assigned to the snapshots.

Set Roles

To set the roles for the selected snapshots, click on the “More Actions” button and select the “Set Roles” option. The “Set Roles” dialog box will appear.

Select the roles to have access to the snapshots by selecting the checkboxes. Alternatively, you can search for the desired role by keying in the keyword in the search function at the top of the dialog box. You can also choose to select all, select none or invert selection by clicking on their respective icons on the right of the search function.

Click on the “OK” button to save the changes or click on the “Cancel” button to abort the action.

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

Alternatively, you can click on the any group, owner or role under the “Group”, “Owner” or “Roles” columns respectively to aid the search for the sites in the page.

In the example above, snapshot that belongs to the group “I18N Group” is shown.

These two search methods can be combined together, with each criteria separated by a comma.