Changes

Jump to navigation Jump to search
m
no edit summary
Line 19: Line 19:  
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.
   −
To enable/override a parameter you have to define the constant name and set it to '''1''' (unless othwerwise 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>
      Line 66: Line 66:  
* '''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_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_JEDITABLE''' ► Allow to update from screen, directly into database, some properties of elements (invoices, proposals, ...) using Ajax. This make response time faster, but avoid using this feature, because it bypasses some business actions (updates on other data that should be done consistently) and ignores business controls on data you saved. Consequently this feature breaks consistency of data and possibly the stability of the software.
    
* '''MAIN_USE_JQUERY_MULTISELECT''' ► Allow to use Ajax when a choice that require multiselect is used (for the moment only external modules uses select box with multiselect values). Set the value to the jQuery plugin name to use (multiselect, multiple-select, select2…). Setting it to any other value will result in unwanted side-effects and/or bugs.
 
* '''MAIN_USE_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.
Line 120: Line 120:  
* '''MAIN_USE_OLD_SEARCH_FORM''' ► Display the old search form in left menu.
 
* '''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_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_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+)
Line 180: Line 180:  
* '''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_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 ask 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_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_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.
Line 196: Line 196:  
* '''MAIN_EMAIL_USECCC''' ► 1 = Show field BCC into email forms, If email = Show BCC prefilled with email.
 
* '''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_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.
 
* '''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.
Line 210: Line 210:  
* '''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 will appears into the help on the email setup page.
+
* '''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+)
 
* '''MAIN_MAIL_ENABLED_USER_DEST_SELECT''' ► Show also internal users into list of recipients of email in email sending form ► (v8.0+)
Line 227: Line 227:  
* '''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.
 
* '''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 destinaries
+
* '''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_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.
Line 238: Line 238:  
* '''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_IK''' ► This feature allows you to set index kilometers against a mileage index for different types of vehicles. ► (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+)
Line 260: Line 260:  
* '''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.
   −
* '''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.
+
* '''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)]]
 
[[#Top|(back to top)]]
   Line 276: Line 276:  
* '''FACTURE_SHOW_SEND_REMINDER''' ► Show link "Send reminder by mail", same feature than "Send by mail" ''(obsolete feature)''.
 
* '''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_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 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 read-only archive log.
    
* '''INVOICE_CAN_NEVER_BE_REMOVED''' ► Never allow to delete invoices (except draft invoices).
 
* '''INVOICE_CAN_NEVER_BE_REMOVED''' ► Never allow to delete invoices (except draft invoices).
Line 292: Line 292:  
* '''FACTURE_SENDBYEMAIL_FOR_ALL_STATUS''' ► Can send invoice by email to customer even if invoice has status "draft".
 
* '''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. (it's work with crabe template)
+
* '''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_CREDIT_NOTE_STANDALONE''' ► Can make a credit note without invoice. ► (v3.9)
Line 314: Line 314:  
* '''FACTURE_ENABLE_NEGATIVE_LINES''' ► Allows to add negative lines to an invoice ► (v8.0.2+)
 
* '''FACTURE_ENABLE_NEGATIVE_LINES''' ► Allows to add negative lines to an invoice ► (v8.0.2+)
   −
* '''INVOICE_USE_DEFAULT_DOCUMENT''' ► This new configurations allow user to select à default invoice documents models according to invoice type. On invoice create page, the model is dynamicaly change on invoice type selection. ► (v9.0+)
+
* '''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+)
 
[[#Top|(back to top)]]
 
[[#Top|(back to top)]]
    
== '''Look or Theme''' ==
 
== '''Look or Theme''' ==
* '''MAIN_OPTIMIZEFORTEXTBROWSER''' ► Optimize output rendering for usage of a text browser (usefull for blind people)
+
* '''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+)
 
* '''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 autorized rather than just grey them
+
* '''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+)
 
* '''THEME_TOPMENU_STICKY_POSITION''' ► Option to fix top menu with eldy theme ► (v7.0+)
Line 347: Line 347:     
== '''PDF Options''' ==
 
== '''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_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_DISABLE_PDF_COMPRESSION''' ► Disable PDF compression.
Line 355: Line 355:  
* '''MAIN_DISABLE_PDF_AUTOUPDATE''' ► Disable automatic generation of PDF each time we add/update/delete a product line (we can still build document by clicking on "Generate"). This option may increase interface speed on servers with low CPU.
 
* '''MAIN_DISABLE_PDF_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_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_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]].
Line 547: Line 547:     
== '''Third Parties Module''' ==
 
== '''Third Parties Module''' ==
* '''COMPANY_AQUARIUM_CLEAN_REGEX''' ► 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 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)
    
* '''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)
 
* '''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 593: Line 593:     
== '''WYSIWYG Editor''' ==
 
== '''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.
+
* '''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)]]
 
[[#Top|(back to top)]]
98

edits

Navigation menu