PDF Maker for vtiger 7

  1. Introduction
  2. Install
  3. Update/Upgrade
  4. Quick start
    1. Create the simple PDF template
    2. Create the simple Header/Footer template
    3. Generate PDF file
  5. Work area
    1. ListView
    2. ListView of Header/Footer
    3. DetailView
    4. DetailView of Header/Footer
    5. EditView
      1. Properties
      2. Other information
      3. Labels
      4. Product block
      5. Header/Footer
      6. Settings
      7. Sharing
    6. EditView of Header/Footer
      1. Properties
      2. Other Informations
      3. Labels
    7. PDF Maker block
    8. Preview
  6. Editing
    1. Inserting images
    2. Creating tables
    3. Inserting barcodes and QR codes
      1. Formatting barcodes and QR codes
    4. Inserting Labels
    5. Using a product blocks
      1. Create new product block in EditView
      2. Insert and edit product block template
      3. Separate Block for Products and for Services
    6. Using related blocks
      1. Create the related block
      2. Insert related block
      3. Edit related block
      4. Delete related block
    7. Using ListView block
    8. Mapping product block
    9. Template settings
      1. File name
      2. Status
      3. Set as default
      4. Set template for Customer Portal
  7. PDF Maker block actions
    1. Export
    2. Preview
    3. Send Email
    4. Edit and Export
    5. Save into Documents
    6. PDF Product Page Break
    7. PDF Product Images
      1. PDF Product Images in product templates
      2. PDF Product Images in product blocks
  8. Additional features
    1. Mass export and merging templates
      1. Sorting within mass export
    2. Export and import templates
    3. Sharing
    4. Custom functions
      1. CFArray functions
      2. CFArrayALL functions
      3. datefmt
      4. pdfmakerGetEntityName
      5. isInMultiselectbox
      6. its4you_if
      7. its4you_ifnumber
      8. its4you_isnull
      9. #HIDETR#
      10. getTemplateId
      11. its4you_getContactImage
      12. its4you_formatNumberToPDF
      13. its4you_formatNumberFromPDF
      14. its4you_multiplication
      15. its4you_deduct
      16. its4you_sum
      17. its4you_divide
      18. its4you_nl2br
      19. CFGNumberValue
      20. CFNumberValue
      21. its4you_NumberFormat
      22. semantic_ru
      23. num2str_ru
      24. convert_number_to_words
    5. Template for Header/Footer
  9. Settings
    1. Extensions
      1. Customer portal
      2. Workflows
      3. Styles 4 You
    2. Profiles
    3. Self-defined labels
    4. Product block templates
    5. License settings
      1. Deactivate license
      2. Reactivate license
    6. Upgrade
    7. Uninstall
  10. Tips & tricks
    1. Define background image
    2. Print labels, envelopes and more
  11. Change log
    1. PDF Maker
    2. Manual for PDF Maker

1.Introduction to the PDF Maker

The PDF Maker is extension tool designed for vtiger CRM. There is already possibility of the export to pdf format in vtiger CRM functionality but it covers just few modules. In addition pdf templates are hardcoded and cannot be edited. Therefore, the intention was to provide powerful and flexible tool which allows users of vtiger CRM to create own pdf templates.

The PDF Maker benefits are:

  • supported mostly inside all modules
  • unlimited number of PDF templates within one module
  • simple addition, edit, duplication or deletion of the pdf template
  • simple direct sending of the pdf files
  • advanced and more creative editing of pdf files using inserting images, tables, barcodes
  • creation of an own product block
  • mass export to PDF from list view
Yes No Suggest edit

2.How to install PDF Maker

Please provide following steps in order to install PDF Maker

It is highly recommended to finish the installation without any interruption. For successful installation we need to exchange information (see license for details).
  1. Install the .zip (package) file of the PDF Maker module via Setting -> CRM Settings -> Module Management -> Modules. Click on the Import Module from Zip.
    Installation of PDF Maker for vtiger 7 - step 1

    Installation of PDF Maker for vtiger 7 – step 1

  2. Select the .zip (package) file that you downloaded from our shop. Please check that you accepted the disclaimer and would like to proceed. Click on the [Import] button.
    Installation of PDF Maker for vtiger 7 - step 2

    Installation of PDF Maker for vtiger 7 – step 2

    Note: If you have after this step error message: Sorry! Attempt to access restricted file. Please check if folder test/vlib has correct write permission for browser (apache, www-data).

  3. Verify the import details parsed from the .zip (package) file. Please check that you accepted the license agreement and click [Import Now] to proceed or [Cancel] to cancel.
    Installation of PDF Maker for vtiger 7 - step 3

    Installation of PDF Maker for vtiger 7 – step 3

    For successfully completing the installation is neccesary download mPDF library into PDFMaker module from external storage place,
    because mpdf.zip is over 2MB and many customers has MAX_UPLOAD_SIZE set to 2 MB (webhosting) so we have make available download it from our server.

  4. PDF Maker was imported
    Installation of PDF Maker for vtiger 7 - step 4

    Installation of PDF Maker for vtiger 7 – step 4

In order to finish installation, please provide following validation steps.

  1. PDF Maker Validation Step. Please check your Company information and insert license key. Make sure that your server has Internet access. Click on button [Validate]. If you want to change your Company information, click on button [Change Company Information].
    Validation PDF Maker for vtiger 7

    Validation PDF Maker for vtiger 7

  2. Mpdf Download. Click on [Download] button to download and install mpdf script.
    mPDF for PDF Maker

    mPDF for PDF Maker

  3. If PDF Maker is installed successfully you will see following screen. Click on [Finish].
    PDF Maker was installed successfully

    PDF Maker was installed successfully

Yes No Suggest edit

3.How to update/upgrade PDF Maker

The upgrade of the PDF Maker is initiated in the same way as PDF maker installation or click on Upgrade PDFMaker link in Customize tab of PDF Maker.

How to update/upgrade PDF Maker

How to update/upgrade PDF Maker

So please refer to above installation part for details how to initiate the import of the module from the file. As can be seen on following picture you will be notified that the PDF Maker module already exists. The upgrade will start immediately when you click on the [Update Now] button.

How to update PDF Maker

How to update PDF Maker

After upgrade the notification about successful upgrade is shown.

How to update PDF Maker

How to update PDF Maker

Yes No Suggest edit

4.Quick start

In the following section you can find short description how to create your first simple PDF template for vtiger CRM using PDF Maker.

Note: The full description of the PDF Maker’s menus, tabs and icons can be found in the later chapters.

Yes No Suggest edit

4.1.Create the simple PDF template

In order to edit the PDF template you have to start the PDF Maker tool which can be after installation located under the Projects as seen below on the picture.

  1. In vtiger CRM menu please go to Projects and click on PDF Maker (since vtiger 7 there is no Tools part so records which used to be in Tools tab are in Projects tab now)
    Location of PDF Maker module

    Location of PDF Maker module

  2. The screenshot below shows PDF Maker ListView. You can click on [+Add template] button to add new template.
    Add PDF template – PDF Maker Vtiger 7

    Add PDF template – PDF Maker Vtiger 7

  3. In the EditView, go to Properties tab and define the template name and the description.
    Creation of the template in EditView

    Creation of the template in EditView

  4. Choose the module from the list (i.e. Invoice).
  5. Choose one of the all available fields from the selected module (i.e. Invoice No) and click on the [$] button to insert it into template.
  6. Repeat the steps 5. and 6. to finish your pdf template according to your needs.
  7. Finally click on the [Save] button.
Yes No Suggest edit

4.2.Create the simple Header/Footer template

In order to edit/create the Header/Footer template you have to start the PDF Maker tool which can be after installation located under the Projects (since Vtiger 7.1.0 again in Tools)  as seen below on the picture.

  1. In vtiger CRM menu please go to Projects and click on PDF Maker (since vtiger 7 there is no Tools part so records which used to be in Tools tab are in Projects tab now)
    Location of PDF Maker module - PDF Maker Vtiger 7

    Location of PDF Maker module – PDF Maker Vtiger 7

  2. The screenshot below shows PDF Maker ListView. You can click on button to add new Header/Footer template.
    Add Header/Footer template – PDF Maker Vtiger 7

    Add Header/Footer template – PDF Maker Vtiger 7

  3. In the EditView, go to Properties tab and define the template name.
    Creation of the Header/Footer template in EditView – PDF Maker Vtiger 7

    Creation of the Header/Footer template in EditView – PDF Maker Vtiger 7

  4. Select the type of template from the list (i.e. Header).
  5. Choose the module from the list (i.e. Invoice) if you want.
  6. Choose one of the all available fields from the selected module (i.e. Invoice No – if module is selected) or create universal template without module’s variables and click on the button to insert it into template.
  7. Repeat the steps 6. and 7. to finish your Header/Footer template according to your needs.
  8. Finally click on the button.
