Administration
Overview
The Administration class is used to manage settings stored in the database config table.
The Administration Class
The Administration class is located in ./modules/Administration/Administration.php. Settings modified using this class are written to the config table.
Creating / Updating Settings
To create or update a specific setting, you can specify the new value using theÂ saveSetting() function as shown here:
require_once 'modules/Administration/Administration.php';
$administrationObj = new Administration();
//save the setting
$administrationObj->saveSetting("MyCategory", "MySetting", 'MySettingsValue');
Retrieving Settings
You can access the config settings by using theÂ retrieveSettings() function. You can filter the settings by category by passing in a filter parameter. If no value is passed to retrieveSettings(), all settings will be returned. An example is shown here:
require_once 'modules/Administration/Administration.php';
$administrationObj = new Administration();
//Retrieve all settings in the category of 'MyCategory'.
//This parameter can be left empty to retrieve all settings.
$administrationObj->retrieveSettings('MyCategory');
//Use a specific setting
$MySetting = $administrationObj->settings['MyCategory_MySetting'];
Considerations
The Administration class will store the settings in the config table, and the config table is cached using SugarCache as the admin_settings_cache.Â This class should be used for storing dynamic settings for a module, connector or the system as a whole, such as the last run date (for a scheduler) or an expiring token (for a connector). You should not use the Administration class to store User-based settings, settings that are frequently changing or being written to via the API, or excessively large values, as this can degrade the performance of the instance since all settings are loaded into the admin_settings_cache, which is used throughout the system.


Alternatively, you can use the Configurator class, located in ./modules/Configurator/Configurator.php, to store the settings in the ./config_override.php file if the settings are not dynamic or not changing programmatically. ItÂ is important to note that settings stored using the configurator will cause a metadata hash refresh that may lead to users being logged out of the system.
  	Last modified: 2023-02-03 21:04:03


Configurator
Overview
The Configurator class, located in ./modules/Configurator/Configurator.php,Â handles the config settings found in ./config.php and ./config_override.php.
Retrieving Settings
You can access the Sugar config settings by using the global variable $GLOBALS['sugar_config'] as shown below:
global $sugar_config;
//Use a specific setting
$MySetting = $sugar_config['MySetting'];
If you should need to reload the config settings, this is an example of how to retrieve a specific setting using the configurator:
require_once 'modules/Configurator/Configurator.php';
$configuratorObj = new Configurator();
//Load config
$configuratorObj->loadConfig();
//Use a specific setting
$MySetting = $configuratorObj->config['MySetting'];
Creating / Updating Settings
To create or update a specific setting, you can specify the new value using the configurator as shown below:
require_once 'modules/Configurator/Configurator.php';
$configuratorObj = new Configurator();
//Load config
$configuratorObj->loadConfig();
//Update a specific setting
$configuratorObj->config['MySetting'] = "MySettingsValue";
//Save the new setting
$configuratorObj->saveConfig();
Considerations
When looking to store custom settings, the Configurator class will store the settings in the ./config_override.php file. This class should only be used for long-termÂ configuration options asÂ Configurator->saveConfig() will trigger a metadata refresh that may log users out of the system.
Alternatively, you can use the Administration class, located in ./modules/Administration/Administration.php, to store settings in the config table in the database.Â This AdministrationÂ class should be used for storing dynamic settings such as a last run date or an expiring token.


TopicsCore SettingsSugar configuration settings.Silent Installer SettingsThe Sugar silent installer facilitates and automates the installation of the Sugar application after the files have been copied onto the server. This is done by populating correct parameters in a configuration file and then making a web request to kick off the installation.
  	Last modified: 2023-02-03 21:04:03


Silent Installer Settings
Overview
The Sugar silent installer facilitates and automates the installation of the Sugar application after the files have been copied onto the server. This is done by populating correct parameters in a configuration file and then making a web request to kick off the installation.
config_si.php
The ./config_si.php file is located at the root level of the Sugar application. It contains an array of name-value pairs consisting of the relevant parameters for installation of the app. The array name is $sugar_config_si. An example file looks like:
<?php
$sugar_config_si = array (
    'setup_site_url' => 'http://${domainname}:${webport}/sugar',
    'setup_system_name' => '${systemname}',
    'setup_db_host_name' => 'localhost',
    'setup_site_admin_user_name' => 'admin',
    'setup_site_admin_password' => '${sugarpassword}',
    'demoData' => true,
    'setup_db_type' => 'mysql',
    'setup_db_host_name' => '{db_host_name}',
    'setup_db_port_num' => 'db_port_number',
    'setup_db_database_name' => 'sugar',
    'setup_db_admin_user_name' => 'root',
    'setup_db_admin_password' => '${rootpassword}',
    'setup_db_options' => array(
    	'ssl' => true,
    ),
    'setup_db_drop_tables' => false,
    'setup_db_create_database' => true,
    'setup_license_key' => '${slkey}',
    'setup_license_key_users' => '${slkeyusers}',
    'setup_license_key_expire_date' => '${slkeyexpiredate}',
    'setup_license_key_oc_licences' => '${slkey_oc_licenses}',


'setup_license_key_oc_licences' => '${slkey_oc_licenses}',
    'default_currency_iso4217' => 'USD',
    'default_currency_name' => 'US Dollars',
    'default_currency_significant_digits' => '2',
    'default_currency_symbol' => '$',
    'default_date_format' => 'Y-m-d',
    'default_time_format' => 'H:i',
    'default_decimal_seperator' => '.',
    'default_export_charset' => 'ISO-8859-1',
    'default_language' => 'en_us',
    'default_locale_name_format' => 's f l',
    'default_number_grouping_seperator' => ',',
    'export_delimiter' => ',',
);
Essential Settings
The following are settings that must be set:
General System Settings
setup_system_name
Description
A unique system name for the application that will be displayed on the web browser
Type
String
setup_site_url
Description
The site location and URL of the Sugar application
Type
String
setup_site_admin_user_name
Description
Specifies the admin username for the Sugar application
Type
String
setup_site_admin_password
Description
Specifies the admin password for the Sugar application
Type
String
demoData
Description
Indicates whether the app will be installed with demo data
Type
Boolean
Database Settings
setup_db_type
Description
Defines the type of database being used with Sugar. It is important to note that db2 and oracle are only applicable to Sugar Ent and Ult.
Type
String: valid options include mysql, mssql, db2, oracle
setup_db_host_instance
Description
Defines the host instance for MSSQL connections.
Type
String : Database Host Instance Name
setup_db_host_name
Description
Defines the hostname of the database server.
Type
String
setup_db_port_num


