Difference between revisions of "QPR UI Installation Checklist"

From Mea Wiki
Jump to navigation Jump to search
m
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This '''QPR UI Installation Checklist''' contains all the steps needed for a complete QPR UI installation. These steps apply only for a new QPR UI installation. If you are upgrading an existing installation, see the [[Upgrading QPR UI|upgrage instructions]].
+
This checklist for QPR UI installation and configuration contains all the needed steps to complete a QPR UI installation. The steps need to be done in the listed order.
 +
 
 +
<div class="downloadButton" style="width:240px;margin:5px 0px 5px 20px;">[[QPR_Product_Downloads|Download QPR UI]]</div>
 +
 
 +
{| class="wikitable"
 +
!'''Installation step'''
 +
! '''Description'''
 +
|-
 +
||1.&nbsp;[[QPR UI System Requirements|QPR UI system requirements]]
 +
||Check that your hardware and software infrastructure fulfills the QPR UI system requirements. Especially note ''Microsoft OLE DB Driver 18 for SQL Server'' and ''.Net Framework 3.5'' which need to be installed before installing QPR UI.
 +
|-
 +
||2.&nbsp;[[SQL Server Configuration in QPR UI|SQL Server configuration]]
 +
||Make the needed configurations for the SQL Server where the QPR UI database will be located. SQL Server configuration must be done before running the QPR UI installer.
 +
|-
 +
||3.&nbsp;[[QPR UI Windows Installer|QPR UI installer]]
 +
||Run the QPR UI installer. The installer download link can be found in the [[QPR_UI_Wiki|home page]] of this wiki. Settings in the wizard pages 6, 8, 9 and 10 can also be done after the installation, if the needed information is not available during the installation. (For advanced installation scenarios, you can alternatively use the [[Silent Installation in QPR UI|silent installation procedure]].)
 +
|-
 +
||4.&nbsp;[[Setting up IIS as Reverse Proxy for QPR UI|IIS&nbsp;as&nbsp;reverse&nbsp;proxy&nbsp;for&nbsp;QPR&nbsp;UI]]
 +
||Configure IIS to route through QPR UI traffic.
 +
|-
 +
||5. [[Enable Detailed Error Messages in IIS|Detailed&nbsp;error&nbsp;messages&nbsp;in&nbsp;IIS]]
 +
||Enable detailed error messages for IIS.
 +
|-
 +
||6.&nbsp;[[QPR UI Security Hardening|Hardening&nbsp;security]]
 +
||Go through the instructions for hardening the security for QPR UI.
 +
|-
 +
||7.&nbsp;[[Common QPR Authentication]]
 +
||Configure the Common QPR Authentication, which enables to open QPR Suite portal from QPR UI and vice versa without a separate login. The Common QPR Authentication is mandatory if using the federated authentication (the next step).
 +
|-
 +
||8.&nbsp;[[Federated Authentication in QPR UI|Federated authentication]]
 +
||Configure the federated authentication for QPR UI, if there is a federated authentication identity provider (IdP) available in your organization, such as Active Directory Federation Services (ADFS). This enables to use your organization's centralized identity management system without managing user accounts separately in QPR products. Note that QPR UI is not directly compatible with the LDAP protocol.
 +
|-
 +
||9.&nbsp;[[QPR Reporting Add-on#Installation|QPR Suite Reporting Add-on]]
 +
||It is recommended to install QPR Suite Reporting Add-on. To use the QPR Suite Reporting Add-on Expressions Language in QPR UI, you need to configure the [[QPR UI System Settings#Settings for QPR Product Locations|QPR_REPORTING_EXPRESSIONS_WEB_SERVICE_LOCATION]] setting in QPR UI configuration table.
 +
|-
 +
||10.&nbsp;[[QPR UI System Settings|System settings]]
 +
||You might need to change QPR UI system settings stored in QPR UI database. Note that database connection settings are in the [[Payara Configuration in QPR UI#Changing Database Connection Settings|Payara Administration Console]].
 +
|}
  
# First of all, check that your hardware and software infrastructure fulfills the [[QPR UI System Requirements|system requirements]] for QPR UI.
 
# Set the needed [[SQL Server Configuration in QPR UI|configurations for SQL Server]] containing QPR UI database. SQL Server configuration must be done before running the QPR UI installer.
 
# Check the [[Installing QPR UI#Before running installation wizard|Before running installation wizard]] section.
 
# Run the [[Installing QPR UI|QPR UI installer]]. Note that the settings in the wizard pages 8-10 are not mandatory at this point. (For advanced scenarios, you can alternatively use the [[Silent Installation in QPR UI|silent installation]].)
 
# Configure [[Routing Through IIS in QPR UI|IIS to pass through QPR UI traffic]]. This enables to use standard ports 80 or 443 for QPR UI that are usually reserved by IIS.
 
# Optional: You can configure [[Common QPR Authentication]], which enables to open QPR Suite portal from QPR UI and vice versa without a separate login.
 
# Optional: You can configure [[Federated Authentication in QPR UI|federated authentication]] for QPR UI, if there is a federated authentication identity provider (IdP) available in your organization, such as Active Directory Federation Services (ADFS). This enables to use your organization's centralized user management system without managing user accounts separately in QPR products. Note that QPR UI is not compatible with the LDAP protocol.
 
# Optional: If you need to change QPR UI system settings after the installation, you can find all settings [[QPR UI System Settings|here]]. Note that some settings are in [[Glassfish Configuration in QPR UI|GlassFish]], such as database settings and GlassFish ports.
 
# QPR UI installation is now ready! You can start QPR UI, and go through the [[Creating a New QPR UI View|tutorial]] how to create views and dashboards.
 
 
[[Category: QPR UI]]
 
[[Category: QPR UI]]

Latest revision as of 15:01, 15 January 2020

This checklist for QPR UI installation and configuration contains all the needed steps to complete a QPR UI installation. The steps need to be done in the listed order.

Installation step Description
1. QPR UI system requirements Check that your hardware and software infrastructure fulfills the QPR UI system requirements. Especially note Microsoft OLE DB Driver 18 for SQL Server and .Net Framework 3.5 which need to be installed before installing QPR UI.
2. SQL Server configuration Make the needed configurations for the SQL Server where the QPR UI database will be located. SQL Server configuration must be done before running the QPR UI installer.
3. QPR UI installer Run the QPR UI installer. The installer download link can be found in the home page of this wiki. Settings in the wizard pages 6, 8, 9 and 10 can also be done after the installation, if the needed information is not available during the installation. (For advanced installation scenarios, you can alternatively use the silent installation procedure.)
4. IIS as reverse proxy for QPR UI Configure IIS to route through QPR UI traffic.
5. Detailed error messages in IIS Enable detailed error messages for IIS.
6. Hardening security Go through the instructions for hardening the security for QPR UI.
7. Common QPR Authentication Configure the Common QPR Authentication, which enables to open QPR Suite portal from QPR UI and vice versa without a separate login. The Common QPR Authentication is mandatory if using the federated authentication (the next step).
8. Federated authentication Configure the federated authentication for QPR UI, if there is a federated authentication identity provider (IdP) available in your organization, such as Active Directory Federation Services (ADFS). This enables to use your organization's centralized identity management system without managing user accounts separately in QPR products. Note that QPR UI is not directly compatible with the LDAP protocol.
9. QPR Suite Reporting Add-on It is recommended to install QPR Suite Reporting Add-on. To use the QPR Suite Reporting Add-on Expressions Language in QPR UI, you need to configure the QPR_REPORTING_EXPRESSIONS_WEB_SERVICE_LOCATION setting in QPR UI configuration table.
10. System settings You might need to change QPR UI system settings stored in QPR UI database. Note that database connection settings are in the Payara Administration Console.