Sugar Community Edition Installation and Administration Guide Version 5.0

System

The options listed under this section allow you to configure system-wide settings that apply to all users in your organization. However, users can override some default settings, such as the default date format, by specifying different settings in their My Accounts page.

System Settings

Use this option to configure the system-wide settings according to your organization’s specifications. Users can override some default settings, such as the date format, on their My Accounts page

User Interface

Use this sub-panel to configure the user interface.

1.	Configure the following fields:

Listview items per page. Enter the maximum number of records you want displayed in the list view. The system paginates lists that contain more than the specified number of records.

Display server response times. By default, the footer on every page displays the time taken to respond when users attempt to perform an action, such as logging in or opening an item, in Sugar. Deselect this box if you do not want to display the response time.

Prevent user customizable Homepage layout. Select this box if you want to prevent users from customizing their Home page layout.

Maximum number of Dashlets on Homepage. Enter the maximum number of dashlets you want displayed on the Home page. Users will not be able to add more than the number of dashlets that you specify. The default value is 10.

Subpanel items per page. Enter the maximum number of records you want displayed in the list view. The system paginates lists that contain more than the specified number of records.

Display tabs on login screen. By default, the Login page displays the Sugar module tabs on the Login page. Deselect this box if you do not want to display these tabs on the Login page.

Prevent user customizable subpanel layout. Select this box if you want to prevent users from customizing their detail page layout.

Show Full Name (not Login). Select this box if you want the full name for users displayed instead of their login names.

2.	To save the settings, click Save.

3.	To restore the default settings, click Restore; to exit the page without saving your changes, click Cancel.

Logos

You can upload your organization’s logo to display in the Sugar User Interface .

To upload logos

1.	Configure any of the following fields:

Current logo in use. Displays your current organization’s logo that displays in the User Interface.

Upload new logo (212x40). Enter the path to the location of the logo that you want to upload from your local machine. Or, click Browse to navigate to the location of the logo on your local machine. The dimension should be 212 X 40, with the standard transparent background color, in PNG format.

2.	To save the settings, click Save.

3.	To restore the previous settings, click Restore; to exit the System Settings page without saving your changes, click Cancel.

LDAP and Active Directory Authentication Support

If your organization has implemented LDAP or Active Directory authentication, you can also enable authentication in Sugar. When your users attempt to log into Sugar, the application authenticates them against your LDAP directory or Active Directory. If authentication is successful, the user is allowed to log into Sugar. If you are using LDAP with SOAP, you will need to specify the encryption key for the system and forward the key to your users.

If your users are using the Sugar Plug-in for Microsoft Outlook, they will need to enter this key number in Outlook. The Sugar Plug-in for Microsoft Outlook uses this key to encrypt user passwords before forwarding them to Sugar for authentication. Sugar decrypts the password with the same key and forwards the user names and passwords to the LDAP server for authentication. If authentication is successful, the users are allowed to access Sugar through the Sugar Plug-in for Microsoft Outlook.

To enable authentication

1.	In the LDAP Authentication Support sub-panel, select the Enable LDAP box and enter the following information:

Server. Enter the LDAP server name.

Port Number. Enter the server’s port number.

Base DN. Enter the base DN name.

Bind Attribute. Enter the attribute name that is used to bind the user’s name in LDAP.

Login attribute. Enter the attribute name that is used to search for the user in LDAP.

Authenticated User. Enter the user name.

Authenticated Password. Enter the user’s password.

Auto Create Users. Select this option check the Sugar database for the user name and add it if it does not exist in the database.

Encryption Key. If you are using LDAP with SOAP, enter the encryption key to encrypt user passwords in the Sugar Plug-in for Microsoft Outlook.

2.	To save the settings, click Save.

3.	To restore the previous settings, click Restore.

4.	To exit the System Settings page without saving your changes, click Cancel.

Proxy Settings

If you are using a proxy server to connect to the Internet, you will need to enter the information here to allow the system to check for Sugar updates.

1.	Configure the following fields:

Use proxy server. If you want to connect to the Internet through a proxy server, select this option.

The system displays fields to specify the proxy host and port number.

Proxy Host. Enter the name of the proxy server host

Port. Enter the port number for the proxy host.

Authentication. Select this box if you want to enable proxy authentication to allow Sugar to connect to the company’s proxy server.

User Name. Enter the user name.