Description
Defines the hostname of the database server.
Type
String
setup_db_port_num
Description
Defines the port number on the server to connect to for authentication and transactions.
Type
String
setup_db_database_name
Description
Defines the database name to connect to on the database server.
Type
String
setup_db_admin_user_name
Description
Specifies the database administrator's username
Type
String
setup_db_admin_password
Description
Specifies the database administrator's password
Type
String
Recommended Database Settings
The following are not necessarily required, but it is recommended that at least one is set:
setup_db_create_database
Description
Specifies whether Sugar will create a new database with the name given or use an existing database.
Type
Boolean
setup_db_drop_tables
Description
Specifies whether Sugar will drop existing tables on a database if the database already exists
Type
Boolean
Extended Database Settings
There is also an option for an additional array of db config settings. These array entries are equivalent to the Core Settings options prefixed with dbconfigoption. For example dbconfigoption.collation and dbconfigoption.ssl
setup_db_options
Description
See: Architecture/Configurator/Core_Settings/index.html#dbconfigoptionautofree
Type
Array
Full-Text Search (ElasticSearch) Settings
setup_fts_type
Description
The Full-Text Search service type
Type
String, currently only supported value Elastic
setup_fts_host
Description
The hostname of the Full-Text Search service
Type
String
setup_fts_port
Description
The port number of the Full-Text Search service
Type
String
Advanced Full-Text Search Configuration Settings


Type
String
Advanced Full-Text Search Configuration Settings
While not required, the Silent Installer offers a few FTS settings not available in the browser-based installation process. These settings are considered more advanced and should not be implemented casually. Further details on advanced ElasticSearch configuration can be found in the ElasticSearch installation guide in the section Advanced Configuration.
setup_fts_curl
Description
Additional settings for the cURL request to the Elasticsearch server, keyed by the PHP cURL constants used for curl_setopt. For exampleÂ Â
'setup_fts_curl' => array(
	CURLOPT_SSL_VERIFYPEER = false,
),
Type
Array
License Settings
While not required during installation, the license settings are required for Sugar to be usable by all users. Setting the license settings during the Silent Install will save the need to enter this required data after the install.
setup_license_key
Description
Specifies the license key
Type
String
setup_license_key_users
Description
Specifies the number of license key users
Type
Integer
setup_license_key_expire_date
Description
The expiration date of the license key
Type
String: yyyy-mm-dd format
setup_site_sugarbeet_automatic_checks
Description
Specifies if License Validation checks should be set to Automatic
Type
Boolean
Additionally, Offline Client license settings can be set in Silent Installer
setup_license_key_oc_licences
Description
the number of offline client users
Type
Integer
setup_num_lic_oc
Description
the number of offline client users
Type
Integer
Making the Web Request
After the ./config_si.php file is in place, the following web request can be made to kick off the installation:
http://${hostname}/sugar/install.php?goto=SilentInstall&cli=true


http://${hostname}/sugar/install.php?goto=SilentInstall&cli=true
where ${hostname} is the name of the host. Upon completion of the process, the installation should respond with Success, and you may navigate to the web address to find an installed version of Sugar.
Configuring a Sugar-Specific Database User during Install
By default, Sugar will use the database user set for the install process as the database user for general use after installation. There are three different Silent Install options for having Sugar use a different database user once installed. Which option the installer users is determined by the dbUSRData config setting.
The dbUSRData silent install config setting has four valid options:
same
This is the default setting used, even when dbUSRData is not explicitly set. The DB user provided for installing Sugar is used for running Sugar after installation.
auto
Sugar will create a new database user using a self-generated username and password.
In your $sugar_config_si array, the options for this to work as expected are:
'dbUSRData' => 'auto',
'setup_db_create_sugarsales_user' => true,
provide
Sugar will use the provided database username and password after installation, and the installer assumes that the database user has already been created on the database and that the provided password is valid. Essentially this is informing Sugar to use a different existing DB user after the installation has completed.
In your $sugar_config_si array, the options for this to work as expected are:
'dbUSRData' => 'provide',
'setup_db_create_sugarsales_user' => false,
'setup_db_sugarsales_user' => '{existing_db_user_name}',
'setup_db_sugarsales_password' => '{existing_db_user_password}',
'setup_db_sugarsales_password_retype' => '{existing_db_user_password}',
create


create
Sugar will create a new database user using the provided database username and password after installation. This is similar to 'provide', except that Sugar assumes that it will be creating the database user during installation.
In your $sugar_config_si array, the options for this to work as expected are:
'dbUSRData' => 'create',
'setup_db_create_sugarsales_user' => true,
'setup_db_sugarsales_user' => '{new_db_user_name}',
'setup_db_sugarsales_password' => '{new_db_user_password}',
'setup_db_sugarsales_password_retype' => '{new_db_user_password}',
Note: For create, the installer will create a user with access only to the database created for this Sugar instance. It will also have limited access for which host it can connect from, versus the admin user, which usually has access from any host.
Sugar will set the user to have access to localhost and the provided hostname derived from setup_site_url. If there are issues connecting to the database during or after installation, check that the user was created correctly in the database and that the user can connect from the host that the instance is on.
Other Silent Install Config Options
Many of these options match an equivalent Sugar Config option, with further descriptions available at Core Settings.
cache_dir
Description
This is the directory Sugar will store all cached files. Can be relative to Sugar root directory.
Type
String, default "cache/"
Locale Settings
The following options are locale settings. With one exception, these can be set or updated through Administration > Locale.Â
export_delimiter
Description
The field delimiter (separator) used when exporting records as CSV
Type
String, default ","
default_export_charset
Description
The default character set for CSV files to be encoded in when exporting
Type


