QRM Installation Guide Windows

Transcription

1 1 The Compatible with LabVIEW logo is a trademark of National Instruments Corporation and is used under a license from National Instruments Corporation. 1

2 2 Contents 1 Document Change History Documents and Abbreviations Reference Documents Abbreviations Introduction System Requirements Readers Guide Downloads Overview Installing the SQL Server Configuring the Database Configure ODBC (optional) Installing.NET Framework 4 ( 7 only) Installing.NET Framework 3.5SP1 ( 8 only) Installing the QRM Web Service Enable IIS Microsoft Internet Information Service Importing QRM Web Application into IIS Changing the IIS Application Pool Timeout (optional) Testing the Web Application Customizing Company Logo and Colors (optional) Using QRM with XP Support Troubleshooting Firewalls IIS QRM Web Service License Activation License Deactivation License expired Database Connection Strings Users and Passwords No Results in the QRM Web Application

3 3 1 Document Change History Version Comment Author 1.0 First version. Thomas Olsson 1.1 Updated database section. Mattias Ericsson 1.2 Updated with more general descriptions + Mattias Ericsson 8 support. 1.3 Updated with 2008 Server + Mattias Ericsson Customization of logo. 1.4 Added Application Pool section. Mattias Ericsson 2.0 Updated with license management and Mattias Ericsson. reviewed. 2.1 Updated to also support 8.1 Mattias Ericsson 2.2 Updated and removed unnecessary installations after review. Improved Troubleshooting section. Mattias Ericsson 2 Documents and Abbreviations 2.1 Reference Documents Ref Doc Nr Document Name Content [1] QRM Quick Start Guide Start Guide 2.2 Abbreviations IIS Install CD QRM Internet Information Services Microsoft The installation media location 3

4 4 3 Introduction QRM is a web based result management system for storing and analyzing test results. It is a flexible system using web servers, databases and ATML XML data which can be setup on a single computer, servers or cloud solutions. Storage System Storing and synchronizing test data in over the internet using ATML and web services to a SQL Server database in a robust and secure way. Presentation and Analysis System Presentation, report and statistical analysis of test data through a web page. QRM clients post the test results as ATML XML reports to HTTP web service that will forward over a secured internet connection or store test results to the QRM result database. Sites can be connected together easily by the distributed architecture of QRM. By using the QRM Web application, test results can be viewed and analyzed as they are produced. 3.1 System Requirements 7, 8, Server 2008R2 or Server bit and 64-bit Min 2GB RAM, 8GB recommended SQL Server 2005, 2008R2, 2012 and Readers Guide This is a guide to setting up a QRM installation manually. It is highly recommended that all steps are done in order, as the descriptions may be dependent on previous steps. Not all steps needs to be performed, since QRM may be configured in many ways depending on the needs and IT infrastructure. It is strongly recommended to first setup one single station with QRM Web service, QRM Web Application running on an IIS installation and a SQL Server Express installation with all needed databases. Please refer to ref [1] first if not already done that. 3.3 Downloads This document contains download links to Microsoft SQL Server Express, IIS extensions and.net Framework. To make it simpler, these links are also available at: This also contains the latest downloads available. 4

5 5 4 Overview This guide will help you set up the simplest possible QRM installation. The installation is done on one computer which will host the QRM Web Application and QRM Web Service, both connected to a database. Both the QRM Web Application and QRM Web Service uses HTTP. QRM Web Application is hosted by a Microsoft IIS Web Server, default listening to port 80. QRM Web Service is hosted by a Service and default listening to port Presentation & Analysis System Storage System QRM Web Application QRM Web Service localhost/qrm IIS ASP.NET Application localhost:8080/qrmresult NI Service QRM Result Database Data SQL Database ODBC QRM Data Source Figure 1. QRM overview. Note that ODBC is optional, a direct link directly to SQL Server may be used. The following steps are required to setup a QRM system: 1. Install (optional) or use an existing SQL Server 2005/2008/2012 (any version) 2. Create databases and a database user 3. Configure ODBC (optional) 4. Install Microsoft.NET 3.5SP1 (only 8) 5. Install Microsoft.NET 4 (only 7) 6. Install and configure QRM Web Service 7. Enable IIS 8. Install Administration tools for IIS 9. Install QRM Web Application 5

