Hotfix Instructions - Kentico 10

Hotfixes allow you to fix problems in your installation of Kentico. You can download hotfix packages and view the list of fixed bugs on the Kentico DevNet portal.

If you have the source code version of Kentico, please see Hotfix Instructions - Kentico 10 Source Code.

Note

Hotfixes are not tested for all possible scenarios, so you may experience issues after applying the hotfix.

Always back up your project files and database before applying a hotfix.

Table of Contents

Prerequisites

You can only apply the hotfix to complete Kentico projects that use the standard folder structure (the solution file, GlobalAssemblyInfo.cs, the CMS and Lib sub-folders). If you run your website as a deployment of the CMS folder, you need to hotfix the original complete project and then create a new deployment.

Applying the hotfix to web site projects

Local installation

  1. If your system stores virtual objects on the file system (due to enabled Deployment mode or source control options), return the files to the database. You can re-enable deployment mode or source control after you apply the hotfix.

  2. Run Kentico Hotfix Utility (Hotfix.exe) from the location where you installed the hotfix.

  3. Select your project folder using the Browse button or type in the path to the project manually.

  4. Use the application to back up your project files and/or database if you haven’t already done so.

  5. Select which components you want to update. Click Switch to advanced mode if you wish to change the settings. We recommend updating all components.
    • Kentico files - the files of your web project
    • Setup files - the Kentico installer and external utilities (which are separate from the web project)
    • SQL script - the database structure and data

  6. Choose a method of taking the project offline and back online.

  7. Click Next to start the update procedure.

  8. After the update finishes, click Next to view any problems that may have occurred and the instructions to solve them.

For more information, see Kentico Hotfix and Upgrade Utility.

Remote installation

If you cannot access your web project directly (for example when the project is located on a remote hosting server), you can use the Hotfix Utility to create the updated file structure and then upload them to your web project location. 

  1. Navigate to the location where you installed the hotfix.
  2. Run Hotfix.exe from the command line with the /deploy parameter. Set the parameter value based on the installation type you’re using:

    • net45site - web site project using .NET version 4.5
    • net46site - web site project using .NET version 4.6

    Example: Hotfix.exe /deploy=net45site

    This launches the Hotfix Utility, which then creates the files and folders necessary for updating a project running on .NET version 4.5 and saves them into the folder chosen in the first step of the Hotfix Utility wizard.

    Additionally, you can provide the /path parameter, which tells the application where to create the file structure. This way you won’t have to set the path in the first step of the Hotfix Wizard.

    You can supply the /path parameter in two different formats – relative, which represents a folder in the location from which the utility was executed; or absolute, which can be any path to a local disk.

    Example: Hotfix.exe /deploy=net45site /path=Deploy

    This launches the Hotfix Utility, which then creates a folder named Deploy in the directory from which the utility was executed and copies all files and folders necessary for updating a project running on .NET version 4.5 into that folder.

  3. Once you have the update files ready, take your website offline. You can do this by copying the App_Offline.htm file from the hotfix installation directory into the root of the remote web project.

  4. Upload the update files created by the Hotfix Utility into your remote web project's CMS folder (overwrite the original files).

    Important

    If you have previously modified some of the Kentico project files (such as web parts or administration interface files), DO NOT OVERWRITE these files. You could lose your modifications.

    You need to compare the modified files with the new versions and make appropriate changes manually.

  5. Manually execute the hotfix SQL scripts on your Kentico database.

    • If you do not use separated databases - run the Hotfix_separated.sql and Hotfix_default.sql script files located in the SQL folder of your hotfix installation directory. We recommend running the files in the described order.

    • If you use separated databases - run the Hotfix_separated.sql script file on the separated database and Hotfix_default.sql on your main database. The script files are located in the SQL folder of your hotfix installation directory.

  6. Bring your website back online (delete the App_Offline.htm file).

Applying the hotfix to web application projects

Local installation

  1. If your system stores virtual objects on the file system (due to enabled Deployment mode or source control options), return the files to the database. After you apply the hotfix, re-enable deployment mode or source control and rebuild the project.

  2. Run Kentico Hotfix Utility (Hotfix.exe) from the location where you installed the hotfix.

  3. Select your project folder using the Browse button or type in the path to the project manually.

  4. Use the application to back up your project files and/or database if you haven’t already done so.

  5. Select which components you want to update. Click Switch to advanced mode if you wish to change the settings. We recommend updating all components.
    • Kentico files - the files of your web project
    • Setup files - the Kentico installer and external utilities (which are separate from the web project)
    • SQL script - the database structure and data

  6. Choose a method of taking the project offline and back online.

  7. Click Next to start the update procedure.

  8. After the update finishes, click Next to view any problems that may have occurred and the instructions to solve them.

  9. Open the project solution in Visual Studio and build the solution.

For more information, see Kentico Hotfix and Upgrade Utility.

Remote installation