Description
The default character set for CSV files to be encoded in when exporting
Type
String, default "ISO-8859-1"
default_currency_iso4217
Description
The ISO-4217 code of the default currency
Type
String, default "USD"
default_currency_name
Description
The name to use for the default currency
Type
String, default "US Dollars"
default_currency_significant_digits
Description
Changes the number of significant digits in currency by default.
Note that this setting can not be changed through the Admin panel after installation. It can be set for each user through the user's profile or can be updated globally by updating the config array.
Type
Integer, default 2
default_currency_symbol
Description
The symbol to use for the default currency
Type
String, default "$"
default_language
Description
Sets each user's default language. Possible values include any language offered by Sugar, such as: 'ar_SA', 'bg_BG', 'ca_ES', 'cs_CZ', 'da_DK', 'de_DE', 'el_EL', 'en_UK', 'en_us', 'es_ES', 'es_LA', 'zh_CN'
Type
String, default "en_US"
default_date_format
Description
Modifies the default date format for all users.
Type
String, default "m/d/Y"
default_time_format
Description
Modifies the default time format for all users.
Type
String, default "H:i"
default_decimal_seperator
Description
Sets the character used as a decimal separator for numbers.
Type
String, default "."
default_number_grouping_seperator
Description
Sets the character used as the 1000s separator for numbers.
Type
String, default ","
default_locale_name_format
Description
Sets the format for displaying full name (eg "Salutation FirstName LastName" vs "LastName, FirstName"


Type
String, default "s f l"
  	Last modified: 2023-02-03 21:04:03


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
activitystreamcleaner
DescriptionArray that defines the parameters for the Activity Stream purger. TypeArrayVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['activitystreamcleaner'] = array();activitystreamcleaner.keep_all_relationships_activities
DescriptionThis value is used by the ActivityStreamPurger scheduler job to determine whether the link type activities are to be removed. By default, these records are removed along with other activity types such as create, update, etc.  This can be overridden by setting this value equal to true.TypeBooleanRange of valuestrue or falseVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['activitystreamcleaner']['keep_all_relationships_activities'] = true;activitystreamcleaner.limit_scheduler_run
DescriptionSets the number of activity stream records to delete per batch when run by the scheduled job that purges activity stream records.TypeInteger : Number of recordsRange of valuesIntegers, values below 0 become 0Versions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value25000Override Example$sugar_config['activitystreamcleaner']['limit_scheduler_run'] = 1000;activitystreamcleaner.months_to_keep


DescriptionThis value is used by the ActivityStreamPurger scheduler job.  When this job runs, it uses this value to determine which Activity Stream records to prune from the activities table.   Activities with a date older than the current date minus this number of months will be removed from the table.TypeInteger : Number of monthsRange of valuesAny integer greater than or equal to 0Versions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value6Override Example$sugar_config['activitystreamcleaner']['months_to_keep'] = 12;activity_streams
DescriptionArray that defines parameters for processing Data Privacy erasure requests for activity streams. TypeArrayVersions8.0.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['activity_streams'] = array();activity_streams.erasure_job_delay
DescriptionDefines the number of minutes between Activity Stream Erasure jobs. When multiple jobs are queued, this is the number of minutes that will separate their scheduled execution to allow Data Privacy erasures to occur in batches and minimize concurrent execution. These jobs can take some time to run and can tax the overall server performance if the number of Activity Stream records is very large. This setting is related to activity_streams.erasure_job_limit. These settings should be considered together to optimize throughput of Activity Erasure jobs.TypeInteger : MinutesVersions8.0.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['activity_streams']['erasure_job_delay'] = 5;activity_streams.erasure_job_limit


DescriptionDefines the maximum number of Data Privacy Records that can be processed by a single running instance of the Activity Stream Erasure job. This setting is related to activity_streams.erasure_job_delay. These settings should be considered together to optimize throughput of Activity Erasure jobs. For example, the longer that an activity erasure job processes, the more delay will be needed to prevent too many jobs executing in parallel.TypeIntegerVersions8.0.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5Override Example$sugar_config['activity_streams']['erasure_job_limit'] = 8;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.TypeArrayVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride 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 : MillisecondsVersions7.8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value9000Override Example$sugar_config['additional_js_config']['alertAutoCloseDelay'] = 3000;additional_js_config.authStore


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.
Note: This setting is not respected for instances that use SugarIdentity.TypeStringRange of values'cache' and 'cookie'Versions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuecacheOverride Example$sugar_config['additional_js_config']['authStore'] = 'cookie';additional_js_config.disableOmnibarTypeahead
DescriptionDisables the typeahead feature in the listview Omnibar and force users to hit Enter when filtering. From a technical perspective, this will reduce the number of hits to the server.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['additional_js_config']['disableOmnibarTypeahead'] = true;additional_js_config.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 browser's 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');TypeBooleanRange of valuestrue and falseVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['additional_js_config']['logger']['write_to_server'] = true;additional_js_config.sidecarCompatMode
DescriptionBy default, the Sidecar framework will prevent customizations from calling private Sidecar methods. If after upgrading you find this to be an issue, the configuration can be set to true as a temporary workaround. All JavaScript customizations are expected to use public Sidecar APIs. TypeBooleanRange of valuestrue and falseVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['additional_js_config']['sidecarCompatMode'] = true;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.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['admin_access_control'] = true;admin_export_only
DescriptionAllow only users with administrative privileges to export data.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['admin_export_only'] = true;allowFreezeFirstColumn


DescriptionGlobal admin config that turns the frozen first columns on/off. This setting can be toggled on and off via Admin > System Settings in Sugar or via code in the config.php file. When this setting is turned off, the ability to freeze the first column of data on a list view is disabled. If the setting is enabled, users will have an option to either freeze or unfreeze the first column on a per-module basis, similar to how you can toggle whether or not a field is included as a column in your list view. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanVersions12.0.0+ProductsEnterprise, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['allowFreezeFirstColumn'] = false;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.TypeBooleanRange of valuestrue and falseVersions7.8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride 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.TypeBooleanRange of valuestrue and falseVersions5.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride 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 Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['allow_sendmail_outbound'] = true;analytics
DescriptionAn array defining properties for an analytics connector. Instances running on Sugar's cloud environment will have this setting enforced as a predetermined array.TypeArrayVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Valuea predetermined arrayOverride Example$sugar_config['analytics'] = array();analytics.connector
DescriptionThe name of the connector to use for gathering analytics. Instances running on Sugar's cloud environment will have this setting enforced as a predetermined value.TypeString : Connector nameVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Valuea predetermined valueOverride Example$sugar_config['analytics']['connector'] = 'Pendo';analytics.enabled
DescriptionDetermines if the analytics are enabled. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['analytics']['enabled'] = true;analytics.id