6 6 5 Installing the SQL Server The following instruction shows how to install a simple SQL 2012 Express. Depending on situations, there are many choices on database management. Any 2005/2008/2008 R2/2012/Azure can be used. All versions supported from the largest Enterprise versions to smallest Express versions. 1. Install SQL Server Express 2012 a. Depending on 32 or 64-bit system, select the appropriate installer for SQL Server. To determine your system type, open the Control Panel System item by pressing your keyboard s key+pause or by clicking on the Start menu>control Panel>System And Security>System. The system type is displayed as shown below. SQL Server 2012 Express can be downloaded from: Make sure you get an installation package that contains the tool: SQL Server Management Studio 6

7 7 b. Run the SQL Installer and when the installer starts, select New SQL Server. c. Tick I accept the license terms and then Next. The installer will start installing. d. You might be asked to restart the system. If the installer seems to have stalled, this dialog is likely hidden by the installer window. Click OK to have the installer continue. 7

8 8 e. Click Next. f. Click Next until the Database Engine Configuration is displayed. Click on Mixed Mode and choose and enter a password for the administrator/super user of the database. Click Next. Click Next until you reach Installation Progress. 8

9 9 g. You might be asked to restart the system after install. Click OK. 9

10 10 h. Click Close i. Close the window 10

11 11 6 Configuring the Database The SQL Server database must be setup correctly with a user and a database. The following steps show how to add a user and set up the database from a SQL script. 1. Start the SQL Server Management Studio. 2. Click Connect. 11

12 12 3. Right-click on Databases and select New Database. 4. Select a Database name (enter QRMResultDatabase) and press OK. An empty database is now created. 12

13 13 5. Select File->Open->File (or CTRL+O). Browse to the folder <Install CD QRM>\QRM\Database scripts Select the QRMModel.edmx.sql file and then click Open. 6. Click the script tab to select the script and click the Execute button to run the sql script. Make sure that the database selected in Available Databases is correct before pressing Execute (click CTRL+U to select that list, indicated with red ring in picture below) 7. Repeat 3 through 6 and create one more databases called: 13

14 14 Aspnetdb. Open and execute the sql-scripts called InstallCommon.sql, InstallRoles.sql and InstallMembership.sq, in order. Remember to check that aspnetdb is the active database before executing the scripts. 14

15 15 8. Expand the Security and right-click Logins. Select New Login. In the General tab, select a Login name (TestUser will be used in this guide) and Password and tick SQL Server authentication. Make sure User must change password at next login is not selected. Deselect Enforce password policy may also be good, but it is up to your IT security policy to create the SQL user as you require. authentication may also be used if need. It doesn t matter which user you create as long as you provide the correct database connection string. 15

16 16 9. In the User Mapping tab, tick the Map tickbox and make sure you select role membership owner for each database. Repeat for all three databases. Click OK. 16

17 17 7 Configure ODBC (optional) The QRM Web Service (running as a background service) may use different kind of database connector adapters. If ODBC is used, the follow the instructions below, else the section may be skipped. Note that QRM Web Service is a 32-bit application and the 32-bit ODBC administrator must be used. 1. Open the ODBC administrator. For a 32-bit, directly from Administrative tools as shown below. For 64-bit, open the 32-bit ODBC administrator from: C:\\SysWOW64\odbcad32.exe 17

18 18 2. Click the System DSN tab and click Add 3. Scroll down and select SQL Server, then click Finish. 18

