SugarCRM SupportDocumentationSugar DeveloperSugar Developer Guide 7.9ArchitectureConfiguratorCore Settings

Core Settings

Overview

Sugar 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

additional_js_config

DescriptionConfiguration values for when the ./cache/config.js file is generated. It is important to note that after changing this setting or any of its subsettings in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.
TypeArray
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['additional_js_config'] = array();

additional_js_config.alertAutoCloseDelay

DescriptionDefines the default auto close delay for system alerts. It is important to note that after changing this setting in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.
TypeInteger : Milliseconds
Versions7.8.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value9000
Override Example
$sugar_config['additional_js_config']['alertAutoCloseDelay'] = 3000;

additional_js_config.authStorage

DescriptionDefines the implementation of authentication data storage. The default storage, 'cache', is persistent and uses the localStorage API. Alternatively, 'cookie' storage may be used. This will store the authentication data in your browser window until the browser itself is closed. It is important to note that this behavior will differ between browsers. It is important to note that after changing this setting in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.
TypeString
Range of values'cache' and 'cookie'
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuecache
Override Example
$sugar_config['additional_js_config']['authStore'] = 'cookie';

admin_access_control

DescriptionRemoves 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['admin_access_control'] = true;

admin_export_only

DescriptionAllow only users with administrative privileges to export data.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['admin_export_only'] = true;

allow_oauth_via_get

DescriptionAs of 7.8, Sugar does not support auth tokens being passed in from GET query string parameters by default. While allowing this functionality is not a recommended practice from a security standpoint, administrators may enable the setting at their own risk.
TypeBoolean
Range of valuestrue and false
Versions7.8.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['allow_oauth_via_get'] = true;

allow_pop_inbound

DescriptionInbound 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.
TypeBoolean
Range of valuestrue and false
Versions5.5.1+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['allow_pop_inbound'] = true;

allow_sendmail_outbound

DescriptionEnables 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.
TypeBoolean
Range of valuestrue and false
Versions5.5.1+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuefalse
Override Example
$sugar_config['allow_sendmail_outbound'] = true;

analytics

DescriptionAn array defining properties for an analytics connector. Instances running on the On-Demand environment will have this setting enforced as a predetermined array.
TypeArray
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
On-Demand Valuea predetermined array
Override Example
$sugar_config['analytics'] = array();

analytics.connector

DescriptionThe name of the connector to use for gathering analytics. Instances running on the On-Demand environment will have this setting enforced as a predetermined value.
TypeString : Connector name
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
On-Demand Valuea predetermined value
Override Example
$sugar_config['analytics']['connector'] = 'GoogleAnalytics';

analytics.enabled

DescriptionDetermines if the analytics are enabled. Instances running on the On-Demand environment will have this setting enforced as true.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['analytics']['enabled'] = true;

analytics.id

DescriptionThe tracking id for the analytics connector. Instances running on the On-Demand environment will have this setting enforced as a predetermined value.
TypeString : Tracking ID
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
On-Demand Valuea predetermined value
Override Example
$sugar_config['analytics']['id'] = 'UA-XXXXXXX-X';

api

DescriptionAPI specific configurations.
TypeInteger
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['api']=array();

api.timeout

DescriptionThe timeout in seconds when uploading files through the REST API.
TypeInteger : Seconds
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value180
Override Example
$sugar_config['api']['timeout'] = 240;

aws

DescriptionThe Amazon AWS configuration. Used for storing uploads on S3. The upload_wrapper_class setting must also be updated to SugarUploadS3 to enable this configuration. You can do this by placing $sugar_config['upload_wrapper_class'] = 'SugarUploadS3'; in your config_override.php.
TypeArray
Versions6.7.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['aws'] = array();

aws.aws_key

DescriptionAmazon AWS public key.
TypeString : Key
Versions6.7.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['aws']['aws_key'] = 'key';

aws.aws_secret

DescriptionAmazon AWS secret key.
TypeString : Key
Versions6.7.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['aws']['aws_secret'] = 'secret';

aws.upload_bucket

DescriptionThe Amazon S3 bucket name for uploads.
TypeString : S3 bucket name
Versions6.7.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['aws']['upload_bucket'] = 'bucket';

cache_dir

DescriptionThis is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory.
TypeString : Directory
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuecache/
Override Example
$sugar_config['cache_dir'] = 'cache/';

cache_expire_timeout

DescriptionThe length of time cached items should be expired after.
TypeInteger : Seconds
Versions6.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value300
Override Example
$sugar_config['cache_expire_timeout'] = 400;

calendar

DescriptionAn array that defines all of the various settings for the Calendar module.
TypeArray
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['calendar'] = array();

calendar.day_timestep

DescriptionSets the default day time step.
TypeInteger : Days
Range of values15, 30 and 60
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value15
Override Example
$sugar_config['calendar']['day_timestep'] = 15;

calendar.default_view

DescriptionChanges the default view in the calendar module.
TypeString
Range of values'day', 'week', 'month' and 'share'
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['calendar']['default_view'] = 'week';

calendar.items_draggable

DescriptionEnable/Disable drag-and-drop feature to move calendar items.
TypeBoolean
Range of valuestrue and false
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['calendar']['items_draggable'] = true;

calendar.items_resizable

DescriptionSets whether items on the calendar can be resized via clicking and dragging.
TypeBoolean
Range of valuestrue and false
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['calendar']['items_resizable'] = true;

calendar.show_calls_by_default

DescriptionDisplay/Hide calls by default.
TypeBoolean
Range of valuestrue and false
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['calendar']['show_calls_by_default'] = true;

calendar.week_timestep

DescriptionThe default week step size when viewing the calendar.
TypeInteger : Calendar Step Size
Range of values15, 30, and 60
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['calendar']['week_timestep'] = 30;

check_query

DescriptionValidates queries when adding limits.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['check_query'] = true;

check_query_cost

DescriptionSets the maximum cost limit of a query.
TypeInteger
Versions5.2.0+
EditionsEnterprise, Ultimate
Default Value10
Override Example
$sugar_config['check_query_cost'] = 10;

collapse_subpanels

DescriptionPertains to Sidecar modules only. By default, all subpanels are in a collapsed state. If a user expands a subpanel, Sugar caches this preference so that it remains expanded on future visits to the same view. Set this value to 'true' to force a collapsed state for subpanels regardless of user preference, which may improve page-load performance by not querying for data until a user explicitly chooses to expand a subpanel.
TypeBoolean
Range of valuestrue and false
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['collapse_subpanels'] = true;

cron

DescriptionArray that defines all of the cron parameters.
TypeArray
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['cron'] = aray();

cron.enforce_runtime

DescriptionDetermines if cron.max_cron_runtime is enforced during the cron run.
TypeBoolean
Range of valuestrue and false
Versions7.2.2.2+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['cron']['enforce_runtime'] = true;

