Installing OneStop Reporting Products Contents 1 Introduction 2 Product Overview 3 System Requirements 4 Deployment 5 Installation 6 Appendix 2010 OneStop Reporting http://www.onestopreporting.com support@onestopreporting.com Version 2.1 1
1. Introduction This document describes the deployment and installation process for OneStop Reporting products. Each product comes with a free 30-day trial license included which allows you to evaluate our products before you buy. All products mentioned in this document can be downloaded from http://products.onestopreporting.com. 2. Product Overview 2.1 General product description OneStop Reporting technology utilizes a Report Engine and a Meta Data Layer to extract and process live data from your business system directly into Microsoft Excel. As all the OneStop Reporting products will connect directly to your live data, there is no need to have the actual business system installed on the client. With the Report Designer or the Report Player installed, running a report is as simple as opening the Excel workbook. 2.2 OneStop Report Designer The Report Designer is an add-in for Microsoft Excel which allows you to design and run reports directly in Excel. The tool is 100% drag-and-drop based and the user will immediately recognize their business system s items and objects delivered through the Meta Data Layer while creating the report. As the reports themselves are just ordinary Excel workbooks this allows you to utilize all the layout and formatting options of Excel and store and distribute the report as you would do with any other Excel file. 2.3 OneStop Report Player This light weight add-in is intended for users who only need to run reports created in the Report Designer. The player is available both for Excel 2007 and Excel 2003 and allows the user to set parameters and run the report as he wishes, but not do any changes to the layout or definition of the report. 2.4 OneStop Report Composer In addition, OneStop Reporting offers the stand-alone and ad-hoc query tool Report Composer. This product is a Windows based application and does not require Microsoft Excel installed in order to operate. The Report Composer is well suited for those who need an easy-to-use tool for ad-hoc queries and simple report purposes. The Report Composer may also be used as a starting point for reports that should be further developed in Report Designer. 2
2.5 Products Diagram The figure below shows a high level overview of the OneStop products and how they interact with each other and your business system. OneStop Reporting products Microsoft Excel Microsoft Excel Report Composer Report Designer Report Player Reports Report Engine & Meta Data Layer OSR Meta Repository System Database Business System Database 3
2.6 A common scenario for OneStop Reporting product usage There are typically two or three types of users in an organization that would be users of a suite of products like the OneStop Reporting products. The roles and number of people using such products would of course depend on the size and type of your organization. The figure below shows a high level overview of how the OneStop products typically may be used by different roles in your organization. OneStop Reporting Product Deployment Managers - Refreshable formatted reports Business Analysts and Controllers - Ad hoc queries - Refreshable formatted reports - Analysis Report Administrator - Creating reports Report Designer Report Player Report Composer Report Player Report Composer Reports Business System 4
3. System Requirements Supported platforms (32 or 64-bit): Windows Server 2000/2003/2008 Windows XP Windows Vista Windows 7 Supported Microsoft Office versions: OneStop Report Designer: - Microsoft Excel 2007 OneStop Report Player: - Microsoft Excel 2007 - Microsoft Excel 2003 Additional prerequisites (will be installed automatically): All products: - Microsoft.NET Framework 3.5 SP1 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) Please note that for OneStop Report Composer on 64-bit platforms you need to manually install Microsoft SQL Server Compact 3.5 SP1 32-bit and 64-bit versions if you want to run using Integrated database as Repository. 5
4. Deployment 4.1 Applications The OneStop Reporting products are installed as client based applications. 4.1.1 Report Composer OneStop Report Composer is a standalone application which is started from the Windows Start Menu. It does not require any other OneStop Reporting applications nor Microsoft Office installed to operate. 4.1.2 Report Designer The OneStop Report Designer is an addin to Microsoft Office Excel 2007 and is accessed through a custom OneStop Reporting tab on the Excel ribbon. 4.1.3 Report Player The OneStop Report Player is an also an addin to Microsoft Office Excel but does not present any user interface until a report is opened. There is also a version of Report Player which is compatible with Excel 2003. 4.2 Data Sources All OneStop Reporting products connect to two different data sources: - The Business System Data Source - The OneStop Repository The OneStop Repository is setup during installation and the Business System Data Source is setup through a data connection wizard the first time an application starts up. See the Installation section for details. 4.3 OneStop Repository The OneStop Repository holds various configuration data for your reports as well as information required to integrate to your business system. There are two options for deployment: - Integrated Database (Microsoft SQL Server Compact Edition (CE)) - SQL Server (Microsoft SQL Server Express or higher. This option requires Microsoft SQL Server pre-installed on your server.) 4.3.1 Integrated Database If you select the Integrated Database option a local file-based Repository will be installed per user. The content of the Repository cannot be shared with other users in your organization. This option is recommended if reports and settings are not going to be shared between users in your organization. 6
4.3.2 SQL Server Repository By creating a Repository on SQL Server, all users that have access to the same SQL Server will be able to share configuration and settings for the reports. This option is recommended if there are multiple people in your organization that are going to create or run reports. See the Appendix for information about the content of the OneStop Reporting Repository. 4.4 Shared Reports and Security Even though the reports created by the OneStop Report Designer are ordinary Excel files and can be stored anywhere, you should consider establishing a shared location on your network for storing the reports. When setting up this structure you should also consider whether you would define a file structure with folders having different user/user group rights so that different users may access different reports depending on their rights and roles. 5. Installation 5.1 Overview Installation of OneStop Reporting products shares a common platform and this document will therefore only show a detailed installation description for one product. Please note that special considerations need to be made when installing on a Windows Terminal Server platform. See section 5.4. 5.2 Application installation for Clients The detailed installation description is shown for Report Designer in the section below, but will apply even if you install other OneStop Reporting products like Report Composer or Report Player. Go to the download site http://products.onestopreporting.com and click on the link for your desired product. Click the Run button in the File Download dialog: 7
Click the Run button again in the Security Warning dialog: 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 and start the installation: 8
If you are installing multiple products you can still extract the files to the same directory. A subdirectory will automatically be created for each product. After the files are extracted the Setup will automatically start. If the Setup detects that some prerequisites are missing you will be prompted to install the missing components. In such a case follow the instructions in the dialogs that appear. See section 3 for more information about required prerequisites. 9
After the prerequisites are installed the Setup will commence: Next, choose the installation folder: 10
Click Next to install the files: When the file installation is complete the Repository Setup Wizard will appear. 11
5.3 Repository Wizard 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: Next, select which type of OneStop Reporting Repository you want to install. See section 4.2 for more information on which choice is best for your organization. 12
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. 13
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 required SQL Server permissions. 14
Check the Integration Package(s) applicable and click Next to automatically download and install the package(s) into your Repository: 15
The Download System Integration Packages dialog is also available from the OneStop Reporting application. See section 0. In the next screen you can enter your license numbers: If you do not have the license numbers yet, you can leave the fields blank and the OneStop Reporting applications will run with a demo license. You can then later enter a valid license number from within the applications. You do not need to enter a license number for products you are not going to install. 16
The Repository Setup Wizard is now complete and the installation will finish. 17
5.4 Application installation for Terminal Server deployment Go to the download site http://products.onestopreporting.com and click on the link to download Complete installation package for Terminal Server deployment. Click the Run button in the File Download dialog: 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: 18
Open Windows Explorer and go to the folder you extracted the files to: 19
To make sure the prerequisites are installed run PrerequisitesSetup.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 a 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: 20
5.4.1 Terminal Server configuration 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). 21
You can change this setting back after you finish installation of OneStop Reporting. 5.4.2 Terminal Server Install Mode Installing OneStop Reporting products must be done with your Terminal Server in Install mode. This assures that the registry entries needed to start the Excel addins are propagated to all users on the Terminal Server. 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 5.4 and select the.msi file of the OneStop Reporting product you wish to install: 22
Do not select any of the PrerequisitesSetup files. The Setup will now start. Refer to section 5.2 Application installation for Clients for detailed installation instructions. 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 in section 5.4.1. For OneStop Report Composer additional actions may be required to publish the Start Menu icon to all users. 23
5.4.3 Registry This section describes the registry entries required for OneStop Reporting products. If required, the USERLOGON script found under the Windows\System32 folder can be crafted to set the appropriate registry settings at user logon. Values shown in the screenshots may differ from the actual installation on your server. 5.4.3.1 Registry Export Tool The Terminal Installation package contains an additional tool that can be used to 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 files in section 5.4. 5.4.3.2 Common 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. 24
HKEY_CURRENT_USER\Software\OneStop Reporting\Settings The values under this key specify the Repository server name. 5.4.3.3 Report 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. 5.4.3.4 Report Designer HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportDesigner This key contains specifies values required for the Report Designer addin to run in Excel. The value of LoadBehavior determines whether the addin is enabled or not. 3 = Enabled, 2 = Disabled. 5.4.3.5 Report Player 2007 HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportPlayer.Excel2007 This key contains specifies values required for the Report Player addin to run in Excel 2007. The value of LoadBehavior determines whether the addin is enabled or not. 3 = Enabled, 2 = Disabled. 25
5.4.3.6 Report Player 2003 HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\OneStop.ReportPlayer.Excel2003 This key contains specifies values required for the Report Player addin to run in Excel 2003. 5.4.3.7 Report Designer and Report Player 2007 security HKEY_CURRENT_USER\Software\Microsoft\VSTO\Security\Inclusion Office 2007 includes an additional security measure to specify which addins are trusted to run. The two keys for Report Designer and Report Player to pre-trust the addins is shown below. 26
5.5 System integration updates The System Integration Packages installer is available under Options. If an update is available it will show in the Status column: 27
6. 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 - Usage Log for usage statistics of OneStop Reporting products Troubleshooting OneStop User Authentication: If you during the Application startup should be prompted for a user login, that would be the OneStop User authentication system that needs a user and password entered. The OneStop User authentication system is not enabled in this version of the product, so you should always enter the credentials for the OneStop Administrator which is (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. 28