Changes

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

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

List of Known Hidden Options

The basic format of how the list is written is broken down in the example below:

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

<center>

<center>

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

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

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

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

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

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

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

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

 

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

*MAIN_DISABLE_TRUNC ► Disable all truncings in select list. (v7.0 and more)

*MAIN_DISABLE_TRUNC ► Disable all truncings in select list. (v7.0 and more)

*MAIN_DOC_SORT_FIELD ► Set the default sorting field on document page (name by default) ► (v11.0)

*MAIN_DOC_SORT_FIELD ► Set the default sorting field on document page (name by default) ► (v11.0)

*MAIN_DOC_SORT_ORDER ► Set the default sorting order (ASC or DESC) on document page (ASC by default) ► (v11.0)

*MAIN_DOC_SORT_ORDER ► Set the default sorting order (ASC or DESC) on document page (ASC by default) ► (v11.0)

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

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

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

*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_EXTERNAL_SMTP_CLIENT_IP_ADDRESS ► (A better name of this option should be MAIN_EXTERNAL_MAIL_CLIENT_IP_ADDRESS). Set here the list of IPs where your Dolibarr instances are hosted. So when your customer go into the setup area of email:

**If he chose mail method, a message will explain him how to setup its SPF record for its email domain (showing the list of IP). This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.

**If he chose smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD.

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

*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)]]

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

=Emailing Module=

=Emailing Module=

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

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

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

*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)]]

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

=Export Module=

=Export Module=

*MAIN_INVERT_SENDER_RECIPIENT ► Invert sender and recipient in some PDF.

*MAIN_INVERT_SENDER_RECIPIENT ► Invert sender and recipient in some PDF.

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

*MAIN_ODT_AS_PDF ► 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 '''jodconverter''' jar must exist, '''soffice''' must also be available. The constant <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> without scripts).

*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_ODT_AS_PDF_DEL_SOURCE ► For ODT generation. If set, then initial behaviour is conserved but ODT file is removed when option to convert it as PDF (see previous) is on. Disabled by default

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

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

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

*MAIN_TVAINTRA_IN_SOURCE_ADDRESS ► Show VAT N° in source address of PDF to comply with legalities in certain countries. Note that VAT number should be already visible in footer of page ► (v8.0.1+)

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

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

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

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

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

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

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

*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_USE_UNITS ► Add another units on products (Use same dictionnary as default unit feature) and propagate this unit on line of documents.

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

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

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

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

=Projects Module=

=Projects Module=

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

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

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

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

=Services Module=

=Services Module=

*SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED ► Disable stock dispatch when total expected was already received

*SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED ► Disable stock dispatch when total expected was already received

*STOCK_SUPPORTS_SERVICES ► Stock support services

*STOCK_SUPPORTS_SERVICES ► Stock support services

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

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

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

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

*SOCIETE_DISABLE_CUSTOMERS ► Remove all menu and features related to customers

*SOCIETE_DISABLE_CUSTOMERS ► Remove all menu and features related to customers

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

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

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

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

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

*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_CAN_HAVE_CATEGORY_EVEN_IF_NOT_CUSTOMER_PROSPECT_SUPPLIER ► Possible to add Categories to third parties that are not customer, prospect or supplier.

 

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

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

*THIRDPARTY_DEFAULT_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_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_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_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).

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

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

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

*THIRDPARTY_SUGGEST_ALSO_ADDRESS_CREATION ► Enabled contact creation on third-party create card

*THIRDPARTY_SUGGEST_ALSO_ADDRESS_CREATION ► Enabled contact creation on third-party create card

=STRIPE Module=

=STRIPE Module=

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

*STRIPE_FORCE_VERSION ► Force the STRIPE version. For Example: "2019-09-09" (v11+)

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

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

=For SaaS / Cloud hosting integrators=

=For SaaS / Cloud hosting integrators=

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

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

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

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

*MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS: (A better name of this option should be MAIN_EXTERNAL_MAIL_CLIENT_IP_ADDRESS). Set here the list of IPs where your Dolibarr instances are hosted. So when your customer go into the setup area of email:

*If you set a system limit on number of recipient, you can set some option to match the same values so users will be informed: 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.

- If he chose mail method, a message will explain him how to setup its SPF record for its email domain (showing the list of IP). This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.

 

*MAILING_LIMIT_WARNING_PHPMAIL ► Set this value to a translation key. Then add translation keys into the instance so user will see a message when into the email setup page. For example, you can set a message to say ''Warning: To avoid abuse, when using default setup, you are restricted to 500 emails per day for all your application (account may be suspended in case of violation of this rule. You can setup application to use your own SMTP server for sending email so you want have no restriction at all (see menu Home-Setup-Emails)''

- If he chose smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD.  

**If he chose smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD.

*MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD: Set here the string to add in the SPF record This string will be shown into a help message when the user in in the setup of email page and has choose a method using an external SMTP server.

*MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD ► Set here the string to add in the SPF record This string will be shown into a help message when the user in in the setup of email page and has choose a method using an external SMTP server.

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

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

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

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

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

*MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING ► If set to N, the warning saying modules are not activated will be shown if number of activated module is < N (Having this variable not defined is same than having it set to 1). This may be usefull if you preinstall an application with some modules already loaded by default and you want to keep the warning to be sure the user will enable other modules he need, even if some modules are already enabed.

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

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

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

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