Create a custom PDF template for any transaction

Introduction

Although we have default PDFs that perfectly highlight the details of your transactions, you may want to build your own template(s) to suit your business needs. Our report template editor provides you with the flexibility to customize your own transactions by allowing you to configure the layout and add graphics as well as other auxiliary features.

Accessing the report template editor

Go into settings from the top right-hand corner.

Under the reports & data card, you will find the report template editor option. 
 

 

Create a new template

Hit the add new button to create a new template.

  1. Add a name to the template
  2. Select the appropriate module for the template
  3. If you don't want to use the default template, you can always import your own template by hitting upload template
  4. Hit accept to create the template

Customize your PDF template

Once you accept, you can customize your PDF template however you would like. 

Note that we advise that you save in between any modifications you make by clicking on the save button next to the template name.

When you first create a new template, you will get the default template to start from. There are certain details (attributes) already included, which are the numerical, standard details of the transaction. These are the same details or fields or attributes you can see when you open the transaction module.
For instance, you will always see quote number or quote date as well as bill to and ship to for each individual quote. These features will auto-populate according to the individual transaction that you selected for the template.

If you do not want the title of this PDF to be the module name itself (quote in this example), you can double click on the text box to edit it. Note that this will be the name for any individual quote you apply this template to.

Delete attributes

If you do not want to keep these details - say, you do not want a due date on your template, you can click on the box and press backspace to remove it entirely. 

Add attributes

If you want to add an auto-populating field that you do not currently see on the default template, you can add it. You can select the prop or the type of figure you'd like from the left-hand sidebar.

From here, you can populate your figure or text box. Click on the text box or the given cells. You can manually type anything you want to have as a permanent addition to the template. Otherwise, you can click on the text box or the cell where you would like an auto-populating input and click on insert data field to navigate to the detail you would like to obtain information from. Through this, you can link an attribute to this cell so that the value of that attribute from that specific transaction will automatically populate.

The image below is of the pop-up modal you will get when you click insert data field. From here, you can choose the attribute you want to fill your figure with. Here, as an example, we have highlighted status. The temp next to it is dummy text, just as an example of a status. All the fields next to the attributes are dummy texts used to identify what the attributes are, just in case the attribute isn't clear (CAD, CAD being an example of a currency)

Adding date attributes

Enter YYYY-MM-DD\THH:mm:ss.SSSSZ in the input format box under formatting on the right-hand side:

Other acceptable date formats include: MM/DD/YYYY, YYYY/MM/DD, MMM-DD-YYYY, and    DD/MMM/YYYY

Please note that if the format is not added, the date attribute will not be printed. 

Adding line discount attributes

Right-click on a cell inside a line to insert a new column:

Here we have added a column for discounts:

  1. Double click to edit the new cell to display the value of the discount attribute
  2. Hit insert data field on the left panel
  3. Scroll down to Discount/List
  4. Select the discount attribute you want to display and hit insert data field

#amount displays the value of the discount attribute:

code displays the name of the discount attribute:

Adding box templates attributes

Open a packing list template

  1. Add a container to the template.
  2. Select the container (it must be highlighted in blue) and select boxes as the data field in the panel on the right.

3. Add a sample text box or a table inside the container. Make sure they are highlighted in blue.

4. Select the sample text element by double-clicking it (it must be highlighted in blue) and hit the insert data field button in the right-side panel.

5. A modal will be displayed. Make sure the search field is already filled with boxes.
6. Select the box attribute you want to display and hit insert data field to save your changes.

You can add several attributes (one at a time) inside the same sample text element. Repeat the above steps to do that.


If you have added a table instead of a sample text box, when you double click inside a cell and hit insert data field, make sure the search field is already filled with boxes::lines::

Print pictures

  1. Add the image component to the template
  2. Make sure the component is highlighted in blue or select it to highlight it
  3. Hit insert data field on the left panel
  4. Enter picture in the search field
  5. Select the appropriate value:

    To print the picture of my company, select the data: my_company > attributes > picture > value
    To print the picture of a customer or a vendor, select the data: company > attributes > picture > value
    To print the picture of an item, select the data: lines > item > attributes > picture > value

6.    Hit insert data field

You can see that the picture of my company from settings is displayed automatically to the default transaction templates.

Print items by line

  1. Open a transaction template
  2. Move the subtotal, discount, charges, tax and total table outside the lines container
  3. Move the image component inside the lines container
  4. Make sure they are highlighted in blue
  5. Select the image component
  6. Copy and paste the following text in the value field: {item::attributes::picture::value}
  7. Save the template

    Formatting your custom PDF

    There are more auxiliary features that can be added, as can be seen on the left-hand side. You can also format the template by using the bar on the top.

    Print barcodes

    1. Open the product template (for example)
    2. Add the barcode component to the template
    3. Select the barcode and hit insert data field
    4. Select the relevant data for your item (ie SKU, UPC...) and hit insert data field


    5. Save the template

      Print the source of each transaction line 

      To print the source of each transaction line, simply insert the field lines::source field in the template.

      Navigating the menu bar on the PDF template

      You can take various actions regarding your template using the menu bar at the top of the template.

      Import and Export

      Click on file. This will give you the option to import and export. (This article explains how to import custom pdf templates.)

      If you would like to download it in a certain format, there is the option to do so once you click on download as.

      Preview and edit modes

      You have the flexibility of flipping back and forth between preview and edit to check out how it looks as you're making modifications. Click on view and you will be able to do this.

       

      Rename or Delete your templates

      Once a template has been created, you can change the name of the template at any time with the rename/delete option at the top right corner of the PDF template screen.

      image

      Rename your template

      Clicking the rename option will open a modal allowing you to enter a new name for your template.

      image

      You will see a notification asking you to restart Paragon: 

      image

      Delete a template

      If a PDF template becomes obsolete or has been replaced, you can remove the unwanted template from the list by clicking the delete option. 

      image

      You will be shown a modal where you must confirm the deletion. 

      image

      If you confirm, you will see a notification asking you to restart Paragon. 

      What's next?

      Now that you've created your custom PDF output templates, you can configure where and when each template should be used in printing and/or emailing through the print and/or email action button.

      How to configure conditional custom PDF printing and emailing

      Add more options to the action button