Password. Enter a password for the user.

2.	To save the settings, click Save.

3.	To restore the previous settings, click Restore.

4.	To exit the System Settings page without saving your changes, click Cancel.

Customer Self-Service Portal

Select this option to integrate your organization’s self-service portal with Sugar. This enables your customers to access your Sugar records such as Notes and Cases.

1.	Select the Enable self-service portal integration box.

2.	To save the setting, click Save.

3.	To restore the previous setting, click Restore.

4.	To exit the System Settings page without saving your changes, click Cancel.

SkypeOut

Select this option to allow users to make calls through Skype.

To enable Skype

1.	Select the Enable SkypeOut integration box.

2.	To save the setting, click Save.

3.	To restore the previous setting, click Restore.

4.	To exit the System Settings page without saving your changes, click Cancel.

Mail Merge

If you have installed the Sugar Plug-in for Microsoft Word, this option allows you to perform a mail merge with Word documents. For example, you can merge contact information from Sugar with form letters created in Microsoft Word.

1.	Select the Enable mail merge box.

2.	To save the setting, click Save.

3.	To restore the previous setting, click Restore.

4.	To exit the System Settings page without saving your changes, click Cancel.

Export

Use this panel to specify export settings such as the delimiter used to separate data in export files and the default character set used to export data from Sugar. The settings you specify here apply to all users in the organization. However, users can define a different default export character set on their My Account page to export data from Sugar.

This character encoding is also used when importing data into Sugar.

By default, Sugar uses UTF-8 to store data and CP1252 to export data. For locales that use character encoding other than CP1252, you must specify the appropriate default character set. This ensures that the character set used by the Sugar system to create the exported file is mapped to the correct character set on the user’s machine. For example, MS Windows uses SJIS in Japan. So, for users in this locale, you will need to select SJIS as the default export character set.

By default, both users and administrators can export files from Sugar. However, you can prevent users from exporting files.

To export files

1.	Set the following options:

Delimiter. Specify the delimiter, such as a comma or a period, to use while exporting data.

Default Export Character Set. The default is CP 1252. For locales other than US and Western Europe, select the appropriate character set from the drop-down list.

Disable export. Select this option if you want to prevent users and administrators from exporting data export.

Admin export only. Select this option if you want to allow only administrators to export data.

2.	To save the settings, click Save.

3.	To restore the previous settings, click Restore; to exit the System Settings page without saving your changes, click Cancel.

Advanced

1.	Select any of the following advanced configuration options:

Validate user IP address: Select this option to validate, for security purposes, the IP addresses of users who log into Sugar.

Log slow queries. Select this option to log the system’s slow responses to user queries in the sugarcrm.log file. This information is for performance tuning investigation.

Maximum upload size. Enter the maximum file size, in KB, that users are allowed to upload.

Note:

The upload size is also dependent on PHP’s upload settings.

Portal Session Timeout. Enter the maximum time, in seconds, for a SugarPortal session. The session will timeout when the time limit is reached.

Log memory usage. Select this option to record memory usage in the sugarcrm.log file.

Slow query time threshold. Specify the threshold, in milliseconds, that defines slow queries. Queries that take longer than the threshold time are logged in the sugarcrm.log file. This information is for performance-tuning investigation.

Display stack trace of errors. When you select this option, if an error occurs when users are running the application, the system displays where the error occurred in the application’s stack trace. This information is for debugging purposes.

Developer Mode. Select this option to disable caching so that you can immediately view changes made to language, vardefs, and template files.

2.	To save the settings, click Save.

3.	To restore the previous settings, click Restore; to exit the System Settings page without saving your changes, click Cancel.

Scheduler

Use this option to schedule jobs such as dispatching campaign emails.

The Scheduler integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems. You can schedule the following types of jobs:

Check Inbound Mail Accounts. This job monitors inbound emails in active mail accounts that you set up using the Inbound Email option in the Email panel of the Admin page.

Run Nightly Process Bounced Campaign Emails. This job polls any mail account in which, the “Possible Actions” parameter is set to “Bounce Handling”. This is an essential component of monitoring mass email campaigns.

Run Nightly Mass Email Campaigns. This job processes the outbound email queue for your organization’s mass campaign Emails.