cron.max_cron_jobs

DescriptionMaximum 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_jobs to set this value due to bug #62936 ( https://web.sugarcrm.com/support/issues/62936 ).
TypeInteger
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value6.5.x: 10
7.6.x: 25
Override Example
$sugar_config['cron']['max_cron_jobs'] = 10;

cron.max_cron_runtime

DescriptionDetermines 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.
TypeInteger : Seconds
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value180
Override Example
$sugar_config['cron']['max_cron_runtime'] = 60;

cron.min_cron_interval

DescriptionMinimum time between cron runs. Setting this to 0 will disable throttling completely.
TypeInteger : Seconds
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value30
Override Example
$sugar_config['cron']['min_cron_interval'] = 30;

csrf

DescriptionAn array defining attributes for CSRF token protection.
TypeArray
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['csrf'] = array();

csrf.soft_fail_form

DescriptionWhen opted in for CSRF form authentication, any failures will result in a CSRF message to the user indicating a potential CSRF attack and an aborted action. If you are unsure whether the CSRF tokens are properly implemented in your backward compatible modules, this configuration parameter can be set to true. Setting this to true will avoid any exceptions being thrown to the end user. By default, any failures will result in a fatal log message indicating the issue. If you are running in "soft failure", a second fatal message will be logged such as "CSRF: attack vector NOT mitigated, soft failure mode enabled". Be careful enabling this configuration as it will only log CSRF authentication failures and will not protect your system.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['csrf']['soft_fail_form'] = true;

csrf.token_size

DescriptionThe size in bytes of the CSRF token to generate.
TypeInteger : Bytes
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value32
Override Example
$sugar_config['csrf']['token_size'] = 16;

custom_help_base_url

DescriptionAllows an instance to specify a custom help url for their user
TypeString : URL
Versions6.4.3+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuehttp://www.sugarcrm.com/crm/product_doc.php
Override Example
$sugar_config['custom_help_base_url'] = 'http://www.custom_url/index.php';

custom_help_url

DescriptionDesignate the URL used to redirect the user to help documentation.
TypeString : Website address
Versions6.4.3+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuehttp://www.sugarcrm.com/crm/product_doc.php
Override Example
$sugar_config['custom_help_url'] = 'http://www.sugarcrm.com/crm/product_doc.php';

dbconfig

DescriptionDefines all of the connection parameters for the database server.
TypeArray
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['dbconfig'] = array();

dbconfig.db_host_instance

DescriptionDefines the host instance for MSSQL connections.
TypeString : Database Host Instance Name
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_host_instance'] = 'SQLEXPRESS';

dbconfig.db_host_name

DescriptionPart of the 'dbconfig' array. Defines the host name of the database server.
TypeString : Host name
Range of valueshost name of database server
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_host_name'] = 'localhost';

dbconfig.db_manager

DescriptionPart of the 'dbconfig' array. Defines the specific library used to connect with your database. Instances running on the On-Demand environment will have this setting enforced as MysqliManager.
TypeString : Database Manager
Range of valuesThe class name of the database driver, Possible values are: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', and 'SqlsrvManager'.
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default ValueDetermined by install: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', or 'SqlsrvManager'
On-Demand ValueMysqliManager
Override Example
$sugar_config['dbconfig']['db_manager'] = 'MysqliManager';

dbconfig.db_name

DescriptionPart of the 'dbconfig' array. Defines the database name to connect to on the database server.
TypeString : Database Name
Range of valuesdatabase name
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_name'] = 'sugar_db';

dbconfig.db_password

DescriptionPart of the 'dbconfig' array. Defines the password that correlates to the db_user_name parameter.
TypeString : Password
Range of valuespassword of the user defined in db_user_name
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_password'] = 'sql_password';

dbconfig.db_port

DescriptionPart of the 'dbconfig' array. Defines the port number on the server to connect to for authentication and transactions.
TypeString : Network Port
Range of valuesport number to connect to on the database server
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value3306
Override Example
$sugar_config['dbconfig']['db_port'] = '3306';

dbconfig.db_type

DescriptionDefines 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.
TypeString : Database Enigine
Range of values'mysql', 'mssql', 'db2', and 'oracle'
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['dbconfig']['db_type'] = 'mysql';

dbconfig.db_user_name

DescriptionDefines the user to connect to the Sugar database as.
TypeString : Database User
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['dbconfig']['db_user_name'] = 'sql_user';

dbconfigoption.autofree

DescriptionAutomatically frees the database reference when it closes the reference.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['dbconfigoption']['autofree'] = true;

dbconfigoption.collation

DescriptionThe set of rules to be used for comparing characters in a character set.
TypeString : Collation type
Versions5.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueutf8_general_ci
Override Example
$sugar_config['dbconfigoption']['collation'] = 'utf8_general_ci';

dbconfigoption.debug

DescriptionEnables debugging on the database connection.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['dbconfigoption']['debug'] = true;

dbconfigoption.persistent

DescriptionDetermines whether Sugar should use persistent connection when possible to connecting to the database.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['dbconfigoption']['persistent'] = true;

dbconfigoption.ssl

DescriptionEnables SSL on the database connection.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['dbconfigoption']['ssl'] = true;

dbconfigoption.ssl_options

DescriptionAn array detailing the SSL database connection options.
TypeArray
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfigoption']['ssl_options'] = array();

dbconfigoption.ssl_options.ssl_capath
DescriptionThe path the trusted SSL certificate authority file in PEM format for SSL connection to the database.
TypeString : File path
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfigoption']['ssl_options']['ssl_capath'] = 'path/to/ca-cert';

dbconfigoption.ssl_options.ssl_cert
DescriptionThe path the SSL certificate file for SSL connection to the database.
TypeString : File path
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfigoption']['ssl_options']['ssl_cert'] = 'path/to/cert';

dbconfigoption.ssl_options.ssl_cipher
DescriptionThe SSL cipher to be used for encryption.
TypeString : Cipher
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfigoption']['ssl_options']['ssl_cipher'] = 'cipher';

dbconfigoption.ssl_options.ssl_key
DescriptionThe path the SSL key for SSL connection to the database.
TypeString : File path
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['dbconfigoption']['ssl_options']['ssl_key'] = 'path/to/key';

default_currency_significant_digits

DescriptionChanges the number of significant digits in currency by default.
TypeInteger : Number of significant digits
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value2
Override Example
$sugar_config['default_currency_significant_digits'] = 2;

default_date_format

DescriptionModifies the default date format for all users.
TypeString : Date format
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuem/d/Y
Override Example
$sugar_config['default_date_format'] = 'm/d/Y';

default_decimal_seperator

DescriptionSets the character used as a decimal separator for numbers.
TypeString : Text character
Range of valuesAny character
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value.
Override Example
$sugar_config['default_decimal_seperator'] = '.';

