Product Documentation

Upgrade the Reporting service and migrate the data warehouse

Jun 05, 2015
Updated: 2014-08-18
Upgrading the Reporting service involves the following tasks:
  • Upgrade and reconfigure the Reporting service. This includes backing up the config.xml file, RDL files, and data sources. The config.xml file is located at %PROGRAMFILES%CitrixCortexData WarehouseData Transferconfig. You can find the RDL files and data sources through the Report Manager web site for SQL Server Reporting Services. If the reporting definitions and data sources have been moved to another location, you must back up these components manually.
  • Migrate the data warehouse. This includes importing new reporting configuration and report definitions for enabled services, migrating the OLMReporting database, and generating the required configuration files.
    Note: The migration process might run for an extended period of time due to data reprocessing. You can monitor this process through the Data Warehouse logs located at %PROGRAMDATA%CitrixCloudPortal Services Manager SetupLogsData Warehouse Migrationtimestamp.log. Additionally, the %PROGRAMFILES%CitrixCortexData Warehouse Servicelog folder contains logs of errors that occur while upgrading the OLMReporting database schema and data to the Version 11 format.

The user performing the upgrade must be logged on as a domain administrator.

To upgrade the Reporting service using the graphical interface

  1. From the installation media, double-click setup.exe and click Get Started.
  2. On the Select Deployment Task page, select Upgrade Existing Deployment.
  3. On the Upgrade Existing Deployment page, select Upgrade Roles and Services. The Setup Tool verifies the database version. If the correct database version is not detected, the Setup Tool prompts you to manually verify the version and click Next.
  4. When prompted, accept the End User Licensing Agreement and then click Next.
  5. On the Select Components page, select Reporting. By default, installed components for which upgrades are available are selected.
  6. On the Ready to upgrade page, click Upgrade. The Setup Tool installs the Configuration Tool, upgrades the selected components, and displays progress.
  7. On the Upgrade Complete page, click Finish.
  8. From the Upgrade Existing Deployment page, select Re-configure Upgraded Roles and Services.
  9. On the Re-configure Upgraded Components page, click Finish Upgrade for each component you want to reconfigure.
  10. Use the following table to configure the settings for each server role:
    Role Page Description

    Report Mailer

    No action needed. Proceed to Step 11.

    Reporting

    Preview Service Package Import

    Review the service components that will be imported when the Reporting service is reconfigured. By default, only the Reporting service components are selected. Other components, such as roles and assemblies, are imported when the Web server role is configured.

    Enter Data Transfer Connection Credentials

    Configure the following settings:
    • Under Source Connection, enter the password for the OLMUser account.
    • Under Destination Connection, enter the password for the OLMReportingUser account.

    Data Transfer Service

    • Auto-generate credentials: Select this option to create the service account with auto-generated credentials. Leave this option cleared to specify your own credentials for this account.
    • User name: Enter a unique user name for the service account. The default user name is csm_dataw_svc.
    • Password: Enter a password for this account that conforms to your domain's password policy. This field is not available if you elect to auto-generate credentials.
    • Create if doesn't exist: Leave this option selected to create the service account if it does not already exist. If you elect to create this account manually prior to configuring the server role, clear this option. This option is not available if you elect to auto-generate credentials.
    • Service port: Specify the port that the service will use. The default port is 80.
    • Data purge window (months): Select Configure and then specify the number of months after which older historical data is deleted. For example, specify 84 to delete data that is older than seven years.
  11. On the Summary page, click Commit.
  12. When the reconfiguration is complete, click Finish.

To migrate the data warehouse using the graphical interface

  1. From the installation media, double-click setup.exe and click Get Started.
  2. On the Select Deployment Task page, select Upgrade Existing Deployment.
  3. On the Upgrade Existing Deployment page, select Start Data Warehouse Migration.
  4. On the Start Data Warehouse Migration page, click Start Migration. The Setup Tool launches the migration process. To monitor progress, click Refresh.
  5. When the migration is finished, click Exit.
After the upgrade and migration are complete, you can manually restore any reporting customizations. For example:
  1. Redeploy any custom views or stored procedures to accommodate schema changes.
  2. Migrate any custom commands in the Version 10 config.xml file to the Version 11 config.xml file to accommodate schema changes.
  3. Redeploy any report definition customizations.

To upgrade the Reporting service and migrate the data warehouse using the command line

  1. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
  2. At the command prompt, enter CortexSetup.exe /Upgrade:Reporting /Legacy. The Setup Tool upgrades the Reporting service and returns the command prompt.
  3. At the command prompt, enter CortexConfigConsole.exe /Upgrade:Reporting /Legacy and specify the following properties:
    Property Description
    /OlmPassword The password for the OLM database.
    /OlmReportingPassword The password for the OLMReporting database.
    /DwsUserName The user name for the data warehouse service account.
    /DwsPassword The password for the data warehouse service account.
    /AutoCreateDwsUser:True|False Optional. Create the data warehouse user account. Default = True
    /DwsServer:hostname Optional. The hostname of the server hosting the data warehouse. Default = the name of the local computer
    /DwsPort:port Optional. Inbound port to be used with the data warehouse. Default = 8095
    /PackageFolder:path-to-service-packages Optional. The location of the Services folder on the Services Manager installation media, which contains the service packages.
    /IgnoreErrors:True|False Optional. Whether or not to ignore service import errors. Default = True
    /PurgeAgeInMonths Optional. The number of months after which older historical data is deleted. For example, specify 84 to delete data that is older than seven years.

Sample command strings

The following command reconfigures the Reporting service and migrates the data warehouse.
CortexConfigConsole.exe /Upgrade:Reporting /Legacy /OlmPassword:password /OlmReportingPassword:password /DwsUserName:user-name /DwsPassword:password /IgnoreErrors:False