Prune Database on 1st of Month. This job reads all the tables in your Sugar database, finds records that have been soft-deleted (deleted = 1), creates a large SQL file, and physically deletes those records on the 1st of every month. It is mostly a performance job, and is not essential to the use of Sugar. The backup files are placed in cache/backups with time-stamped filenames.

Configuring Settings for Scheduler Jobs

For UNIX and Linux systems, you will need to add a new cronjob to your Crontab. For Microsoft Windows, you can use the Task Scheduler.

Unix and Linux Systems

To add a new cronjob to your crontab

1.	At the command prompt, type crontab -e.

2.	Enter the following line to your crontab:

* * * * * cd /path/to/sugar/crm; php -f cron.php > /dev/null 2>&1

3.	Ensure that the /path/to/ is correct for your instance.

4.	Save your changes and close.

If you encounter problems, do the following:

1.	Determine who the Apache server runs as.

In a properly configured virtual host environment provided by your host, Apache will run as your Login user ID for files in your virtual directory. If you are unsure, contact the Customer Service department for your host.

a.	Search for a file named httpd.conf. Typically, this file is located in the /etc folder. It will vary with the distribution.

b.	Open the file using a text editor and locate a line that starts with “User”. The word(s) that follow it directly is the name of the User that Apache will run as on your system.

2.	Determine the capabilities of your PHP installation.

The Sugar Scheduler is designed to work with PHP and its extensions; specifically the database connector, the IMAP libraries, and the cURL libraries.

Ensure that the PHP binary (php-cli or just php) is available and has those libraries available.

Search for the PHP binary as follows:

a.	Type which php. On most correctly configured PHP installations, you will find the binary in /usr/bin or /usr/local/bin. If so, move on to Step 3.

Or

b.	Type find / -name php. Typically, this command will return a long list. Parse through the list to find an executable file named php.

c.	If you cannot find the PHP binary, scroll down to the Troubleshooting Tips at the end of this section and read item No. 2.

3.	Create a cronjob for the Apache user

a.	Type crontab -e -u [the Apache user].

b.	Enter the following line to your crontab:

* * * * * cd /path/to/sugar/crm; php -f cron.php > /dev/null 2&>1

c.	To fine tune this job, change the first two “*”. The first is the “Minutes” value, the second is the “Hours” value.

For example, to run the cronjob every 3 minutes, enter:

"*/3 * * * * cd /path/to/sugar/crm; php -f cron.php > /dev/null 2&>1

4.	Test the crontab line as follows to confirm that your system is ready to run:

a.	At a terminal prompt, copy and paste the command for your cronjob, and run it; the logic here is that if the command will execute successfully when run manually, the crontab will be able to execute successfully as well.

b.	If your cronjob looks as follows:

* * * * * cd /var/www/html/sugarcrm; php -f cron.php > /dev/null 2&>1

type the command from "cd.." to "2&>1" into a terminal and press Enter.

c.	If any errors occur, refer to “Troubleshooting Tips” on page 35.

5.	Save your changes and close.

Microsoft Windows (2000, XP, Server) Systems

Set up the Windows batch file as follows:

1.	Create a batch file that will execute all the necessary commands.

2.	Enter the following paths in the batch file:

•	cd c:\path\to\your\sugarinstance

This folder should contain the cron.php file.

•	c:\path\to\your\php.exe -c c:\windows\php.ini -f cron.php

3.	Run the batch file from a command prompt to ensure that the output has no errors.

4.	If you encounter problems, do the following:

a.	Determine which PHP binary to use based on your PHP version.

PHP 4.x

If your system has a 4.x version of PHP, the PHP-CGI binary is named php.exe and is typically located in the root folder of your PHP install folder. To allow it to interact with the dynamic libraries, specify the location of the php.ini file. This can vary from system to system. If you are unsure, assuming that php.exe is located in c:\php, enter the following command at the command prompt:

c:\php\php.exe -r phpinfo();

The system will identify the php.ini file and its location.

PHP 5.x

If your system has a 5.x version of PHP, the PHP-CGI binary is named php-cgi.exe (not php-cli.exe) and is typically located in the root folder of your PHP install folder. To allow it to interact with the dynamic libraries, specify the location of the php.ini file. This can vary from system to system. If you are unsure, enter the command described above.

The system will identify the php.ini file and its location.

5.	Create the batch file.

a.	Click Scheduler in the Systems panel of the Admin page.

