Dolibarr ERP CRM Wiki - User contributions [en]

Language and development rules

2022-09-05T14:03:15Z

Dolichicken: In English, the meaning of "eventually" is more like "at the end". This is different to German (and probably French), where the meaning of "eventuell" is more like "maybe".

[[de:Sprachen_und_Programmierregeln]]
[[fr:Langages_et_normes]]
[[es:Lenguaje_y_Normas_de_Desarrollo]]
[[zh:语言和开发规则]]


{{TemplateDocDevEn}}

These are some rules on language, syntax and norm we use in the Dolibarr project:

=Versions=

*Dolibarr must work on:

#All OS (Windows, Linux, MACOS...)
#PHP {{PHPMinVersion}} (Must work with no need of complementary PHP module, except module to PHP module to access database).
#MySQL {{MySqlMinVersion}}

=Copyright Norms=

*All PHP files must start with a header that looks like

<syntaxhighlight lang="PHP">
<?php
/* Copyright (C) YYYY John Doe <email@email.com>
*
* Licence information
*/
...
</syntaxhighlight>
When you edit an existing file of project, you must add a Copyright line under others.

=PHP Norms=
==PHP==

*Dolibarr is written with PHP and supports all versions of PHP higher than {{PHPMinVersion}}. All files must end with extension .php

*Usage of PHP superglobals variables must use the dedicated operators $_COOKIES, $_SERVER, $_ENV but use the Dolibarr function GETPOST() to get the contents of $_GET or $_POST..

*Other operators ($HTTP_SERVER_GET, ...) are now deprecated in PHP, so they must not be used. Code must work if option '''register_long_arrays''' is set to off. Moreover, the code must work when PHP option '''register_globals''' is off (recommended by PHP). It must also work if the option '''register_globals''' is on (by default on a lot of installations).

*Do not use '''<s>PHP_SELF</s>'''. Use instead '''$_SERVER["PHP_SELF"]'''. Also, Dolibarr framework sanitizes content of $_SERVER["PHP_SELF"] variable (into main.inc.php file, before any business code).

*When several variables must be initialized with the same value, you must use individual declarations (separated by ;)

<syntaxhighlight lang="PHP">
$var1 = 1;
$var2 = 1;
$var3 = 1;
</syntaxhighlight>
instead of
<syntaxhighlight lang="PHP">
$var1 = $var2 = $var3 = 1;
</syntaxhighlight>
which is slower.

 

====Strings====

*Strings must be have variables outside of the quote.

<syntaxhighlight lang="PHP">
print "My text show my ".$variable." !\n";
</syntaxhighlight>

 

====Comments====

*Comments must use the C syntax, ie a double slash for a comment on one line and a slash-star to open a bloc for several lines

<syntaxhighlight lang="PHP">
/* Bloc of comment
*
* End of bloc
*/

$monobjet = new MonObjet($db);
$result=$monobjet->fetch($idobject);

for ($i = 1 , $i < 2 ; $i++) {
// comment on one line
print $i;
}

function myFunction($param1, $param2)
{
// code
}
</syntaxhighlight>

 

*Functions must return a value equal or higher than 0 if successful and strictly lower than 0 if error.

*No dead code (code never used) into Dolibarr core code (code used by external modules only must be included within the external modules).

*Use "include_once" for anything with functions or class definitions in it (like *.class.php and *.lib.php files), use "include" for template-style php with files containing common part of HTML and PHP code (like *.inc.php and *.tpl.php files).

