Core Settings Sugar CRM
9:30Sugar configuration settings.
Settings Architecture
When you first install Sugar, all of the default settings are located in
./config.php. As you begin configuring the system, the modified settings are stored in./config_override.php. Settings in ./config.php are overridden by the values in./config_override.php.Settings
addAjaxBannedModules (Deprecated in future release)
| Description | Disables a module from being loaded using the AJAX UI. This is generally used if you are experiencing display issues with modules and want to prevent it from being loaded by the AJAX UI. |
| Type | Array : Module list |
| Versions | 6.3.0 - 6.7.12 |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
admin_access_control
| Description | Removes Sugar Updates, Upgrade Wizard, Backups and Module Builder from the Admin menu. For developers, these restrictions can be found in./include/MVC/Controller/file_access_control_map.php and overriden by creating./custom/include/MVC/Controller/file_access_control_map.php. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
admin_export_only
| Description | Allow only users with administrative privileges to export data. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
allow_pop_inbound
| Description | Inbound email accounts are setup to work with IMAP protocols by default. If your email provider required POP3 access instead of IMAP, you can enables POP3 as an available inbound email protocol. Please note that mailboxes configured with a POP3 connection are not supported by SugarCRM and may cause unintended consequences. IMAP is the recommended protocol to use for inbound email accounts. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.5.1+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
allow_sendmail_outbound
| Description | Enables the option of choosing sendmail as an SMTP server in Admin > Email Settings. Sendmail must be enabled on the server for this option to work. Please note that mailboxes configured with sendmail are not supported and may cause unintended consequences. Instances running on the On-Demand environment will have this setting enforced as false. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.5.1+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | false |
| Override Example | |
cache_dir
| Description | This is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory. |
| Type | String : Directory |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | cache/ |
| Override Example | |
cache_expire_timeout
| Description | The length of time cached items should be expired after. |
| Type | Integer : Seconds |
| Versions | 6.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 300 |
| Override Example | |
calendar
| Description | An array that defines all of the various settings for the Calendar module. |
| Type | Array |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
calendar.day_timestep
| Description | Sets the default day time step. |
| Type | Integer : Days |
| Range of values | 15, 30 and 60 |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 15 |
| Override Example | |
calendar.default_view
| Description | Changes the default view in the calendar module. |
| Type | String |
| Range of values | 'day', 'week', 'month' and 'share' |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
calendar.items_draggable
| Description | Enable/Disable drag-and-drop feature to move calendar items. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
calendar.items_resizable
| Description | Sets whether items on the calendar can be resized via clicking and dragging. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
calendar.show_calls_by_default
| Description | Display/Hide calls by default. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
calendar.week_timestep
| Description | The default week step size when viewing the calendar. |
| Type | Integer : Calendar Step Size |
| Range of values | 15, 30, and 60 |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
check_query
| Description | Validates queries when adding limits. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
check_query_cost
| Description | Sets the maximum cost limit of a query. |
| Type | Integer |
| Versions | 5.2.0+ |
| Editions | Ent, Ult |
| Default Value | 10 |
| Override Example | |
cron
| Description | Array that defines all of the cron parameters. |
| Type | Array |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
cron.max_cron_jobs
| Description | Maximum jobs per cron run. Default is 10. If you are using a version prior to 6.5.14, you will need to also populate max_jobsto set this value due to bug #62936 ( https://web.sugarcrm.com/support/issues/62936 ). |
| Type | Integer |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 10 |
| Override Example | |
cron.max_cron_runtime
| Description | Determines the maximum time in seconds that a single job should be allowed to run. If a single job exceeds this limit, cron.php is aborted with the long-running job marked as in progress in the job queue. The next time cron runs, it will skip the job that overran the limit and start on the next job in the queue. This limit is only enforced when cron.enforce_runtime is set to true. |
| Type | Integer : Seconds |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 180 |
| Override Example | |
cron.min_cron_interval
| Description | Minimum time between cron runs. Setting this to 0 will disable throttling completely. |
| Type | Integer : Seconds |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 30 |
| Override Example | |
custom_help_url
| Description | Designate the URL used to redirect the user to help documentation. |
| Type | String : Website address |
| Versions | 6.4.3+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | http://www.sugarcrm.com/crm/product_doc.php |
| Override Example | |
dashlet_display_row_options (Deprecated in future release)
| Description | Determines the number of rows displayed in the 6.x dashlet options. This setting is deprecated as of 7.x. To modify the dashlet row configuration in 7.x you will need to navigate to Admin > Dropdown Editor and edit the dashlet_limit_optionslist. |
| Type | Array |
| Range of values | 1, 3, 5, 10 |
| Versions | 5.2.0 - 6.7.12 |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 5 |
| Override Example | |
dbconfig
| Description | Defines all of the connection parameters for the database server. |
| Type | Array |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
dbconfig.db_host_instance
| Description | Defines the host instance for MSSQL connections. |
| Type | String |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
dbconfig.db_type
| Description | Defines the type of database being used with Sugar. It is important to note that db2 and oracle are only applicable to the Ent and Ult editions of Sugar. |
| Type | String : Database Enigine |
| Range of values | 'mysql', 'mssql', 'db2', and 'oracle' |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
dbconfig.db_user_name
| Description | Defines the user to connect to the Sugar database as. |
| Type | String : Database User |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
default_currency_significant_digits
| Description | Changes the number of significant digits in currency by default. |
| Type | Integer : Number of significant digits |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 2 |
| Override Example | |
default_date_format
| Description | Modifies the default date format for all users. |
| Type | String : Date format |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | m/d/Y |
| Override Example | |
default_decimal_seperator
| Description | Sets the character used as a decimal separator for numbers. |
| Type | String : Text character |
| Range of values | Any character |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | . |
| Override Example | |
default_email_client
| Description | Sets the default email client that opens when users send emails. |
| Type | String : Email client |
| Range of values | 'sugar', 'external' |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | sugar |
| Override Example | |
default_language
| Description | Sets each user's default language. Possible values include any language offered by Sugar, such as: 'ar_SA', 'bg_BG', 'ca_ES', 'cs_CZ', 'da_DK', 'de_DE', 'el_EL', 'en_UK', 'en_us', 'es_ES', 'es_LA', 'et_EE', 'fi_FI', 'fr_FR', 'he_IL', 'hu_HU', 'it_it', 'ja_JP', 'ko_KR', 'lt_LT', 'lv_LV', 'nb_NO', 'nl_NL', 'pl_PL', 'pt_BR', 'pt_PT', 'ro_RO', 'ru_RU', 'sk_SK', 'sq_AL', 'sr_RS', 'sv_SE', 'tr_TR', 'uk_UA', 'zh_CN' |
| Type | String : Language key |
| Range of values | Any available language |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | en_us |
| Override Example | |
default_number_grouping_seperator
| Description | Sets the character used as the 1000s separator for numbers. |
| Type | String : Text character |
| Range of values | Any character |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | , |
| Override Example | |
default_permissions
| Description | Array that defines the ownership and permissions for directories and files created naturally by the application. |
| Type | Array |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
default_permissions.dir_mode
| Description | Part of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created directories. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 1528 equates to the permissions 2770. Instances running on the On-Demand environment will have this setting enforced as 1528. |
| Type | Integer : Octal Value |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| On-Demand Value | 1528 |
| Override Example | |
default_permissions.file_mode
| Description | Part of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created files. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 432 in equates to the permissions 660. Instances running on the On-Demand environment will have this setting enforced as 432. |
| Type | Integer : Octal value |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| On-Demand Value | 432 |
| Override Example | |
default_permissions.group
| Description | Used in UNIX-based systems only to define the group membership of any newly created directories and files. This value should be a group that the Apache user is a member of to help ensure proper functionality. Instances running on the On-Demand environment will have this setting enforced asempty. |
| Type | String : Web group |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| On-Demand Value | empty |
| Override Example | |
default_permissions.user
| Description | Part of the 'default_permissions' array. Used in UNIX-based systems only to define the ownership of any newly created directories and files. This value should be the Apache user. Instances running on the On-Demand environment will have this setting enforced as empty. |
| Type | String : Web user |
| Range of values | Apache user |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| On-Demand Value | empty |
| Override Example | |
default_user_is_admin
| Description | Allows for determining whether a user is a system administrator by default. |
| Type | Boolean |
| Range of values | true, false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
developerMode
| Description | Rebuilds various cached files when a page is accessed. Can be set by an admin in Admin > System Settings. Instances running on the On-Demand environment will have this setting enforced as false. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | false |
| Override Example | |
disable_count_query
| Description | Removes the count totals from listviews. This is commonly used to prevent performing expensive count queries on the database when loading listviews and subpanels. It is important to note that in 7.x, this parameter will only affect modules running in Backward Compatibility mode. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
disable_export
| Description | Prevents exports of data into .csv files. Normally set in the UI via Admin > Locale. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
disable_uw_upload
| Description | Disables the upgrade wizard from being accessible through the Sugar admin interface. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0.j+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
disable_vcr
| Description | Disables record paging in the detailview (VCR controls). Increases performance by not loading all records from a listview into memory when accessing the record detailview. In 7.x versions, this setting is only applicable to modules running in Backward Compatibility Mode. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
dump_slow_queries
| Description | Logs slow queries to the sugar log file. Instances running on the On-Demand environment will have this setting enforced as false. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | false |
| Override Example | |
email_address_separator
| Description | Sets the character used to separate email addresses. |
| Type | String : Text character |
| Range of values | Any character |
| Versions | 6.4.3+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | , |
| Override Example | |
email_default_client
| Description | Sets the default email client for all users. |
| Type | String : String |
| Range of values | sugar, external |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | sugar |
| Override Example | |
enable_inline_reports_edit
| Description | Allows a user to edit specific field types (e.g. dropdowns, text fields) in a rows and columns report without having to navigate directly to the record. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.3.0+ |
| Editions | Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
external_cache_disabled
| Description | Disables all external caching in Sugar. This is normally set to true to determine if there is a conflict with PHP caching. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
external_cache_disabled_memcache
| Description | Disables Memcache caching in Sugar. Recommended setting is false. This setting is normally normall only enabled to determine if there is a conflict with PHP caching. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Array |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
external_cache_disabled_memcached
| Description | Disables Memcached caching from working with Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
external_cache_disabled_smash
| Description | Disables Smash caching in Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0c+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
forms
| Description | An array defining form requirements. |
| Type | Array |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
forms.requireFirst
| Description | Presents all required fields grouped together in the first panel on the EditView form. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
hide_admin_backup
| Description | Removes the Backups option in the admin menu and also prevents direct access to the feature. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.5.1+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
hide_full_text_engine_config
| Description | Determines if the FTS settings are present in the admin search page in Admin > Search. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.5.15+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
hide_subpanels
| Description | This setting only applies to modules running in Backward Compatibility Mode. When a DetailView is loaded, all subpanels are collapsed. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
hide_subpanels_on_login
| Description | This setting only applies to modules running in backward compatibility mode. Collapses subpanels per session. When a DetailView is initially loaded during a session, all subpanels are collapsed. Once explanded, it will remain expanded until the user logs out. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
installer_locked
| Description | Sets whether the installer is locked or not. When false, it is possible to access Sugar's initial configuration page to reinstall the instance. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| On-Demand Value | true |
| Override Example | |
jobs
| Description | Job Queue configurations. |
| Type | Array |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
jobs.hard_lifetime
| Description | Hard deletes all jobs that are older than the hard cutoff. Default is 21 days. |
| Type | Integer : Days |
| Versions | 6.5.1+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 21 |
| Override Example | |
jobs.max_retries
| Description | Maximum number of failures for job. Default is 5. |
| Type | Integer : Number of failures |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 5 |
| Override Example | |
jobs.min_retry_interval
| Description | Minimal interval between job reruns. Default is 30 seconds. |
| Type | Integer : Seconds |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 30 |
| Override Example | |
jobs.soft_lifetime
| Description | Soft deletes all jobs that are older than cutoff. Default is 21 days. |
| Type | Integer : Days |
| Versions | 6.5.1+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 7 |
| Override Example | |
jobs.timeout
| Description | If a job is running longer than the limit, the job is failed by force. Specified in seconds. Default is 3600 seconds (1 hour). |
| Type | Integer : Seconds |
| Versions | 6.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 3600 |
| Override Example | |
list_max_entries_per_page
| Description | Listview items per page. |
| Type | String : Records per page |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 20 |
| Override Example | |
list_report_max_per_page
| Description | Sets the maximum number of reports that are listed on each page in the Reports module. |
| Type | Integer : Number of records |
| Versions | 5.2.0+ |
| Editions | Pro, Corp, Ent, Ult |
| Default Value | 100 |
| Override Example | |
lock_homepage (Deprecated in future release)
| Description | Prevents users from being able to customize the Homepage layout. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0 - 6.7.12 |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
logger
| Description | An array that defines all of the logging settings. |
| Type | Array |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
logger.file.dateFormat
| Description | The date format for the log file is any value that is acceptable to the PHP strftime() function. The default is '%c'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php. |
| Type | String : Date format |
| Range of values | Pattern for date format |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | %c |
| Override Example | |
logger.file.ext
| Description | The extension of the log file. The default value is '.log'. Instances running on the On-Demand environment will have this setting enforced as .log. |
| Type | String : File extension |
| Range of values | Extension for the log |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | .log |
| On-Demand Value | .log |
| Override Example | |
logger.file.maxLogs
| Description | When the log file grows to the logger.file.maxSize value, the system will automatically roll the log file. Thelogger.file.maxLogs value controls the max number of logs that will be saved before it deletes the oldest. The default value is 10. |
| Type | Integer : Number of logs |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 10 |
| Override Example | |
logger.file.maxSize
| Description | This value controls the max file size of a log before the system will roll the log file. It must be set in the format '10MB' where 10 is number of MB to store. Always use MB as no other value is currently accepted. To disable log rolling set the value to false. The default value is '10MB'. Instances running on the On-Demand environment will have this setting enforced as 10MB. |
| Type | String : Size |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 10MB |
| On-Demand Value | 10MB |
| Override Example | |
logger.file.name
| Description | The name of the log file to be written to. Instances running on the On-Demand environment will have this setting enforced as sugarcrm. |
| Type | String : Filename |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | sugarcrm |
| On-Demand Value | sugarcrm |
| Override Example | |
logger.file.suffix
| Description | The suffix to the file name to track logs chronologically. For instance, if you wanted to append the month and year to a file name, you can change this setting to '%m_%Y'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php. Instances running on the On-Demand environment will have this setting enforced as empty. |
| Type | String : Suffix pattern |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | empty |
| On-Demand Value | empty |
| Override Example | |
logger.level
| Description | Determines the logging level of the system. The recommended setting is 'fatal'. Instances running on the On-Demand environment will have this setting enforced as fatal. |
| Type | String : Logging level |
| Range of values | 'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off' |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | fatal |
| On-Demand Value | fatal |
| Override Example | |
log_dir
| Description | Sets the location in the file system where the Sugar log file will be stored. By default, it is set to '.' meaning that it is stored in the root instance directory. |
| Type | String : Directory Path |
| Versions | 5.2.0+ |
| Editions | Pro, Corp, Ent, Ult |
| Default Value | . |
| Override Example | |
log_file
| Description | Designates the file name where the instance's logs will be stored. Instances running on the On-Demand environment will have this setting enforced as sugarcrm.log. |
| Type | String : Name of the log file |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | sugarcrm.log |
| On-Demand Value | sugarcrm.log |
| Override Example | |
log_memory_usage
| Description | Logs the memory usage. Instances running on the On-Demand environment will have this setting enforced as false. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.5.0+ |
| Editions | Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | false |
| Override Example | |
mark_emails_seen
| Description | Determines whether to mark an email as read before importing the email to Sugar during the inbound email import. This is not recommended as an import failure will cause the email to be marked as read which will be skipped during the next inbound email import. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.5.17+ |
| Editions | Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
max_dashlets_homepage (Deprecated in future release)
| Description | Determines the maximum number of Sugar Dashlets on a users Homepage. |
| Type | String : Number of dashlets |
| Versions | 5.2.0 - 6.7.12 |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 15 |
| Override Example | |
moduleInstaller
| Description | Array that defines restrictions on module installations via the Module Loader utility. |
| Type | Array |
| Versions | 5.2.0.j+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
moduleInstaller.disableFileScan
| Description | When packageScan is set to 'true', Sugar scans all files in an installable package to ensure that the file extensions are acceptable and that the files do not contain blacklisted class or function calls. Setting the disableFileScan parameter to 'true' avoids this scan from occurring while still enforcing other parameters set. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0j+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
moduleInstaller.packageScan
| Description | Enables package scanning on any modules uploaded through Module Loader prior to the installation. If the package is found to violate any restrictions of the packageScan, the installation will not proceed and an error report will be generated to the user attempting the install. Instances running on the On-Demand environment will have this setting enforced as true. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| On-Demand Value | true |
| Override Example | |
moduleInstaller.validExt
| Description | Part of the moduleInstaller array. When moduleInstaller.packageScanis set to true, Sugar will not allow certain file extensions to be present in an installable package. The moduleInstaller.validExt parameter allows you to define additional explicit extensions deemed safe to install on your instance of Sugar. Instances running on the On-Demand environment will have this setting enforced as array('xml'). |
| Type | Array : Extensions |
| Range of values | File extensions to allow |
| Versions | 6.0.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | array('png', 'gif', 'jpg', 'css', 'js', 'php', 'txt', 'html', 'htm', 'tpl', 'pdf', 'md5', 'xml', 'hbs', 'less', 'wsdl') |
| On-Demand Value | array('xml') |
| Override Example | |
oc_converted (Deprecated in future release)
| Description | This setting is only used in the Offline Client by the sync process. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0 - 6.5.23 |
| Editions | Ent, Ult |
| Override Example | |
oc_password (Deprecated in future release)
| Description | The password for the Offline Client user. |
| Type | String : Password |
| Versions | 5.2.0 - 6.5.23 |
| Editions | Ent, Ult |
| Override Example | |
oc_server_url (Deprecated in future release)
| Description | Used in Offline Client only to define the URL of the parent instance of Sugar for synchronization purposes. This is normally the same URL as sync_site_url but with a "/" at the end. |
| Type | String : Web URL |
| Versions | 5.2.0 - 6.5.23 |
| Editions | Ent, Ult |
| Override Example | |
oc_username (Deprecated in future release)
| Description | Specifies the user the Offline Client is being installed for. |
| Type | String : Sugar Username |
| Versions | 5.2.0 - 6.5.23 |
| Editions | Ent, Ult |
| Override Example | |
oracle_enable_ci
| Description | By default, Oracle searching is case sensitive in Sugar, which can be a problem if you are not sure of the case of the data you are searching for. Using this settings, you can turn on insensitive search for Oracle 10g and 11g. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.1.3+ |
| Editions | Ent, Ult |
| Override Example | |
parent_site_url (Deprecated in future release)
| Description | Used in portal installations to define the parent URL of the Sugar instance to communicate with. |
| Type | String : Web URL |
| Versions | 5.2.0 - 6.5.23 |
| Editions | Pro, Corp, Ent, Ult |
| Override Example | |
passwordsetting
| Description | Defines all of the password requirements for the instance. |
| Type | Array |
| Versions | 5.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
passwordsetting.forgotpasswordON
| Description | Enables the Forgot Password features. When enabled, users will have the ability to reset their own passwords at the Login page. Set in UI via Admin->Password Management. |
| Type | String |
| Range of values | 0, 1 |
| Versions | 5.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 1 |
| Override Example | |
passwordsetting.linkexpiration
0
| Description | Determines whether the password reset link expires. |
| Type | String |
| Range of values | 0, 1 |
| Versions | 6.0.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
passwordsetting.onelower
0
| Description | Configures whether at least one lower-case letter is required in users' passwords. |
| Type | String |
| Range of values | 0, 1 |
| Versions | 6.0.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
passwordsetting.onenumber
| Description | Configures whether at least one number is required in users' passwords. |
| Type | String |
| Range of values | 0, 1 |
| Versions | 6.0.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 1 |
| Override Example | |
passwordsetting.systexpirationtype
| Description | Specifies the unit of measurement forpasswordsetting.systexpirationtime. The available options are: Days (1), Weeks (7) and Months (30). This value can be set in the UI via Admin > Password Management. |
| Type | Integer |
| Range of values | 1, 7, and 30 |
| Versions | 5.5.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 1 |
| Override Example | |
require_accounts
| Description | Determines whether an account is required for record creation within the system. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
SAML_X509Cert
| Description | The SAML Certificate Key. |
| Type | String : SAML Certificate Key |
| Versions | 6.1.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
search_wildcard_infront
| Description | In Sugar 7.x+, this setting is only valid for modules running in BWC mode. When enabled, automatically adds a wildcard in front of any searches performed in the application. This setting is not recommended to be enabled as preceding wildcards results in database indices not being utilized and performance decreasing. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.4.3+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
session_dir
| Description | Directory on the server to store Sugar session data. If left empty, the PHP session settings will be inherited. Instances running on the On-Demand environment will have this setting enforced as empty. |
| Type | String |
| Range of values | Directory path |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | empty |
| On-Demand Value | empty |
| Override Example | |
showThemePicker
| Description | Removes the theme selection drop down. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
show_download_tab
| Description | Used to determine whether the download tab will appear in the User settings. The download tab provides users with access to Sugar plug-ins and other available downloads. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
site_url
| Description | Current URL of your Sugar instance. This value is critical in its accuracy for multiple points of functionality in the instance. |
| Type | String : URL |
| Range of values | Current URL of Sugar |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
slow_query_time_msec
| Description | Slow query time threshold. Instances running on the On-Demand environment will have this setting enforced as 5000. |
| Type | String : Milliseconds |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 5000 |
| On-Demand Value | 5000 |
| Override Example | |
stack_trace_errors
| Description | Displays stack trace of errors. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
studio_max_history
| Description | When layout changes are made in Studio, a history of those changes are recorded with each save & deploy under ./custom/history/modules/. The studio_max_history parameter controls how many files Sugar keeps for a particular module. If this parameter is undefined, a default of 50 is observed and to keep all historical Studio actions, set this parameter to 0. Instances running on the On-Demand environment will have this setting enforced as 50. |
| Type | Integer : Number of files to keep |
| Range of values | Any integer |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 50 |
| On-Demand Value | 50 |
| Override Example | |
sugar_version
| Description | The current version of Sugar that is being used. This value should not be modified as it is updated in the config when Sugar is upgraded. |
| Type | String : Version Number |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
tmp_dir
| Description | The directory path for temporary XML files used by charts and diagnostics. |
| Type | String : Directory path |
| Range of values | Filesystem path |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | cache/xml/ |
| Override Example | |
tracker_max_display_length
| Description | The number of records that will be shown per record in the "Last Viewed" section located under each module tab. |
| Type | Integer : Number of records |
| Versions | 6.0.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
unique_key
| Description | Specifies the unique identifier for the instance. This value is used in features such as PHP caching, FTS indexing, and email archiving. It is extremely important that this string is unique from any other instances deployed even if they are only for development purposes only. |
| Type | String : Unique Identifier |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
upload_badext
| Description | An array of extensions that cannot be uploaded in their native file format. Sugar will append a .txt extension to the end of any files with an invalid extension to avoid security issues with running unauthorized scripts on an instance. |
| Type | Array |
| Range of values | Extensions that cannot be uploaded as is |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
upload_dir
| Description | The directory path where uploaded files are stored for note attachments, documents, and module loadable packages. By default, uploads are stored in the ./upload/ directory. |
| Type | String |
| Range of values | Directory path |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | upload/ |
| Override Example | |
upload_maxsize
| Description | The maximum file size that users can upload into Sugar as attachments. When uploading files to Sugar, there are three file size limits to configure. The first two limits are your PHPupload_max_filesize and post_max_size which are configured in your php.ini. The second limit is the sugar configuration setting for upload_maxsize, which will restrict the upload limit from within Sugar. This setting can also be modified in the application via Admin > System Settings. The smallest of these three values will be honored when an oversized file has been uploaded. |
| Type | Integer : Filesize in bytes |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
use_common_ml_dir
| Description | A security control that allows you to restrict Module Loader to read modules from a specific directory on the server and disable the ability to upload new modules into the Module Loader. To specify a new directory you will need to populate the config parameter 'common_ml_dir'. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
use_php_code_json
| Description | Determines if the environment has a valid version of PHP-JSON. This should be determined by the function returnPhpJsonStatus() and shouldn't be overridden. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
use_real_names
| Description | Display users' full names instead of their User Names in assignment fields. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
use_sprites
| Description | A sprite is a two-dimensional image or animation that is integrated into a larger scene. This parameter is used to disable sprites. This is set to true by default (if you have GD libraries installed). |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.4.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
vcal_time
| Description | Used to determine the number of months in advance of the current date that the Free/Busy information for calls and meetings will be published. To turn Free/Busy publishing off, set this variable to '0'. The minimum is 1 month; the maximum is 12 months. |
| Type | String : Months |
| Range of values | '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', and '12' |
| Versions | 5.2.0.c+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 2 |
| Override Example | |
verify_client_ip
| Description | Whether or not to verify the client IP. Setting this to false will disable the system checking to see if the user is accessing Sugar from the IP address of their last page load. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | true |
| Override Example | |
wl_list_max_entries_per_page
| Description | The number of records to be shown per page on the listview of the mobile browser. |
| Type | Integer : Number of records to display |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 10 |
| Override Example | |
wl_list_max_entries_per_subpanel
| Description | Determines the number of records shown in the subpanels on the DetailView of the mobile browser. |
| Type | Integer : Records |
| Versions | 5.2.0+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 3 |
| Override Example | |
xhprof_config
| Description | Configuration settings for xhprof. More information on xhprof can be found at http://pecl.php.net/package/xhprof. |
| Type | Array |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
xhprof_config.enable
| Description | Enables the xhprof profiler. |
| Type | Boolean |
| Range of values | true and false |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | false |
| Override Example | |
xhprof_config.flags
| Description | The flags for xhprof profiler. |
| Type | String : xhprof flags |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
xhprof_config.ignored_functions
| Description | An array of function names to ignore from the profile. |
| Type | Array : Function names |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
xhprof_config.log_to
| Description | The path to log the xhprof profiler output to. |
| Type | String : Directory path |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Override Example | |
xhprof_config.manager
| Description | The xhprof manager class to use. Prior to 7.7, specifying valuesxhprof_config.save_to, xhprof_config.mongodb_uri,xhprof_config.mongodb_db, xhprof_config.mongodb_collection,xhprof_config.mongodb_options, and xhprof_config.filter_wtwill need to have set xhprof_config.manager set to 'SugarXHprofPerformance'. As of 7.7, settingxhprof_config.manager is not longer required. If you want to customize SugarXHprof, you can create the folder./custom/include/SugarXHprof/ and create a file with your custom class class name. The custom class will need to extendSugarXHprof. If a custom class doesn't exist or hasn't been specified, SugarXHprof will be used. |
| Type | String : Class |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | SugarXHprof |
| Override Example | |
xhprof_config.sample_rate
| Description | The sample rate of the xhprof profiler. 1/{specified value} requests are profiled. To sample all requests, set this value to 1. |
| Type | Integer : Sample Rate (1/{value}) |
| Versions | 6.5.10+ |
| Editions | CE, Pro, Corp, Ent, Ult |
| Default Value | 10 |
| Override Example | |
Last modified: 04/20/2016 02:24pm
0 comentarios