Let the platform do the work

Core Settings

activitystreamcleaner

DescriptionArray that defines the parameters for the Activity Stream purger.
TypeArray
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeBoolean
Range of valuestrue or false
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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
Range of valuesIntegers, values below 0 become 0
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value25000
Override 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
Range of valuesAny integer greater than or equal to 0
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value6
Override Example
$sugar_config['activitystreamcleaner']['months_to_keep'] = 12;

activity_streams

DescriptionArray that defines parameters for processing Data Privacy erasure requests for activity streams.
TypeArray
Versions8.0.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Versions8.0.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeInteger
Versions8.0.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value5
Override 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.
TypeArray
Versions7.5.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['additional_js_config'] = array();

additional_js_config.alertAutoCloseDelay

DescriptionDefines the default auto close delay for system alerts. It is important to note that after changing this setting in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.
TypeInteger
Versions7.8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value9000
Override 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.
TypeString
Range of values'cache' and 'cookie'
Versions7.5.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuecache
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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');
TypeBoolean
Range of valuestrue and false
Versions7.5.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['additional_js_config']['sidecarCompatMode'] = true;

additional_js_config.skipTutorial

DescriptionDisables the tutorial system shown when users log in for the first time.
TypeBoolean
Range of valuestrue and false
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['additional_js_config']['skipTutorial'] = 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['admin_access_control'] = true;

admin_export_only

DescriptionAllow only users with administrative privileges to export data.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Versions12.0.0+
ProductsEnterprise, Serve, Sell
Default Valuetrue
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.8.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['allow_oauth_via_get'] = true;

allow_pop_inbound

DescriptionInbound email accounts are setup to work with IMAP protocols by default. If your email provider required POP3 access instead of IMAP, you can enables POP3 as an available inbound email protocol. Please note that mailboxes configured with a POP3 connection are not supported by SugarCRM and may cause unintended consequences. IMAP is the recommended protocol to use for inbound email accounts.
TypeBoolean
Range of valuestrue and false
Versions5.5.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['allow_pop_inbound'] = true;

allow_sendmail_outbound

DescriptionEnables the option of choosing sendmail as an SMTP server in Admin > Email Settings. Sendmail must be enabled on the server for this option to work. Please note that mailboxes configured with sendmail are not supported and may cause unintended consequences.
TypeBoolean
Range of valuestrue and false
Versions5.5.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['allow_sendmail_outbound'] = true;

analytics

DescriptionAn array defining properties for an analytics connector.
TypeArray
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['analytics'] = array();

analytics.connector

DescriptionThe name of the connector to use for gathering analytics.
TypeString
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['analytics']['connector'] = 'Pendo';

analytics.enabled

DescriptionDetermines if the analytics are enabled.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['analytics']['enabled'] = true;

analytics.id

DescriptionThe tracking id for the analytics connector.
TypeString
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['analytics']['id'] = 'UA-XXXXXXX-X';

api

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

api.timeout

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

authenticationClass

DescriptionThe class to be used for login authentication.
TypeString
Range of valuesSAMLAuthenticate
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default ValueSugarAuthenticate
Override Example
$sugar_config['authenticationClass'] = 'SAMLAuthenticate';

aws

DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.
TypeArray
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['aws'] = array();

aws.aws_key

DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.
TypeString
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['aws']['upload_bucket'] = 'bucket';

cache

DescriptionArray that defines additional properties for SugarCache if it's enabled (see external_cache).
TypeArray
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['cache'] = array();

cache.backend

DescriptionDefines the SugarCache backend to use via a fully qualified class name (FQCN).
TypeString
Range 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, Sell
Default ValueSugarcrm\Sugarcrm\Cache\Backend\BackwardCompatible
Override Example
$sugar_config['cache']['backend'] = 'Sugarcrm\Sugarcrm\Cache\Backend\Redis';

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.
TypeString
Range of valuesN/A as it is generated automatically
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default ValueRandom value (generated on cache initialization)
Override Example
$sugar_config['cache']['encryption_key'] = 'Sugar-generated encryption key';

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.
TypeBoolean
Range of valuestrue and false
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuecache/
Override Example
$sugar_config['cache_dir'] = 'cache/';

cache_expire_timeout

DescriptionThe length of time cached items should be expired after.
TypeInteger
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value300
Override Example
$sugar_config['cache_expire_timeout'] = 400;

calendar

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

calendar.day_timestep

DescriptionSets the default day time step.
TypeInteger
Range of values15, 30 and 60
Versions6.4.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value15
Override Example
$sugar_config['calendar']['day_timestep'] = 15;

calendar.default_view

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

calendar.items_draggable

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

calendar.items_resizable

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

calendar.show_calls_by_default

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

calendar.week_timestep

DescriptionThe default week step size when viewing the calendar.
TypeInteger
Range of values15, 30, and 60
Versions6.4.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['calendar']['week_timestep'] = 30;

check_query

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

check_query_cost

DescriptionSets the maximum cost limit of a query.
TypeInteger
Versions5.2.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Value10
Override 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.
TypeBoolean
Range of valuestrue and false
Versions9.3.0+
ProductsServe
Default Valuetrue
Override Example
$sugar_config['clear_resolved_date'] = false;

cloud_insight

DescriptionArray that defines the properties for SugarCloud Insights.
TypeArray
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['cloud_insight'] = array();

cloud_insight.enabled

DescriptionDetermines if the SugarCloud Insights service is enabled.
TypeBoolean
Range of valuestrue and false
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['cloud_insight']['enabled'] = false;

cloud_insight.key

DescriptionSpecifies the unique key for the SugarCloud Insights service.
TypeString
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['cloud_insight']['key'] = '';

cloud_insight.url

DescriptionThe current URL for SugarCloud Insights service.
TypeString
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['collapse_subpanels'] = true;

cron

DescriptionArray that defines all of the cron parameters.
TypeArray
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['cron'] = array();

cron.enforce_runtime

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

cron.max_cron_jobs

DescriptionMaximum jobs per cron run. Default is 10. If you are using a version prior to 6.5.14, you will need to also populate max_jobs to set this value due to bug #62936 ( https://web.sugarcrm.com/support/issues/62936 ).
TypeInteger
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value6.5.x: 10
7.6.x: 25
Override Example
$sugar_config['cron']['max_cron_jobs'] = 10;

cron.max_cron_runtime

DescriptionDetermines the maximum time in seconds that a single job should be allowed to run. If a single job exceeds this limit, cron.php is aborted with the long-running job marked as in progress in the job queue. The next time cron runs, it will skip the job that overran the limit and start on the next job in the queue. This limit is only enforced when cron.enforce_runtime is set to true.
TypeInteger
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value180
Override Example
$sugar_config['cron']['max_cron_runtime'] = 60;

