Overview

export content as a pdf 

The {pdf-export} macro is used as an Action to export a page or blog post in PDF format and adds the pdf to the page as an attachment.

A parameter can be added to specify a PDF template to be used for the export. This parameter value will be a K15t Template Name or K15t Template ID value sourced from the K15t Scroll PDF Exporter app template information.

For more information, see: Integration Guides > Content Integrations > K15t Scroll PDF Exporter App

Requirements

You must install the K15t Scroll PDF Exporter app in order to use this macro. 

If the K15t Scroll PDF Exporter app is disabled or not installed, then the macro is ignored.

If you wish to export only content that is in a Comala workflow final state then you must install the Comala Document Management for Scroll Exporter app (it is free but it can only be installed after K15t Scroll PDF Exporter and Comala Document Management have been installed).


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

Where to use it?

Optional

The {pdf-export} macro can be put in a {trigger} macro.

Parameters

Parameter

Required

Default

Notes

template

No

Blank

If the template parameter is not specified, the bundled 'Documentation' template is used.

Value can be one of:

  • Template Name
  • Template ID

K15t recommend this parameter value to be added as the template id. The template ID is found in the K15t Scroll PDF Exporter dashboard.

If the specified template is not recognized, the exported pdf will use the bundled 'Documentation' template (default template).


Note that use of the template parameter in the {pdf-export} macro is only available with Comala Document Management 6.13 or higher.


Setting a template to use for export

To specify a template, use the template name in the {pdf-export} macro as shown.

{pdf-export:template=Article}


K15t recommend the use of the template ID.

You can find the value of the template ID by accessing the K15t Scroll PDF Exporter dashboard


If you have created or downloaded a new pdf template in the K15t PDF Exporter app the template id will be a slightly different format to the K15t app supplied templates.


Copy the hexadecimal template id from the Template Information.


Paste the template id into the pdf-export macro in the trigger.

{pdf-export:template=4e0e8c19-67ac-4f3e-864e-1090d5ae0556}



Basic example

{workflow:name=Export PDF on Approval}
   {state:Editing|submit=Review}
   {state}
   {state:Review|approved=Approved|rejected=Editing}
      {approval:Review}
   {state}
   {state:Approved|updated=Editing|final=true}
   {state}
   {trigger:statechanged|state=Approved}
      {pdf-export}
   {trigger}
{workflow}


The statechanged event for the transition to the Approved state will add a pdf export of the current content as a file attachment to the current page. If no template name of id is specified the K15t PDF Exporter app uses the default template.



The exported pdf filename by default is generated as

The K15t admin can change the export filename structure.

If the K15t app is unable to recognize a template id or name

Events

The following Events are associated with pdf-export

Example

{trigger:pdf-export-success}
	{set-message:style=success|duration=PT1M}
	pdf export successfully completed
	{set-message}
{trigger}
{trigger:pdf-export-error}
	{set-message:style=warning}
	pdf export failed. @errormessage@
	{set-message}
{trigger}

See Also