DescriptionThe tracking id for the analytics connector. Instances running on Sugar's cloud environment will have this setting enforced as a predetermined value.TypeString : Tracking IDVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Valuea predetermined valueOverride Example$sugar_config['analytics']['id'] = 'UA-XXXXXXX-X';api
DescriptionAPI specific configurations.TypeIntegerVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['api']=array();api.timeout
DescriptionThe timeout in seconds when uploading files through the REST API.TypeInteger : SecondsVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value180Override Example$sugar_config['api']['timeout'] = 240;authenticationClass
DescriptionThe class to be used for login authentication.TypeString : Sugar Authentication ClassRange of valuesSAMLAuthenticateVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueSugarAuthenticateOverride Example$sugar_config['authenticationClass'] = 'SAMLAuthenticate';aws
DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeArrayVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws'] = array();aws.aws_key
DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeString : KeyVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws']['aws_key'] = 'key';aws.aws_secret
DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeString : KeyVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws']['aws_secret'] = 'secret';aws.upload_bucket


DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeString : S3 bucket nameVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws']['upload_bucket'] = 'bucket';cache
DescriptionArray that defines additional properties for SugarCache if it's enabled (see external_cache).TypeArrayVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cache'] = array();cache.backend
DescriptionDefines the SugarCache backend to use via a fully qualified class name (FQCN). Instances running on Sugar's cloud environment will have this setting enforced as Sugarcrm\Sugarcrm\Cache\Backend\BackwardCompatible.TypeString : Cache LibraryRange of values'Sugarcrm\Sugarcrm\Cache\Backend\Redis' , '\Sugarcrm\Sugarcrm\Cache\Backend\APCu' , '\Sugarcrm\Sugarcrm\Cache\Backend\Memcached' , '\Sugarcrm\Sugarcrm\Cache\Backend\InMemory' , ''Versions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueSugarcrm\Sugarcrm\Cache\Backend\BackwardCompatibleSugarCloud ValueSugarcrm\Sugarcrm\Cache\Backend\BackwardCompatibleOverride Example$sugar_config['cache']['backend'] = 'Sugarcrm\Sugarcrm\Cache\Backend\Redis';cache.disable_gz
DescriptionDefines whether the SugarCache compression should be disabled in multi-tenant deployment, which is not applicable without cache.multi_tenant. This will modify Sugar's caching behavior to disable compression of the cached data. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions12.1.0+ProductsEnterprise, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['cache']['disable_gz'] = true;cache.encryption_key


DescriptionUsed to store encryption key for SugarCache is in multi-tenant mode. By default, Sugar will generate a random UUID string for the encryption key as needed. It is not recommended to change or override this value since it will be regenerated whenever the cache is cleared. Not applicable without  cache.multi_tenant. Instances running on Sugar's cloud environment will have this setting enforced as Random value (unique for each SugarCloud instance).TypeString : UUID stringRange of valuesN/A as it is generated automaticallyVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueRandom value (generated on cache initialization)SugarCloud ValueRandom value (unique for each SugarCloud instance)Override Example$sugar_config['cache']['encryption_key'] = 'Sugar-generated encryption key';cache.gz_level
DescriptionDefines the SugarCache compression level, which is not applicable without cache.multi_tenant. Instances running on Sugar's cloud environment will have this setting enforced as 9.TypeIntegerRange of values0, 1, 2, 3, 4, 5, 6, 7, 8, 9Versions12.1.0+ProductsEnterprise, Serve, SellDefault Value9SugarCloud Value9Override Example$sugar_config['cache']['gz_level'] = 2;cache.multi_tenant
DescriptionDefines whether the SugarCache backend will be used by multiple Sugar instances as part of a multi-tenant deployment. This will modify Sugar's caching behavior to maintain isolation between Sugar instances. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['cache']['multi_tenant'] = true;cache_dir


DescriptionThis is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory.TypeString : DirectoryVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuecache/Override Example$sugar_config['cache_dir'] = 'cache/';cache_expire_timeout
DescriptionThe length of time cached items should be expired after. TypeInteger : SecondsVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value300Override Example$sugar_config['cache_expire_timeout'] = 400;calendar
DescriptionAn array that defines all of the various settings for the Calendar module.TypeArrayVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['calendar'] = array();calendar.day_timestep
DescriptionSets the default day time step.TypeInteger : DaysRange of values15, 30 and 60Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value15Override Example$sugar_config['calendar']['day_timestep'] = 15;calendar.default_view
DescriptionChanges the default view in the calendar module.TypeStringRange of values'day', 'week', 'month' and 'share'Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['calendar']['default_view'] = 'week';calendar.items_draggable
DescriptionEnable/Disable drag-and-drop feature to move calendar items.TypeBooleanRange of valuestrue and falseVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['calendar']['items_draggable'] = true;calendar.items_resizable


DescriptionSets whether items on the calendar can be resized via clicking and dragging.TypeBooleanRange of valuestrue and falseVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['calendar']['items_resizable'] = true;calendar.show_calls_by_default
DescriptionDisplay/Hide calls by default.TypeBooleanRange of valuestrue and falseVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['calendar']['show_calls_by_default'] = true;calendar.week_timestep
DescriptionThe default week step size when viewing the calendar.TypeInteger : Calendar Step SizeRange of values15, 30, and 60Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['calendar']['week_timestep'] = 30;check_query
DescriptionValidates queries when adding limits.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['check_query'] = true;check_query_cost
DescriptionSets the maximum cost limit of a query.TypeIntegerVersions5.2.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['check_query_cost'] = 10;clear_resolved_date
DescriptionIn Sugar Serve version 9.3 and higher, the Resolved Date field on Cases is automatically cleared when the case's status changes from "Closed", "Rejected", or "Duplicate" to any other value. Setting this parameter to false prevents Sugar from automatically clearing the Resolved Date field.TypeBooleanRange of valuestrue and falseVersions9.3.0+ProductsServeDefault ValuetrueOverride Example$sugar_config['clear_resolved_date'] = false;cloud_insight