default_email_client

DescriptionSets the default email client that opens when users send emails.
TypeString : Email client
Range of values'sugar', 'external'
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuesugar
Override Example
$sugar_config['default_email_client'] = 'sugar';

default_language

DescriptionSets 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'
TypeString : Language key
Range of valuesAny available language
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueen_us
Override Example
$sugar_config['default_language'] = 'en_us';

default_number_grouping_seperator

DescriptionSets the character used as the 1000s separator for numbers.
TypeString : Text character
Range of valuesAny character
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value,
Override Example
$sugar_config['default_number_grouping_seperator'] = ',';

default_permissions

DescriptionArray that defines the ownership and permissions for directories and files created naturally by the application.
TypeArray
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['default_permissions'] = array();

default_permissions.dir_mode

DescriptionPart 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.
TypeInteger : Octal Value
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
On-Demand Value1528
Override Example
$sugar_config['default_permissions']['dir_mode'] = 1528;

default_permissions.file_mode

DescriptionPart 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.
TypeInteger : Octal value
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
On-Demand Value432
Override Example
$sugar_config['default_permissions']['file_mode'] = 432;

default_permissions.group

DescriptionUsed 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 as empty.
TypeString : Web group
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
On-Demand Valueempty
Override Example
$sugar_config['default_permissions']['group'] = 'apache';

default_permissions.user

DescriptionPart 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.
TypeString : Web user
Range of valuesApache user
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
On-Demand Valueempty
Override Example
$sugar_config['default_permissions']['user'] = 'apache';

default_user_is_admin

DescriptionAllows for determining whether a user is a system administrator by default.
TypeBoolean
Range of valuestrue, false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['default_user_is_admin'] = true;

developerMode

DescriptionRebuilds 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuefalse
Override Example
$sugar_config['developerMode'] = true;

diagnostic_file_max_lifetime

DescriptionThe interval in seconds of when to expire and remove diagnostic files. It is important to note that the "Remove diagnostic files" scheduler job must be enabled to remove the diagnostic files.
TypeInteger : Seconds
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value604800
Override Example
$sugar_config['diagnostic_file_max_lifetime'] = 604800;

disable_count_query

DescriptionRemoves 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['disable_count_query'] = true;

disable_export

DescriptionPrevents exports of data into .csv files. Normally set in the UI via Admin > Locale.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['disable_export'] = true;

DescriptionWhen a calculated field in Sugar uses the related function in the Sugar Logic, this will cause the calculated field to be executed when the related module is updated. This can cause a cascading effect through the system to update related calculated fields. When this happens you may receive a 502 Gateway Error. Please note that this is a global setting that will affect all modules. If you have a calculated field in Accounts that sums up all Opportunities for the account, setting this value to true will no longer update the opportunity account sum in Accounts until the account record itself is modified. However, if this setting is left disabled, the sum would update any time a related opportunity or the account is modified.
TypeBoolean
Range of valuestrue and false
Versions6.3.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['disable_related_calc_fields'] = true;

disable_unknown_platforms

DescriptionControls whether or not unregistered platforms are allowed to by used when logging in using v10 REST API. Custom platforms can be registered using the Platform extension. Used to prevent excessive metadata generation when invalid or unrecognized platform types are specified in an API call.
TypeBoolean
Range of valuestrue and false
Versions7.9.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['disable_unknown_platforms'] = false;

disable_unknown_platforms (Deprecated in future release)

DescriptionControls whether or not unregistered platforms are allowed to by used when logging in using v10 REST API. Custom platforms can be registered to ./custom/clients/platforms.php. Used to prevent excessive metadata generation when invalid platform types are specified in an API call.
TypeBoolean
Range of valuestrue and false
Versions7.6.2.0 - 7.9.2.0
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['disable_unknown_platforms'] = true;

disable_uw_upload

DescriptionDisables 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0.j+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['disable_uw_upload'] = true;

disable_vcr

DescriptionDisables 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['disable_vcr'] = true;

dump_slow_queries

DescriptionLogs slow queries to the sugar log file. Instances running on the On-Demand environment will have this setting enforced as false.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuefalse
Override Example
$sugar_config['dump_slow_queries'] = true;

email_address_separator

DescriptionSets the character used to separate email addresses.
TypeString : Text character
Range of valuesAny character
Versions6.4.3+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value,
Override Example
$sugar_config['email_address_separator'] = ',';

email_default_client

DescriptionSets the default email client for all users.
TypeString : String
Range of valuessugar, external
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuesugar
Override Example
$sugar_config['email_default_client'] = 'sugar';

email_default_delete_attachments

DescriptionWhen deleting an email, this setting will mark all related notes as deleted, and attempt to delete files that are related to those notes.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['email_default_delete_attachments'] = false;

email_default_editor

DescriptionAllows configuring the default editor type for email. 'plain' sets the editor to only use plain text. 'html' allows the editor to be html enabled.
TypeString : String
Range of values'plain' and 'html'
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuehtml
Override Example
$sugar_config['email_default_editor'] = 'plain';

email_mailer_timeout

DescriptionThe connection timeout period when sending an email.
TypeInteger : Seconds
Versions7.8.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value10
Override Example
$sugar_config['email_mailer_timeout'] = 30;

enable_inline_reports_edit

DescriptionAllows 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.
TypeBoolean
Range of valuestrue and false
Versions6.3.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['enable_inline_reports_edit'] = true;

enable_mobile_redirect

DescriptionFlag indicating whether smartphone users are automatically redirected to the mobile view when navigating to a Sugar instance.
TypeBoolean
Range of valuestrue and false
Versions7.1.5+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['enable_mobile_redirect'] = false;

external_cache.memcache.host
DescriptionThe host url for memchache.
TypeString : Host URL
Versions6.2.0+
EditionsCommunity Edition, Professional, Enterprise
Default Value127.0.0.1
Override Example
$sugar_config['external_cache']['memcache']['host'] = '192.168.1.1';

external_cache.memcache.port
DescriptionThe host port for memcache.
TypeInteger : Port number
Versions6.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value11211
Override Example
$sugar_config['external_cache']['memcache']['port'] = 11212;

external_cache_db_gc_probability

DescriptionProbability factor to determine when garbage collection on stale keys from the DB backend will happen.
TypeInteger : Probability factor
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value0.0001
Override Example
$sugar_config['external_cache_db_gc_probability'] = 0.0005;

external_cache_db_gc_threshold

DescriptionThe threshold in milliseconds to flag garbage collection queries as [SLOW] in sugarcrm.log.
TypeInteger : Milliseconds
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value200
Override Example
$sugar_config['external_cache_db_gc_threshold'] = 500;

external_cache_disabled

DescriptionDisables 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled'] = true;

