Dolibarr ERP CRM Wiki - User contributions [en]

Prerequisites

2017-11-14T02:14:20Z

MagicFab: /* OS */ Added Windows Visual C++ redistributable requirement note

[[Category:Admin]]
{{TemplateDocUser}}

Dolibarr was built to work on following components :

= OS =
* Every OS is supported.
For example: GNU/Linux, BSD, Windows, MacOS, Aix, ...

== Windows 7 ==

When using Windows 7 the Visual C++ Redistributable for Visual Studio 2012 Update 4 must be already installed. An error message during installation will indicate if this is missing.

'''Make sure you choose the 32-bit version (vcredist_x86.exe).'''

It can be obtained here:

* https://www.microsoft.com/en-us/download/details.aspx?id=30679

= Database =
* Mysql {{MySqlMinVersion}} (any Mysql options/parameters supported). Do not use Mysql version 5.5.40 nor 5.5.41, this version has critical bugs with data loss.
If using option mode=STRICT returns some warnings or error, please report them to us.
* MariaDb {{MySqlMinVersion}}
* PostgresSql {{PostgresMinVersion}}
* MSSql (experimental support not working yet)
* Database size need is lower than '''1Mb per 100''' customers/suppliers registered into database.

= PHP =
* Version {{PHPMinVersion}}
* Support for user sessions must be enabled (it is the default value for PHP)
* Works however magick_quotes parameter is set
* Works however register_globals parameter is set
* Works however safe_mode parameter is set

* PHP configuration must allow use of a max of {{PHPMinMemory}}Mb of memory (parameter PHP memory_limit).

= Disk storage =
* Program files use less than '''80Mb''' on disks.
However, it will need more disk space if you upload joined files or to store generated PDF or ODT documents. Storage will depend on number and size of attached files.

= CPU =
Any hardware configuration is enough to make Dolibarr work, even an old intel/pentium processor.
If you have more than 50 users, a 1GHz CPU or more is recommended.

Environment and development tools

2017-11-05T14:33:35Z

MagicFab: /* File:Computer.png Optional */ Grammar

{{TemplateDocDev}}

Every integrated development environment can be used.
However, this is a list of tools highly recommanded to use. They are all famous and a good help as they are featurful and of high quality. They are used by most main Dolibarr developers. Above all, they are all free and Opensource.

= [[File:Eclipsephp.jpg]] For every developer =

This is the recommended main tools but every tool compliant to Web, PHP, Mysql and Web standards can be used.

== An AMP server ==

* Apache, Mysql and PHP

For Linux: Those 3 products are available in all Linux distribution by default.