cron.min_cron_interval

DescriptionMinimum time between cron runs. Setting this to 0 will disable throttling completely.
TypeInteger
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value30
Override Example
$sugar_config['cron']['min_cron_interval'] = 30;

csrf

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

csrf.opt_in

DescriptionCSRF tokens are injected in BWC modules on forms which allow "modify" actions as an additional protection layer against CSRF attacks. This functionality complements SugarCRM's referrer validation for "modify" actions. When forms are posted which trigger a "modify" action without having the proper CSRF token set, the end user will be served a CSRF token mismatch message and requested action will be denied. Additionally, a fatal warning message will be logged ("CSRF: attack vector detected, invalid form token detected"). When using this feature make sure any custom BWC module implement the proper CSRF token injection. CSRF token protection is an opt-in feature of Sugar 7.7 and removed in 7.8+.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['csrf']['opt_in'] = false;

csrf.soft_fail_form

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

csrf.token_size

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

customPortalPlatforms

DescriptionThis configuration allows a platform with custom authentication to be excluded from an IDM integration.
TypeArray
Versions9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['customPortalPlatforms'] = array('platform1', 'platform2');

custom_help_base_url

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

custom_help_url

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

dbconfig

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

dbconfig.db_host_instance

DescriptionDefines the host instance for MSSQL connections.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_host_instance'] = 'SQLEXPRESS';

dbconfig.db_host_name

DescriptionPart of the 'dbconfig' array. Defines the host name of the database server.
TypeString
Range of valueshost name of database server
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_host_name'] = 'localhost';

dbconfig.db_manager

DescriptionPart of the 'dbconfig' array. Defines the specific library used to connect with your database.
TypeString
Range of valuesThe class name of the database driver, Possible values are: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', and 'SqlsrvManager'.
Versions6.4.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default ValueDetermined by install: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', or 'SqlsrvManager'
Override Example
$sugar_config['dbconfig']['db_manager'] = 'MysqliManager';

dbconfig.db_name

DescriptionPart of the 'dbconfig' array. Defines the database name to connect to on the database server.
TypeString
Range of valuesdatabase name
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override Example
$sugar_config['dbconfig']['db_name'] = 'sugar_db';

dbconfig.db_password

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

dbconfig.db_port

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

dbconfig.db_type

DescriptionDefines the type of database being used with Sugar. It is important to note that db2 and oracle are only applicable to Sugar Enterprise and Ultimate.
TypeString
Range of values'mysql', 'mssql', 'db2', and 'oci8'
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['dbconfig']['db_type'] = 'mysql';

dbconfig.db_user_name

DescriptionDefines the user to connect to the Sugar database as.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['dbconfig']['db_user_name'] = 'sql_user';

dbconfigoption.autofree

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

dbconfigoption.collation

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

dbconfigoption.debug

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

dbconfigoption.persistent

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

dbconfigoption.ssl

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

dbconfigoption.ssl_options

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

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

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

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

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

default_currency_significant_digits

DescriptionChanges the number of significant digits in currency by default.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value2
Override Example
$sugar_config['default_currency_significant_digits'] = 2;

default_date_format

DescriptionModifies the default date format for all users.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuem/d/Y
Override Example
$sugar_config['default_date_format'] = 'm/d/Y';

default_decimal_seperator

DescriptionSets the character used as a decimal separator for numbers.
TypeString
Range of valuesAny character
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value.
Override Example
$sugar_config['default_decimal_seperator'] = '.';

default_email_client

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

default_language

DescriptionSets each user's default language. Possible values include any language offered by Sugar, such as: 'ar_SA', 'bg_BG', 'ca_ES', 'cs_CZ', 'da_DK', 'de_DE', 'el_EL', 'en_UK', 'en_us', 'es_ES', 'es_LA', 'et_EE', 'fi_FI', 'fr_FR', 'he_IL', 'hu_HU', 'it_it', 'ja_JP', 'ko_KR', 'lt_LT', 'lv_LV', 'nb_NO', 'nl_NL', 'pl_PL', 'pt_BR', 'pt_PT', 'ro_RO', 'ru_RU', 'sk_SK', 'sq_AL', 'sr_RS', 'sv_SE', 'tr_TR', 'uk_UA', 'zh_CN'
TypeString
Range of valuesAny available language
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueen_us
Override Example
$sugar_config['default_language'] = 'en_us';

default_number_grouping_seperator

DescriptionSets the character used as the 1000s separator for numbers.
TypeString
Range of valuesAny character
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value,
Override Example
$sugar_config['default_number_grouping_seperator'] = ',';

default_permissions

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

default_permissions.dir_mode

DescriptionPart of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created directories. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 1528 equates to the permissions 2770.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['default_permissions']['dir_mode'] = 1528;

default_permissions.file_mode

DescriptionPart of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created files. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 432 in equates to the permissions 660.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['default_permissions']['file_mode'] = 432;

default_permissions.group

DescriptionUsed in UNIX-based systems only to define the group membership of any newly created directories and files. This value should be a group that the Apache user is a member of to help ensure proper functionality.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['default_permissions']['group'] = 'apache';

default_permissions.user

DescriptionPart of the 'default_permissions' array. Used in UNIX-based systems only to define the ownership of any newly created directories and files. This value should be the Apache user.
TypeString
Range of valuesApache user
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['default_permissions']['user'] = 'apache';

default_user_is_admin

DescriptionAllows for determining whether a user is a system administrator by default.
TypeBoolean
Range of valuestrue, false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions9.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['developerMode'] = true;

developer_mode_visible

DescriptionDetermines whether the Developer Mode flag is visible to administrators in Admin > System Settings.
TypeBoolean
Range of valuestrue or false
Versions11.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override 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
Versions7.6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value604800
Override Example
$sugar_config['diagnostic_file_max_lifetime'] = 604800;

disabled_languages

DescriptionAllows an admin to select languages that are disabled for the instance.
TypeString
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override 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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['disable_count_query'] = true;

disable_export

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

DescriptionWhen a calculated field in Sugar uses the related function in the Sugar Logic, this will cause the calculated field to be executed when the related module is updated. This can cause a cascading effect through the system to update related calculated fields. When this happens you may receive a 502 Gateway Error. Please note that this is a global setting that will affect all modules. If you have a calculated field in Accounts that sums up all Opportunities for the account, setting this value to true will no longer update the opportunity account sum in Accounts until the account record itself is modified. However, if this setting is left disabled, the sum would update any time a related opportunity or the account is modified.
TypeBoolean
Range of valuestrue and false
Versions6.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeBoolean
Range of valuestrue and false
Versions5.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value7.6 - 7.10: false
7.11 and higher: true
Override Example
$sugar_config['disable_unknown_platforms'] = true;

