Using Configurator

Overview

A complete list of all settings in SugarCRM

How it works

When you first install SugarCRM, all of your settings will be specified in config.php. As you being changing settings, the settings will be stored in config_override.php.

When using the application, settings in config.php will be overridden with the settings in config_override.php

Settings

addAjaxBannedModules

Performance and page-rendering times are improved in AJAX UI-enabled modules because full page refreshes are not required in those modules. If you are experiencing display issues with modules that are not compatible with AJAX, the AJAX UI for those modules can be disabled.

Type: Array of strings: module names
Versions: 6.3.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['addAjaxBannedModules'][] = 'Accounts';

admin_access_control

Removes: Sugar Updates, Upgrade Wizard, Backups and Module Builder from the Admin menu. These restrictions can be found in ./include/MVC/Controller/file_access_control_map.php and overriden in ./custom/include/MVC/Controller/file_access_control_map.php.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['admin_access_control'] = true;

admin_export_only

Allow only users with administrative privileges to export data.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['admin_export_only'] = true;

allow_pop_inbound

Inbound email accounts are setup to work with IMAP protocols by default. If your email provider required POP3 access instead ofIMAP, you can enables POP3 as an available inbound email protocol. Please note that mailboxes configured with a POP3 connection are not supported and may cause unintended consequences. IMAP is the recommended protocol to use for inbound email accounts.

Type: Boolean: true, false
Versions: 5.5.1RC+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['allow_pop_inbound'] = true;

allow_sendmail_outbound

Enables the option of choosing sendmail as an SMTP server in Admin > Email Settings. Note: sendmail must be enabled on the server for this option to work.

Type: Boolean: true, false
Versions: 5.5.1RC+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['allow_sendmail_outbound'] = true;

authenticationClass

Class to use for user authentication.

Type: String: Authentication class name - ‘SAMLAuthenticate’
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: SugarAuthenticate
Override Example:

$sugar_config['authenticationClass'] = 'SAMLAuthenticate';

cache_dir

This is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory.

Type: String: Path to desired cache directory
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: cache/
Override Example:

$sugar_config['cache_dir'] = 'cache/';

cache_expire_timeout

How long the cached values should be kept in the cache in seconds.

Type: Integer: In seconds
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['cache_expire_timeout'] = 36000;

calendar

An array that defines all of the Calendar enhancements.

Type: Array
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar'] = array();

calendar.day_timestep

Default day step size.

Type: Integer: 15, 30 and 60
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['day_timestep'] = 15;

calendar.default_view

Changes the default view in calendar module.

Type: String: ‘day’, ‘week’, ‘month’ and ‘share’
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['default_view'] = 'week';

calendar.editview_height

Default quick edit popup height in pixels.

Type: Integer: Represented in pixels
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['editview_height'] = 480;

calendar.editview_width

Default quick edit popup width in pixels.

Type: Integer: Represented in pixels
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['editview_width'] = 990;

calendar.items_draggable

Enable/Disable drag-and-drop feature to move calendar items.

Type: Boolean: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['items_draggable'] = true;

calendar.month_timestep

Default month step size.

Type: Integer: 15, 30 and 60
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['month_timestep'] = 60;

calendar.mouseover_expand (deprecated)

Enable/Disable additional detail icon on calendar items.

Type: Boolean: true, false
Versions: 6.4.0RC1 - 6.4.6
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['mouseover_expand'] = true;

calendar.show_calls_by_default

Display/Hide calls by default.

Type: Boolean: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['show_calls_by_default'] = true;

calendar.show_tasks_by_default

Display/Hide tasks by default.

Type: Boolean: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['show_tasks_by_default'] = true;

calendar.week_timestep

Default week step size.

Type: Integer: 15, 30 and 60
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['calendar']['week_timestep'] = 30;

campaign_banner_id_generation

Determines the ID generation for campaign banners. If the value is not set to use ‘md5’ a default guid is generated.

Type: String: ID Generation type.
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: md5
Override Example:

$sugar_config['campaign_banner_id_generation'] = 'md5';

chartEngine

Determines the file to use for loading Chart resources. Scans in custom/include/SugarCharts or include/SugarCharts (see SugarChartFactory::getInstance).

Type: String: ID of chart engine.
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: Jit
Override Example:

$sugar_config['chartEngine'] = 'D3';

check_query

Validates queries when adding limits.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['check_query'] = true;

check_query_cost

Sets the maximum cost limit of a query.

