OneStop Reporting 3.7 Installation Guide Updated: 2013-01-31 Copyright OneStop Reporting AS www.onestopreporting.com
Table of Contents System Requirements... 1 Obtaining the Software... 2 Obtaining Your Licenses... 2 OneStop Reporting Overview... 3 Introduction... 3 Product Overview... 3 General Product Description... 3 OSR Report Designer... 3 OSR Player... 3 OSR Publisher... 3 OSR Composer... 3 OSR Administration... 4 OSR Multi-Company (Console)... 4 OneStop Reporting Installation... 5 Read This if You Have OneStop Reporting 2.x... 5 Installing OneStop Reporting... 5 Repository Setup Wizard... 8 Creating a New Repository... 11 Unattended Installation (for Workstations)... 17 Terminal Server Installation... 18 Preparation... 18 Installation... 19 OneStop Reporting Registry Keys... 20 Common Settings for All Components... 20 OSR Report Designer/OSR Player on Windows 32-bit or Windows 64-bit with 64-bit Office... 20 OSR Report Designer/OSR Player on Windows 64-bit with 32-bit Office... 21 Miscellaneous... 22 OneStop User Authentication:... 22 Multiple Repository Databases... 22 Page i
System Requirements There are many factors that contribute to the performance of the OneStop Reporting solution, including hardware platform, network performance, number of concurrent users, number of transactions and size and design of individual reports. Performance metrics should be established once a baseline system is configured. For more details, please contact OneStop Reporting or your OneStop Reporting partner. OneStop Reporting Components Operating System Windows XP SP 3 Windows Vista Windows 7 (32-bit or 64-bit) Windows 8 (32-bit or 64-bit) Windows Server 2003 (32-bit or 64-bit) Windows Server 2008 (32-bit or 64-bit) Windows Server 2012 (32-bit or 64-bit) RAM CPU 2 GB (4GB Recommended) Intel/AMD (Dual core or more recommended) Microsoft Office Excel 2007 SP2 1+2.NET Framework Excel 2010 (32/64 bit) 2 Excel 2013 (32/64 bit) Full 4.0 or newer Other Microsoft Visual Studio 2010 Tools for Office Runtime 1. Office 2007 requires SP2 and successive updates. 2. The Office installation needs to have the.net Programmability Support option for Excel enabled. Page 1
Obtaining the Software The software can be downloaded from the Downloads area on www.onestopreporting.com. The first time you go to Downloads you must register an account. You can then immediately log in using the user name and password you registered. Two installation files are available depending on your Windows system: OneStopReporting_v3.x.xxxxx.xxxx_Setup_x86.exe for 32-bit Windows systems OneStopReporting_v3.x.xxxxx.xxxx_Setup_x64.exe for 64-bit Windows systems Obtaining Your Licenses Licenses are available from OneStop Reporting, and will be updated when there are any changes. If you have not received your licenses after you have purchased the software, please contact support@onestopreporting.com to obtain it. Page 2
OneStop Reporting Overview Introduction The OneStop Reporting product suite comprises several applications, as described below. In order to simplify installation, all OSR applications are installed from one installation file. Access to the individual applications is determined by your license. The installation file can be downloaded as described in the Obtaining the Software section. Product Overview General Product Description OneStop Reporting is a complete BI solution with modules for reporting, budgeting and dashboards/analysis. The OneStop Reporting products are 100 % integrated with a number of leading ERP systems. Report design is done with direct access to all data from the ERP system, including customized tables and fields. As all the OneStop Reporting applications connect directly to your live data from the ERP system's database, it is not necessary to have the actual business system installed on the client. OSR Report Designer OSR Report Designer is used for creating and formatting all types of reports using the OSR functionality that is integrated in the well-known Excel interface. You have full access to the tables and fields from the ERP system and will immediately recognize the business system s items and objects delivered through the Meta Data Layer while creating the report. You design reports using simple drag and drop functionality and can store and distribute the reports as you would do with any other Excel file. OSR Player OSR Player is intended for users who only need to run reports created in the OSR Report Designer. OSR Player allows the user to choose parameters prior to running a report, but the user cannot make any changes to the layout or definition of the report. OSR Publisher OSR Publisher is the tool used for running and distributing reports throughout your organization. In OSR Publisher you can set up Subscriptions to automatically run your reports at scheduled times and distribute them in various formats (for example as Excel worksheet, Web page or PDF document) by different methods, for example via e-mail or by posting to a network folder. OSR Composer OSR Composer is a ad-hoc-based query and reporting tool that is also integrated with the ERP system's database. OSR Composer is well suited for making ad-hoc queries and simple reports. In OSR Composer you work in a pivot table environment where you can play around with columns and rows to focus on the desired information. OSR Composer works as a standalone analysis tool or as a starting point for formatted reports that can be transferred to Excel or OSR Report Designer for further refining. Page 3
OSR Administration OSR Administration is the tool for setting up the system, security and access management, and licence management. OSR Administration also includes a simple integration tool for adding customized tables and fields from the integrated ERP system. OSR Multi-Company (Console) OSR Multi-Compay (Console) adds all general ledger and budget transactions for companies that you want to consolidate into a separate table. This table can then be used in the other OSR applications for running consolidated reports. Page 4
OneStop Reporting Installation Read This if You Have OneStop Reporting 2.x Prior to version 3.0, OneStop Reporting came with multiple installation files - one for each of the components OSR Report Designer, OSR Player, OSR Composer and OSR Multi-Company (Console). In addition there was a Terminal Server Package which contained all setup files in one compressed archive. From version 3.0 all OneStop Reporting applications have been merged into just two installation files, one for 32-bit Windows and one for 64-bit Windows. There is no Terminal Server Package. As a consequence of this change, all previous versions must be manually uninstalled if you are upgrading from a 2.x version to a 3.x version. Another significant change is that whilst the previous versions required registration on HKEY_CURRENT_USER, v3 only uses HKEY_LOCAL_MACHINE. This simplifies deployment on Terminal Servers and removes the need for per-user login-scripts. Existing Repository databases will be automatically upgraded. Installing OneStop Reporting 1. Log on as a Windows user with administration rights. 2. Download and run the setup file for OneStop Reporting. See Obtaining the Software on page 2 for more information about the appropriate file to download. 3. In the first window, accept the default directory or enter the destination where you want the setup files to extract to and click Install to continue. Clicking the Install button will extract the OneStop Reporting setup files to the folder that was specified in the Destination folder text box and start the setup wizard. The destination folder is a temporary folder which can be deleted after installation is complete. Page 5
4. In the Welcome window, click Next. 5. Read the License Agreement, select I Agree and click Next. 6. In the Select Installation Folder window, the default installation location for OneStop Reporting is automatically displayed. If you want the program files to reside in a different location click the Browse button to change the location. Then click Next. In Windows Vista or higher or on Windows Server 2008 it is highly recommended to use the default Program Files or Program Files (x86) folder as this is a trusted location. A trusted location has certain security privileges which are required for Microsoft Excel add-ins such as OSR Report Designer and OSR Player. Installing in a different folder will trigger the Microsoft Office Customization Installer dialog box the first time Excel is started after OSR has been installed, asking each user to confirm that the OneStop Reporting add-in should be installed for that user. Page 6
7. In the Confirm Installation window, click Next to start the installation. 8. Please wait while OneStop Reporting is installed. Note: In Windows Vista and higher, a User Account Control window may be displayed, asking you if you want to allow the following program from an unknown publisher to make changes to this computer. Click Yes when prompted. Page 7
9. If this is the first time installation of OneStop Reporting on this computer, or you are upgrading from a previous version, an additional Repository Setup Wizard will be displayed. Refer to the Repository Setup Wizard section on page 8 for more information on how to do this. If the installation detects that it is able to connect to an existing OneStop Reporting v3 repository, no additional wizard will appear. You will then see the Installation Complete window. Click Close to complete the installation. Repository Setup Wizard If this is the first time OneStop Reporting is installed on this computer, or you are upgrading from a previous version, you must complete the Repository Setup Wizard. The OneStop Reporting Repository holds all the information needed for the OneStop Reporting applications to integrate to your business system. The repository also contains various configuration data for your reports as well as security information, licenses, OSR Publisher subscriptions and other settings. The Repository does not store any business data or any reports. The Repository Setup Wizard will connect to the OneStop Reporting integration package download site using the standard Internet (http port 80) protocol to download files. If the computer you are installing on does not have Internet access, you may use the I have files option available in the relevant windows. Page 8
1. In the Repository Setup Wizard window, click Next. 2. In the Choose Repository Type window, choose either SQL Server Database (Recommended) or Integrated Database. You must always choose SQL Server Database if you have multiple users using OneStop Reporting. a. Integrated database This option allows you to use a database that comes pre-installed with OneStop Reporting. This is a file-based database which is local to your user account on your computer and which cannot be shared with other users in your organization. This means that any report configuration and settings you create are only accessible by you on your computer. Page 9
This option is recommended if you are the only person in your organization who are going to Create or Run your reports. Note: You may still publish your reports for others to read as normal Excel files. b. SQL Server database (Recommended) This option requires you to have a version of Microsoft SQL Server installed on your local computer or a network server. All users that have access to the same SQL Server will be able to share configuration and settings you set for your reports. This option is recommended if there are other people in your organization who will be running your reports or create their own. 3. If you selected Create new, refer to Creating a New Repository on page 11 to continue. If you selected SQL Server database, continue with step 4. 4. If you selected SQL Server database you will have the following choices: Create new or Connect to an existing. If this is the very first client you are installing in your environment, choose Create new. This only needs to be done once. The same repository database will be used for all other clients. For all other clients, choose Connect to existing. Then select or enter the appropriate SQL Server name in the Server field. If a connection to an existing repository is found, a green indicator icon will display if that server contains a valid repository. 4. Click Next to complete the setup. Page 10
Creating a New Repository 1. If you selected Create new, the wizard will ask you to enter the connection information for your SQL Server in order to create a repository database. a. Server: In this field, enter the name of the SQL Server and instance in the format, ServerName\Instance. If the default instance is used, only the server name is required. b. Authentication: i. If SQL Server Authentication is used, you must enter a user login which is defined in the SQL Server and which has permission to create a database and add a new user. Typically you would enter the sa user. The SQL Server Authentication method will create a new login called osruser on your SQL Server. This user is a system user for OneStop Reporting and will have read and write permissions to the OSR_Repository database. ii. If Windows Authentication is selected, the Windows user entered in the User name field must have the appropriate rights to create a database. By default, this field is automatically filled in with the currently logged on Windows user. If you enter a different user, you must also enter the password. The OSR_Repository database will be created using this user, and the user will be the owner of the database. No osruser login will be created and the repository database will be accessed through Windows authentication instead. Therefore all other users that will be using OneStop Reporting must manually be given db_datareader and db_datawriter permissions to the OSR_Repository database. See the Microsoft SQL-Server documentation for more information. Page 11
c. User name: This is the user which will be used for creating the Repository database. If you have selected Windows Authentication you may also enter a different Windows user, but then you must also provide a password. d. Password: This is the password for the user. After entering all the required information, click Next. A new Repository called OSR_Repository will be created in the SQL Server. 2. If the credentials from the previous screen were entered correctly and the user has the required rights to create the database, a success message will appear. Click OK to close the window and continue the setup process. 3. Before you can create reports you need to download and install a required System Integration Package to integrate to your business system. Select and highlight the appropriate package for your system and click Next to start the automatic download and installation of the Integration Package. Page 12
If you already have installed a System Integration Package in a previous OneStop Reporting version, you will see an Update available note in the Version column. Select the package and click Next. If you have received the System Integration Package as files, choose I have Integration Package files. You will be prompted to browse for the file. Click the button to select the file and then click OK. Repeat for each file you have received. 4. In the Install Licenses window, enter license numbers for the products you have purchased and click Next. The licenses will be downloaded and installed into the repository. Page 13
If you have received license files (.lic) you may use the I have license files option to browse and install the files manually. 5. In order to simplify licensing issues, OneStop Reporting version 3.0 or newer allows you to explicitly define which users in your organization are going to use the different components of OneStop Reporting. This list of assigned users is stored in the repository. a. If this is the first time you are installing OneStop Reporting on the computer you will see the simplified Users winidow: The The OneStop Reporting suite will be run by option allows you to quickly add a user to the list and automatically give this user access to all licensed components. You may select a user using the Lookup button to the right. b. If OneStop Reporting was installed on the computer before (i.e. if you are upgrading from a previous version) or if you chose the I want to migrate and/or setup multiple users you will be taken to the Assign Users window: Page 14
This window allows you to browse Windows users in your domain and assign them to the different OneStop Reporting components. In the section to the left you can search and select users from your Windows domain and in the section to the right you can assign the different OneStop Reporting components. Notes: A OSR component will only be displayed in the list if you have a license for that component. The number you see below the component name shows how many activations you have left on your license. This will increase/decrease when you check/uncheck components for users. You can only assign either Designer or Player to a user, not both. Domain is not included in the user name so DomainA\John is the same as DomainB\John. c. If you are upgrading from a previous version and this is the first client you are connecting to your old repository with, you will get a question asking whether to attempt to migrate users. If you answer Yes to this question, the Wizard will try to match users in your current domain with previous license activations on the OneStop Reporting license server. If the operation was successful you will get the list of users automatically assigned to the appropriate components. Page 15
Notes: This operation may be unsuccessful or only partly successful depending on whether the correct domain was used and which users actually were activated on previous OneStop Reporting versions. You may retry the operation with a different domain by choosing and expanding the Migrate users from previous versions option. OSR Publisher must always be assigned manually after the migration operation. You can always set up or change the assignments list later using the OSR Administration. 6. In the Thank You window, click Finish. This will complete the Repository setup wizard. 7. Completing the Repository Setup Wizard will take you back to the installation wizard. Click Close to finish and exit. Page 16
Unattended Installation (for Workstations) When deploying for multiple users' desktops, manually installing and going through the installation wizard for each user may be considered too tedious for the IT team. In such cases, a deployment method using regular logon scripts (such as batch files) or Active Directory Group Policies can be used. See the following Microsoft Technet article for further information about creating login-scripts: http://technet.microsoft.com/en-us/magazine/dd630947.aspx. Performing an unattended installation 1. Open Command Prompt as a Windows user with administrator rights. 2. Change directory to the folder into which the OneStop Reporting installation files were extracted (normally C:\Temp\OneStop Reporting\). 3. Start the installation by running either: msiexec.exe /q /i OneStopReportingSetup_x86.msi RepositoryServer= <servername> (x86) - or - msiexec.exe /q /i OneStopReportingSetup_x64.msi RepositoryServer= <servername> (x64) The <servername> argument must be replaced with the name of the SQL-Server instance where the OneStop Repository database was installed. This will use the osruser SQL login to access the repository database. If you are using Windows Authentication on SQL-Server you must add a ;1 suffix (for example MySqlServer;1). This will use the current logged-on Windows user to access the repository database and therefore the user also needs appropriate permissions. See also Creating a New Repository on page 11 for more formation. Refer to the Microsoft Windows Installer Tool documentation for further information about supported command-line switches. Page 17
Terminal Server Installation Preparation 1. Log on as a Windows user with administrator rights. 2. The Terminal Server needs to be configured to ensure that you are allowed to install Microsoft Installer (MSI) packages. This is done by changing a policy in the Windows Group Policy Editor. Changing policy in the Group Policy Editor 1. Choose Start >> Run, type gpedit.msc and press Enter. 2. Navigate to Local Computer Policy >> Configuration >> Administrative Templates >> Windows Components >> Windows Installer. 3. Right-click Disable Windows Installer and choose Properties. (You can also double-click Disable Windows Installer to open up the properties.) 4. Select Enabled and set the Disable Windows Installer value to Never. 5. Click OK. Manually Change the MSI Settings in the Registry: If the Group Policy Editor is not available on your server version, you can manually set this setting in the Windows Registry: 1. Open the Registry editor and navigate to: HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Windows\Installer 2. Create or modify the REG_DWORD value DisableMSI and set it to 0 (zero). Page 18
You can change this setting back after you finish installation of OneStop Reporting. Installation Please refer to the OneStop Reporting Installation section on page 5 for details on installing OneStop Reporting. Notes: Registry entries for OSR Report Designer and OSR Player are installed under HKEY_LOCAL_MACHINE. Shortcuts for OneStop Reporting components available from the Start menu are installed in All users. Page 19
OneStop Reporting Registry Keys The following section provides information about the different registry keys for the OneStop Reporting applications. Common Settings for All Components [HKEY_LOCAL_MACHINE\Software\OneStop Reporting\Settings] "RepositoryServer"="<servername>" [HKEY_LOCAL_MACHINE\Software\Wow6432Node\OneStop Reporting\Settings] "RepositoryServer"="<servername>" OSR Report Designer/OSR Player on Windows 32-bit or Windows 64-bit with 64-bit Office [HKEY_LOCAL_MACHINE\Software\Classes\OneStop.ReportPlayer.OSRFunctions] All sub keys. [HKEY_LOCAL_MACHINE\Software\Classes\CLSID\{74B6B2D2-F28A-4F03-BB6A-6B5DA5306460}] All sub keys. [HKEY_LOCAL_MACHINE\Software\Microsoft\Office\Excel\Addins\OneStop.ReportDesigner] All sub keys. Office 2007: [HKEY_LOCAL_MACHINE\Software\Microsoft\Office\12.0\Common\General] EnableLocalMachineVSTO = 1 Office 2010: [HKEY_LOCAL_MACHINE\Software\Microsoft\Office\14.0\Common\General] EnableLocalMachineVSTO = 1 Office 2013: [HKEY_LOCAL_MACHINE\Software\Microsoft\Office\15.0\Common\General] EnableLocalMachineVSTO = 1 Will be added when user starts Excel: Office 2007: [HKEY_CURRENT_USER\Software\Microsoft\Office\12.0\Excel\Options] "OPEN"="/A \"OneStop.ReportPlayer.OSRFunctions\"" Office 2010: [HKEY_CURRENT_USER\Software\Microsoft\Office\14.0\Excel\Options] "OPEN"="/A \"OneStop.ReportPlayer.OSRFunctions\"" Page 20
Office 2013: [HKEY_CURRENT_USER\Software\Microsoft\Office\15.0\Excel\Options] "OPEN"="/A \"OneStop.ReportPlayer.OSRFunctions\"" Note that the OPEN key may have a different number such as OPEN1 or OPEN35. This is OK. OSR Report Designer/OSR Player on Windows 64-bit with 32-bit Office [HKEY_LOCAL_MACHINE\Software\Classes\OneStop.ReportPlayer.OSRFunctions] All sub keys. [HKEY_LOCAL_MACHINE\Software\ Wow6432Node\Classes\CLSID\{74B6B2D2-F28A-4F03-BB6A- 6B5DA5306460}] All sub keys. [HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Office\Excel\Addins\OneStop.ReportDesi gner] All sub keys. Office 2007: [HKEY_LOCAL_MACHINE \Software\ Wow6432Node\Microsoft\Office\12.0\Common\General] EnableLocalMachineVSTO = 1 Office 2010: [HKEY_LOCAL_MACHINE \Software\ Wow6432Node\Microsoft\Office\14.0\Common\General] EnableLocalMachineVSTO = 1 Office 2013: [HKEY_LOCAL_MACHINE \Software\ Wow6432Node\Microsoft\Office\15.0\Common\General] EnableLocalMachineVSTO = 1 Will be added when user starts Excel: Office 2007: [HKEY_CURRENT_USER\Software\Microsoft\Office\12.0\Excel\Options] "OPEN"="/A \"OneStop.ReportPlayer.OSRFunctions\"" Office 2010: [HKEY_CURRENT_USER\Software\Microsoft\Office\14.0\Excel\Options] "OPEN"="/A \"OneStop.ReportPlayer.OSRFunctions\"" Page 21
Office 2013: [HKEY_CURRENT_USER\Software\Microsoft\Office\15.0\Excel\Options] "OPEN"="/A \"OneStop.ReportPlayer.OSRFunctions\"" Note that the OPEN key may have a different number such as OPEN1 or OPEN35. This is OK. Miscellaneous OneStop User Authentication: Windows Authentication is not available on the system before Access Management has been setup by the 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 The password can be changed using the OSR Administration. Multiple Repository Databases By default, the OneStop Reporting product suite uses a repository database called OSR_Repository. However, it is possible to set up multiple repositories by setting the following registry keys: [HKEY_LOCAL_MACHINE \Software\OneStop Reporting\Settings] "RepositoryDatabase"="<databasename>" [HKEY_LOCAL_MACHINE \Software\Wow6432Node\OneStop Reporting\Settings] "RepositoryDatabase"="<databasename>" Note: These keys can also be set under HKEY_CURRENT_USER, but not at both HKEY_CURRENT_USER and HKEY_LOCAL_MACHINE at the same time. Set these keys before starting OSR Administration to create a repository database. Page 22