Overview

This page describes an enhanced integration between the Scroll PDF Exporter (version 4.0.12 and above) and Comala Document Management.

If you are using earlier releases of the Scroll PDF Exporter, please refer to the K15t Scroll Exporters integration guide instead.

Features

This integration allows you to:

  • Choose whether draft content is exported or not
  • Choose whether workflow headers and footers are exported or not
  • Embed workflow placeholders in exports
  • Embed workflow metadata in exports
  • Configure your custom export templates to use any of the features listed above

Note: A Comala Document Management workflow must be applied to some or all of the pages you are exporting for any of these features to work.

Installation

Workflow published state

When using Same-space publishing in Comala Document Management, you can define a final 'published' workflow state using the final=true parameter. This causes all other workflow states to be considered 'unpublished' drafts.

The PDF export will include the latest versions of all content, regardless of workflow state, by default.

To instruct the Scroll PDF Exporter to only export the published versions of content:

  1. choose Export to PDF from the page tools menu option
  2. choose Show Details > Content
  3. Scroll down to the Comala Document Management section and select Export only the last published versions of the pages


The export behavior is as follows

Option selected?Effect
(tick)Only content published to the final=true workflow state will be exported
(error)

The latest version of all content will be exported, regardless of workflow state

Workflow event

You can use the {pdf-export} macro to create a pdf file of the current page in response to a workflow event.

The pdf file is added as an attachment to the current page.

A template parameter with a value of the template id or template name can be added to the macro to specify the pdf template to use.

The {pdf-export} macro is only supported if used with Scroll PDF Exporter 4.10.11 or higher

The following workflow Events are associated with pdf-export

  • pdf-export-success
  • pdf-export-error

These can be used in a workflow trigger.

Workflow headers and footers

Comala Document Management can be configured to add a header and/or footer to content in two ways:

The PDF export will include the headers and footers by default.

To instruct the Scroll PDF Exporter to omit the workflow headers and footers:

  1. choose Export to PDF from the page tools menu option
  2. choose Show Details > Content
  3. Scroll down to the Comala Document Management section and select Hide the workflow header and footer

Workflow placeholders

The following Comala Workflow placeholders can be used in your custom export templates:

NameNotes
Workflow State CommentThe comment provided when transitioning the root page into another workflow state without an approval.
Workflow State DateThe date when the root page was transitioned into the current workflow state. The output format is customizable.
Workflow State DescriptionThe description of the workflow state of the root page in the workflow definition.
Workflow State ContentThe content revision that the current workflow state of the root page refers to.
Workflow State UsernameThe name of the user who transitioned the root page into its current workflow state.
Workflow State NameThe name of the workflow state of the root page.
Workflow State is PublicIndicates whether the current workflow state of the root page is in a public state.

Metadata placeholders

In a Comala Document Management, you can save metadata to a page using the {set-metadata} macro:

  • You can use the macro to store Value References or static values as metadata
  • The metadata must be stored on the root page of the content you are exporting to PDF

You can embed the metadata in a Scroll PDF template:

  • Open your PDF template and insert a Metadata placeholder
  • In the Metadata key field enter the metadata key which you used in your {set-metadata} macro

Metadata can also be accessed in your workflows and content – for more information, see:

Custom templates

You can apply any of the features listed above by configuring your custom export template in the Scroll PDF Template Editor.

See also

External Links

Integration Guides

Workflow Authoring Guide