Tuesday, September 3, 2013

Tips for upgrading Kentico CMS site from v6 to v7

Recently I upgraded one web site written in Kentico CMS v6 to v7 and would like to share my experience.

Preparation

Due to the some API changes in v7, you might need to change your code a lot if your web site is mainly using ASPX template.
To track your changes, it is better if the changes can be recorded down and can be revert any time if it is needed. This is where
source control comes in place. If you have not apply source control to your web site yet, this is the good opportunity to start
using source control.

Here are the suggestions for using SVN as the source control for this upgrading purpose:

  1. create a new repository
  2. create trunk and branches in the repository
  3. check out the trunk to a local folder
  4. copy all files and folders from your web site folder into trunk folder
  5. add all files and folders and commit to SVN repository
  6. create a branch into branch folder based on the trunk

The idea behind this is to record all changes to the branch during the upgrading. Depends on the complexity of the web site,
the changes you will make to the source code might take few days/weeks, so that I do not recommend that upgrade the
production directly, instead, you should make a copy to your development machine and upgrade this copy first. All the changes
made to the local instance will be committed into the new created branch. When the upgrade is done and has been test,
production then can be upgraded. The upgrade to the production will be as simple as following steps:

  1. copy files from the production server into trunk.
  2. commit all the modifications if there is any.
  3. merge changes from the branch
  4. copy file back to production from the trunk

Upgrade

The database upgrade script might contains changes to the views. But I have found that in Micorsoft SQL 2008 R2, after execution
of the upgrade script, the views might not be synchronized properly. In my case the error was some data conversion failures.
The root cause seemed to be the changes on base views had not propagated properly to other views which were base on the base
views.

If you need to perform the upgrade manually, it requires to delete a lot files and folders before updating files to new version’s.
The instruction has listed the files and folders, but it is very fussy if you go through the list and delete file/folder one by one.
A easier way is to copy the content of the list to a text file, then add “del “ to the beginning of the full name of the file and add
”del /s/q “ to the beginning of the full name of the path, save the text file as a .BAT file, this batch file can delete files and folders
in one go and save you a lot of time.

There is an undocumented change you need to take care if your page uses CMSForm for editing a document in the same way as
the Form tab in the CMS Desk content page, you need to assign DocumentManager.LocalMessagesPlaceHolder to the the CMSForm
element’s MessagesPlaceHolderto property, otherwise, there will be an exception when the form is submitted.