external_cache_disabled_apc

DescriptionDisables APC 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled_apc'] = false;

external_cache_disabled_db

DescriptionDisables the database key/value cache from being eligible as cache backend.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['external_cache_disabled_db'] = true;

external_cache_disabled_memcache

DescriptionDisables 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled_memcache'] = true;

external_cache_disabled_memcached

DescriptionDisables 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.
TypeBoolean
Range of valuestrue and false
Versions6.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled_memcached'] = false;

external_cache_disabled_mongo

DescriptionDisables Mongo 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.
TypeBoolean
Range of valuestrue and false
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled_mongo'] = true;

external_cache_disabled_smash

DescriptionDisables Smash caching in Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching.
TypeBoolean
Range of valuestrue and false
Versions5.2.0c+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['external_cache_disabled_smash'] = false;

external_cache_disabled_wincache

DescriptionDisables WinCache 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.
TypeBoolean
Range of valuestrue and false
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled_wincache'] = false;

external_cache_disabled_zend

DescriptionDisables Zend 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['external_cache_disabled_zend'] = false;

forms

DescriptionAn array defining form requirements.
TypeArray
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['forms'] = array();

forms.requireFirst

DescriptionPresents all required fields grouped together in the first panel on the EditView form.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['forms']['requireFirst'] = true;

freebusy_use_vcal_cache

DescriptionPrior to Sugar version 7.6, FreeBusy Calendar searches used the vcals table to cache user meeting and call activity for the purpose of determining user availability in for future free time search. As of 7.6, a new design allowed for more accurate free/busy searching that no longer used this cache, but the cache was still being written to, by default, when calls/meetings were created/updated for backward compatibility reasons. As of Sugar 7.9, in order to enhance performance, the cache is no longer being written to by default. Instead, the override variable 'FreeBusyCache_Enabled' must be set to true for the Cache to be written. Since this cache is no longer used inside the Sugar application, this option should be used with caution as the cache itself is expected to be removed from the Sugar product in a future release.
TypeBoolean
Range of valuestrue and false
Versions6.1.0RC1+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['freebusy_use_vcal_cache'] = true;

hide_admin_backup

DescriptionRemoves 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.
TypeBoolean
Range of valuestrue and false
Versions6.5.1+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['hide_admin_backup'] = true;

hide_admin_licensing

DescriptionHides the License settings subpanel in the administrative panel. Instances running on the On-Demand environment will have this setting enforced as false.
TypeBoolean
Range of valuestrue and false
Versions6.5.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuefalse
Override Example
$sugar_config['hide_admin_licensing'] = true;

hide_full_text_engine_config

DescriptionDetermines 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.
TypeBoolean
Range of valuestrue and false
Versions6.5.15+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['hide_full_text_engine_config'] = true;

hide_subpanels

DescriptionThis 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['hide_subpanels'] = true;

hide_subpanels_on_login

DescriptionThis 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['hide_subpanels_on_login'] = true;

history_max_viewed

DescriptionThe number of history items from the tracker to display for a user.
TypeInteger
Versions5.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value50
Override Example
$GLOBALS['sugar_config']['history_max_viewed'] = 25;

installer_locked

DescriptionSets 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
On-Demand Valuetrue
Override Example
$sugar_config['installer_locked'] = false;

jobs

DescriptionJob Queue configurations.
TypeArray
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['jobs'] = array();

jobs.hard_lifetime

DescriptionHard deletes all jobs that are older than the hard cutoff. Default is 21 days.
TypeInteger : Days
Versions6.5.1+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value21
Override Example
$sugar_config['jobs']['hard_lifetime'] = 21;

jobs.max_retries

DescriptionMaximum number of failures for job. Default is 5.
TypeInteger : Number of failures
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value5
Override Example
$sugar_config['jobs']['max_retries'] = 5;

jobs.min_retry_interval

DescriptionMinimal interval between job reruns. Default is 30 seconds.
TypeInteger : Seconds
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value30
Override Example
$sugar_config['jobs']['min_retry_interval'] = 30;

jobs.soft_lifetime

DescriptionSoft deletes all jobs that are older than cutoff. Default is 21 days.
TypeInteger : Days
Versions6.5.1+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value7
Override Example
$sugar_config['jobs']['soft_lifetime'] = 7;

jobs.timeout

DescriptionIf a job is running longer than the limit, the job is failed by force. Specified in seconds. Default is 3600 seconds (1 hour).
TypeInteger : Seconds
Versions6.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value3600
Override Example
$sugar_config['jobs']['timeout'] = 86400;

list_max_entries_per_page

DescriptionListview items per page.
TypeString : Records per page
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value20
Override Example
$sugar_config['list_max_entries_per_page'] = '20';

list_report_max_per_page

DescriptionSets the maximum number of reports that are listed on each page in the Reports module.
TypeInteger : Number of records
Versions5.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value100
Override Example
$sugar_config['list_report_max_per_page'] = 100;

logger

DescriptionAn array that defines all of the logging settings.
TypeArray
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['logger'] = array();

logger.channels.input_validation.level
DescriptionThis setting controls the logging level for input validation failure messages when validation.soft_fail is enabled.
TypeString : Logging level
Range of values'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off'
Versions7.9.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['logger']['channels']['input_validation']['level'] = 'warning';

logger.channels.metadata.level
DescriptionThis logging channel can be used to track and debug metadata refresh issues. Overly frequent metadata refreshes will cause performance issues for affected Sugar instances. This metadata logging channel can help determine the frequency and causes of metadata refreshes. For backward compatibility, the following levels map as follows: 'fatal' => 'alert', 'security' => 'critical', 'warn' => 'warning', 'deprecated' => 'notice';
TypeString
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions7.9.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['logger']['channels']['metadata']['level'] = 'debug';

logger.file.dateFormat
DescriptionThe 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.
TypeString : Date format
Range of valuesPattern for date format
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value%c
Override Example
$sugar_config['logger']['file']['dateFormat'] = '%c';

logger.file.ext
DescriptionThe extension of the log file. The default value is '.log'. Instances running on the On-Demand environment will have this setting enforced as .log.
TypeString : File extension
Range of valuesExtension for the log
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value.log
On-Demand Value.log
Override Example
$sugar_config['logger']['file']['ext'] = '.log';

logger.file.maxLogs
DescriptionWhen the log file grows to the logger.file.maxSize value, the system will automatically roll the log file. The logger.file.maxLogs value controls the max number of logs that will be saved before it deletes the oldest. The default value is 10.
TypeInteger : Number of logs
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value10
Override Example
$sugar_config['logger']['file']['maxLogs'] = 10;

logger.file.maxSize
DescriptionThis 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.
TypeString : Size
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value10MB
On-Demand Value10MB
Override Example
$sugar_config['logger']['file']['maxSize'] = '10MB';