DescriptionArray that defines the properties for SugarCloud Insights. TypeArrayVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cloud_insight'] = array();cloud_insight.enabled
DescriptionDetermines if the SugarCloud Insights service is enabled. TypeBooleanRange of valuestrue and falseVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['cloud_insight']['enabled'] = false;cloud_insight.key
DescriptionSpecifies the unique key for the SugarCloud Insights service.TypeString : KeyVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cloud_insight']['key'] = '<insights key>';cloud_insight.url
DescriptionThe current URL for SugarCloud Insights service. TypeString : URLVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cloud_insight']['url'] = 'https://sugarcloud-insights.service.sugarcrm.com';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.TypeBooleanRange of valuestrue and falseVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['collapse_subpanels'] = true;cron


DescriptionArray that defines all of the cron parameters.TypeArrayVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cron'] = array();cron.enforce_runtime
DescriptionDetermines if cron.max_cron_runtime is enforced during the cron run.TypeBooleanRange of valuestrue and falseVersions7.2.2.2+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride 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 ).TypeIntegerVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value6.5.x: 107.6.x: 25Override 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 : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value180Override 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 : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value30Override Example$sugar_config['cron']['min_cron_interval'] = 30;csrf
DescriptionAn array defining attributes for CSRF token protection.TypeArrayVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride 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.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['csrf']['soft_fail_form'] = true;csrf.token_size
DescriptionThe size in bytes of the CSRF token to generate.TypeInteger : BytesVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value32Override Example$sugar_config['csrf']['token_size'] = 16;customPortalPlatforms


DescriptionThis configuration allows a platform with custom authentication to be excluded from an IDM integration.TypeArray : PlatformsVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['customPortalPlatforms'] = array('platform1', 'platform2');custom_help_base_url
DescriptionAllows an instance to specify a custom help url for their userTypeString : URLVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuehttp://www.sugarcrm.com/crm/product_doc.phpOverride 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 addressVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuehttp://www.sugarcrm.com/crm/product_doc.phpOverride 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.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['dbconfig'] = array();dbconfig.db_host_instance
DescriptionDefines the host instance for MSSQL connections.TypeString : Database Host Instance NameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 nameRange of valueshost name of database serverVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 Sugar's cloud environment will have this setting enforced as MysqliManager.TypeString : Database ManagerRange of valuesThe class name of the database driver, Possible values are: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', and 'SqlsrvManager'.Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueDetermined by install: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', or 'SqlsrvManager'SugarCloud ValueMysqliManagerOverride 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 NameRange of valuesdatabase nameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 : PasswordRange of valuespassword of the user defined in db_user_nameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 PortRange of valuesport number to connect to on the database serverVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3306Override 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 Sugar Enterprise and Ultimate.TypeString : Database EngineRange of values'mysql', 'mssql', 'db2', and 'oci8'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['dbconfig']['db_type'] = 'mysql';dbconfig.db_user_name
DescriptionDefines the user to connect to the Sugar database as.TypeString : Database UserVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['dbconfig']['db_user_name'] = 'sql_user';dbconfigoption.autofree
DescriptionAutomatically frees the database reference when it closes the reference.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['autofree'] = true;dbconfigoption.collation
DescriptionThe set of rules to be used for comparing characters in a character set.TypeString : Collation typeVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valueutf8_general_ciOverride Example$sugar_config['dbconfigoption']['collation'] = 'utf8_general_ci';dbconfigoption.debug
DescriptionEnables debugging on the database connection.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['debug'] = true;dbconfigoption.persistent


DescriptionDetermines whether Sugar should use persistent connection when possible to connecting to the database.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['persistent'] = true;dbconfigoption.ssl
DescriptionEnables SSL on the database connection.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['ssl'] = true;dbconfigoption.ssl_options
DescriptionAn array detailing the SSL database connection options.TypeArrayRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 pathRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 pathRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 : CipherRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 pathRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride 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 digitsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value2Override Example$sugar_config['default_currency_significant_digits'] = 2;default_date_format
DescriptionModifies the default date format for all users.TypeString : Date formatVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuem/d/YOverride Example$sugar_config['default_date_format'] = 'm/d/Y';default_decimal_seperator
DescriptionSets the character used as a decimal separator for numbers.TypeString : Text characterRange of valuesAny characterVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value.Override Example$sugar_config['default_decimal_seperator'] = '.';default_email_client
DescriptionSets the default email client that opens when users send emails.TypeString : Email clientRange of values'sugar', 'external'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuesugarOverride 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 keyRange of valuesAny available languageVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valueen_usOverride Example$sugar_config['default_language'] = 'en_us';default_number_grouping_seperator
DescriptionSets the character used as the 1000s separator for numbers.TypeString : Text characterRange of valuesAny characterVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault 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.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride 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 Sugar's cloud environment will have this setting enforced as 1528.TypeInteger : Octal ValueVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Value1528Override 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 Sugar's cloud environment will have this setting enforced as 432.TypeInteger : Octal valueVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Value432Override 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 Sugar's cloud environment will have this setting enforced as empty.TypeString : Web groupVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud ValueemptyOverride 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 Sugar's cloud environment will have this setting enforced as empty.TypeString : Web userRange of valuesApache userVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud ValueemptyOverride Example$sugar_config['default_permissions']['user'] = 'apache';default_user_is_admin
DescriptionAllows for determining whether a user is a system administrator by default.TypeBooleanRange of valuestrue, falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['default_user_is_admin'] = true;deny_license_update
DescriptionDetermines whether the license key in Admin > License Management is editable in the user interface. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions9.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['deny_license_update'] = true;developerMode
DescriptionRebuilds various cached files when a page is accessed. Can be set by an admin in Admin > System Settings. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['developerMode'] = true;developer_mode_visible


DescriptionDetermines whether the Developer Mode flag is visible to administrators in Admin > System Settings.  Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue or falseVersions11.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuefalseOverride Example$sugar_config['developer_mode_visible'] = false;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 : SecondsVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value604800Override Example$sugar_config['diagnostic_file_max_lifetime'] = 604800;disabled_languages
DescriptionAllows an admin to select languages that are disabled for the instance.TypeString : CSV Language KeysVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['disabled_languages'] = 'bg_BG,da_DK,de_DE';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.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['disable_count_query'] = true;disable_export
DescriptionPrevents exports of data into .csv files. Normally set in the UI via Admin > Locale.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['disable_export'] = true;disable_related_calc_fields


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.TypeBooleanRange of valuestrue and falseVersions6.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['disable_related_calc_fields'] = true;disable_team_access_check
DescriptionPrevents the system from checking to see if the creating/editing user has access to the record being saved. In normal circumstances, if a user creates a record and assigns it to a team they are not part of - their private team will be added. Setting this to true will prevent this.TypeBooleanRange of valuestrue and falseVersions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['disable_team_access_check'] = true;disable_unknown_platforms


