Using the Version Utility to upgrade to Reporting 12.1.

Miguel Machado / Thursday, May 17, 2012

Topic Overview

Purpose

This topic explains how to use the Version Utility to upgrade solutions to Reporting 12.1.

In this topic

This topic contains the following sections:

  • Version Utility Tool Features
  • Upgrading Reporting Version
  • Related Content

 

Version Utility Tool Features

Features Overview

The following table summarizes the features of the Version Utility tool.

Feature

Description

Project referenced assemblies update

  Assemblies referenced in the project are replaced with the new version of the assemblies.

Project configurations update

  All project configurations are updated to reflect the last changes of NetAdvantage Reporting.

 

Upgrading Reporting Version

Introduction

The Version Utility allows you to easily upgrade existing solutions to a volume of NetAdvantage Reporting.

With the Version Utility you can upgrade:

  • Solution - Upgrade all projects and project files contained in a single Microsoft Visual Studio™ solution.
  • Project - Upgrade all files contained in a single Microsoft Visual Studio project.
  • Website - Upgrade all files in a single Microsoft Visual Studio Website project folder.

The version utility can be accessed through:

  • A command line interface
  • An Add-in interface
  • A stand-alone application

The changes made during the upgrade are written to a log file regardless of the interface used and all modified files are backed up inside a new folder created in each project.

Requirements

 

To complete the procedure, you need:

  • NetAdvantage Reporting 12.1 installed
  • NetAdvantage Version Utility 12.1 installed (download

 

Overview

  1. Starting the Utility
  2. Selecting the Content Type
  3. Reviewing the Files to Update
  4. (Optional) Customizing the Upgrade
  5. Performing the Update
  6. Finalizing the Process

Steps

The following steps show how to upgrade a solution using the version utility application.

Step

Description

1. Start the Utility

Start the utility using the:

  • Standalone Application - Click on Start> All Programs> Infragistics> 12.1>Version Utility 2012.1
  • VS Add-in - Select the Upgrade Infragistics Version 12.1 option in the context menu of your solution/project (right click on you project to display context menu).

When you start the utility through the Stand Alone application, the following screen of the Utility opens; if you are using the Add-in this step is skipped since the item to be upgraded is already specified.

 

2. Select the Content Type

 

Selects the type of content you wish to upgrade, navigate to it and lead it.

Once the content is loaded, the Version Utility will start analyzing it, during which it will be displaying its next screen:

 

3. Review the Files to Upgrade

 

You can review the tasks by expanding each list item.

 

4. (Optional) Customize the Upgrade

To customize the upgrade, click the Upgrade Options link. This opens the Upgrade Options dialog:

 

  1. Use the Control Assemblies Path option to make sure you have all the necessary assemblies in one folder. The Utility allows you to select a single folder that contains the assemblies - there is no recursive search in its subfolders.
  2. If you want to use custom Upgrade Options a new analysis will be performed based on the settings you have chosen.

5. Perform the Upgrade

 

When the analysis is complete, click the upgrade button. The upgrade process begins:

 

 

The Utility will modify only the necessary files to upgrade a solution. Only the following files within a solution are modified:

  1. Project file - .csproj
  2. Configuration Files - app.config/web.config*
  3. License - .licx
  4. Code Files - .cs/.vb
  5. Resources - .resx
  6. Report Service - .svc

 

* The following table summarizes all changes to the configuration file (e.g. app.config/web.config). Additional details are available below. Please check the Reporting 12.1 Release Notes for further information about these changes.

 

Change

Description

New Report Processor HTTP Module

 A new module has been added that manages the report service calls. This module also allows configuring HTTP compression for the report service.

New Resources HTTP Handler

 The HTTP Handler used in 11.2 was modified to serve resources in general, not just images.

Two Endpoints supported 

 The service configuration now has two endpoints, SOAP and JSON endpoints can now be defined.


Note: Notice that report files (.igr) are not upgraded by the utility. This can be done by opening the report in Visual Studio’s designer where you will be promted to update the report if required.

Once the process is complete, you are taken to the final step of the Utility.

6. Finalize the Process

  • Successful Conversion

 

Upon successful completition of all identified upgrade tasks the Version Utility will inform you of the success and will provide a link to the log file for the modifications.

 

  • Unsuccessful Conversion

If the Utility encounters a condition which it cannot handle it will stop the upgrade process at the point where the error occurred and will inform you of the error:

 

At this time, you can use the log file to identify what caused the error and try to fix the error manually. If you resolve the error reported in the log file, you can try the upgrade process again to give the Utility the chance to process the upgrade tasks that have not been completed yet. As an alternative, you can, of course, upgrade your application manually.

 

Related Content

Topics

The following topics provide additional information related to this topic.

Topic

Purpose

  This topic summarizes the known issues and limitations of the NetAdvantage Reporting 2012 Volume 1 release.