Yes No Suggest edit

4.3.How to generate PDF file with PDF Maker template

In the following picture you can see how to generate PDF file in the ListView or DetailView using PDF Maker:

Listview

  1. Select record(s).
  2. Click on button and select “PDF Export”.
  3. Select the PDF template(s).
  4. Select the language.
  5. Click on [Download file].
  6. Dialog box will/won’t appear on the screen depending on your web browser. The PDF file is generated.
DetailView

  1. Click on [Export to pdf]
  2. Select the PDF template(s).
  3. Select the language.
  4. Click on [Download file].
  5. Dialog box will/won’t appear on the screen depending on your web browser. The PDF file is generated.

 

Generate the PDF file

Generate the PDF file

Yes No Suggest edit

5.Work area

The Work Area of PDF Maker consists of:

  • ListView – used for common tasks like add new template, import and export templates and access to others tools
  • ListView of Header/Footer – used for common tasks like add new template of Header or Footer, import,export or delete templates
  • DetailView – shows already created PDF template in details
  • EditView – allows the preparation of the new PDF template or editing existing templates
  • EditView of Header/Footer – allows the preparation of the new Header/Footer template or editing existing templates
  • PDF Maker block – mainly used for export records to PDF file
  • Preview – preview window with options to Download, Print, Send Email, Edit and Save into Documents
Yes No Suggest edit

5.1.ListView of PDFMaker

The common tasks like add/delete template, import/export templates or start editing have to be initiated via PDF Maker ListView. Go to Projects→ PDF Maker and PDF Maker ListView will appear on your screen.
The main part of the PDF Maker ListView consists of list of the PDF templates, which gives you information about a template name, a primary module, a short description, sharing info, template owner and its status. In the list you can also select one or more templates and consequently delete or export the selected group of templates using button . As shown in the picture, it is also possible to edit or duplicate already created PDF templates directly from the ListView. Also there is option to search templates in your ListView.

ListView – PDF Maker Vtiger 7

ListView – PDF Maker Vtiger 7

There is group of buttons in the above part:

contains actions for delete, import and export of the PDF templates
is used to add new PDF template
is used to add new Header/Footer template
is settings part of PDF Maker. You can find here Extensions, Profiles, Self-defined labels, Product block templates, License setting, Upgrade PDF Maker and option to Uninstall PDF Maker

How to import or export PDF template is described in the Export and Import templates.
How to create Header/Footer is described in the DetailView of Header/Footer.
Yes No Suggest edit

5.2.ListView of Header/Footer

The common tasks like add/delete Header/Footer template, import/export templates or start editing have to be initiated via ListView of Header/Footer. Go to Projects→ PDF Maker click on Header/Footer List and Header/Footer ListView will appear on your screen.
The main part of the PDF Maker ListView consists of list of the Header/Footer templates, which gives you information about a template name, a primary module, a short description and type of template. In the list you can also select one or more templates and consequently delete or export the selected group of templates using button . As shown in the picture, it is also possible to edit or duplicate already created PDF templates directly from the ListView.

ListView of Headers/Footers – PDF Maker Vtiger 7

ListView of Headers/Footers – PDF Maker Vtiger 7

There is group of buttons in the above part:

contains actions for delete, import and export of the Header/Footer templates
is used to add new PDF template
is used to add new Header/Footer template
is settings part of PDF Maker. You can find here Extensions, Profiles, Self-defined labels, Product block templates, License setting, Upgrade PDF Maker and option to Uninstall PDF Maker

Yes No Suggest edit

5.3.DetailView of PDF Maker

From ListView you can directly open any pdf template in DetailView. The DetailView consists of:

  • Template information part – gives basic information of the template
  • PDF template itself which consist of Header, Body and Footer part.
  • Group of action buttons
    • [Edit] – switch to EditView and start editing
    • [More] –
      • [Delete] – allows you to delete template
      • [Duplicate] – create duplicate of the template and start editing
  • Tools – for changing default and status of the shown template
    • Set as default / Unset as default – setting of default
    • Set as inactive / Set as active – change status
  • Display conditions – allows you to set conditions when template is shown or hidden
  • CSS Styles – allows to you manage your CSS styles and assigned it to templates
DetailView of PDF Maker

DetailView of PDF Maker

Display conditions

Display conditions tab allows set conditions when template is shown or hidden. If you want to show template without ban, leave conditions empty. There is option to show template if conditions are true or hide templates if conditions are true. You can set it by choosing Yes if/No if in Displayed tab. In Conditions tab you can choose if you want that all conditions must be met or At least one of the conditions must be met. You can add or delete conditions.

Display conditions

Display conditions

CSS Styles

Styles4You extension allows to you manage your CSS styles and assigned it to templates.

Styles4You

Styles4You

Yes No Suggest edit

5.4.DetailView of Header/Footer

From ListView of Header/Footer you can open any Header/Footer template in DetailView. The DetailView consists of:

  • Template information part – gives basic information of the template
  • Header/footer template itself which consist of Header, Body and Footer part.
  • Group of action buttons
    • [Edit] – switch to EditView and start editing
    • [More] –
      • [Delete] – allows you to delete template
      • [Duplicate] – create duplicate of the template and start editing
DetailView of Headers/Footers – PDF Maker Vtiger 7

DetailView of Headers/Footers – PDF Maker Vtiger 7

Yes No Suggest edit

5.5.EditView of PDF Maker

The EditView shown in the picture below is divided into two areas:

  • Tabs area – allows user to insert into template different kind of values, fields, labels and to set up properties, sharing and other common settings of the pdf template. Tabs area consists of following tabs, which are described in the following subchapters:
    • Properties
    • Other informations
    • Labels
    • Product block
    • Header/Footer
    • Settings
    • Sharing
  • Editing area – is mainly used for inserting/editing your own text, tables, images etc. and to make some design adjustment of the template like font change, color, format, size, background color of the text etc. This editing can be initiated via many toolbars located inside three tabs (Body, Header and Footer) in the above part of Editing area. Please refer to the chapter 4 for the details related to editing.

Note: If you click on Body tab in editing area you are automatically switched to Properties tab. Also if you click on Header tab or Footer tab in editing area then it switches Tabs area to Header/Footer tab.

EditView of PDF Maker

EditView of PDF Maker

Yes No Suggest edit

5.5.1.Properties

The main purpose of the Properties tab is to define template name and module for which PDF will be used.

PDF Maker Properties tab

PDF Maker Properties tab

Name Description
Template name The name of the template. It is mandatory field for template creation.
Module Template will be based and available only for one selected module and its fields.
Related modules If exists related module(s) to selected module, it is possible here to select and use fields from any related modules.
Related blocks Related block(s) to selected module, with buttons to insert, create, edit or delete related block.
Company information Comprises group of fields from Company information.
User information Assigned to User, Logged in User, Modified by User and Created by User information
Yes No Suggest edit

5.5.2.Other information

As shown below Other information tab contains several fields. There are ListView block option, Terms and Conditions, Current date, Barcodes, QR code and Custom functions.

PDF Maker Other information tab

PDF Maker Other information tab

 

Name Description
ListView block In case you need pdf file which consists of the several records and some related fields you can use ListView block.
Terms and Conditions Terms and Conditions.
Current date Current date in several formats.
Barcodes, QR code Several types of Barcodes and QR code
Custom functions If you need a special treatment of vtiger data in your template, you can use custom (your own) functions.
Yes No Suggest edit

5.5.3.Labels

Labels tab consists of Global language, Module language and Self-defined labels part. Labels are very useful especially in case you need to print/save documents in two or more languages.

PDF Maker Labels tab

PDF Maker Labels tab

 

Name Description
Global language Global labels.
Module language Labels related only to selected module.
Self-defined labels Labels defined by user.
Yes No Suggest edit

5.5.4.Product block

The product block tab allows inserting product block template and editing it. In addition, you can create your own product block using “Block start”, “Block end” and fields for products and services.

PDF Maker Product block tab

PDF Maker Product block tab

Name Description
Product block template Insert predefined and created product block templates.
Product block Products and Services Block start, Products and Services Block end. Products Block start, Products Block end. Services Block start, Services Block end. Each product block has to start with “Block start” and ends with “Block end”.
Common fields for Products & Services Fields common for products & services. You can find same fields for products and services separately as well, but it is recommended to prefer common fields in the templates.
Available fields for Products Fields for products.
Available fields for Services Fields for services.
Yes No Suggest edit

5.5.5.Header/Footer