disable_vcr

DescriptionDisables record paging in the detailview (VCR controls). Increases performance by not loading all records from a listview into memory when accessing the record detailview. In 7.x versions, this setting is only applicable to modules running in Backward Compatibility Mode.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['disable_vcr'] = true;

dump_slow_queries

DescriptionLogs slow queries to the sugar log file.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['dump_slow_queries'] = true;

email_default_client

DescriptionSets the default email client for all users.
TypeString
Range of valuessugar, external
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuesugar
Override Example
$sugar_config['email_default_client'] = 'sugar';

email_default_delete_attachments

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

email_default_editor

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

email_mailer_timeout

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.
TypeInteger
Versions7.8.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value2
Override Example
$sugar_config['email_mailer_timeout'] = 30;

enable_inline_reports_edit (Deprecated in future release)

DescriptionAllows a user to edit specific field types (e.g., dropdowns, text fields) in a rows and columns report without having to navigate directly to the record.
TypeBoolean
Range of valuestrue and false
Versions6.3.0–12.0.0
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['enable_inline_reports_edit'] = true;

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.
TypeBoolean
Range of valuestrue and false
Versions10.3.0+
ProductsServe, Sell
Default Valuetrue
Override Example
$sugar_config['enable_link_to_drawer'] = false;

DescriptionWhen true, Elasticsearch will enable long-text search for the following field types: 'longtext', 'htmleditable_tinymce'.
TypeBoolean
Range of valuestrue and false
Versions10.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.1.5+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override 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.
TypeBoolean
Range of valuestrue or false
Versions11.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['enable_one_index'] = true;

exclude_notifications

DescriptionThis setting controls the modules that are excluded from assignment notifications.
TypeArray
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['exclude_notifications'] = array();

exclude_notifications.module

DescriptionAllows an administrator to explicitly disable modules from sending assignment notifications to users.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['exclude_notifications'][''] = true;

external_cache

DescriptionSugarCache basic configuration.
TypeArray
Versions6.2.0+
ProductsEnterprise, Serve, Sell
Override Example
$sugar_config['external_cache'] = array();

external_cache.memcache

DescriptionThis setting controls the memcache properties.
TypeArray
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['external_cache']['memcache'] = array();

external_cache.memcache.host
DescriptionThe host url for memchache.
TypeString
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value127.0.0.1
Override Example
$sugar_config['external_cache']['memcache']['host'] = '192.168.1.1';

external_cache.memcache.port
DescriptionThe host port for memcache.
TypeInteger
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value11211
Override Example
$sugar_config['external_cache']['memcache']['port'] = 11212;

external_cache.redis

DescriptionThis setting controls the redis properties.
TypeArray
Versions9.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['external_cache']['redis'] = array();

external_cache.redis.host
DescriptionThe IP address or the hostname of the Redis host.
TypeString
Range of values'127.0.0.1', '192.168.0.2', 'redis.serveraddress.com', 'local.redis.server.local'
Versions9.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value127.0.0.1
Override 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.
TypeBoolean
Range of valuestrue and false
Versions9.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['external_cache'] ['redis'] ['persistent'] = false;

external_cache.redis.port
DescriptionThe Port number configured in the Redis host.
TypeInteger
Range of valuesAny TCP port number
Versions9.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value6379
Override Example
$sugar_config['external_cache'] ['redis'] ['port'] = 6377;

external_cache.redis.timeout
DescriptionConnection timeout to the Redis server. 0 means unlimited or OS defined.
TypeInteger
Range of valuesAny integer greater than or equal to 0
Versions9.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value0.0001
Override Example
$sugar_config['external_cache_db_gc_probability'] = 0.0005;

external_cache_db_gc_threshold

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

external_cache_disabled

DescriptionDisables all external caching in Sugar. This is normally set to true to determine if there is a conflict with PHP caching.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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
Range of valuesapc, db, file, memcache, memcached, memory, redis, smash, wincache, and zend
Versions6.2.0+
ProductsProfessional, Enterprise
Default Valueempty
Override Example
$sugar_config['external_cache_force_backend'] = 'db';

forms

DescriptionAn array defining form requirements.
TypeArray
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['forms'] = array();

forms.requireFirst

DescriptionPresents all required fields grouped together in the first panel on the EditView form.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['forms']['requireFirst'] = 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.
TypeBoolean
Versions12.0.0+
ProductsEnterprise, Serve, Sell
Default Valuetrue
Override 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.
TypeBoolean
Range of valuestrue and false
Versions8.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['gs_use_shortcut_operator'] = false

hide_admin_licensing

DescriptionHides the License settings subpanel in the administrative panel.
TypeBoolean
Range of valuestrue and false
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['hide_admin_licensing'] = true;

hide_full_text_engine_config

DescriptionDetermines if the FTS settings are present in the admin search page in Admin > Search.
TypeBoolean
Range of valuestrue and false
Versions6.5.15+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['hide_full_text_engine_config'] = true;

hide_subpanels

DescriptionThis setting only applies to modules running in Backward Compatibility Mode. When a DetailView is loaded, all subpanels are collapsed. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['hide_subpanels'] = true;

hide_subpanels_on_login

DescriptionThis setting only applies to modules running in backward compatibility mode. Collapses subpanels per session. When a DetailView is initially loaded during a session, all subpanels are collapsed. Once explanded, it will remain expanded until the user logs out. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['hide_subpanels_on_login'] = true;

hint

DescriptionThe array of configurations related to Hint.
TypeArray
Versions10.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeString
Range of values'US', 'EU', 'APSE'
Versions10.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value50
Override 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
Versions6.5.10+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuelocalhost
Override Example
$sugar_config['host_name'] = 'localhost';

import_max_records_per_file

DescriptionThe number of records to process per batch during an import using the Import Wizard.
TypeInteger
Range of valuesAny integer
Versions7.5.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value100
Override Example
$sugar_config['import_max_records_per_file'] = 50;

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.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['installer_locked'] = false;

jobs

DescriptionJob Queue configurations.
TypeArray
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['jobs'] = array();

jobs.hard_lifetime

DescriptionHard deletes all jobs that are older than the hard cutoff. Default is 21 days.
TypeInteger
Versions6.5.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value21
Override Example
$sugar_config['jobs']['hard_lifetime'] = 21;

