Add Extrafields on PDF Models: Difference between revisions
mNo edit summary Tag: 2017 source edit |
No edit summary Tag: 2017 source edit |
||
| Line 28: | Line 28: | ||
Go on the Complementary attributes (invoices) tab | Go on the Complementary attributes (invoices) tab | ||
[[File:Invoices module setup.png|none|thumb]] | [[File:Invoices module setup.png|none|thumb]] | ||
Put the all the mandatory fields, especially the Attribute code that will be used in the next chapters | Put the all the mandatory fields, especially the '''Attribute code''' that will be used in the next chapters | ||
You should end up with something like that : | You should end up with something like that : | ||
| Line 36: | Line 36: | ||
Go on the Complementary attributes (lines) tab | Go on the Complementary attributes (lines) tab | ||
[[File:Invoices module setup line.png|none|thumb]] | [[File:Invoices module setup line.png|none|thumb]] | ||
Put the all the mandatory fields, especially the Attribute code that will be used in the next chapters | Put the all the mandatory fields, especially the '''Attribute code''' that will be used in the next chapters | ||
You should end up with something like that : | You should end up with something like that : | ||
| Line 42: | Line 42: | ||
==Verification on the Invoices Module== | ==Verification on the Invoices Module== | ||
Clic on Billing|Payement and select New invoice | Clic on '''Billing|Payement''' and select '''New invoice''' | ||
If you have created a Module complementary attribute, you should have that : | If you have created a Module complementary attribute, you should have that : | ||
| Line 49: | Line 49: | ||
If you have created a Line complementary attribute, you should have that : | If you have created a Line complementary attribute, you should have that : | ||
[[File:Invoices module line extrafield.png|none|thumb]] | [[File:Invoices module line extrafield.png|none|thumb]] | ||
=Create a new invoice template= | |||
All the steps are describes there [[Create a PDF document template]] | |||
* Open the '''core\modules\facture\doc\''' directory | |||
* Copy the '''pdf_crabe.modules.php''' | |||
* Rename the copy as '''pdf_my_template.modules.php''' | |||
* Edit and make the following changes in the code: | |||
# Rename 'class pdf_crabe' to 'class pdf_my_template' | |||
# Rename constant '$this->name = "crabe";' to '$this->name = "my_template"; | |||
# Save file. Now the template will be available in the list of models in Dolibarr. | |||
# Test this model (see previous section) before going further ... | |||
Revision as of 15:05, 3 October 2019
This page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr.
This is a exemple and needs to be adapted to your needs. It is based on billing document but it will be the same for the others modules
Prerequisite
You can read the following links before, some paragraph will come from these pages :
Create a Complementary Attributes on Invoices Module
First you need to create your complementary attribute. This complementary attributes can be of two types :
- Module complementary attribute
- Line complementary attribute
Access to the configuration
Go on the Dolibarr application > Setup > Modules/Applications
Click on the parameter icon 
of the Invoices module
Then you can create Module or Line complementary attribute
Module complementary attribute
Go on the Complementary attributes (invoices) tab
Put the all the mandatory fields, especially the Attribute code that will be used in the next chapters
You should end up with something like that :
Line complementary attribute
Go on the Complementary attributes (lines) tab
Put the all the mandatory fields, especially the Attribute code that will be used in the next chapters
You should end up with something like that :
Verification on the Invoices Module
Clic on Billing|Payement and select New invoice
If you have created a Module complementary attribute, you should have that :
If you have created a Line complementary attribute, you should have that :
Create a new invoice template
All the steps are describes there Create a PDF document template
- Open the core\modules\facture\doc\ directory
- Copy the pdf_crabe.modules.php
- Rename the copy as pdf_my_template.modules.php
- Edit and make the following changes in the code:
- Rename 'class pdf_crabe' to 'class pdf_my_template'
- Rename constant '$this->name = "crabe";' to '$this->name = "my_template";
- Save file. Now the template will be available in the list of models in Dolibarr.
- Test this model (see previous section) before going further ...