At the bottom of the default screen, you will see the contents of the commands you need to add to a batch file.

b.	Open notepad.exe, copy and paste what Sugar’s recommendation into a blank file.

c.	Change the Save As Type to "dropdown to All Files *.*. " and save it as a .bat file.

Note:

This is only a recommendation. It may not work for your particular instance. Check the folder paths because they are often the cause for problems with the Scheduler.

6.	Test the batch file.

a.	From the command prompt, navigate to the folder where you saved the batch file.

b.	Enter the full name of the batch file to execute it.

c.	Note and correct any reported errors, usually related to paths that cannot be found.

7.	Create a scheduled task.

a.	Click Start and navigate to Control Panel/Scheduled Tasks/Add Scheduled Task.

b.	Go through the Wizard, browse to the batch file you just created, and select it.

c.	Schedule a daily job, and ensure that you select Open advanced properties for this task when I click finish.

d.	On the Advanced Properties page, navigate to the Schedule tab and then click Advanced.

e.	Check off Repeat task to enable the fields below it, and select Every Minute or specify the interval you think is appropriate.

8.	Save your changes and close the Wizard.

To schedule a job

1.	In the Shortcuts menu of the Scheduler home page, click Create Scheduler.

2.	In the Basic Setup sub-panel, enter the following information:

Job Name. Enter a name for the job.

Status. From the drop-down list, select Active to run the job at the specified intervals; select Inactive if you only want to save the job schedule information but not run the job.

Job. Select a job from the drop-down list. The OR field is not used.

Interval. Specify the time interval to check for new scheduled jobs.

The default is every one minute daily.

3.	For advanced options, click the Advanced Options link below the Job field.

The Advanced Options sub-panel displays below.

4.	Enter information for the following fields:

Execute If Missed. Select this box to run any jobs that the scheduler missed.

Date & Time Start. Click the Calendar icon and select the start date for the job; select the time, in hours and minutes, from the adjacent drop-down list.

Date & Time End. Click the Calendar icon and select the end date for the job; select the time, in hours and minutes, from the adjacent drop-down list.

Active From. From the drop-down list, select the time, in hours and minutes, when the job becomes active.

Active To. From the drop-down list, select the time, in hours and minutes, when the job becomes inactive.

5.	Click Save to create the job; click Cancel to exit the page without creating the job.

To manage scheduled jobs

1.	In the System sub-panel of the Admin page, click Scheduler.

The Schedule List page displays on the page.

2.	Select any job from the job list to view its settings or the Job log. You can edit, duplicate, or delete the settings. You can also delete a job by clicking the del icon corresponding to the job in the Schedule list.

3.	To edit the settings, click Edit.

4.	Make the necessary changes and click Save to update the settings; click Cancel to exit the page without saving your changes.

Troubleshooting Tips

Linux

1.	The Sugar Scheduler fails to run even though the cron.log file shows that the crontab is triggering the new job.

•	The Apache user's PATH does not include the location of the PHP binary.

•	Change the crontab entry to include the FULL path to the PHP binary as shown below:

* * * * * /usr/local/bin/php -f cron.php > /dev/null 2&>1

•	The Apache user's PATH does not include the location of the php.ini file, and thus the external libraries (such as mod_mysql and mod_imap) are unavailable at run time.

•	Change the crontab entry to include a PHP switch to explicitly define a php.ini to use as shown below.

* * * * * php -c /path/to/your/php.ini -f cron.php > /dev/null 2&>1"

2.	No PHP binary found or it is broken.

•	Change the mechanism by which your cronjob calls Sugar's cron.php.

•	Determine if this is an option at this time by finding either “curl” or “wget” on your system. This is done with the commands “which curl” and “which wget”.

If you use cURL, your crontab entry should look as follows:

* * * * * curl --silent http://yourdomain/yoursugarcrminstance/cron.php

If you use wget, your crontab entry should look like:

* * * * * wget -q http://yourdomain/yoursugarcrminstance/cron.php

Note:

Both curl and wget have numerous switches that do not always map to different versions on different platforms. Experiment in the terminal until you find the “perfect” line, and add it as the line for your crontab entry.

Windows

 

1.

The most common problem is that the PHP binary does not have the proper libraries available at run time. As a result, it cannot make calls to your database or to your email server. To force PHP to be aware of these libraries, it needs to access the php.ini file, which in turn tells it where to find everything that is available.