The Header / Footer tab comprises some variables and header/footer settings related to displaying.

Header/Footer tab – PDF Maker Vtiger 7

Header/Footer tab – PDF Maker Vtiger 7

Name Description
Header Allows you use custom or select from your Header templates
Footer Allows you use custom or select from your Footer templates
Header / Footer variables “Current page”, “Total pages” and “Page/pages”.
Display header Allows defining how to display the header of the pdf document.
Display footer Allows defining how to display the footer of the pdf document.

If you use Custom Header or Footer then to export is taken Header or Footer from PDF Template.
If you Select From list and choose your Header or Footer template then this template is added to PDF file in process of export.
How it works you can find also here

Yes No Suggest edit

5.5.6.Settings

The settings tab allows defining file name, page settings, number format and other settings from usage of template point of view.

PDF Maker Settings tab

PDF Maker Settings tab

 

Name Description
File name File name in different formats.
Description The description of the pdf template.
Page format A3, A4, A5, A6, Letter, Legal or Custom. Custom page format allows to define width and height of the page in mm. Maximum values are 2000 mm x 2000 mm and minimum values are 100mm x 100mm.
Page orientation Portrait or landscape.
Ignored picklist values Define picklist values which will be ignored in the final pdf document like None, none, keine etc. Entered values have to be separated with comma.
Margins Margins in cm. Maximum value is 9.9 cm and minimum value is 0 cm.
Number format Decimal point separator – comma, dot (but any symbol can be used) Number of decimal points – 0-3 Thousands separator – comma, dot, space (but any symbol can be used)
Status Active / Inactive
Set as default Set/unset as default for DetailView and ListView.
Set for Customer Portal Set template of Invoice/Quotes for customer portal
Yes No Suggest edit

5.5.7.Sharing

The Sharing tab changes depend on whether PDF template is shared or public/private. Using this tab you can define how to share your template between you and other users or groups.

PDF Maker Sharing tab

PDF Maker Sharing tab

 

Name Description
Template owner Select template owner from the list.
Sharing Select “Public”, “Private”, “Share”
Yes No Suggest edit

5.6.EditView of Header/Footer

Since PDF Maker 700.4.0 version there is useful option to create Header/Footer templates and then use it for PDF template. This function should save your time when you need make changes in all Header or Footer of PDF template.

The EditView of Header/Footer shown in the picture below is divided into two areas:

  • Tabs area – allows user to insert into template different kind of values, fields and  labels and to set up properties, and other common settings of the pdf template. Tabs area consists of following tabs which are described in the following subchapters:
    • Properties
    • Other informations
    • Labels
  • Editing area – is mainly used for inserting/editing your own text, tables, images etc. and to make some design adjustment of the template like font change, color, format, size, background color of the text etc.
EditView of Header/Footer – PDF Maker Vtiger 7

EditView of Header/Footer – PDF Maker Vtiger 7

Yes No Suggest edit

5.6.1.Properties of Header/Footer

The main purpose of the Properties tab is to define template name and type of template (Header or Footer).

Properties tab – PDF Maker Vtiger 7

Properties tab – PDF Maker Vtiger 7

Name Description
Template name* The name of the template. It is mandatory field for template creation.
Type Type of template.  Header or Footer template
Description Description of your template
Header/Footer variables Current page, All pages, Page/pages
Module You can select module if want add module fields. If you do not choose module template will be available for all PDF templates.
Related modules If you select module and if exists related module(s) to selected module, it is possible here to select and use fields from any related modules.
Company information Comprises group of fields from Company information.
User information Assigned to User, Logged in User, Modified by User and Created by User information
Yes No Suggest edit

5.6.2.Other Informations of Header/Footer

As shown below Other information tab contains several fields. There are ListView block option, Terms and Conditions, Current date, Barcodes, QR code and Custom functions.

Other information tab – PDF Maker Vtiger 7

Other information tab – PDF Maker Vtiger 7

Name Description
Terms and Conditions Terms and Conditions.
Current date Current date in several formats.
Barcodes, QR code Several types of Barcodes and QR code
Custom functions If you need a special treatment of Vtiger data in your template, you can use custom (or your own) functions.
Yes No Suggest edit

5.6.3.Labels of Header/Footer

Labels tab consists of Global language, Module language (if module is selected) and Self-defined labels part. Labels are very useful especially in case you need to print/save documents in two or more languages.

Labels tab – PDF Maker Vtiger 7

Labels tab – PDF Maker Vtiger 7

Name Description
Global language Global labels.
Module language Labels related only to selected module.
Self-defined labels Labels defined by user.
Yes No Suggest edit

5.7.PDF Maker block

The PDF Maker block can be found inside the specific module. In the module ListView it is necessary to click on any record to see details and on the right side, you can find the block. Depends on type of module and whether template already exists for selected module following forms of PDF Maker block can be seen in the screen (after PDF Maker installation, the PDF Maker block is visible only for modules with at least one already created PDF template) :

  1. Standard layout of the PDF Maker block.
  2. Extended layout of the PDF Maker block available for modules Invoice, Sales Order, Purchase Order, Quotes.
PDF Maker block for vtiger 7

PDF Maker block for vtiger 7

Yes No Suggest edit

5.8.Preview

Preview window contains of PDF file preview and also you can find here options to Download file, Print, Send Email, Edit and Save into Documents.
It is useful to see how looks your PDF file.

Preview of PDF Maker

Preview of PDF Maker

Yes No Suggest edit

6.Editing

The editing of the pdf templates in the PDF Maker is easy and is provided inside editing area in the EditView. Before you start the creation of the new template, you have to decide whether the new PDF template will be based on primary module or not. So two kinds of PDF templates exists:

Primary module pdf templates – inside template you can combine primary module fields, related module fields, your text, images, tables, products block templates, related blocks, listview blocks, all fields from Other information tab, etc.

Common templates – templates can be used in all modules. Inside common templates is not recommended to use primary module fields, related module fields, products block templates, related blocks or listview blocks. The reason is that values for such fields should be not available for particular modules and therefore the exported pdf file will contain just notations of the fields e.g. $s-products-productname$ but not real expected values.

As can be seen in the picture below, in order to have useful pdf template you can combine: your own text, module fields or related module fields, images, tables, barcodes, labels, products block templates, related blocks, etc… Just click inside the editing area below the Body/Header/Footer tabs and start typing your text. You can continue with adding additional fields. Body/Header/Footer tabs allows you to change formatting of your text and other inserted fields using a lot of toolbars. Just select the text/field and click on any icon of the tool like font, color, bold, italic, alignment etc.

Editing

Editing

Yes No Suggest edit

6.1.Inserting images

mages can improve the design of your documents. CKEditor is used inside the PDF Maker and it allows you to add images into your documents in an easy and intuitive way.

So, if you would like to insert image please provide following steps:

  1. Press the button on the toolbar.
    Insert Image

    Insert Image

  2. A pop-up window called “Image Properties” will appear. It includes four tabs that group image options.
  3. Define the URL address of the image. You may also use the [Browse Server] in order to browse the files. Set up other properties of the image.
  4. Click [Ok] to add image into Templates.

For more info visit following site: http://docs.cksource.com/CKEditor_3.x/Users_Guide/Rich_Text/Images

Yes No Suggest edit

6.2.Creating tables

The tables are inseparable component of many documents. Similarly to images, tables can be inserted into
your templates in few simple steps:

  1. Press the insert/edit table button on the toolbar. After that a popup window called “Table
    Properties” will appear.

    Creating tables

    Creating tables

  2. Set the basic table properties like number of columns and rows, width, height, etc.
  3. Click on [Ok] button.

After that the table is inserted into the template and you can write some text, insert all available fields from
chosen and related Modules or add some images into the new table. You can also make some design
adjustments like bold text, underline, etc.

For more info visit following site: http://docs.cksource.com/CKEditor_3.x/Users_Guide/Rich_Text/Tables

Yes No Suggest edit

6.3.Inserting barcodes and QR codes

There is a “Barcodes, QR code” field in the Other information tab. Barcodes are divided into group. Detailed
description of the barcodes can be found in the attached document (just click on ).
In order to insert the barcode into the template please provide following steps:

  1. Choose your barcode type.
  2. Click on button.
  3. Barcode is inserted into template.
  4. Replace “YOURCODE” with static number/string (4a) for making the barcode or you can use the
    variables from the actual template (4b).
Barcode selection

Barcode selection

How to insert QR code shows next picture:

  1. In Other information tab please select QR field from “Barcodes, QR code” and click on button.
  2. In inserted part [BARCODE|QR=YOURCODE|BARCODE] replace “YOURCODE” with your QR code
    value.
How to insert QR code

