Documente Academic
Documente Profesional
Documente Cultură
Installation Instructions
Version 2017.1.0
All product names referenced herein are trademarks or registered trademarks of their respective companies.
QPR Software Plc. disclaims proprietary interest in the marks and names of others. Although QPR Software Plc.
makes every effort to ensure that this information is accurate, QPR Software Plc. will not be liable for any errors
or omission of facts contained herein. QPR reserves the right to modify specifications cited in this document
without prior notice.
Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this
document may be reproduced or transmitted in any form or by any means, electronic or manual, for any
purpose, without the express written permission of QPR Software Plc.
Table of Contents
1 .................................................................................................................................1
Introduction
1.1 Who.............................................................................................................................
Should Read This Guide 1
1.2 How.............................................................................................................................
to Use This Guide 1
2 Getting Started
.................................................................................................................................2
2.1 Installation
.............................................................................................................................
Components and Basic Requirements 2
4 Configuration 29
.................................................................................................................................
4.1 Web
.............................................................................................................................
Server 29
4.2 QPR
.............................................................................................................................
Web Services Foundation 29
5 Starting 30
.................................................................................................................................
6 Troubleshooting 31
.................................................................................................................................
7 Appendices 32
.................................................................................................................................
7.1 Appendix
.............................................................................................................................
A - System Requirements & Recommendations 32
Hardware
............................................................................................................................................................
Recommendations 32
Supported
............................................................................................................................................................
Databases 33
Supported
............................................................................................................................................................
Operating Systems 34
Supported
............................................................................................................................................................
Web Servers 35
CGI/ISAPI Installation and Configuration
...................................................................................................................................................... 35
Requirements
............................................................................................................................................... 35
Installation
............................................................................................................................................... 36
Configuration
............................................................................................................................................... 36
Supported
............................................................................................................................................................
Web Browsers 36
Other
............................................................................................................................................................
Requirements 37
7.2 Appendix
.............................................................................................................................
B - Database Installation 39
7.3 Appendix
.............................................................................................................................
C - Web Server Configuration 40
7.4 Appendix
.............................................................................................................................
D - QPR Web Services Foundation Configuration 43
7.5 Appendix
.............................................................................................................................
E - Preparations for a System Installation 45
Verify
............................................................................................................................................................
that You Have the Latest Version 45
Pre-installation
............................................................................................................................................................
Checklist 45
Resources and User Rights
...................................................................................................................................................... 45
Web......................................................................................................................................................
Server 46
User......................................................................................................................................................
Directory 46
Hardware
...................................................................................................................................................... 46
Software
...................................................................................................................................................... 46
What to Install?
...................................................................................................................................................... 47
System
............................................................................................................................................................
Validation Checklist 48
1 Introduction
This document provides instructions on how to install QPR 2017.1 and perform its initial configuration.
This document is aimed at persons who perform the installation for QPR products. The instructions
provided here assume that the reader has administrative access to the target computer(s). QPR
recommends that especially server installations are performed by IT professionals.
This guide is structured so that the basic instructions are provided first and additional details can be
found in the appendices. So for example system requirements are provided on a generic level in the
actual chapters, but you can find more detailed requirements in the appendices when necessary. Links
are provided to the correct appendix whenever additional details are available.
2 Getting Started
The QPR 2017.1 suite consists of multiple components, all of which are not necessary for all scenarios.
In this chapter you can verify what components you need and what are the prerequisites for installing
them.
See more detailed system requirements in Appendix A - System Requirements and Recommendations.
The installation requires that Windows Installer 3.1 is installed. Every version of Windows supported
by QPR has a required Windows Installer version installed out of the box. In the case you do not have
the Windows Installer engine installed or you have an older version, please acquire a supported
version from Windows Update. In addition, MDAC 2.7 or newer is required for the installation.
QPR Suite 2017.1 installation is divided into two separate packages, one for client components and
one for server components.
The packages can basically be installed in any order, but in the case of full system installation with
both clients and servers it is strongly recommended to install the Clients package first. If the Servers
package is present in the same folder as the Clients package, the Clients package provides an option
to launch the Servers package at the end of the installation.
If the packages are installed in a different order, then e.g. default server connections may have to be
created manually.
NOTE! If you are installing both Clients and Servers packages, do not activate anything before both
packages are installed to avoid unnecessary deductions to your allowed activation times count.
NOTE! For installing QPR Add-In for Microsoft Office for a 64-bit version of Microsoft Office 2010,
2013, or 2016, you need to use the QPRAfMO2017Setup_x64.exe installation package.
NOTE! It is highly recommended to apply latest Windows Updates and reboot your machine prior to
installation so that installation of possible prerequisites does not fail due to a pending reboot.
2. Welcome Page
This is the starting point of the QPR Suite 2017.1
Clients installation wizard.
3. 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.
7. Ready to Install
The installer is now ready to start copying the
application files to the computer. If you need to
change any settings, click Back and make the
necessary changes.
8. Complete
The installation is now complete. Check the
"Activate the product now" if you wish to launch
the QPR Product Activation Wizard after clicking
Finish. Note that the "Activate the product now"
option is not available if client components that
require activation were not selected to be
installed. Similarly, checking the "Show the
readme file" checkbox opens the readme file after
you click Finish. In addition, if the QPR Suite
2017.1 Servers installation package is present in
the same folder as the Clients package, there is
the "Install QPR Server Components" option.
Selecting that option will launch the Server
installer (instructions in the next chapter) when
the Finish button is clicked. If you have multiple
options selected, the corresponding operations
are performed one at a time, i.e. the readme file
is displayed after finishing the activation. In
installations with also server components
included, activation should be done only after all
the components are installed, so you cannot
select both "Activate the product now" and
"Install QPR Server Components" options
simultaneously.
2. Welcome Page
This is the starting point of the QPR Suite 2017.1
Servers installation wizard.
3. 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.
4. Setup Type
Here you can choose between Complete
installation or Custom installation. The Complete
installation installs all server components, while
the Custom option lets you choose the
components to install. With the Complete option,
click Next and proceed to step 6. With the
Custom option, click Next and proceed to step 5.
5. Custom Setup
Select the features that will be installed. You can
also change the destination folders here for
various components. However, all features except
for QPR Portal Web Contents use the same
destination folder, so changing the destination
folder for one of the features affects the others as
well. It is advisable to leave the QPR Portal Web
Contents destination folder to its default value in
this dialog, as its location will be determined in
the forthcoming dialogs.
11. Complete
The installation is now complete. Check the
"Activate the software now" if you wish to launch
the QPR Product Activation Wizard after clicking
Finish. Similarly, checking the "Show the readme
file" checkbox opens the readme file after you
click Finish. In addition, if an older qualifying
QPR installation was found on the computer,
there is also a "Launch the Migration Utility"
option available on the last page. Selecting that
will open QPR Configuration Manager into the
System Migration section after clicking Finish. If
you have multiple options selected, the
corresponding operations are performed one at a
time, i.e. the readme file is displayed after
finishing the activation and the migration utility is
not launched before the readme file is closed.
QPR Server components (i.e. QPR Metrics Server, QPR BizArchitecture Server, QPR Foundation Server,
QPR Web Application Server, and QPR Web Services Server) can be installed as service. In the case
you are installing one of more QPR server components and you have selected service to be installed,
the QPR Service installation will be performed after the files are installed. The QPR Service controls all
QPR Suite 2017.1 server components (except for QPR Web Services Server which has its own
subservice) installed on the computer.
In the case you selected service to be installed during the installation, you are asked whether you
want the service to be started during Windows start-up. Also, if you selected the "Standalone as a
service" option during the installation, you will be asked for the user account under which the service
is run. If you need more configuration options regarding the service such as installing it with a
different name or creating service dependencies, please install the service from the command line
after the installation. See the instructions below for more information.
In addition, if QPR Web Services Server is installed and service installation is selected, a separate QPR
WS Service 2017.1 service is installed. The WS service starts automatically when the main service is
started.
The "Server as a service" option installs the service to the local system account by default and
therefore LocalDB is not installed with this option but you have to provide a functional database
instance instead. This option is intended for production server installations where the server will be
accessed by multiple users. If you need to use the service with some other account than the local
system, skip service installation during the initial installation and install the service manually after the
initial installation.
Services can be installed and uninstalled with command line parameters as well. With the command
line installation option you can install the service later on even if you have decided not to install it
during the QPR 2017.1 installation. The installation/uninstallation is done by launching the
QPR.Init.exe in the Utilities folder under the QPR 2017.1 installation folder followed by a parameter.
The parameters are:
-i for installing the service. For example, launching 'qpr.init.exe -i' in the Utilities folder starts
service installation for the QPR Service 2017.1.
-d for uninstalling the service. For example, launching 'qpr.init.exe -d' in the Utilities folder
uninstalls the QPR Service 2017.1.
-b4 for installing the WS service. For example, launching 'qpr.init.exe -b4' in the Utilities folder
starts service installation for the QPR WS Service 2017.1.
-u4 for uninstalling the WS service. For example, launching 'qpr.init.exe -u4' in the Utilities folder
uninstalls the QPR WS Service 2017.1.
NOTE: If you are installing QPR services manually, make sure that the Standalone option in the
Servers section of QPR_Shared.ini is set to 0. The Standalone option is not compatible with services.
This section provides information on suggested configuration for selected scenarios where the default
configuration is not optimal.
Right-to-left Languages
When running QPR Portal in right-to-left languages such as Arabic, the following configuration should
be done:
Use Microsoft Silverlight instead of SVG
Enable the "Use bitmap text in graphical views" setting in the QPR Web Application Server -> QPR
Metrics Plugin section.
Follow the instructions in the following sections to install QPR 2017.1 silently or to customize an
installation with the graphical user interface included.
To perform a silent installation equivalent to the typical installation with the default settings, open the
command prompt to the folder containing the installation package(s) and start the installation with the
following command: QPR2017_Clients_Setup_x86.exe /s /v"/qn ALLUSERS=1" for the Clients
package and QPR2017_Servers_Setup_x64.exe /s /v"/qn ALLUSERS=1" for the Servers
package.
Once the desktop icons have appeared on the desktop (only in the Clients package) and the msiexec
process is not running (see the Task Manager) anymore, you can start using the software.
See the next section for information about how to customize e.g. the selection of software
components included in the installation.
To customize the silent installation, you can supply some of the public properties listed below to
customize the behavior of the silent installation. The base command required in all cases is
QPR2017_Clients_Setup_x86.exe /s /v"/qn (and QPR2017_Servers_Setup_x64.exe /s /
v"/qn for the Servers package) followed by a selection of properties listed below. Remember also to
add a closing double quote after defining the properties you want. In addition, make sure that there
are no spaces in the /v"/qn part to ensure correct functionality. Note that you can also supply the
properties to an normal (i.e. not silent) installation. In that case, omit the /s and /qn options from the
base command. In addition, if any properties require values that need to be enclosed in double
quotes, you need to escape those double quotes with a preceding backslash to avoid prematurely
terminating the string supplied to the /v option. Example: QPR2017_Clients_Setup_x86.exe /s /v"/qn
INSTALLDIR=\"C:\Program Files\QPR 2017.1\""
Note that you can define settings such as server connection strings by having them included in a pre-
configured QPR_Clients.ini, QPR_Shared.ini, and QPR_Servers.ini files in the same folder as the
corresponding installation package. See Appendix A in QPR Administrator's Guide for reference about
which settings reside in which file. In the case any of the files exists, it is copied to the installation
folder during the installation and the settings included in it are used when the actual settings file
created into the "Clients\Settings", "Shared\Settings", and "Servers\Settings" folders (depending on
the file) under C:\ProgramData\QPR Software\QPR 2017\2017.1\. However, the file may not get
copied properly in the case the installation package is located in a network drive.
NOTE: When using a pre-filled QPR_Shared.ini, take the template file installed to C:\ProgramData
\QPR Software\QPR 2017\2017.1\Shared\Settings and customize the settings there. The product
cannot be activated if information included in the template QPR_Shared.ini is not included in the
customized QPR_Shared.ini.
Properties (note that these are case sensitive, so for example ProductActivation=1 does not work):
PRODUCTACTIVATION=1: Launches the QPR Product Activation Wizard at the end of the
installation. Note that only one PRODUCTACTIVATION option can be selected for an installation, so
this property cannot coexist with PRODUCTACTIVATION=2 or PRODUCTACTIVATION=3.
PRODUCTACTIVATION=2: Activates a 14-day evaluation license (if allowed) silently at the end of
the installation.
PRODUCTACTIVATION=3: Performs a silent activation at the end of the installation provided
that there's a properly filled QPR_Shared.ini present in the folder containing the QPR2017Setup.exe
package. See details about the necessary settings below.
NOIISCONFIG=1: Skips the automatic creation of Microsoft IIS virtual directories. This is useful in
the case you are using some other web server software and you are having problems with the
installation.
NOSERVICE=1: Skips the QPR Service installation. The service is installed by default on server
editions of Windows, so you can use this option in the case you want to install the service manually
after a silent installation on for instance Windows Server 2008.
ASKSCRIPTFOLDER=1: Requests for the script/CGI-binary folder also when Microsoft IIS is found
on the computer. This can be used also in non-silent installation to provide additional control.
ENTITLEMENTID=<product activation entitlement ID>: This option passes the entitlement
ID (product activation code) that is used for product activation. The end user needs to provide the
rest of required information in the QPR Product Activation utility. This option is available only in the
clients package.
SKIPSELECTIONS=1: This option causes the client component selection to be skipped in a non-
silent installation. To configure the feature set, use the INSTALLLEVEL and ADDLOCAL properties
similarly as in a silent installation when launching the installation. This option is available only in the
clients package.
MCCONNSTRING: Server connection string for QPR Modeling Client. This should be in the same
format as used in the PGS Communication section of QPR_Clients.ini, e.g. "0,1,My
Computer,localhost,default;". This option is available only in the clients package.
MTCONNSTRING: Server connection string for QPR Metrics. This should be in the same format as
used in the SCS Communication section of QPR_Clients.ini, e.g. "0,1,My
Computer,localhost,default;". This option is available only in the clients package.
In the case you want to customize the selection of features installed within a silent installation
similarly as you could do in the Select Features dialog in the Custom installation, you can do so by
lowering the installation level below the default (100) and adding the desired features using the
ADDLOCAL property. Feature names (case sensitive) in the Clients package:
EnterpriseArchitect: QPR EnterpriseArchitect
ProcessDesigner: QPR ProcessDesigner
Metrics: QPR Metrics
UserManagementClient: QPR User Management Client
AfMO2010: QPR Add-In for Microsoft Office 2010. Requires Microsoft .NET Framework 4.6.2 and
VSTO runtime 4.0 which are installed during the QPR 2017.1 installation if QPR Add-In for Microsoft
Office 2010 is selected to be installed and the .NET Framework is not found.
AfMO2013: QPR Add-In for Microsoft Office 2013. Requires Microsoft .NET Framework 4.6.2 and
VSTO runtime 4.0 which are installed during the QPR 2017.1 installation if QPR Add-In for Microsoft
Office 2013 is selected to be installed and the .NET Framework is not found.
AfMO2016: QPR Add-In for Microsoft Office 2016. Requires Microsoft .NET Framework 4.6.2 and
VSTO runtime 4.0 which are installed during the QPR 2017.1 installation if QPR Add-In for Microsoft
Office 2016 is selected to be installed and the .NET Framework is not found.
EADesktopIcon: Desktop shortcut icon for QPR EnterpriseArchitect
PDDesktopIcon: Desktop shortcut icon for QPR ProcessDesigner
MetricsDesktopIcon: Desktop shortcut icon for QPR Metrics
ActivationShortcut: Start menu shortcut for QPR Activation Utility
Note: ProcessDesigner and EnterpriseArchitect cannot be installed simultaneously. If both features are
requested to be installed, the installer defaults to ProcessDesigner.
To define installation location for these, provide values to the INSTALLDIR (all features except for
WASWebcontents), CGI (WASWebContents) and WASWEB (WASWebContents) properties. When the
WASWebContents feature is installed, you need to define both CGI (location for files which need
execute permissions, such as qpr.isapi.dll) and WASWEB (location for other web content) properties.
Example 2: Install QPR Suite 2017.1 Clients silently with only QPR Metrics and its desktop icon
included and launch product activation at the end of the installation:
QPR2017_Clients_Setup_x86.exe /s /v"/qn INSTALLLEVEL=10
ADDLOCAL=Metrics,MetricsDesktopIcon INSTALLDIR=\"C:\Program Files\QPR 2017
Custom\" PRODUCTACTIVATION=2"
[Activation]
URL=<QPR activation server location>
SilentFirstActivation=1
[CustomerInfo]
EntitlementID=<valid product activation entitlement>
Email=<valid e-mail>
FirstName=<name>
LastName=<name>
Country=<country>
Organization=<organization>
Activating QPR Products is a straightforward procedure. Follow the instructions below to activate your
QPR product using the QPR Activation Utility:
NOTE: Only those QPR Products you have purchased a license for can be activated.
1. In the welcome page, you can select the activation method and need to input your customer
information. For a Designer activation you need to use the contact information of the actual end
user, but a server activation should be done with the contact information of the administrator/
license owner. You can also view your current activation status by clicking the Activation Status
button at the bottom left corner. If you don't have a product activation code yet, you can choose
the 14-day evaluation activation provided that you haven't already used the evaluation period. In
the case you select to activate using your product activation code, input the code into the
corresponding field. If you have forgotten your product activation code or your 14-day evaluation
period has expired, click the "Forgot your Product Activation Code? Evaluation period expired?" link.
Fill in also your user information to the section reserved for it. Note that you need to fill in at least
all the fields marked with an asterisk (*). In addition, use only Western characters in the form. After
filling in the required information, click Next to continue. The information you provided is sent to
QPR during the activation.
2. The License Agreement is displayed. After reading the license agreement, tick the "I accept the
licensing terms" checkbox and click the Next button to continue.
3. Define the activation method. You can choose to activate the software Automatically via Web or
manually via E-mail. You can use a Proxy Server during the automatic activation by clicking the
Proxy Settings button, selecting the "Use proxy server to connect to QPR product activation
server" check box, and defining the address and port of the proxy server. After selecting the
method, click Activate (or Next, if you selected manual activation via E-mail). In the case you
selected automatic activation via web, the product is now activated automatically. In the case you
selected manually via E-mail, you need to send the displayed Activation Code to QPR Customer
Care. After receiving the Activation Message from QPR Customer Care, click Next to continue and
input the message into the Activation Message section. Then, click Next to continue.
4. At the final stage, your new activation status is displayed. Please check that the information is
correct and click Finish to close the QPR Activation Utility.
While transitions from a QPR version to another are handled by migration, moving from one QPR
2017.1 release to a newer maintenance release is handled as an upgrade installation that replaces the
existing installation.
NOTE: Server components can be upgraded to a newer maintenance release without having to
update also the client components at the same time. However, QPR recommends both server and
client components to be upgraded.
The QPR 2017.1 maintenance release installer will detect the language of the previous version and the
upgrade installation wizard will use the same language during the installation process. Note that the
software itself may have more languages available (see the packing slip or readme for more details)
than what is used by the installation wizard.
Follow the instructions below to upgrade QPR 2017.1 Clients to a newer maintenance release:
1. Accept Upgrade
When there is an older release of QPR 2017.1
installed, the wizard detects it and informs that
an upgrade will be done. Start the upgrade by
clicking Yes.
2. Welcome Page
The installer is now ready to start copying the
application files to the computer.
3. Complete
The clients upgrade is now complete. If the QPR
Suite 2017.1 Servers installation package is
present in the same folder as the Clients package,
there is the "Install QPR Server Components"
option. Selecting that option will launch the
Server installer (instructions below) when the
Finish button is clicked. Similarly, checking the
"Show the readme file" checkbox opens the
readme file after you click Finish.
1. Accept Upgrade
When there is an older release of QPR 2017.1
installed, the wizard detects it and informs that
an upgrade will be done. Start the upgrade by
clicking Yes.
2. Welcome Page
The installer is now ready to start copying the
application files to the computer.
4. Complete
The servers upgrade is now complete. Selecting
the "Show the readme file" checkbox opens the
readme file after you click Finish. If a QPR 8.1 or
newer installation was found on the computer,
there is also a "Launch the Migration Utility"
option available. Selecting that will open QPR
Configuration Manager into the System Migration
section after clicking Finish.
While the QPR 2017.1 installation does recognize a QPR 8.1, 2012.1, 2012.2, 2014.1, and 2015.1
installation, an upgrade similar to older QPR versions is not offered or performed. Instead of
upgrading the older version installation, QPR 2017.1 is installed side-by-side with the older version
with default folders changed so that with the default settings of the older version installation are not
overwritten (provided that also the older version was installed to default folders). If QPR 8.1, 2012.1,
2012.2, 2014.1, or 2015.1 is detected on the computer, there is a possibility to launch the migration
utility at the end of the QPR 2017.1 installation. With the help of the migration utility you can transfer
your old settings and database from the old version easily. For more information for performing the
migration, see the System Migration section in QPR - Configuration Instructions document.
Settings in ini files are partially transferred. When using the transfer, any old passwords are converted
to new stronger encryption when transferring to QPR 2017.1. However, other settings such as paths
are transferred as such and you will need to review and most likely change them after the migration.
Other alternative is to skip settings transfer and input the necessary passwords again using QPR
Configuration Manager.
The custom stylesheet structure of the QPR package makes it easier to transfer old Portal
customizations to the new version when upgrading the QPR suite. For instructions concerning the
customization itself, refer to the QPR Developer's Guide.
Provided that you have inserted all your modifications to the custom.css file, you will only need to
copy your changes from the old custom.css file into the current custom.css file under the qprsoftware/
stylesheets/custom.css folder. Copy also your customimages folder in the case you had any
customized images in use. Do not overwrite the existing custom.css file as there can be some new
styles included in the new file. Copy only your existing customizations to the matching classes.
Note also that the web content folder structure has changed a bit between QPR 8.1 and QPR
2012.1/2012.2, so you may need to modify some templates if you have referenced files located in
earlier web content directories. See below for details about the changes. In addition, templates from
an earlier version are unlikely to work as such in a newer version, so when upgrading for example
from QPR 8.1 to QPR 2016.1, the old templates folder should not be dropped into the new installation
as such, but the customizations should be ported instead. Porting means that the differences between
the original QPR 8.1 templates and new QPR 2016.1 templates are analyzed and customizations done
manually where applicable or necessary.
See the tables below for information about where QPR Portal templates are located in different
versions so that you can properly port any customizations you might have in your templates.
Common templates
Version Folder location
8.1 C:\ProgramData\QPR Software\QPR 8\8.1\Templates\WAS\Common
Portal templates
Version Folder location
8.1 C:\ProgramData\QPR Software\QPR 8\8.1\Templates\WAS\Portal
SC templates
PG templates
Version Folder location
8.1 C:\ProgramData\QPR Software\QPR 8\8.1\Templates\WAS\PG
Note: During upgrades between different releases of QPR 2017.1 (for example 2017.1.1 and
2017.1.2) the old template folder is backed up to C:\ProgramData\QPR Software\QPR 2017\2017.1
\Templates_before_<current service pack>, and you can restore customizations from there.
Make all the customizations to the custom.css file and store all the modified images to the
qprsoftware/stylesheets/customimages folder. Doing this ensures that the future upgrades will be
simple, as you will only need to copy the styles in the custom.css stylesheet and the customimages
folder to the new installation folder. It is also good to mark all customizations with easily searchable
comments to make it easier to transfer them into a new version.
Please note that new features implemented into QPR products may change the model appearance
and/or functionality. In addition, changes to models may be required to take full advantage of the new
additions. See the QPR - Introduction to New Features document for information about the new
features and readme.txt for any last minute additions or known issues .
3.9 Modify
You can use the modify installation to add or remove installed features after the actual QPR Suite
2017.1 installation. To modify your selection of installed features, follow the instructions below:
3.10 Uninstallation
During uninstallation, the Clients and Servers folders (depending on the package that's being
uninstalled) under the common application data (C:\ProgramData\QPR Software\QPR 2017\2017.1) is
copied to Clients_old / Servers_old (or old1...oldN in the case more backup folders exist), and you're
asked whether you want to remove the folder. In the case you have any customizations or you have
used the example LocalDB database, it is safer to answer No and delete the old settings only after
you've checked that you have all the material you want to keep with you.
Please note that the LocalDB engine is not uninstalled when the QPR Servers package is removed. If
you need to remove it, please uninstall LocalDB from the Windows Control Panel.
4 Configuration
This section defines the configuration steps that should be taken before taking QPR Suite 2017.1 into
use.
Database
Select the correct database instance in the Common - Database Operations tab in QPR Configuration
Manager. For production use this should be a Microsoft SQL Server or an Oracle database you have
created for this purpose, but for demonstration and evaluation purposes there is also a Microsoft SQL
Server Express LocalDB database called QPR_2017_LOCALDB_DEMO installed with the servers
package when either of the standalone options is chosen during the installation.
Most supported web servers require some post-install configuration before QPR Portal can be used.
On Microsoft Internet Information Services 7 or newer (shipped with Windows 7 and newer), the most
common setting that is required is the ISAPI/CGI Restrictions setting. You need to allow the path of
QPR 2017.1 qpr.isapi.dll to be executed. Refer to Appendix C for more details about the necessary
configuration steps.
If you installed QPR Web Services Foundation, see Appendix D - QPR Web Services Foundation
Configuration for information on how to configure it properly.
5 Starting
After the installation is complete and the software is activated, verify that all necessary components
start properly.
If you installed the service(s), just launch the main service and there's no need to launch the servers
manually.
6 Troubleshooting
This chapter provides help on the problems you might encounter during QPR 2017.1 installation.
Q: I just installed QPR 2017 to a machine containing also a QPR 8 installation, and my server
components won't start.
A: Both QPR 2017 and QPR 8 servers use the same default ports, so in the case you have e.g. QPR 8
running as a service in the background, the ports are already in use, and you must either shut down
the QPR 8 servers or change the ports QPR 2017 is using.
Q: I just modified my QPR 2017.1 installation, but my QPR Foundation Server won't start anymore.
A: Launch QPR Activation Utility to see your product activation status. Note that a Modify installation
won't require reactivation unless you install some previously uninstalled items that require activation.
Even if this is not the case, your transient product activation might have expired. If the product
activation status is correct, launch the QPR Configuration Manager and go to the Database operations
section. See that the data source is correct. Click the Test button to test your database configuration.
Q: Servers are installed and work properly, but I cannot connect to the servers with my Designers.
A: Check that your firewall allows traffic to the ports used by QPR servers.
Q: I get an error message stating that Microsoft .NET Framework installation appears to have failed
during QPR 2017.1 installation.
A: This can occur if a Windows update that's being applied to the .NET Framework during the
installation fails to install or there are pending reboots from other updates. If you encounter this issue,
it's advisable to verify that your computer has the latest Windows updates installed and reboot the
computer prior to QPR 2017.1 installation. Note that if you choose to install .NET Framework
separately after the QPR installation, you will most likely have to manually remove handler mappings
that conflict with QPR Web Services Foundation in the QPR2017-1 IIS application (see Appendix C for
more information).
7 Appendices
7.1 Appendix A - System Requirements & Recommendations
This chapter describes the requirements and recommendations for the different components of QPR
2017.1.
The following hardware / operating system configurations are recommended to be used with various
QPR 2017.1 components. Note that these recommendations are based on a general case installation.
The system may in fact require more or less hardware depending on the usage of the system.
QPR Servers
Note that only Windows versions of multi-platform databases are supported. However, non-Windows
versions may also work, but the functionality cannot be guaranteed and you must verify the
functionality by yourself in such cases.
Your database must meet both the generic database requirements and the DBMS/edition
requirements listed below. Database compatibility can be tested with the QPR Configuration Manager
and it should be done every time a new database is taken into use.
Only Windows versions of the databases listed below have been verified and are officially supported
by QPR. Database vendors may provide compatibility for alternative operating systems like Linux,
UNIX, AIX, and HP9000. Contact your Database vendor and QPR to learn more about alternative
operating systems.
The following operating systems are supported by the different QPR components:
Note: Default w eb servers shipped w ith non-server versions of W indow s m ay im pose lim its on the
am ount of concurrent users. Please verify the lim its from the operating system docum entation.
*Note: 32-bit Q PR com ponents (i.e. clients installed specifically from the 32-bit installer) are run in 32-
bit m ode. Therefore, they are subject to 32-bit lim itations, as regards, for exam ple m em ory allocation.
Servers installed from the 64-bit installers do not have this lim itation.
With other servers the functionality must be separately tested or separately confirmed by QPR. Note
that QPR Web Services Foundation is supported only on Microsoft Internet Information Services 7.0 -
8.5.
For details on web server configuration, refer to Appendix C - Web Server Configuration.
7.1.4.1.1 Requirements
7.1.4.1.2 Installation
Note that plugin-specific contents must be separately installed to web server computer, if plugins used
require files there.
7.1.4.1.3 Configuration
*Note about support for Mozilla Firefox for Windows and Google Chrome: Due to the rapid
update schedule of these web browsers, QPR does not specify any specifically supported version but
indicates the latest versions that are tested and verified to work. Firefox and Chrome versions newer
than the tested versions are likely to work normally, but QPR cannot guarantee their functionality
before the next QPR release.
Note: All Windows paths (e.g. information item locations such as X:\Document on a network
drive.doc) may not work on other browsers than Microsoft Internet Explorer. For optimal browser-
independent functionality, upload all shared documents into a location accessible via HTTP.
Note: To browse QPR Portal with the Internet Explorer 11 in the Modern UI user interface of
Microsoft Windows 8.1, the Microsoft Internet Explorer compatibility mode needs to be turned off.
Browser Configuration
Usually default settings are correct, i.e. no separate configuration is needed. However the following
settings may need attention:
Browser must allow execution of JavaScript and JavaScript must be allowed to perform the
following functions:
Open new windows
Resize and move windows
In some cases, a pop-up blocker may interfere with QPR Portal. It is advisable to add QPR
Portal as a whitelisted (allowed) site which can open windows freely in the case a whitelisting
possibility exists.
Depending on contents browsed through QPR Portal, it may be advisable to set the 'Empty page
history' setting on.
http://< host_nam e> /Q PR2017-1/Portal/qpr.isapi.dll when using Microsoft IIS as the web server. With
other servers the generic URL is http://< host nam e> /< script_path> /qpr.isapi.dll
Substitute qpr.isapi.dll with qpr.cgi.exe in the case the server is using the CGI binary, or with qpr.cgi
in the case you are using a web server running on some other platform than Windows.
SVG Requirements
QPR 2017.1 supports SVG graphics in QPR Portal with Microsoft Internet Explorer (built-in from
version 9 onwards) and Mozilla Firefox built-in viewers. However, the built-in SVG is not supported for
Microsoft Internet Explorer in the Compatibility Mode.
Note that the server computer needs to be set to use the default 100% font size. Larger sizes may
cause display issues with SVG views.
Note: You can use also Microsoft Silverlight (see requirements below) instead of SVG.
Note that the server computer needs to be set to use the default 100% font size. Larger sizes may
cause display issues with Silverlight views.
Note: You can use SVG (see requirements above) instead of Microsoft Silverlight.
.NET Requirements
Microsoft .NET Framework 4.6.2 is required for using QPR Web Services Foundation and QPR Add-In
for Microsoft Office 2010/2013. If you select either of the features to be installed and you do not have
the framework installed, it is installed during the QPR 2017 installation. However, the .NET Framework
installation requires an Internet connection, so without a connection you need to acquire the
framework by other means. If you wish to install the framework before installing QPR 2017, you can
acquire it from http://www.microsoft.com/downloads/en/details.aspx?
displaylang=en&FamilyID=0a391abd-25c1-4fc0-919f-b21f31ab88b7.
Microsoft .NET Framework 2.0 or later is required for using QPR Metrics Client and QPR Web
Application Server. QPR 2017 installation will install Microsoft .NET Framework 2.0 SP2 if it is not
present on the computer and QPR Metrics Client and/or QPR Web Application Server is selected to be
installed.
Office Requirements
Using the QPR Add-In for Microsoft Office 2010/2013/2016 requires Microsoft Word 2010, Microsoft
Word 2013, or Microsoft Word 2016 and Visual Studio Tools for Office runtime 4.0. The VSTO runtime
is installed during the QPR Add-In for Microsoft Office 2010/2013/2016 installation in the case they are
not present on the machine.
VB Script Requirements
In the case Visual Basic Scripting (VBScript) is used, the supported version is 1.0.
OLAP Requirements
With OLAP (Online Analytical Processing), only Microsoft SQL Server is supported.
LDAP Requirements
If LDAP (Lightweight Directory Access Protocol) is used for authentication, the following
implementations are supported:
Windows Active Directory
OpenLDAP 2.3
Localization Requirements
In multilingual environments you may need to install additional fonts to computers running QPR
Modeling Client and/or QPR Metrics Client. On Windows 7 and newer systems the necessary fonts are
usually installed by default. This can be done in Control Panel -> Regional and Language Options ->
Languages -> Supplemental language support. Note that you will have to reboot the computer after
installing the additional language support files.
The system requirements provided herein do not extend to situations where a defect or an error has
been recognized in a third party vendor software product listed herein as a supported product. Such
errors are e.g. all errors that the third party vendor has acknowledged by releasing a service pack or a
new version addressing the issue, or errors which are in some other way publicly acknowledged by the
vendor.
QPR products use DataBase Management Systems (DBMS) for administrating users and storing user
and model data.
The primary requirement for the database server is that it needs to be an SQL DBMS with an Open
DataBase Connectivity (ODBC) interface. You can use any DBMS which conforms to these
requirements, but the installation will be the most convenient when one of the directly supported
DBMSes is used.
Here are the instructions for setting up a Microsoft SQL Server DBMS for QPR products:
Note about Oracle character sets: The national character set in Oracle must always be
AL16UTF16, and the database character set must be AL32UTF8.
All QPR products use a single database instance, so you need to create and configure only one
database for the whole system.
Please consult your Microsoft SQL Server/Oracle manual for instructions on creating a new
database.
A minimum QPR database should work fine with the default database configurations. However,
make sure that there is enough hard drive space allocated for the database tablespace as well
as the transaction log. They both should have space for at least 100 MB of data. With larger
amounts of data the allocations and database settings most probably need to be adjusted.
You can test your database configuration by clicking the Test Database Configuration
button at the Database tab of the Common section in the QPR Configuration Manager utility,
which can be found at the Utilities folder under your QPR 2017.1 Servers installation folder.
Verify also that there is an ODBC data source configured for the database and configure it if
needed. Please note the following about the data sources:
The data sources must be created using 64-bit servers for them to be visible in QPR
Configuration Manager.
Creating a System DSN is highly recommended to make sure that the DSN is visible also for
the account running QPR Service (System account by default).
Windows Authentication is not supported for the database connection, so e.g. SQL Server
needs to be configured to allow mixed mode authentication and a SQL Server login needs to
be provided for the QPR database.
IIS Setup
In addition to the default selections, the following extra modules need to be installed for IIS 7.0 / 7.5:
Common HTTP Features -> Static Content
Common HTTP Features -> HTTP Redirection
Common HTTP Features -> HTTP Errors
World Wide Web Services -> Application Development Features -> .NET Extensibility
World Wide Web Services -> Application Development Features -> ASP.NET (for QPR Web Services
Foundation)
World Wide Web Services -> Application Development Features -> ISAPI Extensions
World Wide Web Services -> Application Development Features -> ISAPI Filters
Web Management Tools -> IIS Management Console (if not already installed)
In addition to the default selections, the following role services need to be installed for IIS 7.0 on
Windows Server 2008:
Application Development -> ASP.NET (for QPR Web Services Foundation)
Application Development -> .NET Extensibility
Application Development -> ISAPI Extensions
Application Development -> ISAPI Filters
On Windows 7 these selections can be made in the "Turn Windows features on or off" section in the
Control Panel. On Windows Server 2008 the selection is available at Server Manager -> Roles -> Web
Server (IIS) -> Add Role Services.
1. Go to Start Menu -> Control Panel -> Administrative Tools -> Internet Information Services (IIS)
Manager.
2. Expand the Server name and open the ISAPI and CGI Restrictions section.
3. Select Add.
4. Browse the path to the QPR.isapi.dll (using qpr.cgi.exe with IIS 7 is not supported. Note that
you'll need to verify that also QPR Web Application Server is configured to use the qpr.isapi.dll)
into the ISAPI or CGI Path field.
5. Input a description for the extension and check the "Allow extension path to execute"
checkbox.
6. Click the OK button.
The following MIME type mappings are created automatically for the Portal virtual directory under the
QPR2017-1 application in IIS, but in the case there are issues with Silverlight or SVG views, verify that
the following mappings exist:
Extension: .svg, MIME type image/svg+xml
Extension: .xaml, MIME type application/xaml+xml
Extension: .xap, MIME type application/x-silverlight-app
Extension: .xbap, MIME type application/x-ms-xbap
1. Go to Start Menu -> Control Panel -> Administrative Tools -> Internet Information Services (IIS)
Manager.
2. Select Default Web Site.
3. Open the MIME Types section.
4. If the extension is not listed, select Add and input the extension and the correct MIME type.
5. Click OK and restart the website
2012, Microsoft Internet Information Services (IIS) 8.5 in Windows 8.1 and Windows Server 2012 R2,
or Microsoft Internet Information Services (IIS) 10.0 in Windows 10.
IIS Setup
In addition to the default selections, the following extra modules and their dependencies need to be
installed for IIS 8.0 / 8.5 / 10.
Common HTTP Features -> Static Content
Common HTTP Features -> HTTP Redirection
Common HTTP Features -> HTTP Errors
World Wide Web Services -> Application Development Features -> .NET Extensibility 3.5
World Wide Web Services -> Application Development Features -> ASP.NET 3.5 (for QPR Web
Services Foundation)
World Wide Web Services -> Application Development Features -> ISAPI Extensions
World Wide Web Services -> Application Development Features -> ISAPI Filters
Web Management Tools -> IIS Management Console (if not already installed)
Web Management Tools -> IIS Management Scripts and Tools
In addition to the default selections, the following role services need to be installed for IIS 8.0 / 8.5 on
Windows Server 2012 / 2012 R2:
Web Server -> Application Development -> ASP.NET 3.5 (for QPR Web Services Foundation)
Web Server -> Application Development -> .NET Extensibility 3.5
Web Server -> Application Development -> ISAPI Extensions
Web Server -> Application Development -> ISAPI Filters
Also make sure that the ".NET Framework 3.5 (included .NET 2.0 and 3.0)" feature is selected on the
main level.
On Windows 8 / 8.1 / 10 these selections can be made in the "Turn Windows features on or off"
section in the Control Panel. On Windows Server 2012 and 2012 R2 the selection is available at Server
Manager -> IIS -> select "Add Roles and Features" from the Tasks drop-down menu in the Roles and
Features section.
1. Go to Control Panel -> Administrative Tools -> Internet Information Services (IIS) Manager.
2. Expand the Server name and open the ISAPI and CGI Restrictions section.
3. Select Add.
4. Browse the path to the QPR.isapi.dll (using qpr.cgi.exe with IIS 7 and newer is not supported.
Note that you'll need to verify that also QPR Web Application Server is configured to use the
qpr.isapi.dll) into the ISAPI or CGI Path field.
5. Input a description for the extension and check the "Allow extension path to execute"
checkbox.
6. Click the OK button.
The following MIME type mappings are created automatically for the Portal virtual directory under the
QPR2017-1 application in IIS, but in the case there are issues with Silverlight or SVG views, verify that
the following mappings exist:
Extension: .svg, MIME type image/svg+xml
Extension: .xaml, MIME type application/xaml+xml
Extension: .xap, MIME type application/x-silverlight-app
Extension: .xbap, MIME type application/x-ms-xbap
1. Go to Control Panel -> Administrative Tools -> Internet Information Services (IIS) Manager.
1. See the "Application pool configuration" section above for information about proper application pool
configuration.
2. Create the MIME type mappings as instructed above.
3. If QPR Web Service Foundation is used, remove the following mappings from the QPR2017-1
application:
.svc
.aspx
.axd
WebResource.axd
ScriptResource.axd
QPR Web Services Foundation is accessed using the QPR Web Services Server, which requires the
following configuration to run properly:
The QPR Web Services Server installation installs also a test utility with which you can determine that
your environment is properly configured for the service. The utility is called servicetester.aspx and its
URL is http://<hostname>/QPR2017-1/Portal/qpr.isapi.dll/wsforward/servicetester.aspx (substitute
http with https when using SSL).
A secure connection to QPR Web Services Server requires that the site hosting qpr.isapi.dll is set to
use https.
Authentication
By default QPR Web Services Foundation uses regular authentication by authentication methods
enabled in QPR Configuration Manager. However, if you wish to use Integrated Windows
Authentication (IWA), the following additional steps are needed:
Configure the Portal virtual directory under the QPR2017-1 application to use IWA and allow full
access to MainService.svc file.
Make sure that IWACGIBinaryHost setting in the [WAS Settings] section of QPR_Servers.ini is set to
localhost.
Make the following modifications in the <QPR servers installation root>\WebServices folder:
o Rename the Web.config file to some other name
o Rename the Web.config.IWA file to Web.config
QPR Web Services Server base URL (append MainService.svc or servicetester.aspx to the end
depending on the intended use) http://<hostname>/QPR2017-1/Portal/qpr.isapi.dll/wsforward/
without SSL and https://<hostname>/QPR2017-1/Portal/qpr.isapi.dll/wsforward/ with SSL. Both URLs
work with QPR authentication as well as Integrated Windows Authentication (IWA). Note that for
optimal SSL functionality only official certificates should be used.
In addition to basic configuration, the following should be noted with Microsoft Internet Information
Services 7 and 7.5:
Windows Authentication module needs to be installed for IIS. This can be done in Server Manager -
> Roles -> Web Server (IIS) -> Add Role Services.
Troubleshooting
This section provides information on how to resolve common configuration issues related to running
QPR Web Services Foundation.
Issue: Servicetester.aspx doesn't work properly and log displays lots of access denied errors
Solution #1: Give the ASPNET user rights to modify files under C:\ProgramData\QPR Software\QPR
2017\QPR 2017.1. In Windows Server 2008, give the rights to NetworkServices user instead of
ASPNET.
Issue: Servicetester does not work but redirects to the main service page. Any functionality needing
QPR Web Services Foundation does not work.
Solution: Remove the following handler mappings from the QPR2017-1 application in IIS:
.svc
.aspx
.axd
WebResource.axd
ScriptResource.axd
Issue: I'm using Integrated Windows Authentication and servicetester.aspx spawns endless IIS
authentication dialogs and giving valid credentials does not help.
Solution: Change the IWACGIBinaryHost setting in QPR_Servers.ini to localhost. Also make sure that
the default web.config file has been replaced with web.config.IWA file available in the WebServices
folder.
In QPR_Servers.ini, make sure that the IWACGIBinaryHost key in [WAS Settings] section points to
the same network interface that is used to access WSS through the IP in qprsettings.dat. For
example, if your IIS is in machine 192.168.0.1 and your WSS is in machine 192.168.0.2, these are
the correct settings:
o qprsettings.dat: WS_HOST_ADDR=192.168.0.2
o QPR_Servers.ini: IWACGIBinaryHost=192.168.0.1
In IIS, QPR2017-1/Portal directory must have Windows authentication enabled and Anonymous
authentication disabled.
Good preparations are the most important factor in carrying out a successful installation. Please read
through this section carefully to ensure that your system environment is ready for QPR 2017
installation.
To be able to follow these instructions precisely, verify that you have the latest version of QPR 2017.1.
See https://community.qpr.com for information about the latest version.
In order to perform the QPR 2017 installation you need to have administrative privileges in Windows.
Also make sure that you have an adequate amount of free hard disk space. See the System
Requirements section for information about the required amount.
In order to use QPR Portal, you need to have a web server software configured before installing QPR
2017.1. See the System Requirements chapter for information about supported web servers and
consult the server's installation instructions for information about its installation.
QPR 2017 utilizes QPR User Management System for user rights administration. QPR User
Management System supports also user imports from NT domain and LDAP servers as well as
Integrated Windows Authentication (IWA). Before making the installation it is advisable to plan how
user rights for QPR products are managed and acquire required rights to e.g. active directory servers.
7.5.2.4 Hardware
Check the System Requirements chapter and verify that your hardware is adequate for running QPR
2017.
7.5.2.5 Software
If you intend to install QPR Web Services Foundation (included in the typical installation) and/or QPR
Add-In for Microsoft Office 2010/2013/2016 (optional), there are some additional dependencies:
All of these requirements are included in the QPR 2017 installation package and installed if the
corresponding features are selected to be included in the installation, but you might consider installing
these components before the QPR 2017 installation in the following cases:
Bandwidth usage is a concern or you are installing the suite on multiple workstations. Due to the
size of the full runtime, the QPR 2017 package includes only an installer bootstrapper which fetches
the rest of the framework from the Microsoft web site. Distributing the framework internally within
your organization before QPR 2017 installation eliminates the need for separately fetching the
framework to all target workstations.
You want to reduce time required to install QPR 2017
Note that in order for the QPR Add-In for Microsoft Office 2010/2013/2016 to work properly, the Office
2010/2013/2016 installation needs to have the Visual Basic for Applications feature installed (found in
the Office Shared Features section of the installation options).
Modeling Tools
o QPR ProcessDesigner
o QPR EnterpriseArchitect
o None
QPR Metrics Client
QPR User Management Client
QPR Add-In for Microsoft Office (not selected by default, available only if an Office 2010, 2013, or
2016 installation is detected on the computer)
Note that QPR ProcessDesigner and QPR EnterpriseArchitect both cannot be installed on the same
computer, you have to select either one or none.
Note that for installing QPR Add-In for Microsoft Office for a 64-bit version of Microsoft Office
2010/2013/2016, you need to use the QPRAfMOSetup_x64.exe installation package.
Microsoft .NET Framework 4.6.2 is required for installing QPR Web Services Server and the QPR Add-
In for Microsoft Office 2010/2013/2016. In addition to the .NET Framework, the QPR Add-In for
Microsoft Office 2010/2013/2016 requires the VSTO 4.0 runtime to be installed. These additional
requirements are installed to your computer if you select the installation options that require them.
The additional installations take place after the "Ready to Install" step right before copying the QPR
2017.1 files.
Microsoft .NET Framework 2.0 or later is required for installing QPR Metrics Client and QPR Web
Application Server. QPR 2017 installation will install Microsoft .NET Framework 2.0 SP2 if it is not
present on the computer and QPR Metrics Client and/or QPR Web Application Server is selected to be
installed.
Use the checklists below (pick the one that is applicable) to verify that your QPR system is properly
installed and configured on a basic level. Note that the checklists below are for reference purposes
and they do not take into account any environment-specific settings.
Use this list if you selected to install service or omitted both standalone and service options.
# Task Expected Output Notes
1 If you installed QPR Service, The service is started
start the service. Otherwise successfully or all server
start all QPR servers (QPR components are started
Foundation Server, QPR successfully.
Metrics Server, QPR
BizArchitecture Server, and
QPR Web Application Server)
2 Open a server model in QPR Model is opened without errors.
EnterpriseArchitect/QPR
ProcessDesigner
3 Start QPR Metrics Client The application is started
successfully.
4 Open a model in QPR Metrics Model is opened without errors.
5 Launch QPR Portal Login is successful.
6 Browse QPR Modeling and All models are displayed You may need to install an SVG
QPR Metrics Models in Portal successfully. plugin or Microsoft Silverlight first
in order to view some QPR
Metrics views.
7 Access http://localhost/ The tester is launched * Applicable only if you installed
QPR2017-1/Portal/ successfully and clicking on QPR Web Services Foundation.
qpr.isapi.dll/wsforward/ QueryObjectsAsXml returns a
servicetester.aspx and click result set with multiple objects
QueryObjectsAsXml
8 Launch Microsoft Word 2010, The QPR tab appears in Word. * Applicable only if you installed
2013, or 2016. QPR Add-In for Microsoft Office.