OneStop Reporting OSR Portal 4.6 Installation Guide

Transcription

1 OneStop Reporting OSR Portal 4.6 Installation Guide

2 Doc. Version 1.0 Updated: 11-Jan-16 Copyright OneStop Reporting AS Contents Introduction... 1 For companies already using OneStop Reporting... 1 System requirements... 2 Technical considerations... 3 When SQL Server is not in the same domain or VLAN as IIS... 3 When SQL Server and IIS is on the same domain but not on the same physical server... 3 SSL (Secure Socket Layer)... 3 Customizing the web address (URL) for your OSR Portal... 3 Silverlight on the server... 4 Obtaining the software... 4 Obtaining your licenses... 4 Before installing OSR Portal Windows Process Activation... 5 Preparing MSDTC for use with OSR Portal... 6 Open firewall for MSDTC... 7 Installing OSR Portal Configuring OSR Portal Setting up the repository and installing integration package and license keys Appendix 1 Technical Information OneStop Reporting Registry Keys Common Settings for All Components Multiple repository databases Miscellaneous OneStop user authentication... 18

3 Introduction This is the installation guide for OSR Portal 4.6. OSR Portal 4.6 requires OneStop Reporting 4.6 and cannot be used with previous versions of OneStop Reporting. For a successful installation, three steps must be completed: 1. OSR Portal must be installed on the IIS Server. 2. OSR Portal must be configured in the OSR Administration module. 3. OneStop Reporting 4.6 must be installed on each client that will use any other OSR Module. Start with the installation of OSR Portal on the IIS Server as described in this document. Then configure OSR Portal (described in the OSR Administration user guide). Finally, install or upgrade to OneStop Reporting 4.6 on each client that will access any of the other OSR Modules (described in the OneStop Reporting 4.6 Installation Guide.) For companies already using OneStop Reporting If you are an existing OneStop Reporting customer (using OneStop Reporting 3.7 or older) you must uninstall OneStop Reporting from all clients before installing OneStop Reporting 4.6 on these clients. Uninstalling removes OneStop Reporting applications only. Your repository and data remain intact for continued use. During the installation process, you will connect to your existing repository. If you have an existing OneStop Reporting repository (existing users), make a backup of the repository before starting the OSR Portal or OneStop Reporting 4.6 installation. If you are upgrading from an earlier version of OSR Portal your host name bindings in IIS will persist. Side 1

4 System requirements See the section below for the system requirements for installing and running OSR Portal 4.6. System Requirements for OSR Portal User Rights Operating System RAM CPU Microsoft Office.NET Framework Server Printer Services SQL Server Client Web Browser The user who will perform the OSR Portal installation must have Administrator privileges on the server and must be able to access Active Directory on the domain. The user must be member of the SYSADMIN role on SQL Server or have the SQL Server sa login password available during installation. Windows 7 (32/64-bit) Windows 8 (32/64-bit) Windows Server 2008 (32/64-bit) Windows Server 2012 (32/64-bit) 2 GB (4GB Recommended) Intel/AMD (Dual core or more recommended) Excel 2007 SP3 Excel 2010 (32/64 bit) 2 Excel 2013 (32/64 bit) Full or newer IIS 7 or newer (with ASP.NET support) Microsoft XPS Document Writer MSDTC (Microsoft Distributed Transaction Coordinator) 2008 or above IE9 or higher, Chrome Notes! 1 Office 2007 requires SP3 and successive updates. 2 The Office installation needs to have the.net Programmability Support option for Excel enabled. Side 2