*Coding style to use is the '''PSR-12''' (https://www.php-fig.org/psr/psr-12/). Only rules tagged "MUST" are currently required. So note however the exceptions:
**Length of line: PSR-12 mention we can't go up to 120 characters on same line, this is a soft limit. It is better to have long lines instead of long page with code content that is just data declaration and does not contain any logic. However, we introduced a hard limit of '''1000''' characters (having line larger than this may return errors on Continuous Integration tests).
**Tabs are allowed: The other exception is that we don't replace systematically the tabs with spaces. Using tabs is more convenient for most editors/developers. Also using spaces breaks some auto-format features (like Eclipse autoformat feature on some Eclipse version). For the moment, the best setup is "Keep spaces/tabs as it is", however, you can activate the option "Remove spaces at end of lines".
**We allow elements of an array on same line and we do not always add a new line at end of each element.
**Note 1: The following rule are very important to follow:
***Files must be saved with Unix format (LF) and not Windows (CR/LF). Unix format is compatible on all OS such as Unix like, Windows, Mac, but the Windows text file format may not work on some PHP under Unix.
***Smart tags PHP are not used. PHP code section must start with '''<?php'''
**Note 2: You can use the file '''dev/setup/codesniffer/ruleset.xml''' as rule file to control coding style with PHPCodeSniffer.
**Note 3: You can use the file '''dev/setup/eclipse/PSR-12 [built-in].xml''' as rule file to setup Eclipse syntax formater.
**Note 4: You may note that current code is not yet compliant with the PSR-12. The reason is that we must "now" follow the "MUST" rules of PSR-12, but it wasn't in the past. So feel free to change coding style to match new rules (keep in mind the 2 exceptions) if you find such cases.

==Classes and properties structures==

Some properties of classes are found in different classes. To avoid having different names, we will use the following PHP properties names:

{{TemplatePHPFields}}

=SQL and Database rules=

==DDL file format==
Files containing definition of the database structure (DDL files) must be '''2 per table''':

*The first file defines the table and its fields. The file name contains the table name, e.g. like this: <tt>llx_''mytable''.sql</tt>

A comment will be added for each field to explain its usage.

*The second file defines all foreign keys, performance indexes or other constraints and the file name will be like: <tt>llx_''mytable''.key.sql</tt>

These files must be stored in the directory '''install/mysql/tables''' for all standard files or '''mymodule/tables''' for tables provided by an external module.

Example: '''file for creating the table llx_mytable will be llx_mytable.sql''':

<syntaxhighlight lang="sql">
-- ===========================================================================
-- Copyright (C) 2013 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================

create table llx_mytable
(
rowid integer NOT NULL AUTO_INCREMENT PRIMARY KEY,
ref varchar(30) NOT NULL, -- object reference number
entity integer DEFAULT 1 NOT NULL, -- multi company id
ref_ext varchar(255),-- reference into an external system (not used by dolibarr)
field_one integer,
field_two integer NOT NULL,
fk_field integer,
field_date datetime,
datec timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,, -- creation datetime
tms timestamp, -- update time stamp
fk_user_author integer NOT NULL, -- Author, foreign key of llx_user
fk_user_mod integer NOT NULL, -- Last updater, foreign key of llx_user
import_key varchar(14) -- Use by import process
)type=innodb;
</syntaxhighlight>

Example: '''file for creating keys/indexes for the table llx_mytable will be llx_mytable.key.sql''':

<syntaxhighlight lang="sql">
-- ===========================================================================
-- Copyright (C) 2013 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================

ALTER TABLE llx_mytable ADD UNIQUE uk_mytable_field (field_one, field_two);

ALTER TABLE llx_mytable ADD CONSTRAINT fk_mytable_fk_field FOREIGN KEY (fk_field) REFERENCES llx_matablepere (rowid);
</syntaxhighlight>

==Table and fields structures==

*Structure of tables.

When you create a new table, it is recommended to use the same conventions as other Dolibarr tables. This means the following fields:
- rowid INTEGER AUTO_INCREMENT PRIMARY KEY that is technical id of record
- entity INTEGER default 1 that is id for the multicompany feature
- date_creation datetime that is the creation date
- tms timestamp that will contain date of last modification (the database manages this field automatically, no need to manage it by the code, just create the field)
- date_valid datetime that is the validation date (if applicable)
- import_key varchar(32) that will contain the import code YYYYMMDDHHMMSS if you make mass import
- status smallint to store a status
Optional
- fk_user_creat or fk_user_author integer that is the id of user making creation
- fk_user_modif integer that is the id of user making change
- fk_user_valid integer that is the id of user validating record (if applicable)
- fk_soc integer that is the ID of the Third party (if applicable)

Note field:
- note_private text for private comment of the object
- note_public text for public comment of the object
or
- note text if there is no need to have private and public

*Type of fields:

To be compatible with any accuracy required by any country on amounts, to be compatible with any database syntax and with the Dolibarr upgrade framework, we will use the following types for database fields:

- integer for a primary key, an integer or any of foreign key (bigint may also be accepted for very large tables)
- smallint for a small number (like for a status) or a boolean
- double(24,8) for any amount
- double(6,3) for any vat rate
- real for a quantity
- varchar for a string (also if length is 1, the type char is more and more deprecated)
- timestamp for a field date+time that is automatically updated
- datetime for a field date+time
- date for a field date
- text or medium text for large fields (no index allowed on such fields)

All business rules must be in the same place, in PHP code, not in the client or the database, that's why type enum is also not allowed.
Other types are not allowed for compatibility reasons.

*All tables have a prefix to avoid name conflicts with other projects. In the current version this prefix is fixed and can't be modified. Its value is <tt>llx_</tt>. In a future version this value should be modified during installation process.

==Primary keys==
The primary key of a table must be called <tt>rowid</tt>.

Some old tables do not use this rule and use a primary key called <tt>id</tt> (e.g. [[Table llx_c_actioncomm]]). The reason is historical and this should not happen anymore.

==Foreign keys==
Name of a foreign key must start with the prefix <tt>fk_</tt> followed by the table name (i.e. name of the referencing table) (this is required to avoid duplicate names in project that are not allowed even if in different tables by some DBMS like Postgresql) then the field name (i.e. name of the referencing field) (this is to allow to have several foreign keys in same table).

Example:
''fk_facture_fourn_fk_soc'' is a foreign key in the table llx_facture_fourn for the field fk_soc in this table (that references the rowid field in another table)

Note: If you develop your own external module, it must have no foreign keys that point to Dolibarr standard tables. This will break standard dolibarr upgrades, repair, backup and restore tools and may also break standard features.

==Alternative keys==
Sometimes, we need other unique keys than primary key. When we need this, we can create an alternate unique key. Such a key should have a name that starts with <tt>uk_</tt>, then the table name (this is required to avoid duplicate names of unique keys that may create problems for some DBMS like Postgresql) and then another string to define the key (this is to allow having several unique keys on the same table).

Example:
''uk_societe_code_client'' is a unique key on table llx_societe on field code_client.

==Index performance==
Some fields are often used as search or order criteria, or for joins. In such case, we need to set a performance index on field to increase performances. Such indexes are named with a prefix <tt>idx_</tt> then the table name and then the field name.

Example:
''idx_societe_user_creat'' is a performance index on table llx_societe for field user_creat

==SQL Coding rules==

*Alias usage/Fields naming

When doing select, we can use alias to simplify writing/reading of requests:
<syntaxhighlight lang="sql">
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
</syntaxhighlight>
However, we must not used alias for update request as they are not compatible with Mysql 3.1.

*Using SELECT * is forbidden ! When using SELECT you must define complete list of fields to get. This avoids confusion. And above all, this make reengeering of code easier and make impact analysis of change on a field possible. Example:

<syntaxhighlight lang="sql">
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
</syntaxhighlight>

*Into SQL requests, you must quote fields except the fields that contain amounts which must be stored as double or real type. Quotes on numbers may result in saving as a different value. For example 412.62 in an insert will be saved as value 412.61999512 into database (due to implicit conversion string to numeric) if the target field has type double(24,8). Only PHP see value 412.61999512. Other tools will see 412.62 giving a sense that there is no problem. But it's PHP that has the good vision. There is really a wrong value into database. By removing quotes on numbers, no problem occurs.

Example:
<syntaxhighlight lang="sql">
Good: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
Bad: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
</syntaxhighlight>

Note, problem of float numbers is same problem on all langauges and not only when inserting data into database. It occurs also with any language when you work on "real" numbers, so numbers must be, as soon as they are affected, cleaned with function price2num with second parameter defined to :
'MU' (for unit prices), 'MT' (for total prices) or 'MS' (otherwise) depending on usage of number. (see function documentation)

*Functions NOW, SYSDATE or DATEDIFF are forbidden inside SQL requests. If you must use the current date into a field, value must come from the PHP and not from the database engine. This is for better portability of code and correct management of TimeZone.

For example, don't do:
<syntaxhighlight lang="PHP">
$sql="SELECT rowid FROM table where datefield = NOW()";
</syntaxhighlight>
but do:
<syntaxhighlight lang="PHP">
$sql="SELECT rowid FROM table where datefield = '".$this->db->idate(dol_now())."'";
</syntaxhighlight>

For example, don't do:
<syntaxhighlight lang="PHP">
$sql="SELECT rowid FROM table where DATEDIFF(table.datefield, NOW()) > 7";
</syntaxhighlight>
but do:
<syntaxhighlight lang="PHP">
$sql="SELECT rowid FROM table where datefield < '".$this->db->idate(dol_now() - (7 * 24 * 3600))."'";
</syntaxhighlight>

An other advantage of this rule, is that request benefits of index because we are making a compare of a field with a fixed value. When using datediff, you make an operation on field before comparison, this means database can't use the index on field, resulting on very bad performance compared to solution without the datediff.

*Use $db->ifsql for SQL IF

Do not include the IF into your forged SQL request. But use instead $db->ifsql() method to you will make a SQL IF that is compatible with all SQL databases.

*No DELETE CASCADE and ON UPDATE CASCADE

Such SQL instructions are forbidden because they bypass the business rules of the application. For example, if there is a delete cascade between table A and B, when the application will execute the code to remove a record in A, the children into table B will also be removed. If there was a Dolibarr PHP trigger (for example bring by an external module) on the deletion of record of B (for example to validate the deletion or to execute a complementary action), the DELETE CASCADE will be executed without having the Dolibarr PHP trigger executed, missing the validation or actions of the PHP trigger of the module. So all business rules must be implemented on the same side (the server PHP side), this is the reason why business rules implemented on Database are not allowed (same situation than the next point on Database triggers)

==Using Database triggers==
Using Database triggers is not allowed into the code of Dolibarr, so you should have no troubles with Database triggers.
Database triggers are not portable. Compatibility may be broken when upgrading your version of your database, database triggers are often not included into backup tools, database triggers need permissions that you may not have (and should not have) on a common secured database, database triggers means also that you include some "business rules" of your application into the database where most other rules are managed by the code itself (this can create conflict or code that can't be debugged with a step by step debugger), database triggers execute code using the timezone of the database instead of the reference timezone of application that may be different (generating offset into database) ...
There is tons of reason why we do not recommend to use database triggers in your own development.
Using Database triggers can save you time when you make development but is a very bad practice, so is forbidden as it is not compatible with the high level of quality of code expected by Dolibarr team. External modules that uses Database triggers may also be refused on the market place since it won't work for more than 50% of users.

==MySQL-MariaDB specificity==

*Tables must be declared with format InnoDB.

This format supports foreign keys and their restrictions, and transactions integrity is also supported. This guarantees that Dolibarr events keep all data with correct values between tables even when transaction modify different tables.

*Dolibarr MUST work even if MySQL option '''strict''' is active.

To activate it (required when developing on Dolibarr), add the following line into the config file of your MySQL server (my.cnf or my.ini)
{{MySqlStrictMode}}

==PostgreSQL specificities==
Only MySQL files must be maintained.
Those files are converted "on the fly" by the database Dolibarr driver.

There is an exception for the SQL "UPDATE FROM":

MySQL Syntax:
<syntaxhighlight lang="sql">
UPDATE table_target as target, table_source as source SET fieldtarget=source.fieldsource
WHERE source.rowid=target.rowid;
</syntaxhighlight>

PgSQL Syntax:
<syntaxhighlight lang="sql">
UPDATE table_target as target SET fieldtarget=source.fieldsource
FROM table_source as source WHERE source.rowid=target.rowid;
</syntaxhighlight>

There is no native SQL requests "UPDATE FROM" in all Dolibarr core. But if you use one in your own code of your module, you should do :
<syntaxhighlight lang="PHP">
if ($this->db->type=='pgsql') {
$sql="UPDATE table_target as target SET fieldtarget=source.fieldsource
FROM table_source as source WHERE source.rowid=target.rowid";
} else {
$sql= "UPDATE table_target as target, table_source as source SET fieldtarget=source.fieldsource
WHERE source.rowid=target.rowid";
}
</syntaxhighlight>

=HTML norms=
==Syntax rules==

*HTML used must be HTML compliant and not XHTML. All attributes of HTML tags must be in lower case and quoted with ".

*Links href must be absolute and use the function dol_buildpath() to get absolute path from a relative path and img tag must be build using function img_picto().

For example:
<syntaxhighlight lang="PHP">
print '<a href="'.dol_buildpath('/mydir/mypage.php').'">'.img_picto('Texte alt','namepictopng','').'</a>';
</syntaxhighlight>

*HTML tables must have columns with no forced width, except for columns that contains data we know the length. For example, a column with a picto only can be forced to with="20px".

Otherwise, we must avoid forcing the column width. Reason is that, in most cases, the browser make a better works to define column width automatically than forced values, and it works whatever is the resolution.

*Javascript/ajax code and call to javascript files into php pages must be avoided. However, if you need to include javascript code, you must add a condition on "$conf->use_javascript_ajax"

<syntaxhighlight lang="PHP">
if ($conf->use_javascript_ajax) {
... // php code generating javascript here
}
</syntaxhighlight>

*Popup windows must not be used, except for tooltips (and must have a condition as explained before).

*External scripts must be written in Perl if they can't be written in PHP. Usage of another language is not forbidden but must be argued before in the development mailing-list.

==External template framework ?==
There is ton of frameworks to provide a template language of an HTML page (smarty, twig, ...). The best and faster on we know is just called "PHP", and because Dolibarr already depends on PHP, there is no need to introduce a dependency on a third language to make templates.

All template frameworks are just pre-processor, BEFORE PHP. It can't be faster than PHP alone. When we say "speed is increased because template framework use a cache", you must read in fact "the overtime spent by the framework is reduced by cache, not the speed of processing PHP file". We should say "any template framework has an overload over PHP, the cache of the template framework just reduces the slowing effect of using this framework", but not "the speed is increased, it is always decreased compared to pure PHP".

Above all, having a template system is completely possible by doing a "'''.tpl.php'''" file that dos not contains any logic code, but only HTML and print of variables. We get same result (but faster and easier to develop because it does not need to do all the setXXX before calling each template). All variables (known by code that include the template) are automatically known into a PHP template page. No risk to forget a set, and a lot of line of codes reduced, a lot of time and development errors are also saved.

Also, keeping a guarantee of 100% of isolation between code and HTML output is interesting in only 1 situation: When teams building design is completely different than team building logic code, AND if you build not too sophisticated pages, AND with no need of too many Ajax features (this need to know how code works).
And this situation is surely not the Dolibarr future (team will often be same, Ajax will be more and more present, event if I hope not too much, and screens are more and more dependent of dynamic or contextual events, difficult to have this with one simple template without transforming the template into a page with high level of code). Also design if more an more managed now in CSS side instead of PHP side.

In the past, Dolibarr has experimented a template system like smarty. If on the paper the idea was good, we quickly realized that finding a bug become a headache, coding become a treasure hunt, maintenance and development were done so slower (compared to previous situation where output templates are into the "View" section of each PHP file) that we forgot this idea. Pragmatism has made the rule.

There is a ton of other reasons to not use an external template system and all arguments to use them are also the best argument to use HTML/PHP as our template system. We just ask to keep separation between '''Controllers''' (the first section of PHP pages juste after the /* Action */ line), and the '''Views''', the second section after the /* View */ comment).

=Dolibarr norms and code skeleton=

==Skeleton code==
To standardize the code, and to speed up the development of new components in Dolibarr, you'll find skeletons of files fully prepared in the directory '''htdocs/modulebuilder/templates/'''.

For example:

*1 file that serves as an example of the module description: '''myModule.class.php'''
*1 file that serves as an example of code for creating a new class: '''skeleton_class.class.php'''
*1 file that serves as an example of code for creating a new page: '''skeleton_page.php'''
*1 file that serves as an example of code for creating a script for executing command lines: '''skeleton_script.php'''

...

Use it as an example.
Note that the skeletons are also used by the PHP Code generator ([[Module ModuleBuilder]]), which is described in the development chapter of Dolibarr modules, to speed up your development.

==Dates and Timezones==
Dolibarr is an application that is multi-user and multi-location. It's therefore necessary to store dates in the right format. To avoid problems with conversions, the following rules should be applied:

*A date into memory must always be stored with Timestamp GMT format.
*A date stored into database, is the GMT Timestamp of date submitted into the request usng the PHP server timezone. This does not apply to date update automatically by database (fields '''tms''' into database).

For exemple le 1st january 1970, 3 hour at Paris (TZ=+1) = 2 hour at Greenwitch (TZ=0) will be stored into memory with value 7200 and will be submitted into a SQL request to database with the string '19700101030000' (PHP convert into its TZ hour and database will unconvert it using its timezone too that is same than PHP).

All select methods should translate date fields, that are with format TZ of database ('19700101030000'), into a timestamp field by calling the method db->jdate. This is to store into memory a GTM Timestamp date. All insert methods must convert, during generation of SQL request, the memory date into the string by using db->idate (you may find examples into skeleton).

*Dates that are updated automatically (field '''tms''' into database) contains a GMT Timestamp GMT of date when change is done. The select will also use the db->jdate (that use PHP server TZ) to convert read data into a GMT Timestamp into memory. So if timezone of database differs from timezone of PHP server (one of them is not correctly set), you may experience differences between creation date and update date.

*Manipulation date with PHP must be done using the Dolibarr date functions: '''dol_now(), dol_mktime(), dol_stringtotime(), dol_getdate(), dol_time_plus_duree()'''. You may also find other functions available into file '''date.lib.php'''.

==UTF8/ISO encoding==
Dolibarr stores data in the following way:

*In database, data is stored in UTF8 or ISO. It depends on the database's pagecode therefore these options are set at creation time. In any case, Dolibarr's database driver (in lib/database) deals with it to convert from/to UTF8 at insertion and readout.
*Memory data is stored in UTF8 (PHP object instances).
*Web pages are returned and rendered into UTF8

==Float numbers, amount and calculation==
With PHP, like other languages (Java for exemple), non integer data (float, real, double) are not reliable for calculation.
Try to make for example
<syntaxhighlight lang="PHP">
print 239.2 - 229.3 - 9.9;
</syntaxhighlight>
You wont get zero but a very small decimal number. If you get zero her, you should be able to find other examples that don't work.
Problem of float is general, so a variable that is a result of a calculation using decimal numbers must ALWAYS be cleaned using the function '''price2num()''' with the econd parameter to: 'MU', 'MT' or 'MS' depending on need (see description of function).
<syntaxhighlight lang="PHP">
print price2num(239.2 - 229.3 - 9.9, 'MT');
</syntaxhighlight>
If data manipulated is not an amount, then using MU, MT, MS has no sense, and you must use the function '''round()'''.

==Creation of tables==
Do not create tables, on the fly, during execution by a standard user, we mean, during current usage of software.
If you create a module that uses its own table, not available in the default Dolibarr code, then take a look at tutorial [[Module development]]. It explains how to provide new tables with your module, so that, the tables will be created during module activation and not during module usage.

==Comparing version==
If your code need to make different things depending on Dolibarr version, you can use the following tip to detect and compare versions
<syntaxhighlight lang="PHP">
$version=preg_split('/[\.-]/',DOL_VERSION);
if (versioncompare($version,array(5,0,-4)) >= 0) { //mycode for 5.0 only; } // For dolibarr 5.0.* (the -4 means we include also alpha, beta, rc and rcX)
</syntaxhighlight>

But this solution need to include the function versioncompare. An alternative solution to test version is to do:
<syntaxhighlight lang="PHP">
if ((float) DOL_VERSION >= 5.0) { //mycode for 5.0 only; } // For dolibarr 5.0.*
</syntaxhighlight>

==Logs==
Add logs to your code using function
<syntaxhighlight lang="PHP">
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
</syntaxhighlight>

==Working directory==
If you need to create a working directory, into your code, refer to it with
'''DOL_DATA_ROOT.'/mymodule''''

The directory can be created into your code by the following function:
<syntaxhighlight lang="PHP">
$mymoduledir=DOL_DATA_ROOT.'/mymodule';
dol_mkdir($mymoduledir);
</syntaxhighlight>

If you need a directory to store temporary data, this directory must be '''DOL_DATA_ROOT.'/mymodule/temp''''

=Design patterns and Object programming=

==Creation design patterns (GoF)==
Design patterns defined by the Gang Of Four (see wikipédia on [[w:Design patterns|Design patterns]]).
No usage of such patterns is required. We found some objects next to Singletons or Factory but not completely compliant with syntax, this is to be compatible with PHP 4 that is not a pure object language.

==Structure design patterns (GoF)==
Design patterns defined by the Gang Of Four (see wikipédia on [[w:Design patterns|Design patterns]]).
No usage of such patterns is required.

==Behavior design patterns (GoF)==
Design patterns defined by the Gang Of Four (see wikipédia on [[w:Design patterns|Design patterns]]).
No usage of such patterns is required.

==Design patterns of enterprise (Martin Fowler)==

===Patterns of code organization===
[[w:Martin Fowler|Martin Fowler]] has identified 3 ways to organize code:

*The '''Transaction Script''' (The source code is linear for each user action).

This is the old school used by all procedural languages.
Inconvenient: Redundancy of code. Need to know the physical model of data to develop.

*The '''Domain Model'''

This notion is available with object languages. It is business process (to identify before) that are used for objects classes.
Inconvenient: Model very complex to maintain.

*The '''Table Module'''

This is a mix between 2 previous where we have only one unique class for each table of database.

-> As shown in code skeletons (see previous chapter), Dolibarr uses concept of '''Table Module'''.

===Communication between business logic - data (ORM)===

There are 3 ways to make links:

*The '''Table And Row Data Gateway'''

This is the most simple. You have one class per table and each class is a link to the table with CRUD methods (Ceate, Read, Update, Delete). A class instance is a record in the table. The class contains only code to reach lines and fields of table.

Example: This mode is used by some ORM Frameworks, like '''iBatis''' (http://ibatis.apache.org/).

*The '''Active Record'''

Same as previous, but we are allowed to add some business functions into the class, if such functions are dedicated to the table or recording into this table.

Example: This mode is used for Dolibarr development and most PHP software that includes their own framework and best practices.

*The '''Data Mapper'''

Classes represent entities of the problem and not the data. So you have to double, triple ... these classes with Mapper classes to access the data.
More "purist" on paper (closer of business), this method also has the disadvantage of being more complex in practice.

Example: This is the choice if you use the ORM Framework '''Propel''' (http://propel.phpdb.org/trac/). We find this model in heavier applications, based on this ORM among others.

-> For Dolibarr development, it is recommended to use the connection mode '''Active Record''', which offers the advantages of a model close to the business without having the complexity, without obfuscating technical architecture. It is by this way that the development, understanding of code and technical maintenance and / or business behaviour seems the more productive (this is however an ongoing debate between the purists and the pragmatists, debate in which nobody can really be right, because it depends on the objectives).
[[Category:Development]]

==Design pattern for Graphic interfaces (MVC)==
There are several design patterns for user interfaces (MVC, MVP, MVVM).
Many confuse this design pattern with that of using a template framework. It's unrelated. A template framework (see previous point) is only linked to the "V" part of these models.

-> Dolibarr uses the '''MVC''' Design Pattern. Part M is materialized by a DAO class containing the CRUD (Create-Read-Update-Delete) methods for accessing the table.
Many frameworks have chosen to put the C code part (Controller) and the V code part (View) in different files, or even separate directories. The maintenance seems easier on paper, in practice, you have to juggle constantly between a ton of files when your project become larger. In Dolibarr, the separation is made by a simple comment section. The part of code C (Controller) is therefore the code that follow the tag
<pre>
/*
* Actions
* /
</pre>
It is followed by the part of code V (Vue), well separated from the C by the tag
<pre>
/*
* View
* /
</pre>

This mode of separation has had a neutral effect on new developments but has made it possible to reduce the time required for maintenance and fixing bugs so significantly that it is not envisaged to switch to another type of separation (yes the findings made in real life are not always those expected by school theory). The important thing remains that there is always a separation between C and V, no matter how this separation is materialized, as long as it is (Reminder: Do not confuse the notion of separation of C and V with the notion of separation of the code to feed the data of a View and of the code to format the View, this a principle of separation relating to the Design Pattern of Vue, see next point).

==Design pattern for Views - Presentation==
There are frameworks that specialize in Vue Design Pattern, the part of formatting the screen seen by the user.
Old versions of Dolibarr used Smarty. This framework is an overlay to an already very powerful screen formatting framework called ... PHP. The benefits being much lower than the disadvantages, it has been abandoned in favor of PHP templates (.tpl.php file) which remain the simplest, the most universal, the most scalable and the most efficient, of the presentation frameworks.

Its only flaw is that it cannot guarantee 100% the deviations of a developer who would integrate into the View, a logic unrelated to the presentation (therefore other than code intended for generation, formatting, HTML output , test or loop logic). This point is however controlled by the validation mechanism of the project managers' code.

Here again, it is the experience and the observation of a better productivity performance that has motivated the abandonment of the external Presentation frameworks in favor of the PHP framework.

List of modules id

2020-11-02T15:08:19Z

Dolichicken: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}}
This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here. Please pick range into existing holes first.

{{Flag fr}}
Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici. Merci de prendre dans les trous existant en priorité !

{{Flag sp}}
Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

=ID 0 - 99999=
{{Flag en}}
Reserved for Dolibarr's internal modules.

{{Flag fr}}
Réservé aux modules internes de Dolibarr.

{{Flag sp}}
Reservado a los módulos internos de Dolibarr.

=ID 100000 - 499999=
{{Flag en}}
Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 50 numbers only the first time, 1000 max per company)

{{Flag fr}}
Zone réservée aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limitée à 50 valeurs la première fois, 1000 maximum par société)

{{Flag sp}}
Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 50 valores por editor)

[[File:Warning.png]] If you reserve more than 50, we may automatically change your reservation range without information and you may experience conflicts with other modules in a future, so please follow the rules !

*ID 100000 - 100999: OpenThink (http://www.openthink.be)
*ID 101000 - 101999: NLTechno (https://www.nltechno.com)
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
*ID 105000 - 105999: GPC.solutions
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Oas services ([http://www.oas-services.fr https://www.oas-services.fr])
*ID 110000 - 110999: Librethic (https://librethic.io)
*ID 111000 - 111999: Asset IT (www.assetit.ch)
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
*ID 113000 - 113999: Asilib - Alexandre Spangaro
*ID 114000 - 114999: Iceleaf OÜ
*ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
*ID 116000 - 116999: Wolftec GmbH
*ID 117000 - 117999: Oscim (http://www.oscim.fr)
*ID 118000 - 118999: Oarces Web (dev.oarces.com)
*ID 119000 - 119999: Manuel Berrocal - Absolacom
*ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
*ID 121000 - 121999: Oscss - Shop
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: backbone internet service (www.backbone.co.at)
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br)
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
*ID 131000 - 131999: Joan Louis (itaca.fr)
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr)
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 135000 - 135999: Net-Logic (http://netlogic.fr)
*ID 140000 - 140999: Altairis (http://altairis.fr)
*ID 141000 - 141050: Projet2Team (https://www.projet2team.fr)
*ID 141051 - 141099: Elistair (http://elistair.com)
*ID 141100 - 141149: Blue Networks Technologies (https://www.blnt.fr)
*ID 141150 - 141199: Florian DUFOURG - France
*ID 142000 - 142049: ITANéA (https://www.itanea.fr)
*ID 142050 - 142099: ERP Consulting NZ ([https://www.erpconsulting.co.nz www.erpconsulting.co.nz])
*ID 150000 - 150999: Jeffinfo
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (http://dolipar.org)
*ID 162000 - 162999: Jacques Rébiscoul
*ID 163000 - 163999: Open-DSI (https://www.open-dsi.fr)
*ID 164000 - 164999: Pixelada S. Coop. And. (https://pixelada.org)
*ID 165000 - 165049: DovConnect
*ID 165050 - 165099: Mind Operated Systems (https://www.mosystems.biz)
*ID 165100 - 165150: SD-Formation (https://sdformation.fr)
*ID 170000 - 170999: TRIDENT CONSULTING LTD (www.tridentdxb.com)
*ID 171000 - 171999: LVSInformatique (www.lvsinformatique.com)
*ID 172000 - 172299: Ray Soft-Systems (https://www.ray-soft-systems.com)
*ID 172300 - 172349: Günter Lukas Consulting (https://gl.co.at)
*ID 172350 - 172399: MB Informatique (https://www.mb-informatique.fr)
*ID 172400 - 172449: Professional Structures Limited (https://pstructures.com)
*ID 172450 - 172699: IT-BS (https://www.it-bs.fr)
*ID 172700 - 172749: Indelog (https://www.indelog.fr)
*ID 172750 - 172799: NS-INFO90 (https://www.ns-info90.fr)
*ID 180000 - 180999: Triangle Ingénierie
*ID 181000 - 181999: TI Sin Problemas (https://www.tisinproblemas.com)
*ID 182000 - 182049: Chipserv Pawel Wlizlo (https://www.testware.it)
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 199000 - 199999: RFMS
*ID 200000 - 200999: Noxiome
*ID 201000 - 201999: Sasa Ostrouska (saxa)
*ID 202000 - 202999: Z-Application
*ID 203000 - 203099: Elidee - elidee.com
*ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
*ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
*ID 205000 - 205999: Kreiz IT
*ID 206000 - 206999: GBINFO (www.gbinfo.fr)
*ID 207000 - 207099: MacroProg (https://www.macroprog.com)
*ID 207100 - 207149: Reactiva Software
*ID 207150 - 207199: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 230000 - 230049: Unareil (https://www.unareil.eu)
*ID 230050 - 230099: Lyra Network (https://www.lyra.com/)
*ID 230100 - 230149: Gheorghe Iftimi - CTW - RO
*ID 230150 - 230199: MEMA Machinery & Tools (https://www.mema.be)
*ID 230200 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230499: Chickenforce/code-chicken, IT Services Hahn (https://github.com/code-chicken [http://itservices-hahn.de/ https://itservices-hahn.de])
*ID 230500 : '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350: '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 399999: (take ranges of 50 only please, 1000 max per company)
*ID 400000 - 400999: 2byte.es (http://www.2byte.es)
*ID 401000 - 401999: B&D Informática
*ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
*ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 409000 - 409999: LliureTIC (www.lliuretic.cat)
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423050: cyberesprit
*ID 423051 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 424000 - 424049: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
*ID 426000 - 426099: Arkesis-Solution
*ID 426100 - 426149: GetLandy (www.getlandy.com)
*ID 426150 - 426649: OOB Software
*ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
*ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
*ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 429000 - 429999: induslab
*ID 430000 - 430099: Mixity sprl (www.mixity.be)
*ID 430100 - 430199: sgiraud
*ID 430200 - 430299: Merlion TI (www.merlion-si.com.br)
*ID 430300 - 431299: Libre Expert (www.libre-expert.com)
*ID 431300 - 431399: ptibogxiv (www.ptibogxiv.net)
*ID 431400 - 431499: Befox (www.befox.fr)
*ID 431500 - 431599: rue Béjo (www.ruebejo.fr)
*ID 431600 - 431699: Avizzeo (www.avizzeo.com)
*ID 431700 - 432199: Multisistemas (www.multisistemas.com.sv)
*ID 432200 - 432399: Burbuja - Chile (www.burbuja.cl)
*ID 432400 - 433399: INOVEA CONSEIL (https://www.inovea-conseil.com)
*ID 433400 - 434399: Rachid HRICH - Maroc (HricH ServiceS.)
*ID 434400 - 435399: Lance Bleakley - LanceIT (www.lanceit.net)
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 438400 - 439399: Tetras Libre - France - Développement logiciels libres (www.tetras-libre.fr)
*ID 439400 - 440399: Dolibarr-pro - France - Développement Dolibarr (www.dolibarr-pro.com)
*ID 440400 - 441399: Quidlab Co., Ltd - Thailand - ( www.quidlab.com )
*ID 441400 - 442399: Ide@log - France - (https://www.idealog-info.net) - Laurent Leblanc
*ID 442400 - 443399: Valerio Bianchi (www.valeriobianchi.com)
*ID 443400 - 444399: delassalle - France - (www.delassalle.fr) - Joseph Delassalle
*ID 444400 - 445399: Webartis - Maroc - (www.webartis.net) - François Dry
*ID 445400 - 445499: SCOP Au-delà des nuages - France
*ID 446000 - 446999: iouston (http://www.iouston.com) - France - Julien Marchand
*ID 447000 - 447999: rSanjoSEO - Rafael San José Tovar (www.rsanjoseo.com) - Spain
*ID 448000 - 448999: Code 42 (www.code42.fr)
*ID 449000 - 449999: TakePOS (www.takepos.com)
*ID 450000 - 450999: Pierre ARDOIN
*ID 451000 - 451999: Éditeur depordi.fr
*ID 452000 - 452999: Dylan NAKONG
*ID 453000 - 453999: Menahd Ouchenir - France - menahd-ouchenir.com
*ID 454000 - 454999: Withheld - Canada
*ID 455000 - 455999: Gaëtan MAISON - Info Libre @ Dom - France (https://www.infolibreadom.com)
*ID 456000 - 456999: Laurent LEBLEU - B.L.C. - Blue Line Company - Lille - France (www.bluelinecompany.fr/dolibarr)
*ID 457000 - 457999: Sébastien BOUCHER
*ID 458000 - 458999: Lester HERNÁNDEZ - Argentina - (freelancerlrhd@gmail.com)
*ID 459000 - 459999: Infopen - France
*ID 460000 - 460050: torvista - Spain
*ID 461000 - 461999: MEGALOGI - Maroc (www.erpcloud.ma)
*ID 462000 - 462999: Making Digital (www.making-digital.fr) - France
*ID 463000 - 463999: linx s.r.l.s.
*ID 464000 - 464999: NimbleCubed Inc. (www.nimblecubed.com)
*ID 465000 - 465999: Artefacts - CourantAlternatif
*ID 466000 - 466999: CDM Consultores - (www.cdm.guru)
*ID 467000 - 467999: M71 Service GmbH - (www.m71-service.de)
*ID 468000 - 468049: Clément Segonzac - France (clement.segonzac@gmail.com)
*ID 468050 - 468099: Flavien Belli - France (https://github.com/Marshlyin || belliflaviencontactpro@gmail.com)
*ID 468100 - 468119: Chl (https://code.bugness.org/Dolibarr)
*ID 468120 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 468175 - 468199: Gaëlle Rauffet - France (kiwiscan.net)
*ID 468200 - 468250: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468251 - 468270: CD-Systems - France (https://www.cd-systems.fr)
*ID 468300 - 468349: Uvensys - Germany (https://uvensys.de)
*ID 468350 - 468399 : Laudeco - Belgium (http://github.com/laudeco)
*ID 468400 - 468449 : Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 468450 - 468499 : Mehdi Belkhayat - Maroc (https://opensi.ma)
*ID 468500 - 468599 : InvIT GmbH - Germany (https://invit.sh)
*ID 468600 - 468649 : Ricardo Sequeira - Portugal (https://ricardo-sequeira.com)

...

=ID > 500000=

This range can't be reserved. It is a common range. If you don't plan to distribute your module, you can use an ID in this range with no need to reserve it.

{{Flag en}}
If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (50 ids at once, 1000 ids maximum per partner).

{{Flag fr}}
Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (par lot de 50 d'abord, pas plus de 1000 numéros par partenaire).

{{Flag sp}}
Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

List of modules id

2020-11-02T11:26:56Z

Dolichicken: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}}
This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here. Please pick range into existing holes first.

{{Flag fr}}
Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici. Merci de prendre dans les trous existant en priorité !

{{Flag sp}}
Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

=ID 0 - 99999=
{{Flag en}}
Reserved for Dolibarr's internal modules.

{{Flag fr}}
Réservé aux modules internes de Dolibarr.

{{Flag sp}}
Reservado a los módulos internos de Dolibarr.

=ID 100000 - 499999=
{{Flag en}}
Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 50 numbers only the first time, 1000 max per company)

{{Flag fr}}
Zone réservée aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limitée à 50 valeurs la première fois, 1000 maximum par société)

{{Flag sp}}
Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 50 valores por editor)

[[File:Warning.png]] If you reserve more than 50, we may automatically change your reservation range without information and you may experience conflicts with other modules in a future, so please follow the rules !

*ID 100000 - 100999: OpenThink (http://www.openthink.be)
*ID 101000 - 101999: NLTechno (https://www.nltechno.com)
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
*ID 105000 - 105999: GPC.solutions
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Oas services ([http://www.oas-services.fr https://www.oas-services.fr])
*ID 110000 - 110999: Librethic (https://librethic.io)
*ID 111000 - 111999: Asset IT (www.assetit.ch)
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
*ID 113000 - 113999: Asilib - Alexandre Spangaro
*ID 114000 - 114999: Iceleaf OÜ
*ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
*ID 116000 - 116999: Wolftec GmbH
*ID 117000 - 117999: Oscim (http://www.oscim.fr)
*ID 118000 - 118999: Oarces Web (dev.oarces.com)
*ID 119000 - 119999: Manuel Berrocal - Absolacom
*ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
*ID 121000 - 121999: Oscss - Shop
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: backbone internet service (www.backbone.co.at)
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br)
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
*ID 131000 - 131999: Joan Louis (itaca.fr)
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr)
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 135000 - 135999: Net-Logic (http://netlogic.fr)
*ID 140000 - 140999: Altairis (http://altairis.fr)
*ID 141000 - 141050: Projet2Team (https://www.projet2team.fr)
*ID 141051 - 141099: Elistair (http://elistair.com)
*ID 141100 - 141149: Blue Networks Technologies (https://www.blnt.fr)
*ID 141150 - 141199: Florian DUFOURG - France
*ID 142000 - 142049: ITANéA (https://www.itanea.fr)
*ID 142050 - 142099: ERP Consulting NZ ([https://www.erpconsulting.co.nz www.erpconsulting.co.nz])
*ID 150000 - 150999: Jeffinfo
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (http://dolipar.org)
*ID 162000 - 162999: Jacques Rébiscoul
*ID 163000 - 163999: Open-DSI (https://www.open-dsi.fr)
*ID 164000 - 164999: Pixelada S. Coop. And. (https://pixelada.org)
*ID 165000 - 165049: DovConnect
*ID 165050 - 165099: Mind Operated Systems (https://www.mosystems.biz)
*ID 165100 - 165150: SD-Formation (https://sdformation.fr)
*ID 170000 - 170999: TRIDENT CONSULTING LTD (www.tridentdxb.com)
*ID 171000 - 171999: LVSInformatique (www.lvsinformatique.com)
*ID 172000 - 172299: Ray Soft-Systems (https://www.ray-soft-systems.com)
*ID 172300 - 172349: Günter Lukas Consulting (https://gl.co.at)
*ID 172350 - 172399: MB Informatique (https://www.mb-informatique.fr)
*ID 172400 - 172449: Professional Structures Limited (https://pstructures.com)
*ID 172450 - 172699: IT-BS (https://www.it-bs.fr)
*ID 172700 - 172749: Indelog (https://www.indelog.fr)
*ID 172750 - 172799: NS-INFO90 (https://www.ns-info90.fr)
*ID 180000 - 180999: Triangle Ingénierie
*ID 181000 - 181999: TI Sin Problemas (https://www.tisinproblemas.com)
*ID 182000 - 182049: Chipserv Pawel Wlizlo (https://www.testware.it)
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 199000 - 199999: RFMS
*ID 200000 - 200999: Noxiome
*ID 201000 - 201999: Sasa Ostrouska (saxa)
*ID 202000 - 202999: Z-Application
*ID 203000 - 203099: Elidee - elidee.com
*ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
*ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
*ID 205000 - 205999: Kreiz IT
*ID 206000 - 206999: GBINFO (www.gbinfo.fr)
*ID 207000 - 207099: MacroProg (https://www.macroprog.com)
*ID 207100 - 207149: Reactiva Software
*ID 207150 - 207199: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 230000 - 230049: Unareil (https://www.unareil.eu)
*ID 230050 - 230099: Lyra Network (https://www.lyra.com/)
*ID 230100 - 230149: Gheorghe Iftimi - CTW - RO
*ID 230150 - 230199: MEMA Machinery & Tools (https://www.mema.be)
*ID 230200 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230499: Chickenforce/code-chicken, IT Services Hahn (https://github.com/code-chicken [https://isrh.de https://itservices-hahn.de])
*ID 230500 : '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350: '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 399999: (take ranges of 50 only please, 1000 max per company)
*ID 400000 - 400999: 2byte.es (http://www.2byte.es)
*ID 401000 - 401999: B&D Informática
*ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
*ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 409000 - 409999: LliureTIC (www.lliuretic.cat)
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423050: cyberesprit
*ID 423051 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 424000 - 424049: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
*ID 426000 - 426099: Arkesis-Solution
*ID 426100 - 426149: GetLandy (www.getlandy.com)
*ID 426150 - 426649: OOB Software
*ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
*ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
*ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 429000 - 429999: induslab
*ID 430000 - 430099: Mixity sprl (www.mixity.be)
*ID 430100 - 430199: sgiraud
*ID 430200 - 430299: Merlion TI (www.merlion-si.com.br)
*ID 430300 - 431299: Libre Expert (www.libre-expert.com)
*ID 431300 - 431399: ptibogxiv (www.ptibogxiv.net)
*ID 431400 - 431499: Befox (www.befox.fr)
*ID 431500 - 431599: rue Béjo (www.ruebejo.fr)
*ID 431600 - 431699: Avizzeo (www.avizzeo.com)
*ID 431700 - 432199: Multisistemas (www.multisistemas.com.sv)
*ID 432200 - 432399: Burbuja - Chile (www.burbuja.cl)
*ID 432400 - 433399: INOVEA CONSEIL (https://www.inovea-conseil.com)
*ID 433400 - 434399: Rachid HRICH - Maroc (HricH ServiceS.)
*ID 434400 - 435399: Lance Bleakley - LanceIT (www.lanceit.net)
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 438400 - 439399: Tetras Libre - France - Développement logiciels libres (www.tetras-libre.fr)
*ID 439400 - 440399: Dolibarr-pro - France - Développement Dolibarr (www.dolibarr-pro.com)
*ID 440400 - 441399: Quidlab Co., Ltd - Thailand - ( www.quidlab.com )
*ID 441400 - 442399: Ide@log - France - (https://www.idealog-info.net) - Laurent Leblanc
*ID 442400 - 443399: Valerio Bianchi (www.valeriobianchi.com)
*ID 443400 - 444399: delassalle - France - (www.delassalle.fr) - Joseph Delassalle
*ID 444400 - 445399: Webartis - Maroc - (www.webartis.net) - François Dry
*ID 445400 - 445499: SCOP Au-delà des nuages - France
*ID 446000 - 446999: iouston (http://www.iouston.com) - France - Julien Marchand
*ID 447000 - 447999: rSanjoSEO - Rafael San José Tovar (www.rsanjoseo.com) - Spain
*ID 448000 - 448999: Code 42 (www.code42.fr)
*ID 449000 - 449999: TakePOS (www.takepos.com)
*ID 450000 - 450999: Pierre ARDOIN
*ID 451000 - 451999: Éditeur depordi.fr
*ID 452000 - 452999: Dylan NAKONG
*ID 453000 - 453999: Menahd Ouchenir - France - menahd-ouchenir.com
*ID 454000 - 454999: Withheld - Canada
*ID 455000 - 455999: Gaëtan MAISON - Info Libre @ Dom - France (https://www.infolibreadom.com)
*ID 456000 - 456999: Laurent LEBLEU - B.L.C. - Blue Line Company - Lille - France (www.bluelinecompany.fr/dolibarr)
*ID 457000 - 457999: Sébastien BOUCHER
*ID 458000 - 458999: Lester HERNÁNDEZ - Argentina - (freelancerlrhd@gmail.com)
*ID 459000 - 459999: Infopen - France
*ID 460000 - 460050: torvista - Spain
*ID 461000 - 461999: MEGALOGI - Maroc (www.erpcloud.ma)
*ID 462000 - 462999: Making Digital (www.making-digital.fr) - France
*ID 463000 - 463999: linx s.r.l.s.
*ID 464000 - 464999: NimbleCubed Inc. (www.nimblecubed.com)
*ID 465000 - 465999: Artefacts - CourantAlternatif
*ID 466000 - 466999: CDM Consultores - (www.cdm.guru)
*ID 467000 - 467999: M71 Service GmbH - (www.m71-service.de)
*ID 468000 - 468049: Clément Segonzac - France (clement.segonzac@gmail.com)
*ID 468050 - 468099: Flavien Belli - France (https://github.com/Marshlyin || belliflaviencontactpro@gmail.com)
*ID 468100 - 468119: Chl (https://code.bugness.org/Dolibarr)
*ID 468120 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 468175 - 468199: Gaëlle Rauffet - France (kiwiscan.net)
*ID 468200 - 468250: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468251 - 468270: CD-Systems - France (https://www.cd-systems.fr)
*ID 468300 - 468349: Uvensys - Germany (https://uvensys.de)
*ID 468350 - 468399 : Laudeco - Belgium (http://github.com/laudeco)
*ID 468400 - 468449 : Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 468450 - 468499 : Mehdi Belkhayat - Maroc (https://opensi.ma)
*ID 468500 - 468599 : InvIT GmbH - Germany (https://invit.sh)
*ID 468600 - 468649 : Ricardo Sequeira - Portugal (https://ricardo-sequeira.com)

...

=ID > 500000=

This range can't be reserved. It is a common range. If you don't plan to distribute your module, you can use an ID in this range with no need to reserve it.

{{Flag en}}
If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (50 ids at once, 1000 ids maximum per partner).

{{Flag fr}}
Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (par lot de 50 d'abord, pas plus de 1000 numéros par partenaire).

{{Flag sp}}
Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

List of modules id

2020-10-30T16:44:09Z

Dolichicken: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}}
This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here. Please pick range into existing holes first.

{{Flag fr}}
Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici. Merci de prendre dans les trous existant en priorité !

{{Flag sp}}
Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

=ID 0 - 99999=
{{Flag en}}
Reserved for Dolibarr's internal modules.

{{Flag fr}}
Réservé aux modules internes de Dolibarr.

{{Flag sp}}
Reservado a los módulos internos de Dolibarr.

=ID 100000 - 499999=
{{Flag en}}
Reserved area for editors in need for an ID range. You can edit this page to add your own range (take a range of 50 numbers only the first time, 1000 max per company)

{{Flag fr}}
Zone réservée aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limitée à 50 valeurs la première fois, 1000 maximum par société)

{{Flag sp}}
Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 50 valores por editor)

[[File:Warning.png]] If you reserve more than 50, we may automatically change your reservation range without information and you may experience conflicts with other modules in a future, so please follow the rules !

*ID 100000 - 100999: OpenThink (http://www.openthink.be)
*ID 101000 - 101999: NLTechno (https://www.nltechno.com)
*ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
*ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
*ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
*ID 105000 - 105999: GPC.solutions
*ID 106000 - 106999: PHPASSO
*ID 107000 - 107999: TecLib (http://www.teclib.com) / Auguria (http://www.auguria.net)
*ID 108000 - 108999: ETHICWEB
*ID 109000 - 109999: Oas services ([http://www.oas-services.fr https://www.oas-services.fr])
*ID 110000 - 110999: Librethic (https://librethic.io)
*ID 111000 - 111999: Asset IT (www.assetit.ch)
*ID 112000 - 112999: Aarboard AG (www.aarboard.ch)
*ID 113000 - 113999: Asilib - Alexandre Spangaro
*ID 114000 - 114999: Iceleaf OÜ
*ID 115000 - 115999: 2A2C Conseil - Cyril ZEKSER
*ID 116000 - 116999: Wolftec GmbH
*ID 117000 - 117999: Oscim (http://www.oscim.fr)
*ID 118000 - 118999: Oarces Web (dev.oarces.com)
*ID 119000 - 119999: Manuel Berrocal - Absolacom
*ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
*ID 121000 - 121999: Oscss - Shop
*ID 122000 - 122999: MrSof - la Nation du Web
*ID 123000 - 123999: Bruno Généré (webiseasy.org)
*ID 124000 - 124999: backbone internet service (www.backbone.co.at)
*ID 125000 - 125999: ProgSI (www.progsi.ma)
*ID 126000 - 126999: Catalanet
*ID 127000 - 127999: Virgilio Filho pt-BR Brasil (@dolibarr.br)
*ID 128000 - 128999: Nicolas Frappé France (www.sospc.info)
*ID 129000 - 129999: Adeo-Informatique
*ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
*ID 131000 - 131999: Joan Louis (itaca.fr)
*ID 132000 - 132999: Jean-Marie Arsac (https://azimut.fr)
*ID 133000 - 133999: Oriel Systems Ltd, UK. (www.orielsystems.com)
*ID 135000 - 135999: Net-Logic (http://netlogic.fr)
*ID 140000 - 140999: Altairis (http://altairis.fr)
*ID 141000 - 141050: Projet2Team (https://www.projet2team.fr)
*ID 141051 - 141099: Elistair (http://elistair.com)
*ID 141100 - 141149: Blue Networks Technologies (https://www.blnt.fr)
*ID 141150 - 141199: Florian DUFOURG - France
*ID 142000 - 142049: ITANéA (https://www.itanea.fr)
*ID 142050 - 142099: ERP Consulting NZ ([https://www.erpconsulting.co.nz www.erpconsulting.co.nz])
*ID 150000 - 150999: Jeffinfo
*ID 160000 - 160999: Charles-François BENKE (http://www.patas-monkey.com)
*ID 161000 - 161999: Abbes Bahfir (http://dolipar.org)
*ID 162000 - 162999: Jacques Rébiscoul
*ID 163000 - 163999: Open-DSI (https://www.open-dsi.fr)
*ID 164000 - 164999: Pixelada S. Coop. And. (https://pixelada.org)
*ID 165000 - 165049: DovConnect
*ID 165050 - 165099: Mind Operated Systems (https://www.mosystems.biz)
*ID 165100 - 165150: SD-Formation (https://sdformation.fr)
*ID 170000 - 170999: TRIDENT CONSULTING LTD (www.tridentdxb.com)
*ID 171000 - 171999: LVSInformatique (www.lvsinformatique.com)
*ID 172000 - 172299: Ray Soft-Systems (https://www.ray-soft-systems.com)
*ID 172300 - 172349: Günter Lukas Consulting (https://gl.co.at)
*ID 172350 - 172399: MB Informatique (https://www.mb-informatique.fr)
*ID 172400 - 172449: Professional Structures Limited (https://pstructures.com)
*ID 172450 - 172699: IT-BS (https://www.it-bs.fr)
*ID 172700 - 172749: Indelog (https://www.indelog.fr)
*ID 172750 - 172799: NS-INFO90 (https://www.ns-info90.fr)
*ID 180000 - 180999: Triangle Ingénierie
*ID 181000 - 181999: TI Sin Problemas (https://www.tisinproblemas.com)
*ID 182000 - 182049: Chipserv Pawel Wlizlo (https://www.testware.it)
*ID 183000 - 183999: BB2A Anthony Berton (https://www.bb2a.fr)
*ID 190000 - 190999: Diciannove (http://19.coop)
*ID 191000 - 191999: Elonet (https://elonet.fr)
*ID 199000 - 199999: RFMS
*ID 200000 - 200999: Noxiome
*ID 201000 - 201999: Sasa Ostrouska (saxa)
*ID 202000 - 202999: Z-Application
*ID 203000 - 203099: Elidee - elidee.com
*ID 203100 - 203999: Garcia MICHEL (soamichel.fr)
*ID 204000 - 204999: Ari Elbaz elarifr - accedinfo.com
*ID 205000 - 205999: Kreiz IT
*ID 206000 - 206999: GBINFO (www.gbinfo.fr)
*ID 207000 - 207099: MacroProg (https://www.macroprog.com)
*ID 207100 - 207149: Reactiva Software
*ID 207150 - 207199: Ndejje University Water Research and Development Centre ([https://github.com/NDUWRDC/LIMS/])
*ID 207200 - 207299: Massaoud Bouzenad ([https://www.dzprod.net dzprod.net])
*ID 207300 - 207349: Ksar
*ID 207350 - 207399: Easylinux (www.easylinux.fr)
*ID 222000 - 222999: dolibit (https://www.dolibit.de)
*ID 230000 - 230049: Unareil (https://www.unareil.eu)
*ID 230050 - 230099: Lyra Network (https://www.lyra.com/)
*ID 230100 - 230149: Gheorghe Iftimi - CTW - RO
*ID 230150 - 230199: MEMA Machinery & Tools (https://www.mema.be)
*ID 230200 - 230249: Teleassist
*ID 230250 - 230299: Nh Developer
*ID 230300 - 230349: Chickenforce aka code-chicken (https://github.com/code-chicken)
*ID 230350 : '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 274250 - 274299: Nerv Project (www.nerv-project.eu)
*ID 274300 - 274349: Knowhere Consulting S.L. (https://www.knowhere-consulting.eu)
*ID 274350: '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 320000 - 320999: Novus Studios (www.novusstudios.it)
*ID 321000 - 321999: AtooNet (http://www.atoo-net.com)
*ID 332000 - 332099: Gecka (https://gecka.nc)
*ID 332100 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 330000 - 330049: XTEC Industries (www.xtec-ind.com)
*ID 330050 - 330099: 10100 S.R.L. - (www.10100.to)
*ID 330100 - 330149: AES Dana SRL (https://aes-dana.be)
*ID 330150 - 330199: Freshcore (https://www.freshcore.fr)
*ID 330200 - 399999: (take ranges of 50 only please, 1000 max per company)
*ID 400000 - 400999: 2byte.es (http://www.2byte.es)
*ID 401000 - 401999: B&D Informática
*ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
*ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
*ID 404000 - 404999: Aikhan
*ID 405000 - 405999: AIME (http://www.aime.mx)
*ID 409000 - 409999: LliureTIC (www.lliuretic.cat)
*ID 420000 - 420099: BBS Concept
*ID 420100 - 420199: LeMousticProduction (www.lemousticproduction.info) -< module DoliRH
*ID 420200 - 421199: VatCheck (www.abnc.be)
*ID 422200 - 422999: Artaban (http://artaban.fr)
*ID 423000 - 423050: cyberesprit
*ID 423051 - 423099: R.Bossard
*ID 423100 - 423199: Joliciel (www.joliciel.fr)
*ID 424000 - 424049: A3sys - Mon-Dolibarr (http://www.mon-dolibarr.fr) by Philazerty
*ID 424050 - 424099: Pragma-tech (www.pragma-tech.fr)
*ID 424100 - 424149: Ohoo Solutions (http://www.ohoosolutions.com)
*ID 424150 - 424199: DAGARCAM Informática (https://www.dagarcam.com/)
*ID 424200 '''Free (take ranges of 50 only please, 1000 max per company)'''
*ID 425000 - 425999: Sébastien SERRE Thivinfo (www.thivinfo.com)
*ID 426000 - 426099: Arkesis-Solution
*ID 426100 - 426149: GetLandy (www.getlandy.com)
*ID 426150 - 426649: OOB Software
*ID 426650 - 426849: Soft-Task Serviços e Sistemas (www.soft-task.com.br)
*ID 426850 - 427000: Bruno Caldas (https://github.com/BCaldas)
*ID 427001 - 427999: Kevin GUERRIER (alias xcl.saian)
*ID 428000 - 428099: af83
*ID 429000 - 429999: induslab
*ID 430000 - 430099: Mixity sprl (www.mixity.be)
*ID 430100 - 430199: sgiraud
*ID 430200 - 430299: Merlion TI (www.merlion-si.com.br)
*ID 430300 - 431299: Libre Expert (www.libre-expert.com)
*ID 431300 - 431399: ptibogxiv (www.ptibogxiv.net)
*ID 431400 - 431499: Befox (www.befox.fr)
*ID 431500 - 431599: rue Béjo (www.ruebejo.fr)
*ID 431600 - 431699: Avizzeo (www.avizzeo.com)
*ID 431700 - 432199: Multisistemas (www.multisistemas.com.sv)
*ID 432200 - 432399: Burbuja - Chile (www.burbuja.cl)
*ID 432400 - 433399: INOVEA CONSEIL (https://www.inovea-conseil.com)
*ID 433400 - 434399: Rachid HRICH - Maroc (HricH ServiceS.)
*ID 434400 - 435399: Lance Bleakley - LanceIT (www.lanceit.net)
*ID 436000 - 436099: SOWEBIO (www.soweb.io)
*ID 436100 - 436199: CAP-REL (www.cap-rel.fr)
*ID 436200 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 436400 - 437399: Mohamed AHERDANE - Morocco - IT Consultant ( www.wave.ma )
*ID 437400 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 438400 - 439399: Tetras Libre - France - Développement logiciels libres (www.tetras-libre.fr)
*ID 439400 - 440399: Dolibarr-pro - France - Développement Dolibarr (www.dolibarr-pro.com)
*ID 440400 - 441399: Quidlab Co., Ltd - Thailand - ( www.quidlab.com )
*ID 441400 - 442399: Ide@log - France - (https://www.idealog-info.net) - Laurent Leblanc
*ID 442400 - 443399: Valerio Bianchi (www.valeriobianchi.com)
*ID 443400 - 444399: delassalle - France - (www.delassalle.fr) - Joseph Delassalle
*ID 444400 - 445399: Webartis - Maroc - (www.webartis.net) - François Dry
*ID 445400 - 445499: SCOP Au-delà des nuages - France
*ID 446000 - 446999: iouston (http://www.iouston.com) - France - Julien Marchand
*ID 447000 - 447999: rSanjoSEO - Rafael San José Tovar (www.rsanjoseo.com) - Spain
*ID 448000 - 448999: Code 42 (www.code42.fr)
*ID 449000 - 449999: TakePOS (www.takepos.com)
*ID 450000 - 450999: Pierre ARDOIN
*ID 451000 - 451999: Éditeur depordi.fr
*ID 452000 - 452999: Dylan NAKONG
*ID 453000 - 453999: Menahd Ouchenir - France - menahd-ouchenir.com
*ID 454000 - 454999: Withheld - Canada
*ID 455000 - 455999: Gaëtan MAISON - Info Libre @ Dom - France (https://www.infolibreadom.com)
*ID 456000 - 456999: Laurent LEBLEU - B.L.C. - Blue Line Company - Lille - France (www.bluelinecompany.fr/dolibarr)
*ID 457000 - 457999: Sébastien BOUCHER
*ID 458000 - 458999: Lester HERNÁNDEZ - Argentina - (freelancerlrhd@gmail.com)
*ID 459000 - 459999: Infopen - France
*ID 460000 - 460050: torvista - Spain
*ID 461000 - 461999: MEGALOGI - Maroc (www.erpcloud.ma)
*ID 462000 - 462999: Making Digital (www.making-digital.fr) - France
*ID 463000 - 463999: linx s.r.l.s.
*ID 464000 - 464999: NimbleCubed Inc. (www.nimblecubed.com)
*ID 465000 - 465999: Artefacts - CourantAlternatif
*ID 466000 - 466999: CDM Consultores - (www.cdm.guru)
*ID 467000 - 467999: M71 Service GmbH - (www.m71-service.de)
*ID 468000 - 468049: Clément Segonzac - France (clement.segonzac@gmail.com)
*ID 468050 - 468099: Flavien Belli - France (https://github.com/Marshlyin || belliflaviencontactpro@gmail.com)
*ID 468100 - 468119: Chl (https://code.bugness.org/Dolibarr)
*ID 468120 '''Free (take ranges of 50 only please at once, 1000 max per company)'''
*ID 468175 - 468199: Gaëlle Rauffet - France (kiwiscan.net)
*ID 468200 - 468250: Paulo Oliveira - Brasil (paulorcdo@gmail.com)
*ID 468251 - 468270: CD-Systems - France (https://www.cd-systems.fr)
*ID 468300 - 468349: Uvensys - Germany (https://uvensys.de)
*ID 468350 - 468399 : Laudeco - Belgium (http://github.com/laudeco)
*ID 468400 - 468449 : Alexis LAURIER - France (https://www.alexislaurier.fr)
*ID 468450 - 468499 : Mehdi Belkhayat - Maroc (https://opensi.ma)
*ID 468500 - 468599 : InvIT GmbH - Germany (https://invit.sh)
*ID 468600 - 468649 : Ricardo Sequeira - Portugal (https://ricardo-sequeira.com)

...

=ID > 500000=

This range can't be reserved. It is a common range. If you don't plan to distribute your module, you can use an ID in this range with no need to reserve it.

{{Flag en}}
If you don't already have reserved ids and need some, please don't use hazardous number and use a number higher than 500000, but it is better to ask a wiki account, and reserve your own range by editing the 100000 - 499999 range (50 ids at once, 1000 ids maximum per partner).

{{Flag fr}}
Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres au hasard et utilisez une valeur supérieure à 500000, toutefois, il est préférable d'obtenir un compte wiki, et réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (par lot de 50 d'abord, pas plus de 1000 numéros par partenaire).

{{Flag sp}}
Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

Setup Other

2020-01-15T08:06:27Z

Dolichicken: The correct spelling is customs, not "Custom"

[[fr:Paramétrage_Divers]]
[[es:Configuración_Varios]]
[[de:Erweiterte_Einstellungen]]
[[zh:其他设置]]


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

'''Help About Screen''': Other setup

'''Menu Path''': Home ► Setup ► Other

=Introduction=
Some options are not visible in the interface (often because they are deprecated or are beta features). In most cases you do not need these functions and their use may make the application unstable.

{{warning|32px}} This page contains the list of some advanced hidden parameters. In most cases, it is parameters for internal usage, development, external modules, features in development not stable or that may lead to security risk. For standard usage of Dolibarr, such parameters '''SHOULD NOT''' be used. All hidden options are NOT supported. They may be removed in a future, modified at any version and break stability of your application.

To enable/override a parameter you have to define the constant name and set it to 1 (unless otherwise stated) in <code>Home ► Setup ► Other Setup</code>

Here is a "todo list" showing wich options are not yet documented (for V11 on 01/12/2019) : [[Setup Other todolist]]

=List of Known Hidden Options=

After Global Options, the list is sorted alphabetically. The basic format of how the list is written is broken down in the example below:

HIDDEN_CONFIG ► ''Description of config'' ► ''(specific version information) or values''

==Global Options==

*ADD_UNSPLASH_LOGIN_BACKGROUND ► The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image). ► (v10.0)

*MAIN_APPLICATION_TITLE ► This will change the title of software (that appears on the login page by default). Warning, changing this may make Dolibarr version detection fail by smartphone applications like [[Application Android - DoliDroid]]

*MAIN_AUTOFILL_DATE ► If this constant is defined (to something other than 0), the date of invoice, proposal, order or payment are auto-filled with the current date. It is highly recommended to NOT ENABLE this feature. This can create a lot of input errors with data not validated by users. This leads to incorrect values saved in the database causing confusion when you have to do your accountancy reports! However some users want it, so we provide it.

*MAIN_AUTO_TIMESTAMP_IN_PUBLIC_NOTES ► Add a timestamp and user automatically when editing the ''public'' note.

*MAIN_AUTO_TIMESTAMP_IN_PRIVATE_NOTES ► Add a timestamp and user automatically when editing the ''private'' note.
*MAIN_COUNTRIES_IN_EEC ► Country list in European Area (For VAT purpose) (v10.0+)

*MAIN_DEFAULT_PAYMENT_TERM_ID ► With ID of a payment term, will use this as default payment term each time you create a new proposal, order, invoice (customer and supplier)

*MAIN_DEFAULT_LANGUAGE_FILTER ► Useful if you do not want to show en_US language option in combo boxes (other languages can easily be removed in langs directory but not en_US) ► (v10.0)

*MAIN_LANGUAGES_ALLOWED ► is a list of languages without spaces, example : fr_FR,en_US,de_DE,it_IT if defined, only those languages will appear in combos. ► (v11.0)

*MAIN_DISABLE_NOTES_TAB ►Show or hide notes tab in the card page

*MAIN_DISABLE_CONTACTS_TAB ► Show or hide contacts tab in the card page

*MAIN_DISABLE_FULL_SCANLIST ► Disables the complete scan of tables to allow the pagination to show total number of pages. May be useful to activate on systems with a very high quantity of data (tables with more than 2 000 000 records).

*MAIN_DISABLE_JQUERY_JNOTIFY ► Disable usage of <code>JNotify</code> to show confirm or error messages

*MAIN_DISABLE_AJAX_COMBOX ► If you have a large number of third parties or products, you can disable the autocomplete feature on the third parties list by setting this constant to 1 ► (v3.6.0+)

*MAIN_DISABLE_MULTIPLE_FILEUPLOAD ► Disable users to upload multiple files at once.
*MAIN_DISABLE_TRUNC ► Disable all truncings in select list. (v7.0 and more)

*MAIN_DISABLEDRAFTSTATUS ► Disable the status Draft for some objects (project, donation, ...)

*MAIN_DOC_USE_OBJECT_THIRDPARTY_NAME ► Add name of thirdparty at begin of generated document.

*MAIN_DOC_USE_TIMING ► Add a timestamp at end of generated document. Value must be format of timestamp. For example: <code>%Y%m%d%H%M</code> (only for ODT files)

*MAIN_DOC_UPLOAD_NOT_RENAME_BY_DEFAULT ► Disable the auto renaming on upload file ► (v10.0)

*MAIN_DOL_SCRIPTS_ROOT ► Define directory who contains 'scripts' directory (e.g. <code>/var/www/dolibarr</code>)

*MAIN_ENABLE_LOG_TO_HTML ► If this constant is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.

*MAIN_ENABLE_IMPORT_LINKED_OBJECT_LINES ► Allow to import lines into current document from "linked" compatible documents ► (v8.0+)

*MAIN_FIRST_TO_UPPER ► Dolibarr add uppercase to Third Parties, contacts or members names if not done. Warning, with some languages (whose words with uppercase are not same words, or pagecode does not always have an uppercase, like cyrillic languages), this feature may alter your data.

*MAIN_ALL_TO_UPPER ► Dolibarr puts uppercase for Third Parties, contacts or members names if not done. Warning, with some languages (whose words with uppercase are not same words, or pagecode does not always have an uppercase, like cyrillic languages), this feature may alter your data. ► (v11.0)

*MAIN_FILESYSTEM_ENCODING ► With some PHP versions, PHP is not able to detect the page code for filesystem of the server OS. To solve this, Dolibarr assumes your OS filesystem is UTF-8 if on Linux or OSX system, and ISO-8859-1 if on Windows. If not, for example on a Windows server with a NTFS UTF-8 pagecode, you can set the variable <code>MAIN_FILESYSTEM_ENCODING</code> to "<code>utf-8</code>".

*MAIN_FORCELANGDIR ► Relative path of the directory holding your custom <code>langs</code> folder.

*MAIN_HTML_TITLE ► Can be used to control how the html page title is formatted. If value contains key '<code>noapp</code>', application name will not be output. If value contains '<code>thirdpartynameonly</code>', on tab for thirdparties, only name of thirdparties are output. Value can be list of tags: '<code>noapp;thirdpartynameonly</code>'

*MAIN_HELPCENTER_LINKTOUSE ► Define the URL link to use as the target page for link "I need help" onto logon page

*MAIN_LANDING_PAGE ► Can choose the first page to show after login (the landing page). This option works as a global option (llx_const) and per user option (llx_user_param). ► (v3.9+)

*MAIN_LOGOUT_GOTO_URL ► URL to which the user will be redirected after LOGOUT

*MAIN_MAXTABS_IN_CARD ► Maximum number of tabs visible. Others are grouped into a combo list.

*MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING ► A warning saying setup of modules is not complete is shown if the number of enabled modules is lower or equal than this value (1 if not defined)

*MAIN_MODULES_FOR_EXTERNAL ► Limit available modules for external users. By default value is '<code>facture,commande,contact,propal,projet,contrat,societe,ficheinter,expedition,agenda</code>'

*MAIN_NO_CONCAT_DESCRIPTION ► Allow to use only input custom description in lines (propale, order, invoice) ► (v10.0)

*MAIN_ONLY_LOGIN_ALLOWED ► Only the specified login is allowed to log in Dolibarr (maintenance mode).

*MAIN_OPTIMIZE_SPEED ► Use some speed enhancements. See page [[FAQ Increase Performance]] for more information.

*MAIN_PROPAGATE_CONTACTS_FROM_ORIGIN ► When creating an order, contract, invoice from another object, specific contacts of objects are set as specific contact of the new object when possible. ► (v4.0+)

*MAIN_PUBLIC_NOTE_IN_ADDRESS ► Show public note in address block ► (v4.0+)

*MAIN_REMOVE_INSTALL_WARNING ► Remove all security warnings that appear to administrator users if URL <code>/install</code> is public. You should solve the problem if warning occurs, instead of removing the warning! For this, create a file called <code>install.lock</code> into Dolibarr root directory. This will stop the warning but also make the page <code>/install</code> not possible to use, to protect your installation.

*MAIN_REPEATCONTACTONEACHTAB ► If added and set to 1, this adds contacts on all tabs, not only main tab.

*MAIN_REPLACE_TRANS_xx_XX ► Where <code>xx_XX</code> is language code. If value is <code>string1:newstring1;string2:newstring2</code> then replace <code>string1</code> with <code>newstring1</code> in all translation done for language <code>xx_XX</code>.

*MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND ► Change way of rounding total TTC lines, rounding first of after.

*MAIN_SECURITY_CSRF_WITH_TOKEN ► Activate a second anti-CSRF protection on POST (a POST from another web site can't be done). Note there is already a default protection using test on referrer. This second protection uses TOKEN on forms and is more powerful. ► (v5.0+)

*MAIN_SERVER_TZ ► If you can't set the timezone of your PHP installation, set this constant. Better is to set it to UTC. In future, this constant will be forced to 'UTC' so PHP server timezone will not have effect anymore. Examples: <code>Europe/Paris</code>, <code>auto</code>.

*MAIN_SEARCH_FORM_ON_HOME_AREAS ► Show the search form on home page areas for core modules (Removed after v5 due to global search combo) ► (v6.0+)

*MAIN_SEARCH_DIRECT_OPEN_IF_ONLY_ONE ► If only one result is found, then setting this value to 1 will take you direct to the item (default method). Setting the value to 0 will show the result in the list as a single result ► (v5.0+)

*MAIN_SERVICES_ARE_ECOMMERCE_200238EC ► (< 8)

*MAIN_SHOW_TUNING_INFO ► Add tuning information into javascript console. Better when xdebug is enabled.

*MAIN_SHOW_TECHNICAL_ID ► Show also technical IDs on elements cards or some lists (not supported everywhere).

*MAIN_SHOWDATABASENAMEINHELPPAGESLINK ► Show database name in upper help menu ► (v8.0+)

*MAIN_USE_HOURMIN_IN_DATE_RANGE ► On all entities lines (invoice, order, contract...), it is possible to add hour and minutes with date on fields "date start" and "date end".

*MAIN_USE_JQUERY_JEDITABLE ► Allow to update from screen, directly into database, some properties of elements (invoices, proposals, ...) using Ajax. This make response time faster, but avoid using this feature, because it bypasses some business actions (updates on other data that should be done consistently) and ignores business controls on data you saved. Consequently this feature breaks consistency of data and possibly the stability of the software.

*MAIN_USE_JQUERY_MULTISELECT ► Allow to use Ajax when a choice that require multiselect is used (for the moment only external modules uses select box with multiselect values). Set the value to the jQuery plugin name to use (multiselect, multiple-select, select2…). Setting it to any other value will result in unwanted side-effects and/or bugs.

*MAIN_USE_OLD_SEARCH_FORM ► Display the old search form in left menu.

*MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC ► Allow using product VAT if customer is individual and out of E.E.C. (European Economic Community) ► (v7.0+)

*MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS ► Allow to define a default VAT rate

*MAIN_VIEW_LINE_NUMBER ► Shows a line number against each line in the order/invoice for products/services. On screen only, not on PDF.

*MAIN_VOLUME_DEFAULT_ROUND ► Accuracy of volume (number of decimals)

*MAIN_VOLUME_DEFAULT_UNIT ► Default unit for weight (0=kg, -3=g, ...)

*MAIN_WEIGHT_DEFAULT_ROUND ► Accuracy of weight (number of decimals)

*MAIN_WEIGHT_DEFAULT_UNIT ► Default unit for weight (0=kg, -3=g, ...)
*USER_HIDE_INACTIVE_IN_COMBOBOX ► Disable display inactive users in combobox.
*MAIN_DISABLE_PDF_THUMBS ► Disable thumbs PDF in case of imagick bug
*MAIN_KEEP_REF_CUSTOMER_ON_CLONING ► Keep the Customer Reference on cloned object (Propal/Invoice)
*MAIN_DONT_KEEP_NOTE_ON_CLONING ► Remove the object notes during cloning ► (v11.0)
*MAIN_DOC_SORT_FIELD ► Set the default sorting field on document page (name by default) ► (v11.0)
*MAIN_DOC_SORT_ORDER ► Set the default sorting order (ASC or DESC) on document page (ASC by default) ► (v11.0)

[[#Top|(back to top)]]

==Accountancy Module==

*ACCOUNTANCY_COMBO_FOR_AUX ► Add graphic option for ACCOUNTANCY_COMBO_FOR_AUX ► (v10.0)

[[#Top|(back to top)]]

==Agenda Module==

*AGENDA_MAX_EVENTS_DAY_VIEW ► Define the maximum number of visible entries for each day in agenda. Default value is 3. Value 0 means no limit.

*AGENDA_USE_EVENT_TYPE ► Add a mandatory field "Type" when creating an event (deprecated).

*AGENDA_AUTOSET_END_DATE_WITH_DELTA_HOURS ► To automatically set end date of event to start date + delta on event creation page.
*AGENDA_DISABLE_LOCATION ► Disable location field in action card ► (>=v5.0)

*MAIN_ADD_EVENT_ON_ELEMENT_CARD ► Allow to create an event from a document (proposal, order, invoice)
*AGENDA_ALL_CALENDARS ► Change the default view to calendar for all the Agenda's

[[#Top|(back to top)]]

==Bank Module==

*BANK_CAN_RECONCILIATE_CASHACCOUNT ► Can reconciliate cash accounts ► (v3.8)

*BANK_DISABLE_CHECK_DEPOSIT ► Disable check deposit feature

*BANK_ASK_PAYMENT_BANK_DURING_ORDER ► Ask bank account during creation of an order

*BANK_ASK_PAYMENT_BANK_DURING_PROPOSAL ► Ask bank account during creation of a proposal

[[#Top|(back to top)]]

==BlockedLog==

*BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY ► Make disable of module "blockedlog" not possible for countries code defined into value. Example: 'FR,...'

[[#Top|(back to top)]]

==Contracts==

*CONTRACT_SUPPORT_PRODUCTS ► Products are also suggested into module contract.

[[#Top|(back to top)]]

==Direct Debit Orders==

*WITHDRAWAL_ALLOW_ANY_INVOICE_STATUS ► If this option is set, all invoices status (even already paid) may appear on the list of invoices qualified for a direct debit payment. This is the list of invoices with a payment request done, and not linked to a direct debit payment. By default, only "unpayed" invoices are used to avoid to pay twice the same invoice.

==Email and SMS==

*MAIN_MAILFORM_DISABLE_ENTERKEY ► Activate javascript code to disable the enter key in the MAIL form. ► (>= 8.0.1)

*MAIL_PREFIX_FOR_EMAIL_ID ► Prefix for the mails ID. Default value is <code>$_SERVER["SERVER_NAME"]</code> ► (>= 8.0.1)

*MAIN_MAIL_DEBUG ► Write content with header of last mail into file <code>dolibarr_mail.log</code> into directory <code>dolibarr_main_data_root</code>.

*MAIN_SMS_DEBUG ► Write content of SMS sent into file <code>dolibarr_sms.log</code> into directory <code>dolibarr_main_data_root</code>.

*MAIN_MAIL_ALLOW_SENDMAIL_F ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option <code>-f</code>. This option is here to ask Dolibarr to call the function mail of PHP by adding value for the option <code>-f</code>. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for rare setup of sendmail that ask the -f option to be mandatory or for sendmail setup that does not use by default the Return-path of header email to define the sender (with this option, the return-path will be provided also on command line and not lost by sendmail).

*MAIN_MAIL_SENDMAIL_FORCE_BA ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some case, we want to recipient to be provided to sendmail into the email content instead of its command line parameter. For this we must add the -ba parameter to sendmail. This option asks PHP to provide this parameter when sending a mail. Note that another solution is to edit the mail.force_extra_parameters=-ba into <code>php.ini</code> file.

*MAIN_MAIL_NO_FULL_EMAIL ► Recipient email and sender are cleaned to be on form "<email>" instead of "Name <email>". This might solve problem of compatibility with very old mailers.

*MAIN_FIX_FOR_BUGGED_MTA ► Some MTA agent are bugged and add some CR chars each time they saw a LF. Because Dolibarr emails are forged to be already cleaned, if MTA agent do that, you will send an email with two CR chars. This may result in having recipient not able to read your email. To fix this, add this constant to 1. Dolibarr will then create an email that is not RFC compliant but because the MTA agent is bugged, the email will be modified and become correct during sending, solving the problem of bad email received. Add this constant if your recipient experience problems when opening email for example users using webmail of <code>orange.fr</code> or <code>hotmail.com</code>

*MAIN_MAIL_DO_NOT_USE_SIGN ► Do not add user signature at end of suggested pre-defined email

*MAIL_FORCE_DELIVERY_RECEIPT_INVOICE ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Invoice'' module.

*MAIL_FORCE_DELIVERY_RECEIPT_ORDER ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Order'' module.

*MAIL_FORCE_DELIVERY_RECEIPT_PROPAL ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Proposal'' module.

*MAIN_EMAIL_USECCC ► 1 = Show field BCC into email forms, If email = Show BCC prefilled with email.

*MAIN_MAIL_AUTOCOPY_PROPOSAL_TO, MAIN_MAIL_AUTOCOPY_ORDER_TO, MAIN_MAIL_AUTOCOPY_INVOICE_TO ► Email to use as a BCC recipient when sending email for proposal, order or invoice. You can make this value visible by setting MAIN_EMAIL_USECCC (to 1 or to another email, see previous point)

*MAIN_EMAIL_ADD_TRACK_ID ► When value is 1 (this is also default value if option is not set): The record "Message-id" added into smtp header includes a tracking id to define where the email was sent from. When value is 2: you send an email from third party card, the sender email is completed with the email source tracking string "+thiXXX" on email (your email will be sent with the "From" that is myname+thi123@mycompany.com). So when user receiving email will make "Answer", email will be sent to myname@mycompany.com but with the tracking id included (into header or into target email), allowing you to know to which third party or object, the email exchange is related to.

*MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL ► Restrict sending of 1 email message to <code>x</code> recipients for same email message (x for To: + CC: + BCC:). If not defined, value is <code>10</code>. Required to fight against spamming that include 1000 recipients in 1 message. Note that MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL, MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL and MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL are also available.

*MAIN_MAIL_FORCE_CONTENT_TYPE_TO_HTML ► Force to send all email (event with text only content) as HTML formatted email.

*MAIN_MAIL_USE_MULTI_PART ► Forge email content using an alternate text part ► (for 5.0.2+). By default with 6.0+

*MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS ► If images were stored into the medias directory from CKEditor, then images into emails are replaced with "inline content". This may increase seriously risk of being detected as SPAM.

*MAIN_COPY_FILE_IN_EVENT_AUTO ► Add attachement document on event auto generated by sending email from dolibarr. ► (v6.0+)

*MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS ► Enter the public IP address of the server, so it appears in the help on the email setup page.

*MAIN_MAIL_ENABLED_USER_DEST_SELECT ► Show also internal users into list of recipients of email in email sending form ► (v8.0+)

[[#Top|(back to top)]]

==Emailing Module==

*MAILING_PREFIX_FOR_EMAIL_ID ► Set the value that will be used to compose the "Email ID" into email headers. If you set this value to '<code>SERVER_NAME</code>', the virtual host of web server will be used. By default, this is not defined, so a hash key, unique to each instance, is used.

*MAILING_NO_USING_PHPMAIL ► If set, the module emailing can't be used with mail setup of "phpmail". Using a thirdparty SMTP server is required. You can complete warning message by adding an email to contact for setup help with constant MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS.

*MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS ► Contains the email of contact to show into the message visible to a user when he try to use emailing module without SMTP server and if option MAILING_NO_USING_PHPMAIL is set to on.

*MAILING_LIMIT_WARNING_PHPMAIL ► Show a warning message (var contains the '''message to show''', or '''translation key''') on emailing send form if setup is on "phpmail". Note: The application always try to translation the message considering the message is a translation key, before showing the translation or message if translation was not found.

*MAILING_LIMIT_WARNING_NOPHPMAIL ► Show a warning message (var contains the '''message to show''', or '''translation key''') on emailing send form if setup is something else than "phpmail". Note: The application always try to translation the message considering the message is a translation key, before showing the translation or message if translation was not found.
*EMAILING_USE_ADVANCED_SELECTOR ► Enable the advanced selector for recipients.

*MAILING_LIMIT_SENDBYWEB ► Restrict number of emails you can send in same sending session with emailing module from GUI. The value "<code>dolibarr_mailing_limit_sendbyweb</code>" if defined into config file is used in priority for this limit. A negative value means, sending by web is forbidden.

*MAILING_LIMIT_SENDBYCLI ► Restrict number of emails you can send in same sending session with emailing module from CLI script. The value "<code>dolibarr_mailing_limit_sendbycli</code>" if defined into config file is used in priority for this limit.

[[#Top|(back to top)]]

==Expense Report==

*EXPENSEREPORT_ALLOW_OVERLAPPING_PERIODS ► Can enter several expense reports on same or overlapping date periods. ► (v7.0+)

*EXPENSEREPORT_USE_OLD_NUMBERING_RULE ► The module Expense Report use numbering rules that you can setup (like other modules do). If you need to keep the hard-coded numbering rule of expenses report used in v6.0 set this constant to 1 ► (>=v7.0+)

*MAIN_USE_EXPENSE_IK ► This feature allows you to set index kilometers against a mileage index for different types of vehicles. ► (v7.0+)

*MAIN_USE_EXPENSE_RULE ► This feature allows you to set a variety of rules per user/group/all so they can only create reports within their limits. ► (v7.0+)

*OVERRIDE_VAT_FOR_EXPENSE_REPORT ► Setting constant OVERRIDE_VAT_FOR_EXPENSE_REPORT to 1 will allow expense reports to show VAT even if the global VAT setting is off ► (v10.0)

[[#Top|(back to top)]]

==Export Module==

*EXPORT_CSV_SEPARATOR_TO_USE ► String value to use as default separator to delimit fields of exported files (by default Dolibarr uses "<code>,</code>"). Example: EXPORT_CSV_SEPARATOR_TO_USE=<code>;</code>

*EXPORT_CSV_FORCE_CHARSET ► Choose the charset used in the output file built by the CSV exporter. By default it is ISO-8859-1. Example: EXPORT_CSV_FORCE_CHARSET= <code>utf-8</code>

*EXPORTTOOL_CATEGORIES ► Can export categories (several lines) into one column with the "product export profile"

*USE_STRICT_CSV_RULES ► Use strict/real CSV format for export. Do not clean/replace CR+LF with '\n' but quote them using the escaping CSV char (<code>"</code>).
*EXPORTS_SHARE_MODELS ► Share export models between user

[[#Top|(back to top)]]

==Foundation Module==

*MEMBER_URL_REDIRECT_SUBSCRIPTION ► Link called and shown when a member account is autocreated in member module by a guest user.

*MEMBER_EXT_URL_SUBSCRIPTION_INFO ► Link of external page pointed by the "Show here" link added in front of payment cell, into the page to make online subscription.

[[#Top|(back to top)]]

==Interventions Module==

*FICHINTER_CLASSIFY_BILLED► Allow to classify an intervention card as "Billed". This add also trigger <code>FICHINTER_CLASSIFY_BILLED</code> into list of possible automatic event into agenda.

*FICHINTER_DISABLE_DETAILS► Disable entry of details line on intervention. Can validate with no line.

[[#Top|(back to top)]]

==Invoice Module==

*MAIN_DEPOSIT_MULTI_TVA ► In deposits invoice, creates one line per VAT rate from the origin document ► (6.0)

*FACTURE_SHOW_SEND_REMINDER ► Show link "Send reminder by mail", same feature than "Send by mail" ''(obsolete feature)''.

*INVOICE_CAN_ALWAYS_BE_EDITED ► Allow to edit invoices even if payment was started. Note: If the module "BlockedLog" is active (required in some countries for legal reasons), this will not change content of archived logs tracked by this module. By definition there is no way to change or remove archived records. It will just update data in your application and a new record to track your change into the read-only archive log.

*INVOICE_CAN_ALWAYS_BE_REMOVED ► Allow to always delete invoices (even if invoice is not last one). Note: If the module "BlockedLog" is active (required by some countries for legal reason), this will not change content of archived logs tracked by this module. By definition there is no way to change or remove archived records. It will just update data in your application and a new record to track your change into the read-only archive log.

*INVOICE_CAN_NEVER_BE_REMOVED ► Never allow to delete invoices (except draft invoices).

*INVOICE_POSITIVE_CREDIT_NOTE ► All amounts on PDF credit notes are positive.

*FACTURE_CHANGE_THIRDPARTY ► Allow to change the third party in the draft invoices. If a discount was set from the original thirdparty, then discount remain, making data not coherent.

*FACTURE_USE_PROFORMAT ► Enable PROFORMAT invoices type.

*FACTURE_DEPOSITS_ARE_JUST_PAYMENTS ► Treats deposit invoices as a special case. Deposit invoices don't get counted on turnover. They are then applied as a payment, like a discount, on the final invoice. By default, when you include the deposit into draft of final invoice, the amount of final invoice is reduced. With this option, final amount is not reduced but a payment is registered. WARNING: In a lot of european countries, using this option is not allowed.

*FACTURE_SENDBYEMAIL_FOR_ALL_STATUS ► Can send invoice by email to customer even if invoice has status "draft".

*INVOICE_CREDIT_NOTE_STANDALONE ► Start implementation to allow a credit note even without invoice (dangerous) ► (v3.9)

*INVOICE_USE_SITUATION ► Enable the "situation invoice" feature

*INVOICE_USE_SITUATION_CREDIT_NOTE ► Enable the "situation credit note" feature (need <code>INVOICE_USE_SITUATION</code>) ► (v8.0)

*INVOICE_DISABLE_DEPOSIT ► Disable deposit invoices

*INVOICE_DISABLE_REPLACEMENT ► Disable replacement invoices

*INVOICE_DISABLE_CREDIT_NOTE ► Disable credit notes

*MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT ► See PDF option

*MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT_COLUMN ► See PDF options

*WORKFLOW_BILL_ON_SHIPMENT ► Change label of button with suitable label when you need to create invoice on shipments

*INVOICE_ALLOW_EXTERNAL_DOWNLOAD ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. Use the tag __DIRECTDOWNLOAD_URL_INVOICE__ in email template to insert it. ► (v7.0+)

*INVOICE_POINTOFTAX_DATE ► Add Point of Tax Date on invoices for country-specific legality reasons ► (v4.0+)

*FACTURE_ENABLE_NEGATIVE_LINES ► Allows to add negative lines to an invoice ► (v8.0.2+)

*INVOICE_USE_DEFAULT_DOCUMENT ► Allow user to select a default invoice documents models according to invoice type. On invoice create page, the model is dynamically changed on invoice type selection. ► (v9.0+)

*FACTURE_REUSE_NOTES_ON_CREATE_FROM ► Reuse the Public Note and Private note of the previous object (Proposal,...) when creating the bill.
*MAIN_SHOW_FACNUMBER_IN_DISCOUNT_LIST ► Display the reference of credit notes in discount list when creating the bill.

[[#Top|(back to top)]]

==Look or Theme==

*MAIN_FAVICON_URL ► favicon url
*MAIN_OPTIMIZEFORTEXTBROWSER ► Optimize output rendering for usage of a text browser (useful for blind people)

*THEME_ELDY_DISABLE_IMAGE ► Disabled images of top menu for eldy theme. ► (v3.8+)

*MAIN_MENU_HIDE_UNAUTHORIZED ► Hide menu if logged in user is not authorized rather than just grey them

*THEME_TOPMENU_STICKY_POSITION ► Option to fix top menu with eldy theme ► (v7.0+)

*MAIN_EASTER_EGG_COMMITSTRIP ► Show a comic image from the CommitStrip website. Images are refreshed daily. ► (v6.0+)

*MAIN_STATUS_USES_CSS ► (v10.0+) Change status design using new style

*MAIN_USE_NEW_TITLE_BUTTON ► (v10.0+) Use new list buttons design
*MAIN_APPLICATION_DISABLED_STATEBOARD ► Hide the stateboard of the main page
*MAIN_APPLICATION_DISABLED_WORKBOARD ► Hide the workboard of the main page
*MAIN_INCLUDE_GLOBAL_STATS_IN_OPENED_DASHBOARD ► (v11.0+) This conf will auto remove global stats box item if there are already in the new dashboard of opened elements and keep displayed stats on the opened item box (not only on mouse over)
*MAIN_USE_TOP_MENU_BOOKMARK_DROPDOWN ► (v11.0+) actually only for eldy theme, this conf move bookmark to top menu and use new design too
*MAIN_USE_TOP_MENU_SEARCH_DROPDOWN ► (v11.0+) actually only for eldy theme, this conf move search input to top menu and use new design too

*THEME_AGRESSIVENESS_RATIO ► (v11.0+) this conf can be used to increase/decrease agressiveness of colors. Value 0 is medium, value is between -100 (light grey colors) to +100 (very flashy colors)

[[#Top|(back to top)]]

==MultiCurrency==

*MAIN_MULTICURRENCY_ALLOW_SYNCHRONIZATION ► Enable CurrencyLayer API synchronization

[[#Top|(back to top)]]

==Order Module==

*COMMANDE_REQUIRE_SOURCE => Make the input field "Source of order" mandatory.

*COMMANDE_VALID_AFTER_CLOSE_PROPAL => When an order is created on a proposal close, the order is directly defined with status "Validated".

*COMMANDE_CHANGE_THIRDPARTY => Can change customer on orders

*WAREHOUSE_ASK_WAREHOUSE_DURING_ORDER => When an order is created, the warehouse can be defined

*ORDER_ALLOW_EXTERNAL_DOWNLOAD => When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)
*THIRDPARTY_PROPAGATE_EXTRAFIELDS_TO_ORDER => Copy extrafields from thirdparty to order. ► (v11.0+)
*MAIN_USE_PROPAL_REFCLIENT_FOR_ORDER => Copy customer reference from proposal to order. ► (v7.0+)

[[#Top|(back to top)]]

==PDF Options==

*ADD_HTML_FORMATING_INTO_DESC_DOC ► Add more visibility to important informations like reference and serial number in desc. ► (v10.0)

*MAIN_ADD_PDF_BACKGROUND ► Define this constant with short name of a PDF file (example "<code>mypdf.pdf</code>") that must be saved into directory "<code>documents/mycompany</code>". This will add PDF as a background of some of your generated PDF files (proposals,invoices,orders). If you need to concat PDF, see instead [[Module Concat PDF]].

*MAIN_DISABLE_FORCE_SAVEAS ► If your browser always asks to save downloaded files on disk (like PDF), try this this option. File may be displayed directly in your browser.

*MAIN_DISABLE_PDF_AUTOUPDATE ► Disable automatic generation of PDF each time we add/update/delete a product line (we can still build document by clicking on "Generate"). This option may increase interface speed on servers with low CPU.

*MAIN_DISABLE_PDF_COMPRESSION ► Disable PDF compression.

*MAIN_DOCUMENTS_LOGO_HEIGHT ► Can force height of the logo on PDF.

*MAIN_DOCUMENTS_WITH_PICTURE_WIDTH ► Can change size of picture when hidden option <code>MAIN_GENERATE_PROPOSALS_WITH_PICTURE</code> is used. By default value is <code>20</code>.

*MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS ► Adding the company address at the bottom of the page. Disabled by default

*MAIN_GENERATE_PROPOSALS_WITH_PICTURE ► Include the first image of the product into the line of the generated PDF for customer proposals.

*MAIN_GENERATE_INVOICES_WITH_PICTURE ► Include the first image of the product into the line of the generated PDF for customer invoices.

*MAIN_GENERATE_SUPPLIER_PROPOSAL_WITH_PICTURE ► Include the first image of the product into the line of the generated PDF for supplier proposals ► (v5.0.3+)

*MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT ► Disable VAT on generated documents. like for an association. (Works with crabe template)

*MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT_COLUMN ► Hide column with VAT information but only column not total.

*MAIN_INVERT_SENDER_RECIPIENT ► Invert sender and recipient in some PDF.

*MAIN_ODT_AS_PDF ► Activate PDF conversion from ODT document. If value is '<code>jodconverter</code>', java and jodconverter command line tool must be available. If value is '<code>/pathto/jodconverter.jar</code>' then java and the jodconvertar jar must exist. Soffice must also be available. <code>MAIN_DOL_SCRIPTS_ROOT</code> Must also be defined to path where the "scripts" directory is stored (for example <code>/var/www/mydolibarr</code>).

*MAIN_ODT_AS_PDF_DEL_SOURCE ► For ODT generation. If set, then initial behaviour is conserved but ODT file is removed when option to convert it as PDF (see previous) is on. Disabled by default

*MAIN_PDF_FORCE_FONT ► To ignore font defined into language file and force usage of a particular font. For example "<code>DejaVuSans</code>".

*MAIN_PDF_FORCE_FONT_SIZE ► To force size of font (by default 10). For example "<code>12</code>" ► (v11.0)

*MAIN_PDF_FREETEXT_HEIGHT ► Change height of space reserved to output the free text.

*MAIN_PDF_TITLE_BACKGROUND_COLOR ► Can define a background color onto title line. Example: <code>220,220,200</code>

*MAIN_PDF_USE_LARGE_LOGO ► Use the original logo with its higher resolution into the PDF instead of the small thumb. This may lead to very very large PDF !

*MAIN_USE_BACKGROUND_ON_PDF ► Define this constant with short name of an image (example "<code>myimage.jpg</code>") that must be saved into directory "<code>documents/mycompany/logos</code>". This will add this background image into your generated PDF files. Warning: This option make TCPDF library being crazy sometime and content on image disappeared!

*MAIN_USE_COMPANY_NAME_OF_CONTACT ► Use contact name and information rather than company

*MAIN_PDF_ADDALSOTARGETDETAILS ► Add particular details like the telephone number on generated PDFs. Can be useful in cases where a printed order/invoice etc is given to a delivery driver/courier etc.

*MAIN_TVAINTRA_IN_SOURCE_ADDRESS ► Show VAT N° in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING ► Add optional esign field in pdf propal ► (v8.0+)

*MAIN_PROFID1_IN_SOURCE_ADDRESS ► Show Professional ID 1 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*MAIN_PROFID2_IN_SOURCE_ADDRESS ► Show Professional ID 2 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*MAIN_PROFID3_IN_SOURCE_ADDRESS ► Show Professional ID 3 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*MAIN_PROFID4_IN_SOURCE_ADDRESS ► Show Professional ID 4 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*MAIN_PROFID5_IN_SOURCE_ADDRESS ► Show Professional ID 5 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*MAIN_PROFID6_IN_SOURCE_ADDRESS ► Show Professional ID 6 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)

*PDF_SHOW_PROJECT ► Show project onto PDF (supported on supplier order only for the moment)

*PDF_BANK_HIDE_NUMBER_SHOW_ONLY_BICIBAN ► Hide bank number ("code banque/guichet/compte" for France, "sort code/account number" for GB, ...) and keep only BIC/IBAN on PDF.

*PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES ► Modify the use/position of Supplier Ref/Internal Ref with the item Label (name) on PDF documents.

Default (constant not set or Value <code>0</code>): Internal ref followed by supplier ref in brackets."COMPANY-REF-001 (Vendor SKU SUPPLIER-REF-001) - LABEL...".

Value <code>1</code>: Supplier ref only eg."SUPPLIER-REF-001 - LABEL...".

Value <code>2</code>: Supplier ref followed by internal ref in brackets. eg."SUPPLIER-REF-001 (InternalRef COMPANY-REF-001) - LABEL...".

*PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME ► Include alternative/alias name into name on PDF.

*PDF_USE_1A ► PDF files produced by dolibarr respect PDF/A standard ► (v?)

*PDF_SECURITY_ENCRYPTION ► Encrypt PDF produced by dolibarr ► (v?) . See additional parameters :PDF_SECURITY_ENCRYPTION_RIGHTS (block 'modify' or 'copy') - PDF_SECURITY_ENCRYPTION_USERPASS - PDF_SECURITY_ENCRYPTION_OWNERPASS (random if not specified) - PDF_SECURITY_ENCRYPTION_STRENGTH (0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit) - PDF_SECURITY_ENCRYPTION_PUBKEYS Array of recipients containing public-key certificates ('c') and permissions ('p') - For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print')))

[[#Top|(back to top)]]

==Point of Sale (POS)==

*CASHDESK_SHOW_KEYPAD ► Show a mouse key pad into the 'Simple Point of Sale' module.

*POS_ADDON ► Set this value to an existing numbering module rule (for example '<code>mod_facture_terre</code>', '<code>mod_facture_mars</code>', ...) to force the numbering module to use for invoice ref definition when invoice is created by the POS. For example setting value <code>POS_ADDON</code> to '<code>mod_facture_terre</code>' will use the numbering module '<code>terre</code>' for invoice generated from POS, whatever is the numbering rule defined into invoice module setup (you can also use POS_NUMBERING_TERRE_FORCE_PREFIX and POS_NUMBERING_MARS_FORCE_PREFIX variable to change the prefix used).

*TAKEPOS_ENABLE_SUMUP ► Enable the compatibility of TakePOS with the card reader terminal [https://SumUp.fr SumUp]

[[#Top|(back to top)]]

==Products Module==

*CATEGORY_GRAPHSTATS_ON_PRODUCTS ► Show graph of products with categories and totals in Products Area screen

*MAIN_PRODUCT_DISABLE_CUSTOMCOUNTRYCODE ► Avoid customs code and country of origin to be set as product description when added to Propal/Order/Invoice

*PRODUCT_ADD_TYPE_IN_DOCUMENTS ► Add text "Product" or "Service" at beginning of details lines on built PDF documents.

*PRODUCT_DONOTSEARCH_ANYWHERE ► When Ajax search is enabled, search is done on criteria anywhere in label of product. By adding this option, search is done only on start of label. This is really faster when you have a huge number of products.

*MAIN_DIRECT_STATUS_UPDATE ► Allows you to change the status of the product (''for sale/not for sale for purchase/not for purchase'') directly on the product page via a ''on/off'' switch button. This can be convenient for those who need to quickly disable certain statuses of products without having to go through the editing product page individually. Also can be very useful if used as a filter on the product and product search list. This option doesn't generate a MODIFY trigger, so be careful with external modules. ► v4.0+

*MAIN_SEARCH_PRODUCT_BY_FOURN_REF ► (>= 8.0) Allow to search a product by supplier ref in document's add line form.

*MAIN_DISABLE_FREE_LINES ► Disallow using free lines to add line in documents ► (>= 8.0)

*MAIN_SHOW_PRODUCT_ACTIVITY_TRIM ► Show Product and Services turnover before for all four quarters tax over recent years recent years on the product area ► (v5.0+)

*PRODUIT_DESC_IN_LIST ► Show long description of product/service into lists.

*PRODUCT_DISABLE_PROPAGATE_CUSTOMER_PRICES_ON_CHILD_COMPANIES ► Disable propagation of prices per customer from a customer to its child company.

*PRODUCT_DISABLE_SIZE ► Disable size in product card.

*PRODUCT_DISABLE_LENGTH ► Disable length in product card ► v4.0+

*PRODUCT_DISABLE_SURFACE ► Disable surface in product card. ► v4.0+

*PRODUCT_DISABLE_VOLUME ► Disable volume in product card.

*PRODUCT_DISABLE_CUSTOM_INFO ► Disable custom info (custom code and country origin) in product/service card.

*PRODUIT_MULTIPRICES_USE_VAT_PER_LEVEL ► When option to use price per level/segment is on, this allows to also set a dedicated vat for each price level.

*PRODUCT_MAX_LENGTH_COMBO ► Limit the length of the label displayed when adding lines in proposals/invoices/orders

*PRODUCT_MAX_VISIBLE_PHOTO ► Show a maximum number of product photos (as thumbnails) on the product main card. Example, setting this constant to '<code>5</code>' will show the first five product photos found on the product card.

*PRODUIT_PDF_MERGE_PROPAL ► Enable module Propal merge product PDF

*PRODUCT_USE_OLD_PATH_FOR_PHOTO ► Ask dolibarr to check also old path (before 3.7) where photos were stored.

*PRODUCT_USE_UNITS ► Enable units from dictionary in product/service card.

*RESOURCE_ON_PRODUCTS_RESOURCE_ON_SERVICES ►Allow to affect ressources on products/services (v10.0+)

[[#Top|(back to top)]]

==Projects Module==

*PROJECT_DISABLE_UNLINK_FROM_OVERVIEW ► Enable removing the button from a link in the project overview. ► (>= 8.0.1)

*PROJECT_CAN_ALWAYS_LINK_TO_ALL_SUPPLIERS ► Enable linking a project to any supplier even when using the third party link feature. Note: Set to 1 by default from 3.7.

*PROJECT_TIME_ON_ALL_TASKS_MY_PROJECTS ► Can add time spent on tasks, even if i am not assigned to task (however, task must be a project i am a contact).

*PROJECT_SHOW_REF_INTO_LISTS ► Add column with project ref into list (with 3.7 list of supplier invoices only, will be expanded to other lists)

*PROJECT_HIDE_UNSELECTABLES ► Hide into select list, all project that we can't select (closed or draft)

*PROJECT_HIDE_TASKS ► Hide tasks. For user using project only as an analytics key and not using tasks.

*PROJECT_LIST_SHOW_STARTDATE ► Shows start date of projects in project lists.

*PROJECT_LINK_ON_OVERWIEW_DISABLED ► Hide the "link to" form on the overview page ► (4.0)

*PROJECT_CREATE_ON_OVERVIEW_DISABLED ► Hide the "create ..." button on the overview page ► (4.0)

*PROJECT_ALLOW_TO_LINK_FROM_OTHER_COMPANY ► Can link an object to a project of another thirdparty

*PROJECT_ALLOW_COMMENT_ON_TASK ► Add comment feature on project task

[[#Top|(back to top)]]

==Proposals Module==

*PROPAL_CLONE_ON_CREATE_PAGE ► On the create proposal page, ask if we want to create the proposal by cloning an already existing one. You should use instead the "Clone" button available on existing proposals.

*MAIN_PROPAL_CHOOSE_ODT_DOCUMENT ► On setup page, you'll be able to select which ODT document to use when close or cancel proposals.

*MAIN_GENERATE_PROPOSALS_WITH_PICTURE ► Add a picture of the product (the first one found if there are several) into the generated PDF of proposals. Note that using this will reduce the available width for the product description.

*PROPAL_DISABLE_SIGNATURE ► Do no show the box for signature.

*WORKFLOW_PROPAL_CAN_CLASSIFY_BILLED_WITHOUT_INVOICES ► Button "Classified Billed" is visible on proposal even if there is no invoice linked to proposal.

*PRODUIT_PDF_MERGE_PROPAL ► When generating the proposal PDF, all PDFs linked to products linked to proposal are also included into final PDF

*PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)

*MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING ► add optional esign field in pdf propal ► (v8.0+)

[[#Top|(back to top)]]

==Services Module==

*SERVICE_ARE_ECOMMERCE_200238EC ► If this option is enabled, services are processed like eServices according to directive of EU Council Directive 2002/38/EC (http://ec.europa.eu/taxation_customs/taxation/vat/traders/e-commerce/article_1610_en.htm). Default VAT rate are based on buying country instead of selling country for BtoC sells.

[[#Top|(back to top)]]

==Shipments==

*STOCK_WAREHOUSE_NOT_REQUIRED_FOR_SHIPMENTS ► If set, you can add a shipment line, with no stock source defined. ► (>= 8.0.1)

*SHIPMENT_GETS_ALL_ORDER_PRODUCTS ► Add all order lines in shipment, including the one with 0 in quantity

[[#Top|(back to top)]]

==Stocks==

*CASHDESK_FORCE_STOCK_ON_BILL ► Option to force decrease of stock whatever is user setup

*SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED ► Disable stock dispatch when total expected was already received
*STOCK_SUPPORTS_SERVICES ► Stock support services

[[#Top|(back to top)]]

==Suppliers Module==

*FOURN_PRODUCT_AVAILABILITY ► On the Suppliers price page of the products, activate the supplier product availability. ''This is duplicate feature with delivery_delay introduced with 3.8.''

*RELOAD_PAGE_ON_SUPPLIER_CHANGE ► On creation of a supplier order/invoice, reload form with supplier-specific details when supplier is selected from drop-down list.

*SUPPLIER_ORDER_AUTOADD_USER_CONTACT ► Add user approving supplier order as a contact automatically.

*SUPPLIER_ORDER_DEFAULT_PAYMENT_MODE_ID ► Set the default payment method for suppliers (<code>rowid</code> in table <code>llx_c_paiement</code>).

*SUPPLIER_ORDER_USE_DISPATCH_STATUS ► Add a status on each dispatch order line when receiving products from suppliers ► (v4.0+)

*SUPPLIER_ORDER_NO_DIRECT_APPROVE ► No button "Validate and Approve". Always do step "Validate" and "Approve" in 2 steps.

*SUPPLIER_ORDER_WITH_PREDEFINED_PRICES_ONLY ► Restrict selection of products in supplier order to only those with a buying price defined for that supplier. ► (v6.0+)

*SUPPLIER_ORDER_EDIT_BUYINGPRICE_DURING_RECEIPT ► Can modify the buying price used for PMP calculation when making a stock reception on a supplier order. ► (v6.0+)

*SUPPLIER_PROPOSAL_WITH_PREDEFINED_PRICES_ONLY ► Restrict selection of products in supplier proposal to only those with a buying price defined for that supplier. ► (v6.0+)

*DISPLAY_DISCOUNTED_SUPPLIER_PRICE ► Allow to display discounted supplier price when searching product in supplier documents ► (v10.0)

*MAIN_CAN_EDIT_SUPPLIER_ON_SUPPLIER_ORDER ► Allow to change the supplier on a draft supplier order ► (v10.0)

[[#Top|(back to top)]]

==Third Parties Module==

*COMPANY_AQUARIUM_CLEAN_REGEX ► Add a REGEX rule on the third parties names. It applies a regex replacement pattern on generated code if COMPANY_AQUARIUM_CLEAN_REGEX is set. Value must be a regex with parenthesis. The part into parenthesis is kept, the rest removed. For example if COMPANY_AQUARIUM_CLEAN_REGEX = '<code>^..(..)..(.*)</code>' the first char and second char are removed and the char 5 and 6 too ► (>= 8.0.1)

*MAIN_FORCE_DEFAULT_STATE_ID ► <code>rowid (integer)</code> of a state/province as defined in <code>llx_c_departements</code>. On the creation of a third party/contact, the state/province corresponding to this rowid is preselected in the dropdown list. ► (>= 8.0.1)

*SOCIETE_DISABLE_CUSTOMERS ► Remove all menu and features related to customers

*SOCIETE_DISABLE_PROSPECTS ► Remove all menu and features related to prospects

*SOCIETE_DISABLE_STATE ► Do not use field "state/province"

*THIRDPARTY_NOTCUSTOMERPROSPECT_BY_DEFAULT ► Do not set status "Customer/Prospect" to "on" when creating a new third party from menu "New third party".

*THIRDPARTY_NOTSUPPLIER_BY_DEFAULT ► Do not set status "Supplier" to "on" when creating a new third party from menu "New third party".

*SOCIETE_SORT_ON_TYPEENT ► The combo list of "type of third party" is sorted on a field "position" that appears into dictionary instead of alphabetical order.

*THIRDPARTY_DEFAULT_CREATE_CONTACT ► With this setting as 1 the option is set for third parties to be created WITH the child contact ► (v5.0+)

*THIRDPARTY_DEFAULT_USEVAT ► When creating a new third party, the field "Use vat" is set to on or off depending on value of this parameter.

*THIRDPARTY_DEFAULT_USELOCALTAX1 ► When creating a new third party, the field "Use second tax" is set to on or off depending on value of this parameter.

*THIRDPARTY_DEFAULT_USELOCALTAX2 ► When creating a new third party, the field "Use third tax" is set to on or off depending on value of this parameter.

*THIRDPARTY_INCLUDE_PARENT_IN_LINKTO ► Search also for elements on parent third party when using the "link to" object feature.

*THIRDPARTY_INCLUDE_PROJECT_THIRDPARY_IN_LINKTO ► Search also for elements on third party that own the project of the current element when using the "link to" object feature (if project is owned by a different thirdparty than current one).

*SOCIETE_ASK_FOR_SHIPPING_METHOD ► Shipping method can be predefined on customer card and will be used as default on order creation

*THIRDPARTY_LOGO_ALLOW_EXTERNAL_DOWNLOAD ► When a logo is uploaded, a share key is automatically set so the file can be downloaded using the share key.

*MAIN_DISABLE_RESTRICTION_ON_THIRDPARTY_FOR_EXTERNAL ► External users are always restricted on the thirdparty of their contact record. With this option, permission "see all thirdparty" may works also for external user. Not implemented yet...

*THIRDPARTY_CAN_HAVE_CATEGORY_EVEN_IF_NOT_CUSTOMER_PROSPECT_SUPPLIER ► Possible to add Categories to third parties that are not customer, prospect or supplier.
*THIRDPARTY_SUGGEST_ALSO_ADDRESS_CREATION ► Enabled contact creation on third-party create card

[[#Top|(back to top)]]

==VAT Report==

*MAIN_INCLUDE_ZERO_VAT_IN_REPORTS ► Include lines with VAT to 0% (for "auto-liquidation" in EEC) ► (v8.0.3+)

[[#Top|(back to top)]]

==WYSIWYG Editor==

*FCKEDITOR_ENABLE_DETAILS_FULL ► Can cut and paste external images (hosted on external server) into description of proposal, orders or invoices. WARNING: PDF generation is not guaranteed with this. Also if the image is removed or renamed by the image hosting service, your proposal, order or invoice will be broken.

[[#Top|(back to top)]]

==STRIPE Module==

*STRIPE_FORCE_VERSION ► Force the STRIPE version ► (v11+)

[[#Top|(back to top)]]

==For SaaS / Cloud hosting integrators==

The following options are useless for a common usage of Dolibarr. But they are usefull if you plan to host / provide Dolibarr instances as Software As A Service (SAAS) to your customers.

*To avoid bad use of the emailing module, it is recommanded to set the option MAILING_NO_USING_PHPMAIL to 1 (This option is described previously). Also you can complete the message visible by customers when they try to setup the SMTP credentials of their Dolibarr by using the constant MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS (This option is described previously). For example, you can point to a FAQ on your website.

*MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS: Set here the ip of list of ip where your Dolibarr instances are hosted. So when your customer go into the setup area of email, a message will explain him how to setup its SPF record for its email domain. This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.

*MAIN_ALWAYS_CREATE_LOCK_AFTER_LAST_UPGRADE: If set, when you launch upgrades of your customer instances, you are sure that the upgrade process recreate automatically the file install.lock so the administration tools like install.php and repair.php can't be used on your customer instance (until the lock file is deleted).

*MAIN_FILECHECK_LOCAL_SUFFIX and MAIN_FILECHECK_LOCAL_EXT: If you offer a customized or patched version of Dolibarr, when the user will use the tool to check the integrity of files, the default xml file name used for signature checking will be the official file provided by the Dolibarr team, so it does not includes your own changes. To have the suggested signature file being your own file, you can set the constant MAIN_FILECHECK_LOCAL_SUFFIX to a suffix. For example, set this to "'''-mysaassolution'''". So, when the user will use the file integrity tool, the default file to check for signature will be "'''/install/filelist-10.0.2-mysaassolution.xml'''" instead of "'''/install/filelist-10.0.2.xml'''". All you have to do is generate the signature file '''mysaassolution''' using the tool '''build/generate_filelist_xml.php''' and put this file into the install directory of your customer instance. Doing this, your customer, and yourself, will be able to check if a file was modified without being disturbed by false alerts due to your customized files or patches (they will be included in the signature used for check). Also, if you want to zip the customized signature file into "'''/install/filelist-10.0.2-mysaassolution.xml.zip'''", you can set the constant MAIN_FILECHECK_LOCAL_EXT to '.zip'.

*WEBSITE_REPLACE_INFO_ABOUT_USAGE_WITH_WEBSERVER: Put here a text a a translation key of a text to show when the user will use the feature "Deploy" when he want to deploy a website done with Dolibarr CMS. So you can, for example, show him a message that this feature is not part of is subscription and putting a website online may need a complementary subscription.

*CRON_DISABLE_KEY_CHANGE: When you provide an instance to a customer, you probably also add an entry in the cron of this user so Dolibarr batch and scheduler can work correctly. For security purpose, it may have a security key that is inside the command line into the cron entry and this entry must match the value defined into Dolibarr setup (setup of module 'Scheduled Jobs'). Because, a customer of a Saas platform will probably have no access to edit the cron file, it is also import that he has no way to edit the key into the Dolibarr setup, so the key in the cron command line will always match the key in Dolibarr setup, and the Dolibarr batches will executed without security errors. To be sure, the customer does not change the value, you can set this constant to 1 into the table [[Table_llx_const]].

*SYSLOG_DISABLE_LOGHANDLER_SYSLOG: Set this to 1 to disable usage of syslog (having all customer instances logging in the same system file is not a good idea).

First setup

2019-10-09T10:54:16Z

Dolichicken: Typo