logger.file.name
DescriptionThe name of the log file to be written to. Instances running on the On-Demand environment will have this setting enforced as sugarcrm.
TypeString : Filename
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuesugarcrm
On-Demand Valuesugarcrm
Override Example
$sugar_config['logger']['file']['name'] = 'sugarcrm';

logger.file.suffix
DescriptionThe 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.
TypeString : Suffix pattern
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueempty
On-Demand Valueempty
Override Example
$sugar_config['logger']['file']['suffix'] = '%m_%Y';

logger.level

DescriptionDetermines 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.
TypeString : Logging level
Range of values'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off'
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefatal
On-Demand Valuefatal
Override Example
$sugar_config['logger']['level'] = 'fatal';

logger.write_to_server

DescriptionEnables the front end messages to be logged. The logger level must be tuned accordingly under Administration settings. Developers can set the client side flag by running App.config.logger.writeToServer = true; in their browsers console. To simulate logging actions through the console, developers can use: App.logger.trace('message'); App.logger.debug('message'); App.logger.info('message'); App.logger.warn('message'); App.logger.fatal('message');
TypeBoolean
Range of valuestrue and false
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['logger']['write_to_server'] = true;

logger_visible

DescriptionDetermines whether the Logger Settings panel is visible to administrators in Admin > System Settings. Instances running on the On-Demand environment will have this setting enforced as false.
TypeBoolean
Range of valuestrue and false
Versions6.7.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
On-Demand Valuefalse
Override Example
$sugar_config['logger_visible'] = false;

log_dir

DescriptionSets 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. Instances running on the On-Demand environment will have this setting enforced as ..
TypeString : Directory Path
Versions5.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value.
On-Demand Value.
Override Example
$sugar_config['log_dir'] = '.';

log_file

DescriptionDesignates 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.
TypeString : Name of the log file
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuesugarcrm.log
On-Demand Valuesugarcrm.log
Override Example
$sugar_config['log_file'] = 'new_sugarcrm.log'

log_memory_usage

DescriptionLogs the memory usage. Instances running on the On-Demand environment will have this setting enforced as false.
TypeBoolean
Range of valuestrue and false
Versions5.5.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuefalse
Override Example
$sugar_config['log_memory_usage'] = true;

maintenanceMode

DescriptionAllows the instance to be placed in a maintenance mode where users cannot access the instance.
TypeBoolean
Range of valuestrue and false
Versions7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['maintenanceMode'] = false;

mark_emails_seen

DescriptionDetermines 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.
TypeBoolean
Range of valuestrue and false
Versions6.5.17+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['mark_emails_seen'] = true;

mass_actions

DescriptionArray that defines mass action behaviors.
TypeArray
Versions7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['mass_actions'] = array();

DescriptionNumber of records per chunk while performing mass linking updates.
TypeInteger
Versions7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value20
Override Example
$sugar_config['mass_actions']['mass_link_chunk_size'] = 20;

max_session_time

DescriptionDetermines the maximum lock time in seconds between session requests. When a session request is locked for long periods of time, other requests are blocked until it is released. A null value will not implement a max session time. Instances running on the On-Demand environment will have this setting enforced as 1.
TypeInteger : Seconds
Versions6.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuenull
On-Demand Value1
Override Example
$sugar_config['max_session_time'] = 1;

moduleInstaller

DescriptionArray that defines restrictions on module installations via the Module Loader utility.
TypeArray
Versions5.2.0.j+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['moduleInstaller'] = array();

moduleInstaller.disableFileScan

DescriptionWhen 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0j+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['moduleInstaller']['disableFileScan'] = true;

moduleInstaller.packageScan

DescriptionEnables 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.
TypeBoolean
Range of valuestrue and false
Versions5.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
On-Demand Valuetrue
Override Example
$sugar_config['moduleInstaller']['packageScan'] = true;

moduleInstaller.validExt

DescriptionPart of the moduleInstaller array. When moduleInstaller.packageScan is set to true, Sugar will not allow certain file extensions to be present in an installable package. By default, Sugar allows the following extensions: 'png', 'gif', 'jpg', 'css', 'js', 'php', 'txt', 'html', 'htm', 'tpl', 'pdf', 'md5', 'xml', 'hbs', 'less', and 'wsdl'. This parameter allows you to define additional extensions deemed safe to install on your instance of Sugar. Instances running on the On-Demand environment will have this setting enforced as array('eot','svg','tff','woff','woff2','xml').
TypeArray : Extensions
Range of valuesFile extensions to allow
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuearray()
On-Demand Valuearray('eot','svg','tff','woff','woff2','xml')
Override Example
$sugar_config['moduleInstaller']['validExt'] = array('swf', 'log');

mso_fixup_paragraph_tags