How to insert QR code

Yes No Suggest edit

6.3.1.Formatting barcodes and QR codes

The inserted barcodes or QR codes can be formatted using:

  1. additional attributes – add one or more supported attributes into barcode/QR syntax like
    [BARCODE|CODE=YOURCODE|ATT1=value1|…|ATTN=valueN|BARCODE]
    Example:
    [BARCODE|EAN13=789|SIZE=1.5|HEIGHT=0.5|BARCODE]
  2. Cascading Style Sheets (CSS) – define CSS style within PDF template and put it into barcode/QR
    syntax like: [BARCODE|CODE=YOURCODE|CLASS=name_of_style|BARCODE]
    Example:

    [BARCODE|EAN13=123|CLASS=barcodestyle|BARCODE]

Please refer to mPDF Book Manual barcode part for details
https://mpdf.github.io/reference/html-control-tags/barcode.html

Formatting barcodes and QR codes

Formatting barcodes and QR codes

Yes No Suggest edit

6.4.Inserting Labels

The intention of the labels is saving time and effort for creating pdf templates. Using labels provides an easy and flexible way to prepare pdf files / or just parts of pdf files in different languages without necessity to create separate pdf template per each language. As it was described in chapter 5.3.3, labels can be inserted into templates via Labels tab. In order to insert any global related label, module related label or self-defined label just click on Labels tab, select from dropdown list any label and click on [Insert into template] button.

Labels tab

Labels tab

 

Please refer to example below used for invoice pdf template. Instead of having two (or more) templates the labels are used as much as possible. For example the label %G_Phone% used in the template will be replaced in final pdf file in german language as “Telefon” and in final pdf file in English language as “Phone” automatically based on your language selection. So it is not necessary to create duplicate templates for another language, just use labels and select language before exporting into pdf. The global labels use notation %G_*****%, module labels use %M_*****% and self-defined labels use notation %C_*****%.

Inserting labels

Inserting labels

If the global and module related labels are not sufficient for you, it is possible to define self-defined labels. In order to define self-defined please follow instructions described in the chapter 9.2.

Yes No Suggest edit

6.5.Using a product blocks

The product blocks are simple but powerful parts of your PDF templates. They are used to display all products/services from modules Invoices, Quotes, Sales Order and Purchase Order in your PDF files regardless of the number of products/services for particular record. Below you can find simple example where invoice contains three products which are automatically seen in the final PDF exported file. You don’t need to create template for three rows in the table, just define start and stop of the product block and product fields according to your needs. Next chapter describes how to create your own product block. In addition, we also introduced some default product block templates as well as tool for managing them (9.3).

Product block usage

Product block usage

Yes No Suggest edit

6.5.1.Create new product block in EditView

