Setup Other: Difference between revisions

Jump to navigation Jump to search
m
Reverted edits by Jtraulle (talk) to last revision by Joseplluis
m (→‎Global Options: Added version column)
m (Reverted edits by Jtraulle (talk) to last revision by Joseplluis)
Tag: Rollback
Line 20: Line 20:
This page contains the list of advanced hidden parameters. In most cases, it is parameters for development, external modules, or hidden features which can allow some tweaking to your own Dolibarr instance. For standard usage of Dolibarr, such parameters MUST NOT be used.
This page contains the list of advanced hidden parameters. In most cases, it is parameters for development, external modules, or hidden features which can allow some tweaking to your own Dolibarr instance. For standard usage of Dolibarr, such parameters MUST NOT be used.


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




=List of Known Hidden Options=
=List of Known Hidden Options=
After Global Options, the list is sorted alphabetically.  The basic format of how the list is written is broken down in the example below:
HIDDEN_CONFIG ► ''Description of config'' ► ''(specific version information) or values''


==Global Options==
==Global Options==
{| class="wikitable sortable mw-collapsible"
 
!HIDDEN_CONFIG
*MAIN_DISABLE_NOTES_TAB ►Show or hide notes tab in the card page
!''Description of config''
 
!Version
*MAIN_DISABLE_CONTACTS_TAB ► Show or hide contacts tab in the card page
|-
 
|MAIN_DISABLE_NOTES_TAB
*MAIN_LOGOUT_GOTO_URL ► URL to which the user will be redirected after LOGOUT
|Show or hide notes tab in the card page
 
|
*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_DISABLE_CONTACTS_TAB
*MAIN_SHOW_TECHNICAL_ID ► Show also technical IDs on elements cards or some lists (not supported everywhere).
|Show or hide contacts tab in the card page
 
|
*MAIN_MAXTABS_IN_CARD ► Maximum number of tabs visible. Others are grouped into a combo list.
|-
 
|MAIN_LOGOUT_GOTO_URL
*MAIN_ONLY_LOGIN_ALLOWED ► Only the specified login is allowed to log in Dolibarr (maintenance mode).
|URL to which the user will be redirected after LOGOUT
 
|
*MAIN_AUTO_TIMESTAMP_IN_PUBLIC_NOTES ► Add a timestamp and user automatically when editing the ''public'' note.
|-
 
|MAIN_FILESYSTEM_ENCODING
*MAIN_AUTO_TIMESTAMP_IN_PRIVATE_NOTES ► Add a timestamp and user automatically when editing the ''private'' note.
|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_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_SHOW_TECHNICAL_ID
*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]]
|Show also technical IDs on elements cards or some lists (not supported everywhere).
 
|
*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_MAXTABS_IN_CARD
*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).
|Maximum number of tabs visible. Others are grouped into a combo list.
 
|
*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_ONLY_LOGIN_ALLOWED
*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.
|Only the specified login is allowed to log in Dolibarr (maintenance mode).
 
|
*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_AUTO_TIMESTAMP_IN_PUBLIC_NOTES
*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.
|Add a timestamp and user automatically when editing the ''public'' note.
 
|
*MAIN_OPTIMIZE_SPEED ► Use some speed enhancements. See page [[Increase_Performance]] for more information.
|-
 
|MAIN_AUTO_TIMESTAMP_IN_PRIVATE_NOTES
*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>.
|Add a timestamp and user automatically when editing the ''private'' note.
 
|
*MAIN_REPEATCONTACTONEACHTAB ► If added and set to 1, this adds contacts on all tabs, not only main tab.
|-
 
|MAIN_SECURITY_CSRF_WITH_TOKEN
*MAIN_DISABLE_JQUERY_JNOTIFY ► Disable usage of <code>JNotify</code> to show confirm or error messages
|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_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_APPLICATION_TITLE
*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.
|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_HELPCENTER_LINKTOUSE ► Define the URL link to use as the target page for link "I need help" onto logon page
|-
 
|MAIN_AUTOFILL_DATE
*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>'
|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_SHOW_TUNING_INFO ► Add tuning information into javascript console. Better when xdebug is enabled.
|-
 
|MAIN_DISABLE_FULL_SCANLIST
*MAIN_DOL_SCRIPTS_ROOT ► Define directory who contains 'scripts' directory (e.g. <code>/var/www/dolibarr</code>)
|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_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_FIRST_TO_UPPER
*MAIN_ADD_SALE_REP_SIGNATURE_IN_NOTE ► Add signature of the first sale representative into documents (at end of public notes).
|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_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_ENABLE_LOG_TO_HTML
*MAIN_USE_CACHE_MANIFEST ► Add an HTML5 cache manifest to the page - Attention, this functionality is obsolete and removed from web standards
|If this constant is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.
 
|
*MAIN_FORCELANGDIR ► Relative path of the directory holding your custom <code>langs</code> folder.
|-
 
|MAIN_USE_HOURMIN_IN_DATE_RANGE
*MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS ► Allow to define a default VAT rate
|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_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_REMOVE_INSTALL_WARNING
*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+)
|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_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_OPTIMIZE_SPEED
*MAIN_WEIGHT_DEFAULT_ROUND ► Accuracy of weight (number of decimals)
|Use some speed enhancements. See page [[Increase_Performance]] for more information.
 
