Dolibarr ERP CRM Wiki - User contributions [en]

Module AI (Artificial Intelligence)

2024-05-10T18:02:08Z

Abdel:

{{TemplateDocUser}}{{TemplateModEN}}{{BasculeDevUserEn|devdoc=[[Module AI(developer)]]|name=AI (Artificial Intelligence) functionalities|num=4560|userdoc=This page}}

 
=Introduction=
With this module, you can generate a wide range of content with ease'''.''' Craft compelling text, produce stunning images, create natural-sounding audio, translate languages effortlessly, and explore endless creative possibilities.

This user-friendly module integrates seamlessly with Dolibarr, empowering you to save time, enhance communication, and reach a global audience.
=Installation=
{{NoInstallModuleEn}}
=Configuration=
{{ActivationModuleEn}}
Note that activating this module will automatically activate the [https://wiki.dolibarr.org/Module_Third_Parties Module Third Parties].

=More configuration=

To set up the service, simply select the AI provider (such as ChatGPT, Grok, or another) and specify the API key, which you can find in a section of your account for that service. Additionally, the module allows you to configure the prompt for each specific instruction.

You can edit the prompt by clicking on the button edit, also you can delete it.

For example, if you're using a text generation feature, you can set a '''pre-prompt''' that contains the required instruction and a '''post-prompt''' that adds further details. This approach can make it much easier for your AI to generate highly specific output
[[File:Ai config.png|center|frame|this image show the form to create pre-prompt et post-prompt for function needed]]

*

=Generate with the dedicated prompt=

By activating module AI, a button will be showed for display the prompt where you can fill in your instruction.

'''Note :''' For the time being, this function is only available when sending emails.
[[File:Ai generate.png|border|center|frameless|1327x1327px]]
 

=Life cycle=
 [[File:Schema.png|center|thumb|759x759px]]

Module AI (Artificial Intelligence)

2024-05-10T17:57:24Z

Abdel: /* Generate with the dedicated prompt */

{{TemplateDocUser}}{{TemplateModEN}}{{BasculeDevUserEn|devdoc=[[Module AI(developer)]]|name=AI (Artificial Intelligence) functionalities|num=80|userdoc=This page}} 
=Introduction=
With this module, you can generate a wide range of content with ease'''.''' Craft compelling text, produce stunning images, create natural-sounding audio, translate languages effortlessly, and explore endless creative possibilities.

This user-friendly module integrates seamlessly with Dolibarr, empowering you to save time, enhance communication, and reach a global audience.
=Installation=
{{NoInstallModuleEn}}
=Configuration=
{{ActivationModuleEn}}
Note that activating this module will automatically activate the [https://wiki.dolibarr.org/Module_Third_Parties Module Third Parties].

=More configuration=

To set up the service, simply select the AI provider (such as ChatGPT, Grok, or another) and specify the API key, which you can find in a section of your account for that service. Additionally, the module allows you to configure the prompt for each specific instruction.

You can edit the prompt by clicking on the button edit, also you can delete it.

For example, if you're using a text generation feature, you can set a '''pre-prompt''' that contains the required instruction and a '''post-prompt''' that adds further details. This approach can make it much easier for your AI to generate highly specific output
[[File:Ai config.png|center|frame|this image show the form to create pre-prompt et post-prompt for function needed]]

*

=Generate with the dedicated prompt=

By activating module AI, a button will be showed for display the prompt where you can fill in your instruction.

'''Note :''' For the time being, this function is only available when sending emails.
[[File:Ai generate.png|border|center|frameless|1327x1327px]]
 

=Life cycle=
 [[File:Schema.png|center|thumb|759x759px]]

Module AI (Artificial Intelligence)

2024-05-10T17:56:56Z

Abdel: /* More configuration */

{{TemplateDocUser}}{{TemplateModEN}}{{BasculeDevUserEn|devdoc=[[Module AI(developer)]]|name=AI (Artificial Intelligence) functionalities|num=80|userdoc=This page}} 
=Introduction=
With this module, you can generate a wide range of content with ease'''.''' Craft compelling text, produce stunning images, create natural-sounding audio, translate languages effortlessly, and explore endless creative possibilities.

This user-friendly module integrates seamlessly with Dolibarr, empowering you to save time, enhance communication, and reach a global audience.
=Installation=
{{NoInstallModuleEn}}
=Configuration=
{{ActivationModuleEn}}
Note that activating this module will automatically activate the [https://wiki.dolibarr.org/Module_Third_Parties Module Third Parties].

==More configuration==

To set up the service, simply select the AI provider (such as ChatGPT, Grok, or another) and specify the API key, which you can find in a section of your account for that service. Additionally, the module allows you to configure the prompt for each specific instruction.

You can edit the prompt by clicking on the button edit, also you can delete it.

For example, if you're using a text generation feature, you can set a '''pre-prompt''' that contains the required instruction and a '''post-prompt''' that adds further details. This approach can make it much easier for your AI to generate highly specific output
[[File:Ai config.png|center|frame|this image show the form to create pre-prompt et post-prompt for function needed]]

*

==Generate with the dedicated prompt==

By activating module AI, a button will be showed for display the prompt where you can fill in your instruction.

'''Note :''' For the time being, this function is only available when sending emails.
[[File:Ai generate.png|border|center|frameless|1327x1327px]]
 

=Life cycle=
 [[File:Schema.png|center|thumb|759x759px]]

Module AI (Artificial Intelligence)

2024-05-10T17:56:04Z

Abdel: /* Life cycle */

{{TemplateDocUser}}{{TemplateModEN}}{{BasculeDevUserEn|devdoc=[[Module AI(developer)]]|name=AI (Artificial Intelligence) functionalities|num=80|userdoc=This page}} 
=Introduction=
With this module, you can generate a wide range of content with ease'''.''' Craft compelling text, produce stunning images, create natural-sounding audio, translate languages effortlessly, and explore endless creative possibilities.

This user-friendly module integrates seamlessly with Dolibarr, empowering you to save time, enhance communication, and reach a global audience.
=Installation=
{{NoInstallModuleEn}}
=Configuration=
{{ActivationModuleEn}}
Note that activating this module will automatically activate the [https://wiki.dolibarr.org/Module_Third_Parties Module Third Parties].

==More configuration==
To set up the service, simply select the AI provider (such as ChatGPT, Grok, or another) and specify the API key, which you can find in a section of your account for that service. Additionally, the module allows you to configure the prompt for each specific instruction.

You can edit the prompt by clicking on the button edit, also you can delete it.

For example, if you're using a text generation feature, you can set a '''pre-prompt''' that contains the required instruction and a '''post-prompt''' that adds further details. This approach can make it much easier for your AI to generate highly specific output
[[File:Ai config.png|center|frame|this image show the form to create pre-prompt et post-prompt for function needed]]

*

==Generate with the dedicated prompt==
By activating module AI, a button will be showed for display the prompt where you can fill in your instruction.

'''Note :''' For the time being, this function is only available when sending emails.
[[File:Ai generate.png|border|center|frameless|1327x1327px]]
 

==Life cycle==
[[File:Schema.png|center|thumb|759x759px]]

Module AI (Artificial Intelligence)

2024-05-10T17:55:19Z

Abdel:

{{TemplateDocUser}}{{TemplateModEN}}{{BasculeDevUserEn|devdoc=[[Module AI(developer)]]|name=AI (Artificial Intelligence) functionalities|num=80|userdoc=This page}} 
=Introduction=
With this module, you can generate a wide range of content with ease'''.''' Craft compelling text, produce stunning images, create natural-sounding audio, translate languages effortlessly, and explore endless creative possibilities.

This user-friendly module integrates seamlessly with Dolibarr, empowering you to save time, enhance communication, and reach a global audience.
=Installation=
{{NoInstallModuleEn}}
=Configuration=
{{ActivationModuleEn}}
Note that activating this module will automatically activate the [https://wiki.dolibarr.org/Module_Third_Parties Module Third Parties].

== More configuration ==
To set up the service, simply select the AI provider (such as ChatGPT, Grok, or another) and specify the API key, which you can find in a section of your account for that service. Additionally, the module allows you to configure the prompt for each specific instruction.

You can edit the prompt by clicking on the button edit, also you can delete it.

For example, if you're using a text generation feature, you can set a '''pre-prompt''' that contains the required instruction and a '''post-prompt''' that adds further details. This approach can make it much easier for your AI to generate highly specific output
[[File:Ai config.png|center|frame|this image show the form to create pre-prompt et post-prompt for function needed]]

*

== Generate with the dedicated prompt ==
By activating module AI, a button will be showed for display the prompt where you can fill in your instruction.

'''Note :''' For the time being, this function is only available when sending emails.
[[File:Ai generate.png|border|center|frameless|1327x1327px]]
 

== Life cycle ==
[[File:Schema.png|center|thumb]]

File:Schema.png

2024-05-10T17:52:11Z

Abdel:

process

File:Ai generate.png

2024-05-10T16:44:43Z

Abdel:

ai prompt

File:Ai config.png

2024-05-10T16:29:14Z

Abdel:

more config ai module

User documentation

2024-05-10T16:15:27Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : Tool to generate email template,audio, images... by choosing service AI (Chatgpt,Grok..)(Experimental)
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

User documentation

2024-05-10T16:13:40Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : Tool to generate email template,audio, images... by choosing witch AI (Chatgpt,Grok..)(Experimental)
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

Module AI (Artificial Intelligence)

2024-05-10T16:01:17Z

Abdel: Created page with "<!--You can edit this section but do NOT remove these comments Links below will be automatically replicated on translated pages by Poly..."

User documentation

2024-05-10T16:00:05Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : tool for generating email, text and images...(Experimental)
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

User documentation

2024-05-10T15:58:46Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : tool for generating email, text and images...(Experimental)
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

User documentation

2024-05-10T15:58:12Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : tool for generating email, text and images...
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

User documentation

2024-05-10T15:56:29Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : tool for generating email, text and images...
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

User documentation

2024-05-10T15:56:02Z

Abdel: /* Multi-modules tools */

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]
[[ro:Documentaţie utilizator]]
[[pt:Documentação_dos_utilizadores]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

Documentation on how to use Dolibarr is provided in next chapters

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=Dashboard=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=Usage (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==Human Resource Management (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|-
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|-
| style="text-align:center;" |
|'''[[Module AI Functionalities]]''' : tool for generating email, text and images...}
|

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services (Deprecated)
|-
| style="text-align:center;" |
|'''[[Module Webhook|Web hooks]]''' : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

Module ModuleBuilder

2024-05-07T17:46:42Z

Abdel: /* CSS / JS / CLI */

[[zh:ModuleBuilder用户手册]]


[[Category:Core]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Foundations|
num=3300|
devdoc=|
userdoc=This page|}}

=Introduction=
The ModuleBuilder is a module for developpers only, to help you to develop a module.
It is RAD, No Code or Low Code tool.

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

=Usage=
The ModuleBuilder within Dolibarr presents a lot of features designed for the comprehensive management and development of module.

==Creating a new module==
Click on the "Bug" picto on top right in the menu bar to reach the ModuleBuilder tool.

First, create a new module by clicking on the link "New module".

Choose a name and some options.
First files to have a working module will be generated. You can already enable and disable your module from the common page to enabled/disable module of Dolibarr. However, it is recommended to work on the other steps of development of your module, with the module not enabled.

==Work on your new module==

===Language Support===

*This function allows developers to introduce additional languages into a module, enhancing its accessibility and usability across different linguistic demographics.
*It involves integrating new language files or entries that translate the module's interface and messages.

 
[[File:AddLanguage.png|center|thumb|1446x1446px]]
 

===Menus===
Enables the crafting of custom menus within the module's UI, allowing users to navigate through the module's features more efficiently. This might include adding new menu items linked to specific functionalities or adjusting the module's navigation structure.

*Creating menus in the system is achieved through two distinct methods: Initially, when an object is created, three menus are automatically generated and displayed on the left sidebar. Alternatively, menus and sub-menus can be manually added by utilizing the form at the top of the table, which requires filling in specific fields such as title, URL, and position. Furthermore, permissions can be assigned to each menu to ensure they are only visible to users with the appropriate rights.
*The editing process mirrors this approach closely.
*For deletion, one needs to click on the trash can icon and confirm to proceed with the removal.

 
[[File:Menus.png|center|frameless|1482x1482px]]

===Object===

*To add an object, simply enter the name, choose an icon, and specify the name of an existing table, if nothing is specified, it creates a new table.
*The three check-boxes depend on your preference: one for enabling automatic numbering generation, the second for enabling PDF document creation, and the third to generate permissions for the object created.

 
[[File:AddObject.png|center|thumb|1301x1301px|'''Add Object''']]

In the description of an object within a Dolibarr module developed using ModuleBuilder, several essential components and functionalities are outlined. These include :

*'''PHP DAO CRUD Class''': This is the core PHP class that handles database operations such as create, read, update, and delete for the object, ensuring seamless data management.
*'''Icon Representation''': An icon specified for visual representation of the object in the user interface, aiding in quick identification.
*'''Module API''': Defines the application programming interface for the module, enabling external interactions and integrations.(one file contain CRUD methods for each object created).
*'''Unit Testing''': A set of PHP unit tests designed to verify the functionality and reliability of the object, ensuring robust operation.
*'''Library Files''': Comprise both a common library file for module-wide functions and an object-specific library file, which includes functions unique to the object's logic and operations.
*'''SQL Scripts''': Include the main SQL script for creating the object's database table, along with additional scripts for keys, indexes, and extra fields, ensuring optimized database structure and performance.
*'''User Interface Pages''':
**A listing page for viewing all records of the object,
**A detailed card page for creating, modifying, and displaying individual records,
**Dedicated pages for managing related contacts, documents, notes, and events, each providing specialized functionalities within the object's context.

'''The setup also features a button, facilitating the generation, modification, or deletion of these components as needed. This system offers a comprehensive framework for extending and customizing the object within the module, providing developers with a robust set of tools for module customization and functionality enhancement.'''
 
 
[[File:DolObject.png|center|thumb|1408x1408px]]
 
==='''Property Addition''':===
This feature permits the extension of entities or modules by adding new properties. These properties can be utilized to store additional information, customize behavior, or integrate with other modules, enhancing the module's flexibility and capability.

*To add an additional attribute to a specific object, simply click on the "+" button to the right of the properties list, which will display a form allowing you to fill in fields such as label, type, code, etc.
*To modify, simply click on the pencil icon that appears in the same row of the list, which brings up a form for editing.
*For deletion, the trash can icon allows for the removal of a property after confirmation.

 
[[File:PropertiesObject.png|center|thumb|1402x1402px]]
 
[[File:AddProperties.png|border|center|thumb|1413x1413px]]
 

===Permissions===
For permissions, there are two ways to create them:

*By ticking the box at the bottom of the form during the creation of the object and it creating the 3 default permissions (create, write, delete).
*By manually creating them in the rights section, which provides a list of permissions for each object. The form at the top of the table allows you to select the object and choose a permission; the ID is automatically assigned, as well as the label, although you have the option to change it if desired.

 [[File:PermissionsList.png|center|thumb|1463x1463px]]
 

===Dictionaries===

*To create a dictionary, there is a dedicated section for this purpose. A create button (+) on the right displays a form to enter the name of the dictionary, which will become the name of the table in the database, preceded by "c_".

*The other fields are automatically filled in, and it is recommended to leave them as they are. For editing, you have the option to change the label, the fields for sorting, and for inserting or editing.

 
[[File:ListDict.png|center|thumb|1477x1477px]]

[[File:AddDictionnaire.png|center|thumb|1485x1485px|Add dictionary ]]

===Hooks===

*Define in the <code>module_parts['hooks']</code> property within the module descriptor the contexts in which the hooks should be executed (the list of contexts can be found by searching for 'initHooks(' in the core code). Then, edit the hook file to add the code for your hooked functions (hookable functions can be found by searching for 'executeHooks' in the core code).
*Click the "+" button to generate the hooks code.

===Triggers===

*In a module, the <code>triggers</code> part of the <code>module_parts</code> array indicates whether the module includes its own directory for triggers within Dolibarr's core triggers system, To generate the trigger file, simply use the "+" button provided by the ModuleBuilder interface in triggers section .

===CSS / JS / CLI===

*'''CSS''' : Once generated, you can use the file to define custom styles that will be applied to the module's frontend, improving its appearance and user experience. You can specify styles for layout, colors, fonts, and more, ensuring your module aligns with the desired aesthetic and usability standards.

*'''JavaScript (JS)''' : After generating a JS file, you can write scripts to handle user interactions, perform validations, manipulate DOM elements.

*The '''Command Line Interface (CLI)''' file plays a crucial role in facilitating module interaction via the command line, allowing for the execution of scripts, or functions without a graphical interface. This is particularly useful for automating processes.

By utilizing the ModuleBuilder to generate these files, you simplify the initial setup process for incorporating CSS, JS, and CLI functionalities into your module. Each file serves a distinct purpose, contributing to the module's visual design, interactivity, and operational flexibility, ultimately enhancing its overall utility and integration within the Dolibarr ecosystem.

All these configurations was added in '''modYourModuleName.class.php''' file in folder '''htdocs/custom/YourModuleName/core/modules''' and you can edit it if you want but you should be careful when you manipulate this file '''specially with comments'''.

Module ModuleBuilder

2024-05-07T17:29:30Z

Abdel: /* Object */

Module ModuleBuilder

2024-03-22T17:27:49Z

Abdel: /* Dictionaries : */

[[zh:ModuleBuilder用户手册]]


[[Category:Core]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Foundations|
num=3300|
devdoc=|
userdoc=This page|}}

=Introduction=
The ModuleBuilder is a module for developpers only, to help you to develop a module.
It is RAD, No Code or Low Code tool.

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

=Usage=
The ModuleBuilder within Dolibarr presents a lot of features designed for the comprehensive management and development of module.

==='''Language Support''':===

*This function allows developers to introduce additional languages into a module, enhancing its accessibility and usability across different linguistic demographics.
*It involves integrating new language files or entries that translate the module's interface and messages.

 
[[File:AddLanguage.png|center|thumb|1446x1446px]]
 

==='''Menus''':===
Enables the crafting of custom menus within the module's UI, allowing users to navigate through the module's features more efficiently. This might include adding new menu items linked to specific functionalities or adjusting the module's navigation structure.

*Creating menus in the system is achieved through two distinct methods: Initially, when an object is created, three menus are automatically generated and displayed on the left sidebar. Alternatively, menus and sub-menus can be manually added by utilizing the form at the top of the table, which requires filling in specific fields such as title, URL, and position. Furthermore, permissions can be assigned to each menu to ensure they are only visible to users with the appropriate rights.
*The editing process mirrors this approach closely.
*For deletion, one needs to click on the trash can icon and confirm to proceed with the removal.

 
[[File:Menus.png|center|frameless|1482x1482px]]

===Object:===

*To add an object, simply enter the name, choose an icon, and specify the name of an existing table, if nothing is specified, it creates a new table
*The three check-boxes depend on your preference: one for enabling automatic numbering generation, the second for enabling PDF document creation, and the third to generate permissions for this object.

 
[[File:AddObject.png|center|thumb|1301x1301px|'''Add Object''']]

In the description of an object within a Dolibarr module developed using ModuleBuilder, several essential components and functionalities are outlined. These include:

*'''PHP DAO CRUD Class''': This is the core PHP class that handles database operations such as create, read, update, and delete for the object, ensuring seamless data management.
*'''Icon Representation''': An icon specified for visual representation of the object in the user interface, aiding in quick identification.
*'''Module API''': Defines the application programming interface for the module, enabling external interactions and integrations.
*'''Unit Testing''': A set of PHP unit tests designed to verify the functionality and reliability of the object, ensuring robust operation.
*'''Library Files''': Comprise both a common library file for module-wide functions and an object-specific library file, which includes functions unique to the object's logic and operations.
*'''SQL Scripts''': Include the main SQL script for creating the object's database table, along with additional scripts for keys, indexes, and extra fields, ensuring optimized database structure and performance.
*'''User Interface Pages''':
**A listing page for viewing all records of the object,
**A detailed card page for creating, modifying, and displaying individual records,
**Dedicated pages for managing related contacts, documents, notes, and events, each providing specialized functionalities within the object's context.

'''The setup also features a button, facilitating the generation, modification, or deletion of these components as needed. This system offers a comprehensive framework for extending and customizing the object within the module, providing developers with a robust set of tools for module customization and functionality enhancement.'''
 
 
[[File:DolObject.png|center|thumb|1408x1408px]]
 
==='''Property Addition''':===
This feature permits the extension of entities or modules by adding new properties. These properties can be utilized to store additional information, customize behavior, or integrate with other modules, enhancing the module's flexibility and capability.

*To add an additional attribute to a specific object, simply click on the "+" button to the right of the properties list, which will display a form allowing you to fill in fields such as label, type, code, etc.
*To modify, simply click on the pencil icon that appears in the same row of the list, which brings up a form for editing.
*For deletion, the trash can icon allows for the removal of a property after confirmation.

 
[[File:PropertiesObject.png|center|thumb|1402x1402px]]
 
[[File:AddProperties.png|border|center|thumb|1413x1413px]]
 

===Permissions:===
For permissions, there are two ways to create them:

*By ticking the box at the bottom of the form during the creation of the object and it creating the 3 default permissions (create, write, delete).
*By manually creating them in the rights section, which provides a list of permissions for each object. The form at the top of the table allows you to select the object and choose a permission; the ID is automatically assigned, as well as the label, although you have the option to change it if desired.

 [[File:PermissionsList.png|center|thumb|1463x1463px]]
 

===Dictionaries :===

*To create a dictionary, there is a dedicated section for this purpose. A create button (+) on the right displays a form to enter the name of the dictionary, which will become the name of the table in the database, preceded by "c_".

*The other fields are automatically filled in, and it is recommended to leave them as they are. For editing, you have the option to change the label, the fields for sorting, and for inserting or editing.

 
[[File:ListDict.png|center|thumb|1477x1477px]]

[[File:AddDictionnaire.png|center|thumb|1485x1485px|Add dictionary ]]

=== Hooks : ===

* Define in the <code>module_parts['hooks']</code> property within the module descriptor the contexts in which the hooks should be executed (the list of contexts can be found by searching for 'initHooks(' in the core code). Then, edit the hook file to add the code for your hooked functions (hookable functions can be found by searching for 'executeHooks' in the core code).
* Click the "+" button to generate the hooks code.

=== Triggers : ===

* In a module, the <code>triggers</code> part of the <code>module_parts</code> array indicates whether the module includes its own directory for triggers within Dolibarr's core triggers system, To generate the trigger file, simply use the "+" button provided by the ModuleBuilder interface in triggers section .

=== CSS / JS / CLI : ===

* '''CSS''' : Once generated, you can use the file to define custom styles that will be applied to the module's frontend, improving its appearance and user experience. You can specify styles for layout, colors, fonts, and more, ensuring your module aligns with the desired aesthetic and usability standards.

* '''JavaScript (JS)''' : After generating a JS file, you can write scripts to handle user interactions, perform validations, manipulate DOM elements.

* The '''Command Line Interface (CLI)''' file plays a crucial role in facilitating module interaction via the command line, allowing for the execution of scripts, or functions without a graphical interface. This is particularly useful for automating processes.

By utilizing the ModuleBuilder to generate these files, you simplify the initial setup process for incorporating CSS, JS, and CLI functionalities into your module. Each file serves a distinct purpose, contributing to the module's visual design, interactivity, and operational flexibility, ultimately enhancing its overall utility and integration within the Dolibarr ecosystem.

Module ModuleBuilder

2024-03-22T17:02:20Z

Abdel: /* Dictionaries : */

[[zh:ModuleBuilder用户手册]]


[[Category:Core]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Foundations|
num=3300|
devdoc=|
userdoc=This page|}}

=Introduction=
The ModuleBuilder is a module for developpers only, to help you to develop a module.
It is RAD, No Code or Low Code tool.

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

=Usage=
The ModuleBuilder within Dolibarr presents a lot of features designed for the comprehensive management and development of module.

==='''Language Support''':===

*This function allows developers to introduce additional languages into a module, enhancing its accessibility and usability across different linguistic demographics.
*It involves integrating new language files or entries that translate the module's interface and messages.

 
[[File:AddLanguage.png|center|thumb|1446x1446px]]
 

==='''Menus''':===
Enables the crafting of custom menus within the module's UI, allowing users to navigate through the module's features more efficiently. This might include adding new menu items linked to specific functionalities or adjusting the module's navigation structure.

*Creating menus in the system is achieved through two distinct methods: Initially, when an object is created, three menus are automatically generated and displayed on the left sidebar. Alternatively, menus and sub-menus can be manually added by utilizing the form at the top of the table, which requires filling in specific fields such as title, URL, and position. Furthermore, permissions can be assigned to each menu to ensure they are only visible to users with the appropriate rights.
*The editing process mirrors this approach closely.
*For deletion, one needs to click on the trash can icon and confirm to proceed with the removal.

 
[[File:Menus.png|center|frameless|1482x1482px]]

===Object:===

*To add an object, simply enter the name, choose an icon, and specify the name of an existing table, if nothing is specified, it creates a new table
*The three check-boxes depend on your preference: one for enabling automatic numbering generation, the second for enabling PDF document creation, and the third to generate permissions for this object.

 
[[File:AddObject.png|center|thumb|1301x1301px|'''Add Object''']]

In the description of an object within a Dolibarr module developed using ModuleBuilder, several essential components and functionalities are outlined. These include:

*'''PHP DAO CRUD Class''': This is the core PHP class that handles database operations such as create, read, update, and delete for the object, ensuring seamless data management.
*'''Icon Representation''': An icon specified for visual representation of the object in the user interface, aiding in quick identification.
*'''Module API''': Defines the application programming interface for the module, enabling external interactions and integrations.
*'''Unit Testing''': A set of PHP unit tests designed to verify the functionality and reliability of the object, ensuring robust operation.
*'''Library Files''': Comprise both a common library file for module-wide functions and an object-specific library file, which includes functions unique to the object's logic and operations.
*'''SQL Scripts''': Include the main SQL script for creating the object's database table, along with additional scripts for keys, indexes, and extra fields, ensuring optimized database structure and performance.
*'''User Interface Pages''':
**A listing page for viewing all records of the object,
**A detailed card page for creating, modifying, and displaying individual records,
**Dedicated pages for managing related contacts, documents, notes, and events, each providing specialized functionalities within the object's context.

'''The setup also features a button, facilitating the generation, modification, or deletion of these components as needed. This system offers a comprehensive framework for extending and customizing the object within the module, providing developers with a robust set of tools for module customization and functionality enhancement.'''
 
 
[[File:DolObject.png|center|thumb|1408x1408px]]
 
==='''Property Addition''':===
This feature permits the extension of entities or modules by adding new properties. These properties can be utilized to store additional information, customize behavior, or integrate with other modules, enhancing the module's flexibility and capability.

*To add an additional attribute to a specific object, simply click on the "+" button to the right of the properties list, which will display a form allowing you to fill in fields such as label, type, code, etc.
*To modify, simply click on the pencil icon that appears in the same row of the list, which brings up a form for editing.
*For deletion, the trash can icon allows for the removal of a property after confirmation.

 
[[File:PropertiesObject.png|center|thumb|1402x1402px]]
 
[[File:AddProperties.png|border|center|thumb|1413x1413px]]
 

===Permissions:===
For permissions, there are two ways to create them:

*By ticking the box at the bottom of the form during the creation of the object and it creating the 3 default permissions (create, write, delete).
*By manually creating them in the rights section, which provides a list of permissions for each object. The form at the top of the table allows you to select the object and choose a permission; the ID is automatically assigned, as well as the label, although you have the option to change it if desired.

 [[File:PermissionsList.png|center|thumb|1463x1463px]]
 

===Dictionaries :===

*To create a dictionary, there is a dedicated section for this purpose. A create button (+) on the right displays a form to enter the name of the dictionary, which will become the name of the table in the database, preceded by "c_".

*The other fields are automatically filled in, and it is recommended to leave them as they are. For editing, you have the option to change the label, the fields for sorting, and for inserting or editing.

 
[[File:ListDict.png|center|thumb|1477x1477px]]

[[File:AddDictionnaire.png|center|thumb|1485x1485px|Add dictionary ]]

Module ModuleBuilder

2024-03-22T16:58:09Z

Abdel: /* Object: */

[[zh:ModuleBuilder用户手册]]


[[Category:Core]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Foundations|
num=3300|
devdoc=|
userdoc=This page|}}

=Introduction=
The ModuleBuilder is a module for developpers only, to help you to develop a module.
It is RAD, No Code or Low Code tool.

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

=Usage=
The ModuleBuilder within Dolibarr presents a lot of features designed for the comprehensive management and development of module.

==='''Language Support''':===

*This function allows developers to introduce additional languages into a module, enhancing its accessibility and usability across different linguistic demographics.
*It involves integrating new language files or entries that translate the module's interface and messages.

 
[[File:AddLanguage.png|center|thumb|1446x1446px]]
 

==='''Menus''':===
Enables the crafting of custom menus within the module's UI, allowing users to navigate through the module's features more efficiently. This might include adding new menu items linked to specific functionalities or adjusting the module's navigation structure.

*Creating menus in the system is achieved through two distinct methods: Initially, when an object is created, three menus are automatically generated and displayed on the left sidebar. Alternatively, menus and sub-menus can be manually added by utilizing the form at the top of the table, which requires filling in specific fields such as title, URL, and position. Furthermore, permissions can be assigned to each menu to ensure they are only visible to users with the appropriate rights.
*The editing process mirrors this approach closely.
*For deletion, one needs to click on the trash can icon and confirm to proceed with the removal.

 
[[File:Menus.png|center|frameless|1482x1482px]]

===Object:===

*To add an object, simply enter the name, choose an icon, and specify the name of an existing table, if nothing is specified, it creates a new table
*The three check-boxes depend on your preference: one for enabling automatic numbering generation, the second for enabling PDF document creation, and the third to generate permissions for this object.

 
[[File:AddObject.png|center|thumb|1301x1301px|'''Add Object''']]

In the description of an object within a Dolibarr module developed using ModuleBuilder, several essential components and functionalities are outlined. These include:

*'''PHP DAO CRUD Class''': This is the core PHP class that handles database operations such as create, read, update, and delete for the object, ensuring seamless data management.
*'''Icon Representation''': An icon specified for visual representation of the object in the user interface, aiding in quick identification.
*'''Module API''': Defines the application programming interface for the module, enabling external interactions and integrations.
*'''Unit Testing''': A set of PHP unit tests designed to verify the functionality and reliability of the object, ensuring robust operation.
*'''Library Files''': Comprise both a common library file for module-wide functions and an object-specific library file, which includes functions unique to the object's logic and operations.
*'''SQL Scripts''': Include the main SQL script for creating the object's database table, along with additional scripts for keys, indexes, and extra fields, ensuring optimized database structure and performance.
*'''User Interface Pages''':
**A listing page for viewing all records of the object,
**A detailed card page for creating, modifying, and displaying individual records,
**Dedicated pages for managing related contacts, documents, notes, and events, each providing specialized functionalities within the object's context.

'''The setup also features a button, facilitating the generation, modification, or deletion of these components as needed. This system offers a comprehensive framework for extending and customizing the object within the module, providing developers with a robust set of tools for module customization and functionality enhancement.'''
 
 
[[File:DolObject.png|center|thumb|1503x1503px]]
 
==='''Property Addition''':===
This feature permits the extension of entities or modules by adding new properties. These properties can be utilized to store additional information, customize behavior, or integrate with other modules, enhancing the module's flexibility and capability.

*To add an additional attribute to a specific object, simply click on the "+" button to the right of the properties list, which will display a form allowing you to fill in fields such as label, type, code, etc.
*To modify, simply click on the pencil icon that appears in the same row of the list, which brings up a form for editing.
*For deletion, the trash can icon allows for the removal of a property after confirmation.

 
[[File:PropertiesObject.png|center|thumb|1402x1402px]]
 
[[File:AddProperties.png|border|center|thumb|1413x1413px]]
 

===Permissions:===
For permissions, there are two ways to create them:

*By ticking the box at the bottom of the form during the creation of the object and it creating the 3 default permissions (create, write, delete).
*By manually creating them in the rights section, which provides a list of permissions for each object. The form at the top of the table allows you to select the object and choose a permission; the ID is automatically assigned, as well as the label, although you have the option to change it if desired.

 [[File:PermissionsList.png|center|thumb|1463x1463px]]
 

===Dictionaries :===

*To create a dictionary, there is a dedicated section for this purpose. A create button (+) on the right displays a form to enter the name of the dictionary, which will become the name of the table in the database, preceded by "c_".

*The other fields are automatically filled in, and it is recommended to leave them as they are. For editing, you have the option to change the label, the fields for sorting, and for inserting or editing.

 
[[File:ListDict.png|center|thumb|1422x1422px]]

[[File:AddDictionnaire.png|center|thumb|1428x1428px|Add dictionary ]]

Module ModuleBuilder

2024-03-22T16:57:44Z

Abdel: /* Object: */

[[zh:ModuleBuilder用户手册]]


[[Category:Core]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Foundations|
num=3300|
devdoc=|
userdoc=This page|}}

=Introduction=
The ModuleBuilder is a module for developpers only, to help you to develop a module.
It is RAD, No Code or Low Code tool.

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

=Usage=
The ModuleBuilder within Dolibarr presents a lot of features designed for the comprehensive management and development of module.

==='''Language Support''':===

*This function allows developers to introduce additional languages into a module, enhancing its accessibility and usability across different linguistic demographics.
*It involves integrating new language files or entries that translate the module's interface and messages.

 
[[File:AddLanguage.png|center|thumb|1446x1446px]]
 

==='''Menus''':===
Enables the crafting of custom menus within the module's UI, allowing users to navigate through the module's features more efficiently. This might include adding new menu items linked to specific functionalities or adjusting the module's navigation structure.

*Creating menus in the system is achieved through two distinct methods: Initially, when an object is created, three menus are automatically generated and displayed on the left sidebar. Alternatively, menus and sub-menus can be manually added by utilizing the form at the top of the table, which requires filling in specific fields such as title, URL, and position. Furthermore, permissions can be assigned to each menu to ensure they are only visible to users with the appropriate rights.
*The editing process mirrors this approach closely.
*For deletion, one needs to click on the trash can icon and confirm to proceed with the removal.

 
[[File:Menus.png|center|frameless|1482x1482px]]

===Object:===

*To add an object, simply enter the name, choose an icon, and specify the name of an existing table, if nothing is specified, it creates a new table
*The three check-boxes depend on your preference: one for enabling automatic numbering generation, the second for enabling PDF document creation, and the third to generate permissions for this object.

 
[[File:AddObject.png|center|thumb|1301x1301px|'''Add Object''']]

In the description of an object within a Dolibarr module developed using ModuleBuilder, several essential components and functionalities are outlined. These include:

* '''PHP DAO CRUD Class''': This is the core PHP class that handles database operations such as create, read, update, and delete for the object, ensuring seamless data management.
* '''Icon Representation''': An icon specified for visual representation of the object in the user interface, aiding in quick identification.
* '''Module API''': Defines the application programming interface for the module, enabling external interactions and integrations.
* '''Unit Testing''': A set of PHP unit tests designed to verify the functionality and reliability of the object, ensuring robust operation.
* '''Library Files''': Comprise both a common library file for module-wide functions and an object-specific library file, which includes functions unique to the object's logic and operations.
* '''SQL Scripts''': Include the main SQL script for creating the object's database table, along with additional scripts for keys, indexes, and extra fields, ensuring optimized database structure and performance.
* '''User Interface Pages''':
** A listing page for viewing all records of the object,
** A detailed card page for creating, modifying, and displaying individual records,
** Dedicated pages for managing related contacts, documents, notes, and events, each providing specialized functionalities within the object's context.

'''The setup also features a button, facilitating the generation, modification, or deletion of these components as needed. This system offers a comprehensive framework for extending and customizing the object within the module, providing developers with a robust set of tools for module customization and functionality enhancement.'''
 
[[File:DolObject.png|center|thumb|1503x1503px]]
 
==='''Property Addition''':===
This feature permits the extension of entities or modules by adding new properties. These properties can be utilized to store additional information, customize behavior, or integrate with other modules, enhancing the module's flexibility and capability.

*To add an additional attribute to a specific object, simply click on the "+" button to the right of the properties list, which will display a form allowing you to fill in fields such as label, type, code, etc.
*To modify, simply click on the pencil icon that appears in the same row of the list, which brings up a form for editing.
*For deletion, the trash can icon allows for the removal of a property after confirmation.

 
[[File:PropertiesObject.png|center|thumb|1402x1402px]]
 
[[File:AddProperties.png|border|center|thumb|1413x1413px]]
 

===Permissions:===
For permissions, there are two ways to create them:

*By ticking the box at the bottom of the form during the creation of the object and it creating the 3 default permissions (create, write, delete).
*By manually creating them in the rights section, which provides a list of permissions for each object. The form at the top of the table allows you to select the object and choose a permission; the ID is automatically assigned, as well as the label, although you have the option to change it if desired.

 [[File:PermissionsList.png|center|thumb|1463x1463px]]
 

===Dictionaries :===

*To create a dictionary, there is a dedicated section for this purpose. A create button (+) on the right displays a form to enter the name of the dictionary, which will become the name of the table in the database, preceded by "c_".

*The other fields are automatically filled in, and it is recommended to leave them as they are. For editing, you have the option to change the label, the fields for sorting, and for inserting or editing.

 
[[File:ListDict.png|center|thumb|1422x1422px]]

[[File:AddDictionnaire.png|center|thumb|1428x1428px|Add dictionary ]]

File:DolObject.png

2024-03-22T16:55:18Z

Abdel:

Details of object with files modified

File:AddObject.png

2024-03-22T16:42:04Z

Abdel:

add Object

Module ModuleBuilder

2024-03-22T16:41:00Z

Abdel: /* Dictionaries : */

Module ModuleBuilder

2024-03-22T15:16:15Z

Abdel: /* Usage */

File:AddDictionnaire.png

2024-03-22T15:13:17Z

Abdel:

create dictionary

File:ListDict.png

2024-03-22T15:11:36Z

Abdel:

list dictionaries

File:PermissionsList.png

2024-03-22T14:53:35Z

Abdel:

List of permissions

File:PropertiesObject.png

2024-03-22T13:54:48Z

Abdel:

list of default properties for object

File:AddProperties.png

2024-03-22T13:48:13Z

Abdel:

for add props to object

Module ModuleBuilder

2024-03-21T17:56:43Z

Abdel: /* Usage */

Module ModuleBuilder

2024-03-21T17:56:09Z

Abdel: /* Usage */

Module ModuleBuilder

2024-03-21T17:55:26Z

Abdel: /* Usage */

Module ModuleBuilder

2024-03-21T17:55:09Z

Abdel: /* Usage */

File:Menus.png

2024-03-21T17:52:54Z

Abdel:

list of menus and with button to add, edit and delete

Module ModuleBuilder

2024-03-21T17:41:36Z

Abdel: /* Usage */

Module ModuleBuilder

2024-03-21T17:40:11Z

Abdel: /* Usage */

Module ModuleBuilder

2024-03-21T17:39:00Z

Abdel: /* Usage */

File:AddLanguage.png

2024-03-21T17:38:32Z

Abdel:

describe to how to add new language for the module

Module ModuleBuilder

2024-03-21T17:28:38Z

Abdel: /* Usage */