If you cannot access your web project directly (for example when the project is located on a remote hosting server), you can use the Hotfix Utility to create the updated file structure and then upload them to your web project location. 

  1. Navigate to the location where you installed the hotfix.
  2. Run Hotfix.exe from the command line with the /deploy parameter. Set the parameter value based on the installation type you’re using:

    • net45app - web site project using .NET version 4.5
    • net46app - web site project using .NET version 4.6

    Example: Hotfix.exe /deploy=net45app
    This launches the Hotfix Utility, which then creates the files and folders necessary for updating a project running on .NET version 4.5 and saves them into the folder chosen in the first step of the Hotfix Utility wizard.

    Additionally, you can provide the /path parameter, which tells the application where to create the file structure. This way you won’t have to set the path in the first step of the Hotfix Wizard.

    You can supply the /path parameter in two different formats – relative, which represents a folder in the location from which the utility was executed; or absolute, which can be any path to a local disk.

    Example: Hotfix.exe /deploy=net45app /path=Deploy
    This launches the Hotfix Utility, which then creates a folder named Deploy in the directory from which the utility was executed and copies all files and folders necessary for updating a project running on .NET version 4.5 into that folder.

  3. Once you have the update files ready, take your website offline. You can do this by copying the App_Offline.htm file from the hotfix installation directory into the root of the remote web project.

  4. Upload the update files created by the Hotfix Utility into your remote web project's CMS folder (overwrite the original files).

    Important

    If you have previously modified some of the Kentico project files (such as web parts or administration interface files), DO NOT OVERWRITE these files. You could lose your modifications.

    You need to compare the modified files with the new versions and make appropriate changes manually.

  5. Manually execute the hotfix SQL scripts on your Kentico database.

    • If you do not use separated databases - run the Hotfix_separated.sql and Hotfix_default.sql script files located in the SQL folder of your hotfix installation directory. We recommend running the files in the described order.

    • If you use separated databases - run the Hotfix_separated.sql script file on the separated database and Hotfix_default.sql on your main database. The script files are located in the SQL folder of your hotfix installation directory.

  6. Open the project in Visual Studio and build the solution.

  7. Bring your website back online (delete the App_Offline.htm file).

Applying the hotfix to Microsoft Azure

In the case of websites hosted on Microsoft Azure, you need to apply the hotfix to your local copy of the web application and then redeploy.

  1. Run Kentico Hotfix Utility (Hotfix.exe) from the location where you installed the hotfix.

  2. Select the folder containing your local version of the project using the Browse button or type in the path to the project manually.
     

  3. Use the application to back up your project files and/or database in case you haven’t already done so.
     

  4. Select whether you want to update files, database or both. If your database is hosted on SQL Azure, you need to update it manually.

  5. Click Next to start the update procedure.

  6. After the update finishes, click Next to view any problems that may have occurred and the instructions to solve them.

  7. Open the project’s solution in Visual Studio and rebuild it.

  8. Redeploy the application to Microsoft Azure.

  9. If your website’s database is hosted on SQL Azure, manually execute the hotfix SQL scripts against it.

    • If you do not use separated databases - run the Hotfix_separated.sql and Hotfix_default.sql script files located in the SQL folder of your hotfix installation directory. We recommend running the files in the described order.

    • If you use separated databases - run the Hotfix_separated.sql script file on the separated database and Hotfix_default.sql on your main database. The script files are located in the SQL folder of your hotfix installation directory.

After applying the hotfix

All users who work with the Kentico administration interface should clear the cache in their browsers after applying the hotfix. Otherwise, some features in the administration interface may not be displayed correctly.

Updating setup files and external utilities

Hotfixes provide bug fixes for all files related to the Kentico installation, which includes the installer and other external utilities, such as Kentico Installation Manager and Kentico Service Manager.

To update these files and utilities, you need to apply the hotfix to the setup files:

  1. When running the hotfix utility, click Switch to advanced mode in the Change confirmation step.
  2. Select the Setup files checkbox.
  3. Click Next.
  4. In the Running applications step, stop any applications that are currently running from the setup files.
  5. Click Next and continue through the rest of the hotfix procedure.

The hotfix makes any required changes to the files in the directory where you installed your Kentico setup files.

Additional notes and workarounds

10.0.11

  • After applying the hotfix, you can configure the character encoding that the continuous integration solution uses when generating non-binary files in the CIRepository folder. Add the CMSCIEncoding key to the appSettings section of your project's web.config file. Changing the value of the key does not update the encoding type of existing files in the CIRepository folder. To fully update the repository content, you need to run complete serialization for all objects and manually update the encoding type of your repository.config file.

    Example
    <add key="CMSCIEncoding" value="utf-8" />
  • When processing serialized XML data with custom fields of the Decimal number data type (for example during import, staging, or in the REST service), the system handled certain types of decimal values incorrectly if the culture context of the source data was different than on the target instance. After applying the hotfix, the system attempts to adapt the processing for all types of decimal culture formats. In certain cases this may result in an error, and you then need to fix the source data or as a temporary workaround add the <add key="CMSDisableDecimalSeparatorFix" value="true" /> key to the appSettings section your project's web.config file, which returns the system to the pre-hotfix decimal processing behavior.

    REST service errors

    If you encounter errors when processing REST service requests with data containing decimal numbers, use the CMSRESTCulture web.config key to set the culture context of the REST service to match the culture format used by the sending application.

    <add key="CMSRESTCulture" value="en-US" />

    We strongly recommend sending data in the en-US culture format.

10.0.16

  • Heavy load on sites hosted on Microsoft Azure and utilizing the 51Degrees Premium integration caused site downtime in certain cases. After applying the hotfix, the Devices selector on the General tab of device profiles in the Device profiles application now only lists devices specified in ~/App_Data/CMSModules/DeviceProfile/devices.xml. Instead of selecting individual devices via the Devices selector, we recommend using macro expressions to create your desired device profile. For example, a device profile with the following macro expression applies only to mobile phones with screens no wider than 480px:

    Example - Device profile macro expression
    maxWidth = 480;
    
    width = CurrentDevice.ScreenPixelsWidth;
    
    if (!CurrentDevice.IsMobile || (width > maxSideSize))
    {
        return false;
    }
    
    return true;

Fixed bugs

For a full list of bugs covered by the hotfix, open the Hotfixes page on DevNet and click Fixed bugs for the appropriate Kentico version.


Was this page helpful?