Snapshot document publishing

Activating snapshot publishing

There are three steps to setting up snapshot publishing to take place on a Comala workflow event:

1. Install Comala Publishing to your instance and enable snapshot publishing for a space

2. Set up snapshot publishing in your space tools snapshot publishing dashboard

3. Update your workflow to trigger the snapshot publishing process and apply to your documents(see below)

Publishing a snapshot using a workflow trigger

A snapshot can be published using

• the snapshot-page macro to create a snapshot that is added to a specified snapshot collection

• the pdf-export macro to create a snapshot that is added to the page as an attachment

Snapshot-page action trigger workflow markup

The publishing is triggered by an action macro, snapshot-page, which must be used in a trigger.

{workflow:name=Snapshot Publishing}
   {state:Editing|submit=Review}
   {state}
   {state:Review|approved=Published|rejected=Editing}
      {approval:Review|assignable=true}
   {state}
   {state:Published|final=true|updated=Editing}
   {state}
   {trigger:statechanged|state=Published}
      {set-metadata:lastapprover}
      @user@
      {set-metadata}
      {snapshot-page|collection=@collectionname@|editor=@lastapprover@}
   {trigger}
{workflow}

The example markup above based on the example from same-space publishing, but we've added the trigger at the bottom.

When the state changes to Published, the trigger is activated and the snapshot-page macro instructs the Comala Publishing app to create a snapshot document from the Confluence document.

• the collection parameter is required to add the snapshot to a named collection. The example uses a workflow parameter value reference @collectionname@ for the value of this parameter

• the editor parameter adds the user who be set as the creator of the snapshot. The example uses a metadata value set on transition to the Published state for the value of this parameter

pdf-export action trigger workflow markup

With Comala Publishing installed, the pdf-export macro can be used as an action to export a snapshot of page or blog post in PDF format and adds the pdf to the page as an attachment.

The pdf is added with a filename in the following format:

• <confluence_filename>_<document_version>_<date_pdf_file_created>_<time_pdf_created>.pdf

{trigger:statechanged|state=Published}
      {pdf-export}
{trigger}

There are no macro parameters to configure.