Upgrading and hotfixing an instance
You can launch the upgrade/hotfix utilities in two ways:
- Click Apply in the Upgrade/Hotfix or Check dialog of Kentico Xperience Installation Manager.
- Execute the file from the folder where you installed the hotfix or upgrade.
Getting hotfix packages
- download hotfix packages through the Kentico Xperience Installation Manager.
- download the packages from http://devnet.kentico.com.
If you need to hotfix the source code version, please contact us at firstname.lastname@example.org.
Note: Hotfixes are cumulative, so you only need to apply the latest hotfix to fix all issues covered by previously released hotfixes.
The hotfix or upgrade process consists of the following steps:
Hotfixing with files in deployment or source control mode
If your system stores virtual objects on the file system (due to enabled deployment mode or source control options), you need to return the files to the database before you apply the hotfix.
Re-enable deployment mode or source control after you finish the hotfix procedure.
- Specify the root folder of the Xperience instance you want to upgrade or hotfix.
- This is only necessary if you ran the utility manually (not from Kentico Xperience Installation Manager).
Specify a project backup folder and click Back up OR select the I already have a backup of my project check box.
Specify a database backup folder and click Backup OR select the I already have a backup of my database check box.
Keep the default settings (i.e., all options enabled) OR click the Switch to advanced mode (for experts only) link and specify, whether the upgrade or hotfix replaces project files, setup files (i.e., external utilities) and executes SQL scripts.
Select one of the first set of options:
- Use default App_Offline.htm – the utility creates a new App_Offline.htm file in the root of the web project to put the instance into an offline mode (see How to: Prepare to Deploy a Web Project for more details on the use of the file).
- Use existing App_Offline.htm_ – uses an existing App_Offline.htm_ file and renames it to App_Offline.htm. The file must be present in the project's root folder for this option to be available. See the second option below for more details.
Select one of the second set of options, which lets you choose what to do with the App_Offline.htm file:
- Delete - the file will be deleted.
- Rename to App_Offline.htm_ – the file will be renamed to App_Offline.htm_ and usable on next upgrade or hotfix.
A log showing progress of the hotfix or upgrade is displayed. You can select the Show error messages only check box to display only error messages in the log.
Click Next, once the process finishes.
The utility lets you know if the hotfix or upgrade finished successfully. By clicking the Open log file link, you can open the upgrade process log that was displayed in the previous step.
Physically, the log is saved in ~\App_Data\log.txt, so you can inspect it even after closing the utility.
If an error occurred while applying the hotfix or upgrade, the utility will notify you with a message and an error log. Errors that can commonly occur during the process are conflicts with customized files. By default, the upgrade or hotfix does not overwrite modified files in order to preserve your customizations (unless you enabled the Overwrite all files option in the utility):
For each conflict with a customized file, the process creates the new version of the file with the .new extension. You need to manually transfer your customizations to the new files and then replace the original ones.
Customized files that would have otherwise been deleted remain in the file system, with an added .deleted extension.
Click Close to finish and close the utility.
Completing the hotfix process
After you have applied the hotfix or upgrade, finish the process by performing these steps:
- Open the Xperience administration project in Visual Studio and Rebuild the solution.
- Access the URL of the Xperience administration site.
- When handling the first request after the hotfix was applied, the system performs certain tasks required to complete the hotfix procedure. The first request may take longer than usual to process.
You also need to update the Xperience code used by your MVC application after you apply the hotfix to the Xperience application:
- Open your MVC application in Visual Studio.
- Right-click your MVC project in the Solution Explorer and select Manage NuGet Packages.
- Update the Kentico.Xperience.AspNet.Mvc5 NuGet package to the version that matches the applied hotfix.