a.	Locate the php.ini file: if you are unsure, run the following command:

phpinfo();

The system identifies the php.ini file and its location.

2.	The second most common breakage is incorrect paths to the extensions that PHP needs; a map is useless if the information is bad.

a.	Open php.ini in your favorite text editor.

b.	Find the section named “Paths and Directories”.

c.	The pertinent entry is “extension_dir”.

d.	Keeping in mind that this file piggybacks on Window's $PATH$ variable, double-check the paths listed.

e.	Correct any errors - sometimes giving an absolute path solves hard-to-diagnose problems, for example, full path listing from c:\... onwards.

Necessary extensions are disabled.

f.	Open your php.ini file in a text editor.

g.	Find the section named “Dynamic Extensions”.

h.	Scroll to the Windows-specific list.

i.	Make sure that the necessary extensions are uncommented (no “;” preceding the line). The bare minimum for Sugar Scheduler to run is to have php_curl, your database connector, typically php_mysql (for PHP5), and php_imap.

j.	Test the batch file again.

Diagnostic Tool

Use this option to capture system configuration for diagnostics and analysis. The diagnostic tool pulls up system information and stores it in a zip file on the server for download. When you send a help request to Customer Support, you can attach the file because it summarizes all the basic information required to resolve the problem.

To capture system configuration

1.	On the Diagnostic Tool page, click Execute Diagnostic to run the tool.

2.	To capture specific configuration information, click the Advanced link below the Execute Diagnostic button.

The system displays a list of system configuration files. By default, the system captures configuration information for all the selected files.

The system performs the following actions of these files:

SugarCRM Config.php - Copies the config.php file from the root directory after replacing the DB password with asterisk for security purposes.

SugarCRM Custom directory - Copies the custom directory to a Zip file to enable Customer Support to know what has been customized through the Layout Editor.

phpinfo() - Executes phpinfo and stores it in a file.

MySQL - Configuration Table Dumps - copies a few tables from the database and replaces sensitive information with asterisk for security purposes.

MySQL - All Tables Schema - writes the schema for all tables to an HTML file.

MySQL - General Information - Pulls up some general information, like MySQL version, character sets, etc.

MD5 info - Runs md5 checks on all files in the sugar directory and compares it against a stock Sugar installation’s md5s. This enables Customer Support to learn which, if any, files have been manually customized.

BeanList/BeanFiles files exist - If a custom module has been loaded, and the author did not define these references correctly, it can cause problems. This action checks all the references to ensure they are correct.

SugarCRM Log file - copies the log file.

Sugar schema output (VARDEFS) - copies the Sugar database schema.

3.	Deselect the ones you do not want to view and then click Execute Diagnostic.

The system creates a Zip file that contains the captured configuration information.

4.	To view the file, click the Download the Diagnostic file link at the bottom of the page; to delete the file, click the Delete the Diagnostic file link.

5.	If you choose to download the file, the File Download dialog box displays on the page. To view its contents, click Open, and click the file you want to view. To save the Zip file contents, click Save, and select a location on your local machine.

Upgrade Wizard

The Upgrade Wizard provides a quick way to upload and install new Sugar versions as well as upgrade existing ones.

Note:

Before using the Upgrade Wizard, ensure that the config.php file for your installation is writable.

The Sugar 5.0 database schema has significant changes that may impact existing code customizations when you upgrade the application. These schema changes are described below. Your options to handle existing code customizations are also described later in this section.

Schema Modifications

Sugar version 5.0 has implemented schema changes to ensure consistency, unifying several data types such as the Boolean and Date/Time data types. Additionally, new email functionality has necessitated significant schema changes. These changes may impact existing code customizations during the upgrade process.

Schema changes are as follows:

•	The Email address has been refactored in version 5.0 to remove email addresses within major modules and introduce a separate email table linked back to major modules. This provides for unlimited email addresses rather than a fixed set. The following modules are affected by this change:

Accounts

Contacts

Leads

Targets

•	The following tables are impacted by the unifying of date-time data types:

calls

email_marketing

meetings

project_task

tasks

•	The following tables are impacted by the Boolean data type change:

project_task

tasks

Code Customizations

During the upgrade process, Sugar automatically converts all customizations implemented through Studio and upgrades the schema. The Upgrade Wizard archives your code customizations in the modules/<CustomModules>/.pre_500 directory where CustomModules is the name of your customized module folder.

