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.

Open

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

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

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

Installation

It is important to check the compatibility of the different versions of each app.

• install Comala Document Management app – version 4.18.2 or above

• install 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

• install the free K15t Comala Document Management for Scroll Exporter – latest version

  • this app must be installed after the other two apps

For further information on version compatibility please 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:

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

Open

The export behavior is as follows

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 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:

• use the header or headertemplate parameter of the workflow macro, or

• use the pageheader or pagefooter macros

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.

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:

• Metadata references

• get-metadata macro

Custom templates

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

• Export only the last published versions of the pages

• Hide the workflow header and footer 

• Workflow placeholders

• Metadata placeholders

See also

Integration Guides

• Comala Metadata app

• Workflow Supplier

Workflow Authoring Guide

• Notifications

• Value References

External Links

• Product Documentation

• Vendor Website