19 19 4. Name the database QRM. Click Next. 5. Enter the Login ID and Password as you entered it in section 6 step 8. Click Next. 19

20 20 6. Change the default database to QRMResultDatabase. Click Next. 7. Deselect Use strong encryption for data and click Finish. 20

21 21 8. Click on Test Data Source to make sure the connection works. 9. Click OK. 21

22 Click OK. 22

23 23 8 Installing.NET Framework 4 ( 7 only) On 7 (and XP), the.net Framework 4 needs to be installed (already preinstalled on 8). Please download and follow instructions from: 9 Installing.NET Framework 3.5SP1 ( 8 only) By default, the.net framework 3.5SP1 is not installed on 8 (already preinstalled on 7). In Control Panel, choose Programs and Features, choose Turn features on or off, and then select the.net Framework 3.5 (includes.net 2.0 and 3.0) check box. This option requires an Internet connection. You do not need to select the child items. For more information follow the link below: 23

24 24 10 Installing the QRM Web Service The QRM Web Service is a background Service that is installed by a standard installer. This is a 32-bit windows service that is used on both 32-bit and 64- bit operating systems. The purpose of the QRM Web Service is to receive XML ATML test data and store the data in the database and/or forward XML ATML test data to another QRM Web Service. It is recommended to use a multicore computer, since performance is increase by parallel processing of the XML results. 1. Browse to <Install Path>\QRM\QRM Web Service\<version>. Rightclick on the setup.exe and select Run as administrator. 2. Click Next. 24

25 25 3. Click Next. 4. Click Next. Installation is complete. If there is any error messages regarding timeout, just ignore these. 25

26 26 5. Open C:\Users\Public\Documents\QRM\QRMWebServiceConfig.ini with Notepad or any text editor. 6. Configure the QRM Web Service database connection (optional). If the web service should store to a database set the following key: StoreDatabaseActive=TRUE The QRM Web Service can be set up to use ODBC or SQLServer database provider adapter directly. Using ODBC (make sure there exists a ODBC as shown in in section 6): DatabaseProviders='ADODB' DatabaseConnectionStrings='DSN=QRM,TestUser,<TestUsersPassword>' Replace <TestUsersPassword> with the password you selected for the TestUser user in section 6, step 8. Using SQLSERVER: DatabaseProviders='SQLSERVER DatabaseConnectionStrings='Data Source=<server>\<instance>; Initial Catalog=QRMResultDatabase; User Id=TestUser; Password=<TestUsersPassword>; MultipleActiveResultSets=True' Example: DatabaseConnectionStrings='Data Source=.\sqlexpress; Initial Catalog=QRMResultDatabase; User Id=TestUser; Password=<TestUsersPassword>; MultipleActiveResultSets=True' Replace <TestUsersPassword> with the password you selected for the TestUser user in section 6, step Configuring the QRM Web Service forward connection (optional). If the web service should forward the ATML XML result to another QRM Web Service set the following key: ForwardingActive=TRUE ForwardingURLs=' Replace <URL> with the IP-address of the web service to forward data to. 8. Save the file. 26

27 27 9. Open a web browser and enter in the address field. This will show the status page for the QRM Web Service. 10. QRM Web Service needs to be activated. Press Activate. If there is a password promt enter user qrmuser and password qrm123! which is the default login. Enter the license key that has been provided by AddQ. Note that there are different keys for QRM Web Service and QRM Web Application. 27

28 28 Press Activate to automatically authenticate and register the license though internet. A.lic license file will be created in: C:\Users\Public\Documents\QRM If no public internet access is available, follow the onscreen instructions and please visit: to manually activate and download the license file. Please follow onscreen instructions. If license is not actived, no database storage or forwarding of results are possible. Only local storage of ATML XML files are allowed. When activated successfully QRM Web service should look like below. 28