After completing the upgrade, it is recommended that you re-implement your code customizations in version 5.0. However, to ease the transition from version 4.5.1 to version 5.0, Sugar provides a compatibility mode. Initially, you can use the compatibility mode to run version 4.5.1-implemented code customizations in version 5.0 until you can re-implement the code customizations in 5.0.

You need not handle all customized modules in the same manner. You can run some modules in compatibility mode and re-implement others in Sugar 5.0.

Running a module in compatibility mode has the following limitations:

•	You cannot edit the module using Studio in version 5.0.

•	The 5.0 schema modifications will need to be addressed even for code running under compatibility mode.

•	SugarCRM Inc. will not provide patches to modules running in compatibility mode.

•	SugarCRM Inc. will not support the compatibility mode indefinitely.

To run customized modules in compatibility mode

1.	Move the files currently residing in the custom module directory into the .500 directory. This is a new directory that is created during the upgrade to archive the base 5.0 version for safekeeping.

When you apply subsequent Sugar patches to 5.x code, the Upgrade Wizard will detect the existence of this archive folder and apply the patch accordingly, thus maintaining the integrity of the 5.x version of your module running in compatibility mode.

2.	Copy your customization files from the .pre_500 directory to the custom module directory.

3.	Adjust your code as required to account for the 5.0 schema modifications.

Upgrading Sugar

You need the appropriate Upgrade zip file to upgrading your Sugar application. For more information, see the Sugar Upgrade Guide.

Locale Settings

Use this option to set system-wide default formats for date, time, language, name, and currency. If you are using MySQL, you can also specify the collation order for records in the application.

User Interface

Default Date Format. From the drop-down list, select a date format for all records. Users can override the default format by setting a different date format in their My Account page.

Default Time Format. From the drop-down list, select a time format to display in all records such as Cases. Users can override the default format by setting a different time format in their My Account page.

Default Language. From the drop-down list, select the default language for the Sugar User Interface. Users can select a different language from the login page, provided they have installed the appropriate language pack.

Default Name Format. Enter the default salutation and name format to display in list views and detail views. You can specify any combination of salutation first name, and last name. For example: Mr. John Smith, Mr. Smith, or John Smith. Users can override the default format by setting a different time format in their My Account page.

To save the settings, click Save.

To restore the previous settings, click Restore; to exit the System Settings page without saving your changes, click Cancel.

Default Currency

Select this option if you want to override the default currency that you set during installation. Users can override the default currency that you specify on their My Account page.

Currency. Enter the name of the currency that your organization uses to conduct business.

Currency symbol. Enter the symbol for the currency.

ISO 4217 Currency Code. Enter the ISO code for the currency.

1000s Separator. Specify a delimiter to separate thousands when users specify a numeric value for the amount.

Decimal Symbol. Specify a default decimal symbol.

Database Collation

This sub-panel displays only if you are using the MYSQL database. You can select the desired collation order from the drop-down list. The default is utf8_general_ci.

To save the settings, click Save; to exit the page without saving your changes, click Cancel.

Backups

Use this option to backup the Sugar configuration files. Note that this option does not backup the database.

To backup Sugar configuration files

1.	Click the Backups option in the System sub-panel on the Admin page.

2.	In the Directory field, specify a directory that is writable by the same user as the Apache process.

3.	In the Filename field, enter a file name for the Zip file including the .zip extension.

4.	To ensure that backup can be performed, click Confirm Settings.

5.	Click Run Backup to create the .zip file of your Sugar application files.

Note:

To backup your database information, refer to your database vendor's documentation.

Repair

Use this option to upgrade and rebuild data from a previous version of Sugar for the current version of the program. You also use this option to convert a Sugar installation to offline mode.

The upgrade options include:

Upgrade Teams: Scans all users to ensure that they each have a private team, and that they are members of the global team, automatically fixing any discrepancies after an upgrade. It may also be useful to restore private teams if they become corrupted or are removed for any reason.

Quick Repair and Rebuild: Repairs and rebuilds the database, extensions, vardefs, dashlets etc., for selected modules.

Repair Database: This option is applicable to MYSQL databases only. It repairs your Sugar database based on values defined in the vardefs. You can choose to display the SQL that will be executed on the screen, export it, or execute it.

