Edit this page

Storage Migration Tool

The Telerik Report Server Storage Migration Tool is a standalone module shipped with the Telerik Report Server installation and its purpose is to provide easy out-of-the box solution for migrating the Report Server storage. It can be used from a command line or a graphical (Windows Forms) user interface. The executables are placed in Tools\ subfolder of the installation directory.

Command-Line Interface

The executable must be started with two arguments, describing the source and destination storage types, followed by a connection information for each storage type. An example usage of the tool with command-line arguments would look like this:

migrate.exe type=file,connection="C:\Report Server\Data" type=redis,connection=localhost:6981,defaultDatabase=1

Available values for type parameter (case-insensitive):

  • file - indicates that a file storage will be used.

  • redis - indicates that a Redis storage will be used.

  • mssql - indicates that a MSSQL server storage will be used.

File Storage Connection Parameters

When using file as a storage type, the connection parameter must contain the path to the Telerik Report Server storage directory. By default it is named Data and is placed under Telerik.ReportServer.Web folder. When the path consists of directory names containing spaces, the argument must be enclosed in quotes. When used for destination parameter, make sure the current user has proper rights for creating files in the specified folder.

Redis Storage Connection Parameters

The migration tool uses StackExchange.Redis.StrongName v.1.0.479 library as a client that accepts the value of the connection argument in order to create a connection to the database. Make sure the Redis storage instance is active and is accepting connections before commencing a migration. Examples for initializing the connection options can be found here.

MSSQL Storage Connection Parameters

Similar to the redis option, when mssql type is used, the value of the connection parameter is passed as a connection string to the MSSQL client. Make sure the MSSQL server is active and accepts connections before commencing a migration. Examples for constructing the connection string can be found here. Note that if you do not specify a table name the data will be stored using the master schema.

Graphical User Interface

The migration tool can be used via Windows Forms application that provides a convenient UI and an option to log the migration process output. The form requires setting type and connection information for source and destination storages - the same way it is done with the CLI tool. An events log text box will display the results of the migration process and its content can be copied to clipboard via a context menu. If needed, the same log can be saved to a file for further examination - in this case make sure your user has the necessary privileges for writing a file into log directory.

Automating the Migration Process

Some scenarios require to deploy a pre-configured Report Server instance to the clients. The Report Server installation distributes two PowerShell scripts, named rs-export.ps1 and rs-import.ps1, that help automate this process. Although the scripts can be used out-of-the-box, their purpose is to demonstrate an example workflow, and they should be modified according to the current use case.

The rs-export.ps1 script starts a Report Server installation in silent mode and, when finished, opens the server's management console and waits for the server configuration to complete. When the administrator finishes configuring the report server (users, reports, whitelabeling, etc.), the script continues with exporting the server's assets storage into a .zip file and then exits.

The rs-import.ps1 script starts a Report Server installation and unpacks the produced by the first script .zip file as its storage. In case changing the ReportServer storage type is required, the script determines (via a parameter) the connection to the target storage and migrates the contents of the .zip file to MSSQL or REDIS, if needed. The script also modifies the .config file in Report Server directory so it will match the target storage type. Finally the scripts starts the Report Server Manager and exits.

Both scripts accept startup parameters, defining the installation directory and path to the produced .zip file, so they would work even without modification for most common migration scenarios.

Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article