jobs.max_retries

DescriptionMaximum number of failures for job. Default is 5.
TypeInteger
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value5
Override Example
$sugar_config['jobs']['max_retries'] = 5;

jobs.min_retry_interval

DescriptionMinimal interval between job reruns. Default is 30 seconds.
TypeInteger
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value30
Override Example
$sugar_config['jobs']['min_retry_interval'] = 30;

jobs.soft_lifetime

DescriptionSoft deletes all jobs that are older than cutoff. Default is 21 days.
TypeInteger
Versions6.5.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value7
Override Example
$sugar_config['jobs']['soft_lifetime'] = 7;

jobs.timeout

DescriptionIf a job is running longer than the limit, the job is failed by force. Specified in seconds. Default is 3600 seconds (1 hour).
TypeInteger
Versions6.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value3600
Override 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
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default ValueAll available languages
Override Example
$sugar_config['languages'] =  array ('en_us' => 'English (US)');

list_max_entries_per_page

DescriptionListview items per page.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value20
Override Example
$sugar_config['list_max_entries_per_page'] = '20';

list_report_max_per_page

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

logger

DescriptionAn array that defines all of the logging settings.
TypeArray
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels'] = array();

logger.channels.authentication
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the authentication channel.
TypeArray
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['authentication']['level'] = 'debug';

logger.channels.authentication.processors
DescriptionThis setting controls the authentication PSR-3 Logger channels processors.
TypeArray
Range of values'request', 'backtrace'
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels'][''] = 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['']['handlers'][] = 'File';

logger.channels.channel.level
DescriptionThis setting controls the PSR-3 Log Level for the specified log channel.
TypeString
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['']['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
Range of values'request', 'backtrace'
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['']['processors'] = array('request', 'backtrace');

logger.channels.db
DescriptionThis setting controls the PSR-3 Logger Channel configuration for the db channel.
TypeArray
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['db']['level'] = 'debug';

logger.channels.db.processors
DescriptionThis setting controls the db PSR-3 Logger channels processors.
TypeArray
Range of values'request', 'backtrace'
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override 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.
TypeArray
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override 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.
TypeString
Range of valuesemergency, alert, critical, error, warning, notice, info, debug, off
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuealert
Override 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.
TypeArray
Range of valuesrequest, backtrace
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of values'request', 'backtrace'
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['metadata']['level'] = 'debug';

logger.channels.metadata.processors
DescriptionThis setting controls the metadata PSR-3 Logger channels processors.
TypeArray
Range of values'request', 'backtrace'
Versions7.9.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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.
TypeArray
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['logger']['channels']['rest']['level'] = 'debug';

logger.channels.rest.processors
DescriptionThis setting controls the rest PSR-3 Logger channels processors.
TypeArray
Range of values'request', 'backtrace'
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override 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
Range of valuesPattern for date format
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value%c
Override Example
$sugar_config['logger']['file']['dateFormat'] = '%c';

logger.file.ext
DescriptionThe extension of the log file. The default value is '.log'.
TypeString
Range of valuesExtension for the log
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value.log
Override Example
$sugar_config['logger']['file']['ext'] = '.log';

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

logger.file.maxSize
DescriptionThis value controls the max file size of a log before the system will roll the log file. It must be set in the format '10MB' where 10 is number of MB to store. Always use MB as no other value is currently accepted. To disable log rolling set the value to false. The default value is '10MB'.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value10MB
Override Example
$sugar_config['logger']['file']['maxSize'] = '10MB';

logger.file.name
DescriptionThe name of the log file to be written to.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuesugarcrm
Override Example
$sugar_config['logger']['file']['name'] = 'sugarcrm';

logger.file.suffix
DescriptionThe suffix to the file name to track logs chronologically. For instance, if you wanted to append the month and year to a file name, you can change this setting to '%m_%Y'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override Example
$sugar_config['logger']['file']['suffix'] = '%m_%Y';

logger.level

DescriptionDetermines the logging level of the system. The recommended setting is 'fatal'.
TypeString
Range of values'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off'
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefatal
Override Example
$sugar_config['logger']['level'] = 'fatal';

logger_visible

DescriptionDetermines whether the Logger Settings panel is visible to administrators in Admin > System Settings.
TypeBoolean
Range of valuestrue and false
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['logger_visible'] = false;

log_dir

DescriptionSets the location in the file system where the Sugar log file will be stored. By default, it is set to '.' meaning that it is stored in the root instance directory.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value.
Override Example
$sugar_config['log_dir'] = '.';

log_file

DescriptionDesignates the file name where the instance's logs will be stored.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuesugarcrm.log
Override Example
$sugar_config['log_file'] = 'new_sugarcrm.log'

log_memory_usage

DescriptionLogs the memory usage.
TypeBoolean
Range of valuestrue and false
Versions5.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override 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.
TypeBoolean
Range of valuestrue and false
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['maintenanceMode'] = false;

marketing_extras_enabled

DescriptionThis configuration disables the marketing content on the Sugar login screen.
TypeBoolean
Range of valuestrue and false
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['marketing_extras_enabled'] = false;

mark_emails_seen

DescriptionDetermines whether to mark an email as read before importing the email to Sugar during the inbound email import. This is not recommended as an import failure will cause the email to be marked as read which will be skipped during the next inbound email import.
TypeBoolean
Range of valuestrue and false
Versions6.5.17+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['mark_emails_seen'] = true;

mass_actions

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

mass_actions.mass_delete_chunk_size

DescriptionNumber of records per chunk while performing a mass delete.
TypeInteger
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value20
Override Example
$sugar_config['mass_delete_chunk_size'] = 20;

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

mass_actions.mass_update_chunk_size

DescriptionNumber of records per chunk while performing a mass update.
TypeInteger
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value500
Override Example
$sugar_config['mass_actions']['mass_update_chunk_size'] = 500;

mass_actions.max_records_to_merge

DescriptionNumber of records per chunk while performing a mass merge.
TypeInteger
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value5
Override Example
$sugar_config['mass_actions']['max_records_to_merge'] = 20;

max_aggregate_email_attachments_bytes

DescriptionThe maximum allowed size of all uploaded attachments added together for a single email message. Users may upload files as email attachments within to the lowest of the PHP upload_max_filesize, post_max_size, and system upload_maxsize size limits, but users cannot upload more files to a single message than the max_aggregate_email_attachments_bytes configuration permits.
TypeInteger
Versions7.10.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value10000000
Override Example
$sugar_config['max_aggregate_email_attachments_bytes'] = 20000000;

max_session_time

DescriptionDetermines the maximum lock time in seconds between session requests. When a session request is locked for long periods of time, other requests are blocked until it is released. A null value will not implement a max session time.
TypeInteger
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuenull
Override Example
$sugar_config['max_session_time'] = 1;

metrics_enabled

DescriptionWhether or not system metrics have been enabled.
TypeBoolean
Range of valuestrue and false
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['metrics_enabled'] = true;

metric_providers

DescriptionA Name/Path array of metric providers for measuring system metrics
TypeArray
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['metric_providers'] = array ('provider' => 'path/to/provider');

metric_settings

DescriptionThe individual settings required by a metric provider. And values provided will be passed when instantiating the metric providers object.
TypeArray
Versions6.7.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['metric_settings'] = array ('provider' => array('setting' => 'value'));

minify_resources

DescriptionDetermines whether minification and compression are applied to javascript resources
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['minify_resources'] = false;

moduleInstaller.disableActions

DescriptionPart of the moduleInstaller array. When packageScan is set to 'true', Sugar does not restrict any specific actions that can be completed during the installation process. The disableActions parameter allows you to define any actions you wish to restrict from executing.
TypeArray
Range of valuesSpecific actions to restrict in module packages
Versions5.2.0j+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuearray()
Override Example
$sugar_config['moduleInstaller']['disableActions'] = array('pre_execute', 'post_execute');

moduleInstaller.disableFileScan

DescriptionWhen packageScan is set to 'true', Sugar scans all files in an installable package to ensure that the file extensions are acceptable and that the files do not contain denylisted class or function calls. Setting the disableFileScan parameter to 'true' avoids this scan from occurring while still enforcing other parameters set.
TypeBoolean
Range of valuestrue and false
Versions5.2.0j+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['moduleInstaller']['disableFileScan'] = true;

moduleInstaller.packageScan

DescriptionEnables package scanning on any modules uploaded through Module Loader prior to the installation. If the package is found to violate any restrictions of the packageScan, the installation will not proceed and an error report will be generated to the user attempting the install.
TypeBoolean
Range of valuestrue and false
Versions5.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['moduleInstaller']['packageScan'] = true;

moduleInstaller.validExt

DescriptionPart of the moduleInstaller array. When moduleInstaller.packageScan is set to true, Sugar will not allow certain file extensions to be present in an installable package. By default, Sugar allows the following extensions: 'png', 'gif', 'jpg', 'css', 'js', 'php', 'txt', 'html', 'htm', 'tpl', 'pdf', 'md5', 'xml', 'hbs', 'less', and 'wsdl'. This parameter allows you to define additional extensions deemed safe to install on your instance of Sugar.
TypeArray
Range of valuesFile extensions to allow
Versions6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuearray()
Override Example
$sugar_config['moduleInstaller']['validExt'] = array('swf', 'log');

mso_fixup_paragraph_tags

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

new_email_addresses_opted_out

DescriptionIf true, then newly created EmailAddress records in Sugar will be opted-out by default. This setting can also be controlled using the "Opt-out new email addresses by default" setting in Admin > System Email Settings.
TypeBoolean
Range of valuestrue and false
Versions8.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['new_email_addresses_opted_out'] = true;

noPrivateTeamUpdate

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

oauth2

DescriptionConfigutations for the oauth2 server.
TypeArray
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['oauth2'] = array();

oauth2.access_token_lifetime

DescriptionThe lifetime of the access token in seconds. This setting controls how often Sugar will check to see if the user's token has expired. It is recommended for this value not to surpass more than half of the oauth2.refresh_token_lifetime setting.

Note: This setting cannot exceed the maximum PHP session timeout, which is configured by PHP setting session.gc_maxlifetime. In SugarCloud the maximum session timeout is set to 7200s (2 hours).

Note: This setting is not respected for instances that use SugarIdentity.
TypeInteger
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value3600
Override Example
$sugar_config['oauth2']['access_token_lifetime'] = 3600;

oauth2.refresh_token_lifetime

DescriptionThe lifetime of refresh token in seconds. We recommend the oauth2.refresh_token_lifetime remains at 1209600 seconds or less for security. Should you increase this number, do not exceed 2147220 seconds.

Note: This setting is not respected for instances that use SugarIdentity.
TypeInteger
Versions7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value1209600
Override Example
$sugar_config['oauth2']['refresh_token_lifetime'] = 1409600;

oauth_token_expiry

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

oauth_token_life

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

oracle_enable_ci

DescriptionBy default, Oracle searching is case sensitive in Sugar, which can be a problem if you are not sure of the case of the data you are searching for. Using this settings, you can turn on insensitive search for Oracle 10g and 11g.
TypeBoolean
Range of valuestrue and false
Versions6.1.3+
ProductsEnterprise, Ultimate
Default Valuefalse
Override Example
$sugar_config['oracle_enable_ci'] = true;

passwordHash

DescriptionArray that defines the password hashing behaviors.

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeArray
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['passwordHash'] = array();

passwordHash.algo

DescriptionThe specific algorithm to be used by the hashing backend. The available values depend on the selected passwordHash.backend. See http://php.net/manual/en/password.constants.php for more information when using the native backend.

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeString
Range of valuesFor native backend: "PASSWORD_DEFAULT" and "PASSWORD_BCRYPT". For sha2 backend: "CRYPT_SHA256" and "CRYPT_SHA512"
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value"PASSWORD_DEFAULT" for native. "CRYPT_SHA256" for sha2 backend.
Override Example
$sugar_config['passwordHash']['algo'] = 'PASSWORD_BCRYPT';

passwordHash.allowLegacy

DescriptionAllow logins of users who have their password stored using the insecure legacy MD5 hash. During the transition period for the 7.7 series, this will be allowed out of the box. Versions past 7.7 will no longer allow by default authentication against insecure hashes. This configuration parameter can be used to change the default behavior.

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value7.7.x: true
7.8.x+:false
Override Example
$sugar_config['passwordHash']['allowLegacy'] = false;

passwordHash.backend

DescriptionThe password hash backend class to use. By default, the "native" backend is used which uses Blowfish to hash the passwords in the database. An alternative is using the "sha2" backend which makes use of SHA-2 hashing instead. Depending on the backend, different configuration options are available for passwordHash.algo and passwordHash.options.

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeString
Range of values'sha2' and 'native'
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuenative
Override Example
$sugar_config['passwordHash']['backend'] = 'sha2';

passwordHash.options

DescriptionThe available configuration values depend on the selected passwordHash.backend. See http://php.net/manual/en/function.password-hash.php when using the native backend and http://php.net/manual/en/function.crypt.php for the sha2 backend. Note that only the following specified options are allowed. For native backend: passwordHash.options.cost. For sha2 backend: passwordHash.options.rounds.

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeArray
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['passwordHash']['options'] = array();

passwordHash.options.cost
DescriptionAn available option when the passwordHash.backend configuration is set to "native". More information on the native backend can be found at http://php.net/manual/en/function.password-hash.php

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeInteger
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value10
Override Example
$sugar_config['passwordHash']['options']['cost'] = 15;

passwordHash.options.rounds
DescriptionAn available option when the passwordHash.backend configuration is set to "sha2". More information on the sha2 backend can be found at http://php.net/manual/en/function.crypt.php

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeInteger
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value5000
Override Example
$sugar_config['passwordHash']['options']['rounds'] = 4000;

passwordHash.rehash

DescriptionWhen enabled, the system will automatically rehash the user's password when successfully authenticated. This allows adoption to the newly configured password hash backend without resetting user's passwords.

Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.
TypeBoolean
Range of valuestrue and false
Versions7.7.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['passwordHash']['rehash'] = false;

passwordsetting

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

passwordsetting.forgotpasswordON

DescriptionEnables the Forgot Password features. When enabled, users will have the ability to reset their own passwords at the Login page. Set in UI via Admin->Password Management.
TypeString
Range of values0, 1
Versions5.5.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value1
Override Example
$sugar_config['passwordsetting']['forgotpasswordON'] = '0';

passwordsetting.linkexpiration

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

passwordsetting.onelower

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

passwordsetting.onenumber

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

passwordsetting.oneupper

DescriptionConfigures whether at least one upper-case letter is required in users' passwords.
TypeBoolean
Range of values0, 1
Versions6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['passwordsetting']['oneupper'] = 1;

passwordsetting.systexpirationtype

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

pdf_file_max_lifetime

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

perfProfile

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

perfProfile.TeamSecurity

DescriptionDetermines whether the team security filtering is applied.
TypeArray
Versions7.2.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['perfProfile']['TeamSecurity'] = array();

perfProfile.TeamSecurity.default
DescriptionThis setting is used to enable or disable Team Security denormalization feature by default across the application.
TypeArray
Range of valuestrue and false
Versions7.7.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['perfProfile']['TeamSecurity']['default'] = array();

perfProfile.TeamSecurity.default.disable_subquery_optimizer_hint
DescriptionAs of Sugar 11.0.2, the default behavior of TeamSecurity on MySQL no longer uses an INNER JOIN to a 'team_sets' subquery; instead, Sugar 11.0.2 and higher use WHERE team_set_id IN [team_sets subquery] with a MySQL optimizer hint. To disable this approach and switch back to the INNER JOIN implementation, set this config to 'true'.
TypeBoolean
Range of valuestrue and false
Versions11.0.2+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['perfProfile']['TeamSecurity']['default']['disable_subquery_optimizer_hint'] = true;

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

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

perfProfile.TeamSecurity.default.use_denorm
DescriptionThis setting is used to enable or disable Team Security denormalization feature. Team Security denormalization can significantly improve SQL query performance when there are a large number of Teams in a Sugar instance. The cost is that this feature relies on a separate Team security denormalization table that needs to be updated as records change to ensure Sugar's Team security visibility rules are applied properly. It is important to note that 'default' applies this to all modules. To set specific settings for a specific module, you will need to use: $sugar_config['perfProfile']['TeamSecurity']['{module}']['use_denorm'] = true;
TypeBoolean
Range of valuestrue and false
Versions8.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['perfProfile']['TeamSecurity']['default']['use_denorm'] = true;

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

perfProfile.TeamSecurity.gs_use_normalized_teams
DescriptionDetermines whether the team set IDs are cached; this may improve Elasticsearch indexing performance, especially for those instances with a large number of team sets per user. Admin must schedule re-indexing Elasticsearch server if this value has been changed.
TypeBoolean
Range of valuestrue and false
Versions11.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['perfProfile']['TeamSecurity']['gs_use_normalized_teams'] = true;

perfProfile.TeamSecurity.inline_update
DescriptionWhen denormalization is in use (perfProfile.TeamSecurity.default.use_denorm config set to true), this setting will allow the denormalization table to be updated in real time as records are updated in the system. If this setting is disabled, the denormalization table must be scheduled by the Sugar administrator via Schedulers > Rebuild Denormalized Team Security Data.
TypeBoolean
Range of valuestrue and false
Versions8.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['perfProfile']['TeamSecurity']['inline_update'] = true;

pmse_settings_default

DescriptionSettings for troubleshooting and debugging SugarBPM
TypeArray
Versions7.6.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['pmse_settings_default'] = array();

pmse_settings_default.error_number_of_cycles

DescriptionNumber of cycles before triggering an error in SugarBPM
TypeString
Versions7.6.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Value10
Override Example
$sugar_config['pmse_settings_default']['error_number_of_cycles'] = 15;

pmse_settings_default.error_timeout

DescriptionTime in seconds of timeout before triggering an error in SugarBPM
TypeString
Versions7.6.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Value40
Override Example
$sugar_config['pmse_settings_default']['error_timeout'] = 45;

pmse_settings_default.logger_level

DescriptionThe default logger level for SugarBPM
TypeString
Range of valuesemergency, alert, critical, error, warning, notice, info, debug
Versions7.6.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Valuecritical
Override Example
$sugar_config['pmse_settings_default']['logger_level'] = 'emergency';

portal_enableSelfSignUp

DescriptionThis portal configuration option controls whether external portal sign-ups are permitted and is also controlled in the user interface via the "Allow new users to sign up" Sugar Portal setting. See the Sugar Portal page in the Administration Guide for details on this setting: https://support.sugarcrm.com/SmartLinks/Administration_Guide/Developer_Tools/Sugar_Portal/hdr_Configure_Portal This option is disabled by default for new instances. Note: Upon upgrade to 11.1.0 or higher from version 11.0.x or lower, the default value will be 'true' for instances that had their portal enabled before upgrade and at least one contact configured for portal.
TypeBoolean
Range of valuestrue and false
Versions11.1.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['portal_enableSelfSignUp'] = true;

processes_auto_save_interval

DescriptionDefines the interval (in milliseconds) at which auto-saving of process definitions will occur while using the SugarBPM process designer. A value of 0 will disable auto-saving.
TypeInteger
Versions8.3.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Value30000
Override Example
$sugar_config['processes_auto_save_interval'] = 120000

processes_auto_validate_on_autosave

DescriptionDefines whether validation of process definitions will automatically occur when a process definition is auto-saved. To enable this setting, 'processes_auto_save_interval' must be greater than 0.
TypeBoolean
Range of valuestrue and false
Versions8.3.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['processes_auto_validate_on_autosave'] = false

processes_auto_validate_on_import

DescriptionDetermines whether validation of process definitions will automatically occur immediately after a process definition is imported.
TypeBoolean
Range of valuestrue and false
Versions8.3.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['processes_auto_validate_on_import'] = false

proxy_visible

DescriptionDetermines whether the Proxy Settings panel is visible to administrators in Admin > System Settings. Instances running on Sugar's cloud environment will have this setting enforced as false.
TypeBoolean
Range of valuestrue or false
Versions11.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuetrue
Override Example
$sugar_config['proxy_visible'] = false;

push_notification

DescriptionThe array of configurations related to push notifications.
TypeArray
Versions11.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['push_notification'] = array();

push_notification.enabled

DescriptionFor Sugar instances that are eligible for push notifications, use this setting to turn push notifications on or off. See the Android and iOS User Guides for the requirements to be eligible: https://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_iOS_User_Guide/#Eligible_Sugar_Instances https://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_Android_User_Guide/#Eligible_Sugar_Instances
TypeBoolean
Range of valuestrue and false
Versions11.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['push_notification']['enabled'] = true;

push_notification.service_provider

DescriptionFor Sugar instances that are eligible for push notifications, this setting specifies the provider. Currently, SugarPush is the only available provider. See the Android and iOS User Guides for the requirements to be eligible: https://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_iOS_User_Guide/#Eligible_Sugar_Instances https://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_Android_User_Guide/#Eligible_Sugar_Instances
TypeString
Range of values'SugarPush'
Versions11.0.0+
ProductsEnterprise, Ultimate, Serve, Sell
Default Value'SugarPush'
Override Example
$sugar_config['push_notification']['service_provider'] = 'SugarPush';

require_accounts

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

rest_response_etag_cache_age

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

roleBasedViews

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

SAML_provisionUser

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

SAML_X509Cert

DescriptionThe SAML Certificate Key.
TypeString
Versions6.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['SAML_X509Cert'] = '-----BEGIN CERTIFICATE-----CERTIFICATE KEY-----END CERTIFICATE-----';

schedule_report_with_chart

DescriptionBy default, reports distributed via the Reports Schedule module in 8.1 and later will not include a chart in the emailed PDF even if one has been configured for display in Sugar. Because the report charts are not re-built when the scheduler runs a scheduled report, the chart may not accurately represent the data presented in the PDF. Instead, the chart will represent the data that was pulled the last time a user triggered a "Run Report" action on the report, which may or may not match the data available when the report is generated for the scheduled report. Consider this potential conflict carefully before using this config to override the default behavior.
TypeBoolean
Range of valuestrue and false
Versions8.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['schedule_report_with_chart'] = true;

search_engine

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

search_engine.max_bulk_delete_threshold

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

search_engine.max_bulk_query_threshold

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

search_engine.max_bulk_threshold

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

search_engine.postpone_job_time

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

search_wildcard_infront

DescriptionIn Sugar 7.x+, this setting is only valid for modules running in BWC mode. When enabled, automatically adds a wildcard in front of any searches performed in the application. This setting is not recommended to be enabled as preceding wildcards results in database indices not being utilized and performance decreasing.
TypeBoolean
Range of valuestrue and false
Versions6.4.3+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['search_wildcard_infront'] = true;

session_dir

DescriptionDirectory on the server to store Sugar session data. If left empty, the PHP session settings will be inherited.
TypeString
Range of valuesDirectory path
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueempty
Override Example
$sugar_config['session_dir'] = '/tmp/SugarSession/';

showThemePicker

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

show_download_tab

DescriptionUsed to determine whether the download tab will appear in the User settings. The download tab provides users with access to Sugar plug-ins and other available downloads.
TypeBoolean
Range of valuestrue and false
Versions6.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['show_download_tab'] = true;

site_url

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

slow_query_time_msec

DescriptionSlow query time threshold.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value5000
Override Example
$sugar_config['slow_query_time_msec'] = '1000';

smtp_mailer_debug

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

stack_trace_errors

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

studio_max_history

DescriptionWhen layout changes are made in Studio, a history of those changes are recorded with each save & deploy under ./custom/history/modules/. The studio_max_history parameter controls how many files Sugar keeps for a particular module. If this parameter is undefined, a default of 50 is observed and to keep all historical Studio actions, set this parameter to 0.
TypeInteger
Range of valuesAny integer
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value50
Override Example
$sugar_config['studio_max_history'] = 100;

sugar_version

DescriptionThe current version of Sugar that is being used. This value should not be modified as it is updated in the config when Sugar is upgraded.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['sugar_version'] = '6.7.3';

time_aware_job_max_batch_size

DescriptionThe number of records processed per batch by the "Process Time-Aware Schedules" job scheduler. It is important to note that the scheduler job must be enabled.
TypeInteger
Versions10.3.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value100
Override Example
$sugar_config['time_aware_job_max_batch_size'] = 200;

tmp_dir

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

tmp_file_max_lifetime

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

tracker_max_display_length

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

tracker_module_config

DescriptionArray that defines the parameters that control which modules are tracked when Tracker Actions are enabled.
TypeArray
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['tracker_module_config'] = array();

tracker_module_config.disable

DescriptionThe list of modules that are ignored by Tracker Actions. If tracker_module_config.enable_only is defined, then tracker_module_config.disable will be ignored. If neither config is defined, then all modules are enabled. By default, neither config is defined and all actions for all modules across all platforms will be enabled when Tracker Actions is enabled.
TypeArray
Range of valuesModule keys
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['tracker_module_config']['disable'] = ['Reports', 'ActivityStream'];

tracker_module_config.enable_only

DescriptionA list of module names for which records are saved in the tracker table when Tracker Actions are enabled; all other modules will be disabled. If tracker_module_config.enable_only is empty or null or undefined, tracker_module_config.disable will apply. If neither config is defined, then all modules are enabled. By default, neither config is defined and all actions for all modules across all platforms will be enabled when Tracker Actions is enabled.
TypeArray
Range of valuesModule keys
Versions11.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['tracker_module_config']['enable_only'] = ['Reports', 'ActivityStream'];

uninstall_timeout

DescriptionControls the timeout time in seconds for an uninstall process.
TypeInteger
Versions10.2.1+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value600
Override Example
$sugar_config['uninstall_timeout'] = 300;

unique_key

DescriptionSpecifies the unique identifier for the instance. This value is used in features such as PHP caching, FTS indexing, and email archiving. It is extremely important that this string is unique from any other instances deployed even if they are only for development purposes only.
TypeString
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['unique_key'] = 'c0b5475f3f5b26ddb2976edc8865b5f6';

upload_badext

DescriptionAn array of extensions that cannot be uploaded in their native file format. Sugar will append a .txt extension to the end of any files with an invalid extension to avoid security issues with running unauthorized scripts on an instance.
TypeArray
Range of valuesExtensions that cannot be uploaded as is
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['upload_badext'][] = 'swf';

upload_dir

DescriptionThe directory path where uploaded files are stored for note attachments, documents, and module loadable packages. By default, uploads are stored in the ./upload/ directory. For more information, refer to the Uploads documentation.
TypeString
Range of valuesDirectory path
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueupload/
Override Example
$sugar_config['upload_dir'] = 'upload/'

upload_maxsize

DescriptionThe maximum individual file size that users can upload to modules that support file uploads. Restricts the upload limit from within Sugar without affecting any other applications that may be running on your server. This limit can be easily adjusted in Sugar via Admin > System Settings but is only useful if it is set to a size smaller than the php.ini limits. For more information, refer to the Uploads documentation.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['upload_maxsize'] = 40000000;

upload_wrapper_class

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

use_common_ml_dir

DescriptionA security control that allows you to restrict Module Loader to read modules from a specific directory on the server and disable the ability to upload new modules into the Module Loader. To specify a new directory you will need to populate the config parameter 'common_ml_dir'.
TypeBoolean
Range of valuestrue and false
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['use_common_ml_dir'] = true;

use_php_code_json

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

use_real_names

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

use_sprites

DescriptionA sprite is a two-dimensional image or animation that is integrated into a larger scene. This parameter is used to disable sprites. This is set to true by default (if you have GD libraries installed).
TypeBoolean
Range of valuestrue and false
Versions6.4.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['use_sprites'] = false;

validation

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

validation.compat_mode

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

validation.soft_fail

DescriptionDetermines whether soft failure mode for the input validation framework is enabled. When this mode is enabled, any input validation violations will only be reported as a warning in the sugarcrm.log without having any negative impact on the request. When disabled, violations are reported as fatal in the sugarcrm.log and actual exceptions are being thrown resulting in an HTTP 500 response. It is highly recommended for developers to verify their customizations work with this parameter set to false in preparation for the 8.0 release.
TypeBoolean
Range of valuestrue and false
Versions7.7.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value7.7.x: true
7.8.x: true
7.9.x: true
8.0.x: false
Override Example
$sugar_config['validation']['soft_fail'] = false;

verify_client_ip

DescriptionWhether or not to verify the client IP. Setting this to true will enable the system checking to see if the user is accessing Sugar from the IP address of their last page load.

Note: This default value must be set to "false" in order to use Sugar Connect and Sugar Integrate.
TypeBoolean
Range of valuestrue and false
Versions10.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valuefalse
Override Example
$sugar_config['verify_client_ip'] = true;

web_logic_hook_timeout

DescriptionTimeout for requests to web logic hooks. Any requests that run longer than the set limit will fail and trigger an error in the log.
TypeInteger
Versions11.1.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value10
Override Example
$sugar_config['web_logic_hook_timeout'] = 2;

wl_list_max_entries_per_page

DescriptionThe number of records to be shown per page on the listview of the mobile browser.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value10
Override Example
$sugar_config['wl_list_max_entries_per_page'] = 10;

wl_list_max_entries_per_subpanel

DescriptionDetermines the number of records shown in the subpanels on the DetailView of the mobile browser.
TypeInteger
Versions5.2.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value3
Override Example
$sugar_config['wl_list_max_entries_per_subpanel'] = 3;

xhprof_config

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

xhprof_config.enable

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

xhprof_config.filter_wt

DescriptionThe wall time. Values are specified in milliseconds.
TypeInteger
Versions7.6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['xhprof_config']['filter_wt'] = 2;

xhprof_config.flags

DescriptionThe flags for xhprof profiler.
TypeString
Versions6.5.10+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['xhprof_config']['flags'] = XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY;

xhprof_config.ignored_functions

DescriptionAn array of function names to ignore from the profile.
TypeArray
Versions6.5.10+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['xhprof_config']['ignored_functions'] = array("function_name");

xhprof_config.log_to

DescriptionThe path to log the xhprof profiler output to.
TypeString
Versions6.5.10+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Override Example
$sugar_config['xhprof_config']['log_to'] = '{instance server path}/cache/xhprof';

xhprof_config.manager

DescriptionThe xhprof manager class to use. Prior to 7.7, specifying values xhprof_config.save_to, xhprof_config.mongodb_uri, xhprof_config.mongodb_db, xhprof_config.mongodb_collection, xhprof_config.mongodb_options, and xhprof_config.filter_wt will need to have set xhprof_config.manager set to 'SugarXHprofPerformance'. As of 7.7, setting xhprof_config.manager is not longer required. If you want to customize SugarXHprof, you can create the folder ./custom/include/SugarXHprof/ and create a file with your custom class class name. The custom class will need to extend SugarXHprof. If a custom class doesn't exist or hasn't been specified, SugarXHprof will be used.
TypeString
Versions6.5.10+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default ValueSugarXHprof
Override Example
$sugar_config['xhprof_config']['manager'] = 'CustomSugarXHprof';

xhprof_config.memory_limit

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

xhprof_config.mongodb_collection

DescriptionThe name of the mongo db collections.
TypeString
Versions7.6.0.0+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Valueresults
Override Example
$sugar_config['xhprof_config']['mongodb_db'] = 'results_new';

xhprof_config.mongodb_db

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

xhprof_config.mongodb_options

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

xhprof_config.mongodb_uri

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

xhprof_config.sample_rate

DescriptionThe sample rate of the xhprof profiler. 1/{specified value} requests are profiled. To sample all requests, set this value to 1.
TypeInteger
Versions6.5.10+
ProductsProfessional, Enterprise, Ultimate, Serve, Sell
Default Value10
Override Example
$sugar_config['xhprof_config']['sample_rate'] = 1;

xhprof_config.save_to

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

xhprof_config.track_elastic

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

xhprof_config.track_elastic_backtrace

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

xhprof_config.track_sql

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

xhprof_config.track_sql_backtrace

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