|
*MAIN_WEIGHT_DEFAULT_UNIT ► Default unit for weight (0=kg, -3=g, ...)
|-
 
|MAIN_REPLACE_TRANS_xx_XX
*MAIN_VOLUME_DEFAULT_ROUND ► Accuracy of volume (number of decimals)
|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_VOLUME_DEFAULT_UNIT ► Default unit for weight (0=kg, -3=g, ...)
|-
 
|MAIN_REPEATCONTACTONEACHTAB
*MAIN_PUBLIC_NOTE_IN_ADDRESS ► Show public note in address block ► (v4.0+)
|If added and set to 1, this adds contacts on all tabs, not only main tab.
 
|
*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_DISABLE_JQUERY_JNOTIFY
*MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND ► Change way of rounding total TTC lines, rounding first of after.
|Disable usage of <code>JNotify</code> to show confirm or error messages.
 
|
*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_USE_JQUERY_JEDITABLE
*MAIN_DOC_USE_OBJECT_THIRDPARTY_NAME ► Add name of thirdparty at begin of generated document.
|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_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_USE_JQUERY_MULTISELECT
*MAIN_DISABLEDRAFTSTATUS ► Disable the status Draft for some objects (project, donation, ...)
|Allow to use Ajax when a choice that require multiselect is used (for the moment only external modules uses select box with multiselect values). Set the value to the jQuery plugin name to use (multiselect, multiple-select, select2…). Setting it to any other value will result in unwanted side-effects and/or bugs.
 
|
*MAIN_USE_OLD_SEARCH_FORM ► Display the old search form in left menu.
|-
 
|MAIN_HELPCENTER_LINKTOUSE
*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>.
|Define the URL link to use as the target page for link "I need help" onto logon page.
 
|
*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_MODULES_FOR_EXTERNAL
*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+)
|Limit available modules for external users. By default value is <code>facture,commande,contact,propal,projet,contrat,societe,ficheinter,expedition,agenda</code>.
 
|
*MAIN_ENABLE_IMPORT_LINKED_OBJECT_LINES ► Allow to import lines into current document from "linked" compatible documents ► (v8.0+)
|-
 
|MAIN_SHOW_TUNING_INFO
*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+)
|Add tuning information into javascript console. Better when xdebug is enabled.
 
|
*MAIN_SHOWDATABASENAMEINHELPPAGESLINK ► Show database name in upper help menu ► (v8.0+)
|-
 
|MAIN_DOL_SCRIPTS_ROOT
*MAIN_DISABLE_MULTIPLE_FILEUPLOAD ► Disable users to upload multiple files at once.
|Define directory who contains 'scripts' directory (e.g. <code>/var/www/dolibarr</code>)
 
|
*USER_HIDE_INACTIVE_IN_COMBOBOX ► Disable display inactive users in combobox.
|-
 
|MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING
*MAIN_SERVICES_ARE_ECOMMERCE_200238EC ► (< 8)
|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_DOC_UPLOAD_NOT_RENAME_BY_DEFAULT ► Disable the auto renaming on upload file ► (v10.0)
|-
 
|MAIN_ADD_SALE_REP_SIGNATURE_IN_NOTE
*MAIN_DEFAULT_LANGUAGE_FILTER ► Useful if you do not want to show en_US language option in combo boxes (other languages can easily be removed in langs directory but not en_US) ► (v10.0)
|Add signature of the first sale representative into documents (at end of public notes).
 
|
*NO_CONCAT_DESCRIPTION ► Allow to use only input custom description in lines (propale, order, invoice) ► (v10.0)
|-
 
|MAIN_DISABLE_AJAX_COMBOX
*ADD_UNSPLASH_LOGIN_BACKGROUND ► The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image). ► (v10.0)
|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_SERVICES_ARE_ECOMMERCE_200238EC
|
|< v8.0
|-
|MAIN_DOC_UPLOAD_NOT_RENAME_BY_DEFAULT
|Disable the auto renaming on upload file
|v10.0+
|-
|MAIN_DEFAULT_LANGUAGE_FILTER
|Useful if you do not want to show en_US language option in combo boxes (other languages can easily be removed in langs directory but not en_US)  
|v10.0+
|-
|NO_CONCAT_DESCRIPTION
|Allow to use only input custom description in lines (propale, order, invoice)
|v10.0+
|-
|ADD_UNSPLASH_LOGIN_BACKGROUND
|The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image).
|v10.0+
|}




Line 732: Line 609:
{| class="wikitable sortable"
{| class="wikitable sortable"
|+
|+
!HIDDEN_CONFIG
!Variable
!''Description of config''
!Fonction
!Version
!Valeurs possibles
!Version Dolibarr Mini
|-
|-
|CASHDESK_FORCE_STOCK_ON_BILL
|CASHDESK_FORCE_STOCK_ON_BILL
|Option to force decrease of stock whatever is user setup
|Option to force decrease of stock whatever is user setup
|v8.0.1+
|
|>= 8.0.1)
|-
|-
|SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED
|SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED
|Disable stock dispatch when total expected was already received
|Disable stock dispatch when total expected was already received
|
|
|-
|
|
|
|
|
|}
|}

Navigation menu