DescriptionControls whether or not unregistered platforms are allowed to be used when logging in using REST API. Custom platforms can be registered via Admin > Configure API Platforms or by using the Platform extension. Used to prevent excessive metadata generation when invalid or unrecognized platform types are specified in an API call.TypeBooleanRange of valuestrue and falseVersions7.6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7.6 - 7.10: false7.11 and higher: trueOverride 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 Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.2.0.j+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride 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.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['disable_vcr'] = true;dump_slow_queries
DescriptionLogs slow queries to the sugar log file. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['dump_slow_queries'] = true;email_address_separator


DescriptionSets the character used to separate email addresses.TypeString : Text characterRange of valuesAny characterVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value,Override Example$sugar_config['email_address_separator'] = ',';email_default_client
DescriptionSets the default email client for all users.TypeString : StringRange of valuessugar, externalVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuesugarOverride 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.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride 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 : StringRange of values'plain' and 'html'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuehtmlOverride Example$sugar_config['email_default_editor'] = 'plain';email_mailer_timelimit
DescriptionThe timeout period in seconds for SMTP commands. Instances running on Sugar's cloud environment will have this setting enforced as 2.TypeInteger : SecondsRange of valuesAny integer greater than or equal to 1Versions12.2.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value2SugarCloud Value2Override Example$sugar_config['email_mailer_timelimit'] = 30;email_mailer_timeout
DescriptionThe connection timeout period when sending an email.


DescriptionThe connection timeout period when sending an email.
Note: The default value for this configuration is 2 seconds for Sugar versions 12.2.0 and higher. The default value for Sugar versions 7.8.0.0 to 12.1.0 is 10 seconds.
 Instances running on Sugar's cloud environment will have this setting enforced as 2.TypeInteger : SecondsVersions7.8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value2SugarCloud Value2Override Example$sugar_config['email_mailer_timeout'] = 30;email_recipient_chunk_size
DescriptionDefines the maximum number of addresses in the email's To field. If an email is to be sent to more than the email_recipient_chunk_size addresses, the list will be split and multiple duplicate emails will be sent, each one with no more than the email_recipient_chunk_size recipients in the To field. Some email service providers limit maximum number of recipients in an email, this option is intended to workaround such limitations. Instances running on Sugar's cloud environment will have this setting enforced as 10.TypeIntegerRange of valuesAny integer greater than or equal to 1Versions12.1.0+ProductsEnterprise, Serve, SellDefault Value10SugarCloud Value10Override Example$sugar_config['email_recipient_chunk_size'] = 20;enable_link_to_drawer
DescriptionWhen true, the link-to-drawer feature known as "Focus Drawers" will be enabled for links to Sidecar module records instance-wide. Focus Drawers are exclusive to Sugar Sell and Sugar Serve.TypeBooleanRange of valuestrue and falseVersions10.3.0+ProductsServe, SellDefault ValuetrueOverride Example$sugar_config['enable_link_to_drawer'] = false;enable_long_text_search


DescriptionWhen true, Elasticsearch will enable long-text search for the following field types: 'longtext', 'htmleditable_tinymce'.TypeBooleanRange of valuestrue and falseVersions10.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['enable_long_text_search'] = true;enable_mobile_redirect
DescriptionFlag indicating whether smartphone users are automatically redirected to the mobile view when navigating to a Sugar instance.TypeBooleanRange of valuestrue and falseVersions7.1.5+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['enable_mobile_redirect'] = false;enable_one_index
DescriptionIf you are running Elasticsearch 6 or higher, Elasticsearch creates a separate index for each full-text-search-enabled module. However, performance advantages are gained from instead using a single index for the entire instance. The 'enable_one-index' config enables you to move from 1-index-per-module to 1-index-per-instance. This setting can be enabled by an administrator via Admin > Search > Re-Index, and the re-index will automatically switch the instance over to 1 index and change this config to true. TypeBooleanRange of valuestrue or falseVersions11.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['enable_one_index'] = true;exclude_notifications
DescriptionThis setting controls the modules that are excluded from assignment notifications.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['exclude_notifications'] = array();exclude_notifications.module
DescriptionAllows an administrator to explicitly disable modules from sending assignment notifications to users.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['exclude_notifications']['<module>'] = true;external_cache


DescriptionSugarCache basic configuration.TypeArrayVersions6.2.0+ProductsEnterprise, Serve, SellOverride Example$sugar_config['external_cache'] = array();external_cache.memcache
DescriptionThis setting controls the memcache properties.TypeArrayVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['external_cache']['memcache'] = array();external_cache.memcache.host
DescriptionThe host url for memchache.TypeString : Host URLVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value127.0.0.1Override Example$sugar_config['external_cache']['memcache']['host'] = '192.168.1.1';external_cache.memcache.port
DescriptionThe host port for memcache.TypeInteger : Port numberVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value11211Override Example$sugar_config['external_cache']['memcache']['port'] = 11212;external_cache.redis
DescriptionThis setting controls the redis properties.TypeArrayVersions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['external_cache']['redis'] = array();external_cache.redis.host
DescriptionThe IP address or the hostname of the Redis host.TypeStringRange of values'127.0.0.1', '192.168.0.2', 'redis.serveraddress.com', 'local.redis.server.local'Versions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value127.0.0.1Override Example$sugar_config['external_cache'] ['redis'] ['host'] = '127.0.0.1';external_cache.redis.persistent