DescriptionDetermines whether email HTML is scrubbed for empty paragraph tags when displayed in the application. Setting this value to true will enable the HTML scrubbing. Enabling this setting does not affect the HTML stored in the database from the initial import. Created as a result of bug 66022 (https://web.sugarcrm.com/support/issues/66022).
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['mso_fixup_paragraph_tags'] = true;

noPrivateTeamUpdate

DescriptionPrevents name changes to a users private team. This setting can be modified by changing in Admin > System Settings > Advanced > Prevent name changes by users to update their Private Team Name
TypeBoolean
Range of valuestrue and false
Versions7.6.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['noPrivateTeamUpdate'] = true;

oauth_token_expiry

DescriptionSets whether OAuth tokens will expire.
TypeString
Range of valuestrue and false
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default ValueFalse
Override Example
$sugar_config['oauth_token_expiry'] = '0';

oauth_token_life

DescriptionSets the length (in seconds) of the life of an OAuth token.
TypeInteger : Seconds
Versions7.5.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value86400
Override Example
$sugar_config['oauth_token_life'] = '86400';

passwordHash

DescriptionAray that defines the password hashing behaviors.
TypeArray
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['passwordHash'] = array();

passwordHash.algo

DescriptionThe specific algorithm to be used by the hashing backend. The available values depend on the selected passwordHash.backend. See http://php.net/manual/en/password.constants.php for more information when using the native backend.
TypeString : Algorithm Type
Range of valuesFor native backend: "PASSWORD_DEFAULT" and "PASSWORD_BCRYPT". For sha2 backend: "CRYPT_SHA256" and "CRYPT_SHA512"
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value"PASSWORD_DEFAULT" for native. "CRYPT_SHA256" for sha2 backend.
Override Example
$sugar_config['passwordHash']['algo'] = 'PASSWORD_BCRYPT';

passwordHash.allowLegacy

DescriptionAllow logins of users who have their password stored using the insecure legacy MD5 hash. During the transition period for the 7.7 series, this will be allowed out of the box. Versions past 7.7 will no longer allow by default authentication against insecure hashes. This configuration parameter can be used to change the default behavior.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value7.7.x: true
7.8.x+:false
Override Example
$sugar_config['passwordHash']['allowLegacy'] = false;

passwordHash.backend

DescriptionThe password hash backend class to use. By default, the "native" backend is used which uses Blowfish to hash the passwords in the database. An alternative is using the "sha2" backend which makes use of SHA-2 hashing instead. Depending on the backend, different configuration options are available for passwordHash.algo and passwordHash.options.
TypeString
Range of values'sha2' and 'native'
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuenative
Override Example
$sugar_config['passwordHash']['backend'] = 'sha2';

passwordHash.options

DescriptionThe available configuration values depend on the selected passwordHash.backend. See http://php.net/manual/en/function.password-hash.php when using the native backend and http://php.net/manual/en/function.crypt.php for the sha2 backend. Note that only the following specified options are allowed. For native backend: passwordHash.options.cost. For sha2 backend: passwordHash.options.rounds.
TypeArray
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['passwordHash']['options'] = array();

passwordHash.options.cost
DescriptionAn available option when the passwordHash.backend configuration is set to "native". More information on the native backend can be found at http://php.net/manual/en/function.password-hash.php
TypeInteger
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value10
Override Example
$sugar_config['passwordHash']['options']['cost'] = 15;

passwordHash.options.rounds
DescriptionAn available option when the passwordHash.backend configuration is set to "sha2". More information on the sha2 backend can be found at http://php.net/manual/en/function.crypt.php
TypeInteger
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value5000
Override Example
$sugar_config['passwordHash']['options']['rounds'] = 4000;

passwordHash.rehash

DescriptionWhen enabled, the system will automatically rehash the user's password when successfully authenticated. This allows adoption to the newly configured password hash backend without resetting user's passwords.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['passwordHash']['rehash'] = false;

passwordsetting

DescriptionDefines all of the password requirements for the instance.
TypeArray
Versions5.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['passwordsetting'] = array();

passwordsetting.forgotpasswordON

DescriptionEnables 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.
TypeString
Range of values0, 1
Versions5.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value1
Override Example
$sugar_config['passwordsetting']['forgotpasswordON'] = '0';

passwordsetting.linkexpiration

0
DescriptionDetermines whether the password reset link expires.
TypeString
Range of values0, 1
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['passwordsetting']['linkexpiration'] = '0';

passwordsetting.onelower

0
DescriptionConfigures whether at least one lower-case letter is required in users' passwords.
TypeString
Range of values0, 1
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['passwordsetting']['onespecial'] = '0';

passwordsetting.onenumber

DescriptionConfigures whether at least one number is required in users' passwords.
TypeString
Range of values0, 1
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value1
Override Example
$sugar_config['passwordsetting']['onenumber'] = '1';

passwordsetting.systexpirationtype

DescriptionSpecifies the unit of measurement for passwordsetting.systexpirationtime. The available options are: Days (1), Weeks (7) and Months (30). This value can be set in the UI via Admin > Password Management.
TypeInteger
Range of values1, 7, and 30
Versions5.5.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value1
Override Example
$sugar_config['passwordsetting']['systexpirationtype'] = '7';

pdf_file_max_lifetime

DescriptionThe interval in seconds of when to expire and remove generated PDF files. It is important to note that the "Remove temporary PDF files" scheduler job must be enabled to remove the PDF files.
TypeInteger : Seconds
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value86400
Override Example
$sugar_config['pdf_file_max_lifetime'] = 86400;

perfProfile

DescriptionAllows for an admin to tweak aspects of the system for performance enhancements when fetching records. As every system is different, your mileage will vary when using the perfProfile settings. Increases or decreases in performance will depend on a combination of primarily the amount of users, amount of unique team sets, and data size per module. The perfProfile parameters are available to be able to fine tune the team security performance no your platform. It is not recommended to change any setting directly in a production environment without testing and understanding the impact.
TypeArray
Versions7.2.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['perfProfile'] = array();

perfProfile.TeamSecurity.default.teamset_prefetch
DescriptionFetches the list of team sets that the current user is a member of in a separate query and use those ID's directly in the team security clause to avoid adding a subquery. Under certain conditions, this may improve team security performance. It is important to note that 'default' applies this applied to all modules. To set specific settings for a specific module, you will need to use: $sugar_config['perfProfile']['TeamSecurity']['{module}']['teamset_prefetch'] = true;
TypeBoolean
Range of valuestrue and false
Versions7.2.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['perfProfile']['TeamSecurity']['default']['teamset_prefetch'] = true;

perfProfile.TeamSecurity.default.teamset_prefetch_max
DescriptionThe maximum amount of team set ID's to include in the team security clause. If the current user is a member of more unique teams sets than this value, the system will fall back to using a regular subquery instead. Under certain conditions, this may improve team security performance. It is important to note that 'default' applies this applied to all modules. To set specific settings for a specific module, you will need to use: $sugar_config['perfProfile']['TeamSecurity']['{module}']['teamset_prefetch_max'] = true;
TypeInteger : Records
Versions7.2.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueempty
Override Example
$sugar_config['perfProfile']['TeamSecurity']['default']['teamset_prefetch_max'] = 500;

perfProfile.TeamSecurity.default.where_condition
DescriptionDetermines whether the team security filtering is applied in the WHERE clause instead of SELECT clause. Under certain conditions, this may improve team security performance. It is important to note that 'default' applies this applied to all modules. To set specific settings for a specific module, you will need to use: $sugar_config['perfProfile']['TeamSecurity']['{module}']['where_condition'] = true;
TypeBoolean
Range of valuestrue and false
Versions7.2.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['perfProfile']['TeamSecurity']['default']['where_condition'] = true;

pmse_settings_default

DescriptionSettings for troubleshooting and debugging the advanced workflow.
TypeArray
Versions7.6.0.0+
EditionsEnterprise, Ultimate
Override Example
$sugar_config['pmse_settings_default'] = array();

pmse_settings_default.error_number_of_cycles

DescriptionNumber of cycles before triggering an error in advanced workflow.
TypeString : Cycles
Versions7.6.0.0+
EditionsEnterprise, Ultimate
Default Value10
Override Example
$sugar_config['pmse_settings_default']['error_number_of_cycles'] = 15;

pmse_settings_default.error_timeout

DescriptionTime in seconds of timeout before triggering an error in advanced workflow.
TypeString : Seconds
Versions7.6.0.0+
EditionsEnterprise, Ultimate
Default Value40
Override Example
$sugar_config['pmse_settings_default']['error_timeout'] = 45;

pmse_settings_default.logger_level

DescriptionThe default logger level in advanced workflow.
TypeString
Range of valuesemergency, alert, error, warning, notice, info, debug
Versions7.6.0.0+
EditionsEnterprise, Ultimate
Default Valuecritical
Override Example
$sugar_config['pmse_settings_default']['logger_level'] = 'emergency';

require_accounts

DescriptionDetermines whether an account is required for record creation within the system.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['require_accounts'] = false;

rest_response_etag_cache_age

DescriptionControls how long the browser should cache rest responses.
TypeInteger : Seconds
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value10
Override Example
$sugar_config['rest_response_etag_cache_age'] = 15;

roleBasedViews

DescriptionEnables role based views and dropdowns.
TypeBoolean
Range of valuestrue and false
Versions7.6.0.0+
EditionsEnterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['roleBasedViews'] = true;

SAML_provisionUser

DescriptionDetermines whether or not a new user is auto-provisioned when authenticating through SAML. Setting this setting to false will prevent a new user from being created.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['SAML_provisionUser'] = false;

SAML_X509Cert

DescriptionThe SAML Certificate Key.
TypeString : SAML Certificate Key
Versions6.1.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['SAML_X509Cert'] = '-----BEGIN CERTIFICATE-----CERTIFICATE KEY-----END CERTIFICATE-----';

search_engine

DescriptionArray that defines the search enginer behaviors.
TypeArray
Versions7.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['search_engine'] = array();

search_engine.max_bulk_delete_threshold

DescriptionThe maximun number of records that can be deleted at a time.
TypeInteger : Number of records
Versions7.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value3000
Override Example
$sugar_config['search_engine']['max_bulk_delete_threshold'] = 3000;

search_engine.max_bulk_query_threshold

DescriptionThe maximum number of records to process before starting to bulk insert. Prevents memory issues.
TypeInteger : Number of records
Versions7.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value15000
Override Example
$sugar_config['search_engine']['max_bulk_query_threshold'] = 20000;

search_engine.max_bulk_threshold

DescriptionThe maximum number of records to process before starting to bulk insert. Prevents memory issues.
TypeInteger
Versions7.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value5000
Override Example
$sugar_config['search_engine']['search_engine.max_bulk_threshold'] = 10000;

search_engine.postpone_job_time

DescriptionAmount of time to postpone a job by so that it's not executed twice during the same request.
TypeInteger : Seconds
Versions7.2.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value120
Override Example
$sugar_config['search_engine']['search_engine.postpone_job_time'] = 70;

search_wildcard_infront

DescriptionIn 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.
TypeBoolean
Range of valuestrue and false
Versions6.4.3+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['search_wildcard_infront'] = true;

session_dir

DescriptionDirectory 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.
TypeString
Range of valuesDirectory path
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueempty
On-Demand Valueempty
Override Example
$sugar_config['session_dir'] = '/tmp/SugarSession/';

showThemePicker

DescriptionRemoves the theme selection drop down.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['showThemePicker'] = false;

show_download_tab

DescriptionUsed 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.
TypeBoolean
Range of valuestrue and false
Versions6.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['show_download_tab'] = true;

site_url

DescriptionCurrent URL of your Sugar instance. This value is critical in its accuracy for multiple points of functionality in the instance.
TypeString : URL
Range of valuesCurrent URL of Sugar
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['site_url'] = 'http://my.sugarinstance.com';

slow_query_time_msec

DescriptionSlow query time threshold. Instances running on the On-Demand environment will have this setting enforced as 5000.
TypeString : Milliseconds
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value5000
On-Demand Value5000
Override Example
$sugar_config['slow_query_time_msec'] = '1000';

smtp_mailer_debug

0
DescriptionThe smtp_mailer_debug is used for increasing the debugging output for PHPMailer on individual instances so that more information can be seen when there are bugs or escalations. The default is 0 and produces no additional output for errors. 1-4 log the additional error information to sugarcrm.log as specified by PHPMailer at https://github.com/PHPMailer/PHPMailer/wiki/SMTP-Debugging#debug-levels .
TypeInteger
Range of values0, 1, 2, 3, 4
Versions7.9.1.0+
EditionsProfessional, Enterprise, Ultimate
Override Example
$sugar_config['smtp_mailer_debug'] = 4;

stack_trace_errors

DescriptionDisplays stack trace of errors.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['stack_trace_errors'] = true;

studio_max_history

DescriptionWhen 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.
TypeInteger : Number of files to keep
Range of valuesAny integer
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value50
On-Demand Value50
Override Example
$sugar_config['studio_max_history'] = 100;

sugar_version

DescriptionThe 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.
TypeString : Version Number
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['sugar_version'] = '6.7.3';

tmp_dir

DescriptionThe directory path for temporary XML files used by charts and diagnostics.
TypeString : Directory path
Range of valuesFilesystem path
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuecache/xml/
Override Example
$sugar_config['tmp_dir'] = 'cache/xml/';

tmp_file_max_lifetime

DescriptionThe interval in seconds of when to expire and remove temporary upload files. It is important to note that the "Remove temporary files" scheduler job must be enabled to remove the temporary files.
TypeInteger : Seconds
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value86400
Override Example
$sugar_config['tmp_file_max_lifetime'] = 86400;

tracker_max_display_length

DescriptionThe number of records that will be shown per record in the "Last Viewed" section located under each module tab.
TypeInteger : Number of records
Versions6.0.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['tracker_max_display_length'] = 45;

unique_key

DescriptionSpecifies 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.
TypeString : Unique Identifier
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['unique_key'] = 'c0b5475f3f5b26ddb2976edc8865b5f6';

upload_badext

DescriptionAn 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.
TypeArray
Range of valuesExtensions that cannot be uploaded as is
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['upload_badext'][] = 'swf';

upload_dir

DescriptionThe directory path where uploaded files are stored for note attachments, documents, and module loadable packages. By default, uploads are stored in the ./upload/ directory.
TypeString
Range of valuesDirectory path
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valueupload/
Override Example
$sugar_config['upload_dir'] = 'upload/'

upload_maxsize

DescriptionThe 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 PHP upload_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.
TypeInteger : Filesize in bytes
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['upload_maxsize'] = 40000000;

upload_wrapper_class

DescriptionThe name of the class used as upload wrapper.
TypeString : Upload wrapper class
Versions6.7.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default ValueUploadStream
Override Example
$sugar_config['upload_wrapper_class'] = 'SugarUploadS3';

use_common_ml_dir

DescriptionA 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'.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['use_common_ml_dir'] = true;

use_php_code_json

DescriptionDetermines if the environment has a valid version of PHP-JSON. This should be determined by the function returnPhpJsonStatus() and shouldn't be overridden.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['use_php_code_json'] = true;

use_real_names

DescriptionDisplay users' full names instead of their User Names in assignment fields.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['use_real_names'] = true;

use_sprites

DescriptionA 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).
TypeBoolean
Range of valuestrue and false
Versions6.4.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['use_sprites'] = false;

