Difference between revisions of "QPR UI Windows Installer"

Revision as of 07:32, 7 November 2017

Link to the installation package can be found from this wiki's main page.

If you are upgrading to the latest version of QPR UI, follow the upgrade instructions instead of this page instructions.

Before running installation wizard

Before running the installation wizard, check the following things:

System Requirements

Check that the QPR UI System Requirements are fulfilled.

QPR Suite Web Services Accessibility

Depending on which QPR Suite product you want to use as the data source for QPR UI, check that either:

The QPR MEA Web Services you need is available by using the QPR Web Services Servicetester.
The QPR ProcessAnalyzer web service is available by logging in to QPR ProcessAnalyzer with the Excel client.

Ports

Make sure that there are no other (server) applications listening on ports 4848, 8080 or 8181, because QPR UI uses these ports by default (they are the default ports for GlassFish web server). QPR UI installation fails if these ports are in use during the installation. It's possible to change the GlassFish port in the GlassFish Admin Console, but the issue is that this is doable only after the installation. This can be worked around by shutting down the other application during QPR MobileDasdboard installation as follows:

Shutdown the other application using ports 4848, 8080 or 8181.
Run QPR UI installation wizard as described in Running installation wizard.
Change the GlassFish port from GlassFish Administration Console.
Start the other application.

Running installation wizard

To install QPR UI, follow the instructions below:

1. Welcome Page
This is the starting point of the QPR UI installation wizard. Click Next to continue.
2. License Agreement
Here you can see the End User Software License terms for the software that is about to be installed. You will need to accept these terms before continuing the installation. Select I accept the terms in the license agreement and click Next to continue in the case you accept the license terms. Otherwise you'll need to cancel the installation.
3. Destination Folder
In this page you can see the folder where QPR UI is will be installed. If you want to install to a different folder, click on the Change button and define a new target folder.
4. Database Configuration
Select whether to create a new database for QPR UI or to use an existing database. Select Set up a new database for QPR UI, if you have an empty database and you are installing a new QPR UI system. With this option, the empty database is initialized for QPR UI. Note that if the database is not empty, it's data is lost in the initialization. Select Use an existing database, if you have an existing QPR UI database (either a database from an older version of QPR UI or the same version). Note that if you select this option for an empty database, the installation fails, because the database is not initialized for QPR UI.	400px
5. Database Server
In this page you need to supply the information to connect to Microsoft SQL Server where QPR UI database is located. The Database server drop-down list contains found SQL Servers, but if the desired SQL Server is not found, input the host name and the possible instance name in the form SQLSERVERNAME\INSTANCENAME. For connecting to the SQL Server, you can use either: Windows authentication (Windows domain account defined below) or SQL Server authentication (SQL Server login defined below) After inputting Login ID (username) and password, click on Validate to verify that the account can be used for connecting to the defined database server. The Next button is enabled only after a successful validation of credentials. The validation only checks that the account can be used to login to the SQL Server - it doesn't check that the account has enough rights to operate the database. Note for Windows authentication: The account supplied here will be used for database connection when QPR UI is running in the Glassfish. Also the user account running this installation wizard needs to have access to the database to create the necessary tables there during the installation. Name of database field defines QPR UI database name (that must already exist).
6. Server Locations
Define where the QPR Suite and QPR ProcessAnalyzer Web Services can be accessed. For QPR Suite Web Service, the endpoint is given in the format: http://<your host>/<your IIS application>/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/. The suggested url for QPR Suite Web Services points to QPR 2017.1 instance in the same server computer. localhost can be used if QPR Suite and QPR UI are on the same server computer. If you have QPR ProcessAnalyzer available, define its endpoint URL to the corresponding field. NOTE: If your QPR UI installation is running in a clustered environment, set UseXForwardedForAsClientIp to true in the web.config of the QPR ProcessAnalyzer instance that is used. Also note that when using SSL, both QPR Suite and QPR ProcessAnalyzer should be set to ignore client certificates in their IIS configuration. Click Next to continue.
7. GlassFish Configuration
Define the HTTP and HTTPS port numbers of the GlassFish application server used to host QPR UI. Make sure that the ports are not in use by other applications. To see see if a port is in use, you can use for example the following Netstat command executed in an elevated Command Prompt: netstat -an \| find ":port_number_here" Click Next to continue.
8. QPR Suite System User
Here you need to define the user credentials of a QPR Suite administrator user. Click Next to continue.
9. Single Sign-on Setup
If you have other QPR Suite products in use, with these settings you can configure Common QPR Authentication to work between the products. To add a URL: select the Service type (e.g. "QPR Portal") define the Service URL (e.g. http://<service_hostname>/QPR2017-1/Portal/QPR.Isapi.dll/) click Add If you need to change an existing definition, you can either remove the latest definition by clicking Remove last or remove all the definitions by clicking Clear, and then start adding again. Note that with the settings defined here, you can define the Common QPR Authentication to work when linking to QPR UI. If you need to link from QPR UI to some other QPR Suite product, you need to do define the settings in the other product. Click Next to continue.
10. Federated Authentication Configuration
This page allows configuring Single Sign-On (SSO) login that enables logging in to QPR UI using the existing credentials provided by your organization's federated identity provider. If there’s no applicable federated identity provider in your organization or you wish to configure it later, this page can be left blank. See the federated authentication page for more information how these settings are configured. Click Next to continue.
11. Ready to Install
The installer is now ready to start. If you need to change any settings, click Back and make the necessary changes. Once you are satisfied with the settings, click Install to start the installation.
12. Complete
The installation is now complete. Check the Launch QPR UI checkbox to open the QPR UI login page. If you choose not to launch the login page straight away, you can access it later on at: http(s)://<your_server_dns_name>:8080/mobiledash. Click Finish to close the installer.

Enabling SSL

See the instructions here for enabling SSL on QPR UI.

Maintenance

If you need to repair QPR UI installation for whatever reason, restart the "QPR UI" service after the repair before using the product.

Enabling More Descriptive Error Messages From QPR Suite Web Services

To enable more descriptive error messages in QPR UI when data from QPR Suite web services is queried, the default IIS setting for error code 500 in the QPR Suite web services needs to be changed.

To change the error setting:

On the server machine running QPR Suite web services, go to Control Panel -> Administrative Tools -> Internet Information Services (IIS) Manager.
Select the Server name > Sites > Default Web Site > <Your QPR installation application (e.g. QPR2017-1)> section.
Double-click Error Pages and Click Edit Feature Settings...
Select Detailed errors and click OK:

@@ Line 1: / Line 1: @@
 Link to the installation package can be found from this wiki's main page.
-If you are upgrading to the latest version of QPR MobileDashboard, follow the [[Upgrading QPR MobileDashboard|upgrade instructions]] instead of this page instructions.
+If you are upgrading to the latest version of QPR UI, follow the [[Upgrading QPR UI|upgrade instructions]] instead of this page instructions.
 __TOC__
@@ Line 9: / Line 9: @@
 === System Requirements ===
-Check that the [[QPR MobileDashboard System Requirements]] are fulfilled.
+Check that the [[QPR UI System Requirements]] are fulfilled.
 === QPR Suite Web Services Accessibility ===
-Depending on which QPR Suite product you want to use as the data source for QPR MobileDashboard, check that either:
+Depending on which QPR Suite product you want to use as the data source for QPR UI, check that either:
 * The QPR MEA Web Services you need is available by using the [http://kb.qpr.com/qpr2017-1/index.html?qpr_web_services_foundation_in.htm QPR Web Services Servicetester].
 * The QPR ProcessAnalyzer web service is available by [[Get_Started#Logging_in_to_QPR_ProcessAnalyzer_Pro|logging in to QPR ProcessAnalyzer with the Excel client]].
 === Ports ===
-Make sure that there are no other (server) applications listening on ports '''4848''', '''8080''' or '''8181''', because QPR MobileDashboard uses these ports by default (they are the default ports for GlassFish web server). QPR MobileDashboard installation fails if these ports are in use during the installation. It's possible to change the GlassFish port in the GlassFish Admin Console, but the issue is that this is doable only after the installation. This can be worked around by shutting down the other application during QPR MobileDasdboard installation as follows:
+Make sure that there are no other (server) applications listening on ports '''4848''', '''8080''' or '''8181''', because QPR UI uses these ports by default (they are the default ports for GlassFish web server). QPR UI installation fails if these ports are in use during the installation. It's possible to change the GlassFish port in the GlassFish Admin Console, but the issue is that this is doable only after the installation. This can be worked around by shutting down the other application during QPR MobileDasdboard installation as follows:
 # Shutdown the other application using ports 4848, 8080 or 8181.
-# Run QPR MobileDashboard installation wizard as described in [[#Running installation wizard|Running installation wizard]].
+# Run QPR UI installation wizard as described in [[#Running installation wizard|Running installation wizard]].
-# [[Glassfish Configuration in QPR MobileDashboard |Change the GlassFish port]] from GlassFish Administration Console.
+# [[Glassfish Configuration in QPR UI |Change the GlassFish port]] from GlassFish Administration Console.
 # Start the other application.
 == Running installation wizard ==
-To install QPR MobileDashboard, follow the instructions below:
+To install QPR UI, follow the instructions below:
 {| class="wikitable"
 |colspan="2" style="font-size: 17px"|'''1. Welcome Page'''
 |-
-|This is the starting point of the QPR MobileDashboard installation wizard.
+|This is the starting point of the QPR UI installation wizard.
 Click '''Next''' to continue.
@@ Line 40: / Line 40: @@
 |colspan="2" style="font-size: 17px"|'''3. Destination Folder'''
 |-
-|In this page you can see the folder where QPR MobileDashboard is will be installed. If you want to install to a different folder, click on the '''Change''' button and define a new target folder.
+|In this page you can see the folder where QPR UI is will be installed. If you want to install to a different folder, click on the '''Change''' button and define a new target folder.
 |[[File:Pic_installation_destinationfolder.png|400px]]
 |-
 |colspan="2" style="font-size: 17px"|'''4. Database Configuration'''
 |-
-|Select whether to create a new database for QPR MobileDashboard or to use an existing database.
+|Select whether to create a new database for QPR UI or to use an existing database.
-* Select '''Set up a new database for QPR MobileDashboard''', if you have an empty database and you are installing a new QPR MobileDashboard system. With this option, the empty database is initialized for QPR MobileDashboard. Note that if the database is not empty, it's data is lost in the initialization.
+* Select '''Set up a new database for QPR UI''', if you have an empty database and you are installing a new QPR UI system. With this option, the empty database is initialized for QPR UI. Note that if the database is not empty, it's data is lost in the initialization.
-* Select '''Use an existing database''', if you have an existing QPR MobileDashboard database (either a database from an older version of QPR MobileDashboard or the same version). Note that if you select this option for an empty database, the installation fails, because the database is not initialized for QPR MobileDashboard.
+* Select '''Use an existing database''', if you have an existing QPR UI database (either a database from an older version of QPR UI or the same version). Note that if you select this option for an empty database, the installation fails, because the database is not initialized for QPR UI.
 |[[File:Pic_installation_databaseconfiguration.png|400px]]
 |-
 |colspan="2" style="font-size: 17px"|'''5. Database Server'''
 |-
-|In this page you need to supply the information to connect to Microsoft SQL Server where QPR MobileDashboard database is located. The '''Database server''' drop-down list contains found SQL Servers, but if the desired SQL Server is not found, input the host name and the possible instance name in the form SQLSERVERNAME\INSTANCENAME.
+|In this page you need to supply the information to connect to Microsoft SQL Server where QPR UI database is located. The '''Database server''' drop-down list contains found SQL Servers, but if the desired SQL Server is not found, input the host name and the possible instance name in the form SQLSERVERNAME\INSTANCENAME.
 For connecting to the SQL Server, you can use either:
@@ Line 61: / Line 61: @@
 Note for Windows authentication:
-* The account supplied here will be used for database connection when QPR MobileDashboard is running in the Glassfish. Also the user account running this installation wizard needs to have access to the database to create the necessary tables there during the installation.
+* The account supplied here will be used for database connection when QPR UI is running in the Glassfish. Also the user account running this installation wizard needs to have access to the database to create the necessary tables there during the installation.
-'''Name of database''' field defines QPR MobileDashboard database name (that must already exist).
+'''Name of database''' field defines QPR UI database name (that must already exist).
 |[[File:Pic_installation_dbconfig.png|400px]]
@@ Line 69: / Line 69: @@
 |colspan="2" style="font-size: 17px"|'''6. Server Locations'''
 |-
-|Define where the QPR Suite and QPR ProcessAnalyzer Web Services can be accessed. For '''QPR Suite Web Service''', the endpoint is given in the format: '''http://<your host>/<your IIS application>/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/'''.<br>The suggested url for QPR Suite Web Services points to QPR 2017.1 instance in the same server computer. '''localhost''' can be used if QPR Suite and QPR MobileDashboard are on the same server computer.
+|Define where the QPR Suite and QPR ProcessAnalyzer Web Services can be accessed. For '''QPR Suite Web Service''', the endpoint is given in the format: '''http://<your host>/<your IIS application>/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp/'''.<br>The suggested url for QPR Suite Web Services points to QPR 2017.1 instance in the same server computer. '''localhost''' can be used if QPR Suite and QPR UI are on the same server computer.
-If you have QPR ProcessAnalyzer available, define its endpoint URL to the corresponding field. NOTE: If your QPR MobileDashboard installation is running in a clustered environment, set '''UseXForwardedForAsClientIp''' to true in the '''web.config''' of the QPR ProcessAnalyzer instance that is used.
+If you have QPR ProcessAnalyzer available, define its endpoint URL to the corresponding field. NOTE: If your QPR UI installation is running in a clustered environment, set '''UseXForwardedForAsClientIp''' to true in the '''web.config''' of the QPR ProcessAnalyzer instance that is used.
 Also note that when using SSL, both QPR Suite and QPR ProcessAnalyzer should be set to ignore client certificates in their IIS configuration.
@@ Line 80: / Line 80: @@
 |colspan="2" style="font-size: 17px"|'''7. GlassFish Configuration'''
 |-
-|Define the HTTP and HTTPS '''port numbers''' of the GlassFish application server used to host QPR MobileDashboard.
+|Define the HTTP and HTTPS '''port numbers''' of the GlassFish application server used to host QPR UI.
 <br>
 Make sure that the ports are not in use by other applications. To see see if a port is in use, you can use for example the following [https://technet.microsoft.com/en-us/library/bb490947.aspx Netstat] command executed in an elevated Command Prompt: <pre>netstat -an | find ":port_number_here"</pre>
@@ Line 105: / Line 105: @@
 If you need to change an existing definition, you can either remove the latest definition by clicking '''Remove last''' or remove all the definitions by clicking '''Clear''', and then start adding again.
-Note that with the settings defined here, you can define the Common QPR Authentication to work when linking <u>to</u> QPR MobileDashboard. If you need to link <u>from</u> QPR MobileDashboard to some other QPR Suite product, you need to do define the settings in the other product.
+Note that with the settings defined here, you can define the Common QPR Authentication to work when linking <u>to</u> QPR UI. If you need to link <u>from</u> QPR UI to some other QPR Suite product, you need to do define the settings in the other product.
 Click '''Next''' to continue.
@@ Line 112: / Line 112: @@
 |colspan="2" style="font-size: 17px"|'''10. Federated Authentication Configuration'''
 |-
-|This page allows configuring Single Sign-On (SSO) login that enables logging in to QPR MobileDashboard using the existing credentials provided by your organization's federated identity provider. If there’s no applicable federated identity provider in your organization or you wish to configure it later, this page can be left blank. See the [[Federated Authentication in QPR MobileDashboard|federated authentication]] page for more information how these settings are configured.
+|This page allows configuring Single Sign-On (SSO) login that enables logging in to QPR UI using the existing credentials provided by your organization's federated identity provider. If there’s no applicable federated identity provider in your organization or you wish to configure it later, this page can be left blank. See the [[Federated Authentication in QPR UI|federated authentication]] page for more information how these settings are configured.
 Click '''Next''' to continue.
@@ Line 126: / Line 126: @@
 |The installation is now complete.
-Check the '''Launch QPR MobileDashboard''' checkbox to open the QPR MobileDashboard login page. If you choose not to launch the login page straight away, you can access it later on at: '''http(s)://<your_server_dns_name>:8080/mobiledash'''.
+Check the '''Launch QPR UI''' checkbox to open the QPR UI login page. If you choose not to launch the login page straight away, you can access it later on at: '''http(s)://<your_server_dns_name>:8080/mobiledash'''.
 Click '''Finish''' to close the installer.
@@ Line 133: / Line 133: @@
 == Enabling SSL ==
-See the instructions [[Glassfish_Configuration_in_QPR_MobileDashboard#SSL_Configuration|here for enabling SSL on QPR MobileDashboard]].
+See the instructions [[Glassfish_Configuration_in_QPR_UI#SSL_Configuration|here for enabling SSL on QPR UI]].
 == Maintenance ==
-If you need to repair QPR MobileDashboard installation for whatever reason, restart the "QPR MobileDashboard" service after the repair before using the product.
+If you need to repair QPR UI installation for whatever reason, restart the "QPR UI" service after the repair before using the product.
 == Enabling More Descriptive Error Messages From QPR Suite Web Services ==
-To enable more descriptive error messages in QPR MobileDashboard when data from QPR Suite web services is queried, the default IIS setting for error code 500 in the QPR Suite web services needs to be changed.
+To enable more descriptive error messages in QPR UI when data from QPR Suite web services is queried, the default IIS setting for error code 500 in the QPR Suite web services needs to be changed.
 To change the error setting:
@@ Line 148: / Line 148: @@
 :: [[File:Pic_iis_detailed_errors.png|400px]]
-[[Category: QPR MobileDashboard]]
+[[Category: QPR UI]]