DescriptionThe type of connection to the Redis server: persistent or not.TypeBooleanRange of valuestrue and falseVersions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['external_cache'] ['redis'] ['persistent'] = false;external_cache.redis.port
DescriptionThe Port number configured in the Redis host.TypeIntegerRange of valuesAny TCP port numberVersions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value6379Override Example$sugar_config['external_cache'] ['redis'] ['port'] = 6377;external_cache.redis.timeout
DescriptionConnection timeout to the Redis server. 0 means unlimited or OS defined.TypeIntegerRange of valuesAny integer greater than or equal to 0Versions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['external_cache'] ['redis'] ['timeout'] = false;external_cache_db_gc_probability
DescriptionProbability factor to determine when garbage collection on stale keys from the DB backend will happen.TypeInteger : Probability factorVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0.0001Override 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 : MillisecondsRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value200Override 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 Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['external_cache_disabled'] = 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 Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['external_cache_disabled_memcached'] = 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 Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['external_cache_disabled_wincache'] = false;external_cache_force_backend
DescriptionForce given external key/value cache backend. Make sure that the requirements are met and any other cache backend specific configuration is applied.TypeString : Backend typeRange of valuesapc, db, file, memcache, memcached, memory, redis, smash, wincache, and zendVersions6.2.0+ProductsProfessional, EnterpriseDefault ValueemptyOverride Example$sugar_config['external_cache_force_backend'] = 'db';forms


DescriptionAn array defining form requirements.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['forms'] = array();forms.requireFirst
DescriptionPresents all required fields grouped together in the first panel on the EditView form.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride 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.TypeBooleanRange of valuestrue and falseVersions6.1.0RC1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['freebusy_use_vcal_cache'] = true;freezeListHeaders


DescriptionGlobal admin config that turns the frozen headers on/off. By default, most list views now have frozen headers and a static pagination element at the bottom of the screen. When the setting is turned off (set to false), this will revert to non-frozen headers and a user having to scroll down to see the pagination buttons. This is enforced in almost every list view in Sugar with the exception of some unique list views that do not have pagination controls. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanVersions12.0.0+ProductsEnterprise, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['freezeListHeaders'] = false;gs_use_shortcut_operator
DescriptionThe default value of true permits use of shortcut operators in global search. These operators are: '&' for AND, '|' for OR, and '-' for NOT. Setting this to false will disable the shortcut operators in global search and cause these characters to be interpreted as literals.TypeBooleanRange of valuestrue and falseVersions8.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['gs_use_shortcut_operator'] = falsehide_admin_licensing
DescriptionHides the License settings subpanel in the administrative panel. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride 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 Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions6.5.15+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride 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.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride 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.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['hide_subpanels_on_login'] = true;hint
DescriptionThe array of configurations related to Hint.TypeArrayVersions10.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['hint'] = array();hint.hint_install_target_geo


DescriptionThis optional property allows you to, before installation of Hint, explicitly set which region you would like Hint to connect to, overriding the default behavior of the Hint installer. The default behavior is for Hint to connect to services hosted in the region nearest to that of the Sugar instance on which it is being installed. See the Hint Administration Guide for more details on Hint service regions: https://support.sugarcrm.com/Documentation/Installable_Connectors/Hint/Hint_Installation_Guide/#Choosing_the_Hint_Services_Region
Note: Once configured, it is not possible to modify the region Hint connects to. Switching regions requires completely uninstalling and reinstalling Hint, which will cause you to lose all existing system and end-user settings.
Note: 'APSE' is only available for 12.0 and higher.TypeStringRange of values'US', 'EU', 'APSE'Versions10.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['hint']['hint_install_target_geo'] = 'US';history_max_viewed
DescriptionThe number of history items from the tracker to display for a user.TypeIntegerVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value50Override Example$GLOBALS['sugar_config']['history_max_viewed'] = 25;host_name
DescriptionSets the host name of the instance, such as the website address or location where the instance is hosted and accessed.TypeString : StringVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuelocalhostOverride Example$sugar_config['host_name'] = 'localhost';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 Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['installer_locked'] = false;jobs
DescriptionJob Queue configurations.TypeArrayVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['jobs'] = array();jobs.hard_lifetime
DescriptionHard deletes all jobs that are older than the hard cutoff. Default is 21 days.TypeInteger : DaysVersions6.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value21Override Example$sugar_config['jobs']['hard_lifetime'] = 21;jobs.max_retries
DescriptionMaximum number of failures for job. Default is 5.TypeInteger : Number of failuresVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5Override Example$sugar_config['jobs']['max_retries'] = 5;jobs.min_retry_interval
DescriptionMinimal interval between job reruns. Default is 30 seconds.TypeInteger : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value30Override 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 : DaysVersions6.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7Override 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 : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3600Override Example$sugar_config['jobs']['timeout'] = 86400;languages
DescriptionThe list of languages available in the system. An administrator can limit the languages available by removing them from this array. When modifying this array, you will need to make sure that the default_language config setting matches a language available in the list.TypeArray : Language KeysVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueAll available languagesOverride Example$sugar_config['languages'] =  array ('en_us' => 'English (US)');list_max_entries_per_page
DescriptionListview items per page.TypeString : Records per pageVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value20Override 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 recordsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value100Override Example$sugar_config['list_report_max_per_page'] = 100;logger
DescriptionAn array that defines all of the logging settings.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger'] = array();logger.channels


DescriptionThis setting controls the PSR-3 Logger channels. There are stock channels included in Sugar that can be utilized for various troubleshooting, and custom channels can easily be utilized in custom code. Please consult the PSR-3 Logger Documentation for further information on modifying channels and utilizing them.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels'] = array();logger.channels.authentication
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the authentication channel.TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['authentication'] = array();logger.channels.authentication.handlers
DescriptionThis setting controls the PSR-3 Logger Handler utilized by the authentication logging channel. TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['authentication']['handlers'][] = 'File';logger.channels.authentication.level
DescriptionThis setting controls the authentication PSR-3 Logger channel's log level. If you need to troubleshoot authentication issues in Sugar, and do not want to enable debug logging on the entire system, you can utilize this channel for more robust logging around the Authentication Controller.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['authentication']['level'] = 'debug';logger.channels.authentication.processors


DescriptionThis setting controls the authentication PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['authentication']['authentication']['processors'] = array('request', 'backtrace');logger.channels.channel
DescriptionThis setting controls the PSR-3 Logger channels. There are stock channels included in Sugar that can be utilized for various troubleshooting, and custom channels can easily be utilized in custom code. The channel configuration typically consists of three properties, the level, handlers, and processors, however not all need to be defined as they do inherit their properties from the default Logger implementation. Please consult the PSR-3 Logger Documentation for further information on adding custom channels and utilizing them.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>'] = array();logger.channels.channel.handlers
DescriptionThis setting controls the PSR-3 Logger Handler utilized by the defined logging channel. By default Sugar only comes with the 'File' handler, however custom handlers can easily be added as outlined in our PSR-3 Logger Documentation.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>']['handlers'][] = 'File';logger.channels.channel.level