validation

DescriptionAn array that defines settings for user input validation behaviors.
TypeArray
Versions7.7.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['validation'] = array();

validation.compat_mode

DescriptionDetermines compatibility mode for superglobals in the input validation framework. When enabled, setting, unsetting, and modifying $_GET, $_POST, or $_REQUEST values through PHP code is supported. Using PHP code to manipulate superglobals is discouraged. User input parameters should be considered read-only. As a transition period, this is currently allowed out-of-box, but may change in a future release. It is highly recommended for developers to verify their customizations work with this parameter set to false in preparation for the 7.9 release.
TypeBoolean
Range of valuestrue and false
Versions7.7.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value7.7.x: true
7.8.x: true
7.9.x: false
Override Example
$sugar_config['validation']['compat_mode'] = false;

validation.soft_fail

DescriptionDetermines whether soft failure mode for the input validation framework is enabled. When this mode is enabled, any input validation violations will only be reported as a warning in the sugarcrm.log without having any negative impact on the request. When disabled, violations are reported as fatal in the sugarcrm.log and actual exceptions are being thrown resulting in an HTTP 500 response.
TypeBoolean
Range of valuestrue and false
Versions7.7.1.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value7.7.x: true
7.8.x: true
7.9.x: true
Override Example
$sugar_config['validation']['soft_fail'] = false;

