Installing
OneStop Reporting Products
on Terminal Server

Contents

1Introduction

2System Requirements

3Installation

4Documentation of applied Registry Settings

5System Integration Updates

6Appendix

© 2010 OneStop Reporting

Version2.4

  1. Introduction

This document describes the installation process for OneStop Reporting products on Terminal Server.

The product installation package for OneStop Reporting for terminal server can be downloaded from

See the document “OneStop Reporting Product Overview and Deployment” for more information about the products and discussions about deployment strategies. It is important to read through the sections about Planning for Deployment on Terminal Server.

  1. System Requirements

Supported platforms (32 or 64-bit):

  • Windows Server 2000/2003/2008

Supported Microsoft Office versions:

  • OneStop Report Designer:

-Microsoft Excel 2007

-Microsoft Excel 2010 32-bit

-Microsoft Excel 2010 64-bit (See the Appendix for specific instructions)

  • OneStop Report Player:

-Microsoft Excel 2003

-Microsoft Excel 2007

-Microsoft Excel 2010 32-bit

-Microsoft Excel 2010 64-bit (See the Appendix for specific instructions)

Additional prerequisites (included in the package – must be installed separately):

  • All products:

-Microsoft .NET Framework 3.5 SP1

  • OneStop Report Designer and OneStop Report Player 2010

-Visual Studio 2010 Tools for Office Runtime

  • OneStop Report Designer and OneStop Report Player 2007

-Microsoft Office 2007 Primary Interop Assemblies

-Visual Studio Tool for the Office System 3.0 Runtime Service Pack 1

  • OneStop Report Player 2003:

-Microsoft Office 2007 Compatibility Pack

-Microsoft Office 2003 Primary Interop Assemblies

-Visual Studio 2005 Tools for Office Second Edition Runtime

-Shared Add-in Support Update for Microsoft .NET Framework 2.0 (KB908002)

  1. Installation
  2. Application installation for Terminal Server deployment
  1. Log onto the Terminal Server as an Administrator.
  2. Go to the download site
    and click on the link to download “Complete installation package”.
  3. Click the “Run” button in the File Download dialog:


  1. When the product has finished downloading, you will be presented with a new screen. Click on the “Install” button to extract the setup files to the specified folder:
  1. Open Windows Explorer and go to the folder you extracted the files to:

  1. Install the required prerequisites:
    (you do not need to do this in “install mode” or through “Add/Remove Programs”)
  • “Prerequisites2010Setup.exe” if you are running Office Excel 2010
  • “Prerequisites2007Setup.exe” if you are running Office Excel 2007
  • “Prerequisites2003Setup.exe” if you are running Office Excel 2003.

If the Setup detects that some prerequisites are missing you will be prompted to install the missing components. In such case follow the instructions in the dialogs that appear. See section 3 for more information about required prerequisites.

You will be presented the dialog below when the prerequisites setup is finished:


  1. The Terminal Server needs to be configured to ensure that you are allowed to install MSI packages. This is done by changing a policy in the Group Policy Editor.

To start the Group Policy Editor:

  • Go to Start -> Run and type “gpedit.msc” and press enter.
  • Navigate to Local Computer Policy -> Configuration -> Administrative Templates -> Windows Components ->Windows Installer
  • Right-click on “Disable Windows Installer” and choose “Properties”.
  • Select “Enabled” and set the “Disable Windows Installer” value to “Never”.
  • Click OK.

If the Group Policy Editor is not available on your server version, you can set this setting in the Windows Registry.

Open the Registry editor and navigate to:

HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Windows\Installer

Create or modify the REG_DWORD value “DisableMSI” and set it to 0 (zero).

You can change this setting back after you finish installation of OneStop Reporting.

  1. Set the server in “Install Mode” according to the following instructions.
    DONOTUSE“CHANGE USER /INSTALL” FROM THE COMMAND PROMPT!
    This assures that the registry entries needed to start the Excel add-ins are propagated to all users on the Terminal Server. Windows will store these registry entries under:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\

For Windows Server 2008:

  • Open Control Panel -> Administrative Tools -> Install Application on Terminal Server

For Windows Server 2003:

  • Open Control Panel -> Add or Remove Programs -> Add New Programs, then click on the “CD or Floppy” button after the title “Add a program from CD-ROM or floppy disk”.