Type: Integer
Versions: 5.2.0+
Editions: Ent, and Ult
Default Value: 10
Override Example:

$sugar_config['check_query_cost'] = 10;

check_query_log

Determines whether a bad query is logged as ‘fatal’ or ‘warn’. If set to true, the bad query is logged as ‘fatal’.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['check_query_log'] = true;

common_ml_dir

Used in conjunction with the parameter ‘use_common_ml_dir’ to restrict Module Loader to read modules from only a specific directory on the server and disable the ability to upload new modules into the Module Loader.

Type: String: path to new directory
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['common_ml_dir'] = '/path/to/new/directory';

create_default_user

Used in PopulateSeedData.php - determines the assigned user for all demo data. If the user does not exist or this value is not set, we default to admin user

Type: String: user_name of the desired user
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['create_default_user'] = 'jim';

cron

Array that defines all of the cron parameters.

Type: Array
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['cron'] = aray();

cron.max_cron_jobs

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 ( http://bugs.sugarcrm.com/?bug_number=62936 ).

Type: Integer
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 10
Override Example:

$sugar_config['cron']['max_cron_jobs'] = 10;

cron.max_cron_runtime

Maximum time per cron run in seconds. Default is 60.

Type: Integer: In seconds
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 60
Override Example:

$sugar_config['cron']['max_cron_runtime'] = 60;

cron.min_cron_interval

Minimum time between cron runs. Setting this to 0 will disable throttling completely.

Type: Integer: In seconds
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 30
Override Example:

$sugar_config['cron']['min_cron_interval'] = 30;

dashlet_auto_refresh_min

This is the minimum value one can choose to have dashlets auto-refresh. Setting to ‘Never’ (-1) disables auto-refreshing of dashlets entirely.

Type: String: ’-1’ (Never), ‘30’, ‘60’, ‘180’, ‘300’ and ‘600'
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dashlet_auto_refresh_min'] = '30';

dbconfig

Array that defines all of the connection parameters for the database server.

Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig'] = array();

dbconfig.db_host_instance

Part of the ‘dbconfig’ array. Defines the host instance for MSSQL connections only.

Type: String: host instance used on the database server. Used only by SQL Server now.
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_host_instance'] = 'SQLEXPRESS';

dbconfig.db_host_name

Part of the ‘dbconfig’ array. Defines the host name of the database server.

Type: String: host name of database server
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_host_name'] = 'localhost';

dbconfig.db_manager

Part of the ‘dbconfig’ array. Defines the specific library used to connect with your database.

Type: String: class name of the DB driver, e.g.: ‘MysqlManager’, ‘MysqliManager’, ‘FreeTDSManager’, ‘MssqlManager’, ‘SqlsrvManager’
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['dbconfig']['db_manager'] = 'MysqliManager';

dbconfig.db_name

Part of the ‘dbconfig’ array. Defines the database name to connect to on the database server.

Type: String: database name
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_name'] = 'sugar_db';

dbconfig.db_password

Part of the ‘dbconfig’ array. Defines the password that correlates to the db_user_name parameter.

Type: String: password of the user defined in db_user_name
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_password'] = 'sql_password';

dbconfig.db_port

Part of the ‘dbconfig’ array. Defines the port number on the server to connect to for authentication and transactions.

Type: String: port number to connect to on the database server
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_port'] = '3306';

dbconfig.db_type

Part of the ‘dbconfig’ array. Defines the type of database used with Sugar.

Type: String: database engine name
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_type'] = 'mysql';

dbconfig.db_user_name

Part of the ‘dbconfig’ array. Defines the user to connect to the database.

Type: String: user name to connect to database
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfig']['db_user_name'] = 'sql_user';

dbconfigoption

This defines options used to connect to the database.

Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dbconfigoption'] = array();

dbconfigoption.persistent

Part of the dbconfig array. Determines whether Sugar should use persistent connection when possible to connect to the database.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: TRUE
Override Example:

$sugar_config['dbconfigoption']['persistent'] = 'sql_user';

default_module_favicon

If you are in a module with an icon, use the module’s icon as the favicon, instead of the theme’s favicon, in the browser tab. Set in UIvia Admin->System Settings.

Type: Boolean: true, false
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['default_module_favicon'] = true;

default_permissions

Array that defines the ownership and permissions for directories and files created naturally by the application.

Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['default_permissions'] = array();

default_permissions.dir_mode

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, a value of 1528 in this setting equates to 2770 permissions.

Type: Integer
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['default_permissions']['dir_mode'] = 1528;

default_permissions.file_mode

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, a value of 432 in this setting equates to 660 permissions.

Type: Integer
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['default_permissions']['file_mode'] = 432;

default_permissions.group

Part of the ‘default_permissions’ array. 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: Group for the Apache user
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['default_permissions']['group'] = 'apache';

default_permissions.user

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: Apache user
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['default_permissions']['user'] = 'apache';

defaultSubPanelExpandCollapse

Ignore the cookie that remembers whether the panel is expanded or collapsed. Setting this to true ill ensure the subpanel is expanded.

Type: Boolean: true, false
Versions: 6.5.3+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: FALSE
Override Example:

$sugar_config['defaultSubPanelExpandCollapse'] = true;

developerMode

Rebuilds all cached files when a page is accessed. Set in the UI via Admin->System Settings.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['developerMode'] = true;

disable_convert_lead

If a lead has already been converted, enabling this option will remove the convert lead action.

Type: Boolean: true, false
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['disable_convert_lead'] = true;

disable_count_query

Drops the absolute totals from listviews. Eliminates performing expensive count queries on the database when populating listviews and subpanels.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: FALSE
Override Example:

$sugar_config['disable_count_query'] = true;

disable_download_tab (deprecated)

Prevents users from accessing the Downloads tab within their user preferences layout. Set in UI via Admin->System Settings.

Type: Boolean: true, false
Versions: 6.0.1 - 6.1.8
Editions: CE, Pro, and Ent
Default Value: TRUE
Override Example:

$sugar_config['show_download_tab'] = false;

disable_export

Prevents exports of data into .csv files. Set in the UI via Admin->Locale

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: FALSE
Override Example:

$sugar_config['disable_export'] = true;

disable_related_calc_fields

When a calculated field in Sugar users 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: true, false
Versions: 6.3.0RC1+
Editions: Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['disable_related_calc_fields'] = true;

disable_team_access_check

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: true, false
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['disable_team_access_check'] = true;

disable_uw_upload

Disables the upgrade wizard from being accessible through the SugarCRM Admin UI.

Type: Boolean: true, false
Versions: 5.2.0j+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['disable_uw_upload'] = true;

disable_vcr

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.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['disable_vcr'] = true;

disc_client

Only used in the Offline Client. Do not set this parameter to true in a production instance of Sugar.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['disc_client'] = false;

dump_slow_queries

Log slow queries.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['dump_slow_queries'] = true;

enable_action_menu

Select to display DetailView and subpanel actions within a dropdown menu. If un-selected, the actions will display as separate buttons.

Type: Boolean: true, false
Versions: 6.5.1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['enable_action_menu'] = true;

enable_autocomplete

Alters dropdown and multiselect field behaviors so that users can type the option they want to select and use ‘Tab’ to complete the selection.

Type: Boolean: true, false
Versions: 6.3.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['enable_autocomplete'] = true;

enable_inline_reports_edit

Allows the user to edit specific field types (e.g. dropdowns, text fields) in a rows and columns report without navigating directly to the record.

Type: Boolean: true, false
Versions: 6.3.0RC1+
Editions: Pro, Corp, Ent, Ult
Override Example:

$sugar_config['enable_inline_reports_edit'] = true;

enable_web_services_user_creation

Allows for the ability to create a portal API user. Default is false in Pro and true for Ent and Ult versions.

Type: Boolean: true, false
Versions: 5.5.0RC4+
Editions: Pro, Ent, Corp, and Ult
Default Value: FALSE
Override Example:

$sugar_config['enable_web_services_user_creation'] = true;

export_excel_compatible

When exporting reports of different languages, users may run into the garbled issue as reading the reports in MS Excel. This configuartion will control whether the encoding is enabled for the exported files. It is set to false by default. When set to true, the exported files would be encoded and readable by MS Excel.

Type: Boolean: true, false
Versions: 6.5.15+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: FALSE
Override Example:

$sugar_config['export_excel_compatible'] = true;

external_cache_disabled

Disables all external 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: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled'] = false;

external_cache_disabled_apc

Disables APC caching from working with Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_apc'] = false;

external_cache_disabled_memcache

Disables Memcache 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: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_memcache'] = false;

external_cache_disabled_memcached

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: true, false
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_memcached'] = false;

external_cache_disabled_redis

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: true, false
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_redis'] = false;

external_cache_disabled_smash

Disables Smash 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: true, false
Versions: 5.2.0c+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_smash'] = false;

external_cache_disabled_wincache

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: true, false
Versions: 6.0.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_wincache'] = false;

external_cache_disabled_zend

Disables Zend caching from working with Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['external_cache_disabled_zend'] = false;

external_cache_disabled_zendserver (deprecated)

Disables ZendServer 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: true, false
Versions: 6.1.0RC1 - 6.1.8
Editions: CE, Pro, and Ent
Override Example:

$sugar_config['external_cache_disabled_zendserver'] = false;

favorites_max_viewed

Maximum number of favorites to show in the module menu.

Type: Integer
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['favorites_max_viewed'] = 10;

forms

An array defining form requirements.

Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['forms'] = array();

forms.requireFirst

Presents all required fields grouped together in the first panel on the EditView form.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: FALSE
Override Example:

$sugar_config['forms']['requireFirst'] = true;

hide_admin_backup

Removes the listing of the Backups option in the Admin menu and also prevents direct access to the feature.

Type: Boolean: true, false
Versions: 6.5.1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['hide_admin_backup'] = true;

hide_admin_licensing

Hides the License settings subpanel in the admin panel.

Type: Boolean: true, false
Versions: 6.5.3+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['hide_admin_licensing'] = true;

hide_full_text_engine_config

Set this to true if you want to hide the FTS settings in the Search admin page.

Type: Boolean: true, false
Versions: 6.5.0RC1+
Editions: Pro, Corp, Ent, Ult, and CE
Override Example:

$sugar_config['hide_full_text_engine_config'] = true;

hide_subpanels

Hides all subpanels. Increases performance by collapsing all subpanels when accessing a detailview every time and not querying for data until a user explicitly expands a subpanel.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['hide_subpanels'] = true;

hide_subpanels_on_login

Hides subpanels per session. Increases performance by collapsing all subpanels when accessing a detailview when the user logs in but any subpanels expanded during the user’s session will remain expanded until the user logs out.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['hide_subpanels_on_login'] = true;

html_allow_objects

If embedded objects are allowed in HTML. If false (default), objects will be filtered out by HTML cleanup routines.

Type: Boolean: true, false
Versions: 6.5.9+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['html_allow_objects'] = false;

http_referer

Array that defines acceptable URLs, actions, and strength level when referencing your instance of Sugar.

Type: Array
Versions: 5.5.3+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['http_referer'] = array();

http_referer.actions

Part of the http_referer array. The ‘actions’ array defines the acceptable actions that can be performed when a request is made from a URL in the whitelist.

Type: Array: List of actions
Versions: 5.5.3+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['http_referer']['actions'][] = 'SupportPortal';

http_referer.list

Part of the http_referer array. To prevent Cross Site Request Forgery (XSRF) attacks, Sugar has a list of acceptable sites that are allowed as a referer to Sugar. If you receive a "Possible Cross Site Request Forgery (XSRF) Attack Detected" message from an approved site trying to access Sugar, you can add that approved site’s URL to the list of valid referers.

Type: Array: List of URLs
Versions: 5.5.3+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['http_referer']['list'][] = 'www.mysite.com';

http_referer.weak

Part of the http_referer array. This parameter allows for a more relaxed HTTP referer security in the application. It is generally recommended to leave this setting as false and to manage exceptions through the ‘list’ and ‘actions’ arrays.

Type: Boolean: true, false
Versions: 6.0.4+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['http_referer']['weak'] = true;

import_max_records_total_limit

Specifies how many rows are allowed within import files. If the number of rows in an import file exceeds this number, the user will be alerted. If no number is entered, an unlimited number of rows are allowed.

Type: String: Number of max records
Versions: 6.3.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['import_max_records_total_limit'] = '';

jobs

Job Queue configurations.

Type: Array
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['jobs'] = array();

jobs.hard_lifetime

Hard deletes all jobs that are older than hard cutoff. Specified in days. Default is 21.

Type: Integer: Hard delete limit in days
Versions: 6.5.1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 21
Override Example:

$sugar_config['jobs']['hard_lifetime'] = 21;

jobs.max_retries

Maximum number of failures for job. Default is 5.

Type: Integer: Number of failures
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 5
Override Example:

$sugar_config['jobs']['max_retries'] = 5;

jobs.min_retry_interval

Minimal interval between job reruns. Specified in seconds. Default is 30.

Type: Integer: Interval between job reruns in seconds.
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 30
Override Example:

$sugar_config['jobs']['min_retry_interval'] = 30;

jobs.soft_lifetime

Soft deletes all jobs that are older than cutoff. Specified in days. Default is 21.

Type: Integer: Soft delete limit in days
Versions: 6.5.1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 7
Override Example:

$sugar_config['jobs']['soft_lifetime'] = 7;

jobs.timeout

Job running timeout. If running longer than the limit, the job is failed by force. Specified in seconds. Default is 86400 / 1 day.

Type: Integer: Timeout for job execution
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 86400
Override Example:

$sugar_config['jobs']['timeout'] = 86400;

lead_conv_activity_opt

Lead Conversion Options. Copy - Creates and relates copies of all of the Lead’s activities to new records that are selected by the user during conversion. Copies are created for each of the selected records. Move - Moves all of the Lead’s activities to a new record that is selected by the user during conversion. Do Nothing - Does nothing with the Lead’s activities during conversion. The activities remain related to the Lead only.

Type: String: ‘move’, ‘copy’, ‘donothing’
Versions: 6.3.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['lead_conv_activity_opt'] = 'donothing';

list_max_entries_per_page

Listview items per page.

Type: String: Number of max entries per page
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['list_max_entries_per_page'] = '20';

list_max_entries_per_subpanel

Subpanel items per page.

Type: String: Number of max entries per subpanel
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['list_max_entries_per_subpanel'] = '10';

lock_homepage

Prevent user customizable Homepage layout.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['lock_homepage'] = true;

lock_subpanels

Prevent user customizable subpanel layout.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['lock_subpanels'] = true;

log_memory_usage

Log memory usage.

Type: Boolean: true, false
Versions: 5.5.0RC4+
Editions: Pro, Ent, Corp, Ult, and CE
Override Example:

$sugar_config['log_memory_usage'] = true;

logger

An array that defines all of the logging settings.

Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['logger'] = array();

logger.default

Changes the logger engine used in SugarCRM.

Type: String: Name of custom logger
Versions: 6.0.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['logger']['default'] = 'FirePHP';

logger.level

Determines the logging level of the system. The recommended setting is ‘fatal’.

Type: String: ‘debug’, ‘info’, ‘warn’, ‘deprecated’, ‘error’, ‘fatal’, ‘security’, ‘off’
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: fatal
Override Example:

$sugar_config['logger']['level'] = 'fatal';

max_dashlets_homepage

Maximum number of Sugar Dashlets on Homepage.

Type: String: Number of max dashlets
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['max_dashlets_homepage'] = '15';

meeting_integration

Used to build a custom integration into the Meetings module. The value for this parameter must also match a module directory, file within that module directory, and a class name within that file. Based on the example, this means that the following directory exists ./modules/newIntegration/ with a newIntegration.php file contained in that directory that defines a newIntegration class.

Type: String: Custom meeting integration
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['meeting_integration'] = 'newIntegration';

moduleInstaller

Array that defines restrictions on module installations via the Module Loader utility.

Type: Array
Versions: 5.2.0j+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller'] = array();

moduleInstaller.blackList (deprecated)

Part of the moduleInstaller array. When packageScan is set to ‘true’, there is a predefined list of functions that are restricted by Sugar. The blackList parameter allows you to add additional functions to that restricted list.

Type: Array: Additional functions to restrict
Versions: 5.2.0j - 6.5.13
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['blackList'] = array('strlen', 'ini_set');

moduleInstaller.blackListExempt (deprecated)

Part of the moduleInstaller array. When packageScan is set to ‘true’, there is a predefined list of functions that are restricted by Sugar. The blackListExempt parameter allows you to remove functions from that list and thus pass the package scanning process.

Type: Array: Functions to allow
Versions: 5.2.0j - 6.5.13
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['blackListExempt'] = array('fopen', 'file_put_contents');

moduleInstaller.classBlackList (deprecated)

Part of the moduleInstaller array. When packageScan is set to ‘true’, there is a predefined list of classes that are restricted by Sugar. The classBlackList parameter allows you to add additional classes to that restricted list. The values of this array should be all lowercase.

Type: Array: Additional classes to restrict
Versions: 6.5.0RC1 - 6.5.13
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['moduleInstaller']['classBlackList'] = array('customclass1', 'customclass2');

moduleInstaller.classBlackListExempt (deprecated)

Part of the moduleInstaller array. When packageScan is set to ‘true’, there is a predefined list of classes that are restricted by Sugar. The classBlackListExempt parameter allows you to remove classes from that list and thus pass the package scanning process. The values of this array should be all lowercase.

Type: Array: Classes to allow
Versions: 6.5.0RC1 - 6.5.13
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['moduleInstaller']['classBlackListExempt'] = array('reflectionextension', 'reflectionfunction');

moduleInstaller.disableActions

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: Specific actions to restrict in module packages
Versions: 5.2.0j+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['disableActions'] = array('pre_execute', 'post_execute');

moduleInstaller.disableFileScan

Part of the moduleInstaller array. When packageScan is set to ‘true’, Sugar scans all files in an installable package to ensure that the file extensions are acceptable and the files do not contain blacklisted class or function calls. Setting the disableFileScan parameter to ‘true’ avoids this scan from occurring while still enforcing other parameters set.

Type: Boolean: true, false
Versions: 5.2.0j+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['disableFileScan'] = true;

moduleInstaller.disableRestrictedCopy

Part of the moduleInstaller array. When packageScan is set to ‘true’, Sugar will not install any packages that overwrite core source code files. Setting the disableRestrictedCopy parameter to ‘true’ will remove that restriction.

Type: Boolean: true, false
Versions: 5.2.0j+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['disableRestrictedCopy'] = true;

moduleInstaller.packageScan

Part of the moduleInstaller array. 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: true, false
Versions: 5.2.0j+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['packageScan'] = true;

moduleInstaller.validExt (deprecated)

Part of the moduleInstaller array. When packageScan is set to ‘true’, Sugar will not allow certain file extensions to be present in an installable package. Setting the validExt parameter allows you to define explicit extensions deemed safe to install on your instance of Sugar.

Type: Array: File extensions to allow
Versions: 5.2.0j - 6.5.13
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['moduleInstaller']['validExt'] = array('swf', 'log');

oc_converted

Only used in the Offline Client by the Sync process.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['oc_converted'] = false;

oc_password

Only used in the Offline Client.

Type: String: password of the offline user
Versions: 5.2.0+
Editions: Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['oc_password'] = 'Sugar12345';

oc_server_url

Used in Offline Client only to define the URL of the parent instance of Sugar for synchronization purposes. Same URL as sync_site_url but with a "/" at the end.

Type: String: Parent site URL with an "/" at the end
Versions: 5.2.0+
Editions: Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['oc_server_url'] = 'http://my.sugarinstance.com/';

oc_username

Only used in the Offline Client.

Type: String: userid of the offline user
Versions: 5.2.0+
Editions: Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['oc_username'] = 'Ethan';

oracle_enable_ci

Case insensitive search for Oracle. http://developers.sugarcrm.com/wordpress/2011/10/20/howto-enable-case-insensitive-searching-in-oracle/

Type: Boolean: true, false
Versions: 6.1.3+
Editions: Ent, and Ult
Override Example:

$sugar_config['oracle_enable_ci'] = true;

parent_site_url

Used in portal installations to define the URL of the parent Sugar instance that the portal communicates with via SOAP.

Type: String: URL of parent Sugar instance
Versions: 5.2.0+
Editions: Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['parent_site_url'] = 'http://my.sugarinstance.com';

passwordsetting.forgotpasswordON

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: Boolean: true, false
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: TRUE
Override Example:

$sugar_config['passwordsetting']['forgotpasswordON'] = '0';

passwordsetting.generatepasswordtmpl

Specifies the template to use when the system generated password is emailed. Set in UI via Admin->Password Management.

Type: String: GUID of template for system password generation
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: c2e49c27-d454-7ada-f03e-5092ada146c3
Override Example:

$sugar_config['passwordsetting']['generatepasswordtmpl'] = 'c758f609-4ef3-45b4-2f1f-5092ad59ec3d';

passwordsetting.systexpiration

Enables the System Generated Password feature. Set in the UI via Admin->Password Management.

Type: Boolean: true, false
Versions: 6.0.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: 1
Override Example:

$sugar_config['passwordsetting']['systexpiration'] = '0';

passwordsetting.systexpirationtime

Specifies the amount of time (depending on type) the System Generated Password expires. Set in the UI via Admin->Password Management.

Type: Integer: Number of Days, Weeks, Months
Versions: 6.0.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['passwordsetting']['systexpirationtime'] = '2';

passwordsetting.systexpirationtype

Specifies Days (1), Weeks (7) or Months (30). Used in conjunction with passwordsetting.systexpirationtime. Set in the UI via Admin ->Password Management.

Type: Integer: 1, 7, 30
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: 1
Override Example:

$sugar_config['passwordsetting']['systexpirationtype'] = '7';

quicksearch_querydelay

Number of seconds that Sugar will wait before searching for records in a quicksearch relate field. More info on this functionality can be found at http://support.sugarcrm.com/04_Find_Answers/02KB/02Administration/100Troubleshooting/Changing_the_Behavior_of_Quicksearch_Autofill_Fields

Type: Integer: Number of seconds
Versions: 6.1.3+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['quicksearch_querydelay'] = 1;

require_accounts

Determines whether an account is required for record creation within the system.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['require_accounts'] = false;

resource_management

An array that defines query limits and exceptions for non-admin users.

Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['resource_management'] = array();

resource_management.default_limit

Part of the resource_management array. Sugar allows non-admin users to be restricted to how many queries they can run per action. By default the limit for all modules is set to 1000 queries. This prevents user-initiated processes from taking up too many system resources. If an operation is performed by a user that attempts too many queries they will see a message returned saying: "Error: Query limit of 1000 reached for Leads module.". Setting the default_limit value to 0 will remove the query limit altogether for all modules.

Type: Integer: Number of queries
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['resource_management']['default_limit'] = 5000;

resource_management.special_query_limit

Part of the resource_management array. The maximum number of queries that can execute off a singular action by a non-admin user involving any module in the special_query_modules array. Can be disabled by setting a value of 0.

Type: Integer: Number of queries
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['resource_management']['special_query_limit'] = 100000;

resource_management.special_query_modules

Part of the resource_management array. Array of modules that are excepted from the standard default_limit of queries.

Type: Array of modules
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['resource_management']['special_query_modules'][] = 'Leads';

SAML_loginurl

Page that will replace the stock login page for SugarCRM.

Type: String: SAML URL for external authentication
Versions: 6.1.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['SAML_loginurl'] = 'https://siteurl.com';

SAML_X509Cert

SAML Certificate Key.

Type: String: SAML Certificate Key
Versions: 6.1.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['SAML_X509Cert'] = '-----BEGIN CERTIFICATE-----CERTIFICATE KEY-----END CERTIFICATE-----';

save_query

By default, list views in Sugar remember the last search performed by the current user in each module. While this can be convenient, it is sometimes unnecessary. If the last search performed in a module was an extensive search, the next time the user navigates to that module will inadvertently perform the search again. This can have a negative impact on performance in Sugar.

Type: String: ‘populate_only’, ‘all’, ‘no’
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['save_query'] = 'populate_only';

search_wildcard_char

Set the following values in the $sugar_config[’save_query’] value in the config_override.php file to configure different options for saving list view queries:

Type: String: Search symbol
Versions: 6.4.3+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['search_wildcard_char'] = '*';

search_wildcard_infront

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: true, false
Versions: 6.4.3+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['search_wildcard_infront'] = true;

session_dir

Directory on the server to store Sugar session data. If left undefined, PHP session settings will be inherited.

Type: String: Directory path
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['session_dir'] = '/tmp/SugarSession/';

show_download_tab

When selected, the Download tab will appear in the User settings and provide users with access to Sugar plug-ins and other available files.

Type: Boolean: true, false
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['show_download_tab'] = true;

showDetailData

Displays read-only ACL fields on EditViews as non-editable. Otherwise the field is hidden.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: TRUE
Override Example:

$sugar_config['showDetailData'] = false;

showThemePicker

Removes the theme selection drop down.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['showThemePicker'] = false;

site_url

Current URL of your Sugar instance. This value is critical in its accuracy for multiple points of functionality in the instance.

Type: String: Current URL of Sugar
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['site_url'] = 'http://my.sugarinstance.com';

slow_query_time_msec

Slow query time threshold.

Type: String: ‘Number’ (msec)
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['slow_query_time_msec'] = '100';

snip

Array used to define parameters specific to the Email Archiving feature.

Type: Array
Versions: 6.3.0RC1+
Editions: Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['snip'] = array();

snip.assign_ignore_email

When assign_ignore_email is set to false, the Email Archiving feature will scan through all email addresses of an incoming email and attempt to match it to a user in Sugar for assignment purposes. If this value is set to true, the email will not be assigned to any user and only be visible based off of role and team security.

Type: Boolean: true, false
Versions: 6.3.0RC1+
Editions: Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['snip']['assign_ignore_email'] = true;

stack_trace_errors

Displays stack trace of errors.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['stack_trace_errors'] = true;

studio_max_history

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: Number of files to keep
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['studio_max_history'] = 100;

subpanelTabs

When enabled, subpanelTabs groups subpanels on the detailview of each module into a tab structure that mimics the grouping defined under Admin > Configure Module Menu Filters

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['subpanelTabs'] = true;

sugar_version

Current version of Sugar that is running. This value should not be defined in config_override as it is updated in config on every upgrade of Sugar.

Type: String: Version number
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['sugar_version'] = '6.7.3';

sugarfeed_prune_interval

This value is used by the sceduler to create a query that will delete all records from the sugar_feeds table that are older than the number of days specified in this value. The default is 30.

Type: Integer: Number of Days in Interval
Versions: 6.5.16+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 30
Override Example:

$sugar_config['sugarfeed_prune_interval'] = 45;

sync_site_url

Used in Offline Client only to define the URL of the parent instance of Sugar for synchronization purposes.

Type: String: Parent site URL without an "/" at the end
Versions: 5.2.0+
Editions: Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['sync_site_url'] = 'http://my.sugarinstance.com';

time_formats

Available time formats and the display shown to end users in the user profile section. Used to select user’s preference for time display in Sugar.

Type: Array: Available time formats
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['time_formats']['H.i'] = '23.00';

tmp_dir

Path for temporary XML files used by charts, diagnosics, etc.

Type: String: Filesystem path
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: cache/xml/
Override Example:

$sugar_config['tmp_dir'] = 'cache/xml/';

tracker_max_display_length

Number of characters that will be shown per record in the "Last Viewed" section located under each module tab.

Type: Integer: Number of characters displayed
Versions: 6.0.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['tracker_max_display_length'] = 45;

unique_key

Unique identifier for the instance. This value is used in PHP caching and features such as Email Archiving. It is extremely important that this string is unique from any other instances deployed.

Type: String: Unique string for instance
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['unique_key'] = 'c0b5475f3f5b26ddb2976edc8865b5f6';

upload_badext

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: Extensions that cannot be uploaded as is
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['upload_badext'][] = 'swf';

upload_dir

Directory path where uploaded files are stored for note attachments, documents, and module loadable packages. By default, uploads are stored in the ./upload/ directory.

Type: String: Directory path
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: upload/
Override Example:

$sugar_config['upload_dir'] = 'upload/'

upload_maxsize

Maximum file size that users can upload into Sugar as attachments. When uploading files to Sugar, there are three file size limits to configure. The first two limits are your PHP upload_max_filesize and post_max_size which are configured in your php.ini. The second limit is the sugar configuration setting for upload_maxsize, which will restrict the upload limit from within Sugar. This setting can also be modified in the application via Admin > System Settings. The smallest of these three values will be honored when an oversized file has been uploaded.

Type: Integer: File size (in bytes)
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['upload_maxsize'] = 40000000;

use_common_ml_dir

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: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['use_common_ml_dir'] = true;

use_php_code_json

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: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['use_php_code_json'] = true;

use_real_names

Display users’ full names instead of their User Names in assignment fields.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['use_real_names'] = true;

use_sprites

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: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:

$sugar_config['use_sprites'] = false;

vcal_time

Use this setting to determine the number of months in advance of the current date that Free/Busy information for calls and meetings is published. To turn Free/Busy publishing off, enter "0". The minimum is 1 month; the maximum is 12 months.

Type: String: Number of months in advance
Versions: 5.2.0c+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['vcal_time'] = '';

verify_client_ip

Disables client IP verification. Eliminates the system checking to see if the user is accessing Sugar from the IP address of their last page load.

Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:

$sugar_config['verify_client_ip'] = false;

wl_list_max_entries_per_page

Displays X number of records shown per page on the listview of the mobile browser.

Type: Integer: Number of records to display
Versions: 5.2.0+
Editions: Pro, Ent, CE, Corp, and Ult
Override Example:

$sugar_config['wl_list_max_entries_per_page'] = 10;

wl_list_max_entries_per_subpanel

Displays X number of records shown in the subpanels on the detailview of the mobile browser.

Type: Integer: Number of records to display
Versions: 5.2.0+
Editions: Pro, Ent, CE, Corp, and Ult
Override Example:

$sugar_config['wl_list_max_entries_per_subpanel'] = 3;