In order to upgrade your Sugar application, you need to download the appropriate Upgrade zip file from the Sugar Website to your local machine. For Sugar Enterprise and Sugar Professional, you can obtain the Upgrade zip file from the Sugar Support Portal at https://www.sugarcrm.com/crm/support and upload it to your local machine. For Sugar Community Edition, you can upload the Upgrade zip file from the SugarCRM Web site to your local machine.
To use the Upgrade Wizard, you need to log into the Sugar application. To use the Silent Upgrader, you need to run a PHP script from the command line on the server where the Sugar instance is installed.
CAUTION: | It is strongly recommended that you run the upgrade process on a copy of your production system. |
If you are using Zend Core 2.0, you will need to increase the default value of the parameters listed below before you begin the upgrade process:
a. | Navigate to C:\Program Files\Zend\Core\etc\fastcgi.conf and increase the default value for ConnectionTimeout to 3000 and RequestTimeout to 6000. |
b. |
• | Backup your system before beginning the upgrade process. It is imperative to backup your current Sugar directory and database. |
a. | In the Advanced section of the System Settings page of your current Sugar installation, modify and save the value of Maximum upload size to 21000000 (20MB). |
b. | Navigate to the php.ini file on your Web Server and configure the parameters listed below as follows: |
• | Set post_max_size to more than 20MB. |
• | Set upload_max_filesize settings to more than 20MB. |
• | Set max_input_time to a large number. |
• | If you are using an Apache Web Server and if you have set LimitRequestBody in the httpd.conf file, then ensure that you set it to a large number or use the default value of 2GB. Restart Apache and then begin the upgrade process. |
• | Ensure that the Webserver user has Write permissions to the Sugar database. The upgrade to Sugar 5.2 will add and replace files in several locations including the sugar root directory. The Webserver user must have Write permissions for the root folder and all sub-directories during the upgrade process. |
• | The process of upgrading can take up to 30 minutes. If you are using the IIS Web server, you need to ensure that the CGI application does not time out. To do this, on IIS, set the CGI script timeout to more than 300 seconds, which is the default value. |
• | If you have customized any module’s PHP file, for example, accounts.php, we strongly recommend that you save it in the Customs directory and not within the main module. This is because, during upgrade, any customizations that you have made may be overridden by changes that Sugar has made for 5.2. |
• | Some entry points were changed in Sugar 5.1. Hence, unless you manually updated custom files that were created in 5.0 with the new entry points in 5.1, they may fail in 5.2 with the error message “Not a valid entry point”. |
For example, if you have customized vCard, navigate to custom\modules\\metadata\detailviewdefs.php and replace <name="vcard" action="vCard.php>"
<name="vcard" action="index.php">
The Upgrade Wizard provides a quick way to upgrade to the latest version of the Sugar application. The Upgrade Wizard includes critical upgrade logic as well as the SQL commands needed to upgrade the application.
Before using the Upgrade Wizard, ensure that the config.php file for your installation is writable.
Note: | Attempting to manually upgrade by simply replacing files and running the upgrade SQL is not supported. |
1. | Download the appropriate Sugar Upgrade zip file from the Sugar Website to your local machine. For example, to upgrade Sugar Professional from version 5.0 to 5.2, you need to download the SugarPro-Upgrade-5.0.0-to-5.2.0.zip. |
2. | Log into your existing Sugar application as the administrator and click admin on the right-hand corner of the page. |
3. |
The Upgrade Wizard screen displays on the page.
4. | Click Next. |
The System Checks screen displays on the page.
5. | Click Next. |
The Upload an Upgrade screen displays on the page.
6. | Click Browse, navigate to the location of the Upgrade zip file, and select it. |
The path to the file displays in the Upload an upgrade field.
7. |
Click Next.
The Preflight Check screen displays on the page.
By default, the Upgrade Wizard Runs SQL option is selected as the database update method. If you ran the SQL queries manually, select Manual SQL Queries from the Database Update Method drop-down list and select the Check when SQL has been manually run box.
8. | Click Next. |
The Commit Upgrade screen displays on the page.
Optionally, you can click Show to see a list of files that were copied and the rebuild results.
9. | Click Next. |
The Debrief screen confirms that the upgrade has been installed.
10. | Click Done. |
11. | In the Systems panel of the Administration Home page, click Repair and select the Rebuild Relationship and Rebuild Extensions options to perform these actions. For more information, see the Installation and Administration Guide that is appropriate to your Sugar application. |
12. | If you unchecked any files to prevent the Upgrade Wizard from overwriting then manually merge the files by extracting the skipped file from the patch zip file. Merge the file that was installed in the Sugar application directory. |
Note: | If your attempt to upgrade Sugar is unsuccessful, check the upgradeWizard.log file in the Sugar folder for information. |
The Silent Upgrader enables you to avoid some of the limitations that the Web application environment may have that prevents the Upgrade Wizard from completing the upgrade. The upload size limit (by PHP and sometimes even by Web server), the CGI (or equivalent) timeout limit, and the MySQL (or equivalent) session timeout limit are some of the challenges people run into when upgrading to Sugar 5.2. The Silent Upgrader either avoids the limitations or better controls the settings in its stand-alone execution environment.
Note: | The silentUpgrade.php script creates new files for the user who is running it. For example, for the root user it create files as user/group root. Because Apache cannot read this, you must ensure that the Web server user has the permissions to read and write the script. |
1. | From the command line on the server where the Sugar instance is installed, execute the silentupgrade.php script as follows: |
upgradeZipFile is the full path to the upgrade zip file. For example, SugarCE-Upgrade-5.1.0-to-5.2.0.zip
logFile is the full path to an alternate log file.
pathToSugarInstance is the full path to the instance being upgraded.
adminUser is a valid admin user name.
Note: | After upgrading to Sugar 5.2.0, you will need to rebuild the relationship metadata. To do this, log into Sugar as the administrator. On the Administration Home page, select the Repair option in the Systems sub-panel and click Rebuild Relationships. |
If you are managing multiple instances of the Sugar application and you want to maintain complete control over the Sugar instances, you can lock down the Upgrade Wizard to ensure that no user with administrative privileges can upgrade any of them. To lock down functions on the Administration page
1. | Navigate to the config.php file in the Sugar root directory. |
2. | Set the following parameter to true as below: |
3. |
1 comment:
Thanks for sharing such great information. It's helped me to install sugarCRM.
Post a Comment