In the Installation applet browse to the folder you extracted the OneStop Reporting installation files in section 3.1.4 and select the .msi file of the OneStop Reporting product you wish to install:


  1. The Setup will now start. Repeat this section for all OneStop Reporting products you wish to install.

When all products are installed you can set your server back to Execute mode if needed and reset the “Disable Windows Installer” policy described previously.

For OneStop Report Composer additional actions may be required to publish the Start Menu icon to all users.

During the installation process you will be prompted for user interaction in a number of dialogs. These dialogs are self-explanatory and omitted in order to reduce the size of this document.

  1. When the file installation is complete the Repository Setup Wizard will appear (see next section).
  2. Repository Wizard
  1. If this is the first time you install an OneStop Reporting product you will be presented with the Repository Wizard dialog:

Successive updates of a OneStop Reporting application will detect if the Repository has already been configured and ask to continue to use the existing settings or to run the Repository Wizard:

  1. Next, select which type of OneStop Reporting Repository you want to install.
  1. If you have selected “SQL Server database” you will get the choice of creating a new Repository or connect to an existing. If this is the first client you install an OneStop Reporting product on you must choose “Create new”.

For the remaining clients you should choose “Connect to existing” and select or enter the appropriate SQL Server name in the Server field in order to point all clients to the same OneStop Reporting Repository.

  1. Next, the Wizard will ask you to enter connection information to your SQL Server database engine in order to create a repository database. The SQL Server login you enter must have permissions to create a database and a login. Normally this should be the “sa” user.

A database called “OSR_Repository” and a login for this database called “osruser” will be created on the specified server.

If you choose SQL Server Authentication you must be logged on as a Windows user with the same requiredSQL Server permissions.

  1. Select the Integration Package applicable for your system and click Next to download and install the package into your Repository:

The Download System Integration Packages dialog is also available from the OneStop Reporting applications.

  1. In the next screen you can enter your license numbers:

You do not need to enter a license number for products you are not going to install.

  1. The Repository Setup Wizard is now complete and the installation will finish.


  1. Registry Settings

The OneStop Reporting products require various per-userregistry settings in order to operate. These settings are normally set during installation and are propagated to all users by Windows. See chapter 3.1.8.

However, in a Terminal Server environment you might want finer control of which users are going to use the various OneStop Reporting products. This can be accomplished by deploying the registry entries through a user logon script. If you are not using any scripting tool of your own you can utilize the standard USERLOGON script found under the Windows\System32 folder.

Values shown in the screenshots may differ from the actual installation on your server.

4.1Registry Tool

The Terminal Installation package contains an additional tool that can be used to check and export registry settings to a Windows Registration file (.reg) which makes it easy to incorporate these registry settings in user logon scripts. You can find this tool in the same folder as you extracted the installationfiles into. (See chapter 3)

4.2Common settings for all OneStop Reporting Applications

HKEY_CURRENT_USER\Software\OneStop Reporting\Licenses

The values under this key specify the license numbers for the different OneStop Reporting applications.

HKEY_CURRENT_USER\Software\OneStop Reporting\Settings

The values under this key specify the Repository server name.

4.3Report Composer

OneStop Report Composer does not require any additional registry settings, but since it is a standalone Windows application a shortcut to the application is created in the Start Menu.This shortcut must be published to the user profile.

4.4Common settings for Report Designer and Report Player

There are two COM registrations under HKEY_LOCAL_MACHINE\SOFTWARE\Classes. These keys together with their corresponding CLSID are merged into HKEY_CLASSES_ROOT for each user by Windows so there should be no need to set these though a script. (See the Windows documentation about the HKEY_CLASSES_ROOT virtual key)

However, each user must have a reference to the “OSRFunctions” add-in through the key:

Excel 2010:HKEY_CURRENT_USER\Software\Microsoft\Office\14.0\Excel\Options

Excel 2007:HKEY_CURRENT_USER\Software\Microsoft\Office\12.0\Excel\Options

Excel 2003:HKEY_CURRENT_USER\Software\Microsoft\Office\11.0\Excel\Options

Note that after Excel has started the first time after installation, it may change the OPEN35 key to OPEN or OPENn where n is the number of add-ins in use.

