Overview
The snapshot-page macro is used to publish a static version of a document. The macro
creates a snapshot of the page
links the snapshot to one or more collections
Comala Publishing must be installed to use the snapshot-page macro
Where to use it?
Optional
One or more snapshot-page macros can be put in a trigger macro.
The snapshot-page macro is available in Comala Document Management v6.17.6+ together with Comala Publishing v3.0+
Parameters
Parameter | Required | Default | Notes | Ver |
|---|---|---|---|---|
|
| none | Name of the snapshot collection where the snapshot document is published
If the collection doesn't exist the macro will create the named collection(s). | |
| Name of the snapshot contributor for the named collection. The contributor is the user who will be set as the the creator of the snapshot document version.
| |||
When using Confluence v7.19 or earlier, you must configure global snapshot publishing in Comala Publishing to set a user and a token to enable integration with Comala Document Management and the functionality of the snapshot-page macro. | ||||
A snapshot created with a trigger specifying a collection that does not exist (or a collection for which the user does not have contributor permission) will be added to the space default Unassigned collection.
A warning message is also displayed on the page. For example, if the mine collection does not exist.
Snapshot event reference
The URL for the location of the created snapshot document is added as a value to the event reference @snapshoturl@ and can be used as a value reference. For example, in a set-message action macro body content.
{trigger:statechanged|state=Done}
{snapshot-page:collection=Uncontrolled Internal Repository|editor=@user@}
{set-message:duration=1m}
Document finished @datetime@. Static snapshot added to the Uncontrolled Internal Repository.
This can be viewed [here|@snapshoturl@] or by choosing the View option in the popup accessed using the snapshot byline on the page.
{set-message}
{trigger}
The value for @snapshoturl@ is a URL for the snapshot document in the named collection viewed through the collections global viewer. For example
https://myconfluence.com/snapshots/collections/viewer/global.action#!4e48c108-68d7-4727-b72a-fc5cc972cdc3/151948182
Example
{trigger:statechanged|state=Published}
{snapshot-page:collection=Published Documents Record|editor=@snapshotpublishinguser@}
{trigger}
Publishes snapshot of the Confluence document version on a transition to the workflow Published state. The snapshot is added to the Published Documents Record collection.
The editor (contributor of the snapshot document version to the collection) is the value of the user workflow parameter @snapshotpublishinguser@.
The user must have contributor permission for the named collections.