vcal_time

DescriptionUsed 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.
TypeString : Months
Range of values'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', and '12'
Versions5.2.0.c+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value2
Override Example
$sugar_config['vcal_time'] = '5';

verify_client_ip

DescriptionWhether 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['verify_client_ip'] = false;

wl_list_max_entries_per_page

DescriptionThe number of records to be shown per page on the listview of the mobile browser.
TypeInteger : Number of records to display
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value10
Override Example
$sugar_config['wl_list_max_entries_per_page'] = 10;

wl_list_max_entries_per_subpanel

DescriptionDetermines the number of records shown in the subpanels on the DetailView of the mobile browser.
TypeInteger : Records
Versions5.2.0+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value3
Override Example
$sugar_config['wl_list_max_entries_per_subpanel'] = 3;

xhprof_config

DescriptionConfiguration settings for xhprof. More information on xhprof can be found at http://pecl.php.net/package/xhprof.
TypeArray
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['xhprof_config'] = array();

xhprof_config.enable

DescriptionEnables the xhprof profiler.
TypeBoolean
Range of valuestrue and false
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['xhprof_config']['enable'] = true;

xhprof_config.filter_wt

0
DescriptionThe wall time. Values are specified in milliseconds.
TypeInteger : Wall time in milliseconds
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['xhprof_config']['filter_wt'] = 2;

xhprof_config.flags

DescriptionThe flags for xhprof profiler.
TypeString : xhprof flags
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['xhprof_config']['flags'] = XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY;

xhprof_config.ignored_functions

DescriptionAn array of function names to ignore from the profile.
TypeArray : Function names
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['xhprof_config']['ignored_functions'] = array("function_name");

xhprof_config.log_to

DescriptionThe path to log the xhprof profiler output to.
TypeString : Directory path
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Override Example
$sugar_config['xhprof_config']['log_to'] = '{instance server path}/cache/xhprof';

xhprof_config.manager

DescriptionThe xhprof manager class to use. Prior to 7.7, specifying values xhprof_config.save_to, xhprof_config.mongodb_uri, xhprof_config.mongodb_db, xhprof_config.mongodb_collection, xhprof_config.mongodb_options, and xhprof_config.filter_wt will need to have set xhprof_config.manager set to 'SugarXHprofPerformance'. As of 7.7, setting xhprof_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 extend SugarXHprof. If a custom class doesn't exist or hasn't been specified, SugarXHprof will be used.
TypeString : Class
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default ValueSugarXHprof
Override Example
$sugar_config['xhprof_config']['manager'] = 'CustomSugarXHprof';

xhprof_config.memory_limit

DescriptionThe memory limit to set while saving profile data to storage.
TypeString : Memory Usage
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Value2048M
Override Example
$sugar_config['xhprof_config']['memory_limit'] = '1024M';

xhprof_config.mongodb_collection

DescriptionThe name of the mongo db collections.
TypeString : Mongo collection name
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueresults
Override Example
$sugar_config['xhprof_config']['mongodb_db'] = 'results_new';

xhprof_config.mongodb_db

DescriptionThe name of the mongo database.
TypeString : Database name
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuexhprof
Override Example
$sugar_config['xhprof_config']['mongodb_db'] = 'xhprof2';

xhprof_config.mongodb_options

DescriptionOptions for mongo db connection. The list of construct options can be found at: http://php.net/manual/en/mongoclient.construct.php#mongo.mongoclient.construct.parameters
TypeArray : Mongo db options
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valueresults
Override Example
$sugar_config['xhprof_config']['mongodb_options'] = array();

xhprof_config.mongodb_uri

DescriptionThe mongo server URL.
TypeString : URL
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuemongodb://localhost:27017
Override Example
$sugar_config['xhprof_config']['mongodb_uri'] = 'mongodb://localhost:27018';

xhprof_config.sample_rate

DescriptionThe sample rate of the xhprof profiler. 1/{specified value} requests are profiled. To sample all requests, set this value to 1.
TypeInteger : Sample Rate (1/{value})
Versions6.5.10+
EditionsCommunity Edition, Professional, Corporate, Enterprise, Ultimate
Default Value10
Override Example
$sugar_config['xhprof_config']['sample_rate'] = 1;

xhprof_config.save_to

DescriptionThe place to save xhprof data. If set to 'mongodb', the data is stored in the mongo database.
TypeString : Save Location
Range of values'file' and 'mongodb'
Versions7.6.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuemongodb
Override Example
$sugar_config['xhprof_config']['save_to'] = 'mongodb';

xhprof_config.track_elastic

DescriptionWhether or not to track elastic data.
TypeBoolean
Range of valuestrue or false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['xhprof_config']['track_elastic'] = false;

xhprof_config.track_elastic_backtrace

DescriptionWhether or not to store the elastic backtrace data.
TypeBoolean
Range of valuestrue or false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['xhprof_config']['track_elastic_backtrace'] = false;

xhprof_config.track_sql

DescriptionWhether or not to track SQL queries.
TypeBoolean
Range of valuestrue or false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['xhprof_config']['track_sql'] = false;

xhprof_config.track_sql_backtrace

DescriptionWhether or not to store the SQL backtrace data.
TypeBoolean
Range of valuestrue or false
Versions7.7.0.0+
EditionsProfessional, Corporate, Enterprise, Ultimate
Default Valuetrue
Override Example
$sugar_config['xhprof_config']['track_sql_backtrace'] = false;

Last modified: 09/29/2017 10:41am