Is this really the version you are looking for? Kentico 8.1 documentation is no longer updated. Use the switch in the header to choose your Kentico version.

Upgrading custom code

The Kentico Code upgrade tool provides a way to analyze Kentico 8 projects and helps convert custom code to version 8.1. You can download the tool from the API Changes page on the DevNet portal.

The tool has the following functionality:

  • Detects custom code that is no longer valid in version 8.1
  • Provides recommendations for each occurrence of invalid code
  • Automatic conversion of the majority of code to the Kentico 8.1 API

Prerequisites

The machine where you plan to run the code upgrade tool must fulfill the following requirements:

The Kentico 8 solution that you wish to analyze must compile without errors.

To allow the tool to check the code of Kentico virtual objects, such as transformations and page layouts, you need to enable Deployment mode for your Kentico 8 instance.

Analyzing Kentico 8 projects

Basic detection

Run CodeUpgrade.exe from the command line, with the path to your project’s solution file as the parameter (WebSite.sln or WebApp.sln).

For example:

CodeUpgrade.exe C:\inetpub\wwwroot\Kentico8\WebSite.sln

The tool generates a csv file containing a list of custom code occurrences in your project that are no longer valid in Kentico 8.1. The information will help you update your custom code after you perform the upgrade.

Each listed occurrence in the csv file has one of the following statuses:

  • Detected - an occurrence of invalid code that the tool cannot resolve automatically. See the Instructions value of the occurrence for more information.
  • CanBeResolved - a detected code occurrence that the tool can resolve automatically if you run it with the -resolve parameter (see the Automatic conversion section).
  • Resolved - invalid code that the tool automatically resolved in the specified output folder. Only used when running the tool with the -resolve parameter.

Automatic conversion

You can also use the tool to provide automatic resolutions for most types of code expressions. Add the -resolve parameter when running CodeUpgrade.exe. Set the target folder for the output using the -outputfolder parameter.

For example:

CodeUpgrade.exe -resolve -outputfolder=C:\ConvertedCode C:\inetpub\wwwroot\Kentico8\WebSite.sln

If the tool detects code issues that can be automatically resolved, it creates copies of the given files in the specified output folder. All resolvable issues in the files are updated to be compatible with the Kentico 8.1 API.

Optional parameters

You can also add the following parameters when running the tool:

  • -output=results.csv - sets the name of the file containing the tool’s results.
  • -verbose=0 - determines how detailed the tool’s output is in the console (enter values from 0 to 3). Does not affect the output file.

For more details about the available parameters, run the tool without any parameters.

Limiting the scope of the analysis

For customized Kentico files, the tool reports all detected issues, including the default Kentico 8 code.  You can avoid reporting of these false positives by enclosing your custom code into #region directives with a specific name. For ASPX markup, use the following syntax:

<%-- #region Name --%> ... <%-- #endregion --%>

To analyze only the code placed inside the regions, run the tool with an additional parameter: -customregion=<regionName>

Implementing the API changes

Use the output of the tool to update your custom code AFTER you upgrade the project to Kentico 8.1.

The output file lists all occurrences of invalid custom code, including:

  • The path of the affected file and line number
  • The exact source code of the expression
  • A set of instructions on how to resolve the issue

If you generated automatic conversions for your code, use the following approaches to insert the new code into your upgraded project:

  • Customized Kentico files - use a code comparison tool and merge the Kentico 8.1 files with the matching files in the tool’s output folder.
  • Fully custom files - directly replace the files using the converted files created by the tool.

Tip: To update the code of virtual objects, enable Deployment mode. You can then fix the code in the corresponding physical files, which match the output of the code upgrade tool. Disable deployment mode to return the updated virtual objects back into the database.