Setup Other: Difference between revisions

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Line 62: Line 62:
* MAIN_INPUT_DESC_HEIGHT => Number of lines in input area of product lines when editing invoices, proposals, orders, ...
* MAIN_INPUT_DESC_HEIGHT => Number of lines in input area of product lines when editing invoices, proposals, orders, ...


== PDF Options ==
== Module Tiers ==
* 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.
* SOCIETE_DISABLE_PROSPECTS => Remove all menu and features related to prospects
 
* MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.
 
* MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT => Hide all information about VAT on generated documents.
 
* MAIN_USE_BACKGROUND_ON_PDF => Define this constant with short name of an image (example "myimage.jpg") that must be saved into directory "documents/mycompany/logos". This will add this background image into your generated PDF files.
 
* MAIN_INVERT_SENDER_RECIPIENT =>  Invert sender and recipient in some PDF.
 
* MAIN_PROFIDx_IN_ADDRESS => Show the professional ID number x in address on PDF documents. You must replace x by 1,2,3 or 4.


== Commercial proposal module ==
== Commercial proposal module ==
Line 105: Line 95:
== Foundation module ==
== 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.
== PDF Options ==
* MAIN_DISABLE_FORCE_SAVEAS => If your browser ask always to save downloaded files on disk (like PDF), try to add this option. File might appears directly into your browser.
* MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.
* MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT => Hide all information about VAT on generated documents.
* MAIN_USE_BACKGROUND_ON_PDF => Define this constant with short name of an image (example "myimage.jpg") that must be saved into directory "documents/mycompany/logos". This will add this background image into your generated PDF files.
* MAIN_INVERT_SENDER_RECIPIENT =>  Invert sender and recipient in some PDF.
* MAIN_PROFIDx_IN_ADDRESS => Show the professional ID number x in address on PDF documents. You must replace x by 1,2,3 or 4.

Revision as of 17:10, 24 January 2011

Help about screen: Other setup

Menu path: Home -> Setup -> Other

Goal

This page is build to add/edit new parameters without a dedicated page build to edit them. In most cases, it is parameters for your own development, external modules, or hidden features.

List of known hidden options

Some options are not visible in the interface (often because they are deprecated or beta features). In most cases you do not need these functions and their use may make the application unstable.

To enable them you have to define a constant to 1 in Home - Setup - Other:

Global options

  • MAIN_APPLICATION_TITLE => This will change the title of software (that appears on the login page by default).
  • MAIN_DISABLE_FULL_SCANLIST => Constant to define to disable complete scan of tables to know the total amount of element to allow the pagination to show total number of pages. To activate on systems with a very important number of data (Tables with more than 500 000 records).
  • MAIN_LOGTOHTML => If this constants is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.
  • MAIN_AUTOFILL_DATE => If this constant is defined (to something else than 0), the date of invoice, proposal, order or payment are filled with current date. It is highly recommended to NOT ENABLE this feature. This create a lot of input errors with no validated data by users. This lead in bad values saved in database giving headaches when you have to do your accountancy reports ! However some users want it, so we provide it.
  • MAIN_MAIL_ALLOW_SENDMAIL_F => On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option -f. This option is here to ask Dolibarr to call the function mail of PHP by adding value for the option -f. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for rare setup of sendmail that ask the -f option to be mandatory.
  • 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_DEBUG => Write content with header of last mail into file dolibarr_mail.log into directory dolibarr_main_data_root.
  • MAIN_USE_HOURMIN_IN_DATE_RANGE => On all entities lines (invoice, order, contract...), it is possible to add hour and minutes with date on fields "date start" and "date end".
  • MAIN_REMOVE_INSTALL_WARNING => Remove all security warning that appears to administrator users if URL /install is public. You shoud solve the problem if warning occurs instead of removing this warning. For this, put a file called install.lock into Dolibarr root directory. This will remove warning but also make the page /install not possible to use to protect your installation.
  • MAIN_OPTIMIZE_SPEED => Use some speed enhancements.

If value of constant has bit 0 set, Dolibarr will use the minifying and compressed version of javascript. Apache server must be configured to have the line

AddType text/javascript .jgz
AddEncoding gzip .jgz

