Skip to main content

PDF Templates

This module allows you to create document templates. In the future, based on these templates, PDF documents or emails can be created, in which the necessary data from KiyoCRM will automatically be added during the merge process.

Creating a PDF Template

  1. In the module menu, select the option "Create PDF Template".
  2. In the Edit Form fill in the following fields:
PDF Template: 

Specify the name of the template being created.

Assigned to:

Please enter/ select the name of the Assigned to user of this template.

Type: 

Here you should select the type of document to be created based on this template. By default, the system suggests creating templates for the following documents: Quotes, Invoices, Contracts, Contacts or a Lead.

Note: When adding a new item to the combo box list pdf_template_type_dom, the name of the key to be added must match the module name. In the following example, the item Prospects is added to the list.
Detailed information on adding a new element to the combo box is described in the Developer Tools page.

Load Sample

The system Quotes several options for ready-made templates, if necessary.

Active

An option that determines whether the current template will be offered in the list of templates when creating a document (see the section below, Creating PDF Documents Based on a Template),

Page Size/ Orientation

If necessary, select the size and orientation of the template page. Then default is A4 size and portrait page orientation.

Inserting into a Field

This option allows you to add the necessary variable to the template, which later (in the process of creating a document based template) will be replaced with the necessary data from the KiyoCRM+

To insert a variable:
  • In the left combo box, select the module from which you want to get information.

  • In the middle combo box, select the name of the field of the selected module, then the name of the necessary variable corresponding to the selected field, so it appears in the right field.

  • In the text of the template, specify the place where the selected variable should be added and click the button Insert.

The following picture shows an example of adding the variable $aos_invoices_number, which, when creating the document based on the current template, will be automatically replaced with the account number.

image.png

If it is necessary to add data in the template, for example, listing positions in the Offer or Invoice, then such data should be arranged in a table:

image.png

Creating Headers and Footers

At the bottom of the Template Editing Form are two fields that allow you to customize the header and footer for the current template:

image.png

Footers are able to use special variables:

  • {PAGENO}, Showing the current page number.

  • {DATE D.m.Y}, Showing the current date in the required format

Setting Page Parameters:

Under the header and footer there are several fields that allow you to customise different page parameters, such as the size of the indents from the page edges of the header and footer fields: