Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Required

Default

Notes

Ver

collection

(tick)

none

Name of the snapshot collection where the snapshot document is published

  • snapshot collection must be linked to the current space in the space tools snapshot publishing dashboard

  • supports the use of value references including workflow parameters

If the collection doesn't exist the macro will create the named collection(s). 

v6.17.6

editor

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.

  • if the parameter is not used, the current user is set as the contributor for the snapshot document version created

  • supports the use of value references including workflow parameters

{snapshot-page:collection=@Worfklow Parameter@|editor=@lastApprover@}@user@}

Info

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.

Code Block
{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

Code Block
https://myconfluence.com/snapshots/collections/viewer/global.action#!4e48c108-68d7-4727-b72a-fc5cc972cdc3/151948182

Example

Code Block
{trigger:statechanged|state=Published}
    {snapshot-page:collection=Published Documents Record|editor=@snapshotpublishinguser@}
{trigger}  

...