You can find Product block tab in EditView which allows inserting, editing and creating of product blocks. In case that product block templates are not sufficient for you, it is easy to create your own product block:

  1. Go to Product block tab and insert product block start variable (#PRODUCTBLOC_START#) and
    product block end (#PRODUCTBLOC_END#).
  2. Add all necessary product/service fields according to your needs between (#PRODUCTBLOC_START#)
    and (#PRODUCTBLOC_END#) and provide formatting if needed.
Create product block

Create product block

Yes No Suggest edit

6.5.2.Insert and edit product block template

There are already created product block templates which you can insert from product block tab and later edit if needed. These templates are available only for modules Invoices, Quotes, Sales Order and Purchase Order that displays product block. The product block templates created within product block tool (9.3) can be added in the same way. You can simply add the whole product block template into your template by:

  1. Go to Product block tab.
  2. Select product block template.
  3. Click on button.
Insert product block template

Insert product block template

When the product block template is inserted you can modify it according to your needs. For example you can add new cells / rows / columns, change font, change the background color, etc. You can edit layout like a table or you can add some new variables / labels as well.

Yes No Suggest edit

6.5.3.Separate Block for Products and for Services

There is also the option to create a separate Block for Products and for Services. To create separate Block please provide following steps:

  1. Go to Product block tab and insert product block start variable (#PRODUCTBLOC_PRODUCTS_START# or #PRODUCTBLOC_SERVICES_START#) and product block end (#PRODUCTBLOC_ PRODUCTS_END# or #PRODUCTBLOC_ SERVICES_END#).
  2. Add all necessary product/service fields according to your needs between (#PRODUCTBLOC_PRODUCTS_START# or #PRODUCTBLOC_SERVICES_START#) and (#PRODUCTBLOC_PRODUCTS_END# or #PRODUCTBLOC_SERVICES_END#) and provide formatting if needed.
Separate Block for Products and for Services

Separate Block for Products and for Services

Yes No Suggest edit

6.7.Using ListView block

In case you need PDF file which consists of the several records and some related fields you can use ListView block. Within this block you can simply set which fields of the records you would like to have. Please refer to below picture which shows simple example of the PDF file consists of the list of invoices and related few fields (invoice number, invoice date, status etc.) and how to prepare it. Firstly in the PDF Maker EditView:

  1. Go to Properties tab and select the “Block start” and click .
  2. Insert fields you would like to have in ListView block ($s-invoice-invoice_no$..).
  3. Insert “Block end” using button .
ListView block - EditView

ListView block – EditView

Provide additional edit steps and save the template. When the template is ready you can use it within ListView (ONLY!) to prepare mail using following steps:

  1. Go to ListView of particular module and select 1 to N records.
  2. Click on and select PDF Export.
  3. Select ListView block template (language) and click on .
  4. Final PDF file with correspondent ListView block is created.
ListView block

ListView block

Note: Each ListView block must start with “Block start” (#LISTVIEWBLOCK_START#) and must end with “Block end” (#LISTVIEWBLOCK_END#). ListView block template can be set as default only for ListView; for DetailView it is not applicable.
Yes No Suggest edit

6.8.Mapping product block with vtiger form

Below picture shows how you can find and use variables during preparation of the PDF template. Although variables have same or similar name you can not mix them if you would like to have correct PDF document.
Please take it into account during preparation of the templates and see short description in following Tables.

Mapping product block with vtiger form

Mapping product block with vtiger form

 

Name Description
Currency Euro, Dollar
Currency symbol €, $
Currency code EUR, USD
Subtotal Price without TAX before discount, by Tax Mode: group = Net Total
Total discount Final Discount amount
Total discount (%) Final Discount in %
Total without TAX Total price without TAX after discount
TAX Total TAX amount
TAX (%) Total TAX in %
TAX block This is useful for some countries, that need to have the detail amount of TAX
Total with TAX Total price with TAX
Shipping & Handling taxes Final taxes for Shipping & Handling
Shipping & Handling amount Final amount for Shipping & Handling
Adjustment Adjustment from vtiger form
Grand Total Grand Total from vtiger form

PDF Maker Other information tab

Name Description
Record ID Record ID
Product No / Service No Number of product / service
Position Number of position (1,2,3, …)
Currency Euro, Dollar
Currency code EUR, USD
Currency symbol €, $
Name Name and description of the product or service
Name of product/service Only the name of the product or service
Description of product/service Description of the product/service from module Product/Service
Comment for product/ service Comment for products/service from Invoice/SO/PO/Q form
Quantity Quantity defined in Invoice/SO/PO/Q
Unit Unit of product/service from module Product/Service
List price List Price from Invoice/SO/PO/Q
Total price List price x Unit
Discount Discount amount for each product/service
Discount (%) Discount in % for each product/service
Total after discount Total price after discount without TAX
TAX TAX amount for each product/service
TAX (%) TAX in % for each product/service
Total price with TAX Total price with TAX for each product/service

Mapping values for product block template item available in Invoices, Quotes, Sales Orders and Purchase Orders

Yes No Suggest edit

6.9.Template settings

6.9.1.File name

In Settings tab of PDF Maker you can find “File name” definition. This setup gives you the opportunity to set the name of generated PDF files according to your needs. You can combine strings, modules variables and some standard variables like Template name, Current date. File name will be used by saving PDF file into Documents and by sending PDF as attachment too. Dropdown list for file name depends on primary module as can be seen on the below image.

File name settings

File name settings

Yes No Suggest edit

6.9.2.Status

You can set status as active or inactive for each template. Please take into account that this can be set separately per logged user, it means this setting is not global. The inactive templates will not appear in the list of available templates in the PDF maker block. You can find status of existing templates in:

  1. ListView – “Status” column
  2. DetailView – Template information
Status of template in ListView and EditView

Status of template in ListView and EditView

To set PDF template as active / inactive you need to use Settings tab in EditView and select status from listbox.

How to set status of PDF template

How to set status of PDF template

Yes No Suggest edit

6.9.3.Set as default

The particular PDF Template can be set as default by a logged user, it means this setting is not global. This default template is specific to that user and to that module. It means that different users can set their own default templates for each module separately. It is possible to define template as default for DetailView and default for ListView separately. You can find whether the template is set as default or not in:

  1. ListView – the template default for DetailView is marked with text “(default for DetailView)”, template default for ListView is marked with text “(default for ListView)”. If the template is default for DetailView as well as for ListView, then in the template name column text “(default)” is written.
  2. DetailView – Properties tab
  3. PDF Maker block – the default template is highlighted and automatically selected in PDF Maker block. PDF template is also highlighted and selected in case that only one PDF template exists for module.
The default template in the PDF Maker block

The default template in the PDF Maker block

To set PDF template as default you need to use Settings tab in EditView – check/uncheck the checkboxes to change this setting separately for EditView and ListView.

Setting default PDF template

Setting default PDF template

Please take into account that templates using ListView block cannot be in parallel set as default for DetailView. The checkbox “for DetailView” in “Settings” tab is automatically inactive if you check checkbox “ListView block” in “Properties” tab

Setting default vs. ListView block

Setting default vs. ListView block

Yes No Suggest edit

6.9.4.Set template for Customer Portal

The PDF Maker template can be set as default template for Customer Portal. In order to set it please go to the Settings tab and check the checkbox “Set for Customer Portal”. Please note that this setting is available only for modules/templates Invoice and Quotes.

Setting the PDF template as template for Customer Portal

Setting the PDF template as template for Customer Portal

Yes No Suggest edit

7.PDF Maker block actions

The PDF Maker block contains links to initiate several actions:

  • Export
  • Preview
  • Send Email
  • Edit and Export
  • Save into Documents
  • Settings
    • PDF Product Page Break
    • PDF Product Images
  • PDF language

You can find description of above actions in the following sections. Please take into account that visibility of above links within PDF Maker block depends on user profile.

Yes No Suggest edit

7.1.Export

The export of your documents/records to PDF files is the basic action of PDF Maker block.

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template. The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on Export and export will be done. Please note that next step depends on used web browser.
Export to PDF

Export to PDF

Preview of PDF Maker

Preview of PDF Maker

Yes No Suggest edit

7.2.Preview

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template. The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on Preview and Preview window will appear. Here you can also find helpful options like Download file, Print, Send Email, Edit and Save into Documents.
Preview of PDF file

Preview of PDF file

Yes No Suggest edit

7.3.Send Email

PDF Maker allows you to send your PDF documents via email in few easy steps:

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template. The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on Send Email.
  3. A popup window “Compose Email” will appear on the screen with already attached PDF file. Please add subject and text according to your needs. You can add additional recipients if necessary as well.
  4. Click on button to send email with attached file(s).
Send Email with PDF – Compose E-Mail

Send Email with PDF – Compose E-Mail

Yes No Suggest edit

7.4.Edit and Export

From time to time it is necessary to edit your document before print or save. For example, you can change post address in one document but don’t want to change record in database because it is temporary necessity. In that case you can choose Edit and Export action item which gives you possibility to change not only layout of the document/template but in addition any text. In order to edit and export PDF file:

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template. The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on Edit and Export link.
  3. A popup window with template will appear in the screen. You can start to modify your document now.
  4. Click on to export the final PDF file.
Edit and export to PDF

Edit and export to PDF

Yes No Suggest edit

7.5.Save into Documents

You can save the template or merged templates into the module Documents using following steps:

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template(s). The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on Save into Documents link. A popup window will appear on the screen.
  3. In the part “Documents” please write the title of the document and select the storage folder. You can also add a note.
  4. Click on button to save the PDF file into Documents.
  5. After that the document can be find under module Documents.
Save PDF into Documents

Save PDF into Documents

Yes No Suggest edit

7.6.PDF Product Page Break

Product blocks are available for some modules (Invoice, SO, PO, Q). PDF Product Page Break action allows
you to setup additional settings according your needs. You can define:

  • A position of the page break. The page break will be inserted after each selected product (blue line)
  • Show table header after page break – a repetition of the table’s header on the next page (red line)
  • Show subtotal before page break – a subtotal value at the end of the page (before page break) (yellow line)
Product break settings

Product break settings

Also good option is modify subtotal before page break. You can edit it if you edit #PRODUCTBLOC_START# in your template.

Edit page break subtotal

Edit page break subtotal

Yes No Suggest edit

7.7.PDF Product Images

PDF Product Images action allows you to define some settings related to product images:

  • used for product templates
  • used inside product blocks
Yes No Suggest edit

7.7.1.PDF Product Images in product templates

The link PDF Product Images is useful in case you are using more images for one product and you would like to select which image has to be used within your PDF exported files. Let’s suppose that variable $PRODUCTS_IMAGENAME$ is used in the template. In order to select which image will be used please provide following steps:

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template(s). The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on PDF Product Images link.
  3. PDF Product Images window will appear on the screen.
  4. Select the picture and click on button.
PDF Product Images in product templates

PDF Product Images in product templates

Depending on your selection 4 different situations can happen:

  1. If more pictures are available only selected picture will be used.
  2. If only one picture is available it is used automatically.
  3. If picture is not available then no changes will be visible in the final document.
  4. In case you don’t want to use picture you are able to switch it off.
Yes No Suggest edit

7.7.2.PDF Product Images in product blocks

The PDF Product Images also allows defining images which will be used in final exported PDF files within product blocks.

  1. Start editing of your PDF template. Go to the Product block tab, from “Available fields for Products” select “Product Image” and click on button.
  2. As can be seen below, it is required to insert the variable $PRODUCTS_IMAGENAME$ between #PRODUCTBLOC_START# end #PRODUCTBLOC_END#.
PDF Product images

PDF Product images

 

Let’s assume that your PDF template including product image variable is correctly prepared and saved. In order to apply PDF product images settings:

  1. Go to the detail view of given Module and on the ride side of DetailView, click on button and in the PDF Maker block, choose your PDF Template(s). The template is selected automatically in case the only one exists for given module or in case the default template is already defined.
  2. Click on PDF Product Images link.
  3. A popup window “PDF Product images” will appear on the screen. It displays all available pictures for each product from the selected record (for example invoice). The system selects automatically the first available picture but you can select which picture will be used in final PDF document, as well as its size. Depending on your selection 4 different situations can happen:
    1. If more pictures are available only selected picture will be used.
    2. In case you don’t want to use picture you are able to switch it off.
    3. If only one picture is available it is used automatically.
    4. If picture is not available the cell in the PDF document remains empty.

    You can also set a width or height for the generated images. If you leave one of the parameter fields empty, the size of image will be proportional. If you leave both parameter fields empty, the image will be displayed in its original size.

  4. Click on button to save your setting.
  5. Now, PDF product images settings are saved and will be used for additional actions, like export to PDF, send email with PDF etc.
 PDF Product images settings

PDF Product images settings

Yes No Suggest edit

8.Additional features

8.1.Mass export and merging templates

In the chapter Export was described how to export documents via PDF Maker block. There is additional possibility of the export to PDF via ListView. In addition, ListView allows you mass export and merging templates. To do mass export in ListView please provide following steps:

  1. Inside ListView, select one or more document.
  2. Click on .
  3. PDF Maker batch export window will appear on the screen.
  4. Select the PDF template.
  5. Click on .
Mass export

Mass export

The merging of the templates allows you to print one or more documents using more templates at once.
Next picture shows the merging of the templates.

Merging templates

Merging templates

If you combine mass export and merging templates you will obtain final PDF document as is shown in the
next picture.

Mass export combined with merging templates

Mass export combined with merging templates

Yes No Suggest edit

8.1.1.Sorting within mass export

The order of the records exported in the pdf file within mass export depends on sorting used in the ListView. So if you change sorting of the records in the ListView then the final PDF file will correspond this sorting, i.e. records will be ordered as sorted in the ListView and the order will depend on sequence of choosing records.

Sorting within mass export

Sorting within mass export

You are able to manage your records in PDF file according to choosing records in ListView.

Manage records in PDF

Manage records in PDF

Yes No Suggest edit

8.2.Export and import templates

Export and import of the PDF templates makes it easy to work with PDF Maker templates by migration process or moving templates from development to productive installation.
In order to export PDF templates to external sources in PDF Maker tool do following steps:

  1. In the PDF Maker ListView page select one or more templates which would you like to export.
  2. Click on and “Export”.
    Export of the templates

    Export of the templates

  3. Confirm export with  or choose other option to export and then export.
    Export of the templates

    Export of the templates

To import PDF templates from external sources click on the “Import” from (see Picture 6.7 point 2.). After click the new import page will appear on the screen.

 Import PDF templates page

Import PDF templates page

In the Import PDF templates page, browse the PDF Maker template-related data in *.xml format and then click the button. It will take a few seconds to complete the import. The imported templates can be found in PDF Maker ListView page.

Yes No Suggest edit

8.3.Sharing

Using Sharing tab you can define template owner and how to share your template between you and other users or groups. You can setup sharing for different entities & members. In order to share your template:

  1. Select “Share” from the list.
  2. Choose groups, roles, roles & subordinates or users to share.
Sharing

Sharing

Yes No Suggest edit

8.4.Custom functions

If you need a special treatment of vtiger data in your template, you can use custom (your own) functions. There is a folder functions under [vTigerROOT]/modules/PDFMaker/resources/, where you can place your own .php file with functions which would you like to use. This file will be included automatically. Inside this folder is file „its4you.php“, which contains our functions. These functions are listed in the Table 6-1 and are provided for you for free. Do not modify this file, because by next version it will be overwritten. If you would like to use your own functions, please create your own file/files, it means create new .php file under [vTigerROOT]/modules/PDFMaker/resources/functions and place here your functions. In order to insert custom function into template provide following:

  1. Go to EditView, and in Other information tab select custom function from selectbox „Custom functions“. You can choose one of our functions (its4you_*), or your own function.
  2. Click on button. It adds function in form
    [CUSTOMFUNCTION|functionname|param1|param2|…|CUSTOMFUNCTION].
  3. Finally you have to define parameters of the function as shown in the picture.
Custom functions

Custom functions

In the above example function with 5 parameters was used, i.e. [CUSTOMFUNCTION|functionname|param1|param2|param3|param4|param5|CUSTOMFUNCTION]. It is possible to use functions without parameters as well. In this case use just notation [CUSTOMFUNCTION|functionname|CUSTOMFUNCTION].

Important note: It is not allowed to use one custom function inside another one, i.e. to use custom function as parameter of another custom function.

Here you can find list of functions available for PDF Maker Pro version:

  • addToCFArray
  • implodeCFArray
  • addToCFArrayALL
  • implodeCFArrayALL
  • sumCFArray
  • sumCFArrayAll
  • datefmt
  • pdfmakerGetEntityName
  • isInMultiselectbox
  • its4you_if
  • getTemplateId
  • its4you_getContactImage
  • its4you_formatNumberToPDF
  • its4you_formatNumberFromPDF
  • its4you_multiplication
  • its4you_deduct
  • its4you_sum
  • its4you_divide
  • its4you_nl2br
  • setCFGNumberValue
  • sumCFGNumberValue
  • deductCFGNumberValue
  • mathCFGNumberValue
  • showCFGNumberValue
  • its4you_NumberFormat
  • setCFNumberValue
  • sumCFNumberValue
  • deductCFNumberValue
  • mathCFNumberValue
  • showCFNumberValue
  • semantic_ru
  • num2str_ru
  • convert_number_to_words

Following sections contain short description of some our its4you_* functions which you can use in your PDF templates.

Yes No Suggest edit

8.4.1.CFArray functions

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.2.CFArrayALL functions

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.3.datefmt function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.4.pdfmakerGetEntityName function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.5.isInMultiselectbox function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.6.its4you_if function

Syntax

[CUSTOMFUNCTION|its4you_if|param1|comparator|param2|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Description

This function executes if-else statement based on given parameters.

Parameters

param1
first parameter of comparison
comparator
you can use one of these possible attributes ==,!=,<,>,<=,>=
param2
second parameter of comparison
whatToReturn1
value returned when comparison succeeded
whatToReturn2
value returned when comparison didn’t succeed

Usage

You want to show “Thanks message” if Grand Total is more than 500€.
First you need to place function into template.
[CUSTOMFUNCTION|its4you_if|param1|comparator|param2|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Now replace please:

  • param1 with $TOTAL$
  • Comparator with > (Possible attributes are ==,!=,<,>,<=,>= )
  • param2 with 500
  • whatToReturn1 with Present included for free!
  • whatToReturn2 leave empty

Finally, your function is:

[CUSTOMFUNCTION|its4you_if|$TOTAL$|>|500|Present included for free!||CUSTOMFUNCTION]

its4you_if Custom function

its4you_if Custom function

Yes No Suggest edit

8.4.7.its4you_ifnumber

Syntax

[CUSTOMFUNCTION|its4you_ifnumber|param1|comparator|param2|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Description

This function executes if-else statement based on given parameters. its4you_ifnumber is similar like its4you_if but it is more suitable for comparing numbers because it convert param1 and param2 into number format.

Parameters

param1
first parameter of comparison
comparator
you can use one of these possible attributes ==,!=,<,>,<=,>=
param2
second parameter of comparison
whatToReturn1
value returned when comparison succeeded
whatToReturn2
value returned when comparison didn’t succeed

Usage

You want to show “Thanks message” if Grand Total is more than 500€.
First you need to place function into template.
[CUSTOMFUNCTION|its4you_ifnumber|param1|comparator|param2|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Now replace please:

  • param1 with $TOTAL$
  • Comparator with > (Possible attributes are ==,!=,<,>,<=,>= )
  • param2 with 500
  • whatToReturn1 with Present included for free!
  • whatToReturn2 leave empty

Finally, your function is:

[CUSTOMFUNCTION|its4you_ifnumber|$TOTAL$|>|500|Present included for free!||CUSTOMFUNCTION]

its4you_ifnumber Custom function – PDF Maker Vtiger 7

its4you_ifnumber Custom function – PDF Maker Vtiger 7

Yes No Suggest edit

8.4.8.its4you_isnull

Syntax

[CUSTOMFUNCTION|its4you_isnull|param1|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Description

This function executes if-else statement based on given parameters. its4you_isnull is similar like its4you_if but it is created to find if param1 is NULL or 0.

Parameters

param1
first parameter of comparison if it is NULL or 0
whatToReturn1
value returned when comparison succeeded (param1 = NULL or 0)
whatToReturn2
value returned when comparison didn’t succeed (param1 != NULL or 0)

Usage

You want to show “Sorry message” if Discount is more 0.
And “Info message” is there is any Discount.
First you need to place function into template.
[CUSTOMFUNCTION|its4you_ifnull|param1|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Now replace please:

  • param1 with $TOTALDISCOUNT$
  • whatToReturn1 with Today you do not receive any discount
  • whatToReturn2 with Your discount for today is $TOTALDISCOUNT$

Finally, your function is:

[CUSTOMFUNCTION|its4you_isnull|$TOTALDISCOUNT$|Today you do not receive any discount|Your discount for today is $TOTALDISCOUNT$|CUSTOMFUNCTION]

its4you_isnull Custom function – PDF Maker Vtiger 7

its4you_isnull Custom function – PDF Maker Vtiger 7

Yes No Suggest edit

8.4.9.#HIDETR#

First at all, #HIDETR# is not exactly custom function. It is functionality that you can use in combination with custom function(most common with its4you_if, its4you_ifnumber, its4you_isnull)

Syntax

[CUSTOMFUNCTION|its4you_*****|param1|#HIDETR#||CUSTOMFUNCTION]

Description

If you use #HIDETR# functionality in custom function, it hide <tr> from your table.

Parameters

without parameters

Usage

Try to imagine that you have PDF template with Discount line. Until now, yow had to have 2 different templates if you wanted hide Discount line when Discount is 0 (One template with discount line and one without).
Since now, you can use #HIDETR# if Discount is 0.
First at all choose and insert right custom function (its4you_if, its4you_ifnumber, its4you_isnull) into <tr> which you want to show/hide.
For example:

[CUSTOMFUNCTION|its4you_isnull|param1|whatToReturn1|whatToReturn2|CUSTOMFUNCTION]

Now replace please:

  • param1 with $TOTALDISCOUNT$
  • whatToReturn1 with #HIDETR#
  • whatToReturn2 leave empty

Finally, your function with #HIDETR# is:

[CUSTOMFUNCTION|its4you_isnull|$TOTALDISCOUNT$|#HIDETR#||CUSTOMFUNCTION]

#HIDETR# functionality – PDF Maker Vtiger 7

#HIDETR# functionality – PDF Maker Vtiger 7

Yes No Suggest edit

8.4.10.getTemplateId function

Syntax

[CUSTOMFUNCTION|getTemplateId|CUSTOMFUNCTION]

Description

This function returns id of current template.

Parameters

This function is without additional parameters.

Usage

Just insert function into your template:
[CUSTOMFUNCTION|getTemplateId|CUSTOMFUNCTION]

getTemplateId Custom function

getTemplateId Custom function

Yes No Suggest edit

8.4.11.its4you_getContactImage function

Syntax

[CUSTOMFUNCTION|its4you_getContactImage|id|width|height|CUSTOMFUNCTION]

Description

This function returns image of contact.

Parameters

id
contact id
width
width of returned image (10%, 100px)
height
height of returned image (10%, 100px)

Usage

Do you want to insert image of contact related to Invoice.
Please provide following steps:
First you need to place function into template.
[CUSTOMFUNCTION|its4you_getContactImage|id|width|height|CUSTOMFUNCTION]

Now replace please:

  • id with id of contact (in our case it is $R_CONTACTS_CRMID$)
    Contact ID

    Contact ID

  • width with for example 20%
  • height with for example 20%

Finally, your function is:

[CUSTOMFUNCTION|its4you_getContactImage|$R_CONTACTS_CRMID$|20%|20%|CUSTOMFUNCTION]

its4you_getContactImage Custom function

its4you_getContactImage Custom function

Yes No Suggest edit

8.4.12.its4you_formatNumberToPDF function

Syntax

[CUSTOMFUNCTION|its4you_formatNumberToPDF|value|CUSTOMFUNCTION]

Description

This function returns formatted value and also is used by other functions.

Parameters

value
integer that you want to format (example: 123456.78)

Usage

Do you want to format integer number to format of PDF Maker numbers?
First you need to place function into template.
[CUSTOMFUNCTION|its4you_formatNumberToPDF|value|CUSTOMFUNCTION]

Now please replace:

  • value with your number (123456.78)

Finally, your function is:

[CUSTOMFUNCTION|its4you_formatNumberToPDF|123456.78|CUSTOMFUNCTION]

its4you_formatNumberToPDF Custom function

its4you_formatNumberToPDF Custom function

Yes No Suggest edit

8.4.13.its4you_formatNumberFromPDF function

Syntax

[CUSTOMFUNCTION|its4you_formatNumberFromPDF|value|CUSTOMFUNCTION]

Description

This function returns converted value into integer and is used by other functions.

Parameters

value
formatted value that you want to convert in to integer (1.452,76)

Usage

Do you want to format integer number to format of PDF Maker numbers?
First you need to place function into template.
[CUSTOMFUNCTION|its4you_formatNumberFromPDF|value|CUSTOMFUNCTION]

Now please replace:

  • value with $TOTAL$ (1.452,76)

Finally, your function is:

[CUSTOMFUNCTION|its4you_formatNumberFromPDF|$TOTAL$|CUSTOMFUNCTION]

its4you_formatNumberFromPDF Custom function

its4you_formatNumberFromPDF Custom function

Yes No Suggest edit

8.4.14.its4you_multiplication function

Syntax

[CUSTOMFUNCTION|its4you_multiplication|CUSTOMFUNCTION]

Description

This function returns multiplication of all input values: arg1*arg2*…*argN.

Parameters

arg1
first argument to multiplication
argN
Nth argument to multiplication

Usage

Do you want to multiplication some fields/numbers from your record?
First you need to place function into template.
[CUSTOMFUNCTION|its4you_multiplication|CUSTOMFUNCTION]

Now please add arguments to sum and separate it with |:

  • arg1 is $PRODUCTQUANTITY$
  • arg2 is $PRODUCTLISTPRICE$

Finally, your function is:

[CUSTOMFUNCTION|its4you_multiplication|$PRODUCTLISTPRICE$|$PRODUCTQUANTITY$|CUSTOMFUNCTION]

its4you_multiplication Custom function

its4you_multiplication Custom function

Yes No Suggest edit

8.4.15.its4you_deduct function

Syntax

[CUSTOMFUNCTION|its4you_deduct|CUSTOMFUNCTION]

Description

This function returns deducted value arg1-arg2-…-argN (all following values are deducted from the first one).

Parameters

arg1
first argument to deduct (all following values are deducted from the this one)
argN
Nth argument to deduct

Usage

Do you want to deduct one field from other?
First you need to place function into template.
[CUSTOMFUNCTION|its4you_deduct|CUSTOMFUNCTION]

Now please add arguments to sum and separate it with |:

  • arg1 is $TOTALWITHOUTVAT$
  • arg2 is $TOTALDISCOUNT$

Finally, your function is:

[CUSTOMFUNCTION|its4you_deduct|$TOTALWITHOUTVAT$|$TOTALDISCOUNT$|CUSTOMFUNCTION]

its4you_deduct Custom function

its4you_deduct Custom function

Yes No Suggest edit

8.4.16.its4you_sum function

Syntax

[CUSTOMFUNCTION|its4you_sum|CUSTOMFUNCTION]

Description

This function returns sum of input values: arg1+arg2+…+argN. Function is inserted without arguments by default but you can add arguments and separate it with |.

Parameters

arg1
first argument to sum
argN
Nth argument to sum

Usage

Do you want to sum some of fields from record?
First you need to place function into template.
[CUSTOMFUNCTION|its4you_sum|CUSTOMFUNCTION]

Now please add arguments to sum and separate it with |:

  • arg1 is $TOTALWITHOUTVAT$
  • arg2 is $VAT$
  • arg3 is $ADJUSTMENT$

Finally, your function is:

[CUSTOMFUNCTION|its4you_sum|$TOTALWITHOUTVAT$|$VAT$|$ADJUSTMENT$|CUSTOMFUNCTION]

its4you_sum Custom function

its4you_sum Custom function

Yes No Suggest edit

8.4.17.its4you_divide function

Syntax

[CUSTOMFUNCTION|its4you_divide|CUSTOMFUNCTION]

Description

This function returns divided value arg1/arg2/…/argN.

Parameters

arg1
first argument to multiplication
argN
Nth argument to multiplication

Usage

Do you want to show product discount for 1 product?
First you need to place function into template.
[CUSTOMFUNCTION|its4you_divide|CUSTOMFUNCTION]

Now please add arguments to sum and separate it with |:

  • arg1 is $PRODUCTDISCOUNT$
  • arg2 is $PRODUCTQUANTITY$

Finally, your function is:

[CUSTOMFUNCTION|its4you_divide|$PRODUCTDISCOUNT$|$PRODUCTQUANTITY$|CUSTOMFUNCTION]

its4you_divide Custom function

its4you_divide Custom function

Yes No Suggest edit

8.4.18.its4you_nl2br function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.19.CFGNumberValue functions

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.20.CFNumberValue functions

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.21.its4you_NumberFormat function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.22.semantic_ru function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.23.num2str_ru function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.4.24.convert_number_to_words function

We are working on this section.
It will be available soon.

Yes No Suggest edit

8.5.Template for Header/Footer

Since PDF Maker 700.4.0 version there is useful option to create Header/Footer templates and then use it for PDF template. This function should save your time when you need make changes in all Header or Footer of PDF template.

It is useful functionality that allows you create Header/Footer template and use it in PDF template. Then if you need to provide any change in Header or Footer you just provide changes in Header/Footer template and this changes will be applied in all PDF templates where you use Header/Footer template.

You can still use Header or Footer in PDF template. If you do not use Header/Footer template in PDF template EditView you can see tabs Header/Footer and this custom Header/Footer is used for creation of PDF file.

Custom Header/Footer in PDF template – PDF Maker Vtiger 7

Custom Header/Footer in PDF template – PDF Maker Vtiger 7

Also you can create and select Header or (and) Footer template for your PDF template and then this (these) Header/Footer template is used for creation of PDF file. If you add Header/Footer template to your PDF template there is no tab of Header/Footer in EditView of PDF template visible anymore.

Header template used – PDF Maker Vtiger 7

Header template used – PDF Maker Vtiger 7

Footer template used – PDF Maker Vtiger 7

Footer template used – PDF Maker Vtiger 7

If you use Header and Footer template then only Body tab is visible in EditView of PDF template.

Header and Footer templates are used – PDF Maker Vtiger 7

Header and Footer templates are used – PDF Maker Vtiger 7

How to use Header/Footer template

There is few simple steps how to start using Header/Footer template functionality. Please see following steps:

  1. First at all you need to create your Header/Footer template (Create the simple Header/Footer template)
  2. Then your template is available in ListView of Header/Footer (ListView of Header/Footer)
  3. Open your PDF template and select Header/Footer tab
  4. Choose Header or (and) Footer template for your PDF Maker template from list of Headers/Footers (Header/Footer)
  5. Now you can generate PDF file with your Header/Footer template
  6. If you need to provide changes in header you do not need edit all PDF templates just your Header or Footer template
Yes No Suggest edit

9.Settings

The PDF Maker settings are accessible directly from the ListView and consist of:

  • Extensions – manage extensions: Customer Portal, Workflows, Styles4You
  • Profiles – manage user-specific PDF Maker access to different roles
  • Self-defined labels – manage your own labels
  • Product block templates – manage your own product block templates
  • License settings – manage all settings related to your license
  • Uninstall PDFMaker – remove PDF Maker completely from your vTiger
PDF Maker settings

PDF Maker settings

Yes No Suggest edit

9.1.Extensions

Available extensions for the PDF Maker

Available extensions for the PDF Maker

Yes No Suggest edit

9.1.1.Customer portal

We’ve already provided possibility to use one of the PDF Maker templates as a standard Customer Portal template for modules Invoice and Quotes. The requirement is to set PDF Maker template as default for Customer Portal. Please refer to chapter “Set template for Customer Portal” to see how to set up PDF Maker template for Customer Portal.

INSTALLATION NOTES: Follow the custom installation process described in Customer Portal.txt
Customer portal

Customer portal

Yes No Suggest edit

9.1.2.Workflows

PDF Maker Workflow extension is a new package which provides features to enhance usability of standard workflow of the vtiger in cooperation with our PDF Maker. It allows you to create completely new tasks “Save Document from PDF Maker” and “Send Email with PDF Maker attachments” for any workflow.

PDF Maker tasks for workflows

PDF Maker tasks for workflows

“Save Document from PDF Maker” task brings you the possibility to automatically create and save Documents from PDF Maker templates for module you create workflow for. All you need to do is to create new Workflow for chosen module and create a new Task “Save Document from PDF Maker”.

Save Document from PDF Maker for workflows

Save Document from PDF Maker for workflows

“Send Email with PDF Maker attachments” task brings you the possibility to automatically send email with attached PDF file based on PDF Template(s). When you create new Workflow for chosen module just create a new Task ” Send Email with PDF Maker attachments” and select PDF Template which has to be used .

Send email with PDF maker attachments for workflows

Send email with PDF maker attachments for workflows

Yes No Suggest edit

9.1.3.Styles 4 You

Styles4You extension allows to you manage your CSS styles and assigned it to templates.
To install Styles4You please provide following steps:

  1. Open PDF Maker
  2. Click on  button and choose Extensions
    How to install Styles4You

    How to install Styles4You

  3. Download zip file by Download button
  4. Install Styles4You via module manager or Install button
    How to install Styles4You

    How to install Styles4You

Now Styles4You has been installed into PDF Maker.

Here you can also add new Style or select your created Style. To add your Style to template please open your template click on button or click on button to select style.

How to add style to template

How to add style to template

Fill name, insert your style and choose priority. Priority is used when you add more styles to one template. PDF Maker takes CSS with smaller number of priority.

How to create Styles4You

How to create Styles4You

Now, your style has been added to your template.

Styles4You

Styles4You

Style used in your template you can also find in edit view of template in CSS Style tab.

Style in EditView of template

Style in EditView of template

Yes No Suggest edit

9.2.Profiles

You may define PDF Maker privileges for all profiles. You may define Create/Edit, View and Delete privileges.

How to set profiles for PDF Maker

How to set profiles for PDF Maker

In order to change privileges click on , use the checkboxes and click on button to save changes.

Manage profiles

Manage profiles

Yes No Suggest edit

9.3.Self-defined labels

If the global and module related labels are not sufficient for you, it is possible to define self-defined labels. In order to define self-defined please use following steps:

  1. In customize choose Self-defined labels
    How to define self-defined labels

    How to define self-defined labels

  2. Click on  button.
    How to define self-defined labels

    How to define self-defined labels

  3. Define label key C_***** and value for your current language. Click on button.
    How to define self-defined labels

    How to define self-defined labels

  4. In order to define values for other installed languages click on “Edit Other Translations” link.
    How to define self-defined labels

    How to define self-defined labels

  5. Define label value for additional languages and click on button.
    How to define self-defined labels

    How to define self-defined labels

You can also find here button which allows you to delete unnecessary labels.

How to delete label

How to delete label

Yes No Suggest edit

9.4.Product block templates

Product block template

Product block template

As can be seen in the picture below, you can simply add – , edit – , duplicate – or delete – product block templates.

Product block templates management

Product block templates management

When you click on button following window will appear on your screen. In order to create and save your own product block template please provide following steps:

  1. Define product block template name.
  2. Insert product block template start (#PRODUCTBLOC_START#) and product block template end (#PRODUCTBLOC_END#).
  3. Add all necessary product/service fields according to your needs between (#PRODUCTBLOC_START#) and (#PRODUCTBLOC_END#) and provide formatting if needed.
  4. Click on button.
Create new product block template

Create new product block template

Yes No Suggest edit

9.5.License settings

License settings

License settings

To open License settings part please click on License settings link.

Yes No Suggest edit

9.5.1.Deactivate license

If you want to deactivate your license please provide following step:

  1. Click on button
    Deactivate license of PDF Maker

    Deactivate license of PDF Maker

  2. Confirm deactivation using button
    Deactivate license of PDF Maker

    Deactivate license of PDF Maker

After deactivation of license you can list or export your PDF templates, but you cannot add, edit, delete or use them. The Actions link to work with templates is not visible in the ListView and DetailView and PDF Maker block is not visible either. To use PDF Maker again properly, you need to activate license key. Please, click on  button and provide activate step.

Deactivated PDF Maker

Deactivated PDF Maker

Activate PDF Maker

Activate PDF Maker

Yes No Suggest edit

9.5.2.Reactivate license

In case that some problem occurs with license key (moving, copying, migrating, changing Company info) you need to reactivate your license key.

Reactivate option also use when you buy upgrade from Basic to Professional version of PDF Maker.

To reactivate license key please provide following steps:

  1. Click on
    Reactivate license of PDF Maker

    Reactivate license of PDF Maker

  2. Confirm with
    Reactivate license of PDF Maker

    Reactivate license of PDF Maker

Yes No Suggest edit

9.6.Upgrade

The upgrade of the PDF Maker is initiated in the same way as PDF maker installation or click on Upgrade link in ListView of PDF Maker. So please refer to above installation part for details how to initiate the import of the module from the file.

Upgrade of the PDF Maker

Upgrade of the PDF Maker

 

Upgrade of the PDF Maker

Upgrade of the PDF Maker

As you can be seen on the Picture below you will be notified that the PDF Maker module already exists. Confirm License agreement and upgrade will start immediately when you click on the button.

Upgrade of the PDF Maker

Upgrade of the PDF Maker

After upgrade the notification about successful upgrade is shown.

Yes No Suggest edit

9.7.Uninstall

There is also available option to remove PDF Maker from your vtiger. To uninstall please provide following steps:

  • Go to the ListView of PDF Maker and in Customize choose option Uninstall PDFMaker
    Uninstall PDF Maker

    Uninstall PDF Maker

  • Click on button
    Uninstall PDF Maker

    Uninstall PDF Maker

  • Confirm uninstall with button
    Uninstall PDF Maker

    Uninstall PDF Maker

Now, PDF Maker is removed from your vtiger and your license is deactivated. To use PDF Maker again you need to provide installation and validation steps (see chapter 2.How to install PDF Maker).

Yes No Suggest edit

10.Tips & tricks

10.1.How to define background image

It is possible to define background image for PDF template as shown in the picture below. Just click on
and insert following code (see Picture 8.1):

In addition, you can define background image repeat property via “background-repeat:value;” by values:

  • repeat – default value i.e. not necessary to define
  • repeat-x – the background image will be repeated only horizontally
  • repeat-y – the background image will be repeated only vertically (example below)
  • no-repeat – the background-image will not be repeated

or background position via “background-position:value”.

Background image

Background image

Yes No Suggest edit

10.2.How to print labels, envelopes and more

Below is simple example how to print envelopes/labels. Please provide following steps:

  1. Define simple PDF template – for example with fields for organization address.
  2. Set minimum size of PDF template (100×100 mm).
  3. Use option “Multiple” for Page sizing & Handling according to your needs.
 Envelope/labels printing  with PDF Maker

Envelope/labels printing with PDF Maker

Yes No Suggest edit

11.Change log

11.1.PDF Maker

  • April 2018 – PDF Maker 700.4.0
  • January – March 2018 – PDF Maker 700.3.0 – 700.3.1
    • Minor Improvements and bug fixes
  • July – October 2017 – PDF Maker 700.2.0 – 700.2.3
  • 13. June 2017 – PDF Maker 700.1.5
    • compatibility with vtiger 7
Yes No Suggest edit

11.2.Manual for PDF Maker

Yes No Suggest edit
Suggest Edit

We use cookies to improve our website. By browsing this website, you agree to our use of cookies. More info