PDF Template Settings

Configuration > Reporting > PDF Templates

Related Guides:

• PDF Templates

Details#

Field	Type	Description
Name	Free Text	Name of the report
Type	Entity Chosen	After clicking into the PDF Templates module, there will be a dropdown in the top left to decide which entity the PDF template will be created for. The entity chosen will then be the type of report, certain $-Variables will only work for specific entity types, i.e. the invoice $-Variables will work for a PDF Template Entity Type: Invoice Note: If there are $-Variables that don't appear to be working correctly, then the entity chosen may not be compatible with the $-Variable being used. It is also important to note that if trying to generate a PDF from the template screen with entity type invoice, then the last invoice used will be the invoice displayed on the template. PDF's can also be generated from the entity areas as well, i..e there is an action to generate PDF's at the top of each invoice screen. The PDF template can also be changed by scrolling down the sidebar on the right and changing it on the dropdown "PDF Template" (At the very bottom of the sidebar).
File Type	Single Select	Only available for entity type "Tickets". You can select between a PDF or an XML file type here. Changing the file type will overwrite the PDF pages/XML attachments.
Description	Free Text	You can input a description of the report in this text box
PDF to prepend to this PDF	Input Box	You can drag and drop a pdf into this box and it will be prepended to the report.
Append rather than prepend the above template	Checkbox	When selected, the chosen Pdf will be appended to the report (attached at the bottom), the default behaviour is that the Pdf is prepended.
Attachment filename override	Free Text	When an attachment is created after generating i.e. a PDF on a ticket, the name given to the attachment will be what is set in here. $-variables are accepted, make sure that the entity you are generating the pdf from will accommodate for the dollar variable's you use. Checkout this guide for finding different dollar variables: Guide
Reports	Table	When i.e. the entity for the PDF Template is "Tickets" this option will appear, you can add reports to this table, which can then be added to the html of the lines within the Pages Tab. If I wanted to show the report for one of the report tables lines, I would i.e. add in to the html <p>$REPORT51DATA</p>

Appearance#

Field	Type	Description
Colour	Single Select	Use the colour of the organisation or you can choose a colour. This colour will apply to the tables added to the report. If custom is selected you can choose from a colour palette or add in a hexcode to the hashtag.
Orientation	Single Select	Portrait or Landscape can be chosen
Margin	Float	You can set a margin size for all of the pages on the document, this will not apply to the appended/ prepended pdf pages.
Include Header	Checkbox	When selected, headers will appear at the top of all pages, this will not apply to the appended/ prepended pdf pages. Dollar variables don't work in here.
Use HTML Header	Checkbox	When selected, there will be an HTML input where you can add in a custom header i.e. images can be added using standard HTML formatting. Header height can also be set. Dollar variables do work in here.
Include Footer	Checkbox	When selected, footers will appear at the bottom of all pages, this will not apply to the appended/ prepended pdf pages. In the three boxes (left, centre, header) you can add i.e. {page} of {total-pages}. Dollar variables don't work in here.
Use HTML Footer	Checkbox	When selected, there will be an HTML input where you can add in a custom header i.e. images can be added using standard HTML formatting. Header height can also be set. Dollar variables do work in here.
Background Image Url (All pages)	URL	Add the URL of an image in here to be the background of all pages.
Override page width (inches)	decimal (1dp)	If not set or set to 0, it will take the standard A4 format.
Override page height (inches)	decimal (1dp)	If not set or set to 0, it will take the standard A4 format.
Media Type	Single Select	Can select Print or Screen. Best to leave on the default option if unsure.

Pages#

Field	Type	Description
Name	Free Text	Name of the page, only visible for the agents editing the template. Can be changed by editing the line item.
Sequence	Free Text	Sequence of the page, only visible for the agents editing the template. Can be changed by editing the line item. This determines the order in which pages show on the pdf. Sequence: 1 will be the first page on the pdf.

Add +#

Field	Type	Description
Is the cover page	Checkbox	When selected, this page will not include headers or footers that have been set in the template. A background image URL specifically for the cover page can also be set if this checkbox is selected.
View $-variables	Button	When clicked on, you can view a list of dollar sign variables that can be placed anywhere on HTML templates.
Core Template HTML	HTML Code	Enter the HTML for the page. If the amount of HTML is more than one page, then it will spill over to another page.

Details Table/ Items Issued Table#

Field	Type	Description
Show the Item primary image alongside the line description	Free Text	For Entity Type: Quotations You can add the primary image from the image tab of a product. It will show beside the line description of the product. Add The 'Description' Field to the Choose fields section.
Choose Fields	Single Select	You can choose what fields show against the i.e. table of products on the Quotation PDF. Such as Quantity, Price, Description, Item Name, etc...