Versions Compared

Key

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

...

Requires Comala Document Management v6.17.6+

Excerpt
namecp_snapshot_wf

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 to enable snapshot publishing in a space

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

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

Workflow markup

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

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

The user must have been added as a collection contributor to the collection permissions by the user who created the collection.

Info

For snapshot publishing all the work is done by the snapshot-page macro. The snapshot-page macro can be used to publish the content from any state using an appropriate trigger event. 

...