---
title: "K15t Scroll PDF Exporter app"
canonical: "https://support.appfire.com/space/CDML/649923655/K15t%20Scroll%20PDF%20Exporter%20app"
format: markdown
---
> Macro (aura-html)


## 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.

![image](media://dcf5892d-0cbe-4f95-b1c3-10f5a24b82ac)

You also need the [K15t Comala Document Management for Scroll Exporter](https://marketplace.atlassian.com/plugins/k15t-comala-workflows-for-scroll-exporters/server/overview) app.

> 📝 If you are using earlier releases of the K15t Scroll PDF Exporter, please refer to the [K15t Scroll Exporters](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649531097) 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](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649825151)**** **– version **4.18.2 or above**
- **[K15t Scroll PDF Exporter](https://marketplace.atlassian.com/plugins/com.k15t.scroll.scroll-pdf/server/overview)**** **– version **[4.0.12](https://help.k15t.com/scroll-pdf-exporter/latest/scroll-pdf-exporter-4-0-12-132319258.html)**** or above**
  - to use the **header/footer option**, you will need version **[4.0.16](https://help.k15t.com/scroll-pdf-exporter/latest/scroll-pdf-exporter-4-0-16-134487179.html)**** or above**
- **[K15t Comala Document Management for Scroll Exporter](https://marketplace.atlassian.com/plugins/k15t-comala-workflows-for-scroll-exporters/server/overview)**** **– 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](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649794062) in Comala Document Management, you can define a final 'published' workflow state using the [final=true parameter](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649531575). 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
4. Select **Export only the last published versions of the pages**

![image](media://8497152f-5463-4da6-bf43-fc23e3848c23)

The export behavior is as follows

| Option selected? | Effect |
| --- | --- |
| :check_mark: | Only content published to the `final=true` workflow state is exported |
| :cross_mark: | The latest version of all content is exported, regardless of workflow state |

## Workflow event

You can use the [pdf-export macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649955790) to create a PDF file of the current page <span style="color: #172b4d">in response to a workflow event.</span>

> ℹ️ 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.

> 📝 <span style="color: #172b4d">The </span>[pdf-export](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649955790)<span style="color: #172b4d">[ macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649955790)</span><span style="color: #172b4d"> is only supported when it is used with K15t Scroll PDF Exporter</span>** 4.10.1**<span style="color: #172b4d">**1**</span><span style="color: #172b4d"> or higher</span>

The following workflow [events](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649759655) are associated with `pdf-export`

- `pdf-export-success`
- `pdf-export-error`

These can be used in a workflow [trigger macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649859133).

## 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](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649662219), or
- [pageheader](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650348817) or [pagefooter](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650251276) macros

The PDF export includes 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**

![image](media://19dad737-c7c1-4618-ae5a-18d00dd3121b)

## Workflow placeholders

The following workflow placeholders can be used in your [custom export templates](https://help.k15t.com/scroll-pdf-exporter/latest/customize-document-sections-121932316.html).

| 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](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650251172):

- Use the macro to store [value references](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694302) 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:

- [Metadata references](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649925583)
- [get-metadata macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649826804)

## Custom templates

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

- [https://help.k15t.com/scroll-pdf-exporter/6.0/server/create-and-manage-custom-templates](https://help.k15t.com/scroll-pdf-exporter/6.0/server/create-and-manage-custom-templates)
- [https://help.k15t.com/scroll-pdf-exporter/6.0/server/define-template-settings](https://help.k15t.com/scroll-pdf-exporter/6.0/server/define-template-settings)
- [https://help.k15t.com/scroll-pdf-exporter/6.0/server/customize-document-sections](https://help.k15t.com/scroll-pdf-exporter/6.0/server/customize-document-sections)
- [https://help.k15t.com/scroll-pdf-exporter/6.0/server/modify-export-behavior](https://help.k15t.com/scroll-pdf-exporter/6.0/server/modify-export-behavior)

## Related pages

- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/649956848](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649956848)
- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/649726882](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649726882)
- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694302](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694302)

**External Links**

![image](media://e887fc7f-8a81-4dc7-886b-4fc5f4bc826c)

- [Atlassian Marketplace](https://marketplace.atlassian.com/apps/7019/scroll-pdf-exporter-for-confluence?hosting=datacenter&tab=overview)
- [K15t website](https://www.k15t.com/)