USER MANUAL

1. Introduction

Welcome to the SoftComply Static Snapshots app!

The SoftComply Static Snapshots app is a Confluence app that supports capturing and storing a static version of a Confluence page of your choice. This will help freeze the content of the page from a specific moment in time. 

2. Quick User Guide 

2.1 How to take a snapshot

You can take a snapshot of a Confluence page either from the SoftComply Static Snapshots app byline menu item on the page or by accessing the SoftComply Static Snapshots item from the More Actions menu of the page.

 

Take a snapshot with the Static Snapshots app from page byline menu

Take a snapshot with the Static Snapshots app by accessing the ‘More Actions’ menu of the page

2.2 How to view a snapshot

There are multiple ways in which you can view an existing static snapshot. 

  • You can view the snapshots by going to the Snapshots app page. All page snapshots can be seen from the Static Snapshots app main page. You can access the app main page from the left menu panel of the page.

  • For a quick view of the snapshot, you can access the snapshot of the page from the page byline menu.

 

  • You can also create a ‘Static Snapshots List’ macro on a Confluence page to have all the snapshots of the page displayed.

 
 
 

  • Finally, you can create a ‘View Static Snapshot’ macro on a Confluence page to see one snapshot of your choice at a time.

2.3 How to delete a snapshot

You can delete a snapshot only when you access the snapshots on the app page.

To delete a snapshot, you will have to access the snapshots from the app page on the left panel of the page.

2.4 How to add a snapshot to a Confluence page

You can display a specific snapshot to any Confluence page when you add a ‘View Static Snapshot’ macro on to the page. When you go to the edit mode of the macro you can search and add the snapshot of a specific space and page of your choice.

  • First, create a ‘View Static Snapshot’ macro on a Confluence page.
 

  • Next, go to the edit mode of the macro and you will see macro options on the right panel of the page. Choose any of the existing snapshots by searching for it based on a Confluence space, page and time when it was taken. If you want to have always the latest snapshot of a certain page displayed, you can enable ‘Show Latest’ checkbox. 

Once you have chosen the snapshot of the space and the page you wish to add to the macro on the page, be sure to press “Publish” on the page to update the macro.

2.5 How to Create a Confluence Page from a Snapshot

From the Static Snapshots app main page you can choose any of the existing snapshots and create a new Confluence page out of them.
 

 

This will create a new version of the Confluence page with the ‘View Static Snapshot’ macro in it.

2.6 Who can View and Take Snapshots – Permissions

Who can view a static snapshot?


If you can see a page, then you can see a snapshot!


Users with View All (i.e. view page) permissions in a specific space can see snapshots of all the visible/accessible pages.

If a page has restrictions then these same restrictions apply also to the viewing of the snapshots.

NB! The snapshot’s content is guarded with the Confluence page permissions and thereby the snapshots are visible to anyone who can see the page!

For example, when a snapshot’s original content includes data that are loaded from external sources which are restricted, then these external restrictions will not be applied to viewing the snapshot. Permissions for viewing the snapshot are the same as for viewing the Confluence page.

Who can take a static snapshot?


If you can edit the page, you can also take a snapshot!


Users with the Add Page permission can take a static snapshot.

NB! If you take snapshot of content from external sources like Jira issues, then after storing the snapshot, the Jira issues will be visible to anyone who has access to the snapshot!

Who can delete a static snapshot?


If you can take a static snapshot, then you can also remove it!


Users with Add Page permission can delete a snapshot.

Who can create a (new version of) Confluence page from a static snapshot?


If you can take a static snapshot, then you can also create a page from it!


Users with Add Page permission can create a new version of a Confluence page out of a static snapshot.