Skip to main content

How to create a PDF Template

Alex Hom avatar
Written by Alex Hom
Updated this week

PDF Templates are portable documents that you can create within the application to showcase your data in a polished file. Users can build reusable templates that output their data in a .pdf within a Document.


  1. Click Add PDF Template

    1. Name

    2. Description

    3. Source

    4. Type

  2. Click Create PDF Template

  3. Click on the Name or See All Settings to edit

Editor

The PDF Template Editor has a standard ribbon for editing and creating the template. Users have the option to include Document data by writing field signatures similar to Email Templates. Dynamic tables can be inserted to reference the fields of the associated Document Type in a formatted table.

Field Signatures

Information stored within Documents can be referenced within a PDF Template. Templates that use these fields will display the data of the fields (in reference to Document where the PDF is being generated from) within the file output.

Templates for Job types will contain all fields used within the job type. Templates for Task Types will contain fields being used in the task as well as fields used within the Task Type’s Job Type. Both configurations will allow a default set of fields to reference called System Fields.

  • Writing a ' / ' (forward slash) will display options for inserting Fields

    • Field signatures are written as the Field Label within two curly braces β€œ{{ }}” and start with the Source of the field.

      • Example: {{ Job.FieldName }} , {{ Task.DateInfo }}

  • System Fields are written as their name

    • {{ Job ID }} , {{ Task ID }}

    • {{ Name }}

    • {{ Created At }}

    • {{ Updated At }}

    • {{ Status Name }}

    • {{ Assignee }}

    • {{ Type }}

    • {{ External Identifier }}

Insert

PDF Templates can include elements outside of plain text via the 'Insert' ribbon. Inserts are useful for organizing your document and adding visual content to supplement the information in your template.

Horizontal Rule

Horizontal Rule is a visual element (displayed as a horizontal line across the PDF) that breaks or separates information.

Image

Images inserted into the PDF Template can be resized within the PDF. Users are presented a modal to drag and drop files or manually browse for them.

Table

Creates a structured grid of rows and columns. Users can select the number of rows and columns for a table when selecting this option.

Tables and cells of tables can be modified by clicking the top right corner of any cell within the table. Data set within a table's cells can utilize fields from a Document by following Field Signatures.

Page Break

Page Breaks are formatting markers that divide information in a template onto new pages.

Dynamic Tables

Dynamic Tables are adjustable tables that reference fields within a Document. It creates tables with the option for a Header, allows the users to select fields from the document or system fields, and has a drag and drop system for arranging fields.

  1. Click Insert

  2. Click Dynamic Table

Note: Tables that span more than one page require the 'Toggle First Row Freeze' in order to maintain the Table Headers across all pages

Did this answer your question?