[[en:Skins]]
[[es:Temas]]
[[zh:主题]]


{{TemplateDocDev}}

=[[File:wallpaper.png]] Création d'un nouveau thème=

Pour créer un nouveau thème, allez dans le répertoire 'htdocs/theme/' recopier par exemple tout le répertoire 'eldy' ...'dolibarr' ... 'toto' ... vers un nouveau répertoire qui aura le nom de votre thème.

Dans ce répertoire changer le nom du fichier .css pour qu'il ait le même nom que le répertoire.

Modifier le fichier AUTHOR avec les informations vous concernant.

Modifier ensuite le CSS, ainsi que les images contenues dans le répertoire img pour personnaliser votre thème.

Le nom du thème apparaîtra automatiquement dans la liste des thèmes utilisables sous la page ''Configuration - Interface'' qui vous permettra de l'activer par défaut, ou ''Utilisateurs et Groupes - Onglet Interface utilisateur'' pour l'activer pour un utilisateur donné.

=[[File:wallpaper.png]] Test d'un nouveau thème=
Pour tester votre thème sur toutes les pages sans l'activer il suffit le préciser dans la barre d'adresse en ajoutant le paramètre theme.

Exemple : https://www.mondolibarr.com/product/list.php?leftmenu=product&type=0&theme=monnouveautheme

=[[File:workcomputer.png]] Diffusion de votre theme=

Quand vous avez créer un nouveau thème, vous pouvez fabriquer un package pour le distribuer en utilisant le script '''build/makepack-dolibarrtheme.pl'''