5 Technical considerations When SQL Server is not in the same domain or VLAN as IIS If you host your web server in a different network or in a DMZ with a firewall between it and SQL Server, the Repository Setup Wizard might fail with an MSDTC error message when creating or upgrading the repository. In this case, follow these steps to set up the repository: 1. Cancel the Repository Setup Wizard. The installation will continue by opening your browser and starting OSR Portal. You will then see a message stating that the repository is not set up correctly. Disregard this message and close the web browser. 2. Open Windows Explorer and locate the OSR Portal installation folder (normally C:\Program Files\OneStop Reporting). 3. You will see a folder called Administration. Copy this folder to a network share or removable drive (USB stick) so you can access it from the SQL Server machine. 4. On the SQL Server machine, log on as an Administrator and start OSR Administration by running the AdminTool.exe file located in the Administration folder. 5. When OSR Administration starts it will display the Repository Setup Wizard automatically and you can continue with the repository setup. 6. Go back to the web server and start OSR Administration from the Windows Start menu. 7. If OSR Administration is able to connect to the repository, you will get to the login dialog and can continue. Otherwise, the Repository Setup Wizard will start again and you can select Connect to existing and enter your SQL Server name. You can then complete the Repository Setup Wizard normally. 8. Start OSR Portal from the Start Menu or by opening your browser to When SQL Server and IIS is on the same domain but not on the same physical server Make sure MSDTC is enabled and appropriately configured on both servers. For correct setup of MSDTC, refer to the section Before installing OSR Portal 5 on page 5. SSL (Secure Socket Layer) In order to activate SSL on OSR Portal you must first check the Enable SSL for OSR Portal option under System Settings in the OSR Administration module. Then you need to configure IIS appropriately as described here: See the Microsoft Internet Information Services documentation for more information. Customizing the web address (URL) for your OSR Portal You can set up your own host name binding (or domain name binding) for accessing OSR Portal using the IIS Manager under Bindings. By setting up OSR Portal with a default binding where Side 3

6 host name is blank, users on the LAN can access OSR Portal by using its server name, for example: See more information about Bindings in the Microsoft IIS documentation: Make sure you have configured Windows Firewall to allow WWW Services to communicate through it. Silverlight on the server OSR Portal does not require Silverlight installed on the server in order to work properly. If you, however, want to run OSR Portal on your server s web browser for testing purposes you must install Silverlight. By default, Internet Explorer will block the Silverlight download, so make sure you have added to the list of Trusted sites in Internet Options, Security before following the on-screen instructions to install Silverlight. Obtaining the software You will receive a link to download the OSR Portal 4.6 installation files from OneStop Reporting or your OneStop Reporting partner. OSRPortal_v4.6.xxxxx.xxxx_Setup.exe This installation covers both 32-bit and 64-bit systems. Obtaining your licenses Licenses are available from OneStop Reporting or via your OneStop Reporting partner. If you have not received your licenses after you have purchased the software, please contact support@onestopreporting.com to obtain it. Side 4

7 Before installing OSR Portal 4.6 The Application Server role must be installed and the Windows Process Activation Service Support enabled. The system requirements for OSR Portal state that Microsoft Distributed Transaction Coordinator (MSDTC) is required. Before stating the installation of OSR Portal 4.6, you should make sure the MSDTC is set up correctly for use with OSR Portal Windows Process Activation In order for Internet Information Services to properly handle communication with the OSR Portal Silverlight application the Application Server role must be installed. Furthermore, the Windows Process Activation Service Support feature and specifically its HTTP Activation option must be enabled. The following features of the Application Server role are required: -.NET Framework Distributed Transactions (see next section) - Windows Process Activation Service Support o HTTP Activation Side 5

8 Preparing MSDTC for use with OSR Portal If IIS Server and SQL Server are not located on the same physical computer, the operations described below must be performed on both servers. 1. In the Start menu, locate Administrative Tools >> Component Services. 2. Choose Component Services >> My Computer >> Distributed Transaction Coordinator. 3. In the work area to the right, right click Local DTC to open the properties dialog for Local DTC. 4. Choose the Security tab. 5. Under Security Settings check Network DTC Access and check Allow Remote Clients under Client and Administration. Under Transaction Manager Communication check Allow Inbound and Allow Outbound. (Keep Mutual Authentication Required and Enable SNA LU 6.2 Transactions selected (default settings).) 6. Choose OK to save. Side 6

9 Open firewall for MSDTC 1. Go to Control Panel >> System Security>> Windows Firewall. 2. In the area to the left, choose Allow a program or feature through Windows Firewall. 3. In the page that is displayed, find Distributed Transaction Coordinator and check the Domain and Home/Work (Private) boxes. 4. Click OK to save. Side 7

10 Installing OSR Portal Make sure you have administrative access to SQL Server. The user must be member of the SYSADMIN role on SQL Server or have the SQL Server sa login password available during installation. Alternatively you may use Windows Authentication. 2. Uninstall the v3.8.xxxx or earlier versions of OSR if installed. (OSR Portal requires OneStop Reporting 4.6. You can install OSR 4.6 after the OSR Portal 4.6 installation and configuration is complete. See the OneStop Reporting 4.6 Installation Guide for instructions.) 3. Locate and start the file OSRPortal_v4.x.xxxxx.xxxx_Setup.exe. In the Welcome to the OSR Portal Setup Wizard page, choose Next. 4. In the next dialog, accept the license terms and choose Next. 5. Choose a location for the application files or accept the default location and choose Next. Side 8