4.5Report Designer

HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportDesigner

This key contains specifies values required for the Report Designer add-in to run in Excel.The value of LoadBehavior determines whether the add-in is enabled or not. 3 = Enabled, 2 = Disabled.

4.6Report Player 2007 (and corresponding for 2010)

HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportPlayer.Excel2007

This key contains specifies values required for the Report Player add-in to run in Excel 2007.The value of LoadBehavior determines whether the add-in is enabled or not. 3 = Enabled, 2 = Disabled.

4.7Report Player 2003

HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportPlayer.Excel2003

This key contains specifies values required for the Report Player add-in to run in Excel 2003.

4.8Report Designer and Report Player 2007/2010 security

HKEY_CURRENT_USER\Software\Microsoft\VSTO\Security\Inclusion

Office 2007 includes an additional security measure to specify which add-ins are trusted to run. The two keys for Report Designer and Report Player to pre-trust the add-ins is shown below.

  1. System integration updates

The System Integration Packages installer is available under Options. If an update is available it will show in the Status column:

  1. Appendix

OneStop Reporting Repository Content
The OneStop Reporting Repository contains information needed for the OneStop Reporting products to operate. The Repository does not store any Business data or any Reports. The following data is stored in the Repository:

-The Meta Data for the Business System

-The Connections to the Business System database

-Company configuration

-Expression trees and KPIs built by the users

-Users (for the future OneStop Reporting user authentication system)

-Licenses

-UsageLog for usage statistics of OneStop Reporting products

Troubleshooting

Microsoft Office 2010 64-Bit

Running Report Designer or Report Player on Excel 2010 64-Bit requires a registry change in order to make the products work properly. This is because the installations are currently only available as 32-bit applications.

Follow these steps:

1)Install the products as described in this document

2)Run the RegistryTool included with the Terminal Server Installation Package

3)Select the appropriate product and click the “Apply Office 2010 64-Bit fix” button

Report Composer andIntegrated Database Repository on 64-bit systems

If you want to run using Integrated database as Repositoryon 64-bit platforms you need to manually install Microsoft SQL Server Compact 3.5 SP1 32-bit and 64-bit versions.

Application startup

If the OneStop Report Designer or Report Player does not seem to work when logging on as a standard user the most likely problem is a missing registry entry.
Please note that the Report Player will not be visible until a report is opened in Excel.

Included with the Terminal Server Installation Package is autility called RegistryToolwhich can check all the necessary registry settings for the current user and report missing entries. Run this tool for users having problems to see if the registry settings have been propagated correctly to their registry hive.

How to manually check the registry keys
You can find the user’s registry hive by logging on as an Administrator and go to the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileListkey. You can then find the hive under the corresponding key in HKEY_USERS.
Below is a brief checklist of keys and most central values to verify:
[HKEY_CLASSES_ROOT\OneStop.ReportDesigner.ReportingConnector][HKEY_CLASSES_ROOT\OneStop.ReportPlayer.OSRFunctions]
[HKEY_CURRENT_USER\Software\OneStop Reporting\Licenses]

"OSR_REPORTCOMPOSER"="" xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"

"OSR_REPORTDESIGNER"="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"

"OSR_REPORTPLAYER"="" xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
[HKEY_CURRENT_USER\Software\OneStop Reporting\Settings]

"RepositoryServer"="xxxxx"
[HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportDesigner]
[HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportPlayer.Excel2007]
Office 2010: [HKEY_CURRENT_USER\Software\Microsoft\Office\14.0\Excel\Options]

Office 2007: [HKEY_CURRENT_USER\Software\Microsoft\Office\12.0\Excel\Options]

"OPEN35"="/A \"OneStop.ReportPlayer.OSRFunctions\""
Note that the OPEN key might have a different number such as OPEN1 or just OPEN. This is ok.

OneStop User Authentication:

Windows Authentication is not available on the system before Access Management has been setup by an administrator. Should you be prompted for a user login at application startup you should use the credentials for the OneStop Administrator (case sensitive):

User: Admin
Password: admin

Uninstall

The OneStop Reporting products may be uninstalled using the ordinary Windows Add/Remove approach to remove the applications.

1