29 If you click any buttons in this window, you will be prompted for login. Default login is qrmuser with password qrm123!. The login is set in: C:\Users\Public\Documents\QRM\QRMWebServiceConfig.ini Change the following keys to change login: AuthUsername=qrmuser AuthPassword=qrm123! 29

30 30 11 Enable IIS Microsoft Internet Information Service Next step is to enable the Microsoft web server, IIS. If not already activated, please follow the steps below. 1. Open the Control Panel and click Programs. 30

31 31 2. Click on Turn features on or off. 3. Select Internet Information Services and click OK. 31

32 32 4. IIS will now install. 5. Make sure ASP.NET is activated for IIS. Expand the World Wide Web Services->Application Development Features and make sure ASP.NET is checked. 6. Install Web Deploy from Use Typical installation. 32

33 33 7. Open the IIS Manager by clicking Start and typing inetmgr. Then close the manager window again. It can also be launched from Control Panel -> Administrative Tools -> Internet Information Services. 8. (Optional) Install IIS Manager for Remote Administration from (not needed for 2008 Server). On the webpage, click Install this extension and follow the instructions At the end of the installation, the following dialog will appear. Click Exit. 9. (Optional) Install Server AppFabric from Select ServerAppFabricSetup_x86_<ver>.exe for 32-bit operating systems or ServerAppFabricSetup_x64_<ver>.exe for 64-bit operating systems. During installation, let all options be default and keep clicking Next and then Install. 33

34 34 12 Importing QRM Web Application into IIS 1. Open the IIS Manager by clicking Start and typing inetmgr. In IIS Manager, expand the Server node (your computer) and the Sites node, and then select the Default Web Site. In the right-hand Actions pane, click the Import Application link. Enter or browse to the QRMWebApplication.zip-package on the installation CD: <Install CD QRM>\QRM\IIS WebApplication\<version>\QRMWebApplication.zip. 34

35 35 2. Keep clicking next until the Enter Application Package Information dialog appears. Enter QRM in the Application Path. The Connection Strings needs to be corrected, but this guide will show how to do it after installation. Click Next. 3. Click Finish. 35

36 36 4. The QRM web application is now installed. 5. Click QRM and then double click Connection Strings i the Features view. 36

37 37 6. Double click Edit the Custom strings for Application Services and QRMContext to match: Application Services Data Source=.\SQLEXPRESS;Initial Catalog=aspnetdb;User Id=TestUser;Password= ;MultipleActiveResultSets=True QRMContext metadata=res://*/qrmmodel.csdl res://*/qrmmodel.ssdl res://*/qrmmodel.msl;pro vider=system.data.sqlclient;provider connection string="data Source=.\SQLEXPRESS;Initial Catalog=QRMResultDatabase;User Id=TestUser;Password= ;MultipleActiveResultSets=True" The black dots ( ) hides the users password, but you can edit it here if you change the password. 7. Done. Please see web resource on on how to tune performance and how to setup SSL etc Changing the IIS Application Pool Timeout (optional) The IIS has a default timeout of 20 minutes when there is no users of the web page. When there is an inactivity timeout, the application pool hosting the QRM web application will be stopped and there will not be any background statistics calculation. It is therefore recommended to increase the application pool timeout. 1. Open the IIS Manager and select Application Pools in the tree view to the left. 37

38 38 2. Right-click and select Advanced Settings. Change the Idle Time-out (minutes) from 20 to

39 39 13 Testing the Web Application 1. Open the web application in a web browser, entering the URL: For an empty database, the site should start directly. 2. Login using Username administrator and Password abc123. You will be prompted to change password, do so. 3. Click on Manage Users and then Register New User. Enter a User Name and click Create User. 39

40 40 4. Click Log Out in the upper right corner and login using the newly created user using password abc Activate QRM Web Application. Select About tab. Enter the license key that has been provided by AddQ. Note that there are different keys for QRM Web Service and QRM Web Application. 40