11 6. Choose Install to start the installation. A window indicating the progress of the installation is displayed. Side 9

12 7. When the installation is complete, a success message is displayed and the OSR Repository Setup Wizard will start automatically. Choose Close in the message window to close it. See the next section for instructions on how to set up your repository and perform the other required configuration tasks. Side 10

13 Configuring OSR Portal When OSR Portal has been successfully installed, you must set up your repository and configure users and roles. Setting up the repository and installing integration package and license keys To set up your repository and install your integration package and license keys, you use the Repository Setup Wizard. If your organization is already using OneStop Reporting, you have an existing OneStop Reporting repository and we strongly recommend that you make a backup of this repository before performing you start this procedure. 1. In the Repository Setup Wizard window, click Next. 2. In the Choose Repository Type window, choose SQL Server Database (Recommended). Side 11

14 3. For SQL Server Repository you have two options: Create new or Connect to an existing. a. If you are a new OneStop Reporting user and OneStop Reporting has never been installed on any servers/clients in our organization, choose Create New and then click Next. Then continue with step 4. b. If your organization is already using OneStop Reporting, you have an existing OneStop Reporting repository, and you want to connect to this repository. Choose Connect to existing and click Next. Then continue with step 4. Side 12

15 4. On the page that is displayed, enter the connection information for your SQL Server in order to create a repository database. (When you are connecting to an existing repository, the page displayed looks slightly different than the illustration below.) Server Authentication 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. 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. 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. Please, note that MSDTC might not work properly unless the machine in question is in a domain. Side 13

16 The OSR_Repository database will be created using this user and the user will be the owner of the database. A machine account (<domain>\<machine>$) login will also be created and given full access to the database. If the SQL Server is on the same server as the Portal, the virtual account for the IIS Application Pool (IIS APPPOOL\OSR Portal) will be created instead of the machine account. No osruser login will be created and the repository database will be accessed through Windows authentication instead. Therefore, all users that will be using any other OSR Module must manually be given db_datareader and db_datawriter permissions to the OSR_Repository database. See the Microsoft SQL-Server documentation for more information. User name Password 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. This is the password for the user. 5. After entering all the required information, click Next. If you selected Create new: If the information in the previous screen was entered correctly and the user has sufficient rights to create the database, a new repository called OSR_Repository will be created in the SQL Server and a dialog notifying you that the repository was successfully created will be displayed. If you selected Connect to existing: Once the upgrade is complete, a dialog notifying you that the repository was successfully upgraded will be displayed. This dialog may also show other upgrade notes (Upgrade completed with messages). The messages can be purely informational or may require you to take action. Side 14

17 5. In the repository created/upgrade completed page, click OK to close the window and continue the setup process. The page for installing the required system integration package opens automatically. 6. Select and highlight the appropriate system integration package for your system and click Next to start the automatic download and installation of the package. 7. 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. Side 15

18 If you are upgrading from a previous version of OneStop Reporting, your current license keys will be displayed for the modules you have purchased. You must, however, add the OSR Portal license key. 8. In the Thank You window, click Finish. This will complete the Repository setup wizard. If the configuration was successful your Internet browser will open automatically and connect to the OSR Portal. A login screen for OSR Portal will be displayed. If you want to log in at this point, make sure that Silverlight is installed on this server. (If you attempt to log in and Silverlight is not found on the server, you will get prompted to install Silverlight.) Side 16

19 Before OSR Portal can be accessed from clients, IIS and the web site must be set up correctly. For information about setting up IIS, refer to the IIS documentation. Before you start using OSR Portal in the organization you should continue to set up your data connection and configure users and roles. This is described in the OSR Administration User Guide in the sections Setting Up a New Data Connection, Adding Active Directory Users (for adding users) and Managing Roles and User (for creating roles and assigning users to roles). Side 17

20 Appendix 1 Technical Information OneStop Reporting Registry Keys The following section provides information about the different registry keys for the OSR Portal. Common Settings for All Components [HKEY_LOCAL_MACHINE\Software\OneStop Reporting\Settings] "RepositoryServer"="<servername>" [HKEY_LOCAL_MACHINE\Software\Wow6432Node\OneStop Reporting\Settings] "RepositoryServer"="<servername>" 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. 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 OSR Administration. Side 18