DescriptionThis setting controls the PSR-3 Log Level for the specified log channel.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>']['level'] = 'alert';logger.channels.channel.processors
DescriptionThis setting controls a specific PSR-3 Logger channels processors. To more easily debug issues, you can enable the provided backtrace or request Log Processors to provide more insight into a particular log. For more information on adding custom processors and using them on logging channels consult the PSR-3 Logger Documentation.TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>']['processors'] = array('request', 'backtrace');logger.channels.db
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the db channel.TypeArrayVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db'] = array();logger.channels.db.handlers
DescriptionThis setting controls the PSR-3 Logger Handler utilized by the db logging channel. TypeArrayVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db']['handlers'][] = 'File';logger.channels.db.level


DescriptionThis setting controls the Log Level for the db channel of the PSR-3 Logger. TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db']['level'] = 'debug';logger.channels.db.processors
DescriptionThis setting controls the db PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db']['processors'] = array('request', 'backtrace');logger.channels.deprecation
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the deprecation channel. If you need to clean up your customizations from usage of deprecated functionality of Sugar or some underlying libraries which implement runtime deprecation logging and you do not want to enable warning logging on the entire system, you can utilize this channel. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeArrayVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['channels']['deprecation'] = [];logger.channels.deprecation.handlers


DescriptionThis setting controls the PSR-3 Logger Handler utilized by the deprecation logging channel. By default, Sugar only comes with the File handler, however custom handlers can be added as outlined in our PSR-3 Logger documentation. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeArrayVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['channels']['deprecation']['handlers'][] = [ 'type' => 'File', 'name' => 'symfony_deprecations', ];logger.channels.deprecation.level
DescriptionThis setting controls the deprecation PSR-3 Logger channel's log level. Instances running on Sugar's cloud environment will have this setting enforced as alert.TypeString : Logging LevelRange of valuesemergency, alert, critical, error, warning, notice, info, debug, offVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuealertSugarCloud ValuealertOverride Example$sugar_config['logger']['channels']['deprecation']['level'] = 'warning';logger.channels.deprecation.processors
DescriptionThis setting controls the deprecation PSR-3 Logger channels processors. To more easily debug issues, you can enable the provided backtrace or request Log Processors to provide more insight into a particular log. For more information on adding custom processors and using them on logging channels, please refer to the PSR-3 Logger documentation. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeArray : Logging ProcessorsRange of valuesrequest, backtraceVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['deprecation']['processors'] = ['request', 'backtrace'];logger.channels.input_validation


DescriptionThis setting controls the PSR-3 Logger Channel configuration for the input_validation channel.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation'] = array();logger.channels.input_validation.handlers
DescriptionThis setting controls the PSR-3 Logger Handler utilized by the input_validation logging channel. TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation']['handlers'][] = 'File';logger.channels.input_validation.level
DescriptionThis setting controls the logging level for input validation failure messages when validation.soft_fail is enabled.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation']['level'] = 'warning';logger.channels.input_validation.processors
DescriptionThis setting controls the input_validation PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation']['processors'] = array('request', 'backtrace');logger.channels.metadata
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the metadata channel.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata'] = array();logger.channels.metadata.handlers


DescriptionThis setting controls the PSR-3 Logger Handler utilized by the metadata logging channel. TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata']['handlers'][] = 'File';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.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata']['level'] = 'debug';logger.channels.metadata.processors
DescriptionThis setting controls the metadata PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata']['processors'] = array('request', 'backtrace');logger.channels.rest
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the rest channel.TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest'] = array();logger.channels.rest.handlers
DescriptionThis setting controls the PSR-3 Logger Handler utilized by the rest logging channel. TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest']['handlers'][] = 'File';logger.channels.rest.level


DescriptionThis setting controls the Log Level for the rest channel of the PSR-3 Logger. TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest']['level'] = 'debug';logger.channels.rest.processors
DescriptionThis setting controls the rest PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest']['processors'] = array('request', 'backtrace');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 formatRange of valuesPattern for date formatVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value%cOverride Example$sugar_config['logger']['file']['dateFormat'] = '%c';logger.file.ext
DescriptionThe extension of the log file. The default value is '.log'. Instances running on Sugar's cloud environment will have this setting enforced as .log.TypeString : File extensionRange of valuesExtension for the logVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value.logSugarCloud Value.logOverride 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 logsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override 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 Sugar's cloud environment will have this setting enforced as 10MB.TypeString : SizeVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10MBSugarCloud Value10MBOverride Example$sugar_config['logger']['file']['maxSize'] = '10MB';logger.file.name
DescriptionThe name of the log file to be written to. Instances running on Sugar's cloud environment will have this setting enforced as sugarcrm.TypeString : FilenameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuesugarcrmSugarCloud ValuesugarcrmOverride 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 Sugar's cloud environment will have this setting enforced as empty.TypeString : Suffix patternVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride 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 Sugar's cloud environment will have this setting enforced as fatal.TypeString : Logging levelRange of values'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefatalSugarCloud ValuefatalOverride Example$sugar_config['logger']['level'] = 'fatal';logger_visible
DescriptionDetermines whether the Logger Settings panel is visible to administrators in Admin > System Settings. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuefalseOverride 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 Sugar's cloud environment will have this setting enforced as ..TypeString : Directory PathVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value.SugarCloud Value.Override Example$sugar_config['log_dir'] = '.';log_file
DescriptionDesignates the file name where the instance's logs will be stored. Instances running on Sugar's cloud environment will have this setting enforced as sugarcrm.log.TypeString : Name of the log fileVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuesugarcrm.logSugarCloud Valuesugarcrm.logOverride Example$sugar_config['log_file'] = 'new_sugarcrm.log'log_memory_usage
DescriptionLogs the memory usage. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['log_memory_usage'] = true;maintenanceMode
DescriptionAllows the instance to be placed in a maintenance mode where non-admin users cannot access the instance.TypeBooleanRange of valuestrue and falseVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['maintenanceMode'] = false;marketing_extras_enabled
DescriptionThis configuration disables the marketing content on the Sugar login screen.TypeBooleanRange of valuestrue and falseVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['marketing_extras_enabled'] = false;mark_emails_seen