Vous obtiendrez un fichier .tgz que vous pourrez soumettre dans l'espace téléchargement de Dolibarr (Rubrique '''contrib''').

Système de Hooks

2019-06-12T12:13:31Z

Dolibarr95: /* Liste des Contexts disponibles dans Dolibarr */

{{TemplateDocDevFr}}

= Introduction =
Les Hooks sont une fonctionnalité pour les développeurs, disponible à partir de Dolibarr 3.2, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier les fichiers du coeur de Dolibarr. Contrairement aux [[triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe ou et à n'importe quel moment dès lors qu'ils ont été prévu dans le core de Dolibarr. Ce sont des points d'insertion dans le programme.
* Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
* Les Hooks sont des fonctions qui s'insèrent dans ou remplacent le code standard. Pour rechercher le code qu'il est possible de surcharger faites une recherche pour "'''executeHooks('''".

= Ajouter un hook pour permettre l'insertion de code =
Pour implémenter un hook dans votre propre module (afin que votre module puisse être "hooké" par d'autres), vous devrez procéder à 2 étapes.

Ces étapes doivent êtres reproduites pour chaque script php de votre module où vous voulez implémenter des hooks.

1- Initialiser l'object HookManager (placez ce bout de code au début de votre script php, juste après ou avant les includes):

<source lang="php">
// Initialize technical object to manage hooks of thirdparties. Note that conf->hooks_modules contains array array
include_once(DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php');
$hookmanager=new HookManager($db);
$hookmanager->initHooks(array('context'));
</source>

$hookmanager->initHooks() accepte 1 paramètre (un array de contextes) et active la prise en charge des hooks pour ce script:

- ''''context'''' est la chaine qui contient le contexte d'exécution. C'est un simple indicateur qui peut être utilisé par les fonctions de hook pour détecter dans quel cas elles sont appelées (plusieurs pages/modules peuvent appeler le même hook à différent endroit, et une fonction de hook peut ne vouloir s'exécuter que pour un contexte donné et pas les autres).

Note: Vous pouvez positionner plusieurs contextes en même temps (par exemple si vous avez besoin d'avoir un context commun à plusieurs pages mais que vous voulez aussi un context propre à une page donnée).

2- Placer ensuite l'appel des hooks la où permettre l'ajout de code:

<source lang="php">
$parameters=array();
$reshook=$hookmanager->executeHooks('hookname',$parameters,$object,$action); // See description below
// Note that $action and $object may have been modified by hook
if (empty($reshook))
{
... // standard code that can be disabled/replaced by hook if return code > 0.
}
</source>

'''$hookmanager->executeHooks()''' accepte 4 paramètres et ajoute un hook (qui est un point d'entrée dans votre script pour des fonctions externes à votre script et module):

- ''''hookname'''' est le nom de la méthode qui sera appelée. Par exemple: 'formObjectOptions'

- '''$parameters''' est un tableau personnalisé pour transmettre plus de données personnalisées au hook (la fonction dans le hook peut traiter ces données). Placez ici ce que vous voulez, ce peut être un fichier, un tableau de chaînes de caractères, n'importe quoi... Par exemple :
<source lang="php">
$parameters=array('file'=>'my/path/to/a/file', 'customnames'=>array('henry','david','john'));
</source>

- '''$object''' est l'objet que vous voulez passer à la fonction du hook, certainement les données du module courant (ex: l'objet facture si on est dans un module de facture, etc..). Ce peut être ce que vous voulez, mais souvenez vous qu'il sera le principal composant utilisé par les fonctions du hook.

- '''$action''' est une chaîne indiquant l'action courante (peut être null ou quelque chose qui ressemble à 'create' ou 'edit').

Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.

Maintenant votre module devrait pouvoir être hooké, vous pouvez suivre la procédure ci-dessous dans '''Implémenter un hook''' pour implémenter une fonction hook qui en prendra avantage (permet aussi de tester que cela fonctionne).

= Implémenter un Hook =
Pour utiliser un Hook (donc ajouter ou surcharger une partie de code), vous devez d'abord avoir défini un descripteur de module (voir [[Développement_module#Créer_un_descripteur_de_Module_(obligatoire)]] pour cela). Ensuite vous devez suivre les étapes suivantes :

1. Ajouter votre module au contexte où le hook doit s'exécuter.
Ce qui veut dire que lorsqu'on se trouve dans le contexte donné, votre code sera appelé.
Pour cela, éditer le descripteur de votre module ('''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''') et renseignez la variable '''$this->module_parts''' comme sur l'exemple :
<source lang="php">
$this->module_parts = array(
'hooks' => array('hookcontext1','hookcontext2') // Set here all hooks context you want to support
);
</source>

Note: il est possible de trouver le contexte d'un module en rajoutant
<source lang="php">
print('Module context: '.$object->context);
</source>
(rajoutez ce bout de code dans le fichier php où réside l'appel des hooks, et supprimez le, une fois la valeur du context relevée).

[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules afin que la modification soit prise en compte car la sauvegarde des couples "modules-hooks" qui doit être gérée est faite en base, laquelle n'est mise à jour qu'au moment de l'activation du module.

2. Pour remplacer une fonction existante par la votre (surcharge)

Créez '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' dans votre module avec un code qui contient la méthode appelée par le hook (le nom de cette méthode se voit au moment de l'appel executeHooks). Voici un exemple:

<source lang="php">
class ActionsYourModuleName
{
/**
* Overloading the doActions function : replacing the parent's function with the one below
*
* @param array() $parameters Hook metadatas (context, etc...)
* @param CommonObject &$object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
* @param string &$action Current action (if set). Generally create or edit or null
* @param HookManager $hookmanager Hook manager propagated to allow calling another hook
* @return int < 0 on error, 0 on success, 1 to replace standard code
*/
function doActions($parameters, &$object, &$action, $hookmanager)
{
$error = 0; // Error counter
$myvalue = 'test'; // A result value

print_r($parameters);
echo "action: " . $action;
print_r($object);

if (in_array('somecontext', explode(':', $parameters['context'])))
{
// do something only for the context 'somecontext'
}

if (! $error)
{
$this->results = array('myreturn' => $myvalue);
$this->resprints = 'A text to show';
return 0; // or return 1 to replace standard code
}
else
{
$this->errors[] = 'Error message';
return -1;
}
}
}
</source>

La méthode sera alors automatiquement appelée au moment de l'appel du code qui contient le executeHooks fournissant à votre code les éléments $parameters, $object et $action.

'''Avec''':
* '''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas)
* '''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard)
* '''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view").
* '''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks.

'''Retours''':
* Le code retour d'un hook doit 0 ou 1 en cas de succès, négatif en cas d'erreur. En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. Si le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur'
* Si la méthode positionne la propriété $this->results avec un tableau, alors le tableau $hookmanager->resArray sera automatiquement enrichi avec le contenu de ce tableau, lequel pourra être réutilisé plus tard.
* Si la méthode positionne la propriété $this->resprints avec une chaîne, alors cette chaîne sera affiché par le gestionnaire de hook (executeHook), tout de suite à la sortie de votre méthode.
* Votre hook peut de plus modifier les valeurs de $object et $action.

= Liste des Hooks disponibles dans Dolibarr =
Trouver les hooks disponibles dans Dolibarr ?
Faites une recherche sur "'''executeHooks('''" dans le code source et vous trouverez facilement toutes les fonctions déjà implémentées.

En voici une liste (non complète):
{{ListOfHooks}}
...

Note: veuillez noter que cette liste peut changer à tout moment dans le futur au fur et à mesure que les hooks et contextes soient implémentés dans Dolibarr, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.

= Liste des Contexts disponibles dans Dolibarr =
Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.
Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.

{| class="wikitable"
|-
! Hook
! Context
|-
| accountancycustomerlist
| htdocs\accountancy\customer\list.php
|-
| accountancyindex
| htdocs\accountancy\index.php
|-
| accountancysupplierlist
| htdocs\accountancy\supplier\list.php
|-
| actioncard
| htdocs\comm\action\card.php
|-
| actiondao
| htdocs\comm\action\class\actioncomm.class.php
|-
| admin
| htdocs\accountancy\admin\accountmodel.php
htdocs\accountancy\admin\categories_list.php
htdocs\accountancy\admin\journals_list.php
htdocs\admin\dict.php
htdocs\admin\website_options.php
|-
| admincompany
| htdocs\admin\company.php
|-
| admindefaultvalues
| htdocs\admin\defaultvalues.php
|-
| adminldap
| htdocs\admin\ldap.php
|-
| adminmodules
| htdocs\admin\modules.php
|-
| admintranslation
| htdocs\admin\translation.php
|-
| agenda
| htdocs\comm\action\index.php
htdocs\comm\action\pertype.php
htdocs\comm\action\peruser.php
|-
| agendaexport
| htdocs\public\agenda\agendaexport.php
|-
| agendalist
| htdocs\comm\action\list.php
|-
| agendaresource
| htdocs\resource\agenda.php
|-
| agendathirdparty
| htdocs\societe\agenda.php
htdocs\product\agenda.php
|-
| assetcard
| htdocs\asset\card.php
|-
| assetdocument
| htdocs\asset\document.php
|-
| assetlist
| htdocs\asset\list.php
|-
| assetnote
| htdocs\asset\note.php
|-
| assettypecard
| htdocs\asset\type.php
|-
| bankaccountlist
| htdocs\compta\bank\list.php
|-
| bankcard
| htdocs\compta\bank\card.php
|-
| banktransactionlist
| htdocs\compta\bank\bankentries_list.php
|-
| banktreso
| htdocs\compta\bank\treso.php
|-
| bomagenda
| htdocs\bom\bom_agenda.php
|-
| bomcard
| htdocs\bom\bom_card.php
|-
| bomdao
| htdocs\bom\class\bom.class.php
|-
| bomdocument
| htdocs\bom\bom_document.php
|-
| bomlinedao
| htdocs\bom\class\bom.class.php
|-
| bomlist
| htdocs\bom\bom_list.php
|-
| bomnote
| htdocs\bom\bom_note.php
|-
| cashcontrol
| htdocs\compta\cashcontrol\cashcontrol_list.php
|-
| cashcontrolcard
| htdocs\compta\cashcontrol\cashcontrol_card.php
|-
| cashdeskloginpage
| htdocs\cashdesk\index.php
|-
| cashdeskTplTicket
| htdocs\cashdesk\validation_ticket.php
|-
| cashfencedao
| htdocs\compta\cashcontrol\class\cashcontrol.class.php
|-
| categorycard
| htdocs\categories\card.php
htdocs\categories\edit.php
htdocs\categories\viewcat.php
|-
| commandefournisseurdispatchdao
| htdocs\fourn\class\fournisseur.commande.dispatch.class.php
|-
| commonobject
| htdocs\core\class\html.form.class.php
|-
| comptafileslist
| htdocs\compta\compta-files.php
|-
| consumptioncontact
| htdocs\contact\consumption.php
|-
| consumptionthirdparty
| htdocs\societe\consumption.php
|-
| contactagenda
| htdocs\contact\agenda.php
|-
| contactcard
| htdocs\contact\card.php
|-
| contactdao
| htdocs\contact\class\contact.class.php
|-
| contactlist
| htdocs\contact\list.php
|-
| contactthirdparty
| htdocs\societe\societecontact.php
|-
| contacttpl
| htdocs\core\tpl\contacts.tpl.php
htdocs\projet\tasks\contact.php
|-
| contractcard
| htdocs\contrat\card.php htdocs\contrat\contact.php
htdocs\contrat\document.php
htdocs\contrat\info.php htdocs\contrat\note.php
|-
| contractlist
| htdocs\contrat\list.php
|-
| contractservicelist
| htdocs\contrat\services_list.php
|-
| cron
| htdocs\cron\class\cronjob.class.php
|-
| cronjoblist
| htdocs\cron\list.php
|-
| defineholidaylist
| htdocs\holiday\define_holiday.php
|-
| deliverycard
| htdocs\livraison\card.php
|-
| doncard
| htdocs\don\card.php
|-
| element_resource
| htdocs\resource\element_resource.php
|-
| emailcollectoractiondao
| htdocs\emailcollector\class\emailcollectoraction.class.php
|-
| emailcollectorcard
| htdocs\admin\emailcollector_card.php
|-
| emailcollectordao
| htdocs\emailcollector\class\emailcollector.class.php
|-
| emailcollectorfilterdao
| htdocs\emailcollector\class\emailcollectorfilter.class.php
|-
| emailcollectorlist
| htdocs\admin\emailcollector_list.php
|-
| emailingdao
| htdocs\comm\mailing\class\mailing.class.php
|-
| emailsenderprofilelist
| htdocs\admin\mails_senderprofile_list.php
|-
| emailtemplates
| htdocs\admin\mails_templates.php
|-
| expeditioncard
| htdocs\expedition\card.php
|-
| expensereportcard
| htdocs\expensereport\card.php
|-
| expensereportlist
| htdocs\expensereport\list.php
|-
| externalbalance
| htdocs\compta\localtax\clients.php
htdocs\compta\localtax\index.php
htdocs\compta\resultat\clientfourn.php
htdocs\compta\resultat\index.php
htdocs\compta\tva\clients.php
htdocs\compta\tva\index.php
htdocs\compta\tva\quadri_detail.php
|-
| fichinterdao
| htdocs\fichinter\class\fichinter.class.php
|-
| fileslib
| htdocs\core\lib\files.lib.php
|-
| formfile
| htdocs\core\class\html.formfile.class.php
|-
| formmail
| htdocs\core\class\html.formmail.class.php
|-
| globaladmin
| htdocs\admin\company.php
htdocs\admin\defaultvalues.php
htdocs\admin\ldap.php
htdocs\admin\modules.php
htdocs\admin\translation.php
|-
| globalcard
| htdocs\adherents\card.php
htdocs\categories\viewcat.php
htdocs\comm\action\card.php
htdocs\asset\type.php
htdocs\bom\bom_agenda.php
htdocs\bom\bom_card.php
htdocs\bom\bom_document.php
htdocs\bom\bom_note.php
htdocs\adherents\type.php
htdocs\adherents\type_ldap.php
htdocs\comm\propal\card.php
htdocs\commande\card.php
htdocs\compta\bank\card.php
htdocs\compta\bank\treso.php
htdocs\compta\bank\various_payment\card.php
htdocs\compta\cashcontrol\cashcontrol_card.php
htdocs\compta\deplacement\card.php
htdocs\compta\facture\card.php
htdocs\compta\facture\fiche-rec.php
htdocs\compta\facture\invoicetemplate_list.php
htdocs\compta\localtax\card.php
htdocs\compta\paiement.php
htdocs\compta\recap-compta.php
htdocs\compta\salaries\card.php
htdocs\compta\tva\card.php
htdocs\contact\agenda.php
htdocs\contact\card.php
htdocs\contrat\card.php
htdocs\contrat\contact.php
htdocs\contrat\document.php
htdocs\contrat\info.php
htdocs\contrat\note.php
htdocs\comm\card.php
htdocs\comm\mailing\card.php
htdocs\don\card.php
htdocs\expedition\card.php
htdocs\expensereport\card.php
htdocs\fichinter\card.php
htdocs\fourn\card.php
htdocs\fourn\commande\card.php
htdocs\fourn\facture\card.php
htdocs\fourn\recap-fourn.php
htdocs\livraison\card.php
htdocs\loan\card.php
htdocs\margin\tabs\thirdpartyMargins.php
htdocs\modulebuilder\template\myobject_agenda.php
htdocs\modulebuilder\template\myobject_card.php
htdocs\modulebuilder\template\myobject_document.php
htdocs\modulebuilder\template\myobject_note.php
htdocs\product\card.php
htdocs\product\fournisseurs.php
htdocs\product\price.php
htdocs\product\stock\card.php
htdocs\product\stock\product.php
htdocs\product\stock\productlot_card.php
htdocs\projet\card.php
htdocs\projet\comment.php
htdocs\projet\contact.php
htdocs\projet\tasks\comment.php
htdocs\projet\tasks\task.php
htdocs\projet\tasks\time.php
htdocs\projet\tasks.php
htdocs\reception\card.php
htdocs\resource\card.php
htdocs\societe\card.php
htdocs\societe\contact.php
htdocs\societe\document.php
htdocs\societe\note.php
htdocs\societe\notify\card.php
htdocs\societe\paymentmodes.php
htdocs\societe\price.php
htdocs\societe\societecontact.php
htdocs\stripe\payment.php
htdocs\supplier_proposal\card.php
htdocs\ticket\card.php
htdocs\user\agenda_extsites.php
htdocs\user\card.php
htdocs\user\clicktodial.php
htdocs\user\document.php
htdocs\user\group\card.php
htdocs\user\group\perms.php
htdocs\user\ldap.php
htdocs\user\note.php
htdocs\user\param_ihm.php
htdocs\user\perms.php
|-
| globallist
| htdocs\compta\compta-files.php
|-
| groupcard
| htdocs\user\group\card.php
|-
| groupdao
| htdocs\user\class\usergroup.class.php
|-
| groupperms
| htdocs\user\group\perms.php
|-
| holidaylist
| htdocs\holiday\list.php
|-
| homesetup
| htdocs\admin\index.php
|-
| idprofurl
| htdocs\societe\class\societe.class.php
|-
| index
| htdocs\index.php
|-
| interventioncard
| htdocs\fichinter\card.php
|-
| interventionlist
| htdocs\fichinter\list.php
|-
| intervnetiondao
| htdocs\fichinter\class\fichinter.class.php
|-
| inventorycard
| htdocs\product\inventory\card.php
|-
| inventorylist
| htdocs\product\inventory\list.php
|-
| invoicecard
| htdocs\compta\facture\card.php
|-
| invoicedao
| htdocs\compta\facture\class\facture.class.php
|-
| invoiceindex
| htdocs\compta\index.php
|-
| invoicelist
| htdocs\compta\facture\list.php
|-
| invoicereccard
| htdocs\compta\facture\fiche-rec.php
htdocs\compta\facture\invoicetemplate_list.php
|-
| invoicesuppliercard
| htdocs\fourn\facture\card.php
|-
| leavemovementlist
| htdocs\holiday\view_log.php
|-
| leftblock
| htdocs\main.inc.php
|-
| loancard
| htdocs\loan\card.php
|-
| localtaxvatcard
| htdocs\compta\localtax\card.php
|-
| login
| htdocs\main.inc.php
|-
| logout
| htdocs\user\logout.php
|-
| mail
| htdocs\core\class\CMailFile.class.php
|-
| mailingcard
| htdocs\comm\mailing\card.php
|-
| mailinglist
| htdocs\comm\mailing\list.php
|-
| main
| htdocs\core\lib\security.lib.php
htdocs\main.inc.php
|-
| mainloginpage
| htdocs\core\lib\security2.lib.php
|-
| membercard
| htdocs\adherents\card.php
|-
| memberlist
| htdocs\adherents\list.php
|-
| membertypecard
| htdocs\adherents\type.php
|
|-
| membertypeldapcard
| htdocs\adherents\type_ldap.php
|-
| movementlist
| htdocs\core\modules\stock\doc\pdf_stdmovement.modules.php
htdocs\product\stock\movement_card.php
htdocs\product\stock\movement_list.php
|-
| myobjectagenda
| htdocs\modulebuilder\template\myobject_agenda.php
|-
| myobjectcard
| htdocs\modulebuilder\template\myobject_card.php
|-
| myobjectdao
| htdocs\comm\mailing\class\mailing.class.php
htdocs\modulebuilder\template\class\myobject.class.php
htdocs\compta\bank\class\paymentvarious.class.php
htdocs\compta\cashcontrol\class\cashcontrol.class.php
htdocs\compta\salaries\class\paymentsalary.class.php
htdocs\emailcollector\class\emailcollector.class.php
|-
| myobjectdocument
| htdocs\modulebuilder\template\myobject_document.php
|-
| myobjectlist
| htdocs\modulebuilder\template\myobject_list.php
|-
| myobjectnote
| htdocs\modulebuilder\template\myobject_note.php
|-
| notification
| htdocs\core\class\notify.class.php
|-
| odtgeneration
| htdocs\core\modules\user\doc\doc_generic_user_odt.modules.php
htdocs\core\modules\usergroup\doc\doc_generic_usergroup_odt.modules.php
htdocs\core\modules\supplier_proposal\doc\doc_generic_supplier_proposal_odt.modules.php
htdocs\core\modules\societe\doc\doc_generic_odt.modules.php
htdocs\core\modules\stock\doc\doc_generic_stock_odt.modules.php
htdocs\core\modules\facture\doc\doc_generic_invoice_odt.modules.php
htdocs\core\modules\product\doc\doc_generic_product_odt.modules.php
htdocs\core\modules\project\doc\doc_generic_project_odt.modules.php
htdocs\core\modules\propale\doc\doc_generic_proposal_odt.modules.php
htdocs\core\modules\reception\doc\doc_generic_reception_odt.modules.php
htdocs\core\modules\commande\doc\doc_generic_order_odt.modules.php
htdocs\core\modules\contract\doc\doc_generic_contract_odt.modules.php
htdocs\core\modules\expedition\doc\doc_generic_shipment_odt.modules.php
|-
| ordercard
| htdocs\commande\card.php
|-
| orderdao
| htdocs\commande\class\commande.class.php
|-
| orderlist
| htdocs\commande\list.php
htdocs\don\list.php
|-
| ordershipmentcard
| htdocs\expedition\shipment.php
|-
| orderstoinvoice
| htdocs\commande\orderstoinvoice.php
|-
| orderstoinvoicesupplier
| htdocs\fourn\commande\orderstoinvoice.php
|-
| ordersuppliercard
| htdocs\fourn\commande\card.php
|-
| ordersupplierdispatch
| htdocs\fourn\commande\dispatch.php
|-
| paiementcard
| htdocs\stripe\payment.php
htdocs\compta\paiement.php
|-
| passwordforgottenpage
| htdocs\user\passwordforgotten.php
|-
| paymentlist
| htdocs\compta\paiement\list.php
|-
| paymentsupplierlist
| htdocs\fourn\facture\paiement.php
|-
| pdfgeneration
| htdocs\core\modules\action\rapport.pdf.php
htdocs\core\modules\bank\doc\pdf_ban.modules.php
htdocs\core\modules\bank\doc\pdf_sepamandate.modules.php
htdocs\core\modules\cheque\doc\pdf_blochet.class.php
htdocs\core\modules\commande\doc\pdf_einstein.modules.php
htdocs\core\modules\commande\doc\pdf_eratosthene.modules.php
htdocs\core\modules\contract\doc\pdf_strato.modules.php
htdocs\core\modules\expedition\doc\pdf_espadon.modules.php
htdocs\core\modules\expedition\doc\pdf_merou.modules.php
htdocs\core\modules\expedition\doc\pdf_rouget.modules.php
htdocs\core\modules\expensereport\doc\pdf_standard.modules.php
htdocs\core\modules\facture\doc\pdf_crabe.modules.php
htdocs\core\modules\facture\doc\pdf_sponge.modules.php
htdocs\core\modules\fichinter\doc\pdf_soleil.modules.php
htdocs\core\modules\livraison\doc\pdf_typhon.modules.php
htdocs\core\modules\product\doc\pdf_standard.modules.php
htdocs\core\modules\project\doc\pdf_baleine.modules.php
htdocs\core\modules\project\doc\pdf_beluga.modules.php
htdocs\core\modules\project\doc\pdf_timespent.modules.php
htdocs\core\modules\propale\doc\pdf_azur.modules.php
htdocs\core\modules\propale\doc\pdf_cyan.modules.php
htdocs\core\modules\rapport\pdf_paiement.class.php
htdocs\core\modules\reception\doc\pdf_squille.modules.php
htdocs\core\modules\stock\doc\pdf_standard.modules.php
htdocs\core\modules\stock\doc\pdf_stdmovement.modules.php
htdocs\core\modules\supplier_invoice\pdf\pdf_canelle.modules.php
htdocs\core\modules\supplier_order\pdf\pdf_cornas.modules.php
htdocs\core\modules\supplier_order\pdf\pdf_muscadet.modules.php
htdocs\core\modules\supplier_payment\doc\pdf_standard.modules.php
htdocs\core\modules\supplier_proposal\doc\pdf_aurore.modules.php
|-
| pricesuppliercard
| htdocs\product\fournisseurs.php
|-
| product_lotlist
| htdocs\product\stock\productlot_list.php
|-
| productcard
| htdocs\product\card.php
|-
| productdao
| htdocs\product\class\product.class.php
|-
| productdocuments
| htdocs\product\document.php
|-
| productindex
| htdocs\product\index.php
|-
| productlotcard
| htdocs\product\stock\productlot_card.php
|-
| productlotdocuments
| htdocs\product\stock\productlot_document.php
|-
| productpricecard
| htdocs\product\price.php
|-
| productservicelist
| htdocs\product\list.php
|-
| productstatscontract
| htdocs\product\stats\contrat.php
|-
| productstatsinvoice
| htdocs\product\stats\facture.php
|-
| productstatsorder
| htdocs\product\stats\commande.php
|-
| productstatspropal
| htdocs\product\stats\propal.php
htdocs\product\stats\supplier_proposal.php
|-
| productstatssupplyinvoice
| htdocs\product\stats\facture_fournisseur.php
|-
| productstatssupplyorder
| htdocs\product\stats\commande_fournisseur.php
|-
| projectcard
| htdocs\projet\card.php
htdocs\projet\comment.php
|-
| projectcontactcard
| htdocs\projet\contact.php
|-
| projectdao
| htdocs\projet\class\project.class.php
|-
| projectlist
| htdocs\projet\list.php
|-
| projectOverview
| htdocs\projet\element.php
|-
| projecttaskcard
| htdocs\projet\tasks\task.php
|-
| projecttaskcommentcard
| htdocs\projet\tasks\comment.php
|-
| projecttaskscard
| htdocs\projet\tasks.php
|-
| projecttasktime
| htdocs\projet\tasks\time.php
|-
| projectthirdparty
| htdocs\societe\project.php
|-
| projectticket
| htdocs\ticket\list.php
|-
| propalcard
| htdocs\comm\propal\card.php
|-
| propallist
| htdocs\comm\propal\list.php
|
|-
| purchasesjournal
| htdocs\accountancy\journal\purchasesjournal.php
|-
| recapcomptacard
| htdocs\compta\recap-compta.php
|-
| receptioncard
| htdocs\reception\card.php
|-
| receptiondao
| htdocs\reception\card.php
htdocs\reception\class\reception.class.php
|-
| receptionlist
| htdocs\reception\list.php
|-
| resource
| htdocs\resource\card.php
|-
| resource_card
| htdocs\resource\card.php
|-
| resourcelist
| htdocs\resource\list.php
|-
| salarycard
| htdocs\compta\salaries\card.php
|-
| salarypayment
| htdocs\compta\salaries\class\paymentsalary.class.php
|-
| searchform
| htdocs\core\ajax\selectsearchbox.php
htdocs\core\search_page.php
htdocs\main.inc.php
|-
| sellsjournal
| htdocs\accountancy\journal\sellsjournal.php
|-
| shipmentlist
| htdocs\expedition\list.php
|-
| stockproductcard
| htdocs\product\stock\product.php
|-
| stockreplenishlist
| htdocs\product\stock\replenish.php
|-
| subscription
| htdocs\adherents\subscription.php
|-
| subscriptionlist
| htdocs\adherents\subscription\list.php
|-
| supplier_proposalcard
| htdocs\supplier_proposal\card.php
|-
| supplier_proposallist
| htdocs\supplier_proposal\list.php
|-
| supplierbalencelist
| htdocs\compta\recap-compta.php
htdocs\fourn\recap-fourn.php
|-
| suppliercard
| htdocs\fourn\card.php
|-
| supplierinvoicelist
| htdocs\fourn\facture\list.php
|-
| supplierorderlist
| htdocs\fourn\commande\list.php
|-
| supplierpricelist
| htdocs\fourn\product\list.php
|-
| surveylist
| htdocs\opensurvey\list.php
|-
| takeposfrontend
| htdocs\takepos\takepos.php
|-
| tasklist
| htdocs\projet\tasks\list.php
|-
| tasktimelist
| htdocs\projet\tasks\time.php
|-
| taxvatcard
| htdocs\compta\tva\card.php
|-
| thirdpartybancard
| htdocs\societe\paymentmodes.php
|-
| thirdpartycard
| htdocs\core\tpl\advtarget.tpl.php
htdocs\societe\card.php
|-
| thirdpartycomm
| htdocs\comm\card.php
|-
| thirdpartycontact
| htdocs\societe\contact.php
|-
| thirdpartycustomerprice
| htdocs\societe\price.php
|-
| thirdpartydao
| htdocs\societe\class\societe.class.php
|-
| thirdpartydocument
| htdocs\societe\document.php
|-
| thirdpartylist
| htdocs\societe\list.php
|-
| thirdpartymargins
| htdocs\margin\tabs\thirdpartyMargins.php
|-
| thirdpartynote
| htdocs\societe\note.php
|-
| thirdpartynotification
| htdocs\societe\notify\card.php
|-
| thirdpartyticket
| htdocs\ticket\list.php
|-
| ticketcard
| htdocs\ticket\card.php
|-
| ticketlist
| htdocs\ticket\list.php
|-
| timesheetperdaycard
| htdocs\projet\activity\perday.php
|-
| timesheetperweekcard
| htdocs\projet\activity\perweek.php
|-
| toprightmenu
| htdocs\main.inc.php
|-
| tripsandexpensescard
| htdocs\compta\deplacement\card.php
|-
| upgrade
| htdocs\install\upgrade2.php
|-
| useragenda
| htdocs\user\agenda_extsites.php
|-
| usercard
| htdocs\user\agenda_extsites.php
htdocs\user\card.php
htdocs\user\clicktodial.php
htdocs\user\document.php
htdocs\user\ldap.php
htdocs\user\note.php
htdocs\user\param_ihm.php
htdocs\user\perms.php
|-
| userdao
| htdocs\user\class\user.class.php
|-
| userdoc
| htdocs\user\document.php
|-
| userhome
| htdocs\user\home.php
|-
| userihm
| htdocs\user\param_ihm.php
|-
| userldap
| htdocs\user\ldap.php
|-
| userlist
| htdocs\user\list.php
|-
| usernote
| htdocs\user\note.php
|-
| userperms
| htdocs\user\perms.php
|-
| variouscard
| htdocs\compta\bank\various_payment\card.php
|-
| variouspayment
| htdocs\compta\bank\class\paymentvarious.class.php
|-
| warehousecard
| htdocs\product\stock\card.php
|-
| website
| htdocs\admin\website.php
|-
| websiteaccountcard
| htdocs\website\websiteaccount_card.php
|-
| websitethirdpartylist
| htdocs\societe\website.php
|}

Note: veuillez noter que cette liste peut changer à tout moment dans le futur au fur et à mesure que les hooks et contextes soient implémentés dans Dolibarr, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.

= Voir aussi =
* [[Triggers]]
* [[Interfaces Dolibarr toward foreign systems]]
* [[Interfaces from foreign systems toward Dolibarr]]

Système de Hooks

2019-06-12T12:04:31Z

Dolibarr95: /* Liste des Contexts disponibles dans Dolibarr */

Système de Hooks

2019-06-12T12:02:36Z

Dolibarr95: /* Liste des Contexts disponibles dans Dolibarr */

{{TemplateDocDevFr}}

= Introduction =
Les Hooks sont une fonctionnalité pour les développeurs, disponible à partir de Dolibarr 3.2, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier les fichiers du coeur de Dolibarr. Contrairement aux [[triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe ou et à n'importe quel moment dès lors qu'ils ont été prévu dans le core de Dolibarr. Ce sont des points d'insertion dans le programme.
* Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
* Les Hooks sont des fonctions qui s'insèrent dans ou remplacent le code standard. Pour rechercher le code qu'il est possible de surcharger faites une recherche pour "'''executeHooks('''".

= Ajouter un hook pour permettre l'insertion de code =
Pour implémenter un hook dans votre propre module (afin que votre module puisse être "hooké" par d'autres), vous devrez procéder à 2 étapes.

Ces étapes doivent êtres reproduites pour chaque script php de votre module où vous voulez implémenter des hooks.

1- Initialiser l'object HookManager (placez ce bout de code au début de votre script php, juste après ou avant les includes):

<source lang="php">
// Initialize technical object to manage hooks of thirdparties. Note that conf->hooks_modules contains array array
include_once(DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php');
$hookmanager=new HookManager($db);
$hookmanager->initHooks(array('context'));
</source>

$hookmanager->initHooks() accepte 1 paramètre (un array de contextes) et active la prise en charge des hooks pour ce script:

- ''''context'''' est la chaine qui contient le contexte d'exécution. C'est un simple indicateur qui peut être utilisé par les fonctions de hook pour détecter dans quel cas elles sont appelées (plusieurs pages/modules peuvent appeler le même hook à différent endroit, et une fonction de hook peut ne vouloir s'exécuter que pour un contexte donné et pas les autres).

Note: Vous pouvez positionner plusieurs contextes en même temps (par exemple si vous avez besoin d'avoir un context commun à plusieurs pages mais que vous voulez aussi un context propre à une page donnée).

2- Placer ensuite l'appel des hooks la où permettre l'ajout de code:

<source lang="php">
$parameters=array();
$reshook=$hookmanager->executeHooks('hookname',$parameters,$object,$action); // See description below
// Note that $action and $object may have been modified by hook
if (empty($reshook))
{
... // standard code that can be disabled/replaced by hook if return code > 0.
}
</source>

'''$hookmanager->executeHooks()''' accepte 4 paramètres et ajoute un hook (qui est un point d'entrée dans votre script pour des fonctions externes à votre script et module):

- ''''hookname'''' est le nom de la méthode qui sera appelée. Par exemple: 'formObjectOptions'

- '''$parameters''' est un tableau personnalisé pour transmettre plus de données personnalisées au hook (la fonction dans le hook peut traiter ces données). Placez ici ce que vous voulez, ce peut être un fichier, un tableau de chaînes de caractères, n'importe quoi... Par exemple :
<source lang="php">
$parameters=array('file'=>'my/path/to/a/file', 'customnames'=>array('henry','david','john'));
</source>

- '''$object''' est l'objet que vous voulez passer à la fonction du hook, certainement les données du module courant (ex: l'objet facture si on est dans un module de facture, etc..). Ce peut être ce que vous voulez, mais souvenez vous qu'il sera le principal composant utilisé par les fonctions du hook.

- '''$action''' est une chaîne indiquant l'action courante (peut être null ou quelque chose qui ressemble à 'create' ou 'edit').

Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.

Maintenant votre module devrait pouvoir être hooké, vous pouvez suivre la procédure ci-dessous dans '''Implémenter un hook''' pour implémenter une fonction hook qui en prendra avantage (permet aussi de tester que cela fonctionne).

= Implémenter un Hook =
Pour utiliser un Hook (donc ajouter ou surcharger une partie de code), vous devez d'abord avoir défini un descripteur de module (voir [[Développement_module#Créer_un_descripteur_de_Module_(obligatoire)]] pour cela). Ensuite vous devez suivre les étapes suivantes :

1. Ajouter votre module au contexte où le hook doit s'exécuter.
Ce qui veut dire que lorsqu'on se trouve dans le contexte donné, votre code sera appelé.
Pour cela, éditer le descripteur de votre module ('''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''') et renseignez la variable '''$this->module_parts''' comme sur l'exemple :
<source lang="php">
$this->module_parts = array(
'hooks' => array('hookcontext1','hookcontext2') // Set here all hooks context you want to support
);
</source>

Note: il est possible de trouver le contexte d'un module en rajoutant
<source lang="php">
print('Module context: '.$object->context);
</source>
(rajoutez ce bout de code dans le fichier php où réside l'appel des hooks, et supprimez le, une fois la valeur du context relevée).

[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules afin que la modification soit prise en compte car la sauvegarde des couples "modules-hooks" qui doit être gérée est faite en base, laquelle n'est mise à jour qu'au moment de l'activation du module.

2. Pour remplacer une fonction existante par la votre (surcharge)

Créez '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' dans votre module avec un code qui contient la méthode appelée par le hook (le nom de cette méthode se voit au moment de l'appel executeHooks). Voici un exemple:

<source lang="php">
class ActionsYourModuleName
{
/**
* Overloading the doActions function : replacing the parent's function with the one below
*
* @param array() $parameters Hook metadatas (context, etc...)
* @param CommonObject &$object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
* @param string &$action Current action (if set). Generally create or edit or null
* @param HookManager $hookmanager Hook manager propagated to allow calling another hook
* @return int < 0 on error, 0 on success, 1 to replace standard code
*/
function doActions($parameters, &$object, &$action, $hookmanager)
{
$error = 0; // Error counter
$myvalue = 'test'; // A result value

print_r($parameters);
echo "action: " . $action;
print_r($object);

if (in_array('somecontext', explode(':', $parameters['context'])))
{
// do something only for the context 'somecontext'
}

if (! $error)
{
$this->results = array('myreturn' => $myvalue);
$this->resprints = 'A text to show';
return 0; // or return 1 to replace standard code
}
else
{
$this->errors[] = 'Error message';
return -1;
}
}
}
</source>

La méthode sera alors automatiquement appelée au moment de l'appel du code qui contient le executeHooks fournissant à votre code les éléments $parameters, $object et $action.

'''Avec''':
* '''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas)
* '''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard)
* '''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view").
* '''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks.

'''Retours''':
* Le code retour d'un hook doit 0 ou 1 en cas de succès, négatif en cas d'erreur. En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. Si le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur'
* Si la méthode positionne la propriété $this->results avec un tableau, alors le tableau $hookmanager->resArray sera automatiquement enrichi avec le contenu de ce tableau, lequel pourra être réutilisé plus tard.
* Si la méthode positionne la propriété $this->resprints avec une chaîne, alors cette chaîne sera affiché par le gestionnaire de hook (executeHook), tout de suite à la sortie de votre méthode.
* Votre hook peut de plus modifier les valeurs de $object et $action.

= Liste des Hooks disponibles dans Dolibarr =
Trouver les hooks disponibles dans Dolibarr ?
Faites une recherche sur "'''executeHooks('''" dans le code source et vous trouverez facilement toutes les fonctions déjà implémentées.

En voici une liste (non complète):
{{ListOfHooks}}
...

Note: veuillez noter que cette liste peut changer à tout moment dans le futur au fur et à mesure que les hooks et contextes soient implémentés dans Dolibarr, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.

= Liste des Contexts disponibles dans Dolibarr =
Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.
Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.

En voici une liste (non complète):
{{ListOfContexts}}
...

Note: veuillez noter que cette liste peut changer à tout moment dans le futur au fur et à mesure que les hooks et contextes soient implémentés dans Dolibarr, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.

{| class="wikitable"
|-
! Hook
! Context
|-
| accountancycustomerlist
| htdocs\accountancy\customer\list.php
|-
| accountancyindex
| htdocs\accountancy\index.php
|-
| accountancysupplierlist
| htdocs\accountancy\supplier\list.php
|-
| actioncard
| htdocs\comm\action\card.php
|-
| actiondao
| htdocs\comm\action\class\actioncomm.class.php
|-
| admin
| htdocs\accountancy\admin\accountmodel.php
htdocs\accountancy\admin\categories_list.php
htdocs\accountancy\admin\journals_list.php
htdocs\admin\dict.php
htdocs\admin\website_options.php
|-
| admincompany
| htdocs\admin\company.php
|-
| admindefaultvalues
| htdocs\admin\defaultvalues.php
|-
| adminldap
| htdocs\admin\ldap.php
|-
| adminmodules
| htdocs\admin\modules.php
|-
| admintranslation
| htdocs\admin\translation.php
|-
| agenda
| htdocs\comm\action\index.php
htdocs\comm\action\pertype.php
htdocs\comm\action\peruser.php
|-
| agendaexport
| htdocs\public\agenda\agendaexport.php
|-
| agendalist
| htdocs\comm\action\list.php
|-
| agendaresource
| htdocs\resource\agenda.php
|-
| agendathirdparty
| htdocs\societe\agenda.php
htdocs\product\agenda.php
|-
| assetcard
| htdocs\asset\card.php
|-
| assetdocument
| htdocs\asset\document.php
|-
| assetlist
| htdocs\asset\list.php
|-
| assetnote
| htdocs\asset\note.php
|-
| assettypecard
| htdocs\asset\type.php
|-
| bankaccountlist
| htdocs\compta\bank\list.php
|-
| bankcard
| htdocs\compta\bank\card.php
|-
| banktransactionlist
| htdocs\compta\bank\bankentries_list.php
|-
| banktreso
| htdocs\compta\bank\treso.php
|-
| bomagenda
| htdocs\bom\bom_agenda.php
|-
| bomcard
| htdocs\bom\bom_card.php
|-
| bomdao
| htdocs\bom\class\bom.class.php
|-
| bomdocument
| htdocs\bom\bom_document.php
|-
| bomlinedao
| htdocs\bom\class\bom.class.php
|-
| bomlist
| htdocs\bom\bom_list.php
|-
| bomnote
| htdocs\bom\bom_note.php
|-
| cashcontrol
| htdocs\compta\cashcontrol\cashcontrol_list.php
|-
| cashcontrolcard
| htdocs\compta\cashcontrol\cashcontrol_card.php
|-
| cashdeskloginpage
| htdocs\cashdesk\index.php
|-
| cashdeskTplTicket
| htdocs\cashdesk\validation_ticket.php
|-
| cashfencedao
| htdocs\compta\cashcontrol\class\cashcontrol.class.php
|-
| categorycard
| htdocs\categories\card.php
htdocs\categories\edit.php
htdocs\categories\viewcat.php
|-
| commandefournisseurdispatchdao
| htdocs\fourn\class\fournisseur.commande.dispatch.class.php
|-
| commonobject
| htdocs\core\class\html.form.class.php
|-
| comptafileslist
| htdocs\compta\compta-files.php
|-
| consumptioncontact
| htdocs\contact\consumption.php
|-
| consumptionthirdparty
| htdocs\societe\consumption.php
|-
| contactagenda
| htdocs\contact\agenda.php
|-
| contactcard
| htdocs\contact\card.php
|-
| contactdao
| htdocs\contact\class\contact.class.php
|-
| contactlist
| htdocs\contact\list.php
|-
| contactthirdparty
| htdocs\societe\societecontact.php
|-
| contacttpl
| htdocs\core\tpl\contacts.tpl.php
htdocs\projet\tasks\contact.php
|-
| contractcard
| htdocs\contrat\card.php htdocs\contrat\contact.php
htdocs\contrat\document.php
htdocs\contrat\info.php htdocs\contrat\note.php
|-
| contractlist
| htdocs\contrat\list.php
|-
| contractservicelist
| htdocs\contrat\services_list.php
|-
| cron
| htdocs\cron\class\cronjob.class.php
|-
| cronjoblist
| htdocs\cron\list.php
|-
| defineholidaylist
| htdocs\holiday\define_holiday.php
|-
| deliverycard
| htdocs\livraison\card.php
|-
| doncard
| htdocs\don\card.php
|-
| element_resource
| htdocs\resource\element_resource.php
|-
| emailcollectoractiondao
| htdocs\emailcollector\class\emailcollectoraction.class.php
|-
| emailcollectorcard
| htdocs\admin\emailcollector_card.php
|-
| emailcollectordao
| htdocs\emailcollector\class\emailcollector.class.php
|-
| emailcollectorfilterdao
| htdocs\emailcollector\class\emailcollectorfilter.class.php
|-
| emailcollectorlist
| htdocs\admin\emailcollector_list.php
|-
| emailingdao
| htdocs\comm\mailing\class\mailing.class.php
|-
| emailsenderprofilelist
| htdocs\admin\mails_senderprofile_list.php
|-
| emailtemplates
| htdocs\admin\mails_templates.php
|-
| expeditioncard
| htdocs\expedition\card.php
|-
| expensereportcard
| htdocs\expensereport\card.php
|-
| expensereportlist
| htdocs\expensereport\list.php
|-
| externalbalance
| htdocs\compta\localtax\clients.php
htdocs\compta\localtax\index.php
htdocs\compta\resultat\clientfourn.php
htdocs\compta\resultat\index.php
htdocs\compta\tva\clients.php
htdocs\compta\tva\index.php
htdocs\compta\tva\quadri_detail.php
|-
| fichinterdao
| htdocs\fichinter\class\fichinter.class.php
|-
| fileslib
| htdocs\core\lib\files.lib.php
|-
| formfile
| htdocs\core\class\html.formfile.class.php
|-
| formmail
| htdocs\core\class\html.formmail.class.php
|-
| globaladmin
| htdocs\admin\company.php
htdocs\admin\defaultvalues.php
htdocs\admin\ldap.php
htdocs\admin\modules.php
htdocs\admin\translation.php
|-
| globalcard
| htdocs\adherents\card.php
htdocs\categories\viewcat.php
htdocs\comm\action\card.php
htdocs\asset\type.php
htdocs\bom\bom_agenda.php
htdocs\bom\bom_card.php
htdocs\bom\bom_document.php
htdocs\bom\bom_note.php
htdocs\adherents\type.php
htdocs\adherents\type_ldap.php
htdocs\comm\propal\card.php
htdocs\commande\card.php
htdocs\compta\bank\card.php
htdocs\compta\bank\treso.php
htdocs\compta\bank\various_payment\card.php
htdocs\compta\cashcontrol\cashcontrol_card.php
htdocs\compta\deplacement\card.php
htdocs\compta\facture\card.php
htdocs\compta\facture\fiche-rec.php
htdocs\compta\facture\invoicetemplate_list.php
htdocs\compta\localtax\card.php
htdocs\compta\paiement.php
htdocs\compta\recap-compta.php
htdocs\compta\salaries\card.php
htdocs\compta\tva\card.php
htdocs\contact\agenda.php
htdocs\contact\card.php
htdocs\contrat\card.php
htdocs\contrat\contact.php
htdocs\contrat\document.php
htdocs\contrat\info.php
htdocs\contrat\note.php
htdocs\comm\card.php
htdocs\comm\mailing\card.php
htdocs\don\card.php
htdocs\expedition\card.php
htdocs\expensereport\card.php
htdocs\fichinter\card.php
htdocs\fourn\card.php
htdocs\fourn\commande\card.php
htdocs\fourn\facture\card.php
htdocs\fourn\recap-fourn.php
htdocs\livraison\card.php
htdocs\loan\card.php
htdocs\margin\tabs\thirdpartyMargins.php
htdocs\modulebuilder\template\myobject_agenda.php
htdocs\modulebuilder\template\myobject_card.php
htdocs\modulebuilder\template\myobject_document.php
htdocs\modulebuilder\template\myobject_note.php
htdocs\product\card.php
htdocs\product\fournisseurs.php
htdocs\product\price.php
htdocs\product\stock\card.php
htdocs\product\stock\product.php
htdocs\product\stock\productlot_card.php
htdocs\projet\card.php
htdocs\projet\comment.php
htdocs\projet\contact.php
htdocs\projet\tasks\comment.php
htdocs\projet\tasks\task.php
htdocs\projet\tasks\time.php
htdocs\projet\tasks.php
htdocs\reception\card.php
htdocs\resource\card.php
htdocs\societe\card.php
htdocs\societe\contact.php
htdocs\societe\document.php
htdocs\societe\note.php
htdocs\societe\notify\card.php
htdocs\societe\paymentmodes.php
htdocs\societe\price.php
htdocs\societe\societecontact.php
htdocs\stripe\payment.php
htdocs\supplier_proposal\card.php
htdocs\ticket\card.php
htdocs\user\agenda_extsites.php
htdocs\user\card.php
htdocs\user\clicktodial.php
htdocs\user\document.php
htdocs\user\group\card.php
htdocs\user\group\perms.php
htdocs\user\ldap.php
htdocs\user\note.php
htdocs\user\param_ihm.php
htdocs\user\perms.php
|-
| globallist
| htdocs\compta\compta-files.php
|-
| groupcard
| htdocs\user\group\card.php
|-
| groupdao
| htdocs\user\class\usergroup.class.php
|-
| groupperms
| htdocs\user\group\perms.php
|-
| holidaylist
| htdocs\holiday\list.php
|-
| homesetup
| htdocs\admin\index.php
|-
| idprofurl
| htdocs\societe\class\societe.class.php
|-
| index
| htdocs\index.php
|-
| interventioncard
| htdocs\fichinter\card.php
|-
| interventionlist
| htdocs\fichinter\list.php
|-
| intervnetiondao
| htdocs\fichinter\class\fichinter.class.php
|-
| inventorycard
| htdocs\product\inventory\card.php
|-
| inventorylist
| htdocs\product\inventory\list.php
|-
| invoicecard
| htdocs\compta\facture\card.php
|-
| invoicedao
| htdocs\compta\facture\class\facture.class.php
|-
| invoiceindex
| htdocs\compta\index.php
|-
| invoicelist
| htdocs\compta\facture\list.php
|-
| invoicereccard
| htdocs\compta\facture\fiche-rec.php
htdocs\compta\facture\invoicetemplate_list.php
|-
| invoicesuppliercard
| htdocs\fourn\facture\card.php
|-
| leavemovementlist
| htdocs\holiday\view_log.php
|-
| leftblock
| htdocs\main.inc.php
|-
| loancard
| htdocs\loan\card.php
|-
| localtaxvatcard
| htdocs\compta\localtax\card.php
|-
| login
| htdocs\main.inc.php
|-
| logout
| htdocs\user\logout.php
|-
| mail
| htdocs\core\class\CMailFile.class.php
|-
| mailingcard
| htdocs\comm\mailing\card.php
|-
| mailinglist
| htdocs\comm\mailing\list.php
|-
| main
| htdocs\core\lib\security.lib.php
htdocs\main.inc.php
|-
| mainloginpage
| htdocs\core\lib\security2.lib.php
|-
| membercard
| htdocs\adherents\card.php
|-
| memberlist
| htdocs\adherents\list.php
|-
| membertypecard
| htdocs\adherents\type.php
|
|-
| membertypeldapcard
| htdocs\adherents\type_ldap.php
|-
| movementlist
| htdocs\core\modules\stock\doc\pdf_stdmovement.modules.php
htdocs\product\stock\movement_card.php
htdocs\product\stock\movement_list.php
|-
| myobjectagenda
| htdocs\modulebuilder\template\myobject_agenda.php
|-
| myobjectcard
| htdocs\modulebuilder\template\myobject_card.php
|-
| myobjectdao
| htdocs\comm\mailing\class\mailing.class.php
htdocs\modulebuilder\template\class\myobject.class.php
htdocs\compta\bank\class\paymentvarious.class.php
htdocs\compta\cashcontrol\class\cashcontrol.class.php
htdocs\compta\salaries\class\paymentsalary.class.php
htdocs\emailcollector\class\emailcollector.class.php
|-
| myobjectdocument
| htdocs\modulebuilder\template\myobject_document.php
|-
| myobjectlist
| htdocs\modulebuilder\template\myobject_list.php
|-
| myobjectnote
| htdocs\modulebuilder\template\myobject_note.php
|-
| notification
| htdocs\core\class\notify.class.php
|-
| odtgeneration
| htdocs\core\modules\user\doc\doc_generic_user_odt.modules.php
htdocs\core\modules\usergroup\doc\doc_generic_usergroup_odt.modules.php
htdocs\core\modules\supplier_proposal\doc\doc_generic_supplier_proposal_odt.modules.php
htdocs\core\modules\societe\doc\doc_generic_odt.modules.php
htdocs\core\modules\stock\doc\doc_generic_stock_odt.modules.php
htdocs\core\modules\facture\doc\doc_generic_invoice_odt.modules.php
htdocs\core\modules\product\doc\doc_generic_product_odt.modules.php
htdocs\core\modules\project\doc\doc_generic_project_odt.modules.php
htdocs\core\modules\propale\doc\doc_generic_proposal_odt.modules.php
htdocs\core\modules\reception\doc\doc_generic_reception_odt.modules.php
htdocs\core\modules\commande\doc\doc_generic_order_odt.modules.php
htdocs\core\modules\contract\doc\doc_generic_contract_odt.modules.php
htdocs\core\modules\expedition\doc\doc_generic_shipment_odt.modules.php
|-
| ordercard
| htdocs\commande\card.php
|-
| orderdao
| htdocs\commande\class\commande.class.php
|-
| orderlist
| htdocs\commande\list.php
htdocs\don\list.php
|-
| ordershipmentcard
| htdocs\expedition\shipment.php
|-
| orderstoinvoice
| htdocs\commande\orderstoinvoice.php
|-
| orderstoinvoicesupplier
| htdocs\fourn\commande\orderstoinvoice.php
|-
| ordersuppliercard
| htdocs\fourn\commande\card.php
|-
| ordersupplierdispatch
| htdocs\fourn\commande\dispatch.php
|-
| paiementcard
| htdocs\stripe\payment.php
htdocs\compta\paiement.php
|-
| passwordforgottenpage
| htdocs\user\passwordforgotten.php
|-
| paymentlist
| htdocs\compta\paiement\list.php
|-
| paymentsupplierlist
| htdocs\fourn\facture\paiement.php
|-
| pdfgeneration
| htdocs\core\modules\action\rapport.pdf.php
htdocs\core\modules\bank\doc\pdf_ban.modules.php
htdocs\core\modules\bank\doc\pdf_sepamandate.modules.php
htdocs\core\modules\cheque\doc\pdf_blochet.class.php
htdocs\core\modules\commande\doc\pdf_einstein.modules.php
htdocs\core\modules\commande\doc\pdf_eratosthene.modules.php
htdocs\core\modules\contract\doc\pdf_strato.modules.php
htdocs\core\modules\expedition\doc\pdf_espadon.modules.php
htdocs\core\modules\expedition\doc\pdf_merou.modules.php
htdocs\core\modules\expedition\doc\pdf_rouget.modules.php
htdocs\core\modules\expensereport\doc\pdf_standard.modules.php
htdocs\core\modules\facture\doc\pdf_crabe.modules.php
htdocs\core\modules\facture\doc\pdf_sponge.modules.php
htdocs\core\modules\fichinter\doc\pdf_soleil.modules.php
htdocs\core\modules\livraison\doc\pdf_typhon.modules.php
htdocs\core\modules\product\doc\pdf_standard.modules.php
htdocs\core\modules\project\doc\pdf_baleine.modules.php
htdocs\core\modules\project\doc\pdf_beluga.modules.php
htdocs\core\modules\project\doc\pdf_timespent.modules.php
htdocs\core\modules\propale\doc\pdf_azur.modules.php
htdocs\core\modules\propale\doc\pdf_cyan.modules.php
htdocs\core\modules\rapport\pdf_paiement.class.php
htdocs\core\modules\reception\doc\pdf_squille.modules.php
htdocs\core\modules\stock\doc\pdf_standard.modules.php
htdocs\core\modules\stock\doc\pdf_stdmovement.modules.php
htdocs\core\modules\supplier_invoice\pdf\pdf_canelle.modules.php
htdocs\core\modules\supplier_order\pdf\pdf_cornas.modules.php
htdocs\core\modules\supplier_order\pdf\pdf_muscadet.modules.php
htdocs\core\modules\supplier_payment\doc\pdf_standard.modules.php
htdocs\core\modules\supplier_proposal\doc\pdf_aurore.modules.php
|-
| pricesuppliercard
| htdocs\product\fournisseurs.php
|-
| product_lotlist
| htdocs\product\stock\productlot_list.php
|-
| productcard
| htdocs\product\card.php
|-
| productdao
| htdocs\product\class\product.class.php
|-
| productdocuments
| htdocs\product\document.php
|-
| productindex
| htdocs\product\index.php
|-
| productlotcard
| htdocs\product\stock\productlot_card.php
|-
| productlotdocuments
| htdocs\product\stock\productlot_document.php
|-
| productpricecard
| htdocs\product\price.php
|-
| productservicelist
| htdocs\product\list.php
|-
| productstatscontract
| htdocs\product\stats\contrat.php
|-
| productstatsinvoice
| htdocs\product\stats\facture.php
|-
| productstatsorder
| htdocs\product\stats\commande.php
|-
| productstatspropal
| htdocs\product\stats\propal.php
htdocs\product\stats\supplier_proposal.php
|-
| productstatssupplyinvoice
| htdocs\product\stats\facture_fournisseur.php
|-
| productstatssupplyorder
| htdocs\product\stats\commande_fournisseur.php
|-
| projectcard
| htdocs\projet\card.php
htdocs\projet\comment.php
|-
| projectcontactcard
| htdocs\projet\contact.php
|-
| projectdao
| htdocs\projet\class\project.class.php
|-
| projectlist
| htdocs\projet\list.php
|-
| projectOverview
| htdocs\projet\element.php
|-
| projecttaskcard
| htdocs\projet\tasks\task.php
|-
| projecttaskcommentcard
| htdocs\projet\tasks\comment.php
|-
| projecttaskscard
| htdocs\projet\tasks.php
|-
| projecttasktime
| htdocs\projet\tasks\time.php
|-
| projectthirdparty
| htdocs\societe\project.php
|-
| projectticket
| htdocs\ticket\list.php
|-
| propalcard
| htdocs\comm\propal\card.php
|-
| propallist
| htdocs\comm\propal\list.php
|
|-
| purchasesjournal
| htdocs\accountancy\journal\purchasesjournal.php
|-
| recapcomptacard
| htdocs\compta\recap-compta.php
|-
| receptioncard
| htdocs\reception\card.php
|-
| receptiondao
| htdocs\reception\card.php
htdocs\reception\class\reception.class.php
|-
| receptionlist
| htdocs\reception\list.php
|-
| resource
| htdocs\resource\card.php
|-
| resource_card
| htdocs\resource\card.php
|-
| resourcelist
| htdocs\resource\list.php
|-
| salarycard
| htdocs\compta\salaries\card.php
|-
| salarypayment
| htdocs\compta\salaries\class\paymentsalary.class.php
|-
| searchform
| htdocs\core\ajax\selectsearchbox.php
htdocs\core\search_page.php
htdocs\main.inc.php
|-
| sellsjournal
| htdocs\accountancy\journal\sellsjournal.php
|-
| shipmentlist
| htdocs\expedition\list.php
|-
| stockproductcard
| htdocs\product\stock\product.php
|-
| stockreplenishlist
| htdocs\product\stock\replenish.php
|-
| subscription
| htdocs\adherents\subscription.php
|-
| subscriptionlist
| htdocs\adherents\subscription\list.php
|-
| supplier_proposalcard
| htdocs\supplier_proposal\card.php
|-
| supplier_proposallist
| htdocs\supplier_proposal\list.php
|-
| supplierbalencelist
| htdocs\compta\recap-compta.php
htdocs\fourn\recap-fourn.php
|-
| suppliercard
| htdocs\fourn\card.php
|-
| supplierinvoicelist
| htdocs\fourn\facture\list.php
|-
| supplierorderlist
| htdocs\fourn\commande\list.php
|-
| supplierpricelist
| htdocs\fourn\product\list.php
|-
| surveylist
| htdocs\opensurvey\list.php
|-
| takeposfrontend
| htdocs\takepos\takepos.php
|-
| tasklist
| htdocs\projet\tasks\list.php
|-
| tasktimelist
| htdocs\projet\tasks\time.php
|-
| taxvatcard
| htdocs\compta\tva\card.php
|-
| thirdpartybancard
| htdocs\societe\paymentmodes.php
|-
| thirdpartycard
| htdocs\core\tpl\advtarget.tpl.php
htdocs\societe\card.php
|-
| thirdpartycomm
| htdocs\comm\card.php
|-
| thirdpartycontact
| htdocs\societe\contact.php
|-
| thirdpartycustomerprice
| htdocs\societe\price.php
|-
| thirdpartydao
| htdocs\societe\class\societe.class.php
|-
| thirdpartydocument
| htdocs\societe\document.php
|-
| thirdpartylist
| htdocs\societe\list.php
|-
| thirdpartymargins
| htdocs\margin\tabs\thirdpartyMargins.php
|-
| thirdpartynote
| htdocs\societe\note.php
|-
| thirdpartynotification
| htdocs\societe\notify\card.php
|-
| thirdpartyticket
| htdocs\ticket\list.php
|-
| ticketcard
| htdocs\ticket\card.php
|-
| ticketlist
| htdocs\ticket\list.php
|-
| timesheetperdaycard
| htdocs\projet\activity\perday.php
|-
| timesheetperweekcard
| htdocs\projet\activity\perweek.php
|-
| toprightmenu
| htdocs\main.inc.php
|-
| tripsandexpensescard
| htdocs\compta\deplacement\card.php
|-
| upgrade
| htdocs\install\upgrade2.php
|-
| useragenda
| htdocs\user\agenda_extsites.php
|-
| usercard
| htdocs\user\agenda_extsites.php
htdocs\user\card.php
htdocs\user\clicktodial.php
htdocs\user\document.php
htdocs\user\ldap.php
htdocs\user\note.php
htdocs\user\param_ihm.php
htdocs\user\perms.php
|-
| userdao
| htdocs\user\class\user.class.php
|-
| userdoc
| htdocs\user\document.php
|-
| userhome
| htdocs\user\home.php
|-
| userihm
| htdocs\user\param_ihm.php
|-
| userldap
| htdocs\user\ldap.php
|-
| userlist
| htdocs\user\list.php
|-
| usernote
| htdocs\user\note.php
|-
| userperms
| htdocs\user\perms.php
|-
| variouscard
| htdocs\compta\bank\various_payment\card.php
|-
| variouspayment
| htdocs\compta\bank\class\paymentvarious.class.php
|-
| warehousecard
| htdocs\product\stock\card.php
|-
| website
| htdocs\admin\website.php
|-
| websiteaccountcard
| htdocs\website\websiteaccount_card.php
|-
| websitethirdpartylist
| htdocs\societe\website.php
|}

= Voir aussi =
* [[Triggers]]
* [[Interfaces Dolibarr toward foreign systems]]
* [[Interfaces from foreign systems toward Dolibarr]]

Paramétrage du module Tiers

2019-06-06T12:07:47Z

Dolibarr95: /* copies ecrans */

[[Category:Admin]]
{{TemplateDocUtil}}

'''Aide de l'écran:''' Paramétrage [[Module Tiers]]

'''Menu d'accès:''' Accueil -> Configuration -> Modules -> Tiers -> Configuration (avec le gestionaire de menu 'eldy')

= Module de génération et contrôles des codes tiers =
Choisissez ici le module qui servira de compteur pour définir le code client et le code fournisseur aux nouveaux tiers créés.

Placez la souris sur le picto "?" à la fin des lignes pour avoir des informations sur les règles amenées par le module.

''Exemple de configuration :''

[[File:Configuration_CodeTiers_Dolibar.jpg]]

Dans cet exemple c'est le module Éléphant qui a été sélectionné.
Les masques indiquent comment les codes clients/fournisseurs seront générés par Dolibarr.

= Module de génération des codes compta =
Choisissez ici le module qui servira à attribuer automatiquement un code compta aux nouveaux tiers créés.

= Modèles de documents =
Activez ici les modèles de documents que vous voulez voir proposez pour générer les factures, propal ou autres dans les écrans.
== Module Generic ODT ==
Avec ce module, vous définissez une liste de répertoires contenant des modèles de document ODT (ces modèles doivent être des fichiers se termiant par .odt). Vous pouvez utiliser OpenOffice ou tout traitement de texte capable de sauvegarder des fichiers au format .odt.

Ensuite, vous ajouter et editer vos fichiers modèles ODT avec le contenu qui vous intéresse.

Placer à l'intérieur de ces modèles les tags qui seront remplacés lors de la génération par la valeurs adéquates. Voici la liste complète des tasg disponibles:
{{TagsTemplatesMySoc}}
{{TagsTemplatesThirdParty}}

= Id professionel unique =
Des Id professionnels énumérés, vous devez indiquer qui doit être unique et qui peut être dupliqué.

= Autre =
Définissez ou non les options supplémentaires.

LISTE D OPTIONS
*Attendre que vous ayez appuyé sur une touche avant de charger le contenu de la liste déroulante des tiers

*Attendre que vous ayez appuyé sur une touche avant de charger le contenu de la liste déroulante des contacts/adresses

*Afficher les références client/fournisseur dans les listes

*Demander la méthode d'expédition préférée pour les tiers

= Onglets "Attributs supplémentaires" =
A partir de ces deux onglets vous pouvez créer de nouveaux attributs pour les tiers et les contacts/adresses.

=copies écrans=

[[https://wiki.dolibarr.org/upload/thumb/d/d9/Configuration_du_module_Tiers_2018.jpg/565px-Configuration_du_module_Tiers_2018.jpg]]

[[File:Screencapture-admin-societe-v9.png]]
[[Configuration_du_module_Tiers_2018.jpg]]

File:Screencapture-admin-societe-v9.png

2019-06-06T12:06:28Z

Dolibarr95: Screenshot of societe admin page in v9

Screenshot of societe admin page in v9

Module Produits

2019-06-06T12:01:59Z

Dolibarr95: /* Configuration */

[[Category:Produit]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Produits|
num=50|
devdoc=[[Module Produits (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module permet de gérer un catalogue de produits.

Voir aussi le [[Module Services]] pour gérer un catalogue de services, ou le [[Module Stock]] pour la gestion de stock.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

Voici une capture d'écran du paramétrage du module

[[File:screencapture-admin-product-v9.png]]

= Définition =
== Produits ==
Un produit Dolibarr est un bien à gérer, soit parce qu'il caractérise un objet proposé à des clients, soit parce qu'il caractérise un objet obtenu auprès de fournisseurs.
Il s'agit de biens matériels, contrairement aux [[Services]].

Un produit répond, en résumé, aux règles suivantes:
* Un produit peut se stocker dans un entrepôt (seuls les produits d'ailleurs apparaissent dans le module [[Module_Stock|Stock]]. Les services n'y apparaissent pas).
* Un produit peut se livrer (seuls les produits d'ailleurs apparaissent dans le module [[Module Expédition|Expedition]]. Les services n'y apparaissent pas. Ces derniers sont réalisés ou non, mais pas livrés).
* Un produit est en général un bien matériel. Sa valeur souvent se déprécie avec le temps (Un produit d'occasion vaut moins que le même produit neuf).

Certains champs sont présent uniquement sur les produits et non disponibles sur les services comme:
* Weight
* Size
* Custom code = Commodity code = License code = HTS = Code SH (Un code sur 6 char pour définir la catégorie douanière internationale du produit)

== Produits virtuels (aussi appelé Produits packs) ==
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock des n produits composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté. Par exemple, si vous avez configuré l'augmentation de stock sur validation de commande fournisseur, en validant une commande fournisseur contenant un produit virtuel, vous incrémentez le stock de ce produit mais aussi de tous les sous-produit le constituant.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel père et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produit est utilisé pour fabriquer un module père, le sous produit est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produit ne peut plus faire le chemin inverse pour revenir en stock.

= Cycle de vie / Règles de gestion =
{{ToComplete}}

= Exemples de cas d'utilisation =
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCMP01:
|situation=
|actions=
}} 

Module Produits

2019-06-06T08:36:40Z

Dolibarr95: /* Configuration */

[[Category:Produit]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Produits|
num=50|
devdoc=[[Module Produits (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module permet de gérer un catalogue de produits.

Voir aussi le [[Module Services]] pour gérer un catalogue de services, ou le [[Module Stock]] pour la gestion de stock.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

Voici une capture d'écran du paramétrage du module

[[File:screencapture-admin-product-v9.png]]

'''Remarque :''' Une barre de recherche des produits peut être utilisée à la place de la liste déroulante (pratique si grand nombre de produits).

Il faut pour cela activer, dans le module produits, l'option "Utiliser une barre de recherche ..." et laisser AJAX/Javascript activé dans les paramètres d'interface utilisateur.

= Définition =
== Produits ==
Un produit Dolibarr est un bien à gérer, soit parce qu'il caractérise un objet proposé à des clients, soit parce qu'il caractérise un objet obtenu auprès de fournisseurs.
Il s'agit de biens matériels, contrairement aux [[Services]].

Un produit répond, en résumé, aux règles suivantes:
* Un produit peut se stocker dans un entrepôt (seuls les produits d'ailleurs apparaissent dans le module [[Module_Stock|Stock]]. Les services n'y apparaissent pas).
* Un produit peut se livrer (seuls les produits d'ailleurs apparaissent dans le module [[Module Expédition|Expedition]]. Les services n'y apparaissent pas. Ces derniers sont réalisés ou non, mais pas livrés).
* Un produit est en général un bien matériel. Sa valeur souvent se déprécie avec le temps (Un produit d'occasion vaut moins que le même produit neuf).

Certains champs sont présent uniquement sur les produits et non disponibles sur les services comme:
* Weight
* Size
* Custom code = Commodity code = License code = HTS = Code SH (Un code sur 6 char pour définir la catégorie douanière internationale du produit)

== Produits virtuels (aussi appelé Produits packs) ==
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock des n produits composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté. Par exemple, si vous avez configuré l'augmentation de stock sur validation de commande fournisseur, en validant une commande fournisseur contenant un produit virtuel, vous incrémentez le stock de ce produit mais aussi de tous les sous-produit le constituant.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel père et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produit est utilisé pour fabriquer un module père, le sous produit est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produit ne peut plus faire le chemin inverse pour revenir en stock.

= Cycle de vie / Règles de gestion =
{{ToComplete}}

= Exemples de cas d'utilisation =
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCMP01:
|situation=
|actions=
}} 

Module Produits

2019-06-06T08:36:26Z

Dolibarr95: /* capture écran */

[[Category:Produit]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Produits|
num=50|
devdoc=[[Module Produits (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Ce module permet de gérer un catalogue de produits.

Voir aussi le [[Module Services]] pour gérer un catalogue de services, ou le [[Module Stock]] pour la gestion de stock.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

Voici une capture d'écran du paramétrage du module
[[File:screencapture-admin-product-v9.png]]

'''Remarque :''' Une barre de recherche des produits peut être utilisée à la place de la liste déroulante (pratique si grand nombre de produits).

Il faut pour cela activer, dans le module produits, l'option "Utiliser une barre de recherche ..." et laisser AJAX/Javascript activé dans les paramètres d'interface utilisateur.

= Définition =
== Produits ==
Un produit Dolibarr est un bien à gérer, soit parce qu'il caractérise un objet proposé à des clients, soit parce qu'il caractérise un objet obtenu auprès de fournisseurs.
Il s'agit de biens matériels, contrairement aux [[Services]].

Un produit répond, en résumé, aux règles suivantes:
* Un produit peut se stocker dans un entrepôt (seuls les produits d'ailleurs apparaissent dans le module [[Module_Stock|Stock]]. Les services n'y apparaissent pas).
* Un produit peut se livrer (seuls les produits d'ailleurs apparaissent dans le module [[Module Expédition|Expedition]]. Les services n'y apparaissent pas. Ces derniers sont réalisés ou non, mais pas livrés).
* Un produit est en général un bien matériel. Sa valeur souvent se déprécie avec le temps (Un produit d'occasion vaut moins que le même produit neuf).

Certains champs sont présent uniquement sur les produits et non disponibles sur les services comme:
* Weight
* Size
* Custom code = Commodity code = License code = HTS = Code SH (Un code sur 6 char pour définir la catégorie douanière internationale du produit)

== Produits virtuels (aussi appelé Produits packs) ==
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock des n produits composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté. Par exemple, si vous avez configuré l'augmentation de stock sur validation de commande fournisseur, en validant une commande fournisseur contenant un produit virtuel, vous incrémentez le stock de ce produit mais aussi de tous les sous-produit le constituant.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel père et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produit est utilisé pour fabriquer un module père, le sous produit est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produit ne peut plus faire le chemin inverse pour revenir en stock.

= Cycle de vie / Règles de gestion =
{{ToComplete}}

= Exemples de cas d'utilisation =
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCMP01:
|situation=
|actions=
}} 

File:Screencapture-admin-product-v9.png

2019-06-06T08:32:46Z

Dolibarr95: Screenshot of product admin page in v9

Screenshot of product admin page in v9

Setup Other

2019-04-16T07:20:25Z

Dolibarr95: /* MAIN_DOC_USE_TIMING ODT */

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

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

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

= '''Goal''' =
This page is built to add/edit new parameters without a dedicated page to edit them. In most cases, it is parameters for your own development, external modules, or hidden features which can allow some tweaking to your own Dolibarr instance.

For standard usage of Dolibarr, this screen must be kept empty and not be used.

= '''Reading the List''' =
After Global Options, this 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''

= '''List of Known Hidden Options''' =
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.

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>

== '''Global Options''' ==

* '''MAIN_DISABLE_NOTES_TAB''' ►Show or hide notes tab in the card page ► (core)

* '''MAIN_DISABLE_CONTACTS_TAB''' ► Show or hide contacts tab in the card page ► (core)

* '''MAIN_LOGOUT_GOTO_URL''' ► URL to which the user will be redirected after LOGOUT ► (core)

* '''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_SHOW_TECHNICAL_ID''' ► Show also technical IDs on elements cards or some lists (not supported everywhere).

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

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

* '''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_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 less powerful. ► (v5.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_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 500 000 records).

* '''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_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_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_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_OPTIMIZE_SPEED''' ► Use some speed enhancements. See page [[Increase_Performance]] for more information.

* '''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_REPEATCONTACTONEACHTAB''' ► If added and set to '''1''', this adds contacts on all tabs, not only main tab.

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

* '''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_HELPCENTER_LINKTOUSE''' ► Define the URL link to use as the target page for link "I need help" onto logon page

* '''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_SHOW_TUNING_INFO''' ► Add tuning information into javascript console. Better when xdebug is enabled.

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

* '''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_ADD_SALE_REP_SIGNATURE_IN_NOTE''' ► Add signature of the first sale representative into documents (at end of public notes).

* '''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_USE_CACHE_MANIFEST''' ► Add an HTML5 cache manifest to the page - Attention, this functionality is obsolete and removed from web standards

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

* '''MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS''' ► Allow to define a default VAT rate

* '''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_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_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_WEIGHT_DEFAULT_ROUND''' ► Accuracy of weight (number of decimals)

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

* '''MAIN_VOLUME_DEFAULT_ROUND''' ► Accuracy of volume (number of decimals)

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

* '''MAIN_PUBLIC_NOTE_IN_ADDRESS''' ► Show public note in address block ► (v4.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_ROUNDOFTOTAL_NOT_TOTALOFROUND''' ► Change way of rounding total TTC lines, rounding first of after.

* '''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_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_DISABLEDRAFTSTATUS''' ► Disable the status Draft for some objects (project, donation, ...)

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

* '''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_ENABLE_IMPORT_LINKED_OBJECT_LINES''' ► Allow to import lines into current document from "linked" compatible documents ► (v8.0+)

* '''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_SHOWDATABASENAMEINHELPPAGESLINK''' ► Show database name in upper help menu ► (v8.0+)

* '''MAIN_DISABLE_MULTIPLE_FILEUPLOAD''' ► Disable users to upload multiple files at once.

* '''USER_HIDE_INACTIVE_IN_COMBOBOX''' ► Disable display inactive users in combobox.

* '''MAIN_FIRSTNAME_NAME_POSITION''' ► Position of firstname in full name (0/1).

[[#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.

* '''MAIN_ADD_EVENT_ON_ELEMENT_CARD''' ► Allow to create an event from a document (proposal, order, invoice)
[[#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)]]

== '''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 an email to show in a message visible to 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". For example, you can set this parameter to <code>MAILING_LIMIT_WARNING_PHPMAIL</code> and enter translation key for each language for this key.

* '''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". For example, you can set this parameter to <code>MAILING_LIMIT_WARNING_NOPHPMAIL</code> and enter translation key for each language for this key.

* '''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+)
[[#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>).
[[#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.

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

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

* '''INVOICE_CREDIT_NOTE_STANDALONE''' ► Can make a credit note without invoice. ► (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

* '''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. ► (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.
[[#Top|(back to top)]]

== '''Look or Theme''' ==
* '''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+)
[[#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+)
[[#Top|(back to top)]]

== '''PDF Options''' ==
* '''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_COMPRESSION''' ► Disable PDF compression.

* '''MAIN_INVERT_SENDER_RECIPIENT''' ► Invert sender and recipient in some PDF.

* '''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_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_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_PDF_FORCE_FONT''' ► To ignore font defined into language file and force usage of a particular font. For example "<code>DejaVuSans</code>".

* '''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_USE_COMPANY_NAME_OF_CONTACT''' ► Use contact name and information rather than company

* '''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_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_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_WITHOUT_VAT_COLUMN''' ► Hide column with VAT information but only column not total.

* '''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...".

* '''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.

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

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

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

* '''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+)
[[#Top|(back to top)]]

== '''Point of Sale''' ==
* '''CASHDESK_SHOW_KEYPAD''' ► Show a mouse key pad into Point of Sale.

* '''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 us to define the invoice ref 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).
[[#Top|(back to top)]]

== '''Products Module''' ==
* '''MAIN_PRODUCT_DISABLE_CUSTOMCOUNTRYCODE''' ► Avoid Custom 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.

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

* '''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.

* '''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.

* '''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+

* '''PRODUCT_CHARGES''' ► Adds an extra field for adhoc charges at the product buying price stage. The cost price is then calculated with supplier price + charges if defined. Useful for extra costs for a product or certain delivery charges to the product. ► (<= v7.0)

* '''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.

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

* '''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+)

* '''CATEGORY_GRAPHSTATS_ON_PRODUCTS''' ► Show graph of products with categories and totals in Products Area screen
[[#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''' ==
* '''MAIN_SERVICES_ARE_ECOMMERCE_200238EC''' ► (< 8)

* '''CASHDESK_FORCE_STOCK_ON_BILL''' => Option to force decrease of stock whatever is user setup. ► (>= 8.0.1)

* '''SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED''' ► Disable stock dispatch when total expected was already received.
[[#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+)
[[#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+)

* '''MAIN_THIRDPARTY_CREATION_INDIVIDUAL''' ► With this setting as '''1''' the option is set for third parties to be created WITH the child contact ► (v<5.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.
[[#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)]]

Setup Other

2018-11-21T07:51:05Z

Dolibarr95: COMPANY_AQUARIUM_CLEAN_REGEX

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

'''Help about screen:''' Other setup

'''Menu path:''' Home -> Setup -> Other

= Goal =
This page is built to add/edit new parameters without a dedicated page to edit them. In most cases, it is parameters for your own development, external modules, or hidden features which can allow some tweaking to your own Dolibarr instance.

For standard usage of Dolibarr, this screen must be kept empty and not be used.

= List of Known Hidden Options =
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.

To enable/override a parameter you have to define the constant name and set it to '''1''' in '''Home -> Setup -> Other Setup''':

== Global Options ==

* MAIN_DISABLE_NOTES_TAB (core) => Show or hide notes tab in the card page

* MAIN_DISABLE_CONTACTS_TAB (core) => Show or hide contacts tab in the card page

* MAIN_LOGOUT_GOTO_URL => (core) url to which the user will be redirected after LOGOUT.

* 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 MAIN_FILESYSTEM_ENCODING to "utf-8".

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

* MAIN_MAXTABS_IN_CARD => Max number of tabs visible. Others are grouped into a combo list.

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

* 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_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 less powerful. (v5.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_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 500 000 records).

* 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_ENABLE_LOG_TO_HTML (MAIN_LOGTOHTML before 3.9) => If this constant is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.

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

* MAIN_OPTIMIZE_SPEED => Use some speed enhancements. See page [[Increase_Performance]] for more information.

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

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

* MAIN_DISABLE_JQUERY_JNOTIFY => Disable usage of JNotify to show confirm or error messages

* 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 features, because, it bypasses some business actions (updates on other data that should be done consistently) and ignores business controls on data you saved. So 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_HELPCENTER_LINKTOUSE => Define the url link to use as the target page for link "I need help" onto logon page

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

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

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

* 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_ADD_SALE_REP_SIGNATURE_IN_NOTE => Add signature of the first sale representative into documents (at end of public notes).

* 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 constant MAIN_DISABLE_AJAX_COMBOX to 1 into Home-Setup-Other (v3.6.0+).

* MAIN_USE_CACHE_MANIFEST => Add an HTML5 cache manifest to the page - Attention, this functionality is obsolete and removed from web standards

* MAIN_FORCELANGDIR => relative path of the directory holding your custom langs folder.

* MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS => allow to define a default VAT rate

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

* 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_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_WEIGHT_DEFAULT_ROUND => Accuracy of weight (number of decimals)

* MAIN_WEIGHT_DEFAULT_UNIT => Default unit for weight (0=kg, -3=g, ...)

* MAIN_VOLUME_DEFAULT_ROUND => Accuracy of volume (number of decimals)

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

* MAIN_PUBLIC_NOTE_IN_ADDRESS => show public note in address block (v4.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_ROUNDOFTOTAL_NOT_TOTALOFROUND => Change way of rounding total TTC lines, rounding first of after

* 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_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: %Y%m%d%H%M

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

* MAIN_USE_OLD_SEARCH_FORM => Display the old search form in left menu.

* 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 : Europe/Paris, auto.

* 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_ENABLE_IMPORT_LINKED_OBJECT_LINES => Allow to import lines into current document from "linked" compatible documents (v8.0+)

* 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_SHOWDATABASENAMEINHELPPAGESLINK => Show database name in upper help menu (v8.0+)

== Look or Theme ==
* MAIN_OPTIMIZEFORTEXTBROWSER => Optimize output rendering for usage of a text browser (usefull for blind people)
* THEME_ELDY_DISABLE_IMAGE => Disabled images of top menu for eldy theme. (v3.8.0+)
* MAIN_MENU_HIDE_UNAUTHORIZED => Hide menu if logged in user is not autorized rather than just grey them
* THEME_TOPMENU_STICKY_POSITION => Option to fix top menu with eldy theme (hidden conf) (v7.0+)
* MAIN_EASTER_EGG_COMMITSTRIP => Show a comic image from the CommitStrip website. Images are refreshed daily. (v6.0+)

== Email and SMS ==

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

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

* MAIN_MAIL_DEBUG => Write content with header of last mail into file dolibarr_mail.log into directory dolibarr_main_data_root.

* MAIN_SMS_DEBUG => Write content of SMS sent into file dolibarr_sms.log into directory dolibarr_main_data_root.

* 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 -f. This option is here to ask Dolibarr to call the function '''mail''' of PHP by adding value for the option -f. 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 ask PHP to provide this parameter when sending a mail. Note that another solution is to edit the '''mail.force_extra_parameters=-ba''' into '''php.ini''' 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 orange.fr or hotmail.com

* 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 recipients 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 x recipients for same email message (x for To: + CC: + BCC:). If not defined, value is 10. 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 will appears into 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+)

== Third Parties module ==

* COMPANY_AQUARIUM_CLEAN_REGEX (>= 8.0.1) => Add a REGEX rule on the third parties names. It apply 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 exemple if COMPANY_AQUARIUM_CLEAN_REGEX = '^..(..)..(.*)'
the first char and second char are removed and the char 5 and 6 too

* MAIN_FORCE_DEFAULT_STATE_ID (>= 8.0.1) => rowid (integer) of a state/province as defined in llx_c_departements. On the creation of a third party/contact, the state/province corresponding to this rowid is preselected in the dropdown list.
* 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 (Dolibarr 5.0+) => Default Third party create are individual
* MAIN_THIRDPARTY_CREATION_INDIVIDUAL (Dolibarr <5.0) => Default Third party create are individual
* 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.

== 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

== 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
* 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+)

== 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 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 non reversible 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 non reversible 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.
* FACTURE_SENDBYEMAIL_FOR_ALL_STATUS => Can send invoice by email to customer even if invoice has status "draft".
* MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT => Disable VAT on genrated documents. like for an association. (it's work with crabe template)
* INVOICE_CREDIT_NOTE_STANDALONE (dolibarr 3.9) => Can make a credit note without invoice.
* INVOICE_USE_SITUATION = Enable the "situation invoice" feature
* INVOICE_USE_SITUATION_CREDIT_NOTE (dolibarr 8.0) = Enable the "situation credit note" feature (need INVOICE_USE_SITUATION)
* INVOICE_DISABLE_DEPOSIT = Disable deposit invoices
* INVOICE_DISABLE_REPLACEMENT = Disable replacement invoices
* INVOICE_DISABLE_CREDIT_NOTE = Disable credit notes
* 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. (v7.0+)

== 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 ExpenseReport 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 6.0 set this constant to '1' (>=v7.0+)

==VAT Report==
* MAIN_INCLUDE_ZERO_VAT_IN_REPORTS => Include lines with VAT to 0% (for "auto-liquidation" in EEC) (V8.0.3+)

== Export module ==
* EXPORT_CSV_SEPARATOR_TO_USE => String value to use as default separator to delimit fields of exported files (by default Dolibarr uses ","). Example: EXPORT_CSV_SEPARATOR_TO_USE=;
* 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= utf-8
* 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 (").

== 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.
* MAIN_ADD_EVENT_ON_ELEMENT_CARD => Allow to create an event from a document (proposal, order, invoice)

== Products module ==
* MAIN_PRODUCT_DISABLE_CUSTOMCOUNTRYCODE => Avoid Custom 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.
* PRODUIT_DESC_IN_LIST => Show long description of product/service into lists.
* 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.
* 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.
* 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+

* PRODUCT_CHARGES => Adds an extra field for adhoc charges at the product buying price stage. The cost price is then calculated with supplier price + charges if defined. Useful for extra costs for a product or certain delivery charges to the product. (<= v7.0)

* PRODUCT_MAX_VISIBLE_PHOTO => Show a maximum number of product photos (as thumbnails) on the product main card. Example, setting this constant to '5' will show the first five product photos found on the product card.
* PRODUCT_MAX_LENGTH_COMBO => limit the length of the label displayed when adding lines in proposals/invoices/orders
* MAIN_DISABLE_FREE_LINES (>= 8.0) => Disallow using free lines to add line in documents

== 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.

== Stocks ==
* MAIN_SERVICES_ARE_ECOMMERCE_200238EC (< 8) =>

* CASHDESK_FORCE_STOCK_ON_BILL (>= 8.0.1) => 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.

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

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

== Point of Sale ==
* CASHDESK_SHOW_KEYPAD => Show a mouse key pad into Point Of Sale.
* POS_ADDON = Set this value to an existing numbering module rule (for example 'mod_facture_terre', 'mod_facture_mars', ...) to force the numbering module to us to define the invoice ref when invoice is created by the POS. For example setting value POS_ADDON to 'mod_facture_terre' will use the numbering module 'terre' 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).

== Contracts ==
* CONTRACT_SUPPORT_PRODUCTS => Products are also suggested into module contract.

== Projects module ==
* PROJECT_DISABLE_UNLINK_FROM_OVERVIEW (>= 8.0.1) => Enable removing the button from a link in the project overview.
* 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 (4.0) => Hide the "link to" form on the overview page
* PROJECT_CREATE_ON_OVERVIEW_DISABLED (4.0) => Hide the "create ..." button on the overview page
* 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

== 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 off payment cell, into the page to make online subscription.

== Interventions module ==
* FICHINTER_CLASSIFY_BILLED => Allow to classify an intervention card as "Billed". This add also trigger FICHINTER_CLASSIFY_BILLED into list of possible automatic event into agenda.
* FICHINTER_DISABLE_DETAILS => Disable entry of details line on intervention. Can validate with no line.

== 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 (rowid in table llx_c_paiement).
* 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_NOPRICEDEFINED => Can enter a product even if no supplier price defined. (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+)

== Bank module ==
* BANK_CAN_RECONCILIATE_CASHACCOUNT (3.8) => Can reconciliate cash accounts
* 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

== 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 'SERVER_NAME', 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 use 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 an email to show in a message visible to 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". For example, you can set this parameter to 'MAILING_LIMIT_WARNING_PHPMAIL' and enter translation key for each language for this key.
* 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". For example, you can set this parameter to 'MAILING_LIMIT_WARNING_NOPHPMAIL' and enter translation key for each language for this key.
* EMAILING_USE_ADVANCED_SELECTOR => Enable the advanced selector for destinaries

* MAILING_LIMIT_SENDBYWEB => Restrict number of emails you can send in same sending session with emailing module from GUI. The value "dolibarr_mailing_limit_sendbyweb" 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 "dolibarr_mailing_limit_sendbycli" if defined into config file is used in priority for this limit.

== PDF options ==
* MAIN_DISABLE_FORCE_SAVEAS => If your browser ask always to save downloaded files on disk (like PDF), try to add this option. File might appears directly into your browser.

* MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.

* MAIN_INVERT_SENDER_RECIPIENT => Invert sender and recipient in some PDF.

* 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_USE_BACKGROUND_ON_PDF => Define this constant with short name of an image (example "myimage.jpg") that must be saved into directory "documents/mycompany/logos". This will add this background image into your generated PDF files. Warning: This option make TCPDF library beeing crazy sometime and content on image disappeared !

* MAIN_ADD_PDF_BACKGROUND => Define this constant with short name of a PDF file (example "mypdf.pdf") that must be saved into directory "documents/mycompany". 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_PDF_FORCE_FONT => To ignore font defined into language file and force usage of a particular font. For example "DejaVuSans".

* 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: '220,220,200'

* MAIN_USE_COMPANY_NAME_OF_CONTACT => Use contact name and information rather than company

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

* 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_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_DOCUMENTS_LOGO_HEIGHT => Can force height of Logo on PDF.

* MAIN_DOCUMENTS_WITH_PICTURE_WIDTH => Can change size of picture when hidden option MAIN_GENERATE_PROPOSALS_WITH_PICTURE is used. By default value is 20.

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

* 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 number/account" for GB, ...) and keep only BIC/IBAN on PDF.

* PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES => Value 1 or 2 change the way product ref is show (1 = show supplier ref only and not internal ref, 2 = show supplier then internal). Without, internal ref then supplier is shown.

* 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.

* PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME => Include alternative/alias name into name on PDF.

* MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING => add optional esign field in pdf propal

== 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 guaranted with this. Also if the image is removed or renamed by the image hoster, your proposal, order or invoice will be broken.

== BlockedLog ==

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

== MultiCurrency ==

* MAIN_MULTICURRENCY_ALLOW_SYNCHRONIZATION => Enable CurrencyLayer API synchronization

Liste de classes et objets

2018-10-15T14:21:09Z

Dolibarr95:

Cette page a pour but d aider l utilisateur a appeler un objet ds dolibarr
(avec extrafields par exemple avec le "lien vers objet")

{| class="wikitable"
|+MODULE TIERS
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Contact
|Contact
|Contact:contact/class/contact.class.php
|-
|societe
|societe
|Société:societe/class/societe.class.php
|}

{| class="wikitable"
|+MODULE PRODUIT
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Produit
|Product
|Product:Product/class/Product.class.php
|
|-
|Service
|Service
|?
|}

{| class="wikitable"
|+MODULE ADHERENT
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|adherent
|adherent
|adherent:adherent/class/adherent.class.php
|}

{| class="wikitable"
|+MODULE PROJET
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|PROJET
|project
|project:project/class/project.class.php
|}

{| class="wikitable"
|+MODULE TICKET
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|TICKET
|ticket
|ticket/class/ticket.class.php
|}

{| class="wikitable"
|+MODULE AGENDA
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Evenement
|Event
|ActionComm:comm/action/class/actioncomm.class.php
|}

{| class="wikitable"
|+MODULE INTERVENTION
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|fichinter
|fichinter
|fichinter/class/fichinter.class.php
|}

{| class="wikitable"
|+MODULE RESSOURCE
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|resource
|resource
|resource/class/resource.class.php
|}

{| class="wikitable"
|+MODULE INFOEXTRANET
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Equipement
|device
|class/device.class.php
|-
|address
|address
|class/address.class.php
|-
|application
|application
|class/application.class.php
|-
|role
|role
|class/role.class.php
|-
|Equipement Reseau
|networkdevice
|networkdevice.class.php

Liste de classes et objets

2018-10-15T07:00:48Z

Dolibarr95:

Cette page a pour but d aider l utilisateur a appeler un objet ds dolibarr
(avec extrafields par exemple avec le "lien vers objet")

{| class="wikitable"
|+MODULE TIERS
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Contact
|Contact
|Contact:contact/class/contact.class.php
|-
|societe
|societe
|Société:societe/class/societe.class.php
|}

{| class="wikitable"
|+MODULE PRODUIT
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Produit
|Product
|Product:Product/class/Product.class.php
|
|-
|Service
|Service
|?
|}

{| class="wikitable"
|+MODULE ADHERENT
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|adherent
|adherent
|adherent:adherent/class/adherent.class.php
|}

{| class="wikitable"
|+MODULE PROJET
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|PROJET
|project
|project:project/class/project.class.php
|}

{| class="wikitable"
|+MODULE TICKET
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|TICKET
|ticket
|ticket/class/ticket.class.php
|}

{| class="wikitable"
|+MODULE AGENDA
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Evenement
|Event
|comm/action/class/actioncomm.class.php
|}

{| class="wikitable"
|+MODULE INTERVENTION
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|fichinter
|fichinter
|fichinter/class/fichinter.class.php
|}

{| class="wikitable"
|+MODULE RESSOURCE
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|resource
|resource
|resource/class/resource.class.php
|}

{| class="wikitable"
|+MODULE INFOEXTRANET
|-
|NOM DE L OBJET
|NOM DE L OBJET DS LA CLASSE
|CLASSE
|-
|Equipement
|device
|class/device.class.php
|-
|address
|address
|class/address.class.php
|-
|application
|application
|class/application.class.php
|-
|role
|role
|class/role.class.php
|-
|Equipement Reseau
|networkdevice
|networkdevice.class.php

Setup Dictionnary

2018-10-12T15:01:10Z

Dolibarr95: /* Function */

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

'''Help about screen:''' Setup Dictionnary

'''Menu path:''' Home -> Setup -> Dictionary Setup

= Function =

This page can be used to edit lists of values used in some Dolibarr comboboxes.
The lists available for editing depend on the modules activated.

This is the list you should get if all modules are activated.

* Currencies
* Countries
* Regions
* State/Cantons
* Juridical kinds of company
* Company types
* Staff
* Prospect potential level
* Civility title
* Contact/Address types
* Type of agenda events
* VAT Rates
* Payment terms
* Payment modes
* Origin of proposals/orders
* Ordering methods
* Shipping methods
* Types of fees
* Delivery delay
* Paper formats

''Note:'' External modules can add extra specific dictionaries.

Troubleshooting

2018-10-05T07:25:26Z

Setup Other

2018-09-20T08:13:42Z

Dolibarr95: Wrong place for the constant

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

'''Help about screen:''' Other setup

'''Menu path:''' Home -> Setup -> Other

= Goal =
This page is built to add/edit new parameters without a dedicated page to edit them. In most cases, it is parameters for your own development, external modules, or hidden features which can allow some tweaking to your own Dolibarr instance.

For standard usage of Dolibarr, this screen must be kept empty and not be used.

= List of Known Hidden Options =
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.

To enable/override a parameter you have to define the constant name and set it to '''1''' in '''Home -> Setup -> Other Setup''':

== Global Options ==

* MAIN_LOGOUT_GOTO_URL => (core) url to which the user will be redirected after LOGOUT.

* 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 MAIN_FILESYSTEM_ENCODING to "utf-8".

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

* MAIN_MAXTABS_IN_CARD => Max number of tabs visible. Others are grouped into a combo list.

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

* 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_SECURITY_CSRF_WITH_TOKEN (>= 5.0) => 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 less powerful.

* 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_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 500 000 records).

* 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_ENABLE_LOG_TO_HTML (MAIN_LOGTOHTML before 3.9) => If this constant is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.

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

* MAIN_OPTIMIZE_SPEED => Use some speed enhancements. See page [[Increase_Performance]] for more information.

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

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

* MAIN_DISABLE_JQUERY_JNOTIFY => Disable usage of JNotify to show confirm or error messages

* 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 features, because, it bypasses some business actions (updates on other data that should be done consistently) and ignores business controls on data you saved. So 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_HELPCENTER_LINKTOUSE => Define the url link to use as the target page for link "I need help" onto logon page

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

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

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

* 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_ADD_SALE_REP_SIGNATURE_IN_NOTE => Add signature of the first sale representative into documents (at end of public notes).

* 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 constant MAIN_DISABLE_AJAX_COMBOX to 1 into Home-Setup-Other (with Dolibarr v3.6.0+).

* MAIN_USE_CACHE_MANIFEST => Add an HTML5 cache manifest to the page - Attention, this functionality is obsolete and removed from web standards

* MAIN_FORCELANGDIR => relative path of the directory holding your custom langs folder.

* MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS => allow to define a default VAT rate

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

* MAIN_LANDING_PAGE => (>= 3.9). 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).

* MAIN_PROPAGATE_CONTACTS_FROM_ORIGIN => (>= 4.0) When creating an order, contract, invoice from another object, specific contacts of objects are set as specific contact of the new object when possible.

* MAIN_WEIGHT_DEFAULT_ROUND => Accuracy of weight (number of decimals)

* MAIN_WEIGHT_DEFAULT_UNIT => Default unit for weight (0=kg, -3=g, ...)

* MAIN_VOLUME_DEFAULT_ROUND => Accuracy of volume (number of decimals)

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

* MAIN_PUBLIC_NOTE_IN_ADDRESS >=4.0 => show public note in address block

* 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_ROUNDOFTOTAL_NOT_TOTALOFROUND => Change way of rounding total TTC lines, rounding first of after

* 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_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: %Y%m%d%H%M

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

* MAIN_USE_OLD_SEARCH_FORM => Display the old search form in left menu.

* 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 : Europe/Paris, auto.

* 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_ENABLE_IMPORT_LINKED_OBJECT_LINES (dolibarr 8.0) => Allow to import lines into current document from "linked" compatible documents

== Look or Theme ==
* MAIN_OPTIMIZEFORTEXTBROWSER => Optimize output rendering for usage of a text browser (usefull for blind people)
* THEME_ELDY_DISABLE_IMAGE => Disabled images of top menu for eldy theme.
* MAIN_MENU_HIDE_UNAUTHORIZED => Hide menu if logged in user is not autorized rather than just grey them
* THEME_TOPMENU_STICKY_POSITION => Option to fix top menu with eldy theme (hidden conf)(v7.0+)

== Email and SMS ==

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

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

* MAIN_MAIL_DEBUG => Write content with header of last mail into file dolibarr_mail.log into directory dolibarr_main_data_root.

* MAIN_SMS_DEBUG => Write content of SMS sent into file dolibarr_sms.log into directory dolibarr_main_data_root.

* 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 -f. This option is here to ask Dolibarr to call the function '''mail''' of PHP by adding value for the option -f. 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 ask PHP to provide this parameter when sending a mail. Note that another solution is to edit the '''mail.force_extra_parameters=-ba''' into '''php.ini''' 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 orange.fr or hotmail.com

* 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 recipients 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 x recipients for same email message (x for To: + CC: + BCC:). If not defined, value is 10. 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 will appears into 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+)

== Third Parties module ==

* COMPANY_AQUARIUM_CLEAN_REGEX (>= 8.0.1) => Add a REGEX rule on the third parties names.
* MAIN_FORCE_DEFAULT_STATE_ID (>= 8.0.1) => Enables to force the selection of a country / province / county from a country specifying IDs
* 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 (Dolibarr 5.0+) => Default Third party create are individual
* MAIN_THIRDPARTY_CREATION_INDIVIDUAL (Dolibarr <5.0) => Default Third party create are individual
* 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...

== 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

== 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
* 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+)

== 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 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 non reversible 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 non reversible 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.
* FACTURE_SENDBYEMAIL_FOR_ALL_STATUS => Can send invoice by email to customer even if invoice has status "draft".
* MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT => Disable VAT on genrated documents. like for an association. (it's work with crabe template)
* INVOICE_CREDIT_NOTE_STANDALONE (dolibarr 3.9) => Can make a credit note without invoice.
* INVOICE_USE_SITUATION = Enable the "situation invoice" feature
* INVOICE_USE_SITUATION_CREDIT_NOTE (dolibarr 8.0) = Enable the "situation credit note" feature (need INVOICE_USE_SITUATION)
* INVOICE_DISABLE_DEPOSIT = Disable deposit invoices
* INVOICE_DISABLE_REPLACEMENT = Disable replacement invoices
* INVOICE_DISABLE_CREDIT_NOTE = Disable credit notes
* 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. (v7.0+)

== Expense Report ==
* EXPENSEREPORT_ALLOW_OVERLAPPING_PERIODS => Can enter several expense reports on same or overlapping date periods. (v7.0+)

== Export module ==
* EXPORT_CSV_SEPARATOR_TO_USE => String value to use as default separator to delimit fields of exported files (by default Dolibarr uses ","). Example: EXPORT_CSV_SEPARATOR_TO_USE=;
* 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= utf-8
* 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 (").

== 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.
* MAIN_ADD_EVENT_ON_ELEMENT_CARD => Allow to create an event from a document (proposal, order, invoice)

== Products module ==
* MAIN_PRODUCT_DISABLE_CUSTOMCOUNTRYCODE => Avoid Custom 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.
* PRODUIT_DESC_IN_LIST => Show long description of product/service into lists.
* 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.
* 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.
* 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+

* PRODUCT_CHARGES => Adds an extra field for adhoc charges at the product buying price stage. The Cost price is then calculated with supplier price + charges if defined. Useful for extra costs for a product or certain delivery charges to the product.

* PRODUCT_MAX_VISIBLE_PHOTO => Show a maximum number of product photos (as thumbnails) on the product main card. Example, setting this constant to '5' will show the first five product photos found on the product card.
* PRODUCT_MAX_LENGTH_COMBO => limit the length of the label displayed when adding lines in proposals/invoices/orders
* MAIN_DISABLE_FREE_LINES (>= 8.0) => Disallow using free lines to add line in documents

== 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.

== Stocks ==

* SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED => Disable stock dispatch when total expected was already received.

== Shipments ==
* SHIPMENT_GETS_ALL_ORDER_PRODUCTS => Add all order lines in shipment, including the one with 0 in quantity

== Point of Sale ==
* CASHDESK_SHOW_KEYPAD => Show a mouse key pad into Point Of Sale.
* POS_ADDON = Set this value to an existing numbering module rule (for example 'mod_facture_terre', 'mod_facture_mars', ...) to force the numbering module to us to define the invoice ref when invoice is created by the POS. For example setting value POS_ADDON to 'mod_facture_terre' will use the numbering module 'terre' 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).

== Contracts ==
* CONTRACT_SUPPORT_PRODUCTS => Products are also suggested into module contract.

== Projects module ==
* PROJECT_DISABLE_UNLINK_FROM_OVERVIEW (>= 8.0.1) => Enable removing the button from a link in the project overview.
* 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 (4.0) => Hide the "link to" form on the overview page
* PROJECT_CREATE_ON_OVERVIEW_DISABLED (4.0) => Hide the "create ..." button on the overview page
* 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

== 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 off payment cell, into the page to make online subscription.

== Interventions module ==
* FICHINTER_CLASSIFY_BILLED => Allow to classify an intervention card as "Billed". This add also trigger FICHINTER_CLASSIFY_BILLED into list of possible automatic event into agenda.
* FICHINTER_DISABLE_DETAILS => Disable entry of details line on intervention. Can validate with no line.

== 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.
* SUPPLIER_ORDER_AUTOADD_USER_CONTACT => Add user approving supplier order as a contact automatically.
* 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_NOPRICEDEFINED => Can enter a product even if no supplier price defined. (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+)

== Bank module ==
* BANK_CAN_RECONCILIATE_CASHACCOUNT (3.8) => Can reconciliate cash accounts
* 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

== 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 'SERVER_NAME', 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 use 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 an email to show in a message visible to 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". For example, you can set this parameter to 'MAILING_LIMIT_WARNING_PHPMAIL' and enter translation key for each language for this key.
* 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". For example, you can set this parameter to 'MAILING_LIMIT_WARNING_NOPHPMAIL' and enter translation key for each language for this key.
* EMAILING_USE_ADVANCED_SELECTOR => Enable the advanced selector for destinaries

* MAILING_LIMIT_SENDBYWEB => Restrict number of emails you can send in same sending session with emailing module from GUI. The value "dolibarr_mailing_limit_sendbyweb" 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 "dolibarr_mailing_limit_sendbycli" if defined into config file is used in priority for this limit.

== PDF options ==
* MAIN_DISABLE_FORCE_SAVEAS => If your browser ask always to save downloaded files on disk (like PDF), try to add this option. File might appears directly into your browser.

* MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.

* MAIN_INVERT_SENDER_RECIPIENT => Invert sender and recipient in some PDF.

* 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_USE_BACKGROUND_ON_PDF => Define this constant with short name of an image (example "myimage.jpg") that must be saved into directory "documents/mycompany/logos". This will add this background image into your generated PDF files. Warning: This option make TCPDF library beeing crazy sometime and content on image disappeared !

* MAIN_ADD_PDF_BACKGROUND => Define this constant with short name of a PDF file (example "mypdf.pdf") that must be saved into directory "documents/mycompany". 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_PDF_FORCE_FONT => To ignore font defined into language file and force usage of a particular font. For example "DejaVuSans".

* 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: '220,220,200'

* MAIN_USE_COMPANY_NAME_OF_CONTACT => Use contact name and information rather than company

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

* 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_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_DOCUMENTS_WITH_PICTURE_WIDTH => Can change size of picture when hidden option MAIN_GENERATE_PROPOSALS_WITH_PICTURE is used. By default value is 20.

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

* 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 number/account" for GB, ...) and keep only BIC/IBAN on PDF.

* PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES => Value 1 or 2 change the way product ref is show (1 = show supplier ref only and not internal ref, 2 = show supplier then internal). Without, internal ref then supplier is shown.

* 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.

* PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME => Include alternative/alias name into name on PDF.

* MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING => add optional esign field in pdf propal

== 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 guaranted with this. Also if the image is removed or renamed by the image hoster, your proposal, order or invoice will be broken.

== BlockedLog ==

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

== MultiCurreny ==

* MAIN_MULTICURRENCY_ALLOW_SYNCHRONIZATION => Enable CurrencyLayer API synchronization