This feature seems to fails on HTTPS (security error for an unknown reason).

- If value of constant has bit 1 set, Dolibarr will use shared memory to cache translation of language files. This means that only one language can be used (the one defined by first user that log after the Apache server reboot). Use Module MemCached EN that has no limitations instead of this option.

- If value of constant has bit 2 defined (Example: MAIN_OPTIMIZE_SPEED=4), Dolibarr will return pages compressed into GZ (and if browser support it). This consume more CPU on server but reduce transfer time. Use it with slow connexion.

- To have all optimizations enabled, you must set all bits (Example: MAIN_OPTIMIZE_SPEED=7).

- Rem: To increase performance, you can also set your apache to activate cache of resources by adding the directives:

# Cache for static resources (Enable expiration and set it to one month)
ExpiresActive On
ExpiresByType image/x-icon A2592000
ExpiresByType image/gif A2592000
ExpiresByType image/png A2592000
ExpiresByType image/jpeg A2592000
ExpiresByType text/javascript A2592000
ExpiresByType application/javascript A2592000
  • MAIN_INPUT_DESC_HEIGHT => Number of lines in input area of product lines when editing invoices, proposals, orders, ...

Module Tiers

  • SOCIETE_DISABLE_PROSPECTS => Remove all menu and features related to prospects

Commercial proposal module

  • PROPALE_ADD_DELIVERY_ADDRESS => Activate old feature to input delivery addresses on proposals. You should not use this feature and use instead the tab "proposal contacts" to associate delivery addresses to a proposal.
  • 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.

Invoice module

  • FACTURE_SHOW_SEND_REMINDER => Show link "Send reminder by mail", same feature than "Send by mail" (obsolete feature).

Order module

  • COMMANDE_ADD_DELIVERY_ADDRESS => Activate old feature to input delivery addresses on orders or shippings. You should not use this feature and use instead the tab "proposal contacts" to associate delivery addresses to a an order or a shipping.
  • COMMANDE_REQUIRE_SOURCE => Make the input field "Source of order" mandatory.
  • COMMANDE_VALID_AFTER_CLOSE_PROPAL => When an order is created on a proposal close, the order is directly defined with status "Validated".
  • COMMANDE_ADD_DELIVERY_COST_LINE => Add a line with weight if weight is known for product and trigger FraisPort activated.

Export module

  • EXPORT_CSV_SEPARATOR_TO_USE => String value to use as separator to delimit fields int exported files (by default Dolibarr use ","). Example: EXPORT_CSV_SEPARATOR_TO_USE=;
  • EXPORT_CSV_FORCE_CHARSET => Choose the charset of file built by CSV export. By default: UTF-8. Example: EXPORT_CSV_FORCE_CHARSET=ISO-8859-1

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.

Product module

  • PRODUCT_ADD_TYPE_IN_DOCUMENTS => Add text "Product" or "Service" at beginning of details lines on built PDF documents.
  • PRODUCT_SHOW_WHEN_CREATE => Old option no more supported (create problems) to be able to add lines of product during first step of element creation.
  • PRODUCT_DONOTSEARCH_ANYWHERE => When Ajax search is enabled, search is done on criteria anywhere in label of product. By adding this option, search is done only on start of label. This is really faster when you have a huge number of products.

Service module

Foundation module

  • MEMBER_URL_REDIRECT_SUBSCRIPTION => Link called and shown when a member account is autocreated in member module by a guest user.

PDF Options

  • MAIN_DISABLE_FORCE_SAVEAS => If your browser ask always to save downloaded files on disk (like PDF), try to add this option. File might appears directly into your browser.
  • MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.
  • MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT => Hide all information about VAT on generated documents.
  • MAIN_USE_BACKGROUND_ON_PDF => Define this constant with short name of an image (example "myimage.jpg") that must be saved into directory "documents/mycompany/logos". This will add this background image into your generated PDF files.
  • MAIN_INVERT_SENDER_RECIPIENT => Invert sender and recipient in some PDF.
  • MAIN_PROFIDx_IN_ADDRESS => Show the professional ID number x in address on PDF documents. You must replace x by 1,2,3 or 4.