Expand Column Width. For MSSQL, expands certain char, varchar and text columns in database.

Clear Chart Data Cache: Removes cached data files that charts use.

Clear Template Data Cache: Removes cached template files.

Clear Vardefs Data Cache: Removes vardefs from the cache.

Rebuild .htaccess file: Rebuilds the .htaccess file to limit access to certain files directly.

Rebuild Audit: Rebuilds the audit table.

Rebuild Config File: Rebuilds the config.php file by updating the version and adding defaults when not explicitly declared.

Rebuild Extensions: Rebuilds extensions including extended vardefs, language packs, menus, and administration

Rebuild Relationships: Rebuilds relationship metadata and drops the cache file.

Rebuild Schedulers: Rebuilds your out-of-the-box Scheduler Jobs.

Rebuild Dashlets: Rebuilds the Dashlets cache file.

Rebuild Javascript Languages: Rebuilds Javascript versions of language files.

Rebuild JS Compressed Files: Copies original Full JS Source files and replaces existing compressed JS files.

Rebuild JS Grouping Files: Re-concatenates and overwrites existing group files with latest versions of group files.

Rebuild Minified JS Files: Copies original Full JS Source Files and minifies them, then replaces existing compressed files.

Repair JS Files: Compresses Existing JS files - includes any changes made, but does not overwrite original JS Source files

Repair Roles: Repairs roles by adding all new modules that support access control as well as any new access controls to existing modules.

Repair Indexes: Validates and, optionally, repairs database indexes against definitions in vardef files.

Repair Inbound Email Accounts: Repairs Inbound Email accounts and encrypts account passwords.

Remove XSS: Removes XSS Vulnerabilities from the database.

Repair Activities: Repairs Activities (Calls, Meetings) end dates.

Check Reports: Checks whether reports are still valid after an upgrade and lists any invalid reports that are found during the check.

Currencies

Use this option to specify a default currency and the rate.

For each new currency that you define, enter the name, symbol (for example, $), conversion rate to the US $, and the currency code (such as CDN for the Canadian dollar). Note that each user can select his default currency in the User Management screen.

Note:

To display the Euro symbol in charts, you will need to install Macromedia Flash8.

Module Loader

Use the Module Loader to install Sugar modules, custom modules, upgrades, language packs, dashlets, and themes from Sugar Exchange.

You can install a module directly from Sugar Exchange to your Sugar application. You can also upload a module from Sugar Exchange to your local machine and then upload it from your local machine to your Sugar application at a later date. When you install a module directly from Sugar Exchange, you can check for the latest version.

You create custom modules in the Module Builder. A custom module is contained within a package. You save packages as a zip file on your local machine and then use the Module Loader to upload them into Sugar. For more information on creating packages, see “Module Builder” on page 65.

You can also use the Module Loader to uninstall packages that you deleted in the Module Builder.

To install a module from Sugar Exchange

1.	On the System sub-panel of the Administration Home page, click Module Loader.

The Module Loader Home page displays on the screen.

If you need to register with SugarCRM, Inc. to obtain a user name and password to log into the system, click the Create an account link. If you have already registered but do not remember your password, click the Forgotten your password? link to receive a new password.

2.	Enter your user name and password, accept the license agreement, and click Login.

If the login is successful, the system displays Sugar packages and extensions that are available for download.

3.	Click the Plus sign (+) next to Modules.

The available modules and updates display below

4.	Select the module that you want to install.

5.	Click Download Selected and click OK to confirm your decision.

The downloaded module display below.

6.	To install the module, click Install; to remove the module, click Uninstall.

To install a module from your local machine

1.	Select the Install From Local File tab.

2.	In the Upload a module field, enter the path to the module or click Browse to navigate to the location of the module’s .zip file.

3.	Click Upload.

The uploaded module displays on the Install from Sugar Exchange tab.

4.	Click Install to unzip the module file.

The Module Loader unzips the Module file and displays a message stating that the module is ready to be installed.

5.	Click Commit to install the module.

If the installation is successful, the system displays a message stating that the module installed successfully.

6.	To go back to the Module Loader page, click Back to the Module Loader.

The new module is listed on the page.

To uninstall a module

1.	To uninstall the module, click Delete Package.

The system displays a message stating that the module is ready to be uninstalled

2.	Click Commit to uninstall the module.

The module is removed from Sugar.