41 41 Press Activate to automatically authenticate and register the license though internet. A.lic license file will be created in: C:\Users\Public\Documents\QRM If no public internet access is allowed, follow the onscreen instructions and please visit: to manually activate and download the license file. Please follow onscreen instructions. If no license is entered, only calls from localhost with administrator roles is allowed. This way, the QRM Web Application can be installed on a development computer without license and with no limitations. 41

42 42 14 Customizing Company Logo and Colors (optional) It is possible to change the QRM Web Application logo and color in following files: C:\inetpub\wwwroot\QRM\Styles\logo.gif C:\inetpub\wwwroot\QRM\Styles\Site.css Just replace the logo.gif with your company logo, and modify the Site.css for changing the background colors of buttons, headers etc. There is no need to restart the IIS, but a refresh in the browser is necessary. 15 Using QRM with XP It is possible to install the QRM Web Service on a XP SP3 machine, but it is not possible to install the QRM Web Application and IIS. If QRM Web Service should be installed, the.net Framework 3.5 needs to be installed on XP SP3. Please download and follow the instruction below: The QRM Web Service configuration file may be found at: C:\Documents and Settings\All Users\Documents\QRM\QRMWebServiceConfig.ini 16 Support If you have questions, please post them at the QRM Community: If you don t have access to the community, please click Ask to join this group. For any question, feel free to contact AddQ support at: support@addq.se 42

43 43 17 Troubleshooting If you run into trouble, first go through this guide again and make sure you have all settings correct. Also try to verify that you can access the database with the login and also make sure you can reach the different servers. Database connection strings are a very common source of problems Firewalls Make sure there are no firewalls blocking traffic. The default TCP ports used are: SQL Server port 1433 and 1434 (UDP) QRM Web Application port 80 (https: 443) QRM Web Service port 8080 (https: 8081) 17.2 IIS A good source of troubleshooting your IIS installation is: If the ASP.NET v4.0 support is missing (e.g. Application pool ASP.NET v4.0 is missing) there is a need of reregistering the.net 4 Framework in IIS. Run the following command line (as administrator): C:\\Microsoft.NET\Framework\v \aspnet_regiis.exe i If the short cut to the Internet Information Services is missing in the Control Panel- >Administration tools, it can manually be started from: C:\\System32\inetsrv\InetMgr.exe 17.3 QRM Web Service If the QRM web service does not start, make sure.net 3.5 is installed ( 8) and also try to reboot your computer License Activation Both the QRM Web Service and QRM Web Application needs to be activated. During activation, the AddQ activation server is contacted to create a license file that is automatically installed. The licenses have no expire date. Only evaluation licenses have expiration. If the activation is unsuccessful check the following: 43

44 44 1. Make sure you can reach The page as shown below should appear. There might be a proxy that is causing the problem. Manual activation through a web browser might solve the problem. 2. If your computer that needs to be activated does not have access to public internet and cannot reach addq4.se, try use a different computer with public access to addq4.se to manually create the license files. This is described in section Notice that there are different license keys for QRM Web Application and QRM Web Service. There is only one activation for the QRM Web Application and ten activations for the QRM Web Service. If you need more license keys, please contact AddQ at sales@addq.se. 4. If you still got problems with activation please contact AddQ support at support@addq.se License Deactivation If you need to deactivate a license key, this can be performed within the QRM Web Service and QRM Web Application the same way as activation, but the buttons are now called Deactivate. Both the QRM Web Application and QRM Web Service automatically connect to addq4.se to deactivate and unregister the computers. If your computer has no public internet access to addq4.se, you can manually deactivate the computer at:

45 License expired If your license has expired, you are running an evaluation license. The evaluation licenses are time-limited, but without any limitation in functionality. Please contact AddQ at for information of how to buy a full license. If your license has expired the following happens: QRM Web Application The web page can only be reach from a localhost call (the same computer as the IIS server is running) and only logins with administrator rights can be used. It is fully functional in all other ways. QRM Web Service Database storage and forwarding are disabled regardless of the configuration file. ATML reports are still stored to disk if configured. This way it is possible to collect ATML reports and when a new QRM license is entered, the ATML XML files can manually be uploaded through the QRM Web Service and posted to the database afterwards. Please refer to the QRM Quick Start Guide ref [1] Database Connection Strings There are three connections strings that must be setup correctly: 1. QRM Web Service This connection string is used for storing data in the QRM Result Database and is configured in: C:\Users\Public\Documents\QRM\QRMWebServiceConfig.ini Please refer to section 10 of how to setup the connection string. Make sure that all non-used connection strings are disabled or removed. Notice that the QRM Web Service needs to be restarted for the setting to be updated. This can easily be done by open the following URL in your web browser: (default username: qrmuser, password qrm123!) Then press Start button. 2. QRM Web Application There are two connection strings, one for connection to the QRM Result Database and one for the connection to aspnetdb where the users of the web application are stored. Both these connection strings can be edited from the IIS Manager. Launch the IIS Manager from the Control Panel->Administrative Tools->Administration Tools->Internet Information Services (IIS) Manager. 45

46 46 In the IIS Manager you can edit the connection strings by selecting the QRM web application and then double click on the Connection Strings in the ASP.NET section as shown in Figure 2 below. Figure 2. The connections strings can be edited in the ASP.NET section of the QRM Web Application in the IIS Manager. Figure 3. The Yellow Screen of Death when QRM Web Application failed to start due to a problem with the connection string. Usually the error message is quite good specifying the cause of the problem. 46

47 Users and Passwords There are many users and passwords that need to be configured in order to maintain security, but this can be a bit confusing in the beginning. The following default users and passwords are used: QRM Web Application QRM Web Service Username Password Comment administrator abc123 (prompt on first login to change) The web application has its own users and all users are created within the web application from an administrator. qrmuser qrm123! All calls from QRM Clients and also thrugh web browser to the Web Service requires authentication. The user and password are configured in the C:\Users\Public\Documents\ QRM\QRMWebServiceConfig.ini SQL Databases TestUser Test The connection strings to database calls need to contain authentication to SQL Server. These passwords are configured within SQL Server Management Studio. This guide uses the username and password as stated to the left. QRM Demo Web Application at addq4.se/qrm TestUser qrm123! This is the only available user on the demo QRM Web Application at addq4.se/qrm. Table 1. Overview of the user names and passwords in QRM. 47

48 No Results in the QRM Web Application If everything appears to be installed correctly and your QRM clients have posted results, but there still is no QRM results in the QRM Web Application. Please check the following: QRM Web Application 1. Overview Tab these results are background calculations and are updated every 15 minute by default. Please wait a while or if you log in as administrator, press the Update button to force an update of the calculation. It might still take a few seconds for the statistics to finish. 2. Test Results Tab Press Execute without any changes in the filter. If you have uploaded old ATML XML reports afterwards, make sure the start date and stop date interval is correct. Default is the last week from today. QRM Web Service 1. Make sure that license is activated. If no license is activated, there will be no database storage available. You need an evaluation license to be able to store results in the database. 2. Make sure you really activated database storage in the C:\Users\Public\Documents\QRM\QRMWebServiceConfig.ini 48

49 49 Make sure the keys are set correctly: DatabaseConnectionStrings=<your connection string> StoreDatabaseActive=TRUE Also make sure to deactivate or remove non used keys from the example connection strings. Check that everything is ok, by open in your web browser. Scroll down to Database storage and make sure it is set to TRUE as shown below. Also check the Last error message to make sure there are no connection errors. If you suspect there is connection problems with the database, enable the logging feature by setting the key UseLog=True in the configuration file. By default, the log files appear in: C:\QRM\QRMLog 49

50 50 3. Make sure that the QRM Web Service actually received the ATML test report. Look at the # of success result requests. 50