The Upgrade Wizard provides a quick way to upgrade to the latest version of the SuiteCRM application. It includes critical upgrade logic as well as the SQL commands needed to upgrade the application. Ensure that the config.php file for your installation, located in the SuiteCRM root directory, is writable, before using the Upgrade Wizard. Note: Manual upgrades by file replacements and running the upgrade SQL are not supported.
Download the appropriate SuiteCRM Upgrade zip file from the SuiteCRM website to your local machine. For example, download the SuiteCRMPro-Upgrade-6.4.x-to-6.5.0.zipfile to upgrade SuiteCRM Professional from version 6.4.x to 6.5.0. Download the appropriate conversion file to convert to SuiteCRM Professional or SuiteCRM Enterprise.
Log into your existing SuiteCRM application as the administrator and click admin on the right-hand corner of the page.
Click Upgrade Wizard in the Systems panel of the Administration Home page.
This displays the Upgrade Wizard page.
This displays the System Checks page. SuiteCRM begins the system check process. The Systems Check page indicates that there were no issues if the system check process completes successfully. Issues with file permissions, database, and server settings are listed on the page if the system check process encountered any problems.
Click Next if the system check is successful.
This displays the Upload an Upgrade page.
Click Browse, and navigate to the location of the upgrade zip file and select it.
The path to the file displays in the Upload an Upgrade field.
Click Upload Upgrade to upload the package to the SuiteCRM application.
The system uploads the package and displays it on the page. Use the Delete Package button to remove the package if necessary.
This displays the Preflight Check page.
Click Show Schema Change Script to view differences in the SuiteCRM databases schema between your current and new SuiteCRM versions.
By default, the Upgrade Wizard Runs SQL option is selected as the database update method. Select Manual SQL Queries from the Database Update Method drop-down list and select the Check when SQL has been manually run box, if you ran the SQL queries manually.
Click Recheck to rerun Preflight Check. Click Next to skip this step.
This displays the Commit Upgrade page.
You can also click Show to see a list of files that were copied and the rebuilt results. You can also view skipped queries.
During the upgrade process, SuiteCRM performs a three-way merge between the customized instance on old version, default instance on old version, and default instance on new version. This three-way merge adds any fields that have been added to the default module layouts in the new version to the corresponding module layouts in the existing version, if the module layouts in the old version were not customized through Studio (or in the appropriate upgrade-safe way) prior to the upgrade. The three-way merge also changes the placement of fields in non-Studio-customized module layouts to match the placement in the default module layouts.
SuiteCRM displays the Confirm Layouts page as Step 5 of the upgrade process if the existing module layouts have been customized, and there are changes to the default fields and field placement in the new module layouts.
The Confirm Layouts page lists the module layouts that have changed in the new version. The administrator has the option of applying the changes to the existing module layouts. By default, all of the listed module layouts are selected to be merged during the upgrade.
For example, in 6.1.0, SuiteCRM added the Assigned To fields to the default Detail View and Edit View layouts for Notes and for Email Templates. If the instance being upgraded has a customized EditView layout for Notes, but no customized layouts for Email Templates, the === following will occur during the upgrade:
The Confirm Layouts page appears as Step 5 in the Upgrade Wizard
The Confirm Layouts page displays the Notes module with the EditView
and DetailView layouts. The Email Templates layouts do not display on
the Confirm Layouts page because the existing layouts were not
The Administrator has the option of choosing to merge the changes in the Notes module with the existing customized EditView layout.
Uncheck the module if you do not want to add the new fields to a module.
This displays a message confirming that the layouts were successfully merged (if you chose to update your modules).
The Debrief page confirms the upgrade installation. Complete the steps for manual merging of files or running SQL queries now.
This displays the Home page indicating that the upgrade is complete.
Click Repair and select the Rebuild Relationships and Rebuild Extensions options in the Systems panel of the Administration Home page.
For more information, see Repair.
Manually merge the files by extracting the skipped file from the patch zip file if you unchecked any files to prevent the Upgrade Wizard from overwriting them. Merge the file installed in the SuiteCRM application directory.
Note:Check the upgradeWizard.log file in the SuiteCRM folder for information on unsuccessful SuiteCRM upgrades.
Content is available under GNU Free Documentation License 1.3 or later unless otherwise noted.