10 KiB
title | page_title | description | slug | tags | published | position | previous_url |
---|---|---|---|---|---|---|---|
Overview | Upgrade Overview | Learn more about the general flow when upgrading Telerik Reporting and using the major and minor releases, and upgrade desktop, website, and other projects manually. | telerikreporting/upgrade/overview | telerik, reporting, upgrading, major, minor, releases, desktop, website, other, projects, manually, overview | True | 0 | /installation-upgrading-newer-version, /installation-upgrading-newer_version, /upgradepathoverview, /upgrade/ |
Upgrading Telerik Reporting
Depending on the new features and changes in each new Telerik Reporting release, you may have to upgrade your project.
All Telerik Reporting and Telerik Report Server resources that interact must match in version. For example, Html5 Report Viewer with version {{site.buildversion}}, Angular Report Viewer {{site.spaviewerversion}}, and React Report Viewer {{site.spaviewerversion}} must use a Reporting REST Service {{site.buildversion}}, or Telerik Report Server with version {{site.reportserverversion}}. Upon upgrading Telerik Reporting or Report Server ensure the browser hasn't cached the viewer's files with the older version.
The PDF documentation is updated less often than the online documentation and may contain outdated or imprecise information.
General Workflow
To upgrade Telerik Reporting:
- Check for any new features, fixes, breaking or dependency changes in the Telerik Reporting Release History.
- Install the desired Telerik Reporting version by using the Telerik Control Panel or [through the MSI installer file]({%slug telerikreporting/installation%}).
- Upgrade all projects that use Telerik Reporting as described in this article.
- Check for any updates between your current and desired versions in the articles with the specific changes in each Telerik Reporting release. For example, if your project currently targets Q3 2013, to upgrade to Q1 2014, review the articles for [Q3 2013]({%slug telerikreporting/upgrade/2013/q3-2013%}) and [Q1 2014]({%slug telerikreporting/upgrade/2014/q1-2014%}).
For any persisting issues, use either of the following options:
- Refer to the article on [troubleshooting installation and upgrade issues]({%slug unable-to-upgrade-after-wizard%}) in Telerik Reporting.
- Send the issue through the dedicated Telerik Reporting support system together with your project or solution in a
.zip
file.
Major and Minor Releases
Telerik Reporting supports the following types of releases:
- Major versions— Can simultaneously coexist on the same machine. For example, major versions are the [Q3 2013]({%slug telerikreporting/upgrade/2013/q3-2013%}) and [Q1 2014]({%slug telerikreporting/upgrade/2014/q1-2014%}) releases.
- Minor versions, or Service Packs (SP)— A major version can coexist on the same machine with only a single minor version from the same release. For example, when you upgrade the major Q1 2014 release to the later minor Q1 2014 SP1 release, the installer will first uninstall the Q1 2014 version and then install Q1 2014 SP1.
If the new Telerik Reporting version is a major release, it will be installed next to the earlier releases. If the new Telerik Reporting version is a minor release, it will replace the corresponding major release.
Visual Studio Toolbox loads only the updates from the latest Telerik Reporting version that is installed on your computer. However, you will be able to work with the item and project templates from all Telerik Reporting versions that are installed on your computer.
Upgrading Projects Automatically
To automatically upgrade your project to a later Telerik Reporting version, use the [Telerik Upgrade Wizard]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/visual-studio-report-designer/upgrade-wizard%}).
The Telerik Upgrade Wizard does not support website projects because websites handle the assembly references in a different way. To upgrade your website project automatically, transform it into a web application. Alternatively, upgrade your website project manually.
The Telerik Upgrade Wizard does not support .NET Core projects. To upgrade your .NET project, manually upgrade the references to the Telerik Reporting assemblies or NuGet packages and the HTML5 Report Viewer scripts to the required version.
You can only manually update the website projects and WPF projects that use the WPF Report Viewers but do not have separately purchased Telerik UI for WPF product.
Upgrading Projects Manually
You can manually upgrade class library and website projects, and desktop and web applications.
-
In
Solution Explorer
, click the Show All Files button. Open References and locate the references to the previous Telerik Reporting assemblies.Service Pack assemblies are marked with yellow exclamation marks which show that the assemblies cannot be located. This behavior is normal and indicates that you have uninstalled the version to which they belong.
-
Select the old assemblies that you identified in the previous step and click Delete to remove them. Keep the names of the deleted assemblies for further reference.
-
Right-click References and select Add Reference > Add all to add all required references to the new Telerik Reporting assembly versions. These versions correspond to the deleted ones from the previous step. As a result, the newly added references appear in References without the yellow exclamation marks which means that they are valid.
-
Open the
web.config/app.config
file and update all version numbers to the new one in the following instances:<configSections>
―The location in which you can alter the attributes of the rendering extensions.<httpHandlers>
/<handlers>
―The location in which the ASP.NET Report Viewer registers its handler.<assemblies>
―The Reporting assemblies that are references in the web application.
-
(For web applications only) Open the
.aspx
or.master
pages and change the version of the ASP.NET Report Viewer in theRegister
directive. Update the HTML5 Report Viewer files in the project. Open the.cshtml
or.vbhtml
and layout views, the pure HTML pages or the.aspx
or.master
pages, and change the version of the links which point to the following files:telerikReportViewer-x.x.x.x(.min).css
―The CSS of the HTML5 Report Viewer wherex.x.x.x
is the HTML5 Report Viewer and Telerik Reporting version (for example,8.1.14.816
).telerikReportViewer-x.x.x.x(.min).js
―The JavaScript files of the HTML5 Report Viewer wherex.x.x.x
is the HTML5 Report Viewer and Telerik Reporting version (for example,8.1.14.816
).telerikReportViewerTemplate.html
―The default HTML template page of the HTML5 Report Viewer.
(For WPF applications only) Update the references to Telerik UI for WPF and the corresponding binding redirects, if any. For more information, refer to the article on [manually setting up the WPF ReportViewer]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/wpf-application/how-to-add--manually-report-viewer-to-a-wpf-.net-framework-project%}). Update the XAML resources which correspond to the updated Telerik UI for WPF assemblies.
-
Open all report resource files as XML―each
.resx
file appears under the respective report file. Locate all occurrences of a Telerik Reporting Assembly and update the version number to the new one. Unlike the version name (for example,Q1 2008
), the version number is a technical identifier (for example,2.5.8.414
). -
Restart Visual Studio and rebuild all updated projects.
-
If compilation errors or warnings occur, review the Telerik Reporting Release History for any obsolete or deleted properties, methods, and events, and handle these according to the instructions. Review the release history for all releases between the previous and the latest version you installed.
Upgrading Website Projects Manually
To upgrade your website project manually:
-
In
Solution Explorer
, click the Show All Files button. Select Delete all to remove all Telerik Reporting assemblies from theBin
folder. -
From the References tab on the Property Pages of the website, remove all references to Telerik Reporting assemblies. Keep the names of the deleted assemblies for further reference.
-
Select Add all to add all required references to the new Telerik Reporting assembly versions. They correspond to the ones that you deleted in the previous step.
-
Open the
web.config
file and update all version numbers to the new one in the following instances:<configSections>
―The location in which you can alter the attributes of the rendering extensions.<httpHandlers>
/<handlers>
―The location in which the ASP.NET Report Viewer registers its handler.<assemblies>
―The Telerik Reporting assemblies that are referenced on the website.
-
Open the
.aspx/.master
pages and change the version of the Report Viewer in theRegister
directive. -
Open all report resource files as XML―Each
.resx
file appears under the respective report file. Locate all occurrences of a Telerik Reporting Assembly and update their version number to the new one. Unlike the version name (for example, Q1 2014), the version number is a technical identifier (for example, 8.0.14.225). -
Restart Visual Studio and rebuild all updated projects.
-
If compilation errors or warnings occur, review the Telerik Reporting Release History for any obsolete or deleted properties, methods, and events, and handle these according to the instructions. Review the Release History for all releases between the previous and the latest version you installed.