27,403
edits
Changes
Jump to navigation
Jump to search
mLine 15:
Line 15: − =Introduction=+ + + + + Line 24:
Line 28: − =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==+ Line 44:
Line 54: + Line 57:
Line 68: − + − − *MAIN_DISABLE_MULTIPLE_FILEUPLOAD ► Disable users to upload multiple files at once. Line 159:
Line 168: + + + − ==Accountancy Module==+ Line 171:
Line 183: − ==Agenda Module==+ Line 186:
Line 198: − ==Bank Module==+ Line 199:
Line 211: − ==BlockedLog==+ Line 206:
Line 218: − ==Contracts==+ Line 213:
Line 225: − ==Direct Debit Orders==+ − ==Email and SMS==+ + Line 259:
Line 272: − + + + + − + − ==Emailing Module== Line 285:
Line 300: − ==Expense Report==+ + + Line 294:
Line 311: − − *OVERRIDE_VAT_FOR_EXPENSE_REPORT ► Setting constant OVERRIDE_VAT_FOR_EXPENSE_REPORT to 1 will allow expense reports to show VAT even if the global VAT setting is off ► (v10.0) − ==Export Module==+ Line 313:
Line 328: − ==Foundation Module==+ Line 322:
Line 337: − ==Interventions Module==+ Line 331:
Line 346: − ==Invoice Module==+ Line 381:
Line 396: + − ==Look or Theme==+ + Line 410:
Line 427: − ==MultiCurrency==+ + + Line 417:
Line 436: − ==Order Module==+ Line 430:
Line 449: + + − ==PDF Options== − *ADD_HTML_FORMATING_INTO_DESC_DOC ► Add more visibility to important informations like reference and serial number in desc. ► (v10.0)+ Line 463:
Line 483: − + Line 483:
Line 503: − + Line 499:
Line 519: − + − + Line 512:
Line 532: + + + + − + − ==Point of Sale (POS)==+ Line 530:
Line 554: − ==Products Module==+ + Line 564:
Line 589: + + Line 572:
Line 599: − + + − ==Projects Module==+ Line 605:
Line 633: − ==Proposals Module==+ Line 622:
Line 650: + + − + − ==Services Module== Line 633:
Line 662: − ==Shipments==+ Line 642:
Line 671: − ==Stocks==+ Line 648:
Line 677: + − ==Suppliers Module==+ + Line 674:
Line 705: − Line 680:
Line 710: − ==Third Parties Module==+ − − *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) Line 692:
Line 720: − + − + − + − − *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+) Line 705:
Line 731: + + + + − − *SOCIETE_ASK_FOR_SHIPPING_METHOD ► Shipping method can be predefined on customer card and will be used as default on order creation − *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. − ==VAT Report==+ Line 728:
Line 753: − ==WYSIWYG Editor==+ Line 735:
Line 760: − ==STRIPE Module==+ − + − ==For SaaS / Cloud hosting integrators==+ + + + + − + − - 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. + + + − + − + − + − + − + − +
→PDF Options
'''Menu Path''': Home ► Setup ► Other
'''Menu Path''': Home ► Setup ► Other
'''Introduction'''
Some options are not visible in the interface (often because they are deprecated or are beta features). In most cases you do not need these functions and their use may make the application unstable.
Some options are not visible in the interface (often because they are deprecated or are beta features). In most cases you do not need these functions and their use may make the application unstable.
{{warning|32px}} This page contains the list of some advanced hidden parameters. In most cases, it is parameters for internal usage, development, external modules, features in development not stable or that may lead to security risk. For standard usage of Dolibarr, such parameters '''SHOULD NOT''' be used. All hidden options are NOT supported. They may be removed in a future, modified at any version and break stability of your application.
{{warning|32px}} This page contains the list of some advanced hidden parameters. In most cases, it is parameters for internal usage, development, external modules, features in development not stable or that may lead to security risk. For standard usage of Dolibarr, such parameters '''SHOULD NOT''' be used. All hidden options are NOT supported. They may be removed in a future, modified at any version and break stability of your application.
To enable/override a parameter you have to define the constant name and set it to 1 (unless otherwise stated) in <code>Home ► Setup ► Other Setup</code>
To enable/override a parameter you have to define the constant name and set it to 1 (unless otherwise stated) in <code>Home ► Setup ► Other Setup</code>
Here is a "todo list" showing wich options are not yet documented (for V11 on 01/12/2019) : [[Setup Other todolist]]
Here is a "todo list" showing wich options are not yet documented (for V11 on 01/12/2019) : [[Setup Other todolist]]
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>
<div class="toclimit-1 tocinline">
__TOC__
</div>
</center>
=Global Options=
*ADD_UNSPLASH_LOGIN_BACKGROUND ► The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image). ► (v10.0)
*ADD_UNSPLASH_LOGIN_BACKGROUND ► The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image). ► (v10.0)
*MAIN_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_PAYMENT_TYPE_ID► With ID of a payment type, will use this as default payment type each time you create a new proposal, order, invoice (customer and supplier) ► (v12.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_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_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)
*MAIN_USE_ZIPTOWN_DICTIONNARY► Use dictionnary ZIP for create card.
*MAIN_USE_TOP_MENU_BOOKMARK_DROPDOWN► Show bookmark in top menu with theme eldy ► (v11.0)
*MAIN_USE_TOP_MENU_SEARCH_DROPDOWN► Show search in top menu with theme eldy ► (v11.0)
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=Accountancy Module=
*ACCOUNTANCY_COMBO_FOR_AUX ► Add graphic option for ACCOUNTANCY_COMBO_FOR_AUX ► (v10.0)
*ACCOUNTANCY_COMBO_FOR_AUX ► Add graphic option for ACCOUNTANCY_COMBO_FOR_AUX ► (v10.0)
[[#Top|(back to top)]]
[[#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_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.
=Bank Module=
*BANK_CAN_RECONCILIATE_CASHACCOUNT ► Can reconciliate cash accounts ► (v3.8)
*BANK_CAN_RECONCILIATE_CASHACCOUNT ► Can reconciliate cash accounts ► (v3.8)
=BlockedLog=
*BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY ► Make disable of module "blockedlog" not possible for countries code defined into value. Example: 'FR,...'
*BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY ► Make disable of module "blockedlog" not possible for countries code defined into value. Example: 'FR,...'
=Contracts=
*CONTRACT_SUPPORT_PRODUCTS ► Products are also suggested into module contract.
*CONTRACT_SUPPORT_PRODUCTS ► Products are also suggested into module contract.
=Direct Debit Orders=
*WITHDRAWAL_ALLOW_ANY_INVOICE_STATUS ► If this option is set, all invoices status (even already paid) may appear on the list of invoices qualified for a direct debit payment. This is the list of invoices with a payment request done, and not linked to a direct debit payment. By default, only "unpayed" invoices are used to avoid to pay twice the same invoice.
*WITHDRAWAL_ALLOW_ANY_INVOICE_STATUS ► If this option is set, all invoices status (even already paid) may appear on the list of invoices qualified for a direct debit payment. This is the list of invoices with a payment request done, and not linked to a direct debit payment. By default, only "unpayed" invoices are used to avoid to pay twice the same invoice.
=Email and SMS=
*MAIN_MAILFORM_DISABLE_ENTERKEY ► Activate javascript code to disable the enter key in the MAIL form. ► (>= 8.0.1)
*MAIN_MAILFORM_DISABLE_ENTERKEY ► Activate javascript code to disable the enter key in the MAIL form. ► (>= 8.0.1)
*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=
*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_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.
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=Expense Report=
*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_OVERRIDE_VAT ► Setting constant EXPENSEREPORT_OVERRIDE_VAT to 1 will allow expense reports to show VAT even if the global VAT setting is off ► (v10.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_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_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>
=Foundation Module=
*MEMBER_URL_REDIRECT_SUBSCRIPTION ► Link called and shown when a member account is autocreated in member module by a guest user.
*MEMBER_URL_REDIRECT_SUBSCRIPTION ► Link called and shown when a member account is autocreated in member module by a guest user.
=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_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.
=Invoice Module=
*MAIN_DEPOSIT_MULTI_TVA ► In deposits invoice, creates one line per VAT rate from the origin document ► (6.0)
*MAIN_DEPOSIT_MULTI_TVA ► In deposits invoice, creates one line per VAT rate from the origin document ► (6.0)
*FACTURE_REUSE_NOTES_ON_CREATE_FROM ► Reuse the Public Note and Private note of the previous object (Proposal,...) when creating the bill.
*FACTURE_REUSE_NOTES_ON_CREATE_FROM ► Reuse the Public Note and Private note of the previous object (Proposal,...) when creating the bill.
*MAIN_SHOW_FACNUMBER_IN_DISCOUNT_LIST ► Display the reference of credit notes in discount list when creating the bill.
*MAIN_SHOW_FACNUMBER_IN_DISCOUNT_LIST ► Display the reference of credit notes in discount list when creating the bill.
*INVOICE_ALLOW_FREE_REF ► Apability to change reference of an invoice. This will be possible as long as the invoice has the status “Draft” and only if your country is not in Europe(V11)
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=Look or Theme=
*MAIN_FAVICON_URL ► favicon url
*MAIN_FAVICON_URL ► favicon url
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=MultiCurrency=
*MAIN_MULTICURRENCY_ALLOW_SYNCHRONIZATION ► Enable CurrencyLayer API synchronization
*MAIN_MULTICURRENCY_ALLOW_SYNCHRONIZATION ► Enable CurrencyLayer API synchronization
=Order Module=
*COMMANDE_REQUIRE_SOURCE => Make the input field "Source of order" mandatory.
*COMMANDE_REQUIRE_SOURCE => Make the input field "Source of order" mandatory.
*THIRDPARTY_PROPAGATE_EXTRAFIELDS_TO_ORDER => Copy extrafields from thirdparty to order. ► (v11.0+)
*THIRDPARTY_PROPAGATE_EXTRAFIELDS_TO_ORDER => Copy extrafields from thirdparty to order. ► (v11.0+)
*MAIN_USE_PROPAL_REFCLIENT_FOR_ORDER => Copy customer reference from proposal to order. ► (v7.0+)
*MAIN_USE_PROPAL_REFCLIENT_FOR_ORDER => Copy customer reference from proposal to order. ► (v7.0+)
*ORDER_ENABLE_NEGATIVE => Can validate an order when amount is negative
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=PDF Options=
*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_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_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+)
*MAIN_PROFID6_IN_SOURCE_ADDRESS ► Show Professional ID 6 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)
*MAIN_PROFID6_IN_SOURCE_ADDRESS ► Show Professional ID 6 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)
*PDF_SHOW_PROJECT ► Show project onto PDF (supported on supplier order only for the moment)
*PDF_BANK_HIDE_NUMBER_SHOW_ONLY_BICIBAN ► Hide bank number ("code banque/guichet/compte" for France, "sort code/account number" for GB, ...) and keep only BIC/IBAN on PDF.
*PDF_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_BOLD_PRODUCT_REF_AND_PERIOD ► Add more visibility (bold) on product ref and period of service in desc. ► (v12.0)
*PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES ► Modify the use/position of Supplier Ref/Internal Ref with the item Label (name) on PDF documents.
*PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES ► Modify the use/position of Supplier Ref/Internal Ref with the item Label (name) on PDF documents.
*PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME ► Include alternative/alias name into name on PDF.
*PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME ► Include alternative/alias name into name on PDF.
*PDF_SECURITY_ENCRYPTION ► Encrypt PDF produced by dolibarr ► (v?) . See additional parameters :PDF_SECURITY_ENCRYPTION_RIGHTS (block 'modify' or 'copy') - PDF_SECURITY_ENCRYPTION_USERPASS - PDF_SECURITY_ENCRYPTION_OWNERPASS (random if not specified) - PDF_SECURITY_ENCRYPTION_STRENGTH (0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit) - PDF_SECURITY_ENCRYPTION_PUBKEYS Array of recipients containing public-key certificates ('c') and permissions ('p') - For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print')))
*PDF_SHOW_PROJECT ► Show project onto PDF (supported on supplier order only for the moment)
*PDF_USE_1A ► PDF files produced by dolibarr respect PDF/A standard ► (v?)
*PDF_USE_1A ► PDF files produced by dolibarr respect PDF/A standard ► (v?)
*PDF_SECURITY_ENCRYPTION ► Encrypt PDF produced by dolibarr ► (v?) . See additional parameters :PDF_SECURITY_ENCRYPTION_RIGHTS (block 'modify' or 'copy') - PDF_SECURITY_ENCRYPTION_USERPASS - PDF_SECURITY_ENCRYPTION_OWNERPASS (random if not specified) - PDF_SECURITY_ENCRYPTION_STRENGTH (0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit) - PDF_SECURITY_ENCRYPTION_PUBKEYS Array of recipients containing public-key certificates ('c') and permissions ('p') - For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print')))
*PDF_USE_ALSO_LANGUAGE_CODE ► The value of this constant must be a language code ('fr_FR', 'en_US', 'sa_SA', ...). If set, the PDF document will contains both language (default and the one defined by the constant).
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=Point of Sale (POS)=
*CASHDESK_SHOW_KEYPAD ► Show a mouse key pad into the 'Simple Point of Sale' module.
*CASHDESK_SHOW_KEYPAD ► Show a mouse key pad into the 'Simple Point of Sale' module.
[[#Top|(back to top)]]
[[#Top|(back to top)]]
=Products Module=
*CATEGORY_GRAPHSTATS_ON_PRODUCTS ► Show graph of products with categories and totals in Products Area screen
*CATEGORY_GRAPHSTATS_ON_PRODUCTS ► Show graph of products with categories and totals in Products Area screen
*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.
*PRODUIT_CUSTOMER_PRICES_BY_QTY ► If price per quantity ► Experimental
*PRODUIT_CUSTOMER_PRICES_BY_QTY_MULTIPRICES ► If price per quantity and customer ► Experimental
*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+)
*PRODUCT_SHOW_ORIGIN_IN_COMBO ► Show origin of products when adding lines in proposals/invoices/orders (v12.0+)
[[#Top|(back to top)]]
[[#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_DISABLE_UNLINK_FROM_OVERVIEW ► Enable removing the button from a link in the project overview. ► (>= 8.0.1)
=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.
*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_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+)
*PROPOSAL_AUTO_ADD_AUTHOR_AS_CONTACT ► Add Proposal Author as user contact follow proposal
*PROPALE_PDF_HIDE_PAYMENTTERMMODE ► Do not show the payment mode on proposal ► (v7.0+)
[[#Top|(back to top)]]
[[#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.
*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.
=Shipments=
*STOCK_WAREHOUSE_NOT_REQUIRED_FOR_SHIPMENTS ► If set, you can add a shipment line, with no stock source defined. ► (>= 8.0.1)
*STOCK_WAREHOUSE_NOT_REQUIRED_FOR_SHIPMENTS ► If set, you can add a shipment line, with no stock source defined. ► (>= 8.0.1)
=Stocks=
*CASHDESK_FORCE_STOCK_ON_BILL ► Option to force decrease of stock whatever is user setup
*CASHDESK_FORCE_STOCK_ON_BILL ► Option to force decrease of stock whatever is user setup
*SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED ► Disable stock dispatch when total expected was already received
*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
*USER_DEFAULT_WAREHOUSE ►Show warehouse in user card ► (v11.0)
[[#Top|(back to top)]]
[[#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.''
*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.''
*MAIN_CAN_EDIT_SUPPLIER_ON_SUPPLIER_ORDER ► Allow to change the supplier on a draft supplier order ► (v10.0)
*MAIN_CAN_EDIT_SUPPLIER_ON_SUPPLIER_ORDER ► Allow to change the supplier on a draft supplier order ► (v10.0)
[[#Top|(back to top)]]
[[#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)
*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_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_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".
*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
[[#Top|(back to top)]]
[[#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+)
*MAIN_INCLUDE_ZERO_VAT_IN_REPORTS ► Include lines with VAT to 0% (for "auto-liquidation" in EEC) ► (v8.0.3+)
=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.
*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.
=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=
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.
*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]].
*CRON_DISABLE_TUTORIAL_CRON ► Disable the tutorial about how to install the cron script (on a SaaS hosting, this should be the system)
*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.
*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)''
*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_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.