For Windows: Install [http://www.wampserver.com/ WampServer 2] (Mysql database, Apache and PHP in an all in one package). This WAMP server offers MySql+Apache+PHP, with possibility to change version of any of this component with a simple click.

== Chrome or Firefox and plugins ==
* Chrome
You can download this on web site http://www.chrome.com

* Firefox 3.0 with plugins:
** Firebug + Firecookie + FirePHP ,
** HTML Validator,
** User Agent Switcher to simulate usage of smartphones.
** Selenium IDE,
** Cert Viewer Plus if you plan to make tests with HTTPS,
** QuickProxy if you want to switch quickly on proxy tools (WebScarab),
You can download this on web site http://www.firefox.com

== SquirrelSQL ==
* SquirrelSQL for database administration
You can download it at http://squirrel-sql.sf.net

== Eclipse and plugins ==
=== Install Eclipse ===
We recommend to use an Eclipse version provided on eclipse.org. For example: {{DownloadEclipse}}

Also any version available on [http://www.eclipse.org Eclipse web site] is possible.

Once Eclipse is installed, it is recommanded to setup following parameters:
{{EclipseStandardSetup}}

=== Install plugin Eclipse for PHP: PDT. ===
If you installed Eclipse version and PDT is not included, all you have to do is using process Help -> Install new software -> Add -> Archive to add module:

{{DownloadEclipsePDT}}

Once installed, you must also setup PDT into Eclipse as explained into chapter [[Environment_and_development_tools_-_Optionnal_components#From_Eclipse]]

=== Setup Eclipse to get sources ===
Once Eclipse is installed, you can connect to GIT repository to get last development version.

For this see page [[FAQ Get,update GIT project sources]].

= [[File:Computer.png]] Optional =
There are a lot of more components you can install to get more technologies support:
[[Environment and development tools - Optionnal components]]

Translator documentation

2017-11-03T12:45:50Z

MagicFab: /* Using the web interface (for translators) */

<keywords content="translation, documentation, translator, localize, localization, i18n, internationalization, language" />

= [[File:Language.png]] Translate Dolibarr Application into your language =

Dolibarr language files are already translated in several languages.
English is the default and always complete. Other languages depend on contributions. This tutorial can help you complete a translation for a language not yet available or somehow incorrect.
Dolibarr can be translated by three different means:

# Manually using Transifex (Official and recommended method).
# Manually editing language files
# Completely automatic: autotranslator

== Manual Translation using Transifex online service (recommended) ==

Transifex is a web application that provides an online platform for translation projects. It includes teams and discussion tools, translation memory, glossary, proofreading and a lot of other features.
It is quite easy to use and all translations can be uploaded and downloaded through the web interface or using their TX client from a terminal.
Transifex is an open source project and the "community edition" can be freely downloaded and installed, but we will use the online hosted service.

===Using the web interface (for translators)===
If you want to help translating Dolibarr in your own language, check the project's page at https://www.transifex.com/dolibarr-association/dolibarr/

You can then register an account and request joining the project team for the language(s) you're targeting. A manager will have to accept your request, so please be patient.

Once accepted, you can start translating right away.

For more informations, please check Transifex "Getting Started" introduction at http://docs.transifex.com/introduction/translators/ and the web editor tutorial at http://docs.transifex.com/tutorials/txeditor/

===='''Note about en_US'''====
The web interface can not be used to translate the en_US language which is source.

Any change must be done in Dolibarr source code and submitted using a Pull Request on our GitHub repository.

=== Using TX command line client (for Dolibarr [[:Category:Yoda]] team) ===
This describe how to use Transifex from command line. However, this is reserved to Dolibarr admin users to synchronize Transifex with Dolibarr main sources.

[http://docs.transifex.com/developer/client/ Official documentation]

====TX Client configuration====
First install TX Client.
With Debian/Ubuntu/Mint:
<source lang="bash">
apt-get install python-pip
pip install transifex-client
</source>
Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.
<source lang="bash">
cd git/dolibarr
tx init
</source>
Accept to overwrite config file. Keep default value for Transifex instance, then enter your Transifex login and password.

After this, a .transifexrc has been created into your HOME dir and a generic config file has been created as '''.tx/config''' in project's root.
So your directory's contents will look like that:
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

The current config file can be downloaded from https://github.com/Dolibarr/dolibarr/tree/develop/.tx , put it into .tx directory, overwriting the one created by '''tx init'''

This project configuration file is used to store the project’s details and the file-to-resource mappings.

That is a sample of what the config file contains:

<source lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</source>

Here is an explanation of the sections and options used in the config file:

<nowiki>[main] section</nowiki>

In this section we have project-wide options, such as the default transifex host for all projects. These can be overridden by each resource, in case it is needed.

<nowiki>[dolibarr.resource]</nowiki>

source_lang: this is the source language of the resource. 
source_file: this points to the source file directly. 
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory'' 
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory'' 
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory'' 

====TX Client use====
Some useful information on '''tx''' commands.

'''tx status'''

Show status of translations

'''tx push'''

Used to push changes from your computer to Transifex server 
Additional options for the tx push command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to push (defaults to all)
-r <resource> - Specify the resource for which you want to push the translations (defaults to all)
-f - Push source files without checking modification times
--skip - Don't stop on errors. Useful when pushing many files concurrently.
-s - Push the source file to the server
-t - Push the translation files to the server
--no-interactive - Don't require user input when forcing a push</pre></code>

'''tx pull'''

Used to pull changes from Transifex server to your computer 
Additional options for the tx pull command are:
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''Examples'''

To pull translation files, you can use:

<source lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</source>

To push source files, just type:

<source lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</source>

=== Other questions on transifex process ===
This is short questions and answer you may also ask about transifex translation process:

1) Is the sync on a regular time interval ?

No. It is done where there is enough translation submitted. It is also done on a beta branch just before creating the final release package.

2) Are all the translations synced to git, or only the reviewed translations. Do I need to review before sync is done ?

When a Sync is done, transifex files overwrites files into git, but only if there is at least on record modified for the file.
You don't have to make review before sync is done. Making review is above all to know which lines were manually reviewed and which one were initially translated using a robot.

3) In which Dolibarr releases will translations be available ? Are transifex translations also synced to maintenance releases ?

Sync is always done on develop and/or beta.
So transifex changes appear in all version whose branch is created after the transifex change (a sync is always done before creating a new branch). Once a branch is created, then new changes into transifex will be available only for next branch. Reason of this is that transifex is not able to manage branch/versions (not yet).

== Manual Translation (not recommended) ==

To translate Dolibarr into another language, go to the langs directory and create a folder/directory named with the code language to translate (follow the existing format, for example en_US, en_GB, es_ES, de_DE, etc...). Then copy the files from an existing language directory (for example en_US/main.lang, en_GB/bills.lang), into the new language directory that you have just created.

These files have the format of key/value pairs in each line like the followings:

<source lang="ini">
Code1 = translate phrase 1
Code2 = translate phrase 2
...
Coden = translate phrase n
</source>

Translate the phrases (the value portion of the key/value pairs) on right side of the "=" as seen above, the code (the key portion) on left side of "=" should remain unchanged. It is possible to translate the files one by one, without bringing them all at once. If a file has not been translated into the new language, Dolibarr uses English.

To have a localised (translated) string into the PHP code, all you have to do is load the language file and use the method to get the translated value, like this:

<source lang="php">
$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX

print $langs->trans("CodeX")
</source>

An entry type;

<source lang="ini">
CodeX = phrase X
</source>

must be present or added to the myfile.lang file.

== Automatic Translation with autotranslator.php tool ==

* Translator OS: All
* Tool: '''autotranslator.php''' provided with Dolibarr in directory '''dev/translation'''.
This method is recommended when starting translation for a language not already initialized. If there is already a translation available but you need to add missing key or correct errors, try to use method using Transifex (see later).

To make or update all files of a language code, just run the script:
<source lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</source>
For example :
<source lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</source>
to translate into Portuguese (pt_PT) using English (en_US) files.

All non existing files will be created, all existing files will be updated.
The tool use [http://translate.google.com Google translation] service to find the translation value of a string, so a working Internet connection is required from station running the script. Also a GOOGLEAPIKEY is required and Google charges a fee for using this service (20 euros / 1 000 000 of translated chars).
Your PHP must also have permissions to write into '''htdocs/langs''' directory and must have curl functions available.

= [[File:Language.png]] Distribute or include your translation into core source =

Once you start translating, it's a smart decision to share it, so it can be included into the official code of Dolibarr.
If you keep it for you, others will not be able to improve it when new terms are added or previous terms are modified, and you will still have to manage the translation on your own.

If you translated through the Transifex system, there's nothing to be done. Your translation will be included in the next version of Dolibarr. No additional work! In technical terms, the translation will be exported from Transifex and imported into Dolibarr by our developers, at least once every month.

If, however, you translated directly in Dolibarr files, then you will first have to transfer those translations to Transifex before they can be included. So, really, you should start translating into Transifex.
If you send us your translation through a Pull Request on Github, sadly, it will be overwritten by the next import from Transifex, so it would be very short-lived.

Note:

The reference language is en_US and is always complete. You can find it in the htdocs/langs/en_US/ folder. All other language files are likely to be slightly or highly incomplete, depending on the language.

If you are developing a new module, you are likely going to need the addition of new language variables. This is done exclusively through the update of the en_US language (htdocs/langs/en_US/ folder). Just modify these files to add the variable you need and send the resulting folder as part of your Pull Request. Refer to the developer documentation to learn how to contribute code (you will need an account on {{TemplateUrlSCM}}.

= [[File:Language.png]] Translate documentation on wiki =
The wiki is written in 3 languages: English, French and Spanish.
If you want to enhance documentation on one of these languages, all you have to do is to create an account on this wiki.
Then, you can edit existing pages to correct a bad translation or translate pages waiting for translation [[:Category:Page_waiting_for_translation]].

Documentation Développeur

2017-11-03T01:21:17Z

MagicFab: /* Les modules de numérotation */ Grammaire

<keywords content="développeur, développement, documentation, guide, doc, tutorial, help, api, coding, standard, règles" />
Cette page est l'index des articles en rapport avec la documentation développeur. Pour la documentation utilisateur, [[Documentation utilisateur|voir ici]].

= Organisation et outils de développement =
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.
# [[Projet Dolibarr|Organisation du projet]]
# [[A savoir avant de commencer|A savoir avant de commencer à developper]]
# [[Outils de développement|Environnement et Outils de développement]]
# [[Librairies externes et dépendances]]
# [[FAQ_Récupérer,_mettre_à_jours_les_sources_du_projet|Récupérer, mettre à jour les sources d'une version]]

= Règles de codage et bonnes pratiques =
# [[Langages et normes|Langage et normes de développement (PHP, SQL, HTML)]]
# [[:Category:Table SQL|Liste des tables]]
# L'arborescence des fichiers et classes du core est disponible sur la [http://doxygen.dolibarr.org/ documentation générée doxygen]

= Liste des modules =
La documentation technique, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page de documentation développeur de chaque module. Choisissez la page qui vous concerne pour y accéder:

* La liste des modules standards est définie sur la page [[:Category:Liste des Modules (développeur)‎|Liste des Modules]]
* La liste des modules complémentaires est définie sur la page [[:Category:Modules_complémentaires|Modules complémentaires]]

= Développer un nouveau module/extension pour les [http://fr.wikipedia.org/wiki/Interface_homme-machine IHM] =
Cette section décrit comment développer un nouveau module influant sur l'interface utilisateur de Dolibarr. Cela peut être les écrans, le look, le code ou les données.

Le développement de script n'entre pas dans ce périmètre et est décrit au chapitre suivant.

Pour développer votre propre module d'extension Dolibarr, aller sur le didacticiel: [[Développement module]]

= Développer un script ligne de commande ou batch =
Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, etc...).
La réalisation de modifications sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: [[Développement de scripts]]

= Les couches techniques de Dolibarr =
== Arborescence des fichiers ==
La hiérachie des fichiers de la version actuelle est visible sur la [http://doxygen.dolibarr.org/ documentation générée doxygen des sources] (documentation générée style "javadoc").

Les chemins à utiliser pour ajouter vos fichiers lors de la réalisation d'un nouveau module sont décrits dans la documentation de développement d'un nouveau module (voir [[Développement module]]).

== Le Système de paramétrage ==
Il existe 3 niveaux de paramétrage dans Dolibarr.
* La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. Voir [[Fichier de configuration]] pour plus d'informations.
* Le paramétrage des fonctionnalités est stocké dans la [[Table llx_const]]. Voir la page [[Constantes]] pour plus d'informations.
* Le paramétrage propre à un utilisateur est stocké dans la [[Table llx_user_param]]. Voir la page [[Constantes]] pour plus d'informations.

== Les objets métiers ==
Voir la page [[Objets métiers]]

== Le Système de menus ==
Voir la page [[Système de menus]]

== Le Système des onglets ==
Voir la page [[Système d'onglets]]

== Le Système des thèmes ==
Voir la page [[Themes]]

== Le Système des boites ==
Voir la page [[Système des boites]]

== Le Système d'authentification ==
Voir la page [[Authentification]]

== Le Système des permissions ==
Voir la page [[Permissions]]

== Le Système de traduction ==
Voir la page [[Système de traduction]]

== La Gestion d'erreur ==
Voir la page [[Gestion d'erreur]]

== Le système des Canvas (surcharge écrans) ==
Les Canvas sont une fonction développeur pour remplacer les écrans de création, mise a jour ou visualisation d'une fiche (produits, tiers, contacts, ...). Par exemple, vous pouvez remplacer le formulaire de saisie d'un tiers par le votre, ou le formulaire d'édition, ou l'écran de consultation.

Voir la page [[Développement Canvas]]

== Le système des Triggers ==
Les Triggers sont une fonctionnalité développeurs pour exécuter du code personnaliser durant l'exécution d'un "événement métier" Dolibarr (création de facture, suppression d'un utilisateur, mise à jour d'un tier, etc...), et uniquement pour des événements métiers. Pour personnaliser du code dans un autre contexte, voir plutôt le chapitre '''Le système des Hooks'''.

Pour l'utilisation des triggers voir [[Interfaces_Dolibarr_vers_exterieur|cette page]].

== Le Système de Hooks ==
Voir la page [[Système de Hooks]]

== Le Système de substitution de variables ==
Voir la page [[Système de substitution de variables]]

== Les Web services ==
Dolibarr peut être configuré pour fournir des services accessible à un système extérieur. Voir [[Module Services Web]]

== Le stockage de fichiers/documents ==
Voir la page [[Documents générés]]

== Les modules de numérotation ==
Pour chaque entité créée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard dontcertains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans préfixe, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne réponds pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
Plus d'information sur la page [[Créer un module de numérotation]].

== Les modèles et la génération de documents ==
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

= Les exports/imports de masse =
# [[Imports de masse]]
# [[Module Exports|Exports de masse]]

= Interfaces et liens avec d'autres applications =
# [[Interfaces Dolibarr vers exterieur]] ou vers Dolibarr (Triggers Dolibarr)
# [[Interfaces Exterieur vers Dolibarr]]
# [[Module Services Web]]

= FAQ =
Toutes les FAQ (Foires Aux Questions) sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]]

Developer documentation

2017-11-03T01:19:33Z

MagicFab: Grammar, formatting

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

* [[:Category:List of Modules (developer)‎|List of standard modules]]
* [[:Category:Complementary modules|List of complementary modules]]

= To develop a new module/addon for GUI =
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

= To develop a batch or command line script =
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).
Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

= Technical components of Dolibarr =
== Tree structure ==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file, conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See the [[Constants]] page for more information.
* Feature parameters specific to a user are stored in [[Table llx_user_param]]. See the [[Constants]] page for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See [[Menus system]].

== Tabs system ==
See [[Tabs system]].

== Skins system ==
See [[Skins]].

== Box system ==
See [[Box system]].

== Authentication system ==
See [[Authentication]].

== Permission system ==
See [[Permissions En|Permissions]].

== Translation system ==
See [[Translation system]].

== Error management ==
See [[Error reporting|Error reporting]].

== Canvas system ==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]].

== Triggers system ==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See [[Hooks system]].

== Variable substitution system ==
See [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.

See [[Module Web Services]].

== Files/Documents storage management ==
See [[Generated documents]].

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

== Document templates and documents generation ==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

== Extrafields ==
See [[Extrafields]].

== Other internal function ==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Developer documentation

2017-11-03T01:07:43Z

MagicFab: /* Setup storage */ - Grammar

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

* [[:Category:List of Modules (developer)‎|List of standard modules]]
* [[:Category:Complementary modules|List of complementary modules]]

= To develop a new module/addon for GUI =
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

= To develop a batch or command line script =
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).
Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

= Technical components of Dolibarr =
== Tree structure ==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file, conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See the [[Constants]] page for more information.
* Feature parameters specific to a user are stored in [[Table llx_user_param]]. See the [[Constants]] page for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Developer documentation

2017-11-03T01:05:17Z

MagicFab: /* Tree structure */

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

* [[:Category:List of Modules (developer)‎|List of standard modules]]
* [[:Category:Complementary modules|List of complementary modules]]

= To develop a new module/addon for GUI =
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

= To develop a batch or command line script =
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).
Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

= Technical components of Dolibarr =
== Tree structure ==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information.
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Documentation Développeur

2017-11-03T01:02:57Z

MagicFab: /* Arborescence des fichiers */

<keywords content="développeur, développement, documentation, guide, doc, tutorial, help, api, coding, standard, règles" />
Cette page est l'index des articles en rapport avec la documentation développeur. Pour la documentation utilisateur, [[Documentation utilisateur|voir ici]].

= Organisation et outils de développement =
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.
# [[Projet Dolibarr|Organisation du projet]]
# [[A savoir avant de commencer|A savoir avant de commencer à developper]]
# [[Outils de développement|Environnement et Outils de développement]]
# [[Librairies externes et dépendances]]
# [[FAQ_Récupérer,_mettre_à_jours_les_sources_du_projet|Récupérer, mettre à jour les sources d'une version]]

= Règles de codage et bonnes pratiques =
# [[Langages et normes|Langage et normes de développement (PHP, SQL, HTML)]]
# [[:Category:Table SQL|Liste des tables]]
# L'arborescence des fichiers et classes du core est disponible sur la [http://doxygen.dolibarr.org/ documentation générée doxygen]

= Liste des modules =
La documentation technique, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page de documentation développeur de chaque module. Choisissez la page qui vous concerne pour y accéder:

* La liste des modules standards est définie sur la page [[:Category:Liste des Modules (développeur)‎|Liste des Modules]]
* La liste des modules complémentaires est définie sur la page [[:Category:Modules_complémentaires|Modules complémentaires]]

= Développer un nouveau module/extension pour les [http://fr.wikipedia.org/wiki/Interface_homme-machine IHM] =
Cette section décrit comment développer un nouveau module influant sur l'interface utilisateur de Dolibarr. Cela peut être les écrans, le look, le code ou les données.

Le développement de script n'entre pas dans ce périmètre et est décrit au chapitre suivant.

Pour développer votre propre module d'extension Dolibarr, aller sur le didacticiel: [[Développement module]]

= Développer un script ligne de commande ou batch =
Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, etc...).
La réalisation de modifications sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: [[Développement de scripts]]

= Les couches techniques de Dolibarr =
== Arborescence des fichiers ==
La hiérachie des fichiers de la version actuelle est visible sur la [http://doxygen.dolibarr.org/ documentation générée doxygen des sources] (documentation générée style "javadoc").

Les chemins à utiliser pour ajouter vos fichiers lors de la réalisation d'un nouveau module sont décrits dans la documentation de développement d'un nouveau module (voir [[Développement module]]).

== Le Système de paramétrage ==
Il existe 3 niveaux de paramétrage dans Dolibarr.
* La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. Voir [[Fichier de configuration]] pour plus d'informations.
* Le paramétrage des fonctionnalités est stocké dans la [[Table llx_const]]. Voir la page [[Constantes]] pour plus d'informations.
* Le paramétrage propre à un utilisateur est stocké dans la [[Table llx_user_param]]. Voir la page [[Constantes]] pour plus d'informations.

== Les objets métiers ==
Voir la page [[Objets métiers]]

== Le Système de menus ==
Voir la page [[Système de menus]]

== Le Système des onglets ==
Voir la page [[Système d'onglets]]

== Le Système des thèmes ==
Voir la page [[Themes]]

== Le Système des boites ==
Voir la page [[Système des boites]]

== Le Système d'authentification ==
Voir la page [[Authentification]]

== Le Système des permissions ==
Voir la page [[Permissions]]

== Le Système de traduction ==
Voir la page [[Système de traduction]]

== La Gestion d'erreur ==
Voir la page [[Gestion d'erreur]]

== Le système des Canvas (surcharge écrans) ==
Les Canvas sont une fonction développeur pour remplacer les écrans de création, mise a jour ou visualisation d'une fiche (produits, tiers, contacts, ...). Par exemple, vous pouvez remplacer le formulaire de saisie d'un tiers par le votre, ou le formulaire d'édition, ou l'écran de consultation.

Voir la page [[Développement Canvas]]

== Le système des Triggers ==
Les Triggers sont une fonctionnalité développeurs pour exécuter du code personnaliser durant l'exécution d'un "événement métier" Dolibarr (création de facture, suppression d'un utilisateur, mise à jour d'un tier, etc...), et uniquement pour des événements métiers. Pour personnaliser du code dans un autre contexte, voir plutôt le chapitre '''Le système des Hooks'''.

Pour l'utilisation des triggers voir [[Interfaces_Dolibarr_vers_exterieur|cette page]].

== Le Système de Hooks ==
Voir la page [[Système de Hooks]]

== Le Système de substitution de variables ==
Voir la page [[Système de substitution de variables]]

== Les Web services ==
Dolibarr peut être configuré pour fournir des services accessible à un système extérieur. Voir [[Module Services Web]]

== Le stockage de fichiers/documents ==
Voir la page [[Documents générés]]

== Les modules de numérotation ==
Pour chaque entité créée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
Plus d'information sur la page [[Créer un module de numérotation]]

== Les modèles et la génération de documents ==
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

= Les exports/imports de masse =
# [[Imports de masse]]
# [[Module Exports|Exports de masse]]

= Interfaces et liens avec d'autres applications =
# [[Interfaces Dolibarr vers exterieur]] ou vers Dolibarr (Triggers Dolibarr)
# [[Interfaces Exterieur vers Dolibarr]]
# [[Module Services Web]]

= FAQ =
Toutes les FAQ (Foires Aux Questions) sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]]

Documentation Développeur

2017-11-03T01:01:43Z

MagicFab: /* Développer un script ligne de commande ou batch */

<keywords content="développeur, développement, documentation, guide, doc, tutorial, help, api, coding, standard, règles" />
Cette page est l'index des articles en rapport avec la documentation développeur. Pour la documentation utilisateur, [[Documentation utilisateur|voir ici]].

= Organisation et outils de développement =
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.
# [[Projet Dolibarr|Organisation du projet]]
# [[A savoir avant de commencer|A savoir avant de commencer à developper]]
# [[Outils de développement|Environnement et Outils de développement]]
# [[Librairies externes et dépendances]]
# [[FAQ_Récupérer,_mettre_à_jours_les_sources_du_projet|Récupérer, mettre à jour les sources d'une version]]

= Règles de codage et bonnes pratiques =
# [[Langages et normes|Langage et normes de développement (PHP, SQL, HTML)]]
# [[:Category:Table SQL|Liste des tables]]
# L'arborescence des fichiers et classes du core est disponible sur la [http://doxygen.dolibarr.org/ documentation générée doxygen]

= Liste des modules =
La documentation technique, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page de documentation développeur de chaque module. Choisissez la page qui vous concerne pour y accéder:

* La liste des modules standards est définie sur la page [[:Category:Liste des Modules (développeur)‎|Liste des Modules]]
* La liste des modules complémentaires est définie sur la page [[:Category:Modules_complémentaires|Modules complémentaires]]

= Développer un nouveau module/extension pour les [http://fr.wikipedia.org/wiki/Interface_homme-machine IHM] =
Cette section décrit comment développer un nouveau module influant sur l'interface utilisateur de Dolibarr. Cela peut être les écrans, le look, le code ou les données.

Le développement de script n'entre pas dans ce périmètre et est décrit au chapitre suivant.

Pour développer votre propre module d'extension Dolibarr, aller sur le didacticiel: [[Développement module]]

= Développer un script ligne de commande ou batch =
Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, etc...).
La réalisation de modifications sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: [[Développement de scripts]]

= Les couches techniques de Dolibarr =
== Arborescence des fichiers ==
La hierachie des fichiers de la version actuelle est visibles sur la [http://doxygen.dolibarr.org/ documentation générée doxygen des sources] (documentation générée style "javadoc").

Mais les chemins à utiliser pour ajouter vos fichiers lors de la réalisation d'un nouveau module sont décrits dans la documentation de développement d'un nouveau module (voir [[Développement module]]).

== Le Système de paramétrage ==
Il existe 3 niveaux de paramétrage dans Dolibarr.
* La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. Voir [[Fichier de configuration]] pour plus d'informations.
* Le paramétrage des fonctionnalités est stocké dans la [[Table llx_const]]. Voir la page [[Constantes]] pour plus d'informations.
* Le paramétrage propre à un utilisateur est stocké dans la [[Table llx_user_param]]. Voir la page [[Constantes]] pour plus d'informations.

== Les objets métiers ==
Voir la page [[Objets métiers]]

== Le Système de menus ==
Voir la page [[Système de menus]]

== Le Système des onglets ==
Voir la page [[Système d'onglets]]

== Le Système des thèmes ==
Voir la page [[Themes]]

== Le Système des boites ==
Voir la page [[Système des boites]]

== Le Système d'authentification ==
Voir la page [[Authentification]]

== Le Système des permissions ==
Voir la page [[Permissions]]

== Le Système de traduction ==
Voir la page [[Système de traduction]]

== La Gestion d'erreur ==
Voir la page [[Gestion d'erreur]]

== Le système des Canvas (surcharge écrans) ==
Les Canvas sont une fonction développeur pour remplacer les écrans de création, mise a jour ou visualisation d'une fiche (produits, tiers, contacts, ...). Par exemple, vous pouvez remplacer le formulaire de saisie d'un tiers par le votre, ou le formulaire d'édition, ou l'écran de consultation.

Voir la page [[Développement Canvas]]

== Le système des Triggers ==
Les Triggers sont une fonctionnalité développeurs pour exécuter du code personnaliser durant l'exécution d'un "événement métier" Dolibarr (création de facture, suppression d'un utilisateur, mise à jour d'un tier, etc...), et uniquement pour des événements métiers. Pour personnaliser du code dans un autre contexte, voir plutôt le chapitre '''Le système des Hooks'''.

Pour l'utilisation des triggers voir [[Interfaces_Dolibarr_vers_exterieur|cette page]].

== Le Système de Hooks ==
Voir la page [[Système de Hooks]]

== Le Système de substitution de variables ==
Voir la page [[Système de substitution de variables]]

== Les Web services ==
Dolibarr peut être configuré pour fournir des services accessible à un système extérieur. Voir [[Module Services Web]]

== Le stockage de fichiers/documents ==
Voir la page [[Documents générés]]

== Les modules de numérotation ==
Pour chaque entité créée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
Plus d'information sur la page [[Créer un module de numérotation]]

== Les modèles et la génération de documents ==
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

= Les exports/imports de masse =
# [[Imports de masse]]
# [[Module Exports|Exports de masse]]

= Interfaces et liens avec d'autres applications =
# [[Interfaces Dolibarr vers exterieur]] ou vers Dolibarr (Triggers Dolibarr)
# [[Interfaces Exterieur vers Dolibarr]]
# [[Module Services Web]]

= FAQ =
Toutes les FAQ (Foires Aux Questions) sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]]

Documentation Développeur

2017-11-03T01:01:09Z

MagicFab: /* Développer un nouveau module/extension pour les IHM */

<keywords content="développeur, développement, documentation, guide, doc, tutorial, help, api, coding, standard, règles" />
Cette page est l'index des articles en rapport avec la documentation développeur. Pour la documentation utilisateur, [[Documentation utilisateur|voir ici]].

= Organisation et outils de développement =
Ce chapitre regroupe des informations générales qu'il est nécessaire de lire avant de commencer toute action de développement sur Dolibarr.
# [[Projet Dolibarr|Organisation du projet]]
# [[A savoir avant de commencer|A savoir avant de commencer à developper]]
# [[Outils de développement|Environnement et Outils de développement]]
# [[Librairies externes et dépendances]]
# [[FAQ_Récupérer,_mettre_à_jours_les_sources_du_projet|Récupérer, mettre à jour les sources d'une version]]

= Règles de codage et bonnes pratiques =
# [[Langages et normes|Langage et normes de développement (PHP, SQL, HTML)]]
# [[:Category:Table SQL|Liste des tables]]
# L'arborescence des fichiers et classes du core est disponible sur la [http://doxygen.dolibarr.org/ documentation générée doxygen]

= Liste des modules =
La documentation technique, spécifique à un module fonctionnel standard de Dolibarr, est définie sur la page de documentation développeur de chaque module. Choisissez la page qui vous concerne pour y accéder:

* La liste des modules standards est définie sur la page [[:Category:Liste des Modules (développeur)‎|Liste des Modules]]
* La liste des modules complémentaires est définie sur la page [[:Category:Modules_complémentaires|Modules complémentaires]]

= Développer un nouveau module/extension pour les [http://fr.wikipedia.org/wiki/Interface_homme-machine IHM] =
Cette section décrit comment développer un nouveau module influant sur l'interface utilisateur de Dolibarr. Cela peut être les écrans, le look, le code ou les données.

Le développement de script n'entre pas dans ce périmètre et est décrit au chapitre suivant.

Pour développer votre propre module d'extension Dolibarr, aller sur le didacticiel: [[Développement module]]

= Développer un script ligne de commande ou batch =
Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, écriture, etc...).
La réalisation de modification sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issues d'un autre système, se référer à la page: [[Développement de scripts]]

= Les couches techniques de Dolibarr =
== Arborescence des fichiers ==
La hierachie des fichiers de la version actuelle est visibles sur la [http://doxygen.dolibarr.org/ documentation générée doxygen des sources] (documentation générée style "javadoc").

Mais les chemins à utiliser pour ajouter vos fichiers lors de la réalisation d'un nouveau module sont décrits dans la documentation de développement d'un nouveau module (voir [[Développement module]]).

== Le Système de paramétrage ==
Il existe 3 niveaux de paramétrage dans Dolibarr.
* La configuration technique de Dolibarr (mode authentification à l'application, identifiant de la base de données et location de l'espace de stockage des fichiers) est définie dans le seul fichier de configuration conf/conf.php. Voir [[Fichier de configuration]] pour plus d'informations.
* Le paramétrage des fonctionnalités est stocké dans la [[Table llx_const]]. Voir la page [[Constantes]] pour plus d'informations.
* Le paramétrage propre à un utilisateur est stocké dans la [[Table llx_user_param]]. Voir la page [[Constantes]] pour plus d'informations.

== Les objets métiers ==
Voir la page [[Objets métiers]]

== Le Système de menus ==
Voir la page [[Système de menus]]

== Le Système des onglets ==
Voir la page [[Système d'onglets]]

== Le Système des thèmes ==
Voir la page [[Themes]]

== Le Système des boites ==
Voir la page [[Système des boites]]

== Le Système d'authentification ==
Voir la page [[Authentification]]

== Le Système des permissions ==
Voir la page [[Permissions]]

== Le Système de traduction ==
Voir la page [[Système de traduction]]

== La Gestion d'erreur ==
Voir la page [[Gestion d'erreur]]

== Le système des Canvas (surcharge écrans) ==
Les Canvas sont une fonction développeur pour remplacer les écrans de création, mise a jour ou visualisation d'une fiche (produits, tiers, contacts, ...). Par exemple, vous pouvez remplacer le formulaire de saisie d'un tiers par le votre, ou le formulaire d'édition, ou l'écran de consultation.

Voir la page [[Développement Canvas]]

== Le système des Triggers ==
Les Triggers sont une fonctionnalité développeurs pour exécuter du code personnaliser durant l'exécution d'un "événement métier" Dolibarr (création de facture, suppression d'un utilisateur, mise à jour d'un tier, etc...), et uniquement pour des événements métiers. Pour personnaliser du code dans un autre contexte, voir plutôt le chapitre '''Le système des Hooks'''.

Pour l'utilisation des triggers voir [[Interfaces_Dolibarr_vers_exterieur|cette page]].

== Le Système de Hooks ==
Voir la page [[Système de Hooks]]

== Le Système de substitution de variables ==
Voir la page [[Système de substitution de variables]]

== Les Web services ==
Dolibarr peut être configuré pour fournir des services accessible à un système extérieur. Voir [[Module Services Web]]

== Le stockage de fichiers/documents ==
Voir la page [[Documents générés]]

== Les modules de numérotation ==
Pour chaque entité créée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.
Plus d'information sur la page [[Créer un module de numérotation]]

== Les modèles et la génération de documents ==
Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].

= Les exports/imports de masse =
# [[Imports de masse]]
# [[Module Exports|Exports de masse]]

= Interfaces et liens avec d'autres applications =
# [[Interfaces Dolibarr vers exterieur]] ou vers Dolibarr (Triggers Dolibarr)
# [[Interfaces Exterieur vers Dolibarr]]
# [[Module Services Web]]

= FAQ =
Toutes les FAQ (Foires Aux Questions) sont disponibles via la page d'index [[:Category:FAQ FR|FAQ FR]]

Developer documentation

2017-11-03T01:00:15Z

MagicFab: /* To develop a batch or command line script */

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

* [[:Category:List of Modules (developer)‎|List of standard modules]]
* [[:Category:Complementary modules|List of complementary modules]]

= To develop a new module/addon for GUI =
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

= To develop a batch or command line script =
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).
Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

= Technical components of Dolibarr =
== Tree structure ==
Path hierarchy of current version are defined into [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation).

However, paths to use to add new files by a new module is defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information.
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Developer documentation

2017-11-03T00:57:55Z

MagicFab: /* To develop a new module/addon for GUI */

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

* [[:Category:List of Modules (developer)‎|List of standard modules]]
* [[:Category:Complementary modules|List of complementary modules]]

= To develop a new module/addon for GUI =
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

= To develop a batch or command line script =
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...).
Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this.

To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]]

= Technical components of Dolibarr =
== Tree structure ==
Path hierarchy of current version are defined into [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation).

However, paths to use to add new files by a new module is defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information.
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Developer documentation

2017-11-03T00:53:40Z

MagicFab: /* List of modules */

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

* [[:Category:List of Modules (developer)‎|List of standard modules]]
* [[:Category:Complementary modules|List of complementary modules]]

= To develop a new module/addon for GUI =
This section describe how to develop a new module on Dolibarr that change how Dolibarr works. Such modules can have its own screens, its own data, its own CSS stylesheet, its own business code or all of this.
Script development is not included in this section (this is described in next chapter).

To develop your own module, go on tutorial: [[Module development]]

= To develop a batch or command line script =
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...).
Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this.

To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]]

= Technical components of Dolibarr =
== Tree structure ==
Path hierarchy of current version are defined into [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation).

However, paths to use to add new files by a new module is defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information.
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Developer documentation

2017-11-03T00:49:55Z

MagicFab: /* Coding rules and best practices */

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentations on standard business modules are available on developer documentation of each modules. Choose page you are interested in to go on it:

* List of standard modules is defined on page [[:Category:List of Modules (developer)‎|List of Modules]]
* List of other modules is defined on page [[:Category:Complementary modules|Complementary modules]]

= To develop a new module/addon for GUI =
This section describe how to develop a new module on Dolibarr that change how Dolibarr works. Such modules can have its own screens, its own data, its own CSS stylesheet, its own business code or all of this.
Script development is not included in this section (this is described in next chapter).

To develop your own module, go on tutorial: [[Module development]]

= To develop a batch or command line script =
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...).
Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this.

To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]]

= Technical components of Dolibarr =
== Tree structure ==
Path hierarchy of current version are defined into [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation).

However, paths to use to add new files by a new module is defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information.
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Prerequisites

2017-11-03T00:49:28Z

MagicFab: /* OS */

[[Category:Admin]]
{{TemplateDocUser}}

Dolibarr was built to work on following components :

= OS =
* Every OS is supported.
For example: GNU/Linux, BSD, Windows, MacOS, Aix, ...

= Database =
* Mysql {{MySqlMinVersion}} (any Mysql options/parameters supported). Do not use Mysql version 5.5.40 nor 5.5.41, this version has critical bugs with data loss.
If using option mode=STRICT returns some warnings or error, please report them to us.
* MariaDb {{MySqlMinVersion}}
* PostgresSql {{PostgresMinVersion}}
* MSSql (experimental support not working yet)
* Database size need is lower than '''1Mb per 100''' customers/suppliers registered into database.

= PHP =
* Version {{PHPMinVersion}}
* Support for user sessions must be enabled (it is the default value for PHP)
* Works however magick_quotes parameter is set
* Works however register_globals parameter is set
* Works however safe_mode parameter is set

* PHP configuration must allow use of a max of {{PHPMinMemory}}Mb of memory (parameter PHP memory_limit).

= Disk storage =
* Program files use less than '''80Mb''' on disks.
However, it will need more disk space if you upload joined files or to store generated PDF or ODT documents. Storage will depend on number and size of attached files.

= CPU =
Any hardware configuration is enough to make Dolibarr work, even an old intel/pentium processor.
If you have more than 50 users, a 1GHz CPU or more is recommended.

To known before to start

2017-11-03T00:46:24Z

MagicFab: moved To known before to start to Required steps before contributing: Grammar, previous title was a literal translation from French

#REDIRECT [[Required steps before contributing]]

Required steps before contributing

2017-11-03T00:46:24Z

MagicFab: moved To known before to start to Required steps before contributing: Grammar, previous title was a literal translation from French

{{TemplateDocDevEn}}

If you wish to become an official Dolibarr developer, you must:

# Read this wiki and in particular the [[Developer documentation]] in its entirety.
# Create an account on {{TemplateURLSCM}} and join the Dolibarr Developers mailing list ({{TemplateURLMLDev}}).
# Post a short presentation to this mailing including your resume, expectations or intentions.
# You can begin making changes in your environment and test them without affecting the Dolibarr project.
# To submit your first work or to become an official developper, it is important to know that this requires going through several steps which may seem long but are necessary to ensure the quality of Dolibarr. More info is available at these links:
* [[Developer FAQ#Submit a patch, work and help on Dolibarr development|Developer FAQ (submit a patch)]]
* [[Developer_FAQ#How_to_be_an_official_developer|Developer FAQ (how to be an official developer)]]

The sole purpose of these requirements is for development to take place in the best possible conditions.

Required steps before contributing

2017-11-03T00:42:43Z

MagicFab: Grammer, rephrasing

Developer documentation

2017-11-03T00:33:54Z

MagicFab: /* Development organization and tools */ - grammar

<keywords content="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />
This page is main index of documents relating to developer documentation. For user documentation, [[User documentation|see here]].

= Development organization and tools =
This chapter contains global information that must be read before starting any development on Dolibarr.
# [[Dolibarr Project|Organization of project]]
# [[To known before to start|To be known before starting to develop]]
# [[Environment and development tools]]
# [[Dependencies and external libraries]]
# [[FAQ_Get,update_project_sources|Get or update sources of a development version]]

= Coding rules and best practices =
# [[Prerequisite|Prerequisites]]
# [[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
# [[:Category:Table SQL|List of tables]]
# Tree structure of files and classes are available onto [http://doxygen.dolibarr.org/ doxygen generated documentation]

= List of modules =
Technical documentations on standard business modules are available on developer documentation of each modules. Choose page you are interested in to go on it:

* List of standard modules is defined on page [[:Category:List of Modules (developer)‎|List of Modules]]
* List of other modules is defined on page [[:Category:Complementary modules|Complementary modules]]

= To develop a new module/addon for GUI =
This section describe how to develop a new module on Dolibarr that change how Dolibarr works. Such modules can have its own screens, its own data, its own CSS stylesheet, its own business code or all of this.
Script development is not included in this section (this is described in next chapter).

To develop your own module, go on tutorial: [[Module development]]

= To develop a batch or command line script =
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...).
Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this.

To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]]

= Technical components of Dolibarr =
== Tree structure ==
Path hierarchy of current version are defined into [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation).

However, paths to use to add new files by a new module is defined in the documentation to develop a new module (see [[Module development]]).

== Setup storage ==
There are 3 places for Dolibarr setup parameters.
* Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information.
* Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information.
* Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information.

== Business objects ==
See page [[Business Objects]]

== Menus system ==
See page [[Menus system]]

== Tabs system ==
See page [[Tabs system]]

== Skins system ==
See page [[Skins]]

== Box system ==
See page [[Box system]]

== Authentication system ==
See page [[Authentication]]

== Permission system ==
See page [[Permissions En|Permissions]]

== Translation system ==
See page [[Translation system]]

== Error management ==
See page [[Error reporting|Error reporting]]

== Canvas system ==
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

See page [[Canvas development]]

== Triggers system ==
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

== Hooks system ==
See page [[Hooks system]].

== Variable substitution system ==
See page [[Variable substitution system]].

== Web services ==
Dolibarr can be setup to provide some services.
See [[Module Web Services]]

== Files/Documents storage management ==
See page [[Generated documents]]

== Numbering modules ==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.

For more information, see on page [[Create numeration module]]

== Document templates and generating documents ==
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]]

== Extrafields ==
See page [[Extrafields]]

== Other internal function ==
There is a lot of internal libraries your code can use.
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.

'''To make a condition on Dolibarr version'''

For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
<source lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</source>

= Mass exports/imports =
# [[Mass imports]]
# [[Module Exports En|Mass exports]]

= Interfaces and links with other applications =
# [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers)
# [[Interfaces from foreign systems toward Dolibarr]]
# [[Module Web Services|Web Services]]

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

Dolibarr pour Ubuntu ou Debian

2017-10-30T17:50:55Z

MagicFab: /* Autres informations */

[[Category:Admin]]
[[File:Logo_ubuntu.png]]

=Introduction=
Dolibarr pour Ubuntu et Debian (DoliDeb) est une version de Dolibarr ERP/CRM packagée avec Mysql, PHP et Apache ou Lighttpd pour les plateformes Ubuntu ou Debian.

En quelques secondes, en installant le package, vous êtes capable de travailler sur Dolibarr, même si vous n'avez pas déjà de serveur Web ou si vous ne savez pas ce que sont Apache/Lighttpd, MariaDB/MySQL ou PHP. Une entrée nommée "Dolibarr ERP & CRM" est ajoutée dans le menu des applications de votre ordinateur.

Dolibarr pour Debian/Ubuntu est un package tout en un qui peut être téléchargé depuis le site https://www.dolibarr.fr/telechargements/ dans la categorie des versions stables (voir aussi sur le site internationnal https://www.dolibarr.org/downloads/).

= Prérequis =
Le package dolideb de dolibarr 3.4+ est compatible avec:
* Debian Wheezy 7+
* Ubuntu 13.04+

= Installation/Mise à jour =

== Depuis le fichier .deb téléchargé ==
Pour installer un package récupéré par téléchargement manuel depuis l'espace téléchargement du site dolibarr.org, cliquer sur le fichier dolibarr.x.y.z.deb si vous êtes dans une fenêtre Nautilus, ou, taper depuis une console:

<source lang="bash">
$ sudo apt-get update
$ sudo dpkg -i dolibarr_x.y.z-w.w_all.deb
</source>

x.y.z est la version de dolibarr, ex. dolibarr_3.1.0-1.1_all.deb

Dans le cas d'une erreur de dépendances, tapez:
<source lang="bash">
$ sudo apt-get install -f
</source>

Cette commande corrigera l'ensemble des dépendances orphelines de votre système et finalisera l'installation du package dolibarr.

Note: Si après la configuration vous rencontrez des problèmes à l'utilisation du module WYSIWYG, allez dans le fichier '''/etc/dolibar/conf.php''' et commentez la ligne
<source lang="ini">
$dolibarr_js_CKEDITOR=...
</source>

== Depuis le dépôt PPA (version de développement) ==
'''''Remarque importante''''' : Cette manipulation est reservée au personnes qui souhaitent faire du développement ou tester une nouvelle version de Dolibarr en cours de développement.
Toutes les versions non-stables (alpha, beta et RC) ne sont pas recommandées pour un usage en production.
Pour télécharger une version stable de Dolibarr, voir le chapitre suivant.

Pour installer la version de développement depuis le dépôt PPA:
<source lang="bash">
sudo add-apt-repository ppa:eldy/dolibarr-dev
sudo apt-get update && sudo apt-get install dolibarr
</source>

Note: Si après la configuration vous rencontrez des problèmes à l'utilisation du module WYSIWYG, allez dans le fichier '''/etc/dolibar/conf.php''' et commentez la ligne
<source lang="ini">
$dolibarr_js_CKEDITOR=...
</source>

= Autres informations =
Les informations suivantes sont à destination des mainteneurs pour maintenir Dolibarr dans le dépôt Debian:
* TCPDF: Page accès paquet debian: https://tracker.debian.org/pkg/tcpdf
* TCPDF: Accès GIT développeur: git+ssh://git.debian.org/git/collab-maint/tcpdf.git
* TCPDF: Accès GIT anonymes lecture seule: git://anonscm.debian.org/collab-maint/tcpdf.git (http://anonscm.debian.org/git/collab-maint/tcpdf.git)

* Dolibarr: Page accès paquet Debian maintenu par Debian (en retard de version par rapport au paquet officiel de l'équipe Dolibarr) https://tracker.debian.org/pkg/dolibarr

Dolibarr pour Ubuntu ou Debian

2017-10-30T17:41:14Z

MagicFab: /* Installation/Mise à jour */

[[Category:Admin]]
[[File:Logo_ubuntu.png]]

=Introduction=
Dolibarr pour Ubuntu et Debian (DoliDeb) est une version de Dolibarr ERP/CRM packagée avec Mysql, PHP et Apache ou Lighttpd pour les plateformes Ubuntu ou Debian.

En quelques secondes, en installant le package, vous êtes capable de travailler sur Dolibarr, même si vous n'avez pas déjà de serveur Web ou si vous ne savez pas ce que sont Apache/Lighttpd, MariaDB/MySQL ou PHP. Une entrée nommée "Dolibarr ERP & CRM" est ajoutée dans le menu des applications de votre ordinateur.

Dolibarr pour Debian/Ubuntu est un package tout en un qui peut être téléchargé depuis le site https://www.dolibarr.fr/telechargements/ dans la categorie des versions stables (voir aussi sur le site internationnal https://www.dolibarr.org/downloads/).

= Prérequis =
Le package dolideb de dolibarr 3.4+ est compatible avec:
* Debian Wheezy 7+
* Ubuntu 13.04+

= Installation/Mise à jour =

== Depuis le fichier .deb téléchargé ==
Pour installer un package récupéré par téléchargement manuel depuis l'espace téléchargement du site dolibarr.org, cliquer sur le fichier dolibarr.x.y.z.deb si vous êtes dans une fenêtre Nautilus, ou, taper depuis une console:

<source lang="bash">
$ sudo apt-get update
$ sudo dpkg -i dolibarr_x.y.z-w.w_all.deb
</source>

x.y.z est la version de dolibarr, ex. dolibarr_3.1.0-1.1_all.deb

Dans le cas d'une erreur de dépendances, tapez:
<source lang="bash">
$ sudo apt-get install -f
</source>

Cette commande corrigera l'ensemble des dépendances orphelines de votre système et finalisera l'installation du package dolibarr.

Note: Si après la configuration vous rencontrez des problèmes à l'utilisation du module WYSIWYG, allez dans le fichier '''/etc/dolibar/conf.php''' et commentez la ligne
<source lang="ini">
$dolibarr_js_CKEDITOR=...
</source>

== Depuis le dépôt PPA (version de développement) ==
'''''Remarque importante''''' : Cette manipulation est reservée au personnes qui souhaitent faire du développement ou tester une nouvelle version de Dolibarr en cours de développement.
Toutes les versions non-stables (alpha, beta et RC) ne sont pas recommandées pour un usage en production.
Pour télécharger une version stable de Dolibarr, voir le chapitre suivant.

Pour installer la version de développement depuis le dépôt PPA:
<source lang="bash">
sudo add-apt-repository ppa:eldy/dolibarr-dev
sudo apt-get update && sudo apt-get install dolibarr
</source>

Note: Si après la configuration vous rencontrez des problèmes à l'utilisation du module WYSIWYG, allez dans le fichier '''/etc/dolibar/conf.php''' et commentez la ligne
<source lang="ini">
$dolibarr_js_CKEDITOR=...
</source>

= Autres informations =
Les informations suivantes sont à destination des mainteneurs pour maintenir Dolibarr dans le depot Debian:
* TCPDF: Page accès paquet debian: https://tracker.debian.org/pkg/tcpdf
* TCPDF: Accès GIT développeur: git+ssh://git.debian.org/git/collab-maint/tcpdf.git
* TCPDF: Accès GIT anonymes lecture seule: git://anonscm.debian.org/collab-maint/tcpdf.git (http://anonscm.debian.org/git/collab-maint/tcpdf.git)

* Dolibarr: Page accès paquet debian maintenu par debian (en retard de version par rapport au paquet officiel de l'équipe Dolibarr) https://tracker.debian.org/pkg/dolibarr

Dolibarr pour Ubuntu ou Debian

2017-10-30T17:39:02Z

MagicFab: /* Introduction */ Ajouté mention de MariaDB

[[Category:Admin]]
[[File:Logo_ubuntu.png]]

=Introduction=
Dolibarr pour Ubuntu et Debian (DoliDeb) est une version de Dolibarr ERP/CRM packagée avec Mysql, PHP et Apache ou Lighttpd pour les plateformes Ubuntu ou Debian.

En quelques secondes, en installant le package, vous êtes capable de travailler sur Dolibarr, même si vous n'avez pas déjà de serveur Web ou si vous ne savez pas ce que sont Apache/Lighttpd, MariaDB/MySQL ou PHP. Une entrée nommée "Dolibarr ERP & CRM" est ajoutée dans le menu des applications de votre ordinateur.

Dolibarr pour Debian/Ubuntu est un package tout en un qui peut être téléchargé depuis le site https://www.dolibarr.fr/telechargements/ dans la categorie des versions stables (voir aussi sur le site internationnal https://www.dolibarr.org/downloads/).

= Prérequis =
Le package dolideb de dolibarr 3.4+ est compatible avec:
* Debian Wheezy 7+
* Ubuntu 13.04+

= Installation/Mise à jour =

== Depuis le fichier .deb téléchargé ==
Pour installer un package récupéré par téléchargement manuel depuis l'espace téléchargement du site dolibarr.org, cliquer sur le fichier dolibarr.x.y.z.deb si vous êtes dans une fenêtre Nautilus, ou, taper depuis une console:

<source lang="bash">
$ sudo apt-get update
$ sudo dpkg -i dolibarr_x.y.z-w.w_all.deb
</source>

x.y.z est la version de dolibarr, ex. dolibarr_3.1.0-1.1_all.deb

Dans le cas d'une erreur de dépendances, tapez:
<source lang="bash">
$ sudo apt-get install -f
</source>

Cette commande corrigera l'ensemble des dépendances orphelines de votre système et finalisera l'installation du package dolibarr.

Note: Si après la configuration vous rencontrez des problèmes à l'utilisation du module WYSIWYG, allez dans le fichier '''/etc/dolibar/conf.php''' et commentez la ligne
<source lang="ini">
$dolibarr_js_CKEDITOR=...
</source>

== Depuis la source PPA (version de développement) ==
'''''Remarque importante''''' : Cette manipulation est reservée au personnes qui souhaitent faire du développement ou tester une nouvelle version de Dolibarr en cours de développement.
Toutes les versions non stables (alpha, beta et RC) ne sont pas recommandées pour un usage en production.
Pour télécharger une version stable de Dolibarr, voir le chapitre suivant.

Pour installer la version de dev depuis le repository PPA:
<source lang="bash">
sudo add-apt-repository ppa:eldy/dolibarr-dev
sudo apt-get update && sudo apt-get install dolibarr
</source>

Note: Si après la configuration vous rencontrez des problèmes à l'utilisation du module WYSIWYG, allez dans le fichier '''/etc/dolibar/conf.php''' et commentez la ligne
<source lang="ini">
$dolibarr_js_CKEDITOR=...
</source>

= Autres informations =
Les informations suivantes sont à destination des mainteneurs pour maintenir Dolibarr dans le depot Debian:
* TCPDF: Page accès paquet debian: https://tracker.debian.org/pkg/tcpdf
* TCPDF: Accès GIT développeur: git+ssh://git.debian.org/git/collab-maint/tcpdf.git
* TCPDF: Accès GIT anonymes lecture seule: git://anonscm.debian.org/collab-maint/tcpdf.git (http://anonscm.debian.org/git/collab-maint/tcpdf.git)

* Dolibarr: Page accès paquet debian maintenu par debian (en retard de version par rapport au paquet officiel de l'équipe Dolibarr) https://tracker.debian.org/pkg/dolibarr

Dolibarr Preferred Partner

2017-10-30T15:31:15Z

MagicFab: /* Specific to Spain and Latino america */

{{TemplateAssoEn}}
<center>
[[File:Business people large.png|120px]]
</center>
This page describe the '''Dolibarr Preferred Partner''' program of '''Dolibarr ERP & CRM''' software. You will find here terms and condition to be certified, and constraints and benefits.
For a list of partners in the world, see page [[List of Dolibarr partners and providers]].

= What is a Dolibarr Preferred Partner (Provided services) =
A "'''Dolibarr Preferred Partner'''" is a supplier that provides services around Dolibarr ERP-CRM while offering guarantees to be reliable and competent around product and offered services.

The following is list of all services a company can provide as a certified [[File:Dolibarr_preferred_partner_int.png|100px]]
# Installation/Setup
# User training / Development training
# Help and support
# Custom development
# Dolibarr web hosting (SaaS or cloud hosting)

Partners can offer one or more of these services but not necessarily all of them. Also, a company can offer all of these services without being certified. The label is above all a guarantee of quality for customers but it can also be a way to benefit from some advantages (see below).

Do not confuse "Dolibarr Preferred Partner" with "Dolibarr Communities". Communities are groups of enthusiasts who work (without necessarily having references) promoting Dolibarr. If you want to also create a Dolibarr community in your region or country, see [[Create a Dolibarr local community]].

The list of Preferred Partners is available on the [[List of Dolibarr partners and providers]] page.

= Eligibility Rules =
Eligibility rules for the label are:

* Being a company registered in your country.

Then you have to enter the criteria for your country:

== For France, Belgium, Switzerland, Luxembourg (cumulative points) ==
* A) The company must be a member of the Dolibarr foundation (either as a moral member or as an individual member). For this, just follow instructions on page [[Subscribe#Subscribe_for_first_time_to_the_foundation|Subscribe]].
* B) The company should have
** submitted/published at least 500 approved lines of code or translations (in the source code, into a module on dolistore.com or onto the wiki.dolibarr.org)
** or have represented Dolibarr in at least one computer room or congress during past year
** or have published two press releases about Dolibarr into past year.
This point B is to guarantee that company is still active around project and news.
* C) The company must agree to have in its ranks at least one active contributor ("active" will be define by analyzing github contrbibutions, wiki or forums).
* D) The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

== For Spain and Latino America ==
* All rules are deinfed into page http://dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner
* The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

== For other countries (cumulative points) ==
* A) The company must be a member of the Dolibarr foundation (either as a moral member or as an individual member). For this, just follow instructions on page [[Subscribe#Subscribe_for_first_time_to_the_foundation|Subscribe]].
* B) The company should
** have submitted at least 500 approved lines of code or translations during past year (in the source code, into a module on dolistore.com or onto the wiki.dolibarr.org)
** or have represented Dolibarr in at least one computer room or congress during past year
** or have published two press releases about Dolibarr during past year.
This point B is to guarantee that company is still active around project and news.
* C) The company must agree to have in its ranks at least one active contributor ("active" will be define by analyzing github contrbibutions, wiki or forums).
* D) The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

These rules are subject to change by strengthening over time. The board members of the Dolibarr foundation may decide to grant the label even if one criteria is not completely filled, checking that the partner has otherwise proved his involvement and contribution in the project. This case, however, requires an unanimous vote (no votes against) from the board members after request by a member of the Dolibarr foundation.

= Constraints =
== For all countries ==
The following constraints must be met:

A1) The company must redirect clients that it can't provide to another Dolibarr Preferred Partner (list available here: [[List of Dolibarr partners and providers]]). Information can be posted on mailing list '''dolibarr-preferred-partners@nongnu.org''' where all Dolibarr Preferred Partners are subscribers.

If the company provides hosting service Dolibarr (SaaS), it must agree to the following:

B1) Time display of a page <2 seconds (measurement made at the Firebug plugin for Firefox)

B2) The host must provide updates of Dolibarr to all of its customers (except if customer request this opposite) of a stable version that is not older than 12 months.

B3) All features included with the standard version of Dolibarr must be enabled. The company is free to add additional modules.

B4) If there are limitations of time or amount that have been added in some offers compared to standard Dolibarr version, the list must appear in the general sales conditions / accommodation.

== Specific to Spain and Latin America ==
* Other constraints are defined in page: http://dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner

= Process to get certification =
== For France, Belgium, Switzerland, Luxembourg ==
* Create a GitHub account (go on https://github.com/). At least one login will be required to fill the request form.
* Subscribe to be a member of the [[Subscribe|Dolibarr foundation]].
* Once subscription and payment recevied, fill the following request document: [[Media:Dolibarr preferred partner contract.odt]] and send it by email to '''contact@dolibarr.org'''
Once document will be received, we will examine your file (delay between 1 and {{TemplateDelayPreferredPartner}} month).

If approved, the foundation add you as a Dolibarr partner into the [[List of Dolibarr partners and providers]] and a contract signed by the office of the foundation will be sent, which will serve as a certificate.

== For Spain and Latino America ==
Complete the [http://www.dolibarr.es/index.php/contacto-dolibarr following form] and provide the following to the company '''2Byte.es''':
* CIF Fotocopias del de la empresa.
* Fotocopias certificado de alta de la empresa.
* Fotocopias del IAE.
At the end of this, the application is assessed. If approved, a contract will be signed between 2Byte and the company. 2byte will add the company on the [[List of Dolibarr partners and providers]].

== For all other countries ==
* Create a GitHub account (go on https://github.com/). At least one login will be required to fill the request form.
* Subscribe to be a member of the [[Subscribe|Dolibarr foundation]].
* Fill the following request document: [[Media:Dolibarr preferred partner contract.odt]] and send it by email to '''contact@dolibarr.org'''
Once document will be received, we will examine your file (delay between 1 and {{TemplateDelayPreferredPartner}} month).

If approved, the foundation add you as a Dolibarr partner into the [[List of Dolibarr partners and providers]] and a contract signed by the office of the foundation will be sent, which will serve as a certificate.

= Rules of validity =
* The certification is valid for a period of one year. It is reviewed annually and renewed automatically as long as the conditions are met (Note: The criteria, however, may have hardened in the meantime).
* The certification is valid for the countries whose language used is a language in which the partner serves.

= Benefits =
== For all countries ==
* The company is promoted by the Dolibarr foundation. For example, the company is highlighted on the [[List of Dolibarr partners and providers]] (Send an email to contact@dolibarr.org if it is not), but also on other information channels controlled by the Dolibarr foundation.
* The Company may use the logo "DOLIBARR Preferred Partner" on its website (in such a case, the logo must point to http://www.dolibarr.org/partners web site) and all documents:
<center> [[File: Dolibarr_preferred_partner_int.png | 160px]] </center>
or Spanish-speaking countries:
<center> [[File: Dolibarr_preferred_partner_es.png | 160px]] </center>
* The company can highlight the term "Dolibarr Preferred Partner" on its website and all its documents.
* The company may receive and use all marketing materials provided by the foundation or company 2byte (Spanish speaking countries). For example, business cards, flyers, slide templates or roll-ups available at Git URL: git://github.com/Dolibarr/foundation.git. All of content into this repository is licensed under licence CC-BY-SA. You are free to modify, translate and use them.
* The company is listed on the mailing-list '''dolibarr-preferred-partners@nongnu.org''' ({{TemplateURLMLDev}}) for receiving the following information:
** Miscellaneous information
** Eventually, list of tenders sent by other "Dolibarr Preferred Partners" who can not meet the need of their client (in such case, language of forwarded message may be in any language, not necessarily yours).
* The company can then provide any kind of services on Dolibarr among the one described into first chapter, with price and condition of its choice.

== Specific to Spain and Latino America ==
* Partners benefits also services defined in page: http://dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner

Dolibarr Preferred Partner

2017-10-30T15:30:35Z

MagicFab: /* What is a Dolibarr Preferred Partner (Provided services) */ - several English grammar fixes

{{TemplateAssoEn}}
<center>
[[File:Business people large.png|120px]]
</center>
This page describe the '''Dolibarr Preferred Partner''' program of '''Dolibarr ERP & CRM''' software. You will find here terms and condition to be certified, and constraints and benefits.
For a list of partners in the world, see page [[List of Dolibarr partners and providers]].

= What is a Dolibarr Preferred Partner (Provided services) =
A "'''Dolibarr Preferred Partner'''" is a supplier that provides services around Dolibarr ERP-CRM while offering guarantees to be reliable and competent around product and offered services.

The following is list of all services a company can provide as a certified [[File:Dolibarr_preferred_partner_int.png|100px]]
# Installation/Setup
# User training / Development training
# Help and support
# Custom development
# Dolibarr web hosting (SaaS or cloud hosting)

Partners can offer one or more of these services but not necessarily all of them. Also, a company can offer all of these services without being certified. The label is above all a guarantee of quality for customers but it can also be a way to benefit from some advantages (see below).

Do not confuse "Dolibarr Preferred Partner" with "Dolibarr Communities". Communities are groups of enthusiasts who work (without necessarily having references) promoting Dolibarr. If you want to also create a Dolibarr community in your region or country, see [[Create a Dolibarr local community]].

The list of Preferred Partners is available on the [[List of Dolibarr partners and providers]] page.

= Eligibility Rules =
Eligibility rules for the label are:

* Being a company registered in your country.

Then you have to enter the criteria for your country:

== For France, Belgium, Switzerland, Luxembourg (cumulative points) ==
* A) The company must be a member of the Dolibarr foundation (either as a moral member or as an individual member). For this, just follow instructions on page [[Subscribe#Subscribe_for_first_time_to_the_foundation|Subscribe]].
* B) The company should have
** submitted/published at least 500 approved lines of code or translations (in the source code, into a module on dolistore.com or onto the wiki.dolibarr.org)
** or have represented Dolibarr in at least one computer room or congress during past year
** or have published two press releases about Dolibarr into past year.
This point B is to guarantee that company is still active around project and news.
* C) The company must agree to have in its ranks at least one active contributor ("active" will be define by analyzing github contrbibutions, wiki or forums).
* D) The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

== For Spain and Latino America ==
* All rules are deinfed into page http://dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner
* The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

== For other countries (cumulative points) ==
* A) The company must be a member of the Dolibarr foundation (either as a moral member or as an individual member). For this, just follow instructions on page [[Subscribe#Subscribe_for_first_time_to_the_foundation|Subscribe]].
* B) The company should
** have submitted at least 500 approved lines of code or translations during past year (in the source code, into a module on dolistore.com or onto the wiki.dolibarr.org)
** or have represented Dolibarr in at least one computer room or congress during past year
** or have published two press releases about Dolibarr during past year.
This point B is to guarantee that company is still active around project and news.
* C) The company must agree to have in its ranks at least one active contributor ("active" will be define by analyzing github contrbibutions, wiki or forums).
* D) The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

These rules are subject to change by strengthening over time. The board members of the Dolibarr foundation may decide to grant the label even if one criteria is not completely filled, checking that the partner has otherwise proved his involvement and contribution in the project. This case, however, requires an unanimous vote (no votes against) from the board members after request by a member of the Dolibarr foundation.

= Constraints =
== For all countries ==
The following constraints must be met:

A1) The company must redirect clients that it can't provide to another Dolibarr Preferred Partner (list available here: [[List of Dolibarr partners and providers]]). Information can be posted on mailing list '''dolibarr-preferred-partners@nongnu.org''' where all Dolibarr Preferred Partners are subscribers.

If the company provides hosting service Dolibarr (SaaS), it must agree to the following:

B1) Time display of a page <2 seconds (measurement made at the Firebug plugin for Firefox)

B2) The host must provide updates of Dolibarr to all of its customers (except if customer request this opposite) of a stable version that is not older than 12 months.

B3) All features included with the standard version of Dolibarr must be enabled. The company is free to add additional modules.

B4) If there are limitations of time or amount that have been added in some offers compared to standard Dolibarr version, the list must appear in the general sales conditions / accommodation.

== Specific to Spain and Latino america ==
* Other constraints are defined in page: http://dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner

= Process to get certification =
== For France, Belgium, Switzerland, Luxembourg ==
* Create a GitHub account (go on https://github.com/). At least one login will be required to fill the request form.
* Subscribe to be a member of the [[Subscribe|Dolibarr foundation]].
* Once subscription and payment recevied, fill the following request document: [[Media:Dolibarr preferred partner contract.odt]] and send it by email to '''contact@dolibarr.org'''
Once document will be received, we will examine your file (delay between 1 and {{TemplateDelayPreferredPartner}} month).

If approved, the foundation add you as a Dolibarr partner into the [[List of Dolibarr partners and providers]] and a contract signed by the office of the foundation will be sent, which will serve as a certificate.

== For Spain and Latino America ==
Complete the [http://www.dolibarr.es/index.php/contacto-dolibarr following form] and provide the following to the company '''2Byte.es''':
* CIF Fotocopias del de la empresa.
* Fotocopias certificado de alta de la empresa.
* Fotocopias del IAE.
At the end of this, the application is assessed. If approved, a contract will be signed between 2Byte and the company. 2byte will add the company on the [[List of Dolibarr partners and providers]].

== For all other countries ==
* Create a GitHub account (go on https://github.com/). At least one login will be required to fill the request form.
* Subscribe to be a member of the [[Subscribe|Dolibarr foundation]].
* Fill the following request document: [[Media:Dolibarr preferred partner contract.odt]] and send it by email to '''contact@dolibarr.org'''
Once document will be received, we will examine your file (delay between 1 and {{TemplateDelayPreferredPartner}} month).

If approved, the foundation add you as a Dolibarr partner into the [[List of Dolibarr partners and providers]] and a contract signed by the office of the foundation will be sent, which will serve as a certificate.

= Rules of validity =
* The certification is valid for a period of one year. It is reviewed annually and renewed automatically as long as the conditions are met (Note: The criteria, however, may have hardened in the meantime).
* The certification is valid for the countries whose language used is a language in which the partner serves.

= Benefits =
== For all countries ==
* The company is promoted by the Dolibarr foundation. For example, the company is highlighted on the [[List of Dolibarr partners and providers]] (Send an email to contact@dolibarr.org if it is not), but also on other information channels controlled by the Dolibarr foundation.
* The Company may use the logo "DOLIBARR Preferred Partner" on its website (in such a case, the logo must point to http://www.dolibarr.org/partners web site) and all documents:
<center> [[File: Dolibarr_preferred_partner_int.png | 160px]] </center>
or Spanish-speaking countries:
<center> [[File: Dolibarr_preferred_partner_es.png | 160px]] </center>
* The company can highlight the term "Dolibarr Preferred Partner" on its website and all its documents.
* The company may receive and use all marketing materials provided by the foundation or company 2byte (Spanish speaking countries). For example, business cards, flyers, slide templates or roll-ups available at Git URL: git://github.com/Dolibarr/foundation.git. All of content into this repository is licensed under licence CC-BY-SA. You are free to modify, translate and use them.
* The company is listed on the mailing-list '''dolibarr-preferred-partners@nongnu.org''' ({{TemplateURLMLDev}}) for receiving the following information:
** Miscellaneous information
** Eventually, list of tenders sent by other "Dolibarr Preferred Partners" who can not meet the need of their client (in such case, language of forwarded message may be in any language, not necessarily yours).
* The company can then provide any kind of services on Dolibarr among the one described into first chapter, with price and condition of its choice.

== Specific to Spain and Latino America ==
* Partners benefits also services defined in page: http://dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner