Core Settings
activity_streams
Description | Array that defines parameters for processing Data Privacy erasure requests for activity streams. |
Type | Array |
Versions | 8.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
activity_streams.erasure_job_delay
Description | Defines 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. |
Type | Integer |
Versions | 8.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
activity_streams.erasure_job_limit
Description | Defines 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. |
Type | Integer |
Versions | 8.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 5 |
Override Example |
|
activitystreamcleaner
Description | Array that defines the parameters for the Activity Stream purger. |
Type | Array |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
activitystreamcleaner.keep_all_relationships_activities
Description | This 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. |
Type | Boolean |
Range of values | true or false |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
activitystreamcleaner.limit_scheduler_run
Description | Sets the number of activity stream records to delete per batch when run by the scheduled job that purges activity stream records. |
Type | Integer |
Range of values | Integers, values below 0 become 0 |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 25000 |
Override Example |
|
activitystreamcleaner.months_to_keep
Description | This 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. |
Type | Integer |
Range of values | Any integer greater than or equal to 0 |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 6 |
Override Example |
|
additional_js_config
Description | Configuration 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. |
Type | Array |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
additional_js_config.alertAutoCloseDelay
Description | Defines 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. |
Type | Integer |
Versions | 7.8+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 9000 |
Override Example |
|
additional_js_config.authStore
Description | Defines 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. |
Type | String |
Range of values | 'cache' and 'cookie' |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | cache |
Override Example |
|
additional_js_config.disableOmnibarTypeahead
Description | Disables 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
additional_js_config.logger.write_to_server
Description | Enables 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'); |
Type | Boolean |
Range of values | true and false |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
additional_js_config.sidecarCompatMode
Description | By 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
additional_js_config.skipTutorial
Description | Disables the tutorial system shown when users log in for the first time. |
Type | Boolean |
Range of values | true and false |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate |
Default Value | false |
Override Example |
|
admin_access_control
Description | Removes Sugar Updates, Upgrade Wizard, Backups and Module Builder from the Admin menu. For developers, these restrictions can be found in ./include/MVC/Controller/file_access_control_map.php and overriden by creating ./custom/include/MVC/Controller/file_access_control_map.php . |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
admin_export_only
Description | Allow only users with administrative privileges to export data. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
ajax_debounce_interval
Description | Delay in milliseconds to wait after key presses in the email recipient search. It prevents excessive database load in case of short search conditions for email recipients. |
Type | Integer |
Range of values | 600, 700, 800, or any other integer (preferably above 500) |
Versions | 13.1+ |
Products | Enterprise, Serve, Sell |
Default Value | 500 |
Override Example |
|
allow_oauth_via_get
Description | As 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.8+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
allow_pop_inbound
Description | Inbound email accounts are setup to work with IMAP protocols by default. If your email provider required POP3 access instead of IMAP, you can enables POP3 as an available inbound email protocol. Please note that mailboxes configured with a POP3 connection are not supported by SugarCRM and may cause unintended consequences. IMAP is the recommended protocol to use for inbound email accounts. |
Type | Boolean |
Range of values | true and false |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
allow_sendmail_outbound
Description | Enables the option of choosing sendmail as an SMTP server in Admin > Email Settings. Sendmail must be enabled on the server for this option to work. Please note that mailboxes configured with sendmail are not supported and may cause unintended consequences. |
Type | Boolean |
Range of values | true and false |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
allowFreezeFirstColumn
Description | Global 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. |
Type | Boolean |
Versions | 12.0+ |
Products | Enterprise, Serve, Sell |
Default Value | true |
Override Example |
|
analytics
Description | An array defining properties for an analytics connector. |
Type | Array |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
analytics.connector
Description | The name of the connector to use for gathering analytics. |
Type | String |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
analytics.enabled
Description | Determines if the analytics are enabled. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
analytics.id
Description | The tracking id for the analytics connector. |
Type | String |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
api
Description | API specific configurations. |
Type | Integer |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
api.allowedClients
Description | Allows administrators to limit access to their Sugar instance via different clients (e.g., Chrome browser, stock mobile app) and prevent users from logging in using specific clients.
The following rules are applied in the following order:
Matching is performed on 'User-Agent' HTTP header, case-insensitive, and whole word only. |
Type | Array |
Range of values | Array with keys corresponding to available clients/platforms (base, portal, mobile) and values containing strings that can be used to identify client by it's User-Agent HTTP header |
Versions | 14.0+ |
Products | Enterprise, Serve, Sell |
Default Value | empty |
Override Example |
|
api.timeout
Description | The timeout in seconds when uploading files through the REST API. |
Type | Integer |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 180 |
Override Example |
|
authenticationClass
Description | The class to be used for login authentication. |
Type | String |
Range of values | SAMLAuthenticate |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | SugarAuthenticate |
Override Example |
|
aws
Description | This configuration's functionality has been deprecated and will be removed in an upcoming release. |
Type | Array |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
aws.aws_key
Description | This configuration's functionality has been deprecated and will be removed in an upcoming release. |
Type | String |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
aws.aws_secret
Description | This configuration's functionality has been deprecated and will be removed in an upcoming release. |
Type | String |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
aws.upload_bucket
Description | This configuration's functionality has been deprecated and will be removed in an upcoming release. |
Type | String |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
cache
Description | Array that defines additional properties for SugarCache if it's enabled (see external_cache). |
Type | Array |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
cache_dir
Description | This is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | cache/ |
Override Example |
|
cache_expire_timeout
Description | The length of time cached items should be expired after. |
Type | Integer |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 300 |
Override Example |
|
cache.backend
Description | Defines the SugarCache backend to use via a fully qualified class name (FQCN). |
Type | String |
Range of values | 'Sugarcrm\Sugarcrm\Cache\Backend\Redis' , '\Sugarcrm\Sugarcrm\Cache\Backend\APCu' , '\Sugarcrm\Sugarcrm\Cache\Backend\Memcached' , '\Sugarcrm\Sugarcrm\Cache\Backend\InMemory' , '' |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | Sugarcrm\Sugarcrm\Cache\Backend\BackwardCompatible |
Override Example |
|
cache.disable_gz
Description | Defines whether the SugarCache compression should be disabled in multi-tenant deployment, which is not applicable without cache.multi_tenant . This will modify Sugar's caching behavior to disable compression of the cached data. |
Type | Boolean |
Range of values | true and false |
Versions | 12.1+ |
Products | Enterprise, Serve, Sell |
Default Value | false |
Override Example |
|
cache.encryption_key
Description | Used 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 . |
Type | String |
Range of values | N/A as it is generated automatically |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | Random value (generated on cache initialization) |
Override Example |
|
cache.gz_level
Description | Defines the SugarCache compression level, which is not applicable without cache.multi_tenant . |
Type | Integer |
Range of values | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 |
Versions | 12.1+ |
Products | Enterprise, Serve, Sell |
Default Value | 9 |
Override Example |
|
cache.multi_tenant
Description | Defines 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. |
Type | Boolean |
Range of values | true and false |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
calendar
Description | An array that defines all of the various settings for the Calendar module. |
Type | Array |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
calendar.day_timestep
Description | Sets the default day time step. |
Type | Integer |
Range of values | 15, 30 and 60 |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 15 |
Override Example |
|
calendar.default_view
Description | Changes the default view in the calendar module. |
Type | String |
Range of values | 'day', 'week', 'month' and 'share' |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
calendar.items_draggable
Description | Enable/Disable drag-and-drop feature to move calendar items. |
Type | Boolean |
Range of values | true and false |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
calendar.items_resizable
Description | Sets whether items on the calendar can be resized via clicking and dragging. |
Type | Boolean |
Range of values | true and false |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
calendar.show_calls_by_default
Description | Display/Hide calls by default. |
Type | Boolean |
Range of values | true and false |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
calendar.week_timestep
Description | The default week step size when viewing the calendar. |
Type | Integer |
Range of values | 15, 30, and 60 |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
check_query
Description | Validates queries when adding limits. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
check_query_cost
Description | Sets the maximum cost limit of a query. |
Type | Integer |
Versions | 5.2+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
clear_resolved_date
Description | In 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. |
Type | Boolean |
Range of values | true and false |
Versions | 9.3+ |
Products | Serve |
Default Value | true |
Override Example |
|
cloud_insight
Description | Array that defines the properties for SugarCloud Insights. |
Type | Array |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
cloud_insight.enabled
Description | Determines if the SugarCloud Insights service is enabled. |
Type | Boolean |
Range of values | true and false |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
cloud_insight.key
Description | Specifies the unique key for the SugarCloud Insights service. |
Type | String |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
cloud_insight.url
Description | The current URL for SugarCloud Insights service. |
Type | String |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
collapse_subpanels
Description | Pertains 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
cron
Description | Array that defines all of the cron parameters. |
Type | Array |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
cron.enforce_runtime
Description | Determines if cron.max_cron_runtime is enforced during the cron run. |
Type | Boolean |
Range of values | true and false |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
cron.max_cron_jobs
Description | Maximum jobs per cron run. Default is 10. If you are using a version prior to 6.5.14, you will need to also populate max_jobs to set this value due to bug #62936 ( https://web.sugarcrm.com/support/issues/62936 ). |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 6.5.x: 10 7.6.x: 25 |
Override Example |
|
cron.max_cron_runtime
Description | Determines the maximum time in seconds that a single job should be allowed to run. If a single job exceeds this limit, cron.php is aborted with the long-running job marked as in progress in the job queue. The next time cron runs, it will skip the job that overran the limit and start on the next job in the queue. This limit is only enforced when cron.enforce_runtime is set to true. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 180 |
Override Example |
|
cron.min_cron_interval
Description | Minimum time between cron runs. Setting this to 0 will disable throttling completely. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 30 |
Override Example |
|
csrf
Description | An array defining attributes for CSRF token protection. |
Type | Array |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
csrf.opt_in
Description | CSRF 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+. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate |
Default Value | false |
Override Example |
|
csrf.soft_fail_form
Description | When 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
csrf.token_size
Description | The size in bytes of the CSRF token to generate. |
Type | Integer |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 32 |
Override Example |
|
custom_help_base_url
Description | Allows an instance to specify a custom help url for their user |
Type | String |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | http://www.sugarcrm.com/crm/product_doc.php |
Override Example |
|
custom_help_url
Description | Designate the URL used to redirect the user to help documentation. |
Type | String |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | http://www.sugarcrm.com/crm/product_doc.php |
Override Example |
|
customPortalPlatforms
Description | This configuration allows a platform with custom authentication to be excluded from an IDM integration. |
Type | Array |
Versions | 9.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
dbconfig
Description | Defines all of the connection parameters for the database server. |
Type | Array |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
dbconfig.db_host_instance
Description | Defines the host instance for MSSQL connections. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfig.db_host_name
Description | Part of the 'dbconfig' array. Defines the host name of the database server. |
Type | String |
Range of values | host name of database server |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfig.db_manager
Description | Part of the 'dbconfig' array. Defines the specific library used to connect with your database. |
Type | String |
Range of values | The class name of the database driver, Possible values are: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', and 'SqlsrvManager'. |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | Determined by install: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', or 'SqlsrvManager' |
Override Example |
|
dbconfig.db_name
Description | Part of the 'dbconfig' array. Defines the database name to connect to on the database server. |
Type | String |
Range of values | database name |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfig.db_password
Description | Part of the 'dbconfig' array. Defines the password that correlates to the db_user_name parameter. |
Type | String |
Range of values | password of the user defined in db_user_name |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfig.db_port
Description | Part of the 'dbconfig' array. Defines the port number on the server to connect to for authentication and transactions. |
Type | String |
Range of values | port number to connect to on the database server |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 3306 |
Override Example |
|
dbconfig.db_type
Description | Defines the type of database being used with Sugar. It is important to note that db2 and oracle are only applicable to Sugar Enterprise and Ultimate. |
Type | String |
Range of values | 'mysql', 'mssql', 'db2', and 'oci8' |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
dbconfig.db_user_name
Description | Defines the user to connect to the Sugar database as. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
dbconfigoption.autofree
Description | Automatically frees the database reference when it closes the reference. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
dbconfigoption.collation
Description | The set of rules to be used for comparing characters in a character set.
|
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | utf8mb4_0900_ai_ci |
Override Example |
|
dbconfigoption.debug
Description | Enables debugging on the database connection. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
dbconfigoption.persistent
Description | Determines whether Sugar should use persistent connection when possible to connecting to the database. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
dbconfigoption.ssl
Description | Enables SSL on the database connection. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
dbconfigoption.ssl_options
Description | An array detailing the SSL database connection options. |
Type | Array |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfigoption.ssl_options.ssl_capath
Description | The path the trusted SSL certificate authority file in PEM format for SSL connection to the database. |
Type | String |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfigoption.ssl_options.ssl_cert
Description | The path the SSL certificate file for SSL connection to the database. |
Type | String |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfigoption.ssl_options.ssl_cipher
Description | The SSL cipher to be used for encryption. |
Type | String |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dbconfigoption.ssl_options.ssl_key
Description | The path the SSL key for SSL connection to the database. |
Type | String |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
default_currency_significant_digits
Description | Changes the number of significant digits in currency by default. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 2 |
Override Example |
|
default_date_format
Description | Modifies the default date format for all users. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | m/d/Y |
Override Example |
|
default_decimal_seperator
Description | Sets the character used as a decimal separator for numbers. |
Type | String |
Range of values | Any character |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | . |
Override Example |
|
default_email_client
Description | Sets the default email client that opens when users send emails. |
Type | String |
Range of values | 'sugar', 'external' |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | sugar |
Override Example |
|
default_language
Description | Sets each user's default language. Possible values include any language offered by Sugar, such as: 'ar_SA', 'bg_BG', 'ca_ES', 'cs_CZ', 'da_DK', 'de_DE', 'el_EL', 'en_UK', 'en_us', 'es_ES', 'es_LA', 'et_EE', 'fi_FI', 'fr_FR', 'he_IL', 'hu_HU', 'it_it', 'ja_JP', 'ko_KR', 'lt_LT', 'lv_LV', 'nb_NO', 'nl_NL', 'pl_PL', 'pt_BR', 'pt_PT', 'ro_RO', 'ru_RU', 'sk_SK', 'sq_AL', 'sr_RS', 'sv_SE', 'tr_TR', 'uk_UA', 'zh_CN' |
Type | String |
Range of values | Any available language |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | en_us |
Override Example |
|
default_number_grouping_seperator
Description | Sets the character used as the 1000s separator for numbers. |
Type | String |
Range of values | Any character |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | , |
Override Example |
|
default_permissions
Description | Array that defines the ownership and permissions for directories and files created naturally by the application. |
Type | Array |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
default_permissions.dir_mode
Description | Part of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created directories. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 1528 equates to the permissions 2770. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
default_permissions.file_mode
Description | Part of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created files. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 432 in equates to the permissions 660. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
default_permissions.group
Description | Used in UNIX-based systems only to define the group membership of any newly created directories and files. This value should be a group that the Apache user is a member of to help ensure proper functionality. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
default_permissions.user
Description | Part of the 'default_permissions' array. Used in UNIX-based systems only to define the ownership of any newly created directories and files. This value should be the Apache user. |
Type | String |
Range of values | Apache user |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
default_user_is_admin
Description | Allows for determining whether a user is a system administrator by default. |
Type | Boolean |
Range of values | true, false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
deny_license_update
Description | Determines whether the license key in Admin > License Management is editable in the user interface. |
Type | Boolean |
Range of values | true and false |
Versions | 9.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
developer_mode_visible
Description | Determines whether the Developer Mode flag is visible to administrators in Admin > System Settings. |
Type | Boolean |
Range of values | true or false |
Versions | 11.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
developerMode
Description | Rebuilds various cached files when a page is accessed. Can be set by an admin in Admin > System Settings. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
diagnostic_file_max_lifetime
Description | The 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. |
Type | Integer |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 604800 |
Override Example |
|
disable_count_query
Description | Removes the count totals from listviews. This is commonly used to prevent performing expensive count queries on the database when loading listviews and subpanels. It is important to note that in 7.x, this parameter will only affect modules running in Backward Compatibility mode. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
disable_export
Description | Prevents exports of data into .csv files. Normally set in the UI via Admin > Locale. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
disable_related_calc_fields
Description | When 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. |
Type | Boolean |
Range of values | true and false |
Versions | 6.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
disable_team_access_check
Description | Prevents 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. |
Type | Boolean |
Range of values | true and false |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
disable_unknown_platforms
Description | Controls 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 7.6 - 7.10: false 7.11 and higher: true |
Override Example |
|
disable_uw_upload
Description | Disables the upgrade wizard from being accessible through the Sugar admin interface. |
Type | Boolean |
Range of values | true and false |
Versions | .0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
disable_vcr
Description | Disables record paging in the detailview (VCR controls). Increases performance by not loading all records from a listview into memory when accessing the record detailview. In 7.x versions, this setting is only applicable to modules running in Backward Compatibility Mode. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
disabled_languages
Description | Allows an admin to select languages that are disabled for the instance. |
Type | String |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
dump_slow_queries
Description | Logs slow queries to the sugar log file. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
email_default_client
Description | Sets the default email client for all users. |
Type | String |
Range of values | sugar, external |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | sugar |
Override Example |
|
email_default_delete_attachments
Description | When deleting an email, this setting will mark all related notes as deleted, and attempt to delete files that are related to those notes. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
email_default_editor
Description | Allows configuring the default editor type for email. 'plain' sets the editor to only use plain text. 'html' allows the editor to be html enabled. |
Type | String |
Range of values | 'plain' and 'html' |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | html |
Override Example |
|
email_mailer_timelimit
Description | The timeout period in seconds for SMTP commands. |
Type | Integer |
Range of values | Any integer greater than or equal to 1 |
Versions | 12.2+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | 2 |
Override Example |
|
email_mailer_timeout
Description | The 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. |
Type | Integer |
Versions | 7.8+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 2 |
Override Example |
|
email_participants_min_search
Description | The number of characters that are required to start searching for email recipients. It prevents excessive database load in case of short search conditions for email recipients. |
Type | Integer |
Range of values | 2, 3, 4, 5 (preferably 3-5) |
Versions | 13.1+ |
Products | Enterprise, Serve, Sell |
Default Value | 1 |
Override Example |
|
email_recipient_chunk_size
Description | Defines the maximum number of addresses in the email's To field. If an email is to be sent to more than the email_recipient_chunk_size addresses, the list will be split and multiple duplicate emails will be sent, each one with no more than the email_recipient_chunk_size recipients in the To field. Some email service providers limit maximum number of recipients in an email, this option is intended to workaround such limitations. |
Type | Integer |
Range of values | Any integer greater than or equal to 1 |
Versions | 12.1+ |
Products | Enterprise, Serve, Sell |
Default Value | 10 |
Override Example |
|
enable_link_to_drawer
Description | When 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. |
Type | Boolean |
Range of values | true and false |
Versions | 10.3+ |
Products | Serve, Sell |
Default Value | true |
Override Example |
|
enable_long_text_search
Description | When true, Elasticsearch will enable long-text search for the following field types: 'longtext', 'htmleditable_tinymce'. |
Type | Boolean |
Range of values | true and false |
Versions | 10.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
enable_mobile_redirect
Description | Flag indicating whether smartphone users are automatically redirected to the mobile view when navigating to a Sugar instance. |
Type | Boolean |
Range of values | true and false |
Versions | 7.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
enable_one_index
Description | If 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. |
Type | Boolean |
Range of values | true or false |
Versions | 11.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
exclude_notifications
Description | This setting controls the modules that are excluded from assignment notifications. |
Type | Array |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
exclude_notifications.module
Description | Allows an administrator to explicitly disable modules from sending assignment notifications to users. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
external_cache
Description | SugarCache basic configuration. |
Type | Array |
Versions | 6.2+ |
Products | Enterprise, Serve, Sell |
Override Example |
|
external_cache_db_gc_probability
Description | Probability factor to determine when garbage collection on stale keys from the DB backend will happen. |
Type | Integer |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 0.0001 |
Override Example |
|
external_cache_db_gc_threshold
Description | The threshold in milliseconds to flag garbage collection queries as [SLOW] in sugarcrm.log. |
Type | Integer |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 200 |
Override Example |
|
external_cache_disabled
Description | Disables all external caching in Sugar. This is normally set to true to determine if there is a conflict with PHP caching. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
external_cache_disabled_memcached
Description | Disables Memcached caching from working with Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching. |
Type | Boolean |
Range of values | true and false |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
external_cache_disabled_redis
Description | Disables Redis 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. |
Type | Boolean |
Range of values | true and false |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
external_cache_disabled_wincache
Description | Disables 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. |
Type | Boolean |
Range of values | true and false |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
external_cache_force_backend
Description | Force given external key/value cache backend. Make sure that the requirements are met and any other cache backend specific configuration is applied. |
Type | String |
Range of values | apc, db, file, memcache, memcached, memory, redis, smash, wincache, and zend |
Versions | 6.2+ |
Products | Professional, Enterprise |
Default Value | empty |
Override Example |
|
external_cache.memcache
Description | This setting controls the memcache properties. |
Type | Array |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
external_cache.memcache.host
Description | The host url for memchache. |
Type | String |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 127.0.0.1 |
Override Example |
|
external_cache.memcache.port
Description | The host port for memcache. |
Type | Integer |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 11211 |
Override Example |
|
external_cache.redis
Description | This setting controls the redis properties. |
Type | Array |
Versions | 9.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
external_cache.redis.host
Description | The IP address or the hostname of the Redis host. |
Type | String |
Range of values | '127.0.0.1', '192.168.0.2', 'redis.serveraddress.com', 'local.redis.server.local' |
Versions | 9.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 127.0.0.1 |
Override Example |
|
external_cache.redis.persistent
Description | The type of connection to the Redis server: persistent or not. |
Type | Boolean |
Range of values | true and false |
Versions | 9.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
external_cache.redis.port
Description | The Port number configured in the Redis host. |
Type | Integer |
Range of values | Any TCP port number |
Versions | 9.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 6379 |
Override Example |
|
external_cache.redis.timeout
Description | Connection timeout to the Redis server. 0 means unlimited or OS defined. |
Type | Integer |
Range of values | Any integer greater than or equal to 0 |
Versions | 9.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
forms
Description | An array defining form requirements. |
Type | Array |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
forms.requireFirst
Description | Presents all required fields grouped together in the first panel on the EditView form. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
freebusy_use_vcal_cache
Description | Prior to Sugar version 7.6, FreeBusy Calendar searches used the vcals table to cache user meeting and call activity for the purpose of determining user availability in for future free time search. As of 7.6, a new design allowed for more accurate free/busy searching that no longer used this cache, but the cache was still being written to, by default, when calls/meetings were created/updated for backward compatibility reasons. As of Sugar 7.9, in order to enhance performance, the cache is no longer being written to by default. Instead, the override variable 'FreeBusyCache_Enabled' must be set to true for the Cache to be written. Since this cache is no longer used inside the Sugar application, this option should be used with caution as the cache itself is expected to be removed from the Sugar product in a future release. |
Type | Boolean |
Range of values | true and false |
Versions | .0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
freeze_list_headers
Description | Global 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. |
Type | Boolean |
Versions | 12.0+ |
Products | Enterprise, Serve, Sell |
Default Value | true |
Override Example |
|
gs_use_shortcut_operator
Description | The 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. |
Type | Boolean |
Range of values | true and false |
Versions | 8.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
hide_admin_licensing
Description | Hides the License settings subpanel in the administrative panel. |
Type | Boolean |
Range of values | true and false |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
hide_full_text_engine_config
Description | Determines if the FTS settings are present in the admin search page in Admin > Search. |
Type | Boolean |
Range of values | true and false |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
hide_subpanels
Description | This setting only applies to modules running in Backward Compatibility Mode. When a DetailView is loaded, all subpanels are collapsed. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
hide_subpanels_on_login
Description | This setting only applies to modules running in backward compatibility mode. Collapses subpanels per session. When a DetailView is initially loaded during a session, all subpanels are collapsed. Once explanded, it will remain expanded until the user logs out. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
hint
Description | The array of configurations related to Hint. |
Type | Array |
Versions | 10.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
hint.hint_install_target_geo
Description | This 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. |
Type | String |
Range of values | 'US', 'EU', 'APSE' |
Versions | 10.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
history_max_viewed
Description | The number of history items from the tracker to display for a user. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 50 |
Override Example |
|
host_name
Description | Sets the host name of the instance, such as the website address or location where the instance is hosted and accessed. |
Type | String |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | localhost |
Override Example |
|
import_max_records_per_file
Description | The number of records to process per batch during an import using the Import Wizard. |
Type | Integer |
Range of values | Any integer |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 100 |
Override Example |
|
installer_locked
Description | Sets whether the installer is locked or not. When false, it is possible to access Sugar's initial configuration page to reinstall the instance. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
jobs
Description | Job Queue configurations. |
Type | Array |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
jobs.hard_lifetime
Description | Hard deletes all jobs that are older than the hard cutoff. Default is 21 days. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 21 |
Override Example |
|
jobs.max_retries
Description | Maximum number of failures for job. Default is 5. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 5 |
Override Example |
|
jobs.min_retry_interval
Description | Minimal interval between job reruns. Default is 30 seconds. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 30 |
Override Example |
|
jobs.soft_lifetime
Description | Soft deletes all jobs that are older than cutoff. Default is 21 days. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 7 |
Override Example |
|
jobs.timeout
Description | If a job is running longer than the limit, the job is failed by force. Specified in seconds. Default is 3600 seconds (1 hour). |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 3600 |
Override Example |
|
languages
Description | The 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. |
Type | Array |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | All available languages |
Override Example |
|
list_max_entries_per_page
Description | Listview items per page. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 20 |
Override Example |
|
list_report_max_per_page
Description | Sets the maximum number of reports that are listed on each page in the Reports module. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 100 |
Override Example |
|
log_dir
Description | Sets the location in the file system where the Sugar log file will be stored. By default, it is set to '.' meaning that it is stored in the root instance directory. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | . |
Override Example |
|
log_file
Description | Designates the file name where the instance's logs will be stored. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | sugarcrm.log |
Override Example |
|
log_memory_usage
Description | Logs the memory usage. |
Type | Boolean |
Range of values | true and false |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
logger
Description | An array that defines all of the logging settings. |
Type | Array |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger_visible
Description | Determines whether the Logger Settings panel is visible to administrators in Admin > System Settings. |
Type | Boolean |
Range of values | true and false |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
logger.channels
Description | This 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. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.authentication
Description | This setting controls the PSR-3 Logger Channel configuration for the authentication channel. |
Type | Array |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.authentication.handlers
Description | This setting controls the PSR-3 Logger Handler utilized by the authentication logging channel. |
Type | Array |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.authentication.level
Description | This 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. |
Type | String |
Range of values | 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off' |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.authentication.processors
Description | This setting controls the authentication PSR-3 Logger channels processors. |
Type | Array |
Range of values | 'request', 'backtrace' |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.channel
Description | This 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. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.channel.handlers
Description | This 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. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.channel.level
Description | This setting controls the PSR-3 Log Level for the specified log channel. |
Type | String |
Range of values | 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off' |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.channel.processors
Description | This 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. |
Type | Array |
Range of values | 'request', 'backtrace' |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.db
Description | This setting controls the PSR-3 Logger Channel configuration for the db channel. |
Type | Array |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.db.handlers
Description | This setting controls the PSR-3 Logger Handler utilized by the db logging channel. |
Type | Array |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.db.level
Description | This setting controls the Log Level for the db channel of the PSR-3 Logger. |
Type | String |
Range of values | 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off' |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.db.processors
Description | This setting controls the db PSR-3 Logger channels processors. |
Type | Array |
Range of values | 'request', 'backtrace' |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.deprecation
Description | This 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. |
Type | Array |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
logger.channels.deprecation.handlers
Description | This 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. |
Type | Array |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
logger.channels.deprecation.level
Description | This setting controls the deprecation PSR-3 Logger channel's log level. |
Type | String |
Range of values | emergency, alert, critical, error, warning, notice, info, debug, off |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | alert |
Override Example |
|
logger.channels.deprecation.processors
Description | This 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. |
Type | Array |
Range of values | request, backtrace |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
logger.channels.input_validation
Description | This setting controls the PSR-3 Logger Channel configuration for the input_validation channel. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.input_validation.handlers
Description | This setting controls the PSR-3 Logger Handler utilized by the input_validation logging channel. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.input_validation.level
Description | This setting controls the logging level for input validation failure messages when validation.soft_fail is enabled. |
Type | String |
Range of values | 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off' |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.input_validation.processors
Description | This setting controls the input_validation PSR-3 Logger channels processors. |
Type | Array |
Range of values | 'request', 'backtrace' |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.metadata
Description | This setting controls the PSR-3 Logger Channel configuration for the metadata channel. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.metadata.handlers
Description | This setting controls the PSR-3 Logger Handler utilized by the metadata logging channel. |
Type | Array |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.metadata.level
Description | This 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. |
Type | String |
Range of values | 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off' |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.metadata.processors
Description | This setting controls the metadata PSR-3 Logger channels processors. |
Type | Array |
Range of values | 'request', 'backtrace' |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.rest
Description | This setting controls the PSR-3 Logger Channel configuration for the rest channel. |
Type | Array |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.rest.handlers
Description | This setting controls the PSR-3 Logger Handler utilized by the rest logging channel. |
Type | Array |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.rest.level
Description | This setting controls the Log Level for the rest channel of the PSR-3 Logger. |
Type | String |
Range of values | 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off' |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.channels.rest.processors
Description | This setting controls the rest PSR-3 Logger channels processors. |
Type | Array |
Range of values | 'request', 'backtrace' |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
logger.file.dateFormat
Description | The date format for the log file is any value that is acceptable to the PHP strftime() function. The default is '%c'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php. |
Type | String |
Range of values | Pattern for date format |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | %c |
Override Example |
|
logger.file.ext
Description | The extension of the log file. The default value is '.log'. |
Type | String |
Range of values | Extension for the log |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | .log |
Override Example |
|
logger.file.maxLogs
Description | When the log file grows to the logger.file.maxSize value, the system will automatically roll the log file. 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. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
logger.file.maxSize
Description | This value controls the max file size of a log before the system will roll the log file. It must be set in the format '10MB' where 10 is number of MB to store. Always use MB as no other value is currently accepted. To disable log rolling set the value to false. The default value is '10MB'. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10MB |
Override Example |
|
logger.file.name
Description | The name of the log file to be written to. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | sugarcrm |
Override Example |
|
logger.file.suffix
Description | The suffix to the file name to track logs chronologically. For instance, if you wanted to append the month and year to a file name, you can change this setting to '%m_%Y'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
logger.level
Description | Determines the logging level of the system. The recommended setting is 'fatal'. |
Type | String |
Range of values | 'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off' |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | fatal |
Override Example |
|
maintenanceMode
Description | Allows the instance to be placed in a maintenance mode where non-admin users cannot access the instance. |
Type | Boolean |
Range of values | true and false |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
mark_emails_seen
Description | Determines whether to mark an email as read before importing the email to Sugar during the inbound email import. This is not recommended as an import failure will cause the email to be marked as read which will be skipped during the next inbound email import. |
Type | Boolean |
Range of values | true and false |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
marketing_extras_enabled
Description | This configuration disables the marketing content on the Sugar login screen. |
Type | Boolean |
Range of values | true and false |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
mass_actions
Description | Array that defines mass action behaviors. |
Type | Array |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
mass_actions.mass_delete_chunk_size
Description | Number of records per chunk while performing a mass delete. |
Type | Integer |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 20 |
Override Example |
|
mass_actions.mass_link_chunk_size
Description | Number of records per chunk while performing mass linking updates. |
Type | Integer |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 20 |
Override Example |
|
mass_actions.mass_update_chunk_size
Description | Number of records per chunk while performing a mass update. |
Type | Integer |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 500 |
Override Example |
|
mass_actions.max_records_to_merge
Description | Number of records per chunk while performing a mass merge. |
Type | Integer |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 5 |
Override Example |
|
max_aggregate_email_attachments_bytes
Description | The 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. |
Type | Integer |
Versions | 7.10+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10000000 |
Override Example |
|
max_session_time
Description | Determines 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. |
Type | Integer |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | null |
Override Example |
|
maxPinnedModules
Description | The number of pinned modules to be displayed on the navigation bar (in the collapsed state).
Note: For Sugar versions 13.0.0 and higher, the number of pinned modules can also be configured via Admin > Navigation Bar and Subpanels. |
Type | Integer |
Versions | 12.3+ |
Products | Enterprise, Serve, Sell |
Default Value | 4 |
Override Example |
|
metric_providers
Description | A Name/Path array of metric providers for measuring system metrics |
Type | Array |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
metric_settings
Description | The individual settings required by a metric provider. And values provided will be passed when instantiating the metric providers object. |
Type | Array |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
metrics_enabled
Description | Whether or not system metrics have been enabled. |
Type | Boolean |
Range of values | true and false |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
minify_resources
Description | Determines whether minification and compression are applied to javascript resources |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
moduleInstaller
Description | Array that defines restrictions on module installations via the Module Loader utility. |
Type | Array |
Versions | .0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
moduleInstaller.disableActions
Description | Part 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. |
Type | Array |
Range of values | Specific actions to restrict in module packages |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | array() |
Override Example |
|
moduleInstaller.disableFileScan
Description | When packageScan is set to 'true', Sugar scans all files in an installable package to ensure that the file extensions are acceptable and that the files do not contain denylisted class or function calls. Setting the disableFileScan parameter to 'true' avoids this scan from occurring while still enforcing other parameters set. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
moduleInstaller.features.enableHttpOnlyCookies
Description | Sets the cookie option to "HTTP Only" for loginErrorMessage cookie in case of session expiration. |
Type | Boolean |
Range of values | true and false |
Versions | 13.1+ |
Products | Enterprise, Serve, Sell |
Default Value | true |
Override Example |
|
moduleInstaller.features.enableStringManifestChecks
Description | Adds an extra check to the PackageScanner to scan manifest.php before it is included/required by the code. |
Type | Boolean |
Range of values | true or false |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Default Value | true |
Override Example |
|
moduleInstaller.features.enforceSecureSmarty
Description | Enforces the use of Sugarcrm\Sugarcrm\Security\MLP\Alternatives\Sugar_Smarty instead of Smarty and Sugar_Smarty in module loadable packages. |
Type | Boolean |
Range of values | true or false |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Default Value | false |
Override Example |
|
moduleInstaller.packageScan
Description | Enables package scanning on any modules uploaded through Module Loader prior to the installation. If the package is found to violate any restrictions of the packageScan, the installation will not proceed and an error report will be generated to the user attempting the install. |
Type | Boolean |
Range of values | true and false |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
moduleInstaller.unserialize.allowed_classes
Description | The contents of module loadable packages are patched at the upload stage if the module loadable package contains calls to the unserialize() function. All the calls to unserialize() will be replaced with the secure alternative \Sugarcrm\Sugarcrm\Security\MLP\Alternatives\unserialize() . The alternative function acts as a wrapper to unserialize() , enforcing the usage of the second parameter with allowed_classes option. By default, it does not allow unserializing classes, and the behavior is equal to calling \unserialize() with the ['allowed_classes' => false] as a second parameter.
The following classes cannot be allowed in any case because they can be used to perform PHP Object Injection Attacks:
These classes will be ignored if you pass them as a parameter or specify them in config.php. |
Type | Array |
Range of values | Array of classes whose unserialize() functions should not be replaced with the secure alternative |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Default Value | empty |
Override Example |
|
moduleInstaller.validExt
Description | Part 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. |
Type | Array |
Range of values | File extensions to allow |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | array() |
Override Example |
|
mso_fixup_paragraph_tags
Description | Determines 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). |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
new_email_addresses_opted_out
Description | If 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. |
Type | Boolean |
Range of values | true and false |
Versions | 8.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
noPrivateTeamUpdate
Description | Prevents 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 |
Type | Boolean |
Range of values | true and false |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
oauth_token_expiry
Description | Sets whether OAuth tokens will expire. |
Type | String |
Range of values | true and false |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | False |
Override Example |
|
oauth_token_life
Description | Sets the length (in seconds) of the life of an OAuth token. |
Type | Integer |
Versions | 7.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 86400 |
Override Example |
|
oauth2
Description | Configutations for the oauth2 server. |
Type | Array |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
oauth2.access_token_lifetime
Description | The 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. |
Type | Integer |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 3600 |
Override Example |
|
oauth2.refresh_token_lifetime
Description | The 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. |
Type | Integer |
Versions | 7.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 1209600 |
Override Example |
|
oracle_enable_ci
Description | By default, Oracle searching is case sensitive in Sugar, which can be a problem if you are not sure of the case of the data you are searching for. Using this settings, you can turn on insensitive search for Oracle 10g and 11g. |
Type | Boolean |
Range of values | true and false |
Versions | 6.1+ |
Products | Enterprise, Ultimate |
Default Value | false |
Override Example |
|
passwordHash
Description | Array 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. |
Type | Array |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
passwordHash.algo
Description | The 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. |
Type | String |
Range of values | For native backend: "PASSWORD_DEFAULT" and "PASSWORD_BCRYPT". For sha2 backend: "CRYPT_SHA256" and "CRYPT_SHA512" |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | "PASSWORD_DEFAULT" for native. "CRYPT_SHA256" for sha2 backend. |
Override Example |
|
passwordHash.allowLegacy
Description | Allow 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 7.7.x: true 7.8.x+:false |
Override Example |
|
passwordHash.backend
Description | The 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. |
Type | String |
Range of values | 'sha2' and 'native' |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | native |
Override Example |
|
passwordHash.options
Description | The 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. |
Type | Array |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
passwordHash.options.cost
Description | An 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. |
Type | Integer |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
passwordHash.options.rounds
Description | An 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. |
Type | Integer |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 5000 |
Override Example |
|
passwordHash.rehash
Description | When 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
passwordsetting
Description | Defines all of the password requirements for the instance. |
Type | Array |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
passwordsetting.forgotpasswordON
Description | Enables the Forgot Password features. When enabled, users will have the ability to reset their own passwords at the Login page. Set in UI via Admin->Password Management. |
Type | String |
Range of values | 0, 1 |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 1 |
Override Example |
|
passwordsetting.linkexpiration
Description | Determines whether the password reset link expires. |
Type | String |
Range of values | 0, 1 |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
passwordsetting.onelower
Description | Configures whether at least one lower-case letter is required in users' passwords. |
Type | String |
Range of values | 0, 1 |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
passwordsetting.onenumber
Description | Configures whether at least one number is required in users' passwords. |
Type | String |
Range of values | 0, 1 |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 1 |
Override Example |
|
passwordsetting.oneupper
Description | Configures whether at least one upper-case letter is required in users' passwords. |
Type | Boolean |
Range of values | 0, 1 |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
passwordsetting.systexpirationtype
Description | Specifies 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. |
Type | Integer |
Range of values | 1, 7, and 30 |
Versions | 5.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 1 |
Override Example |
|
pdf_file_max_lifetime
Description | The 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. |
Type | Integer |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 86400 |
Override Example |
|
perfProfile
Description | Allows 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. |
Type | Array |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
perfProfile.TeamSecurity
Description | Determines whether the team security filtering is applied. |
Type | Array |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
perfProfile.TeamSecurity.default
Description | This setting is used to enable or disable Team Security denormalization feature by default across the application. |
Type | Array |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
perfProfile.TeamSecurity.default.disable_subquery_optimizer_hint
Description | As 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'. |
Type | Boolean |
Range of values | true and false |
Versions | 11.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
perfProfile.TeamSecurity.default.teamset_prefetch
Description | Fetches 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; |
Type | Boolean |
Range of values | true and false |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
perfProfile.TeamSecurity.default.teamset_prefetch_max
Description | The 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; |
Type | Integer |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
perfProfile.TeamSecurity.default.use_denorm
Description | This 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; |
Type | Boolean |
Range of values | true and false |
Versions | 8.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
perfProfile.TeamSecurity.default.where_condition
Description | Determines 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; |
Type | Boolean |
Range of values | true and false |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
perfProfile.TeamSecurity.gs_use_normalized_teams
Description | Determines 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. |
Type | Boolean |
Range of values | true and false |
Versions | 11.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
perfProfile.TeamSecurity.inline_update
Description | When 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. |
Type | Boolean |
Range of values | true and false |
Versions | 8.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
pmse_settings_default
Description | Settings for troubleshooting and debugging SugarBPM |
Type | Array |
Versions | 7.6+ |
Products | Enterprise, Ultimate, Serve, Sell |
Override Example |
|
pmse_settings_default.error_number_of_cycles
Description | Number of cycles before triggering an error in SugarBPM |
Type | String |
Versions | 7.6+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
pmse_settings_default.error_timeout
Description | Time in seconds of timeout before triggering an error in SugarBPM |
Type | String |
Versions | 7.6+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | 40 |
Override Example |
|
pmse_settings_default.logger_level
Description | The default logger level for SugarBPM |
Type | String |
Range of values | emergency, alert, critical, error, warning, notice, info, debug |
Versions | 7.6+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | critical |
Override Example |
|
portal_enableSelfSignUp
Description | This 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. |
Type | Boolean |
Range of values | true and false |
Versions | 11.1+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
processes_auto_save_interval
Description | Defines 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. |
Type | Integer |
Versions | 8.3+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | 30000 |
Override Example |
|
processes_auto_validate_on_autosave
Description | Defines 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. |
Type | Boolean |
Range of values | true and false |
Versions | 8.3+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
processes_auto_validate_on_import
Description | Determines whether validation of process definitions will automatically occur immediately after a process definition is imported. |
Type | Boolean |
Range of values | true and false |
Versions | 8.3+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
proxy_visible
Description | Determines 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. |
Type | Boolean |
Range of values | true or false |
Versions | 11.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
push_notification
Description | The array of configurations related to push notifications. |
Type | Array |
Versions | 11.0+ |
Products | Enterprise, Ultimate, Serve, Sell |
Override Example |
|
push_notification.enabled
Description | For 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 |
Type | Boolean |
Range of values | true and false |
Versions | 11.0+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
push_notification.service_provider
Description | For 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 |
Type | String |
Range of values | 'SugarPush' |
Versions | 11.0+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | 'SugarPush' |
Override Example |
|
reports_complexity_display
Description | Array that establishes the thresholds for the number of cells in a report above which the formatting changes. |
Type | Array |
Range of values | Positive integers |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Override Example |
|
reports_complexity_display.export
Description | When a report has more than this many cells, you will only be able to view results in a table by exporting the table. |
Type | Integer |
Range of values | Any integer greater than or equal to 1 |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Default Value | 300000 |
Override Example |
|
reports_complexity_display.simplified
Description | When a report has more than this many cells, you will be able to view results as a simplified table or export the results. |
Type | Integer |
Range of values | Any integer greater than or equal to 1 |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Default Value | 50000 |
Override Example |
|
require_accounts
Description | Determines whether an account is required for record creation within the system. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
rest_response_etag_cache_age
Description | Controls how long the browser should cache rest responses. |
Type | Integer |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
roleBasedViews
Description | Enables role based views and dropdowns. |
Type | Boolean |
Range of values | true and false |
Versions | 7.6+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
SAML_provisionUser
Description | Determines 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
SAML_X509Cert
Description | The SAML Certificate Key. |
Type | String |
Versions | 6.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
schedule_report_with_chart
Description | By 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. |
Type | Boolean |
Range of values | true and false |
Versions | 8.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
search_engine
Description | Array that defines the search enginer behaviors. |
Type | Array |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
search_engine.force_async_index
Description | Force asyncronous FTS indexing for updated/created records. Always puts the records into the queue for indexing instead of indexing in runtime. |
Type | Boolean |
Range of values | true or false |
Versions | 7.0+ |
Products | Enterprise, Serve, Sell |
Default Value | false |
Override Example |
|
search_engine.max_bulk_delete_threshold
Description | The maximun number of records that can be deleted at a time. |
Type | Integer |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 3000 |
Override Example |
|
search_engine.max_bulk_query_threshold
Description | The maximum number of records to process before starting to bulk insert. Prevents memory issues. |
Type | Integer |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 15000 |
Override Example |
|
search_engine.max_bulk_threshold
Description | The maximum number of records to process before starting to bulk insert. Prevents memory issues. |
Type | Integer |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 5000 |
Override Example |
|
search_engine.postpone_job_time
Description | Amount of time to postpone a job by so that it's not executed twice during the same request. |
Type | Integer |
Versions | 7.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 120 |
Override Example |
|
search_wildcard_infront
Description | In Sugar 7.x+, this setting is only valid for modules running in BWC mode. When enabled, automatically adds a wildcard in front of any searches performed in the application. This setting is not recommended to be enabled as preceding wildcards results in database indices not being utilized and performance decreasing. |
Type | Boolean |
Range of values | true and false |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
security.private_ips
Description | Defines a range of IPs considered to be private. Such IPs and corresponding domains are not reachable via ExternalResourceClient. |
Type | Array |
Range of values | Pipe-delimited range of IPs (e.g., '10.0.0.0|10.255.255.255') |
Versions | 12.1+ |
Products | Enterprise, Serve, Sell |
Default Value | ['10.0.0.0|10.255.255.255', '172.16.0.0|172.31.255.255', '192.168.0.0|192.168.255.255', '169.254.0.0|169.254.255.255', '127.0.0.0|127.255.255.255',] |
Override Example |
|
security.use_doh
Description | Enables remote Domain Name System (DNS) resolution via the HTTPS protocol. A goal of the method is to increase user privacy and security by preventing eavesdropping and manipulation of DNS data by man-in-the-middle attacks by using the HTTPS protocol to encrypt the data between the DoH (DNS over HTTPS) client and the DoH-based DNS resolver. When enabled, it will use dns.google (8.8.4.4) to resolve hostnames. |
Type | Boolean |
Range of values | true and false |
Versions | 13.0+ |
Products | Enterprise, Serve, Sell |
Default Value | false |
Override Example |
|
session_dir
Description | Directory on the server to store Sugar session data. If left empty, the PHP session settings will be inherited. |
Type | String |
Range of values | Directory path |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | empty |
Override Example |
|
show_download_tab
Description | Used to determine whether the download tab will appear in the User settings. The download tab provides users with access to Sugar plug-ins and other available downloads. |
Type | Boolean |
Range of values | true and false |
Versions | 6.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
showThemePicker
Description | Removes the theme selection drop down. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
site_url
Description | Current URL of your Sugar instance. This value is critical in its accuracy for multiple points of functionality in the instance. |
Type | String |
Range of values | Current URL of Sugar |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
slow_query_time_msec
Description | Slow query time threshold. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 5000 |
Override Example |
|
smtp_mailer_debug
Description | The 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 . |
Type | Integer |
Range of values | 0, 1, 2, 3, 4 |
Versions | 7.9+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
stack_trace_errors
Description | Displays stack trace of errors. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
studio_max_history
Description | When layout changes are made in Studio, a history of those changes are recorded with each save & deploy under ./custom/history/modules/. The studio_max_history parameter controls how many files Sugar keeps for a particular module. If this parameter is undefined, a default of 50 is observed and to keep all historical Studio actions, set this parameter to 0. |
Type | Integer |
Range of values | Any integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 50 |
Override Example |
|
sugar_version
Description | The current version of Sugar that is being used. This value should not be modified as it is updated in the config when Sugar is upgraded. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
symfony_deprecation_log
Description | By default, the deprecation warnings, triggered by Symfony components, are written to sugarcrm.log in the Sugar root directory. But since the default log level is set to Fatal , the deprecation warning messages will not appear in the log. As an option, you can add the $sugar_config['logger']['channels']['deprecation'] configuration and configure the log level and output method to just capture the deprecation warnings in a separate deprecations.log file. |
Type | Boolean |
Range of values | true and false |
Versions | 12.2+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
time_aware_job_max_batch_size
Description | The 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. |
Type | Integer |
Versions | 10.3+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 100 |
Override Example |
|
tmp_dir
Description | The directory path for temporary XML files used by charts and diagnostics. |
Type | String |
Range of values | Filesystem path |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | cache/xml/ |
Override Example |
|
tmp_file_max_lifetime
Description | The 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. |
Type | Integer |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 86400 |
Override Example |
|
tracker_max_display_length
Description | The maximum number of characters to display for records listed in the module tab's Recently Viewed menu. If the record's name is longer than this max value, it will be truncated with an ellipsis at the end. |
Type | Integer |
Versions | 6.0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
tracker_module_config
Description | Array that defines the parameters that control which modules are tracked when Tracker Actions are enabled. |
Type | Array |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
tracker_module_config.disable
Description | The 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. |
Type | Array |
Range of values | Module keys |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
tracker_module_config.enable_only
Description | A 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. |
Type | Array |
Range of values | Module keys |
Versions | 11.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
uninstall_timeout
Description | Controls the timeout time in seconds for an uninstall process. |
Type | Integer |
Versions | 10.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 600 |
Override Example |
|
uninstallOnError
Description | Toggles the switch that uninstalls the package that was just installed if the install ended up with a PHP error. |
Type | Boolean |
Range of values | true and false |
Versions | 12.0+ |
Products | Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
unique_key
Description | Specifies the unique identifier for the instance. This value is used in features such as PHP caching, FTS indexing, and email archiving. It is extremely important that this string is unique from any other instances deployed even if they are only for development purposes only. |
Type | String |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
upload_badext
Description | An array of extensions that cannot be uploaded in their native file format. Sugar will append a .txt extension to the end of any files with an invalid extension to avoid security issues with running unauthorized scripts on an instance. |
Type | Array |
Range of values | Extensions that cannot be uploaded as is |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
upload_dir
Description | The directory path where uploaded files are stored for note attachments, documents, and module loadable packages. By default, uploads are stored in the ./upload/ directory. For more information, refer to the Uploads documentation. |
Type | String |
Range of values | Directory path |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | upload/ |
Override Example |
|
upload_maxsize
Description | The 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. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
upload_wrapper_class
Description | The name of the class used as upload wrapper. |
Type | String |
Versions | 6.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | UploadStream |
Override Example |
|
use_common_ml_dir
Description | A security control that allows you to restrict Module Loader to read modules from a specific directory on the server and disable the ability to upload new modules into the Module Loader. To specify a new directory you will need to populate the config parameter 'common_ml_dir'. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
use_php_code_json
Description | Determines if the environment has a valid version of PHP-JSON. This should be determined by the function returnPhpJsonStatus() and shouldn't be overridden. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
use_real_names
Description | Display users' full names instead of their User Names in assignment fields. |
Type | Boolean |
Range of values | true and false |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
use_sprites
Description | A sprite is a two-dimensional image or animation that is integrated into a larger scene. This parameter is used to disable sprites. This is set to true by default (if you have GD libraries installed). |
Type | Boolean |
Range of values | true and false |
Versions | 6.4+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
validation
Description | An array that defines settings for user input validation behaviors. |
Type | Array |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
validation.compat_mode
Description | Determines 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 7.7.x: true 7.8.x: true 7.9.x: false |
Override Example |
|
validation.soft_fail
Description | Determines 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. |
Type | Boolean |
Range of values | true and false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 7.7.x: true 7.8.x: true 7.9.x: true 8.0.x: false |
Override Example |
|
vcal_time
Description | Used to determine the number of months in advance of the current date that the Free/Busy information for calls and meetings will be published. To turn Free/Busy publishing off, set this variable to '0'. The minimum is 1 month; the maximum is 12 months. |
Type | String |
Range of values | '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', and '12' |
Versions | .0+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 2 |
Override Example |
|
verify_client_ip
Description | Whether 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 SugarConnect. |
Type | Boolean |
Range of values | true and false |
Versions | 10.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
web_logic_hook_timeout
Description | Timeout for requests to web logic hooks. Any requests that run longer than the set limit will fail and trigger an error in the log. |
Type | Integer |
Versions | 11.1+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
wl_list_max_entries_per_page
Description | The number of records to be shown per page on the listview of the mobile browser. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
wl_list_max_entries_per_subpanel
Description | Determines the number of records shown in the subpanels on the DetailView of the mobile browser. |
Type | Integer |
Versions | 5.2+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 3 |
Override Example |
|
xhprof_config
Description | Configuration settings for xhprof. More information on xhprof can be found at http://pecl.php.net/package/xhprof. |
Type | Array |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
xhprof_config.enable
Description | Enables the xhprof profiler. |
Type | Boolean |
Range of values | true and false |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | false |
Override Example |
|
xhprof_config.filter_wt
Description | The wall time. Values are specified in milliseconds. |
Type | Integer |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
xhprof_config.flags
Description | The flags for xhprof profiler. |
Type | String |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
xhprof_config.ignored_functions
Description | An array of function names to ignore from the profile. |
Type | Array |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
xhprof_config.log_to
Description | The path to log the xhprof profiler output to. |
Type | String |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Override Example |
|
xhprof_config.manager
Description | The 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. |
Type | String |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | SugarXHprof |
Override Example |
|
xhprof_config.memory_limit
Description | The memory limit to set while saving profile data to storage. |
Type | String |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 2048M |
Override Example |
|
xhprof_config.mongodb_collection
Description | The name of the mongo db collections. |
Type | String |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | results |
Override Example |
|
xhprof_config.mongodb_db
Description | The name of the mongo database. |
Type | String |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | xhprof |
Override Example |
|
xhprof_config.mongodb_options
Description | Options 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 |
Type | Array |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | results |
Override Example |
|
xhprof_config.mongodb_uri
Description | The mongo server URL. |
Type | String |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | mongodb://localhost:27017 |
Override Example |
|
xhprof_config.sample_rate
Description | The sample rate of the xhprof profiler. 1/{specified value} requests are profiled. To sample all requests, set this value to 1. |
Type | Integer |
Versions | 6.5+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | 10 |
Override Example |
|
xhprof_config.save_to
Description | The place to save xhprof data. If set to 'mongodb', the data is stored in the mongo database. |
Type | String |
Range of values | 'file' and 'mongodb' |
Versions | 7.6+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | mongodb |
Override Example |
|
xhprof_config.track_elastic
Description | Whether or not to track elastic data. |
Type | Boolean |
Range of values | true or false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
xhprof_config.track_elastic_backtrace
Description | Whether or not to store the elastic backtrace data. |
Type | Boolean |
Range of values | true or false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
xhprof_config.track_sql
Description | Whether or not to track SQL queries. |
Type | Boolean |
Range of values | true or false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|
xhprof_config.track_sql_backtrace
Description | Whether or not to store the SQL backtrace data. |
Type | Boolean |
Range of values | true or false |
Versions | 7.7+ |
Products | Professional, Enterprise, Ultimate, Serve, Sell |
Default Value | true |
Override Example |
|