K15t Scroll PDF Exporter app

Overview

K15t Scroll PDF Exporter

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

You also need the K15t Comala Document Management for Scroll Exporter app.

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

Features

This integration lets you:

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

For any of these features to work, a Comala Document Management workflow must be applied to some or all of the pages you are exporting.

Installation

It is important to check the compatibility of the different versions of each app. You should install:

Comala Document Management app – version 4.18.2 or above
K15t Scroll PDF Exporter – version 4.0.12 or above
- to use the header/footer option, you will need version 4.0.16 or above
K15t Comala Document Management for Scroll Exporter – latest free version
- this app must be installed after the other two apps

For further information on version compatibility, refer to the K15t product documentation.

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:

Choose Export to PDF from the page tools menu option
Choose Show Details > Content
Scroll down to the Comala Document Management section
Select Export only the last published versions of the pages

Exporting PDF - Export only the last published version of pages - option checked

The export behavior is as follows

Option selected?	Effect

Option selected?	Effect
	Only content published to the `final=true` workflow state is exported
	The latest version of all content is 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 when it is used with K15t 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 macro.

Workflow headers and footers

Comala Document Management can be configured to add a header and/or footer to content in two ways. You can use the

header or headertemplate parameter of the workflow macro, or
pageheader or pagefooter macros

The PDF export includes the headers and footers by default.

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

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

Exporting PDF - Hide the workflow header and footer - option checked

Workflow placeholders

The following workflow placeholders can be used in your custom export templates.

Name	Notes

Name	Notes
Workflow State Comment	The comment provided when transitioning the root page into another workflow state without an approval.
Workflow State Date	The date when the root page was transitioned into the current workflow state. The output format is customizable.
Workflow State Description	The description of the workflow state of the root page in the workflow definition.
Workflow State Content	The content revision that the current workflow state of the root page refers to.
Workflow State Username	The name of the user who transitioned the root page into its current workflow state.
Workflow State Name	The name of the workflow state of the root page.
Workflow State is Public	Indicates 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:

Use the macro to store value references or static values as metadata
Store the metadata 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 that 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 K15t Scroll PDF Template Editor.

Related pages

External Links