1,953
edits
PolyglotBot (talk | contribs) m (Import interlang links (links to translated versions of this page in other languages) from Multi Language Manager table.) |
No edit summary Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
<!-- BEGIN | = Table of Contents = | ||
<!-- | <!-- BEGIN interlang links --> | ||
Links below | <!-- Do NOT edit this section | ||
[[ | Links below are automatically managed by PolyglotBot | ||
You can edit links on the English source page : Module_Ultimatepdf_EN --> | |||
[[en:Module_Ultimatepdf_EN]] | |||
<!-- END interlang links --> | <!-- END interlang links --> | ||
[[Category: | [[Category:Add-on Modules]] | ||
[[Category:Ultimatepdf]] | [[Category:Ultimatepdf]] | ||
{{ | {{TemplateDocDev}} | ||
{{ | {{TemplateDocUtil}} | ||
= | =Information= | ||
{{TemplateModuleInfo | {{TemplateModuleInfo | ||
|modulename=UltimatePDF | |modulename=UltimatePDF | ||
|editor= | |editor=[[File:Logo atoonet.jpg|link=https://www.atoo-net.com]] | ||
| | |||
|webbuy={{LinkToPluginDownloadDoliStore|keyword=ultimatepdf}} | |webbuy={{LinkToPluginDownloadDoliStore|keyword=ultimatepdf}} | ||
|status=stable | |status=stable | ||
|prerequisites= | |prerequisites= | ||
|minversion= | |minversion=18.0.0 - 23.0.0 | ||
|note= | |note= | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
}} | }} | ||
= Features = | =Features= | ||
The true Swiss Army knife with '''over 100 blades!''' that lets you customize your PDF documents to match your company's visual identity. You can choose: | |||
* Font color, border color, and frame background color. | |||
* The style of border lines (solid or dashed). | |||
Adds many features to documents: | |||
* '''PDF document concatenation''' on all document types (T&Cs, technical datasheets...). | |||
* '''Independent reference column'''. | |||
* '''Line numbering column'''. | |||
* '''Independent image column'''. | |||
* '''Signature and "Approved" stamp block'''. | |||
* '''Currency symbols displayed after amounts'''. | |||
* '''Bill of Exchange (LCR) for invoices'''. | |||
* '''And much more...'''. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Prerequisites== | |||
'''Dolibarr:''' Supported versions: | |||
* '''20.x''' | |||
* '''21.x''' | |||
* '''22.x''' | |||
* '''23.x''' | |||
Each version of UltimatePDF corresponds to the equivalent version of Dolibarr: | |||
* '''UltimatePDF 20''' → '''Dolibarr 20''' | |||
* '''UltimatePDF 21''' → '''Dolibarr 21''' | |||
* '''UltimatePDF 22''' → '''Dolibarr 22''' | |||
* '''UltimatePDF 23''' → '''Dolibarr 23''' | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
=⚙️ Installation Procedure= | |||
===⚙️ Manual Installation=== | |||
# '''Download''' the module archive file (.zip). | |||
# '''Place''' the file in the Dolibarr root directory. | |||
# '''Unzip''' the file using the command: | |||
<code>unzip module_ultimatepdf-X.0.0.zip</code> | |||
# '''Verify''' that the correct module location is: | |||
<code>htdocs/custom/ultimatepdf</code> | |||
# '''The module is now available''' and can be enabled from Dolibarr. | |||
--- | |||
===⚙️ Installation via the Dolibarr Interface=== | |||
You can also '''deploy and install''' the module directly from the Dolibarr interface: | |||
# Go to the '''Configuration''' > '''Modules/Applications''' menu. | |||
# Go to the '''Deploy/Install an external module''' tab. | |||
# Click '''Choose a file''' and select the module .zip file. | |||
# Click '''Send File''' to start the installation. | |||
# Enable the module once installation is complete. | |||
'''✅ The module is now operational and ready to use!''' | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
=⚙️ Configuration= | |||
To use this module, you must first enable it. | |||
After logging in with an administrator account: | |||
# Go to '''Home > Configuration > Modules'''. | |||
# In the '''Main Modules / Multi-module Tools''' tab, find '''UltimatePDF'''. | |||
# Click the activation button. | |||
# A settings icon appears at the end of the module row. Click it to access the settings. | |||
Once enabled, the module supports several document templates in Dolibarr: | |||
===Supported Document Templates=== | |||
* '''ultimate_propal''': Commercial proposal templates. | |||
* '''ultimate_order''': Order document templates. | |||
* '''ultimate_invoice''': Invoice templates. | |||
* '''ultimate_shipment''': Shipping slip templates. | |||
* '''ultimate_receipt''': Customer delivery receipt templates. | |||
* '''ultimate_supplierinvoice''': Supplier invoice templates. | |||
* '''ultimate_supplierorder''': Supplier order templates. | |||
* '''ultimate_supplierproposal''': Supplier price request templates. | |||
* '''ultimate_project''': Project report templates. | |||
* '''ultimate_contract''': Contract and subscription templates. | |||
* '''ultimate_expensereport''': Expense report templates. | |||
* '''ultimate_product''': Product document templates. | |||
* '''ultimate_bom''': Templates for the BOM module. | |||
✅ ''Once enabled, the module is immediately operational and ready to use in Dolibarr.'' | |||
= | ==='''Quick Access'''=== | ||
Dolibarr | <i class="fas fa-bolt"></i> You can access the module configuration from its dedicated menu in Dolibarr. If you need help, click the '''"?"''' button in the top right corner of the interface. | ||
--- | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
[[File:Ultimatepdf_docu_001.png|959x358px|link=Special:FilePath/Ultimatepdf_docu_001.png]] | |||
* Template example: [[https://wiki.dolibarr.org/images/d/d8/PR2007-0087.pdf]] | |||
* | |||
==Template Configuration== | |||
''' | '''Module-specific configuration page:''' | ||
= | [[File:model_01.png|960px|link=Special:FilePath/model_01.png]] | ||
' | On the module's dedicated configuration page, several tabs are available: | ||
* Templates Tab | |||
Here you can create and edit your templates: | |||
# Fill in the label field to give your template a name. | |||
# Give a description of your template so you can find it easily (e.g. "My blue template with VAT and References"). | |||
# Option to use a different font than the one configured in the language file, for example "DejaVuSans". Personally I like Raleway and Roboto. | |||
# Fill the | |||
# Give a description of your | |||
# | |||
( <i class="fas fa-exclamation-triangle"></i> '''Warning: some exotic fonts cause display issues with currencies, and don't forget to select one or the system will crash''') | |||
# | # Display a background image on your templates. | ||
# Remember to adjust the background image transparency, as it may hide certain areas of the document. | |||
# Configure the image position using X and Y coordinates. | |||
# Option to use a PDF as the document background. ( !''' Warning: This feature can behave unpredictably, for example it may only apply on every other page, etc...''') | |||
[[File: | [[File:model_02.png|960px|link=Special:FilePath/model_02.png]] | ||
( <i class="fas fa-exclamation-triangle"></i>''' Info: a new full-width banner layout is now available''') | |||
[[File: | [[File:model_03.png|960px|link=Special:FilePath/model_03.png]] | ||
[[File:model_04.png|960px|link=Special:FilePath/model_04.png]] | |||
<i class="fas fa-exclamation-triangle"></i> Option to use a different logo than your company logo (for themed subsidiaries, for example). | |||
# Allows you to hide the alternate logo without deleting it, and display your company logo instead. | |||
# You can hide your company logo and only display the company name, or use the alternate logo in full page width. | |||
# Allows displaying the Qualibat logo in the footer of PDF documents. | |||
[[File: | [[File:model_05.png|960px|link=Special:FilePath/model_05.png]] | ||
<i class="fas fa-exclamation-triangle"></i> Option to change the contact details of the issuing company. | |||
[[File: | [[File:model_06.png|960px|link=Special:FilePath/model_06.png]] | ||
[[File:model_07.png|960px|link=Special:FilePath/model_07.png]] | |||
= | [[File:model_08.png|960px|link=Special:FilePath/model_08.png]] | ||
# Upload an image (A4 page size) to display on the first page of a commercial proposal; it will be added to the list of preconfigured pages available for selection. | |||
# Use the color picker to set a background color for address blocks. | |||
# Use the color picker to set a background color for column headers. | |||
# Use the color picker to set a border color. | |||
# Use the color picker to set a text color. | |||
# Use the color picker to set a QR code color. | |||
# Show or hide the background color of address blocks independently. | |||
# Configure the border line style (dashed or solid). | |||
# Configure the background color transparency. | |||
# Configure the corner radius (rounded or right-angled). | |||
# Show or hide the VAT column and amounts. | |||
# Swap the sender/receiver address block positions. | |||
# Show or hide column borders. | |||
# Adjust your document margins. | |||
[[File:model_09.png|960px|link=Special:FilePath/model_09.png]] | |||
[[File:Ultimatepdf_help-04.png|800px|link=Special:FilePath/Ultimatepdf_help-04.png]] | |||
# Adjust the width of the line numbering column. | |||
# Show or hide the reference column. | |||
# Adjust the width of the reference column. | |||
[[File:Ultimatepdf_help-05.png|850px|link=Special:FilePath/Ultimatepdf_help-05.png]] | |||
# Adjust the width of the description column. | |||
# Adjust the width of the image column. | |||
[[File:Ultimatepdf_help-06.png|800px|link=Special:FilePath/Ultimatepdf_help-06.png]] | |||
- Hide the | # Adjust the width of the VAT column. | ||
# Adjust the width of the unit price column. | |||
[[File:Ultimatepdf_help-07.png|800px|link=Special:FilePath/Ultimatepdf_help-07.png]] | |||
# Adjust the width of the quantity column. | |||
# Adjust the width of the unit column. | |||
# Adjust the width of the discount column. | |||
[[File:Ultimatepdf_help-08.png|800px|link=Special:FilePath/Ultimatepdf_help-08.png]] | |||
# Change the height of the free-text block area (at the bottom of the page). | |||
# Change the font size of the free text. | |||
# Display the signature of the assigned representative in the public note block. | |||
[[File:Ultimatepdf_help-09.png|800px|link=Special:FilePath/Ultimatepdf_help-09.png]] | |||
# Configure the footer text color. | |||
Now don't forget to select your template by clicking the icon in the top right menu. | |||
[[File:Ultimatepdf_docu_002.png|800px|link=Special:FilePath/Ultimatepdf_docu_002.png]] | |||
Select the template from the dropdown list. | |||
Online training: [[http://www.youtube.com/watch?v=bw3a08poCmU]] (based on an older template, but the principles remain the same) | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Options Tab== | |||
See the [[Options Tab]] page. | |||
[[File:Ultimatepdf_docu_003.png|800px|link=Special:FilePath/Ultimatepdf_docu_003.png]] | |||
You can manage the following features here: | |||
'''Address block construction rules''': | |||
- Hide the alternate logo. | |||
- Hide your company logo. | |||
- Use the contact's company name in the delivery address. | |||
- Add the public note to the source address block. | |||
- Display phone, fax and email when a contact address is used. | |||
- Use a contact's company name in the document. | |||
- Hide the intra-community VAT number in address blocks. | |||
- Display professional ID in addresses - Prof. ID 1 (SIREN) - Source address | |||
- Display professional ID in addresses - Prof. ID 2 (SIRET) - Source address | |||
- Display professional ID in addresses - Prof. ID 3 (NAF-APE) - Source address | |||
- Display professional ID in addresses - Prof. ID 4 (RCS/RM) - Source address | |||
- Display professional ID in addresses - Prof. ID 5 (EORI number) - Source address | |||
- Display professional ID in addresses - Prof. ID 1 (SIREN) - Third-party address | |||
- Display professional ID in addresses - Prof. ID 2 (SIRET) - Third-party address | |||
- Display professional ID in addresses - Prof. ID 3 (NAF-APE) - Third-party address | |||
- Display professional ID in addresses - Prof. ID 4 (RCS/RM) - Third-party address | |||
- Display professional ID in addresses - Prof. ID 5 (EORI number) - Third-party address | |||
[[File:Ultimatepdf_help-6-02.png|800px|link=Special:FilePath/Ultimatepdf_help-6-02.png]] | |||
You can manage the following features here: | |||
'''Column construction rules''': | |||
- Hide the long description in the description column. | - Hide the long description in the description column. | ||
- Hide references in the description column. | |||
- Hide all data in columns after the description (VAT, list price, Qty, Discount, Total). | |||
- Display lines with amounts including tax by default. | |||
- Hide only the VAT column, but display amounts in the total. | |||
- Hide pre-tax amounts. | |||
- Hide quantities. | |||
- Hide VAT amounts. | |||
- Enable the units column for products. | |||
- Hide | '''Miscellaneous settings''' | ||
- Hide the bank account RIB section. | |||
- Use automatic line wrapping for the free-text footer. | |||
[[File:Ultimatepdf_help-15.0.040bis.png|link=Special:FilePath/Ultimatepdf_help-15.0.040bis.png]] | |||
- Add the ability to automatically attach your Terms & Conditions to PDF documents (invoices, quotes, orders). | |||
[[File:Ultimatepdf_help-6-03.png|link=Special:FilePath/Ultimatepdf_help-6-03.png]] | |||
'''Other options''' | |||
- Display the third-party barcode at the bottom of your documents. | |||
- Default barcode type used for third parties. | |||
'''Paper format''' | |||
- Paper format. | |||
'''Settings can now be configured independently for all document types''' | |||
- Add a dashed line between product/service lines. | |||
- Display a folding mark at one-third of the page. | |||
- Display product photo thumbnails in your Proposals. | |||
- Display product photo thumbnails in your Orders. | |||
- Display product photo thumbnails in your Invoices. | |||
- Do not repeat the header on multi-page documents. | |||
- Display an alternate logo instead of the company logo. | |||
- Display a background image on your documents. | |||
- Display the "Approved" signature block. | |||
- Display the signature of the assigned representative in the public note block. | |||
- Hide the bank account RIB section. | |||
- Display the third-party barcode in Proposals, Orders, Shipments and Invoices. | |||
- Display the third-party QR code in Proposals, Orders, Invoices and Shipments. | |||
- Display the mention: "Reverse charge – subcontracting scheme". | |||
- Show or hide the LS and LR columns on shipping slips. | |||
- Add and merge one or more PDFs into your Proposals, Invoices or Orders. | |||
- Add a custom line using dictionaries and extra fields in your Proposals, Invoices or Orders. | |||
- Choose which bank account to display on invoices. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Commercial Proposals Tab== | |||
[[File:model_10.png|960px|link=Special:FilePath/model_10.png]] | |||
==Rules for Address Section Content== | |||
- Display phone, fax and email when a contact address is used. | |||
- Display the sales representative following the proposal. | |||
- Display customer phone, fax and email. | |||
- Hide source details in the address block. | |||
- Hide intra-community VAT display in address blocks. | |||
[[File:model_11.png|960px|link=Special:FilePath/model_11.png]] | |||
==Miscellaneous Settings== | |||
- Enter the target bank account for the commercial proposal. | |||
- Display product barcodes in commercial proposals. | |||
- Display the third-party barcode at the top of your proposals. | |||
- Display the third-party QR code at the top of your proposals. | |||
- Display your company QR code at the top of your proposals. | |||
- Display the project title in your commercial proposal. | |||
- Display the project reference in the commercial proposal. | |||
- Display linked objects in your proposal. | |||
- Do not repeat the header on multi-page documents. | |||
- Manage versions of your commercial proposals. | |||
- Settings can now be configured independently for commercial proposals. | |||
- Display barcode for each product line: [https://www.doliweb.com/comm/propal/card.php?id=506&action=confirm_validate&confirm=yes&token=3953f896e38e82e3e1ed291aaf3c40bb example] | |||
- Display an "electronic signature": [https://www.doliweb.com/public/onlinesign/newonlinesign.php?ref=PR2210-0171&source=proposal&message=signed&securekey=7b30ad6f3d9c994063423777c96e66b5 example] | |||
- Manage versions of your commercial proposals: [https://www.doliweb.com/comm/propal/card.php?id=506&action=confirm_validate&confirm=yes&token=3953f896e38e82e3e1ed291aaf3c40bb example] | |||
[[File:model_12.png|960px|link=Special:FilePath/model_12.png]] | |||
==Sub-menu Configuration== | |||
- Display the date in text format. | |||
- Hide the customer code sub-menu. | |||
- Hide the customer reference sub-menu. | |||
- Hide the availability sub-menu. | |||
- Hide the delivery date sub-menu. | |||
- Hide the sales representative sub-menu. | |||
<i class="fas fa-exclamation-triangle"></i> Sub-menu positions are automatically recalculated based on how many are shown or hidden. | |||
[[File:model_13.png|960px|link=Special:FilePath/model_13.png]] | |||
==Document Body Configuration== | |||
- Add a dashed line between product/service lines. | |||
- Display a folding mark at one-third of the page to facilitate mailing. | |||
- Hide the long description in the description column. | |||
- Allow data to flow onto the previous page if the description is long enough. | |||
- Display the signature of the assigned representative in the public note block. | |||
- Add "Case handled by" in the public note block. | |||
- Display the line numbering column. | |||
- Display product photo thumbnails in your Proposals. | |||
- Display the unit price excluding tax column in commercial proposals. | |||
- Display the discount column in commercial proposals. | |||
- Display the unit price after discount column in commercial proposals. | |||
- Display the quantity column in commercial proposals. | |||
- Display the weight column in commercial proposals. | |||
[[File:model_14.png|960px|link=Special:FilePath/model_14.png]] | |||
==Footer Configuration== | |||
- Display the total weight in the Total block. | |||
- Display the "Approved" signature block. | |||
- Add the manager's signature at the bottom of commercial proposals. | |||
- Display "Reverse charge – subcontracting scheme" on proposals. | |||
- Add one or more introduction pages. | |||
- Merge PDFs directly linked to products in the commercial proposal. | |||
- Attach PDF files by merging them into the commercial proposal. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Orders Tab== | |||
- Settings can now be configured independently for orders. | |||
[[File:model_15.png|960px|link=Special:FilePath/model_15.png]] | |||
==Rules for Address Section Content== | |||
- Display phone, fax and email when a contact address is used. | |||
- Display customer phone, fax and email. | |||
- Hide source details in the address block. | |||
- Hide intra-community VAT display in address blocks. | |||
[[File:model_16.png|960px|link=Special:FilePath/model_16.png]] | |||
==Miscellaneous Settings== | |||
- Display product barcodes in orders. | |||
- Display the third-party barcode at the top of your orders. | |||
- Display the third-party QR code at the top of your orders. | |||
- Display the order QR code at the top of your orders. | |||
- Display your company QR code at the top of your orders. | |||
- Display project references in orders. | |||
- Display project titles in orders. | |||
- Do not repeat the header on multi-page documents. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Invoices Tab== | |||
[[File:Ultimatepdf_help-6-06.png|link=Special:FilePath/Ultimatepdf_help-6-06.png]] | |||
- Settings can now be configured independently for invoices. | |||
- Display the "Reverse charge – subcontracting scheme" line on your invoices. | |||
- Enable the progress billing feature. | |||
- Hide already paid amounts on invoices. | |||
- | - Add the manager's signature at the bottom of invoices. | ||
- | - Display the outstanding balance amount in the document. | ||
- | - Add the ability to convert amounts and numbers to text. | ||
- | - Attach PDF files by merging them into the invoice. | ||
'' | ''[[#Table of Contents|⬆ Back to top]]'' | ||
==Shipments Tab== | |||
[[File:Ultimatepdf_help-6-07.png|link=Special:FilePath/Ultimatepdf_help-6-07.png]] | |||
- | - Settings can now be configured independently for shipments. | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Receipts Tab== | |||
[[File:Ultimatepdf_help-6-08.png|link=Special:FilePath/Ultimatepdf_help-6-08.png]] | |||
- | - Settings can now be configured independently for Delivery Receipts. | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Supplier Orders Tab== | |||
[[File:Ultimatepdf_help-6-09.png|link=Special:FilePath/Ultimatepdf_help-6-09.png]] | |||
- | - Settings can now be configured independently for Supplier Orders. | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Supplier Invoices Tab== | |||
[[File:Ultimatepdf_help-6-10.png|link=Special:FilePath/Ultimatepdf_help-6-10.png]] | |||
- | - Settings can now be configured independently for supplier invoices. | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Price Requests Tab== | |||
= | [[File:Ultimatepdf_help-6-11.png|link=Special:FilePath/Ultimatepdf_help-6-11.png]] | ||
- Settings can now be configured independently for Price Requests. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
== | ==Contracts Tab== | ||
[[File:Ultimatepdf_help- | [[File:Ultimatepdf_help-6-12.png|link=Special:FilePath/Ultimatepdf_help-6-12.png]] | ||
- Settings can now be | - Settings can now be configured independently for contracts. | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Expense Reports Tab== | |||
[[File:Ultimatepdf_help-6-13.png|link=Special:FilePath/Ultimatepdf_help-6-13.png]] | |||
- Settings can now be configured independently for Expense Reports. | |||
[[ | ''[[#Table of Contents|⬆ Back to top]]'' | ||
==Interventions Tab== | |||
= | [[File:Ultimatepdf_help-6-14.png|link=Special:FilePath/Ultimatepdf_help-6-14.png]] | ||
- Settings can now be configured independently for Interventions. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
== | ==Projects Tab== | ||
[[File:Ultimatepdf_help- | [[File:Ultimatepdf_help-13-15.png|link=Special:FilePath/Ultimatepdf_help-13-15.png]] | ||
- Settings can now be | - Settings can now be configured independently for Projects. | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||
==Products Tab== | |||
[[File:Ultimatepdf_help-15-16.png|link=Special:FilePath/Ultimatepdf_help-15-16.png]] | |||
- Settings can now be configured independently for Products. | |||
[[ | ''[[#Table of Contents|⬆ Back to top]]'' | ||
==BOMs Tab== | |||
== | [[File:Ultimatepdf help-15 17.png|link=link=Special:FilePath/Ultimatepdf_help-15-17.png|alt=]] | ||
- Settings can now be configured independently for BOMs. | |||
''[[#Table of Contents|⬆ Back to top]]'' | |||
= Usage = | =Usage= | ||
Easy to use | Easy to use — in just a few clicks your documents reflect your brand colors, and each of your team members can have their own personalized documents. | ||
Despite all its features, if UltimatePDF does not allow you to create a highly specialized document template, you can contact us to have it built with custom development: [mailto:contact@atoo-net.com email me] | |||
=Compatibility and Synergies= | |||
- Milestone | UltimatePDF is compatible with: | ||
- Purchase | - The Milestone module | ||
- Incoterm module | - The MBI Signature module | ||
- The Sales and Purchase Unit Management module (displays results in a units column across all templates) | |||
- The Incoterm module | |||
- Progress billing management. | |||
= Development = | =Development= | ||
UltimatePDF is a module maintained on the Framasoft Git: | |||
https://git.framasoft.org/grandoc/ultimatepdf | https://git.framasoft.org/grandoc/ultimatepdf | ||
''[[#Table of Contents|⬆ Back to top]]'' | |||